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 gchar *account_id = g_strdup_printf (
69 MODEST_PER_ACCOUNT_LOCAL_OUTBOX_FOLDER_ACCOUNT_ID_PREFIX "%s",
70 tny_account_get_id (account));
72 local_account = modest_tny_account_store_get_tny_account_by_id (modest_runtime_get_account_store(),
76 /* Other local folders are all in one on-disk directory: */
77 local_account = modest_tny_account_store_get_tny_account_by_id (modest_runtime_get_account_store(),
78 MODEST_ACTUAL_LOCAL_FOLDERS_ACCOUNT_ID);
82 g_printerr ("modest: cannot get local account\n");
86 folders = TNY_LIST (tny_simple_list_new ());
88 /* There is no need to do this _async, as these are local folders. */
89 /* TODO: However, this seems to fail sometimes when the network is busy,
90 * returning an empty list. murrayc. */
91 tny_folder_store_get_folders (TNY_FOLDER_STORE (local_account),
93 iter = tny_list_create_iterator (folders);
95 while (!tny_iterator_is_done (iter)) {
97 TNY_FOLDER (tny_iterator_get_current (iter));
98 if (modest_tny_folder_get_local_folder_type (folder) == special_type) {
99 special_folder = folder;
103 g_object_unref (G_OBJECT(folder));
104 tny_iterator_next (iter);
107 g_object_unref (G_OBJECT (folders));
108 g_object_unref (G_OBJECT (iter));
109 g_object_unref (G_OBJECT (local_account));
111 return special_folder;
116 /* These seem to be listed in
117 * libtinymail-camel/camel-lite/camel/providers/imap/camel-imap-store.c
119 #define MODEST_ACCOUNT_OPTION_SSL "use_ssl"
120 #define MODEST_ACCOUNT_OPTION_SSL_NEVER "never"
121 #define MODEST_ACCOUNT_OPTION_SSL_ALWAYS "always"
122 #define MODEST_ACCOUNT_OPTION_SSL_WHEN_POSSIBLE "when-possible"
124 /* These seem to be listed in
125 * libtinymail-camel/camel-lite/camel/providers/imap/camel-imap-provider.c
127 #define MODEST_ACCOUNT_OPTION_USE_LSUB "use_lsub" /* Show only subscribed folders */
128 #define MODEST_ACCOUNT_OPTION_CHECK_ALL "check_all" /* Check for new messages in all folders */
131 /* Posssible values for tny_account_set_secure_auth_mech().
132 * These might be camel-specific.
133 * Really, tinymail should use an enum.
134 * camel_sasl_authtype() seems to list some possible values.
137 /* Note that evolution does not offer these for IMAP: */
138 #define MODEST_ACCOUNT_AUTH_PLAIN "PLAIN"
139 #define MODEST_ACCOUNT_AUTH_ANONYMOUS "ANONYMOUS"
141 /* Caeml's IMAP uses NULL instead for "Password".
142 * Also, not that Evolution offers "Password" for IMAP, but "Login" for SMTP.*/
143 #define MODEST_ACCOUNT_AUTH_PASSWORD "LOGIN"
144 #define MODEST_ACCOUNT_AUTH_CRAMMD5 "CRAM-MD5"
148 * modest_tny_account_new_from_server_account:
149 * @account_mgr: a valid account mgr instance
150 * @account_name: the server account name for which to create a corresponding tny account
151 * @type: the type of account to create (TNY_ACCOUNT_TYPE_STORE or TNY_ACCOUNT_TYPE_TRANSPORT)
153 * get a tnyaccount corresponding to the server_accounts (store or transport) for this account.
154 * NOTE: this function does not set the camel session or the get/forget password functions
156 * Returns: a new TnyAccount or NULL in case of error.
159 modest_tny_account_new_from_server_account (ModestAccountMgr *account_mgr,
160 ModestServerAccountData *account_data)
164 g_return_val_if_fail (account_mgr, NULL);
165 g_return_val_if_fail (account_data, NULL);
168 if (account_data->proto == MODEST_PROTOCOL_TRANSPORT_STORE_UNKNOWN) {
169 g_printerr ("modest: '%s' does not provide a protocol\n",
170 account_data->account_name);
174 TnyAccount *tny_account = NULL;
176 switch (account_data->proto) {
177 case MODEST_PROTOCOL_TRANSPORT_SENDMAIL:
178 case MODEST_PROTOCOL_TRANSPORT_SMTP:
179 tny_account = TNY_ACCOUNT(tny_camel_transport_account_new ()); break;
180 case MODEST_PROTOCOL_STORE_POP:
181 tny_account = TNY_ACCOUNT(tny_camel_pop_store_account_new ()); break;
182 case MODEST_PROTOCOL_STORE_IMAP:
183 tny_account = TNY_ACCOUNT(tny_camel_imap_store_account_new ()); break;
184 case MODEST_PROTOCOL_STORE_MAILDIR:
185 case MODEST_PROTOCOL_STORE_MBOX:
186 /* Note that this is not where we create the special local folders account.
187 * That happens in modest_tny_account_new_for_local_folders() instead.
189 tny_account = TNY_ACCOUNT(tny_camel_store_account_new()); break;
191 g_return_val_if_reached (NULL);
194 g_printerr ("modest: could not create tny account for '%s'\n",
195 account_data->account_name);
198 tny_account_set_id (tny_account, account_data->account_name);
201 const gchar* proto_name =
202 modest_protocol_info_get_transport_store_protocol_name(account_data->proto);
203 tny_account_set_proto (tny_account, proto_name);
206 /* mbox and maildir accounts use a URI instead of the rest:
207 * Note that this is not where we create the special local folders account.
208 * We do that in modest_tny_account_new_for_local_folders() instead. */
209 if (account_data->uri) {
210 /* printf("DEBUG: %s: Using URI=%s\n", __FUNCTION__, account_data->uri); */
211 tny_account_set_url_string (TNY_ACCOUNT(tny_account), account_data->uri);
212 g_message ("%s: local account-url: %s", __FUNCTION__, account_data->uri);
215 /* Set camel-specific options: */
217 /* Enable secure connection settings: */
218 /* printf("DEBUG: %s: security=%d\n", __FUNCTION__, account_data->security); */
219 const gchar* option_security = NULL;
220 switch (account_data->security) {
221 case MODEST_PROTOCOL_CONNECTION_NORMAL:
222 option_security = MODEST_ACCOUNT_OPTION_SSL "=" MODEST_ACCOUNT_OPTION_SSL_NEVER;
224 case MODEST_PROTOCOL_CONNECTION_SSL:
225 case MODEST_PROTOCOL_CONNECTION_TLS:
226 option_security = MODEST_ACCOUNT_OPTION_SSL "=" MODEST_ACCOUNT_OPTION_SSL_ALWAYS;;
228 case MODEST_PROTOCOL_CONNECTION_TLS_OP:
229 option_security = MODEST_ACCOUNT_OPTION_SSL "=" MODEST_ACCOUNT_OPTION_SSL_WHEN_POSSIBLE;
236 tny_camel_account_add_option (TNY_CAMEL_ACCOUNT (tny_account),
239 /* Secure authentication: */
240 /* printf("DEBUG: %s: secure-auth=%d\n", __FUNCTION__, account_data->secure_auth); */
241 const gchar* auth_mech_name = NULL;
242 switch (account_data->secure_auth) {
243 case MODEST_PROTOCOL_AUTH_NONE:
244 /* IMAP and POP need at least a password,
245 * which camel uses if we specify NULL.
246 * This setting should never happen anyway. */
247 if (account_data->proto == MODEST_PROTOCOL_STORE_IMAP ||
248 account_data->proto == MODEST_PROTOCOL_STORE_POP)
249 auth_mech_name = NULL;
250 else if (account_data->proto == MODEST_PROTOCOL_TRANSPORT_SMTP)
251 auth_mech_name = MODEST_ACCOUNT_AUTH_ANONYMOUS;
253 auth_mech_name = MODEST_ACCOUNT_AUTH_PLAIN;
256 case MODEST_PROTOCOL_AUTH_PASSWORD:
257 /* Camel use a password for IMAP or POP if we specify NULL,
258 * For IMAP, at least it will report an error if we use "Password", "Login" or "Plain".
259 * (POP is know to report an error for Login too. Probably Password and Plain too.) */
260 if (account_data->proto == MODEST_PROTOCOL_STORE_IMAP)
261 auth_mech_name = NULL;
262 else if (account_data->proto == MODEST_PROTOCOL_STORE_POP)
263 auth_mech_name = NULL;
265 auth_mech_name = MODEST_ACCOUNT_AUTH_PASSWORD;
268 case MODEST_PROTOCOL_AUTH_CRAMMD5:
269 auth_mech_name = MODEST_ACCOUNT_AUTH_CRAMMD5;
273 g_warning ("%s: Unhandled secure authentication setting %d for "
274 "account=%s (%s)", __FUNCTION__, account_data->secure_auth,
275 account_data->account_name, account_data->hostname);
280 tny_account_set_secure_auth_mech (tny_account, auth_mech_name);
282 if (modest_protocol_info_protocol_is_store(account_data->proto) &&
283 (account_data->proto == MODEST_PROTOCOL_STORE_IMAP) ) {
284 /* Other connection options, needed for IMAP. */
285 tny_camel_account_add_option (TNY_CAMEL_ACCOUNT (tny_account),
286 MODEST_ACCOUNT_OPTION_USE_LSUB);
287 tny_camel_account_add_option (TNY_CAMEL_ACCOUNT (tny_account),
288 MODEST_ACCOUNT_OPTION_CHECK_ALL);
291 if (account_data->username)
292 tny_account_set_user (tny_account, account_data->username);
293 if (account_data->hostname)
294 tny_account_set_hostname (tny_account, account_data->hostname);
297 if (account_data->port)
298 tny_account_set_port (tny_account, account_data->port);
301 /* FIXME: for debugging */
302 url = tny_account_get_url_string (TNY_ACCOUNT(tny_account));
303 g_message ("modest: account-url: %s", url);
305 /***********************/
311 /* we need these dummy functions, or tinymail will complain */
313 get_pass_dummy (TnyAccount *account, const gchar *prompt, gboolean *cancel)
318 forget_pass_dummy (TnyAccount *account)
320 /* intentionally left blank */
324 modest_tny_account_new_from_account (ModestAccountMgr *account_mgr, const gchar *account_name,
326 TnySessionCamel *session,
327 TnyGetPassFunc get_pass_func,
328 TnyForgetPassFunc forget_pass_func)
330 TnyAccount *tny_account = NULL;
331 ModestAccountData *account_data = NULL;
332 ModestServerAccountData *server_data = NULL;
334 g_return_val_if_fail (account_mgr, NULL);
335 g_return_val_if_fail (account_name, NULL);
337 account_data = modest_account_mgr_get_account_data (account_mgr, account_name);
339 g_printerr ("modest: cannot get account data for account %s\n", account_name);
343 if (type == TNY_ACCOUNT_TYPE_STORE && account_data->store_account)
344 server_data = account_data->store_account;
345 else if (type == TNY_ACCOUNT_TYPE_TRANSPORT && account_data->transport_account)
346 server_data = account_data->transport_account;
348 g_printerr ("modest: no %s account defined for '%s'\n",
349 type == TNY_ACCOUNT_TYPE_STORE ? "store" : "transport",
350 account_data->display_name);
351 modest_account_mgr_free_account_data (account_mgr, account_data);
355 tny_account = modest_tny_account_new_from_server_account (account_mgr, server_data);
357 g_printerr ("modest: failed to create tny account for %s (%s)\n",
358 account_data->account_name, server_data->account_name);
359 modest_account_mgr_free_account_data (account_mgr, account_data);
363 tny_camel_account_set_session (TNY_CAMEL_ACCOUNT(tny_account), session);
364 tny_account_set_forget_pass_func (tny_account,
365 forget_pass_func ? forget_pass_func : forget_pass_dummy);
366 tny_account_set_pass_func (tny_account,
367 get_pass_func ? get_pass_func: get_pass_dummy);
369 /* This name is what shows up in the folder view -- so for some POP/IMAP/... server
370 * account, we set its name to the account of which it is part. */
371 if (account_data->display_name)
372 tny_account_set_name (tny_account, account_data->display_name);
374 modest_tny_account_set_parent_modest_account_name_for_server_account (tny_account, account_name);
376 modest_account_mgr_free_account_data (account_mgr, account_data);
383 modest_tny_account_new_for_local_folders (ModestAccountMgr *account_mgr, TnySessionCamel *session)
385 TnyStoreAccount *tny_account;
387 gchar *maildir, *url_string;
389 g_return_val_if_fail (account_mgr, NULL);
391 tny_account = tny_camel_store_account_new ();
393 g_printerr ("modest: cannot create account for local folders");
396 tny_camel_account_set_session (TNY_CAMEL_ACCOUNT(tny_account), session);
398 /* This path contains directories for each local folder.
399 * We have created them so that TnyCamelStoreAccount can find them
400 * and report a folder for each directory: */
401 maildir = modest_local_folder_info_get_maildir_path ();
402 url = camel_url_new ("maildir:", NULL);
403 camel_url_set_path (url, maildir);
404 /* Needed by tinymail's DBC assertions */
405 camel_url_set_host (url, "localhost");
406 url_string = camel_url_to_string (url, 0);
408 tny_account_set_url_string (TNY_ACCOUNT(tny_account), url_string);
409 printf("DEBUG: %s: local folders url=%s\n", __FUNCTION__, url_string);
411 tny_account_set_name (TNY_ACCOUNT(tny_account), MODEST_LOCAL_FOLDERS_DEFAULT_DISPLAY_NAME);
412 tny_account_set_id (TNY_ACCOUNT(tny_account), MODEST_ACTUAL_LOCAL_FOLDERS_ACCOUNT_ID);
413 tny_account_set_forget_pass_func (TNY_ACCOUNT(tny_account), forget_pass_dummy);
414 tny_account_set_pass_func (TNY_ACCOUNT(tny_account), get_pass_dummy);
416 modest_tny_account_set_parent_modest_account_name_for_server_account (
417 TNY_ACCOUNT (tny_account), MODEST_ACTUAL_LOCAL_FOLDERS_ACCOUNT_ID);
419 camel_url_free (url);
423 return TNY_ACCOUNT(tny_account);
428 modest_tny_account_new_for_per_account_local_outbox_folder (ModestAccountMgr *account_mgr, TnyAccount *account, TnySessionCamel *session)
430 g_return_val_if_fail (account_mgr, NULL);
431 g_return_val_if_fail (account, NULL);
432 g_return_val_if_fail (tny_account_get_account_type (account) == TNY_ACCOUNT_TYPE_TRANSPORT, NULL);
434 /* Notice that we create a ModestTnyOutboxAccount here,
435 * instead of just a TnyCamelStoreAccount,
436 * so that we can later identify this as a special account for internal use only.
438 TnyStoreAccount *tny_account = TNY_STORE_ACCOUNT (modest_tny_outbox_account_new ());
440 g_printerr ("modest: cannot create account for per-account local outbox folder.");
444 tny_camel_account_set_session (TNY_CAMEL_ACCOUNT(tny_account), session);
446 /* Make sure that the paths exists on-disk so that TnyCamelStoreAccount can
447 * find it to create a TnyFolder for it: */
448 gchar *folder_dir = modest_per_account_local_outbox_folder_info_get_maildir_path_to_outbox_folder (account);
449 modest_init_one_local_folder(folder_dir);
453 /* This path should contain just one directory - "outbox": */
455 modest_per_account_local_outbox_folder_info_get_maildir_path (account);
457 CamelURL *url = camel_url_new ("maildir:", NULL);
458 camel_url_set_path (url, maildir);
461 /* Needed by tinymail's DBC assertions */
462 camel_url_set_host (url, "localhost");
463 gchar *url_string = camel_url_to_string (url, 0);
464 camel_url_free (url);
466 tny_account_set_url_string (TNY_ACCOUNT(tny_account), url_string);
467 printf("DEBUG: %s: local outbox folder account url=%s\n", __FUNCTION__, url_string);
470 /* This text should never been seen,
471 * because the per-account outbox accounts are not seen directly by the user.
472 * Their folders are merged and shown as one folder. */
473 tny_account_set_name (TNY_ACCOUNT(tny_account), "Per-Account Outbox");
475 gchar *account_id = g_strdup_printf (
476 MODEST_PER_ACCOUNT_LOCAL_OUTBOX_FOLDER_ACCOUNT_ID_PREFIX "%s",
477 tny_account_get_id (account));
478 tny_account_set_id (TNY_ACCOUNT(tny_account), account_id);
481 tny_account_set_forget_pass_func (TNY_ACCOUNT(tny_account), forget_pass_dummy);
482 tny_account_set_pass_func (TNY_ACCOUNT(tny_account), get_pass_dummy);
484 /* Make this think that it belongs to the modest local-folders parent account: */
485 modest_tny_account_set_parent_modest_account_name_for_server_account (
486 TNY_ACCOUNT (tny_account), MODEST_ACTUAL_LOCAL_FOLDERS_ACCOUNT_ID);
488 return TNY_ACCOUNT(tny_account);
493 typedef gint (*TnyStatsFunc) (TnyFolderStats *stats);
495 typedef struct _RecurseFoldersHelper {
496 TnyStatsFunc function;
499 } RecurseFoldersHelper;
502 recurse_folders (TnyFolderStore *store,
503 TnyFolderStoreQuery *query,
504 RecurseFoldersHelper *helper)
507 TnyList *folders = tny_simple_list_new ();
509 tny_folder_store_get_folders (store, folders, query, NULL);
510 iter = tny_list_create_iterator (folders);
512 helper->folders += tny_list_get_length (folders);
514 while (!tny_iterator_is_done (iter)) {
515 TnyFolderStats *stats;
518 folder = TNY_FOLDER (tny_iterator_get_current (iter));
519 stats = tny_folder_get_stats (folder);
521 /* initially, we sometimes get -1 from tinymail; ignore that */
522 if (helper->function && helper->function (stats) > 0)
523 helper->sum += helper->function (stats);
525 if (TNY_IS_FOLDER_STORE (folder)) {
526 recurse_folders (TNY_FOLDER_STORE (folder), query, helper);
529 g_object_unref (folder);
530 g_object_unref (stats);
531 tny_iterator_next (iter);
533 g_object_unref (G_OBJECT (iter));
534 g_object_unref (G_OBJECT (folders));
538 modest_tny_folder_store_get_folder_count (TnyFolderStore *self)
540 RecurseFoldersHelper *helper;
543 g_return_val_if_fail (TNY_IS_FOLDER_STORE (self), -1);
546 helper = g_malloc0 (sizeof (RecurseFoldersHelper));
547 helper->function = NULL;
551 recurse_folders (self, NULL, helper);
553 retval = helper->folders;
561 modest_tny_folder_store_get_message_count (TnyFolderStore *self)
563 RecurseFoldersHelper *helper;
566 g_return_val_if_fail (TNY_IS_FOLDER_STORE (self), -1);
569 helper = g_malloc0 (sizeof (RecurseFoldersHelper));
570 helper->function = (TnyStatsFunc) tny_folder_stats_get_all_count;
573 recurse_folders (self, NULL, helper);
575 retval = helper->sum;
583 modest_tny_folder_store_get_local_size (TnyFolderStore *self)
585 RecurseFoldersHelper *helper;
588 g_return_val_if_fail (TNY_IS_FOLDER_STORE (self), -1);
591 helper = g_malloc0 (sizeof (RecurseFoldersHelper));
592 helper->function = (TnyStatsFunc) tny_folder_stats_get_local_size;
595 recurse_folders (self, NULL, helper);
597 retval = helper->sum;
604 const gchar* modest_tny_account_get_parent_modest_account_name_for_server_account (TnyAccount *self)
606 return (const gchar *)g_object_get_data (G_OBJECT (self), "modest_account");
609 void modest_tny_account_set_parent_modest_account_name_for_server_account (TnyAccount *self, const gchar* parent_modest_acount_name)
611 g_object_set_data_full (G_OBJECT(self), "modest_account",
612 (gpointer*) g_strdup (parent_modest_acount_name), g_free);