Fixes NB#140509, sync() currently viewed folder on send&receive even with auto-updates
[modest] / src / modest-tny-folder.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 #include <glib.h>
31 #include <glib/gi18n.h>
32 #include <string.h>
33 #include <modest-defs.h>
34 #include <modest-tny-folder.h>
35 #include <modest-tny-account.h>
36 #include <modest-tny-outbox-account.h>
37 #include <tny-simple-list.h>
38 #include <tny-camel-folder.h>
39 #include <tny-merge-folder.h>
40 #include <modest-runtime.h>
41 #include <modest-tny-account-store.h>
42 #include <modest-text-utils.h>
43
44
45 /* make sure you use the *full* name, because foo/drafts is not the same as drafts */
46 static TnyFolderType
47 modest_tny_folder_guess_folder_type_from_name (const gchar* full_name)
48 {
49         g_return_val_if_fail (full_name, TNY_FOLDER_TYPE_INVALID);
50         
51         if (strcmp (full_name, modest_local_folder_info_get_type_name(TNY_FOLDER_TYPE_OUTBOX)) == 0)
52                 return TNY_FOLDER_TYPE_OUTBOX;
53         else if (strcmp (full_name, modest_local_folder_info_get_type_name(TNY_FOLDER_TYPE_DRAFTS)) == 0)
54                 return TNY_FOLDER_TYPE_DRAFTS;
55         return
56                 TNY_FOLDER_TYPE_NORMAL;
57 }
58
59
60
61 TnyFolderType
62 modest_tny_folder_guess_folder_type (TnyFolder *folder)
63 {
64         TnyFolderType type;
65         
66         g_return_val_if_fail (TNY_IS_FOLDER(folder), TNY_FOLDER_TYPE_INVALID);
67
68         if (modest_tny_folder_is_local_folder (folder) || 
69             modest_tny_folder_is_memory_card_folder (folder))
70                 type = modest_tny_folder_get_local_or_mmc_folder_type (folder);
71         else
72                 type = tny_folder_get_folder_type (TNY_FOLDER (folder));
73
74         /* Fallback code, some servers (Dovecot in some versions)
75            report incorrectly that the INBOX folder is a normal
76            folder. Really ugly code but... */
77         if (type == TNY_FOLDER_TYPE_NORMAL) {
78                 TnyFolderStore *parent = tny_folder_get_folder_store (folder);
79                 if (parent) {
80                         if (TNY_IS_ACCOUNT (parent)) {
81                                 gchar *downcase = 
82                                         g_ascii_strdown (tny_camel_folder_get_full_name (TNY_CAMEL_FOLDER (folder)), 
83                                                          -1);
84
85                                 if ((strlen (downcase) == 5) &&
86                                     !strncmp (downcase, "inbox", 5))
87                                         type = TNY_FOLDER_TYPE_INBOX;
88                                 if ((strlen (downcase) == 7) &&
89                                     !strncmp (downcase, "archive", 7))
90                                         type = TNY_FOLDER_TYPE_ARCHIVE;
91                                 g_free (downcase);
92                         }
93                         g_object_unref (parent);
94                 }
95         }
96         
97         if (type == TNY_FOLDER_TYPE_UNKNOWN) {
98                 const gchar *folder_name =
99                         tny_camel_folder_get_full_name (TNY_CAMEL_FOLDER (folder));
100                 type =  modest_tny_folder_guess_folder_type_from_name (folder_name);
101         }
102
103         if (type == TNY_FOLDER_TYPE_INVALID)
104                 g_warning ("%s: BUG: TNY_FOLDER_TYPE_INVALID", __FUNCTION__);
105
106         return type;
107 }
108
109
110 const gchar*
111 modest_tny_folder_get_help_id (TnyFolder *folder)
112 {
113         TnyFolderType type;
114         const gchar* help_id = NULL;
115         
116         g_return_val_if_fail (folder, NULL);
117         g_return_val_if_fail (TNY_IS_FOLDER(folder), NULL);
118         
119         type = modest_tny_folder_guess_folder_type (TNY_FOLDER (folder));
120         
121         switch (type) {
122         case TNY_FOLDER_TYPE_NORMAL:  help_id = "applications_email_managefolders"; break;
123         case TNY_FOLDER_TYPE_INBOX:   help_id = "applications_email_inbox";break;
124         case TNY_FOLDER_TYPE_OUTBOX:  help_id = "applications_email_outbox";break;
125         case TNY_FOLDER_TYPE_SENT:    help_id = "applications_email_sent"; break;
126         case TNY_FOLDER_TYPE_DRAFTS:  help_id = "applications_email_drafts";break;
127         case TNY_FOLDER_TYPE_ARCHIVE: help_id = "applications_email_managefolders";break;
128
129         case TNY_FOLDER_TYPE_INVALID: g_warning ("%s: BUG: TNY_FOLDER_TYPE_INVALID", __FUNCTION__);break;
130         default:                      g_warning ("%s: BUG: unexpected folder type (%d)", __FUNCTION__, type);
131         }
132         
133         return help_id;
134 }
135
136
137
138 /* FIXME: encode all folder rules here */
139 ModestTnyFolderRules
140 modest_tny_folder_get_rules   (TnyFolder *folder)
141 {
142         ModestTnyFolderRules rules = 0;
143         TnyFolderType type;
144
145         g_return_val_if_fail (TNY_IS_FOLDER(folder), -1);
146         
147         if (modest_tny_folder_is_local_folder (folder) ||
148             modest_tny_folder_is_memory_card_folder (folder)) {
149         
150                 type = modest_tny_folder_get_local_or_mmc_folder_type (folder);
151                 g_return_val_if_fail (type != TNY_FOLDER_TYPE_INVALID, -1);
152                 
153                 switch (type) {
154                 case TNY_FOLDER_TYPE_OUTBOX:
155                 case TNY_FOLDER_TYPE_SENT:
156                 case TNY_FOLDER_TYPE_DRAFTS:
157                         rules |= MODEST_FOLDER_RULES_FOLDER_NON_WRITEABLE;
158                 case TNY_FOLDER_TYPE_INBOX:
159                 case TNY_FOLDER_TYPE_JUNK:
160                 case TNY_FOLDER_TYPE_TRASH:
161                 case TNY_FOLDER_TYPE_ROOT:
162                 case TNY_FOLDER_TYPE_NOTES:
163                 case TNY_FOLDER_TYPE_CONTACTS:
164                 case TNY_FOLDER_TYPE_CALENDAR:
165                 case TNY_FOLDER_TYPE_ARCHIVE:
166                 case TNY_FOLDER_TYPE_MERGE:
167                 case TNY_FOLDER_TYPE_NUM:
168                         rules |= MODEST_FOLDER_RULES_FOLDER_NON_DELETABLE;
169                         rules |= MODEST_FOLDER_RULES_FOLDER_NON_MOVEABLE;
170                         rules |= MODEST_FOLDER_RULES_FOLDER_NON_RENAMEABLE;
171                 default:
172                         break;
173                 }
174         } else {
175                 ModestProtocolRegistry *protocol_registry;
176                 ModestProtocolType protocol_type;
177                 TnyFolderType folder_type;
178                 TnyAccount *account;
179
180                 protocol_registry = modest_runtime_get_protocol_registry ();
181
182                 account = modest_tny_folder_get_account ((TnyFolder*)folder);
183                 if (!account)
184                         return -1; /* no account: nothing is allowed */
185                 
186                 protocol_type = modest_tny_account_get_protocol_type (account);
187
188                 if (modest_protocol_registry_protocol_type_has_tag (protocol_registry, protocol_type, MODEST_PROTOCOL_REGISTRY_STORE_HAS_FOLDERS)) {
189                         rules = 0;
190                 } else {
191                         /* pop, nntp, ... */
192                         rules =
193                                 MODEST_FOLDER_RULES_FOLDER_NON_WRITEABLE |
194                                 MODEST_FOLDER_RULES_FOLDER_NON_DELETABLE |
195                                 MODEST_FOLDER_RULES_FOLDER_NON_MOVEABLE  |
196                                 MODEST_FOLDER_RULES_FOLDER_NON_RENAMEABLE;
197
198                 }
199                 g_object_unref (G_OBJECT(account));
200
201                 /* Neither INBOX nor ROOT, nor ARCHIVE folders should me moveable */
202                 folder_type = modest_tny_folder_guess_folder_type (folder);
203                 g_return_val_if_fail (folder_type != TNY_FOLDER_TYPE_INVALID, -1);
204                 
205                 if ((folder_type ==  TNY_FOLDER_TYPE_INBOX) ||
206                     (folder_type == TNY_FOLDER_TYPE_ROOT) ||
207                     (folder_type == TNY_FOLDER_TYPE_ARCHIVE)) {
208                         rules |= MODEST_FOLDER_RULES_FOLDER_NON_DELETABLE;
209                         rules |= MODEST_FOLDER_RULES_FOLDER_NON_MOVEABLE;
210                         rules |= MODEST_FOLDER_RULES_FOLDER_NON_RENAMEABLE;
211                 }
212         }
213         return rules;
214 }
215
216         
217
218 gboolean
219 modest_tny_folder_is_local_folder   (TnyFolder *folder)
220 {
221         g_return_val_if_fail (TNY_IS_FOLDER (folder), FALSE);
222         
223         /* The merge folder is a special case, 
224          * used to merge the per-account local outbox folders. 
225          * and can have no get_account() implementation.
226          * We should do something more sophisticated if we 
227          * ever use TnyMergeFolder for anything else.
228          */
229         if (TNY_IS_MERGE_FOLDER (folder)) {
230                 return TRUE;
231         }
232         
233         TnyAccount* account = tny_folder_get_account ((TnyFolder*)folder);
234         if (!account) {
235                 g_warning ("folder without account");
236                 return FALSE;
237         }
238         
239         /* Outbox is a special case, using a derived TnyAccount: */
240         if (MODEST_IS_TNY_OUTBOX_ACCOUNT (account)) {
241                 //g_warning ("BUG: should not be reached");
242                 /* should be handled with the MERGE_FOLDER above*/
243                 g_object_unref (G_OBJECT(account));
244                 return TRUE;
245         }
246
247         const gchar* account_id = tny_account_get_id (account);
248         if (!account_id) {
249                 g_warning ("BUG: account without account id");
250                 g_object_unref (G_OBJECT(account));
251                 return FALSE;
252         }
253         
254         g_object_unref (G_OBJECT(account));
255         return (strcmp (account_id, MODEST_LOCAL_FOLDERS_ACCOUNT_ID) == 0);
256 }
257
258 gboolean
259 modest_tny_folder_is_memory_card_folder   (TnyFolder *folder)
260 {
261         g_return_val_if_fail (folder, FALSE);
262
263         /* The merge folder is a special case,
264          * used to merge the per-account local outbox folders.
265          * and can have no get_account() implementation.
266          */
267         if (TNY_IS_MERGE_FOLDER (folder))
268                 return FALSE;
269
270         TnyAccount* account = tny_folder_get_account ((TnyFolder*)folder);
271         if (!account)
272                 return FALSE;
273
274         const gchar* account_id = tny_account_get_id (account);
275         if (!account_id) {
276                 g_object_unref (account);
277                 return FALSE;
278         }
279
280         g_object_unref (account);
281
282         return (strcmp (account_id, MODEST_MMC_ACCOUNT_ID) == 0);
283 }
284
285 gboolean
286 modest_tny_folder_is_remote_folder   (TnyFolder *folder)
287 {
288         gboolean is_local = TRUE;
289
290         g_return_val_if_fail (TNY_IS_FOLDER(folder), FALSE);
291         
292         is_local = ((modest_tny_folder_is_local_folder(folder)) ||
293                     (modest_tny_folder_is_memory_card_folder(folder)));
294
295
296         return !is_local;
297 }
298
299
300 TnyFolderType
301 modest_tny_folder_get_local_or_mmc_folder_type  (TnyFolder *folder)
302 {
303         g_return_val_if_fail (folder, TNY_FOLDER_TYPE_INVALID);
304         g_return_val_if_fail (modest_tny_folder_is_local_folder(folder)||
305                               modest_tny_folder_is_memory_card_folder(folder),
306                               TNY_FOLDER_TYPE_INVALID);
307         
308         /* The merge folder is a special case, 
309          * used to merge the per-account local outbox folders. 
310          * and can have no get_account() implementation.
311          * We should do something more sophisticated if we 
312          * ever use TnyMergeFolder for anything else.
313          */
314         if (TNY_IS_MERGE_FOLDER (folder))
315                 return TNY_FOLDER_TYPE_OUTBOX;
316                 
317         /* Outbox is a special case, using a derived TnyAccount: */
318         TnyAccount* parent_account = tny_folder_get_account (folder);
319         if (parent_account && MODEST_IS_TNY_OUTBOX_ACCOUNT (parent_account)) {
320                 g_object_unref (parent_account);
321                 return TNY_FOLDER_TYPE_OUTBOX;  
322         }
323
324         if (parent_account) {
325                 g_object_unref (parent_account);
326                 parent_account = NULL;
327         }
328         
329         /* we need to use the camel functions, because we want the
330          * _full name_, that is, the full path name of the folder,
331          * to distinguish between 'Outbox' and 'myfunkyfolder/Outbox'
332          */
333
334         const gchar *full_name = tny_camel_folder_get_full_name (TNY_CAMEL_FOLDER (folder));
335         /* printf ("DEBUG: %s: full_name=%s\n", __FUNCTION__, full_name); */
336         
337         if (!full_name) 
338                 return TNY_FOLDER_TYPE_UNKNOWN;
339         else 
340                 return modest_local_folder_info_get_type (full_name);
341 }
342
343 gboolean
344 modest_tny_folder_is_outbox_for_account (TnyFolder *folder, TnyAccount *account)
345 {
346         g_return_val_if_fail(folder, FALSE);
347         g_return_val_if_fail(account, FALSE);
348         
349         if (modest_tny_folder_get_local_or_mmc_folder_type (folder) != TNY_FOLDER_TYPE_OUTBOX)
350                 return FALSE;
351                 
352         return TRUE;
353 }
354
355 gchar* 
356 modest_tny_folder_get_header_unique_id (TnyHeader *header)
357 {
358         TnyFolder *folder;
359         gchar *url, *retval;
360         gchar *uid;
361
362         g_return_val_if_fail (TNY_IS_HEADER (header), NULL);
363
364         folder = tny_header_get_folder (header);
365         if (!folder)
366                 return NULL;
367
368         url = tny_folder_get_url_string (folder);
369         uid = tny_header_dup_uid (header);
370
371         retval = g_strjoin ("/", url, uid, NULL);
372         g_free (uid);
373
374         g_free (url);
375         g_object_unref (folder);
376
377         return retval;
378 }
379
380 TnyAccount *
381 modest_tny_folder_get_account (TnyFolder *folder)
382 {
383         TnyAccount *account = NULL;
384
385         g_return_val_if_fail (TNY_IS_FOLDER(folder), NULL);
386         
387         if (TNY_IS_MERGE_FOLDER (folder)) {
388                 /* TnyMergeFolder does not support get_account(), 
389                  * because it could be merging folders from multiple accounts.
390                  * So we assume that this is the local folders account: */
391                  
392                 account = modest_tny_account_store_get_local_folders_account (modest_runtime_get_account_store());
393         } else {
394                 account = tny_folder_get_account (folder);
395         }
396         
397         return account;
398 }
399
400 /*
401  * It's probably better to use a query to get the folders that match
402  * new_name but currently tinymail only provides a match by name using
403  * regular expressions and we want an exact matching. We're not using
404  * a regular expression for the exact name because we'd need first to
405  * escape @new_name and it's not easy sometimes. 
406  *
407  * The code that uses the query is available in revision 3152.
408  */
409 gboolean
410 modest_tny_folder_has_subfolder_with_name (TnyFolderStore *parent,
411                                            const gchar *new_name,
412                                            gboolean non_strict)
413 {
414         TnyList *subfolders = NULL;
415         TnyIterator *iter = NULL;
416         TnyFolder *folder = NULL;
417         GError *err = NULL;
418         gboolean has_name = FALSE;
419
420         g_return_val_if_fail (TNY_IS_FOLDER_STORE (parent), FALSE);
421         g_return_val_if_fail (new_name, FALSE);
422
423         /* Get direct subfolders */
424         subfolders = tny_simple_list_new ();
425         tny_folder_store_get_folders (parent, subfolders, NULL, FALSE, &err);
426
427         /* Check names */
428         iter = tny_list_create_iterator (subfolders);
429         while (!tny_iterator_is_done (iter) && !has_name) {
430
431                 const gchar *name;
432
433                 folder = (TnyFolder*)tny_iterator_get_current (iter);
434                 if (!folder || ! TNY_IS_FOLDER(folder)) {
435                         g_warning ("%s: invalid folder", __FUNCTION__);
436                         tny_iterator_next (iter);
437                         continue;
438                 }
439
440                 name = tny_folder_get_name (folder);
441                 if (!name) {
442                         g_warning ("%s: folder name == NULL", __FUNCTION__);
443                         g_object_unref (folder);
444                         tny_iterator_next (iter);
445                         continue;
446                 }
447
448                 /* is it simply the same folder name? */
449                 if (strcmp (name, new_name) == 0)
450                         has_name = TRUE;
451                 /* or is it the same when ignoring case (non-strict mode)? */
452                 else if (non_strict && modest_text_utils_utf8_strcmp (name, new_name, TRUE) == 0)
453                         has_name = TRUE;
454                 /* or is the name equal to the display name of some folder, in the current locale? */
455                 else if (non_strict) {
456                         TnyFolderType type = modest_tny_folder_guess_folder_type (folder);
457                         if (type != TNY_FOLDER_TYPE_INVALID && type != TNY_FOLDER_TYPE_NORMAL) 
458                                 has_name = !(modest_text_utils_utf8_strcmp (modest_local_folder_info_get_type_display_name (type),
459                                                                             new_name,
460                                                                             TRUE));
461                 } else {
462                         has_name = FALSE;
463                 }
464
465                 g_object_unref (folder);
466                 tny_iterator_next(iter);
467         }
468
469         /* free */
470         g_object_unref (iter);
471         g_object_unref (subfolders);
472
473         return has_name;
474 }
475
476 gboolean 
477 modest_tny_folder_is_ancestor (TnyFolder *folder,
478                                TnyFolderStore *ancestor)
479 {
480         TnyFolderStore *tmp = NULL;
481         gboolean found = FALSE;
482
483         tmp = TNY_FOLDER_STORE (folder);
484         while (!found && tmp && !TNY_IS_ACCOUNT (tmp)) {
485                 TnyFolderStore *folder_store;
486
487                 folder_store = tny_folder_get_folder_store (TNY_FOLDER (tmp));
488                 if (ancestor == folder_store)
489                         found = TRUE;
490                 else
491                         tmp = folder_store;
492                 g_object_unref (folder_store);
493         }
494         return found;
495 }
496
497 gchar * 
498 modest_tny_folder_get_display_name (TnyFolder *folder)
499 {
500         TnyFolderType type = TNY_FOLDER_TYPE_UNKNOWN;
501         gchar *fname;
502
503         g_return_val_if_fail (TNY_IS_FOLDER (folder), NULL);
504
505         fname = g_strdup (tny_folder_get_name (folder));
506         type = tny_folder_get_folder_type (folder);
507
508         if (modest_tny_folder_is_local_folder (TNY_FOLDER (folder)) ||
509             modest_tny_folder_is_memory_card_folder (TNY_FOLDER (folder))) {
510                 type = modest_tny_folder_get_local_or_mmc_folder_type (TNY_FOLDER (folder));
511                 if (type != TNY_FOLDER_TYPE_UNKNOWN) {
512                         g_free (fname);
513                                 fname = g_strdup (modest_local_folder_info_get_type_display_name (type));
514                 }
515         } else {
516                 /* Sometimes an special folder is reported by the server as
517                    NORMAL, like some versions of Dovecot */
518                 if (type == TNY_FOLDER_TYPE_NORMAL ||
519                     type == TNY_FOLDER_TYPE_UNKNOWN) {
520                         type = modest_tny_folder_guess_folder_type (TNY_FOLDER (folder));
521                 }
522         }
523
524         if (type == TNY_FOLDER_TYPE_INBOX) {
525                 g_free (fname);
526                 fname = g_strdup (_("mcen_me_folder_inbox"));
527         }
528
529         return fname;
530 }
531
532 TnyFolder *
533 modest_tny_folder_store_find_folder_from_uri (TnyFolderStore *folder_store, const gchar *uri)
534 {
535         TnyList *children;
536         TnyIterator *iterator;
537         TnyFolder *result;
538         gchar *uri_to_find, *slash;
539         gint uri_lenght;
540
541         if (uri == NULL)
542                 return NULL;
543
544         slash = strrchr (uri, '/');
545         if (slash == NULL)
546                 return NULL;
547
548         result = NULL;
549         children = TNY_LIST (tny_simple_list_new ());
550         tny_folder_store_get_folders (folder_store, children, NULL, FALSE, NULL);
551
552         uri_lenght = slash - uri + 1;
553         uri_to_find = g_malloc0 (sizeof(char) * uri_lenght);
554         strncpy (uri_to_find, uri, uri_lenght);
555         uri_to_find[uri_lenght - 1] = '\0';
556
557         for (iterator = tny_list_create_iterator (children);
558              iterator && !tny_iterator_is_done (iterator) && (result == NULL);
559              tny_iterator_next (iterator)) {
560                 TnyFolderStore *child;
561
562                 child = TNY_FOLDER_STORE (tny_iterator_get_current (iterator));
563                 if (!child) 
564                         continue;
565
566                 if (TNY_IS_FOLDER (child)) {
567                         gchar *folder_url;
568
569                         folder_url = tny_folder_get_url_string (TNY_FOLDER (child));
570                         if (uri_to_find && folder_url && !strcmp (folder_url, uri_to_find))
571                                 result = g_object_ref (child);
572                         g_free (folder_url);
573                 }
574
575                 if ((result == NULL) && TNY_IS_FOLDER_STORE (child)) {
576                         result = modest_tny_folder_store_find_folder_from_uri (child, uri);
577                 }
578
579                 g_object_unref (child);
580         }
581
582         g_free (uri_to_find);
583         g_object_unref (iterator);
584         g_object_unref (children);
585
586         return result;
587 }