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 GError *error = NULL;
118 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;
130 /* All the tree will be listened */
131 gconf_client_add_dir (priv->gconf_client,
133 GCONF_CLIENT_PRELOAD_NONE,
136 /* Notify every change under namespace */
138 gconf_client_notify_add (priv->gconf_client,
140 modest_conf_on_change,
147 modest_conf_finalize (GObject *obj)
149 ModestConfPrivate *priv = MODEST_CONF_GET_PRIVATE(obj);
150 if (priv->gconf_client) {
152 gconf_client_suggest_sync (priv->gconf_client, NULL);
154 g_object_unref (priv->gconf_client);
155 priv->gconf_client = NULL;
158 G_OBJECT_CLASS(parent_class)->finalize (obj);
162 modest_conf_new (void)
165 ModestConfPrivate *priv;
167 conf = MODEST_CONF(g_object_new(MODEST_TYPE_CONF, NULL));
169 g_printerr ("modest: failed to init ModestConf (GConf)\n");
173 priv = MODEST_CONF_GET_PRIVATE(conf);
174 if (!priv->gconf_client) {
175 g_printerr ("modest: failed to init gconf\n");
176 g_object_unref (conf);
185 modest_conf_get_string (ModestConf* self, const gchar* key, GError **err)
187 ModestConfPrivate *priv;
189 g_return_val_if_fail (self, NULL);
190 g_return_val_if_fail (key, NULL);
192 priv = MODEST_CONF_GET_PRIVATE(self);
193 return gconf_client_get_string (priv->gconf_client, key, err);
198 modest_conf_get_int (ModestConf* self, const gchar* key, GError **err)
200 ModestConfPrivate *priv;
202 g_return_val_if_fail (self, -1);
203 g_return_val_if_fail (key, -1);
205 priv = MODEST_CONF_GET_PRIVATE(self);
207 return gconf_client_get_int (priv->gconf_client, key, err);
211 modest_conf_get_float (ModestConf* self, const gchar* key, GError **err)
213 ModestConfPrivate *priv;
215 g_return_val_if_fail (self, -1);
216 g_return_val_if_fail (key, -1);
218 priv = MODEST_CONF_GET_PRIVATE(self);
220 return gconf_client_get_float (priv->gconf_client, key, err);
224 modest_conf_get_bool (ModestConf* self, const gchar* key, GError **err)
226 ModestConfPrivate *priv;
228 g_return_val_if_fail (self, FALSE);
229 g_return_val_if_fail (key, FALSE);
231 priv = MODEST_CONF_GET_PRIVATE(self);
233 return gconf_client_get_bool (priv->gconf_client, key, err);
238 modest_conf_get_list (ModestConf* self, const gchar* key, ModestConfValueType list_type,
241 ModestConfPrivate *priv;
242 GConfValueType gconf_type;
244 g_return_val_if_fail (self, NULL);
245 g_return_val_if_fail (key, NULL);
247 priv = MODEST_CONF_GET_PRIVATE(self);
249 gconf_type = modest_conf_type_to_gconf_type (list_type, err);
251 return gconf_client_get_list (priv->gconf_client, key, gconf_type, err);
258 modest_conf_set_string (ModestConf* self, const gchar* key, const gchar* val,
261 ModestConfPrivate *priv;
263 g_return_val_if_fail (self,FALSE);
264 g_return_val_if_fail (key, FALSE);
265 g_return_val_if_fail (val, FALSE);
267 priv = MODEST_CONF_GET_PRIVATE(self);
269 if (!gconf_client_key_is_writable(priv->gconf_client,key,err)) {
270 g_printerr ("modest: '%s' is not writable\n", key);
274 return gconf_client_set_string (priv->gconf_client, key, val, err);
278 modest_conf_set_int (ModestConf* self, const gchar* key, gint val,
281 ModestConfPrivate *priv;
283 g_return_val_if_fail (self,FALSE);
284 g_return_val_if_fail (key, FALSE);
286 priv = MODEST_CONF_GET_PRIVATE(self);
288 if (!gconf_client_key_is_writable(priv->gconf_client,key,err)) {
289 g_printerr ("modest: '%s' is not writable\n", key);
293 return gconf_client_set_int (priv->gconf_client, key, val, err);
297 modest_conf_set_float (ModestConf* self,
302 ModestConfPrivate *priv;
304 g_return_val_if_fail (self,FALSE);
305 g_return_val_if_fail (key, FALSE);
307 priv = MODEST_CONF_GET_PRIVATE(self);
309 if (!gconf_client_key_is_writable(priv->gconf_client,key,err)) {
310 g_printerr ("modest: '%s' is not writable\n", key);
314 return gconf_client_set_float (priv->gconf_client, key, val, err);
319 modest_conf_set_bool (ModestConf* self, const gchar* key, gboolean val,
322 ModestConfPrivate *priv;
324 g_return_val_if_fail (self,FALSE);
325 g_return_val_if_fail (key, FALSE);
327 priv = MODEST_CONF_GET_PRIVATE(self);
329 if (!gconf_client_key_is_writable(priv->gconf_client,key, err)) {
330 g_warning ("modest: '%s' is not writable\n", key);
334 return gconf_client_set_bool (priv->gconf_client, key, val, err);
339 modest_conf_set_list (ModestConf* self, const gchar* key,
340 GSList *val, ModestConfValueType list_type,
343 ModestConfPrivate *priv;
344 GConfValueType gconf_type;
346 g_return_val_if_fail (self, FALSE);
347 g_return_val_if_fail (key, FALSE);
349 priv = MODEST_CONF_GET_PRIVATE(self);
351 gconf_type = modest_conf_type_to_gconf_type (list_type, err);
353 return gconf_client_set_list (priv->gconf_client, key, gconf_type, val, err);
358 modest_conf_list_subkeys (ModestConf* self, const gchar* key, GError **err)
360 ModestConfPrivate *priv;
362 g_return_val_if_fail (self,FALSE);
363 g_return_val_if_fail (key, FALSE);
365 priv = MODEST_CONF_GET_PRIVATE(self);
367 return gconf_client_all_dirs (priv->gconf_client,key,err);
372 modest_conf_remove_key (ModestConf* self, const gchar* key, GError **err)
374 ModestConfPrivate *priv;
377 g_return_val_if_fail (self,FALSE);
378 g_return_val_if_fail (key, FALSE);
380 priv = MODEST_CONF_GET_PRIVATE(self);
382 retval = gconf_client_recursive_unset (priv->gconf_client,key,0,err);
383 gconf_client_suggest_sync (priv->gconf_client, NULL);
390 modest_conf_key_exists (ModestConf* self, const gchar* key, GError **err)
392 ModestConfPrivate *priv;
395 g_return_val_if_fail (self,FALSE);
396 g_return_val_if_fail (key, FALSE);
398 priv = MODEST_CONF_GET_PRIVATE(self);
400 /* the fast way... */
401 if (gconf_client_dir_exists (priv->gconf_client,key,err))
404 val = gconf_client_get (priv->gconf_client, key, NULL);
408 gconf_value_free (val);
415 modest_conf_key_escape (const gchar* key)
417 g_return_val_if_fail (key, NULL);
418 g_return_val_if_fail (strlen (key) > 0, g_strdup (key));
420 return gconf_escape_key (key, strlen(key));
425 modest_conf_key_unescape (const gchar* key)
427 g_return_val_if_fail (key, NULL);
429 return gconf_unescape_key (key, strlen(key));
433 modest_conf_key_is_valid (const gchar* key)
435 return gconf_valid_key (key, NULL);
439 modest_conf_on_change (GConfClient *client,
444 ModestConfEvent event;
447 event = (entry->value) ? MODEST_CONF_EVENT_KEY_CHANGED : MODEST_CONF_EVENT_KEY_UNSET;
448 key = gconf_entry_get_key (entry);
450 g_signal_emit (G_OBJECT(data),
451 signals[KEY_CHANGED_SIGNAL], 0,
452 key, event, conn_id);
455 static GConfValueType
456 modest_conf_type_to_gconf_type (ModestConfValueType value_type, GError **err)
458 GConfValueType gconf_type;
460 switch (value_type) {
461 case MODEST_CONF_VALUE_INT:
462 gconf_type = GCONF_VALUE_INT;
464 case MODEST_CONF_VALUE_BOOL:
465 gconf_type = GCONF_VALUE_BOOL;
467 case MODEST_CONF_VALUE_FLOAT:
468 gconf_type = GCONF_VALUE_FLOAT;
470 case MODEST_CONF_VALUE_STRING:
471 gconf_type = GCONF_VALUE_STRING;
474 /* FIXME: use MODEST_ERROR, and error code */
475 gconf_type = GCONF_VALUE_INVALID;
476 g_printerr ("modest: invalid list value type %d\n", value_type);
477 *err = g_error_new_literal (0, 0, "invalid list value type");
483 modest_conf_listen_to_namespace (ModestConf *self,
484 const gchar *namespace)
486 ModestConfPrivate *priv;
487 GError *error = NULL;
489 g_return_if_fail (MODEST_IS_CONF (self));
490 g_return_if_fail (namespace);
492 priv = MODEST_CONF_GET_PRIVATE(self);
494 /* Add the namespace to the list of the namespaces that will
496 gconf_client_add_dir (priv->gconf_client,
498 GCONF_CLIENT_PRELOAD_NONE,
503 modest_conf_forget_namespace (ModestConf *self,
504 const gchar *namespace)
506 ModestConfPrivate *priv;
508 g_return_if_fail (MODEST_IS_CONF (self));
509 g_return_if_fail (namespace);
511 priv = MODEST_CONF_GET_PRIVATE(self);
513 /* Remove the namespace to the list of the namespaces that will
515 gconf_client_remove_dir (priv->gconf_client, namespace, NULL);