Improve GKeyFile test coverage
[platform/upstream/glib.git] / gio / gsettings-tool.c
1 /*
2  * Copyright © 2010 Codethink Limited
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the licence, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA 02111-1307, USA.
18  *
19  * Author: Ryan Lortie <desrt@desrt.ca>
20  */
21
22 #include "config.h"
23
24 #include <gio/gio.h>
25 #include <gi18n.h>
26 #include <locale.h>
27 #include <string.h>
28 #include <stdlib.h>
29
30 #ifdef G_OS_WIN32
31 #include "glib/glib-private.h"
32 #endif
33
34 static GSettingsSchemaSource   *global_schema_source;
35 static GSettings               *global_settings;
36 static GSettingsSchema         *global_schema;
37 static GSettingsSchemaKey      *global_schema_key;
38 const gchar                    *global_key;
39 const gchar                    *global_value;
40
41 static gboolean
42 is_relocatable_schema (GSettingsSchema *schema)
43 {
44   return g_settings_schema_get_path (schema) == NULL;
45 }
46
47 static gboolean
48 check_relocatable_schema (GSettingsSchema *schema,
49                           const gchar     *schema_id)
50 {
51   if (schema == NULL)
52     {
53       g_printerr (_("No such schema '%s'\n"), schema_id);
54       return FALSE;
55     }
56
57   if (!is_relocatable_schema (schema))
58     {
59       g_printerr (_("Schema '%s' is not relocatable "
60                     "(path must not be specified)\n"),
61                   schema_id);
62       return FALSE;
63     }
64
65   return TRUE;
66 }
67
68 static gboolean
69 check_schema (GSettingsSchema *schema,
70               const gchar *schema_id)
71 {
72   if (schema == NULL)
73     {
74       g_printerr (_("No such schema '%s'\n"), schema_id);
75       return FALSE;
76     }
77
78   if (is_relocatable_schema (schema))
79     {
80       g_printerr (_("Schema '%s' is relocatable "
81                     "(path must be specified)\n"),
82                   schema_id);
83       return FALSE;
84     }
85
86   return TRUE;
87 }
88
89 static gboolean
90 check_path (const gchar *path)
91 {
92   if (path[0] == '\0')
93     {
94       g_printerr (_("Empty path given.\n"));
95       return FALSE;
96     }
97
98   if (path[0] != '/')
99     {
100       g_printerr (_("Path must begin with a slash (/)\n"));
101       return FALSE;
102     }
103
104   if (!g_str_has_suffix (path, "/"))
105     {
106       g_printerr (_("Path must end with a slash (/)\n"));
107       return FALSE;
108     }
109
110   if (strstr (path, "//"))
111     {
112       g_printerr (_("Path must not contain two adjacent slashes (//)\n"));
113       return FALSE;
114     }
115
116   return TRUE;
117 }
118
119 static void
120 output_list (gchar **list)
121 {
122   gint i;
123
124   for (i = 0; list[i]; i++)
125     g_print ("%s\n", list[i]);
126 }
127
128 static void
129 gsettings_print_version (void)
130 {
131   g_print ("%d.%d.%d\n", glib_major_version, glib_minor_version,
132            glib_micro_version);
133 }
134
135 static void
136 gsettings_list_schemas (void)
137 {
138   gchar **schemas;
139
140   g_settings_schema_source_list_schemas (global_schema_source, TRUE, &schemas, NULL);
141   output_list (schemas);
142   g_strfreev (schemas);
143 }
144
145 static void
146 gsettings_list_relocatable_schemas (void)
147 {
148   gchar **schemas;
149
150   g_settings_schema_source_list_schemas (global_schema_source, TRUE, NULL, &schemas);
151   output_list (schemas);
152   g_strfreev (schemas);
153 }
154
155 static void
156 gsettings_list_keys (void)
157 {
158   gchar **keys;
159
160   keys = g_settings_list_keys (global_settings);
161   output_list (keys);
162   g_strfreev (keys);
163 }
164
165 static void
166 gsettings_list_children (void)
167 {
168   gchar **children;
169   gint max = 0;
170   gint i;
171
172   children = g_settings_list_children (global_settings);
173   for (i = 0; children[i]; i++)
174     if (strlen (children[i]) > max)
175       max = strlen (children[i]);
176
177   for (i = 0; children[i]; i++)
178     {
179       GSettings *child;
180       GSettingsSchema *schema;
181       gchar *path;
182
183       child = g_settings_get_child (global_settings, children[i]);
184       g_object_get (child,
185                     "settings-schema", &schema,
186                     "path", &path,
187                     NULL);
188
189       if (g_settings_schema_get_path (schema) != NULL)
190         g_print ("%-*s   %s\n", max, children[i], g_settings_schema_get_id (schema));
191       else
192         g_print ("%-*s   %s:%s\n", max, children[i], g_settings_schema_get_id (schema), path);
193
194       g_object_unref (child);
195       g_settings_schema_unref (schema);
196       g_free (path);
197     }
198
199   g_strfreev (children);
200 }
201
202 static void
203 enumerate (GSettings *settings)
204 {
205   gchar **keys;
206   gchar *schema;
207   gint i;
208
209   g_object_get (settings, "schema-id", &schema, NULL);
210
211   keys = g_settings_list_keys (settings);
212   for (i = 0; keys[i]; i++)
213     {
214       GVariant *value;
215       gchar *printed;
216
217       value = g_settings_get_value (settings, keys[i]);
218       printed = g_variant_print (value, TRUE);
219       g_print ("%s %s %s\n", schema, keys[i], printed);
220       g_variant_unref (value);
221       g_free (printed);
222     }
223
224   g_free (schema);
225   g_strfreev (keys);
226 }
227
228 static void
229 list_recursively (GSettings *settings)
230 {
231   gchar **children;
232   gint i;
233
234   enumerate (settings);
235   children = g_settings_list_children (settings);
236   for (i = 0; children[i]; i++)
237     {
238       GSettings *child;
239
240       child = g_settings_get_child (settings, children[i]);
241       list_recursively (child);
242       g_object_unref (child);
243     }
244
245   g_strfreev (children);
246 }
247
248 static void
249 gsettings_list_recursively (void)
250 {
251   if (global_settings)
252     {
253       list_recursively (global_settings);
254     }
255   else
256     {
257       gchar **schemas;
258       gint i;
259
260       g_settings_schema_source_list_schemas (global_schema_source, TRUE, &schemas, NULL);
261
262       for (i = 0; schemas[i]; i++)
263         {
264           GSettings *settings;
265
266           settings = g_settings_new (schemas[i]);
267           list_recursively (settings);
268           g_object_unref (settings);
269         }
270
271       g_strfreev (schemas);
272     }
273 }
274
275 static void
276 gsettings_range (void)
277 {
278   GVariant *range, *detail;
279   const gchar *type;
280
281   range = g_settings_schema_key_get_range (global_schema_key);
282   g_variant_get (range, "(&sv)", &type, &detail);
283
284   if (strcmp (type, "type") == 0)
285     g_print ("type %s\n", g_variant_get_type_string (detail) + 1);
286
287   else if (strcmp (type, "range") == 0)
288     {
289       GVariant *min, *max;
290       gchar *smin, *smax;
291
292       g_variant_get (detail, "(**)", &min, &max);
293       smin = g_variant_print (min, FALSE);
294       smax = g_variant_print (max, FALSE);
295
296       g_print ("range %s %s %s\n",
297                g_variant_get_type_string (min), smin, smax);
298       g_variant_unref (min);
299       g_variant_unref (max);
300       g_free (smin);
301       g_free (smax);
302     }
303
304   else if (strcmp (type, "enum") == 0 || strcmp (type, "flags") == 0)
305     {
306       GVariantIter iter;
307       GVariant *item;
308
309       g_print ("%s\n", type);
310
311       g_variant_iter_init (&iter, detail);
312       while (g_variant_iter_loop (&iter, "*", &item))
313         {
314           gchar *printed;
315
316           printed = g_variant_print (item, FALSE);
317           g_print ("%s\n", printed);
318           g_free (printed);
319         }
320     }
321
322   g_variant_unref (detail);
323   g_variant_unref (range);
324 }
325
326 static void
327 gsettings_get (void)
328 {
329   GVariant *value;
330   gchar *printed;
331
332   value = g_settings_get_value (global_settings, global_key);
333   printed = g_variant_print (value, TRUE);
334   g_print ("%s\n", printed);
335   g_variant_unref (value);
336   g_free (printed);
337 }
338
339 static void
340 gsettings_reset (void)
341 {
342   g_settings_reset (global_settings, global_key);
343   g_settings_sync ();
344 }
345
346 static void
347 reset_all_keys (GSettings *settings)
348 {
349   gchar **keys;
350   gint i;
351
352   keys = g_settings_list_keys (settings);
353   for (i = 0; keys[i]; i++)
354     {
355       g_settings_reset (settings, keys[i]);
356     }
357
358   g_strfreev (keys);
359 }
360
361 static void
362 gsettings_reset_recursively (void)
363 {
364   gchar **children;
365   gint i;
366
367   g_settings_delay (global_settings);
368
369   reset_all_keys (global_settings);
370   children = g_settings_list_children (global_settings);
371   for (i = 0; children[i]; i++)
372     {
373       GSettings *child;
374       child = g_settings_get_child (global_settings, children[i]);
375
376       reset_all_keys (child);
377
378       g_object_unref (child);
379     }
380
381   g_strfreev (children);
382
383   g_settings_apply (global_settings);
384   g_settings_sync ();
385 }
386
387 static void
388 gsettings_writable (void)
389 {
390   g_print ("%s\n",
391            g_settings_is_writable (global_settings, global_key) ?
392            "true" : "false");
393 }
394
395 static void
396 value_changed (GSettings   *settings,
397                const gchar *key,
398                gpointer     user_data)
399 {
400   GVariant *value;
401   gchar *printed;
402
403   value = g_settings_get_value (settings, key);
404   printed = g_variant_print (value, TRUE);
405   g_print ("%s: %s\n", key, printed);
406   g_variant_unref (value);
407   g_free (printed);
408 }
409
410 static void
411 gsettings_monitor (void)
412 {
413   if (global_key)
414     {
415       gchar *name;
416
417       name = g_strdup_printf ("changed::%s", global_key);
418       g_signal_connect (global_settings, name, G_CALLBACK (value_changed), NULL);
419     }
420   else
421     g_signal_connect (global_settings, "changed", G_CALLBACK (value_changed), NULL);
422
423   for (;;)
424     g_main_context_iteration (NULL, TRUE);
425 }
426
427 static void
428 gsettings_set (void)
429 {
430   const GVariantType *type;
431   GError *error = NULL;
432   GVariant *new;
433   gchar *freeme = NULL;
434
435   type = g_settings_schema_key_get_value_type (global_schema_key);
436
437   new = g_variant_parse (type, global_value, NULL, NULL, &error);
438
439   /* If that didn't work and the type is string then we should assume
440    * that the user is just trying to set a string directly and forgot
441    * the quotes (or had them consumed by the shell).
442    *
443    * If the user started with a quote then we assume that some deeper
444    * problem is at play and we want the failure in that case.
445    *
446    * Consider:
447    *
448    *   gsettings set x.y.z key "'i don't expect this to work'"
449    *
450    * Note that we should not just add quotes and try parsing again, but
451    * rather assume that the user is providing us with a bare string.
452    * Assume we added single quotes, then consider this case:
453    *
454    *   gsettings set x.y.z key "i'd expect this to work"
455    *
456    * A similar example could be given for double quotes.
457    *
458    * Avoid that whole mess by just using g_variant_new_string().
459    */
460   if (new == NULL &&
461       g_variant_type_equal (type, G_VARIANT_TYPE_STRING) &&
462       global_value[0] != '\'' && global_value[0] != '"')
463     {
464       g_clear_error (&error);
465       new = g_variant_new_string (global_value);
466     }
467
468   if (new == NULL)
469     {
470       g_printerr ("%s\n", error->message);
471       exit (1);
472     }
473
474   if (!g_settings_schema_key_range_check (global_schema_key, new))
475     {
476       g_printerr (_("The provided value is outside of the valid range\n"));
477       g_variant_unref (new);
478       exit (1);
479     }
480
481   if (!g_settings_set_value (global_settings, global_key, new))
482     {
483       g_printerr (_("The key is not writable\n"));
484       exit (1);
485     }
486
487   g_settings_sync ();
488
489   g_free (freeme);
490 }
491
492 static int
493 gsettings_help (gboolean     requested,
494                 const gchar *command)
495 {
496   const gchar *description;
497   const gchar *synopsis;
498   GString *string;
499
500   string = g_string_new (NULL);
501
502   if (command == NULL)
503     ;
504
505   else if (strcmp (command, "help") == 0)
506     {
507       description = _("Print help");
508       synopsis = "[COMMAND]";
509     }
510
511   else if (strcmp (command, "--version") == 0)
512     {
513       description = _("Print version information and exit");
514       synopsis = "";
515     }
516
517   else if (strcmp (command, "list-schemas") == 0)
518     {
519       description = _("List the installed (non-relocatable) schemas");
520       synopsis = "";
521     }
522
523   else if (strcmp (command, "list-relocatable-schemas") == 0)
524     {
525       description = _("List the installed relocatable schemas");
526       synopsis = "";
527     }
528
529   else if (strcmp (command, "list-keys") == 0)
530     {
531       description = _("List the keys in SCHEMA");
532       synopsis = N_("SCHEMA[:PATH]");
533     }
534
535   else if (strcmp (command, "list-children") == 0)
536     {
537       description = _("List the children of SCHEMA");
538       synopsis = N_("SCHEMA[:PATH]");
539     }
540
541   else if (strcmp (command, "list-recursively") == 0)
542     {
543       description = _("List keys and values, recursively\n"
544                       "If no SCHEMA is given, list all keys\n");
545       synopsis = N_("[SCHEMA[:PATH]]");
546     }
547
548   else if (strcmp (command, "get") == 0)
549     {
550       description = _("Get the value of KEY");
551       synopsis = N_("SCHEMA[:PATH] KEY");
552     }
553
554   else if (strcmp (command, "range") == 0)
555     {
556       description = _("Query the range of valid values for KEY");
557       synopsis = N_("SCHEMA[:PATH] KEY");
558     }
559
560   else if (strcmp (command, "set") == 0)
561     {
562       description = _("Set the value of KEY to VALUE");
563       synopsis = N_("SCHEMA[:PATH] KEY VALUE");
564     }
565
566   else if (strcmp (command, "reset") == 0)
567     {
568       description = _("Reset KEY to its default value");
569       synopsis = N_("SCHEMA[:PATH] KEY");
570     }
571
572   else if (strcmp (command, "reset-recursively") == 0)
573     {
574       description = _("Reset all keys in SCHEMA to their defaults");
575       synopsis = N_("SCHEMA[:PATH]");
576     }
577
578   else if (strcmp (command, "writable") == 0)
579     {
580       description = _("Check if KEY is writable");
581       synopsis = N_("SCHEMA[:PATH] KEY");
582     }
583
584   else if (strcmp (command, "monitor") == 0)
585     {
586       description = _("Monitor KEY for changes.\n"
587                     "If no KEY is specified, monitor all keys in SCHEMA.\n"
588                     "Use ^C to stop monitoring.\n");
589       synopsis = N_("SCHEMA[:PATH] [KEY]");
590     }
591   else
592     {
593       g_string_printf (string, _("Unknown command %s\n\n"), command);
594       requested = FALSE;
595       command = NULL;
596     }
597
598   if (command == NULL)
599     {
600       g_string_append (string,
601       _("Usage:\n"
602         "  gsettings --version\n"
603         "  gsettings [--schemadir SCHEMADIR] COMMAND [ARGS...]\n"
604         "\n"
605         "Commands:\n"
606         "  help                      Show this information\n"
607         "  list-schemas              List installed schemas\n"
608         "  list-relocatable-schemas  List relocatable schemas\n"
609         "  list-keys                 List keys in a schema\n"
610         "  list-children             List children of a schema\n"
611         "  list-recursively          List keys and values, recursively\n"
612         "  range                     Queries the range of a key\n"
613         "  get                       Get the value of a key\n"
614         "  set                       Set the value of a key\n"
615         "  reset                     Reset the value of a key\n"
616         "  reset-recursively         Reset all values in a given schema\n"
617         "  writable                  Check if a key is writable\n"
618         "  monitor                   Watch for changes\n"
619         "\n"
620         "Use 'gsettings help COMMAND' to get detailed help.\n\n"));
621     }
622   else
623     {
624       g_string_append_printf (string, _("Usage:\n  gsettings [--schemadir SCHEMADIR] %s %s\n\n%s\n\n"),
625                               command, synopsis[0] ? _(synopsis) : "", description);
626
627       g_string_append (string, _("Arguments:\n"));
628
629       g_string_append (string,
630                        _("  SCHEMADIR A directory to search for additional schemas\n"));
631
632       if (strstr (synopsis, "[COMMAND]"))
633         g_string_append (string,
634                        _("  COMMAND   The (optional) command to explain\n"));
635
636       else if (strstr (synopsis, "SCHEMA"))
637         g_string_append (string,
638                        _("  SCHEMA    The name of the schema\n"
639                          "  PATH      The path, for relocatable schemas\n"));
640
641       if (strstr (synopsis, "[KEY]"))
642         g_string_append (string,
643                        _("  KEY       The (optional) key within the schema\n"));
644
645       else if (strstr (synopsis, "KEY"))
646         g_string_append (string,
647                        _("  KEY       The key within the schema\n"));
648
649       if (strstr (synopsis, "VALUE"))
650         g_string_append (string,
651                        _("  VALUE     The value to set\n"));
652
653       g_string_append (string, "\n");
654     }
655
656   if (requested)
657     g_print ("%s", string->str);
658   else
659     g_printerr ("%s\n", string->str);
660
661   g_string_free (string, TRUE);
662
663   return requested ? 0 : 1;
664 }
665
666
667 int
668 main (int argc, char **argv)
669 {
670   void (* function) (void);
671
672 #ifdef G_OS_WIN32
673   gchar *tmp;
674 #endif
675
676   setlocale (LC_ALL, "");
677   textdomain (GETTEXT_PACKAGE);
678
679 #ifdef G_OS_WIN32
680   tmp = _glib_get_locale_dir ();
681   bindtextdomain (GETTEXT_PACKAGE, tmp);
682   g_free (tmp);
683 #else
684   bindtextdomain (GETTEXT_PACKAGE, GLIB_LOCALE_DIR);
685 #endif
686
687 #ifdef HAVE_BIND_TEXTDOMAIN_CODESET
688   bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
689 #endif
690
691   if (argc < 2)
692     return gsettings_help (FALSE, NULL);
693
694   global_schema_source = g_settings_schema_source_ref (g_settings_schema_source_get_default ());
695
696   if (argc > 3 && g_str_equal (argv[1], "--schemadir"))
697     {
698       GSettingsSchemaSource *parent = global_schema_source;
699       GError *error = NULL;
700
701       global_schema_source = g_settings_schema_source_new_from_directory (argv[2], parent, FALSE, &error);
702       g_settings_schema_source_unref (parent);
703
704       if (global_schema_source == NULL)
705         {
706           g_printerr (_("Could not load schemas from %s: %s\n"), argv[2], error->message);
707           g_clear_error (&error);
708
709           return 1;
710         }
711
712       /* shift remaining arguments (not correct wrt argv[0], but doesn't matter) */
713       argv = argv + 2;
714       argc -= 2;
715     }
716
717   if (strcmp (argv[1], "help") == 0)
718     return gsettings_help (TRUE, argv[2]);
719
720   else if (argc == 2 && strcmp (argv[1], "--version") == 0)
721     function = gsettings_print_version;
722
723   else if (argc == 2 && strcmp (argv[1], "list-schemas") == 0)
724     function = gsettings_list_schemas;
725
726   else if (argc == 2 && strcmp (argv[1], "list-relocatable-schemas") == 0)
727     function = gsettings_list_relocatable_schemas;
728
729   else if (argc == 3 && strcmp (argv[1], "list-keys") == 0)
730     function = gsettings_list_keys;
731
732   else if (argc == 3 && strcmp (argv[1], "list-children") == 0)
733     function = gsettings_list_children;
734
735   else if ((argc == 2 || argc == 3) && strcmp (argv[1], "list-recursively") == 0)
736     function = gsettings_list_recursively;
737
738   else if (argc == 4 && strcmp (argv[1], "range") == 0)
739     function = gsettings_range;
740
741   else if (argc == 4 && strcmp (argv[1], "get") == 0)
742     function = gsettings_get;
743
744   else if (argc == 5 && strcmp (argv[1], "set") == 0)
745     function = gsettings_set;
746
747   else if (argc == 4 && strcmp (argv[1], "reset") == 0)
748     function = gsettings_reset;
749
750   else if (argc == 3 && strcmp (argv[1], "reset-recursively") == 0)
751     function = gsettings_reset_recursively;
752
753   else if (argc == 4 && strcmp (argv[1], "writable") == 0)
754     function = gsettings_writable;
755
756   else if ((argc == 3 || argc == 4) && strcmp (argv[1], "monitor") == 0)
757     function = gsettings_monitor;
758
759   else
760     return gsettings_help (FALSE, argv[1]);
761
762   if (argc > 2)
763     {
764       gchar **parts;
765
766       if (argv[2][0] == '\0')
767         {
768           g_printerr (_("Empty schema name given\n"));
769           return 1;
770         }
771
772       parts = g_strsplit (argv[2], ":", 2);
773
774       global_schema = g_settings_schema_source_lookup (global_schema_source, parts[0], TRUE);
775       if (parts[1])
776         {
777           if (!check_relocatable_schema (global_schema, parts[0]) || !check_path (parts[1]))
778             return 1;
779
780           global_settings = g_settings_new_full (global_schema, NULL, parts[1]);
781         }
782       else
783         {
784           if (!check_schema (global_schema, parts[0]))
785             return 1;
786
787           global_settings = g_settings_new_full (global_schema, NULL, NULL);
788         }
789
790       g_strfreev (parts);
791     }
792
793   if (argc > 3)
794     {
795       if (!g_settings_schema_has_key (global_schema, argv[3]))
796         {
797           g_printerr (_("No such key '%s'\n"), argv[3]);
798           return 1;
799         }
800
801       global_key = argv[3];
802       global_schema_key = g_settings_schema_get_key (global_schema, global_key);
803     }
804
805   if (argc > 4)
806     global_value = argv[4];
807
808   (* function) ();
809
810
811   g_clear_pointer (&global_schema_source, g_settings_schema_source_unref);
812   g_clear_pointer (&global_schema_key, g_settings_schema_key_unref);
813   g_clear_pointer (&global_schema, g_settings_schema_unref);
814   g_clear_object (&global_settings);
815
816   return 0;
817 }