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-simple-list.h>
  36 #include <tny-camel-folder.h>
  37 #include <tny-merge-folder.h>
  38 #include <camel/camel-folder.h>
  39 #include <modest-protocol-info.h>
  40 #include <modest-runtime.h>
  41 #include <modest-tny-account-store.h>
  42
  43 TnyFolderType
  44 modest_tny_folder_guess_folder_type_from_name (const gchar* name)
  45 {
  46         gint  type;
  47         gchar *folder;
  48
  49         g_return_val_if_fail (name, TNY_FOLDER_TYPE_UNKNOWN);
  50
  51         type = TNY_FOLDER_TYPE_UNKNOWN;
  52         folder = g_utf8_strdown (name, strlen(name));
  53
  54 //      if (strcmp (folder, "inbox") == 0 ||
  55 //          strcmp (folder, _("inbox")) == 0 ||
  56 //          strcmp (folder, _("mcen_me_folder_inbox")) == 0)
  57 //              type = TNY_FOLDER_TYPE_INBOX;
  58         if (strcmp (folder, _("mcen_me_folder_outbox")) == 0)
  59                 type = TNY_FOLDER_TYPE_OUTBOX;
  60 //      else if (g_str_has_prefix(folder, "junk") ||
  61 //               g_str_has_prefix(folder, _("junk")))
  62 //              type = TNY_FOLDER_TYPE_JUNK;
  63 //      else if (g_str_has_prefix(folder, "trash") ||
  64 //               g_str_has_prefix(folder, _("trash")))
  65 //              type = TNY_FOLDER_TYPE_TRASH;
  66         else if (strcmp (folder, _("mcen_me_folder_sent")) == 0)
  67                 type = TNY_FOLDER_TYPE_SENT;
  68         else if (strcmp (folder, _("mcen_me_folder_drafts")) == 0)
  69                 type = TNY_FOLDER_TYPE_DRAFTS;
  70 //      else if (g_str_has_prefix(folder, "notes") ||
  71 //               g_str_has_prefix(folder, _("notes")))
  72 //              type = TNY_FOLDER_TYPE_NOTES;
  73 //      else if (g_str_has_prefix(folder, "contacts") ||
  74 //               g_str_has_prefix(folder, _("contacts")))
  75 //              type = TNY_FOLDER_TYPE_CONTACTS;
  76 //      else if (g_str_has_prefix(folder, "calendar") ||
  77 //               g_str_has_prefix(folder, _("calendar")))
  78 //              type = TNY_FOLDER_TYPE_CALENDAR;
  79
  80         g_free (folder);
  81         return type;
  82 }
  83
  84
  85
  86 TnyFolderType
  87 modest_tny_folder_guess_folder_type (const TnyFolder *folder)
  88 {
  89         TnyFolderType type;
  90
  91         g_return_val_if_fail (TNY_IS_FOLDER(folder), TNY_FOLDER_TYPE_UNKNOWN);
  92
  93         if (modest_tny_folder_is_local_folder ((TnyFolder*)folder))
  94                 type = modest_tny_folder_get_local_or_mmc_folder_type ((TnyFolder*)folder);
  95         else
  96                 type = tny_folder_get_folder_type (TNY_FOLDER (folder));
  97
  98         if (type == TNY_FOLDER_TYPE_UNKNOWN) {
  99                 const gchar *folder_name;
 100                 folder_name = tny_folder_get_name (TNY_FOLDER (folder));
 101                 type =  modest_tny_folder_guess_folder_type_from_name (folder_name);
 102         }
 103
 104         return type;
 105 }
 106
 107
 108 /* FIXME: encode all folder rules here */
 109 ModestTnyFolderRules
 110 modest_tny_folder_get_rules   (TnyFolder *folder)
 111 {
 112         ModestTnyFolderRules rules = 0;
 113         TnyFolderType type;
 114
 115         g_return_val_if_fail (TNY_IS_FOLDER(folder), -1);
 116
 117         if (modest_tny_folder_is_local_folder (folder) ||
 118             modest_tny_folder_is_memory_card_folder (folder)) {
 119
 120                 type = modest_tny_folder_get_local_or_mmc_folder_type (folder);
 121
 122                 switch (type) {
 123                 case TNY_FOLDER_TYPE_OUTBOX:
 124                 case TNY_FOLDER_TYPE_SENT:
 125                 case TNY_FOLDER_TYPE_DRAFTS:
 126                         rules |= MODEST_FOLDER_RULES_FOLDER_NON_WRITEABLE;
 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                 TnyFolderType folder_type;
 146                 TnyAccount *account;
 147
 148                 account = modest_tny_folder_get_account ((TnyFolder*)folder);
 149                 if (!account)
 150                         return -1; /* no account: nothing is allowed */
 151
 152                 proto = modest_protocol_info_get_transport_store_protocol (tny_account_get_proto (account));
 153
 154                 if (proto == MODEST_PROTOCOL_STORE_IMAP) {
 155                         rules = 0;
 156                 } else {
 157                         /* pop, nntp, ... */
 158                         rules =
 159                                 MODEST_FOLDER_RULES_FOLDER_NON_WRITEABLE |
 160                                 MODEST_FOLDER_RULES_FOLDER_NON_DELETABLE |
 161                                 MODEST_FOLDER_RULES_FOLDER_NON_MOVEABLE  |
 162                                 MODEST_FOLDER_RULES_FOLDER_NON_RENAMEABLE;
 163
 164                 }
 165                 g_object_unref (G_OBJECT(account));
 166
 167                 /* Neither INBOX nor ROOT, nor ARCHIVE folders should me moveable */
 168                 folder_type = modest_tny_folder_guess_folder_type (folder);
 169                 if ((folder_type ==  TNY_FOLDER_TYPE_INBOX) ||
 170                     (folder_type == TNY_FOLDER_TYPE_ROOT) ||
 171                     (folder_type == TNY_FOLDER_TYPE_ARCHIVE)) {
 172                         rules |= MODEST_FOLDER_RULES_FOLDER_NON_DELETABLE;
 173                         rules |= MODEST_FOLDER_RULES_FOLDER_NON_MOVEABLE;
 174                         rules |= MODEST_FOLDER_RULES_FOLDER_NON_RENAMEABLE;
 175                 }
 176         }
 177         return rules;
 178 }
 179
 180
 181
 182 gboolean
 183 modest_tny_folder_is_local_folder   (TnyFolder *folder)
 184 {
 185         g_return_val_if_fail (TNY_IS_FOLDER (folder), FALSE);
 186
 187         /* The merge folder is a special case,
 188          * used to merge the per-account local outbox folders.
 189          * and can have no get_account() implementation.
 190          * We should do something more sophisticated if we
 191          * ever use TnyMergeFolder for anything else.
 192          */
 193         if (TNY_IS_MERGE_FOLDER (folder)) {
 194                 return TRUE;
 195         }
 196
 197         TnyAccount* account = tny_folder_get_account ((TnyFolder*)folder);
 198         if (!account) {
 199                 g_warning ("folder without account");
 200                 return FALSE;
 201         }
 202
 203         /* Outbox is a special case, using a derived TnyAccount: */
 204         if (MODEST_IS_TNY_OUTBOX_ACCOUNT (account)) {
 205                 //g_warning ("BUG: should not be reached");
 206                 /* should be handled with the MERGE_FOLDER above*/
 207                 g_object_unref (G_OBJECT(account));
 208                 return TRUE;
 209         }
 210
 211         const gchar* account_id = tny_account_get_id (account);
 212         if (!account_id) {
 213                 g_warning ("BUG: account without account id");
 214                 g_object_unref (G_OBJECT(account));
 215                 return FALSE;
 216         }
 217
 218         g_object_unref (G_OBJECT(account));
 219         return (strcmp (account_id, MODEST_LOCAL_FOLDERS_ACCOUNT_ID) == 0);
 220 }
 221
 222 gboolean
 223 modest_tny_folder_is_memory_card_folder   (TnyFolder *folder)
 224 {
 225         g_return_val_if_fail (folder, FALSE);
 226
 227         /* The merge folder is a special case,
 228          * used to merge the per-account local outbox folders.
 229          * and can have no get_account() implementation.
 230          */
 231         if (TNY_IS_MERGE_FOLDER (folder))
 232                 return FALSE;
 233
 234         TnyAccount* account = tny_folder_get_account ((TnyFolder*)folder);
 235         if (!account)
 236                 return FALSE;
 237
 238         const gchar* account_id = tny_account_get_id (account);
 239         if (!account_id)
 240                 return FALSE;
 241
 242         g_object_unref (G_OBJECT(account));
 243
 244         return (strcmp (account_id, MODEST_MMC_ACCOUNT_ID) == 0);
 245 }
 246
 247 gboolean
 248 modest_tny_folder_is_remote_folder   (TnyFolder *folder)
 249 {
 250         gboolean is_local = TRUE;
 251
 252         g_return_val_if_fail (folder, FALSE);
 253
 254         is_local = ((modest_tny_folder_is_local_folder(folder)) ||
 255                     (modest_tny_folder_is_memory_card_folder(folder)));
 256
 257
 258         return !is_local;
 259 }
 260
 261 TnyFolderType
 262 modest_tny_folder_get_local_or_mmc_folder_type  (TnyFolder *folder)
 263 {
 264         g_return_val_if_fail (folder, TNY_FOLDER_TYPE_UNKNOWN);
 265         g_return_val_if_fail (modest_tny_folder_is_local_folder(folder)||
 266                               modest_tny_folder_is_memory_card_folder(folder),
 267                               TNY_FOLDER_TYPE_UNKNOWN);
 268
 269         /* The merge folder is a special case,
 270          * used to merge the per-account local outbox folders.
 271          * and can have no get_account() implementation.
 272          * We should do something more sophisticated if we
 273          * ever use TnyMergeFolder for anything else.
 274          */
 275         if (TNY_IS_MERGE_FOLDER (folder))
 276                 return TNY_FOLDER_TYPE_OUTBOX;
 277
 278         /* Outbox is a special case, using a derived TnyAccount: */
 279         TnyAccount* parent_account = tny_folder_get_account (folder);
 280         if (parent_account && MODEST_IS_TNY_OUTBOX_ACCOUNT (parent_account)) {
 281                 g_object_unref (parent_account);
 282                 return TNY_FOLDER_TYPE_OUTBOX;
 283         }
 284
 285         if (parent_account) {
 286                 g_object_unref (parent_account);
 287                 parent_account = NULL;
 288         }
 289
 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 distinguish 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 TNY_FOLDER_TYPE_UNKNOWN;
 297
 298         const gchar *full_name = camel_folder_get_full_name (camel_folder);
 299         /* printf ("DEBUG: %s: full_name=%s\n", __FUNCTION__, full_name); */
 300         camel_object_unref (CAMEL_OBJECT(camel_folder));
 301
 302         if (!full_name)
 303                 return TNY_FOLDER_TYPE_UNKNOWN;
 304         else
 305                 return modest_local_folder_info_get_type (full_name);
 306 }
 307
 308 gboolean
 309 modest_tny_folder_is_outbox_for_account (TnyFolder *folder, TnyAccount *account)
 310 {
 311         g_return_val_if_fail(folder, FALSE);
 312         g_return_val_if_fail(account, FALSE);
 313
 314         if (modest_tny_folder_get_local_or_mmc_folder_type (folder) != TNY_FOLDER_TYPE_OUTBOX)
 315                 return FALSE;
 316
 317         return TRUE;
 318 #if 0
 319         /* we need to use the camel functions, because we want the
 320          * _full name_, that is, the full path name of the folder,
 321          * to distinguis between 'Outbox' and 'myfunkyfolder/Outbox'
 322          */
 323         CamelFolder *camel_folder = tny_camel_folder_get_folder (TNY_CAMEL_FOLDER(folder));
 324         if (!camel_folder)
 325                 return FALSE;
 326
 327         const gchar *full_name = camel_folder_get_full_name (camel_folder);
 328         camel_object_unref (CAMEL_OBJECT(camel_folder));
 329
 330         if (!full_name)
 331                 return TNY_FOLDER_TYPE_UNKNOWN;
 332         else
 333                 return modest_local_folder_info_get_type (full_name);
 334
 335         return FALSE;
 336 #endif
 337 }
 338
 339 gchar*
 340 modest_tny_folder_get_header_unique_id (TnyHeader *header)
 341 {
 342         TnyFolder *folder;
 343         gchar *url, *retval;
 344         const gchar *uid;
 345
 346         g_return_val_if_fail (TNY_IS_HEADER (header), NULL);
 347
 348         folder = tny_header_get_folder (header);
 349         if (!folder)
 350                 return NULL;
 351
 352         url = tny_folder_get_url_string (folder);
 353         uid = tny_header_get_uid (header);
 354
 355         retval = g_strjoin ("/", url, uid, NULL);
 356
 357         g_free (url);
 358         g_object_unref (folder);
 359
 360         return retval;
 361 }
 362
 363 TnyAccount *
 364 modest_tny_folder_get_account (TnyFolder *folder)
 365 {
 366         TnyAccount *account = NULL;
 367
 368         if (TNY_IS_MERGE_FOLDER (folder)) {
 369                 /* TnyMergeFolder does not support get_account(),
 370                  * because it could be merging folders from multiple accounts.
 371                  * So we assume that this is the local folders account: */
 372
 373                 account = modest_tny_account_store_get_local_folders_account (modest_runtime_get_account_store());
 374         } else {
 375                 account = tny_folder_get_account (folder);
 376         }
 377
 378         return account;
 379 }
 380
 381 /*
 382  * It's probably better to use a query to get the folders that match
 383  * new_name but currently tinymail only provides a match by name using
 384  * regular expressions and we want an exact matching. We're not using
 385  * a regular expression for the exact name because we'd need first to
 386  * escape @new_name and it's not easy sometimes.
 387  *
 388  * The code that uses the query is available in revision 3152.
 389  */
 390 gboolean
 391 modest_tny_folder_has_subfolder_with_name (TnyFolderStore *parent,
 392                                            const gchar *new_name)
 393 {
 394         TnyList *subfolders = NULL;
 395         TnyIterator *iter = NULL;
 396         TnyFolder *folder = NULL;
 397         GError *err = NULL;
 398         gboolean same_subfolder = FALSE;
 399
 400         g_return_val_if_fail (TNY_IS_FOLDER_STORE (parent), FALSE);
 401
 402         /* Get direct subfolders */
 403         subfolders = tny_simple_list_new ();
 404         tny_folder_store_get_folders (parent, subfolders, NULL, &err);
 405
 406         /* Check names */
 407         iter = tny_list_create_iterator (subfolders);
 408         while (!tny_iterator_is_done (iter) && !same_subfolder) {
 409                 const gchar *name = NULL;
 410
 411                 folder = TNY_FOLDER(tny_iterator_get_current (iter));
 412                 name = tny_folder_get_name (folder);
 413
 414                 same_subfolder = !strcmp(name, new_name);
 415
 416                 g_object_unref (folder);
 417                 tny_iterator_next(iter);
 418         }
 419
 420         /* free */
 421         if (iter != NULL)
 422                 g_object_unref (iter);
 423         if (subfolders != NULL)
 424                 g_object_unref (subfolders);
 425
 426         return same_subfolder;
 427 }