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,
41 gboolean server_account);
45 ACCOUNT_CHANGED_SIGNAL,
46 ACCOUNT_REMOVED_SIGNAL,
50 typedef struct _ModestAccountMgrPrivate ModestAccountMgrPrivate;
51 struct _ModestAccountMgrPrivate {
52 ModestConf *modest_conf;
53 ModestProtocolMgr *proto_mgr;
56 #define MODEST_ACCOUNT_MGR_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
57 MODEST_TYPE_ACCOUNT_MGR, \
58 ModestAccountMgrPrivate))
60 static GObjectClass *parent_class = NULL;
61 static guint signals[LAST_SIGNAL] = {0};
64 account_from_key (const gchar *key, gboolean *is_account_key, gboolean *is_server_account)
66 const gchar* account_ns = MODEST_ACCOUNT_NAMESPACE "/";
67 const gchar* server_account_ns = MODEST_SERVER_ACCOUNT_NAMESPACE "/";
69 gchar *account = NULL;
71 /* determine whether it's an account or a server account,
72 * based on the prefix */
73 if (g_str_has_prefix (key, account_ns)) {
75 if (is_server_account)
76 *is_server_account = FALSE;
78 account = g_strdup (key + strlen (account_ns));
80 } else if (g_str_has_prefix (key, server_account_ns)) {
82 if (is_server_account)
83 *is_server_account = TRUE;
85 account = g_strdup (key + strlen (server_account_ns));
89 /* if there are any slashes left in the key, it's not
90 * the toplevel entry for an account
92 cursor = strstr(account, "/");
94 if (is_account_key && cursor)
95 *is_account_key = TRUE;
97 /* put a NULL where the first slash was */
108 on_key_change (ModestConf *conf, const gchar *key, ModestConfEvent event, gpointer user_data)
110 ModestAccountMgr *self;
111 ModestAccountMgrPrivate *priv;
114 gboolean is_account_key, is_server_account;
117 self = MODEST_ACCOUNT_MGR (user_data);
118 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
120 account = account_from_key (key, &is_account_key, &is_server_account);
122 /* if this is not an account-related key change, ignore */
126 /* account was removed -- emit this, even if the account was disabled */
127 if (is_account_key && event == MODEST_CONF_EVENT_KEY_UNSET) {
128 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_REMOVED_SIGNAL], 0,
129 account, is_server_account);
134 /* is this account enabled? */
135 if (is_server_account)
138 enabled = modest_account_mgr_account_get_enabled (self, account);
140 /* account was changed.
141 * and always notify when enabled/disabled changes
143 if (enabled || g_str_has_suffix (key, MODEST_ACCOUNT_ENABLED))
144 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_CHANGED_SIGNAL], 0,
145 account, key, is_server_account);
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,
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;
216 priv->proto_mgr = modest_protocol_mgr_new ();
220 modest_account_mgr_finalize (GObject * obj)
222 ModestAccountMgrPrivate *priv =
223 MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
225 if (priv->modest_conf) {
226 g_object_unref (G_OBJECT(priv->modest_conf));
227 priv->modest_conf = NULL;
230 if (priv->proto_mgr) {
231 g_object_unref (G_OBJECT(priv->proto_mgr));
232 priv->proto_mgr = NULL;
235 G_OBJECT_CLASS(parent_class)->finalize (obj);
239 modest_account_mgr_new (ModestConf * conf)
242 ModestAccountMgrPrivate *priv;
244 g_return_val_if_fail (conf, NULL);
246 obj = G_OBJECT (g_object_new (MODEST_TYPE_ACCOUNT_MGR, NULL));
247 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
249 g_object_ref (G_OBJECT(conf));
250 priv->modest_conf = conf;
252 g_signal_connect (G_OBJECT (conf), "key_changed",
253 G_CALLBACK (on_key_change),
256 return MODEST_ACCOUNT_MGR (obj);
261 null_means_empty (const gchar * str)
263 return str ? str : "";
268 modest_account_mgr_account_set_enabled (ModestAccountMgr *self, const gchar* name,
271 return modest_account_mgr_set_bool (self, name,
272 MODEST_ACCOUNT_ENABLED, enabled,
278 modest_account_mgr_account_get_enabled (ModestAccountMgr *self, const gchar* name)
280 return modest_account_mgr_get_bool (self, name,
281 MODEST_ACCOUNT_ENABLED, FALSE,
287 modest_account_mgr_add_account (ModestAccountMgr *self,
289 const gchar *store_account,
290 const gchar *transport_account,
293 ModestAccountMgrPrivate *priv;
297 g_return_val_if_fail (self, FALSE);
298 g_return_val_if_fail (name, FALSE);
299 g_return_val_if_fail (strchr(name, '/') == NULL, FALSE);
301 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
304 * we create the account by adding an account 'dir', with the name <name>,
305 * and in that the 'display_name' string key
307 key = get_account_keyname (name, MODEST_ACCOUNT_DISPLAY_NAME, FALSE);
308 if (modest_account_mgr_account_exists (self, key, FALSE, err)) {
309 g_printerr ("modest: account already exists\n");
314 ok = modest_conf_set_string (priv->modest_conf, key, name, err);
318 g_printerr ("modest: cannot set display name\n");
323 key = get_account_keyname (name, MODEST_ACCOUNT_STORE_ACCOUNT, FALSE);
324 ok = modest_conf_set_string (priv->modest_conf, key, store_account, err);
327 g_printerr ("modest: failed to set store account '%s'\n",
333 if (transport_account) {
334 key = get_account_keyname (name, MODEST_ACCOUNT_TRANSPORT_ACCOUNT, FALSE);
335 ok = modest_conf_set_string (priv->modest_conf, key, transport_account, err);
338 g_printerr ("modest: failed to set transport account '%s'\n",
344 modest_account_mgr_account_set_enabled (self, name, TRUE);
353 modest_account_mgr_add_server_account (ModestAccountMgr * self,
354 const gchar * name, const gchar *hostname,
355 const gchar * username, const gchar * password,
358 ModestAccountMgrPrivate *priv;
361 g_return_val_if_fail (self, FALSE);
362 g_return_val_if_fail (name, FALSE);
363 g_return_val_if_fail (strchr(name, '/') == NULL, FALSE);
365 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
368 key = get_account_keyname (name, MODEST_ACCOUNT_HOSTNAME, TRUE);
369 if (modest_conf_key_exists (priv->modest_conf, key, NULL)) {
370 g_printerr ("modest: server account '%s' already exists", name);
375 modest_conf_set_string (priv->modest_conf, key, null_means_empty(hostname), NULL);
379 key = get_account_keyname (name, MODEST_ACCOUNT_USERNAME, TRUE);
380 modest_conf_set_string (priv->modest_conf, key, null_means_empty (username), NULL);
384 key = get_account_keyname (name, MODEST_ACCOUNT_PASSWORD, TRUE);
385 modest_conf_set_string (priv->modest_conf, key, null_means_empty (password), NULL);
389 key = get_account_keyname (name, MODEST_ACCOUNT_PROTO, TRUE);
390 modest_conf_set_string (priv->modest_conf, key, null_means_empty (proto), NULL);
399 modest_account_mgr_remove_account (ModestAccountMgr * self,
401 gboolean server_account,
404 ModestAccountMgrPrivate *priv;
408 g_return_val_if_fail (self, FALSE);
409 g_return_val_if_fail (name, FALSE);
411 if (!modest_account_mgr_account_exists (self, name, server_account, err)) {
412 g_printerr ("modest: account '%s' does not exist\n", name);
416 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
417 key = get_account_keyname (name, NULL, server_account);
419 retval = modest_conf_remove_key (priv->modest_conf, key, NULL);
427 /* strip the first /n/ character from each element
428 * caller must make sure all elements are strings with
429 * length >= n, and also that data can be freed.
433 strip_prefix_from_elements (GSList * lst, guint n)
436 memmove (lst->data, lst->data + n,
437 strlen(lst->data) - n + 1);
444 modest_account_mgr_search_server_accounts (ModestAccountMgr * self,
445 const gchar * account_name,
446 ModestProtocolType type,
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_PROTOCOL_TYPE_ANY && !proto) {
470 strip_prefix_from_elements (accounts, strlen(key)+1);
472 /* +1 because we must remove the ending '/' as well */
475 /* otherwise, filter out the none-matching ones */
481 account = account_from_key ((gchar*)cursor->data, NULL, NULL);
482 acc_proto = modest_account_mgr_get_string (self, account, MODEST_ACCOUNT_PROTO,
484 if ((!acc_proto) || /* proto not defined? */
485 (type != MODEST_PROTOCOL_TYPE_ANY && /* proto type ... */
486 !modest_protocol_mgr_protocol_is_valid (priv->proto_mgr,
487 acc_proto,type)) || /* ... matches? */
488 (proto && strcmp (proto, acc_proto) != 0)) { /* proto matches? */
489 /* match! remove from the list */
490 GSList *nxt = cursor->next;
491 accounts = g_slist_delete_link (accounts, cursor);
494 cursor = cursor->next;
500 /* +1 because we must remove the ending '/' as well */
501 strip_prefix_from_elements (accounts, strlen(key)+1);
509 modest_account_mgr_account_names (ModestAccountMgr * self, GError ** err)
512 ModestAccountMgrPrivate *priv;
513 const size_t prefix_len = strlen (MODEST_ACCOUNT_NAMESPACE "/");
515 g_return_val_if_fail (self, NULL);
517 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
519 accounts = modest_conf_list_subkeys (priv->modest_conf,
520 MODEST_ACCOUNT_NAMESPACE, err);
522 strip_prefix_from_elements (accounts, prefix_len);
527 static ModestServerAccountData*
528 modest_account_mgr_get_server_account_data (ModestAccountMgr *self, const gchar* name)
530 ModestServerAccountData *data;
532 g_return_val_if_fail (modest_account_mgr_account_exists (self, name,
534 data = g_new0 (ModestServerAccountData, 1);
536 data->account_name = g_strdup (name);
537 data->hostname = modest_account_mgr_get_string (self, name,
538 MODEST_ACCOUNT_HOSTNAME,
540 data->username = modest_account_mgr_get_string (self, name,
541 MODEST_ACCOUNT_USERNAME,
543 data->proto = modest_account_mgr_get_string (self, name,
544 MODEST_ACCOUNT_PROTO,
546 data->password = modest_account_mgr_get_string (self, name,
547 MODEST_ACCOUNT_PASSWORD,
554 modest_account_mgr_free_server_account_data (ModestAccountMgr *self,
555 ModestServerAccountData* data)
557 g_return_if_fail (self);
560 return; /* not an error */
562 g_free (data->account_name);
563 g_free (data->hostname);
564 g_free (data->username);
565 g_free (data->proto);
566 g_free (data->password);
573 modest_account_mgr_get_account_data (ModestAccountMgr *self, const gchar* name)
575 ModestAccountData *data;
576 gchar *server_account;
578 g_return_val_if_fail (self, NULL);
579 g_return_val_if_fail (name, NULL);
580 g_return_val_if_fail (modest_account_mgr_account_exists (self, name,
582 data = g_new0 (ModestAccountData, 1);
584 data->account_name = g_strdup (name);
585 data->full_name = modest_account_mgr_get_string (self, name,
586 MODEST_ACCOUNT_FULLNAME,
588 data->email = modest_account_mgr_get_string (self, name,
589 MODEST_ACCOUNT_EMAIL,
591 data->enabled = modest_account_mgr_account_get_enabled (self, name);
594 server_account = modest_account_mgr_get_string (self, name,
595 MODEST_ACCOUNT_STORE_ACCOUNT,
597 if (server_account) {
598 data->store_account =
599 modest_account_mgr_get_server_account_data (self,
601 g_free (server_account);
605 server_account = modest_account_mgr_get_string (self, name,
606 MODEST_ACCOUNT_TRANSPORT_ACCOUNT,
608 if (server_account) {
609 data->transport_account =
610 modest_account_mgr_get_server_account_data (self,
612 g_free (server_account);
620 modest_account_mgr_free_account_data (ModestAccountMgr *self, ModestAccountData *data)
622 g_return_if_fail (self);
627 g_free (data->account_name);
628 g_free (data->full_name);
629 g_free (data->email);
631 modest_account_mgr_free_server_account_data (self, data->store_account);
632 modest_account_mgr_free_server_account_data (self, data->transport_account);
639 modest_account_mgr_get_string (ModestAccountMgr *self, const gchar *name,
640 const gchar *key, gboolean server_account, GError **err) {
642 ModestAccountMgrPrivate *priv;
647 g_return_val_if_fail (self, NULL);
648 g_return_val_if_fail (name, NULL);
649 g_return_val_if_fail (key, NULL);
651 keyname = get_account_keyname (name, key, server_account);
653 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
654 retval = modest_conf_get_string (priv->modest_conf, keyname, err);
662 modest_account_mgr_get_int (ModestAccountMgr *self, const gchar *name,
663 const gchar *key, gboolean server_account, GError **err)
665 ModestAccountMgrPrivate *priv;
670 g_return_val_if_fail (self, -1);
671 g_return_val_if_fail (name, -1);
672 g_return_val_if_fail (key, -1);
674 keyname = get_account_keyname (name, key, server_account);
676 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
677 retval = modest_conf_get_int (priv->modest_conf, keyname, err);
686 modest_account_mgr_get_bool (ModestAccountMgr * self, const gchar *account,
687 const gchar * key, gboolean server_account, GError ** err)
689 ModestAccountMgrPrivate *priv;
694 g_return_val_if_fail (self, FALSE);
695 g_return_val_if_fail (account, FALSE);
696 g_return_val_if_fail (key, FALSE);
698 keyname = get_account_keyname (account, key, server_account);
700 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
701 retval = modest_conf_get_bool (priv->modest_conf, keyname, err);
710 modest_account_mgr_set_string (ModestAccountMgr * self, const gchar * name,
711 const gchar * key, const gchar * val,
712 gboolean server_account, GError ** err)
714 ModestAccountMgrPrivate *priv;
719 g_return_val_if_fail (self, FALSE);
720 g_return_val_if_fail (name, FALSE);
721 g_return_val_if_fail (key, FALSE);
723 keyname = get_account_keyname (name, key, server_account);
725 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
727 retval = modest_conf_set_string (priv->modest_conf, keyname, val,
736 modest_account_mgr_set_int (ModestAccountMgr * self, const gchar * name,
737 const gchar * key, int val, gboolean server_account,
740 ModestAccountMgrPrivate *priv;
745 g_return_val_if_fail (self, FALSE);
746 g_return_val_if_fail (name, FALSE);
747 g_return_val_if_fail (key, FALSE);
749 keyname = get_account_keyname (name, key, server_account);
751 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
753 retval = modest_conf_set_int (priv->modest_conf, keyname, val, err);
762 modest_account_mgr_set_bool (ModestAccountMgr * self, const gchar * name,
763 const gchar * key, gboolean val, gboolean server_account,
766 ModestAccountMgrPrivate *priv;
771 g_return_val_if_fail (self, FALSE);
772 g_return_val_if_fail (name, FALSE);
773 g_return_val_if_fail (key, FALSE);
775 keyname = get_account_keyname (name, key, server_account);
777 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
779 retval = modest_conf_set_bool (priv->modest_conf, keyname, val, err);
786 modest_account_mgr_set_list (ModestAccountMgr *self,
790 ModestConfValueType list_type,
791 gboolean server_account,
794 ModestAccountMgrPrivate *priv;
797 g_return_if_fail (self);
798 g_return_if_fail (name);
799 g_return_if_fail (key);
800 g_return_if_fail (val);
802 keyname = get_account_keyname (name, key, server_account);
804 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
805 modest_conf_set_list (priv->modest_conf, keyname, val, list_type, err);
810 modest_account_mgr_account_exists (ModestAccountMgr * self, const gchar * name,
811 gboolean server_account, GError ** err)
813 ModestAccountMgrPrivate *priv;
818 g_return_val_if_fail (self, FALSE);
819 g_return_val_if_fail (name, FALSE);
821 keyname = get_account_keyname (name, NULL, server_account);
823 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
824 retval = modest_conf_key_exists (priv->modest_conf, keyname, err);
832 modest_account_mgr_get_list (ModestAccountMgr *self,
835 ModestConfValueType list_type,
836 gboolean server_account,
839 ModestAccountMgrPrivate *priv;
844 g_return_val_if_fail (self, NULL);
845 g_return_val_if_fail (name, NULL);
846 g_return_val_if_fail (key, NULL);
848 keyname = get_account_keyname (name, key, server_account);
850 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
851 retval = modest_conf_get_list (priv->modest_conf, keyname, list_type, err);
859 modest_account_mgr_unset (ModestAccountMgr *self,
862 gboolean server_account,
865 ModestAccountMgrPrivate *priv;
870 g_return_val_if_fail (self, FALSE);
871 g_return_val_if_fail (name, FALSE);
872 g_return_val_if_fail (key, FALSE);
874 keyname = get_account_keyname (name, key, server_account);
876 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
877 retval = modest_conf_remove_key (priv->modest_conf, keyname, err);
885 /* must be freed by caller */
887 get_account_keyname (const gchar *account_name, const gchar * name, gboolean server_account)
892 namespace = server_account ? MODEST_SERVER_ACCOUNT_NAMESPACE : MODEST_ACCOUNT_NAMESPACE;
895 return g_strdup (namespace);
898 retval = g_strconcat (namespace, "/", account_name, "/", name, NULL);
900 retval = g_strconcat (namespace, "/", account_name, NULL);
902 /* special case: the key has some weird characters */
903 if (!modest_conf_key_is_valid (retval)) {
905 gchar *account_name_esc, *name_esc;
908 account_name_esc = account_name ? modest_conf_key_escape (account_name) : NULL;
909 name_esc = name ? modest_conf_key_escape (name) : NULL;
911 retval = get_account_keyname (account_name_esc, name_esc, server_account);
913 g_free (account_name_esc);