gio/gkeyfilesettingsbackend.c

   1 /*
   2  * Copyright © 2010 Codethink Limited
   3  * Copyright © 2010 Novell, 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.1 of the License, 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, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Authors: Vincent Untz <vuntz@gnome.org>
  19  *          Ryan Lortie <desrt@desrt.ca>
  20  */
  21
  22 #include "config.h"
  23
  24 #include <glib.h>
  25 #include <glibintl.h>
  26
  27 #include <stdio.h>
  28 #include <string.h>
  29
  30 #include "gfile.h"
  31 #include "gfileinfo.h"
  32 #include "gfileenumerator.h"
  33 #include "gfilemonitor.h"
  34 #include "gsimplepermission.h"
  35 #include "gsettingsbackendinternal.h"
  36 #include "giomodule-priv.h"
  37 #include "gportalsupport.h"
  38
  39
  40 #define G_TYPE_KEYFILE_SETTINGS_BACKEND      (g_keyfile_settings_backend_get_type ())
  41 #define G_KEYFILE_SETTINGS_BACKEND(inst)     (G_TYPE_CHECK_INSTANCE_CAST ((inst),      \
  42                                               G_TYPE_KEYFILE_SETTINGS_BACKEND,         \
  43                                               GKeyfileSettingsBackend))
  44 #define G_IS_KEYFILE_SETTINGS_BACKEND(inst)  (G_TYPE_CHECK_INSTANCE_TYPE ((inst),      \
  45                                               G_TYPE_KEYFILE_SETTINGS_BACKEND))
  46
  47
  48 typedef GSettingsBackendClass GKeyfileSettingsBackendClass;
  49
  50 typedef enum {
  51   PROP_FILENAME = 1,
  52   PROP_ROOT_PATH,
  53   PROP_ROOT_GROUP,
  54   PROP_DEFAULTS_DIR
  55 } GKeyfileSettingsBackendProperty;
  56
  57 typedef struct
  58 {
  59   GSettingsBackend   parent_instance;
  60
  61   GKeyFile          *keyfile;
  62   GPermission       *permission;
  63   gboolean           writable;
  64   char              *defaults_dir;
  65   GKeyFile          *system_keyfile;
  66   GHashTable        *system_locks; /* Used as a set, owning the strings it contains */
  67
  68   gchar             *prefix;
  69   gint               prefix_len;
  70   gchar             *root_group;
  71   gint               root_group_len;
  72
  73   GFile             *file;
  74   GFileMonitor      *file_monitor;
  75   guint8             digest[32];
  76   GFile             *dir;
  77   GFileMonitor      *dir_monitor;
  78 } GKeyfileSettingsBackend;
  79
  80 #ifdef G_OS_WIN32
  81 #define EXTENSION_PRIORITY 10
  82 #else
  83 #define EXTENSION_PRIORITY (glib_should_use_portal () ? 110 : 10)
  84 #endif
  85
  86 G_DEFINE_TYPE_WITH_CODE (GKeyfileSettingsBackend,
  87                          g_keyfile_settings_backend,
  88                          G_TYPE_SETTINGS_BACKEND,
  89                          _g_io_modules_ensure_extension_points_registered ();
  90                          g_io_extension_point_implement (G_SETTINGS_BACKEND_EXTENSION_POINT_NAME,
  91                                                          g_define_type_id, "keyfile", EXTENSION_PRIORITY))
  92
  93 static void
  94 compute_checksum (guint8        *digest,
  95                   gconstpointer  contents,
  96                   gsize          length)
  97 {
  98   GChecksum *checksum;
  99   gsize len = 32;
 100
 101   checksum = g_checksum_new (G_CHECKSUM_SHA256);
 102   g_checksum_update (checksum, contents, length);
 103   g_checksum_get_digest (checksum, digest, &len);
 104   g_checksum_free (checksum);
 105   g_assert (len == 32);
 106 }
 107
 108 static void
 109 g_keyfile_settings_backend_keyfile_write (GKeyfileSettingsBackend *kfsb)
 110 {
 111   gchar *contents;
 112   gsize length;
 113
 114   contents = g_key_file_to_data (kfsb->keyfile, &length, NULL);
 115   g_file_replace_contents (kfsb->file, contents, length, NULL, FALSE,
 116                            G_FILE_CREATE_REPLACE_DESTINATION,
 117                            NULL, NULL, NULL);
 118
 119   compute_checksum (kfsb->digest, contents, length);
 120   g_free (contents);
 121 }
 122
 123 static gboolean
 124 group_name_matches (const gchar *group_name,
 125                     const gchar *prefix)
 126 {
 127   /* sort of like g_str_has_prefix() except that it must be an exact
 128    * match or the prefix followed by '/'.
 129    *
 130    * for example 'a' is a prefix of 'a' and 'a/b' but not 'ab'.
 131    */
 132   gint i;
 133
 134   for (i = 0; prefix[i]; i++)
 135     if (prefix[i] != group_name[i])
 136       return FALSE;
 137
 138   return group_name[i] == '\0' || group_name[i] == '/';
 139 }
 140
 141 static gboolean
 142 convert_path (GKeyfileSettingsBackend  *kfsb,
 143               const gchar              *key,
 144               gchar                   **group,
 145               gchar                   **basename)
 146 {
 147   gint key_len = strlen (key);
 148   gint i;
 149
 150   if (key_len < kfsb->prefix_len ||
 151       memcmp (key, kfsb->prefix, kfsb->prefix_len) != 0)
 152     return FALSE;
 153
 154   key_len -= kfsb->prefix_len;
 155   key += kfsb->prefix_len;
 156
 157   for (i = key_len; i >= 0; i--)
 158     if (key[i] == '/')
 159       break;
 160
 161   if (kfsb->root_group)
 162     {
 163       /* if a root_group was specified, make sure the user hasn't given
 164        * a path that ghosts that group name
 165        */
 166       if (i == kfsb->root_group_len && memcmp (key, kfsb->root_group, i) == 0)
 167         return FALSE;
 168     }
 169   else
 170     {
 171       /* if no root_group was given, ensure that the user gave a path */
 172       if (i == -1)
 173         return FALSE;
 174     }
 175
 176   if (group)
 177     {
 178       if (i >= 0)
 179         {
 180           *group = g_memdup (key, i + 1);
 181           (*group)[i] = '\0';
 182         }
 183       else
 184         *group = g_strdup (kfsb->root_group);
 185     }
 186
 187   if (basename)
 188     *basename = g_memdup (key + i + 1, key_len - i);
 189
 190   return TRUE;
 191 }
 192
 193 static gboolean
 194 path_is_valid (GKeyfileSettingsBackend *kfsb,
 195                const gchar             *path)
 196 {
 197   return convert_path (kfsb, path, NULL, NULL);
 198 }
 199
 200 static GVariant *
 201 get_from_keyfile (GKeyfileSettingsBackend *kfsb,
 202                   const GVariantType      *type,
 203                   const gchar             *key)
 204 {
 205   GVariant *return_value = NULL;
 206   gchar *group, *name;
 207
 208   if (convert_path (kfsb, key, &group, &name))
 209     {
 210       gchar *str;
 211       gchar *sysstr;
 212
 213       g_assert (*name);
 214
 215       sysstr = g_key_file_get_value (kfsb->system_keyfile, group, name, NULL);
 216       str = g_key_file_get_value (kfsb->keyfile, group, name, NULL);
 217       if (sysstr &&
 218           (g_hash_table_contains (kfsb->system_locks, key) ||
 219            str == NULL))
 220         {
 221           g_free (str);
 222           str = g_steal_pointer (&sysstr);
 223         }
 224
 225       if (str)
 226         {
 227           return_value = g_variant_parse (type, str, NULL, NULL, NULL);
 228           if (return_value == NULL &&
 229               g_variant_type_equal (type, G_VARIANT_TYPE_STRING) &&
 230               str[0] != '\"')
 231             {
 232               GString *s = g_string_sized_new (strlen (str) + 2);
 233               char *p = str;
 234
 235               g_string_append_c (s, '\"');
 236               while (*p)
 237                 {
 238                   if (*p == '\"')
 239                     g_string_append_c (s, '\\');
 240                   g_string_append_c (s, *p);
 241                   p++;
 242                 }
 243               g_string_append_c (s, '\"');
 244               return_value = g_variant_parse (type, s->str, NULL, NULL, NULL);
 245               g_string_free (s, TRUE);
 246             }
 247           g_free (str);
 248         }
 249
 250       g_free (sysstr);
 251
 252       g_free (group);
 253       g_free (name);
 254     }
 255
 256   return return_value;
 257 }
 258
 259 static gboolean
 260 set_to_keyfile (GKeyfileSettingsBackend *kfsb,
 261                 const gchar             *key,
 262                 GVariant                *value)
 263 {
 264   gchar *group, *name;
 265
 266   if (g_hash_table_contains (kfsb->system_locks, key))
 267     return FALSE;
 268
 269   if (convert_path (kfsb, key, &group, &name))
 270     {
 271       if (value)
 272         {
 273           gchar *str = g_variant_print (value, FALSE);
 274           g_key_file_set_value (kfsb->keyfile, group, name, str);
 275           g_variant_unref (g_variant_ref_sink (value));
 276           g_free (str);
 277         }
 278       else
 279         {
 280           if (*name == '\0')
 281             {
 282               gchar **groups;
 283               gint i;
 284
 285               groups = g_key_file_get_groups (kfsb->keyfile, NULL);
 286
 287               for (i = 0; groups[i]; i++)
 288                 if (group_name_matches (groups[i], group))
 289                   g_key_file_remove_group (kfsb->keyfile, groups[i], NULL);
 290
 291               g_strfreev (groups);
 292             }
 293           else
 294             g_key_file_remove_key (kfsb->keyfile, group, name, NULL);
 295         }
 296
 297       g_free (group);
 298       g_free (name);
 299
 300       return TRUE;
 301     }
 302
 303   return FALSE;
 304 }
 305
 306 static GVariant *
 307 g_keyfile_settings_backend_read (GSettingsBackend   *backend,
 308                                  const gchar        *key,
 309                                  const GVariantType *expected_type,
 310                                  gboolean            default_value)
 311 {
 312   GKeyfileSettingsBackend *kfsb = G_KEYFILE_SETTINGS_BACKEND (backend);
 313
 314   if (default_value)
 315     return NULL;
 316
 317   return get_from_keyfile (kfsb, expected_type, key);
 318 }
 319
 320 typedef struct
 321 {
 322   GKeyfileSettingsBackend *kfsb;
 323   gboolean failed;
 324 } WriteManyData;
 325
 326 static gboolean
 327 g_keyfile_settings_backend_write_one (gpointer key,
 328                                       gpointer value,
 329                                       gpointer user_data)
 330 {
 331   WriteManyData *data = user_data;
 332   gboolean success;
 333
 334   success = set_to_keyfile (data->kfsb, key, value);
 335   g_assert (success);
 336
 337   return FALSE;
 338 }
 339
 340 static gboolean
 341 g_keyfile_settings_backend_check_one (gpointer key,
 342                                       gpointer value,
 343                                       gpointer user_data)
 344 {
 345   WriteManyData *data = user_data;
 346
 347   return data->failed = g_hash_table_contains (data->kfsb->system_locks, key) ||
 348                         !path_is_valid (data->kfsb, key);
 349 }
 350
 351 static gboolean
 352 g_keyfile_settings_backend_write_tree (GSettingsBackend *backend,
 353                                        GTree            *tree,
 354                                        gpointer          origin_tag)
 355 {
 356   WriteManyData data = { G_KEYFILE_SETTINGS_BACKEND (backend) };
 357
 358   if (!data.kfsb->writable)
 359     return FALSE;
 360
 361   g_tree_foreach (tree, g_keyfile_settings_backend_check_one, &data);
 362
 363   if (data.failed)
 364     return FALSE;
 365
 366   g_tree_foreach (tree, g_keyfile_settings_backend_write_one, &data);
 367   g_keyfile_settings_backend_keyfile_write (data.kfsb);
 368
 369   g_settings_backend_changed_tree (backend, tree, origin_tag);
 370
 371   return TRUE;
 372 }
 373
 374 static gboolean
 375 g_keyfile_settings_backend_write (GSettingsBackend *backend,
 376                                   const gchar      *key,
 377                                   GVariant         *value,
 378                                   gpointer          origin_tag)
 379 {
 380   GKeyfileSettingsBackend *kfsb = G_KEYFILE_SETTINGS_BACKEND (backend);
 381   gboolean success;
 382
 383   if (!kfsb->writable)
 384     return FALSE;
 385
 386   success = set_to_keyfile (kfsb, key, value);
 387
 388   if (success)
 389     {
 390       g_settings_backend_changed (backend, key, origin_tag);
 391       g_keyfile_settings_backend_keyfile_write (kfsb);
 392     }
 393
 394   return success;
 395 }
 396
 397 static void
 398 g_keyfile_settings_backend_reset (GSettingsBackend *backend,
 399                                   const gchar      *key,
 400                                   gpointer          origin_tag)
 401 {
 402   GKeyfileSettingsBackend *kfsb = G_KEYFILE_SETTINGS_BACKEND (backend);
 403
 404   if (set_to_keyfile (kfsb, key, NULL))
 405     g_keyfile_settings_backend_keyfile_write (kfsb);
 406
 407   g_settings_backend_changed (backend, key, origin_tag);
 408 }
 409
 410 static gboolean
 411 g_keyfile_settings_backend_get_writable (GSettingsBackend *backend,
 412                                          const gchar      *name)
 413 {
 414   GKeyfileSettingsBackend *kfsb = G_KEYFILE_SETTINGS_BACKEND (backend);
 415
 416   return kfsb->writable &&
 417          !g_hash_table_contains (kfsb->system_locks, name) &&
 418          path_is_valid (kfsb, name);
 419 }
 420
 421 static GPermission *
 422 g_keyfile_settings_backend_get_permission (GSettingsBackend *backend,
 423                                            const gchar      *path)
 424 {
 425   GKeyfileSettingsBackend *kfsb = G_KEYFILE_SETTINGS_BACKEND (backend);
 426
 427   return g_object_ref (kfsb->permission);
 428 }
 429
 430 static void
 431 keyfile_to_tree (GKeyfileSettingsBackend *kfsb,
 432                  GTree                   *tree,
 433                  GKeyFile                *keyfile,
 434                  gboolean                 dup_check)
 435 {
 436   gchar **groups;
 437   gint i;
 438
 439   groups = g_key_file_get_groups (keyfile, NULL);
 440   for (i = 0; groups[i]; i++)
 441     {
 442       gboolean is_root_group;
 443       gchar **keys;
 444       gint j;
 445
 446       is_root_group = g_strcmp0 (kfsb->root_group, groups[i]) == 0;
 447
 448       /* reject group names that will form invalid key names */
 449       if (!is_root_group &&
 450           (g_str_has_prefix (groups[i], "/") ||
 451            g_str_has_suffix (groups[i], "/") || strstr (groups[i], "//")))
 452         continue;
 453
 454       keys = g_key_file_get_keys (keyfile, groups[i], NULL, NULL);
 455       g_assert (keys != NULL);
 456
 457       for (j = 0; keys[j]; j++)
 458         {
 459           gchar *path, *value;
 460
 461           /* reject key names with slashes in them */
 462           if (strchr (keys[j], '/'))
 463             continue;
 464
 465           if (is_root_group)
 466             path = g_strdup_printf ("%s%s", kfsb->prefix, keys[j]);
 467           else
 468             path = g_strdup_printf ("%s%s/%s", kfsb->prefix, groups[i], keys[j]);
 469
 470           value = g_key_file_get_value (keyfile, groups[i], keys[j], NULL);
 471
 472           if (dup_check && g_strcmp0 (g_tree_lookup (tree, path), value) == 0)
 473             {
 474               g_tree_remove (tree, path);
 475               g_free (value);
 476               g_free (path);
 477             }
 478           else
 479             g_tree_insert (tree, path, value);
 480         }
 481
 482       g_strfreev (keys);
 483     }
 484   g_strfreev (groups);
 485 }
 486
 487 static void
 488 g_keyfile_settings_backend_keyfile_reload (GKeyfileSettingsBackend *kfsb)
 489 {
 490   guint8 digest[32];
 491   gchar *contents;
 492   gsize length;
 493
 494   contents = NULL;
 495   length = 0;
 496
 497   g_file_load_contents (kfsb->file, NULL, &contents, &length, NULL, NULL);
 498   compute_checksum (digest, contents, length);
 499
 500   if (memcmp (kfsb->digest, digest, sizeof digest) != 0)
 501     {
 502       GKeyFile *keyfiles[2];
 503       GTree *tree;
 504
 505       tree = g_tree_new_full ((GCompareDataFunc) strcmp, NULL,
 506                               g_free, g_free);
 507
 508       keyfiles[0] = kfsb->keyfile;
 509       keyfiles[1] = g_key_file_new ();
 510
 511       if (length > 0)
 512         g_key_file_load_from_data (keyfiles[1], contents, length,
 513                                    G_KEY_FILE_KEEP_COMMENTS |
 514                                    G_KEY_FILE_KEEP_TRANSLATIONS, NULL);
 515
 516       keyfile_to_tree (kfsb, tree, keyfiles[0], FALSE);
 517       keyfile_to_tree (kfsb, tree, keyfiles[1], TRUE);
 518       g_key_file_free (keyfiles[0]);
 519       kfsb->keyfile = keyfiles[1];
 520
 521       if (g_tree_nnodes (tree) > 0)
 522         g_settings_backend_changed_tree (&kfsb->parent_instance, tree, NULL);
 523
 524       g_tree_unref (tree);
 525
 526       memcpy (kfsb->digest, digest, sizeof digest);
 527     }
 528
 529   g_free (contents);
 530 }
 531
 532 static void
 533 g_keyfile_settings_backend_keyfile_writable (GKeyfileSettingsBackend *kfsb)
 534 {
 535   GFileInfo *fileinfo;
 536   gboolean writable;
 537
 538   fileinfo = g_file_query_info (kfsb->dir, "access::*", 0, NULL, NULL);
 539
 540   if (fileinfo)
 541     {
 542       writable =
 543         g_file_info_get_attribute_boolean (fileinfo, G_FILE_ATTRIBUTE_ACCESS_CAN_WRITE) &&
 544         g_file_info_get_attribute_boolean (fileinfo, G_FILE_ATTRIBUTE_ACCESS_CAN_EXECUTE);
 545       g_object_unref (fileinfo);
 546     }
 547   else
 548     writable = FALSE;
 549
 550   if (writable != kfsb->writable)
 551     {
 552       kfsb->writable = writable;
 553       g_settings_backend_path_writable_changed (&kfsb->parent_instance, "/");
 554     }
 555 }
 556
 557 static void
 558 g_keyfile_settings_backend_finalize (GObject *object)
 559 {
 560   GKeyfileSettingsBackend *kfsb = G_KEYFILE_SETTINGS_BACKEND (object);
 561
 562   g_key_file_free (kfsb->keyfile);
 563   g_object_unref (kfsb->permission);
 564   g_key_file_unref (kfsb->system_keyfile);
 565   g_hash_table_unref (kfsb->system_locks);
 566   g_free (kfsb->defaults_dir);
 567
 568   g_file_monitor_cancel (kfsb->file_monitor);
 569   g_object_unref (kfsb->file_monitor);
 570   g_object_unref (kfsb->file);
 571
 572   g_file_monitor_cancel (kfsb->dir_monitor);
 573   g_object_unref (kfsb->dir_monitor);
 574   g_object_unref (kfsb->dir);
 575
 576   g_free (kfsb->root_group);
 577   g_free (kfsb->prefix);
 578
 579   G_OBJECT_CLASS (g_keyfile_settings_backend_parent_class)
 580     ->finalize (object);
 581 }
 582
 583 static void
 584 g_keyfile_settings_backend_init (GKeyfileSettingsBackend *kfsb)
 585 {
 586 }
 587
 588 static void
 589 file_changed (GFileMonitor      *monitor,
 590               GFile             *file,
 591               GFile             *other_file,
 592               GFileMonitorEvent  event_type,
 593               gpointer           user_data)
 594 {
 595   GKeyfileSettingsBackend *kfsb = user_data;
 596
 597   /* Ignore file deletions, let the GKeyFile content remain in tact. */
 598   if (event_type != G_FILE_MONITOR_EVENT_DELETED)
 599     g_keyfile_settings_backend_keyfile_reload (kfsb);
 600 }
 601
 602 static void
 603 dir_changed (GFileMonitor       *monitor,
 604               GFile             *file,
 605               GFile             *other_file,
 606               GFileMonitorEvent  event_type,
 607               gpointer           user_data)
 608 {
 609   GKeyfileSettingsBackend *kfsb = user_data;
 610
 611   g_keyfile_settings_backend_keyfile_writable (kfsb);
 612 }
 613
 614 static void
 615 load_system_settings (GKeyfileSettingsBackend *kfsb)
 616 {
 617   GError *error = NULL;
 618   const char *dir = "/etc/glib-2.0/settings";
 619   char *path;
 620   char *contents;
 621
 622   kfsb->system_keyfile = g_key_file_new ();
 623   kfsb->system_locks = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, NULL);
 624
 625   if (kfsb->defaults_dir)
 626     dir = kfsb->defaults_dir;
 627
 628   path = g_build_filename (dir, "defaults", NULL);
 629
 630   /* The defaults are in the same keyfile format that we use for the settings.
 631    * It can be produced from a dconf database using: dconf dump
 632    */
 633   if (!g_key_file_load_from_file (kfsb->system_keyfile, path, G_KEY_FILE_NONE, &error))
 634     {
 635       if (!g_error_matches (error, G_FILE_ERROR, G_FILE_ERROR_NOENT))
 636         g_warning ("Failed to read %s: %s", path, error->message);
 637       g_clear_error (&error);
 638     }
 639   else
 640     g_debug ("Loading default settings from %s", path);
 641
 642   g_free (path);
 643
 644   path = g_build_filename (dir, "locks", NULL);
 645
 646   /* The locks file is a text file containing a list paths to lock, one per line.
 647    * It can be produced from a dconf database using: dconf list-locks
 648    */
 649   if (!g_file_get_contents (path, &contents, NULL, &error))
 650     {
 651       if (!g_error_matches (error, G_FILE_ERROR, G_FILE_ERROR_NOENT))
 652         g_warning ("Failed to read %s: %s", path, error->message);
 653       g_clear_error (&error);
 654     }
 655   else
 656     {
 657       char **lines;
 658       gsize i;
 659
 660       g_debug ("Loading locks from %s", path);
 661
 662       lines = g_strsplit (contents, "\n", 0);
 663       for (i = 0; lines[i]; i++)
 664         {
 665           char *line = lines[i];
 666           if (line[0] == '#' || line[0] == '\0')
 667             {
 668               g_free (line);
 669               continue;
 670             }
 671
 672           g_debug ("Locking key %s", line);
 673           g_hash_table_add (kfsb->system_locks, g_steal_pointer (&line));
 674         }
 675
 676       g_free (lines);
 677     }
 678   g_free (contents);
 679
 680   g_free (path);
 681 }
 682
 683 static void
 684 g_keyfile_settings_backend_constructed (GObject *object)
 685 {
 686   GKeyfileSettingsBackend *kfsb = G_KEYFILE_SETTINGS_BACKEND (object);
 687
 688   if (kfsb->file == NULL)
 689     {
 690       char *filename = g_build_filename (g_get_user_config_dir (),
 691                                          "glib-2.0", "settings", "keyfile",
 692                                          NULL);
 693       kfsb->file = g_file_new_for_path (filename);
 694       g_free (filename);
 695     }
 696
 697   if (kfsb->prefix == NULL)
 698     {
 699       kfsb->prefix = g_strdup ("/");
 700       kfsb->prefix_len = 1;
 701     }
 702
 703   kfsb->keyfile = g_key_file_new ();
 704   kfsb->permission = g_simple_permission_new (TRUE);
 705
 706   kfsb->dir = g_file_get_parent (kfsb->file);
 707   g_file_make_directory_with_parents (kfsb->dir, NULL, NULL);
 708
 709   kfsb->file_monitor = g_file_monitor (kfsb->file, G_FILE_MONITOR_NONE, NULL, NULL);
 710   kfsb->dir_monitor = g_file_monitor (kfsb->dir, G_FILE_MONITOR_NONE, NULL, NULL);
 711
 712   compute_checksum (kfsb->digest, NULL, 0);
 713
 714   g_signal_connect (kfsb->file_monitor, "changed",
 715                     G_CALLBACK (file_changed), kfsb);
 716   g_signal_connect (kfsb->dir_monitor, "changed",
 717                     G_CALLBACK (dir_changed), kfsb);
 718
 719   g_keyfile_settings_backend_keyfile_writable (kfsb);
 720   g_keyfile_settings_backend_keyfile_reload (kfsb);
 721
 722   load_system_settings (kfsb);
 723 }
 724
 725 static void
 726 g_keyfile_settings_backend_set_property (GObject      *object,
 727                                          guint         prop_id,
 728                                          const GValue *value,
 729                                          GParamSpec   *pspec)
 730 {
 731   GKeyfileSettingsBackend *kfsb = G_KEYFILE_SETTINGS_BACKEND (object);
 732
 733   switch ((GKeyfileSettingsBackendProperty)prop_id)
 734     {
 735     case PROP_FILENAME:
 736       /* Construct only. */
 737       g_assert (kfsb->file == NULL);
 738       kfsb->file = g_file_new_for_path (g_value_get_string (value));
 739       break;
 740
 741     case PROP_ROOT_PATH:
 742       /* Construct only. */
 743       g_assert (kfsb->prefix == NULL);
 744       kfsb->prefix = g_value_dup_string (value);
 745       if (kfsb->prefix)
 746         kfsb->prefix_len = strlen (kfsb->prefix);
 747       break;
 748
 749     case PROP_ROOT_GROUP:
 750       /* Construct only. */
 751       g_assert (kfsb->root_group == NULL);
 752       kfsb->root_group = g_value_dup_string (value);
 753       if (kfsb->root_group)
 754         kfsb->root_group_len = strlen (kfsb->root_group);
 755       break;
 756
 757     case PROP_DEFAULTS_DIR:
 758       /* Construct only. */
 759       g_assert (kfsb->defaults_dir == NULL);
 760       kfsb->defaults_dir = g_value_dup_string (value);
 761       break;
 762
 763     default:
 764       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 765       break;
 766     }
 767 }
 768
 769 static void
 770 g_keyfile_settings_backend_get_property (GObject    *object,
 771                                          guint       prop_id,
 772                                          GValue     *value,
 773                                          GParamSpec *pspec)
 774 {
 775   GKeyfileSettingsBackend *kfsb = G_KEYFILE_SETTINGS_BACKEND (object);
 776
 777   switch ((GKeyfileSettingsBackendProperty)prop_id)
 778     {
 779     case PROP_FILENAME:
 780       g_value_set_string (value, g_file_peek_path (kfsb->file));
 781       break;
 782
 783     case PROP_ROOT_PATH:
 784       g_value_set_string (value, kfsb->prefix);
 785       break;
 786
 787     case PROP_ROOT_GROUP:
 788       g_value_set_string (value, kfsb->root_group);
 789       break;
 790
 791     case PROP_DEFAULTS_DIR:
 792       g_value_set_string (value, kfsb->defaults_dir);
 793       break;
 794
 795     default:
 796       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 797       break;
 798     }
 799 }
 800
 801 static void
 802 g_keyfile_settings_backend_class_init (GKeyfileSettingsBackendClass *class)
 803 {
 804   GObjectClass *object_class = G_OBJECT_CLASS (class);
 805
 806   object_class->finalize = g_keyfile_settings_backend_finalize;
 807   object_class->constructed = g_keyfile_settings_backend_constructed;
 808   object_class->get_property = g_keyfile_settings_backend_get_property;
 809   object_class->set_property = g_keyfile_settings_backend_set_property;
 810
 811   class->read = g_keyfile_settings_backend_read;
 812   class->write = g_keyfile_settings_backend_write;
 813   class->write_tree = g_keyfile_settings_backend_write_tree;
 814   class->reset = g_keyfile_settings_backend_reset;
 815   class->get_writable = g_keyfile_settings_backend_get_writable;
 816   class->get_permission = g_keyfile_settings_backend_get_permission;
 817   /* No need to implement subscribed/unsubscribe: the only point would be to
 818    * stop monitoring the file when there's no GSettings anymore, which is no
 819    * big win.
 820    */
 821
 822   /**
 823    * GKeyfileSettingsBackend:filename:
 824    *
 825    * The location where the settings are stored on disk.
 826    *
 827    * Defaults to `$XDG_CONFIG_HOME/glib-2.0/settings/keyfile`.
 828    */
 829   g_object_class_install_property (object_class,
 830                                    PROP_FILENAME,
 831                                    g_param_spec_string ("filename",
 832                                                         P_("Filename"),
 833                                                         P_("The filename"),
 834                                                         NULL,
 835                                                         G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
 836                                                         G_PARAM_STATIC_STRINGS));
 837
 838   /**
 839    * GKeyfileSettingsBackend:root-path:
 840    *
 841    * All settings read to or written from the backend must fall under the
 842    * path given in @root_path (which must start and end with a slash and
 843    * not contain two consecutive slashes).  @root_path may be "/".
 844    *
 845    * Defaults to "/".
 846    */
 847   g_object_class_install_property (object_class,
 848                                    PROP_ROOT_PATH,
 849                                    g_param_spec_string ("root-path",
 850                                                         P_("Root path"),
 851                                                         P_("The root path"),
 852                                                         NULL,
 853                                                         G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
 854                                                         G_PARAM_STATIC_STRINGS));
 855
 856   /**
 857    * GKeyfileSettingsBackend:root-group:
 858    *
 859    * If @root_group is non-%NULL then it specifies the name of the keyfile
 860    * group used for keys that are written directly below the root path.
 861    *
 862    * Defaults to NULL.
 863    */
 864   g_object_class_install_property (object_class,
 865                                    PROP_ROOT_GROUP,
 866                                    g_param_spec_string ("root-group",
 867                                                         P_("Root group"),
 868                                                         P_("The root group"),
 869                                                         NULL,
 870                                                         G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
 871                                                         G_PARAM_STATIC_STRINGS));
 872
 873   /**
 874    * GKeyfileSettingsBackend:default-dir:
 875    *
 876    * The directory where the system defaults and locks are located.
 877    *
 878    * Defaults to `/etc/glib-2.0/settings`.
 879    */
 880   g_object_class_install_property (object_class,
 881                                    PROP_DEFAULTS_DIR,
 882                                    g_param_spec_string ("defaults-dir",
 883                                                         P_("Default dir"),
 884                                                         P_("Defaults dir"),
 885                                                         NULL,
 886                                                         G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
 887                                                         G_PARAM_STATIC_STRINGS));
 888 }
 889
 890 /**
 891  * g_keyfile_settings_backend_new:
 892  * @filename: the filename of the keyfile
 893  * @root_path: the path under which all settings keys appear
 894  * @root_group: (nullable): the group name corresponding to
 895  *              @root_path, or %NULL
 896  *
 897  * Creates a keyfile-backed #GSettingsBackend.
 898  *
 899  * The filename of the keyfile to use is given by @filename.
 900  *
 901  * All settings read to or written from the backend must fall under the
 902  * path given in @root_path (which must start and end with a slash and
 903  * not contain two consecutive slashes).  @root_path may be "/".
 904  *
 905  * If @root_group is non-%NULL then it specifies the name of the keyfile
 906  * group used for keys that are written directly below @root_path.  For
 907  * example, if @root_path is "/apps/example/" and @root_group is
 908  * "toplevel", then settings the key "/apps/example/enabled" to a value
 909  * of %TRUE will cause the following to appear in the keyfile:
 910  *
 911  * |[
 912  *   [toplevel]
 913  *   enabled=true
 914  * ]|
 915  *
 916  * If @root_group is %NULL then it is not permitted to store keys
 917  * directly below the @root_path.
 918  *
 919  * For keys not stored directly below @root_path (ie: in a sub-path),
 920  * the name of the subpath (with the final slash stripped) is used as
 921  * the name of the keyfile group.  To continue the example, if
 922  * "/apps/example/profiles/default/font-size" were set to
 923  * 12 then the following would appear in the keyfile:
 924  *
 925  * |[
 926  *   [profiles/default]
 927  *   font-size=12
 928  * ]|
 929  *
 930  * The backend will refuse writes (and return writability as being
 931  * %FALSE) for keys outside of @root_path and, in the event that
 932  * @root_group is %NULL, also for keys directly under @root_path.
 933  * Writes will also be refused if the backend detects that it has the
 934  * inability to rewrite the keyfile (ie: the containing directory is not
 935  * writable).
 936  *
 937  * There is no checking done for your key namespace clashing with the
 938  * syntax of the key file format.  For example, if you have '[' or ']'
 939  * characters in your path names or '=' in your key names you may be in
 940  * trouble.
 941  *
 942  * The backend reads default values from a keyfile called `defaults` in
 943  * the directory specified by the #GKeyfileSettingsBackend:defaults-dir property,
 944  * and a list of locked keys from a text file with the name `locks` in
 945  * the same location.
 946  *
 947  * Returns: (transfer full): a keyfile-backed #GSettingsBackend
 948  **/
 949 GSettingsBackend *
 950 g_keyfile_settings_backend_new (const gchar *filename,
 951                                 const gchar *root_path,
 952                                 const gchar *root_group)
 953 {
 954   g_return_val_if_fail (filename != NULL, NULL);
 955   g_return_val_if_fail (root_path != NULL, NULL);
 956   g_return_val_if_fail (g_str_has_prefix (root_path, "/"), NULL);
 957   g_return_val_if_fail (g_str_has_suffix (root_path, "/"), NULL);
 958   g_return_val_if_fail (strstr (root_path, "//") == NULL, NULL);
 959
 960   return G_SETTINGS_BACKEND (g_object_new (G_TYPE_KEYFILE_SETTINGS_BACKEND,
 961                                            "filename", filename,
 962                                            "root-path", root_path,
 963                                            "root-group", root_group,
 964                                            NULL));
 965 }