X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-mail-operation-queue.c;h=e7307121128a41ff6432486dd728857d2cd2b73a;hp=a273b83527505b3909fbe56bf9eca2f6f01fc717;hb=62b2744caac1ec1fd692dddde4fe33397e9ce0fe;hpb=04a38f89beefcb16b241e13a92e03be74884ff00 diff --git a/src/modest-mail-operation-queue.c b/src/modest-mail-operation-queue.c index a273b83..e730712 100644 --- a/src/modest-mail-operation-queue.c +++ b/src/modest-mail-operation-queue.c @@ -28,30 +28,31 @@ */ #include "config.h" +#include "modest-marshal.h" #include "modest-mail-operation-queue.h" +#include "modest-runtime.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 { - /* MY_SIGNAL_1, */ - /* MY_SIGNAL_2, */ - LAST_SIGNAL + QUEUE_CHANGED_SIGNAL, + QUEUE_EMPTY_SIGNAL, + NUM_SIGNALS }; typedef struct _ModestMailOperationQueuePrivate ModestMailOperationQueuePrivate; struct _ModestMailOperationQueuePrivate { GQueue *op_queue; GMutex *queue_lock; + guint op_id; }; #define MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \ MODEST_TYPE_MAIL_OPERATION_QUEUE, \ @@ -59,8 +60,7 @@ struct _ModestMailOperationQueuePrivate { /* globals */ static GObjectClass *parent_class = NULL; -/* uncomment the following if you have defined any signals */ -/* static guint signals[LAST_SIGNAL] = {0}; */ +static guint signals[NUM_SIGNALS] = {0}; GType modest_mail_operation_queue_get_type (void) @@ -98,6 +98,41 @@ modest_mail_operation_queue_class_init (ModestMailOperationQueueClass *klass) gobject_class->finalize = modest_mail_operation_queue_finalize; g_type_class_add_private (gobject_class, sizeof(ModestMailOperationQueuePrivate)); + + /** + * ModestMailOperationQueue::queue-changed + * @self: the #ModestMailOperationQueue that emits the signal + * @mail_op: the #ModestMailOperation affected + * @type: the type of change in the queue + * @user_data: user data set when the signal handler was connected + * + * Emitted whenever the contents of the queue change + */ + signals[QUEUE_CHANGED_SIGNAL] = + g_signal_new ("queue-changed", + G_TYPE_FROM_CLASS (gobject_class), + G_SIGNAL_RUN_FIRST, + G_STRUCT_OFFSET (ModestMailOperationQueueClass, queue_changed), + 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 @@ -109,6 +144,29 @@ modest_mail_operation_queue_init (ModestMailOperationQueue *obj) priv->op_queue = g_queue_new (); priv->queue_lock = g_mutex_new (); + priv->op_id = 0; +} + +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_mail_operation_cancel (mail_op); + g_queue_remove (priv->op_queue, mail_op); + g_object_unref (G_OBJECT (mail_op)); } static void @@ -121,8 +179,13 @@ modest_mail_operation_queue_finalize (GObject *obj) g_mutex_lock (priv->queue_lock); if (priv->op_queue) { - if (!g_queue_is_empty (priv->op_queue)) - g_queue_foreach (priv->op_queue, (GFunc) g_object_unref, NULL); + /* Cancel all */ + 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); } @@ -140,6 +203,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) @@ -154,13 +227,27 @@ 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)); g_mutex_unlock (priv->queue_lock); + + /* 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 -modest_mail_operation_queue_remove (ModestMailOperationQueue *self, +modest_mail_operation_queue_remove (ModestMailOperationQueue *self, ModestMailOperation *mail_op) { ModestMailOperationQueuePrivate *priv; + ModestMailOperationStatus status; g_return_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self)); g_return_if_fail (MODEST_IS_MAIL_OPERATION (mail_op)); @@ -170,29 +257,63 @@ modest_mail_operation_queue_remove (ModestMailOperationQueue *self, g_mutex_lock (priv->queue_lock); g_queue_remove (priv->op_queue, mail_op); g_mutex_unlock (priv->queue_lock); -} + 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) { + /* 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) { + 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__); + } + } + + /* Free object */ -/* 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) -{ - modest_mail_operation_queue_cancel_no_block (op_queue, self); + /* 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); } -static void -modest_mail_operation_queue_cancel_no_block (ModestMailOperationQueue *self, - ModestMailOperation *mail_op) +guint +modest_mail_operation_queue_num_elements (ModestMailOperationQueue *self) { - if (modest_mail_operation_is_finished (mail_op)) - return; + ModestMailOperationQueuePrivate *priv; + guint length = 0; - /* TODO: the implementation is still empty */ - modest_mail_operation_cancel (mail_op); + 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); + length = g_queue_get_length (priv->op_queue); + g_mutex_unlock (priv->queue_lock); - /* Remove from the queue */ - modest_mail_operation_queue_remove (self, mail_op); + return length; } void @@ -206,23 +327,48 @@ modest_mail_operation_queue_cancel (ModestMailOperationQueue *self, priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self); - g_mutex_lock (priv->queue_lock); - modest_mail_operation_queue_cancel_no_block (self, mail_op); - g_mutex_unlock (priv->queue_lock); + /* 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; + + new_list = (GSList**) list; + *new_list = g_slist_prepend (*new_list, MODEST_MAIL_OPERATION (op)); } void 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)); 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); - g_queue_foreach (priv->op_queue, - (GFunc) modest_mail_operation_queue_cancel_no_block_wrapper, - 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? */ + + 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); }