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-proto.h"
32 #include "modest-marshal.h"
33 #include "modest-account-keys.h"
34 #include "modest-account-mgr.h"
36 /* 'private'/'protected' functions */
37 static void modest_account_mgr_class_init (ModestAccountMgrClass * klass);
38 static void modest_account_mgr_init (ModestAccountMgr * obj);
39 static void modest_account_mgr_finalize (GObject * obj);
41 static gchar *get_account_keyname (const gchar * accname, const gchar * name,
42 gboolean server_account);
46 ACCOUNT_CHANGED_SIGNAL,
47 ACCOUNT_REMOVED_SIGNAL,
51 typedef struct _ModestAccountMgrPrivate ModestAccountMgrPrivate;
52 struct _ModestAccountMgrPrivate {
53 ModestConf *modest_conf;
54 ModestProtocolMgr *proto_mgr;
57 #define MODEST_ACCOUNT_MGR_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
58 MODEST_TYPE_ACCOUNT_MGR, \
59 ModestAccountMgrPrivate))
61 static GObjectClass *parent_class = NULL;
62 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 whether 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,
171 my_type = g_type_register_static (G_TYPE_OBJECT,
179 modest_account_mgr_class_init (ModestAccountMgrClass * klass)
181 GObjectClass *gobject_class;
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_REMOVED_SIGNAL] =
192 g_signal_new ("account_removed",
193 G_TYPE_FROM_CLASS (klass),
195 G_STRUCT_OFFSET(ModestAccountMgrClass,account_removed),
197 modest_marshal_VOID__STRING_BOOLEAN,
198 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_BOOLEAN);
199 signals[ACCOUNT_CHANGED_SIGNAL] =
200 g_signal_new ("account_changed",
201 G_TYPE_FROM_CLASS (klass),
203 G_STRUCT_OFFSET(ModestAccountMgrClass,account_changed),
205 modest_marshal_VOID__STRING_STRING_BOOLEAN,
206 G_TYPE_NONE, 3, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_BOOLEAN);
211 modest_account_mgr_init (ModestAccountMgr * obj)
213 ModestAccountMgrPrivate *priv =
214 MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
216 priv->modest_conf = NULL;
217 priv->proto_mgr = modest_protocol_mgr_new ();
221 modest_account_mgr_finalize (GObject * obj)
223 ModestAccountMgrPrivate *priv =
224 MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
226 if (priv->modest_conf) {
227 g_object_unref (G_OBJECT(priv->modest_conf));
228 priv->modest_conf = NULL;
231 if (priv->proto_mgr) {
232 g_object_unref (G_OBJECT(priv->proto_mgr));
233 priv->proto_mgr = NULL;
236 G_OBJECT_CLASS(parent_class)->finalize (obj);
240 modest_account_mgr_new (ModestConf * conf)
243 ModestAccountMgrPrivate *priv;
245 g_return_val_if_fail (conf, NULL);
247 obj = G_OBJECT (g_object_new (MODEST_TYPE_ACCOUNT_MGR, NULL));
248 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
250 g_object_ref (G_OBJECT(conf));
251 priv->modest_conf = conf;
253 g_signal_connect (G_OBJECT (conf), "key_changed",
254 G_CALLBACK (on_key_change),
257 return MODEST_ACCOUNT_MGR (obj);
262 null_means_empty (const gchar * str)
264 return str ? str : "";
269 modest_account_mgr_account_set_enabled (ModestAccountMgr *self, const gchar* name,
272 return modest_account_mgr_set_bool (self, name,
273 MODEST_ACCOUNT_ENABLED, enabled,
279 modest_account_mgr_account_get_enabled (ModestAccountMgr *self, const gchar* name)
281 return modest_account_mgr_get_bool (self, name,
282 MODEST_ACCOUNT_ENABLED, FALSE,
288 modest_account_mgr_add_account (ModestAccountMgr *self,
290 const gchar *store_account,
291 const gchar *transport_account,
294 ModestAccountMgrPrivate *priv;
298 g_return_val_if_fail (self, FALSE);
299 g_return_val_if_fail (name, FALSE);
300 g_return_val_if_fail (strchr(name, '/') == NULL, FALSE);
302 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
305 * we create the account by adding an account 'dir', with the name <name>,
306 * and in that the 'display_name' string key
308 key = get_account_keyname (name, MODEST_ACCOUNT_DISPLAY_NAME, FALSE);
309 if (modest_account_mgr_account_exists (self, key, FALSE, err)) {
310 g_printerr ("modest: account already exists\n");
315 ok = modest_conf_set_string (priv->modest_conf, key, name, err);
319 g_printerr ("modest: cannot set display name\n");
324 key = get_account_keyname (name, MODEST_ACCOUNT_STORE_ACCOUNT, FALSE);
325 ok = modest_conf_set_string (priv->modest_conf, key, store_account, err);
328 g_printerr ("modest: failed to set store account '%s'\n",
334 if (transport_account) {
335 key = get_account_keyname (name, MODEST_ACCOUNT_TRANSPORT_ACCOUNT, FALSE);
336 ok = modest_conf_set_string (priv->modest_conf, key, transport_account, err);
339 g_printerr ("modest: failed to set transport account '%s'\n",
345 modest_account_mgr_account_set_enabled (self, name, TRUE);
354 modest_account_mgr_add_server_account (ModestAccountMgr * self,
355 const gchar * name, const gchar *hostname,
356 const gchar * username, const gchar * password,
359 ModestAccountMgrPrivate *priv;
361 ModestProtoType proto_type = MODEST_PROTO_TYPE_ANY;
363 g_return_val_if_fail (self, FALSE);
364 g_return_val_if_fail (name, FALSE);
365 g_return_val_if_fail (strchr(name, '/') == NULL, FALSE);
367 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
370 key = get_account_keyname (name, MODEST_ACCOUNT_HOSTNAME, TRUE);
371 if (modest_conf_key_exists (priv->modest_conf, key, NULL)) {
372 g_printerr ("modest: server account '%s' already exists", name);
377 modest_conf_set_string (priv->modest_conf, key, null_means_empty(hostname), NULL);
381 key = get_account_keyname (name, MODEST_ACCOUNT_USERNAME, TRUE);
382 modest_conf_set_string (priv->modest_conf, key, null_means_empty (username), NULL);
386 key = get_account_keyname (name, MODEST_ACCOUNT_PASSWORD, TRUE);
387 modest_conf_set_string (priv->modest_conf, key, null_means_empty (password), NULL);
391 key = get_account_keyname (name, MODEST_ACCOUNT_PROTO, TRUE);
392 modest_conf_set_string (priv->modest_conf, key, null_means_empty (proto), NULL);
396 key = get_account_keyname (name, MODEST_ACCOUNT_TYPE, TRUE);
397 proto_type = modest_proto_type (proto);
398 modest_conf_set_string (priv->modest_conf, key,
399 (proto_type == MODEST_PROTO_TYPE_TRANSPORT) ? "transport" : "store",
409 modest_account_mgr_remove_account (ModestAccountMgr * self,
411 gboolean server_account,
414 ModestAccountMgrPrivate *priv;
418 g_return_val_if_fail (self, FALSE);
419 g_return_val_if_fail (name, FALSE);
421 if (!modest_account_mgr_account_exists (self, name, server_account, err)) {
422 g_printerr ("modest: account '%s' does not exist\n", name);
426 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
427 key = get_account_keyname (name, NULL, server_account);
429 retval = modest_conf_remove_key (priv->modest_conf, key, NULL);
437 /* strip the first /n/ character from each element
438 * caller must make sure all elements are strings with
439 * length >= n, and also that data can be freed.
443 strip_prefix_from_elements (GSList * lst, guint n)
446 memmove (lst->data, lst->data + n,
447 strlen(lst->data) - n + 1);
454 modest_account_mgr_search_server_accounts (ModestAccountMgr * self,
455 const gchar * account_name,
456 ModestProtocolType type,
461 ModestAccountMgrPrivate *priv;
465 g_return_val_if_fail (self, NULL);
467 key = get_account_keyname (account_name, NULL, TRUE);
468 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
470 /* get the list of all server accounts */
471 accounts = modest_conf_list_subkeys (priv->modest_conf, key, &err);
474 g_printerr ("modest: failed to get subkeys for '%s'\n", key);
478 /* no restrictions, return everything */
479 if (type == MODEST_PROTOCOL_TYPE_ANY && !proto) {
480 strip_prefix_from_elements (accounts, strlen(key)+1);
482 /* +1 because we must remove the ending '/' as well */
485 /* otherwise, filter out the none-matching ones */
491 account = account_from_key ((gchar*)cursor->data, NULL, NULL);
492 acc_proto = modest_account_mgr_get_string (self, account, MODEST_ACCOUNT_PROTO,
494 if ((!acc_proto) || /* proto not defined? */
495 (type != MODEST_PROTOCOL_TYPE_ANY && /* proto type ... */
496 !modest_protocol_mgr_protocol_is_valid (priv->proto_mgr,
497 acc_proto,type)) || /* ... matches? */
498 (proto && strcmp (proto, acc_proto) != 0)) { /* proto matches? */
499 /* match! remove from the list */
500 GSList *nxt = cursor->next;
501 accounts = g_slist_delete_link (accounts, cursor);
504 cursor = cursor->next;
510 /* +1 because we must remove the ending '/' as well */
511 strip_prefix_from_elements (accounts, strlen(key)+1);
519 modest_account_mgr_account_names (ModestAccountMgr * self, GError ** err)
522 ModestAccountMgrPrivate *priv;
523 const size_t prefix_len = strlen (MODEST_ACCOUNT_NAMESPACE "/");
525 g_return_val_if_fail (self, NULL);
527 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
529 accounts = modest_conf_list_subkeys (priv->modest_conf,
530 MODEST_ACCOUNT_NAMESPACE, err);
532 strip_prefix_from_elements (accounts, prefix_len);
537 static ModestServerAccountData*
538 modest_account_mgr_get_server_account_data (ModestAccountMgr *self, const gchar* name)
540 ModestServerAccountData *data;
542 g_return_val_if_fail (modest_account_mgr_account_exists (self, name,
544 data = g_new0 (ModestServerAccountData, 1);
546 data->account_name = g_strdup (name);
547 data->hostname = modest_account_mgr_get_string (self, name,
548 MODEST_ACCOUNT_HOSTNAME,
550 data->username = modest_account_mgr_get_string (self, name,
551 MODEST_ACCOUNT_USERNAME,
553 data->proto = modest_account_mgr_get_string (self, name,
554 MODEST_ACCOUNT_PROTO,
556 data->password = modest_account_mgr_get_string (self, name,
557 MODEST_ACCOUNT_PASSWORD,
564 modest_account_mgr_free_server_account_data (ModestAccountMgr *self,
565 ModestServerAccountData* data)
567 g_return_if_fail (self);
570 return; /* not an error */
572 g_free (data->account_name);
573 g_free (data->hostname);
574 g_free (data->username);
575 g_free (data->proto);
576 g_free (data->password);
583 modest_account_mgr_get_account_data (ModestAccountMgr *self, const gchar* name)
585 ModestAccountData *data;
586 gchar *server_account;
588 g_return_val_if_fail (self, NULL);
589 g_return_val_if_fail (name, NULL);
590 g_return_val_if_fail (modest_account_mgr_account_exists (self, name,
592 data = g_new0 (ModestAccountData, 1);
594 data->account_name = g_strdup (name);
595 data->full_name = modest_account_mgr_get_string (self, name,
596 MODEST_ACCOUNT_FULLNAME,
598 data->email = modest_account_mgr_get_string (self, name,
599 MODEST_ACCOUNT_EMAIL,
601 data->enabled = modest_account_mgr_account_get_enabled (self, name);
604 server_account = modest_account_mgr_get_string (self, name,
605 MODEST_ACCOUNT_STORE_ACCOUNT,
607 if (server_account) {
608 data->store_account =
609 modest_account_mgr_get_server_account_data (self,
611 g_free (server_account);
615 server_account = modest_account_mgr_get_string (self, name,
616 MODEST_ACCOUNT_TRANSPORT_ACCOUNT,
618 if (server_account) {
619 data->transport_account =
620 modest_account_mgr_get_server_account_data (self,
622 g_free (server_account);
630 modest_account_mgr_free_account_data (ModestAccountMgr *self, ModestAccountData *data)
632 g_return_if_fail (self);
637 g_free (data->account_name);
638 g_free (data->full_name);
639 g_free (data->email);
641 modest_account_mgr_free_server_account_data (self, data->store_account);
642 modest_account_mgr_free_server_account_data (self, data->transport_account);
649 modest_account_mgr_get_string (ModestAccountMgr *self, const gchar *name,
650 const gchar *key, gboolean server_account, GError **err) {
652 ModestAccountMgrPrivate *priv;
657 g_return_val_if_fail (self, NULL);
658 g_return_val_if_fail (name, NULL);
659 g_return_val_if_fail (key, NULL);
661 keyname = get_account_keyname (name, key, server_account);
663 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
664 retval = modest_conf_get_string (priv->modest_conf, keyname, err);
672 modest_account_mgr_get_int (ModestAccountMgr *self, const gchar *name,
673 const gchar *key, gboolean server_account, GError **err)
675 ModestAccountMgrPrivate *priv;
680 g_return_val_if_fail (self, -1);
681 g_return_val_if_fail (name, -1);
682 g_return_val_if_fail (key, -1);
684 keyname = get_account_keyname (name, key, server_account);
686 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
687 retval = modest_conf_get_int (priv->modest_conf, keyname, err);
696 modest_account_mgr_get_bool (ModestAccountMgr * self, const gchar *account,
697 const gchar * key, gboolean server_account, GError ** err)
699 ModestAccountMgrPrivate *priv;
704 g_return_val_if_fail (self, FALSE);
705 g_return_val_if_fail (account, FALSE);
706 g_return_val_if_fail (key, FALSE);
708 keyname = get_account_keyname (account, key, server_account);
710 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
711 retval = modest_conf_get_bool (priv->modest_conf, keyname, err);
720 modest_account_mgr_set_string (ModestAccountMgr * self, const gchar * name,
721 const gchar * key, const gchar * val,
722 gboolean server_account, GError ** err)
724 ModestAccountMgrPrivate *priv;
729 g_return_val_if_fail (self, FALSE);
730 g_return_val_if_fail (name, FALSE);
731 g_return_val_if_fail (key, FALSE);
733 keyname = get_account_keyname (name, key, server_account);
735 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
737 retval = modest_conf_set_string (priv->modest_conf, keyname, val,
746 modest_account_mgr_set_int (ModestAccountMgr * self, const gchar * name,
747 const gchar * key, int val, gboolean server_account,
750 ModestAccountMgrPrivate *priv;
755 g_return_val_if_fail (self, FALSE);
756 g_return_val_if_fail (name, FALSE);
757 g_return_val_if_fail (key, FALSE);
759 keyname = get_account_keyname (name, key, server_account);
761 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
763 retval = modest_conf_set_int (priv->modest_conf, keyname, val, err);
772 modest_account_mgr_set_bool (ModestAccountMgr * self, const gchar * name,
773 const gchar * key, gboolean val, gboolean server_account,
776 ModestAccountMgrPrivate *priv;
781 g_return_val_if_fail (self, FALSE);
782 g_return_val_if_fail (name, FALSE);
783 g_return_val_if_fail (key, FALSE);
785 keyname = get_account_keyname (name, key, server_account);
787 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
789 retval = modest_conf_set_bool (priv->modest_conf, keyname, val, err);
796 modest_account_mgr_set_list (ModestAccountMgr *self,
800 ModestConfValueType list_type,
801 gboolean server_account,
804 ModestAccountMgrPrivate *priv;
807 g_return_if_fail (self);
808 g_return_if_fail (name);
809 g_return_if_fail (key);
810 g_return_if_fail (val);
812 keyname = get_account_keyname (name, key, server_account);
814 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
815 modest_conf_set_list (priv->modest_conf, keyname, val, list_type, err);
820 modest_account_mgr_account_exists (ModestAccountMgr * self, const gchar * name,
821 gboolean server_account, GError ** err)
823 ModestAccountMgrPrivate *priv;
828 g_return_val_if_fail (self, FALSE);
829 g_return_val_if_fail (name, FALSE);
831 keyname = get_account_keyname (name, NULL, server_account);
833 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
834 retval = modest_conf_key_exists (priv->modest_conf, keyname, err);
842 modest_account_mgr_get_list (ModestAccountMgr *self,
845 ModestConfValueType list_type,
846 gboolean server_account,
849 ModestAccountMgrPrivate *priv;
854 g_return_val_if_fail (self, NULL);
855 g_return_val_if_fail (name, NULL);
856 g_return_val_if_fail (key, NULL);
858 keyname = get_account_keyname (name, key, server_account);
860 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
861 retval = modest_conf_get_list (priv->modest_conf, keyname, list_type, err);
869 modest_account_mgr_unset (ModestAccountMgr *self,
872 gboolean server_account,
875 ModestAccountMgrPrivate *priv;
880 g_return_val_if_fail (self, FALSE);
881 g_return_val_if_fail (name, FALSE);
882 g_return_val_if_fail (key, FALSE);
884 keyname = get_account_keyname (name, key, server_account);
886 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
887 retval = modest_conf_remove_key (priv->modest_conf, keyname, err);
895 /* must be freed by caller */
897 get_account_keyname (const gchar *account_name, const gchar * name, gboolean server_account)
902 namespace = server_account ? MODEST_SERVER_ACCOUNT_NAMESPACE : MODEST_ACCOUNT_NAMESPACE;
905 return g_strdup (namespace);
908 retval = g_strconcat (namespace, "/", account_name, "/", name, NULL);
910 retval = g_strconcat (namespace, "/", account_name, NULL);
912 /* special case: the key has some weird characters */
913 if (!modest_conf_key_is_valid (retval)) {
915 gchar *account_name_esc, *name_esc;
918 account_name_esc = account_name ? modest_conf_key_escape (account_name) : NULL;
919 name_esc = name ? modest_conf_key_escape (name) : NULL;
921 retval = get_account_keyname (account_name_esc, name_esc, server_account);
923 g_free (account_name_esc);