citadel/citserver.c

   1 /*
   2  * Main source module for the Citadel server
   3  *
   4  * Copyright (c) 1987-2015 by the citadel.org team
   5  *
   6  * This program is open source software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License, version 3.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  */
  14
  15 #include <stdio.h>
  16 #include "sysdep.h"
  17 #include <time.h>
  18 #if HAVE_BACKTRACE
  19 #include <execinfo.h>
  20 #endif
  21 #include <libcitadel.h>
  22
  23 #include "ctdl_module.h"
  24 #include "housekeeping.h"
  25 #include "locate_host.h"
  26 #include "citserver.h"
  27 #include "user_ops.h"
  28 #include "control.h"
  29 #include "config.h"
  30
  31 char *unique_session_numbers;
  32 int ScheduledShutdown = 0;
  33 time_t server_startup_time;
  34 int panic_fd;
  35 int openid_level_supported = 0;
  36
  37 /*
  38  * print the actual stack frame.
  39  */
  40 void cit_backtrace(void)
  41 {
  42 #ifdef HAVE_BACKTRACE
  43         void *stack_frames[50];
  44         size_t size, i;
  45         char **strings;
  46
  47         const char *p = IOSTR;
  48         if (p == NULL) p = "";
  49         size = backtrace(stack_frames, sizeof(stack_frames) / sizeof(void*));
  50         strings = backtrace_symbols(stack_frames, size);
  51         for (i = 0; i < size; i++) {
  52                 if (strings != NULL)
  53                         syslog(LOG_ALERT, "%s %s\n", p, strings[i]);
  54                 else
  55                         syslog(LOG_ALERT, "%s %p\n", p, stack_frames[i]);
  56         }
  57         free(strings);
  58 #endif
  59 }
  60
  61 void cit_oneline_backtrace(void)
  62 {
  63 #ifdef HAVE_BACKTRACE
  64         void *stack_frames[50];
  65         size_t size, i;
  66         char **strings;
  67         StrBuf *Buf;
  68
  69         size = backtrace(stack_frames, sizeof(stack_frames) / sizeof(void*));
  70         strings = backtrace_symbols(stack_frames, size);
  71         if (size > 0)
  72         {
  73                 Buf = NewStrBuf();
  74                 for (i = 1; i < size; i++) {
  75                         if (strings != NULL)
  76                                 StrBufAppendPrintf(Buf, "%s : ", strings[i]);
  77                         else
  78                                 StrBufAppendPrintf(Buf, "%p : ", stack_frames[i]);
  79                 }
  80                 free(strings);
  81                 syslog(LOG_ALERT, "%s %s\n", IOSTR, ChrPtr(Buf));
  82                 FreeStrBuf(&Buf);
  83         }
  84 #endif
  85 }
  86
  87 /*
  88  * print the actual stack frame.
  89  */
  90 void cit_panic_backtrace(int SigNum)
  91 {
  92 #ifdef HAVE_BACKTRACE
  93         void *stack_frames[10];
  94         size_t size, i;
  95         char **strings;
  96
  97         printf("caught signal 11\n");
  98         size = backtrace(stack_frames, sizeof(stack_frames) / sizeof(void*));
  99         strings = backtrace_symbols(stack_frames, size);
 100         for (i = 0; i < size; i++) {
 101                 if (strings != NULL)
 102                         syslog(LOG_ALERT, "%s\n", strings[i]);
 103                 else
 104                         syslog(LOG_ALERT, "%p\n", stack_frames[i]);
 105         }
 106         free(strings);
 107 #endif
 108         exit(-1);
 109 }
 110
 111 /*
 112  * Various things that need to be initialized at startup
 113  */
 114 void master_startup(void) {
 115         struct timeval tv;
 116         unsigned int seed;
 117         FILE *urandom;
 118         struct ctdlroom qrbuf;
 119         int rv;
 120         struct passwd *pw;
 121         gid_t gid;
 122
 123         syslog(LOG_DEBUG, "master_startup() started\n");
 124         time(&server_startup_time);
 125
 126         syslog(LOG_INFO, "Checking directory access");
 127         if ((pw = getpwuid(ctdluid)) == NULL) {
 128                 gid = getgid();
 129         } else {
 130                 gid = pw->pw_gid;
 131         }
 132
 133         if (create_run_directories(CTDLUID, gid) != 0) {
 134                 syslog(LOG_EMERG, "failed to access & create directories");
 135                 exit(1);
 136         }
 137         syslog(LOG_INFO, "Opening databases");
 138         open_databases();
 139
 140         /* Load site-specific configuration */
 141         syslog(LOG_INFO, "Initializing configuration system");
 142         initialize_config_system();
 143         validate_config();
 144         migrate_legacy_control_record();
 145
 146         /* Check floor reference counts */
 147         check_ref_counts();
 148
 149         syslog(LOG_INFO, "Creating base rooms (if necessary)\n");
 150         CtdlCreateRoom(CtdlGetConfigStr("c_baseroom"),  0, "", 0, 1, 0, VIEW_BBS);
 151         CtdlCreateRoom(AIDEROOM,                        3, "", 0, 1, 0, VIEW_BBS);
 152         CtdlCreateRoom(SYSCONFIGROOM,                   3, "", 0, 1, 0, VIEW_BBS);
 153         CtdlCreateRoom(CtdlGetConfigStr("c_twitroom"),  0, "", 0, 1, 0, VIEW_BBS);
 154
 155         /* The "Local System Configuration" room doesn't need to be visible */
 156         if (CtdlGetRoomLock(&qrbuf, SYSCONFIGROOM) == 0) {
 157                 qrbuf.QRflags2 |= QR2_SYSTEM;
 158                 CtdlPutRoomLock(&qrbuf);
 159         }
 160
 161         /* Aide needs to be public postable, else we're not RFC conformant. */
 162         if (CtdlGetRoomLock(&qrbuf, AIDEROOM) == 0) {
 163                 qrbuf.QRflags2 |= QR2_SMTP_PUBLIC;
 164                 CtdlPutRoomLock(&qrbuf);
 165         }
 166
 167         syslog(LOG_INFO, "Seeding the pseudo-random number generator...\n");
 168         urandom = fopen("/dev/urandom", "r");
 169         if (urandom != NULL) {
 170                 rv = fread(&seed, sizeof seed, 1, urandom);
 171                 if (rv == -1)
 172                         syslog(LOG_EMERG, "failed to read random seed: %s\n",
 173                                strerror(errno));
 174                 fclose(urandom);
 175         }
 176         else {
 177                 gettimeofday(&tv, NULL);
 178                 seed = tv.tv_usec;
 179         }
 180         srand(seed);
 181         srandom(seed);
 182
 183         syslog(LOG_DEBUG, "master_startup() finished\n");
 184 }
 185
 186
 187 /*
 188  * Cleanup routine to be called when the server is shutting down.
 189  */
 190 void master_cleanup(int exitcode) {
 191         struct CleanupFunctionHook *fcn;
 192         static int already_cleaning_up = 0;
 193
 194         if (already_cleaning_up) while(1) usleep(1000000);
 195         already_cleaning_up = 1;
 196
 197         /* Run any cleanup routines registered by loadable modules */
 198         for (fcn = CleanupHookTable; fcn != NULL; fcn = fcn->next) {
 199                 (*fcn->h_function_pointer)();
 200         }
 201
 202         /* Close the AdjRefCount queue file */
 203         AdjRefCount(-1, 0);
 204
 205         /* Do system-dependent stuff */
 206         sysdep_master_cleanup();
 207
 208         /* Close the configuration system */
 209         shutdown_config_system();
 210
 211         /* Close databases */
 212         syslog(LOG_INFO, "Closing databases\n");
 213         close_databases();
 214
 215         /* If the operator requested a halt but not an exit, halt here. */
 216         if (shutdown_and_halt) {
 217                 syslog(LOG_NOTICE, "citserver: Halting server without exiting.\n");
 218                 fflush(stdout); fflush(stderr);
 219                 while(1) {
 220                         sleep(32767);
 221                 }
 222         }
 223
 224         /* Now go away. */
 225         syslog(LOG_NOTICE, "citserver: Exiting with status %d\n", exitcode);
 226         fflush(stdout); fflush(stderr);
 227
 228         if (restart_server != 0)
 229                 exit(1);
 230         if ((running_as_daemon != 0) && ((exitcode == 0) ))
 231                 exitcode = CTDLEXIT_SHUTDOWN;
 232         exit(exitcode);
 233 }
 234
 235
 236
 237 /*
 238  * returns an asterisk if there are any instant messages waiting,
 239  * space otherwise.
 240  */
 241 char CtdlCheckExpress(void) {
 242         if (CC->FirstExpressMessage == NULL) {
 243                 return(' ');
 244         }
 245         else {
 246                 return('*');
 247         }
 248 }
 249
 250
 251 /*
 252  * Check originating host against the public_clients file.  This determines
 253  * whether the client is allowed to change the hostname for this session
 254  * (for example, to show the location of the user rather than the location
 255  * of the client).
 256  */
 257 int CtdlIsPublicClient(void)
 258 {
 259         char buf[1024];
 260         char addrbuf[1024];
 261         FILE *fp;
 262         int i;
 263         char *public_clientspos;
 264         char *public_clientsend;
 265         char *paddr = NULL;
 266         struct stat statbuf;
 267         static time_t pc_timestamp = 0;
 268         static char public_clients[SIZ];
 269         static char public_clients_file[SIZ];
 270
 271 #define LOCALHOSTSTR "127.0.0.1"
 272
 273         snprintf(public_clients_file, sizeof public_clients_file, "%s/public_clients", ctdl_etc_dir);
 274
 275         /*
 276          * Check the time stamp on the public_clients file.  If it's been
 277          * updated since the last time we were here (or if this is the first
 278          * time we've been through the loop), read its contents and learn
 279          * the IP addresses of the listed hosts.
 280          */
 281         if (stat(public_clients_file, &statbuf) != 0) {
 282                 /* No public_clients file exists, so bail out */
 283                 syslog(LOG_WARNING, "Warning: '%s' does not exist\n",
 284                                 public_clients_file);
 285                 return(0);
 286         }
 287
 288         if (statbuf.st_mtime > pc_timestamp) {
 289                 begin_critical_section(S_PUBLIC_CLIENTS);
 290                 syslog(LOG_INFO, "Loading %s\n", public_clients_file);
 291
 292                 public_clientspos = &public_clients[0];
 293                 public_clientsend = public_clientspos + SIZ;
 294                 safestrncpy(public_clientspos, LOCALHOSTSTR, sizeof public_clients);
 295                 public_clientspos += sizeof(LOCALHOSTSTR) - 1;
 296
 297                 if (hostname_to_dotted_quad(addrbuf, CtdlGetConfigStr("c_fqdn")) == 0) {
 298                         *(public_clientspos++) = '|';
 299                         paddr = &addrbuf[0];
 300                         while (!IsEmptyStr (paddr) &&
 301                                (public_clientspos < public_clientsend))
 302                                 *(public_clientspos++) = *(paddr++);
 303                 }
 304
 305                 fp = fopen(public_clients_file, "r");
 306                 if (fp != NULL)
 307                         while ((fgets(buf, sizeof buf, fp)!=NULL) &&
 308                                (public_clientspos < public_clientsend)){
 309                                 char *ptr;
 310                                 ptr = buf;
 311                                 while (!IsEmptyStr(ptr)) {
 312                                         if (*ptr == '#') {
 313                                                 *ptr = 0;
 314                                                 break;
 315                                         }
 316                                 else ptr++;
 317                                 }
 318                                 ptr--;
 319                                 while (ptr>buf && isspace(*ptr)) {
 320                                         *(ptr--) = 0;
 321                                 }
 322                                 if (hostname_to_dotted_quad(addrbuf, buf) == 0) {
 323                                         *(public_clientspos++) = '|';
 324                                         paddr = addrbuf;
 325                                         while (!IsEmptyStr(paddr) &&
 326                                                (public_clientspos < public_clientsend)){
 327                                                 *(public_clientspos++) = *(paddr++);
 328                                         }
 329                                 }
 330                         }
 331                 if (fp != NULL) fclose(fp);
 332                 pc_timestamp = time(NULL);
 333                 end_critical_section(S_PUBLIC_CLIENTS);
 334         }
 335
 336         syslog(LOG_DEBUG, "Checking whether %s is a local or public client\n",
 337                 CC->cs_addr);
 338         for (i=0; i<num_parms(public_clients); ++i) {
 339                 extract_token(addrbuf, public_clients, i, '|', sizeof addrbuf);
 340                 if (!strcasecmp(CC->cs_addr, addrbuf)) {
 341                         syslog(LOG_DEBUG, "... yes its local.\n");
 342                         return(1);
 343                 }
 344         }
 345
 346         /* No hits.  This is not a public client. */
 347         syslog(LOG_DEBUG, "... no it isn't.\n");
 348         return(0);
 349 }
 350
 351
 352
 353
 354
 355 void citproto_begin_session() {
 356         if (CC->nologin==1) {
 357                 cprintf("%d %s: Too many users are already online (maximum is %d)\n",
 358                         ERROR + MAX_SESSIONS_EXCEEDED,
 359                         CtdlGetConfigStr("c_nodename"), CtdlGetConfigInt("c_maxsessions")
 360                 );
 361                 CC->kill_me = KILLME_MAX_SESSIONS_EXCEEDED;
 362         }
 363         else {
 364                 cprintf("%d %s Citadel server ready.\n", CIT_OK, CtdlGetConfigStr("c_nodename"));
 365                 CC->can_receive_im = 1;
 366         }
 367 }
 368
 369
 370 void citproto_begin_admin_session() {
 371         CC->internal_pgm = 1;
 372         cprintf("%d %s Citadel server ADMIN CONNECTION ready.\n", CIT_OK, CtdlGetConfigStr("c_nodename"));
 373 }
 374
 375
 376
 377
 378 /*
 379  * This loop recognizes all server commands.
 380  */
 381 void do_command_loop(void) {
 382         char cmdbuf[SIZ];
 383
 384         time(&CC->lastcmd);
 385         memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
 386         if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
 387                 syslog(LOG_ERR, "Citadel client disconnected: ending session.\n");
 388                 CC->kill_me = KILLME_CLIENT_DISCONNECTED;
 389                 return;
 390         }
 391
 392         /* Log the server command, but don't show passwords... */
 393         if ( (strncasecmp(cmdbuf, "PASS", 4)) && (strncasecmp(cmdbuf, "SETP", 4)) ) {
 394                 syslog(LOG_INFO, "[%d][%s(%ld)] %s",
 395                         CC->cs_pid, CC->curr_user, CC->user.usernum, cmdbuf
 396                 );
 397         }
 398         else {
 399                 syslog(LOG_INFO, "[%d][%s(%ld)] <password command hidden from log>",
 400                         CC->cs_pid, CC->curr_user, CC->user.usernum
 401                 );
 402         }
 403
 404         buffer_output();
 405
 406         /*
 407          * Let other clients see the last command we executed, and
 408          * update the idle time, but not NOOP, QNOP, PEXP, GEXP, RWHO, or TIME.
 409          */
 410         if ( (strncasecmp(cmdbuf, "NOOP", 4))
 411            && (strncasecmp(cmdbuf, "QNOP", 4))
 412            && (strncasecmp(cmdbuf, "PEXP", 4))
 413            && (strncasecmp(cmdbuf, "GEXP", 4))
 414            && (strncasecmp(cmdbuf, "RWHO", 4))
 415            && (strncasecmp(cmdbuf, "TIME", 4)) ) {
 416                 strcpy(CC->lastcmdname, "    ");
 417                 safestrncpy(CC->lastcmdname, cmdbuf, sizeof(CC->lastcmdname));
 418                 time(&CC->lastidle);
 419         }
 420
 421         if ((strncasecmp(cmdbuf, "ENT0", 4))
 422            && (strncasecmp(cmdbuf, "MESG", 4))
 423            && (strncasecmp(cmdbuf, "MSGS", 4)))
 424         {
 425            CC->cs_flags &= ~CS_POSTING;
 426         }
 427
 428         if (!DLoader_Exec_Cmd(cmdbuf)) {
 429                 cprintf("%d Unrecognized or unsupported command.\n", ERROR + CMD_NOT_SUPPORTED);
 430         }
 431
 432         unbuffer_output();
 433
 434         /* Run any after-each-command routines registered by modules */
 435         PerformSessionHooks(EVT_CMD);
 436 }
 437
 438
 439 /*
 440  * This loop performs all asynchronous functions.
 441  */
 442 void do_async_loop(void) {
 443         PerformSessionHooks(EVT_ASYNC);
 444 }
 445