* src/folder.c
[claws.git] / src / procmsg.h
index d1ac5cd..fef815f 100644 (file)
@@ -1,6 +1,6 @@
 /*
  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 1999,2000 Hiroyuki Yamamoto
+ * Copyright (C) 1999-2003 Hiroyuki Yamamoto
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
 #ifndef __PROCMSG_H__
 #define __PROCMSG_H__
 
+#ifdef HAVE_CONFIG_H
+#  include "config.h"
+#endif
+
 #include <glib.h>
 #include <stdio.h>
 #include <time.h>
 #include <sys/types.h>
 #include <string.h>
 
-typedef struct _MsgInfo                MsgInfo;
+typedef struct _MsgInfo                        MsgInfo;
+typedef struct _MsgFlags               MsgFlags;
+typedef struct _MsgInfoUpdate          MsgInfoUpdate;
+typedef struct _MailFilteringData      MailFilteringData;
 
-#include "folder.h"
+typedef GSList MsgInfoList;
+typedef GSList MsgNumberList;
 
-typedef enum
-{
-       /* permanent flags (0x0000ffff) */
-       MSG_NEW         = 1 << 0,
-       MSG_UNREAD      = 1 << 1,
-       MSG_MARKED      = 1 << 2,
-       MSG_DELETED     = 1 << 3,
-       MSG_REPLIED     = 1 << 4,
-       MSG_FORWARDED   = 1 << 5,
-
-       /* temporary flags (0xffff0000) */
-       MSG_MOVE        = 1 << 16,
-       MSG_COPY        = 1 << 17,
-
-       MSG_QUEUED      = 1 << 25,
-       MSG_DRAFT       = 1 << 26,
-       MSG_ENCRYPTED   = 1 << 27,
-       MSG_IMAP        = 1 << 28,
-       MSG_MIME        = 1 << 29,
-       MSG_NEWS        = 1 << 30,
-       MSG_CACHED      = 1 << 31
-} MsgFlags;
-
-#define MSG_PERMANENT_FLAG_MASK                (MSG_NEW       | \
-                                        MSG_UNREAD    | \
-                                        MSG_MARKED    | \
-                                        MSG_DELETED   | \
-                                        MSG_REPLIED   | \
-                                        MSG_FORWARDED)
-#define MSG_CACHED_FLAG_MASK           (MSG_MIME)
+#define MSG_NEW                        (1U << 0)
+#define MSG_UNREAD             (1U << 1)
+#define MSG_MARKED             (1U << 2)
+#define MSG_DELETED            (1U << 3)
+#define MSG_REPLIED            (1U << 4)
+#define MSG_FORWARDED          (1U << 5)
+#define MSG_REALLY_DELETED     (1U << 6)               /* mbox stuff */
+
+#define MSG_CLABEL_SBIT        (7)             /* start bit of color label */
+#define MAKE_MSG_CLABEL(h, m, l)       (((h) << (MSG_CLABEL_SBIT + 2)) | \
+                                        ((m) << (MSG_CLABEL_SBIT + 1)) | \
+                                        ((l) << (MSG_CLABEL_SBIT + 0)))
+
+#define MSG_CLABEL_NONE                MAKE_MSG_CLABEL(0U, 0U, 0U)
+#define MSG_CLABEL_1           MAKE_MSG_CLABEL(0U, 0U, 1U)
+#define MSG_CLABEL_2           MAKE_MSG_CLABEL(0U, 1U, 0U)
+#define MSG_CLABEL_3           MAKE_MSG_CLABEL(0U, 1U, 1U)
+#define MSG_CLABEL_4           MAKE_MSG_CLABEL(1U, 0U, 0U)
+#define MSG_CLABEL_5           MAKE_MSG_CLABEL(1U, 0U, 1U)
+#define MSG_CLABEL_6           MAKE_MSG_CLABEL(1U, 1U, 0U)
+#define MSG_CLABEL_7           MAKE_MSG_CLABEL(1U, 1U, 1U)
+
+#define MSG_CLABEL_ORANGE      MSG_CLABEL_1
+#define MSG_CLABEL_RED         MSG_CLABEL_2
+#define MSG_CLABEL_PINK                MSG_CLABEL_3
+#define MSG_CLABEL_SKYBLUE     MSG_CLABEL_4
+#define MSG_CLABEL_BLUE                MSG_CLABEL_5
+#define MSG_CLABEL_GREEN       MSG_CLABEL_6
+#define MSG_CLABEL_BROWN       MSG_CLABEL_7
+
+#define MSG_IGNORE_THREAD      (1U << 10)   /* ignore threads */
+#define MSG_LOCKED             (1U << 11)   /* msg is locked  */
+#define MSG_RETRCPT_PENDING    (1U << 12)   /* return receipt pending */
+/* RESERVED */
+#define        MSG_RESERVED_CLAWS      (1U << 30)   /* for sylpheed-claws */
+#define        MSG_RESERVED            (1U << 31)
+
+typedef guint32 MsgPermFlags;
+
+#define MSG_CLABEL_FLAG_MASK   (MSG_CLABEL_7)
+
+#define MSG_MOVE               (1U << 0)
+#define MSG_COPY               (1U << 1)
+#define MSG_QUEUED             (1U << 16)
+#define MSG_DRAFT              (1U << 17)
+#define MSG_ENCRYPTED          (1U << 18)
+#define MSG_IMAP               (1U << 19)
+#define MSG_NEWS               (1U << 20)
+#define MSG_SIGNED             (1U << 21)
+#define MSG_MIME               (1U << 29)
+#define MSG_CACHED             (1U << 31)
+
+typedef guint32 MsgTmpFlags;
+
+#define MSG_CACHED_FLAG_MASK   (MSG_MIME | MSG_ENCRYPTED | MSG_SIGNED)
 
 #define MSG_SET_FLAGS(msg, flags)      { (msg) |= (flags); }
 #define MSG_UNSET_FLAGS(msg, flags)    { (msg) &= ~(flags); }
-#define MSG_IS_NEW(msg)                        ((msg & MSG_NEW) != 0)
-#define MSG_IS_UNREAD(msg)             ((msg & MSG_UNREAD) != 0)
-#define MSG_IS_MARKED(msg)             ((msg & MSG_MARKED) != 0)
-#define MSG_IS_DELETED(msg)            ((msg & MSG_DELETED) != 0)
-#define MSG_IS_REPLIED(msg)            ((msg & MSG_REPLIED) != 0)
-#define MSG_IS_FORWARDED(msg)          ((msg & MSG_FORWARDED) != 0)
-
-#define MSG_IS_MOVE(msg)               ((msg & MSG_MOVE) != 0)
-#define MSG_IS_COPY(msg)               ((msg & MSG_COPY) != 0)
-
-#define MSG_IS_QUEUED(msg)             ((msg & MSG_QUEUED) != 0)
-#define MSG_IS_DRAFT(msg)              ((msg & MSG_DRAFT) != 0)
-#define MSG_IS_ENCRYPTED(msg)          ((msg & MSG_ENCRYPTED) != 0)
-#define MSG_IS_IMAP(msg)               ((msg & MSG_IMAP) != 0)
-#define MSG_IS_MIME(msg)               ((msg & MSG_MIME) != 0)
-#define MSG_IS_NEWS(msg)               ((msg & MSG_NEWS) != 0)
-#define MSG_IS_CACHED(msg)             ((msg & MSG_CACHED) != 0)
-
-#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 = strlen(data)) == 0) { \
-               len = 0; \
-               WRITE_CACHE_DATA_INT(len, fp); \
-       } else { \
-               len = strlen(data); \
-               WRITE_CACHE_DATA_INT(len, fp); \
-               fwrite(data, len, 1, fp); \
-       } \
-}
+#define MSG_SET_PERM_FLAGS(msg, flags) \
+       MSG_SET_FLAGS((msg).perm_flags, flags)
+#define MSG_SET_TMP_FLAGS(msg, flags) \
+       MSG_SET_FLAGS((msg).tmp_flags, flags)
+#define MSG_UNSET_PERM_FLAGS(msg, flags) \
+       MSG_UNSET_FLAGS((msg).perm_flags, flags)
+#define MSG_UNSET_TMP_FLAGS(msg, flags) \
+       MSG_UNSET_FLAGS((msg).tmp_flags, flags)
+
+#define MSG_IS_NEW(msg)                        (((msg).perm_flags & MSG_NEW) != 0)
+#define MSG_IS_UNREAD(msg)             (((msg).perm_flags & MSG_UNREAD) != 0)
+#define MSG_IS_MARKED(msg)             (((msg).perm_flags & MSG_MARKED) != 0)
+#define MSG_IS_DELETED(msg)            (((msg).perm_flags & MSG_DELETED) != 0)
+#define MSG_IS_REPLIED(msg)            (((msg).perm_flags & MSG_REPLIED) != 0)
+#define MSG_IS_LOCKED(msg)             (((msg).perm_flags & MSG_LOCKED) != 0)
+#define MSG_IS_FORWARDED(msg)          (((msg).perm_flags & MSG_FORWARDED) != 0)
+
+#define MSG_GET_COLORLABEL(msg)                (((msg).perm_flags & MSG_CLABEL_FLAG_MASK))
+#define MSG_GET_COLORLABEL_VALUE(msg)  (MSG_GET_COLORLABEL(msg) >> MSG_CLABEL_SBIT)
+#define MSG_SET_COLORLABEL_VALUE(msg, val) \
+       MSG_SET_PERM_FLAGS(msg, ((((guint)(val)) & 7) << MSG_CLABEL_SBIT))
+
+#define MSG_COLORLABEL_TO_FLAGS(val) ((((guint)(val)) & 7) << MSG_CLABEL_SBIT)
+#define MSG_COLORLABEL_FROM_FLAGS(val) (val >> MSG_CLABEL_SBIT)
+
+#define MSG_IS_MOVE(msg)               (((msg).tmp_flags & MSG_MOVE) != 0)
+#define MSG_IS_COPY(msg)               (((msg).tmp_flags & MSG_COPY) != 0)
+
+#define MSG_IS_QUEUED(msg)             (((msg).tmp_flags & MSG_QUEUED) != 0)
+#define MSG_IS_DRAFT(msg)              (((msg).tmp_flags & MSG_DRAFT) != 0)
+#define MSG_IS_ENCRYPTED(msg)          (((msg).tmp_flags & MSG_ENCRYPTED) != 0)
+#define MSG_IS_SIGNED(msg)             (((msg).tmp_flags & MSG_SIGNED) != 0)
+#define MSG_IS_IMAP(msg)               (((msg).tmp_flags & MSG_IMAP) != 0)
+#define MSG_IS_NEWS(msg)               (((msg).tmp_flags & MSG_NEWS) != 0)
+#define MSG_IS_MIME(msg)               (((msg).tmp_flags & MSG_MIME) != 0)
+#define MSG_IS_CACHED(msg)             (((msg).tmp_flags & MSG_CACHED) != 0)
+
+/* Claws related flags */
+#define MSG_IS_REALLY_DELETED(msg)     (((msg).perm_flags & MSG_REALLY_DELETED) != 0)
+#define MSG_IS_IGNORE_THREAD(msg)      (((msg).perm_flags & MSG_IGNORE_THREAD) != 0)
+#define MSG_IS_RETRCPT_PENDING(msg)    (((msg).perm_flags & MSG_RETRCPT_PENDING) != 0)
+
+#define MSGINFO_UPDATE_HOOKLIST "msginfo_update"
+#define MAIL_FILTERING_HOOKLIST "mail_filtering_hooklist"
+
+#include "folder.h"
+#include "procmime.h"
+#include "prefs_filtering.h"
+
+struct _MsgFlags
+{
+       MsgPermFlags perm_flags;
+       MsgTmpFlags  tmp_flags;
+};
+
 
 struct _MsgInfo
 {
+       guint refcnt;
+
        guint  msgnum;
        off_t  size;
        time_t mtime;
        time_t date_t;
+
        MsgFlags flags;
 
        gchar *fromname;
@@ -111,11 +168,12 @@ struct _MsgInfo
        gchar *date;
        gchar *from;
        gchar *to;
+       gchar *cc;
        gchar *newsgroups;
        gchar *subject;
        gchar *msgid;
        gchar *inreplyto;
-       gchar *cc;
+       gchar *xref;
 
        FolderItem *folder;
        FolderItem *to_folder;
@@ -126,6 +184,7 @@ struct _MsgInfo
        gchar *returnreceiptto;
 
        gchar *references;
+       gchar *fromspace;
 
        gint score;
        gint threadscore;
@@ -135,6 +194,15 @@ struct _MsgInfo
        guint decryption_failed : 1;
 };
 
+struct _MsgInfoUpdate {
+       MsgInfo *msginfo;
+};
+
+struct _MailFilteringData
+{
+       MsgInfo *msginfo;
+};
+
 GHashTable *procmsg_msg_hash_table_create      (GSList         *mlist);
 void procmsg_msg_hash_table_append             (GHashTable     *msg_table,
                                                 GSList         *mlist);
@@ -142,19 +210,17 @@ GHashTable *procmsg_to_folder_hash_table_create   (GSList         *mlist);
 
 GSList *procmsg_read_cache             (FolderItem     *item,
                                         gboolean        scan_file);
-void   procmsg_set_flags               (GSList         *mlist,
-                                        FolderItem     *item);
-gint   procmsg_get_last_num_in_cache   (GSList         *mlist);
-void   procmsg_write_cache             (MsgInfo        *msginfo,
-                                        FILE           *fp);
-void   procmsg_write_flags             (MsgInfo        *msginfo,
-                                        FILE           *fp);
+gint   procmsg_get_last_num_in_msg_list(GSList         *mlist);
+void   procmsg_msg_list_free           (GSList         *mlist);
 void   procmsg_get_mark_sum            (const gchar    *folder,
-                                        gint           *new,
-                                        gint           *unread,
-                                        gint           *total);
-FILE   *procmsg_open_mark_file         (const gchar    *folder,
-                                        gboolean        append);
+                                        gint           *new_msgs,
+                                        gint           *unread_msgs,
+                                        gint           *total_msgs,
+                                        gint           *min,
+                                        gint           *max,
+                                        gint            first);
+
+GNode  *procmsg_get_thread_tree                (GSList         *mlist);
 
 void   procmsg_move_messages           (GSList         *mlist);
 void   procmsg_copy_messages           (GSList         *mlist);
@@ -162,17 +228,54 @@ void      procmsg_copy_messages           (GSList         *mlist);
 gchar  *procmsg_get_message_file_path  (MsgInfo        *msginfo);
 gchar  *procmsg_get_message_file       (MsgInfo        *msginfo);
 FILE   *procmsg_open_message           (MsgInfo        *msginfo);
+#if USE_GPGME
+FILE   *procmsg_open_message_decrypted (MsgInfo        *msginfo,
+                                        MimeInfo      **mimeinfo);
+#endif
 gboolean procmsg_msg_exist             (MsgInfo        *msginfo);
 
+void   procmsg_get_filter_keyword      (MsgInfo          *msginfo,
+                                        gchar           **header,
+                                        gchar           **key,
+                                        PrefsFilterType   type);
+
 void   procmsg_empty_trash             (void);
-gint   procmsg_send_queue              (void);
+gint   procmsg_send_queue              (FolderItem     *queue,
+                                        gboolean        save_msgs);
+gint   procmsg_save_to_outbox          (FolderItem     *outbox,
+                                        const gchar    *file,
+                                        gboolean        is_queued);
 void   procmsg_print_message           (MsgInfo        *msginfo,
                                         const gchar    *cmdline);
 
+MsgInfo *procmsg_msginfo_new           ();
+MsgInfo *procmsg_msginfo_new_ref       (MsgInfo        *msginfo);
 MsgInfo *procmsg_msginfo_copy          (MsgInfo        *msginfo);
+MsgInfo *procmsg_msginfo_get_full_info (MsgInfo        *msginfo);
 void    procmsg_msginfo_free           (MsgInfo        *msginfo);
+guint   procmsg_msginfo_memusage       (MsgInfo        *msginfo);
 
 gint procmsg_cmp_msgnum_for_sort       (gconstpointer   a,
                                         gconstpointer   b);
+gint procmsg_send_message_queue                (const gchar *file);
+
+void procmsg_msginfo_set_flags         (MsgInfo *msginfo,
+                                        MsgPermFlags perm_flags,
+                                         MsgTmpFlags tmp_flags);
+void procmsg_msginfo_unset_flags       (MsgInfo *msginfo,
+                                        MsgPermFlags perm_flags,
+                                         MsgTmpFlags tmp_flags);
+gint procmsg_remove_special_headers    (const gchar    *in, 
+                                        const gchar    *out);
+
+gboolean procmsg_msg_has_flagged_parent        (MsgInfo        *info,
+                                        MsgPermFlags    perm_flags);
+gboolean procmsg_msg_has_marked_parent (MsgInfo        *info);
+GSList *procmsg_find_children          (MsgInfo        *info);
+void procmsg_update_unread_children    (MsgInfo        *info,
+                                        gboolean        newly_marked);
+void procmsg_msginfo_set_to_folder     (MsgInfo        *msginfo,
+                                        FolderItem     *to_folder);
+gboolean procmsg_msginfo_filter                (MsgInfo        *msginfo);
 
 #endif /* __PROCMSG_H__ */