092236442b6eb6365e6e397e89af784346c22d93
[citadel.git] / webcit / webserver.c
1 /*
2  * $Id$
3  *
4  * This contains a simple multithreaded TCP server manager.  It sits around
5  * waiting on the specified port for incoming HTTP connections.  When a
6  * connection is established, it calls context_loop() from context_loop.c.
7  *
8  */
9
10
11 #include "webcit.h"
12 #include "webserver.h"
13
14 #ifndef HAVE_SNPRINTF
15 int vsnprintf(char *buf, size_t max, const char *fmt, va_list argp);
16 #endif
17
18 int verbosity = 9;              /* Logging level */
19 int msock;                      /* master listening socket */
20 int is_https = 0;               /* Nonzero if I am an HTTPS service */
21 int follow_xff = 0;             /* Follow X-Forwarded-For: header */
22 extern void *context_loop(int);
23 extern void *housekeeping_loop(void);
24 extern pthread_mutex_t SessionListMutex;
25 extern pthread_key_t MyConKey;
26
27
28 char *server_cookie = NULL;
29
30
31 char *ctdlhost = DEFAULT_HOST;
32 char *ctdlport = DEFAULT_PORT;
33 int setup_wizard = 0;
34 char wizard_filename[PATH_MAX];
35
36 /*
37  * This is a generic function to set up a master socket for listening on
38  * a TCP port.  The server shuts down if the bind fails.
39  */
40 int ig_tcp_server(char *ip_addr, int port_number, int queue_len)
41 {
42         struct sockaddr_in sin;
43         int s, i;
44
45         memset(&sin, 0, sizeof(sin));
46         sin.sin_family = AF_INET;
47         if (ip_addr == NULL) {
48                 sin.sin_addr.s_addr = INADDR_ANY;
49         } else {
50                 sin.sin_addr.s_addr = inet_addr(ip_addr);
51         }
52
53         if (sin.sin_addr.s_addr == INADDR_NONE) {
54                 sin.sin_addr.s_addr = INADDR_ANY;
55         }
56
57         if (port_number == 0) {
58                 lprintf(1, "Cannot start: no port number specified.\n");
59                 exit(1);
60         }
61         sin.sin_port = htons((u_short) port_number);
62
63         s = socket(PF_INET, SOCK_STREAM, (getprotobyname("tcp")->p_proto));
64         if (s < 0) {
65                 lprintf(1, "Can't create a socket: %s\n", strerror(errno));
66                 exit(errno);
67         }
68         /* Set some socket options that make sense. */
69         i = 1;
70         setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
71
72         if (bind(s, (struct sockaddr *) &sin, sizeof(sin)) < 0) {
73                 lprintf(1, "Can't bind: %s\n", strerror(errno));
74                 exit(errno);
75         }
76         if (listen(s, queue_len) < 0) {
77                 lprintf(1, "Can't listen: %s\n", strerror(errno));
78                 exit(errno);
79         }
80         return (s);
81 }
82
83
84 /*
85  * Read data from the client socket.
86  * Return values are:
87  *      1       Requested number of bytes has been read.
88  *      0       Request timed out.
89  *      -1      Connection is broken, or other error.
90  */
91 int client_read_to(int sock, char *buf, int bytes, int timeout)
92 {
93         int len, rlen;
94         fd_set rfds;
95         struct timeval tv;
96         int retval;
97
98
99 #ifdef HAVE_OPENSSL
100         if (is_https) {
101                 return (client_read_ssl(buf, bytes, timeout));
102         }
103 #endif
104
105         len = 0;
106         while (len < bytes) {
107                 FD_ZERO(&rfds);
108                 FD_SET(sock, &rfds);
109                 tv.tv_sec = timeout;
110                 tv.tv_usec = 0;
111
112                 retval = select((sock) + 1, &rfds, NULL, NULL, &tv);
113                 if (FD_ISSET(sock, &rfds) == 0) {
114                         return (0);
115                 }
116
117                 rlen = read(sock, &buf[len], bytes - len);
118
119                 if (rlen < 1) {
120                         lprintf(2, "client_read() failed: %s\n",
121                                 strerror(errno));
122                         return (-1);
123                 }
124                 len = len + rlen;
125         }
126
127 #ifdef HTTP_TRACING
128         write(2, "\033[32m", 5);
129         write(2, buf, bytes);
130         write(2, "\033[30m", 5);
131 #endif
132         return (1);
133 }
134
135
136 ssize_t client_write(const void *buf, size_t count)
137 {
138
139         if (WC->burst != NULL) {
140                 WC->burst =
141                     realloc(WC->burst, (WC->burst_len + count + 2));
142                 memcpy(&WC->burst[WC->burst_len], buf, count);
143                 WC->burst_len += count;
144                 return (count);
145         }
146 #ifdef HAVE_OPENSSL
147         if (is_https) {
148                 client_write_ssl((char *) buf, count);
149                 return (count);
150         }
151 #endif
152 #ifdef HTTP_TRACING
153         write(2, "\033[34m", 5);
154         write(2, buf, count);
155         write(2, "\033[30m", 5);
156 #endif
157         return (write(WC->http_sock, buf, count));
158 }
159
160
161 void begin_burst(void)
162 {
163         if (WC->burst != NULL) {
164                 free(WC->burst);
165                 WC->burst = NULL;
166         }
167         WC->burst_len = 0;
168         WC->burst = malloc(SIZ);
169 }
170
171
172 /*
173  * compress_gzip() uses the same calling syntax as compress2(), but it
174  * creates a stream compatible with HTTP "Content-encoding: gzip"
175  */
176 #ifdef HAVE_ZLIB
177 #define DEF_MEM_LEVEL 8
178 #define OS_CODE 0x03    /* unix */
179 int ZEXPORT compress_gzip(Bytef * dest, uLongf * destLen,
180                           const Bytef * source, uLong sourceLen, int level)
181 {
182         const int gz_magic[2] = { 0x1f, 0x8b }; /* gzip magic header */
183
184         /* write gzip header */
185         sprintf((char *) dest, "%c%c%c%c%c%c%c%c%c%c",
186                 gz_magic[0], gz_magic[1], Z_DEFLATED,
187                 0 /*flags */ , 0, 0, 0, 0 /*time */ , 0 /*xflags */ ,
188                 OS_CODE);
189
190         /* normal deflate */
191         z_stream stream;
192         int err;
193         stream.next_in = (Bytef *) source;
194         stream.avail_in = (uInt) sourceLen;
195         stream.next_out = dest + 10L;   // after header
196         stream.avail_out = (uInt) * destLen;
197         if ((uLong) stream.avail_out != *destLen)
198                 return Z_BUF_ERROR;
199
200         stream.zalloc = (alloc_func) 0;
201         stream.zfree = (free_func) 0;
202         stream.opaque = (voidpf) 0;
203
204         err = deflateInit2(&stream, level, Z_DEFLATED, -MAX_WBITS,
205                            DEF_MEM_LEVEL, Z_DEFAULT_STRATEGY);
206         if (err != Z_OK)
207                 return err;
208
209         err = deflate(&stream, Z_FINISH);
210         if (err != Z_STREAM_END) {
211                 deflateEnd(&stream);
212                 return err == Z_OK ? Z_BUF_ERROR : err;
213         }
214         *destLen = stream.total_out + 10L;
215
216         /* write CRC and Length */
217         uLong crc = crc32(0L, source, sourceLen);
218         int n;
219         for (n = 0; n < 4; ++n, ++*destLen) {
220                 dest[*destLen] = (int) (crc & 0xff);
221                 crc >>= 8;
222         }
223         uLong len = stream.total_in;
224         for (n = 0; n < 4; ++n, ++*destLen) {
225                 dest[*destLen] = (int) (len & 0xff);
226                 len >>= 8;
227         }
228         err = deflateEnd(&stream);
229         return err;
230 }
231 #endif
232
233 void end_burst(void)
234 {
235         size_t the_len;
236         char *the_data;
237
238         if (WC->burst == NULL)
239                 return;
240
241         the_len = WC->burst_len;
242         the_data = WC->burst;
243
244         WC->burst_len = 0;
245         WC->burst = NULL;
246
247 #ifdef HAVE_ZLIB
248         /* Handle gzip compression */
249         if (WC->gzip_ok) {
250                 char *compressed_data = NULL;
251                 uLongf compressed_len;
252
253                 compressed_len = (uLongf) ((the_len * 101) / 100) + 100;
254                 compressed_data = malloc(compressed_len);
255
256                 if (compress_gzip((Bytef *) compressed_data,
257                                   &compressed_len,
258                                   (Bytef *) the_data,
259                                   (uLongf) the_len, Z_BEST_SPEED) == Z_OK) {
260                         wprintf("Content-encoding: gzip\r\n");
261                         free(the_data);
262                         the_data = compressed_data;
263                         the_len = compressed_len;
264                 } else {
265                         free(compressed_data);
266                 }
267         }
268 #endif                          /* HAVE_ZLIB */
269
270         wprintf("Content-length: %d\r\n\r\n", the_len);
271         client_write(the_data, the_len);
272         free(the_data);
273         return;
274 }
275
276
277
278 /*
279  * Read data from the client socket with default timeout.
280  * (This is implemented in terms of client_read_to() and could be
281  * justifiably moved out of sysdep.c)
282  */
283 int client_read(int sock, char *buf, int bytes)
284 {
285         return (client_read_to(sock, buf, bytes, SLEEPING));
286 }
287
288
289 /*
290  * client_getln()   ...   Get a LF-terminated line of text from the client.
291  * (This is implemented in terms of client_read() and could be
292  * justifiably moved out of sysdep.c)
293  */
294 int client_getln(int sock, char *buf, int bufsiz)
295 {
296         int i, retval;
297
298         /* Read one character at a time.
299          */
300         for (i = 0;; i++) {
301                 retval = client_read(sock, &buf[i], 1);
302                 if (retval != 1 || buf[i] == '\n' || i == (bufsiz-1))
303                         break;
304         }
305
306         /* If we got a long line, discard characters until the newline.
307          */
308         if (i == (bufsiz-1))
309                 while (buf[i] != '\n' && retval == 1)
310                         retval = client_read(sock, &buf[i], 1);
311
312         /*
313          * Strip any trailing non-printable characters.
314          */
315         buf[i] = 0;
316         while ((strlen(buf) > 0) && (!isprint(buf[strlen(buf) - 1]))) {
317                 buf[strlen(buf) - 1] = 0;
318         }
319         return (retval);
320 }
321
322
323 /*
324  * Start running as a daemon.  Only close stdio if do_close_stdio is set.
325  */
326 void start_daemon(int do_close_stdio)
327 {
328         if (do_close_stdio) {
329                 /* close(0); */
330                 close(1);
331                 close(2);
332         }
333         signal(SIGHUP, SIG_IGN);
334         signal(SIGINT, SIG_IGN);
335         signal(SIGQUIT, SIG_IGN);
336         if (fork() != 0)
337                 exit(0);
338 }
339
340 void spawn_another_worker_thread()
341 {
342         pthread_t SessThread;   /* Thread descriptor */
343         pthread_attr_t attr;    /* Thread attributes */
344         int ret;
345
346         lprintf(3, "Creating a new thread\n");
347
348         /* set attributes for the new thread */
349         pthread_attr_init(&attr);
350         pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
351
352         /* Our per-thread stacks need to be bigger than the default size, otherwise
353          * the MIME parser crashes on FreeBSD, and the IMAP service crashes on
354          * 64-bit Linux.
355          */
356         if ((ret = pthread_attr_setstacksize(&attr, 1024 * 1024))) {
357                 lprintf(1, "pthread_attr_setstacksize: %s\n",
358                         strerror(ret));
359                 pthread_attr_destroy(&attr);
360         }
361
362         /* now create the thread */
363         if (pthread_create(&SessThread, &attr,
364                            (void *(*)(void *)) worker_entry, NULL)
365             != 0) {
366                 lprintf(1, "Can't create thread: %s\n", strerror(errno));
367         }
368
369         /* free up the attributes */
370         pthread_attr_destroy(&attr);
371 }
372
373 /*
374  * Here's where it all begins.
375  */
376 int main(int argc, char **argv)
377 {
378         pthread_t SessThread;   /* Thread descriptor */
379         pthread_attr_t attr;    /* Thread attributes */
380         int a, i;               /* General-purpose variables */
381         int port = PORT_NUM;    /* Port to listen on */
382         char tracefile[PATH_MAX];
383         char ip_addr[256];
384         char *webcitdir = WEBCITDIR;
385         char *locale = NULL;
386
387         /* initialize the International Bright Young Thing */
388 #ifdef ENABLE_NLS
389         locale = setlocale(LC_ALL, "");
390         bindtextdomain(PACKAGE, LOCALEDIR);
391         textdomain(PACKAGE);
392 #endif
393
394         /* Parse command line */
395 #ifdef HAVE_OPENSSL
396         while ((a = getopt(argc, argv, "h:i:p:t:x:cfs")) != EOF)
397 #else
398         while ((a = getopt(argc, argv, "h:i:p:t:x:cf")) != EOF)
399 #endif
400                 switch (a) {
401                 case 'h':
402                         webcitdir = strdup(optarg);
403                         break;
404                 case 'i':
405                         safestrncpy(ip_addr, optarg, sizeof ip_addr);
406                         break;
407                 case 'p':
408                         port = atoi(optarg);
409                         break;
410                 case 't':
411                         safestrncpy(tracefile, optarg, sizeof tracefile);
412                         freopen(tracefile, "w", stdout);
413                         freopen(tracefile, "w", stderr);
414                         freopen(tracefile, "r", stdin);
415                         break;
416                 case 'x':
417                         verbosity = atoi(optarg);
418                         break;
419                 case 'f':
420                         follow_xff = 1;
421                         break;
422                 case 'c':
423                         server_cookie = malloc(256);
424                         if (server_cookie != NULL) {
425                                 safestrncpy(server_cookie,
426                                        "Set-cookie: wcserver=",
427                                         256);
428                                 if (gethostname
429                                     (&server_cookie[strlen(server_cookie)],
430                                      200) != 0) {
431                                         lprintf(2, "gethostname: %s\n",
432                                                 strerror(errno));
433                                         free(server_cookie);
434                                 }
435                         }
436                         break;
437                 case 's':
438                         is_https = 1;
439                         break;
440                 default:
441                         fprintf(stderr, "usage: webserver "
442                                 "[-i ip_addr] [-p http_port] "
443                                 "[-t tracefile] [-c] [-f] "
444 #ifdef HAVE_OPENSSL
445                                 "[-s] "
446 #endif
447                                 "[remotehost [remoteport]]\n");
448                         return 1;
449                 }
450
451         if (optind < argc) {
452                 ctdlhost = argv[optind];
453                 if (++optind < argc)
454                         ctdlport = argv[optind];
455         }
456         /* Tell 'em who's in da house */
457         lprintf(1, SERVER "\n");
458         lprintf(1, "Copyright (C) 1996-2005 by the Citadel development team.\n"
459                 "This software is distributed under the terms of the "
460                 "GNU General Public License.\n\n"
461         );
462
463         lprintf(9, "Changing directory to %s\n", webcitdir);
464         if (chdir(webcitdir) != 0) {
465                 perror("chdir");
466         }
467
468         /*
469          * Set up a place to put thread-specific data.
470          * We only need a single pointer per thread - it points to the
471          * wcsession struct to which the thread is currently bound.
472          */
473         if (pthread_key_create(&MyConKey, NULL) != 0) {
474                 lprintf(1, "Can't create TSD key: %s\n", strerror(errno));
475         }
476
477         /*
478          * Set up a place to put thread-specific SSL data.
479          * We don't stick this in the wcsession struct because SSL starts
480          * up before the session is bound, and it gets torn down between
481          * transactions.
482          */
483 #ifdef HAVE_OPENSSL
484         if (pthread_key_create(&ThreadSSL, NULL) != 0) {
485                 lprintf(1, "Can't create TSD key: %s\n", strerror(errno));
486         }
487 #endif
488
489         /*
490          * Bind the server to our favorite port.
491          * There is no need to check for errors, because ig_tcp_server()
492          * exits if it doesn't succeed.
493          */
494         lprintf(2, "Attempting to bind to port %d...\n", port);
495         msock = ig_tcp_server(ip_addr, port, LISTEN_QUEUE_LENGTH);
496         lprintf(2, "Listening on socket %d\n", msock);
497         signal(SIGPIPE, SIG_IGN);
498
499         pthread_mutex_init(&SessionListMutex, NULL);
500
501         /*
502          * Start up the housekeeping thread
503          */
504         pthread_attr_init(&attr);
505         pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
506         pthread_create(&SessThread, &attr,
507                        (void *(*)(void *)) housekeeping_loop, NULL);
508
509
510         /*
511          * If this is an HTTPS server, fire up SSL
512          */
513 #ifdef HAVE_OPENSSL
514         if (is_https) {
515                 init_ssl();
516         }
517 #endif
518
519         /* Start a few initial worker threads */
520         for (i = 0; i < (MIN_WORKER_THREADS); ++i) {
521                 spawn_another_worker_thread();
522         }
523
524         /* now the original thread becomes another worker */
525         worker_entry();
526         return 0;
527 }
528
529
530 /*
531  * Entry point for worker threads
532  */
533 void worker_entry(void)
534 {
535         int ssock;
536         int i = 0;
537         int time_to_die = 0;
538         int fail_this_transaction = 0;
539
540         do {
541                 /* Only one thread can accept at a time */
542                 fail_this_transaction = 0;
543                 ssock = accept(msock, NULL, 0);
544                 if (ssock < 0) {
545                         lprintf(2, "accept() failed: %s\n",
546                                 strerror(errno));
547                 } else {
548                         /* Set the SO_REUSEADDR socket option */
549                         i = 1;
550                         setsockopt(ssock, SOL_SOCKET, SO_REUSEADDR,
551                                    &i, sizeof(i));
552
553                         /* If we are an HTTPS server, go crypto now. */
554 #ifdef HAVE_OPENSSL
555                         if (is_https) {
556                                 if (starttls(ssock) != 0) {
557                                         fail_this_transaction = 1;
558                                         close(ssock);
559                                 }
560                         }
561 #endif
562
563                         if (fail_this_transaction == 0) {
564                                 /* Perform an HTTP transaction... */
565                                 context_loop(ssock);
566                                 /* ...and close the socket. */
567                                 lingering_close(ssock);
568                         }
569
570                 }
571
572         } while (!time_to_die);
573
574         pthread_exit(NULL);
575 }
576
577
578 int lprintf(int loglevel, const char *format, ...)
579 {
580         va_list ap;
581
582         if (loglevel <= verbosity) {
583                 va_start(ap, format);
584                 vfprintf(stderr, format, ap);
585                 va_end(ap);
586                 fflush(stderr);
587         }
588         return 1;
589 }