* Fixes NB#81719, modest is no longer crashing when the send queue notifies errors...
[modest] / src / modest-tny-send-queue.c
index 42823a4..480d4ea 100644 (file)
@@ -32,6 +32,7 @@
 #include <tny-simple-list.h>
 #include <tny-iterator.h>
 #include <tny-folder.h>
+#include <tny-error.h>
 #include <tny-camel-msg.h>
 #include <tny-folder-change.h>
 #include <tny-folder-observer.h>
@@ -69,14 +70,21 @@ static void _on_msg_error_happened (TnySendQueue *self,
                                    GError *err, 
                                    gpointer user_data);
 
+static void _on_queue_start        (TnySendQueue *self, 
+                                   gpointer user_data);
+
+static void modest_tny_send_queue_add_async (TnySendQueue *self, 
+                                            TnyMsg *msg, 
+                                            TnySendQueueAddCallback callback, 
+                                            TnyStatusCallback status_callback, 
+                                            gpointer user_data);
+
 static TnyFolder* modest_tny_send_queue_get_outbox  (TnySendQueue *self);
 static TnyFolder* modest_tny_send_queue_get_sentbox (TnySendQueue *self);
 
 /* list my signals  */
 enum {
-       STATUS_CHANGED,
-       /* MY_SIGNAL_1, */
-       /* MY_SIGNAL_2, */
+       STATUS_CHANGED_SIGNAL,
        LAST_SIGNAL
 };
 
@@ -93,6 +101,10 @@ struct _ModestTnySendQueuePrivate {
 
        /* The info that is currently being sent */
        GList* current;
+
+       /* Special folders */
+       TnyFolder *outbox;
+       TnyFolder *sentbox;
 };
 
 #define MODEST_TNY_SEND_QUEUE_GET_PRIVATE(o)      (G_TYPE_INSTANCE_GET_PRIVATE((o), \
@@ -178,66 +190,10 @@ modest_tny_send_queue_to_string (ModestTnySendQueue *self)
 }
 
 static void
-modest_tny_send_queue_cancel (TnySendQueue *self, gboolean remove, GError **err)
-{
-       ModestTnySendQueuePrivate *priv;
-       SendInfo *info;
-       TnyIterator *iter = NULL;
-       TnyFolder *outbox = NULL;
-       TnyList *headers = tny_simple_list_new ();
-       TnyHeader *header = NULL;
-
-       priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
-       if(priv->current != NULL)
-       {
-               info = priv->current->data;
-               priv->current = NULL;
-
-               /* Keep in list until retry, so that we know that this was suspended
-                * by the user and not by an error. */
-               info->status = MODEST_TNY_SEND_QUEUE_SUSPENDED;
-
-               g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
-       }
-
-       /* Set flags to supend sending operaiton (if removed, this is not necessary) */
-       if (!remove) {          
-               outbox = modest_tny_send_queue_get_outbox (TNY_SEND_QUEUE(self));
-               if (!outbox) {
-                       g_warning ("%s: modest_tny_send_queue_get_outbox(..) returned NULL\n", __FUNCTION__);
-                       goto frees;
-               }
-               tny_folder_get_headers (outbox, headers, TRUE, err);
-               if (err != NULL) goto frees;
-               iter = tny_list_create_iterator (headers);
-               while (!tny_iterator_is_done (iter)) {
-                       header = TNY_HEADER (tny_iterator_get_current (iter));
-                       if (header) {
-                               tny_header_set_flag (header, TNY_HEADER_FLAG_SUSPENDED);
-                               tny_iterator_next (iter);
-                               g_object_unref (header);
-                       }
-               }
-               
-               g_queue_foreach (priv->queue, (GFunc)modest_tny_send_queue_info_free, NULL);
-               g_queue_free (priv->queue);
-               priv->queue = g_queue_new();
-       }
-               
-       /* Dont call super class implementaiton, becasue camel removes messages from outbox */
-       TNY_CAMEL_SEND_QUEUE_CLASS(parent_class)->cancel_func (self, remove, err); /* FIXME */
-
- frees:
-       if (headers != NULL)
-               g_object_unref (G_OBJECT (headers));
-       if (outbox != NULL) 
-               g_object_unref (G_OBJECT (outbox));
-       if (iter != NULL) 
-               g_object_unref (iter);
-}
-
-static void
-_on_added_to_outbox (TnySendQueue *self, gboolean cancelled, TnyMsg *msg, GError *err,
+_on_added_to_outbox (TnySendQueue *self, 
+                    gboolean cancelled, 
+                    TnyMsg *msg, 
+                    GError *err,
                     gpointer user_data) 
 {
        ModestTnySendQueuePrivate *priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE(self);
@@ -251,7 +207,6 @@ _on_added_to_outbox (TnySendQueue *self, gboolean cancelled, TnyMsg *msg, GError
 
        header = tny_msg_get_header (msg);
        msg_id = modest_tny_send_queue_get_msg_id (header);
-/*     msg_id = tny_header_get_message_id (header); */
        g_return_if_fail(msg_id != NULL);
 
        /* Put newly added message in WAITING state */
@@ -266,25 +221,11 @@ _on_added_to_outbox (TnySendQueue *self, gboolean cancelled, TnyMsg *msg, GError
                g_queue_push_tail (priv->queue, info);
        }
 
-       g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
+       g_signal_emit (self, signals[STATUS_CHANGED_SIGNAL], 0, info->msg_id, info->status);
 
        g_object_unref(G_OBJECT(header));
 }
 
-void
-modest_tny_send_queue_add (ModestTnySendQueue *self, TnyMsg *msg, GError **err)
-{
-       g_return_if_fail (MODEST_IS_TNY_SEND_QUEUE(self));
-       g_return_if_fail (TNY_IS_CAMEL_MSG(msg));
-
-       tny_camel_send_queue_add_async (TNY_CAMEL_SEND_QUEUE(self), 
-                                       msg, 
-                                       _on_added_to_outbox, 
-                                       NULL, 
-                                       NULL);
-}
-
-
 static void
 _add_message (ModestTnySendQueue *self, TnyHeader *header)
 {
@@ -333,51 +274,41 @@ _add_message (ModestTnySendQueue *self, TnyHeader *header)
        g_free(msg_uid);
 }
 
+static void 
+modest_tny_send_queue_add_async (TnySendQueue *self, 
+                                TnyMsg *msg, 
+                                TnySendQueueAddCallback callback, 
+                                TnyStatusCallback status_callback, 
+                                gpointer user_data)
+{
+       /* Call the superclass passing our own callback */
+       TNY_CAMEL_SEND_QUEUE_CLASS(parent_class)->add_async (self, msg, _on_added_to_outbox, NULL, NULL);
+}
+
+
 static TnyFolder*
 modest_tny_send_queue_get_sentbox (TnySendQueue *self)
 {
-       TnyFolder *folder;
-       TnyCamelTransportAccount *account;
+       ModestTnySendQueuePrivate *priv;
 
        g_return_val_if_fail (self, NULL);
 
-       account = tny_camel_send_queue_get_transport_account (TNY_CAMEL_SEND_QUEUE(self));
-       if (!account) {
-               g_printerr ("modest: no account for send queue\n");
-               return NULL;
-       }
-       folder  = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
-                                                        TNY_FOLDER_TYPE_SENT);
-       g_object_unref (G_OBJECT(account));
+       priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
 
-       return folder;
+       return g_object_ref (priv->sentbox);
 }
 
 
 static TnyFolder*
 modest_tny_send_queue_get_outbox (TnySendQueue *self)
 {
-       TnyFolder *folder;
-       TnyCamelTransportAccount *account;
+       ModestTnySendQueuePrivate *priv;
 
        g_return_val_if_fail (self, NULL);
 
-       account = tny_camel_send_queue_get_transport_account (TNY_CAMEL_SEND_QUEUE(self));
-       if (!account) {
-               g_printerr ("modest: no account for send queue\n");
-               return NULL;
-       }
-       folder  = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
-                                                        TNY_FOLDER_TYPE_OUTBOX);
-
-       /* This vfunc's tinymail contract does not allow it to return NULL. */
-       if (!folder) {
-               g_warning("%s: Returning NULL.\n", __FUNCTION__);
-       }
-
-       g_object_unref (G_OBJECT(account));
+       priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
 
-       return folder;
+       return g_object_ref (priv->outbox);
 }
 
 GType
@@ -417,12 +348,12 @@ modest_tny_send_queue_class_init (ModestTnySendQueueClass *klass)
        parent_class            = g_type_class_peek_parent (klass);
        gobject_class->finalize = modest_tny_send_queue_finalize;
 
-       TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_outbox_func  = modest_tny_send_queue_get_outbox;
-        TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_sentbox_func = modest_tny_send_queue_get_sentbox;
-        TNY_CAMEL_SEND_QUEUE_CLASS(klass)->cancel_func      = modest_tny_send_queue_cancel;
+       TNY_CAMEL_SEND_QUEUE_CLASS(klass)->add_async   = modest_tny_send_queue_add_async;
+       TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_outbox  = modest_tny_send_queue_get_outbox;
+        TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_sentbox = modest_tny_send_queue_get_sentbox;
        klass->status_changed   = NULL;
 
-       signals[STATUS_CHANGED] =
+       signals[STATUS_CHANGED_SIGNAL] =
                g_signal_new ("status_changed",
                              G_TYPE_FROM_CLASS (gobject_class),
                              G_SIGNAL_RUN_FIRST,
@@ -454,21 +385,24 @@ modest_tny_send_queue_finalize (GObject *obj)
        g_queue_foreach (priv->queue, (GFunc)modest_tny_send_queue_info_free, NULL);
        g_queue_free (priv->queue);
 
+       g_object_unref (priv->outbox);
+       g_object_unref (priv->sentbox);
+
        G_OBJECT_CLASS(parent_class)->finalize (obj);
 }
 
 ModestTnySendQueue*
 modest_tny_send_queue_new (TnyCamelTransportAccount *account)
 {
-       ModestTnySendQueue *self;
+       ModestTnySendQueue *self = NULL;
+       ModestTnySendQueuePrivate *priv = NULL;
+       TnyIterator *iter = NULL;
+       TnyList *headers = NULL;
        
        g_return_val_if_fail (TNY_IS_CAMEL_TRANSPORT_ACCOUNT(account), NULL);
        
        self = MODEST_TNY_SEND_QUEUE(g_object_new(MODEST_TYPE_TNY_SEND_QUEUE, NULL));
        
-       tny_camel_send_queue_set_transport_account (TNY_CAMEL_SEND_QUEUE(self),
-                                                   account); 
-
        /* Connect signals to control when a msg is being or has been sent */
        g_signal_connect (G_OBJECT(self), "msg-sending",
                          G_CALLBACK(_on_msg_start_sending),
@@ -479,51 +413,45 @@ modest_tny_send_queue_new (TnyCamelTransportAccount *account)
        g_signal_connect (G_OBJECT(self), "error-happened",
                          G_CALLBACK(_on_msg_error_happened),
                          NULL);
-       return self;
-}
-
-
+       g_signal_connect (G_OBJECT (self), "queue-start",
+                         G_CALLBACK (_on_queue_start),
+                         NULL);
 
-void
-modest_tny_send_queue_try_to_send (ModestTnySendQueue* self)
-{
-       TnyIterator *iter = NULL;
-       TnyFolder *outbox = NULL;
-       TnyList *headers = tny_simple_list_new ();
-       TnyHeader *header = NULL;
-       GError *err = NULL;
+       /* Set outbox and sentbox */
+       priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
+       priv->outbox  = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
+                                                              TNY_FOLDER_TYPE_OUTBOX);
+       priv->sentbox = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
+                                                              TNY_FOLDER_TYPE_SENT);
 
-       g_return_if_fail (MODEST_IS_TNY_SEND_QUEUE(self));
-       
-       outbox = modest_tny_send_queue_get_outbox (TNY_SEND_QUEUE(self));
-       if (!outbox)
-               return;
 
-       tny_folder_get_headers (outbox, headers, TRUE, &err);
-       if (err != NULL) 
-               goto frees;
+       headers = tny_simple_list_new ();       
+       tny_folder_get_headers (priv->outbox, headers, TRUE, NULL);
 
+       /* Add messages to our internal queue */
        iter = tny_list_create_iterator (headers);
        while (!tny_iterator_is_done (iter)) {
-               header = TNY_HEADER (tny_iterator_get_current (iter));
-               if (header) {   
-                       _add_message (self, header); 
-                       g_object_unref (header);
-               }
+               TnyHeader *header = TNY_HEADER (tny_iterator_get_current (iter));
+               _add_message (self, header); 
+               g_object_unref (header);                
 
                tny_iterator_next (iter);
        }
-       
-       /* Flush send queue */
-       tny_camel_send_queue_flush (TNY_CAMEL_SEND_QUEUE(self));
-
- frees:
-       if (headers != NULL)
-               g_object_unref (G_OBJECT (headers));
-       if (outbox != NULL) 
-               g_object_unref (G_OBJECT (outbox));
-       if (iter != NULL) 
-               g_object_unref (iter);
+
+       /* Reenable suspended items */
+       modest_tny_send_queue_wakeup (self);
+
+       /* Frees */
+       g_object_unref (headers);
+       g_object_unref (iter);
+
+       /* Do this at the end, because it'll call tny_send_queue_flush
+          which will call tny_send_queue_get_outbox and
+          tny_send_queue_get_sentbox */
+       tny_camel_send_queue_set_transport_account (TNY_CAMEL_SEND_QUEUE(self),
+                                                   account); 
+
+       return self;
 }
 
 gboolean
@@ -585,12 +513,8 @@ modest_tny_send_queue_get_msg_id (TnyHeader *header)
 
 
 static void
-_on_msg_start_sending (TnySendQueue *self,
-                      TnyHeader *header,
-                      TnyMsg *msg,
-                      int done, 
-                      int total,
-                      gpointer user_data)
+_on_msg_start_sending (TnySendQueue *self, TnyHeader *header,
+                      TnyMsg *msg, int done, int total, gpointer user_data)
 {
        ModestTnySendQueuePrivate *priv = NULL;
        GList *item = NULL;
@@ -601,21 +525,20 @@ _on_msg_start_sending (TnySendQueue *self,
        
        /* Get message uid */
        msg_id = modest_tny_send_queue_get_msg_id (header);
-
-       /* Get status info */
-       item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), msg_id);
-       if (!item) 
-               g_warning  ("%s: item (%s) should not be NULL",
-                           __FUNCTION__, msg_id ? msg_id : "<none>");
-       else {
+       if (msg_id) 
+               item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), msg_id);
+       else
+               g_warning ("%s: could not get msg-id for header", __FUNCTION__);
+       
+       if (item) {
+               /* Set current status item */
                info = item->data;
                info->status = MODEST_TNY_SEND_QUEUE_SENDING;
-               
-               /* Set current status item */
-               g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
+               g_signal_emit (self, signals[STATUS_CHANGED_SIGNAL], 0, info->msg_id, info->status);
                priv->current = item;
-       }
-
+       } else
+               g_warning ("%s: could not find item with id '%s'", __FUNCTION__, msg_id);
+       
        /* free */
        g_free (msg_id);
 }
@@ -641,8 +564,13 @@ _on_msg_has_been_sent (TnySendQueue *self,
 
        /* Get status info */
        item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), msg_id);
+
+
+       /* TODO: note that item=NULL must not happen, but I found that
+          tinymail is issuing the message-sent signal twice, because
+          tny_camel_send_queue_update is called twice for each
+          message sent. This must be fixed in tinymail. Sergio */
        if (item) {
-               
                /* Remove status info */
                modest_tny_send_queue_info_free (item->data);
                g_queue_delete_link (priv->queue, item);
@@ -663,33 +591,52 @@ _on_msg_error_happened (TnySendQueue *self,
                        gpointer user_data)
 {
        ModestTnySendQueuePrivate *priv = NULL;
-       SendInfo *info = NULL;
-       GList *item = NULL;
-       gchar* msg_uid = NULL;
        
        priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
-       
-       /* Get sending info (create new if it doesn not exist) */
-       msg_uid = modest_tny_send_queue_get_msg_id (header);
-       item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), 
-                                                 msg_uid);     
-       if (item == NULL) {
-               info = g_slice_new (SendInfo);
-               info->msg_id = (msg_uid != NULL)? strdup(msg_uid) : NULL;
-               g_queue_push_tail (priv->queue, info);
-       } else
-               info = item->data;
 
        /* Keep in queue so that we remember that the opertion has failed */
        /* and was not just cancelled */
-       info->status = MODEST_TNY_SEND_QUEUE_FAILED;
+       if (err->code == TNY_SYSTEM_ERROR_CANCEL)
+               info->status = MODEST_TNY_SEND_QUEUE_SUSPENDED;
+       else
+               info->status = MODEST_TNY_SEND_QUEUE_FAILED;
        priv->current = NULL;
-       
-       /* Notify status has changed */
-       g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
 
-       /* free */
-       g_free(msg_uid);
+       /* Note that header could be NULL. Tinymail notifies about
+          generic send queue errors with this signal as well, and
+          those notifications are not bound to any particular header
+          or message */
+       if (header) {
+               SendInfo *info = NULL;
+               GList *item = NULL;
+               gchar* msg_uid = NULL;
+
+               /* Get sending info (create new if it doesn not exist) */
+               msg_uid = modest_tny_send_queue_get_msg_id (header);
+               item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), 
+                                                         msg_uid);     
+               
+               info = item->data;
+               
+               /* Notify status has changed */
+               g_signal_emit (self, signals[STATUS_CHANGED_SIGNAL], 0, info->msg_id, info->status);
+
+               /* free */
+               g_free(msg_uid);
+       }
+}
+
+static void 
+_on_queue_start (TnySendQueue *self,
+                gpointer data)
+{
+       ModestMailOperation *mail_op;
+
+       mail_op = modest_mail_operation_new (NULL);
+       modest_mail_operation_queue_add (modest_runtime_get_mail_operation_queue (),
+                                        mail_op);
+       modest_mail_operation_run_queue (mail_op, MODEST_TNY_SEND_QUEUE (self));
+       g_object_unref (mail_op);
 }
 
 static void 
@@ -699,6 +646,7 @@ fill_list_of_caches (gpointer key, gpointer value, gpointer userdata)
        *send_queues = g_slist_prepend (*send_queues, value);
 }
 
+/* This function shouldn't be here. Move it to another place. Sergio */
 ModestTnySendQueueStatus
 modest_tny_all_send_queues_get_msg_status (TnyHeader *header)
 {
@@ -762,3 +710,54 @@ modest_tny_all_send_queues_get_msg_status (TnyHeader *header)
        g_slist_free (send_queues);
        return status;
 }
+
+void   
+modest_tny_send_queue_wakeup (ModestTnySendQueue *self)
+{
+       ModestTnySendQueuePrivate *priv;
+       TnyList *headers;
+       TnyIterator *iter;
+
+       g_return_if_fail (MODEST_IS_TNY_SEND_QUEUE (self));
+
+       priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
+
+       headers = tny_simple_list_new ();
+       tny_folder_get_headers (priv->outbox, headers, TRUE, NULL);
+
+       /* Wake up every single suspended header */
+       iter = tny_list_create_iterator (headers);
+       while (!tny_iterator_is_done (iter)) {
+               TnyHeader *header = TNY_HEADER (tny_iterator_get_current (iter));
+
+               if (tny_header_get_flags (header) & TNY_HEADER_FLAG_SUSPENDED) {
+                       gchar *msg_id;
+                       GList *item;
+                       SendInfo *info;
+
+                       /* Unset the suspended flag */
+                       tny_header_unset_flag (header, TNY_HEADER_FLAG_SUSPENDED);
+
+                       /* Notify view */
+                       msg_id = modest_tny_send_queue_get_msg_id (header);                     
+                       item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), msg_id);
+                       info = (SendInfo *) item->data;
+                       info->status = MODEST_TNY_SEND_QUEUE_WAITING;
+                       g_signal_emit (self, signals[STATUS_CHANGED_SIGNAL], 0, info->msg_id, info->status);
+                       
+                       /* Frees */
+                       g_free (msg_id);
+               }
+
+               /* Frees */
+               g_object_unref (header);
+               tny_iterator_next (iter);
+       }
+
+       /* Make changes persistent on disk */
+       tny_folder_sync_async (priv->outbox, FALSE, NULL, NULL, NULL);
+
+       /* Frees */
+       g_object_unref (iter);
+       g_object_unref (G_OBJECT (headers));
+}