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-marshal.h>
38 #include <string.h> /* strcmp */
40 /* 'private'/'protected' functions */
41 static void modest_tny_send_queue_class_init (ModestTnySendQueueClass *klass);
42 static void modest_tny_send_queue_finalize (GObject *obj);
43 static void modest_tny_send_queue_instance_init (GTypeInstance *instance, gpointer g_class);
46 /* static void _on_msg_start_sending (TnySendQueue *self, TnyMsg *msg, gpointer user_data); */
47 static void _on_msg_has_been_sent (TnySendQueue *self, TnyMsg *msg, gpointer user_data);
48 static void _on_msg_error_happened (TnySendQueue *self, TnyHeader *header, TnyMsg *msg, GError *err, gpointer user_data);
50 static TnyFolder*modest_tny_send_queue_get_outbox (TnySendQueue *self);
51 static TnyFolder*modest_tny_send_queue_get_sentbox (TnySendQueue *self);
61 typedef struct _SendInfo SendInfo;
64 ModestTnySendQueueStatus status;
67 typedef struct _ModestTnySendQueuePrivate ModestTnySendQueuePrivate;
68 struct _ModestTnySendQueuePrivate {
72 /* The info that is currently being sent */
76 #define MODEST_TNY_SEND_QUEUE_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
77 MODEST_TYPE_TNY_SEND_QUEUE, \
78 ModestTnySendQueuePrivate))
81 static TnyCamelSendQueueClass *parent_class = NULL;
83 /* uncomment the following if you have defined any signals */
84 static guint signals[LAST_SIGNAL] = {0};
87 * this thread actually tries to send all the mails in the outbox and keeps
88 * track of their state.
92 on_modest_tny_send_queue_compare_id(gconstpointer info, gconstpointer msg_id)
94 return strcmp( ((SendInfo*)info)->msg_id, msg_id);
98 modest_tny_send_queue_info_free(SendInfo *info)
100 g_free(info->msg_id);
101 g_slice_free(SendInfo, info);
105 modest_tny_send_queue_lookup_info (ModestTnySendQueue *self, const gchar *msg_id)
107 ModestTnySendQueuePrivate *priv;
108 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
110 return g_queue_find_custom (priv->queue, msg_id, on_modest_tny_send_queue_compare_id);
114 modest_tny_send_queue_cancel (TnySendQueue *self, gboolean remove, GError **err)
116 ModestTnySendQueuePrivate *priv;
118 TnyIterator *iter = NULL;
119 TnyFolder *outbox = NULL;
120 TnyList *headers = tny_simple_list_new ();
121 TnyHeader *header = NULL;
123 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
124 if(priv->current != NULL)
126 info = priv->current->data;
127 priv->current = NULL;
129 /* Keep in list until retry, so that we know that this was suspended
130 * by the user and not by an error. */
131 info->status = MODEST_TNY_SEND_QUEUE_SUSPENDED;
133 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
136 /* Set flags to supend sending operaiton (if removed, this is not necessary) */
138 outbox = modest_tny_send_queue_get_outbox (TNY_SEND_QUEUE(self));
139 tny_folder_get_headers (outbox, headers, TRUE, err);
140 if (err != NULL) goto frees;
141 iter = tny_list_create_iterator (headers);
142 while (!tny_iterator_is_done (iter)) {
143 header = TNY_HEADER (tny_iterator_get_current (iter));
144 tny_header_unset_flags (header, TNY_HEADER_FLAG_PRIORITY);
145 tny_header_set_flags (header, TNY_HEADER_FLAG_SUSPENDED_PRIORITY);
146 tny_iterator_next (iter);
147 g_object_unref (header);
150 g_queue_foreach (priv->queue, (GFunc)modest_tny_send_queue_info_free, NULL);
151 g_queue_free (priv->queue);
152 priv->queue = g_queue_new();
155 /* Dont call super class implementaiton, becasue camel removes messages from outbox */
156 TNY_CAMEL_SEND_QUEUE_CLASS(parent_class)->cancel_func (self, remove, err); /* FIXME */
160 g_object_unref (G_OBJECT (headers));
162 g_object_unref (G_OBJECT (outbox));
164 g_object_unref (iter);
168 modest_tny_send_queue_add (TnySendQueue *self, TnyMsg *msg, GError **err)
170 ModestTnySendQueuePrivate *priv;
172 SendInfo *info = NULL;
176 g_return_if_fail (TNY_IS_SEND_QUEUE(self));
177 g_return_if_fail (TNY_IS_CAMEL_MSG(msg));
179 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
180 header = tny_msg_get_header (msg);
182 /* FIXME: do something smart here... */
184 /* Note that this call actually sets the message id to something
186 TNY_CAMEL_SEND_QUEUE_CLASS(parent_class)->add_func (self, msg, err); /* FIXME */
188 /* Check whether the mail is already in the queue */
189 /* msg_id = tny_header_get_message_id (header); */
190 msg_id = tny_header_get_uid (header);
191 g_return_if_fail (msg_id != NULL);
192 existing = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE(self), msg_id);
195 //g_assert(info->status == MODEST_TNY_SEND_QUEUE_SUSPENDED ||
196 // info->status == MODEST_TNY_SEND_QUEUE_FAILED);
198 info = existing->data;
199 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
204 info = g_slice_new (SendInfo);
206 info->msg_id = strdup(msg_id);
207 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
208 g_queue_push_tail (priv->queue, info);
211 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
215 _add_message (ModestTnySendQueue *self, TnyHeader *header)
217 ModestTnySendQueuePrivate *priv;
218 SendInfo *info = NULL;
219 GList* existing = NULL;
220 gchar* msg_uid = NULL;
221 ModestTnySendQueueStatus status = MODEST_TNY_SEND_QUEUE_WAITING;
223 g_return_if_fail (TNY_IS_SEND_QUEUE(self));
224 g_return_if_fail (TNY_IS_HEADER(header));
225 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
227 /* Check whether the mail is already in the queue */
228 msg_uid = modest_tny_send_queue_get_msg_id (header);
229 status = modest_tny_send_queue_get_msg_status (self, msg_uid);
231 case MODEST_TNY_SEND_QUEUE_UNKNONW:
232 case MODEST_TNY_SEND_QUEUE_SUSPENDED:
233 case MODEST_TNY_SEND_QUEUE_FAILED:
234 if (status != MODEST_TNY_SEND_QUEUE_SUSPENDED)
235 tny_header_unset_flags (header, TNY_HEADER_FLAG_PRIORITY);
236 existing = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE(self), msg_uid);
237 if(existing != NULL) return;
239 /* Add new meesage info */
240 info = g_slice_new (SendInfo);
241 info->msg_id = strdup(msg_uid);
242 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
243 g_queue_push_tail (priv->queue, info);
255 modest_tny_send_queue_get_sentbox (TnySendQueue *self)
258 TnyCamelTransportAccount *account;
260 g_return_val_if_fail (self, NULL);
262 account = tny_camel_send_queue_get_transport_account (TNY_CAMEL_SEND_QUEUE(self));
264 g_printerr ("modest: no account for send queue\n");
267 folder = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
268 TNY_FOLDER_TYPE_SENT);
269 g_object_unref (G_OBJECT(account));
276 modest_tny_send_queue_get_outbox (TnySendQueue *self)
279 TnyCamelTransportAccount *account;
281 g_return_val_if_fail (self, NULL);
283 account = tny_camel_send_queue_get_transport_account (TNY_CAMEL_SEND_QUEUE(self));
285 g_printerr ("modest: no account for send queue\n");
288 folder = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
289 TNY_FOLDER_TYPE_OUTBOX);
291 /* This vfunc's tinymail contract does not allow it to return NULL. */
293 g_warning("%s: Returning NULL.\n", __FUNCTION__);
296 g_object_unref (G_OBJECT(account));
302 modest_tny_send_queue_get_type (void)
304 static GType my_type = 0;
307 static const GTypeInfo my_info = {
308 sizeof(ModestTnySendQueueClass),
309 NULL, /* base init */
310 NULL, /* base finalize */
311 (GClassInitFunc) modest_tny_send_queue_class_init,
312 NULL, /* class finalize */
313 NULL, /* class data */
314 sizeof(ModestTnySendQueue),
316 (GInstanceInitFunc) modest_tny_send_queue_instance_init,
319 my_type = g_type_register_static (TNY_TYPE_CAMEL_SEND_QUEUE,
320 "ModestTnySendQueue",
328 modest_tny_send_queue_class_init (ModestTnySendQueueClass *klass)
330 GObjectClass *gobject_class;
332 gobject_class = (GObjectClass*) klass;
334 parent_class = g_type_class_peek_parent (klass);
335 gobject_class->finalize = modest_tny_send_queue_finalize;
337 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->add_func = modest_tny_send_queue_add;
338 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_outbox_func = modest_tny_send_queue_get_outbox;
339 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_sentbox_func = modest_tny_send_queue_get_sentbox;
340 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->cancel_func = modest_tny_send_queue_cancel;
341 klass->status_changed = NULL;
343 signals[STATUS_CHANGED] =
344 g_signal_new ("status_changed",
345 G_TYPE_FROM_CLASS (gobject_class),
347 G_STRUCT_OFFSET (ModestTnySendQueueClass, status_changed),
349 modest_marshal_VOID__STRING_INT,
350 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_INT);
352 g_type_class_add_private (gobject_class, sizeof(ModestTnySendQueuePrivate));
356 modest_tny_send_queue_instance_init (GTypeInstance *instance, gpointer g_class)
358 ModestTnySendQueuePrivate *priv;
360 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (instance);
361 priv->queue = g_queue_new();
362 priv->current = NULL;
366 modest_tny_send_queue_finalize (GObject *obj)
368 ModestTnySendQueuePrivate *priv;
370 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (obj);
372 g_queue_foreach (priv->queue, (GFunc)modest_tny_send_queue_info_free, NULL);
373 g_queue_free (priv->queue);
375 G_OBJECT_CLASS(parent_class)->finalize (obj);
379 modest_tny_send_queue_new (TnyCamelTransportAccount *account)
381 ModestTnySendQueue *self;
383 g_return_val_if_fail (TNY_IS_CAMEL_TRANSPORT_ACCOUNT(account), NULL);
385 self = MODEST_TNY_SEND_QUEUE(g_object_new(MODEST_TYPE_TNY_SEND_QUEUE, NULL));
387 tny_camel_send_queue_set_transport_account (TNY_CAMEL_SEND_QUEUE(self),
390 /* Connect signals to control when a msg is being or has been sent */
391 /* TODO: this signal was implemented in tinymail camel send queue, but im
392 waiting for implement some unit tests nbefore commited changes */
394 /* g_signal_connect (G_OBJECT(self), "msg-sending", */
395 /* G_CALLBACK(_on_msg_start_sending), */
399 g_signal_connect (G_OBJECT(self), "msg-sent",
400 G_CALLBACK(_on_msg_has_been_sent),
402 g_signal_connect (G_OBJECT(self), "error-happened",
403 G_CALLBACK(_on_msg_error_happened),
411 modest_tny_send_queue_try_to_send (ModestTnySendQueue* self)
413 TnyIterator *iter = NULL;
414 TnyFolder *outbox = NULL;
415 TnyList *headers = tny_simple_list_new ();
416 TnyHeader *header = NULL;
419 outbox = modest_tny_send_queue_get_outbox (TNY_SEND_QUEUE(self));
420 tny_folder_get_headers (outbox, headers, TRUE, &err);
421 if (err != NULL) goto frees;
422 iter = tny_list_create_iterator (headers);
423 while (!tny_iterator_is_done (iter)) {
424 header = TNY_HEADER (tny_iterator_get_current (iter));
425 _add_message (self, header);
426 tny_iterator_next (iter);
427 g_object_unref (header);
430 /* Flush send queue */
431 tny_camel_send_queue_flush (TNY_CAMEL_SEND_QUEUE(self));
435 g_object_unref (G_OBJECT (headers));
437 g_object_unref (G_OBJECT (outbox));
439 g_object_unref (iter);
443 modest_tny_send_queue_msg_is_being_sent (ModestTnySendQueue* self,
446 ModestTnySendQueueStatus status;
448 g_return_val_if_fail (msg_id != NULL, FALSE);
450 status = modest_tny_send_queue_get_msg_status (self, msg_id);
451 return status == MODEST_TNY_SEND_QUEUE_SENDING;
455 modest_tny_send_queue_sending_in_progress (ModestTnySendQueue* self)
457 ModestTnySendQueuePrivate *priv;
458 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
460 return priv->current != NULL;
463 ModestTnySendQueueStatus
464 modest_tny_send_queue_get_msg_status (ModestTnySendQueue *self, const gchar *msg_id)
467 item = modest_tny_send_queue_lookup_info (self, msg_id);
468 if(item == NULL) return MODEST_TNY_SEND_QUEUE_UNKNONW;
469 return ((SendInfo*)item->data)->status;
473 modest_tny_send_queue_get_msg_id (TnyHeader *header)
475 const gchar *uid = NULL;
476 gchar* msg_uid = NULL;
479 /* Get message uid */
480 uid = tny_header_get_uid (header);
481 tmp = g_strsplit (uid, "__", 2);
483 msg_uid = g_strconcat (tmp[0], "_", NULL);
485 msg_uid = g_strdup(tmp[0]);
495 /* _on_msg_start_sending (TnySendQueue *self, */
497 /* gpointer user_data) */
499 /* ModestTnySendQueuePrivate *priv; */
500 /* TnyHeader *header; */
502 /* SendInfo *info; */
504 /* priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self); */
506 /* header = tny_msg_get_header(msg); */
507 /* item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), tny_header_get_message_id (header)); */
509 /* if (item != NULL) */
511 /* info = item->data; */
512 /* info->status = MODEST_TNY_SEND_QUEUE_SENDING; */
514 /* g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status); */
517 /* priv->current = item; */
521 _on_msg_has_been_sent (TnySendQueue *self,
525 ModestTnySendQueuePrivate *priv;
529 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
531 header = tny_msg_get_header (msg);
533 /* TODO: Use this version as soon as the msg-sending
534 * notification works */
536 item = priv->current;
537 g_assert(item != NULL);
539 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), tny_header_get_message_id(header));
540 g_assert(item != NULL);
543 modest_tny_send_queue_info_free (item->data);
544 g_queue_delete_link (priv->queue, item);
545 priv->current = NULL;
548 static void _on_msg_error_happened (TnySendQueue *self,
554 ModestTnySendQueuePrivate *priv = NULL;
555 SendInfo *info = NULL;
557 gchar* msg_uid = NULL;
559 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
561 /* Get sending info (create new if it doesn not exist) */
562 msg_uid = modest_tny_send_queue_get_msg_id (header);
563 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self),
566 info = g_slice_new (SendInfo);
567 info->msg_id = strdup(msg_uid);
568 g_queue_push_tail (priv->queue, info);
574 /* Keep in queue so that we remember that the opertion has failed */
575 /* and was not just cancelled */
576 info->status = MODEST_TNY_SEND_QUEUE_FAILED;
578 /* Notify status has changed */
579 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);