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 *plain_body,
227 const gchar *html_body,
228 const GList *attachments_list)
231 ModestMailOperationPrivate *priv = NULL;
234 g_return_if_fail (MODEST_IS_MAIL_OPERATION (self));
235 g_return_if_fail (TNY_IS_TRANSPORT_ACCOUNT (transport_account));
237 priv = MODEST_MAIL_OPERATION_GET_PRIVATE(self);
239 /* Check parametters */
241 g_set_error (&(priv->error), MODEST_MAIL_OPERATION_ERROR,
242 MODEST_MAIL_OPERATION_ERROR_MISSING_PARAMETER,
243 _("Error trying to send a mail. You need to set at least one recipient"));
247 if (html_body == NULL) {
248 new_msg = modest_tny_msg_new (to, from, cc, bcc, subject, plain_body, (GSList *) attachments_list); /* FIXME: attachments */
250 new_msg = modest_tny_msg_new_html_plain (to, from, cc, bcc, subject, html_body, plain_body, (GSList *) attachments_list);
253 g_printerr ("modest: failed to create a new msg\n");
257 modest_mail_operation_send_mail (self, transport_account, new_msg);
259 g_object_unref (G_OBJECT(new_msg));
263 status_update_cb (TnyFolder *folder, const gchar *what, gint status, gint oftotal, gpointer user_data)
265 g_print ("%s status: %d, of total %d\n", what, status, oftotal);
269 folder_refresh_cb (TnyFolder *folder, gboolean canceled, GError **err, gpointer user_data)
271 ModestMailOperation *self = NULL;
272 ModestMailOperationPrivate *priv = NULL;
273 RefreshFolderAsyncHelper *helper;
275 helper = (RefreshFolderAsyncHelper *) user_data;
276 self = MODEST_MAIL_OPERATION (helper->mail_op);
277 priv = MODEST_MAIL_OPERATION_GET_PRIVATE(self);
279 if ((canceled && *err) || *err) {
280 priv->error = g_error_copy (*err);
282 } else if (canceled) {
284 g_set_error (&(priv->error), MODEST_MAIL_OPERATION_ERROR,
285 MODEST_MAIL_OPERATION_ERROR_OPERATION_CANCELED,
286 _("Error trying to refresh folder %s. Operation canceled"),
287 tny_folder_get_name (folder));
292 if (priv->done == priv->total)
293 priv->status = MODEST_MAIL_OPERATION_STATUS_SUCCESS;
294 else if ((priv->done + helper->canceled + helper->failed) == priv->total) {
295 if (helper->failed == priv->total)
296 priv->status = MODEST_MAIL_OPERATION_STATUS_FAILED;
297 else if (helper->failed == priv->total)
298 priv->status = MODEST_MAIL_OPERATION_STATUS_CANCELED;
300 priv->status = MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS;
302 tny_iterator_next (helper->iter);
303 if (tny_iterator_is_done (helper->iter)) {
305 list = tny_iterator_get_list (helper->iter);
306 g_object_unref (G_OBJECT (helper->iter));
307 g_object_unref (G_OBJECT (list));
308 g_slice_free (RefreshFolderAsyncHelper, helper);
310 TnyFolder *folder = TNY_FOLDER (tny_iterator_get_current (helper->iter));
312 g_message ("modest: refreshing folder %s",
313 tny_folder_get_name (folder));
314 tny_folder_refresh_async (folder, folder_refresh_cb, status_update_cb, helper);
315 g_object_unref (G_OBJECT(folder)); // FIXME: don't unref yet
318 g_signal_emit (G_OBJECT (self), signals[PROGRESS_CHANGED_SIGNAL], 0, NULL);
323 update_folders_cb (TnyFolderStore *folder_store, TnyList *list, GError **err, gpointer user_data)
325 ModestMailOperation *self;
326 ModestMailOperationPrivate *priv;
327 RefreshFolderAsyncHelper *helper;
330 self = MODEST_MAIL_OPERATION (user_data);
331 priv = MODEST_MAIL_OPERATION_GET_PRIVATE (self);
334 priv->error = g_error_copy (*err);
335 priv->status = MODEST_MAIL_OPERATION_STATUS_FAILED;
339 priv->total = tny_list_get_length (list);
341 priv->status = MODEST_MAIL_OPERATION_STATUS_IN_PROGRESS;
343 helper = g_slice_new0 (RefreshFolderAsyncHelper);
344 helper->mail_op = self;
345 helper->iter = tny_list_create_iterator (list);
347 helper->canceled = 0;
349 /* Async refresh folders */
350 folder = TNY_FOLDER (tny_iterator_get_current (helper->iter));
352 g_message ("modest: refreshing folder %s", tny_folder_get_name (folder));
353 tny_folder_refresh_async (folder, folder_refresh_cb,
354 status_update_cb, helper);
356 //g_object_unref (G_OBJECT(folder)); /* FIXME -==> don't unref yet... */
360 modest_mail_operation_update_account (ModestMailOperation *self,
361 TnyStoreAccount *store_account)
363 ModestMailOperationPrivate *priv;
365 TnyFolderStoreQuery *query;
367 g_return_val_if_fail (MODEST_IS_MAIL_OPERATION (self), FALSE);
368 g_return_val_if_fail (TNY_IS_STORE_ACCOUNT(store_account), FALSE);
370 priv = MODEST_MAIL_OPERATION_GET_PRIVATE(self);
372 /* Get subscribed folders & refresh them */
373 folders = TNY_LIST (tny_simple_list_new ());
374 query = NULL; //tny_folder_store_query_new ();
376 /* FIXME: is this needed? */
377 // tny_device_force_online (TNY_DEVICE(modest_runtime_get_device()));
379 /* FIXME: let query be NULL: do it for all */
380 //tny_folder_store_query_add_item (query, NULL, TNY_FOLDER_STORE_QUERY_OPTION_SUBSCRIBED);
381 tny_folder_store_get_folders_async (TNY_FOLDER_STORE (store_account),
382 folders, update_folders_cb, query, self);
383 //g_object_unref (query); /* FIXME */
388 ModestMailOperationStatus
389 modest_mail_operation_get_status (ModestMailOperation *self)
391 ModestMailOperationPrivate *priv;
393 g_return_val_if_fail (self, MODEST_MAIL_OPERATION_STATUS_INVALID);
394 g_return_val_if_fail (MODEST_IS_MAIL_OPERATION (self),
395 MODEST_MAIL_OPERATION_STATUS_INVALID);
397 priv = MODEST_MAIL_OPERATION_GET_PRIVATE (self);
402 modest_mail_operation_get_error (ModestMailOperation *self)
404 ModestMailOperationPrivate *priv;
406 g_return_val_if_fail (self, NULL);
407 g_return_val_if_fail (MODEST_IS_MAIL_OPERATION (self), NULL);
409 priv = MODEST_MAIL_OPERATION_GET_PRIVATE (self);
414 modest_mail_operation_cancel (ModestMailOperation *self)
421 modest_mail_operation_get_task_done (ModestMailOperation *self)
423 ModestMailOperationPrivate *priv;
425 g_return_val_if_fail (MODEST_IS_MAIL_OPERATION (self), 0);
427 priv = MODEST_MAIL_OPERATION_GET_PRIVATE (self);
432 modest_mail_operation_get_task_total (ModestMailOperation *self)
434 ModestMailOperationPrivate *priv;
436 g_return_val_if_fail (MODEST_IS_MAIL_OPERATION (self), 0);
438 priv = MODEST_MAIL_OPERATION_GET_PRIVATE (self);
443 modest_mail_operation_is_finished (ModestMailOperation *self)
445 ModestMailOperationPrivate *priv;
446 gboolean retval = FALSE;
448 if (!MODEST_IS_MAIL_OPERATION (self)) {
449 g_warning ("%s: invalid parametter", G_GNUC_FUNCTION);
453 priv = MODEST_MAIL_OPERATION_GET_PRIVATE (self);
455 if (priv->status == MODEST_MAIL_OPERATION_STATUS_SUCCESS ||
456 priv->status == MODEST_MAIL_OPERATION_STATUS_FAILED ||
457 priv->status == MODEST_MAIL_OPERATION_STATUS_CANCELED ||
458 priv->status == MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS) {
467 /* ******************************************************************* */
468 /* ************************** STORE ACTIONS ************************* */
469 /* ******************************************************************* */
473 modest_mail_operation_create_folder (ModestMailOperation *self,
474 TnyFolderStore *parent,
477 ModestMailOperationPrivate *priv;
478 TnyFolder *new_folder = NULL;
479 //TnyStoreAccount *store_account;
481 g_return_val_if_fail (TNY_IS_FOLDER_STORE (parent), NULL);
482 g_return_val_if_fail (name, NULL);
484 priv = MODEST_MAIL_OPERATION_GET_PRIVATE (self);
486 /* Create the folder */
487 new_folder = tny_folder_store_create_folder (parent, name, &(priv->error));
488 CHECK_EXCEPTION (priv, MODEST_MAIL_OPERATION_STATUS_FAILED, return NULL);
490 /* /\* Subscribe to folder *\/ */
491 /* if (!tny_folder_is_subscribed (new_folder)) { */
492 /* store_account = TNY_STORE_ACCOUNT (tny_folder_get_account (TNY_FOLDER (parent))); */
493 /* tny_store_account_subscribe (store_account, new_folder); */
494 /* g_object_unref (G_OBJECT (store_account)); */
501 modest_mail_operation_remove_folder (ModestMailOperation *self,
503 gboolean remove_to_trash)
505 TnyFolderStore *parent;
507 ModestMailOperationPrivate *priv;
509 g_return_if_fail (MODEST_IS_MAIL_OPERATION (self));
510 g_return_if_fail (TNY_IS_FOLDER (folder));
512 priv = MODEST_MAIL_OPERATION_GET_PRIVATE (self);
514 /* Get the account */
515 account = tny_folder_get_account (folder);
517 /* Delete folder or move to trash */
518 if (remove_to_trash) {
519 TnyFolder *trash_folder, *new_folder;
520 trash_folder = modest_tny_account_get_special_folder (account,
521 TNY_FOLDER_TYPE_TRASH);
522 /* TODO: error_handling */
523 new_folder = modest_mail_operation_xfer_folder (self, folder,
524 TNY_FOLDER_STORE (trash_folder), TRUE);
525 g_object_unref (G_OBJECT (new_folder));
527 parent = tny_folder_get_folder_store (folder);
529 tny_folder_store_remove_folder (parent, folder, &(priv->error));
530 CHECK_EXCEPTION (priv, MODEST_MAIL_OPERATION_STATUS_FAILED, );
533 g_object_unref (G_OBJECT (parent));
535 g_object_unref (G_OBJECT (account));
539 modest_mail_operation_rename_folder (ModestMailOperation *self,
543 ModestMailOperationPrivate *priv;
545 g_return_if_fail (MODEST_IS_MAIL_OPERATION (self));
546 g_return_if_fail (TNY_IS_FOLDER_STORE (folder));
547 g_return_if_fail (name);
549 priv = MODEST_MAIL_OPERATION_GET_PRIVATE (self);
551 /* FIXME: better error handling */
552 if (strrchr (name, '/') != NULL)
555 /* Rename. Camel handles folder subscription/unsubscription */
556 tny_folder_set_name (folder, name, &(priv->error));
557 CHECK_EXCEPTION (priv, MODEST_MAIL_OPERATION_STATUS_FAILED, return);
561 modest_mail_operation_xfer_folder (ModestMailOperation *self,
563 TnyFolderStore *parent,
564 gboolean delete_original)
566 ModestMailOperationPrivate *priv;
568 g_return_val_if_fail (MODEST_IS_MAIL_OPERATION (self), NULL);
569 g_return_val_if_fail (TNY_IS_FOLDER_STORE (parent), NULL);
570 g_return_val_if_fail (TNY_IS_FOLDER (folder), NULL);
572 priv = MODEST_MAIL_OPERATION_GET_PRIVATE (self);
574 return tny_folder_copy (folder,
576 tny_folder_get_name (folder),
582 /* ******************************************************************* */
583 /* ************************** MSG ACTIONS ************************* */
584 /* ******************************************************************* */
587 modest_mail_operation_remove_msg (ModestMailOperation *self,
589 gboolean remove_to_trash)
593 g_return_if_fail (TNY_IS_HEADER (header));
595 folder = tny_header_get_folder (header);
597 /* Delete or move to trash */
598 if (remove_to_trash) {
599 TnyFolder *trash_folder;
600 TnyStoreAccount *store_account;
602 store_account = TNY_STORE_ACCOUNT (tny_folder_get_account (folder));
603 trash_folder = modest_tny_account_get_special_folder (TNY_ACCOUNT(store_account),
604 TNY_FOLDER_TYPE_TRASH);
606 modest_mail_operation_xfer_msg (self, header, trash_folder, TRUE);
607 /* g_object_unref (trash_folder); */
609 ModestMailOperationPrivate *priv;
611 /* Set status failed and set an error */
612 priv = MODEST_MAIL_OPERATION_GET_PRIVATE(self);
613 priv->status = MODEST_MAIL_OPERATION_STATUS_FAILED;
614 g_set_error (&(priv->error), MODEST_MAIL_OPERATION_ERROR,
615 MODEST_MAIL_OPERATION_ERROR_ITEM_NOT_FOUND,
616 _("Error trying to delete a message. Trash folder not found"));
619 g_object_unref (G_OBJECT (store_account));
621 tny_folder_remove_msg (folder, header, NULL); /* FIXME */
622 tny_folder_sync(folder, TRUE, NULL); /* FIXME */
626 g_object_unref (folder);
630 transfer_msgs_cb (TnyFolder *folder, GError **err, gpointer user_data)
632 ModestMailOperationPrivate *priv;
634 priv = MODEST_MAIL_OPERATION_GET_PRIVATE(user_data);
637 priv->error = g_error_copy (*err);
639 priv->status = MODEST_MAIL_OPERATION_STATUS_FAILED;
642 priv->status = MODEST_MAIL_OPERATION_STATUS_SUCCESS;
645 g_signal_emit (G_OBJECT (user_data), signals[PROGRESS_CHANGED_SIGNAL], 0, NULL);
649 modest_mail_operation_xfer_msg (ModestMailOperation *self,
652 gboolean delete_original)
654 ModestMailOperationPrivate *priv;
655 TnyFolder *src_folder;
658 g_return_val_if_fail (MODEST_IS_MAIL_OPERATION (self), FALSE);
659 g_return_val_if_fail (TNY_IS_HEADER (header), FALSE);
660 g_return_val_if_fail (TNY_IS_FOLDER (folder), FALSE);
662 src_folder = tny_header_get_folder (header);
663 headers = tny_simple_list_new ();
665 priv = MODEST_MAIL_OPERATION_GET_PRIVATE(self);
668 priv->status = MODEST_MAIL_OPERATION_STATUS_IN_PROGRESS;
670 tny_list_prepend (headers, G_OBJECT (header));
671 tny_folder_transfer_msgs_async (src_folder, headers, folder,
672 delete_original, transfer_msgs_cb,
676 /* FIXME: don't free 'm yet */
677 ///g_object_unref (headers);
678 ///g_object_unref (src_folder);