X-Git-Url: https://code.citadel.org/?p=citadel.git;a=blobdiff_plain;f=webcit%2Fmessages.h;h=e9a3ebdc992c7797f3c3eac7246f2c850e71b99e;hp=3c0145b9a42213c8fdda6fd029c5e23d82c2103c;hb=HEAD;hpb=8715459d63e42b5b27cab8259d084ec6475a373f diff --git a/webcit/messages.h b/webcit/messages.h index 3c0145b9a..41ab5b3d3 100644 --- a/webcit/messages.h +++ b/webcit/messages.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 1996-2013 by the citadel.org team + * Copyright (c) 1996-2020 by the citadel.org team * * This program is open source software. You can redistribute it and/or * modify it under the terms of the GNU General Public License, version 3. @@ -9,10 +9,11 @@ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. */ +#ifndef MESSAGES_H +#define MESSAGES_H extern CtxType CTX_MAILSUM; extern CtxType CTX_MIME_ATACH; -extern HashList *MsgHeaderHandler; extern HashList *MimeRenderHandler; extern HashList *ReadLoopHandler; typedef struct wc_mime_attachment wc_mime_attachment; @@ -41,65 +42,95 @@ void DestroyMime(void *vMime); #define MSGFLAG_READ (1<<0) typedef struct _message_summary { - long msgnum; /* the message number on the citadel server */ + long msgnum; // the message number on the citadel server int Flags; - - time_t date; /* its creation date */ + time_t date; // its creation date int nhdr; int format_type; StrBuf *euid; - StrBuf *from; /* the author */ - StrBuf *to; /* the recipient */ - StrBuf *subj; /* the title / subject */ + StrBuf *from; // display name of message author + StrBuf *to; // the recipient + StrBuf *subj; // title / subject StrBuf *reply_inreplyto; + long reply_inreplyto_hash; StrBuf *reply_references; + long reply_references_hash; StrBuf *ReplyTo; StrBuf *cccc; - StrBuf *hnod; StrBuf *AllRcpt; StrBuf *Room; - StrBuf *Rfca; + StrBuf *Rfca; // UPN or email address of message author StrBuf *EnvTo; - StrBuf *OtherNode; const StrBuf *PartNum; - - HashList *Attachments; /* list of attachments */ + HashList *Attachments; // list of attachments HashList *Submessages; HashList *AttachLinks; - HashList *AllAttach; - int hasattachments; - - - /* The mime part of the message */ - wc_mime_attachment *MsgBody; + int is_local; // nonzero if the message originated on the local system + wc_mime_attachment *MsgBody; // the MIME part of the message } message_summary; -void DestroyMessageSummary(void *vMsg); +void DestroyMessageSummary(void *vMsg); +/* some of these fields map to msgkeys[] in msgbase.c ... others don't */ -static inline message_summary* GetMessagePtrAt(int n, HashList *Summ) -{ +/* I think these are supposed to align with fieldMnemonics in msg_renderers.c + * So if you change one you have to change the other. + * TODO: figure out who did this and beat them with a wet noodle. + */ +typedef enum _eMessageField { + eAuthor, + eXclusivID, + erFc822Addr, + emessageId, + eJournal, + eReplyTo, + eListID, + eMessageText, + eIsLocal, + eMessagePath, + eRecipient, + eSpecialField, + eTimestamp, + eMsgSubject, + eenVelopeTo, + eWeferences, + eCarbonCopY, + eHeaderOnly, + eFormatType, + eMessagePart, + eSubFolder, + eLastHeader +} eMessageField; + +extern const char* fieldMnemonics[]; + +int GetFieldFromMnemonic(eMessageField *f, const char* c); +int EvaluateMsgHdr(const char *HeaderName, long HdrNLen, message_summary *Msg, StrBuf *HdrLine, StrBuf *FoundCharset); +int EvaluateMsgHdrEnum(eMessageField f, message_summary *Msg, StrBuf *HdrLine, StrBuf *FoundCharset); + + +static inline message_summary* GetMessagePtrAt(int n, HashList *Summ) { const char *Key; long HKLen; void *vMsg; - if (Summ == NULL) + if (Summ == NULL) { return NULL; + } GetHashAt(Summ, n, &HKLen, &Key, &vMsg); return (message_summary*) vMsg; } -typedef void (*ExamineMsgHeaderFunc)(message_summary *Msg, StrBuf *HdrLine, StrBuf *FoundCharset); +typedef void (*ExamineMsgHeaderFunc)(message_summary *Msg, StrBuf *HdrLine, StrBuf *FoundCharset); void evaluate_mime_part(StrBuf *Target, WCTemplputParams *TP); - typedef enum _eCustomRoomRenderer { eUseDefault = VIEW_JOURNAL + 100, eReadEUIDS -}eCustomRoomRenderer; +} eCustomRoomRenderer; enum { do_search, @@ -116,12 +147,14 @@ enum { * @param Line the raw line with your message data * @param Msg put your parser results here... * @param ConversionBuffer if you need some workbuffer, don't free me! + * @param ViewSpecific your view specific context data * @returns 0: failure, trash this message. 1: all right, store it */ typedef int (*load_msg_ptrs_detailheaders) (StrBuf *Line, const char **pos, message_summary *Msg, - StrBuf *ConversionBuffer); + StrBuf *ConversionBuffer, + void **ViewSpecific); typedef void (*readloop_servcmd)(char *buf, long bufsize); @@ -137,7 +170,8 @@ int read_message(StrBuf *Target, const char *tmpl, long tmpllen, long msgnum, const StrBuf *section, - const StrBuf **OutMime); + const StrBuf **OutMime, + WCTemplputParams *TP); int load_message(message_summary *Msg, StrBuf *FoundCharset, StrBuf **Error); @@ -165,8 +199,13 @@ typedef struct _SharedMessageStatus { int load_msg_ptrs(const char *servcmd, const char *filter, - SharedMessageStatus *Stat, - load_msg_ptrs_detailheaders LH); + StrBuf *FoundCharset, + SharedMessageStatus *Stat, + void **ViewSpecific, + load_msg_ptrs_detailheaders LH, + StrBuf *FetchMessageList, + eMessageField *MessageFieldList, + long HeaderCount); typedef int (*GetParamsGetServerCall_func)(SharedMessageStatus *Stat, void **ViewSpecific, @@ -251,7 +290,12 @@ void RegisterReadLoopHandlerset( * VALgrindHALLA. * it also should release the content for delivery via end_burst() or wDumpContent(1); */ - View_Cleanup_func ViewCleanup + View_Cleanup_func ViewCleanup, + /** + * brofwseListFields schould be a NULL-terminated list of message field mnemonics + * that will be the browse vector for the message header list. + */ + const char **browseListFields ); /* GetParamsGetServerCall @@ -267,9 +311,8 @@ RenderView_or_Tail int ParseMessageListHeaders_Detail(StrBuf *Line, const char **pos, message_summary *Msg, - StrBuf *ConversionBuffer); - - + StrBuf *ConversionBuffer, + void **ViewSpecific); /** * @brief function to register the availability to render a specific message @@ -282,3 +325,14 @@ void RegisterMimeRenderer(const char *HeaderName, long HdrNLen, RenderMimeFunc MimeRenderer, int InlineRenderable, int Priority); + + +/** + * @brief fill the header parts of Msg with the headers loaded by MSG0 + * @param Msg empty message struct, only preinitialized with the msgid + * @param FoundCharset buffer with the prefered charset of the headers + * @param buf linebuffer used to buffer citserver replies + */ +int ReadOneMessageSummary(message_summary *Msg, StrBuf *FoundCharset, StrBuf *Buf); + +#endif