2 * Main source module for the Citadel server
4 * Copyright (c) 1987-2011 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 <sys/types.h>
24 #if TIME_WITH_SYS_TIME
25 # include <sys/time.h>
29 # include <sys/time.h>
45 #include <sys/types.h>
46 #include <sys/socket.h>
47 #include <netinet/in.h>
48 #include <arpa/inet.h>
49 #include <libcitadel.h>
52 #include "sysdep_decls.h"
54 #include "citserver.h"
57 #include "housekeeping.h"
61 #include "locate_host.h"
65 #include "euidindex.h"
67 #include "svn_revision.h"
68 #include "ctdl_module.h"
70 char *unique_session_numbers;
71 int ScheduledShutdown = 0;
72 time_t server_startup_time;
74 int openid_level_supported = 0;
77 * print the actual stack frame.
79 void cit_backtrace(void)
82 void *stack_frames[50];
87 size = backtrace(stack_frames, sizeof(stack_frames) / sizeof(void*));
88 strings = backtrace_symbols(stack_frames, size);
89 for (i = 0; i < size; i++) {
91 syslog(LOG_ALERT, "%s\n", strings[i]);
93 syslog(LOG_ALERT, "%p\n", stack_frames[i]);
99 void cit_oneline_backtrace(void)
101 #ifdef HAVE_BACKTRACE
102 void *stack_frames[50];
107 size = backtrace(stack_frames, sizeof(stack_frames) / sizeof(void*));
108 strings = backtrace_symbols(stack_frames, size);
112 for (i = 1; i < size; i++) {
114 StrBufAppendPrintf(Buf, "%s : ", strings[i]);
116 StrBufAppendPrintf(Buf, "%p : ", stack_frames[i]);
119 syslog(LOG_ALERT, "%s\n", ChrPtr(Buf));
126 * print the actual stack frame.
128 void cit_panic_backtrace(int SigNum)
130 #ifdef HAVE_BACKTRACE
131 void *stack_frames[10];
135 printf("caught signal 11\n");
136 size = backtrace(stack_frames, sizeof(stack_frames) / sizeof(void*));
137 strings = backtrace_symbols(stack_frames, size);
138 for (i = 0; i < size; i++) {
140 syslog(LOG_ALERT, "%s\n", strings[i]);
142 syslog(LOG_ALERT, "%p\n", stack_frames[i]);
150 * Various things that need to be initialized at startup
152 void master_startup(void) {
156 struct ctdlroom qrbuf;
159 syslog(LOG_DEBUG, "master_startup() started\n");
160 time(&server_startup_time);
163 syslog(LOG_INFO, "Opening databases\n");
167 syslog(LOG_INFO, "Creating base rooms (if necessary)\n");
168 CtdlCreateRoom(config.c_baseroom, 0, "", 0, 1, 0, VIEW_BBS);
169 CtdlCreateRoom(AIDEROOM, 3, "", 0, 1, 0, VIEW_BBS);
170 CtdlCreateRoom(SYSCONFIGROOM, 3, "", 0, 1, 0, VIEW_BBS);
171 CtdlCreateRoom(config.c_twitroom, 0, "", 0, 1, 0, VIEW_BBS);
173 /* The "Local System Configuration" room doesn't need to be visible */
174 if (CtdlGetRoomLock(&qrbuf, SYSCONFIGROOM) == 0) {
175 qrbuf.QRflags2 |= QR2_SYSTEM;
176 CtdlPutRoomLock(&qrbuf);
179 /* Aide needs to be public postable, else we're not RFC conformant. */
180 if (CtdlGetRoomLock(&qrbuf, AIDEROOM) == 0) {
181 qrbuf.QRflags2 |= QR2_SMTP_PUBLIC;
182 CtdlPutRoomLock(&qrbuf);
185 syslog(LOG_INFO, "Seeding the pseudo-random number generator...\n");
186 urandom = fopen("/dev/urandom", "r");
187 if (urandom != NULL) {
188 rv = fread(&seed, sizeof seed, 1, urandom);
190 syslog(LOG_EMERG, "failed to read random seed: %s\n",
195 gettimeofday(&tv, NULL);
203 syslog(LOG_DEBUG, "master_startup() finished\n");
208 * Cleanup routine to be called when the server is shutting down.
210 void master_cleanup(int exitcode) {
211 struct CleanupFunctionHook *fcn;
212 static int already_cleaning_up = 0;
214 if (already_cleaning_up) while(1) usleep(1000000);
215 already_cleaning_up = 1;
217 /* Run any cleanup routines registered by loadable modules */
218 for (fcn = CleanupHookTable; fcn != NULL; fcn = fcn->next) {
219 (*fcn->h_function_pointer)();
222 /* Close the AdjRefCount queue file */
225 /* Do system-dependent stuff */
226 sysdep_master_cleanup();
228 /* Close databases */
229 syslog(LOG_INFO, "Closing databases\n");
232 /* If the operator requested a halt but not an exit, halt here. */
233 if (shutdown_and_halt) {
234 syslog(LOG_NOTICE, "citserver: Halting server without exiting.\n");
235 fflush(stdout); fflush(stderr);
244 syslog(LOG_NOTICE, "citserver: Exiting with status %d\n", exitcode);
245 fflush(stdout); fflush(stderr);
247 if (restart_server != 0)
249 if ((running_as_daemon != 0) && ((exitcode == 0) ))
250 exitcode = CTDLEXIT_SHUTDOWN;
257 * returns an asterisk if there are any instant messages waiting,
260 char CtdlCheckExpress(void) {
261 if (CC->FirstExpressMessage == NULL) {
271 * Check originating host against the public_clients file. This determines
272 * whether the client is allowed to change the hostname for this session
273 * (for example, to show the location of the user rather than the location
276 int is_public_client(void)
282 char *public_clientspos;
283 char *public_clientsend;
286 static time_t pc_timestamp = 0;
287 static char public_clients[SIZ];
288 static char public_clients_file[SIZ];
290 #define LOCALHOSTSTR "127.0.0.1"
292 snprintf(public_clients_file, sizeof public_clients_file, "%s/public_clients", ctdl_etc_dir);
295 * Check the time stamp on the public_clients file. If it's been
296 * updated since the last time we were here (or if this is the first
297 * time we've been through the loop), read its contents and learn
298 * the IP addresses of the listed hosts.
300 if (stat(public_clients_file, &statbuf) != 0) {
301 /* No public_clients file exists, so bail out */
302 syslog(LOG_WARNING, "Warning: '%s' does not exist\n",
303 public_clients_file);
307 if (statbuf.st_mtime > pc_timestamp) {
308 begin_critical_section(S_PUBLIC_CLIENTS);
309 syslog(LOG_INFO, "Loading %s\n", public_clients_file);
311 public_clientspos = &public_clients[0];
312 public_clientsend = public_clientspos + SIZ;
313 safestrncpy(public_clientspos, LOCALHOSTSTR, sizeof public_clients);
314 public_clientspos += sizeof(LOCALHOSTSTR) - 1;
316 if (hostname_to_dotted_quad(addrbuf, config.c_fqdn) == 0) {
317 *(public_clientspos++) = '|';
319 while (!IsEmptyStr (paddr) &&
320 (public_clientspos < public_clientsend))
321 *(public_clientspos++) = *(paddr++);
324 fp = fopen(public_clients_file, "r");
326 while ((fgets(buf, sizeof buf, fp)!=NULL) &&
327 (public_clientspos < public_clientsend)){
330 while (!IsEmptyStr(ptr)) {
338 while (ptr>buf && isspace(*ptr)) {
341 if (hostname_to_dotted_quad(addrbuf, buf) == 0) {
342 *(public_clientspos++) = '|';
344 while (!IsEmptyStr(paddr) &&
345 (public_clientspos < public_clientsend)){
346 *(public_clientspos++) = *(paddr++);
350 if (fp != NULL) fclose(fp);
351 pc_timestamp = time(NULL);
352 end_critical_section(S_PUBLIC_CLIENTS);
355 syslog(LOG_DEBUG, "Checking whether %s is a local or public client\n",
357 for (i=0; i<num_parms(public_clients); ++i) {
358 extract_token(addrbuf, public_clients, i, '|', sizeof addrbuf);
359 if (!strcasecmp(CC->cs_addr, addrbuf)) {
360 syslog(LOG_DEBUG, "... yes its local.\n");
365 /* No hits. This is not a public client. */
366 syslog(LOG_DEBUG, "... no it isn't.\n");
373 * help_subst() - support routine for help file viewer
375 void help_subst(char *strbuf, char *source, char *dest)
380 while (p = pattern2(strbuf, source), (p >= 0)) {
381 strcpy(workbuf, &strbuf[p + strlen(source)]);
382 strcpy(&strbuf[p], dest);
383 strcat(strbuf, workbuf);
387 void do_help_subst(char *buffer)
391 help_subst(buffer, "^nodename", config.c_nodename);
392 help_subst(buffer, "^humannode", config.c_humannode);
393 help_subst(buffer, "^fqdn", config.c_fqdn);
394 help_subst(buffer, "^username", CC->user.fullname);
395 snprintf(buf2, sizeof buf2, "%ld", CC->user.usernum);
396 help_subst(buffer, "^usernum", buf2);
397 help_subst(buffer, "^sysadm", config.c_sysadm);
398 help_subst(buffer, "^variantname", CITADEL);
399 snprintf(buf2, sizeof buf2, "%d", config.c_maxsessions);
400 help_subst(buffer, "^maxsessions", buf2);
401 help_subst(buffer, "^bbsdir", ctdl_message_dir);
405 typedef const char *ccharp;
407 * display system messages or help
409 void cmd_mesg(char *mname)
419 extract_token(buf, mname, 0, '|', sizeof buf);
421 dirs[0] = strdup(ctdl_message_dir);
422 dirs[1] = strdup(ctdl_hlp_dir);
424 snprintf(buf2, sizeof buf2, "%s.%d.%d",
425 buf, CC->cs_clientdev, CC->cs_clienttyp);
427 /* If the client requested "?" then produce a listing */
428 if (!strcmp(buf, "?")) {
429 cprintf("%d %s\n", LISTING_FOLLOWS, buf);
430 dp = opendir(dirs[1]);
432 while (d = readdir(dp), d != NULL) {
433 if (d->d_name[0] != '.') {
434 cprintf(" %s\n", d->d_name);
445 /* Otherwise, look for the requested file by name. */
447 mesg_locate(targ, sizeof targ, buf2, 2, (const ccharp*)dirs);
448 if (IsEmptyStr(targ)) {
449 snprintf(buf2, sizeof buf2, "%s.%d",
450 buf, CC->cs_clientdev);
451 mesg_locate(targ, sizeof targ, buf2, 2,
452 (const ccharp*)dirs);
453 if (IsEmptyStr(targ)) {
454 mesg_locate(targ, sizeof targ, buf, 2,
455 (const ccharp*)dirs);
463 if (IsEmptyStr(targ)) {
464 cprintf("%d '%s' not found. (Searching in %s and %s)\n",
465 ERROR + FILE_NOT_FOUND,
473 mfp = fopen(targ, "r");
475 cprintf("%d Cannot open '%s': %s\n",
476 ERROR + INTERNAL_ERROR, targ, strerror(errno));
479 cprintf("%d %s\n", LISTING_FOLLOWS,buf);
481 while (fgets(buf, (sizeof buf - 1), mfp) != NULL) {
482 buf[strlen(buf)-1] = 0;
493 * enter system messages or help
495 void cmd_emsg(char *mname)
505 if (CtdlAccessCheck(ac_aide)) return;
507 extract_token(buf, mname, 0, '|', sizeof buf);
508 for (a=0; !IsEmptyStr(&buf[a]); ++a) { /* security measure */
509 if (buf[a] == '/') buf[a] = '.';
512 dirs[0] = strdup(ctdl_message_dir);
513 dirs[1] = strdup(ctdl_hlp_dir);
515 mesg_locate(targ, sizeof targ, buf, 2, (const ccharp*)dirs);
519 if (IsEmptyStr(targ)) {
520 snprintf(targ, sizeof targ,
525 mfp = fopen(targ,"w");
527 cprintf("%d Cannot open '%s': %s\n",
528 ERROR + INTERNAL_ERROR, targ, strerror(errno));
531 cprintf("%d %s\n", SEND_LISTING, targ);
533 while (client_getln(buf, sizeof buf) >=0 && strcmp(buf, "000")) {
534 fprintf(mfp, "%s\n", buf);
541 /* Don't show the names of private rooms unless the viewing
542 * user also knows the rooms.
544 void GenerateRoomDisplay(char *real_room,
546 CitContext *viewer) {
550 strcpy(real_room, viewed->room.QRname);
551 if (viewed->room.QRflags & QR_MAILBOX) {
552 strcpy(real_room, &real_room[11]);
554 if (viewed->room.QRflags & QR_PRIVATE) {
555 CtdlRoomAccess(&viewed->room, &viewer->user, &ra, NULL);
556 if ( (ra & UA_KNOWN) == 0) {
557 strcpy(real_room, " ");
561 if (viewed->cs_flags & CS_CHAT) {
562 while (strlen(real_room) < 14) {
563 strcat(real_room, " ");
565 strcpy(&real_room[14], "<chat>");
571 * Convenience function.
573 int CtdlAccessCheck(int required_level) {
575 if (CC->internal_pgm) return(0);
576 if (required_level >= ac_internal) {
577 cprintf("%d This is not a user-level command.\n",
578 ERROR + HIGHER_ACCESS_REQUIRED);
582 if ((required_level >= ac_logged_in_or_guest) && (CC->logged_in == 0) && (!config.c_guest_logins)) {
583 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
587 if ((required_level >= ac_logged_in) && (CC->logged_in == 0)) {
588 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
592 if (CC->user.axlevel >= AxAideU) return(0);
593 if (required_level >= ac_aide) {
594 cprintf("%d This command requires Admin access.\n",
595 ERROR + HIGHER_ACCESS_REQUIRED);
599 if (is_room_aide()) return(0);
600 if (required_level >= ac_room_aide) {
601 cprintf("%d This command requires Admin or Room Admin access.\n",
602 ERROR + HIGHER_ACCESS_REQUIRED);
606 /* shhh ... succeed quietly */
616 * Shut down the server
618 void cmd_down(char *argbuf) {
619 char *Reply ="%d Shutting down server. Goodbye.\n";
621 if (CtdlAccessCheck(ac_aide)) return;
623 if (!IsEmptyStr(argbuf))
626 restart_server = extract_int(argbuf, 0);
628 if (restart_server > 0)
630 Reply = "%d citserver will now shut down and automatically restart.\n";
632 if ((restart_server > 0) && !running_as_daemon)
634 syslog(LOG_ERR, "The user requested restart, but not running as daemon! Geronimooooooo!\n");
635 Reply = "%d Warning: citserver is not running in daemon mode and is therefore unlikely to restart automatically.\n";
638 cprintf(Reply, state);
642 cprintf(Reply, CIT_OK + SERVER_SHUTTING_DOWN);
644 CC->kill_me = KILLME_SERVER_SHUTTING_DOWN;
645 server_shutting_down = 1;
650 * Halt the server without exiting the server process.
652 void cmd_halt(char *argbuf) {
654 if (CtdlAccessCheck(ac_aide)) return;
656 cprintf("%d Halting server. Goodbye.\n", CIT_OK);
657 server_shutting_down = 1;
658 shutdown_and_halt = 1;
663 * Schedule or cancel a server shutdown
665 void cmd_scdn(char *argbuf)
669 char *Reply = "%d %d\n";
671 if (CtdlAccessCheck(ac_aide)) return;
673 new_state = extract_int(argbuf, 0);
674 if ((new_state == 2) || (new_state == 3))
677 if (!running_as_daemon)
679 syslog(LOG_ERR, "The user requested restart, but not running as deamon! Geronimooooooo!\n");
680 Reply = "%d %d Warning, not running in deamon mode. maybe we will come up again, but don't lean on it.\n";
684 restart_server = extract_int(argbuf, 0);
687 if ((new_state == 0) || (new_state == 1)) {
688 ScheduledShutdown = new_state;
690 cprintf(Reply, state, ScheduledShutdown);
696 * Back-end function for starting a session
698 void begin_session(CitContext *con)
701 * Initialize some variables specific to our context.
704 con->internal_pgm = 0;
705 con->download_fp = NULL;
706 con->upload_fp = NULL;
707 con->cached_msglist = NULL;
708 con->cached_num_msgs = 0;
709 con->FirstExpressMessage = NULL;
711 time(&con->lastidle);
712 strcpy(con->lastcmdname, " ");
713 strcpy(con->cs_clientname, "(unknown)");
714 strcpy(con->curr_user, NLI);
715 *con->net_node = '\0';
716 *con->fake_username = '\0';
717 *con->fake_hostname = '\0';
718 *con->fake_roomname = '\0';
719 *con->cs_clientinfo = '\0';
720 safestrncpy(con->cs_host, config.c_fqdn, sizeof con->cs_host);
721 safestrncpy(con->cs_addr, "", sizeof con->cs_addr);
722 con->cs_UDSclientUID = -1;
723 con->cs_host[sizeof con->cs_host - 1] = 0;
724 if (!CC->is_local_socket) {
725 locate_host(con->cs_host, sizeof con->cs_host,
726 con->cs_addr, sizeof con->cs_addr,
733 #ifdef HAVE_STRUCT_UCRED
735 /* as http://www.wsinnovations.com/softeng/articles/uds.html told us... */
736 struct ucred credentials;
737 socklen_t ucred_length = sizeof(struct ucred);
739 /*fill in the user data structure */
740 if(getsockopt(con->client_socket, SOL_SOCKET, SO_PEERCRED, &credentials, &ucred_length)) {
741 syslog(LOG_NOTICE, "could obtain credentials from unix domain socket");
745 /* the process ID of the process on the other side of the socket */
746 /* credentials.pid; */
748 /* the effective UID of the process on the other side of the socket */
749 con->cs_UDSclientUID = credentials.uid;
751 /* the effective primary GID of the process on the other side of the socket */
752 /* credentials.gid; */
754 /* To get supplemental groups, we will have to look them up in our account
755 database, after a reverse lookup on the UID to get the account name.
756 We can take this opportunity to check to see if this is a legit account.
758 snprintf(con->cs_clientinfo, sizeof(con->cs_clientinfo),
759 "PID: "F_PID_T"; UID: "F_UID_T"; GID: "F_XPID_T" ",
768 con->upload_type = UPL_FILE;
772 if (((config.c_maxsessions > 0)&&(num_sessions > config.c_maxsessions)) || CtdlWantSingleUser()) {
776 if (!CC->is_local_socket) {
777 syslog(LOG_NOTICE, "Session (%s) started from %s (%s).\n", con->ServiceName, con->cs_host, con->cs_addr);
780 syslog(LOG_NOTICE, "Session (%s) started via local socket UID:%d.\n", con->ServiceName, con->cs_UDSclientUID);
783 /* Run any session startup routines registered by loadable modules */
784 PerformSessionHooks(EVT_START);
788 void citproto_begin_session() {
789 if (CC->nologin==1) {
790 cprintf("%d %s: Too many users are already online (maximum is %d)\n",
791 ERROR + MAX_SESSIONS_EXCEEDED,
792 config.c_nodename, config.c_maxsessions
794 CC->kill_me = KILLME_MAX_SESSIONS_EXCEEDED;
797 cprintf("%d %s Citadel server ready.\n", CIT_OK, config.c_nodename);
798 CC->can_receive_im = 1;
803 void citproto_begin_admin_session() {
804 CC->internal_pgm = 1;
805 cprintf("%d %s Citadel server ADMIN CONNECTION ready.\n", CIT_OK, config.c_nodename);
812 * This loop recognizes all server commands.
814 void do_command_loop(void) {
818 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
819 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
820 syslog(LOG_ERR, "Citadel client disconnected: ending session.\n");
821 CC->kill_me = KILLME_CLIENT_DISCONNECTED;
825 /* Log the server command, but don't show passwords... */
826 if ( (strncasecmp(cmdbuf, "PASS", 4)) && (strncasecmp(cmdbuf, "SETP", 4)) ) {
827 syslog(LOG_INFO, "[%d][%s(%ld)] %s",
828 CC->cs_pid, CC->curr_user, CC->user.usernum, cmdbuf
832 syslog(LOG_INFO, "[%d][%s(%ld)] <password command hidden from log>",
833 CC->cs_pid, CC->curr_user, CC->user.usernum
840 * Let other clients see the last command we executed, and
841 * update the idle time, but not NOOP, QNOP, PEXP, GEXP, RWHO, or TIME.
843 if ( (strncasecmp(cmdbuf, "NOOP", 4))
844 && (strncasecmp(cmdbuf, "QNOP", 4))
845 && (strncasecmp(cmdbuf, "PEXP", 4))
846 && (strncasecmp(cmdbuf, "GEXP", 4))
847 && (strncasecmp(cmdbuf, "RWHO", 4))
848 && (strncasecmp(cmdbuf, "TIME", 4)) ) {
849 strcpy(CC->lastcmdname, " ");
850 safestrncpy(CC->lastcmdname, cmdbuf, sizeof(CC->lastcmdname));
854 if ((strncasecmp(cmdbuf, "ENT0", 4))
855 && (strncasecmp(cmdbuf, "MESG", 4))
856 && (strncasecmp(cmdbuf, "MSGS", 4)))
858 CC->cs_flags &= ~CS_POSTING;
861 if (!DLoader_Exec_Cmd(cmdbuf)) {
862 cprintf("%d Unrecognized or unsupported command.\n", ERROR + CMD_NOT_SUPPORTED);
867 /* Run any after-each-command routines registered by modules */
868 PerformSessionHooks(EVT_CMD);
873 * This loop performs all asynchronous functions.
875 void do_async_loop(void) {
876 PerformSessionHooks(EVT_ASYNC);
880 /*****************************************************************************/
881 /* MODULE INITIALIZATION STUFF */
882 /*****************************************************************************/
884 CTDL_MODULE_INIT(citserver)
888 CtdlRegisterProtoHook(cmd_mesg, "MESG", "fetch system banners");
889 CtdlRegisterProtoHook(cmd_emsg, "EMSG", "submit system banners");
891 CtdlRegisterProtoHook(cmd_down, "DOWN", "perform a server shutdown");
892 CtdlRegisterProtoHook(cmd_halt, "HALT", "halt the server without exiting the server process");
893 CtdlRegisterProtoHook(cmd_scdn, "SCDN", "schedule or cancel a server shutdown");
895 /* return our id for the Log */