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>
23 #include "citserver.h"
24 #include "svn_revision.h"
25 #include "modules_init.h"
28 #include "serv_extensions.h"
29 #include "citadel_dirs.h"
33 const char *CitadelServiceUDS="citadel-UDS";
34 const char *CitadelServiceTCP="citadel-TCP";
35 int sanity_diag_mode = 0;
39 * Create or remove a lock file, so we only have one Citadel Server running at a time.
41 void ctdl_lockfile(int yo) {
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;
81 int max_log_level = LOG_INFO;
82 char relhome[PATH_MAX]="";
83 char ctdldir[PATH_MAX]=CTDLDIR;
84 int syslog_facility = LOG_DAEMON;
86 struct passwd *p = NULL;
88 struct stat filestats;
91 /* initialize the master context */
93 InitializeMasterTSD();
95 /* parse command-line arguments */
96 while ((a=getopt(argc, argv, "cl:dh:x:t:B:Dru:s:")) != EOF) switch(a) {
98 // test this binary for compatibility and exit
100 fprintf(stderr, "%d: binary compatibility confirmed\n", argv[0]);
104 // identify the desired syslog facility
106 safestrncpy(facility, optarg, sizeof(facility));
107 syslog_facility = SyslogFacility(facility);
110 // run in the background if -d was specified
112 running_as_daemon = 1;
115 // specify the data directory
117 relh = optarg[0] != '/';
119 safestrncpy(ctdl_home_directory, optarg, sizeof ctdl_home_directory);
122 safestrncpy(relhome, optarg, sizeof relhome);
127 // identify the desired logging severity level
129 max_log_level = atoi(optarg);
136 // basesize (what is this?)
138 basesize = atoi(optarg);
145 // -r tells the server not to drop root permissions.
146 // Don't use this unless you know what you're doing.
151 // -u tells the server what uid to run under...
158 p = getpwnam(optarg);
168 // -s tells the server to behave differently during sanity checks
170 sanity_diag_mode = atoi(optarg);
173 // any other parameter makes it crash and burn
175 fprintf(stderr, "citserver: usage: "
186 /* Last ditch effort to determine the user name ... if there's a user called "citadel" then use that */
188 p = getpwnam("citadel");
193 p = getpwnam("guest");
203 if ((ctdluid == 0) && (drop_root_perms == 0)) {
204 fprintf(stderr, "citserver: cannot determine user to run as; please specify -r or -u options\n");
205 exit(CTDLEXIT_UNUSER);
208 StartLibCitadel(basesize);
209 setlogmask(LOG_UPTO(max_log_level));
211 ( running_as_daemon ? (LOG_PID) : (LOG_PID | LOG_PERROR) ),
215 calc_dirs_n_files(relh, home, relhome, ctdldir, dbg);
216 /* daemonize, if we were asked to */
217 if (running_as_daemon) {
222 /* Tell 'em who's in da house */
223 syslog(LOG_INFO, " ");
224 syslog(LOG_INFO, " ");
225 syslog(LOG_INFO, "*** Citadel server engine ***\n");
226 syslog(LOG_INFO, "Version %d (build %s) ***", REV_LEVEL, svn_revision());
227 syslog(LOG_INFO, "Copyright (C) 1987-2021 by the Citadel development team.");
228 syslog(LOG_INFO, " ");
229 syslog(LOG_INFO, "This program is open source software: you can redistribute it and/or");
230 syslog(LOG_INFO, "modify it under the terms of the GNU General Public License, version 3.");
231 syslog(LOG_INFO, " ");
232 syslog(LOG_INFO, "This program is distributed in the hope that it will be useful,");
233 syslog(LOG_INFO, "but WITHOUT ANY WARRANTY; without even the implied warranty of");
234 syslog(LOG_INFO, "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the");
235 syslog(LOG_INFO, "GNU General Public License for more details.");
236 syslog(LOG_INFO, " ");
237 syslog(LOG_INFO, "%s", libcitadel_version_string());
240 /* on some dists rundir gets purged on startup. so we need to recreate it. */
242 if (stat(ctdl_run_dir, &filestats) == -1) {
243 #ifdef HAVE_GETPWUID_R
244 #ifdef SOLARIS_GETPWUID
245 pwp = getpwuid_r(ctdluid, &pw, pwbuf, sizeof(pwbuf));
246 #else // SOLARIS_GETPWUID
247 getpwuid_r(ctdluid, &pw, pwbuf, sizeof(pwbuf), &pwp);
248 #endif // SOLARIS_GETPWUID
249 #else // HAVE_GETPWUID_R
251 #endif // HAVE_GETPWUID_R
253 if ((mkdir(ctdl_run_dir, 0755) != 0) && (errno != EEXIST)) {
254 syslog(LOG_ERR, "main: unable to create run directory [%s]: %m", ctdl_run_dir);
257 if (chown(ctdl_run_dir, ctdluid, (pwp==NULL)?-1:pw.pw_gid) != 0) {
258 syslog(LOG_ERR, "main: unable to set the access rights for [%s]: %m", ctdl_run_dir);
264 init_sysdep(); // Initialize...
265 master_startup(); // Do non system dependent startup functions
266 check_control(); // Check/sanitize/initialize control record, fix user indexes
267 syslog(LOG_INFO, "main: upgrading modules"); // Run any upgrade entry points
271 * Load the user for the masterCC or create them if they don't exist
273 if (CtdlGetUser(&masterCC.user, "SYS_Citadel"))
275 /* User doesn't exist. We can't use create user here as the user number needs to be 0 */
276 strcpy (masterCC.user.fullname, "SYS_Citadel") ;
277 CtdlPutUser(&masterCC.user);
278 CtdlGetUser(&masterCC.user, "SYS_Citadel"); /* Just to be safe */
282 * Bind the server to a Unix-domain socket (user client access)
284 CtdlRegisterServiceHook(0,
286 citproto_begin_session,
292 * Bind the server to a Unix-domain socket (admin client access)
294 CtdlRegisterServiceHook(0,
295 file_citadel_admin_socket,
296 citproto_begin_admin_session,
300 chmod(file_citadel_admin_socket, S_IRWXU); /* for your eyes only */
303 * Bind the server to our favorite TCP port (usually 504).
305 CtdlRegisterServiceHook(CtdlGetConfigInt("c_port_number"),
307 citproto_begin_session,
313 * Load any server-side extensions available here.
315 syslog(LOG_INFO, "main: initializing server extensions");
317 initialise_modules(0);
320 * If we need host auth, start our chkpwd daemon.
322 if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_HOST) {
323 start_chkpwd_daemon();
327 * check, whether we're fired up another time after a crash.
328 * if, post an aide message, so the admin has a chance to react.
333 * Now that we've bound the sockets, change to the Citadel user id and its
334 * corresponding group ids
336 if (drop_root_perms) {
337 cdb_chmod_data(); /* make sure we own our data files */
339 #ifdef HAVE_GETPWUID_R
340 #ifdef SOLARIS_GETPWUID
341 pwp = getpwuid_r(ctdluid, &pw, pwbuf, sizeof(pwbuf));
342 #else // SOLARIS_GETPWUID
343 getpwuid_r(ctdluid, &pw, pwbuf, sizeof(pwbuf), &pwp);
344 #endif // SOLARIS_GETPWUID
345 #else // HAVE_GETPWUID_R
347 #endif // HAVE_GETPWUID_R
350 syslog(LOG_ERR, "main: WARNING, getpwuid(%ld): %m Group IDs will be incorrect.", (long)CTDLUID);
352 initgroups(pw.pw_name, pw.pw_gid);
353 if (setgid(pw.pw_gid))
354 syslog(LOG_ERR, "main: setgid(%ld): %m", (long)pw.pw_gid);
356 syslog(LOG_INFO, "main: changing uid to %ld", (long)CTDLUID);
357 if (setuid(CTDLUID) != 0) {
358 syslog(LOG_ERR, "main: setuid() failed: %m");
360 #if defined (HAVE_SYS_PRCTL_H) && defined (PR_SET_DUMPABLE)
361 prctl(PR_SET_DUMPABLE, 1);
365 /* We want to check for idle sessions once per minute */
366 CtdlRegisterSessionHook(terminate_idle_sessions, EVT_TIMER, PRIO_CLEANUP + 1);
370 int exit_code = master_cleanup(exit_signal);
372 if (restart_server) {
373 syslog(LOG_INFO, "main: *** CITADEL SERVER IS RESTARTING ***");
374 execv(argv[0], argv);