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-outbox-account.h>
35 #include <tny-simple-list.h>
36 #include <tny-camel-folder.h>
37 #include <tny-merge-folder.h>
38 #include <modest-protocol-info.h>
39 #include <modest-runtime.h>
40 #include <modest-tny-account-store.h>
43 modest_tny_folder_guess_folder_type_from_name (const gchar* name)
47 gchar *dc_outbox = NULL;
48 gchar *dc_sent = NULL;
49 gchar *dc_drafts = NULL;
51 g_return_val_if_fail (name, TNY_FOLDER_TYPE_UNKNOWN);
53 type = TNY_FOLDER_TYPE_UNKNOWN;
54 folder = g_utf8_strdown (name, strlen(name));
55 dc_outbox = g_utf8_strdown (_("mcen_me_folder_outbox"), -1);
56 dc_sent = g_utf8_strdown (_("mcen_me_folder_sent"), -1);
57 dc_drafts = g_utf8_strdown (_("mcen_me_folder_drafts"), -1);
59 // if (strcmp (folder, "inbox") == 0 ||
60 // strcmp (folder, _("inbox")) == 0 ||
61 // strcmp (folder, _("mcen_me_folder_inbox")) == 0)
62 // type = TNY_FOLDER_TYPE_INBOX;
63 if (strcmp (folder, dc_outbox) == 0)
64 type = TNY_FOLDER_TYPE_OUTBOX;
65 // else if (g_str_has_prefix(folder, "junk") ||
66 // g_str_has_prefix(folder, _("junk")))
67 // type = TNY_FOLDER_TYPE_JUNK;
68 // else if (g_str_has_prefix(folder, "trash") ||
69 // g_str_has_prefix(folder, _("trash")))
70 // type = TNY_FOLDER_TYPE_TRASH;
71 else if (strcmp (folder, dc_sent) == 0)
72 type = TNY_FOLDER_TYPE_SENT;
73 else if (strcmp (folder, dc_drafts) == 0)
74 type = TNY_FOLDER_TYPE_DRAFTS;
75 // else if (g_str_has_prefix(folder, "notes") ||
76 // g_str_has_prefix(folder, _("notes")))
77 // type = TNY_FOLDER_TYPE_NOTES;
78 // else if (g_str_has_prefix(folder, "contacts") ||
79 // g_str_has_prefix(folder, _("contacts")))
80 // type = TNY_FOLDER_TYPE_CONTACTS;
81 // else if (g_str_has_prefix(folder, "calendar") ||
82 // g_str_has_prefix(folder, _("calendar")))
83 // type = TNY_FOLDER_TYPE_CALENDAR;
95 modest_tny_folder_guess_folder_type (const TnyFolder *folder)
99 g_return_val_if_fail (TNY_IS_FOLDER(folder), TNY_FOLDER_TYPE_UNKNOWN);
101 if (modest_tny_folder_is_local_folder ((TnyFolder*)folder))
102 type = modest_tny_folder_get_local_or_mmc_folder_type ((TnyFolder*)folder);
104 type = tny_folder_get_folder_type (TNY_FOLDER (folder));
106 if (type == TNY_FOLDER_TYPE_UNKNOWN) {
107 const gchar *folder_name;
108 folder_name = tny_folder_get_name (TNY_FOLDER (folder));
109 type = modest_tny_folder_guess_folder_type_from_name (folder_name);
116 /* FIXME: encode all folder rules here */
118 modest_tny_folder_get_rules (TnyFolder *folder)
120 ModestTnyFolderRules rules = 0;
123 g_return_val_if_fail (TNY_IS_FOLDER(folder), -1);
125 if (modest_tny_folder_is_local_folder (folder) ||
126 modest_tny_folder_is_memory_card_folder (folder)) {
128 type = modest_tny_folder_get_local_or_mmc_folder_type (folder);
131 case TNY_FOLDER_TYPE_OUTBOX:
132 case TNY_FOLDER_TYPE_SENT:
133 case TNY_FOLDER_TYPE_DRAFTS:
134 rules |= MODEST_FOLDER_RULES_FOLDER_NON_WRITEABLE;
135 case TNY_FOLDER_TYPE_INBOX:
136 case TNY_FOLDER_TYPE_JUNK:
137 case TNY_FOLDER_TYPE_TRASH:
138 case TNY_FOLDER_TYPE_ROOT:
139 case TNY_FOLDER_TYPE_NOTES:
140 case TNY_FOLDER_TYPE_CONTACTS:
141 case TNY_FOLDER_TYPE_CALENDAR:
142 case TNY_FOLDER_TYPE_ARCHIVE:
143 case TNY_FOLDER_TYPE_MERGE:
144 case TNY_FOLDER_TYPE_NUM:
145 rules |= MODEST_FOLDER_RULES_FOLDER_NON_DELETABLE;
146 rules |= MODEST_FOLDER_RULES_FOLDER_NON_MOVEABLE;
147 rules |= MODEST_FOLDER_RULES_FOLDER_NON_RENAMEABLE;
152 ModestTransportStoreProtocol proto;
153 TnyFolderType folder_type;
156 account = modest_tny_folder_get_account ((TnyFolder*)folder);
158 return -1; /* no account: nothing is allowed */
160 proto = modest_protocol_info_get_transport_store_protocol (tny_account_get_proto (account));
162 if (proto == MODEST_PROTOCOL_STORE_IMAP) {
167 MODEST_FOLDER_RULES_FOLDER_NON_WRITEABLE |
168 MODEST_FOLDER_RULES_FOLDER_NON_DELETABLE |
169 MODEST_FOLDER_RULES_FOLDER_NON_MOVEABLE |
170 MODEST_FOLDER_RULES_FOLDER_NON_RENAMEABLE;
173 g_object_unref (G_OBJECT(account));
175 /* Neither INBOX nor ROOT, nor ARCHIVE folders should me moveable */
176 folder_type = modest_tny_folder_guess_folder_type (folder);
177 if ((folder_type == TNY_FOLDER_TYPE_INBOX) ||
178 (folder_type == TNY_FOLDER_TYPE_ROOT) ||
179 (folder_type == TNY_FOLDER_TYPE_ARCHIVE)) {
180 rules |= MODEST_FOLDER_RULES_FOLDER_NON_DELETABLE;
181 rules |= MODEST_FOLDER_RULES_FOLDER_NON_MOVEABLE;
182 rules |= MODEST_FOLDER_RULES_FOLDER_NON_RENAMEABLE;
191 modest_tny_folder_is_local_folder (TnyFolder *folder)
193 g_return_val_if_fail (TNY_IS_FOLDER (folder), FALSE);
195 /* The merge folder is a special case,
196 * used to merge the per-account local outbox folders.
197 * and can have no get_account() implementation.
198 * We should do something more sophisticated if we
199 * ever use TnyMergeFolder for anything else.
201 if (TNY_IS_MERGE_FOLDER (folder)) {
205 TnyAccount* account = tny_folder_get_account ((TnyFolder*)folder);
207 g_warning ("folder without account");
211 /* Outbox is a special case, using a derived TnyAccount: */
212 if (MODEST_IS_TNY_OUTBOX_ACCOUNT (account)) {
213 //g_warning ("BUG: should not be reached");
214 /* should be handled with the MERGE_FOLDER above*/
215 g_object_unref (G_OBJECT(account));
219 const gchar* account_id = tny_account_get_id (account);
221 g_warning ("BUG: account without account id");
222 g_object_unref (G_OBJECT(account));
226 g_object_unref (G_OBJECT(account));
227 return (strcmp (account_id, MODEST_LOCAL_FOLDERS_ACCOUNT_ID) == 0);
231 modest_tny_folder_is_memory_card_folder (TnyFolder *folder)
233 g_return_val_if_fail (folder, FALSE);
235 /* The merge folder is a special case,
236 * used to merge the per-account local outbox folders.
237 * and can have no get_account() implementation.
239 if (TNY_IS_MERGE_FOLDER (folder))
242 TnyAccount* account = tny_folder_get_account ((TnyFolder*)folder);
246 const gchar* account_id = tny_account_get_id (account);
250 g_object_unref (G_OBJECT(account));
252 return (strcmp (account_id, MODEST_MMC_ACCOUNT_ID) == 0);
256 modest_tny_folder_is_remote_folder (TnyFolder *folder)
258 gboolean is_local = TRUE;
260 g_return_val_if_fail (folder, FALSE);
262 is_local = ((modest_tny_folder_is_local_folder(folder)) ||
263 (modest_tny_folder_is_memory_card_folder(folder)));
270 modest_tny_folder_get_local_or_mmc_folder_type (TnyFolder *folder)
272 g_return_val_if_fail (folder, TNY_FOLDER_TYPE_UNKNOWN);
273 g_return_val_if_fail (modest_tny_folder_is_local_folder(folder)||
274 modest_tny_folder_is_memory_card_folder(folder),
275 TNY_FOLDER_TYPE_UNKNOWN);
277 /* The merge folder is a special case,
278 * used to merge the per-account local outbox folders.
279 * and can have no get_account() implementation.
280 * We should do something more sophisticated if we
281 * ever use TnyMergeFolder for anything else.
283 if (TNY_IS_MERGE_FOLDER (folder))
284 return TNY_FOLDER_TYPE_OUTBOX;
286 /* Outbox is a special case, using a derived TnyAccount: */
287 TnyAccount* parent_account = tny_folder_get_account (folder);
288 if (parent_account && MODEST_IS_TNY_OUTBOX_ACCOUNT (parent_account)) {
289 g_object_unref (parent_account);
290 return TNY_FOLDER_TYPE_OUTBOX;
293 if (parent_account) {
294 g_object_unref (parent_account);
295 parent_account = NULL;
298 /* we need to use the camel functions, because we want the
299 * _full name_, that is, the full path name of the folder,
300 * to distinguish between 'Outbox' and 'myfunkyfolder/Outbox'
303 const gchar *full_name = tny_camel_folder_get_full_name (TNY_CAMEL_FOLDER (folder));
304 /* printf ("DEBUG: %s: full_name=%s\n", __FUNCTION__, full_name); */
307 return TNY_FOLDER_TYPE_UNKNOWN;
309 return modest_local_folder_info_get_type (full_name);
313 modest_tny_folder_is_outbox_for_account (TnyFolder *folder, TnyAccount *account)
315 g_return_val_if_fail(folder, FALSE);
316 g_return_val_if_fail(account, FALSE);
318 if (modest_tny_folder_get_local_or_mmc_folder_type (folder) != TNY_FOLDER_TYPE_OUTBOX)
325 modest_tny_folder_get_header_unique_id (TnyHeader *header)
331 g_return_val_if_fail (TNY_IS_HEADER (header), NULL);
333 folder = tny_header_get_folder (header);
337 url = tny_folder_get_url_string (folder);
338 uid = tny_header_get_uid (header);
340 retval = g_strjoin ("/", url, uid, NULL);
343 g_object_unref (folder);
349 modest_tny_folder_get_account (TnyFolder *folder)
351 TnyAccount *account = NULL;
353 if (TNY_IS_MERGE_FOLDER (folder)) {
354 /* TnyMergeFolder does not support get_account(),
355 * because it could be merging folders from multiple accounts.
356 * So we assume that this is the local folders account: */
358 account = modest_tny_account_store_get_local_folders_account (modest_runtime_get_account_store());
360 account = tny_folder_get_account (folder);
367 * It's probably better to use a query to get the folders that match
368 * new_name but currently tinymail only provides a match by name using
369 * regular expressions and we want an exact matching. We're not using
370 * a regular expression for the exact name because we'd need first to
371 * escape @new_name and it's not easy sometimes.
373 * The code that uses the query is available in revision 3152.
376 modest_tny_folder_has_subfolder_with_name (TnyFolderStore *parent,
377 const gchar *new_name)
379 TnyList *subfolders = NULL;
380 TnyIterator *iter = NULL;
381 TnyFolder *folder = NULL;
383 gboolean same_subfolder = FALSE;
385 g_return_val_if_fail (TNY_IS_FOLDER_STORE (parent), FALSE);
387 /* Get direct subfolders */
388 subfolders = tny_simple_list_new ();
389 tny_folder_store_get_folders (parent, subfolders, NULL, &err);
392 iter = tny_list_create_iterator (subfolders);
393 while (!tny_iterator_is_done (iter) && !same_subfolder) {
394 const gchar *name = NULL;
396 folder = TNY_FOLDER(tny_iterator_get_current (iter));
397 name = tny_folder_get_name (folder);
399 same_subfolder = !strcmp(name, new_name);
401 g_object_unref (folder);
402 tny_iterator_next(iter);
407 g_object_unref (iter);
408 if (subfolders != NULL)
409 g_object_unref (subfolders);
411 return same_subfolder;
415 modest_tny_folder_is_ancestor (TnyFolder *folder,
416 TnyFolderStore *ancestor)
418 TnyFolderStore *tmp = NULL;
419 gboolean found = FALSE;
421 tmp = TNY_FOLDER_STORE (folder);
422 while (!found && tmp && !TNY_IS_ACCOUNT (tmp)) {
423 TnyFolderStore *folder_store;
425 folder_store = tny_folder_get_folder_store (TNY_FOLDER (tmp));
426 if (ancestor == folder_store)
430 g_object_unref (folder_store);