* src/folder.[ch]
[claws.git] / src / msgcache.c
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2001 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 #include "defs.h"
21
22 #include <glib.h>
23
24 #include <time.h>
25
26 #include "intl.h"
27 #include "msgcache.h"
28 #include "utils.h"
29 #include "procmsg.h"
30
31 struct _MsgCache {
32         GHashTable      *msgnum_table;
33         GHashTable      *msgid_table;
34         guint            memusage;
35         time_t           last_access;
36 };
37
38 MsgCache *msgcache_new()
39 {
40         MsgCache *cache;
41         
42         cache = g_new0(MsgCache, 1),
43         cache->msgnum_table = g_hash_table_new(g_int_hash, g_int_equal);
44         cache->msgid_table = g_hash_table_new(g_str_hash, g_str_equal);
45         cache->last_access = time(NULL);
46
47         return cache;
48 }
49
50 static gboolean msgcache_msginfo_free_func(gpointer num, gpointer msginfo, gpointer user_data)
51 {
52         procmsg_msginfo_free((MsgInfo *)msginfo);
53         return TRUE;
54 }                                                                                         
55
56 void msgcache_destroy(MsgCache *cache)
57 {
58         g_return_if_fail(cache != NULL);
59
60         g_hash_table_foreach_remove(cache->msgnum_table, msgcache_msginfo_free_func, NULL);
61         g_hash_table_destroy(cache->msgid_table);
62         g_hash_table_destroy(cache->msgnum_table);
63         g_free(cache);
64 }
65
66 void msgcache_add_msg(MsgCache *cache, MsgInfo *msginfo) 
67 {
68         MsgInfo *newmsginfo;
69
70         g_return_if_fail(cache != NULL);
71         g_return_if_fail(msginfo != NULL);
72
73         newmsginfo = procmsg_msginfo_new_ref(msginfo);
74         g_hash_table_insert(cache->msgnum_table, &newmsginfo->msgnum, newmsginfo);
75         if(newmsginfo->msgid != NULL)
76                 g_hash_table_insert(cache->msgid_table, newmsginfo->msgid, newmsginfo);
77         cache->memusage += procmsg_msginfo_memusage(msginfo);
78         cache->last_access = time(NULL);
79
80         debug_print(_("Cache size: %d messages, %d byte\n"), g_hash_table_size(cache->msgnum_table), cache->memusage);
81 }
82
83 void msgcache_remove_msg(MsgCache *cache, guint msgnum)
84 {
85         MsgInfo *msginfo;
86
87         g_return_if_fail(cache != NULL);
88         g_return_if_fail(msgnum > 0);
89
90         msginfo = (MsgInfo *) g_hash_table_lookup(cache->msgnum_table, &msgnum);
91         if(!msginfo)
92                 return;
93
94         cache->memusage -= procmsg_msginfo_memusage(msginfo);
95         if(msginfo->msgid)
96                 g_hash_table_remove(cache->msgid_table, msginfo->msgid);
97         g_hash_table_remove(cache->msgnum_table, &msginfo->msgnum);
98         procmsg_msginfo_free(msginfo);
99         cache->last_access = time(NULL);
100
101         debug_print(_("Cache size: %d messages, %d byte\n"), g_hash_table_size(cache->msgnum_table), cache->memusage);
102 }
103
104 void msgcache_update_msg(MsgCache *cache, MsgInfo *msginfo)
105 {
106         MsgInfo *oldmsginfo, *newmsginfo;
107         
108         g_return_if_fail(cache != NULL);
109         g_return_if_fail(msginfo != NULL);
110
111         oldmsginfo = g_hash_table_lookup(cache->msgnum_table, &msginfo->msgnum);
112         if(msginfo) {
113                 g_hash_table_remove(cache->msgid_table, oldmsginfo->msgid);
114                 g_hash_table_remove(cache->msgnum_table, &oldmsginfo->msgnum);
115                 procmsg_msginfo_free(oldmsginfo);
116         }
117         cache->memusage -= procmsg_msginfo_memusage(oldmsginfo);
118
119         newmsginfo = procmsg_msginfo_new_ref(msginfo);
120         g_hash_table_insert(cache->msgnum_table, &newmsginfo->msgnum, newmsginfo);
121         if(newmsginfo->msgid)
122                 g_hash_table_insert(cache->msgid_table, newmsginfo->msgid, newmsginfo);
123         cache->memusage += procmsg_msginfo_memusage(newmsginfo);
124         cache->last_access = time(NULL);
125         
126         debug_print(_("Cache size: %d messages, %d byte\n"), g_hash_table_size(cache->msgnum_table), cache->memusage);
127
128         return;
129 }
130
131 static gint msgcache_read_cache_data_str(FILE *fp, gchar **str)
132 {
133         gchar buf[BUFFSIZE];
134         gint ret = 0;
135         size_t len;
136
137         if (fread(&len, sizeof(len), 1, fp) == 1) {
138                 if (len < 0)
139                         ret = -1;
140                 else {
141                         gchar *tmp = NULL;
142
143                         while (len > 0) {
144                                 size_t size = MIN(len, BUFFSIZE - 1);
145
146                                 if (fread(buf, size, 1, fp) != 1) {
147                                         ret = -1;
148                                         if (tmp) g_free(tmp);
149                                         *str = NULL;
150                                         break;
151                                 }
152
153                                 buf[size] = '\0';
154                                 if (tmp) {
155                                         *str = g_strconcat(tmp, buf, NULL);
156                                         g_free(tmp);
157                                         tmp = *str;
158                                 } else
159                                         tmp = *str = g_strdup(buf);
160
161                                 len -= size;
162                         }
163                 }
164         } else
165                 ret = -1;
166
167         if (ret < 0)
168                 g_warning(_("Cache data is corrupted\n"));
169
170         return ret;
171 }
172
173
174 #define READ_CACHE_DATA(data, fp) \
175 { \
176         if (msgcache_read_cache_data_str(fp, &data) < 0) { \
177                 procmsg_msginfo_free(msginfo); \
178                 error = TRUE; \
179                 break; \
180         } \
181 }
182
183 #define READ_CACHE_DATA_INT(n, fp) \
184 { \
185         if (fread(&n, sizeof(n), 1, fp) != 1) { \
186                 g_warning(_("Cache data is corrupted\n")); \
187                 procmsg_msginfo_free(msginfo); \
188                 error = TRUE; \
189                 break; \
190         } \
191 }
192
193 MsgCache *msgcache_read_cache(FolderItem *item, const gchar *cache_file)
194 {
195         MsgCache *cache;
196         FILE *fp;
197         MsgInfo *msginfo;
198 /*      MsgFlags default_flags; */
199         gchar file_buf[BUFFSIZE];
200         gint ver;
201         guint num;
202         gboolean error = FALSE;
203
204         g_return_val_if_fail(cache_file != NULL, NULL);
205         g_return_val_if_fail(item != NULL, NULL);
206
207         if ((fp = fopen(cache_file, "rb")) == NULL) {
208                 debug_print(_("\tNo cache file\n"));
209                 return NULL;
210         }
211         setvbuf(fp, file_buf, _IOFBF, sizeof(file_buf));
212
213         debug_print(_("\tReading message cache from %s...\n"), cache_file);
214
215         /* compare cache version */
216         if (fread(&ver, sizeof(ver), 1, fp) != 1 ||
217             CACHE_VERSION != ver) {
218                 debug_print(_("Cache version is different. Discarding it.\n"));
219                 fclose(fp);
220                 return NULL;
221         }
222
223         cache = msgcache_new();
224
225         g_hash_table_freeze(cache->msgnum_table);
226
227         while (fread(&num, sizeof(num), 1, fp) == 1) {
228                 msginfo = procmsg_msginfo_new();
229                 msginfo->msgnum = num;
230                 READ_CACHE_DATA_INT(msginfo->size, fp);
231                 READ_CACHE_DATA_INT(msginfo->mtime, fp);
232                 READ_CACHE_DATA_INT(msginfo->date_t, fp);
233                 READ_CACHE_DATA_INT(msginfo->flags.tmp_flags, fp);
234
235                 READ_CACHE_DATA(msginfo->fromname, fp);
236
237                 READ_CACHE_DATA(msginfo->date, fp);
238                 READ_CACHE_DATA(msginfo->from, fp);
239                 READ_CACHE_DATA(msginfo->to, fp);
240                 READ_CACHE_DATA(msginfo->cc, fp);
241                 READ_CACHE_DATA(msginfo->newsgroups, fp);
242                 READ_CACHE_DATA(msginfo->subject, fp);
243                 READ_CACHE_DATA(msginfo->msgid, fp);
244                 READ_CACHE_DATA(msginfo->inreplyto, fp);
245                 READ_CACHE_DATA(msginfo->references, fp);
246                 READ_CACHE_DATA(msginfo->xref, fp);
247
248 /*
249                 MSG_SET_PERM_FLAGS(msginfo->flags, default_flags.perm_flags);
250                 MSG_SET_TMP_FLAGS(msginfo->flags, default_flags.tmp_flags);
251 */
252                 msginfo->folder = item;
253
254                 g_hash_table_insert(cache->msgnum_table, &msginfo->msgnum, msginfo);
255                 if(msginfo->msgid)
256                         g_hash_table_insert(cache->msgid_table, msginfo->msgid, msginfo);
257                 cache->memusage += procmsg_msginfo_memusage(msginfo);
258         }
259         fclose(fp);
260
261         if(error) {
262                 g_hash_table_thaw(cache->msgnum_table);
263                 msgcache_destroy(cache);
264                 return NULL;
265         }
266
267         cache->last_access = time(NULL);
268         g_hash_table_thaw(cache->msgnum_table);
269
270         debug_print(_("done. (%d items read)\n"), g_hash_table_size(cache->msgnum_table));
271         debug_print(_("Cache size: %d messages, %d byte\n"), g_hash_table_size(cache->msgnum_table), cache->memusage);
272
273         return cache;
274 }
275
276 void msgcache_read_mark(MsgCache *cache, const gchar *mark_file)
277 {
278         FILE *fp;
279         MsgInfo *msginfo;
280         MsgPermFlags perm_flags;
281         gint ver;
282         guint num;
283
284         if ((fp = fopen(mark_file, "rb")) == NULL) {
285                 debug_print(_("Mark file not found.\n"));
286                 return;
287         } else if (fread(&ver, sizeof(ver), 1, fp) != 1 || MARK_VERSION != ver) {
288                 debug_print(_("Mark version is different (%d != %d). "
289                               "Discarding it.\n"), ver, MARK_VERSION);
290         } else {
291                 debug_print(_("\tReading message marks from %s...\n"), mark_file);
292
293                 while (fread(&num, sizeof(num), 1, fp) == 1) {
294                         if (fread(&perm_flags, sizeof(perm_flags), 1, fp) != 1) break;
295
296                         msginfo = g_hash_table_lookup(cache->msgnum_table, &num);
297                         if(msginfo) {
298                                 msginfo->flags.perm_flags = perm_flags;
299                         }
300                 }
301         }
302         fclose(fp);
303 }
304
305 #define WRITE_CACHE_DATA_INT(n, fp) \
306         fwrite(&n, sizeof(n), 1, fp)
307
308 #define WRITE_CACHE_DATA(data, fp) \
309 { \
310         gint len; \
311  \
312         if (data == NULL || (len = strlen(data)) == 0) { \
313                 len = 0; \
314                 WRITE_CACHE_DATA_INT(len, fp); \
315         } else { \
316                 len = strlen(data); \
317                 WRITE_CACHE_DATA_INT(len, fp); \
318                 fwrite(data, len, 1, fp); \
319         } \
320 }
321
322 void msgcache_write_cache(MsgInfo *msginfo, FILE *fp)
323 {
324         MsgTmpFlags flags = msginfo->flags.tmp_flags & MSG_CACHED_FLAG_MASK;
325
326         WRITE_CACHE_DATA_INT(msginfo->msgnum, fp);
327         WRITE_CACHE_DATA_INT(msginfo->size, fp);
328         WRITE_CACHE_DATA_INT(msginfo->mtime, fp);
329         WRITE_CACHE_DATA_INT(msginfo->date_t, fp);
330         WRITE_CACHE_DATA_INT(flags, fp);
331
332         WRITE_CACHE_DATA(msginfo->fromname, fp);
333
334         WRITE_CACHE_DATA(msginfo->date, fp);
335         WRITE_CACHE_DATA(msginfo->from, fp);
336         WRITE_CACHE_DATA(msginfo->to, fp);
337         WRITE_CACHE_DATA(msginfo->cc, fp);
338         WRITE_CACHE_DATA(msginfo->newsgroups, fp);
339         WRITE_CACHE_DATA(msginfo->subject, fp);
340         WRITE_CACHE_DATA(msginfo->msgid, fp);
341         WRITE_CACHE_DATA(msginfo->inreplyto, fp);
342         WRITE_CACHE_DATA(msginfo->references, fp);
343         WRITE_CACHE_DATA(msginfo->xref, fp);
344 }
345
346 static void msgcache_write_flags(MsgInfo *msginfo, FILE *fp)
347 {
348         MsgPermFlags flags = msginfo->flags.perm_flags;
349
350         WRITE_CACHE_DATA_INT(msginfo->msgnum, fp);
351         WRITE_CACHE_DATA_INT(flags, fp);
352 }
353
354 struct write_fps
355 {
356         FILE *cache_fp;
357         FILE *mark_fp;
358 };
359
360 static void msgcache_write_func(gpointer key, gpointer value, gpointer user_data)
361 {
362         MsgInfo *msginfo;
363         struct write_fps *write_fps;
364         
365         msginfo = (MsgInfo *)value;
366         write_fps = user_data;
367
368         msgcache_write_cache(msginfo, write_fps->cache_fp);
369         msgcache_write_flags(msginfo, write_fps->mark_fp);
370 }
371
372 gint msgcache_write(const gchar *cache_file, const gchar *mark_file, MsgCache *cache)
373 {
374         FILE *fp;
375         struct write_fps write_fps;
376         gint ver;
377
378         g_return_val_if_fail(cache_file != NULL, -1);
379         g_return_val_if_fail(mark_file != NULL, -1);
380         g_return_val_if_fail(cache != NULL, -1);
381
382         debug_print(_("\tWriting message cache to %s and %s...\n"), cache_file, mark_file);
383
384         if ((fp = fopen(cache_file, "wb")) == NULL) {
385                 FILE_OP_ERROR(cache_file, "fopen");
386                 return -1;
387         }
388         if (change_file_mode_rw(fp, cache_file) < 0)
389                 FILE_OP_ERROR(cache_file, "chmod");
390
391         ver = CACHE_VERSION;
392         WRITE_CACHE_DATA_INT(ver, fp);  
393         write_fps.cache_fp = fp;
394
395         if ((fp = fopen(mark_file, "wb")) == NULL) {
396                 FILE_OP_ERROR(mark_file, "fopen");
397                 fclose(write_fps.cache_fp);
398                 return -1;
399         }
400
401         ver = MARK_VERSION;
402         WRITE_CACHE_DATA_INT(ver, fp);
403         write_fps.mark_fp = fp;
404
405         g_hash_table_foreach(cache->msgnum_table, msgcache_write_func, (gpointer)&write_fps);
406
407         fclose(write_fps.cache_fp);
408         fclose(write_fps.mark_fp);
409
410         cache->last_access = time(NULL);
411
412         debug_print(_("done.\n"));
413         return 0;
414 }
415
416 MsgInfo *msgcache_get_msg(MsgCache *cache, guint num)
417 {
418         MsgInfo *msginfo;
419
420         g_return_val_if_fail(cache != NULL, NULL);
421
422         msginfo = g_hash_table_lookup(cache->msgnum_table, &num);
423         if(!msginfo)
424                 return NULL;
425         cache->last_access = time(NULL);
426         
427         return procmsg_msginfo_new_ref(msginfo);
428 }
429
430 MsgInfo *msgcache_get_msg_by_id(MsgCache *cache, const gchar *msgid)
431 {
432         MsgInfo *msginfo;
433         
434         g_return_val_if_fail(cache != NULL, NULL);
435
436         msginfo = g_hash_table_lookup(cache->msgid_table, msgid);
437         if(!msginfo)
438                 return NULL;
439         cache->last_access = time(NULL);
440         
441         return procmsg_msginfo_new_ref(msginfo);        
442 }
443
444 static void msgcache_get_msg_list_func(gpointer key, gpointer value, gpointer user_data)
445 {
446         GSList **listptr = user_data;
447         MsgInfo *msginfo = value;
448
449         *listptr = g_slist_prepend(*listptr, procmsg_msginfo_new_ref(msginfo));
450 }
451
452 GSList *msgcache_get_msg_list(MsgCache *cache)
453 {
454         GSList *msg_list = NULL;
455
456         g_return_val_if_fail(cache != NULL, NULL);
457
458         g_hash_table_foreach((GHashTable *)cache->msgnum_table, msgcache_get_msg_list_func, (gpointer)&msg_list);       
459         cache->last_access = time(NULL);
460
461         return msg_list;
462 }
463
464 time_t msgcache_get_last_access_time(MsgCache *cache)
465 {
466         g_return_val_if_fail(cache != NULL, 0);
467         
468         return cache->last_access;
469 }
470
471 gint msgcache_get_memory_usage(MsgCache *cache)
472 {
473         g_return_val_if_fail(cache != NULL, 0);
474
475         return cache->memusage;
476 }