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-tny-folder.h>
34 #include <modest-tny-account.h>
35 #include <modest-tny-outbox-account.h>
36 #include <tny-simple-list.h>
37 #include <tny-camel-folder.h>
38 #include <tny-merge-folder.h>
39 #include <modest-runtime.h>
40 #include <modest-tny-account-store.h>
41 #include <modest-text-utils.h>
44 /* make sure you use the *full* name, because foo/drafts is not the same as drafts */
46 modest_tny_folder_guess_folder_type_from_name (const gchar* full_name)
48 g_return_val_if_fail (full_name, TNY_FOLDER_TYPE_INVALID);
50 if (strcmp (full_name, modest_local_folder_info_get_type_name(TNY_FOLDER_TYPE_OUTBOX)) == 0)
51 return TNY_FOLDER_TYPE_OUTBOX;
52 else if (strcmp (full_name, modest_local_folder_info_get_type_name(TNY_FOLDER_TYPE_DRAFTS)) == 0)
53 return TNY_FOLDER_TYPE_DRAFTS;
55 TNY_FOLDER_TYPE_NORMAL;
61 modest_tny_folder_guess_folder_type (TnyFolder *folder)
65 g_return_val_if_fail (TNY_IS_FOLDER(folder), TNY_FOLDER_TYPE_INVALID);
67 if (modest_tny_folder_is_local_folder (folder) ||
68 modest_tny_folder_is_memory_card_folder (folder))
69 type = modest_tny_folder_get_local_or_mmc_folder_type (folder);
71 type = tny_folder_get_folder_type (TNY_FOLDER (folder));
73 /* Fallback code, some servers (Dovecot in some versions)
74 report incorrectly that the INBOX folder is a normal
75 folder. Really ugly code but... */
76 if (type == TNY_FOLDER_TYPE_NORMAL) {
77 TnyFolderStore *parent = tny_folder_get_folder_store (folder);
79 if (TNY_IS_ACCOUNT (parent)) {
81 g_ascii_strdown (tny_camel_folder_get_full_name (TNY_CAMEL_FOLDER (folder)),
84 if ((strlen (downcase) == 5) &&
85 !strncmp (downcase, "inbox", 5))
86 type = TNY_FOLDER_TYPE_INBOX;
87 if ((strlen (downcase) == 7) &&
88 !strncmp (downcase, "archive", 7))
89 type = TNY_FOLDER_TYPE_ARCHIVE;
92 g_object_unref (parent);
96 if (type == TNY_FOLDER_TYPE_UNKNOWN) {
97 const gchar *folder_name =
98 tny_camel_folder_get_full_name (TNY_CAMEL_FOLDER (folder));
99 type = modest_tny_folder_guess_folder_type_from_name (folder_name);
102 if (type == TNY_FOLDER_TYPE_INVALID)
103 g_warning ("%s: BUG: TNY_FOLDER_TYPE_INVALID", __FUNCTION__);
110 modest_tny_folder_get_help_id (TnyFolder *folder)
113 const gchar* help_id = NULL;
115 g_return_val_if_fail (folder, NULL);
116 g_return_val_if_fail (TNY_IS_FOLDER(folder), NULL);
118 type = modest_tny_folder_guess_folder_type (TNY_FOLDER (folder));
121 case TNY_FOLDER_TYPE_NORMAL: help_id = "applications_email_managefolders"; break;
122 case TNY_FOLDER_TYPE_INBOX: help_id = "applications_email_inbox";break;
123 case TNY_FOLDER_TYPE_OUTBOX: help_id = "applications_email_outbox";break;
124 case TNY_FOLDER_TYPE_SENT: help_id = "applications_email_sent"; break;
125 case TNY_FOLDER_TYPE_DRAFTS: help_id = "applications_email_drafts";break;
126 case TNY_FOLDER_TYPE_ARCHIVE: help_id = "applications_email_managefolders";break;
128 case TNY_FOLDER_TYPE_INVALID: g_warning ("%s: BUG: TNY_FOLDER_TYPE_INVALID", __FUNCTION__);break;
129 default: g_warning ("%s: BUG: unexpected folder type (%d)", __FUNCTION__, type);
137 /* FIXME: encode all folder rules here */
139 modest_tny_folder_get_rules (TnyFolder *folder)
141 ModestTnyFolderRules rules = 0;
144 g_return_val_if_fail (TNY_IS_FOLDER(folder), -1);
146 if (modest_tny_folder_is_local_folder (folder) ||
147 modest_tny_folder_is_memory_card_folder (folder)) {
149 type = modest_tny_folder_get_local_or_mmc_folder_type (folder);
150 g_return_val_if_fail (type != TNY_FOLDER_TYPE_INVALID, -1);
153 case TNY_FOLDER_TYPE_OUTBOX:
154 case TNY_FOLDER_TYPE_SENT:
155 case TNY_FOLDER_TYPE_DRAFTS:
156 rules |= MODEST_FOLDER_RULES_FOLDER_NON_WRITEABLE;
157 case TNY_FOLDER_TYPE_INBOX:
158 case TNY_FOLDER_TYPE_JUNK:
159 case TNY_FOLDER_TYPE_TRASH:
160 case TNY_FOLDER_TYPE_ROOT:
161 case TNY_FOLDER_TYPE_NOTES:
162 case TNY_FOLDER_TYPE_CONTACTS:
163 case TNY_FOLDER_TYPE_CALENDAR:
164 case TNY_FOLDER_TYPE_ARCHIVE:
165 case TNY_FOLDER_TYPE_MERGE:
166 case TNY_FOLDER_TYPE_NUM:
167 rules |= MODEST_FOLDER_RULES_FOLDER_NON_DELETABLE;
168 rules |= MODEST_FOLDER_RULES_FOLDER_NON_MOVEABLE;
169 rules |= MODEST_FOLDER_RULES_FOLDER_NON_RENAMEABLE;
174 ModestProtocolRegistry *protocol_registry;
175 ModestProtocolType protocol_type;
176 TnyFolderType folder_type;
179 protocol_registry = modest_runtime_get_protocol_registry ();
181 account = modest_tny_folder_get_account ((TnyFolder*)folder);
183 return -1; /* no account: nothing is allowed */
185 protocol_type = modest_tny_account_get_protocol_type (account);
187 if (modest_protocol_registry_protocol_type_has_tag (protocol_registry, protocol_type, MODEST_PROTOCOL_REGISTRY_STORE_HAS_FOLDERS)) {
192 MODEST_FOLDER_RULES_FOLDER_NON_WRITEABLE |
193 MODEST_FOLDER_RULES_FOLDER_NON_DELETABLE |
194 MODEST_FOLDER_RULES_FOLDER_NON_MOVEABLE |
195 MODEST_FOLDER_RULES_FOLDER_NON_RENAMEABLE;
198 g_object_unref (G_OBJECT(account));
200 /* Neither INBOX nor ROOT, nor ARCHIVE folders should me moveable */
201 folder_type = modest_tny_folder_guess_folder_type (folder);
202 g_return_val_if_fail (folder_type != TNY_FOLDER_TYPE_INVALID, -1);
204 if ((folder_type == TNY_FOLDER_TYPE_INBOX) ||
205 (folder_type == TNY_FOLDER_TYPE_ROOT) ||
206 (folder_type == TNY_FOLDER_TYPE_ARCHIVE)) {
207 rules |= MODEST_FOLDER_RULES_FOLDER_NON_DELETABLE;
208 rules |= MODEST_FOLDER_RULES_FOLDER_NON_MOVEABLE;
209 rules |= MODEST_FOLDER_RULES_FOLDER_NON_RENAMEABLE;
218 modest_tny_folder_is_local_folder (TnyFolder *folder)
220 g_return_val_if_fail (TNY_IS_FOLDER (folder), FALSE);
222 /* The merge folder is a special case,
223 * used to merge the per-account local outbox folders.
224 * and can have no get_account() implementation.
225 * We should do something more sophisticated if we
226 * ever use TnyMergeFolder for anything else.
228 if (TNY_IS_MERGE_FOLDER (folder)) {
232 TnyAccount* account = tny_folder_get_account ((TnyFolder*)folder);
234 g_warning ("folder without account");
238 /* Outbox is a special case, using a derived TnyAccount: */
239 if (MODEST_IS_TNY_OUTBOX_ACCOUNT (account)) {
240 //g_warning ("BUG: should not be reached");
241 /* should be handled with the MERGE_FOLDER above*/
242 g_object_unref (G_OBJECT(account));
246 const gchar* account_id = tny_account_get_id (account);
248 g_warning ("BUG: account without account id");
249 g_object_unref (G_OBJECT(account));
253 g_object_unref (G_OBJECT(account));
254 return (strcmp (account_id, MODEST_LOCAL_FOLDERS_ACCOUNT_ID) == 0);
258 modest_tny_folder_is_memory_card_folder (TnyFolder *folder)
260 g_return_val_if_fail (folder, FALSE);
262 /* The merge folder is a special case,
263 * used to merge the per-account local outbox folders.
264 * and can have no get_account() implementation.
266 if (TNY_IS_MERGE_FOLDER (folder))
269 TnyAccount* account = tny_folder_get_account ((TnyFolder*)folder);
273 const gchar* account_id = tny_account_get_id (account);
275 g_object_unref (account);
279 g_object_unref (account);
281 return (strcmp (account_id, MODEST_MMC_ACCOUNT_ID) == 0);
285 modest_tny_folder_is_remote_folder (TnyFolder *folder)
287 gboolean is_local = TRUE;
289 g_return_val_if_fail (TNY_IS_FOLDER(folder), FALSE);
291 is_local = ((modest_tny_folder_is_local_folder(folder)) ||
292 (modest_tny_folder_is_memory_card_folder(folder)));
300 modest_tny_folder_get_local_or_mmc_folder_type (TnyFolder *folder)
302 g_return_val_if_fail (folder, TNY_FOLDER_TYPE_INVALID);
303 g_return_val_if_fail (modest_tny_folder_is_local_folder(folder)||
304 modest_tny_folder_is_memory_card_folder(folder),
305 TNY_FOLDER_TYPE_INVALID);
307 /* The merge folder is a special case,
308 * used to merge the per-account local outbox folders.
309 * and can have no get_account() implementation.
310 * We should do something more sophisticated if we
311 * ever use TnyMergeFolder for anything else.
313 if (TNY_IS_MERGE_FOLDER (folder))
314 return TNY_FOLDER_TYPE_OUTBOX;
316 /* Outbox is a special case, using a derived TnyAccount: */
317 TnyAccount* parent_account = tny_folder_get_account (folder);
318 if (parent_account && MODEST_IS_TNY_OUTBOX_ACCOUNT (parent_account)) {
319 g_object_unref (parent_account);
320 return TNY_FOLDER_TYPE_OUTBOX;
323 if (parent_account) {
324 g_object_unref (parent_account);
325 parent_account = NULL;
328 /* we need to use the camel functions, because we want the
329 * _full name_, that is, the full path name of the folder,
330 * to distinguish between 'Outbox' and 'myfunkyfolder/Outbox'
333 const gchar *full_name = tny_camel_folder_get_full_name (TNY_CAMEL_FOLDER (folder));
334 /* printf ("DEBUG: %s: full_name=%s\n", __FUNCTION__, full_name); */
337 return TNY_FOLDER_TYPE_UNKNOWN;
339 return modest_local_folder_info_get_type (full_name);
343 modest_tny_folder_is_outbox_for_account (TnyFolder *folder, TnyAccount *account)
345 g_return_val_if_fail(folder, FALSE);
346 g_return_val_if_fail(account, FALSE);
348 if (modest_tny_folder_get_local_or_mmc_folder_type (folder) != TNY_FOLDER_TYPE_OUTBOX)
355 modest_tny_folder_get_header_unique_id (TnyHeader *header)
361 g_return_val_if_fail (TNY_IS_HEADER (header), NULL);
363 folder = tny_header_get_folder (header);
367 url = tny_folder_get_url_string (folder);
368 uid = tny_header_dup_uid (header);
370 retval = g_strjoin ("/", url, uid, NULL);
374 g_object_unref (folder);
380 modest_tny_folder_get_account (TnyFolder *folder)
382 TnyAccount *account = NULL;
384 g_return_val_if_fail (TNY_IS_FOLDER(folder), NULL);
386 if (TNY_IS_MERGE_FOLDER (folder)) {
387 /* TnyMergeFolder does not support get_account(),
388 * because it could be merging folders from multiple accounts.
389 * So we assume that this is the local folders account: */
391 account = modest_tny_account_store_get_local_folders_account (modest_runtime_get_account_store());
393 account = tny_folder_get_account (folder);
400 * It's probably better to use a query to get the folders that match
401 * new_name but currently tinymail only provides a match by name using
402 * regular expressions and we want an exact matching. We're not using
403 * a regular expression for the exact name because we'd need first to
404 * escape @new_name and it's not easy sometimes.
406 * The code that uses the query is available in revision 3152.
409 modest_tny_folder_has_subfolder_with_name (TnyFolderStore *parent,
410 const gchar *new_name,
413 TnyList *subfolders = NULL;
414 TnyIterator *iter = NULL;
415 TnyFolder *folder = NULL;
417 gboolean has_name = FALSE;
419 g_return_val_if_fail (TNY_IS_FOLDER_STORE (parent), FALSE);
420 g_return_val_if_fail (new_name, FALSE);
422 /* Get direct subfolders */
423 subfolders = tny_simple_list_new ();
424 tny_folder_store_get_folders (parent, subfolders, NULL, FALSE, &err);
427 iter = tny_list_create_iterator (subfolders);
428 while (!tny_iterator_is_done (iter) && !has_name) {
432 folder = (TnyFolder*)tny_iterator_get_current (iter);
433 if (!folder || ! TNY_IS_FOLDER(folder)) {
434 g_warning ("%s: invalid folder", __FUNCTION__);
435 tny_iterator_next (iter);
439 name = tny_folder_get_name (folder);
441 g_warning ("%s: folder name == NULL", __FUNCTION__);
442 g_object_unref (folder);
443 tny_iterator_next (iter);
447 /* is it simply the same folder name? */
448 if (strcmp (name, new_name) == 0)
450 /* or is it the same when ignoring case (non-strict mode)? */
451 else if (non_strict && modest_text_utils_utf8_strcmp (name, new_name, TRUE) == 0)
453 /* or is the name equal to the display name of some folder, in the current locale? */
454 else if (non_strict) {
455 TnyFolderType type = modest_tny_folder_guess_folder_type (folder);
456 if (type != TNY_FOLDER_TYPE_INVALID && type != TNY_FOLDER_TYPE_NORMAL)
457 has_name = !(modest_text_utils_utf8_strcmp (modest_local_folder_info_get_type_display_name (type),
464 g_object_unref (folder);
465 tny_iterator_next(iter);
470 g_object_unref (iter);
471 if (subfolders != NULL)
472 g_object_unref (subfolders);
478 modest_tny_folder_is_ancestor (TnyFolder *folder,
479 TnyFolderStore *ancestor)
481 TnyFolderStore *tmp = NULL;
482 gboolean found = FALSE;
484 tmp = TNY_FOLDER_STORE (folder);
485 while (!found && tmp && !TNY_IS_ACCOUNT (tmp)) {
486 TnyFolderStore *folder_store;
488 folder_store = tny_folder_get_folder_store (TNY_FOLDER (tmp));
489 if (ancestor == folder_store)
493 g_object_unref (folder_store);
499 modest_tny_folder_get_display_name (TnyFolder *folder)
501 TnyFolderType type = TNY_FOLDER_TYPE_UNKNOWN;
504 g_return_val_if_fail (TNY_IS_FOLDER (folder), NULL);
506 fname = g_strdup (tny_folder_get_name (folder));
507 type = tny_folder_get_folder_type (folder);
509 if (modest_tny_folder_is_local_folder (TNY_FOLDER (folder)) ||
510 modest_tny_folder_is_memory_card_folder (TNY_FOLDER (folder))) {
511 type = modest_tny_folder_get_local_or_mmc_folder_type (TNY_FOLDER (folder));
512 if (type != TNY_FOLDER_TYPE_UNKNOWN) {
514 fname = g_strdup (modest_local_folder_info_get_type_display_name (type));
517 /* Sometimes an special folder is reported by the server as
518 NORMAL, like some versions of Dovecot */
519 if (type == TNY_FOLDER_TYPE_NORMAL ||
520 type == TNY_FOLDER_TYPE_UNKNOWN) {
521 type = modest_tny_folder_guess_folder_type (TNY_FOLDER (folder));
525 if (type == TNY_FOLDER_TYPE_INBOX) {
527 fname = g_strdup (_("mcen_me_folder_inbox"));