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>
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);
41 typedef struct _ModestAccountMgrPrivate ModestAccountMgrPrivate;
42 struct _ModestAccountMgrPrivate {
43 ModestConf *modest_conf;
46 #define MODEST_ACCOUNT_MGR_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
47 MODEST_TYPE_ACCOUNT_MGR, \
48 ModestAccountMgrPrivate))
51 ACCOUNT_CHANGED_SIGNAL,
52 ACCOUNT_REMOVED_SIGNAL,
58 static GObjectClass *parent_class = NULL;
59 static guint signals[LAST_SIGNAL] = {0};
62 on_key_change (ModestConf *conf, const gchar *key, ModestConfEvent event, gpointer user_data)
64 ModestAccountMgr *self;
65 ModestAccountMgrPrivate *priv;
68 gboolean is_account_key, is_server_account;
71 self = MODEST_ACCOUNT_MGR (user_data);
72 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
74 account = _modest_account_mgr_account_from_key (key, &is_account_key, &is_server_account);
76 /* if this is not an account-related key change, ignore */
80 /* account was removed -- emit this, even if the account was disabled */
81 if (is_account_key && event == MODEST_CONF_EVENT_KEY_UNSET) {
82 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_REMOVED_SIGNAL], 0,
83 account, is_server_account);
88 /* is this account enabled? */
89 if (is_server_account)
92 enabled = modest_account_mgr_account_get_enabled (self, account);
94 /* account was changed.
95 * and always notify when enabled/disabled changes
97 if (enabled || g_str_has_suffix (key, MODEST_ACCOUNT_ENABLED))
98 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_CHANGED_SIGNAL], 0,
99 account, key, is_server_account);
106 modest_account_mgr_get_type (void)
108 static GType my_type = 0;
111 static const GTypeInfo my_info = {
112 sizeof (ModestAccountMgrClass),
113 NULL, /* base init */
114 NULL, /* base finalize */
115 (GClassInitFunc) modest_account_mgr_class_init,
116 NULL, /* class finalize */
117 NULL, /* class data */
118 sizeof (ModestAccountMgr),
120 (GInstanceInitFunc) modest_account_mgr_init,
124 my_type = g_type_register_static (G_TYPE_OBJECT,
132 modest_account_mgr_class_init (ModestAccountMgrClass * klass)
134 GObjectClass *gobject_class;
135 gobject_class = (GObjectClass *) klass;
137 parent_class = g_type_class_peek_parent (klass);
138 gobject_class->finalize = modest_account_mgr_finalize;
140 g_type_class_add_private (gobject_class,
141 sizeof (ModestAccountMgrPrivate));
143 /* signal definitions */
144 signals[ACCOUNT_REMOVED_SIGNAL] =
145 g_signal_new ("account_removed",
146 G_TYPE_FROM_CLASS (klass),
148 G_STRUCT_OFFSET(ModestAccountMgrClass,account_removed),
150 modest_marshal_VOID__STRING_BOOLEAN,
151 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_BOOLEAN);
152 signals[ACCOUNT_CHANGED_SIGNAL] =
153 g_signal_new ("account_changed",
154 G_TYPE_FROM_CLASS (klass),
156 G_STRUCT_OFFSET(ModestAccountMgrClass,account_changed),
158 modest_marshal_VOID__STRING_STRING_BOOLEAN,
159 G_TYPE_NONE, 3, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_BOOLEAN);
164 modest_account_mgr_init (ModestAccountMgr * obj)
166 ModestAccountMgrPrivate *priv =
167 MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
169 priv->modest_conf = NULL;
173 modest_account_mgr_finalize (GObject * obj)
175 ModestAccountMgrPrivate *priv =
176 MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
178 if (priv->modest_conf) {
179 g_object_unref (G_OBJECT(priv->modest_conf));
180 priv->modest_conf = NULL;
183 G_OBJECT_CLASS(parent_class)->finalize (obj);
187 modest_account_mgr_new (ModestConf * conf)
190 ModestAccountMgrPrivate *priv;
192 g_return_val_if_fail (conf, NULL);
194 obj = G_OBJECT (g_object_new (MODEST_TYPE_ACCOUNT_MGR, NULL));
195 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
197 g_object_ref (G_OBJECT(conf));
198 priv->modest_conf = conf;
200 g_signal_connect (G_OBJECT (conf), "key_changed",
201 G_CALLBACK (on_key_change),
204 return MODEST_ACCOUNT_MGR (obj);
209 null_means_empty (const gchar * str)
211 return str ? str : "";
216 modest_account_mgr_add_account (ModestAccountMgr *self,
218 const gchar *store_account,
219 const gchar *transport_account,
222 ModestAccountMgrPrivate *priv;
226 g_return_val_if_fail (self, FALSE);
227 g_return_val_if_fail (name, FALSE);
228 g_return_val_if_fail (strchr(name, '/') == NULL, FALSE);
230 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
233 * we create the account by adding an account 'dir', with the name <name>,
234 * and in that the 'display_name' string key
236 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_DISPLAY_NAME, FALSE);
237 if (modest_account_mgr_account_exists (self, key, FALSE, err)) {
238 g_printerr ("modest: account already exists\n");
243 ok = modest_conf_set_string (priv->modest_conf, key, name, err);
246 g_printerr ("modest: cannot set display name\n");
251 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_STORE_ACCOUNT, FALSE);
252 ok = modest_conf_set_string (priv->modest_conf, key, store_account, err);
255 g_printerr ("modest: failed to set store account '%s'\n",
261 if (transport_account) {
262 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_TRANSPORT_ACCOUNT, FALSE);
263 ok = modest_conf_set_string (priv->modest_conf, key, transport_account, err);
266 g_printerr ("modest: failed to set transport account '%s'\n",
272 modest_account_mgr_account_set_enabled (self, name, TRUE);
281 modest_account_mgr_add_server_account (ModestAccountMgr * self,
282 const gchar * name, const gchar *hostname,
283 const gchar * username, const gchar * password,
284 ModestProtocol proto)
286 ModestAccountMgrPrivate *priv;
288 ModestProtocolType proto_type;
290 g_return_val_if_fail (self, FALSE);
291 g_return_val_if_fail (name, FALSE);
292 g_return_val_if_fail (strchr(name, '/') == NULL, FALSE);
294 proto_type = modest_protocol_info_get_protocol_type (proto);
295 g_return_val_if_fail (proto_type == MODEST_PROTOCOL_TYPE_TRANSPORT ||
296 proto_type == MODEST_PROTOCOL_TYPE_STORE, FALSE);
298 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
301 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_HOSTNAME, TRUE);
302 if (modest_conf_key_exists (priv->modest_conf, key, NULL)) {
303 g_printerr ("modest: server account '%s' already exists", name);
308 modest_conf_set_string (priv->modest_conf, key, null_means_empty(hostname), NULL);
312 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_USERNAME, TRUE);
313 modest_conf_set_string (priv->modest_conf, key, null_means_empty (username), NULL);
317 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_PASSWORD, TRUE);
318 modest_conf_set_string (priv->modest_conf, key, null_means_empty (password), NULL);
322 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_PROTO, TRUE);
323 modest_conf_set_string (priv->modest_conf, key,
324 modest_protocol_info_get_protocol_name(proto),
334 modest_account_mgr_remove_account (ModestAccountMgr * self,
336 gboolean server_account,
339 ModestAccountMgrPrivate *priv;
343 g_return_val_if_fail (self, FALSE);
344 g_return_val_if_fail (name, FALSE);
346 if (!modest_account_mgr_account_exists (self, name, server_account, err)) {
347 g_printerr ("modest: account '%s' does not exist\n", name);
351 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
352 key = _modest_account_mgr_get_account_keyname (name, NULL, server_account);
354 retval = modest_conf_remove_key (priv->modest_conf, key, NULL);
362 /* strip the first /n/ character from each element
363 * caller must make sure all elements are strings with
364 * length >= n, and also that data can be freed.
368 strip_prefix_from_elements (GSList * lst, guint n)
371 memmove (lst->data, lst->data + n,
372 strlen(lst->data) - n + 1);
379 modest_account_mgr_search_server_accounts (ModestAccountMgr * self,
380 const gchar * account_name,
381 ModestProtocolType type,
382 ModestProtocol proto)
386 ModestAccountMgrPrivate *priv;
390 g_return_val_if_fail (self, NULL);
392 if (proto != MODEST_PROTOCOL_UNKNOWN) {
393 ModestProtocolType proto_type;
394 proto_type = modest_protocol_info_get_protocol_type (proto);
395 g_return_val_if_fail (proto_type == MODEST_PROTOCOL_TYPE_TRANSPORT ||
396 proto_type == MODEST_PROTOCOL_TYPE_STORE, NULL);
399 key = _modest_account_mgr_get_account_keyname (account_name, NULL, TRUE);
400 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
402 /* get the list of all server accounts */
403 accounts = modest_conf_list_subkeys (priv->modest_conf, key, &err);
406 g_printerr ("modest: failed to get subkeys for '%s'\n", key);
410 /* filter out the ones with the wrong protocol */
411 /* we could optimize for unknown proto / unknown type, but it will only
412 * make the code more complex */
415 gchar *account = _modest_account_mgr_account_from_key ((gchar*)cursor->data, NULL, NULL);
416 gchar *acc_proto = modest_account_mgr_get_string (self, account, MODEST_ACCOUNT_PROTO,
418 ModestProtocol this_proto = modest_protocol_info_get_protocol (acc_proto);
419 ModestProtocolType this_type = modest_protocol_info_get_protocol_type (this_proto);
421 if ((this_type != MODEST_PROTOCOL_TYPE_UNKNOWN && this_type != type) ||
422 (this_proto != MODEST_PROTOCOL_UNKNOWN && this_proto != proto)) {
423 GSList *nxt = cursor->next;
424 accounts = g_slist_delete_link (accounts, cursor);
427 cursor = cursor->next;
433 /* +1 because we must remove the ending '/' as well */
434 strip_prefix_from_elements (accounts, strlen(key)+1);
440 modest_account_mgr_account_names (ModestAccountMgr * self, GError ** err)
443 ModestAccountMgrPrivate *priv;
444 const size_t prefix_len = strlen (MODEST_ACCOUNT_NAMESPACE "/");
446 g_return_val_if_fail (self, NULL);
448 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
450 accounts = modest_conf_list_subkeys (priv->modest_conf,
451 MODEST_ACCOUNT_NAMESPACE, err);
453 strip_prefix_from_elements (accounts, prefix_len);
460 modest_account_mgr_get_string (ModestAccountMgr *self, const gchar *name,
461 const gchar *key, gboolean server_account, GError **err) {
463 ModestAccountMgrPrivate *priv;
468 g_return_val_if_fail (self, NULL);
469 g_return_val_if_fail (name, NULL);
470 g_return_val_if_fail (key, NULL);
472 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
474 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
475 retval = modest_conf_get_string (priv->modest_conf, keyname, err);
483 modest_account_mgr_get_int (ModestAccountMgr *self, const gchar *name,
484 const gchar *key, gboolean server_account, GError **err)
486 ModestAccountMgrPrivate *priv;
491 g_return_val_if_fail (self, -1);
492 g_return_val_if_fail (name, -1);
493 g_return_val_if_fail (key, -1);
495 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
497 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
498 retval = modest_conf_get_int (priv->modest_conf, keyname, err);
507 modest_account_mgr_get_bool (ModestAccountMgr * self, const gchar *account,
508 const gchar * key, gboolean server_account, GError ** err)
510 ModestAccountMgrPrivate *priv;
515 g_return_val_if_fail (self, FALSE);
516 g_return_val_if_fail (account, FALSE);
517 g_return_val_if_fail (key, FALSE);
519 keyname = _modest_account_mgr_get_account_keyname (account, key, server_account);
521 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
522 retval = modest_conf_get_bool (priv->modest_conf, keyname, err);
531 modest_account_mgr_set_string (ModestAccountMgr * self, const gchar * name,
532 const gchar * key, const gchar * val,
533 gboolean server_account, GError ** err)
535 ModestAccountMgrPrivate *priv;
540 g_return_val_if_fail (self, FALSE);
541 g_return_val_if_fail (name, FALSE);
542 g_return_val_if_fail (key, FALSE);
544 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
546 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
548 retval = modest_conf_set_string (priv->modest_conf, keyname, val,
557 modest_account_mgr_set_int (ModestAccountMgr * self, const gchar * name,
558 const gchar * key, int val, gboolean server_account,
561 ModestAccountMgrPrivate *priv;
566 g_return_val_if_fail (self, FALSE);
567 g_return_val_if_fail (name, FALSE);
568 g_return_val_if_fail (key, FALSE);
570 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
572 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
574 retval = modest_conf_set_int (priv->modest_conf, keyname, val, err);
583 modest_account_mgr_set_bool (ModestAccountMgr * self, const gchar * name,
584 const gchar * key, gboolean val, gboolean server_account,
587 ModestAccountMgrPrivate *priv;
592 g_return_val_if_fail (self, FALSE);
593 g_return_val_if_fail (name, FALSE);
594 g_return_val_if_fail (key, FALSE);
596 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
598 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
600 retval = modest_conf_set_bool (priv->modest_conf, keyname, val, err);
607 modest_account_mgr_set_list (ModestAccountMgr *self,
611 ModestConfValueType list_type,
612 gboolean server_account,
615 ModestAccountMgrPrivate *priv;
618 g_return_if_fail (self);
619 g_return_if_fail (name);
620 g_return_if_fail (key);
621 g_return_if_fail (val);
623 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
625 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
626 modest_conf_set_list (priv->modest_conf, keyname, val, list_type, err);
631 modest_account_mgr_account_exists (ModestAccountMgr * self, const gchar * name,
632 gboolean server_account, GError ** err)
634 ModestAccountMgrPrivate *priv;
639 g_return_val_if_fail (self, FALSE);
640 g_return_val_if_fail (name, FALSE);
642 keyname = _modest_account_mgr_get_account_keyname (name, NULL, server_account);
644 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
645 retval = modest_conf_key_exists (priv->modest_conf, keyname, err);
653 modest_account_mgr_get_list (ModestAccountMgr *self,
656 ModestConfValueType list_type,
657 gboolean server_account,
660 ModestAccountMgrPrivate *priv;
665 g_return_val_if_fail (self, NULL);
666 g_return_val_if_fail (name, NULL);
667 g_return_val_if_fail (key, NULL);
669 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
671 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
672 retval = modest_conf_get_list (priv->modest_conf, keyname, list_type, err);
680 modest_account_mgr_unset (ModestAccountMgr *self,
683 gboolean server_account,
686 ModestAccountMgrPrivate *priv;
691 g_return_val_if_fail (self, FALSE);
692 g_return_val_if_fail (name, FALSE);
693 g_return_val_if_fail (key, FALSE);
695 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
697 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
698 retval = modest_conf_remove_key (priv->modest_conf, keyname, err);