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.
31 #include <glib/gi18n.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>
45 /* make sure you use the *full* name, because foo/drafts is not the same as drafts */
47 modest_tny_folder_guess_folder_type_from_name (const gchar* full_name)
49 g_return_val_if_fail (full_name, TNY_FOLDER_TYPE_INVALID);
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;
56 TNY_FOLDER_TYPE_NORMAL;
62 modest_tny_folder_guess_folder_type (TnyFolder *folder)
66 g_return_val_if_fail (TNY_IS_FOLDER(folder), TNY_FOLDER_TYPE_INVALID);
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);
72 type = tny_folder_get_folder_type (TNY_FOLDER (folder));
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);
80 if (TNY_IS_ACCOUNT (parent)) {
82 g_ascii_strdown (tny_camel_folder_get_full_name (TNY_CAMEL_FOLDER (folder)),
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;
93 g_object_unref (parent);
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);
103 if (type == TNY_FOLDER_TYPE_INVALID)
104 g_warning ("%s: BUG: TNY_FOLDER_TYPE_INVALID", __FUNCTION__);
111 modest_tny_folder_get_help_id (TnyFolder *folder)
114 const gchar* help_id = NULL;
116 g_return_val_if_fail (folder, NULL);
117 g_return_val_if_fail (TNY_IS_FOLDER(folder), NULL);
119 type = modest_tny_folder_guess_folder_type (TNY_FOLDER (folder));
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;
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);
138 /* FIXME: encode all folder rules here */
140 modest_tny_folder_get_rules (TnyFolder *folder)
142 ModestTnyFolderRules rules = 0;
145 g_return_val_if_fail (TNY_IS_FOLDER(folder), -1);
147 if (modest_tny_folder_is_local_folder (folder) ||
148 modest_tny_folder_is_memory_card_folder (folder)) {
150 type = modest_tny_folder_get_local_or_mmc_folder_type (folder);
151 g_return_val_if_fail (type != TNY_FOLDER_TYPE_INVALID, -1);
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;
175 ModestProtocolRegistry *protocol_registry;
176 ModestProtocolType protocol_type;
177 TnyFolderType folder_type;
180 protocol_registry = modest_runtime_get_protocol_registry ();
182 account = modest_tny_folder_get_account ((TnyFolder*)folder);
184 return -1; /* no account: nothing is allowed */
186 protocol_type = modest_tny_account_get_protocol_type (account);
188 if (modest_protocol_registry_protocol_type_has_tag (protocol_registry, protocol_type, MODEST_PROTOCOL_REGISTRY_STORE_HAS_FOLDERS)) {
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;
199 g_object_unref (G_OBJECT(account));
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);
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;
219 modest_tny_folder_is_local_folder (TnyFolder *folder)
221 g_return_val_if_fail (TNY_IS_FOLDER (folder), FALSE);
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.
229 if (TNY_IS_MERGE_FOLDER (folder)) {
233 TnyAccount* account = tny_folder_get_account ((TnyFolder*)folder);
235 g_warning ("folder without account");
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));
247 const gchar* account_id = tny_account_get_id (account);
249 g_warning ("BUG: account without account id");
250 g_object_unref (G_OBJECT(account));
254 g_object_unref (G_OBJECT(account));
255 return (strcmp (account_id, MODEST_LOCAL_FOLDERS_ACCOUNT_ID) == 0);
259 modest_tny_folder_is_memory_card_folder (TnyFolder *folder)
261 g_return_val_if_fail (folder, FALSE);
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.
267 if (TNY_IS_MERGE_FOLDER (folder))
270 TnyAccount* account = tny_folder_get_account ((TnyFolder*)folder);
274 const gchar* account_id = tny_account_get_id (account);
276 g_object_unref (account);
280 g_object_unref (account);
282 return (strcmp (account_id, MODEST_MMC_ACCOUNT_ID) == 0);
286 modest_tny_folder_is_remote_folder (TnyFolder *folder)
288 gboolean is_local = TRUE;
290 g_return_val_if_fail (TNY_IS_FOLDER(folder), FALSE);
292 is_local = ((modest_tny_folder_is_local_folder(folder)) ||
293 (modest_tny_folder_is_memory_card_folder(folder)));
301 modest_tny_folder_get_local_or_mmc_folder_type (TnyFolder *folder)
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);
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.
314 if (TNY_IS_MERGE_FOLDER (folder))
315 return TNY_FOLDER_TYPE_OUTBOX;
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;
324 if (parent_account) {
325 g_object_unref (parent_account);
326 parent_account = NULL;
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'
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); */
338 return TNY_FOLDER_TYPE_UNKNOWN;
340 return modest_local_folder_info_get_type (full_name);
344 modest_tny_folder_is_outbox_for_account (TnyFolder *folder, TnyAccount *account)
346 g_return_val_if_fail(folder, FALSE);
347 g_return_val_if_fail(account, FALSE);
349 if (modest_tny_folder_get_local_or_mmc_folder_type (folder) != TNY_FOLDER_TYPE_OUTBOX)
356 modest_tny_folder_get_header_unique_id (TnyHeader *header)
362 g_return_val_if_fail (TNY_IS_HEADER (header), NULL);
364 folder = tny_header_get_folder (header);
368 url = tny_folder_get_url_string (folder);
369 uid = tny_header_dup_uid (header);
371 retval = g_strjoin ("/", url, uid, NULL);
375 g_object_unref (folder);
381 modest_tny_folder_get_account (TnyFolder *folder)
383 TnyAccount *account = NULL;
385 g_return_val_if_fail (TNY_IS_FOLDER(folder), NULL);
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: */
392 account = modest_tny_account_store_get_local_folders_account (modest_runtime_get_account_store());
394 account = tny_folder_get_account (folder);
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.
407 * The code that uses the query is available in revision 3152.
410 modest_tny_folder_has_subfolder_with_name (TnyFolderStore *parent,
411 const gchar *new_name,
414 TnyList *subfolders = NULL;
415 TnyIterator *iter = NULL;
416 TnyFolder *folder = NULL;
418 gboolean has_name = FALSE;
420 g_return_val_if_fail (TNY_IS_FOLDER_STORE (parent), FALSE);
421 g_return_val_if_fail (new_name, FALSE);
423 /* Get direct subfolders */
424 subfolders = tny_simple_list_new ();
425 tny_folder_store_get_folders (parent, subfolders, NULL, FALSE, &err);
428 iter = tny_list_create_iterator (subfolders);
429 while (!tny_iterator_is_done (iter) && !has_name) {
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);
440 name = tny_folder_get_name (folder);
442 g_warning ("%s: folder name == NULL", __FUNCTION__);
443 g_object_unref (folder);
444 tny_iterator_next (iter);
448 /* is it simply the same folder name? */
449 if (strcmp (name, new_name) == 0)
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)
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),
465 g_object_unref (folder);
466 tny_iterator_next(iter);
470 g_object_unref (iter);
471 g_object_unref (subfolders);
477 modest_tny_folder_is_ancestor (TnyFolder *folder,
478 TnyFolderStore *ancestor)
480 TnyFolderStore *tmp = NULL;
481 gboolean found = FALSE;
483 tmp = TNY_FOLDER_STORE (folder);
484 while (!found && tmp && !TNY_IS_ACCOUNT (tmp)) {
485 TnyFolderStore *folder_store;
487 folder_store = tny_folder_get_folder_store (TNY_FOLDER (tmp));
488 if (ancestor == folder_store)
492 g_object_unref (folder_store);
498 modest_tny_folder_get_display_name (TnyFolder *folder)
500 TnyFolderType type = TNY_FOLDER_TYPE_UNKNOWN;
503 g_return_val_if_fail (TNY_IS_FOLDER (folder), NULL);
505 fname = g_strdup (tny_folder_get_name (folder));
506 type = tny_folder_get_folder_type (folder);
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) {
513 fname = g_strdup (modest_local_folder_info_get_type_display_name (type));
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));
524 if (type == TNY_FOLDER_TYPE_INBOX) {
526 fname = g_strdup (_("mcen_me_folder_inbox"));