citadel/citserver.c

   1 /*
   2  * Main source module for the Citadel server
   3  *
   4  * Copyright (c) 1987-2021 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         }
  58         else {
  59                 gid = pw->pw_gid;
  60         }
  61
  62         if (create_run_directories(CTDLUID, gid) != 0) {
  63                 syslog(LOG_ERR, "citserver: failed to access and create directories");
  64                 exit(1);
  65         }
  66         syslog(LOG_INFO, "Opening databases");
  67         open_databases();
  68
  69         /* Load site-specific configuration */
  70         syslog(LOG_INFO, "Initializing configuration system");
  71         initialize_config_system();
  72         validate_config();
  73         migrate_legacy_control_record();
  74
  75         // If we have an existing database that is older than version 928, reindex the user records.
  76         // Unfortunately we cannot do this in serv_upgrade.c because it needs to happen VERY early during startup.
  77         int existing_db = CtdlGetConfigInt("MM_hosted_upgrade_level");
  78         if ( (existing_db > 0) && (existing_db < 928) ) {
  79                 ForEachUser(reindex_user_928, NULL);
  80         }
  81
  82         /* Check floor reference counts */
  83         check_ref_counts();
  84
  85         syslog(LOG_INFO, "Creating base rooms (if necessary)");
  86         CtdlCreateRoom(CtdlGetConfigStr("c_baseroom"), 0, "", 0, 1, 0, VIEW_BBS);
  87         CtdlCreateRoom(AIDEROOM, 3, "", 0, 1, 0, VIEW_BBS);
  88         CtdlCreateRoom(SYSCONFIGROOM, 3, "", 0, 1, 0, VIEW_BBS);
  89         CtdlCreateRoom(CtdlGetConfigStr("c_twitroom"), 0, "", 0, 1, 0, VIEW_BBS);
  90
  91         /* The "Local System Configuration" room doesn't need to be visible */
  92         if (CtdlGetRoomLock(&qrbuf, SYSCONFIGROOM) == 0) {
  93                 qrbuf.QRflags2 |= QR2_SYSTEM;
  94                 CtdlPutRoomLock(&qrbuf);
  95         }
  96
  97         /* Aide needs to be public postable, else we're not RFC conformant. */
  98         if (CtdlGetRoomLock(&qrbuf, AIDEROOM) == 0) {
  99                 qrbuf.QRflags2 |= QR2_SMTP_PUBLIC;
 100                 CtdlPutRoomLock(&qrbuf);
 101         }
 102
 103         syslog(LOG_INFO, "Seeding the pseudo-random number generator...");
 104         urandom = fopen("/dev/urandom", "r");
 105         if (urandom != NULL) {
 106                 rv = fread(&seed, sizeof seed, 1, urandom);
 107                 if (rv == -1) {
 108                         syslog(LOG_ERR, "citserver: failed to read random seed: %m");
 109                 }
 110                 fclose(urandom);
 111         } else {
 112                 gettimeofday(&tv, NULL);
 113                 seed = tv.tv_usec;
 114         }
 115         srand(seed);
 116         srandom(seed);
 117
 118         syslog(LOG_DEBUG, "master_startup() finished");
 119 }
 120
 121
 122 /*
 123  * Cleanup routine to be called when the server is shutting down.  Returns the needed exit code.
 124  */
 125 int master_cleanup(int exitcode)
 126 {
 127         static int already_cleaning_up = 0;
 128
 129         if (already_cleaning_up) {
 130                 while (1) {
 131                         usleep(1000000);
 132                 }
 133         }
 134         already_cleaning_up = 1;
 135
 136         /* Do system-dependent stuff */
 137         sysdep_master_cleanup();
 138
 139         /* Close the configuration system */
 140         shutdown_config_system();
 141
 142         /* Close databases */
 143         syslog(LOG_INFO, "citserver: closing databases");
 144         close_databases();
 145
 146         /* If the operator requested a halt but not an exit, halt here. */
 147         if (shutdown_and_halt) {
 148                 syslog(LOG_ERR, "citserver: Halting server without exiting.");
 149                 fflush(stdout);
 150                 fflush(stderr);
 151                 while (1) {
 152                         sleep(32767);
 153                 }
 154         }
 155
 156         /* Now go away. */
 157         syslog(LOG_ERR, "citserver: Exiting with status %d", exitcode);
 158         fflush(stdout);
 159         fflush(stderr);
 160
 161         if (restart_server != 0) {
 162                 exitcode = 1;
 163         } else if ((running_as_daemon != 0) && ((exitcode == 0))) {
 164                 exitcode = CTDLEXIT_SHUTDOWN;
 165         }
 166         return (exitcode);
 167 }
 168
 169
 170 /*
 171  * returns an asterisk if there are any instant messages waiting,
 172  * space otherwise.
 173  */
 174 char CtdlCheckExpress(void)
 175 {
 176         if (CC->FirstExpressMessage == NULL) {
 177                 return (' ');
 178         } else {
 179                 return ('*');
 180         }
 181 }
 182
 183
 184 void citproto_begin_session()
 185 {
 186         if (CC->nologin == 1) {
 187                 cprintf("%d Too many users are already online (maximum is %d)\n",
 188                         ERROR + MAX_SESSIONS_EXCEEDED, CtdlGetConfigInt("c_maxsessions")
 189                     );
 190                 CC->kill_me = KILLME_MAX_SESSIONS_EXCEEDED;
 191         } else {
 192                 cprintf("%d %s Citadel server ready.\n", CIT_OK, CtdlGetConfigStr("c_fqdn"));
 193                 CC->can_receive_im = 1;
 194         }
 195 }
 196
 197
 198 void citproto_begin_admin_session()
 199 {
 200         CC->internal_pgm = 1;
 201         cprintf("%d %s Citadel server ADMIN CONNECTION ready.\n", CIT_OK, CtdlGetConfigStr("c_fqdn"));
 202 }
 203
 204
 205 /*
 206  * This loop performs all asynchronous functions.
 207  */
 208 void do_async_loop(void)
 209 {
 210         PerformSessionHooks(EVT_ASYNC);
 211 }