1 /* Copyright (c) 2006, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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.
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.
30 #include "modest-mail-operation.h"
31 /* include other impl specific header files */
34 #include <tny-mime-part.h>
35 #include <tny-store-account.h>
36 #include <tny-folder-store.h>
37 #include <tny-folder-store-query.h>
38 #include <tny-camel-stream.h>
39 #include <tny-simple-list.h>
40 #include <tny-send-queue.h>
41 #include <camel/camel-stream-mem.h>
42 #include <glib/gi18n.h>
43 #include <modest-tny-account.h>
44 #include <modest-tny-send-queue.h>
45 #include <modest-runtime.h>
46 #include "modest-text-utils.h"
47 #include "modest-tny-msg.h"
48 #include "modest-tny-platform-factory.h"
49 #include "modest-marshal.h"
50 #include "modest-error.h"
52 /* 'private'/'protected' functions */
53 static void modest_mail_operation_class_init (ModestMailOperationClass *klass);
54 static void modest_mail_operation_init (ModestMailOperation *obj);
55 static void modest_mail_operation_finalize (GObject *obj);
57 static void status_update_cb (TnyFolder *folder,
62 static void folder_refresh_cb (TnyFolder *folder,
66 static void update_folders_cb (TnyFolderStore *self,
71 enum _ModestMailOperationSignals
73 PROGRESS_CHANGED_SIGNAL,
78 typedef struct _ModestMailOperationPrivate ModestMailOperationPrivate;
79 struct _ModestMailOperationPrivate {
82 ModestMailOperationStatus status;
86 #define MODEST_MAIL_OPERATION_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
87 MODEST_TYPE_MAIL_OPERATION, \
88 ModestMailOperationPrivate))
90 #define CHECK_EXCEPTION(priv, new_status, op) if (priv->error) {\
91 priv->status = new_status;\
95 typedef struct _RefreshFolderAsyncHelper
97 ModestMailOperation *mail_op;
102 } RefreshFolderAsyncHelper;
105 static GObjectClass *parent_class = NULL;
107 static guint signals[NUM_SIGNALS] = {0};
110 modest_mail_operation_get_type (void)
112 static GType my_type = 0;
114 static const GTypeInfo my_info = {
115 sizeof(ModestMailOperationClass),
116 NULL, /* base init */
117 NULL, /* base finalize */
118 (GClassInitFunc) modest_mail_operation_class_init,
119 NULL, /* class finalize */
120 NULL, /* class data */
121 sizeof(ModestMailOperation),
123 (GInstanceInitFunc) modest_mail_operation_init,
126 my_type = g_type_register_static (G_TYPE_OBJECT,
127 "ModestMailOperation",
134 modest_mail_operation_class_init (ModestMailOperationClass *klass)
136 GObjectClass *gobject_class;
137 gobject_class = (GObjectClass*) klass;
139 parent_class = g_type_class_peek_parent (klass);
140 gobject_class->finalize = modest_mail_operation_finalize;
142 g_type_class_add_private (gobject_class, sizeof(ModestMailOperationPrivate));
145 * ModestMailOperation::progress-changed
146 * @self: the #MailOperation that emits the signal
147 * @user_data: user data set when the signal handler was connected
149 * Emitted when the progress of a mail operation changes
151 signals[PROGRESS_CHANGED_SIGNAL] =
152 g_signal_new ("progress_changed",
153 G_TYPE_FROM_CLASS (gobject_class),
155 G_STRUCT_OFFSET (ModestMailOperationClass, progress_changed),
157 g_cclosure_marshal_VOID__VOID,
162 modest_mail_operation_init (ModestMailOperation *obj)
164 ModestMailOperationPrivate *priv;
166 priv = MODEST_MAIL_OPERATION_GET_PRIVATE(obj);
168 priv->status = MODEST_MAIL_OPERATION_STATUS_INVALID;
175 modest_mail_operation_finalize (GObject *obj)
177 ModestMailOperationPrivate *priv;
179 priv = MODEST_MAIL_OPERATION_GET_PRIVATE(obj);
182 g_error_free (priv->error);
186 G_OBJECT_CLASS(parent_class)->finalize (obj);
190 modest_mail_operation_new (void)
192 return MODEST_MAIL_OPERATION(g_object_new(MODEST_TYPE_MAIL_OPERATION, NULL));
197 modest_mail_operation_send_mail (ModestMailOperation *self,
198 TnyTransportAccount *transport_account,
201 TnySendQueue *send_queue;
203 g_return_if_fail (MODEST_IS_MAIL_OPERATION (self));
204 g_return_if_fail (TNY_IS_TRANSPORT_ACCOUNT (transport_account));
206 send_queue = TNY_SEND_QUEUE (modest_runtime_get_send_queue (transport_account));
207 if (!TNY_IS_SEND_QUEUE(send_queue))
208 g_printerr ("modest: could not find send queue for account\n");
211 tny_send_queue_add (send_queue, msg, &err);
213 g_printerr ("modest: error adding msg to send queue: %s\n",
217 g_message ("modest: message added to send queue");
222 modest_mail_operation_send_new_mail (ModestMailOperation *self,
223 TnyTransportAccount *transport_account,
224 const gchar *from, const gchar *to,
225 const gchar *cc, const gchar *bcc,
226 const gchar *subject, const gchar *body,
227 const GList *attachments_list)
230 ModestMailOperationPrivate *priv = NULL;
232 g_return_if_fail (MODEST_IS_MAIL_OPERATION (self));
233 g_return_if_fail (TNY_IS_TRANSPORT_ACCOUNT (transport_account));
235 priv = MODEST_MAIL_OPERATION_GET_PRIVATE(self);
237 /* Check parametters */
239 g_set_error (&(priv->error), MODEST_MAIL_OPERATION_ERROR,
240 MODEST_MAIL_OPERATION_ERROR_MISSING_PARAMETER,
241 _("Error trying to send a mail. You need to set at least one recipient"));
245 new_msg = modest_tny_msg_new (to, from, cc, bcc, subject, body, NULL); /* FIXME: attachments */
247 g_printerr ("modest: failed to create a new msg\n");
251 modest_mail_operation_send_mail (self, transport_account, new_msg);
253 g_object_unref (G_OBJECT(new_msg));
257 status_update_cb (TnyFolder *folder, const gchar *what, gint status, gint oftotal, gpointer user_data)
259 g_print ("%s status: %d, of total %d\n", what, status, oftotal);
263 folder_refresh_cb (TnyFolder *folder, gboolean canceled, GError **err, gpointer user_data)
265 ModestMailOperation *self = NULL;
266 ModestMailOperationPrivate *priv = NULL;
267 RefreshFolderAsyncHelper *helper;
269 helper = (RefreshFolderAsyncHelper *) user_data;
270 self = MODEST_MAIL_OPERATION (helper->mail_op);
271 priv = MODEST_MAIL_OPERATION_GET_PRIVATE(self);
273 if ((canceled && *err) || *err) {
274 priv->error = g_error_copy (*err);
276 } else if (canceled) {
278 g_set_error (&(priv->error), MODEST_MAIL_OPERATION_ERROR,
279 MODEST_MAIL_OPERATION_ERROR_OPERATION_CANCELED,
280 _("Error trying to refresh folder %s. Operation canceled"),
281 tny_folder_get_name (folder));
286 if (priv->done == priv->total)
287 priv->status = MODEST_MAIL_OPERATION_STATUS_SUCCESS;
288 else if ((priv->done + helper->canceled + helper->failed) == priv->total) {
289 if (helper->failed == priv->total)
290 priv->status = MODEST_MAIL_OPERATION_STATUS_FAILED;
291 else if (helper->failed == priv->total)
292 priv->status = MODEST_MAIL_OPERATION_STATUS_CANCELED;
294 priv->status = MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS;
296 tny_iterator_next (helper->iter);
297 if (tny_iterator_is_done (helper->iter)) {
299 list = tny_iterator_get_list (helper->iter);
300 g_object_unref (G_OBJECT (helper->iter));
301 g_object_unref (G_OBJECT (list));
302 g_slice_free (RefreshFolderAsyncHelper, helper);
304 TnyFolder *folder = TNY_FOLDER (tny_iterator_get_current (helper->iter));
306 g_message ("modest: refreshing folder %s",
307 tny_folder_get_name (folder));
308 tny_folder_refresh_async (folder, folder_refresh_cb, status_update_cb, helper);
309 g_object_unref (G_OBJECT(folder)); // FIXME: don't unref yet
312 g_signal_emit (G_OBJECT (self), signals[PROGRESS_CHANGED_SIGNAL], 0, NULL);
317 update_folders_cb (TnyFolderStore *folder_store, TnyList *list, GError **err, gpointer user_data)
319 ModestMailOperation *self;
320 ModestMailOperationPrivate *priv;
321 RefreshFolderAsyncHelper *helper;
324 self = MODEST_MAIL_OPERATION (user_data);
325 priv = MODEST_MAIL_OPERATION_GET_PRIVATE (self);
328 priv->error = g_error_copy (*err);
329 priv->status = MODEST_MAIL_OPERATION_STATUS_FAILED;
333 priv->total = tny_list_get_length (list);
335 priv->status = MODEST_MAIL_OPERATION_STATUS_IN_PROGRESS;
337 helper = g_slice_new0 (RefreshFolderAsyncHelper);
338 helper->mail_op = self;
339 helper->iter = tny_list_create_iterator (list);
341 helper->canceled = 0;
343 /* Async refresh folders */
344 folder = TNY_FOLDER (tny_iterator_get_current (helper->iter));
346 g_message ("modest: refreshing folder %s", tny_folder_get_name (folder));
347 tny_folder_refresh_async (folder, folder_refresh_cb,
348 status_update_cb, helper);
350 //g_object_unref (G_OBJECT(folder)); /* FIXME -==> don't unref yet... */
354 modest_mail_operation_update_account (ModestMailOperation *self,
355 TnyStoreAccount *store_account)
357 ModestMailOperationPrivate *priv;
359 TnyFolderStoreQuery *query;
361 g_return_val_if_fail (MODEST_IS_MAIL_OPERATION (self), FALSE);
362 g_return_val_if_fail (TNY_IS_STORE_ACCOUNT(store_account), FALSE);
364 priv = MODEST_MAIL_OPERATION_GET_PRIVATE(self);
366 /* Get subscribed folders & refresh them */
367 folders = TNY_LIST (tny_simple_list_new ());
368 query = NULL; //tny_folder_store_query_new ();
370 /* FIXME: is this needed? */
371 // tny_device_force_online (TNY_DEVICE(modest_runtime_get_device()));
373 /* FIXME: let query be NULL: do it for all */
374 //tny_folder_store_query_add_item (query, NULL, TNY_FOLDER_STORE_QUERY_OPTION_SUBSCRIBED);
375 tny_folder_store_get_folders_async (TNY_FOLDER_STORE (store_account),
376 folders, update_folders_cb, query, self);
377 //g_object_unref (query); /* FIXME */
382 ModestMailOperationStatus
383 modest_mail_operation_get_status (ModestMailOperation *self)
385 ModestMailOperationPrivate *priv;
387 g_return_val_if_fail (self, MODEST_MAIL_OPERATION_STATUS_INVALID);
388 g_return_val_if_fail (MODEST_IS_MAIL_OPERATION (self),
389 MODEST_MAIL_OPERATION_STATUS_INVALID);
391 priv = MODEST_MAIL_OPERATION_GET_PRIVATE (self);
396 modest_mail_operation_get_error (ModestMailOperation *self)
398 ModestMailOperationPrivate *priv;
400 g_return_val_if_fail (self, NULL);
401 g_return_val_if_fail (MODEST_IS_MAIL_OPERATION (self), NULL);
403 priv = MODEST_MAIL_OPERATION_GET_PRIVATE (self);
408 modest_mail_operation_cancel (ModestMailOperation *self)
415 modest_mail_operation_get_task_done (ModestMailOperation *self)
417 ModestMailOperationPrivate *priv;
419 g_return_val_if_fail (MODEST_IS_MAIL_OPERATION (self), 0);
421 priv = MODEST_MAIL_OPERATION_GET_PRIVATE (self);
426 modest_mail_operation_get_task_total (ModestMailOperation *self)
428 ModestMailOperationPrivate *priv;
430 g_return_val_if_fail (MODEST_IS_MAIL_OPERATION (self), 0);
432 priv = MODEST_MAIL_OPERATION_GET_PRIVATE (self);
437 modest_mail_operation_is_finished (ModestMailOperation *self)
439 ModestMailOperationPrivate *priv;
440 gboolean retval = FALSE;
442 if (!MODEST_IS_MAIL_OPERATION (self)) {
443 g_warning ("%s: invalid parametter", G_GNUC_FUNCTION);
447 priv = MODEST_MAIL_OPERATION_GET_PRIVATE (self);
449 if (priv->status == MODEST_MAIL_OPERATION_STATUS_SUCCESS ||
450 priv->status == MODEST_MAIL_OPERATION_STATUS_FAILED ||
451 priv->status == MODEST_MAIL_OPERATION_STATUS_CANCELED ||
452 priv->status == MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS) {
461 /* ******************************************************************* */
462 /* ************************** STORE ACTIONS ************************* */
463 /* ******************************************************************* */
467 modest_mail_operation_create_folder (ModestMailOperation *self,
468 TnyFolderStore *parent,
471 ModestMailOperationPrivate *priv;
472 TnyFolder *new_folder = NULL;
473 //TnyStoreAccount *store_account;
475 g_return_val_if_fail (TNY_IS_FOLDER_STORE (parent), NULL);
476 g_return_val_if_fail (name, NULL);
478 priv = MODEST_MAIL_OPERATION_GET_PRIVATE (self);
480 /* Create the folder */
481 new_folder = tny_folder_store_create_folder (parent, name, &(priv->error));
482 CHECK_EXCEPTION (priv, MODEST_MAIL_OPERATION_STATUS_FAILED, return NULL);
484 /* /\* Subscribe to folder *\/ */
485 /* if (!tny_folder_is_subscribed (new_folder)) { */
486 /* store_account = TNY_STORE_ACCOUNT (tny_folder_get_account (TNY_FOLDER (parent))); */
487 /* tny_store_account_subscribe (store_account, new_folder); */
488 /* g_object_unref (G_OBJECT (store_account)); */
495 modest_mail_operation_remove_folder (ModestMailOperation *self,
497 gboolean remove_to_trash)
499 TnyFolderStore *parent;
501 ModestMailOperationPrivate *priv;
503 g_return_if_fail (MODEST_IS_MAIL_OPERATION (self));
504 g_return_if_fail (TNY_IS_FOLDER (folder));
506 priv = MODEST_MAIL_OPERATION_GET_PRIVATE (self);
508 /* Get the account */
509 account = tny_folder_get_account (folder);
511 /* Delete folder or move to trash */
512 if (remove_to_trash) {
513 TnyFolder *trash_folder, *new_folder;
514 trash_folder = modest_tny_account_get_special_folder (account,
515 TNY_FOLDER_TYPE_TRASH);
516 /* TODO: error_handling */
517 new_folder = modest_mail_operation_xfer_folder (self, folder,
518 TNY_FOLDER_STORE (trash_folder), TRUE);
519 g_object_unref (G_OBJECT (new_folder));
521 parent = tny_folder_get_folder_store (folder);
523 tny_folder_store_remove_folder (parent, folder, &(priv->error));
524 CHECK_EXCEPTION (priv, MODEST_MAIL_OPERATION_STATUS_FAILED, );
527 g_object_unref (G_OBJECT (parent));
529 g_object_unref (G_OBJECT (account));
533 modest_mail_operation_rename_folder (ModestMailOperation *self,
537 ModestMailOperationPrivate *priv;
539 g_return_if_fail (MODEST_IS_MAIL_OPERATION (self));
540 g_return_if_fail (TNY_IS_FOLDER_STORE (folder));
541 g_return_if_fail (name);
543 priv = MODEST_MAIL_OPERATION_GET_PRIVATE (self);
545 /* FIXME: better error handling */
546 if (strrchr (name, '/') != NULL)
549 /* Rename. Camel handles folder subscription/unsubscription */
550 tny_folder_set_name (folder, name, &(priv->error));
551 CHECK_EXCEPTION (priv, MODEST_MAIL_OPERATION_STATUS_FAILED, return);
555 modest_mail_operation_xfer_folder (ModestMailOperation *self,
557 TnyFolderStore *parent,
558 gboolean delete_original)
560 ModestMailOperationPrivate *priv;
562 g_return_val_if_fail (MODEST_IS_MAIL_OPERATION (self), NULL);
563 g_return_val_if_fail (TNY_IS_FOLDER_STORE (parent), NULL);
564 g_return_val_if_fail (TNY_IS_FOLDER (folder), NULL);
566 priv = MODEST_MAIL_OPERATION_GET_PRIVATE (self);
568 return tny_folder_copy (folder,
570 tny_folder_get_name (folder),
576 /* ******************************************************************* */
577 /* ************************** MSG ACTIONS ************************* */
578 /* ******************************************************************* */
581 modest_mail_operation_remove_msg (ModestMailOperation *self,
583 gboolean remove_to_trash)
587 g_return_if_fail (TNY_IS_HEADER (header));
589 folder = tny_header_get_folder (header);
591 /* Delete or move to trash */
592 if (remove_to_trash) {
593 TnyFolder *trash_folder;
594 TnyStoreAccount *store_account;
596 store_account = TNY_STORE_ACCOUNT (tny_folder_get_account (folder));
597 trash_folder = modest_tny_account_get_special_folder (TNY_ACCOUNT(store_account),
598 TNY_FOLDER_TYPE_TRASH);
600 modest_mail_operation_xfer_msg (self, header, trash_folder, TRUE);
601 /* g_object_unref (trash_folder); */
603 ModestMailOperationPrivate *priv;
605 /* Set status failed and set an error */
606 priv = MODEST_MAIL_OPERATION_GET_PRIVATE(self);
607 priv->status = MODEST_MAIL_OPERATION_STATUS_FAILED;
608 g_set_error (&(priv->error), MODEST_MAIL_OPERATION_ERROR,
609 MODEST_MAIL_OPERATION_ERROR_ITEM_NOT_FOUND,
610 _("Error trying to delete a message. Trash folder not found"));
613 g_object_unref (G_OBJECT (store_account));
615 tny_folder_remove_msg (folder, header, NULL); /* FIXME */
616 tny_folder_sync(folder, TRUE, NULL); /* FIXME */
620 g_object_unref (folder);
624 transfer_msgs_cb (TnyFolder *folder, GError **err, gpointer user_data)
626 ModestMailOperationPrivate *priv;
628 priv = MODEST_MAIL_OPERATION_GET_PRIVATE(user_data);
631 priv->error = g_error_copy (*err);
633 priv->status = MODEST_MAIL_OPERATION_STATUS_FAILED;
636 priv->status = MODEST_MAIL_OPERATION_STATUS_SUCCESS;
639 g_signal_emit (G_OBJECT (user_data), signals[PROGRESS_CHANGED_SIGNAL], 0, NULL);
643 modest_mail_operation_xfer_msg (ModestMailOperation *self,
646 gboolean delete_original)
648 ModestMailOperationPrivate *priv;
649 TnyFolder *src_folder;
652 g_return_val_if_fail (MODEST_IS_MAIL_OPERATION (self), FALSE);
653 g_return_val_if_fail (TNY_IS_HEADER (header), FALSE);
654 g_return_val_if_fail (TNY_IS_FOLDER (folder), FALSE);
656 src_folder = tny_header_get_folder (header);
657 headers = tny_simple_list_new ();
659 priv = MODEST_MAIL_OPERATION_GET_PRIVATE(self);
662 priv->status = MODEST_MAIL_OPERATION_STATUS_IN_PROGRESS;
664 tny_list_prepend (headers, G_OBJECT (header));
665 tny_folder_transfer_msgs_async (src_folder, headers, folder,
666 delete_original, transfer_msgs_cb,
670 /* FIXME: don't free 'm yet */
671 ///g_object_unref (headers);
672 ///g_object_unref (src_folder);