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 info = existing->data;
198 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
203 info = g_slice_new (SendInfo);
205 info->msg_id = strdup(msg_id);
206 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
207 g_queue_push_tail (priv->queue, info);
210 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
212 g_object_unref(G_OBJECT(header));
216 modest_tny_send_queue_add (ModestTnySendQueue *self, TnyMsg *msg, GError **err)
218 g_return_if_fail (MODEST_IS_TNY_SEND_QUEUE(self));
219 g_return_if_fail (TNY_IS_CAMEL_MSG(msg));
221 tny_camel_send_queue_add_async (TNY_CAMEL_SEND_QUEUE(self),
230 _add_message (ModestTnySendQueue *self, TnyHeader *header)
232 ModestWindowMgr *mgr = NULL;
233 ModestTnySendQueuePrivate *priv;
234 SendInfo *info = NULL;
235 GList* existing = NULL;
236 gchar* msg_uid = NULL;
237 ModestTnySendQueueStatus status = MODEST_TNY_SEND_QUEUE_UNKNONW;
238 gboolean editing = FALSE;
240 g_return_if_fail (TNY_IS_SEND_QUEUE(self));
241 g_return_if_fail (TNY_IS_HEADER(header));
242 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
244 /* Check whether the mail is already in the queue */
245 msg_uid = modest_tny_send_queue_get_msg_id (header);
246 status = modest_tny_send_queue_get_msg_status (self, msg_uid);
248 case MODEST_TNY_SEND_QUEUE_UNKNONW:
249 case MODEST_TNY_SEND_QUEUE_SUSPENDED:
250 case MODEST_TNY_SEND_QUEUE_FAILED:
251 if (status != MODEST_TNY_SEND_QUEUE_SUSPENDED)
252 tny_header_unset_flags (header, TNY_HEADER_FLAG_PRIORITY);
254 /* Check if it already exists on queue */
255 existing = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE(self), msg_uid);
259 /* Check if its being edited */
260 mgr = modest_runtime_get_window_mgr ();
261 editing = modest_window_mgr_find_registered_header (mgr, header, NULL);
265 /* Add new meesage info */
266 info = g_slice_new (SendInfo);
267 info->msg_id = strdup(msg_uid);
268 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
269 g_queue_push_tail (priv->queue, info);
280 modest_tny_send_queue_get_sentbox (TnySendQueue *self)
283 TnyCamelTransportAccount *account;
285 g_return_val_if_fail (self, NULL);
287 account = tny_camel_send_queue_get_transport_account (TNY_CAMEL_SEND_QUEUE(self));
289 g_printerr ("modest: no account for send queue\n");
292 folder = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
293 TNY_FOLDER_TYPE_SENT);
294 g_object_unref (G_OBJECT(account));
301 modest_tny_send_queue_get_outbox (TnySendQueue *self)
304 TnyCamelTransportAccount *account;
306 g_return_val_if_fail (self, NULL);
308 account = tny_camel_send_queue_get_transport_account (TNY_CAMEL_SEND_QUEUE(self));
310 g_printerr ("modest: no account for send queue\n");
313 folder = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
314 TNY_FOLDER_TYPE_OUTBOX);
316 /* This vfunc's tinymail contract does not allow it to return NULL. */
318 g_warning("%s: Returning NULL.\n", __FUNCTION__);
321 g_object_unref (G_OBJECT(account));
327 modest_tny_send_queue_get_type (void)
329 static GType my_type = 0;
332 static const GTypeInfo my_info = {
333 sizeof(ModestTnySendQueueClass),
334 NULL, /* base init */
335 NULL, /* base finalize */
336 (GClassInitFunc) modest_tny_send_queue_class_init,
337 NULL, /* class finalize */
338 NULL, /* class data */
339 sizeof(ModestTnySendQueue),
341 (GInstanceInitFunc) modest_tny_send_queue_instance_init,
345 my_type = g_type_register_static (TNY_TYPE_CAMEL_SEND_QUEUE,
346 "ModestTnySendQueue",
354 modest_tny_send_queue_class_init (ModestTnySendQueueClass *klass)
356 GObjectClass *gobject_class;
358 gobject_class = (GObjectClass*) klass;
360 parent_class = g_type_class_peek_parent (klass);
361 gobject_class->finalize = modest_tny_send_queue_finalize;
363 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_outbox_func = modest_tny_send_queue_get_outbox;
364 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_sentbox_func = modest_tny_send_queue_get_sentbox;
365 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->cancel_func = modest_tny_send_queue_cancel;
366 klass->status_changed = NULL;
368 signals[STATUS_CHANGED] =
369 g_signal_new ("status_changed",
370 G_TYPE_FROM_CLASS (gobject_class),
372 G_STRUCT_OFFSET (ModestTnySendQueueClass, status_changed),
374 modest_marshal_VOID__STRING_INT,
375 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_INT);
377 g_type_class_add_private (gobject_class, sizeof(ModestTnySendQueuePrivate));
381 modest_tny_send_queue_instance_init (GTypeInstance *instance, gpointer g_class)
383 ModestTnySendQueuePrivate *priv;
385 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (instance);
386 priv->queue = g_queue_new();
387 priv->current = NULL;
391 modest_tny_send_queue_finalize (GObject *obj)
393 ModestTnySendQueuePrivate *priv;
395 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (obj);
397 g_queue_foreach (priv->queue, (GFunc)modest_tny_send_queue_info_free, NULL);
398 g_queue_free (priv->queue);
400 G_OBJECT_CLASS(parent_class)->finalize (obj);
404 modest_tny_send_queue_new (TnyCamelTransportAccount *account)
406 ModestTnySendQueue *self;
408 g_return_val_if_fail (TNY_IS_CAMEL_TRANSPORT_ACCOUNT(account), NULL);
410 self = MODEST_TNY_SEND_QUEUE(g_object_new(MODEST_TYPE_TNY_SEND_QUEUE, NULL));
412 tny_camel_send_queue_set_transport_account (TNY_CAMEL_SEND_QUEUE(self),
415 /* Connect signals to control when a msg is being or has been sent */
416 g_signal_connect (G_OBJECT(self), "msg-sending",
417 G_CALLBACK(_on_msg_start_sending),
419 g_signal_connect (G_OBJECT(self), "msg-sent",
420 G_CALLBACK(_on_msg_has_been_sent),
422 g_signal_connect (G_OBJECT(self), "error-happened",
423 G_CALLBACK(_on_msg_error_happened),
431 modest_tny_send_queue_try_to_send (ModestTnySendQueue* self)
433 TnyIterator *iter = NULL;
434 TnyFolder *outbox = NULL;
435 TnyList *headers = tny_simple_list_new ();
436 TnyHeader *header = NULL;
439 outbox = modest_tny_send_queue_get_outbox (TNY_SEND_QUEUE(self));
443 tny_folder_get_headers (outbox, headers, TRUE, &err);
447 iter = tny_list_create_iterator (headers);
448 while (!tny_iterator_is_done (iter)) {
449 header = TNY_HEADER (tny_iterator_get_current (iter));
451 _add_message (self, header);
452 g_object_unref (header);
455 tny_iterator_next (iter);
458 /* Flush send queue */
459 tny_camel_send_queue_flush (TNY_CAMEL_SEND_QUEUE(self));
463 g_object_unref (G_OBJECT (headers));
465 g_object_unref (G_OBJECT (outbox));
467 g_object_unref (iter);
471 modest_tny_send_queue_msg_is_being_sent (ModestTnySendQueue* self,
474 ModestTnySendQueueStatus status;
476 g_return_val_if_fail (msg_id != NULL, FALSE);
478 status = modest_tny_send_queue_get_msg_status (self, msg_id);
479 return status == MODEST_TNY_SEND_QUEUE_SENDING;
483 modest_tny_send_queue_sending_in_progress (ModestTnySendQueue* self)
485 ModestTnySendQueuePrivate *priv;
486 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
488 return priv->current != NULL;
491 ModestTnySendQueueStatus
492 modest_tny_send_queue_get_msg_status (ModestTnySendQueue *self, const gchar *msg_id)
495 item = modest_tny_send_queue_lookup_info (self, msg_id);
496 if(item == NULL) return MODEST_TNY_SEND_QUEUE_UNKNONW;
497 return ((SendInfo*)item->data)->status;
501 modest_tny_send_queue_get_msg_id (TnyHeader *header)
503 const gchar *uid = NULL;
504 gchar* msg_uid = NULL;
507 /* Get message uid */
508 uid = tny_header_get_uid (header);
510 tmp = g_strsplit (uid, "__", 2);
514 msg_uid = g_strconcat (tmp[0], "_", NULL);
516 msg_uid = g_strdup(tmp[0]);
527 _on_msg_start_sending (TnySendQueue *self,
534 ModestTnySendQueuePrivate *priv = NULL;
536 SendInfo *info = NULL;
537 gchar *msg_id = NULL;
539 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
541 /* Get message uid */
542 msg_id = modest_tny_send_queue_get_msg_id (header);
544 /* Get status info */
545 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), msg_id);
547 g_warning ("%s: item should not be NULL", __FUNCTION__);
550 info->status = MODEST_TNY_SEND_QUEUE_SENDING;
552 /* Set current status item */
553 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
554 priv->current = item;
562 _on_msg_has_been_sent (TnySendQueue *self,
569 ModestTnySendQueuePrivate *priv;
571 gchar *msg_id = NULL;
573 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
575 /* Get message uid */
576 msg_id = modest_tny_send_queue_get_msg_id (header);
578 /* Get status info */
579 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), msg_id);
581 g_warning ("%s: item should not be NULL", __FUNCTION__);
584 /* Remove status info */
585 modest_tny_send_queue_info_free (item->data);
586 g_queue_delete_link (priv->queue, item);
587 priv->current = NULL;
589 modest_platform_information_banner (NULL, NULL, _("mcen_ib_message_sent"));
597 _on_msg_error_happened (TnySendQueue *self,
603 ModestTnySendQueuePrivate *priv = NULL;
604 SendInfo *info = NULL;
606 gchar* msg_uid = NULL;
608 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
610 /* Get sending info (create new if it doesn not exist) */
611 msg_uid = modest_tny_send_queue_get_msg_id (header);
612 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self),
615 info = g_slice_new (SendInfo);
616 info->msg_id = strdup(msg_uid);
617 g_queue_push_tail (priv->queue, info);
621 /* Keep in queue so that we remember that the opertion has failed */
622 /* and was not just cancelled */
623 info->status = MODEST_TNY_SEND_QUEUE_FAILED;
625 /* Notify status has changed */
626 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);