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-error.h>
36 #include <tny-camel-msg.h>
37 #include <tny-folder-change.h>
38 #include <tny-folder-observer.h>
39 #include <modest-tny-account.h>
40 #include <modest-runtime.h>
41 #include <modest-platform.h>
42 #include <widgets/modest-window-mgr.h>
43 #include <modest-marshal.h>
44 #include <modest-debug.h>
45 #include <string.h> /* strcmp */
47 /* 'private'/'protected' functions */
48 static void modest_tny_send_queue_class_init (ModestTnySendQueueClass *klass);
49 static void modest_tny_send_queue_finalize (GObject *obj);
50 static void modest_tny_send_queue_instance_init (GTypeInstance *instance, gpointer g_class);
53 static void _on_msg_start_sending (TnySendQueue *self,
60 static void _on_msg_has_been_sent (TnySendQueue *self,
67 static void _on_msg_error_happened (TnySendQueue *self,
73 static TnyFolder* modest_tny_send_queue_get_outbox (TnySendQueue *self);
74 static TnyFolder* modest_tny_send_queue_get_sentbox (TnySendQueue *self);
78 STATUS_CHANGED_SIGNAL,
82 typedef struct _SendInfo SendInfo;
85 ModestTnySendQueueStatus status;
88 typedef struct _ModestTnySendQueuePrivate ModestTnySendQueuePrivate;
89 struct _ModestTnySendQueuePrivate {
93 /* The info that is currently being sent */
101 #define MODEST_TNY_SEND_QUEUE_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
102 MODEST_TYPE_TNY_SEND_QUEUE, \
103 ModestTnySendQueuePrivate))
106 static TnyCamelSendQueueClass *parent_class = NULL;
108 /* uncomment the following if you have defined any signals */
109 static guint signals[LAST_SIGNAL] = {0};
112 * this thread actually tries to send all the mails in the outbox and keeps
113 * track of their state.
117 on_modest_tny_send_queue_compare_id (gconstpointer info, gconstpointer msg_id)
119 g_return_val_if_fail (info && ((SendInfo*)info)->msg_id && msg_id, -1);
121 return strcmp( ((SendInfo*)info)->msg_id, msg_id);
125 modest_tny_send_queue_info_free (SendInfo *info)
127 g_free(info->msg_id);
128 g_slice_free(SendInfo, info);
132 modest_tny_send_queue_lookup_info (ModestTnySendQueue *self, const gchar *msg_id)
134 ModestTnySendQueuePrivate *priv;
135 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
137 return g_queue_find_custom (priv->queue, msg_id, on_modest_tny_send_queue_compare_id);
142 queue_item_to_string (gpointer data, gchar **user_data)
144 SendInfo *info = (SendInfo*)data;
148 if (!(user_data && *user_data))
151 switch (info->status) {
152 case MODEST_TNY_SEND_QUEUE_UNKNOWN: status = "UNKNOWN"; break;
153 case MODEST_TNY_SEND_QUEUE_WAITING: status = "WAITING"; break;
154 case MODEST_TNY_SEND_QUEUE_SUSPENDED: status = "SUSPENDED"; break;
155 case MODEST_TNY_SEND_QUEUE_SENDING: status = "SENDING"; break;
156 case MODEST_TNY_SEND_QUEUE_FAILED: status = "FAILED"; break;
157 default: status= "UNEXPECTED"; break;
160 tmp = g_strdup_printf ("%s\"%s\" => [%s]\n",
161 *user_data, info->msg_id, status);
167 modest_tny_send_queue_to_string (ModestTnySendQueue *self)
170 ModestTnySendQueuePrivate *priv;
172 g_return_val_if_fail (MODEST_IS_TNY_SEND_QUEUE(self), NULL);
173 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
175 str = g_strdup_printf ("items in the send queue: %d\n",
176 g_queue_get_length (priv->queue));
178 g_queue_foreach (priv->queue, (GFunc)queue_item_to_string, &str);
184 _on_added_to_outbox (TnySendQueue *self, gboolean cancelled, TnyMsg *msg, GError *err,
187 ModestTnySendQueuePrivate *priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE(self);
188 TnyHeader *header = NULL;
189 SendInfo *info = NULL;
190 GList* existing = NULL;
191 gchar* msg_id = NULL;
193 g_return_if_fail (TNY_IS_SEND_QUEUE(self));
194 g_return_if_fail (TNY_IS_CAMEL_MSG(msg));
196 header = tny_msg_get_header (msg);
197 msg_id = modest_tny_send_queue_get_msg_id (header);
198 /* msg_id = tny_header_get_message_id (header); */
199 g_return_if_fail(msg_id != NULL);
201 /* Put newly added message in WAITING state */
202 existing = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE(self), msg_id);
203 if(existing != NULL) {
204 info = existing->data;
205 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
207 info = g_slice_new (SendInfo);
208 info->msg_id = 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_SIGNAL], 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_camel_send_queue_add_async (TNY_CAMEL_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_UNKNOWN;
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_UNKNOWN:
252 case MODEST_TNY_SEND_QUEUE_SUSPENDED:
253 case MODEST_TNY_SEND_QUEUE_FAILED:
255 /* Check if it already exists on queue */
256 existing = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE(self), msg_uid);
260 /* Check if its being edited */
261 mgr = modest_runtime_get_window_mgr ();
262 editing = modest_window_mgr_find_registered_header (mgr, header, NULL);
266 /* Add new meesage info */
267 info = g_slice_new (SendInfo);
268 info->msg_id = strdup(msg_uid);
269 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
270 g_queue_push_tail (priv->queue, info);
281 modest_tny_send_queue_get_sentbox (TnySendQueue *self)
283 ModestTnySendQueuePrivate *priv;
285 g_return_val_if_fail (self, NULL);
287 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
289 return g_object_ref (priv->sentbox);
294 modest_tny_send_queue_get_outbox (TnySendQueue *self)
296 ModestTnySendQueuePrivate *priv;
298 g_return_val_if_fail (self, NULL);
300 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
302 return g_object_ref (priv->outbox);
306 modest_tny_send_queue_get_type (void)
308 static GType my_type = 0;
311 static const GTypeInfo my_info = {
312 sizeof(ModestTnySendQueueClass),
313 NULL, /* base init */
314 NULL, /* base finalize */
315 (GClassInitFunc) modest_tny_send_queue_class_init,
316 NULL, /* class finalize */
317 NULL, /* class data */
318 sizeof(ModestTnySendQueue),
320 (GInstanceInitFunc) modest_tny_send_queue_instance_init,
324 my_type = g_type_register_static (TNY_TYPE_CAMEL_SEND_QUEUE,
325 "ModestTnySendQueue",
333 modest_tny_send_queue_class_init (ModestTnySendQueueClass *klass)
335 GObjectClass *gobject_class;
337 gobject_class = (GObjectClass*) klass;
339 parent_class = g_type_class_peek_parent (klass);
340 gobject_class->finalize = modest_tny_send_queue_finalize;
342 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_outbox_func = modest_tny_send_queue_get_outbox;
343 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_sentbox_func = modest_tny_send_queue_get_sentbox;
344 klass->status_changed = NULL;
346 signals[STATUS_CHANGED_SIGNAL] =
347 g_signal_new ("status_changed",
348 G_TYPE_FROM_CLASS (gobject_class),
350 G_STRUCT_OFFSET (ModestTnySendQueueClass, status_changed),
352 modest_marshal_VOID__STRING_INT,
353 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_INT);
355 g_type_class_add_private (gobject_class, sizeof(ModestTnySendQueuePrivate));
359 modest_tny_send_queue_instance_init (GTypeInstance *instance, gpointer g_class)
361 ModestTnySendQueuePrivate *priv;
363 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (instance);
364 priv->queue = g_queue_new();
365 priv->current = NULL;
369 modest_tny_send_queue_finalize (GObject *obj)
371 ModestTnySendQueuePrivate *priv;
373 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (obj);
375 g_queue_foreach (priv->queue, (GFunc)modest_tny_send_queue_info_free, NULL);
376 g_queue_free (priv->queue);
378 g_object_unref (priv->outbox);
379 g_object_unref (priv->sentbox);
381 G_OBJECT_CLASS(parent_class)->finalize (obj);
385 modest_tny_send_queue_new (TnyCamelTransportAccount *account)
387 ModestTnySendQueue *self = NULL;
388 ModestTnySendQueuePrivate *priv = NULL;
389 TnyIterator *iter = NULL;
390 TnyList *headers = NULL;
392 g_return_val_if_fail (TNY_IS_CAMEL_TRANSPORT_ACCOUNT(account), NULL);
394 self = MODEST_TNY_SEND_QUEUE(g_object_new(MODEST_TYPE_TNY_SEND_QUEUE, NULL));
396 /* Connect signals to control when a msg is being or has been sent */
397 g_signal_connect (G_OBJECT(self), "msg-sending",
398 G_CALLBACK(_on_msg_start_sending),
400 g_signal_connect (G_OBJECT(self), "msg-sent",
401 G_CALLBACK(_on_msg_has_been_sent),
403 g_signal_connect (G_OBJECT(self), "error-happened",
404 G_CALLBACK(_on_msg_error_happened),
407 /* Set outbox and sentbox */
408 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
409 priv->outbox = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
410 TNY_FOLDER_TYPE_OUTBOX);
411 priv->sentbox = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
412 TNY_FOLDER_TYPE_SENT);
415 headers = tny_simple_list_new ();
416 tny_folder_get_headers (priv->outbox, headers, TRUE, NULL);
418 /* Add messages to our internal queue */
419 iter = tny_list_create_iterator (headers);
420 while (!tny_iterator_is_done (iter)) {
421 TnyHeader *header = TNY_HEADER (tny_iterator_get_current (iter));
422 _add_message (self, header);
423 g_object_unref (header);
425 tny_iterator_next (iter);
428 /* Reenable suspended items */
429 modest_tny_send_queue_wakeup (self);
432 g_object_unref (G_OBJECT (headers));
433 g_object_unref (G_OBJECT (priv->outbox));
434 g_object_unref (iter);
436 /* Do this at the end, because it'll call tny_send_queue_flush
437 which will call tny_send_queue_get_outbox and
438 tny_send_queue_get_sentbox */
439 tny_camel_send_queue_set_transport_account (TNY_CAMEL_SEND_QUEUE(self),
446 modest_tny_send_queue_msg_is_being_sent (ModestTnySendQueue* self,
449 ModestTnySendQueueStatus status;
451 g_return_val_if_fail (msg_id != NULL, FALSE);
453 status = modest_tny_send_queue_get_msg_status (self, msg_id);
454 return status == MODEST_TNY_SEND_QUEUE_SENDING;
458 modest_tny_send_queue_sending_in_progress (ModestTnySendQueue* self)
460 ModestTnySendQueuePrivate *priv;
462 g_return_val_if_fail (MODEST_IS_TNY_SEND_QUEUE(self), FALSE);
464 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
466 return priv->current != NULL;
469 ModestTnySendQueueStatus
470 modest_tny_send_queue_get_msg_status (ModestTnySendQueue *self, const gchar *msg_id)
474 g_return_val_if_fail (MODEST_IS_TNY_SEND_QUEUE(self), MODEST_TNY_SEND_QUEUE_UNKNOWN);
475 g_return_val_if_fail (msg_id, MODEST_TNY_SEND_QUEUE_UNKNOWN);
477 item = modest_tny_send_queue_lookup_info (self, msg_id);
479 return MODEST_TNY_SEND_QUEUE_UNKNOWN;
481 return ((SendInfo*)item->data)->status;
485 modest_tny_send_queue_get_msg_id (TnyHeader *header)
487 gchar* msg_uid = NULL;
488 const gchar *subject;
489 time_t date_received;
491 g_return_val_if_fail (header && TNY_IS_HEADER(header), NULL);
493 /* Get message uid */
494 subject = tny_header_get_subject (header);
495 date_received = tny_header_get_date_received (header);
497 msg_uid = g_strdup_printf ("%s %d", subject, (int) date_received);
504 _on_msg_start_sending (TnySendQueue *self,
511 ModestTnySendQueuePrivate *priv = NULL;
513 SendInfo *info = NULL;
514 gchar *msg_id = NULL;
516 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
518 /* Get message uid */
519 msg_id = modest_tny_send_queue_get_msg_id (header);
521 /* Get status info */
522 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), msg_id);
524 /* Set current status item */
526 info->status = MODEST_TNY_SEND_QUEUE_SENDING;
527 g_signal_emit (self, signals[STATUS_CHANGED_SIGNAL], 0, info->msg_id, info->status);
528 priv->current = item;
535 _on_msg_has_been_sent (TnySendQueue *self,
542 ModestTnySendQueuePrivate *priv;
543 gchar *msg_id = NULL;
546 /* TODO: Sometimes tinymail does not return a header, need to check */
547 g_return_if_fail (TNY_IS_HEADER (header));
549 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
551 /* Get message uid */
552 msg_id = modest_tny_send_queue_get_msg_id (header);
554 tny_header_set_flag (header, TNY_HEADER_FLAG_SEEN);
556 /* Get status info */
557 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), msg_id);
559 /* Remove status info */
560 modest_tny_send_queue_info_free (item->data);
561 g_queue_delete_link (priv->queue, item);
562 priv->current = NULL;
564 modest_platform_information_banner (NULL, NULL, _("mcen_ib_message_sent"));
571 _on_msg_error_happened (TnySendQueue *self,
577 ModestTnySendQueuePrivate *priv = NULL;
578 SendInfo *info = NULL;
580 gchar* msg_uid = NULL;
582 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
584 /* Get sending info (create new if it doesn not exist) */
585 msg_uid = modest_tny_send_queue_get_msg_id (header);
586 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self),
590 /* Keep in queue so that we remember that the opertion has failed */
591 /* and was not just cancelled */
592 if (err->code == TNY_SYSTEM_ERROR_CANCEL)
593 info->status = MODEST_TNY_SEND_QUEUE_SUSPENDED;
595 info->status = MODEST_TNY_SEND_QUEUE_FAILED;
596 priv->current = NULL;
598 /* Notify status has changed */
599 g_signal_emit (self, signals[STATUS_CHANGED_SIGNAL], 0, info->msg_id, info->status);
606 fill_list_of_caches (gpointer key, gpointer value, gpointer userdata)
608 GSList **send_queues = (GSList **) userdata;
609 *send_queues = g_slist_prepend (*send_queues, value);
612 /* This function shouldn't be here. Move it to another place. Sergio */
613 ModestTnySendQueueStatus
614 modest_tny_all_send_queues_get_msg_status (TnyHeader *header)
616 ModestCacheMgr *cache_mgr = NULL;
617 GHashTable *send_queue_cache = NULL;
618 ModestTnyAccountStore *accounts_store = NULL;
619 TnyList *accounts = NULL;
620 TnyIterator *iter = NULL;
621 TnyTransportAccount *account = NULL;
622 GSList *send_queues = NULL, *node;
623 /* get_msg_status returns suspended by default, so we want to detect changes */
624 ModestTnySendQueueStatus status = MODEST_TNY_SEND_QUEUE_UNKNOWN;
625 ModestTnySendQueueStatus queue_status = MODEST_TNY_SEND_QUEUE_UNKNOWN;
626 gchar *msg_uid = NULL;
627 ModestTnySendQueue *send_queue = NULL;
629 g_return_val_if_fail (TNY_IS_HEADER(header), MODEST_TNY_SEND_QUEUE_UNKNOWN);
631 msg_uid = modest_tny_send_queue_get_msg_id (header);
632 cache_mgr = modest_runtime_get_cache_mgr ();
633 send_queue_cache = modest_cache_mgr_get_cache (cache_mgr,
634 MODEST_CACHE_MGR_CACHE_TYPE_SEND_QUEUE);
636 g_hash_table_foreach (send_queue_cache, (GHFunc) fill_list_of_caches, &send_queues);
637 if (send_queues == NULL) {
638 accounts = tny_simple_list_new ();
639 accounts_store = modest_runtime_get_account_store ();
640 tny_account_store_get_accounts (TNY_ACCOUNT_STORE(accounts_store),
642 TNY_ACCOUNT_STORE_TRANSPORT_ACCOUNTS);
644 iter = tny_list_create_iterator (accounts);
645 while (!tny_iterator_is_done (iter)) {
646 account = TNY_TRANSPORT_ACCOUNT(tny_iterator_get_current (iter));
647 send_queue = modest_runtime_get_send_queue(TNY_TRANSPORT_ACCOUNT(account));
648 g_object_unref(account);
650 queue_status = modest_tny_send_queue_get_msg_status (send_queue, msg_uid);
651 if (queue_status != MODEST_TNY_SEND_QUEUE_UNKNOWN) {
652 status = queue_status;
655 tny_iterator_next (iter);
657 g_object_unref (iter);
658 g_object_unref (accounts);
661 for (node = send_queues; node != NULL; node = g_slist_next (node)) {
662 send_queue = MODEST_TNY_SEND_QUEUE (node->data);
664 queue_status = modest_tny_send_queue_get_msg_status (send_queue, msg_uid);
665 if (queue_status != MODEST_TNY_SEND_QUEUE_UNKNOWN) {
666 status = queue_status;
673 g_slist_free (send_queues);
678 modest_tny_send_queue_wakeup (ModestTnySendQueue *self)
680 ModestTnySendQueuePrivate *priv;
684 g_return_if_fail (MODEST_IS_TNY_SEND_QUEUE (self));
686 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
688 headers = tny_simple_list_new ();
689 tny_folder_get_headers (priv->outbox, headers, TRUE, NULL);
691 /* Wake up every single suspended header */
692 iter = tny_list_create_iterator (headers);
693 while (!tny_iterator_is_done (iter)) {
694 TnyHeader *header = TNY_HEADER (tny_iterator_get_current (iter));
696 if (tny_header_get_flags (header) & TNY_HEADER_FLAG_SUSPENDED) {
701 /* Unset the suspended flag */
702 tny_header_unset_flag (header, TNY_HEADER_FLAG_SUSPENDED);
705 msg_id = modest_tny_send_queue_get_msg_id (header);
706 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), msg_id);
707 info = (SendInfo *) item->data;
708 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
709 g_signal_emit (self, signals[STATUS_CHANGED_SIGNAL], 0, info->msg_id, info->status);
716 g_object_unref (header);
717 tny_iterator_next (iter);
721 g_object_unref (iter);
722 g_object_unref (G_OBJECT (headers));