8f7e2caaa06356e8816db531c8c596361ba9a7b4
[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                         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);
148                 }
149                 
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();
153         }
154                 
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 */
157
158  frees:
159         if (headers != NULL)
160                 g_object_unref (G_OBJECT (headers));
161         if (outbox != NULL) 
162                 g_object_unref (G_OBJECT (outbox));
163         if (iter != NULL) 
164                 g_object_unref (iter);
165 }
166
167 static void
168 modest_tny_send_queue_add (TnySendQueue *self, TnyMsg *msg, GError **err)
169 {
170         ModestTnySendQueuePrivate *priv;
171         TnyHeader *header;
172         SendInfo *info = NULL;
173         GList* existing;
174         const gchar* msg_id;
175
176         g_return_if_fail (TNY_IS_SEND_QUEUE(self));
177         g_return_if_fail (TNY_IS_CAMEL_MSG(msg));
178
179         priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
180         header = tny_msg_get_header (msg);
181
182         /* FIXME: do something smart here... */
183
184         /* Note that this call actually sets the message id to something
185          * sensible. */ 
186         TNY_CAMEL_SEND_QUEUE_CLASS(parent_class)->add_func (self, msg, err); /* FIXME */
187
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);
193         if(existing != NULL)
194         {
195                 //g_assert(info->status == MODEST_TNY_SEND_QUEUE_SUSPENDED ||
196                 //        info->status == MODEST_TNY_SEND_QUEUE_FAILED);
197
198                 info = existing->data;
199                 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
200         }
201         else
202         {
203                 
204                 info = g_slice_new (SendInfo);
205
206                 info->msg_id = strdup(msg_id);
207                 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
208                 g_queue_push_tail (priv->queue, info);
209         }
210
211         g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
212
213         /* free */
214         g_object_unref (header);
215 }
216
217 static void
218 _add_message (ModestTnySendQueue *self, TnyHeader *header)
219 {
220         ModestTnySendQueuePrivate *priv;
221         SendInfo *info = NULL;
222         GList* existing = NULL;
223         gchar* msg_uid = NULL;
224         ModestTnySendQueueStatus status = MODEST_TNY_SEND_QUEUE_WAITING;
225
226         g_return_if_fail (TNY_IS_SEND_QUEUE(self));
227         g_return_if_fail (TNY_IS_HEADER(header));
228         priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
229         
230         /* Check whether the mail is already in the queue */
231         msg_uid = modest_tny_send_queue_get_msg_id (header);
232         status = modest_tny_send_queue_get_msg_status (self, msg_uid);
233         switch (status) {
234         case MODEST_TNY_SEND_QUEUE_UNKNONW:
235         case MODEST_TNY_SEND_QUEUE_SUSPENDED:
236         case MODEST_TNY_SEND_QUEUE_FAILED:
237                 if (status != MODEST_TNY_SEND_QUEUE_SUSPENDED)
238                         tny_header_unset_flags (header, TNY_HEADER_FLAG_PRIORITY);
239                 existing = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE(self), msg_uid);
240                 if(existing != NULL) return;
241         
242                 /* Add new meesage info */
243                 info = g_slice_new (SendInfo);
244                 info->msg_id = strdup(msg_uid);
245                 info->status = MODEST_TNY_SEND_QUEUE_WAITING;
246                 g_queue_push_tail (priv->queue, info);
247                 break;
248         default:
249                 goto frees;
250         }
251
252         /* Free */
253  frees:
254         g_free(msg_uid);
255 }
256
257 static TnyFolder*
258 modest_tny_send_queue_get_sentbox (TnySendQueue *self)
259 {
260         TnyFolder *folder;
261         TnyCamelTransportAccount *account;
262
263         g_return_val_if_fail (self, NULL);
264
265         account = tny_camel_send_queue_get_transport_account (TNY_CAMEL_SEND_QUEUE(self));
266         if (!account) {
267                 g_printerr ("modest: no account for send queue\n");
268                 return NULL;
269         }
270         folder  = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
271                                                          TNY_FOLDER_TYPE_SENT);
272         g_object_unref (G_OBJECT(account));
273
274         return folder;
275 }
276
277
278 static TnyFolder*
279 modest_tny_send_queue_get_outbox (TnySendQueue *self)
280 {
281         TnyFolder *folder;
282         TnyCamelTransportAccount *account;
283
284         g_return_val_if_fail (self, NULL);
285
286         account = tny_camel_send_queue_get_transport_account (TNY_CAMEL_SEND_QUEUE(self));
287         if (!account) {
288                 g_printerr ("modest: no account for send queue\n");
289                 return NULL;
290         }
291         folder  = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
292                                                          TNY_FOLDER_TYPE_OUTBOX);
293
294         /* This vfunc's tinymail contract does not allow it to return NULL. */
295         if (!folder) {
296                 g_warning("%s: Returning NULL.\n", __FUNCTION__);
297         }
298
299         g_object_unref (G_OBJECT(account));
300
301         return folder;
302 }
303
304 GType
305 modest_tny_send_queue_get_type (void)
306 {
307         static GType my_type = 0;
308
309         if (my_type == 0) {
310                 static const GTypeInfo my_info = {
311                         sizeof(ModestTnySendQueueClass),
312                         NULL,           /* base init */
313                         NULL,           /* base finalize */
314                         (GClassInitFunc) modest_tny_send_queue_class_init,
315                         NULL,           /* class finalize */
316                         NULL,           /* class data */
317                         sizeof(ModestTnySendQueue),
318                         0,              /* n_preallocs */
319                         (GInstanceInitFunc) modest_tny_send_queue_instance_init,
320                         NULL
321                 };
322                 my_type = g_type_register_static (TNY_TYPE_CAMEL_SEND_QUEUE,
323                                                   "ModestTnySendQueue",
324                                                   &my_info, 0);
325         }
326         return my_type;
327 }
328
329
330 static void
331 modest_tny_send_queue_class_init (ModestTnySendQueueClass *klass)
332 {
333         GObjectClass *gobject_class;
334
335         gobject_class = (GObjectClass*) klass;
336         
337         parent_class            = g_type_class_peek_parent (klass);
338         gobject_class->finalize = modest_tny_send_queue_finalize;
339
340         TNY_CAMEL_SEND_QUEUE_CLASS(klass)->add_func         = modest_tny_send_queue_add;
341         TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_outbox_func  = modest_tny_send_queue_get_outbox;
342         TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_sentbox_func = modest_tny_send_queue_get_sentbox;
343         TNY_CAMEL_SEND_QUEUE_CLASS(klass)->cancel_func      = modest_tny_send_queue_cancel;
344         klass->status_changed   = NULL;
345
346         signals[STATUS_CHANGED] =
347                 g_signal_new ("status_changed",
348                               G_TYPE_FROM_CLASS (gobject_class),
349                               G_SIGNAL_RUN_FIRST,
350                               G_STRUCT_OFFSET (ModestTnySendQueueClass, status_changed),
351                               NULL, NULL,
352                               modest_marshal_VOID__STRING_INT,
353                               G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_INT);
354
355         g_type_class_add_private (gobject_class, sizeof(ModestTnySendQueuePrivate));
356 }
357
358 static void
359 modest_tny_send_queue_instance_init (GTypeInstance *instance, gpointer g_class)
360 {
361         ModestTnySendQueuePrivate *priv;
362
363         priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (instance);
364         priv->queue = g_queue_new();
365         priv->current = NULL;
366 }
367
368 static void
369 modest_tny_send_queue_finalize (GObject *obj)
370 {
371         ModestTnySendQueuePrivate *priv;
372                 
373         priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (obj);
374
375         g_queue_foreach (priv->queue, (GFunc)modest_tny_send_queue_info_free, NULL);
376         g_queue_free (priv->queue);
377
378         G_OBJECT_CLASS(parent_class)->finalize (obj);
379 }
380
381 ModestTnySendQueue*
382 modest_tny_send_queue_new (TnyCamelTransportAccount *account)
383 {
384         ModestTnySendQueue *self;
385         
386         g_return_val_if_fail (TNY_IS_CAMEL_TRANSPORT_ACCOUNT(account), NULL);
387         
388         self = MODEST_TNY_SEND_QUEUE(g_object_new(MODEST_TYPE_TNY_SEND_QUEUE, NULL));
389         
390         tny_camel_send_queue_set_transport_account (TNY_CAMEL_SEND_QUEUE(self),
391                                                     account); 
392
393         /* Connect signals to control when a msg is being or has been sent */
394         g_signal_connect (G_OBJECT(self), "msg-sending",
395                           G_CALLBACK(_on_msg_start_sending),
396                           NULL);                          
397         g_signal_connect (G_OBJECT(self), "msg-sent",
398                           G_CALLBACK(_on_msg_has_been_sent), 
399                           NULL);
400         g_signal_connect (G_OBJECT(self), "error-happened",
401                           G_CALLBACK(_on_msg_error_happened),
402                           NULL);
403         return self;
404 }
405
406
407
408 void
409 modest_tny_send_queue_try_to_send (ModestTnySendQueue* self)
410 {
411         TnyIterator *iter = NULL;
412         TnyFolder *outbox = NULL;
413         TnyList *headers = tny_simple_list_new ();
414         TnyHeader *header = NULL;
415         GError *err = NULL;
416
417         outbox = modest_tny_send_queue_get_outbox (TNY_SEND_QUEUE(self));
418         tny_folder_get_headers (outbox, headers, TRUE, &err);
419         if (err != NULL) goto frees;
420         iter = tny_list_create_iterator (headers);
421         while (!tny_iterator_is_done (iter)) {
422                 header = TNY_HEADER (tny_iterator_get_current (iter));          
423                 _add_message (self, header); 
424                 tny_iterator_next (iter);
425                 g_object_unref (header);
426         }
427         
428         /* Flush send queue */
429         tny_camel_send_queue_flush (TNY_CAMEL_SEND_QUEUE(self));
430
431  frees:
432         if (headers != NULL)
433                 g_object_unref (G_OBJECT (headers));
434         if (outbox != NULL) 
435                 g_object_unref (G_OBJECT (outbox));
436         if (iter != NULL) 
437                 g_object_unref (iter);
438 }
439
440 gboolean
441 modest_tny_send_queue_msg_is_being_sent (ModestTnySendQueue* self,
442                                          const gchar *msg_id)
443 {       
444         ModestTnySendQueueStatus status;
445         
446         g_return_val_if_fail (msg_id != NULL, FALSE); 
447         
448         status = modest_tny_send_queue_get_msg_status (self, msg_id);
449         return status == MODEST_TNY_SEND_QUEUE_SENDING;
450 }
451
452 gboolean
453 modest_tny_send_queue_sending_in_progress (ModestTnySendQueue* self)
454 {       
455         ModestTnySendQueuePrivate *priv;
456         priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
457         
458         return priv->current != NULL;
459 }
460
461 ModestTnySendQueueStatus
462 modest_tny_send_queue_get_msg_status (ModestTnySendQueue *self, const gchar *msg_id)
463 {
464   GList *item;
465   item = modest_tny_send_queue_lookup_info (self, msg_id);
466   if(item == NULL) return MODEST_TNY_SEND_QUEUE_UNKNONW;
467   return ((SendInfo*)item->data)->status;
468 }
469
470 gchar *
471 modest_tny_send_queue_get_msg_id (TnyHeader *header)
472 {
473         const gchar *uid = NULL;
474         gchar* msg_uid = NULL;
475         gchar **tmp = NULL;
476                 
477         /* Get message uid */
478         uid = tny_header_get_uid (header);
479         tmp = g_strsplit (uid, "__", 2);
480         if (tmp[1] != NULL) 
481                 msg_uid = g_strconcat (tmp[0], "_", NULL);
482         else 
483                 msg_uid = g_strdup(tmp[0]);
484
485         /* free */
486         g_strfreev(tmp);
487
488         return msg_uid;
489 }
490
491
492 static void
493 _on_msg_start_sending (TnySendQueue *self,
494                        TnyHeader *header,
495                        TnyMsg *msg,
496                        int done, 
497                        int total,
498                        gpointer user_data)
499 {
500         ModestTnySendQueuePrivate *priv = NULL;
501         GList *item = NULL;
502         SendInfo *info = NULL;
503         gchar *msg_id = NULL;
504
505         priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
506         
507         /* Get message uid */
508         msg_id = modest_tny_send_queue_get_msg_id (header);
509
510         /* Get status info */
511         item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), msg_id);
512         g_return_if_fail (item != NULL);
513         info = item->data;
514         info->status = MODEST_TNY_SEND_QUEUE_SENDING;
515         
516         /* Set current status item */
517         g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
518         priv->current = item;
519
520         /* free */
521         g_free (msg_id);
522 }
523
524 static void 
525 _on_msg_has_been_sent (TnySendQueue *self,
526                        TnyHeader *header,
527                        TnyMsg *msg, 
528                        int done, 
529                        int total,
530                        gpointer user_data)
531 {
532         ModestTnySendQueuePrivate *priv;
533         GList *item;
534         gchar *msg_id = NULL;
535
536         priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
537
538         /* Get message uid */
539         msg_id = modest_tny_send_queue_get_msg_id (header);
540         
541         /* Get status info */
542         item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), msg_id);
543         g_return_if_fail(item != NULL);
544
545         /* Remove status info */
546         modest_tny_send_queue_info_free (item->data);
547         g_queue_delete_link (priv->queue, item);
548         priv->current = NULL;
549
550         /* free */
551         g_free(msg_id);
552 }
553
554 static void 
555 _on_msg_error_happened (TnySendQueue *self,
556                         TnyHeader *header,
557                         TnyMsg *msg,
558                         GError *err,
559                         gpointer user_data)
560 {
561         ModestTnySendQueuePrivate *priv = NULL;
562         SendInfo *info = NULL;
563         GList *item = NULL;
564         gchar* msg_uid = NULL;
565         
566         priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
567         
568         /* Get sending info (create new if it doesn not exist) */
569         msg_uid = modest_tny_send_queue_get_msg_id (header);
570         item = modest_tny_send_queue_lookup_info (MODEST_TNY_SEND_QUEUE (self), 
571                                                   msg_uid);     
572         if (item == NULL) {
573                 info = g_slice_new (SendInfo);
574                 info->msg_id = strdup(msg_uid);
575                 g_queue_push_tail (priv->queue, info);
576         }
577         else {
578                 info = item->data;
579         } 
580
581         /* Keep in queue so that we remember that the opertion has failed */
582         /* and was not just cancelled */
583         info->status = MODEST_TNY_SEND_QUEUE_FAILED;
584         
585         /* Notify status has changed */
586         g_signal_emit (self, signals[STATUS_CHANGED], 0, info->msg_id, info->status);
587
588         /* free */
589         g_free(msg_uid);
590 }