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-2010 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 citthread_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
 263         register CitContext *c;
 264
 265         return ((c = (CitContext *) citthread_getspecific(MyConKey),
 266                 c == NULL) ? &masterCC : c
 267         );
 268 }
 269
 270
 271
 272
 273 /*
 274  * Terminate idle sessions.  This function pounds through the session table
 275  * comparing the current time to each session's time-of-last-command.  If an
 276  * idle session is found it is terminated, then the search restarts at the
 277  * beginning because the pointer to our place in the list becomes invalid.
 278  */
 279 void terminate_idle_sessions(void)
 280 {
 281         CitContext *ccptr;
 282         time_t now;
 283         int session_to_kill;
 284         int killed = 0;
 285         int longrunners = 0;
 286
 287         now = time(NULL);
 288         session_to_kill = 0;
 289         begin_critical_section(S_SESSION_TABLE);
 290         for (ccptr = ContextList; ccptr != NULL; ccptr = ccptr->next) {
 291                 if (  (ccptr!=CC)
 292                 && (config.c_sleeping > 0)
 293                 && (now - (ccptr->lastcmd) > config.c_sleeping) ) {
 294                         if (!ccptr->dont_term) {
 295                                 ccptr->kill_me = KILLME_IDLE;
 296                                 ++killed;
 297                         }
 298                         else
 299                                 longrunners ++;
 300                 }
 301         }
 302         end_critical_section(S_SESSION_TABLE);
 303         if (killed > 0)
 304                 syslog(LOG_INFO, "Scheduled %d idle sessions for termination\n", killed);
 305         if (longrunners > 0)
 306                 syslog(LOG_INFO, "Didn't terminate %d protected idle sessions;\n", killed);
 307 }
 308
 309 void terminate_stuck_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                         close(ccptr->client_socket);
 319                         ccptr->client_socket = -1;
 320                         killed++;
 321                 }
 322         }
 323         end_critical_section(S_SESSION_TABLE);
 324         if (killed > 0)
 325                 syslog(LOG_INFO, "Flushed %d stuck sessions\n", killed);
 326 }
 327
 328
 329
 330 /*
 331  * Terminate a session.
 332  */
 333 void RemoveContext (CitContext *con)
 334 {
 335         const char *c;
 336         if (con==NULL) {
 337                 syslog(LOG_ERR, "WARNING: RemoveContext() called with NULL!\n");
 338                 return;
 339         }
 340         c = con->ServiceName;
 341         if (c == NULL)
 342                 c = "WTF?";
 343         syslog(LOG_DEBUG, "RemoveContext(%s) session %d\n", c, con->cs_pid);
 344         cit_backtrace ();
 345
 346         /* Run any cleanup routines registered by loadable modules.
 347          * Note: We have to "become_session()" because the cleanup functions
 348          *       might make references to "CC" assuming it's the right one.
 349          */
 350         become_session(con);
 351         CtdlUserLogout();
 352         PerformSessionHooks(EVT_STOP);
 353         become_session(NULL);
 354
 355         syslog(LOG_NOTICE, "[%3d] Session ended.\n", con->cs_pid);
 356
 357         /* If the client is still connected, blow 'em away. */
 358         client_close();
 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 /*
 379  * Initialize a new context and place it in the list.  The session number
 380  * used to be the PID (which is why it's called cs_pid), but that was when we
 381  * had one process per session.  Now we just assign them sequentially, starting
 382  * at 1 (don't change it to 0 because masterCC uses 0).
 383  */
 384 CitContext *CreateNewContext(void) {
 385         CitContext *me;
 386         static int next_pid = 0;
 387
 388         me = (CitContext *) malloc(sizeof(CitContext));
 389         if (me == NULL) {
 390                 syslog(LOG_ALERT, "citserver: can't allocate memory!!\n");
 391                 return NULL;
 392         }
 393         memset(me, 0, sizeof(CitContext));
 394         /* Give the contaxt 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         me->RecvBuf.Buf = NewStrBuf();
 408         begin_critical_section(S_SESSION_TABLE);
 409         me->cs_pid = ++next_pid;
 410         me->prev = NULL;
 411         me->next = ContextList;
 412         me->lastcmd = time(NULL);       /* set lastcmd to now to prevent idle timer infanticide */
 413         ContextList = me;
 414         if (me->next != NULL) {
 415                 me->next->prev = me;
 416         }
 417         ++num_sessions;
 418         end_critical_section(S_SESSION_TABLE);
 419         return (me);
 420 }
 421
 422
 423 /*
 424  * Initialize a new context and place it in the list.  The session number
 425  * used to be the PID (which is why it's called cs_pid), but that was when we
 426  * had one process per session.  Now we just assign them sequentially, starting
 427  * at 1 (don't change it to 0 because masterCC uses 0).
 428  */
 429 CitContext *CloneContext(CitContext *CloneMe) {
 430         CitContext *me;
 431         static int next_pid = 0;
 432
 433         me = (CitContext *) malloc(sizeof(CitContext));
 434         if (me == NULL) {
 435                 syslog(LOG_ALERT, "citserver: can't allocate memory!!\n");
 436                 return NULL;
 437         }
 438         memcpy(me, CloneMe, sizeof(CitContext));
 439
 440         memset(&me->RecvBuf, 0, sizeof(IOBuffer));
 441         memset(&me->SendBuf, 0, sizeof(IOBuffer));
 442         memset(&me->SBuf, 0, sizeof(IOBuffer));
 443         me->MigrateBuf = NULL;
 444         me->sMigrateBuf = NULL;
 445         me->redirect_buffer = NULL;
 446 #ifdef HAVE_OPENSSL
 447         me->ssl = NULL;
 448 #endif
 449
 450         me->download_fp = NULL;
 451         me->upload_fp = NULL;
 452         /// TODO: what about the room/user?
 453         me->ma = NULL;
 454         me->openid_data = NULL;
 455         me->ldap_dn = NULL;
 456         me->session_specific_data = NULL;
 457
 458         me->download_fp = NULL;
 459         me->upload_fp = NULL;
 460         me->client_socket = 0;
 461
 462         me->MigrateBuf = NewStrBuf();
 463         me->RecvBuf.Buf = NewStrBuf();
 464
 465         begin_critical_section(S_SESSION_TABLE);
 466         {
 467                 me->cs_pid = ++next_pid;
 468                 me->prev = NULL;
 469                 me->next = ContextList;
 470                 me->lastcmd = time(NULL);       /* set lastcmd to now to prevent idle timer infanticide */
 471                 ContextList = me;
 472                 if (me->next != NULL) {
 473                         me->next->prev = me;
 474                 }
 475                 ++num_sessions;
 476         }
 477         end_critical_section(S_SESSION_TABLE);
 478         return (me);
 479 }
 480
 481
 482 /*
 483  * Return an array containing a copy of the context list.
 484  * This allows worker threads to perform "for each context" operations without
 485  * having to lock and traverse the live list.
 486  */
 487 CitContext *CtdlGetContextArray(int *count)
 488 {
 489         int nContexts, i;
 490         CitContext *nptr, *cptr;
 491
 492         nContexts = num_sessions;
 493         nptr = malloc(sizeof(CitContext) * nContexts);
 494         if (!nptr) {
 495                 *count = 0;
 496                 return NULL;
 497         }
 498         begin_critical_section(S_SESSION_TABLE);
 499         for (cptr = ContextList, i=0; cptr != NULL && i < nContexts; cptr = cptr->next, i++) {
 500                 memcpy(&nptr[i], cptr, sizeof (CitContext));
 501         }
 502         end_critical_section (S_SESSION_TABLE);
 503
 504         *count = i;
 505         return nptr;
 506 }
 507
 508
 509
 510 /*
 511  * This function fills in a context and its user field correctly
 512  * Then creates/loads that user
 513  */
 514 void CtdlFillSystemContext(CitContext *context, char *name)
 515 {
 516         char sysname[SIZ];
 517         long len;
 518
 519         memset(context, 0, sizeof(CitContext));
 520         context->internal_pgm = 1;
 521         context->cs_pid = 0;
 522         strcpy (sysname, "SYS_");
 523         strcat (sysname, name);
 524         len = cutuserkey(sysname);
 525         memcpy(context->curr_user, sysname, len + 1);
 526         context->client_socket = (-1);
 527         context->state = CON_SYS;
 528         context->ServiceName = name;
 529
 530         /* internal_create_user has the side effect of loading the user regardless of wether they
 531          * already existed or needed to be created
 532          */
 533         internal_create_user (sysname, len, &(context->user), -1) ;
 534
 535         /* Check to see if the system user needs upgrading */
 536         if (context->user.usernum == 0)
 537         {       /* old system user with number 0, upgrade it */
 538                 context->user.usernum = get_new_user_number();
 539                 syslog(LOG_DEBUG, "Upgrading system user \"%s\" from user number 0 to user number %ld\n", context->user.fullname, context->user.usernum);
 540                 /* add user to the database */
 541                 CtdlPutUser(&(context->user));
 542                 cdb_store(CDB_USERSBYNUMBER, &(context->user.usernum), sizeof(long), context->user.fullname, strlen(context->user.fullname)+1);
 543         }
 544 }
 545
 546 /*
 547  * flush it again...
 548  */
 549 void CtdlClearSystemContext(void)
 550 {
 551         CitContext *CCC = MyContext();
 552
 553         memset(CCC, 0, sizeof(CitContext));
 554         citthread_setspecific(MyConKey, NULL);
 555 }
 556
 557 /*
 558  * Cleanup any contexts that are left lying around
 559  */
 560 void context_cleanup(void)
 561 {
 562         CitContext *ptr = NULL;
 563         CitContext *rem = NULL;
 564
 565         /*
 566          * Clean up the contexts.
 567          * There are no threads so no critical_section stuff is needed.
 568          */
 569         ptr = ContextList;
 570
 571         /* We need to update the ContextList because some modules may want to itterate it
 572          * Question is should we NULL it before iterating here or should we just keep updating it
 573          * as we remove items?
 574          *
 575          * Answer is to NULL it first to prevent modules from doing any actions on the list at all
 576          */
 577         ContextList=NULL;
 578         while (ptr != NULL){
 579                 /* Remove the session from the active list */
 580                 rem = ptr->next;
 581                 --num_sessions;
 582
 583                 syslog(LOG_DEBUG, "context_cleanup(): Purging session #%d %s\n", ptr->cs_pid, ptr->ServiceName);
 584                 RemoveContext(ptr);
 585                 free (ptr);
 586                 ptr = rem;
 587         }
 588 }
 589
 590
 591
 592 /*
 593  * Purge all sessions which have the 'kill_me' flag set.
 594  * This function has code to prevent it from running more than once every
 595  * few seconds, because running it after every single unbind would waste a lot
 596  * of CPU time and keep the context list locked too much.  To force it to run
 597  * anyway, set "force" to nonzero.
 598  */
 599 void dead_session_purge(int force) {
 600         CitContext *ptr, *ptr2;         /* general-purpose utility pointer */
 601         CitContext *rem = NULL;         /* list of sessions to be destroyed */
 602
 603         if (force == 0) {
 604                 if ( (time(NULL) - last_purge) < 5 ) {
 605                         return; /* Too soon, go away */
 606                 }
 607         }
 608         time(&last_purge);
 609
 610         if (try_critical_section(S_SESSION_TABLE))
 611                 return;
 612
 613         ptr = ContextList;
 614         while (ptr) {
 615                 ptr2 = ptr;
 616                 ptr = ptr->next;
 617
 618                 if ( (ptr2->state == CON_IDLE) && (ptr2->kill_me) ) {
 619                         /* Remove the session from the active list */
 620                         if (ptr2->prev) {
 621                                 ptr2->prev->next = ptr2->next;
 622                         }
 623                         else {
 624                                 ContextList = ptr2->next;
 625                         }
 626                         if (ptr2->next) {
 627                                 ptr2->next->prev = ptr2->prev;
 628                         }
 629
 630                         --num_sessions;
 631                         /* And put it on our to-be-destroyed list */
 632                         ptr2->next = rem;
 633                         rem = ptr2;
 634                 }
 635         }
 636         end_critical_section(S_SESSION_TABLE);
 637
 638         /* Now that we no longer have the session list locked, we can take
 639          * our time and destroy any sessions on the to-be-killed list, which
 640          * is allocated privately on this thread's stack.
 641          */
 642         while (rem != NULL) {
 643                 syslog(LOG_DEBUG, "dead_session_purge(): purging session %d, reason=%d\n", rem->cs_pid, rem->kill_me);
 644                 RemoveContext(rem);
 645                 ptr = rem;
 646                 rem = rem->next;
 647                 free(ptr);
 648         }
 649 }
 650
 651
 652
 653
 654
 655 /*
 656  * masterCC is the context we use when not attached to a session.  This
 657  * function initializes it.
 658  */
 659 void InitializeMasterCC(void) {
 660         memset(&masterCC, 0, sizeof( CitContext));
 661         masterCC.internal_pgm = 1;
 662         masterCC.cs_pid = 0;
 663 }
 664
 665
 666
 667
 668
 669 /*
 670  * Set the "async waiting" flag for a session, if applicable
 671  */
 672 void set_async_waiting(struct CitContext *ccptr)
 673 {
 674         syslog(LOG_DEBUG, "Setting async_waiting flag for session %d\n", ccptr->cs_pid);
 675         if (ccptr->is_async) {
 676                 ccptr->async_waiting++;
 677                 if (ccptr->state == CON_IDLE) {
 678                         ccptr->state = CON_READY;
 679                 }
 680         }
 681 }