89fd67f51cee886b37a256c1215b6a9be52cf332
[claws.git] / src / procmsg.h
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2011 Hiroyuki Yamamoto and the Claws Mail team
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 3 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, see <http://www.gnu.org/licenses/>.
17  * 
18  */
19
20 #ifndef __PROCMSG_H__
21 #define __PROCMSG_H__
22
23 #ifdef HAVE_CONFIG_H
24 #  include "config.h"
25 #endif
26
27 #include <glib.h>
28 #include <stdio.h>
29 #include <time.h>
30 #include <sys/types.h>
31 #include <string.h>
32 #include "utils.h"
33
34 typedef struct _MsgInfo                 MsgInfo;
35 typedef struct _MsgFlags                MsgFlags;
36 typedef struct _MsgFileInfo             MsgFileInfo;
37 typedef struct _MsgInfoUpdate           MsgInfoUpdate;
38 typedef struct _MailFilteringData       MailFilteringData;
39
40 typedef struct _MsgInfoExtraData        MsgInfoExtraData;
41
42 typedef GSList MsgInfoList;
43 typedef GSList MsgNumberList;
44
45 #define MSG_NEW                 (1U << 0)
46 #define MSG_UNREAD              (1U << 1)
47 #define MSG_MARKED              (1U << 2)
48 #define MSG_DELETED             (1U << 3)
49 #define MSG_REPLIED             (1U << 4)
50 #define MSG_FORWARDED           (1U << 5)
51
52 #define MSG_CLABEL_SBIT (6)             /* start bit of color label */
53 /* color labels use 4 bits: 6, 7, 8, 9; bit weight is 7<8<9<6,
54   IOW the color label value itself must be computed from MsgPermFlags
55   bits like this:
56   value =   bit-7-value*2^0
57           + bit-8-value*2^1
58           + bit-9-value*2^2
59           + bit-6-value*2^3 */
60
61 /* color label permflags masks */
62 #define MAKE_MSG_CLABEL(x, h, m, l)     (\
63                                          ((x) << (MSG_CLABEL_SBIT + 0)) | \
64                                          ((h) << (MSG_CLABEL_SBIT + 3)) | \
65                                          ((m) << (MSG_CLABEL_SBIT + 2)) | \
66                                          ((l) << (MSG_CLABEL_SBIT + 1)))
67 #define MSG_CLABEL_NONE         MAKE_MSG_CLABEL(0U, 0U, 0U, 0U)
68 #define MSG_CLABEL_1            MAKE_MSG_CLABEL(0U, 0U, 0U, 1U)
69 #define MSG_CLABEL_2            MAKE_MSG_CLABEL(0U, 0U, 1U, 0U)
70 #define MSG_CLABEL_3            MAKE_MSG_CLABEL(0U, 0U, 1U, 1U)
71 #define MSG_CLABEL_4            MAKE_MSG_CLABEL(0U, 1U, 0U, 0U)
72 #define MSG_CLABEL_5            MAKE_MSG_CLABEL(0U, 1U, 0U, 1U)
73 #define MSG_CLABEL_6            MAKE_MSG_CLABEL(0U, 1U, 1U, 0U)
74 #define MSG_CLABEL_7            MAKE_MSG_CLABEL(0U, 1U, 1U, 1U)
75 #define MSG_CLABEL_8            MAKE_MSG_CLABEL(1U, 0U, 0U, 0U)
76 #define MSG_CLABEL_9            MAKE_MSG_CLABEL(1U, 0U, 0U, 1U)
77 #define MSG_CLABEL_10           MAKE_MSG_CLABEL(1U, 0U, 1U, 0U)
78 #define MSG_CLABEL_11           MAKE_MSG_CLABEL(1U, 0U, 1U, 1U)
79 #define MSG_CLABEL_12           MAKE_MSG_CLABEL(1U, 1U, 0U, 0U)
80 #define MSG_CLABEL_13           MAKE_MSG_CLABEL(1U, 1U, 0U, 1U)
81 #define MSG_CLABEL_14           MAKE_MSG_CLABEL(1U, 1U, 1U, 0U)
82 #define MSG_CLABEL_15           MAKE_MSG_CLABEL(1U, 1U, 1U, 1U)
83 #define MSG_CLABEL_FLAG_MASK    (MSG_CLABEL_15)
84
85 #define MSG_IGNORE_THREAD       (1U << 10)   /* ignore threads */
86 #define MSG_LOCKED              (1U << 11)   /* msg is locked  */
87 #define MSG_RETRCPT_SENT        (1U << 12)   /* new one */ 
88 #define MSG_SPAM                (1U << 13)   /* new one */ 
89 #define MSG_POSTFILTERED        (1U << 14)
90 #define MSG_WATCH_THREAD        (1U << 15)   /* watch threads */
91 #define MSG_FULLY_CACHED        (1U << 16)   /* IMAP: fully cached */
92 #define MSG_RETRCPT_GOT         (1U << 17)   /* got return receipt */
93         
94 /* RESERVED */
95 #define MSG_RESERVED_CLAWS      (1U << 30)   /* for claws-mail */
96 #define MSG_RESERVED            (1U << 31)
97
98 typedef guint32 MsgPermFlags;
99
100 #define MSG_MOVE                (1U << 0)
101 #define MSG_COPY                (1U << 1)
102 #define MSG_MOVE_DONE           (1U << 15)              
103 #define MSG_QUEUED              (1U << 16)
104 #define MSG_DRAFT               (1U << 17)
105 #define MSG_ENCRYPTED           (1U << 18)
106 #define MSG_IMAP                (1U << 19)
107 #define MSG_NEWS                (1U << 20)
108 #define MSG_SIGNED              (1U << 21)
109 #define MSG_MULTIPART           (1U << 29)
110 #define MSG_HAS_ATTACHMENT      (1U << 30)
111 #define MSG_SCANNED             (1U << 31)
112
113 typedef guint32 MsgTmpFlags;
114
115 #define MSG_CACHED_FLAG_MASK    (MSG_MULTIPART | MSG_ENCRYPTED | MSG_SIGNED | MSG_HAS_ATTACHMENT | MSG_SCANNED)
116
117 #define MSG_SET_FLAGS(msg, flags)       { (msg) |= (flags); }
118 #define MSG_UNSET_FLAGS(msg, flags)     { (msg) &= ~(flags); }
119 #define MSG_SET_PERM_FLAGS(msg, flags) \
120         MSG_SET_FLAGS((msg).perm_flags, flags)
121 #define MSG_SET_TMP_FLAGS(msg, flags) \
122         MSG_SET_FLAGS((msg).tmp_flags, flags)
123 #define MSG_UNSET_PERM_FLAGS(msg, flags) \
124         MSG_UNSET_FLAGS((msg).perm_flags, flags)
125 #define MSG_UNSET_TMP_FLAGS(msg, flags) \
126         MSG_UNSET_FLAGS((msg).tmp_flags, flags)
127
128 #define MSG_IS_NEW(msg)                 (((msg).perm_flags & MSG_NEW) != 0)
129 #define MSG_IS_UNREAD(msg)              (((msg).perm_flags & MSG_UNREAD) != 0)
130 #define MSG_IS_MARKED(msg)              (((msg).perm_flags & MSG_MARKED) != 0)
131 #define MSG_IS_DELETED(msg)             (((msg).perm_flags & MSG_DELETED) != 0)
132 #define MSG_IS_REPLIED(msg)             (((msg).perm_flags & MSG_REPLIED) != 0)
133 #define MSG_IS_LOCKED(msg)              (((msg).perm_flags & MSG_LOCKED) != 0)
134 #define MSG_IS_FORWARDED(msg)           (((msg).perm_flags & MSG_FORWARDED) != 0)
135 #define MSG_IS_POSTFILTERED(msg)        (((msg).perm_flags & MSG_POSTFILTERED) != 0)
136
137 /* color label decoding/encoding (permflag storage bits <-> color list index value)*/
138 #define MSG_COLORLABEL_TO_FLAGS(val) (((((guint)(val)) & 7) << (MSG_CLABEL_SBIT+1)) \
139                                                                           | (((guint)(val) & 8) << (MSG_CLABEL_SBIT-3)))
140 #define MSG_COLORLABEL_FROM_FLAGS(val) ((((guint)(val) >> (MSG_CLABEL_SBIT+1)) & 7 ) \
141                                                                                 | (((guint)(val) >> (MSG_CLABEL_SBIT-3)) & 8))
142 #define MSG_GET_COLORLABEL(msg)         (((msg).perm_flags & MSG_CLABEL_FLAG_MASK))
143 #define MSG_GET_COLORLABEL_VALUE(msg)   (MSG_COLORLABEL_FROM_FLAGS(MSG_GET_COLORLABEL(msg)))
144 #define MSG_SET_COLORLABEL_VALUE(msg, val)      MSG_SET_PERM_FLAGS(msg, MSG_COLORLABEL_TO_FLAGS(val))
145
146 #define MSG_IS_MOVE(msg)                (((msg).tmp_flags & MSG_MOVE) != 0)
147 #define MSG_IS_COPY(msg)                (((msg).tmp_flags & MSG_COPY) != 0)
148 #define MSG_IS_MOVE_DONE(msg)           (((msg).tmp_flags & MSG_MOVE_DONE) != 0)
149
150 #define MSG_IS_QUEUED(msg)              (((msg).tmp_flags & MSG_QUEUED) != 0)
151 #define MSG_IS_DRAFT(msg)               (((msg).tmp_flags & MSG_DRAFT) != 0)
152 #define MSG_IS_ENCRYPTED(msg)           (((msg).tmp_flags & MSG_ENCRYPTED) != 0)
153 #define MSG_IS_SIGNED(msg)              (((msg).tmp_flags & MSG_SIGNED) != 0)
154 #define MSG_IS_IMAP(msg)                (((msg).tmp_flags & MSG_IMAP) != 0)
155 #define MSG_IS_NEWS(msg)                (((msg).tmp_flags & MSG_NEWS) != 0)
156 #define MSG_IS_MULTIPART(msg)           (((msg).tmp_flags & MSG_MULTIPART) != 0)
157 #define MSG_IS_WITH_ATTACHMENT(msg)     (((msg).tmp_flags & MSG_HAS_ATTACHMENT) != 0)
158 #define MSG_IS_SCANNED(msg)             (((msg).tmp_flags & MSG_SCANNED) != 0)
159
160 /* Claws related flags */
161 #define MSG_IS_REALLY_DELETED(msg)      (((msg).perm_flags & MSG_REALLY_DELETED) != 0)
162 #define MSG_IS_IGNORE_THREAD(msg)       (((msg).perm_flags & MSG_IGNORE_THREAD) != 0)
163 #define MSG_IS_RETRCPT_PENDING(msg)     (((msg).perm_flags & MSG_RETRCPT_PENDING) != 0)
164 #define MSG_IS_RETRCPT_SENT(msg)        (((msg).perm_flags & MSG_RETRCPT_SENT) != 0)
165 #define MSG_IS_RETRCPT_GOT(msg)         (((msg).perm_flags & MSG_RETRCPT_GOT) != 0)
166 #define MSG_IS_SPAM(msg)                (((msg).perm_flags & MSG_SPAM) != 0)
167 #define MSG_IS_WATCH_THREAD(msg)        (((msg).perm_flags & MSG_WATCH_THREAD) != 0)
168 #define MSG_IS_FULLY_CACHED(msg)        (((msg).perm_flags & MSG_FULLY_CACHED) != 0)
169
170 #define MSGINFO_UPDATE_HOOKLIST "msginfo_update"
171 #define MAIL_FILTERING_HOOKLIST "mail_filtering_hooklist"
172 #define MAIL_LISTFILTERING_HOOKLIST "mail_listfiltering_hooklist"
173 #define MAIL_POSTFILTERING_HOOKLIST "mail_postfiltering_hooklist"
174
175 typedef enum {
176         MSGINFO_UPDATE_FLAGS = 1 << 0,
177         MSGINFO_UPDATE_DELETED = 1 << 1
178 } MsgInfoUpdateFlags;
179
180 #include "procmime.h"
181 #include "prefs_filtering.h"
182 #include "folder.h"
183
184 struct _MsgFlags
185 {
186         MsgPermFlags perm_flags;
187         MsgTmpFlags  tmp_flags;
188 };
189
190 typedef enum {
191         IS_NOTHING = 0,
192         IS_MOVE,
193         IS_COPY,
194         IS_DELE
195 } FiltOp;
196
197 /* *********************************************************** *
198  * WARNING: When adding or removing members to this structure, *
199  * be sure to update procmsg.c::procmsg_msginfo_memusage()  to *
200  * avoid underestimating cache memory usage - especially since *
201  * this would cause an overflow and metadata loss when writing *
202  * the cache to disk.                                          *
203  * *********************************************************** */
204 struct _MsgInfo
205 {
206         guint refcnt;
207
208         guint  msgnum;
209         goffset  size;
210         time_t mtime;
211         time_t date_t;
212         time_t thread_date;
213
214         MsgFlags flags;
215
216         gchar *fromname;
217
218         gchar *date;
219         gchar *from;
220         gchar *to;
221         gchar *cc;
222         gchar *newsgroups;
223         gchar *subject;
224         gchar *msgid;
225         gchar *inreplyto;
226         gchar *xref;
227
228         FolderItem *folder;
229         FolderItem *to_folder;
230
231         FolderItem *to_filter_folder;   
232         FiltOp filter_op;
233
234         GSList *references;
235         gchar *fromspace;
236
237         gint score;
238
239         /* used only for encrypted messages */
240         gchar *plaintext_file;
241         
242         gint hidden;
243
244         /* used only for partially received messages */
245         gint total_size;
246         gint planned_download;
247
248         GSList *tags;
249
250         MsgInfoExtraData *extradata;
251 };
252
253 struct _MsgInfoExtraData
254 {
255         gchar *xface;
256         gchar *face;
257
258         gchar *dispositionnotificationto;
259         gchar *returnreceiptto;
260
261         /* used only for partially received messages */
262         gchar *partial_recv;
263         gchar *account_server;
264         gchar *account_login;
265
266         /* Mailing list support */
267         gchar *list_post;
268         gchar *list_subscribe;
269         gchar *list_unsubscribe;
270         gchar *list_help;
271         gchar *list_archive;
272         gchar *list_owner;
273 };
274
275 struct _MsgFileInfo
276 {
277         MsgInfo *msginfo;
278         gchar *file;
279         MsgFlags *flags;
280 };
281
282 struct _MsgInfoUpdate {
283         MsgInfo *msginfo;
284         MsgInfoUpdateFlags flags;
285 };
286
287 struct _MailFilteringData
288 {
289         MsgInfo *msginfo;
290         GSList  *msglist;
291         GSList  *filtered;
292         GSList  *unfiltered;
293         PrefsAccount *account;
294 };
295
296 GSList *procmsg_read_cache              (FolderItem     *item,
297                                          gboolean        scan_file);
298 void    procmsg_msg_list_free           (GSList         *mlist);
299 void    procmsg_get_mark_sum            (const gchar    *folder,
300                                          gint           *new_msgs,
301                                          gint           *unread_msgs,
302                                          gint           *total_msgs,
303                                          gint           *min,
304                                          gint           *max,
305                                          gint            first);
306
307 GNode  *procmsg_get_thread_tree         (GSList         *mlist);
308
309 gint    procmsg_move_messages           (GSList         *mlist);
310 void    procmsg_copy_messages           (GSList         *mlist);
311
312 /* return path is locale charset */
313 gchar  *procmsg_get_message_file_path   (MsgInfo        *msginfo);
314 gchar  *procmsg_get_message_file        (MsgInfo        *msginfo);
315 gchar  *procmsg_get_message_file_full   (MsgInfo        *msginfo, 
316                                          gboolean        get_headers,
317                                          gboolean        get_body);
318 GSList *procmsg_get_message_file_list   (MsgInfoList    *mlist);
319 void    procmsg_message_file_list_free  (MsgInfoList    *file_list);
320 FILE   *procmsg_open_message            (MsgInfo        *msginfo);
321 gboolean procmsg_msg_exist              (MsgInfo        *msginfo);
322
323 void    procmsg_get_filter_keyword      (MsgInfo          *msginfo,
324                                          gchar           **header,
325                                          gchar           **key,
326                                          PrefsFilterType   type);
327
328 void    procmsg_empty_all_trash         (void);
329
330 gint    procmsg_send_queue              (FolderItem     *queue,
331                                          gboolean        save_msgs,
332                                          gchar          **errstr);
333 gboolean procmsg_queue_lock             (gchar          **errstr);
334 void     procmsg_queue_unlock           (void);
335 gboolean procmsg_queue_is_empty (FolderItem *queue);
336 void    procmsg_print_message           (MsgInfo        *msginfo,
337                                          const gchar    *cmdline);
338
339 MsgInfo *procmsg_msginfo_new            ();
340 MsgInfo *procmsg_msginfo_new_ref        (MsgInfo        *msginfo);
341 MsgInfo *procmsg_msginfo_copy           (MsgInfo        *msginfo);
342 MsgInfo *procmsg_msginfo_get_full_info  (MsgInfo        *msginfo);
343 MsgInfo *procmsg_msginfo_get_full_info_from_file
344                                         (MsgInfo *msginfo, 
345                                         const gchar *file);
346 void     procmsg_msginfo_free           (MsgInfo        *msginfo);
347 guint    procmsg_msginfo_memusage       (MsgInfo        *msginfo);
348
349 gint procmsg_send_message_queue_with_lock(const gchar *file,
350                                           gchar **errstr,
351                                           FolderItem *queue,
352                                           gint msgnum,
353                                           gboolean *queued_removed);
354
355 gint procmsg_send_message_queue         (const gchar *file,
356                                          gchar **errstr,
357                                          FolderItem *queue, 
358                                          gint msgnum,
359                                          gboolean *queued_removed);
360
361 void procmsg_msginfo_set_flags          (MsgInfo *msginfo,
362                                          MsgPermFlags perm_flags,
363                                          MsgTmpFlags tmp_flags);
364 void procmsg_msginfo_unset_flags        (MsgInfo *msginfo,
365                                          MsgPermFlags perm_flags,
366                                          MsgTmpFlags tmp_flags);
367 void procmsg_msginfo_change_flags       (MsgInfo *msginfo, 
368                                          MsgPermFlags add_perm_flags, 
369                                          MsgTmpFlags add_tmp_flags,
370                                          MsgPermFlags rem_perm_flags, 
371                                          MsgTmpFlags rem_tmp_flags);
372 gint procmsg_remove_special_headers     (const gchar    *in, 
373                                          const gchar    *out);
374
375 gboolean procmsg_msg_has_flagged_parent (MsgInfo        *info,
376                                          MsgPermFlags    perm_flags);
377 gboolean procmsg_msg_has_marked_parent  (MsgInfo        *info);
378 void procmsg_msginfo_set_to_folder      (MsgInfo        *msginfo,
379                                          FolderItem     *to_folder);
380 void procmsg_msglist_filter             (GSList         *list, 
381                                          PrefsAccount   *ac, 
382                                          GSList         **filtered,
383                                          GSList         **unfiltered,
384                                          gboolean        do_filter);
385
386 MsgInfo *procmsg_msginfo_new_from_mimeinfo
387                                         (MsgInfo        *src_msginfo, 
388                                          MimeInfo       *mimeinfo);
389
390 void procmsg_register_spam_learner (int (*learn_func)(MsgInfo *info, GSList *list, gboolean spam));
391 void procmsg_unregister_spam_learner (int (*learn_func)(MsgInfo *info, GSList *list, gboolean spam));
392 gboolean procmsg_spam_can_learn         (void);
393 void procmsg_spam_set_folder            (const char *item_identifier, FolderItem *(*spam_get_folder_func)(MsgInfo *info));
394 FolderItem *procmsg_spam_get_folder     (MsgInfo *msginfo);
395 int procmsg_spam_learner_learn  (MsgInfo *msginfo, GSList *msglist, gboolean spam);
396 gboolean procmsg_have_queued_mails_fast (void);
397 gboolean procmsg_have_trashed_mails_fast (void);
398 gboolean procmsg_is_sending(void);
399 gchar *procmsg_msginfo_get_tags_str(MsgInfo *msginfo);
400 void procmsg_msginfo_update_tags(MsgInfo *msginfo, gboolean set, gint id);
401 void procmsg_msginfo_clear_tags(MsgInfo *msginfo);
402 void procmsg_msginfo_commit_tags(GSList *msglist);
403 #endif /* __PROCMSG_H__ */