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);
81 #if 0 /* Not needed, but works. */
83 compare_option_strings_for_name (const gchar* a, const gchar* b)
85 /* printf(" debug: compare_option_strings_for_name():a=%s, b=%s\n", a, b); */
86 const gchar* sep = strchr(a, '=');
94 /* Get the part of the string before the =.
95 * Note that this allocation is inefficient just so we can do a strcmp. */
96 gchar* name = g_malloc (len+1);
98 name[len] = 0; /* Null-termination. */
100 /* printf(" debug: name=%s\n", name); */
102 gint result = strcmp (name, b);
110 modest_server_account_data_get_option_string (GSList* options_list, const gchar* option_name)
115 gchar *result = NULL;
116 GSList* option = g_slist_find_custom(options_list, option_name, (GCompareFunc)compare_option_strings_for_name);
118 /* Get the value part of the key=value pair: */
119 const gchar* pair = (const gchar*)option->data;
121 const gchar* sep = strchr(pair, '=');
123 gint len = sep - pair;
125 result = g_strdup(sep+1);
127 /* Avoid returning an empty string instead of NULL. */
128 if(result && strlen(result) == 0) {
140 modest_server_account_data_get_option_bool (GSList* options_list, const gchar* option_name)
145 gboolean result = FALSE;
146 GSList* option = g_slist_find_custom(options_list, option_name, (GCompareFunc)strcmp);
156 gboolean modest_account_mgr_set_connection_specific_smtp (ModestAccountMgr *self,
157 const gchar* account_name,
158 const gchar* connection_name, const gchar* server_account_name)
160 modest_account_mgr_remove_connection_specific_smtp (self, account_name, connection_name);
162 GSList *list = modest_account_mgr_get_list (self, account_name,
163 MODEST_ACCOUNT_CONNECTION_SPECIFIC_SMTP_LIST,
164 MODEST_CONF_VALUE_STRING, TRUE);
166 /* The server account is in the item after the connection name: */
167 GSList *list_connection = g_slist_append (list, (gpointer)connection_name);
168 list_connection = g_slist_append (list_connection, (gpointer)server_account_name);
170 /* Reset the changed list: */
171 modest_account_mgr_set_list (self, account_name,
172 MODEST_ACCOUNT_CONNECTION_SPECIFIC_SMTP_LIST, list,
173 MODEST_CONF_VALUE_STRING, TRUE);
175 /* TODO: Should we free the items too, or just the list? */
182 * modest_account_mgr_remove_connection_specific_smtp
183 * @self: a ModestAccountMgr instance
184 * @name: the account name
185 * @connection_name: A libconic IAP connection name
187 * Disassacoiate a server account to use with the specific connection for this account.
189 * Returns: TRUE if it worked, FALSE otherwise
191 gboolean modest_account_mgr_remove_connection_specific_smtp (ModestAccountMgr *self,
192 const gchar* account_name, const gchar* connection_name)
194 GSList *list = modest_account_mgr_get_list (self, account_name,
195 MODEST_ACCOUNT_CONNECTION_SPECIFIC_SMTP_LIST,
196 MODEST_CONF_VALUE_STRING, TRUE);
200 /* The server account is in the item after the connection name: */
201 GSList *list_connection = g_slist_find_custom (list, connection_name, (GCompareFunc)strcmp);
202 if (list_connection) {
203 /* remove both items: */
204 GSList *temp = g_slist_delete_link(list_connection, list_connection);
205 temp = g_slist_delete_link(temp, g_slist_next(temp));
208 /* Reset the changed list: */
209 modest_account_mgr_set_list (self, account_name,
210 MODEST_ACCOUNT_CONNECTION_SPECIFIC_SMTP_LIST, list,
211 MODEST_CONF_VALUE_STRING, TRUE);
213 /* TODO: Should we free the items too, or just the list? */
220 * modest_account_mgr_get_connection_specific_smtp
221 * @self: a ModestAccountMgr instance
222 * @name: the account name
223 * @connection_name: A libconic IAP connection name
225 * Retrieve a server account to use with this specific connection for this account.
227 * Returns: a server account name to use for this connection, or NULL if none is specified.
229 gchar* modest_account_mgr_get_connection_specific_smtp (ModestAccountMgr *self, const gchar* account_name,
230 const gchar* connection_name)
232 gchar *result = NULL;
234 GSList *list = modest_account_mgr_get_list (self, account_name,
235 MODEST_ACCOUNT_CONNECTION_SPECIFIC_SMTP_LIST,
236 MODEST_CONF_VALUE_STRING, TRUE);
240 /* The server account is in the item after the connection name: */
241 GSList *list_connection = g_slist_find_custom (list, connection_name, (GCompareFunc)strcmp);
242 if (list_connection) {
243 GSList * list_server_account = g_slist_next(list_connection);
244 if (list_server_account)
245 result = g_strdup ((gchar*)(list_server_account->data));
248 /* TODO: Should we free the items too, or just the list? */
255 modest_server_account_get_username (ModestAccountMgr *self, const gchar* account_name)
257 return modest_account_mgr_get_string (self, account_name, MODEST_ACCOUNT_USERNAME,
258 TRUE /* server account */);
262 modest_server_account_set_username (ModestAccountMgr *self, const gchar* account_name,
263 const gchar* username)
265 /* Note that this won't work properly as long as the gconf cache is broken
267 gchar *existing_username = modest_server_account_get_username(self,
270 modest_account_mgr_set_string (self, account_name, MODEST_ACCOUNT_USERNAME,
271 username, TRUE /* server account */);
273 /* We don't know anything about new usernames: */
274 if (strcmp (existing_username, username) != 0)
275 modest_server_account_set_username_has_succeeded (self,
276 account_name, FALSE);
278 g_free (existing_username);
282 modest_server_account_get_username_has_succeeded (ModestAccountMgr *self, const gchar* account_name)
284 return modest_account_mgr_get_bool (self, account_name, MODEST_ACCOUNT_USERNAME_HAS_SUCCEEDED,
285 TRUE /* server account */);
289 modest_server_account_set_username_has_succeeded (ModestAccountMgr *self, const gchar* account_name,
292 modest_account_mgr_set_bool (self, account_name, MODEST_ACCOUNT_USERNAME_HAS_SUCCEEDED,
293 succeeded, TRUE /* server account */);
297 modest_server_account_set_password (ModestAccountMgr *self, const gchar* account_name,
298 const gchar* password)
300 modest_account_mgr_set_string (self, account_name, MODEST_ACCOUNT_PASSWORD,
301 password, TRUE /* server account */);
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 ModestProtocol
313 get_secure_auth_for_conf_string(const gchar* value)
315 ModestProtocol 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 ModestProtocol 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, ModestProtocol 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 ModestProtocol
363 get_security_for_conf_string(const gchar* value)
365 ModestProtocol result = MODEST_PROTOCOL_SECURITY_NONE;
367 if (strcmp(value, MODEST_ACCOUNT_SECURITY_VALUE_NONE) == 0)
368 result = MODEST_PROTOCOL_SECURITY_NONE;
369 else if (strcmp(value, MODEST_ACCOUNT_SECURITY_VALUE_NORMAL) == 0)
370 result = MODEST_PROTOCOL_SECURITY_TLS;
371 else if (strcmp(value, MODEST_ACCOUNT_SECURITY_VALUE_SSL) == 0)
372 result = MODEST_PROTOCOL_SECURITY_SSL;
379 modest_server_account_get_security (ModestAccountMgr *self,
380 const gchar* account_name)
382 ModestProtocol result = MODEST_PROTOCOL_SECURITY_NONE;
383 gchar* value = modest_account_mgr_get_string (self, account_name, MODEST_ACCOUNT_SECURITY,
384 TRUE /* server account */);
386 result = get_security_for_conf_string (value);
395 modest_server_account_set_security (ModestAccountMgr *self,
396 const gchar* account_name, ModestProtocol security)
398 /* Get the conf string for the enum value: */
399 const gchar* str_value = NULL;
400 if (security == MODEST_PROTOCOL_SECURITY_NONE)
401 str_value = MODEST_ACCOUNT_SECURITY_VALUE_NONE;
402 else if (security == MODEST_PROTOCOL_SECURITY_TLS)
403 str_value = MODEST_ACCOUNT_SECURITY_VALUE_NORMAL;
404 else if (security == MODEST_PROTOCOL_SECURITY_SSL)
405 str_value = MODEST_ACCOUNT_SECURITY_VALUE_SSL;
407 /* Set it in the configuration: */
408 modest_account_mgr_set_string (self, account_name, MODEST_ACCOUNT_SECURITY, str_value, TRUE);
413 modest_account_mgr_get_server_account_option (ModestAccountMgr *self,
414 const gchar* account_name, const gchar* option_name)
416 GSList *option_list = modest_account_mgr_get_list (self, account_name, MODEST_ACCOUNT_OPTIONS,
417 MODEST_CONF_VALUE_STRING, TRUE);
421 gchar *result = modest_server_account_data_get_option_value (option_list, option_name);
423 /* TODO: Should we free the items too, or just the list? */
424 g_slist_free (option_list);
430 ModestServerAccountData*
431 modest_account_mgr_get_server_account_data (ModestAccountMgr *self, const gchar* name)
433 ModestServerAccountData *data;
436 g_return_val_if_fail (modest_account_mgr_account_exists (self, name, TRUE), NULL);
437 data = g_slice_new0 (ModestServerAccountData);
439 data->account_name = g_strdup (name);
440 data->hostname = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_HOSTNAME,TRUE);
441 data->username = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_USERNAME,TRUE);
442 proto = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_PROTO, TRUE);
443 data->proto = modest_protocol_info_get_protocol (proto);
446 data->port = modest_account_mgr_get_int (self, name, MODEST_ACCOUNT_PORT, TRUE);
448 gchar *secure_auth_str = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_AUTH_MECH, TRUE);
449 data->secure_auth = get_secure_auth_for_conf_string(secure_auth_str);
450 g_free (secure_auth_str);
452 gchar *security_str = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_SECURITY, TRUE);
453 data->security = get_security_for_conf_string(security_str);
454 g_free (security_str);
456 data->last_updated = modest_account_mgr_get_int (self, name, MODEST_ACCOUNT_LAST_UPDATED,TRUE);
458 data->password = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_PASSWORD, TRUE);
459 data->uri = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_URI,TRUE);
460 data->options = modest_account_mgr_get_list (self, name, MODEST_ACCOUNT_OPTIONS,
461 MODEST_CONF_VALUE_STRING, TRUE);
469 modest_account_mgr_free_server_account_data (ModestAccountMgr *self,
470 ModestServerAccountData* data)
472 g_return_if_fail (self);
475 return; /* not an error */
477 g_free (data->account_name);
478 data->account_name = NULL;
480 g_free (data->hostname);
481 data->hostname = NULL;
483 g_free (data->username);
484 data->username = NULL;
486 g_free (data->password);
487 data->password = NULL;
490 GSList *tmp = data->options;
493 tmp = g_slist_next (tmp);
495 g_slist_free (data->options);
498 g_slice_free (ModestServerAccountData, data);
501 /** You must use modest_account_mgr_free_account_data() on the result.
504 modest_account_mgr_get_account_data (ModestAccountMgr *self, const gchar* name)
506 ModestAccountData *data;
507 gchar *server_account;
508 gchar *default_account;
510 g_return_val_if_fail (self, NULL);
511 g_return_val_if_fail (name, NULL);
513 if (!modest_account_mgr_account_exists (self, name, FALSE)) {
514 /* For instance, maybe you are mistakenly checking for a server account name? */
515 g_warning ("%s: Account %s does not exist.", __FUNCTION__, name);
519 data = g_slice_new0 (ModestAccountData);
521 data->account_name = g_strdup (name);
523 data->display_name = modest_account_mgr_get_string (self, name,
524 MODEST_ACCOUNT_DISPLAY_NAME,
526 data->fullname = modest_account_mgr_get_string (self, name,
527 MODEST_ACCOUNT_FULLNAME,
529 data->email = modest_account_mgr_get_string (self, name,
530 MODEST_ACCOUNT_EMAIL,
532 data->is_enabled = modest_account_mgr_get_enabled (self, name);
534 default_account = modest_account_mgr_get_default_account (self);
535 data->is_default = (default_account && strcmp (default_account, name) == 0);
536 g_free (default_account);
539 server_account = modest_account_mgr_get_string (self, name,
540 MODEST_ACCOUNT_STORE_ACCOUNT,
542 if (server_account) {
543 data->store_account =
544 modest_account_mgr_get_server_account_data (self, server_account);
545 g_free (server_account);
549 server_account = modest_account_mgr_get_string (self, name,
550 MODEST_ACCOUNT_TRANSPORT_ACCOUNT,
552 if (server_account) {
553 data->transport_account =
554 modest_account_mgr_get_server_account_data (self, server_account);
555 g_free (server_account);
563 modest_account_mgr_free_account_data (ModestAccountMgr *self, ModestAccountData *data)
565 g_return_if_fail (self);
567 if (!data) /* not an error */
570 g_free (data->account_name);
571 g_free (data->display_name);
572 g_free (data->fullname);
573 g_free (data->email);
575 modest_account_mgr_free_server_account_data (self, data->store_account);
576 modest_account_mgr_free_server_account_data (self, data->transport_account);
578 g_slice_free (ModestAccountData, data);
583 modest_account_mgr_get_default_account (ModestAccountMgr *self)
589 g_return_val_if_fail (self, NULL);
591 conf = MODEST_ACCOUNT_MGR_GET_PRIVATE (self)->modest_conf;
592 account = modest_conf_get_string (conf, MODEST_CONF_DEFAULT_ACCOUNT, &err);
595 g_printerr ("modest: failed to get '%s': %s\n",
596 MODEST_CONF_DEFAULT_ACCOUNT, err->message);
602 /* it's not really an error if there is no default account */
607 if (!modest_account_mgr_account_exists (self, account, FALSE)) {
608 g_printerr ("modest: default account does not exist\n");
618 modest_account_mgr_set_default_account (ModestAccountMgr *self, const gchar* account)
622 g_return_val_if_fail (self, FALSE);
623 g_return_val_if_fail (account, FALSE);
624 g_return_val_if_fail (modest_account_mgr_account_exists (self, account, FALSE),
627 conf = MODEST_ACCOUNT_MGR_GET_PRIVATE (self)->modest_conf;
629 return modest_conf_set_string (conf, MODEST_CONF_DEFAULT_ACCOUNT,
635 modest_account_mgr_unset_default_account (ModestAccountMgr *self)
639 g_return_val_if_fail (self, FALSE);
641 conf = MODEST_ACCOUNT_MGR_GET_PRIVATE (self)->modest_conf;
643 return modest_conf_remove_key (conf, MODEST_CONF_DEFAULT_ACCOUNT, NULL /* err */);
647 gint on_accounts_list_sort_by_title(gconstpointer a, gconstpointer b)
649 return g_utf8_collate((const gchar*)a, (const gchar*)b);
653 modest_account_mgr_set_first_account_as_default (ModestAccountMgr *self)
655 gboolean result = FALSE;
656 GSList *account_names = modest_account_mgr_account_names (self, TRUE /* only enabled */);
658 /* Get the first one, alphabetically, by title: */
659 GSList* list_sorted = g_slist_sort (account_names,
660 on_accounts_list_sort_by_title);
663 const gchar* account_name = (const gchar*)list_sorted->data;
665 result = modest_account_mgr_set_default_account (self, account_name);
668 /* TODO: Free the strings too? */
669 g_slist_free (account_names);
675 modest_account_mgr_get_from_string (ModestAccountMgr *self, const gchar* name)
677 gchar *fullname, *email, *from;
679 g_return_val_if_fail (self, NULL);
680 g_return_val_if_fail (name, NULL);
682 fullname = modest_account_mgr_get_string (self, name,MODEST_ACCOUNT_FULLNAME,
684 email = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_EMAIL,
686 from = g_strdup_printf ("%s <%s>",
687 fullname ? fullname : "",
695 /* Add a number to the end of the text, or increment a number that is already there.
698 util_increment_name (const gchar* text)
700 /* Get the end character,
701 * also doing a UTF-8 validation which is required for using g_utf8_prev_char().
703 const gchar* end = NULL;
704 if (!g_utf8_validate (text, -1, &end))
710 --end; /* Go to before the null-termination. */
712 /* Look at each UTF-8 characer, starting at the end: */
713 const gchar* p = end;
714 const gchar* alpha_end = NULL;
717 /* Stop when we reach the first character that is not a numeric digit: */
718 const gunichar ch = g_utf8_get_char (p);
719 if (!g_unichar_isdigit (ch)) {
724 p = g_utf8_prev_char (p);
728 /* The text must consist completely of numeric digits. */
734 /* Intepret and increment the number, if any: */
735 gint num = atol (alpha_end);
738 /* Get the name part: */
739 gint name_len = alpha_end - text;
740 gchar *name_without_number = g_malloc(name_len + 1);
741 memcpy (name_without_number, text, name_len);
742 name_without_number[name_len] = 0;\
744 /* Concatenate the text part and the new number: */
745 gchar *result = g_strdup_printf("%s%d", name_without_number, num);
746 g_free (name_without_number);
752 modest_account_mgr_get_unused_account_name (ModestAccountMgr *self, const gchar* starting_name,
753 gboolean server_account)
755 gchar *account_name = g_strdup (starting_name);
757 while (modest_account_mgr_account_exists (self,
758 account_name, server_account /* server_account */)) {
760 gchar * account_name2 = util_increment_name (account_name);
761 g_free (account_name);
762 account_name = account_name2;
769 modest_account_mgr_get_unused_account_display_name (ModestAccountMgr *self, const gchar* starting_name)
771 gchar *account_name = g_strdup (starting_name);
773 while (modest_account_mgr_account_with_display_name_exists (self, account_name)) {
775 gchar * account_name2 = util_increment_name (account_name);
776 g_free (account_name);
777 account_name = account_name2;