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