2007-07-31 Philip Van Hoof <pvanhoof@gnome.org>
[modest] / src / modest-tny-folder.c
index 10e77e5..fd35b01 100644 (file)
 #include <glib/gi18n.h>
 #include <string.h>
 #include <modest-tny-folder.h>
+#include <modest-tny-outbox-account.h>
 #include <tny-camel-folder.h>
+#include <tny-merge-folder.h>
 #include <camel/camel-folder.h>
 #include <modest-protocol-info.h>
+#include <modest-runtime.h>
+#include <modest-tny-account-store.h>
 
 TnyFolderType
 modest_tny_folder_guess_folder_type_from_name (const gchar* name)
@@ -46,37 +50,31 @@ modest_tny_folder_guess_folder_type_from_name (const gchar* name)
        type = TNY_FOLDER_TYPE_UNKNOWN;
        folder = g_utf8_strdown (name, strlen(name));
 
-       if (strcmp (folder, "inbox") == 0 ||
-           strcmp (folder, _("inbox")) == 0 ||
-           strcmp (folder, _("mcen_me_folder_inbox")) == 0)
-               type = TNY_FOLDER_TYPE_INBOX;
-       else if (strcmp (folder, "outbox") == 0 ||
-                strcmp (folder, _("outbox")) == 0 ||
-                strcmp (folder, _("mcen_me_folder_outbox")) == 0)
+//     if (strcmp (folder, "inbox") == 0 ||
+//         strcmp (folder, _("inbox")) == 0 ||
+//         strcmp (folder, _("mcen_me_folder_inbox")) == 0)
+//             type = TNY_FOLDER_TYPE_INBOX;
+       if (strcmp (folder, _("mcen_me_folder_outbox")) == 0)
                type = TNY_FOLDER_TYPE_OUTBOX;
-       else if (g_str_has_prefix(folder, "junk") ||
-                g_str_has_prefix(folder, _("junk")))
-               type = TNY_FOLDER_TYPE_JUNK;
-       else if (g_str_has_prefix(folder, "trash") ||
-                g_str_has_prefix(folder, _("trash")))
-               type = TNY_FOLDER_TYPE_TRASH;
-       else if (g_str_has_prefix(folder, "sent") ||
-                g_str_has_prefix(folder, _("sent")) ||
-                strcmp (folder, _("mcen_me_folder_sent")) == 0)
+//     else if (g_str_has_prefix(folder, "junk") ||
+//              g_str_has_prefix(folder, _("junk")))
+//             type = TNY_FOLDER_TYPE_JUNK;
+//     else if (g_str_has_prefix(folder, "trash") ||
+//              g_str_has_prefix(folder, _("trash")))
+//             type = TNY_FOLDER_TYPE_TRASH;
+       else if (strcmp (folder, _("mcen_me_folder_sent")) == 0)
                type = TNY_FOLDER_TYPE_SENT;
-       else if (g_str_has_prefix(folder, "draft") ||
-                g_str_has_prefix(folder, _("draft")) ||
-                strcmp (folder, _("mcen_me_folder_drafts")) == 0)
+       else if (strcmp (folder, _("mcen_me_folder_drafts")) == 0)
                type = TNY_FOLDER_TYPE_DRAFTS;
-       else if (g_str_has_prefix(folder, "notes") ||
-                g_str_has_prefix(folder, _("notes")))
-               type = TNY_FOLDER_TYPE_NOTES;
-       else if (g_str_has_prefix(folder, "contacts") ||
-                g_str_has_prefix(folder, _("contacts")))
-               type = TNY_FOLDER_TYPE_CONTACTS;
-       else if (g_str_has_prefix(folder, "calendar") ||
-                g_str_has_prefix(folder, _("calendar")))
-               type = TNY_FOLDER_TYPE_CALENDAR;
+//     else if (g_str_has_prefix(folder, "notes") ||
+//              g_str_has_prefix(folder, _("notes")))
+//             type = TNY_FOLDER_TYPE_NOTES;
+//     else if (g_str_has_prefix(folder, "contacts") ||
+//              g_str_has_prefix(folder, _("contacts")))
+//             type = TNY_FOLDER_TYPE_CONTACTS;
+//     else if (g_str_has_prefix(folder, "calendar") ||
+//              g_str_has_prefix(folder, _("calendar")))
+//             type = TNY_FOLDER_TYPE_CALENDAR;
        
        g_free (folder);
        return type;
@@ -88,14 +86,16 @@ TnyFolderType
 modest_tny_folder_guess_folder_type (const TnyFolder *folder)
 {
        TnyFolderType type;
+       
+       g_return_val_if_fail (TNY_IS_FOLDER(folder), TNY_FOLDER_TYPE_UNKNOWN);
 
-       g_return_val_if_fail (folder, TNY_FOLDER_TYPE_UNKNOWN);
-
-       type = tny_folder_get_folder_type (TNY_FOLDER (folder));
+       if (modest_tny_folder_is_local_folder ((TnyFolder*)folder))
+               type = modest_tny_folder_get_local_or_mmc_folder_type ((TnyFolder*)folder);
+       else
+               type = tny_folder_get_folder_type (TNY_FOLDER (folder));
        
        if (type == TNY_FOLDER_TYPE_UNKNOWN) {
                const gchar *folder_name;
-
                folder_name = tny_folder_get_name (TNY_FOLDER (folder));
                type =  modest_tny_folder_guess_folder_type_from_name (folder_name);
        }
@@ -106,34 +106,45 @@ modest_tny_folder_guess_folder_type (const TnyFolder *folder)
 
 /* FIXME: encode all folder rules here */
 ModestTnyFolderRules
-modest_tny_folder_get_rules   (const TnyFolder *folder)
+modest_tny_folder_get_rules   (TnyFolder *folder)
 {
        ModestTnyFolderRules rules = 0;
        TnyFolderType type;
 
        g_return_val_if_fail (TNY_IS_FOLDER(folder), -1);
 
-       if (modest_tny_folder_is_local_folder (folder)) {
+       if (modest_tny_folder_is_local_folder (folder) ||
+           modest_tny_folder_is_memory_card_folder (folder)) {
        
-               type = modest_tny_folder_get_local_folder_type (folder);
+               type = modest_tny_folder_get_local_or_mmc_folder_type (folder);
                
                switch (type) {
-               case TNY_FOLDER_TYPE_DRAFTS:
                case TNY_FOLDER_TYPE_OUTBOX:
                case TNY_FOLDER_TYPE_SENT:
+               case TNY_FOLDER_TYPE_DRAFTS:
                        rules |= MODEST_FOLDER_RULES_FOLDER_NON_WRITEABLE;
                case TNY_FOLDER_TYPE_INBOX:
                case TNY_FOLDER_TYPE_JUNK:
                case TNY_FOLDER_TYPE_TRASH:
-               default:
+               case TNY_FOLDER_TYPE_ROOT:
+               case TNY_FOLDER_TYPE_NOTES:
+               case TNY_FOLDER_TYPE_CONTACTS:
+               case TNY_FOLDER_TYPE_CALENDAR:
+               case TNY_FOLDER_TYPE_ARCHIVE:
+               case TNY_FOLDER_TYPE_MERGE:
+               case TNY_FOLDER_TYPE_NUM:
                        rules |= MODEST_FOLDER_RULES_FOLDER_NON_DELETABLE;
                        rules |= MODEST_FOLDER_RULES_FOLDER_NON_MOVEABLE;
                        rules |= MODEST_FOLDER_RULES_FOLDER_NON_RENAMEABLE;
+               default:
+                       break;
                }
        } else {
                ModestTransportStoreProtocol proto;
-               TnyAccount *account =
-                       tny_folder_get_account ((TnyFolder*)folder);
+               TnyFolderType folder_type;
+               TnyAccount *account;
+
+               account = modest_tny_folder_get_account ((TnyFolder*)folder);
                if (!account)
                        return -1; /* no account: nothing is allowed */
                
@@ -151,56 +162,196 @@ modest_tny_folder_get_rules   (const TnyFolder *folder)
 
                }
                g_object_unref (G_OBJECT(account));
+
+               /* Neither INBOX not ROOT folders should me moveable */
+               folder_type = modest_tny_folder_guess_folder_type (folder);
+               if ((folder_type ==  TNY_FOLDER_TYPE_INBOX) ||
+                   (folder_type == TNY_FOLDER_TYPE_ROOT)) {
+                       rules |= MODEST_FOLDER_RULES_FOLDER_NON_DELETABLE;
+                       rules |= MODEST_FOLDER_RULES_FOLDER_NON_MOVEABLE;
+                       rules |= MODEST_FOLDER_RULES_FOLDER_NON_RENAMEABLE;
+               }
        }
        return rules;
 }
 
 
 gboolean
-modest_tny_folder_is_local_folder   (const TnyFolder *folder)
+modest_tny_folder_is_local_folder   (TnyFolder *folder)
 {
-       TnyAccount*  account;
-       const gchar* account_id;
+       g_return_val_if_fail (TNY_IS_FOLDER (folder), FALSE);
+       
+       /* The merge folder is a special case, 
+        * used to merge the per-account local outbox folders. 
+        * and can have no get_account() implementation.
+        * We should do something more sophisticated if we 
+        * ever use TnyMergeFolder for anything else.
+        */
+       if (TNY_IS_MERGE_FOLDER (folder))
+               return TRUE;
+
+       TnyAccount* account = tny_folder_get_account ((TnyFolder*)folder);
+       if (!account)
+               return FALSE;
        
+       /* Outbox is a special case, using a derived TnyAccount: */
+       if (MODEST_IS_TNY_OUTBOX_ACCOUNT (account)) {
+               g_object_unref (G_OBJECT(account));
+               return TRUE;
+       }
+
+       const gchar* account_id = tny_account_get_id (account);
+       if (!account_id) {
+               g_object_unref (G_OBJECT(account));
+               return FALSE;
+       }
+       
+       g_object_unref (G_OBJECT(account));
+       return (strcmp (account_id, MODEST_LOCAL_FOLDERS_ACCOUNT_ID) == 0);
+}
+
+gboolean
+modest_tny_folder_is_memory_card_folder   (TnyFolder *folder)
+{
        g_return_val_if_fail (folder, FALSE);
        
-       account = tny_folder_get_account ((TnyFolder*)folder);
+       /* The merge folder is a special case, 
+        * used to merge the per-account local outbox folders. 
+        * and can have no get_account() implementation.
+        */
+       if (TNY_IS_MERGE_FOLDER (folder))
+               return FALSE;
+
+       TnyAccount* account = tny_folder_get_account ((TnyFolder*)folder);
        if (!account)
                return FALSE;
 
-       account_id = tny_account_get_id (account);
+       const gchar* account_id = tny_account_get_id (account);
        if (!account_id)
                return FALSE;
 
        g_object_unref (G_OBJECT(account));
        
-       return (strcmp (account_id, MODEST_LOCAL_FOLDERS_ACCOUNT_ID) == 0);
+       return (strcmp (account_id, MODEST_MMC_ACCOUNT_ID) == 0);
 }      
 
 
 TnyFolderType
-modest_tny_folder_get_local_folder_type  (const TnyFolder *folder)
+modest_tny_folder_get_local_or_mmc_folder_type  (TnyFolder *folder)
 {
-       CamelFolder *camel_folder;
-       const gchar *full_name;
-       
        g_return_val_if_fail (folder, TNY_FOLDER_TYPE_UNKNOWN);
-       g_return_val_if_fail (modest_tny_folder_is_local_folder(folder),
+       g_return_val_if_fail (modest_tny_folder_is_local_folder(folder)||
+                             modest_tny_folder_is_memory_card_folder(folder),
                              TNY_FOLDER_TYPE_UNKNOWN);
+       
+       /* The merge folder is a special case, 
+        * used to merge the per-account local outbox folders. 
+        * and can have no get_account() implementation.
+        * We should do something more sophisticated if we 
+        * ever use TnyMergeFolder for anything else.
+        */
+       if (TNY_IS_MERGE_FOLDER (folder))
+               return TNY_FOLDER_TYPE_OUTBOX;
+               
+       /* Outbox is a special case, using a derived TnyAccount: */
+       TnyAccount* parent_account = tny_folder_get_account (folder);
+       if (parent_account && MODEST_IS_TNY_OUTBOX_ACCOUNT (parent_account)) {
+               g_object_unref (parent_account);
+               return TNY_FOLDER_TYPE_OUTBOX;  
+       }
 
+       if (parent_account) {
+               g_object_unref (parent_account);
+               parent_account = NULL;
+       }
+       
        /* we need to use the camel functions, because we want the
         * _full name_, that is, the full path name of the folder,
-        * to distinguis between 'Outbox' and 'myfunkyfolder/Outbox'
+        * to distinguish between 'Outbox' and 'myfunkyfolder/Outbox'
         */
-       camel_folder = tny_camel_folder_get_folder (TNY_CAMEL_FOLDER(folder));
+       CamelFolder *camel_folder = tny_camel_folder_get_folder (TNY_CAMEL_FOLDER(folder));
        if (!camel_folder)
                return TNY_FOLDER_TYPE_UNKNOWN;
 
-       full_name = camel_folder_get_full_name (camel_folder);
+       const gchar *full_name = camel_folder_get_full_name (camel_folder);
+       /* printf ("DEBUG: %s: full_name=%s\n", __FUNCTION__, full_name); */
+       camel_object_unref (CAMEL_OBJECT(camel_folder));
+       
+       if (!full_name) 
+               return TNY_FOLDER_TYPE_UNKNOWN;
+       else 
+               return modest_local_folder_info_get_type (full_name);
+}
+
+gboolean
+modest_tny_folder_is_outbox_for_account (TnyFolder *folder, TnyAccount *account)
+{
+       g_return_val_if_fail(folder, FALSE);
+       g_return_val_if_fail(account, FALSE);
+       
+       if (modest_tny_folder_get_local_or_mmc_folder_type (folder) != TNY_FOLDER_TYPE_OUTBOX)
+               return FALSE;
+               
+       return TRUE;
+#if 0  
+       /* we need to use the camel functions, because we want the
+        * _full name_, that is, the full path name of the folder,
+        * to distinguis between 'Outbox' and 'myfunkyfolder/Outbox'
+        */
+       CamelFolder *camel_folder = tny_camel_folder_get_folder (TNY_CAMEL_FOLDER(folder));
+       if (!camel_folder)
+               return FALSE;
+
+       const gchar *full_name = camel_folder_get_full_name (camel_folder);
        camel_object_unref (CAMEL_OBJECT(camel_folder));
        
        if (!full_name) 
                return TNY_FOLDER_TYPE_UNKNOWN;
        else 
                return modest_local_folder_info_get_type (full_name);
+               
+       return FALSE;
+#endif
+}
+
+gchar* 
+modest_tny_folder_get_header_unique_id (TnyHeader *header)
+{
+       TnyFolder *folder;
+       gchar *url, *retval;
+       const gchar *uid;
+
+       g_return_val_if_fail (TNY_IS_HEADER (header), NULL);
+
+       folder = tny_header_get_folder (header);
+       if (!folder)
+               return NULL;
+
+       url = tny_folder_get_url_string (folder);
+       uid = tny_header_get_uid (header);
+
+       retval = g_strjoin ("/", url, uid, NULL);
+
+       g_free (url);
+       g_object_unref (folder);
+
+       return retval;
+}
+
+TnyAccount *
+modest_tny_folder_get_account (TnyFolder *folder)
+{
+       TnyAccount *account = NULL;
+       
+       if (TNY_IS_MERGE_FOLDER (folder)) {
+               /* TnyMergeFolder does not support get_account(), 
+                * because it could be merging folders from multiple accounts.
+                * So we assume that this is the local folders account: */
+                
+               account = modest_tny_account_store_get_local_folders_account (modest_runtime_get_account_store());
+       } else {
+               account = tny_folder_get_account (folder);
+       }
+       
+       return account;
 }