* src/modest-text-utils.[ch]:
[modest] / src / modest-tny-account.c
1 /* Copyright (c) 2006, Nokia Corporation
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
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.
16  *
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.
28  */
29
30 #include <modest-platform.h>
31 #include <modest-tny-platform-factory.h>
32 #include <modest-tny-account.h>
33 #include <modest-tny-account-store.h>
34 #include <modest-tny-local-folders-account.h>
35 #include <modest-runtime.h>
36 #include <tny-simple-list.h>
37 #include <modest-tny-folder.h>
38 #include <modest-tny-outbox-account.h>
39 #include <modest-account-mgr-helpers.h>
40 #include <modest-init.h>
41 #include <tny-camel-transport-account.h>
42 #include <tny-camel-imap-store-account.h>
43 #include <tny-camel-pop-store-account.h>
44 #include <tny-folder-stats.h>
45 #include <string.h>
46 #ifdef MODEST_HAVE_HILDON0_WIDGETS
47 #include <hildon-widgets/hildon-file-system-info.h>
48 #else
49 #include <hildon/hildon-file-system-info.h>
50 #endif
51
52 TnyFolder *
53 modest_tny_account_get_special_folder (TnyAccount *account,
54                                        TnyFolderType special_type)
55 {
56         TnyList *folders;
57         TnyIterator *iter;
58         TnyFolder *special_folder = NULL;
59
60         
61         g_return_val_if_fail (account, NULL);
62         g_return_val_if_fail (0 <= special_type && special_type < TNY_FOLDER_TYPE_NUM,
63                               NULL);
64         
65         TnyAccount *local_account  = NULL;
66                 
67         /* The accounts have already been instantiated by 
68          * modest_tny_account_store_get_accounts(), which is the 
69          * TnyAccountStore::get_accounts_func() implementation,
70          * so we just get them here.
71          */
72          
73         /* Per-account outbox folders are each in their own on-disk directory: */
74         if (special_type == TNY_FOLDER_TYPE_OUTBOX) {
75                 const gchar *modest_account_name = 
76                         modest_tny_account_get_parent_modest_account_name_for_server_account (account);
77                 
78                 if (modest_account_name) {
79                         gchar *account_id = g_strdup_printf (
80                                 MODEST_PER_ACCOUNT_LOCAL_OUTBOX_FOLDER_ACCOUNT_ID_PREFIX "%s", 
81                                 modest_account_name);
82                         
83                         local_account = modest_tny_account_store_get_tny_account_by (modest_runtime_get_account_store(),
84                                                                                      MODEST_TNY_ACCOUNT_STORE_QUERY_ID,
85                                                                                      account_id);
86                         if (!local_account) {
87                                 g_printerr ("modest: %s: modest_tny_account_store_get_tny_account_by(ID) returned NULL for %s\n", __FUNCTION__, account_id);
88                         return NULL;
89                         }
90                 
91                         g_free (account_id);
92                 } else {
93                         g_warning ("%s: modest_account_name was NULL.", __FUNCTION__);
94                 }
95         } else {
96                 /* Other local folders are all in one on-disk directory: */
97                 local_account = modest_tny_account_store_get_tny_account_by (modest_runtime_get_account_store(),
98                                                                              MODEST_TNY_ACCOUNT_STORE_QUERY_ID,
99                                                                              MODEST_LOCAL_FOLDERS_ACCOUNT_ID);
100         }
101         
102         if (!local_account) {
103                 g_printerr ("modest: cannot get local account\n");
104                 return NULL;
105         }
106
107         folders = TNY_LIST (tny_simple_list_new ());
108
109         /* There is no need to do this _async, as these are local folders. */
110         /* TODO: However, this seems to fail sometimes when the network is busy, 
111          * returning an empty list. murrayc. */ 
112         GError *error = NULL;
113         tny_folder_store_get_folders (TNY_FOLDER_STORE (local_account),
114                                       folders, NULL, &error);
115         if (error) {
116                 g_warning ("%s: tny_folder_store_get_folders() failed:\n  error=%s\n", 
117                         __FUNCTION__, error->message);
118         }
119                                       
120         if (tny_list_get_length (folders) == 0) {
121                 gchar* url_string = tny_account_get_url_string (local_account);
122                 g_printerr ("modest: %s: tny_folder_store_get_folders() returned an empty list for account with URL '%s'\n", 
123                         __FUNCTION__, url_string);
124                 g_free (url_string);
125         }
126         
127         iter = tny_list_create_iterator (folders);
128
129         while (!tny_iterator_is_done (iter)) {
130                 TnyFolder *folder =
131                         TNY_FOLDER (tny_iterator_get_current (iter));
132                 if (folder) {
133                         if (modest_tny_folder_get_local_or_mmc_folder_type (folder) == special_type) {
134                                 special_folder = folder;
135                                 break; /* Leaving a ref for the special_folder return value. */
136                         }
137                 
138                         g_object_unref (G_OBJECT(folder));
139                 }
140
141                 tny_iterator_next (iter);
142         }
143         
144         g_object_unref (G_OBJECT (folders));
145         g_object_unref (G_OBJECT (iter));
146         g_object_unref (G_OBJECT (local_account));
147
148         /*
149         if (!special_folder) {
150                 g_warning ("%s: Returning NULL.", __FUNCTION__);        
151         }
152         */
153         
154         return special_folder;
155 }
156
157 static void
158 on_connection_status_changed (TnyAccount *account, TnyConnectionStatus status, gpointer user_data)
159 {
160         printf ("DEBUG: %s: status=%d\n", __FUNCTION__, status);
161         
162         if (status == TNY_CONNECTION_STATUS_DISCONNECTED) {
163                 /* A tinymail network operation failed, and tinymail then noticed that 
164                  * the account is offline, because our TnyDevice is offline,
165                  * because libconic says we are offline.
166                  * So ask the user to go online again.
167                  * 
168                  * Note that this signal will not be emitted if the account was offline 
169                  * when the network operation was first attempted. For those cases, 
170                  * the application must do its own explicit checks.
171                  *
172                  * We make sure that this UI is shown in the main thread, to avoid races,
173                  * because tinymail does not guarantee that this signal handler will be called 
174                  * in the main thread.
175                  */
176                 /* TODO: Commented out, because this causes hangs, probably related to 
177                  * our use of mainloops:
178                  * modest_platform_connect_and_wait (NULL);
179                  */
180         } else if (status == TNY_CONNECTION_STATUS_CONNECTED_BROKEN) {
181                 printf ("DEBUG: %s: Connection broken. Forcing TnyDevice offline.\n", 
182                         __FUNCTION__);
183                         
184                 /* Something went wrong during some network operation.
185                  * Stop trying to use the network now,
186                  * by forcing accounts into offline mode:
187                  * 
188                  * When libconic reconnects, it will set the device back online again,
189                  * regardless of it being forced offline before.
190                  */
191                 /* TODO: Find out when this is falsely being emitted. */
192                 printf ("  DEBUG: %s: Not forcing offline because tinymail is sometimes reporting false connection breaks.\n", 
193                         __FUNCTION__);
194                 /*
195                 TnyDevice *device = modest_runtime_get_device ();
196                 tny_device_force_offline (device);
197                 */
198         }
199 }
200
201
202
203 /**
204  * create_tny_account:
205  * @account_mgr: a valid account mgr instance
206  * @session: A valid TnySessionCamel instance.
207  * @account_data: the server account for which to create a corresponding tny account
208  * 
209  * get a tnyaccount corresponding to the server_accounts (store or transport) for this account.
210  * NOTE: this function does not set the camel session or the get/forget password functions
211  * 
212  * Returns: a new TnyAccount or NULL in case of error.
213  */
214 static TnyAccount*
215 create_tny_account (ModestAccountMgr *account_mgr,
216                     TnySessionCamel *session,
217                     ModestServerAccountData *account_data)
218 {
219         g_return_val_if_fail (account_mgr, NULL);
220         g_return_val_if_fail (session, NULL);
221         g_return_val_if_fail (account_data, NULL);
222
223         /* sanity checks */
224         if (account_data->proto == MODEST_PROTOCOL_TRANSPORT_STORE_UNKNOWN) {
225                 g_printerr ("modest: '%s' does not provide a protocol\n",
226                             account_data->account_name);
227                 return NULL;
228         }
229
230         TnyAccount *tny_account = NULL;
231         
232         switch (account_data->proto) {
233         case MODEST_PROTOCOL_TRANSPORT_SENDMAIL:
234         case MODEST_PROTOCOL_TRANSPORT_SMTP:
235                 tny_account = TNY_ACCOUNT(tny_camel_transport_account_new ()); break;
236         case MODEST_PROTOCOL_STORE_POP:
237                 tny_account = TNY_ACCOUNT(tny_camel_pop_store_account_new ()); break;
238         case MODEST_PROTOCOL_STORE_IMAP:
239                 tny_account = TNY_ACCOUNT(tny_camel_imap_store_account_new ()); break;
240         case MODEST_PROTOCOL_STORE_MAILDIR:
241         case MODEST_PROTOCOL_STORE_MBOX:
242                 /* Note that this is not where we create the special local folders account.
243                  * That happens in modest_tny_account_new_for_local_folders() instead.
244                  */
245                 tny_account = TNY_ACCOUNT(tny_camel_store_account_new()); break;
246         default:
247                 g_return_val_if_reached (NULL);
248         }
249         if (!tny_account) {
250                 g_printerr ("modest: could not create tny account for '%s'\n",
251                             account_data->account_name);
252                 return NULL;
253         }
254         tny_account_set_id (tny_account, account_data->account_name);
255
256         /* This must be set quite early, or other set() functions will fail. */
257         tny_camel_account_set_session (TNY_CAMEL_ACCOUNT (tny_account), session);
258     
259         /* Handle connection requests:
260          * This (badly-named) signal will be called when we try to use an offline account. */
261         g_signal_connect (G_OBJECT (tny_account), "connection-status-changed",
262                         G_CALLBACK (on_connection_status_changed), NULL);
263
264         /* Proto */
265         const gchar* proto_name =
266                 modest_protocol_info_get_transport_store_protocol_name(account_data->proto);
267         tny_account_set_proto (tny_account, proto_name);
268
269         return tny_account;
270 }
271
272
273
274 /* Camel options: */
275
276 /* These seem to be listed in 
277  * libtinymail-camel/camel-lite/camel/providers/imap/camel-imap-store.c 
278  */
279 #define MODEST_ACCOUNT_OPTION_SSL "use_ssl"
280 #define MODEST_ACCOUNT_OPTION_SSL_NEVER "never"
281 /* This is a tinymail camel-lite specific option, 
282  * roughly equivalent to "always" in regular camel,
283  * which is appropriate for a generic "SSL" connection option: */
284 #define MODEST_ACCOUNT_OPTION_SSL_WRAPPED "wrapped"
285 /* Not used in our UI so far: */
286 #define MODEST_ACCOUNT_OPTION_SSL_WHEN_POSSIBLE "when-possible"
287 /* This is a tinymailcamel-lite specific option that is not in regular camel. */
288 #define MODEST_ACCOUNT_OPTION_SSL_TLS "tls"
289
290 /* These seem to be listed in 
291  * libtinymail-camel/camel-lite/camel/providers/imap/camel-imap-provider.c 
292  */
293 #define MODEST_ACCOUNT_OPTION_USE_LSUB "use_lsub" /* Show only subscribed folders */
294 #define MODEST_ACCOUNT_OPTION_CHECK_ALL "check_all" /* Check for new messages in all folders */
295
296 /* Posssible values for tny_account_set_secure_auth_mech().
297  * These might be camel-specific.
298  * Really, tinymail should use an enum.
299  * camel_sasl_authtype() seems to list some possible values.
300  */
301  
302 /* Note that evolution does not offer these for IMAP: */
303 #define MODEST_ACCOUNT_AUTH_PLAIN "PLAIN"
304 #define MODEST_ACCOUNT_AUTH_ANONYMOUS "ANONYMOUS"
305
306 /* Caeml's IMAP uses NULL instead for "Password".
307  * Also, not that Evolution offers "Password" for IMAP, but "Login" for SMTP.*/
308 #define MODEST_ACCOUNT_AUTH_PASSWORD "LOGIN" 
309 #define MODEST_ACCOUNT_AUTH_CRAMMD5 "CRAM-MD5"
310
311                 
312 /**
313  * update_tny_account:
314  * @account_mgr: a valid account mgr instance
315  * @account_data: the server account for which to create a corresponding tny account
316  * 
317  * get a tnyaccount corresponding to the server_accounts (store or transport) for this account.
318  * NOTE: this function does not set the camel session or the get/forget password functions
319  * 
320  * Returns: a new TnyAccount or NULL in case of error.
321  */
322 static gboolean
323 update_tny_account (TnyAccount *tny_account, ModestAccountMgr *account_mgr,
324                     ModestServerAccountData *account_data)
325 {
326         gchar *url = NULL;
327         
328         g_return_val_if_fail (account_mgr, FALSE);
329         g_return_val_if_fail (account_data, FALSE);
330         g_return_val_if_fail (tny_account, FALSE);
331
332         tny_account_set_id (tny_account, account_data->account_name);
333                
334         /* mbox and maildir accounts use a URI instead of the rest:
335          * Note that this is not where we create the special local folders account.
336          * We do that in modest_tny_account_new_for_local_folders() instead. */
337         if (account_data->uri)  
338                 tny_account_set_url_string (TNY_ACCOUNT(tny_account), account_data->uri);
339         else {
340                 /* Set camel-specific options: */
341                 
342                 /* Enable secure connection settings: */
343                 const gchar* option_security = NULL;
344                 switch (account_data->security) {
345                 case MODEST_PROTOCOL_CONNECTION_NORMAL:
346                         option_security = MODEST_ACCOUNT_OPTION_SSL "=" MODEST_ACCOUNT_OPTION_SSL_NEVER;
347                         break;
348                 case MODEST_PROTOCOL_CONNECTION_SSL:
349                         /* Apparently, use of "IMAPS" (specified in our UI spec), implies 
350                          * use of the "wrapped" option: */
351                         option_security = MODEST_ACCOUNT_OPTION_SSL "=" MODEST_ACCOUNT_OPTION_SSL_WRAPPED;
352                         break;
353                 case MODEST_PROTOCOL_CONNECTION_TLS:
354                         option_security = MODEST_ACCOUNT_OPTION_SSL "=" MODEST_ACCOUNT_OPTION_SSL_TLS;
355                         break;
356                 case MODEST_PROTOCOL_CONNECTION_TLS_OP:
357                         /* This is not actually in our UI: */
358                         option_security = MODEST_ACCOUNT_OPTION_SSL "=" MODEST_ACCOUNT_OPTION_SSL_WHEN_POSSIBLE;
359                         break;
360                 default:
361                         break;
362                 }
363                 
364                 if(option_security)
365                         tny_camel_account_add_option (TNY_CAMEL_ACCOUNT (tny_account),
366                                                       option_security);
367                 
368                 /* Secure authentication: */
369
370                 const gchar* auth_mech_name = NULL;
371                 switch (account_data->secure_auth) {
372                 case MODEST_PROTOCOL_AUTH_NONE:
373                         /* IMAP and POP need at least a password,
374                          * which camel uses if we specify NULL.
375                          * This setting should never happen anyway. */
376                         if (account_data->proto == MODEST_PROTOCOL_STORE_IMAP ||
377                             account_data->proto == MODEST_PROTOCOL_STORE_POP)
378                                 auth_mech_name = NULL;
379                         else if (account_data->proto == MODEST_PROTOCOL_TRANSPORT_SMTP)
380                                 auth_mech_name = MODEST_ACCOUNT_AUTH_ANONYMOUS;
381                         else
382                                 auth_mech_name = MODEST_ACCOUNT_AUTH_PLAIN;
383                         break;
384                         
385                 case MODEST_PROTOCOL_AUTH_PASSWORD:
386                         /* Camel use a password for IMAP or POP if we specify NULL,
387                          * For IMAP, at least it will report an error if we use "Password", "Login" or "Plain".
388                          * (POP is know to report an error for Login too. Probably Password and Plain too.) */
389                         if (account_data->proto == MODEST_PROTOCOL_STORE_IMAP)
390                                 auth_mech_name = NULL;
391                         else if (account_data->proto == MODEST_PROTOCOL_STORE_POP)
392                                 auth_mech_name = NULL;
393                         else
394                                 auth_mech_name = MODEST_ACCOUNT_AUTH_PASSWORD;
395                         break;
396                         
397                 case MODEST_PROTOCOL_AUTH_CRAMMD5:
398                         auth_mech_name = MODEST_ACCOUNT_AUTH_CRAMMD5;
399                         break;
400                         
401                 default:
402                         g_warning ("%s: Unhandled secure authentication setting %d for "
403                                 "account=%s (%s)", __FUNCTION__, account_data->secure_auth,
404                                    account_data->account_name, account_data->hostname);
405                         break;
406                 }
407                 
408                 if(auth_mech_name) 
409                         tny_account_set_secure_auth_mech (tny_account, auth_mech_name);
410                 
411                 if (modest_protocol_info_protocol_is_store(account_data->proto) && 
412                         (account_data->proto == MODEST_PROTOCOL_STORE_IMAP) ) {
413                         /* Other connection options, needed for IMAP. */
414                         tny_camel_account_add_option (TNY_CAMEL_ACCOUNT (tny_account),
415                                                       MODEST_ACCOUNT_OPTION_USE_LSUB);
416                         tny_camel_account_add_option (TNY_CAMEL_ACCOUNT (tny_account),
417                                                       MODEST_ACCOUNT_OPTION_CHECK_ALL);
418                 }
419                 
420                 if (account_data->username) 
421                         tny_account_set_user (tny_account, account_data->username);
422                 if (account_data->hostname)
423                         tny_account_set_hostname (tny_account, account_data->hostname);
424                  
425                 /* Set the port: */
426                 if (account_data->port)
427                         tny_account_set_port (tny_account, account_data->port);
428         }
429
430         /* FIXME: for debugging. 
431          * Let's keep this because it is very useful for debugging. */
432         url = tny_account_get_url_string (TNY_ACCOUNT(tny_account));
433         g_debug ("%s:\n  account-url: %s\n", __FUNCTION__, url);
434
435         g_free (url);
436         return TRUE;
437 }
438
439 TnyAccount*
440 modest_tny_account_new_from_server_account_name (ModestAccountMgr *account_mgr,
441                                                  TnySessionCamel *session,
442                                                  const gchar *server_account_name)
443 {
444         ModestServerAccountData *account_data;
445         TnyAccount *tny_account;
446         
447         g_return_val_if_fail (session, NULL);
448         g_return_val_if_fail (server_account_name, NULL);
449
450         account_data =  modest_account_mgr_get_server_account_data (account_mgr, 
451                                                                     server_account_name);
452         if (!account_data)
453                 return NULL;
454
455         tny_account = create_tny_account (account_mgr, session, account_data);
456         if (!tny_account)
457                 g_warning ("%s: failed to create tny_account", __FUNCTION__);
458         else if (!update_tny_account (tny_account, account_mgr, account_data))
459                 g_warning ("%s: failed to initialize tny_account", __FUNCTION__);
460         
461         modest_account_mgr_free_server_account_data (account_mgr, account_data);
462         
463         return tny_account;
464 }
465
466
467
468 gboolean
469 modest_tny_account_update_from_server_account_name (TnyAccount *tny_account,
470                                                     ModestAccountMgr *account_mgr,
471                                                     const gchar *server_account_name)
472 {
473         ModestServerAccountData *account_data;
474         gboolean valid_account_type;
475         
476         g_return_val_if_fail (tny_account, FALSE);
477         g_return_val_if_fail (server_account_name, FALSE);
478         
479         account_data =  modest_account_mgr_get_server_account_data (account_mgr, 
480                                                                     server_account_name);
481         if (!account_data) {
482                 g_warning ("%s: failed to get server account data for %s",
483                            __FUNCTION__, server_account_name);
484                 return FALSE;
485         }
486
487         valid_account_type = FALSE;
488
489         /* you cannot change the protocol type of an existing account;
490          * so double check we don't even try
491          */
492         switch (account_data->proto) {
493         case MODEST_PROTOCOL_TRANSPORT_SENDMAIL:
494         case MODEST_PROTOCOL_TRANSPORT_SMTP:
495                 if (!TNY_IS_CAMEL_TRANSPORT_ACCOUNT(tny_account))
496                         g_warning ("%s: expecting transport account", __FUNCTION__);
497                 else
498                         valid_account_type = TRUE;
499                 break;
500         case MODEST_PROTOCOL_STORE_POP:
501                 if (!TNY_IS_CAMEL_POP_STORE_ACCOUNT(tny_account))
502                         g_warning ("%s: expecting pop account", __FUNCTION__);
503                 else
504                         valid_account_type = TRUE;
505                 break;
506         case MODEST_PROTOCOL_STORE_IMAP:
507                 if (!TNY_IS_CAMEL_IMAP_STORE_ACCOUNT(tny_account))
508                         g_warning ("%s: expecting imap account", __FUNCTION__);
509                 else
510                         valid_account_type = TRUE;
511                 break;
512         case MODEST_PROTOCOL_STORE_MAILDIR:
513         case MODEST_PROTOCOL_STORE_MBOX:
514                 if (!TNY_IS_CAMEL_STORE_ACCOUNT(tny_account))
515                         g_warning ("%s: expecting store account", __FUNCTION__);
516                 else
517                         valid_account_type = TRUE;
518                 break;
519         default:
520                 g_warning ("invalid account type");
521         }
522
523         if (!valid_account_type) {
524                 g_warning ("%s: protocol type cannot be changed", __FUNCTION__);
525                 modest_account_mgr_free_server_account_data (account_mgr, account_data);
526                 return FALSE;
527         }
528         
529         if (!update_tny_account (tny_account, account_mgr, account_data)) {
530                 g_warning ("%s: failed to update account", __FUNCTION__);
531                 modest_account_mgr_free_server_account_data (account_mgr, account_data);
532                 return FALSE;
533         }
534
535         modest_account_mgr_free_server_account_data (account_mgr, account_data);
536         return TRUE;
537 }
538
539
540
541
542
543 /* we need these dummy functions, or tinymail will complain */
544 static gchar*
545 get_pass_dummy (TnyAccount *account, const gchar *prompt, gboolean *cancel)
546 {
547         return NULL;
548 }
549 static void
550 forget_pass_dummy (TnyAccount *account)
551 {
552         /* intentionally left blank */
553 }
554
555 TnyAccount*
556 modest_tny_account_new_from_account (ModestAccountMgr *account_mgr,
557                                      const gchar *account_name,
558                                      TnyAccountType type,
559                                      TnySessionCamel *session,
560                                      TnyGetPassFunc get_pass_func,
561                                      TnyForgetPassFunc forget_pass_func) 
562 {
563         TnyAccount *tny_account = NULL;
564         ModestAccountData *account_data = NULL;
565         ModestServerAccountData *server_data = NULL;
566
567         g_return_val_if_fail (account_mgr, NULL);
568         g_return_val_if_fail (account_name, NULL);
569         g_return_val_if_fail (session, NULL);
570
571         account_data = modest_account_mgr_get_account_data (account_mgr, account_name);
572         if (!account_data) {
573                 g_printerr ("modest: %s: cannot get account data for account %s\n",
574                             __FUNCTION__, account_name);
575                 return NULL;
576         }
577
578         if (type == TNY_ACCOUNT_TYPE_STORE && account_data->store_account)
579                 server_data = account_data->store_account;
580         else if (type == TNY_ACCOUNT_TYPE_TRANSPORT && account_data->transport_account)
581                 server_data = account_data->transport_account;
582         if (!server_data) {
583                 g_printerr ("modest: no %s account defined for '%s'\n",
584                             type == TNY_ACCOUNT_TYPE_STORE ? "store" : "transport",
585                             account_data->display_name);
586                 modest_account_mgr_free_account_data (account_mgr, account_data);
587                 return NULL;
588         }
589         
590         tny_account = create_tny_account (account_mgr,session, server_data);
591         if (!tny_account) { 
592                 g_printerr ("modest: failed to create tny account for %s (%s)\n",
593                             account_data->account_name, server_data->account_name);
594                 modest_account_mgr_free_account_data (account_mgr, account_data);
595                 return NULL;
596         } else
597                 update_tny_account (tny_account, account_mgr, server_data);
598                 
599         /* This name is what shows up in the folder view -- so for some POP/IMAP/... server
600          * account, we set its name to the account of which it is part. */
601  
602         if (account_data->display_name)
603                 tny_account_set_name (tny_account, account_data->display_name);
604
605         tny_account_set_forget_pass_func (tny_account,
606                                           forget_pass_func ? forget_pass_func : forget_pass_dummy);
607         tny_account_set_pass_func (tny_account,
608                                    get_pass_func ? get_pass_func: get_pass_dummy);
609         
610
611         modest_tny_account_set_parent_modest_account_name_for_server_account (tny_account, account_name);
612
613         modest_account_mgr_free_account_data (account_mgr, account_data);
614
615         return tny_account;
616 }
617
618 typedef struct
619 {
620         TnyStoreAccount *account;
621         
622         ModestTnyAccountGetMmcAccountNameCallback callback;
623         gpointer user_data;
624 } GetMmcAccountNameData;
625
626
627
628
629 /* Gets the memory card name: */
630 static void 
631 on_modest_file_system_info(HildonFileSystemInfoHandle *handle,
632                              HildonFileSystemInfo *info,
633                              const GError *error, gpointer data)
634 {
635         GetMmcAccountNameData *callback_data = (GetMmcAccountNameData*)data;
636
637         if (error) {
638                 g_warning ("%s: error=%s", __FUNCTION__, error->message);
639         }
640         
641         TnyAccount *account = TNY_ACCOUNT (callback_data->account);
642         
643         const gchar *previous_display_name = NULL;
644         
645         const gchar *display_name = NULL;
646         if (!error && info) {
647                 display_name = hildon_file_system_info_get_display_name(info);
648                 previous_display_name = tny_account_get_name (account);
649         }
650                  
651         /* printf ("DEBUG: %s: display name=%s\n", __FUNCTION__,  display_name); */
652         tny_account_set_name (account, display_name);
653                 
654         /* Inform the application that the name is now ready: */
655         if (callback_data->callback)
656                 (*(callback_data->callback)) (callback_data->account, 
657                         callback_data->user_data);
658         
659         g_object_unref (callback_data->account);
660         g_slice_free (GetMmcAccountNameData, callback_data);
661 }
662
663 void modest_tny_account_get_mmc_account_name (TnyStoreAccount* self, ModestTnyAccountGetMmcAccountNameCallback callback, gpointer user_data)
664 {
665         /* Just use the hard-coded path for the single memory card,
666          * rather than try to figure out the path to the specific card by 
667          * looking at the maildir URI:
668          */
669         const gchar *uri_real = MODEST_MCC1_VOLUMEPATH_URI;
670
671         /*
672         gchar* uri = tny_account_get_url_string (TNY_ACCOUNT (self));
673         if (!uri)
674                 return;
675
676         TODO: This gets the name of the folder, but we want the name of the volume.
677         gchar *uri_real = NULL;
678         const gchar* prefix = "maildir://localhost/";
679         if ((strstr (uri, prefix) == uri) && (strlen(uri) > strlen(prefix)) )
680                 uri_real = g_strconcat ("file:///", uri + strlen (prefix), NULL);
681         */
682
683         if (uri_real) {
684                 //This is freed in the callback:
685                 GetMmcAccountNameData * callback_data = g_slice_new0(GetMmcAccountNameData);
686                 callback_data->account = self;
687                 g_object_ref (callback_data->account); /* Unrefed when we destroy the struct. */
688                 callback_data->callback = callback;
689                 callback_data->user_data = user_data;
690                 
691                 /* TODO: gnome_vfs_volume_get_display_name() does not return 
692                  * the same string. But why not? Why does hildon needs its own 
693                  * function for this?
694                  */
695                 /* printf ("DEBUG: %s Calling hildon_file_system_info_async_new() with URI=%s\n", __FUNCTION__, uri_real); */
696                 hildon_file_system_info_async_new(uri_real, 
697                         on_modest_file_system_info, callback_data /* user_data */);
698
699                 /* g_free (uri_real); */
700         }
701
702         /* g_free (uri); */
703 }
704
705                                 
706
707 TnyAccount*
708 modest_tny_account_new_for_local_folders (ModestAccountMgr *account_mgr, TnySessionCamel *session,
709                                           const gchar* location_filepath)
710 {
711
712         
713         /* Make sure that the directories exist: */
714         modest_init_local_folders (location_filepath);
715
716         TnyStoreAccount *tny_account;
717         CamelURL *url;
718         gchar *maildir, *url_string;
719
720         g_return_val_if_fail (account_mgr, NULL);
721         g_return_val_if_fail (session, NULL);
722
723         
724         if (!location_filepath) {
725                 /* A NULL filepath means that this is the special local-folders maildir 
726                  * account: */
727                 tny_account = TNY_STORE_ACCOUNT (modest_tny_local_folders_account_new ());
728         }
729         else {
730                 /* Else, for instance, a per-account outbox maildir account: */
731                 tny_account = TNY_STORE_ACCOUNT (tny_camel_store_account_new ());
732         }
733                 
734         if (!tny_account) {
735                 g_printerr ("modest: %s: cannot create account for local folders. filepath=%s", 
736                         __FUNCTION__, location_filepath);
737                 return NULL;
738         }
739         tny_camel_account_set_session (TNY_CAMEL_ACCOUNT(tny_account), session);
740         
741         /* This path contains directories for each local folder.
742          * We have created them so that TnyCamelStoreAccount can find them 
743          * and report a folder for each directory: */
744         maildir = modest_local_folder_info_get_maildir_path (location_filepath);
745         url = camel_url_new ("maildir:", NULL);
746         camel_url_set_path (url, maildir);
747         /* Needed by tinymail's DBC assertions */
748         camel_url_set_host (url, "localhost");
749         url_string = camel_url_to_string (url, 0);
750         
751         tny_account_set_url_string (TNY_ACCOUNT(tny_account), url_string);
752 /*      printf("DEBUG: %s:\n  url=%s\n", __FUNCTION__, url_string); */
753
754         /* TODO: Use a more generic way of identifying memory card paths, 
755          * and of marking accounts as memory card accounts, maybe
756          * via a derived TnyCamelStoreAccount ? */
757         const gboolean is_mmc = 
758                 location_filepath && 
759                 (strcmp (location_filepath, MODEST_MCC1_VOLUMEPATH) == 0);
760                 
761         /* The name of memory card locations will be updated asynchronously.
762          * This is just a default: */
763         const gchar *name = is_mmc ? _("Memory Card") : 
764                 MODEST_LOCAL_FOLDERS_DEFAULT_DISPLAY_NAME;
765         tny_account_set_name (TNY_ACCOUNT(tny_account), name); 
766         
767         /* Get the correct display name for memory cards, asynchronously: */
768         if (location_filepath) {
769                 GError *error = NULL;
770                 gchar *uri = g_filename_to_uri(location_filepath, NULL, &error);
771                 if (error) {
772                         g_warning ("%s: g_filename_to_uri(%s) failed: %s", __FUNCTION__, 
773                                 location_filepath, error->message);
774                         g_error_free (error);
775                         error = NULL;   
776                 } else if (uri) {
777                         /* Get the account name asynchronously:
778                          * This might not happen soon enough, so some UI code might 
779                          * need to call this again, specifying a callback.
780                          */
781                         modest_tny_account_get_mmc_account_name (tny_account, NULL, NULL);
782                                 
783                         g_free (uri);
784                         uri = NULL;
785                 }
786         }
787         
788         
789         const gchar* id = is_mmc ? MODEST_MMC_ACCOUNT_ID :
790                 MODEST_LOCAL_FOLDERS_ACCOUNT_ID;
791         tny_account_set_id (TNY_ACCOUNT(tny_account), id);
792         
793         tny_account_set_forget_pass_func (TNY_ACCOUNT(tny_account), forget_pass_dummy);
794         tny_account_set_pass_func (TNY_ACCOUNT(tny_account), get_pass_dummy);
795         
796         modest_tny_account_set_parent_modest_account_name_for_server_account (
797                 TNY_ACCOUNT (tny_account), id);
798         
799         camel_url_free (url);
800         g_free (maildir);
801         g_free (url_string);
802
803         return TNY_ACCOUNT(tny_account);
804 }
805
806
807 TnyAccount*
808 modest_tny_account_new_for_per_account_local_outbox_folder (ModestAccountMgr *account_mgr,
809                                                             const gchar* account_name,
810                                                             TnySessionCamel *session)
811 {
812         g_return_val_if_fail (account_mgr, NULL);
813         g_return_val_if_fail (account_name, NULL);
814         g_return_val_if_fail (session, NULL);
815         
816         /* Notice that we create a ModestTnyOutboxAccount here, 
817          * instead of just a TnyCamelStoreAccount,
818          * so that we can later identify this as a special account for internal use only.
819          */
820         TnyStoreAccount *tny_account = TNY_STORE_ACCOUNT (modest_tny_outbox_account_new ());
821         if (!tny_account) {
822                 g_printerr ("modest: cannot create account for per-account local outbox folder.");
823                 return NULL;
824         }
825         
826         tny_camel_account_set_session (TNY_CAMEL_ACCOUNT(tny_account), session);
827         
828         /* Make sure that the paths exists on-disk so that TnyCamelStoreAccount can 
829          * find it to create a TnyFolder for it: */
830         gchar *folder_dir = modest_per_account_local_outbox_folder_info_get_maildir_path_to_outbox_folder (account_name); 
831         modest_init_one_local_folder(folder_dir);
832         g_free (folder_dir);
833         folder_dir = NULL;
834
835         /* This path should contain just one directory - "outbox": */
836         gchar *maildir = 
837                 modest_per_account_local_outbox_folder_info_get_maildir_path (account_name);
838                         
839         CamelURL *url = camel_url_new ("maildir:", NULL);
840         camel_url_set_path (url, maildir);
841         g_free (maildir);
842         
843         /* Needed by tinymail's DBC assertions */
844         camel_url_set_host (url, "localhost");
845         gchar *url_string = camel_url_to_string (url, 0);
846         camel_url_free (url);
847         
848         tny_account_set_url_string (TNY_ACCOUNT(tny_account), url_string);
849 /*      printf("DEBUG: %s:\n  url=%s\n", __FUNCTION__, url_string); */
850         g_free (url_string);
851
852         /* This text should never been seen,
853          * because the per-account outbox accounts are not seen directly by the user.
854          * Their folders are merged and shown as one folder. */ 
855         tny_account_set_name (TNY_ACCOUNT(tny_account), "Per-Account Outbox"); 
856         
857         gchar *account_id = g_strdup_printf (
858                 MODEST_PER_ACCOUNT_LOCAL_OUTBOX_FOLDER_ACCOUNT_ID_PREFIX "%s", 
859                 account_name);
860         tny_account_set_id (TNY_ACCOUNT(tny_account), account_id);
861         g_free (account_id);
862         
863         tny_account_set_forget_pass_func (TNY_ACCOUNT(tny_account), forget_pass_dummy);
864         tny_account_set_pass_func (TNY_ACCOUNT(tny_account), get_pass_dummy);
865         
866         /* Make this think that it belongs to the modest local-folders parent account: */
867         modest_tny_account_set_parent_modest_account_name_for_server_account (
868                 TNY_ACCOUNT (tny_account), MODEST_LOCAL_FOLDERS_ACCOUNT_ID);
869
870         return TNY_ACCOUNT(tny_account);
871 }
872
873
874
875 typedef gint (*TnyStatsFunc) (TnyFolderStats *stats);
876 #define TASK_GET_ALL_COUNT      0
877 #define TASK_GET_LOCAL_SIZE     1
878 #define TASK_GET_FOLDER_COUNT   2
879
880 typedef struct _RecurseFoldersHelper {
881         gint task;
882         guint sum;
883         guint folders;
884 } RecurseFoldersHelper;
885
886 static void
887 recurse_folders (TnyFolderStore *store, 
888                  TnyFolderStoreQuery *query, 
889                  RecurseFoldersHelper *helper)
890 {
891         TnyIterator *iter;
892         TnyList *folders = tny_simple_list_new ();
893
894         tny_folder_store_get_folders (store, folders, query, NULL);
895         iter = tny_list_create_iterator (folders);
896
897         helper->folders += tny_list_get_length (folders);
898
899         while (!tny_iterator_is_done (iter)) {
900                 TnyFolder *folder;
901
902                 folder = TNY_FOLDER (tny_iterator_get_current (iter));
903                 if (folder) {
904                         if (helper->task == TASK_GET_ALL_COUNT)
905                                 helper->sum += tny_folder_get_all_count (folder);
906
907                         if (helper->task == TASK_GET_LOCAL_SIZE)
908                                 helper->sum += tny_folder_get_local_size (folder);
909
910                         if (TNY_IS_FOLDER_STORE (folder))
911                                 recurse_folders (TNY_FOLDER_STORE (folder), query, helper);
912
913                         g_object_unref (folder);
914                 }
915
916                 tny_iterator_next (iter);
917         }
918          g_object_unref (G_OBJECT (iter));
919          g_object_unref (G_OBJECT (folders));
920 }
921
922 gint 
923 modest_tny_folder_store_get_folder_count (TnyFolderStore *self)
924 {
925         RecurseFoldersHelper *helper;
926         gint retval;
927
928         g_return_val_if_fail (TNY_IS_FOLDER_STORE (self), -1);
929
930         /* Create helper */
931         helper = g_malloc0 (sizeof (RecurseFoldersHelper));
932         helper->task = TASK_GET_FOLDER_COUNT;
933         helper->sum = 0;
934         helper->folders = 0;
935
936         recurse_folders (self, NULL, helper);
937
938         retval = helper->folders;
939
940         g_free (helper);
941
942         return retval;
943 }
944
945 gint
946 modest_tny_folder_store_get_message_count (TnyFolderStore *self)
947 {
948         RecurseFoldersHelper *helper;
949         gint retval;
950
951         g_return_val_if_fail (TNY_IS_FOLDER_STORE (self), -1);
952         
953         /* Create helper */
954         helper = g_malloc0 (sizeof (RecurseFoldersHelper));
955         helper->task = TASK_GET_ALL_COUNT;
956         helper->sum = 0;
957
958         recurse_folders (self, NULL, helper);
959
960         retval = helper->sum;
961
962         g_free (helper);
963
964         return retval;
965 }
966
967 gint 
968 modest_tny_folder_store_get_local_size (TnyFolderStore *self)
969 {
970         RecurseFoldersHelper *helper;
971         gint retval;
972
973         g_return_val_if_fail (TNY_IS_FOLDER_STORE (self), -1);
974
975         /* Create helper */
976         helper = g_malloc0 (sizeof (RecurseFoldersHelper));
977         helper->task = TASK_GET_LOCAL_SIZE;
978         helper->sum = 0;
979
980         recurse_folders (self, NULL, helper);
981
982         retval = helper->sum;
983
984         g_free (helper);
985
986         return retval;
987 }
988
989 const gchar* 
990 modest_tny_account_get_parent_modest_account_name_for_server_account (TnyAccount *self)
991 {
992         return (const gchar *)g_object_get_data (G_OBJECT (self), "modest_account");
993 }
994
995 void 
996 modest_tny_account_set_parent_modest_account_name_for_server_account (TnyAccount *self, 
997                                                                       const gchar* parent_modest_acount_name)
998 {
999         g_object_set_data_full (G_OBJECT(self), "modest_account",
1000                                 (gpointer) g_strdup (parent_modest_acount_name), g_free);
1001 }
1002
1003 gboolean
1004 modest_tny_account_is_virtual_local_folders (TnyAccount *self)
1005 {
1006         /* We should make this more sophisticated if we ever use ModestTnyLocalFoldersAccount 
1007          * for anything else. */
1008         return MODEST_IS_TNY_LOCAL_FOLDERS_ACCOUNT (self);
1009 }
1010
1011
1012 gboolean
1013 modest_tny_account_is_memory_card_account (TnyAccount *self)
1014 {
1015         const gchar* account_id = NULL;
1016
1017         g_return_val_if_fail (TNY_ACCOUNT (self), FALSE);
1018
1019         if (!self)
1020                 return FALSE;
1021
1022         account_id = tny_account_get_id (self);
1023
1024         if (!account_id)
1025                 return FALSE;
1026         else    
1027                 return (strcmp (account_id, MODEST_MMC_ACCOUNT_ID) == 0);
1028 }