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;
119 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
120 if(priv->current != NULL)
122 info = priv->current->data;
123 priv->current = NULL;
125 /* Keep in list until retry, so that we know that this was suspended
126 * by the user and not by an error. */
127 info->status = MODEST_TNY_SEND_QUEUE_SUSPENDED;
129 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
132 /* Set flags to supend sending operaiton (if removed, this is not necessary) */
134 TnyIterator *iter = NULL;
135 TnyFolder *outbox = NULL;
136 TnyList *headers = tny_simple_list_new ();
137 outbox = modest_tny_send_queue_get_outbox (self);
138 tny_folder_get_headers (outbox, headers, TRUE, err);
139 if (err != NULL && *err != NULL) goto frees;
140 iter = tny_list_create_iterator (headers);
141 while (!tny_iterator_is_done (iter)) {
142 TnyHeader *header = TNY_HEADER (tny_iterator_get_current (iter));
143 tny_header_unset_flags (header, TNY_HEADER_FLAG_PRIORITY);
144 tny_header_set_flags (header, TNY_HEADER_FLAG_SUSPENDED_PRIORITY);
145 g_object_unref (header);
146 tny_iterator_next (iter);
149 g_object_unref (G_OBJECT (headers));
150 g_object_unref (G_OBJECT (outbox));
153 /* Dont call super class implementaiton, becasue camel removes messages from outbox */
154 TNY_CAMEL_SEND_QUEUE_CLASS(parent_class)->cancel_func (self, remove, err); /* FIXME */
158 modest_tny_send_queue_add (TnySendQueue *self, TnyMsg *msg, GError **err)
160 ModestTnySendQueuePrivate *priv;
162 SendInfo *info = NULL;
166 g_return_if_fail (TNY_IS_SEND_QUEUE(self));
167 g_return_if_fail (TNY_IS_CAMEL_MSG(msg));
169 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
170 header = tny_msg_get_header (msg);
172 /* FIXME: do something smart here... */
174 /* Note that this call actually sets the message id to something
176 TNY_CAMEL_SEND_QUEUE_CLASS(parent_class)->add_func (self, msg, err); /* FIXME */
178 /* Check whether the mail is already in the queue */
179 msg_id = tny_header_get_message_id (header);
180 existing = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE(self), msg_id);
183 //g_assert(info->status == MODEST_TNY_SEND_QUEUE_SUSPENDED ||
184 // info->status == MODEST_TNY_SEND_QUEUE_FAILED);
186 info = existing->data;
187 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
192 info = g_slice_new (SendInfo);
194 info->msg_id = strdup(msg_id);
195 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
196 g_queue_push_tail (priv->queue, info);
199 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
203 modest_tny_send_queue_get_sentbox (TnySendQueue *self)
206 TnyCamelTransportAccount *account;
208 g_return_val_if_fail (self, NULL);
210 account = tny_camel_send_queue_get_transport_account (TNY_CAMEL_SEND_QUEUE(self));
212 g_printerr ("modest: no account for send queue\n");
215 folder = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
216 TNY_FOLDER_TYPE_SENT);
217 g_object_unref (G_OBJECT(account));
224 modest_tny_send_queue_get_outbox (TnySendQueue *self)
227 TnyCamelTransportAccount *account;
229 g_return_val_if_fail (self, NULL);
231 account = tny_camel_send_queue_get_transport_account (TNY_CAMEL_SEND_QUEUE(self));
233 g_printerr ("modest: no account for send queue\n");
236 folder = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
237 TNY_FOLDER_TYPE_OUTBOX);
239 /* This vfunc's tinymail contract does not allow it to return NULL. */
241 g_warning("%s: Returning NULL.\n", __FUNCTION__);
244 g_object_unref (G_OBJECT(account));
250 modest_tny_send_queue_get_type (void)
252 static GType my_type = 0;
255 static const GTypeInfo my_info = {
256 sizeof(ModestTnySendQueueClass),
257 NULL, /* base init */
258 NULL, /* base finalize */
259 (GClassInitFunc) modest_tny_send_queue_class_init,
260 NULL, /* class finalize */
261 NULL, /* class data */
262 sizeof(ModestTnySendQueue),
264 (GInstanceInitFunc) modest_tny_send_queue_instance_init,
267 my_type = g_type_register_static (TNY_TYPE_CAMEL_SEND_QUEUE,
268 "ModestTnySendQueue",
276 modest_tny_send_queue_class_init (ModestTnySendQueueClass *klass)
278 GObjectClass *gobject_class;
280 gobject_class = (GObjectClass*) klass;
282 parent_class = g_type_class_peek_parent (klass);
283 gobject_class->finalize = modest_tny_send_queue_finalize;
285 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->add_func = modest_tny_send_queue_add;
286 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_outbox_func = modest_tny_send_queue_get_outbox;
287 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_sentbox_func = modest_tny_send_queue_get_sentbox;
288 TNY_CAMEL_SEND_QUEUE_CLASS(klass)->cancel_func = modest_tny_send_queue_cancel;
289 klass->status_changed = NULL;
291 signals[STATUS_CHANGED] =
292 g_signal_new ("status_changed",
293 G_TYPE_FROM_CLASS (gobject_class),
295 G_STRUCT_OFFSET (ModestTnySendQueueClass, status_changed),
297 modest_marshal_VOID__STRING_INT,
298 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_INT);
300 g_type_class_add_private (gobject_class, sizeof(ModestTnySendQueuePrivate));
304 modest_tny_send_queue_instance_init (GTypeInstance *instance, gpointer g_class)
306 ModestTnySendQueuePrivate *priv;
308 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (instance);
309 priv->queue = g_queue_new();
310 priv->current = NULL;
314 modest_tny_send_queue_finalize (GObject *obj)
316 ModestTnySendQueuePrivate *priv;
318 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (obj);
320 g_queue_foreach (priv->queue, (GFunc)modest_tny_send_queue_info_free, NULL);
321 g_queue_free (priv->queue);
323 G_OBJECT_CLASS(parent_class)->finalize (obj);
327 modest_tny_send_queue_new (TnyCamelTransportAccount *account)
329 ModestTnySendQueue *self;
331 g_return_val_if_fail (TNY_IS_CAMEL_TRANSPORT_ACCOUNT(account), NULL);
333 self = MODEST_TNY_SEND_QUEUE(g_object_new(MODEST_TYPE_TNY_SEND_QUEUE, NULL));
335 tny_camel_send_queue_set_transport_account (TNY_CAMEL_SEND_QUEUE(self),
338 /* Connect signals to control when a msg is being or has been sent */
339 /* TODO: this signal was implemented in tinymail camel send queue, but im
340 waiting for implement some unit tests nbefore commited changes */
342 /* g_signal_connect (G_OBJECT(self), "msg-sending", */
343 /* G_CALLBACK(_on_msg_start_sending), */
347 g_signal_connect (G_OBJECT(self), "msg-sent",
348 G_CALLBACK(_on_msg_has_been_sent),
350 g_signal_connect (G_OBJECT(self), "error-happened",
351 G_CALLBACK(_on_msg_error_happened),
359 modest_tny_send_queue_try_to_send (ModestTnySendQueue* self)
361 /* Flush send queue */
362 tny_camel_send_queue_flush (TNY_CAMEL_SEND_QUEUE(self));
366 modest_tny_send_queue_msg_is_being_sent (ModestTnySendQueue* self,
369 ModestTnySendQueueStatus status;
371 g_return_val_if_fail (msg_id != NULL, FALSE);
373 status = modest_tny_send_queue_get_msg_status (self, msg_id);
374 return status == MODEST_TNY_SEND_QUEUE_SENDING;
378 modest_tny_send_queue_sending_in_progress (ModestTnySendQueue* self)
380 ModestTnySendQueuePrivate *priv;
381 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
383 return priv->current != NULL;
386 ModestTnySendQueueStatus
387 modest_tny_send_queue_get_msg_status (ModestTnySendQueue *self, const gchar *msg_id)
390 item = modest_tny_send_queue_lookup_info (self, msg_id);
391 if(item == NULL) return MODEST_TNY_SEND_QUEUE_SUSPENDED;
392 return ((SendInfo*)item->data)->status;
396 /* _on_msg_start_sending (TnySendQueue *self, */
398 /* gpointer user_data) */
400 /* ModestTnySendQueuePrivate *priv; */
401 /* TnyHeader *header; */
403 /* SendInfo *info; */
405 /* priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self); */
407 /* header = tny_msg_get_header(msg); */
408 /* item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), tny_header_get_message_id (header)); */
410 /* if (item != NULL) */
412 /* info = item->data; */
413 /* info->status = MODEST_TNY_SEND_QUEUE_SENDING; */
415 /* g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status); */
418 /* priv->current = item; */
422 _on_msg_has_been_sent (TnySendQueue *self,
426 ModestTnySendQueuePrivate *priv;
430 priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
432 header = tny_msg_get_header (msg);
434 /* TODO: Use this version as soon as the msg-sending
435 * notification works */
437 item = priv->current;
438 g_assert(item != NULL);
440 item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), tny_header_get_message_id(header));
441 g_assert(item != NULL);
444 modest_tny_send_queue_info_free (item->data);
445 g_queue_delete_link (priv->queue, item);
446 priv->current = NULL;
449 static void _on_msg_error_happened (TnySendQueue *self,
455 /* ModestTnySendQueuePrivate *priv; */
456 /* SendInfo *info; */
458 /* TnyHeader *msg_header; */
460 /* priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self); */
462 /* TODO: Use this version as soon as the msg-sending
463 * notification works */
465 /* item = priv->current; */
466 /* g_assert(item != NULL); */
467 /* info = priv->current->data; */
469 /* /\* TODO: Why do we get the msg and its header separately? The docs */
470 /* * don't really tell. *\/ */
471 /* g_assert(header == tny_msg_get_header (msg)); // ???? */
472 /* msg_header = tny_msg_get_header (msg); */
473 /* item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), */
474 /* tny_header_get_message_id (msg_header)); */
475 /* g_object_unref (msg_header); */
476 /* g_assert(item != NULL); */
477 /* info = item->data; */
480 /* Keep in queue so that we remember that the opertion has failed
481 * and was not just cancelled */
482 /* info->status = MODEST_TNY_SEND_QUEUE_FAILED; */
483 /* g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status); */