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-mgr.h"
34 /* 'private'/'protected' functions */
35 static void modest_account_mgr_class_init (ModestAccountMgrClass * klass);
36 static void modest_account_mgr_init (ModestAccountMgr * obj);
37 static void modest_account_mgr_finalize (GObject * obj);
39 static gchar *get_account_keyname (const gchar * accname, const gchar * name,
40 gboolean server_account);
44 ACCOUNT_CHANGED_SIGNAL,
45 ACCOUNT_REMOVED_SIGNAL,
49 typedef struct _ModestAccountMgrPrivate ModestAccountMgrPrivate;
50 struct _ModestAccountMgrPrivate {
51 ModestConf *modest_conf;
54 #define MODEST_ACCOUNT_MGR_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
55 MODEST_TYPE_ACCOUNT_MGR, \
56 ModestAccountMgrPrivate))
58 static GObjectClass *parent_class = NULL;
59 static guint signals[LAST_SIGNAL] = {0};
62 account_from_key (const gchar *key, gboolean *is_account_key, gboolean *is_server_account)
64 const gchar* account_ns = MODEST_ACCOUNT_NAMESPACE "/";
65 const gchar* server_account_ns = MODEST_SERVER_ACCOUNT_NAMESPACE "/";
67 gchar *account = NULL;
69 /* determine whether it's an account or a server account,
70 * based on the prefix */
71 if (g_str_has_prefix (key, account_ns)) {
73 if (is_server_account)
74 *is_server_account = FALSE;
76 account = g_strdup (key + strlen (account_ns));
78 } else if (g_str_has_prefix (key, server_account_ns)) {
80 if (is_server_account)
81 *is_server_account = TRUE;
83 account = g_strdup (key + strlen (server_account_ns));
87 /* if there are any slashes left in the key, it's not
88 * the toplevel entry for an account
90 cursor = strstr(account, "/");
92 if (is_account_key && cursor)
93 *is_account_key = TRUE;
95 /* put a NULL where the first slash was */
106 on_key_change (ModestConf *conf, const gchar *key, ModestConfEvent event, gpointer user_data)
108 ModestAccountMgr *self;
109 ModestAccountMgrPrivate *priv;
112 gboolean is_account_key, is_server_account;
115 self = MODEST_ACCOUNT_MGR (user_data);
116 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
118 account = account_from_key (key, &is_account_key, &is_server_account);
120 /* if this is not an account-related key change, ignore */
124 /* account was removed -- emit this, even if the account was disabled */
125 if (is_account_key && event == MODEST_CONF_EVENT_KEY_UNSET) {
126 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_REMOVED_SIGNAL], 0,
127 account, is_server_account);
132 /* is this account enabled? */
133 if (is_server_account)
136 enabled = modest_account_mgr_account_get_enabled (self, account);
138 /* account was changed.
139 * and always notify when enabled/disabled changes
141 if (enabled || g_str_has_suffix (key, MODEST_ACCOUNT_ENABLED))
142 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_CHANGED_SIGNAL], 0,
143 account, key, is_server_account);
150 modest_account_mgr_get_type (void)
152 static GType my_type = 0;
155 static const GTypeInfo my_info = {
156 sizeof (ModestAccountMgrClass),
157 NULL, /* base init */
158 NULL, /* base finalize */
159 (GClassInitFunc) modest_account_mgr_class_init,
160 NULL, /* class finalize */
161 NULL, /* class data */
162 sizeof (ModestAccountMgr),
164 (GInstanceInitFunc) modest_account_mgr_init,
168 my_type = g_type_register_static (G_TYPE_OBJECT,
176 modest_account_mgr_class_init (ModestAccountMgrClass * klass)
178 GObjectClass *gobject_class;
179 gobject_class = (GObjectClass *) klass;
181 parent_class = g_type_class_peek_parent (klass);
182 gobject_class->finalize = modest_account_mgr_finalize;
184 g_type_class_add_private (gobject_class,
185 sizeof (ModestAccountMgrPrivate));
187 /* signal definitions */
188 signals[ACCOUNT_REMOVED_SIGNAL] =
189 g_signal_new ("account_removed",
190 G_TYPE_FROM_CLASS (klass),
192 G_STRUCT_OFFSET(ModestAccountMgrClass,account_removed),
194 modest_marshal_VOID__STRING_BOOLEAN,
195 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_BOOLEAN);
196 signals[ACCOUNT_CHANGED_SIGNAL] =
197 g_signal_new ("account_changed",
198 G_TYPE_FROM_CLASS (klass),
200 G_STRUCT_OFFSET(ModestAccountMgrClass,account_changed),
202 modest_marshal_VOID__STRING_STRING_BOOLEAN,
203 G_TYPE_NONE, 3, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_BOOLEAN);
208 modest_account_mgr_init (ModestAccountMgr * obj)
210 ModestAccountMgrPrivate *priv =
211 MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
213 priv->modest_conf = NULL;
217 modest_account_mgr_finalize (GObject * obj)
219 ModestAccountMgrPrivate *priv =
220 MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
222 if (priv->modest_conf) {
223 g_object_unref (G_OBJECT(priv->modest_conf));
224 priv->modest_conf = NULL;
227 G_OBJECT_CLASS(parent_class)->finalize (obj);
231 modest_account_mgr_new (ModestConf * conf)
234 ModestAccountMgrPrivate *priv;
236 g_return_val_if_fail (conf, NULL);
238 obj = G_OBJECT (g_object_new (MODEST_TYPE_ACCOUNT_MGR, NULL));
239 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
241 g_object_ref (G_OBJECT(conf));
242 priv->modest_conf = conf;
244 g_signal_connect (G_OBJECT (conf), "key_changed",
245 G_CALLBACK (on_key_change),
248 return MODEST_ACCOUNT_MGR (obj);
253 null_means_empty (const gchar * str)
255 return str ? str : "";
260 modest_account_mgr_account_set_enabled (ModestAccountMgr *self, const gchar* name,
263 return modest_account_mgr_set_bool (self, name,
264 MODEST_ACCOUNT_ENABLED, enabled,
270 modest_account_mgr_account_get_enabled (ModestAccountMgr *self, const gchar* name)
272 return modest_account_mgr_get_bool (self, name,
273 MODEST_ACCOUNT_ENABLED, FALSE,
279 modest_account_mgr_add_account (ModestAccountMgr *self,
281 const gchar *store_account,
282 const gchar *transport_account,
285 ModestAccountMgrPrivate *priv;
289 g_return_val_if_fail (self, FALSE);
290 g_return_val_if_fail (name, FALSE);
291 g_return_val_if_fail (strchr(name, '/') == NULL, FALSE);
293 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
296 * we create the account by adding an account 'dir', with the name <name>,
297 * and in that the 'display_name' string key
299 key = get_account_keyname (name, MODEST_ACCOUNT_DISPLAY_NAME, FALSE);
300 if (modest_account_mgr_account_exists (self, key, FALSE, err)) {
301 g_printerr ("modest: account already exists\n");
306 ok = modest_conf_set_string (priv->modest_conf, key, name, err);
309 g_printerr ("modest: cannot set display name\n");
314 key = get_account_keyname (name, MODEST_ACCOUNT_STORE_ACCOUNT, FALSE);
315 ok = modest_conf_set_string (priv->modest_conf, key, store_account, err);
318 g_printerr ("modest: failed to set store account '%s'\n",
324 if (transport_account) {
325 key = get_account_keyname (name, MODEST_ACCOUNT_TRANSPORT_ACCOUNT, FALSE);
326 ok = modest_conf_set_string (priv->modest_conf, key, transport_account, err);
329 g_printerr ("modest: failed to set transport account '%s'\n",
335 modest_account_mgr_account_set_enabled (self, name, TRUE);
344 modest_account_mgr_add_server_account (ModestAccountMgr * self,
345 const gchar * name, const gchar *hostname,
346 const gchar * username, const gchar * password,
347 ModestProtocol proto)
349 ModestAccountMgrPrivate *priv;
351 ModestProtocolType proto_type;
353 g_return_val_if_fail (self, FALSE);
354 g_return_val_if_fail (name, FALSE);
355 g_return_val_if_fail (strchr(name, '/') == NULL, FALSE);
357 proto_type = modest_protocol_info_get_protocol_type (proto);
358 g_return_val_if_fail (proto_type == MODEST_PROTOCOL_TYPE_TRANSPORT ||
359 proto_type == MODEST_PROTOCOL_TYPE_STORE, FALSE);
361 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
364 key = get_account_keyname (name, MODEST_ACCOUNT_HOSTNAME, TRUE);
365 if (modest_conf_key_exists (priv->modest_conf, key, NULL)) {
366 g_printerr ("modest: server account '%s' already exists", name);
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,
387 modest_protocol_info_get_protocol_name(proto),
397 modest_account_mgr_remove_account (ModestAccountMgr * self,
399 gboolean server_account,
402 ModestAccountMgrPrivate *priv;
406 g_return_val_if_fail (self, FALSE);
407 g_return_val_if_fail (name, FALSE);
409 if (!modest_account_mgr_account_exists (self, name, server_account, err)) {
410 g_printerr ("modest: account '%s' does not exist\n", name);
414 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
415 key = get_account_keyname (name, NULL, server_account);
417 retval = modest_conf_remove_key (priv->modest_conf, key, NULL);
425 /* strip the first /n/ character from each element
426 * caller must make sure all elements are strings with
427 * length >= n, and also that data can be freed.
431 strip_prefix_from_elements (GSList * lst, guint n)
434 memmove (lst->data, lst->data + n,
435 strlen(lst->data) - n + 1);
442 modest_account_mgr_search_server_accounts (ModestAccountMgr * self,
443 const gchar * account_name,
444 ModestProtocolType type,
445 ModestProtocol proto)
449 ModestAccountMgrPrivate *priv;
453 g_return_val_if_fail (self, NULL);
455 if (proto != MODEST_PROTOCOL_UNKNOWN) {
456 ModestProtocolType proto_type;
457 proto_type = modest_protocol_info_get_protocol_type (proto);
458 g_return_val_if_fail (proto_type == MODEST_PROTOCOL_TYPE_TRANSPORT ||
459 proto_type == MODEST_PROTOCOL_TYPE_STORE, NULL);
462 key = get_account_keyname (account_name, NULL, TRUE);
463 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
465 /* get the list of all server accounts */
466 accounts = modest_conf_list_subkeys (priv->modest_conf, key, &err);
469 g_printerr ("modest: failed to get subkeys for '%s'\n", key);
473 /* filter out the ones with the wrong protocol */
474 /* we could optimize for unknown proto / unknown type, but it will only
475 * make the code more complex */
478 gchar *account = account_from_key ((gchar*)cursor->data, NULL, NULL);
479 gchar *acc_proto = modest_account_mgr_get_string (self, account, MODEST_ACCOUNT_PROTO,
481 ModestProtocol this_proto = modest_protocol_info_get_protocol (acc_proto);
482 ModestProtocolType this_type = modest_protocol_info_get_protocol_type (this_proto);
484 if ((this_type != MODEST_PROTOCOL_TYPE_UNKNOWN && this_type != type) ||
485 (this_proto != MODEST_PROTOCOL_UNKNOWN && this_proto != proto)) {
486 GSList *nxt = cursor->next;
487 accounts = g_slist_delete_link (accounts, cursor);
490 cursor = cursor->next;
496 /* +1 because we must remove the ending '/' as well */
497 strip_prefix_from_elements (accounts, strlen(key)+1);
503 modest_account_mgr_account_names (ModestAccountMgr * self, GError ** err)
506 ModestAccountMgrPrivate *priv;
507 const size_t prefix_len = strlen (MODEST_ACCOUNT_NAMESPACE "/");
509 g_return_val_if_fail (self, NULL);
511 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
513 accounts = modest_conf_list_subkeys (priv->modest_conf,
514 MODEST_ACCOUNT_NAMESPACE, err);
516 strip_prefix_from_elements (accounts, prefix_len);
521 static ModestServerAccountData*
522 modest_account_mgr_get_server_account_data (ModestAccountMgr *self, const gchar* name)
524 ModestServerAccountData *data;
527 g_return_val_if_fail (modest_account_mgr_account_exists (self, name,
529 data = g_new0 (ModestServerAccountData, 1);
531 data->account_name = g_strdup (name);
532 data->hostname = modest_account_mgr_get_string (self, name,
533 MODEST_ACCOUNT_HOSTNAME,
535 data->username = modest_account_mgr_get_string (self, name,
536 MODEST_ACCOUNT_USERNAME,
539 proto = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_PROTO,
541 data->proto = modest_protocol_info_get_protocol (proto);
544 data->password = modest_account_mgr_get_string (self, name,
545 MODEST_ACCOUNT_PASSWORD,
552 modest_account_mgr_free_server_account_data (ModestAccountMgr *self,
553 ModestServerAccountData* data)
555 g_return_if_fail (self);
558 return; /* not an error */
560 g_free (data->account_name);
561 data->account_name = NULL;
563 g_free (data->hostname);
564 data->hostname = NULL;
566 g_free (data->username);
567 data->username = NULL;
569 g_free (data->password);
570 data->password = NULL;
576 modest_account_mgr_get_account_data (ModestAccountMgr *self, const gchar* name)
578 ModestAccountData *data;
579 gchar *server_account;
581 g_return_val_if_fail (self, NULL);
582 g_return_val_if_fail (name, NULL);
583 g_return_val_if_fail (modest_account_mgr_account_exists (self, name,
585 data = g_new0 (ModestAccountData, 1);
587 data->account_name = g_strdup (name);
589 data->display_name = modest_account_mgr_get_string (self, name,
590 MODEST_ACCOUNT_DISPLAY_NAME,
592 data->fullname = modest_account_mgr_get_string (self, name,
593 MODEST_ACCOUNT_FULLNAME,
595 data->email = modest_account_mgr_get_string (self, name,
596 MODEST_ACCOUNT_EMAIL,
598 data->enabled = modest_account_mgr_account_get_enabled (self, name);
601 server_account = modest_account_mgr_get_string (self, name,
602 MODEST_ACCOUNT_STORE_ACCOUNT,
604 if (server_account) {
605 data->store_account =
606 modest_account_mgr_get_server_account_data (self,
608 g_free (server_account);
612 server_account = modest_account_mgr_get_string (self, name,
613 MODEST_ACCOUNT_TRANSPORT_ACCOUNT,
615 if (server_account) {
616 data->transport_account =
617 modest_account_mgr_get_server_account_data (self,
619 g_free (server_account);
627 modest_account_mgr_free_account_data (ModestAccountMgr *self, ModestAccountData *data)
629 g_return_if_fail (self);
631 if (!data) /* not an error */
634 g_free (data->account_name);
635 g_free (data->display_name);
636 g_free (data->fullname);
637 g_free (data->email);
639 modest_account_mgr_free_server_account_data (self, data->store_account);
640 modest_account_mgr_free_server_account_data (self, data->transport_account);
647 modest_account_mgr_get_string (ModestAccountMgr *self, const gchar *name,
648 const gchar *key, gboolean server_account, GError **err) {
650 ModestAccountMgrPrivate *priv;
655 g_return_val_if_fail (self, NULL);
656 g_return_val_if_fail (name, NULL);
657 g_return_val_if_fail (key, NULL);
659 keyname = get_account_keyname (name, key, server_account);
661 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
662 retval = modest_conf_get_string (priv->modest_conf, keyname, err);
670 modest_account_mgr_get_int (ModestAccountMgr *self, const gchar *name,
671 const gchar *key, gboolean server_account, GError **err)
673 ModestAccountMgrPrivate *priv;
678 g_return_val_if_fail (self, -1);
679 g_return_val_if_fail (name, -1);
680 g_return_val_if_fail (key, -1);
682 keyname = get_account_keyname (name, key, server_account);
684 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
685 retval = modest_conf_get_int (priv->modest_conf, keyname, err);
694 modest_account_mgr_get_bool (ModestAccountMgr * self, const gchar *account,
695 const gchar * key, gboolean server_account, GError ** err)
697 ModestAccountMgrPrivate *priv;
702 g_return_val_if_fail (self, FALSE);
703 g_return_val_if_fail (account, FALSE);
704 g_return_val_if_fail (key, FALSE);
706 keyname = get_account_keyname (account, key, server_account);
708 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
709 retval = modest_conf_get_bool (priv->modest_conf, keyname, err);
718 modest_account_mgr_set_string (ModestAccountMgr * self, const gchar * name,
719 const gchar * key, const gchar * val,
720 gboolean server_account, GError ** err)
722 ModestAccountMgrPrivate *priv;
727 g_return_val_if_fail (self, FALSE);
728 g_return_val_if_fail (name, FALSE);
729 g_return_val_if_fail (key, FALSE);
731 keyname = get_account_keyname (name, key, server_account);
733 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
735 retval = modest_conf_set_string (priv->modest_conf, keyname, val,
744 modest_account_mgr_set_int (ModestAccountMgr * self, const gchar * name,
745 const gchar * key, int val, gboolean server_account,
748 ModestAccountMgrPrivate *priv;
753 g_return_val_if_fail (self, FALSE);
754 g_return_val_if_fail (name, FALSE);
755 g_return_val_if_fail (key, FALSE);
757 keyname = get_account_keyname (name, key, server_account);
759 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
761 retval = modest_conf_set_int (priv->modest_conf, keyname, val, err);
770 modest_account_mgr_set_bool (ModestAccountMgr * self, const gchar * name,
771 const gchar * key, gboolean val, gboolean server_account,
774 ModestAccountMgrPrivate *priv;
779 g_return_val_if_fail (self, FALSE);
780 g_return_val_if_fail (name, FALSE);
781 g_return_val_if_fail (key, FALSE);
783 keyname = get_account_keyname (name, key, server_account);
785 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
787 retval = modest_conf_set_bool (priv->modest_conf, keyname, val, err);
794 modest_account_mgr_set_list (ModestAccountMgr *self,
798 ModestConfValueType list_type,
799 gboolean server_account,
802 ModestAccountMgrPrivate *priv;
805 g_return_if_fail (self);
806 g_return_if_fail (name);
807 g_return_if_fail (key);
808 g_return_if_fail (val);
810 keyname = get_account_keyname (name, key, server_account);
812 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
813 modest_conf_set_list (priv->modest_conf, keyname, val, list_type, err);
818 modest_account_mgr_account_exists (ModestAccountMgr * self, const gchar * name,
819 gboolean server_account, GError ** err)
821 ModestAccountMgrPrivate *priv;
826 g_return_val_if_fail (self, FALSE);
827 g_return_val_if_fail (name, FALSE);
829 keyname = get_account_keyname (name, NULL, server_account);
831 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
832 retval = modest_conf_key_exists (priv->modest_conf, keyname, err);
840 modest_account_mgr_get_list (ModestAccountMgr *self,
843 ModestConfValueType list_type,
844 gboolean server_account,
847 ModestAccountMgrPrivate *priv;
852 g_return_val_if_fail (self, NULL);
853 g_return_val_if_fail (name, NULL);
854 g_return_val_if_fail (key, NULL);
856 keyname = get_account_keyname (name, key, server_account);
858 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
859 retval = modest_conf_get_list (priv->modest_conf, keyname, list_type, err);
867 modest_account_mgr_unset (ModestAccountMgr *self,
870 gboolean server_account,
873 ModestAccountMgrPrivate *priv;
878 g_return_val_if_fail (self, FALSE);
879 g_return_val_if_fail (name, FALSE);
880 g_return_val_if_fail (key, FALSE);
882 keyname = get_account_keyname (name, key, server_account);
884 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
885 retval = modest_conf_remove_key (priv->modest_conf, keyname, err);
893 /* must be freed by caller */
895 get_account_keyname (const gchar *account_name, const gchar * name, gboolean server_account)
900 namespace = server_account ? MODEST_SERVER_ACCOUNT_NAMESPACE : MODEST_ACCOUNT_NAMESPACE;
903 return g_strdup (namespace);
906 retval = g_strconcat (namespace, "/", account_name, "/", name, NULL);
908 retval = g_strconcat (namespace, "/", account_name, NULL);
910 /* special case: the key has some weird characters */
911 if (!modest_conf_key_is_valid (retval)) {
913 gchar *account_name_esc, *name_esc;
916 account_name_esc = account_name ? modest_conf_key_escape (account_name) : NULL;
917 name_esc = name ? modest_conf_key_escape (name) : NULL;
919 retval = get_account_keyname (account_name_esc, name_esc, server_account);
921 g_free (account_name_esc);