* Fixes NB#84889 show the proper error when a write error happens and it was not...
[modest] / src / modest-tny-local-folders-account.c
1 /* Copyright (c) 2007, 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 <string.h>
32 #include <stdio.h>
33 #include <config.h>
34 #include <glib/gi18n.h>
35 #include <tny-error.h>
36 #include <modest-tny-local-folders-account.h>
37 #include <modest-tny-outbox-account.h>
38 #include <modest-tny-folder.h>
39 #include <tny-camel-folder.h>
40 #include <tny-merge-folder.h>
41 #include <tny-simple-list.h>
42 #include <tny-gtk-lockable.h>
43
44 G_DEFINE_TYPE (ModestTnyLocalFoldersAccount, 
45         modest_tny_local_folders_account, 
46         TNY_TYPE_CAMEL_STORE_ACCOUNT);
47
48 #define TNY_LOCAL_FOLDERS_ACCOUNT_GET_PRIVATE(o) \
49   (G_TYPE_INSTANCE_GET_PRIVATE ((o), MODEST_TYPE_TNY_LOCAL_FOLDERS_ACCOUNT, ModestTnyLocalFoldersAccountPrivate))
50
51 typedef struct _ModestTnyLocalFoldersAccountPrivate ModestTnyLocalFoldersAccountPrivate;
52
53 struct _ModestTnyLocalFoldersAccountPrivate
54 {
55         TnyMergeFolder *outbox_folder;
56 };
57
58 static void         get_folders    (TnyFolderStore *self, 
59                                     TnyList *list, 
60                                     TnyFolderStoreQuery *query, 
61                                     GError **err);
62
63 static TnyFolder*   create_folder  (TnyFolderStore *self, 
64                                     const gchar *name, 
65                                     GError **err);
66
67 static void
68 modest_tny_local_folders_account_finalize (GObject *object)
69 {
70         ModestTnyLocalFoldersAccountPrivate *priv;
71
72         priv = TNY_LOCAL_FOLDERS_ACCOUNT_GET_PRIVATE (object);
73         if (priv->outbox_folder) {
74                 g_object_unref (priv->outbox_folder);
75                 priv->outbox_folder = NULL;
76         }
77         G_OBJECT_CLASS (modest_tny_local_folders_account_parent_class)->finalize (object);
78 }
79
80 static void
81 modest_tny_local_folders_account_class_init (ModestTnyLocalFoldersAccountClass *klass)
82 {
83         GObjectClass *object_class = G_OBJECT_CLASS (klass);
84         
85         g_type_class_add_private (klass, sizeof (ModestTnyLocalFoldersAccountPrivate));
86         
87         object_class->finalize = modest_tny_local_folders_account_finalize;
88           
89         /* Override virtual functions from the parent class: */
90         TNY_CAMEL_STORE_ACCOUNT_CLASS(klass)->get_folders = get_folders;
91         TNY_CAMEL_STORE_ACCOUNT_CLASS(klass)->create_folder = create_folder;
92 }
93
94 static void
95 modest_tny_local_folders_account_init (ModestTnyLocalFoldersAccount *self)
96 {
97         /* Do nothing */
98 }
99
100 ModestTnyLocalFoldersAccount*
101 modest_tny_local_folders_account_new (void)
102 {
103   return g_object_new (MODEST_TYPE_TNY_LOCAL_FOLDERS_ACCOUNT, NULL);
104 }
105
106 /**********************************************************/
107 /*          TnyCamelStoreAccount functions redefinitions  */
108 /**********************************************************/
109 static gboolean 
110 modest_tny_local_folders_account_query_passes (TnyFolderStoreQuery *query, TnyFolder *folder)
111 {
112         gboolean retval = FALSE;
113
114         if (query && (tny_list_get_length (tny_folder_store_query_get_items (query)) > 0)) {
115                 TnyList *items = tny_folder_store_query_get_items (query);
116                 TnyIterator *iterator;
117                 iterator = tny_list_create_iterator (items);
118
119                 while (!tny_iterator_is_done (iterator))
120                 {
121                         TnyFolderStoreQueryItem *item = (TnyFolderStoreQueryItem*) tny_iterator_get_current (iterator);
122                         if (item) {
123                                 TnyFolderStoreQueryOption options = tny_folder_store_query_item_get_options (item);
124                                 const regex_t *regex = tny_folder_store_query_item_get_regex (item);
125
126                                 if ((options & TNY_FOLDER_STORE_QUERY_OPTION_SUBSCRIBED) &&
127                                    tny_folder_is_subscribed (folder))
128                                         retval = TRUE;
129
130                                 if ((options & TNY_FOLDER_STORE_QUERY_OPTION_UNSUBSCRIBED) &&
131                                     !(tny_folder_is_subscribed (folder)))
132                                         retval = TRUE;
133
134                                 if (regex && options & TNY_FOLDER_STORE_QUERY_OPTION_MATCH_ON_NAME)
135                                    if (regexec (regex, tny_folder_get_name (folder), 0, NULL, 0) == 0)
136                                         retval = TRUE;
137
138                                 if (regex && options & TNY_FOLDER_STORE_QUERY_OPTION_MATCH_ON_ID)
139                                   if (regexec (regex, tny_folder_get_id (folder), 0, NULL, 0) == 0)
140                                         retval = TRUE;
141
142                                 g_object_unref (G_OBJECT (item));
143                         }
144
145                         tny_iterator_next (iterator);
146                 }
147                  
148                 g_object_unref (G_OBJECT (iterator));
149                 g_object_unref (G_OBJECT (items));
150         } else
151                 retval = TRUE;
152
153         return retval;
154 }
155
156 static void
157 get_folders (TnyFolderStore *self, TnyList *list, TnyFolderStoreQuery *query, GError **err)
158 {
159         TnyCamelStoreAccountClass *parent_class;
160         ModestTnyLocalFoldersAccountPrivate *priv;
161
162         /* Call the base class implementation: */
163         parent_class = g_type_class_peek_parent (MODEST_TNY_LOCAL_FOLDERS_ACCOUNT_GET_CLASS (self));
164         parent_class->get_folders (self, list, query, err);
165         
166         /* Add our extra folder only if it passes the query */
167         priv = TNY_LOCAL_FOLDERS_ACCOUNT_GET_PRIVATE (self);
168                 
169         if (priv->outbox_folder && 
170             modest_tny_local_folders_account_query_passes (query, TNY_FOLDER (priv->outbox_folder)))
171                 tny_list_prepend (list, G_OBJECT (priv->outbox_folder));
172 }
173
174 static TnyFolder*
175 create_folder (TnyFolderStore *self, 
176                const gchar *name, 
177                GError **err)
178 {
179         TnyCamelStoreAccountClass *parent_class;
180
181         parent_class = g_type_class_peek_parent (MODEST_TNY_LOCAL_FOLDERS_ACCOUNT_GET_CLASS (self));
182
183         /* If the folder name is been used by our extra folders */
184         if (modest_tny_local_folders_account_folder_name_in_use (MODEST_TNY_LOCAL_FOLDERS_ACCOUNT (self), name)) {
185                 g_set_error (err, TNY_ERROR_DOMAIN, 
186                              TNY_SERVICE_ERROR_FOLDER_CREATE,
187                              "Folder name already in use");
188                 return NULL;
189         }
190
191         /* Call the base class implementation: */
192         return parent_class->create_folder (self, name, err);
193 }
194
195 /*****************************/
196 /*      Public methods       */ 
197 /*****************************/
198 gboolean
199 modest_tny_local_folders_account_folder_name_in_use (ModestTnyLocalFoldersAccount *self,
200                                                      const gchar *name)
201 {
202         ModestTnyLocalFoldersAccountPrivate *priv;
203         gchar *down_name;
204         const gchar *type_name;
205         gboolean retval;
206         
207         /* Check that we're not trying to create/rename any folder
208            with the same name that our OUTBOX, DRAFT, SENT */
209         priv = TNY_LOCAL_FOLDERS_ACCOUNT_GET_PRIVATE (self);
210         down_name = g_utf8_strdown (name, strlen (name));
211
212         type_name = modest_local_folder_info_get_type_name (TNY_FOLDER_TYPE_OUTBOX);
213         if (!strcmp (type_name, down_name)) {
214                 retval = TRUE;
215         } else {
216                 type_name = modest_local_folder_info_get_type_name (TNY_FOLDER_TYPE_DRAFTS);
217                 if (!strcmp (type_name, down_name)) {
218                         retval = TRUE;
219                 } else {
220                         type_name = modest_local_folder_info_get_type_name (TNY_FOLDER_TYPE_SENT);
221                         if (!strcmp (type_name, down_name)) {
222                                 retval = TRUE;
223                         } else {
224                                 retval = FALSE;
225                         }
226                 }
227         }
228         g_free (down_name);
229
230         return retval;
231 }
232
233 void
234 modest_tny_local_folders_account_add_folder_to_outbox (ModestTnyLocalFoldersAccount *self, 
235                                                        TnyFolder *per_account_outbox)
236 {
237         ModestTnyLocalFoldersAccountPrivate *priv;
238
239         g_return_if_fail (MODEST_IS_TNY_LOCAL_FOLDERS_ACCOUNT (self));
240         g_return_if_fail (TNY_IS_FOLDER (per_account_outbox));
241
242         priv = TNY_LOCAL_FOLDERS_ACCOUNT_GET_PRIVATE (self);
243
244         /* Create on-demand */
245         if (!priv->outbox_folder) {
246                 priv->outbox_folder = TNY_MERGE_FOLDER (tny_merge_folder_new_with_ui_locker (_("mcen_me_folder_outbox"), tny_gtk_lockable_new ()));
247         
248                 /* Set type to outbox */
249                 tny_merge_folder_set_folder_type (priv->outbox_folder, TNY_FOLDER_TYPE_OUTBOX);
250         }
251
252         /* Add outbox to the global OUTBOX folder */
253         tny_merge_folder_add_folder (priv->outbox_folder, per_account_outbox);
254 }
255
256 void 
257 modest_tny_local_folders_account_remove_folder_from_outbox (ModestTnyLocalFoldersAccount *self, 
258                                                             TnyFolder *per_account_outbox)
259 {
260         ModestTnyLocalFoldersAccountPrivate *priv;
261         TnyList *merged_folders = NULL;
262
263         g_return_if_fail (MODEST_IS_TNY_LOCAL_FOLDERS_ACCOUNT (self));
264         g_return_if_fail (TNY_IS_FOLDER (per_account_outbox));
265
266         priv = TNY_LOCAL_FOLDERS_ACCOUNT_GET_PRIVATE (self);
267
268         /* Remove outbox from the global OUTBOX folder */
269         tny_merge_folder_remove_folder (priv->outbox_folder, per_account_outbox);
270
271         /* If there is no folder in the outbox the delete it */
272         merged_folders = tny_simple_list_new ();
273         tny_merge_folder_get_folders (priv->outbox_folder, merged_folders);
274         if (tny_list_get_length (merged_folders) == 0) {
275                 g_object_unref (priv->outbox_folder);
276                 priv->outbox_folder = NULL;
277         }
278         g_object_unref (merged_folders);
279 }
280
281 TnyFolder *
282 modest_tny_local_folders_account_get_merged_outbox (ModestTnyLocalFoldersAccount *self)
283 {
284         ModestTnyLocalFoldersAccountPrivate *priv;
285         g_return_val_if_fail (MODEST_IS_TNY_LOCAL_FOLDERS_ACCOUNT (self), NULL);
286
287         priv = TNY_LOCAL_FOLDERS_ACCOUNT_GET_PRIVATE (self);
288         if (priv->outbox_folder)
289                 return g_object_ref (priv->outbox_folder);
290         else
291                 return NULL;
292 }