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                 };
  74                 my_type = g_type_register_static (G_TYPE_OBJECT,
  75                                                   "ModestConf",
  76                                                   &my_info, 0);
  77         }
  78         return my_type;
  79 }
  80
  81 static void
  82 modest_conf_class_init (ModestConfClass *klass)
  83 {
  84         GObjectClass *gobject_class;
  85         gobject_class = (GObjectClass*) klass;
  86
  87         parent_class            = g_type_class_peek_parent (klass);
  88         gobject_class->finalize = modest_conf_finalize;
  89
  90         g_type_class_add_private (gobject_class, sizeof(ModestConfPrivate));
  91
  92         signals[KEY_CHANGED_SIGNAL] =
  93                 g_signal_new ("key_changed",
  94                               G_TYPE_FROM_CLASS (gobject_class),
  95                               G_SIGNAL_RUN_FIRST,
  96                               G_STRUCT_OFFSET (ModestConfClass,key_changed),
  97                               NULL, NULL,
  98                               modest_marshal_VOID__STRING_INT,
  99                               G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_INT);
 100 }
 101
 102 static void
 103 modest_conf_init (ModestConf *obj)
 104 {
 105         GConfClient *conf = NULL;
 106         ModestConfPrivate *priv = MODEST_CONF_GET_PRIVATE(obj);
 107         GError *err      = NULL;
 108
 109         priv->gconf_client = NULL;
 110
 111         conf = gconf_client_get_default ();
 112         if (!conf) {
 113                 g_printerr ("modest: could not get gconf client\n");
 114                 return;
 115         }
 116
 117         gconf_client_add_dir (conf,MODEST_CONF_NAMESPACE,
 118                               GCONF_CLIENT_PRELOAD_NONE,
 119                               &err);
 120         if (err) {
 121                 g_printerr ("modest: error %d with gconf_client_add_dir: '%s'\n",
 122                             err->code, err->message);
 123                 g_object_unref (conf);
 124                 g_error_free (err);
 125                 return;
 126         }
 127
 128         gconf_client_notify_add (conf, MODEST_CONF_NAMESPACE,
 129                                  modest_conf_on_change,
 130                                  obj, NULL, &err);
 131         if (err) {
 132                 g_printerr ("modest: gconf_client_notify_add error %d: '%s'\n",
 133                             err->code, err->message);
 134                 g_object_unref (conf);
 135                 g_error_free (err);
 136                 return;
 137         }
 138
 139         priv->gconf_client = conf;      /* all went well! */
 140 }
 141
 142 static void
 143 modest_conf_finalize (GObject *obj)
 144 {
 145         ModestConfPrivate *priv = MODEST_CONF_GET_PRIVATE(obj);
 146         if (priv->gconf_client) {
 147
 148                 gconf_client_suggest_sync (priv->gconf_client, NULL);
 149
 150                 g_object_unref (priv->gconf_client);
 151                 priv->gconf_client = NULL;
 152         }
 153 }
 154
 155 GObject*
 156 modest_conf_new (void)
 157 {
 158         ModestConf *conf = MODEST_CONF(g_object_new(MODEST_TYPE_CONF, NULL));
 159         if (!conf) {
 160                 g_printerr ("modest: failed to init ModestConf (GConf)\n");
 161                 return NULL;
 162         }
 163
 164         ModestConfPrivate *priv = MODEST_CONF_GET_PRIVATE(conf);
 165         if (!priv->gconf_client) {
 166                 g_printerr ("modest: failed to init gconf\n");
 167                 g_object_unref (conf);
 168                 return NULL;
 169         }
 170
 171         return G_OBJECT(conf);
 172 }
 173
 174
 175 gchar*
 176 modest_conf_get_string (ModestConf* self, const gchar* key, GError **err)
 177 {
 178         ModestConfPrivate *priv;
 179
 180         g_return_val_if_fail (self, NULL);
 181         g_return_val_if_fail (key,  NULL);
 182
 183         priv = MODEST_CONF_GET_PRIVATE(self);
 184         return gconf_client_get_string (priv->gconf_client, key, err);
 185 }
 186
 187
 188 gint
 189 modest_conf_get_int (ModestConf* self, const gchar* key, GError **err)
 190 {
 191         ModestConfPrivate *priv;
 192
 193         g_return_val_if_fail (self, -1);
 194         g_return_val_if_fail (key, -1);
 195
 196         priv = MODEST_CONF_GET_PRIVATE(self);
 197
 198         return gconf_client_get_int (priv->gconf_client, key, err);
 199 }
 200
 201
 202 gboolean
 203 modest_conf_get_bool (ModestConf* self, const gchar* key, GError **err)
 204 {
 205         ModestConfPrivate *priv;
 206
 207         g_return_val_if_fail (self, FALSE);
 208         g_return_val_if_fail (key, FALSE);
 209
 210         priv = MODEST_CONF_GET_PRIVATE(self);
 211
 212         return gconf_client_get_bool (priv->gconf_client, key, err);
 213 }
 214
 215
 216 gboolean
 217 modest_conf_set_string (ModestConf* self, const gchar* key, const gchar* val,
 218                         GError **err)
 219 {
 220         ModestConfPrivate *priv;
 221
 222         g_return_val_if_fail (self,FALSE);
 223         g_return_val_if_fail (key, FALSE);
 224
 225         priv = MODEST_CONF_GET_PRIVATE(self);
 226
 227         if (!gconf_client_key_is_writable(priv->gconf_client,key,err)) {
 228                 g_printerr ("modest: '%s' is not writable\n", key);
 229                 return FALSE;
 230         }
 231
 232         return gconf_client_set_string (priv->gconf_client, key, val, err);
 233 }
 234
 235
 236 gboolean
 237 modest_conf_set_int  (ModestConf* self, const gchar* key, gint val,
 238                       GError **err)
 239 {
 240         ModestConfPrivate *priv;
 241
 242         g_return_val_if_fail (self,FALSE);
 243         g_return_val_if_fail (key, FALSE);
 244
 245         priv = MODEST_CONF_GET_PRIVATE(self);
 246
 247         if (!gconf_client_key_is_writable(priv->gconf_client,key,err)) {
 248                 g_printerr ("modest: '%s' is not writable\n", key);
 249                 return FALSE;
 250         }
 251
 252         return gconf_client_set_int (priv->gconf_client, key, val, err);
 253 }
 254
 255
 256 gboolean
 257 modest_conf_set_bool (ModestConf* self, const gchar* key, gboolean val,
 258                       GError **err)
 259 {
 260         ModestConfPrivate *priv;
 261
 262         g_return_val_if_fail (self,FALSE);
 263         g_return_val_if_fail (key, FALSE);
 264
 265         priv = MODEST_CONF_GET_PRIVATE(self);
 266
 267         if (!gconf_client_key_is_writable(priv->gconf_client,key, err)) {
 268                 g_warning ("modest: '%s' is not writable\n", key);
 269                 return FALSE;
 270         }
 271
 272         return gconf_client_set_bool (priv->gconf_client,key,val, err);
 273 }
 274
 275
 276
 277
 278 GSList*
 279 modest_conf_list_subkeys (ModestConf* self, const gchar* key, GError **err)
 280 {
 281         ModestConfPrivate *priv;
 282
 283         g_return_val_if_fail (self,FALSE);
 284         g_return_val_if_fail (key, FALSE);
 285
 286         priv = MODEST_CONF_GET_PRIVATE(self);
 287
 288         return gconf_client_all_dirs (priv->gconf_client,key,err);
 289 }
 290
 291
 292 gboolean
 293 modest_conf_remove_key (ModestConf* self, const gchar* key, GError **err)
 294 {
 295         ModestConfPrivate *priv;
 296
 297         g_return_val_if_fail (self,FALSE);
 298         g_return_val_if_fail (key, FALSE);
 299
 300         priv = MODEST_CONF_GET_PRIVATE(self);
 301
 302         return gconf_client_recursive_unset (priv->gconf_client,key,0,err);
 303 }
 304
 305
 306
 307
 308 gboolean
 309 modest_conf_key_exists (ModestConf* self, const gchar* key, GError **err)
 310 {
 311         ModestConfPrivate *priv;
 312
 313         g_return_val_if_fail (self,FALSE);
 314         g_return_val_if_fail (key, FALSE);
 315
 316         priv = MODEST_CONF_GET_PRIVATE(self);
 317
 318         return gconf_client_dir_exists (priv->gconf_client,key,err);
 319 }
 320
 321
 322 gchar*
 323 modest_conf_key_escape (ModestConf *self, const gchar* key)
 324 {
 325         g_return_val_if_fail (key, NULL);
 326
 327         return gconf_escape_key (key, strlen(key));
 328 }
 329
 330
 331 gchar*
 332 modest_conf_key_unescape (ModestConf *self, const gchar* key)
 333 {
 334         g_return_val_if_fail (key, NULL);
 335
 336         return gconf_unescape_key (key, strlen(key));
 337 }
 338
 339
 340
 341 static void
 342 modest_conf_on_change (GConfClient *client, guint conn_id, GConfEntry *entry,
 343                        gpointer data)
 344 {
 345         ModestConfEvent event;
 346         const gchar* key;
 347
 348         event = (entry->value) ? MODEST_CONF_EVENT_KEY_CHANGED : MODEST_CONF_EVENT_KEY_UNSET;
 349         key    = gconf_entry_get_key (entry);
 350
 351         g_signal_emit (G_OBJECT(data),
 352                        signals[KEY_CHANGED_SIGNAL], 0,
 353                        key, event);
 354 }