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);
40 static void modest_conf_init (ModestConf *obj);
42 static void modest_conf_finalize (GObject *obj);
44 static void modest_conf_on_change (GConfClient *client, guint conn_id,
45 GConfEntry *entry, gpointer data);
47 static GConfValueType modest_conf_type_to_gconf_type (ModestConfValueType value_type,
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_INT,
110 G_TYPE_NONE, 3, G_TYPE_STRING, G_TYPE_INT, G_TYPE_INT);
114 modest_conf_init (ModestConf *obj)
116 GConfClient *conf = NULL;
117 ModestConfPrivate *priv = MODEST_CONF_GET_PRIVATE(obj);
120 priv->gconf_client = NULL;
122 conf = gconf_client_get_default ();
124 g_printerr ("modest: could not get gconf client\n");
128 priv->gconf_client = conf; /* all went well! */
132 modest_conf_finalize (GObject *obj)
134 ModestConfPrivate *priv = MODEST_CONF_GET_PRIVATE(obj);
135 if (priv->gconf_client) {
137 gconf_client_suggest_sync (priv->gconf_client, NULL);
139 g_object_unref (priv->gconf_client);
140 priv->gconf_client = NULL;
143 G_OBJECT_CLASS(parent_class)->finalize (obj);
147 modest_conf_new (void)
150 ModestConfPrivate *priv;
152 conf = MODEST_CONF(g_object_new(MODEST_TYPE_CONF, NULL));
154 g_printerr ("modest: failed to init ModestConf (GConf)\n");
158 priv = MODEST_CONF_GET_PRIVATE(conf);
159 if (!priv->gconf_client) {
160 g_printerr ("modest: failed to init gconf\n");
161 g_object_unref (conf);
170 modest_conf_get_string (ModestConf* self, const gchar* key, GError **err)
172 ModestConfPrivate *priv;
174 g_return_val_if_fail (self, NULL);
175 g_return_val_if_fail (key, NULL);
177 priv = MODEST_CONF_GET_PRIVATE(self);
178 return gconf_client_get_string (priv->gconf_client, key, err);
183 modest_conf_get_int (ModestConf* self, const gchar* key, GError **err)
185 ModestConfPrivate *priv;
187 g_return_val_if_fail (self, -1);
188 g_return_val_if_fail (key, -1);
190 priv = MODEST_CONF_GET_PRIVATE(self);
192 return gconf_client_get_int (priv->gconf_client, key, err);
197 modest_conf_get_bool (ModestConf* self, const gchar* key, GError **err)
199 ModestConfPrivate *priv;
201 g_return_val_if_fail (self, FALSE);
202 g_return_val_if_fail (key, FALSE);
204 priv = MODEST_CONF_GET_PRIVATE(self);
206 return gconf_client_get_bool (priv->gconf_client, key, err);
211 modest_conf_get_list (ModestConf* self, const gchar* key, ModestConfValueType list_type,
214 ModestConfPrivate *priv;
215 GConfValueType gconf_type;
217 g_return_val_if_fail (self, NULL);
218 g_return_val_if_fail (key, NULL);
220 priv = MODEST_CONF_GET_PRIVATE(self);
222 gconf_type = modest_conf_type_to_gconf_type (list_type, err);
224 return gconf_client_get_list (priv->gconf_client, key, gconf_type, err);
231 modest_conf_set_string (ModestConf* self, const gchar* key, const gchar* val,
234 ModestConfPrivate *priv;
236 g_return_val_if_fail (self,FALSE);
237 g_return_val_if_fail (key, FALSE);
238 g_return_val_if_fail (val, FALSE);
240 priv = MODEST_CONF_GET_PRIVATE(self);
242 if (!gconf_client_key_is_writable(priv->gconf_client,key,err)) {
243 g_printerr ("modest: '%s' is not writable\n", key);
247 return gconf_client_set_string (priv->gconf_client, key, val, err);
251 modest_conf_set_int (ModestConf* self, const gchar* key, gint val,
254 ModestConfPrivate *priv;
256 g_return_val_if_fail (self,FALSE);
257 g_return_val_if_fail (key, FALSE);
259 priv = MODEST_CONF_GET_PRIVATE(self);
261 if (!gconf_client_key_is_writable(priv->gconf_client,key,err)) {
262 g_printerr ("modest: '%s' is not writable\n", key);
266 return gconf_client_set_int (priv->gconf_client, key, val, err);
271 modest_conf_set_bool (ModestConf* self, const gchar* key, gboolean val,
274 ModestConfPrivate *priv;
276 g_return_val_if_fail (self,FALSE);
277 g_return_val_if_fail (key, FALSE);
279 priv = MODEST_CONF_GET_PRIVATE(self);
281 if (!gconf_client_key_is_writable(priv->gconf_client,key, err)) {
282 g_warning ("modest: '%s' is not writable\n", key);
286 return gconf_client_set_bool (priv->gconf_client, key, val, err);
291 modest_conf_set_list (ModestConf* self, const gchar* key,
292 GSList *val, ModestConfValueType list_type,
295 ModestConfPrivate *priv;
296 GConfValueType gconf_type;
299 g_return_val_if_fail (self, FALSE);
300 g_return_val_if_fail (key, FALSE);
302 priv = MODEST_CONF_GET_PRIVATE(self);
304 gconf_type = modest_conf_type_to_gconf_type (list_type, err);
308 result = gconf_client_set_list (priv->gconf_client, key, gconf_type, val, err);
310 g_warning("gconf_client_set_list() failed with key=%s. error=%s", key,
315 /* TODO: Remove this, when we fix the problem: */
316 /* This shows that sometimes set_list fails, while saying that it succeeded: */
318 const gint debug_list_length_start = g_slist_length(val);
319 GSList* debug_list = gconf_client_get_list(priv->gconf_client, key, gconf_type, err);
320 const gint debug_list_length_after = g_slist_length(debug_list);
322 if(debug_list_length_start != debug_list_length_after)
323 g_warning("modest_conf_set_list(): The list length after setting is "
324 "not the same as the specified list. key=%s. "
325 "We think that we fixed this, so tell us if you see this.", key);
326 g_slist_free(debug_list);
334 modest_conf_list_subkeys (ModestConf* self, const gchar* key, GError **err)
336 ModestConfPrivate *priv;
338 g_return_val_if_fail (self,FALSE);
339 g_return_val_if_fail (key, FALSE);
341 priv = MODEST_CONF_GET_PRIVATE(self);
343 return gconf_client_all_dirs (priv->gconf_client,key,err);
348 modest_conf_remove_key (ModestConf* self, const gchar* key, GError **err)
350 ModestConfPrivate *priv;
353 g_return_val_if_fail (self,FALSE);
354 g_return_val_if_fail (key, FALSE);
356 priv = MODEST_CONF_GET_PRIVATE(self);
358 retval = gconf_client_recursive_unset (priv->gconf_client,key,0,err);
359 gconf_client_suggest_sync (priv->gconf_client, NULL);
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 (const gchar* key)
393 g_return_val_if_fail (key, NULL);
394 g_return_val_if_fail (strlen (key) > 0, g_strdup (key));
396 return gconf_escape_key (key, strlen(key));
401 modest_conf_key_unescape (const gchar* key)
403 g_return_val_if_fail (key, NULL);
405 return gconf_unescape_key (key, strlen(key));
409 modest_conf_key_is_valid (const gchar* key)
411 return gconf_valid_key (key, NULL);
415 modest_conf_on_change (GConfClient *client,
420 ModestConfEvent event;
423 event = (entry->value) ? MODEST_CONF_EVENT_KEY_CHANGED : MODEST_CONF_EVENT_KEY_UNSET;
424 key = gconf_entry_get_key (entry);
426 g_signal_emit (G_OBJECT(data),
427 signals[KEY_CHANGED_SIGNAL], 0,
428 key, event, conn_id);
432 static GConfValueType
433 modest_conf_type_to_gconf_type (ModestConfValueType value_type, GError **err)
435 GConfValueType gconf_type;
437 switch (value_type) {
438 case MODEST_CONF_VALUE_INT:
439 gconf_type = GCONF_VALUE_INT;
441 case MODEST_CONF_VALUE_BOOL:
442 gconf_type = GCONF_VALUE_BOOL;
444 case MODEST_CONF_VALUE_FLOAT:
445 gconf_type = GCONF_VALUE_FLOAT;
447 case MODEST_CONF_VALUE_STRING:
448 gconf_type = GCONF_VALUE_STRING;
451 /* FIXME: use MODEST_ERROR, and error code */
452 gconf_type = GCONF_VALUE_INVALID;
453 g_printerr ("modest: invalid list value type %d\n", value_type);
454 *err = g_error_new_literal (0, 0, "invalid list value type");
459 ModestConfNotificationId
460 modest_conf_listen_to_namespace (ModestConf *self,
461 const gchar *namespace)
463 ModestConfPrivate *priv;
464 GError *error = NULL;
465 ModestConfNotificationId notification_id;
467 g_return_val_if_fail (MODEST_IS_CONF (self), 0);
468 g_return_val_if_fail (namespace, 0);
470 priv = MODEST_CONF_GET_PRIVATE(self);
472 /* Add the namespace to the list of the namespaces that will
474 gconf_client_add_dir (priv->gconf_client, namespace,
475 GCONF_CLIENT_PRELOAD_NONE,
481 /* Notify every change under namespace */
482 notification_id = gconf_client_notify_add (priv->gconf_client,
484 modest_conf_on_change,
491 return notification_id;
495 modest_conf_forget_namespace (ModestConf *self,
496 const gchar *namespace,
497 ModestConfNotificationId id)
499 ModestConfPrivate *priv;
501 g_return_if_fail (MODEST_IS_CONF (self));
502 g_return_if_fail (namespace);
504 priv = MODEST_CONF_GET_PRIVATE(self);
506 /* Remove the namespace to the list of the namespaces that will
508 gconf_client_remove_dir (priv->gconf_client, namespace, NULL);
510 /* Notify every change under namespace */
511 gconf_client_notify_remove (priv->gconf_client, id);