citadel/context.c

   1 /*
   2  * Citadel context management stuff.
   3  * Here's where we (hopefully) have all the code that manipulates contexts.
   4  *
   5  * Copyright (c) 1987-2011 by the citadel.org team
   6  *
   7  * This program is open source software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  20  */
  21
  22 #include "sysdep.h"
  23 #include <stdlib.h>
  24 #include <unistd.h>
  25 #include <stdio.h>
  26 #include <fcntl.h>
  27 #include <ctype.h>
  28 #include <signal.h>
  29 #include <sys/types.h>
  30 #include <sys/stat.h>
  31 #include <sys/wait.h>
  32 #include <sys/socket.h>
  33 #include <syslog.h>
  34 #include <sys/syslog.h>
  35 /*
  36 #include <sys/syscall.h>
  37 */
  38
  39 #if TIME_WITH_SYS_TIME
  40 # include <sys/time.h>
  41 # include <time.h>
  42 #else
  43 # if HAVE_SYS_TIME_H
  44 #  include <sys/time.h>
  45 # else
  46 #  include <time.h>
  47 # endif
  48 #endif
  49
  50 #include <limits.h>
  51 #include <sys/resource.h>
  52 #include <netinet/in.h>
  53 #include <netinet/tcp.h>
  54 #include <arpa/inet.h>
  55 #include <netdb.h>
  56 #include <sys/un.h>
  57 #include <string.h>
  58 #include <pwd.h>
  59 #include <errno.h>
  60 #include <stdarg.h>
  61 #include <grp.h>
  62 #include <libcitadel.h>
  63 #include "citadel.h"
  64 #include "server.h"
  65 #include "sysdep_decls.h"
  66 #include "citserver.h"
  67 #include "support.h"
  68 #include "config.h"
  69 #include "database.h"
  70 #include "housekeeping.h"
  71 #include "modules/crypto/serv_crypto.h" /* Needed for init_ssl, client_write_ssl, client_read_ssl, destruct_ssl */
  72 #include "ecrash.h"
  73
  74 #ifdef HAVE_SYS_SELECT_H
  75 #include <sys/select.h>
  76 #endif
  77
  78 #ifndef HAVE_SNPRINTF
  79 #include "snprintf.h"
  80 #endif
  81
  82 #include "ctdl_module.h"
  83 #include "threads.h"
  84 #include "user_ops.h"
  85 #include "control.h"
  86
  87
  88
  89 pthread_key_t MyConKey;                         /* TSD key for MyContext() */
  90
  91
  92 CitContext masterCC;
  93 CitContext *ContextList = NULL;
  94
  95 time_t last_purge = 0;                          /* Last dead session purge */
  96 int num_sessions = 0;                           /* Current number of sessions */
  97
  98 /* Flag for single user mode */
  99 static int want_single_user = 0;
 100
 101 /* Try to go single user */
 102
 103 int CtdlTrySingleUser(void)
 104 {
 105         int can_do = 0;
 106
 107         begin_critical_section(S_SINGLE_USER);
 108         if (want_single_user)
 109                 can_do = 0;
 110         else
 111         {
 112                 can_do = 1;
 113                 want_single_user = 1;
 114         }
 115         end_critical_section(S_SINGLE_USER);
 116         return can_do;
 117 }
 118
 119 void CtdlEndSingleUser(void)
 120 {
 121         begin_critical_section(S_SINGLE_USER);
 122         want_single_user = 0;
 123         end_critical_section(S_SINGLE_USER);
 124 }
 125
 126
 127 int CtdlWantSingleUser(void)
 128 {
 129         return want_single_user;
 130 }
 131
 132 int CtdlIsSingleUser(void)
 133 {
 134         if (want_single_user)
 135         {
 136                 /* check for only one context here */
 137                 if (num_sessions == 1)
 138                         return TRUE;
 139         }
 140         return FALSE;
 141 }
 142
 143
 144
 145
 146
 147 /*
 148  * Locate a context by its session number and terminate it if the user is able.
 149  * User can NOT terminate their current session.
 150  * User CAN terminate any other session that has them logged in.
 151  * Aide CAN terminate any session except the current one.
 152  */
 153 int CtdlTerminateOtherSession (int session_num)
 154 {
 155         int ret = 0;
 156         CitContext *ccptr;
 157
 158         if (session_num == CC->cs_pid) {
 159                 return TERM_NOTALLOWED;
 160         }
 161
 162         syslog(LOG_DEBUG, "Locating session to kill\n");
 163         begin_critical_section(S_SESSION_TABLE);
 164         for (ccptr = ContextList; ccptr != NULL; ccptr = ccptr->next) {
 165                 if (session_num == ccptr->cs_pid) {
 166                         ret |= TERM_FOUND;
 167                         if ((ccptr->user.usernum == CC->user.usernum)
 168                            || (CC->user.axlevel >= AxAideU)) {
 169                                 ret |= TERM_ALLOWED;
 170                                 ccptr->kill_me = KILLME_ADMIN_TERMINATE;
 171                         }
 172                 }
 173         }
 174         end_critical_section(S_SESSION_TABLE);
 175         return ret;
 176 }
 177
 178
 179
 180 /*
 181  * Check to see if the user who we just sent mail to is logged in.  If yes,
 182  * bump the 'new mail' counter for their session.  That enables them to
 183  * receive a new mail notification without having to hit the database.
 184  */
 185 void BumpNewMailCounter(long which_user)
 186 {
 187         CtdlBumpNewMailCounter(which_user);
 188 }
 189
 190 void CtdlBumpNewMailCounter(long which_user)
 191 {
 192         CitContext *ptr;
 193
 194         begin_critical_section(S_SESSION_TABLE);
 195
 196         for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
 197                 if (ptr->user.usernum == which_user) {
 198                         ptr->newmail += 1;
 199                 }
 200         }
 201
 202         end_critical_section(S_SESSION_TABLE);
 203 }
 204
 205
 206 /*
 207  * Check to see if a user is currently logged in
 208  * Take care with what you do as a result of this test.
 209  * The user may not have been logged in when this function was called BUT
 210  * because of threading the user might be logged in before you test the result.
 211  */
 212 int CtdlIsUserLoggedIn (char *user_name)
 213 {
 214         CitContext *cptr;
 215         int ret = 0;
 216
 217         begin_critical_section (S_SESSION_TABLE);
 218         for (cptr = ContextList; cptr != NULL; cptr = cptr->next) {
 219                 if (!strcasecmp(cptr->user.fullname, user_name)) {
 220                         ret = 1;
 221                         break;
 222                 }
 223         }
 224         end_critical_section(S_SESSION_TABLE);
 225         return ret;
 226 }
 227
 228
 229
 230 /*
 231  * Check to see if a user is currently logged in.
 232  * Basically same as CtdlIsUserLoggedIn() but uses the user number instead.
 233  * Take care with what you do as a result of this test.
 234  * The user may not have been logged in when this function was called BUT
 235  * because of threading the user might be logged in before you test the result.
 236  */
 237 int CtdlIsUserLoggedInByNum (long usernum)
 238 {
 239         CitContext *cptr;
 240         int ret = 0;
 241
 242         begin_critical_section(S_SESSION_TABLE);
 243         for (cptr = ContextList; cptr != NULL; cptr = cptr->next) {
 244                 if (cptr->user.usernum == usernum) {
 245                         ret = 1;
 246                 }
 247         }
 248         end_critical_section(S_SESSION_TABLE);
 249         return ret;
 250 }
 251
 252
 253
 254 /*
 255  * Return a pointer to the CitContext structure bound to the thread which
 256  * called this function.  If there's no such binding (for example, if it's
 257  * called by the housekeeper thread) then a generic 'master' CC is returned.
 258  *
 259  * This function is used *VERY* frequently and must be kept small.
 260  */
 261 CitContext *MyContext(void) {
 262         register CitContext *c;
 263         return ((c = (CitContext *) pthread_getspecific(MyConKey), c == NULL) ? &masterCC : c);
 264 }
 265
 266
 267
 268
 269 /*
 270  * Terminate idle sessions.  This function pounds through the session table
 271  * comparing the current time to each session's time-of-last-command.  If an
 272  * idle session is found it is terminated, then the search restarts at the
 273  * beginning because the pointer to our place in the list becomes invalid.
 274  */
 275 void terminate_idle_sessions(void)
 276 {
 277         CitContext *ccptr;
 278         time_t now;
 279         int session_to_kill;
 280         int killed = 0;
 281         int longrunners = 0;
 282
 283         now = time(NULL);
 284         session_to_kill = 0;
 285         begin_critical_section(S_SESSION_TABLE);
 286         for (ccptr = ContextList; ccptr != NULL; ccptr = ccptr->next) {
 287                 if (  (ccptr!=CC)
 288                 && (config.c_sleeping > 0)
 289                 && (now - (ccptr->lastcmd) > config.c_sleeping) ) {
 290                         if (!ccptr->dont_term) {
 291                                 ccptr->kill_me = KILLME_IDLE;
 292                                 ++killed;
 293                         }
 294                         else
 295                                 longrunners ++;
 296                 }
 297         }
 298         end_critical_section(S_SESSION_TABLE);
 299         if (killed > 0)
 300                 syslog(LOG_INFO, "Scheduled %d idle sessions for termination\n", killed);
 301         if (longrunners > 0)
 302                 syslog(LOG_INFO, "Didn't terminate %d protected idle sessions;\n", killed);
 303 }
 304
 305
 306 /*
 307  * During shutdown, close the sockets of any sessions still connected.
 308  */
 309 void terminate_all_sessions(void)
 310 {
 311         CitContext *ccptr;
 312         int killed = 0;
 313
 314         begin_critical_section(S_SESSION_TABLE);
 315         for (ccptr = ContextList; ccptr != NULL; ccptr = ccptr->next) {
 316                 if (ccptr->client_socket != -1)
 317                 {
 318                         syslog(LOG_INFO, "terminate_all_sessions() is murdering %s", ccptr->curr_user);
 319                         close(ccptr->client_socket);
 320                         ccptr->client_socket = -1;
 321                         killed++;
 322                 }
 323         }
 324         end_critical_section(S_SESSION_TABLE);
 325         if (killed > 0) {
 326                 syslog(LOG_INFO, "Flushed %d stuck sessions\n", killed);
 327         }
 328 }
 329
 330
 331
 332 /*
 333  * Terminate a session.
 334  */
 335 void RemoveContext (CitContext *con)
 336 {
 337         const char *c;
 338         if (con==NULL) {
 339                 syslog(LOG_ERR, "WARNING: RemoveContext() called with NULL!\n");
 340                 return;
 341         }
 342         c = con->ServiceName;
 343         if (c == NULL)
 344                 c = "WTF?";
 345         syslog(LOG_DEBUG, "RemoveContext(%s) session %d\n", c, con->cs_pid);
 346         cit_backtrace ();
 347
 348         /* Run any cleanup routines registered by loadable modules.
 349          * Note: We have to "become_session()" because the cleanup functions
 350          *       might make references to "CC" assuming it's the right one.
 351          */
 352         become_session(con);
 353         CtdlUserLogout();
 354         PerformSessionHooks(EVT_STOP);
 355         client_close();                         /* If the client is still connected, blow 'em away. */
 356         become_session(NULL);
 357
 358         syslog(LOG_NOTICE, "[%3d] Session ended.\n", con->cs_pid);
 359
 360         /* If using AUTHMODE_LDAP, free the DN */
 361         if (con->ldap_dn) {
 362                 free(con->ldap_dn);
 363                 con->ldap_dn = NULL;
 364         }
 365
 366         FreeStrBuf(&con->MigrateBuf);
 367         FreeStrBuf(&con->RecvBuf.Buf);
 368         if (con->cached_msglist) {
 369                 free(con->cached_msglist);
 370         }
 371
 372         syslog(LOG_DEBUG, "Done with RemoveContext()\n");
 373 }
 374
 375
 376
 377 /*
 378  * Initialize a new context and place it in the list.  The session number
 379  * used to be the PID (which is why it's called cs_pid), but that was when we
 380  * had one process per session.  Now we just assign them sequentially, starting
 381  * at 1 (don't change it to 0 because masterCC uses 0).
 382  */
 383 CitContext *CreateNewContext(void) {
 384         CitContext *me;
 385         static int next_pid = 0;
 386
 387         me = (CitContext *) malloc(sizeof(CitContext));
 388         if (me == NULL) {
 389                 syslog(LOG_ALERT, "citserver: can't allocate memory!!\n");
 390                 return NULL;
 391         }
 392         memset(me, 0, sizeof(CitContext));
 393
 394         /* Give the context a name. Hopefully makes it easier to track */
 395         strcpy (me->user.fullname, "SYS_notauth");
 396
 397         /* The new context will be created already in the CON_EXECUTING state
 398          * in order to prevent another thread from grabbing it while it's
 399          * being set up.
 400          */
 401         me->state = CON_EXECUTING;
 402         /*
 403          * Generate a unique session number and insert this context into
 404          * the list.
 405          */
 406         me->MigrateBuf = NewStrBuf();
 407
 408         me->RecvBuf.Buf = NewStrBuf();
 409
 410         me->lastcmd = time(NULL);       /* set lastcmd to now to prevent idle timer infanticide TODO: if we have a valid IO, use that to set the timer. */
 411
 412
 413         begin_critical_section(S_SESSION_TABLE);
 414         me->cs_pid = ++next_pid;
 415         me->prev = NULL;
 416         me->next = ContextList;
 417         ContextList = me;
 418         if (me->next != NULL) {
 419                 me->next->prev = me;
 420         }
 421         ++num_sessions;
 422         end_critical_section(S_SESSION_TABLE);
 423         return (me);
 424 }
 425
 426
 427 /*
 428  * Initialize a new context and place it in the list.  The session number
 429  * used to be the PID (which is why it's called cs_pid), but that was when we
 430  * had one process per session.  Now we just assign them sequentially, starting
 431  * at 1 (don't change it to 0 because masterCC uses 0).
 432  */
 433 CitContext *CloneContext(CitContext *CloneMe) {
 434         CitContext *me;
 435         static int next_pid = 0;
 436
 437         me = (CitContext *) malloc(sizeof(CitContext));
 438         if (me == NULL) {
 439                 syslog(LOG_ALERT, "citserver: can't allocate memory!!\n");
 440                 return NULL;
 441         }
 442         memcpy(me, CloneMe, sizeof(CitContext));
 443
 444         memset(&me->RecvBuf, 0, sizeof(IOBuffer));
 445         memset(&me->SendBuf, 0, sizeof(IOBuffer));
 446         memset(&me->SBuf, 0, sizeof(IOBuffer));
 447         me->MigrateBuf = NULL;
 448         me->sMigrateBuf = NULL;
 449         me->redirect_buffer = NULL;
 450 #ifdef HAVE_OPENSSL
 451         me->ssl = NULL;
 452 #endif
 453
 454         me->download_fp = NULL;
 455         me->upload_fp = NULL;
 456         /// TODO: what about the room/user?
 457         me->ma = NULL;
 458         me->openid_data = NULL;
 459         me->ldap_dn = NULL;
 460         me->session_specific_data = NULL;
 461
 462         me->download_fp = NULL;
 463         me->upload_fp = NULL;
 464         me->client_socket = 0;
 465
 466         me->MigrateBuf = NewStrBuf();
 467         me->RecvBuf.Buf = NewStrBuf();
 468
 469         begin_critical_section(S_SESSION_TABLE);
 470         {
 471                 me->cs_pid = ++next_pid;
 472                 me->prev = NULL;
 473                 me->next = ContextList;
 474                 me->lastcmd = time(NULL);       /* set lastcmd to now to prevent idle timer infanticide */
 475                 ContextList = me;
 476                 if (me->next != NULL) {
 477                         me->next->prev = me;
 478                 }
 479                 ++num_sessions;
 480         }
 481         end_critical_section(S_SESSION_TABLE);
 482         return (me);
 483 }
 484
 485
 486 /*
 487  * Return an array containing a copy of the context list.
 488  * This allows worker threads to perform "for each context" operations without
 489  * having to lock and traverse the live list.
 490  */
 491 CitContext *CtdlGetContextArray(int *count)
 492 {
 493         int nContexts, i;
 494         CitContext *nptr, *cptr;
 495
 496         nContexts = num_sessions;
 497         nptr = malloc(sizeof(CitContext) * nContexts);
 498         if (!nptr) {
 499                 *count = 0;
 500                 return NULL;
 501         }
 502         begin_critical_section(S_SESSION_TABLE);
 503         for (cptr = ContextList, i=0; cptr != NULL && i < nContexts; cptr = cptr->next, i++) {
 504                 memcpy(&nptr[i], cptr, sizeof (CitContext));
 505         }
 506         end_critical_section (S_SESSION_TABLE);
 507
 508         *count = i;
 509         return nptr;
 510 }
 511
 512
 513
 514 /*
 515  * This function fills in a context and its user field correctly
 516  * Then creates/loads that user
 517  */
 518 void CtdlFillSystemContext(CitContext *context, char *name)
 519 {
 520         char sysname[SIZ];
 521         long len;
 522
 523         memset(context, 0, sizeof(CitContext));
 524         context->internal_pgm = 1;
 525         context->cs_pid = 0;
 526         strcpy (sysname, "SYS_");
 527         strcat (sysname, name);
 528         len = cutuserkey(sysname);
 529         memcpy(context->curr_user, sysname, len + 1);
 530         context->client_socket = (-1);
 531         context->state = CON_SYS;
 532         context->ServiceName = name;
 533
 534         /* internal_create_user has the side effect of loading the user regardless of wether they
 535          * already existed or needed to be created
 536          */
 537         internal_create_user (sysname, len, &(context->user), -1) ;
 538
 539         /* Check to see if the system user needs upgrading */
 540         if (context->user.usernum == 0)
 541         {       /* old system user with number 0, upgrade it */
 542                 context->user.usernum = get_new_user_number();
 543                 syslog(LOG_DEBUG, "Upgrading system user \"%s\" from user number 0 to user number %ld\n", context->user.fullname, context->user.usernum);
 544                 /* add user to the database */
 545                 CtdlPutUser(&(context->user));
 546                 cdb_store(CDB_USERSBYNUMBER, &(context->user.usernum), sizeof(long), context->user.fullname, strlen(context->user.fullname)+1);
 547         }
 548 }
 549
 550
 551 /*
 552  * Cleanup any contexts that are left lying around
 553  */
 554 void context_cleanup(void)
 555 {
 556         CitContext *ptr = NULL;
 557         CitContext *rem = NULL;
 558
 559         /*
 560          * Clean up the contexts.
 561          * There are no threads so no critical_section stuff is needed.
 562          */
 563         ptr = ContextList;
 564
 565         /* We need to update the ContextList because some modules may want to itterate it
 566          * Question is should we NULL it before iterating here or should we just keep updating it
 567          * as we remove items?
 568          *
 569          * Answer is to NULL it first to prevent modules from doing any actions on the list at all
 570          */
 571         ContextList=NULL;
 572         while (ptr != NULL){
 573                 /* Remove the session from the active list */
 574                 rem = ptr->next;
 575                 --num_sessions;
 576
 577                 syslog(LOG_DEBUG, "context_cleanup(): Purging session #%d %s\n", ptr->cs_pid, ptr->ServiceName);
 578                 RemoveContext(ptr);
 579                 free (ptr);
 580                 ptr = rem;
 581         }
 582 }
 583
 584
 585
 586 /*
 587  * Purge all sessions which have the 'kill_me' flag set.
 588  * This function has code to prevent it from running more than once every
 589  * few seconds, because running it after every single unbind would waste a lot
 590  * of CPU time and keep the context list locked too much.  To force it to run
 591  * anyway, set "force" to nonzero.
 592  */
 593 void dead_session_purge(int force) {
 594         CitContext *ptr, *ptr2;         /* general-purpose utility pointer */
 595         CitContext *rem = NULL;         /* list of sessions to be destroyed */
 596
 597         if (force == 0) {
 598                 if ( (time(NULL) - last_purge) < 5 ) {
 599                         return; /* Too soon, go away */
 600                 }
 601         }
 602         time(&last_purge);
 603
 604         if (try_critical_section(S_SESSION_TABLE))
 605                 return;
 606
 607         ptr = ContextList;
 608         while (ptr) {
 609                 ptr2 = ptr;
 610                 ptr = ptr->next;
 611
 612                 if ( (ptr2->state == CON_IDLE) && (ptr2->kill_me) ) {
 613                         /* Remove the session from the active list */
 614                         if (ptr2->prev) {
 615                                 ptr2->prev->next = ptr2->next;
 616                         }
 617                         else {
 618                                 ContextList = ptr2->next;
 619                         }
 620                         if (ptr2->next) {
 621                                 ptr2->next->prev = ptr2->prev;
 622                         }
 623
 624                         --num_sessions;
 625                         /* And put it on our to-be-destroyed list */
 626                         ptr2->next = rem;
 627                         rem = ptr2;
 628                 }
 629         }
 630         end_critical_section(S_SESSION_TABLE);
 631
 632         /* Now that we no longer have the session list locked, we can take
 633          * our time and destroy any sessions on the to-be-killed list, which
 634          * is allocated privately on this thread's stack.
 635          */
 636         while (rem != NULL) {
 637                 syslog(LOG_DEBUG, "dead_session_purge(): purging session %d, reason=%d\n", rem->cs_pid, rem->kill_me);
 638                 RemoveContext(rem);
 639                 ptr = rem;
 640                 rem = rem->next;
 641                 free(ptr);
 642         }
 643 }
 644
 645
 646
 647
 648
 649 /*
 650  * masterCC is the context we use when not attached to a session.  This
 651  * function initializes it.
 652  */
 653 void InitializeMasterCC(void) {
 654         memset(&masterCC, 0, sizeof(struct CitContext));
 655         masterCC.internal_pgm = 1;
 656         masterCC.cs_pid = 0;
 657 }
 658
 659
 660
 661
 662
 663 /*
 664  * Set the "async waiting" flag for a session, if applicable
 665  */
 666 void set_async_waiting(struct CitContext *ccptr)
 667 {
 668         syslog(LOG_DEBUG, "Setting async_waiting flag for session %d\n", ccptr->cs_pid);
 669         if (ccptr->is_async) {
 670                 ccptr->async_waiting++;
 671                 if (ccptr->state == CON_IDLE) {
 672                         ccptr->state = CON_READY;
 673                 }
 674         }
 675 }