git.maemo.org Git - modest/blob - src/modest-mail-operation-queue.c

   1 /* Copyright (c) 2006, Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  * * Redistributions of source code must retain the above copyright
   9  *   notice, this list of conditions and the following disclaimer.
  10  * * Redistributions in binary form must reproduce the above copyright
  11  *   notice, this list of conditions and the following disclaimer in the
  12  *   documentation and/or other materials provided with the distribution.
  13  * * Neither the name of the Nokia Corporation nor the names of its
  14  *   contributors may be used to endorse or promote products derived from
  15  *   this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
  21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #include "config.h"
  31 #include "modest-marshal.h"
  32 #include "modest-mail-operation-queue.h"
  33 #include "modest-runtime.h"
  34
  35 /* 'private'/'protected' functions */
  36 static void modest_mail_operation_queue_class_init (ModestMailOperationQueueClass *klass);
  37 static void modest_mail_operation_queue_init       (ModestMailOperationQueue *obj);
  38 static void modest_mail_operation_queue_finalize   (GObject *obj);
  39
  40 static void modest_mail_operation_queue_cancel_no_block_wrapper (ModestMailOperation *mail_op,
  41                                                                  ModestMailOperationQueue *op_queue);
  42
  43 static void modest_mail_operation_queue_cancel_no_block         (ModestMailOperationQueue *op_queue,
  44                                                                  ModestMailOperation *mail_op);
  45
  46 /* list my signals  */
  47 enum {
  48         QUEUE_CHANGED_SIGNAL,
  49         NUM_SIGNALS
  50 };
  51
  52 typedef struct _ModestMailOperationQueuePrivate ModestMailOperationQueuePrivate;
  53 struct _ModestMailOperationQueuePrivate {
  54         GQueue *op_queue;
  55         GMutex *queue_lock;
  56         guint   op_id;
  57 };
  58 #define MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(o)      (G_TYPE_INSTANCE_GET_PRIVATE((o), \
  59                                                          MODEST_TYPE_MAIL_OPERATION_QUEUE, \
  60                                                          ModestMailOperationQueuePrivate))
  61 /* globals */
  62 static GObjectClass *parent_class = NULL;
  63
  64 static guint signals[NUM_SIGNALS] = {0};
  65
  66 GType
  67 modest_mail_operation_queue_get_type (void)
  68 {
  69         static GType my_type = 0;
  70         if (!my_type) {
  71                 static const GTypeInfo my_info = {
  72                         sizeof(ModestMailOperationQueueClass),
  73                         NULL,           /* base init */
  74                         NULL,           /* base finalize */
  75                         (GClassInitFunc) modest_mail_operation_queue_class_init,
  76                         NULL,           /* class finalize */
  77                         NULL,           /* class data */
  78                         sizeof(ModestMailOperationQueue),
  79                         1,              /* n_preallocs */
  80                         (GInstanceInitFunc) modest_mail_operation_queue_init,
  81                         NULL
  82                 };
  83
  84                 my_type = g_type_register_static (G_TYPE_OBJECT,
  85                                                   "ModestMailOperationQueue",
  86                                                   &my_info, 0);
  87         }
  88         return my_type;
  89 }
  90
  91 static void
  92 modest_mail_operation_queue_class_init (ModestMailOperationQueueClass *klass)
  93 {
  94         GObjectClass *gobject_class;
  95
  96         gobject_class = (GObjectClass*) klass;
  97         parent_class  = g_type_class_peek_parent (klass);
  98
  99         gobject_class->finalize    = modest_mail_operation_queue_finalize;
 100
 101         g_type_class_add_private (gobject_class, sizeof(ModestMailOperationQueuePrivate));
 102
 103         /**
 104          * ModestMailOperationQueue::queue-changed
 105          * @self: the #ModestMailOperationQueue that emits the signal
 106          * @mail_op: the #ModestMailOperation affected
 107          * @type: the type of change in the queue
 108          * @user_data: user data set when the signal handler was connected
 109          *
 110          * Emitted whenever the contents of the queue change
 111          */
 112         signals[QUEUE_CHANGED_SIGNAL] =
 113                 g_signal_new ("queue-changed",
 114                               G_TYPE_FROM_CLASS (gobject_class),
 115                               G_SIGNAL_RUN_FIRST,
 116                               G_STRUCT_OFFSET (ModestMailOperationQueueClass, queue_changed),
 117                               NULL, NULL,
 118                               modest_marshal_VOID__POINTER_INT,
 119                               G_TYPE_NONE, 2, G_TYPE_POINTER, G_TYPE_INT);
 120 }
 121
 122 static void
 123 modest_mail_operation_queue_init (ModestMailOperationQueue *obj)
 124 {
 125         ModestMailOperationQueuePrivate *priv;
 126
 127         priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(obj);
 128
 129         priv->op_queue   = g_queue_new ();
 130         priv->queue_lock = g_mutex_new ();
 131         priv->op_id = 0;
 132 }
 133
 134 static void
 135 modest_mail_operation_queue_finalize (GObject *obj)
 136 {
 137         ModestMailOperationQueuePrivate *priv;
 138
 139         priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(obj);
 140
 141         g_mutex_lock (priv->queue_lock);
 142
 143         if (priv->op_queue) {
 144                 /* Cancel all */
 145                 if (!g_queue_is_empty (priv->op_queue))
 146                         modest_mail_operation_queue_cancel_all (MODEST_MAIL_OPERATION_QUEUE (obj));
 147                 g_queue_free (priv->op_queue);
 148         }
 149
 150         g_mutex_unlock (priv->queue_lock);
 151         g_mutex_free (priv->queue_lock);
 152
 153         G_OBJECT_CLASS(parent_class)->finalize (obj);
 154 }
 155
 156 ModestMailOperationQueue *
 157 modest_mail_operation_queue_new (void)
 158 {
 159         ModestMailOperationQueue *self = g_object_new (MODEST_TYPE_MAIL_OPERATION_QUEUE, NULL);
 160
 161         return MODEST_MAIL_OPERATION_QUEUE (self);
 162 }
 163
 164 void
 165 modest_mail_operation_queue_add (ModestMailOperationQueue *self,
 166                                  ModestMailOperation *mail_op)
 167 {
 168         ModestMailOperationQueuePrivate *priv;
 169
 170         g_return_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self));
 171         g_return_if_fail (MODEST_IS_MAIL_OPERATION (mail_op));
 172
 173         priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self);
 174
 175         g_mutex_lock (priv->queue_lock);
 176         g_queue_push_tail (priv->op_queue, g_object_ref (mail_op));
 177         modest_mail_operation_set_id (mail_op, priv->op_id++);
 178         g_mutex_unlock (priv->queue_lock);
 179
 180         /* Notify observers */
 181         g_signal_emit (self, signals[QUEUE_CHANGED_SIGNAL], 0,
 182                        mail_op, MODEST_MAIL_OPERATION_QUEUE_OPERATION_ADDED);
 183 }
 184
 185 void
 186 modest_mail_operation_queue_remove (ModestMailOperationQueue *self,
 187                                     ModestMailOperation *mail_op)
 188 {
 189         ModestMailOperationQueuePrivate *priv;
 190         ModestMailOperationStatus status;
 191
 192         g_return_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self));
 193         g_return_if_fail (MODEST_IS_MAIL_OPERATION (mail_op));
 194
 195         priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self);
 196
 197         g_mutex_lock (priv->queue_lock);
 198         g_queue_remove (priv->op_queue, mail_op);
 199         g_mutex_unlock (priv->queue_lock);
 200
 201         /* Notify observers */
 202         g_signal_emit (self, signals[QUEUE_CHANGED_SIGNAL], 0,
 203                        mail_op, MODEST_MAIL_OPERATION_QUEUE_OPERATION_REMOVED);
 204
 205         /* Check errors */
 206         status = modest_mail_operation_get_status (mail_op);
 207         if (status != MODEST_MAIL_OPERATION_STATUS_SUCCESS) {
 208                 /* This is a sanity check. Shouldn't be needed, but
 209                    prevent possible application crashes. It's useful
 210                    also for detecting mail operations with invalid
 211                    status and error handling */
 212                 if (modest_mail_operation_get_error (mail_op) != NULL)
 213                         modest_mail_operation_execute_error_handler (mail_op);
 214                 else
 215                         g_warning ("%s: possible error in a mail operation "\
 216                                    "implementation. The status is not succesful"\
 217                                    "but the mail operation does not have any "\
 218                                    "error set\n", __FUNCTION__);
 219         }
 220
 221         /* Free object */
 222         modest_runtime_verify_object_last_ref (mail_op, "");
 223         g_object_unref (G_OBJECT (mail_op));
 224 }
 225
 226 guint
 227 modest_mail_operation_queue_num_elements (ModestMailOperationQueue *self)
 228 {
 229         ModestMailOperationQueuePrivate *priv;
 230         guint length = 0;
 231
 232         g_return_val_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self), 0);
 233
 234         priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self);
 235
 236         g_mutex_lock (priv->queue_lock);
 237         length = g_queue_get_length (priv->op_queue);
 238         g_mutex_unlock (priv->queue_lock);
 239
 240         return length;
 241 }
 242
 243
 244 /* Utility function intended to be used with g_queue_foreach */
 245 static void
 246 modest_mail_operation_queue_cancel_no_block_wrapper (ModestMailOperation *self,
 247                                                      ModestMailOperationQueue *op_queue)
 248 {
 249         modest_mail_operation_queue_cancel_no_block (op_queue, self);
 250 }
 251
 252 static void
 253 modest_mail_operation_queue_cancel_no_block (ModestMailOperationQueue *self,
 254                                              ModestMailOperation *mail_op)
 255 {
 256         if (modest_mail_operation_is_finished (mail_op))
 257                 return;
 258
 259         /* TODO: the implementation is still empty */
 260         modest_mail_operation_cancel (mail_op);
 261
 262         /* Remove from the queue */
 263         modest_mail_operation_queue_remove (self, mail_op);
 264 }
 265
 266 void
 267 modest_mail_operation_queue_cancel (ModestMailOperationQueue *self,
 268                                     ModestMailOperation *mail_op)
 269 {
 270         ModestMailOperationQueuePrivate *priv;
 271
 272         g_return_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self));
 273         g_return_if_fail (MODEST_IS_MAIL_OPERATION (mail_op));
 274
 275         priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self);
 276
 277         g_mutex_lock (priv->queue_lock);
 278         modest_mail_operation_queue_cancel_no_block (self, mail_op);
 279         g_mutex_unlock (priv->queue_lock);
 280 }
 281
 282 void
 283 modest_mail_operation_queue_cancel_all (ModestMailOperationQueue *self)
 284 {
 285         ModestMailOperationQueuePrivate *priv;
 286
 287         g_return_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self));
 288
 289         priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self);
 290
 291         g_mutex_lock (priv->queue_lock);
 292         g_queue_foreach (priv->op_queue,
 293                          (GFunc) modest_mail_operation_queue_cancel_no_block_wrapper,
 294                          self);
 295         g_mutex_unlock (priv->queue_lock);
 296 }