2007-07-23 Murray Cumming <murrayc@murrayc.com>
[modest] / src / modest-mail-operation.c
index df94621..39dbea7 100644 (file)
@@ -51,6 +51,7 @@
 #include "modest-text-utils.h"
 #include "modest-tny-msg.h"
 #include "modest-tny-folder.h"
+#include "modest-tny-account-store.h"
 #include "modest-tny-platform-factory.h"
 #include "modest-marshal.h"
 #include "modest-error.h"
 #define KB 1024
 #define GET_SIZE_BUFFER_SIZE 128
 
+/* 
+ * Remove all these #ifdef stuff when the tinymail's idle calls become
+ * locked
+ */
+#define TINYMAIL_IDLES_NOT_LOCKED_YET 1
+
 /* 'private'/'protected' functions */
 static void modest_mail_operation_class_init (ModestMailOperationClass *klass);
 static void modest_mail_operation_init       (ModestMailOperation *obj);
@@ -76,8 +83,6 @@ static void     get_msg_status_cb (GObject *obj,
 
 static void     modest_mail_operation_notify_end (ModestMailOperation *self);
 
-static gboolean did_a_cancel = FALSE;
-
 enum _ModestMailOperationSignals 
 {
        PROGRESS_CHANGED_SIGNAL,
@@ -395,29 +400,27 @@ gboolean
 modest_mail_operation_cancel (ModestMailOperation *self)
 {
        ModestMailOperationPrivate *priv;
+       gboolean canceled = FALSE;
 
-       if (!MODEST_IS_MAIL_OPERATION (self)) {
-               g_warning ("%s: invalid parametter", G_GNUC_FUNCTION);
-               return FALSE;
-       }
+       g_return_val_if_fail (MODEST_IS_MAIL_OPERATION (self), FALSE);
 
        priv = MODEST_MAIL_OPERATION_GET_PRIVATE (self);
-       if (!priv) {
-               g_warning ("BUG: %s: priv == NULL", __FUNCTION__);
-               return FALSE;
-       }
 
-       did_a_cancel = TRUE;
+       /* Note that if we call cancel with an already canceled mail
+          operation the progress changed signal won't be emitted */
+       if (priv->status == MODEST_MAIL_OPERATION_STATUS_CANCELED)
+               return FALSE;
 
        /* Set new status */
        priv->status = MODEST_MAIL_OPERATION_STATUS_CANCELED;
-
-       /* This emits progress-changed on which the mail operation queue is
-        * listening, so the mail operation is correctly removed from the
-        * queue without further explicit calls. */
-       modest_mail_operation_notify_end (self);
        
-       return TRUE;
+       /* Cancel the mail operation. We need to wrap it between this
+          start/stop operations to allow following calls to the
+          account */
+       if (priv->account)
+               tny_account_cancel (priv->account);
+
+       return canceled;
 }
 
 guint 
@@ -714,6 +717,7 @@ modest_mail_operation_send_new_mail_cb (ModestMailOperation *self,
                        tny_header_set_flags (header, TNY_HEADER_FLAG_DELETED);
                        tny_header_set_flags (header, TNY_HEADER_FLAG_SEEN);
                        g_object_unref (header);
+                       g_object_unref (folder);
                }
        }
 
@@ -1017,7 +1021,13 @@ idle_notify_progress (gpointer data)
        ModestMailOperationState *state;
 
        state = modest_mail_operation_clone_state (mail_op);
+#ifdef TINYMAIL_IDLES_NOT_LOCKED_YET
+       gdk_threads_enter ();
+#endif
        g_signal_emit (G_OBJECT (mail_op), signals[PROGRESS_CHANGED_SIGNAL], 0, state, NULL);
+#ifdef TINYMAIL_IDLES_NOT_LOCKED_YET
+       gdk_threads_leave ();
+#endif
        g_slice_free (ModestMailOperationState, state);
        
        return TRUE;
@@ -1035,7 +1045,13 @@ idle_notify_progress_once (gpointer data)
 
        pair = (ModestPair *) data;
 
+#ifdef TINYMAIL_IDLES_NOT_LOCKED_YET
+       gdk_threads_enter ();
+#endif
        g_signal_emit (G_OBJECT (pair->first), signals[PROGRESS_CHANGED_SIGNAL], 0, pair->second, NULL);
+#ifdef TINYMAIL_IDLES_NOT_LOCKED_YET
+       gdk_threads_leave ();
+#endif
 
        /* Free the state and the reference to the mail operation */
        g_slice_free (ModestMailOperationState, (ModestMailOperationState*)pair->second);
@@ -1125,13 +1141,14 @@ static gpointer
 update_account_thread (gpointer thr_user_data)
 {
        static gboolean first_time = TRUE;
-       UpdateAccountInfo *info;
+       UpdateAccountInfo *info = NULL;
        TnyList *all_folders = NULL;
        GPtrArray *new_headers = NULL;
        TnyIterator *iter = NULL;
        TnyFolderStoreQuery *query = NULL;
        ModestMailOperationPrivate *priv = NULL;
        ModestTnySendQueue *send_queue = NULL;
+       gint num_new_headers = 0;
 
        info = (UpdateAccountInfo *) thr_user_data;
        priv = MODEST_MAIL_OPERATION_GET_PRIVATE(info->mail_op);
@@ -1178,10 +1195,12 @@ update_account_thread (gpointer thr_user_data)
        gint timeout = g_timeout_add (100, idle_notify_progress, info->mail_op);
 
        /* Refresh folders */
+       num_new_headers = 0;
        new_headers = g_ptr_array_new ();
        iter = tny_list_create_iterator (all_folders);
 
-       while (!tny_iterator_is_done (iter) && !priv->error && !did_a_cancel) {
+       while (!tny_iterator_is_done (iter) && !priv->error && 
+              priv->status != MODEST_MAIL_OPERATION_STATUS_CANCELED) {
 
                InternalFolderObserver *observer;
                TnyFolderStore *folder = TNY_FOLDER_STORE (tny_iterator_get_current (iter));
@@ -1230,20 +1249,17 @@ update_account_thread (gpointer thr_user_data)
 
                g_object_unref (G_OBJECT (folder));
                if (priv->error)
-               {
                        priv->status = MODEST_MAIL_OPERATION_STATUS_FAILED;
-                       goto out;
-               }
-               
+
                tny_iterator_next (iter);
        }
 
-       did_a_cancel = FALSE;
-
        g_object_unref (G_OBJECT (iter));
        g_source_remove (timeout);
 
-       if (new_headers->len > 0) {
+       if (priv->status != MODEST_MAIL_OPERATION_STATUS_CANCELED && 
+           priv->status != MODEST_MAIL_OPERATION_STATUS_FAILED &&
+           new_headers->len > 0) {
                gint msg_num = 0;
 
                /* Order by date */
@@ -1291,12 +1307,17 @@ update_account_thread (gpointer thr_user_data)
 
                        msg_num++;
                }
-               g_ptr_array_foreach (new_headers, (GFunc) g_object_unref, NULL);
-               g_ptr_array_free (new_headers, FALSE);
        }
+
+       /* Get the number of new headers and free them */
+       num_new_headers = new_headers->len;
+       g_ptr_array_foreach (new_headers, (GFunc) g_object_unref, NULL);
+       g_ptr_array_free (new_headers, FALSE);
        
+       if (priv->status == MODEST_MAIL_OPERATION_STATUS_CANCELED)
+               goto out;
+
        /* Perform send (if operation was not cancelled) */
-       if (did_a_cancel) goto out;             
 /*     priv->op_type = MODEST_MAIL_OPERATION_TYPE_SEND; */
        priv->done = 0;
        priv->total = 0;
@@ -1336,7 +1357,7 @@ update_account_thread (gpointer thr_user_data)
                /* This thread is not in the main lock */
                idle_info = g_malloc0 (sizeof (UpdateAccountInfo));
                idle_info->mail_op = g_object_ref (info->mail_op);
-               idle_info->new_headers = (new_headers) ? new_headers->len : 0;
+               idle_info->new_headers = num_new_headers;
                idle_info->callback = info->callback;
                g_idle_add (idle_update_account_cb, idle_info);
        }
@@ -1365,12 +1386,12 @@ modest_mail_operation_update_account (ModestMailOperation *self,
                                      UpdateAccountCallback callback,
                                      gpointer user_data)
 {
-       GThread *thread;
-       UpdateAccountInfo *info;
-       ModestMailOperationPrivate *priv;
-       ModestAccountMgr *mgr;
-       TnyStoreAccount *modest_account;
-       TnyTransportAccount *transport_account;
+       GThread *thread = NULL;
+       UpdateAccountInfo *info = NULL;
+       ModestMailOperationPrivate *priv = NULL;
+       ModestAccountMgr *mgr = NULL;
+       TnyStoreAccount *store_account = NULL;
+       TnyTransportAccount *transport_account = NULL;
 
        g_return_val_if_fail (MODEST_IS_MAIL_OPERATION (self), FALSE);
        g_return_val_if_fail (account_name, FALSE);
@@ -1383,20 +1404,20 @@ modest_mail_operation_update_account (ModestMailOperation *self,
        priv->done  = 0;
        priv->status = MODEST_MAIL_OPERATION_STATUS_IN_PROGRESS;
 
+       /* Get the Modest account */
+       store_account = (TnyStoreAccount *)
+               modest_tny_account_store_get_server_account (modest_runtime_get_account_store (),
+                                                                    account_name,
+                                                                    TNY_ACCOUNT_TYPE_STORE);
+                                                                    
        /* Make sure that we have a connection, and request one 
         * if necessary:
         * TODO: Is there some way to trigger this for every attempt to 
         * use the network? */
-       if (!modest_platform_connect_and_wait (NULL))
+       if (!modest_platform_connect_and_wait (NULL, TNY_ACCOUNT (store_account)))
                goto error;
 
-       /* Get the Modest account */
-       modest_account = (TnyStoreAccount *)
-               modest_tny_account_store_get_server_account (modest_runtime_get_account_store (),
-                                                                    account_name,
-                                                                    TNY_ACCOUNT_TYPE_STORE);
-
-       if (!modest_account) {
+       if (!store_account) {
                g_set_error (&(priv->error), MODEST_MAIL_OPERATION_ERROR,
                             MODEST_MAIL_OPERATION_ERROR_ITEM_NOT_FOUND,
                             "cannot get tny store account for %s\n", account_name);
@@ -1419,7 +1440,7 @@ modest_mail_operation_update_account (ModestMailOperation *self,
        /* Create the helper object */
        info = g_slice_new (UpdateAccountInfo);
        info->mail_op = self;
-       info->account = modest_account;
+       info->account = store_account;
        info->transport_account = transport_account;
        info->callback = callback;
        info->user_data = user_data;
@@ -1565,9 +1586,12 @@ modest_mail_operation_remove_folder (ModestMailOperation *self,
                trash_folder = modest_tny_account_get_special_folder (account,
                                                                      TNY_FOLDER_TYPE_TRASH);
                /* TODO: error_handling */
-                modest_mail_operation_xfer_folder (self, folder,
+               if (trash_folder) {
+                       modest_mail_operation_xfer_folder (self, folder,
                                                    TNY_FOLDER_STORE (trash_folder), 
                                                    TRUE, NULL, NULL);
+                       g_object_unref (trash_folder);
+               }
        } else {
                TnyFolderStore *parent = tny_folder_get_folder_store (folder);
 
@@ -1607,7 +1631,13 @@ transfer_folder_status_cb (GObject *obj,
        priv->total = status->of_total;
 
        state = modest_mail_operation_clone_state (self);
+#ifdef TINYMAIL_IDLES_NOT_LOCKED_YET
+       gdk_threads_enter ();
+#endif
        g_signal_emit (G_OBJECT (self), signals[PROGRESS_CHANGED_SIGNAL], 0, state, NULL);
+#ifdef TINYMAIL_IDLES_NOT_LOCKED_YET
+       gdk_threads_leave ();
+#endif
        g_slice_free (ModestMailOperationState, state);
 }
 
@@ -1660,6 +1690,47 @@ transfer_folder_cb (TnyFolder *folder,
        g_slice_free   (XFerMsgAsyncHelper, helper);
 }
 
+/**
+ *
+ * This function checks if the new name is a valid name for our local
+ * folders account. The new name could not be the same than then name
+ * of any of the mandatory local folders
+ *
+ * We can not rely on tinymail because tinymail does not check the
+ * name of the virtual folders that the account could have in the case
+ * that we're doing a rename (because it directly calls Camel which
+ * knows nothing about our virtual folders). 
+ *
+ * In the case of an actual copy/move (i.e. move/copy a folder between
+ * accounts) tinymail uses the tny_folder_store_create_account which
+ * is reimplemented by our ModestTnyLocalFoldersAccount that indeed
+ * checks the new name of the folder, so this call in that case
+ * wouldn't be needed. *But* NOTE that if tinymail changes its
+ * implementation (if folder transfers within the same account is no
+ * longer implemented as a rename) this call will allow Modest to work
+ * perfectly
+ *
+ * If the new name is not valid, this function will set the status to
+ * failed and will set also an error in the mail operation
+ */
+static gboolean
+new_name_valid_if_local_account (ModestMailOperationPrivate *priv,
+                                TnyFolderStore *into,
+                                const gchar *new_name)
+{
+       if (TNY_IS_ACCOUNT (into) && 
+           modest_tny_account_is_virtual_local_folders (TNY_ACCOUNT (into)) &&
+           modest_tny_local_folders_account_extra_folder_exists (MODEST_TNY_LOCAL_FOLDERS_ACCOUNT (into),
+                                                                 new_name)) {
+               priv->status = MODEST_MAIL_OPERATION_STATUS_FAILED;
+               g_set_error (&(priv->error), MODEST_MAIL_OPERATION_ERROR,
+                            MODEST_MAIL_OPERATION_ERROR_FOLDER_RULES,
+                            _("FIXME: folder name already in use"));
+               return FALSE;
+       } else
+               return TRUE;
+}
+
 void
 modest_mail_operation_xfer_folder (ModestMailOperation *self,
                                   TnyFolder *folder,
@@ -1708,23 +1779,31 @@ modest_mail_operation_xfer_folder (ModestMailOperation *self,
                /* Notify the queue */
                modest_mail_operation_notify_end (self);
        } else {
-               /* Create the helper */
-               helper = g_slice_new0 (XFerMsgAsyncHelper);
-               helper->mail_op = g_object_ref(self);
-               helper->dest_folder = NULL;
-               helper->headers = NULL;
-               helper->user_callback = user_callback;
-               helper->user_data = user_data;
-               
-               /* Move/Copy folder */          
-               tny_folder_copy_async (folder,
-                                      parent,
-                                      tny_folder_get_name (folder),
-                                      delete_original,
-                                      transfer_folder_cb,
-                                      transfer_folder_status_cb,
-                                      helper);
-/*                                    self); */
+
+
+               /* Check that the new folder name is not used by any
+                  special local folder */
+               if (new_name_valid_if_local_account (priv, parent, 
+                                                    tny_folder_get_name (folder))) {
+                       /* Create the helper */
+                       helper = g_slice_new0 (XFerMsgAsyncHelper);
+                       helper->mail_op = g_object_ref(self);
+                       helper->dest_folder = NULL;
+                       helper->headers = NULL;
+                       helper->user_callback = user_callback;
+                       helper->user_data = user_data;
+                       
+                       /* Move/Copy folder */          
+                       tny_folder_copy_async (folder,
+                                              parent,
+                                              tny_folder_get_name (folder),
+                                              delete_original,
+                                              transfer_folder_cb,
+                                              transfer_folder_status_cb,
+                                              helper);
+               } else {
+                       modest_mail_operation_notify_end (self);
+               }
        }
 }
 
@@ -1767,25 +1846,30 @@ modest_mail_operation_rename_folder (ModestMailOperation *self,
        } else {
                TnyFolderStore *into;
 
-               /* Create the helper */
-               helper = g_slice_new0 (XFerMsgAsyncHelper);
-               helper->mail_op = g_object_ref(self);
-               helper->dest_folder = NULL;
-               helper->headers = NULL;
-               helper->user_callback = NULL;
-               helper->user_data = NULL;
-
-               /* Rename. Camel handles folder subscription/unsubscription */
-               into = tny_folder_get_folder_store (folder);
-               tny_folder_copy_async (folder, into, name, TRUE,
-                                transfer_folder_cb,
-                                transfer_folder_status_cb,
-                                helper);
-/*                              self); */
-               if (into)
-                       g_object_unref (into);          
+               into = tny_folder_get_folder_store (folder);    
+
+               /* Check that the new folder name is not used by any
+                  special local folder */
+               if (new_name_valid_if_local_account (priv, into, name)) {
+                       /* Create the helper */
+                       helper = g_slice_new0 (XFerMsgAsyncHelper);
+                       helper->mail_op = g_object_ref(self);
+                       helper->dest_folder = NULL;
+                       helper->headers = NULL;
+                       helper->user_callback = NULL;
+                       helper->user_data = NULL;
+               
+                       /* Rename. Camel handles folder subscription/unsubscription */
+                       tny_folder_copy_async (folder, into, name, TRUE,
+                                              transfer_folder_cb,
+                                              transfer_folder_status_cb,
+                                              helper);
+               } else {
+                       modest_mail_operation_notify_end (self);
+               }
+               g_object_unref (into);
        }
- }
+}
 
 /* ******************************************************************* */
 /* **************************  MSG  ACTIONS  ************************* */
@@ -2001,28 +2085,19 @@ get_msg_status_cb (GObject *obj,
        self = helper->mail_op;
        priv = MODEST_MAIL_OPERATION_GET_PRIVATE(self);
 
-       if(priv->status == MODEST_MAIL_OPERATION_STATUS_CANCELED) {
-               TnyFolder *folder = tny_header_get_folder (helper->header);
-               if (folder) {
-                       TnyAccount *account;
-                       account = tny_folder_get_account (folder);
-                       if (account) {
-                               tny_account_cancel (account);
-                               g_object_unref (account);
-                       }
-                       g_object_unref (folder);
-               }
-              
-               return;
-       }
-
        priv->done = 1;
        priv->total = 1;
 
        state = modest_mail_operation_clone_state (self);
        state->bytes_done = status->position;
        state->bytes_total = status->of_total;
+#ifdef TINYMAIL_IDLES_NOT_LOCKED_YET
+       gdk_threads_enter ();
+#endif
        g_signal_emit (G_OBJECT (self), signals[PROGRESS_CHANGED_SIGNAL], 0, state, NULL);
+#ifdef TINYMAIL_IDLES_NOT_LOCKED_YET
+       gdk_threads_leave ();
+#endif
        g_slice_free (ModestMailOperationState, state);
 }
 
@@ -2328,7 +2403,13 @@ transfer_msgs_status_cb (GObject *obj,
        priv->total = status->of_total;
 
        state = modest_mail_operation_clone_state (self);
+#ifdef TINYMAIL_IDLES_NOT_LOCKED_YET
+       gdk_threads_enter ();
+#endif
        g_signal_emit (G_OBJECT (self), signals[PROGRESS_CHANGED_SIGNAL], 0, state, NULL);
+#ifdef TINYMAIL_IDLES_NOT_LOCKED_YET
+       gdk_threads_leave ();
+#endif
        g_slice_free (ModestMailOperationState, state);
 }
 
@@ -2506,7 +2587,7 @@ on_refresh_folder (TnyFolder   *folder,
        }
 
        /* Free */
-       g_object_unref (helper->mail_op);
+/*     g_object_unref (helper->mail_op); */
        g_slice_free   (RefreshAsyncHelper, helper);
 
        /* Notify about operation end */
@@ -2537,7 +2618,13 @@ on_refresh_folder_status_update (GObject *obj,
        priv->total = status->of_total;
 
        state = modest_mail_operation_clone_state (self);
+#ifdef TINYMAIL_IDLES_NOT_LOCKED_YET
+       gdk_threads_enter ();
+#endif
        g_signal_emit (G_OBJECT (self), signals[PROGRESS_CHANGED_SIGNAL], 0, state, NULL);
+#ifdef TINYMAIL_IDLES_NOT_LOCKED_YET
+       gdk_threads_leave ();
+#endif
        g_slice_free (ModestMailOperationState, state);
 }
 
@@ -2559,7 +2646,7 @@ modest_mail_operation_refresh_folder  (ModestMailOperation *self,
 
        /* Create the helper */
        helper = g_slice_new0 (RefreshAsyncHelper);
-       helper->mail_op = g_object_ref(self);
+       helper->mail_op = g_object_ref (self);
        helper->user_callback = user_callback;
        helper->user_data = user_data;
 
@@ -2598,7 +2685,9 @@ modest_mail_operation_notify_end (ModestMailOperation *self)
                priv->account_name = NULL;
        }
        
-       /* Notify the observers about the mail opertation end */
+       /* Notify the observers about the mail operation end */
+       /* We do not wrapp this emission because we assume that this
+          function is always called from within the main lock */
        state = modest_mail_operation_clone_state (self);
        g_signal_emit (G_OBJECT (self), signals[PROGRESS_CHANGED_SIGNAL], 0, state, NULL);
        g_slice_free (ModestMailOperationState, state);