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 <tny-folder-change.h>
37 #include <tny-folder-observer.h>
38 #include <modest-tny-account.h>
39 #include <modest-runtime.h>
40 #include <modest-platform.h>
41 #include <widgets/modest-window-mgr.h>
42 #include <modest-marshal.h>
43 #include <string.h> /* strcmp */
45 /* 'private'/'protected' functions */
46 static void modest_tny_send_queue_class_init (ModestTnySendQueueClass *klass);
47 static void modest_tny_send_queue_finalize (GObject *obj);
48 static void modest_tny_send_queue_instance_init (GTypeInstance *instance, gpointer g_class);
51 static void _on_msg_start_sending (TnySendQueue *self, TnyHeader *header, TnyMsg *msg, int done, int total, gpointer user_data);
52 static void _on_msg_has_been_sent (TnySendQueue *self, TnyHeader *header, TnyMsg *msg, int done, int total, gpointer user_data);
53 static void _on_msg_error_happened (TnySendQueue *self, TnyHeader *header, TnyMsg *msg, GError *err, gpointer user_data);
55 static TnyFolder*modest_tny_send_queue_get_outbox (TnySendQueue *self);
56 static TnyFolder*modest_tny_send_queue_get_sentbox (TnySendQueue *self);
66 typedef struct _SendInfo SendInfo;
69 ModestTnySendQueueStatus status;
72 typedef struct _ModestTnySendQueuePrivate ModestTnySendQueuePrivate;
73 struct _ModestTnySendQueuePrivate {
77 /* The info that is currently being sent */
81 #define MODEST_TNY_SEND_QUEUE_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
82 MODEST_TYPE_TNY_SEND_QUEUE, \
83 ModestTnySendQueuePrivate))
86 static TnyCamelSendQueueClass *parent_class = NULL;
88 /* uncomment the following if you have defined any signals */
89 static guint signals[LAST_SIGNAL] = {0};
92 * this thread actually tries to send all the mails in the outbox and keeps
93 * track of their state.
97 on_modest_tny_send_queue_compare_id(gconstpointer info, gconstpointer msg_id)
99 g_return_val_if_fail (info && ((SendInfo*)info)->msg_id && msg_id, -1);
101 return strcmp( ((SendInfo*)info)->msg_id, msg_id);
105 modest_tny_send_queue_info_free(SendInfo *info)
107 g_free(info->msg_id);
108 g_slice_free(SendInfo, info);
112 modest_tny_send_queue_lookup_info (ModestTnySendQueue *self, const gchar *msg_id)
114 ModestTnySendQueuePrivate *priv;
115 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
117 return g_queue_find_custom (priv->queue, msg_id, on_modest_tny_send_queue_compare_id);
121 modest_tny_send_queue_cancel (TnySendQueue *self, gboolean remove, GError **err)
123 ModestTnySendQueuePrivate *priv;
125 TnyIterator *iter = NULL;
126 TnyFolder *outbox = NULL;
127 TnyList *headers = tny_simple_list_new ();
128 TnyHeader *header = NULL;
130 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
131 if(priv->current != NULL)
133 info = priv->current->data;
134 priv->current = NULL;
136 /* Keep in list until retry, so that we know that this was suspended
137 * by the user and not by an error. */
138 info->status = MODEST_TNY_SEND_QUEUE_SUSPENDED;
140 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
143 /* Set flags to supend sending operaiton (if removed, this is not necessary) */
145 outbox = modest_tny_send_queue_get_outbox (TNY_SEND_QUEUE(self));
146 tny_folder_get_headers (outbox, headers, TRUE, err);
147 if (err != NULL) goto frees;
148 iter = tny_list_create_iterator (headers);
149 while (!tny_iterator_is_done (iter)) {
150 header = TNY_HEADER (tny_iterator_get_current (iter));
152 tny_header_unset_flags (header, TNY_HEADER_FLAG_PRIORITY);
153 tny_header_set_flags (header, TNY_HEADER_FLAG_SUSPENDED_PRIORITY);
154 tny_iterator_next (iter);
155 g_object_unref (header);
159 g_queue_foreach (priv->queue, (GFunc)modest_tny_send_queue_info_free, NULL);
160 g_queue_free (priv->queue);
161 priv->queue = g_queue_new();
164 /* Dont call super class implementaiton, becasue camel removes messages from outbox */
165 TNY_CAMEL_SEND_QUEUE_CLASS(parent_class)->cancel_func (self, remove, err); /* FIXME */
169 g_object_unref (G_OBJECT (headers));
171 g_object_unref (G_OBJECT (outbox));
173 g_object_unref (iter);
177 _on_added_to_outbox (TnySendQueue *self, gboolean cancelled, TnyMsg *msg, GError *err, gpointer user_data)
179 ModestTnySendQueuePrivate *priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE(self);
180 TnyHeader *header = NULL;
181 SendInfo *info = NULL;
182 GList* existing = NULL;
183 const gchar* msg_id = NULL;
185 g_return_if_fail (TNY_IS_SEND_QUEUE(self));
186 g_return_if_fail (TNY_IS_CAMEL_MSG(msg));
188 header = tny_msg_get_header (msg);
189 msg_id = modest_tny_send_queue_get_msg_id (header);
190 /* msg_id = tny_header_get_message_id (header); */
191 g_return_if_fail(msg_id != NULL);
193 /* Put newly added message in WAITING state */
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);
215 g_object_unref(G_OBJECT(header));
219 modest_tny_send_queue_add (ModestTnySendQueue *self, TnyMsg *msg, GError **err)
221 g_return_if_fail (MODEST_IS_TNY_SEND_QUEUE(self));
222 g_return_if_fail (TNY_IS_CAMEL_MSG(msg));
224 tny_send_queue_add_async (TNY_SEND_QUEUE(self),
233 _add_message (ModestTnySendQueue *self, TnyHeader *header)
235 ModestWindowMgr *mgr = NULL;
236 ModestTnySendQueuePrivate *priv;
237 SendInfo *info = NULL;
238 GList* existing = NULL;
239 gchar* msg_uid = NULL;
240 ModestTnySendQueueStatus status = MODEST_TNY_SEND_QUEUE_WAITING;
241 gboolean editing = FALSE;
243 g_return_if_fail (TNY_IS_SEND_QUEUE(self));
244 g_return_if_fail (TNY_IS_HEADER(header));
245 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
247 /* Check whether the mail is already in the queue */
248 msg_uid = modest_tny_send_queue_get_msg_id (header);
249 status = modest_tny_send_queue_get_msg_status (self, msg_uid);
251 case MODEST_TNY_SEND_QUEUE_UNKNONW:
252 case MODEST_TNY_SEND_QUEUE_SUSPENDED:
253 case MODEST_TNY_SEND_QUEUE_FAILED:
254 if (status != MODEST_TNY_SEND_QUEUE_SUSPENDED)
255 tny_header_unset_flags (header, TNY_HEADER_FLAG_PRIORITY);
257 /* Check if it already exists on queue */
258 existing = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE(self), msg_uid);
262 /* Check if its being edited */
263 mgr = modest_runtime_get_window_mgr ();
264 editing = modest_window_mgr_find_registered_header (mgr, header, NULL);
268 /* Add new meesage info */
269 info = g_slice_new (SendInfo);
270 info->msg_id = strdup(msg_uid);
271 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
272 g_queue_push_tail (priv->queue, info);
283 modest_tny_send_queue_get_sentbox (TnySendQueue *self)
286 TnyCamelTransportAccount *account;
288 g_return_val_if_fail (self, NULL);
290 account = tny_camel_send_queue_get_transport_account (TNY_CAMEL_SEND_QUEUE(self));
292 g_printerr ("modest: no account for send queue\n");
295 folder = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
296 TNY_FOLDER_TYPE_SENT);
297 g_object_unref (G_OBJECT(account));
304 modest_tny_send_queue_get_outbox (TnySendQueue *self)
307 TnyCamelTransportAccount *account;
309 g_return_val_if_fail (self, NULL);
311 account = tny_camel_send_queue_get_transport_account (TNY_CAMEL_SEND_QUEUE(self));
313 g_printerr ("modest: no account for send queue\n");
316 folder = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
317 TNY_FOLDER_TYPE_OUTBOX);
319 /* This vfunc's tinymail contract does not allow it to return NULL. */
321 g_warning("%s: Returning NULL.\n", __FUNCTION__);
324 g_object_unref (G_OBJECT(account));
330 modest_tny_send_queue_get_type (void)
332 static GType my_type = 0;
335 static const GTypeInfo my_info = {
336 sizeof(ModestTnySendQueueClass),
337 NULL, /* base init */
338 NULL, /* base finalize */
339 (GClassInitFunc) modest_tny_send_queue_class_init,
340 NULL, /* class finalize */
341 NULL, /* class data */
342 sizeof(ModestTnySendQueue),
344 (GInstanceInitFunc) modest_tny_send_queue_instance_init,
348 my_type = g_type_register_static (TNY_TYPE_CAMEL_SEND_QUEUE,
349 "ModestTnySendQueue",
357 modest_tny_send_queue_class_init (ModestTnySendQueueClass *klass)
359 GObjectClass *gobject_class;
361 gobject_class = (GObjectClass*) klass;
363 parent_class = g_type_class_peek_parent (klass);
364 gobject_class->finalize = modest_tny_send_queue_finalize;
366 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_outbox_func = modest_tny_send_queue_get_outbox;
367 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_sentbox_func = modest_tny_send_queue_get_sentbox;
368 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->cancel_func = modest_tny_send_queue_cancel;
369 klass->status_changed = NULL;
371 signals[STATUS_CHANGED] =
372 g_signal_new ("status_changed",
373 G_TYPE_FROM_CLASS (gobject_class),
375 G_STRUCT_OFFSET (ModestTnySendQueueClass, status_changed),
377 modest_marshal_VOID__STRING_INT,
378 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_INT);
380 g_type_class_add_private (gobject_class, sizeof(ModestTnySendQueuePrivate));
384 modest_tny_send_queue_instance_init (GTypeInstance *instance, gpointer g_class)
386 ModestTnySendQueuePrivate *priv;
388 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (instance);
389 priv->queue = g_queue_new();
390 priv->current = NULL;
394 modest_tny_send_queue_finalize (GObject *obj)
396 ModestTnySendQueuePrivate *priv;
398 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (obj);
400 g_queue_foreach (priv->queue, (GFunc)modest_tny_send_queue_info_free, NULL);
401 g_queue_free (priv->queue);
403 G_OBJECT_CLASS(parent_class)->finalize (obj);
407 modest_tny_send_queue_new (TnyCamelTransportAccount *account)
409 ModestTnySendQueue *self;
411 g_return_val_if_fail (TNY_IS_CAMEL_TRANSPORT_ACCOUNT(account), NULL);
413 self = MODEST_TNY_SEND_QUEUE(g_object_new(MODEST_TYPE_TNY_SEND_QUEUE, NULL));
415 tny_camel_send_queue_set_transport_account (TNY_CAMEL_SEND_QUEUE(self),
418 /* Connect signals to control when a msg is being or has been sent */
419 g_signal_connect (G_OBJECT(self), "msg-sending",
420 G_CALLBACK(_on_msg_start_sending),
422 g_signal_connect (G_OBJECT(self), "msg-sent",
423 G_CALLBACK(_on_msg_has_been_sent),
425 g_signal_connect (G_OBJECT(self), "error-happened",
426 G_CALLBACK(_on_msg_error_happened),
434 modest_tny_send_queue_try_to_send (ModestTnySendQueue* self)
436 TnyIterator *iter = NULL;
437 TnyFolder *outbox = NULL;
438 TnyList *headers = tny_simple_list_new ();
439 TnyHeader *header = NULL;
442 outbox = modest_tny_send_queue_get_outbox (TNY_SEND_QUEUE(self));
446 tny_folder_get_headers (outbox, headers, TRUE, &err);
450 iter = tny_list_create_iterator (headers);
451 while (!tny_iterator_is_done (iter)) {
452 header = TNY_HEADER (tny_iterator_get_current (iter));
454 _add_message (self, header);
455 g_object_unref (header);
458 tny_iterator_next (iter);
461 /* Flush send queue */
462 tny_camel_send_queue_flush (TNY_CAMEL_SEND_QUEUE(self));
466 g_object_unref (G_OBJECT (headers));
468 g_object_unref (G_OBJECT (outbox));
470 g_object_unref (iter);
474 modest_tny_send_queue_msg_is_being_sent (ModestTnySendQueue* self,
477 ModestTnySendQueueStatus status;
479 g_return_val_if_fail (msg_id != NULL, FALSE);
481 status = modest_tny_send_queue_get_msg_status (self, msg_id);
482 return status == MODEST_TNY_SEND_QUEUE_SENDING;
486 modest_tny_send_queue_sending_in_progress (ModestTnySendQueue* self)
488 ModestTnySendQueuePrivate *priv;
489 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
491 return priv->current != NULL;
494 ModestTnySendQueueStatus
495 modest_tny_send_queue_get_msg_status (ModestTnySendQueue *self, const gchar *msg_id)
498 item = modest_tny_send_queue_lookup_info (self, msg_id);
499 if(item == NULL) return MODEST_TNY_SEND_QUEUE_UNKNONW;
500 return ((SendInfo*)item->data)->status;
504 modest_tny_send_queue_get_msg_id (TnyHeader *header)
506 const gchar *uid = NULL;
507 gchar* msg_uid = NULL;
510 /* Get message uid */
511 uid = tny_header_get_uid (header);
513 tmp = g_strsplit (uid, "__", 2);
517 msg_uid = g_strconcat (tmp[0], "_", NULL);
519 msg_uid = g_strdup(tmp[0]);
530 _on_msg_start_sending (TnySendQueue *self,
537 ModestTnySendQueuePrivate *priv = NULL;
539 SendInfo *info = NULL;
540 gchar *msg_id = NULL;
542 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
544 /* Get message uid */
545 msg_id = modest_tny_send_queue_get_msg_id (header);
547 /* Get status info */
548 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), msg_id);
550 g_warning ("%s: item should not be NULL", __FUNCTION__);
553 info->status = MODEST_TNY_SEND_QUEUE_SENDING;
555 /* Set current status item */
556 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
557 priv->current = item;
565 _on_msg_has_been_sent (TnySendQueue *self,
572 ModestTnySendQueuePrivate *priv;
574 gchar *msg_id = NULL;
576 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
578 /* Get message uid */
579 msg_id = modest_tny_send_queue_get_msg_id (header);
581 /* Get status info */
582 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), msg_id);
584 g_warning ("%s: item should not be NULL", __FUNCTION__);
587 /* Remove status info */
588 modest_tny_send_queue_info_free (item->data);
589 g_queue_delete_link (priv->queue, item);
590 priv->current = NULL;
592 modest_platform_information_banner (NULL, NULL, _("mcen_ib_message_sent"));
600 _on_msg_error_happened (TnySendQueue *self,
606 ModestTnySendQueuePrivate *priv = NULL;
607 SendInfo *info = NULL;
609 gchar* msg_uid = NULL;
611 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
613 /* Get sending info (create new if it doesn not exist) */
614 msg_uid = modest_tny_send_queue_get_msg_id (header);
615 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self),
618 info = g_slice_new (SendInfo);
619 info->msg_id = strdup(msg_uid);
620 g_queue_push_tail (priv->queue, info);
624 /* Keep in queue so that we remember that the opertion has failed */
625 /* and was not just cancelled */
626 info->status = MODEST_TNY_SEND_QUEUE_FAILED;
628 /* Notify status has changed */
629 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);