gio/gsettingsbackend.c

   1 /*
   2  * Copyright © 2009, 2010 Codethink Limited
   3  * Copyright © 2010 Red Hat, Inc.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the licence, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Authors: Ryan Lortie <desrt@desrt.ca>
  21  *          Matthias Clasen <mclasen@redhat.com>
  22  */
  23
  24 #include "config.h"
  25
  26 #include "gsettingsbackendinternal.h"
  27 #include "gnullsettingsbackend.h"
  28 #include "giomodule-priv.h"
  29 #include "gio-marshal.h"
  30
  31 #include <string.h>
  32 #include <stdlib.h>
  33 #include <glib.h>
  34 #include <glibintl.h>
  35
  36 #include "gioalias.h"
  37
  38 G_DEFINE_ABSTRACT_TYPE (GSettingsBackend, g_settings_backend, G_TYPE_OBJECT)
  39
  40 typedef struct _GSettingsBackendWatch GSettingsBackendWatch;
  41
  42 struct _GSettingsBackendPrivate
  43 {
  44   GSettingsBackendWatch *watches;
  45   gchar *context;
  46 };
  47
  48 enum
  49 {
  50   PROP_0,
  51   PROP_CONTEXT
  52 };
  53
  54 /**
  55  * SECTION:gsettingsbackend
  56  * @title: GSettingsBackend
  57  * @short_description: an interface for settings backend implementations
  58  * @include: gio/gsettingsbackend.h
  59  * @see_also: #GSettings, #GIOExtensionPoint
  60  *
  61  * The #GSettingsBackend interface defines a generic interface for
  62  * non-strictly-typed data that is stored in a hierarchy. To implement
  63  * an alternative storage backend for #GSettings, you need to implement
  64  * the #GSettingsBackend interface and then make it implement the
  65  * extension point #G_SETTINGS_BACKEND_EXTENSION_POINT_NAME.
  66  *
  67  * The interface defines methods for reading and writing values, a
  68  * method for determining if writing of certain values will fail
  69  * (lockdown) and a change notification mechanism.
  70  *
  71  * The semantics of the interface are very precisely defined and
  72  * implementations must carefully adhere to the expectations of
  73  * callers that are documented on each of the interface methods.
  74  *
  75  * Some of the GSettingsBackend functions accept or return a #GTree.
  76  * These trees always have strings as keys and #GVariant as values.
  77  * g_settings_backend_create_tree() is a convenience function to create
  78  * suitable trees.
  79  *
  80  * <note><para>
  81  * The #GSettingsBackend API is exported to allow third-party
  82  * implementations, but does not carry the same stability guarantees
  83  * as the public GIO API. For this reason, you have to define the
  84  * C preprocessor symbol #G_SETTINGS_ENABLE_BACKEND before including
  85  * <filename>gio/gsettingsbackend.h</filename>
  86  * </para></note>
  87  **/
  88
  89 struct _GSettingsBackendWatch
  90 {
  91   GSettingsBackendChangedFunc              changed;
  92   GSettingsBackendPathChangedFunc          path_changed;
  93   GSettingsBackendKeysChangedFunc          keys_changed;
  94   GSettingsBackendWritableChangedFunc      writable_changed;
  95   GSettingsBackendPathWritableChangedFunc  path_writable_changed;
  96   gpointer                                 user_data;
  97
  98   GSettingsBackendWatch                   *next;
  99 };
 100
 101 void
 102 g_settings_backend_watch (GSettingsBackend                        *backend,
 103                           GSettingsBackendChangedFunc              changed,
 104                           GSettingsBackendPathChangedFunc          path_changed,
 105                           GSettingsBackendKeysChangedFunc          keys_changed,
 106                           GSettingsBackendWritableChangedFunc      writable_changed,
 107                           GSettingsBackendPathWritableChangedFunc  path_writable_changed,
 108                           gpointer                                 user_data)
 109 {
 110   GSettingsBackendWatch *watch;
 111
 112   watch = g_slice_new (GSettingsBackendWatch);
 113   watch->changed = changed;
 114   watch->path_changed = path_changed;
 115   watch->keys_changed = keys_changed;
 116   watch->writable_changed = writable_changed;
 117   watch->path_writable_changed = path_writable_changed;
 118   watch->user_data = user_data;
 119
 120   watch->next = backend->priv->watches;
 121   backend->priv->watches = watch;
 122 }
 123
 124 void
 125 g_settings_backend_unwatch (GSettingsBackend *backend,
 126                             gpointer          user_data)
 127 {
 128   GSettingsBackendWatch **ptr;
 129
 130   for (ptr = &backend->priv->watches; *ptr; ptr = &(*ptr)->next)
 131     if ((*ptr)->user_data == user_data)
 132       {
 133         GSettingsBackendWatch *tmp = *ptr;
 134
 135         *ptr = tmp->next;
 136         g_slice_free (GSettingsBackendWatch, tmp);
 137
 138         return;
 139       }
 140
 141   g_assert_not_reached ();
 142 }
 143
 144 static gboolean
 145 is_key (const gchar *key)
 146 {
 147   gint length;
 148   gint i;
 149
 150   g_return_val_if_fail (key != NULL, FALSE);
 151   g_return_val_if_fail (key[0] == '/', FALSE);
 152
 153   for (i = 1; key[i]; i++)
 154     g_return_val_if_fail (key[i] != '/' || key[i + 1] != '/', FALSE);
 155
 156   length = i;
 157
 158   g_return_val_if_fail (key[length - 1] != '/', FALSE);
 159
 160   return TRUE;
 161 }
 162
 163 static gboolean
 164 is_path (const gchar *path)
 165 {
 166   gint length;
 167   gint i;
 168
 169   g_return_val_if_fail (path != NULL, FALSE);
 170   g_return_val_if_fail (path[0] == '/', FALSE);
 171
 172   for (i = 1; path[i]; i++)
 173     g_return_val_if_fail (path[i] != '/' || path[i + 1] != '/', FALSE);
 174
 175   length = i;
 176
 177   g_return_val_if_fail (path[length - 1] == '/', FALSE);
 178
 179   return TRUE;
 180 }
 181
 182 /**
 183  * g_settings_backend_changed:
 184  * @backend: a #GSettingsBackend implementation
 185  * @key: the name of the key
 186  * @origin_tag: the origin tag
 187  *
 188  * Signals that a single key has possibly changed.  Backend
 189  * implementations should call this if a key has possibly changed its
 190  * value.
 191  *
 192  * @key must be a valid key (ie: starting with a slash, not containing
 193  * '//', and not ending with a slash).
 194  *
 195  * The implementation must call this function during any call to
 196  * g_settings_backend_write(), before the call returns (except in the
 197  * case that no keys are actually changed and it cares to detect this
 198  * fact).  It may not rely on the existence of a mainloop for
 199  * dispatching the signal later.
 200  *
 201  * The implementation may call this function at any other time it likes
 202  * in response to other events (such as changes occuring outside of the
 203  * program).  These calls may originate from a mainloop or may originate
 204  * in response to any other action (including from calls to
 205  * g_settings_backend_write()).
 206  *
 207  * In the case that this call is in response to a call to
 208  * g_settings_backend_write() then @origin_tag must be set to the same
 209  * value that was passed to that call.
 210  *
 211  * Since: 2.26
 212  **/
 213 void
 214 g_settings_backend_changed (GSettingsBackend *backend,
 215                             const gchar      *key,
 216                             gpointer          origin_tag)
 217 {
 218   GSettingsBackendWatch *watch;
 219
 220   g_return_if_fail (G_IS_SETTINGS_BACKEND (backend));
 221   g_return_if_fail (is_key (key));
 222
 223   for (watch = backend->priv->watches; watch; watch = watch->next)
 224     watch->changed (backend, key, origin_tag, watch->user_data);
 225 }
 226
 227 /**
 228  * g_settings_backend_keys_changed:
 229  * @backend: a #GSettingsBackend implementation
 230  * @path: the path containing the changes
 231  * @items: the %NULL-terminated list of changed keys
 232  * @origin_tag: the origin tag
 233  *
 234  * Signals that a list of keys have possibly changed.  Backend
 235  * implementations should call this if keys have possibly changed their
 236  * values.
 237  *
 238  * @path must be a valid path (ie: starting and ending with a slash and
 239  * not containing '//').  Each string in @items must form a valid key
 240  * name when @path is prefixed to it (ie: each item must not start or
 241  * end with '/' and must not contain '//').
 242  *
 243  * The meaning of this signal is that any of the key names resulting
 244  * from the contatenation of @path with each item in @items may have
 245  * changed.
 246  *
 247  * The same rules for when notifications must occur apply as per
 248  * g_settings_backend_changed().  These two calls can be used
 249  * interchangeably if exactly one item has changed (although in that
 250  * case g_settings_backend_changed() is definitely preferred).
 251  *
 252  * For efficiency reasons, the implementation should strive for @path to
 253  * be as long as possible (ie: the longest common prefix of all of the
 254  * keys that were changed) but this is not strictly required.
 255  *
 256  * Since: 2.26
 257  */
 258 void
 259 g_settings_backend_keys_changed (GSettingsBackend    *backend,
 260                                  const gchar         *path,
 261                                  gchar const * const *items,
 262                                  gpointer             origin_tag)
 263 {
 264   GSettingsBackendWatch *watch;
 265
 266   g_return_if_fail (G_IS_SETTINGS_BACKEND (backend));
 267   g_return_if_fail (path[0] == '\0' || is_path (path));
 268   g_return_if_fail (items != NULL);
 269
 270   for (watch = backend->priv->watches; watch; watch = watch->next)
 271     watch->keys_changed (backend, path, items, origin_tag, watch->user_data);
 272 }
 273
 274 /**
 275  * g_settings_backend_path_changed:
 276  * @backend: a #GSettingsBackend implementation
 277  * @path: the path containing the changes
 278  * @origin_tag: the origin tag
 279  *
 280  * Signals that all keys below a given path may have possibly changed.
 281  * Backend implementations should call this if an entire path of keys
 282  * have possibly changed their values.
 283  *
 284  * @path must be a valid path (ie: starting and ending with a slash and
 285  * not containing '//').
 286  *
 287  * The meaning of this signal is that any of the key which has a name
 288  * starting with @path may have changed.
 289  *
 290  * The same rules for when notifications must occur apply as per
 291  * g_settings_backend_changed().  This call might be an appropriate
 292  * reasponse to a 'reset' call but implementations are also free to
 293  * explicitly list the keys that were affected by that call if they can
 294  * easily do so.
 295  *
 296  * For efficiency reasons, the implementation should strive for @path to
 297  * be as long as possible (ie: the longest common prefix of all of the
 298  * keys that were changed) but this is not strictly required.  As an
 299  * example, if this function is called with the path of "/" then every
 300  * single key in the application will be notified of a possible change.
 301  *
 302  * Since: 2.26
 303  */
 304 void
 305 g_settings_backend_path_changed (GSettingsBackend *backend,
 306                                  const gchar      *path,
 307                                  gpointer          origin_tag)
 308 {
 309   GSettingsBackendWatch *watch;
 310
 311   g_return_if_fail (G_IS_SETTINGS_BACKEND (backend));
 312   g_return_if_fail (is_path (path));
 313
 314   for (watch = backend->priv->watches; watch; watch = watch->next)
 315     watch->path_changed (backend, path, origin_tag, watch->user_data);
 316 }
 317
 318 /**
 319  * g_settings_backend_writable_changed:
 320  * @backend: a #GSettingsBackend implementation
 321  * @key: the name of the key
 322  *
 323  * Signals that the writability of a single key has possibly changed.
 324  *
 325  * Since GSettings performs no locking operations for itself, this call
 326  * will always be made in response to external events.
 327  *
 328  * Since: 2.26
 329  **/
 330 void
 331 g_settings_backend_writable_changed (GSettingsBackend *backend,
 332                                      const gchar      *key)
 333 {
 334   GSettingsBackendWatch *watch;
 335
 336   g_return_if_fail (G_IS_SETTINGS_BACKEND (backend));
 337   g_return_if_fail (is_key (key));
 338
 339   for (watch = backend->priv->watches; watch; watch = watch->next)
 340     watch->writable_changed (backend, key, watch->user_data);
 341 }
 342
 343 /**
 344  * g_settings_backend_path_writable_changed:
 345  * @backend: a #GSettingsBackend implementation
 346  * @path: the name of the path
 347  *
 348  * Signals that the writability of all keys below a given path may have
 349  * changed.
 350  *
 351  * Since GSettings performs no locking operations for itself, this call
 352  * will always be made in response to external events.
 353  *
 354  * Since: 2.26
 355  **/
 356 void
 357 g_settings_backend_path_writable_changed (GSettingsBackend *backend,
 358                                           const gchar      *path)
 359 {
 360   GSettingsBackendWatch *watch;
 361
 362   g_return_if_fail (G_IS_SETTINGS_BACKEND (backend));
 363   g_return_if_fail (is_path (path));
 364
 365   for (watch = backend->priv->watches; watch; watch = watch->next)
 366     watch->path_writable_changed (backend, path, watch->user_data);
 367 }
 368
 369 typedef struct
 370 {
 371   const gchar **keys;
 372   GVariant **values;
 373   gint prefix_len;
 374   gchar *prefix;
 375 } FlattenState;
 376
 377 static gboolean
 378 g_settings_backend_flatten_one (gpointer key,
 379                                 gpointer value,
 380                                 gpointer user_data)
 381 {
 382   FlattenState *state = user_data;
 383   const gchar *skey = key;
 384   gint i;
 385
 386   g_return_val_if_fail (is_key (key), TRUE);
 387
 388   /* calculate longest common prefix */
 389   if (state->prefix == NULL)
 390     {
 391       gchar *last_byte;
 392
 393       /* first key?  just take the prefix up to the last '/' */
 394       state->prefix = g_strdup (skey);
 395       last_byte = strrchr (state->prefix, '/') + 1;
 396       state->prefix_len = last_byte - state->prefix;
 397       *last_byte = '\0';
 398     }
 399   else
 400     {
 401       /* find the first character that does not match.  we will
 402        * definitely find one because the prefix ends in '/' and the key
 403        * does not.  also: no two keys in the tree are the same.
 404        */
 405       for (i = 0; state->prefix[i] == skey[i]; i++);
 406
 407       /* check if we need to shorten the prefix */
 408       if (state->prefix[i] != '\0')
 409         {
 410           /* find the nearest '/', terminate after it */
 411           while (state->prefix[i - 1] != '/')
 412             i--;
 413
 414           state->prefix[i] = '\0';
 415           state->prefix_len = i;
 416         }
 417     }
 418
 419
 420   /* save the entire item into the array.
 421    * the prefixes will be removed later.
 422    */
 423   *state->keys++ = key;
 424
 425   if (state->values)
 426     *state->values++ = value;
 427
 428   return FALSE;
 429 }
 430
 431 /**
 432  * g_settings_backend_flatten_tree:
 433  * @tree: a #GTree containing the changes
 434  * @path: the location to save the path
 435  * @keys: the location to save the relative keys
 436  * @values: the location to save the values, or %NULL
 437  *
 438  * Calculate the longest common prefix of all keys in a tree and write
 439  * out an array of the key names relative to that prefix and,
 440  * optionally, the value to store at each of those keys.
 441  *
 442  * You must free the value returned in @path, @keys and @values using
 443  * g_free().  You should not attempt to free or unref the contents of
 444  * @keys or @values.
 445  *
 446  * Since: 2.26
 447  **/
 448 void
 449 g_settings_backend_flatten_tree (GTree         *tree,
 450                                  gchar        **path,
 451                                  const gchar ***keys,
 452                                  GVariant    ***values)
 453 {
 454   FlattenState state = { 0, };
 455   gsize nnodes;
 456
 457   nnodes = g_tree_nnodes (tree);
 458
 459   *keys = state.keys = g_new (const gchar *, nnodes + 1);
 460   state.keys[nnodes] = NULL;
 461
 462   if (values != NULL)
 463     {
 464       *values = state.values = g_new (GVariant *, nnodes + 1);
 465       state.values[nnodes] = NULL;
 466     }
 467
 468   g_tree_foreach (tree, g_settings_backend_flatten_one, &state);
 469   g_return_if_fail (*keys + nnodes == state.keys);
 470
 471   *path = state.prefix;
 472   while (nnodes--)
 473     *--state.keys += state.prefix_len;
 474 }
 475
 476 /**
 477  * g_settings_backend_changed_tree:
 478  * @backend: a #GSettingsBackend implementation
 479  * @tree: a #GTree containing the changes
 480  * @origin_tag: the origin tag
 481  *
 482  * This call is a convenience wrapper.  It gets the list of changes from
 483  * @tree, computes the longest common prefix and calls
 484  * g_settings_backend_changed().
 485  *
 486  * Since: 2.26
 487  **/
 488 void
 489 g_settings_backend_changed_tree (GSettingsBackend *backend,
 490                                  GTree            *tree,
 491                                  gpointer          origin_tag)
 492 {
 493   GSettingsBackendWatch *watch;
 494   const gchar **keys;
 495   gchar *path;
 496
 497   g_return_if_fail (G_IS_SETTINGS_BACKEND (backend));
 498
 499   g_settings_backend_flatten_tree (tree, &path, &keys, NULL);
 500
 501   for (watch = backend->priv->watches; watch; watch = watch->next)
 502     watch->keys_changed (backend, path, keys, origin_tag, watch->user_data);
 503
 504   g_free (path);
 505   g_free (keys);
 506 }
 507
 508 /*< private >
 509  * g_settings_backend_read:
 510  * @backend: a #GSettingsBackend implementation
 511  * @key: the key to read
 512  * @expected_type: a #GVariantType hint
 513  * @returns: the value that was read, or %NULL
 514  *
 515  * Reads a key. This call will never block.
 516  *
 517  * If the key exists, the value associated with it will be returned.
 518  * If the key does not exist, %NULL will be returned.
 519  *
 520  * If @expected_type is given, it serves as a type hint to the backend.
 521  * If you expect a key of a certain type then you should give
 522  * @expected_type to increase your chances of getting it.  Some backends
 523  * may ignore this argument and return values of a different type; it is
 524  * mostly used by backends that don't store strong type information.
 525  */
 526 GVariant *
 527 g_settings_backend_read (GSettingsBackend   *backend,
 528                          const gchar        *key,
 529                          const GVariantType *expected_type,
 530                          gboolean            default_value)
 531 {
 532   return G_SETTINGS_BACKEND_GET_CLASS (backend)
 533     ->read (backend, key, expected_type, default_value);
 534 }
 535
 536 /*< private >
 537  * g_settings_backend_write:
 538  * @backend: a #GSettingsBackend implementation
 539  * @key: the name of the key
 540  * @value: a #GVariant value to write to this key
 541  * @origin_tag: the origin tag
 542  * @returns: %TRUE if the write succeeded, %FALSE if the key was not writable
 543  *
 544  * Writes exactly one key.
 545  *
 546  * This call does not fail.  During this call a
 547  * #GSettingsBackend::changed signal will be emitted if the value of the
 548  * key has changed.  The updated key value will be visible to any signal
 549  * callbacks.
 550  *
 551  * One possible method that an implementation might deal with failures is
 552  * to emit a second "changed" signal (either during this call, or later)
 553  * to indicate that the affected keys have suddenly "changed back" to their
 554  * old values.
 555  */
 556 gboolean
 557 g_settings_backend_write (GSettingsBackend *backend,
 558                           const gchar      *key,
 559                           GVariant         *value,
 560                           gpointer          origin_tag)
 561 {
 562   return G_SETTINGS_BACKEND_GET_CLASS (backend)
 563     ->write (backend, key, value, origin_tag);
 564 }
 565
 566 /*< private >
 567  * g_settings_backend_write_keys:
 568  * @backend: a #GSettingsBackend implementation
 569  * @values: a #GTree containing key-value pairs to write
 570  * @origin_tag: the origin tag
 571  *
 572  * Writes one or more keys.  This call will never block.
 573  *
 574  * The key of each item in the tree is the key name to write to and the
 575  * value is a #GVariant to write.  The proper type of #GTree for this
 576  * call can be created with g_settings_backend_create_tree().  This call
 577  * might take a reference to the tree; you must not modified the #GTree
 578  * after passing it to this call.
 579  *
 580  * This call does not fail.  During this call a #GSettingsBackend::changed
 581  * signal will be emitted if any keys have been changed.  The new values of
 582  * all updated keys will be visible to any signal callbacks.
 583  *
 584  * One possible method that an implementation might deal with failures is
 585  * to emit a second "changed" signal (either during this call, or later)
 586  * to indicate that the affected keys have suddenly "changed back" to their
 587  * old values.
 588  */
 589 gboolean
 590 g_settings_backend_write_keys (GSettingsBackend *backend,
 591                                GTree            *tree,
 592                                gpointer          origin_tag)
 593 {
 594   return G_SETTINGS_BACKEND_GET_CLASS (backend)
 595     ->write_keys (backend, tree, origin_tag);
 596 }
 597
 598 /*< private >
 599  * g_settings_backend_reset:
 600  * @backend: a #GSettingsBackend implementation
 601  * @key: the name of a key
 602  * @origin_tag: the origin tag
 603  *
 604  * "Resets" the named key to its "default" value (ie: after system-wide
 605  * defaults, mandatory keys, etc. have been taken into account) or possibly
 606  * unsets it.
 607  */
 608 void
 609 g_settings_backend_reset (GSettingsBackend *backend,
 610                           const gchar      *key,
 611                           gpointer          origin_tag)
 612 {
 613   G_SETTINGS_BACKEND_GET_CLASS (backend)
 614     ->reset (backend, key, origin_tag);
 615 }
 616
 617 /*< private >
 618  * g_settings_backend_reset_path:
 619  * @backend: a #GSettingsBackend implementation
 620  * @name: the name of a key or path
 621  * @origin_tag: the origin tag
 622  *
 623  * "Resets" the named path.  This means that every key under the path is
 624  * reset.
 625  */
 626 void
 627 g_settings_backend_reset_path (GSettingsBackend *backend,
 628                                const gchar      *path,
 629                                gpointer          origin_tag)
 630 {
 631   G_SETTINGS_BACKEND_GET_CLASS (backend)
 632     ->reset_path (backend, path, origin_tag);
 633 }
 634
 635 /*< private >
 636  * g_settings_backend_get_writable:
 637  * @backend: a #GSettingsBackend implementation
 638  * @key: the name of a key
 639  * @returns: %TRUE if the key is writable
 640  *
 641  * Finds out if a key is available for writing to.  This is the
 642  * interface through which 'lockdown' is implemented.  Locked down
 643  * keys will have %FALSE returned by this call.
 644  *
 645  * You should not write to locked-down keys, but if you do, the
 646  * implementation will deal with it.
 647  */
 648 gboolean
 649 g_settings_backend_get_writable (GSettingsBackend *backend,
 650                                  const gchar      *key)
 651 {
 652   return G_SETTINGS_BACKEND_GET_CLASS (backend)
 653     ->get_writable (backend, key);
 654 }
 655
 656 /*< private >
 657  * g_settings_backend_unsubscribe:
 658  * @backend: a #GSettingsBackend
 659  * @name: a key or path to subscribe to
 660  *
 661  * Reverses the effect of a previous call to
 662  * g_settings_backend_subscribe().
 663  */
 664 void
 665 g_settings_backend_unsubscribe (GSettingsBackend *backend,
 666                                 const char       *name)
 667 {
 668   G_SETTINGS_BACKEND_GET_CLASS (backend)
 669     ->unsubscribe (backend, name);
 670 }
 671
 672 /*< private >
 673  * g_settings_backend_subscribe:
 674  * @backend: a #GSettingsBackend
 675  * @name: a key or path to subscribe to
 676  *
 677  * Requests that change signals be emitted for events on @name.
 678  */
 679 void
 680 g_settings_backend_subscribe (GSettingsBackend *backend,
 681                               const gchar      *name)
 682 {
 683   G_SETTINGS_BACKEND_GET_CLASS (backend)
 684     ->subscribe (backend, name);
 685 }
 686
 687 static void
 688 g_settings_backend_set_property (GObject         *object,
 689                                  guint            prop_id,
 690                                  const GValue    *value,
 691                                  GParamSpec      *pspec)
 692 {
 693   GSettingsBackend *backend = G_SETTINGS_BACKEND (object);
 694
 695   switch (prop_id)
 696     {
 697     case PROP_CONTEXT:
 698       backend->priv->context = g_value_dup_string (value);
 699       break;
 700
 701     default:
 702       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 703       break;
 704     }
 705 }
 706
 707 static void
 708 g_settings_backend_get_property (GObject    *object,
 709                                  guint       prop_id,
 710                                  GValue     *value,
 711                                  GParamSpec *pspec)
 712 {
 713   GSettingsBackend *backend = G_SETTINGS_BACKEND (object);
 714
 715   switch (prop_id)
 716     {
 717     case PROP_CONTEXT:
 718       g_value_set_string (value, backend->priv->context);
 719       break;
 720
 721     default:
 722       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 723       break;
 724     }
 725 }
 726
 727 static void
 728 g_settings_backend_finalize (GObject *object)
 729 {
 730   GSettingsBackend *backend = G_SETTINGS_BACKEND (object);
 731
 732   g_free (backend->priv->context);
 733
 734   G_OBJECT_CLASS (g_settings_backend_parent_class)->finalize (object);
 735 }
 736
 737 static void
 738 ignore_subscription (GSettingsBackend *backend,
 739                      const gchar      *key)
 740 {
 741 }
 742
 743 static void
 744 g_settings_backend_init (GSettingsBackend *backend)
 745 {
 746   backend->priv = G_TYPE_INSTANCE_GET_PRIVATE (backend,
 747                                                G_TYPE_SETTINGS_BACKEND,
 748                                                GSettingsBackendPrivate);
 749 }
 750
 751 static void
 752 g_settings_backend_class_init (GSettingsBackendClass *class)
 753 {
 754   GObjectClass *gobject_class = G_OBJECT_CLASS (class);
 755
 756   class->subscribe = ignore_subscription;
 757   class->unsubscribe = ignore_subscription;
 758
 759   gobject_class->get_property = g_settings_backend_get_property;
 760   gobject_class->set_property = g_settings_backend_set_property;
 761   gobject_class->finalize = g_settings_backend_finalize;
 762
 763   g_type_class_add_private (class, sizeof (GSettingsBackendPrivate));
 764
 765   /**
 766    * GSettingsBackend:context:
 767    *
 768    * The "context" property gives a hint to the backend as to
 769    * what storage to use. It is up to the implementation to make
 770    * use of this information.
 771    *
 772    * E.g. DConf supports "user", "system", "defaults" and "login"
 773    * contexts.
 774    *
 775    * If your backend supports different contexts, you should also
 776    * provide an implementation of the supports_context() class
 777    * function in #GSettingsBackendClass.
 778    */
 779   g_object_class_install_property (gobject_class, PROP_CONTEXT,
 780     g_param_spec_string ("context", P_("Context"),
 781                          P_("An identifier to decide which storage to use"),
 782                          "", G_PARAM_READWRITE |
 783                          G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
 784
 785 }
 786
 787 /*< private >
 788  * g_settings_backend_create_tree:
 789  * @returns: a new #GTree
 790  *
 791  * This is a convenience function for creating a tree that is compatible
 792  * with g_settings_backend_write().  It merely calls g_tree_new_full()
 793  * with strcmp(), g_free() and g_variant_unref().
 794  */
 795 GTree *
 796 g_settings_backend_create_tree (void)
 797 {
 798   return g_tree_new_full ((GCompareDataFunc) strcmp, NULL,
 799                           g_free, (GDestroyNotify) g_variant_unref);
 800 }
 801
 802
 803 static gpointer
 804 get_default_backend (const gchar *context)
 805 {
 806   GIOExtension *extension = NULL;
 807   GIOExtensionPoint *point;
 808   GList *extensions;
 809   const gchar *env;
 810   GType type;
 811
 812   _g_io_modules_ensure_loaded ();
 813
 814   point = g_io_extension_point_lookup (G_SETTINGS_BACKEND_EXTENSION_POINT_NAME);
 815
 816   if ((env = getenv ("GSETTINGS_BACKEND")))
 817     {
 818       extension = g_io_extension_point_get_extension_by_name (point, env);
 819
 820       if (extension == NULL)
 821         g_warning ("Can't find GSettings backend '%s' given in "
 822                    "GSETTINGS_BACKEND environment variable", env);
 823     }
 824
 825   if (extension == NULL)
 826     {
 827       extensions = g_io_extension_point_get_extensions (point);
 828
 829       if (extensions == NULL)
 830         g_error ("No GSettingsBackend implementations exist.");
 831
 832       extension = extensions->data;
 833     }
 834
 835   if (context[0] != '\0') /* (context != "") */
 836     {
 837       GSettingsBackendClass *backend_class;
 838       GTypeClass *class;
 839
 840       class = g_io_extension_ref_class (extension);
 841       backend_class = G_SETTINGS_BACKEND_CLASS (class);
 842
 843       if (backend_class->supports_context == NULL ||
 844           !backend_class->supports_context (context))
 845         {
 846           g_type_class_unref (class);
 847           return NULL;
 848         }
 849
 850       g_type_class_unref (class);
 851     }
 852
 853   type = g_io_extension_get_type (extension);
 854
 855   return g_object_new (type, "context", context, NULL);
 856 }
 857
 858 static GHashTable *g_settings_backends;
 859
 860 /*< private >
 861  * g_settings_backend_get_with_context:
 862  * @context: a context that might be used by the backend to determine
 863  *     which storage to use, or %NULL to use the default storage
 864  * @returns: the default #GSettingsBackend
 865  *
 866  * Returns the default #GSettingsBackend. It is possible to override
 867  * the default by setting the <envar>GSETTINGS_BACKEND</envar>
 868  * environment variable to the name of a settings backend.
 869  *
 870  * The @context parameter can be used to indicate that a different
 871  * than the default storage is desired. E.g. the DConf backend lets
 872  * you use "user", "system", "defaults" and "login" as contexts.
 873  *
 874  * If @context is not supported by the implementation, this function
 875  * returns an instance of the #GSettingsMemoryBackend.
 876  * See g_settings_backend_supports_context(),
 877  *
 878  * The user does not own the return value and it must not be freed.
 879  */
 880 GSettingsBackend *
 881 g_settings_backend_get_with_context (const gchar *context)
 882 {
 883   GSettingsBackend *backend;
 884
 885   g_return_val_if_fail (context != NULL, NULL);
 886
 887   _g_io_modules_ensure_extension_points_registered ();
 888
 889   if (g_settings_backends == NULL)
 890     g_settings_backends = g_hash_table_new (g_str_hash, g_str_equal);
 891
 892   backend = g_hash_table_lookup (g_settings_backends, context);
 893
 894   if (!backend)
 895     {
 896       backend = get_default_backend (context);
 897
 898       if (!backend)
 899         backend = g_null_settings_backend_new ();
 900
 901       g_hash_table_insert (g_settings_backends, g_strdup (context), backend);
 902     }
 903
 904   return g_object_ref (backend);
 905 }
 906
 907 /*< private >
 908  * g_settings_backend_supports_context:
 909  * @context: a context string that might be passed to
 910  *     g_settings_backend_new_with_context()
 911  * @returns: #TRUE if @context is supported
 912  *
 913  * Determines if the given context is supported by the default
 914  * GSettingsBackend implementation.
 915  */
 916 gboolean
 917 g_settings_backend_supports_context (const gchar *context)
 918 {
 919   GSettingsBackend *backend;
 920
 921   g_return_val_if_fail (context != NULL, FALSE);
 922
 923   backend = get_default_backend (context);
 924
 925   if (backend)
 926     {
 927       g_object_unref (backend);
 928       return TRUE;
 929     }
 930
 931   return FALSE;
 932 }
 933
 934 /**
 935  * g_settings_backend_setup:
 936  * @context: a context string (not %NULL or "")
 937  * @backend: a #GSettingsBackend
 938  *
 939  * Sets up @backend for use with #GSettings.
 940  *
 941  * If you create a #GSettings with its context property set to @context
 942  * then it will use the backend given to this function.  See
 943  * g_settings_new_with_context().
 944  *
 945  * The backend must be set up before any settings objects are created
 946  * for the named context.
 947  *
 948  * It is not possible to specify a backend for the default context.
 949  *
 950  * This function takes a reference on @backend and never releases it.
 951  *
 952  * Since: 2.26
 953  **/
 954 void
 955 g_settings_backend_setup (const gchar      *context,
 956                           GSettingsBackend *backend)
 957 {
 958   g_return_if_fail (context[0] != '\0');
 959   g_return_if_fail (G_IS_SETTINGS_BACKEND (backend));
 960
 961   if (g_settings_backends == NULL)
 962     g_settings_backends = g_hash_table_new (g_str_hash, g_str_equal);
 963
 964   if (g_hash_table_lookup (g_settings_backends, context))
 965     g_error ("A GSettingsBackend already exists for context '%s'", context);
 966
 967   g_hash_table_insert (g_settings_backends,
 968                        g_strdup (context),
 969                        g_object_ref (backend));
 970 }
 971
 972 #define __G_SETTINGS_BACKEND_C__
 973 #include "gioaliasdef.c"