1 /* Copyright (c) 2006, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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.
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.
30 #include <gconf/gconf-client.h>
32 #include "modest-conf.h"
33 #include "modest-marshal.h"
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);
45 static guint signals[LAST_SIGNAL] = {0};
48 typedef struct _ModestConfPrivate ModestConfPrivate;
49 struct _ModestConfPrivate {
50 GConfClient *gconf_client;
52 #define MODEST_CONF_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
56 static GObjectClass *parent_class = NULL;
59 modest_conf_get_type (void)
61 static GType my_type = 0;
63 static const GTypeInfo my_info = {
64 sizeof(ModestConfClass),
66 NULL, /* base finalize */
67 (GClassInitFunc) modest_conf_class_init,
68 NULL, /* class finalize */
69 NULL, /* class data */
72 (GInstanceInitFunc) modest_conf_init,
75 my_type = g_type_register_static (G_TYPE_OBJECT,
83 modest_conf_class_init (ModestConfClass *klass)
85 GObjectClass *gobject_class;
86 gobject_class = (GObjectClass*) klass;
88 parent_class = g_type_class_peek_parent (klass);
89 gobject_class->finalize = modest_conf_finalize;
91 g_type_class_add_private (gobject_class, sizeof(ModestConfPrivate));
93 signals[KEY_CHANGED_SIGNAL] =
94 g_signal_new ("key_changed",
95 G_TYPE_FROM_CLASS (gobject_class),
97 G_STRUCT_OFFSET (ModestConfClass,key_changed),
99 modest_marshal_VOID__STRING_INT,
100 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_INT);
104 modest_conf_init (ModestConf *obj)
106 GConfClient *conf = NULL;
107 ModestConfPrivate *priv = MODEST_CONF_GET_PRIVATE(obj);
110 priv->gconf_client = NULL;
112 conf = gconf_client_get_default ();
114 g_printerr ("modest: could not get gconf client\n");
118 gconf_client_add_dir (conf,MODEST_CONF_NAMESPACE,
119 GCONF_CLIENT_PRELOAD_NONE,
122 g_printerr ("modest: error %d with gconf_client_add_dir: '%s'\n",
123 err->code, err->message);
124 g_object_unref (conf);
129 gconf_client_notify_add (conf, MODEST_CONF_NAMESPACE,
130 modest_conf_on_change,
133 g_printerr ("modest: gconf_client_notify_add error %d: '%s'\n",
134 err->code, err->message);
135 g_object_unref (conf);
140 priv->gconf_client = conf; /* all went well! */
144 modest_conf_finalize (GObject *obj)
146 ModestConfPrivate *priv = MODEST_CONF_GET_PRIVATE(obj);
147 if (priv->gconf_client) {
149 gconf_client_suggest_sync (priv->gconf_client, NULL);
151 g_object_unref (priv->gconf_client);
152 priv->gconf_client = NULL;
155 G_OBJECT_CLASS(parent_class)->finalize (obj);
159 modest_conf_new (void)
162 ModestConfPrivate *priv;
164 conf = MODEST_CONF(g_object_new(MODEST_TYPE_CONF, NULL));
166 g_printerr ("modest: failed to init ModestConf (GConf)\n");
170 priv = MODEST_CONF_GET_PRIVATE(conf);
171 if (!priv->gconf_client) {
172 g_printerr ("modest: failed to init gconf\n");
173 g_object_unref (conf);
182 modest_conf_get_string (ModestConf* self, const gchar* key, GError **err)
184 ModestConfPrivate *priv;
186 g_return_val_if_fail (self, NULL);
187 g_return_val_if_fail (key, NULL);
189 priv = MODEST_CONF_GET_PRIVATE(self);
190 return gconf_client_get_string (priv->gconf_client, key, err);
195 modest_conf_get_int (ModestConf* self, const gchar* key, GError **err)
197 ModestConfPrivate *priv;
199 g_return_val_if_fail (self, -1);
200 g_return_val_if_fail (key, -1);
202 priv = MODEST_CONF_GET_PRIVATE(self);
204 return gconf_client_get_int (priv->gconf_client, key, err);
209 modest_conf_get_bool (ModestConf* self, const gchar* key, GError **err)
211 ModestConfPrivate *priv;
213 g_return_val_if_fail (self, FALSE);
214 g_return_val_if_fail (key, FALSE);
216 priv = MODEST_CONF_GET_PRIVATE(self);
218 return gconf_client_get_bool (priv->gconf_client, key, err);
224 modest_conf_get_string_or_default (ModestConf* self, const gchar* key,
225 const gchar *defaultval)
227 ModestConfPrivate *priv;
231 g_return_val_if_fail (self, g_strdup(defaultval));
232 g_return_val_if_fail (key, g_strdup(defaultval));
234 priv = MODEST_CONF_GET_PRIVATE(self);
235 val = gconf_client_get (priv->gconf_client, key, NULL);
240 str = gconf_value_get_string (val);
241 gconf_value_free (val);
244 return g_strdup (str);
249 modest_conf_get_int_or_default (ModestConf* self, const gchar* key,
252 ModestConfPrivate *priv;
256 g_return_val_if_fail (self, defaultval);
257 g_return_val_if_fail (key, defaultval);
259 priv = MODEST_CONF_GET_PRIVATE(self);
260 val = gconf_client_get (priv->gconf_client, key, NULL);
265 retval = gconf_value_get_int (val);
266 gconf_value_free (val);
276 modest_conf_set_string (ModestConf* self, const gchar* key, const gchar* val,
279 ModestConfPrivate *priv;
281 g_return_val_if_fail (self,FALSE);
282 g_return_val_if_fail (key, FALSE);
284 priv = MODEST_CONF_GET_PRIVATE(self);
286 if (!gconf_client_key_is_writable(priv->gconf_client,key,err)) {
287 g_printerr ("modest: '%s' is not writable\n", key);
291 return gconf_client_set_string (priv->gconf_client, key, val, err);
296 modest_conf_set_int (ModestConf* self, const gchar* key, gint val,
299 ModestConfPrivate *priv;
301 g_return_val_if_fail (self,FALSE);
302 g_return_val_if_fail (key, FALSE);
304 priv = MODEST_CONF_GET_PRIVATE(self);
306 if (!gconf_client_key_is_writable(priv->gconf_client,key,err)) {
307 g_printerr ("modest: '%s' is not writable\n", key);
311 return gconf_client_set_int (priv->gconf_client, key, val, err);
316 modest_conf_set_bool (ModestConf* self, const gchar* key, gboolean val,
319 ModestConfPrivate *priv;
321 g_return_val_if_fail (self,FALSE);
322 g_return_val_if_fail (key, FALSE);
324 priv = MODEST_CONF_GET_PRIVATE(self);
326 if (!gconf_client_key_is_writable(priv->gconf_client,key, err)) {
327 g_warning ("modest: '%s' is not writable\n", key);
331 return gconf_client_set_bool (priv->gconf_client,key,val, err);
338 modest_conf_list_subkeys (ModestConf* self, const gchar* key, GError **err)
340 ModestConfPrivate *priv;
342 g_return_val_if_fail (self,FALSE);
343 g_return_val_if_fail (key, FALSE);
345 priv = MODEST_CONF_GET_PRIVATE(self);
347 return gconf_client_all_dirs (priv->gconf_client,key,err);
352 modest_conf_remove_key (ModestConf* self, const gchar* key, GError **err)
354 ModestConfPrivate *priv;
356 g_return_val_if_fail (self,FALSE);
357 g_return_val_if_fail (key, FALSE);
359 priv = MODEST_CONF_GET_PRIVATE(self);
361 return gconf_client_recursive_unset (priv->gconf_client,key,0,err);
366 modest_conf_key_exists (ModestConf* self, const gchar* key, GError **err)
368 ModestConfPrivate *priv;
371 g_return_val_if_fail (self,FALSE);
372 g_return_val_if_fail (key, FALSE);
374 priv = MODEST_CONF_GET_PRIVATE(self);
376 /* the fast way... */
377 if (gconf_client_dir_exists (priv->gconf_client,key,err))
380 val = gconf_client_get (priv->gconf_client, key, NULL);
384 gconf_value_free (val);
391 modest_conf_key_escape (ModestConf *self, const gchar* key)
393 g_return_val_if_fail (key, NULL);
395 return gconf_escape_key (key, strlen(key));
400 modest_conf_key_unescape (ModestConf *self, const gchar* key)
402 g_return_val_if_fail (key, NULL);
404 return gconf_unescape_key (key, strlen(key));
410 modest_conf_on_change (GConfClient *client, guint conn_id, GConfEntry *entry,
413 ModestConfEvent event;
416 event = (entry->value) ? MODEST_CONF_EVENT_KEY_CHANGED : MODEST_CONF_EVENT_KEY_UNSET;
417 key = gconf_entry_get_key (entry);
419 g_signal_emit (G_OBJECT(data),
420 signals[KEY_CHANGED_SIGNAL], 0,
425 modest_conf_get_list (ModestConf* self, const gchar* key, ModestConfValueType list_type, GError **err)
427 ModestConfPrivate *priv;
428 GConfValueType gconf_type;
430 g_return_val_if_fail (self, NULL);
431 g_return_val_if_fail (key, NULL);
433 priv = MODEST_CONF_GET_PRIVATE(self);
436 case MODEST_CONF_VALUE_INT:
437 gconf_type = GCONF_VALUE_INT;
439 case MODEST_CONF_VALUE_BOOL:
440 gconf_type = GCONF_VALUE_BOOL;
442 case MODEST_CONF_VALUE_FLOAT:
443 gconf_type = GCONF_VALUE_FLOAT;
445 case MODEST_CONF_VALUE_STRING:
446 gconf_type = GCONF_VALUE_STRING;
452 return gconf_client_get_list (priv->gconf_client, key, gconf_type, err);