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]);
111 * print the actual stack frame.
113 void cit_panic_backtrace(int SigNum)
115 #ifdef HAVE_BACKTRACE
116 void *stack_frames[10];
120 printf("caught signal 11\n");
121 size = backtrace(stack_frames, sizeof(stack_frames) / sizeof(void*));
122 strings = backtrace_symbols(stack_frames, size);
123 for (i = 0; i < size; i++) {
125 syslog(LOG_ALERT, "%s\n", strings[i]);
127 syslog(LOG_ALERT, "%p\n", stack_frames[i]);
135 * Various things that need to be initialized at startup
137 void master_startup(void) {
141 struct ctdlroom qrbuf;
144 syslog(LOG_DEBUG, "master_startup() started\n");
145 time(&server_startup_time);
147 syslog(LOG_INFO, "Opening databases\n");
150 ctdl_thread_internal_init_tsd();
152 CtdlThreadAllocTSD();
156 syslog(LOG_INFO, "Creating base rooms (if necessary)\n");
157 CtdlCreateRoom(config.c_baseroom, 0, "", 0, 1, 0, VIEW_BBS);
158 CtdlCreateRoom(AIDEROOM, 3, "", 0, 1, 0, VIEW_BBS);
159 CtdlCreateRoom(SYSCONFIGROOM, 3, "", 0, 1, 0, VIEW_BBS);
160 CtdlCreateRoom(config.c_twitroom, 0, "", 0, 1, 0, VIEW_BBS);
162 /* The "Local System Configuration" room doesn't need to be visible */
163 if (CtdlGetRoomLock(&qrbuf, SYSCONFIGROOM) == 0) {
164 qrbuf.QRflags2 |= QR2_SYSTEM;
165 CtdlPutRoomLock(&qrbuf);
168 /* Aide needs to be public postable, else we're not RFC conformant. */
169 if (CtdlGetRoomLock(&qrbuf, AIDEROOM) == 0) {
170 qrbuf.QRflags2 |= QR2_SMTP_PUBLIC;
171 CtdlPutRoomLock(&qrbuf);
174 syslog(LOG_INFO, "Seeding the pseudo-random number generator...\n");
175 urandom = fopen("/dev/urandom", "r");
176 if (urandom != NULL) {
177 rv = fread(&seed, sizeof seed, 1, urandom);
181 gettimeofday(&tv, NULL);
187 syslog(LOG_INFO, "Initializing ipgm secret\n");
189 config.c_ipgm_secret = rand();
192 syslog(LOG_DEBUG, "master_startup() finished\n");
197 * Cleanup routine to be called when the server is shutting down.
199 void master_cleanup(int exitcode) {
200 struct CleanupFunctionHook *fcn;
201 static int already_cleaning_up = 0;
203 if (already_cleaning_up) while(1) sleep(1);
204 already_cleaning_up = 1;
206 /* Run any cleanup routines registered by loadable modules */
207 for (fcn = CleanupHookTable; fcn != NULL; fcn = fcn->next) {
208 (*fcn->h_function_pointer)();
211 /* Close the AdjRefCount queue file */
214 /* Do system-dependent stuff */
215 sysdep_master_cleanup();
217 /* Close databases */
218 syslog(LOG_INFO, "Closing databases\n");
221 #ifdef DEBUG_MEMORY_LEAKS
225 /* If the operator requested a halt but not an exit, halt here. */
226 if (shutdown_and_halt) {
227 syslog(LOG_NOTICE, "citserver: Halting server without exiting.\n");
228 fflush(stdout); fflush(stderr);
237 syslog(LOG_NOTICE, "citserver: Exiting with status %d\n", exitcode);
238 fflush(stdout); fflush(stderr);
240 if (restart_server != 0)
242 if ((running_as_daemon != 0) && ((exitcode == 0) ))
243 exitcode = CTDLEXIT_SHUTDOWN;
250 * cmd_info() - tell the client about this server
252 void cmd_info(char *cmdbuf) {
253 cprintf("%d Server info:\n", LISTING_FOLLOWS);
254 cprintf("%d\n", CC->cs_pid);
255 cprintf("%s\n", config.c_nodename);
256 cprintf("%s\n", config.c_humannode);
257 cprintf("%s\n", config.c_fqdn);
258 cprintf("%s\n", CITADEL);
259 cprintf("%d\n", REV_LEVEL);
260 cprintf("%s\n", config.c_site_location);
261 cprintf("%s\n", config.c_sysadm);
262 cprintf("%d\n", SERVER_TYPE);
263 cprintf("%s\n", config.c_moreprompt);
264 cprintf("1\n"); /* 1 = yes, this system supports floors */
265 cprintf("1\n"); /* 1 = we support the extended paging options */
266 cprintf("\n"); /* nonce no longer supported */
267 cprintf("1\n"); /* 1 = yes, this system supports the QNOP command */
270 cprintf("1\n"); /* 1 = yes, this server is LDAP-enabled */
272 cprintf("0\n"); /* 1 = no, this server is not LDAP-enabled */
275 if (config.c_auth_mode == AUTHMODE_NATIVE) {
276 cprintf("%d\n", config.c_disable_newu);
279 cprintf("1\n"); /* "create new user" does not work with non-native auth modes */
282 cprintf("%s\n", config.c_default_cal_zone);
284 /* Output load averages */
285 cprintf("%f\n", CtdlThreadLoadAvg);
286 cprintf("%f\n", CtdlThreadWorkerAvg);
287 cprintf("%d\n", CtdlThreadGetCount());
289 cprintf("1\n"); /* yes, Sieve mail filtering is supported */
290 cprintf("%d\n", config.c_enable_fulltext);
291 cprintf("%s\n", svn_revision());
293 if (config.c_auth_mode == AUTHMODE_NATIVE) {
294 cprintf("%d\n", openid_level_supported); /* OpenID is enabled when using native auth */
297 cprintf("0\n"); /* OpenID is disabled when using non-native auth */
300 cprintf("%d\n", config.c_guest_logins);
307 * returns an asterisk if there are any instant messages waiting,
310 char CtdlCheckExpress(void) {
311 if (CC->FirstExpressMessage == NULL) {
319 void cmd_time(char *argbuf)
325 localtime_r(&tv, &tmp);
327 /* timezone and daylight global variables are not portable. */
328 #ifdef HAVE_STRUCT_TM_TM_GMTOFF
329 cprintf("%d %ld|%ld|%d\n", CIT_OK, (long)tv, tmp.tm_gmtoff, tmp.tm_isdst);
331 cprintf("%d %ld|%ld|%d\n", CIT_OK, (long)tv, timezone, tmp.tm_isdst);
337 * Check originating host against the public_clients file. This determines
338 * whether the client is allowed to change the hostname for this session
339 * (for example, to show the location of the user rather than the location
342 int is_public_client(void)
348 char *public_clientspos;
349 char *public_clientsend;
352 static time_t pc_timestamp = 0;
353 static char public_clients[SIZ];
354 static char public_clients_file[SIZ];
356 #define LOCALHOSTSTR "127.0.0.1"
358 snprintf(public_clients_file, sizeof public_clients_file, "%s/public_clients", ctdl_etc_dir);
361 * Check the time stamp on the public_clients file. If it's been
362 * updated since the last time we were here (or if this is the first
363 * time we've been through the loop), read its contents and learn
364 * the IP addresses of the listed hosts.
366 if (stat(public_clients_file, &statbuf) != 0) {
367 /* No public_clients file exists, so bail out */
368 syslog(LOG_WARNING, "Warning: '%s' does not exist\n",
369 public_clients_file);
373 if (statbuf.st_mtime > pc_timestamp) {
374 begin_critical_section(S_PUBLIC_CLIENTS);
375 syslog(LOG_INFO, "Loading %s\n", public_clients_file);
377 public_clientspos = &public_clients[0];
378 public_clientsend = public_clientspos + SIZ;
379 safestrncpy(public_clientspos, LOCALHOSTSTR, sizeof public_clients);
380 public_clientspos += sizeof(LOCALHOSTSTR) - 1;
382 if (hostname_to_dotted_quad(addrbuf, config.c_fqdn) == 0) {
383 *(public_clientspos++) = '|';
385 while (!IsEmptyStr (paddr) &&
386 (public_clientspos < public_clientsend))
387 *(public_clientspos++) = *(paddr++);
390 fp = fopen(public_clients_file, "r");
392 while ((fgets(buf, sizeof buf, fp)!=NULL) &&
393 (public_clientspos < public_clientsend)){
396 while (!IsEmptyStr(ptr)) {
404 while (ptr>buf && isspace(*ptr)) {
407 if (hostname_to_dotted_quad(addrbuf, buf) == 0) {
408 *(public_clientspos++) = '|';
410 while (!IsEmptyStr(paddr) &&
411 (public_clientspos < public_clientsend)){
412 *(public_clientspos++) = *(paddr++);
417 pc_timestamp = time(NULL);
418 end_critical_section(S_PUBLIC_CLIENTS);
421 syslog(LOG_DEBUG, "Checking whether %s is a local or public client\n",
423 for (i=0; i<num_parms(public_clients); ++i) {
424 extract_token(addrbuf, public_clients, i, '|', sizeof addrbuf);
425 if (!strcasecmp(CC->cs_addr, addrbuf)) {
426 syslog(LOG_DEBUG, "... yes it is.\n");
431 /* No hits. This is not a public client. */
432 syslog(LOG_DEBUG, "... no it isn't.\n");
438 * the client is identifying itself to the server
440 void cmd_iden(char *argbuf)
448 if (num_parms(argbuf)<4) {
449 cprintf("%d usage error\n", ERROR + ILLEGAL_VALUE);
453 dev_code = extract_int(argbuf,0);
454 cli_code = extract_int(argbuf,1);
455 rev_level = extract_int(argbuf,2);
456 extract_token(desc, argbuf, 3, '|', sizeof desc);
458 safestrncpy(from_host, config.c_fqdn, sizeof from_host);
459 from_host[sizeof from_host - 1] = 0;
460 if (num_parms(argbuf)>=5) extract_token(from_host, argbuf, 4, '|', sizeof from_host);
462 CC->cs_clientdev = dev_code;
463 CC->cs_clienttyp = cli_code;
464 CC->cs_clientver = rev_level;
465 safestrncpy(CC->cs_clientname, desc, sizeof CC->cs_clientname);
466 CC->cs_clientname[31] = 0;
468 /* For local sockets and public clients, trust the hostname supplied by the client */
469 if ( (CC->is_local_socket) || (is_public_client()) ) {
470 safestrncpy(CC->cs_host, from_host, sizeof CC->cs_host);
471 CC->cs_host[sizeof CC->cs_host - 1] = 0;
475 syslog(LOG_NOTICE, "Client %d/%d/%01d.%02d (%s) from %s\n",
483 cprintf("%d Ok\n",CIT_OK);
488 * display system messages or help
490 void cmd_mesg(char *mname)
500 extract_token(buf, mname, 0, '|', sizeof buf);
502 dirs[0] = strdup(ctdl_message_dir);
503 dirs[1] = strdup(ctdl_hlp_dir);
505 snprintf(buf2, sizeof buf2, "%s.%d.%d",
506 buf, CC->cs_clientdev, CC->cs_clienttyp);
508 /* If the client requested "?" then produce a listing */
509 if (!strcmp(buf, "?")) {
510 cprintf("%d %s\n", LISTING_FOLLOWS, buf);
511 dp = opendir(dirs[1]);
513 while (d = readdir(dp), d != NULL) {
514 if (d->d_name[0] != '.') {
515 cprintf(" %s\n", d->d_name);
526 /* Otherwise, look for the requested file by name. */
528 mesg_locate(targ, sizeof targ, buf2, 2, (const char **)dirs);
529 if (IsEmptyStr(targ)) {
530 snprintf(buf2, sizeof buf2, "%s.%d",
531 buf, CC->cs_clientdev);
532 mesg_locate(targ, sizeof targ, buf2, 2,
533 (const char **)dirs);
534 if (IsEmptyStr(targ)) {
535 mesg_locate(targ, sizeof targ, buf, 2,
536 (const char **)dirs);
544 if (IsEmptyStr(targ)) {
545 cprintf("%d '%s' not found. (Searching in %s and %s)\n",
546 ERROR + FILE_NOT_FOUND,
554 mfp = fopen(targ, "r");
556 cprintf("%d Cannot open '%s': %s\n",
557 ERROR + INTERNAL_ERROR, targ, strerror(errno));
560 cprintf("%d %s\n", LISTING_FOLLOWS,buf);
562 while (fgets(buf, (sizeof buf - 1), mfp) != NULL) {
563 buf[strlen(buf)-1] = 0;
574 * enter system messages or help
576 void cmd_emsg(char *mname)
586 if (CtdlAccessCheck(ac_aide)) return;
588 extract_token(buf, mname, 0, '|', sizeof buf);
589 for (a=0; !IsEmptyStr(&buf[a]); ++a) { /* security measure */
590 if (buf[a] == '/') buf[a] = '.';
593 dirs[0] = strdup(ctdl_message_dir);
594 dirs[1] = strdup(ctdl_hlp_dir);
596 mesg_locate(targ, sizeof targ, buf, 2, (const char**)dirs);
600 if (IsEmptyStr(targ)) {
601 snprintf(targ, sizeof targ,
606 mfp = fopen(targ,"w");
608 cprintf("%d Cannot open '%s': %s\n",
609 ERROR + INTERNAL_ERROR, targ, strerror(errno));
612 cprintf("%d %s\n", SEND_LISTING, targ);
614 while (client_getln(buf, sizeof buf) >=0 && strcmp(buf, "000")) {
615 fprintf(mfp, "%s\n", buf);
622 /* Don't show the names of private rooms unless the viewing
623 * user also knows the rooms.
625 void GenerateRoomDisplay(char *real_room,
627 CitContext *viewer) {
631 strcpy(real_room, viewed->room.QRname);
632 if (viewed->room.QRflags & QR_MAILBOX) {
633 strcpy(real_room, &real_room[11]);
635 if (viewed->room.QRflags & QR_PRIVATE) {
636 CtdlRoomAccess(&viewed->room, &viewer->user, &ra, NULL);
637 if ( (ra & UA_KNOWN) == 0) {
638 strcpy(real_room, "<private room>");
642 if (viewed->cs_flags & CS_CHAT) {
643 while (strlen(real_room) < 14) {
644 strcat(real_room, " ");
646 strcpy(&real_room[14], "<chat>");
652 * Convenience function.
654 int CtdlAccessCheck(int required_level) {
656 if (CC->internal_pgm) return(0);
657 if (required_level >= ac_internal) {
658 cprintf("%d This is not a user-level command.\n",
659 ERROR + HIGHER_ACCESS_REQUIRED);
663 if ((required_level >= ac_logged_in_or_guest) && (CC->logged_in == 0) && (!config.c_guest_logins)) {
664 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
668 if ((required_level >= ac_logged_in) && (CC->logged_in == 0)) {
669 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
673 if (CC->user.axlevel >= AxAideU) return(0);
674 if (required_level >= ac_aide) {
675 cprintf("%d This command requires Aide access.\n",
676 ERROR + HIGHER_ACCESS_REQUIRED);
680 if (is_room_aide()) return(0);
681 if (required_level >= ac_room_aide) {
682 cprintf("%d This command requires Aide or Room Aide access.\n",
683 ERROR + HIGHER_ACCESS_REQUIRED);
687 /* shhh ... succeed quietly */
694 * Terminate another running session
696 void cmd_term(char *cmdbuf)
701 session_num = extract_int(cmdbuf, 0);
703 terminated = CtdlTerminateOtherSession(session_num);
705 if (terminated < 0) {
706 cprintf("%d You can't kill your own session.\n", ERROR + ILLEGAL_VALUE);
710 if (terminated & TERM_FOUND) {
711 if (terminated == TERM_KILLED) {
712 cprintf("%d Session terminated.\n", CIT_OK);
715 cprintf("%d You are not allowed to do that.\n",
716 ERROR + HIGHER_ACCESS_REQUIRED);
720 cprintf("%d No such session.\n", ERROR + ILLEGAL_VALUE);
726 * get the paginator prompt
728 void cmd_more(char *argbuf) {
729 cprintf("%d %s\n", CIT_OK, config.c_moreprompt);
736 void cmd_echo(char *etext)
738 cprintf("%d %s\n", CIT_OK, etext);
743 * Perform privilege escalation for an internal program
745 void cmd_ipgm(char *argbuf)
749 secret = extract_int(argbuf, 0);
751 /* For security reasons, we do NOT allow this command to run
752 * over the network. Local sockets only.
754 if (!CC->is_local_socket) {
756 cprintf("%d Authentication failed.\n", ERROR + PASSWORD_REQUIRED);
758 else if (secret == config.c_ipgm_secret) {
759 CC->internal_pgm = 1;
760 strcpy(CC->curr_user, "<internal program>");
761 CC->cs_flags = CC->cs_flags|CS_STEALTH;
762 cprintf("%d Authenticated as an internal program.\n", CIT_OK);
766 cprintf("%d Authentication failed.\n", ERROR + PASSWORD_REQUIRED);
767 syslog(LOG_ERR, "Warning: ipgm authentication failed.\n");
774 * Shut down the server
776 void cmd_down(char *argbuf) {
777 char *Reply ="%d Shutting down server. Goodbye.\n";
779 if (CtdlAccessCheck(ac_aide)) return;
781 if (!IsEmptyStr(argbuf))
784 restart_server = extract_int(argbuf, 0);
786 if (restart_server > 0)
788 Reply = "%d citserver will now shut down and automatically restart.\n";
790 if ((restart_server > 0) && !running_as_daemon)
792 syslog(LOG_ERR, "The user requested restart, but not running as daemon! Geronimooooooo!\n");
793 Reply = "%d Warning: citserver is not running in daemon mode and is therefore unlikely to restart automatically.\n";
796 cprintf(Reply, state);
800 cprintf(Reply, CIT_OK + SERVER_SHUTTING_DOWN);
802 CC->kill_me = 1; /* Even the DOWN command has to follow correct proceedure when disconecting */
808 * Halt the server without exiting the server process.
810 void cmd_halt(char *argbuf) {
812 if (CtdlAccessCheck(ac_aide)) return;
814 cprintf("%d Halting server. Goodbye.\n", CIT_OK);
816 shutdown_and_halt = 1;
821 * Schedule or cancel a server shutdown
823 void cmd_scdn(char *argbuf)
827 char *Reply = "%d %d\n";
829 if (CtdlAccessCheck(ac_aide)) return;
831 new_state = extract_int(argbuf, 0);
832 if ((new_state == 2) || (new_state == 3))
835 if (!running_as_daemon)
837 syslog(LOG_ERR, "The user requested restart, but not running as deamon! Geronimooooooo!\n");
838 Reply = "%d %d Warning, not running in deamon mode. maybe we will come up again, but don't lean on it.\n";
842 restart_server = extract_int(argbuf, 0);
845 if ((new_state == 0) || (new_state == 1)) {
846 ScheduledShutdown = new_state;
848 cprintf(Reply, state, ScheduledShutdown);
853 * Set or unset asynchronous protocol mode
855 void cmd_asyn(char *argbuf)
859 new_state = extract_int(argbuf, 0);
860 if ((new_state == 0) || (new_state == 1)) {
861 CC->is_async = new_state;
863 cprintf("%d %d\n", CIT_OK, CC->is_async);
869 * Back-end function for starting a session
871 void begin_session(CitContext *con)
874 struct sockaddr_in sin;
877 * Initialize some variables specific to our context.
880 con->internal_pgm = 0;
881 con->download_fp = NULL;
882 con->upload_fp = NULL;
883 con->cached_msglist = NULL;
884 con->FirstExpressMessage = NULL;
886 time(&con->lastidle);
887 strcpy(con->lastcmdname, " ");
888 strcpy(con->cs_clientname, "(unknown)");
889 strcpy(con->curr_user, NLI);
890 *con->net_node = '\0';
891 *con->fake_username = '\0';
892 *con->fake_hostname = '\0';
893 *con->fake_roomname = '\0';
894 *con->cs_clientinfo = '\0';
895 safestrncpy(con->cs_host, config.c_fqdn, sizeof con->cs_host);
896 safestrncpy(con->cs_addr, "", sizeof con->cs_addr);
897 con->cs_UDSclientUID = -1;
898 con->cs_host[sizeof con->cs_host - 1] = 0;
900 if (!CC->is_local_socket) {
901 locate_host(con->cs_host, sizeof con->cs_host,
902 con->cs_addr, sizeof con->cs_addr,
909 #ifdef HAVE_STRUCT_UCRED
911 /* as http://www.wsinnovations.com/softeng/articles/uds.html told us... */
912 struct ucred credentials;
913 socklen_t ucred_length = sizeof(struct ucred);
915 /*fill in the user data structure */
916 if(getsockopt(con->client_socket, SOL_SOCKET, SO_PEERCRED, &credentials, &ucred_length)) {
917 syslog(LOG_NOTICE, "could obtain credentials from unix domain socket");
921 /* the process ID of the process on the other side of the socket */
922 /* credentials.pid; */
924 /* the effective UID of the process on the other side of the socket */
925 con->cs_UDSclientUID = credentials.uid;
927 /* the effective primary GID of the process on the other side of the socket */
928 /* credentials.gid; */
930 /* To get supplemental groups, we will have to look them up in our account
931 database, after a reverse lookup on the UID to get the account name.
932 We can take this opportunity to check to see if this is a legit account.
934 snprintf(con->cs_clientinfo, sizeof(con->cs_clientinfo),
935 "PID: "F_PID_T"; UID: "F_UID_T"; GID: "F_XPID_T" ",
944 con->upload_type = UPL_FILE;
948 if (((config.c_maxsessions > 0)&&(num_sessions > config.c_maxsessions)) || CtdlWantSingleUser()) {
952 if (!CC->is_local_socket) {
953 syslog(LOG_NOTICE, "Session (%s) started from %s (%s).\n", con->ServiceName, con->cs_host, con->cs_addr);
956 syslog(LOG_NOTICE, "Session (%s) started via local socket UID:%d.\n", con->ServiceName, con->cs_UDSclientUID);
959 /* Run any session startup routines registered by loadable modules */
960 PerformSessionHooks(EVT_START);
964 void citproto_begin_session() {
965 if (CC->nologin==1) {
966 cprintf("%d %s: Too many users are already online (maximum is %d)\n",
967 ERROR + MAX_SESSIONS_EXCEEDED,
968 config.c_nodename, config.c_maxsessions
973 cprintf("%d %s Citadel server ready.\n", CIT_OK, config.c_nodename);
974 CC->can_receive_im = 1;
979 void cmd_noop(char *argbuf)
981 cprintf("%d%cok\n", CIT_OK, CtdlCheckExpress() );
985 void cmd_qnop(char *argbuf)
987 /* do nothing, this command returns no response */
991 void cmd_quit(char *argbuf)
993 cprintf("%d Goodbye.\n", CIT_OK);
998 void cmd_lout(char *argbuf)
1002 cprintf("%d logged out.\n", CIT_OK);
1007 * This loop recognizes all server commands.
1009 void do_command_loop(void) {
1011 const char *old_name = NULL;
1013 old_name = CtdlThreadName("do_command_loop");
1016 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
1017 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
1018 syslog(LOG_ERR, "Client disconnected: ending session.\n");
1020 CtdlThreadName(old_name);
1024 /* Log the server command, but don't show passwords... */
1025 if ( (strncasecmp(cmdbuf, "PASS", 4)) && (strncasecmp(cmdbuf, "SETP", 4)) ) {
1026 syslog(LOG_INFO, "CtdlCommand [%s] [%s] %s\n", CTDLUSERIP, CC->curr_user, cmdbuf);
1029 syslog(LOG_INFO, "CtdlCommand [%s] [%s] <password command hidden from log>\n", CTDLUSERIP, CC->curr_user);
1035 * Let other clients see the last command we executed, and
1036 * update the idle time, but not NOOP, QNOP, PEXP, GEXP, RWHO, or TIME.
1038 if ( (strncasecmp(cmdbuf, "NOOP", 4))
1039 && (strncasecmp(cmdbuf, "QNOP", 4))
1040 && (strncasecmp(cmdbuf, "PEXP", 4))
1041 && (strncasecmp(cmdbuf, "GEXP", 4))
1042 && (strncasecmp(cmdbuf, "RWHO", 4))
1043 && (strncasecmp(cmdbuf, "TIME", 4)) ) {
1044 strcpy(CC->lastcmdname, " ");
1045 safestrncpy(CC->lastcmdname, cmdbuf, sizeof(CC->lastcmdname));
1046 time(&CC->lastidle);
1049 CtdlThreadName(cmdbuf);
1051 if ((strncasecmp(cmdbuf, "ENT0", 4))
1052 && (strncasecmp(cmdbuf, "MESG", 4))
1053 && (strncasecmp(cmdbuf, "MSGS", 4)))
1055 CC->cs_flags &= ~CS_POSTING;
1058 if (!DLoader_Exec_Cmd(cmdbuf)) {
1059 cprintf("%d Unrecognized or unsupported command.\n", ERROR + CMD_NOT_SUPPORTED);
1064 /* Run any after-each-command routines registered by modules */
1065 PerformSessionHooks(EVT_CMD);
1066 CtdlThreadName(old_name);
1071 * This loop performs all asynchronous functions.
1073 void do_async_loop(void) {
1074 PerformSessionHooks(EVT_ASYNC);
1078 /*****************************************************************************/
1079 /* MODULE INITIALIZATION STUFF */
1080 /*****************************************************************************/
1082 CTDL_MODULE_INIT(citserver)
1085 CtdlRegisterProtoHook(cmd_noop, "NOOP", "no operation");
1086 CtdlRegisterProtoHook(cmd_qnop, "QNOP", "no operation with no response");
1087 CtdlRegisterProtoHook(cmd_quit, "QUIT", "log out and disconnect from server");
1088 CtdlRegisterProtoHook(cmd_lout, "LOUT", "log out but do not disconnect from server");
1089 CtdlRegisterProtoHook(cmd_asyn, "ASYN", "enable asynchronous server responses");
1090 CtdlRegisterProtoHook(cmd_info, "INFO", "fetch server capabilities and configuration");
1091 CtdlRegisterProtoHook(cmd_mesg, "MESG", "fetch system banners");
1092 CtdlRegisterProtoHook(cmd_emsg, "EMSG", "submit system banners");
1093 CtdlRegisterProtoHook(cmd_echo, "ECHO", "echo text back to the client");
1094 CtdlRegisterProtoHook(cmd_more, "MORE", "fetch the paginator prompt");
1095 CtdlRegisterProtoHook(cmd_iden, "IDEN", "identify the client software and location");
1096 CtdlRegisterProtoHook(cmd_ipgm, "IPGM", "perform privilege escalation for internal programs");
1097 CtdlRegisterProtoHook(cmd_term, "TERM", "terminate another running session");
1098 CtdlRegisterProtoHook(cmd_down, "DOWN", "perform a server shutdown");
1099 CtdlRegisterProtoHook(cmd_halt, "HALT", "halt the server without exiting the server process");
1100 CtdlRegisterProtoHook(cmd_scdn, "SCDN", "schedule or cancel a server shutdown");
1101 CtdlRegisterProtoHook(cmd_time, "TIME", "fetch the date and time from the server");
1103 /* return our id for the Log */