2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 1999-2005 Hiroyuki Yamamoto & The Sylpheed Claws Team
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.
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.
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23 #include <glib/gi18n.h>
32 #if G_BYTE_ORDER == G_BIG_ENDIAN
34 ((((x) & 0xff000000) >> 24) | (((x) & 0x00ff0000) >> 8) | \
35 (((x) & 0x0000ff00) << 8) | (((x) & 0x000000ff) << 24))
37 #define bswap_32(x) (x)
40 static gboolean swapping = TRUE;
50 GHashTable *msgnum_table;
51 GHashTable *msgid_table;
56 typedef struct _StringConverter StringConverter;
57 struct _StringConverter {
58 gchar *(*convert) (StringConverter *converter, gchar *srcstr);
59 void (*free) (StringConverter *converter);
62 typedef struct _StrdupConverter StrdupConverter;
63 struct _StrdupConverter {
64 StringConverter converter;
67 typedef struct _CharsetConverter CharsetConverter;
68 struct _CharsetConverter {
69 StringConverter converter;
75 MsgCache *msgcache_new(void)
79 cache = g_new0(MsgCache, 1),
80 cache->msgnum_table = g_hash_table_new(g_int_hash, g_int_equal);
81 cache->msgid_table = g_hash_table_new(g_str_hash, g_str_equal);
82 cache->last_access = time(NULL);
87 static gboolean msgcache_msginfo_free_func(gpointer num, gpointer msginfo, gpointer user_data)
89 procmsg_msginfo_free((MsgInfo *)msginfo);
93 void msgcache_destroy(MsgCache *cache)
95 g_return_if_fail(cache != NULL);
97 g_hash_table_foreach_remove(cache->msgnum_table, msgcache_msginfo_free_func, NULL);
98 g_hash_table_destroy(cache->msgid_table);
99 g_hash_table_destroy(cache->msgnum_table);
103 void msgcache_add_msg(MsgCache *cache, MsgInfo *msginfo)
107 g_return_if_fail(cache != NULL);
108 g_return_if_fail(msginfo != NULL);
110 newmsginfo = procmsg_msginfo_new_ref(msginfo);
111 g_hash_table_insert(cache->msgnum_table, &newmsginfo->msgnum, newmsginfo);
112 if(newmsginfo->msgid != NULL)
113 g_hash_table_insert(cache->msgid_table, newmsginfo->msgid, newmsginfo);
114 cache->memusage += procmsg_msginfo_memusage(msginfo);
115 cache->last_access = time(NULL);
117 debug_print("Cache size: %d messages, %d bytes\n", g_hash_table_size(cache->msgnum_table), cache->memusage);
120 void msgcache_remove_msg(MsgCache *cache, guint msgnum)
124 g_return_if_fail(cache != NULL);
125 g_return_if_fail(msgnum > 0);
127 msginfo = (MsgInfo *) g_hash_table_lookup(cache->msgnum_table, &msgnum);
131 cache->memusage -= procmsg_msginfo_memusage(msginfo);
133 g_hash_table_remove(cache->msgid_table, msginfo->msgid);
134 g_hash_table_remove(cache->msgnum_table, &msginfo->msgnum);
135 procmsg_msginfo_free(msginfo);
136 cache->last_access = time(NULL);
138 debug_print("Cache size: %d messages, %d byte\n", g_hash_table_size(cache->msgnum_table), cache->memusage);
141 void msgcache_update_msg(MsgCache *cache, MsgInfo *msginfo)
143 MsgInfo *oldmsginfo, *newmsginfo;
145 g_return_if_fail(cache != NULL);
146 g_return_if_fail(msginfo != NULL);
148 oldmsginfo = g_hash_table_lookup(cache->msgnum_table, &msginfo->msgnum);
149 if(oldmsginfo && oldmsginfo->msgid)
150 g_hash_table_remove(cache->msgid_table, oldmsginfo->msgid);
152 g_hash_table_remove(cache->msgnum_table, &oldmsginfo->msgnum);
153 cache->memusage -= procmsg_msginfo_memusage(oldmsginfo);
154 procmsg_msginfo_free(oldmsginfo);
157 newmsginfo = procmsg_msginfo_new_ref(msginfo);
158 g_hash_table_insert(cache->msgnum_table, &newmsginfo->msgnum, newmsginfo);
159 if(newmsginfo->msgid)
160 g_hash_table_insert(cache->msgid_table, newmsginfo->msgid, newmsginfo);
161 cache->memusage += procmsg_msginfo_memusage(newmsginfo);
162 cache->last_access = time(NULL);
164 debug_print("Cache size: %d messages, %d byte\n", g_hash_table_size(cache->msgnum_table), cache->memusage);
169 MsgInfo *msgcache_get_msg(MsgCache *cache, guint num)
173 g_return_val_if_fail(cache != NULL, NULL);
175 msginfo = g_hash_table_lookup(cache->msgnum_table, &num);
178 cache->last_access = time(NULL);
180 return procmsg_msginfo_new_ref(msginfo);
183 MsgInfo *msgcache_get_msg_by_id(MsgCache *cache, const gchar *msgid)
187 g_return_val_if_fail(cache != NULL, NULL);
188 g_return_val_if_fail(msgid != NULL, NULL);
190 msginfo = g_hash_table_lookup(cache->msgid_table, msgid);
193 cache->last_access = time(NULL);
195 return procmsg_msginfo_new_ref(msginfo);
198 static void msgcache_get_msg_list_func(gpointer key, gpointer value, gpointer user_data)
200 MsgInfoList **listptr = user_data;
201 MsgInfo *msginfo = value;
203 *listptr = g_slist_prepend(*listptr, procmsg_msginfo_new_ref(msginfo));
206 MsgInfoList *msgcache_get_msg_list(MsgCache *cache)
208 MsgInfoList *msg_list = NULL;
210 g_return_val_if_fail(cache != NULL, NULL);
212 g_hash_table_foreach((GHashTable *)cache->msgnum_table, msgcache_get_msg_list_func, (gpointer)&msg_list);
213 cache->last_access = time(NULL);
215 msg_list = g_slist_reverse(msg_list);
220 time_t msgcache_get_last_access_time(MsgCache *cache)
222 g_return_val_if_fail(cache != NULL, 0);
224 return cache->last_access;
227 gint msgcache_get_memory_usage(MsgCache *cache)
229 g_return_val_if_fail(cache != NULL, 0);
231 return cache->memusage;
235 * Cache saving functions
238 #define READ_CACHE_DATA(data, fp, total_len) \
240 if ((tmp_len = msgcache_read_cache_data_str(fp, &data, conv)) < 0) { \
241 procmsg_msginfo_free(msginfo); \
245 total_len += tmp_len; \
248 #define READ_CACHE_DATA_INT(n, fp) \
253 if ((ni = fread(&idata, sizeof(idata), 1, fp)) != 1) { \
254 g_warning("read_int: Cache data corrupted, read %d of %d at " \
255 "offset %ld\n", ni, sizeof(idata), ftell(fp)); \
256 procmsg_msginfo_free(msginfo); \
260 n = swapping ? bswap_32(idata) : (idata);\
263 #define WRITE_CACHE_DATA_INT(n, fp) \
267 idata = (guint32)bswap_32(n); \
268 fwrite(&idata, sizeof(idata), 1, fp); \
271 #define WRITE_CACHE_DATA(data, fp) \
277 len = strlen(data); \
278 WRITE_CACHE_DATA_INT(len, fp); \
280 fwrite(data, len, 1, fp); \
284 static FILE *msgcache_open_data_file(const gchar *file, guint version,
286 gchar *buf, size_t buf_size)
291 g_return_val_if_fail(file != NULL, NULL);
293 if (mode == DATA_WRITE) {
294 if ((fp = g_fopen(file, "wb")) == NULL) {
295 FILE_OP_ERROR(file, "fopen");
298 if (change_file_mode_rw(fp, file) < 0)
299 FILE_OP_ERROR(file, "chmod");
301 WRITE_CACHE_DATA_INT(version, fp);
306 if ((fp = g_fopen(file, "rb")) == NULL)
307 debug_print("Mark/Cache file '%s' not found\n", file);
309 if (buf && buf_size > 0)
310 setvbuf(fp, buf, _IOFBF, buf_size);
311 if (fread(&data_ver, sizeof(data_ver), 1, fp) != 1 ||
312 version != bswap_32(data_ver)) {
313 g_message("%s: Mark/Cache version is different (%u != %u).\n",
314 file, bswap_32(data_ver), version);
318 data_ver = bswap_32(data_ver);
321 if (mode == DATA_READ)
325 /* reopen with append mode */
327 if ((fp = g_fopen(file, "ab")) == NULL)
328 FILE_OP_ERROR(file, "fopen");
330 /* open with overwrite mode if mark file doesn't exist or
331 version is different */
332 fp = msgcache_open_data_file(file, version, DATA_WRITE, buf,
339 static gint msgcache_read_cache_data_str(FILE *fp, gchar **str,
340 StringConverter *conv)
342 gchar *tmpstr = NULL;
348 if ((ni = fread(&len, sizeof(len), 1, fp) != 1) ||
350 g_warning("read_data_str: Cache data (len) corrupted, read %d "
351 "of %d bytes at offset %ld\n", ni, sizeof(len),
356 if ((ni = fread(&len, sizeof(len), 1, fp) != 1) ||
357 bswap_32(len) > G_MAXINT) {
358 g_warning("read_data_str: Cache data (len) corrupted, read %d "
359 "of %d bytes at offset %ld\n", ni, sizeof(len),
369 tmpstr = g_malloc(len + 1);
371 if ((ni = fread(tmpstr, 1, len, fp)) != len) {
372 g_warning("read_data_str: Cache data corrupted, read %d of %d "
373 "bytes at offset %ld\n",
381 *str = conv->convert(conv, tmpstr);
389 gchar *strconv_strdup_convert(StringConverter *conv, gchar *srcstr)
391 return g_strdup(srcstr);
394 gchar *strconv_charset_convert(StringConverter *conv, gchar *srcstr)
396 CharsetConverter *charsetconv = (CharsetConverter *) conv;
398 return conv_codeset_strdup(srcstr, charsetconv->srccharset, charsetconv->dstcharset);
401 void strconv_charset_free(StringConverter *conv)
403 CharsetConverter *charsetconv = (CharsetConverter *) conv;
405 g_free(charsetconv->srccharset);
406 g_free(charsetconv->dstcharset);
409 MsgCache *msgcache_read_cache(FolderItem *item, const gchar *cache_file)
414 MsgTmpFlags tmp_flags = 0;
415 gchar file_buf[BUFFSIZE];
418 gboolean error = FALSE;
419 StringConverter *conv = NULL;
420 gchar *srccharset = NULL;
421 const gchar *dstcharset = NULL;
426 struct timeval start;
429 gettimeofday(&start, NULL);
431 g_return_val_if_fail(cache_file != NULL, NULL);
432 g_return_val_if_fail(item != NULL, NULL);
436 /* In case we can't open the mark file with MARK_VERSION, check if we can open it with the
437 * swapped MARK_VERSION. As msgcache_open_data_file swaps it too, if this succeeds,
438 * it means it's the old version (not little-endian) on a big-endian machine. The code has
439 * no effect on x86 as their file doesn't change. */
441 if ((fp = msgcache_open_data_file
442 (cache_file, CACHE_VERSION, DATA_READ, file_buf, sizeof(file_buf))) == NULL) {
443 if ((fp = msgcache_open_data_file
444 (cache_file, bswap_32(CACHE_VERSION), DATA_READ, file_buf, sizeof(file_buf))) == NULL)
450 debug_print("\tReading %sswapped message cache from %s...\n", swapping?"":"un", cache_file);
452 if (folder_has_parent_of_type(item, F_QUEUE)) {
453 tmp_flags |= MSG_QUEUED;
454 } else if (folder_has_parent_of_type(item, F_DRAFT)) {
455 tmp_flags |= MSG_DRAFT;
458 if (msgcache_read_cache_data_str(fp, &srccharset, NULL) < 0)
460 dstcharset = CS_UTF_8;
461 if (srccharset == NULL || dstcharset == NULL) {
463 } else if (strcmp(srccharset, dstcharset) == 0) {
464 debug_print("using Noop Converter\n");
468 CharsetConverter *charsetconv;
470 debug_print("using CharsetConverter\n");
472 charsetconv = g_new0(CharsetConverter, 1);
473 charsetconv->converter.convert = strconv_charset_convert;
474 charsetconv->converter.free = strconv_charset_free;
475 charsetconv->srccharset = g_strdup(srccharset);
476 charsetconv->dstcharset = g_strdup(dstcharset);
478 conv = (StringConverter *) charsetconv;
482 cache = msgcache_new();
484 while (fread(&num, sizeof(num), 1, fp) == 1) {
488 msginfo = procmsg_msginfo_new();
489 msginfo->msgnum = num;
490 memusage += sizeof(MsgInfo);
492 READ_CACHE_DATA_INT(msginfo->size, fp);
493 READ_CACHE_DATA_INT(msginfo->mtime, fp);
494 READ_CACHE_DATA_INT(msginfo->date_t, fp);
495 READ_CACHE_DATA_INT(msginfo->flags.tmp_flags, fp);
497 READ_CACHE_DATA(msginfo->fromname, fp, memusage);
499 READ_CACHE_DATA(msginfo->date, fp, memusage);
500 READ_CACHE_DATA(msginfo->from, fp, memusage);
501 READ_CACHE_DATA(msginfo->to, fp, memusage);
502 READ_CACHE_DATA(msginfo->cc, fp, memusage);
503 READ_CACHE_DATA(msginfo->newsgroups, fp, memusage);
504 READ_CACHE_DATA(msginfo->subject, fp, memusage);
505 READ_CACHE_DATA(msginfo->msgid, fp, memusage);
506 READ_CACHE_DATA(msginfo->inreplyto, fp, memusage);
507 READ_CACHE_DATA(msginfo->xref, fp, memusage);
509 READ_CACHE_DATA_INT(msginfo->planned_download, fp);
510 READ_CACHE_DATA_INT(msginfo->total_size, fp);
511 READ_CACHE_DATA_INT(refnum, fp);
513 for (; refnum != 0; refnum--) {
516 READ_CACHE_DATA(ref, fp, memusage);
518 if (ref && strlen(ref))
519 msginfo->references =
520 g_slist_prepend(msginfo->references, ref);
522 if (msginfo->references)
523 msginfo->references =
524 g_slist_reverse(msginfo->references);
526 msginfo->folder = item;
527 msginfo->flags.tmp_flags |= tmp_flags;
529 g_hash_table_insert(cache->msgnum_table, &msginfo->msgnum, msginfo);
531 g_hash_table_insert(cache->msgid_table, msginfo->msgid, msginfo);
536 if (conv->free != NULL)
542 msgcache_destroy(cache);
546 cache->last_access = time(NULL);
547 cache->memusage = memusage;
549 debug_print("done. (%d items read)\n", g_hash_table_size(cache->msgnum_table));
550 debug_print("Cache size: %d messages, %d byte\n", g_hash_table_size(cache->msgnum_table), cache->memusage);
552 gettimeofday(&end, NULL);
553 timersub(&end, &start, &diff);
554 printf("spent %d seconds %d usages %d;%d\n", diff.tv_sec, diff.tv_usec, cache->memusage, memusage);
559 void msgcache_read_mark(MsgCache *cache, const gchar *mark_file)
563 MsgPermFlags perm_flags;
568 /* In case we can't open the mark file with MARK_VERSION, check if we can open it with the
569 * swapped MARK_VERSION. As msgcache_open_data_file swaps it too, if this succeeds,
570 * it means it's the old version (not little-endian) on a big-endian machine. The code has
571 * no effect on x86 as their file doesn't change. */
573 if ((fp = msgcache_open_data_file(mark_file, MARK_VERSION, DATA_READ, NULL, 0)) == NULL) {
574 /* see if it isn't swapped ? */
575 if ((fp = msgcache_open_data_file(mark_file, bswap_32(MARK_VERSION), DATA_READ, NULL, 0)) == NULL)
578 swapping = FALSE; /* yay */
580 debug_print("reading %sswapped mark file.\n", swapping?"":"un");
581 while (fread(&num, sizeof(num), 1, fp) == 1) {
584 if (fread(&perm_flags, sizeof(perm_flags), 1, fp) != 1) break;
586 perm_flags = bswap_32(perm_flags);
587 msginfo = g_hash_table_lookup(cache->msgnum_table, &num);
589 msginfo->flags.perm_flags = perm_flags;
595 void msgcache_write_cache(MsgInfo *msginfo, FILE *fp)
597 MsgTmpFlags flags = msginfo->flags.tmp_flags & MSG_CACHED_FLAG_MASK;
600 WRITE_CACHE_DATA_INT(msginfo->msgnum, fp);
601 WRITE_CACHE_DATA_INT(msginfo->size, fp);
602 WRITE_CACHE_DATA_INT(msginfo->mtime, fp);
603 WRITE_CACHE_DATA_INT(msginfo->date_t, fp);
604 WRITE_CACHE_DATA_INT(flags, fp);
606 WRITE_CACHE_DATA(msginfo->fromname, fp);
608 WRITE_CACHE_DATA(msginfo->date, fp);
609 WRITE_CACHE_DATA(msginfo->from, fp);
610 WRITE_CACHE_DATA(msginfo->to, fp);
611 WRITE_CACHE_DATA(msginfo->cc, fp);
612 WRITE_CACHE_DATA(msginfo->newsgroups, fp);
613 WRITE_CACHE_DATA(msginfo->subject, fp);
614 WRITE_CACHE_DATA(msginfo->msgid, fp);
615 WRITE_CACHE_DATA(msginfo->inreplyto, fp);
616 WRITE_CACHE_DATA(msginfo->xref, fp);
617 WRITE_CACHE_DATA_INT(msginfo->planned_download, fp);
618 WRITE_CACHE_DATA_INT(msginfo->total_size, fp);
620 WRITE_CACHE_DATA_INT(g_slist_length(msginfo->references), fp);
622 for (cur = msginfo->references; cur != NULL; cur = cur->next) {
623 WRITE_CACHE_DATA((gchar *)cur->data, fp);
627 static void msgcache_write_flags(MsgInfo *msginfo, FILE *fp)
629 MsgPermFlags flags = msginfo->flags.perm_flags;
631 WRITE_CACHE_DATA_INT(msginfo->msgnum, fp);
632 WRITE_CACHE_DATA_INT(flags, fp);
641 static void msgcache_write_func(gpointer key, gpointer value, gpointer user_data)
644 struct write_fps *write_fps;
646 msginfo = (MsgInfo *)value;
647 write_fps = user_data;
649 msgcache_write_cache(msginfo, write_fps->cache_fp);
650 msgcache_write_flags(msginfo, write_fps->mark_fp);
653 gint msgcache_write(const gchar *cache_file, const gchar *mark_file, MsgCache *cache)
655 struct write_fps write_fps;
657 g_return_val_if_fail(cache_file != NULL, -1);
658 g_return_val_if_fail(mark_file != NULL, -1);
659 g_return_val_if_fail(cache != NULL, -1);
661 write_fps.cache_fp = msgcache_open_data_file(cache_file, CACHE_VERSION,
662 DATA_WRITE, NULL, 0);
663 if (write_fps.cache_fp == NULL)
666 WRITE_CACHE_DATA(CS_UTF_8, write_fps.cache_fp);
668 write_fps.mark_fp = msgcache_open_data_file(mark_file, MARK_VERSION,
669 DATA_WRITE, NULL, 0);
670 if (write_fps.mark_fp == NULL) {
671 fclose(write_fps.cache_fp);
675 debug_print("\tWriting message cache to %s and %s...\n", cache_file, mark_file);
677 if (change_file_mode_rw(write_fps.cache_fp, cache_file) < 0)
678 FILE_OP_ERROR(cache_file, "chmod");
680 g_hash_table_foreach(cache->msgnum_table, msgcache_write_func, (gpointer)&write_fps);
682 fclose(write_fps.cache_fp);
683 fclose(write_fps.mark_fp);
685 cache->last_access = time(NULL);
687 debug_print("done.\n");