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_unset_flags (header, TNY_HEADER_FLAG_PRIORITY);
169 tny_header_set_flags (header, TNY_HEADER_FLAG_SUSPENDED_PRIORITY);
170 tny_iterator_next (iter);
171 g_object_unref (header);
175 g_queue_foreach (priv->queue, (GFunc)modest_tny_send_queue_info_free, NULL);
176 g_queue_free (priv->queue);
177 priv->queue = g_queue_new();
180 /* Dont call super class implementaiton, becasue camel removes messages from outbox */
181 TNY_CAMEL_SEND_QUEUE_CLASS(parent_class)->cancel_func (self, remove, err); /* FIXME */
185 g_object_unref (G_OBJECT (headers));
187 g_object_unref (G_OBJECT (outbox));
189 g_object_unref (iter);
193 _on_added_to_outbox (TnySendQueue *self, gboolean cancelled, TnyMsg *msg, GError *err, gpointer user_data)
195 ModestTnySendQueuePrivate *priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE(self);
196 TnyHeader *header = NULL;
197 SendInfo *info = NULL;
198 GList* existing = NULL;
199 const gchar* msg_id = NULL;
201 g_return_if_fail (TNY_IS_SEND_QUEUE(self));
202 g_return_if_fail (TNY_IS_CAMEL_MSG(msg));
204 header = tny_msg_get_header (msg);
205 msg_id = modest_tny_send_queue_get_msg_id (header);
206 /* msg_id = tny_header_get_message_id (header); */
207 g_return_if_fail(msg_id != NULL);
209 /* Put newly added message in WAITING state */
210 existing = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE(self), msg_id);
213 info = existing->data;
214 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
219 info = g_slice_new (SendInfo);
221 info->msg_id = strdup(msg_id);
222 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
223 g_queue_push_tail (priv->queue, info);
226 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
228 g_object_unref(G_OBJECT(header));
232 modest_tny_send_queue_add (ModestTnySendQueue *self, TnyMsg *msg, GError **err)
234 g_return_if_fail (MODEST_IS_TNY_SEND_QUEUE(self));
235 g_return_if_fail (TNY_IS_CAMEL_MSG(msg));
237 tny_camel_send_queue_add_async (TNY_CAMEL_SEND_QUEUE(self),
246 _add_message (ModestTnySendQueue *self, TnyHeader *header)
248 ModestWindowMgr *mgr = NULL;
249 ModestTnySendQueuePrivate *priv;
250 SendInfo *info = NULL;
251 GList* existing = NULL;
252 gchar* msg_uid = NULL;
253 ModestTnySendQueueStatus status = MODEST_TNY_SEND_QUEUE_UNKNONW;
254 gboolean editing = FALSE;
256 g_return_if_fail (TNY_IS_SEND_QUEUE(self));
257 g_return_if_fail (TNY_IS_HEADER(header));
258 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
260 /* Check whether the mail is already in the queue */
261 msg_uid = modest_tny_send_queue_get_msg_id (header);
262 status = modest_tny_send_queue_get_msg_status (self, msg_uid);
264 case MODEST_TNY_SEND_QUEUE_UNKNONW:
265 case MODEST_TNY_SEND_QUEUE_SUSPENDED:
266 case MODEST_TNY_SEND_QUEUE_FAILED:
267 if (status != MODEST_TNY_SEND_QUEUE_SUSPENDED)
268 tny_header_unset_flags (header, TNY_HEADER_FLAG_PRIORITY);
270 /* Check if it already exists on queue */
271 existing = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE(self), msg_uid);
275 /* Check if its being edited */
276 mgr = modest_runtime_get_window_mgr ();
277 editing = modest_window_mgr_find_registered_header (mgr, header, NULL);
281 /* Add new meesage info */
282 info = g_slice_new (SendInfo);
283 info->msg_id = strdup(msg_uid);
284 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
285 g_queue_push_tail (priv->queue, info);
296 modest_tny_send_queue_get_sentbox (TnySendQueue *self)
299 TnyCamelTransportAccount *account;
301 g_return_val_if_fail (self, NULL);
303 account = tny_camel_send_queue_get_transport_account (TNY_CAMEL_SEND_QUEUE(self));
305 g_printerr ("modest: no account for send queue\n");
308 folder = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
309 TNY_FOLDER_TYPE_SENT);
310 g_object_unref (G_OBJECT(account));
317 modest_tny_send_queue_get_outbox (TnySendQueue *self)
320 TnyCamelTransportAccount *account;
322 g_return_val_if_fail (self, NULL);
324 account = tny_camel_send_queue_get_transport_account (TNY_CAMEL_SEND_QUEUE(self));
326 g_printerr ("modest: no account for send queue\n");
329 folder = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
330 TNY_FOLDER_TYPE_OUTBOX);
332 /* This vfunc's tinymail contract does not allow it to return NULL. */
334 g_warning("%s: Returning NULL.\n", __FUNCTION__);
337 g_object_unref (G_OBJECT(account));
343 modest_tny_send_queue_get_type (void)
345 static GType my_type = 0;
348 static const GTypeInfo my_info = {
349 sizeof(ModestTnySendQueueClass),
350 NULL, /* base init */
351 NULL, /* base finalize */
352 (GClassInitFunc) modest_tny_send_queue_class_init,
353 NULL, /* class finalize */
354 NULL, /* class data */
355 sizeof(ModestTnySendQueue),
357 (GInstanceInitFunc) modest_tny_send_queue_instance_init,
361 my_type = g_type_register_static (TNY_TYPE_CAMEL_SEND_QUEUE,
362 "ModestTnySendQueue",
370 modest_tny_send_queue_class_init (ModestTnySendQueueClass *klass)
372 GObjectClass *gobject_class;
374 gobject_class = (GObjectClass*) klass;
376 parent_class = g_type_class_peek_parent (klass);
377 gobject_class->finalize = modest_tny_send_queue_finalize;
379 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_outbox_func = modest_tny_send_queue_get_outbox;
380 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_sentbox_func = modest_tny_send_queue_get_sentbox;
381 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->cancel_func = modest_tny_send_queue_cancel;
382 klass->status_changed = NULL;
384 signals[STATUS_CHANGED] =
385 g_signal_new ("status_changed",
386 G_TYPE_FROM_CLASS (gobject_class),
388 G_STRUCT_OFFSET (ModestTnySendQueueClass, status_changed),
390 modest_marshal_VOID__STRING_INT,
391 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_INT);
393 g_type_class_add_private (gobject_class, sizeof(ModestTnySendQueuePrivate));
397 modest_tny_send_queue_instance_init (GTypeInstance *instance, gpointer g_class)
399 ModestTnySendQueuePrivate *priv;
401 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (instance);
402 priv->queue = g_queue_new();
403 priv->current = NULL;
407 modest_tny_send_queue_finalize (GObject *obj)
409 ModestTnySendQueuePrivate *priv;
411 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (obj);
413 g_queue_foreach (priv->queue, (GFunc)modest_tny_send_queue_info_free, NULL);
414 g_queue_free (priv->queue);
416 G_OBJECT_CLASS(parent_class)->finalize (obj);
420 modest_tny_send_queue_new (TnyCamelTransportAccount *account)
422 ModestTnySendQueue *self;
424 g_return_val_if_fail (TNY_IS_CAMEL_TRANSPORT_ACCOUNT(account), NULL);
426 self = MODEST_TNY_SEND_QUEUE(g_object_new(MODEST_TYPE_TNY_SEND_QUEUE, NULL));
428 tny_camel_send_queue_set_transport_account (TNY_CAMEL_SEND_QUEUE(self),
431 /* Connect signals to control when a msg is being or has been sent */
432 g_signal_connect (G_OBJECT(self), "msg-sending",
433 G_CALLBACK(_on_msg_start_sending),
435 g_signal_connect (G_OBJECT(self), "msg-sent",
436 G_CALLBACK(_on_msg_has_been_sent),
438 g_signal_connect (G_OBJECT(self), "error-happened",
439 G_CALLBACK(_on_msg_error_happened),
447 modest_tny_send_queue_try_to_send (ModestTnySendQueue* self)
449 TnyIterator *iter = NULL;
450 TnyFolder *outbox = NULL;
451 TnyList *headers = tny_simple_list_new ();
452 TnyHeader *header = NULL;
455 outbox = modest_tny_send_queue_get_outbox (TNY_SEND_QUEUE(self));
459 tny_folder_get_headers (outbox, headers, TRUE, &err);
463 iter = tny_list_create_iterator (headers);
464 while (!tny_iterator_is_done (iter)) {
465 header = TNY_HEADER (tny_iterator_get_current (iter));
467 _add_message (self, header);
468 g_object_unref (header);
471 tny_iterator_next (iter);
474 /* Flush send queue */
475 tny_camel_send_queue_flush (TNY_CAMEL_SEND_QUEUE(self));
479 g_object_unref (G_OBJECT (headers));
481 g_object_unref (G_OBJECT (outbox));
483 g_object_unref (iter);
487 modest_tny_send_queue_msg_is_being_sent (ModestTnySendQueue* self,
490 ModestTnySendQueueStatus status;
492 g_return_val_if_fail (msg_id != NULL, FALSE);
494 status = modest_tny_send_queue_get_msg_status (self, msg_id);
495 return status == MODEST_TNY_SEND_QUEUE_SENDING;
499 modest_tny_send_queue_sending_in_progress (ModestTnySendQueue* self)
501 ModestTnySendQueuePrivate *priv;
502 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
504 return priv->current != NULL;
507 ModestTnySendQueueStatus
508 modest_tny_send_queue_get_msg_status (ModestTnySendQueue *self, const gchar *msg_id)
511 item = modest_tny_send_queue_lookup_info (self, msg_id);
512 if(item == NULL) return MODEST_TNY_SEND_QUEUE_UNKNONW;
513 return ((SendInfo*)item->data)->status;
517 modest_tny_send_queue_get_msg_id (TnyHeader *header)
519 gchar* msg_uid = NULL;
520 const gchar *subject;
521 time_t date_received;
523 /* Get message uid */
524 subject = tny_header_get_subject (header);
525 date_received = tny_header_get_date_received (header);
527 msg_uid = g_strdup_printf ("%s %d", subject, (int) date_received);
534 _on_msg_start_sending (TnySendQueue *self,
541 ModestTnySendQueuePrivate *priv = NULL;
543 SendInfo *info = NULL;
544 gchar *msg_id = NULL;
546 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
548 /* Get message uid */
549 msg_id = modest_tny_send_queue_get_msg_id (header);
551 /* Get status info */
552 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), msg_id);
554 g_warning ("%s: item should not be NULL", __FUNCTION__);
557 info->status = MODEST_TNY_SEND_QUEUE_SENDING;
559 /* Set current status item */
560 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
561 priv->current = item;
569 _on_msg_has_been_sent (TnySendQueue *self,
576 ModestTnySendQueuePrivate *priv;
577 gchar *msg_id = NULL;
579 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
581 /* Get message uid */
582 msg_id = modest_tny_send_queue_get_msg_id (header);
584 tny_header_set_flags (header, TNY_HEADER_FLAG_SEEN);
586 /* Get status info */
587 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), msg_id);
590 /* Remove status info */
591 modest_tny_send_queue_info_free (item->data);
592 g_queue_delete_link (priv->queue, item);
593 priv->current = NULL;
595 modest_platform_information_banner (NULL, NULL, _("mcen_ib_message_sent"));
603 _on_msg_error_happened (TnySendQueue *self,
609 ModestTnySendQueuePrivate *priv = NULL;
610 SendInfo *info = NULL;
612 gchar* msg_uid = NULL;
614 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
616 /* Get sending info (create new if it doesn not exist) */
617 msg_uid = modest_tny_send_queue_get_msg_id (header);
618 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self),
621 info = g_slice_new (SendInfo);
622 info->msg_id = strdup(msg_uid);
623 g_queue_push_tail (priv->queue, info);
627 /* Keep in queue so that we remember that the opertion has failed */
628 /* and was not just cancelled */
629 info->status = MODEST_TNY_SEND_QUEUE_FAILED;
631 /* Notify status has changed */
632 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);