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