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, gboolean server_account);
44 ACCOUNT_CHANGED_SIGNAL,
45 ACCOUNT_REMOVED_SIGNAL,
49 typedef struct _ModestAccountMgrPrivate ModestAccountMgrPrivate;
50 struct _ModestAccountMgrPrivate {
51 ModestConf *modest_conf;
52 GSList *current_accounts;
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;
61 static guint signals[LAST_SIGNAL] = {0};
65 account_from_key (const gchar *key, gboolean *is_account_key, gboolean *is_server_account)
67 const gchar* account_ns = MODEST_ACCOUNT_NAMESPACE "/";
68 const gchar* server_account_ns = MODEST_SERVER_ACCOUNT_NAMESPACE "/";
70 gchar *account = NULL;
72 /* determine if it's an account or a server account,
73 * based on the prefix */
74 if (g_str_has_prefix (key, account_ns)) {
76 if (is_server_account)
77 *is_server_account = FALSE;
79 account = g_strdup (key + strlen (account_ns));
81 } else if (g_str_has_prefix (key, server_account_ns)) {
83 if (is_server_account)
84 *is_server_account = TRUE;
86 account = g_strdup (key + strlen (server_account_ns));
90 /* if there are any slashes left in the key, it's not
91 * the toplevel entry for an account
93 cursor = strstr(account, "/");
95 if (is_account_key && cursor)
96 *is_account_key = TRUE;
98 /* put a NULL where the first slash was */
109 on_key_change (ModestConf *conf, const gchar *key, ModestConfEvent event, gpointer user_data)
111 ModestAccountMgr *self;
112 ModestAccountMgrPrivate *priv;
115 gboolean is_account_key, is_server_account;
118 self = MODEST_ACCOUNT_MGR (user_data);
119 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
121 account = account_from_key (key, &is_account_key, &is_server_account);
123 /* account was removed -- emit this, even if the account was disabled */
124 if (is_account_key && event == MODEST_CONF_EVENT_KEY_UNSET) {
125 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_REMOVED_SIGNAL], 0,
126 account, is_server_account);
131 /* is this account enabled? */
132 enabled = modest_account_mgr_account_get_enabled (self, account,
135 /* account was changed.
136 * and always notify when enabled/disabled changes
138 if (enabled || g_str_has_suffix (key, MODEST_ACCOUNT_ENABLED))
139 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_CHANGED_SIGNAL], 0,
140 account, key, is_server_account);
147 modest_account_mgr_get_type (void)
149 static GType my_type = 0;
152 static const GTypeInfo my_info = {
153 sizeof (ModestAccountMgrClass),
154 NULL, /* base init */
155 NULL, /* base finalize */
156 (GClassInitFunc) modest_account_mgr_class_init,
157 NULL, /* class finalize */
158 NULL, /* class data */
159 sizeof (ModestAccountMgr),
161 (GInstanceInitFunc) modest_account_mgr_init,
164 my_type = g_type_register_static (G_TYPE_OBJECT,
172 modest_account_mgr_class_init (ModestAccountMgrClass * klass)
174 GObjectClass *gobject_class;
175 gobject_class = (GObjectClass *) klass;
177 parent_class = g_type_class_peek_parent (klass);
178 gobject_class->finalize = modest_account_mgr_finalize;
180 g_type_class_add_private (gobject_class,
181 sizeof (ModestAccountMgrPrivate));
183 /* signal definitions */
184 signals[ACCOUNT_REMOVED_SIGNAL] =
185 g_signal_new ("account_removed",
186 G_TYPE_FROM_CLASS (klass),
188 G_STRUCT_OFFSET(ModestAccountMgrClass,account_removed),
190 modest_marshal_VOID__STRING_BOOLEAN,
191 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_BOOLEAN);
192 signals[ACCOUNT_CHANGED_SIGNAL] =
193 g_signal_new ("account_changed",
194 G_TYPE_FROM_CLASS (klass),
196 G_STRUCT_OFFSET(ModestAccountMgrClass,account_changed),
198 modest_marshal_VOID__STRING_STRING_BOOLEAN,
199 G_TYPE_NONE, 3, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_BOOLEAN);
204 modest_account_mgr_init (ModestAccountMgr * obj)
206 ModestAccountMgrPrivate *priv =
207 MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
209 priv->modest_conf = NULL;
213 modest_account_mgr_finalize (GObject * obj)
215 ModestAccountMgrPrivate *priv =
216 MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
218 if (priv->modest_conf) {
219 g_object_unref (G_OBJECT(priv->modest_conf));
220 priv->modest_conf = NULL;
226 modest_account_mgr_new (ModestConf * conf)
229 ModestAccountMgrPrivate *priv;
231 g_return_val_if_fail (conf, NULL);
233 obj = G_OBJECT (g_object_new (MODEST_TYPE_ACCOUNT_MGR, NULL));
234 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
236 g_object_ref (G_OBJECT(conf));
237 priv->modest_conf = conf;
239 g_signal_connect (G_OBJECT (conf), "key_changed",
240 G_CALLBACK (on_key_change),
243 return MODEST_ACCOUNT_MGR (obj);
248 null_means_empty (const gchar * str)
250 return str ? str : "";
255 modest_account_mgr_account_set_enabled (ModestAccountMgr *self, const gchar* name,
256 gboolean is_server_account, gboolean enabled)
258 return modest_account_mgr_set_bool (self, name,
259 MODEST_ACCOUNT_ENABLED, enabled,
260 is_server_account, NULL);
265 modest_account_mgr_account_get_enabled (ModestAccountMgr *self, const gchar* name,
266 gboolean is_server_account)
268 return modest_account_mgr_get_bool (self, name,
269 MODEST_ACCOUNT_ENABLED, is_server_account,
275 modest_account_mgr_add_account (ModestAccountMgr *self,
277 const gchar *store_account,
278 const gchar *transport_account,
281 ModestAccountMgrPrivate *priv;
285 g_return_val_if_fail (self, FALSE);
286 g_return_val_if_fail (name, FALSE);
288 if (modest_account_mgr_account_exists (self, name, FALSE, err)) {
289 g_printerr ("modest: account already exists\n");
294 * we create the account by adding an account 'dir', with the name <name>,
295 * and in that the 'display_name' string key
297 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
299 key = get_account_keyname (name, MODEST_ACCOUNT_DISPLAY_NAME, FALSE);
300 ok = modest_conf_set_string (priv->modest_conf, key, name, err);
304 g_printerr ("modest: cannot set display name\n");
309 key = get_account_keyname (name, MODEST_ACCOUNT_STORE_ACCOUNT, FALSE);
310 ok = modest_conf_set_string (priv->modest_conf, key, store_account, err);
313 g_printerr ("modest: failed to set store account '%s'\n",
319 if (transport_account) {
320 key = get_account_keyname (name, MODEST_ACCOUNT_TRANSPORT_ACCOUNT, FALSE);
321 ok = modest_conf_set_string (priv->modest_conf, key, transport_account, err);
324 g_printerr ("modest: failed to set transport account '%s'\n",
330 modest_account_mgr_account_set_enabled (self, name, FALSE, TRUE);
339 modest_account_mgr_add_server_account (ModestAccountMgr * self,
341 const gchar * hostname,
342 const gchar * username,
343 const gchar * password,
346 ModestAccountMgrPrivate *priv;
349 g_return_val_if_fail (self, FALSE);
350 g_return_val_if_fail (name, FALSE);
352 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
354 key = get_account_keyname (name, NULL, TRUE);
355 if (modest_conf_key_exists (priv->modest_conf, key, NULL)) {
356 g_printerr ("modest: server account '%s' already exists", name);
363 key = get_account_keyname (name, MODEST_ACCOUNT_HOSTNAME, TRUE);
364 modest_conf_set_string (priv->modest_conf, key, null_means_empty(hostname), NULL);
368 key = get_account_keyname (name, MODEST_ACCOUNT_USERNAME, TRUE);
369 modest_conf_set_string (priv->modest_conf, key, null_means_empty (username), NULL);
373 key = get_account_keyname (name, MODEST_ACCOUNT_PASSWORD, TRUE);
374 modest_conf_set_string (priv->modest_conf, key, null_means_empty (password), NULL);
378 key = get_account_keyname (name, MODEST_ACCOUNT_PROTO, TRUE);
379 modest_conf_set_string (priv->modest_conf, key, null_means_empty (proto), NULL);
383 modest_account_mgr_account_set_enabled (self, name, TRUE, TRUE);
391 modest_account_mgr_remove_account (ModestAccountMgr * self,
393 gboolean server_account,
396 ModestAccountMgrPrivate *priv;
400 g_return_val_if_fail (self, FALSE);
401 g_return_val_if_fail (name, FALSE);
403 if (!modest_account_mgr_account_exists (self, name, server_account, err)) {
404 g_printerr ("modest: account '%s' does not exist\n", name);
408 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
409 key = get_account_keyname (name, NULL, server_account);
411 retval = modest_conf_remove_key (priv->modest_conf, key, NULL);
419 /* strip the first /n/ character from each element */
420 /* caller must make sure all elements are strings with
421 * length >= n, and also that data can be freed.
424 strip_prefix_from_elements (GSList * lst, guint n)
426 GSList *cursor = lst;
429 gchar *str = (gchar *) cursor->data;
430 cursor->data = g_strdup (str + n);
432 cursor = cursor->next;
439 modest_account_mgr_search_server_accounts (ModestAccountMgr * self,
440 const gchar * account_name,
441 ModestProtoType type,
443 gboolean only_enabled)
447 ModestAccountMgrPrivate *priv;
451 g_return_val_if_fail (self, NULL);
453 key = get_account_keyname (account_name, NULL, TRUE);
454 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
456 /* get the list of all server accounts */
457 accounts = modest_conf_list_subkeys (priv->modest_conf, key, &err);
460 g_printerr ("modest: failed to get subkeys for '%s'\n", key);
464 /* no restrictions, return everything */
465 if (type == MODEST_PROTO_TYPE_ANY && !proto)
466 return strip_prefix_from_elements (accounts, strlen(key)+1);
467 /* +1 because we must remove the ending '/' as well */
469 /* otherwise, filter out the none-matching ones */
476 account = account_from_key ((gchar*)cursor->data, NULL, NULL);
478 enabled = modest_account_mgr_account_get_enabled (self, account, TRUE);
479 acc_proto = modest_account_mgr_get_string (self, account, MODEST_ACCOUNT_PROTO,
481 if ((!acc_proto) || /* proto not defined? */
482 (type != MODEST_PROTO_TYPE_ANY && /* proto type ... */
483 modest_proto_type (acc_proto) != type) || /* ... matches? */
484 (proto && strcmp (proto, acc_proto) != 0) || /* proto matches? */
485 (!enabled && only_enabled)) { /* account enabled? */
486 /* match! remove from the list */
487 GSList *nxt = cursor->next;
488 accounts = g_slist_delete_link (accounts, cursor);
491 cursor = cursor->next;
497 return strip_prefix_from_elements (accounts, strlen(key)+1);
498 /* +1 because we must remove the ending '/' as well */
503 modest_account_mgr_account_names (ModestAccountMgr * self, GError ** err)
506 ModestAccountMgrPrivate *priv;
507 const size_t prefix_len = strlen (MODEST_ACCOUNT_NAMESPACE "/");
510 g_return_val_if_fail (self, NULL);
512 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
514 accounts = modest_conf_list_subkeys (priv->modest_conf,
515 MODEST_ACCOUNT_NAMESPACE, err);
516 return strip_prefix_from_elements (accounts, prefix_len);
521 modest_account_mgr_get_string (ModestAccountMgr *self, const gchar *name,
522 const gchar *key, gboolean server_account, GError **err) {
524 ModestAccountMgrPrivate *priv;
529 g_return_val_if_fail (self, NULL);
530 g_return_val_if_fail (name, NULL);
531 g_return_val_if_fail (key, NULL);
533 keyname = get_account_keyname (name, key, server_account);
535 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
536 retval = modest_conf_get_string (priv->modest_conf, keyname, err);
544 modest_account_mgr_get_int (ModestAccountMgr *self, const gchar *name,
545 const gchar *key, gboolean server_account, GError **err)
547 ModestAccountMgrPrivate *priv;
552 g_return_val_if_fail (self, -1);
553 g_return_val_if_fail (name, -1);
554 g_return_val_if_fail (key, -1);
556 keyname = get_account_keyname (name, key, server_account);
558 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
559 retval = modest_conf_get_int (priv->modest_conf, keyname, err);
568 modest_account_mgr_get_bool (ModestAccountMgr * self, const gchar *account,
569 const gchar * key, gboolean server_account, GError ** err)
571 ModestAccountMgrPrivate *priv;
576 g_return_val_if_fail (self, FALSE);
577 g_return_val_if_fail (account, FALSE);
578 g_return_val_if_fail (key, FALSE);
580 keyname = get_account_keyname (account, key, server_account);
582 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
583 retval = modest_conf_get_bool (priv->modest_conf, keyname, err);
592 modest_account_mgr_set_string (ModestAccountMgr * self, const gchar * name,
593 const gchar * key, const gchar * val,
594 gboolean server_account, GError ** err)
596 ModestAccountMgrPrivate *priv;
601 g_return_val_if_fail (self, FALSE);
602 g_return_val_if_fail (name, FALSE);
603 g_return_val_if_fail (key, FALSE);
605 keyname = get_account_keyname (name, key, server_account);
607 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
609 retval = modest_conf_set_string (priv->modest_conf, keyname, val,
618 modest_account_mgr_set_int (ModestAccountMgr * self, const gchar * name,
619 const gchar * key, int val, gboolean server_account,
622 ModestAccountMgrPrivate *priv;
627 g_return_val_if_fail (self, FALSE);
628 g_return_val_if_fail (name, FALSE);
629 g_return_val_if_fail (key, FALSE);
631 keyname = get_account_keyname (name, key, server_account);
633 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
635 retval = modest_conf_set_int (priv->modest_conf, keyname, val, err);
644 modest_account_mgr_set_bool (ModestAccountMgr * self, const gchar * name,
645 const gchar * key, gboolean val, gboolean server_account,
648 ModestAccountMgrPrivate *priv;
653 g_return_val_if_fail (self, FALSE);
654 g_return_val_if_fail (name, FALSE);
655 g_return_val_if_fail (key, FALSE);
657 keyname = get_account_keyname (name, key, server_account);
659 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
661 retval = modest_conf_set_bool (priv->modest_conf, keyname, val, err);
669 modest_account_mgr_account_exists (ModestAccountMgr * self, const gchar * name,
670 gboolean server_account, GError ** err)
672 ModestAccountMgrPrivate *priv;
677 g_return_val_if_fail (self, FALSE);
678 g_return_val_if_fail (name, FALSE);
680 keyname = get_account_keyname (name, NULL, server_account);
682 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
683 retval = modest_conf_key_exists (priv->modest_conf, keyname, err);
690 /* must be freed by caller */
692 get_account_keyname (const gchar * accname, const gchar * name, gboolean server_account)
694 gchar *namespace, *account_name, *retval;
696 namespace = server_account ? MODEST_SERVER_ACCOUNT_NAMESPACE : MODEST_ACCOUNT_NAMESPACE;
699 return g_strdup (namespace);
701 account_name = modest_conf_key_escape (NULL, accname);
704 retval = g_strconcat (namespace, "/", accname, "/", name, NULL);
706 retval = g_strconcat (namespace, "/", accname, NULL);
708 g_free (account_name);