1 #include "../../common/command/command.qh"
8 #include "../campaign.qh"
9 #include "../cheats.qh"
10 #include "../cl_player.qh"
11 #include "../ipban.qh"
12 #include "../mapvoting.qh"
13 #include "../scores.qh"
14 #include "../teamplay.qh"
16 #include "../mutators/mutators_include.qh"
19 #include "../vehicles/vehicle.qh"
22 #include "../../common/constants.qh"
23 #include "../../common/deathtypes.qh"
24 #include "../../common/mapinfo.qh"
25 #include "../../common/notifications.qh"
26 #include "../../common/teams.qh"
27 #include "../../common/util.qh"
29 #include "../../warpzonelib/common.qh"
31 void ClientKill_TeamChange (float targetteam); // 0 = don't change, -1 = auto, -2 = spec
33 // =========================================================
34 // Server side networked commands code, reworked by Samual
35 // Last updated: December 28th, 2011
36 // =========================================================
38 float SV_ParseClientCommand_floodcheck()
40 if (!timeout_status) // not while paused
42 if(time <= (self.cmd_floodtime + autocvar_sv_clientcommand_antispam_time))
44 self.cmd_floodcount += 1;
45 if(self.cmd_floodcount > autocvar_sv_clientcommand_antispam_count) { return false; } // too much spam, halt
49 self.cmd_floodtime = time;
50 self.cmd_floodcount = 1;
53 return true; // continue, as we're not flooding yet
57 // =======================
58 // Command Sub-Functions
59 // =======================
61 void ClientCommand_autoswitch(float request, float argc)
65 case CMD_REQUEST_COMMAND:
69 self.autoswitch = InterpretBoolean(argv(1));
70 sprint(self, strcat("^1autoswitch is currently turned ", (self.autoswitch ? "on" : "off"), ".\n"));
76 sprint(self, "Incorrect parameters for ^2autoswitch^7\n");
77 case CMD_REQUEST_USAGE:
79 sprint(self, "\nUsage:^3 cmd autoswitch selection\n");
80 sprint(self, " Where 'selection' controls if autoswitch is on or off.\n");
86 void ClientCommand_checkfail(float request, string command) // internal command, used only by code
90 case CMD_REQUEST_COMMAND:
92 printf("CHECKFAIL: %s (%s) epically failed check %s\n", self.netname, self.netaddress, substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)));
94 return; // never fall through to usage
98 sprint(self, "Incorrect parameters for ^2checkfail^7\n");
99 case CMD_REQUEST_USAGE:
101 sprint(self, "\nUsage:^3 cmd checkfail <message>\n");
102 sprint(self, " Where 'message' is the message reported by client about the fail.\n");
108 void ClientCommand_clientversion(float request, float argc) // internal command, used only by code
112 case CMD_REQUEST_COMMAND:
118 self.version = ((argv(1) == "$gameversion") ? 1 : stof(argv(1)));
120 if(self.version < autocvar_gameversion_min || self.version > autocvar_gameversion_max)
122 self.version_mismatch = 1;
123 ClientKill_TeamChange(-2); // observe
125 else if(autocvar_g_campaign || autocvar_g_balance_teams)
127 //JoinBestTeam(self, false, true);
129 else if(teamplay && !autocvar_sv_spectate && !(self.team_forced > 0))
131 self.classname = "observer"; // really?
132 stuffcmd(self, "menu_showteamselect\n");
141 sprint(self, "Incorrect parameters for ^2clientversion^7\n");
142 case CMD_REQUEST_USAGE:
144 sprint(self, "\nUsage:^3 cmd clientversion version\n");
145 sprint(self, " Where 'version' is the game version reported by self.\n");
151 void ClientCommand_mv_getpicture(float request, float argc) // internal command, used only by code
155 case CMD_REQUEST_COMMAND:
159 if(intermission_running)
160 MapVote_SendPicture(stof(argv(1)));
167 sprint(self, "Incorrect parameters for ^2mv_getpicture^7\n");
168 case CMD_REQUEST_USAGE:
170 sprint(self, "\nUsage:^3 cmd mv_getpicture mapid\n");
171 sprint(self, " Where 'mapid' is the id number of the map to request an image of on the map vote selection menu.\n");
177 void ClientCommand_join(float request)
181 case CMD_REQUEST_COMMAND:
185 if(!IS_PLAYER(self) && !lockteams && !gameover)
189 if(nJoinAllowed(self))
191 if(autocvar_g_campaign) { campaign_bots_may_start = 1; }
193 self.classname = "player";
194 PlayerScore_Clear(self);
195 Kill_Notification(NOTIF_ONE_ONLY, self, MSG_CENTER_CPID, CPID_PREVENT_JOIN);
196 Send_Notification(NOTIF_ALL, world, MSG_INFO, INFO_JOIN_PLAY, self.netname);
201 //player may not join because of g_maxplayers is set
202 Send_Notification(NOTIF_ONE_ONLY, self, MSG_CENTER, CENTER_JOIN_PREVENT);
206 return; // never fall through to usage
210 case CMD_REQUEST_USAGE:
212 sprint(self, "\nUsage:^3 cmd join\n");
213 sprint(self, " No arguments required.\n");
219 void ClientCommand_physics(float request, float argc)
223 case CMD_REQUEST_COMMAND:
225 string command = strtolower(argv(1));
227 if(!autocvar_g_physics_clientselect)
229 sprint(self, "Client physics selection is currently disabled.\n");
233 if(command == "list" || command == "help")
235 sprint(self, strcat("Available physics sets: \n\n", autocvar_g_physics_clientselect_options, " default\n"));
239 if(Physics_Valid(command) || command == "default")
241 stuffcmd(self, strcat("\nseta cl_physics ", command, "\nsendcvar cl_physics\n"));
242 sprint(self, strcat("^2Physics set successfully changed to ^3", command, "\n"));
248 sprint(self, strcat("Current physics set: ^3", self.cvar_cl_physics, "\n"));
249 case CMD_REQUEST_USAGE:
251 sprint(self, "\nUsage:^3 cmd physics <physics>\n");
252 sprint(self, " See 'cmd physics list' for available physics sets.\n");
253 sprint(self, " Argument 'default' resets to standard physics.\n");
259 void ClientCommand_ready(float request) // todo: anti-spam for toggling readyness
263 case CMD_REQUEST_COMMAND:
267 if(warmup_stage || autocvar_sv_ready_restart || g_race_qualifying == 2)
269 if(!readyrestart_happened || autocvar_sv_ready_restart_repeatable)
271 if(time < game_starttime) // game is already restarting
273 if (self.ready) // toggle
276 bprint(self.netname, "^2 is ^1NOT^2 ready\n");
281 bprint(self.netname, "^2 is ready\n");
284 // cannot reset the game while a timeout is active!
288 sprint(self, "^1Game has already been restarted\n");
292 return; // never fall through to usage
296 case CMD_REQUEST_USAGE:
298 sprint(self, "\nUsage:^3 cmd ready\n");
299 sprint(self, " No arguments required.\n");
305 void ClientCommand_say(float request, float argc, string command)
309 case CMD_REQUEST_COMMAND:
311 if(argc >= 2) { Say(self, false, world, substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)), 1); }
312 return; // never fall through to usage
316 case CMD_REQUEST_USAGE:
318 sprint(self, "\nUsage:^3 cmd say <message>\n");
319 sprint(self, " Where 'message' is the string of text to say.\n");
325 void ClientCommand_say_team(float request, float argc, string command)
329 case CMD_REQUEST_COMMAND:
331 if(argc >= 2) { Say(self, true, world, substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)), 1); }
332 return; // never fall through to usage
336 case CMD_REQUEST_USAGE:
338 sprint(self, "\nUsage:^3 cmd say_team <message>\n");
339 sprint(self, " Where 'message' is the string of text to say.\n");
345 void ClientCommand_selectteam(float request, float argc)
349 case CMD_REQUEST_COMMAND:
356 if(self.team_forced <= 0)
363 case "red": selection = NUM_TEAM_1; break;
364 case "blue": selection = NUM_TEAM_2; break;
365 case "yellow": selection = NUM_TEAM_3; break;
366 case "pink": selection = NUM_TEAM_4; break;
367 case "auto": selection = (-1); break;
369 default: selection = 0; break;
374 if(self.team == selection && self.deadflag == DEAD_NO)
375 sprint(self, "^7You already are on that team.\n");
376 else if(self.wasplayer && autocvar_g_changeteam_banned)
377 sprint(self, "^1You cannot change team, forbidden by the server.\n");
380 if(autocvar_g_balance_teams && autocvar_g_balance_teams_prevent_imbalance)
382 CheckAllowedTeams(self);
384 if(!TeamSmallerEqThanTeam(Team_TeamToNumber(selection), Team_TeamToNumber(self.team), self))
386 Send_Notification(NOTIF_ONE, self, MSG_INFO, INFO_TEAMCHANGE_LARGERTEAM);
390 ClientKill_TeamChange(selection);
395 sprint(self, "^7The game has already begun, you must wait until the next map to be able to join a team.\n");
397 sprint(self, "^7selectteam can not be used as your team is forced\n");
399 sprint(self, "^7selectteam can only be used in teamgames\n");
406 sprint(self, "Incorrect parameters for ^2selectteam^7\n");
407 case CMD_REQUEST_USAGE:
409 sprint(self, "\nUsage:^3 cmd selectteam team\n");
410 sprint(self, " Where 'team' is the prefered team to try and join.\n");
411 sprint(self, " Full list of options here: \"red, blue, yellow, pink, auto\"\n");
417 void ClientCommand_selfstuff(float request, string command)
421 case CMD_REQUEST_COMMAND:
425 stuffcmd(self, substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)));
431 sprint(self, "Incorrect parameters for ^2selectteam^7\n");
432 case CMD_REQUEST_USAGE:
434 sprint(self, "\nUsage:^3 cmd selfstuff <command>\n");
435 sprint(self, " Where 'command' is the string to be stuffed to your client.\n");
441 void ClientCommand_sentcvar(float request, float argc, string command)
445 case CMD_REQUEST_COMMAND:
452 if(argc == 2) // undefined cvar: use the default value on the server then
454 s = strcat(substring(command, argv_start_index(0), argv_end_index(1) - argv_start_index(0)), " \"", cvar_defstring(argv(1)), "\"");
465 sprint(self, "Incorrect parameters for ^2sentcvar^7\n");
466 case CMD_REQUEST_USAGE:
468 sprint(self, "\nUsage:^3 cmd sentcvar <cvar>\n");
469 sprint(self, " Where 'cvar' is the cvar plus arguments to send to the server.\n");
475 void ClientCommand_spectate(float request)
479 case CMD_REQUEST_COMMAND:
485 if(self.lms_spectate_warning)
487 // for the forfeit message...
488 self.lms_spectate_warning = 2;
489 // mark player as spectator
490 PlayerScore_Add(self, SP_LMS_RANK, 666 - PlayerScore_Add(self, SP_LMS_RANK, 0));
494 self.lms_spectate_warning = 1;
495 sprint(self, "WARNING: you won't be able to enter the game again after spectating in LMS. Use the same command again to spectate anyway.\n");
500 if((IS_PLAYER(self) || self.caplayer) && autocvar_sv_spectate == 1)
502 if(self.caplayer && (IS_SPEC(self) || IS_OBSERVER(self)))
503 Send_Notification(NOTIF_ONE_ONLY, self, MSG_INFO, INFO_CA_LEAVE);
504 ClientKill_TeamChange(-2); // observe
507 return; // never fall through to usage
511 case CMD_REQUEST_USAGE:
513 sprint(self, "\nUsage:^3 cmd spectate\n");
514 sprint(self, " No arguments required.\n");
520 void ClientCommand_suggestmap(float request, float argc)
524 case CMD_REQUEST_COMMAND:
528 sprint(self, strcat(MapVote_Suggest(argv(1)), "\n"));
534 sprint(self, "Incorrect parameters for ^2suggestmap^7\n");
535 case CMD_REQUEST_USAGE:
537 sprint(self, "\nUsage:^3 cmd suggestmap map\n");
538 sprint(self, " Where 'map' is the name of the map to suggest.\n");
544 void ClientCommand_tell(float request, float argc, string command)
548 case CMD_REQUEST_COMMAND:
552 entity tell_to = GetIndexedEntity(argc, 1);
553 float tell_accepted = VerifyClientEntity(tell_to, true, false);
555 if(tell_accepted > 0) // the target is a real client
557 if(tell_to != self) // and we're allowed to send to them :D
559 Say(self, false, tell_to, substring(command, argv_start_index(next_token), argv_end_index(-1) - argv_start_index(next_token)), true);
562 else { print_to(self, "You can't ^2tell^7 a message to yourself."); return; }
564 else if(argv(1) == "#0")
566 trigger_magicear_processmessage_forallears(self, -1, world, substring(command, argv_start_index(next_token), argv_end_index(-1) - argv_start_index(next_token)));
569 else { print_to(self, strcat("tell: ", GetClientErrorString(tell_accepted, argv(1)), ".")); return; }
574 sprint(self, "Incorrect parameters for ^2tell^7\n");
575 case CMD_REQUEST_USAGE:
577 sprint(self, "\nUsage:^3 cmd tell client <message>\n");
578 sprint(self, " Where 'client' is the entity number or name of the player to send 'message' to.\n");
584 void ClientCommand_voice(float request, float argc, string command)
588 case CMD_REQUEST_COMMAND:
593 VoiceMessage(argv(1), substring(command, argv_start_index(2), argv_end_index(-1) - argv_start_index(2)));
595 VoiceMessage(argv(1), "");
602 sprint(self, "Incorrect parameters for ^2voice^7\n");
603 case CMD_REQUEST_USAGE:
605 sprint(self, "\nUsage:^3 cmd voice messagetype <soundname>\n");
606 sprint(self, " 'messagetype' is the type of broadcast to do, like team only or such,\n");
607 sprint(self, " and 'soundname' is the string/filename of the sound/voice message to play.\n");
613 /* use this when creating a new command, making sure to place it in alphabetical order... also,
614 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
615 void ClientCommand_(float request)
619 case CMD_REQUEST_COMMAND:
622 return; // never fall through to usage
626 case CMD_REQUEST_USAGE:
628 sprint(self, "\nUsage:^3 cmd \n");
629 sprint(self, " No arguments required.\n");
637 // =====================================
638 // Macro system for networked commands
639 // =====================================
641 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
642 #define CLIENT_COMMANDS(request,arguments,command) \
643 CLIENT_COMMAND("autoswitch", ClientCommand_autoswitch(request, arguments), "Whether or not to switch automatically when getting a better weapon") \
644 CLIENT_COMMAND("checkfail", ClientCommand_checkfail(request, command), "Report if a client-side check failed") \
645 CLIENT_COMMAND("clientversion", ClientCommand_clientversion(request, arguments), "Release version of the game") \
646 CLIENT_COMMAND("mv_getpicture", ClientCommand_mv_getpicture(request, arguments), "Retrieve mapshot picture from the server") \
647 CLIENT_COMMAND("join", ClientCommand_join(request), "Become a player in the game") \
648 CLIENT_COMMAND("physics", ClientCommand_physics(request, arguments), "Change physics set") \
649 CLIENT_COMMAND("ready", ClientCommand_ready(request), "Qualify as ready to end warmup stage (or restart server if allowed)") \
650 CLIENT_COMMAND("say", ClientCommand_say(request, arguments, command), "Print a message to chat to all players") \
651 CLIENT_COMMAND("say_team", ClientCommand_say_team(request, arguments, command), "Print a message to chat to all team mates") \
652 CLIENT_COMMAND("selectteam", ClientCommand_selectteam(request, arguments), "Attempt to choose a team to join into") \
653 CLIENT_COMMAND("selfstuff", ClientCommand_selfstuff(request, command), "Stuffcmd a command to your own client") \
654 CLIENT_COMMAND("sentcvar", ClientCommand_sentcvar(request, arguments, command), "New system for sending a client cvar to the server") \
655 CLIENT_COMMAND("spectate", ClientCommand_spectate(request), "Become an observer") \
656 CLIENT_COMMAND("suggestmap", ClientCommand_suggestmap(request, arguments), "Suggest a map to the mapvote at match end") \
657 CLIENT_COMMAND("tell", ClientCommand_tell(request, arguments, command), "Send a message directly to a player") \
658 CLIENT_COMMAND("voice", ClientCommand_voice(request, arguments, command), "Send voice message via sound") \
661 void ClientCommand_macro_help()
663 #define CLIENT_COMMAND(name,function,description) \
664 { sprint(self, " ^2", name, "^7: ", description, "\n"); }
666 CLIENT_COMMANDS(0, 0, "");
667 #undef CLIENT_COMMAND
672 float ClientCommand_macro_command(float argc, string command)
674 #define CLIENT_COMMAND(name,function,description) \
675 { if(name == strtolower(argv(0))) { function; return true; } }
677 CLIENT_COMMANDS(CMD_REQUEST_COMMAND, argc, command);
678 #undef CLIENT_COMMAND
683 float ClientCommand_macro_usage(float argc)
685 #define CLIENT_COMMAND(name,function,description) \
686 { if(name == strtolower(argv(1))) { function; return true; } }
688 CLIENT_COMMANDS(CMD_REQUEST_USAGE, argc, "");
689 #undef CLIENT_COMMAND
694 void ClientCommand_macro_write_aliases(float fh)
696 #define CLIENT_COMMAND(name,function,description) \
697 { CMD_Write_Alias("qc_cmd_cmd", name, description); }
699 CLIENT_COMMANDS(0, 0, "");
700 #undef CLIENT_COMMAND
705 // ======================================
706 // Main Function Called By Engine (cmd)
707 // ======================================
708 // If this function exists, server game code parses clientcommand before the engine code gets it.
710 void SV_ParseClientCommand(string command)
712 // If invalid UTF-8, don't even parse it
713 string command2 = "";
714 float len = strlen(command);
716 for (i = 0; i < len; ++i)
717 command2 = strcat(command2, chr2str(str2chr(command, i)));
718 if (command != command2)
721 // if we're banned, don't even parse the command
722 if(Ban_MaybeEnforceBanOnce(self))
725 float argc = tokenize_console(command);
727 // for the mutator hook system
728 cmd_name = strtolower(argv(0));
730 cmd_string = command;
732 // Guide for working with argc arguments by example:
733 // argc: 1 - 2 - 3 - 4
734 // argv: 0 - 1 - 2 - 3
735 // cmd vote - master - login - password
738 switch(strtolower(argv(0)))
740 // exempt commands which are not subject to floodcheck
741 case "begin": break; // handled by engine in host_cmd.c
742 case "download": break; // handled by engine in cl_parse.c
743 case "mv_getpicture": break; // handled by server in this file
744 case "pause": break; // handled by engine in host_cmd.c
745 case "prespawn": break; // handled by engine in host_cmd.c
746 case "sentcvar": break; // handled by server in this file
747 case "spawn": break; // handled by engine in host_cmd.c
750 if(SV_ParseClientCommand_floodcheck())
751 break; // "true": continue, as we're not flooding yet
753 return; // "false": not allowed to continue, halt // print("^1ERROR: ^7ANTISPAM CAUGHT: ", command, ".\n");
756 /* NOTE: should this be disabled? It can be spammy perhaps, but hopefully it's okay for now */
757 if(argv(0) == "help")
761 sprint(self, "\nClient networked commands:\n");
762 ClientCommand_macro_help();
764 sprint(self, "\nCommon networked commands:\n");
765 CommonCommand_macro_help(self);
767 sprint(self, "\nUsage:^3 cmd COMMAND...^7, where possible commands are listed above.\n");
768 sprint(self, "For help about a specific command, type cmd help COMMAND\n");
771 else if(CommonCommand_macro_usage(argc, self)) // Instead of trying to call a command, we're going to see detailed information about it
775 else if(ClientCommand_macro_usage(argc)) // same, but for normal commands now
780 else if(MUTATOR_CALLHOOK(SV_ParseClientCommand))
782 return; // handled by a mutator
784 else if(CheatCommand(argc))
786 return; // handled by server/cheats.qc
788 else if(CommonCommand_macro_command(argc, self, command))
790 return; // handled by server/command/common.qc
792 else if(ClientCommand_macro_command(argc, command)) // continue as usual and scan for normal commands
794 return; // handled by one of the above ClientCommand_* functions
797 clientcommand(self, command);