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 /* modest-account-mgr.c */
34 #include "modest-marshal.h"
35 #include "modest-account-keys.h"
36 #include "modest-account-mgr.h"
38 /* 'private'/'protected' functions */
39 static void modest_account_mgr_class_init (ModestAccountMgrClass * klass);
40 static void modest_account_mgr_init (ModestAccountMgr * obj);
41 static void modest_account_mgr_finalize (GObject * obj);
43 static gchar *get_account_keyname (const gchar * accname, const gchar * name);
44 static gchar *get_server_account_keyname (const gchar * accname,
49 ACCOUNT_CHANGE_SIGNAL,
50 ACCOUNT_REMOVE_SIGNAL,
55 typedef struct _ModestAccountMgrPrivate ModestAccountMgrPrivate;
56 struct _ModestAccountMgrPrivate {
57 ModestConf *modest_conf;
58 GSList *current_accounts;
61 #define MODEST_ACCOUNT_MGR_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
62 MODEST_TYPE_ACCOUNT_MGR, \
63 ModestAccountMgrPrivate))
65 static GObjectClass *parent_class = NULL;
67 static guint signals[LAST_SIGNAL] = {0};
71 delete_account_from_list (GSList *list, const gchar *name)
73 GSList *iter, *result;
78 if (!strcmp (name, iter->data)) {
79 result = g_slist_delete_link (list, iter);
83 iter = g_slist_next (iter);
89 find_account_in_list (GSList *list, const gchar *name)
91 GSList *iter, *result;
96 if (!strcmp (name, iter->data)) {
101 iter = g_slist_next (iter);
106 /* Map configuration changes to account changes.
107 * Doing this here makes sure all changes are available and external changes
108 * are covered as well. */
111 modest_account_mgr_check_change (ModestConf *conf, const gchar *key,
112 const gchar *new_value, gpointer user_data)
114 ModestAccountMgr *amgr = user_data;
115 ModestAccountMgrPrivate *priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (amgr);
117 if ((strlen (key) > strlen (MODEST_SERVER_ACCOUNT_NAMESPACE "/")
118 && g_str_has_prefix (key, MODEST_SERVER_ACCOUNT_NAMESPACE))) {
119 gchar *subkey = g_strdup(key + strlen (MODEST_SERVER_ACCOUNT_NAMESPACE "/"));
121 if (! strstr (subkey, "/")) { /* no more '/' means an account was modified */
123 priv->current_accounts =
124 delete_account_from_list (priv->current_accounts, subkey);
126 g_signal_emit (amgr, signals[ACCOUNT_REMOVE_SIGNAL], 0, subkey);
132 param = strstr (subkey, "/");
136 /* that's the second case for a new account */
137 if (!find_account_in_list (priv->current_accounts, subkey) && strstr (param, MODEST_ACCOUNT_PROTO)) {
138 priv->current_accounts =
139 g_slist_prepend (priv->current_accounts, g_strdup (subkey));
140 g_signal_emit (amgr, signals[ACCOUNT_ADD_SIGNAL], 0, subkey);
143 g_signal_emit (amgr, signals[ACCOUNT_CHANGE_SIGNAL], 0, subkey, param, new_value);
152 modest_account_mgr_get_type (void)
154 static GType my_type = 0;
157 static const GTypeInfo my_info = {
158 sizeof (ModestAccountMgrClass),
159 NULL, /* base init */
160 NULL, /* base finalize */
161 (GClassInitFunc) modest_account_mgr_class_init,
162 NULL, /* class finalize */
163 NULL, /* class data */
164 sizeof (ModestAccountMgr),
166 (GInstanceInitFunc) modest_account_mgr_init,
169 my_type = g_type_register_static (G_TYPE_OBJECT,
177 modest_account_mgr_class_init (ModestAccountMgrClass * klass)
179 GObjectClass *gobject_class;
180 GType paramtypes[3] = {G_TYPE_POINTER, G_TYPE_POINTER, G_TYPE_POINTER};
182 gobject_class = (GObjectClass *) klass;
184 parent_class = g_type_class_peek_parent (klass);
185 gobject_class->finalize = modest_account_mgr_finalize;
187 g_type_class_add_private (gobject_class,
188 sizeof (ModestAccountMgrPrivate));
190 /* signal definitions */
191 signals[ACCOUNT_ADD_SIGNAL] =
192 g_signal_newv ("account-add",
193 G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
195 g_cclosure_marshal_VOID__POINTER,
196 G_TYPE_NONE, 1, paramtypes);
198 signals[ACCOUNT_REMOVE_SIGNAL] =
199 g_signal_newv ("account-remove",
200 G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
202 g_cclosure_marshal_VOID__POINTER,
203 G_TYPE_NONE, 1, paramtypes);
204 signals[ACCOUNT_CHANGE_SIGNAL] =
205 g_signal_newv ("account-change",
206 G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
208 modest_marshal_VOID__POINTER_POINTER_POINTER,
209 G_TYPE_NONE, 3, paramtypes);
214 modest_account_mgr_init (ModestAccountMgr * obj)
216 ModestAccountMgrPrivate *priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
218 priv->modest_conf = NULL;
222 modest_account_mgr_finalize (GObject * obj)
224 ModestAccountMgr *self = MODEST_ACCOUNT_MGR (obj);
225 ModestAccountMgrPrivate *priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
227 if (priv->modest_conf) {
228 g_object_unref (G_OBJECT(priv->modest_conf));
229 priv->modest_conf = NULL;
234 modest_account_mgr_new (ModestConf * conf)
237 ModestAccountMgrPrivate *priv;
239 g_return_val_if_fail (conf, NULL);
241 obj = G_OBJECT (g_object_new (MODEST_TYPE_ACCOUNT_MGR, NULL));
242 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
245 * increase the ref count on the modest_conf. Normally, the
246 * ModestConf should outlive the ModestAccountMgr though
248 g_object_ref (G_OBJECT (priv->modest_conf = conf));
250 priv->current_accounts = modest_account_mgr_account_names (MODEST_ACCOUNT_MGR(obj), NULL);
252 g_signal_connect (G_OBJECT (conf), "key-changed",
253 G_CALLBACK (modest_account_mgr_check_change), obj);
259 modest_account_mgr_add_account (ModestAccountMgr * self, const gchar * name,
260 const gchar * store_account,
261 const gchar * transport_account,
264 ModestAccountMgrPrivate *priv;
267 g_return_val_if_fail (self, FALSE);
268 g_return_val_if_fail (name, FALSE);
270 if (modest_account_mgr_account_exists (self, name, err)) {
271 g_warning ("account already exists");
275 * we create the account by adding an account 'dir', with the name <name>,
276 * and in that the 'display_name' string key
278 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
280 key = get_account_keyname (name, MODEST_ACCOUNT_DISPLAY_NAME);
281 modest_conf_set_string (priv->modest_conf, key, name, err);
285 key = get_account_keyname (name,
286 MODEST_ACCOUNT_STORE_ACCOUNT);
287 modest_conf_set_string (priv->modest_conf, key, store_account,
292 if (transport_account) {
293 key = get_account_keyname (name,
294 MODEST_ACCOUNT_TRANSPORT_ACCOUNT);
295 modest_conf_set_string (priv->modest_conf, key,
296 transport_account, err);
300 return TRUE; /* TODO: error handling */
305 modest_account_mgr_remove_account (ModestAccountMgr * self,
306 const gchar * name, GError ** err)
308 ModestAccountMgrPrivate *priv;
312 g_return_val_if_fail (self, FALSE);
313 g_return_val_if_fail (name, FALSE);
315 if (!modest_account_mgr_account_exists (self, name, err)) {
316 g_warning ("account doest not exist");
320 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
321 key = get_account_keyname (name, NULL);
323 retval = modest_conf_remove_key (priv->modest_conf, key, NULL);
331 null_means_empty (const gchar * str)
333 return str ? str : "";
338 modest_account_mgr_add_server_account (ModestAccountMgr * self,
340 const gchar * hostname,
341 const gchar * username,
342 const gchar * password,
345 ModestAccountMgrPrivate *priv;
348 g_return_val_if_fail (self, FALSE);
349 g_return_val_if_fail (name, FALSE);
351 /* TODO: check already exists */
353 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
354 acckey = g_strconcat (MODEST_SERVER_ACCOUNT_NAMESPACE, "/",
357 if (modest_conf_key_exists (priv->modest_conf, acckey, NULL)) {
358 g_warning ("server account %s already exists", name);
364 key = g_strconcat (acckey, "/", MODEST_ACCOUNT_HOSTNAME, NULL);
365 modest_conf_set_string (priv->modest_conf, key,
366 null_means_empty (hostname), NULL);
370 key = g_strconcat (acckey, "/", MODEST_ACCOUNT_USERNAME, NULL);
371 modest_conf_set_string (priv->modest_conf, key,
372 null_means_empty (username), NULL);
377 key = g_strconcat (acckey, "/", MODEST_ACCOUNT_PASSWORD,
379 modest_conf_set_string (priv->modest_conf, key,
380 null_means_empty (password), NULL);
385 key = g_strconcat (acckey, "/", MODEST_ACCOUNT_PROTO, NULL);
386 modest_conf_set_string (priv->modest_conf, key,
387 null_means_empty (proto), NULL);
391 return TRUE; /* FIXME: better error checking */
395 modest_account_mgr_remove_server_account (ModestAccountMgr * self,
396 const gchar * name, GError ** err)
398 ModestAccountMgrPrivate *priv;
402 g_return_val_if_fail (self, FALSE);
403 g_return_val_if_fail (name, FALSE);
405 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
407 acckey = g_strconcat (MODEST_SERVER_ACCOUNT_NAMESPACE, "/",
410 if (!modest_conf_key_exists (priv->modest_conf, acckey, NULL)) {
411 g_warning ("server account %s does not exist exist", name);
416 retval = modest_conf_remove_key (priv->modest_conf, acckey, 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;
435 cursor->data = g_strdup (str + n);
437 cursor = cursor->next;
444 modest_account_mgr_server_account_names (ModestAccountMgr * self,
445 const gchar * account_name,
446 ModestProtoType type,
448 gboolean only_enabled)
452 ModestAccountMgrPrivate *priv;
453 const size_t prefix_len =
454 strlen (MODEST_SERVER_ACCOUNT_NAMESPACE "/");
456 g_return_val_if_fail (self, NULL);
458 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
459 accounts = modest_conf_list_subkeys (priv->modest_conf,
460 MODEST_SERVER_ACCOUNT_NAMESPACE,
463 /* no restrictions, return everything */
464 if (type == MODEST_PROTO_TYPE_ANY && !proto)
465 return strip_prefix_from_elements (accounts, prefix_len);
467 /* otherwise, filter out the none-matching ones */
470 gchar *keyspace, *proto_key, *acc_proto;
472 keyspace = (gchar *) cursor->data;
474 g_strconcat (keyspace, "/", MODEST_ACCOUNT_PROTO,
477 modest_conf_get_string (priv->modest_conf, proto_key,
481 if ((!acc_proto) || /* proto not defined? */
482 (type != MODEST_PROTO_TYPE_ANY && /* proto type ... */
483 modest_proto_type (acc_proto) != type) || /* ... matches? */
484 (proto && strcmp (proto, acc_proto) != 0)) { /* proto matches? */
485 /* no match: remove from the list */
486 GSList *nxt = cursor->next;
489 accounts = g_slist_delete_link (accounts, cursor);
492 cursor = cursor->next;
495 return strip_prefix_from_elements (accounts, prefix_len);
500 modest_account_mgr_account_names (ModestAccountMgr * self, GError ** err)
503 ModestAccountMgrPrivate *priv;
504 const size_t prefix_len = strlen (MODEST_ACCOUNT_NAMESPACE "/");
507 g_return_val_if_fail (self, NULL);
509 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
511 accounts = modest_conf_list_subkeys (priv->modest_conf,
512 MODEST_ACCOUNT_NAMESPACE, err);
513 return strip_prefix_from_elements (accounts, prefix_len);
518 get_account_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);
531 keyname = get_server_account_keyname (name, key);
533 keyname = get_account_keyname (name, key);
535 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
536 retval = modest_conf_get_string (priv->modest_conf, keyname, err);
544 modest_account_mgr_get_server_account_string (ModestAccountMgr * self,
549 return get_account_string (self, name, key, TRUE, err);
554 modest_account_mgr_get_account_string (ModestAccountMgr * self,
555 const gchar * name, const gchar * key,
558 return get_account_string (self, name, key, FALSE, err);
563 get_account_int (ModestAccountMgr * self, const gchar * name,
564 const gchar * key, gboolean server_account, GError ** err)
566 ModestAccountMgrPrivate *priv;
571 g_return_val_if_fail (self, -1);
572 g_return_val_if_fail (name, -1);
573 g_return_val_if_fail (key, -1);
576 keyname = get_server_account_keyname (name, key);
578 keyname = get_account_keyname (name, key);
580 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
581 retval = modest_conf_get_int (priv->modest_conf, keyname, err);
589 modest_account_mgr_get_server_account_int (ModestAccountMgr * self,
591 const gchar * key, GError ** err)
593 return get_account_int (self, name, key, TRUE, err);
598 modest_account_mgr_get_account_int (ModestAccountMgr * self,
599 const gchar * name, const gchar * key,
602 return get_account_int (self, name, key, FALSE, err);
607 get_account_bool (ModestAccountMgr * self, const gchar * name,
608 const gchar * key, gboolean server_account, GError ** err)
610 ModestAccountMgrPrivate *priv;
615 g_return_val_if_fail (self, FALSE);
616 g_return_val_if_fail (name, FALSE);
617 g_return_val_if_fail (key, FALSE);
620 keyname = get_server_account_keyname (name, key);
622 keyname = get_account_keyname (name, key);
624 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
625 retval = modest_conf_get_bool (priv->modest_conf, keyname, err);
633 modest_account_mgr_get_server_account_bool (ModestAccountMgr * self,
635 const gchar * key, GError ** err)
637 return get_account_bool (self, name, key, TRUE, err);
642 modest_account_mgr_get_account_bool (ModestAccountMgr * self,
643 const gchar * name, const gchar * key,
646 return get_account_bool (self, name, key, FALSE, err);
651 set_account_string (ModestAccountMgr * self, const gchar * name,
652 const gchar * key, const gchar * val,
653 gboolean server_account, GError ** err)
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);
665 keyname = get_server_account_keyname (name, key);
667 keyname = get_account_keyname (name, key);
669 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
671 retval = modest_conf_set_string (priv->modest_conf, keyname, val,
680 modest_account_mgr_set_server_account_string (ModestAccountMgr * self,
686 return set_account_string (self, name, key, val, TRUE, err);
691 modest_account_mgr_set_account_string (ModestAccountMgr * self,
692 const gchar * name, const gchar * key,
693 const gchar * val, GError ** err)
695 return set_account_string (self, name, key, val, FALSE, err);
700 set_account_int (ModestAccountMgr * self, const gchar * name,
701 const gchar * key, gboolean server_account, int val,
704 ModestAccountMgrPrivate *priv;
709 g_return_val_if_fail (self, FALSE);
710 g_return_val_if_fail (name, FALSE);
711 g_return_val_if_fail (key, FALSE);
714 keyname = get_server_account_keyname (name, key);
716 keyname = get_account_keyname (name, key);
718 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
720 retval = modest_conf_set_int (priv->modest_conf, keyname, val, err);
728 modest_account_mgr_set_server_account_int (ModestAccountMgr * self,
730 const gchar * key, int val,
733 return set_account_int (self, name, key, val, TRUE, err);
738 modest_account_mgr_set_account_int (ModestAccountMgr * self,
739 const gchar * name, const gchar * key,
740 int val, GError ** err)
742 return set_account_int (self, name, key, val, FALSE, err);
747 set_account_bool (ModestAccountMgr * self, const gchar * name,
748 const gchar * key, gboolean server_account, gboolean val,
751 ModestAccountMgrPrivate *priv;
756 g_return_val_if_fail (self, FALSE);
757 g_return_val_if_fail (name, FALSE);
758 g_return_val_if_fail (key, FALSE);
761 keyname = get_server_account_keyname (name, key);
763 keyname = get_account_keyname (name, key);
765 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
767 retval = modest_conf_set_bool (priv->modest_conf, keyname, val, err);
775 modest_account_mgr_set_server_account_bool (ModestAccountMgr * self,
777 const gchar * key, gboolean val,
780 return set_account_bool (self, name, key, val, TRUE, err);
785 modest_account_mgr_set_account_bool (ModestAccountMgr * self,
786 const gchar * name, const gchar * key,
787 gboolean val, GError ** err)
789 return set_account_bool (self, name, key, val, FALSE, err);
794 account_exists (ModestAccountMgr * self, const gchar * name,
795 gboolean server_account, GError ** err)
797 ModestAccountMgrPrivate *priv;
802 g_return_val_if_fail (self, FALSE);
803 g_return_val_if_fail (name, FALSE);
806 keyname = get_server_account_keyname (name, NULL);
808 keyname = get_account_keyname (name, NULL);
810 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
811 retval = modest_conf_key_exists (priv->modest_conf, keyname, err);
819 modest_account_mgr_server_account_exists (ModestAccountMgr * self,
820 const gchar * name, GError ** err)
822 return account_exists (self, name, TRUE, err);
827 modest_account_mgr_account_exists (ModestAccountMgr * self,
828 const gchar * name, GError ** err)
830 return account_exists (self, name, FALSE, err);
834 /* must be freed by caller */
836 get_account_keyname (const gchar * accname, const gchar * name)
840 (MODEST_ACCOUNT_NAMESPACE, "/",
841 accname, "/", name, NULL);
844 (MODEST_ACCOUNT_NAMESPACE, "/", accname, NULL);
848 /* must be freed by caller */
850 get_server_account_keyname (const gchar * accname, const gchar * name)
854 (MODEST_SERVER_ACCOUNT_NAMESPACE, "/",
855 accname, "/", name, NULL);
858 (MODEST_SERVER_ACCOUNT_NAMESPACE, "/", accname, NULL);