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