X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-mail-operation-queue.c;h=d22917fd513cbf518aa142939b6e1d7bc2fd3b8d;hp=98a6c65cbc8f0cb0d093e643af9f93abba1465bf;hb=83c3671f0e0b2ff021d3cb8b37653e66c1e38066;hpb=e46546c5c14f2c3b601a03f633b266a5616b9710 diff --git a/src/modest-mail-operation-queue.c b/src/modest-mail-operation-queue.c index 98a6c65..d22917f 100644 --- a/src/modest-mail-operation-queue.c +++ b/src/modest-mail-operation-queue.c @@ -31,21 +31,21 @@ #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); static void modest_mail_operation_queue_init (ModestMailOperationQueue *obj); static void modest_mail_operation_queue_finalize (GObject *obj); -static void modest_mail_operation_queue_cancel_no_block_wrapper (ModestMailOperation *mail_op, - ModestMailOperationQueue *op_queue); - -static void modest_mail_operation_queue_cancel_no_block (ModestMailOperationQueue *op_queue, - ModestMailOperation *mail_op); +static void +on_operation_finished (ModestMailOperation *mail_op, + gpointer user_data); /* list my signals */ enum { QUEUE_CHANGED_SIGNAL, + QUEUE_EMPTY_SIGNAL, NUM_SIGNALS }; @@ -117,6 +117,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 @@ -132,6 +149,40 @@ modest_mail_operation_queue_init (ModestMailOperationQueue *obj) } 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 +on_finalize_foreach(gpointer op, + gpointer user_data) +{ + ModestMailOperationQueue *queue; + ModestMailOperationQueuePrivate *priv; + ModestMailOperation *mail_op; + + queue = MODEST_MAIL_OPERATION_QUEUE (user_data); + priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE (queue); + mail_op = MODEST_MAIL_OPERATION (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_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); + g_object_unref (G_OBJECT (mail_op)); +} + +static void modest_mail_operation_queue_finalize (GObject *obj) { ModestMailOperationQueuePrivate *priv; @@ -140,10 +191,21 @@ 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)) - modest_mail_operation_queue_cancel_all (MODEST_MAIL_OPERATION_QUEUE (obj)); + if (!g_queue_is_empty (priv->op_queue)) { + g_queue_foreach (priv->op_queue, + (GFunc)on_finalize_foreach, + MODEST_MAIL_OPERATION_QUEUE (obj)); + } + g_queue_free (priv->op_queue); } @@ -161,6 +223,16 @@ modest_mail_operation_queue_new (void) return MODEST_MAIL_OPERATION_QUEUE (self); } +static void +on_operation_finished (ModestMailOperation *mail_op, + gpointer user_data) +{ + ModestMailOperationQueue *queue = MODEST_MAIL_OPERATION_QUEUE (user_data); + + /* Remove operation from queue when finished */ + modest_mail_operation_queue_remove (queue, mail_op); +} + void modest_mail_operation_queue_add (ModestMailOperationQueue *self, ModestMailOperation *mail_op) @@ -174,8 +246,18 @@ modest_mail_operation_queue_add (ModestMailOperationQueue *self, 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); + + 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, @@ -183,7 +265,7 @@ modest_mail_operation_queue_add (ModestMailOperationQueue *self, } void -modest_mail_operation_queue_remove (ModestMailOperationQueue *self, +modest_mail_operation_queue_remove (ModestMailOperationQueue *self, ModestMailOperation *mail_op) { ModestMailOperationQueuePrivate *priv; @@ -198,33 +280,46 @@ modest_mail_operation_queue_remove (ModestMailOperationQueue *self, g_queue_remove (priv->op_queue, mail_op); 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_operation_finished), + self); + /* Notify observers */ g_signal_emit (self, signals[QUEUE_CHANGED_SIGNAL], 0, mail_op, MODEST_MAIL_OPERATION_QUEUE_OPERATION_REMOVED); /* Check errors */ status = modest_mail_operation_get_status (mail_op); - if (status != MODEST_MAIL_OPERATION_STATUS_SUCCESS) { + if (status == MODEST_MAIL_OPERATION_STATUS_CANCELED) { + g_warning ("%s: operation canceled \n", __FUNCTION__); + } else if (status != MODEST_MAIL_OPERATION_STATUS_SUCCESS) { /* This is a sanity check. Shouldn't be needed, but prevent possible application crashes. It's useful also for detecting mail operations with invalid status and error handling */ - if (modest_mail_operation_get_error (mail_op) != NULL) + if (modest_mail_operation_get_error (mail_op) != NULL) { modest_mail_operation_execute_error_handler (mail_op); - else { - if (status == MODEST_MAIL_OPERATION_STATUS_CANCELED) - g_warning ("%s: operation canceled \n", __FUNCTION__); - else - g_warning ("%s: possible error in a mail operation " \ - "implementation. The status is not successful " \ - "but the mail operation does not have any " \ - "error set\n", __FUNCTION__); + } else { + g_warning ("%s: possible error in a mail operation " \ + "implementation. The status is not successful " \ + "but the mail operation does not have any " \ + "error set\n", __FUNCTION__); } } /* Free object */ - modest_runtime_verify_object_last_ref (mail_op, ""); + + /* 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 */ + g_signal_emit (self, signals[QUEUE_EMPTY_SIGNAL], 0); } guint @@ -244,57 +339,135 @@ modest_mail_operation_queue_num_elements (ModestMailOperationQueue *self) return length; } - -/* Utility function intended to be used with g_queue_foreach */ -static void -modest_mail_operation_queue_cancel_no_block_wrapper (ModestMailOperation *self, - ModestMailOperationQueue *op_queue) +void +modest_mail_operation_queue_cancel (ModestMailOperationQueue *self, + ModestMailOperation *mail_op) { - modest_mail_operation_queue_cancel_no_block (op_queue, self); -} + ModestMailOperationQueuePrivate *priv; -static void -modest_mail_operation_queue_cancel_no_block (ModestMailOperationQueue *self, - ModestMailOperation *mail_op) -{ - if (modest_mail_operation_is_finished (mail_op)) - return; + g_return_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self)); + g_return_if_fail (MODEST_IS_MAIL_OPERATION (mail_op)); - /* TODO: the implementation is still empty */ + 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); +} + +static void +on_cancel_all_foreach (gpointer op, gpointer list) +{ + GSList **new_list; - /* Remove from the queue */ - modest_mail_operation_queue_remove (self, mail_op); + new_list = (GSList**) list; + *new_list = g_slist_prepend (*new_list, MODEST_MAIL_OPERATION (op)); } void -modest_mail_operation_queue_cancel (ModestMailOperationQueue *self, - ModestMailOperation *mail_op) +modest_mail_operation_queue_cancel_all (ModestMailOperationQueue *self) { ModestMailOperationQueuePrivate *priv; + GSList* operations_to_cancel = NULL; + GSList* cur = NULL; 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); + /* Remember which operations to cancel. This is the only thing that + * is done while holding the lock, so we do not need to call + * functions from other files while holding the lock, which could + * lead to a deadlock if such a call re-enters into this queue and + * tries to acquire another lock. */ g_mutex_lock (priv->queue_lock); - modest_mail_operation_queue_cancel_no_block (self, mail_op); + 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? */ + + for(cur = operations_to_cancel; cur != NULL; cur = cur->next) { + if (!MODEST_IS_MAIL_OPERATION(cur->data)) + g_printerr ("modest: cur->data is not a valid mail operation\n"); + else + modest_mail_operation_cancel (MODEST_MAIL_OPERATION (cur->data)); + } + + g_slist_free(operations_to_cancel); } -void -modest_mail_operation_queue_cancel_all (ModestMailOperationQueue *self) +typedef struct { - ModestMailOperationQueuePrivate *priv; + GSList **new_list; + GObject *source; +} FindBySourceInfo; - g_return_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self)); +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) modest_mail_operation_queue_cancel_no_block_wrapper, - self); + 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; }