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>
33 #include <modest-account-mgr-priv.h>
34 #include <modest-account-mgr-helpers.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);
43 ACCOUNT_CHANGED_SIGNAL,
44 ACCOUNT_REMOVED_SIGNAL,
50 static GObjectClass *parent_class = NULL;
51 static guint signals[LAST_SIGNAL] = {0};
54 on_key_change (ModestConf *conf, const gchar *key, ModestConfEvent event, gpointer user_data)
56 ModestAccountMgr *self;
57 ModestAccountMgrPrivate *priv;
60 gboolean is_account_key, is_server_account;
63 self = MODEST_ACCOUNT_MGR (user_data);
64 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
66 /* there is only one not-really-account key which will still emit
67 * a signal: a change in MODEST_CONF_DEFAULT_ACCOUNT */
68 if (key && strcmp (key, MODEST_CONF_DEFAULT_ACCOUNT) == 0) {
69 gchar *default_account =
70 modest_account_mgr_get_default_account (self);
71 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_CHANGED_SIGNAL], 0,
72 default_account, key, FALSE);
73 g_free (default_account);
77 account = _modest_account_mgr_account_from_key (key, &is_account_key, &is_server_account);
79 /* if this is not an account-related key change, ignore */
83 /* account was removed -- emit this, even if the account was disabled */
84 if (is_account_key && event == MODEST_CONF_EVENT_KEY_UNSET) {
85 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_REMOVED_SIGNAL], 0,
86 account, is_server_account);
91 /* is this account enabled? */
92 if (is_server_account)
95 enabled = modest_account_mgr_get_enabled (self, account);
97 /* server account was changed, default account was changed
98 * and always notify when enabled/disabled changes
101 g_str_has_suffix (key, MODEST_ACCOUNT_ENABLED) ||
102 strcmp (key, MODEST_CONF_DEFAULT_ACCOUNT) == 0)
103 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_CHANGED_SIGNAL], 0,
104 account, key, is_server_account);
111 modest_account_mgr_get_type (void)
113 static GType my_type = 0;
116 static const GTypeInfo my_info = {
117 sizeof (ModestAccountMgrClass),
118 NULL, /* base init */
119 NULL, /* base finalize */
120 (GClassInitFunc) modest_account_mgr_class_init,
121 NULL, /* class finalize */
122 NULL, /* class data */
123 sizeof (ModestAccountMgr),
125 (GInstanceInitFunc) modest_account_mgr_init,
129 my_type = g_type_register_static (G_TYPE_OBJECT,
137 modest_account_mgr_class_init (ModestAccountMgrClass * klass)
139 GObjectClass *gobject_class;
140 gobject_class = (GObjectClass *) klass;
142 parent_class = g_type_class_peek_parent (klass);
143 gobject_class->finalize = modest_account_mgr_finalize;
145 g_type_class_add_private (gobject_class,
146 sizeof (ModestAccountMgrPrivate));
148 /* signal definitions */
149 signals[ACCOUNT_REMOVED_SIGNAL] =
150 g_signal_new ("account_removed",
151 G_TYPE_FROM_CLASS (klass),
153 G_STRUCT_OFFSET(ModestAccountMgrClass,account_removed),
155 modest_marshal_VOID__STRING_BOOLEAN,
156 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_BOOLEAN);
157 signals[ACCOUNT_CHANGED_SIGNAL] =
158 g_signal_new ("account_changed",
159 G_TYPE_FROM_CLASS (klass),
161 G_STRUCT_OFFSET(ModestAccountMgrClass,account_changed),
163 modest_marshal_VOID__STRING_STRING_BOOLEAN,
164 G_TYPE_NONE, 3, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_BOOLEAN);
169 modest_account_mgr_init (ModestAccountMgr * obj)
171 ModestAccountMgrPrivate *priv =
172 MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
174 priv->modest_conf = NULL;
178 modest_account_mgr_finalize (GObject * obj)
180 ModestAccountMgrPrivate *priv =
181 MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
183 if (priv->modest_conf) {
184 g_object_unref (G_OBJECT(priv->modest_conf));
185 priv->modest_conf = NULL;
188 G_OBJECT_CLASS(parent_class)->finalize (obj);
193 modest_account_mgr_new (ModestConf *conf)
196 ModestAccountMgrPrivate *priv;
198 g_return_val_if_fail (conf, NULL);
200 obj = G_OBJECT (g_object_new (MODEST_TYPE_ACCOUNT_MGR, NULL));
201 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
203 g_object_ref (G_OBJECT(conf));
204 priv->modest_conf = conf;
206 g_signal_connect (G_OBJECT (conf), "key_changed",
207 G_CALLBACK (on_key_change),
210 return MODEST_ACCOUNT_MGR (obj);
215 null_means_empty (const gchar * str)
217 return str ? str : "";
222 modest_account_mgr_add_account (ModestAccountMgr *self,
224 const gchar *store_account,
225 const gchar *transport_account)
227 ModestAccountMgrPrivate *priv;
230 gchar *default_account;
233 g_return_val_if_fail (MODEST_IS_ACCOUNT_MGR(self), FALSE);
234 g_return_val_if_fail (name, FALSE);
235 g_return_val_if_fail (strchr(name, '/') == NULL, FALSE);
237 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
240 * we create the account by adding an account 'dir', with the name <name>,
241 * and in that the 'display_name' string key
243 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_DISPLAY_NAME, FALSE);
244 if (modest_account_mgr_account_exists (self, key, FALSE)) {
245 g_printerr ("modest: account already exists\n");
250 ok = modest_conf_set_string (priv->modest_conf, key, name, &err);
253 g_printerr ("modest: cannot set display name\n");
255 g_printerr ("modest: %s\n", err->message);
262 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_STORE_ACCOUNT, FALSE);
263 ok = modest_conf_set_string (priv->modest_conf, key, store_account, &err);
266 g_printerr ("modest: failed to set store account '%s'\n",
269 g_printerr ("modest: %s\n", err->message);
277 if (transport_account) {
278 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_TRANSPORT_ACCOUNT,
280 ok = modest_conf_set_string (priv->modest_conf, key, transport_account, &err);
283 g_printerr ("modest: failed to set transport account '%s'\n",
286 g_printerr ("modest: %s\n", err->message);
292 modest_account_mgr_set_enabled (self, name, TRUE);
294 /* if no default account has been defined yet, do so now */
295 default_account = modest_account_mgr_get_default_account (self);
296 if (!default_account)
297 modest_account_mgr_set_default_account (self, name);
298 g_free (default_account);
307 modest_account_mgr_add_server_account (ModestAccountMgr * self,
308 const gchar * name, const gchar *hostname,
309 const gchar * username, const gchar * password,
310 ModestProtocol proto)
312 ModestAccountMgrPrivate *priv;
314 ModestProtocolType proto_type;
318 g_return_val_if_fail (MODEST_IS_ACCOUNT_MGR(self), FALSE);
319 g_return_val_if_fail (name, FALSE);
320 g_return_val_if_fail (strchr(name, '/') == NULL, FALSE);
322 proto_type = modest_protocol_info_get_protocol_type (proto);
323 g_return_val_if_fail (proto_type == MODEST_PROTOCOL_TYPE_TRANSPORT ||
324 proto_type == MODEST_PROTOCOL_TYPE_STORE, FALSE);
326 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
329 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_HOSTNAME, TRUE);
330 if (modest_conf_key_exists (priv->modest_conf, key, &err)) {
331 g_printerr ("modest: server account '%s' already exists", name);
339 modest_conf_set_string (priv->modest_conf, key, null_means_empty(hostname), &err);
341 g_printerr ("modest: failed to set %s: %s\n", key, err->message);
350 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_USERNAME, TRUE);
351 ok = modest_conf_set_string (priv->modest_conf, key, null_means_empty (username), &err);
353 g_printerr ("modest: failed to set %s: %s\n", key, err->message);
363 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_PASSWORD, TRUE);
364 ok = modest_conf_set_string (priv->modest_conf, key, null_means_empty (password), &err);
366 g_printerr ("modest: failed to set %s: %s\n", key, err->message);
375 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_PROTO, TRUE);
376 ok = modest_conf_set_string (priv->modest_conf, key,
377 modest_protocol_info_get_protocol_name(proto), &err);
379 g_printerr ("modest: failed to set %s: %s\n", key, err->message);
387 g_printerr ("modest: failed to add server account\n");
396 modest_account_mgr_add_server_account_uri (ModestAccountMgr * self,
397 const gchar *name, ModestProtocol proto,
400 ModestAccountMgrPrivate *priv;
404 g_return_val_if_fail (MODEST_IS_ACCOUNT_MGR(self), FALSE);
405 g_return_val_if_fail (name, FALSE);
406 g_return_val_if_fail (strchr(name, '/') == NULL, FALSE);
407 g_return_val_if_fail (uri, FALSE);
409 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
413 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_PROTO, TRUE);
414 ok = modest_conf_set_string (priv->modest_conf, key,
415 modest_protocol_info_get_protocol_name(proto), NULL);
419 g_printerr ("modest: failed to set proto\n");
424 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_URI, TRUE);
425 ok = modest_conf_set_string (priv->modest_conf, key, uri, NULL);
429 g_printerr ("modest: failed to set uri\n");
438 modest_account_mgr_remove_account (ModestAccountMgr * self,
439 const gchar * name, gboolean server_account)
441 ModestAccountMgrPrivate *priv;
446 g_return_val_if_fail (MODEST_IS_ACCOUNT_MGR(self), FALSE);
447 g_return_val_if_fail (name, FALSE);
449 if (!modest_account_mgr_account_exists (self, name, server_account)) {
450 g_printerr ("modest: account '%s' does not exist\n", name);
454 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
455 key = _modest_account_mgr_get_account_keyname (name, NULL, server_account);
457 retval = modest_conf_remove_key (priv->modest_conf, key, &err);
461 g_printerr ("modest: error removing key: %s\n", err->message);
470 /* strip the first /n/ character from each element
471 * caller must make sure all elements are strings with
472 * length >= n, and also that data can be freed.
476 strip_prefix_from_elements (GSList * lst, guint n)
479 memmove (lst->data, lst->data + n,
480 strlen(lst->data) - n + 1);
487 modest_account_mgr_search_server_accounts (ModestAccountMgr * self,
488 const gchar * account_name,
489 ModestProtocolType type,
490 ModestProtocol proto)
494 ModestAccountMgrPrivate *priv;
498 g_return_val_if_fail (self, NULL);
500 if (proto != MODEST_PROTOCOL_UNKNOWN) {
501 ModestProtocolType proto_type;
502 proto_type = modest_protocol_info_get_protocol_type (proto);
503 g_return_val_if_fail (proto_type == MODEST_PROTOCOL_TYPE_TRANSPORT ||
504 proto_type == MODEST_PROTOCOL_TYPE_STORE, NULL);
507 key = _modest_account_mgr_get_account_keyname (account_name, NULL, TRUE);
508 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
510 /* get the list of all server accounts */
511 accounts = modest_conf_list_subkeys (priv->modest_conf, key, &err);
513 g_printerr ("modest: failed to get subkeys for '%s' (%s)\n", key,
519 /* filter out the ones with the wrong protocol */
520 /* we could optimize for unknown proto / unknown type, but it will only
521 * make the code more complex */
524 gchar *account = _modest_account_mgr_account_from_key ((gchar*)cursor->data, NULL, NULL);
525 gchar *acc_proto = modest_account_mgr_get_string (self, account, MODEST_ACCOUNT_PROTO,TRUE);
526 ModestProtocol this_proto = modest_protocol_info_get_protocol (acc_proto);
527 ModestProtocolType this_type = modest_protocol_info_get_protocol_type (this_proto);
529 if ((this_type != MODEST_PROTOCOL_TYPE_UNKNOWN && this_type != type) ||
530 (this_proto != MODEST_PROTOCOL_UNKNOWN && this_proto != proto)) {
531 GSList *nxt = cursor->next;
532 accounts = g_slist_delete_link (accounts, cursor);
535 cursor = cursor->next;
541 /* +1 because we must remove the ending '/' as well */
542 strip_prefix_from_elements (accounts, strlen(key)+1);
548 modest_account_mgr_account_names (ModestAccountMgr * self)
551 ModestAccountMgrPrivate *priv;
554 const size_t prefix_len = strlen (MODEST_ACCOUNT_NAMESPACE "/");
556 g_return_val_if_fail (self, NULL);
558 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
560 accounts = modest_conf_list_subkeys (priv->modest_conf,
561 MODEST_ACCOUNT_NAMESPACE, &err);
563 g_printerr ("modest: failed to get subkeys (%s): %s\n",
564 MODEST_ACCOUNT_NAMESPACE, err->message);
566 return NULL; /* assume accounts did not get value when err is set...*/
569 strip_prefix_from_elements (accounts, prefix_len);
575 modest_account_mgr_get_string (ModestAccountMgr *self, const gchar *name,
576 const gchar *key, gboolean server_account) {
578 ModestAccountMgrPrivate *priv;
584 g_return_val_if_fail (self, NULL);
585 g_return_val_if_fail (name, NULL);
586 g_return_val_if_fail (key, NULL);
588 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
590 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
591 retval = modest_conf_get_string (priv->modest_conf, keyname, &err);
593 g_printerr ("modest: error getting string '%s': %s\n", keyname, err->message);
604 modest_account_mgr_get_password (ModestAccountMgr *self, const gchar *name,
605 const gchar *key, gboolean server_account)
607 return modest_account_mgr_get_string (self, name, key, server_account);
614 modest_account_mgr_get_int (ModestAccountMgr *self, const gchar *name, const gchar *key,
615 gboolean server_account)
617 ModestAccountMgrPrivate *priv;
623 g_return_val_if_fail (MODEST_IS_ACCOUNT_MGR(self), -1);
624 g_return_val_if_fail (name, -1);
625 g_return_val_if_fail (key, -1);
627 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
629 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
630 retval = modest_conf_get_int (priv->modest_conf, keyname, &err);
632 g_printerr ("modest: error getting int '%s': %s\n", keyname, err->message);
644 modest_account_mgr_get_bool (ModestAccountMgr * self, const gchar *account,
645 const gchar * key, gboolean server_account)
647 ModestAccountMgrPrivate *priv;
653 g_return_val_if_fail (MODEST_IS_ACCOUNT_MGR(self), FALSE);
654 g_return_val_if_fail (account, FALSE);
655 g_return_val_if_fail (key, FALSE);
657 keyname = _modest_account_mgr_get_account_keyname (account, key, server_account);
659 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
660 retval = modest_conf_get_bool (priv->modest_conf, keyname, &err);
662 g_printerr ("modest: error getting bool '%s': %s\n", keyname, err->message);
674 modest_account_mgr_get_list (ModestAccountMgr *self, const gchar *name,
675 const gchar *key, ModestConfValueType list_type,
676 gboolean server_account)
678 ModestAccountMgrPrivate *priv;
684 g_return_val_if_fail (MODEST_IS_ACCOUNT_MGR(self), NULL);
685 g_return_val_if_fail (name, NULL);
686 g_return_val_if_fail (key, NULL);
688 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
690 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
691 retval = modest_conf_get_list (priv->modest_conf, keyname, list_type, &err);
693 g_printerr ("modest: error getting list '%s': %s\n", keyname,
705 modest_account_mgr_set_string (ModestAccountMgr * self, const gchar * name,
706 const gchar * key, const gchar * val, gboolean server_account)
708 ModestAccountMgrPrivate *priv;
714 g_return_val_if_fail (MODEST_IS_ACCOUNT_MGR(self), FALSE);
715 g_return_val_if_fail (name, FALSE);
716 g_return_val_if_fail (key, FALSE);
718 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
720 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
722 retval = modest_conf_set_string (priv->modest_conf, keyname, val, &err);
724 g_printerr ("modest: error setting string '%s': %s\n", keyname, err->message);
734 modest_account_mgr_set_password (ModestAccountMgr * self, const gchar * name,
735 const gchar * key, const gchar * val, gboolean server_account)
737 return modest_account_mgr_set_password (self, name, key, val, server_account);
743 modest_account_mgr_set_int (ModestAccountMgr * self, const gchar * name,
744 const gchar * key, int val, gboolean server_account)
746 ModestAccountMgrPrivate *priv;
752 g_return_val_if_fail (MODEST_IS_ACCOUNT_MGR(self), FALSE);
753 g_return_val_if_fail (name, FALSE);
754 g_return_val_if_fail (key, FALSE);
756 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
758 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
760 retval = modest_conf_set_int (priv->modest_conf, keyname, val, &err);
762 g_printerr ("modest: error setting int '%s': %s\n", keyname, err->message);
773 modest_account_mgr_set_bool (ModestAccountMgr * self, const gchar * name,
774 const gchar * key, gboolean val, gboolean server_account)
776 ModestAccountMgrPrivate *priv;
782 g_return_val_if_fail (MODEST_IS_ACCOUNT_MGR(self), FALSE);
783 g_return_val_if_fail (name, FALSE);
784 g_return_val_if_fail (key, FALSE);
786 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
788 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
790 retval = modest_conf_set_bool (priv->modest_conf, keyname, val, &err);
792 g_printerr ("modest: error setting bool '%s': %s\n", keyname, err->message);
802 modest_account_mgr_set_list (ModestAccountMgr *self,
806 ModestConfValueType list_type,
807 gboolean server_account)
809 ModestAccountMgrPrivate *priv;
814 g_return_val_if_fail (self, FALSE);
815 g_return_val_if_fail (name, FALSE);
816 g_return_val_if_fail (key, FALSE);
817 g_return_val_if_fail (val, FALSE);
819 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
821 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
822 retval = modest_conf_set_list (priv->modest_conf, keyname, val, list_type, &err);
824 g_printerr ("modest: error setting list '%s': %s\n", keyname, err->message);
834 modest_account_mgr_account_exists (ModestAccountMgr * self, const gchar * name,
835 gboolean server_account)
837 ModestAccountMgrPrivate *priv;
843 g_return_val_if_fail (MODEST_IS_ACCOUNT_MGR(self), FALSE);
844 g_return_val_if_fail (name, FALSE);
846 keyname = _modest_account_mgr_get_account_keyname (name, NULL, server_account);
848 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
849 retval = modest_conf_key_exists (priv->modest_conf, keyname, &err);
851 g_printerr ("modest: error determining existance of '%s': %s\n", keyname,
863 modest_account_mgr_unset (ModestAccountMgr *self, const gchar *name,
864 const gchar *key, gboolean server_account)
866 ModestAccountMgrPrivate *priv;
872 g_return_val_if_fail (MODEST_IS_ACCOUNT_MGR(self), FALSE);
873 g_return_val_if_fail (name, FALSE);
874 g_return_val_if_fail (key, FALSE);
876 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
878 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
879 retval = modest_conf_remove_key (priv->modest_conf, keyname, &err);
881 g_printerr ("modest: error unsetting'%s': %s\n", keyname,