final touches on dkim test harness
[citadel.git] / webcit / webcit.h
index cc700fa7e6da9302e210e2b2ffd4a795456eb7cc..31eaa92dffc36f66c36ab63abe4601d624b5d1f6 100644 (file)
@@ -1,14 +1,5 @@
-/*
- * Copyright (c) 1987-2018 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.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- */
+// Copyright (c) 1987-2024 by the citadel.org team (Art Cancro et al)
+// This program is open source software.  Use, duplication, or disclosure is subject to the GNU General Public license v3.
 
 #include "sysdep.h"
 #include <sys/select.h>
@@ -87,16 +78,16 @@ typedef struct wcsession wcsession;
 #include "roomops.h"
 #include "preferences.h"
 
-#include "tcp_sockets.h"
+#include "sockets.h"
 #include "utils.h"
 #ifdef HAVE_OPENSSL
-/* Work around RedHat's b0rken OpenSSL includes */
+// Work around RedHat's b0rken OpenSSL includes
 #define OPENSSL_NO_KRB5
 #include <openssl/ssl.h>
 #include <openssl/err.h>
 #include <openssl/rand.h>
 extern char *ssl_cipher_list;
-#define        DEFAULT_SSL_CIPHER_LIST "DEFAULT"       /* See http://openssl.org/docs/apps/ciphers.html */
+#define        DEFAULT_SSL_CIPHER_LIST "DEFAULT"       // See http://openssl.org/docs/apps/ciphers.html
 #endif
 
 #if SIZEOF_SIZE_T == SIZEOF_INT 
@@ -122,34 +113,29 @@ extern char *ssl_cipher_list;
 #undef memcpy
 #endif
 
-#define SLEEPING               180             /* TCP connection timeout */
-#define WEBCIT_TIMEOUT         900             /* WebCit session timeout */
-#define PORT_NUM               2000            /* port number to listen on */
+#define SLEEPING               180                     /* TCP connection timeout */
+#define WEBCIT_TIMEOUT         900                     /* WebCit session timeout */
+#define PORT_NUM               80                      /* port number to listen on */
 #define DEVELOPER_ID           0
 #define CLIENT_ID              4
-#define CLIENT_VERSION         917             /* This version of WebCit */
-#define MINIMUM_CIT_VERSION    917             /* Minimum required version of Citadel server */
-#define        LIBCITADEL_MIN          914             /* 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 */
-#define HOUSEKEEPING           15              /* Housekeeping frequency */
+#define CLIENT_VERSION 999             /* This version of WebCit */
+#define MINIMUM_CIT_VERSION    931                     /* Minimum required version of Citadel server */
+#define        LIBCITADEL_MIN          931                     /* Minimum required version of libcitadel */
+#define DEFAULT_CTDLDIR                "/usr/local/citadel"    /* Default Citadel server directory */
+#define TARGET                 "webcit01"              /* Window target for inline URL's */
+#define HOUSEKEEPING           15                      /* Housekeeping frequency */
 #define MAX_WORKER_THREADS     250
-#define LISTEN_QUEUE_LENGTH    100             /* listen() backlog queue */
+#define LISTEN_QUEUE_LENGTH    100                     /* listen() backlog queue */
 
 #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)
 
@@ -160,7 +146,7 @@ extern char *ssl_cipher_list;
 #define ERROR          500
 #define BINARY_FOLLOWS         600
 #define SEND_BINARY    700
-#define START_CHAT_MODE        800
+#define SEND_THEN_RECV 800
 #define ASYNC_MSG      900
 
 #define MINORCODE(a) (a % 100)
@@ -187,24 +173,16 @@ extern char *ssl_cipher_list;
 #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 do not (yet) have a user logged in.
- */
+// NLI is the string that shows up in a who's online listing for sessions that are active but do not (yet) have a user logged in.
 #define NLI    "(not logged in)"
 
-/*
- * Expiry policy for the autopurger
- */
-
+// Expiry policy for the autopurger
 typedef struct __ExpirePolicy {
         int expire_mode;
         int expire_value;
 } ExpirePolicy;
 
-/*
- * Linked list of session variables encoded in an x-www-urlencoded content type
- */
+// Linked list of session variables encoded in an x-www-urlencoded content type
 typedef struct urlcontent urlcontent;
 struct urlcontent {
        char url_key[32];               /* key */
@@ -213,9 +191,7 @@ struct urlcontent {
        HashList *sub;
 };
 
-/*
- * Information about the Citadel server to which we are connected
- */ 
+// Information about the Citadel server to which we are connected
 typedef struct _serv_info {
        int serv_pid;                   /* Process ID of the Citadel server */
        StrBuf *serv_nodename;          /* Node name of the Citadel server */
@@ -300,7 +276,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 {
@@ -308,13 +283,11 @@ typedef struct _headereval {
        int Type;
 } headereval;
 
-
 struct attach_link {
        char partnum[32];
        char html[1024];
 };
 
-
 enum {
        eUp,
        eDown,
@@ -340,8 +313,6 @@ extern const char *ReqStrs[eNONE];
 #define AUTH_COOKIE 1
 #define AUTH_BASIC 2
 
-
-
 typedef struct _HdrRefs {
        long eReqType;                          /* HTTP method */
        int desired_session;
@@ -393,11 +364,8 @@ 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.
- */
+// One of these is kept for each active Citadel session.
+// HTTP transactions are bound to one at a time.
 struct wcsession {
 /* infrastructural members */
        wcsession *next;                        /* Linked list */
@@ -473,15 +441,11 @@ struct wcsession {
        HashList *FloorsByName;                 /* same but hashed by its name */
        HashList *Rooms;                        /* our directory structure as loaded by LKRA */
        HashList *summ;                         /* list of messages for mailbox summary view */
-  /** 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. */
-
-
        char last_chat_user[256];
-
        StrBuf *IconTheme;                      /* Icontheme setting */
 
 /* Iconbar controls */
@@ -499,7 +463,7 @@ struct wcsession {
        StrBuf *ConvertBuf1;
        StrBuf *ConvertBuf2;
 
-/* cache stuff for templates. TODO: find a smarter way */
+/* cache stuff for templates. */
        HashList *ServCfg;                      /* cache our server config for editing */
        HashList *InetCfg;                      /* Our inet server config for editing */
        ExpirePolicy Policy[maxpolicy];
@@ -517,7 +481,6 @@ typedef struct _HttpHeader {
 
 void RegisterHeaderHandler(const char *Name, long Len, Header_Evaluator F);
 
-
 enum {
        S_SHUTDOWN,
        S_SPAWNER,
@@ -538,10 +501,6 @@ extern pthread_key_t MyConKey;
 #ifdef HAVE_OPENSSL
 #define THREADSSL ((SSL *)pthread_getspecific(ThreadSSL))
 extern pthread_key_t ThreadSSL;
-extern char ctdl_key_dir[PATH_MAX];
-extern char file_crpt_file_key[PATH_MAX];
-extern char file_crpt_file_csr[PATH_MAX];
-extern char file_crpt_file_cer[PATH_MAX];
 
 void init_ssl(void);
 void endtls(void);
@@ -554,12 +513,9 @@ int client_write_ssl(const StrBuf *Buf);
 extern int is_https;
 extern int follow_xff;
 extern char *server_cookie;
-extern char *ctdlhost, *ctdlport;
 extern char *axdefs[];
 extern int num_threads_existing;
 extern int num_threads_executing;
-extern int setup_wizard;
-extern char wizard_filename[];
 
 void InitialiseSemaphores(void);
 void begin_critical_section(int which_one);
@@ -577,99 +533,50 @@ 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_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_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 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);
@@ -680,52 +587,42 @@ void StrTabbedDialog(StrBuf *Target, int num_tabs, StrBuf *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(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);
 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);
-
+void display_enter(void);
 
 /* 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.
- */
+// 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
+#define WC_TIMEFORMAT_NONE     0
+#define WC_TIMEFORMAT_AMPM     1
+#define WC_TIMEFORMAT_24       2
 
 extern int time_to_die;                        /* Nonzero if server is shutting down */
 extern int DisableGzip;
 
 void display_summary_page(void);
-
 HashList *GetValidDomainNames(StrBuf *Target, WCTemplputParams *TP);
 void output_error_pic(const char *ErrMsg1, const char *ErrMsg2);
+void jsonMessageListHdr(void);
+extern char *ctdl_dir;                 /* Directory where Citadel Server is running */
 
+// ical_dezonify() references this, but it's also used in WebCit Classic so we abstract it
+#define default_zone_name      ChrPtr(WC->serv_info->serv_default_cal_zone)
 
+#include "webserver.h"