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-conf.h"
  35 #include "modest-marshal.h"
  36 #include <stdio.h>
  37
  38 static void   modest_conf_class_init     (ModestConfClass *klass);
  39
  40 static void   modest_conf_init           (ModestConf *obj);
  41
  42 static void   modest_conf_finalize       (GObject *obj);
  43
  44 static void   modest_conf_on_change      (GConfClient *client, guint conn_id,
  45                                           GConfEntry *entry, gpointer data);
  46
  47 static GConfValueType modest_conf_type_to_gconf_type (ModestConfValueType value_type,
  48                                                       GError **err);
  49
  50 /* list my signals */
  51 enum {
  52         KEY_CHANGED_SIGNAL,
  53         LAST_SIGNAL
  54 };
  55 static guint signals[LAST_SIGNAL] = {0};
  56
  57
  58 typedef struct _ModestConfPrivate ModestConfPrivate;
  59 struct _ModestConfPrivate {
  60         GConfClient *gconf_client;
  61 };
  62 #define MODEST_CONF_GET_PRIVATE(o)      (G_TYPE_INSTANCE_GET_PRIVATE((o), \
  63                                                                      MODEST_TYPE_CONF, \
  64                                                                      ModestConfPrivate))
  65 /* globals */
  66 static GObjectClass *parent_class = NULL;
  67
  68 GType
  69 modest_conf_get_type (void)
  70 {
  71         static GType my_type = 0;
  72         if (!my_type) {
  73                 static const GTypeInfo my_info = {
  74                         sizeof(ModestConfClass),
  75                         NULL,           /* base init */
  76                         NULL,           /* base finalize */
  77                         (GClassInitFunc) modest_conf_class_init,
  78                         NULL,           /* class finalize */
  79                         NULL,           /* class data */
  80                         sizeof(ModestConf),
  81                         1,              /* n_preallocs */
  82                         (GInstanceInitFunc) modest_conf_init,
  83                         NULL
  84                 };
  85                 my_type = g_type_register_static (G_TYPE_OBJECT,
  86                                                   "ModestConf",
  87                                                   &my_info, 0);
  88         }
  89         return my_type;
  90 }
  91
  92 static void
  93 modest_conf_class_init (ModestConfClass *klass)
  94 {
  95         GObjectClass *gobject_class;
  96         gobject_class = (GObjectClass*) klass;
  97
  98         parent_class            = g_type_class_peek_parent (klass);
  99         gobject_class->finalize = modest_conf_finalize;
 100
 101         g_type_class_add_private (gobject_class, sizeof(ModestConfPrivate));
 102
 103         signals[KEY_CHANGED_SIGNAL] =
 104                 g_signal_new ("key_changed",
 105                               G_TYPE_FROM_CLASS (gobject_class),
 106                               G_SIGNAL_RUN_FIRST,
 107                               G_STRUCT_OFFSET (ModestConfClass,key_changed),
 108                               NULL, NULL,
 109                               modest_marshal_VOID__STRING_INT_INT,
 110                               G_TYPE_NONE, 3, G_TYPE_STRING, G_TYPE_INT, G_TYPE_INT);
 111 }
 112
 113 static void
 114 modest_conf_init (ModestConf *obj)
 115 {
 116         GConfClient *conf = NULL;
 117         GError *error = NULL;
 118         ModestConfPrivate *priv = MODEST_CONF_GET_PRIVATE(obj);
 119
 120         priv->gconf_client = NULL;
 121
 122         conf = gconf_client_get_default ();
 123         if (!conf) {
 124                 g_printerr ("modest: could not get gconf client\n");
 125                 return;
 126         }
 127
 128         priv->gconf_client = conf;
 129
 130         /* All the tree will be listened */
 131         gconf_client_add_dir (priv->gconf_client,
 132                               "/apps/modest",
 133                               GCONF_CLIENT_PRELOAD_NONE,
 134                               &error);
 135
 136         /* Notify every change under namespace */
 137         if (!error)
 138                 gconf_client_notify_add (priv->gconf_client,
 139                                          "/apps/modest",
 140                                          modest_conf_on_change,
 141                                          obj,
 142                                          NULL,
 143                                          &error);
 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
 232         g_return_val_if_fail (self, NULL);
 233         g_return_val_if_fail (key,  NULL);
 234
 235         priv = MODEST_CONF_GET_PRIVATE(self);
 236
 237         gconf_type = modest_conf_type_to_gconf_type (list_type, err);
 238
 239         return gconf_client_get_list (priv->gconf_client, key, gconf_type, err);
 240 }
 241
 242
 243
 244
 245 gboolean
 246 modest_conf_set_string (ModestConf* self, const gchar* key, const gchar* val,
 247                         GError **err)
 248 {
 249         ModestConfPrivate *priv;
 250
 251         g_return_val_if_fail (self,FALSE);
 252         g_return_val_if_fail (key, FALSE);
 253         g_return_val_if_fail (val, FALSE);
 254
 255         priv = MODEST_CONF_GET_PRIVATE(self);
 256
 257         if (!gconf_client_key_is_writable(priv->gconf_client,key,err)) {
 258                 g_printerr ("modest: '%s' is not writable\n", key);
 259                 return FALSE;
 260         }
 261
 262         return gconf_client_set_string (priv->gconf_client, key, val, err);
 263 }
 264
 265 gboolean
 266 modest_conf_set_int  (ModestConf* self, const gchar* key, gint val,
 267                       GError **err)
 268 {
 269         ModestConfPrivate *priv;
 270
 271         g_return_val_if_fail (self,FALSE);
 272         g_return_val_if_fail (key, FALSE);
 273
 274         priv = MODEST_CONF_GET_PRIVATE(self);
 275
 276         if (!gconf_client_key_is_writable(priv->gconf_client,key,err)) {
 277                 g_printerr ("modest: '%s' is not writable\n", key);
 278                 return FALSE;
 279         }
 280
 281         return gconf_client_set_int (priv->gconf_client, key, val, err);
 282 }
 283
 284
 285 gboolean
 286 modest_conf_set_bool (ModestConf* self, const gchar* key, gboolean val,
 287                       GError **err)
 288 {
 289         ModestConfPrivate *priv;
 290
 291         g_return_val_if_fail (self,FALSE);
 292         g_return_val_if_fail (key, FALSE);
 293
 294         priv = MODEST_CONF_GET_PRIVATE(self);
 295
 296         if (!gconf_client_key_is_writable(priv->gconf_client,key, err)) {
 297                 g_warning ("modest: '%s' is not writable\n", key);
 298                 return FALSE;
 299         }
 300
 301         return gconf_client_set_bool (priv->gconf_client, key, val, err);
 302 }
 303
 304
 305 gboolean
 306 modest_conf_set_list (ModestConf* self, const gchar* key,
 307                       GSList *val, ModestConfValueType list_type,
 308                       GError **err)
 309 {
 310         ModestConfPrivate *priv;
 311         GConfValueType gconf_type;
 312         gboolean result;
 313
 314         g_return_val_if_fail (self, FALSE);
 315         g_return_val_if_fail (key, FALSE);
 316
 317         priv = MODEST_CONF_GET_PRIVATE(self);
 318
 319         gconf_type = modest_conf_type_to_gconf_type (list_type, err);
 320         if (*err)
 321                 return FALSE;
 322
 323         result = gconf_client_set_list (priv->gconf_client, key, gconf_type, val, err);
 324         if(*err) {
 325                 g_warning("gconf_client_set_list() failed with key=%s. error=%s", key,
 326                           (*err)->message);
 327                 result = FALSE;
 328         }
 329
 330         /* TODO: Remove this, when we fix the problem: */
 331         /* This shows that sometimes set_list fails, while saying that it succeeded: */
 332         if (result) {
 333                 const gint debug_list_length_start = g_slist_length(val);
 334                 GSList* debug_list = gconf_client_get_list(priv->gconf_client, key, gconf_type, err);
 335                 const gint debug_list_length_after = g_slist_length(debug_list);
 336
 337                 if(debug_list_length_start != debug_list_length_after)
 338                         g_warning("modest_conf_set_list(): The list length after setting is "
 339                                   "not the same as the specified list. key=%s. "
 340                                   "We think that we fixed this, so tell us if you see this.", key);
 341                 g_slist_free(debug_list);
 342         }
 343
 344         return result;
 345 }
 346
 347
 348 GSList*
 349 modest_conf_list_subkeys (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_all_dirs (priv->gconf_client,key,err);
 359 }
 360
 361
 362 gboolean
 363 modest_conf_remove_key (ModestConf* self, const gchar* key, GError **err)
 364 {
 365         ModestConfPrivate *priv;
 366         gboolean retval;
 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         retval = gconf_client_recursive_unset (priv->gconf_client,key,0,err);
 374         gconf_client_suggest_sync (priv->gconf_client, NULL);
 375
 376         return retval;
 377 }
 378
 379
 380 gboolean
 381 modest_conf_key_exists (ModestConf* self, const gchar* key, GError **err)
 382 {
 383         ModestConfPrivate *priv;
 384         GConfValue *val;
 385
 386         g_return_val_if_fail (self,FALSE);
 387         g_return_val_if_fail (key, FALSE);
 388
 389         priv = MODEST_CONF_GET_PRIVATE(self);
 390
 391         /* the fast way... */
 392         if (gconf_client_dir_exists (priv->gconf_client,key,err))
 393                 return TRUE;
 394
 395         val = gconf_client_get (priv->gconf_client, key, NULL);
 396         if (!val)
 397                 return FALSE;
 398         else {
 399                 gconf_value_free (val);
 400                 return TRUE;
 401         }
 402 }
 403
 404
 405 gchar*
 406 modest_conf_key_escape (const gchar* key)
 407 {
 408         g_return_val_if_fail (key, NULL);
 409         g_return_val_if_fail (strlen (key) > 0, g_strdup (key));
 410
 411         return gconf_escape_key (key, strlen(key));
 412 }
 413
 414
 415 gchar*
 416 modest_conf_key_unescape (const gchar* key)
 417 {
 418         g_return_val_if_fail (key, NULL);
 419
 420         return gconf_unescape_key (key, strlen(key));
 421 }
 422
 423 gboolean
 424 modest_conf_key_is_valid (const gchar* key)
 425 {
 426         return gconf_valid_key (key, NULL);
 427 }
 428
 429 static void
 430 modest_conf_on_change (GConfClient *client,
 431                        guint conn_id,
 432                        GConfEntry *entry,
 433                        gpointer data)
 434 {
 435         ModestConfEvent event;
 436         const gchar* key;
 437
 438         event = (entry->value) ? MODEST_CONF_EVENT_KEY_CHANGED : MODEST_CONF_EVENT_KEY_UNSET;
 439         key    = gconf_entry_get_key (entry);
 440
 441         g_signal_emit (G_OBJECT(data),
 442                        signals[KEY_CHANGED_SIGNAL], 0,
 443                        key, event, conn_id);
 444 }
 445
 446 static GConfValueType
 447 modest_conf_type_to_gconf_type (ModestConfValueType value_type, GError **err)
 448 {
 449         GConfValueType gconf_type;
 450
 451         switch (value_type) {
 452         case MODEST_CONF_VALUE_INT:
 453                 gconf_type = GCONF_VALUE_INT;
 454                 break;
 455         case MODEST_CONF_VALUE_BOOL:
 456                 gconf_type = GCONF_VALUE_BOOL;
 457                 break;
 458         case MODEST_CONF_VALUE_FLOAT:
 459                 gconf_type = GCONF_VALUE_FLOAT;
 460                 break;
 461         case MODEST_CONF_VALUE_STRING:
 462                 gconf_type = GCONF_VALUE_STRING;
 463                 break;
 464         default:
 465                 /* FIXME: use MODEST_ERROR, and error code */
 466                 gconf_type = GCONF_VALUE_INVALID;
 467                 g_printerr ("modest: invalid list value type %d\n", value_type);
 468                 *err = g_error_new_literal (0, 0, "invalid list value type");
 469         }
 470         return gconf_type;
 471 }
 472
 473 void
 474 modest_conf_listen_to_namespace (ModestConf *self,
 475                                  const gchar *namespace)
 476 {
 477         ModestConfPrivate *priv;
 478         GError *error = NULL;
 479
 480         g_return_if_fail (MODEST_IS_CONF (self));
 481         g_return_if_fail (namespace);
 482
 483         priv = MODEST_CONF_GET_PRIVATE(self);
 484
 485         /* Add the namespace to the list of the namespaces that will
 486            be observed */
 487         gconf_client_add_dir (priv->gconf_client,
 488                               namespace,
 489                               GCONF_CLIENT_PRELOAD_NONE,
 490                               &error);
 491 }
 492
 493 void
 494 modest_conf_forget_namespace (ModestConf *self,
 495                               const gchar *namespace)
 496 {
 497         ModestConfPrivate *priv;
 498
 499         g_return_if_fail (MODEST_IS_CONF (self));
 500         g_return_if_fail (namespace);
 501
 502         priv = MODEST_CONF_GET_PRIVATE(self);
 503
 504         /* Remove the namespace to the list of the namespaces that will
 505            be observed */
 506         gconf_client_remove_dir (priv->gconf_client, namespace, NULL);
 507 }