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 "static.local", /** site local static templates */
48 "tiny_mce" /** the JS editor */
53 char *server_cookie = NULL; /**< our Cookie connection to the client */
55 int http_port = PORT_NUM; /**< Port to listen on */
57 char *ctdlhost = DEFAULT_HOST; /**< our name */
58 char *ctdlport = DEFAULT_PORT; /**< our Port */
59 int setup_wizard = 0; /**< should we run the setup wizard? \todo */
60 char wizard_filename[PATH_MAX];/**< where's the setup wizard? */
61 int running_as_daemon = 0; /**< should we deamonize on startup? */
65 * \brief This is a generic function to set up a master socket for listening on
66 * a TCP port. The server shuts down if the bind fails.
67 * \param ip_addr ip to bind to
68 * \param port_number the port to bind to
69 * \param queue_len the size of the input queue ????
71 int ig_tcp_server(char *ip_addr, int port_number, int queue_len)
73 struct sockaddr_in sin;
76 memset(&sin, 0, sizeof(sin));
77 sin.sin_family = AF_INET;
78 if (ip_addr == NULL) {
79 sin.sin_addr.s_addr = INADDR_ANY;
81 sin.sin_addr.s_addr = inet_addr(ip_addr);
84 if (sin.sin_addr.s_addr == INADDR_NONE) {
85 sin.sin_addr.s_addr = INADDR_ANY;
88 if (port_number == 0) {
89 lprintf(1, "Cannot start: no port number specified.\n");
92 sin.sin_port = htons((u_short) port_number);
94 s = socket(PF_INET, SOCK_STREAM, (getprotobyname("tcp")->p_proto));
96 lprintf(1, "Can't create a socket: %s\n", strerror(errno));
99 /** Set some socket options that make sense. */
101 setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
103 if (bind(s, (struct sockaddr *) &sin, sizeof(sin)) < 0) {
104 lprintf(1, "Can't bind: %s\n", strerror(errno));
107 if (listen(s, queue_len) < 0) {
108 lprintf(1, "Can't listen: %s\n", strerror(errno));
117 * \brief Create a Unix domain socket and listen on it
118 * \param sockpath file name of the unix domain socket
119 * \param queue_len queue size of the kernel fifo????
121 int ig_uds_server(char *sockpath, int queue_len)
123 struct sockaddr_un addr;
126 int actual_queue_len;
128 actual_queue_len = queue_len;
129 if (actual_queue_len < 5) actual_queue_len = 5;
131 i = unlink(sockpath);
132 if (i != 0) if (errno != ENOENT) {
133 lprintf(1, "citserver: can't unlink %s: %s\n",
134 sockpath, strerror(errno));
138 memset(&addr, 0, sizeof(addr));
139 addr.sun_family = AF_UNIX;
140 safestrncpy(addr.sun_path, sockpath, sizeof addr.sun_path);
142 s = socket(AF_UNIX, SOCK_STREAM, 0);
144 lprintf(1, "citserver: Can't create a socket: %s\n",
149 if (bind(s, (struct sockaddr *)&addr, sizeof(addr)) < 0) {
150 lprintf(1, "citserver: Can't bind: %s\n",
155 if (listen(s, actual_queue_len) < 0) {
156 lprintf(1, "citserver: Can't listen: %s\n",
161 chmod(sockpath, 0777);
169 * \brief Read data from the client socket.
170 * \param sock socket fd to read from ???
171 * \param buf buffer to read into
172 * \param bytes how large is the read buffer?
173 * \param timeout how long should we wait for input?
174 * \return values are\
175 * 1 Requested number of bytes has been read.\
176 * 0 Request timed out.\
177 * -1 Connection is broken, or other error.
179 int client_read_to(int sock, char *buf, int bytes, int timeout)
189 return (client_read_ssl(buf, bytes, timeout));
194 while (len < bytes) {
200 retval = select((sock) + 1, &rfds, NULL, NULL, &tv);
201 if (FD_ISSET(sock, &rfds) == 0) {
205 rlen = read(sock, &buf[len], bytes - len);
208 lprintf(2, "client_read() failed: %s\n",
216 write(2, "\033[32m", 5);
217 write(2, buf, bytes);
218 write(2, "\033[30m", 5);
224 * \brief write data to the client
225 * \param buf data to write to the client
226 * \param count size of buffer
228 ssize_t client_write(const void *buf, size_t count)
233 if (WC->burst != NULL) {
234 if ((WC->burst_len + count) >= WC->burst_alloc) {
235 newalloc = (WC->burst_alloc * 2);
236 if ((WC->burst_len + count) >= newalloc) {
239 newptr = realloc(WC->burst, newalloc);
240 if (newptr != NULL) {
242 WC->burst_alloc = newalloc;
245 if ((WC->burst_len + count) < WC->burst_alloc) {
246 memcpy(&WC->burst[WC->burst_len], buf, count);
247 WC->burst_len += count;
256 client_write_ssl((char *) buf, count);
261 write(2, "\033[34m", 5);
262 write(2, buf, count);
263 write(2, "\033[30m", 5);
265 return (write(WC->http_sock, buf, count));
269 * \brief what burst???
271 void begin_burst(void)
273 if (WC->burst != NULL) {
278 WC->burst_alloc = 32768;
279 WC->burst = malloc(WC->burst_alloc);
284 * \brief uses the same calling syntax as compress2(), but it
285 * creates a stream compatible with HTTP "Content-encoding: gzip"
288 #define DEF_MEM_LEVEL 8 /**< memlevel??? */
289 #define OS_CODE 0x03 /**< unix */
290 int ZEXPORT compress_gzip(Bytef * dest, /**< compressed buffer*/
291 uLongf * destLen, /**< length of the compresed data */
292 const Bytef * source, /**< source to encode */
293 uLong sourceLen, /**< length of the source to encode */
294 int level) /**< what level??? */
296 const int gz_magic[2] = { 0x1f, 0x8b }; /** gzip magic header */
298 /** write gzip header */
299 sprintf((char *) dest, "%c%c%c%c%c%c%c%c%c%c",
300 gz_magic[0], gz_magic[1], Z_DEFLATED,
301 0 /*flags */ , 0, 0, 0, 0 /*time */ , 0 /** xflags */ ,
307 stream.next_in = (Bytef *) source;
308 stream.avail_in = (uInt) sourceLen;
309 stream.next_out = dest + 10L; // after header
310 stream.avail_out = (uInt) * destLen;
311 if ((uLong) stream.avail_out != *destLen)
314 stream.zalloc = (alloc_func) 0;
315 stream.zfree = (free_func) 0;
316 stream.opaque = (voidpf) 0;
318 err = deflateInit2(&stream, level, Z_DEFLATED, -MAX_WBITS,
319 DEF_MEM_LEVEL, Z_DEFAULT_STRATEGY);
323 err = deflate(&stream, Z_FINISH);
324 if (err != Z_STREAM_END) {
326 return err == Z_OK ? Z_BUF_ERROR : err;
328 *destLen = stream.total_out + 10L;
330 /* write CRC and Length */
331 uLong crc = crc32(0L, source, sourceLen);
333 for (n = 0; n < 4; ++n, ++*destLen) {
334 dest[*destLen] = (int) (crc & 0xff);
337 uLong len = stream.total_in;
338 for (n = 0; n < 4; ++n, ++*destLen) {
339 dest[*destLen] = (int) (len & 0xff);
342 err = deflateEnd(&stream);
348 * \brief what burst???
355 if (WC->burst == NULL)
358 the_len = WC->burst_len;
359 the_data = WC->burst;
366 /* Handle gzip compression */
368 char *compressed_data = NULL;
369 uLongf compressed_len;
371 compressed_len = (uLongf) ((the_len * 101) / 100) + 100;
372 compressed_data = malloc(compressed_len);
374 if (compress_gzip((Bytef *) compressed_data,
377 (uLongf) the_len, Z_BEST_SPEED) == Z_OK) {
378 wprintf("Content-encoding: gzip\r\n");
380 the_data = compressed_data;
381 the_len = compressed_len;
383 free(compressed_data);
386 #endif /* HAVE_ZLIB */
388 wprintf("Content-length: %d\r\n\r\n", the_len);
389 client_write(the_data, the_len);
397 * \brief Read data from the client socket with default timeout.
398 * (This is implemented in terms of client_read_to() and could be
399 * justifiably moved out of sysdep.c)
400 * \param sock the socket fd to read from???
401 * \param buf the buffer to write to
402 * \param bytes how large is the buffer
404 int client_read(int sock, char *buf, int bytes)
406 return (client_read_to(sock, buf, bytes, SLEEPING));
411 * \brief Get a LF-terminated line of text from the client.
412 * (This is implemented in terms of client_read() and could be
413 * justifiably moved out of sysdep.c)
414 * \param sock socket fd to get client line from???
415 * \param buf buffer to write read data to
416 * \param bufsiz how many bytes to read
417 * \return numer of bytes read???
419 int client_getln(int sock, char *buf, int bufsiz)
423 /** Read one character at a time.*/
425 retval = client_read(sock, &buf[i], 1);
426 if (retval != 1 || buf[i] == '\n' || i == (bufsiz-1))
428 if ( (!isspace(buf[i])) && (!isprint(buf[i])) ) {
429 /** Non printable character recieved from client */
434 /** If we got a long line, discard characters until the newline. */
436 while (buf[i] != '\n' && retval == 1)
437 retval = client_read(sock, &buf[i], 1);
440 * Strip any trailing non-printable characters.
443 while ((strlen(buf) > 0) && (!isprint(buf[strlen(buf) - 1]))) {
444 buf[strlen(buf) - 1] = 0;
450 * \brief shut us down the regular way.
451 * param signum the signal we want to forward
454 void graceful_shutdown(int signum) {
455 kill(current_child, signum);
461 * \brief Start running as a daemon.
463 * param do_close_stdio Only close stdio if set.
467 * Start running as a daemon.
469 void start_daemon(char *pid_file)
478 /* Close stdin/stdout/stderr and replace them with /dev/null.
479 * We don't just call close() because we don't want these fd's
480 * to be reused for other files.
484 signal(SIGHUP, SIG_IGN);
485 signal(SIGINT, SIG_IGN);
486 signal(SIGQUIT, SIG_IGN);
495 freopen("/dev/null", "r", stdin);
496 freopen("/dev/null", "w", stdout);
497 freopen("/dev/null", "w", stderr);
500 current_child = fork();
503 if (current_child < 0) {
508 else if (current_child == 0) {
509 signal(SIGTERM, graceful_shutdown);
510 return; /* continue starting citadel. */
514 signal(SIGTERM, SIG_IGN);
516 fp = fopen(pid_file, "w");
518 fprintf(fp, "%d\n", current_child);
522 waitpid(current_child, &status, 0);
527 /* Did the main process exit with an actual exit code? */
528 if (WIFEXITED(status)) {
530 /* Exit code 0 means the watcher should exit */
531 if (WEXITSTATUS(status) == 0) {
535 /* Exit code 101-109 means the watcher should exit */
536 else if ( (WEXITSTATUS(status) >= 101) && (WEXITSTATUS(status) <= 109) ) {
540 /* Any other exit code means we should restart. */
546 /* Any other type of termination (signals, etc.) should also restart. */
551 } while (do_restart);
556 exit(WEXITSTATUS(status));
560 * \brief Spawn an additional worker thread into the pool.
562 void spawn_another_worker_thread()
564 pthread_t SessThread; /**< Thread descriptor */
565 pthread_attr_t attr; /**< Thread attributes */
568 lprintf(3, "Creating a new thread\n");
570 /** set attributes for the new thread */
571 pthread_attr_init(&attr);
572 pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
575 * Our per-thread stacks need to be bigger than the default size, otherwise
576 * the MIME parser crashes on FreeBSD, and the IMAP service crashes on
579 if ((ret = pthread_attr_setstacksize(&attr, 1024 * 1024))) {
580 lprintf(1, "pthread_attr_setstacksize: %s\n",
582 pthread_attr_destroy(&attr);
585 /** now create the thread */
586 if (pthread_create(&SessThread, &attr,
587 (void *(*)(void *)) worker_entry, NULL)
589 lprintf(1, "Can't create thread: %s\n", strerror(errno));
592 /** free up the attributes */
593 pthread_attr_destroy(&attr);
597 * \brief Here's where it all begins.
598 * \param argc number of commandline args
599 * \param argv the commandline arguments
601 int main(int argc, char **argv)
603 pthread_t SessThread; /**< Thread descriptor */
604 pthread_attr_t attr; /**< Thread attributes */
605 int a, i; /**< General-purpose variables */
606 char tracefile[PATH_MAX];
608 char dirbuffer[PATH_MAX]="";
611 int home_specified=0;
612 char relhome[PATH_MAX]="";
613 char webcitdir[PATH_MAX] = DATADIR;
614 char *pidfile = NULL;
620 #endif /* ENABLE_NLS */
621 char uds_listen_path[PATH_MAX]; /**< listen on a unix domain socket? */
623 strcpy(uds_listen_path, "");
625 /** Parse command line */
627 while ((a = getopt(argc, argv, "h:i:p:t:x:dD:cfs")) != EOF)
629 while ((a = getopt(argc, argv, "h:i:p:t:x:dD:cf")) != EOF)
633 hdir = strdup(optarg);
635 if (!relh) safestrncpy(webcitdir, hdir,
638 safestrncpy(relhome, relhome,
640 /* free(hdir); TODO: SHOULD WE DO THIS? */
645 running_as_daemon = 1;
648 pidfile = strdup(optarg);
649 running_as_daemon = 1;
652 safestrncpy(ip_addr, optarg, sizeof ip_addr);
655 http_port = atoi(optarg);
656 if (http_port == 0) {
657 safestrncpy(uds_listen_path, optarg, sizeof uds_listen_path);
661 safestrncpy(tracefile, optarg, sizeof tracefile);
662 freopen(tracefile, "w", stdout);
663 freopen(tracefile, "w", stderr);
664 freopen(tracefile, "r", stdin);
667 verbosity = atoi(optarg);
673 server_cookie = malloc(256);
674 if (server_cookie != NULL) {
675 safestrncpy(server_cookie,
676 "Set-cookie: wcserver=",
679 (&server_cookie[strlen(server_cookie)],
681 lprintf(2, "gethostname: %s\n",
691 fprintf(stderr, "usage: webserver "
692 "[-i ip_addr] [-p http_port] "
693 "[-t tracefile] [-c] [-f] "
698 "[remotehost [remoteport]]\n");
703 ctdlhost = argv[optind];
705 ctdlport = argv[optind];
708 /* daemonize, if we were asked to */
709 if (running_as_daemon) {
710 start_daemon(pidfile);
713 /** Tell 'em who's in da house */
714 lprintf(1, SERVER "\n");
715 lprintf(1, "Copyright (C) 1996-2007 by the Citadel development team.\n"
716 "This software is distributed under the terms of the "
717 "GNU General Public License.\n\n"
721 /** initialize the International Bright Young Thing */
723 initialize_locales();
724 locale = setlocale(LC_ALL, "");
725 mo = malloc(strlen(webcitdir) + 20);
726 lprintf(9, "Message catalog directory: %s\n", bindtextdomain("webcit", LOCALEDIR));
728 lprintf(9, "Text domain: %s\n", textdomain("webcit"));
729 lprintf(9, "Text domain Charset: %s\n", bind_textdomain_codeset("webcit","UTF8"));
733 /* calculate all our path on a central place */
734 /* where to keep our config */
736 #define COMPUTE_DIRECTORY(SUBDIR) memcpy(dirbuffer,SUBDIR, sizeof dirbuffer);\
737 snprintf(SUBDIR,sizeof SUBDIR, "%s%s%s%s%s%s%s", \
738 (home&!relh)?webcitdir:basedir, \
739 ((basedir!=webcitdir)&(home&!relh))?basedir:"/", \
740 ((basedir!=webcitdir)&(home&!relh))?"/":"", \
742 (relhome[0]!='\0')?"/":"",\
744 (dirbuffer[0]!='\0')?"/":"");
746 COMPUTE_DIRECTORY(socket_dir);
748 COMPUTE_DIRECTORY(static_dir);
749 /** we should go somewhere we can leave our coredump, if enabled... */
750 lprintf(9, "Changing directory to %s\n", socket_dir);
751 if (chdir(webcitdir) != 0) {
754 initialize_viewdefs();
758 * Set up a place to put thread-specific data.
759 * We only need a single pointer per thread - it points to the
760 * wcsession struct to which the thread is currently bound.
762 if (pthread_key_create(&MyConKey, NULL) != 0) {
763 lprintf(1, "Can't create TSD key: %s\n", strerror(errno));
767 * Set up a place to put thread-specific SSL data.
768 * We don't stick this in the wcsession struct because SSL starts
769 * up before the session is bound, and it gets torn down between
773 if (pthread_key_create(&ThreadSSL, NULL) != 0) {
774 lprintf(1, "Can't create TSD key: %s\n", strerror(errno));
779 * Bind the server to our favorite port.
780 * There is no need to check for errors, because ig_tcp_server()
781 * exits if it doesn't succeed.
784 if (strlen(uds_listen_path) > 0) {
785 lprintf(2, "Attempting to create listener socket at %s...\n", uds_listen_path);
786 msock = ig_uds_server(uds_listen_path, LISTEN_QUEUE_LENGTH);
789 lprintf(2, "Attempting to bind to port %d...\n", http_port);
790 msock = ig_tcp_server(ip_addr, http_port, LISTEN_QUEUE_LENGTH);
793 lprintf(2, "Listening on socket %d\n", msock);
794 signal(SIGPIPE, SIG_IGN);
796 pthread_mutex_init(&SessionListMutex, NULL);
799 * Start up the housekeeping thread
801 pthread_attr_init(&attr);
802 pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
803 pthread_create(&SessThread, &attr,
804 (void *(*)(void *)) housekeeping_loop, NULL);
808 * If this is an HTTPS server, fire up SSL
816 /** Start a few initial worker threads */
817 for (i = 0; i < (MIN_WORKER_THREADS); ++i) {
818 spawn_another_worker_thread();
821 /* now the original thread becomes another worker */
828 * Entry point for worker threads
830 void worker_entry(void)
835 int fail_this_transaction = 0;
838 /** Only one thread can accept at a time */
839 fail_this_transaction = 0;
840 ssock = accept(msock, NULL, 0);
842 lprintf(2, "accept() failed: %s\n",
845 /** Set the SO_REUSEADDR socket option */
847 setsockopt(ssock, SOL_SOCKET, SO_REUSEADDR,
850 /** If we are an HTTPS server, go crypto now. */
853 if (starttls(ssock) != 0) {
854 fail_this_transaction = 1;
860 if (fail_this_transaction == 0) {
862 /** Perform an HTTP transaction... */
865 /** Shut down SSL/TLS if required... */
872 /** ...and close the socket. */
873 lingering_close(ssock);
878 } while (!time_to_die);
884 * \brief logprintf. log messages
885 * logs to stderr if loglevel is lower than the verbosity set at startup
886 * \param loglevel level of the message
887 * \param format the printf like format string
888 * \param ... the strings to put into format
890 int lprintf(int loglevel, const char *format, ...)
894 if (loglevel <= verbosity) {
895 va_start(ap, format);
896 vfprintf(stderr, format, ap);
905 * \brief print the actual stack frame.
907 void wc_backtrace(void)
909 #ifdef HAVE_BACKTRACE
910 void *stack_frames[50];
915 size = backtrace(stack_frames, sizeof(stack_frames) / sizeof(void*));
916 strings = backtrace_symbols(stack_frames, size);
917 for (i = 0; i < size; i++) {
919 lprintf(1, "%s\n", strings[i]);
921 lprintf(1, "%p\n", stack_frames[i]);