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