git.maemo.org Git - modest/blob - src/modest-tny-folder.c

   1 /* Copyright (c) 2006, Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   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.
  16  *
  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.
  28  */
  29
  30 #include <glib.h>
  31 #include <glib/gi18n.h>
  32 #include <string.h>
  33 #include <modest-tny-folder.h>
  34 #include <modest-tny-outbox-account.h>
  35 #include <tny-camel-folder.h>
  36 #include <tny-merge-folder.h>
  37 #include <camel/camel-folder.h>
  38 #include <modest-protocol-info.h>
  39
  40 TnyFolderType
  41 modest_tny_folder_guess_folder_type_from_name (const gchar* name)
  42 {
  43         gint  type;
  44         gchar *folder;
  45
  46         g_return_val_if_fail (name, TNY_FOLDER_TYPE_UNKNOWN);
  47
  48         type = TNY_FOLDER_TYPE_UNKNOWN;
  49         folder = g_utf8_strdown (name, strlen(name));
  50
  51         if (strcmp (folder, "inbox") == 0 ||
  52             strcmp (folder, _("inbox")) == 0 ||
  53             strcmp (folder, _("mcen_me_folder_inbox")) == 0)
  54                 type = TNY_FOLDER_TYPE_INBOX;
  55         else if (strcmp (folder, "outbox") == 0 ||
  56                  strcmp (folder, _("outbox")) == 0 ||
  57                  strcmp (folder, _("mcen_me_folder_outbox")) == 0)
  58                 type = TNY_FOLDER_TYPE_OUTBOX;
  59         else if (g_str_has_prefix(folder, "junk") ||
  60                  g_str_has_prefix(folder, _("junk")))
  61                 type = TNY_FOLDER_TYPE_JUNK;
  62         else if (g_str_has_prefix(folder, "trash") ||
  63                  g_str_has_prefix(folder, _("trash")))
  64                 type = TNY_FOLDER_TYPE_TRASH;
  65         else if (g_str_has_prefix(folder, "sent") ||
  66                  g_str_has_prefix(folder, _("sent")) ||
  67                  strcmp (folder, _("mcen_me_folder_sent")) == 0)
  68                 type = TNY_FOLDER_TYPE_SENT;
  69         else if (g_str_has_prefix(folder, "draft") ||
  70                  g_str_has_prefix(folder, _("draft")) ||
  71                  strcmp (folder, _("mcen_me_folder_drafts")) == 0)
  72                 type = TNY_FOLDER_TYPE_DRAFTS;
  73         else if (g_str_has_prefix(folder, "notes") ||
  74                  g_str_has_prefix(folder, _("notes")))
  75                 type = TNY_FOLDER_TYPE_NOTES;
  76         else if (g_str_has_prefix(folder, "contacts") ||
  77                  g_str_has_prefix(folder, _("contacts")))
  78                 type = TNY_FOLDER_TYPE_CONTACTS;
  79         else if (g_str_has_prefix(folder, "calendar") ||
  80                  g_str_has_prefix(folder, _("calendar")))
  81                 type = TNY_FOLDER_TYPE_CALENDAR;
  82
  83         g_free (folder);
  84         return type;
  85 }
  86
  87
  88
  89 TnyFolderType
  90 modest_tny_folder_guess_folder_type (const TnyFolder *folder)
  91 {
  92         TnyFolderType type;
  93
  94         g_return_val_if_fail (folder, TNY_FOLDER_TYPE_UNKNOWN);
  95
  96         type = tny_folder_get_folder_type (TNY_FOLDER (folder));
  97
  98         if (type == TNY_FOLDER_TYPE_UNKNOWN) {
  99                 const gchar *folder_name;
 100
 101                 folder_name = tny_folder_get_name (TNY_FOLDER (folder));
 102                 type =  modest_tny_folder_guess_folder_type_from_name (folder_name);
 103         }
 104
 105         return type;
 106 }
 107
 108
 109 /* FIXME: encode all folder rules here */
 110 ModestTnyFolderRules
 111 modest_tny_folder_get_rules   (TnyFolder *folder)
 112 {
 113         ModestTnyFolderRules rules = 0;
 114         TnyFolderType type;
 115
 116         g_return_val_if_fail (TNY_IS_FOLDER(folder), -1);
 117
 118         if (modest_tny_folder_is_local_folder (folder)) {
 119
 120                 type = modest_tny_folder_get_local_folder_type (folder);
 121
 122                 switch (type) {
 123                 case TNY_FOLDER_TYPE_OUTBOX:
 124                 case TNY_FOLDER_TYPE_SENT:
 125                         rules |= MODEST_FOLDER_RULES_FOLDER_NON_WRITEABLE;
 126                 case TNY_FOLDER_TYPE_DRAFTS:
 127                 case TNY_FOLDER_TYPE_INBOX:
 128                 case TNY_FOLDER_TYPE_JUNK:
 129                 case TNY_FOLDER_TYPE_TRASH:
 130                 case TNY_FOLDER_TYPE_ROOT:
 131                 case TNY_FOLDER_TYPE_NOTES:
 132                 case TNY_FOLDER_TYPE_CONTACTS:
 133                 case TNY_FOLDER_TYPE_CALENDAR:
 134                 case TNY_FOLDER_TYPE_ARCHIVE:
 135                 case TNY_FOLDER_TYPE_MERGE:
 136                 case TNY_FOLDER_TYPE_NUM:
 137                         rules |= MODEST_FOLDER_RULES_FOLDER_NON_DELETABLE;
 138                         rules |= MODEST_FOLDER_RULES_FOLDER_NON_MOVEABLE;
 139                         rules |= MODEST_FOLDER_RULES_FOLDER_NON_RENAMEABLE;
 140                 default:
 141                         break;
 142                 }
 143         } else {
 144                 ModestTransportStoreProtocol proto;
 145                 TnyAccount *account =
 146                         tny_folder_get_account ((TnyFolder*)folder);
 147                 if (!account)
 148                         return -1; /* no account: nothing is allowed */
 149
 150                 proto = modest_protocol_info_get_transport_store_protocol (tny_account_get_proto (account));
 151
 152                 if (proto == MODEST_PROTOCOL_STORE_IMAP) {
 153                         rules = 0;
 154                 } else {
 155                         /* pop, nntp, ... */
 156                         rules =
 157                                 MODEST_FOLDER_RULES_FOLDER_NON_WRITEABLE |
 158                                 MODEST_FOLDER_RULES_FOLDER_NON_DELETABLE |
 159                                 MODEST_FOLDER_RULES_FOLDER_NON_MOVEABLE  |
 160                                 MODEST_FOLDER_RULES_FOLDER_NON_RENAMEABLE;
 161
 162                 }
 163                 g_object_unref (G_OBJECT(account));
 164         }
 165         return rules;
 166 }
 167
 168
 169 gboolean
 170 modest_tny_folder_is_local_folder   (TnyFolder *folder)
 171 {
 172         g_return_val_if_fail (folder, FALSE);
 173
 174         /* The merge folder is a special case,
 175          * used to merge the per-account local outbox folders.
 176          * and can have no get_account() implementation.
 177          * We should do something more sophisticated if we
 178          * ever use TnyMergeFolder for anything else.
 179          */
 180         if (TNY_IS_MERGE_FOLDER (folder))
 181                 return TRUE;
 182
 183         TnyAccount* account = tny_folder_get_account ((TnyFolder*)folder);
 184         if (!account)
 185                 return FALSE;
 186
 187         /* Outbox is a special case, using a derived TnyAccount: */
 188         if (MODEST_IS_TNY_OUTBOX_ACCOUNT (account)) {
 189                 g_object_unref (account);
 190                 return TRUE;
 191         }
 192
 193         const gchar* account_id = tny_account_get_id (account);
 194         if (!account_id)
 195                 return FALSE;
 196
 197         g_object_unref (G_OBJECT(account));
 198
 199         return (strcmp (account_id, MODEST_ACTUAL_LOCAL_FOLDERS_ACCOUNT_ID) == 0);
 200 }
 201
 202
 203 TnyFolderType
 204 modest_tny_folder_get_local_folder_type  (TnyFolder *folder)
 205 {
 206         g_return_val_if_fail (folder, TNY_FOLDER_TYPE_UNKNOWN);
 207
 208         /* The merge folder is a special case,
 209          * used to merge the per-account local outbox folders.
 210          * and can have no get_account() implementation.
 211          * We should do something more sophisticated if we
 212          * ever use TnyMergeFolder for anything else.
 213          */
 214         if (TNY_IS_MERGE_FOLDER (folder))
 215                 return TNY_FOLDER_TYPE_OUTBOX;
 216
 217         /* Outbox is a special case, using a derived TnyAccount: */
 218         TnyAccount* parent_account = tny_folder_get_account (folder);
 219         if (parent_account && MODEST_IS_TNY_OUTBOX_ACCOUNT (parent_account)) {
 220                 g_object_unref (parent_account);
 221                 return TNY_FOLDER_TYPE_OUTBOX;
 222         }
 223
 224         if (parent_account) {
 225                 g_object_unref (parent_account);
 226                 parent_account = NULL;
 227         }
 228
 229
 230         g_return_val_if_fail (modest_tny_folder_is_local_folder(folder),
 231                               TNY_FOLDER_TYPE_UNKNOWN);
 232
 233         /* we need to use the camel functions, because we want the
 234          * _full name_, that is, the full path name of the folder,
 235          * to distinguish between 'Outbox' and 'myfunkyfolder/Outbox'
 236          */
 237         CamelFolder *camel_folder = tny_camel_folder_get_folder (TNY_CAMEL_FOLDER(folder));
 238         if (!camel_folder)
 239                 return TNY_FOLDER_TYPE_UNKNOWN;
 240
 241         const gchar *full_name = camel_folder_get_full_name (camel_folder);
 242         /* printf ("DEBUG: %s: full_name=%s\n", __FUNCTION__, full_name); */
 243         camel_object_unref (CAMEL_OBJECT(camel_folder));
 244
 245         if (!full_name)
 246                 return TNY_FOLDER_TYPE_UNKNOWN;
 247         else
 248                 return modest_local_folder_info_get_type (full_name);
 249 }
 250
 251 gboolean
 252 modest_tny_folder_is_outbox_for_account (TnyFolder *folder, TnyAccount *account)
 253 {
 254         g_return_val_if_fail(folder, FALSE);
 255         g_return_val_if_fail(account, FALSE);
 256
 257         if (modest_tny_folder_get_local_folder_type (folder) != TNY_FOLDER_TYPE_OUTBOX)
 258                 return FALSE;
 259
 260         return TRUE;
 261 #if 0
 262         /* we need to use the camel functions, because we want the
 263          * _full name_, that is, the full path name of the folder,
 264          * to distinguis between 'Outbox' and 'myfunkyfolder/Outbox'
 265          */
 266         CamelFolder *camel_folder = tny_camel_folder_get_folder (TNY_CAMEL_FOLDER(folder));
 267         if (!camel_folder)
 268                 return FALSE;
 269
 270         const gchar *full_name = camel_folder_get_full_name (camel_folder);
 271         camel_object_unref (CAMEL_OBJECT(camel_folder));
 272
 273         if (!full_name)
 274                 return TNY_FOLDER_TYPE_UNKNOWN;
 275         else
 276                 return modest_local_folder_info_get_type (full_name);
 277
 278         return FALSE;
 279 #endif
 280 }
 281
 282 gchar*
 283 modest_tny_folder_get_header_unique_id (TnyHeader *header)
 284 {
 285         TnyFolder *folder;
 286         gchar *url, *retval;
 287         const gchar *uid;
 288
 289         g_return_val_if_fail (TNY_IS_HEADER (header), NULL);
 290
 291         folder = tny_header_get_folder (header);
 292         if (!folder)
 293                 return NULL;
 294
 295         url = tny_folder_get_url_string (folder);
 296         uid = tny_header_get_uid (header);
 297
 298         retval = g_strjoin ("/", url, uid, NULL);
 299
 300         g_free (url);
 301         g_object_unref (folder);
 302
 303         return retval;
 304 }