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