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,
228 ModestAccountMgrPrivate *priv;
231 gchar *default_account;
233 g_return_val_if_fail (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, err)) {
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");
258 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_STORE_ACCOUNT, FALSE);
259 ok = modest_conf_set_string (priv->modest_conf, key, store_account, err);
262 g_printerr ("modest: failed to set store account '%s'\n",
268 if (transport_account) {
269 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_TRANSPORT_ACCOUNT, FALSE);
270 ok = modest_conf_set_string (priv->modest_conf, key, transport_account, err);
273 g_printerr ("modest: failed to set transport account '%s'\n",
278 modest_account_mgr_set_enabled (self, name, TRUE);
280 /* if no default account has been defined yet, do so now */
281 default_account = modest_account_mgr_get_default_account (self);
282 if (!default_account)
283 modest_account_mgr_set_default_account (self, name);
284 g_free (default_account);
293 modest_account_mgr_add_server_account (ModestAccountMgr * self,
294 const gchar * name, const gchar *hostname,
295 const gchar * username, const gchar * password,
296 ModestProtocol proto)
298 ModestAccountMgrPrivate *priv;
300 ModestProtocolType proto_type;
302 g_return_val_if_fail (self, FALSE);
303 g_return_val_if_fail (name, FALSE);
304 g_return_val_if_fail (strchr(name, '/') == NULL, FALSE);
306 proto_type = modest_protocol_info_get_protocol_type (proto);
307 g_return_val_if_fail (proto_type == MODEST_PROTOCOL_TYPE_TRANSPORT ||
308 proto_type == MODEST_PROTOCOL_TYPE_STORE, FALSE);
310 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
313 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_HOSTNAME, TRUE);
314 if (modest_conf_key_exists (priv->modest_conf, key, NULL)) {
315 g_printerr ("modest: server account '%s' already exists", name);
320 modest_conf_set_string (priv->modest_conf, key, null_means_empty(hostname), NULL);
324 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_USERNAME, TRUE);
325 modest_conf_set_string (priv->modest_conf, key, null_means_empty (username), NULL);
329 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_PASSWORD, TRUE);
330 modest_conf_set_string (priv->modest_conf, key, null_means_empty (password), NULL);
334 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_PROTO, TRUE);
335 modest_conf_set_string (priv->modest_conf, key,
336 modest_protocol_info_get_protocol_name(proto),
345 modest_account_mgr_add_server_account_uri (ModestAccountMgr * self,
346 const gchar *name, ModestProtocol proto,
349 ModestAccountMgrPrivate *priv;
352 g_return_val_if_fail (self, FALSE);
353 g_return_val_if_fail (name, FALSE);
354 g_return_val_if_fail (strchr(name, '/') == NULL, FALSE);
355 g_return_val_if_fail (uri, FALSE);
357 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
361 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_PROTO, TRUE);
362 modest_conf_set_string (priv->modest_conf, key,
363 modest_protocol_info_get_protocol_name(proto), NULL);
367 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_URI, TRUE);
368 modest_conf_set_string (priv->modest_conf, key, uri, NULL);
377 modest_account_mgr_remove_account (ModestAccountMgr * self,
379 gboolean server_account,
382 ModestAccountMgrPrivate *priv;
386 g_return_val_if_fail (self, FALSE);
387 g_return_val_if_fail (name, FALSE);
389 if (!modest_account_mgr_account_exists (self, name, server_account, err)) {
390 g_printerr ("modest: account '%s' does not exist\n", name);
394 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
395 key = _modest_account_mgr_get_account_keyname (name, NULL, server_account);
397 retval = modest_conf_remove_key (priv->modest_conf, key, NULL);
405 /* strip the first /n/ character from each element
406 * caller must make sure all elements are strings with
407 * length >= n, and also that data can be freed.
411 strip_prefix_from_elements (GSList * lst, guint n)
414 memmove (lst->data, lst->data + n,
415 strlen(lst->data) - n + 1);
422 modest_account_mgr_search_server_accounts (ModestAccountMgr * self,
423 const gchar * account_name,
424 ModestProtocolType type,
425 ModestProtocol proto)
429 ModestAccountMgrPrivate *priv;
433 g_return_val_if_fail (self, NULL);
435 if (proto != MODEST_PROTOCOL_UNKNOWN) {
436 ModestProtocolType proto_type;
437 proto_type = modest_protocol_info_get_protocol_type (proto);
438 g_return_val_if_fail (proto_type == MODEST_PROTOCOL_TYPE_TRANSPORT ||
439 proto_type == MODEST_PROTOCOL_TYPE_STORE, NULL);
442 key = _modest_account_mgr_get_account_keyname (account_name, NULL, TRUE);
443 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
445 /* get the list of all server accounts */
446 accounts = modest_conf_list_subkeys (priv->modest_conf, key, &err);
449 g_printerr ("modest: failed to get subkeys for '%s'\n", key);
453 /* filter out the ones with the wrong protocol */
454 /* we could optimize for unknown proto / unknown type, but it will only
455 * make the code more complex */
458 gchar *account = _modest_account_mgr_account_from_key ((gchar*)cursor->data, NULL, NULL);
459 gchar *acc_proto = modest_account_mgr_get_string (self, account, MODEST_ACCOUNT_PROTO,
461 ModestProtocol this_proto = modest_protocol_info_get_protocol (acc_proto);
462 ModestProtocolType this_type = modest_protocol_info_get_protocol_type (this_proto);
464 if ((this_type != MODEST_PROTOCOL_TYPE_UNKNOWN && this_type != type) ||
465 (this_proto != MODEST_PROTOCOL_UNKNOWN && this_proto != proto)) {
466 GSList *nxt = cursor->next;
467 accounts = g_slist_delete_link (accounts, cursor);
470 cursor = cursor->next;
476 /* +1 because we must remove the ending '/' as well */
477 strip_prefix_from_elements (accounts, strlen(key)+1);
483 modest_account_mgr_account_names (ModestAccountMgr * self, GError ** err)
486 ModestAccountMgrPrivate *priv;
487 const size_t prefix_len = strlen (MODEST_ACCOUNT_NAMESPACE "/");
489 g_return_val_if_fail (self, NULL);
491 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
493 accounts = modest_conf_list_subkeys (priv->modest_conf,
494 MODEST_ACCOUNT_NAMESPACE, err);
496 strip_prefix_from_elements (accounts, prefix_len);
502 modest_account_mgr_get_string (ModestAccountMgr *self, const gchar *name,
503 const gchar *key, gboolean server_account, GError **err) {
505 ModestAccountMgrPrivate *priv;
510 g_return_val_if_fail (self, NULL);
511 g_return_val_if_fail (name, NULL);
512 g_return_val_if_fail (key, NULL);
514 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
516 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
517 retval = modest_conf_get_string (priv->modest_conf, keyname, err);
525 modest_account_mgr_get_int (ModestAccountMgr *self, const gchar *name,
526 const gchar *key, gboolean server_account, GError **err)
528 ModestAccountMgrPrivate *priv;
533 g_return_val_if_fail (self, -1);
534 g_return_val_if_fail (name, -1);
535 g_return_val_if_fail (key, -1);
537 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
539 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
540 retval = modest_conf_get_int (priv->modest_conf, keyname, err);
549 modest_account_mgr_get_bool (ModestAccountMgr * self, const gchar *account,
550 const gchar * key, gboolean server_account, GError ** err)
552 ModestAccountMgrPrivate *priv;
557 g_return_val_if_fail (self, FALSE);
558 g_return_val_if_fail (account, FALSE);
559 g_return_val_if_fail (key, FALSE);
561 keyname = _modest_account_mgr_get_account_keyname (account, key, server_account);
563 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
564 retval = modest_conf_get_bool (priv->modest_conf, keyname, err);
573 modest_account_mgr_set_string (ModestAccountMgr * self, const gchar * name,
574 const gchar * key, const gchar * val,
575 gboolean server_account, GError ** err)
577 ModestAccountMgrPrivate *priv;
582 g_return_val_if_fail (self, FALSE);
583 g_return_val_if_fail (name, FALSE);
584 g_return_val_if_fail (key, FALSE);
586 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
588 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
590 retval = modest_conf_set_string (priv->modest_conf, keyname, val,
599 modest_account_mgr_set_int (ModestAccountMgr * self, const gchar * name,
600 const gchar * key, int val, gboolean server_account,
603 ModestAccountMgrPrivate *priv;
608 g_return_val_if_fail (self, FALSE);
609 g_return_val_if_fail (name, FALSE);
610 g_return_val_if_fail (key, FALSE);
612 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
614 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
616 retval = modest_conf_set_int (priv->modest_conf, keyname, val, err);
625 modest_account_mgr_set_bool (ModestAccountMgr * self, const gchar * name,
626 const gchar * key, gboolean val, gboolean server_account,
629 ModestAccountMgrPrivate *priv;
634 g_return_val_if_fail (self, FALSE);
635 g_return_val_if_fail (name, FALSE);
636 g_return_val_if_fail (key, FALSE);
638 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
640 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
642 retval = modest_conf_set_bool (priv->modest_conf, keyname, val, err);
649 modest_account_mgr_set_list (ModestAccountMgr *self,
653 ModestConfValueType list_type,
654 gboolean server_account,
657 ModestAccountMgrPrivate *priv;
660 g_return_if_fail (self);
661 g_return_if_fail (name);
662 g_return_if_fail (key);
663 g_return_if_fail (val);
665 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
667 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
668 modest_conf_set_list (priv->modest_conf, keyname, val, list_type, err);
673 modest_account_mgr_account_exists (ModestAccountMgr * self, const gchar * name,
674 gboolean server_account, GError ** err)
676 ModestAccountMgrPrivate *priv;
681 g_return_val_if_fail (self, FALSE);
682 g_return_val_if_fail (name, FALSE);
684 keyname = _modest_account_mgr_get_account_keyname (name, NULL, server_account);
686 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
687 retval = modest_conf_key_exists (priv->modest_conf, keyname, err);
695 modest_account_mgr_get_list (ModestAccountMgr *self,
698 ModestConfValueType list_type,
699 gboolean server_account,
702 ModestAccountMgrPrivate *priv;
707 g_return_val_if_fail (self, NULL);
708 g_return_val_if_fail (name, NULL);
709 g_return_val_if_fail (key, NULL);
711 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
713 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
714 retval = modest_conf_get_list (priv->modest_conf, keyname, list_type, err);
722 modest_account_mgr_unset (ModestAccountMgr *self,
725 gboolean server_account,
728 ModestAccountMgrPrivate *priv;
733 g_return_val_if_fail (self, FALSE);
734 g_return_val_if_fail (name, FALSE);
735 g_return_val_if_fail (key, FALSE);
737 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
739 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
740 retval = modest_conf_remove_key (priv->modest_conf, keyname, err);