2 * WebCit "system dependent" code.
4 * Copyright (c) 1996-2011 by the citadel.org team
6 * This program is open source 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 */
83 extern void *context_loop(ParsedHttpHdrs *Hdr);
84 extern void *housekeeping_loop(void);
85 extern void do_housekeeping(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... */
105 void InitialiseSemaphores(void)
109 /* Set up a bunch of semaphores to be used for critical sections */
110 for (i=0; i<MAX_SEMAPHORES; ++i) {
111 pthread_mutex_init(&Critters[i], NULL);
116 syslog(2, "Failed to open exit pipe: %d [%s]\n",
125 * Obtain a semaphore lock to begin a critical section.
127 void begin_critical_section(int which_one)
129 pthread_mutex_lock(&Critters[which_one]);
133 * Release a semaphore lock to end a critical section.
135 void end_critical_section(int which_one)
137 pthread_mutex_unlock(&Critters[which_one]);
141 void ShutDownWebcit(void)
143 free_zone_directory ();
144 icaltimezone_release_zone_tab ();
145 icalmemory_free_ring ();
146 ShutDownLibCitadel ();
156 * Entry point for worker threads
158 void worker_entry(void)
162 int fail_this_transaction = 0;
165 memset(&Hdr, 0, sizeof(ParsedHttpHdrs));
166 Hdr.HR.eReqType = eGET;
167 http_new_modules(&Hdr);
170 /* Each worker thread blocks on accept() while waiting for something to do. */
171 fail_this_transaction = 0;
176 --num_threads_executing;
178 FD_SET(msock, &wset);
179 FD_SET(ExitPipe[1], &wset);
181 select(msock + 1, NULL, &wset, NULL, NULL);
185 ssock = accept(msock, NULL, 0);
186 ++num_threads_executing;
187 if (ssock < 0) fail_this_transaction = 1;
188 } while ((msock > 0) && (ssock < 0) && (time_to_die == 0));
190 if ((msock == -1)||(time_to_die))
191 {/* ok, we're going down. */
194 /* The first thread to get here will have to do the cleanup.
195 * Make sure it's really just one.
197 begin_critical_section(S_SHUTDOWN);
203 end_critical_section(S_SHUTDOWN);
205 {/* we're the one to cleanup the mess. */
206 http_destroy_modules(&Hdr);
207 syslog(2, "I'm master shutdown: tagging sessions to be killed.\n");
209 syslog(2, "master shutdown: waiting for others\n");
210 sleeeeeeeeeep(1); /* wait so some others might finish... */
211 syslog(2, "master shutdown: cleaning up sessions\n");
213 syslog(2, "master shutdown: cleaning up libical\n");
217 syslog(2, "master shutdown exiting.\n");
222 if (ssock < 0 ) continue;
224 check_thread_pool_size();
226 /* Now do something. */
228 if (ssock > 0) close (ssock);
229 syslog(2, "in between.");
232 /* Got it? do some real work! */
233 /* Set the SO_REUSEADDR socket option */
235 setsockopt(ssock, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
237 /* If we are an HTTPS server, go crypto now. */
240 if (starttls(ssock) != 0) {
241 fail_this_transaction = 1;
249 fdflags = fcntl(ssock, F_GETFL);
251 syslog(1, "unable to get server socket flags! %s \n",
253 fdflags = fdflags | O_NONBLOCK;
254 if (fcntl(ssock, F_SETFL, fdflags) < 0)
255 syslog(1, "unable to set server socket nonblocking flags! %s \n",
259 if (fail_this_transaction == 0) {
260 Hdr.http_sock = ssock;
262 /* Perform an HTTP transaction... */
265 /* Shut down SSL/TLS if required... */
272 /* ...and close the socket. */
273 if (Hdr.http_sock > 0) {
274 lingering_close(ssock);
276 http_detach_modules(&Hdr);
282 } while (!time_to_die);
284 http_destroy_modules(&Hdr);
285 syslog(1, "Thread exiting.\n");
291 * Shut us down the regular way.
292 * signum is the signal we want to forward
295 void graceful_shutdown_watcher(int signum) {
296 syslog(1, "Watcher thread exiting.\n");
297 write(ExitPipe[0], HKEY(" "));
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 syslog(1, "WebCit is being shut down on signal %d.\n", signum);
321 write(ExitPipe[0], HKEY(" "));
326 * Start running as a daemon.
328 void start_daemon(char *pid_file)
337 /* Close stdin/stdout/stderr and replace them with /dev/null.
338 * We don't just call close() because we don't want these fd's
339 * to be reused for other files.
343 signal(SIGHUP, SIG_IGN);
344 signal(SIGINT, SIG_IGN);
345 signal(SIGQUIT, SIG_IGN);
354 freopen("/dev/null", "r", stdin);
355 freopen("/dev/null", "w", stdout);
356 freopen("/dev/null", "w", stderr);
357 signal(SIGTERM, graceful_shutdown_watcher);
358 signal(SIGHUP, graceful_shutdown_watcher);
361 current_child = fork();
364 if (current_child < 0) {
366 ShutDownLibCitadel ();
370 else if (current_child == 0) { /* child process */
371 signal(SIGHUP, graceful_shutdown);
373 return; /* continue starting webcit. */
375 else { /* watcher process */
377 fp = fopen(pid_file, "w");
379 fprintf(fp, "%d\n", getpid());
383 waitpid(current_child, &status, 0);
388 /* Did the main process exit with an actual exit code? */
389 if (WIFEXITED(status)) {
391 /* Exit code 0 means the watcher should exit */
392 if (WEXITSTATUS(status) == 0) {
396 /* Exit code 101-109 means the watcher should exit */
397 else if ( (WEXITSTATUS(status) >= 101) && (WEXITSTATUS(status) <= 109) ) {
401 /* Any other exit code means we should restart. */
407 /* Any other type of termination (signals, etc.) should also restart. */
412 } while (do_restart);
417 ShutDownLibCitadel ();
418 exit(WEXITSTATUS(status));
423 * Spawn an additional worker thread into the pool.
425 void spawn_another_worker_thread()
427 pthread_t SessThread; /* Thread descriptor */
428 pthread_attr_t attr; /* Thread attributes */
431 ++num_threads_existing;
432 ++num_threads_executing;
434 /* set attributes for the new thread */
435 pthread_attr_init(&attr);
436 pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
439 * Our per-thread stacks need to be bigger than the default size,
440 * otherwise the MIME parser crashes on FreeBSD.
442 if ((ret = pthread_attr_setstacksize(&attr, 1024 * 1024))) {
443 syslog(1, "pthread_attr_setstacksize: %s\n", strerror(ret));
444 pthread_attr_destroy(&attr);
447 /* now create the thread */
448 if (pthread_create(&SessThread, &attr, (void *(*)(void *)) worker_entry, NULL) != 0) {
449 syslog(1, "Can't create thread: %s\n", strerror(errno));
452 /* free up the attributes */
453 pthread_attr_destroy(&attr);
458 webcit_calc_dirs_n_files(int relh, const char *basedir, int home, char *webcitdir, char *relhome)
460 char dirbuffer[PATH_MAX]="";
461 /* calculate all our path on a central place */
462 /* where to keep our config */
464 #define COMPUTE_DIRECTORY(SUBDIR) memcpy(dirbuffer,SUBDIR, sizeof dirbuffer);\
465 snprintf(SUBDIR,sizeof SUBDIR, "%s%s%s%s%s%s%s", \
466 (home&!relh)?webcitdir:basedir, \
467 ((basedir!=webcitdir)&(home&!relh))?basedir:"/", \
468 ((basedir!=webcitdir)&(home&!relh))?"/":"", \
470 (relhome[0]!='\0')?"/":"",\
472 (dirbuffer[0]!='\0')?"/":"");
474 COMPUTE_DIRECTORY(socket_dir);
475 basedir=WWWDIR "/static";
476 COMPUTE_DIRECTORY(static_dir);
477 basedir=WWWDIR "/static/icons";
478 COMPUTE_DIRECTORY(static_icon_dir);
479 basedir=WWWDIR "/static.local";
480 COMPUTE_DIRECTORY(static_local_dir);
481 StripSlashes(static_dir, 1);
482 StripSlashes(static_icon_dir, 1);
483 StripSlashes(static_local_dir, 1);
485 snprintf(file_crpt_file_key,
486 sizeof file_crpt_file_key,
489 snprintf(file_crpt_file_csr,
490 sizeof file_crpt_file_csr,
493 snprintf(file_crpt_file_cer,
494 sizeof file_crpt_file_cer,
498 /* we should go somewhere we can leave our coredump, if enabled... */
499 syslog(9, "Changing directory to %s\n", socket_dir);
500 if (chdir(webcitdir) != 0) {
505 void drop_root(uid_t UID)
507 struct passwd pw, *pwp = NULL;
510 * Now that we've bound the sockets, change to the Citadel user id and its
511 * corresponding group ids
515 #ifdef HAVE_GETPWUID_R
516 #ifdef SOLARIS_GETPWUID
517 pwp = getpwuid_r(UID, &pw, pwbuf, sizeof(pwbuf));
518 #else /* SOLARIS_GETPWUID */
519 getpwuid_r(UID, &pw, pwbuf, sizeof(pwbuf), &pwp);
520 #endif /* SOLARIS_GETPWUID */
521 #else /* HAVE_GETPWUID_R */
523 #endif /* HAVE_GETPWUID_R */
526 syslog(LOG_CRIT, "WARNING: getpwuid(%d): %s\n"
527 "Group IDs will be incorrect.\n", UID,
530 initgroups(pw.pw_name, pw.pw_gid);
531 if (setgid(pw.pw_gid))
532 syslog(LOG_CRIT, "setgid(%ld): %s\n", (long)pw.pw_gid,
535 syslog(LOG_INFO, "Changing uid to %ld\n", (long)UID);
536 if (setuid(UID) != 0) {
537 syslog(LOG_CRIT, "setuid() failed: %s\n", strerror(errno));
539 #if defined (HAVE_SYS_PRCTL_H) && defined (PR_SET_DUMPABLE)
540 prctl(PR_SET_DUMPABLE, 1);
547 * print the actual stack frame.
549 void wc_backtrace(void)
551 #ifdef HAVE_BACKTRACE
552 void *stack_frames[50];
557 size = backtrace(stack_frames, sizeof(stack_frames) / sizeof(void*));
558 strings = backtrace_symbols(stack_frames, size);
559 for (i = 0; i < size; i++) {
561 syslog(1, "%s\n", strings[i]);
563 syslog(1, "%p\n", stack_frames[i]);