2007-07-25 Murray Cumming <murrayc@murrayc.com>
[modest] / src / modest-tny-send-queue.c
1 /* Copyright (c) 2006, Nokia Corporation
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
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.
16  *
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.
28  */
29
30
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 */
39
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);
44
45 /* Signal handlers */ 
46 static void _on_msg_start_sending (TnySendQueue *self, TnyHeader *header, TnyMsg *msg, int done, int total, gpointer user_data);
47 static void _on_msg_has_been_sent (TnySendQueue *self, TnyHeader *header, TnyMsg *msg, int done, int total, gpointer user_data);
48 static void _on_msg_error_happened (TnySendQueue *self, TnyHeader *header, TnyMsg *msg, GError *err, gpointer user_data);
49
50 static TnyFolder*modest_tny_send_queue_get_outbox (TnySendQueue *self);
51 static TnyFolder*modest_tny_send_queue_get_sentbox (TnySendQueue *self);
52
53 /* list my signals  */
54 enum {
55         STATUS_CHANGED,
56         /* MY_SIGNAL_1, */
57         /* MY_SIGNAL_2, */
58         LAST_SIGNAL
59 };
60
61 typedef struct _SendInfo SendInfo;
62 struct _SendInfo {
63         gchar* msg_id;
64         ModestTnySendQueueStatus status;
65 };
66
67 typedef struct _ModestTnySendQueuePrivate ModestTnySendQueuePrivate;
68 struct _ModestTnySendQueuePrivate {
69         /* Queued infos */
70         GQueue* queue;
71
72         /* The info that is currently being sent */
73         GList* current;
74 };
75
76 #define MODEST_TNY_SEND_QUEUE_GET_PRIVATE(o)      (G_TYPE_INSTANCE_GET_PRIVATE((o), \
77                                                    MODEST_TYPE_TNY_SEND_QUEUE, \
78                                                    ModestTnySendQueuePrivate))
79
80 /* globals */
81 static TnyCamelSendQueueClass *parent_class = NULL;
82
83 /* uncomment the following if you have defined any signals */
84 static guint signals[LAST_SIGNAL] = {0};
85
86 /*
87  * this thread actually tries to send all the mails in the outbox and keeps
88  * track of their state.
89  */
90
91 static int
92 on_modest_tny_send_queue_compare_id(gconstpointer info, gconstpointer msg_id)
93 {
94         return strcmp( ((SendInfo*)info)->msg_id, msg_id);
95 }
96
97 static void
98 modest_tny_send_queue_info_free(SendInfo *info)
99 {
100         g_free(info->msg_id);
101         g_slice_free(SendInfo, info);
102 }
103
104 static GList*
105 modest_tny_send_queue_lookup_info (ModestTnySendQueue *self, const gchar *msg_id)
106 {
107         ModestTnySendQueuePrivate *priv;
108         priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
109
110         return g_queue_find_custom (priv->queue, msg_id, on_modest_tny_send_queue_compare_id);
111 }
112
113 static void
114 modest_tny_send_queue_cancel (TnySendQueue *self, gboolean remove, GError **err)
115 {
116         ModestTnySendQueuePrivate *priv;
117         SendInfo *info;
118         TnyIterator *iter = NULL;
119         TnyFolder *outbox = NULL;
120         TnyList *headers = tny_simple_list_new ();
121         TnyHeader *header = NULL;
122
123         priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
124         if(priv->current != NULL)
125         {
126                 info = priv->current->data;
127                 priv->current = NULL;
128
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;
132
133                 g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
134         }
135
136         /* Set flags to supend sending operaiton (if removed, this is not necessary) */
137         if (!remove) {          
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                         if (header) {   
145                                 tny_header_unset_flags (header, TNY_HEADER_FLAG_PRIORITY);
146                                 tny_header_set_flags (header, TNY_HEADER_FLAG_SUSPENDED_PRIORITY);
147                                 tny_iterator_next (iter);
148                                 g_object_unref (header);
149                         }
150                 }
151                 
152                 g_queue_foreach (priv->queue, (GFunc)modest_tny_send_queue_info_free, NULL);
153                 g_queue_free (priv->queue);
154                 priv->queue = g_queue_new();
155         }
156                 
157         /* Dont call super class implementaiton, becasue camel removes messages from outbox */
158         TNY_CAMEL_SEND_QUEUE_CLASS(parent_class)->cancel_func (self, remove, err); /* FIXME */
159
160  frees:
161         if (headers != NULL)
162                 g_object_unref (G_OBJECT (headers));
163         if (outbox != NULL) 
164                 g_object_unref (G_OBJECT (outbox));
165         if (iter != NULL) 
166                 g_object_unref (iter);
167 }
168
169 static void
170 modest_tny_send_queue_add (TnySendQueue *self, TnyMsg *msg, GError **err)
171 {
172         ModestTnySendQueuePrivate *priv;
173         TnyHeader *header;
174         SendInfo *info = NULL;
175         GList* existing;
176         const gchar* msg_id;
177
178         g_return_if_fail (TNY_IS_SEND_QUEUE(self));
179         g_return_if_fail (TNY_IS_CAMEL_MSG(msg));
180
181         priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
182         header = tny_msg_get_header (msg);
183
184         /* FIXME: do something smart here... */
185
186         /* Note that this call actually sets the message id to something
187          * sensible. */ 
188         TNY_CAMEL_SEND_QUEUE_CLASS(parent_class)->add_func (self, msg, err); /* FIXME */
189
190         /* Check whether the mail is already in the queue */
191 /*      msg_id = tny_header_get_message_id (header); */
192         msg_id = tny_header_get_uid (header);   
193         g_return_if_fail (msg_id != NULL);
194         existing = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE(self), msg_id);
195         if(existing != NULL)
196         {
197                 //g_assert(info->status == MODEST_TNY_SEND_QUEUE_SUSPENDED ||
198                 //        info->status == MODEST_TNY_SEND_QUEUE_FAILED);
199
200                 info = existing->data;
201                 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
202         }
203         else
204         {
205                 
206                 info = g_slice_new (SendInfo);
207
208                 info->msg_id = strdup(msg_id);
209                 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
210                 g_queue_push_tail (priv->queue, info);
211         }
212
213         g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
214
215         /* free */
216         g_object_unref (header);
217 }
218
219 static void
220 _add_message (ModestTnySendQueue *self, TnyHeader *header)
221 {
222         ModestTnySendQueuePrivate *priv;
223         SendInfo *info = NULL;
224         GList* existing = NULL;
225         gchar* msg_uid = NULL;
226         ModestTnySendQueueStatus status = MODEST_TNY_SEND_QUEUE_WAITING;
227
228         g_return_if_fail (TNY_IS_SEND_QUEUE(self));
229         g_return_if_fail (TNY_IS_HEADER(header));
230         priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
231         
232         /* Check whether the mail is already in the queue */
233         msg_uid = modest_tny_send_queue_get_msg_id (header);
234         status = modest_tny_send_queue_get_msg_status (self, msg_uid);
235         switch (status) {
236         case MODEST_TNY_SEND_QUEUE_UNKNONW:
237         case MODEST_TNY_SEND_QUEUE_SUSPENDED:
238         case MODEST_TNY_SEND_QUEUE_FAILED:
239                 if (status != MODEST_TNY_SEND_QUEUE_SUSPENDED)
240                         tny_header_unset_flags (header, TNY_HEADER_FLAG_PRIORITY);
241                 existing = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE(self), msg_uid);
242                 if(existing != NULL) return;
243         
244                 /* Add new meesage info */
245                 info = g_slice_new (SendInfo);
246                 info->msg_id = strdup(msg_uid);
247                 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
248                 g_queue_push_tail (priv->queue, info);
249                 break;
250         default:
251                 goto frees;
252         }
253
254         /* Free */
255  frees:
256         g_free(msg_uid);
257 }
258
259 static TnyFolder*
260 modest_tny_send_queue_get_sentbox (TnySendQueue *self)
261 {
262         TnyFolder *folder;
263         TnyCamelTransportAccount *account;
264
265         g_return_val_if_fail (self, NULL);
266
267         account = tny_camel_send_queue_get_transport_account (TNY_CAMEL_SEND_QUEUE(self));
268         if (!account) {
269                 g_printerr ("modest: no account for send queue\n");
270                 return NULL;
271         }
272         folder  = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
273                                                          TNY_FOLDER_TYPE_SENT);
274         g_object_unref (G_OBJECT(account));
275
276         return folder;
277 }
278
279
280 static TnyFolder*
281 modest_tny_send_queue_get_outbox (TnySendQueue *self)
282 {
283         TnyFolder *folder;
284         TnyCamelTransportAccount *account;
285
286         g_return_val_if_fail (self, NULL);
287
288         account = tny_camel_send_queue_get_transport_account (TNY_CAMEL_SEND_QUEUE(self));
289         if (!account) {
290                 g_printerr ("modest: no account for send queue\n");
291                 return NULL;
292         }
293         folder  = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
294                                                          TNY_FOLDER_TYPE_OUTBOX);
295
296         /* This vfunc's tinymail contract does not allow it to return NULL. */
297         if (!folder) {
298                 g_warning("%s: Returning NULL.\n", __FUNCTION__);
299         }
300
301         g_object_unref (G_OBJECT(account));
302
303         return folder;
304 }
305
306 GType
307 modest_tny_send_queue_get_type (void)
308 {
309         static GType my_type = 0;
310
311         if (my_type == 0) {
312                 static const GTypeInfo my_info = {
313                         sizeof(ModestTnySendQueueClass),
314                         NULL,           /* base init */
315                         NULL,           /* base finalize */
316                         (GClassInitFunc) modest_tny_send_queue_class_init,
317                         NULL,           /* class finalize */
318                         NULL,           /* class data */
319                         sizeof(ModestTnySendQueue),
320                         0,              /* n_preallocs */
321                         (GInstanceInitFunc) modest_tny_send_queue_instance_init,
322                         NULL
323                 };
324                 my_type = g_type_register_static (TNY_TYPE_CAMEL_SEND_QUEUE,
325                                                   "ModestTnySendQueue",
326                                                   &my_info, 0);
327         }
328         return my_type;
329 }
330
331
332 static void
333 modest_tny_send_queue_class_init (ModestTnySendQueueClass *klass)
334 {
335         GObjectClass *gobject_class;
336
337         gobject_class = (GObjectClass*) klass;
338         
339         parent_class            = g_type_class_peek_parent (klass);
340         gobject_class->finalize = modest_tny_send_queue_finalize;
341
342         TNY_CAMEL_SEND_QUEUE_CLASS(klass)->add_func         = modest_tny_send_queue_add;
343         TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_outbox_func  = modest_tny_send_queue_get_outbox;
344         TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_sentbox_func = modest_tny_send_queue_get_sentbox;
345         TNY_CAMEL_SEND_QUEUE_CLASS(klass)->cancel_func      = modest_tny_send_queue_cancel;
346         klass->status_changed   = NULL;
347
348         signals[STATUS_CHANGED] =
349                 g_signal_new ("status_changed",
350                               G_TYPE_FROM_CLASS (gobject_class),
351                               G_SIGNAL_RUN_FIRST,
352                               G_STRUCT_OFFSET (ModestTnySendQueueClass, status_changed),
353                               NULL, NULL,
354                               modest_marshal_VOID__STRING_INT,
355                               G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_INT);
356
357         g_type_class_add_private (gobject_class, sizeof(ModestTnySendQueuePrivate));
358 }
359
360 static void
361 modest_tny_send_queue_instance_init (GTypeInstance *instance, gpointer g_class)
362 {
363         ModestTnySendQueuePrivate *priv;
364
365         priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (instance);
366         priv->queue = g_queue_new();
367         priv->current = NULL;
368 }
369
370 static void
371 modest_tny_send_queue_finalize (GObject *obj)
372 {
373         ModestTnySendQueuePrivate *priv;
374                 
375         priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (obj);
376
377         g_queue_foreach (priv->queue, (GFunc)modest_tny_send_queue_info_free, NULL);
378         g_queue_free (priv->queue);
379
380         G_OBJECT_CLASS(parent_class)->finalize (obj);
381 }
382
383 ModestTnySendQueue*
384 modest_tny_send_queue_new (TnyCamelTransportAccount *account)
385 {
386         ModestTnySendQueue *self;
387         
388         g_return_val_if_fail (TNY_IS_CAMEL_TRANSPORT_ACCOUNT(account), NULL);
389         
390         self = MODEST_TNY_SEND_QUEUE(g_object_new(MODEST_TYPE_TNY_SEND_QUEUE, NULL));
391         
392         tny_camel_send_queue_set_transport_account (TNY_CAMEL_SEND_QUEUE(self),
393                                                     account); 
394
395         /* Connect signals to control when a msg is being or has been sent */
396         g_signal_connect (G_OBJECT(self), "msg-sending",
397                           G_CALLBACK(_on_msg_start_sending),
398                           NULL);                          
399         g_signal_connect (G_OBJECT(self), "msg-sent",
400                           G_CALLBACK(_on_msg_has_been_sent), 
401                           NULL);
402         g_signal_connect (G_OBJECT(self), "error-happened",
403                           G_CALLBACK(_on_msg_error_happened),
404                           NULL);
405         return self;
406 }
407
408
409
410 void
411 modest_tny_send_queue_try_to_send (ModestTnySendQueue* self)
412 {
413         TnyIterator *iter = NULL;
414         TnyFolder *outbox = NULL;
415         TnyList *headers = tny_simple_list_new ();
416         TnyHeader *header = NULL;
417         GError *err = NULL;
418
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                 if (header) {   
426                         _add_message (self, header); 
427                         g_object_unref (header);
428                 }
429
430                 tny_iterator_next (iter);
431         }
432         
433         /* Flush send queue */
434         tny_camel_send_queue_flush (TNY_CAMEL_SEND_QUEUE(self));
435
436  frees:
437         if (headers != NULL)
438                 g_object_unref (G_OBJECT (headers));
439         if (outbox != NULL) 
440                 g_object_unref (G_OBJECT (outbox));
441         if (iter != NULL) 
442                 g_object_unref (iter);
443 }
444
445 gboolean
446 modest_tny_send_queue_msg_is_being_sent (ModestTnySendQueue* self,
447                                          const gchar *msg_id)
448 {       
449         ModestTnySendQueueStatus status;
450         
451         g_return_val_if_fail (msg_id != NULL, FALSE); 
452         
453         status = modest_tny_send_queue_get_msg_status (self, msg_id);
454         return status == MODEST_TNY_SEND_QUEUE_SENDING;
455 }
456
457 gboolean
458 modest_tny_send_queue_sending_in_progress (ModestTnySendQueue* self)
459 {       
460         ModestTnySendQueuePrivate *priv;
461         priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
462         
463         return priv->current != NULL;
464 }
465
466 ModestTnySendQueueStatus
467 modest_tny_send_queue_get_msg_status (ModestTnySendQueue *self, const gchar *msg_id)
468 {
469   GList *item;
470   item = modest_tny_send_queue_lookup_info (self, msg_id);
471   if(item == NULL) return MODEST_TNY_SEND_QUEUE_UNKNONW;
472   return ((SendInfo*)item->data)->status;
473 }
474
475 gchar *
476 modest_tny_send_queue_get_msg_id (TnyHeader *header)
477 {
478         const gchar *uid = NULL;
479         gchar* msg_uid = NULL;
480         gchar **tmp = NULL;
481                 
482         /* Get message uid */
483         uid = tny_header_get_uid (header);
484         tmp = g_strsplit (uid, "__", 2);
485         if (tmp[1] != NULL) 
486                 msg_uid = g_strconcat (tmp[0], "_", NULL);
487         else 
488                 msg_uid = g_strdup(tmp[0]);
489
490         /* free */
491         g_strfreev(tmp);
492
493         return msg_uid;
494 }
495
496
497 static void
498 _on_msg_start_sending (TnySendQueue *self,
499                        TnyHeader *header,
500                        TnyMsg *msg,
501                        int done, 
502                        int total,
503                        gpointer user_data)
504 {
505         ModestTnySendQueuePrivate *priv = NULL;
506         GList *item = NULL;
507         SendInfo *info = NULL;
508         gchar *msg_id = NULL;
509
510         priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
511         
512         /* Get message uid */
513         msg_id = modest_tny_send_queue_get_msg_id (header);
514
515         /* Get status info */
516         item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), msg_id);
517         g_return_if_fail (item != NULL);
518         info = item->data;
519         info->status = MODEST_TNY_SEND_QUEUE_SENDING;
520         
521         /* Set current status item */
522         g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
523         priv->current = item;
524
525         /* free */
526         g_free (msg_id);
527 }
528
529 static void 
530 _on_msg_has_been_sent (TnySendQueue *self,
531                        TnyHeader *header,
532                        TnyMsg *msg, 
533                        int done, 
534                        int total,
535                        gpointer user_data)
536 {
537         ModestTnySendQueuePrivate *priv;
538         GList *item;
539         gchar *msg_id = NULL;
540
541         priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
542
543         /* Get message uid */
544         msg_id = modest_tny_send_queue_get_msg_id (header);
545         
546         /* Get status info */
547         item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), msg_id);
548         g_return_if_fail(item != NULL);
549
550         /* Remove status info */
551         modest_tny_send_queue_info_free (item->data);
552         g_queue_delete_link (priv->queue, item);
553         priv->current = NULL;
554
555         /* free */
556         g_free(msg_id);
557 }
558
559 static void 
560 _on_msg_error_happened (TnySendQueue *self,
561                         TnyHeader *header,
562                         TnyMsg *msg,
563                         GError *err,
564                         gpointer user_data)
565 {
566         ModestTnySendQueuePrivate *priv = NULL;
567         SendInfo *info = NULL;
568         GList *item = NULL;
569         gchar* msg_uid = NULL;
570         
571         priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
572         
573         /* Get sending info (create new if it doesn not exist) */
574         msg_uid = modest_tny_send_queue_get_msg_id (header);
575         item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), 
576                                                   msg_uid);     
577         if (item == NULL) {
578                 info = g_slice_new (SendInfo);
579                 info->msg_id = strdup(msg_uid);
580                 g_queue_push_tail (priv->queue, info);
581         }
582         else {
583                 info = item->data;
584         } 
585
586         /* Keep in queue so that we remember that the opertion has failed */
587         /* and was not just cancelled */
588         info->status = MODEST_TNY_SEND_QUEUE_FAILED;
589         
590         /* Notify status has changed */
591         g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
592
593         /* free */
594         g_free(msg_uid);
595 }