src/folder.h

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2002 Hiroyuki Yamamoto
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 #ifndef __FOLDER_H__
  21 #define __FOLDER_H__
  22
  23 #include <glib.h>
  24 #include <time.h>
  25
  26 typedef struct _Folder                  Folder;
  27 typedef struct _FolderClass             FolderClass;
  28 typedef struct _LocalFolder             LocalFolder;
  29 typedef struct _RemoteFolder            RemoteFolder;
  30 #if 0
  31 typedef struct _MaildirFolder           MaildirFolder;
  32 #endif
  33 typedef struct _FolderItem              FolderItem;
  34
  35 typedef struct _FolderUpdateData        FolderUpdateData;
  36 typedef struct _FolderItemUpdateData    FolderItemUpdateData;
  37
  38 #define FOLDER(obj)             ((Folder *)obj)
  39 #define FOLDER_TYPE(obj)        (FOLDER(obj)->klass->type)
  40
  41 #define FOLDER_CLASS(obj)       (FOLDER(obj)->klass)
  42 #define LOCAL_FOLDER(obj)       ((LocalFolder *)obj)
  43 #define REMOTE_FOLDER(obj)      ((RemoteFolder *)obj)
  44
  45 #define FOLDER_IS_LOCAL(obj)    (FOLDER_TYPE(obj) == F_MH      || \
  46                                  FOLDER_TYPE(obj) == F_MBOX    || \
  47                                  FOLDER_TYPE(obj) == F_MAILDIR)
  48
  49 #if 0
  50 #define MAILDIR_FOLDER(obj)     ((MaildirFolder *)obj)
  51 #endif
  52
  53 #define FOLDER_ITEM(obj)        ((FolderItem *)obj)
  54
  55 #define FOLDER_UPDATE_HOOKLIST "folder_update"
  56 #define FOLDER_ITEM_UPDATE_HOOKLIST "folder_item_update"
  57
  58 typedef enum
  59 {
  60         F_MH,
  61         F_MBOX,
  62         F_MAILDIR,
  63         F_IMAP,
  64         F_NEWS,
  65         F_UNKNOWN
  66 } FolderType;
  67
  68 typedef enum
  69 {
  70         F_NORMAL,
  71         F_INBOX,
  72         F_OUTBOX,
  73         F_DRAFT,
  74         F_QUEUE,
  75         F_TRASH
  76 } SpecialFolderItemType;
  77
  78 typedef enum
  79 {
  80         SORT_BY_NONE,
  81         SORT_BY_NUMBER,
  82         SORT_BY_SIZE,
  83         SORT_BY_DATE,
  84         SORT_BY_FROM,
  85         SORT_BY_SUBJECT,
  86         SORT_BY_SCORE,
  87         SORT_BY_LABEL,
  88         SORT_BY_MARK,
  89         SORT_BY_STATUS,
  90         SORT_BY_MIME,
  91         SORT_BY_TO,
  92         SORT_BY_LOCKED
  93 } FolderSortKey;
  94
  95 typedef enum
  96 {
  97         SORT_ASCENDING,
  98         SORT_DESCENDING
  99 } FolderSortType;
 100
 101 typedef enum
 102 {
 103         F_MOVE_OK = 0,
 104         F_MOVE_FAILED_DEST_IS_PARENT = -1,
 105         F_MOVE_FAILED_DEST_IS_CHILD = -2,
 106         F_MOVE_FAILED_DEST_OUTSIDE_MAILBOX = -3,
 107         F_MOVE_FAILED = -4,
 108 } FolderItemMoveResult;
 109
 110 typedef enum
 111 {
 112         FOLDER_TREE_CHANGED = 1 << 0,
 113 /*
 114         maybe enhance with:
 115         FOLDER_NEW_FOLDERITEM
 116         FOLDER_REMOVE_FOLDERITEM
 117 */
 118 } FolderUpdateFlags;
 119
 120 typedef enum
 121 {
 122         F_ITEM_UPDATE_MSGCNT = 1 << 0,
 123         F_ITEM_UPDATE_CONTENT = 1 << 1,
 124 } FolderItemUpdateFlags;
 125
 126 typedef void (*FolderUIFunc)            (Folder         *folder,
 127                                          FolderItem     *item,
 128                                          gpointer        data);
 129 typedef void (*FolderDestroyNotify)     (Folder         *folder,
 130                                          FolderItem     *item,
 131                                          gpointer        data);
 132 typedef void (*FolderItemFunc)          (FolderItem     *item,
 133                                          gpointer        data);
 134
 135 #include "prefs_folder_item.h"
 136
 137 #include "prefs_account.h"
 138 #include "session.h"
 139 #include "procmsg.h"
 140 #include "msgcache.h"
 141
 142 struct _Folder
 143 {
 144         FolderClass *klass;
 145
 146         gchar *name;
 147         PrefsAccount *account;
 148
 149         FolderItem *inbox;
 150         FolderItem *outbox;
 151         FolderItem *draft;
 152         FolderItem *queue;
 153         FolderItem *trash;
 154
 155         FolderUIFunc ui_func;
 156         gpointer     ui_func_data;
 157
 158         GNode *node;
 159
 160         gpointer data;
 161
 162         GHashTable *newsart;
 163 };
 164
 165 struct _FolderClass
 166 {
 167         FolderType  type;
 168         gchar      *idstr;
 169         gchar      *uistr;
 170
 171         /* virtual functions */
 172
 173         /* Folder funtions */
 174         Folder          *(*new_folder)          (const gchar    *name,
 175                                                  const gchar    *path);
 176         void            (*destroy_folder)       (Folder         *folder);
 177         void            (*scan_tree)            (Folder         *folder);
 178
 179         gint            (*create_tree)          (Folder         *folder);
 180
 181         /* FolderItem functions */
 182         FolderItem      *(*item_new)            (Folder         *folder);
 183         void            (*item_destroy)         (Folder         *folder,
 184                                                  FolderItem     *item);
 185         FolderItem      *(*create_folder)       (Folder         *folder,
 186                                                  FolderItem     *parent,
 187                                                  const gchar    *name);
 188         gint            (*rename_folder)        (Folder         *folder,
 189                                                  FolderItem     *item,
 190                                                  const gchar    *name);
 191         gint            (*remove_folder)        (Folder         *folder,
 192                                                  FolderItem     *item);
 193         gint            (*get_num_list)         (Folder         *folder,
 194                                                  FolderItem     *item,
 195                                                  GSList        **list);
 196         void            (*update_mark)          (Folder         *folder,
 197                                                  FolderItem     *item);
 198         void            (*finished_copy)        (Folder         *folder,
 199                                                  FolderItem     *item);
 200         void            (*finished_remove)      (Folder         *folder,
 201                                                  FolderItem * item);
 202         gboolean        (*check_msgnum_validity)(Folder         *folder,
 203                                                  FolderItem * item);
 204
 205         /* Message functions */
 206         MsgInfo         *(*get_msginfo)         (Folder         *folder,
 207                                                  FolderItem     *item,
 208                                                  gint            num);
 209         GSList          *(*get_msginfos)        (Folder         *folder,
 210                                                  FolderItem     *item,
 211                                                  MsgNumberList  *msgnum_list);
 212         gchar           *(*fetch_msg)           (Folder         *folder,
 213                                                  FolderItem     *item,
 214                                                  gint            num);
 215         gint            (*add_msg)              (Folder         *folder,
 216                                                  FolderItem     *dest,
 217                                                  const gchar    *file,
 218                                                 gboolean         remove_source);
 219         gint            (*copy_msg)             (Folder         *folder,
 220                                                  FolderItem     *dest,
 221                                                  MsgInfo        *msginfo);
 222         gint            (*remove_msg)           (Folder         *folder,
 223                                                  FolderItem     *item,
 224                                                  gint            num);
 225         gint            (*remove_all_msg)       (Folder         *folder,
 226                                                  FolderItem     *item);
 227         gboolean        (*is_msg_changed)       (Folder         *folder,
 228                                                  FolderItem     *item,
 229                                                  MsgInfo        *msginfo);
 230         void            (*change_flags)         (Folder         *folder,
 231                                                  FolderItem     *item,
 232                                                  MsgInfo        *msginfo,
 233                                                  MsgPermFlags    newflags);
 234 };
 235
 236 struct _LocalFolder
 237 {
 238         Folder folder;
 239
 240         gchar *rootpath;
 241 };
 242
 243 struct _RemoteFolder
 244 {
 245         Folder folder;
 246
 247         Session *session;
 248 };
 249
 250 #if 0
 251 struct _MaildirFolder
 252 {
 253         LocalFolder lfolder;
 254 };
 255 #endif
 256
 257 struct _FolderItem
 258 {
 259         SpecialFolderItemType stype;
 260
 261         gchar *name;
 262         gchar *path;
 263
 264         time_t mtime;
 265
 266         gint new_msgs;
 267         gint unread_msgs;
 268         gint total_msgs;
 269         gint unreadmarked_msgs;
 270
 271         gint last_num;
 272
 273         MsgCache *cache;
 274
 275         /* special flags */
 276         guint no_sub         : 1; /* no child allowed?    */
 277         guint no_select      : 1; /* not selectable?      */
 278         guint collapsed      : 1; /* collapsed item       */
 279         guint thread_collapsed      : 1; /* collapsed item       */
 280         guint threaded       : 1; /* threaded folder view */
 281         guint hide_read_msgs : 1; /* hide read messages   */
 282         guint ret_rcpt       : 1; /* return receipt       */
 283
 284         gint op_count;
 285         guint opened         : 1; /* opened by summary view */
 286         FolderItemUpdateFlags update_flags; /* folderview for this folder should be updated */
 287
 288         FolderSortKey sort_key;
 289         FolderSortType sort_type;
 290
 291         FolderItem *parent;
 292
 293         Folder *folder;
 294
 295         PrefsAccount *account;
 296
 297         gboolean apply_sub;
 298
 299         GSList *mark_queue;
 300
 301         gpointer data;
 302
 303         PrefsFolderItem * prefs;
 304 };
 305
 306 typedef struct {
 307         FolderSortKey   sort_key;
 308         FolderSortType  sort_type;
 309         guint           collapsed       : 1;
 310         guint           thread_collapsed        : 1;
 311         guint           threaded        : 1;
 312         guint           hide_read_msgs  : 1; /* CLAWS */
 313         guint           ret_rcpt        : 1; /* CLAWS */
 314 } PersistPrefs;
 315
 316 struct _FolderUpdateData
 317 {
 318         Folder                  *folder;
 319         FolderUpdateFlags        update_flags;
 320 /*
 321         FolderItem              *item
 322 */
 323 };
 324
 325 struct _FolderItemUpdateData
 326 {
 327         FolderItem              *item;
 328         FolderItemUpdateFlags    update_flags;
 329 };
 330
 331 void        folder_system_init          (void);
 332 void        folder_register_class       (FolderClass    *klass);
 333 Folder     *folder_new                  (FolderClass    *type,
 334                                          const gchar    *name,
 335                                          const gchar    *path);
 336 void        folder_local_folder_init    (Folder         *folder,
 337                                          const gchar    *name,
 338                                          const gchar    *path);
 339 void        folder_remote_folder_init   (Folder         *folder,
 340                                          const gchar    *name,
 341                                          const gchar    *path);
 342
 343 void        folder_destroy              (Folder         *folder);
 344 void        folder_local_folder_destroy (LocalFolder    *lfolder);
 345 void        folder_remote_folder_destroy(RemoteFolder   *rfolder);
 346
 347 FolderItem *folder_item_new     (Folder         *folder,
 348                                  const gchar    *name,
 349                                  const gchar    *path);
 350 void        folder_item_append  (FolderItem     *parent,
 351                                  FolderItem     *item);
 352 void        folder_item_remove  (FolderItem     *item);
 353 void        folder_item_destroy (FolderItem     *item);
 354
 355 void        folder_set_ui_func  (Folder         *folder,
 356                                  FolderUIFunc    func,
 357                                  gpointer        data);
 358 void        folder_set_name     (Folder         *folder,
 359                                  const gchar    *name);
 360 void        folder_tree_destroy (Folder         *folder);
 361
 362 void   folder_add               (Folder         *folder);
 363
 364 GList *folder_get_list          (void);
 365 gint   folder_read_list         (void);
 366 void   folder_write_list        (void);
 367 void   folder_scan_tree         (Folder *folder);
 368 FolderItem *folder_create_folder(FolderItem     *parent, const gchar *name);
 369 void   folder_update_op_count           (void);
 370 void   folder_func_to_all_folders       (FolderItemFunc function,
 371                                          gpointer data);
 372 void   folder_count_total_msgs  (guint          *new_msgs,
 373                                  guint          *unread_msgs,
 374                                  guint          *unreadmarked_msgs,
 375                                  guint          *total_msgs);
 376
 377 Folder     *folder_find_from_path               (const gchar    *path);
 378 Folder     *folder_find_from_name               (const gchar    *name,
 379                                                  FolderClass    *klass);
 380 FolderItem *folder_find_item_from_path          (const gchar    *path);
 381 FolderClass *folder_get_class_from_string       (const gchar    *str);
 382 gchar      *folder_get_identifier               (Folder         *folder);
 383 gchar      *folder_item_get_identifier          (FolderItem     *item);
 384 FolderItem *folder_find_item_from_identifier    (const gchar    *identifier);
 385 gchar      *folder_item_get_name                (FolderItem     *item);
 386
 387 Folder     *folder_get_default_folder   (void);
 388 FolderItem *folder_get_default_inbox    (void);
 389 FolderItem *folder_get_default_outbox   (void);
 390 FolderItem *folder_get_default_draft    (void);
 391 FolderItem *folder_get_default_queue    (void);
 392 FolderItem *folder_get_default_trash    (void);
 393 FolderItem *folder_get_default_processing (void);
 394 void folder_set_missing_folders         (void);
 395 void folder_unref_account_all           (PrefsAccount   *account);
 396
 397 gchar *folder_get_path                  (Folder         *folder);
 398 gchar *folder_item_get_path             (FolderItem     *item);
 399
 400 gint   folder_item_open                 (FolderItem     *item);
 401 void   folder_item_close                (FolderItem     *item);
 402 gint   folder_item_scan                 (FolderItem     *item);
 403 void   folder_item_scan_foreach         (GHashTable     *table);
 404 MsgInfo *folder_item_get_msginfo        (FolderItem     *item,
 405                                          gint            num);
 406 MsgInfo *folder_item_get_msginfo_by_msgid(FolderItem    *item,
 407                                          const gchar    *msgid);
 408 GSList *folder_item_get_msg_list        (FolderItem     *item);
 409 gchar *folder_item_fetch_msg            (FolderItem     *item,
 410                                          gint            num);
 411 gint   folder_item_add_msg              (FolderItem     *dest,
 412                                          const gchar    *file,
 413                                          gboolean        remove_source);
 414 gint   folder_item_move_to              (FolderItem     *src,
 415                                          FolderItem     *dest,
 416                                          FolderItem    **new_item);
 417 gint   folder_item_move_msg             (FolderItem     *dest,
 418                                          MsgInfo        *msginfo);
 419 gint   folder_item_move_msgs_with_dest  (FolderItem     *dest,
 420                                          GSList         *msglist);
 421 gint   folder_item_copy_msg             (FolderItem     *dest,
 422                                          MsgInfo        *msginfo);
 423 gint   folder_item_copy_msgs_with_dest  (FolderItem     *dest,
 424                                          GSList         *msglist);
 425 gint   folder_item_remove_msg           (FolderItem     *item,
 426                                          gint            num);
 427 gint   folder_item_remove_msgs          (FolderItem     *item,
 428                                          GSList         *msglist);
 429 gint   folder_item_remove_all_msg       (FolderItem     *item);
 430 void    folder_item_change_msg_flags    (FolderItem     *item,
 431                                          MsgInfo        *msginfo,
 432                                          MsgPermFlags    newflags);
 433 gboolean folder_item_is_msg_changed     (FolderItem     *item,
 434                                          MsgInfo        *msginfo);
 435 gchar *folder_item_get_cache_file       (FolderItem     *item);
 436 gchar *folder_item_get_mark_file        (FolderItem     *item);
 437 gchar * folder_item_get_identifier(FolderItem * item);
 438
 439 GHashTable *folder_persist_prefs_new    (Folder *folder);
 440 void folder_persist_prefs_free          (GHashTable *pptable);
 441 const PersistPrefs *folder_get_persist_prefs
 442                                         (GHashTable *pptable, const char *name);
 443
 444 void folder_item_restore_persist_prefs  (FolderItem *item, GHashTable *pptable);
 445 void folder_clean_cache_memory          (void);
 446 void folder_item_write_cache            (FolderItem *item);
 447 void folder_item_set_default_flags      (FolderItem *dest, MsgFlags *flags);
 448
 449 void folder_item_apply_processing       (FolderItem *item);
 450
 451 void folder_item_update                 (FolderItem *item,
 452                                          FolderItemUpdateFlags update_flags);
 453 void folder_item_update_recursive       (FolderItem *item,
 454                                          FolderItemUpdateFlags update_flags);
 455 void folder_item_update_freeze          (void);
 456 void folder_item_update_thaw            (void);
 457
 458 #endif /* __FOLDER_H__ */