* add more module handlers:
[citadel.git] / webcit / webcit.h
index 1464bf583f5f8735811fa37c959b7a639a854569..1efdeec091589fb36e8cb1f3a598f78508486306 100644 (file)
 #define PORT_NUM               2000            /* port number to listen on */
 #define DEVELOPER_ID           0
 #define CLIENT_ID              4
-#define CLIENT_VERSION         739             /* This version of WebCit */
-#define MINIMUM_CIT_VERSION    739             /* min required Citadel ver */
-#define        LIBCITADEL_MIN          739             /* min required libcitadel ver */
+#define CLIENT_VERSION         760             /* This version of WebCit */
+#define MINIMUM_CIT_VERSION    744             /* min required Citadel ver */
+#define        LIBCITADEL_MIN          744             /* min required libcitadel ver */
 #define DEFAULT_HOST           "localhost"     /* Default Citadel server */
 #define DEFAULT_PORT           "504"
 #define TARGET                 "webcit01"      /* Target for inline URL's */
@@ -214,25 +214,25 @@ struct urlcontent {
 /*
  * \brief information about us ???
  */ 
-struct serv_info {
+typedef struct _serv_info {
        int serv_pid;                   /* Process ID of the Citadel server */
-       char serv_nodename[32];         /* Node name of the Citadel server */
-       char serv_humannode[64];        /* human readable node name of the Citadel server */
-       char serv_fqdn[64];             /* fully quallified Domain Name (such as uncensored.citadel.org) */
-       char serv_software[64];         /* What version does our connected citadel server use */
+       StrBuf *serv_nodename;          /* Node name of the Citadel server */
+       StrBuf *serv_humannode;         /* human readable node name of the Citadel server */
+       StrBuf *serv_fqdn;              /* fully quallified Domain Name (such as uncensored.citadel.org) */
+       StrBuf *serv_software;          /* What version does our connected citadel server use */
        int serv_rev_level;             /* Whats the citadel server revision */
-       char serv_bbs_city[64];         /* Geographic location of the Citadel server */
-       char serv_sysadm[64];           /* Name of system administrator */
-       char serv_moreprompt[256];      /* Whats the commandline textprompt */
+       StrBuf *serv_bbs_city;          /* Geographic location of the Citadel server */
+       StrBuf *serv_sysadm;            /* Name of system administrator */
+       StrBuf *serv_moreprompt;        /* Whats the commandline textprompt */
        int serv_ok_floors;             /* nonzero == server supports floors */
        int serv_supports_ldap;         /* is the server linked against an ldap tree for adresses? */
        int serv_newuser_disabled;      /* Has the server disabled self-service new user creation? */
-       char serv_default_cal_zone[128];/* Default timezone for unspecified calendar items */
+       StrBuf *serv_default_cal_zone;  /* Default timezone for unspecified calendar items */
        int serv_supports_sieve;        /* Does the server support Sieve mail filtering? */
        int serv_fulltext_enabled;      /* Does the server have the full text index enabled? */
-       char serv_svn_revision[256];    /* SVN revision of the server */
+       StrBuf *serv_svn_revision;      /* SVN revision of the server */
        int serv_supports_openid;       /* Does the server support authentication via OpenID? */
-};
+} ServInfo;
 
 
 
@@ -290,9 +290,15 @@ typedef struct _disp_cal {
 
        int multi_day_event;
        int is_repeat;
+       icalcomponent *SortBy;          /* cal items for display */
+       icalproperty_status Status;
 } disp_cal;                                            
 
-
+typedef struct _IcalEnumMap {
+       const char *Name;
+       long NameLen;
+       icalproperty_kind map;
+} IcalEnumMap;
 
 /*
  * Address book entry (keep it short and sweet, it's just a quickie lookup
@@ -328,80 +334,120 @@ enum {
  */
 typedef struct wcsession wcsession;
 struct wcsession {
+/* infrastructural members */
        wcsession *next;                        /**< Linked list */
+       pthread_mutex_t SessionMutex;           /**< mutex for exclusive access */
        int wc_session;                         /**< WebCit session ID */
-       char wc_username[128];                  /**< login name of current user */
-       char wc_fullname[128];                  /**< Screen name of current user */
-       char wc_password[128];                  /**< Password of current user */
-       char wc_roomname[256];                  /**< Room we are currently in */
-       int connected;                          /**< nonzero == we are connected to Citadel */
-       int logged_in;                          /**< nonzero == we are logged in  */
-       int axlevel;                            /**< this user's access level */
-       int is_aide;                            /**< nonzero == this user is an Aide */
-       int is_room_aide;                       /**< nonzero == this user is a Room Aide in this room */
+       int killthis;                           /**< Nonzero == purge this session */
+       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) */
+
+/* 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 */
+       const char *ReadPos;                    /**< whats our read position in ReadBuf? */
        int chat_sock;                          /**< Client socket to Citadel server - for chat */
+       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 */
+/* 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*/
+       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? */
+
+       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 */
+       int axlevel;                            /**< this user's access level */
+       int is_aide;                            /**< nonzero == this user is an Aide */
+       int is_room_aide;                       /**< nonzero == this user is a Room Aide in this room */
+       int connected;                          /**< nonzero == we are connected to Citadel */
+       int logged_in;                          /**< nonzero == we are logged in  */
+       int need_regi;                          /**< This user needs to register. */
+       int need_vali;                          /**< New users require validation. */
+
+/* Preferences */
+       StrBuf *cs_inet_email;                  /**< User's preferred Internet addr. */
+       char reply_to[512];                     /**< reply-to address */
+       HashList *hash_prefs;                   /**< WebCit preferences for this user */
+       StrBuf *DefaultCharset;                 /**< Charset the user preferes */
+       int downloaded_prefs;                   /** Has the client download its prefs yet? */
+       int SavePrefsToServer;                  /**< Should we save our preferences to the server at the end of the request? */
+       int selected_language;                  /**< Language selected by user */
+       int time_format_cache;                  /**< which timeformat does our user like? */
+
+/* current room related */
+       StrBuf *wc_roomname;                    /**< Room we are currently in */
        unsigned room_flags;                    /**< flags associated with the current room */
        unsigned room_flags2;                   /**< flags associated with the current room */
        int wc_view;                            /**< view for the current room */
        int wc_default_view;                    /**< default view for the current room */
        int wc_is_trash;                        /**< nonzero == current room is a Trash folder */
        int wc_floor;                           /**< floor number of current room */
+       int is_mailbox;                         /**< the current room is a private mailbox */
+
+/* next/previous room thingabob */
+       struct march *march;                    /**< march mode room list */
        char ugname[128];                       /**< where does 'ungoto' take us */
        long uglsn;                             /**< last seen message number for ungoto */
+
+/* Uploading; mime attachments for composing messages */
+       HashList *attachments;                  /**< list of attachments for 'enter message' */
        int upload_length;                      /**< content length of http-uploaded data */
        char *upload;                           /**< pointer to http-uploaded data */
        char upload_filename[PATH_MAX];         /**< filename of http-uploaded data */
        char upload_content_type[256];          /**< content type of http-uploaded data */
+
        int new_mail;                           /**< user has new mail waiting */
        int remember_new_mail;                  /**< last count of new mail messages */
-       int need_regi;                          /**< This user needs to register. */
-       int need_vali;                          /**< New users require validation. */
-       char cs_inet_email[256];                /**< User's preferred Internet addr. */
-       pthread_mutex_t SessionMutex;           /**< mutex for exclusive access */
-       time_t lastreq;                         /**< Timestamp of most recent HTTP */
-       int killthis;                           /**< Nonzero == purge this session */
-       struct march *march;                    /**< march mode room list */
-       char reply_to[512];                     /**< reply-to address */
+
+/* Roomiew control */
        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 */
-       char this_page[512];                    /**< URL of current page */
-       char http_host[512];                    /**< HTTP Host: header */
-       HashList *hash_prefs;                   /**< WebCit preferences for this user */
+  /** Perhaps these should be within a struct instead */
+       long startmsg;                          /**< message number to start at */
+       long maxmsgs;                           /**< maximum messages to display */
+        long num_displayed;                     /**< number of messages actually displayed */
        HashList *disp_cal_items;               /**< sorted list of calendar items; startdate is the sort criteria. */
-       HashList *attachments;                  /**< list of attachments for 'enter message' */
+
+
        char last_chat_user[256];               /**< ??? todo */
-       char ImportantMessage[SIZ];             /**< ??? todo */
-       int ctdl_pid;                           /**< Session ID on the Citadel server */
-       char httpauth_user[256];                /**< only for GroupDAV sessions */
-       char httpauth_pass[256];                /**< only for GroupDAV sessions */
-       int gzip_ok;                            /**< Nonzero if Accept-encoding: gzip */
-       int is_mailbox;                         /**< the current room is a private mailbox */
+
+/* Iconbar controls */
        struct folder *cache_fold;              /**< cache the iconbar room list */
        int cache_max_folders;                  /**< ??? todo */
        int cache_num_floors;                   /**< ??? todo */
        time_t cache_timestamp;                 /**< ??? todo */
-       HashList *IconBarSetttings;             /**< which icons should be shown / not shown? */
-       long current_iconbar;                   /**< What is currently in the iconbar? */
+       HashList *IconBarSettings;             /**< which icons should be shown / not shown? */
        const StrBuf *floordiv_expanded;        /**< which floordiv currently expanded */
-       int selected_language;                  /**< Language selected by user */
-       time_t last_pager_check;                /**< last time we polled for instant msgs */
-       int nonce;                              /**< session nonce (to prevent session riding) */
-       int time_format_cache;                  /**< which timeformat does our user like? */
-       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 *WBuf;                           /**< Our output buffer */
-       StrBuf *HBuf;                           /**< Our HeaderBuffer */
-       StrBuf *CLineBuf;                       /**< linebuffering client stuff */
-       StrBuf *DefaultCharset;                 /**< Charset the user preferes */
+
+
+
+/* cache stuff for templates. TODO: find a smartrer way */
        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 */
@@ -455,7 +501,6 @@ extern char file_crpt_file_csr[PATH_MAX];
 extern char file_crpt_file_cer[PATH_MAX];
 #endif
 
-struct serv_info serv_info;
 extern char floorlist[128][SIZ];
 extern char *axdefs[];
 extern char *ctdlhost, *ctdlport;
@@ -466,10 +511,6 @@ extern int setup_wizard;
 extern char wizard_filename[];
 extern time_t if_modified_since;
 extern int follow_xff;
-extern HashList *HandlerHash;
-extern HashList *PreferenceHooks;
-extern HashList *ZoneHash;
-extern HashList *SortHash;
 
 void InitialiseSemaphores(void);
 void begin_critical_section(int which_one);
@@ -477,13 +518,13 @@ void end_critical_section(int which_one);
 
 
 void stuff_to_cookie(char *cookie, size_t clen, int session,
-                       char *user, char *pass, char *room);
+                       StrBuf *user, StrBuf *pass, StrBuf *room);
 void cookie_to_stuff(StrBuf *cookie, int *session,
-                char *user, size_t user_len,
-                char *pass, size_t pass_len,
-                char *room, size_t room_len);
-void locate_host(char *, int);
-void become_logged_in(char *, char *, char *);
+                    StrBuf *user,
+                    StrBuf *pass,
+                    StrBuf *room);
+void locate_host(StrBuf *TBuf, int);
+void become_logged_in(const StrBuf *user, const StrBuf *pass, StrBuf *serv_response);
 void openid_manual_create(void);
 void display_login();
 void display_openids(void);
@@ -493,7 +534,8 @@ void display_main_menu(void);
 void display_aide_menu(void);
 void display_advanced_menu(void);
 void slrp_highest(void);
-void get_serv_info(char *, char *);
+ServInfo *get_serv_info(StrBuf *, char *);
+void DeleteServInfo(ServInfo **FreeMe);
 int uds_connectsock(char *);
 int tcp_connectsock(char *, char *);
 int serv_getln(char *strbuf, int bufsize);
@@ -529,28 +571,30 @@ void output_headers(    int do_httpheaders,
                        int unset_cookies,
                        int suppress_check,
                        int cache);
+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(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);
-void escputs(char *strbuf);
+void escputs(const 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 escputs1(const char *strbuf, int nbsp, int nolinebreaks);
 void msgesc(char *target, size_t tlen, char *strbuf);
 void msgescputs(char *strbuf);
 void msgescputs1(char *strbuf);
-void stripout(char *str, char leftboundary, char rightboundary);
 void dump_vars(void);
 void embed_main_menu(void);
-void serv_read(char *buf, int bytes);
 
 void SetAccessCommand(long Oper);
 void do_addrbook_view(addrbookent *addrbook, int num_ab);
-void fetch_ab_name(message_summary *Msg, char *namebuf);
-void display_vcard(StrBuf *Target, const char *vcard_source, char alpha, int full, char *storename, long msgnum);
+void fetch_ab_name(message_summary *Msg, char **namebuf);
+void display_vcard(StrBuf *Target, StrBuf *vcard_source, char alpha, int full, char **storename, long msgnum);
+void jsonMessageList(void);
+void new_summary_view(void);
+void getseen(void);
 void text_to_server(char *ptr);
 void text_to_server_qp(char *ptr);
 void confirm_delete_msg(void);
@@ -560,25 +604,26 @@ void server_to_text(void);
 void save_edit(char *description, char *enter_cmd, int regoto);
 void display_edit(char *description, char *check_cmd,
                  char *read_cmd, char *save_cmd, int with_room_banner);
-int gotoroom(char *gname);
+long gotoroom(const StrBuf *gname);
 void confirm_delete_room(void);
 void validate(void);
 void display_graphics_upload(char *, char *, char *);
 void do_graphics_upload(char *upl_cmd);
-void serv_read(char *buf, int bytes);
 void serv_gets(char *strbuf);
 void serv_write(const char *buf, int nbytes);
-void serv_puts(const char *string);
 void serv_putbuf(const StrBuf *string);
 void serv_printf(const char *format,...)__attribute__((__format__(__printf__,1,2)));
-void load_floorlist(void);
+void load_floorlist(StrBuf *Buf);
 void shutdown_sessions(void);
 void do_housekeeping(void);
-void smart_goto(char *);
+void smart_goto(const StrBuf *);
 void worker_entry(void);
-void session_loop(HashList *HTTPHeaders, StrBuf *ReqLine, StrBuf *ReqType, StrBuf *ReadBuf);
+void session_loop(StrBuf *ReqLine, 
+                 StrBuf *ReqType, 
+                 StrBuf *ReadBuf, 
+                 const char **Pos);
 size_t wc_strftime(char *s, size_t max, const char *format, const struct tm *tm);
-void fmt_time(char *buf, time_t thetime);
+void fmt_time(char *buf, size_t siz, time_t thetime);
 void httpdate(char *buf, time_t thetime);
 time_t httpdate_to_timestamp(StrBuf *buf);
 void end_webcit_session(void);
@@ -594,13 +639,16 @@ char *memreadline(char *start, char *buf, int maxlen);
 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
 void remove_token(char *source, int parmnum, char separator);
-char *load_mimepart(long msgnum, char *partnum);
+StrBuf *load_mimepart(long msgnum, char *partnum);
 void MimeLoadData(wc_mime_attachment *Mime);
 int pattern2(char *search, char *patn);
-void do_edit_vcard(long, char *, char *, char *);
-void striplt(char *);
-void stripltlen(char *, int *);
-void select_user_to_edit(char *message, char *preselect);
+void do_edit_vcard(long msgnum, char *partnum, 
+                  message_summary *VCMsg,
+                  wc_mime_attachment *VCAtt,
+                  char *return_to, 
+                  const char *force_room);
+
+void select_user_to_edit(const char *preselect);
 void delete_user(char *);
 void do_change_view(int);
 void folders(void);
@@ -608,8 +656,8 @@ void folders(void);
 
 
 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 offer_start_page(StrBuf *Target, WCTemplputParams *TP);
+void convenience_page(const char *titlebarcolor, const char *titlebarmsg, const char *messagetext);
 void output_html(const char *, int, int, StrBuf *, StrBuf *);
 void do_listsub(void);
 ssize_t write(int fd, const void *buf, size_t count);
@@ -622,7 +670,7 @@ void updatenote(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 calendar_summary_view(void);
 void free_march_list(wcsession *wcf);
 void display_rules_editor_inner_div(void);
 void generate_uuid(char *);
@@ -661,17 +709,19 @@ int ical_ctdl_is_overlap(
 
 extern char *months[];
 extern char *days[];
-int read_server_binary(StrBuf *Ret, size_t total_len);
+int read_server_binary(StrBuf *Ret, size_t total_len, StrBuf *Buf);
 int StrBuf_ServGetBLOB(StrBuf *buf, long BlobSize);
+int StrBuf_ServGetBLOBBuffered(StrBuf *buf, long BlobSize);
 int read_server_text(StrBuf *Buf, long *nLines);
-int goto_config_room(void);
-long locate_user_vcard_in_this_room(void);
+int goto_config_room(StrBuf *Buf);
+long locate_user_vcard_in_this_room(message_summary **VCMsg,
+                                   wc_mime_attachment **VCAtt);
 void sleeeeeeeeeep(int);
 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(char *roomname, StrBuf *request_method);
+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[]);
@@ -679,10 +729,16 @@ void tabbed_dialog(int num_tabs, char *tabnames[]);
 void begin_tab(int tabnum, int num_tabs);
 void end_tab(int tabnum, int num_tabs);
 void str_wiki_index(char *s);
+long guess_calhourformat(void);
 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);
+
+#define DATEFMT_FULL 0
+#define DATEFMT_BRIEF 1
+#define DATEFMT_RAWDATE 2
+#define DATEFMT_LOCALEDATE 3
+void webcit_fmt_date(char *buf, size_t siz, time_t thetime, int Format);
 int fetch_http(char *url, char *target_buf, int maxbytes);
 void free_attachments(wcsession *sess);
 void summary(void);
@@ -690,7 +746,17 @@ void summary(void);
 int is_mobile_ua(char *user_agent);
 
 void embed_room_banner(char *, int);
-
+#define FLOOR_PARAM_LEN 3
+extern const char FLOOR_PARAM_NAMES[(FLOOR_PARAM_LEN + 1)][15];
+extern const int FLOOR_PARAM_NAMELEN[(FLOOR_PARAM_LEN + 1)];
+#define FPKEY(a) FLOOR_PARAM_NAMES[a], FLOOR_PARAM_NAMELEN[a]
+#define ROOM_PARAM_LEN 8
+extern const char ROOM_PARAM_NAMES[(ROOM_PARAM_LEN + 1)][20];
+extern const int ROOM_PARAM_NAMELEN[(ROOM_PARAM_LEN +1)];
+#define RPKEY(a) ROOM_PARAM_NAMES[a], ROOM_PARAM_NAMELEN[a]
+HashList *GetFloorListHash(StrBuf *Target, WCTemplputParams *TP);
+HashList *GetRoomListHash(StrBuf *Target, WCTemplputParams *TP);
+int SortRoomsByListOrder(const void *room1, const void *room2);
 /* navbar types that can be passed to embed_room_banner */
 enum {
        navbar_none,
@@ -717,6 +783,7 @@ extern char *hourname[];    /* Names of hours (12am, 1am, etc.) */
 
 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{
@@ -747,3 +814,4 @@ void WebcitAddUrlHandler(const char * UrlString, long UrlSLen, WebcitHandlerFunc
 #define WC_TIMEFORMAT_24 2
 
 
+void LoadIconSettings(void);