2 * Copyright (c) 1996-2013 by the citadel.org team
4 * This program is open source software. You can redistribute it and/or
5 * modify it under the terms of the GNU General Public License, version 3.
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
15 extern CtxType CTX_MAILSUM;
16 extern CtxType CTX_MIME_ATACH;
17 extern HashList *MimeRenderHandler;
18 extern HashList *ReadLoopHandler;
19 typedef struct wc_mime_attachment wc_mime_attachment;
20 typedef void (*RenderMimeFunc)(StrBuf *Target, WCTemplputParams *TP, StrBuf *FoundCharset);
21 typedef struct _RenderMimeFuncStruct {
23 } RenderMimeFuncStruct;
25 struct wc_mime_attachment {
34 size_t length; /* length of the mimeattachment */
36 long lvalue; /* if we put a long... */
37 long msgnum; /* the message number on the citadel server derived from message_summary */
38 const RenderMimeFuncStruct *Renderer;
40 void DestroyMime(void *vMime);
42 #define MSGFLAG_READ (1<<0)
44 typedef struct _message_summary {
45 long msgnum; /* the message number on the citadel server */
48 time_t date; /* its creation date */
52 StrBuf *from; /* the author */
53 StrBuf *to; /* the recipient */
54 StrBuf *subj; /* the title / subject */
55 StrBuf *reply_inreplyto;
56 long reply_inreplyto_hash;
57 StrBuf *reply_references;
58 long reply_references_hash;
65 const StrBuf *PartNum;
66 HashList *Attachments; /* list of attachments */
67 HashList *Submessages;
68 HashList *AttachLinks;
72 /* The mime part of the message */
73 wc_mime_attachment *MsgBody;
75 void DestroyMessageSummary(void *vMsg);
77 /* Maps to msgkeys[] in msgbase.c: */
79 typedef enum _eMessageField {
107 extern const char* fieldMnemonics[];
109 int GetFieldFromMnemonic(eMessageField *f, const char* c);
111 int EvaluateMsgHdr(const char *HeaderName, long HdrNLen, message_summary *Msg, StrBuf *HdrLine, StrBuf *FoundCharset);
112 int EvaluateMsgHdrEnum(eMessageField f, message_summary *Msg, StrBuf *HdrLine, StrBuf *FoundCharset);
116 static inline message_summary* GetMessagePtrAt(int n, HashList *Summ)
124 GetHashAt(Summ, n, &HKLen, &Key, &vMsg);
125 return (message_summary*) vMsg;
128 typedef void (*ExamineMsgHeaderFunc)(message_summary *Msg, StrBuf *HdrLine, StrBuf *FoundCharset);
130 void evaluate_mime_part(StrBuf *Target, WCTemplputParams *TP);
133 typedef enum _eCustomRoomRenderer {
134 eUseDefault = VIEW_JOURNAL + 100,
136 }eCustomRoomRenderer;
149 * @brief function to parse the | separated message headers list
150 * @param Line the raw line with your message data
151 * @param Msg put your parser results here...
152 * @param ConversionBuffer if you need some workbuffer, don't free me!
153 * @param ViewSpecific your view specific context data
154 * @returns 0: failure, trash this message. 1: all right, store it
156 typedef int (*load_msg_ptrs_detailheaders) (StrBuf *Line,
158 message_summary *Msg,
159 StrBuf *ConversionBuffer,
160 void **ViewSpecific);
162 typedef void (*readloop_servcmd)(char *buf, long bufsize);
164 typedef struct _readloopstruct {
166 readloop_servcmd cmd;
169 extern readloop_struct rlid[];
171 void readloop(long oper, eCustomRoomRenderer ForceRenderer);
172 int read_message(StrBuf *Target,
173 const char *tmpl, long tmpllen,
175 const StrBuf *section,
176 const StrBuf **OutMime,
177 WCTemplputParams *TP);
178 int load_message(message_summary *Msg,
179 StrBuf *FoundCharset,
185 typedef struct _SharedMessageStatus {
186 long load_seen; /* should read information be loaded */
187 long sortit; /* should we sort it using the standard sort API? */
188 long defaultsortorder; /* if we should sort it, which direction should be the default? */
190 long maxload; /* how many headers should we accept from the server? defaults to 10k */
191 long maxmsgs; /* how many message bodies do you want to load at most?*/
193 long startmsg; /* which is the start message? */
194 long nummsgs; /* How many messages are available to your view? */
195 long numNewmsgs; /* if you load the seen-status, this is the count of them. */
196 long num_displayed; /* counted up for LoadMsgFromServer */ /* TODO: unclear who should access this and why */
198 long lowest_found; /* smallest Message ID found; */
199 long highest_found; /* highest Message ID found; */
201 } SharedMessageStatus;
203 int load_msg_ptrs(const char *servcmd,
205 StrBuf *FoundCharset,
206 SharedMessageStatus *Stat,
208 load_msg_ptrs_detailheaders LH,
209 StrBuf *FetchMessageList,
210 eMessageField *MessageFieldList,
213 typedef int (*GetParamsGetServerCall_func)(SharedMessageStatus *Stat,
221 typedef int (*PrintViewHeader_func)(SharedMessageStatus *Stat, void **ViewSpecific);
223 typedef int (*LoadMsgFromServer_func)(SharedMessageStatus *Stat,
225 message_summary* Msg,
229 typedef int (*RenderView_or_Tail_func)(SharedMessageStatus *Stat,
232 typedef int (*View_Cleanup_func)(void **ViewSpecific);
234 void RegisterReadLoopHandlerset(
236 * RoomType: which View definition are you going to be called for
241 * GetParamsGetServerCall should do the following:
242 * * allocate your private context structure
243 * * evaluate your commandline arguments, put results to your private struct.
244 * * fill cmd with the command to load the message pointer list:
245 * * might depend on bstr/oper depending on your needs
246 * * might stay empty if no list should loaded and LoadMsgFromServer
248 * * influence the behaviour by presetting values on SharedMessageStatus
250 GetParamsGetServerCall_func GetParamsGetServerCall,
253 * PrintpageHeader prints the surrounding information like iconbar, header etc.
254 * by default, output_headers() is called.
257 PrintViewHeader_func PrintPageHeader,
260 * PrintViewHeader is here to print informations infront of your messages.
261 * The message list is already loaded & sorted (if) so you can evaluate
262 * its result on the SharedMessageStatus struct.
264 PrintViewHeader_func PrintViewHeader,
267 * LH is the function, you specify if you want to load more than just message
268 * numbers from the server during the listing fetch operation.
270 load_msg_ptrs_detailheaders LH,
273 * LoadMsgFromServer is called for every message in the message list:
276 * * up to 'maxmsgs' after your 'startmsg'
277 * * it should load and parse messages from citserer.
278 * * depending on your needs you might want to print your message here...
279 * * if cmd was empty, its skipped alltogether.
281 LoadMsgFromServer_func LoadMsgFromServer,
284 * RenderView_or_Tail is called last;
285 * * if you used PrintViewHeader to print messages, you might want to print
286 * trailing information here
287 * * if you just pre-loaded your messages, put your render code here.
289 RenderView_or_Tail_func RenderView_or_Tail,
292 * ViewCleanup should just clear your private data so all your mem can go back to
294 * it also should release the content for delivery via end_burst() or wDumpContent(1);
296 View_Cleanup_func ViewCleanup,
298 * brofwseListFields schould be a NULL-terminated list of message field mnemonics
299 * that will be the browse vector for the message header list.
301 const char **browseListFields
304 GetParamsGetServerCall
314 int ParseMessageListHeaders_Detail(StrBuf *Line,
316 message_summary *Msg,
317 StrBuf *ConversionBuffer,
318 void **ViewSpecific);
321 * @brief function to register the availability to render a specific message
322 * @param HeaderName Mimetype we know howto display
323 * @param HdrNLen length...
324 * @param InlineRenderable Should we announce to citserver that we want to receive these mimeparts immediately?
325 * @param Priority if multipart/alternative; which mimepart/Renderer should be prefered? (only applies if InlineRenderable)
327 void RegisterMimeRenderer(const char *HeaderName, long HdrNLen,
328 RenderMimeFunc MimeRenderer,
329 int InlineRenderable,
334 * @brief fill the header parts of Msg with the headers loaded by MSG0
335 * @param Msg empty message struct, only preinitialized with the msgid
336 * @param FoundCharset buffer with the prefered charset of the headers
337 * @param buf linebuffer used to buffer citserver replies
339 int ReadOneMessageSummary(message_summary *Msg, StrBuf *FoundCharset, StrBuf *Buf);