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);
119 priv->gconf_client = NULL;
121 conf = gconf_client_get_default ();
123 g_printerr ("modest: could not get gconf client\n");
127 priv->gconf_client = conf; /* all went well! */
131 modest_conf_finalize (GObject *obj)
133 ModestConfPrivate *priv = MODEST_CONF_GET_PRIVATE(obj);
134 if (priv->gconf_client) {
136 gconf_client_suggest_sync (priv->gconf_client, NULL);
138 g_object_unref (priv->gconf_client);
139 priv->gconf_client = NULL;
142 G_OBJECT_CLASS(parent_class)->finalize (obj);
146 modest_conf_new (void)
149 ModestConfPrivate *priv;
151 conf = MODEST_CONF(g_object_new(MODEST_TYPE_CONF, NULL));
153 g_printerr ("modest: failed to init ModestConf (GConf)\n");
157 priv = MODEST_CONF_GET_PRIVATE(conf);
158 if (!priv->gconf_client) {
159 g_printerr ("modest: failed to init gconf\n");
160 g_object_unref (conf);
169 modest_conf_get_string (ModestConf* self, const gchar* key, GError **err)
171 ModestConfPrivate *priv;
173 g_return_val_if_fail (self, NULL);
174 g_return_val_if_fail (key, NULL);
176 priv = MODEST_CONF_GET_PRIVATE(self);
177 return gconf_client_get_string (priv->gconf_client, key, err);
182 modest_conf_get_int (ModestConf* self, const gchar* key, GError **err)
184 ModestConfPrivate *priv;
186 g_return_val_if_fail (self, -1);
187 g_return_val_if_fail (key, -1);
189 priv = MODEST_CONF_GET_PRIVATE(self);
191 return gconf_client_get_int (priv->gconf_client, key, err);
196 modest_conf_get_bool (ModestConf* self, const gchar* key, GError **err)
198 ModestConfPrivate *priv;
200 g_return_val_if_fail (self, FALSE);
201 g_return_val_if_fail (key, FALSE);
203 priv = MODEST_CONF_GET_PRIVATE(self);
205 return gconf_client_get_bool (priv->gconf_client, key, err);
210 modest_conf_get_list (ModestConf* self, const gchar* key, ModestConfValueType list_type,
213 ModestConfPrivate *priv;
214 GConfValueType gconf_type;
216 g_return_val_if_fail (self, NULL);
217 g_return_val_if_fail (key, NULL);
219 priv = MODEST_CONF_GET_PRIVATE(self);
221 gconf_type = modest_conf_type_to_gconf_type (list_type, err);
223 return gconf_client_get_list (priv->gconf_client, key, gconf_type, err);
230 modest_conf_set_string (ModestConf* self, const gchar* key, const gchar* val,
233 ModestConfPrivate *priv;
235 g_return_val_if_fail (self,FALSE);
236 g_return_val_if_fail (key, FALSE);
237 g_return_val_if_fail (val, FALSE);
239 priv = MODEST_CONF_GET_PRIVATE(self);
241 if (!gconf_client_key_is_writable(priv->gconf_client,key,err)) {
242 g_printerr ("modest: '%s' is not writable\n", key);
246 return gconf_client_set_string (priv->gconf_client, key, val, err);
250 modest_conf_set_int (ModestConf* self, const gchar* key, gint val,
253 ModestConfPrivate *priv;
255 g_return_val_if_fail (self,FALSE);
256 g_return_val_if_fail (key, FALSE);
258 priv = MODEST_CONF_GET_PRIVATE(self);
260 if (!gconf_client_key_is_writable(priv->gconf_client,key,err)) {
261 g_printerr ("modest: '%s' is not writable\n", key);
265 return gconf_client_set_int (priv->gconf_client, key, val, err);
270 modest_conf_set_bool (ModestConf* self, const gchar* key, gboolean val,
273 ModestConfPrivate *priv;
275 g_return_val_if_fail (self,FALSE);
276 g_return_val_if_fail (key, FALSE);
278 priv = MODEST_CONF_GET_PRIVATE(self);
280 if (!gconf_client_key_is_writable(priv->gconf_client,key, err)) {
281 g_warning ("modest: '%s' is not writable\n", key);
285 return gconf_client_set_bool (priv->gconf_client, key, val, err);
290 modest_conf_set_list (ModestConf* self, const gchar* key,
291 GSList *val, ModestConfValueType list_type,
294 ModestConfPrivate *priv;
295 GConfValueType gconf_type;
298 g_return_val_if_fail (self, FALSE);
299 g_return_val_if_fail (key, FALSE);
301 priv = MODEST_CONF_GET_PRIVATE(self);
303 gconf_type = modest_conf_type_to_gconf_type (list_type, err);
307 result = gconf_client_set_list (priv->gconf_client, key, gconf_type, val, err);
309 g_warning("gconf_client_set_list() failed with key=%s. error=%s", key,
314 /* TODO: Remove this, when we fix the problem: */
315 /* This shows that sometimes set_list fails, while saying that it succeeded: */
317 const gint debug_list_length_start = g_slist_length(val);
318 GSList* debug_list = gconf_client_get_list(priv->gconf_client, key, gconf_type, err);
319 const gint debug_list_length_after = g_slist_length(debug_list);
321 if(debug_list_length_start != debug_list_length_after)
322 g_warning("modest_conf_set_list(): The list length after setting is "
323 "not the same as the specified list. key=%s. "
324 "We think that we fixed this, so tell us if you see this.", key);
325 g_slist_free(debug_list);
333 modest_conf_list_subkeys (ModestConf* self, const gchar* key, GError **err)
335 ModestConfPrivate *priv;
337 g_return_val_if_fail (self,FALSE);
338 g_return_val_if_fail (key, FALSE);
340 priv = MODEST_CONF_GET_PRIVATE(self);
342 return gconf_client_all_dirs (priv->gconf_client,key,err);
347 modest_conf_remove_key (ModestConf* self, const gchar* key, GError **err)
349 ModestConfPrivate *priv;
352 g_return_val_if_fail (self,FALSE);
353 g_return_val_if_fail (key, FALSE);
355 priv = MODEST_CONF_GET_PRIVATE(self);
357 retval = gconf_client_recursive_unset (priv->gconf_client,key,0,err);
358 gconf_client_suggest_sync (priv->gconf_client, NULL);
365 modest_conf_key_exists (ModestConf* self, const gchar* key, GError **err)
367 ModestConfPrivate *priv;
370 g_return_val_if_fail (self,FALSE);
371 g_return_val_if_fail (key, FALSE);
373 priv = MODEST_CONF_GET_PRIVATE(self);
375 /* the fast way... */
376 if (gconf_client_dir_exists (priv->gconf_client,key,err))
379 val = gconf_client_get (priv->gconf_client, key, NULL);
383 gconf_value_free (val);
390 modest_conf_key_escape (const gchar* key)
392 g_return_val_if_fail (key, NULL);
393 g_return_val_if_fail (strlen (key) > 0, g_strdup (key));
395 return gconf_escape_key (key, strlen(key));
400 modest_conf_key_unescape (const gchar* key)
402 g_return_val_if_fail (key, NULL);
404 return gconf_unescape_key (key, strlen(key));
408 modest_conf_key_is_valid (const gchar* key)
410 return gconf_valid_key (key, NULL);
414 modest_conf_on_change (GConfClient *client,
419 ModestConfEvent event;
422 event = (entry->value) ? MODEST_CONF_EVENT_KEY_CHANGED : MODEST_CONF_EVENT_KEY_UNSET;
423 key = gconf_entry_get_key (entry);
425 g_signal_emit (G_OBJECT(data),
426 signals[KEY_CHANGED_SIGNAL], 0,
427 key, event, conn_id);
431 static GConfValueType
432 modest_conf_type_to_gconf_type (ModestConfValueType value_type, GError **err)
434 GConfValueType gconf_type;
436 switch (value_type) {
437 case MODEST_CONF_VALUE_INT:
438 gconf_type = GCONF_VALUE_INT;
440 case MODEST_CONF_VALUE_BOOL:
441 gconf_type = GCONF_VALUE_BOOL;
443 case MODEST_CONF_VALUE_FLOAT:
444 gconf_type = GCONF_VALUE_FLOAT;
446 case MODEST_CONF_VALUE_STRING:
447 gconf_type = GCONF_VALUE_STRING;
450 /* FIXME: use MODEST_ERROR, and error code */
451 gconf_type = GCONF_VALUE_INVALID;
452 g_printerr ("modest: invalid list value type %d\n", value_type);
453 *err = g_error_new_literal (0, 0, "invalid list value type");
458 ModestConfNotificationId
459 modest_conf_listen_to_namespace (ModestConf *self,
460 const gchar *namespace)
462 ModestConfPrivate *priv;
463 GError *error = NULL;
464 ModestConfNotificationId notification_id;
466 g_return_val_if_fail (MODEST_IS_CONF (self), 0);
467 g_return_val_if_fail (namespace, 0);
469 priv = MODEST_CONF_GET_PRIVATE(self);
471 /* Add the namespace to the list of the namespaces that will
473 gconf_client_add_dir (priv->gconf_client, namespace,
474 GCONF_CLIENT_PRELOAD_NONE,
480 /* Notify every change under namespace */
481 notification_id = gconf_client_notify_add (priv->gconf_client,
483 modest_conf_on_change,
490 return notification_id;
494 modest_conf_forget_namespace (ModestConf *self,
495 const gchar *namespace,
496 ModestConfNotificationId id)
498 ModestConfPrivate *priv;
500 g_return_if_fail (MODEST_IS_CONF (self));
501 g_return_if_fail (namespace);
503 priv = MODEST_CONF_GET_PRIVATE(self);
505 /* Remove the namespace to the list of the namespaces that will
507 gconf_client_remove_dir (priv->gconf_client, namespace, NULL);
509 /* Notify every change under namespace */
510 gconf_client_notify_remove (priv->gconf_client, id);