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 gboolean modest_account_mgr_set_connection_specific_smtp (ModestAccountMgr *self,
81 const gchar* account_name,
82 const gchar* connection_name, const gchar* server_account_name)
84 modest_account_mgr_remove_connection_specific_smtp (self, account_name, connection_name);
86 GSList *list = modest_account_mgr_get_list (self, account_name,
87 MODEST_ACCOUNT_CONNECTION_SPECIFIC_SMTP_LIST,
88 MODEST_CONF_VALUE_STRING, FALSE);
90 /* The server account is in the item after the connection name: */
91 GSList *list_connection = g_slist_append (list, (gpointer)connection_name);
92 list_connection = g_slist_append (list_connection, (gpointer)server_account_name);
94 /* Reset the changed list: */
95 modest_account_mgr_set_list (self, account_name,
96 MODEST_ACCOUNT_CONNECTION_SPECIFIC_SMTP_LIST, list_connection,
97 MODEST_CONF_VALUE_STRING, FALSE);
99 /* TODO: Should we free the items too, or just the list? */
106 * modest_account_mgr_remove_connection_specific_smtp
107 * @self: a ModestAccountMgr instance
108 * @name: the account name
109 * @connection_name: A libconic IAP connection name
111 * Disassacoiate a server account to use with the specific connection for this account.
113 * Returns: TRUE if it worked, FALSE otherwise
115 gboolean modest_account_mgr_remove_connection_specific_smtp (ModestAccountMgr *self,
116 const gchar* account_name, const gchar* connection_name)
118 GSList *list = modest_account_mgr_get_list (self, account_name,
119 MODEST_ACCOUNT_CONNECTION_SPECIFIC_SMTP_LIST,
120 MODEST_CONF_VALUE_STRING, FALSE);
124 /* The server account is in the item after the connection name: */
125 GSList *list_connection = g_slist_find_custom (list, connection_name, (GCompareFunc)strcmp);
126 if (list_connection) {
127 /* remove both items: */
128 GSList *temp = g_slist_delete_link(list_connection, list_connection);
129 temp = g_slist_delete_link(temp, g_slist_next(temp));
132 /* Reset the changed list: */
133 modest_account_mgr_set_list (self, account_name,
134 MODEST_ACCOUNT_CONNECTION_SPECIFIC_SMTP_LIST, list,
135 MODEST_CONF_VALUE_STRING, FALSE);
137 /* TODO: Should we free the items too, or just the list? */
143 gboolean modest_account_mgr_get_has_connection_specific_smtp (ModestAccountMgr *self, const gchar* account_name)
145 GSList *list = modest_account_mgr_get_list (self, account_name,
146 MODEST_ACCOUNT_CONNECTION_SPECIFIC_SMTP_LIST,
147 MODEST_CONF_VALUE_STRING, FALSE);
151 /* TODO: Should we free the items too, or just the list? */
158 * modest_account_mgr_get_connection_specific_smtp
159 * @self: a ModestAccountMgr instance
160 * @name: the account name
161 * @connection_name: A libconic IAP connection name
163 * Retrieve a server account to use with this specific connection for this account.
165 * Returns: a server account name to use for this connection, or NULL if none is specified.
167 gchar* modest_account_mgr_get_connection_specific_smtp (ModestAccountMgr *self, const gchar* account_name,
168 const gchar* connection_name)
170 gchar *result = NULL;
172 GSList *list = modest_account_mgr_get_list (self, account_name,
173 MODEST_ACCOUNT_CONNECTION_SPECIFIC_SMTP_LIST,
174 MODEST_CONF_VALUE_STRING, FALSE);
178 /* The server account is in the item after the connection name: */
179 GSList *list_connection = g_slist_find_custom (list, connection_name, (GCompareFunc)strcmp);
180 if (list_connection) {
181 GSList * list_server_account = g_slist_next(list_connection);
182 if (list_server_account)
183 result = g_strdup ((gchar*)(list_server_account->data));
186 /* TODO: Should we free the items too, or just the list? */
193 modest_server_account_get_username (ModestAccountMgr *self, const gchar* account_name)
195 return modest_account_mgr_get_string (self, account_name, MODEST_ACCOUNT_USERNAME,
196 TRUE /* server account */);
200 modest_server_account_set_username (ModestAccountMgr *self, const gchar* account_name,
201 const gchar* username)
203 /* Note that this won't work properly as long as the gconf cache is broken
205 gchar *existing_username = modest_server_account_get_username(self,
208 modest_account_mgr_set_string (self, account_name, MODEST_ACCOUNT_USERNAME,
209 username, TRUE /* server account */);
211 /* We don't know anything about new usernames: */
212 if (strcmp (existing_username, username) != 0)
213 modest_server_account_set_username_has_succeeded (self,
214 account_name, FALSE);
216 g_free (existing_username);
220 modest_server_account_get_username_has_succeeded (ModestAccountMgr *self, const gchar* account_name)
222 return modest_account_mgr_get_bool (self, account_name, MODEST_ACCOUNT_USERNAME_HAS_SUCCEEDED,
223 TRUE /* server account */);
227 modest_server_account_set_username_has_succeeded (ModestAccountMgr *self, const gchar* account_name,
230 modest_account_mgr_set_bool (self, account_name, MODEST_ACCOUNT_USERNAME_HAS_SUCCEEDED,
231 succeeded, TRUE /* server account */);
235 modest_server_account_set_password (ModestAccountMgr *self, const gchar* account_name,
236 const gchar* password)
238 modest_account_mgr_set_string (self, account_name, MODEST_ACCOUNT_PASSWORD,
239 password, TRUE /* server account */);
243 modest_server_account_get_hostname (ModestAccountMgr *self, const gchar* account_name)
245 return modest_account_mgr_get_string (self, account_name, MODEST_ACCOUNT_HOSTNAME,
246 TRUE /* server account */);
250 static ModestAuthProtocol
251 get_secure_auth_for_conf_string(const gchar* value)
253 ModestAuthProtocol result = MODEST_PROTOCOL_AUTH_NONE;
255 if (strcmp(value, MODEST_ACCOUNT_AUTH_MECH_VALUE_NONE) == 0)
256 result = MODEST_PROTOCOL_AUTH_NONE;
257 else if (strcmp(value, MODEST_ACCOUNT_AUTH_MECH_VALUE_PASSWORD) == 0)
258 result = MODEST_PROTOCOL_AUTH_PASSWORD;
259 else if (strcmp(value, MODEST_ACCOUNT_AUTH_MECH_VALUE_CRAMMD5) == 0)
260 result = MODEST_PROTOCOL_AUTH_CRAMMD5;
267 modest_server_account_get_secure_auth (ModestAccountMgr *self,
268 const gchar* account_name)
270 ModestAuthProtocol result = MODEST_PROTOCOL_AUTH_NONE;
271 gchar* value = modest_account_mgr_get_string (self, account_name, MODEST_ACCOUNT_AUTH_MECH,
272 TRUE /* server account */);
274 result = get_secure_auth_for_conf_string (value);
284 modest_server_account_set_secure_auth (ModestAccountMgr *self,
285 const gchar* account_name, ModestAuthProtocol secure_auth)
287 /* Get the conf string for the enum value: */
288 const gchar* str_value = NULL;
289 if (secure_auth == MODEST_PROTOCOL_AUTH_NONE)
290 str_value = MODEST_ACCOUNT_AUTH_MECH_VALUE_NONE;
291 else if (secure_auth == MODEST_PROTOCOL_AUTH_PASSWORD)
292 str_value = MODEST_ACCOUNT_AUTH_MECH_VALUE_PASSWORD;
293 else if (secure_auth == MODEST_PROTOCOL_AUTH_CRAMMD5)
294 str_value = MODEST_ACCOUNT_AUTH_MECH_VALUE_CRAMMD5;
296 /* Set it in the configuration: */
297 modest_account_mgr_set_string (self, account_name, MODEST_ACCOUNT_AUTH_MECH, str_value, TRUE);
300 static ModestConnectionProtocol
301 get_security_for_conf_string(const gchar* value)
303 ModestConnectionProtocol result = MODEST_PROTOCOL_CONNECTION_NORMAL;
305 if (strcmp(value, MODEST_ACCOUNT_SECURITY_VALUE_NONE) == 0)
306 result = MODEST_PROTOCOL_CONNECTION_NORMAL;
307 else if (strcmp(value, MODEST_ACCOUNT_SECURITY_VALUE_NORMAL) == 0)
308 result = MODEST_PROTOCOL_CONNECTION_TLS;
309 else if (strcmp(value, MODEST_ACCOUNT_SECURITY_VALUE_SSL) == 0)
310 result = MODEST_PROTOCOL_CONNECTION_SSL;
316 ModestConnectionProtocol
317 modest_server_account_get_security (ModestAccountMgr *self,
318 const gchar* account_name)
320 ModestConnectionProtocol result = MODEST_PROTOCOL_CONNECTION_NORMAL;
321 gchar* value = modest_account_mgr_get_string (self, account_name, MODEST_ACCOUNT_SECURITY,
322 TRUE /* server account */);
324 result = get_security_for_conf_string (value);
333 modest_server_account_set_security (ModestAccountMgr *self,
334 const gchar* account_name, ModestConnectionProtocol security)
336 /* Get the conf string for the enum value: */
337 const gchar* str_value = NULL;
338 if (security == MODEST_PROTOCOL_CONNECTION_NORMAL)
339 str_value = MODEST_ACCOUNT_SECURITY_VALUE_NONE;
340 else if (security == MODEST_PROTOCOL_CONNECTION_TLS)
341 str_value = MODEST_ACCOUNT_SECURITY_VALUE_NORMAL;
342 else if (security == MODEST_PROTOCOL_CONNECTION_SSL)
343 str_value = MODEST_ACCOUNT_SECURITY_VALUE_SSL;
345 /* Set it in the configuration: */
346 modest_account_mgr_set_string (self, account_name, MODEST_ACCOUNT_SECURITY, str_value, TRUE);
349 ModestServerAccountData*
350 modest_account_mgr_get_server_account_data (ModestAccountMgr *self, const gchar* name)
352 ModestServerAccountData *data;
355 g_return_val_if_fail (modest_account_mgr_account_exists (self, name, TRUE), NULL);
356 data = g_slice_new0 (ModestServerAccountData);
358 data->account_name = g_strdup (name);
359 data->hostname = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_HOSTNAME,TRUE);
360 data->username = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_USERNAME,TRUE);
361 proto = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_PROTO, TRUE);
362 data->proto = modest_protocol_info_get_transport_store_protocol (proto);
365 data->port = modest_account_mgr_get_int (self, name, MODEST_ACCOUNT_PORT, TRUE);
367 gchar *secure_auth_str = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_AUTH_MECH, TRUE);
368 data->secure_auth = get_secure_auth_for_conf_string(secure_auth_str);
369 g_free (secure_auth_str);
371 gchar *security_str = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_SECURITY, TRUE);
372 data->security = get_security_for_conf_string(security_str);
373 g_free (security_str);
375 data->last_updated = modest_account_mgr_get_int (self, name, MODEST_ACCOUNT_LAST_UPDATED,TRUE);
377 data->password = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_PASSWORD, TRUE);
384 modest_account_mgr_free_server_account_data (ModestAccountMgr *self,
385 ModestServerAccountData* data)
387 g_return_if_fail (self);
390 return; /* not an error */
392 g_free (data->account_name);
393 data->account_name = NULL;
395 g_free (data->hostname);
396 data->hostname = NULL;
398 g_free (data->username);
399 data->username = NULL;
401 g_free (data->password);
402 data->password = NULL;
404 g_slice_free (ModestServerAccountData, data);
407 /** You must use modest_account_mgr_free_account_data() on the result.
410 modest_account_mgr_get_account_data (ModestAccountMgr *self, const gchar* name)
412 ModestAccountData *data;
413 gchar *server_account;
414 gchar *default_account;
416 g_return_val_if_fail (self, NULL);
417 g_return_val_if_fail (name, NULL);
419 if (!modest_account_mgr_account_exists (self, name, FALSE)) {
420 /* For instance, maybe you are mistakenly checking for a server account name? */
421 g_warning ("%s: Account %s does not exist.", __FUNCTION__, name);
425 data = g_slice_new0 (ModestAccountData);
427 data->account_name = g_strdup (name);
429 data->display_name = modest_account_mgr_get_string (self, name,
430 MODEST_ACCOUNT_DISPLAY_NAME,
432 data->fullname = modest_account_mgr_get_string (self, name,
433 MODEST_ACCOUNT_FULLNAME,
435 data->email = modest_account_mgr_get_string (self, name,
436 MODEST_ACCOUNT_EMAIL,
438 data->is_enabled = modest_account_mgr_get_enabled (self, name);
440 default_account = modest_account_mgr_get_default_account (self);
441 data->is_default = (default_account && strcmp (default_account, name) == 0);
442 g_free (default_account);
445 server_account = modest_account_mgr_get_string (self, name,
446 MODEST_ACCOUNT_STORE_ACCOUNT,
448 if (server_account) {
449 data->store_account =
450 modest_account_mgr_get_server_account_data (self, server_account);
451 g_free (server_account);
455 server_account = modest_account_mgr_get_string (self, name,
456 MODEST_ACCOUNT_TRANSPORT_ACCOUNT,
458 if (server_account) {
459 data->transport_account =
460 modest_account_mgr_get_server_account_data (self, server_account);
461 g_free (server_account);
469 modest_account_mgr_free_account_data (ModestAccountMgr *self, ModestAccountData *data)
471 g_return_if_fail (self);
473 if (!data) /* not an error */
476 g_free (data->account_name);
477 g_free (data->display_name);
478 g_free (data->fullname);
479 g_free (data->email);
481 modest_account_mgr_free_server_account_data (self, data->store_account);
482 modest_account_mgr_free_server_account_data (self, data->transport_account);
484 g_slice_free (ModestAccountData, data);
489 modest_account_mgr_get_default_account (ModestAccountMgr *self)
495 g_return_val_if_fail (self, NULL);
497 conf = MODEST_ACCOUNT_MGR_GET_PRIVATE (self)->modest_conf;
498 account = modest_conf_get_string (conf, MODEST_CONF_DEFAULT_ACCOUNT, &err);
501 g_printerr ("modest: failed to get '%s': %s\n",
502 MODEST_CONF_DEFAULT_ACCOUNT, err->message);
508 /* Make sure that at least one account is always the default, if possible:
509 * (It would be meaningless to have enabled accounts but no default account. */
511 modest_account_mgr_set_first_account_as_default (self);
512 account = modest_conf_get_string (conf, MODEST_CONF_DEFAULT_ACCOUNT, &err);
516 if (!modest_account_mgr_account_exists (self, account, FALSE)) {
517 g_printerr ("modest: default account does not exist\n");
527 modest_account_mgr_set_default_account (ModestAccountMgr *self, const gchar* account)
531 g_return_val_if_fail (self, FALSE);
532 g_return_val_if_fail (account, FALSE);
533 g_return_val_if_fail (modest_account_mgr_account_exists (self, account, FALSE),
536 conf = MODEST_ACCOUNT_MGR_GET_PRIVATE (self)->modest_conf;
538 return modest_conf_set_string (conf, MODEST_CONF_DEFAULT_ACCOUNT,
544 modest_account_mgr_unset_default_account (ModestAccountMgr *self)
548 g_return_val_if_fail (self, FALSE);
550 conf = MODEST_ACCOUNT_MGR_GET_PRIVATE (self)->modest_conf;
552 return modest_conf_remove_key (conf, MODEST_CONF_DEFAULT_ACCOUNT, NULL /* err */);
556 gint on_accounts_list_sort_by_title(gconstpointer a, gconstpointer b)
558 return g_utf8_collate((const gchar*)a, (const gchar*)b);
562 modest_account_mgr_set_first_account_as_default (ModestAccountMgr *self)
564 gboolean result = FALSE;
565 GSList *account_names = modest_account_mgr_account_names (self, TRUE /* only enabled */);
567 /* Get the first one, alphabetically, by title: */
568 GSList* list_sorted = g_slist_sort (account_names,
569 on_accounts_list_sort_by_title);
572 const gchar* account_name = (const gchar*)list_sorted->data;
574 result = modest_account_mgr_set_default_account (self, account_name);
577 /* TODO: Free the strings too? */
578 g_slist_free (account_names);
584 modest_account_mgr_get_from_string (ModestAccountMgr *self, const gchar* name)
586 gchar *fullname, *email, *from;
588 g_return_val_if_fail (self, NULL);
589 g_return_val_if_fail (name, NULL);
591 fullname = modest_account_mgr_get_string (self, name,MODEST_ACCOUNT_FULLNAME,
593 email = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_EMAIL,
595 from = g_strdup_printf ("%s <%s>",
596 fullname ? fullname : "",
604 /* Add a number to the end of the text, or increment a number that is already there.
607 util_increment_name (const gchar* text)
609 /* Get the end character,
610 * also doing a UTF-8 validation which is required for using g_utf8_prev_char().
612 const gchar* end = NULL;
613 if (!g_utf8_validate (text, -1, &end))
619 --end; /* Go to before the null-termination. */
621 /* Look at each UTF-8 characer, starting at the end: */
622 const gchar* p = end;
623 const gchar* alpha_end = NULL;
626 /* Stop when we reach the first character that is not a numeric digit: */
627 const gunichar ch = g_utf8_get_char (p);
628 if (!g_unichar_isdigit (ch)) {
633 p = g_utf8_prev_char (p);
637 /* The text must consist completely of numeric digits. */
643 /* Intepret and increment the number, if any: */
644 gint num = atol (alpha_end);
647 /* Get the name part: */
648 gint name_len = alpha_end - text;
649 gchar *name_without_number = g_malloc(name_len + 1);
650 memcpy (name_without_number, text, name_len);
651 name_without_number[name_len] = 0;\
653 /* Concatenate the text part and the new number: */
654 gchar *result = g_strdup_printf("%s%d", name_without_number, num);
655 g_free (name_without_number);
661 modest_account_mgr_get_unused_account_name (ModestAccountMgr *self, const gchar* starting_name,
662 gboolean server_account)
664 gchar *account_name = g_strdup (starting_name);
666 while (modest_account_mgr_account_exists (self,
667 account_name, server_account /* server_account */)) {
669 gchar * account_name2 = util_increment_name (account_name);
670 g_free (account_name);
671 account_name = account_name2;
678 modest_account_mgr_get_unused_account_display_name (ModestAccountMgr *self, const gchar* starting_name)
680 gchar *account_name = g_strdup (starting_name);
682 while (modest_account_mgr_account_with_display_name_exists (self, account_name)) {
684 gchar * account_name2 = util_increment_name (account_name);
685 g_free (account_name);
686 account_name = account_name2;