2 Copyright (C) 1996-1997 Id Software, Inc.
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
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.
13 See the GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 // for secure rcon authentication
29 cvar_t cl_name = {CVAR_CLIENT | CVAR_SAVE | CVAR_USERINFO, "name", "player", "change your player name"};
30 cvar_t cl_rate = {CVAR_CLIENT | CVAR_SAVE | CVAR_USERINFO, "rate", "20000", "change your connection speed"};
31 cvar_t cl_rate_burstsize = {CVAR_CLIENT | CVAR_SAVE | CVAR_USERINFO, "rate_burstsize", "1024", "internal storage cvar for current rate control burst size (changed by rate_burstsize command)"};
32 cvar_t cl_topcolor = {CVAR_CLIENT | CVAR_SAVE | CVAR_USERINFO, "topcolor", "0", "change the color of your shirt"};
33 cvar_t cl_bottomcolor = {CVAR_CLIENT | CVAR_SAVE | CVAR_USERINFO, "bottomcolor", "0", "change the color of your pants"};
34 cvar_t cl_team = {CVAR_CLIENT | CVAR_USERINFO | CVAR_SAVE, "team", "none", "QW team (4 character limit, example: blue)"};
35 cvar_t cl_skin = {CVAR_CLIENT | CVAR_USERINFO | CVAR_SAVE, "skin", "", "QW player skin name (example: base)"};
36 cvar_t cl_noaim = {CVAR_CLIENT | CVAR_USERINFO | CVAR_SAVE, "noaim", "1", "QW option to disable vertical autoaim"};
37 cvar_t cl_pmodel = {CVAR_CLIENT | CVAR_USERINFO | CVAR_SAVE, "pmodel", "0", "current player model number in nehahra"};
38 cvar_t r_fixtrans_auto = {CVAR_CLIENT, "r_fixtrans_auto", "0", "automatically fixtrans textures (when set to 2, it also saves the fixed versions to a fixtrans directory)"};
40 extern cvar_t rcon_secure;
41 extern cvar_t rcon_secure_challengetimeout;
47 Sends an entire command string over to the server, unprocessed
50 void CL_ForwardToServer (const char *s)
53 if (cls.state != ca_connected)
55 Con_Printf("Can't \"%s\", not connected\n", s);
62 // LadyHavoc: thanks to Fuh for bringing the pure evil of SZ_Print to my
63 // attention, it has been eradicated from here, its only (former) use in
65 if (cls.protocol == PROTOCOL_QUAKEWORLD)
66 MSG_WriteByte(&cls.netcon->message, qw_clc_stringcmd);
68 MSG_WriteByte(&cls.netcon->message, clc_stringcmd);
69 if ((!strncmp(s, "say ", 4) || !strncmp(s, "say_team ", 9)) && cl_locs_enable.integer)
71 // say/say_team commands can replace % character codes with status info
74 if (*s == '%' && s[1])
76 // handle proquake message macros
80 case 'l': // current location
81 CL_Locs_FindLocationName(temp, sizeof(temp), cl.movement_origin);
83 case 'h': // current health
84 dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_HEALTH]);
86 case 'a': // current armor
87 dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_ARMOR]);
89 case 'x': // current rockets
90 dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_ROCKETS]);
92 case 'c': // current cells
93 dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_CELLS]);
95 // silly proquake macros
96 case 'd': // loc at last death
97 CL_Locs_FindLocationName(temp, sizeof(temp), cl.lastdeathorigin);
99 case 't': // current time
100 dpsnprintf(temp, sizeof(temp), "%.0f:%.0f", floor(cl.time / 60), cl.time - floor(cl.time / 60) * 60);
102 case 'r': // rocket launcher status ("I have RL", "I need rockets", "I need RL")
103 if (!(cl.stats[STAT_ITEMS] & IT_ROCKET_LAUNCHER))
104 dpsnprintf(temp, sizeof(temp), "I need RL");
105 else if (!cl.stats[STAT_ROCKETS])
106 dpsnprintf(temp, sizeof(temp), "I need rockets");
108 dpsnprintf(temp, sizeof(temp), "I have RL");
110 case 'p': // powerup status (outputs "quad" "pent" and "eyes" according to status)
111 if (cl.stats[STAT_ITEMS] & IT_QUAD)
114 strlcat(temp, " ", sizeof(temp));
115 strlcat(temp, "quad", sizeof(temp));
117 if (cl.stats[STAT_ITEMS] & IT_INVULNERABILITY)
120 strlcat(temp, " ", sizeof(temp));
121 strlcat(temp, "pent", sizeof(temp));
123 if (cl.stats[STAT_ITEMS] & IT_INVISIBILITY)
126 strlcat(temp, " ", sizeof(temp));
127 strlcat(temp, "eyes", sizeof(temp));
130 case 'w': // weapon status (outputs "SSG:NG:SNG:GL:RL:LG" with the text between : characters omitted if you lack the weapon)
131 if (cl.stats[STAT_ITEMS] & IT_SUPER_SHOTGUN)
132 strlcat(temp, "SSG", sizeof(temp));
133 strlcat(temp, ":", sizeof(temp));
134 if (cl.stats[STAT_ITEMS] & IT_NAILGUN)
135 strlcat(temp, "NG", sizeof(temp));
136 strlcat(temp, ":", sizeof(temp));
137 if (cl.stats[STAT_ITEMS] & IT_SUPER_NAILGUN)
138 strlcat(temp, "SNG", sizeof(temp));
139 strlcat(temp, ":", sizeof(temp));
140 if (cl.stats[STAT_ITEMS] & IT_GRENADE_LAUNCHER)
141 strlcat(temp, "GL", sizeof(temp));
142 strlcat(temp, ":", sizeof(temp));
143 if (cl.stats[STAT_ITEMS] & IT_ROCKET_LAUNCHER)
144 strlcat(temp, "RL", sizeof(temp));
145 strlcat(temp, ":", sizeof(temp));
146 if (cl.stats[STAT_ITEMS] & IT_LIGHTNING)
147 strlcat(temp, "LG", sizeof(temp));
150 // not a recognized macro, print it as-is...
156 // write the resulting text
157 SZ_Write(&cls.netcon->message, (unsigned char *)temp, (int)strlen(temp));
161 MSG_WriteByte(&cls.netcon->message, *s);
164 MSG_WriteByte(&cls.netcon->message, 0);
166 else // any other command is passed on as-is
167 SZ_Write(&cls.netcon->message, (const unsigned char *)s, (int)strlen(s) + 1);
170 void CL_ForwardToServer_f (cmd_state_t *cmd)
174 if (!strcasecmp(Cmd_Argv(cmd, 0), "cmd"))
176 // we want to strip off "cmd", so just send the args
177 s = Cmd_Argc(cmd) > 1 ? Cmd_Args(cmd) : "";
181 // we need to keep the command name, so send Cmd_Argv(cmd, 0), a space and then Cmd_Args(cmd)
182 s = va(vabuf, sizeof(vabuf), "%s %s", Cmd_Argv(cmd, 0), Cmd_Argc(cmd) > 1 ? Cmd_Args(cmd) : "");
184 // don't send an empty forward message if the user tries "cmd" by itself
187 CL_ForwardToServer(s);
190 static void CL_SendCvar_f(cmd_state_t *cmd)
193 const char *cvarname;
196 if(Cmd_Argc(cmd) != 2)
198 cvarname = Cmd_Argv(cmd, 1);
199 if (cls.state == ca_connected)
201 c = Cvar_FindVar(&cvars_all, cvarname, CVAR_CLIENT | CVAR_SERVER);
202 // LadyHavoc: if there is no such cvar or if it is private, send a
203 // reply indicating that it has no value
204 if(!c || (c->flags & CVAR_PRIVATE))
205 CL_ForwardToServer(va(vabuf, sizeof(vabuf), "sentcvar %s", cvarname));
207 CL_ForwardToServer(va(vabuf, sizeof(vabuf), "sentcvar %s \"%s\"", c->name, c->string));
217 cvar_t cl_color = {CVAR_READONLY | CVAR_CLIENT | CVAR_SAVE, "_cl_color", "0", "internal storage cvar for current player colors (changed by color command)"};
219 // Ignore the callbacks so this two-to-three way synchronization doesn't cause an infinite loop.
220 static void CL_Color_c(cvar_t *var)
224 Cvar_Set_NoCallback(&cl_topcolor, va(vabuf, sizeof(vabuf), "%i", ((var->integer >> 4) & 15)));
225 Cvar_Set_NoCallback(&cl_bottomcolor, va(vabuf, sizeof(vabuf), "%i", (var->integer & 15)));
228 static void CL_Topcolor_c(cvar_t *var)
232 Cvar_Set_NoCallback(&cl_color, va(vabuf, sizeof(vabuf), "%i", var->integer*16 + cl_bottomcolor.integer));
235 static void CL_Bottomcolor_c(cvar_t *var)
239 Cvar_Set_NoCallback(&cl_color, va(vabuf, sizeof(vabuf), "%i", cl_topcolor.integer*16 + var->integer));
242 static void CL_Color_f(cmd_state_t *cmd)
246 if (Cmd_Argc(cmd) == 1)
248 if (cmd->source == src_command)
250 Con_Printf("\"color\" is \"%i %i\"\n", cl_topcolor.integer, cl_bottomcolor.integer);
251 Con_Print("color <0-15> [0-15]\n");
256 if (Cmd_Argc(cmd) == 2)
257 top = bottom = atoi(Cmd_Argv(cmd, 1));
260 top = atoi(Cmd_Argv(cmd, 1));
261 bottom = atoi(Cmd_Argv(cmd, 2));
264 * This is just a convenient way to change topcolor and bottomcolor
265 * We can't change cl_color from here directly because topcolor and
266 * bottomcolor may be changed separately and do not call this function.
267 * So it has to be changed when the userinfo strings are updated, which
268 * happens twice here. Perhaps find a cleaner way?
271 top = top >= 0 ? top : cl_topcolor.integer;
272 bottom = bottom >= 0 ? bottom : cl_bottomcolor.integer;
277 // LadyHavoc: allowing skin colormaps 14 and 15 by commenting this out
283 if (cmd->source == src_command)
285 Cvar_SetValueQuick(&cl_topcolor, top);
286 Cvar_SetValueQuick(&cl_bottomcolor, bottom);
295 packet <destination> <contents>
297 Contents allows \n escape character
300 static void CL_Packet_f(cmd_state_t *cmd) // credit: taken from QuakeWorld
306 lhnetaddress_t address;
307 lhnetsocket_t *mysocket;
309 if (Cmd_Argc(cmd) != 3)
311 Con_Printf ("packet <destination> <contents>\n");
315 if (!LHNETADDRESS_FromString (&address, Cmd_Argv(cmd, 1), sv_netport.integer))
317 Con_Printf ("Bad address\n");
321 in = Cmd_Argv(cmd, 2);
323 send[0] = send[1] = send[2] = send[3] = -1;
325 l = (int)strlen (in);
326 for (i=0 ; i<l ; i++)
328 if (out >= send + sizeof(send) - 1)
330 if (in[i] == '\\' && in[i+1] == 'n')
335 else if (in[i] == '\\' && in[i+1] == '0')
340 else if (in[i] == '\\' && in[i+1] == 't')
345 else if (in[i] == '\\' && in[i+1] == 'r')
350 else if (in[i] == '\\' && in[i+1] == '"')
359 mysocket = NetConn_ChooseClientSocketForAddress(&address);
361 mysocket = NetConn_ChooseServerSocketForAddress(&address);
363 NetConn_Write(mysocket, send, out - send, &address);
367 =====================
370 ProQuake rcon support
371 =====================
373 static void CL_PQRcon_f(cmd_state_t *cmd)
377 lhnetsocket_t *mysocket;
379 if (Cmd_Argc(cmd) == 1)
381 Con_Printf("%s: Usage: %s command\n", Cmd_Argv(cmd, 0), Cmd_Argv(cmd, 0));
385 if (!rcon_password.string || !rcon_password.string[0] || rcon_secure.integer > 0)
387 Con_Printf ("You must set rcon_password before issuing an pqrcon command, and rcon_secure must be 0.\n");
391 e = strchr(rcon_password.string, ' ');
392 n = e ? e-rcon_password.string : (int)strlen(rcon_password.string);
395 cls.rcon_address = cls.netcon->peeraddress;
398 if (!rcon_address.string[0])
400 Con_Printf ("You must either be connected, or set the rcon_address cvar to issue rcon commands\n");
403 LHNETADDRESS_FromString(&cls.rcon_address, rcon_address.string, sv_netport.integer);
405 mysocket = NetConn_ChooseClientSocketForAddress(&cls.rcon_address);
409 unsigned char bufdata[64];
412 MSG_WriteLong(&buf, 0);
413 MSG_WriteByte(&buf, CCREQ_RCON);
414 SZ_Write(&buf, (const unsigned char*)rcon_password.string, n);
415 MSG_WriteByte(&buf, 0); // terminate the (possibly partial) string
416 MSG_WriteString(&buf, Cmd_Args(cmd));
417 StoreBigLong(buf.data, NETFLAG_CTL | (buf.cursize & NETFLAG_LENGTH_MASK));
418 NetConn_Write(mysocket, buf.data, buf.cursize, &cls.rcon_address);
424 =====================
427 Send the rest of the command line over as
428 an unconnected command.
429 =====================
431 static void CL_Rcon_f(cmd_state_t *cmd) // credit: taken from QuakeWorld
435 lhnetsocket_t *mysocket;
437 if (Cmd_Argc(cmd) == 1)
439 Con_Printf("%s: Usage: %s command\n", Cmd_Argv(cmd, 0), Cmd_Argv(cmd, 0));
443 if (!rcon_password.string || !rcon_password.string[0])
445 Con_Printf ("You must set rcon_password before issuing an rcon command.\n");
449 e = strchr(rcon_password.string, ' ');
450 n = e ? e-rcon_password.string : (int)strlen(rcon_password.string);
453 cls.rcon_address = cls.netcon->peeraddress;
456 if (!rcon_address.string[0])
458 Con_Printf ("You must either be connected, or set the rcon_address cvar to issue rcon commands\n");
461 LHNETADDRESS_FromString(&cls.rcon_address, rcon_address.string, sv_netport.integer);
463 mysocket = NetConn_ChooseClientSocketForAddress(&cls.rcon_address);
464 if (mysocket && Cmd_Args(cmd)[0])
466 // simply put together the rcon packet and send it
467 if(Cmd_Argv(cmd, 0)[0] == 's' || rcon_secure.integer > 1)
469 if(cls.rcon_commands[cls.rcon_ringpos][0])
472 LHNETADDRESS_ToString(&cls.rcon_addresses[cls.rcon_ringpos], s, sizeof(s), true);
473 Con_Printf("rcon to %s (for command %s) failed: too many buffered commands (possibly increase MAX_RCONS)\n", s, cls.rcon_commands[cls.rcon_ringpos]);
474 cls.rcon_commands[cls.rcon_ringpos][0] = 0;
477 for (i = 0;i < MAX_RCONS;i++)
478 if(cls.rcon_commands[i][0])
479 if (!LHNETADDRESS_Compare(&cls.rcon_address, &cls.rcon_addresses[i]))
483 NetConn_WriteString(mysocket, "\377\377\377\377getchallenge", &cls.rcon_address); // otherwise we'll request the challenge later
484 strlcpy(cls.rcon_commands[cls.rcon_ringpos], Cmd_Args(cmd), sizeof(cls.rcon_commands[cls.rcon_ringpos]));
485 cls.rcon_addresses[cls.rcon_ringpos] = cls.rcon_address;
486 cls.rcon_timeout[cls.rcon_ringpos] = host.realtime + rcon_secure_challengetimeout.value;
487 cls.rcon_ringpos = (cls.rcon_ringpos + 1) % MAX_RCONS;
489 else if(rcon_secure.integer > 0)
493 dpsnprintf(argbuf, sizeof(argbuf), "%ld.%06d %s", (long) time(NULL), (int) (rand() % 1000000), Cmd_Args(cmd));
494 memcpy(buf, "\377\377\377\377srcon HMAC-MD4 TIME ", 24);
495 if(HMAC_MDFOUR_16BYTES((unsigned char *) (buf + 24), (unsigned char *) argbuf, (int)strlen(argbuf), (unsigned char *) rcon_password.string, n))
498 strlcpy(buf + 41, argbuf, sizeof(buf) - 41);
499 NetConn_Write(mysocket, buf, 41 + (int)strlen(buf + 41), &cls.rcon_address);
505 memcpy(buf, "\377\377\377\377", 4);
506 dpsnprintf(buf+4, sizeof(buf)-4, "rcon %.*s %s", n, rcon_password.string, Cmd_Args(cmd));
507 NetConn_WriteString(mysocket, buf, &cls.rcon_address);
516 Sent by server when serverinfo changes
519 // TODO: shouldn't this be a cvar instead?
520 static void CL_FullServerinfo_f(cmd_state_t *cmd) // credit: taken from QuakeWorld
523 if (Cmd_Argc(cmd) != 2)
525 Con_Printf ("usage: fullserverinfo <complete info string>\n");
529 strlcpy (cl.qw_serverinfo, Cmd_Argv(cmd, 1), sizeof(cl.qw_serverinfo));
530 InfoString_GetValue(cl.qw_serverinfo, "teamplay", temp, sizeof(temp));
531 cl.qw_teamplay = atoi(temp);
538 Allow clients to change userinfo
542 static void CL_FullInfo_f(cmd_state_t *cmd) // credit: taken from QuakeWorld
548 if (Cmd_Argc(cmd) != 2)
550 Con_Printf ("fullinfo <complete info string>\n");
554 s = Cmd_Argv(cmd, 1);
559 size_t len = strcspn(s, "\\");
560 if (len >= sizeof(key)) {
561 len = sizeof(key) - 1;
563 strlcpy(key, s, len + 1);
567 Con_Printf ("MISSING VALUE\n");
570 ++s; // Skip over backslash.
572 len = strcspn(s, "\\");
573 if (len >= sizeof(value)) {
574 len = sizeof(value) - 1;
576 strlcpy(value, s, len + 1);
578 CL_SetInfo(key, value, false, false, false, false);
585 ++s; // Skip over backslash.
593 Allow clients to change userinfo
596 static void CL_SetInfo_f(cmd_state_t *cmd) // credit: taken from QuakeWorld
598 if (Cmd_Argc(cmd) == 1)
600 InfoString_Print(cls.userinfo);
603 if (Cmd_Argc(cmd) != 3)
605 Con_Printf ("usage: setinfo [ <key> <value> ]\n");
608 CL_SetInfo(Cmd_Argv(cmd, 1), Cmd_Argv(cmd, 2), true, false, false, false);
611 static void CL_PingPLReport_f(cmd_state_t *cmd)
615 int l = Cmd_Argc(cmd);
616 if (l > cl.maxclients)
618 for (i = 0;i < l;i++)
620 cl.scores[i].qw_ping = atoi(Cmd_Argv(cmd, 1+i*2));
621 cl.scores[i].qw_packetloss = strtol(Cmd_Argv(cmd, 1+i*2+1), &errbyte, 0);
622 if(errbyte && *errbyte == ',')
623 cl.scores[i].qw_movementloss = atoi(errbyte + 1);
625 cl.scores[i].qw_movementloss = 0;
629 void CL_InitCommands(void)
631 dpsnprintf(cls.userinfo, sizeof(cls.userinfo), "\\name\\player\\team\\none\\topcolor\\0\\bottomcolor\\0\\rate\\10000\\msg\\1\\noaim\\1\\*ver\\dp");
633 Cvar_RegisterVariable(&cl_name);
634 Cvar_RegisterAlias(&cl_name, "_cl_name");
635 Cvar_RegisterVariable(&cl_rate);
636 Cvar_RegisterAlias(&cl_rate, "_cl_rate");
637 Cvar_RegisterVariable(&cl_rate_burstsize);
638 Cvar_RegisterAlias(&cl_rate_burstsize, "_cl_rate_burstsize");
639 Cvar_RegisterVariable(&cl_pmodel);
640 Cvar_RegisterAlias(&cl_pmodel, "_cl_pmodel");
641 Cvar_RegisterVariable(&cl_color);
642 Cvar_RegisterCallback(&cl_color, CL_Color_c);
643 Cvar_RegisterVariable(&cl_topcolor);
644 Cvar_RegisterCallback(&cl_topcolor, CL_Topcolor_c);
645 Cvar_RegisterVariable(&cl_bottomcolor);
646 Cvar_RegisterCallback(&cl_bottomcolor, CL_Bottomcolor_c);
647 Cvar_RegisterVariable(&r_fixtrans_auto);
648 Cvar_RegisterVariable(&cl_team);
649 Cvar_RegisterVariable(&cl_skin);
650 Cvar_RegisterVariable(&cl_noaim);
652 Cmd_AddCommand(CMD_CLIENT | CMD_CLIENT_FROM_SERVER, "cmd", CL_ForwardToServer_f, "send a console commandline to the server (used by some mods)");
653 Cmd_AddCommand(CMD_CLIENT, "color", CL_Color_f, "change your player shirt and pants colors");
654 Cmd_AddCommand(CMD_CLIENT, "rcon", CL_Rcon_f, "sends a command to the server console (if your rcon_password matches the server's rcon_password), or to the address specified by rcon_address when not connected (again rcon_password must match the server's); note: if rcon_secure is set, client and server clocks must be synced e.g. via NTP");
655 Cmd_AddCommand(CMD_CLIENT, "srcon", CL_Rcon_f, "sends a command to the server console (if your rcon_password matches the server's rcon_password), or to the address specified by rcon_address when not connected (again rcon_password must match the server's); this always works as if rcon_secure is set; note: client and server clocks must be synced e.g. via NTP");
656 Cmd_AddCommand(CMD_CLIENT, "pqrcon", CL_PQRcon_f, "sends a command to a proquake server console (if your rcon_password matches the server's rcon_password), or to the address specified by rcon_address when not connected (again rcon_password must match the server's)");
657 Cmd_AddCommand(CMD_CLIENT, "packet", CL_Packet_f, "send a packet to the specified address:port containing a text string");
658 Cmd_AddCommand(CMD_CLIENT, "fullinfo", CL_FullInfo_f, "allows client to modify their userinfo");
659 Cmd_AddCommand(CMD_CLIENT, "setinfo", CL_SetInfo_f, "modifies your userinfo");
660 Cmd_AddCommand(CMD_CLIENT, "sendcvar", CL_SendCvar_f, "sends the value of a cvar to the server as a sentcvar command, for use by QuakeC");
661 Cmd_AddCommand(CMD_CLIENT, "fixtrans", Image_FixTransparentPixels_f, "change alpha-zero pixels in an image file to sensible values, and write out a new TGA (warning: SLOW)");
663 // commands that are only sent by server to client for execution
664 Cmd_AddCommand(CMD_CLIENT_FROM_SERVER, "pingplreport", CL_PingPLReport_f, "command sent by server containing client ping and packet loss values for scoreboard, triggered by pings command from client (not used by QW servers)");
665 Cmd_AddCommand(CMD_CLIENT_FROM_SERVER, "fullserverinfo", CL_FullServerinfo_f, "internal use only, sent by server to client to update client's local copy of serverinfo string");