2 * Server functions which perform operations on user objects.
4 * Copyright (c) 1987-2023 by the citadel.org team
6 * This program is open source software; you can redistribute it and/or
7 * modify 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.
16 #include <libcitadel.h>
17 #include "../../citserver.h"
18 #include "../../ctdl_module.h"
19 #include "../../config.h"
22 void cmd_noop(char *argbuf)
24 cprintf("%d%cok\n", CIT_OK, CtdlCheckExpress() );
28 void cmd_qnop(char *argbuf)
30 /* do nothing, this command returns no response */
35 * Set or unset asynchronous protocol mode
37 void cmd_asyn(char *argbuf)
41 new_state = extract_int(argbuf, 0);
42 if ((new_state == 0) || (new_state == 1)) {
43 CC->is_async = new_state;
45 cprintf("%d %d\n", CIT_OK, CC->is_async);
50 * cmd_info() - Identify this server and its capabilities to the client
52 void cmd_info(char *cmdbuf) {
53 cprintf("%d Server info:\n", LISTING_FOLLOWS);
54 cprintf("%d\n", CC->cs_pid);
55 cprintf("%s\n", CtdlGetConfigStr("c_nodename"));
56 cprintf("%s\n", CtdlGetConfigStr("c_humannode"));
57 cprintf("%s\n", CtdlGetConfigStr("c_fqdn"));
58 cprintf("%s\n", CITADEL);
59 cprintf("%d\n", REV_LEVEL);
60 cprintf("%s\n", CtdlGetConfigStr("c_site_location"));
61 cprintf("%s\n", CtdlGetConfigStr("c_sysadm"));
62 cprintf("%d\n", SERVER_TYPE);
63 cprintf("%s\n", CtdlGetConfigStr("c_moreprompt"));
64 cprintf("1\n"); /* 1 = yes, this system supports floors */
65 cprintf("1\n"); /* 1 = we support the extended paging options */
66 cprintf("\n"); /* no longer used */
67 cprintf("1\n"); /* 1 = yes, this system supports the QNOP command */
68 cprintf("1\n"); /* 1 = yes, this server is LDAP-enabled */
70 if ((CtdlGetConfigInt("c_auth_mode") == AUTHMODE_NATIVE) && (CtdlGetConfigInt("c_disable_newu") == 0))
72 cprintf("%d\n", CtdlGetConfigInt("c_disable_newu"));
75 cprintf("1\n"); /* "create new user" does not work with non-native auth modes */
78 cprintf("%s\n", CtdlGetConfigStr("c_default_cal_zone"));
80 cprintf("0\n"); /* no longer used */
81 cprintf("0\n"); /* no longer used */
82 cprintf("0\n"); /* no longer used */
83 cprintf("0\n"); /* no longer used */
85 cprintf("%d\n", CtdlGetConfigInt("c_enable_fulltext"));
86 cprintf("%s\n", BUILD_ID);
88 cprintf("0\n"); /* OpenID is no longer supported */
90 cprintf("%d\n", CtdlGetConfigInt("c_guest_logins"));
98 void cmd_echo(char *etext)
100 cprintf("%d %s\n", CIT_OK, etext);
105 * get the paginator prompt
107 void cmd_more(char *argbuf) {
108 cprintf("%d %s\n", CIT_OK, CtdlGetConfigStr("c_moreprompt"));
113 * the client is identifying itself to the server
115 void cmd_iden(char *argbuf)
123 if (num_parms(argbuf)<4) {
124 cprintf("%d usage error\n", ERROR + ILLEGAL_VALUE);
128 dev_code = extract_int(argbuf,0);
129 cli_code = extract_int(argbuf,1);
130 rev_level = extract_int(argbuf,2);
131 extract_token(desc, argbuf, 3, '|', sizeof desc);
133 safestrncpy(from_host, CtdlGetConfigStr("c_fqdn"), sizeof from_host);
134 from_host[sizeof from_host - 1] = 0;
135 if (num_parms(argbuf)>=5) extract_token(from_host, argbuf, 4, '|', sizeof from_host);
137 CC->cs_clientdev = dev_code;
138 CC->cs_clienttyp = cli_code;
139 CC->cs_clientver = rev_level;
140 safestrncpy(CC->cs_clientname, desc, sizeof CC->cs_clientname);
141 CC->cs_clientname[31] = 0;
143 /* For local sockets, allow the client to supply the user's origin address */
144 if ((CC->is_local_client) || (!IsEmptyStr(CC->cs_addr) && (!strcmp(CC->cs_addr, "127.0.0.1")) || (!strcmp(CC->cs_addr, "::1")))) {
145 safestrncpy(CC->cs_host, from_host, sizeof CC->cs_host);
146 CC->cs_host[sizeof CC->cs_host - 1] = 0;
150 syslog(LOG_NOTICE, "session: client %d/%d/%01d.%02d (%s) from %s",
158 cprintf("%d Ok\n",CIT_OK);
163 * Terminate another running session
165 void cmd_term(char *cmdbuf)
167 int session_num = extract_int(cmdbuf, 0);
168 int terminated = CtdlTerminateOtherSession(session_num);
170 if (terminated < 0) {
171 cprintf("%d You can't kill your own session.\n", ERROR + ILLEGAL_VALUE);
175 if (terminated & TERM_FOUND) {
176 if (terminated == TERM_KILLED) {
177 cprintf("%d Session terminated.\n", CIT_OK);
180 cprintf("%d You are not allowed to do that.\n", ERROR + HIGHER_ACCESS_REQUIRED);
184 cprintf("%d No such session.\n", ERROR + ILLEGAL_VALUE);
189 void cmd_time(char *argbuf)
195 localtime_r(&tv, &tmp);
197 /* timezone and daylight global variables are not portable. */
198 #ifdef HAVE_STRUCT_TM_TM_GMTOFF
199 cprintf("%d %ld|%ld|%d|%ld\n", CIT_OK, (long)tv, tmp.tm_gmtoff, tmp.tm_isdst, server_startup_time);
201 cprintf("%d %ld|%ld|%d|%ld\n", CIT_OK, (long)tv, timezone, tmp.tm_isdst, server_startup_time);
206 // Initialization function, called from modules_init.c
207 char *ctdl_module_init_serv_session(void) {
209 CtdlRegisterProtoHook(cmd_noop, "NOOP", "no operation");
210 CtdlRegisterProtoHook(cmd_qnop, "QNOP", "no operation with no response");
211 CtdlRegisterProtoHook(cmd_asyn, "ASYN", "enable asynchronous server responses");
212 CtdlRegisterProtoHook(cmd_info, "INFO", "fetch server capabilities and configuration");
213 CtdlRegisterProtoHook(cmd_echo, "ECHO", "echo text back to the client");
214 CtdlRegisterProtoHook(cmd_more, "MORE", "fetch the paginator prompt");
215 CtdlRegisterProtoHook(cmd_iden, "IDEN", "identify the client software and location");
216 CtdlRegisterProtoHook(cmd_term, "TERM", "terminate another running session");
217 CtdlRegisterProtoHook(cmd_time, "TIME", "fetch the date and time from the server");
219 /* return our id for the Log */
220 return "serv_session";