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-tny-send-queue.h>
32 #include <tny-simple-list.h>
33 #include <tny-iterator.h>
34 #include <tny-folder.h>
35 #include <tny-camel-msg.h>
36 #include <modest-tny-account.h>
37 #include <modest-runtime.h>
38 #include <widgets/modest-window-mgr.h>
39 #include <modest-marshal.h>
40 #include <string.h> /* strcmp */
42 /* 'private'/'protected' functions */
43 static void modest_tny_send_queue_class_init (ModestTnySendQueueClass *klass);
44 static void modest_tny_send_queue_finalize (GObject *obj);
45 static void modest_tny_send_queue_instance_init (GTypeInstance *instance, gpointer g_class);
48 static void _on_msg_start_sending (TnySendQueue *self, TnyHeader *header, TnyMsg *msg, int done, int total, gpointer user_data);
49 static void _on_msg_has_been_sent (TnySendQueue *self, TnyHeader *header, TnyMsg *msg, int done, int total, gpointer user_data);
50 static void _on_msg_error_happened (TnySendQueue *self, TnyHeader *header, TnyMsg *msg, GError *err, gpointer user_data);
52 static TnyFolder*modest_tny_send_queue_get_outbox (TnySendQueue *self);
53 static TnyFolder*modest_tny_send_queue_get_sentbox (TnySendQueue *self);
63 typedef struct _SendInfo SendInfo;
66 ModestTnySendQueueStatus status;
69 typedef struct _ModestTnySendQueuePrivate ModestTnySendQueuePrivate;
70 struct _ModestTnySendQueuePrivate {
74 /* The info that is currently being sent */
78 #define MODEST_TNY_SEND_QUEUE_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
79 MODEST_TYPE_TNY_SEND_QUEUE, \
80 ModestTnySendQueuePrivate))
83 static TnyCamelSendQueueClass *parent_class = NULL;
85 /* uncomment the following if you have defined any signals */
86 static guint signals[LAST_SIGNAL] = {0};
89 * this thread actually tries to send all the mails in the outbox and keeps
90 * track of their state.
94 on_modest_tny_send_queue_compare_id(gconstpointer info, gconstpointer msg_id)
96 return strcmp( ((SendInfo*)info)->msg_id, msg_id);
100 modest_tny_send_queue_info_free(SendInfo *info)
102 g_free(info->msg_id);
103 g_slice_free(SendInfo, info);
107 modest_tny_send_queue_lookup_info (ModestTnySendQueue *self, const gchar *msg_id)
109 ModestTnySendQueuePrivate *priv;
110 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
112 return g_queue_find_custom (priv->queue, msg_id, on_modest_tny_send_queue_compare_id);
116 modest_tny_send_queue_cancel (TnySendQueue *self, gboolean remove, GError **err)
118 ModestTnySendQueuePrivate *priv;
120 TnyIterator *iter = NULL;
121 TnyFolder *outbox = NULL;
122 TnyList *headers = tny_simple_list_new ();
123 TnyHeader *header = NULL;
125 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
126 if(priv->current != NULL)
128 info = priv->current->data;
129 priv->current = NULL;
131 /* Keep in list until retry, so that we know that this was suspended
132 * by the user and not by an error. */
133 info->status = MODEST_TNY_SEND_QUEUE_SUSPENDED;
135 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
138 /* Set flags to supend sending operaiton (if removed, this is not necessary) */
140 outbox = modest_tny_send_queue_get_outbox (TNY_SEND_QUEUE(self));
141 tny_folder_get_headers (outbox, headers, TRUE, err);
142 if (err != NULL) goto frees;
143 iter = tny_list_create_iterator (headers);
144 while (!tny_iterator_is_done (iter)) {
145 header = TNY_HEADER (tny_iterator_get_current (iter));
147 tny_header_unset_flags (header, TNY_HEADER_FLAG_PRIORITY);
148 tny_header_set_flags (header, TNY_HEADER_FLAG_SUSPENDED_PRIORITY);
149 tny_iterator_next (iter);
150 g_object_unref (header);
154 g_queue_foreach (priv->queue, (GFunc)modest_tny_send_queue_info_free, NULL);
155 g_queue_free (priv->queue);
156 priv->queue = g_queue_new();
159 /* Dont call super class implementaiton, becasue camel removes messages from outbox */
160 TNY_CAMEL_SEND_QUEUE_CLASS(parent_class)->cancel_func (self, remove, err); /* FIXME */
164 g_object_unref (G_OBJECT (headers));
166 g_object_unref (G_OBJECT (outbox));
168 g_object_unref (iter);
172 modest_tny_send_queue_add (TnySendQueue *self, TnyMsg *msg, GError **err)
174 ModestTnySendQueuePrivate *priv;
175 TnyHeader *header = NULL;
176 SendInfo *info = NULL;
177 GList* existing = NULL;
178 const gchar* msg_id = NULL;
180 g_return_if_fail (TNY_IS_SEND_QUEUE(self));
181 g_return_if_fail (TNY_IS_CAMEL_MSG(msg));
183 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
184 header = tny_msg_get_header (msg);
186 /* Note that this call actually sets the message id to something
188 TNY_CAMEL_SEND_QUEUE_CLASS(parent_class)->add_func (self, msg, err); /* FIXME */
190 /* Check whether the mail is already in the queue */
191 /* msg_id = tny_header_get_message_id (header); */
192 msg_id = tny_header_get_uid (header);
193 g_return_if_fail (msg_id != NULL);
194 existing = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE(self), msg_id);
197 //g_assert(info->status == MODEST_TNY_SEND_QUEUE_SUSPENDED ||
198 // info->status == MODEST_TNY_SEND_QUEUE_FAILED);
200 info = existing->data;
201 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
206 info = g_slice_new (SendInfo);
208 info->msg_id = strdup(msg_id);
209 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
210 g_queue_push_tail (priv->queue, info);
213 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
216 g_object_unref (header);
220 _add_message (ModestTnySendQueue *self, TnyHeader *header)
222 ModestWindowMgr *mgr = NULL;
223 ModestTnySendQueuePrivate *priv;
224 SendInfo *info = NULL;
225 GList* existing = NULL;
226 gchar* msg_uid = NULL;
227 ModestTnySendQueueStatus status = MODEST_TNY_SEND_QUEUE_WAITING;
228 gboolean editing = FALSE;
230 g_return_if_fail (TNY_IS_SEND_QUEUE(self));
231 g_return_if_fail (TNY_IS_HEADER(header));
232 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
234 /* Check whether the mail is already in the queue */
235 msg_uid = modest_tny_send_queue_get_msg_id (header);
236 status = modest_tny_send_queue_get_msg_status (self, msg_uid);
238 case MODEST_TNY_SEND_QUEUE_UNKNONW:
239 case MODEST_TNY_SEND_QUEUE_SUSPENDED:
240 case MODEST_TNY_SEND_QUEUE_FAILED:
241 if (status != MODEST_TNY_SEND_QUEUE_SUSPENDED)
242 tny_header_unset_flags (header, TNY_HEADER_FLAG_PRIORITY);
244 /* Check if it already exists on queue */
245 existing = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE(self), msg_uid);
246 if(existing != NULL) return;
248 /* Check if its being edited */
249 mgr = modest_runtime_get_window_mgr ();
250 editing = modest_window_mgr_find_registered_header (mgr, header, NULL);
253 /* Add new meesage info */
254 info = g_slice_new (SendInfo);
255 info->msg_id = strdup(msg_uid);
256 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
257 g_queue_push_tail (priv->queue, info);
269 modest_tny_send_queue_get_sentbox (TnySendQueue *self)
272 TnyCamelTransportAccount *account;
274 g_return_val_if_fail (self, NULL);
276 account = tny_camel_send_queue_get_transport_account (TNY_CAMEL_SEND_QUEUE(self));
278 g_printerr ("modest: no account for send queue\n");
281 folder = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
282 TNY_FOLDER_TYPE_SENT);
283 g_object_unref (G_OBJECT(account));
290 modest_tny_send_queue_get_outbox (TnySendQueue *self)
293 TnyCamelTransportAccount *account;
295 g_return_val_if_fail (self, NULL);
297 account = tny_camel_send_queue_get_transport_account (TNY_CAMEL_SEND_QUEUE(self));
299 g_printerr ("modest: no account for send queue\n");
302 folder = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
303 TNY_FOLDER_TYPE_OUTBOX);
305 /* This vfunc's tinymail contract does not allow it to return NULL. */
307 g_warning("%s: Returning NULL.\n", __FUNCTION__);
310 g_object_unref (G_OBJECT(account));
316 modest_tny_send_queue_get_type (void)
318 static GType my_type = 0;
321 static const GTypeInfo my_info = {
322 sizeof(ModestTnySendQueueClass),
323 NULL, /* base init */
324 NULL, /* base finalize */
325 (GClassInitFunc) modest_tny_send_queue_class_init,
326 NULL, /* class finalize */
327 NULL, /* class data */
328 sizeof(ModestTnySendQueue),
330 (GInstanceInitFunc) modest_tny_send_queue_instance_init,
333 my_type = g_type_register_static (TNY_TYPE_CAMEL_SEND_QUEUE,
334 "ModestTnySendQueue",
342 modest_tny_send_queue_class_init (ModestTnySendQueueClass *klass)
344 GObjectClass *gobject_class;
346 gobject_class = (GObjectClass*) klass;
348 parent_class = g_type_class_peek_parent (klass);
349 gobject_class->finalize = modest_tny_send_queue_finalize;
351 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->add_func = modest_tny_send_queue_add;
352 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_outbox_func = modest_tny_send_queue_get_outbox;
353 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_sentbox_func = modest_tny_send_queue_get_sentbox;
354 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->cancel_func = modest_tny_send_queue_cancel;
355 klass->status_changed = NULL;
357 signals[STATUS_CHANGED] =
358 g_signal_new ("status_changed",
359 G_TYPE_FROM_CLASS (gobject_class),
361 G_STRUCT_OFFSET (ModestTnySendQueueClass, status_changed),
363 modest_marshal_VOID__STRING_INT,
364 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_INT);
366 g_type_class_add_private (gobject_class, sizeof(ModestTnySendQueuePrivate));
370 modest_tny_send_queue_instance_init (GTypeInstance *instance, gpointer g_class)
372 ModestTnySendQueuePrivate *priv;
374 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (instance);
375 priv->queue = g_queue_new();
376 priv->current = NULL;
380 modest_tny_send_queue_finalize (GObject *obj)
382 ModestTnySendQueuePrivate *priv;
384 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (obj);
386 g_queue_foreach (priv->queue, (GFunc)modest_tny_send_queue_info_free, NULL);
387 g_queue_free (priv->queue);
389 G_OBJECT_CLASS(parent_class)->finalize (obj);
393 modest_tny_send_queue_new (TnyCamelTransportAccount *account)
395 ModestTnySendQueue *self;
397 g_return_val_if_fail (TNY_IS_CAMEL_TRANSPORT_ACCOUNT(account), NULL);
399 self = MODEST_TNY_SEND_QUEUE(g_object_new(MODEST_TYPE_TNY_SEND_QUEUE, NULL));
401 tny_camel_send_queue_set_transport_account (TNY_CAMEL_SEND_QUEUE(self),
404 /* Connect signals to control when a msg is being or has been sent */
405 g_signal_connect (G_OBJECT(self), "msg-sending",
406 G_CALLBACK(_on_msg_start_sending),
408 g_signal_connect (G_OBJECT(self), "msg-sent",
409 G_CALLBACK(_on_msg_has_been_sent),
411 g_signal_connect (G_OBJECT(self), "error-happened",
412 G_CALLBACK(_on_msg_error_happened),
420 modest_tny_send_queue_try_to_send (ModestTnySendQueue* self)
422 TnyIterator *iter = NULL;
423 TnyFolder *outbox = NULL;
424 TnyList *headers = tny_simple_list_new ();
425 TnyHeader *header = NULL;
428 outbox = modest_tny_send_queue_get_outbox (TNY_SEND_QUEUE(self));
432 tny_folder_get_headers (outbox, headers, TRUE, &err);
436 iter = tny_list_create_iterator (headers);
437 while (!tny_iterator_is_done (iter)) {
438 header = TNY_HEADER (tny_iterator_get_current (iter));
440 _add_message (self, header);
441 g_object_unref (header);
444 tny_iterator_next (iter);
447 /* Flush send queue */
448 tny_camel_send_queue_flush (TNY_CAMEL_SEND_QUEUE(self));
452 g_object_unref (G_OBJECT (headers));
454 g_object_unref (G_OBJECT (outbox));
456 g_object_unref (iter);
460 modest_tny_send_queue_msg_is_being_sent (ModestTnySendQueue* self,
463 ModestTnySendQueueStatus status;
465 g_return_val_if_fail (msg_id != NULL, FALSE);
467 status = modest_tny_send_queue_get_msg_status (self, msg_id);
468 return status == MODEST_TNY_SEND_QUEUE_SENDING;
472 modest_tny_send_queue_sending_in_progress (ModestTnySendQueue* self)
474 ModestTnySendQueuePrivate *priv;
475 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
477 return priv->current != NULL;
480 ModestTnySendQueueStatus
481 modest_tny_send_queue_get_msg_status (ModestTnySendQueue *self, const gchar *msg_id)
484 item = modest_tny_send_queue_lookup_info (self, msg_id);
485 if(item == NULL) return MODEST_TNY_SEND_QUEUE_UNKNONW;
486 return ((SendInfo*)item->data)->status;
490 modest_tny_send_queue_get_msg_id (TnyHeader *header)
492 const gchar *uid = NULL;
493 gchar* msg_uid = NULL;
496 /* Get message uid */
497 uid = tny_header_get_uid (header);
498 tmp = g_strsplit (uid, "__", 2);
500 msg_uid = g_strconcat (tmp[0], "_", NULL);
502 msg_uid = g_strdup(tmp[0]);
512 _on_msg_start_sending (TnySendQueue *self,
519 ModestTnySendQueuePrivate *priv = NULL;
521 SendInfo *info = NULL;
522 gchar *msg_id = NULL;
524 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
526 /* Get message uid */
527 msg_id = modest_tny_send_queue_get_msg_id (header);
529 /* Get status info */
530 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), msg_id);
531 g_return_if_fail (item != NULL);
533 info->status = MODEST_TNY_SEND_QUEUE_SENDING;
535 /* Set current status item */
536 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
537 priv->current = item;
544 _on_msg_has_been_sent (TnySendQueue *self,
551 ModestTnySendQueuePrivate *priv;
553 gchar *msg_id = NULL;
555 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
557 /* Get message uid */
558 msg_id = modest_tny_send_queue_get_msg_id (header);
560 /* Get status info */
561 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), msg_id);
562 g_return_if_fail(item != NULL);
564 /* Remove status info */
565 modest_tny_send_queue_info_free (item->data);
566 g_queue_delete_link (priv->queue, item);
567 priv->current = NULL;
574 _on_msg_error_happened (TnySendQueue *self,
580 ModestTnySendQueuePrivate *priv = NULL;
581 SendInfo *info = NULL;
583 gchar* msg_uid = NULL;
585 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
587 /* Get sending info (create new if it doesn not exist) */
588 msg_uid = modest_tny_send_queue_get_msg_id (header);
589 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self),
592 info = g_slice_new (SendInfo);
593 info->msg_id = strdup(msg_uid);
594 g_queue_push_tail (priv->queue, info);
600 /* Keep in queue so that we remember that the opertion has failed */
601 /* and was not just cancelled */
602 info->status = MODEST_TNY_SEND_QUEUE_FAILED;
604 /* Notify status has changed */
605 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);