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));
162 tny_folder_get_headers (outbox, headers, TRUE, err);
163 if (err != NULL) goto frees;
164 iter = tny_list_create_iterator (headers);
165 while (!tny_iterator_is_done (iter)) {
166 header = TNY_HEADER (tny_iterator_get_current (iter));
168 tny_header_set_flag (header, TNY_HEADER_FLAG_SUSPENDED);
169 tny_iterator_next (iter);
170 g_object_unref (header);
174 g_queue_foreach (priv->queue, (GFunc)modest_tny_send_queue_info_free, NULL);
175 g_queue_free (priv->queue);
176 priv->queue = g_queue_new();
179 /* Dont call super class implementaiton, becasue camel removes messages from outbox */
180 TNY_CAMEL_SEND_QUEUE_CLASS(parent_class)->cancel_func (self, remove, err); /* FIXME */
184 g_object_unref (G_OBJECT (headers));
186 g_object_unref (G_OBJECT (outbox));
188 g_object_unref (iter);
192 _on_added_to_outbox (TnySendQueue *self, gboolean cancelled, TnyMsg *msg, GError *err, gpointer user_data)
194 ModestTnySendQueuePrivate *priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE(self);
195 TnyHeader *header = NULL;
196 SendInfo *info = NULL;
197 GList* existing = NULL;
198 const gchar* msg_id = NULL;
200 g_return_if_fail (TNY_IS_SEND_QUEUE(self));
201 g_return_if_fail (TNY_IS_CAMEL_MSG(msg));
203 header = tny_msg_get_header (msg);
204 msg_id = modest_tny_send_queue_get_msg_id (header);
205 /* msg_id = tny_header_get_message_id (header); */
206 g_return_if_fail(msg_id != NULL);
208 /* Put newly added message in WAITING state */
209 existing = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE(self), msg_id);
212 info = existing->data;
213 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
218 info = g_slice_new (SendInfo);
220 info->msg_id = strdup(msg_id);
221 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
222 g_queue_push_tail (priv->queue, info);
225 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
227 g_object_unref(G_OBJECT(header));
231 modest_tny_send_queue_add (ModestTnySendQueue *self, TnyMsg *msg, GError **err)
233 g_return_if_fail (MODEST_IS_TNY_SEND_QUEUE(self));
234 g_return_if_fail (TNY_IS_CAMEL_MSG(msg));
236 tny_camel_send_queue_add_async (TNY_CAMEL_SEND_QUEUE(self),
245 _add_message (ModestTnySendQueue *self, TnyHeader *header)
247 ModestWindowMgr *mgr = NULL;
248 ModestTnySendQueuePrivate *priv;
249 SendInfo *info = NULL;
250 GList* existing = NULL;
251 gchar* msg_uid = NULL;
252 ModestTnySendQueueStatus status = MODEST_TNY_SEND_QUEUE_UNKNOWN;
253 gboolean editing = FALSE;
255 g_return_if_fail (TNY_IS_SEND_QUEUE(self));
256 g_return_if_fail (TNY_IS_HEADER(header));
257 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
259 /* Check whether the mail is already in the queue */
260 msg_uid = modest_tny_send_queue_get_msg_id (header);
261 status = modest_tny_send_queue_get_msg_status (self, msg_uid);
263 case MODEST_TNY_SEND_QUEUE_UNKNOWN:
264 case MODEST_TNY_SEND_QUEUE_SUSPENDED:
265 case MODEST_TNY_SEND_QUEUE_FAILED:
267 /* Check if it already exists on queue */
268 existing = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE(self), msg_uid);
272 /* Check if its being edited */
273 mgr = modest_runtime_get_window_mgr ();
274 editing = modest_window_mgr_find_registered_header (mgr, header, NULL);
278 /* Add new meesage info */
279 info = g_slice_new (SendInfo);
280 info->msg_id = strdup(msg_uid);
281 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
282 g_queue_push_tail (priv->queue, info);
293 modest_tny_send_queue_get_sentbox (TnySendQueue *self)
296 TnyCamelTransportAccount *account;
298 g_return_val_if_fail (self, NULL);
300 account = tny_camel_send_queue_get_transport_account (TNY_CAMEL_SEND_QUEUE(self));
302 g_printerr ("modest: no account for send queue\n");
305 folder = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
306 TNY_FOLDER_TYPE_SENT);
307 g_object_unref (G_OBJECT(account));
314 modest_tny_send_queue_get_outbox (TnySendQueue *self)
317 TnyCamelTransportAccount *account;
319 g_return_val_if_fail (self, NULL);
321 account = tny_camel_send_queue_get_transport_account (TNY_CAMEL_SEND_QUEUE(self));
323 g_printerr ("modest: no account for send queue\n");
326 folder = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
327 TNY_FOLDER_TYPE_OUTBOX);
329 /* This vfunc's tinymail contract does not allow it to return NULL. */
331 g_warning("%s: Returning NULL.\n", __FUNCTION__);
334 g_object_unref (G_OBJECT(account));
340 modest_tny_send_queue_get_type (void)
342 static GType my_type = 0;
345 static const GTypeInfo my_info = {
346 sizeof(ModestTnySendQueueClass),
347 NULL, /* base init */
348 NULL, /* base finalize */
349 (GClassInitFunc) modest_tny_send_queue_class_init,
350 NULL, /* class finalize */
351 NULL, /* class data */
352 sizeof(ModestTnySendQueue),
354 (GInstanceInitFunc) modest_tny_send_queue_instance_init,
358 my_type = g_type_register_static (TNY_TYPE_CAMEL_SEND_QUEUE,
359 "ModestTnySendQueue",
367 modest_tny_send_queue_class_init (ModestTnySendQueueClass *klass)
369 GObjectClass *gobject_class;
371 gobject_class = (GObjectClass*) klass;
373 parent_class = g_type_class_peek_parent (klass);
374 gobject_class->finalize = modest_tny_send_queue_finalize;
376 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_outbox_func = modest_tny_send_queue_get_outbox;
377 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_sentbox_func = modest_tny_send_queue_get_sentbox;
378 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->cancel_func = modest_tny_send_queue_cancel;
379 klass->status_changed = NULL;
381 signals[STATUS_CHANGED] =
382 g_signal_new ("status_changed",
383 G_TYPE_FROM_CLASS (gobject_class),
385 G_STRUCT_OFFSET (ModestTnySendQueueClass, status_changed),
387 modest_marshal_VOID__STRING_INT,
388 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_INT);
390 g_type_class_add_private (gobject_class, sizeof(ModestTnySendQueuePrivate));
394 modest_tny_send_queue_instance_init (GTypeInstance *instance, gpointer g_class)
396 ModestTnySendQueuePrivate *priv;
398 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (instance);
399 priv->queue = g_queue_new();
400 priv->current = NULL;
404 modest_tny_send_queue_finalize (GObject *obj)
406 ModestTnySendQueuePrivate *priv;
408 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (obj);
410 g_queue_foreach (priv->queue, (GFunc)modest_tny_send_queue_info_free, NULL);
411 g_queue_free (priv->queue);
413 G_OBJECT_CLASS(parent_class)->finalize (obj);
417 modest_tny_send_queue_new (TnyCamelTransportAccount *account)
419 ModestTnySendQueue *self;
421 g_return_val_if_fail (TNY_IS_CAMEL_TRANSPORT_ACCOUNT(account), NULL);
423 self = MODEST_TNY_SEND_QUEUE(g_object_new(MODEST_TYPE_TNY_SEND_QUEUE, NULL));
425 tny_camel_send_queue_set_transport_account (TNY_CAMEL_SEND_QUEUE(self),
428 /* Connect signals to control when a msg is being or has been sent */
429 g_signal_connect (G_OBJECT(self), "msg-sending",
430 G_CALLBACK(_on_msg_start_sending),
432 g_signal_connect (G_OBJECT(self), "msg-sent",
433 G_CALLBACK(_on_msg_has_been_sent),
435 g_signal_connect (G_OBJECT(self), "error-happened",
436 G_CALLBACK(_on_msg_error_happened),
444 modest_tny_send_queue_try_to_send (ModestTnySendQueue* self)
446 TnyIterator *iter = NULL;
447 TnyFolder *outbox = NULL;
448 TnyList *headers = tny_simple_list_new ();
449 TnyHeader *header = NULL;
452 outbox = modest_tny_send_queue_get_outbox (TNY_SEND_QUEUE(self));
456 tny_folder_get_headers (outbox, headers, TRUE, &err);
460 iter = tny_list_create_iterator (headers);
461 while (!tny_iterator_is_done (iter)) {
462 header = TNY_HEADER (tny_iterator_get_current (iter));
464 _add_message (self, header);
465 g_object_unref (header);
468 tny_iterator_next (iter);
471 /* Flush send queue */
472 tny_camel_send_queue_flush (TNY_CAMEL_SEND_QUEUE(self));
476 g_object_unref (G_OBJECT (headers));
478 g_object_unref (G_OBJECT (outbox));
480 g_object_unref (iter);
484 modest_tny_send_queue_msg_is_being_sent (ModestTnySendQueue* self,
487 ModestTnySendQueueStatus status;
489 g_return_val_if_fail (msg_id != NULL, FALSE);
491 status = modest_tny_send_queue_get_msg_status (self, msg_id);
492 return status == MODEST_TNY_SEND_QUEUE_SENDING;
496 modest_tny_send_queue_sending_in_progress (ModestTnySendQueue* self)
498 ModestTnySendQueuePrivate *priv;
499 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
501 return priv->current != NULL;
504 ModestTnySendQueueStatus
505 modest_tny_send_queue_get_msg_status (ModestTnySendQueue *self, const gchar *msg_id)
508 item = modest_tny_send_queue_lookup_info (self, msg_id);
509 if(item == NULL) return MODEST_TNY_SEND_QUEUE_UNKNOWN;
510 return ((SendInfo*)item->data)->status;
514 modest_tny_send_queue_get_msg_id (TnyHeader *header)
516 gchar* msg_uid = NULL;
517 const gchar *subject;
518 time_t date_received;
520 /* Get message uid */
521 subject = tny_header_get_subject (header);
522 date_received = tny_header_get_date_received (header);
524 msg_uid = g_strdup_printf ("%s %d", subject, (int) date_received);
531 _on_msg_start_sending (TnySendQueue *self,
538 ModestTnySendQueuePrivate *priv = NULL;
540 SendInfo *info = NULL;
541 gchar *msg_id = NULL;
543 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
545 /* Get message uid */
546 msg_id = modest_tny_send_queue_get_msg_id (header);
548 /* Get status info */
549 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), msg_id);
551 g_warning ("%s: item should not be NULL", __FUNCTION__);
554 info->status = MODEST_TNY_SEND_QUEUE_SENDING;
556 /* Set current status item */
557 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
558 priv->current = item;
566 _on_msg_has_been_sent (TnySendQueue *self,
573 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 tny_header_set_flag (header, TNY_HEADER_FLAG_SEEN);
583 /* Get status info */
584 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), msg_id);
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);