gsettings-tool: Add --version into general usage
[platform/upstream/glib.git] / gio / gsettings-tool.c
index c751eeb..fd6d910 100644 (file)
  * Author: Ryan Lortie <desrt@desrt.ca>
  */
 
+#include "config.h"
+
 #include <gio/gio.h>
+#include <gi18n.h>
+#include <locale.h>
 #include <string.h>
 #include <stdlib.h>
 
+#ifdef G_OS_WIN32
+#include "glib/glib-private.h"
+#endif
+
 static gboolean
 contained (const gchar * const *items,
            const gchar         *item)
@@ -35,49 +43,51 @@ contained (const gchar * const *items,
 }
 
 static gboolean
-is_schema (const gchar *schema)
-{
-  return contained (g_settings_list_schemas (), schema);
-}
-
-static gboolean
-is_relocatable_schema (const gchar *schema)
+is_relocatable_schema (GSettingsSchema *schema)
 {
-  return contained (g_settings_list_relocatable_schemas (), schema);
+  return g_settings_schema_get_path (schema) == NULL;
 }
 
 static gboolean
-check_relocatable_schema (const gchar *schema)
+check_relocatable_schema (GSettingsSchema *schema,
+                          const gchar     *schema_id)
 {
-  if (is_relocatable_schema (schema))
-    return TRUE;
-
-  if (is_schema (schema))
-    g_printerr ("Schema '%s' is not relocatable "
-                "(path must not be specified)\n",
-                schema);
+  if (schema == NULL)
+    {
+      g_printerr (_("No such schema '%s'\n"), schema_id);
+      return FALSE;
+    }
 
-  else
-    g_printerr ("No such schema '%s'\n", schema);
+  if (!is_relocatable_schema (schema))
+    {
+      g_printerr (_("Schema '%s' is not relocatable "
+                    "(path must not be specified)\n"),
+                  schema_id);
+      return FALSE;
+    }
 
-  return FALSE;
+  return TRUE;
 }
 
 static gboolean
-check_schema (const gchar *schema)
+check_schema (GSettingsSchema *schema,
+              const gchar *schema_id)
 {
-  if (is_schema (schema))
-    return TRUE;
+  if (schema == NULL)
+    {
+      g_printerr (_("No such schema '%s'\n"), schema_id);
+      return FALSE;
+    }
 
   if (is_relocatable_schema (schema))
-    g_printerr ("Schema '%s' is relocatable "
-                "(path must be specified)\n",
-                schema);
-
-  else
-    g_printerr ("No such schema '%s'\n", schema);
+    {
+      g_printerr (_("Schema '%s' is relocatable "
+                    "(path must be specified)\n"),
+                  schema_id);
+      return FALSE;
+    }
 
-  return FALSE;
+  return TRUE;
 }
 
 static gboolean
@@ -85,25 +95,25 @@ check_path (const gchar *path)
 {
   if (path[0] == '\0')
     {
-      g_printerr ("Empty path given.\n");
+      g_printerr (_("Empty path given.\n"));
       return FALSE;
     }
 
   if (path[0] != '/')
     {
-      g_printerr ("Path must begin with a slash (/)\n");
+      g_printerr (_("Path must begin with a slash (/)\n"));
       return FALSE;
     }
 
   if (!g_str_has_suffix (path, "/"))
     {
-      g_printerr ("Path must end with a slash (/)\n");
+      g_printerr (_("Path must end with a slash (/)\n"));
       return FALSE;
     }
 
   if (strstr (path, "//"))
     {
-      g_printerr ("Path must not contain two adjacent slashes (//)\n");
+      g_printerr (_("Path must not contain two adjacent slashes (//)\n"));
       return FALSE;
     }
 
@@ -124,7 +134,7 @@ check_key (GSettings   *settings,
   if (good)
     return TRUE;
 
-  g_printerr ("No such key '%s'\n", key);
+  g_printerr (_("No such key '%s'\n"), key);
 
   return FALSE;
 }
@@ -139,6 +149,15 @@ output_list (const gchar * const *list)
 }
 
 static void
+gsettings_print_version (GSettings   *settings,
+                         const gchar *key,
+                         const gchar *value)
+{
+  g_print ("%d.%d.%d\n", glib_major_version, glib_minor_version,
+           glib_micro_version);
+}
+
+static void
 gsettings_list_schemas (GSettings   *settings,
                         const gchar *key,
                         const gchar *value)
@@ -183,22 +202,22 @@ gsettings_list_children (GSettings   *settings,
   for (i = 0; children[i]; i++)
     {
       GSettings *child;
-      gchar *schema;
+      GSettingsSchema *schema;
       gchar *path;
 
       child = g_settings_get_child (settings, children[i]);
       g_object_get (child,
-                    "schema", &schema,
+                    "settings-schema", &schema,
                     "path", &path,
                     NULL);
 
-      if (is_schema (schema))
-        g_print ("%-*s   %s\n", max, children[i], schema);
+      if (g_settings_schema_get_path (schema) != NULL)
+        g_print ("%-*s   %s\n", max, children[i], g_settings_schema_get_id (schema));
       else
-        g_print ("%-*s   %s:%s\n", max, children[i], schema, path);
+        g_print ("%-*s   %s:%s\n", max, children[i], g_settings_schema_get_id (schema), path);
 
       g_object_unref (child);
-      g_free (schema);
+      g_settings_schema_unref (schema);
       g_free (path);
     }
 
@@ -206,6 +225,124 @@ gsettings_list_children (GSettings   *settings,
 }
 
 static void
+enumerate (GSettings *settings)
+{
+  gchar **keys;
+  gchar *schema;
+  gint i;
+
+  g_object_get (settings, "schema-id", &schema, NULL);
+
+  keys = g_settings_list_keys (settings);
+  for (i = 0; keys[i]; i++)
+    {
+      GVariant *value;
+      gchar *printed;
+
+      value = g_settings_get_value (settings, keys[i]);
+      printed = g_variant_print (value, TRUE);
+      g_print ("%s %s %s\n", schema, keys[i], printed);
+      g_variant_unref (value);
+      g_free (printed);
+    }
+
+  g_free (schema);
+  g_strfreev (keys);
+}
+
+static void
+gsettings_list_recursively (GSettings   *settings,
+                            const gchar *key,
+                            const gchar *value)
+{
+  if (settings)
+    {
+      gchar **children;
+      gint i;
+
+      enumerate (settings);
+      children = g_settings_list_children (settings);
+      for (i = 0; children[i]; i++)
+        {
+          GSettings *child;
+
+          child = g_settings_get_child (settings, children[i]);
+          gsettings_list_recursively (child, NULL, NULL);
+          g_object_unref (child);
+        }
+
+      g_strfreev (children);
+    }
+  else
+    {
+      const gchar * const *schemas;
+      gint i;
+
+      schemas = g_settings_list_schemas ();
+
+      for (i = 0; schemas[i]; i++)
+        {
+          settings = g_settings_new (schemas[i]);
+          gsettings_list_recursively (settings, NULL, NULL);
+          g_object_unref (settings);
+        }
+    }
+}
+
+static void
+gsettings_range (GSettings   *settings,
+                 const gchar *key,
+                 const gchar *value)
+{
+  GVariant *range, *detail;
+  const gchar *type;
+
+  range = g_settings_get_range (settings, key);
+  g_variant_get (range, "(&sv)", &type, &detail);
+
+  if (strcmp (type, "type") == 0)
+    g_print ("type %s\n", g_variant_get_type_string (detail) + 1);
+
+  else if (strcmp (type, "range") == 0)
+    {
+      GVariant *min, *max;
+      gchar *smin, *smax;
+
+      g_variant_get (detail, "(**)", &min, &max);
+      smin = g_variant_print (min, FALSE);
+      smax = g_variant_print (max, FALSE);
+
+      g_print ("range %s %s %s\n",
+               g_variant_get_type_string (min), smin, smax);
+      g_variant_unref (min);
+      g_variant_unref (max);
+      g_free (smin);
+      g_free (smax);
+    }
+
+  else if (strcmp (type, "enum") == 0 || strcmp (type, "flags") == 0)
+    {
+      GVariantIter iter;
+      GVariant *item;
+
+      g_print ("%s\n", type);
+
+      g_variant_iter_init (&iter, detail);
+      while (g_variant_iter_loop (&iter, "*", &item))
+        {
+          gchar *printed;
+
+          printed = g_variant_print (item, FALSE);
+          g_print ("%s\n", printed);
+          g_free (printed);
+        }
+    }
+
+  g_variant_unref (detail);
+  g_variant_unref (range);
+}
+
+static void
 gsettings_get (GSettings   *settings,
                const gchar *key,
                const gchar *value_)
@@ -230,6 +367,49 @@ gsettings_reset (GSettings   *settings,
 }
 
 static void
+reset_all_keys (GSettings   *settings)
+{
+  gchar **keys;
+  gint i;
+
+  keys = g_settings_list_keys (settings);
+  for (i = 0; keys[i]; i++)
+    {
+      g_settings_reset (settings, keys[i]);
+    }
+
+  g_strfreev (keys);
+}
+
+static void
+gsettings_reset_recursively (GSettings   *settings,
+                             const gchar *key,
+                             const gchar *value)
+{
+  gchar **children;
+  gint i;
+
+  g_settings_delay (settings);
+
+  reset_all_keys (settings);
+  children = g_settings_list_children (settings);
+  for (i = 0; children[i]; i++)
+    {
+      GSettings *child;
+      child = g_settings_get_child (settings, children[i]);
+
+      reset_all_keys (child);
+
+      g_object_unref (child);
+    }
+
+  g_strfreev (children);
+
+  g_settings_apply (settings);
+  g_settings_sync ();
+}
+
+static void
 gsettings_writable (GSettings   *settings,
                     const gchar *key,
                     const gchar *value)
@@ -281,12 +461,45 @@ gsettings_set (GSettings   *settings,
   GError *error = NULL;
   GVariant *existing;
   GVariant *new;
+  gchar *freeme = NULL;
 
   existing = g_settings_get_value (settings, key);
   type = g_variant_get_type (existing);
 
   new = g_variant_parse (type, value, NULL, NULL, &error);
 
+  /* If that didn't work and the type is string then we should assume
+   * that the user is just trying to set a string directly and forgot
+   * the quotes (or had them consumed by the shell).
+   *
+   * If the user started with a quote then we assume that some deeper
+   * problem is at play and we want the failure in that case.
+   *
+   * Consider:
+   *
+   *   gsettings set x.y.z key "'i don't expect this to work'"
+   *
+   * Note that we should not just add quotes and try parsing again, but
+   * rather assume that the user is providing us with a bare string.
+   * Assume we added single quotes, then consider this case:
+   *
+   *   gsettings set x.y.z key "i'd expect this to work"
+   *
+   * A similar example could be given for double quotes.
+   *
+   * Avoid that whole mess by just using g_variant_new_string().
+   */
+  if (new == NULL &&
+      g_variant_type_equal (type, G_VARIANT_TYPE_STRING) &&
+      value[0] != '\'' && value[0] != '"')
+    {
+      g_clear_error (&error);
+      new = g_variant_new_string (value);
+    }
+
+  /* we're done with 'type' now, so we can free 'existing' */
+  g_variant_unref (existing);
+
   if (new == NULL)
     {
       g_printerr ("%s\n", error->message);
@@ -295,16 +508,20 @@ gsettings_set (GSettings   *settings,
 
   if (!g_settings_range_check (settings, key, new))
     {
-      g_printerr ("The provided value is outside of the valid range\n");
+      g_printerr (_("The provided value is outside of the valid range\n"));
       g_variant_unref (new);
       exit (1);
     }
 
-  g_settings_set_value (settings, key, new);
-  g_variant_unref (existing);
-  g_variant_unref (new);
+  if (!g_settings_set_value (settings, key, new))
+    {
+      g_printerr (_("The key is not writable\n"));
+      exit (1);
+    }
 
   g_settings_sync ();
+
+  g_free (freeme);
 }
 
 static int
@@ -320,64 +537,95 @@ gsettings_help (gboolean     requested,
   if (command == NULL)
     ;
 
+  else if (strcmp (command, "help") == 0)
+    {
+      description = _("Print help");
+      synopsis = "[COMMAND]";
+    }
+
+  else if (strcmp (command, "--version") == 0)
+    {
+      description = _("Print version information and exit");
+      synopsis = "";
+    }
+
   else if (strcmp (command, "list-schemas") == 0)
     {
-      description = "List the installed (non-relocatable) schemas";
+      description = _("List the installed (non-relocatable) schemas");
       synopsis = "";
     }
 
   else if (strcmp (command, "list-relocatable-schemas") == 0)
     {
-      description = "List the installed relocatable schemas";
+      description = _("List the installed relocatable schemas");
       synopsis = "";
     }
 
   else if (strcmp (command, "list-keys") == 0)
     {
-      description = "Lists the keys in SCHEMA";
-      synopsis = "SCHEMA[:PATH]";
+      description = _("List the keys in SCHEMA");
+      synopsis = N_("SCHEMA[:PATH]");
     }
 
   else if (strcmp (command, "list-children") == 0)
     {
-      description = "Lists the children of SCHEMA";
-      synopsis = "SCHEMA[:PATH]";
+      description = _("List the children of SCHEMA");
+      synopsis = N_("SCHEMA[:PATH]");
+    }
+
+  else if (strcmp (command, "list-recursively") == 0)
+    {
+      description = _("List keys and values, recursively\n"
+                      "If no SCHEMA is given, list all keys\n");
+      synopsis = N_("[SCHEMA[:PATH]]");
     }
 
   else if (strcmp (command, "get") == 0)
     {
-      description = "Gets the value of KEY";
-      synopsis = "SCHEMA[:PATH] KEY";
+      description = _("Get the value of KEY");
+      synopsis = N_("SCHEMA[:PATH] KEY");
+    }
+
+  else if (strcmp (command, "range") == 0)
+    {
+      description = _("Query the range of valid values for KEY");
+      synopsis = N_("SCHEMA[:PATH] KEY");
     }
 
   else if (strcmp (command, "set") == 0)
     {
-      description = "Sets the value of KEY to VALUE";
-      synopsis = "SCHEMA[:PATH] KEY VALUE";
+      description = _("Set the value of KEY to VALUE");
+      synopsis = N_("SCHEMA[:PATH] KEY VALUE");
     }
 
   else if (strcmp (command, "reset") == 0)
     {
-      description = "Resets KEY to its default value";
-      synopsis = "SCHEMA[:PATH] KEY";
+      description = _("Reset KEY to its default value");
+      synopsis = N_("SCHEMA[:PATH] KEY");
+    }
+
+  else if (strcmp (command, "reset-recursively") == 0)
+    {
+      description = _("Reset all keys in SCHEMA to their defaults");
+      synopsis = N_("SCHEMA[:PATH]");
     }
 
   else if (strcmp (command, "writable") == 0)
     {
-      description = "Checks if KEY is writable";
-      synopsis = "SCHEMA[:PATH] KEY";
+      description = _("Check if KEY is writable");
+      synopsis = N_("SCHEMA[:PATH] KEY");
     }
 
   else if (strcmp (command, "monitor") == 0)
     {
-      description = "Monitors KEY for changes.\n"
+      description = _("Monitor KEY for changes.\n"
                     "If no KEY is specified, monitor all keys in SCHEMA.\n"
-                    "Use ^C to stop monitoring.\n";
-      synopsis = "SCHEMA[:PATH] [KEY]";
+                    "Use ^C to stop monitoring.\n");
+      synopsis = N_("SCHEMA[:PATH] [KEY]");
     }
   else
     {
-      g_string_printf (string, "Unknown command %s\n\n", command);
+      g_string_printf (string, _("Unknown command %s\n\n"), command);
       requested = FALSE;
       command = NULL;
     }
@@ -385,8 +633,9 @@ gsettings_help (gboolean     requested,
   if (command == NULL)
     {
       g_string_append (string,
-        "Usage:\n"
-        "  gsettings COMMAND [ARGS...]\n"
+      _("Usage:\n"
+        "  gsettings --version\n"
+        "  gsettings [--schemadir SCHEMADIR] COMMAND [ARGS...]\n"
         "\n"
         "Commands:\n"
         "  help                      Show this information\n"
@@ -394,48 +643,55 @@ gsettings_help (gboolean     requested,
         "  list-relocatable-schemas  List relocatable schemas\n"
         "  list-keys                 List keys in a schema\n"
         "  list-children             List children of a schema\n"
+        "  list-recursively          List keys and values, recursively\n"
+        "  range                     Queries the range of a key\n"
         "  get                       Get the value of a key\n"
         "  set                       Set the value of a key\n"
         "  reset                     Reset the value of a key\n"
+        "  reset-recursively         Reset all values in a given schema\n"
         "  writable                  Check if a key is writable\n"
         "  monitor                   Watch for changes\n"
         "\n"
-        "Use 'gsettings help COMMAND' to get detailed help.\n\n");
+        "Use 'gsettings help COMMAND' to get detailed help.\n\n"));
     }
   else
     {
-      g_string_append_printf (string, "Usage:\n  gsettings %s %s\n\n%s\n\n",
-                              command, synopsis, description);
+      g_string_append_printf (string, _("Usage:\n  gsettings [--schemadir SCHEMADIR] %s %s\n\n%s\n\n"),
+                              command, synopsis[0] ? _(synopsis) : "", description);
 
-      if (synopsis[0])
-        {
-          g_string_append (string, "Arguments:\n");
+      g_string_append (string, _("Arguments:\n"));
 
-          if (strstr (synopsis, "SCHEMA"))
-            g_string_append (string,
-                             "  SCHEMA    The name of the schema\n"
-                             "  PATH      The path, for relocatable schemas\n");
+      g_string_append (string,
+                       _("  SCHEMADIR A directory to search for additional schemas\n"));
 
-          if (strstr (synopsis, "[KEY]"))
-            g_string_append (string,
-                             "  KEY       The (optional) key within the schema\n");
+      if (strstr (synopsis, "[COMMAND]"))
+        g_string_append (string,
+                       _("  COMMAND   The (optional) command to explain\n"));
 
-          else if (strstr (synopsis, "KEY"))
-            g_string_append (string,
-                             "  KEY       The key within the schema\n");
+      else if (strstr (synopsis, "SCHEMA"))
+        g_string_append (string,
+                       _("  SCHEMA    The name of the schema\n"
+                         "  PATH      The path, for relocatable schemas\n"));
 
-          if (strstr (synopsis, "VALUE"))
-            g_string_append (string,
-                             "  VALUE     The value to set\n");
+      if (strstr (synopsis, "[KEY]"))
+        g_string_append (string,
+                       _("  KEY       The (optional) key within the schema\n"));
 
-          g_string_append (string, "\n");
-        }
+      else if (strstr (synopsis, "KEY"))
+        g_string_append (string,
+                       _("  KEY       The key within the schema\n"));
+
+      if (strstr (synopsis, "VALUE"))
+        g_string_append (string,
+                       _("  VALUE     The value to set\n"));
+
+      g_string_append (string, "\n");
     }
 
   if (requested)
     g_print ("%s", string->str);
   else
-    g_printerr ("%s", string->str);
+    g_printerr ("%s\n", string->str);
 
   g_string_free (string, TRUE);
 
@@ -447,15 +703,62 @@ int
 main (int argc, char **argv)
 {
   void (* function) (GSettings *, const gchar *, const gchar *);
+  GSettingsSchemaSource *schema_source;
+  GSettingsSchema *schema;
   GSettings *settings;
   const gchar *key;
 
+#ifdef G_OS_WIN32
+  gchar *tmp;
+#endif
+
+  setlocale (LC_ALL, "");
+  textdomain (GETTEXT_PACKAGE);
+
+#ifdef G_OS_WIN32
+  tmp = _glib_get_locale_dir ();
+  bindtextdomain (GETTEXT_PACKAGE, tmp);
+  g_free (tmp);
+#else
+  bindtextdomain (GETTEXT_PACKAGE, GLIB_LOCALE_DIR);
+#endif
+
+#ifdef HAVE_BIND_TEXTDOMAIN_CODESET
+  bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
+#endif
+
   if (argc < 2)
     return gsettings_help (FALSE, NULL);
 
-  else if (strcmp (argv[1], "help") == 0)
+  schema_source = g_settings_schema_source_ref (g_settings_schema_source_get_default ());
+
+  if (argc > 3 && g_str_equal (argv[1], "--schemadir"))
+    {
+      GSettingsSchemaSource *parent = schema_source;
+      GError *error = NULL;
+
+      schema_source = g_settings_schema_source_new_from_directory (argv[2], parent, FALSE, &error);
+      g_settings_schema_source_unref (parent);
+
+      if (schema_source == NULL)
+        {
+          g_printerr (_("Could not load schemas from %s: %s\n"), argv[2], error->message);
+          g_clear_error (&error);
+
+          return 1;
+        }
+
+      /* shift remaining arguments (not correct wrt argv[0], but doesn't matter) */
+      argv = argv + 2;
+      argc -= 2;
+    }
+
+  if (strcmp (argv[1], "help") == 0)
     return gsettings_help (TRUE, argv[2]);
 
+  else if (argc == 2 && strcmp (argv[1], "--version") == 0)
+    function = gsettings_print_version;
+
   else if (argc == 2 && strcmp (argv[1], "list-schemas") == 0)
     function = gsettings_list_schemas;
 
@@ -468,6 +771,12 @@ main (int argc, char **argv)
   else if (argc == 3 && strcmp (argv[1], "list-children") == 0)
     function = gsettings_list_children;
 
+  else if ((argc == 2 || argc == 3) && strcmp (argv[1], "list-recursively") == 0)
+    function = gsettings_list_recursively;
+
+  else if (argc == 4 && strcmp (argv[1], "range") == 0)
+    function = gsettings_range;
+
   else if (argc == 4 && strcmp (argv[1], "get") == 0)
     function = gsettings_get;
 
@@ -477,6 +786,9 @@ main (int argc, char **argv)
   else if (argc == 4 && strcmp (argv[1], "reset") == 0)
     function = gsettings_reset;
 
+  else if (argc == 3 && strcmp (argv[1], "reset-recursively") == 0)
+    function = gsettings_reset_recursively;
+
   else if (argc == 4 && strcmp (argv[1], "writable") == 0)
     function = gsettings_writable;
 
@@ -486,39 +798,41 @@ main (int argc, char **argv)
   else
     return gsettings_help (FALSE, argv[1]);
 
-  g_type_init ();
-
   if (argc > 2)
     {
       gchar **parts;
 
       if (argv[2][0] == '\0')
         {
-          g_printerr ("Empty schema name given");
+          g_printerr (_("Empty schema name given\n"));
           return 1;
         }
 
       parts = g_strsplit (argv[2], ":", 2);
 
+      schema = g_settings_schema_source_lookup (schema_source, parts[0], TRUE);
       if (parts[1])
         {
-          if (!check_relocatable_schema (parts[0]) || !check_path (parts[1]))
+          if (!check_relocatable_schema (schema, parts[0]) || !check_path (parts[1]))
             return 1;
 
-          settings = g_settings_new_with_path (parts[0], parts[1]);
+          settings = g_settings_new_full (schema, NULL, parts[1]);
         }
       else
         {
-          if (!check_schema (parts[0]))
+          if (!check_schema (schema, parts[0]))
             return 1;
 
-          settings = g_settings_new (parts[0]);
+          settings = g_settings_new_full (schema, NULL, NULL);
         }
 
       g_strfreev (parts);
     }
   else
-    settings = NULL;
+    {
+      settings = NULL;
+      schema = NULL;
+    }
 
   if (argc > 3)
     {
@@ -534,6 +848,10 @@ main (int argc, char **argv)
 
   if (settings != NULL)
     g_object_unref (settings);
+  if (schema != NULL)
+    g_settings_schema_unref (schema);
+
+  g_settings_schema_source_unref (schema_source);
 
   return 0;
 }