3 #include <server/defs.qh>
4 #include <server/miscfunctions.qh>
6 #include <common/command/_mod.qh>
11 #include "../campaign.qh"
12 #include "../cheats.qh"
13 #include "../client.qh"
14 #include "../player.qh"
15 #include "../ipban.qh"
16 #include "../mapvoting.qh"
17 #include "../scores.qh"
18 #include "../teamplay.qh"
20 #include <server/mutators/_mod.qh>
21 #include <common/gamemodes/_mod.qh>
24 #include <common/vehicles/all.qh>
27 #include <common/constants.qh>
28 #include <common/deathtypes/all.qh>
29 #include <common/effects/all.qh>
30 #include <common/mapinfo.qh>
31 #include <common/notifications/all.qh>
32 #include <common/physics/player.qh>
33 #include <common/teams.qh>
34 #include <common/util.qh>
35 #include <common/mapobjects/triggers.qh>
37 #include <common/minigames/sv_minigames.qh>
39 #include <common/monsters/_mod.qh>
40 #include <common/monsters/sv_spawn.qh>
41 #include <common/monsters/sv_monsters.qh>
43 #include <lib/warpzone/common.qh>
45 // =========================================================
46 // Server side networked commands code, reworked by Samual
47 // Last updated: December 28th, 2011
48 // =========================================================
50 bool SV_ParseClientCommand_floodcheck(entity this)
52 entity store = IS_CLIENT(this) ? CS(this) : this; // unfortunately, we need to store these on the client initially
54 if (!timeout_status) // not while paused
56 if (time <= (store.cmd_floodtime + autocvar_sv_clientcommand_antispam_time))
58 store.cmd_floodcount += 1;
59 if (store.cmd_floodcount > autocvar_sv_clientcommand_antispam_count) return false; // too much spam, halt
63 store.cmd_floodtime = time;
64 store.cmd_floodcount = 1;
67 return true; // continue, as we're not flooding yet
71 // =======================
72 // Command Sub-Functions
73 // =======================
75 void ClientCommand_autoswitch(entity caller, float request, float argc)
79 case CMD_REQUEST_COMMAND:
83 CS(caller).autoswitch = InterpretBoolean(argv(1));
84 sprint(caller, strcat("^1autoswitch is currently turned ", (CS(caller).autoswitch ? "on" : "off"), ".\n"));
90 sprint(caller, "Incorrect parameters for ^2autoswitch^7\n");
91 case CMD_REQUEST_USAGE:
93 sprint(caller, "\nUsage:^3 cmd autoswitch selection\n");
94 sprint(caller, " Where 'selection' controls if autoswitch is on or off.\n");
100 void ClientCommand_clientversion(entity caller, float request, float argc) // internal command, used only by code
104 case CMD_REQUEST_COMMAND:
108 if (IS_CLIENT(caller))
110 CS(caller).version = ((argv(1) == "$gameversion") ? 1 : stof(argv(1)));
112 if (CS(caller).version < autocvar_gameversion_min || CS(caller).version > autocvar_gameversion_max)
114 CS(caller).version_mismatch = true;
115 ClientKill_TeamChange(caller, -2); // observe
117 else if (autocvar_g_campaign || autocvar_g_balance_teams)
119 // JoinBestTeam(caller, false, true);
121 else if (teamplay && !autocvar_sv_spectate && !(caller.team_forced > 0))
123 TRANSMUTE(Observer, caller); // really?
124 stuffcmd(caller, "menu_showteamselect\n");
133 sprint(caller, "Incorrect parameters for ^2clientversion^7\n");
134 case CMD_REQUEST_USAGE:
136 sprint(caller, "\nUsage:^3 cmd clientversion version\n");
137 sprint(caller, " Where 'version' is the game version reported by caller.\n");
143 void ClientCommand_mv_getpicture(entity caller, float request, float argc) // internal command, used only by code
147 case CMD_REQUEST_COMMAND:
151 if (intermission_running) MapVote_SendPicture(caller, stof(argv(1)));
158 sprint(caller, "Incorrect parameters for ^2mv_getpicture^7\n");
159 case CMD_REQUEST_USAGE:
161 sprint(caller, "\nUsage:^3 cmd mv_getpicture mapid\n");
162 sprint(caller, " Where 'mapid' is the id number of the map to request an image of on the map vote selection menu.\n");
168 void ClientCommand_join(entity caller, float request)
172 case CMD_REQUEST_COMMAND:
175 if (IS_CLIENT(caller) && !IS_PLAYER(caller))
176 if (joinAllowed(caller))
179 return; // never fall through to usage
183 case CMD_REQUEST_USAGE:
185 sprint(caller, "\nUsage:^3 cmd join\n");
186 sprint(caller, " No arguments required.\n");
192 void ClientCommand_physics(entity caller, float request, float argc)
196 case CMD_REQUEST_COMMAND:
198 string command = strtolower(argv(1));
200 if (!autocvar_g_physics_clientselect)
202 sprint(caller, "Client physics selection is currently disabled.\n");
206 if (command == "list" || command == "help")
208 sprint(caller, strcat("Available physics sets: \n\n", autocvar_g_physics_clientselect_options, " default\n"));
212 if (Physics_Valid(command) || command == "default")
214 stuffcmd(caller, strcat("\nseta cl_physics ", command, "\nsendcvar cl_physics\n"));
215 sprint(caller, strcat("^2Physics set successfully changed to ^3", command, "\n"));
221 sprint(caller, strcat("Current physics set: ^3", CS(caller).cvar_cl_physics, "\n"));
222 case CMD_REQUEST_USAGE:
224 sprint(caller, "\nUsage:^3 cmd physics <physics>\n");
225 sprint(caller, " See 'cmd physics list' for available physics sets.\n");
226 sprint(caller, " Argument 'default' resets to standard physics.\n");
232 void ClientCommand_ready(entity caller, float request) // todo: anti-spam for toggling readyness
236 case CMD_REQUEST_COMMAND:
238 if (IS_CLIENT(caller))
240 if (warmup_stage || sv_ready_restart || g_race_qualifying == 2)
242 if (!readyrestart_happened || sv_ready_restart_repeatable)
244 if (time < game_starttime) // game is already restarting
246 if (caller.ready) // toggle
248 caller.ready = false;
249 if(IS_PLAYER(caller) || caller.caplayer == 1)
250 bprint(playername(caller, false), "^2 is ^1NOT^2 ready\n");
255 if(IS_PLAYER(caller) || caller.caplayer == 1)
256 bprint(playername(caller, false), "^2 is ready\n");
259 // cannot reset the game while a timeout is active!
260 if (!timeout_status) ReadyCount();
264 sprint(caller, "^1Game has already been restarted\n");
268 return; // never fall through to usage
272 case CMD_REQUEST_USAGE:
274 sprint(caller, "\nUsage:^3 cmd ready\n");
275 sprint(caller, " No arguments required.\n");
281 void ClientCommand_say(entity caller, float request, float argc, string command)
285 case CMD_REQUEST_COMMAND:
287 if (argc >= 2) Say(caller, false, NULL, substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)), 1);
288 return; // never fall through to usage
292 case CMD_REQUEST_USAGE:
294 sprint(caller, "\nUsage:^3 cmd say <message>\n");
295 sprint(caller, " Where 'message' is the string of text to say.\n");
301 void ClientCommand_say_team(entity caller, float request, float argc, string command)
305 case CMD_REQUEST_COMMAND:
307 if (argc >= 2) Say(caller, true, NULL, substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)), 1);
308 return; // never fall through to usage
312 case CMD_REQUEST_USAGE:
314 sprint(caller, "\nUsage:^3 cmd say_team <message>\n");
315 sprint(caller, " Where 'message' is the string of text to say.\n");
322 void ClientCommand_selectteam(entity caller, float request, float argc)
326 case CMD_REQUEST_COMMAND:
332 if (!IS_CLIENT(caller))
338 sprint(caller, "^7selectteam can only be used in teamgames\n");
341 if (caller.team_forced > 0)
343 sprint(caller, "^7selectteam can not be used as your team is forced\n");
348 sprint(caller, "^7The game has already begun, you must wait until the next map to be able to join a team.\n");
356 selection = NUM_TEAM_1;
361 selection = NUM_TEAM_2;
366 selection = NUM_TEAM_3;
371 selection = NUM_TEAM_4;
384 if (caller.team == selection && selection != -1 && !IS_DEAD(caller))
386 sprint(caller, "^7You already are on that team.\n");
389 if (CS(caller).wasplayer && autocvar_g_changeteam_banned)
391 sprint(caller, "^1You cannot change team, forbidden by the server.\n");
394 if ((selection != -1) && autocvar_g_balance_teams &&
395 autocvar_g_balance_teams_prevent_imbalance)
397 entity balance = TeamBalance_CheckAllowedTeams(caller);
398 TeamBalance_GetTeamCounts(balance, caller);
399 if ((Team_IndexToBit(Team_TeamToIndex(selection)) &
400 TeamBalance_FindBestTeams(balance, caller, false)) == 0)
402 Send_Notification(NOTIF_ONE, caller, MSG_INFO, INFO_TEAMCHANGE_LARGERTEAM);
403 TeamBalance_Destroy(balance);
406 TeamBalance_Destroy(balance);
408 ClientKill_TeamChange(caller, selection);
409 if (!IS_PLAYER(caller))
411 caller.team_selected = true; // avoids asking again for team selection on join
416 sprint(caller, "Incorrect parameters for ^2selectteam^7\n");
417 case CMD_REQUEST_USAGE:
419 sprint(caller, "\nUsage:^3 cmd selectteam team\n");
420 sprint(caller, " Where 'team' is the prefered team to try and join.\n");
421 sprint(caller, " Full list of options here: \"red, blue, yellow, pink, auto\"\n");
427 void ClientCommand_selfstuff(entity caller, float request, string command)
431 case CMD_REQUEST_COMMAND:
435 stuffcmd(caller, substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)));
441 sprint(caller, "Incorrect parameters for ^2selfstuff^7\n");
442 case CMD_REQUEST_USAGE:
444 sprint(caller, "\nUsage:^3 cmd selfstuff <command>\n");
445 sprint(caller, " Where 'command' is the string to be stuffed to your client.\n");
451 void ClientCommand_sentcvar(entity caller, float request, float argc, string command)
455 case CMD_REQUEST_COMMAND:
462 if (argc == 2) // undefined cvar: use the default value on the server then
464 s = strcat(substring(command, argv_start_index(0), argv_end_index(1) - argv_start_index(0)), " \"", cvar_defstring(argv(1)), "\"");
468 GetCvars(caller, CS(caller), 1);
475 sprint(caller, "Incorrect parameters for ^2sentcvar^7\n");
476 case CMD_REQUEST_USAGE:
478 sprint(caller, "\nUsage:^3 cmd sentcvar <cvar>\n");
479 sprint(caller, " Where 'cvar' is the cvar plus arguments to send to the server.\n");
485 void ClientCommand_spectate(entity caller, float request)
489 case CMD_REQUEST_COMMAND:
491 if (!intermission_running && IS_CLIENT(caller))
493 if((IS_SPEC(caller) || IS_OBSERVER(caller)) && argv(1) != "")
495 entity client = GetFilteredEntity(argv(1));
496 int spec_accepted = VerifyClientEntity(client, false, false);
497 if(spec_accepted > 0 && IS_PLAYER(client))
499 if(Spectate(caller, client))
500 return; // fall back to regular handling
504 int mutator_returnvalue = MUTATOR_CALLHOOK(ClientCommand_Spectate, caller);
506 if (mutator_returnvalue == MUT_SPECCMD_RETURN) return;
508 if ((IS_PLAYER(caller) || mutator_returnvalue == MUT_SPECCMD_FORCE))
509 if (autocvar_sv_spectate == 1)
510 ClientKill_TeamChange(caller, -2); // observe
512 return; // never fall through to usage
516 case CMD_REQUEST_USAGE:
518 sprint(caller, "\nUsage:^3 cmd spectate <client>\n");
519 sprint(caller, " Where 'client' can be the player to spectate.\n");
525 void ClientCommand_suggestmap(entity caller, float request, float argc)
529 case CMD_REQUEST_COMMAND:
533 sprint(caller, strcat(MapVote_Suggest(caller, argv(1)), "\n"));
539 sprint(caller, "Incorrect parameters for ^2suggestmap^7\n");
540 case CMD_REQUEST_USAGE:
542 sprint(caller, "\nUsage:^3 cmd suggestmap map\n");
543 sprint(caller, " Where 'map' is the name of the map to suggest.\n");
549 void ClientCommand_tell(entity caller, float request, float argc, string command)
553 case CMD_REQUEST_COMMAND:
557 if(!IS_CLIENT(caller) && IS_REAL_CLIENT(caller)) // connecting
559 print_to(caller, "You can't ^2tell^7 a message while connecting.");
563 entity tell_to = GetIndexedEntity(argc, 1);
564 float tell_accepted = VerifyClientEntity(tell_to, true, false);
566 if (tell_accepted > 0) // the target is a real client
568 if (tell_to != caller) // and we're allowed to send to them :D
570 // workaround for argv indexes indexing ascii chars instead of utf8 chars
571 // In this case when the player name contains utf8 chars
572 // the message gets partially trimmed in the beginning.
573 // Potentially this bug affects any substring call that uses
574 // argv_start_index and argv_end_index.
576 string utf8_enable_save = cvar_string("utf8_enable");
577 cvar_set("utf8_enable", "0");
578 string msg = substring(command, argv_start_index(next_token), argv_end_index(-1) - argv_start_index(next_token));
579 cvar_set("utf8_enable", utf8_enable_save);
581 Say(caller, false, tell_to, msg, true);
584 else { print_to(caller, "You can't ^2tell^7 a message to yourself."); return; }
586 else if (argv(1) == "#0")
588 trigger_magicear_processmessage_forallears(caller, -1, NULL, substring(command, argv_start_index(next_token), argv_end_index(-1) - argv_start_index(next_token)));
591 else { print_to(caller, strcat("tell: ", GetClientErrorString(tell_accepted, argv(1)), ".")); return; }
596 sprint(caller, "Incorrect parameters for ^2tell^7\n");
597 case CMD_REQUEST_USAGE:
599 sprint(caller, "\nUsage:^3 cmd tell client <message>\n");
600 sprint(caller, " Where 'client' is the entity number or name of the player to send 'message' to.\n");
606 void ClientCommand_voice(entity caller, float request, float argc, string command)
610 case CMD_REQUEST_COMMAND:
614 entity e = GetVoiceMessage(argv(1));
617 sprint(caller, sprintf("Invalid voice. Use one of: %s\n", allvoicesamples));
622 msg = substring(command, argv_start_index(2), argv_end_index(-1) - argv_start_index(2));
623 VoiceMessage(caller, e, msg);
630 sprint(caller, "Incorrect parameters for ^2voice^7\n");
631 case CMD_REQUEST_USAGE:
633 sprint(caller, "\nUsage:^3 cmd voice messagetype <soundname>\n");
634 sprint(caller, " 'messagetype' is the type of broadcast to do, like team only or such,\n");
635 sprint(caller, " and 'soundname' is the string/filename of the sound/voice message to play.\n");
641 /* use this when creating a new command, making sure to place it in alphabetical order... also,
642 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
643 void ClientCommand_(entity caller, float request)
647 case CMD_REQUEST_COMMAND:
650 return; // never fall through to usage
654 case CMD_REQUEST_USAGE:
656 sprint(caller, "\nUsage:^3 cmd \n");
657 sprint(caller, " No arguments required.\n");
665 // =====================================
666 // Macro system for networked commands
667 // =====================================
669 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
670 #define CLIENT_COMMANDS(ent, request, arguments, command) \
671 CLIENT_COMMAND("autoswitch", ClientCommand_autoswitch(ent, request, arguments), "Whether or not to switch automatically when getting a better weapon") \
672 CLIENT_COMMAND("clientversion", ClientCommand_clientversion(ent, request, arguments), "Release version of the game") \
673 CLIENT_COMMAND("mv_getpicture", ClientCommand_mv_getpicture(ent, request, arguments), "Retrieve mapshot picture from the server") \
674 CLIENT_COMMAND("join", ClientCommand_join(ent, request), "Become a player in the game") \
675 CLIENT_COMMAND("physics", ClientCommand_physics(ent, request, arguments), "Change physics set") \
676 CLIENT_COMMAND("ready", ClientCommand_ready(ent, request), "Qualify as ready to end warmup stage (or restart server if allowed)") \
677 CLIENT_COMMAND("say", ClientCommand_say(ent, request, arguments, command), "Print a message to chat to all players") \
678 CLIENT_COMMAND("say_team", ClientCommand_say_team(ent, request, arguments, command), "Print a message to chat to all team mates") \
679 CLIENT_COMMAND("selectteam", ClientCommand_selectteam(ent, request, arguments), "Attempt to choose a team to join into") \
680 CLIENT_COMMAND("selfstuff", ClientCommand_selfstuff(ent, request, command), "Stuffcmd a command to your own client") \
681 CLIENT_COMMAND("sentcvar", ClientCommand_sentcvar(ent, request, arguments, command), "New system for sending a client cvar to the server") \
682 CLIENT_COMMAND("spectate", ClientCommand_spectate(ent, request), "Become an observer") \
683 CLIENT_COMMAND("suggestmap", ClientCommand_suggestmap(ent, request, arguments), "Suggest a map to the mapvote at match end") \
684 CLIENT_COMMAND("tell", ClientCommand_tell(ent, request, arguments, command), "Send a message directly to a player") \
685 CLIENT_COMMAND("voice", ClientCommand_voice(ent, request, arguments, command), "Send voice message via sound") \
686 CLIENT_COMMAND("minigame", ClientCommand_minigame(ent, request, arguments, command), "Start a minigame") \
689 void ClientCommand_macro_help(entity caller)
691 #define CLIENT_COMMAND(name, function, description) \
692 { sprint(caller, " ^2", name, "^7: ", description, "\n"); }
694 CLIENT_COMMANDS(NULL, 0, 0, "");
695 #undef CLIENT_COMMAND
698 float ClientCommand_macro_command(float argc, entity caller, string command)
700 #define CLIENT_COMMAND(name, function, description) \
701 { if (name == strtolower(argv(0))) { function; return true; } }
703 CLIENT_COMMANDS(caller, CMD_REQUEST_COMMAND, argc, command);
704 #undef CLIENT_COMMAND
709 float ClientCommand_macro_usage(float argc, entity caller)
711 #define CLIENT_COMMAND(name, function, description) \
712 { if (name == strtolower(argv(1))) { function; return true; } }
714 CLIENT_COMMANDS(caller, CMD_REQUEST_USAGE, argc, "");
715 #undef CLIENT_COMMAND
720 void ClientCommand_macro_write_aliases(float fh)
722 #define CLIENT_COMMAND(name, function, description) \
723 { CMD_Write_Alias("qc_cmd_cmd", name, description); }
725 CLIENT_COMMANDS(NULL, 0, 0, "");
726 #undef CLIENT_COMMAND
729 // ======================================
730 // Main Function Called By Engine (cmd)
731 // ======================================
732 // If this function exists, server game code parses clientcommand before the engine code gets it.
734 void SV_ParseClientCommand(entity this, string command)
736 // If invalid UTF-8, don't even parse it
737 string command2 = "";
738 float len = strlen(command);
740 for (i = 0; i < len; ++i)
741 command2 = strcat(command2, chr2str(str2chr(command, i)));
742 if (command != command2) return;
744 // if we're banned, don't even parse the command
745 if (Ban_MaybeEnforceBanOnce(this)) return;
747 float argc = tokenize_console(command);
749 // Guide for working with argc arguments by example:
750 // argc: 1 - 2 - 3 - 4
751 // argv: 0 - 1 - 2 - 3
752 // cmd vote - master - login - password
755 switch (strtolower(argv(0)))
757 // exempt commands which are not subject to floodcheck
758 case "begin": break; // handled by engine in host_cmd.c
759 case "download": break; // handled by engine in cl_parse.c
760 case "mv_getpicture": break; // handled by server in this file
761 case "pause": break; // handled by engine in host_cmd.c
762 case "prespawn": break; // handled by engine in host_cmd.c
763 case "sentcvar": break; // handled by server in this file
764 case "spawn": break; // handled by engine in host_cmd.c
765 case "c2s": Net_ClientCommand(this, command); return; // handled by net.qh
768 if (SV_ParseClientCommand_floodcheck(this)) break; // "true": continue, as we're not flooding yet
769 else return; // "false": not allowed to continue, halt // print("^1ERROR: ^7ANTISPAM CAUGHT: ", command, ".\n");
772 /* NOTE: should this be disabled? It can be spammy perhaps, but hopefully it's okay for now */
773 if (argv(0) == "help")
777 sprint(this, "\nClient networked commands:\n");
778 ClientCommand_macro_help(this);
780 sprint(this, "\nCommon networked commands:\n");
781 CommonCommand_macro_help(this);
783 sprint(this, "\nUsage:^3 cmd COMMAND...^7, where possible commands are listed above.\n");
784 sprint(this, "For help about a specific command, type cmd help COMMAND\n");
787 else if (CommonCommand_macro_usage(argc, this)) // Instead of trying to call a command, we're going to see detailed information about it
791 else if (ClientCommand_macro_usage(argc, this)) // same, but for normal commands now
796 else if (MUTATOR_CALLHOOK(SV_ParseClientCommand, this, strtolower(argv(0)), argc, command))
798 return; // handled by a mutator
800 else if (CheatCommand(this, argc))
802 return; // handled by server/cheats.qc
804 else if (CommonCommand_macro_command(argc, this, command))
806 return; // handled by server/command/common.qc
808 else if (ClientCommand_macro_command(argc, this, command)) // continue as usual and scan for normal commands
810 return; // handled by one of the above ClientCommand_* functions
814 clientcommand(this, command);