* upgrade hash retriever function, it now takes the usual cloud of parameters as...
[citadel.git] / webcit / webcit.h
index 9ba816a3c5c43c1e33aa73eeb144b60069849d28..59a361e8ebfe5022fd157ac6af20ae7c31467b57 100644 (file)
@@ -1,3 +1,4 @@
+
 /* $Id$ */
 
 #include "sysdep.h"
@@ -49,6 +50,9 @@
 #endif
 
 #ifdef ENABLE_NLS
+#ifdef HAVE_XLOCALE_H
+#include <xlocale.h>
+#endif
 #include <libintl.h>
 #include <locale.h>
 #ifdef HAVE_USELOCALE
@@ -134,33 +138,33 @@ extern locale_t wc_locales[];
  *
  * bucket one...
  */
-#define QR_PERMANENT   1               /**< Room does not purge                */
-#define QR_INUSE       2               /**< Set if in use, clear if avail      */
-#define QR_PRIVATE     4               /**< Set for any type of private room   */
-#define QR_PASSWORDED  8               /**< Set if there's a password too      */
-#define QR_GUESSNAME   16              /**< Set if it's a guessname room       */
-#define QR_DIRECTORY   32              /**< Directory room                     */
-#define QR_UPLOAD      64              /**< Allowed to upload                  */
-#define QR_DOWNLOAD    128             /**< Allowed to download                */
-#define QR_VISDIR      256             /**< Visible directory                  */
-#define QR_ANONONLY    512             /**< Anonymous-Only room                */
-#define QR_ANONOPT     1024            /**< Anonymous-Option room              */
-#define QR_NETWORK     2048            /**< Shared network room                */
-#define QR_PREFONLY    4096            /**< Preferred status needed to enter   */
-#define QR_READONLY    8192            /**< Aide status required to post       */
-#define QR_MAILBOX     16384           /**< Set if this is a private mailbox   */
+#define QR_PERMANENT   1               /* Room does not purge          */
+#define QR_INUSE       2               /* Set if in use, clear if avail        */
+#define QR_PRIVATE     4               /* Set for any type of private room     */
+#define QR_PASSWORDED  8               /* Set if there's a password too        */
+#define QR_GUESSNAME   16              /* Set if it's a guessname room */
+#define QR_DIRECTORY   32              /* Directory room                       */
+#define QR_UPLOAD      64              /* Allowed to upload                    */
+#define QR_DOWNLOAD    128             /* Allowed to download          */
+#define QR_VISDIR      256             /* Visible directory                    */
+#define QR_ANONONLY    512             /* Anonymous-Only room          */
+#define QR_ANONOPT     1024            /* Anonymous-Option room                */
+#define QR_NETWORK     2048            /* Shared network room          */
+#define QR_PREFONLY    4096            /* Preferred status needed to enter     */
+#define QR_READONLY    8192            /* Aide status required to post */
+#define QR_MAILBOX     16384           /* Set if this is a private mailbox     */
 
-/**
+/*
  * bucket two...
  */
-#define QR2_SYSTEM     1               /**< System room; hide by default       */
-#define QR2_SELFLIST   2               /**< Self-service mailing list mgmt     */
-#define QR2_COLLABDEL  4               /**< Anyone who can post can also delete*/
-#define QR2_SUBJECTREQ  8               /**< Subject strongly recommended */
+#define QR2_SYSTEM     1               /* System room; hide by default */
+#define QR2_SELFLIST   2               /* Self-service mailing list mgmt       */
+#define QR2_COLLABDEL  4               /* Anyone who can post can also delete*/
+#define QR2_SUBJECTREQ  8               /* Subject strongly recommended */
 #define QR2_SMTP_PUBLIC 16              /* smtp public postable room */
 #define QR2_MODERATED  32              /* Listservice aide has to permit posts  */
 
-/**
+/*
  * user/room access
  */
 #define UA_KNOWN       2
@@ -169,22 +173,22 @@ extern locale_t wc_locales[];
 #define UA_ZAPPED      16
 
 
-/**
+/*
  * User flags (from Citadel)
  */
-#define US_NEEDVALID   1               /**< User needs to be validated         */
-#define US_PERM                4               /**< Permanent user                     */
-#define US_LASTOLD     16              /**< Print last old message with new    */
-#define US_EXPERT      32              /**< Experienced user                   */
-#define US_UNLISTED    64              /**< Unlisted userlog entry             */
-#define US_NOPROMPT    128             /**< Don't prompt after each message    */
-#define US_PROMPTCTL   256             /**< <N>ext & <S>top work at prompt     */
-#define US_DISAPPEAR   512             /**< Use "disappearing msg prompts"     */
-#define US_REGIS       1024            /**< Registered user                    */
-#define US_PAGINATOR   2048            /**< Pause after each screen of text    */
-#define US_INTERNET    4096            /**< Internet mail privileges           */
-#define US_FLOORS      8192            /**< User wants to see floors           */
-#define US_COLOR       16384           /**< User wants ANSI color support      */
+#define US_NEEDVALID   1               /* User needs to be validated           */
+#define US_PERM                4               /* Permanent user                       */
+#define US_LASTOLD     16              /* Print last old message with new      */
+#define US_EXPERT      32              /* Experienced user                     */
+#define US_UNLISTED    64              /* Unlisted userlog entry               */
+#define US_NOPROMPT    128             /* Don't prompt after each message      */
+#define US_PROMPTCTL   256             /* <N>ext & <S>top work at prompt       */
+#define US_DISAPPEAR   512             /* Use "disappearing msg prompts"       */
+#define US_REGIS       1024            /* Registered user                      */
+#define US_PAGINATOR   2048            /* Pause after each screen of text      */
+#define US_INTERNET    4096            /* Internet mail privileges             */
+#define US_FLOORS      8192            /* User wants to see floors             */
+#define US_COLOR       16384           /* User wants ANSI color support        */
 #define US_USER_SET    (US_LASTOLD | US_EXPERT | US_UNLISTED | \
                        US_NOPROMPT | US_DISAPPEAR | US_PAGINATOR | \
                        US_FLOORS | US_COLOR | US_PROMPTCTL )
@@ -196,16 +200,16 @@ extern locale_t wc_locales[];
 #define NLI    "(not logged in)"
 
 
-/**
+/*
  * \brief      Linked list of session variables encoded in an x-www-urlencoded content type
  */
 typedef struct urlcontent urlcontent;
 struct urlcontent {
-       char url_key[32];          /**< the variable name */
-       StrBuf *url_data;            /**< its value */
+       char url_key[32];          /* the variable name */
+       StrBuf *url_data;            /* its value */
 };
 
-/**
+/*
  * \brief information about us ???
  */ 
 struct serv_info {
@@ -230,14 +234,14 @@ struct serv_info {
 
 
 
-/**
+/*
  * \brief This struct holds a list of rooms for \\\<G\\\>oto operations.
  */
 struct march {
-       struct march *next;       /**< pointer to next in linked list */
-       char march_name[128];     /**< name of room */
-       int march_floor;          /**< floor number of room */
-       int march_order;          /**< sequence in which we are to visit this room */
+       struct march *next;       /* pointer to next in linked list */
+       char march_name[128];     /* name of room */
+       int march_floor;          /* floor number of room */
+       int march_order;          /* sequence in which we are to visit this room */
 };
 
 /* *
@@ -245,12 +249,12 @@ struct march {
  *             It is a binary tree.
  */
 struct roomlisting {
-       struct roomlisting *lnext;      /**< pointer to 'left' tree node */
-       struct roomlisting *rnext;      /**< pointer to 'right' tree node */
-       char rlname[128];               /**< name of room */
-       unsigned rlflags;               /**< room flags */
-       int rlfloor;                    /**< the floor it resides on */
-       int rlorder;                    /**< room listing order */
+       struct roomlisting *lnext;      /* pointer to 'left' tree node */
+       struct roomlisting *rnext;      /* pointer to 'right' tree node */
+       char rlname[128];               /* name of room */
+       unsigned rlflags;               /* room flags */
+       int rlfloor;                    /* the floor it resides on */
+       int rlorder;                    /* room listing order */
 };
 
 
@@ -282,19 +286,19 @@ typedef struct _TemplateToken {
        TemplateParam *Params[MAXPARAM];
 } WCTemplateToken;
 
-typedef void (*WCHandlerFunc)(StrBuf *Target, int nArgs, WCTemplateToken *Token, void *Context, int ContextType);
+typedef void (*WCHandlerFunc)();
 
 
-/**
+/*
  * \brief Dynamic content for variable substitution in templates
  */
 typedef struct _wcsubst {
-       int wcs_type;                       /**< which type of Substitution are we */
-       char wcs_key[32];                   /**< copy of our hashkey for debugging */
-       StrBuf *wcs_value;                  /**< if we're a string, keep it here */
-       long lvalue;                        /**< type long? keep data here */
-       int ContextRequired;                /**< do we require a context type? */
-       WCHandlerFunc wcs_function; /**< funcion hook ???*/
+       int wcs_type;                       /* which type of Substitution are we */
+       char wcs_key[32];                   /* copy of our hashkey for debugging */
+       StrBuf *wcs_value;                  /* if we're a string, keep it here */
+       long lvalue;                        /* type long? keep data here */
+       int ContextRequired;                /* do we require a context type? */
+       WCHandlerFunc wcs_function; /* funcion hook ???*/
 } wcsubst;
 
 #define CTX_NONE 0
@@ -306,6 +310,8 @@ typedef struct _wcsubst {
 #define CTX_PREF 6
 #define CTX_NODECONF 7
 #define CTX_USERLIST 8
+#define CTX_MAILSUM 9
+
 
 void RegisterNS(const char *NSName, long len, 
                int nMinArgs, 
@@ -328,7 +334,7 @@ void RegisterConditional(const char *Name, long len,
 
 
 typedef void (*SubTemplFunc)(StrBuf *TemplBuffer, void *Context, WCTemplateToken *Token);
-typedef HashList *(*RetrieveHashlistFunc)(WCTemplateToken *Token);
+typedef HashList *(*RetrieveHashlistFunc)(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context, int ContextType);
 typedef void (*HashDestructorFunc) (HashList **KillMe);
 void RegisterITERATOR(const char *Name, long len,
                      int AdditionalParams, 
@@ -352,8 +358,8 @@ void SVCallback(char *keyname, size_t keylen,  WCHandlerFunc fcn_ptr);
 void SVPUTBuf(const char *keyname, int keylen, const StrBuf *Buf, int ref);
 #define SVPutBuf(a, b, c); SVPUTBuf(a, sizeof(a) - 1, b, c)
 
-void DoTemplate(const char *templatename, long len, void *Context, StrBuf *Target, int ContextType);
-#define do_template(a, b) DoTemplate(a, sizeof(a) -1, b, NULL, 0);
+void DoTemplate(const char *templatename, long len, StrBuf *Target, void *Context, int ContextType);
+#define do_template(a, b) DoTemplate(a, sizeof(a) -1, NULL, b, 0);
 void url_do_template(void);
 
 int CompareSubstToToken(TemplateParam *ParamToCompare, TemplateParam *ParamToLookup);
@@ -362,62 +368,114 @@ int CompareSubstToStrBuf(StrBuf *Compare, TemplateParam *ParamToLookup);
 
 
 
-/**
+/*
  * \brief Values for wcs_type
  */
 enum {
-       WCS_STRING,       /**< its a string */
-       WCS_FUNCTION,     /**< its a function callback */
-       WCS_SERVCMD,      /**< its a command to send to the citadel server */
-       WCS_STRBUF,       /**< its a strbuf we own */
-       WCS_STRBUF_REF,   /**< its a strbuf we mustn't free */
-       WCS_LONG          /**< its an integer */
+       WCS_STRING,       /* its a string */
+       WCS_FUNCTION,     /* its a function callback */
+       WCS_SERVCMD,      /* its a command to send to the citadel server */
+       WCS_STRBUF,       /* its a strbuf we own */
+       WCS_STRBUF_REF,   /* its a strbuf we mustn't free */
+       WCS_LONG          /* its an integer */
 };
 
-/**
+/*
  * \brief mail attachment ???
  */
 struct wc_attachment {
-       struct wc_attachment *next;/**< pointer to next in list */
-       size_t length;                     /**< length of the contenttype */
-       char content_type[SIZ];    /**< the content itself ???*/
-       char filename[SIZ];                /**< the filename hooked to this content ??? */
-       char *data;                /**< the data pool; aka this content */
-       long lvalue;               /**< if we put a long... */
+       struct wc_attachment *next;/* pointer to next in list */
+       size_t length;                     /* length of the contenttype */
+       char content_type[SIZ];    /* the content itself ???*/
+       char filename[SIZ];                /* the filename hooked to this content ??? */
+       char *data;                /* the data pool; aka this content */
+       long lvalue;               /* if we put a long... */
 };
 
-/**
+typedef struct _wc_mime_attachment {
+       StrBuf *Name;
+       StrBuf *FileName;
+       StrBuf *PartNum;
+       StrBuf *Disposition;
+       StrBuf *ContentType;
+       StrBuf *Charset;
+       StrBuf *Data;
+       size_t length;                     /* length of the mimeatachment */
+       long size_known;
+       char content_type[SIZ];    /* the content itself ???*/
+       char filename[SIZ];                /* the filename hooked to this content ??? */
+       char *data;                /* the data pool; aka this content */
+       long lvalue;               /* if we put a long... */
+       long msgnum;            /**< the message number on the citadel server derived from message_summary */
+}wc_mime_attachment;
+
+
+typedef void (*RenderMimeFunc)(wc_mime_attachment *Mime, StrBuf *RawData, StrBuf *FoundCharset);
+
+/*
  * \brief message summary structure. ???
  */
-struct message_summary {
+typedef struct _message_summary {
        time_t date;        /**< its creation date */
        long msgnum;            /**< the message number on the citadel server */
-       char from[128];         /**< the author */
-       char to[128];           /**< the recipient */
-       char subj[256];         /**< the title / subject */
-       int hasattachments;     /**< does it have atachments? */
+       int nhdr;
+       int format_type;
+       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;
+       StrBuf *Room;
+       StrBuf *Rfca;
+       StrBuf *OtherNode;
+
+       HashList *Attachments;  /**< list of Accachments */
+       HashList *Submessages;
+       HashList *AttachLinks;
+
+       HashList *AllAttach;
+
        int is_new;         /**< is it yet read? */
-};
+       int hasattachments;     /* does it have atachments? */
+
+
+       /** The mime part of the message */
+       wc_mime_attachment MsgBody;
+
+
+       /** Referencces; don't neeed to be freed: */
+       wc_mime_attachment *cal_partnum_ref;
+       wc_mime_attachment *vcard_partnum_ref;
+} message_summary;
+
+typedef void (*ExamineMsgHeaderFunc)(message_summary *Msg, StrBuf *HdrLine, StrBuf *FoundCharset);
+
+
+
 
 /**
  * \brief  Data structure for roomlist-to-folderlist conversion 
  */
 struct folder {
-       int floor;      /**< which floor is it on */
-       char room[SIZ]; /**< which roomname ??? */
-       char name[SIZ]; /**< which is its own name??? */
-       int hasnewmsgs; /**< are there unread messages inside */
-       int is_mailbox; /**< is it a mailbox?  */
-       int selectable; /**< can we select it ??? */
-       int view;       /**< whats its default view? inbox/calendar.... */
-       int num_rooms;  /**< If this is a floor, how many rooms does it have */
+       int floor;      /* which floor is it on */
+       char room[SIZ]; /* which roomname ??? */
+       char name[SIZ]; /* which is its own name??? */
+       int hasnewmsgs; /* are there unread messages inside */
+       int is_mailbox; /* is it a mailbox?  */
+       int selectable; /* can we select it ??? */
+       int view;       /* whats its default view? inbox/calendar.... */
+       int num_rooms;  /* If this is a floor, how many rooms does it have */
 };
 
 typedef struct _disp_cal {                                     
-       icalcomponent *cal;             /**< cal items for display */
-       long cal_msgnum;                /**< cal msgids for display */
-       char *from;                     /**< owner of this component */
-       int unread;                     /**< already seen by the user? */
+       icalcomponent *cal;             /* cal items for display */
+       long cal_msgnum;                /* cal msgids for display */
+       char *from;                     /* owner of this component */
+       int unread;                     /* already seen by the user? */
 
        time_t event_start;
        time_t event_end;
@@ -427,9 +485,9 @@ typedef struct _disp_cal {
 } disp_cal;                                            
 
 
-/**
- * \brief One of these is kept for each active Citadel session.
- * HTTP transactions are bound to on e at a time.
+/*
+ * One of these is kept for each active Citadel session.
+ * HTTP transactions are bound to one at a time.
  */
 struct wcsession {
        struct wcsession *next;                 /**< Linked list */
@@ -469,8 +527,7 @@ struct wcsession {
        struct march *march;                    /**< march mode room list */
        char reply_to[512];                     /**< reply-to address */
        long msgarr[10000];                     /**< for read operations */
-       int num_summ;                           /**< number of messages in mailbox summary view */
-       struct message_summary *summ;           /**< array of messages for mailbox summary view */
+       HashList *summ;                         /**< list of messages for mailbox summary view */
        int is_mobile;                  /**< Client is a handheld browser */
        HashList *urlstrings;                   /**< variables passed to webcit in a URL */
        HashList *vars;                         /**< HTTP variable substitutions for this page */
@@ -502,15 +559,17 @@ struct wcsession {
        StrBuf *WBuf;                           /**< Our output buffer */
        StrBuf *HBuf;                           /**< Our HeaderBuffer */
        StrBuf *CLineBuf;                       /**< linebuffering client stuff */
-
+       StrBuf *DefaultCharset;                 /**< Charset the user preferes */
        HashList *ServCfg;                      /**< cache our server config for editing */
        HashList *InetCfg;                      /**< Our inet server config for editing */
+
+       StrBuf *trailing_javascript;            /**< extra javascript to be appended to page */
 };
 
-/** values for WC->current_iconbar */
+/* values for WC->current_iconbar */
 enum {
-       current_iconbar_menu,     /**< view the icon menue */
-       current_iconbar_roomlist  /**< view the roomtree */
+       current_iconbar_menu,     /* view the icon menue */
+       current_iconbar_roomlist  /* view the roomtree */
 };
 enum {
        S_SELECT,
@@ -518,6 +577,27 @@ enum {
        MAX_SEMAPHORES
 };
 
+
+/*
+ * calview contains data passed back and forth between the message fetching loop
+ * and the calendar view renderer.
+ */
+enum {
+       calview_month,
+       calview_day,
+       calview_week,
+       calview_brief
+};
+
+struct calview {
+       int view;
+       int year;
+       int month;
+       int day;
+       time_t lower_bound;
+       time_t upper_bound;
+};
+
 #ifndef num_parms
 #define num_parms(source)              num_tokens(source, '|') 
 #endif
@@ -557,7 +637,8 @@ extern HashList *GlobalNS;
 extern HashList *Iterators;
 extern HashList *ZoneHash;
 extern HashList *Contitionals;
-
+extern HashList *MsgHeaderHandler;
+extern HashList *MimeRenderHandler;
 
 void InitialiseSemaphores(void);
 void begin_critical_section(int which_one);
@@ -586,15 +667,20 @@ int uds_connectsock(char *);
 int tcp_connectsock(char *, char *);
 int serv_getln(char *strbuf, int bufsize);
 int StrBuf_ServGetln(StrBuf *buf);
+int GetServerStatus(StrBuf *Line, long* FullState);
 void serv_puts(const char *string);
 void who(void);
 void who_inner_div(void);
 void ajax_mini_calendar(void);
 void fmout(char *align);
 void _fmout(StrBuf *Targt, char *align);
+void FmOut(StrBuf *Target, char *align, StrBuf *Source);
 void pullquote_fmout(void);
 void wDumpContent(int);
 
+int Flathash(const char *str, long len);
+
+
 /* These may return NULL if not foud */
 #define sbstr(a) SBstr(a, sizeof(a) - 1)
 const StrBuf *SBSTR(const char *key);
@@ -649,6 +735,7 @@ void print_menu_box(char* Title, char *Class, int nLines, ...);
 long stresc(char *target, long tSize, char *strbuf, int nbsp, int nolinebreaks);
 void escputs(char *strbuf);
 void url(char *buf, size_t bufsize);
+void UrlizeText(StrBuf* Target, StrBuf *Source, StrBuf *WrkBuf);
 void escputs1(char *strbuf, int nbsp, int nolinebreaks);
 void msgesc(char *target, size_t tlen, char *strbuf);
 void msgescputs(char *strbuf);
@@ -742,16 +829,18 @@ int is_msg_in_mset(char *mset, long msgnum);
 void display_addressbook(long msgnum, char alpha);
 void offer_start_page(StrBuf *Target, int nArgs, WCTemplateToken *Token, void *Context, int ContextType);
 void convenience_page(char *titlebarcolor, char *titlebarmsg, char *messagetext);
-void output_html(char *, int, int);
+void output_html(const char *, int, int, StrBuf *, StrBuf *);
 void do_listsub(void);
 void toggle_self_service(void);
 ssize_t write(int fd, const void *buf, size_t count);
 void cal_process_attachment(char *part_source, long msgnum, char *cal_partnum);
-void display_calendar(long msgnum, int unread);
-void display_task(long msgnum, int unread);
-void display_note(long msgnum, int unread);
+void load_calendar_item(message_summary *Msg, int unread, struct calview *c);
+void display_calendar(message_summary *Msg, int unread);
+void display_task(message_summary *Msg, int unread);
+void display_note(message_summary *Msg, int unread);
 void updatenote(void);
-void do_calendar_view(void);
+void parse_calendar_view_request(struct calview *c);
+void render_calendar_view(struct calview *c);
 void do_tasks_view(void);
 void calendar_summary_view(void);
 int load_msg_ptrs(char *servcmd, int with_headers);
@@ -772,11 +861,13 @@ void display_pictureview(void);
 void display_edit_task(void);
 void display_edit_event(void);
 icaltimezone *get_default_icaltimezone(void);
-void display_icaltimetype_as_webform(struct icaltimetype *, char *);
+void display_icaltimetype_as_webform(struct icaltimetype *, char *, int);
 void icaltime_from_webform(struct icaltimetype *result, char *prefix);
 void icaltime_from_webform_dateonly(struct icaltimetype *result, char *prefix);
-void display_edit_individual_event(icalcomponent *supplied_vtodo, long msgnum, char *from, int unread);
-void save_individual_event(icalcomponent *supplied_vtodo, long msgnum, char *from, int unread);
+void display_edit_individual_event(icalcomponent *supplied_vtodo, long msgnum, char *from,
+       int unread, struct calview *calv);
+void save_individual_event(icalcomponent *supplied_vtodo, long msgnum, char *from,
+       int unread, struct calview *calv);
 void ical_dezonify(icalcomponent *cal);
 void partstat_as_string(char *buf, icalproperty *attendee);
 icalcomponent *ical_encapsulate_subcomponent(icalcomponent *subcomp);
@@ -806,7 +897,6 @@ void sleeeeeeeeeep(int);
 void http_transmit_thing(const char *content_type, int is_static);
 long unescape_input(char *buf);
 void do_selected_iconbar(void);
-int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
 void spawn_another_worker_thread(void);
 void display_rss(char *roomname, StrBuf *request_method);
 void offer_languages(StrBuf *Target, int nArgs, WCTemplateToken *Token, void *Context, int ContextType);
@@ -824,15 +914,12 @@ void end_tab(int tabnum, int num_tabs);
 void str_wiki_index(char *s);
 int get_time_format_cached (void);
 int xtoi(const char *in, size_t len);
+const char *get_selected_language(void);
 void webcit_fmt_date(char *buf, time_t thetime, int brief);
 int fetch_http(char *url, char *target_buf, int maxbytes);
 
 int is_mobile_ua(char *user_agent);
 
-#ifdef HAVE_ICONV
-iconv_t ctdl_iconv_open(const char *tocode, const char *fromcode);
-#endif
-
 void embed_room_banner(char *, int);
 
 /* navbar types that can be passed to embed_room_banner */
@@ -863,7 +950,7 @@ void utf8ify_rfc822_string(char *buf);
 void begin_burst(void);
 long end_burst(void);
 
-extern char *hourname[];       /**< Names of hours (12am, 1am, etc.) */
+extern char *hourname[];       /* Names of hours (12am, 1am, etc.) */
 
 void http_datestring(char *buf, size_t n, time_t xtime);