webcit/messages.h

   1
   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 {
   8         RenderMimeFunc f;
   9 } RenderMimeFuncStruct;
  10
  11 struct wc_mime_attachment {
  12         int level;
  13         StrBuf *Name;
  14         StrBuf *FileName;
  15         StrBuf *PartNum;
  16         StrBuf *Disposition;
  17         StrBuf *ContentType;
  18         StrBuf *Charset;
  19         StrBuf *Data;
  20         size_t length;          /* length of the mimeattachment */
  21         long size_known;
  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;
  25 };
  26 void DestroyMime(void *vMime);
  27
  28 #define MSGFLAG_READ (1<<0)
  29
  30 typedef struct _message_summary {
  31         long msgnum;            /* the message number on the citadel server */
  32         int Flags;
  33
  34         time_t date;            /* its creation date */
  35         int nhdr;
  36         int format_type;
  37         StrBuf *euid;
  38         StrBuf *from;           /* the author */
  39         StrBuf *to;             /* the recipient */
  40         StrBuf *subj;           /* the title / subject */
  41         StrBuf *reply_inreplyto;
  42         StrBuf *reply_references;
  43         StrBuf *ReplyTo;
  44         StrBuf *cccc;
  45         StrBuf *hnod;
  46         StrBuf *AllRcpt;
  47         StrBuf *Room;
  48         StrBuf *Rfca;
  49         StrBuf *OtherNode;
  50         const StrBuf *PartNum;
  51
  52         HashList *Attachments;  /* list of attachments */
  53         HashList *Submessages;
  54         HashList *AttachLinks;
  55
  56         HashList *AllAttach;
  57
  58         int hasattachments;
  59
  60
  61         /* The mime part of the message */
  62         wc_mime_attachment *MsgBody;
  63 } message_summary;
  64 void DestroyMessageSummary(void *vMsg);
  65
  66
  67
  68 static inline message_summary* GetMessagePtrAt(int n, HashList *Summ)
  69 {
  70         const char *Key;
  71         long HKLen;
  72         void *vMsg;
  73
  74         if (Summ == NULL)
  75                 return NULL;
  76         GetHashAt(Summ, n, &HKLen, &Key, &vMsg);
  77         return (message_summary*) vMsg;
  78 }
  79
  80 typedef void (*ExamineMsgHeaderFunc)(message_summary *Msg, StrBuf *HdrLine, StrBuf *FoundCharset);
  81
  82 void evaluate_mime_part(message_summary *Msg, wc_mime_attachment *Mime);
  83
  84
  85 typedef enum _eCustomRoomRenderer {
  86         eUseDefault = VIEW_JOURNAL + 100,
  87         eReadEUIDS
  88 }eCustomRoomRenderer;
  89
  90 enum {
  91         do_search,
  92         headers,
  93         readfwd,
  94         readnew,
  95         readold,
  96         readgt,
  97         readlt
  98 };
  99
 100 /**
 101  * @brief function to parse the | separated message headers list
 102  * @param Line the raw line with your message data
 103  * @param Msg put your parser results here...
 104  * @param ConversionBuffer if you need some workbuffer, don't free me!
 105  * @returns 0: failure, trash this message. 1: all right, store it
 106  */
 107 typedef int (*load_msg_ptrs_detailheaders) (StrBuf *Line,
 108                                             const char **pos,
 109                                             message_summary *Msg,
 110                                             StrBuf *ConversionBuffer);
 111
 112 typedef void (*readloop_servcmd)(char *buf, long bufsize);
 113
 114 typedef struct _readloopstruct {
 115         ConstStr name;
 116         readloop_servcmd cmd;
 117 } readloop_struct;
 118
 119 extern readloop_struct rlid[];
 120
 121 void readloop(long oper, eCustomRoomRenderer ForceRenderer);
 122 int read_message(StrBuf *Target,
 123                  const char *tmpl, long tmpllen,
 124                  long msgnum,
 125                  const StrBuf *section,
 126                  const StrBuf **OutMime);
 127 int load_message(message_summary *Msg,
 128                  StrBuf *FoundCharset,
 129                  StrBuf **Error);
 130
 131
 132
 133
 134 typedef struct _SharedMessageStatus {
 135         long load_seen;        /* should read information be loaded */
 136         long sortit;           /* should we sort it using the standard sort API? */
 137         long defaultsortorder; /* if we should sort it, which direction should be the default? */
 138
 139         long maxload;          /* how many headers should we accept from the server? defaults to 10k */
 140         long maxmsgs;          /* how many message bodies do you want to load at most?*/
 141
 142         long startmsg;         /* which is the start message? */
 143         long nummsgs;          /* How many messages are available to your view? */
 144         long num_displayed;    /* counted up for LoadMsgFromServer */ /* TODO: unclear who should access this and why */
 145
 146         long lowest_found;     /* smallest Message ID found;  */
 147         long highest_found;    /* highest Message ID found;  */
 148
 149 } SharedMessageStatus;
 150
 151 int load_msg_ptrs(const char *servcmd,
 152                   const char *filter,
 153                   SharedMessageStatus *Stat,
 154                   load_msg_ptrs_detailheaders LH);
 155
 156 typedef int (*GetParamsGetServerCall_func)(SharedMessageStatus *Stat,
 157                                            void **ViewSpecific,
 158                                            long oper,
 159                                            char *cmd,
 160                                            long len,
 161                                            char *filter,
 162                                            long flen);
 163
 164 typedef int (*PrintViewHeader_func)(SharedMessageStatus *Stat, void **ViewSpecific);
 165
 166 typedef int (*LoadMsgFromServer_func)(SharedMessageStatus *Stat,
 167                                       void **ViewSpecific,
 168                                       message_summary* Msg,
 169                                       int is_new,
 170                                       int i);
 171
 172 typedef int (*RenderView_or_Tail_func)(SharedMessageStatus *Stat,
 173                                        void **ViewSpecific,
 174                                        long oper);
 175 typedef int (*View_Cleanup_func)(void **ViewSpecific);
 176
 177 void RegisterReadLoopHandlerset(
 178         /**
 179          * RoomType: which View definition are you going to be called for
 180          */
 181         int RoomType,
 182
 183         /**
 184          * GetParamsGetServerCall should do the following:
 185          *  * allocate your private context structure
 186          *  * evaluate your commandline arguments, put results to your private struct.
 187          *  * fill cmd with the command to load the message pointer list:
 188          *    * might depend on bstr/oper depending on your needs
 189          *    * might stay empty if no list should loaded and LoadMsgFromServer
 190          *      is skipped.
 191          *  * influence the behaviour by presetting values on SharedMessageStatus
 192          */
 193         GetParamsGetServerCall_func GetParamsGetServerCall,
 194
 195         /**
 196          * PrintpageHeader prints the surrounding information like iconbar, header etc.
 197          * by default, output_headers() is called.
 198          *
 199          */
 200         PrintViewHeader_func PrintPageHeader,
 201
 202         /**
 203          * PrintViewHeader is here to print informations infront of your messages.
 204          * The message list is already loaded & sorted (if) so you can evaluate
 205          * its result on the SharedMessageStatus struct.
 206          */
 207         PrintViewHeader_func PrintViewHeader,
 208
 209         /**
 210          * LH is the function, you specify if you want to load more than just message
 211          * numbers from the server during the listing fetch operation.
 212          */
 213         load_msg_ptrs_detailheaders LH,
 214
 215         /**
 216          * LoadMsgFromServer is called for every message in the message list:
 217          *  * which is
 218          *    * after 'startmsg'
 219          *    * up to 'maxmsgs' after your 'startmsg'
 220          *  * it should load and parse messages from citserer.
 221          *  * depending on your needs you might want to print your message here...
 222          *  * if cmd was empty, its skipped alltogether.
 223          */
 224         LoadMsgFromServer_func LoadMsgFromServer,
 225
 226         /**
 227          * RenderView_or_Tail is called last;
 228          *  * if you used PrintViewHeader to print messages, you might want to print
 229          *    trailing information here
 230          *  * if you just pre-loaded your messages, put your render code here.
 231          */
 232         RenderView_or_Tail_func RenderView_or_Tail,
 233
 234         /**
 235          * ViewCleanup should just clear your private data so all your mem can go back to
 236          * VALgrindHALLA.
 237          * it also should release the content for delivery via end_burst() or wDumpContent(1);
 238          */
 239         View_Cleanup_func ViewCleanup
 240         );
 241 /*
 242 GetParamsGetServerCall
 243
 244 PrintViewHeader
 245
 246 LoadMsgFromServer
 247
 248 RenderView_or_Tail
 249 */
 250
 251
 252 int ParseMessageListHeaders_Detail(StrBuf *Line,
 253                                    const char **pos,
 254                                    message_summary *Msg,
 255                                    StrBuf *ConversionBuffer);
 256
 257
 258
 259 /**
 260  * @brief function to register the availability to render a specific message
 261  * @param HeaderName Mimetype we know howto display
 262  * @param HdrNLen length...
 263  * @param InlineRenderable Should we announce to citserver that we want to receive these mimeparts immediately?
 264  * @param Priority if multipart/alternative; which mimepart/Renderer should be prefered? (only applies if InlineRenderable)
 265  */
 266 void RegisterMimeRenderer(const char *HeaderName, long HdrNLen,
 267                           RenderMimeFunc MimeRenderer,
 268                           int InlineRenderable,
 269                           int Priority);