2 * Copyright (c) 1987-2015 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"
90 #include "tcp_sockets.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 2000 /* port number to listen on */
128 #define DEVELOPER_ID 0
130 #define CLIENT_VERSION 901 /* This version of WebCit */
131 #define MINIMUM_CIT_VERSION 901 /* Minimum required version of Citadel server */
132 #define LIBCITADEL_MIN 901 /* Minimum required version of libcitadel */
133 #define DEFAULT_HOST "localhost" /* Default Citadel server */
134 #define DEFAULT_PORT "504"
135 #define TARGET "webcit01" /* Window target for inline URL's */
136 #define HOUSEKEEPING 15 /* Housekeeping frequency */
137 #define MAX_WORKER_THREADS 250
138 #define LISTEN_QUEUE_LENGTH 100 /* listen() backlog queue */
140 #define USERCONFIGROOM "My Citadel Config"
141 #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.
153 #define SRV_STATUS_MSG(ServerLineBuf) (ChrPtr(ServerLineBuf) + 4), (StrLength(ServerLineBuf) - 4)
154 #define MAJORCODE(a) (((int)(a / 100) ) * 100)
156 #define LISTING_FOLLOWS 100
158 #define MORE_DATA 300
159 #define SEND_LISTING 400
161 #define BINARY_FOLLOWS 600
162 #define SEND_BINARY 700
163 #define START_CHAT_MODE 800
164 #define ASYNC_MSG 900
166 #define MINORCODE(a) (a % 100)
167 #define ASYNC_GEXP 02
168 #define INTERNAL_ERROR 10
170 #define ILLEGAL_VALUE 12
171 #define NOT_LOGGED_IN 20
172 #define CMD_NOT_SUPPORTED 30
173 #define SERVER_SHUTTING_DOWN 31
174 #define PASSWORD_REQUIRED 40
175 #define ALREADY_LOGGED_IN 41
176 #define USERNAME_REQUIRED 42
177 #define HIGHER_ACCESS_REQUIRED 50
178 #define MAX_SESSIONS_EXCEEDED 51
179 #define RESOURCE_BUSY 52
180 #define RESOURCE_NOT_OPEN 53
182 #define INVALID_FLOOR_OPERATION 61
183 #define NO_SUCH_USER 70
184 #define FILE_NOT_FOUND 71
185 #define ROOM_NOT_FOUND 72
186 #define NO_SUCH_SYSTEM 73
187 #define ALREADY_EXISTS 74
188 #define MESSAGE_NOT_FOUND 75
191 * NLI is the string that shows up in a who's online listing for sessions
192 * that are active but do not (yet) have a user logged in.
194 #define NLI "(not logged in)"
197 * Expiry policy for the autopurger
199 #define EXPIRE_NEXTLEVEL 0 /* Inherit expiration policy */
200 #define EXPIRE_MANUAL 1 /* Don't expire messages at all */
201 #define EXPIRE_NUMMSGS 2 /* Keep only latest n messages */
202 #define EXPIRE_AGE 3 /* Expire messages after n days */
204 typedef struct __ExpirePolicy {
208 void LoadExpirePolicy(GPEXWhichPolicy which);
209 void SaveExpirePolicyFromHTTP(GPEXWhichPolicy which);
212 * Linked list of session variables encoded in an x-www-urlencoded content type
214 typedef struct urlcontent urlcontent;
216 char url_key[32]; /* key */
218 StrBuf *url_data; /* value */
223 * Information about the Citadel server to which we are connected
225 typedef struct _serv_info {
226 int serv_pid; /* Process ID of the Citadel server */
227 StrBuf *serv_nodename; /* Node name of the Citadel server */
228 StrBuf *serv_humannode; /* Juman readable node name of the Citadel server */
229 StrBuf *serv_fqdn; /* Fully qualified Domain Name (such as uncensored.citadel.org) */
230 StrBuf *serv_software; /* Free form text description of the server software in use */
231 int serv_rev_level; /* Server version number (times 100) */
232 StrBuf *serv_bbs_city; /* Geographic location of the Citadel server */
233 StrBuf *serv_sysadm; /* Name of system administrator */
234 int serv_supports_ldap; /* is the server linked against an ldap tree for adresses? */
235 int serv_newuser_disabled; /* Has the server disabled self-service new user creation? */
236 StrBuf *serv_default_cal_zone; /* Default timezone for unspecified calendar items */
237 int serv_supports_sieve; /* Server supports Sieve mail filtering */
238 int serv_fulltext_enabled; /* Full text index is enabled */
239 StrBuf *serv_svn_revision; /* svn or git revision of the server */
240 int serv_supports_openid; /* Server supports authentication via OpenID */
241 int serv_supports_guest; /* Server supports unauthenticated guest logins */
245 typedef struct _disp_cal {
246 icalcomponent *cal; /* cal items for display */
247 long cal_msgnum; /* cal msgids for display */
248 char *from; /* owner of this component */
249 int unread; /* already seen by the user? */
256 icalcomponent *SortBy; /* cal items for display */
257 icalproperty_status Status;
260 typedef struct _IcalKindEnumMap {
263 icalproperty_kind map;
265 typedef struct _IcalMethodEnumMap {
268 icalproperty_method map;
273 #define ANONYMOUS (1<<1)
274 #define NEED_URL (1<<2)
275 #define XHTTP_COMMANDS (1<<3)
277 #define URLNAMESPACE (1<<4)
278 #define LOGCHATTY (1<<5)
279 #define COOKIEUNNEEDED (1<<6)
280 #define ISSTATIC (1<<7)
281 #define FORCE_SESSIONCLOSE (1<<8)
282 #define PARSE_REST_URL (1<<9)
283 #define PROHIBIT_STARTPAGE (1<<10)
286 #define DATEFMT_FULL 0
287 #define DATEFMT_BRIEF 1
288 #define DATEFMT_RAWDATE 2
289 #define DATEFMT_LOCALEDATE 3
290 long webcit_fmt_date(char *buf, size_t siz, time_t thetime, int Format);
293 typedef enum _RESTDispatchID {
299 typedef int (*WebcitRESTDispatchID)(RESTDispatchID WhichAction, int IgnoreFloor);
300 typedef void (*WebcitHandlerFunc)(void);
301 typedef struct _WebcitHandler{
303 WebcitRESTDispatchID RID;
310 void WebcitAddUrlHandler(const char * UrlString, long UrlSLen, const char *DisplayName, long dslen, WebcitHandlerFunc F, long Flags);
312 typedef struct _headereval {
313 ExamineMsgHeaderFunc evaluator;
343 extern const char *ReqStrs[eNONE];
346 #define AUTH_COOKIE 1
351 typedef struct _HdrRefs {
352 long eReqType; /* HTTP method */
359 time_t if_modified_since;
360 int gzip_ok; /* Nonzero if Accept-encoding: gzip */
361 int prohibit_caching;
365 /* these are references into Hdr->HTTPHeaders, so we don't need to free them. */
369 StrBuf *browser_host;
370 StrBuf *browser_language;
375 const WebcitHandler *Handler;
378 typedef struct _ParsedHttpHdrs {
379 int http_sock; /* HTTP server socket */
391 StrBuf *this_page; /* URL of current page */
395 HashList *urlstrings; /* variables passed to webcit in a URL */
396 HashList *HTTPHeaders; /* the headers the client sent us */
397 int nWildfireHeaders; /* how many wildfire headers did we already send? */
404 * One of these is kept for each active Citadel session.
405 * HTTP transactions are bound to one at a time.
408 /* infrastructural members */
409 wcsession *next; /* Linked list */
410 pthread_mutex_t SessionMutex; /* mutex for exclusive access */
411 int wc_session; /* WebCit session ID */
412 int killthis; /* Nonzero == purge this session */
413 int ctdl_pid; /* Session ID on the Citadel server */
414 int nonce; /* session nonce (to prevent session riding) */
415 int inuse; /* set to nonzero if bound to a running thread */
416 int isFailure; /* Http 2xx or 5xx? */
418 /* Session local Members */
419 int serv_sock; /* Client socket to Citadel server */
420 StrBuf *ReadBuf; /* linebuffered reads from the server */
421 StrBuf *MigrateReadLineBuf; /* here we buffer legacy server read stuff */
422 const char *ReadPos; /* whats our read position in ReadBuf? */
423 int last_chat_seq; /* When in chat - last message seq# we saw */
424 time_t lastreq; /* Timestamp of most recent HTTP */
425 time_t last_pager_check; /* last time we polled for instant msgs */
426 ServInfo *serv_info; /* Information about the citserver we're connected to */
427 StrBuf *PushedDestination; /* Where to go after login, registration, etc. */
429 /* Request local Members */
430 StrBuf *CLineBuf; /* linebuffering client stuff */
432 StrBuf *WBuf; /* Our output buffer */
433 StrBuf *HBuf; /* Our HeaderBuffer */
434 StrBuf *WFBuf; /* Wildfire error logging buffer */
435 StrBuf *trailing_javascript; /* extra javascript to be appended to page */
436 StrBuf *ImportantMsg;
437 HashList *Directory; /* Parts of the directory URL in snippets */
438 const Floor *CurrentFloor; /* when Parsing REST, which floor are we on? */
441 StrBuf *wc_username; /* login name of current user */
442 StrBuf *wc_fullname; /* Screen name of current user */
443 StrBuf *wc_password; /* Password of current user */
444 StrBuf *httpauth_pass; /* only for GroupDAV sessions */
445 int axlevel; /* this user's access level */
446 int is_aide; /* nonzero == this user is an Admin */
447 int connected; /* nonzero == we are connected to Citadel */
448 int logged_in; /* nonzero == we are logged in */
449 int need_regi; /* This user needs to register. */
450 int need_vali; /* New users require validation. */
453 StrBuf *cs_inet_email; /* User's preferred Internet addr. */
454 HashList *hash_prefs; /* WebCit preferences for this user */
455 StrBuf *DefaultCharset; /* Charset the user preferes */
456 int downloaded_prefs; /* Has the client download its prefs yet? */
457 int SavePrefsToServer; /* Should we save our preferences to the server at the end of the request? */
458 int selected_language; /* Language selected by user */
459 int time_format_cache; /* which timeformat does our user like? */
461 folder CurRoom; /* information about our current room */
462 const folder *ThisRoom; /* if REST found a room, remember it here. */
463 /* next/previous room thingabob */
464 struct march *march; /* march mode room list */
465 char ugname[128]; /* where does 'ungoto' take us */
466 long uglsn; /* last seen message number for ungoto */
468 /* Uploading; mime attachments for composing messages */
469 HashList *attachments; /* list of attachments for 'enter message' */
470 int upload_length; /* content length of http-uploaded data */
471 StrBuf *upload; /* pointer to http-uploaded data */
472 StrBuf *upload_filename; /* filename of http-uploaded data */
473 char upload_content_type[256]; /* content type of http-uploaded data */
475 int remember_new_mail; /* last count of new mail messages */
477 /* Roomiew control */
478 HashList *Floors; /* floors our citserver has hashed numeric for quicker access*/
479 HashList *FloorsByName; /* same but hashed by its name */
480 HashList *Rooms; /* our directory structure as loaded by LKRA */
481 HashList *summ; /* list of messages for mailbox summary view */
482 /** Perhaps these should be within a struct instead */
483 long startmsg; /* message number to start at */
484 long maxmsgs; /* maximum messages to display */
485 long num_displayed; /* number of messages actually displayed */
486 HashList *disp_cal_items; /* sorted list of calendar items; startdate is the sort criteria. */
489 char last_chat_user[256];
491 StrBuf *IconTheme; /* Icontheme setting */
493 /* Iconbar controls */
494 int cache_max_folders;
495 int cache_num_floors;
496 long *IBSettingsVec; /* which icons should be shown / not shown? */
497 const StrBuf *floordiv_expanded; /* which floordiv currently expanded */
498 int ib_wholist_expanded;
499 int ib_roomlist_expanded;
501 /* our known Sieve scripts; loaded by SIEVE:SCRIPTS iterator. */
502 HashList *KnownSieveScripts;
504 /* Transcoding cache buffers; used to avoid to frequent realloc */
508 /* cache stuff for templates. TODO: find a smarter way */
509 HashList *ServCfg; /* cache our server config for editing */
510 HashList *InetCfg; /* Our inet server config for editing */
511 ExpirePolicy Policy[maxpolicy];
513 /* used by the blog viewer */
514 int bptlid; /* hash of thread currently being rendered */
518 typedef void (*Header_Evaluator)(StrBuf *Line, ParsedHttpHdrs *hdr);
520 typedef struct _HttpHeader {
526 void RegisterHeaderHandler(const char *Name, long Len, Header_Evaluator F);
536 #define num_parms(source) num_tokens(source, '|')
539 #define site_prefix (WC ? (WC->Hdr->HostHeader) : NULL)
541 /* Per-session data */
542 #define WC ((struct wcsession *)pthread_getspecific(MyConKey))
543 extern pthread_key_t MyConKey;
545 /* Per-thread SSL context */
547 #define THREADSSL ((SSL *)pthread_getspecific(ThreadSSL))
548 extern pthread_key_t ThreadSSL;
549 extern char ctdl_key_dir[PATH_MAX];
550 extern char file_crpt_file_key[PATH_MAX];
551 extern char file_crpt_file_csr[PATH_MAX];
552 extern char file_crpt_file_cer[PATH_MAX];
556 void ssl_lock(int mode, int n, const char *file, int line);
557 int starttls(int sock);
558 extern SSL_CTX *ssl_ctx;
559 int client_read_sslbuffer(StrBuf *buf, int timeout);
560 int client_write_ssl(const StrBuf *Buf);
564 extern int follow_xff;
565 extern char *server_cookie;
566 extern char *ctdlhost, *ctdlport;
567 extern char *axdefs[];
568 extern int num_threads_existing;
569 extern int num_threads_executing;
570 extern int setup_wizard;
571 extern char wizard_filename[];
573 void InitialiseSemaphores(void);
574 void begin_critical_section(int which_one);
575 void end_critical_section(int which_one);
577 void CheckGZipCompressionAllowed(const char *MimeType, long MLen);
579 extern void do_404(void);
580 void http_redirect(const char *);
583 #ifdef UBER_VERBOSE_DEBUGGING
584 #define wc_printf(...) wcc_printf(__FILE__, __FUNCTION__, __LINE__, __VA_ARGS__)
585 void wcc_printf(const char *FILE, const char *FUNCTION, long LINE, const char *format, ...);
587 void wc_printf(const char *format,...)__attribute__((__format__(__printf__,1,2)));
590 void hprintf(const char *format,...)__attribute__((__format__(__printf__,1,2)));
592 void CheckAuthBasic(ParsedHttpHdrs *hdr);
593 void GetAuthBasic(ParsedHttpHdrs *hdr);
595 void sleeeeeeeeeep(int);
597 size_t wc_strftime(char *s, size_t max, const char *format, const struct tm *tm);
598 void fmt_time(char *buf, size_t siz, time_t thetime);
599 void httpdate(char *buf, time_t thetime);
600 time_t httpdate_to_timestamp(StrBuf *buf);
605 void end_webcit_session(void);
610 void cookie_to_stuff(StrBuf *cookie,
617 void locate_host(StrBuf *TBuf, int);
618 void become_logged_in(const StrBuf *user, const StrBuf *pass, StrBuf *serv_response);
620 void display_login(void);
621 void display_openids(void);
622 void display_default_landing_page(void);
623 void do_welcome(void);
625 void display_reg(int during_login);
626 void display_main_menu(void);
627 void display_aide_menu(void);
629 void RegisterEmbeddableMimeType(const char *MimeType, long MTLen, int Priority);
630 void CreateMimeStr(void);
633 void pop_destination(void);
635 void FmOut(StrBuf *Target, const char *align, const StrBuf *Source);
636 void wDumpContent(int);
639 void PutRequestLocalMem(void *Data, DeleteHashDataFunc DeleteIt);
641 void output_headers( int do_httpheaders,
647 void output_custom_content_header(const char *ctype);
648 void cdataout(char *rawdata);
651 void url(char *buf, size_t bufsize);
652 void UrlizeText(StrBuf* Target, StrBuf *Source, StrBuf *WrkBuf);
654 void display_success(const char *successmessage);
656 void shutdown_sessions(void);
660 StrBuf *load_mimepart(long msgnum, char *partnum);
661 void MimeLoadData(wc_mime_attachment *Mime);
662 void do_edit_vcard(long msgnum, char *partnum,
663 message_summary *VCMsg,
664 wc_mime_attachment *VCAtt,
665 const char *return_to,
666 const char *force_room);
668 void select_user_to_edit(const char *preselect);
670 void convenience_page(const char *titlebarcolor, const char *titlebarmsg, const char *messagetext);
671 void output_html(const char *, int, int, StrBuf *, StrBuf *);
673 ssize_t write(int fd, const void *buf, size_t count);
674 void cal_process_attachment(wc_mime_attachment *Mime);
676 void begin_ajax_response(void);
677 void end_ajax_response(void);
679 extern char *months[];
681 long locate_user_vcard_in_this_room(message_summary **VCMsg,
682 wc_mime_attachment **VCAtt);
683 void http_transmit_thing(const char *content_type, int is_static);
684 void http_transmit_headers(const char *content_type, int is_static, long is_chunked, int is_gzip);
685 long unescape_input(char *buf);
686 void check_thread_pool_size(void);
687 void StrEndTab(StrBuf *Target, int tabnum, int num_tabs);
688 void StrBeginTab(StrBuf *Target, int tabnum, int num_tabs, StrBuf **Names);
689 void StrTabbedDialog(StrBuf *Target, int num_tabs, StrBuf *tabnames[]);
690 void tabbed_dialog(int num_tabs, char *tabnames[]);
691 void begin_tab(int tabnum, int num_tabs);
692 void end_tab(int tabnum, int num_tabs);
694 int get_time_format_cached (void);
695 void display_wiki_pagelist(void);
696 void str_wiki_index(char *);
698 HashList *GetRoomListHashLKRA(StrBuf *Target, WCTemplputParams *TP);
700 /* actual supported locales */
701 void TmplGettext(StrBuf *Target, WCTemplputParams *TP);
703 void set_selected_language(const char *);
704 void go_selected_language(void);
705 void stop_selected_language(void);
706 const char *get_selected_language(void);
708 void utf8ify_rfc822_string(char **buf);
710 void begin_burst(void);
711 long end_burst(void);
713 void AppendImportantMessage(const char *pch, long len);
715 void http_datestring(char *buf, size_t n, time_t xtime);
718 /* These should be empty, but we have them for testing */
719 #define DEFAULT_HTTPAUTH_USER ""
720 #define DEFAULT_HTTPAUTH_PASS ""
723 /* Exit codes 101 through 109 are initialization failures so we don't want to
724 * just keep respawning indefinitely.
726 #define WC_EXIT_BIND 101 /* Can't bind to the port */
727 #define WC_EXIT_SSL 102 /* Can't initialize SSL */
730 #define WC_TIMEFORMAT_NONE 0
731 #define WC_TIMEFORMAT_AMPM 1
732 #define WC_TIMEFORMAT_24 2
734 extern int time_to_die; /* Nonzero if server is shutting down */
735 extern int DisableGzip;
738 * Array type for a blog post. The first message is the post; the rest are comments
742 long *msgs; /* Array of msgnums for messages we are displaying */
743 int num_msgs; /* Number of msgnums stored in 'msgs' */
744 int alloc_msgs; /* Currently allocated size of array */
750 * Data which gets returned from a call to blogview_learn_thread_references()
758 struct bltr blogview_learn_thread_references(long msgnum);
759 void tmplput_blog_permalink(StrBuf *Target, WCTemplputParams *TP);
760 void display_summary_page(void);
762 HashList *GetValidDomainNames(StrBuf *Target, WCTemplputParams *TP);