* HAIL MELD!
[citadel.git] / webcit / context_loop.c
index aa2863895184b461f9a2caefb80adaacfbf90489..e505b5465d00606e231372d2e7433c9ded6a035b 100644 (file)
 /* Only one thread may manipulate SessionList at a time... */
 pthread_mutex_t SessionListMutex;
 
-struct wcsession *SessionList = NULL;
+struct wcsession *SessionList = NULL; /**< our sessions ????*/
 
-pthread_key_t MyConKey;                         /* TSD key for MySession() */
+pthread_key_t MyConKey;         /**< TSD key for MySession() */
 
 
+/*
+ * free the memory used for viewing atachments
+ */
 void free_attachments(struct wcsession *sess) {
        struct wc_attachment *att;
 
@@ -31,6 +34,39 @@ void free_attachments(struct wcsession *sess) {
 }
 
 
+void DestroySession(struct wcsession **sessions_to_kill)
+{
+       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));
+       free_march_list((*sessions_to_kill));
+       DeleteHash(&((*sessions_to_kill)->hash_prefs));
+       DeleteHash(&((*sessions_to_kill)->IconBarSetttings));
+       DeleteHash(&((*sessions_to_kill)->ServCfg));
+       FreeStrBuf(&((*sessions_to_kill)->UrlFragment1));
+       FreeStrBuf(&((*sessions_to_kill)->UrlFragment2));
+       FreeStrBuf(&((*sessions_to_kill)->WBuf));
+       FreeStrBuf(&((*sessions_to_kill)->HBuf));
+
+       free((*sessions_to_kill));
+       (*sessions_to_kill) = NULL;
+}
+
+void shutdown_sessions(void)
+{
+       struct wcsession *sptr;
+       
+       for (sptr = SessionList; sptr != NULL; sptr = sptr->next) {
+                       sptr->killthis = 1;
+       }
+}
+
 void do_housekeeping(void)
 {
        struct wcsession *sptr, *ss;
@@ -38,7 +74,7 @@ void do_housekeeping(void)
        int num_sessions = 0;
        static int num_threads = MIN_WORKER_THREADS;
 
-       /*
+       /**
         * Lock the session list, moving any candidates for euthanasia into
         * a separate list.
         */
@@ -47,16 +83,16 @@ void do_housekeeping(void)
        for (sptr = SessionList; sptr != NULL; sptr = sptr->next) {
                ++num_sessions;
 
-               /* Kill idle sessions */
+               /** Kill idle sessions */
                if ((time(NULL) - (sptr->lastreq)) >
                   (time_t) WEBCIT_TIMEOUT) {
                        sptr->killthis = 1;
                }
 
-               /* Remove sessions flagged for kill */
+               /** Remove sessions flagged for kill */
                if (sptr->killthis) {
 
-                       /* remove session from linked list */
+                       /** remove session from linked list */
                        if (sptr == SessionList) {
                                SessionList = SessionList->next;
                        }
@@ -72,26 +108,21 @@ void do_housekeeping(void)
        }
        pthread_mutex_unlock(&SessionListMutex);
 
-       /*
+       /**
         * 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);
-               }
-               free_attachments(sessions_to_kill);
                pthread_mutex_unlock(&sessions_to_kill->SessionMutex);
                sptr = sessions_to_kill->next;
-               free(sessions_to_kill);
+
+               DestroySession(&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.
         */
@@ -105,8 +136,8 @@ void do_housekeeping(void)
 }
 
 
-/* 
- * Wake up occasionally and clean house
+/**
+ * \brief Wake up occasionally and clean house
  */
 void housekeeping_loop(void)
 {
@@ -117,11 +148,12 @@ void housekeeping_loop(void)
 }
 
 
-/*
+/**
+ * \brief Create a Session id
  * Generate a unique WebCit session ID (which is not the same thing as the
  * Citadel session ID).
  *
- * FIXME ... ensure that session number is truly unique
+ * \todo FIXME ... ensure that session number is truly unique
  *
  */
 int GenerateSessionID(void)
@@ -139,11 +171,11 @@ int GenerateSessionID(void)
 /*
  * Collapse multiple cookies on one line
  */
-int req_gets(int sock, char *buf, char *hold)
+int req_gets(int *sock, char *buf, char *hold, size_t hlen)
 {
-       int a;
+       int a, b;
 
-       if (strlen(hold) == 0) {
+       if (IsEmptyStr(hold)) {
                strcpy(buf, "");
                a = client_getln(sock, buf, SIZ);
                if (a<1) return(-1);
@@ -153,12 +185,19 @@ int req_gets(int sock, char *buf, char *hold)
        strcpy(hold, "");
 
        if (!strncasecmp(buf, "Cookie: ", 8)) {
-               for (a = 0; a < strlen(buf); ++a)
+               int len;
+               len = strlen(buf);
+               for (a = 0; a < len; ++a)
                        if (buf[a] == ';') {
-                               sprintf(hold, "Cookie: %s", &buf[a + 1]);
+                               // we don't refresh len, because of we 
+                               // only exit from here.
+                               snprintf(hold, hlen, "Cookie: %s", &buf[a + 1]);
                                buf[a] = 0;
-                               while (isspace(hold[8]))
-                                       strcpy(&hold[8], &hold[9]);
+                               b = 8;
+                               while (isspace(hold[b]))
+                                       b++;
+                               
+                               memmove(&hold[8], &hold[b], len - b + 1);
                                return(0);
                        }
        }
@@ -170,7 +209,6 @@ int req_gets(int sock, char *buf, char *hold)
  * lingering_close() a`la Apache. see
  * http://www.apache.org/docs/misc/fin_wait_2.html for rationale
  */
-
 int lingering_close(int fd)
 {
        char buf[SIZ];
@@ -205,24 +243,43 @@ int lingering_close(int fd)
 
 
 
-/*
- * 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.
+/**
+ * \brief      sanity requests
+ *             Check for bogus requests coming from brain-dead Windows boxes.
+ *
+ * \param      http_cmd        The HTTP request to check
  */
 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);
+       char *url;
+       int i, max;
+
+       url = strstr(http_cmd, " ");
+       if (url == NULL) return(1);
+       ++url;
+
+       char *bogus_prefixes[] = {
+               "/scripts/root.exe",    /**< Worms and trojans and viruses, oh my! */
+               "/c/winnt",
+               "/MSADC/",
+               "/_vti",                /**< Broken Microsoft DAV implementation */
+               "/MSOffice"             /**< Stoopid MSOffice thinks everyone is IIS */
+       };
+
+       max = sizeof(bogus_prefixes) / sizeof(char *);
+
+       for (i=0; i<max; ++i) {
+               if (!strncasecmp(url, bogus_prefixes[i], strlen(bogus_prefixes[i]))) {
+                       return(2);
+               }
+       }
 
        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.
@@ -232,8 +289,9 @@ int is_bogus(char *http_cmd) {
  * 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)
+void context_loop(int *sock)
 {
        struct httprequest *req = NULL;
        struct httprequest *last = NULL;
@@ -243,23 +301,25 @@ void context_loop(int sock)
        int got_cookie = 0;
        int gzip_ok = 0;
        struct wcsession *TheSession, *sptr;
-       char httpauth_string[SIZ];
-       char httpauth_user[SIZ];
-       char httpauth_pass[SIZ];
+       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
         */
        memset(hold, 0, sizeof(hold));
        do {
-               if (req_gets(sock, buf, hold) < 0) return;
+               if (req_gets(sock, buf, hold, SIZ) < 0) return;
 
-               /*
+               /**
                 * Can we compress?
                 */
                if (!strncasecmp(buf, "Accept-encoding:", 16)) {
@@ -268,7 +328,7 @@ void context_loop(int sock)
                        }
                }
 
-               /*
+               /**
                 * Browser-based sessions use cookies for session authentication
                 */
                if (!strncasecmp(buf, "Cookie: webcit=", 15)) {
@@ -277,7 +337,7 @@ void context_loop(int sock)
                        got_cookie = 1;
                }
 
-               /*
+               /**
                 * GroupDAV-based sessions use HTTP authentication
                 */
                if (!strncasecmp(buf, "Authorization: Basic ", 21)) {
@@ -291,10 +351,10 @@ void context_loop(int sock)
                }
 
                if (!strncasecmp(buf, "Accept-Language: ", 17)) {
-                       httplang_to_locale(&buf[17]);
+                       safestrncpy(accept_language, &buf[17], sizeof accept_language);
                }
 
-               /*
+               /**
                 * Read in the request
                 */
                hptr = (struct httprequest *)
@@ -308,39 +368,49 @@ void context_loop(int sock)
 
                safestrncpy(hptr->line, buf, sizeof hptr->line);
 
-       } while (strlen(buf) > 0);
+       } while (!IsEmptyStr(buf));
 
-       /*
+       /**
         * 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" */
+       ptr = strstr(req->line, " /webcit ");   /*< Handle "/webcit" */
        if (ptr != NULL) {
                strcpy(ptr+2, ptr+8);
        }
 
-       ptr = strstr(req->line, " /webcit");    /* Handle "/webcit/" */
+       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);
+       /** Begin parsing the request. */
+#ifdef TECH_PREVIEW
+       if ((strncmp(req->line+4, "/sslg", 5) != 0) &&
+           (strncmp(req->line+4, "/static/", 8) != 0) &&
+           (strncmp(req->line+4, "/wholist_section", 16) != 0)) {
+#endif
+               lprintf(5, "HTTP: %s\n", buf);
+#ifdef TECH_PREVIEW
+       }
+#endif
 
-       /* Check for bogus requests */
-       if (is_bogus(buf)) goto bail;
+       /** Check for bogus requests */
+       if (is_bogus(buf)) {
+               strcpy(req->line, "GET /404 HTTP/1.1");
+               strcpy(buf, "GET /404 HTTP/1.1");
+       }
 
-       /*
+       /**
         * Strip out the method, leaving the URL up front...
         */
        remove_token(buf, 0, ' ');
        if (buf[1]==' ') buf[1]=0;
 
-       /*
+       /**
         * While we're at it, gracefully handle requests for the
         * robots.txt and favicon.ico files.
         */
@@ -352,7 +422,8 @@ void context_loop(int sock)
                strcpy(req->line, "GET /static/favicon.ico");
        }
 
-       /* These are the URL's which may be executed without a
+       /**
+        * 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.
@@ -364,12 +435,13 @@ void context_loop(int sock)
                && (strncasecmp(buf, "/groupdav", 9))
                && (strncasecmp(buf, "/static", 7))
                && (strncasecmp(buf, "/rss", 4))
+               && (strncasecmp(buf, "/404", 4))
                && (got_cookie == 0)) {
                strcpy(req->line, "GET /static/nocookies.html"
                                "?force_close_session=yes HTTP/1.1");
        }
 
-       /*
+       /**
         * See if there's an existing session open with the desired ID or user/pass
         */
        TheSession = NULL;
@@ -378,14 +450,14 @@ void context_loop(int sock)
                pthread_mutex_lock(&SessionListMutex);
                for (sptr = SessionList; sptr != NULL; sptr = sptr->next) {
 
-                       /* If HTTP-AUTH, look for a session with matching credentials */
-                       if ( (strlen(httpauth_user) > 0)
+                       /** If HTTP-AUTH, look for a session with matching credentials */
+                       if ( (!IsEmptyStr(httpauth_user))
                           &&(!strcasecmp(sptr->httpauth_user, httpauth_user))
                           &&(!strcasecmp(sptr->httpauth_pass, httpauth_pass)) ) {
                                TheSession = sptr;
                        }
 
-                       /* If cookie-session, look for a session with matching session ID */
+                       /** If cookie-session, look for a session with matching session ID */
                        if ( (desired_session != 0) && (sptr->wc_session == desired_session)) {
                                TheSession = sptr;
                        }
@@ -394,7 +466,7 @@ void context_loop(int sock)
                pthread_mutex_unlock(&SessionListMutex);
        }
 
-       /*
+       /**
         * Create a new session if we have to
         */
        if (TheSession == NULL) {
@@ -404,15 +476,33 @@ void context_loop(int sock)
                memset(TheSession, 0, sizeof(struct wcsession));
                TheSession->serv_sock = (-1);
                TheSession->chat_sock = (-1);
-               TheSession->wc_session = GenerateSessionID();
+       
+               /* If we're recreating a session that expired, it's best to give it the same
+                * session number that it had before.  The client browser ought to pick up
+                * the new session number and start using it, but in some rare situations it
+                * doesn't, and that's a Bad Thing because it causes lots of spurious sessions
+                * to get created.
+                */     
+               if (desired_session == 0) {
+                       TheSession->wc_session = GenerateSessionID();
+               }
+               else {
+                       TheSession->wc_session = desired_session;
+               }
+
                strcpy(TheSession->httpauth_user, httpauth_user);
                strcpy(TheSession->httpauth_pass, httpauth_pass);
+               TheSession->hash_prefs = NewHash(1,NULL);       /* Get a hash table for the user preferences */
                pthread_mutex_init(&TheSession->SessionMutex, NULL);
-
                pthread_mutex_lock(&SessionListMutex);
+               TheSession->urlstrings = NULL;
+               TheSession->vars = NULL;
+               TheSession->nonce = rand();
+               TheSession->WBuf = NULL;
                TheSession->next = SessionList;
                SessionList = TheSession;
                pthread_mutex_unlock(&SessionListMutex);
+               session_is_new = 1;
        }
 
        /*
@@ -425,21 +515,41 @@ void context_loop(int sock)
         */
        pthread_mutex_lock(&TheSession->SessionMutex);          /* bind */
        pthread_setspecific(MyConKey, (void *)TheSession);
-       TheSession->http_sock = sock;
+       
+       TheSession->urlstrings = NewHash(1,NULL);
+       TheSession->vars = NewHash(1,NULL);
+       TheSession->http_sock = *sock;
        TheSession->lastreq = time(NULL);                       /* log */
        TheSession->gzip_ok = gzip_ok;
-       session_loop(req);                              /* do transaction */
+#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
+       DeleteHash(&TheSession->urlstrings);
+       DeleteHash(&TheSession->vars);
+       FreeStrBuf(&TheSession->WBuf);
+       FreeStrBuf(&TheSession->HBuf);
+       
+       
        pthread_mutex_unlock(&TheSession->SessionMutex);        /* unbind */
 
        /* Free the request buffer */
-bail:  while (req != NULL) {
+       while (req != NULL) {
                hptr = req->next;
                free(req);
                req = hptr;
        }
 
-       /* Free up any session-local substitution variables which
+       /*
+        * Free up any session-local substitution variables which
         * were set during this transaction
         */
-       clear_local_substs();
+       
+       
 }