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 <glib/gi18n.h>
33 #include "modest-conf.h"
34 #include "modest-marshal.h"
37 static void modest_conf_class_init (ModestConfClass *klass);
38 static void modest_conf_init (ModestConf *obj);
39 static void modest_conf_finalize (GObject *obj);
40 static void modest_conf_on_change (GConfClient *client, guint conn_id,
41 GConfEntry *entry, gpointer data);
42 static GConfValueType modest_conf_type_to_gconf_type (ModestConfValueType value_type,
49 static guint signals[LAST_SIGNAL] = {0};
52 typedef struct _ModestConfPrivate ModestConfPrivate;
53 struct _ModestConfPrivate {
54 GConfClient *gconf_client;
56 #define MODEST_CONF_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
60 static GObjectClass *parent_class = NULL;
63 modest_conf_get_type (void)
65 static GType my_type = 0;
67 static const GTypeInfo my_info = {
68 sizeof(ModestConfClass),
70 NULL, /* base finalize */
71 (GClassInitFunc) modest_conf_class_init,
72 NULL, /* class finalize */
73 NULL, /* class data */
76 (GInstanceInitFunc) modest_conf_init,
79 my_type = g_type_register_static (G_TYPE_OBJECT,
87 modest_conf_class_init (ModestConfClass *klass)
89 GObjectClass *gobject_class;
90 gobject_class = (GObjectClass*) klass;
92 parent_class = g_type_class_peek_parent (klass);
93 gobject_class->finalize = modest_conf_finalize;
95 g_type_class_add_private (gobject_class, sizeof(ModestConfPrivate));
97 signals[KEY_CHANGED_SIGNAL] =
98 g_signal_new ("key_changed",
99 G_TYPE_FROM_CLASS (gobject_class),
101 G_STRUCT_OFFSET (ModestConfClass,key_changed),
103 modest_marshal_VOID__STRING_INT,
104 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_INT);
108 modest_conf_init (ModestConf *obj)
110 GConfClient *conf = NULL;
111 ModestConfPrivate *priv = MODEST_CONF_GET_PRIVATE(obj);
114 priv->gconf_client = NULL;
116 conf = gconf_client_get_default ();
118 g_printerr ("modest: could not get gconf client\n");
122 gconf_client_add_dir (conf,MODEST_CONF_NAMESPACE,
123 GCONF_CLIENT_PRELOAD_NONE,
126 g_printerr ("modest: error %d with gconf_client_add_dir: '%s'\n",
127 err->code, err->message);
128 g_object_unref (conf);
133 gconf_client_notify_add (conf, MODEST_CONF_NAMESPACE,
134 modest_conf_on_change,
137 g_printerr ("modest: gconf_client_notify_add error %d: '%s'\n",
138 err->code, err->message);
139 g_object_unref (conf);
144 priv->gconf_client = conf; /* all went well! */
148 modest_conf_finalize (GObject *obj)
150 ModestConfPrivate *priv = MODEST_CONF_GET_PRIVATE(obj);
151 if (priv->gconf_client) {
153 gconf_client_suggest_sync (priv->gconf_client, NULL);
155 g_object_unref (priv->gconf_client);
156 priv->gconf_client = NULL;
159 G_OBJECT_CLASS(parent_class)->finalize (obj);
163 modest_conf_new (void)
166 ModestConfPrivate *priv;
168 conf = MODEST_CONF(g_object_new(MODEST_TYPE_CONF, NULL));
170 g_printerr ("modest: failed to init ModestConf (GConf)\n");
174 priv = MODEST_CONF_GET_PRIVATE(conf);
175 if (!priv->gconf_client) {
176 g_printerr ("modest: failed to init gconf\n");
177 g_object_unref (conf);
186 modest_conf_get_string (ModestConf* self, const gchar* key, GError **err)
188 ModestConfPrivate *priv;
190 g_return_val_if_fail (self, NULL);
191 g_return_val_if_fail (key, NULL);
193 priv = MODEST_CONF_GET_PRIVATE(self);
194 return gconf_client_get_string (priv->gconf_client, key, err);
199 modest_conf_get_int (ModestConf* self, const gchar* key, GError **err)
201 ModestConfPrivate *priv;
203 g_return_val_if_fail (self, -1);
204 g_return_val_if_fail (key, -1);
206 priv = MODEST_CONF_GET_PRIVATE(self);
208 return gconf_client_get_int (priv->gconf_client, key, err);
213 modest_conf_get_bool (ModestConf* self, const gchar* key, GError **err)
215 ModestConfPrivate *priv;
217 g_return_val_if_fail (self, FALSE);
218 g_return_val_if_fail (key, FALSE);
220 priv = MODEST_CONF_GET_PRIVATE(self);
222 return gconf_client_get_bool (priv->gconf_client, key, err);
227 modest_conf_get_list (ModestConf* self, const gchar* key, ModestConfValueType list_type,
230 ModestConfPrivate *priv;
231 GConfValueType gconf_type;
233 g_return_val_if_fail (self, NULL);
234 g_return_val_if_fail (key, NULL);
236 priv = MODEST_CONF_GET_PRIVATE(self);
238 gconf_type = modest_conf_type_to_gconf_type (list_type, err);
240 return gconf_client_get_list (priv->gconf_client, key, gconf_type, err);
247 modest_conf_set_string (ModestConf* self, const gchar* key, const gchar* val,
250 ModestConfPrivate *priv;
252 g_return_val_if_fail (self,FALSE);
253 g_return_val_if_fail (key, FALSE);
255 priv = MODEST_CONF_GET_PRIVATE(self);
257 if (!gconf_client_key_is_writable(priv->gconf_client,key,err)) {
258 g_printerr ("modest: '%s' is not writable\n", key);
262 return gconf_client_set_string (priv->gconf_client, key, val, err);
267 modest_conf_set_int (ModestConf* self, const gchar* key, gint val,
270 ModestConfPrivate *priv;
272 g_return_val_if_fail (self,FALSE);
273 g_return_val_if_fail (key, FALSE);
275 priv = MODEST_CONF_GET_PRIVATE(self);
277 if (!gconf_client_key_is_writable(priv->gconf_client,key,err)) {
278 g_printerr ("modest: '%s' is not writable\n", key);
282 return gconf_client_set_int (priv->gconf_client, key, val, err);
287 modest_conf_set_bool (ModestConf* self, const gchar* key, gboolean val,
290 ModestConfPrivate *priv;
292 g_return_val_if_fail (self,FALSE);
293 g_return_val_if_fail (key, FALSE);
295 priv = MODEST_CONF_GET_PRIVATE(self);
297 if (!gconf_client_key_is_writable(priv->gconf_client,key, err)) {
298 g_warning ("modest: '%s' is not writable\n", key);
302 return gconf_client_set_bool (priv->gconf_client,key,val, err);
307 modest_conf_set_list (ModestConf* self, const gchar* key,
308 GSList *val, ModestConfValueType list_type,
311 ModestConfPrivate *priv;
312 GConfValueType gconf_type;
314 g_return_val_if_fail (self, FALSE);
315 g_return_val_if_fail (key, FALSE);
317 priv = MODEST_CONF_GET_PRIVATE(self);
319 gconf_type = modest_conf_type_to_gconf_type (list_type, err);
324 gboolean result = gconf_client_set_list (priv->gconf_client, key, gconf_type, val, err);
326 g_warning("gconf_client_set_list() failed with key=%s. error=%s", key, (*err)->message);
330 /* TODO: Remove this, when we fix the problem: */
331 /* This shows that sometimes set_list fails, while saying that it succeeded: */
333 const gint debug_list_length_start = g_slist_length(val);
334 GSList* debug_list = gconf_client_get_list(priv->gconf_client, key, gconf_type, err);
335 const gint debug_list_length_after = g_slist_length(debug_list);
337 if(debug_list_length_start != debug_list_length_after)
338 g_warning("modest_conf_set_list(): The list length after setting is not the same as the specified list. key=%s", key);
340 g_slist_free(debug_list);
348 modest_conf_list_subkeys (ModestConf* self, const gchar* key, GError **err)
350 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 return gconf_client_all_dirs (priv->gconf_client,key,err);
362 modest_conf_remove_key (ModestConf* self, const gchar* key, GError **err)
364 ModestConfPrivate *priv;
367 g_return_val_if_fail (self,FALSE);
368 g_return_val_if_fail (key, FALSE);
370 priv = MODEST_CONF_GET_PRIVATE(self);
372 retval = gconf_client_recursive_unset (priv->gconf_client,key,0,err);
373 gconf_client_suggest_sync (priv->gconf_client, NULL);
380 modest_conf_key_exists (ModestConf* self, const gchar* key, GError **err)
382 ModestConfPrivate *priv;
385 g_return_val_if_fail (self,FALSE);
386 g_return_val_if_fail (key, FALSE);
388 priv = MODEST_CONF_GET_PRIVATE(self);
390 /* the fast way... */
391 if (gconf_client_dir_exists (priv->gconf_client,key,err))
394 val = gconf_client_get (priv->gconf_client, key, NULL);
398 gconf_value_free (val);
405 modest_conf_key_escape (const gchar* key)
407 g_return_val_if_fail (key, NULL);
408 g_return_val_if_fail (strlen (key) > 0, g_strdup (key));
410 return gconf_escape_key (key, strlen(key));
415 modest_conf_key_unescape (const gchar* key)
417 g_return_val_if_fail (key, NULL);
419 return gconf_unescape_key (key, strlen(key));
423 modest_conf_key_is_valid (const gchar* key)
425 return gconf_valid_key (key, NULL);
429 /* hmmm... might need to make specific callback for specific keys */
431 modest_conf_on_change (GConfClient *client, guint conn_id, GConfEntry *entry,
434 ModestConfEvent event;
437 event = (entry->value) ? MODEST_CONF_EVENT_KEY_CHANGED : MODEST_CONF_EVENT_KEY_UNSET;
438 key = gconf_entry_get_key (entry);
440 g_signal_emit (G_OBJECT(data),
441 signals[KEY_CHANGED_SIGNAL], 0,
445 static GConfValueType
446 modest_conf_type_to_gconf_type (ModestConfValueType value_type, GError **err)
448 GConfValueType gconf_type = 0;
450 switch (value_type) {
451 case MODEST_CONF_VALUE_INT:
452 gconf_type = GCONF_VALUE_INT;
454 case MODEST_CONF_VALUE_BOOL:
455 gconf_type = GCONF_VALUE_BOOL;
457 case MODEST_CONF_VALUE_FLOAT:
458 gconf_type = GCONF_VALUE_FLOAT;
460 case MODEST_CONF_VALUE_STRING:
461 gconf_type = GCONF_VALUE_STRING;
464 /* FIXME: use MODEST_ERROR, and error code */
465 *err = g_error_new_literal (0, 0, _("Invalid list value type"));