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.
31 #include "modest-marshal.h"
32 #include "modest-account-keys.h"
33 #include "modest-account-mgr.h"
35 /* 'private'/'protected' functions */
36 static void modest_account_mgr_class_init (ModestAccountMgrClass * klass);
37 static void modest_account_mgr_init (ModestAccountMgr * obj);
38 static void modest_account_mgr_finalize (GObject * obj);
40 static gchar *get_account_keyname (const gchar * accname, const gchar * name, gboolean server_account);
44 ACCOUNT_CHANGED_SIGNAL,
45 ACCOUNT_REMOVED_SIGNAL,
49 typedef struct _ModestAccountMgrPrivate ModestAccountMgrPrivate;
50 struct _ModestAccountMgrPrivate {
51 ModestConf *modest_conf;
52 GSList *current_accounts;
55 #define MODEST_ACCOUNT_MGR_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
56 MODEST_TYPE_ACCOUNT_MGR, \
57 ModestAccountMgrPrivate))
59 static GObjectClass *parent_class = NULL;
61 static guint signals[LAST_SIGNAL] = {0};
65 account_from_key (const gchar *key, gboolean *is_account_key, gboolean *is_server_account)
67 const gchar* account_ns = MODEST_ACCOUNT_NAMESPACE "/";
68 const gchar* server_account_ns = MODEST_SERVER_ACCOUNT_NAMESPACE "/";
70 gchar *account = NULL;
72 /* determine if it's an account or a server account,
73 * based on the prefix */
74 if (g_str_has_prefix (key, account_ns)) {
76 if (is_server_account)
77 *is_server_account = FALSE;
79 account = g_strdup (key + strlen (account_ns));
81 } else if (g_str_has_prefix (key, server_account_ns)) {
83 if (is_server_account)
84 *is_server_account = TRUE;
86 account = g_strdup (key + strlen (server_account_ns));
90 /* if there are any slashes left in the key, it's not
91 * the toplevel entry for an account
93 cursor = strstr(account, "/");
95 if (is_account_key && cursor)
96 *is_account_key = TRUE;
98 /* put a NULL where the first slash was */
109 on_key_change (ModestConf *conf, const gchar *key, ModestConfEvent event, gpointer user_data)
111 ModestAccountMgr *self;
112 ModestAccountMgrPrivate *priv;
115 gboolean is_account_key, is_server_account;
118 self = MODEST_ACCOUNT_MGR (user_data);
119 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
121 account = account_from_key (key, &is_account_key, &is_server_account);
123 /* if this is not an account-related key change, ignore */
127 /* account was removed -- emit this, even if the account was disabled */
128 if (is_account_key && event == MODEST_CONF_EVENT_KEY_UNSET) {
129 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_REMOVED_SIGNAL], 0,
130 account, is_server_account);
135 /* is this account enabled? */
136 if (is_server_account)
139 enabled = modest_account_mgr_account_get_enabled (self, account);
141 /* account was changed.
142 * and always notify when enabled/disabled changes
144 if (enabled || g_str_has_suffix (key, MODEST_ACCOUNT_ENABLED))
145 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_CHANGED_SIGNAL], 0,
146 account, key, is_server_account);
153 modest_account_mgr_get_type (void)
155 static GType my_type = 0;
158 static const GTypeInfo my_info = {
159 sizeof (ModestAccountMgrClass),
160 NULL, /* base init */
161 NULL, /* base finalize */
162 (GClassInitFunc) modest_account_mgr_class_init,
163 NULL, /* class finalize */
164 NULL, /* class data */
165 sizeof (ModestAccountMgr),
167 (GInstanceInitFunc) modest_account_mgr_init,
170 my_type = g_type_register_static (G_TYPE_OBJECT,
178 modest_account_mgr_class_init (ModestAccountMgrClass * klass)
180 GObjectClass *gobject_class;
181 gobject_class = (GObjectClass *) klass;
183 parent_class = g_type_class_peek_parent (klass);
184 gobject_class->finalize = modest_account_mgr_finalize;
186 g_type_class_add_private (gobject_class,
187 sizeof (ModestAccountMgrPrivate));
189 /* signal definitions */
190 signals[ACCOUNT_REMOVED_SIGNAL] =
191 g_signal_new ("account_removed",
192 G_TYPE_FROM_CLASS (klass),
194 G_STRUCT_OFFSET(ModestAccountMgrClass,account_removed),
196 modest_marshal_VOID__STRING_BOOLEAN,
197 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_BOOLEAN);
198 signals[ACCOUNT_CHANGED_SIGNAL] =
199 g_signal_new ("account_changed",
200 G_TYPE_FROM_CLASS (klass),
202 G_STRUCT_OFFSET(ModestAccountMgrClass,account_changed),
204 modest_marshal_VOID__STRING_STRING_BOOLEAN,
205 G_TYPE_NONE, 3, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_BOOLEAN);
210 modest_account_mgr_init (ModestAccountMgr * obj)
212 ModestAccountMgrPrivate *priv =
213 MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
215 priv->modest_conf = NULL;
219 modest_account_mgr_finalize (GObject * obj)
221 ModestAccountMgrPrivate *priv =
222 MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
224 if (priv->modest_conf) {
225 g_object_unref (G_OBJECT(priv->modest_conf));
226 priv->modest_conf = NULL;
232 modest_account_mgr_new (ModestConf * conf)
235 ModestAccountMgrPrivate *priv;
237 g_return_val_if_fail (conf, NULL);
239 obj = G_OBJECT (g_object_new (MODEST_TYPE_ACCOUNT_MGR, NULL));
240 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
242 g_object_ref (G_OBJECT(conf));
243 priv->modest_conf = conf;
245 g_signal_connect (G_OBJECT (conf), "key_changed",
246 G_CALLBACK (on_key_change),
249 return MODEST_ACCOUNT_MGR (obj);
254 null_means_empty (const gchar * str)
256 return str ? str : "";
261 modest_account_mgr_account_set_enabled (ModestAccountMgr *self, const gchar* name,
264 return modest_account_mgr_set_bool (self, name,
265 MODEST_ACCOUNT_ENABLED, enabled,
271 modest_account_mgr_account_get_enabled (ModestAccountMgr *self, const gchar* name)
273 return modest_account_mgr_get_bool (self, name,
274 MODEST_ACCOUNT_ENABLED, FALSE,
280 modest_account_mgr_add_account (ModestAccountMgr *self,
282 const gchar *store_account,
283 const gchar *transport_account,
286 ModestAccountMgrPrivate *priv;
290 g_return_val_if_fail (self, FALSE);
291 g_return_val_if_fail (name, FALSE);
293 if (modest_account_mgr_account_exists (self, name, FALSE, err)) {
294 g_printerr ("modest: account already exists\n");
299 * we create the account by adding an account 'dir', with the name <name>,
300 * and in that the 'display_name' string key
302 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
304 key = get_account_keyname (name, MODEST_ACCOUNT_DISPLAY_NAME, FALSE);
305 ok = modest_conf_set_string (priv->modest_conf, key, name, err);
309 g_printerr ("modest: cannot set display name\n");
314 key = get_account_keyname (name, MODEST_ACCOUNT_STORE_ACCOUNT, FALSE);
315 ok = modest_conf_set_string (priv->modest_conf, key, store_account, err);
318 g_printerr ("modest: failed to set store account '%s'\n",
324 if (transport_account) {
325 key = get_account_keyname (name, MODEST_ACCOUNT_TRANSPORT_ACCOUNT, FALSE);
326 ok = modest_conf_set_string (priv->modest_conf, key, transport_account, err);
329 g_printerr ("modest: failed to set transport account '%s'\n",
335 modest_account_mgr_account_set_enabled (self, name, TRUE);
344 modest_account_mgr_add_server_account (ModestAccountMgr * self,
346 const gchar * hostname,
347 const gchar * username,
348 const gchar * password,
351 ModestAccountMgrPrivate *priv;
354 g_return_val_if_fail (self, FALSE);
355 g_return_val_if_fail (name, FALSE);
357 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
359 key = get_account_keyname (name, NULL, TRUE);
360 if (modest_conf_key_exists (priv->modest_conf, key, NULL)) {
361 g_printerr ("modest: server account '%s' already exists", name);
368 key = get_account_keyname (name, MODEST_ACCOUNT_HOSTNAME, TRUE);
369 modest_conf_set_string (priv->modest_conf, key, null_means_empty(hostname), NULL);
373 key = get_account_keyname (name, MODEST_ACCOUNT_USERNAME, TRUE);
374 modest_conf_set_string (priv->modest_conf, key, null_means_empty (username), NULL);
378 key = get_account_keyname (name, MODEST_ACCOUNT_PASSWORD, TRUE);
379 modest_conf_set_string (priv->modest_conf, key, null_means_empty (password), NULL);
383 key = get_account_keyname (name, MODEST_ACCOUNT_PROTO, TRUE);
384 modest_conf_set_string (priv->modest_conf, key, null_means_empty (proto), NULL);
393 modest_account_mgr_remove_account (ModestAccountMgr * self,
395 gboolean server_account,
398 ModestAccountMgrPrivate *priv;
402 g_return_val_if_fail (self, FALSE);
403 g_return_val_if_fail (name, FALSE);
405 if (!modest_account_mgr_account_exists (self, name, server_account, err)) {
406 g_printerr ("modest: account '%s' does not exist\n", name);
410 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
411 key = get_account_keyname (name, NULL, server_account);
413 retval = modest_conf_remove_key (priv->modest_conf, key, NULL);
421 /* strip the first /n/ character from each element */
422 /* caller must make sure all elements are strings with
423 * length >= n, and also that data can be freed.
426 strip_prefix_from_elements (GSList * lst, guint n)
428 GSList *cursor = lst;
431 gchar *str = (gchar *) cursor->data;
432 cursor->data = g_strdup (str + n);
434 cursor = cursor->next;
441 modest_account_mgr_search_server_accounts (ModestAccountMgr * self,
442 const gchar * account_name,
443 ModestProtoType type,
448 ModestAccountMgrPrivate *priv;
452 g_return_val_if_fail (self, NULL);
454 key = get_account_keyname (account_name, NULL, TRUE);
455 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
457 /* get the list of all server accounts */
458 accounts = modest_conf_list_subkeys (priv->modest_conf, key, &err);
461 g_printerr ("modest: failed to get subkeys for '%s'\n", key);
465 /* no restrictions, return everything */
466 if (type == MODEST_PROTO_TYPE_ANY && !proto)
467 return strip_prefix_from_elements (accounts, strlen(key)+1);
468 /* +1 because we must remove the ending '/' as well */
470 /* otherwise, filter out the none-matching ones */
476 account = account_from_key ((gchar*)cursor->data, NULL, NULL);
477 acc_proto = modest_account_mgr_get_string (self, account, MODEST_ACCOUNT_PROTO,
479 if ((!acc_proto) || /* proto not defined? */
480 (type != MODEST_PROTO_TYPE_ANY && /* proto type ... */
481 modest_proto_type (acc_proto) != type) || /* ... matches? */
482 (proto && strcmp (proto, acc_proto) != 0)) { /* proto matches? */
483 /* match! remove from the list */
484 GSList *nxt = cursor->next;
485 accounts = g_slist_delete_link (accounts, cursor);
488 cursor = cursor->next;
494 return strip_prefix_from_elements (accounts, strlen(key)+1);
495 /* +1 because we must remove the ending '/' as well */
500 modest_account_mgr_account_names (ModestAccountMgr * self, GError ** err)
503 ModestAccountMgrPrivate *priv;
504 const size_t prefix_len = strlen (MODEST_ACCOUNT_NAMESPACE "/");
506 g_return_val_if_fail (self, NULL);
508 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
510 accounts = modest_conf_list_subkeys (priv->modest_conf,
511 MODEST_ACCOUNT_NAMESPACE, err);
513 return strip_prefix_from_elements (accounts, prefix_len);
518 modest_account_mgr_get_string (ModestAccountMgr *self, const gchar *name,
519 const gchar *key, gboolean server_account, GError **err) {
521 ModestAccountMgrPrivate *priv;
526 g_return_val_if_fail (self, NULL);
527 g_return_val_if_fail (name, NULL);
528 g_return_val_if_fail (key, NULL);
530 keyname = get_account_keyname (name, key, server_account);
532 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
533 retval = modest_conf_get_string (priv->modest_conf, keyname, err);
541 modest_account_mgr_get_int (ModestAccountMgr *self, const gchar *name,
542 const gchar *key, gboolean server_account, GError **err)
544 ModestAccountMgrPrivate *priv;
549 g_return_val_if_fail (self, -1);
550 g_return_val_if_fail (name, -1);
551 g_return_val_if_fail (key, -1);
553 keyname = get_account_keyname (name, key, server_account);
555 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
556 retval = modest_conf_get_int (priv->modest_conf, keyname, err);
565 modest_account_mgr_get_bool (ModestAccountMgr * self, const gchar *account,
566 const gchar * key, gboolean server_account, GError ** err)
568 ModestAccountMgrPrivate *priv;
573 g_return_val_if_fail (self, FALSE);
574 g_return_val_if_fail (account, FALSE);
575 g_return_val_if_fail (key, FALSE);
577 keyname = get_account_keyname (account, key, server_account);
579 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
580 retval = modest_conf_get_bool (priv->modest_conf, keyname, err);
589 modest_account_mgr_set_string (ModestAccountMgr * self, const gchar * name,
590 const gchar * key, const gchar * val,
591 gboolean server_account, GError ** err)
593 ModestAccountMgrPrivate *priv;
598 g_return_val_if_fail (self, FALSE);
599 g_return_val_if_fail (name, FALSE);
600 g_return_val_if_fail (key, FALSE);
602 keyname = get_account_keyname (name, key, server_account);
604 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
606 retval = modest_conf_set_string (priv->modest_conf, keyname, val,
615 modest_account_mgr_set_int (ModestAccountMgr * self, const gchar * name,
616 const gchar * key, int val, gboolean server_account,
619 ModestAccountMgrPrivate *priv;
624 g_return_val_if_fail (self, FALSE);
625 g_return_val_if_fail (name, FALSE);
626 g_return_val_if_fail (key, FALSE);
628 keyname = get_account_keyname (name, key, server_account);
630 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
632 retval = modest_conf_set_int (priv->modest_conf, keyname, val, err);
641 modest_account_mgr_set_bool (ModestAccountMgr * self, const gchar * name,
642 const gchar * key, gboolean val, gboolean server_account,
645 ModestAccountMgrPrivate *priv;
650 g_return_val_if_fail (self, FALSE);
651 g_return_val_if_fail (name, FALSE);
652 g_return_val_if_fail (key, FALSE);
654 keyname = get_account_keyname (name, key, server_account);
656 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
658 retval = modest_conf_set_bool (priv->modest_conf, keyname, val, err);
666 modest_account_mgr_account_exists (ModestAccountMgr * self, const gchar * name,
667 gboolean server_account, GError ** err)
669 ModestAccountMgrPrivate *priv;
674 g_return_val_if_fail (self, FALSE);
675 g_return_val_if_fail (name, FALSE);
677 keyname = get_account_keyname (name, NULL, server_account);
679 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
680 retval = modest_conf_key_exists (priv->modest_conf, keyname, err);
687 /* must be freed by caller */
689 get_account_keyname (const gchar * accname, const gchar * name, gboolean server_account)
691 gchar *namespace, *account_name, *retval;
693 namespace = server_account ? MODEST_SERVER_ACCOUNT_NAMESPACE : MODEST_ACCOUNT_NAMESPACE;
696 return g_strdup (namespace);
698 account_name = modest_conf_key_escape (NULL, accname);
701 retval = g_strconcat (namespace, "/", accname, "/", name, NULL);
703 retval = g_strconcat (namespace, "/", accname, NULL);
705 g_free (account_name);