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>
33 #include <glib/gi18n.h>
34 #include "modest-conf.h"
35 #include "modest-marshal.h"
38 static void modest_conf_class_init (ModestConfClass *klass);
39 static void modest_conf_init (ModestConf *obj);
40 static void modest_conf_finalize (GObject *obj);
41 static void modest_conf_on_change (GConfClient *client, guint conn_id,
42 GConfEntry *entry, gpointer data);
43 static GConfValueType modest_conf_type_to_gconf_type (ModestConfValueType value_type,
48 modest_conf_maemo_fake_on_change (ModestConf *conf, const gchar* key, ModestConfEvent event);
55 static guint signals[LAST_SIGNAL] = {0};
58 typedef struct _ModestConfPrivate ModestConfPrivate;
59 struct _ModestConfPrivate {
60 GConfClient *gconf_client;
62 #define MODEST_CONF_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
66 static GObjectClass *parent_class = NULL;
69 modest_conf_get_type (void)
71 static GType my_type = 0;
73 static const GTypeInfo my_info = {
74 sizeof(ModestConfClass),
76 NULL, /* base finalize */
77 (GClassInitFunc) modest_conf_class_init,
78 NULL, /* class finalize */
79 NULL, /* class data */
82 (GInstanceInitFunc) modest_conf_init,
85 my_type = g_type_register_static (G_TYPE_OBJECT,
93 modest_conf_class_init (ModestConfClass *klass)
95 GObjectClass *gobject_class;
96 gobject_class = (GObjectClass*) klass;
98 parent_class = g_type_class_peek_parent (klass);
99 gobject_class->finalize = modest_conf_finalize;
101 g_type_class_add_private (gobject_class, sizeof(ModestConfPrivate));
103 signals[KEY_CHANGED_SIGNAL] =
104 g_signal_new ("key_changed",
105 G_TYPE_FROM_CLASS (gobject_class),
107 G_STRUCT_OFFSET (ModestConfClass,key_changed),
109 modest_marshal_VOID__STRING_INT,
110 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_INT);
114 modest_conf_init (ModestConf *obj)
116 GConfClient *conf = NULL;
117 ModestConfPrivate *priv = MODEST_CONF_GET_PRIVATE(obj);
121 priv->gconf_client = NULL;
123 conf = gconf_client_get_default ();
125 g_printerr ("modest: could not get gconf client\n");
128 gconf_client_add_dir (conf,MODEST_CONF_NAMESPACE,
129 GCONF_CLIENT_PRELOAD_NONE,
132 g_printerr ("modest: error %d with gconf_client_add_dir: '%s'\n",
133 err->code, err->message);
134 g_object_unref (conf);
139 gconf_client_notify_add (conf, MODEST_CONF_NAMESPACE,
140 modest_conf_on_change,
143 g_printerr ("modest: gconf_client_notify_add error %d: '%s'\n",
144 err->code, err->message);
145 g_object_unref (conf);
149 priv->gconf_client = conf; /* all went well! */
153 modest_conf_finalize (GObject *obj)
155 ModestConfPrivate *priv = MODEST_CONF_GET_PRIVATE(obj);
156 if (priv->gconf_client) {
158 gconf_client_suggest_sync (priv->gconf_client, NULL);
160 g_object_unref (priv->gconf_client);
161 priv->gconf_client = NULL;
164 G_OBJECT_CLASS(parent_class)->finalize (obj);
168 modest_conf_new (void)
171 ModestConfPrivate *priv;
173 conf = MODEST_CONF(g_object_new(MODEST_TYPE_CONF, NULL));
175 g_printerr ("modest: failed to init ModestConf (GConf)\n");
179 priv = MODEST_CONF_GET_PRIVATE(conf);
180 if (!priv->gconf_client) {
181 g_printerr ("modest: failed to init gconf\n");
182 g_object_unref (conf);
191 modest_conf_get_string (ModestConf* self, const gchar* key, GError **err)
193 ModestConfPrivate *priv;
195 g_return_val_if_fail (self, NULL);
196 g_return_val_if_fail (key, NULL);
198 priv = MODEST_CONF_GET_PRIVATE(self);
199 return gconf_client_get_string (priv->gconf_client, key, err);
204 modest_conf_get_int (ModestConf* self, const gchar* key, GError **err)
206 ModestConfPrivate *priv;
208 g_return_val_if_fail (self, -1);
209 g_return_val_if_fail (key, -1);
211 priv = MODEST_CONF_GET_PRIVATE(self);
213 return gconf_client_get_int (priv->gconf_client, key, err);
218 modest_conf_get_bool (ModestConf* self, const gchar* key, GError **err)
220 ModestConfPrivate *priv;
222 g_return_val_if_fail (self, FALSE);
223 g_return_val_if_fail (key, FALSE);
225 priv = MODEST_CONF_GET_PRIVATE(self);
227 return gconf_client_get_bool (priv->gconf_client, key, err);
232 modest_conf_get_list (ModestConf* self, const gchar* key, ModestConfValueType list_type,
235 ModestConfPrivate *priv;
236 GConfValueType gconf_type;
238 g_return_val_if_fail (self, NULL);
239 g_return_val_if_fail (key, NULL);
241 priv = MODEST_CONF_GET_PRIVATE(self);
243 gconf_type = modest_conf_type_to_gconf_type (list_type, err);
245 return gconf_client_get_list (priv->gconf_client, key, gconf_type, err);
252 modest_conf_set_string (ModestConf* self, const gchar* key, const gchar* val,
255 ModestConfPrivate *priv;
257 g_return_val_if_fail (self,FALSE);
258 g_return_val_if_fail (key, FALSE);
259 g_return_val_if_fail (val, FALSE);
261 priv = MODEST_CONF_GET_PRIVATE(self);
263 if (!gconf_client_key_is_writable(priv->gconf_client,key,err)) {
264 g_printerr ("modest: '%s' is not writable\n", key);
268 if (gconf_client_set_string (priv->gconf_client, key, val, err)) {
269 modest_conf_maemo_fake_on_change (self, key, MODEST_CONF_EVENT_KEY_CHANGED);
277 modest_conf_set_int (ModestConf* self, const gchar* key, gint val,
280 ModestConfPrivate *priv;
282 g_return_val_if_fail (self,FALSE);
283 g_return_val_if_fail (key, FALSE);
285 priv = MODEST_CONF_GET_PRIVATE(self);
287 if (!gconf_client_key_is_writable(priv->gconf_client,key,err)) {
288 g_printerr ("modest: '%s' is not writable\n", key);
292 if (gconf_client_set_int (priv->gconf_client, key, val, err)) {
293 modest_conf_maemo_fake_on_change (self, key, MODEST_CONF_EVENT_KEY_CHANGED);
301 modest_conf_set_bool (ModestConf* self, const gchar* key, gboolean val,
304 ModestConfPrivate *priv;
306 g_return_val_if_fail (self,FALSE);
307 g_return_val_if_fail (key, FALSE);
309 priv = MODEST_CONF_GET_PRIVATE(self);
311 if (!gconf_client_key_is_writable(priv->gconf_client,key, err)) {
312 g_warning ("modest: '%s' is not writable\n", key);
316 if (gconf_client_set_bool (priv->gconf_client, key, val, err)) {
317 modest_conf_maemo_fake_on_change (self, key, MODEST_CONF_EVENT_KEY_CHANGED);
325 modest_conf_set_list (ModestConf* self, const gchar* key,
326 GSList *val, ModestConfValueType list_type,
329 ModestConfPrivate *priv;
330 GConfValueType gconf_type;
333 g_return_val_if_fail (self, FALSE);
334 g_return_val_if_fail (key, FALSE);
336 priv = MODEST_CONF_GET_PRIVATE(self);
338 gconf_type = modest_conf_type_to_gconf_type (list_type, err);
342 result = gconf_client_set_list (priv->gconf_client, key, gconf_type, val, err);
344 g_warning("gconf_client_set_list() failed with key=%s. error=%s", key,
349 /* TODO: Remove this, when we fix the problem: */
350 /* This shows that sometimes set_list fails, while saying that it succeeded: */
352 const gint debug_list_length_start = g_slist_length(val);
353 GSList* debug_list = gconf_client_get_list(priv->gconf_client, key, gconf_type, err);
354 const gint debug_list_length_after = g_slist_length(debug_list);
356 if(debug_list_length_start != debug_list_length_after)
357 g_warning("modest_conf_set_list(): The list length after setting is "
358 "not the same as the specified list. key=%s. "
359 "We think that we fixed this, so tell us if you see this.", key);
360 g_slist_free(debug_list);
364 modest_conf_maemo_fake_on_change (self, key, MODEST_CONF_EVENT_KEY_CHANGED);
371 modest_conf_list_subkeys (ModestConf* self, const gchar* key, GError **err)
373 ModestConfPrivate *priv;
375 g_return_val_if_fail (self,FALSE);
376 g_return_val_if_fail (key, FALSE);
378 priv = MODEST_CONF_GET_PRIVATE(self);
380 return gconf_client_all_dirs (priv->gconf_client,key,err);
385 modest_conf_remove_key (ModestConf* self, const gchar* key, GError **err)
387 ModestConfPrivate *priv;
390 g_return_val_if_fail (self,FALSE);
391 g_return_val_if_fail (key, FALSE);
393 priv = MODEST_CONF_GET_PRIVATE(self);
395 retval = gconf_client_recursive_unset (priv->gconf_client,key,0,err);
396 gconf_client_suggest_sync (priv->gconf_client, NULL);
399 modest_conf_maemo_fake_on_change (self, key, MODEST_CONF_EVENT_KEY_UNSET);
407 modest_conf_key_exists (ModestConf* self, const gchar* key, GError **err)
409 ModestConfPrivate *priv;
412 g_return_val_if_fail (self,FALSE);
413 g_return_val_if_fail (key, FALSE);
415 priv = MODEST_CONF_GET_PRIVATE(self);
417 /* the fast way... */
418 if (gconf_client_dir_exists (priv->gconf_client,key,err))
421 val = gconf_client_get (priv->gconf_client, key, NULL);
425 gconf_value_free (val);
432 modest_conf_key_escape (const gchar* key)
434 g_return_val_if_fail (key, NULL);
435 g_return_val_if_fail (strlen (key) > 0, g_strdup (key));
437 return gconf_escape_key (key, strlen(key));
442 modest_conf_key_unescape (const gchar* key)
444 g_return_val_if_fail (key, NULL);
446 return gconf_unescape_key (key, strlen(key));
450 modest_conf_key_is_valid (const gchar* key)
452 return gconf_valid_key (key, NULL);
455 /* hmmm... might need to make specific callback for specific keys */
457 modest_conf_on_change (GConfClient *client, guint conn_id, GConfEntry *entry,
460 ModestConfEvent event;
463 event = (entry->value) ? MODEST_CONF_EVENT_KEY_CHANGED : MODEST_CONF_EVENT_KEY_UNSET;
464 key = gconf_entry_get_key (entry);
466 g_signal_emit (G_OBJECT(data),
467 signals[KEY_CHANGED_SIGNAL], 0,
472 static GConfValueType
473 modest_conf_type_to_gconf_type (ModestConfValueType value_type, GError **err)
475 GConfValueType gconf_type;
477 switch (value_type) {
478 case MODEST_CONF_VALUE_INT:
479 gconf_type = GCONF_VALUE_INT;
481 case MODEST_CONF_VALUE_BOOL:
482 gconf_type = GCONF_VALUE_BOOL;
484 case MODEST_CONF_VALUE_FLOAT:
485 gconf_type = GCONF_VALUE_FLOAT;
487 case MODEST_CONF_VALUE_STRING:
488 gconf_type = GCONF_VALUE_STRING;
491 /* FIXME: use MODEST_ERROR, and error code */
492 gconf_type = GCONF_VALUE_INVALID;
493 g_printerr ("modest: invalid list value type %d\n", value_type);
494 *err = g_error_new_literal (0, 0, "invalid list value type");
501 ////////////////////////////////////////////////////////////////////////////////
502 /* workaround for the b0rked dbus-gconf on maemo */
503 /* fires a fake change notification after 0.3 secs.
504 * Might not be necessary anymore. */
506 #ifdef MODEST_PLATFORM_MAEMO
513 change_helper_new (ModestConf *conf, const gchar *key)
515 ChangeHelper *helper = g_slice_alloc (sizeof(ChangeHelper));
516 helper->obj = g_object_ref(G_OBJECT(conf));
517 helper->key = g_strdup (key);
522 change_helper_free (ChangeHelper *helper)
524 g_object_unref (helper->obj);
525 g_free (helper->key);
528 g_slice_free (ChangeHelper,helper);
532 emit_change_cb (ChangeHelper *helper)
536 g_signal_emit (G_OBJECT(helper->obj),signals[KEY_CHANGED_SIGNAL], 0,
537 helper->key, MODEST_CONF_EVENT_KEY_CHANGED);
538 change_helper_free (helper);
544 emit_remove_cb (ChangeHelper *helper)
548 g_signal_emit (G_OBJECT(helper->obj),signals[KEY_CHANGED_SIGNAL], 0,
549 helper->key, MODEST_CONF_EVENT_KEY_UNSET);
550 change_helper_free (helper);
554 #endif /* MODEST_PLATFORM_MAEMO */
558 modest_conf_maemo_fake_on_change (ModestConf *conf, const gchar* key, ModestConfEvent event)
560 /* hack for faster notification, might not be necessary anymore: */
562 #ifdef MODEST_PLATFORM_MAEMO
564 ChangeHelper *helper = change_helper_new (conf,key);
565 g_timeout_add (100, /* after 100 ms */
566 (event == MODEST_CONF_EVENT_KEY_CHANGED)
567 ? (GSourceFunc)emit_change_cb : (GSourceFunc)emit_remove_cb,
569 #endif /* MODEST_PLATFORM_MAEMO */
572 //////////////////////////////////////////////////////////////////////////////////