2007-05-23 Murray Cumming <murrayc@murrayc.com>
[modest] / src / modest-tny-account.c
index fc30538..c6617fb 100644 (file)
 #include <modest-runtime.h>
 #include <tny-simple-list.h>
 #include <modest-tny-folder.h>
+#include <modest-tny-outbox-account.h>
 #include <modest-account-mgr-helpers.h>
+#include <modest-init.h>
 #include <tny-camel-transport-account.h>
 #include <tny-camel-imap-store-account.h>
 #include <tny-camel-pop-store-account.h>
+#include <tny-folder-stats.h>
+
 
-/* for now, ignore the account ===> the special folders are the same,
- * local folders for all accounts
- * this might change, ie, IMAP might have server-side sent-items
- */
 TnyFolder *
 modest_tny_account_get_special_folder (TnyAccount *account,
                                       TnyFolderType special_type)
@@ -49,14 +49,35 @@ modest_tny_account_get_special_folder (TnyAccount *account,
        TnyList *folders;
        TnyIterator *iter;
        TnyFolder *special_folder = NULL;
-       TnyAccount *local_account;
+
        
        g_return_val_if_fail (account, NULL);
        g_return_val_if_fail (0 <= special_type && special_type < TNY_FOLDER_TYPE_NUM,
                              NULL);
        
-       local_account = modest_tny_account_store_get_tny_account_by_id (modest_runtime_get_account_store(),
-                                                                       MODEST_LOCAL_FOLDERS_ACCOUNT_ID);
+       TnyAccount *local_account  = NULL;
+               
+       /* The accounts have already been instantiated by 
+        * modest_tny_account_store_get_accounts(), which is the 
+        * TnyAccountStore::get_accounts_func() implementation,
+        * so we just get them here.
+        */
+        
+       /* Per-account outbox folders are each in their own on-disk directory: */
+       if (special_type == TNY_FOLDER_TYPE_OUTBOX) {
+               gchar *account_id = g_strdup_printf (
+                       MODEST_PER_ACCOUNT_LOCAL_OUTBOX_FOLDER_ACCOUNT_ID_PREFIX "%s", 
+                       tny_account_get_id (account));
+               
+                       local_account = modest_tny_account_store_get_tny_account_by_id (modest_runtime_get_account_store(),
+                                                                       account_id);
+                       g_free (account_id);
+       } else {
+               /* Other local folders are all in one on-disk directory: */
+               local_account = modest_tny_account_store_get_tny_account_by_id (modest_runtime_get_account_store(),
+                                                                               MODEST_ACTUAL_LOCAL_FOLDERS_ACCOUNT_ID);
+       }
+       
        if (!local_account) {
                g_printerr ("modest: cannot get local account\n");
                return NULL;
@@ -76,15 +97,50 @@ modest_tny_account_get_special_folder (TnyAccount *account,
                        special_folder = folder;
                        break;
                }
+               
                g_object_unref (G_OBJECT(folder));
                tny_iterator_next (iter);
        }
+       
        g_object_unref (G_OBJECT (folders));
        g_object_unref (G_OBJECT (iter));
+       g_object_unref (G_OBJECT (local_account));
 
        return special_folder;
 }
 
+/* Camel options: */
+
+/* These seem to be listed in 
+ * libtinymail-camel/camel-lite/camel/providers/imap/camel-imap-store.c 
+ */
+#define MODEST_ACCOUNT_OPTION_SSL "use_ssl"
+#define MODEST_ACCOUNT_OPTION_SSL_NEVER "never"
+#define MODEST_ACCOUNT_OPTION_SSL_ALWAYS "always"
+#define MODEST_ACCOUNT_OPTION_SSL_WHEN_POSSIBLE "when-possible"
+
+/* These seem to be listed in 
+ * libtinymail-camel/camel-lite/camel/providers/imap/camel-imap-provider.c 
+ */
+#define MODEST_ACCOUNT_OPTION_USE_LSUB "use_lsub" /* Show only subscribed folders */
+#define MODEST_ACCOUNT_OPTION_CHECK_ALL "check_all" /* Check for new messages in all folders */
+
+
+/* Posssible values for tny_account_set_secure_auth_mech().
+ * These might be camel-specific.
+ * Really, tinymail should use an enum.
+ * camel_sasl_authtype() seems to list some possible values.
+ */
+/* Note that evolution does not offer these for IMAP: */
+#define MODEST_ACCOUNT_AUTH_PLAIN "PLAIN"
+#define MODEST_ACCOUNT_AUTH_ANONYMOUS "ANONYMOUS"
+
+/* Caeml's IMAP uses NULL instead for "Password".
+ * Also, not that Evolution offers "Password" for IMAP, but "Login" for SMTP.*/
+#define MODEST_ACCOUNT_AUTH_PASSWORD "LOGIN" 
+#define MODEST_ACCOUNT_AUTH_CRAMMD5 "CRAM-MD5"
+
 
 /**
  * modest_tny_account_new_from_server_account:
@@ -100,19 +156,21 @@ modest_tny_account_get_special_folder (TnyAccount *account,
 static TnyAccount*
 modest_tny_account_new_from_server_account (ModestAccountMgr *account_mgr,
                                            ModestServerAccountData *account_data)
-{
-       TnyAccount *tny_account;
-               
+{      
+       gchar *url = NULL;
+
        g_return_val_if_fail (account_mgr, NULL);
        g_return_val_if_fail (account_data, NULL);
 
        /* sanity checks */
-       if (account_data->proto == MODEST_PROTOCOL_UNKNOWN) {
+       if (account_data->proto == MODEST_PROTOCOL_TRANSPORT_STORE_UNKNOWN) {
                g_printerr ("modest: '%s' does not provide a protocol\n",
                            account_data->account_name);
                return NULL;
        }
 
+       TnyAccount *tny_account = NULL;
+       
        switch (account_data->proto) {
        case MODEST_PROTOCOL_TRANSPORT_SENDMAIL:
        case MODEST_PROTOCOL_TRANSPORT_SMTP:
@@ -123,6 +181,9 @@ modest_tny_account_new_from_server_account (ModestAccountMgr *account_mgr,
                tny_account = TNY_ACCOUNT(tny_camel_imap_store_account_new ()); break;
        case MODEST_PROTOCOL_STORE_MAILDIR:
        case MODEST_PROTOCOL_STORE_MBOX:
+               /* Note that this is not where we create the special local folders account.
+                * That happens in modest_tny_account_new_for_local_folders() instead.
+                */
                tny_account = TNY_ACCOUNT(tny_camel_store_account_new()); break;
        default:
                g_return_val_if_reached (NULL);
@@ -135,24 +196,112 @@ modest_tny_account_new_from_server_account (ModestAccountMgr *account_mgr,
        tny_account_set_id (tny_account, account_data->account_name);
 
        /* Proto */
-       tny_account_set_proto (tny_account,
-                              modest_protocol_info_get_protocol_name(account_data->proto));
-       if (account_data->uri) 
+       const gchar* proto_name =
+               modest_protocol_info_get_transport_store_protocol_name(account_data->proto);
+       tny_account_set_proto (tny_account, proto_name);
+
+              
+       /* mbox and maildir accounts use a URI instead of the rest:
+        * Note that this is not where we create the special local folders account.
+        * We do that in modest_tny_account_new_for_local_folders() instead. */
+       if (account_data->uri)  {
+               /* printf("DEBUG: %s: Using URI=%s\n", __FUNCTION__, account_data->uri); */
                tny_account_set_url_string (TNY_ACCOUNT(tny_account), account_data->uri);
+               g_message ("%s: local account-url: %s", __FUNCTION__, account_data->uri);
+       }
        else {
-               if (account_data->options) {
-                       GSList *options = account_data->options;
-                       while (options) {
-                               tny_camel_account_add_option (TNY_CAMEL_ACCOUNT (tny_account),
-                                                             options->data);
-                               options = g_slist_next (options);
-                       }
+               /* Set camel-specific options: */
+               
+               /* Enable secure connection settings: */
+               /* printf("DEBUG: %s: security=%d\n", __FUNCTION__, account_data->security); */
+               const gchar* option_security = NULL;
+               switch (account_data->security) {
+               case MODEST_PROTOCOL_CONNECTION_NORMAL:
+                       option_security = MODEST_ACCOUNT_OPTION_SSL "=" MODEST_ACCOUNT_OPTION_SSL_NEVER;
+                       break;
+               case MODEST_PROTOCOL_CONNECTION_SSL:
+               case MODEST_PROTOCOL_CONNECTION_TLS:
+                       option_security = MODEST_ACCOUNT_OPTION_SSL "=" MODEST_ACCOUNT_OPTION_SSL_ALWAYS;;
+                       break;
+               case MODEST_PROTOCOL_CONNECTION_TLS_OP:
+                       option_security = MODEST_ACCOUNT_OPTION_SSL "=" MODEST_ACCOUNT_OPTION_SSL_WHEN_POSSIBLE;
+                       break;
+               default:
+                       break;
                }
+               
+               if(option_security)
+                       tny_camel_account_add_option (TNY_CAMEL_ACCOUNT (tny_account),
+                                                     option_security);
+               
+               /* Secure authentication: */
+               /* printf("DEBUG: %s: secure-auth=%d\n", __FUNCTION__, account_data->secure_auth); */
+               const gchar* auth_mech_name = NULL;
+               switch (account_data->secure_auth) {
+               case MODEST_PROTOCOL_AUTH_NONE:
+                       /* IMAP and POP need at least a password,
+                        * which camel uses if we specify NULL.
+                        * This setting should never happen anyway. */
+                       if (account_data->proto == MODEST_PROTOCOL_STORE_IMAP ||
+                           account_data->proto == MODEST_PROTOCOL_STORE_POP)
+                               auth_mech_name = NULL;
+                       else if (account_data->proto == MODEST_PROTOCOL_TRANSPORT_SMTP)
+                               auth_mech_name = MODEST_ACCOUNT_AUTH_ANONYMOUS;
+                       else
+                               auth_mech_name = MODEST_ACCOUNT_AUTH_PLAIN;
+                       break;
+                       
+               case MODEST_PROTOCOL_AUTH_PASSWORD:
+                       /* Camel use a password for IMAP or POP if we specify NULL,
+                        * For IMAP, at least it will report an error if we use "Password", "Login" or "Plain".
+                        * (POP is know to report an error for Login too. Probably Password and Plain too.) */
+                       if (account_data->proto == MODEST_PROTOCOL_STORE_IMAP)
+                               auth_mech_name = NULL;
+                       else if (account_data->proto == MODEST_PROTOCOL_STORE_POP)
+                               auth_mech_name = NULL;
+                       else
+                               auth_mech_name = MODEST_ACCOUNT_AUTH_PASSWORD;
+                       break;
+                       
+               case MODEST_PROTOCOL_AUTH_CRAMMD5:
+                       auth_mech_name = MODEST_ACCOUNT_AUTH_CRAMMD5;
+                       break;
+                       
+               default:
+                       g_warning ("%s: Unhandled secure authentication setting %d for "
+                               "account=%s (%s)", __FUNCTION__, account_data->secure_auth,
+                                  account_data->account_name, account_data->hostname);
+                       break;
+               }
+               
+               if(auth_mech_name) 
+                       tny_account_set_secure_auth_mech (tny_account, auth_mech_name);
+               
+               if (modest_protocol_info_protocol_is_store(account_data->proto) && 
+                       (account_data->proto == MODEST_PROTOCOL_STORE_IMAP) ) {
+                       /* Other connection options, needed for IMAP. */
+                       tny_camel_account_add_option (TNY_CAMEL_ACCOUNT (tny_account),
+                                                     MODEST_ACCOUNT_OPTION_USE_LSUB);
+                       tny_camel_account_add_option (TNY_CAMEL_ACCOUNT (tny_account),
+                                                     MODEST_ACCOUNT_OPTION_CHECK_ALL);
+               }
+               
                if (account_data->username) 
                        tny_account_set_user (tny_account, account_data->username);
                if (account_data->hostname)
                        tny_account_set_hostname (tny_account, account_data->hostname);
+                
+               /* Set the port: */
+               if (account_data->port)
+                       tny_account_set_port (tny_account, account_data->port);
        }
+
+       /* FIXME: for debugging */
+       url = tny_account_get_url_string (TNY_ACCOUNT(tny_account));
+       g_message ("modest: account-url: %s", url);
+       g_free (url);
+       /***********************/
+       
        return tny_account;
 }
 
@@ -214,13 +363,16 @@ modest_tny_account_new_from_account (ModestAccountMgr *account_mgr, const gchar
                                          forget_pass_func ? forget_pass_func : forget_pass_dummy);
        tny_account_set_pass_func (tny_account,
                                   get_pass_func ? get_pass_func: get_pass_dummy);
-
-       /* this name is what shows up in the folder view -- so for some POP/IMAP/... server
-        * account, we set its name to the acount of which it is part */
+       
+       /* This name is what shows up in the folder view -- so for some POP/IMAP/... server
+        * account, we set its name to the account of which it is part. */
        if (account_data->display_name)
                tny_account_set_name (tny_account, account_data->display_name); 
 
+       modest_tny_account_set_parent_modest_account_name_for_server_account (tny_account, account_name);
+       
        modest_account_mgr_free_account_data (account_mgr, account_data);
+
        return tny_account;
 }
 
@@ -241,17 +393,27 @@ modest_tny_account_new_for_local_folders (ModestAccountMgr *account_mgr, TnySess
        }
        tny_camel_account_set_session (TNY_CAMEL_ACCOUNT(tny_account), session);
        
+       /* This path contains directories for each local folder.
+        * We have created them so that TnyCamelStoreAccount can find them 
+        * and report a folder for each directory: */
        maildir = modest_local_folder_info_get_maildir_path ();
        url = camel_url_new ("maildir:", NULL);
        camel_url_set_path (url, maildir);
+       /* Needed by tinymail's DBC assertions */
+       camel_url_set_host (url, "localhost");
        url_string = camel_url_to_string (url, 0);
        
        tny_account_set_url_string (TNY_ACCOUNT(tny_account), url_string);
-       tny_account_set_name (TNY_ACCOUNT(tny_account), MODEST_LOCAL_FOLDERS_ACCOUNT_NAME); 
-       tny_account_set_id (TNY_ACCOUNT(tny_account), MODEST_LOCAL_FOLDERS_ACCOUNT_ID); 
+       printf("DEBUG: %s: local folders url=%s\n", __FUNCTION__, url_string);
+
+       tny_account_set_name (TNY_ACCOUNT(tny_account), MODEST_LOCAL_FOLDERS_DEFAULT_DISPLAY_NAME); 
+       tny_account_set_id (TNY_ACCOUNT(tny_account), MODEST_ACTUAL_LOCAL_FOLDERS_ACCOUNT_ID); 
         tny_account_set_forget_pass_func (TNY_ACCOUNT(tny_account), forget_pass_dummy);
        tny_account_set_pass_func (TNY_ACCOUNT(tny_account), get_pass_dummy);
-
+       
+       modest_tny_account_set_parent_modest_account_name_for_server_account (
+               TNY_ACCOUNT (tny_account), MODEST_ACTUAL_LOCAL_FOLDERS_ACCOUNT_ID);
+       
        camel_url_free (url);
        g_free (maildir);
        g_free (url_string);
@@ -260,3 +422,192 @@ modest_tny_account_new_for_local_folders (ModestAccountMgr *account_mgr, TnySess
 }
 
 
+TnyAccount*
+modest_tny_account_new_for_per_account_local_outbox_folder (ModestAccountMgr *account_mgr, TnyAccount *account, TnySessionCamel *session)
+{
+       g_return_val_if_fail (account_mgr, NULL);
+       g_return_val_if_fail (account, NULL);
+       g_return_val_if_fail (tny_account_get_account_type (account) == TNY_ACCOUNT_TYPE_TRANSPORT, NULL);
+       
+       /* Notice that we create a ModestTnyOutboxAccount here, 
+        * instead of just a TnyCamelStoreAccount,
+        * so that we can later identify this as a special account for internal use only.
+        */
+       TnyStoreAccount *tny_account = TNY_STORE_ACCOUNT (modest_tny_outbox_account_new ());
+       if (!tny_account) {
+               g_printerr ("modest: cannot create account for per-account local outbox folder.");
+               return NULL;
+       }
+       
+       tny_camel_account_set_session (TNY_CAMEL_ACCOUNT(tny_account), session);
+       
+       /* Make sure that the paths exists on-disk so that TnyCamelStoreAccount can 
+        * find it to create a TnyFolder for it: */
+       gchar *folder_dir = modest_per_account_local_outbox_folder_info_get_maildir_path_to_outbox_folder (account); 
+       modest_init_one_local_folder(folder_dir);
+       g_free (folder_dir);
+       folder_dir = NULL;
+
+       /* This path should contain just one directory - "outbox": */
+       gchar *maildir = 
+               modest_per_account_local_outbox_folder_info_get_maildir_path (account);
+                       
+       CamelURL *url = camel_url_new ("maildir:", NULL);
+       camel_url_set_path (url, maildir);
+       g_free (maildir);
+       
+       /* Needed by tinymail's DBC assertions */
+       camel_url_set_host (url, "localhost");
+       gchar *url_string = camel_url_to_string (url, 0);
+       camel_url_free (url);
+       
+       tny_account_set_url_string (TNY_ACCOUNT(tny_account), url_string);
+       printf("DEBUG: %s: local outbox folder account url=%s\n", __FUNCTION__, url_string);
+       g_free (url_string);
+
+       /* This text should never been seen,
+        * because the per-account outbox accounts are not seen directly by the user.
+        * Their folders are merged and shown as one folder. */ 
+       tny_account_set_name (TNY_ACCOUNT(tny_account), "Per-Account Outbox"); 
+       
+       gchar *account_id = g_strdup_printf (
+               MODEST_PER_ACCOUNT_LOCAL_OUTBOX_FOLDER_ACCOUNT_ID_PREFIX "%s", 
+               tny_account_get_id (account));
+       tny_account_set_id (TNY_ACCOUNT(tny_account), account_id);
+       g_free (account_id);
+       
+       tny_account_set_forget_pass_func (TNY_ACCOUNT(tny_account), forget_pass_dummy);
+       tny_account_set_pass_func (TNY_ACCOUNT(tny_account), get_pass_dummy);
+       
+       /* Make this think that it belongs to the modest local-folders parent account: */
+       modest_tny_account_set_parent_modest_account_name_for_server_account (
+               TNY_ACCOUNT (tny_account), MODEST_ACTUAL_LOCAL_FOLDERS_ACCOUNT_ID);
+
+       return TNY_ACCOUNT(tny_account);
+}
+
+
+
+typedef gint (*TnyStatsFunc) (TnyFolderStats *stats);
+
+typedef struct _RecurseFoldersHelper {
+       TnyStatsFunc function;
+       guint sum;
+       guint folders;
+} RecurseFoldersHelper;
+
+static void
+recurse_folders (TnyFolderStore *store, 
+                TnyFolderStoreQuery *query, 
+                RecurseFoldersHelper *helper)
+{
+       TnyIterator *iter;
+       TnyList *folders = tny_simple_list_new ();
+
+       tny_folder_store_get_folders (store, folders, query, NULL);
+       iter = tny_list_create_iterator (folders);
+
+       helper->folders += tny_list_get_length (folders);
+
+       while (!tny_iterator_is_done (iter)) {
+               TnyFolderStats *stats;
+               TnyFolder *folder;
+
+               folder = TNY_FOLDER (tny_iterator_get_current (iter));
+               stats = tny_folder_get_stats (folder);
+
+               /* initially, we sometimes get -1 from tinymail; ignore that */
+               if (helper->function && helper->function (stats) > 0)
+                       helper->sum += helper->function (stats);
+
+               if (TNY_IS_FOLDER_STORE (folder)) {
+                       recurse_folders (TNY_FOLDER_STORE (folder), query, helper);
+               }
+           
+               g_object_unref (folder);
+               g_object_unref (stats);
+               tny_iterator_next (iter);
+       }
+        g_object_unref (G_OBJECT (iter));
+        g_object_unref (G_OBJECT (folders));
+}
+
+gint 
+modest_tny_folder_store_get_folder_count (TnyFolderStore *self)
+{
+       RecurseFoldersHelper *helper;
+       gint retval;
+
+       g_return_val_if_fail (TNY_IS_FOLDER_STORE (self), -1);
+
+       /* Create helper */
+       helper = g_malloc0 (sizeof (RecurseFoldersHelper));
+       helper->function = NULL;
+       helper->sum = 0;
+       helper->folders = 0;
+
+       recurse_folders (self, NULL, helper);
+
+       retval = helper->folders;
+
+       g_free (helper);
+
+       return retval;
+}
+
+gint
+modest_tny_folder_store_get_message_count (TnyFolderStore *self)
+{
+       RecurseFoldersHelper *helper;
+       gint retval;
+
+       g_return_val_if_fail (TNY_IS_FOLDER_STORE (self), -1);
+       
+       /* Create helper */
+       helper = g_malloc0 (sizeof (RecurseFoldersHelper));
+       helper->function = (TnyStatsFunc) tny_folder_stats_get_all_count;
+       helper->sum = 0;
+
+       recurse_folders (self, NULL, helper);
+
+       retval = helper->sum;
+
+       g_free (helper);
+
+       return retval;
+}
+
+gint 
+modest_tny_folder_store_get_local_size (TnyFolderStore *self)
+{
+       RecurseFoldersHelper *helper;
+       gint retval;
+
+       g_return_val_if_fail (TNY_IS_ACCOUNT (self), -1);
+
+       /* Create helper */
+       helper = g_malloc0 (sizeof (RecurseFoldersHelper));
+       helper->function = (TnyStatsFunc) tny_folder_stats_get_local_size;
+       helper->sum = 0;
+
+       recurse_folders (self, NULL, helper);
+
+       retval = helper->sum;
+
+       g_free (helper);
+
+       return retval;
+}
+
+const gchar* modest_tny_account_get_parent_modest_account_name_for_server_account (TnyAccount *self)
+{
+       return (const gchar *)g_object_get_data (G_OBJECT (self), "modest_account");
+}
+
+void modest_tny_account_set_parent_modest_account_name_for_server_account (TnyAccount *self, const gchar* parent_modest_acount_name)
+{
+       g_object_set_data_full (G_OBJECT(self), "modest_account",
+                               (gpointer*) g_strdup (parent_modest_acount_name), g_free);
+}
+
+