/*
- * context_loop.c
- *
+ * $Id$
+ */
+/**
+ * \defgroup WebServerII some of the webserver stuff.
* This is the other half of the webserver. It handles the task of hooking
- * up HTTP requests with the session they belong to, using HTTP cookies to
+ * up HTTP requests with the sessions they belong to, using HTTP cookies to
* keep track of things. If the HTTP request doesn't belong to any currently
- * active session, a new session is spawned.
+ * active session, a new session is started.
*
- * $Id$
*/
-
-#include <ctype.h>
-#include <stdlib.h>
-#ifdef HAVE_UNISTD_H
-#include <unistd.h>
-#endif
-#include <stdio.h>
-#ifdef HAVE_FCNTL_H
-#include <fcntl.h>
-#endif
-#include <signal.h>
-#include <sys/types.h>
-#include <sys/wait.h>
-#include <sys/socket.h>
-#ifdef HAVE_SYS_TIME_H
-#include <sys/time.h>
-#endif
-#ifdef HAVE_LIMITS_H
-#include <limits.h>
-#endif
-#include <netinet/in.h>
-#include <netdb.h>
-#include <string.h>
-#include <errno.h>
-#include <stdarg.h>
-#include <pthread.h>
+/*@{*/
#include "webcit.h"
#include "webserver.h"
-/*
- * We keep one of these around for each active session
+/** Only one thread may manipulate SessionList at a time... */
+pthread_mutex_t SessionListMutex;
+
+struct wcsession *SessionList = NULL; /**< our sessions ????*/
+
+pthread_key_t MyConKey; /**< TSD key for MySession() */
+
+
+/**
+ * \brief free the memory used for viewing atachments
+ * \param sess the session object to destroy
+ */
+void free_attachments(struct wcsession *sess) {
+ struct wc_attachment *att;
+
+ while (sess->first_attachment != NULL) {
+ att = sess->first_attachment;
+ sess->first_attachment = sess->first_attachment->next;
+ free(att->data);
+ free(att);
+ }
+}
+
+/**
+ * \brief what??????
*/
-struct wc_session {
- struct wc_session *next; /* Next session in list */
- int session_id; /* Session ID */
- int inpipe[2]; /* Data from webserver to session */
- int outpipe[2]; /* Data from session to webserver */
- pthread_mutex_t critter; /* Critical section uses pipes */
- };
+void do_housekeeping(void)
+{
+ struct wcsession *sptr, *ss;
+ struct wcsession *sessions_to_kill = NULL;
+ int num_sessions = 0;
+ static int num_threads = MIN_WORKER_THREADS;
+
+ /**
+ * Lock the session list, moving any candidates for euthanasia into
+ * a separate list.
+ */
+ pthread_mutex_lock(&SessionListMutex);
+ num_sessions = 0;
+ for (sptr = SessionList; sptr != NULL; sptr = sptr->next) {
+ ++num_sessions;
+
+ /** Kill idle sessions */
+ if ((time(NULL) - (sptr->lastreq)) >
+ (time_t) WEBCIT_TIMEOUT) {
+ sptr->killthis = 1;
+ }
+
+ /** Remove sessions flagged for kill */
+ if (sptr->killthis) {
-struct wc_session *SessionList = NULL;
+ /** remove session from linked list */
+ if (sptr == SessionList) {
+ SessionList = SessionList->next;
+ }
+ else for (ss=SessionList;ss!=NULL;ss=ss->next) {
+ if (ss->next == sptr) {
+ ss->next = ss->next->next;
+ }
+ }
-/* Only one thread may manipulate SessionList at a time... */
-pthread_mutex_t MasterCritter;
+ sptr->next = sessions_to_kill;
+ sessions_to_kill = sptr;
+ }
+ }
+ pthread_mutex_unlock(&SessionListMutex);
-int GenerateSessionID(void) {
- return getpid();
+ /**
+ * Now free up and destroy the culled sessions.
+ */
+ while (sessions_to_kill != NULL) {
+ lprintf(3, "Destroying session %d\n", sessions_to_kill->wc_session);
+ pthread_mutex_lock(&sessions_to_kill->SessionMutex);
+ close(sessions_to_kill->serv_sock);
+ close(sessions_to_kill->chat_sock);
+ if (sessions_to_kill->preferences != NULL) {
+ free(sessions_to_kill->preferences);
+ }
+ if (sessions_to_kill->cache_fold != NULL) {
+ free(sessions_to_kill->cache_fold);
+ }
+ free_attachments(sessions_to_kill);
+ pthread_mutex_unlock(&sessions_to_kill->SessionMutex);
+ sptr = sessions_to_kill->next;
+ free(sessions_to_kill);
+ sessions_to_kill = sptr;
+ --num_sessions;
}
+ /**
+ * If there are more sessions than threads, then we should spawn
+ * more threads ... up to a predefined maximum.
+ */
+ while ( (num_sessions > num_threads)
+ && (num_threads <= MAX_WORKER_THREADS) ) {
+ spawn_another_worker_thread();
+ ++num_threads;
+ lprintf(3, "There are %d sessions and %d threads active.\n",
+ num_sessions, num_threads);
+ }
+}
-void gets0(int fd, char buf[]) {
- buf[0] = 0;
- do {
- buf[strlen(buf)+1] = 0;
- read(fd, &buf[strlen(buf)], 1);
- } while (buf[strlen(buf)-1] >= 32);
- buf[strlen(buf)-1] = 0;
+/**
+ * \brief Wake up occasionally and clean house
+ */
+void housekeeping_loop(void)
+{
+ while (1) {
+ sleeeeeeeeeep(HOUSEKEEPING);
+ do_housekeeping();
}
+}
-/*
- * Collapse multiple cookies on one line
+
+/**
+ * \brief Create a Session id
+ * Generate a unique WebCit session ID (which is not the same thing as the
+ * Citadel session ID).
+ *
+ * \todo FIXME ... ensure that session number is truly unique
+ *
+ */
+int GenerateSessionID(void)
+{
+ static int seq = (-1);
+
+ if (seq < 0) {
+ seq = (int) time(NULL);
+ }
+
+ return ++seq;
+}
+
+
+/**
+ * \brief Collapse multiple cookies on one line
+ * \param sock a socket?
+ * \param buf some bunch of chars?
+ * \param hold hold what?
*/
-void req_gets(int sock, char *buf, char *hold) {
+int req_gets(int sock, char *buf, char *hold)
+{
int a;
- if (strlen(hold)==0) {
- client_gets(sock, buf);
- }
- else {
- strcpy(buf, hold);
- }
+ if (strlen(hold) == 0) {
+ strcpy(buf, "");
+ a = client_getln(sock, buf, SIZ);
+ if (a<1) return(-1);
+ } else {
+ safestrncpy(buf, hold, SIZ);
+ }
strcpy(hold, "");
if (!strncasecmp(buf, "Cookie: ", 8)) {
- for (a=0; a<strlen(buf); ++a) if (buf[a]==';') {
- sprintf(hold, "Cookie: %s", &buf[a+1]);
- buf[a]=0;
- while (isspace(hold[8])) strcpy(&hold[8], &hold[9]);
- return;
+ for (a = 0; a < strlen(buf); ++a)
+ if (buf[a] == ';') {
+ sprintf(hold, "Cookie: %s", &buf[a + 1]);
+ buf[a] = 0;
+ while (isspace(hold[8]))
+ strcpy(&hold[8], &hold[9]);
+ return(0);
}
- }
}
-/*
- * Grab a lock on the session, so other threads don't try to access
- * the pipes at the same time.
- */
-static void lock_session(struct wc_session *session) {
- printf("Locking session %d...\n", session->session_id);
- pthread_mutex_lock(&session->critter);
- printf(" ...got lock\n");
- }
+ return(0);
+}
-/*
- * Let go of the lock.
+/**
+ * \brief close some fd for some reason???
+ * \param fd the fd to close??????
+ * lingering_close() a`la Apache. see
+ * http://www.apache.org/docs/misc/fin_wait_2.html for rationale
*/
-static void unlock_session(struct wc_session *session) {
- printf("Unlocking.\n");
- pthread_mutex_unlock(&session->critter);
- }
-extern const char *defaulthost;
-extern const char *defaultport;
+int lingering_close(int fd)
+{
+ char buf[SIZ];
+ int i;
+ fd_set set;
+ struct timeval tv, start;
-/*
- * This loop gets called once for every HTTP connection made to WebCit.
+ gettimeofday(&start, NULL);
+ shutdown(fd, 1);
+ do {
+ do {
+ gettimeofday(&tv, NULL);
+ tv.tv_sec = SLEEPING - (tv.tv_sec - start.tv_sec);
+ tv.tv_usec = start.tv_usec - tv.tv_usec;
+ if (tv.tv_usec < 0) {
+ tv.tv_sec--;
+ tv.tv_usec += 1000000;
+ }
+ FD_ZERO(&set);
+ FD_SET(fd, &set);
+ i = select(fd + 1, &set, NULL, NULL, &tv);
+ } while (i == -1 && errno == EINTR);
+
+ if (i <= 0)
+ break;
+
+ i = read(fd, buf, sizeof buf);
+ } while (i != 0 && (i != -1 || errno == EINTR));
+
+ return close(fd);
+}
+
+
+
+/**
+ * \brief sanity requests
+ * Check for bogus requests coming from (for example) brain-dead
+ * Windoze boxes that are infected with the latest worm-of-the-week.
+ * If we detect one of these, bail out without bothering our Citadel
+ * server.
+ * \param http_cmd the cmd to check
*/
-void *context_loop(int sock) {
- char (*req)[256];
- char buf[256], hold[256];
- char http_method[256];
- int num_lines = 0;
- int a;
- int f;
- int desired_session = 0;
- char str_session[256];
- struct wc_session *sptr;
- struct wc_session *TheSession;
- int ContentLength;
- int CloseSession = 0;
-
- if ((req = malloc((long)sizeof(char[256][256]))) == NULL) {
- sprintf(buf, "Can't malloc buffers; dropping connection.\n");
- fprintf(stderr, "%s", buf);
- write(sock, buf, strlen(buf));
- close (sock);
- pthread_exit(NULL);
- }
+int is_bogus(char *http_cmd) {
+
+ if (!strncasecmp(http_cmd, "GET /scripts/root.exe", 21)) return(1);
+ if (!strncasecmp(http_cmd, "GET /c/winnt", 12)) return(2);
+ if (!strncasecmp(http_cmd, "GET /MSADC/", 11)) return(3);
- printf("Reading request from socket %d\n", sock);
+ return(0); /* probably ok */
+}
- /*
+
+
+/**
+ * \brief handle one request
+ * This loop gets called once for every HTTP connection made to WebCit. At
+ * this entry point we have an HTTP socket with a browser allegedly on the
+ * other end, but we have not yet bound to a WebCit session.
+ *
+ * The job of this function is to locate the correct session and bind to it,
+ * or create a session if necessary and bind to it, then run the WebCit
+ * transaction loop. Afterwards, we unbind from the session. When this
+ * function returns, the worker thread is then free to handle another
+ * transaction.
+ * \param sock the socket we will put our answer to
+ */
+void context_loop(int sock)
+{
+ struct httprequest *req = NULL;
+ struct httprequest *last = NULL;
+ struct httprequest *hptr;
+ char buf[SIZ], hold[SIZ];
+ int desired_session = 0;
+ int got_cookie = 0;
+ int gzip_ok = 0;
+ struct wcsession *TheSession, *sptr;
+ char httpauth_string[1024];
+ char httpauth_user[1024];
+ char httpauth_pass[1024];
+ char accept_language[256];
+ char *ptr = NULL;
+ int session_is_new = 0;
+
+ strcpy(httpauth_string, "");
+ strcpy(httpauth_user, DEFAULT_HTTPAUTH_USER);
+ strcpy(httpauth_pass, DEFAULT_HTTPAUTH_PASS);
+
+ /**
* Find out what it is that the web browser is asking for
*/
- ContentLength = 0;
+ memset(hold, 0, sizeof(hold));
do {
- req_gets(sock, buf, hold);
- if (!strncasecmp(buf, "Cookie: wc_session=", 19)) {
- desired_session = atoi(&buf[19]);
- }
- if (!strncasecmp(buf, "Content-length: ", 16)) {
- ContentLength = atoi(&buf[16]);
+ if (req_gets(sock, buf, hold) < 0) return;
+
+ /**
+ * Can we compress?
+ */
+ if (!strncasecmp(buf, "Accept-encoding:", 16)) {
+ if (strstr(&buf[16], "gzip")) {
+ gzip_ok = 1;
}
- strcpy(&req[num_lines++][0], buf);
- } while(strlen(buf)>0);
+ }
- strcpy(http_method, &req[0][0]);
- for (a=0; a<strlen(http_method); ++a) {
- if (isspace(http_method[a])) http_method[a]=0;
+ /**
+ * Browser-based sessions use cookies for session authentication
+ */
+ if (!strncasecmp(buf, "Cookie: webcit=", 15)) {
+ cookie_to_stuff(&buf[15], &desired_session,
+ NULL, 0, NULL, 0, NULL, 0);
+ got_cookie = 1;
}
- /*
- * See if there's an existing session open with the desired ID
- */
- TheSession = NULL;
- if (desired_session != 0) {
- pthread_mutex_lock(&MasterCritter);
- for (sptr=SessionList; sptr!=NULL; sptr=sptr->next) {
- if (sptr->session_id == desired_session) {
- TheSession = sptr;
- lock_session(TheSession);
- }
- }
- pthread_mutex_unlock(&MasterCritter);
+ /**
+ * GroupDAV-based sessions use HTTP authentication
+ */
+ if (!strncasecmp(buf, "Authorization: Basic ", 21)) {
+ CtdlDecodeBase64(httpauth_string, &buf[21], strlen(&buf[21]));
+ extract_token(httpauth_user, httpauth_string, 0, ':', sizeof httpauth_user);
+ extract_token(httpauth_pass, httpauth_string, 1, ':', sizeof httpauth_pass);
}
- /*
- * Create a new session if we have to
- */
- if (TheSession == NULL) {
- printf("Creating a new session\n");
- pthread_mutex_lock(&MasterCritter);
- TheSession = (struct wc_session *)
- malloc(sizeof(struct wc_session));
- TheSession->session_id = GenerateSessionID();
- pipe(TheSession->inpipe);
- pipe(TheSession->outpipe);
- pthread_mutex_init(&TheSession->critter, NULL);
- lock_session(TheSession);
- TheSession->next = SessionList;
- SessionList = TheSession;
- pthread_mutex_unlock(&MasterCritter);
- sprintf(str_session, "%d", TheSession->session_id);
- f = fork();
- fflush(stdout); fflush(stdin);
- if (f==0) {
- dup2(TheSession->inpipe[0], 0);
- dup2(TheSession->outpipe[1], 1);
- /* Close the ends of the pipes that we're not using */
- close(TheSession->inpipe[1]);
- close(TheSession->outpipe[0]);
- close(sock);
- execlp("./webcit", "webcit", str_session, defaulthost,
- defaultport, NULL);
- printf("HTTP/1.0 404 WebCit Failure\n\n");
- printf("Server: %s\n", SERVER);
- printf("Content-type: text/html\n");
- printf("Content-length: 76\n");
- printf("\n");
- printf("<HTML><HEAD><TITLE>Error</TITLE></HEAD>\n");
- printf("<BODY BACKGROUND=\"/image&name=background\" TEXT=\"#000000\" LINK=\"#004400\">execlp() failed</BODY></HTML>\n");
- exit(0);
- }
- /* Close the ends of the pipes that we're not using */
- close(TheSession->inpipe[0]);
- close(TheSession->outpipe[1]);
+ if (!strncasecmp(buf, "If-Modified-Since: ", 19)) {
+ if_modified_since = httpdate_to_timestamp(&buf[19]);
}
- /*
- * Send the request to the appropriate session...
- */
- printf(" Writing %d lines of command\n", num_lines);
- printf("%s\n", &req[0][0]);
- for (a=0; a<num_lines; ++a) {
- write(TheSession->inpipe[1], &req[a][0], strlen(&req[a][0]));
- write(TheSession->inpipe[1], "\n", 1);
+ if (!strncasecmp(buf, "Accept-Language: ", 17)) {
+ safestrncpy(accept_language, &buf[17], sizeof accept_language);
}
- printf(" Writing %d bytes of content\n", ContentLength);
- if (ContentLength > 0) {
- while (ContentLength > 0) {
- a = ContentLength;
- if (a > sizeof buf) a = sizeof buf;
- if (!client_read(sock, buf, a)) goto end;
- if (write(TheSession->inpipe[1], buf, a) != a) goto end;
- ContentLength -= a;
- }
- }
+ /**
+ * Read in the request
+ */
+ hptr = (struct httprequest *)
+ malloc(sizeof(struct httprequest));
+ if (req == NULL)
+ req = hptr;
+ else
+ last->next = hptr;
+ hptr->next = NULL;
+ last = hptr;
+
+ safestrncpy(hptr->line, buf, sizeof hptr->line);
+
+ } while (strlen(buf) > 0);
+
+ /**
+ * If the request is prefixed by "/webcit" then chop that off. This
+ * allows a front end web server to forward all /webcit requests to us
+ * while still using the same web server port for other things.
+ */
+
+ ptr = strstr(req->line, " /webcit "); /*< Handle "/webcit" */
+ if (ptr != NULL) {
+ strcpy(ptr+2, ptr+8);
+ }
- /*
- * ...and get the response.
+ ptr = strstr(req->line, " /webcit"); /*< Handle "/webcit/" */
+ if (ptr != NULL) {
+ strcpy(ptr+1, ptr+8);
+ }
+
+ /** Begin parsing the request. */
+
+ safestrncpy(buf, req->line, sizeof buf);
+ lprintf(5, "HTTP: %s\n", buf);
+
+ /** Check for bogus requests */
+ if (is_bogus(buf)) goto bail;
+
+ /**
+ * Strip out the method, leaving the URL up front...
*/
- printf(" Reading response\n");
- ContentLength = 0;
- do {
- gets0(TheSession->outpipe[0], buf);
- write(sock, buf, strlen(buf));
- write(sock, "\n", 1);
- if (!strncasecmp(buf, "Content-length: ", 16))
- ContentLength = atoi(&buf[16]);
- if (!strcasecmp(buf, "X-WebCit-Session: close")) {
- CloseSession = 1;
- }
- } while (strlen(buf) > 0);
+ remove_token(buf, 0, ' ');
+ if (buf[1]==' ') buf[1]=0;
- printf(" Reading %d bytes of content\n", ContentLength);
- while(ContentLength--) {
- read(TheSession->outpipe[0], buf, 1);
- write(sock, buf, 1);
- }
+ /**
+ * While we're at it, gracefully handle requests for the
+ * robots.txt and favicon.ico files.
+ */
+ if (!strncasecmp(buf, "/robots.txt", 11)) {
+ strcpy(req->line, "GET /static/robots.txt"
+ "?force_close_session=yes HTTP/1.1");
+ }
+ else if (!strncasecmp(buf, "/favicon.ico", 12)) {
+ strcpy(req->line, "GET /static/favicon.ico");
+ }
+
+ /**
+ * These are the URL's which may be executed without a
+ * session cookie already set. If it's not one of these,
+ * force the session to close because cookies are
+ * probably disabled on the client browser.
+ */
+ else if ( (strcmp(buf, "/"))
+ && (strncasecmp(buf, "/listsub", 8))
+ && (strncasecmp(buf, "/freebusy", 9))
+ && (strncasecmp(buf, "/do_logout", 10))
+ && (strncasecmp(buf, "/groupdav", 9))
+ && (strncasecmp(buf, "/static", 7))
+ && (strncasecmp(buf, "/rss", 4))
+ && (got_cookie == 0)) {
+ strcpy(req->line, "GET /static/nocookies.html"
+ "?force_close_session=yes HTTP/1.1");
+ }
- /*
- * If the last response included a "close session" directive,
- * remove the context now.
+ /**
+ * See if there's an existing session open with the desired ID or user/pass
*/
- if (CloseSession) {
- printf("Removing session.\n");
- pthread_mutex_lock(&MasterCritter);
+ TheSession = NULL;
+
+ if (TheSession == NULL) {
+ pthread_mutex_lock(&SessionListMutex);
+ for (sptr = SessionList; sptr != NULL; sptr = sptr->next) {
- if (SessionList==TheSession) {
- SessionList = SessionList->next;
+ /** If HTTP-AUTH, look for a session with matching credentials */
+ if ( (strlen(httpauth_user) > 0)
+ &&(!strcasecmp(sptr->httpauth_user, httpauth_user))
+ &&(!strcasecmp(sptr->httpauth_pass, httpauth_pass)) ) {
+ TheSession = sptr;
}
- else {
- for (sptr=SessionList; sptr!=NULL; sptr=sptr->next) {
- if (sptr->next == TheSession) {
- sptr->next = TheSession->next;
- }
- }
+
+ /** If cookie-session, look for a session with matching session ID */
+ if ( (desired_session != 0) && (sptr->wc_session == desired_session)) {
+ TheSession = sptr;
}
- close(TheSession->inpipe[1]);
- close(TheSession->outpipe[0]);
- unlock_session(TheSession);
- free(TheSession);
-
- pthread_mutex_unlock(&MasterCritter);
}
- else {
- end:
- unlock_session(TheSession);
- }
- free(req);
-
+ pthread_mutex_unlock(&SessionListMutex);
+ }
- /* Discard the CRLF following the POST data. Yes, this is
- * necessary. No, you don't want to know why. */
- if (!strcasecmp(http_method, "POST")) {
- client_read(sock, buf, 2);
- }
+ /**
+ * Create a new session if we have to
+ */
+ if (TheSession == NULL) {
+ lprintf(3, "Creating a new session\n");
+ TheSession = (struct wcsession *)
+ malloc(sizeof(struct wcsession));
+ memset(TheSession, 0, sizeof(struct wcsession));
+ TheSession->serv_sock = (-1);
+ TheSession->chat_sock = (-1);
+ TheSession->wc_session = GenerateSessionID();
+ strcpy(TheSession->httpauth_user, httpauth_user);
+ strcpy(TheSession->httpauth_pass, httpauth_pass);
+ pthread_mutex_init(&TheSession->SessionMutex, NULL);
+ pthread_mutex_lock(&SessionListMutex);
+ TheSession->next = SessionList;
+ SessionList = TheSession;
+ pthread_mutex_unlock(&SessionListMutex);
+ session_is_new = 1;
+ }
- /*
- * Now our HTTP connection is done. It would be relatively easy
- * to support HTTP/1.1 "persistent" connections by looping back to
- * the top of this function. For now, we'll just close.
- */
- printf(" Closing socket %d ... ret=%d\n", sock, close(sock));
+ /**
+ * A future improvement might be to check the session integrity
+ * at this point before continuing.
+ */
- /*
- * The thread handling this HTTP connection is now finished.
+ /**
+ * Bind to the session and perform the transaction
*/
- pthread_exit(NULL);
+ pthread_mutex_lock(&TheSession->SessionMutex); /*< bind */
+ pthread_setspecific(MyConKey, (void *)TheSession);
+ TheSession->http_sock = sock;
+ TheSession->lastreq = time(NULL); /*< log */
+ TheSession->gzip_ok = gzip_ok;
+#ifdef ENABLE_NLS
+ if (session_is_new) {
+ httplang_to_locale(accept_language);
}
+ go_selected_language(); /*< set locale */
+#endif
+ session_loop(req); /*< do transaction */
+#ifdef ENABLE_NLS
+ stop_selected_language(); /*< unset locale */
+#endif
+ pthread_mutex_unlock(&TheSession->SessionMutex); /*< unbind */
+
+ /** Free the request buffer */
+bail: while (req != NULL) {
+ hptr = req->next;
+ free(req);
+ req = hptr;
+ }
+
+ /**
+ * Free up any session-local substitution variables which
+ * were set during this transaction
+ */
+ clear_local_substs();
+}
+/*@}*/