2 * WebCit "system dependent" code.
4 * Copyright (c) 1996-2010 by the citadel.org team
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 #include <sys/types.h>
31 #include <sys/socket.h>
33 #include <sys/syslog.h>
35 #if TIME_WITH_SYS_TIME
36 # include <sys/time.h>
40 # include <sys/time.h>
47 #include <sys/resource.h>
48 #include <netinet/in.h>
49 #include <netinet/tcp.h>
50 #include <arpa/inet.h>
64 #ifdef HAVE_SYS_SELECT_H
65 #include <sys/select.h>
71 #include "webserver.h"
72 #include "modules_init.h"
77 pthread_mutex_t Critters[MAX_SEMAPHORES]; /* Things needing locking */
78 pthread_key_t MyConKey; /* TSD key for MyContext() */
79 pthread_key_t MyReq; /* TSD key for MyReq() */
80 int msock; /* master listening socket */
81 int time_to_die = 0; /* Nonzero if server is shutting down */
82 int verbosity = 9; /* Logging level */
84 extern void *context_loop(ParsedHttpHdrs *Hdr);
85 extern void *housekeeping_loop(void);
87 char ctdl_key_dir[PATH_MAX]=SSL_DIR;
88 char file_crpt_file_key[PATH_MAX]="";
89 char file_crpt_file_csr[PATH_MAX]="";
90 char file_crpt_file_cer[PATH_MAX]="";
92 const char editor_absolut_dir[PATH_MAX]=EDITORDIR; /* nailed to what configure gives us. */
93 char static_dir[PATH_MAX]; /* calculated on startup */
94 char static_local_dir[PATH_MAX]; /* calculated on startup */
95 char static_icon_dir[PATH_MAX]; /* where should we find our mime icons? */
96 char *static_dirs[]={ /* needs same sort order as the web mapping */
97 (char*)static_dir, /* our templates on disk */
98 (char*)static_local_dir, /* user provided templates disk */
99 (char*)editor_absolut_dir, /* the editor on disk */
100 (char*)static_icon_dir /* our icons... */
103 void InitialiseSemaphores(void)
107 /* Set up a bunch of semaphores to be used for critical sections */
108 for (i=0; i<MAX_SEMAPHORES; ++i) {
109 pthread_mutex_init(&Critters[i], NULL);
114 * Obtain a semaphore lock to begin a critical section.
116 void begin_critical_section(int which_one)
118 /* lprintf(CTDL_DEBUG, "begin_critical_section(%d)\n", which_one); */
119 pthread_mutex_lock(&Critters[which_one]);
123 * Release a semaphore lock to end a critical section.
125 void end_critical_section(int which_one)
127 pthread_mutex_unlock(&Critters[which_one]);
131 void ShutDownWebcit(void)
133 free_zone_directory ();
134 icaltimezone_release_zone_tab ();
135 icalmemory_free_ring ();
136 ShutDownLibCitadel ();
146 * Entry point for worker threads
148 void worker_entry(void)
152 int fail_this_transaction = 0;
155 memset(&Hdr, 0, sizeof(ParsedHttpHdrs));
156 Hdr.HR.eReqType = eGET;
157 http_new_modules(&Hdr);
160 /* Each worker thread blocks on accept() while waiting for something to do. */
161 fail_this_transaction = 0;
165 --num_threads_executing;
166 ssock = accept(msock, NULL, 0);
167 ++num_threads_executing;
168 if (ssock < 0) fail_this_transaction = 1;
169 } while ((msock > 0) && (ssock < 0) && (time_to_die == 0));
171 if ((msock == -1)||(time_to_die))
172 {/* ok, we're going down. */
175 /* The first thread to get here will have to do the cleanup.
176 * Make sure it's really just one.
178 begin_critical_section(S_SHUTDOWN);
184 end_critical_section(S_SHUTDOWN);
186 {/* we're the one to cleanup the mess. */
187 http_destroy_modules(&Hdr);
188 lprintf(2, "I'm master shutdown: tagging sessions to be killed.\n");
190 lprintf(2, "master shutdown: waiting for others\n");
191 sleeeeeeeeeep(1); /* wait so some others might finish... */
192 lprintf(2, "master shutdown: cleaning up sessions\n");
194 lprintf(2, "master shutdown: cleaning up libical\n");
198 lprintf(2, "master shutdown exiting.\n");
203 if (ssock < 0 ) continue;
205 check_thread_pool_size();
207 /* Now do something. */
209 if (ssock > 0) close (ssock);
210 lprintf(2, "in between.");
213 /* Got it? do some real work! */
214 /* Set the SO_REUSEADDR socket option */
216 setsockopt(ssock, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
218 /* If we are an HTTPS server, go crypto now. */
221 if (starttls(ssock) != 0) {
222 fail_this_transaction = 1;
230 fdflags = fcntl(ssock, F_GETFL);
232 lprintf(1, "unable to get server socket flags! %s \n",
234 fdflags = fdflags | O_NONBLOCK;
235 if (fcntl(ssock, F_SETFL, fdflags) < 0)
236 lprintf(1, "unable to set server socket nonblocking flags! %s \n",
240 if (fail_this_transaction == 0) {
241 Hdr.http_sock = ssock;
243 /* Perform an HTTP transaction... */
246 /* Shut down SSL/TLS if required... */
253 /* ...and close the socket. */
254 if (Hdr.http_sock > 0) {
255 lingering_close(ssock);
257 http_detach_modules(&Hdr);
263 } while (!time_to_die);
265 http_destroy_modules(&Hdr);
266 lprintf (1, "Thread exiting.\n");
272 * logs to stderr if loglevel is lower than the verbosity set at startup
274 * loglevel level of the message
275 * format the printf like format string
276 * ... the strings to put into format
278 int lprintf(int loglevel, const char *format, ...)
282 if (loglevel <= verbosity) {
283 va_start(ap, format);
284 vfprintf(stderr, format, ap);
292 * Shut us down the regular way.
293 * signum is the signal we want to forward
296 void graceful_shutdown_watcher(int signum) {
297 lprintf (1, "Watcher thread exiting.\n");
298 kill(current_child, signum);
299 if (signum != SIGHUP)
305 * Shut us down the regular way.
306 * signum is the signal we want to forward
309 void graceful_shutdown(int signum) {
313 lprintf (1, "WebCit is being shut down on signal %d.\n", signum);
325 * Start running as a daemon.
327 void start_daemon(char *pid_file)
338 /* Close stdin/stdout/stderr and replace them with /dev/null.
339 * We don't just call close() because we don't want these fd's
340 * to be reused for other files.
344 signal(SIGHUP, SIG_IGN);
345 signal(SIGINT, SIG_IGN);
346 signal(SIGQUIT, SIG_IGN);
355 rvfp = freopen("/dev/null", "r", stdin);
356 rvfp = freopen("/dev/null", "w", stdout);
357 rvfp = freopen("/dev/null", "w", stderr);
358 signal(SIGTERM, graceful_shutdown_watcher);
359 signal(SIGHUP, graceful_shutdown_watcher);
362 current_child = fork();
365 if (current_child < 0) {
367 ShutDownLibCitadel ();
371 else if (current_child == 0) { /* child process */
372 signal(SIGHUP, graceful_shutdown);
374 return; /* continue starting webcit. */
376 else { /* watcher process */
378 fp = fopen(pid_file, "w");
380 fprintf(fp, "%d\n", getpid());
384 waitpid(current_child, &status, 0);
389 /* Did the main process exit with an actual exit code? */
390 if (WIFEXITED(status)) {
392 /* Exit code 0 means the watcher should exit */
393 if (WEXITSTATUS(status) == 0) {
397 /* Exit code 101-109 means the watcher should exit */
398 else if ( (WEXITSTATUS(status) >= 101) && (WEXITSTATUS(status) <= 109) ) {
402 /* Any other exit code means we should restart. */
408 /* Any other type of termination (signals, etc.) should also restart. */
413 } while (do_restart);
418 ShutDownLibCitadel ();
419 exit(WEXITSTATUS(status));
424 * Spawn an additional worker thread into the pool.
426 void spawn_another_worker_thread()
428 pthread_t SessThread; /* Thread descriptor */
429 pthread_attr_t attr; /* Thread attributes */
432 ++num_threads_existing;
433 ++num_threads_executing;
435 /* set attributes for the new thread */
436 pthread_attr_init(&attr);
437 pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
440 * Our per-thread stacks need to be bigger than the default size,
441 * otherwise the MIME parser crashes on FreeBSD.
443 if ((ret = pthread_attr_setstacksize(&attr, 1024 * 1024))) {
444 lprintf(1, "pthread_attr_setstacksize: %s\n", strerror(ret));
445 pthread_attr_destroy(&attr);
448 /* now create the thread */
449 if (pthread_create(&SessThread, &attr, (void *(*)(void *)) worker_entry, NULL) != 0) {
450 lprintf(1, "Can't create thread: %s\n", strerror(errno));
453 /* free up the attributes */
454 pthread_attr_destroy(&attr);
459 webcit_calc_dirs_n_files(int relh, const char *basedir, int home, char *webcitdir, char *relhome)
461 char dirbuffer[PATH_MAX]="";
462 /* calculate all our path on a central place */
463 /* where to keep our config */
465 #define COMPUTE_DIRECTORY(SUBDIR) memcpy(dirbuffer,SUBDIR, sizeof dirbuffer);\
466 snprintf(SUBDIR,sizeof SUBDIR, "%s%s%s%s%s%s%s", \
467 (home&!relh)?webcitdir:basedir, \
468 ((basedir!=webcitdir)&(home&!relh))?basedir:"/", \
469 ((basedir!=webcitdir)&(home&!relh))?"/":"", \
471 (relhome[0]!='\0')?"/":"",\
473 (dirbuffer[0]!='\0')?"/":"");
475 COMPUTE_DIRECTORY(socket_dir);
476 basedir=WWWDIR "/static";
477 COMPUTE_DIRECTORY(static_dir);
478 basedir=WWWDIR "/static/icons";
479 COMPUTE_DIRECTORY(static_icon_dir);
480 basedir=WWWDIR "/static.local";
481 COMPUTE_DIRECTORY(static_local_dir);
482 StripSlashes(static_dir, 1);
483 StripSlashes(static_icon_dir, 1);
484 StripSlashes(static_local_dir, 1);
486 snprintf(file_crpt_file_key,
487 sizeof file_crpt_file_key,
490 snprintf(file_crpt_file_csr,
491 sizeof file_crpt_file_csr,
494 snprintf(file_crpt_file_cer,
495 sizeof file_crpt_file_cer,
499 /* we should go somewhere we can leave our coredump, if enabled... */
500 lprintf(9, "Changing directory to %s\n", socket_dir);
501 if (chdir(webcitdir) != 0) {
506 void drop_root(uid_t UID)
508 struct passwd pw, *pwp = NULL;
511 * Now that we've bound the sockets, change to the Citadel user id and its
512 * corresponding group ids
516 #ifdef HAVE_GETPWUID_R
517 #ifdef SOLARIS_GETPWUID
518 pwp = getpwuid_r(UID, &pw, pwbuf, sizeof(pwbuf));
519 #else // SOLARIS_GETPWUID
520 getpwuid_r(UID, &pw, pwbuf, sizeof(pwbuf), &pwp);
521 #endif // SOLARIS_GETPWUID
522 #else // HAVE_GETPWUID_R
524 #endif // HAVE_GETPWUID_R
527 lprintf(CTDL_CRIT, "WARNING: getpwuid(%ld): %s\n"
528 "Group IDs will be incorrect.\n", UID,
531 initgroups(pw.pw_name, pw.pw_gid);
532 if (setgid(pw.pw_gid))
533 lprintf(CTDL_CRIT, "setgid(%ld): %s\n", (long)pw.pw_gid,
536 lprintf(CTDL_INFO, "Changing uid to %ld\n", (long)UID);
537 if (setuid(UID) != 0) {
538 lprintf(CTDL_CRIT, "setuid() failed: %s\n", strerror(errno));
540 #if defined (HAVE_SYS_PRCTL_H) && defined (PR_SET_DUMPABLE)
541 prctl(PR_SET_DUMPABLE, 1);
548 * print the actual stack frame.
550 void wc_backtrace(void)
552 #ifdef HAVE_BACKTRACE
553 void *stack_frames[50];
558 size = backtrace(stack_frames, sizeof(stack_frames) / sizeof(void*));
559 strings = backtrace_symbols(stack_frames, size);
560 for (i = 0; i < size; i++) {
562 lprintf(1, "%s\n", strings[i]);
564 lprintf(1, "%p\n", stack_frames[i]);