Readloop remove special cases
[citadel.git] / webcit / messages.h
index 321ef1f89c9a9353653c15ac1ceb1cffe74d2132..a063170e046c0d96ae688b75555f1e36bed785a8 100644 (file)
@@ -25,18 +25,21 @@ struct wc_mime_attachment {
 };
 void DestroyMime(void *vMime);
 
+#define MSGFLAG_READ (1<<0)
 
 typedef struct _message_summary {
-       time_t date;            /* its creation date */
        long msgnum;            /* the message number on the citadel server */
+       int Flags;
+
+       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 *reply_inreplyto;
        StrBuf *reply_references;
-       StrBuf *reply_to;
        StrBuf *cccc;
        StrBuf *hnod;
        StrBuf *AllRcpt;
@@ -51,7 +54,6 @@ typedef struct _message_summary {
 
        HashList *AllAttach;
 
-       int is_new;
        int hasattachments;
 
 
@@ -59,21 +61,53 @@ typedef struct _message_summary {
        wc_mime_attachment *MsgBody;
 } message_summary;
 void DestroyMessageSummary(void *vMsg);
-inline message_summary* GetMessagePtrAt(int n, HashList *Summ);
+
+
+
+static inline message_summary* GetMessagePtrAt(int n, HashList *Summ)
+{
+       const char *Key;
+       long HKLen;
+       void *vMsg;
+
+       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);
 
 void evaluate_mime_part(message_summary *Msg, wc_mime_attachment *Mime);
 
+
+typedef enum _eCustomRoomRenderer {
+       eUseDefault = VIEW_JOURNAL + 100, 
+       eReadEUIDS
+}eCustomRoomRenderer;
+
 enum {
        do_search,
        headers,
        readfwd,
        readnew,
        readold,
-       readgt
+       readgt,
+       readlt
 };
 
+/**
+ * @brief function to parse the | separated message headers list
+ * @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!
+ * @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);
+
 typedef void (*readloop_servcmd)(char *buf, long bufsize);
 
 typedef struct _readloopstruct {
@@ -83,8 +117,7 @@ typedef struct _readloopstruct {
 
 extern readloop_struct rlid[];
 
-
-void readloop(long oper);
+void readloop(long oper, eCustomRoomRenderer ForceRenderer);
 int read_message(StrBuf *Target, 
                 const char *tmpl, long tmpllen, 
                 long msgnum, 
@@ -97,31 +130,35 @@ int load_message(message_summary *Msg,
 
 
 
-typedef struct _SharedMessageStatus{
-       long load_seen;        /** should read information be loaded */
-       long sortit;           /** should we sort it using the standard sort API? */
-       long defaultsortorder; /** if we should sort it, which direction should be the default? */
+typedef struct _SharedMessageStatus {
+       long load_seen;        /* should read information be loaded */
+       long sortit;           /* should we sort it using the standard sort API? */
+       long defaultsortorder; /* if we should sort it, which direction should be the default? */
 
-       long maxload;          /** how many headers should we accept from the server? defaults to 10k */
-       long maxmsgs;          /** how many message bodies do you want to load at most?*/
-       long reverse;          /** should the load-range be reversed? */
+       long maxload;          /* how many headers should we accept from the server? defaults to 10k */
+       long maxmsgs;          /* how many message bodies do you want to load at most?*/
 
-       long startmsg;         /** which is the start message ????? */
-       long nummsgs;          /** How many messages are available to your view? */
-       long num_displayed;    /** counted up for LoadMsgFromServer */ /* TODO: unclear who should access this and why */
+       long startmsg;         /* which is the start message? */
+       long nummsgs;          /* How many messages are available to your view? */
+       long num_displayed;    /* counted up for LoadMsgFromServer */ /* TODO: unclear who should access this and why */
 
-       long lowest_found;     /** smallest Message ID found;  */
-       long highest_found;    /** highest Message ID found;  */
+       long lowest_found;     /* smallest Message ID found;  */
+       long highest_found;    /* highest Message ID found;  */
 
-}SharedMessageStatus;
+} SharedMessageStatus;
 
-int load_msg_ptrs(const char *servcmd, SharedMessageStatus *Stat);
+int load_msg_ptrs(const char *servcmd,
+                 const char *filter,
+                 SharedMessageStatus *Stat, 
+                 load_msg_ptrs_detailheaders LH);
 
 typedef int (*GetParamsGetServerCall_func)(SharedMessageStatus *Stat, 
                                           void **ViewSpecific, 
                                           long oper, 
                                           char *cmd, 
-                                          long len);
+                                          long len,
+                                          char *filter,
+                                          long flen);
 
 typedef int (*PrintViewHeader_func)(SharedMessageStatus *Stat, void **ViewSpecific);
 
@@ -154,6 +191,13 @@ void RegisterReadLoopHandlerset(
         */
        GetParamsGetServerCall_func GetParamsGetServerCall,
 
+       /**
+        * PrintpageHeader prints the surrounding information like iconbar, header etc.
+        * by default, output_headers() is called.
+        *
+        */
+       PrintViewHeader_func PrintPageHeader,
+
        /**
         * PrintViewHeader is here to print informations infront of your messages.
         * The message list is already loaded & sorted (if) so you can evaluate 
@@ -161,6 +205,12 @@ void RegisterReadLoopHandlerset(
         */
        PrintViewHeader_func PrintViewHeader,
 
+       /**
+        * LH is the function, you specify if you want to load more than just message
+        * numbers from the server during the listing fetch operation.
+        */
+       load_msg_ptrs_detailheaders LH,
+
        /**
         * LoadMsgFromServer is called for every message in the message list:
         *  * which is 
@@ -196,3 +246,23 @@ LoadMsgFromServer
 
 RenderView_or_Tail
 */
+
+
+int ParseMessageListHeaders_Detail(StrBuf *Line, 
+                                  const char **pos, 
+                                  message_summary *Msg, 
+                                  StrBuf *ConversionBuffer);
+
+
+
+/**
+ * @brief function to register the availability to render a specific message
+ * @param HeaderName Mimetype we know howto display
+ * @param HdrNLen length...
+ * @param InlineRenderable Should we announce to citserver that we want to receive these mimeparts immediately?
+ * @param Priority if multipart/alternative; which mimepart/Renderer should be prefered? (only applies if InlineRenderable)
+ */
+void RegisterMimeRenderer(const char *HeaderName, long HdrNLen, 
+                         RenderMimeFunc MimeRenderer,
+                         int InlineRenderable,
+                         int Priority);