sync with main 0.9.11cvs1
[claws.git] / src / msgcache.c
index 3fd6bc3..0a3c956 100644 (file)
 #include "utils.h"
 #include "procmsg.h"
 
+typedef enum
+{
+       DATA_READ,
+       DATA_WRITE,
+       DATA_APPEND
+} DataOpenMode;
+
 struct _MsgCache {
        GHashTable      *msgnum_table;
        GHashTable      *msgid_table;
@@ -77,7 +84,7 @@ void msgcache_add_msg(MsgCache *cache, MsgInfo *msginfo)
        cache->memusage += procmsg_msginfo_memusage(msginfo);
        cache->last_access = time(NULL);
 
-       debug_print("Cache size: %d messages, %d byte\n", g_hash_table_size(cache->msgnum_table), cache->memusage);
+       debug_print("Cache size: %d messages, %d bytes\n", g_hash_table_size(cache->msgnum_table), cache->memusage);
 }
 
 void msgcache_remove_msg(MsgCache *cache, guint msgnum)
@@ -128,14 +135,180 @@ void msgcache_update_msg(MsgCache *cache, MsgInfo *msginfo)
        return;
 }
 
+MsgInfo *msgcache_get_msg(MsgCache *cache, guint num)
+{
+       MsgInfo *msginfo;
+
+       g_return_val_if_fail(cache != NULL, NULL);
+
+       msginfo = g_hash_table_lookup(cache->msgnum_table, &num);
+       if(!msginfo)
+               return NULL;
+       cache->last_access = time(NULL);
+       
+       return procmsg_msginfo_new_ref(msginfo);
+}
+
+MsgInfo *msgcache_get_msg_by_id(MsgCache *cache, const gchar *msgid)
+{
+       MsgInfo *msginfo;
+       
+       g_return_val_if_fail(cache != NULL, NULL);
+       g_return_val_if_fail(msgid != NULL, NULL);
+
+       msginfo = g_hash_table_lookup(cache->msgid_table, msgid);
+       if(!msginfo)
+               return NULL;
+       cache->last_access = time(NULL);
+       
+       return procmsg_msginfo_new_ref(msginfo);        
+}
+
+static void msgcache_get_msg_list_func(gpointer key, gpointer value, gpointer user_data)
+{
+       MsgInfoList **listptr = user_data;
+       MsgInfo *msginfo = value;
+
+       *listptr = g_slist_prepend(*listptr, procmsg_msginfo_new_ref(msginfo));
+}
+
+MsgInfoList *msgcache_get_msg_list(MsgCache *cache)
+{
+       MsgInfoList *msg_list = NULL;
+
+       g_return_val_if_fail(cache != NULL, NULL);
+
+       g_hash_table_foreach((GHashTable *)cache->msgnum_table, msgcache_get_msg_list_func, (gpointer)&msg_list);       
+       cache->last_access = time(NULL);
+       
+       msg_list = g_slist_reverse(msg_list);
+
+       return msg_list;
+}
+
+time_t msgcache_get_last_access_time(MsgCache *cache)
+{
+       g_return_val_if_fail(cache != NULL, 0);
+       
+       return cache->last_access;
+}
+
+gint msgcache_get_memory_usage(MsgCache *cache)
+{
+       g_return_val_if_fail(cache != NULL, 0);
+
+       return cache->memusage;
+}
+
+/*
+ *  Cache saving functions
+ */
+
+#define READ_CACHE_DATA(data, fp) \
+{ \
+       if (msgcache_read_cache_data_str(fp, &data) < 0) { \
+               procmsg_msginfo_free(msginfo); \
+               error = TRUE; \
+               break; \
+       } \
+}
+
+#define READ_CACHE_DATA_INT(n, fp) \
+{ \
+       guint32 idata; \
+ \
+       if (fread(&idata, sizeof(idata), 1, fp) != 1) { \
+               g_warning("Cache data is corrupted\n"); \
+               procmsg_msginfo_free(msginfo); \
+               error = TRUE; \
+               break; \
+       } else \
+               n = idata;\
+}
+
+#define WRITE_CACHE_DATA_INT(n, fp)            \
+{                                              \
+       guint32 idata;                          \
+                                               \
+       idata = (guint32)n;                     \
+       fwrite(&idata, sizeof(idata), 1, fp);   \
+}
+
+#define WRITE_CACHE_DATA(data, fp) \
+{ \
+       size_t len; \
+       if (data == NULL) \
+               len = 0; \
+       else \
+               len = strlen(data); \
+       WRITE_CACHE_DATA_INT(len, fp); \
+       if (len > 0) { \
+               fwrite(data, len, 1, fp); \
+       } \
+}
+
+static FILE *msgcache_open_data_file(const gchar *file, gint version,
+                                    DataOpenMode mode,
+                                    gchar *buf, size_t buf_size)
+{
+       FILE *fp;
+       gint data_ver;
+
+       g_return_val_if_fail(file != NULL, NULL);
+
+       if (mode == DATA_WRITE) {
+               if ((fp = fopen(file, "wb")) == NULL) {
+                       FILE_OP_ERROR(file, "fopen");
+                       return NULL;
+               }
+               if (change_file_mode_rw(fp, file) < 0)
+                       FILE_OP_ERROR(file, "chmod");
+
+               WRITE_CACHE_DATA_INT(version, fp);
+               return fp;
+       }
+
+       /* check version */
+       if ((fp = fopen(file, "rb")) == NULL)
+               debug_print("Mark/Cache file not found\n");
+       else {
+               if (buf && buf_size > 0)
+                       setvbuf(fp, buf, _IOFBF, buf_size);
+               if (fread(&data_ver, sizeof(data_ver), 1, fp) != 1 ||
+                        version != data_ver) {
+                       debug_print("Mark/Cache version is different (%d != %d). "
+                                   "Discarding it.\n", data_ver, version);
+                       fclose(fp);
+                       fp = NULL;
+               }
+       }
+
+       if (mode == DATA_READ)
+               return fp;
+
+       if (fp) {
+               /* reopen with append mode */
+               fclose(fp);
+               if ((fp = fopen(file, "ab")) == NULL)
+                       FILE_OP_ERROR(file, "fopen");
+       } else {
+               /* open with overwrite mode if mark file doesn't exist or
+                  version is different */
+               fp = msgcache_open_data_file(file, version, DATA_WRITE, buf,
+                                           buf_size);
+       }
+
+       return fp;
+}
+
 static gint msgcache_read_cache_data_str(FILE *fp, gchar **str)
 {
        gchar buf[BUFFSIZE];
        gint ret = 0;
-       size_t len;
+       guint32 len;
 
        if (fread(&len, sizeof(len), 1, fp) == 1) {
-               if (len < 0)
+               if (len > G_MAXINT)
                        ret = -1;
                else {
                        gchar *tmp = NULL;
@@ -170,26 +343,6 @@ static gint msgcache_read_cache_data_str(FILE *fp, gchar **str)
        return ret;
 }
 
-
-#define READ_CACHE_DATA(data, fp) \
-{ \
-       if (msgcache_read_cache_data_str(fp, &data) < 0) { \
-               procmsg_msginfo_free(msginfo); \
-               error = TRUE; \
-               break; \
-       } \
-}
-
-#define READ_CACHE_DATA_INT(n, fp) \
-{ \
-       if (fread(&n, sizeof(n), 1, fp) != 1) { \
-               g_warning("Cache data is corrupted\n"); \
-               procmsg_msginfo_free(msginfo); \
-               error = TRUE; \
-               break; \
-       } \
-}
-
 MsgCache *msgcache_read_cache(FolderItem *item, const gchar *cache_file)
 {
        MsgCache *cache;
@@ -197,29 +350,18 @@ MsgCache *msgcache_read_cache(FolderItem *item, const gchar *cache_file)
        MsgInfo *msginfo;
        MsgTmpFlags tmp_flags = 0;
        gchar file_buf[BUFFSIZE];
-       gint ver;
        guint num;
        gboolean error = FALSE;
 
        g_return_val_if_fail(cache_file != NULL, NULL);
        g_return_val_if_fail(item != NULL, NULL);
 
-       if ((fp = fopen(cache_file, "rb")) == NULL) {
-               debug_print("\tNo cache file\n");
+       if ((fp = msgcache_open_data_file
+               (cache_file, CACHE_VERSION, DATA_READ, file_buf, sizeof(file_buf))) == NULL)
                return NULL;
-       }
-       setvbuf(fp, file_buf, _IOFBF, sizeof(file_buf));
 
        debug_print("\tReading message cache from %s...\n", cache_file);
 
-       /* compare cache version */
-       if (fread(&ver, sizeof(ver), 1, fp) != 1 ||
-           CACHE_VERSION != ver) {
-               debug_print("Cache version is different. Discarding it.\n");
-               fclose(fp);
-               return NULL;
-       }
-
        if (item->stype == F_QUEUE) {
                tmp_flags |= MSG_QUEUED;
        } else if (item->stype == F_DRAFT) {
@@ -281,46 +423,24 @@ void msgcache_read_mark(MsgCache *cache, const gchar *mark_file)
        FILE *fp;
        MsgInfo *msginfo;
        MsgPermFlags perm_flags;
-       gint ver;
        guint num;
 
-       if ((fp = fopen(mark_file, "rb")) == NULL) {
-               debug_print("Mark file not found.\n");
+       if ((fp = msgcache_open_data_file(mark_file, MARK_VERSION, DATA_READ, NULL, 0)) == NULL)
                return;
-       } else if (fread(&ver, sizeof(ver), 1, fp) != 1 || MARK_VERSION != ver) {
-               debug_print("Mark version is different (%d != %d). "
-                             "Discarding it.\n", ver, MARK_VERSION);
-       } else {
-               debug_print("\tReading message marks from %s...\n", mark_file);
 
-               while (fread(&num, sizeof(num), 1, fp) == 1) {
-                       if (fread(&perm_flags, sizeof(perm_flags), 1, fp) != 1) break;
+       debug_print("\tReading message marks from %s...\n", mark_file);
 
-                       msginfo = g_hash_table_lookup(cache->msgnum_table, &num);
-                       if(msginfo) {
-                               msginfo->flags.perm_flags = perm_flags;
-                       }
+       while (fread(&num, sizeof(num), 1, fp) == 1) {
+               if (fread(&perm_flags, sizeof(perm_flags), 1, fp) != 1) break;
+
+               msginfo = g_hash_table_lookup(cache->msgnum_table, &num);
+               if(msginfo) {
+                       msginfo->flags.perm_flags = perm_flags;
                }
        }
        fclose(fp);
 }
 
-#define WRITE_CACHE_DATA_INT(n, fp) \
-       fwrite(&n, sizeof(n), 1, fp)
-
-#define WRITE_CACHE_DATA(data, fp) \
-{ \
-       gint len; \
-       if (data == NULL) \
-               len = 0; \
-       else \
-               len = strlen(data); \
-       WRITE_CACHE_DATA_INT(len, fp); \
-       if (len > 0) { \
-               fwrite(data, len, 1, fp); \
-       } \
-}
-
 void msgcache_write_cache(MsgInfo *msginfo, FILE *fp)
 {
        MsgTmpFlags flags = msginfo->flags.tmp_flags & MSG_CACHED_FLAG_MASK;
@@ -373,36 +493,28 @@ static void msgcache_write_func(gpointer key, gpointer value, gpointer user_data
 
 gint msgcache_write(const gchar *cache_file, const gchar *mark_file, MsgCache *cache)
 {
-       FILE *fp;
        struct write_fps write_fps;
-       gint ver;
 
        g_return_val_if_fail(cache_file != NULL, -1);
        g_return_val_if_fail(mark_file != NULL, -1);
        g_return_val_if_fail(cache != NULL, -1);
 
-       debug_print("\tWriting message cache to %s and %s...\n", cache_file, mark_file);
-
-       if ((fp = fopen(cache_file, "wb")) == NULL) {
-               FILE_OP_ERROR(cache_file, "fopen");
+       write_fps.cache_fp = msgcache_open_data_file(cache_file, CACHE_VERSION,
+               DATA_WRITE, NULL, 0);
+       if (write_fps.cache_fp == NULL)
                return -1;
-       }
-       if (change_file_mode_rw(fp, cache_file) < 0)
-               FILE_OP_ERROR(cache_file, "chmod");
-
-       ver = CACHE_VERSION;
-       WRITE_CACHE_DATA_INT(ver, fp);  
-       write_fps.cache_fp = fp;
 
-       if ((fp = fopen(mark_file, "wb")) == NULL) {
-               FILE_OP_ERROR(mark_file, "fopen");
+       write_fps.mark_fp = msgcache_open_data_file(mark_file, MARK_VERSION,
+               DATA_WRITE, NULL, 0);
+       if (write_fps.mark_fp == NULL) {
                fclose(write_fps.cache_fp);
                return -1;
        }
 
-       ver = MARK_VERSION;
-       WRITE_CACHE_DATA_INT(ver, fp);
-       write_fps.mark_fp = fp;
+       debug_print("\tWriting message cache to %s and %s...\n", cache_file, mark_file);
+
+       if (change_file_mode_rw(write_fps.cache_fp, cache_file) < 0)
+               FILE_OP_ERROR(cache_file, "chmod");
 
        g_hash_table_foreach(cache->msgnum_table, msgcache_write_func, (gpointer)&write_fps);
 
@@ -415,66 +527,3 @@ gint msgcache_write(const gchar *cache_file, const gchar *mark_file, MsgCache *c
        return 0;
 }
 
-MsgInfo *msgcache_get_msg(MsgCache *cache, guint num)
-{
-       MsgInfo *msginfo;
-
-       g_return_val_if_fail(cache != NULL, NULL);
-
-       msginfo = g_hash_table_lookup(cache->msgnum_table, &num);
-       if(!msginfo)
-               return NULL;
-       cache->last_access = time(NULL);
-       
-       return procmsg_msginfo_new_ref(msginfo);
-}
-
-MsgInfo *msgcache_get_msg_by_id(MsgCache *cache, const gchar *msgid)
-{
-       MsgInfo *msginfo;
-       
-       g_return_val_if_fail(cache != NULL, NULL);
-
-       msginfo = g_hash_table_lookup(cache->msgid_table, msgid);
-       if(!msginfo)
-               return NULL;
-       cache->last_access = time(NULL);
-       
-       return procmsg_msginfo_new_ref(msginfo);        
-}
-
-static void msgcache_get_msg_list_func(gpointer key, gpointer value, gpointer user_data)
-{
-       MsgInfoList **listptr = user_data;
-       MsgInfo *msginfo = value;
-
-       *listptr = g_slist_prepend(*listptr, procmsg_msginfo_new_ref(msginfo));
-}
-
-MsgInfoList *msgcache_get_msg_list(MsgCache *cache)
-{
-       MsgInfoList *msg_list = NULL;
-
-       g_return_val_if_fail(cache != NULL, NULL);
-
-       g_hash_table_foreach((GHashTable *)cache->msgnum_table, msgcache_get_msg_list_func, (gpointer)&msg_list);       
-       cache->last_access = time(NULL);
-       
-       msg_list = g_slist_reverse(msg_list);
-
-       return msg_list;
-}
-
-time_t msgcache_get_last_access_time(MsgCache *cache)
-{
-       g_return_val_if_fail(cache != NULL, 0);
-       
-       return cache->last_access;
-}
-
-gint msgcache_get_memory_usage(MsgCache *cache)
-{
-       g_return_val_if_fail(cache != NULL, 0);
-
-       return cache->memusage;
-}