2 * Main source module for the Citadel server
4 * Copyright (c) 1987-2015 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.
21 #include <libcitadel.h>
23 #include "ctdl_module.h"
24 #include "housekeeping.h"
25 #include "locate_host.h"
26 #include "citserver.h"
31 char *unique_session_numbers;
32 int ScheduledShutdown = 0;
33 time_t server_startup_time;
35 int openid_level_supported = 0;
38 * print the actual stack frame.
40 void cit_backtrace(void)
43 void *stack_frames[50];
47 const char *p = IOSTR;
48 if (p == NULL) p = "";
49 size = backtrace(stack_frames, sizeof(stack_frames) / sizeof(void*));
50 strings = backtrace_symbols(stack_frames, size);
51 for (i = 0; i < size; i++) {
53 syslog(LOG_ALERT, "%s %s\n", p, strings[i]);
55 syslog(LOG_ALERT, "%s %p\n", p, stack_frames[i]);
61 void cit_oneline_backtrace(void)
64 void *stack_frames[50];
69 size = backtrace(stack_frames, sizeof(stack_frames) / sizeof(void*));
70 strings = backtrace_symbols(stack_frames, size);
74 for (i = 1; i < size; i++) {
76 StrBufAppendPrintf(Buf, "%s : ", strings[i]);
78 StrBufAppendPrintf(Buf, "%p : ", stack_frames[i]);
81 syslog(LOG_ALERT, "%s %s\n", IOSTR, ChrPtr(Buf));
88 * print the actual stack frame.
90 void cit_panic_backtrace(int SigNum)
93 void *stack_frames[10];
97 printf("caught signal 11\n");
98 size = backtrace(stack_frames, sizeof(stack_frames) / sizeof(void*));
99 strings = backtrace_symbols(stack_frames, size);
100 for (i = 0; i < size; i++) {
102 syslog(LOG_ALERT, "%s\n", strings[i]);
104 syslog(LOG_ALERT, "%p\n", stack_frames[i]);
112 * Various things that need to be initialized at startup
114 void master_startup(void) {
118 struct ctdlroom qrbuf;
123 syslog(LOG_DEBUG, "master_startup() started\n");
124 time(&server_startup_time);
126 syslog(LOG_INFO, "Checking directory access");
127 if ((pw = getpwuid(ctdluid)) == NULL) {
133 if (create_run_directories(CTDLUID, gid) != 0) {
134 syslog(LOG_EMERG, "failed to access & create directories");
137 syslog(LOG_INFO, "Opening databases");
140 /* Load site-specific configuration */
141 syslog(LOG_INFO, "Loading citadel.config");
142 initialize_config_system();
145 syslog(LOG_INFO, "Acquiring control record");
149 /* Check floor reference counts */
152 syslog(LOG_INFO, "Creating base rooms (if necessary)\n");
153 CtdlCreateRoom(CtdlGetConfigStr("c_baseroom"), 0, "", 0, 1, 0, VIEW_BBS);
154 CtdlCreateRoom(AIDEROOM, 3, "", 0, 1, 0, VIEW_BBS);
155 CtdlCreateRoom(SYSCONFIGROOM, 3, "", 0, 1, 0, VIEW_BBS);
156 CtdlCreateRoom(CtdlGetConfigStr("c_twitroom"), 0, "", 0, 1, 0, VIEW_BBS);
158 /* The "Local System Configuration" room doesn't need to be visible */
159 if (CtdlGetRoomLock(&qrbuf, SYSCONFIGROOM) == 0) {
160 qrbuf.QRflags2 |= QR2_SYSTEM;
161 CtdlPutRoomLock(&qrbuf);
164 /* Aide needs to be public postable, else we're not RFC conformant. */
165 if (CtdlGetRoomLock(&qrbuf, AIDEROOM) == 0) {
166 qrbuf.QRflags2 |= QR2_SMTP_PUBLIC;
167 CtdlPutRoomLock(&qrbuf);
170 syslog(LOG_INFO, "Seeding the pseudo-random number generator...\n");
171 urandom = fopen("/dev/urandom", "r");
172 if (urandom != NULL) {
173 rv = fread(&seed, sizeof seed, 1, urandom);
175 syslog(LOG_EMERG, "failed to read random seed: %s\n",
180 gettimeofday(&tv, NULL);
188 syslog(LOG_DEBUG, "master_startup() finished\n");
193 * Cleanup routine to be called when the server is shutting down.
195 void master_cleanup(int exitcode) {
196 struct CleanupFunctionHook *fcn;
197 static int already_cleaning_up = 0;
199 if (already_cleaning_up) while(1) usleep(1000000);
200 already_cleaning_up = 1;
202 /* Run any cleanup routines registered by loadable modules */
203 for (fcn = CleanupHookTable; fcn != NULL; fcn = fcn->next) {
204 (*fcn->h_function_pointer)();
207 /* Close the AdjRefCount queue file */
210 /* Do system-dependent stuff */
211 sysdep_master_cleanup();
213 /* Close the configuration system */
214 shutdown_config_system();
216 /* Close databases */
217 syslog(LOG_INFO, "Closing databases\n");
220 /* If the operator requested a halt but not an exit, halt here. */
221 if (shutdown_and_halt) {
222 syslog(LOG_NOTICE, "citserver: Halting server without exiting.\n");
223 fflush(stdout); fflush(stderr);
232 syslog(LOG_NOTICE, "citserver: Exiting with status %d\n", exitcode);
233 fflush(stdout); fflush(stderr);
235 if (restart_server != 0)
237 if ((running_as_daemon != 0) && ((exitcode == 0) ))
238 exitcode = CTDLEXIT_SHUTDOWN;
245 * returns an asterisk if there are any instant messages waiting,
248 char CtdlCheckExpress(void) {
249 if (CC->FirstExpressMessage == NULL) {
259 * Check originating host against the public_clients file. This determines
260 * whether the client is allowed to change the hostname for this session
261 * (for example, to show the location of the user rather than the location
264 int CtdlIsPublicClient(void)
270 char *public_clientspos;
271 char *public_clientsend;
274 static time_t pc_timestamp = 0;
275 static char public_clients[SIZ];
276 static char public_clients_file[SIZ];
278 #define LOCALHOSTSTR "127.0.0.1"
280 snprintf(public_clients_file, sizeof public_clients_file, "%s/public_clients", ctdl_etc_dir);
283 * Check the time stamp on the public_clients file. If it's been
284 * updated since the last time we were here (or if this is the first
285 * time we've been through the loop), read its contents and learn
286 * the IP addresses of the listed hosts.
288 if (stat(public_clients_file, &statbuf) != 0) {
289 /* No public_clients file exists, so bail out */
290 syslog(LOG_WARNING, "Warning: '%s' does not exist\n",
291 public_clients_file);
295 if (statbuf.st_mtime > pc_timestamp) {
296 begin_critical_section(S_PUBLIC_CLIENTS);
297 syslog(LOG_INFO, "Loading %s\n", public_clients_file);
299 public_clientspos = &public_clients[0];
300 public_clientsend = public_clientspos + SIZ;
301 safestrncpy(public_clientspos, LOCALHOSTSTR, sizeof public_clients);
302 public_clientspos += sizeof(LOCALHOSTSTR) - 1;
304 if (hostname_to_dotted_quad(addrbuf, CtdlGetConfigStr("c_fqdn")) == 0) {
305 *(public_clientspos++) = '|';
307 while (!IsEmptyStr (paddr) &&
308 (public_clientspos < public_clientsend))
309 *(public_clientspos++) = *(paddr++);
312 fp = fopen(public_clients_file, "r");
314 while ((fgets(buf, sizeof buf, fp)!=NULL) &&
315 (public_clientspos < public_clientsend)){
318 while (!IsEmptyStr(ptr)) {
326 while (ptr>buf && isspace(*ptr)) {
329 if (hostname_to_dotted_quad(addrbuf, buf) == 0) {
330 *(public_clientspos++) = '|';
332 while (!IsEmptyStr(paddr) &&
333 (public_clientspos < public_clientsend)){
334 *(public_clientspos++) = *(paddr++);
338 if (fp != NULL) fclose(fp);
339 pc_timestamp = time(NULL);
340 end_critical_section(S_PUBLIC_CLIENTS);
343 syslog(LOG_DEBUG, "Checking whether %s is a local or public client\n",
345 for (i=0; i<num_parms(public_clients); ++i) {
346 extract_token(addrbuf, public_clients, i, '|', sizeof addrbuf);
347 if (!strcasecmp(CC->cs_addr, addrbuf)) {
348 syslog(LOG_DEBUG, "... yes its local.\n");
353 /* No hits. This is not a public client. */
354 syslog(LOG_DEBUG, "... no it isn't.\n");
362 void citproto_begin_session() {
363 if (CC->nologin==1) {
364 cprintf("%d %s: Too many users are already online (maximum is %d)\n",
365 ERROR + MAX_SESSIONS_EXCEEDED,
366 CtdlGetConfigStr("c_nodename"), CtdlGetConfigInt("c_maxsessions")
368 CC->kill_me = KILLME_MAX_SESSIONS_EXCEEDED;
371 cprintf("%d %s Citadel server ready.\n", CIT_OK, CtdlGetConfigStr("c_nodename"));
372 CC->can_receive_im = 1;
377 void citproto_begin_admin_session() {
378 CC->internal_pgm = 1;
379 cprintf("%d %s Citadel server ADMIN CONNECTION ready.\n", CIT_OK, CtdlGetConfigStr("c_nodename"));
386 * This loop recognizes all server commands.
388 void do_command_loop(void) {
392 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
393 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
394 syslog(LOG_ERR, "Citadel client disconnected: ending session.\n");
395 CC->kill_me = KILLME_CLIENT_DISCONNECTED;
399 /* Log the server command, but don't show passwords... */
400 if ( (strncasecmp(cmdbuf, "PASS", 4)) && (strncasecmp(cmdbuf, "SETP", 4)) ) {
401 syslog(LOG_INFO, "[%d][%s(%ld)] %s",
402 CC->cs_pid, CC->curr_user, CC->user.usernum, cmdbuf
406 syslog(LOG_INFO, "[%d][%s(%ld)] <password command hidden from log>",
407 CC->cs_pid, CC->curr_user, CC->user.usernum
414 * Let other clients see the last command we executed, and
415 * update the idle time, but not NOOP, QNOP, PEXP, GEXP, RWHO, or TIME.
417 if ( (strncasecmp(cmdbuf, "NOOP", 4))
418 && (strncasecmp(cmdbuf, "QNOP", 4))
419 && (strncasecmp(cmdbuf, "PEXP", 4))
420 && (strncasecmp(cmdbuf, "GEXP", 4))
421 && (strncasecmp(cmdbuf, "RWHO", 4))
422 && (strncasecmp(cmdbuf, "TIME", 4)) ) {
423 strcpy(CC->lastcmdname, " ");
424 safestrncpy(CC->lastcmdname, cmdbuf, sizeof(CC->lastcmdname));
428 if ((strncasecmp(cmdbuf, "ENT0", 4))
429 && (strncasecmp(cmdbuf, "MESG", 4))
430 && (strncasecmp(cmdbuf, "MSGS", 4)))
432 CC->cs_flags &= ~CS_POSTING;
435 if (!DLoader_Exec_Cmd(cmdbuf)) {
436 cprintf("%d Unrecognized or unsupported command.\n", ERROR + CMD_NOT_SUPPORTED);
441 /* Run any after-each-command routines registered by modules */
442 PerformSessionHooks(EVT_CMD);
447 * This loop performs all asynchronous functions.
449 void do_async_loop(void) {
450 PerformSessionHooks(EVT_ASYNC);