git.maemo.org Git - modest/blob - src/modest-conf.c

   1 /* Copyright (c) 2006, Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  * * Redistributions of source code must retain the above copyright
   9  *   notice, this list of conditions and the following disclaimer.
  10  * * Redistributions in binary form must reproduce the above copyright
  11  *   notice, this list of conditions and the following disclaimer in the
  12  *   documentation and/or other materials provided with the distribution.
  13  * * Neither the name of the Nokia Corporation nor the names of its
  14  *   contributors may be used to endorse or promote products derived from
  15  *   this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
  21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #include <gconf/gconf-client.h>
  31 #include <string.h>
  32 #include "modest-conf.h"
  33 #include "modest-marshal.h"
  34
  35 static void   modest_conf_class_init     (ModestConfClass *klass);
  36 static void   modest_conf_init           (ModestConf *obj);
  37 static void   modest_conf_finalize       (GObject *obj);
  38 static void   modest_conf_on_change      (GConfClient *client, guint conn_id,
  39                                           GConfEntry *entry, gpointer data);
  40 /* list my signals */
  41 enum {
  42         KEY_CHANGED_SIGNAL,
  43         LAST_SIGNAL
  44 };
  45 static guint signals[LAST_SIGNAL] = {0};
  46
  47
  48 typedef struct _ModestConfPrivate ModestConfPrivate;
  49 struct _ModestConfPrivate {
  50         GConfClient *gconf_client;
  51 };
  52 #define MODEST_CONF_GET_PRIVATE(o)      (G_TYPE_INSTANCE_GET_PRIVATE((o), \
  53                                          MODEST_TYPE_CONF, \
  54                                          ModestConfPrivate))
  55 /* globals */
  56 static GObjectClass *parent_class = NULL;
  57
  58 GType
  59 modest_conf_get_type (void)
  60 {
  61         static GType my_type = 0;
  62         if (!my_type) {
  63                 static const GTypeInfo my_info = {
  64                         sizeof(ModestConfClass),
  65                         NULL,           /* base init */
  66                         NULL,           /* base finalize */
  67                         (GClassInitFunc) modest_conf_class_init,
  68                         NULL,           /* class finalize */
  69                         NULL,           /* class data */
  70                         sizeof(ModestConf),
  71                         1,              /* n_preallocs */
  72                         (GInstanceInitFunc) modest_conf_init,
  73                 };
  74                 my_type = g_type_register_static (G_TYPE_OBJECT,
  75                                                   "ModestConf",
  76                                                   &my_info, 0);
  77         }
  78         return my_type;
  79 }
  80
  81 static void
  82 modest_conf_class_init (ModestConfClass *klass)
  83 {
  84         GObjectClass *gobject_class;
  85         gobject_class = (GObjectClass*) klass;
  86
  87         parent_class            = g_type_class_peek_parent (klass);
  88         gobject_class->finalize = modest_conf_finalize;
  89
  90         g_type_class_add_private (gobject_class, sizeof(ModestConfPrivate));
  91
  92         signals[KEY_CHANGED_SIGNAL] =
  93                 g_signal_new ("key_changed",
  94                               G_TYPE_FROM_CLASS (gobject_class),
  95                               G_SIGNAL_RUN_FIRST,
  96                               G_STRUCT_OFFSET (ModestConfClass,key_changed),
  97                               NULL, NULL,
  98                               modest_marshal_VOID__STRING_INT,
  99                               G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_INT);
 100 }
 101
 102 static void
 103 modest_conf_init (ModestConf *obj)
 104 {
 105         GConfClient *conf = NULL;
 106         ModestConfPrivate *priv = MODEST_CONF_GET_PRIVATE(obj);
 107         GError *err      = NULL;
 108
 109         priv->gconf_client = NULL;
 110
 111         conf = gconf_client_get_default ();
 112         if (!conf) {
 113                 g_printerr ("modest: could not get gconf client\n");
 114                 return;
 115         }
 116
 117         gconf_client_add_dir (conf,MODEST_CONF_NAMESPACE,
 118                               GCONF_CLIENT_PRELOAD_NONE,
 119                               &err);
 120         if (err) {
 121                 g_printerr ("modest: error %d with gconf_client_add_dir: '%s'\n",
 122                             err->code, err->message);
 123                 g_object_unref (conf);
 124                 g_error_free (err);
 125                 return;
 126         }
 127
 128         gconf_client_notify_add (conf, MODEST_CONF_NAMESPACE,
 129                                  modest_conf_on_change,
 130                                  obj, NULL, &err);
 131         if (err) {
 132                 g_printerr ("modest: gconf_client_notify_add error %d: '%s'\n",
 133                             err->code, err->message);
 134                 g_object_unref (conf);
 135                 g_error_free (err);
 136                 return;
 137         }
 138
 139         priv->gconf_client = conf;      /* all went well! */
 140 }
 141
 142 static void
 143 modest_conf_finalize (GObject *obj)
 144 {
 145         ModestConfPrivate *priv = MODEST_CONF_GET_PRIVATE(obj);
 146         if (priv->gconf_client) {
 147
 148                 gconf_client_suggest_sync (priv->gconf_client, NULL);
 149
 150                 g_object_unref (priv->gconf_client);
 151                 priv->gconf_client = NULL;
 152         }
 153 }
 154
 155 ModestConf*
 156 modest_conf_new (void)
 157 {
 158         ModestConf *conf;
 159         ModestConfPrivate *priv;
 160
 161         conf = MODEST_CONF(g_object_new(MODEST_TYPE_CONF, NULL));
 162         if (!conf) {
 163                 g_printerr ("modest: failed to init ModestConf (GConf)\n");
 164                 return NULL;
 165         }
 166
 167         priv = MODEST_CONF_GET_PRIVATE(conf);
 168         if (!priv->gconf_client) {
 169                 g_printerr ("modest: failed to init gconf\n");
 170                 g_object_unref (conf);
 171                 return NULL;
 172         }
 173
 174         return conf;
 175 }
 176
 177
 178 gchar*
 179 modest_conf_get_string (ModestConf* self, const gchar* key, GError **err)
 180 {
 181         ModestConfPrivate *priv;
 182
 183         g_return_val_if_fail (self, NULL);
 184         g_return_val_if_fail (key,  NULL);
 185
 186         priv = MODEST_CONF_GET_PRIVATE(self);
 187         return gconf_client_get_string (priv->gconf_client, key, err);
 188 }
 189
 190
 191 gint
 192 modest_conf_get_int (ModestConf* self, const gchar* key, GError **err)
 193 {
 194         ModestConfPrivate *priv;
 195
 196         g_return_val_if_fail (self, -1);
 197         g_return_val_if_fail (key, -1);
 198
 199         priv = MODEST_CONF_GET_PRIVATE(self);
 200
 201         return gconf_client_get_int (priv->gconf_client, key, err);
 202 }
 203
 204
 205 gboolean
 206 modest_conf_get_bool (ModestConf* self, const gchar* key, GError **err)
 207 {
 208         ModestConfPrivate *priv;
 209
 210         g_return_val_if_fail (self, FALSE);
 211         g_return_val_if_fail (key, FALSE);
 212
 213         priv = MODEST_CONF_GET_PRIVATE(self);
 214
 215         return gconf_client_get_bool (priv->gconf_client, key, err);
 216 }
 217
 218
 219
 220 gchar*
 221 modest_conf_get_string_or_default (ModestConf* self, const gchar* key,
 222                                    const gchar *defaultval)
 223 {
 224         ModestConfPrivate *priv;
 225         GConfValue *val;
 226         const gchar *str;
 227
 228         g_return_val_if_fail (self, g_strdup(defaultval));
 229         g_return_val_if_fail (key,  g_strdup(defaultval));
 230
 231         priv = MODEST_CONF_GET_PRIVATE(self);
 232         val = gconf_client_get (priv->gconf_client, key, NULL);
 233
 234         if (!val)
 235                 str = defaultval;
 236         else {
 237                 str = gconf_value_get_string (val);
 238                 gconf_value_free (val);
 239         }
 240
 241         return g_strdup (str);
 242 }
 243
 244
 245 gint
 246 modest_conf_get_int_or_default (ModestConf* self, const gchar* key,
 247                                 gint defaultval)
 248 {
 249         ModestConfPrivate *priv;
 250         GConfValue *val;
 251         gint retval;
 252
 253         g_return_val_if_fail (self, defaultval);
 254         g_return_val_if_fail (key,  defaultval);
 255
 256         priv = MODEST_CONF_GET_PRIVATE(self);
 257         val = gconf_client_get (priv->gconf_client, key, NULL);
 258
 259         if (!val)
 260                 retval = defaultval;
 261         else {
 262                 retval = gconf_value_get_int (val);
 263                 gconf_value_free (val);
 264         }
 265
 266         return retval;
 267 }
 268
 269
 270
 271
 272 gboolean
 273 modest_conf_set_string (ModestConf* self, const gchar* key, const gchar* val,
 274                         GError **err)
 275 {
 276         ModestConfPrivate *priv;
 277
 278         g_return_val_if_fail (self,FALSE);
 279         g_return_val_if_fail (key, FALSE);
 280
 281         priv = MODEST_CONF_GET_PRIVATE(self);
 282
 283         if (!gconf_client_key_is_writable(priv->gconf_client,key,err)) {
 284                 g_printerr ("modest: '%s' is not writable\n", key);
 285                 return FALSE;
 286         }
 287
 288         return gconf_client_set_string (priv->gconf_client, key, val, err);
 289 }
 290
 291
 292 gboolean
 293 modest_conf_set_int  (ModestConf* self, const gchar* key, gint val,
 294                       GError **err)
 295 {
 296         ModestConfPrivate *priv;
 297
 298         g_return_val_if_fail (self,FALSE);
 299         g_return_val_if_fail (key, FALSE);
 300
 301         priv = MODEST_CONF_GET_PRIVATE(self);
 302
 303         if (!gconf_client_key_is_writable(priv->gconf_client,key,err)) {
 304                 g_printerr ("modest: '%s' is not writable\n", key);
 305                 return FALSE;
 306         }
 307
 308         return gconf_client_set_int (priv->gconf_client, key, val, err);
 309 }
 310
 311
 312 gboolean
 313 modest_conf_set_bool (ModestConf* self, const gchar* key, gboolean val,
 314                       GError **err)
 315 {
 316         ModestConfPrivate *priv;
 317
 318         g_return_val_if_fail (self,FALSE);
 319         g_return_val_if_fail (key, FALSE);
 320
 321         priv = MODEST_CONF_GET_PRIVATE(self);
 322
 323         if (!gconf_client_key_is_writable(priv->gconf_client,key, err)) {
 324                 g_warning ("modest: '%s' is not writable\n", key);
 325                 return FALSE;
 326         }
 327
 328         return gconf_client_set_bool (priv->gconf_client,key,val, err);
 329 }
 330
 331
 332
 333
 334 GSList*
 335 modest_conf_list_subkeys (ModestConf* self, const gchar* key, GError **err)
 336 {
 337         ModestConfPrivate *priv;
 338
 339         g_return_val_if_fail (self,FALSE);
 340         g_return_val_if_fail (key, FALSE);
 341
 342         priv = MODEST_CONF_GET_PRIVATE(self);
 343
 344         return gconf_client_all_dirs (priv->gconf_client,key,err);
 345 }
 346
 347
 348 gboolean
 349 modest_conf_remove_key (ModestConf* self, const gchar* key, GError **err)
 350 {
 351         ModestConfPrivate *priv;
 352
 353         g_return_val_if_fail (self,FALSE);
 354         g_return_val_if_fail (key, FALSE);
 355
 356         priv = MODEST_CONF_GET_PRIVATE(self);
 357
 358         return gconf_client_recursive_unset (priv->gconf_client,key,0,err);
 359 }
 360
 361
 362 gboolean
 363 modest_conf_key_exists (ModestConf* self, const gchar* key, GError **err)
 364 {
 365         ModestConfPrivate *priv;
 366         gboolean dir_exists;
 367         GConfValue *val;
 368         const gchar *str;
 369
 370         g_return_val_if_fail (self,FALSE);
 371         g_return_val_if_fail (key, FALSE);
 372
 373         priv = MODEST_CONF_GET_PRIVATE(self);
 374
 375         /* the fast way... */
 376         if (gconf_client_dir_exists (priv->gconf_client,key,err))
 377                 return TRUE;
 378
 379         val = gconf_client_get (priv->gconf_client, key, NULL);
 380         if (!val)
 381                 return FALSE;
 382         else {
 383                 gconf_value_free (val);
 384                 return TRUE;
 385         }
 386 }
 387
 388
 389 gchar*
 390 modest_conf_key_escape (ModestConf *self, const gchar* key)
 391 {
 392         g_return_val_if_fail (key, NULL);
 393
 394         return gconf_escape_key (key, strlen(key));
 395 }
 396
 397
 398 gchar*
 399 modest_conf_key_unescape (ModestConf *self, const gchar* key)
 400 {
 401         g_return_val_if_fail (key, NULL);
 402
 403         return gconf_unescape_key (key, strlen(key));
 404 }
 405
 406
 407
 408 static void
 409 modest_conf_on_change (GConfClient *client, guint conn_id, GConfEntry *entry,
 410                        gpointer data)
 411 {
 412         ModestConfEvent event;
 413         const gchar* key;
 414
 415         event = (entry->value) ? MODEST_CONF_EVENT_KEY_CHANGED : MODEST_CONF_EVENT_KEY_UNSET;
 416         key    = gconf_entry_get_key (entry);
 417
 418         g_signal_emit (G_OBJECT(data),
 419                        signals[KEY_CHANGED_SIGNAL], 0,
 420                        key, event);
 421 }