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.
8 * Copyright (c) 1996-2009 by the citadel.org developers.
9 * This program is released under the terms of the GNU General Public License v3.
14 #include "webserver.h"
19 #include "modules_init.h"
21 int vsnprintf(char *buf, size_t max, const char *fmt, va_list argp);
24 int verbosity = 9; /* Logging level */
25 int msock; /* master listening socket */
26 int is_https = 0; /* Nonzero if I am an HTTPS service */
27 int follow_xff = 0; /* Follow X-Forwarded-For: header */
28 int home_specified = 0; /* did the user specify a homedir? */
29 int time_to_die = 0; /* Nonzero if server is shutting down */
31 extern void *context_loop(int*);
32 extern void *housekeeping_loop(void);
33 extern pthread_mutex_t SessionListMutex;
34 extern pthread_key_t MyConKey;
36 extern int ig_tcp_server(char *ip_addr, int port_number, int queue_len);
37 extern int ig_uds_server(char *sockpath, int queue_len);
40 char ctdl_key_dir[PATH_MAX]=SSL_DIR;
41 char file_crpt_file_key[PATH_MAX]="";
42 char file_crpt_file_csr[PATH_MAX]="";
43 char file_crpt_file_cer[PATH_MAX]="";
45 char socket_dir[PATH_MAX]; /* where to talk to our citadel server */
46 const char editor_absolut_dir[PATH_MAX]=EDITORDIR; /* nailed to what configure gives us. */
47 char static_dir[PATH_MAX]; /* calculated on startup */
48 char static_local_dir[PATH_MAX]; /* calculated on startup */
49 char static_icon_dir[PATH_MAX]; /* where should we find our mime icons? */
50 char *static_dirs[]={ /* needs same sort order as the web mapping */
51 (char*)static_dir, /* our templates on disk */
52 (char*)static_local_dir, /* user provided templates disk */
53 (char*)editor_absolut_dir, /* the editor on disk */
54 (char*)static_icon_dir /* our icons... */
58 * Subdirectories from which the client may request static content
60 * (If you add more, remember to increment 'ndirs' below)
62 char *static_content_dirs[] = {
63 "static", /* static templates */
64 "static.local", /* site local static templates */
65 "tiny_mce" /* rich text editor */
71 char *server_cookie = NULL; /* our Cookie connection to the client */
72 int http_port = PORT_NUM; /* Port to listen on */
73 char *ctdlhost = DEFAULT_HOST; /* our name */
74 char *ctdlport = DEFAULT_PORT; /* our Port */
75 int setup_wizard = 0; /* should we run the setup wizard? \todo */
76 char wizard_filename[PATH_MAX]; /* where's the setup wizard? */
77 int running_as_daemon = 0; /* should we deamonize on startup? */
82 * Shut us down the regular way.
83 * signum is the signal we want to forward
86 void graceful_shutdown_watcher(int signum) {
87 lprintf (1, "bye; shutting down watcher.");
88 kill(current_child, signum);
97 * Shut us down the regular way.
98 * signum is the signal we want to forward
101 void graceful_shutdown(int signum) {
106 lprintf (1, "bye going down gracefull.[%d][%s]\n", signum, wd);
118 * Start running as a daemon.
120 void start_daemon(char *pid_file)
129 /* Close stdin/stdout/stderr and replace them with /dev/null.
130 * We don't just call close() because we don't want these fd's
131 * to be reused for other files.
135 signal(SIGHUP, SIG_IGN);
136 signal(SIGINT, SIG_IGN);
137 signal(SIGQUIT, SIG_IGN);
146 freopen("/dev/null", "r", stdin);
147 freopen("/dev/null", "w", stdout);
148 freopen("/dev/null", "w", stderr);
149 signal(SIGTERM, graceful_shutdown_watcher);
150 signal(SIGHUP, graceful_shutdown_watcher);
153 current_child = fork();
156 if (current_child < 0) {
158 ShutDownLibCitadel ();
162 else if (current_child == 0) { /* child process */
163 signal(SIGHUP, graceful_shutdown);
165 return; /* continue starting webcit. */
167 else { /* watcher process */
169 fp = fopen(pid_file, "w");
171 fprintf(fp, "%d\n", getpid());
175 waitpid(current_child, &status, 0);
180 /* Did the main process exit with an actual exit code? */
181 if (WIFEXITED(status)) {
183 /* Exit code 0 means the watcher should exit */
184 if (WEXITSTATUS(status) == 0) {
188 /* Exit code 101-109 means the watcher should exit */
189 else if ( (WEXITSTATUS(status) >= 101) && (WEXITSTATUS(status) <= 109) ) {
193 /* Any other exit code means we should restart. */
199 /* Any other type of termination (signals, etc.) should also restart. */
204 } while (do_restart);
209 ShutDownLibCitadel ();
210 exit(WEXITSTATUS(status));
214 * Spawn an additional worker thread into the pool.
216 void spawn_another_worker_thread()
218 pthread_t SessThread; /* Thread descriptor */
219 pthread_attr_t attr; /* Thread attributes */
222 lprintf(3, "Creating a new thread\n");
224 /* set attributes for the new thread */
225 pthread_attr_init(&attr);
226 pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
229 * Our per-thread stacks need to be bigger than the default size, otherwise
230 * the MIME parser crashes on FreeBSD, and the IMAP service crashes on
233 if ((ret = pthread_attr_setstacksize(&attr, 1024 * 1024))) {
234 lprintf(1, "pthread_attr_setstacksize: %s\n",
236 pthread_attr_destroy(&attr);
239 /* now create the thread */
240 if (pthread_create(&SessThread, &attr,
241 (void *(*)(void *)) worker_entry, NULL)
243 lprintf(1, "Can't create thread: %s\n", strerror(errno));
246 /* free up the attributes */
247 pthread_attr_destroy(&attr);
250 /* #define DBG_PRINNT_HOOKS_AT_START */
251 #ifdef DBG_PRINNT_HOOKS_AT_START
252 const char foobuf[32];
253 const char *nix(void *vptr) {snprintf(foobuf, 32, "%0x", (long) vptr); return foobuf;}
255 extern int dbg_analyze_msg;
256 extern int dbg_bactrace_template_errors;
257 extern int DumpTemplateI18NStrings;
258 extern StrBuf *I18nDump;
259 void InitTemplateCache(void);
260 extern int LoadTemplates;
262 extern HashList *HandlerHash;
266 webcit_calc_dirs_n_files(int relh, const char *basedir, int home, char *webcitdir, char *relhome)
268 char dirbuffer[PATH_MAX]="";
269 /* calculate all our path on a central place */
270 /* where to keep our config */
272 #define COMPUTE_DIRECTORY(SUBDIR) memcpy(dirbuffer,SUBDIR, sizeof dirbuffer);\
273 snprintf(SUBDIR,sizeof SUBDIR, "%s%s%s%s%s%s%s", \
274 (home&!relh)?webcitdir:basedir, \
275 ((basedir!=webcitdir)&(home&!relh))?basedir:"/", \
276 ((basedir!=webcitdir)&(home&!relh))?"/":"", \
278 (relhome[0]!='\0')?"/":"",\
280 (dirbuffer[0]!='\0')?"/":"");
282 COMPUTE_DIRECTORY(socket_dir);
283 basedir=WWWDIR "/static";
284 COMPUTE_DIRECTORY(static_dir);
285 basedir=WWWDIR "/static/icons";
286 COMPUTE_DIRECTORY(static_icon_dir);
287 basedir=WWWDIR "/static.local";
288 COMPUTE_DIRECTORY(static_local_dir);
290 snprintf(file_crpt_file_key,
291 sizeof file_crpt_file_key,
294 snprintf(file_crpt_file_csr,
295 sizeof file_crpt_file_csr,
298 snprintf(file_crpt_file_cer,
299 sizeof file_crpt_file_cer,
303 /* we should go somewhere we can leave our coredump, if enabled... */
304 lprintf(9, "Changing directory to %s\n", socket_dir);
305 if (chdir(webcitdir) != 0) {
310 * Here's where it all begins.
312 int main(int argc, char **argv)
314 pthread_t SessThread; /* Thread descriptor */
315 pthread_attr_t attr; /* Thread attributes */
316 int a, i; /* General-purpose variables */
317 char tracefile[PATH_MAX];
318 char ip_addr[256]="0.0.0.0";
321 int home_specified=0;
322 char relhome[PATH_MAX]="";
323 char webcitdir[PATH_MAX] = DATADIR;
324 char *pidfile = NULL;
330 #endif /* ENABLE_NLS */
331 char uds_listen_path[PATH_MAX]; /* listen on a unix domain socket? */
332 const char *I18nDumpFile = NULL;
334 WildFireInitBacktrace(argv[0], 2);
338 #ifdef DBG_PRINNT_HOOKS_AT_START
339 /* dbg_PrintHash(HandlerHash, nix, NULL);*/
342 /* Ensure that we are linked to the correct version of libcitadel */
343 if (libcitadel_version_number() < LIBCITADEL_VERSION_NUMBER) {
344 fprintf(stderr, " You are running libcitadel version %d.%02d\n",
345 (libcitadel_version_number() / 100), (libcitadel_version_number() % 100));
346 fprintf(stderr, "WebCit was compiled against version %d.%02d\n",
347 (LIBCITADEL_VERSION_NUMBER / 100), (LIBCITADEL_VERSION_NUMBER % 100));
351 strcpy(uds_listen_path, "");
353 /* Parse command line */
355 while ((a = getopt(argc, argv, "h:i:p:t:T:x:dD:G:cfsZ")) != EOF)
357 while ((a = getopt(argc, argv, "h:i:p:t:T:x:dD:G:cfZ")) != EOF)
361 hdir = strdup(optarg);
363 if (!relh) safestrncpy(webcitdir, hdir,
366 safestrncpy(relhome, relhome,
368 /* free(hdir); TODO: SHOULD WE DO THIS? */
373 running_as_daemon = 1;
376 pidfile = strdup(optarg);
377 running_as_daemon = 1;
380 safestrncpy(ip_addr, optarg, sizeof ip_addr);
383 http_port = atoi(optarg);
384 if (http_port == 0) {
385 safestrncpy(uds_listen_path, optarg, sizeof uds_listen_path);
389 safestrncpy(tracefile, optarg, sizeof tracefile);
390 freopen(tracefile, "w", stdout);
391 freopen(tracefile, "w", stderr);
392 freopen(tracefile, "r", stdin);
395 LoadTemplates = atoi(optarg);
396 dbg_analyze_msg = (LoadTemplates && (1<<1)) != 0;
397 dbg_bactrace_template_errors = (LoadTemplates && (1<<2)) != 0;
403 verbosity = atoi(optarg);
409 server_cookie = malloc(256);
410 if (server_cookie != NULL) {
411 safestrncpy(server_cookie,
412 "Set-cookie: wcserver=",
415 (&server_cookie[strlen(server_cookie)],
417 lprintf(2, "gethostname: %s\n",
427 DumpTemplateI18NStrings = 1;
428 I18nDump = NewStrBufPlain(HKEY("int templatestrings(void)\n{\n"));
429 I18nDumpFile = optarg;
432 fprintf(stderr, "usage: webcit "
433 "[-i ip_addr] [-p http_port] "
434 "[-t tracefile] [-c] [-f] "
435 "[-T Templatedebuglevel] "
436 "[-d] [-Z] [-G i18ndumpfile] "
440 "[remotehost [remoteport]]\n");
445 ctdlhost = argv[optind];
447 ctdlport = argv[optind];
450 /* daemonize, if we were asked to */
451 if (!DumpTemplateI18NStrings && running_as_daemon) {
452 start_daemon(pidfile);
455 signal(SIGHUP, graceful_shutdown);
458 webcit_calc_dirs_n_files(relh, basedir, home, webcitdir, relhome);
459 LoadIconDir(static_icon_dir);
461 /* Tell 'em who's in da house */
462 lprintf(1, PACKAGE_STRING "\n");
463 lprintf(1, "Copyright (C) 1996-2009 by the Citadel development team.\n"
464 "This software is distributed under the terms of the "
465 "GNU General Public License.\n\n"
469 /* initialize the International Bright Young Thing */
471 initialize_locales();
474 locale = setlocale(LC_ALL, "");
476 mo = malloc(strlen(webcitdir) + 20);
477 lprintf(9, "Message catalog directory: %s\n", bindtextdomain("webcit", LOCALEDIR"/locale"));
479 lprintf(9, "Text domain: %s\n", textdomain("webcit"));
480 lprintf(9, "Text domain Charset: %s\n", bind_textdomain_codeset("webcit","UTF8"));
492 initialise_modules();
493 initialize_viewdefs();
497 if (DumpTemplateI18NStrings) {
499 StrBufAppendBufPlain(I18nDump, HKEY("}\n"), 0);
500 if (StrLength(I18nDump) < 50) {
501 lprintf(1, "********************************************************************************\n");
502 lprintf(1, "* No strings found in templates! are you shure they're there? *\n");
503 lprintf(1, "********************************************************************************\n");
506 fd = fopen(I18nDumpFile, "w");
508 lprintf(1, "********************************************************************************\n");
509 lprintf(1, "* unable to open I18N dumpfile [%s] *\n", I18nDumpFile);
510 lprintf(1, "********************************************************************************\n");
513 fwrite(ChrPtr(I18nDump), 1, StrLength(I18nDump), fd);
519 /* Tell libical to return an error instead of aborting if it sees badly formed iCalendar data. */
520 icalerror_errors_are_fatal = 0;
522 /* Use our own prefix on tzid's generated from system tzdata */
523 icaltimezone_set_tzid_prefix("/citadel.org/");
526 * Set up a place to put thread-specific data.
527 * We only need a single pointer per thread - it points to the
528 * wcsession struct to which the thread is currently bound.
530 if (pthread_key_create(&MyConKey, NULL) != 0) {
531 lprintf(1, "Can't create TSD key: %s\n", strerror(errno));
533 InitialiseSemaphores ();
536 * Set up a place to put thread-specific SSL data.
537 * We don't stick this in the wcsession struct because SSL starts
538 * up before the session is bound, and it gets torn down between
542 if (pthread_key_create(&ThreadSSL, NULL) != 0) {
543 lprintf(1, "Can't create TSD key: %s\n", strerror(errno));
548 * Bind the server to our favorite port.
549 * There is no need to check for errors, because ig_tcp_server()
550 * exits if it doesn't succeed.
553 if (!IsEmptyStr(uds_listen_path)) {
554 lprintf(2, "Attempting to create listener socket at %s...\n", uds_listen_path);
555 msock = ig_uds_server(uds_listen_path, LISTEN_QUEUE_LENGTH);
558 lprintf(2, "Attempting to bind to port %d...\n", http_port);
559 msock = ig_tcp_server(ip_addr, http_port, LISTEN_QUEUE_LENGTH);
562 lprintf(2, "Listening on socket %d\n", msock);
563 signal(SIGPIPE, SIG_IGN);
565 pthread_mutex_init(&SessionListMutex, NULL);
568 * Start up the housekeeping thread
570 pthread_attr_init(&attr);
571 pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
572 pthread_create(&SessThread, &attr,
573 (void *(*)(void *)) housekeeping_loop, NULL);
577 * If this is an HTTPS server, fire up SSL
585 /* Start a few initial worker threads */
586 for (i = 0; i < (MIN_WORKER_THREADS); ++i) {
587 spawn_another_worker_thread();
590 /* now the original thread becomes another worker */
592 ShutDownLibCitadel ();
597 void ShutDownWebcit(void)
599 free_zone_directory ();
600 icaltimezone_release_zone_tab ();
601 icalmemory_free_ring ();
602 ShutDownLibCitadel ();
615 * Entry point for worker threads
617 void worker_entry(void)
621 int fail_this_transaction = 0;
624 fd_set readset, tempset;
629 FD_SET(msock, &readset);
632 /* Only one thread can accept at a time */
633 fail_this_transaction = 0;
637 ret = -1; /* just one at once should select... */
638 begin_critical_section(S_SELECT);
641 if (msock > 0) FD_SET(msock, &tempset);
644 if (msock > 0) ret = select(msock+1, &tempset, NULL, NULL, &tv);
645 end_critical_section(S_SELECT);
646 if ((ret < 0) && (errno != EINTR) && (errno != EAGAIN))
647 {/* EINTR and EAGAIN are thrown but not of interest. */
648 lprintf(2, "accept() failed:%d %s\n",
649 errno, strerror(errno));
651 else if ((ret > 0) && (msock > 0) && FD_ISSET(msock, &tempset))
652 {/* Successfully selected, and still not shutting down? Accept! */
653 ssock = accept(msock, NULL, 0);
656 } while ((msock > 0) && (ssock < 0) && (time_to_die == 0));
658 if ((msock == -1)||(time_to_die))
659 {/* ok, we're going down. */
662 /* the first to come here will have to do the cleanup.
663 * make shure its realy just one.
665 begin_critical_section(S_SHUTDOWN);
671 end_critical_section(S_SHUTDOWN);
673 {/* we're the one to cleanup the mess. */
674 lprintf(2, "I'm master shutdown: tagging sessions to be killed.\n");
676 lprintf(2, "master shutdown: waiting for others\n");
677 sleeeeeeeeeep(1); /* wait so some others might finish... */
678 lprintf(2, "master shutdown: cleaning up sessions\n");
680 lprintf(2, "master shutdown: cleaning up libical\n");
684 lprintf(2, "master shutdown exiting!.\n");
689 if (ssock < 0 ) continue;
692 if (ssock > 0) close (ssock);
693 lprintf(2, "inbetween.");
695 } else { /* Got it? do some real work! */
696 /* Set the SO_REUSEADDR socket option */
698 setsockopt(ssock, SOL_SOCKET, SO_REUSEADDR,
701 /* If we are an HTTPS server, go crypto now. */
704 if (starttls(ssock) != 0) {
705 fail_this_transaction = 1;
712 fdflags = fcntl(ssock, F_GETFL);
714 lprintf(1, "unable to get server socket flags! %s \n",
716 fdflags = fdflags | O_NONBLOCK;
717 if (fcntl(ssock, F_SETFD, fdflags) < 0)
718 lprintf(1, "unable to set server socket nonblocking flags! %s \n",
723 if (fail_this_transaction == 0) {
725 /* Perform an HTTP transaction... */
726 context_loop(&ssock);
728 /* Shut down SSL/TLS if required... */
735 /* ...and close the socket. */
737 lingering_close(ssock);
742 } while (!time_to_die);
744 lprintf (1, "bye\n");
750 * logs to stderr if loglevel is lower than the verbosity set at startup
752 * loglevel level of the message
753 * format the printf like format string
754 * ... the strings to put into format
756 int lprintf(int loglevel, const char *format, ...)
760 if (loglevel <= verbosity) {
761 va_start(ap, format);
762 vfprintf(stderr, format, ap);
771 * print the actual stack frame.
773 void wc_backtrace(void)
775 #ifdef HAVE_BACKTRACE
776 void *stack_frames[50];
781 size = backtrace(stack_frames, sizeof(stack_frames) / sizeof(void*));
782 strings = backtrace_symbols(stack_frames, size);
783 for (i = 0; i < size; i++) {
785 lprintf(1, "%s\n", strings[i]);
787 lprintf(1, "%p\n", stack_frames[i]);