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);
40 static void modest_mail_operation_queue_cancel_no_block_wrapper (ModestMailOperation *mail_op,
41 ModestMailOperationQueue *op_queue);
43 static void modest_mail_operation_queue_cancel_no_block (ModestMailOperationQueue *op_queue,
44 ModestMailOperation *mail_op);
52 typedef struct _ModestMailOperationQueuePrivate ModestMailOperationQueuePrivate;
53 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 ();
133 modest_mail_operation_queue_finalize (GObject *obj)
135 ModestMailOperationQueuePrivate *priv;
137 priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(obj);
139 g_mutex_lock (priv->queue_lock);
141 if (priv->op_queue) {
143 if (!g_queue_is_empty (priv->op_queue))
144 modest_mail_operation_queue_cancel_all (MODEST_MAIL_OPERATION_QUEUE (obj));
145 g_queue_free (priv->op_queue);
148 g_mutex_unlock (priv->queue_lock);
149 g_mutex_free (priv->queue_lock);
151 G_OBJECT_CLASS(parent_class)->finalize (obj);
154 ModestMailOperationQueue *
155 modest_mail_operation_queue_new (void)
157 ModestMailOperationQueue *self = g_object_new (MODEST_TYPE_MAIL_OPERATION_QUEUE, NULL);
159 return MODEST_MAIL_OPERATION_QUEUE (self);
163 modest_mail_operation_queue_add (ModestMailOperationQueue *self,
164 ModestMailOperation *mail_op)
166 ModestMailOperationQueuePrivate *priv;
168 g_return_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self));
169 g_return_if_fail (MODEST_IS_MAIL_OPERATION (mail_op));
171 priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self);
173 g_mutex_lock (priv->queue_lock);
174 g_queue_push_tail (priv->op_queue, g_object_ref (mail_op));
175 g_mutex_unlock (priv->queue_lock);
177 /* Notify observers */
178 g_signal_emit (self, signals[QUEUE_CHANGED_SIGNAL], 0,
179 mail_op, MODEST_MAIL_OPERATION_QUEUE_OPERATION_ADDED);
183 modest_mail_operation_queue_remove (ModestMailOperationQueue *self,
184 ModestMailOperation *mail_op)
186 ModestMailOperationQueuePrivate *priv;
188 g_return_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self));
189 g_return_if_fail (MODEST_IS_MAIL_OPERATION (mail_op));
191 priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self);
193 g_mutex_lock (priv->queue_lock);
194 g_queue_remove (priv->op_queue, mail_op);
195 g_mutex_unlock (priv->queue_lock);
197 /* /\* HACK see the documentation of the function. Remove this */
198 /* call when tinymail provides accurate progress values *\/ */
199 /* _modest_mail_operation_notify_end (mail_op); */
201 /* Notify observers */
202 g_signal_emit (self, signals[QUEUE_CHANGED_SIGNAL], 0,
203 mail_op, MODEST_MAIL_OPERATION_QUEUE_OPERATION_REMOVED);
206 modest_runtime_verify_object_last_ref (mail_op, "");
207 g_object_unref (G_OBJECT (mail_op));
211 modest_mail_operation_queue_num_elements (ModestMailOperationQueue *self)
213 ModestMailOperationQueuePrivate *priv;
216 g_return_val_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self), 0);
218 priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self);
220 g_mutex_lock (priv->queue_lock);
221 length = g_queue_get_length (priv->op_queue);
222 g_mutex_unlock (priv->queue_lock);
228 /* Utility function intended to be used with g_queue_foreach */
230 modest_mail_operation_queue_cancel_no_block_wrapper (ModestMailOperation *self,
231 ModestMailOperationQueue *op_queue)
233 modest_mail_operation_queue_cancel_no_block (op_queue, self);
237 modest_mail_operation_queue_cancel_no_block (ModestMailOperationQueue *self,
238 ModestMailOperation *mail_op)
240 if (modest_mail_operation_is_finished (mail_op))
243 /* TODO: the implementation is still empty */
244 modest_mail_operation_cancel (mail_op);
246 /* Remove from the queue */
247 modest_mail_operation_queue_remove (self, mail_op);
251 modest_mail_operation_queue_cancel (ModestMailOperationQueue *self,
252 ModestMailOperation *mail_op)
254 ModestMailOperationQueuePrivate *priv;
256 g_return_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self));
257 g_return_if_fail (MODEST_IS_MAIL_OPERATION (mail_op));
259 priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self);
261 g_mutex_lock (priv->queue_lock);
262 modest_mail_operation_queue_cancel_no_block (self, mail_op);
263 g_mutex_unlock (priv->queue_lock);
267 modest_mail_operation_queue_cancel_all (ModestMailOperationQueue *self)
269 ModestMailOperationQueuePrivate *priv;
271 g_return_if_fail (MODEST_IS_MAIL_OPERATION_QUEUE (self));
273 priv = MODEST_MAIL_OPERATION_QUEUE_GET_PRIVATE(self);
275 g_mutex_lock (priv->queue_lock);
276 g_queue_foreach (priv->op_queue,
277 (GFunc) modest_mail_operation_queue_cancel_no_block_wrapper,
279 g_mutex_unlock (priv->queue_lock);