* add debugging code to the send-queue and the operations-queue;
[modest] / src / modest-tny-send-queue.c
index 17a7b25..5a0e150 100644 (file)
 #include <tny-iterator.h>
 #include <tny-folder.h>
 #include <tny-camel-msg.h>
+#include <tny-folder-change.h>
+#include <tny-folder-observer.h>
 #include <modest-tny-account.h>
+#include <modest-runtime.h>
+#include <modest-platform.h>
+#include <widgets/modest-window-mgr.h>
 #include <modest-marshal.h>
+#include <modest-debug.h>
 #include <string.h> /* strcmp */
 
 /* 'private'/'protected' functions */
@@ -43,12 +49,28 @@ static void modest_tny_send_queue_finalize   (GObject *obj);
 static void modest_tny_send_queue_instance_init (GTypeInstance *instance, gpointer g_class);
 
 /* Signal handlers */ 
-/* static void _on_msg_start_sending (TnySendQueue *self, TnyMsg *msg, gpointer user_data); */
-static void _on_msg_has_been_sent (TnySendQueue *self, TnyMsg *msg, gpointer user_data);
-static void _on_msg_error_happened (TnySendQueue *self, TnyHeader *header, TnyMsg *msg, GError *err, gpointer user_data);
-
-static TnyFolder*modest_tny_send_queue_get_outbox (TnySendQueue *self);
-static TnyFolder*modest_tny_send_queue_get_sentbox (TnySendQueue *self);
+static void _on_msg_start_sending (TnySendQueue *self, 
+                                  TnyHeader *header, 
+                                  TnyMsg *msg, 
+                                  int done, 
+                                  int total, 
+                                  gpointer user_data);
+
+static void _on_msg_has_been_sent (TnySendQueue *self, 
+                                  TnyHeader *header, 
+                                  TnyMsg *msg, 
+                                  int done, 
+                                  int total, 
+                                  gpointer user_data);
+
+static void _on_msg_error_happened (TnySendQueue *self, 
+                                   TnyHeader *header, 
+                                   TnyMsg *msg, 
+                                   GError *err, 
+                                   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 {
@@ -91,6 +113,8 @@ static guint signals[LAST_SIGNAL] = {0};
 static int
 on_modest_tny_send_queue_compare_id(gconstpointer info, gconstpointer msg_id)
 {
+       g_return_val_if_fail (info && ((SendInfo*)info)->msg_id && msg_id, -1);
+       
        return strcmp( ((SendInfo*)info)->msg_id, msg_id);
 }
 
@@ -101,12 +125,36 @@ modest_tny_send_queue_info_free(SendInfo *info)
        g_slice_free(SendInfo, info);
 }
 
+static void
+print_queue_item (gpointer data, gpointer user_data)
+{
+       SendInfo *info = (SendInfo*)data;
+       const gchar *status;
+       
+       switch (info->status) {
+       case MODEST_TNY_SEND_QUEUE_UNKNOWN: status = "UNKNOWN"; break;
+       case MODEST_TNY_SEND_QUEUE_WAITING: status = "WAITING"; break;
+       case MODEST_TNY_SEND_QUEUE_SUSPENDED: status = "SUSPENDED"; break;
+       case MODEST_TNY_SEND_QUEUE_SENDING: status = "SENDING"; break;
+       case MODEST_TNY_SEND_QUEUE_FAILED: status = "FAILED"; break;
+       default: status= "UNEXPECTED"; break;
+       }
+
+       g_debug ("\"%s\" => [%s]", info->msg_id, status);
+}
+
 static GList*
 modest_tny_send_queue_lookup_info (ModestTnySendQueue *self, const gchar *msg_id)
 {
        ModestTnySendQueuePrivate *priv;
        priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
 
+       MODEST_DEBUG_BLOCK (
+               g_debug ("items in the send queue (%d):",
+                        g_queue_get_length (priv->queue));
+               g_queue_foreach (priv->queue, print_queue_item, NULL);
+       );
+       
        return g_queue_find_custom (priv->queue, msg_id, on_modest_tny_send_queue_compare_id);
 }
 
@@ -115,6 +163,10 @@ 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)
@@ -130,7 +182,24 @@ modest_tny_send_queue_cancel (TnySendQueue *self, gboolean remove, GError **err)
        }
 
        /* Set flags to supend sending operaiton (if removed, this is not necessary) */
-       if (!remove) {
+       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();
@@ -138,38 +207,37 @@ modest_tny_send_queue_cancel (TnySendQueue *self, gboolean remove, GError **err)
                
        /* 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
-modest_tny_send_queue_add (TnySendQueue *self, TnyMsg *msg, GError **err)
+_on_added_to_outbox (TnySendQueue *self, gboolean cancelled, TnyMsg *msg, GError *err, gpointer user_data) 
 {
-       ModestTnySendQueuePrivate *priv;
-       TnyHeader *header;
+       ModestTnySendQueuePrivate *priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE(self);
+       TnyHeader *header = NULL;
        SendInfo *info = NULL;
-       GList* existing;
-       const gchar* msg_id;
+       GList* existing = NULL;
+       const gchar* msg_id = NULL;
 
        g_return_if_fail (TNY_IS_SEND_QUEUE(self));
        g_return_if_fail (TNY_IS_CAMEL_MSG(msg));
 
-       priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
        header = tny_msg_get_header (msg);
-
-       /* FIXME: do something smart here... */
-
-       /* Note that this call actually sets the message id to something
-        * sensible. */ 
-       TNY_CAMEL_SEND_QUEUE_CLASS(parent_class)->add_func (self, msg, err); /* FIXME */
-
-       /* Check whether the mail is already in the queue */
+       msg_id = modest_tny_send_queue_get_msg_id (header);
 /*     msg_id = tny_header_get_message_id (header); */
-       msg_id = tny_header_get_uid (header);
+       g_return_if_fail(msg_id != NULL);
+
+       /* Put newly added message in WAITING state */
        existing = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE(self), msg_id);
        if(existing != NULL)
        {
-               //g_assert(info->status == MODEST_TNY_SEND_QUEUE_SUSPENDED ||
-               //        info->status == MODEST_TNY_SEND_QUEUE_FAILED);
-
                info = existing->data;
                info->status = MODEST_TNY_SEND_QUEUE_WAITING;
        }
@@ -184,16 +252,34 @@ modest_tny_send_queue_add (TnySendQueue *self, TnyMsg *msg, GError **err)
        }
 
        g_signal_emit (self, signals[STATUS_CHANGED], 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)
 {
+       ModestWindowMgr *mgr = NULL;
        ModestTnySendQueuePrivate *priv;
        SendInfo *info = NULL;
        GList* existing = NULL;
        gchar* msg_uid = NULL;
-       ModestTnySendQueueStatus status = MODEST_TNY_SEND_QUEUE_WAITING;
+       ModestTnySendQueueStatus status = MODEST_TNY_SEND_QUEUE_UNKNOWN;
+       gboolean editing = FALSE;
 
        g_return_if_fail (TNY_IS_SEND_QUEUE(self));
        g_return_if_fail (TNY_IS_HEADER(header));
@@ -203,13 +289,21 @@ _add_message (ModestTnySendQueue *self, TnyHeader *header)
        msg_uid = modest_tny_send_queue_get_msg_id (header);
        status = modest_tny_send_queue_get_msg_status (self, msg_uid);
        switch (status) {
-       case MODEST_TNY_SEND_QUEUE_UNKNONW:
+       case MODEST_TNY_SEND_QUEUE_UNKNOWN:
        case MODEST_TNY_SEND_QUEUE_SUSPENDED:
        case MODEST_TNY_SEND_QUEUE_FAILED:
-               tny_header_unset_flags (header, TNY_HEADER_FLAG_PRIORITY);
+
+               /* Check if it already exists on queue */
                existing = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE(self), msg_uid);
-               if(existing != NULL) return;
-       
+               if(existing != NULL)
+                       break;
+               
+               /* Check if its being edited */
+               mgr = modest_runtime_get_window_mgr ();
+               editing = modest_window_mgr_find_registered_header (mgr, header, NULL);
+               if (editing)
+                       break;
+               
                /* Add new meesage info */
                info = g_slice_new (SendInfo);
                info->msg_id = strdup(msg_uid);
@@ -217,11 +311,10 @@ _add_message (ModestTnySendQueue *self, TnyHeader *header)
                g_queue_push_tail (priv->queue, info);
                break;
        default:
-               goto frees;
+               break;
        }
 
        /* Free */
- frees:
        g_free(msg_uid);
 }
 
@@ -290,6 +383,7 @@ modest_tny_send_queue_get_type (void)
                        (GInstanceInitFunc) modest_tny_send_queue_instance_init,
                        NULL
                };
+               
                my_type = g_type_register_static (TNY_TYPE_CAMEL_SEND_QUEUE,
                                                  "ModestTnySendQueue",
                                                  &my_info, 0);
@@ -308,7 +402,6 @@ 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)->add_func         = modest_tny_send_queue_add;
        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;
@@ -362,14 +455,9 @@ modest_tny_send_queue_new (TnyCamelTransportAccount *account)
                                                    account); 
 
        /* Connect signals to control when a msg is being or has been sent */
-       /* TODO: this signal was implemented in tinymail camel send queue, but im
-          waiting for implement some unit tests nbefore commited changes */
-/*     if (FALSE) { */
-/*             g_signal_connect (G_OBJECT(self), "msg-sending", */
-/*                               G_CALLBACK(_on_msg_start_sending),  */
-/*                               NULL); */
-/*     } */
-                         
+       g_signal_connect (G_OBJECT(self), "msg-sending",
+                         G_CALLBACK(_on_msg_start_sending),
+                         NULL);                          
        g_signal_connect (G_OBJECT(self), "msg-sent",
                          G_CALLBACK(_on_msg_has_been_sent), 
                          NULL);
@@ -391,22 +479,34 @@ modest_tny_send_queue_try_to_send (ModestTnySendQueue* self)
        GError *err = NULL;
 
        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;
+       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));          
-               _add_message (self, header); 
+               header = TNY_HEADER (tny_iterator_get_current (iter));
+               if (header) {   
+                       _add_message (self, header); 
+                       g_object_unref (header);
+               }
+
                tny_iterator_next (iter);
-               g_object_unref (header);
        }
        
        /* Flush send queue */
        tny_camel_send_queue_flush (TNY_CAMEL_SEND_QUEUE(self));
 
  frees:
-       g_object_unref (G_OBJECT (headers));
-       g_object_unref (G_OBJECT (outbox));
+       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);
 }
 
 gboolean
@@ -435,91 +535,103 @@ modest_tny_send_queue_get_msg_status (ModestTnySendQueue *self, const gchar *msg
 {
   GList *item;
   item = modest_tny_send_queue_lookup_info (self, msg_id);
-  if(item == NULL) return MODEST_TNY_SEND_QUEUE_UNKNONW;
+  if(item == NULL) return MODEST_TNY_SEND_QUEUE_UNKNOWN;
   return ((SendInfo*)item->data)->status;
 }
 
 gchar *
 modest_tny_send_queue_get_msg_id (TnyHeader *header)
 {
-       const gchar *uid = NULL;
        gchar* msg_uid = NULL;
-       gchar **tmp = NULL;
+       const gchar *subject;
+       time_t date_received;
                
        /* Get message uid */
-       uid = tny_header_get_uid (header);
-       tmp = g_strsplit (uid, "__", 2);
-       if (tmp[1] != NULL) 
-               msg_uid = g_strconcat (tmp[0], "_", NULL);
-       else 
-               msg_uid = g_strdup(tmp[0]);
+       subject = tny_header_get_subject (header);
+       date_received = tny_header_get_date_received (header);
 
-       /* free */
-       g_strfreev(tmp);
+       msg_uid = g_strdup_printf ("%s %d", subject, (int) date_received);
 
        return msg_uid;
 }
 
 
-/* static void  */
-/* _on_msg_start_sending (TnySendQueue *self, */
-/*                    TnyMsg *msg, */
-/*                    gpointer user_data) */
-/* { */
-/*     ModestTnySendQueuePrivate *priv; */
-/*     TnyHeader *header; */
-/*     GList *item; */
-/*     SendInfo *info; */
-
-/*     priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self); */
-
-/*     header = tny_msg_get_header(msg); */
-/*     item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), tny_header_get_message_id (header)); */
+static void
+_on_msg_start_sending (TnySendQueue *self,
+                      TnyHeader *header,
+                      TnyMsg *msg,
+                      int done, 
+                      int total,
+                      gpointer user_data)
+{
+       ModestTnySendQueuePrivate *priv = NULL;
+       GList *item = NULL;
+       SendInfo *info = NULL;
+       gchar *msg_id = NULL;
 
-/*     if (item != NULL) */
-/*     { */
-/*             info = item->data; */
-/*             info->status = MODEST_TNY_SEND_QUEUE_SENDING; */
+       priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
+       
+       /* Get message uid */
+       msg_id = modest_tny_send_queue_get_msg_id (header);
 
-/*             g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status); */
-/*     } */
+       /* 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 {
+               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);
+               priv->current = item;
+       }
 
-/*     priv->current = item; */
-/* } */
+       /* free */
+       g_free (msg_id);
+}
 
 static void 
 _on_msg_has_been_sent (TnySendQueue *self,
+                      TnyHeader *header,
                       TnyMsg *msg, 
+                      int done, 
+                      int total,
                       gpointer user_data)
 {
        ModestTnySendQueuePrivate *priv;
-       TnyHeader *header;
+       gchar *msg_id = NULL;
        GList *item;
-
        priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
 
-       header = tny_msg_get_header (msg);
+       /* Get message uid */
+       msg_id = modest_tny_send_queue_get_msg_id (header);
 
-       /* TODO: Use this version as soon as the msg-sending
-        *  notification works */
-#if 0
-       item = priv->current;
-       g_assert(item != NULL);
-#else
-       item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), tny_header_get_message_id(header));
-       g_assert(item != NULL);
-#endif
-
-       modest_tny_send_queue_info_free (item->data);
-       g_queue_delete_link (priv->queue, item);
-       priv->current = NULL;
+       tny_header_set_flag (header, TNY_HEADER_FLAG_SEEN);
+
+       /* Get status info */
+       item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), msg_id);
+       if (item) {
+               
+               /* Remove status info */
+               modest_tny_send_queue_info_free (item->data);
+               g_queue_delete_link (priv->queue, item);
+               priv->current = NULL;
+               
+               modest_platform_information_banner (NULL, NULL, _("mcen_ib_message_sent"));
+       }
+
+       /* free */
+       g_free(msg_id);
 }
 
-static void _on_msg_error_happened (TnySendQueue *self,
-                                    TnyHeader *header,
-                                   TnyMsg *msg,
-                                   GError *err,
-                                   gpointer user_data)
+static void 
+_on_msg_error_happened (TnySendQueue *self,
+                       TnyHeader *header,
+                       TnyMsg *msg,
+                       GError *err,
+                       gpointer user_data)
 {
        ModestTnySendQueuePrivate *priv = NULL;
        SendInfo *info = NULL;
@@ -534,16 +646,15 @@ static void _on_msg_error_happened (TnySendQueue *self,
                                                  msg_uid);     
        if (item == NULL) {
                info = g_slice_new (SendInfo);
-               info->msg_id = strdup(msg_uid);
+               info->msg_id = (msg_uid != NULL)? strdup(msg_uid) : NULL;
                g_queue_push_tail (priv->queue, info);
-       }
-       else {
+       } 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;
+       priv->current = NULL;
        
        /* Notify status has changed */
        g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
@@ -551,3 +662,72 @@ static void _on_msg_error_happened (TnySendQueue *self,
        /* free */
        g_free(msg_uid);
 }
+
+static void 
+fill_list_of_caches (gpointer key, gpointer value, gpointer userdata)
+{
+       GSList **send_queues = (GSList **) userdata;
+       *send_queues = g_slist_prepend (*send_queues, value);
+}
+
+ModestTnySendQueueStatus
+modest_tny_all_send_queues_get_msg_status (TnyHeader *header)
+{
+       ModestCacheMgr *cache_mgr = NULL;
+       GHashTable     *send_queue_cache = NULL;
+       ModestTnyAccountStore *accounts_store = NULL;
+       TnyList *accounts = NULL;
+       TnyIterator *iter = NULL;
+       TnyTransportAccount *account = NULL;
+       GSList *send_queues = NULL, *node;
+       /* get_msg_status returns suspended by default, so we want to detect changes */
+       ModestTnySendQueueStatus status = MODEST_TNY_SEND_QUEUE_UNKNOWN;
+       ModestTnySendQueueStatus queue_status = MODEST_TNY_SEND_QUEUE_UNKNOWN;
+       gchar *msg_uid = NULL;
+       ModestTnySendQueue *send_queue = NULL;
+       
+       msg_uid = modest_tny_send_queue_get_msg_id (header);
+       cache_mgr = modest_runtime_get_cache_mgr ();
+       send_queue_cache = modest_cache_mgr_get_cache (cache_mgr,
+                                                      MODEST_CACHE_MGR_CACHE_TYPE_SEND_QUEUE);
+       
+       g_hash_table_foreach (send_queue_cache, (GHFunc) fill_list_of_caches, &send_queues);
+       if (send_queues == NULL) {
+               accounts = tny_simple_list_new (); 
+               accounts_store = modest_runtime_get_account_store ();
+               tny_account_store_get_accounts (TNY_ACCOUNT_STORE(accounts_store), 
+                                               accounts, 
+                                               TNY_ACCOUNT_STORE_TRANSPORT_ACCOUNTS);
+               
+               iter = tny_list_create_iterator (accounts);
+               while (!tny_iterator_is_done (iter)) {                  
+                       account = TNY_TRANSPORT_ACCOUNT(tny_iterator_get_current (iter));
+                       send_queue = modest_runtime_get_send_queue(TNY_TRANSPORT_ACCOUNT(account));
+                       g_object_unref(account);
+
+                       queue_status = modest_tny_send_queue_get_msg_status (send_queue, msg_uid);
+                       if (queue_status != MODEST_TNY_SEND_QUEUE_UNKNOWN) {
+                               status = queue_status;
+                               break;
+                       }
+                       tny_iterator_next (iter);
+               }
+               g_object_unref (iter);
+               g_object_unref (accounts);
+       }
+       else {
+               for (node = send_queues; node != NULL; node = g_slist_next (node)) {
+                       send_queue = MODEST_TNY_SEND_QUEUE (node->data);
+                       
+                       queue_status = modest_tny_send_queue_get_msg_status (send_queue, msg_uid);
+                       if (queue_status != MODEST_TNY_SEND_QUEUE_UNKNOWN) {
+                               status = queue_status;
+                               break;
+                       }
+               }
+       }
+
+       g_free(msg_uid);
+       g_slist_free (send_queues);
+       return status;
+}