X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-mail-operation-queue.c;h=720e66841f00a49973f3606462fa0921c12238ca;hp=7bf680bc813f3c1e41382f292e73b66025cf39f3;hb=e374da56f67092cecb1572dd4bee2ca34e0bc04c;hpb=cd1ae71abedf78491c1f34d1fb1a772064d87b8e diff --git a/src/modest-mail-operation-queue.c b/src/modest-mail-operation-queue.c index 7bf680b..720e668 100644 --- a/src/modest-mail-operation-queue.c +++ b/src/modest-mail-operation-queue.c @@ -31,6 +31,7 @@ #include "modest-marshal.h" #include "modest-mail-operation-queue.h" #include "modest-runtime.h" +#include "modest-debug.h" /* 'private'/'protected' functions */ static void modest_mail_operation_queue_class_init (ModestMailOperationQueueClass *klass); @@ -38,13 +39,13 @@ static void modest_mail_operation_queue_init (ModestMailOperationQueue *ob static void modest_mail_operation_queue_finalize (GObject *obj); static void -on_progress_changed (ModestMailOperation *mail_op, - ModestMailOperationState *state, - gpointer user_data); +on_operation_finished (ModestMailOperation *mail_op, + gpointer user_data); /* list my signals */ enum { QUEUE_CHANGED_SIGNAL, + QUEUE_EMPTY_SIGNAL, NUM_SIGNALS }; @@ -53,6 +54,8 @@ struct _ModestMailOperationQueuePrivate { GQueue *op_queue; GMutex *queue_lock; guint op_id; + guint queue_empty_handler; + gboolean running_final_sync; }; #define MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \ MODEST_TYPE_MAIL_OPERATION_QUEUE, \ @@ -116,6 +119,23 @@ modest_mail_operation_queue_class_init (ModestMailOperationQueueClass *klass) NULL, NULL, modest_marshal_VOID__POINTER_INT, G_TYPE_NONE, 2, G_TYPE_POINTER, G_TYPE_INT); + + /** + * ModestMailOperationQueue::queue-empty + * @self: the #ModestMailOperationQueue that emits the signal + * @user_data: user data set when the signal handler was connected + * + * Issued whenever the queue is empty + */ + signals[QUEUE_EMPTY_SIGNAL] = + g_signal_new ("queue-empty", + G_TYPE_FROM_CLASS (gobject_class), + G_SIGNAL_RUN_FIRST, + G_STRUCT_OFFSET (ModestMailOperationQueueClass, queue_empty), + NULL, NULL, + g_cclosure_marshal_VOID__VOID, + G_TYPE_NONE, 0); + } static void @@ -128,6 +148,18 @@ modest_mail_operation_queue_init (ModestMailOperationQueue *obj) priv->op_queue = g_queue_new (); priv->queue_lock = g_mutex_new (); priv->op_id = 0; + priv->queue_empty_handler = 0; + priv->running_final_sync = FALSE; +} + +static void +print_queue_item (ModestMailOperation *op, const gchar* prefix) +{ + gchar *op_str = modest_mail_operation_to_string (op); + g_debug ("%s: %s", + prefix ? prefix : "", + op_str); + g_free (op_str); } static void @@ -145,7 +177,9 @@ on_finalize_foreach(gpointer op, /* Simply remove from queue, but without emitting a * QUEUE_CHANGED_SIGNAL because we are in finalize anyway and have * the lock acquired. */ - g_signal_handlers_disconnect_by_func (mail_op, G_CALLBACK (on_progress_changed), user_data); + g_signal_handlers_disconnect_by_func (mail_op, G_CALLBACK (on_operation_finished), user_data); + + MODEST_DEBUG_BLOCK (print_queue_item (mail_op, "cancel/remove");); modest_mail_operation_cancel (mail_op); g_queue_remove (priv->op_queue, mail_op); @@ -161,6 +195,13 @@ modest_mail_operation_queue_finalize (GObject *obj) g_mutex_lock (priv->queue_lock); + MODEST_DEBUG_BLOCK ( + g_debug ("%s; items in queue: %d", + __FUNCTION__, g_queue_get_length (priv->op_queue)); + g_queue_foreach (priv->op_queue, (GFunc)print_queue_item, "in queue"); + ); + + if (priv->op_queue) { /* Cancel all */ if (!g_queue_is_empty (priv->op_queue)) { @@ -187,17 +228,12 @@ modest_mail_operation_queue_new (void) } static void -on_progress_changed (ModestMailOperation *mail_op, - ModestMailOperationState *state, - gpointer user_data) +on_operation_finished (ModestMailOperation *mail_op, + gpointer user_data) { - ModestMailOperationQueue *queue; - - if(!state->finished) - return; + ModestMailOperationQueue *queue = MODEST_MAIL_OPERATION_QUEUE (user_data); /* Remove operation from queue when finished */ - queue = MODEST_MAIL_OPERATION_QUEUE (user_data); modest_mail_operation_queue_remove (queue, mail_op); } @@ -209,29 +245,70 @@ modest_mail_operation_queue_add (ModestMailOperationQueue *self, g_return_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self)); g_return_if_fail (MODEST_IS_MAIL_OPERATION (mail_op)); - + priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self); + priv->running_final_sync = (modest_mail_operation_get_type_operation (mail_op) == MODEST_MAIL_OPERATION_TYPE_SHUTDOWN); + g_mutex_lock (priv->queue_lock); g_queue_push_tail (priv->op_queue, g_object_ref (mail_op)); - modest_mail_operation_set_id (mail_op, priv->op_id++); g_mutex_unlock (priv->queue_lock); - /* Get notified when the operation ends to remove it from the queue */ - g_signal_connect (G_OBJECT (mail_op), "progress_changed", - G_CALLBACK (on_progress_changed), self); + MODEST_DEBUG_BLOCK (print_queue_item (mail_op, "add");); + + /* Get notified when the operation ends to remove it from the + queue. We connect it using the *after* because we want to + let the other handlers for the finish function happen + before this */ + g_signal_connect_after (G_OBJECT (mail_op), + "operation-finished", + G_CALLBACK (on_operation_finished), + self); /* Notify observers */ g_signal_emit (self, signals[QUEUE_CHANGED_SIGNAL], 0, mail_op, MODEST_MAIL_OPERATION_QUEUE_OPERATION_ADDED); } -void +static gboolean +notify_queue_empty (gpointer user_data) +{ + ModestMailOperationQueue *self = (ModestMailOperationQueue *) user_data; + ModestMailOperationQueuePrivate *priv; + guint num_elements; + + priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self); + + g_mutex_lock (priv->queue_lock); + num_elements = priv->op_queue->length; + g_mutex_unlock (priv->queue_lock); + + /* We re-check again that the queue is empty. It could happen + that we had issued a tny_send_queue_flush before the send + queue could add a mail operation to the queue as a response + to the "start-queue" signal, because that signal is issued + by tinymail in the main loop. Therefor it could happen that + we emit the queue-empty signal while a send-queue is still + waiting for the "start-queue" signal from tinymail, so the + send queue will never try to send the items because modest + is finalized before */ + if (num_elements == 0) { + gdk_threads_enter (); + g_signal_emit (self, signals[QUEUE_EMPTY_SIGNAL], 0); + gdk_threads_leave (); + } + + return FALSE; +} + + +void modest_mail_operation_queue_remove (ModestMailOperationQueue *self, ModestMailOperation *mail_op) { ModestMailOperationQueuePrivate *priv; ModestMailOperationStatus status; + guint num_elements; g_return_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self)); g_return_if_fail (MODEST_IS_MAIL_OPERATION (mail_op)); @@ -240,10 +317,13 @@ modest_mail_operation_queue_remove (ModestMailOperationQueue *self, g_mutex_lock (priv->queue_lock); g_queue_remove (priv->op_queue, mail_op); + num_elements = priv->op_queue->length; g_mutex_unlock (priv->queue_lock); + MODEST_DEBUG_BLOCK (print_queue_item (mail_op, "remove");); + g_signal_handlers_disconnect_by_func (G_OBJECT (mail_op), - G_CALLBACK (on_progress_changed), + G_CALLBACK (on_operation_finished), self); /* Notify observers */ @@ -252,7 +332,8 @@ modest_mail_operation_queue_remove (ModestMailOperationQueue *self, /* Check errors */ status = modest_mail_operation_get_status (mail_op); - if (status != MODEST_MAIL_OPERATION_STATUS_SUCCESS) { + if (status != MODEST_MAIL_OPERATION_STATUS_SUCCESS && + status != MODEST_MAIL_OPERATION_STATUS_INVALID) { /* This is a sanity check. Shouldn't be needed, but prevent possible application crashes. It's useful also for detecting mail operations with invalid @@ -271,23 +352,29 @@ modest_mail_operation_queue_remove (ModestMailOperationQueue *self, } /* Free object */ - - /* We do not own the last reference when this operation is deleted - * as response to a progress changed signal from the mail operation - * itself, in which case the glib signal system owns a reference - * until the signal emission is complete. armin. */ - /* modest_runtime_verify_object_last_ref (mail_op, ""); */ g_object_unref (G_OBJECT (mail_op)); + + /* Emit the queue empty-signal. See the function to know why + we emit it in an idle */ + if (num_elements == 0) { + if (priv->queue_empty_handler) { + g_source_remove (priv->queue_empty_handler); + priv->queue_empty_handler = 0; + } + priv->queue_empty_handler = g_idle_add_full (G_PRIORITY_LOW, + notify_queue_empty, + self, NULL); + } } -guint +guint modest_mail_operation_queue_num_elements (ModestMailOperationQueue *self) { ModestMailOperationQueuePrivate *priv; guint length = 0; g_return_val_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self), 0); - + priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self); g_mutex_lock (priv->queue_lock); @@ -308,6 +395,8 @@ modest_mail_operation_queue_cancel (ModestMailOperationQueue *self, priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self); + MODEST_DEBUG_BLOCK (print_queue_item (mail_op, "cancel");); + /* This triggers a progess_changed signal in which we remove * the operation from the queue. */ modest_mail_operation_cancel (mail_op); @@ -342,7 +431,7 @@ modest_mail_operation_queue_cancel_all (ModestMailOperationQueue *self) g_queue_foreach (priv->op_queue, (GFunc) on_cancel_all_foreach, &operations_to_cancel); g_mutex_unlock (priv->queue_lock); - /* TODO: Reverse the list, to remove operations in order? */ + operations_to_cancel = g_slist_reverse (operations_to_cancel); for(cur = operations_to_cancel; cur != NULL; cur = cur->next) { if (!MODEST_IS_MAIL_OPERATION(cur->data)) @@ -353,3 +442,99 @@ modest_mail_operation_queue_cancel_all (ModestMailOperationQueue *self) g_slist_free(operations_to_cancel); } + +typedef struct +{ + GSList **new_list; + GObject *source; +} FindBySourceInfo; + +static void +on_find_by_source_foreach (gpointer op, gpointer data) +{ + FindBySourceInfo *info = (FindBySourceInfo*) data; + + if ( info->source == modest_mail_operation_get_source (MODEST_MAIL_OPERATION (op))) { + g_object_ref (G_OBJECT (op)); + *(info->new_list) = g_slist_prepend (*(info->new_list), MODEST_MAIL_OPERATION (op)); + } +} + +GSList* +modest_mail_operation_queue_get_by_source ( + ModestMailOperationQueue *self, + GObject *source) +{ + ModestMailOperationQueuePrivate *priv; + GSList* found_operations= NULL; + FindBySourceInfo *info = g_new0 (FindBySourceInfo, 1); + + g_return_val_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self), NULL); + g_return_val_if_fail (source != NULL, NULL); + + priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self); + + info->new_list = &found_operations; + info->source = source; + + g_mutex_lock (priv->queue_lock); + g_queue_foreach (priv->op_queue, (GFunc) on_find_by_source_foreach, info); + g_mutex_unlock (priv->queue_lock); + + g_free (info); + + return found_operations; +} + +static void +accumulate_mail_op_strings (ModestMailOperation *op, gchar **str) +{ + *str = g_strdup_printf ("%s\n%s", *str, modest_mail_operation_to_string (op)); +} + + +gchar* +modest_mail_operation_queue_to_string (ModestMailOperationQueue *self) +{ + gchar *str; + guint len; + ModestMailOperationQueuePrivate *priv; + + g_return_val_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self), NULL); + + priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self); + + len = g_queue_get_length (priv->op_queue); + str = g_strdup_printf ("mail operation queue (%02d)\n-------------------------", len); + if (len == 0) + str = g_strdup_printf ("%s\n%s", str, ""); + else { + g_mutex_lock (priv->queue_lock); + g_queue_foreach (priv->op_queue, (GFunc)accumulate_mail_op_strings, &str); + g_mutex_unlock (priv->queue_lock); + } + + return str; +} + +gboolean +modest_mail_operation_queue_running_shutdown (ModestMailOperationQueue *self) +{ + ModestMailOperationQueuePrivate *priv; + + g_return_val_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self), FALSE); + + priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self); + return priv->running_final_sync; +} + +void +modest_mail_operation_queue_set_running_shutdown (ModestMailOperationQueue *self) +{ + ModestMailOperationQueuePrivate *priv; + + g_return_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self)); + + priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self); + priv->running_final_sync = TRUE; +}