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 <modest-debug.h>
44 #include <string.h> /* strcmp */
46 /* 'private'/'protected' functions */
47 static void modest_tny_send_queue_class_init (ModestTnySendQueueClass *klass);
48 static void modest_tny_send_queue_finalize (GObject *obj);
49 static void modest_tny_send_queue_instance_init (GTypeInstance *instance, gpointer g_class);
52 static void _on_msg_start_sending (TnySendQueue *self,
59 static void _on_msg_has_been_sent (TnySendQueue *self,
66 static void _on_msg_error_happened (TnySendQueue *self,
72 static TnyFolder* modest_tny_send_queue_get_outbox (TnySendQueue *self);
73 static TnyFolder* modest_tny_send_queue_get_sentbox (TnySendQueue *self);
83 typedef struct _SendInfo SendInfo;
86 ModestTnySendQueueStatus status;
89 typedef struct _ModestTnySendQueuePrivate ModestTnySendQueuePrivate;
90 struct _ModestTnySendQueuePrivate {
94 /* The info that is currently being sent */
98 #define MODEST_TNY_SEND_QUEUE_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
99 MODEST_TYPE_TNY_SEND_QUEUE, \
100 ModestTnySendQueuePrivate))
103 static TnyCamelSendQueueClass *parent_class = NULL;
105 /* uncomment the following if you have defined any signals */
106 static guint signals[LAST_SIGNAL] = {0};
109 * this thread actually tries to send all the mails in the outbox and keeps
110 * track of their state.
114 on_modest_tny_send_queue_compare_id(gconstpointer info, gconstpointer msg_id)
116 g_return_val_if_fail (info && ((SendInfo*)info)->msg_id && msg_id, -1);
118 return strcmp( ((SendInfo*)info)->msg_id, msg_id);
122 modest_tny_send_queue_info_free(SendInfo *info)
124 g_free(info->msg_id);
125 g_slice_free(SendInfo, info);
129 modest_tny_send_queue_lookup_info (ModestTnySendQueue *self, const gchar *msg_id)
131 ModestTnySendQueuePrivate *priv;
132 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
134 return g_queue_find_custom (priv->queue, msg_id, on_modest_tny_send_queue_compare_id);
139 queue_item_to_string (gpointer data, gchar **user_data)
141 SendInfo *info = (SendInfo*)data;
145 if (!(user_data && *user_data))
148 switch (info->status) {
149 case MODEST_TNY_SEND_QUEUE_UNKNOWN: status = "UNKNOWN"; break;
150 case MODEST_TNY_SEND_QUEUE_WAITING: status = "WAITING"; break;
151 case MODEST_TNY_SEND_QUEUE_SUSPENDED: status = "SUSPENDED"; break;
152 case MODEST_TNY_SEND_QUEUE_SENDING: status = "SENDING"; break;
153 case MODEST_TNY_SEND_QUEUE_FAILED: status = "FAILED"; break;
154 default: status= "UNEXPECTED"; break;
157 tmp = g_strdup_printf ("%s\"%s\" => [%s]\n",
158 *user_data, info->msg_id, status);
164 modest_tny_send_queue_to_string (ModestTnySendQueue *self)
167 ModestTnySendQueuePrivate *priv;
169 g_return_val_if_fail (MODEST_IS_TNY_SEND_QUEUE(self), NULL);
170 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
172 str = g_strdup_printf ("items in the send queue: %d\n",
173 g_queue_get_length (priv->queue));
175 g_queue_foreach (priv->queue, (GFunc)queue_item_to_string, &str);
181 modest_tny_send_queue_cancel (TnySendQueue *self, gboolean remove, GError **err)
183 ModestTnySendQueuePrivate *priv;
185 TnyIterator *iter = NULL;
186 TnyFolder *outbox = NULL;
187 TnyList *headers = tny_simple_list_new ();
188 TnyHeader *header = NULL;
190 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
191 if(priv->current != NULL)
193 info = priv->current->data;
194 priv->current = NULL;
196 /* Keep in list until retry, so that we know that this was suspended
197 * by the user and not by an error. */
198 info->status = MODEST_TNY_SEND_QUEUE_SUSPENDED;
200 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
203 /* Set flags to supend sending operaiton (if removed, this is not necessary) */
205 outbox = modest_tny_send_queue_get_outbox (TNY_SEND_QUEUE(self));
207 g_warning ("%s: modest_tny_send_queue_get_outbox(..) returned NULL\n", __FUNCTION__);
210 tny_folder_get_headers (outbox, headers, TRUE, err);
211 if (err != NULL) goto frees;
212 iter = tny_list_create_iterator (headers);
213 while (!tny_iterator_is_done (iter)) {
214 header = TNY_HEADER (tny_iterator_get_current (iter));
216 tny_header_set_flag (header, TNY_HEADER_FLAG_SUSPENDED);
217 tny_iterator_next (iter);
218 g_object_unref (header);
222 g_queue_foreach (priv->queue, (GFunc)modest_tny_send_queue_info_free, NULL);
223 g_queue_free (priv->queue);
224 priv->queue = g_queue_new();
227 /* Dont call super class implementaiton, becasue camel removes messages from outbox */
228 TNY_CAMEL_SEND_QUEUE_CLASS(parent_class)->cancel_func (self, remove, err); /* FIXME */
232 g_object_unref (G_OBJECT (headers));
234 g_object_unref (G_OBJECT (outbox));
236 g_object_unref (iter);
240 _on_added_to_outbox (TnySendQueue *self, gboolean cancelled, TnyMsg *msg, GError *err, gpointer user_data)
242 ModestTnySendQueuePrivate *priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE(self);
243 TnyHeader *header = NULL;
244 SendInfo *info = NULL;
245 GList* existing = NULL;
246 const gchar* msg_id = NULL;
248 g_return_if_fail (TNY_IS_SEND_QUEUE(self));
249 g_return_if_fail (TNY_IS_CAMEL_MSG(msg));
251 header = tny_msg_get_header (msg);
252 msg_id = modest_tny_send_queue_get_msg_id (header);
253 /* msg_id = tny_header_get_message_id (header); */
254 g_return_if_fail(msg_id != NULL);
256 /* Put newly added message in WAITING state */
257 existing = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE(self), msg_id);
260 info = existing->data;
261 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
266 info = g_slice_new (SendInfo);
268 info->msg_id = strdup(msg_id);
269 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
270 g_queue_push_tail (priv->queue, info);
273 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
275 g_object_unref(G_OBJECT(header));
279 modest_tny_send_queue_add (ModestTnySendQueue *self, TnyMsg *msg, GError **err)
281 g_return_if_fail (MODEST_IS_TNY_SEND_QUEUE(self));
282 g_return_if_fail (TNY_IS_CAMEL_MSG(msg));
284 tny_camel_send_queue_add_async (TNY_CAMEL_SEND_QUEUE(self),
293 _add_message (ModestTnySendQueue *self, TnyHeader *header)
295 ModestWindowMgr *mgr = NULL;
296 ModestTnySendQueuePrivate *priv;
297 SendInfo *info = NULL;
298 GList* existing = NULL;
299 gchar* msg_uid = NULL;
300 ModestTnySendQueueStatus status = MODEST_TNY_SEND_QUEUE_UNKNOWN;
301 gboolean editing = FALSE;
303 g_return_if_fail (TNY_IS_SEND_QUEUE(self));
304 g_return_if_fail (TNY_IS_HEADER(header));
305 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
307 /* Check whether the mail is already in the queue */
308 msg_uid = modest_tny_send_queue_get_msg_id (header);
309 status = modest_tny_send_queue_get_msg_status (self, msg_uid);
311 case MODEST_TNY_SEND_QUEUE_UNKNOWN:
312 case MODEST_TNY_SEND_QUEUE_SUSPENDED:
313 case MODEST_TNY_SEND_QUEUE_FAILED:
315 /* Check if it already exists on queue */
316 existing = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE(self), msg_uid);
320 /* Check if its being edited */
321 mgr = modest_runtime_get_window_mgr ();
322 editing = modest_window_mgr_find_registered_header (mgr, header, NULL);
326 /* Add new meesage info */
327 info = g_slice_new (SendInfo);
328 info->msg_id = strdup(msg_uid);
329 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
330 g_queue_push_tail (priv->queue, info);
341 modest_tny_send_queue_get_sentbox (TnySendQueue *self)
344 TnyCamelTransportAccount *account;
346 g_return_val_if_fail (self, NULL);
348 account = tny_camel_send_queue_get_transport_account (TNY_CAMEL_SEND_QUEUE(self));
350 g_printerr ("modest: no account for send queue\n");
353 folder = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
354 TNY_FOLDER_TYPE_SENT);
355 g_object_unref (G_OBJECT(account));
362 modest_tny_send_queue_get_outbox (TnySendQueue *self)
365 TnyCamelTransportAccount *account;
367 g_return_val_if_fail (self, NULL);
369 account = tny_camel_send_queue_get_transport_account (TNY_CAMEL_SEND_QUEUE(self));
371 g_printerr ("modest: no account for send queue\n");
374 folder = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
375 TNY_FOLDER_TYPE_OUTBOX);
377 /* This vfunc's tinymail contract does not allow it to return NULL. */
379 g_warning("%s: Returning NULL.\n", __FUNCTION__);
382 g_object_unref (G_OBJECT(account));
388 modest_tny_send_queue_get_type (void)
390 static GType my_type = 0;
393 static const GTypeInfo my_info = {
394 sizeof(ModestTnySendQueueClass),
395 NULL, /* base init */
396 NULL, /* base finalize */
397 (GClassInitFunc) modest_tny_send_queue_class_init,
398 NULL, /* class finalize */
399 NULL, /* class data */
400 sizeof(ModestTnySendQueue),
402 (GInstanceInitFunc) modest_tny_send_queue_instance_init,
406 my_type = g_type_register_static (TNY_TYPE_CAMEL_SEND_QUEUE,
407 "ModestTnySendQueue",
415 modest_tny_send_queue_class_init (ModestTnySendQueueClass *klass)
417 GObjectClass *gobject_class;
419 gobject_class = (GObjectClass*) klass;
421 parent_class = g_type_class_peek_parent (klass);
422 gobject_class->finalize = modest_tny_send_queue_finalize;
424 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_outbox_func = modest_tny_send_queue_get_outbox;
425 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_sentbox_func = modest_tny_send_queue_get_sentbox;
426 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->cancel_func = modest_tny_send_queue_cancel;
427 klass->status_changed = NULL;
429 signals[STATUS_CHANGED] =
430 g_signal_new ("status_changed",
431 G_TYPE_FROM_CLASS (gobject_class),
433 G_STRUCT_OFFSET (ModestTnySendQueueClass, status_changed),
435 modest_marshal_VOID__STRING_INT,
436 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_INT);
438 g_type_class_add_private (gobject_class, sizeof(ModestTnySendQueuePrivate));
442 modest_tny_send_queue_instance_init (GTypeInstance *instance, gpointer g_class)
444 ModestTnySendQueuePrivate *priv;
446 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (instance);
447 priv->queue = g_queue_new();
448 priv->current = NULL;
452 modest_tny_send_queue_finalize (GObject *obj)
454 ModestTnySendQueuePrivate *priv;
456 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (obj);
458 g_queue_foreach (priv->queue, (GFunc)modest_tny_send_queue_info_free, NULL);
459 g_queue_free (priv->queue);
461 G_OBJECT_CLASS(parent_class)->finalize (obj);
465 modest_tny_send_queue_new (TnyCamelTransportAccount *account)
467 ModestTnySendQueue *self;
469 g_return_val_if_fail (TNY_IS_CAMEL_TRANSPORT_ACCOUNT(account), NULL);
471 self = MODEST_TNY_SEND_QUEUE(g_object_new(MODEST_TYPE_TNY_SEND_QUEUE, NULL));
473 tny_camel_send_queue_set_transport_account (TNY_CAMEL_SEND_QUEUE(self),
476 /* Connect signals to control when a msg is being or has been sent */
477 g_signal_connect (G_OBJECT(self), "msg-sending",
478 G_CALLBACK(_on_msg_start_sending),
480 g_signal_connect (G_OBJECT(self), "msg-sent",
481 G_CALLBACK(_on_msg_has_been_sent),
483 g_signal_connect (G_OBJECT(self), "error-happened",
484 G_CALLBACK(_on_msg_error_happened),
492 modest_tny_send_queue_try_to_send (ModestTnySendQueue* self)
494 TnyIterator *iter = NULL;
495 TnyFolder *outbox = NULL;
496 TnyList *headers = tny_simple_list_new ();
497 TnyHeader *header = NULL;
500 outbox = modest_tny_send_queue_get_outbox (TNY_SEND_QUEUE(self));
504 tny_folder_get_headers (outbox, headers, TRUE, &err);
508 iter = tny_list_create_iterator (headers);
509 while (!tny_iterator_is_done (iter)) {
510 header = TNY_HEADER (tny_iterator_get_current (iter));
512 _add_message (self, header);
513 g_object_unref (header);
516 tny_iterator_next (iter);
519 /* Flush send queue */
520 tny_camel_send_queue_flush (TNY_CAMEL_SEND_QUEUE(self));
524 g_object_unref (G_OBJECT (headers));
526 g_object_unref (G_OBJECT (outbox));
528 g_object_unref (iter);
532 modest_tny_send_queue_msg_is_being_sent (ModestTnySendQueue* self,
535 ModestTnySendQueueStatus status;
537 g_return_val_if_fail (msg_id != NULL, FALSE);
539 status = modest_tny_send_queue_get_msg_status (self, msg_id);
540 return status == MODEST_TNY_SEND_QUEUE_SENDING;
544 modest_tny_send_queue_sending_in_progress (ModestTnySendQueue* self)
546 ModestTnySendQueuePrivate *priv;
547 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
549 return priv->current != NULL;
552 ModestTnySendQueueStatus
553 modest_tny_send_queue_get_msg_status (ModestTnySendQueue *self, const gchar *msg_id)
556 item = modest_tny_send_queue_lookup_info (self, msg_id);
557 if(item == NULL) return MODEST_TNY_SEND_QUEUE_UNKNOWN;
558 return ((SendInfo*)item->data)->status;
562 modest_tny_send_queue_get_msg_id (TnyHeader *header)
564 gchar* msg_uid = NULL;
565 const gchar *subject;
566 time_t date_received;
568 /* Get message uid */
569 subject = tny_header_get_subject (header);
570 date_received = tny_header_get_date_received (header);
572 msg_uid = g_strdup_printf ("%s %d", subject, (int) date_received);
579 _on_msg_start_sending (TnySendQueue *self,
586 ModestTnySendQueuePrivate *priv = NULL;
588 SendInfo *info = NULL;
589 gchar *msg_id = NULL;
591 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
593 /* Get message uid */
594 msg_id = modest_tny_send_queue_get_msg_id (header);
596 /* Get status info */
597 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), msg_id);
599 g_warning ("%s: item (%s) should not be NULL",
600 __FUNCTION__, msg_id ? msg_id : "<none>");
603 info->status = MODEST_TNY_SEND_QUEUE_SENDING;
605 /* Set current status item */
606 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
607 priv->current = item;
615 _on_msg_has_been_sent (TnySendQueue *self,
622 ModestTnySendQueuePrivate *priv;
623 gchar *msg_id = NULL;
625 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
627 /* Get message uid */
628 msg_id = modest_tny_send_queue_get_msg_id (header);
630 tny_header_set_flag (header, TNY_HEADER_FLAG_SEEN);
632 /* Get status info */
633 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), msg_id);
636 /* Remove status info */
637 modest_tny_send_queue_info_free (item->data);
638 g_queue_delete_link (priv->queue, item);
639 priv->current = NULL;
641 modest_platform_information_banner (NULL, NULL, _("mcen_ib_message_sent"));
649 _on_msg_error_happened (TnySendQueue *self,
655 ModestTnySendQueuePrivate *priv = NULL;
656 SendInfo *info = NULL;
658 gchar* msg_uid = NULL;
660 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
662 /* Get sending info (create new if it doesn not exist) */
663 msg_uid = modest_tny_send_queue_get_msg_id (header);
664 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self),
667 info = g_slice_new (SendInfo);
668 info->msg_id = (msg_uid != NULL)? strdup(msg_uid) : NULL;
669 g_queue_push_tail (priv->queue, info);
673 /* Keep in queue so that we remember that the opertion has failed */
674 /* and was not just cancelled */
675 info->status = MODEST_TNY_SEND_QUEUE_FAILED;
676 priv->current = NULL;
678 /* Notify status has changed */
679 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
686 fill_list_of_caches (gpointer key, gpointer value, gpointer userdata)
688 GSList **send_queues = (GSList **) userdata;
689 *send_queues = g_slist_prepend (*send_queues, value);
692 ModestTnySendQueueStatus
693 modest_tny_all_send_queues_get_msg_status (TnyHeader *header)
695 ModestCacheMgr *cache_mgr = NULL;
696 GHashTable *send_queue_cache = NULL;
697 ModestTnyAccountStore *accounts_store = NULL;
698 TnyList *accounts = NULL;
699 TnyIterator *iter = NULL;
700 TnyTransportAccount *account = NULL;
701 GSList *send_queues = NULL, *node;
702 /* get_msg_status returns suspended by default, so we want to detect changes */
703 ModestTnySendQueueStatus status = MODEST_TNY_SEND_QUEUE_UNKNOWN;
704 ModestTnySendQueueStatus queue_status = MODEST_TNY_SEND_QUEUE_UNKNOWN;
705 gchar *msg_uid = NULL;
706 ModestTnySendQueue *send_queue = NULL;
708 msg_uid = modest_tny_send_queue_get_msg_id (header);
709 cache_mgr = modest_runtime_get_cache_mgr ();
710 send_queue_cache = modest_cache_mgr_get_cache (cache_mgr,
711 MODEST_CACHE_MGR_CACHE_TYPE_SEND_QUEUE);
713 g_hash_table_foreach (send_queue_cache, (GHFunc) fill_list_of_caches, &send_queues);
714 if (send_queues == NULL) {
715 accounts = tny_simple_list_new ();
716 accounts_store = modest_runtime_get_account_store ();
717 tny_account_store_get_accounts (TNY_ACCOUNT_STORE(accounts_store),
719 TNY_ACCOUNT_STORE_TRANSPORT_ACCOUNTS);
721 iter = tny_list_create_iterator (accounts);
722 while (!tny_iterator_is_done (iter)) {
723 account = TNY_TRANSPORT_ACCOUNT(tny_iterator_get_current (iter));
724 send_queue = modest_runtime_get_send_queue(TNY_TRANSPORT_ACCOUNT(account));
725 g_object_unref(account);
727 queue_status = modest_tny_send_queue_get_msg_status (send_queue, msg_uid);
728 if (queue_status != MODEST_TNY_SEND_QUEUE_UNKNOWN) {
729 status = queue_status;
732 tny_iterator_next (iter);
734 g_object_unref (iter);
735 g_object_unref (accounts);
738 for (node = send_queues; node != NULL; node = g_slist_next (node)) {
739 send_queue = MODEST_TNY_SEND_QUEUE (node->data);
741 queue_status = modest_tny_send_queue_get_msg_status (send_queue, msg_uid);
742 if (queue_status != MODEST_TNY_SEND_QUEUE_UNKNOWN) {
743 status = queue_status;
750 g_slist_free (send_queues);