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