webcit/context_loop.c

   1 /*
   2  * context_loop.c
   3  *
   4  * This is the other half of the webserver.  It handles the task of hooking
   5  * up HTTP requests with the sessions they belong to, using HTTP cookies to
   6  * keep track of things.  If the HTTP request doesn't belong to any currently
   7  * active session, a new session is started.
   8  *
   9  * $Id$
  10  */
  11
  12 #include <ctype.h>
  13 #include <stdlib.h>
  14 #ifdef HAVE_UNISTD_H
  15 #include <unistd.h>
  16 #endif
  17 #include <stdio.h>
  18 #ifdef HAVE_FCNTL_H
  19 #include <fcntl.h>
  20 #endif
  21 #include <signal.h>
  22 #include <sys/types.h>
  23 #include <sys/wait.h>
  24 #include <sys/socket.h>
  25 #ifdef HAVE_SYS_TIME_H
  26 #include <sys/time.h>
  27 #endif
  28 #ifdef HAVE_LIMITS_H
  29 #include <limits.h>
  30 #endif
  31 #include <netinet/in.h>
  32 #include <netdb.h>
  33 #include <string.h>
  34 #include <errno.h>
  35 #include <stdarg.h>
  36 #include <pthread.h>
  37 #include <signal.h>
  38 #include "webcit.h"
  39 #include "webserver.h"
  40
  41 /* Only one thread may manipulate SessionList at a time... */
  42 pthread_mutex_t SessionListMutex;
  43
  44 struct wcsession *SessionList = NULL;
  45
  46 pthread_key_t MyConKey;                         /* TSD key for MySession() */
  47
  48
  49 void free_attachments(struct wcsession *sess) {
  50         struct wc_attachment *att;
  51
  52         while (sess->first_attachment != NULL) {
  53                 att = sess->first_attachment;
  54                 sess->first_attachment = sess->first_attachment->next;
  55                 free(att->data);
  56                 free(att);
  57         }
  58 }
  59
  60
  61 void do_housekeeping(void)
  62 {
  63         struct wcsession *sptr, *ss, *session_to_kill;
  64         int num_sessions = 0;
  65         static int num_threads = MIN_WORKER_THREADS;
  66
  67         do {
  68                 session_to_kill = NULL;
  69                 pthread_mutex_lock(&SessionListMutex);
  70                 num_sessions = 0;
  71                 for (sptr = SessionList; sptr != NULL; sptr = sptr->next) {
  72                         ++num_sessions;
  73
  74                         /* Kill idle sessions */
  75                         if ((time(NULL) - (sptr->lastreq)) >
  76                            (time_t) WEBCIT_TIMEOUT) {
  77                                 sptr->killthis = 1;
  78                         }
  79
  80                         /* Remove sessions flagged for kill */
  81                         if (sptr->killthis) {
  82
  83                                 lprintf(3, "Destroying session %d\n",
  84                                         sptr->wc_session);
  85
  86                                 /* remove session from linked list */
  87                                 if (sptr == SessionList) {
  88                                         SessionList = SessionList->next;
  89                                 }
  90                                 else for (ss=SessionList;ss!=NULL;ss=ss->next) {
  91                                         if (ss->next == sptr) {
  92                                                 ss->next = ss->next->next;
  93                                         }
  94                                 }
  95
  96                                 session_to_kill = sptr;
  97                                 goto BREAKOUT;
  98                         }
  99                 }
 100 BREAKOUT:       pthread_mutex_unlock(&SessionListMutex);
 101
 102                 if (session_to_kill != NULL) {
 103                         pthread_mutex_lock(&session_to_kill->SessionMutex);
 104                         close(session_to_kill->serv_sock);
 105                         close(session_to_kill->chat_sock);
 106                         if (session_to_kill->preferences != NULL) {
 107                                 free(session_to_kill->preferences);
 108                         }
 109                         free_attachments(session_to_kill);
 110                         pthread_mutex_unlock(&session_to_kill->SessionMutex);
 111                         free(session_to_kill);
 112                 }
 113
 114         } while (session_to_kill != NULL);
 115
 116         /*
 117          * See if we need more worker threads
 118          */
 119         while ( (num_sessions > num_threads)
 120               && (num_threads <= MAX_WORKER_THREADS) ) {
 121                 spawn_another_worker_thread();
 122                 ++num_threads;
 123                 lprintf(3, "There are %d sessions and %d threads active.\n",
 124                         num_sessions, num_threads);
 125         }
 126 }
 127
 128
 129 /*
 130  * Wake up occasionally and clean house
 131  */
 132 void housekeeping_loop(void)
 133 {
 134         while (1) {
 135                 sleeeeeeeeeep(HOUSEKEEPING);
 136                 do_housekeeping();
 137         }
 138 }
 139
 140
 141 /*
 142  * Generate a unique WebCit session ID (which is not the same thing as the
 143  * Citadel session ID).
 144  *
 145  * FIXME ... ensure that session number is truly unique
 146  *
 147  */
 148 int GenerateSessionID(void)
 149 {
 150         static int seq = (-1);
 151
 152         if (seq < 0) {
 153                 seq = (int) time(NULL);
 154         }
 155
 156         return ++seq;
 157 }
 158
 159
 160 /*
 161  * Collapse multiple cookies on one line
 162  */
 163 int req_gets(int sock, char *buf, char *hold)
 164 {
 165         int a;
 166
 167         if (strlen(hold) == 0) {
 168                 strcpy(buf, "");
 169                 a = client_gets(sock, buf);
 170                 if (a<1) return(-1);
 171         } else {
 172                 safestrncpy(buf, hold, SIZ);
 173         }
 174         strcpy(hold, "");
 175
 176         if (!strncasecmp(buf, "Cookie: ", 8)) {
 177                 for (a = 0; a < strlen(buf); ++a)
 178                         if (buf[a] == ';') {
 179                                 sprintf(hold, "Cookie: %s", &buf[a + 1]);
 180                                 buf[a] = 0;
 181                                 while (isspace(hold[8]))
 182                                         strcpy(&hold[8], &hold[9]);
 183                                 return(0);
 184                         }
 185         }
 186
 187         return(0);
 188 }
 189
 190 /*
 191  * lingering_close() a`la Apache. see
 192  * http://www.apache.org/docs/misc/fin_wait_2.html for rationale
 193  */
 194
 195 int lingering_close(int fd)
 196 {
 197         char buf[SIZ];
 198         int i;
 199         fd_set set;
 200         struct timeval tv, start;
 201
 202         gettimeofday(&start, NULL);
 203         shutdown(fd, 1);
 204         do {
 205                 do {
 206                         gettimeofday(&tv, NULL);
 207                         tv.tv_sec = SLEEPING - (tv.tv_sec - start.tv_sec);
 208                         tv.tv_usec = start.tv_usec - tv.tv_usec;
 209                         if (tv.tv_usec < 0) {
 210                                 tv.tv_sec--;
 211                                 tv.tv_usec += 1000000;
 212                         }
 213                         FD_ZERO(&set);
 214                         FD_SET(fd, &set);
 215                         i = select(fd + 1, &set, NULL, NULL, &tv);
 216                 } while (i == -1 && errno == EINTR);
 217
 218                 if (i <= 0)
 219                         break;
 220
 221                 i = read(fd, buf, sizeof buf);
 222         } while (i != 0 && (i != -1 || errno == EINTR));
 223
 224         return close(fd);
 225 }
 226
 227
 228
 229 /*
 230  * Check for bogus requests coming from (for example) brain-dead
 231  * Windoze boxes that are infected with the latest worm-of-the-week.
 232  * If we detect one of these, bail out without bothering our Citadel
 233  * server.
 234  */
 235 int is_bogus(char *http_cmd) {
 236
 237         if (!strncasecmp(http_cmd, "GET /scripts/root.exe", 21)) return(1);
 238         if (!strncasecmp(http_cmd, "GET /c/winnt", 12)) return(2);
 239         if (!strncasecmp(http_cmd, "GET /MSADC/", 11)) return(3);
 240
 241         return(0);      /* probably ok */
 242 }
 243
 244
 245
 246 /*
 247  * This loop gets called once for every HTTP connection made to WebCit.  At
 248  * this entry point we have an HTTP socket with a browser allegedly on the
 249  * other end, but we have not yet bound to a WebCit session.
 250  *
 251  * The job of this function is to locate the correct session and bind to it,
 252  * or create a session if necessary and bind to it, then run the WebCit
 253  * transaction loop.  Afterwards, we unbind from the session.  When this
 254  * function returns, the worker thread is then free to handle another
 255  * transaction.
 256  */
 257 void context_loop(int sock)
 258 {
 259         struct httprequest *req = NULL;
 260         struct httprequest *last = NULL;
 261         struct httprequest *hptr;
 262         char buf[SIZ], hold[SIZ];
 263         int desired_session = 0;
 264         int got_cookie = 0;
 265         struct wcsession *TheSession, *sptr;
 266         int outside_frameset_allowed = 0;
 267
 268         /*
 269          * Find out what it is that the web browser is asking for
 270          */
 271         memset(hold, 0, sizeof(hold));
 272         do {
 273                 if (req_gets(sock, buf, hold) < 0) return;
 274
 275                 if (!strncasecmp(buf, "Cookie: webcit=", 15)) {
 276                         cookie_to_stuff(&buf[15], &desired_session,
 277                                 NULL, NULL, NULL);
 278                         got_cookie = 1;
 279                 }
 280
 281                 hptr = (struct httprequest *)
 282                         malloc(sizeof(struct httprequest));
 283                 if (req == NULL)
 284                         req = hptr;
 285                 else
 286                         last->next = hptr;
 287                 hptr->next = NULL;
 288                 last = hptr;
 289
 290                 safestrncpy(hptr->line, buf, sizeof hptr->line);
 291
 292         } while (strlen(buf) > 0);
 293
 294         safestrncpy(buf, req->line, sizeof buf);
 295         lprintf(5, "HTTP: %s\n", buf);
 296
 297         /* Check for bogus requests */
 298         if (is_bogus(buf)) goto bail;
 299
 300         /*
 301          * If requesting a non-root page, there should already be a cookie
 302          * set.  If there isn't, the client browser has cookies turned off
 303          * (or doesn't support them) and we have to barf & bail.
 304          */
 305         if (!strncasecmp(buf, "GET ", 4)) strcpy(buf, &buf[4]);
 306         else if (!strncasecmp(buf, "HEAD ", 5)) strcpy(buf, &buf[5]);
 307         else if (!strncasecmp(buf, "POST ", 5)) strcpy(buf, &buf[5]);
 308         if (buf[1]==' ') buf[1]=0;
 309
 310         /*
 311          * While we're at it, gracefully handle requests for the
 312          * robots.txt and favicon.ico files.
 313          */
 314         if (!strncasecmp(buf, "/robots.txt", 11)) {
 315                 strcpy(req->line, "GET /static/robots.txt"
 316                                 "?force_close_session=yes HTTP/1.0");
 317         }
 318         else if (!strncasecmp(buf, "/favicon.ico", 12)) {
 319                 strcpy(req->line, "GET /static/favicon.ico");
 320         }
 321
 322         /* These are the URL's which may be executed without a
 323          * session cookie already set.  If it's not one of these,
 324          * force the session to close because cookies are
 325          * probably disabled on the client browser.
 326          */
 327         else if ( (strcmp(buf, "/"))
 328                 && (strncasecmp(buf, "/listsub", 8))
 329                 && (strncasecmp(buf, "/freebusy", 9))
 330                 && (strncasecmp(buf, "/do_logout", 10))
 331                 && (got_cookie == 0)) {
 332                 strcpy(req->line, "GET /static/nocookies.html"
 333                                 "?force_close_session=yes HTTP/1.0");
 334         }
 335
 336         /* These are the URL's which may be executed outside of the
 337          * main frameset.  If it's not one of these, the page will
 338          * need JavaScript added to force the frameset to reload.
 339          */
 340         if ( (!strcasecmp(buf, "/"))
 341            || (!strncasecmp(buf, "/static/", 8))
 342            || (!strncasecmp(buf, "/do_welcome", 11))
 343            || (!strncasecmp(buf, "/do_logout", 10))
 344            || (!strncasecmp(buf, "/login", 6))
 345            || (!strncasecmp(buf, "/page_popup", 11))
 346            || (!strncasecmp(buf, "/page_user", 10))     /* Sometimes this is wrong */
 347            || (!strncasecmp(buf, "/display_page", 10))  /* Sometimes this is wrong */
 348            || (!strncasecmp(buf, "/listsub", 8))
 349            || (!strncasecmp(buf, "/freebusy", 9))
 350            || (!strncasecmp(buf, "/termquit", 9)) ) {
 351                 outside_frameset_allowed = 1;
 352         }
 353         else {
 354                 outside_frameset_allowed = 0;
 355         }
 356
 357         /*
 358          * See if there's an existing session open with the desired ID
 359          */
 360         TheSession = NULL;
 361         if (desired_session != 0) {
 362                 pthread_mutex_lock(&SessionListMutex);
 363                 for (sptr = SessionList; sptr != NULL; sptr = sptr->next) {
 364                         if (sptr->wc_session == desired_session) {
 365                                 TheSession = sptr;
 366                         }
 367                 }
 368                 pthread_mutex_unlock(&SessionListMutex);
 369         }
 370
 371         /*
 372          * Create a new session if we have to
 373          */
 374         if (TheSession == NULL) {
 375                 lprintf(3, "Creating a new session\n");
 376                 TheSession = (struct wcsession *)
 377                         malloc(sizeof(struct wcsession));
 378                 memset(TheSession, 0, sizeof(struct wcsession));
 379                 TheSession->serv_sock = (-1);
 380                 TheSession->chat_sock = (-1);
 381                 TheSession->wc_session = GenerateSessionID();
 382                 pthread_mutex_init(&TheSession->SessionMutex, NULL);
 383
 384                 pthread_mutex_lock(&SessionListMutex);
 385                 TheSession->next = SessionList;
 386                 SessionList = TheSession;
 387                 pthread_mutex_unlock(&SessionListMutex);
 388         }
 389
 390         /*
 391          * A future improvement might be to check the session integrity
 392          * at this point before continuing.
 393          */
 394
 395         /*
 396          * Bind to the session and perform the transaction
 397          */
 398         pthread_mutex_lock(&TheSession->SessionMutex);          /* bind */
 399         pthread_setspecific(MyConKey, (void *)TheSession);
 400         TheSession->http_sock = sock;
 401         TheSession->lastreq = time(NULL);                       /* log */
 402         TheSession->outside_frameset_allowed = outside_frameset_allowed;
 403         session_loop(req);                              /* do transaction */
 404         pthread_mutex_unlock(&TheSession->SessionMutex);        /* unbind */
 405
 406         /* Free the request buffer */
 407 bail:   while (req != NULL) {
 408                 hptr = req->next;
 409                 free(req);
 410                 req = hptr;
 411         }
 412
 413         /* Free up any session-local substitution variables which
 414          * were set during this transaction
 415          */
 416         clear_local_substs();
 417 }