* All OS-level includes are now included from webcit.h instead of from
[citadel.git] / webcit / webcit.h
index b816518b111d0016de93e4585b192357f8eb7a46..7274f78940e7b2bc24ffa8135bbd8af7193eb029 100644 (file)
@@ -1,10 +1,57 @@
 /* $Id$ */
 
+#include <ctype.h>
+#include <stdlib.h>
+#ifdef HAVE_UNISTD_H
+#include <unistd.h>
+#endif
+#include <stdio.h>
+#ifdef HAVE_FCNTL_H
+#include <fcntl.h>
+#endif
+#include <signal.h>
+#include <sys/types.h>
+#include <sys/wait.h>
+#include <sys/socket.h>
+#ifdef HAVE_SYS_TIME_H
+#include <sys/time.h>
+#endif
+#include <sys/stat.h>
+#ifdef HAVE_LIMITS_H
+#include <limits.h>
+#endif
+#include <netinet/in.h>
+#include <arpa/inet.h>
+#include <sys/un.h>
+#include <netdb.h>
+#include <sys/poll.h>
+#include <string.h>
+#include <pwd.h>
+#include <errno.h>
+#include <stdarg.h>
+#include <pthread.h>
+#include <signal.h>
+#include <sys/utsname.h>
+
+#ifdef HAVE_ICONV
+#include <iconv.h>
+#endif
+
+
+/*
+ * Uncomment to dump an HTTP trace to stderr
+#define HTTP_TRACING 1
+ */
+
+#ifdef HTTP_TRACING
+#undef HAVE_ZLIB_H
+#undef HAVE_ZLIB
+#endif
+
 #ifdef HAVE_ZLIB_H
 #include <zlib.h>
 #endif
 
-
 #ifdef HAVE_ICAL_H
 #ifdef HAVE_LIBICAL
 #define WEBCIT_WITH_CALENDAR_SERVICE 1
 #define SLEEPING               180             /* TCP connection timeout */
 #define WEBCIT_TIMEOUT         900             /* WebCit session timeout */
 #define PORT_NUM               2000            /* port number to listen on */
-#define SERVER                 "WebCit v5.22"  /* who's in da house */
+#define SERVER                 "WebCit v6.21"  /* who's in da house */
 #define DEVELOPER_ID           0
 #define CLIENT_ID              4
-#define CLIENT_VERSION         522             /* This version of WebCit */
-#define MINIMUM_CIT_VERSION    623             /* min required Citadel vers */
+#define CLIENT_VERSION         621             /* This version of WebCit */
+#define MINIMUM_CIT_VERSION    655             /* min required Citadel vers */
 #define DEFAULT_HOST           "localhost"     /* Default Citadel server */
 #define DEFAULT_PORT           "504"
 #define LB                     (1)             /* Internal escape chars */
  *
  * bucket one...
  */
-#define QR_PERMANENT   1               /* Room does not purge              */
+#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_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 QR2_SELFLIST   2               /* Self-service mailing list mgmt   */
 
 
-#define UA_KNOWN                2
-#define UA_GOTOALLOWED          4
-#define UA_HASNEWMSGS           8
-#define UA_ZAPPED               16
+#define UA_KNOWN               2
+#define UA_GOTOALLOWED   4
+#define UA_HASNEWMSGS     8
+#define UA_ZAPPED             16
 
 
 
@@ -172,12 +219,22 @@ struct wc_attachment {
        char *data;
 };
 
+struct message_summary {
+       time_t date;
+       long msgnum;
+       char from[128];
+       char to[128];
+       char subj[128];
+       int hasattachments;
+       int is_new;
+};
+
 /*
  * 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 */
+       struct wcsession *next;         /* Linked list */
        int wc_session;                 /* WebCit session ID */
        char wc_username[SIZ];
        char wc_password[SIZ];
@@ -205,16 +262,19 @@ struct wcsession {
        int need_regi;                  /* This user needs to register. */
        int need_vali;                  /* New users require validation. */
        char cs_inet_email[SIZ];        /* User's preferred Internet addr. */
-        pthread_mutex_t SessionMutex;  /* mutex for exclusive access */
-        time_t lastreq;                        /* Timestamp of most recent HTTP */
+       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[SIZ];             /* reply-to address */
-       long msgarr[4096];              /* for read operations */
-       int fake_frames;
+
+       long msgarr[10000];             /* for read operations */
+       int num_summ;
+       struct message_summary *summ;
+
        int is_wap;                     /* Client is a WAP gateway */
        struct urlcontent *urlstrings;
-       int HaveExpressMessages;        /* Nonzero if incoming msgs exist */
+       int HaveInstantMessages;        /* Nonzero if incoming msgs exist */
        struct wcsubst *vars;
        char this_page[SIZ];            /* address of current page */
        char http_host[SIZ];            /* HTTP Host: header */
@@ -228,12 +288,16 @@ struct wcsession {
 #endif
        struct wc_attachment *first_attachment;
        char ImportantMessage[SIZ];
-       int outside_frameset_allowed;   /* nonzero if current req is allowed
-                                        * outside of the main frameset */
        char last_chat_user[SIZ];
+       int ctdl_pid;                   /* Session ID on the Citadel server */
+       char httpauth_user[SIZ];        /* only for GroupDAV sessions */
+       char httpauth_pass[SIZ];        /* only for GroupDAV sessions */
+
+       size_t burst_len;
+       char *burst;
+       int gzip_ok;                    /* Nonzero if Accept-encoding: gzip */
 };
 
-#define extract(dest,source,parmnum)   extract_token(dest,source,parmnum,'|')
 #define num_parms(source)              num_tokens(source, '|')
 
 /* Per-session data */
@@ -252,14 +316,18 @@ extern char *axdefs[];
 extern char *ctdlhost, *ctdlport;
 extern char *server_cookie;
 extern int is_https;
-
-extern struct wcsubst *global_subst;
-
+extern int setup_wizard;
+extern char wizard_filename[];
+void do_setup_wizard(void);
 
 void stuff_to_cookie(char *cookie, int session,
                        char *user, char *pass, char *room);
 void cookie_to_stuff(char *cookie, int *session,
-                       char *user, char *pass, char *room);
+                char *user, size_t user_len,
+                char *pass, size_t pass_len,
+                char *room, size_t room_len);
+char *bmstrstr(char *text, char *pattern,
+        int (*cmpfunc)(const char *, const char *, size_t) );
 void locate_host(char *, int);
 void become_logged_in(char *, char *, char *);
 void do_login(void);
@@ -267,6 +335,7 @@ void display_login(char *mesg);
 void do_welcome(void);
 void do_logout(void);
 void display_main_menu(void);
+void display_aide_menu(void);
 void display_advanced_menu(void);
 void slrp_highest(void);
 void gotonext(void);
@@ -274,9 +343,10 @@ void ungoto(void);
 void get_serv_info(char *, char *);
 int uds_connectsock(char *);
 int tcp_connectsock(char *, char *);
-void serv_gets(char *strbuf);
+void serv_getln(char *strbuf, int bufsize);
 void serv_puts(char *string);
-void whobbs(void);
+void who(void);
+void who_inner_html(void);
 void fmout(FILE *fp, char *align);
 void wDumpContent(int);
 void serv_printf(const char *format,...);
@@ -285,7 +355,13 @@ void urlesc(char *, char *);
 void urlescputs(char *);
 void jsesc(char *, char *);
 void jsescputs(char *);
-void output_headers(int);
+void output_headers(    int do_httpheaders,
+                       int do_htmlhead,
+                       int do_room_banner,
+                       int unset_cookies,
+                       int refresh30,
+                       int suppress_check,
+                       int cache);
 void wprintf(const char *format,...);
 void output_static(char *what);
 void stresc(char *target, char *strbuf, int nbsp, int nolinebreaks);
@@ -294,20 +370,20 @@ void url(char *buf);
 void escputs1(char *strbuf, int nbsp, int nolinebreaks);
 void msgesc(char *target, char *strbuf);
 void msgescputs(char *strbuf);
-long extract_long(char *source, long int parmnum);
-int extract_int(char *source, int parmnum);
+int extract_int(const char *source, int parmnum);
+long extract_long(const char *source, int parmnum);
 void stripout(char *str, char leftboundary, char rightboundary);
 void dump_vars(void);
 void embed_main_menu(void);
 void serv_read(char *buf, int bytes);
 int haschar(char *, char);
 void readloop(char *oper);
+void embed_message(void);
 void text_to_server(char *ptr, int convert_to_html);
 void display_enter(void);
 void post_message(void);
 void confirm_delete_msg(void);
 void delete_msg(void);
-void do_stuff_to_one_msg(void);
 void confirm_move_msg(void);
 void move_msg(void);
 void userlist(void);
@@ -327,11 +403,12 @@ void display_editroom(void);
 void netedit(void);
 void editroom(void);
 void display_whok(void);
+void do_invt_kick(void);
 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 headers_type);
-void gotoroom(char *gname, int display_name);
+                 char *read_cmd, char *save_cmd, int with_room_banner);
+void gotoroom(char *gname);
 void confirm_delete_room(void);
 void delete_room(void);
 void validate(void);
@@ -360,11 +437,10 @@ void siteconfig(void);
 void display_generic(void);
 void do_generic(void);
 void display_menubar(int);
-void embed_room_banner(char *);
 void smart_goto(char *);
 void worker_entry(void);
 void session_loop(struct httprequest *);
-void fmt_date(char *buf, time_t thetime);
+void fmt_date(char *buf, time_t thetime, int brief);
 void fmt_time(char *buf, time_t thetime);
 void httpdate(char *buf, time_t thetime);
 void end_webcit_session(void);
@@ -379,7 +455,7 @@ void do_template(void *templatename);
 int lingering_close(int fd);
 char *memreadline(char *start, char *buf, int maxlen);
 int num_tokens (char *source, char tok);
-void extract_token(char *dest, char *source, int parmnum, char separator);
+void 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);
 int pattern2(char *search, char *patn);
@@ -388,6 +464,7 @@ void edit_vcard(void);
 void submit_vcard(void);
 void striplt(char *);
 void select_user_to_edit(char *message, char *preselect);
+void delete_user(char *);
 void display_edituser(char *who, int is_new);
 void create_user(void);
 void edituser(void);
@@ -397,15 +474,16 @@ void folders(void);
 void do_stuff_to_msgs(void);
 void load_preferences(void);
 void save_preferences(void);
-void get_preference(char *key, char *value);
-void set_preference(char *key, char *value);
+void get_preference(char *key, char *value, size_t value_len);
+void set_preference(char *key, char *value, int save_to_server);
 void knrooms(void);
 int is_msg_in_mset(char *mset, long msgnum);
 char *safestrncpy(char *dest, const char *src, size_t n);
 void display_addressbook(long msgnum, char alpha);
 void offer_start_page(void);
+void convenience_page(char *titlebarcolor, char *titlebarmsg, char *messagetext);
 void change_start_page(void);
-void output_html(void);
+void output_html(char *);
 void display_floorconfig(char *);
 void delete_floor(void);
 void create_floor(void);
@@ -417,18 +495,21 @@ 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);
 void display_task(long msgnum);
+void display_note(long msgnum);
 void do_calendar_view(void);
 void do_tasks_view(void);
 void free_calendar_buffer(void);
 void calendar_summary_view(void);
-int load_msg_ptrs(char *servcmd);
+int load_msg_ptrs(char *servcmd, int with_headers);
 void CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen);
 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
 void free_attachments(struct wcsession *sess);
 void set_room_policy(void);
 void display_inetconf(void);
 void save_inetconf(void);
-
+void generate_uuid(char *);
+void display_preferences(void);
+void set_preferences(void);
 
 #ifdef WEBCIT_WITH_CALENDAR_SERVICE
 void display_edit_task(void);
@@ -436,10 +517,10 @@ void save_task(void);
 void display_edit_event(void);
 void save_event(void);
 void display_icaltimetype_as_webform(struct icaltimetype *, char *);
-struct icaltimetype icaltime_from_webform(char *prefix);
+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);
 void save_individual_event(icalcomponent *supplied_vtodo, long msgnum);
-void generate_new_uid(char *);
 void respond_to_request(void);
 void handle_rsvp(void);
 void ical_dezonify(icalcomponent *cal);
@@ -465,6 +546,12 @@ void commit_iconbar(void);
 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
 void spawn_another_worker_thread(void);
 
+void embed_room_banner(char *, int);
+/* navbar types that can be passed to embed_room_banner */
+enum {
+       navbar_none,
+       navbar_default
+};
 
 
 #ifdef HAVE_OPENSSL
@@ -477,7 +564,18 @@ int client_read_ssl(char *buf, int bytes, int timeout);
 void client_write_ssl(char *buf, int nbytes);
 #endif
 
+#ifdef HAVE_ZLIB
+#include <zlib.h>
+int ZEXPORT compress_gzip(Bytef * dest, uLongf * destLen,
+                          const Bytef * source, uLong sourceLen, int level);
+#endif
+
 
+void begin_burst(void);
+void end_burst(void);
+
+extern char *ascmonths[];
+void http_datestring(char *buf, size_t n, time_t xtime);
 
 /* Views (from citadel.h) */
 #define        VIEW_BBS                0       /* Traditional Citadel BBS view */
@@ -485,3 +583,9 @@ void client_write_ssl(char *buf, int nbytes);
 #define VIEW_ADDRESSBOOK       2       /* Address book view */
 #define VIEW_CALENDAR          3       /* Calendar view */
 #define VIEW_TASKS             4       /* Tasks view */
+#define VIEW_NOTES             5       /* Notes view */
+
+
+/* These should be empty, but we have them for testing */
+#define DEFAULT_HTTPAUTH_USER  ""
+#define DEFAULT_HTTPAUTH_PASS  ""