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.
30 #include <modest-account-mgr-helpers.h>
31 #include <modest-account-mgr-priv.h>
32 #include <tny-simple-list.h>
33 #include <modest-runtime.h>
37 modest_account_mgr_set_enabled (ModestAccountMgr *self, const gchar* name,
40 return modest_account_mgr_set_bool (self, name, MODEST_ACCOUNT_ENABLED, enabled,FALSE);
45 modest_account_mgr_get_enabled (ModestAccountMgr *self, const gchar* name)
47 return modest_account_mgr_get_bool (self, name, MODEST_ACCOUNT_ENABLED, FALSE);
50 gboolean modest_account_mgr_set_signature (ModestAccountMgr *self, const gchar* name,
51 const gchar* signature, gboolean use_signature)
53 gboolean result = modest_account_mgr_set_bool (self, name, MODEST_ACCOUNT_USE_SIGNATURE,
54 use_signature, FALSE);
55 result = result && modest_account_mgr_set_string (self, name, MODEST_ACCOUNT_SIGNATURE,
60 gchar* modest_account_mgr_get_display_name (ModestAccountMgr *self,
63 return modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_DISPLAY_NAME, FALSE);
68 gchar* modest_account_mgr_get_signature (ModestAccountMgr *self, const gchar* name,
69 gboolean* use_signature)
73 modest_account_mgr_get_bool (self, name, MODEST_ACCOUNT_USE_SIGNATURE, FALSE);
76 return modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_SIGNATURE, FALSE);
80 ModestTransportStoreProtocol modest_account_mgr_get_store_protocol (ModestAccountMgr *self, const gchar* name)
82 ModestTransportStoreProtocol result = MODEST_PROTOCOL_STORE_POP; /* Arbitrary default */
84 gchar *server_account_name = modest_account_mgr_get_string (self, name,
85 MODEST_ACCOUNT_STORE_ACCOUNT,
87 if (server_account_name) {
88 ModestServerAccountData* server_data =
89 modest_account_mgr_get_server_account_data (self, server_account_name);
90 result = server_data->proto;
92 modest_account_mgr_free_server_account_data (self, server_data);
94 g_free (server_account_name);
100 gboolean modest_account_mgr_set_connection_specific_smtp (ModestAccountMgr *self,
101 const gchar* account_name,
102 const gchar* connection_name, const gchar* server_account_name)
104 modest_account_mgr_remove_connection_specific_smtp (self, account_name, connection_name);
106 GSList *list = modest_account_mgr_get_list (self, account_name,
107 MODEST_ACCOUNT_CONNECTION_SPECIFIC_SMTP_LIST,
108 MODEST_CONF_VALUE_STRING, FALSE);
110 /* The server account is in the item after the connection name: */
111 GSList *list_connection = g_slist_append (list, (gpointer)connection_name);
112 list_connection = g_slist_append (list_connection, (gpointer)server_account_name);
114 /* Reset the changed list: */
115 modest_account_mgr_set_list (self, account_name,
116 MODEST_ACCOUNT_CONNECTION_SPECIFIC_SMTP_LIST, list_connection,
117 MODEST_CONF_VALUE_STRING, FALSE);
119 /* TODO: Should we free the items too, or just the list? */
126 * modest_account_mgr_remove_connection_specific_smtp
127 * @self: a ModestAccountMgr instance
128 * @name: the account name
129 * @connection_name: A libconic IAP connection name
131 * Disassacoiate a server account to use with the specific connection for this account.
133 * Returns: TRUE if it worked, FALSE otherwise
135 gboolean modest_account_mgr_remove_connection_specific_smtp (ModestAccountMgr *self,
136 const gchar* account_name, const gchar* connection_name)
138 GSList *list = modest_account_mgr_get_list (self, account_name,
139 MODEST_ACCOUNT_CONNECTION_SPECIFIC_SMTP_LIST,
140 MODEST_CONF_VALUE_STRING, FALSE);
144 /* The server account is in the item after the connection name: */
145 GSList *list_connection = g_slist_find_custom (list, connection_name, (GCompareFunc)strcmp);
146 if (list_connection) {
147 /* remove both items: */
148 GSList *temp = g_slist_delete_link(list_connection, list_connection);
149 temp = g_slist_delete_link(temp, g_slist_next(temp));
152 /* Reset the changed list: */
153 modest_account_mgr_set_list (self, account_name,
154 MODEST_ACCOUNT_CONNECTION_SPECIFIC_SMTP_LIST, list,
155 MODEST_CONF_VALUE_STRING, FALSE);
157 /* TODO: Should we free the items too, or just the list? */
163 gboolean modest_account_mgr_get_use_connection_specific_smtp (ModestAccountMgr *self, const gchar* account_name)
165 return modest_account_mgr_get_bool (self, account_name,
166 MODEST_ACCOUNT_USE_CONNECTION_SPECIFIC_SMTP, FALSE);
169 gboolean modest_account_mgr_set_use_connection_specific_smtp (ModestAccountMgr *self, const gchar* account_name,
172 return modest_account_mgr_set_bool (self, account_name, MODEST_ACCOUNT_USE_CONNECTION_SPECIFIC_SMTP,
177 * modest_account_mgr_get_connection_specific_smtp
178 * @self: a ModestAccountMgr instance
179 * @name: the account name
180 * @connection_name: A libconic IAP connection name
182 * Retrieve a server account to use with this specific connection for this account.
184 * Returns: a server account name to use for this connection, or NULL if none is specified.
186 gchar* modest_account_mgr_get_connection_specific_smtp (ModestAccountMgr *self, const gchar* account_name,
187 const gchar* connection_name)
189 gchar *result = NULL;
191 GSList *list = modest_account_mgr_get_list (self, account_name,
192 MODEST_ACCOUNT_CONNECTION_SPECIFIC_SMTP_LIST,
193 MODEST_CONF_VALUE_STRING, FALSE);
197 /* The server account is in the item after the connection name: */
200 const gchar* this_connection_name = (const gchar*)(iter->data);
201 if (strcmp (this_connection_name, connection_name) == 0) {
202 iter = g_slist_next (iter);
205 const gchar* account_name = (const gchar*)(iter->data);
207 result = g_strdup (account_name);
213 /* Skip 2 to go to the next connection in the list: */
214 iter = g_slist_next (iter);
216 iter = g_slist_next (iter);
221 printf (" debug: no server found for connection_name=%s.\n", connection_name);
225 /* TODO: Should we free the items too, or just the list? */
232 modest_server_account_get_username (ModestAccountMgr *self, const gchar* account_name)
234 return modest_account_mgr_get_string (self, account_name, MODEST_ACCOUNT_USERNAME,
235 TRUE /* server account */);
239 modest_server_account_set_username (ModestAccountMgr *self, const gchar* account_name,
240 const gchar* username)
242 /* Note that this won't work properly as long as the gconf cache is broken
244 gchar *existing_username = modest_server_account_get_username(self,
247 modest_account_mgr_set_string (self, account_name, MODEST_ACCOUNT_USERNAME,
248 username, TRUE /* server account */);
250 /* We don't know anything about new usernames: */
251 if (strcmp (existing_username, username) != 0)
252 modest_server_account_set_username_has_succeeded (self,
253 account_name, FALSE);
255 g_free (existing_username);
259 modest_server_account_get_username_has_succeeded (ModestAccountMgr *self, const gchar* account_name)
261 return modest_account_mgr_get_bool (self, account_name, MODEST_ACCOUNT_USERNAME_HAS_SUCCEEDED,
262 TRUE /* server account */);
266 modest_server_account_set_username_has_succeeded (ModestAccountMgr *self, const gchar* account_name,
269 modest_account_mgr_set_bool (self, account_name, MODEST_ACCOUNT_USERNAME_HAS_SUCCEEDED,
270 succeeded, TRUE /* server account */);
274 modest_server_account_set_password (ModestAccountMgr *self, const gchar* account_name,
275 const gchar* password)
277 modest_account_mgr_set_string (self, account_name, MODEST_ACCOUNT_PASSWORD,
278 password, TRUE /* server account */);
283 modest_server_account_get_password (ModestAccountMgr *self, const gchar* account_name)
285 return modest_account_mgr_get_string (self, account_name, MODEST_ACCOUNT_PASSWORD,
286 TRUE /* server account */);
290 modest_server_account_get_has_password (ModestAccountMgr *self, const gchar* account_name)
292 gboolean result = FALSE;
293 gchar *password = modest_account_mgr_get_string (self, account_name, MODEST_ACCOUNT_PASSWORD,
294 TRUE /* server account */);
295 if (password && strlen (password)) {
305 modest_server_account_get_hostname (ModestAccountMgr *self, const gchar* account_name)
307 return modest_account_mgr_get_string (self, account_name, MODEST_ACCOUNT_HOSTNAME,
308 TRUE /* server account */);
312 static ModestAuthProtocol
313 get_secure_auth_for_conf_string(const gchar* value)
315 ModestAuthProtocol result = MODEST_PROTOCOL_AUTH_NONE;
317 if (strcmp(value, MODEST_ACCOUNT_AUTH_MECH_VALUE_NONE) == 0)
318 result = MODEST_PROTOCOL_AUTH_NONE;
319 else if (strcmp(value, MODEST_ACCOUNT_AUTH_MECH_VALUE_PASSWORD) == 0)
320 result = MODEST_PROTOCOL_AUTH_PASSWORD;
321 else if (strcmp(value, MODEST_ACCOUNT_AUTH_MECH_VALUE_CRAMMD5) == 0)
322 result = MODEST_PROTOCOL_AUTH_CRAMMD5;
329 modest_server_account_get_secure_auth (ModestAccountMgr *self,
330 const gchar* account_name)
332 ModestAuthProtocol result = MODEST_PROTOCOL_AUTH_NONE;
333 gchar* value = modest_account_mgr_get_string (self, account_name, MODEST_ACCOUNT_AUTH_MECH,
334 TRUE /* server account */);
336 result = get_secure_auth_for_conf_string (value);
346 modest_server_account_set_secure_auth (ModestAccountMgr *self,
347 const gchar* account_name, ModestAuthProtocol secure_auth)
349 /* Get the conf string for the enum value: */
350 const gchar* str_value = NULL;
351 if (secure_auth == MODEST_PROTOCOL_AUTH_NONE)
352 str_value = MODEST_ACCOUNT_AUTH_MECH_VALUE_NONE;
353 else if (secure_auth == MODEST_PROTOCOL_AUTH_PASSWORD)
354 str_value = MODEST_ACCOUNT_AUTH_MECH_VALUE_PASSWORD;
355 else if (secure_auth == MODEST_PROTOCOL_AUTH_CRAMMD5)
356 str_value = MODEST_ACCOUNT_AUTH_MECH_VALUE_CRAMMD5;
358 /* Set it in the configuration: */
359 modest_account_mgr_set_string (self, account_name, MODEST_ACCOUNT_AUTH_MECH, str_value, TRUE);
362 static ModestConnectionProtocol
363 get_security_for_conf_string(const gchar* value)
365 ModestConnectionProtocol result = MODEST_PROTOCOL_CONNECTION_NORMAL;
367 if (strcmp(value, MODEST_ACCOUNT_SECURITY_VALUE_NONE) == 0)
368 result = MODEST_PROTOCOL_CONNECTION_NORMAL;
369 else if (strcmp(value, MODEST_ACCOUNT_SECURITY_VALUE_NORMAL) == 0) {
370 /* The UI has "Normal (TLS)": */
371 result = MODEST_PROTOCOL_CONNECTION_TLS;
372 } else if (strcmp(value, MODEST_ACCOUNT_SECURITY_VALUE_SSL) == 0)
373 result = MODEST_PROTOCOL_CONNECTION_SSL;
379 ModestConnectionProtocol
380 modest_server_account_get_security (ModestAccountMgr *self,
381 const gchar* account_name)
383 ModestConnectionProtocol result = MODEST_PROTOCOL_CONNECTION_NORMAL;
384 gchar* value = modest_account_mgr_get_string (self, account_name, MODEST_ACCOUNT_SECURITY,
385 TRUE /* server account */);
387 result = get_security_for_conf_string (value);
396 modest_server_account_set_security (ModestAccountMgr *self,
397 const gchar* account_name, ModestConnectionProtocol security)
399 /* Get the conf string for the enum value: */
400 const gchar* str_value = NULL;
401 if (security == MODEST_PROTOCOL_CONNECTION_NORMAL)
402 str_value = MODEST_ACCOUNT_SECURITY_VALUE_NONE;
403 else if (security == MODEST_PROTOCOL_CONNECTION_TLS) {
404 /* The UI has "Normal (TLS)": */
405 str_value = MODEST_ACCOUNT_SECURITY_VALUE_NORMAL;
406 } else if (security == MODEST_PROTOCOL_CONNECTION_SSL)
407 str_value = MODEST_ACCOUNT_SECURITY_VALUE_SSL;
409 /* Set it in the configuration: */
410 modest_account_mgr_set_string (self, account_name, MODEST_ACCOUNT_SECURITY, str_value, TRUE);
413 ModestServerAccountData*
414 modest_account_mgr_get_server_account_data (ModestAccountMgr *self, const gchar* name)
416 ModestServerAccountData *data;
419 g_return_val_if_fail (modest_account_mgr_account_exists (self, name, TRUE), NULL);
420 data = g_slice_new0 (ModestServerAccountData);
422 data->account_name = g_strdup (name);
423 data->hostname = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_HOSTNAME,TRUE);
424 data->username = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_USERNAME,TRUE);
425 proto = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_PROTO, TRUE);
426 data->proto = modest_protocol_info_get_transport_store_protocol (proto);
429 data->port = modest_account_mgr_get_int (self, name, MODEST_ACCOUNT_PORT, TRUE);
431 gchar *secure_auth_str = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_AUTH_MECH, TRUE);
432 data->secure_auth = get_secure_auth_for_conf_string(secure_auth_str);
433 g_free (secure_auth_str);
435 gchar *security_str = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_SECURITY, TRUE);
436 data->security = get_security_for_conf_string(security_str);
437 g_free (security_str);
439 data->last_updated = modest_account_mgr_get_int (self, name, MODEST_ACCOUNT_LAST_UPDATED,TRUE);
441 data->password = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_PASSWORD, TRUE);
448 modest_account_mgr_free_server_account_data (ModestAccountMgr *self,
449 ModestServerAccountData* data)
451 g_return_if_fail (self);
454 return; /* not an error */
456 g_free (data->account_name);
457 data->account_name = NULL;
459 g_free (data->hostname);
460 data->hostname = NULL;
462 g_free (data->username);
463 data->username = NULL;
465 g_free (data->password);
466 data->password = NULL;
468 g_slice_free (ModestServerAccountData, data);
471 /** You must use modest_account_mgr_free_account_data() on the result.
474 modest_account_mgr_get_account_data (ModestAccountMgr *self, const gchar* name)
476 ModestAccountData *data;
477 gchar *server_account;
478 gchar *default_account;
480 g_return_val_if_fail (self, NULL);
481 g_return_val_if_fail (name, NULL);
483 if (!modest_account_mgr_account_exists (self, name, FALSE)) {
484 /* For instance, maybe you are mistakenly checking for a server account name? */
485 g_warning ("%s: Account %s does not exist.", __FUNCTION__, name);
489 data = g_slice_new0 (ModestAccountData);
491 data->account_name = g_strdup (name);
493 data->display_name = modest_account_mgr_get_string (self, name,
494 MODEST_ACCOUNT_DISPLAY_NAME,
496 data->fullname = modest_account_mgr_get_string (self, name,
497 MODEST_ACCOUNT_FULLNAME,
499 data->email = modest_account_mgr_get_string (self, name,
500 MODEST_ACCOUNT_EMAIL,
502 data->is_enabled = modest_account_mgr_get_enabled (self, name);
504 default_account = modest_account_mgr_get_default_account (self);
505 data->is_default = (default_account && strcmp (default_account, name) == 0);
506 g_free (default_account);
509 server_account = modest_account_mgr_get_string (self, name,
510 MODEST_ACCOUNT_STORE_ACCOUNT,
512 if (server_account) {
513 data->store_account =
514 modest_account_mgr_get_server_account_data (self, server_account);
515 g_free (server_account);
519 server_account = modest_account_mgr_get_string (self, name,
520 MODEST_ACCOUNT_TRANSPORT_ACCOUNT,
522 if (server_account) {
523 data->transport_account =
524 modest_account_mgr_get_server_account_data (self, server_account);
525 g_free (server_account);
533 modest_account_mgr_free_account_data (ModestAccountMgr *self, ModestAccountData *data)
535 g_return_if_fail (self);
537 if (!data) /* not an error */
540 g_free (data->account_name);
541 g_free (data->display_name);
542 g_free (data->fullname);
543 g_free (data->email);
545 modest_account_mgr_free_server_account_data (self, data->store_account);
546 modest_account_mgr_free_server_account_data (self, data->transport_account);
548 g_slice_free (ModestAccountData, data);
553 modest_account_mgr_get_default_account (ModestAccountMgr *self)
559 g_return_val_if_fail (self, NULL);
561 conf = MODEST_ACCOUNT_MGR_GET_PRIVATE (self)->modest_conf;
562 account = modest_conf_get_string (conf, MODEST_CONF_DEFAULT_ACCOUNT, &err);
565 g_printerr ("modest: failed to get '%s': %s\n",
566 MODEST_CONF_DEFAULT_ACCOUNT, err->message);
573 if (account && !modest_account_mgr_account_exists (self, account, FALSE)) {
574 g_printerr ("modest: default account does not exist\n");
584 modest_account_mgr_set_default_account (ModestAccountMgr *self, const gchar* account)
588 g_return_val_if_fail (self, FALSE);
589 g_return_val_if_fail (account, FALSE);
590 g_return_val_if_fail (modest_account_mgr_account_exists (self, account, FALSE),
593 conf = MODEST_ACCOUNT_MGR_GET_PRIVATE (self)->modest_conf;
595 return modest_conf_set_string (conf, MODEST_CONF_DEFAULT_ACCOUNT, account, NULL);
599 modest_account_mgr_unset_default_account (ModestAccountMgr *self)
603 g_return_val_if_fail (self, FALSE);
605 conf = MODEST_ACCOUNT_MGR_GET_PRIVATE (self)->modest_conf;
607 return modest_conf_remove_key (conf, MODEST_CONF_DEFAULT_ACCOUNT, NULL /* err */);
611 gint on_accounts_list_sort_by_title(gconstpointer a, gconstpointer b)
613 return g_utf8_collate((const gchar*)a, (const gchar*)b);
616 /** Get the first one, alphabetically, by title. */
618 modest_account_mgr_get_first_account_name (ModestAccountMgr *self)
620 const gchar* account_name = NULL;
621 GSList *account_names = modest_account_mgr_account_names (self, TRUE /* only enabled */);
623 /* Return TRUE if there is no account */
627 /* Get the first one, alphabetically, by title: */
628 /* gchar *old_default = modest_account_mgr_get_default_account (self); */
629 GSList* list_sorted = g_slist_sort (account_names, on_accounts_list_sort_by_title);
631 GSList* iter = list_sorted;
632 gboolean found = FALSE;
633 while (iter && !found) {
634 account_name = (const gchar*)list_sorted->data;
640 iter = g_slist_next (iter);
643 gchar* result = NULL;
645 result = g_strdup (account_name);
647 modest_account_mgr_free_account_names (account_names);
648 account_names = NULL;
654 modest_account_mgr_set_first_account_as_default (ModestAccountMgr *self)
656 gboolean result = FALSE;
658 gchar* account_name = modest_account_mgr_get_first_account_name(self);
660 result = modest_account_mgr_set_default_account (self, account_name);
661 g_free (account_name);
664 result = TRUE; /* If there are no accounts then it's not a failure. */
670 modest_account_mgr_get_from_string (ModestAccountMgr *self, const gchar* name)
672 gchar *fullname, *email, *from;
674 g_return_val_if_fail (self, NULL);
675 g_return_val_if_fail (name, NULL);
677 fullname = modest_account_mgr_get_string (self, name,MODEST_ACCOUNT_FULLNAME,
679 email = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_EMAIL,
681 from = g_strdup_printf ("%s <%s>",
682 fullname ? fullname : "",
690 /* Add a number to the end of the text, or increment a number that is already there.
693 util_increment_name (const gchar* text)
695 /* Get the end character,
696 * also doing a UTF-8 validation which is required for using g_utf8_prev_char().
698 const gchar* end = NULL;
699 if (!g_utf8_validate (text, -1, &end))
705 --end; /* Go to before the null-termination. */
707 /* Look at each UTF-8 characer, starting at the end: */
708 const gchar* p = end;
709 const gchar* alpha_end = NULL;
712 /* Stop when we reach the first character that is not a numeric digit: */
713 const gunichar ch = g_utf8_get_char (p);
714 if (!g_unichar_isdigit (ch)) {
719 p = g_utf8_prev_char (p);
723 /* The text must consist completely of numeric digits. */
729 /* Intepret and increment the number, if any: */
730 gint num = atol (alpha_end);
733 /* Get the name part: */
734 gint name_len = alpha_end - text;
735 gchar *name_without_number = g_malloc(name_len + 1);
736 memcpy (name_without_number, text, name_len);
737 name_without_number[name_len] = 0;\
739 /* Concatenate the text part and the new number: */
740 gchar *result = g_strdup_printf("%s%d", name_without_number, num);
741 g_free (name_without_number);
747 modest_account_mgr_get_unused_account_name (ModestAccountMgr *self, const gchar* starting_name,
748 gboolean server_account)
750 gchar *account_name = g_strdup (starting_name);
752 while (modest_account_mgr_account_exists (self,
753 account_name, server_account /* server_account */)) {
755 gchar * account_name2 = util_increment_name (account_name);
756 g_free (account_name);
757 account_name = account_name2;
764 modest_account_mgr_get_unused_account_display_name (ModestAccountMgr *self, const gchar* starting_name)
766 gchar *account_name = g_strdup (starting_name);
768 while (modest_account_mgr_account_with_display_name_exists (self, account_name)) {
770 gchar * account_name2 = util_increment_name (account_name);
771 g_free (account_name);
772 account_name = account_name2;