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