citadel/context.c

   1 /*
   2  * $Id: sysdep.c 7989 2009-10-31 15:29:37Z davew $
   3  *
   4  * Citadel context management stuff.
   5  * See COPYING for copyright information.
   6  *
   7  * Here's where we (hopefully) have all the code that manipulates contexts.
   8  *
   9  */
  10
  11 #include "sysdep.h"
  12 #include <stdlib.h>
  13 #include <unistd.h>
  14 #include <stdio.h>
  15 #include <fcntl.h>
  16 #include <ctype.h>
  17 #include <signal.h>
  18 #include <sys/types.h>
  19 #include <sys/stat.h>
  20 #include <sys/wait.h>
  21 #include <sys/socket.h>
  22 #include <syslog.h>
  23 #include <sys/syslog.h>
  24
  25 #if TIME_WITH_SYS_TIME
  26 # include <sys/time.h>
  27 # include <time.h>
  28 #else
  29 # if HAVE_SYS_TIME_H
  30 #  include <sys/time.h>
  31 # else
  32 #  include <time.h>
  33 # endif
  34 #endif
  35
  36 #include <limits.h>
  37 #include <sys/resource.h>
  38 #include <netinet/in.h>
  39 #include <netinet/tcp.h>
  40 #include <arpa/inet.h>
  41 #include <netdb.h>
  42 #include <sys/un.h>
  43 #include <string.h>
  44 #include <pwd.h>
  45 #include <errno.h>
  46 #include <stdarg.h>
  47 #include <grp.h>
  48 #include <libcitadel.h>
  49 #include "citadel.h"
  50 #include "server.h"
  51 #include "sysdep_decls.h"
  52 #include "citserver.h"
  53 #include "support.h"
  54 #include "config.h"
  55 #include "database.h"
  56 #include "housekeeping.h"
  57 #include "modules/crypto/serv_crypto.h" /* Needed for init_ssl, client_write_ssl, client_read_ssl, destruct_ssl */
  58 #include "ecrash.h"
  59
  60 #ifdef HAVE_SYS_SELECT_H
  61 #include <sys/select.h>
  62 #endif
  63
  64 #ifndef HAVE_SNPRINTF
  65 #include "snprintf.h"
  66 #endif
  67
  68 #include "ctdl_module.h"
  69 #include "threads.h"
  70 #include "user_ops.h"
  71 #include "control.h"
  72
  73
  74
  75 citthread_key_t MyConKey;                               /* TSD key for MyContext() */
  76
  77
  78 CitContext masterCC;
  79 CitContext *ContextList = NULL;
  80
  81 time_t last_purge = 0;                          /* Last dead session purge */
  82 int num_sessions = 0;                           /* Current number of sessions */
  83
  84 /* Flag for single user mode */
  85 static int want_single_user = 0;
  86
  87 /* Try to go single user */
  88
  89 int CtdlTrySingleUser(void)
  90 {
  91         int can_do = 0;
  92
  93         begin_critical_section(S_SINGLE_USER);
  94         if (want_single_user)
  95                 can_do = 0;
  96         else
  97         {
  98                 can_do = 1;
  99                 want_single_user = 1;
 100         }
 101         end_critical_section(S_SINGLE_USER);
 102         return can_do;
 103 }
 104
 105 void CtdlEndSingleUser(void)
 106 {
 107         begin_critical_section(S_SINGLE_USER);
 108         want_single_user = 0;
 109         end_critical_section(S_SINGLE_USER);
 110 }
 111
 112
 113 int CtdlWantSingleUser(void)
 114 {
 115         return want_single_user;
 116 }
 117
 118 int CtdlIsSingleUser(void)
 119 {
 120         if (want_single_user)
 121         {
 122                 /* check for only one context here */
 123                 if (num_sessions == 1)
 124                         return TRUE;
 125         }
 126         return FALSE;
 127 }
 128
 129
 130
 131
 132 /*
 133  * Check to see if the user who we just sent mail to is logged in.  If yes,
 134  * bump the 'new mail' counter for their session.  That enables them to
 135  * receive a new mail notification without having to hit the database.
 136  */
 137 void BumpNewMailCounter(long which_user)
 138 {
 139         CtdlBumpNewMailCounter(which_user);
 140 }
 141
 142 void CtdlBumpNewMailCounter(long which_user)
 143 {
 144         CitContext *ptr;
 145
 146         begin_critical_section(S_SESSION_TABLE);
 147
 148         for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
 149                 if (ptr->user.usernum == which_user) {
 150                         ptr->newmail += 1;
 151                 }
 152         }
 153
 154         end_critical_section(S_SESSION_TABLE);
 155 }
 156
 157
 158 /*
 159  * Check to see if a user is currently logged in
 160  * Take care with what you do as a result of this test.
 161  * The user may not have been logged in when this function was called BUT
 162  * because of threading the user might be logged in before you test the result.
 163  */
 164 int CtdlIsUserLoggedIn (char *user_name)
 165 {
 166         CitContext *cptr;
 167         int ret = 0;
 168
 169         begin_critical_section (S_SESSION_TABLE);
 170         for (cptr = ContextList; cptr != NULL; cptr = cptr->next) {
 171                 if (!strcasecmp(cptr->user.fullname, user_name)) {
 172                         ret = 1;
 173                         break;
 174                 }
 175         }
 176         end_critical_section(S_SESSION_TABLE);
 177         return ret;
 178 }
 179
 180
 181
 182 /*
 183  * Check to see if a user is currently logged in.
 184  * Basically same as CtdlIsUserLoggedIn() but uses the user number instead.
 185  * Take care with what you do as a result of this test.
 186  * The user may not have been logged in when this function was called BUT
 187  * because of threading the user might be logged in before you test the result.
 188  */
 189 int CtdlIsUserLoggedInByNum (long usernum)
 190 {
 191         CitContext *cptr;
 192         int ret = 0;
 193
 194         begin_critical_section(S_SESSION_TABLE);
 195         for (cptr = ContextList; cptr != NULL; cptr = cptr->next) {
 196                 if (cptr->user.usernum == usernum) {
 197                         ret = 1;
 198                 }
 199         }
 200         end_critical_section(S_SESSION_TABLE);
 201         return ret;
 202 }
 203
 204
 205
 206 /*
 207  * Return a pointer to the CitContext structure bound to the thread which
 208  * called this function.  If there's no such binding (for example, if it's
 209  * called by the housekeeper thread) then a generic 'master' CC is returned.
 210  *
 211  * This function is used *VERY* frequently and must be kept small.
 212  */
 213 CitContext *MyContext(void) {
 214
 215         register CitContext *c;
 216
 217         return ((c = (CitContext *) citthread_getspecific(MyConKey),
 218                 c == NULL) ? &masterCC : c
 219         );
 220 }
 221
 222
 223
 224
 225 /*
 226  * Terminate idle sessions.  This function pounds through the session table
 227  * comparing the current time to each session's time-of-last-command.  If an
 228  * idle session is found it is terminated, then the search restarts at the
 229  * beginning because the pointer to our place in the list becomes invalid.
 230  */
 231 void terminate_idle_sessions(void)
 232 {
 233         CitContext *ccptr;
 234         time_t now;
 235         int session_to_kill;
 236         int killed = 0;
 237         int longrunners = 0;
 238
 239         now = time(NULL);
 240         session_to_kill = 0;
 241         begin_critical_section(S_SESSION_TABLE);
 242         for (ccptr = ContextList; ccptr != NULL; ccptr = ccptr->next) {
 243                 if (  (ccptr!=CC)
 244                 && (config.c_sleeping > 0)
 245                 && (now - (ccptr->lastcmd) > config.c_sleeping) ) {
 246                         if (!ccptr->dont_term) {
 247                                 ccptr->kill_me = 1;
 248                                 ++killed;
 249                         }
 250                         else
 251                                 longrunners ++;
 252                 }
 253         }
 254         end_critical_section(S_SESSION_TABLE);
 255         if (killed > 0)
 256                 CtdlLogPrintf(CTDL_INFO, "Terminated %d idle sessions\n", killed);
 257         if (longrunners > 0)
 258                 CtdlLogPrintf(CTDL_INFO, "Didn't terminate %d protected idle sessions;\n", killed);
 259 }
 260
 261
 262
 263 /*
 264  * Terminate a session.
 265  */
 266 void RemoveContext (CitContext *con)
 267 {
 268         if (con==NULL) {
 269                 CtdlLogPrintf(CTDL_ERR,
 270                         "WARNING: RemoveContext() called with NULL!\n");
 271                 return;
 272         }
 273         CtdlLogPrintf(CTDL_DEBUG, "RemoveContext() session %d\n", con->cs_pid);
 274
 275         /* Run any cleanup routines registered by loadable modules.
 276          * Note: We have to "become_session()" because the cleanup functions
 277          *       might make references to "CC" assuming it's the right one.
 278          */
 279         become_session(con);
 280         CtdlUserLogout();
 281         PerformSessionHooks(EVT_STOP);
 282         become_session(NULL);
 283
 284         CtdlLogPrintf(CTDL_NOTICE, "[%3d] Session ended.\n", con->cs_pid);
 285
 286         /* If the client is still connected, blow 'em away. */
 287         CtdlLogPrintf(CTDL_DEBUG, "Closing socket %d\n", con->client_socket);
 288         close(con->client_socket);
 289
 290         /* If using AUTHMODE_LDAP, free the DN */
 291         if (con->ldap_dn) {
 292                 free(con->ldap_dn);
 293                 con->ldap_dn = NULL;
 294         }
 295
 296         CtdlLogPrintf(CTDL_DEBUG, "Done with RemoveContext()\n");
 297 }
 298
 299
 300
 301
 302 /*
 303  * Initialize a new context and place it in the list.  The session number
 304  * used to be the PID (which is why it's called cs_pid), but that was when we
 305  * had one process per session.  Now we just assign them sequentially, starting
 306  * at 1 (don't change it to 0 because masterCC uses 0).
 307  */
 308 CitContext *CreateNewContext(void) {
 309         CitContext *me;
 310         static int next_pid = 0;
 311
 312         me = (CitContext *) malloc(sizeof(CitContext));
 313         if (me == NULL) {
 314                 CtdlLogPrintf(CTDL_ALERT, "citserver: can't allocate memory!!\n");
 315                 return NULL;
 316         }
 317         memset(me, 0, sizeof(CitContext));
 318
 319         /* Give the contaxt a name. Hopefully makes it easier to track */
 320         strcpy (me->user.fullname, "SYS_notauth");
 321
 322         /* The new context will be created already in the CON_EXECUTING state
 323          * in order to prevent another thread from grabbing it while it's
 324          * being set up.
 325          */
 326         me->state = CON_EXECUTING;
 327         /*
 328          * Generate a unique session number and insert this context into
 329          * the list.
 330          */
 331         begin_critical_section(S_SESSION_TABLE);
 332         me->cs_pid = ++next_pid;
 333         me->prev = NULL;
 334         me->next = ContextList;
 335         ContextList = me;
 336         if (me->next != NULL) {
 337                 me->next->prev = me;
 338         }
 339         ++num_sessions;
 340         end_critical_section(S_SESSION_TABLE);
 341         return (me);
 342 }
 343
 344
 345 CitContext *CtdlGetContextArray(int *count)
 346 {
 347         int nContexts, i;
 348         CitContext *nptr, *cptr;
 349
 350         nContexts = num_sessions;
 351         nptr = malloc(sizeof(CitContext) * nContexts);
 352         if (!nptr)
 353                 return NULL;
 354         begin_critical_section(S_SESSION_TABLE);
 355         for (cptr = ContextList, i=0; cptr != NULL && i < nContexts; cptr = cptr->next, i++)
 356                 memcpy(&nptr[i], cptr, sizeof (CitContext));
 357         end_critical_section (S_SESSION_TABLE);
 358
 359         *count = i;
 360         return nptr;
 361 }
 362
 363
 364
 365 /**
 366  * This function fills in a context and its user field correctly
 367  * Then creates/loads that user
 368  */
 369 void CtdlFillSystemContext(CitContext *context, char *name)
 370 {
 371         char sysname[USERNAME_SIZE];
 372
 373         memset(context, 0, sizeof(CitContext));
 374         context->internal_pgm = 1;
 375         context->cs_pid = 0;
 376         strcpy (sysname, "SYS_");
 377         strcat (sysname, name);
 378         /* internal_create_user has the side effect of loading the user regardless of wether they
 379          * already existed or needed to be created
 380          */
 381         internal_create_user (sysname, &(context->user), -1) ;
 382
 383         /* Check to see if the system user needs upgrading */
 384         if (context->user.usernum == 0)
 385         {       /* old system user with number 0, upgrade it */
 386                 context->user.usernum = get_new_user_number();
 387                 CtdlLogPrintf(CTDL_DEBUG, "Upgrading system user \"%s\" from user number 0 to user number %d\n", context->user.fullname, context->user.usernum);
 388                 /* add user to the database */
 389                 CtdlPutUser(&(context->user));
 390                 cdb_store(CDB_USERSBYNUMBER, &(context->user.usernum), sizeof(long), context->user.fullname, strlen(context->user.fullname)+1);
 391         }
 392 }
 393
 394 /*
 395  * Cleanup any contexts that are left lying around
 396  */
 397 void context_cleanup(void)
 398 {
 399         CitContext *ptr = NULL;
 400         CitContext *rem = NULL;
 401
 402         /*
 403          * Clean up the contexts.
 404          * There are no threads so no critical_section stuff is needed.
 405          */
 406         ptr = ContextList;
 407
 408         /* We need to update the ContextList because some modules may want to itterate it
 409          * Question is should we NULL it before iterating here or should we just keep updating it
 410          * as we remove items?
 411          *
 412          * Answer is to NULL it first to prevent modules from doing any actions on the list at all
 413          */
 414         ContextList=NULL;
 415         while (ptr != NULL){
 416                 /* Remove the session from the active list */
 417                 rem = ptr->next;
 418                 --num_sessions;
 419
 420                 CtdlLogPrintf(CTDL_DEBUG, "Purging session %d\n", ptr->cs_pid);
 421                 RemoveContext(ptr);
 422                 free (ptr);
 423                 ptr = rem;
 424         }
 425 }
 426
 427
 428
 429 /*
 430  * Terminate another session.
 431  * (This could justifiably be moved out of sysdep.c because it
 432  * no longer does anything that is system-dependent.)
 433  */
 434 void kill_session(int session_to_kill) {
 435         CitContext *ptr;
 436
 437         begin_critical_section(S_SESSION_TABLE);
 438         for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
 439                 if (ptr->cs_pid == session_to_kill) {
 440                         ptr->kill_me = 1;
 441                 }
 442         }
 443         end_critical_section(S_SESSION_TABLE);
 444 }
 445
 446 /*
 447  * Purge all sessions which have the 'kill_me' flag set.
 448  * This function has code to prevent it from running more than once every
 449  * few seconds, because running it after every single unbind would waste a lot
 450  * of CPU time and keep the context list locked too much.  To force it to run
 451  * anyway, set "force" to nonzero.
 452  */
 453 void dead_session_purge(int force) {
 454         CitContext *ptr, *ptr2;         /* general-purpose utility pointer */
 455         CitContext *rem = NULL; /* list of sessions to be destroyed */
 456
 457         if (force == 0) {
 458                 if ( (time(NULL) - last_purge) < 5 ) {
 459                         return; /* Too soon, go away */
 460                 }
 461         }
 462         time(&last_purge);
 463
 464         if (try_critical_section(S_SESSION_TABLE))
 465                 return;
 466
 467         ptr = ContextList;
 468         while (ptr) {
 469                 ptr2 = ptr;
 470                 ptr = ptr->next;
 471
 472                 if ( (ptr2->state == CON_IDLE) && (ptr2->kill_me) ) {
 473                         /* Remove the session from the active list */
 474                         if (ptr2->prev) {
 475                                 ptr2->prev->next = ptr2->next;
 476                         }
 477                         else {
 478                                 ContextList = ptr2->next;
 479                         }
 480                         if (ptr2->next) {
 481                                 ptr2->next->prev = ptr2->prev;
 482                         }
 483
 484                         --num_sessions;
 485                         /* And put it on our to-be-destroyed list */
 486                         ptr2->next = rem;
 487                         rem = ptr2;
 488                 }
 489         }
 490         end_critical_section(S_SESSION_TABLE);
 491
 492         /* Now that we no longer have the session list locked, we can take
 493          * our time and destroy any sessions on the to-be-killed list, which
 494          * is allocated privately on this thread's stack.
 495          */
 496         while (rem != NULL) {
 497                 CtdlLogPrintf(CTDL_DEBUG, "Purging session %d\n", rem->cs_pid);
 498                 RemoveContext(rem);
 499                 ptr = rem;
 500                 rem = rem->next;
 501                 free(ptr);
 502         }
 503 }
 504
 505
 506
 507
 508
 509 /*
 510  * masterCC is the context we use when not attached to a session.  This
 511  * function initializes it.
 512  */
 513 void InitializeMasterCC(void) {
 514         memset(&masterCC, 0, sizeof( CitContext));
 515         masterCC.internal_pgm = 1;
 516         masterCC.cs_pid = 0;
 517 }
 518
 519
 520
 521
 522 /*
 523  * Bind a thread to a context.  (It's inline merely to speed things up.)
 524  */
 525 INLINE void become_session(CitContext *which_con) {
 526         citthread_setspecific(MyConKey, (void *)which_con );
 527 }
 528
 529
 530