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