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 <modest-protocol-info.h>
  39 #include <modest-runtime.h>
  40 #include <modest-tny-account-store.h>
  41 #include <modest-text-utils.h>
  42
  43
  44 /* make sure you use the *full* name, because foo/drafts is not the same as drafts */
  45 static TnyFolderType
  46 modest_tny_folder_guess_folder_type_from_name (const gchar* full_name)
  47 {
  48         g_return_val_if_fail (full_name, TNY_FOLDER_TYPE_INVALID);
  49
  50         if (strcmp (full_name, modest_local_folder_info_get_type_name(TNY_FOLDER_TYPE_OUTBOX)) == 0)
  51                 return TNY_FOLDER_TYPE_OUTBOX;
  52         else if (strcmp (full_name, modest_local_folder_info_get_type_name(TNY_FOLDER_TYPE_DRAFTS)) == 0)
  53                 return TNY_FOLDER_TYPE_DRAFTS;
  54         return
  55                 TNY_FOLDER_TYPE_NORMAL;
  56 }
  57
  58
  59
  60 TnyFolderType
  61 modest_tny_folder_guess_folder_type (TnyFolder *folder)
  62 {
  63         TnyFolderType type;
  64
  65         g_return_val_if_fail (TNY_IS_FOLDER(folder), TNY_FOLDER_TYPE_INVALID);
  66
  67         if (modest_tny_folder_is_local_folder (folder) ||
  68             modest_tny_folder_is_memory_card_folder (folder))
  69                 type = modest_tny_folder_get_local_or_mmc_folder_type (folder);
  70         else
  71                 type = tny_folder_get_folder_type (TNY_FOLDER (folder));
  72
  73         /* Fallback code, some servers (Dovecot in some versions)
  74            report incorrectly that the INBOX folder is a normal
  75            folder. Really ugly code but... */
  76         if (type == TNY_FOLDER_TYPE_NORMAL) {
  77                 TnyFolderStore *parent = tny_folder_get_folder_store (folder);
  78                 if (parent) {
  79                         if (TNY_IS_ACCOUNT (parent)) {
  80                                 gchar *downcase =
  81                                         g_ascii_strdown (tny_camel_folder_get_full_name (TNY_CAMEL_FOLDER (folder)),
  82                                                          -1);
  83
  84                                 if ((strlen (downcase) == 5) &&
  85                                     !strncmp (downcase, "inbox", 5))
  86                                         type = TNY_FOLDER_TYPE_INBOX;
  87                                 g_free (downcase);
  88                         }
  89                         g_object_unref (parent);
  90                 }
  91         }
  92
  93         if (type == TNY_FOLDER_TYPE_UNKNOWN) {
  94                 const gchar *folder_name =
  95                         tny_camel_folder_get_full_name (TNY_CAMEL_FOLDER (folder));
  96                 type =  modest_tny_folder_guess_folder_type_from_name (folder_name);
  97         }
  98
  99         if (type == TNY_FOLDER_TYPE_INVALID)
 100                 g_warning ("%s: BUG: TNY_FOLDER_TYPE_INVALID", __FUNCTION__);
 101
 102         return type;
 103 }
 104
 105
 106 const gchar*
 107 modest_tny_folder_get_help_id (const TnyFolder *folder)
 108 {
 109         TnyFolderType type;
 110         const gchar* help_id = NULL;
 111
 112         g_return_val_if_fail (folder, NULL);
 113         g_return_val_if_fail (TNY_IS_FOLDER(folder), NULL);
 114
 115         type = modest_tny_folder_guess_folder_type (TNY_FOLDER (folder));
 116
 117         switch (type) {
 118         case TNY_FOLDER_TYPE_NORMAL:  help_id = "applications_email_managefolders"; break;
 119         case TNY_FOLDER_TYPE_INBOX:   help_id = "applications_email_inbox";break;
 120         case TNY_FOLDER_TYPE_OUTBOX:  help_id = "applications_email_outbox";break;
 121         case TNY_FOLDER_TYPE_SENT:    help_id = "applications_email_sent"; break;
 122         case TNY_FOLDER_TYPE_DRAFTS:  help_id = "applications_email_drafts";break;
 123         case TNY_FOLDER_TYPE_ARCHIVE: help_id = "applications_email_managefolders";break;
 124
 125         case TNY_FOLDER_TYPE_INVALID: g_warning ("%s: BUG: TNY_FOLDER_TYPE_INVALID", __FUNCTION__);break;
 126         default:                      g_warning ("%s: BUG: unexpected folder type (%d)", __FUNCTION__, type);
 127         }
 128
 129         return help_id;
 130 }
 131
 132
 133
 134 /* FIXME: encode all folder rules here */
 135 ModestTnyFolderRules
 136 modest_tny_folder_get_rules   (TnyFolder *folder)
 137 {
 138         ModestTnyFolderRules rules = 0;
 139         TnyFolderType type;
 140
 141         g_return_val_if_fail (TNY_IS_FOLDER(folder), -1);
 142
 143         if (modest_tny_folder_is_local_folder (folder) ||
 144             modest_tny_folder_is_memory_card_folder (folder)) {
 145
 146                 type = modest_tny_folder_get_local_or_mmc_folder_type (folder);
 147                 g_return_val_if_fail (type != TNY_FOLDER_TYPE_INVALID, -1);
 148
 149                 switch (type) {
 150                 case TNY_FOLDER_TYPE_OUTBOX:
 151                 case TNY_FOLDER_TYPE_SENT:
 152                 case TNY_FOLDER_TYPE_DRAFTS:
 153                         rules |= MODEST_FOLDER_RULES_FOLDER_NON_WRITEABLE;
 154                 case TNY_FOLDER_TYPE_INBOX:
 155                 case TNY_FOLDER_TYPE_JUNK:
 156                 case TNY_FOLDER_TYPE_TRASH:
 157                 case TNY_FOLDER_TYPE_ROOT:
 158                 case TNY_FOLDER_TYPE_NOTES:
 159                 case TNY_FOLDER_TYPE_CONTACTS:
 160                 case TNY_FOLDER_TYPE_CALENDAR:
 161                 case TNY_FOLDER_TYPE_ARCHIVE:
 162                 case TNY_FOLDER_TYPE_MERGE:
 163                 case TNY_FOLDER_TYPE_NUM:
 164                         rules |= MODEST_FOLDER_RULES_FOLDER_NON_DELETABLE;
 165                         rules |= MODEST_FOLDER_RULES_FOLDER_NON_MOVEABLE;
 166                         rules |= MODEST_FOLDER_RULES_FOLDER_NON_RENAMEABLE;
 167                 default:
 168                         break;
 169                 }
 170         } else {
 171                 ModestTransportStoreProtocol proto;
 172                 TnyFolderType folder_type;
 173                 TnyAccount *account;
 174
 175                 account = modest_tny_folder_get_account ((TnyFolder*)folder);
 176                 if (!account)
 177                         return -1; /* no account: nothing is allowed */
 178
 179                 proto = modest_protocol_info_get_transport_store_protocol (tny_account_get_proto (account));
 180
 181                 if (proto == MODEST_PROTOCOL_STORE_IMAP) {
 182                         rules = 0;
 183                 } else {
 184                         /* pop, nntp, ... */
 185                         rules =
 186                                 MODEST_FOLDER_RULES_FOLDER_NON_WRITEABLE |
 187                                 MODEST_FOLDER_RULES_FOLDER_NON_DELETABLE |
 188                                 MODEST_FOLDER_RULES_FOLDER_NON_MOVEABLE  |
 189                                 MODEST_FOLDER_RULES_FOLDER_NON_RENAMEABLE;
 190
 191                 }
 192                 g_object_unref (G_OBJECT(account));
 193
 194                 /* Neither INBOX nor ROOT, nor ARCHIVE folders should me moveable */
 195                 folder_type = modest_tny_folder_guess_folder_type (folder);
 196                 g_return_val_if_fail (folder_type != TNY_FOLDER_TYPE_INVALID, -1);
 197
 198                 if ((folder_type ==  TNY_FOLDER_TYPE_INBOX) ||
 199                     (folder_type == TNY_FOLDER_TYPE_ROOT) ||
 200                     (folder_type == TNY_FOLDER_TYPE_ARCHIVE)) {
 201                         rules |= MODEST_FOLDER_RULES_FOLDER_NON_DELETABLE;
 202                         rules |= MODEST_FOLDER_RULES_FOLDER_NON_MOVEABLE;
 203                         rules |= MODEST_FOLDER_RULES_FOLDER_NON_RENAMEABLE;
 204                 }
 205         }
 206         return rules;
 207 }
 208
 209
 210
 211 gboolean
 212 modest_tny_folder_is_local_folder   (TnyFolder *folder)
 213 {
 214         g_return_val_if_fail (TNY_IS_FOLDER (folder), FALSE);
 215
 216         /* The merge folder is a special case,
 217          * used to merge the per-account local outbox folders.
 218          * and can have no get_account() implementation.
 219          * We should do something more sophisticated if we
 220          * ever use TnyMergeFolder for anything else.
 221          */
 222         if (TNY_IS_MERGE_FOLDER (folder)) {
 223                 return TRUE;
 224         }
 225
 226         TnyAccount* account = tny_folder_get_account ((TnyFolder*)folder);
 227         if (!account) {
 228                 g_warning ("folder without account");
 229                 return FALSE;
 230         }
 231
 232         /* Outbox is a special case, using a derived TnyAccount: */
 233         if (MODEST_IS_TNY_OUTBOX_ACCOUNT (account)) {
 234                 //g_warning ("BUG: should not be reached");
 235                 /* should be handled with the MERGE_FOLDER above*/
 236                 g_object_unref (G_OBJECT(account));
 237                 return TRUE;
 238         }
 239
 240         const gchar* account_id = tny_account_get_id (account);
 241         if (!account_id) {
 242                 g_warning ("BUG: account without account id");
 243                 g_object_unref (G_OBJECT(account));
 244                 return FALSE;
 245         }
 246
 247         g_object_unref (G_OBJECT(account));
 248         return (strcmp (account_id, MODEST_LOCAL_FOLDERS_ACCOUNT_ID) == 0);
 249 }
 250
 251 gboolean
 252 modest_tny_folder_is_memory_card_folder   (TnyFolder *folder)
 253 {
 254         g_return_val_if_fail (folder, FALSE);
 255
 256         /* The merge folder is a special case,
 257          * used to merge the per-account local outbox folders.
 258          * and can have no get_account() implementation.
 259          */
 260         if (TNY_IS_MERGE_FOLDER (folder))
 261                 return FALSE;
 262
 263         TnyAccount* account = tny_folder_get_account ((TnyFolder*)folder);
 264         if (!account)
 265                 return FALSE;
 266
 267         const gchar* account_id = tny_account_get_id (account);
 268         if (!account_id) {
 269                 g_object_unref (account);
 270                 return FALSE;
 271         }
 272
 273         g_object_unref (account);
 274
 275         return (strcmp (account_id, MODEST_MMC_ACCOUNT_ID) == 0);
 276 }
 277
 278 gboolean
 279 modest_tny_folder_is_remote_folder   (TnyFolder *folder)
 280 {
 281         gboolean is_local = TRUE;
 282
 283         g_return_val_if_fail (TNY_IS_FOLDER(folder), FALSE);
 284
 285         is_local = ((modest_tny_folder_is_local_folder(folder)) ||
 286                     (modest_tny_folder_is_memory_card_folder(folder)));
 287
 288
 289         return !is_local;
 290 }
 291
 292
 293 TnyFolderType
 294 modest_tny_folder_get_local_or_mmc_folder_type  (TnyFolder *folder)
 295 {
 296         g_return_val_if_fail (folder, TNY_FOLDER_TYPE_INVALID);
 297         g_return_val_if_fail (modest_tny_folder_is_local_folder(folder)||
 298                               modest_tny_folder_is_memory_card_folder(folder),
 299                               TNY_FOLDER_TYPE_INVALID);
 300
 301         /* The merge folder is a special case,
 302          * used to merge the per-account local outbox folders.
 303          * and can have no get_account() implementation.
 304          * We should do something more sophisticated if we
 305          * ever use TnyMergeFolder for anything else.
 306          */
 307         if (TNY_IS_MERGE_FOLDER (folder))
 308                 return TNY_FOLDER_TYPE_OUTBOX;
 309
 310         /* Outbox is a special case, using a derived TnyAccount: */
 311         TnyAccount* parent_account = tny_folder_get_account (folder);
 312         if (parent_account && MODEST_IS_TNY_OUTBOX_ACCOUNT (parent_account)) {
 313                 g_object_unref (parent_account);
 314                 return TNY_FOLDER_TYPE_OUTBOX;
 315         }
 316
 317         if (parent_account) {
 318                 g_object_unref (parent_account);
 319                 parent_account = NULL;
 320         }
 321
 322         /* we need to use the camel functions, because we want the
 323          * _full name_, that is, the full path name of the folder,
 324          * to distinguish between 'Outbox' and 'myfunkyfolder/Outbox'
 325          */
 326
 327         const gchar *full_name = tny_camel_folder_get_full_name (TNY_CAMEL_FOLDER (folder));
 328         /* printf ("DEBUG: %s: full_name=%s\n", __FUNCTION__, full_name); */
 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
 336 gboolean
 337 modest_tny_folder_is_outbox_for_account (TnyFolder *folder, TnyAccount *account)
 338 {
 339         g_return_val_if_fail(folder, FALSE);
 340         g_return_val_if_fail(account, FALSE);
 341
 342         if (modest_tny_folder_get_local_or_mmc_folder_type (folder) != TNY_FOLDER_TYPE_OUTBOX)
 343                 return FALSE;
 344
 345         return TRUE;
 346 }
 347
 348 gchar*
 349 modest_tny_folder_get_header_unique_id (TnyHeader *header)
 350 {
 351         TnyFolder *folder;
 352         gchar *url, *retval;
 353         gchar *uid;
 354
 355         g_return_val_if_fail (TNY_IS_HEADER (header), NULL);
 356
 357         folder = tny_header_get_folder (header);
 358         if (!folder)
 359                 return NULL;
 360
 361         url = tny_folder_get_url_string (folder);
 362         uid = tny_header_dup_uid (header);
 363
 364         retval = g_strjoin ("/", url, uid, NULL);
 365         g_free (uid);
 366
 367         g_free (url);
 368         g_object_unref (folder);
 369
 370         return retval;
 371 }
 372
 373 TnyAccount *
 374 modest_tny_folder_get_account (TnyFolder *folder)
 375 {
 376         TnyAccount *account = NULL;
 377
 378         g_return_val_if_fail (TNY_IS_FOLDER(folder), NULL);
 379
 380         if (TNY_IS_MERGE_FOLDER (folder)) {
 381                 /* TnyMergeFolder does not support get_account(),
 382                  * because it could be merging folders from multiple accounts.
 383                  * So we assume that this is the local folders account: */
 384
 385                 account = modest_tny_account_store_get_local_folders_account (modest_runtime_get_account_store());
 386         } else {
 387                 account = tny_folder_get_account (folder);
 388         }
 389
 390         return account;
 391 }
 392
 393 /*
 394  * It's probably better to use a query to get the folders that match
 395  * new_name but currently tinymail only provides a match by name using
 396  * regular expressions and we want an exact matching. We're not using
 397  * a regular expression for the exact name because we'd need first to
 398  * escape @new_name and it's not easy sometimes.
 399  *
 400  * The code that uses the query is available in revision 3152.
 401  */
 402 gboolean
 403 modest_tny_folder_has_subfolder_with_name (TnyFolderStore *parent,
 404                                            const gchar *new_name,
 405                                            gboolean non_strict)
 406 {
 407         TnyList *subfolders = NULL;
 408         TnyIterator *iter = NULL;
 409         TnyFolder *folder = NULL;
 410         GError *err = NULL;
 411         gboolean has_name = FALSE;
 412
 413         g_return_val_if_fail (TNY_IS_FOLDER_STORE (parent), FALSE);
 414         g_return_val_if_fail (new_name, FALSE);
 415
 416         /* Get direct subfolders */
 417         subfolders = tny_simple_list_new ();
 418         tny_folder_store_get_folders (parent, subfolders, NULL, &err);
 419
 420         /* Check names */
 421         iter = tny_list_create_iterator (subfolders);
 422         while (!tny_iterator_is_done (iter) && !has_name) {
 423
 424                 const gchar *name;
 425
 426                 folder = (TnyFolder*)tny_iterator_get_current (iter);
 427                 if (!folder || ! TNY_IS_FOLDER(folder)) {
 428                         g_warning ("%s: invalid folder", __FUNCTION__);
 429                         continue;
 430                 }
 431
 432                 name = tny_folder_get_name (folder);
 433                 if (!name) {
 434                         g_warning ("%s: folder name == NULL", __FUNCTION__);
 435                         g_object_unref (folder);
 436                         continue;
 437                 }
 438
 439                 /* is it simply the same folder name? */
 440                 if (strcmp (name, new_name) == 0)
 441                         has_name = TRUE;
 442                 /* or is it the same when ignoring case (non-strict mode)? */
 443                 else if (non_strict && modest_text_utils_utf8_strcmp (name, new_name, TRUE) == 0)
 444                         has_name = TRUE;
 445                 /* or is the name equal to the display name of some folder, in the current locale? */
 446                 else if (non_strict) {
 447                         TnyFolderType type = modest_tny_folder_guess_folder_type (folder);
 448                         if (type != TNY_FOLDER_TYPE_INVALID && type != TNY_FOLDER_TYPE_NORMAL)
 449                                 has_name = !(modest_text_utils_utf8_strcmp (modest_local_folder_info_get_type_display_name (type),
 450                                                                             new_name,
 451                                                                             TRUE));
 452                 } else {
 453                         has_name = FALSE;
 454                 }
 455
 456                 g_object_unref (folder);
 457                 tny_iterator_next(iter);
 458         }
 459
 460         /* free */
 461         if (iter != NULL)
 462                 g_object_unref (iter);
 463         if (subfolders != NULL)
 464                 g_object_unref (subfolders);
 465
 466         return has_name;
 467 }
 468
 469 gboolean
 470 modest_tny_folder_is_ancestor (TnyFolder *folder,
 471                                TnyFolderStore *ancestor)
 472 {
 473         TnyFolderStore *tmp = NULL;
 474         gboolean found = FALSE;
 475
 476         tmp = TNY_FOLDER_STORE (folder);
 477         while (!found && tmp && !TNY_IS_ACCOUNT (tmp)) {
 478                 TnyFolderStore *folder_store;
 479
 480                 folder_store = tny_folder_get_folder_store (TNY_FOLDER (tmp));
 481                 if (ancestor == folder_store)
 482                         found = TRUE;
 483                 else
 484                         tmp = folder_store;
 485                 g_object_unref (folder_store);
 486         }
 487         return found;
 488 }