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                         NULL
  74                 };
  75                 my_type = g_type_register_static (G_TYPE_OBJECT,
  76                                                   "ModestConf",
  77                                                   &my_info, 0);
  78         }
  79         return my_type;
  80 }
  81
  82 static void
  83 modest_conf_class_init (ModestConfClass *klass)
  84 {
  85         GObjectClass *gobject_class;
  86         gobject_class = (GObjectClass*) klass;
  87
  88         parent_class            = g_type_class_peek_parent (klass);
  89         gobject_class->finalize = modest_conf_finalize;
  90
  91         g_type_class_add_private (gobject_class, sizeof(ModestConfPrivate));
  92
  93         signals[KEY_CHANGED_SIGNAL] =
  94                 g_signal_new ("key_changed",
  95                               G_TYPE_FROM_CLASS (gobject_class),
  96                               G_SIGNAL_RUN_FIRST,
  97                               G_STRUCT_OFFSET (ModestConfClass,key_changed),
  98                               NULL, NULL,
  99                               modest_marshal_VOID__STRING_INT,
 100                               G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_INT);
 101 }
 102
 103 static void
 104 modest_conf_init (ModestConf *obj)
 105 {
 106         GConfClient *conf = NULL;
 107         ModestConfPrivate *priv = MODEST_CONF_GET_PRIVATE(obj);
 108         GError *err      = NULL;
 109
 110         priv->gconf_client = NULL;
 111
 112         conf = gconf_client_get_default ();
 113         if (!conf) {
 114                 g_printerr ("modest: could not get gconf client\n");
 115                 return;
 116         }
 117
 118         gconf_client_add_dir (conf,MODEST_CONF_NAMESPACE,
 119                               GCONF_CLIENT_PRELOAD_NONE,
 120                               &err);
 121         if (err) {
 122                 g_printerr ("modest: error %d with gconf_client_add_dir: '%s'\n",
 123                             err->code, err->message);
 124                 g_object_unref (conf);
 125                 g_error_free (err);
 126                 return;
 127         }
 128
 129         gconf_client_notify_add (conf, MODEST_CONF_NAMESPACE,
 130                                  modest_conf_on_change,
 131                                  obj, NULL, &err);
 132         if (err) {
 133                 g_printerr ("modest: gconf_client_notify_add error %d: '%s'\n",
 134                             err->code, err->message);
 135                 g_object_unref (conf);
 136                 g_error_free (err);
 137                 return;
 138         }
 139
 140         priv->gconf_client = conf;      /* all went well! */
 141 }
 142
 143 static void
 144 modest_conf_finalize (GObject *obj)
 145 {
 146         ModestConfPrivate *priv = MODEST_CONF_GET_PRIVATE(obj);
 147         if (priv->gconf_client) {
 148
 149                 gconf_client_suggest_sync (priv->gconf_client, NULL);
 150
 151                 g_object_unref (priv->gconf_client);
 152                 priv->gconf_client = NULL;
 153         }
 154
 155         G_OBJECT_CLASS(parent_class)->finalize (obj);
 156 }
 157
 158 ModestConf*
 159 modest_conf_new (void)
 160 {
 161         ModestConf *conf;
 162         ModestConfPrivate *priv;
 163
 164         conf = MODEST_CONF(g_object_new(MODEST_TYPE_CONF, NULL));
 165         if (!conf) {
 166                 g_printerr ("modest: failed to init ModestConf (GConf)\n");
 167                 return NULL;
 168         }
 169
 170         priv = MODEST_CONF_GET_PRIVATE(conf);
 171         if (!priv->gconf_client) {
 172                 g_printerr ("modest: failed to init gconf\n");
 173                 g_object_unref (conf);
 174                 return NULL;
 175         }
 176
 177         return conf;
 178 }
 179
 180
 181 gchar*
 182 modest_conf_get_string (ModestConf* self, const gchar* key, GError **err)
 183 {
 184         ModestConfPrivate *priv;
 185
 186         g_return_val_if_fail (self, NULL);
 187         g_return_val_if_fail (key,  NULL);
 188
 189         priv = MODEST_CONF_GET_PRIVATE(self);
 190         return gconf_client_get_string (priv->gconf_client, key, err);
 191 }
 192
 193
 194 gint
 195 modest_conf_get_int (ModestConf* self, const gchar* key, GError **err)
 196 {
 197         ModestConfPrivate *priv;
 198
 199         g_return_val_if_fail (self, -1);
 200         g_return_val_if_fail (key, -1);
 201
 202         priv = MODEST_CONF_GET_PRIVATE(self);
 203
 204         return gconf_client_get_int (priv->gconf_client, key, err);
 205 }
 206
 207
 208 gboolean
 209 modest_conf_get_bool (ModestConf* self, const gchar* key, GError **err)
 210 {
 211         ModestConfPrivate *priv;
 212
 213         g_return_val_if_fail (self, FALSE);
 214         g_return_val_if_fail (key, FALSE);
 215
 216         priv = MODEST_CONF_GET_PRIVATE(self);
 217
 218         return gconf_client_get_bool (priv->gconf_client, key, err);
 219 }
 220
 221
 222
 223 gchar*
 224 modest_conf_get_string_or_default (ModestConf* self, const gchar* key,
 225                                    const gchar *defaultval)
 226 {
 227         ModestConfPrivate *priv;
 228         GConfValue *val;
 229         const gchar *str;
 230
 231         g_return_val_if_fail (self, g_strdup(defaultval));
 232         g_return_val_if_fail (key,  g_strdup(defaultval));
 233
 234         priv = MODEST_CONF_GET_PRIVATE(self);
 235         val = gconf_client_get (priv->gconf_client, key, NULL);
 236
 237         if (!val)
 238                 str = defaultval;
 239         else {
 240                 str = gconf_value_get_string (val);
 241                 gconf_value_free (val);
 242         }
 243
 244         return g_strdup (str);
 245 }
 246
 247
 248 gint
 249 modest_conf_get_int_or_default (ModestConf* self, const gchar* key,
 250                                 gint defaultval)
 251 {
 252         ModestConfPrivate *priv;
 253         GConfValue *val;
 254         gint retval;
 255
 256         g_return_val_if_fail (self, defaultval);
 257         g_return_val_if_fail (key,  defaultval);
 258
 259         priv = MODEST_CONF_GET_PRIVATE(self);
 260         val = gconf_client_get (priv->gconf_client, key, NULL);
 261
 262         if (!val)
 263                 retval = defaultval;
 264         else {
 265                 retval = gconf_value_get_int (val);
 266                 gconf_value_free (val);
 267         }
 268
 269         return retval;
 270 }
 271
 272
 273
 274
 275 gboolean
 276 modest_conf_set_string (ModestConf* self, const gchar* key, const gchar* val,
 277                         GError **err)
 278 {
 279         ModestConfPrivate *priv;
 280
 281         g_return_val_if_fail (self,FALSE);
 282         g_return_val_if_fail (key, FALSE);
 283
 284         priv = MODEST_CONF_GET_PRIVATE(self);
 285
 286         if (!gconf_client_key_is_writable(priv->gconf_client,key,err)) {
 287                 g_printerr ("modest: '%s' is not writable\n", key);
 288                 return FALSE;
 289         }
 290
 291         return gconf_client_set_string (priv->gconf_client, key, val, err);
 292 }
 293
 294
 295 gboolean
 296 modest_conf_set_int  (ModestConf* self, const gchar* key, gint val,
 297                       GError **err)
 298 {
 299         ModestConfPrivate *priv;
 300
 301         g_return_val_if_fail (self,FALSE);
 302         g_return_val_if_fail (key, FALSE);
 303
 304         priv = MODEST_CONF_GET_PRIVATE(self);
 305
 306         if (!gconf_client_key_is_writable(priv->gconf_client,key,err)) {
 307                 g_printerr ("modest: '%s' is not writable\n", key);
 308                 return FALSE;
 309         }
 310
 311         return gconf_client_set_int (priv->gconf_client, key, val, err);
 312 }
 313
 314
 315 gboolean
 316 modest_conf_set_bool (ModestConf* self, const gchar* key, gboolean val,
 317                       GError **err)
 318 {
 319         ModestConfPrivate *priv;
 320
 321         g_return_val_if_fail (self,FALSE);
 322         g_return_val_if_fail (key, FALSE);
 323
 324         priv = MODEST_CONF_GET_PRIVATE(self);
 325
 326         if (!gconf_client_key_is_writable(priv->gconf_client,key, err)) {
 327                 g_warning ("modest: '%s' is not writable\n", key);
 328                 return FALSE;
 329         }
 330
 331         return gconf_client_set_bool (priv->gconf_client,key,val, err);
 332 }
 333
 334
 335
 336
 337 GSList*
 338 modest_conf_list_subkeys (ModestConf* self, const gchar* key, GError **err)
 339 {
 340         ModestConfPrivate *priv;
 341
 342         g_return_val_if_fail (self,FALSE);
 343         g_return_val_if_fail (key, FALSE);
 344
 345         priv = MODEST_CONF_GET_PRIVATE(self);
 346
 347         return gconf_client_all_dirs (priv->gconf_client,key,err);
 348 }
 349
 350
 351 gboolean
 352 modest_conf_remove_key (ModestConf* self, const gchar* key, GError **err)
 353 {
 354         ModestConfPrivate *priv;
 355
 356         g_return_val_if_fail (self,FALSE);
 357         g_return_val_if_fail (key, FALSE);
 358
 359         priv = MODEST_CONF_GET_PRIVATE(self);
 360
 361         return gconf_client_recursive_unset (priv->gconf_client,key,0,err);
 362 }
 363
 364
 365 gboolean
 366 modest_conf_key_exists (ModestConf* self, const gchar* key, GError **err)
 367 {
 368         ModestConfPrivate *priv;
 369         GConfValue *val;
 370
 371         g_return_val_if_fail (self,FALSE);
 372         g_return_val_if_fail (key, FALSE);
 373
 374         priv = MODEST_CONF_GET_PRIVATE(self);
 375
 376         /* the fast way... */
 377         if (gconf_client_dir_exists (priv->gconf_client,key,err))
 378                 return TRUE;
 379
 380         val = gconf_client_get (priv->gconf_client, key, NULL);
 381         if (!val)
 382                 return FALSE;
 383         else {
 384                 gconf_value_free (val);
 385                 return TRUE;
 386         }
 387 }
 388
 389
 390 gchar*
 391 modest_conf_key_escape (ModestConf *self, const gchar* key)
 392 {
 393         g_return_val_if_fail (key, NULL);
 394
 395         return gconf_escape_key (key, strlen(key));
 396 }
 397
 398
 399 gchar*
 400 modest_conf_key_unescape (ModestConf *self, const gchar* key)
 401 {
 402         g_return_val_if_fail (key, NULL);
 403
 404         return gconf_unescape_key (key, strlen(key));
 405 }
 406
 407
 408
 409 static void
 410 modest_conf_on_change (GConfClient *client, guint conn_id, GConfEntry *entry,
 411                        gpointer data)
 412 {
 413         ModestConfEvent event;
 414         const gchar* key;
 415
 416         event = (entry->value) ? MODEST_CONF_EVENT_KEY_CHANGED : MODEST_CONF_EVENT_KEY_UNSET;
 417         key    = gconf_entry_get_key (entry);
 418
 419         g_signal_emit (G_OBJECT(data),
 420                        signals[KEY_CHANGED_SIGNAL], 0,
 421                        key, event);
 422 }
 423
 424 GSList *
 425 modest_conf_get_list (ModestConf* self, const gchar* key, ModestConfValueType list_type, GError **err)
 426 {
 427         ModestConfPrivate *priv;
 428         GConfValueType gconf_type;
 429
 430         g_return_val_if_fail (self, NULL);
 431         g_return_val_if_fail (key,  NULL);
 432
 433         priv = MODEST_CONF_GET_PRIVATE(self);
 434
 435         switch (list_type) {
 436         case MODEST_CONF_VALUE_INT:
 437                 gconf_type = GCONF_VALUE_INT;
 438                 break;
 439         case MODEST_CONF_VALUE_BOOL:
 440                 gconf_type = GCONF_VALUE_BOOL;
 441                 break;
 442         case MODEST_CONF_VALUE_FLOAT:
 443                 gconf_type = GCONF_VALUE_FLOAT;
 444                 break;
 445         case MODEST_CONF_VALUE_STRING:
 446                 gconf_type = GCONF_VALUE_STRING;
 447                 break;
 448         default:
 449                 return NULL;
 450         }
 451
 452         return gconf_client_get_list (priv->gconf_client, key, gconf_type, err);
 453 }