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;
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;
60 static guint signals[LAST_SIGNAL] = {0};
63 account_from_key (const gchar *key, gboolean *is_account_key, gboolean *is_server_account)
65 const gchar* account_ns = MODEST_ACCOUNT_NAMESPACE "/";
66 const gchar* server_account_ns = MODEST_SERVER_ACCOUNT_NAMESPACE "/";
68 gchar *account = NULL;
70 /* determine whether it's an account or a server account,
71 * based on the prefix */
72 if (g_str_has_prefix (key, account_ns)) {
74 if (is_server_account)
75 *is_server_account = FALSE;
77 account = g_strdup (key + strlen (account_ns));
79 } else if (g_str_has_prefix (key, server_account_ns)) {
81 if (is_server_account)
82 *is_server_account = TRUE;
84 account = g_strdup (key + strlen (server_account_ns));
88 /* if there are any slashes left in the key, it's not
89 * the toplevel entry for an account
91 cursor = strstr(account, "/");
93 if (is_account_key && cursor)
94 *is_account_key = TRUE;
96 /* put a NULL where the first slash was */
107 on_key_change (ModestConf *conf, const gchar *key, ModestConfEvent event, gpointer user_data)
109 ModestAccountMgr *self;
110 ModestAccountMgrPrivate *priv;
113 gboolean is_account_key, is_server_account;
116 self = MODEST_ACCOUNT_MGR (user_data);
117 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
119 account = account_from_key (key, &is_account_key, &is_server_account);
121 /* if this is not an account-related key change, ignore */
125 /* account was removed -- emit this, even if the account was disabled */
126 if (is_account_key && event == MODEST_CONF_EVENT_KEY_UNSET) {
127 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_REMOVED_SIGNAL], 0,
128 account, is_server_account);
133 /* is this account enabled? */
134 if (is_server_account)
137 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,
169 my_type = g_type_register_static (G_TYPE_OBJECT,
177 modest_account_mgr_class_init (ModestAccountMgrClass * klass)
179 GObjectClass *gobject_class;
180 gobject_class = (GObjectClass *) klass;
182 parent_class = g_type_class_peek_parent (klass);
183 gobject_class->finalize = modest_account_mgr_finalize;
185 g_type_class_add_private (gobject_class,
186 sizeof (ModestAccountMgrPrivate));
188 /* signal definitions */
189 signals[ACCOUNT_REMOVED_SIGNAL] =
190 g_signal_new ("account_removed",
191 G_TYPE_FROM_CLASS (klass),
193 G_STRUCT_OFFSET(ModestAccountMgrClass,account_removed),
195 modest_marshal_VOID__STRING_BOOLEAN,
196 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_BOOLEAN);
197 signals[ACCOUNT_CHANGED_SIGNAL] =
198 g_signal_new ("account_changed",
199 G_TYPE_FROM_CLASS (klass),
201 G_STRUCT_OFFSET(ModestAccountMgrClass,account_changed),
203 modest_marshal_VOID__STRING_STRING_BOOLEAN,
204 G_TYPE_NONE, 3, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_BOOLEAN);
209 modest_account_mgr_init (ModestAccountMgr * obj)
211 ModestAccountMgrPrivate *priv =
212 MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
214 priv->modest_conf = NULL;
218 modest_account_mgr_finalize (GObject * obj)
220 ModestAccountMgrPrivate *priv =
221 MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
223 if (priv->modest_conf) {
224 g_object_unref (G_OBJECT(priv->modest_conf));
225 priv->modest_conf = NULL;
228 G_OBJECT_CLASS(parent_class)->finalize (obj);
232 modest_account_mgr_new (ModestConf * conf)
235 ModestAccountMgrPrivate *priv;
237 g_return_val_if_fail (conf, NULL);
239 obj = G_OBJECT (g_object_new (MODEST_TYPE_ACCOUNT_MGR, NULL));
240 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
242 g_object_ref (G_OBJECT(conf));
243 priv->modest_conf = conf;
245 g_signal_connect (G_OBJECT (conf), "key_changed",
246 G_CALLBACK (on_key_change),
249 return MODEST_ACCOUNT_MGR (obj);
254 null_means_empty (const gchar * str)
256 return str ? str : "";
261 modest_account_mgr_account_set_enabled (ModestAccountMgr *self, const gchar* name,
264 return modest_account_mgr_set_bool (self, name,
265 MODEST_ACCOUNT_ENABLED, enabled,
271 modest_account_mgr_account_get_enabled (ModestAccountMgr *self, const gchar* name)
273 return modest_account_mgr_get_bool (self, name,
274 MODEST_ACCOUNT_ENABLED, FALSE,
280 modest_account_mgr_add_account (ModestAccountMgr *self,
282 const gchar *store_account,
283 const gchar *transport_account,
286 ModestAccountMgrPrivate *priv;
290 g_return_val_if_fail (self, FALSE);
291 g_return_val_if_fail (name, FALSE);
292 g_return_val_if_fail (strchr(name, '/') == NULL, FALSE);
294 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
297 * we create the account by adding an account 'dir', with the name <name>,
298 * and in that the 'display_name' string key
300 key = get_account_keyname (name, MODEST_ACCOUNT_DISPLAY_NAME, FALSE);
301 if (modest_account_mgr_account_exists (self, key, FALSE, err)) {
302 g_printerr ("modest: account already exists\n");
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_account_set_enabled (self, name, TRUE);
346 modest_account_mgr_add_server_account (ModestAccountMgr * self,
347 const gchar * name, const gchar *hostname,
348 const gchar * username, const gchar * password,
349 ModestProtocol proto)
351 ModestAccountMgrPrivate *priv;
353 ModestProtocolType proto_type;
355 g_return_val_if_fail (self, FALSE);
356 g_return_val_if_fail (name, FALSE);
357 g_return_val_if_fail (strchr(name, '/') == NULL, FALSE);
359 proto_type = modest_protocol_info_get_protocol_type (proto);
360 g_return_val_if_fail (proto_type == MODEST_PROTOCOL_TYPE_TRANSPORT ||
361 proto_type == MODEST_PROTOCOL_TYPE_STORE, FALSE);
363 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
366 key = get_account_keyname (name, MODEST_ACCOUNT_HOSTNAME, TRUE);
367 if (modest_conf_key_exists (priv->modest_conf, key, NULL)) {
368 g_printerr ("modest: server account '%s' already exists", name);
373 modest_conf_set_string (priv->modest_conf, key, null_means_empty(hostname), NULL);
377 key = get_account_keyname (name, MODEST_ACCOUNT_USERNAME, TRUE);
378 modest_conf_set_string (priv->modest_conf, key, null_means_empty (username), NULL);
382 key = get_account_keyname (name, MODEST_ACCOUNT_PASSWORD, TRUE);
383 modest_conf_set_string (priv->modest_conf, key, null_means_empty (password), NULL);
387 key = get_account_keyname (name, MODEST_ACCOUNT_PROTO, TRUE);
388 modest_conf_set_string (priv->modest_conf, key,
389 modest_protocol_info_get_protocol_name(proto),
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,
447 ModestProtocol proto)
451 ModestAccountMgrPrivate *priv;
455 g_return_val_if_fail (self, NULL);
457 if (proto != MODEST_PROTOCOL_UNKNOWN) {
458 ModestProtocolType proto_type;
459 proto_type = modest_protocol_info_get_protocol_type (proto);
460 g_return_val_if_fail (proto_type == MODEST_PROTOCOL_TYPE_TRANSPORT ||
461 proto_type == MODEST_PROTOCOL_TYPE_STORE, NULL);
464 key = get_account_keyname (account_name, NULL, TRUE);
465 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
467 /* get the list of all server accounts */
468 accounts = modest_conf_list_subkeys (priv->modest_conf, key, &err);
471 g_printerr ("modest: failed to get subkeys for '%s'\n", key);
475 /* filter out the ones with the wrong protocol */
476 /* we could optimize for unknown proto / unknown type, but it will only
477 * make the code more complex */
480 gchar *account = account_from_key ((gchar*)cursor->data, NULL, NULL);
481 gchar *acc_proto = modest_account_mgr_get_string (self, account, MODEST_ACCOUNT_PROTO,
483 ModestProtocol this_proto = modest_protocol_info_get_protocol (acc_proto);
484 ModestProtocolType this_type = modest_protocol_info_get_protocol_type (this_proto);
486 if ((this_type != MODEST_PROTOCOL_TYPE_UNKNOWN && this_type != type) ||
487 (this_proto != MODEST_PROTOCOL_UNKNOWN && this_proto != proto)) {
488 GSList *nxt = cursor->next;
489 accounts = g_slist_delete_link (accounts, cursor);
492 cursor = cursor->next;
498 /* +1 because we must remove the ending '/' as well */
499 strip_prefix_from_elements (accounts, strlen(key)+1);
505 modest_account_mgr_account_names (ModestAccountMgr * self, GError ** err)
508 ModestAccountMgrPrivate *priv;
509 const size_t prefix_len = strlen (MODEST_ACCOUNT_NAMESPACE "/");
511 g_return_val_if_fail (self, NULL);
513 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
515 accounts = modest_conf_list_subkeys (priv->modest_conf,
516 MODEST_ACCOUNT_NAMESPACE, err);
518 strip_prefix_from_elements (accounts, prefix_len);
523 static ModestServerAccountData*
524 modest_account_mgr_get_server_account_data (ModestAccountMgr *self, const gchar* name)
526 ModestServerAccountData *data;
529 g_return_val_if_fail (modest_account_mgr_account_exists (self, name,
531 data = g_new0 (ModestServerAccountData, 1);
533 data->account_name = g_strdup (name);
534 data->hostname = modest_account_mgr_get_string (self, name,
535 MODEST_ACCOUNT_HOSTNAME,
537 data->username = modest_account_mgr_get_string (self, name,
538 MODEST_ACCOUNT_USERNAME,
541 proto = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_PROTO,
543 data->proto = modest_protocol_info_get_protocol (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->password);
572 modest_account_mgr_get_account_data (ModestAccountMgr *self, const gchar* name)
574 ModestAccountData *data;
575 gchar *server_account;
577 g_return_val_if_fail (self, NULL);
578 g_return_val_if_fail (name, NULL);
579 g_return_val_if_fail (modest_account_mgr_account_exists (self, name,
581 data = g_new0 (ModestAccountData, 1);
583 data->account_name = g_strdup (name);
584 data->full_name = modest_account_mgr_get_string (self, name,
585 MODEST_ACCOUNT_FULLNAME,
587 data->email = modest_account_mgr_get_string (self, name,
588 MODEST_ACCOUNT_EMAIL,
590 data->enabled = modest_account_mgr_account_get_enabled (self, name);
593 server_account = modest_account_mgr_get_string (self, name,
594 MODEST_ACCOUNT_STORE_ACCOUNT,
596 if (server_account) {
597 data->store_account =
598 modest_account_mgr_get_server_account_data (self,
600 g_free (server_account);
604 server_account = modest_account_mgr_get_string (self, name,
605 MODEST_ACCOUNT_TRANSPORT_ACCOUNT,
607 if (server_account) {
608 data->transport_account =
609 modest_account_mgr_get_server_account_data (self,
611 g_free (server_account);
619 modest_account_mgr_free_account_data (ModestAccountMgr *self, ModestAccountData *data)
621 g_return_if_fail (self);
626 g_free (data->account_name);
627 g_free (data->full_name);
628 g_free (data->email);
630 modest_account_mgr_free_server_account_data (self, data->store_account);
631 modest_account_mgr_free_server_account_data (self, data->transport_account);
638 modest_account_mgr_get_string (ModestAccountMgr *self, const gchar *name,
639 const gchar *key, gboolean server_account, GError **err) {
641 ModestAccountMgrPrivate *priv;
646 g_return_val_if_fail (self, NULL);
647 g_return_val_if_fail (name, NULL);
648 g_return_val_if_fail (key, NULL);
650 keyname = get_account_keyname (name, key, server_account);
652 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
653 retval = modest_conf_get_string (priv->modest_conf, keyname, err);
661 modest_account_mgr_get_int (ModestAccountMgr *self, const gchar *name,
662 const gchar *key, gboolean server_account, GError **err)
664 ModestAccountMgrPrivate *priv;
669 g_return_val_if_fail (self, -1);
670 g_return_val_if_fail (name, -1);
671 g_return_val_if_fail (key, -1);
673 keyname = get_account_keyname (name, key, server_account);
675 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
676 retval = modest_conf_get_int (priv->modest_conf, keyname, err);
685 modest_account_mgr_get_bool (ModestAccountMgr * self, const gchar *account,
686 const gchar * key, gboolean server_account, GError ** err)
688 ModestAccountMgrPrivate *priv;
693 g_return_val_if_fail (self, FALSE);
694 g_return_val_if_fail (account, FALSE);
695 g_return_val_if_fail (key, FALSE);
697 keyname = get_account_keyname (account, key, server_account);
699 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
700 retval = modest_conf_get_bool (priv->modest_conf, keyname, err);
709 modest_account_mgr_set_string (ModestAccountMgr * self, const gchar * name,
710 const gchar * key, const gchar * val,
711 gboolean server_account, GError ** err)
713 ModestAccountMgrPrivate *priv;
718 g_return_val_if_fail (self, FALSE);
719 g_return_val_if_fail (name, FALSE);
720 g_return_val_if_fail (key, FALSE);
722 keyname = get_account_keyname (name, key, server_account);
724 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
726 retval = modest_conf_set_string (priv->modest_conf, keyname, val,
735 modest_account_mgr_set_int (ModestAccountMgr * self, const gchar * name,
736 const gchar * key, int val, gboolean server_account,
739 ModestAccountMgrPrivate *priv;
744 g_return_val_if_fail (self, FALSE);
745 g_return_val_if_fail (name, FALSE);
746 g_return_val_if_fail (key, FALSE);
748 keyname = get_account_keyname (name, key, server_account);
750 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
752 retval = modest_conf_set_int (priv->modest_conf, keyname, val, err);
761 modest_account_mgr_set_bool (ModestAccountMgr * self, const gchar * name,
762 const gchar * key, gboolean val, gboolean server_account,
765 ModestAccountMgrPrivate *priv;
770 g_return_val_if_fail (self, FALSE);
771 g_return_val_if_fail (name, FALSE);
772 g_return_val_if_fail (key, FALSE);
774 keyname = get_account_keyname (name, key, server_account);
776 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
778 retval = modest_conf_set_bool (priv->modest_conf, keyname, val, err);
785 modest_account_mgr_set_list (ModestAccountMgr *self,
789 ModestConfValueType list_type,
790 gboolean server_account,
793 ModestAccountMgrPrivate *priv;
796 g_return_if_fail (self);
797 g_return_if_fail (name);
798 g_return_if_fail (key);
799 g_return_if_fail (val);
801 keyname = get_account_keyname (name, key, server_account);
803 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
804 modest_conf_set_list (priv->modest_conf, keyname, val, list_type, err);
809 modest_account_mgr_account_exists (ModestAccountMgr * self, const gchar * name,
810 gboolean server_account, GError ** err)
812 ModestAccountMgrPrivate *priv;
817 g_return_val_if_fail (self, FALSE);
818 g_return_val_if_fail (name, FALSE);
820 keyname = get_account_keyname (name, NULL, server_account);
822 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
823 retval = modest_conf_key_exists (priv->modest_conf, keyname, err);
831 modest_account_mgr_get_list (ModestAccountMgr *self,
834 ModestConfValueType list_type,
835 gboolean server_account,
838 ModestAccountMgrPrivate *priv;
843 g_return_val_if_fail (self, NULL);
844 g_return_val_if_fail (name, NULL);
845 g_return_val_if_fail (key, NULL);
847 keyname = get_account_keyname (name, key, server_account);
849 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
850 retval = modest_conf_get_list (priv->modest_conf, keyname, list_type, err);
858 modest_account_mgr_unset (ModestAccountMgr *self,
861 gboolean server_account,
864 ModestAccountMgrPrivate *priv;
869 g_return_val_if_fail (self, FALSE);
870 g_return_val_if_fail (name, FALSE);
871 g_return_val_if_fail (key, FALSE);
873 keyname = get_account_keyname (name, key, server_account);
875 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
876 retval = modest_conf_remove_key (priv->modest_conf, keyname, err);
884 /* must be freed by caller */
886 get_account_keyname (const gchar *account_name, const gchar * name, gboolean server_account)
891 namespace = server_account ? MODEST_SERVER_ACCOUNT_NAMESPACE : MODEST_ACCOUNT_NAMESPACE;
894 return g_strdup (namespace);
897 retval = g_strconcat (namespace, "/", account_name, "/", name, NULL);
899 retval = g_strconcat (namespace, "/", account_name, NULL);
901 /* special case: the key has some weird characters */
902 if (!modest_conf_key_is_valid (retval)) {
904 gchar *account_name_esc, *name_esc;
907 account_name_esc = account_name ? modest_conf_key_escape (account_name) : NULL;
908 name_esc = name ? modest_conf_key_escape (name) : NULL;
910 retval = get_account_keyname (account_name_esc, name_esc, server_account);
912 g_free (account_name_esc);