2 extern HashList *MsgHeaderHandler;
3 extern HashList *MimeRenderHandler;
4 extern HashList *ReadLoopHandler;
5 typedef struct wc_mime_attachment wc_mime_attachment;
6 typedef void (*RenderMimeFunc)(wc_mime_attachment *Mime, StrBuf *RawData, StrBuf *FoundCharset);
7 typedef struct _RenderMimeFuncStruct {
9 } RenderMimeFuncStruct;
11 struct wc_mime_attachment {
20 size_t length; /* length of the mimeattachment */
22 long lvalue; /* if we put a long... */
23 long msgnum; /* the message number on the citadel server derived from message_summary */
24 const RenderMimeFuncStruct *Renderer;
26 void DestroyMime(void *vMime);
28 #define MSGFLAG_READ (1<<0)
30 typedef struct _message_summary {
31 long msgnum; /* the message number on the citadel server */
34 time_t date; /* its creation date */
38 StrBuf *from; /* the author */
39 StrBuf *to; /* the recipient */
40 StrBuf *subj; /* the title / subject */
41 StrBuf *reply_inreplyto;
42 StrBuf *reply_references;
49 const StrBuf *PartNum;
51 HashList *Attachments; /* list of attachments */
52 HashList *Submessages;
53 HashList *AttachLinks;
60 /* The mime part of the message */
61 wc_mime_attachment *MsgBody;
63 void DestroyMessageSummary(void *vMsg);
67 static inline message_summary* GetMessagePtrAt(int n, HashList *Summ)
75 GetHashAt(Summ, n, &HKLen, &Key, &vMsg);
76 return (message_summary*) vMsg;
79 typedef void (*ExamineMsgHeaderFunc)(message_summary *Msg, StrBuf *HdrLine, StrBuf *FoundCharset);
81 void evaluate_mime_part(message_summary *Msg, wc_mime_attachment *Mime);
84 typedef enum _eCustomRoomRenderer {
85 eUseDefault = VIEW_JOURNAL + 100,
100 * @brief function to parse the | separated message headers list
101 * @param Line the raw line with your message data
102 * @param Msg put your parser results here...
103 * @param ConversionBuffer if you need some workbuffer, don't free me!
104 * @returns 0: failure, trash this message. 1: all right, store it
106 typedef int (*load_msg_ptrs_detailheaders) (StrBuf *Line,
108 message_summary *Msg,
109 StrBuf *ConversionBuffer);
111 typedef void (*readloop_servcmd)(char *buf, long bufsize);
113 typedef struct _readloopstruct {
115 readloop_servcmd cmd;
118 extern readloop_struct rlid[];
120 void readloop(long oper, eCustomRoomRenderer ForceRenderer);
121 int read_message(StrBuf *Target,
122 const char *tmpl, long tmpllen,
124 const StrBuf *section,
125 const StrBuf **OutMime);
126 int load_message(message_summary *Msg,
127 StrBuf *FoundCharset,
133 typedef struct _SharedMessageStatus {
134 long load_seen; /* should read information be loaded */
135 long sortit; /* should we sort it using the standard sort API? */
136 long defaultsortorder; /* if we should sort it, which direction should be the default? */
138 long maxload; /* how many headers should we accept from the server? defaults to 10k */
139 long maxmsgs; /* how many message bodies do you want to load at most?*/
141 long startmsg; /* which is the start message? */
142 long nummsgs; /* How many messages are available to your view? */
143 long num_displayed; /* counted up for LoadMsgFromServer */ /* TODO: unclear who should access this and why */
145 long lowest_found; /* smallest Message ID found; */
146 long highest_found; /* highest Message ID found; */
148 } SharedMessageStatus;
150 int load_msg_ptrs(const char *servcmd,
152 SharedMessageStatus *Stat,
153 load_msg_ptrs_detailheaders LH);
155 typedef int (*GetParamsGetServerCall_func)(SharedMessageStatus *Stat,
163 typedef int (*PrintViewHeader_func)(SharedMessageStatus *Stat, void **ViewSpecific);
165 typedef int (*LoadMsgFromServer_func)(SharedMessageStatus *Stat,
167 message_summary* Msg,
171 typedef int (*RenderView_or_Tail_func)(SharedMessageStatus *Stat,
174 typedef int (*View_Cleanup_func)(void **ViewSpecific);
176 void RegisterReadLoopHandlerset(
178 * RoomType: which View definition are you going to be called for
183 * GetParamsGetServerCall should do the following:
184 * * allocate your private context structure
185 * * evaluate your commandline arguments, put results to your private struct.
186 * * fill cmd with the command to load the message pointer list:
187 * * might depend on bstr/oper depending on your needs
188 * * might stay empty if no list should loaded and LoadMsgFromServer
190 * * influence the behaviour by presetting values on SharedMessageStatus
192 GetParamsGetServerCall_func GetParamsGetServerCall,
195 * PrintpageHeader prints the surrounding information like iconbar, header etc.
196 * by default, output_headers() is called.
199 PrintViewHeader_func PrintPageHeader,
202 * PrintViewHeader is here to print informations infront of your messages.
203 * The message list is already loaded & sorted (if) so you can evaluate
204 * its result on the SharedMessageStatus struct.
206 PrintViewHeader_func PrintViewHeader,
209 * LH is the function, you specify if you want to load more than just message
210 * numbers from the server during the listing fetch operation.
212 load_msg_ptrs_detailheaders LH,
215 * LoadMsgFromServer is called for every message in the message list:
218 * * up to 'maxmsgs' after your 'startmsg'
219 * * it should load and parse messages from citserer.
220 * * depending on your needs you might want to print your message here...
221 * * if cmd was empty, its skipped alltogether.
223 LoadMsgFromServer_func LoadMsgFromServer,
226 * RenderView_or_Tail is called last;
227 * * if you used PrintViewHeader to print messages, you might want to print
228 * trailing information here
229 * * if you just pre-loaded your messages, put your render code here.
231 RenderView_or_Tail_func RenderView_or_Tail,
234 * ViewCleanup should just clear your private data so all your mem can go back to
236 * it also should release the content for delivery via end_burst() or wDumpContent(1);
238 View_Cleanup_func ViewCleanup
241 GetParamsGetServerCall
251 int ParseMessageListHeaders_Detail(StrBuf *Line,
253 message_summary *Msg,
254 StrBuf *ConversionBuffer);
259 * @brief function to register the availability to render a specific message
260 * @param HeaderName Mimetype we know howto display
261 * @param HdrNLen length...
262 * @param InlineRenderable Should we announce to citserver that we want to receive these mimeparts immediately?
263 * @param Priority if multipart/alternative; which mimepart/Renderer should be prefered? (only applies if InlineRenderable)
265 void RegisterMimeRenderer(const char *HeaderName, long HdrNLen,
266 RenderMimeFunc MimeRenderer,
267 int InlineRenderable,