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-tny-platform-factory.h>
31 #include <modest-tny-account.h>
32 #include <modest-tny-account-store.h>
33 #include <modest-runtime.h>
34 #include <tny-simple-list.h>
35 #include <modest-tny-folder.h>
36 #include <modest-tny-outbox-account.h>
37 #include <modest-account-mgr-helpers.h>
38 #include <modest-init.h>
39 #include <tny-camel-transport-account.h>
40 #include <tny-camel-imap-store-account.h>
41 #include <tny-camel-pop-store-account.h>
42 #include <tny-folder-stats.h>
46 modest_tny_account_get_special_folder (TnyAccount *account,
47 TnyFolderType special_type)
51 TnyFolder *special_folder = NULL;
54 g_return_val_if_fail (account, NULL);
55 g_return_val_if_fail (0 <= special_type && special_type < TNY_FOLDER_TYPE_NUM,
58 TnyAccount *local_account = NULL;
60 /* The accounts have already been instantiated by
61 * modest_tny_account_store_get_accounts(), which is the
62 * TnyAccountStore::get_accounts_func() implementation,
63 * so we just get them here.
66 /* Per-account outbox folders are each in their own on-disk directory: */
67 if (special_type == TNY_FOLDER_TYPE_OUTBOX) {
68 const gchar *modest_account_name =
69 modest_tny_account_get_parent_modest_account_name_for_server_account (account);
70 g_assert (modest_account_name);
72 gchar *account_id = g_strdup_printf (
73 MODEST_PER_ACCOUNT_LOCAL_OUTBOX_FOLDER_ACCOUNT_ID_PREFIX "%s",
76 local_account = modest_tny_account_store_get_tny_account_by_id (modest_runtime_get_account_store(),
80 /* Other local folders are all in one on-disk directory: */
81 local_account = modest_tny_account_store_get_tny_account_by_id (modest_runtime_get_account_store(),
82 MODEST_ACTUAL_LOCAL_FOLDERS_ACCOUNT_ID);
86 g_printerr ("modest: cannot get local account\n");
90 folders = TNY_LIST (tny_simple_list_new ());
92 /* There is no need to do this _async, as these are local folders. */
93 /* TODO: However, this seems to fail sometimes when the network is busy,
94 * returning an empty list. murrayc. */
95 tny_folder_store_get_folders (TNY_FOLDER_STORE (local_account),
97 iter = tny_list_create_iterator (folders);
99 while (!tny_iterator_is_done (iter)) {
101 TNY_FOLDER (tny_iterator_get_current (iter));
102 if (modest_tny_folder_get_local_folder_type (folder) == special_type) {
103 special_folder = folder;
107 g_object_unref (G_OBJECT(folder));
108 tny_iterator_next (iter);
111 g_object_unref (G_OBJECT (folders));
112 g_object_unref (G_OBJECT (iter));
113 g_object_unref (G_OBJECT (local_account));
115 return special_folder;
120 /* These seem to be listed in
121 * libtinymail-camel/camel-lite/camel/providers/imap/camel-imap-store.c
123 #define MODEST_ACCOUNT_OPTION_SSL "use_ssl"
124 #define MODEST_ACCOUNT_OPTION_SSL_NEVER "never"
125 #define MODEST_ACCOUNT_OPTION_SSL_ALWAYS "always"
126 #define MODEST_ACCOUNT_OPTION_SSL_WHEN_POSSIBLE "when-possible"
128 /* These seem to be listed in
129 * libtinymail-camel/camel-lite/camel/providers/imap/camel-imap-provider.c
131 #define MODEST_ACCOUNT_OPTION_USE_LSUB "use_lsub" /* Show only subscribed folders */
132 #define MODEST_ACCOUNT_OPTION_CHECK_ALL "check_all" /* Check for new messages in all folders */
135 /* Posssible values for tny_account_set_secure_auth_mech().
136 * These might be camel-specific.
137 * Really, tinymail should use an enum.
138 * camel_sasl_authtype() seems to list some possible values.
141 /* Note that evolution does not offer these for IMAP: */
142 #define MODEST_ACCOUNT_AUTH_PLAIN "PLAIN"
143 #define MODEST_ACCOUNT_AUTH_ANONYMOUS "ANONYMOUS"
145 /* Caeml's IMAP uses NULL instead for "Password".
146 * Also, not that Evolution offers "Password" for IMAP, but "Login" for SMTP.*/
147 #define MODEST_ACCOUNT_AUTH_PASSWORD "LOGIN"
148 #define MODEST_ACCOUNT_AUTH_CRAMMD5 "CRAM-MD5"
153 * modest_tny_account_new_from_server_account:
154 * @account_mgr: a valid account mgr instance
155 * @account_name: the server account name for which to create a corresponding tny account
156 * @type: the type of account to create (TNY_ACCOUNT_TYPE_STORE or TNY_ACCOUNT_TYPE_TRANSPORT)
158 * get a tnyaccount corresponding to the server_accounts (store or transport) for this account.
159 * NOTE: this function does not set the camel session or the get/forget password functions
161 * Returns: a new TnyAccount or NULL in case of error.
164 modest_tny_account_new_from_server_account (ModestAccountMgr *account_mgr,
165 ModestServerAccountData *account_data)
169 g_return_val_if_fail (account_mgr, NULL);
170 g_return_val_if_fail (account_data, NULL);
173 if (account_data->proto == MODEST_PROTOCOL_TRANSPORT_STORE_UNKNOWN) {
174 g_printerr ("modest: '%s' does not provide a protocol\n",
175 account_data->account_name);
179 TnyAccount *tny_account = NULL;
181 switch (account_data->proto) {
182 case MODEST_PROTOCOL_TRANSPORT_SENDMAIL:
183 case MODEST_PROTOCOL_TRANSPORT_SMTP:
184 tny_account = TNY_ACCOUNT(tny_camel_transport_account_new ()); break;
185 case MODEST_PROTOCOL_STORE_POP:
186 tny_account = TNY_ACCOUNT(tny_camel_pop_store_account_new ()); break;
187 case MODEST_PROTOCOL_STORE_IMAP:
188 tny_account = TNY_ACCOUNT(tny_camel_imap_store_account_new ()); break;
189 case MODEST_PROTOCOL_STORE_MAILDIR:
190 case MODEST_PROTOCOL_STORE_MBOX:
191 /* Note that this is not where we create the special local folders account.
192 * That happens in modest_tny_account_new_for_local_folders() instead.
194 tny_account = TNY_ACCOUNT(tny_camel_store_account_new()); break;
196 g_return_val_if_reached (NULL);
199 g_printerr ("modest: could not create tny account for '%s'\n",
200 account_data->account_name);
203 tny_account_set_id (tny_account, account_data->account_name);
206 const gchar* proto_name =
207 modest_protocol_info_get_transport_store_protocol_name(account_data->proto);
208 tny_account_set_proto (tny_account, proto_name);
211 /* mbox and maildir accounts use a URI instead of the rest:
212 * Note that this is not where we create the special local folders account.
213 * We do that in modest_tny_account_new_for_local_folders() instead. */
214 if (account_data->uri) {
215 tny_account_set_url_string (TNY_ACCOUNT(tny_account), account_data->uri);
216 /* g_message ("DEBUG: %s: local account-url:\n %s", __FUNCTION__, account_data->uri); */
219 /* Set camel-specific options: */
221 /* Enable secure connection settings: */
222 /* printf("DEBUG: %s: security=%d\n", __FUNCTION__, account_data->security); */
223 const gchar* option_security = NULL;
224 switch (account_data->security) {
225 case MODEST_PROTOCOL_CONNECTION_NORMAL:
226 option_security = MODEST_ACCOUNT_OPTION_SSL "=" MODEST_ACCOUNT_OPTION_SSL_NEVER;
228 case MODEST_PROTOCOL_CONNECTION_SSL:
229 case MODEST_PROTOCOL_CONNECTION_TLS:
230 option_security = MODEST_ACCOUNT_OPTION_SSL "=" MODEST_ACCOUNT_OPTION_SSL_ALWAYS;;
232 case MODEST_PROTOCOL_CONNECTION_TLS_OP:
233 option_security = MODEST_ACCOUNT_OPTION_SSL "=" MODEST_ACCOUNT_OPTION_SSL_WHEN_POSSIBLE;
240 tny_camel_account_add_option (TNY_CAMEL_ACCOUNT (tny_account),
243 /* Secure authentication: */
244 /* printf("DEBUG: %s: secure-auth=%d\n", __FUNCTION__, account_data->secure_auth); */
245 const gchar* auth_mech_name = NULL;
246 switch (account_data->secure_auth) {
247 case MODEST_PROTOCOL_AUTH_NONE:
248 /* IMAP and POP need at least a password,
249 * which camel uses if we specify NULL.
250 * This setting should never happen anyway. */
251 if (account_data->proto == MODEST_PROTOCOL_STORE_IMAP ||
252 account_data->proto == MODEST_PROTOCOL_STORE_POP)
253 auth_mech_name = NULL;
254 else if (account_data->proto == MODEST_PROTOCOL_TRANSPORT_SMTP)
255 auth_mech_name = MODEST_ACCOUNT_AUTH_ANONYMOUS;
257 auth_mech_name = MODEST_ACCOUNT_AUTH_PLAIN;
260 case MODEST_PROTOCOL_AUTH_PASSWORD:
261 /* Camel use a password for IMAP or POP if we specify NULL,
262 * For IMAP, at least it will report an error if we use "Password", "Login" or "Plain".
263 * (POP is know to report an error for Login too. Probably Password and Plain too.) */
264 if (account_data->proto == MODEST_PROTOCOL_STORE_IMAP)
265 auth_mech_name = NULL;
266 else if (account_data->proto == MODEST_PROTOCOL_STORE_POP)
267 auth_mech_name = NULL;
269 auth_mech_name = MODEST_ACCOUNT_AUTH_PASSWORD;
272 case MODEST_PROTOCOL_AUTH_CRAMMD5:
273 auth_mech_name = MODEST_ACCOUNT_AUTH_CRAMMD5;
277 g_warning ("%s: Unhandled secure authentication setting %d for "
278 "account=%s (%s)", __FUNCTION__, account_data->secure_auth,
279 account_data->account_name, account_data->hostname);
284 tny_account_set_secure_auth_mech (tny_account, auth_mech_name);
286 if (modest_protocol_info_protocol_is_store(account_data->proto) &&
287 (account_data->proto == MODEST_PROTOCOL_STORE_IMAP) ) {
288 /* Other connection options, needed for IMAP. */
289 tny_camel_account_add_option (TNY_CAMEL_ACCOUNT (tny_account),
290 MODEST_ACCOUNT_OPTION_USE_LSUB);
291 tny_camel_account_add_option (TNY_CAMEL_ACCOUNT (tny_account),
292 MODEST_ACCOUNT_OPTION_CHECK_ALL);
295 if (account_data->username)
296 tny_account_set_user (tny_account, account_data->username);
297 if (account_data->hostname)
298 tny_account_set_hostname (tny_account, account_data->hostname);
301 if (account_data->port)
302 tny_account_set_port (tny_account, account_data->port);
305 /* FIXME: for debugging */
306 url = tny_account_get_url_string (TNY_ACCOUNT(tny_account));
307 /* g_message ("modest: %s:\n account-url: %s", __FUNCTION__, url); */
309 /***********************/
315 modest_tny_account_new_from_server_account_name (ModestAccountMgr *account_mgr,
316 const gchar *server_account_name)
318 ModestServerAccountData *account_data =
319 modest_account_mgr_get_server_account_data (account_mgr,
320 server_account_name);
324 TnyAccount *result = modest_tny_account_new_from_server_account (
325 account_mgr, account_data);
327 modest_account_mgr_free_server_account_data (account_mgr, account_data);
333 /* we need these dummy functions, or tinymail will complain */
335 get_pass_dummy (TnyAccount *account, const gchar *prompt, gboolean *cancel)
340 forget_pass_dummy (TnyAccount *account)
342 /* intentionally left blank */
346 modest_tny_account_new_from_account (ModestAccountMgr *account_mgr, const gchar *account_name,
348 TnySessionCamel *session,
349 TnyGetPassFunc get_pass_func,
350 TnyForgetPassFunc forget_pass_func)
352 TnyAccount *tny_account = NULL;
353 ModestAccountData *account_data = NULL;
354 ModestServerAccountData *server_data = NULL;
356 g_return_val_if_fail (account_mgr, NULL);
357 g_return_val_if_fail (account_name, NULL);
359 account_data = modest_account_mgr_get_account_data (account_mgr, account_name);
361 g_printerr ("modest: %s: cannot get account data for account %s\n", __FUNCTION__, account_name);
365 if (type == TNY_ACCOUNT_TYPE_STORE && account_data->store_account)
366 server_data = account_data->store_account;
367 else if (type == TNY_ACCOUNT_TYPE_TRANSPORT && account_data->transport_account)
368 server_data = account_data->transport_account;
370 g_printerr ("modest: no %s account defined for '%s'\n",
371 type == TNY_ACCOUNT_TYPE_STORE ? "store" : "transport",
372 account_data->display_name);
373 modest_account_mgr_free_account_data (account_mgr, account_data);
377 tny_account = modest_tny_account_new_from_server_account (account_mgr, server_data);
379 g_printerr ("modest: failed to create tny account for %s (%s)\n",
380 account_data->account_name, server_data->account_name);
381 modest_account_mgr_free_account_data (account_mgr, account_data);
385 tny_camel_account_set_session (TNY_CAMEL_ACCOUNT(tny_account), session);
386 tny_account_set_forget_pass_func (tny_account,
387 forget_pass_func ? forget_pass_func : forget_pass_dummy);
388 tny_account_set_pass_func (tny_account,
389 get_pass_func ? get_pass_func: get_pass_dummy);
391 /* This name is what shows up in the folder view -- so for some POP/IMAP/... server
392 * account, we set its name to the account of which it is part. */
393 if (account_data->display_name)
394 tny_account_set_name (tny_account, account_data->display_name);
396 modest_tny_account_set_parent_modest_account_name_for_server_account (tny_account, account_name);
398 modest_account_mgr_free_account_data (account_mgr, account_data);
405 modest_tny_account_new_for_local_folders (ModestAccountMgr *account_mgr, TnySessionCamel *session)
407 TnyStoreAccount *tny_account;
409 gchar *maildir, *url_string;
411 g_return_val_if_fail (account_mgr, NULL);
413 tny_account = tny_camel_store_account_new ();
415 g_printerr ("modest: cannot create account for local folders");
418 tny_camel_account_set_session (TNY_CAMEL_ACCOUNT(tny_account), session);
420 /* This path contains directories for each local folder.
421 * We have created them so that TnyCamelStoreAccount can find them
422 * and report a folder for each directory: */
423 maildir = modest_local_folder_info_get_maildir_path ();
424 url = camel_url_new ("maildir:", NULL);
425 camel_url_set_path (url, maildir);
426 /* Needed by tinymail's DBC assertions */
427 camel_url_set_host (url, "localhost");
428 url_string = camel_url_to_string (url, 0);
430 tny_account_set_url_string (TNY_ACCOUNT(tny_account), url_string);
431 printf("DEBUG: %s:\n url=%s\n", __FUNCTION__, url_string);
433 tny_account_set_name (TNY_ACCOUNT(tny_account), MODEST_LOCAL_FOLDERS_DEFAULT_DISPLAY_NAME);
434 tny_account_set_id (TNY_ACCOUNT(tny_account), MODEST_ACTUAL_LOCAL_FOLDERS_ACCOUNT_ID);
435 tny_account_set_forget_pass_func (TNY_ACCOUNT(tny_account), forget_pass_dummy);
436 tny_account_set_pass_func (TNY_ACCOUNT(tny_account), get_pass_dummy);
438 modest_tny_account_set_parent_modest_account_name_for_server_account (
439 TNY_ACCOUNT (tny_account), MODEST_ACTUAL_LOCAL_FOLDERS_ACCOUNT_ID);
441 camel_url_free (url);
445 return TNY_ACCOUNT(tny_account);
450 modest_tny_account_new_for_per_account_local_outbox_folder (ModestAccountMgr *account_mgr, const gchar* account_name, TnySessionCamel *session)
452 g_return_val_if_fail (account_mgr, NULL);
453 g_return_val_if_fail (account_name, NULL);
455 /* Notice that we create a ModestTnyOutboxAccount here,
456 * instead of just a TnyCamelStoreAccount,
457 * so that we can later identify this as a special account for internal use only.
459 TnyStoreAccount *tny_account = TNY_STORE_ACCOUNT (modest_tny_outbox_account_new ());
461 g_printerr ("modest: cannot create account for per-account local outbox folder.");
465 tny_camel_account_set_session (TNY_CAMEL_ACCOUNT(tny_account), session);
467 /* Make sure that the paths exists on-disk so that TnyCamelStoreAccount can
468 * find it to create a TnyFolder for it: */
469 gchar *folder_dir = modest_per_account_local_outbox_folder_info_get_maildir_path_to_outbox_folder (account_name);
470 modest_init_one_local_folder(folder_dir);
474 /* This path should contain just one directory - "outbox": */
476 modest_per_account_local_outbox_folder_info_get_maildir_path (account_name);
478 CamelURL *url = camel_url_new ("maildir:", NULL);
479 camel_url_set_path (url, maildir);
482 /* Needed by tinymail's DBC assertions */
483 camel_url_set_host (url, "localhost");
484 gchar *url_string = camel_url_to_string (url, 0);
485 camel_url_free (url);
487 tny_account_set_url_string (TNY_ACCOUNT(tny_account), url_string);
488 printf("DEBUG: %s:\n url=%s\n", __FUNCTION__, url_string);
491 /* This text should never been seen,
492 * because the per-account outbox accounts are not seen directly by the user.
493 * Their folders are merged and shown as one folder. */
494 tny_account_set_name (TNY_ACCOUNT(tny_account), "Per-Account Outbox");
496 gchar *account_id = g_strdup_printf (
497 MODEST_PER_ACCOUNT_LOCAL_OUTBOX_FOLDER_ACCOUNT_ID_PREFIX "%s",
499 tny_account_set_id (TNY_ACCOUNT(tny_account), account_id);
502 tny_account_set_forget_pass_func (TNY_ACCOUNT(tny_account), forget_pass_dummy);
503 tny_account_set_pass_func (TNY_ACCOUNT(tny_account), get_pass_dummy);
505 /* Make this think that it belongs to the modest local-folders parent account: */
506 modest_tny_account_set_parent_modest_account_name_for_server_account (
507 TNY_ACCOUNT (tny_account), MODEST_ACTUAL_LOCAL_FOLDERS_ACCOUNT_ID);
509 return TNY_ACCOUNT(tny_account);
514 typedef gint (*TnyStatsFunc) (TnyFolderStats *stats);
516 typedef struct _RecurseFoldersHelper {
517 TnyStatsFunc function;
520 } RecurseFoldersHelper;
523 recurse_folders (TnyFolderStore *store,
524 TnyFolderStoreQuery *query,
525 RecurseFoldersHelper *helper)
528 TnyList *folders = tny_simple_list_new ();
530 tny_folder_store_get_folders (store, folders, query, NULL);
531 iter = tny_list_create_iterator (folders);
533 helper->folders += tny_list_get_length (folders);
535 while (!tny_iterator_is_done (iter)) {
536 TnyFolderStats *stats;
539 folder = TNY_FOLDER (tny_iterator_get_current (iter));
540 stats = tny_folder_get_stats (folder);
542 /* initially, we sometimes get -1 from tinymail; ignore that */
543 if (helper->function && helper->function (stats) > 0)
544 helper->sum += helper->function (stats);
546 if (TNY_IS_FOLDER_STORE (folder)) {
547 recurse_folders (TNY_FOLDER_STORE (folder), query, helper);
550 g_object_unref (folder);
551 g_object_unref (stats);
552 tny_iterator_next (iter);
554 g_object_unref (G_OBJECT (iter));
555 g_object_unref (G_OBJECT (folders));
559 modest_tny_folder_store_get_folder_count (TnyFolderStore *self)
561 RecurseFoldersHelper *helper;
564 g_return_val_if_fail (TNY_IS_FOLDER_STORE (self), -1);
567 helper = g_malloc0 (sizeof (RecurseFoldersHelper));
568 helper->function = NULL;
572 recurse_folders (self, NULL, helper);
574 retval = helper->folders;
582 modest_tny_folder_store_get_message_count (TnyFolderStore *self)
584 RecurseFoldersHelper *helper;
587 g_return_val_if_fail (TNY_IS_FOLDER_STORE (self), -1);
590 helper = g_malloc0 (sizeof (RecurseFoldersHelper));
591 helper->function = (TnyStatsFunc) tny_folder_stats_get_all_count;
594 recurse_folders (self, NULL, helper);
596 retval = helper->sum;
604 modest_tny_folder_store_get_local_size (TnyFolderStore *self)
606 RecurseFoldersHelper *helper;
609 g_return_val_if_fail (TNY_IS_FOLDER_STORE (self), -1);
612 helper = g_malloc0 (sizeof (RecurseFoldersHelper));
613 helper->function = (TnyStatsFunc) tny_folder_stats_get_local_size;
616 recurse_folders (self, NULL, helper);
618 retval = helper->sum;
625 const gchar* modest_tny_account_get_parent_modest_account_name_for_server_account (TnyAccount *self)
627 return (const gchar *)g_object_get_data (G_OBJECT (self), "modest_account");
630 void modest_tny_account_set_parent_modest_account_name_for_server_account (TnyAccount *self, const gchar* parent_modest_acount_name)
632 g_object_set_data_full (G_OBJECT(self), "modest_account",
633 (gpointer*) g_strdup (parent_modest_acount_name), g_free);