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