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_TREE_CHANGED = 1 << 0,
 102         FOLDER_NEW_FOLDERITEM = 1 << 1,
 103         FOLDER_REMOVE_FOLDERITEM = 1 << 2,
 104 } FolderUpdateFlags;
 105
 106 typedef enum
 107 {
 108         F_ITEM_UPDATE_MSGCNT = 1 << 0,
 109         F_ITEM_UPDATE_CONTENT = 1 << 1,
 110 } FolderItemUpdateFlags;
 111
 112 typedef void (*FolderUIFunc)            (Folder         *folder,
 113                                          FolderItem     *item,
 114                                          gpointer        data);
 115 typedef void (*FolderDestroyNotify)     (Folder         *folder,
 116                                          FolderItem     *item,
 117                                          gpointer        data);
 118 typedef void (*FolderItemFunc)          (FolderItem     *item,
 119                                          gpointer        data);
 120
 121
 122 #include "folder_item_prefs.h"
 123
 124 #include "procmsg.h"
 125 #include "msgcache.h"
 126 #include "xml.h"
 127 #include "prefs_account.h"
 128
 129 struct _Folder
 130 {
 131         FolderClass *klass;
 132
 133         gchar *name;
 134         PrefsAccount *account;
 135
 136         FolderItem *inbox;
 137         FolderItem *outbox;
 138         FolderItem *draft;
 139         FolderItem *queue;
 140         FolderItem *trash;
 141
 142         FolderUIFunc ui_func;
 143         gpointer     ui_func_data;
 144
 145         GNode *node;
 146
 147         gpointer data;
 148
 149         GHashTable *newsart;
 150 };
 151
 152 struct _FolderClass
 153 {
 154         FolderType  type;
 155         gchar      *idstr;
 156         gchar      *uistr;
 157
 158         /* virtual functions */
 159
 160         /* Folder funtions */
 161         Folder          *(*new_folder)          (const gchar    *name,
 162                                                  const gchar    *path);
 163         void            (*destroy_folder)       (Folder         *folder);
 164         void             (*set_xml)             (Folder         *folder,
 165                                                  XMLTag         *tag);
 166         XMLTag          *(*get_xml)             (Folder         *folder);
 167         gint            (*scan_tree)            (Folder         *folder);
 168
 169         gint            (*create_tree)          (Folder         *folder);
 170
 171         /* FolderItem functions */
 172         FolderItem      *(*item_new)            (Folder         *folder);
 173         void             (*item_destroy)        (Folder         *folder,
 174                                                  FolderItem     *item);
 175         void             (*item_set_xml)        (Folder         *folder,
 176                                                  FolderItem     *item,
 177                                                  XMLTag         *tag);
 178         XMLTag          *(*item_get_xml)        (Folder         *folder,
 179                                                  FolderItem     *item);
 180         gchar           *(*item_get_path)       (Folder         *folder,
 181                                                  FolderItem     *item);
 182         FolderItem      *(*create_folder)       (Folder         *folder,
 183                                                  FolderItem     *parent,
 184                                                  const gchar    *name);
 185         gint             (*rename_folder)       (Folder         *folder,
 186                                                  FolderItem     *item,
 187                                                  const gchar    *name);
 188         gint             (*remove_folder)       (Folder         *folder,
 189                                                  FolderItem     *item);
 190         gint             (*close)               (Folder         *folder,
 191                                                  FolderItem     *item);
 192         gint             (*get_num_list)        (Folder         *folder,
 193                                                  FolderItem     *item,
 194                                                  GSList        **list,
 195                                                  gboolean       *old_uids_valid);
 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        (*scan_required)        (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                                                  MsgFlags       *flags);
 219         gint            (*add_msgs)             (Folder         *folder,
 220                                                  FolderItem     *dest,
 221                                                  GSList         *file_list,
 222                                                  GRelation      *relation);
 223         gint            (*copy_msg)             (Folder         *folder,
 224                                                  FolderItem     *dest,
 225                                                  MsgInfo        *msginfo);
 226         gint            (*copy_msgs)            (Folder         *folder,
 227                                                  FolderItem     *dest,
 228                                                  MsgInfoList    *msglist,
 229                                                  GRelation      *relation);
 230         gint            (*remove_msg)           (Folder         *folder,
 231                                                  FolderItem     *item,
 232                                                  gint            num);
 233         gint            (*remove_all_msg)       (Folder         *folder,
 234                                                  FolderItem     *item);
 235         gboolean        (*is_msg_changed)       (Folder         *folder,
 236                                                  FolderItem     *item,
 237                                                  MsgInfo        *msginfo);
 238         void            (*change_flags)         (Folder         *folder,
 239                                                  FolderItem     *item,
 240                                                  MsgInfo        *msginfo,
 241                                                  MsgPermFlags    newflags);
 242 };
 243
 244 struct _FolderItem
 245 {
 246         SpecialFolderItemType stype;
 247
 248         gchar *name;
 249         gchar *path;
 250
 251         time_t mtime;
 252
 253         gint new_msgs;
 254         gint unread_msgs;
 255         gint total_msgs;
 256         gint unreadmarked_msgs;
 257
 258         gint last_num;
 259
 260         MsgCache *cache;
 261
 262         /* special flags */
 263         guint no_sub         : 1; /* no child allowed?    */
 264         guint no_select      : 1; /* not selectable?      */
 265         guint collapsed      : 1; /* collapsed item       */
 266         guint thread_collapsed      : 1; /* collapsed item       */
 267         guint threaded       : 1; /* threaded folder view */
 268         guint hide_read_msgs : 1; /* hide read messages   */
 269         guint ret_rcpt       : 1; /* return receipt       */
 270
 271         gint op_count;
 272         guint opened         : 1; /* opened by summary view */
 273         FolderItemUpdateFlags update_flags; /* folderview for this folder should be updated */
 274
 275         FolderSortKey sort_key;
 276         FolderSortType sort_type;
 277
 278         GNode *node;
 279
 280         FolderItem *parent;
 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 Folder     *folder_new                  (FolderClass    *type,
 322                                          const gchar    *name,
 323                                          const gchar    *path);
 324 void        folder_init                 (Folder         *folder,
 325                                          const gchar    *name);
 326
 327 void        folder_destroy              (Folder         *folder);
 328
 329 void        folder_set_xml              (Folder          *folder,
 330                                          XMLTag          *tag);
 331 XMLTag     *folder_get_xml              (Folder          *folder);
 332
 333 FolderItem *folder_item_new             (Folder         *folder,
 334                                          const gchar    *name,
 335                                          const gchar    *path);
 336 void        folder_item_append          (FolderItem     *parent,
 337                                          FolderItem     *item);
 338 void        folder_item_remove          (FolderItem     *item);
 339 void        folder_item_remove_children (FolderItem     *item);
 340 void        folder_item_destroy         (FolderItem     *item);
 341
 342 void        folder_item_set_xml         (Folder          *folder,
 343                                          FolderItem      *item,
 344                                          XMLTag          *tag);
 345 XMLTag     *folder_item_get_xml         (Folder          *folder,
 346                                          FolderItem      *item);
 347
 348 void        folder_set_ui_func  (Folder         *folder,
 349                                  FolderUIFunc    func,
 350                                  gpointer        data);
 351 void        folder_set_name     (Folder         *folder,
 352                                  const gchar    *name);
 353 void        folder_tree_destroy (Folder         *folder);
 354
 355 void   folder_add               (Folder         *folder);
 356
 357 GList *folder_get_list          (void);
 358 gint   folder_read_list         (void);
 359 void   folder_write_list        (void);
 360 void   folder_scan_tree         (Folder *folder);
 361 FolderItem *folder_create_folder(FolderItem     *parent, const gchar *name);
 362 void   folder_update_op_count           (void);
 363 void   folder_func_to_all_folders       (FolderItemFunc function,
 364                                          gpointer data);
 365 void   folder_count_total_msgs  (guint          *new_msgs,
 366                                  guint          *unread_msgs,
 367                                  guint          *unreadmarked_msgs,
 368                                  guint          *total_msgs);
 369 gchar *folder_get_status        (GPtrArray      *folders,
 370                                  gboolean        full);
 371
 372 Folder     *folder_find_from_path               (const gchar    *path);
 373 Folder     *folder_find_from_name               (const gchar    *name,
 374                                                  FolderClass    *klass);
 375 FolderItem *folder_find_item_from_path          (const gchar    *path);
 376 FolderClass *folder_get_class_from_string       (const gchar    *str);
 377 gchar      *folder_get_identifier               (Folder         *folder);
 378 gchar      *folder_item_get_identifier          (FolderItem     *item);
 379 FolderItem *folder_find_item_from_identifier    (const gchar    *identifier);
 380 gchar      *folder_item_get_name                (FolderItem     *item);
 381
 382 Folder     *folder_get_default_folder   (void);
 383 FolderItem *folder_get_default_inbox    (void);
 384 FolderItem *folder_get_default_outbox   (void);
 385 FolderItem *folder_get_default_draft    (void);
 386 FolderItem *folder_get_default_queue    (void);
 387 FolderItem *folder_get_default_trash    (void);
 388 FolderItem *folder_get_default_processing (void);
 389 void folder_set_missing_folders         (void);
 390 void folder_unref_account_all           (PrefsAccount   *account);
 391
 392 gchar *folder_item_get_path             (FolderItem     *item);
 393
 394 gint   folder_item_open                 (FolderItem     *item);
 395 gint   folder_item_close                (FolderItem     *item);
 396 gint   folder_item_scan                 (FolderItem     *item);
 397 void   folder_item_scan_foreach         (GHashTable     *table);
 398 MsgInfo *folder_item_get_msginfo        (FolderItem     *item,
 399                                          gint            num);
 400 MsgInfo *folder_item_get_msginfo_by_msgid(FolderItem    *item,
 401                                          const gchar    *msgid);
 402 GSList *folder_item_get_msg_list        (FolderItem     *item);
 403 gchar *folder_item_fetch_msg            (FolderItem     *item,
 404                                          gint            num);
 405 gint   folder_item_add_msg              (FolderItem     *dest,
 406                                          const gchar    *file,
 407                                          MsgFlags       *flags,
 408                                          gboolean        remove_source);
 409 gint   folder_item_add_msgs             (FolderItem     *dest,
 410                                          GSList         *file_list,
 411                                          gboolean        remove_source);
 412 gint   folder_item_move_to              (FolderItem     *src,
 413                                          FolderItem     *dest,
 414                                          FolderItem    **new_item);
 415 gint   folder_item_move_msg             (FolderItem     *dest,
 416                                          MsgInfo        *msginfo);
 417 gint   folder_item_move_msgs            (FolderItem     *dest,
 418                                          GSList         *msglist);
 419 gint   folder_item_copy_msg             (FolderItem     *dest,
 420                                          MsgInfo        *msginfo);
 421 gint   folder_item_copy_msgs            (FolderItem     *dest,
 422                                          GSList         *msglist);
 423 gint   folder_item_remove_msg           (FolderItem     *item,
 424                                          gint            num);
 425 gint   folder_item_remove_msgs          (FolderItem     *item,
 426                                          GSList         *msglist);
 427 gint   folder_item_remove_all_msg       (FolderItem     *item);
 428 void    folder_item_change_msg_flags    (FolderItem     *item,
 429                                          MsgInfo        *msginfo,
 430                                          MsgPermFlags    newflags);
 431 gboolean folder_item_is_msg_changed     (FolderItem     *item,
 432                                          MsgInfo        *msginfo);
 433 gchar *folder_item_get_cache_file       (FolderItem     *item);
 434 gchar *folder_item_get_mark_file        (FolderItem     *item);
 435 gchar * folder_item_get_identifier      (FolderItem * item);
 436
 437 GHashTable *folder_persist_prefs_new    (Folder *folder);
 438 void folder_persist_prefs_free          (GHashTable *pptable);
 439 const PersistPrefs *folder_get_persist_prefs
 440                                         (GHashTable *pptable, const char *name);
 441
 442 void folder_item_restore_persist_prefs  (FolderItem *item, GHashTable *pptable);
 443 void folder_clean_cache_memory          (void);
 444 void folder_item_write_cache            (FolderItem *item);
 445 void folder_item_set_default_flags      (FolderItem *dest, MsgFlags *flags);
 446
 447 void folder_item_apply_processing       (FolderItem *item);
 448
 449 void folder_item_update                 (FolderItem *item,
 450                                          FolderItemUpdateFlags update_flags);
 451 void folder_item_update_recursive       (FolderItem *item,
 452                                          FolderItemUpdateFlags update_flags);
 453 void folder_item_update_freeze          (void);
 454 void folder_item_update_thaw            (void);
 455
 456 #endif /* __FOLDER_H__ */