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 #include <modest-runtime.h>
  40 #include <modest-tny-account-store.h>
  41
  42 TnyFolderType
  43 modest_tny_folder_guess_folder_type_from_name (const gchar* name)
  44 {
  45         gint  type;
  46         gchar *folder;
  47
  48         g_return_val_if_fail (name, TNY_FOLDER_TYPE_UNKNOWN);
  49
  50         type = TNY_FOLDER_TYPE_UNKNOWN;
  51         folder = g_utf8_strdown (name, strlen(name));
  52
  53         if (strcmp (folder, "inbox") == 0 ||
  54             strcmp (folder, _("inbox")) == 0 ||
  55             strcmp (folder, _("mcen_me_folder_inbox")) == 0)
  56                 type = TNY_FOLDER_TYPE_INBOX;
  57         else if (strcmp (folder, "outbox") == 0 ||
  58                  strcmp (folder, _("outbox")) == 0 ||
  59                  strcmp (folder, _("mcen_me_folder_outbox")) == 0)
  60                 type = TNY_FOLDER_TYPE_OUTBOX;
  61         else if (g_str_has_prefix(folder, "junk") ||
  62                  g_str_has_prefix(folder, _("junk")))
  63                 type = TNY_FOLDER_TYPE_JUNK;
  64         else if (g_str_has_prefix(folder, "trash") ||
  65                  g_str_has_prefix(folder, _("trash")))
  66                 type = TNY_FOLDER_TYPE_TRASH;
  67         else if (g_str_has_prefix(folder, "sent") ||
  68                  g_str_has_prefix(folder, _("sent")) ||
  69                  strcmp (folder, _("mcen_me_folder_sent")) == 0)
  70                 type = TNY_FOLDER_TYPE_SENT;
  71         else if (g_str_has_prefix(folder, "draft") ||
  72                  g_str_has_prefix(folder, _("draft")) ||
  73                  strcmp (folder, _("mcen_me_folder_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;
  84
  85         g_free (folder);
  86         return type;
  87 }
  88
  89
  90
  91 TnyFolderType
  92 modest_tny_folder_guess_folder_type (const TnyFolder *folder)
  93 {
  94         TnyFolderType type;
  95
  96         g_return_val_if_fail (folder, TNY_FOLDER_TYPE_UNKNOWN);
  97
  98         type = tny_folder_get_folder_type (TNY_FOLDER (folder));
  99
 100         if (type == TNY_FOLDER_TYPE_UNKNOWN) {
 101                 const gchar *folder_name;
 102
 103                 folder_name = tny_folder_get_name (TNY_FOLDER (folder));
 104                 type =  modest_tny_folder_guess_folder_type_from_name (folder_name);
 105         }
 106
 107         return type;
 108 }
 109
 110
 111 /* FIXME: encode all folder rules here */
 112 ModestTnyFolderRules
 113 modest_tny_folder_get_rules   (TnyFolder *folder)
 114 {
 115         ModestTnyFolderRules rules = 0;
 116         TnyFolderType type;
 117
 118         g_return_val_if_fail (TNY_IS_FOLDER(folder), -1);
 119
 120         if (modest_tny_folder_is_local_folder (folder) ||
 121             modest_tny_folder_is_memory_card_folder (folder)) {
 122
 123                 type = modest_tny_folder_get_local_folder_type (folder);
 124
 125                 switch (type) {
 126                 case TNY_FOLDER_TYPE_OUTBOX:
 127                 case TNY_FOLDER_TYPE_SENT:
 128                         rules |= MODEST_FOLDER_RULES_FOLDER_NON_WRITEABLE;
 129                 case TNY_FOLDER_TYPE_DRAFTS:
 130                 case TNY_FOLDER_TYPE_INBOX:
 131                 case TNY_FOLDER_TYPE_JUNK:
 132                 case TNY_FOLDER_TYPE_TRASH:
 133                 case TNY_FOLDER_TYPE_ROOT:
 134                 case TNY_FOLDER_TYPE_NOTES:
 135                 case TNY_FOLDER_TYPE_CONTACTS:
 136                 case TNY_FOLDER_TYPE_CALENDAR:
 137                 case TNY_FOLDER_TYPE_ARCHIVE:
 138                 case TNY_FOLDER_TYPE_MERGE:
 139                 case TNY_FOLDER_TYPE_NUM:
 140                         rules |= MODEST_FOLDER_RULES_FOLDER_NON_DELETABLE;
 141                         rules |= MODEST_FOLDER_RULES_FOLDER_NON_MOVEABLE;
 142                         rules |= MODEST_FOLDER_RULES_FOLDER_NON_RENAMEABLE;
 143                 default:
 144                         break;
 145                 }
 146         } else {
 147                 ModestTransportStoreProtocol proto;
 148                 TnyAccount *account =
 149                         modest_tny_folder_get_account ((TnyFolder*)folder);
 150                 if (!account)
 151                         return -1; /* no account: nothing is allowed */
 152
 153                 proto = modest_protocol_info_get_transport_store_protocol (tny_account_get_proto (account));
 154
 155                 if (proto == MODEST_PROTOCOL_STORE_IMAP) {
 156                         rules = 0;
 157                 } else {
 158                         /* pop, nntp, ... */
 159                         rules =
 160                                 MODEST_FOLDER_RULES_FOLDER_NON_WRITEABLE |
 161                                 MODEST_FOLDER_RULES_FOLDER_NON_DELETABLE |
 162                                 MODEST_FOLDER_RULES_FOLDER_NON_MOVEABLE  |
 163                                 MODEST_FOLDER_RULES_FOLDER_NON_RENAMEABLE;
 164
 165                 }
 166                 g_object_unref (G_OBJECT(account));
 167         }
 168         return rules;
 169 }
 170
 171
 172 gboolean
 173 modest_tny_folder_is_local_folder   (TnyFolder *folder)
 174 {
 175         g_return_val_if_fail (folder, FALSE);
 176
 177         /* The merge folder is a special case,
 178          * used to merge the per-account local outbox folders.
 179          * and can have no get_account() implementation.
 180          * We should do something more sophisticated if we
 181          * ever use TnyMergeFolder for anything else.
 182          */
 183         if (TNY_IS_MERGE_FOLDER (folder))
 184                 return TRUE;
 185
 186         TnyAccount* account = tny_folder_get_account ((TnyFolder*)folder);
 187         if (!account)
 188                 return FALSE;
 189
 190         /* Outbox is a special case, using a derived TnyAccount: */
 191         if (MODEST_IS_TNY_OUTBOX_ACCOUNT (account)) {
 192                 g_object_unref (account);
 193                 return TRUE;
 194         }
 195
 196         const gchar* account_id = tny_account_get_id (account);
 197         if (!account_id)
 198                 return FALSE;
 199
 200         g_object_unref (G_OBJECT(account));
 201
 202         return (strcmp (account_id, MODEST_LOCAL_FOLDERS_ACCOUNT_ID) == 0);
 203 }
 204
 205 gboolean
 206 modest_tny_folder_is_memory_card_folder   (TnyFolder *folder)
 207 {
 208         g_return_val_if_fail (folder, FALSE);
 209
 210         /* The merge folder is a special case,
 211          * used to merge the per-account local outbox folders.
 212          * and can have no get_account() implementation.
 213          */
 214         if (TNY_IS_MERGE_FOLDER (folder))
 215                 return FALSE;
 216
 217         TnyAccount* account = tny_folder_get_account ((TnyFolder*)folder);
 218         if (!account)
 219                 return FALSE;
 220
 221         const gchar* account_id = tny_account_get_id (account);
 222         if (!account_id)
 223                 return FALSE;
 224
 225         g_object_unref (G_OBJECT(account));
 226
 227         return (strcmp (account_id, MODEST_MMC_ACCOUNT_ID) == 0);
 228 }
 229
 230
 231 TnyFolderType
 232 modest_tny_folder_get_local_folder_type  (TnyFolder *folder)
 233 {
 234         g_return_val_if_fail (folder, TNY_FOLDER_TYPE_UNKNOWN);
 235
 236         /* The merge folder is a special case,
 237          * used to merge the per-account local outbox folders.
 238          * and can have no get_account() implementation.
 239          * We should do something more sophisticated if we
 240          * ever use TnyMergeFolder for anything else.
 241          */
 242         if (TNY_IS_MERGE_FOLDER (folder))
 243                 return TNY_FOLDER_TYPE_OUTBOX;
 244
 245         /* Outbox is a special case, using a derived TnyAccount: */
 246         TnyAccount* parent_account = tny_folder_get_account (folder);
 247         if (parent_account && MODEST_IS_TNY_OUTBOX_ACCOUNT (parent_account)) {
 248                 g_object_unref (parent_account);
 249                 return TNY_FOLDER_TYPE_OUTBOX;
 250         }
 251
 252         if (parent_account) {
 253                 g_object_unref (parent_account);
 254                 parent_account = NULL;
 255         }
 256
 257
 258         g_return_val_if_fail (modest_tny_folder_is_local_folder(folder),
 259                               TNY_FOLDER_TYPE_UNKNOWN);
 260
 261         /* we need to use the camel functions, because we want the
 262          * _full name_, that is, the full path name of the folder,
 263          * to distinguish between 'Outbox' and 'myfunkyfolder/Outbox'
 264          */
 265         CamelFolder *camel_folder = tny_camel_folder_get_folder (TNY_CAMEL_FOLDER(folder));
 266         if (!camel_folder)
 267                 return TNY_FOLDER_TYPE_UNKNOWN;
 268
 269         const gchar *full_name = camel_folder_get_full_name (camel_folder);
 270         /* printf ("DEBUG: %s: full_name=%s\n", __FUNCTION__, full_name); */
 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
 279 gboolean
 280 modest_tny_folder_is_outbox_for_account (TnyFolder *folder, TnyAccount *account)
 281 {
 282         g_return_val_if_fail(folder, FALSE);
 283         g_return_val_if_fail(account, FALSE);
 284
 285         if (modest_tny_folder_get_local_folder_type (folder) != TNY_FOLDER_TYPE_OUTBOX)
 286                 return FALSE;
 287
 288         return TRUE;
 289 #if 0
 290         /* we need to use the camel functions, because we want the
 291          * _full name_, that is, the full path name of the folder,
 292          * to distinguis between 'Outbox' and 'myfunkyfolder/Outbox'
 293          */
 294         CamelFolder *camel_folder = tny_camel_folder_get_folder (TNY_CAMEL_FOLDER(folder));
 295         if (!camel_folder)
 296                 return FALSE;
 297
 298         const gchar *full_name = camel_folder_get_full_name (camel_folder);
 299         camel_object_unref (CAMEL_OBJECT(camel_folder));
 300
 301         if (!full_name)
 302                 return TNY_FOLDER_TYPE_UNKNOWN;
 303         else
 304                 return modest_local_folder_info_get_type (full_name);
 305
 306         return FALSE;
 307 #endif
 308 }
 309
 310 gchar*
 311 modest_tny_folder_get_header_unique_id (TnyHeader *header)
 312 {
 313         TnyFolder *folder;
 314         gchar *url, *retval;
 315         const gchar *uid;
 316
 317         g_return_val_if_fail (TNY_IS_HEADER (header), NULL);
 318
 319         folder = tny_header_get_folder (header);
 320         if (!folder)
 321                 return NULL;
 322
 323         url = tny_folder_get_url_string (folder);
 324         uid = tny_header_get_uid (header);
 325
 326         retval = g_strjoin ("/", url, uid, NULL);
 327
 328         g_free (url);
 329         g_object_unref (folder);
 330
 331         return retval;
 332 }
 333
 334 TnyAccount *modest_tny_folder_get_account (TnyFolder *folder)
 335 {
 336         TnyAccount *account = NULL;
 337
 338         if (TNY_IS_MERGE_FOLDER (folder)) {
 339                 /* TnyMergeFolder does not support get_account(),
 340                  * because it could be merging folders from multiple accounts.
 341                  * So we assume that this is the local folders account: */
 342
 343                 account = modest_tny_account_store_get_local_folders_account (
 344                         TNY_ACCOUNT_STORE (modest_runtime_get_account_store()));
 345         } else {
 346                 account = tny_folder_get_account (folder);
 347         }
 348
 349         return account;
 350 }
 351