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 as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 #include <sys/types.h>
30 #if TIME_WITH_SYS_TIME
31 # include <sys/time.h>
35 # include <sys/time.h>
51 #include <sys/types.h>
52 #include <sys/socket.h>
53 #include <netinet/in.h>
54 #include <arpa/inet.h>
55 #include <libcitadel.h>
58 #include "sysdep_decls.h"
60 #include "citserver.h"
63 #include "housekeeping.h"
67 #include "locate_host.h"
71 #include "euidindex.h"
73 #include "svn_revision.h"
79 #include "ctdl_module.h"
81 char *unique_session_numbers;
82 int ScheduledShutdown = 0;
83 time_t server_startup_time;
85 int openid_level_supported = 0;
88 * print the actual stack frame.
90 void cit_backtrace(void)
93 void *stack_frames[50];
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]);
110 void cit_oneline_backtrace(void)
112 #ifdef HAVE_BACKTRACE
113 void *stack_frames[50];
118 size = backtrace(stack_frames, sizeof(stack_frames) / sizeof(void*));
119 strings = backtrace_symbols(stack_frames, size);
123 for (i = 1; i < size; i++) {
125 StrBufAppendPrintf(Buf, "%s : ", strings[i]);
127 StrBufAppendPrintf(Buf, "%p : ", stack_frames[i]);
130 syslog(LOG_ALERT, "%s\n", ChrPtr(Buf));
137 * print the actual stack frame.
139 void cit_panic_backtrace(int SigNum)
141 #ifdef HAVE_BACKTRACE
142 void *stack_frames[10];
146 printf("caught signal 11\n");
147 size = backtrace(stack_frames, sizeof(stack_frames) / sizeof(void*));
148 strings = backtrace_symbols(stack_frames, size);
149 for (i = 0; i < size; i++) {
151 syslog(LOG_ALERT, "%s\n", strings[i]);
153 syslog(LOG_ALERT, "%p\n", stack_frames[i]);
161 * Various things that need to be initialized at startup
163 void master_startup(void) {
167 struct ctdlroom qrbuf;
170 syslog(LOG_DEBUG, "master_startup() started\n");
171 time(&server_startup_time);
173 syslog(LOG_INFO, "Opening databases\n");
176 ctdl_thread_internal_init_tsd();
178 CtdlThreadAllocTSD();
182 syslog(LOG_INFO, "Creating base rooms (if necessary)\n");
183 CtdlCreateRoom(config.c_baseroom, 0, "", 0, 1, 0, VIEW_BBS);
184 CtdlCreateRoom(AIDEROOM, 3, "", 0, 1, 0, VIEW_BBS);
185 CtdlCreateRoom(SYSCONFIGROOM, 3, "", 0, 1, 0, VIEW_BBS);
186 CtdlCreateRoom(config.c_twitroom, 0, "", 0, 1, 0, VIEW_BBS);
188 /* The "Local System Configuration" room doesn't need to be visible */
189 if (CtdlGetRoomLock(&qrbuf, SYSCONFIGROOM) == 0) {
190 qrbuf.QRflags2 |= QR2_SYSTEM;
191 CtdlPutRoomLock(&qrbuf);
194 /* Aide needs to be public postable, else we're not RFC conformant. */
195 if (CtdlGetRoomLock(&qrbuf, AIDEROOM) == 0) {
196 qrbuf.QRflags2 |= QR2_SMTP_PUBLIC;
197 CtdlPutRoomLock(&qrbuf);
200 syslog(LOG_INFO, "Seeding the pseudo-random number generator...\n");
201 urandom = fopen("/dev/urandom", "r");
202 if (urandom != NULL) {
203 rv = fread(&seed, sizeof seed, 1, urandom);
207 gettimeofday(&tv, NULL);
213 syslog(LOG_INFO, "Initializing ipgm secret\n");
215 config.c_ipgm_secret = rand();
218 syslog(LOG_DEBUG, "master_startup() finished\n");
223 * Cleanup routine to be called when the server is shutting down.
225 void master_cleanup(int exitcode) {
226 struct CleanupFunctionHook *fcn;
227 static int already_cleaning_up = 0;
229 if (already_cleaning_up) while(1) sleep(1);
230 already_cleaning_up = 1;
232 /* Run any cleanup routines registered by loadable modules */
233 for (fcn = CleanupHookTable; fcn != NULL; fcn = fcn->next) {
234 (*fcn->h_function_pointer)();
237 /* Close the AdjRefCount queue file */
240 /* Do system-dependent stuff */
241 sysdep_master_cleanup();
243 /* Close databases */
244 syslog(LOG_INFO, "Closing databases\n");
247 #ifdef DEBUG_MEMORY_LEAKS
251 /* If the operator requested a halt but not an exit, halt here. */
252 if (shutdown_and_halt) {
253 syslog(LOG_NOTICE, "citserver: Halting server without exiting.\n");
254 fflush(stdout); fflush(stderr);
263 syslog(LOG_NOTICE, "citserver: Exiting with status %d\n", exitcode);
264 fflush(stdout); fflush(stderr);
266 if (restart_server != 0)
268 if ((running_as_daemon != 0) && ((exitcode == 0) ))
269 exitcode = CTDLEXIT_SHUTDOWN;
276 * cmd_info() - tell the client about this server
278 void cmd_info(char *cmdbuf) {
279 cprintf("%d Server info:\n", LISTING_FOLLOWS);
280 cprintf("%d\n", CC->cs_pid);
281 cprintf("%s\n", config.c_nodename);
282 cprintf("%s\n", config.c_humannode);
283 cprintf("%s\n", config.c_fqdn);
284 cprintf("%s\n", CITADEL);
285 cprintf("%d\n", REV_LEVEL);
286 cprintf("%s\n", config.c_site_location);
287 cprintf("%s\n", config.c_sysadm);
288 cprintf("%d\n", SERVER_TYPE);
289 cprintf("%s\n", config.c_moreprompt);
290 cprintf("1\n"); /* 1 = yes, this system supports floors */
291 cprintf("1\n"); /* 1 = we support the extended paging options */
292 cprintf("\n"); /* nonce no longer supported */
293 cprintf("1\n"); /* 1 = yes, this system supports the QNOP command */
296 cprintf("1\n"); /* 1 = yes, this server is LDAP-enabled */
298 cprintf("0\n"); /* 1 = no, this server is not LDAP-enabled */
301 if (config.c_auth_mode == AUTHMODE_NATIVE) {
302 cprintf("%d\n", config.c_disable_newu);
305 cprintf("1\n"); /* "create new user" does not work with non-native auth modes */
308 cprintf("%s\n", config.c_default_cal_zone);
310 /* Output load averages */
311 cprintf("%f\n", CtdlThreadLoadAvg);
312 cprintf("%f\n", CtdlThreadWorkerAvg);
313 cprintf("%d\n", CtdlThreadGetCount());
315 cprintf("1\n"); /* yes, Sieve mail filtering is supported */
316 cprintf("%d\n", config.c_enable_fulltext);
317 cprintf("%s\n", svn_revision());
319 if (config.c_auth_mode == AUTHMODE_NATIVE) {
320 cprintf("%d\n", openid_level_supported); /* OpenID is enabled when using native auth */
323 cprintf("0\n"); /* OpenID is disabled when using non-native auth */
326 cprintf("%d\n", config.c_guest_logins);
333 * returns an asterisk if there are any instant messages waiting,
336 char CtdlCheckExpress(void) {
337 if (CC->FirstExpressMessage == NULL) {
345 void cmd_time(char *argbuf)
351 localtime_r(&tv, &tmp);
353 /* timezone and daylight global variables are not portable. */
354 #ifdef HAVE_STRUCT_TM_TM_GMTOFF
355 cprintf("%d %ld|%ld|%d\n", CIT_OK, (long)tv, tmp.tm_gmtoff, tmp.tm_isdst);
357 cprintf("%d %ld|%ld|%d\n", CIT_OK, (long)tv, timezone, tmp.tm_isdst);
363 * Check originating host against the public_clients file. This determines
364 * whether the client is allowed to change the hostname for this session
365 * (for example, to show the location of the user rather than the location
368 int is_public_client(void)
374 char *public_clientspos;
375 char *public_clientsend;
378 static time_t pc_timestamp = 0;
379 static char public_clients[SIZ];
380 static char public_clients_file[SIZ];
382 #define LOCALHOSTSTR "127.0.0.1"
384 snprintf(public_clients_file, sizeof public_clients_file, "%s/public_clients", ctdl_etc_dir);
387 * Check the time stamp on the public_clients file. If it's been
388 * updated since the last time we were here (or if this is the first
389 * time we've been through the loop), read its contents and learn
390 * the IP addresses of the listed hosts.
392 if (stat(public_clients_file, &statbuf) != 0) {
393 /* No public_clients file exists, so bail out */
394 syslog(LOG_WARNING, "Warning: '%s' does not exist\n",
395 public_clients_file);
399 if (statbuf.st_mtime > pc_timestamp) {
400 begin_critical_section(S_PUBLIC_CLIENTS);
401 syslog(LOG_INFO, "Loading %s\n", public_clients_file);
403 public_clientspos = &public_clients[0];
404 public_clientsend = public_clientspos + SIZ;
405 safestrncpy(public_clientspos, LOCALHOSTSTR, sizeof public_clients);
406 public_clientspos += sizeof(LOCALHOSTSTR) - 1;
408 if (hostname_to_dotted_quad(addrbuf, config.c_fqdn) == 0) {
409 *(public_clientspos++) = '|';
411 while (!IsEmptyStr (paddr) &&
412 (public_clientspos < public_clientsend))
413 *(public_clientspos++) = *(paddr++);
416 fp = fopen(public_clients_file, "r");
418 while ((fgets(buf, sizeof buf, fp)!=NULL) &&
419 (public_clientspos < public_clientsend)){
422 while (!IsEmptyStr(ptr)) {
430 while (ptr>buf && isspace(*ptr)) {
433 if (hostname_to_dotted_quad(addrbuf, buf) == 0) {
434 *(public_clientspos++) = '|';
436 while (!IsEmptyStr(paddr) &&
437 (public_clientspos < public_clientsend)){
438 *(public_clientspos++) = *(paddr++);
443 pc_timestamp = time(NULL);
444 end_critical_section(S_PUBLIC_CLIENTS);
447 syslog(LOG_DEBUG, "Checking whether %s is a local or public client\n",
449 for (i=0; i<num_parms(public_clients); ++i) {
450 extract_token(addrbuf, public_clients, i, '|', sizeof addrbuf);
451 if (!strcasecmp(CC->cs_addr, addrbuf)) {
452 syslog(LOG_DEBUG, "... yes it is.\n");
457 /* No hits. This is not a public client. */
458 syslog(LOG_DEBUG, "... no it isn't.\n");
464 * the client is identifying itself to the server
466 void cmd_iden(char *argbuf)
474 if (num_parms(argbuf)<4) {
475 cprintf("%d usage error\n", ERROR + ILLEGAL_VALUE);
479 dev_code = extract_int(argbuf,0);
480 cli_code = extract_int(argbuf,1);
481 rev_level = extract_int(argbuf,2);
482 extract_token(desc, argbuf, 3, '|', sizeof desc);
484 safestrncpy(from_host, config.c_fqdn, sizeof from_host);
485 from_host[sizeof from_host - 1] = 0;
486 if (num_parms(argbuf)>=5) extract_token(from_host, argbuf, 4, '|', sizeof from_host);
488 CC->cs_clientdev = dev_code;
489 CC->cs_clienttyp = cli_code;
490 CC->cs_clientver = rev_level;
491 safestrncpy(CC->cs_clientname, desc, sizeof CC->cs_clientname);
492 CC->cs_clientname[31] = 0;
494 /* For local sockets and public clients, trust the hostname supplied by the client */
495 if ( (CC->is_local_socket) || (is_public_client()) ) {
496 safestrncpy(CC->cs_host, from_host, sizeof CC->cs_host);
497 CC->cs_host[sizeof CC->cs_host - 1] = 0;
501 syslog(LOG_NOTICE, "Client %d/%d/%01d.%02d (%s) from %s\n",
509 cprintf("%d Ok\n",CIT_OK);
512 typedef const char *ccharp;
514 * display system messages or help
516 void cmd_mesg(char *mname)
526 extract_token(buf, mname, 0, '|', sizeof buf);
528 dirs[0] = strdup(ctdl_message_dir);
529 dirs[1] = strdup(ctdl_hlp_dir);
531 snprintf(buf2, sizeof buf2, "%s.%d.%d",
532 buf, CC->cs_clientdev, CC->cs_clienttyp);
534 /* If the client requested "?" then produce a listing */
535 if (!strcmp(buf, "?")) {
536 cprintf("%d %s\n", LISTING_FOLLOWS, buf);
537 dp = opendir(dirs[1]);
539 while (d = readdir(dp), d != NULL) {
540 if (d->d_name[0] != '.') {
541 cprintf(" %s\n", d->d_name);
552 /* Otherwise, look for the requested file by name. */
554 mesg_locate(targ, sizeof targ, buf2, 2, (const ccharp*)dirs);
555 if (IsEmptyStr(targ)) {
556 snprintf(buf2, sizeof buf2, "%s.%d",
557 buf, CC->cs_clientdev);
558 mesg_locate(targ, sizeof targ, buf2, 2,
559 (const ccharp*)dirs);
560 if (IsEmptyStr(targ)) {
561 mesg_locate(targ, sizeof targ, buf, 2,
562 (const ccharp*)dirs);
570 if (IsEmptyStr(targ)) {
571 cprintf("%d '%s' not found. (Searching in %s and %s)\n",
572 ERROR + FILE_NOT_FOUND,
580 mfp = fopen(targ, "r");
582 cprintf("%d Cannot open '%s': %s\n",
583 ERROR + INTERNAL_ERROR, targ, strerror(errno));
586 cprintf("%d %s\n", LISTING_FOLLOWS,buf);
588 while (fgets(buf, (sizeof buf - 1), mfp) != NULL) {
589 buf[strlen(buf)-1] = 0;
600 * enter system messages or help
602 void cmd_emsg(char *mname)
612 if (CtdlAccessCheck(ac_aide)) return;
614 extract_token(buf, mname, 0, '|', sizeof buf);
615 for (a=0; !IsEmptyStr(&buf[a]); ++a) { /* security measure */
616 if (buf[a] == '/') buf[a] = '.';
619 dirs[0] = strdup(ctdl_message_dir);
620 dirs[1] = strdup(ctdl_hlp_dir);
622 mesg_locate(targ, sizeof targ, buf, 2, (const ccharp*)dirs);
626 if (IsEmptyStr(targ)) {
627 snprintf(targ, sizeof targ,
632 mfp = fopen(targ,"w");
634 cprintf("%d Cannot open '%s': %s\n",
635 ERROR + INTERNAL_ERROR, targ, strerror(errno));
638 cprintf("%d %s\n", SEND_LISTING, targ);
640 while (client_getln(buf, sizeof buf) >=0 && strcmp(buf, "000")) {
641 fprintf(mfp, "%s\n", buf);
648 /* Don't show the names of private rooms unless the viewing
649 * user also knows the rooms.
651 void GenerateRoomDisplay(char *real_room,
653 CitContext *viewer) {
657 strcpy(real_room, viewed->room.QRname);
658 if (viewed->room.QRflags & QR_MAILBOX) {
659 strcpy(real_room, &real_room[11]);
661 if (viewed->room.QRflags & QR_PRIVATE) {
662 CtdlRoomAccess(&viewed->room, &viewer->user, &ra, NULL);
663 if ( (ra & UA_KNOWN) == 0) {
664 strcpy(real_room, "<private room>");
668 if (viewed->cs_flags & CS_CHAT) {
669 while (strlen(real_room) < 14) {
670 strcat(real_room, " ");
672 strcpy(&real_room[14], "<chat>");
678 * Convenience function.
680 int CtdlAccessCheck(int required_level) {
682 if (CC->internal_pgm) return(0);
683 if (required_level >= ac_internal) {
684 cprintf("%d This is not a user-level command.\n",
685 ERROR + HIGHER_ACCESS_REQUIRED);
689 if ((required_level >= ac_logged_in_or_guest) && (CC->logged_in == 0) && (!config.c_guest_logins)) {
690 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
694 if ((required_level >= ac_logged_in) && (CC->logged_in == 0)) {
695 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
699 if (CC->user.axlevel >= AxAideU) return(0);
700 if (required_level >= ac_aide) {
701 cprintf("%d This command requires Aide access.\n",
702 ERROR + HIGHER_ACCESS_REQUIRED);
706 if (is_room_aide()) return(0);
707 if (required_level >= ac_room_aide) {
708 cprintf("%d This command requires Aide or Room Aide access.\n",
709 ERROR + HIGHER_ACCESS_REQUIRED);
713 /* shhh ... succeed quietly */
720 * Terminate another running session
722 void cmd_term(char *cmdbuf)
727 session_num = extract_int(cmdbuf, 0);
729 terminated = CtdlTerminateOtherSession(session_num);
731 if (terminated < 0) {
732 cprintf("%d You can't kill your own session.\n", ERROR + ILLEGAL_VALUE);
736 if (terminated & TERM_FOUND) {
737 if (terminated == TERM_KILLED) {
738 cprintf("%d Session terminated.\n", CIT_OK);
741 cprintf("%d You are not allowed to do that.\n",
742 ERROR + HIGHER_ACCESS_REQUIRED);
746 cprintf("%d No such session.\n", ERROR + ILLEGAL_VALUE);
752 * get the paginator prompt
754 void cmd_more(char *argbuf) {
755 cprintf("%d %s\n", CIT_OK, config.c_moreprompt);
762 void cmd_echo(char *etext)
764 cprintf("%d %s\n", CIT_OK, etext);
769 * Perform privilege escalation for an internal program
771 void cmd_ipgm(char *argbuf)
775 secret = extract_int(argbuf, 0);
777 /* For security reasons, we do NOT allow this command to run
778 * over the network. Local sockets only.
780 if (!CC->is_local_socket) {
782 cprintf("%d Authentication failed.\n", ERROR + PASSWORD_REQUIRED);
784 else if (secret == config.c_ipgm_secret) {
785 CC->internal_pgm = 1;
786 strcpy(CC->curr_user, "<internal program>");
787 CC->cs_flags = CC->cs_flags|CS_STEALTH;
788 cprintf("%d Authenticated as an internal program.\n", CIT_OK);
792 cprintf("%d Authentication failed.\n", ERROR + PASSWORD_REQUIRED);
793 syslog(LOG_ERR, "Warning: ipgm authentication failed.\n");
800 * Shut down the server
802 void cmd_down(char *argbuf) {
803 char *Reply ="%d Shutting down server. Goodbye.\n";
805 if (CtdlAccessCheck(ac_aide)) return;
807 if (!IsEmptyStr(argbuf))
810 restart_server = extract_int(argbuf, 0);
812 if (restart_server > 0)
814 Reply = "%d citserver will now shut down and automatically restart.\n";
816 if ((restart_server > 0) && !running_as_daemon)
818 syslog(LOG_ERR, "The user requested restart, but not running as daemon! Geronimooooooo!\n");
819 Reply = "%d Warning: citserver is not running in daemon mode and is therefore unlikely to restart automatically.\n";
822 cprintf(Reply, state);
826 cprintf(Reply, CIT_OK + SERVER_SHUTTING_DOWN);
828 CC->kill_me = 1; /* Even the DOWN command has to follow correct proceedure when disconecting */
834 * Halt the server without exiting the server process.
836 void cmd_halt(char *argbuf) {
838 if (CtdlAccessCheck(ac_aide)) return;
840 cprintf("%d Halting server. Goodbye.\n", CIT_OK);
842 shutdown_and_halt = 1;
847 * Schedule or cancel a server shutdown
849 void cmd_scdn(char *argbuf)
853 char *Reply = "%d %d\n";
855 if (CtdlAccessCheck(ac_aide)) return;
857 new_state = extract_int(argbuf, 0);
858 if ((new_state == 2) || (new_state == 3))
861 if (!running_as_daemon)
863 syslog(LOG_ERR, "The user requested restart, but not running as deamon! Geronimooooooo!\n");
864 Reply = "%d %d Warning, not running in deamon mode. maybe we will come up again, but don't lean on it.\n";
868 restart_server = extract_int(argbuf, 0);
871 if ((new_state == 0) || (new_state == 1)) {
872 ScheduledShutdown = new_state;
874 cprintf(Reply, state, ScheduledShutdown);
879 * Set or unset asynchronous protocol mode
881 void cmd_asyn(char *argbuf)
885 new_state = extract_int(argbuf, 0);
886 if ((new_state == 0) || (new_state == 1)) {
887 CC->is_async = new_state;
889 cprintf("%d %d\n", CIT_OK, CC->is_async);
895 * Back-end function for starting a session
897 void begin_session(CitContext *con)
900 struct sockaddr_in sin;
903 * Initialize some variables specific to our context.
906 con->internal_pgm = 0;
907 con->download_fp = NULL;
908 con->upload_fp = NULL;
909 con->cached_msglist = NULL;
910 con->FirstExpressMessage = NULL;
912 time(&con->lastidle);
913 strcpy(con->lastcmdname, " ");
914 strcpy(con->cs_clientname, "(unknown)");
915 strcpy(con->curr_user, NLI);
916 *con->net_node = '\0';
917 *con->fake_username = '\0';
918 *con->fake_hostname = '\0';
919 *con->fake_roomname = '\0';
920 *con->cs_clientinfo = '\0';
921 safestrncpy(con->cs_host, config.c_fqdn, sizeof con->cs_host);
922 safestrncpy(con->cs_addr, "", sizeof con->cs_addr);
923 con->cs_UDSclientUID = -1;
924 con->cs_host[sizeof con->cs_host - 1] = 0;
926 if (!CC->is_local_socket) {
927 locate_host(con->cs_host, sizeof con->cs_host,
928 con->cs_addr, sizeof con->cs_addr,
935 #ifdef HAVE_STRUCT_UCRED
937 /* as http://www.wsinnovations.com/softeng/articles/uds.html told us... */
938 struct ucred credentials;
939 socklen_t ucred_length = sizeof(struct ucred);
941 /*fill in the user data structure */
942 if(getsockopt(con->client_socket, SOL_SOCKET, SO_PEERCRED, &credentials, &ucred_length)) {
943 syslog(LOG_NOTICE, "could obtain credentials from unix domain socket");
947 /* the process ID of the process on the other side of the socket */
948 /* credentials.pid; */
950 /* the effective UID of the process on the other side of the socket */
951 con->cs_UDSclientUID = credentials.uid;
953 /* the effective primary GID of the process on the other side of the socket */
954 /* credentials.gid; */
956 /* To get supplemental groups, we will have to look them up in our account
957 database, after a reverse lookup on the UID to get the account name.
958 We can take this opportunity to check to see if this is a legit account.
960 snprintf(con->cs_clientinfo, sizeof(con->cs_clientinfo),
961 "PID: "F_PID_T"; UID: "F_UID_T"; GID: "F_XPID_T" ",
970 con->upload_type = UPL_FILE;
974 if (((config.c_maxsessions > 0)&&(num_sessions > config.c_maxsessions)) || CtdlWantSingleUser()) {
978 if (!CC->is_local_socket) {
979 syslog(LOG_NOTICE, "Session (%s) started from %s (%s).\n", con->ServiceName, con->cs_host, con->cs_addr);
982 syslog(LOG_NOTICE, "Session (%s) started via local socket UID:%d.\n", con->ServiceName, con->cs_UDSclientUID);
985 /* Run any session startup routines registered by loadable modules */
986 PerformSessionHooks(EVT_START);
990 void citproto_begin_session() {
991 if (CC->nologin==1) {
992 cprintf("%d %s: Too many users are already online (maximum is %d)\n",
993 ERROR + MAX_SESSIONS_EXCEEDED,
994 config.c_nodename, config.c_maxsessions
999 cprintf("%d %s Citadel server ready.\n", CIT_OK, config.c_nodename);
1000 CC->can_receive_im = 1;
1005 void cmd_noop(char *argbuf)
1007 cprintf("%d%cok\n", CIT_OK, CtdlCheckExpress() );
1011 void cmd_qnop(char *argbuf)
1013 /* do nothing, this command returns no response */
1017 void cmd_quit(char *argbuf)
1019 cprintf("%d Goodbye.\n", CIT_OK);
1024 void cmd_lout(char *argbuf)
1028 cprintf("%d logged out.\n", CIT_OK);
1033 * This loop recognizes all server commands.
1035 void do_command_loop(void) {
1037 const char *old_name = NULL;
1039 old_name = CtdlThreadName("do_command_loop");
1042 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
1043 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
1044 syslog(LOG_ERR, "Client disconnected: ending session.\n");
1046 CtdlThreadName(old_name);
1050 /* Log the server command, but don't show passwords... */
1051 if ( (strncasecmp(cmdbuf, "PASS", 4)) && (strncasecmp(cmdbuf, "SETP", 4)) ) {
1052 syslog(LOG_INFO, "CtdlCommand [%s] [%s] %s\n", CTDLUSERIP, CC->curr_user, cmdbuf);
1055 syslog(LOG_INFO, "CtdlCommand [%s] [%s] <password command hidden from log>\n", CTDLUSERIP, CC->curr_user);
1061 * Let other clients see the last command we executed, and
1062 * update the idle time, but not NOOP, QNOP, PEXP, GEXP, RWHO, or TIME.
1064 if ( (strncasecmp(cmdbuf, "NOOP", 4))
1065 && (strncasecmp(cmdbuf, "QNOP", 4))
1066 && (strncasecmp(cmdbuf, "PEXP", 4))
1067 && (strncasecmp(cmdbuf, "GEXP", 4))
1068 && (strncasecmp(cmdbuf, "RWHO", 4))
1069 && (strncasecmp(cmdbuf, "TIME", 4)) ) {
1070 strcpy(CC->lastcmdname, " ");
1071 safestrncpy(CC->lastcmdname, cmdbuf, sizeof(CC->lastcmdname));
1072 time(&CC->lastidle);
1075 CtdlThreadName(cmdbuf);
1077 if ((strncasecmp(cmdbuf, "ENT0", 4))
1078 && (strncasecmp(cmdbuf, "MESG", 4))
1079 && (strncasecmp(cmdbuf, "MSGS", 4)))
1081 CC->cs_flags &= ~CS_POSTING;
1084 if (!DLoader_Exec_Cmd(cmdbuf)) {
1085 cprintf("%d Unrecognized or unsupported command.\n", ERROR + CMD_NOT_SUPPORTED);
1090 /* Run any after-each-command routines registered by modules */
1091 PerformSessionHooks(EVT_CMD);
1092 CtdlThreadName(old_name);
1097 * This loop performs all asynchronous functions.
1099 void do_async_loop(void) {
1100 PerformSessionHooks(EVT_ASYNC);
1104 /*****************************************************************************/
1105 /* MODULE INITIALIZATION STUFF */
1106 /*****************************************************************************/
1108 CTDL_MODULE_INIT(citserver)
1111 CtdlRegisterProtoHook(cmd_noop, "NOOP", "no operation");
1112 CtdlRegisterProtoHook(cmd_qnop, "QNOP", "no operation with no response");
1113 CtdlRegisterProtoHook(cmd_quit, "QUIT", "log out and disconnect from server");
1114 CtdlRegisterProtoHook(cmd_lout, "LOUT", "log out but do not disconnect from server");
1115 CtdlRegisterProtoHook(cmd_asyn, "ASYN", "enable asynchronous server responses");
1116 CtdlRegisterProtoHook(cmd_info, "INFO", "fetch server capabilities and configuration");
1117 CtdlRegisterProtoHook(cmd_mesg, "MESG", "fetch system banners");
1118 CtdlRegisterProtoHook(cmd_emsg, "EMSG", "submit system banners");
1119 CtdlRegisterProtoHook(cmd_echo, "ECHO", "echo text back to the client");
1120 CtdlRegisterProtoHook(cmd_more, "MORE", "fetch the paginator prompt");
1121 CtdlRegisterProtoHook(cmd_iden, "IDEN", "identify the client software and location");
1122 CtdlRegisterProtoHook(cmd_ipgm, "IPGM", "perform privilege escalation for internal programs");
1123 CtdlRegisterProtoHook(cmd_term, "TERM", "terminate another running session");
1124 CtdlRegisterProtoHook(cmd_down, "DOWN", "perform a server shutdown");
1125 CtdlRegisterProtoHook(cmd_halt, "HALT", "halt the server without exiting the server process");
1126 CtdlRegisterProtoHook(cmd_scdn, "SCDN", "schedule or cancel a server shutdown");
1127 CtdlRegisterProtoHook(cmd_time, "TIME", "fetch the date and time from the server");
1129 /* return our id for the Log */