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;
89 g_object_unref (parent);
93 if (type == TNY_FOLDER_TYPE_UNKNOWN) {
94 const gchar *folder_name =
95 tny_camel_folder_get_full_name (TNY_CAMEL_FOLDER (folder));
96 type = modest_tny_folder_guess_folder_type_from_name (folder_name);
99 if (type == TNY_FOLDER_TYPE_INVALID)
100 g_warning ("%s: BUG: TNY_FOLDER_TYPE_INVALID", __FUNCTION__);
107 modest_tny_folder_get_help_id (TnyFolder *folder)
110 const gchar* help_id = NULL;
112 g_return_val_if_fail (folder, NULL);
113 g_return_val_if_fail (TNY_IS_FOLDER(folder), NULL);
115 type = modest_tny_folder_guess_folder_type (TNY_FOLDER (folder));
118 case TNY_FOLDER_TYPE_NORMAL: help_id = "applications_email_managefolders"; break;
119 case TNY_FOLDER_TYPE_INBOX: help_id = "applications_email_inbox";break;
120 case TNY_FOLDER_TYPE_OUTBOX: help_id = "applications_email_outbox";break;
121 case TNY_FOLDER_TYPE_SENT: help_id = "applications_email_sent"; break;
122 case TNY_FOLDER_TYPE_DRAFTS: help_id = "applications_email_drafts";break;
123 case TNY_FOLDER_TYPE_ARCHIVE: help_id = "applications_email_managefolders";break;
125 case TNY_FOLDER_TYPE_INVALID: g_warning ("%s: BUG: TNY_FOLDER_TYPE_INVALID", __FUNCTION__);break;
126 default: g_warning ("%s: BUG: unexpected folder type (%d)", __FUNCTION__, type);
134 /* FIXME: encode all folder rules here */
136 modest_tny_folder_get_rules (TnyFolder *folder)
138 ModestTnyFolderRules rules = 0;
141 g_return_val_if_fail (TNY_IS_FOLDER(folder), -1);
143 if (modest_tny_folder_is_local_folder (folder) ||
144 modest_tny_folder_is_memory_card_folder (folder)) {
146 type = modest_tny_folder_get_local_or_mmc_folder_type (folder);
147 g_return_val_if_fail (type != TNY_FOLDER_TYPE_INVALID, -1);
150 case TNY_FOLDER_TYPE_OUTBOX:
151 case TNY_FOLDER_TYPE_SENT:
152 case TNY_FOLDER_TYPE_DRAFTS:
153 rules |= MODEST_FOLDER_RULES_FOLDER_NON_WRITEABLE;
154 case TNY_FOLDER_TYPE_INBOX:
155 case TNY_FOLDER_TYPE_JUNK:
156 case TNY_FOLDER_TYPE_TRASH:
157 case TNY_FOLDER_TYPE_ROOT:
158 case TNY_FOLDER_TYPE_NOTES:
159 case TNY_FOLDER_TYPE_CONTACTS:
160 case TNY_FOLDER_TYPE_CALENDAR:
161 case TNY_FOLDER_TYPE_ARCHIVE:
162 case TNY_FOLDER_TYPE_MERGE:
163 case TNY_FOLDER_TYPE_NUM:
164 rules |= MODEST_FOLDER_RULES_FOLDER_NON_DELETABLE;
165 rules |= MODEST_FOLDER_RULES_FOLDER_NON_MOVEABLE;
166 rules |= MODEST_FOLDER_RULES_FOLDER_NON_RENAMEABLE;
171 ModestProtocolRegistry *protocol_registry;
172 ModestProtocolType protocol_type;
173 TnyFolderType folder_type;
176 protocol_registry = modest_runtime_get_protocol_registry ();
178 account = modest_tny_folder_get_account ((TnyFolder*)folder);
180 return -1; /* no account: nothing is allowed */
182 protocol_type = modest_tny_account_get_protocol_type (account);
184 if (modest_protocol_registry_protocol_type_has_tag (protocol_registry, protocol_type, MODEST_PROTOCOL_REGISTRY_STORE_HAS_FOLDERS)) {
189 MODEST_FOLDER_RULES_FOLDER_NON_WRITEABLE |
190 MODEST_FOLDER_RULES_FOLDER_NON_DELETABLE |
191 MODEST_FOLDER_RULES_FOLDER_NON_MOVEABLE |
192 MODEST_FOLDER_RULES_FOLDER_NON_RENAMEABLE;
195 g_object_unref (G_OBJECT(account));
197 /* Neither INBOX nor ROOT, nor ARCHIVE folders should me moveable */
198 folder_type = modest_tny_folder_guess_folder_type (folder);
199 g_return_val_if_fail (folder_type != TNY_FOLDER_TYPE_INVALID, -1);
201 if ((folder_type == TNY_FOLDER_TYPE_INBOX) ||
202 (folder_type == TNY_FOLDER_TYPE_ROOT) ||
203 (folder_type == TNY_FOLDER_TYPE_ARCHIVE)) {
204 rules |= MODEST_FOLDER_RULES_FOLDER_NON_DELETABLE;
205 rules |= MODEST_FOLDER_RULES_FOLDER_NON_MOVEABLE;
206 rules |= MODEST_FOLDER_RULES_FOLDER_NON_RENAMEABLE;
215 modest_tny_folder_is_local_folder (TnyFolder *folder)
217 g_return_val_if_fail (TNY_IS_FOLDER (folder), FALSE);
219 /* The merge folder is a special case,
220 * used to merge the per-account local outbox folders.
221 * and can have no get_account() implementation.
222 * We should do something more sophisticated if we
223 * ever use TnyMergeFolder for anything else.
225 if (TNY_IS_MERGE_FOLDER (folder)) {
229 TnyAccount* account = tny_folder_get_account ((TnyFolder*)folder);
231 g_warning ("folder without account");
235 /* Outbox is a special case, using a derived TnyAccount: */
236 if (MODEST_IS_TNY_OUTBOX_ACCOUNT (account)) {
237 //g_warning ("BUG: should not be reached");
238 /* should be handled with the MERGE_FOLDER above*/
239 g_object_unref (G_OBJECT(account));
243 const gchar* account_id = tny_account_get_id (account);
245 g_warning ("BUG: account without account id");
246 g_object_unref (G_OBJECT(account));
250 g_object_unref (G_OBJECT(account));
251 return (strcmp (account_id, MODEST_LOCAL_FOLDERS_ACCOUNT_ID) == 0);
255 modest_tny_folder_is_memory_card_folder (TnyFolder *folder)
257 g_return_val_if_fail (folder, FALSE);
259 /* The merge folder is a special case,
260 * used to merge the per-account local outbox folders.
261 * and can have no get_account() implementation.
263 if (TNY_IS_MERGE_FOLDER (folder))
266 TnyAccount* account = tny_folder_get_account ((TnyFolder*)folder);
270 const gchar* account_id = tny_account_get_id (account);
272 g_object_unref (account);
276 g_object_unref (account);
278 return (strcmp (account_id, MODEST_MMC_ACCOUNT_ID) == 0);
282 modest_tny_folder_is_remote_folder (TnyFolder *folder)
284 gboolean is_local = TRUE;
286 g_return_val_if_fail (TNY_IS_FOLDER(folder), FALSE);
288 is_local = ((modest_tny_folder_is_local_folder(folder)) ||
289 (modest_tny_folder_is_memory_card_folder(folder)));
297 modest_tny_folder_get_local_or_mmc_folder_type (TnyFolder *folder)
299 g_return_val_if_fail (folder, TNY_FOLDER_TYPE_INVALID);
300 g_return_val_if_fail (modest_tny_folder_is_local_folder(folder)||
301 modest_tny_folder_is_memory_card_folder(folder),
302 TNY_FOLDER_TYPE_INVALID);
304 /* The merge folder is a special case,
305 * used to merge the per-account local outbox folders.
306 * and can have no get_account() implementation.
307 * We should do something more sophisticated if we
308 * ever use TnyMergeFolder for anything else.
310 if (TNY_IS_MERGE_FOLDER (folder))
311 return TNY_FOLDER_TYPE_OUTBOX;
313 /* Outbox is a special case, using a derived TnyAccount: */
314 TnyAccount* parent_account = tny_folder_get_account (folder);
315 if (parent_account && MODEST_IS_TNY_OUTBOX_ACCOUNT (parent_account)) {
316 g_object_unref (parent_account);
317 return TNY_FOLDER_TYPE_OUTBOX;
320 if (parent_account) {
321 g_object_unref (parent_account);
322 parent_account = NULL;
325 /* we need to use the camel functions, because we want the
326 * _full name_, that is, the full path name of the folder,
327 * to distinguish between 'Outbox' and 'myfunkyfolder/Outbox'
330 const gchar *full_name = tny_camel_folder_get_full_name (TNY_CAMEL_FOLDER (folder));
331 /* printf ("DEBUG: %s: full_name=%s\n", __FUNCTION__, full_name); */
334 return TNY_FOLDER_TYPE_UNKNOWN;
336 return modest_local_folder_info_get_type (full_name);
340 modest_tny_folder_is_outbox_for_account (TnyFolder *folder, TnyAccount *account)
342 g_return_val_if_fail(folder, FALSE);
343 g_return_val_if_fail(account, FALSE);
345 if (modest_tny_folder_get_local_or_mmc_folder_type (folder) != TNY_FOLDER_TYPE_OUTBOX)
352 modest_tny_folder_get_header_unique_id (TnyHeader *header)
358 g_return_val_if_fail (TNY_IS_HEADER (header), NULL);
360 folder = tny_header_get_folder (header);
364 url = tny_folder_get_url_string (folder);
365 uid = tny_header_dup_uid (header);
367 retval = g_strjoin ("/", url, uid, NULL);
371 g_object_unref (folder);
377 modest_tny_folder_get_account (TnyFolder *folder)
379 TnyAccount *account = NULL;
381 g_return_val_if_fail (TNY_IS_FOLDER(folder), NULL);
383 if (TNY_IS_MERGE_FOLDER (folder)) {
384 /* TnyMergeFolder does not support get_account(),
385 * because it could be merging folders from multiple accounts.
386 * So we assume that this is the local folders account: */
388 account = modest_tny_account_store_get_local_folders_account (modest_runtime_get_account_store());
390 account = tny_folder_get_account (folder);
397 * It's probably better to use a query to get the folders that match
398 * new_name but currently tinymail only provides a match by name using
399 * regular expressions and we want an exact matching. We're not using
400 * a regular expression for the exact name because we'd need first to
401 * escape @new_name and it's not easy sometimes.
403 * The code that uses the query is available in revision 3152.
406 modest_tny_folder_has_subfolder_with_name (TnyFolderStore *parent,
407 const gchar *new_name,
410 TnyList *subfolders = NULL;
411 TnyIterator *iter = NULL;
412 TnyFolder *folder = NULL;
414 gboolean has_name = FALSE;
416 g_return_val_if_fail (TNY_IS_FOLDER_STORE (parent), FALSE);
417 g_return_val_if_fail (new_name, FALSE);
419 /* Get direct subfolders */
420 subfolders = tny_simple_list_new ();
421 tny_folder_store_get_folders (parent, subfolders, NULL, FALSE, &err);
424 iter = tny_list_create_iterator (subfolders);
425 while (!tny_iterator_is_done (iter) && !has_name) {
429 folder = (TnyFolder*)tny_iterator_get_current (iter);
430 if (!folder || ! TNY_IS_FOLDER(folder)) {
431 g_warning ("%s: invalid folder", __FUNCTION__);
435 name = tny_folder_get_name (folder);
437 g_warning ("%s: folder name == NULL", __FUNCTION__);
438 g_object_unref (folder);
442 /* is it simply the same folder name? */
443 if (strcmp (name, new_name) == 0)
445 /* or is it the same when ignoring case (non-strict mode)? */
446 else if (non_strict && modest_text_utils_utf8_strcmp (name, new_name, TRUE) == 0)
448 /* or is the name equal to the display name of some folder, in the current locale? */
449 else if (non_strict) {
450 TnyFolderType type = modest_tny_folder_guess_folder_type (folder);
451 if (type != TNY_FOLDER_TYPE_INVALID && type != TNY_FOLDER_TYPE_NORMAL)
452 has_name = !(modest_text_utils_utf8_strcmp (modest_local_folder_info_get_type_display_name (type),
459 g_object_unref (folder);
460 tny_iterator_next(iter);
465 g_object_unref (iter);
466 if (subfolders != NULL)
467 g_object_unref (subfolders);
473 modest_tny_folder_is_ancestor (TnyFolder *folder,
474 TnyFolderStore *ancestor)
476 TnyFolderStore *tmp = NULL;
477 gboolean found = FALSE;
479 tmp = TNY_FOLDER_STORE (folder);
480 while (!found && tmp && !TNY_IS_ACCOUNT (tmp)) {
481 TnyFolderStore *folder_store;
483 folder_store = tny_folder_get_folder_store (TNY_FOLDER (tmp));
484 if (ancestor == folder_store)
488 g_object_unref (folder_store);