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, TRUE);
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,
97 MODEST_CONF_VALUE_STRING, TRUE);
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, TRUE);
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, TRUE);
137 /* TODO: Should we free the items too, or just the list? */
144 * modest_account_mgr_get_connection_specific_smtp
145 * @self: a ModestAccountMgr instance
146 * @name: the account name
147 * @connection_name: A libconic IAP connection name
149 * Retrieve a server account to use with this specific connection for this account.
151 * Returns: a server account name to use for this connection, or NULL if none is specified.
153 gchar* modest_account_mgr_get_connection_specific_smtp (ModestAccountMgr *self, const gchar* account_name,
154 const gchar* connection_name)
156 gchar *result = NULL;
158 GSList *list = modest_account_mgr_get_list (self, account_name,
159 MODEST_ACCOUNT_CONNECTION_SPECIFIC_SMTP_LIST,
160 MODEST_CONF_VALUE_STRING, TRUE);
164 /* The server account is in the item after the connection name: */
165 GSList *list_connection = g_slist_find_custom (list, connection_name, (GCompareFunc)strcmp);
166 if (list_connection) {
167 GSList * list_server_account = g_slist_next(list_connection);
168 if (list_server_account)
169 result = g_strdup ((gchar*)(list_server_account->data));
172 /* TODO: Should we free the items too, or just the list? */
179 modest_server_account_get_username (ModestAccountMgr *self, const gchar* account_name)
181 return modest_account_mgr_get_string (self, account_name, MODEST_ACCOUNT_USERNAME,
182 TRUE /* server account */);
186 modest_server_account_set_username (ModestAccountMgr *self, const gchar* account_name,
187 const gchar* username)
189 /* Note that this won't work properly as long as the gconf cache is broken
191 gchar *existing_username = modest_server_account_get_username(self,
194 modest_account_mgr_set_string (self, account_name, MODEST_ACCOUNT_USERNAME,
195 username, TRUE /* server account */);
197 /* We don't know anything about new usernames: */
198 if (strcmp (existing_username, username) != 0)
199 modest_server_account_set_username_has_succeeded (self,
200 account_name, FALSE);
202 g_free (existing_username);
206 modest_server_account_get_username_has_succeeded (ModestAccountMgr *self, const gchar* account_name)
208 return modest_account_mgr_get_bool (self, account_name, MODEST_ACCOUNT_USERNAME_HAS_SUCCEEDED,
209 TRUE /* server account */);
213 modest_server_account_set_username_has_succeeded (ModestAccountMgr *self, const gchar* account_name,
216 modest_account_mgr_set_bool (self, account_name, MODEST_ACCOUNT_USERNAME_HAS_SUCCEEDED,
217 succeeded, TRUE /* server account */);
221 modest_server_account_set_password (ModestAccountMgr *self, const gchar* account_name,
222 const gchar* password)
224 modest_account_mgr_set_string (self, account_name, MODEST_ACCOUNT_PASSWORD,
225 password, TRUE /* server account */);
229 modest_server_account_get_hostname (ModestAccountMgr *self, const gchar* account_name)
231 return modest_account_mgr_get_string (self, account_name, MODEST_ACCOUNT_HOSTNAME,
232 TRUE /* server account */);
236 static ModestAuthProtocol
237 get_secure_auth_for_conf_string(const gchar* value)
239 ModestAuthProtocol result = MODEST_PROTOCOL_AUTH_NONE;
241 if (strcmp(value, MODEST_ACCOUNT_AUTH_MECH_VALUE_NONE) == 0)
242 result = MODEST_PROTOCOL_AUTH_NONE;
243 else if (strcmp(value, MODEST_ACCOUNT_AUTH_MECH_VALUE_PASSWORD) == 0)
244 result = MODEST_PROTOCOL_AUTH_PASSWORD;
245 else if (strcmp(value, MODEST_ACCOUNT_AUTH_MECH_VALUE_CRAMMD5) == 0)
246 result = MODEST_PROTOCOL_AUTH_CRAMMD5;
253 modest_server_account_get_secure_auth (ModestAccountMgr *self,
254 const gchar* account_name)
256 ModestAuthProtocol result = MODEST_PROTOCOL_AUTH_NONE;
257 gchar* value = modest_account_mgr_get_string (self, account_name, MODEST_ACCOUNT_AUTH_MECH,
258 TRUE /* server account */);
260 result = get_secure_auth_for_conf_string (value);
270 modest_server_account_set_secure_auth (ModestAccountMgr *self,
271 const gchar* account_name, ModestAuthProtocol secure_auth)
273 /* Get the conf string for the enum value: */
274 const gchar* str_value = NULL;
275 if (secure_auth == MODEST_PROTOCOL_AUTH_NONE)
276 str_value = MODEST_ACCOUNT_AUTH_MECH_VALUE_NONE;
277 else if (secure_auth == MODEST_PROTOCOL_AUTH_PASSWORD)
278 str_value = MODEST_ACCOUNT_AUTH_MECH_VALUE_PASSWORD;
279 else if (secure_auth == MODEST_PROTOCOL_AUTH_CRAMMD5)
280 str_value = MODEST_ACCOUNT_AUTH_MECH_VALUE_CRAMMD5;
282 /* Set it in the configuration: */
283 modest_account_mgr_set_string (self, account_name, MODEST_ACCOUNT_AUTH_MECH, str_value, TRUE);
286 static ModestConnectionProtocol
287 get_security_for_conf_string(const gchar* value)
289 ModestConnectionProtocol result = MODEST_PROTOCOL_CONNECTION_NORMAL;
291 if (strcmp(value, MODEST_ACCOUNT_SECURITY_VALUE_NONE) == 0)
292 result = MODEST_PROTOCOL_CONNECTION_NORMAL;
293 else if (strcmp(value, MODEST_ACCOUNT_SECURITY_VALUE_NORMAL) == 0)
294 result = MODEST_PROTOCOL_CONNECTION_TLS;
295 else if (strcmp(value, MODEST_ACCOUNT_SECURITY_VALUE_SSL) == 0)
296 result = MODEST_PROTOCOL_CONNECTION_SSL;
302 ModestConnectionProtocol
303 modest_server_account_get_security (ModestAccountMgr *self,
304 const gchar* account_name)
306 ModestConnectionProtocol result = MODEST_PROTOCOL_CONNECTION_NORMAL;
307 gchar* value = modest_account_mgr_get_string (self, account_name, MODEST_ACCOUNT_SECURITY,
308 TRUE /* server account */);
310 result = get_security_for_conf_string (value);
319 modest_server_account_set_security (ModestAccountMgr *self,
320 const gchar* account_name, ModestConnectionProtocol security)
322 /* Get the conf string for the enum value: */
323 const gchar* str_value = NULL;
324 if (security == MODEST_PROTOCOL_CONNECTION_NORMAL)
325 str_value = MODEST_ACCOUNT_SECURITY_VALUE_NONE;
326 else if (security == MODEST_PROTOCOL_CONNECTION_TLS)
327 str_value = MODEST_ACCOUNT_SECURITY_VALUE_NORMAL;
328 else if (security == MODEST_PROTOCOL_CONNECTION_SSL)
329 str_value = MODEST_ACCOUNT_SECURITY_VALUE_SSL;
331 /* Set it in the configuration: */
332 modest_account_mgr_set_string (self, account_name, MODEST_ACCOUNT_SECURITY, str_value, TRUE);
335 ModestServerAccountData*
336 modest_account_mgr_get_server_account_data (ModestAccountMgr *self, const gchar* name)
338 ModestServerAccountData *data;
341 g_return_val_if_fail (modest_account_mgr_account_exists (self, name, TRUE), NULL);
342 data = g_slice_new0 (ModestServerAccountData);
344 data->account_name = g_strdup (name);
345 data->hostname = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_HOSTNAME,TRUE);
346 data->username = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_USERNAME,TRUE);
347 proto = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_PROTO, TRUE);
348 data->proto = modest_protocol_info_get_transport_store_protocol (proto);
351 data->port = modest_account_mgr_get_int (self, name, MODEST_ACCOUNT_PORT, TRUE);
353 gchar *secure_auth_str = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_AUTH_MECH, TRUE);
354 data->secure_auth = get_secure_auth_for_conf_string(secure_auth_str);
355 g_free (secure_auth_str);
357 gchar *security_str = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_SECURITY, TRUE);
358 data->security = get_security_for_conf_string(security_str);
359 g_free (security_str);
361 data->last_updated = modest_account_mgr_get_int (self, name, MODEST_ACCOUNT_LAST_UPDATED,TRUE);
363 data->password = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_PASSWORD, TRUE);
370 modest_account_mgr_free_server_account_data (ModestAccountMgr *self,
371 ModestServerAccountData* data)
373 g_return_if_fail (self);
376 return; /* not an error */
378 g_free (data->account_name);
379 data->account_name = NULL;
381 g_free (data->hostname);
382 data->hostname = NULL;
384 g_free (data->username);
385 data->username = NULL;
387 g_free (data->password);
388 data->password = NULL;
390 g_slice_free (ModestServerAccountData, data);
393 /** You must use modest_account_mgr_free_account_data() on the result.
396 modest_account_mgr_get_account_data (ModestAccountMgr *self, const gchar* name)
398 ModestAccountData *data;
399 gchar *server_account;
400 gchar *default_account;
402 g_return_val_if_fail (self, NULL);
403 g_return_val_if_fail (name, NULL);
405 if (!modest_account_mgr_account_exists (self, name, FALSE)) {
406 /* For instance, maybe you are mistakenly checking for a server account name? */
407 g_warning ("%s: Account %s does not exist.", __FUNCTION__, name);
411 data = g_slice_new0 (ModestAccountData);
413 data->account_name = g_strdup (name);
415 data->display_name = modest_account_mgr_get_string (self, name,
416 MODEST_ACCOUNT_DISPLAY_NAME,
418 data->fullname = modest_account_mgr_get_string (self, name,
419 MODEST_ACCOUNT_FULLNAME,
421 data->email = modest_account_mgr_get_string (self, name,
422 MODEST_ACCOUNT_EMAIL,
424 data->is_enabled = modest_account_mgr_get_enabled (self, name);
426 default_account = modest_account_mgr_get_default_account (self);
427 data->is_default = (default_account && strcmp (default_account, name) == 0);
428 g_free (default_account);
431 server_account = modest_account_mgr_get_string (self, name,
432 MODEST_ACCOUNT_STORE_ACCOUNT,
434 if (server_account) {
435 data->store_account =
436 modest_account_mgr_get_server_account_data (self, server_account);
437 g_free (server_account);
441 server_account = modest_account_mgr_get_string (self, name,
442 MODEST_ACCOUNT_TRANSPORT_ACCOUNT,
444 if (server_account) {
445 data->transport_account =
446 modest_account_mgr_get_server_account_data (self, server_account);
447 g_free (server_account);
455 modest_account_mgr_free_account_data (ModestAccountMgr *self, ModestAccountData *data)
457 g_return_if_fail (self);
459 if (!data) /* not an error */
462 g_free (data->account_name);
463 g_free (data->display_name);
464 g_free (data->fullname);
465 g_free (data->email);
467 modest_account_mgr_free_server_account_data (self, data->store_account);
468 modest_account_mgr_free_server_account_data (self, data->transport_account);
470 g_slice_free (ModestAccountData, data);
475 modest_account_mgr_get_default_account (ModestAccountMgr *self)
481 g_return_val_if_fail (self, NULL);
483 conf = MODEST_ACCOUNT_MGR_GET_PRIVATE (self)->modest_conf;
484 account = modest_conf_get_string (conf, MODEST_CONF_DEFAULT_ACCOUNT, &err);
487 g_printerr ("modest: failed to get '%s': %s\n",
488 MODEST_CONF_DEFAULT_ACCOUNT, err->message);
494 /* it's not really an error if there is no default account */
499 if (!modest_account_mgr_account_exists (self, account, FALSE)) {
500 g_printerr ("modest: default account does not exist\n");
510 modest_account_mgr_set_default_account (ModestAccountMgr *self, const gchar* account)
514 g_return_val_if_fail (self, FALSE);
515 g_return_val_if_fail (account, FALSE);
516 g_return_val_if_fail (modest_account_mgr_account_exists (self, account, FALSE),
519 conf = MODEST_ACCOUNT_MGR_GET_PRIVATE (self)->modest_conf;
521 return modest_conf_set_string (conf, MODEST_CONF_DEFAULT_ACCOUNT,
527 modest_account_mgr_unset_default_account (ModestAccountMgr *self)
531 g_return_val_if_fail (self, FALSE);
533 conf = MODEST_ACCOUNT_MGR_GET_PRIVATE (self)->modest_conf;
535 return modest_conf_remove_key (conf, MODEST_CONF_DEFAULT_ACCOUNT, NULL /* err */);
539 gint on_accounts_list_sort_by_title(gconstpointer a, gconstpointer b)
541 return g_utf8_collate((const gchar*)a, (const gchar*)b);
545 modest_account_mgr_set_first_account_as_default (ModestAccountMgr *self)
547 gboolean result = FALSE;
548 GSList *account_names = modest_account_mgr_account_names (self, TRUE /* only enabled */);
550 /* Get the first one, alphabetically, by title: */
551 GSList* list_sorted = g_slist_sort (account_names,
552 on_accounts_list_sort_by_title);
555 const gchar* account_name = (const gchar*)list_sorted->data;
557 result = modest_account_mgr_set_default_account (self, account_name);
560 /* TODO: Free the strings too? */
561 g_slist_free (account_names);
567 modest_account_mgr_get_from_string (ModestAccountMgr *self, const gchar* name)
569 gchar *fullname, *email, *from;
571 g_return_val_if_fail (self, NULL);
572 g_return_val_if_fail (name, NULL);
574 fullname = modest_account_mgr_get_string (self, name,MODEST_ACCOUNT_FULLNAME,
576 email = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_EMAIL,
578 from = g_strdup_printf ("%s <%s>",
579 fullname ? fullname : "",
587 /* Add a number to the end of the text, or increment a number that is already there.
590 util_increment_name (const gchar* text)
592 /* Get the end character,
593 * also doing a UTF-8 validation which is required for using g_utf8_prev_char().
595 const gchar* end = NULL;
596 if (!g_utf8_validate (text, -1, &end))
602 --end; /* Go to before the null-termination. */
604 /* Look at each UTF-8 characer, starting at the end: */
605 const gchar* p = end;
606 const gchar* alpha_end = NULL;
609 /* Stop when we reach the first character that is not a numeric digit: */
610 const gunichar ch = g_utf8_get_char (p);
611 if (!g_unichar_isdigit (ch)) {
616 p = g_utf8_prev_char (p);
620 /* The text must consist completely of numeric digits. */
626 /* Intepret and increment the number, if any: */
627 gint num = atol (alpha_end);
630 /* Get the name part: */
631 gint name_len = alpha_end - text;
632 gchar *name_without_number = g_malloc(name_len + 1);
633 memcpy (name_without_number, text, name_len);
634 name_without_number[name_len] = 0;\
636 /* Concatenate the text part and the new number: */
637 gchar *result = g_strdup_printf("%s%d", name_without_number, num);
638 g_free (name_without_number);
644 modest_account_mgr_get_unused_account_name (ModestAccountMgr *self, const gchar* starting_name,
645 gboolean server_account)
647 gchar *account_name = g_strdup (starting_name);
649 while (modest_account_mgr_account_exists (self,
650 account_name, server_account /* server_account */)) {
652 gchar * account_name2 = util_increment_name (account_name);
653 g_free (account_name);
654 account_name = account_name2;
661 modest_account_mgr_get_unused_account_display_name (ModestAccountMgr *self, const gchar* starting_name)
663 gchar *account_name = g_strdup (starting_name);
665 while (modest_account_mgr_account_with_display_name_exists (self, account_name)) {
667 gchar * account_name2 = util_increment_name (account_name);
668 g_free (account_name);
669 account_name = account_name2;