2 * Copyright (c) 1987-2021 by the citadel.org team
4 * This program is open source software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License version 3.
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
14 #include <sys/select.h>
25 #include <sys/types.h>
27 #include <sys/socket.h>
32 #include <sys/socket.h>
33 #include <netinet/in.h>
34 #include <arpa/inet.h>
45 #include <sys/utsname.h>
47 #include <libcitadel.h>
59 #define _(string) gettext(string)
61 #define _(string) (string)
65 #define DBG_QR(x) if(DO_DBG_QR) _DBG_QR(x)
66 #define DBG_QR2(x) if(DO_DBG_QR) _DBG_QR2(x)
70 #include <libical/ical.h>
76 #undef PACKAGE_TARNAME
77 #undef PACKAGE_VERSION
78 #undef PACKAGE_BUGREPORT
80 typedef struct wcsession wcsession;
86 #include "paramhandling.h"
88 #include "preferences.h"
93 /* Work around RedHat's b0rken OpenSSL includes */
94 #define OPENSSL_NO_KRB5
95 #include <openssl/ssl.h>
96 #include <openssl/err.h>
97 #include <openssl/rand.h>
98 extern char *ssl_cipher_list;
99 #define DEFAULT_SSL_CIPHER_LIST "DEFAULT" /* See http://openssl.org/docs/apps/ciphers.html */
102 #if SIZEOF_SIZE_T == SIZEOF_INT
103 #define SIZE_T_FMT "%d"
105 #define SIZE_T_FMT "%ld"
108 #if SIZEOF_LONG_UNSIGNED_INT == SIZEOF_INT
109 #define ULONG_FMT "%d"
111 #define ULONG_FMT "%ld"
114 #define CALENDAR_ROOM_NAME "Calendar"
115 #define PRODID "-//Citadel//NONSGML Citadel Calendar//EN"
117 #define SIZ 4096 /* generic buffer size */
119 #define TRACE syslog(LOG_DEBUG, "\033[3%dmCHECKPOINT: %s:%d\033[0m", ((__LINE__%6)+1), __FILE__, __LINE__)
125 #define SLEEPING 180 /* TCP connection timeout */
126 #define WEBCIT_TIMEOUT 900 /* WebCit session timeout */
127 #define PORT_NUM 80 /* port number to listen on */
128 #define DEVELOPER_ID 0
130 #define CLIENT_VERSION 965 /* This version of WebCit */
131 #define MINIMUM_CIT_VERSION 931 /* Minimum required version of Citadel server */
132 #define LIBCITADEL_MIN 931 /* Minimum required version of libcitadel */
133 #define DEFAULT_CTDLDIR "/usr/local/citadel" /* Default Citadel server directory */
134 #define TARGET "webcit01" /* Window target for inline URL's */
135 #define HOUSEKEEPING 15 /* Housekeeping frequency */
136 #define MAX_WORKER_THREADS 250
137 #define LISTEN_QUEUE_LENGTH 100 /* listen() backlog queue */
139 #define USERCONFIGROOM "My Citadel Config"
140 #define DEFAULT_MAXMSGS 20
142 #ifdef LIBCITADEL_VERSION_NUMBER
143 #if LIBCITADEL_VERSION_NUMBER < LIBCITADEL_MIN
144 #error libcitadel is too old. Please upgrade it before continuing.
148 #define SRV_STATUS_MSG(ServerLineBuf) (ChrPtr(ServerLineBuf) + 4), (StrLength(ServerLineBuf) - 4)
149 #define MAJORCODE(a) (((int)(a / 100) ) * 100)
151 #define LISTING_FOLLOWS 100
153 #define MORE_DATA 300
154 #define SEND_LISTING 400
156 #define BINARY_FOLLOWS 600
157 #define SEND_BINARY 700
158 #define START_CHAT_MODE 800
159 #define ASYNC_MSG 900
161 #define MINORCODE(a) (a % 100)
162 #define ASYNC_GEXP 02
163 #define INTERNAL_ERROR 10
165 #define ILLEGAL_VALUE 12
166 #define NOT_LOGGED_IN 20
167 #define CMD_NOT_SUPPORTED 30
168 #define SERVER_SHUTTING_DOWN 31
169 #define PASSWORD_REQUIRED 40
170 #define ALREADY_LOGGED_IN 41
171 #define USERNAME_REQUIRED 42
172 #define HIGHER_ACCESS_REQUIRED 50
173 #define MAX_SESSIONS_EXCEEDED 51
174 #define RESOURCE_BUSY 52
175 #define RESOURCE_NOT_OPEN 53
177 #define INVALID_FLOOR_OPERATION 61
178 #define NO_SUCH_USER 70
179 #define FILE_NOT_FOUND 71
180 #define ROOM_NOT_FOUND 72
181 #define NO_SUCH_SYSTEM 73
182 #define ALREADY_EXISTS 74
183 #define MESSAGE_NOT_FOUND 75
186 * NLI is the string that shows up in a who's online listing for sessions
187 * that are active but do not (yet) have a user logged in.
189 #define NLI "(not logged in)"
192 * Expiry policy for the autopurger
195 typedef struct __ExpirePolicy {
201 * Linked list of session variables encoded in an x-www-urlencoded content type
203 typedef struct urlcontent urlcontent;
205 char url_key[32]; /* key */
207 StrBuf *url_data; /* value */
212 * Information about the Citadel server to which we are connected
214 typedef struct _serv_info {
215 int serv_pid; /* Process ID of the Citadel server */
216 StrBuf *serv_nodename; /* Node name of the Citadel server */
217 StrBuf *serv_humannode; /* Juman readable node name of the Citadel server */
218 StrBuf *serv_fqdn; /* Fully qualified Domain Name (such as uncensored.citadel.org) */
219 StrBuf *serv_software; /* Free form text description of the server software in use */
220 int serv_rev_level; /* Server version number (times 100) */
221 StrBuf *serv_bbs_city; /* Geographic location of the Citadel server */
222 StrBuf *serv_sysadm; /* Name of system administrator */
223 int serv_supports_ldap; /* is the server linked against an ldap tree for adresses? */
224 int serv_newuser_disabled; /* Has the server disabled self-service new user creation? */
225 StrBuf *serv_default_cal_zone; /* Default timezone for unspecified calendar items */
226 int serv_supports_sieve; /* Server supports Sieve mail filtering */
227 int serv_fulltext_enabled; /* Full text index is enabled */
228 StrBuf *serv_svn_revision; /* svn or git revision of the server */
229 int serv_supports_openid; /* Server supports authentication via OpenID */
230 int serv_supports_guest; /* Server supports unauthenticated guest logins */
234 typedef struct _disp_cal {
235 icalcomponent *cal; /* cal items for display */
236 long cal_msgnum; /* cal msgids for display */
237 char *from; /* owner of this component */
238 int unread; /* already seen by the user? */
245 icalcomponent *SortBy; /* cal items for display */
246 icalproperty_status Status;
249 typedef struct _IcalKindEnumMap {
252 icalproperty_kind map;
254 typedef struct _IcalMethodEnumMap {
257 icalproperty_method map;
262 #define ANONYMOUS (1<<1)
263 #define NEED_URL (1<<2)
264 #define XHTTP_COMMANDS (1<<3)
266 #define URLNAMESPACE (1<<4)
267 #define LOGCHATTY (1<<5)
268 #define COOKIEUNNEEDED (1<<6)
269 #define ISSTATIC (1<<7)
270 #define FORCE_SESSIONCLOSE (1<<8)
271 #define PARSE_REST_URL (1<<9)
272 #define PROHIBIT_STARTPAGE (1<<10)
275 #define DATEFMT_FULL 0
276 #define DATEFMT_BRIEF 1
277 #define DATEFMT_RAWDATE 2
278 #define DATEFMT_LOCALEDATE 3
279 long webcit_fmt_date(char *buf, size_t siz, time_t thetime, int Format);
282 typedef enum _RESTDispatchID {
288 typedef int (*WebcitRESTDispatchID)(RESTDispatchID WhichAction, int IgnoreFloor);
289 typedef void (*WebcitHandlerFunc)(void);
290 typedef struct _WebcitHandler{
292 WebcitRESTDispatchID RID;
298 void WebcitAddUrlHandler(const char * UrlString, long UrlSLen, const char *DisplayName, long dslen, WebcitHandlerFunc F, long Flags);
300 typedef struct _headereval {
301 ExamineMsgHeaderFunc evaluator;
329 extern const char *ReqStrs[eNONE];
332 #define AUTH_COOKIE 1
335 typedef struct _HdrRefs {
336 long eReqType; /* HTTP method */
343 time_t if_modified_since;
344 int gzip_ok; /* Nonzero if Accept-encoding: gzip */
345 int prohibit_caching;
349 /* these are references into Hdr->HTTPHeaders, so we don't need to free them. */
353 StrBuf *browser_host;
354 StrBuf *browser_language;
359 const WebcitHandler *Handler;
362 typedef struct _ParsedHttpHdrs {
363 int http_sock; /* HTTP server socket */
375 StrBuf *this_page; /* URL of current page */
379 HashList *urlstrings; /* variables passed to webcit in a URL */
380 HashList *HTTPHeaders; /* the headers the client sent us */
381 int nWildfireHeaders; /* how many wildfire headers did we already send? */
387 * One of these is kept for each active Citadel session.
388 * HTTP transactions are bound to one at a time.
391 /* infrastructural members */
392 wcsession *next; /* Linked list */
393 pthread_mutex_t SessionMutex; /* mutex for exclusive access */
394 int wc_session; /* WebCit session ID */
395 int killthis; /* Nonzero == purge this session */
396 int ctdl_pid; /* Session ID on the Citadel server */
397 int nonce; /* session nonce (to prevent session riding) */
398 int inuse; /* set to nonzero if bound to a running thread */
399 int isFailure; /* Http 2xx or 5xx? */
401 /* Session local Members */
402 int serv_sock; /* Client socket to Citadel server */
403 StrBuf *ReadBuf; /* linebuffered reads from the server */
404 StrBuf *MigrateReadLineBuf; /* here we buffer legacy server read stuff */
405 const char *ReadPos; /* whats our read position in ReadBuf? */
406 int last_chat_seq; /* When in chat - last message seq# we saw */
407 time_t lastreq; /* Timestamp of most recent HTTP */
408 time_t last_pager_check; /* last time we polled for instant msgs */
409 ServInfo *serv_info; /* Information about the citserver we're connected to */
410 StrBuf *PushedDestination; /* Where to go after login, registration, etc. */
412 /* Request local Members */
413 StrBuf *CLineBuf; /* linebuffering client stuff */
415 StrBuf *WBuf; /* Our output buffer */
416 StrBuf *HBuf; /* Our HeaderBuffer */
417 StrBuf *WFBuf; /* Wildfire error logging buffer */
418 StrBuf *trailing_javascript; /* extra javascript to be appended to page */
419 StrBuf *ImportantMsg;
420 HashList *Directory; /* Parts of the directory URL in snippets */
421 const Floor *CurrentFloor; /* when Parsing REST, which floor are we on? */
424 StrBuf *wc_username; /* login name of current user */
425 StrBuf *wc_fullname; /* Screen name of current user */
426 StrBuf *wc_password; /* Password of current user */
427 StrBuf *httpauth_pass; /* only for GroupDAV sessions */
428 int axlevel; /* this user's access level */
429 int is_aide; /* nonzero == this user is an Admin */
430 int connected; /* nonzero == we are connected to Citadel */
431 int logged_in; /* nonzero == we are logged in */
432 int need_regi; /* This user needs to register. */
433 int need_vali; /* New users require validation. */
436 StrBuf *cs_inet_email; /* User's preferred Internet addr. */
437 HashList *hash_prefs; /* WebCit preferences for this user */
438 StrBuf *DefaultCharset; /* Charset the user preferes */
439 int downloaded_prefs; /* Has the client download its prefs yet? */
440 int SavePrefsToServer; /* Should we save our preferences to the server at the end of the request? */
441 int selected_language; /* Language selected by user */
442 int time_format_cache; /* which timeformat does our user like? */
444 folder CurRoom; /* information about our current room */
445 const folder *ThisRoom; /* if REST found a room, remember it here. */
446 /* next/previous room thingabob */
447 struct march *march; /* march mode room list */
448 char ugname[128]; /* where does 'ungoto' take us */
449 long uglsn; /* last seen message number for ungoto */
451 /* Uploading; mime attachments for composing messages */
452 HashList *attachments; /* list of attachments for 'enter message' */
453 int upload_length; /* content length of http-uploaded data */
454 StrBuf *upload; /* pointer to http-uploaded data */
455 StrBuf *upload_filename; /* filename of http-uploaded data */
456 char upload_content_type[256]; /* content type of http-uploaded data */
458 int remember_new_mail; /* last count of new mail messages */
460 /* Roomiew control */
461 HashList *Floors; /* floors our citserver has hashed numeric for quicker access*/
462 HashList *FloorsByName; /* same but hashed by its name */
463 HashList *Rooms; /* our directory structure as loaded by LKRA */
464 HashList *summ; /* list of messages for mailbox summary view */
465 /** Perhaps these should be within a struct instead */
466 long startmsg; /* message number to start at */
467 long maxmsgs; /* maximum messages to display */
468 long num_displayed; /* number of messages actually displayed */
469 HashList *disp_cal_items; /* sorted list of calendar items; startdate is the sort criteria. */
472 char last_chat_user[256];
474 StrBuf *IconTheme; /* Icontheme setting */
476 /* Iconbar controls */
477 int cache_max_folders;
478 int cache_num_floors;
479 long *IBSettingsVec; /* which icons should be shown / not shown? */
480 const StrBuf *floordiv_expanded; /* which floordiv currently expanded */
481 int ib_wholist_expanded;
482 int ib_roomlist_expanded;
484 /* our known Sieve scripts; loaded by SIEVE:SCRIPTS iterator. */
485 HashList *KnownSieveScripts;
487 /* Transcoding cache buffers; used to avoid to frequent realloc */
491 /* cache stuff for templates. TODO: find a smarter way */
492 HashList *ServCfg; /* cache our server config for editing */
493 HashList *InetCfg; /* Our inet server config for editing */
494 ExpirePolicy Policy[maxpolicy];
499 typedef void (*Header_Evaluator)(StrBuf *Line, ParsedHttpHdrs *hdr);
501 typedef struct _HttpHeader {
507 void RegisterHeaderHandler(const char *Name, long Len, Header_Evaluator F);
517 #define num_parms(source) num_tokens(source, '|')
520 #define site_prefix (WC ? (WC->Hdr->HostHeader) : NULL)
522 /* Per-session data */
523 #define WC ((struct wcsession *)pthread_getspecific(MyConKey))
524 extern pthread_key_t MyConKey;
526 /* Per-thread SSL context */
528 #define THREADSSL ((SSL *)pthread_getspecific(ThreadSSL))
529 extern pthread_key_t ThreadSSL;
533 int starttls(int sock);
534 extern SSL_CTX *ssl_ctx;
535 int client_read_sslbuffer(StrBuf *buf, int timeout);
536 int client_write_ssl(const StrBuf *Buf);
540 extern int follow_xff;
541 extern char *server_cookie;
542 extern char *axdefs[];
543 extern int num_threads_existing;
544 extern int num_threads_executing;
546 void InitialiseSemaphores(void);
547 void begin_critical_section(int which_one);
548 void end_critical_section(int which_one);
550 void CheckGZipCompressionAllowed(const char *MimeType, long MLen);
552 extern void do_404(void);
553 void http_redirect(const char *);
556 #ifdef UBER_VERBOSE_DEBUGGING
557 #define wc_printf(...) wcc_printf(__FILE__, __FUNCTION__, __LINE__, __VA_ARGS__)
558 void wcc_printf(const char *FILE, const char *FUNCTION, long LINE, const char *format, ...);
560 void wc_printf(const char *format,...)__attribute__((__format__(__printf__,1,2)));
562 void hprintf(const char *format,...)__attribute__((__format__(__printf__,1,2)));
563 void CheckAuthBasic(ParsedHttpHdrs *hdr);
564 void GetAuthBasic(ParsedHttpHdrs *hdr);
565 void sleeeeeeeeeep(int);
566 size_t wc_strftime(char *s, size_t max, const char *format, const struct tm *tm);
567 void fmt_time(char *buf, size_t siz, time_t thetime);
568 void httpdate(char *buf, time_t thetime);
569 time_t httpdate_to_timestamp(StrBuf *buf);
570 void end_webcit_session(void);
571 void cookie_to_stuff(StrBuf *cookie, int *session, StrBuf *user, StrBuf *pass, StrBuf *room, StrBuf *language);
572 void locate_host(StrBuf *TBuf, int);
573 void become_logged_in(const StrBuf *user, const StrBuf *pass, StrBuf *serv_response);
574 void display_login(void);
575 void display_openids(void);
576 void display_default_landing_page(void);
577 void do_welcome(void);
578 void display_reg(int during_login);
579 void display_main_menu(void);
580 void display_aide_menu(void);
581 void RegisterEmbeddableMimeType(const char *MimeType, long MTLen, int Priority);
582 void CreateMimeStr(void);
583 void pop_destination(void);
584 void FmOut(StrBuf *Target, const char *align, const StrBuf *Source);
585 void wDumpContent(int);
586 void PutRequestLocalMem(void *Data, DeleteHashDataFunc DeleteIt);
587 void output_headers(int do_httpheaders, int do_htmlhead, int do_room_banner, int unset_cookies, int suppress_check, int cache);
588 void cdataout(char *rawdata);
589 void url(char *buf, size_t bufsize);
590 void UrlizeText(StrBuf* Target, StrBuf *Source, StrBuf *WrkBuf);
591 void display_success(const char *successmessage);
592 void shutdown_sessions(void);
593 StrBuf *load_mimepart(long msgnum, char *partnum);
594 void MimeLoadData(wc_mime_attachment *Mime);
595 void do_edit_vcard(long msgnum, char *partnum, message_summary *VCMsg, wc_mime_attachment *VCAtt, const char *return_to, const char *force_room);
596 void select_user_to_edit(const char *preselect);
597 void convenience_page(const char *titlebarcolor, const char *titlebarmsg, const char *messagetext);
598 void output_html(const char *, int, int, StrBuf *, StrBuf *);
599 ssize_t write(int fd, const void *buf, size_t count);
600 void cal_process_attachment(wc_mime_attachment *Mime);
601 void begin_ajax_response(void);
602 void end_ajax_response(void);
603 extern char *months[];
605 long locate_user_vcard_in_this_room(message_summary **VCMsg, wc_mime_attachment **VCAtt);
606 void http_transmit_thing(const char *content_type, int is_static);
607 void http_transmit_headers(const char *content_type, int is_static, long is_chunked, int is_gzip);
608 long unescape_input(char *buf);
609 void check_thread_pool_size(void);
610 void StrEndTab(StrBuf *Target, int tabnum, int num_tabs);
611 void StrBeginTab(StrBuf *Target, int tabnum, int num_tabs, StrBuf **Names);
612 void StrTabbedDialog(StrBuf *Target, int num_tabs, StrBuf *tabnames[]);
613 void tabbed_dialog(int num_tabs, const char *tabnames[]);
614 void begin_tab(int tabnum, int num_tabs);
615 void end_tab(int tabnum, int num_tabs);
616 int get_time_format_cached (void);
617 void display_wiki_pagelist(void);
618 void str_wiki_index(StrBuf *);
619 HashList *GetRoomListHashLKRA(StrBuf *Target, WCTemplputParams *TP);
620 void TmplGettext(StrBuf *Target, WCTemplputParams *TP); /* actual supported locales */
621 void set_selected_language(const char *);
622 void go_selected_language(void);
623 const char *get_selected_language(void);
624 // void utf8ify_rfc822_string(char **buf); this is in libcitadel now
625 void begin_burst(void);
626 long end_burst(void);
627 void AppendImportantMessage(const char *pch, long len);
628 void http_datestring(char *buf, size_t n, time_t xtime);
629 void display_enter(void);
631 /* These should be empty, but we have them for testing */
632 #define DEFAULT_HTTPAUTH_USER ""
633 #define DEFAULT_HTTPAUTH_PASS ""
635 /* Exit codes 101 through 109 are initialization failures so we don't want to
636 * just keep respawning indefinitely.
638 #define WC_EXIT_BIND 101 /* Can't bind to the port */
639 #define WC_EXIT_SSL 102 /* Can't initialize SSL */
641 #define WC_TIMEFORMAT_NONE 0
642 #define WC_TIMEFORMAT_AMPM 1
643 #define WC_TIMEFORMAT_24 2
645 extern int time_to_die; /* Nonzero if server is shutting down */
646 extern int DisableGzip;
648 void display_summary_page(void);
649 HashList *GetValidDomainNames(StrBuf *Target, WCTemplputParams *TP);
650 void output_error_pic(const char *ErrMsg1, const char *ErrMsg2);
651 void jsonMessageListHdr(void);
652 extern char *ctdl_dir; /* Directory where Citadel Server is running */