* src/folder.[ch]
[claws.git] / 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 void (*FolderUIFunc)            (Folder         *folder,
100                                          FolderItem     *item,
101                                          gpointer        data);
102 typedef void (*FolderDestroyNotify)     (Folder         *folder,
103                                          FolderItem     *item,
104                                          gpointer        data);
105 typedef void (*FolderItemFunc)          (FolderItem     *item,
106                                          gpointer        data);
107
108 struct _Folder
109 {
110         FolderType type;
111
112         gchar *name;
113         PrefsAccount *account;
114
115         FolderItem *inbox;
116         FolderItem *outbox;
117         FolderItem *draft;
118         FolderItem *queue;
119         FolderItem *trash;
120
121         FolderUIFunc ui_func;
122         gpointer     ui_func_data;
123
124         GNode *node;
125
126         gpointer data;
127
128         GHashTable *newsart;
129
130         /* virtual functions */
131 /*
132         GSList * (*get_msg_list)        (Folder         *folder,
133                                          FolderItem     *item,
134                                          gboolean        use_cache);
135 */
136         FolderItem *(*item_new)         (Folder         *folder);
137         void     (*item_destroy)        (Folder         *folder,
138                                          FolderItem     *item);
139         gchar *  (*fetch_msg)           (Folder         *folder,
140                                          FolderItem     *item,
141                                          gint            num);
142         MsgInfo *(*fetch_msginfo)       (Folder         *folder,
143                                          FolderItem     *item,
144                                          gint            num);
145         GSList  *(*fetch_msginfos)      (Folder         *folder,
146                                          FolderItem     *item,
147                                          GSList         *msgnum_list);
148         gint     (*add_msg)             (Folder         *folder,
149                                          FolderItem     *dest,
150                                          const gchar    *file,
151                                          gboolean        remove_source);
152         gint     (*move_msg)            (Folder         *folder,
153                                          FolderItem     *dest,
154                                          MsgInfo        *msginfo);
155         gint     (*move_msgs_with_dest) (Folder         *folder,
156                                          FolderItem     *dest,
157                                          GSList         *msglist);
158         gint     (*copy_msg)            (Folder         *folder,
159                                          FolderItem     *dest,
160                                          MsgInfo        *msginfo);
161         gint     (*copy_msgs_with_dest) (Folder         *folder,
162                                          FolderItem     *dest,
163                                          GSList         *msglist);
164         gint     (*remove_msg)          (Folder         *folder,
165                                          FolderItem     *item,
166                                          gint            num);
167         gint     (*remove_msgs)         (Folder         *folder,
168                                          FolderItem     *item,
169                                          GSList         *msglist);
170         gint     (*remove_all_msg)      (Folder         *folder,
171                                          FolderItem     *item);
172         gboolean (*is_msg_changed)      (Folder         *folder,
173                                          FolderItem     *item,
174                                          MsgInfo        *msginfo);
175         gint     (*scan)                (Folder         *folder);
176         gint     (*get_num_list)        (Folder         *folder,
177                                          FolderItem     *item,
178                                          GSList        **list);
179         void     (*scan_tree)           (Folder         *folder);
180
181         gint     (*create_tree)         (Folder         *folder);
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
191         void     (*destroy)             (Folder         *folder);
192         void     (*update_mark)         (Folder         *folder,
193                                          FolderItem     *item);
194         void     (*change_flags)        (Folder         *folder,
195                                          FolderItem     *item,
196                                          MsgInfo        *info);
197         void     (*finished_copy)       (Folder * folder, FolderItem * item);
198         void     (*finished_remove)     (Folder * folder, FolderItem * item);
199         gboolean (*check_msgnum_validity) (Folder * folder, FolderItem * item);
200 };
201
202 struct _LocalFolder
203 {
204         Folder folder;
205
206         gchar *rootpath;
207 };
208
209 struct _RemoteFolder
210 {
211         Folder folder;
212
213         Session *session;
214 };
215
216 #if 0
217 struct _MaildirFolder
218 {
219         LocalFolder lfolder;
220 };
221 #endif
222
223 struct _FolderItem
224 {
225         SpecialFolderItemType stype;
226
227         gchar *name;
228         gchar *path;
229
230         time_t mtime;
231
232         gint new;
233         gint unread;
234         gint total;
235
236         gint last_num;
237
238         MsgCache *cache;
239
240         /* special flags */
241         guint no_sub         : 1; /* no child allowed?    */
242         guint no_select      : 1; /* not selectable?      */
243         guint collapsed      : 1; /* collapsed item       */
244         guint threaded       : 1; /* threaded folder view */
245         guint hide_read_msgs : 1; /* hide read messages   */
246         guint ret_rcpt       : 1; /* return receipt       */
247
248         gint op_count;
249         guint opened    : 1; /* opened by summary view */
250         guint need_update    : 1; /* folderview for this folder should be updated */
251
252         FolderSortKey sort_key;
253         FolderSortType sort_type;
254
255         FolderItem *parent;
256
257         Folder *folder;
258
259         PrefsAccount *account;
260
261         gboolean apply_sub;
262         
263         GSList *mark_queue;
264
265         gpointer data;
266
267         PrefsFolderItem * prefs;
268 };
269
270 typedef struct {
271         FolderSortKey   sort_key;
272         FolderSortType  sort_type;
273         guint           collapsed       : 1;
274         guint           threaded        : 1;
275         guint           hide_read_msgs  : 1; /* CLAWS */
276         guint           ret_rcpt        : 1; /* CLAWS */
277 } PersistPrefs;
278
279 Folder     *folder_new                  (FolderType      type,
280                                          const gchar    *name,
281                                          const gchar    *path);
282 void        folder_local_folder_init    (Folder         *folder,
283                                          const gchar    *name,
284                                          const gchar    *path);
285 void        folder_remote_folder_init   (Folder         *folder,
286                                          const gchar    *name,
287                                          const gchar    *path);
288
289 void        folder_destroy              (Folder         *folder);
290 void        folder_local_folder_destroy (LocalFolder    *lfolder);
291 void        folder_remote_folder_destroy(RemoteFolder   *rfolder);
292
293 FolderItem *folder_item_new     (Folder         *folder,
294                                  const gchar    *name,
295                                  const gchar    *path);
296 void        folder_item_append  (FolderItem     *parent,
297                                  FolderItem     *item);
298 void        folder_item_remove  (FolderItem     *item);
299 void        folder_item_destroy (FolderItem     *item);
300
301 void        folder_set_ui_func  (Folder         *folder,
302                                  FolderUIFunc    func,
303                                  gpointer        data);
304 void        folder_set_name     (Folder         *folder,
305                                  const gchar    *name);
306 void        folder_tree_destroy (Folder         *folder);
307
308 void   folder_add               (Folder         *folder);
309
310 GList *folder_get_list          (void);
311 gint   folder_read_list         (void);
312 void   folder_write_list        (void);
313 void   folder_scan_tree         (Folder *folder);
314 FolderItem *folder_create_folder(FolderItem     *parent, const gchar *name);
315 void   folder_update_op_count           (void);
316 void   folder_func_to_all_folders       (FolderItemFunc function,
317                                          gpointer data);
318 void   folder_count_total_msgs  (guint          *new,
319                                  guint          *unread,
320                                  guint          *total);
321
322 Folder     *folder_find_from_path               (const gchar    *path);
323 Folder     *folder_find_from_name               (const gchar    *name,
324                                                  FolderType      type);
325 FolderItem *folder_find_item_from_path          (const gchar    *path);
326 gchar      *folder_get_identifier               (Folder         *folder);
327 gchar      *folder_item_get_identifier          (FolderItem     *item);
328 FolderItem *folder_find_item_from_identifier    (const gchar    *identifier);
329
330 Folder     *folder_get_default_folder   (void);
331 FolderItem *folder_get_default_inbox    (void);
332 FolderItem *folder_get_default_outbox   (void);
333 FolderItem *folder_get_default_draft    (void);
334 FolderItem *folder_get_default_queue    (void);
335 FolderItem *folder_get_default_trash    (void);
336 FolderItem *folder_get_default_processing (void);
337 void folder_set_missing_folders         (void);
338 void folder_unref_account_all           (PrefsAccount   *account);
339
340 gchar *folder_get_path                  (Folder         *folder);
341 gchar *folder_item_get_path             (FolderItem     *item);
342
343 gint   folder_item_scan                 (FolderItem     *item);
344 void   folder_item_scan_foreach         (GHashTable     *table);
345 MsgInfo *folder_item_fetch_msginfo      (FolderItem     *item,
346                                          gint            num);
347 MsgInfo *folder_item_fetch_msginfo_by_id(FolderItem     *item,
348                                          const gchar    *msgid);
349 GSList *folder_item_get_msg_list        (FolderItem     *item);
350 gchar *folder_item_fetch_msg            (FolderItem     *item,
351                                          gint            num);
352 gint   folder_item_add_msg              (FolderItem     *dest,
353                                          const gchar    *file,
354                                          gboolean        remove_source);
355 gint   folder_item_move_msg             (FolderItem     *dest,
356                                          MsgInfo        *msginfo);
357 gint   folder_item_move_msgs_with_dest  (FolderItem     *dest,
358                                          GSList         *msglist);
359 gint   folder_item_copy_msg             (FolderItem     *dest,
360                                          MsgInfo        *msginfo);
361 gint   folder_item_copy_msgs_with_dest  (FolderItem     *dest,
362                                          GSList         *msglist);
363 gint   folder_item_remove_msg           (FolderItem     *item,
364                                          gint            num);
365 gint   folder_item_remove_msgs          (FolderItem     *item,
366                                          GSList         *msglist);
367 gint   folder_item_remove_all_msg       (FolderItem     *item);
368 gboolean folder_item_is_msg_changed     (FolderItem     *item,
369                                          MsgInfo        *msginfo);
370 gchar *folder_item_get_cache_file       (FolderItem     *item);
371 gchar *folder_item_get_mark_file        (FolderItem     *item);
372 gchar * folder_item_get_identifier(FolderItem * item);
373 FolderItem * folder_find_item_from_identifier(const gchar *identifier);
374
375 GHashTable *folder_persist_prefs_new    (Folder *folder);
376 void folder_persist_prefs_free          (GHashTable *pptable);
377 const PersistPrefs *folder_get_persist_prefs
378                                         (GHashTable *pptable, const char *name);
379
380 void folder_item_restore_persist_prefs  (FolderItem *item, GHashTable *pptable);
381 void folder_clean_cache_memory          ();
382 void folder_item_write_cache            (FolderItem *item);
383 void folder_item_set_default_flags      (FolderItem *dest, MsgFlags *flags);
384
385 void folder_item_apply_processing       (FolderItem *item);
386
387 #endif /* __FOLDER_H__ */