Replaced cached_msglist array with a btree persistent through the session.
[citadel.git] / citadel / context.c
index c20ec98f7654f873a7387799e617fb3a36fd0fc4..32b306bf92f82b53d6d4557e62c42db1de6206da 100644 (file)
@@ -1,11 +1,22 @@
 /*
- * $Id: sysdep.c 7989 2009-10-31 15:29:37Z davew $
- *
  * Citadel context management stuff.
- * See COPYING for copyright information.
- *
  * Here's where we (hopefully) have all the code that manipulates contexts.
  *
+ * Copyright (c) 1987-2010 by the citadel.org team
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
 #include "sysdep.h"
@@ -21,6 +32,9 @@
 #include <sys/socket.h>
 #include <syslog.h>
 #include <sys/syslog.h>
+/*
+#include <sys/syscall.h>
+*/
 
 #if TIME_WITH_SYS_TIME
 # include <sys/time.h>
@@ -145,13 +159,13 @@ int CtdlTerminateOtherSession (int session_num)
                return TERM_NOTALLOWED;
        }
 
-       CtdlLogPrintf(CTDL_DEBUG, "Locating session to kill\n");
+       syslog(LOG_DEBUG, "Locating session to kill\n");
        begin_critical_section(S_SESSION_TABLE);
        for (ccptr = ContextList; ccptr != NULL; ccptr = ccptr->next) {
                if (session_num == ccptr->cs_pid) {
                        ret |= TERM_FOUND;
                        if ((ccptr->user.usernum == CC->user.usernum)
-                          || (CC->user.axlevel >= 6)) {
+                          || (CC->user.axlevel >= AxAideU)) {
                                ret |= TERM_ALLOWED;
                                ccptr->kill_me = 1;
                        }
@@ -287,9 +301,28 @@ void terminate_idle_sessions(void)
        }
        end_critical_section(S_SESSION_TABLE);
        if (killed > 0)
-               CtdlLogPrintf(CTDL_INFO, "Terminated %d idle sessions\n", killed);
+               syslog(LOG_INFO, "Scheduled %d idle sessions for termination\n", killed);
        if (longrunners > 0)
-               CtdlLogPrintf(CTDL_INFO, "Didn't terminate %d protected idle sessions;\n", killed);
+               syslog(LOG_INFO, "Didn't terminate %d protected idle sessions;\n", killed);
+}
+
+void terminate_stuck_sessions(void)
+{
+       CitContext *ccptr;
+       int killed = 0;
+
+       begin_critical_section(S_SESSION_TABLE);
+       for (ccptr = ContextList; ccptr != NULL; ccptr = ccptr->next) {
+               if (ccptr->client_socket != -1)
+               {
+                       close(ccptr->client_socket);
+                       ccptr->client_socket = -1;
+                       killed++;
+               }
+       }
+       end_critical_section(S_SESSION_TABLE);
+       if (killed > 0)
+               syslog(LOG_INFO, "Flushed %d stuck sessions\n", killed);
 }
 
 
@@ -300,11 +333,11 @@ void terminate_idle_sessions(void)
 void RemoveContext (CitContext *con)
 {
        if (con==NULL) {
-               CtdlLogPrintf(CTDL_ERR,
+               syslog(LOG_ERR,
                        "WARNING: RemoveContext() called with NULL!\n");
                return;
        }
-       CtdlLogPrintf(CTDL_DEBUG, "RemoveContext() session %d\n", con->cs_pid);
+       syslog(LOG_DEBUG, "RemoveContext() session %d\n", con->cs_pid);
 
        /* Run any cleanup routines registered by loadable modules.
         * Note: We have to "become_session()" because the cleanup functions
@@ -315,11 +348,17 @@ void RemoveContext (CitContext *con)
        PerformSessionHooks(EVT_STOP);
        become_session(NULL);
 
-       CtdlLogPrintf(CTDL_NOTICE, "[%3d] Session ended.\n", con->cs_pid);
+       syslog(LOG_NOTICE, "[%3d] Session ended.\n", con->cs_pid);
 
-       /* If the client is still connected, blow 'em away. */
-       CtdlLogPrintf(CTDL_DEBUG, "Closing socket %d\n", con->client_socket);
-       close(con->client_socket);
+       /* 
+        * If the client is still connected, blow 'em away. 
+        * if the socket is 0, its already gone or was never there.
+        */
+       if (con->client_socket != 0)
+       {
+               syslog(LOG_DEBUG, "Closing socket %d\n", con->client_socket);
+               close(con->client_socket);
+       }
 
        /* If using AUTHMODE_LDAP, free the DN */
        if (con->ldap_dn) {
@@ -328,8 +367,12 @@ void RemoveContext (CitContext *con)
        }
 
        FreeStrBuf(&con->MigrateBuf);
-       FreeStrBuf(&con->ReadBuf);
-       CtdlLogPrintf(CTDL_DEBUG, "Done with RemoveContext()\n");
+       FreeStrBuf(&con->RecvBuf.Buf);
+       if (con->cached_msglist) {
+               seenit_free(&con->cached_msglist);
+       }
+
+       syslog(LOG_DEBUG, "Done with RemoveContext()\n");
 }
 
 
@@ -347,11 +390,10 @@ CitContext *CreateNewContext(void) {
 
        me = (CitContext *) malloc(sizeof(CitContext));
        if (me == NULL) {
-               CtdlLogPrintf(CTDL_ALERT, "citserver: can't allocate memory!!\n");
+               syslog(LOG_ALERT, "citserver: can't allocate memory!!\n");
                return NULL;
        }
        memset(me, 0, sizeof(CitContext));
-       
        /* Give the contaxt a name. Hopefully makes it easier to track */
        strcpy (me->user.fullname, "SYS_notauth");
        
@@ -365,11 +407,12 @@ CitContext *CreateNewContext(void) {
         * the list.
         */
        me->MigrateBuf = NewStrBuf();
-       me->ReadBuf = NewStrBuf();
+       me->RecvBuf.Buf = NewStrBuf();
        begin_critical_section(S_SESSION_TABLE);
        me->cs_pid = ++next_pid;
        me->prev = NULL;
        me->next = ContextList;
+       me->lastcmd = time(NULL);       /* set lastcmd to now to prevent idle timer infanticide */
        ContextList = me;
        if (me->next != NULL) {
                me->next->prev = me;
@@ -380,6 +423,70 @@ CitContext *CreateNewContext(void) {
 }
 
 
+/*
+ * Initialize a new context and place it in the list.  The session number
+ * used to be the PID (which is why it's called cs_pid), but that was when we
+ * had one process per session.  Now we just assign them sequentially, starting
+ * at 1 (don't change it to 0 because masterCC uses 0).
+ */
+CitContext *CloneContext(CitContext *CloneMe) {
+       CitContext *me;
+       static int next_pid = 0;
+
+       me = (CitContext *) malloc(sizeof(CitContext));
+       if (me == NULL) {
+               syslog(LOG_ALERT, "citserver: can't allocate memory!!\n");
+               return NULL;
+       }
+       memcpy(me, CloneMe, sizeof(CitContext));
+
+       memset(&me->RecvBuf, 0, sizeof(IOBuffer));
+       memset(&me->SendBuf, 0, sizeof(IOBuffer));
+       memset(&me->SBuf, 0, sizeof(IOBuffer));
+       me->MigrateBuf = NULL;
+       me->sMigrateBuf = NULL;
+       me->redirect_buffer = NULL;
+#ifdef HAVE_OPENSSL
+       me->ssl = NULL;
+#endif
+
+       me->download_fp = NULL;
+       me->upload_fp = NULL;
+       /// TODO: what about the room/user?
+       me->ma = NULL;
+       me->openid_data = NULL;
+       me->ldap_dn = NULL;
+       me->session_specific_data = NULL;
+
+       me->download_fp = NULL;
+       me->upload_fp = NULL;
+       me->client_socket = 0;
+
+       me->MigrateBuf = NewStrBuf();
+       me->RecvBuf.Buf = NewStrBuf();
+       
+       begin_critical_section(S_SESSION_TABLE);
+       {
+               me->cs_pid = ++next_pid;
+               me->prev = NULL;
+               me->next = ContextList;
+               me->lastcmd = time(NULL);       /* set lastcmd to now to prevent idle timer infanticide */
+               ContextList = me;
+               if (me->next != NULL) {
+                       me->next->prev = me;
+               }
+               ++num_sessions;
+       }
+       end_critical_section(S_SESSION_TABLE);
+       return (me);
+}
+
+
+/*
+ * Return an array containing a copy of the context list.
+ * This allows worker threads to perform "for each context" operations without
+ * having to lock and traverse the live list.
+ */
 CitContext *CtdlGetContextArray(int *count)
 {
        int nContexts, i;
@@ -387,11 +494,14 @@ CitContext *CtdlGetContextArray(int *count)
        
        nContexts = num_sessions;
        nptr = malloc(sizeof(CitContext) * nContexts);
-       if (!nptr)
+       if (!nptr) {
+               *count = 0;
                return NULL;
+       }
        begin_critical_section(S_SESSION_TABLE);
-       for (cptr = ContextList, i=0; cptr != NULL && i < nContexts; cptr = cptr->next, i++)
+       for (cptr = ContextList, i=0; cptr != NULL && i < nContexts; cptr = cptr->next, i++) {
                memcpy(&nptr[i], cptr, sizeof (CitContext));
+       }
        end_critical_section (S_SESSION_TABLE);
        
        *count = i;
@@ -400,35 +510,53 @@ CitContext *CtdlGetContextArray(int *count)
 
 
 
-/**
+/*
  * This function fills in a context and its user field correctly
  * Then creates/loads that user
  */
 void CtdlFillSystemContext(CitContext *context, char *name)
 {
-       char sysname[USERNAME_SIZE];
+       char sysname[SIZ];
+       long len;
 
        memset(context, 0, sizeof(CitContext));
        context->internal_pgm = 1;
        context->cs_pid = 0;
        strcpy (sysname, "SYS_");
        strcat (sysname, name);
+       len = cutuserkey(sysname);
+       memcpy(context->curr_user, sysname, len + 1);
+       context->client_socket = (-1);
+       context->state = CON_SYS;
+       context->ServiceName = name;
+
        /* internal_create_user has the side effect of loading the user regardless of wether they
         * already existed or needed to be created
         */
-       internal_create_user (sysname, &(context->user), -1) ;
+       internal_create_user (sysname, len, &(context->user), -1) ;
        
        /* Check to see if the system user needs upgrading */
        if (context->user.usernum == 0)
        {       /* old system user with number 0, upgrade it */
                context->user.usernum = get_new_user_number();
-               CtdlLogPrintf(CTDL_DEBUG, "Upgrading system user \"%s\" from user number 0 to user number %d\n", context->user.fullname, context->user.usernum);
+               syslog(LOG_DEBUG, "Upgrading system user \"%s\" from user number 0 to user number %ld\n", context->user.fullname, context->user.usernum);
                /* add user to the database */
                CtdlPutUser(&(context->user));
                cdb_store(CDB_USERSBYNUMBER, &(context->user.usernum), sizeof(long), context->user.fullname, strlen(context->user.fullname)+1);
        }
 }
 
+/*
+ * flush it again...
+ */
+void CtdlClearSystemContext(void)
+{
+       CitContext *CCC = MyContext();
+
+       memset(CCC, 0, sizeof(CitContext));
+       citthread_setspecific(MyConKey, NULL);
+}
+
 /*
  * Cleanup any contexts that are left lying around
  */
@@ -454,8 +582,8 @@ void context_cleanup(void)
                /* Remove the session from the active list */
                rem = ptr->next;
                --num_sessions;
-               
-               CtdlLogPrintf(CTDL_DEBUG, "Purging session %d\n", ptr->cs_pid);
+
+               syslog(LOG_DEBUG, "Purging session #%d %s\n", ptr->cs_pid, ptr->ServiceName);
                RemoveContext(ptr);
                free (ptr);
                ptr = rem;
@@ -532,7 +660,7 @@ void dead_session_purge(int force) {
         * is allocated privately on this thread's stack.
         */
        while (rem != NULL) {
-               CtdlLogPrintf(CTDL_DEBUG, "Purging session %d\n", rem->cs_pid);
+               syslog(LOG_DEBUG, "Purging session %d\n", rem->cs_pid);
                RemoveContext(rem);
                ptr = rem;
                rem = rem->next;
@@ -557,12 +685,17 @@ void InitializeMasterCC(void) {
 
 
 
+
 /*
- * Bind a thread to a context.  (It's inline merely to speed things up.)
+ * Set the "async waiting" flag for a session, if applicable
  */
-INLINE void become_session(CitContext *which_con) {
-       citthread_setspecific(MyConKey, (void *)which_con );
+void set_async_waiting(struct CitContext *ccptr)
+{
+       syslog(LOG_DEBUG, "Setting async_waiting flag for session %d\n", ccptr->cs_pid);
+       if (ccptr->is_async) {
+               ccptr->async_waiting++;
+               if (ccptr->state == CON_IDLE) {
+                       ccptr->state = CON_READY;
+               }
+       }
 }
-
-
-