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