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 /* account was removed -- emit this, even if the account was disabled */
124 if (is_account_key && event == MODEST_CONF_EVENT_KEY_UNSET) {
125 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_REMOVED_SIGNAL], 0,
126 account, is_server_account);
131 /* is this account enabled? */
132 enabled = modest_account_mgr_account_is_enabled (self, account,
135 /* account was changed.
136 * and always notify when enabled/disabled changes
138 if (enabled || g_str_has_suffix (key, MODEST_ACCOUNT_ENABLED))
139 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_CHANGED_SIGNAL], 0,
140 account, key, is_server_account);
147 modest_account_mgr_get_type (void)
149 static GType my_type = 0;
152 static const GTypeInfo my_info = {
153 sizeof (ModestAccountMgrClass),
154 NULL, /* base init */
155 NULL, /* base finalize */
156 (GClassInitFunc) modest_account_mgr_class_init,
157 NULL, /* class finalize */
158 NULL, /* class data */
159 sizeof (ModestAccountMgr),
161 (GInstanceInitFunc) modest_account_mgr_init,
164 my_type = g_type_register_static (G_TYPE_OBJECT,
172 modest_account_mgr_class_init (ModestAccountMgrClass * klass)
174 GObjectClass *gobject_class;
175 GType paramtypes[3] = {G_TYPE_POINTER, G_TYPE_POINTER, G_TYPE_POINTER};
177 gobject_class = (GObjectClass *) klass;
179 parent_class = g_type_class_peek_parent (klass);
180 gobject_class->finalize = modest_account_mgr_finalize;
182 g_type_class_add_private (gobject_class,
183 sizeof (ModestAccountMgrPrivate));
185 /* signal definitions */
186 signals[ACCOUNT_REMOVED_SIGNAL] =
187 g_signal_new ("account_removed",
188 G_TYPE_FROM_CLASS (klass),
190 G_STRUCT_OFFSET(ModestAccountMgrClass,account_removed),
192 modest_marshal_VOID__STRING_BOOLEAN,
193 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_BOOLEAN);
194 signals[ACCOUNT_CHANGED_SIGNAL] =
195 g_signal_new ("account_changed",
196 G_TYPE_FROM_CLASS (klass),
198 G_STRUCT_OFFSET(ModestAccountMgrClass,account_changed),
200 modest_marshal_VOID__STRING_STRING_BOOLEAN,
201 G_TYPE_NONE, 3, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_BOOLEAN);
206 modest_account_mgr_init (ModestAccountMgr * obj)
208 ModestAccountMgrPrivate *priv =
209 MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
211 priv->modest_conf = NULL;
215 modest_account_mgr_finalize (GObject * obj)
217 ModestAccountMgrPrivate *priv =
218 MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
220 priv->modest_conf = NULL;
224 modest_account_mgr_new (ModestConf * conf)
227 ModestAccountMgrPrivate *priv;
229 g_return_val_if_fail (conf, NULL);
231 obj = G_OBJECT (g_object_new (MODEST_TYPE_ACCOUNT_MGR, NULL));
232 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
234 priv->modest_conf = conf;
236 g_signal_connect (G_OBJECT (conf), "key_changed",
237 G_CALLBACK (on_key_change),
244 null_means_empty (const gchar * str)
246 return str ? str : "";
252 modest_account_mgr_disable_account (ModestAccountMgr *self, const gchar* name,
253 gboolean is_server_account)
255 return modest_account_mgr_set_bool (self, name,
256 MODEST_ACCOUNT_ENABLED, FALSE,
257 is_server_account, NULL);
262 modest_account_mgr_enable_account (ModestAccountMgr *self, const gchar* name,
263 gboolean is_server_account)
265 return modest_account_mgr_set_bool (self, name,
266 MODEST_ACCOUNT_ENABLED, TRUE,
267 is_server_account, NULL);
272 modest_account_mgr_account_is_enabled (ModestAccountMgr *self, const gchar* name,
273 gboolean is_server_account)
275 return modest_account_mgr_get_bool (self, name,
276 MODEST_ACCOUNT_ENABLED, is_server_account,
282 modest_account_mgr_add_account (ModestAccountMgr *self,
284 const gchar *store_account,
285 const gchar *transport_account,
288 ModestAccountMgrPrivate *priv;
292 g_return_val_if_fail (self, FALSE);
293 g_return_val_if_fail (name, FALSE);
295 if (modest_account_mgr_account_exists (self, name, FALSE, err)) {
296 g_printerr ("modest: account already exists\n");
301 * we create the account by adding an account 'dir', with the name <name>,
302 * and in that the 'display_name' string key
304 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
306 key = get_account_keyname (name, MODEST_ACCOUNT_DISPLAY_NAME, FALSE);
307 ok = modest_conf_set_string (priv->modest_conf, key, name, err);
311 g_printerr ("modest: cannot set display name\n");
316 key = get_account_keyname (name, MODEST_ACCOUNT_STORE_ACCOUNT, FALSE);
317 ok = modest_conf_set_string (priv->modest_conf, key, store_account, err);
320 g_printerr ("modest: failed to set store account '%s'\n",
326 if (transport_account) {
327 key = get_account_keyname (name, MODEST_ACCOUNT_TRANSPORT_ACCOUNT, FALSE);
328 ok = modest_conf_set_string (priv->modest_conf, key, transport_account, err);
331 g_printerr ("modest: failed to set transport account '%s'\n",
337 modest_account_mgr_enable_account (self, name, FALSE);
346 modest_account_mgr_add_server_account (ModestAccountMgr * self,
348 const gchar * hostname,
349 const gchar * username,
350 const gchar * password,
353 ModestAccountMgrPrivate *priv;
356 g_return_val_if_fail (self, FALSE);
357 g_return_val_if_fail (name, FALSE);
359 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
361 key = get_account_keyname (name, NULL, TRUE);
362 if (modest_conf_key_exists (priv->modest_conf, key, NULL)) {
363 g_printerr ("modest: server account '%s' already exists", name);
370 key = get_account_keyname (name, MODEST_ACCOUNT_HOSTNAME, TRUE);
371 modest_conf_set_string (priv->modest_conf, key, null_means_empty(hostname), NULL);
375 key = get_account_keyname (name, MODEST_ACCOUNT_USERNAME, TRUE);
376 modest_conf_set_string (priv->modest_conf, key, null_means_empty (username), NULL);
380 key = get_account_keyname (name, MODEST_ACCOUNT_PASSWORD, TRUE);
381 modest_conf_set_string (priv->modest_conf, key, null_means_empty (password), NULL);
385 key = get_account_keyname (name, MODEST_ACCOUNT_PROTO, TRUE);
386 modest_conf_set_string (priv->modest_conf, key, null_means_empty (proto), NULL);
390 modest_account_mgr_enable_account (self, name, TRUE);
398 modest_account_mgr_remove_account (ModestAccountMgr * self,
400 gboolean server_account,
403 ModestAccountMgrPrivate *priv;
407 g_return_val_if_fail (self, FALSE);
408 g_return_val_if_fail (name, FALSE);
410 if (!modest_account_mgr_account_exists (self, name, server_account, err)) {
411 g_printerr ("modest: account '%s' does not exist\n", name);
415 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
416 key = get_account_keyname (name, NULL, server_account);
418 retval = modest_conf_remove_key (priv->modest_conf, key, NULL);
426 /* strip the first /n/ character from each element */
427 /* caller must make sure all elements are strings with
428 * length >= n, and also that data can be freed.
431 strip_prefix_from_elements (GSList * lst, guint n)
433 GSList *cursor = lst;
436 gchar *str = (gchar *) cursor->data;
437 cursor->data = g_strdup (str + n);
439 cursor = cursor->next;
446 modest_account_mgr_search_server_accounts (ModestAccountMgr * self,
447 const gchar * account_name,
448 ModestProtoType type,
450 gboolean only_enabled)
454 ModestAccountMgrPrivate *priv;
458 g_return_val_if_fail (self, NULL);
460 key = get_account_keyname (account_name, NULL, TRUE);
461 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
463 /* get the list of all server accounts */
464 accounts = modest_conf_list_subkeys (priv->modest_conf, key, &err);
467 g_printerr ("modest: failed to get subkeys for '%s'\n", key);
471 /* no restrictions, return everything */
472 if (type == MODEST_PROTO_TYPE_ANY && !proto)
473 return strip_prefix_from_elements (accounts, strlen(key)+1);
474 /* +1 because we must remove the ending '/' as well */
476 /* otherwise, filter out the none-matching ones */
483 account = account_from_key ((gchar*)cursor->data, NULL, NULL);
485 enabled = modest_account_mgr_account_is_enabled (self, account, TRUE);
486 acc_proto = modest_account_mgr_get_string (self, account, MODEST_ACCOUNT_PROTO,
488 if ((!acc_proto) || /* proto not defined? */
489 (type != MODEST_PROTO_TYPE_ANY && /* proto type ... */
490 modest_proto_type (acc_proto) != type) || /* ... matches? */
491 (proto && strcmp (proto, acc_proto) != 0) || /* proto matches? */
492 (!enabled && only_enabled)) { /* account enabled? */
493 /* match! remove from the list */
494 GSList *nxt = cursor->next;
495 accounts = g_slist_delete_link (accounts, cursor);
498 cursor = cursor->next;
504 return strip_prefix_from_elements (accounts, strlen(key)+1);
505 /* +1 because we must remove the ending '/' as well */
510 modest_account_mgr_account_names (ModestAccountMgr * self, GError ** err)
513 ModestAccountMgrPrivate *priv;
514 const size_t prefix_len = strlen (MODEST_ACCOUNT_NAMESPACE "/");
517 g_return_val_if_fail (self, NULL);
519 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
521 accounts = modest_conf_list_subkeys (priv->modest_conf,
522 MODEST_ACCOUNT_NAMESPACE, err);
523 return strip_prefix_from_elements (accounts, prefix_len);
528 modest_account_mgr_get_string (ModestAccountMgr *self, const gchar *name,
529 const gchar *key, gboolean server_account, GError **err) {
531 ModestAccountMgrPrivate *priv;
536 g_return_val_if_fail (self, NULL);
537 g_return_val_if_fail (name, NULL);
538 g_return_val_if_fail (key, NULL);
540 keyname = get_account_keyname (name, key, server_account);
542 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
543 retval = modest_conf_get_string (priv->modest_conf, keyname, err);
551 modest_account_mgr_get_int (ModestAccountMgr *self, const gchar *name,
552 const gchar *key, gboolean server_account, GError **err)
554 ModestAccountMgrPrivate *priv;
559 g_return_val_if_fail (self, -1);
560 g_return_val_if_fail (name, -1);
561 g_return_val_if_fail (key, -1);
563 keyname = get_account_keyname (name, key, server_account);
565 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
566 retval = modest_conf_get_int (priv->modest_conf, keyname, err);
575 modest_account_mgr_get_bool (ModestAccountMgr * self, const gchar *account,
576 const gchar * key, gboolean server_account, GError ** err)
578 ModestAccountMgrPrivate *priv;
583 g_return_val_if_fail (self, FALSE);
584 g_return_val_if_fail (account, FALSE);
585 g_return_val_if_fail (key, FALSE);
587 keyname = get_account_keyname (account, key, server_account);
589 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
590 retval = modest_conf_get_bool (priv->modest_conf, keyname, err);
599 modest_account_mgr_set_string (ModestAccountMgr * self, const gchar * name,
600 const gchar * key, const gchar * val,
601 gboolean server_account, GError ** err)
603 ModestAccountMgrPrivate *priv;
608 g_return_val_if_fail (self, FALSE);
609 g_return_val_if_fail (name, FALSE);
610 g_return_val_if_fail (key, FALSE);
612 keyname = get_account_keyname (name, key, server_account);
614 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
616 retval = modest_conf_set_string (priv->modest_conf, keyname, val,
625 modest_account_mgr_set_int (ModestAccountMgr * self, const gchar * name,
626 const gchar * key, int val, gboolean server_account,
629 ModestAccountMgrPrivate *priv;
634 g_return_val_if_fail (self, FALSE);
635 g_return_val_if_fail (name, FALSE);
636 g_return_val_if_fail (key, FALSE);
638 keyname = get_account_keyname (name, key, server_account);
640 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
642 retval = modest_conf_set_int (priv->modest_conf, keyname, val, err);
651 modest_account_mgr_set_bool (ModestAccountMgr * self, const gchar * name,
652 const gchar * key, gboolean val, gboolean server_account,
655 ModestAccountMgrPrivate *priv;
660 g_return_val_if_fail (self, FALSE);
661 g_return_val_if_fail (name, FALSE);
662 g_return_val_if_fail (key, FALSE);
664 keyname = get_account_keyname (name, key, server_account);
666 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
668 retval = modest_conf_set_bool (priv->modest_conf, keyname, val, err);
676 modest_account_mgr_account_exists (ModestAccountMgr * self, const gchar * name,
677 gboolean server_account, GError ** err)
679 ModestAccountMgrPrivate *priv;
684 g_return_val_if_fail (self, FALSE);
685 g_return_val_if_fail (name, FALSE);
687 keyname = get_account_keyname (name, NULL, server_account);
689 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
690 retval = modest_conf_key_exists (priv->modest_conf, keyname, err);
697 /* must be freed by caller */
699 get_account_keyname (const gchar * accname, const gchar * name, gboolean server_account)
701 gchar *namespace, *account_name, *retval;
703 namespace = server_account ? MODEST_SERVER_ACCOUNT_NAMESPACE : MODEST_ACCOUNT_NAMESPACE;
706 return g_strdup (namespace);
708 account_name = modest_conf_key_escape (NULL, accname);
711 retval = g_strconcat (namespace, "/", accname, "/", name, NULL);
713 retval = g_strconcat (namespace, "/", accname, NULL);
715 g_free (account_name);