* move stuff from Hdr into substruct that may be easily wiped by memset 0'ing them
[citadel.git] / webcit / webcit.h
index 1efdeec091589fb36e8cb1f3a598f78508486306..8604155ec53fcf1b846f1c0ed12d02341d662714 100644 (file)
                        US_NOPROMPT | US_DISAPPEAR | US_PAGINATOR | \
                        US_FLOORS | US_COLOR | US_PROMPTCTL )
 
+
+#define MAJORCODE(a) (((int)(a / 100) ) * 100)
+
+#define LISTING_FOLLOWS        100
+#define CIT_OK                 200     
+#define MORE_DATA      300
+#define SEND_LISTING   400
+#define ERROR          500
+#define BINARY_FOLLOWS         600
+#define SEND_BINARY    700
+#define START_CHAT_MODE        800
+#define ASYNC_MSG      900
+
+#define MINORCODE(a) (a % 100)
+#define ASYNC_GEXP                     02      
+#define INTERNAL_ERROR                         10      
+#define TOO_BIG                        11      
+#define ILLEGAL_VALUE                  12      
+#define NOT_LOGGED_IN                  20      
+#define CMD_NOT_SUPPORTED              30      
+#define SERVER_SHUTTING_DOWN           31      
+#define PASSWORD_REQUIRED              40      
+#define ALREADY_LOGGED_IN              41      
+#define USERNAME_REQUIRED              42      
+#define HIGHER_ACCESS_REQUIRED                 50      
+#define MAX_SESSIONS_EXCEEDED          51      
+#define RESOURCE_BUSY                  52      
+#define RESOURCE_NOT_OPEN              53      
+#define NOT_HERE                       60      
+#define INVALID_FLOOR_OPERATION        61      
+#define NO_SUCH_USER                   70      
+#define FILE_NOT_FOUND                         71      
+#define ROOM_NOT_FOUND                         72      
+#define NO_SUCH_SYSTEM                         73      
+#define ALREADY_EXISTS                         74      
+#define MESSAGE_NOT_FOUND              75
 /*
  * NLI is the string that shows up in a who's online listing for sessions
  * that are active, but for which no user has yet authenticated.
@@ -310,6 +346,26 @@ typedef struct _addrbookent {
 } addrbookent;
 
 
+#define AJAX (1<<0)
+#define ANONYMOUS (1<<1)
+#define NEED_URL (1<<2)
+#define XHTTP_COMMANDS (1<<3)
+#define BOGUS (1<<4)
+#define URLNAMESPACE (1<<4)
+#define LOGCHATTY (1<<5)
+#define COOKIEUNNEEDED (1<<6)
+#define ISSTATIC (1<<7)
+#define FORCE_SESSIONCLOSE (1<<8)
+
+
+typedef void (*WebcitHandlerFunc)(void);
+typedef struct  _WebcitHandler{
+       WebcitHandlerFunc F;
+       long Flags;
+       StrBuf *Name;
+} WebcitHandler;
+void WebcitAddUrlHandler(const char * UrlString, long UrlSLen, WebcitHandlerFunc F, long Flags);
+
 typedef struct _headereval {
        ExamineMsgHeaderFunc evaluator;
        int Type;
@@ -328,6 +384,72 @@ enum {
        eNone
 };
 
+enum {
+       eGET,
+       ePOST,
+       eOPTIONS,
+       ePROPFIND,
+       ePUT,
+       eDELETE,
+       eHEAD,
+       eMOVE,
+       eCOPY,
+       eNONE
+};
+const char *ReqStrs[eNONE];
+
+#define NO_AUTH 0
+#define AUTH_COOKIE 1
+#define AUTH_BASIC 2
+
+
+
+typedef struct _HdrRefs {
+       long eReqType;                          /**< eGET, ePOST.... */
+       int desired_session;
+       int SessionKey;
+
+       int got_auth;
+       int DontNeedAuth;
+       long ContentLength;
+       time_t if_modified_since;
+       int gzip_ok;                            /**< Nonzero if Accept-encoding: gzip */
+
+       /* these are references into Hdr->HTTPHeaders, so we don't need to free them. */
+       StrBuf *ContentType;
+       StrBuf *RawCookie;
+       StrBuf *ReqLine;
+       StrBuf *http_host;                      /**< HTTP Host: header */
+       StrBuf *browser_host;
+       StrBuf *user_agent;
+       StrBuf *plainauth;
+
+
+       const WebcitHandler *Handler;
+} HdrRefs;
+
+typedef struct _ParsedHttpHdrs {
+       int http_sock;                          /**< HTTP server socket */
+       const char *Pos;
+       StrBuf *ReadBuf;
+
+       
+
+       StrBuf *c_username;
+       StrBuf *c_password;
+       StrBuf *c_roomname;
+       StrBuf *c_language;
+       StrBuf *this_page;                      /**< URL of current page */
+       StrBuf *PlainArgs; /*TODO: freeme*/
+
+       HashList *urlstrings;                   /**< variables passed to webcit in a URL */
+       HashList *HTTPHeaders;                  /**< the headers the client sent us */
+       int nWildfireHeaders;                   /**< how many wildfire headers did we already send? */
+
+       HdrRefs HR;
+} ParsedHttpHdrs;
+
+
 /*
  * One of these is kept for each active Citadel session.
  * HTTP transactions are bound to one at a time.
@@ -342,9 +464,9 @@ struct wcsession {
        int is_mobile;                          /**< Client is a handheld browser */
        int ctdl_pid;                           /**< Session ID on the Citadel server */
        int nonce;                              /**< session nonce (to prevent session riding) */
+       int SessionKey;
 
 /* Session local Members */
-       int http_sock;                          /**< HTTP server socket */
        int serv_sock;                          /**< Client socket to Citadel server */
        StrBuf *ReadBuf;                        /**< here we keep our stuff while reading linebuffered from the server. */
        StrBuf *MigrateReadLineBuf;             /**< here we buffer legacy server read stuff */
@@ -353,30 +475,21 @@ struct wcsession {
        time_t lastreq;                         /**< Timestamp of most recent HTTP */
        time_t last_pager_check;                /**< last time we polled for instant msgs */
        ServInfo *serv_info;                   /**< Iformation about the citserver we're connected to */
+       int is_ajax;                            /** < are we doing an ajax request? */
+
 /* Request local Members */
        StrBuf *CLineBuf;                       /**< linebuffering client stuff */
-       StrBuf *UrlFragment1;                   /**< first urlfragment, if NEED_URL is specified by the handler*/
-       StrBuf *UrlFragment2;                   /**< second urlfragment, if NEED_URL is specified by the handler*/
-       StrBuf *UrlFragment3;                   /**< third urlfragment, if NEED_URL is specified by the handler*/
-       StrBuf *UrlFragment4;                   /**< fourth urlfragment, if NEED_URL is specified by the handler*/
+       ParsedHttpHdrs *Hdr;
        StrBuf *WBuf;                           /**< Our output buffer */
        StrBuf *HBuf;                           /**< Our HeaderBuffer */
-       StrBuf *this_page;                      /**< URL of current page */
-       HashList *urlstrings;                   /**< variables passed to webcit in a URL */
-       HashList *vars;                         /**< HTTP variable substitutions for this page */
-       HashList *headers;                      /**< the headers the client sent us */
-       StrBuf *http_host;                      /**< HTTP Host: header */
-       int is_ajax;                            /** < are we doing an ajax request? */
-       int gzip_ok;                            /**< Nonzero if Accept-encoding: gzip */
-       int nWildfireHeaders;                   /**< how many wildfire headers did we already send? */
 
+       HashList *vars;                         /**< HTTP variable substitutions for this page */
        StrBuf *trailing_javascript;            /**< extra javascript to be appended to page */
        char ImportantMessage[SIZ];             /**< ??? todo */
        StrBuf *ImportantMsg;
 
 /* accounting */
        StrBuf *wc_username;                    /**< login name of current user */
-       StrBuf *httpauth_user;                  /**< only for GroupDAV sessions */
        StrBuf *wc_fullname;                    /**< Screen name of current user */
        StrBuf *wc_password;                    /**< Password of current user */
        StrBuf *httpauth_pass;                  /**< only for GroupDAV sessions */
@@ -450,6 +563,18 @@ struct wcsession {
 
 };
 
+
+typedef void (*Header_Evaluator)(StrBuf *Line, ParsedHttpHdrs *hdr);
+
+typedef struct _HttpHeader {
+       Header_Evaluator H;
+       StrBuf *Val;
+       int HaveEvaluator;
+} OneHttpHeader;
+
+void RegisterHeaderHandler(const char *Name, long Len, Header_Evaluator F);
+
+
 /* values for WC->current_iconbar */
 enum {
        current_iconbar_menu,     /* view the icon menue */
@@ -509,20 +634,26 @@ extern char *server_cookie;
 extern int is_https;
 extern int setup_wizard;
 extern char wizard_filename[];
-extern time_t if_modified_since;
 extern int follow_xff;
 
 void InitialiseSemaphores(void);
 void begin_critical_section(int which_one);
 void end_critical_section(int which_one);
 
-
-void stuff_to_cookie(char *cookie, size_t clen, int session,
-                       StrBuf *user, StrBuf *pass, StrBuf *room);
-void cookie_to_stuff(StrBuf *cookie, int *session,
-                    StrBuf *user,
-                    StrBuf *pass,
-                    StrBuf *room);
+void stuff_to_cookie(char *cookie, size_t clen,
+               int session,
+               StrBuf *user,
+               StrBuf *pass,
+               StrBuf *room,
+               char *language
+);
+void cookie_to_stuff(StrBuf *cookie,
+               int *session,
+               StrBuf *user,
+               StrBuf *pass,
+               StrBuf *room,
+               StrBuf *language
+);
 void locate_host(StrBuf *TBuf, int);
 void become_logged_in(const StrBuf *user, const StrBuf *pass, StrBuf *serv_response);
 void openid_manual_create(void);
@@ -534,7 +665,8 @@ void display_main_menu(void);
 void display_aide_menu(void);
 void display_advanced_menu(void);
 void slrp_highest(void);
-ServInfo *get_serv_info(StrBuf *, char *);
+ServInfo *get_serv_info(StrBuf *, StrBuf *);
+int GetConnected(void);
 void DeleteServInfo(ServInfo **FreeMe);
 int uds_connectsock(char *);
 int tcp_connectsock(char *, char *);
@@ -574,7 +706,7 @@ void output_headers(    int do_httpheaders,
 void output_custom_content_header(const char *ctype);
 void wprintf(const char *format,...)__attribute__((__format__(__printf__,1,2)));
 void hprintf(const char *format,...)__attribute__((__format__(__printf__,1,2)));
-void output_static(const char *what);
+void output_static(const char* What);
 
 void print_menu_box(char* Title, char *Class, int nLines, ...);
 long stresc(char *target, long tSize, char *strbuf, int nbsp, int nolinebreaks);
@@ -600,6 +732,8 @@ void text_to_server_qp(char *ptr);
 void confirm_delete_msg(void);
 void display_success(char *);
 void authorization_required(const char *message);
+void CheckAuthBasic(ParsedHttpHdrs *hdr);
+void GetAuthBasic(ParsedHttpHdrs *hdr);
 void server_to_text(void);
 void save_edit(char *description, char *enter_cmd, int regoto);
 void display_edit(char *description, char *check_cmd,
@@ -618,10 +752,7 @@ void shutdown_sessions(void);
 void do_housekeeping(void);
 void smart_goto(const StrBuf *);
 void worker_entry(void);
-void session_loop(StrBuf *ReqLine, 
-                 StrBuf *ReqType, 
-                 StrBuf *ReadBuf, 
-                 const char **Pos);
+void session_loop(void);
 size_t wc_strftime(char *s, size_t max, const char *format, const struct tm *tm);
 void fmt_time(char *buf, size_t siz, time_t thetime);
 void httpdate(char *buf, time_t thetime);
@@ -698,7 +829,6 @@ void ical_dezonify(icalcomponent *cal);
 void partstat_as_string(char *buf, icalproperty *attendee);
 icalcomponent *ical_encapsulate_subcomponent(icalcomponent *subcomp);
 void check_attendee_availability(icalcomponent *supplied_vevent);
-void do_freebusy(const char *req);
 int ical_ctdl_is_overlap(
                         struct icaltimetype t1start,
                         struct icaltimetype t1end,
@@ -721,7 +851,6 @@ void http_transmit_thing(const char *content_type, int is_static);
 long unescape_input(char *buf);
 void do_selected_iconbar(void);
 void spawn_another_worker_thread(void);
-void display_rss(const StrBuf *roomname, StrBuf *request_method);
 void StrEndTab(StrBuf *Target, int tabnum, int num_tabs);
 void StrBeginTab(StrBuf *Target, int tabnum, int num_tabs);
 void StrTabbedDialog(StrBuf *Target, int num_tabs, StrBuf *tabnames[]);
@@ -785,18 +914,6 @@ void http_datestring(char *buf, size_t n, time_t xtime);
 
 typedef void (*IcalCallbackFunc)(icalcomponent *, long, char*, int, struct calview *);
 
-typedef void (*WebcitHandlerFunc)(void);
-typedef struct  _WebcitHandler{
-       WebcitHandlerFunc F;
-       long Flags;
-} WebcitHandler;
-void WebcitAddUrlHandler(const char * UrlString, long UrlSLen, WebcitHandlerFunc F, long Flags);
-
-#define AJAX (1<<0)
-#define ANONYMOUS (1<<1)
-#define NEED_URL (1<<2)
-
-
 /* These should be empty, but we have them for testing */
 #define DEFAULT_HTTPAUTH_USER  ""
 #define DEFAULT_HTTPAUTH_PASS  ""