citadel/citserver.c

   1 /*
   2  * Main source module for the Citadel server
   3  *
   4  * Copyright (c) 1987-2014 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
 121         syslog(LOG_DEBUG, "master_startup() started\n");
 122         time(&server_startup_time);
 123         get_config();
 124
 125         syslog(LOG_INFO, "Opening databases\n");
 126         open_databases();
 127         check_ref_counts();
 128
 129         syslog(LOG_INFO, "Creating base rooms (if necessary)\n");
 130         CtdlCreateRoom(config.c_baseroom,       0, "", 0, 1, 0, VIEW_BBS);
 131         CtdlCreateRoom(AIDEROOM,                3, "", 0, 1, 0, VIEW_BBS);
 132         CtdlCreateRoom(SYSCONFIGROOM,           3, "", 0, 1, 0, VIEW_BBS);
 133         CtdlCreateRoom(config.c_twitroom,       0, "", 0, 1, 0, VIEW_BBS);
 134
 135         /* The "Local System Configuration" room doesn't need to be visible */
 136         if (CtdlGetRoomLock(&qrbuf, SYSCONFIGROOM) == 0) {
 137                 qrbuf.QRflags2 |= QR2_SYSTEM;
 138                 CtdlPutRoomLock(&qrbuf);
 139         }
 140
 141         /* Aide needs to be public postable, else we're not RFC conformant. */
 142         if (CtdlGetRoomLock(&qrbuf, AIDEROOM) == 0) {
 143                 qrbuf.QRflags2 |= QR2_SMTP_PUBLIC;
 144                 CtdlPutRoomLock(&qrbuf);
 145         }
 146
 147         syslog(LOG_INFO, "Seeding the pseudo-random number generator...\n");
 148         urandom = fopen("/dev/urandom", "r");
 149         if (urandom != NULL) {
 150                 rv = fread(&seed, sizeof seed, 1, urandom);
 151                 if (rv == -1)
 152                         syslog(LOG_EMERG, "failed to read random seed: %s\n",
 153                                strerror(errno));
 154                 fclose(urandom);
 155         }
 156         else {
 157                 gettimeofday(&tv, NULL);
 158                 seed = tv.tv_usec;
 159         }
 160         srand(seed);
 161         srandom(seed);
 162
 163         put_config();
 164
 165         syslog(LOG_DEBUG, "master_startup() finished\n");
 166 }
 167
 168
 169 /*
 170  * Cleanup routine to be called when the server is shutting down.
 171  */
 172 void master_cleanup(int exitcode) {
 173         struct CleanupFunctionHook *fcn;
 174         static int already_cleaning_up = 0;
 175
 176         if (already_cleaning_up) while(1) usleep(1000000);
 177         already_cleaning_up = 1;
 178
 179         /* Run any cleanup routines registered by loadable modules */
 180         for (fcn = CleanupHookTable; fcn != NULL; fcn = fcn->next) {
 181                 (*fcn->h_function_pointer)();
 182         }
 183
 184         /* Close the AdjRefCount queue file */
 185         AdjRefCount(-1, 0);
 186
 187         /* Do system-dependent stuff */
 188         sysdep_master_cleanup();
 189
 190         /* Close databases */
 191         syslog(LOG_INFO, "Closing databases\n");
 192         close_databases();
 193
 194         /* If the operator requested a halt but not an exit, halt here. */
 195         if (shutdown_and_halt) {
 196                 syslog(LOG_NOTICE, "citserver: Halting server without exiting.\n");
 197                 fflush(stdout); fflush(stderr);
 198                 while(1) {
 199                         sleep(32767);
 200                 }
 201         }
 202
 203         release_control();
 204
 205         /* Now go away. */
 206         syslog(LOG_NOTICE, "citserver: Exiting with status %d\n", exitcode);
 207         fflush(stdout); fflush(stderr);
 208
 209         if (restart_server != 0)
 210                 exit(1);
 211         if ((running_as_daemon != 0) && ((exitcode == 0) ))
 212                 exitcode = CTDLEXIT_SHUTDOWN;
 213         exit(exitcode);
 214 }
 215
 216
 217
 218 /*
 219  * returns an asterisk if there are any instant messages waiting,
 220  * space otherwise.
 221  */
 222 char CtdlCheckExpress(void) {
 223         if (CC->FirstExpressMessage == NULL) {
 224                 return(' ');
 225         }
 226         else {
 227                 return('*');
 228         }
 229 }
 230
 231
 232 /*
 233  * Check originating host against the public_clients file.  This determines
 234  * whether the client is allowed to change the hostname for this session
 235  * (for example, to show the location of the user rather than the location
 236  * of the client).
 237  */
 238 int CtdlIsPublicClient(void)
 239 {
 240         char buf[1024];
 241         char addrbuf[1024];
 242         FILE *fp;
 243         int i;
 244         char *public_clientspos;
 245         char *public_clientsend;
 246         char *paddr = NULL;
 247         struct stat statbuf;
 248         static time_t pc_timestamp = 0;
 249         static char public_clients[SIZ];
 250         static char public_clients_file[SIZ];
 251
 252 #define LOCALHOSTSTR "127.0.0.1"
 253
 254         snprintf(public_clients_file, sizeof public_clients_file, "%s/public_clients", ctdl_etc_dir);
 255
 256         /*
 257          * Check the time stamp on the public_clients file.  If it's been
 258          * updated since the last time we were here (or if this is the first
 259          * time we've been through the loop), read its contents and learn
 260          * the IP addresses of the listed hosts.
 261          */
 262         if (stat(public_clients_file, &statbuf) != 0) {
 263                 /* No public_clients file exists, so bail out */
 264                 syslog(LOG_WARNING, "Warning: '%s' does not exist\n",
 265                                 public_clients_file);
 266                 return(0);
 267         }
 268
 269         if (statbuf.st_mtime > pc_timestamp) {
 270                 begin_critical_section(S_PUBLIC_CLIENTS);
 271                 syslog(LOG_INFO, "Loading %s\n", public_clients_file);
 272
 273                 public_clientspos = &public_clients[0];
 274                 public_clientsend = public_clientspos + SIZ;
 275                 safestrncpy(public_clientspos, LOCALHOSTSTR, sizeof public_clients);
 276                 public_clientspos += sizeof(LOCALHOSTSTR) - 1;
 277
 278                 if (hostname_to_dotted_quad(addrbuf, config.c_fqdn) == 0) {
 279                         *(public_clientspos++) = '|';
 280                         paddr = &addrbuf[0];
 281                         while (!IsEmptyStr (paddr) &&
 282                                (public_clientspos < public_clientsend))
 283                                 *(public_clientspos++) = *(paddr++);
 284                 }
 285
 286                 fp = fopen(public_clients_file, "r");
 287                 if (fp != NULL)
 288                         while ((fgets(buf, sizeof buf, fp)!=NULL) &&
 289                                (public_clientspos < public_clientsend)){
 290                                 char *ptr;
 291                                 ptr = buf;
 292                                 while (!IsEmptyStr(ptr)) {
 293                                         if (*ptr == '#') {
 294                                                 *ptr = 0;
 295                                                 break;
 296                                         }
 297                                 else ptr++;
 298                                 }
 299                                 ptr--;
 300                                 while (ptr>buf && isspace(*ptr)) {
 301                                         *(ptr--) = 0;
 302                                 }
 303                                 if (hostname_to_dotted_quad(addrbuf, buf) == 0) {
 304                                         *(public_clientspos++) = '|';
 305                                         paddr = addrbuf;
 306                                         while (!IsEmptyStr(paddr) &&
 307                                                (public_clientspos < public_clientsend)){
 308                                                 *(public_clientspos++) = *(paddr++);
 309                                         }
 310                                 }
 311                         }
 312                 if (fp != NULL) fclose(fp);
 313                 pc_timestamp = time(NULL);
 314                 end_critical_section(S_PUBLIC_CLIENTS);
 315         }
 316
 317         syslog(LOG_DEBUG, "Checking whether %s is a local or public client\n",
 318                 CC->cs_addr);
 319         for (i=0; i<num_parms(public_clients); ++i) {
 320                 extract_token(addrbuf, public_clients, i, '|', sizeof addrbuf);
 321                 if (!strcasecmp(CC->cs_addr, addrbuf)) {
 322                         syslog(LOG_DEBUG, "... yes its local.\n");
 323                         return(1);
 324                 }
 325         }
 326
 327         /* No hits.  This is not a public client. */
 328         syslog(LOG_DEBUG, "... no it isn't.\n");
 329         return(0);
 330 }
 331
 332
 333
 334
 335
 336 void citproto_begin_session() {
 337         if (CC->nologin==1) {
 338                 cprintf("%d %s: Too many users are already online (maximum is %d)\n",
 339                         ERROR + MAX_SESSIONS_EXCEEDED,
 340                         config.c_nodename, config.c_maxsessions
 341                 );
 342                 CC->kill_me = KILLME_MAX_SESSIONS_EXCEEDED;
 343         }
 344         else {
 345                 cprintf("%d %s Citadel server ready.\n", CIT_OK, config.c_nodename);
 346                 CC->can_receive_im = 1;
 347         }
 348 }
 349
 350
 351 void citproto_begin_admin_session() {
 352         CC->internal_pgm = 1;
 353         cprintf("%d %s Citadel server ADMIN CONNECTION ready.\n", CIT_OK, config.c_nodename);
 354 }
 355
 356
 357
 358
 359 /*
 360  * This loop recognizes all server commands.
 361  */
 362 void do_command_loop(void) {
 363         char cmdbuf[SIZ];
 364
 365         time(&CC->lastcmd);
 366         memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
 367         if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
 368                 syslog(LOG_ERR, "Citadel client disconnected: ending session.\n");
 369                 CC->kill_me = KILLME_CLIENT_DISCONNECTED;
 370                 return;
 371         }
 372
 373         /* Log the server command, but don't show passwords... */
 374         if ( (strncasecmp(cmdbuf, "PASS", 4)) && (strncasecmp(cmdbuf, "SETP", 4)) ) {
 375                 syslog(LOG_INFO, "[%d][%s(%ld)] %s",
 376                         CC->cs_pid, CC->curr_user, CC->user.usernum, cmdbuf
 377                 );
 378         }
 379         else {
 380                 syslog(LOG_INFO, "[%d][%s(%ld)] <password command hidden from log>",
 381                         CC->cs_pid, CC->curr_user, CC->user.usernum
 382                 );
 383         }
 384
 385         buffer_output();
 386
 387         /*
 388          * Let other clients see the last command we executed, and
 389          * update the idle time, but not NOOP, QNOP, PEXP, GEXP, RWHO, or TIME.
 390          */
 391         if ( (strncasecmp(cmdbuf, "NOOP", 4))
 392            && (strncasecmp(cmdbuf, "QNOP", 4))
 393            && (strncasecmp(cmdbuf, "PEXP", 4))
 394            && (strncasecmp(cmdbuf, "GEXP", 4))
 395            && (strncasecmp(cmdbuf, "RWHO", 4))
 396            && (strncasecmp(cmdbuf, "TIME", 4)) ) {
 397                 strcpy(CC->lastcmdname, "    ");
 398                 safestrncpy(CC->lastcmdname, cmdbuf, sizeof(CC->lastcmdname));
 399                 time(&CC->lastidle);
 400         }
 401
 402         if ((strncasecmp(cmdbuf, "ENT0", 4))
 403            && (strncasecmp(cmdbuf, "MESG", 4))
 404            && (strncasecmp(cmdbuf, "MSGS", 4)))
 405         {
 406            CC->cs_flags &= ~CS_POSTING;
 407         }
 408
 409         if (!DLoader_Exec_Cmd(cmdbuf)) {
 410                 cprintf("%d Unrecognized or unsupported command.\n", ERROR + CMD_NOT_SUPPORTED);
 411         }
 412
 413         unbuffer_output();
 414
 415         /* Run any after-each-command routines registered by modules */
 416         PerformSessionHooks(EVT_CMD);
 417 }
 418
 419
 420 /*
 421  * This loop performs all asynchronous functions.
 422  */
 423 void do_async_loop(void) {
 424         PerformSessionHooks(EVT_ASYNC);
 425 }
 426