New server option -b to specify the name of a file to which backtrace should be writt...
[citadel.git] / citadel / server_main.c
index bab3ab69f29bc960da866d43e7c5cfd5a1417825..33fdc33bcca13daed5bfa5ccf6a778dcdad08e63 100644 (file)
-/*
- * citserver's main() function lives here.
- * 
- * Copyright (c) 1987-2012 by the citadel.org team
- *
- * 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.
- */
+// citserver's main() function lives here.
+// 
+// Copyright (c) 1987-2021 by the citadel.org team
+//
+// 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>
-#include <pwd.h>
-#ifdef HAVE_SYS_PRCTL_H
-#include <sys/prctl.h>
-#endif
+#include <sys/file.h>
 #include <libcitadel.h>
-#include "citadel.h"
-#include "server.h"
-#include "serv_extensions.h"
-#include "sysdep_decls.h"
-#include "threads.h"
 #include "citserver.h"
-#include "support.h"
+#include "svn_revision.h"
+#include "modules_init.h"
 #include "config.h"
 #include "control.h"
-#include "database.h"
-#include "user_ops.h"
-#include "housekeeping.h"
-#include "svn_revision.h"
+#include "serv_extensions.h"
 #include "citadel_dirs.h"
+#include "user_ops.h"
 
-#include "context.h"
-
-#include "modules_init.h"
-#include "ecrash.h"
-
-#ifdef HAVE_SYS_SELECT_H
-#include <sys/select.h>
-#endif
-
-#ifndef HAVE_SNPRINTF
-#include "snprintf.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.
+ * Set 'op' to nonzero to lock, zero to unlock.
+ */
+void ctdl_lockfile(int op) {
+       static char lockfilename[PATH_MAX];
+       static FILE *fp;
+
+       if (op) {
+               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);
+}
 
-void go_threading(void);
 
 /*
  * Here's where it all begins.
  */
-int main(int argc, char **argv)
-{
+int main(int argc, char **argv) {
+
        char facility[32];
-       int a;                  /* General-purpose variables */
+       int a;                  // General-purpose variables
        struct passwd pw, *pwp = NULL;
        char pwbuf[SIZ];
        int drop_root_perms = 1;
-       int relh=0;
-       int home=0;
-       int dbg=0;
-       char relhome[PATH_MAX]="";
-       char ctdldir[PATH_MAX]=CTDLDIR;
+       int max_log_level = LOG_INFO;
+       char *ctdldir = CTDLDIR;
        int syslog_facility = LOG_DAEMON;
+       uid_t u = 0;
+       struct passwd *p = NULL;
 #ifdef HAVE_RUN_DIR
        struct stat filestats;
-#endif
-#ifdef HAVE_BACKTRACE
-       eCrashParameters params;
-//     eCrashSymbolTable symbol_table;
 #endif
 
-       /* initialize the master context */
-       InitializeMasterCC();
-       InitializeMasterTSD();
+       /* 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());
 
        /* parse command-line arguments */
-       while ((a=getopt(argc, argv, "l:dh:x:t:Dr")) != EOF) switch(a) {
+       while ((a=getopt(argc, argv, "cl:dh:x:t:B:Dru:s:b:")) != 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 */
+               // 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;
+                       ctdldir = optarg;
                        break;
 
-               case 'x':       /* deprecated */
+               // identify the desired logging severity level
+               case 'x':
+                       max_log_level = atoi(optarg);
                        break;
 
-               case 't':       /* deprecated */
+               // deprecated
+               case 't':
                        break;
 
+               // deprecated
+                case 'B':
+                        break;
+
+               // deprecated
                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.
-                */
+               // -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;
 
+               // -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;
+
+               case 'b':
+                       backtrace_filename = strdup(optarg);
+                       break;
+
+               // any other parameter makes it crash and burn
                default:
-               /* any other parameter makes it crash and burn */
                        fprintf(stderr, "citserver: usage: "
                                        "citserver "
                                        "[-l LogFacility] "
-                                       "[-d] [-D] [-r] "
+                                       "[-x MaxLogLevel] "
+                                       "[-d] [-r] "
+                                       "[-u user] "
                                        "[-h HomeDir]\n"
                        );
                        exit(1);
        }
 
+       if (chdir(ctdldir) != 0) {
+               syslog(LOG_ERR, "main: unable to change directory to [%s]: %m", ctdldir);
+               exit(CTDLEXIT_HOME);
+       }
+       else {
+               syslog(LOG_INFO, "main: running in data directory %s", ctdldir);
+       }
+
+       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);
+       }
+
+       /* 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");
+               }
+               if (!p) {
+                       p = getpwnam("guest");
+               }
+               if (p) {
+                       u = p->pw_uid;
+               }
+               if (u > 0) {
+                       ctdluid = u;
+               }
+       }
+
+       /* initialize the master context */
+       InitializeMasterCC();
+       InitializeMasterTSD();
+
+       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;
        }
 
-#ifdef HAVE_BACKTRACE
-       bzero(&params, sizeof(params));
-       params.filename = file_pid_paniclog;
-       panic_fd=open(file_pid_paniclog, O_APPEND|O_CREAT|O_DIRECT);
-       params.filep = fopen(file_pid_paniclog, "a+");
-       params.debugLevel = ECRASH_DEBUG_VERBOSE;
-       params.dumpAllThreads = TRUE;
-       params.useBacktraceSymbols = 1;
-       params.signals[0]=SIGSEGV;
-       params.signals[1]=SIGILL;
-       params.signals[2]=SIGBUS;
-       params.signals[3]=SIGABRT;
-       eCrash_Init(&params);
-       eCrash_RegisterThread("MasterThread", 0);
-#endif
-
-       /* Tell 'em who's in da house */
-       syslog(LOG_NOTICE, " ");
-       syslog(LOG_NOTICE, " ");
-       syslog(LOG_NOTICE,
-               "*** Citadel server engine v%d.%02d (build %s) ***",
-               (REV_LEVEL/100), (REV_LEVEL%100), svn_revision());
-       syslog(LOG_NOTICE, "Copyright (C) 1987-2012 by the Citadel development team.");
-       syslog(LOG_NOTICE, "This program is distributed under the terms of the GNU "
-                                       "General Public License.");
-       syslog(LOG_NOTICE, " ");
-       syslog(LOG_DEBUG, "Called as: %s", argv[0]);
-       syslog(LOG_INFO, "%s", libcitadel_version_string());
-
-       /* Load site-specific configuration */
-       syslog(LOG_INFO, "Loading citadel.config");
-       get_config();
-
-       /* get_control() MUST MUST MUST be called BEFORE the databases are opened!! */
-       syslog(LOG_INFO, "Acquiring control record");
-       get_control();
-
-       put_config();
-
-#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(config.c_ctdluid, &pw, pwbuf, sizeof(pwbuf));
-#else // SOLARIS_GETPWUID
-               getpwuid_r(config.c_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_EMERG, 
-                                     "unable to create run directory [%s]: %s", 
-                                     ctdl_run_dir, strerror(errno));
-
-               if (chown(ctdl_run_dir, config.c_ctdluid, (pwp==NULL)?-1:pw.pw_gid) != 0)
-                       syslog(LOG_EMERG, 
-                                     "unable to set the access rights for [%s]: %s", 
-                                     ctdl_run_dir, strerror(errno));
+       if ((mkdir(ctdl_run_dir, 0755) != 0) && (errno != EEXIST)) {
+               syslog(LOG_ERR, "main: unable to create run directory [%s]: %m", ctdl_run_dir);
        }
-                       
-
-#endif
 
-       /* Initialize... */
-       init_sysdep();
+       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);
+       }
 
-       /*
-        * Do non system dependent startup functions.
-        */
-       master_startup();
+       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();
 
        /*
-        * Check that the control record is correct and place sensible values if it isn't
-        */
-       check_control();
-       
-       /*
-        * Run any upgrade entry points
+        * Load the user for the masterCC or create them if they don't exist
         */
-       syslog(LOG_INFO, "Upgrading modules.");
-       upgrade_modules();
-       
-/*
- * Load the user for the masterCC or create them if they don't exist
- */
-       if (CtdlGetUser(&masterCC.user, "SYS_Citadel"))
-       {
+       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 */
+               CtdlGetUser(&masterCC.user, "SYS_Citadel");     /* Just to be safe */
        }
        
        /*
@@ -297,68 +281,49 @@ int main(int argc, char **argv)
        /*
         * 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_async_loop,
                                CitadelServiceTCP);
 
-                               
-       
-       
        /*
         * Load any server-side extensions available here.
         */
-       syslog(LOG_INFO, "Initializing server extensions");
-       
+       syslog(LOG_INFO, "main: initializing server extensions");
        initialise_modules(0);
 
        /*
         * If we need host auth, start our chkpwd daemon.
         */
-       if (config.c_auth_mode == AUTHMODE_HOST) {
+       if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_HOST) {
                start_chkpwd_daemon();
        }
 
-
        /*
         * 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 ();
-
+       checkcrash();
 
        /*
-        * Now that we've bound the sockets, change to the Citadel user id and its
-        * corresponding group ids
+        * Now that we've bound the sockets, change to the Citadel user id and its corresponding group ids
         */
        if (drop_root_perms) {
                cdb_chmod_data();       /* make sure we own our data files */
-
-#ifdef HAVE_GETPWUID_R
-#ifdef SOLARIS_GETPWUID
-               pwp = getpwuid_r(config.c_ctdluid, &pw, pwbuf, sizeof(pwbuf));
-#else // SOLARIS_GETPWUID
-               getpwuid_r(config.c_ctdluid, &pw, pwbuf, sizeof(pwbuf), &pwp);
-#endif // SOLARIS_GETPWUID
-#else // HAVE_GETPWUID_R
-               pwp = NULL;
-#endif // HAVE_GETPWUID_R
-
+               getpwuid_r(ctdluid, &pw, pwbuf, sizeof(pwbuf), &pwp);
                if (pwp == NULL)
-                       syslog(LOG_CRIT, "WARNING: getpwuid(%ld): %s"
-                                  "Group IDs will be incorrect.\n", (long)CTDLUID,
-                               strerror(errno));
+                       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))
-                               syslog(LOG_CRIT, "setgid(%ld): %s", (long)pw.pw_gid,
-                                       strerror(errno));
+                       if (setgid(pw.pw_gid)) {
+                               syslog(LOG_ERR, "main: setgid(%ld): %m", (long)pw.pw_gid);
+                       }
                }
-               syslog(LOG_INFO, "Changing uid to %ld", (long)CTDLUID);
+               syslog(LOG_INFO, "main: changing uid to %ld", (long)CTDLUID);
                if (setuid(CTDLUID) != 0) {
-                       syslog(LOG_CRIT, "setuid() failed: %s", strerror(errno));
+                       syslog(LOG_ERR, "main: setuid() failed: %m");
                }
 #if defined (HAVE_SYS_PRCTL_H) && defined (PR_SET_DUMPABLE)
                prctl(PR_SET_DUMPABLE, 1);
@@ -366,10 +331,17 @@ int main(int argc, char **argv)
        }
 
        /* We want to check for idle sessions once per minute */
-       CtdlRegisterSessionHook(terminate_idle_sessions, EVT_TIMER);
+       CtdlRegisterSessionHook(terminate_idle_sessions, EVT_TIMER, PRIO_CLEANUP + 1);
 
+       /* Go into multithreaded mode.  When this call exits, the server is stopping. */
        go_threading();
        
-       master_cleanup(exit_signal);
-       return(0);
+       /* Get ready to shut down the server. */
+       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);
+       }
+       return(exit_code);
 }