Added a check for NULL prefs_common.dictionary
[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         MsgTmpFlags tmp_flags = 0;
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         if (item->stype == F_QUEUE) {
224                 tmp_flags |= MSG_QUEUED;
225         } else if (item->stype == F_DRAFT) {
226                 tmp_flags |= MSG_DRAFT;
227         }
228
229         cache = msgcache_new();
230
231         g_hash_table_freeze(cache->msgnum_table);
232
233         while (fread(&num, sizeof(num), 1, fp) == 1) {
234                 msginfo = procmsg_msginfo_new();
235                 msginfo->msgnum = num;
236                 READ_CACHE_DATA_INT(msginfo->size, fp);
237                 READ_CACHE_DATA_INT(msginfo->mtime, fp);
238                 READ_CACHE_DATA_INT(msginfo->date_t, fp);
239                 READ_CACHE_DATA_INT(msginfo->flags.tmp_flags, fp);
240
241                 READ_CACHE_DATA(msginfo->fromname, fp);
242
243                 READ_CACHE_DATA(msginfo->date, fp);
244                 READ_CACHE_DATA(msginfo->from, fp);
245                 READ_CACHE_DATA(msginfo->to, fp);
246                 READ_CACHE_DATA(msginfo->cc, fp);
247                 READ_CACHE_DATA(msginfo->newsgroups, fp);
248                 READ_CACHE_DATA(msginfo->subject, fp);
249                 READ_CACHE_DATA(msginfo->msgid, fp);
250                 READ_CACHE_DATA(msginfo->inreplyto, fp);
251                 READ_CACHE_DATA(msginfo->references, fp);
252                 READ_CACHE_DATA(msginfo->xref, fp);
253
254                 msginfo->folder = item;
255                 msginfo->flags.tmp_flags |= tmp_flags;
256
257                 g_hash_table_insert(cache->msgnum_table, &msginfo->msgnum, msginfo);
258                 if(msginfo->msgid)
259                         g_hash_table_insert(cache->msgid_table, msginfo->msgid, msginfo);
260                 cache->memusage += procmsg_msginfo_memusage(msginfo);
261         }
262         fclose(fp);
263
264         if(error) {
265                 g_hash_table_thaw(cache->msgnum_table);
266                 msgcache_destroy(cache);
267                 return NULL;
268         }
269
270         cache->last_access = time(NULL);
271         g_hash_table_thaw(cache->msgnum_table);
272
273         debug_print("done. (%d items read)\n", g_hash_table_size(cache->msgnum_table));
274         debug_print("Cache size: %d messages, %d byte\n", g_hash_table_size(cache->msgnum_table), cache->memusage);
275
276         return cache;
277 }
278
279 void msgcache_read_mark(MsgCache *cache, const gchar *mark_file)
280 {
281         FILE *fp;
282         MsgInfo *msginfo;
283         MsgPermFlags perm_flags;
284         gint ver;
285         guint num;
286
287         if ((fp = fopen(mark_file, "rb")) == NULL) {
288                 debug_print("Mark file not found.\n");
289                 return;
290         } else if (fread(&ver, sizeof(ver), 1, fp) != 1 || MARK_VERSION != ver) {
291                 debug_print("Mark version is different (%d != %d). "
292                               "Discarding it.\n", ver, MARK_VERSION);
293         } else {
294                 debug_print("\tReading message marks from %s...\n", mark_file);
295
296                 while (fread(&num, sizeof(num), 1, fp) == 1) {
297                         if (fread(&perm_flags, sizeof(perm_flags), 1, fp) != 1) break;
298
299                         msginfo = g_hash_table_lookup(cache->msgnum_table, &num);
300                         if(msginfo) {
301                                 msginfo->flags.perm_flags = perm_flags;
302                         }
303                 }
304         }
305         fclose(fp);
306 }
307
308 #define WRITE_CACHE_DATA_INT(n, fp) \
309         fwrite(&n, sizeof(n), 1, fp)
310
311 #define WRITE_CACHE_DATA(data, fp) \
312 { \
313         gint len; \
314  \
315         if (data == NULL || (len = strlen(data)) == 0) { \
316                 len = 0; \
317                 WRITE_CACHE_DATA_INT(len, fp); \
318         } else { \
319                 len = strlen(data); \
320                 WRITE_CACHE_DATA_INT(len, fp); \
321                 fwrite(data, len, 1, fp); \
322         } \
323 }
324
325 void msgcache_write_cache(MsgInfo *msginfo, FILE *fp)
326 {
327         MsgTmpFlags flags = msginfo->flags.tmp_flags & MSG_CACHED_FLAG_MASK;
328
329         WRITE_CACHE_DATA_INT(msginfo->msgnum, fp);
330         WRITE_CACHE_DATA_INT(msginfo->size, fp);
331         WRITE_CACHE_DATA_INT(msginfo->mtime, fp);
332         WRITE_CACHE_DATA_INT(msginfo->date_t, fp);
333         WRITE_CACHE_DATA_INT(flags, fp);
334
335         WRITE_CACHE_DATA(msginfo->fromname, fp);
336
337         WRITE_CACHE_DATA(msginfo->date, fp);
338         WRITE_CACHE_DATA(msginfo->from, fp);
339         WRITE_CACHE_DATA(msginfo->to, fp);
340         WRITE_CACHE_DATA(msginfo->cc, fp);
341         WRITE_CACHE_DATA(msginfo->newsgroups, fp);
342         WRITE_CACHE_DATA(msginfo->subject, fp);
343         WRITE_CACHE_DATA(msginfo->msgid, fp);
344         WRITE_CACHE_DATA(msginfo->inreplyto, fp);
345         WRITE_CACHE_DATA(msginfo->references, fp);
346         WRITE_CACHE_DATA(msginfo->xref, fp);
347 }
348
349 static void msgcache_write_flags(MsgInfo *msginfo, FILE *fp)
350 {
351         MsgPermFlags flags = msginfo->flags.perm_flags;
352
353         WRITE_CACHE_DATA_INT(msginfo->msgnum, fp);
354         WRITE_CACHE_DATA_INT(flags, fp);
355 }
356
357 struct write_fps
358 {
359         FILE *cache_fp;
360         FILE *mark_fp;
361 };
362
363 static void msgcache_write_func(gpointer key, gpointer value, gpointer user_data)
364 {
365         MsgInfo *msginfo;
366         struct write_fps *write_fps;
367         
368         msginfo = (MsgInfo *)value;
369         write_fps = user_data;
370
371         msgcache_write_cache(msginfo, write_fps->cache_fp);
372         msgcache_write_flags(msginfo, write_fps->mark_fp);
373 }
374
375 gint msgcache_write(const gchar *cache_file, const gchar *mark_file, MsgCache *cache)
376 {
377         FILE *fp;
378         struct write_fps write_fps;
379         gint ver;
380
381         g_return_val_if_fail(cache_file != NULL, -1);
382         g_return_val_if_fail(mark_file != NULL, -1);
383         g_return_val_if_fail(cache != NULL, -1);
384
385         debug_print("\tWriting message cache to %s and %s...\n", cache_file, mark_file);
386
387         if ((fp = fopen(cache_file, "wb")) == NULL) {
388                 FILE_OP_ERROR(cache_file, "fopen");
389                 return -1;
390         }
391         if (change_file_mode_rw(fp, cache_file) < 0)
392                 FILE_OP_ERROR(cache_file, "chmod");
393
394         ver = CACHE_VERSION;
395         WRITE_CACHE_DATA_INT(ver, fp);  
396         write_fps.cache_fp = fp;
397
398         if ((fp = fopen(mark_file, "wb")) == NULL) {
399                 FILE_OP_ERROR(mark_file, "fopen");
400                 fclose(write_fps.cache_fp);
401                 return -1;
402         }
403
404         ver = MARK_VERSION;
405         WRITE_CACHE_DATA_INT(ver, fp);
406         write_fps.mark_fp = fp;
407
408         g_hash_table_foreach(cache->msgnum_table, msgcache_write_func, (gpointer)&write_fps);
409
410         fclose(write_fps.cache_fp);
411         fclose(write_fps.mark_fp);
412
413         cache->last_access = time(NULL);
414
415         debug_print("done.\n");
416         return 0;
417 }
418
419 MsgInfo *msgcache_get_msg(MsgCache *cache, guint num)
420 {
421         MsgInfo *msginfo;
422
423         g_return_val_if_fail(cache != NULL, NULL);
424
425         msginfo = g_hash_table_lookup(cache->msgnum_table, &num);
426         if(!msginfo)
427                 return NULL;
428         cache->last_access = time(NULL);
429         
430         return procmsg_msginfo_new_ref(msginfo);
431 }
432
433 MsgInfo *msgcache_get_msg_by_id(MsgCache *cache, const gchar *msgid)
434 {
435         MsgInfo *msginfo;
436         
437         g_return_val_if_fail(cache != NULL, NULL);
438
439         msginfo = g_hash_table_lookup(cache->msgid_table, msgid);
440         if(!msginfo)
441                 return NULL;
442         cache->last_access = time(NULL);
443         
444         return procmsg_msginfo_new_ref(msginfo);        
445 }
446
447 static void msgcache_get_msg_list_func(gpointer key, gpointer value, gpointer user_data)
448 {
449         GSList **listptr = user_data;
450         MsgInfo *msginfo = value;
451
452         *listptr = g_slist_prepend(*listptr, procmsg_msginfo_new_ref(msginfo));
453 }
454
455 GSList *msgcache_get_msg_list(MsgCache *cache)
456 {
457         GSList *msg_list = NULL;
458
459         g_return_val_if_fail(cache != NULL, NULL);
460
461         g_hash_table_foreach((GHashTable *)cache->msgnum_table, msgcache_get_msg_list_func, (gpointer)&msg_list);       
462         cache->last_access = time(NULL);
463
464         return msg_list;
465 }
466
467 time_t msgcache_get_last_access_time(MsgCache *cache)
468 {
469         g_return_val_if_fail(cache != NULL, 0);
470         
471         return cache->last_access;
472 }
473
474 gint msgcache_get_memory_usage(MsgCache *cache)
475 {
476         g_return_val_if_fail(cache != NULL, 0);
477
478         return cache->memusage;
479 }