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