2 * citserver's main() function lives here.
4 * Copyright (c) 1987-2021 by the citadel.org team
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.
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.
17 #include <sys/types.h>
21 #include <libcitadel.h>
22 #include "citserver.h"
23 #include "svn_revision.h"
24 #include "modules_init.h"
27 #include "serv_extensions.h"
28 #include "citadel_dirs.h"
32 const char *CitadelServiceUDS="citadel-UDS";
33 const char *CitadelServiceTCP="citadel-TCP";
34 int sanity_diag_mode = 0;
38 * Create or remove a lock file, so we only have one Citadel Server running at a time.
39 * Set 'op' to nonzero to lock, zero to unlock.
41 void ctdl_lockfile(int op) {
42 static char lockfilename[PATH_MAX];
46 syslog(LOG_DEBUG, "main: creating lockfile");
47 snprintf(lockfilename, sizeof lockfilename, "%s/citadel.lock", ctdl_run_dir);
48 fp = fopen(lockfilename, "w");
50 syslog(LOG_ERR, "%s: %m", lockfilename);
53 if (flock(fileno(fp), (LOCK_EX|LOCK_NB)) != 0) {
54 syslog(LOG_ERR, "main: cannot lock %s , is another citserver running?", lockfilename);
60 syslog(LOG_DEBUG, "main: removing lockfile");
62 flock(fileno(fp), LOCK_UN);
68 * Here's where it all begins.
70 int main(int argc, char **argv) {
74 int a; /* General-purpose variables */
75 struct passwd pw, *pwp = NULL;
77 int drop_root_perms = 1;
78 int max_log_level = LOG_INFO;
79 char *ctdldir = CTDLDIR;
80 int syslog_facility = LOG_DAEMON;
82 struct passwd *p = NULL;
84 struct stat filestats;
87 /* Tell 'em who's in da house */
88 syslog(LOG_INFO, " ");
89 syslog(LOG_INFO, " ");
90 syslog(LOG_INFO, "*** Citadel server engine ***\n");
91 syslog(LOG_INFO, "Version %d (build %s) ***", REV_LEVEL, svn_revision());
92 syslog(LOG_INFO, "Copyright (C) 1987-2021 by the Citadel development team.");
93 syslog(LOG_INFO, " ");
94 syslog(LOG_INFO, "This program is open source software: you can redistribute it and/or");
95 syslog(LOG_INFO, "modify it under the terms of the GNU General Public License, version 3.");
96 syslog(LOG_INFO, " ");
97 syslog(LOG_INFO, "This program is distributed in the hope that it will be useful,");
98 syslog(LOG_INFO, "but WITHOUT ANY WARRANTY; without even the implied warranty of");
99 syslog(LOG_INFO, "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the");
100 syslog(LOG_INFO, "GNU General Public License for more details.");
101 syslog(LOG_INFO, " ");
102 syslog(LOG_INFO, "%s", libcitadel_version_string());
104 /* parse command-line arguments */
105 while ((a=getopt(argc, argv, "cl:dh:x:t:B:Dru:s:")) != EOF) switch(a) {
107 // test this binary for compatibility and exit
109 fprintf(stderr, "%s: binary compatibility confirmed\n", argv[0]);
113 // identify the desired syslog facility
115 safestrncpy(facility, optarg, sizeof(facility));
116 syslog_facility = SyslogFacility(facility);
119 // run in the background if -d was specified
121 running_as_daemon = 1;
124 // specify the data directory
129 // identify the desired logging severity level
131 max_log_level = atoi(optarg);
138 // basesize (passed to libcitadel)
140 basesize = atoi(optarg);
147 // -r tells the server not to drop root permissions.
148 // Don't use this unless you know what you're doing.
153 // -u tells the server what uid to run under...
160 p = getpwnam(optarg);
170 // -s tells the server to behave differently during sanity checks
172 sanity_diag_mode = atoi(optarg);
175 // any other parameter makes it crash and burn
177 fprintf(stderr, "citserver: usage: "
188 if (chdir(ctdldir) != 0) {
189 syslog(LOG_ERR, "main: unable to change directory to [%s]: %m", ctdldir);
192 syslog(LOG_INFO, "main: running in data directory %s", ctdldir);
195 if ((ctdluid == 0) && (drop_root_perms == 0)) {
196 fprintf(stderr, "citserver: cannot determine user to run as; please specify -r or -u options\n");
197 exit(CTDLEXIT_UNUSER);
200 /* Last ditch effort to determine the user name ... if there's a user called "citadel" then use that */
202 p = getpwnam("citadel");
207 p = getpwnam("guest");
217 /* initialize the master context */
218 InitializeMasterCC();
219 InitializeMasterTSD();
221 StartLibCitadel(basesize);
222 setlogmask(LOG_UPTO(max_log_level));
224 ( running_as_daemon ? (LOG_PID) : (LOG_PID | LOG_PERROR) ),
228 /* daemonize, if we were asked to */
229 if (running_as_daemon) {
234 if ((mkdir(ctdl_run_dir, 0755) != 0) && (errno != EEXIST)) {
235 syslog(LOG_ERR, "main: unable to create run directory [%s]: %m", ctdl_run_dir);
238 if (chown(ctdl_run_dir, ctdluid, (pwp==NULL)?-1:pw.pw_gid) != 0) {
239 syslog(LOG_ERR, "main: unable to set the access rights for [%s]: %m", ctdl_run_dir);
243 init_sysdep(); // Initialize...
244 master_startup(); // Do non system dependent startup functions
245 check_control(); // Check/sanitize/initialize control record, fix user indexes
246 syslog(LOG_INFO, "main: upgrading modules"); // Run any upgrade entry points
250 * Load the user for the masterCC or create them if they don't exist
252 if (CtdlGetUser(&masterCC.user, "SYS_Citadel")) {
253 /* User doesn't exist. We can't use create user here as the user number needs to be 0 */
254 strcpy (masterCC.user.fullname, "SYS_Citadel") ;
255 CtdlPutUser(&masterCC.user);
256 CtdlGetUser(&masterCC.user, "SYS_Citadel"); /* Just to be safe */
260 * Bind the server to a Unix-domain socket (user client access)
262 CtdlRegisterServiceHook(0,
264 citproto_begin_session,
270 * Bind the server to a Unix-domain socket (admin client access)
272 CtdlRegisterServiceHook(0,
273 file_citadel_admin_socket,
274 citproto_begin_admin_session,
278 chmod(file_citadel_admin_socket, S_IRWXU); /* for your eyes only */
281 * Bind the server to our favorite TCP port (usually 504).
283 CtdlRegisterServiceHook(CtdlGetConfigInt("c_port_number"),
285 citproto_begin_session,
291 * Load any server-side extensions available here.
293 syslog(LOG_INFO, "main: initializing server extensions");
294 initialise_modules(0);
297 * If we need host auth, start our chkpwd daemon.
299 if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_HOST) {
300 start_chkpwd_daemon();
304 * check, whether we're fired up another time after a crash.
305 * if, post an aide message, so the admin has a chance to react.
310 * Now that we've bound the sockets, change to the Citadel user id and its corresponding group ids
312 if (drop_root_perms) {
313 cdb_chmod_data(); /* make sure we own our data files */
314 getpwuid_r(ctdluid, &pw, pwbuf, sizeof(pwbuf), &pwp);
316 syslog(LOG_ERR, "main: WARNING, getpwuid(%ld): %m Group IDs will be incorrect.", (long)CTDLUID);
318 initgroups(pw.pw_name, pw.pw_gid);
319 if (setgid(pw.pw_gid)) {
320 syslog(LOG_ERR, "main: setgid(%ld): %m", (long)pw.pw_gid);
323 syslog(LOG_INFO, "main: changing uid to %ld", (long)CTDLUID);
324 if (setuid(CTDLUID) != 0) {
325 syslog(LOG_ERR, "main: setuid() failed: %m");
327 #if defined (HAVE_SYS_PRCTL_H) && defined (PR_SET_DUMPABLE)
328 prctl(PR_SET_DUMPABLE, 1);
332 /* We want to check for idle sessions once per minute */
333 CtdlRegisterSessionHook(terminate_idle_sessions, EVT_TIMER, PRIO_CLEANUP + 1);
335 /* Go into multithreaded mode. When this call exits, the server is stopping. */
338 /* Get ready to shut down the server. */
339 int exit_code = master_cleanup(exit_signal);
341 if (restart_server) {
342 syslog(LOG_INFO, "main: *** CITADEL SERVER IS RESTARTING ***");
343 execv(argv[0], argv);