When editing a vCard, suppress the email fields from being displayed when editing...
[citadel.git] / webcit / webcit.h
index 342571fcbce08e25e07ee3cf07690b8ec1955085..7059b12140def9e2289a9f75a90588f41cff01bf 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1987-2012 by the citadel.org team
+ * Copyright (c) 1987-2020 by the citadel.org team
  *
  * This program is open source software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License version 3.
@@ -25,9 +25,6 @@
 #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>
@@ -64,8 +61,6 @@
 #define _(string)      (string)
 #endif
 
-#define IsEmptyStr(a) ((a)[0] == '\0')
-
 #define DO_DBG_QR 0
 #define DBG_QR(x) if(DO_DBG_QR) _DBG_QR(x)
 #define DBG_QR2(x) if(DO_DBG_QR) _DBG_QR2(x)
@@ -132,9 +127,9 @@ extern char *ssl_cipher_list;
 #define PORT_NUM               2000            /* port number to listen on */
 #define DEVELOPER_ID           0
 #define CLIENT_ID              4
-#define CLIENT_VERSION         813             /* This version of WebCit */
-#define MINIMUM_CIT_VERSION    813             /* Minimum required version of Citadel server */
-#define        LIBCITADEL_MIN          813             /* Minimum required version of libcitadel */
+#define CLIENT_VERSION         926             /* This version of WebCit */
+#define MINIMUM_CIT_VERSION    924             /* Minimum required version of Citadel server */
+#define        LIBCITADEL_MIN          924             /* Minimum required version of libcitadel */
 #define DEFAULT_HOST           "localhost"     /* Default Citadel server */
 #define DEFAULT_PORT           "504"
 #define TARGET                 "webcit01"      /* Window target for inline URL's */
@@ -145,16 +140,12 @@ extern char *ssl_cipher_list;
 #define USERCONFIGROOM         "My Citadel Config"
 #define DEFAULT_MAXMSGS                20
 
-
 #ifdef LIBCITADEL_VERSION_NUMBER
 #if LIBCITADEL_VERSION_NUMBER < LIBCITADEL_MIN
 #error libcitadel is too old.  Please upgrade it before continuing.
 #endif
 #endif
 
-
-
-
 #define SRV_STATUS_MSG(ServerLineBuf) (ChrPtr(ServerLineBuf) + 4), (StrLength(ServerLineBuf) - 4)
 #define MAJORCODE(a) (((int)(a / 100) ) * 100)
 
@@ -201,17 +192,11 @@ extern char *ssl_cipher_list;
 /*
  * Expiry policy for the autopurger
  */
-#define EXPIRE_NEXTLEVEL        0       /* Inherit expiration policy    */
-#define EXPIRE_MANUAL           1       /* Don't expire messages at all */
-#define EXPIRE_NUMMSGS          2       /* Keep only latest n messages  */
-#define EXPIRE_AGE              3       /* Expire messages after n days */
 
 typedef struct __ExpirePolicy {
         int expire_mode;
         int expire_value;
 } ExpirePolicy;
-void LoadExpirePolicy(GPEXWhichPolicy which);
-void SaveExpirePolicyFromHTTP(GPEXWhichPolicy which);
 
 /*
  * Linked list of session variables encoded in an x-www-urlencoded content type
@@ -219,7 +204,9 @@ void SaveExpirePolicyFromHTTP(GPEXWhichPolicy which);
 typedef struct urlcontent urlcontent;
 struct urlcontent {
        char url_key[32];               /* key */
+       long klen;
        StrBuf *url_data;               /* value */
+       HashList *sub;
 };
 
 /*
@@ -260,20 +247,16 @@ typedef struct _disp_cal {
        icalproperty_status Status;
 } disp_cal;                                            
 
-typedef struct _IcalEnumMap {
+typedef struct _IcalKindEnumMap {
        const char *Name;
        long NameLen;
        icalproperty_kind map;
-} IcalEnumMap;
-
-/*
- * Address book entry (keep it short and sweet, it's just a quickie lookup
- * which we can use to get to the real meat and bones later)
- */
-typedef struct _addrbookent {
-       char ab_name[64];       /* name string */
-       long ab_msgnum;         /* message number of address book entry */
-} addrbookent;
+} IcalKindEnumMap;
+typedef struct _IcalMethodEnumMap {
+       const char *Name;
+       long NameLen;
+        icalproperty_method map;
+} IcalMethodEnumMap;
 
 
 #define AJAX (1<<0)
@@ -294,7 +277,7 @@ typedef struct _addrbookent {
 #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);
+long webcit_fmt_date(char *buf, size_t siz, time_t thetime, int Format);
 
 
 typedef enum _RESTDispatchID {
@@ -313,7 +296,6 @@ typedef struct  _WebcitHandler{
        StrBuf *DisplayName;
 } WebcitHandler;
 
-
 void WebcitAddUrlHandler(const char * UrlString, long UrlSLen, const char *DisplayName, long dslen, WebcitHandlerFunc F, long Flags);
 
 typedef struct _headereval {
@@ -321,13 +303,11 @@ typedef struct _headereval {
        int Type;
 } headereval;
 
-
 struct attach_link {
        char partnum[32];
        char html[1024];
 };
 
-
 enum {
        eUp,
        eDown,
@@ -353,8 +333,6 @@ extern const char *ReqStrs[eNONE];
 #define AUTH_COOKIE 1
 #define AUTH_BASIC 2
 
-
-
 typedef struct _HdrRefs {
        long eReqType;                          /* HTTP method */
        int desired_session;
@@ -384,6 +362,10 @@ typedef struct _HdrRefs {
 
 typedef struct _ParsedHttpHdrs {
        int http_sock;                          /* HTTP server socket */
+       long HaveRange;
+       long RangeStart;
+       long RangeTil;
+       long TotalBytes;
        const char *Pos;
        StrBuf *ReadBuf;
 
@@ -402,7 +384,6 @@ typedef struct _ParsedHttpHdrs {
        HdrRefs HR;
 } ParsedHttpHdrs;
 
-
 /*
  * One of these is kept for each active Citadel session.
  * HTTP transactions are bound to one at a time.
@@ -416,6 +397,7 @@ struct wcsession {
        int ctdl_pid;                           /* Session ID on the Citadel server */
        int nonce;                              /* session nonce (to prevent session riding) */
        int inuse;                              /* set to nonzero if bound to a running thread */
+       int isFailure;                          /* Http 2xx or 5xx? */
 
 /* Session local Members */
        int serv_sock;                          /* Client socket to Citadel server */
@@ -445,7 +427,7 @@ struct wcsession {
        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_aide;                            /* nonzero == this user is an Admin */
        int connected;                          /* nonzero == we are connected to Citadel */
        int logged_in;                          /* nonzero == we are logged in  */
        int need_regi;                          /* This user needs to register. */
@@ -490,6 +472,8 @@ struct wcsession {
 
        char last_chat_user[256];
 
+       StrBuf *IconTheme;                      /* Icontheme setting */
+
 /* Iconbar controls */
        int cache_max_folders;
        int cache_num_floors;
@@ -510,8 +494,6 @@ struct wcsession {
        HashList *InetCfg;                      /* Our inet server config for editing */
        ExpirePolicy Policy[maxpolicy];
 
-/* used by the blog viewer */
-       int bptlid;                             /* hash of thread currently being rendered */
 };
 
 
@@ -553,11 +535,10 @@ extern char file_crpt_file_cer[PATH_MAX];
 
 void init_ssl(void);
 void endtls(void);
-void ssl_lock(int mode, int n, const char *file, int line);
 int starttls(int sock);
 extern SSL_CTX *ssl_ctx;  
 int client_read_sslbuffer(StrBuf *buf, int timeout);
-void client_write_ssl(const StrBuf *Buf);
+int client_write_ssl(const StrBuf *Buf);
 #endif
 
 extern int is_https;
@@ -574,6 +555,7 @@ void InitialiseSemaphores(void);
 void begin_critical_section(int which_one);
 void end_critical_section(int which_one);
 
+void CheckGZipCompressionAllowed(const char *MimeType, long MLen);
 
 extern void do_404(void);
 void http_redirect(const char *);
@@ -585,150 +567,84 @@ void wcc_printf(const char *FILE, const char *FUNCTION, long LINE, const char *f
 #else 
 void wc_printf(const char *format,...)__attribute__((__format__(__printf__,1,2)));
 #endif
-
 void hprintf(const char *format,...)__attribute__((__format__(__printf__,1,2)));
-
 void CheckAuthBasic(ParsedHttpHdrs *hdr);
 void GetAuthBasic(ParsedHttpHdrs *hdr);
-
 void sleeeeeeeeeep(int);
-
 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);
 time_t httpdate_to_timestamp(StrBuf *buf);
-
-
-
-
 void end_webcit_session(void);
-
-
-
-
-void cookie_to_stuff(StrBuf *cookie,
-               int *session,
-               StrBuf *user,
-               StrBuf *pass,
-               StrBuf *room,
-               StrBuf *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 display_login(void);
 void display_openids(void);
 void display_default_landing_page(void);
 void do_welcome(void);
-
 void display_reg(int during_login);
 void display_main_menu(void);
 void display_aide_menu(void);
-
 void RegisterEmbeddableMimeType(const char *MimeType, long MTLen, int Priority);
 void CreateMimeStr(void);
-
-
 void pop_destination(void);
-
 void FmOut(StrBuf *Target, const char *align, const StrBuf *Source);
 void wDumpContent(int);
-
-
 void PutRequestLocalMem(void *Data, DeleteHashDataFunc DeleteIt);
-
-void output_headers(    int do_httpheaders,
-                       int do_htmlhead,
-                       int do_room_banner,
-                       int unset_cookies,
-                       int suppress_check,
-                       int cache);
-void output_custom_content_header(const char *ctype);
+void output_headers(int do_httpheaders, int do_htmlhead, int do_room_banner, int unset_cookies, int suppress_check, int cache);
 void cdataout(char *rawdata);
-
-
 void url(char *buf, size_t bufsize);
 void UrlizeText(StrBuf* Target, StrBuf *Source, StrBuf *WrkBuf);
-
-
-void display_vcard(StrBuf *Target, wc_mime_attachment *Mime, char alpha, int full, char **storename, long msgnum);
-
 void display_success(const char *successmessage);
-
 void shutdown_sessions(void);
-
-
-
 StrBuf *load_mimepart(long msgnum, char *partnum);
 void MimeLoadData(wc_mime_attachment *Mime);
-void do_edit_vcard(long msgnum, char *partnum, 
-                  message_summary *VCMsg,
-                  wc_mime_attachment *VCAtt,
-                  const char *return_to, 
-                  const char *force_room);
-
+void do_edit_vcard(long msgnum, char *partnum, message_summary *VCMsg, wc_mime_attachment *VCAtt, const char *return_to, const char *force_room);
 void select_user_to_edit(const char *preselect);
-
 void convenience_page(const char *titlebarcolor, const char *titlebarmsg, const char *messagetext);
 void output_html(const char *, int, int, StrBuf *, StrBuf *);
-
 ssize_t write(int fd, const void *buf, size_t count);
 void cal_process_attachment(wc_mime_attachment *Mime);
-
-void address_book_popup(void);
 void begin_ajax_response(void);
 void end_ajax_response(void);
-
 extern char *months[];
 extern char *days[];
-long locate_user_vcard_in_this_room(message_summary **VCMsg,
-                                   wc_mime_attachment **VCAtt);
+long locate_user_vcard_in_this_room(message_summary **VCMsg, wc_mime_attachment **VCAtt);
 void http_transmit_thing(const char *content_type, int is_static);
+void http_transmit_headers(const char *content_type, int is_static, long is_chunked, int is_gzip);
 long unescape_input(char *buf);
 void check_thread_pool_size(void);
 void StrEndTab(StrBuf *Target, int tabnum, int num_tabs);
 void StrBeginTab(StrBuf *Target, int tabnum, int num_tabs, StrBuf **Names);
 void StrTabbedDialog(StrBuf *Target, int num_tabs, StrBuf *tabnames[]);
-void tabbed_dialog(int num_tabs, char *tabnames[]);
+void tabbed_dialog(int num_tabs, const char *tabnames[]);
 void begin_tab(int tabnum, int num_tabs);
 void end_tab(int tabnum, int num_tabs);
-
 int get_time_format_cached (void);
 void display_wiki_pagelist(void);
-void str_wiki_index(char *);
-
+void str_wiki_index(StrBuf *);
 HashList *GetRoomListHashLKRA(StrBuf *Target, WCTemplputParams *TP);
-
-/* actual supported locales */
-void TmplGettext(StrBuf *Target, WCTemplputParams *TP);
-
+void TmplGettext(StrBuf *Target, WCTemplputParams *TP); /* actual supported locales */
 void set_selected_language(const char *);
 void go_selected_language(void);
-void stop_selected_language(void);
 const char *get_selected_language(void);
-
 void utf8ify_rfc822_string(char **buf);
-
 void begin_burst(void);
 long end_burst(void);
-
 void AppendImportantMessage(const char *pch, long len);
-
 void http_datestring(char *buf, size_t n, time_t xtime);
 
-
 /* These should be empty, but we have them for testing */
 #define DEFAULT_HTTPAUTH_USER  ""
 #define DEFAULT_HTTPAUTH_PASS  ""
 
-
 /* Exit codes 101 through 109 are initialization failures so we don't want to
  * just keep respawning indefinitely.
  */
 #define WC_EXIT_BIND           101     /* Can't bind to the port */
 #define WC_EXIT_SSL            102     /* Can't initialize SSL */
 
-
 #define WC_TIMEFORMAT_NONE 0
 #define WC_TIMEFORMAT_AMPM 1
 #define WC_TIMEFORMAT_24 2
@@ -736,26 +652,6 @@ void http_datestring(char *buf, size_t n, time_t xtime);
 extern int time_to_die;                        /* Nonzero if server is shutting down */
 extern int DisableGzip;
 
-/* 
- * Array type for a blog post.  The first message is the post; the rest are comments
- */
-struct blogpost {
-       int top_level_id;
-       long *msgs;             /* Array of msgnums for messages we are displaying */
-       int num_msgs;           /* Number of msgnums stored in 'msgs' */
-       int alloc_msgs;         /* Currently allocated size of array */
-};
-
-
-/*
- * Data which gets returned from a call to blogview_learn_thread_references()
- */
-struct bltr {
-       int id;
-       int refs;
-};
-
-
-struct bltr blogview_learn_thread_references(long msgnum);
-void tmplput_blog_permalink(StrBuf *Target, WCTemplputParams *TP);
 void display_summary_page(void);
+HashList *GetValidDomainNames(StrBuf *Target, WCTemplputParams *TP);
+void output_error_pic(const char *ErrMsg1, const char *ErrMsg2);