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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 #include <glib/gi18n.h>
36 ((((x) & 0xff000000) >> 24) | (((x) & 0x00ff0000) >> 8) | \
37 (((x) & 0x0000ff00) << 8) | (((x) & 0x000000ff) << 24))
39 #define bswap_32(x) (x)
42 static gboolean swapping = TRUE;
52 GHashTable *msgnum_table;
53 GHashTable *msgid_table;
58 typedef struct _StringConverter StringConverter;
59 struct _StringConverter {
60 gchar *(*convert) (StringConverter *converter, gchar *srcstr);
61 void (*free) (StringConverter *converter);
64 typedef struct _StrdupConverter StrdupConverter;
65 struct _StrdupConverter {
66 StringConverter converter;
69 typedef struct _CharsetConverter CharsetConverter;
70 struct _CharsetConverter {
71 StringConverter converter;
77 MsgCache *msgcache_new(void)
81 cache = g_new0(MsgCache, 1),
82 cache->msgnum_table = g_hash_table_new(g_int_hash, g_int_equal);
83 cache->msgid_table = g_hash_table_new(g_str_hash, g_str_equal);
84 cache->last_access = time(NULL);
89 static gboolean msgcache_msginfo_free_func(gpointer num, gpointer msginfo, gpointer user_data)
91 procmsg_msginfo_free((MsgInfo *)msginfo);
95 void msgcache_destroy(MsgCache *cache)
97 g_return_if_fail(cache != NULL);
99 g_hash_table_foreach_remove(cache->msgnum_table, msgcache_msginfo_free_func, NULL);
100 g_hash_table_destroy(cache->msgid_table);
101 g_hash_table_destroy(cache->msgnum_table);
105 void msgcache_add_msg(MsgCache *cache, MsgInfo *msginfo)
109 g_return_if_fail(cache != NULL);
110 g_return_if_fail(msginfo != NULL);
112 newmsginfo = procmsg_msginfo_new_ref(msginfo);
113 g_hash_table_insert(cache->msgnum_table, &newmsginfo->msgnum, newmsginfo);
114 if(newmsginfo->msgid != NULL)
115 g_hash_table_insert(cache->msgid_table, newmsginfo->msgid, newmsginfo);
116 cache->memusage += procmsg_msginfo_memusage(msginfo);
117 cache->last_access = time(NULL);
119 debug_print("Cache size: %d messages, %d bytes\n", g_hash_table_size(cache->msgnum_table), cache->memusage);
122 void msgcache_remove_msg(MsgCache *cache, guint msgnum)
126 g_return_if_fail(cache != NULL);
127 g_return_if_fail(msgnum > 0);
129 msginfo = (MsgInfo *) g_hash_table_lookup(cache->msgnum_table, &msgnum);
133 cache->memusage -= procmsg_msginfo_memusage(msginfo);
135 g_hash_table_remove(cache->msgid_table, msginfo->msgid);
136 g_hash_table_remove(cache->msgnum_table, &msginfo->msgnum);
137 procmsg_msginfo_free(msginfo);
138 cache->last_access = time(NULL);
140 debug_print("Cache size: %d messages, %d byte\n", g_hash_table_size(cache->msgnum_table), cache->memusage);
143 void msgcache_update_msg(MsgCache *cache, MsgInfo *msginfo)
145 MsgInfo *oldmsginfo, *newmsginfo;
147 g_return_if_fail(cache != NULL);
148 g_return_if_fail(msginfo != NULL);
150 oldmsginfo = g_hash_table_lookup(cache->msgnum_table, &msginfo->msgnum);
151 if(oldmsginfo && oldmsginfo->msgid)
152 g_hash_table_remove(cache->msgid_table, oldmsginfo->msgid);
154 g_hash_table_remove(cache->msgnum_table, &oldmsginfo->msgnum);
155 cache->memusage -= procmsg_msginfo_memusage(oldmsginfo);
156 procmsg_msginfo_free(oldmsginfo);
159 newmsginfo = procmsg_msginfo_new_ref(msginfo);
160 g_hash_table_insert(cache->msgnum_table, &newmsginfo->msgnum, newmsginfo);
161 if(newmsginfo->msgid)
162 g_hash_table_insert(cache->msgid_table, newmsginfo->msgid, newmsginfo);
163 cache->memusage += procmsg_msginfo_memusage(newmsginfo);
164 cache->last_access = time(NULL);
166 debug_print("Cache size: %d messages, %d byte\n", g_hash_table_size(cache->msgnum_table), cache->memusage);
171 MsgInfo *msgcache_get_msg(MsgCache *cache, guint num)
175 g_return_val_if_fail(cache != NULL, NULL);
177 msginfo = g_hash_table_lookup(cache->msgnum_table, &num);
180 cache->last_access = time(NULL);
182 return procmsg_msginfo_new_ref(msginfo);
185 MsgInfo *msgcache_get_msg_by_id(MsgCache *cache, const gchar *msgid)
189 g_return_val_if_fail(cache != NULL, NULL);
190 g_return_val_if_fail(msgid != NULL, NULL);
192 msginfo = g_hash_table_lookup(cache->msgid_table, msgid);
195 cache->last_access = time(NULL);
197 return procmsg_msginfo_new_ref(msginfo);
200 static void msgcache_get_msg_list_func(gpointer key, gpointer value, gpointer user_data)
202 MsgInfoList **listptr = user_data;
203 MsgInfo *msginfo = value;
205 *listptr = g_slist_prepend(*listptr, procmsg_msginfo_new_ref(msginfo));
208 MsgInfoList *msgcache_get_msg_list(MsgCache *cache)
210 MsgInfoList *msg_list = NULL;
212 g_return_val_if_fail(cache != NULL, NULL);
214 g_hash_table_foreach((GHashTable *)cache->msgnum_table, msgcache_get_msg_list_func, (gpointer)&msg_list);
215 cache->last_access = time(NULL);
217 msg_list = g_slist_reverse(msg_list);
222 time_t msgcache_get_last_access_time(MsgCache *cache)
224 g_return_val_if_fail(cache != NULL, 0);
226 return cache->last_access;
229 gint msgcache_get_memory_usage(MsgCache *cache)
231 g_return_val_if_fail(cache != NULL, 0);
233 return cache->memusage;
237 * Cache saving functions
240 #define READ_CACHE_DATA(data, fp, total_len) \
242 if ((tmp_len = msgcache_read_cache_data_str(fp, &data, conv)) < 0) { \
243 procmsg_msginfo_free(msginfo); \
247 total_len += tmp_len; \
250 #define READ_CACHE_DATA_INT(n, fp) \
255 if ((ni = fread(&idata, sizeof(idata), 1, fp)) != 1) { \
256 g_warning("read_int: Cache data corrupted, read %d of %d at " \
257 "offset %ld\n", ni, sizeof(idata), ftell(fp)); \
258 procmsg_msginfo_free(msginfo); \
262 n = swapping ? bswap_32(idata) : (idata);\
265 #define WRITE_CACHE_DATA_INT(n, fp) \
269 idata = (guint32)bswap_32(n); \
270 fwrite(&idata, sizeof(idata), 1, fp); \
273 #define WRITE_CACHE_DATA(data, fp) \
279 len = strlen(data); \
280 WRITE_CACHE_DATA_INT(len, fp); \
282 fwrite(data, len, 1, fp); \
286 static FILE *msgcache_open_data_file(const gchar *file, guint version,
288 gchar *buf, size_t buf_size)
293 g_return_val_if_fail(file != NULL, NULL);
295 if (mode == DATA_WRITE) {
296 if ((fp = fopen(file, "wb")) == NULL) {
297 FILE_OP_ERROR(file, "fopen");
300 if (change_file_mode_rw(fp, file) < 0)
301 FILE_OP_ERROR(file, "chmod");
303 WRITE_CACHE_DATA_INT(version, fp);
308 if ((fp = fopen(file, "rb")) == NULL)
309 debug_print("Mark/Cache file '%s' not found\n", file);
311 if (buf && buf_size > 0)
312 setvbuf(fp, buf, _IOFBF, buf_size);
313 if (fread(&data_ver, sizeof(data_ver), 1, fp) != 1 ||
314 version != bswap_32(data_ver)) {
315 g_message("%s: Mark/Cache version is different (%u != %u).\n",
316 file, bswap_32(data_ver), version);
320 data_ver = bswap_32(data_ver);
323 if (mode == DATA_READ)
327 /* reopen with append mode */
329 if ((fp = fopen(file, "ab")) == NULL)
330 FILE_OP_ERROR(file, "fopen");
332 /* open with overwrite mode if mark file doesn't exist or
333 version is different */
334 fp = msgcache_open_data_file(file, version, DATA_WRITE, buf,
341 static gint msgcache_read_cache_data_str(FILE *fp, gchar **str,
342 StringConverter *conv)
344 gchar *tmpstr = NULL;
350 if ((ni = fread(&len, sizeof(len), 1, fp) != 1) ||
352 g_warning("read_data_str: Cache data (len) corrupted, read %d "
353 "of %d bytes at offset %ld\n", ni, sizeof(len),
358 if ((ni = fread(&len, sizeof(len), 1, fp) != 1) ||
359 bswap_32(len) > G_MAXINT) {
360 g_warning("read_data_str: Cache data (len) corrupted, read %d "
361 "of %d bytes at offset %ld\n", ni, sizeof(len),
371 tmpstr = g_malloc(len + 1);
373 if ((ni = fread(tmpstr, 1, len, fp)) != len) {
374 g_warning("read_data_str: Cache data corrupted, read %d of %d "
375 "bytes at offset %ld\n",
383 *str = conv->convert(conv, tmpstr);
391 gchar *strconv_strdup_convert(StringConverter *conv, gchar *srcstr)
393 return g_strdup(srcstr);
396 gchar *strconv_charset_convert(StringConverter *conv, gchar *srcstr)
398 CharsetConverter *charsetconv = (CharsetConverter *) conv;
400 return conv_codeset_strdup(srcstr, charsetconv->srccharset, charsetconv->dstcharset);
403 void strconv_charset_free(StringConverter *conv)
405 CharsetConverter *charsetconv = (CharsetConverter *) conv;
407 g_free(charsetconv->srccharset);
408 g_free(charsetconv->dstcharset);
411 MsgCache *msgcache_read_cache(FolderItem *item, const gchar *cache_file)
416 MsgTmpFlags tmp_flags = 0;
417 gchar file_buf[BUFFSIZE];
420 gboolean error = FALSE;
421 StringConverter *conv = NULL;
422 gchar *srccharset = NULL;
423 const gchar *dstcharset = NULL;
428 struct timeval start;
431 gettimeofday(&start, NULL);
433 g_return_val_if_fail(cache_file != NULL, NULL);
434 g_return_val_if_fail(item != NULL, NULL);
438 /* In case we can't open the mark file with MARK_VERSION, check if we can open it with the
439 * swapped MARK_VERSION. As msgcache_open_data_file swaps it too, if this succeeds,
440 * it means it's the old version (not little-endian) on a big-endian machine. The code has
441 * no effect on x86 as their file doesn't change. */
443 if ((fp = msgcache_open_data_file
444 (cache_file, CACHE_VERSION, DATA_READ, file_buf, sizeof(file_buf))) == NULL) {
445 if ((fp = msgcache_open_data_file
446 (cache_file, bswap_32(CACHE_VERSION), DATA_READ, file_buf, sizeof(file_buf))) == NULL)
452 debug_print("\tReading %sswapped message cache from %s...\n", swapping?"":"un", cache_file);
454 if (item->stype == F_QUEUE) {
455 tmp_flags |= MSG_QUEUED;
456 } else if (item->stype == F_DRAFT) {
457 tmp_flags |= MSG_DRAFT;
460 if (msgcache_read_cache_data_str(fp, &srccharset, NULL) < 0)
462 dstcharset = CS_UTF_8;
463 if (srccharset == NULL || dstcharset == NULL) {
465 } else if (strcmp(srccharset, dstcharset) == 0) {
466 StrdupConverter *strdupconv;
468 debug_print("using StrdupConverter\n");
470 strdupconv = g_new0(StrdupConverter, 1);
471 strdupconv->converter.convert = strconv_strdup_convert;
472 strdupconv->converter.free = NULL;
474 conv = (StringConverter *) strdupconv;
476 CharsetConverter *charsetconv;
478 debug_print("using CharsetConverter\n");
480 charsetconv = g_new0(CharsetConverter, 1);
481 charsetconv->converter.convert = strconv_charset_convert;
482 charsetconv->converter.free = strconv_charset_free;
483 charsetconv->srccharset = g_strdup(srccharset);
484 charsetconv->dstcharset = g_strdup(dstcharset);
486 conv = (StringConverter *) charsetconv;
490 cache = msgcache_new();
491 g_hash_table_freeze(cache->msgnum_table);
492 g_hash_table_freeze(cache->msgid_table);
494 while (fread(&num, sizeof(num), 1, fp) == 1) {
498 msginfo = procmsg_msginfo_new();
499 msginfo->msgnum = num;
500 memusage += sizeof(MsgInfo);
502 READ_CACHE_DATA_INT(msginfo->size, fp);
503 READ_CACHE_DATA_INT(msginfo->mtime, fp);
504 READ_CACHE_DATA_INT(msginfo->date_t, fp);
505 READ_CACHE_DATA_INT(msginfo->flags.tmp_flags, fp);
507 READ_CACHE_DATA(msginfo->fromname, fp, memusage);
509 READ_CACHE_DATA(msginfo->date, fp, memusage);
510 READ_CACHE_DATA(msginfo->from, fp, memusage);
511 READ_CACHE_DATA(msginfo->to, fp, memusage);
512 READ_CACHE_DATA(msginfo->cc, fp, memusage);
513 READ_CACHE_DATA(msginfo->newsgroups, fp, memusage);
514 READ_CACHE_DATA(msginfo->subject, fp, memusage);
515 READ_CACHE_DATA(msginfo->msgid, fp, memusage);
516 READ_CACHE_DATA(msginfo->inreplyto, fp, memusage);
517 READ_CACHE_DATA(msginfo->xref, fp, memusage);
519 READ_CACHE_DATA_INT(msginfo->planned_download, fp);
520 READ_CACHE_DATA_INT(msginfo->total_size, fp);
521 READ_CACHE_DATA_INT(refnum, fp);
523 for (; refnum != 0; refnum--) {
526 READ_CACHE_DATA(ref, fp, memusage);
528 if (ref && strlen(ref))
529 msginfo->references =
530 g_slist_prepend(msginfo->references, ref);
532 if (msginfo->references)
533 msginfo->references =
534 g_slist_reverse(msginfo->references);
536 msginfo->folder = item;
537 msginfo->flags.tmp_flags |= tmp_flags;
539 g_hash_table_insert(cache->msgnum_table, &msginfo->msgnum, msginfo);
541 g_hash_table_insert(cache->msgid_table, msginfo->msgid, msginfo);
544 g_hash_table_thaw(cache->msgnum_table);
545 g_hash_table_thaw(cache->msgid_table);
548 if (conv->free != NULL)
554 msgcache_destroy(cache);
558 cache->last_access = time(NULL);
559 cache->memusage = memusage;
561 debug_print("done. (%d items read)\n", g_hash_table_size(cache->msgnum_table));
562 debug_print("Cache size: %d messages, %d byte\n", g_hash_table_size(cache->msgnum_table), cache->memusage);
564 gettimeofday(&end, NULL);
565 timersub(&end, &start, &diff);
566 printf("spent %d seconds %d usages %d;%d\n", diff.tv_sec, diff.tv_usec, cache->memusage, memusage);
571 void msgcache_read_mark(MsgCache *cache, const gchar *mark_file)
575 MsgPermFlags perm_flags;
580 /* In case we can't open the mark file with MARK_VERSION, check if we can open it with the
581 * swapped MARK_VERSION. As msgcache_open_data_file swaps it too, if this succeeds,
582 * it means it's the old version (not little-endian) on a big-endian machine. The code has
583 * no effect on x86 as their file doesn't change. */
585 if ((fp = msgcache_open_data_file(mark_file, MARK_VERSION, DATA_READ, NULL, 0)) == NULL) {
586 /* see if it isn't swapped ? */
587 if ((fp = msgcache_open_data_file(mark_file, bswap_32(MARK_VERSION), DATA_READ, NULL, 0)) == NULL)
590 swapping = FALSE; /* yay */
592 debug_print("reading %sswapped mark file.\n", swapping?"":"un");
593 while (fread(&num, sizeof(num), 1, fp) == 1) {
596 if (fread(&perm_flags, sizeof(perm_flags), 1, fp) != 1) break;
598 perm_flags = bswap_32(perm_flags);
599 msginfo = g_hash_table_lookup(cache->msgnum_table, &num);
601 msginfo->flags.perm_flags = perm_flags;
607 void msgcache_write_cache(MsgInfo *msginfo, FILE *fp)
609 MsgTmpFlags flags = msginfo->flags.tmp_flags & MSG_CACHED_FLAG_MASK;
612 WRITE_CACHE_DATA_INT(msginfo->msgnum, fp);
613 WRITE_CACHE_DATA_INT(msginfo->size, fp);
614 WRITE_CACHE_DATA_INT(msginfo->mtime, fp);
615 WRITE_CACHE_DATA_INT(msginfo->date_t, fp);
616 WRITE_CACHE_DATA_INT(flags, fp);
618 WRITE_CACHE_DATA(msginfo->fromname, fp);
620 WRITE_CACHE_DATA(msginfo->date, fp);
621 WRITE_CACHE_DATA(msginfo->from, fp);
622 WRITE_CACHE_DATA(msginfo->to, fp);
623 WRITE_CACHE_DATA(msginfo->cc, fp);
624 WRITE_CACHE_DATA(msginfo->newsgroups, fp);
625 WRITE_CACHE_DATA(msginfo->subject, fp);
626 WRITE_CACHE_DATA(msginfo->msgid, fp);
627 WRITE_CACHE_DATA(msginfo->inreplyto, fp);
628 WRITE_CACHE_DATA(msginfo->xref, fp);
629 WRITE_CACHE_DATA_INT(msginfo->planned_download, fp);
630 WRITE_CACHE_DATA_INT(msginfo->total_size, fp);
632 WRITE_CACHE_DATA_INT(g_slist_length(msginfo->references), fp);
634 for (cur = msginfo->references; cur != NULL; cur = cur->next) {
635 WRITE_CACHE_DATA((gchar *)cur->data, fp);
639 static void msgcache_write_flags(MsgInfo *msginfo, FILE *fp)
641 MsgPermFlags flags = msginfo->flags.perm_flags;
643 WRITE_CACHE_DATA_INT(msginfo->msgnum, fp);
644 WRITE_CACHE_DATA_INT(flags, fp);
653 static void msgcache_write_func(gpointer key, gpointer value, gpointer user_data)
656 struct write_fps *write_fps;
658 msginfo = (MsgInfo *)value;
659 write_fps = user_data;
661 msgcache_write_cache(msginfo, write_fps->cache_fp);
662 msgcache_write_flags(msginfo, write_fps->mark_fp);
665 gint msgcache_write(const gchar *cache_file, const gchar *mark_file, MsgCache *cache)
667 struct write_fps write_fps;
669 g_return_val_if_fail(cache_file != NULL, -1);
670 g_return_val_if_fail(mark_file != NULL, -1);
671 g_return_val_if_fail(cache != NULL, -1);
673 write_fps.cache_fp = msgcache_open_data_file(cache_file, CACHE_VERSION,
674 DATA_WRITE, NULL, 0);
675 if (write_fps.cache_fp == NULL)
678 WRITE_CACHE_DATA(CS_UTF_8, write_fps.cache_fp);
680 write_fps.mark_fp = msgcache_open_data_file(mark_file, MARK_VERSION,
681 DATA_WRITE, NULL, 0);
682 if (write_fps.mark_fp == NULL) {
683 fclose(write_fps.cache_fp);
687 debug_print("\tWriting message cache to %s and %s...\n", cache_file, mark_file);
689 if (change_file_mode_rw(write_fps.cache_fp, cache_file) < 0)
690 FILE_OP_ERROR(cache_file, "chmod");
692 g_hash_table_foreach(cache->msgnum_table, msgcache_write_func, (gpointer)&write_fps);
694 fclose(write_fps.cache_fp);
695 fclose(write_fps.mark_fp);
697 cache->last_access = time(NULL);
699 debug_print("done.\n");