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;
157 modest_conf_new (void)
160 ModestConfPrivate *priv;
162 conf = MODEST_CONF(g_object_new(MODEST_TYPE_CONF, NULL));
164 g_printerr ("modest: failed to init ModestConf (GConf)\n");
168 priv = MODEST_CONF_GET_PRIVATE(conf);
169 if (!priv->gconf_client) {
170 g_printerr ("modest: failed to init gconf\n");
171 g_object_unref (conf);
180 modest_conf_get_string (ModestConf* self, const gchar* key, GError **err)
182 ModestConfPrivate *priv;
184 g_return_val_if_fail (self, NULL);
185 g_return_val_if_fail (key, NULL);
187 priv = MODEST_CONF_GET_PRIVATE(self);
188 return gconf_client_get_string (priv->gconf_client, key, err);
193 modest_conf_get_int (ModestConf* self, const gchar* key, GError **err)
195 ModestConfPrivate *priv;
197 g_return_val_if_fail (self, -1);
198 g_return_val_if_fail (key, -1);
200 priv = MODEST_CONF_GET_PRIVATE(self);
202 return gconf_client_get_int (priv->gconf_client, key, err);
207 modest_conf_get_bool (ModestConf* self, const gchar* key, GError **err)
209 ModestConfPrivate *priv;
211 g_return_val_if_fail (self, FALSE);
212 g_return_val_if_fail (key, FALSE);
214 priv = MODEST_CONF_GET_PRIVATE(self);
216 return gconf_client_get_bool (priv->gconf_client, key, err);
222 modest_conf_get_string_or_default (ModestConf* self, const gchar* key,
223 const gchar *defaultval)
225 ModestConfPrivate *priv;
229 g_return_val_if_fail (self, g_strdup(defaultval));
230 g_return_val_if_fail (key, g_strdup(defaultval));
232 priv = MODEST_CONF_GET_PRIVATE(self);
233 val = gconf_client_get (priv->gconf_client, key, NULL);
238 str = gconf_value_get_string (val);
239 gconf_value_free (val);
242 return g_strdup (str);
247 modest_conf_get_int_or_default (ModestConf* self, const gchar* key,
250 ModestConfPrivate *priv;
254 g_return_val_if_fail (self, defaultval);
255 g_return_val_if_fail (key, defaultval);
257 priv = MODEST_CONF_GET_PRIVATE(self);
258 val = gconf_client_get (priv->gconf_client, key, NULL);
263 retval = gconf_value_get_int (val);
264 gconf_value_free (val);
274 modest_conf_set_string (ModestConf* self, const gchar* key, const gchar* val,
277 ModestConfPrivate *priv;
279 g_return_val_if_fail (self,FALSE);
280 g_return_val_if_fail (key, FALSE);
282 priv = MODEST_CONF_GET_PRIVATE(self);
284 if (!gconf_client_key_is_writable(priv->gconf_client,key,err)) {
285 g_printerr ("modest: '%s' is not writable\n", key);
289 return gconf_client_set_string (priv->gconf_client, key, val, err);
294 modest_conf_set_int (ModestConf* self, const gchar* key, gint val,
297 ModestConfPrivate *priv;
299 g_return_val_if_fail (self,FALSE);
300 g_return_val_if_fail (key, FALSE);
302 priv = MODEST_CONF_GET_PRIVATE(self);
304 if (!gconf_client_key_is_writable(priv->gconf_client,key,err)) {
305 g_printerr ("modest: '%s' is not writable\n", key);
309 return gconf_client_set_int (priv->gconf_client, key, val, err);
314 modest_conf_set_bool (ModestConf* self, const gchar* key, gboolean val,
317 ModestConfPrivate *priv;
319 g_return_val_if_fail (self,FALSE);
320 g_return_val_if_fail (key, FALSE);
322 priv = MODEST_CONF_GET_PRIVATE(self);
324 if (!gconf_client_key_is_writable(priv->gconf_client,key, err)) {
325 g_warning ("modest: '%s' is not writable\n", key);
329 return gconf_client_set_bool (priv->gconf_client,key,val, err);
336 modest_conf_list_subkeys (ModestConf* self, const gchar* key, GError **err)
338 ModestConfPrivate *priv;
340 g_return_val_if_fail (self,FALSE);
341 g_return_val_if_fail (key, FALSE);
343 priv = MODEST_CONF_GET_PRIVATE(self);
345 return gconf_client_all_dirs (priv->gconf_client,key,err);
350 modest_conf_remove_key (ModestConf* self, const gchar* key, GError **err)
352 ModestConfPrivate *priv;
354 g_return_val_if_fail (self,FALSE);
355 g_return_val_if_fail (key, FALSE);
357 priv = MODEST_CONF_GET_PRIVATE(self);
359 return gconf_client_recursive_unset (priv->gconf_client,key,0,err);
364 modest_conf_key_exists (ModestConf* self, const gchar* key, GError **err)
366 ModestConfPrivate *priv;
369 g_return_val_if_fail (self,FALSE);
370 g_return_val_if_fail (key, FALSE);
372 priv = MODEST_CONF_GET_PRIVATE(self);
374 /* the fast way... */
375 if (gconf_client_dir_exists (priv->gconf_client,key,err))
378 val = gconf_client_get (priv->gconf_client, key, NULL);
382 gconf_value_free (val);
389 modest_conf_key_escape (ModestConf *self, const gchar* key)
391 g_return_val_if_fail (key, NULL);
393 return gconf_escape_key (key, strlen(key));
398 modest_conf_key_unescape (ModestConf *self, const gchar* key)
400 g_return_val_if_fail (key, NULL);
402 return gconf_unescape_key (key, strlen(key));
408 modest_conf_on_change (GConfClient *client, guint conn_id, GConfEntry *entry,
411 ModestConfEvent event;
414 event = (entry->value) ? MODEST_CONF_EVENT_KEY_CHANGED : MODEST_CONF_EVENT_KEY_UNSET;
415 key = gconf_entry_get_key (entry);
417 g_signal_emit (G_OBJECT(data),
418 signals[KEY_CHANGED_SIGNAL], 0,