src/procmsg.h

   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 #ifndef __PROCMSG_H__
  21 #define __PROCMSG_H__
  22
  23 #include <glib.h>
  24 #include <stdio.h>
  25 #include <time.h>
  26 #include <sys/types.h>
  27 #include <string.h>
  28
  29 typedef struct _MsgInfo         MsgInfo;
  30 typedef struct _MsgFlags        MsgFlags;
  31
  32 #include "folder.h"
  33
  34 typedef enum
  35 {
  36         MSG_NEW         = 1 << 0,
  37         MSG_UNREAD      = 1 << 1,
  38         MSG_MARKED      = 1 << 2,
  39         MSG_DELETED     = 1 << 3,
  40         MSG_REPLIED     = 1 << 4,
  41         MSG_FORWARDED   = 1 << 5,
  42
  43         MSG_REALLY_DELETED = 1 << 6,            /* mbox stuff */
  44
  45 #define MSG_CLABEL_SBIT (7)             /* start bit of color label */
  46 #define MAKE_MSG_CLABEL(h, m, l)        (((h) << (MSG_CLABEL_SBIT + 2)) | \
  47                                          ((m) << (MSG_CLABEL_SBIT + 1)) | \
  48                                          ((l) << (MSG_CLABEL_SBIT + 0)))
  49
  50         MSG_CLABEL_NONE = MAKE_MSG_CLABEL(0, 0, 0),
  51         MSG_CLABEL_1    = MAKE_MSG_CLABEL(0, 0, 1),
  52         MSG_CLABEL_2    = MAKE_MSG_CLABEL(0, 1, 0),
  53         MSG_CLABEL_3    = MAKE_MSG_CLABEL(0, 1, 1),
  54         MSG_CLABEL_4    = MAKE_MSG_CLABEL(1, 0, 0),
  55         MSG_CLABEL_5    = MAKE_MSG_CLABEL(1, 0, 1),
  56         MSG_CLABEL_6    = MAKE_MSG_CLABEL(1, 1, 0),
  57         MSG_CLABEL_7    = MAKE_MSG_CLABEL(1, 1, 1),
  58
  59 #define MSG_CLABEL_ORANGE       MSG_CLABEL_1
  60 #define MSG_CLABEL_RED          MSG_CLABEL_2
  61 #define MSG_CLABEL_PINK         MSG_CLABEL_3
  62 #define MSG_CLABEL_SKYBLUE      MSG_CLABEL_4
  63 #define MSG_CLABEL_BLUE         MSG_CLABEL_5
  64 #define MSG_CLABEL_GREEN        MSG_CLABEL_6
  65 #define MSG_CLABEL_BROWN        MSG_CLABEL_7
  66
  67         MSG_IGNORE_THREAD   = 1 << 10,   /* ignore threads */
  68         MSG_LOCKED          = 1 << 11,   /* msg is locked  */
  69
  70         /* RESERVED */
  71         MSG_RESERVED_CLAWS  = 1 << 30,  /* for sylpheed-claws */
  72         MSG_RESERVED_MAIN   = 1 << 31   /* for sylpheed-main  */
  73 } MsgPermFlags;
  74
  75 #define MSG_CLABEL_FLAG_MASK    (MSG_CLABEL_7)
  76
  77 typedef enum
  78 {
  79         MSG_MOVE        = 1 << 0,
  80         MSG_COPY        = 1 << 1,
  81
  82         MSG_QUEUED      = 1 << 16,
  83         MSG_DRAFT       = 1 << 17,
  84         MSG_ENCRYPTED   = 1 << 18,
  85         MSG_IMAP        = 1 << 19,
  86         MSG_NEWS        = 1 << 20,
  87
  88         MSG_FILTERING   = 1 << 25,      /* claws: re/set by filtering */
  89
  90         MSG_MIME        = 1 << 29,
  91
  92         MSG_CACHED      = 1 << 31
  93 } MsgTmpFlags;
  94
  95 #define MSG_CACHED_FLAG_MASK    (MSG_MIME)
  96
  97 #define MSG_SET_FLAGS(msg, flags)       { (msg) |= (flags); }
  98 #define MSG_UNSET_FLAGS(msg, flags)     { (msg) &= ~(flags); }
  99 #define MSG_SET_PERM_FLAGS(msg, flags) \
 100         MSG_SET_FLAGS((msg).perm_flags, flags)
 101 #define MSG_SET_TMP_FLAGS(msg, flags) \
 102         MSG_SET_FLAGS((msg).tmp_flags, flags)
 103 #define MSG_UNSET_PERM_FLAGS(msg, flags) \
 104         MSG_UNSET_FLAGS((msg).perm_flags, flags)
 105 #define MSG_UNSET_TMP_FLAGS(msg, flags) \
 106         MSG_UNSET_FLAGS((msg).tmp_flags, flags)
 107
 108 #define MSG_IS_NEW(msg)                 (((msg).perm_flags & MSG_NEW) != 0)
 109 #define MSG_IS_UNREAD(msg)              (((msg).perm_flags & MSG_UNREAD) != 0)
 110 #define MSG_IS_MARKED(msg)              (((msg).perm_flags & MSG_MARKED) != 0)
 111 #define MSG_IS_DELETED(msg)             (((msg).perm_flags & MSG_DELETED) != 0)
 112 #define MSG_IS_REPLIED(msg)             (((msg).perm_flags & MSG_REPLIED) != 0)
 113 #define MSG_IS_LOCKED(msg)              (((msg).perm_flags & MSG_LOCKED) != 0)
 114 #define MSG_IS_FORWARDED(msg)           (((msg).perm_flags & MSG_FORWARDED) != 0)
 115
 116 #define MSG_GET_COLORLABEL(msg)         (((msg).perm_flags & MSG_CLABEL_FLAG_MASK))
 117 #define MSG_GET_COLORLABEL_VALUE(msg)   (MSG_GET_COLORLABEL(msg) >> MSG_CLABEL_SBIT)
 118 #define MSG_SET_COLORLABEL_VALUE(msg, val) \
 119         MSG_SET_PERM_FLAGS(msg, ((((guint)(val)) & 7) << MSG_CLABEL_SBIT))
 120
 121 #define MSG_IS_MOVE(msg)                (((msg).tmp_flags & MSG_MOVE) != 0)
 122 #define MSG_IS_COPY(msg)                (((msg).tmp_flags & MSG_COPY) != 0)
 123
 124 #define MSG_IS_QUEUED(msg)              (((msg).tmp_flags & MSG_QUEUED) != 0)
 125 #define MSG_IS_DRAFT(msg)               (((msg).tmp_flags & MSG_DRAFT) != 0)
 126 #define MSG_IS_ENCRYPTED(msg)           (((msg).tmp_flags & MSG_ENCRYPTED) != 0)
 127 #define MSG_IS_IMAP(msg)                (((msg).tmp_flags & MSG_IMAP) != 0)
 128 #define MSG_IS_NEWS(msg)                (((msg).tmp_flags & MSG_NEWS) != 0)
 129 #define MSG_IS_MIME(msg)                (((msg).tmp_flags & MSG_MIME) != 0)
 130 #define MSG_IS_CACHED(msg)              (((msg).tmp_flags & MSG_CACHED) != 0)
 131
 132 /* Claws related flags */
 133 #define MSG_IS_REALLY_DELETED(msg)      (((msg).perm_flags & MSG_REALLY_DELETED) != 0)
 134 #define MSG_IS_IGNORE_THREAD(msg)       (((msg).perm_flags & MSG_IGNORE_THREAD) != 0)
 135 #define MSG_IS_FILTERING(msg)           (((msg).tmp_flags  & MSG_FILTERING) != 0)
 136
 137
 138 #define WRITE_CACHE_DATA_INT(n, fp) \
 139         fwrite(&n, sizeof(n), 1, fp)
 140
 141 #define WRITE_CACHE_DATA(data, fp) \
 142 { \
 143         gint len; \
 144  \
 145         if (data == NULL || (len = strlen(data)) == 0) { \
 146                 len = 0; \
 147                 WRITE_CACHE_DATA_INT(len, fp); \
 148         } else { \
 149                 len = strlen(data); \
 150                 WRITE_CACHE_DATA_INT(len, fp); \
 151                 fwrite(data, len, 1, fp); \
 152         } \
 153 }
 154
 155 struct _MsgFlags
 156 {
 157         MsgPermFlags perm_flags;
 158         MsgTmpFlags  tmp_flags;
 159 };
 160
 161 struct _MsgInfo
 162 {
 163         guint  msgnum;
 164         off_t  size;
 165         time_t mtime;
 166         time_t date_t;
 167
 168         MsgFlags flags;
 169
 170         gchar *fromname;
 171
 172         gchar *date;
 173         gchar *from;
 174         gchar *to;
 175         gchar *cc;
 176         gchar *newsgroups;
 177         gchar *subject;
 178         gchar *msgid;
 179         gchar *inreplyto;
 180
 181         FolderItem *folder;
 182         FolderItem *to_folder;
 183
 184         gchar *xface;
 185
 186         gchar *dispositionnotificationto;
 187         gchar *returnreceiptto;
 188
 189         gchar *references;
 190         gchar *fromspace;
 191
 192         gint score;
 193         gint threadscore;
 194
 195         /* used only for encrypted messages */
 196         gchar *plaintext_file;
 197         guint decryption_failed : 1;
 198 };
 199
 200 GHashTable *procmsg_msg_hash_table_create       (GSList         *mlist);
 201 void procmsg_msg_hash_table_append              (GHashTable     *msg_table,
 202                                                  GSList         *mlist);
 203 GHashTable *procmsg_to_folder_hash_table_create (GSList         *mlist);
 204
 205 GSList *procmsg_read_cache              (FolderItem     *item,
 206                                          gboolean        scan_file);
 207 void    procmsg_set_flags               (GSList         *mlist,
 208                                          FolderItem     *item);
 209 gint    procmsg_get_last_num_in_cache   (GSList         *mlist);
 210 void    procmsg_msg_list_free           (GSList         *mlist);
 211 void    procmsg_write_cache             (MsgInfo        *msginfo,
 212                                          FILE           *fp);
 213 void    procmsg_write_flags             (MsgInfo        *msginfo,
 214                                          FILE           *fp);
 215 void    procmsg_get_mark_sum            (const gchar    *folder,
 216                                          gint           *new,
 217                                          gint           *unread,
 218                                          gint           *total);
 219 FILE   *procmsg_open_mark_file          (const gchar    *folder,
 220                                          gboolean        append);
 221
 222 GNode  *procmsg_get_thread_tree         (GSList         *mlist);
 223
 224 void    procmsg_move_messages           (GSList         *mlist);
 225 void    procmsg_copy_messages           (GSList         *mlist);
 226
 227 gchar  *procmsg_get_message_file_path   (MsgInfo        *msginfo);
 228 gchar  *procmsg_get_message_file        (MsgInfo        *msginfo);
 229 FILE   *procmsg_open_message            (MsgInfo        *msginfo);
 230 gboolean procmsg_msg_exist              (MsgInfo        *msginfo);
 231
 232 void    procmsg_empty_trash             (void);
 233 gint    procmsg_send_queue              (void);
 234 void    procmsg_print_message           (MsgInfo        *msginfo,
 235                                          const gchar    *cmdline);
 236
 237 MsgInfo *procmsg_msginfo_copy           (MsgInfo        *msginfo);
 238 void     procmsg_msginfo_free           (MsgInfo        *msginfo);
 239
 240 gint procmsg_cmp_msgnum_for_sort        (gconstpointer   a,
 241                                          gconstpointer   b);
 242 gint procmsg_send_message_queue         (const gchar *file);
 243
 244 #endif /* __PROCMSG_H__ */