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
  40 #define FOLDER(obj)             ((Folder *)obj)
  41 #define FOLDER_TYPE(obj)        (FOLDER(obj)->type)
  42
  43 #define LOCAL_FOLDER(obj)       ((LocalFolder *)obj)
  44 #define REMOTE_FOLDER(obj)      ((RemoteFolder *)obj)
  45
  46 #define FOLDER_IS_LOCAL(obj)    (FOLDER_TYPE(obj) == F_MH      || \
  47                                  FOLDER_TYPE(obj) == F_MBOX    || \
  48                                  FOLDER_TYPE(obj) == F_MAILDIR)
  49
  50 #if 0
  51 #define MAILDIR_FOLDER(obj)     ((MaildirFolder *)obj)
  52 #endif
  53
  54 #define FOLDER_ITEM(obj)        ((FolderItem *)obj)
  55
  56 typedef enum
  57 {
  58         F_MH,
  59         F_MBOX,
  60         F_MAILDIR,
  61         F_IMAP,
  62         F_NEWS,
  63         F_UNKNOWN
  64 } FolderType;
  65
  66 typedef enum
  67 {
  68         F_NORMAL,
  69         F_INBOX,
  70         F_OUTBOX,
  71         F_DRAFT,
  72         F_QUEUE,
  73         F_TRASH
  74 } SpecialFolderItemType;
  75
  76 typedef void (*FolderUIFunc)            (Folder         *folder,
  77                                          FolderItem     *item,
  78                                          gpointer        data);
  79 typedef void (*FolderDestroyNotify)     (Folder         *folder,
  80                                          FolderItem     *item,
  81                                          gpointer        data);
  82
  83 struct _Folder
  84 {
  85         FolderType type;
  86
  87         gchar *name;
  88         PrefsAccount *account;
  89
  90         FolderItem *inbox;
  91         FolderItem *outbox;
  92         FolderItem *draft;
  93         FolderItem *queue;
  94         FolderItem *trash;
  95
  96         FolderUIFunc ui_func;
  97         gpointer     ui_func_data;
  98
  99         GNode *node;
 100
 101         gpointer data;
 102
 103         /* virtual functions */
 104         GSList * (*get_msg_list)        (Folder         *folder,
 105                                          FolderItem     *item,
 106                                          gboolean        use_cache);
 107         gchar *  (*fetch_msg)           (Folder         *folder,
 108                                          FolderItem     *item,
 109                                          gint            num);
 110         gint     (*add_msg)             (Folder         *folder,
 111                                          FolderItem     *dest,
 112                                          const gchar    *file,
 113                                          gboolean        remove_source);
 114         gint     (*move_msg)            (Folder         *folder,
 115                                          FolderItem     *dest,
 116                                          MsgInfo        *msginfo);
 117         gint     (*move_msgs_with_dest) (Folder         *folder,
 118                                          FolderItem     *dest,
 119                                          GSList         *msglist);
 120         gint     (*copy_msg)            (Folder         *folder,
 121                                          FolderItem     *dest,
 122                                          MsgInfo        *msginfo);
 123         gint     (*copy_msgs_with_dest) (Folder         *folder,
 124                                          FolderItem     *dest,
 125                                          GSList         *msglist);
 126         gint     (*remove_msg)          (Folder         *folder,
 127                                          FolderItem     *item,
 128                                          gint            num);
 129         gint     (*remove_all_msg)      (Folder         *folder,
 130                                          FolderItem     *item);
 131         gboolean (*is_msg_changed)      (Folder         *folder,
 132                                          FolderItem     *item,
 133                                          MsgInfo        *msginfo);
 134         void     (*scan)                (Folder         *folder,
 135                                          FolderItem     *item);
 136         void     (*scan_tree)           (Folder         *folder);
 137
 138         gint     (*create_tree)         (Folder         *folder);
 139         FolderItem * (*create_folder)   (Folder         *folder,
 140                                          FolderItem     *parent,
 141                                          const gchar    *name);
 142         gint     (*rename_folder)       (Folder         *folder,
 143                                          FolderItem     *item,
 144                                          const gchar    *name);
 145         gint     (*remove_folder)       (Folder         *folder,
 146                                          FolderItem     *item);
 147         void     (*update_mark)         (Folder         *folder,
 148                                          FolderItem     *item);
 149         void     (*change_flags)        (Folder         *folder,
 150                                          FolderItem     *item,
 151                                          MsgInfo        *info);
 152         void     (*finished_copy)       (Folder * folder, FolderItem * item);
 153         void     (*finished_remove)       (Folder * folder, FolderItem * item);
 154 };
 155
 156 struct _LocalFolder
 157 {
 158         Folder folder;
 159
 160         gchar *rootpath;
 161 };
 162
 163 struct _RemoteFolder
 164 {
 165         Folder folder;
 166
 167         Session *session;
 168 };
 169
 170 #if 0
 171 struct _MaildirFolder
 172 {
 173         LocalFolder lfolder;
 174 };
 175 #endif
 176
 177 struct _FolderItem
 178 {
 179         SpecialFolderItemType stype;
 180
 181         gchar *name;
 182         gchar *path;
 183         PrefsAccount *account;
 184
 185         time_t mtime;
 186
 187         gint new;
 188         gint unread;
 189         gint total;
 190
 191         gint last_num;
 192
 193         /* special flags */
 194         guint no_sub         : 1; /* no child allowed?    */
 195         guint no_select      : 1; /* not selectable?      */
 196         guint collapsed      : 1; /* collapsed item       */
 197         guint threaded       : 1; /* threaded folder view */
 198         guint hide_read_msgs : 1; /* hide read messages   */
 199         guint ret_rcpt       : 1; /* return receipt       */
 200
 201         gint op_count;
 202
 203         FolderItem *parent;
 204
 205         Folder *folder;
 206
 207         gpointer data;
 208
 209         PrefsFolderItem * prefs;
 210 };
 211
 212 typedef struct {
 213         guint   collapsed       : 1;
 214         guint   threaded        : 1;
 215         guint   hide_read_msgs  : 1; /* CLAWS */
 216         guint   ret_rcpt        : 1; /* CLAWS */
 217 } PersistPrefs;
 218
 219 Folder     *folder_new                  (FolderType      type,
 220                                          const gchar    *name,
 221                                          const gchar    *path);
 222 void        folder_local_folder_init    (Folder         *folder,
 223                                          const gchar    *name,
 224                                          const gchar    *path);
 225 void        folder_remote_folder_init   (Folder         *folder,
 226                                          const gchar    *name,
 227                                          const gchar    *path);
 228
 229 void        folder_destroy              (Folder         *folder);
 230 void        folder_local_folder_destroy (LocalFolder    *lfolder);
 231 void        folder_remote_folder_destroy(RemoteFolder   *rfolder);
 232
 233 FolderItem *folder_item_new     (const gchar    *name,
 234                                  const gchar    *path);
 235 void        folder_item_append  (FolderItem     *parent,
 236                                  FolderItem     *item);
 237 void        folder_item_remove  (FolderItem     *item);
 238 void        folder_item_destroy (FolderItem     *item);
 239
 240 void        folder_set_ui_func  (Folder         *folder,
 241                                  FolderUIFunc    func,
 242                                  gpointer        data);
 243 void        folder_set_name     (Folder         *folder,
 244                                  const gchar    *name);
 245 void        folder_tree_destroy (Folder         *folder);
 246
 247 void   folder_add               (Folder         *folder);
 248
 249 GList *folder_get_list          (void);
 250 gint   folder_read_list         (void);
 251 void   folder_write_list        (void);
 252 void   folder_update_op_count           (void);
 253 void   folder_count_total_msgs  (guint          *new,
 254                                  guint          *unread,
 255                                  guint          *total);
 256
 257 Folder     *folder_find_from_path       (const gchar    *path);
 258 FolderItem *folder_find_item_from_path  (const gchar    *path);
 259 Folder     *folder_get_default_folder   (void);
 260 FolderItem *folder_get_default_inbox    (void);
 261 FolderItem *folder_get_default_outbox   (void);
 262 FolderItem *folder_get_default_draft    (void);
 263 FolderItem *folder_get_default_queue    (void);
 264 FolderItem *folder_get_default_trash    (void);
 265 FolderItem *folder_get_default_processing (void);
 266
 267 gchar *folder_item_get_path             (FolderItem     *item);
 268 void   folder_item_scan                 (FolderItem     *item);
 269 void   folder_item_scan_foreach         (GHashTable     *table);
 270 gchar *folder_item_fetch_msg            (FolderItem     *item,
 271                                          gint            num);
 272 gint   folder_item_add_msg              (FolderItem     *dest,
 273                                          const gchar    *file,
 274                                          gboolean        remove_source);
 275 gint   folder_item_move_msg             (FolderItem     *dest,
 276                                          MsgInfo        *msginfo);
 277 gint   folder_item_move_msgs_with_dest  (FolderItem     *dest,
 278                                          GSList         *msglist);
 279 gint   folder_item_copy_msg             (FolderItem     *dest,
 280                                          MsgInfo        *msginfo);
 281 gint   folder_item_copy_msgs_with_dest  (FolderItem     *dest,
 282                                          GSList         *msglist);
 283 gint   folder_item_remove_msg           (FolderItem     *item,
 284                                          gint            num);
 285 gint   folder_item_remove_msgs          (FolderItem     *item,
 286                                          GSList         *msglist);
 287 gint   folder_item_remove_all_msg       (FolderItem     *item);
 288 gboolean folder_item_is_msg_changed     (FolderItem     *item,
 289                                          MsgInfo        *msginfo);
 290 gchar *folder_item_get_cache_file       (FolderItem     *item);
 291 gchar *folder_item_get_mark_file        (FolderItem     *item);
 292 gchar * folder_item_get_identifier(FolderItem * item);
 293 FolderItem * folder_find_item_from_identifier(const gchar *identifier);
 294
 295 GHashTable *folder_persist_prefs_new    (Folder *folder);
 296 void folder_persist_prefs_free          (GHashTable *pptable);
 297 const PersistPrefs *folder_get_persist_prefs
 298                                         (GHashTable *pptable, const char *name);
 299
 300 void folder_item_restore_persist_prefs  (FolderItem *item, GHashTable *pptable);
 301
 302 #endif /* __FOLDER_H__ */