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 _LocalFolder             LocalFolder;
  28 typedef struct _RemoteFolder            RemoteFolder;
  29 #if 0
  30 typedef struct _MaildirFolder           MaildirFolder;
  31 #endif
  32 typedef struct _FolderItem              FolderItem;
  33 typedef struct _FolderItemUpdateData    FolderItemUpdateData;
  34
  35 #include "prefs_folder_item.h"
  36
  37 #include "prefs_account.h"
  38 #include "session.h"
  39 #include "procmsg.h"
  40 #include "msgcache.h"
  41
  42 #define FOLDER(obj)             ((Folder *)obj)
  43 #define FOLDER_TYPE(obj)        (FOLDER(obj)->type)
  44
  45 #define LOCAL_FOLDER(obj)       ((LocalFolder *)obj)
  46 #define REMOTE_FOLDER(obj)      ((RemoteFolder *)obj)
  47
  48 #define FOLDER_IS_LOCAL(obj)    (FOLDER_TYPE(obj) == F_MH      || \
  49                                  FOLDER_TYPE(obj) == F_MBOX    || \
  50                                  FOLDER_TYPE(obj) == F_MAILDIR)
  51
  52 #if 0
  53 #define MAILDIR_FOLDER(obj)     ((MaildirFolder *)obj)
  54 #endif
  55
  56 #define FOLDER_ITEM(obj)        ((FolderItem *)obj)
  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_UNREAD,
  90         SORT_BY_MIME,
  91         SORT_BY_LOCKED
  92 } FolderSortKey;
  93
  94 typedef enum
  95 {
  96         SORT_ASCENDING,
  97         SORT_DESCENDING
  98 } FolderSortType;
  99
 100 typedef enum
 101 {
 102         F_MOVE_OK,
 103         F_MOVE_FAILED_DEST_IS_PARENT,
 104         F_MOVE_FAILED_DEST_IS_CHILD,
 105         F_MOVE_FAILED_DEST_OUTSIDE_MAILBOX,
 106         F_MOVE_FAILED
 107 } FolderMoveStatus;
 108
 109 typedef void (*FolderUIFunc)            (Folder         *folder,
 110                                          FolderItem     *item,
 111                                          gpointer        data);
 112 typedef void (*FolderDestroyNotify)     (Folder         *folder,
 113                                          FolderItem     *item,
 114                                          gpointer        data);
 115 typedef void (*FolderItemFunc)          (FolderItem     *item,
 116                                          gpointer        data);
 117
 118 struct _Folder
 119 {
 120         FolderType type;
 121
 122         gchar *name;
 123         PrefsAccount *account;
 124
 125         FolderItem *inbox;
 126         FolderItem *outbox;
 127         FolderItem *draft;
 128         FolderItem *queue;
 129         FolderItem *trash;
 130
 131         FolderUIFunc ui_func;
 132         gpointer     ui_func_data;
 133
 134         GNode *node;
 135
 136         gpointer data;
 137
 138         GHashTable *newsart;
 139
 140         /* virtual functions */
 141 /*
 142         GSList * (*get_msg_list)        (Folder         *folder,
 143                                          FolderItem     *item,
 144                                          gboolean        use_cache);
 145 */
 146         FolderItem *(*item_new)         (Folder         *folder);
 147         void     (*item_destroy)        (Folder         *folder,
 148                                          FolderItem     *item);
 149         gchar *  (*fetch_msg)           (Folder         *folder,
 150                                          FolderItem     *item,
 151                                          gint            num);
 152         MsgInfo * (*get_msginfo)        (Folder         *folder,
 153                                          FolderItem     *item,
 154                                          gint            num);
 155         GSList  * (*get_msginfos)       (Folder         *folder,
 156                                          FolderItem     *item,
 157                                          GSList         *msgnum_list);
 158         gint     (*add_msg)             (Folder         *folder,
 159                                          FolderItem     *dest,
 160                                          const gchar    *file,
 161                                          gboolean        remove_source);
 162         gint     (*move_msg)            (Folder         *folder,
 163                                          FolderItem     *dest,
 164                                          MsgInfo        *msginfo);
 165         gint     (*move_msgs_with_dest) (Folder         *folder,
 166                                          FolderItem     *dest,
 167                                          GSList         *msglist);
 168         gint     (*copy_msg)            (Folder         *folder,
 169                                          FolderItem     *dest,
 170                                          MsgInfo        *msginfo);
 171         gint     (*copy_msgs_with_dest) (Folder         *folder,
 172                                          FolderItem     *dest,
 173                                          GSList         *msglist);
 174         gint     (*remove_msg)          (Folder         *folder,
 175                                          FolderItem     *item,
 176                                          gint            num);
 177         gint     (*remove_msgs)         (Folder         *folder,
 178                                          FolderItem     *item,
 179                                          GSList         *msglist);
 180         gint     (*remove_all_msg)      (Folder         *folder,
 181                                          FolderItem     *item);
 182         gboolean (*is_msg_changed)      (Folder         *folder,
 183                                          FolderItem     *item,
 184                                          MsgInfo        *msginfo);
 185         gint     (*scan)                (Folder         *folder);
 186         gint     (*get_num_list)        (Folder         *folder,
 187                                          FolderItem     *item,
 188                                          GSList        **list);
 189         void     (*scan_tree)           (Folder         *folder);
 190
 191         gint     (*create_tree)         (Folder         *folder);
 192         FolderItem * (*create_folder)   (Folder         *folder,
 193                                          FolderItem     *parent,
 194                                          const gchar    *name);
 195         gint     (*rename_folder)       (Folder         *folder,
 196                                          FolderItem     *item,
 197                                          const gchar    *name);
 198         gint     (*remove_folder)       (Folder         *folder,
 199                                          FolderItem     *item);
 200
 201         void     (*destroy)             (Folder         *folder);
 202         void     (*update_mark)         (Folder         *folder,
 203                                          FolderItem     *item);
 204         void     (*change_flags)        (Folder         *folder,
 205                                          FolderItem     *item,
 206                                          MsgInfo        *info);
 207         void     (*finished_copy)       (Folder * folder, FolderItem * item);
 208         void     (*finished_remove)     (Folder * folder, FolderItem * item);
 209         gboolean (*check_msgnum_validity) (Folder * folder, FolderItem * item);
 210 };
 211
 212 struct _LocalFolder
 213 {
 214         Folder folder;
 215
 216         gchar *rootpath;
 217 };
 218
 219 struct _RemoteFolder
 220 {
 221         Folder folder;
 222
 223         Session *session;
 224 };
 225
 226 #if 0
 227 struct _MaildirFolder
 228 {
 229         LocalFolder lfolder;
 230 };
 231 #endif
 232
 233 struct _FolderItem
 234 {
 235         SpecialFolderItemType stype;
 236
 237         gchar *name;
 238         gchar *path;
 239
 240         time_t mtime;
 241
 242         gint new;
 243         gint unread;
 244         gint total;
 245         gint unreadmarked;
 246
 247         gint last_num;
 248
 249         MsgCache *cache;
 250
 251         /* special flags */
 252         guint no_sub         : 1; /* no child allowed?    */
 253         guint no_select      : 1; /* not selectable?      */
 254         guint collapsed      : 1; /* collapsed item       */
 255         guint threaded       : 1; /* threaded folder view */
 256         guint hide_read_msgs : 1; /* hide read messages   */
 257         guint ret_rcpt       : 1; /* return receipt       */
 258
 259         gint op_count;
 260         guint opened    : 1; /* opened by summary view */
 261         guint need_update    : 1; /* folderview for this folder should be updated */
 262
 263         FolderSortKey sort_key;
 264         FolderSortType sort_type;
 265
 266         FolderItem *parent;
 267
 268         Folder *folder;
 269
 270         PrefsAccount *account;
 271
 272         gboolean apply_sub;
 273
 274         GSList *mark_queue;
 275
 276         gpointer data;
 277
 278         PrefsFolderItem * prefs;
 279 };
 280
 281 typedef struct {
 282         FolderSortKey   sort_key;
 283         FolderSortType  sort_type;
 284         guint           collapsed       : 1;
 285         guint           threaded        : 1;
 286         guint           hide_read_msgs  : 1; /* CLAWS */
 287         guint           ret_rcpt        : 1; /* CLAWS */
 288 } PersistPrefs;
 289
 290 struct _FolderItemUpdateData
 291 {
 292         FolderItem      *item;
 293         gboolean         content_change;
 294 };
 295
 296 Folder     *folder_new                  (FolderType      type,
 297                                          const gchar    *name,
 298                                          const gchar    *path);
 299 void        folder_local_folder_init    (Folder         *folder,
 300                                          const gchar    *name,
 301                                          const gchar    *path);
 302 void        folder_remote_folder_init   (Folder         *folder,
 303                                          const gchar    *name,
 304                                          const gchar    *path);
 305
 306 void        folder_destroy              (Folder         *folder);
 307 void        folder_local_folder_destroy (LocalFolder    *lfolder);
 308 void        folder_remote_folder_destroy(RemoteFolder   *rfolder);
 309
 310 FolderItem *folder_item_new     (Folder         *folder,
 311                                  const gchar    *name,
 312                                  const gchar    *path);
 313 void        folder_item_append  (FolderItem     *parent,
 314                                  FolderItem     *item);
 315 void        folder_item_remove  (FolderItem     *item);
 316 void        folder_item_destroy (FolderItem     *item);
 317
 318 void        folder_set_ui_func  (Folder         *folder,
 319                                  FolderUIFunc    func,
 320                                  gpointer        data);
 321 void        folder_set_name     (Folder         *folder,
 322                                  const gchar    *name);
 323 void        folder_tree_destroy (Folder         *folder);
 324
 325 void   folder_add               (Folder         *folder);
 326
 327 GList *folder_get_list          (void);
 328 gint   folder_read_list         (void);
 329 void   folder_write_list        (void);
 330 void   folder_scan_tree         (Folder *folder);
 331 FolderItem *folder_create_folder(FolderItem     *parent, const gchar *name);
 332 void   folder_update_op_count           (void);
 333 void   folder_func_to_all_folders       (FolderItemFunc function,
 334                                          gpointer data);
 335 void   folder_count_total_msgs  (guint          *new,
 336                                  guint          *unread,
 337                                  guint          *unreadmarked,
 338                                  guint          *total);
 339
 340 Folder     *folder_find_from_path               (const gchar    *path);
 341 Folder     *folder_find_from_name               (const gchar    *name,
 342                                                  FolderType      type);
 343 FolderItem *folder_find_item_from_path          (const gchar    *path);
 344 gchar      *folder_get_identifier               (Folder         *folder);
 345 gchar      *folder_item_get_identifier          (FolderItem     *item);
 346 FolderItem *folder_find_item_from_identifier    (const gchar    *identifier);
 347
 348 Folder     *folder_get_default_folder   (void);
 349 FolderItem *folder_get_default_inbox    (void);
 350 FolderItem *folder_get_default_outbox   (void);
 351 FolderItem *folder_get_default_draft    (void);
 352 FolderItem *folder_get_default_queue    (void);
 353 FolderItem *folder_get_default_trash    (void);
 354 FolderItem *folder_get_default_processing (void);
 355 void folder_set_missing_folders         (void);
 356 void folder_unref_account_all           (PrefsAccount   *account);
 357
 358 gchar *folder_get_path                  (Folder         *folder);
 359 gchar *folder_item_get_path             (FolderItem     *item);
 360
 361 gint   folder_item_open                 (FolderItem     *item);
 362 void   folder_item_close                (FolderItem     *item);
 363 gint   folder_item_scan                 (FolderItem     *item);
 364 void   folder_item_scan_foreach         (GHashTable     *table);
 365 MsgInfo *folder_item_get_msginfo        (FolderItem     *item,
 366                                          gint            num);
 367 MsgInfo *folder_item_get_msginfo_by_msgid(FolderItem    *item,
 368                                          const gchar    *msgid);
 369 GSList *folder_item_get_msg_list        (FolderItem     *item);
 370 gchar *folder_item_fetch_msg            (FolderItem     *item,
 371                                          gint            num);
 372 gint   folder_item_add_msg              (FolderItem     *dest,
 373                                          const gchar    *file,
 374                                          gboolean        remove_source);
 375 gint   folder_item_move_to              (FolderItem     *src,
 376                                          FolderItem     *dest,
 377                                          FolderItem    **new_item);
 378 gint   folder_item_move_msg             (FolderItem     *dest,
 379                                          MsgInfo        *msginfo);
 380 gint   folder_item_move_msgs_with_dest  (FolderItem     *dest,
 381                                          GSList         *msglist);
 382 gint   folder_item_copy_msg             (FolderItem     *dest,
 383                                          MsgInfo        *msginfo);
 384 gint   folder_item_copy_msgs_with_dest  (FolderItem     *dest,
 385                                          GSList         *msglist);
 386 gint   folder_item_remove_msg           (FolderItem     *item,
 387                                          gint            num);
 388 gint   folder_item_remove_msgs          (FolderItem     *item,
 389                                          GSList         *msglist);
 390 gint   folder_item_remove_all_msg       (FolderItem     *item);
 391 gboolean folder_item_is_msg_changed     (FolderItem     *item,
 392                                          MsgInfo        *msginfo);
 393 gchar *folder_item_get_cache_file       (FolderItem     *item);
 394 gchar *folder_item_get_mark_file        (FolderItem     *item);
 395 gchar * folder_item_get_identifier(FolderItem * item);
 396
 397 GHashTable *folder_persist_prefs_new    (Folder *folder);
 398 void folder_persist_prefs_free          (GHashTable *pptable);
 399 const PersistPrefs *folder_get_persist_prefs
 400                                         (GHashTable *pptable, const char *name);
 401
 402 void folder_item_restore_persist_prefs  (FolderItem *item, GHashTable *pptable);
 403 void folder_clean_cache_memory          ();
 404 void folder_item_write_cache            (FolderItem *item);
 405 void folder_item_set_default_flags      (FolderItem *dest, MsgFlags *flags);
 406
 407 void folder_item_apply_processing       (FolderItem *item);
 408
 409 void folder_update_item                 (FolderItem *item,
 410                                          gboolean contentchange);
 411 void folder_update_items_when_required  (gboolean contentchange);
 412 void folder_update_item_recursive       (FolderItem *item,
 413                                          gboolean update_summary);
 414
 415 #endif /* __FOLDER_H__ */