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 account = _modest_account_mgr_account_from_key (key, &is_account_key, &is_server_account);
68 /* if this is not an account-related key change, ignore */
72 /* account was removed -- emit this, even if the account was disabled */
73 if (is_account_key && event == MODEST_CONF_EVENT_KEY_UNSET) {
74 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_REMOVED_SIGNAL], 0,
75 account, is_server_account);
80 /* is this account enabled? */
81 if (is_server_account)
84 enabled = modest_account_mgr_account_get_enabled (self, account);
86 /* account was changed.
87 * and always notify when enabled/disabled changes
89 if (enabled || g_str_has_suffix (key, MODEST_ACCOUNT_ENABLED))
90 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_CHANGED_SIGNAL], 0,
91 account, key, is_server_account);
98 modest_account_mgr_get_type (void)
100 static GType my_type = 0;
103 static const GTypeInfo my_info = {
104 sizeof (ModestAccountMgrClass),
105 NULL, /* base init */
106 NULL, /* base finalize */
107 (GClassInitFunc) modest_account_mgr_class_init,
108 NULL, /* class finalize */
109 NULL, /* class data */
110 sizeof (ModestAccountMgr),
112 (GInstanceInitFunc) modest_account_mgr_init,
116 my_type = g_type_register_static (G_TYPE_OBJECT,
124 modest_account_mgr_class_init (ModestAccountMgrClass * klass)
126 GObjectClass *gobject_class;
127 gobject_class = (GObjectClass *) klass;
129 parent_class = g_type_class_peek_parent (klass);
130 gobject_class->finalize = modest_account_mgr_finalize;
132 g_type_class_add_private (gobject_class,
133 sizeof (ModestAccountMgrPrivate));
135 /* signal definitions */
136 signals[ACCOUNT_REMOVED_SIGNAL] =
137 g_signal_new ("account_removed",
138 G_TYPE_FROM_CLASS (klass),
140 G_STRUCT_OFFSET(ModestAccountMgrClass,account_removed),
142 modest_marshal_VOID__STRING_BOOLEAN,
143 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_BOOLEAN);
144 signals[ACCOUNT_CHANGED_SIGNAL] =
145 g_signal_new ("account_changed",
146 G_TYPE_FROM_CLASS (klass),
148 G_STRUCT_OFFSET(ModestAccountMgrClass,account_changed),
150 modest_marshal_VOID__STRING_STRING_BOOLEAN,
151 G_TYPE_NONE, 3, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_BOOLEAN);
156 modest_account_mgr_init (ModestAccountMgr * obj)
158 ModestAccountMgrPrivate *priv =
159 MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
161 priv->modest_conf = NULL;
165 modest_account_mgr_finalize (GObject * obj)
167 ModestAccountMgrPrivate *priv =
168 MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
170 if (priv->modest_conf) {
171 g_object_unref (G_OBJECT(priv->modest_conf));
172 priv->modest_conf = NULL;
175 G_OBJECT_CLASS(parent_class)->finalize (obj);
179 modest_account_mgr_new (ModestConf * conf)
182 ModestAccountMgrPrivate *priv;
184 g_return_val_if_fail (conf, NULL);
186 obj = G_OBJECT (g_object_new (MODEST_TYPE_ACCOUNT_MGR, NULL));
187 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
189 g_object_ref (G_OBJECT(conf));
190 priv->modest_conf = conf;
192 g_signal_connect (G_OBJECT (conf), "key_changed",
193 G_CALLBACK (on_key_change),
196 return MODEST_ACCOUNT_MGR (obj);
201 null_means_empty (const gchar * str)
203 return str ? str : "";
208 modest_account_mgr_add_account (ModestAccountMgr *self,
210 const gchar *store_account,
211 const gchar *transport_account,
214 ModestAccountMgrPrivate *priv;
218 g_return_val_if_fail (self, FALSE);
219 g_return_val_if_fail (name, FALSE);
220 g_return_val_if_fail (strchr(name, '/') == NULL, FALSE);
222 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
225 * we create the account by adding an account 'dir', with the name <name>,
226 * and in that the 'display_name' string key
228 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_DISPLAY_NAME, FALSE);
229 if (modest_account_mgr_account_exists (self, key, FALSE, err)) {
230 g_printerr ("modest: account already exists\n");
235 ok = modest_conf_set_string (priv->modest_conf, key, name, err);
238 g_printerr ("modest: cannot set display name\n");
243 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_STORE_ACCOUNT, FALSE);
244 ok = modest_conf_set_string (priv->modest_conf, key, store_account, err);
247 g_printerr ("modest: failed to set store account '%s'\n",
253 if (transport_account) {
254 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_TRANSPORT_ACCOUNT, FALSE);
255 ok = modest_conf_set_string (priv->modest_conf, key, transport_account, err);
258 g_printerr ("modest: failed to set transport account '%s'\n",
264 modest_account_mgr_account_set_enabled (self, name, TRUE);
273 modest_account_mgr_add_server_account (ModestAccountMgr * self,
274 const gchar * name, const gchar *hostname,
275 const gchar * username, const gchar * password,
276 ModestProtocol proto)
278 ModestAccountMgrPrivate *priv;
280 ModestProtocolType proto_type;
282 g_return_val_if_fail (self, FALSE);
283 g_return_val_if_fail (name, FALSE);
284 g_return_val_if_fail (strchr(name, '/') == NULL, FALSE);
286 proto_type = modest_protocol_info_get_protocol_type (proto);
287 g_return_val_if_fail (proto_type == MODEST_PROTOCOL_TYPE_TRANSPORT ||
288 proto_type == MODEST_PROTOCOL_TYPE_STORE, FALSE);
290 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
293 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_HOSTNAME, TRUE);
294 if (modest_conf_key_exists (priv->modest_conf, key, NULL)) {
295 g_printerr ("modest: server account '%s' already exists", name);
300 modest_conf_set_string (priv->modest_conf, key, null_means_empty(hostname), NULL);
304 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_USERNAME, TRUE);
305 modest_conf_set_string (priv->modest_conf, key, null_means_empty (username), NULL);
309 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_PASSWORD, TRUE);
310 modest_conf_set_string (priv->modest_conf, key, null_means_empty (password), NULL);
314 key = _modest_account_mgr_get_account_keyname (name, MODEST_ACCOUNT_PROTO, TRUE);
315 modest_conf_set_string (priv->modest_conf, key,
316 modest_protocol_info_get_protocol_name(proto),
326 modest_account_mgr_remove_account (ModestAccountMgr * self,
328 gboolean server_account,
331 ModestAccountMgrPrivate *priv;
335 g_return_val_if_fail (self, FALSE);
336 g_return_val_if_fail (name, FALSE);
338 if (!modest_account_mgr_account_exists (self, name, server_account, err)) {
339 g_printerr ("modest: account '%s' does not exist\n", name);
343 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
344 key = _modest_account_mgr_get_account_keyname (name, NULL, server_account);
346 retval = modest_conf_remove_key (priv->modest_conf, key, NULL);
354 /* strip the first /n/ character from each element
355 * caller must make sure all elements are strings with
356 * length >= n, and also that data can be freed.
360 strip_prefix_from_elements (GSList * lst, guint n)
363 memmove (lst->data, lst->data + n,
364 strlen(lst->data) - n + 1);
371 modest_account_mgr_search_server_accounts (ModestAccountMgr * self,
372 const gchar * account_name,
373 ModestProtocolType type,
374 ModestProtocol proto)
378 ModestAccountMgrPrivate *priv;
382 g_return_val_if_fail (self, NULL);
384 if (proto != MODEST_PROTOCOL_UNKNOWN) {
385 ModestProtocolType proto_type;
386 proto_type = modest_protocol_info_get_protocol_type (proto);
387 g_return_val_if_fail (proto_type == MODEST_PROTOCOL_TYPE_TRANSPORT ||
388 proto_type == MODEST_PROTOCOL_TYPE_STORE, NULL);
391 key = _modest_account_mgr_get_account_keyname (account_name, NULL, TRUE);
392 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
394 /* get the list of all server accounts */
395 accounts = modest_conf_list_subkeys (priv->modest_conf, key, &err);
398 g_printerr ("modest: failed to get subkeys for '%s'\n", key);
402 /* filter out the ones with the wrong protocol */
403 /* we could optimize for unknown proto / unknown type, but it will only
404 * make the code more complex */
407 gchar *account = _modest_account_mgr_account_from_key ((gchar*)cursor->data, NULL, NULL);
408 gchar *acc_proto = modest_account_mgr_get_string (self, account, MODEST_ACCOUNT_PROTO,
410 ModestProtocol this_proto = modest_protocol_info_get_protocol (acc_proto);
411 ModestProtocolType this_type = modest_protocol_info_get_protocol_type (this_proto);
413 if ((this_type != MODEST_PROTOCOL_TYPE_UNKNOWN && this_type != type) ||
414 (this_proto != MODEST_PROTOCOL_UNKNOWN && this_proto != proto)) {
415 GSList *nxt = cursor->next;
416 accounts = g_slist_delete_link (accounts, cursor);
419 cursor = cursor->next;
425 /* +1 because we must remove the ending '/' as well */
426 strip_prefix_from_elements (accounts, strlen(key)+1);
432 modest_account_mgr_account_names (ModestAccountMgr * self, GError ** err)
435 ModestAccountMgrPrivate *priv;
436 const size_t prefix_len = strlen (MODEST_ACCOUNT_NAMESPACE "/");
438 g_return_val_if_fail (self, NULL);
440 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
442 accounts = modest_conf_list_subkeys (priv->modest_conf,
443 MODEST_ACCOUNT_NAMESPACE, err);
445 strip_prefix_from_elements (accounts, prefix_len);
451 modest_account_mgr_get_string (ModestAccountMgr *self, const gchar *name,
452 const gchar *key, gboolean server_account, GError **err) {
454 ModestAccountMgrPrivate *priv;
459 g_return_val_if_fail (self, NULL);
460 g_return_val_if_fail (name, NULL);
461 g_return_val_if_fail (key, NULL);
463 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
465 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
466 retval = modest_conf_get_string (priv->modest_conf, keyname, err);
474 modest_account_mgr_get_int (ModestAccountMgr *self, const gchar *name,
475 const gchar *key, gboolean server_account, GError **err)
477 ModestAccountMgrPrivate *priv;
482 g_return_val_if_fail (self, -1);
483 g_return_val_if_fail (name, -1);
484 g_return_val_if_fail (key, -1);
486 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
488 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
489 retval = modest_conf_get_int (priv->modest_conf, keyname, err);
498 modest_account_mgr_get_bool (ModestAccountMgr * self, const gchar *account,
499 const gchar * key, gboolean server_account, GError ** err)
501 ModestAccountMgrPrivate *priv;
506 g_return_val_if_fail (self, FALSE);
507 g_return_val_if_fail (account, FALSE);
508 g_return_val_if_fail (key, FALSE);
510 keyname = _modest_account_mgr_get_account_keyname (account, key, server_account);
512 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
513 retval = modest_conf_get_bool (priv->modest_conf, keyname, err);
522 modest_account_mgr_set_string (ModestAccountMgr * self, const gchar * name,
523 const gchar * key, const gchar * val,
524 gboolean server_account, GError ** err)
526 ModestAccountMgrPrivate *priv;
531 g_return_val_if_fail (self, FALSE);
532 g_return_val_if_fail (name, FALSE);
533 g_return_val_if_fail (key, FALSE);
535 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
537 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
539 retval = modest_conf_set_string (priv->modest_conf, keyname, val,
548 modest_account_mgr_set_int (ModestAccountMgr * self, const gchar * name,
549 const gchar * key, int val, gboolean server_account,
552 ModestAccountMgrPrivate *priv;
557 g_return_val_if_fail (self, FALSE);
558 g_return_val_if_fail (name, FALSE);
559 g_return_val_if_fail (key, FALSE);
561 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
563 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
565 retval = modest_conf_set_int (priv->modest_conf, keyname, val, err);
574 modest_account_mgr_set_bool (ModestAccountMgr * self, const gchar * name,
575 const gchar * key, gboolean val, gboolean server_account,
578 ModestAccountMgrPrivate *priv;
583 g_return_val_if_fail (self, FALSE);
584 g_return_val_if_fail (name, FALSE);
585 g_return_val_if_fail (key, FALSE);
587 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
589 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
591 retval = modest_conf_set_bool (priv->modest_conf, keyname, val, err);
598 modest_account_mgr_set_list (ModestAccountMgr *self,
602 ModestConfValueType list_type,
603 gboolean server_account,
606 ModestAccountMgrPrivate *priv;
609 g_return_if_fail (self);
610 g_return_if_fail (name);
611 g_return_if_fail (key);
612 g_return_if_fail (val);
614 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
616 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
617 modest_conf_set_list (priv->modest_conf, keyname, val, list_type, err);
622 modest_account_mgr_account_exists (ModestAccountMgr * self, const gchar * name,
623 gboolean server_account, GError ** err)
625 ModestAccountMgrPrivate *priv;
630 g_return_val_if_fail (self, FALSE);
631 g_return_val_if_fail (name, FALSE);
633 keyname = _modest_account_mgr_get_account_keyname (name, NULL, server_account);
635 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
636 retval = modest_conf_key_exists (priv->modest_conf, keyname, err);
644 modest_account_mgr_get_list (ModestAccountMgr *self,
647 ModestConfValueType list_type,
648 gboolean server_account,
651 ModestAccountMgrPrivate *priv;
656 g_return_val_if_fail (self, NULL);
657 g_return_val_if_fail (name, NULL);
658 g_return_val_if_fail (key, NULL);
660 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
662 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
663 retval = modest_conf_get_list (priv->modest_conf, keyname, list_type, err);
671 modest_account_mgr_unset (ModestAccountMgr *self,
674 gboolean server_account,
677 ModestAccountMgrPrivate *priv;
682 g_return_val_if_fail (self, FALSE);
683 g_return_val_if_fail (name, FALSE);
684 g_return_val_if_fail (key, FALSE);
686 keyname = _modest_account_mgr_get_account_keyname (name, key, server_account);
688 priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
689 retval = modest_conf_remove_key (priv->modest_conf, keyname, err);