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 enabled = modest_account_mgr_account_get_enabled (self, account,
139 /* account was changed.
140 * and always notify when enabled/disabled changes
142 if (enabled || g_str_has_suffix (key, MODEST_ACCOUNT_ENABLED))
143 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_CHANGED_SIGNAL], 0,
144 account, key, is_server_account);
151 modest_account_mgr_get_type (void)
153 static GType my_type = 0;
156 static const GTypeInfo my_info = {
157 sizeof (ModestAccountMgrClass),
158 NULL, /* base init */
159 NULL, /* base finalize */
160 (GClassInitFunc) modest_account_mgr_class_init,
161 NULL, /* class finalize */
162 NULL, /* class data */
163 sizeof (ModestAccountMgr),
165 (GInstanceInitFunc) modest_account_mgr_init,
168 my_type = g_type_register_static (G_TYPE_OBJECT,
176 modest_account_mgr_class_init (ModestAccountMgrClass * klass)
178 GObjectClass *gobject_class;
179 gobject_class = (GObjectClass *) klass;
181 parent_class = g_type_class_peek_parent (klass);
182 gobject_class->finalize = modest_account_mgr_finalize;
184 g_type_class_add_private (gobject_class,
185 sizeof (ModestAccountMgrPrivate));
187 /* signal definitions */
188 signals[ACCOUNT_REMOVED_SIGNAL] =
189 g_signal_new ("account_removed",
190 G_TYPE_FROM_CLASS (klass),
192 G_STRUCT_OFFSET(ModestAccountMgrClass,account_removed),
194 modest_marshal_VOID__STRING_BOOLEAN,
195 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_BOOLEAN);
196 signals[ACCOUNT_CHANGED_SIGNAL] =
197 g_signal_new ("account_changed",
198 G_TYPE_FROM_CLASS (klass),
200 G_STRUCT_OFFSET(ModestAccountMgrClass,account_changed),
202 modest_marshal_VOID__STRING_STRING_BOOLEAN,
203 G_TYPE_NONE, 3, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_BOOLEAN);
208 modest_account_mgr_init (ModestAccountMgr * obj)
210 ModestAccountMgrPrivate *priv =
211 MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
213 priv->modest_conf = NULL;
217 modest_account_mgr_finalize (GObject * obj)
219 ModestAccountMgrPrivate *priv =
220 MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
222 if (priv->modest_conf) {
223 g_object_unref (G_OBJECT(priv->modest_conf));
224 priv->modest_conf = NULL;
230 modest_account_mgr_new (ModestConf * conf)
233 ModestAccountMgrPrivate *priv;
235 g_return_val_if_fail (conf, NULL);
237 obj = G_OBJECT (g_object_new (MODEST_TYPE_ACCOUNT_MGR, NULL));
238 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
240 g_object_ref (G_OBJECT(conf));
241 priv->modest_conf = conf;
243 g_signal_connect (G_OBJECT (conf), "key_changed",
244 G_CALLBACK (on_key_change),
247 return MODEST_ACCOUNT_MGR (obj);
252 null_means_empty (const gchar * str)
254 return str ? str : "";
259 modest_account_mgr_account_set_enabled (ModestAccountMgr *self, const gchar* name,
260 gboolean is_server_account, gboolean enabled)
262 return modest_account_mgr_set_bool (self, name,
263 MODEST_ACCOUNT_ENABLED, enabled,
264 is_server_account, NULL);
269 modest_account_mgr_account_get_enabled (ModestAccountMgr *self, const gchar* name,
270 gboolean is_server_account)
272 return modest_account_mgr_get_bool (self, name,
273 MODEST_ACCOUNT_ENABLED, is_server_account,
279 modest_account_mgr_add_account (ModestAccountMgr *self,
281 const gchar *store_account,
282 const gchar *transport_account,
285 ModestAccountMgrPrivate *priv;
289 g_return_val_if_fail (self, FALSE);
290 g_return_val_if_fail (name, FALSE);
292 if (modest_account_mgr_account_exists (self, name, FALSE, err)) {
293 g_printerr ("modest: account already exists\n");
298 * we create the account by adding an account 'dir', with the name <name>,
299 * and in that the 'display_name' string key
301 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
303 key = get_account_keyname (name, MODEST_ACCOUNT_DISPLAY_NAME, FALSE);
304 ok = modest_conf_set_string (priv->modest_conf, key, name, err);
308 g_printerr ("modest: cannot set display name\n");
313 key = get_account_keyname (name, MODEST_ACCOUNT_STORE_ACCOUNT, FALSE);
314 ok = modest_conf_set_string (priv->modest_conf, key, store_account, err);
317 g_printerr ("modest: failed to set store account '%s'\n",
323 if (transport_account) {
324 key = get_account_keyname (name, MODEST_ACCOUNT_TRANSPORT_ACCOUNT, FALSE);
325 ok = modest_conf_set_string (priv->modest_conf, key, transport_account, err);
328 g_printerr ("modest: failed to set transport account '%s'\n",
334 modest_account_mgr_account_set_enabled (self, name, FALSE, TRUE);
343 modest_account_mgr_add_server_account (ModestAccountMgr * self,
345 const gchar * hostname,
346 const gchar * username,
347 const gchar * password,
350 ModestAccountMgrPrivate *priv;
353 g_return_val_if_fail (self, FALSE);
354 g_return_val_if_fail (name, FALSE);
356 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
358 key = get_account_keyname (name, NULL, TRUE);
359 if (modest_conf_key_exists (priv->modest_conf, key, NULL)) {
360 g_printerr ("modest: server account '%s' already exists", name);
367 key = get_account_keyname (name, MODEST_ACCOUNT_HOSTNAME, TRUE);
368 modest_conf_set_string (priv->modest_conf, key, null_means_empty(hostname), NULL);
372 key = get_account_keyname (name, MODEST_ACCOUNT_USERNAME, TRUE);
373 modest_conf_set_string (priv->modest_conf, key, null_means_empty (username), NULL);
377 key = get_account_keyname (name, MODEST_ACCOUNT_PASSWORD, TRUE);
378 modest_conf_set_string (priv->modest_conf, key, null_means_empty (password), NULL);
382 key = get_account_keyname (name, MODEST_ACCOUNT_PROTO, TRUE);
383 modest_conf_set_string (priv->modest_conf, key, null_means_empty (proto), NULL);
387 modest_account_mgr_account_set_enabled (self, name, TRUE, TRUE);
395 modest_account_mgr_remove_account (ModestAccountMgr * self,
397 gboolean server_account,
400 ModestAccountMgrPrivate *priv;
404 g_return_val_if_fail (self, FALSE);
405 g_return_val_if_fail (name, FALSE);
407 if (!modest_account_mgr_account_exists (self, name, server_account, err)) {
408 g_printerr ("modest: account '%s' does not exist\n", name);
412 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
413 key = get_account_keyname (name, NULL, server_account);
415 retval = modest_conf_remove_key (priv->modest_conf, key, NULL);
423 /* strip the first /n/ character from each element */
424 /* caller must make sure all elements are strings with
425 * length >= n, and also that data can be freed.
428 strip_prefix_from_elements (GSList * lst, guint n)
430 GSList *cursor = lst;
433 gchar *str = (gchar *) cursor->data;
434 cursor->data = g_strdup (str + n);
436 cursor = cursor->next;
443 modest_account_mgr_search_server_accounts (ModestAccountMgr * self,
444 const gchar * account_name,
445 ModestProtoType type,
447 gboolean only_enabled)
451 ModestAccountMgrPrivate *priv;
455 g_return_val_if_fail (self, NULL);
457 key = get_account_keyname (account_name, NULL, TRUE);
458 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
460 /* get the list of all server accounts */
461 accounts = modest_conf_list_subkeys (priv->modest_conf, key, &err);
464 g_printerr ("modest: failed to get subkeys for '%s'\n", key);
468 /* no restrictions, return everything */
469 if (type == MODEST_PROTO_TYPE_ANY && !proto)
470 return strip_prefix_from_elements (accounts, strlen(key)+1);
471 /* +1 because we must remove the ending '/' as well */
473 /* otherwise, filter out the none-matching ones */
480 account = account_from_key ((gchar*)cursor->data, NULL, NULL);
482 enabled = modest_account_mgr_account_get_enabled (self, account, TRUE);
483 acc_proto = modest_account_mgr_get_string (self, account, MODEST_ACCOUNT_PROTO,
485 if ((!acc_proto) || /* proto not defined? */
486 (type != MODEST_PROTO_TYPE_ANY && /* proto type ... */
487 modest_proto_type (acc_proto) != type) || /* ... matches? */
488 (proto && strcmp (proto, acc_proto) != 0) || /* proto matches? */
489 (!enabled && only_enabled)) { /* account enabled? */
490 /* match! remove from the list */
491 GSList *nxt = cursor->next;
492 accounts = g_slist_delete_link (accounts, cursor);
495 cursor = cursor->next;
501 return strip_prefix_from_elements (accounts, strlen(key)+1);
502 /* +1 because we must remove the ending '/' as well */
507 modest_account_mgr_account_names (ModestAccountMgr * self, GError ** err)
510 ModestAccountMgrPrivate *priv;
511 const size_t prefix_len = strlen (MODEST_ACCOUNT_NAMESPACE "/");
514 g_return_val_if_fail (self, NULL);
516 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
518 accounts = modest_conf_list_subkeys (priv->modest_conf,
519 MODEST_ACCOUNT_NAMESPACE, err);
520 return strip_prefix_from_elements (accounts, prefix_len);
525 modest_account_mgr_get_string (ModestAccountMgr *self, const gchar *name,
526 const gchar *key, gboolean server_account, GError **err) {
528 ModestAccountMgrPrivate *priv;
533 g_return_val_if_fail (self, NULL);
534 g_return_val_if_fail (name, NULL);
535 g_return_val_if_fail (key, NULL);
537 keyname = get_account_keyname (name, key, server_account);
539 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
540 retval = modest_conf_get_string (priv->modest_conf, keyname, err);
548 modest_account_mgr_get_int (ModestAccountMgr *self, const gchar *name,
549 const gchar *key, gboolean server_account, GError **err)
551 ModestAccountMgrPrivate *priv;
556 g_return_val_if_fail (self, -1);
557 g_return_val_if_fail (name, -1);
558 g_return_val_if_fail (key, -1);
560 keyname = get_account_keyname (name, key, server_account);
562 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
563 retval = modest_conf_get_int (priv->modest_conf, keyname, err);
572 modest_account_mgr_get_bool (ModestAccountMgr * self, const gchar *account,
573 const gchar * key, gboolean server_account, GError ** err)
575 ModestAccountMgrPrivate *priv;
580 g_return_val_if_fail (self, FALSE);
581 g_return_val_if_fail (account, FALSE);
582 g_return_val_if_fail (key, FALSE);
584 keyname = get_account_keyname (account, key, server_account);
586 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
587 retval = modest_conf_get_bool (priv->modest_conf, keyname, err);
596 modest_account_mgr_set_string (ModestAccountMgr * self, const gchar * name,
597 const gchar * key, const gchar * val,
598 gboolean server_account, GError ** err)
600 ModestAccountMgrPrivate *priv;
605 g_return_val_if_fail (self, FALSE);
606 g_return_val_if_fail (name, FALSE);
607 g_return_val_if_fail (key, FALSE);
609 keyname = get_account_keyname (name, key, server_account);
611 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
613 retval = modest_conf_set_string (priv->modest_conf, keyname, val,
622 modest_account_mgr_set_int (ModestAccountMgr * self, const gchar * name,
623 const gchar * key, int val, gboolean server_account,
626 ModestAccountMgrPrivate *priv;
631 g_return_val_if_fail (self, FALSE);
632 g_return_val_if_fail (name, FALSE);
633 g_return_val_if_fail (key, FALSE);
635 keyname = get_account_keyname (name, key, server_account);
637 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
639 retval = modest_conf_set_int (priv->modest_conf, keyname, val, err);
648 modest_account_mgr_set_bool (ModestAccountMgr * self, const gchar * name,
649 const gchar * key, gboolean val, gboolean server_account,
652 ModestAccountMgrPrivate *priv;
657 g_return_val_if_fail (self, FALSE);
658 g_return_val_if_fail (name, FALSE);
659 g_return_val_if_fail (key, FALSE);
661 keyname = get_account_keyname (name, key, server_account);
663 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
665 retval = modest_conf_set_bool (priv->modest_conf, keyname, val, err);
673 modest_account_mgr_account_exists (ModestAccountMgr * self, const gchar * name,
674 gboolean server_account, GError ** err)
676 ModestAccountMgrPrivate *priv;
681 g_return_val_if_fail (self, FALSE);
682 g_return_val_if_fail (name, FALSE);
684 keyname = get_account_keyname (name, NULL, server_account);
686 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
687 retval = modest_conf_key_exists (priv->modest_conf, keyname, err);
694 /* must be freed by caller */
696 get_account_keyname (const gchar * accname, const gchar * name, gboolean server_account)
698 gchar *namespace, *account_name, *retval;
700 namespace = server_account ? MODEST_SERVER_ACCOUNT_NAMESPACE : MODEST_ACCOUNT_NAMESPACE;
703 return g_strdup (namespace);
705 account_name = modest_conf_key_escape (NULL, accname);
708 retval = g_strconcat (namespace, "/", accname, "/", name, NULL);
710 retval = g_strconcat (namespace, "/", accname, NULL);
712 g_free (account_name);