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 <modest-tny-account.h>
37 #include <modest-runtime.h>
38 #include <modest-platform.h>
39 #include <widgets/modest-window-mgr.h>
40 #include <modest-marshal.h>
41 #include <string.h> /* strcmp */
43 /* 'private'/'protected' functions */
44 static void modest_tny_send_queue_class_init (ModestTnySendQueueClass *klass);
45 static void modest_tny_send_queue_finalize (GObject *obj);
46 static void modest_tny_send_queue_instance_init (GTypeInstance *instance, gpointer g_class);
49 static void _on_msg_start_sending (TnySendQueue *self, TnyHeader *header, TnyMsg *msg, int done, int total, gpointer user_data);
50 static void _on_msg_has_been_sent (TnySendQueue *self, TnyHeader *header, TnyMsg *msg, int done, int total, gpointer user_data);
51 static void _on_msg_error_happened (TnySendQueue *self, TnyHeader *header, TnyMsg *msg, GError *err, gpointer user_data);
53 static TnyFolder*modest_tny_send_queue_get_outbox (TnySendQueue *self);
54 static TnyFolder*modest_tny_send_queue_get_sentbox (TnySendQueue *self);
64 typedef struct _SendInfo SendInfo;
67 ModestTnySendQueueStatus status;
70 typedef struct _ModestTnySendQueuePrivate ModestTnySendQueuePrivate;
71 struct _ModestTnySendQueuePrivate {
75 /* The info that is currently being sent */
79 #define MODEST_TNY_SEND_QUEUE_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
80 MODEST_TYPE_TNY_SEND_QUEUE, \
81 ModestTnySendQueuePrivate))
84 static TnyCamelSendQueueClass *parent_class = NULL;
86 /* uncomment the following if you have defined any signals */
87 static guint signals[LAST_SIGNAL] = {0};
90 * this thread actually tries to send all the mails in the outbox and keeps
91 * track of their state.
95 on_modest_tny_send_queue_compare_id(gconstpointer info, gconstpointer msg_id)
97 return strcmp( ((SendInfo*)info)->msg_id, msg_id);
101 modest_tny_send_queue_info_free(SendInfo *info)
103 g_free(info->msg_id);
104 g_slice_free(SendInfo, info);
108 modest_tny_send_queue_lookup_info (ModestTnySendQueue *self, const gchar *msg_id)
110 ModestTnySendQueuePrivate *priv;
111 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
113 return g_queue_find_custom (priv->queue, msg_id, on_modest_tny_send_queue_compare_id);
117 modest_tny_send_queue_cancel (TnySendQueue *self, gboolean remove, GError **err)
119 ModestTnySendQueuePrivate *priv;
121 TnyIterator *iter = NULL;
122 TnyFolder *outbox = NULL;
123 TnyList *headers = tny_simple_list_new ();
124 TnyHeader *header = NULL;
126 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
127 if(priv->current != NULL)
129 info = priv->current->data;
130 priv->current = NULL;
132 /* Keep in list until retry, so that we know that this was suspended
133 * by the user and not by an error. */
134 info->status = MODEST_TNY_SEND_QUEUE_SUSPENDED;
136 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
139 /* Set flags to supend sending operaiton (if removed, this is not necessary) */
141 outbox = modest_tny_send_queue_get_outbox (TNY_SEND_QUEUE(self));
142 tny_folder_get_headers (outbox, headers, TRUE, err);
143 if (err != NULL) goto frees;
144 iter = tny_list_create_iterator (headers);
145 while (!tny_iterator_is_done (iter)) {
146 header = TNY_HEADER (tny_iterator_get_current (iter));
148 tny_header_unset_flags (header, TNY_HEADER_FLAG_PRIORITY);
149 tny_header_set_flags (header, TNY_HEADER_FLAG_SUSPENDED_PRIORITY);
150 tny_iterator_next (iter);
151 g_object_unref (header);
155 g_queue_foreach (priv->queue, (GFunc)modest_tny_send_queue_info_free, NULL);
156 g_queue_free (priv->queue);
157 priv->queue = g_queue_new();
160 /* Dont call super class implementaiton, becasue camel removes messages from outbox */
161 TNY_CAMEL_SEND_QUEUE_CLASS(parent_class)->cancel_func (self, remove, err); /* FIXME */
165 g_object_unref (G_OBJECT (headers));
167 g_object_unref (G_OBJECT (outbox));
169 g_object_unref (iter);
173 modest_tny_send_queue_add (TnySendQueue *self, TnyMsg *msg, GError **err)
175 ModestTnySendQueuePrivate *priv;
176 TnyHeader *header = NULL;
177 SendInfo *info = NULL;
178 GList* existing = NULL;
179 const gchar* msg_id = NULL;
181 g_return_if_fail (TNY_IS_SEND_QUEUE(self));
182 g_return_if_fail (TNY_IS_CAMEL_MSG(msg));
184 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
185 header = tny_msg_get_header (msg);
187 /* Note that this call actually sets the message id to something
189 TNY_CAMEL_SEND_QUEUE_CLASS(parent_class)->add_func (self, msg, err); /* FIXME */
191 /* Check whether the mail is already in the queue */
192 /* msg_id = tny_header_get_message_id (header); */
193 msg_id = tny_header_get_uid (header);
194 g_return_if_fail (msg_id != NULL);
195 existing = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE(self), msg_id);
198 //g_assert(info->status == MODEST_TNY_SEND_QUEUE_SUSPENDED ||
199 // info->status == MODEST_TNY_SEND_QUEUE_FAILED);
201 info = existing->data;
202 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
207 info = g_slice_new (SendInfo);
209 info->msg_id = strdup(msg_id);
210 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
211 g_queue_push_tail (priv->queue, info);
214 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
217 g_object_unref (header);
221 _add_message (ModestTnySendQueue *self, TnyHeader *header)
223 ModestWindowMgr *mgr = NULL;
224 ModestTnySendQueuePrivate *priv;
225 SendInfo *info = NULL;
226 GList* existing = NULL;
227 gchar* msg_uid = NULL;
228 ModestTnySendQueueStatus status = MODEST_TNY_SEND_QUEUE_WAITING;
229 gboolean editing = FALSE;
231 g_return_if_fail (TNY_IS_SEND_QUEUE(self));
232 g_return_if_fail (TNY_IS_HEADER(header));
233 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
235 /* Check whether the mail is already in the queue */
236 msg_uid = modest_tny_send_queue_get_msg_id (header);
237 status = modest_tny_send_queue_get_msg_status (self, msg_uid);
239 case MODEST_TNY_SEND_QUEUE_UNKNONW:
240 case MODEST_TNY_SEND_QUEUE_SUSPENDED:
241 case MODEST_TNY_SEND_QUEUE_FAILED:
242 if (status != MODEST_TNY_SEND_QUEUE_SUSPENDED)
243 tny_header_unset_flags (header, TNY_HEADER_FLAG_PRIORITY);
245 /* Check if it already exists on queue */
246 existing = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE(self), msg_uid);
247 if(existing != NULL) return;
249 /* Check if its being edited */
250 mgr = modest_runtime_get_window_mgr ();
251 editing = modest_window_mgr_find_registered_header (mgr, header, NULL);
254 /* Add new meesage info */
255 info = g_slice_new (SendInfo);
256 info->msg_id = strdup(msg_uid);
257 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
258 g_queue_push_tail (priv->queue, info);
270 modest_tny_send_queue_get_sentbox (TnySendQueue *self)
273 TnyCamelTransportAccount *account;
275 g_return_val_if_fail (self, NULL);
277 account = tny_camel_send_queue_get_transport_account (TNY_CAMEL_SEND_QUEUE(self));
279 g_printerr ("modest: no account for send queue\n");
282 folder = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
283 TNY_FOLDER_TYPE_SENT);
284 g_object_unref (G_OBJECT(account));
291 modest_tny_send_queue_get_outbox (TnySendQueue *self)
294 TnyCamelTransportAccount *account;
296 g_return_val_if_fail (self, NULL);
298 account = tny_camel_send_queue_get_transport_account (TNY_CAMEL_SEND_QUEUE(self));
300 g_printerr ("modest: no account for send queue\n");
303 folder = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
304 TNY_FOLDER_TYPE_OUTBOX);
306 /* This vfunc's tinymail contract does not allow it to return NULL. */
308 g_warning("%s: Returning NULL.\n", __FUNCTION__);
311 g_object_unref (G_OBJECT(account));
317 modest_tny_send_queue_get_type (void)
319 static GType my_type = 0;
322 static const GTypeInfo my_info = {
323 sizeof(ModestTnySendQueueClass),
324 NULL, /* base init */
325 NULL, /* base finalize */
326 (GClassInitFunc) modest_tny_send_queue_class_init,
327 NULL, /* class finalize */
328 NULL, /* class data */
329 sizeof(ModestTnySendQueue),
331 (GInstanceInitFunc) modest_tny_send_queue_instance_init,
334 my_type = g_type_register_static (TNY_TYPE_CAMEL_SEND_QUEUE,
335 "ModestTnySendQueue",
343 modest_tny_send_queue_class_init (ModestTnySendQueueClass *klass)
345 GObjectClass *gobject_class;
347 gobject_class = (GObjectClass*) klass;
349 parent_class = g_type_class_peek_parent (klass);
350 gobject_class->finalize = modest_tny_send_queue_finalize;
352 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->add_func = modest_tny_send_queue_add;
353 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_outbox_func = modest_tny_send_queue_get_outbox;
354 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_sentbox_func = modest_tny_send_queue_get_sentbox;
355 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->cancel_func = modest_tny_send_queue_cancel;
356 klass->status_changed = NULL;
358 signals[STATUS_CHANGED] =
359 g_signal_new ("status_changed",
360 G_TYPE_FROM_CLASS (gobject_class),
362 G_STRUCT_OFFSET (ModestTnySendQueueClass, status_changed),
364 modest_marshal_VOID__STRING_INT,
365 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_INT);
367 g_type_class_add_private (gobject_class, sizeof(ModestTnySendQueuePrivate));
371 modest_tny_send_queue_instance_init (GTypeInstance *instance, gpointer g_class)
373 ModestTnySendQueuePrivate *priv;
375 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (instance);
376 priv->queue = g_queue_new();
377 priv->current = NULL;
381 modest_tny_send_queue_finalize (GObject *obj)
383 ModestTnySendQueuePrivate *priv;
385 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (obj);
387 g_queue_foreach (priv->queue, (GFunc)modest_tny_send_queue_info_free, NULL);
388 g_queue_free (priv->queue);
390 G_OBJECT_CLASS(parent_class)->finalize (obj);
394 modest_tny_send_queue_new (TnyCamelTransportAccount *account)
396 ModestTnySendQueue *self;
398 g_return_val_if_fail (TNY_IS_CAMEL_TRANSPORT_ACCOUNT(account), NULL);
400 self = MODEST_TNY_SEND_QUEUE(g_object_new(MODEST_TYPE_TNY_SEND_QUEUE, NULL));
402 tny_camel_send_queue_set_transport_account (TNY_CAMEL_SEND_QUEUE(self),
405 /* Connect signals to control when a msg is being or has been sent */
406 g_signal_connect (G_OBJECT(self), "msg-sending",
407 G_CALLBACK(_on_msg_start_sending),
409 g_signal_connect (G_OBJECT(self), "msg-sent",
410 G_CALLBACK(_on_msg_has_been_sent),
412 g_signal_connect (G_OBJECT(self), "error-happened",
413 G_CALLBACK(_on_msg_error_happened),
421 modest_tny_send_queue_try_to_send (ModestTnySendQueue* self)
423 TnyIterator *iter = NULL;
424 TnyFolder *outbox = NULL;
425 TnyList *headers = tny_simple_list_new ();
426 TnyHeader *header = NULL;
429 outbox = modest_tny_send_queue_get_outbox (TNY_SEND_QUEUE(self));
433 tny_folder_get_headers (outbox, headers, TRUE, &err);
437 iter = tny_list_create_iterator (headers);
438 while (!tny_iterator_is_done (iter)) {
439 header = TNY_HEADER (tny_iterator_get_current (iter));
441 _add_message (self, header);
442 g_object_unref (header);
445 tny_iterator_next (iter);
448 /* Flush send queue */
449 tny_camel_send_queue_flush (TNY_CAMEL_SEND_QUEUE(self));
453 g_object_unref (G_OBJECT (headers));
455 g_object_unref (G_OBJECT (outbox));
457 g_object_unref (iter);
461 modest_tny_send_queue_msg_is_being_sent (ModestTnySendQueue* self,
464 ModestTnySendQueueStatus status;
466 g_return_val_if_fail (msg_id != NULL, FALSE);
468 status = modest_tny_send_queue_get_msg_status (self, msg_id);
469 return status == MODEST_TNY_SEND_QUEUE_SENDING;
473 modest_tny_send_queue_sending_in_progress (ModestTnySendQueue* self)
475 ModestTnySendQueuePrivate *priv;
476 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
478 return priv->current != NULL;
481 ModestTnySendQueueStatus
482 modest_tny_send_queue_get_msg_status (ModestTnySendQueue *self, const gchar *msg_id)
485 item = modest_tny_send_queue_lookup_info (self, msg_id);
486 if(item == NULL) return MODEST_TNY_SEND_QUEUE_UNKNONW;
487 return ((SendInfo*)item->data)->status;
491 modest_tny_send_queue_get_msg_id (TnyHeader *header)
493 const gchar *uid = NULL;
494 gchar* msg_uid = NULL;
497 /* Get message uid */
498 uid = tny_header_get_uid (header);
500 tmp = g_strsplit (uid, "__", 2);
504 msg_uid = g_strconcat (tmp[0], "_", NULL);
506 msg_uid = g_strdup(tmp[0]);
517 _on_msg_start_sending (TnySendQueue *self,
524 ModestTnySendQueuePrivate *priv = NULL;
526 SendInfo *info = NULL;
527 gchar *msg_id = NULL;
529 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
531 /* Get message uid */
532 msg_id = modest_tny_send_queue_get_msg_id (header);
534 /* Get status info */
535 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), msg_id);
536 g_return_if_fail (item != NULL);
538 info->status = MODEST_TNY_SEND_QUEUE_SENDING;
540 /* Set current status item */
541 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
542 priv->current = item;
549 _on_msg_has_been_sent (TnySendQueue *self,
556 ModestTnySendQueuePrivate *priv;
558 gchar *msg_id = NULL;
560 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
562 /* Get message uid */
563 msg_id = modest_tny_send_queue_get_msg_id (header);
565 /* Get status info */
566 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), msg_id);
567 g_return_if_fail(item != NULL);
569 /* Remove status info */
570 modest_tny_send_queue_info_free (item->data);
571 g_queue_delete_link (priv->queue, item);
572 priv->current = NULL;
574 modest_platform_information_banner (NULL, NULL, _("mcen_ib_message_sent"));
581 _on_msg_error_happened (TnySendQueue *self,
587 ModestTnySendQueuePrivate *priv = NULL;
588 SendInfo *info = NULL;
590 gchar* msg_uid = NULL;
592 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
594 /* Get sending info (create new if it doesn not exist) */
595 msg_uid = modest_tny_send_queue_get_msg_id (header);
596 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self),
599 info = g_slice_new (SendInfo);
600 info->msg_id = strdup(msg_uid);
601 g_queue_push_tail (priv->queue, info);
607 /* Keep in queue so that we remember that the opertion has failed */
608 /* and was not just cancelled */
609 info->status = MODEST_TNY_SEND_QUEUE_FAILED;
611 /* Notify status has changed */
612 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);