2 * Copyright (c) 1996-2020 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
47 time_t date; // its creation date
51 StrBuf *from; // display name of message author
52 StrBuf *to; // the recipient
53 StrBuf *subj; // title / subject
54 StrBuf *reply_inreplyto;
55 long reply_inreplyto_hash;
56 StrBuf *reply_references;
57 long reply_references_hash;
62 StrBuf *Rfca; // UPN or email address of message author
64 const StrBuf *PartNum;
65 HashList *Attachments; // list of attachments
66 HashList *Submessages;
67 HashList *AttachLinks;
70 int is_local; // nonzero if the message originated on the local system
71 wc_mime_attachment *MsgBody; // the MIME part of the message
74 void DestroyMessageSummary(void *vMsg);
76 /* some of these fields map to msgkeys[] in msgbase.c ... others don't */
78 /* I think these are supposed to align with fieldMnemonics in msg_renderers.c
79 * So if you change one you have to change the other.
80 * TODO: figure out who did this and beat them with a wet noodle.
82 typedef enum _eMessageField {
107 extern const char* fieldMnemonics[];
109 int GetFieldFromMnemonic(eMessageField *f, const char* c);
110 int EvaluateMsgHdr(const char *HeaderName, long HdrNLen, message_summary *Msg, StrBuf *HdrLine, StrBuf *FoundCharset);
111 int EvaluateMsgHdrEnum(eMessageField f, message_summary *Msg, StrBuf *HdrLine, StrBuf *FoundCharset);
114 static inline message_summary* GetMessagePtrAt(int n, HashList *Summ) {
122 GetHashAt(Summ, n, &HKLen, &Key, &vMsg);
123 return (message_summary*) vMsg;
127 typedef void (*ExamineMsgHeaderFunc)(message_summary *Msg, StrBuf *HdrLine, StrBuf *FoundCharset);
128 void evaluate_mime_part(StrBuf *Target, WCTemplputParams *TP);
130 typedef enum _eCustomRoomRenderer {
131 eUseDefault = VIEW_JOURNAL + 100,
133 } eCustomRoomRenderer;
146 * @brief function to parse the | separated message headers list
147 * @param Line the raw line with your message data
148 * @param Msg put your parser results here...
149 * @param ConversionBuffer if you need some workbuffer, don't free me!
150 * @param ViewSpecific your view specific context data
151 * @returns 0: failure, trash this message. 1: all right, store it
153 typedef int (*load_msg_ptrs_detailheaders) (StrBuf *Line,
155 message_summary *Msg,
156 StrBuf *ConversionBuffer,
157 void **ViewSpecific);
159 typedef void (*readloop_servcmd)(char *buf, long bufsize);
161 typedef struct _readloopstruct {
163 readloop_servcmd cmd;
166 extern readloop_struct rlid[];
168 void readloop(long oper, eCustomRoomRenderer ForceRenderer);
169 int read_message(StrBuf *Target,
170 const char *tmpl, long tmpllen,
172 const StrBuf *section,
173 const StrBuf **OutMime,
174 WCTemplputParams *TP);
175 int load_message(message_summary *Msg,
176 StrBuf *FoundCharset,
182 typedef struct _SharedMessageStatus {
183 long load_seen; /* should read information be loaded */
184 long sortit; /* should we sort it using the standard sort API? */
185 long defaultsortorder; /* if we should sort it, which direction should be the default? */
187 long maxload; /* how many headers should we accept from the server? defaults to 10k */
188 long maxmsgs; /* how many message bodies do you want to load at most?*/
190 long startmsg; /* which is the start message? */
191 long nummsgs; /* How many messages are available to your view? */
192 long numNewmsgs; /* if you load the seen-status, this is the count of them. */
193 long num_displayed; /* counted up for LoadMsgFromServer */ /* TODO: unclear who should access this and why */
195 long lowest_found; /* smallest Message ID found; */
196 long highest_found; /* highest Message ID found; */
198 } SharedMessageStatus;
200 int load_msg_ptrs(const char *servcmd,
202 StrBuf *FoundCharset,
203 SharedMessageStatus *Stat,
205 load_msg_ptrs_detailheaders LH,
206 StrBuf *FetchMessageList,
207 eMessageField *MessageFieldList,
210 typedef int (*GetParamsGetServerCall_func)(SharedMessageStatus *Stat,
218 typedef int (*PrintViewHeader_func)(SharedMessageStatus *Stat, void **ViewSpecific);
220 typedef int (*LoadMsgFromServer_func)(SharedMessageStatus *Stat,
222 message_summary* Msg,
226 typedef int (*RenderView_or_Tail_func)(SharedMessageStatus *Stat,
229 typedef int (*View_Cleanup_func)(void **ViewSpecific);
231 void RegisterReadLoopHandlerset(
233 * RoomType: which View definition are you going to be called for
238 * GetParamsGetServerCall should do the following:
239 * * allocate your private context structure
240 * * evaluate your commandline arguments, put results to your private struct.
241 * * fill cmd with the command to load the message pointer list:
242 * * might depend on bstr/oper depending on your needs
243 * * might stay empty if no list should loaded and LoadMsgFromServer
245 * * influence the behaviour by presetting values on SharedMessageStatus
247 GetParamsGetServerCall_func GetParamsGetServerCall,
250 * PrintpageHeader prints the surrounding information like iconbar, header etc.
251 * by default, output_headers() is called.
254 PrintViewHeader_func PrintPageHeader,
257 * PrintViewHeader is here to print informations infront of your messages.
258 * The message list is already loaded & sorted (if) so you can evaluate
259 * its result on the SharedMessageStatus struct.
261 PrintViewHeader_func PrintViewHeader,
264 * LH is the function, you specify if you want to load more than just message
265 * numbers from the server during the listing fetch operation.
267 load_msg_ptrs_detailheaders LH,
270 * LoadMsgFromServer is called for every message in the message list:
273 * * up to 'maxmsgs' after your 'startmsg'
274 * * it should load and parse messages from citserer.
275 * * depending on your needs you might want to print your message here...
276 * * if cmd was empty, its skipped alltogether.
278 LoadMsgFromServer_func LoadMsgFromServer,
281 * RenderView_or_Tail is called last;
282 * * if you used PrintViewHeader to print messages, you might want to print
283 * trailing information here
284 * * if you just pre-loaded your messages, put your render code here.
286 RenderView_or_Tail_func RenderView_or_Tail,
289 * ViewCleanup should just clear your private data so all your mem can go back to
291 * it also should release the content for delivery via end_burst() or wDumpContent(1);
293 View_Cleanup_func ViewCleanup,
295 * brofwseListFields schould be a NULL-terminated list of message field mnemonics
296 * that will be the browse vector for the message header list.
298 const char **browseListFields
301 GetParamsGetServerCall
311 int ParseMessageListHeaders_Detail(StrBuf *Line,
313 message_summary *Msg,
314 StrBuf *ConversionBuffer,
315 void **ViewSpecific);
318 * @brief function to register the availability to render a specific message
319 * @param HeaderName Mimetype we know howto display
320 * @param HdrNLen length...
321 * @param InlineRenderable Should we announce to citserver that we want to receive these mimeparts immediately?
322 * @param Priority if multipart/alternative; which mimepart/Renderer should be prefered? (only applies if InlineRenderable)
324 void RegisterMimeRenderer(const char *HeaderName, long HdrNLen,
325 RenderMimeFunc MimeRenderer,
326 int InlineRenderable,
331 * @brief fill the header parts of Msg with the headers loaded by MSG0
332 * @param Msg empty message struct, only preinitialized with the msgid
333 * @param FoundCharset buffer with the prefered charset of the headers
334 * @param buf linebuffer used to buffer citserver replies
336 int ReadOneMessageSummary(message_summary *Msg, StrBuf *FoundCharset, StrBuf *Buf);