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"
36 static void modest_conf_class_init (ModestConfClass *klass);
37 static void modest_conf_init (ModestConf *obj);
38 static void modest_conf_finalize (GObject *obj);
39 static void modest_conf_on_change (GConfClient *client, guint conn_id,
40 GConfEntry *entry, gpointer data);
41 static GConfValueType modest_conf_type_to_gconf_type (ModestConfValueType value_type,
48 static guint signals[LAST_SIGNAL] = {0};
51 typedef struct _ModestConfPrivate ModestConfPrivate;
52 struct _ModestConfPrivate {
53 GConfClient *gconf_client;
55 #define MODEST_CONF_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
59 static GObjectClass *parent_class = NULL;
62 modest_conf_get_type (void)
64 static GType my_type = 0;
66 static const GTypeInfo my_info = {
67 sizeof(ModestConfClass),
69 NULL, /* base finalize */
70 (GClassInitFunc) modest_conf_class_init,
71 NULL, /* class finalize */
72 NULL, /* class data */
75 (GInstanceInitFunc) modest_conf_init,
78 my_type = g_type_register_static (G_TYPE_OBJECT,
86 modest_conf_class_init (ModestConfClass *klass)
88 GObjectClass *gobject_class;
89 gobject_class = (GObjectClass*) klass;
91 parent_class = g_type_class_peek_parent (klass);
92 gobject_class->finalize = modest_conf_finalize;
94 g_type_class_add_private (gobject_class, sizeof(ModestConfPrivate));
96 signals[KEY_CHANGED_SIGNAL] =
97 g_signal_new ("key_changed",
98 G_TYPE_FROM_CLASS (gobject_class),
100 G_STRUCT_OFFSET (ModestConfClass,key_changed),
102 modest_marshal_VOID__STRING_INT,
103 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_INT);
107 modest_conf_init (ModestConf *obj)
109 GConfClient *conf = NULL;
110 ModestConfPrivate *priv = MODEST_CONF_GET_PRIVATE(obj);
113 priv->gconf_client = NULL;
115 conf = gconf_client_get_default ();
117 g_printerr ("modest: could not get gconf client\n");
121 gconf_client_add_dir (conf,MODEST_CONF_NAMESPACE,
122 GCONF_CLIENT_PRELOAD_NONE,
125 g_printerr ("modest: error %d with gconf_client_add_dir: '%s'\n",
126 err->code, err->message);
127 g_object_unref (conf);
132 gconf_client_notify_add (conf, MODEST_CONF_NAMESPACE,
133 modest_conf_on_change,
136 g_printerr ("modest: gconf_client_notify_add error %d: '%s'\n",
137 err->code, err->message);
138 g_object_unref (conf);
143 priv->gconf_client = conf; /* all went well! */
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);
212 modest_conf_get_bool (ModestConf* self, const gchar* key, GError **err)
214 ModestConfPrivate *priv;
216 g_return_val_if_fail (self, FALSE);
217 g_return_val_if_fail (key, FALSE);
219 priv = MODEST_CONF_GET_PRIVATE(self);
221 return gconf_client_get_bool (priv->gconf_client, key, err);
226 modest_conf_get_list (ModestConf* self, const gchar* key, ModestConfValueType list_type,
229 ModestConfPrivate *priv;
230 GConfValueType gconf_type;
232 g_return_val_if_fail (self, NULL);
233 g_return_val_if_fail (key, NULL);
235 priv = MODEST_CONF_GET_PRIVATE(self);
237 gconf_type = modest_conf_type_to_gconf_type (list_type, err);
239 return gconf_client_get_list (priv->gconf_client, key, gconf_type, err);
246 modest_conf_set_string (ModestConf* self, const gchar* key, const gchar* val,
249 ModestConfPrivate *priv;
251 g_return_val_if_fail (self,FALSE);
252 g_return_val_if_fail (key, FALSE);
254 priv = MODEST_CONF_GET_PRIVATE(self);
256 if (!gconf_client_key_is_writable(priv->gconf_client,key,err)) {
257 g_printerr ("modest: '%s' is not writable\n", key);
261 return gconf_client_set_string (priv->gconf_client, key, val, err);
266 modest_conf_set_int (ModestConf* self, const gchar* key, gint val,
269 ModestConfPrivate *priv;
271 g_return_val_if_fail (self,FALSE);
272 g_return_val_if_fail (key, FALSE);
274 priv = MODEST_CONF_GET_PRIVATE(self);
276 if (!gconf_client_key_is_writable(priv->gconf_client,key,err)) {
277 g_printerr ("modest: '%s' is not writable\n", key);
281 return gconf_client_set_int (priv->gconf_client, key, val, err);
286 modest_conf_set_bool (ModestConf* self, const gchar* key, gboolean val,
289 ModestConfPrivate *priv;
291 g_return_val_if_fail (self,FALSE);
292 g_return_val_if_fail (key, FALSE);
294 priv = MODEST_CONF_GET_PRIVATE(self);
296 if (!gconf_client_key_is_writable(priv->gconf_client,key, err)) {
297 g_warning ("modest: '%s' is not writable\n", key);
301 return gconf_client_set_bool (priv->gconf_client,key,val, err);
306 modest_conf_set_list (ModestConf* self, const gchar* key,
307 GSList *val, ModestConfValueType list_type,
310 ModestConfPrivate *priv;
311 GConfValueType gconf_type;
313 g_return_val_if_fail (self, FALSE);
314 g_return_val_if_fail (key, FALSE);
316 priv = MODEST_CONF_GET_PRIVATE(self);
318 gconf_type = modest_conf_type_to_gconf_type (list_type, err);
322 return gconf_client_set_list (priv->gconf_client, key, gconf_type, val, err);
327 modest_conf_list_subkeys (ModestConf* self, const gchar* key, GError **err)
329 ModestConfPrivate *priv;
331 g_return_val_if_fail (self,FALSE);
332 g_return_val_if_fail (key, FALSE);
334 priv = MODEST_CONF_GET_PRIVATE(self);
336 return gconf_client_all_dirs (priv->gconf_client,key,err);
341 modest_conf_remove_key (ModestConf* self, const gchar* key, GError **err)
343 ModestConfPrivate *priv;
346 g_return_val_if_fail (self,FALSE);
347 g_return_val_if_fail (key, FALSE);
349 priv = MODEST_CONF_GET_PRIVATE(self);
351 retval = gconf_client_recursive_unset (priv->gconf_client,key,0,err);
352 gconf_client_suggest_sync (priv->gconf_client, NULL);
359 modest_conf_key_exists (ModestConf* self, const gchar* key, GError **err)
361 ModestConfPrivate *priv;
364 g_return_val_if_fail (self,FALSE);
365 g_return_val_if_fail (key, FALSE);
367 priv = MODEST_CONF_GET_PRIVATE(self);
369 /* the fast way... */
370 if (gconf_client_dir_exists (priv->gconf_client,key,err))
373 val = gconf_client_get (priv->gconf_client, key, NULL);
377 gconf_value_free (val);
384 modest_conf_key_escape (const gchar* key)
386 g_return_val_if_fail (key, NULL);
387 g_return_val_if_fail (strlen (key) > 0, g_strdup (key));
389 return gconf_escape_key (key, strlen(key));
394 modest_conf_key_unescape (const gchar* key)
396 g_return_val_if_fail (key, NULL);
398 return gconf_unescape_key (key, strlen(key));
402 modest_conf_key_is_valid (const gchar* key)
404 return gconf_valid_key (key, NULL);
408 /* hmmm... might need to make specific callback for specific keys */
410 modest_conf_on_change (GConfClient *client, guint conn_id, GConfEntry *entry,
413 ModestConfEvent event;
416 event = (entry->value) ? MODEST_CONF_EVENT_KEY_CHANGED : MODEST_CONF_EVENT_KEY_UNSET;
417 key = gconf_entry_get_key (entry);
419 g_signal_emit (G_OBJECT(data),
420 signals[KEY_CHANGED_SIGNAL], 0,
424 static GConfValueType
425 modest_conf_type_to_gconf_type (ModestConfValueType value_type, GError **err)
427 GConfValueType gconf_type = 0;
429 switch (value_type) {
430 case MODEST_CONF_VALUE_INT:
431 gconf_type = GCONF_VALUE_INT;
433 case MODEST_CONF_VALUE_BOOL:
434 gconf_type = GCONF_VALUE_BOOL;
436 case MODEST_CONF_VALUE_FLOAT:
437 gconf_type = GCONF_VALUE_FLOAT;
439 case MODEST_CONF_VALUE_STRING:
440 gconf_type = GCONF_VALUE_STRING;
443 /* FIXME: use MODEST_ERROR, and error code */
444 *err = g_error_new_literal (0, 0, _("Invalid list value type"));