1 /* Copyright (c) 2006, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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.
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.
31 #include "modest-marshal.h"
32 #include "modest-mail-operation-queue.h"
33 #include "modest-runtime.h"
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);
41 on_progress_changed (ModestMailOperation *mail_op,
42 ModestMailOperationState *state,
51 typedef struct _ModestMailOperationQueuePrivate ModestMailOperationQueuePrivate;
52 struct _ModestMailOperationQueuePrivate {
57 #define MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
58 MODEST_TYPE_MAIL_OPERATION_QUEUE, \
59 ModestMailOperationQueuePrivate))
61 static GObjectClass *parent_class = NULL;
63 static guint signals[NUM_SIGNALS] = {0};
66 modest_mail_operation_queue_get_type (void)
68 static GType my_type = 0;
70 static const GTypeInfo my_info = {
71 sizeof(ModestMailOperationQueueClass),
73 NULL, /* base finalize */
74 (GClassInitFunc) modest_mail_operation_queue_class_init,
75 NULL, /* class finalize */
76 NULL, /* class data */
77 sizeof(ModestMailOperationQueue),
79 (GInstanceInitFunc) modest_mail_operation_queue_init,
83 my_type = g_type_register_static (G_TYPE_OBJECT,
84 "ModestMailOperationQueue",
91 modest_mail_operation_queue_class_init (ModestMailOperationQueueClass *klass)
93 GObjectClass *gobject_class;
95 gobject_class = (GObjectClass*) klass;
96 parent_class = g_type_class_peek_parent (klass);
98 gobject_class->finalize = modest_mail_operation_queue_finalize;
100 g_type_class_add_private (gobject_class, sizeof(ModestMailOperationQueuePrivate));
103 * ModestMailOperationQueue::queue-changed
104 * @self: the #ModestMailOperationQueue that emits the signal
105 * @mail_op: the #ModestMailOperation affected
106 * @type: the type of change in the queue
107 * @user_data: user data set when the signal handler was connected
109 * Emitted whenever the contents of the queue change
111 signals[QUEUE_CHANGED_SIGNAL] =
112 g_signal_new ("queue-changed",
113 G_TYPE_FROM_CLASS (gobject_class),
115 G_STRUCT_OFFSET (ModestMailOperationQueueClass, queue_changed),
117 modest_marshal_VOID__POINTER_INT,
118 G_TYPE_NONE, 2, G_TYPE_POINTER, G_TYPE_INT);
122 modest_mail_operation_queue_init (ModestMailOperationQueue *obj)
124 ModestMailOperationQueuePrivate *priv;
126 priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(obj);
128 priv->op_queue = g_queue_new ();
129 priv->queue_lock = g_mutex_new ();
134 on_finalize_foreach(gpointer op,
137 ModestMailOperationQueue *queue;
138 ModestMailOperationQueuePrivate *priv;
139 ModestMailOperation *mail_op;
141 queue = MODEST_MAIL_OPERATION_QUEUE (user_data);
142 priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE (queue);
143 mail_op = MODEST_MAIL_OPERATION (op);
145 /* Simply remove from queue, but without emitting a
146 * QUEUE_CHANGED_SIGNAL because we are in finalize anyway and have
147 * the lock acquired. */
148 g_signal_handlers_disconnect_by_func (mail_op, G_CALLBACK (on_progress_changed), user_data);
150 modest_mail_operation_cancel (mail_op);
151 g_queue_remove (priv->op_queue, mail_op);
152 g_object_unref (G_OBJECT (mail_op));
156 modest_mail_operation_queue_finalize (GObject *obj)
158 ModestMailOperationQueuePrivate *priv;
160 priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(obj);
162 g_mutex_lock (priv->queue_lock);
164 if (priv->op_queue) {
166 if (!g_queue_is_empty (priv->op_queue)) {
167 g_queue_foreach (priv->op_queue,
168 (GFunc)on_finalize_foreach,
169 MODEST_MAIL_OPERATION_QUEUE (obj));
172 g_queue_free (priv->op_queue);
175 g_mutex_unlock (priv->queue_lock);
176 g_mutex_free (priv->queue_lock);
178 G_OBJECT_CLASS(parent_class)->finalize (obj);
181 ModestMailOperationQueue *
182 modest_mail_operation_queue_new (void)
184 ModestMailOperationQueue *self = g_object_new (MODEST_TYPE_MAIL_OPERATION_QUEUE, NULL);
186 return MODEST_MAIL_OPERATION_QUEUE (self);
190 on_progress_changed (ModestMailOperation *mail_op,
191 ModestMailOperationState *state,
194 ModestMailOperationQueue *queue;
199 /* Remove operation from queue when finished */
200 queue = MODEST_MAIL_OPERATION_QUEUE (user_data);
201 modest_mail_operation_queue_remove (queue, mail_op);
205 modest_mail_operation_queue_add (ModestMailOperationQueue *self,
206 ModestMailOperation *mail_op)
208 ModestMailOperationQueuePrivate *priv;
210 g_return_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self));
211 g_return_if_fail (MODEST_IS_MAIL_OPERATION (mail_op));
213 priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self);
215 g_mutex_lock (priv->queue_lock);
216 g_queue_push_tail (priv->op_queue, g_object_ref (mail_op));
217 modest_mail_operation_set_id (mail_op, priv->op_id++);
218 g_mutex_unlock (priv->queue_lock);
220 /* Get notified when the operation ends to remove it from the queue */
221 g_signal_connect (G_OBJECT (mail_op), "progress_changed",
222 G_CALLBACK (on_progress_changed), self);
224 /* Notify observers */
225 g_signal_emit (self, signals[QUEUE_CHANGED_SIGNAL], 0,
226 mail_op, MODEST_MAIL_OPERATION_QUEUE_OPERATION_ADDED);
230 modest_mail_operation_queue_remove (ModestMailOperationQueue *self,
231 ModestMailOperation *mail_op)
233 ModestMailOperationQueuePrivate *priv;
234 ModestMailOperationStatus status;
236 g_return_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self));
237 g_return_if_fail (MODEST_IS_MAIL_OPERATION (mail_op));
239 priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self);
241 g_mutex_lock (priv->queue_lock);
242 g_queue_remove (priv->op_queue, mail_op);
243 g_mutex_unlock (priv->queue_lock);
245 g_signal_handlers_disconnect_by_func (G_OBJECT (mail_op),
246 G_CALLBACK (on_progress_changed),
249 /* Notify observers */
250 g_signal_emit (self, signals[QUEUE_CHANGED_SIGNAL], 0,
251 mail_op, MODEST_MAIL_OPERATION_QUEUE_OPERATION_REMOVED);
254 status = modest_mail_operation_get_status (mail_op);
255 if (status != MODEST_MAIL_OPERATION_STATUS_SUCCESS) {
256 /* This is a sanity check. Shouldn't be needed, but
257 prevent possible application crashes. It's useful
258 also for detecting mail operations with invalid
259 status and error handling */
260 if (modest_mail_operation_get_error (mail_op) != NULL) {
261 modest_mail_operation_execute_error_handler (mail_op);
263 if (status == MODEST_MAIL_OPERATION_STATUS_CANCELED)
264 g_warning ("%s: operation canceled \n", __FUNCTION__);
266 g_warning ("%s: possible error in a mail operation " \
267 "implementation. The status is not successful " \
268 "but the mail operation does not have any " \
269 "error set\n", __FUNCTION__);
275 /* We do not own the last reference when this operation is deleted
276 * as response to a progress changed signal from the mail operation
277 * itself, in which case the glib signal system owns a reference
278 * until the signal emission is complete. armin. */
279 /* modest_runtime_verify_object_last_ref (mail_op, ""); */
280 g_object_unref (G_OBJECT (mail_op));
284 modest_mail_operation_queue_num_elements (ModestMailOperationQueue *self)
286 ModestMailOperationQueuePrivate *priv;
289 g_return_val_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self), 0);
291 priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self);
293 g_mutex_lock (priv->queue_lock);
294 length = g_queue_get_length (priv->op_queue);
295 g_mutex_unlock (priv->queue_lock);
301 modest_mail_operation_queue_cancel (ModestMailOperationQueue *self,
302 ModestMailOperation *mail_op)
304 ModestMailOperationQueuePrivate *priv;
306 g_return_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self));
307 g_return_if_fail (MODEST_IS_MAIL_OPERATION (mail_op));
309 priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self);
311 /* This triggers a progess_changed signal in which we remove
312 * the operation from the queue. */
313 modest_mail_operation_cancel (mail_op);
317 on_cancel_all_foreach (gpointer op, gpointer list)
321 new_list = (GSList**) list;
322 *new_list = g_slist_prepend (*new_list, MODEST_MAIL_OPERATION (op));
326 modest_mail_operation_queue_cancel_all (ModestMailOperationQueue *self)
328 ModestMailOperationQueuePrivate *priv;
329 GSList* operations_to_cancel = NULL;
332 g_return_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self));
334 priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self);
336 /* Remember which operations to cancel. This is the only thing that
337 * is done while holding the lock, so we do not need to call
338 * functions from other files while holding the lock, which could
339 * lead to a deadlock if such a call re-enters into this queue and
340 * tries to acquire another lock. */
341 g_mutex_lock (priv->queue_lock);
342 g_queue_foreach (priv->op_queue, (GFunc) on_cancel_all_foreach, &operations_to_cancel);
343 g_mutex_unlock (priv->queue_lock);
345 /* TODO: Reverse the list, to remove operations in order? */
347 for(cur = operations_to_cancel; cur != NULL; cur = cur->next) {
348 if (!MODEST_IS_MAIL_OPERATION(cur->data))
349 g_printerr ("modest: cur->data is not a valid mail operation\n");
351 modest_mail_operation_cancel (MODEST_MAIL_OPERATION (cur->data));
354 g_slist_free(operations_to_cancel);