* Variable names, comments, documentation, etc... removed the acronym 'BBS'
[citadel.git] / citadel / server_main.c
1 /*
2  * citserver's main() function lives here.
3  *
4  * $Id$
5  */
6
7 #include "sysdep.h"
8 #include <stdlib.h>
9 #include <unistd.h>
10 #include <stdio.h>
11 #include <fcntl.h>
12 #include <ctype.h>
13 #include <signal.h>
14 #include <sys/types.h>
15 #include <sys/stat.h>
16 #include <sys/wait.h>
17 #include <sys/socket.h>
18 #include <syslog.h>
19
20 #if TIME_WITH_SYS_TIME
21 # include <sys/time.h>
22 # include <time.h>
23 #else
24 # if HAVE_SYS_TIME_H
25 #  include <sys/time.h>
26 # else
27 #  include <time.h>
28 # endif
29 #endif
30
31 #include <limits.h>
32 #include <netinet/in.h>
33 #include <netdb.h>
34 #include <sys/un.h>
35 #include <string.h>
36 #include <pwd.h>
37 #include <errno.h>
38 #include <stdarg.h>
39 #include <grp.h>
40 #ifdef HAVE_PTHREAD_H
41 #include <pthread.h>
42 #endif
43 #ifdef HAVE_SYS_PRCTL_H
44 #include <sys/prctl.h>
45 #endif
46 #include "citadel.h"
47 #include "server.h"
48 #include "serv_extensions.h"
49 #include "sysdep_decls.h"
50 #include "citserver.h"
51 #include "support.h"
52 #include "config.h"
53 #include "database.h"
54 #include "housekeeping.h"
55 #include "tools.h"
56
57 #ifdef HAVE_SYS_SELECT_H
58 #include <sys/select.h>
59 #endif
60
61 #ifndef HAVE_SNPRINTF
62 #include "snprintf.h"
63 #endif
64
65 int running_as_daemon = 0;
66
67 /*
68  * Here's where it all begins.
69  */
70 int main(int argc, char **argv)
71 {
72         char facility[32];
73         int a, i;                       /* General-purpose variables */
74         struct passwd *pw;
75         int drop_root_perms = 1;
76         size_t size;
77
78         /* initialize the master context */
79         InitializeMasterCC();
80
81         /* set default syslog facility */
82         syslog_facility = LOG_DAEMON;
83
84         /* parse command-line arguments */
85         for (a=1; a<argc; ++a) {
86
87                 if (!strncmp(argv[a], "-l", 2)) {
88                         safestrncpy(facility, argv[a], sizeof(facility));
89                         syslog_facility = SyslogFacility(facility);
90                         enable_syslog = 1;
91                 }
92
93                 /* run in the background if -d was specified */
94                 else if (!strcmp(argv[a], "-d")) {
95                         running_as_daemon = 1;
96                 }
97
98                 /* -x specifies the desired logging level */
99                 else if (!strncmp(argv[a], "-x", 2)) {
100                         verbosity = atoi(&argv[a][2]);
101                 }
102
103                 else if (!strncmp(argv[a], "-h", 2)) {
104                         safestrncpy(ctdl_home_directory, &argv[a][2],
105                                     sizeof ctdl_home_directory);
106                         home_specified = 1;
107                 }
108
109                 else if (!strncmp(argv[a], "-t", 2)) {
110                         freopen(&argv[a][2], "w", stderr);
111                 }
112
113                 else if (!strncmp(argv[a], "-f", 2)) {
114                         do_defrag = 1;
115                 }
116
117                 /* -r tells the server not to drop root permissions. don't use
118                  * this unless you know what you're doing. this should be
119                  * removed in the next release if it proves unnecessary. */
120                 else if (!strcmp(argv[a], "-r"))
121                         drop_root_perms = 0;
122
123                 /* any other parameter makes it crash and burn */
124                 else {
125                         lprintf(CTDL_EMERG,     "citserver: usage: "
126                                         "citserver "
127                                         "[-lLogFacility] "
128                                         "[-d] [-f]"
129                                         " [-tTraceFile]"
130                                         " [-xLogLevel] [-hHomeDir]\n");
131                         exit(1);
132                 }
133
134         }
135
136         /* daemonize, if we were asked to */
137         if (running_as_daemon) {
138                 start_daemon(0);
139                 drop_root_perms = 1;
140         }
141
142         /* initialize the syslog facility */
143         if (enable_syslog) {
144                 if (running_as_daemon) {
145                         openlog("citadel", LOG_NDELAY, syslog_facility);
146                 }
147                 else {
148                         openlog("citadel", LOG_PERROR|LOG_NDELAY,
149                                 syslog_facility);
150                 }
151                 setlogmask(LOG_UPTO(verbosity));
152         }
153         
154         /* Tell 'em who's in da house */
155         lprintf(CTDL_NOTICE, "\n");
156         lprintf(CTDL_NOTICE, "\n");
157         lprintf(CTDL_NOTICE,
158                 "*** Citadel server engine v%d.%02d ***\n",
159                 (REV_LEVEL/100), (REV_LEVEL%100));
160         lprintf(CTDL_NOTICE,
161                 "Copyright (C) 1987-2005 by the Citadel development team.\n");
162         lprintf(CTDL_NOTICE,
163                 "This program is distributed under the terms of the GNU "
164                 "General Public License.\n");
165         lprintf(CTDL_NOTICE, "\n");
166         lprintf(CTDL_DEBUG, "Called as: %s\n", argv[0]);
167
168         /* Load site-specific parameters, and set the ipgm secret */
169         lprintf(CTDL_INFO, "Loading citadel.config\n");
170         get_config();
171         config.c_ipgm_secret = rand();
172         put_config();
173
174         /* Initialize... */
175         init_sysdep();
176
177         /*
178          * Do non system dependent startup functions.
179          */
180         master_startup();
181
182         /*
183          * Bind the server to a Unix-domain socket.
184          */
185         CtdlRegisterServiceHook(0,
186                                 "citadel.socket",
187                                 citproto_begin_session,
188                                 do_command_loop,
189                                 do_async_loop);
190
191         /*
192          * Bind the server to our favorite TCP port (usually 504).
193          */
194         CtdlRegisterServiceHook(config.c_port_number,
195                                 NULL,
196                                 citproto_begin_session,
197                                 do_command_loop,
198                                 do_async_loop);
199
200         /*
201          * Load any server-side extensions available here.
202          */
203         lprintf(CTDL_INFO, "Initializing server extensions\n");
204         size = strlen(ctdl_home_directory) + 9;
205         initialize_server_extensions();
206
207         /*
208          * Now that we've bound the sockets, change to the Citadel user id and its
209          * corresponding group ids
210          */
211         if (drop_root_perms) {
212                 if ((pw = getpwuid(CTDLUID)) == NULL)
213                         lprintf(CTDL_CRIT, "WARNING: getpwuid(%ld): %s\n"
214                                    "Group IDs will be incorrect.\n", (long)CTDLUID,
215                                 strerror(errno));
216                 else {
217                         initgroups(pw->pw_name, pw->pw_gid);
218                         if (setgid(pw->pw_gid))
219                                 lprintf(CTDL_CRIT, "setgid(%ld): %s\n", (long)pw->pw_gid,
220                                         strerror(errno));
221                 }
222                 lprintf(CTDL_INFO, "Changing uid to %ld\n", (long)CTDLUID);
223                 if (setuid(CTDLUID) != 0) {
224                         lprintf(CTDL_CRIT, "setuid() failed: %s\n", strerror(errno));
225                 }
226 #if defined (HAVE_SYS_PRCTL_H) && defined (PR_SET_DUMPABLE)
227                 prctl(PR_SET_DUMPABLE, 1);
228 #endif
229         }
230
231         /* We want to check for idle sessions once per minute */
232         CtdlRegisterSessionHook(terminate_idle_sessions, EVT_TIMER);
233
234         /*
235          * Now create a bunch of worker threads.
236          */
237         lprintf(CTDL_DEBUG, "Starting %d worker threads\n", config.c_min_workers-1);
238         begin_critical_section(S_WORKER_LIST);
239         for (i=0; i<(config.c_min_workers-1); ++i) {
240                 create_worker();
241         }
242         end_critical_section(S_WORKER_LIST);
243
244         /* Now this thread can become a worker as well. */
245         worker_thread(NULL);
246
247         /* Server is exiting. Wait for workers to shutdown. */
248         lprintf(CTDL_INFO, "Server is shutting down.\n");
249         master_cleanup(0);
250         return(0);
251 }