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 #include <stdio.h>
  36
  37 static void   modest_conf_class_init     (ModestConfClass *klass);
  38 static void   modest_conf_init           (ModestConf *obj);
  39 static void   modest_conf_finalize       (GObject *obj);
  40 static void   modest_conf_on_change      (GConfClient *client, guint conn_id,
  41                                           GConfEntry *entry, gpointer data);
  42 static GConfValueType modest_conf_type_to_gconf_type (ModestConfValueType value_type,
  43                                                       GError **err);
  44 /* list my signals */
  45 enum {
  46         KEY_CHANGED_SIGNAL,
  47         LAST_SIGNAL
  48 };
  49 static guint signals[LAST_SIGNAL] = {0};
  50
  51
  52 typedef struct _ModestConfPrivate ModestConfPrivate;
  53 struct _ModestConfPrivate {
  54         GConfClient *gconf_client;
  55 };
  56 #define MODEST_CONF_GET_PRIVATE(o)      (G_TYPE_INSTANCE_GET_PRIVATE((o), \
  57                                                                      MODEST_TYPE_CONF, \
  58                                                                      ModestConfPrivate))
  59 /* globals */
  60 static GObjectClass *parent_class = NULL;
  61
  62 GType
  63 modest_conf_get_type (void)
  64 {
  65         static GType my_type = 0;
  66         if (!my_type) {
  67                 static const GTypeInfo my_info = {
  68                         sizeof(ModestConfClass),
  69                         NULL,           /* base init */
  70                         NULL,           /* base finalize */
  71                         (GClassInitFunc) modest_conf_class_init,
  72                         NULL,           /* class finalize */
  73                         NULL,           /* class data */
  74                         sizeof(ModestConf),
  75                         1,              /* n_preallocs */
  76                         (GInstanceInitFunc) modest_conf_init,
  77                         NULL
  78                 };
  79                 my_type = g_type_register_static (G_TYPE_OBJECT,
  80                                                   "ModestConf",
  81                                                   &my_info, 0);
  82         }
  83         return my_type;
  84 }
  85
  86 static void
  87 modest_conf_class_init (ModestConfClass *klass)
  88 {
  89         GObjectClass *gobject_class;
  90         gobject_class = (GObjectClass*) klass;
  91
  92         parent_class            = g_type_class_peek_parent (klass);
  93         gobject_class->finalize = modest_conf_finalize;
  94
  95         g_type_class_add_private (gobject_class, sizeof(ModestConfPrivate));
  96
  97         signals[KEY_CHANGED_SIGNAL] =
  98                 g_signal_new ("key_changed",
  99                               G_TYPE_FROM_CLASS (gobject_class),
 100                               G_SIGNAL_RUN_FIRST,
 101                               G_STRUCT_OFFSET (ModestConfClass,key_changed),
 102                               NULL, NULL,
 103                               modest_marshal_VOID__STRING_INT,
 104                               G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_INT);
 105 }
 106
 107 static void
 108 modest_conf_init (ModestConf *obj)
 109 {
 110         GConfClient *conf = NULL;
 111         ModestConfPrivate *priv = MODEST_CONF_GET_PRIVATE(obj);
 112         GError *err      = NULL;
 113
 114         priv->gconf_client = NULL;
 115
 116         conf = gconf_client_get_default ();
 117         if (!conf) {
 118                 g_printerr ("modest: could not get gconf client\n");
 119                 return;
 120         }
 121
 122         gconf_client_add_dir (conf,MODEST_CONF_NAMESPACE,
 123                               GCONF_CLIENT_PRELOAD_NONE,
 124                               &err);
 125         if (err) {
 126                 g_printerr ("modest: error %d with gconf_client_add_dir: '%s'\n",
 127                             err->code, err->message);
 128                 g_object_unref (conf);
 129                 g_error_free (err);
 130                 return;
 131         }
 132
 133         gconf_client_notify_add (conf, MODEST_CONF_NAMESPACE,
 134                                  modest_conf_on_change,
 135                                  obj, NULL, &err);
 136         if (err) {
 137                 g_printerr ("modest: gconf_client_notify_add error %d: '%s'\n",
 138                             err->code, err->message);
 139                 g_object_unref (conf);
 140                 g_error_free (err);
 141                 return;
 142         }
 143
 144         priv->gconf_client = conf;      /* all went well! */
 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
 212 gboolean
 213 modest_conf_get_bool (ModestConf* self, const gchar* key, GError **err)
 214 {
 215         ModestConfPrivate *priv;
 216
 217         g_return_val_if_fail (self, FALSE);
 218         g_return_val_if_fail (key, FALSE);
 219
 220         priv = MODEST_CONF_GET_PRIVATE(self);
 221
 222         return gconf_client_get_bool (priv->gconf_client, key, err);
 223 }
 224
 225
 226 GSList *
 227 modest_conf_get_list (ModestConf* self, const gchar* key, ModestConfValueType list_type,
 228                       GError **err)
 229 {
 230         ModestConfPrivate *priv;
 231         GConfValueType gconf_type;
 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         return gconf_client_get_list (priv->gconf_client, key, gconf_type, err);
 241 }
 242
 243
 244
 245
 246 gboolean
 247 modest_conf_set_string (ModestConf* self, const gchar* key, const gchar* val,
 248                         GError **err)
 249 {
 250         ModestConfPrivate *priv;
 251
 252         g_return_val_if_fail (self,FALSE);
 253         g_return_val_if_fail (key, 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
 266 gboolean
 267 modest_conf_set_int  (ModestConf* self, const gchar* key, gint val,
 268                       GError **err)
 269 {
 270         ModestConfPrivate *priv;
 271
 272         g_return_val_if_fail (self,FALSE);
 273         g_return_val_if_fail (key, FALSE);
 274
 275         priv = MODEST_CONF_GET_PRIVATE(self);
 276
 277         if (!gconf_client_key_is_writable(priv->gconf_client,key,err)) {
 278                 g_printerr ("modest: '%s' is not writable\n", key);
 279                 return FALSE;
 280         }
 281
 282         return gconf_client_set_int (priv->gconf_client, key, val, err);
 283 }
 284
 285
 286 gboolean
 287 modest_conf_set_bool (ModestConf* self, const gchar* key, gboolean val,
 288                       GError **err)
 289 {
 290         ModestConfPrivate *priv;
 291
 292         g_return_val_if_fail (self,FALSE);
 293         g_return_val_if_fail (key, FALSE);
 294
 295         priv = MODEST_CONF_GET_PRIVATE(self);
 296
 297         if (!gconf_client_key_is_writable(priv->gconf_client,key, err)) {
 298                 g_warning ("modest: '%s' is not writable\n", key);
 299                 return FALSE;
 300         }
 301
 302         return gconf_client_set_bool (priv->gconf_client,key,val, err);
 303 }
 304
 305
 306 gboolean
 307 modest_conf_set_list (ModestConf* self, const gchar* key,
 308                       GSList *val, ModestConfValueType list_type,
 309                       GError **err)
 310 {
 311         ModestConfPrivate *priv;
 312         GConfValueType gconf_type;
 313         gboolean result;
 314
 315         g_return_val_if_fail (self, FALSE);
 316         g_return_val_if_fail (key, FALSE);
 317
 318         priv = MODEST_CONF_GET_PRIVATE(self);
 319
 320         gconf_type = modest_conf_type_to_gconf_type (list_type, err);
 321         if (*err)
 322                 return FALSE;
 323
 324         result = gconf_client_set_list (priv->gconf_client, key, gconf_type, val, err);
 325         if(*err) {
 326                 g_warning("gconf_client_set_list() failed with key=%s. error=%s", key,
 327                           (*err)->message);
 328                 result = FALSE;
 329         }
 330
 331         /* TODO: Remove this, when we fix the problem: */
 332         /* This shows that sometimes set_list fails, while saying that it succeeded: */
 333         if (result) {
 334                 const gint debug_list_length_start = g_slist_length(val);
 335                 GSList* debug_list = gconf_client_get_list(priv->gconf_client, key, gconf_type, err);
 336                 const gint debug_list_length_after = g_slist_length(debug_list);
 337
 338                 if(debug_list_length_start != debug_list_length_after)
 339                         g_warning("modest_conf_set_list(): The list length after setting is "
 340                                   "not the same as the specified list. key=%s", 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
 430 /* hmmm... might need to make specific callback for specific keys */
 431 static void
 432 modest_conf_on_change (GConfClient *client, guint conn_id, 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);
 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 }