Network endian for mark and cache files
[claws.git] / src / procmsg.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 __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
33 typedef struct _MsgInfo         MsgInfo;
34 typedef struct _MsgFlags        MsgFlags;
35
36 #include "folder.h"
37 #include "procmime.h"
38
39 typedef enum
40 {
41         MSG_NEW         = 1 << 0,
42         MSG_UNREAD      = 1 << 1,
43         MSG_MARKED      = 1 << 2,
44         MSG_DELETED     = 1 << 3,
45         MSG_REPLIED     = 1 << 4,
46         MSG_FORWARDED   = 1 << 5,
47         
48         MSG_REALLY_DELETED = 1 << 6,            /* mbox stuff */
49
50 #define MSG_CLABEL_SBIT (7)             /* start bit of color label */
51 #define MAKE_MSG_CLABEL(h, m, l)        (((h) << (MSG_CLABEL_SBIT + 2)) | \
52                                          ((m) << (MSG_CLABEL_SBIT + 1)) | \
53                                          ((l) << (MSG_CLABEL_SBIT + 0)))
54
55         MSG_CLABEL_NONE = MAKE_MSG_CLABEL(0, 0, 0),
56         MSG_CLABEL_1    = MAKE_MSG_CLABEL(0, 0, 1),
57         MSG_CLABEL_2    = MAKE_MSG_CLABEL(0, 1, 0),
58         MSG_CLABEL_3    = MAKE_MSG_CLABEL(0, 1, 1),
59         MSG_CLABEL_4    = MAKE_MSG_CLABEL(1, 0, 0),
60         MSG_CLABEL_5    = MAKE_MSG_CLABEL(1, 0, 1),
61         MSG_CLABEL_6    = MAKE_MSG_CLABEL(1, 1, 0),
62         MSG_CLABEL_7    = MAKE_MSG_CLABEL(1, 1, 1),
63
64 #define MSG_CLABEL_ORANGE       MSG_CLABEL_1
65 #define MSG_CLABEL_RED          MSG_CLABEL_2
66 #define MSG_CLABEL_PINK         MSG_CLABEL_3
67 #define MSG_CLABEL_SKYBLUE      MSG_CLABEL_4
68 #define MSG_CLABEL_BLUE         MSG_CLABEL_5
69 #define MSG_CLABEL_GREEN        MSG_CLABEL_6
70 #define MSG_CLABEL_BROWN        MSG_CLABEL_7
71
72         MSG_IGNORE_THREAD   = 1 << 10,   /* ignore threads */
73         MSG_LOCKED          = 1 << 11,   /* msg is locked  */
74         MSG_RETRCPT_PENDING = 1 << 12,   /* return receipt pending */
75
76         /* RESERVED */
77         MSG_RESERVED_CLAWS  = 1 << 30,  /* for sylpheed-claws */
78         MSG_RESERVED_MAIN   = 1 << 31   /* for sylpheed-main  */
79 } MsgPermFlags;
80
81 #define MSG_CLABEL_FLAG_MASK    (MSG_CLABEL_7)
82
83 typedef enum
84 {
85         MSG_MOVE        = 1 << 0,
86         MSG_COPY        = 1 << 1,
87
88         MSG_QUEUED      = 1 << 16,
89         MSG_DRAFT       = 1 << 17,
90         MSG_ENCRYPTED   = 1 << 18,
91         MSG_IMAP        = 1 << 19,
92         MSG_NEWS        = 1 << 20,
93         MSG_SIGNED      = 1 << 21,
94
95         MSG_MIME        = 1 << 29,
96
97         MSG_CACHED      = 1 << 31
98 } MsgTmpFlags;
99
100 #define MSG_CACHED_FLAG_MASK    (MSG_MIME | MSG_ENCRYPTED | MSG_SIGNED)
101
102 #define MSG_SET_FLAGS(msg, flags)       { (msg) |= (flags); }
103 #define MSG_UNSET_FLAGS(msg, flags)     { (msg) &= ~(flags); }
104 #define MSG_SET_PERM_FLAGS(msg, flags) \
105         MSG_SET_FLAGS((msg).perm_flags, flags)
106 #define MSG_SET_TMP_FLAGS(msg, flags) \
107         MSG_SET_FLAGS((msg).tmp_flags, flags)
108 #define MSG_UNSET_PERM_FLAGS(msg, flags) \
109         MSG_UNSET_FLAGS((msg).perm_flags, flags)
110 #define MSG_UNSET_TMP_FLAGS(msg, flags) \
111         MSG_UNSET_FLAGS((msg).tmp_flags, flags)
112
113 #define MSG_IS_NEW(msg)                 (((msg).perm_flags & MSG_NEW) != 0)
114 #define MSG_IS_UNREAD(msg)              (((msg).perm_flags & MSG_UNREAD) != 0)
115 #define MSG_IS_MARKED(msg)              (((msg).perm_flags & MSG_MARKED) != 0)
116 #define MSG_IS_DELETED(msg)             (((msg).perm_flags & MSG_DELETED) != 0)
117 #define MSG_IS_REPLIED(msg)             (((msg).perm_flags & MSG_REPLIED) != 0)
118 #define MSG_IS_LOCKED(msg)              (((msg).perm_flags & MSG_LOCKED) != 0)
119 #define MSG_IS_FORWARDED(msg)           (((msg).perm_flags & MSG_FORWARDED) != 0)
120
121 #define MSG_GET_COLORLABEL(msg)         (((msg).perm_flags & MSG_CLABEL_FLAG_MASK))
122 #define MSG_GET_COLORLABEL_VALUE(msg)   (MSG_GET_COLORLABEL(msg) >> MSG_CLABEL_SBIT)
123 #define MSG_SET_COLORLABEL_VALUE(msg, val) \
124         MSG_SET_PERM_FLAGS(msg, ((((guint)(val)) & 7) << MSG_CLABEL_SBIT))
125
126 #define MSG_COLORLABEL_TO_FLAGS(val) ((((guint)(val)) & 7) << MSG_CLABEL_SBIT)
127 #define MSG_COLORLABEL_FROM_FLAGS(val) (val >> MSG_CLABEL_SBIT)
128
129 #define MSG_IS_MOVE(msg)                (((msg).tmp_flags & MSG_MOVE) != 0)
130 #define MSG_IS_COPY(msg)                (((msg).tmp_flags & MSG_COPY) != 0)
131
132 #define MSG_IS_QUEUED(msg)              (((msg).tmp_flags & MSG_QUEUED) != 0)
133 #define MSG_IS_DRAFT(msg)               (((msg).tmp_flags & MSG_DRAFT) != 0)
134 #define MSG_IS_ENCRYPTED(msg)           (((msg).tmp_flags & MSG_ENCRYPTED) != 0)
135 #define MSG_IS_SIGNED(msg)              (((msg).tmp_flags & MSG_SIGNED) != 0)
136 #define MSG_IS_IMAP(msg)                (((msg).tmp_flags & MSG_IMAP) != 0)
137 #define MSG_IS_NEWS(msg)                (((msg).tmp_flags & MSG_NEWS) != 0)
138 #define MSG_IS_MIME(msg)                (((msg).tmp_flags & MSG_MIME) != 0)
139 #define MSG_IS_CACHED(msg)              (((msg).tmp_flags & MSG_CACHED) != 0)
140
141 /* Claws related flags */
142 #define MSG_IS_REALLY_DELETED(msg)      (((msg).perm_flags & MSG_REALLY_DELETED) != 0)
143 #define MSG_IS_IGNORE_THREAD(msg)       (((msg).perm_flags & MSG_IGNORE_THREAD) != 0)
144 #define MSG_IS_RETRCPT_PENDING(msg)     (((msg).perm_flags & MSG_RETRCPT_PENDING) != 0)
145
146 /* code from bits/byteswap.h (C) 1997, 1998 Free Software Foundation, Inc. */
147 #ifdef BIG_ENDIAN_HOST
148 #define me2ne_32(x) (x)
149 #else
150 #define me2ne_32(x) \
151      ((((x) & 0xff000000) >> 24) | (((x) & 0x00ff0000) >>  8) | \
152       (((x) & 0x0000ff00) <<  8) | (((x) & 0x000000ff) << 24))
153
154 #endif
155
156 #define WRITE_CACHE_DATA_INT(n, fp) { \
157         int i = n; i = me2ne_32(i); \
158         fwrite(&i, sizeof(n), 1, fp); \
159 }
160
161 #define WRITE_CACHE_DATA(data, fp) \
162 { \
163         gint len; \
164  \
165         if (data == NULL || (len = strlen(data)) == 0) { \
166                 len = 0; \
167                 WRITE_CACHE_DATA_INT(len, fp); \
168         } else { \
169                 len = strlen(data); \
170                 WRITE_CACHE_DATA_INT(len, fp); \
171                 fwrite(data, len, 1, fp); \
172         } \
173 }
174
175 struct _MsgFlags
176 {
177         MsgPermFlags perm_flags;
178         MsgTmpFlags  tmp_flags;
179 };
180
181 struct _MsgInfo
182 {
183         guint refcnt;
184
185         guint  msgnum;
186         off_t  size;
187         time_t mtime;
188         time_t date_t;
189
190         MsgFlags flags;
191
192         gchar *fromname;
193
194         gchar *date;
195         gchar *from;
196         gchar *to;
197         gchar *cc;
198         gchar *newsgroups;
199         gchar *subject;
200         gchar *msgid;
201         gchar *inreplyto;
202         gchar *xref;
203
204         FolderItem *folder;
205         FolderItem *to_folder;
206
207         gchar *xface;
208
209         gchar *dispositionnotificationto;
210         gchar *returnreceiptto;
211
212         gchar *references;
213         gchar *fromspace;
214
215         gint score;
216         gint threadscore;
217
218         /* used only for encrypted messages */
219         gchar *plaintext_file;
220         guint decryption_failed : 1;
221 };
222
223 GHashTable *procmsg_msg_hash_table_create       (GSList         *mlist);
224 void procmsg_msg_hash_table_append              (GHashTable     *msg_table,
225                                                  GSList         *mlist);
226 GHashTable *procmsg_to_folder_hash_table_create (GSList         *mlist);
227
228 GSList *procmsg_read_cache              (FolderItem     *item,
229                                          gboolean        scan_file);
230 void    procmsg_set_flags               (GSList         *mlist,
231                                          FolderItem     *item);
232 gint    procmsg_get_last_num_in_msg_list(GSList         *mlist);
233 void    procmsg_msg_list_free           (GSList         *mlist);
234 void    procmsg_write_cache             (MsgInfo        *msginfo,
235                                          FILE           *fp);
236 void    procmsg_write_flags             (MsgInfo        *msginfo,
237                                          FILE           *fp);
238 void    procmsg_flush_mark_queue        (FolderItem     *item,
239                                          FILE           *fp);
240 void    procmsg_add_flags               (FolderItem     *item,
241                                          gint            num,
242                                          MsgFlags        flags);
243 void    procmsg_get_mark_sum            (const gchar    *folder,
244                                          gint           *new,
245                                          gint           *unread,
246                                          gint           *total,
247                                          gint           *min,
248                                          gint           *max,
249                                          gint            first);
250 FILE   *procmsg_open_mark_file          (const gchar    *folder,
251                                          gboolean        append);
252
253 GNode  *procmsg_get_thread_tree         (GSList         *mlist);
254
255 void    procmsg_move_messages           (GSList         *mlist);
256 void    procmsg_copy_messages           (GSList         *mlist);
257
258 gchar  *procmsg_get_message_file_path   (MsgInfo        *msginfo);
259 gchar  *procmsg_get_message_file        (MsgInfo        *msginfo);
260 FILE   *procmsg_open_message            (MsgInfo        *msginfo);
261 #if USE_GPGME
262 FILE   *procmsg_open_message_decrypted  (MsgInfo        *msginfo,
263                                          MimeInfo      **mimeinfo);
264 #endif
265 gboolean procmsg_msg_exist              (MsgInfo        *msginfo);
266
267 void    procmsg_empty_trash             (void);
268 gint    procmsg_send_queue              (FolderItem     *queue,
269                                          gboolean        save_msgs);
270 gint    procmsg_save_to_outbox          (FolderItem     *outbox,
271                                          const gchar    *file,
272                                          gboolean        is_queued);
273 void    procmsg_print_message           (MsgInfo        *msginfo,
274                                          const gchar    *cmdline);
275
276 MsgInfo *procmsg_msginfo_new            ();
277 MsgInfo *procmsg_msginfo_new_ref        (MsgInfo        *msginfo);
278 MsgInfo *procmsg_msginfo_copy           (MsgInfo        *msginfo);
279 MsgInfo *procmsg_msginfo_get_full_info  (MsgInfo        *msginfo);
280 void     procmsg_msginfo_free           (MsgInfo        *msginfo);
281 guint    procmsg_msginfo_memusage       (MsgInfo        *msginfo);
282
283 gint procmsg_cmp_msgnum_for_sort        (gconstpointer   a,
284                                          gconstpointer   b);
285 gint procmsg_send_message_queue         (const gchar *file);
286
287 void procmsg_msginfo_set_flags          (MsgInfo *msginfo,
288                                          MsgPermFlags perm_flags,
289                                           MsgTmpFlags tmp_flags);
290 void procmsg_msginfo_unset_flags        (MsgInfo *msginfo,
291                                          MsgPermFlags perm_flags,
292                                           MsgTmpFlags tmp_flags);
293
294 #endif /* __PROCMSG_H__ */