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,
58 static void _on_msg_has_been_sent (TnySendQueue *self,
65 static void _on_msg_error_happened (TnySendQueue *self,
71 static TnyFolder* modest_tny_send_queue_get_outbox (TnySendQueue *self);
72 static TnyFolder* modest_tny_send_queue_get_sentbox (TnySendQueue *self);
82 typedef struct _SendInfo SendInfo;
85 ModestTnySendQueueStatus status;
88 typedef struct _ModestTnySendQueuePrivate ModestTnySendQueuePrivate;
89 struct _ModestTnySendQueuePrivate {
93 /* The info that is currently being sent */
97 #define MODEST_TNY_SEND_QUEUE_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
98 MODEST_TYPE_TNY_SEND_QUEUE, \
99 ModestTnySendQueuePrivate))
102 static TnyCamelSendQueueClass *parent_class = NULL;
104 /* uncomment the following if you have defined any signals */
105 static guint signals[LAST_SIGNAL] = {0};
108 * this thread actually tries to send all the mails in the outbox and keeps
109 * track of their state.
113 on_modest_tny_send_queue_compare_id(gconstpointer info, gconstpointer msg_id)
115 g_return_val_if_fail (info && ((SendInfo*)info)->msg_id && msg_id, -1);
117 return strcmp( ((SendInfo*)info)->msg_id, msg_id);
121 modest_tny_send_queue_info_free(SendInfo *info)
123 g_free(info->msg_id);
124 g_slice_free(SendInfo, info);
128 modest_tny_send_queue_lookup_info (ModestTnySendQueue *self, const gchar *msg_id)
130 ModestTnySendQueuePrivate *priv;
131 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
133 return g_queue_find_custom (priv->queue, msg_id, on_modest_tny_send_queue_compare_id);
137 modest_tny_send_queue_cancel (TnySendQueue *self, gboolean remove, GError **err)
139 ModestTnySendQueuePrivate *priv;
141 TnyIterator *iter = NULL;
142 TnyFolder *outbox = NULL;
143 TnyList *headers = tny_simple_list_new ();
144 TnyHeader *header = NULL;
146 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
147 if(priv->current != NULL)
149 info = priv->current->data;
150 priv->current = NULL;
152 /* Keep in list until retry, so that we know that this was suspended
153 * by the user and not by an error. */
154 info->status = MODEST_TNY_SEND_QUEUE_SUSPENDED;
156 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
159 /* Set flags to supend sending operaiton (if removed, this is not necessary) */
161 outbox = modest_tny_send_queue_get_outbox (TNY_SEND_QUEUE(self));
163 g_warning ("%s: modest_tny_send_queue_get_outbox(..) returned NULL\n", __FUNCTION__);
166 tny_folder_get_headers (outbox, headers, TRUE, err);
167 if (err != NULL) goto frees;
168 iter = tny_list_create_iterator (headers);
169 while (!tny_iterator_is_done (iter)) {
170 header = TNY_HEADER (tny_iterator_get_current (iter));
172 tny_header_set_flag (header, TNY_HEADER_FLAG_SUSPENDED);
173 tny_iterator_next (iter);
174 g_object_unref (header);
178 g_queue_foreach (priv->queue, (GFunc)modest_tny_send_queue_info_free, NULL);
179 g_queue_free (priv->queue);
180 priv->queue = g_queue_new();
183 /* Dont call super class implementaiton, becasue camel removes messages from outbox */
184 TNY_CAMEL_SEND_QUEUE_CLASS(parent_class)->cancel_func (self, remove, err); /* FIXME */
188 g_object_unref (G_OBJECT (headers));
190 g_object_unref (G_OBJECT (outbox));
192 g_object_unref (iter);
196 _on_added_to_outbox (TnySendQueue *self, gboolean cancelled, TnyMsg *msg, GError *err, gpointer user_data)
198 ModestTnySendQueuePrivate *priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE(self);
199 TnyHeader *header = NULL;
200 SendInfo *info = NULL;
201 GList* existing = NULL;
202 const gchar* msg_id = NULL;
204 g_return_if_fail (TNY_IS_SEND_QUEUE(self));
205 g_return_if_fail (TNY_IS_CAMEL_MSG(msg));
207 header = tny_msg_get_header (msg);
208 msg_id = modest_tny_send_queue_get_msg_id (header);
209 /* msg_id = tny_header_get_message_id (header); */
210 g_return_if_fail(msg_id != NULL);
212 /* Put newly added message in WAITING state */
213 existing = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE(self), msg_id);
216 info = existing->data;
217 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
222 info = g_slice_new (SendInfo);
224 info->msg_id = strdup(msg_id);
225 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
226 g_queue_push_tail (priv->queue, info);
229 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
231 g_object_unref(G_OBJECT(header));
235 modest_tny_send_queue_add (ModestTnySendQueue *self, TnyMsg *msg, GError **err)
237 g_return_if_fail (MODEST_IS_TNY_SEND_QUEUE(self));
238 g_return_if_fail (TNY_IS_CAMEL_MSG(msg));
240 tny_camel_send_queue_add_async (TNY_CAMEL_SEND_QUEUE(self),
249 _add_message (ModestTnySendQueue *self, TnyHeader *header)
251 ModestWindowMgr *mgr = NULL;
252 ModestTnySendQueuePrivate *priv;
253 SendInfo *info = NULL;
254 GList* existing = NULL;
255 gchar* msg_uid = NULL;
256 ModestTnySendQueueStatus status = MODEST_TNY_SEND_QUEUE_UNKNOWN;
257 gboolean editing = FALSE;
259 g_return_if_fail (TNY_IS_SEND_QUEUE(self));
260 g_return_if_fail (TNY_IS_HEADER(header));
261 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
263 /* Check whether the mail is already in the queue */
264 msg_uid = modest_tny_send_queue_get_msg_id (header);
265 status = modest_tny_send_queue_get_msg_status (self, msg_uid);
267 case MODEST_TNY_SEND_QUEUE_UNKNOWN:
268 case MODEST_TNY_SEND_QUEUE_SUSPENDED:
269 case MODEST_TNY_SEND_QUEUE_FAILED:
271 /* Check if it already exists on queue */
272 existing = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE(self), msg_uid);
276 /* Check if its being edited */
277 mgr = modest_runtime_get_window_mgr ();
278 editing = modest_window_mgr_find_registered_header (mgr, header, NULL);
282 /* Add new meesage info */
283 info = g_slice_new (SendInfo);
284 info->msg_id = strdup(msg_uid);
285 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
286 g_queue_push_tail (priv->queue, info);
297 modest_tny_send_queue_get_sentbox (TnySendQueue *self)
300 TnyCamelTransportAccount *account;
302 g_return_val_if_fail (self, NULL);
304 account = tny_camel_send_queue_get_transport_account (TNY_CAMEL_SEND_QUEUE(self));
306 g_printerr ("modest: no account for send queue\n");
309 folder = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
310 TNY_FOLDER_TYPE_SENT);
311 g_object_unref (G_OBJECT(account));
318 modest_tny_send_queue_get_outbox (TnySendQueue *self)
321 TnyCamelTransportAccount *account;
323 g_return_val_if_fail (self, NULL);
325 account = tny_camel_send_queue_get_transport_account (TNY_CAMEL_SEND_QUEUE(self));
327 g_printerr ("modest: no account for send queue\n");
330 folder = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
331 TNY_FOLDER_TYPE_OUTBOX);
333 /* This vfunc's tinymail contract does not allow it to return NULL. */
335 g_warning("%s: Returning NULL.\n", __FUNCTION__);
338 g_object_unref (G_OBJECT(account));
344 modest_tny_send_queue_get_type (void)
346 static GType my_type = 0;
349 static const GTypeInfo my_info = {
350 sizeof(ModestTnySendQueueClass),
351 NULL, /* base init */
352 NULL, /* base finalize */
353 (GClassInitFunc) modest_tny_send_queue_class_init,
354 NULL, /* class finalize */
355 NULL, /* class data */
356 sizeof(ModestTnySendQueue),
358 (GInstanceInitFunc) modest_tny_send_queue_instance_init,
362 my_type = g_type_register_static (TNY_TYPE_CAMEL_SEND_QUEUE,
363 "ModestTnySendQueue",
371 modest_tny_send_queue_class_init (ModestTnySendQueueClass *klass)
373 GObjectClass *gobject_class;
375 gobject_class = (GObjectClass*) klass;
377 parent_class = g_type_class_peek_parent (klass);
378 gobject_class->finalize = modest_tny_send_queue_finalize;
380 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_outbox_func = modest_tny_send_queue_get_outbox;
381 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_sentbox_func = modest_tny_send_queue_get_sentbox;
382 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->cancel_func = modest_tny_send_queue_cancel;
383 klass->status_changed = NULL;
385 signals[STATUS_CHANGED] =
386 g_signal_new ("status_changed",
387 G_TYPE_FROM_CLASS (gobject_class),
389 G_STRUCT_OFFSET (ModestTnySendQueueClass, status_changed),
391 modest_marshal_VOID__STRING_INT,
392 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_INT);
394 g_type_class_add_private (gobject_class, sizeof(ModestTnySendQueuePrivate));
398 modest_tny_send_queue_instance_init (GTypeInstance *instance, gpointer g_class)
400 ModestTnySendQueuePrivate *priv;
402 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (instance);
403 priv->queue = g_queue_new();
404 priv->current = NULL;
408 modest_tny_send_queue_finalize (GObject *obj)
410 ModestTnySendQueuePrivate *priv;
412 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (obj);
414 g_queue_foreach (priv->queue, (GFunc)modest_tny_send_queue_info_free, NULL);
415 g_queue_free (priv->queue);
417 G_OBJECT_CLASS(parent_class)->finalize (obj);
421 modest_tny_send_queue_new (TnyCamelTransportAccount *account)
423 ModestTnySendQueue *self;
425 g_return_val_if_fail (TNY_IS_CAMEL_TRANSPORT_ACCOUNT(account), NULL);
427 self = MODEST_TNY_SEND_QUEUE(g_object_new(MODEST_TYPE_TNY_SEND_QUEUE, NULL));
429 tny_camel_send_queue_set_transport_account (TNY_CAMEL_SEND_QUEUE(self),
432 /* Connect signals to control when a msg is being or has been sent */
433 g_signal_connect (G_OBJECT(self), "msg-sending",
434 G_CALLBACK(_on_msg_start_sending),
436 g_signal_connect (G_OBJECT(self), "msg-sent",
437 G_CALLBACK(_on_msg_has_been_sent),
439 g_signal_connect (G_OBJECT(self), "error-happened",
440 G_CALLBACK(_on_msg_error_happened),
448 modest_tny_send_queue_try_to_send (ModestTnySendQueue* self)
450 TnyIterator *iter = NULL;
451 TnyFolder *outbox = NULL;
452 TnyList *headers = tny_simple_list_new ();
453 TnyHeader *header = NULL;
456 outbox = modest_tny_send_queue_get_outbox (TNY_SEND_QUEUE(self));
460 tny_folder_get_headers (outbox, headers, TRUE, &err);
464 iter = tny_list_create_iterator (headers);
465 while (!tny_iterator_is_done (iter)) {
466 header = TNY_HEADER (tny_iterator_get_current (iter));
468 _add_message (self, header);
469 g_object_unref (header);
472 tny_iterator_next (iter);
475 /* Flush send queue */
476 tny_camel_send_queue_flush (TNY_CAMEL_SEND_QUEUE(self));
480 g_object_unref (G_OBJECT (headers));
482 g_object_unref (G_OBJECT (outbox));
484 g_object_unref (iter);
488 modest_tny_send_queue_msg_is_being_sent (ModestTnySendQueue* self,
491 ModestTnySendQueueStatus status;
493 g_return_val_if_fail (msg_id != NULL, FALSE);
495 status = modest_tny_send_queue_get_msg_status (self, msg_id);
496 return status == MODEST_TNY_SEND_QUEUE_SENDING;
500 modest_tny_send_queue_sending_in_progress (ModestTnySendQueue* self)
502 ModestTnySendQueuePrivate *priv;
503 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
505 return priv->current != NULL;
508 ModestTnySendQueueStatus
509 modest_tny_send_queue_get_msg_status (ModestTnySendQueue *self, const gchar *msg_id)
512 item = modest_tny_send_queue_lookup_info (self, msg_id);
513 if(item == NULL) return MODEST_TNY_SEND_QUEUE_UNKNOWN;
514 return ((SendInfo*)item->data)->status;
518 modest_tny_send_queue_get_msg_id (TnyHeader *header)
520 gchar* msg_uid = NULL;
521 const gchar *subject;
522 time_t date_received;
524 /* Get message uid */
525 subject = tny_header_get_subject (header);
526 date_received = tny_header_get_date_received (header);
528 msg_uid = g_strdup_printf ("%s %d", subject, (int) date_received);
535 _on_msg_start_sending (TnySendQueue *self,
542 ModestTnySendQueuePrivate *priv = NULL;
544 SendInfo *info = NULL;
545 gchar *msg_id = NULL;
547 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
549 /* Get message uid */
550 msg_id = modest_tny_send_queue_get_msg_id (header);
552 /* Get status info */
553 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), msg_id);
555 g_warning ("%s: item should not be NULL", __FUNCTION__);
558 info->status = MODEST_TNY_SEND_QUEUE_SENDING;
560 /* Set current status item */
561 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
562 priv->current = item;
570 _on_msg_has_been_sent (TnySendQueue *self,
577 ModestTnySendQueuePrivate *priv;
578 gchar *msg_id = NULL;
580 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
582 /* Get message uid */
583 msg_id = modest_tny_send_queue_get_msg_id (header);
585 tny_header_set_flag (header, TNY_HEADER_FLAG_SEEN);
587 /* Get status info */
588 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), msg_id);
591 /* Remove status info */
592 modest_tny_send_queue_info_free (item->data);
593 g_queue_delete_link (priv->queue, item);
594 priv->current = NULL;
596 modest_platform_information_banner (NULL, NULL, _("mcen_ib_message_sent"));
604 _on_msg_error_happened (TnySendQueue *self,
610 ModestTnySendQueuePrivate *priv = NULL;
611 SendInfo *info = NULL;
613 gchar* msg_uid = NULL;
615 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
617 /* Get sending info (create new if it doesn not exist) */
618 msg_uid = modest_tny_send_queue_get_msg_id (header);
619 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self),
622 info = g_slice_new (SendInfo);
623 info->msg_id = (msg_uid != NULL)? strdup(msg_uid) : NULL;
624 g_queue_push_tail (priv->queue, info);
628 /* Keep in queue so that we remember that the opertion has failed */
629 /* and was not just cancelled */
630 info->status = MODEST_TNY_SEND_QUEUE_FAILED;
631 priv->current = NULL;
633 /* Notify status has changed */
634 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
641 fill_list_of_caches (gpointer key, gpointer value, gpointer userdata)
643 GSList **send_queues = (GSList **) userdata;
644 *send_queues = g_slist_prepend (*send_queues, value);
647 ModestTnySendQueueStatus
648 modest_tny_all_send_queues_get_msg_status (TnyHeader *header)
650 ModestCacheMgr *cache_mgr = NULL;
651 GHashTable *send_queue_cache = NULL;
652 ModestTnyAccountStore *accounts_store = NULL;
653 TnyList *accounts = NULL;
654 TnyIterator *iter = NULL;
655 TnyTransportAccount *account = NULL;
656 GSList *send_queues = NULL, *node;
657 /* get_msg_status returns suspended by default, so we want to detect changes */
658 ModestTnySendQueueStatus status = MODEST_TNY_SEND_QUEUE_UNKNOWN;
659 ModestTnySendQueueStatus queue_status = MODEST_TNY_SEND_QUEUE_UNKNOWN;
660 gchar *msg_uid = NULL;
661 ModestTnySendQueue *send_queue = NULL;
663 msg_uid = modest_tny_send_queue_get_msg_id (header);
664 cache_mgr = modest_runtime_get_cache_mgr ();
665 send_queue_cache = modest_cache_mgr_get_cache (cache_mgr,
666 MODEST_CACHE_MGR_CACHE_TYPE_SEND_QUEUE);
668 g_hash_table_foreach (send_queue_cache, (GHFunc) fill_list_of_caches, &send_queues);
669 if (send_queues == NULL) {
670 accounts = tny_simple_list_new ();
671 accounts_store = modest_runtime_get_account_store ();
672 tny_account_store_get_accounts (TNY_ACCOUNT_STORE(accounts_store),
674 TNY_ACCOUNT_STORE_TRANSPORT_ACCOUNTS);
676 iter = tny_list_create_iterator (accounts);
677 while (!tny_iterator_is_done (iter)) {
678 account = TNY_TRANSPORT_ACCOUNT(tny_iterator_get_current (iter));
679 send_queue = modest_runtime_get_send_queue(TNY_TRANSPORT_ACCOUNT(account));
680 g_object_unref(account);
682 queue_status = modest_tny_send_queue_get_msg_status (send_queue, msg_uid);
683 if (queue_status != MODEST_TNY_SEND_QUEUE_UNKNOWN) {
684 status = queue_status;
687 tny_iterator_next (iter);
689 g_object_unref (iter);
690 g_object_unref (accounts);
693 for (node = send_queues; node != NULL; node = g_slist_next (node)) {
694 send_queue = MODEST_TNY_SEND_QUEUE (node->data);
696 queue_status = modest_tny_send_queue_get_msg_status (send_queue, msg_uid);
697 if (queue_status != MODEST_TNY_SEND_QUEUE_UNKNOWN) {
698 status = queue_status;
705 g_slist_free (send_queues);