5 * \defgroup Webserver This contains a simple multithreaded TCP server manager. It sits around
6 * waiting on the specified port for incoming HTTP connections. When a
7 * connection is established, it calls context_loop() from context_loop.c.
8 * \ingroup WebcitHttpServer
13 #include "webserver.h"
20 int vsnprintf(char *buf, size_t max, const char *fmt, va_list argp);
23 int verbosity = 9; /**< Logging level */
24 int msock; /**< master listening socket */
25 int is_https = 0; /**< Nonzero if I am an HTTPS service */
26 int follow_xff = 0; /**< Follow X-Forwarded-For: header */
27 int home_specified = 0; /**< did the user specify a homedir? */
28 extern void *context_loop(int);
29 extern void *housekeeping_loop(void);
30 extern pthread_mutex_t SessionListMutex;
31 extern pthread_key_t MyConKey;
33 char socket_dir[PATH_MAX]; /**< where to talk to our citadel server */
34 static const char editor_absolut_dir[PATH_MAX]=EDITORDIR; /**< nailed to what configure gives us. */
35 static char static_dir[PATH_MAX]; /**< calculated on startup */
36 char *static_dirs[]={ /**< needs same sort order as the web mapping */
37 (char*)static_dir, /** our templates on disk */
38 (char*)editor_absolut_dir /** the editor on disk */
40 int ndirs=2; //sizeof(static_content_dirs);//sizeof(char *);
43 * Subdirectories from which the client may request static content
45 char *static_content_dirs[] = {
46 "static", /** static templates */
47 "tiny_mce" /** the JS editor */
52 char *server_cookie = NULL; /**< our Cookie connection to the client */
54 int http_port = PORT_NUM; /**< Port to listen on */
56 char *ctdlhost = DEFAULT_HOST; /**< our name */
57 char *ctdlport = DEFAULT_PORT; /**< our Port */
58 int setup_wizard = 0; /**< should we run the setup wizard? \todo */
59 char wizard_filename[PATH_MAX];/**< where's the setup wizard? */
60 int running_as_daemon = 0; /**< should we deamonize on startup? */
64 * \brief This is a generic function to set up a master socket for listening on
65 * a TCP port. The server shuts down if the bind fails.
66 * \param ip_addr ip to bind to
67 * \param port_number the port to bind to
68 * \param queue_len the size of the input queue ????
70 int ig_tcp_server(char *ip_addr, int port_number, int queue_len)
72 struct sockaddr_in sin;
75 memset(&sin, 0, sizeof(sin));
76 sin.sin_family = AF_INET;
77 if (ip_addr == NULL) {
78 sin.sin_addr.s_addr = INADDR_ANY;
80 sin.sin_addr.s_addr = inet_addr(ip_addr);
83 if (sin.sin_addr.s_addr == INADDR_NONE) {
84 sin.sin_addr.s_addr = INADDR_ANY;
87 if (port_number == 0) {
88 lprintf(1, "Cannot start: no port number specified.\n");
91 sin.sin_port = htons((u_short) port_number);
93 s = socket(PF_INET, SOCK_STREAM, (getprotobyname("tcp")->p_proto));
95 lprintf(1, "Can't create a socket: %s\n", strerror(errno));
98 /** Set some socket options that make sense. */
100 setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
102 if (bind(s, (struct sockaddr *) &sin, sizeof(sin)) < 0) {
103 lprintf(1, "Can't bind: %s\n", strerror(errno));
106 if (listen(s, queue_len) < 0) {
107 lprintf(1, "Can't listen: %s\n", strerror(errno));
116 * \brief Create a Unix domain socket and listen on it
117 * \param sockpath file name of the unix domain socket
118 * \param queue_len queue size of the kernel fifo????
120 int ig_uds_server(char *sockpath, int queue_len)
122 struct sockaddr_un addr;
125 int actual_queue_len;
127 actual_queue_len = queue_len;
128 if (actual_queue_len < 5) actual_queue_len = 5;
130 i = unlink(sockpath);
131 if (i != 0) if (errno != ENOENT) {
132 lprintf(1, "citserver: can't unlink %s: %s\n",
133 sockpath, strerror(errno));
137 memset(&addr, 0, sizeof(addr));
138 addr.sun_family = AF_UNIX;
139 safestrncpy(addr.sun_path, sockpath, sizeof addr.sun_path);
141 s = socket(AF_UNIX, SOCK_STREAM, 0);
143 lprintf(1, "citserver: Can't create a socket: %s\n",
148 if (bind(s, (struct sockaddr *)&addr, sizeof(addr)) < 0) {
149 lprintf(1, "citserver: Can't bind: %s\n",
154 if (listen(s, actual_queue_len) < 0) {
155 lprintf(1, "citserver: Can't listen: %s\n",
160 chmod(sockpath, 0777);
168 * \brief Read data from the client socket.
169 * \param sock socket fd to read from ???
170 * \param buf buffer to read into
171 * \param bytes how large is the read buffer?
172 * \param timeout how long should we wait for input?
173 * \return values are\
174 * 1 Requested number of bytes has been read.\
175 * 0 Request timed out.\
176 * -1 Connection is broken, or other error.
178 int client_read_to(int sock, char *buf, int bytes, int timeout)
188 return (client_read_ssl(buf, bytes, timeout));
193 while (len < bytes) {
199 retval = select((sock) + 1, &rfds, NULL, NULL, &tv);
200 if (FD_ISSET(sock, &rfds) == 0) {
204 rlen = read(sock, &buf[len], bytes - len);
207 lprintf(2, "client_read() failed: %s\n",
215 write(2, "\033[32m", 5);
216 write(2, buf, bytes);
217 write(2, "\033[30m", 5);
223 * \brief write data to the client
224 * \param buf data to write to the client
225 * \param count size of buffer
227 ssize_t client_write(const void *buf, size_t count)
232 if (WC->burst != NULL) {
233 if ((WC->burst_len + count) >= WC->burst_alloc) {
234 newalloc = (WC->burst_alloc * 2);
235 if ((WC->burst_len + count) >= newalloc) {
238 newptr = realloc(WC->burst, newalloc);
239 if (newptr != NULL) {
241 WC->burst_alloc = newalloc;
244 if ((WC->burst_len + count) < WC->burst_alloc) {
245 memcpy(&WC->burst[WC->burst_len], buf, count);
246 WC->burst_len += count;
255 client_write_ssl((char *) buf, count);
260 write(2, "\033[34m", 5);
261 write(2, buf, count);
262 write(2, "\033[30m", 5);
264 return (write(WC->http_sock, buf, count));
268 * \brief what burst???
270 void begin_burst(void)
272 if (WC->burst != NULL) {
277 WC->burst_alloc = 32768;
278 WC->burst = malloc(WC->burst_alloc);
283 * \brief uses the same calling syntax as compress2(), but it
284 * creates a stream compatible with HTTP "Content-encoding: gzip"
287 #define DEF_MEM_LEVEL 8 /**< memlevel??? */
288 #define OS_CODE 0x03 /**< unix */
289 int ZEXPORT compress_gzip(Bytef * dest, /**< compressed buffer*/
290 uLongf * destLen, /**< length of the compresed data */
291 const Bytef * source, /**< source to encode */
292 uLong sourceLen, /**< length of the source to encode */
293 int level) /**< what level??? */
295 const int gz_magic[2] = { 0x1f, 0x8b }; /** gzip magic header */
297 /** write gzip header */
298 sprintf((char *) dest, "%c%c%c%c%c%c%c%c%c%c",
299 gz_magic[0], gz_magic[1], Z_DEFLATED,
300 0 /*flags */ , 0, 0, 0, 0 /*time */ , 0 /** xflags */ ,
306 stream.next_in = (Bytef *) source;
307 stream.avail_in = (uInt) sourceLen;
308 stream.next_out = dest + 10L; // after header
309 stream.avail_out = (uInt) * destLen;
310 if ((uLong) stream.avail_out != *destLen)
313 stream.zalloc = (alloc_func) 0;
314 stream.zfree = (free_func) 0;
315 stream.opaque = (voidpf) 0;
317 err = deflateInit2(&stream, level, Z_DEFLATED, -MAX_WBITS,
318 DEF_MEM_LEVEL, Z_DEFAULT_STRATEGY);
322 err = deflate(&stream, Z_FINISH);
323 if (err != Z_STREAM_END) {
325 return err == Z_OK ? Z_BUF_ERROR : err;
327 *destLen = stream.total_out + 10L;
329 /* write CRC and Length */
330 uLong crc = crc32(0L, source, sourceLen);
332 for (n = 0; n < 4; ++n, ++*destLen) {
333 dest[*destLen] = (int) (crc & 0xff);
336 uLong len = stream.total_in;
337 for (n = 0; n < 4; ++n, ++*destLen) {
338 dest[*destLen] = (int) (len & 0xff);
341 err = deflateEnd(&stream);
347 * \brief what burst???
354 if (WC->burst == NULL)
357 the_len = WC->burst_len;
358 the_data = WC->burst;
365 /* Handle gzip compression */
367 char *compressed_data = NULL;
368 uLongf compressed_len;
370 compressed_len = (uLongf) ((the_len * 101) / 100) + 100;
371 compressed_data = malloc(compressed_len);
373 if (compress_gzip((Bytef *) compressed_data,
376 (uLongf) the_len, Z_BEST_SPEED) == Z_OK) {
377 wprintf("Content-encoding: gzip\r\n");
379 the_data = compressed_data;
380 the_len = compressed_len;
382 free(compressed_data);
385 #endif /* HAVE_ZLIB */
387 wprintf("Content-length: %d\r\n\r\n", the_len);
388 client_write(the_data, the_len);
396 * \brief Read data from the client socket with default timeout.
397 * (This is implemented in terms of client_read_to() and could be
398 * justifiably moved out of sysdep.c)
399 * \param sock the socket fd to read from???
400 * \param buf the buffer to write to
401 * \param bytes how large is the buffer
403 int client_read(int sock, char *buf, int bytes)
405 return (client_read_to(sock, buf, bytes, SLEEPING));
410 * \brief Get a LF-terminated line of text from the client.
411 * (This is implemented in terms of client_read() and could be
412 * justifiably moved out of sysdep.c)
413 * \param sock socket fd to get client line from???
414 * \param buf buffer to write read data to
415 * \param bufsiz how many bytes to read
416 * \return numer of bytes read???
418 int client_getln(int sock, char *buf, int bufsiz)
422 /** Read one character at a time.*/
424 retval = client_read(sock, &buf[i], 1);
425 if (retval != 1 || buf[i] == '\n' || i == (bufsiz-1))
427 if ( (!isspace(buf[i])) && (!isprint(buf[i])) ) {
428 /** Non printable character recieved from client */
433 /** If we got a long line, discard characters until the newline. */
435 while (buf[i] != '\n' && retval == 1)
436 retval = client_read(sock, &buf[i], 1);
439 * Strip any trailing non-printable characters.
442 while ((strlen(buf) > 0) && (!isprint(buf[strlen(buf) - 1]))) {
443 buf[strlen(buf) - 1] = 0;
449 * \brief shut us down the regular way.
450 * param signum the signal we want to forward
453 void graceful_shutdown(int signum) {
454 kill(current_child, signum);
460 * \brief Start running as a daemon.
462 * param do_close_stdio Only close stdio if set.
466 * Start running as a daemon.
468 void start_daemon(char *pid_file)
477 /* Close stdin/stdout/stderr and replace them with /dev/null.
478 * We don't just call close() because we don't want these fd's
479 * to be reused for other files.
486 fp = fopen(pid_file, "w");
488 fprintf(fp, "%d\n", child);
495 signal(SIGHUP, SIG_IGN);
496 signal(SIGINT, SIG_IGN);
497 signal(SIGQUIT, SIG_IGN);
501 freopen("/dev/null", "r", stdin);
502 freopen("/dev/null", "w", stdout);
503 freopen("/dev/null", "w", stderr);
506 current_child = fork();
509 if (current_child < 0) {
514 else if (current_child == 0) {
515 signal(SIGTERM, graceful_shutdown);
516 return; /* continue starting citadel. */
520 signal(SIGTERM, SIG_IGN);
521 waitpid(current_child, &status, 0);
526 /* Did the main process exit with an actual exit code? */
527 if (WIFEXITED(status)) {
529 /* Exit code 0 means the watcher should exit */
530 if (WEXITSTATUS(status) == 0) {
534 /* Exit code 101-109 means the watcher should exit */
535 else if ( (WEXITSTATUS(status) >= 101) && (WEXITSTATUS(status) <= 109) ) {
539 /* Any other exit code means we should restart. */
545 /* Any other type of termination (signals, etc.) should also restart. */
550 } while (do_restart);
555 exit(WEXITSTATUS(status));
559 * \brief Spawn an additional worker thread into the pool.
561 void spawn_another_worker_thread()
563 pthread_t SessThread; /**< Thread descriptor */
564 pthread_attr_t attr; /**< Thread attributes */
567 lprintf(3, "Creating a new thread\n");
569 /** set attributes for the new thread */
570 pthread_attr_init(&attr);
571 pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
574 * Our per-thread stacks need to be bigger than the default size, otherwise
575 * the MIME parser crashes on FreeBSD, and the IMAP service crashes on
578 if ((ret = pthread_attr_setstacksize(&attr, 1024 * 1024))) {
579 lprintf(1, "pthread_attr_setstacksize: %s\n",
581 pthread_attr_destroy(&attr);
584 /** now create the thread */
585 if (pthread_create(&SessThread, &attr,
586 (void *(*)(void *)) worker_entry, NULL)
588 lprintf(1, "Can't create thread: %s\n", strerror(errno));
591 /** free up the attributes */
592 pthread_attr_destroy(&attr);
596 * \brief Here's where it all begins.
597 * \param argc number of commandline args
598 * \param argv the commandline arguments
600 int main(int argc, char **argv)
602 pthread_t SessThread; /**< Thread descriptor */
603 pthread_attr_t attr; /**< Thread attributes */
604 int a, i; /**< General-purpose variables */
605 char tracefile[PATH_MAX];
607 char dirbuffer[PATH_MAX]="";
610 int home_specified=0;
611 char relhome[PATH_MAX]="";
612 char webcitdir[PATH_MAX] = DATADIR;
613 char *pidfile = NULL;
619 #endif /* ENABLE_NLS */
620 char uds_listen_path[PATH_MAX]; /**< listen on a unix domain socket? */
622 strcpy(uds_listen_path, "");
624 /** Parse command line */
626 while ((a = getopt(argc, argv, "h:i:p:t:x:dD:cfs")) != EOF)
628 while ((a = getopt(argc, argv, "h:i:p:t:x:dD:cf")) != EOF)
632 hdir = strdup(optarg);
634 if (!relh) safestrncpy(webcitdir, hdir,
637 safestrncpy(relhome, relhome,
639 /* free(hdir); TODO: SHOULD WE DO THIS? */
644 running_as_daemon = 1;
647 pidfile = strdup(optarg);
648 running_as_daemon = 1;
651 safestrncpy(ip_addr, optarg, sizeof ip_addr);
654 http_port = atoi(optarg);
655 if (http_port == 0) {
656 safestrncpy(uds_listen_path, optarg, sizeof uds_listen_path);
660 safestrncpy(tracefile, optarg, sizeof tracefile);
661 freopen(tracefile, "w", stdout);
662 freopen(tracefile, "w", stderr);
663 freopen(tracefile, "r", stdin);
666 verbosity = atoi(optarg);
672 server_cookie = malloc(256);
673 if (server_cookie != NULL) {
674 safestrncpy(server_cookie,
675 "Set-cookie: wcserver=",
678 (&server_cookie[strlen(server_cookie)],
680 lprintf(2, "gethostname: %s\n",
690 fprintf(stderr, "usage: webserver "
691 "[-i ip_addr] [-p http_port] "
692 "[-t tracefile] [-c] [-f] "
697 "[remotehost [remoteport]]\n");
702 ctdlhost = argv[optind];
704 ctdlport = argv[optind];
707 /* daemonize, if we were asked to */
708 if (running_as_daemon) {
709 start_daemon(pidfile);
712 /** Tell 'em who's in da house */
713 lprintf(1, SERVER "\n");
714 lprintf(1, "Copyright (C) 1996-2006 by the Citadel development team.\n"
715 "This software is distributed under the terms of the "
716 "GNU General Public License.\n\n"
720 /** initialize the International Bright Young Thing */
722 initialize_locales();
723 locale = setlocale(LC_ALL, "");
724 mo = malloc(strlen(webcitdir) + 20);
725 lprintf(9, "Message catalog directory: %s\n", bindtextdomain("webcit", LOCALEDIR));
727 lprintf(9, "Text domain: %s\n", textdomain("webcit"));
728 lprintf(9, "Text domain Charset: %s\n", bind_textdomain_codeset("webcit","UTF8"));
732 /* calculate all our path on a central place */
733 /* where to keep our config */
735 #define COMPUTE_DIRECTORY(SUBDIR) memcpy(dirbuffer,SUBDIR, sizeof dirbuffer);\
736 snprintf(SUBDIR,sizeof SUBDIR, "%s%s%s%s%s%s%s", \
737 (home&!relh)?webcitdir:basedir, \
738 ((basedir!=webcitdir)&(home&!relh))?basedir:"/", \
739 ((basedir!=webcitdir)&(home&!relh))?"/":"", \
741 (relhome[0]!='\0')?"/":"",\
743 (dirbuffer[0]!='\0')?"/":"");
745 COMPUTE_DIRECTORY(socket_dir);
747 COMPUTE_DIRECTORY(static_dir);
748 /** we should go somewhere we can leave our coredump, if enabled... */
749 lprintf(9, "Changing directory to %s\n", socket_dir);
750 if (chdir(webcitdir) != 0) {
753 initialize_viewdefs();
757 * Set up a place to put thread-specific data.
758 * We only need a single pointer per thread - it points to the
759 * wcsession struct to which the thread is currently bound.
761 if (pthread_key_create(&MyConKey, NULL) != 0) {
762 lprintf(1, "Can't create TSD key: %s\n", strerror(errno));
766 * Set up a place to put thread-specific SSL data.
767 * We don't stick this in the wcsession struct because SSL starts
768 * up before the session is bound, and it gets torn down between
772 if (pthread_key_create(&ThreadSSL, NULL) != 0) {
773 lprintf(1, "Can't create TSD key: %s\n", strerror(errno));
778 * Bind the server to our favorite port.
779 * There is no need to check for errors, because ig_tcp_server()
780 * exits if it doesn't succeed.
783 if (strlen(uds_listen_path) > 0) {
784 lprintf(2, "Attempting to create listener socket at %s...\n", uds_listen_path);
785 msock = ig_uds_server(uds_listen_path, LISTEN_QUEUE_LENGTH);
788 lprintf(2, "Attempting to bind to port %d...\n", http_port);
789 msock = ig_tcp_server(ip_addr, http_port, LISTEN_QUEUE_LENGTH);
792 lprintf(2, "Listening on socket %d\n", msock);
793 signal(SIGPIPE, SIG_IGN);
795 pthread_mutex_init(&SessionListMutex, NULL);
798 * Start up the housekeeping thread
800 pthread_attr_init(&attr);
801 pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
802 pthread_create(&SessThread, &attr,
803 (void *(*)(void *)) housekeeping_loop, NULL);
807 * If this is an HTTPS server, fire up SSL
815 /** Start a few initial worker threads */
816 for (i = 0; i < (MIN_WORKER_THREADS); ++i) {
817 spawn_another_worker_thread();
820 /* now the original thread becomes another worker */
827 * Entry point for worker threads
829 void worker_entry(void)
834 int fail_this_transaction = 0;
837 /** Only one thread can accept at a time */
838 fail_this_transaction = 0;
839 ssock = accept(msock, NULL, 0);
841 lprintf(2, "accept() failed: %s\n",
844 /** Set the SO_REUSEADDR socket option */
846 setsockopt(ssock, SOL_SOCKET, SO_REUSEADDR,
849 /** If we are an HTTPS server, go crypto now. */
852 if (starttls(ssock) != 0) {
853 fail_this_transaction = 1;
859 if (fail_this_transaction == 0) {
861 /** Perform an HTTP transaction... */
864 /** Shut down SSL/TLS if required... */
871 /** ...and close the socket. */
872 lingering_close(ssock);
877 } while (!time_to_die);
883 * \brief logprintf. log messages
884 * logs to stderr if loglevel is lower than the verbosity set at startup
885 * \param loglevel level of the message
886 * \param format the printf like format string
887 * \param ... the strings to put into format
889 int lprintf(int loglevel, const char *format, ...)
893 if (loglevel <= verbosity) {
894 va_start(ap, format);
895 vfprintf(stderr, format, ap);
904 * \brief print the actual stack frame.
906 void wc_backtrace(void)
908 #ifdef HAVE_BACKTRACE
909 void *stack_frames[50];
914 size = backtrace(stack_frames, sizeof(stack_frames) / sizeof(void*));
915 strings = backtrace_symbols(stack_frames, size);
916 for (i = 0; i < size; i++) {
918 lprintf(1, "%s\n", strings[i]);
920 lprintf(1, "%p\n", stack_frames[i]);