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;
62 static guint signals[LAST_SIGNAL] = {0};
66 account_from_key (const gchar *key, gboolean *is_account_key, gboolean *is_server_account)
68 const gchar* account_ns = MODEST_ACCOUNT_NAMESPACE "/";
69 const gchar* server_account_ns = MODEST_SERVER_ACCOUNT_NAMESPACE "/";
71 gchar *account = NULL;
73 /* determine if it's an account or a server account,
74 * based on the prefix */
75 if (g_str_has_prefix (key, account_ns)) {
77 if (is_server_account)
78 *is_server_account = FALSE;
80 account = g_strdup (key + strlen (account_ns));
82 } else if (g_str_has_prefix (key, server_account_ns)) {
84 if (is_server_account)
85 *is_server_account = TRUE;
87 account = g_strdup (key + strlen (server_account_ns));
91 /* if there are any slashes left in the key, it's not
92 * the toplevel entry for an account
94 cursor = strstr(account, "/");
96 if (is_account_key && cursor)
97 *is_account_key = TRUE;
99 /* put a NULL where the first slash was */
110 on_key_change (ModestConf *conf, const gchar *key, ModestConfEvent event, gpointer user_data)
112 ModestAccountMgr *self;
113 ModestAccountMgrPrivate *priv;
116 gboolean is_account_key, is_server_account;
119 self = MODEST_ACCOUNT_MGR (user_data);
120 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
122 account = account_from_key (key, &is_account_key, &is_server_account);
124 /* if this is not an account-related key change, ignore */
128 /* account was removed -- emit this, even if the account was disabled */
129 if (is_account_key && event == MODEST_CONF_EVENT_KEY_UNSET) {
130 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_REMOVED_SIGNAL], 0,
131 account, is_server_account);
136 /* is this account enabled? */
137 if (is_server_account)
140 enabled = modest_account_mgr_account_get_enabled (self, account);
142 /* account was changed.
143 * and always notify when enabled/disabled changes
145 if (enabled || g_str_has_suffix (key, MODEST_ACCOUNT_ENABLED))
146 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_CHANGED_SIGNAL], 0,
147 account, key, is_server_account);
154 modest_account_mgr_get_type (void)
156 static GType my_type = 0;
159 static const GTypeInfo my_info = {
160 sizeof (ModestAccountMgrClass),
161 NULL, /* base init */
162 NULL, /* base finalize */
163 (GClassInitFunc) modest_account_mgr_class_init,
164 NULL, /* class finalize */
165 NULL, /* class data */
166 sizeof (ModestAccountMgr),
168 (GInstanceInitFunc) modest_account_mgr_init,
172 my_type = g_type_register_static (G_TYPE_OBJECT,
180 modest_account_mgr_class_init (ModestAccountMgrClass * klass)
182 GObjectClass *gobject_class;
183 gobject_class = (GObjectClass *) klass;
185 parent_class = g_type_class_peek_parent (klass);
186 gobject_class->finalize = modest_account_mgr_finalize;
188 g_type_class_add_private (gobject_class,
189 sizeof (ModestAccountMgrPrivate));
191 /* signal definitions */
192 signals[ACCOUNT_REMOVED_SIGNAL] =
193 g_signal_new ("account_removed",
194 G_TYPE_FROM_CLASS (klass),
196 G_STRUCT_OFFSET(ModestAccountMgrClass,account_removed),
198 modest_marshal_VOID__STRING_BOOLEAN,
199 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_BOOLEAN);
200 signals[ACCOUNT_CHANGED_SIGNAL] =
201 g_signal_new ("account_changed",
202 G_TYPE_FROM_CLASS (klass),
204 G_STRUCT_OFFSET(ModestAccountMgrClass,account_changed),
206 modest_marshal_VOID__STRING_STRING_BOOLEAN,
207 G_TYPE_NONE, 3, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_BOOLEAN);
212 modest_account_mgr_init (ModestAccountMgr * obj)
214 ModestAccountMgrPrivate *priv =
215 MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
217 priv->modest_conf = NULL;
218 priv->proto_mgr = modest_protocol_mgr_new ();
222 modest_account_mgr_finalize (GObject * obj)
224 ModestAccountMgrPrivate *priv =
225 MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
227 if (priv->modest_conf) {
228 g_object_unref (G_OBJECT(priv->modest_conf));
229 priv->modest_conf = NULL;
232 if (priv->proto_mgr) {
233 g_object_unref (G_OBJECT(priv->proto_mgr));
234 priv->proto_mgr = NULL;
237 G_OBJECT_CLASS(parent_class)->finalize (obj);
241 modest_account_mgr_new (ModestConf * conf)
244 ModestAccountMgrPrivate *priv;
246 g_return_val_if_fail (conf, NULL);
248 obj = G_OBJECT (g_object_new (MODEST_TYPE_ACCOUNT_MGR, NULL));
249 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
251 g_object_ref (G_OBJECT(conf));
252 priv->modest_conf = conf;
254 g_signal_connect (G_OBJECT (conf), "key_changed",
255 G_CALLBACK (on_key_change),
258 return MODEST_ACCOUNT_MGR (obj);
263 null_means_empty (const gchar * str)
265 return str ? str : "";
270 modest_account_mgr_account_set_enabled (ModestAccountMgr *self, const gchar* name,
273 return modest_account_mgr_set_bool (self, name,
274 MODEST_ACCOUNT_ENABLED, enabled,
280 modest_account_mgr_account_get_enabled (ModestAccountMgr *self, const gchar* name)
282 return modest_account_mgr_get_bool (self, name,
283 MODEST_ACCOUNT_ENABLED, FALSE,
289 modest_account_mgr_add_account (ModestAccountMgr *self,
291 const gchar *store_account,
292 const gchar *transport_account,
295 ModestAccountMgrPrivate *priv;
299 g_return_val_if_fail (self, FALSE);
300 g_return_val_if_fail (name, FALSE);
302 if (modest_account_mgr_account_exists (self, name, FALSE, err)) {
303 g_printerr ("modest: account already exists\n");
308 * we create the account by adding an account 'dir', with the name <name>,
309 * and in that the 'display_name' string key
311 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
313 key = get_account_keyname (name, MODEST_ACCOUNT_DISPLAY_NAME, FALSE);
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);
364 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
366 key = get_account_keyname (name, NULL, TRUE);
367 if (modest_conf_key_exists (priv->modest_conf, key, NULL)) {
368 g_printerr ("modest: server account '%s' already exists", name);
375 key = get_account_keyname (name, MODEST_ACCOUNT_HOSTNAME, TRUE);
376 modest_conf_set_string (priv->modest_conf, key, null_means_empty(hostname), NULL);
380 key = get_account_keyname (name, MODEST_ACCOUNT_USERNAME, TRUE);
381 modest_conf_set_string (priv->modest_conf, key, null_means_empty (username), NULL);
385 key = get_account_keyname (name, MODEST_ACCOUNT_PASSWORD, TRUE);
386 modest_conf_set_string (priv->modest_conf, key, null_means_empty (password), NULL);
390 key = get_account_keyname (name, MODEST_ACCOUNT_PROTO, TRUE);
391 modest_conf_set_string (priv->modest_conf, key, null_means_empty (proto), NULL);
400 modest_account_mgr_remove_account (ModestAccountMgr * self,
402 gboolean server_account,
405 ModestAccountMgrPrivate *priv;
409 g_return_val_if_fail (self, FALSE);
410 g_return_val_if_fail (name, FALSE);
412 if (!modest_account_mgr_account_exists (self, name, server_account, err)) {
413 g_printerr ("modest: account '%s' does not exist\n", name);
417 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
418 key = get_account_keyname (name, NULL, server_account);
420 retval = modest_conf_remove_key (priv->modest_conf, key, NULL);
428 /* strip the first /n/ character from each element */
429 /* caller must make sure all elements are strings with
430 * length >= n, and also that data can be freed.
433 strip_prefix_from_elements (GSList * lst, guint n)
435 GSList *cursor = lst;
438 gchar *str = (gchar *) cursor->data;
439 cursor->data = g_strdup (str + n);
441 cursor = cursor->next;
448 modest_account_mgr_search_server_accounts (ModestAccountMgr * self,
449 const gchar * account_name,
450 ModestProtocolType type,
455 ModestAccountMgrPrivate *priv;
459 g_return_val_if_fail (self, NULL);
461 key = get_account_keyname (account_name, NULL, TRUE);
462 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
464 /* get the list of all server accounts */
465 accounts = modest_conf_list_subkeys (priv->modest_conf, key, &err);
468 g_printerr ("modest: failed to get subkeys for '%s'\n", key);
472 /* no restrictions, return everything */
473 if (type == MODEST_PROTOCOL_TYPE_ANY && !proto)
474 return strip_prefix_from_elements (accounts, strlen(key)+1);
475 /* +1 because we must remove the ending '/' as well */
477 /* otherwise, filter out the none-matching ones */
483 account = account_from_key ((gchar*)cursor->data, NULL, NULL);
484 acc_proto = modest_account_mgr_get_string (self, account, MODEST_ACCOUNT_PROTO,
486 if ((!acc_proto) || /* proto not defined? */
487 (type != MODEST_PROTOCOL_TYPE_ANY && /* proto type ... */
488 !modest_protocol_mgr_protocol_is_valid (priv->proto_mgr,
489 acc_proto,type)) || /* ... matches? */
490 (proto && strcmp (proto, acc_proto) != 0)) { /* proto matches? */
491 /* match! remove from the list */
492 GSList *nxt = cursor->next;
493 accounts = g_slist_delete_link (accounts, cursor);
496 cursor = cursor->next;
502 return strip_prefix_from_elements (accounts, strlen(key)+1);
503 /* +1 because we must remove the ending '/' as well */
508 modest_account_mgr_account_names (ModestAccountMgr * self, GError ** err)
511 ModestAccountMgrPrivate *priv;
512 const size_t prefix_len = strlen (MODEST_ACCOUNT_NAMESPACE "/");
514 g_return_val_if_fail (self, NULL);
516 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
518 accounts = modest_conf_list_subkeys (priv->modest_conf,
519 MODEST_ACCOUNT_NAMESPACE, err);
521 return strip_prefix_from_elements (accounts, prefix_len);
525 static ModestServerAccountData*
526 modest_account_mgr_get_server_account_data (ModestAccountMgr *self, const gchar* name)
528 ModestServerAccountData *data;
530 g_return_val_if_fail (modest_account_mgr_account_exists (self, name,
532 data = g_new0 (ModestServerAccountData, 1);
534 data->account_name = g_strdup (name);
535 data->hostname = modest_account_mgr_get_string (self, name,
536 MODEST_ACCOUNT_HOSTNAME,
538 data->username = modest_account_mgr_get_string (self, name,
539 MODEST_ACCOUNT_USERNAME,
541 data->proto = modest_account_mgr_get_string (self, name,
542 MODEST_ACCOUNT_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 g_free (data->hostname);
562 g_free (data->username);
563 g_free (data->proto);
564 g_free (data->password);
571 modest_account_mgr_get_account_data (ModestAccountMgr *self,
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,
620 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);
640 modest_account_mgr_get_string (ModestAccountMgr *self, const gchar *name,
641 const gchar *key, gboolean server_account, GError **err) {
643 ModestAccountMgrPrivate *priv;
648 g_return_val_if_fail (self, NULL);
649 g_return_val_if_fail (name, NULL);
650 g_return_val_if_fail (key, NULL);
652 keyname = get_account_keyname (name, key, server_account);
654 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
655 retval = modest_conf_get_string (priv->modest_conf, keyname, err);
663 modest_account_mgr_get_int (ModestAccountMgr *self, const gchar *name,
664 const gchar *key, gboolean server_account, GError **err)
666 ModestAccountMgrPrivate *priv;
671 g_return_val_if_fail (self, -1);
672 g_return_val_if_fail (name, -1);
673 g_return_val_if_fail (key, -1);
675 keyname = get_account_keyname (name, key, server_account);
677 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
678 retval = modest_conf_get_int (priv->modest_conf, keyname, err);
687 modest_account_mgr_get_bool (ModestAccountMgr * self, const gchar *account,
688 const gchar * key, gboolean server_account, GError ** err)
690 ModestAccountMgrPrivate *priv;
695 g_return_val_if_fail (self, FALSE);
696 g_return_val_if_fail (account, FALSE);
697 g_return_val_if_fail (key, FALSE);
699 keyname = get_account_keyname (account, key, server_account);
701 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
702 retval = modest_conf_get_bool (priv->modest_conf, keyname, err);
711 modest_account_mgr_set_string (ModestAccountMgr * self, const gchar * name,
712 const gchar * key, const gchar * val,
713 gboolean server_account, GError ** err)
715 ModestAccountMgrPrivate *priv;
720 g_return_val_if_fail (self, FALSE);
721 g_return_val_if_fail (name, FALSE);
722 g_return_val_if_fail (key, FALSE);
724 keyname = get_account_keyname (name, key, server_account);
726 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
728 retval = modest_conf_set_string (priv->modest_conf, keyname, val,
737 modest_account_mgr_set_int (ModestAccountMgr * self, const gchar * name,
738 const gchar * key, int val, gboolean server_account,
741 ModestAccountMgrPrivate *priv;
746 g_return_val_if_fail (self, FALSE);
747 g_return_val_if_fail (name, FALSE);
748 g_return_val_if_fail (key, FALSE);
750 keyname = get_account_keyname (name, key, server_account);
752 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
754 retval = modest_conf_set_int (priv->modest_conf, keyname, val, err);
763 modest_account_mgr_set_bool (ModestAccountMgr * self, const gchar * name,
764 const gchar * key, gboolean val, gboolean server_account,
767 ModestAccountMgrPrivate *priv;
772 g_return_val_if_fail (self, FALSE);
773 g_return_val_if_fail (name, FALSE);
774 g_return_val_if_fail (key, FALSE);
776 keyname = get_account_keyname (name, key, server_account);
778 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
780 retval = modest_conf_set_bool (priv->modest_conf, keyname, val, err);
788 modest_account_mgr_account_exists (ModestAccountMgr * self, const gchar * name,
789 gboolean server_account, GError ** err)
791 ModestAccountMgrPrivate *priv;
796 g_return_val_if_fail (self, FALSE);
797 g_return_val_if_fail (name, FALSE);
799 keyname = get_account_keyname (name, NULL, server_account);
801 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
802 retval = modest_conf_key_exists (priv->modest_conf, keyname, err);
810 modest_account_mgr_get_list (ModestAccountMgr *self,
813 ModestConfValueType list_type,
814 gboolean server_account,
817 ModestAccountMgrPrivate *priv;
822 g_return_val_if_fail (self, NULL);
823 g_return_val_if_fail (name, NULL);
824 g_return_val_if_fail (key, NULL);
826 keyname = get_account_keyname (name, key, server_account);
828 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
829 retval = modest_conf_get_list (priv->modest_conf, keyname, list_type, err);
835 /* must be freed by caller */
837 get_account_keyname (const gchar * accname, const gchar * name, gboolean server_account)
839 gchar *namespace, *account_name, *retval;
841 namespace = server_account ? MODEST_SERVER_ACCOUNT_NAMESPACE : MODEST_ACCOUNT_NAMESPACE;
844 return g_strdup (namespace);
846 account_name = modest_conf_key_escape (NULL, accname);
849 retval = g_strconcat (namespace, "/", accname, "/", name, NULL);
851 retval = g_strconcat (namespace, "/", accname, NULL);
853 g_free (account_name);