src/folder.h

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