/*
* citserver's main() function lives here.
+ *
+ * Copyright (c) 1987-2021 by the citadel.org team
*
- * $Id$
+ * This program is open source software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
*/
-
-#include "sysdep.h"
#include <stdlib.h>
#include <unistd.h>
#include <stdio.h>
-#include <fcntl.h>
-#include <ctype.h>
-#include <signal.h>
#include <sys/types.h>
#include <sys/stat.h>
-#include <sys/wait.h>
-#include <sys/socket.h>
-#include <syslog.h>
-
-#if TIME_WITH_SYS_TIME
-# include <sys/time.h>
-# include <time.h>
-#else
-# if HAVE_SYS_TIME_H
-# include <sys/time.h>
-# else
-# include <time.h>
-# endif
-#endif
-
-#include <limits.h>
-#include <netinet/in.h>
-#include <netdb.h>
-#include <sys/un.h>
-#include <string.h>
-#include <pwd.h>
-#include <errno.h>
-#include <stdarg.h>
#include <grp.h>
-#ifdef HAVE_PTHREAD_H
-#include <pthread.h>
-#endif
-#ifdef HAVE_SYS_PRCTL_H
-#include <sys/prctl.h>
-#endif
-#include "citadel.h"
-#include "server.h"
-#include "serv_extensions.h"
-#include "sysdep_decls.h"
+#include <sys/file.h>
+#include <libcitadel.h>
+
#include "citserver.h"
-#include "support.h"
+#include "svn_revision.h"
+#include "modules_init.h"
#include "config.h"
-#include "database.h"
-#include "housekeeping.h"
-#include "tools.h"
+#include "control.h"
+#include "serv_extensions.h"
+#include "citadel_dirs.h"
+#include "user_ops.h"
-#ifdef HAVE_SYS_SELECT_H
-#include <sys/select.h>
-#endif
+uid_t ctdluid = 0;
+const char *CitadelServiceUDS="citadel-UDS";
+const char *CitadelServiceTCP="citadel-TCP";
+int sanity_diag_mode = 0;
+
+
+/*
+ * Create or remove a lock file, so we only have one Citadel Server running at a time.
+ */
+void ctdl_lockfile(int yo) {
+ static char lockfilename[PATH_MAX];
+ static FILE *fp;
+
+ if (yo) {
+ syslog(LOG_DEBUG, "main: creating lockfile");
+ snprintf(lockfilename, sizeof lockfilename, "%s/citadel.lock", ctdl_run_dir);
+ fp = fopen(lockfilename, "w");
+ if (!fp) {
+ syslog(LOG_ERR, "%s: %m", lockfilename);
+ exit(CTDLEXIT_DB);
+ }
+ if (flock(fileno(fp), (LOCK_EX|LOCK_NB)) != 0) {
+ syslog(LOG_ERR, "main: cannot lock %s , is another citserver running?", lockfilename);
+ exit(CTDLEXIT_DB);
+ }
+ return;
+ }
+
+ syslog(LOG_DEBUG, "main: removing lockfile");
+ unlink(lockfilename);
+ flock(fileno(fp), LOCK_UN);
+ fclose(fp);
+}
-#ifndef HAVE_SNPRINTF
-#include "snprintf.h"
-#endif
/*
* Here's where it all begins.
*/
int main(int argc, char **argv)
{
- char tracefile[128]; /* Name of file to log traces to */
- int a, i; /* General-purpose variables */
- struct passwd *pw;
+ size_t basesize = 64;
+ char facility[32];
+ int a; /* General-purpose variables */
+ struct passwd pw, *pwp = NULL;
+ char pwbuf[SIZ];
int drop_root_perms = 1;
- struct worker_node *wnp;
- size_t size;
-
- /* specify default port name and trace file */
- strcpy(tracefile, "");
+ int relh=0;
+ int home=0;
+ int dbg=0;
+ int max_log_level = LOG_INFO;
+ char relhome[PATH_MAX]="";
+ char ctdldir[PATH_MAX]=CTDLDIR;
+ int syslog_facility = LOG_DAEMON;
+ uid_t u = 0;
+ struct passwd *p = NULL;
+#ifdef HAVE_RUN_DIR
+ struct stat filestats;
+#endif
/* initialize the master context */
InitializeMasterCC();
+ InitializeMasterTSD();
/* parse command-line arguments */
- for (a=1; a<argc; ++a) {
-
- /* -t specifies where to log trace messages to */
- if (!strncmp(argv[a], "-t", 2)) {
- safestrncpy(tracefile, argv[a], sizeof tracefile);
- strcpy(tracefile, &tracefile[2]);
- freopen(tracefile, "r", stdin);
- freopen(tracefile, "w", stdout);
- freopen(tracefile, "w", stderr);
- chmod(tracefile, 0600);
- }
+ while ((a=getopt(argc, argv, "cl:dh:x:t:B:Dru:s:")) != EOF) switch(a) {
+
+ // test this binary for compatibility and exit
+ case 'c':
+ fprintf(stderr, "%s: binary compatibility confirmed\n", argv[0]);
+ exit(0);
+ break;
+
+ // identify the desired syslog facility
+ case 'l':
+ safestrncpy(facility, optarg, sizeof(facility));
+ syslog_facility = SyslogFacility(facility);
+ break;
+
+ // run in the background if -d was specified
+ case 'd':
+ running_as_daemon = 1;
+ break;
+
+ // specify the data directory
+ case 'h':
+ relh = optarg[0] != '/';
+ if (!relh) {
+ safestrncpy(ctdl_home_directory, optarg, sizeof ctdl_home_directory);
+ }
+ else {
+ safestrncpy(relhome, optarg, sizeof relhome);
+ }
+ home=1;
+ break;
+
+ // identify the desired logging severity level
+ case 'x':
+ max_log_level = atoi(optarg);
+ break;
+
+ // deprecated
+ case 't':
+ break;
+
+ // basesize (what is this?)
+ case 'B':
+ basesize = atoi(optarg);
+ break;
+
+ case 'D':
+ dbg = 1;
+ break;
+
+ // -r tells the server not to drop root permissions.
+ // Don't use this unless you know what you're doing.
+ case 'r':
+ drop_root_perms = 0;
+ break;
- else if (!strncmp(argv[a], "-l", 2)) {
- safestrncpy(tracefile, argv[a], sizeof tracefile);
- strcpy(tracefile, &tracefile[2]);
- syslog_facility = SyslogFacility(tracefile);
- if (syslog_facility >= 0) {
- openlog("citadel", LOG_PID, syslog_facility);
+ // -u tells the server what uid to run under...
+ case 'u':
+ u = atoi(optarg);
+ if (u > 0) {
+ ctdluid = u;
}
- }
+ else {
+ p = getpwnam(optarg);
+ if (p) {
+ u = p->pw_uid;
+ }
+ }
+ if (u > 0) {
+ ctdluid = u;
+ }
+ break;
+
+ // -s tells the server to behave differently during sanity checks
+ case 's':
+ sanity_diag_mode = atoi(optarg);
+ break;
+
+ // any other parameter makes it crash and burn
+ default:
+ fprintf(stderr, "citserver: usage: "
+ "citserver "
+ "[-l LogFacility] "
+ "[-x MaxLogLevel] "
+ "[-d] [-D] [-r] "
+ "[-u user] "
+ "[-h HomeDir]\n"
+ );
+ exit(1);
+ }
- /* run in the background if -d was specified */
- else if (!strcmp(argv[a], "-d")) {
- start_daemon( (strlen(tracefile) > 0) ? 0 : 1 ) ;
+ /* Last ditch effort to determine the user name ... if there's a user called "citadel" then use that */
+ if (ctdluid == 0) {
+ p = getpwnam("citadel");
+ if (!p) {
+ p = getpwnam("bbs");
}
-
- /* -x specifies the desired logging level */
- else if (!strncmp(argv[a], "-x", 2)) {
- verbosity = atoi(&argv[a][2]);
+ if (!p) {
+ p = getpwnam("guest");
}
-
- else if (!strncmp(argv[a], "-h", 2)) {
- safestrncpy(bbs_home_directory, &argv[a][2],
- sizeof bbs_home_directory);
- home_specified = 1;
+ if (p) {
+ u = p->pw_uid;
}
-
- else if (!strncmp(argv[a], "-f", 2)) {
- do_defrag = 1;
+ if (u > 0) {
+ ctdluid = u;
}
+ }
- /* -r tells the server not to drop root permissions. don't use
- * this unless you know what you're doing. this should be
- * removed in the next release if it proves unnecessary. */
- else if (!strcmp(argv[a], "-r"))
- drop_root_perms = 0;
+ if ((ctdluid == 0) && (drop_root_perms == 0)) {
+ fprintf(stderr, "citserver: cannot determine user to run as; please specify -r or -u options\n");
+ exit(CTDLEXIT_UNUSER);
+ }
- /* any other parameter makes it crash and burn */
- else {
- lprintf(CTDL_EMERG, "citserver: usage: "
- "citserver [-tTraceFile] "
- "[-lLogFacility] "
- "[-d] [-f]"
- " [-xLogLevel] [-hHomeDir]\n");
- exit(1);
+ StartLibCitadel(basesize);
+ setlogmask(LOG_UPTO(max_log_level));
+ openlog("citserver",
+ ( running_as_daemon ? (LOG_PID) : (LOG_PID | LOG_PERROR) ),
+ syslog_facility
+ );
+
+ calc_dirs_n_files(relh, home, relhome, ctdldir, dbg);
+ /* daemonize, if we were asked to */
+ if (running_as_daemon) {
+ start_daemon(0);
+ drop_root_perms = 1;
+ }
+
+ /* Tell 'em who's in da house */
+ syslog(LOG_INFO, " ");
+ syslog(LOG_INFO, " ");
+ syslog(LOG_INFO, "*** Citadel server engine ***\n");
+ syslog(LOG_INFO, "Version %d (build %s) ***", REV_LEVEL, svn_revision());
+ syslog(LOG_INFO, "Copyright (C) 1987-2021 by the Citadel development team.");
+ syslog(LOG_INFO, " ");
+ syslog(LOG_INFO, "This program is open source software: you can redistribute it and/or");
+ syslog(LOG_INFO, "modify it under the terms of the GNU General Public License, version 3.");
+ syslog(LOG_INFO, " ");
+ syslog(LOG_INFO, "This program is distributed in the hope that it will be useful,");
+ syslog(LOG_INFO, "but WITHOUT ANY WARRANTY; without even the implied warranty of");
+ syslog(LOG_INFO, "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the");
+ syslog(LOG_INFO, "GNU General Public License for more details.");
+ syslog(LOG_INFO, " ");
+ syslog(LOG_INFO, "%s", libcitadel_version_string());
+
+#ifdef HAVE_RUN_DIR
+ /* on some dists rundir gets purged on startup. so we need to recreate it. */
+
+ if (stat(ctdl_run_dir, &filestats) == -1) {
+#ifdef HAVE_GETPWUID_R
+#ifdef SOLARIS_GETPWUID
+ pwp = getpwuid_r(ctdluid, &pw, pwbuf, sizeof(pwbuf));
+#else // SOLARIS_GETPWUID
+ getpwuid_r(ctdluid, &pw, pwbuf, sizeof(pwbuf), &pwp);
+#endif // SOLARIS_GETPWUID
+#else // HAVE_GETPWUID_R
+ pwp = NULL;
+#endif // HAVE_GETPWUID_R
+
+ if ((mkdir(ctdl_run_dir, 0755) != 0) && (errno != EEXIST)) {
+ syslog(LOG_ERR, "main: unable to create run directory [%s]: %m", ctdl_run_dir);
}
+ if (chown(ctdl_run_dir, ctdluid, (pwp==NULL)?-1:pw.pw_gid) != 0) {
+ syslog(LOG_ERR, "main: unable to set the access rights for [%s]: %m", ctdl_run_dir);
+ }
}
+#endif
- /* Tell 'em who's in da house */
- lprintf(CTDL_NOTICE, "\n");
- lprintf(CTDL_NOTICE, "\n");
- lprintf(CTDL_NOTICE,
- "*** Citadel/UX messaging server engine v%d.%02d ***\n",
- (REV_LEVEL/100), (REV_LEVEL%100));
- lprintf(CTDL_NOTICE,
- "Copyright (C) 1987-2003 by the Citadel/UX development team.\n");
- lprintf(CTDL_NOTICE,
- "This program is distributed under the terms of the GNU "
- "General Public License.\n");
- lprintf(CTDL_NOTICE, "\n");
-
- /* Load site-specific parameters, and set the ipgm secret */
- lprintf(CTDL_INFO, "Loading citadel.config\n");
- get_config();
- config.c_ipgm_secret = rand();
- put_config();
-
- /* Initialize... */
- init_sysdep();
+ ctdl_lockfile(1);
+ init_sysdep(); // Initialize...
+ master_startup(); // Do non system dependent startup functions
+ check_control(); // Check/sanitize/initialize control record, fix user indexes
+ syslog(LOG_INFO, "main: upgrading modules"); // Run any upgrade entry points
+ upgrade_modules();
+/*
+ * Load the user for the masterCC or create them if they don't exist
+ */
+ if (CtdlGetUser(&masterCC.user, "SYS_Citadel"))
+ {
+ /* User doesn't exist. We can't use create user here as the user number needs to be 0 */
+ strcpy (masterCC.user.fullname, "SYS_Citadel") ;
+ CtdlPutUser(&masterCC.user);
+ CtdlGetUser(&masterCC.user, "SYS_Citadel"); /* Just to be safe */
+ }
+
/*
- * Do non system dependent startup functions.
+ * Bind the server to a Unix-domain socket (user client access)
*/
- master_startup();
+ CtdlRegisterServiceHook(0,
+ file_citadel_socket,
+ citproto_begin_session,
+ do_command_loop,
+ do_async_loop,
+ CitadelServiceUDS);
/*
- * Bind the server to a Unix-domain socket.
+ * Bind the server to a Unix-domain socket (admin client access)
*/
CtdlRegisterServiceHook(0,
- "citadel.socket",
- citproto_begin_session,
- do_command_loop);
+ file_citadel_admin_socket,
+ citproto_begin_admin_session,
+ do_command_loop,
+ do_async_loop,
+ CitadelServiceUDS);
+ chmod(file_citadel_admin_socket, S_IRWXU); /* for your eyes only */
/*
* Bind the server to our favorite TCP port (usually 504).
*/
- CtdlRegisterServiceHook(config.c_port_number,
+ CtdlRegisterServiceHook(CtdlGetConfigInt("c_port_number"),
NULL,
citproto_begin_session,
- do_command_loop);
+ do_command_loop,
+ do_async_loop,
+ CitadelServiceTCP);
/*
* Load any server-side extensions available here.
*/
- lprintf(CTDL_INFO, "Initializing server extensions\n");
- size = strlen(bbs_home_directory) + 9;
- initialize_server_extensions();
+ syslog(LOG_INFO, "main: initializing server extensions");
+
+ initialise_modules(0);
+
+ /*
+ * If we need host auth, start our chkpwd daemon.
+ */
+ if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_HOST) {
+ start_chkpwd_daemon();
+ }
/*
- * Now that we've bound the sockets, change to the BBS user id and its
+ * check, whether we're fired up another time after a crash.
+ * if, post an aide message, so the admin has a chance to react.
+ */
+ checkcrash();
+
+ /*
+ * Now that we've bound the sockets, change to the Citadel user id and its
* corresponding group ids
*/
if (drop_root_perms) {
- if ((pw = getpwuid(BBSUID)) == NULL)
- lprintf(CTDL_CRIT, "WARNING: getpwuid(%ld): %s\n"
- "Group IDs will be incorrect.\n", (long)BBSUID,
- strerror(errno));
+ cdb_chmod_data(); /* make sure we own our data files */
+
+#ifdef HAVE_GETPWUID_R
+#ifdef SOLARIS_GETPWUID
+ pwp = getpwuid_r(ctdluid, &pw, pwbuf, sizeof(pwbuf));
+#else // SOLARIS_GETPWUID
+ getpwuid_r(ctdluid, &pw, pwbuf, sizeof(pwbuf), &pwp);
+#endif // SOLARIS_GETPWUID
+#else // HAVE_GETPWUID_R
+ pwp = NULL;
+#endif // HAVE_GETPWUID_R
+
+ if (pwp == NULL)
+ syslog(LOG_ERR, "main: WARNING, getpwuid(%ld): %m Group IDs will be incorrect.", (long)CTDLUID);
else {
- initgroups(pw->pw_name, pw->pw_gid);
- if (setgid(pw->pw_gid))
- lprintf(CTDL_CRIT, "setgid(%ld): %s\n", (long)pw->pw_gid,
- strerror(errno));
+ initgroups(pw.pw_name, pw.pw_gid);
+ if (setgid(pw.pw_gid))
+ syslog(LOG_ERR, "main: setgid(%ld): %m", (long)pw.pw_gid);
}
- lprintf(CTDL_INFO, "Changing uid to %ld\n", (long)BBSUID);
- if (setuid(BBSUID) != 0) {
- lprintf(CTDL_CRIT, "setuid() failed: %s\n", strerror(errno));
+ syslog(LOG_INFO, "main: changing uid to %ld", (long)CTDLUID);
+ if (setuid(CTDLUID) != 0) {
+ syslog(LOG_ERR, "main: setuid() failed: %m");
}
#if defined (HAVE_SYS_PRCTL_H) && defined (PR_SET_DUMPABLE)
prctl(PR_SET_DUMPABLE, 1);
}
/* We want to check for idle sessions once per minute */
- CtdlRegisterSessionHook(terminate_idle_sessions, EVT_TIMER);
-
- /*
- * Now create a bunch of worker threads.
- */
- lprintf(CTDL_DEBUG, "Starting %d worker threads\n", config.c_min_workers-1);
- begin_critical_section(S_WORKER_LIST);
- for (i=0; i<(config.c_min_workers-1); ++i) {
- create_worker();
- }
- end_critical_section(S_WORKER_LIST);
-
- /* Now this thread can become a worker as well. */
- initial_thread = pthread_self();
- worker_thread(NULL);
-
- /* Server is exiting. Wait for workers to shutdown. */
- lprintf(CTDL_INFO, "Waiting for worker threads to shut down\n");
-
- begin_critical_section(S_WORKER_LIST);
- while (worker_list != NULL) {
- wnp = worker_list;
- worker_list = wnp->next;
-
- /* avoid deadlock with an exiting thread */
- end_critical_section(S_WORKER_LIST);
- if ((i = pthread_join(wnp->tid, NULL)))
- lprintf(CTDL_CRIT, "pthread_join: %s\n", strerror(i));
- free(wnp);
- begin_critical_section(S_WORKER_LIST);
+ CtdlRegisterSessionHook(terminate_idle_sessions, EVT_TIMER, PRIO_CLEANUP + 1);
+
+ go_threading();
+
+ int exit_code = master_cleanup(exit_signal);
+ ctdl_lockfile(0);
+ if (restart_server) {
+ syslog(LOG_INFO, "main: *** CITADEL SERVER IS RESTARTING ***");
+ execv(argv[0], argv);
}
- end_critical_section(S_WORKER_LIST);
-
- master_cleanup();
- return(0);
+ return(exit_code);
}