citadel/server/citserver.c

   1 // Main source module for the Citadel server
   2 //
   3 // Copyright (c) 1987-2022 by the citadel.org team
   4 //
   5 // This program is open source software.  Use, duplication, or disclosure
   6 // is subject to the terms of the GNU General Public License, version 3.
   7 // The program is distributed without any warranty, expressed or implied.
   8
   9 #include <stdlib.h>
  10 #include <unistd.h>
  11 #include <stdio.h>
  12 #include <sys/stat.h>
  13 #include "sysdep.h"
  14 #include <time.h>
  15 #include <libcitadel.h>
  16
  17 #include "ctdl_module.h"
  18 #include "housekeeping.h"
  19 #include "locate_host.h"
  20 #include "citserver.h"
  21 #include "user_ops.h"
  22 #include "control.h"
  23 #include "config.h"
  24
  25 char *unique_session_numbers;
  26 int ScheduledShutdown = 0;
  27 time_t server_startup_time;
  28 int panic_fd;
  29 int openid_level_supported = 0;
  30
  31
  32 // We need pseudo-random numbers for a few things.  Seed generously.
  33 void seed_random_number_generator(void) {
  34         FILE *urandom;
  35         struct timeval tv;
  36         unsigned int seed;
  37
  38         syslog(LOG_INFO, "Seeding the pseudo-random number generator...");
  39         urandom = fopen("/dev/urandom", "r");
  40         if (urandom != NULL) {
  41                 if (fread(&seed, sizeof seed, 1, urandom) == -1) {
  42                         syslog(LOG_ERR, "citserver: failed to read random seed: %m");
  43                 }
  44                 fclose(urandom);
  45         }
  46         else {
  47                 gettimeofday(&tv, NULL);
  48                 seed = tv.tv_usec;
  49         }
  50         srand(seed);
  51         srandom(seed);
  52 }
  53
  54
  55 // Various things that need to be initialized at startup
  56 void master_startup(void) {
  57         struct ctdlroom qrbuf;
  58         struct passwd *pw;
  59         gid_t gid;
  60
  61         syslog(LOG_DEBUG, "master_startup() started");
  62         time(&server_startup_time);
  63
  64         syslog(LOG_INFO, "Checking directory access");
  65         if ((pw = getpwuid(ctdluid)) == NULL) {
  66                 gid = getgid();
  67         }
  68         else {
  69                 gid = pw->pw_gid;
  70         }
  71
  72         if (create_run_directories(CTDLUID, gid) != 0) {
  73                 syslog(LOG_ERR, "citserver: failed to access and create directories");
  74                 exit(1);
  75         }
  76
  77         syslog(LOG_DEBUG, "citserver: ctdl_message_dir is %s", ctdl_message_dir);
  78         syslog(LOG_DEBUG, "citserver: ctdl_file_dir is %s", ctdl_file_dir);
  79         syslog(LOG_DEBUG, "citserver: ctdl_key_dir is %s", ctdl_key_dir);
  80         syslog(LOG_DEBUG, "citserver: ctdl_run_dir is %s", ctdl_run_dir);
  81
  82         syslog(LOG_INFO, "Opening databases");
  83         open_databases();
  84
  85         // Load site-specific configuration
  86         seed_random_number_generator();                                 // must be done before config system
  87         syslog(LOG_INFO, "Initializing configuration system");
  88         initialize_config_system();
  89         validate_config();
  90         migrate_legacy_control_record();
  91
  92         // If we have an existing database that is older than version 928, reindex the user records.
  93         // Unfortunately we cannot do this in serv_upgrade.c because it needs to happen VERY early during startup.
  94         int existing_db = CtdlGetConfigInt("MM_hosted_upgrade_level");
  95         if ( (existing_db > 0) && (existing_db < 928) ) {
  96                 ForEachUser(reindex_user_928, NULL);
  97         }
  98
  99         // Check floor reference counts
 100         check_ref_counts();
 101
 102         syslog(LOG_INFO, "Creating base rooms (if necessary)");
 103         CtdlCreateRoom(CtdlGetConfigStr("c_baseroom"), 0, "", 0, 1, 0, VIEW_BBS);
 104         CtdlCreateRoom(AIDEROOM, 3, "", 0, 1, 0, VIEW_BBS);
 105         CtdlCreateRoom(SYSCONFIGROOM, 3, "", 0, 1, 0, VIEW_BBS);
 106         CtdlCreateRoom(CtdlGetConfigStr("c_twitroom"), 0, "", 0, 1, 0, VIEW_BBS);
 107
 108         // The "Local System Configuration" room doesn't need to be visible
 109         if (CtdlGetRoomLock(&qrbuf, SYSCONFIGROOM) == 0) {
 110                 qrbuf.QRflags2 |= QR2_SYSTEM;
 111                 CtdlPutRoomLock(&qrbuf);
 112         }
 113
 114         // Aide needs to be public postable, else we're not RFC conformant.
 115         if (CtdlGetRoomLock(&qrbuf, AIDEROOM) == 0) {
 116                 qrbuf.QRflags2 |= QR2_SMTP_PUBLIC;
 117                 CtdlPutRoomLock(&qrbuf);
 118         }
 119
 120         syslog(LOG_DEBUG, "master_startup() finished");
 121 }
 122
 123
 124 // Cleanup routine to be called when the server is shutting down.  Returns the needed exit code.
 125 int master_cleanup(int exitcode) {
 126         static int already_cleaning_up = 0;
 127
 128         if (already_cleaning_up) {
 129                 while (1) {
 130                         usleep(1000000);
 131                 }
 132         }
 133         already_cleaning_up = 1;
 134
 135         // Do system-dependent stuff
 136         sysdep_master_cleanup();
 137
 138         // Close the configuration system
 139         shutdown_config_system();
 140
 141         // Close databases
 142         syslog(LOG_INFO, "citserver: closing databases");
 143         close_databases();
 144
 145         // If the operator requested a halt but not an exit, halt here.
 146         if (shutdown_and_halt) {
 147                 syslog(LOG_ERR, "citserver: Halting server without exiting.");
 148                 fflush(stdout);
 149                 fflush(stderr);
 150                 while (1) {
 151                         sleep(32767);
 152                 }
 153         }
 154
 155         // Now go away.
 156         syslog(LOG_ERR, "citserver: Exiting with status %d", exitcode);
 157         fflush(stdout);
 158         fflush(stderr);
 159
 160         if (restart_server != 0) {
 161                 exitcode = 1;
 162         }
 163         else if ((running_as_daemon != 0) && ((exitcode == 0))) {
 164                 exitcode = CTDLEXIT_SHUTDOWN;
 165         }
 166         return (exitcode);
 167 }
 168
 169
 170 // returns an asterisk if there are any instant messages waiting, space otherwise.
 171 char CtdlCheckExpress(void) {
 172         if (CC->FirstExpressMessage == NULL) {
 173                 return (' ');
 174         }
 175         else {
 176                 return ('*');
 177         }
 178 }
 179
 180
 181 void citproto_begin_session() {
 182         if (CC->nologin == 1) {
 183                 cprintf("%d Too many users are already online (maximum is %d)\n",
 184                         ERROR + MAX_SESSIONS_EXCEEDED, CtdlGetConfigInt("c_maxsessions")
 185                 );
 186                 CC->kill_me = KILLME_MAX_SESSIONS_EXCEEDED;
 187         }
 188         else {
 189                 cprintf("%d %s Citadel server ready.\n", CIT_OK, CtdlGetConfigStr("c_fqdn"));
 190                 CC->can_receive_im = 1;
 191         }
 192 }
 193
 194
 195 void citproto_begin_admin_session() {
 196         CC->internal_pgm = 1;
 197         cprintf("%d %s Citadel server ADMIN CONNECTION ready.\n", CIT_OK, CtdlGetConfigStr("c_fqdn"));
 198 }
 199
 200
 201 // This loop performs all asynchronous functions.
 202 void do_async_loop(void) {
 203         PerformSessionHooks(EVT_ASYNC);
 204 }