root / libsylph / procmsg.h @ 806
History | View | Annotate | Download (8.5 kB)
| 1 | /*
|
|---|---|
| 2 | * LibSylph -- E-Mail client library |
| 3 | * Copyright (C) 1999-2005 Hiroyuki Yamamoto |
| 4 | * |
| 5 | * This library is free software; you can redistribute it and/or |
| 6 | * modify it under the terms of the GNU Lesser General Public |
| 7 | * License as published by the Free Software Foundation; either |
| 8 | * version 2.1 of the License, or (at your option) any later version. |
| 9 | * |
| 10 | * This library 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 GNU |
| 13 | * Lesser General Public License for more details. |
| 14 | * |
| 15 | * You should have received a copy of the GNU Lesser General Public |
| 16 | * License along with this library; if not, write to the Free Software |
| 17 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
| 18 | */ |
| 19 | |
| 20 | #ifndef __PROCMSG_H__
|
| 21 | #define __PROCMSG_H__
|
| 22 | |
| 23 | #ifdef HAVE_CONFIG_H
|
| 24 | # include "config.h" |
| 25 | #endif
|
| 26 | |
| 27 | #include <glib.h> |
| 28 | #include <stdio.h> |
| 29 | #include <time.h> |
| 30 | #include <sys/types.h> |
| 31 | #include <string.h> |
| 32 | |
| 33 | typedef struct _MsgInfo MsgInfo; |
| 34 | typedef struct _MsgFlags MsgFlags; |
| 35 | typedef struct _MsgFileInfo MsgFileInfo; |
| 36 | |
| 37 | #include "folder.h" |
| 38 | #include "procmime.h" |
| 39 | |
| 40 | typedef enum |
| 41 | {
|
| 42 | DATA_READ, |
| 43 | DATA_WRITE, |
| 44 | DATA_APPEND |
| 45 | } DataOpenMode; |
| 46 | |
| 47 | #define MSG_NEW (1U << 0) |
| 48 | #define MSG_UNREAD (1U << 1) |
| 49 | #define MSG_MARKED (1U << 2) |
| 50 | #define MSG_DELETED (1U << 3) |
| 51 | #define MSG_REPLIED (1U << 4) |
| 52 | #define MSG_FORWARDED (1U << 5) |
| 53 | |
| 54 | #define MSG_CLABEL_SBIT (7) /* start bit of color label */ |
| 55 | #define MAKE_MSG_CLABEL(h, m, l) (((h) << (MSG_CLABEL_SBIT + 2)) | \ |
| 56 | ((m) << (MSG_CLABEL_SBIT + 1)) | \
|
| 57 | ((l) << (MSG_CLABEL_SBIT + 0)))
|
| 58 | |
| 59 | #define MSG_CLABEL_NONE MAKE_MSG_CLABEL(0U, 0U, 0U) |
| 60 | #define MSG_CLABEL_1 MAKE_MSG_CLABEL(0U, 0U, 1U) |
| 61 | #define MSG_CLABEL_2 MAKE_MSG_CLABEL(0U, 1U, 0U) |
| 62 | #define MSG_CLABEL_3 MAKE_MSG_CLABEL(0U, 1U, 1U) |
| 63 | #define MSG_CLABEL_4 MAKE_MSG_CLABEL(1U, 0U, 0U) |
| 64 | #define MSG_CLABEL_5 MAKE_MSG_CLABEL(1U, 0U, 1U) |
| 65 | #define MSG_CLABEL_6 MAKE_MSG_CLABEL(1U, 1U, 0U) |
| 66 | #define MSG_CLABEL_7 MAKE_MSG_CLABEL(1U, 1U, 1U) |
| 67 | |
| 68 | #define MSG_CLABEL_ORANGE MSG_CLABEL_1
|
| 69 | #define MSG_CLABEL_RED MSG_CLABEL_2
|
| 70 | #define MSG_CLABEL_PINK MSG_CLABEL_3
|
| 71 | #define MSG_CLABEL_SKYBLUE MSG_CLABEL_4
|
| 72 | #define MSG_CLABEL_BLUE MSG_CLABEL_5
|
| 73 | #define MSG_CLABEL_GREEN MSG_CLABEL_6
|
| 74 | #define MSG_CLABEL_BROWN MSG_CLABEL_7
|
| 75 | |
| 76 | /* RESERVED */
|
| 77 | #define MSG_RESERVED (1U << 31) |
| 78 | |
| 79 | #define MSG_CLABEL_FLAG_MASK (MSG_CLABEL_7)
|
| 80 | |
| 81 | typedef guint32 MsgPermFlags;
|
| 82 | |
| 83 | #define MSG_MOVE (1U << 0) |
| 84 | #define MSG_COPY (1U << 1) |
| 85 | #define MSG_QUEUED (1U << 16) |
| 86 | #define MSG_DRAFT (1U << 17) |
| 87 | #define MSG_ENCRYPTED (1U << 18) |
| 88 | #define MSG_IMAP (1U << 19) |
| 89 | #define MSG_NEWS (1U << 20) |
| 90 | #define MSG_SIGNED (1U << 21) |
| 91 | #define MSG_CACHED (1U << 28) |
| 92 | #define MSG_MIME (1U << 29) |
| 93 | #define MSG_INVALID (1U << 30) |
| 94 | #define MSG_RECEIVED (1U << 31) |
| 95 | |
| 96 | #define MSG_CACHED_FLAG_MASK (MSG_MIME)
|
| 97 | |
| 98 | typedef guint32 MsgTmpFlags;
|
| 99 | |
| 100 | #define MSG_SET_FLAGS(msg, flags) { (msg) |= (flags); }
|
| 101 | #define MSG_UNSET_FLAGS(msg, flags) { (msg) &= ~(flags); }
|
| 102 | #define MSG_SET_PERM_FLAGS(msg, flags) \
|
| 103 | MSG_SET_FLAGS((msg).perm_flags, flags) |
| 104 | #define MSG_SET_TMP_FLAGS(msg, flags) \
|
| 105 | MSG_SET_FLAGS((msg).tmp_flags, flags) |
| 106 | #define MSG_UNSET_PERM_FLAGS(msg, flags) \
|
| 107 | MSG_UNSET_FLAGS((msg).perm_flags, flags) |
| 108 | #define MSG_UNSET_TMP_FLAGS(msg, flags) \
|
| 109 | MSG_UNSET_FLAGS((msg).tmp_flags, flags) |
| 110 | |
| 111 | #define MSG_IS_NEW(msg) (((msg).perm_flags & MSG_NEW) != 0) |
| 112 | #define MSG_IS_UNREAD(msg) (((msg).perm_flags & MSG_UNREAD) != 0) |
| 113 | #define MSG_IS_MARKED(msg) (((msg).perm_flags & MSG_MARKED) != 0) |
| 114 | #define MSG_IS_DELETED(msg) (((msg).perm_flags & MSG_DELETED) != 0) |
| 115 | #define MSG_IS_REPLIED(msg) (((msg).perm_flags & MSG_REPLIED) != 0) |
| 116 | #define MSG_IS_FORWARDED(msg) (((msg).perm_flags & MSG_FORWARDED) != 0) |
| 117 | |
| 118 | #define MSG_GET_COLORLABEL(msg) (((msg).perm_flags & MSG_CLABEL_FLAG_MASK))
|
| 119 | #define MSG_GET_COLORLABEL_VALUE(msg) (MSG_GET_COLORLABEL(msg) >> MSG_CLABEL_SBIT)
|
| 120 | #define MSG_SET_COLORLABEL_VALUE(msg, val) \
|
| 121 | MSG_SET_PERM_FLAGS(msg, ((((guint)(val)) & 7) << MSG_CLABEL_SBIT))
|
| 122 | |
| 123 | #define MSG_IS_MOVE(msg) (((msg).tmp_flags & MSG_MOVE) != 0) |
| 124 | #define MSG_IS_COPY(msg) (((msg).tmp_flags & MSG_COPY) != 0) |
| 125 | |
| 126 | #define MSG_IS_QUEUED(msg) (((msg).tmp_flags & MSG_QUEUED) != 0) |
| 127 | #define MSG_IS_DRAFT(msg) (((msg).tmp_flags & MSG_DRAFT) != 0) |
| 128 | #define MSG_IS_ENCRYPTED(msg) (((msg).tmp_flags & MSG_ENCRYPTED) != 0) |
| 129 | #define MSG_IS_IMAP(msg) (((msg).tmp_flags & MSG_IMAP) != 0) |
| 130 | #define MSG_IS_NEWS(msg) (((msg).tmp_flags & MSG_NEWS) != 0) |
| 131 | #define MSG_IS_SIGNED(msg) (((msg).tmp_flags & MSG_SIGNED) != 0) |
| 132 | #define MSG_IS_CACHED(msg) (((msg).tmp_flags & MSG_CACHED) != 0) |
| 133 | #define MSG_IS_MIME(msg) (((msg).tmp_flags & MSG_MIME) != 0) |
| 134 | #define MSG_IS_INVALID(msg) (((msg).tmp_flags & MSG_INVALID) != 0) |
| 135 | #define MSG_IS_RECEIVED(msg) (((msg).tmp_flags & MSG_RECEIVED) != 0) |
| 136 | |
| 137 | #define WRITE_CACHE_DATA_INT(n, fp) \
|
| 138 | { \
|
| 139 | guint32 idata; \ |
| 140 | \ |
| 141 | idata = (guint32)n; \ |
| 142 | fwrite(&idata, sizeof(idata), 1, fp); \ |
| 143 | } |
| 144 | |
| 145 | #define WRITE_CACHE_DATA(data, fp) \
|
| 146 | { \
|
| 147 | size_t len; \ |
| 148 | \ |
| 149 | if (data == NULL) { \ |
| 150 | len = 0; \
|
| 151 | WRITE_CACHE_DATA_INT(len, fp); \ |
| 152 | } else { \
|
| 153 | len = strlen(data); \ |
| 154 | WRITE_CACHE_DATA_INT(len, fp); \ |
| 155 | if (len > 0) \ |
| 156 | fwrite(data, len, 1, fp); \
|
| 157 | } \ |
| 158 | } |
| 159 | |
| 160 | struct _MsgFlags
|
| 161 | {
|
| 162 | MsgPermFlags perm_flags; |
| 163 | MsgTmpFlags tmp_flags; |
| 164 | }; |
| 165 | |
| 166 | struct _MsgInfo
|
| 167 | {
|
| 168 | guint msgnum; |
| 169 | off_t size; |
| 170 | time_t mtime; |
| 171 | time_t date_t; |
| 172 | |
| 173 | MsgFlags flags; |
| 174 | |
| 175 | gchar *fromname; |
| 176 | |
| 177 | gchar *date; |
| 178 | gchar *from; |
| 179 | gchar *to; |
| 180 | gchar *cc; |
| 181 | gchar *newsgroups; |
| 182 | gchar *subject; |
| 183 | gchar *msgid; |
| 184 | gchar *inreplyto; |
| 185 | |
| 186 | GSList *references; |
| 187 | |
| 188 | FolderItem *folder; |
| 189 | FolderItem *to_folder; |
| 190 | |
| 191 | gchar *xface; |
| 192 | |
| 193 | /* used only for temporary messages */
|
| 194 | gchar *file_path; |
| 195 | |
| 196 | /* used only for encrypted messages */
|
| 197 | gchar *plaintext_file; |
| 198 | guint decryption_failed : 1;
|
| 199 | }; |
| 200 | |
| 201 | struct _MsgFileInfo
|
| 202 | {
|
| 203 | gchar *file; |
| 204 | MsgFlags *flags; |
| 205 | }; |
| 206 | |
| 207 | typedef FILE * (*DecryptMessageFunc) (MsgInfo *msginfo,
|
| 208 | MimeInfo **mimeinfo); |
| 209 | |
| 210 | GHashTable *procmsg_msg_hash_table_create (GSList *mlist); |
| 211 | void procmsg_msg_hash_table_append (GHashTable *msg_table,
|
| 212 | GSList *mlist); |
| 213 | GHashTable *procmsg_to_folder_hash_table_create (GSList *mlist); |
| 214 | |
| 215 | GSList *procmsg_read_cache (FolderItem *item, |
| 216 | gboolean scan_file); |
| 217 | void procmsg_set_flags (GSList *mlist,
|
| 218 | FolderItem *item); |
| 219 | GSList *procmsg_sort_msg_list (GSList *mlist, |
| 220 | FolderSortKey sort_key, |
| 221 | FolderSortType sort_type); |
| 222 | gint procmsg_get_last_num_in_msg_list(GSList *mlist); |
| 223 | void procmsg_msg_list_free (GSList *mlist);
|
| 224 | |
| 225 | void procmsg_write_cache (MsgInfo *msginfo,
|
| 226 | FILE *fp); |
| 227 | void procmsg_write_flags (MsgInfo *msginfo,
|
| 228 | FILE *fp); |
| 229 | void procmsg_write_cache_list (FolderItem *item,
|
| 230 | GSList *mlist); |
| 231 | void procmsg_write_flags_list (FolderItem *item,
|
| 232 | GSList *mlist); |
| 233 | |
| 234 | void procmsg_flush_mark_queue (FolderItem *item,
|
| 235 | FILE *fp); |
| 236 | void procmsg_add_mark_queue (FolderItem *item,
|
| 237 | gint num, |
| 238 | MsgFlags flags); |
| 239 | void procmsg_add_flags (FolderItem *item,
|
| 240 | gint num, |
| 241 | MsgFlags flags); |
| 242 | |
| 243 | void procmsg_get_mark_sum (FolderItem *item,
|
| 244 | gint *new, |
| 245 | gint *unread, |
| 246 | gint *total, |
| 247 | gint *min, |
| 248 | gint *max, |
| 249 | gint first); |
| 250 | |
| 251 | FILE *procmsg_open_cache_file (FolderItem *item, |
| 252 | DataOpenMode mode); |
| 253 | FILE *procmsg_open_mark_file (FolderItem *item, |
| 254 | DataOpenMode mode); |
| 255 | |
| 256 | void procmsg_clear_cache (FolderItem *item);
|
| 257 | void procmsg_clear_mark (FolderItem *item);
|
| 258 | |
| 259 | GNode *procmsg_get_thread_tree (GSList *mlist); |
| 260 | guint procmsg_get_thread_date (GNode *node); |
| 261 | |
| 262 | gint procmsg_move_messages (GSList *mlist); |
| 263 | gint procmsg_copy_messages (GSList *mlist); |
| 264 | |
| 265 | gchar *procmsg_get_message_file_path (MsgInfo *msginfo); |
| 266 | gchar *procmsg_get_message_file (MsgInfo *msginfo); |
| 267 | GSList *procmsg_get_message_file_list (GSList *mlist); |
| 268 | void procmsg_message_file_list_free (GSList *file_list);
|
| 269 | FILE *procmsg_open_message (MsgInfo *msginfo); |
| 270 | |
| 271 | void procmsg_set_decrypt_message_func (DecryptMessageFunc func);
|
| 272 | FILE *procmsg_open_message_decrypted (MsgInfo *msginfo, |
| 273 | MimeInfo **mimeinfo); |
| 274 | |
| 275 | gboolean procmsg_msg_exist (MsgInfo *msginfo); |
| 276 | |
| 277 | void procmsg_empty_trash (FolderItem *trash);
|
| 278 | void procmsg_empty_all_trash (void); |
| 279 | |
| 280 | gint procmsg_save_to_outbox (FolderItem *outbox, |
| 281 | const gchar *file);
|
| 282 | void procmsg_print_message (MsgInfo *msginfo,
|
| 283 | const gchar *cmdline);
|
| 284 | |
| 285 | MsgInfo *procmsg_msginfo_copy (MsgInfo *msginfo); |
| 286 | MsgInfo *procmsg_msginfo_get_full_info (MsgInfo *msginfo); |
| 287 | gboolean procmsg_msginfo_equal (MsgInfo *msginfo_a, |
| 288 | MsgInfo *msginfo_b); |
| 289 | void procmsg_msginfo_free (MsgInfo *msginfo);
|
| 290 | |
| 291 | gint procmsg_cmp_msgnum_for_sort (gconstpointer a, |
| 292 | gconstpointer b); |
| 293 | |
| 294 | #endif /* __PROCMSG_H__ */ |