random boilerplate
[citadel.git] / citadel / context.c
index 576e9359c7da3cc9efeea5b6f6644d8e740f174f..1a2816f5491aaa555b7e858862fb3066e27e9bdb 100644 (file)
@@ -1,22 +1,15 @@
-/*
- * Citadel context management stuff.
- * Here's where we (hopefully) have all the code that manipulates contexts.
- *
- * Copyright (c) 1987-2015 by the citadel.org team
- *
- * This program is open source software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License, version 3.
- *
- * 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.
- */
+//
+// Citadel context management stuff.
+// Here's where we (hopefully) have all the code that manipulates contexts.
+//
+// Copyright (c) 1987-2020 by the citadel.org team
+//
+// This program is open source software.  Use, duplication, or disclosure
+// is subject to the terms of the GNU General Public License, version 3.
+// The program is distributed without any warranty, expressed or implied.
 
 #include "ctdl_module.h"
 #include "serv_extensions.h"
-#include "ecrash.h"
-
 #include "citserver.h"
 #include "user_ops.h"
 #include "locate_host.h"
 #include "control.h"
 #include "config.h"
 
-int DebugSession = 0;
-
 pthread_key_t MyConKey;                                /* TSD key for MyContext() */
-
-
 CitContext masterCC;
 CitContext *ContextList = NULL;
-
 time_t last_purge = 0;                         /* Last dead session purge */
 int num_sessions = 0;                          /* Current number of sessions */
 int next_pid = 0;
@@ -57,6 +45,7 @@ int CtdlTrySingleUser(void)
        return can_do;
 }
 
+
 void CtdlEndSingleUser(void)
 {
        begin_critical_section(S_SINGLE_USER);
@@ -70,21 +59,19 @@ int CtdlWantSingleUser(void)
        return want_single_user;
 }
 
+
 int CtdlIsSingleUser(void)
 {
        if (want_single_user)
        {
                /* check for only one context here */
                if (num_sessions == 1)
-                       return TRUE;
+                       return 1;
        }
-       return FALSE;
+       return 0;
 }
 
 
-
-
-
 /*
  * Locate a context by its session number and terminate it if the user is able.
  * User can NOT terminate their current session.
@@ -102,7 +89,7 @@ int CtdlTerminateOtherSession (int session_num)
 
        aide = ( (CCC->user.axlevel >= AxAideU) || (CCC->internal_pgm) ) ;
 
-       CONM_syslog(LOG_DEBUG, "Locating session to kill\n");
+       syslog(LOG_DEBUG, "context: locating session to kill");
        begin_critical_section(S_SESSION_TABLE);
        for (ccptr = ContextList; ccptr != NULL; ccptr = ccptr->next) {
                if (session_num == ccptr->cs_pid) {
@@ -116,19 +103,11 @@ int CtdlTerminateOtherSession (int session_num)
 
        if (((ret & TERM_FOUND) != 0) && ((ret & TERM_ALLOWED) != 0))
        {
-               if (ccptr->IO != NULL) {
-                       AsyncIO *IO = ccptr->IO;
-                       end_critical_section(S_SESSION_TABLE);
-                       KillAsyncIOContext(IO);
-               }
+               if (ccptr->user.usernum == CCC->user.usernum)
+                       ccptr->kill_me = KILLME_ADMIN_TERMINATE;
                else
-               {
-                       if (ccptr->user.usernum == CCC->user.usernum)
-                               ccptr->kill_me = KILLME_ADMIN_TERMINATE;
-                       else
-                               ccptr->kill_me = KILLME_IDLE;
-                       end_critical_section(S_SESSION_TABLE);
-               }
+                       ccptr->kill_me = KILLME_IDLE;
+               end_critical_section(S_SESSION_TABLE);
        }
        else
                end_critical_section(S_SESSION_TABLE);
@@ -258,10 +237,12 @@ void terminate_idle_sessions(void)
                }
        }
        end_critical_section(S_SESSION_TABLE);
-       if (killed > 0)
-               CON_syslog(LOG_INFO, "Scheduled %d idle sessions for termination\n", killed);
-       if (longrunners > 0)
-               CON_syslog(LOG_INFO, "Didn't terminate %d protected idle sessions", longrunners);
+       if (killed > 0) {
+               syslog(LOG_INFO, "context: scheduled %d idle sessions for termination", killed);
+       }
+       if (longrunners > 0) {
+               syslog(LOG_INFO, "context: did not terminate %d protected idle sessions", longrunners);
+       }
 }
 
 
@@ -277,12 +258,7 @@ void terminate_all_sessions(void)
        for (ccptr = ContextList; ccptr != NULL; ccptr = ccptr->next) {
                if (ccptr->client_socket != -1)
                {
-                       if (ccptr->IO != NULL) {
-                               CON_syslog(LOG_INFO, "terminate_all_sessions() is murdering %s IO[%ld]CC[%d]", ccptr->curr_user, ccptr->IO->ID, ccptr->cs_pid);
-                       }
-                       else {
-                               CON_syslog(LOG_INFO, "terminate_all_sessions() is murdering %s CC[%d]", ccptr->curr_user, ccptr->cs_pid);
-                       }
+                       syslog(LOG_INFO, "context: terminate_all_sessions() is murdering %s CC[%d]", ccptr->curr_user, ccptr->cs_pid);
                        close(ccptr->client_socket);
                        ccptr->client_socket = -1;
                        killed++;
@@ -290,7 +266,7 @@ void terminate_all_sessions(void)
        }
        end_critical_section(S_SESSION_TABLE);
        if (killed > 0) {
-               CON_syslog(LOG_INFO, "Flushed %d stuck sessions\n", killed);
+               syslog(LOG_INFO, "context: flushed %d stuck sessions", killed);
        }
 }
 
@@ -303,15 +279,14 @@ void RemoveContext (CitContext *con)
 {
        const char *c;
        if (con == NULL) {
-               CONM_syslog(LOG_ERR, "WARNING: RemoveContext() called with NULL!");
+               syslog(LOG_ERR, "context: RemoveContext() called with NULL, this should not happen");
                return;
        }
        c = con->ServiceName;
        if (c == NULL) {
                c = "WTF?";
        }
-       CON_syslog(LOG_DEBUG, "RemoveContext(%s) session %d", c, con->cs_pid);
-///    cit_backtrace();
+       syslog(LOG_DEBUG, "context: RemoveContext(%s) session %d", c, con->cs_pid);
 
        /* Run any cleanup routines registered by loadable modules.
         * Note: We have to "become_session()" because the cleanup functions
@@ -323,7 +298,7 @@ void RemoveContext (CitContext *con)
        client_close();                         /* If the client is still connected, blow 'em away. */
        become_session(NULL);
 
-       CON_syslog(LOG_NOTICE, "[%3d]SRV[%s] Session ended.", con->cs_pid, c);
+       syslog(LOG_INFO, "context: [%3d]SRV[%s] Session ended.", con->cs_pid, c);
 
        /* 
         * If the client is still connected, blow 'em away. 
@@ -331,7 +306,7 @@ void RemoveContext (CitContext *con)
         */
        if (con->client_socket > 0)
        {
-               CON_syslog(LOG_NOTICE, "Closing socket %d", con->client_socket);
+               syslog(LOG_INFO, "context: closing socket %d", con->client_socket);
                close(con->client_socket);
        }
 
@@ -347,7 +322,7 @@ void RemoveContext (CitContext *con)
                free(con->cached_msglist);
        }
 
-       CONM_syslog(LOG_DEBUG, "Done with RemoveContext()");
+       syslog(LOG_DEBUG, "context: done with RemoveContext()");
 }
 
 
@@ -363,7 +338,7 @@ CitContext *CreateNewContext(void) {
 
        me = (CitContext *) malloc(sizeof(CitContext));
        if (me == NULL) {
-               CONM_syslog(LOG_ALERT, "citserver: can't allocate memory!!\n");
+               syslog(LOG_ERR, "citserver: malloc() failed: %m");
                return NULL;
        }
        memset(me, 0, sizeof(CitContext));
@@ -412,7 +387,7 @@ CitContext *CloneContext(CitContext *CloneMe) {
 
        me = (CitContext *) malloc(sizeof(CitContext));
        if (me == NULL) {
-               CONM_syslog(LOG_ALERT, "citserver: can't allocate memory!!\n");
+               syslog(LOG_ERR, "citserver: malloc() failed: %m");
                return NULL;
        }
        memcpy(me, CloneMe, sizeof(CitContext));
@@ -510,16 +485,12 @@ void begin_session(CitContext *con)
        strcpy(con->lastcmdname, "    ");
        strcpy(con->cs_clientname, "(unknown)");
        strcpy(con->curr_user, NLI);
-       *con->net_node = '\0';
-       *con->fake_username = '\0';
-       *con->fake_hostname = '\0';
-       *con->fake_roomname = '\0';
        *con->cs_clientinfo = '\0';
        safestrncpy(con->cs_host, CtdlGetConfigStr("c_fqdn"), sizeof con->cs_host);
        safestrncpy(con->cs_addr, "", sizeof con->cs_addr);
        con->cs_UDSclientUID = -1;
        con->cs_host[sizeof con->cs_host - 1] = 0;
-       if (!CC->is_local_socket) {
+       if (!CC->is_local_client) {
                locate_host(con->cs_host, sizeof con->cs_host,
                        con->cs_addr, sizeof con->cs_addr,
                        con->client_socket
@@ -536,7 +507,7 @@ void begin_session(CitContext *con)
                        
                        /*fill in the user data structure */
                        if(getsockopt(con->client_socket, SOL_SOCKET, SO_PEERCRED, &credentials, &ucred_length)) {
-                               syslog(LOG_NOTICE, "could obtain credentials from unix domain socket");
+                               syslog(LOG_ERR, "context: could obtain credentials from unix domain socket");
                                
                        }
                        else {          
@@ -563,20 +534,15 @@ void begin_session(CitContext *con)
 #endif
        }
        con->cs_flags = 0;
-       con->upload_type = UPL_FILE;
-       con->dl_is_net = 0;
 
        con->nologin = 0;
        if (((CtdlGetConfigInt("c_maxsessions") > 0)&&(num_sessions > CtdlGetConfigInt("c_maxsessions"))) || CtdlWantSingleUser()) {
                con->nologin = 1;
        }
 
-       if (!CC->is_local_socket) {
-               syslog(LOG_NOTICE, "Session (%s) started from %s (%s).\n", con->ServiceName, con->cs_host, con->cs_addr);
-       }
-       else {
-               syslog(LOG_NOTICE, "Session (%s) started via local socket UID:%d.\n", con->ServiceName, con->cs_UDSclientUID);
-       }
+       syslog(LOG_INFO, "context: session (%s) started from %s (%s) uid=%d",
+               con->ServiceName, con->cs_host, con->cs_addr, con->cs_UDSclientUID
+       );
 
        /* Run any session startup routines registered by loadable modules */
        PerformSessionHooks(EVT_START);
@@ -597,22 +563,22 @@ void CtdlFillSystemContext(CitContext *context, char *name)
        context->cs_pid = 0;
        strcpy (sysname, "SYS_");
        strcat (sysname, name);
-       len = cutuserkey(sysname);
+       len = strlen(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
+       /* internal_create_user has the side effect of loading the user regardless of whether they
         * already existed or needed to be created
         */
-       internal_create_user (sysname, len, &(context->user), -1) ;
+       internal_create_user(sysname, &(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();
-               CON_syslog(LOG_INFO, "Upgrading system user \"%s\" from user number 0 to user number %ld\n", context->user.fullname, context->user.usernum);
+               syslog(LOG_INFO, "context: upgrading system user \"%s\" from user number 0 to user number %ld", 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);
@@ -646,7 +612,7 @@ void context_cleanup(void)
                rem = ptr->next;
                --num_sessions;
 
-               CON_syslog(LOG_DEBUG, "context_cleanup(): purging session %d\n", ptr->cs_pid);
+               syslog(LOG_DEBUG, "context: context_cleanup() purging session %d", ptr->cs_pid);
                RemoveContext(ptr);
                free (ptr);
                ptr = rem;
@@ -706,7 +672,7 @@ void dead_session_purge(int force) {
         * is allocated privately on this thread's stack.
         */
        while (rem != NULL) {
-               CON_syslog(LOG_DEBUG, "dead_session_purge(): purging session %d, reason=%d\n", rem->cs_pid, rem->kill_me);
+               syslog(LOG_DEBUG, "context: dead_session_purge() purging session %d, reason=%d", rem->cs_pid, rem->kill_me);
                RemoveContext(rem);
                ptr = rem;
                rem = rem->next;
@@ -737,7 +703,7 @@ void InitializeMasterCC(void) {
  */
 void set_async_waiting(struct CitContext *ccptr)
 {
-       CON_syslog(LOG_DEBUG, "Setting async_waiting flag for session %d\n", ccptr->cs_pid);
+       syslog(LOG_DEBUG, "context: setting async_waiting flag for session %d", ccptr->cs_pid);
        if (ccptr->is_async) {
                ccptr->async_waiting++;
                if (ccptr->state == CON_IDLE) {
@@ -747,14 +713,9 @@ void set_async_waiting(struct CitContext *ccptr)
 }
 
 
-void DebugSessionEnable(const int n)
-{
-       DebugSession = n;
-}
 CTDL_MODULE_INIT(session)
 {
        if (!threading) {
-               CtdlRegisterDebugFlagHook(HKEY("session"), DebugSessionEnable, &DebugSession);
        }
        return "session";
 }