citadel/citserver.c

   1 /*
   2  * Main source module for the Citadel server
   3  *
   4  * Copyright (c) 1987-2019 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 <stdlib.h>
  16 #include <unistd.h>
  17 #include <stdio.h>
  18 #include <sys/stat.h>
  19 #include "sysdep.h"
  20 #include <time.h>
  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 /*
  39  * Various things that need to be initialized at startup
  40  */
  41 void master_startup(void)
  42 {
  43         struct timeval tv;
  44         unsigned int seed;
  45         FILE *urandom;
  46         struct ctdlroom qrbuf;
  47         int rv;
  48         struct passwd *pw;
  49         gid_t gid;
  50
  51         syslog(LOG_DEBUG, "master_startup() started");
  52         time(&server_startup_time);
  53
  54         syslog(LOG_INFO, "Checking directory access");
  55         if ((pw = getpwuid(ctdluid)) == NULL) {
  56                 gid = getgid();
  57         } else {
  58                 gid = pw->pw_gid;
  59         }
  60
  61         if (create_run_directories(CTDLUID, gid) != 0) {
  62                 syslog(LOG_EMERG, "failed to access & create directories");
  63                 exit(1);
  64         }
  65         syslog(LOG_INFO, "Opening databases");
  66         open_databases();
  67
  68         /* Load site-specific configuration */
  69         syslog(LOG_INFO, "Initializing configuration system");
  70         initialize_config_system();
  71         validate_config();
  72         migrate_legacy_control_record();
  73
  74         /* Check floor reference counts */
  75         check_ref_counts();
  76
  77         syslog(LOG_INFO, "Creating base rooms (if necessary)");
  78         CtdlCreateRoom(CtdlGetConfigStr("c_baseroom"), 0, "", 0, 1, 0, VIEW_BBS);
  79         CtdlCreateRoom(AIDEROOM, 3, "", 0, 1, 0, VIEW_BBS);
  80         CtdlCreateRoom(SYSCONFIGROOM, 3, "", 0, 1, 0, VIEW_BBS);
  81         CtdlCreateRoom(CtdlGetConfigStr("c_twitroom"), 0, "", 0, 1, 0, VIEW_BBS);
  82
  83         /* The "Local System Configuration" room doesn't need to be visible */
  84         if (CtdlGetRoomLock(&qrbuf, SYSCONFIGROOM) == 0) {
  85                 qrbuf.QRflags2 |= QR2_SYSTEM;
  86                 CtdlPutRoomLock(&qrbuf);
  87         }
  88
  89         /* Aide needs to be public postable, else we're not RFC conformant. */
  90         if (CtdlGetRoomLock(&qrbuf, AIDEROOM) == 0) {
  91                 qrbuf.QRflags2 |= QR2_SMTP_PUBLIC;
  92                 CtdlPutRoomLock(&qrbuf);
  93         }
  94
  95         syslog(LOG_INFO, "Seeding the pseudo-random number generator...");
  96         urandom = fopen("/dev/urandom", "r");
  97         if (urandom != NULL) {
  98                 rv = fread(&seed, sizeof seed, 1, urandom);
  99                 if (rv == -1) {
 100                         syslog(LOG_ERR, "citserver: failed to read random seed: %m");
 101                 }
 102                 fclose(urandom);
 103         } else {
 104                 gettimeofday(&tv, NULL);
 105                 seed = tv.tv_usec;
 106         }
 107         srand(seed);
 108         srandom(seed);
 109
 110         syslog(LOG_DEBUG, "master_startup() finished");
 111 }
 112
 113
 114 /*
 115  * Cleanup routine to be called when the server is shutting down.  Returns the needed exit code.
 116  */
 117 int master_cleanup(int exitcode)
 118 {
 119         struct CleanupFunctionHook *fcn;
 120         static int already_cleaning_up = 0;
 121
 122         if (already_cleaning_up) {
 123                 while (1) {
 124                         usleep(1000000);
 125                 }
 126         }
 127         already_cleaning_up = 1;
 128
 129         /* Run any cleanup routines registered by loadable modules */
 130         for (fcn = CleanupHookTable; fcn != NULL; fcn = fcn->next) {
 131                 (*fcn->h_function_pointer) ();
 132         }
 133
 134         /* Do system-dependent stuff */
 135         sysdep_master_cleanup();
 136
 137         /* Close the configuration system */
 138         shutdown_config_system();
 139
 140         /* Close databases */
 141         syslog(LOG_INFO, "Closing databases\n");
 142         close_databases();
 143
 144         /* If the operator requested a halt but not an exit, halt here. */
 145         if (shutdown_and_halt) {
 146                 syslog(LOG_ERR, "citserver: Halting server without exiting.");
 147                 fflush(stdout);
 148                 fflush(stderr);
 149                 while (1) {
 150                         sleep(32767);
 151                 }
 152         }
 153
 154         /* Now go away. */
 155         syslog(LOG_ERR, "citserver: Exiting with status %d", exitcode);
 156         fflush(stdout);
 157         fflush(stderr);
 158
 159         if (restart_server != 0) {
 160                 exitcode = 1;
 161         } else if ((running_as_daemon != 0) && ((exitcode == 0))) {
 162                 exitcode = CTDLEXIT_SHUTDOWN;
 163         }
 164         return (exitcode);
 165 }
 166
 167
 168 /*
 169  * returns an asterisk if there are any instant messages waiting,
 170  * space otherwise.
 171  */
 172 char CtdlCheckExpress(void)
 173 {
 174         if (CC->FirstExpressMessage == NULL) {
 175                 return (' ');
 176         } else {
 177                 return ('*');
 178         }
 179 }
 180
 181
 182 void citproto_begin_session()
 183 {
 184         if (CC->nologin == 1) {
 185                 cprintf("%d %s: Too many users are already online (maximum is %d)\n",
 186                         ERROR + MAX_SESSIONS_EXCEEDED, CtdlGetConfigStr("c_nodename"), CtdlGetConfigInt("c_maxsessions")
 187                     );
 188                 CC->kill_me = KILLME_MAX_SESSIONS_EXCEEDED;
 189         } else {
 190                 cprintf("%d %s Citadel server ready.\n", CIT_OK, CtdlGetConfigStr("c_nodename"));
 191                 CC->can_receive_im = 1;
 192         }
 193 }
 194
 195
 196 void citproto_begin_admin_session()
 197 {
 198         CC->internal_pgm = 1;
 199         cprintf("%d %s Citadel server ADMIN CONNECTION ready.\n", CIT_OK, CtdlGetConfigStr("c_nodename"));
 200 }
 201
 202
 203 /*
 204  * This loop performs all asynchronous functions.
 205  */
 206 void do_async_loop(void)
 207 {
 208         PerformSessionHooks(EVT_ASYNC);
 209 }