4 #include "../../dpdefs/progsdefs.qh"
5 #include "../../dpdefs/dpextensions.qh"
6 #include "../sys-post.qh"
7 #include "../../common/util.qh"
8 #include "../../common/counting.qh"
9 #include "../../common/command/shared_defs.qh"
10 #include "../autocvars.qh"
12 #include "../../common/notifications.qh"
15 #include "../scores.qh"
18 // ====================================================
19 // Shared code for server commands, written by Samual
20 // Last updated: December 27th, 2011
21 // ====================================================
23 // select the proper prefix for usage and other messages
24 string GetCommandPrefix(entity caller)
32 // if client return player nickname, or if server return admin nickname
33 string GetCallerName(entity caller)
36 return caller.netname;
38 return admin_name(); //((autocvar_sv_adminnick != "") ? autocvar_sv_adminnick : autocvar_hostname);
41 // verify that the client provided is acceptable for use
42 float VerifyClientEntity(entity client, float must_be_real, float must_be_bots)
44 if (!IS_CLIENT(client))
45 return CLIENT_DOESNT_EXIST;
46 else if(must_be_real && !IS_REAL_CLIENT(client))
47 return CLIENT_NOT_REAL;
48 else if(must_be_bots && !IS_BOT_CLIENT(client))
49 return CLIENT_NOT_BOT;
51 return CLIENT_ACCEPTABLE;
54 // if the client is not acceptable, return a string to be used for error messages
55 string GetClientErrorString(float clienterror, string original_input)
59 case CLIENT_DOESNT_EXIST: { return strcat("Client '", original_input, "' doesn't exist"); }
60 case CLIENT_NOT_REAL: { return strcat("Client '", original_input, "' is not real"); }
61 case CLIENT_NOT_BOT: { return strcat("Client '", original_input, "' is not a bot"); }
62 default: { return "Incorrect usage of GetClientErrorString"; }
66 // is this entity number even in the possible range of entities?
67 float VerifyClientNumber(float tmp_number)
69 if((tmp_number < 1) || (tmp_number > maxclients))
75 entity GetIndexedEntity(float argc, float start_index)
77 entity tmp_player, selection;
78 float tmp_number, index;
85 if(argc > start_index)
87 if(substring(argv(index), 0, 1) == "#")
89 tmp_string = substring(argv(index), 1, -1);
92 if(tmp_string != "") // is it all one token? like #1
94 tmp_number = stof(tmp_string);
96 else if(argc > index) // no, it's two tokens? # 1
98 tmp_number = stof(argv(index));
104 else // maybe it's ONLY a number?
106 tmp_number = stof(argv(index));
110 if(VerifyClientNumber(tmp_number))
112 selection = edict_num(tmp_number); // yes, it was a number
114 else // no, maybe it's a name?
116 FOR_EACH_CLIENT(tmp_player)
117 if (strdecolorize(tmp_player.netname) == strdecolorize(argv(start_index)))
118 selection = tmp_player;
120 index = (start_index + 1);
125 //print(strcat("start_index: ", ftos(start_index), ", next_token: ", ftos(next_token), ", edict: ", ftos(num_for_edict(selection)), ".\n"));
129 // find a player which matches the input string, and return their entity
130 entity GetFilteredEntity(string input)
132 entity tmp_player, selection;
135 if(substring(input, 0, 1) == "#")
136 tmp_number = stof(substring(input, 1, -1));
138 tmp_number = stof(input);
140 if(VerifyClientNumber(tmp_number))
142 selection = edict_num(tmp_number);
147 FOR_EACH_CLIENT(tmp_player)
148 if (strdecolorize(tmp_player.netname) == strdecolorize(input))
149 selection = tmp_player;
155 // same thing, but instead return their edict number
156 float GetFilteredNumber(string input)
158 entity selection = GetFilteredEntity(input);
161 output = num_for_edict(selection);
166 // switch between sprint and print depending on whether the receiver is the server or a player
167 void print_to(entity to, string input)
170 sprint(to, strcat(input, "\n"));
175 // ==========================================
176 // Supporting functions for common commands
177 // ==========================================
179 // used by CommonCommand_timeout() and CommonCommand_timein() to handle game pausing and messaging and such.
180 void timeout_handler_reset()
182 timeout_caller = world;
184 timeout_leadtime = 0;
189 void timeout_handler_think()
193 switch(timeout_status)
197 if(timeout_time > 0) // countdown is still going
199 Send_Notification(NOTIF_ALL, world, MSG_CENTER, CENTER_TIMEOUT_ENDING, timeout_time);
201 if(timeout_time == autocvar_sv_timeout_resumetime) // play a warning sound when only <sv_timeout_resumetime> seconds are left
202 Send_Notification(NOTIF_ALL, world, MSG_ANNCE, ANNCE_PREPARE);
204 self.nextthink = time + TIMEOUT_SLOWMO_VALUE; // think again in one second
205 timeout_time -= 1; // decrease the time counter
207 else // time to end the timeout
209 timeout_status = TIMEOUT_INACTIVE;
211 // reset the slowmo value back to normal
212 cvar_set("slowmo", ftos(orig_slowmo));
214 // unlock the view for players so they can move around again
215 FOR_EACH_REALPLAYER(tmp_player)
216 tmp_player.fixangle = false;
218 timeout_handler_reset();
224 case TIMEOUT_LEADTIME:
226 if(timeout_leadtime > 0) // countdown is still going
228 Send_Notification(NOTIF_ALL, world, MSG_CENTER, CENTER_TIMEOUT_BEGINNING, timeout_leadtime);
230 self.nextthink = time + 1; // think again in one second
231 timeout_leadtime -= 1; // decrease the time counter
233 else // time to begin the timeout
235 timeout_status = TIMEOUT_ACTIVE;
237 // set the slowmo value to the timeout default slowmo value
238 cvar_set("slowmo", ftos(TIMEOUT_SLOWMO_VALUE));
240 // reset all the flood variables
241 FOR_EACH_CLIENT(tmp_player)
242 tmp_player.nickspamcount = tmp_player.nickspamtime = tmp_player.floodcontrol_chat =
243 tmp_player.floodcontrol_chatteam = tmp_player.floodcontrol_chattell =
244 tmp_player.floodcontrol_voice = tmp_player.floodcontrol_voiceteam = 0;
246 // copy .v_angle to .lastV_angle for every player in order to fix their view during pause (see PlayerPreThink)
247 FOR_EACH_REALPLAYER(tmp_player)
248 tmp_player.lastV_angle = tmp_player.v_angle;
250 self.nextthink = time; // think again next frame to handle it under TIMEOUT_ACTIVE code
257 case TIMEOUT_INACTIVE:
260 timeout_handler_reset();
268 // ===================================================
269 // Common commands used in both sv_cmd.qc and cmd.qc
270 // ===================================================
272 void CommonCommand_cvar_changes(float request, entity caller)
276 case CMD_REQUEST_COMMAND:
278 print_to(caller, cvar_changes);
279 return; // never fall through to usage
283 case CMD_REQUEST_USAGE:
285 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " cvar_changes"));
286 print_to(caller, " No arguments required.");
287 print_to(caller, "See also: ^2cvar_purechanges^7");
293 void CommonCommand_cvar_purechanges(float request, entity caller)
297 case CMD_REQUEST_COMMAND:
299 print_to(caller, cvar_purechanges);
300 return; // never fall through to usage
304 case CMD_REQUEST_USAGE:
306 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " cvar_purechanges"));
307 print_to(caller, " No arguments required.");
308 print_to(caller, "See also: ^2cvar_changes^7");
314 void CommonCommand_info(float request, entity caller, float argc)
318 case CMD_REQUEST_COMMAND:
320 string command = builtin_cvar_string(strcat("sv_info_", argv(1)));
323 wordwrap_sprint(command, 1000);
325 print_to(caller, "ERROR: unsupported info command");
327 return; // never fall through to usage
331 case CMD_REQUEST_USAGE:
333 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " info request"));
334 print_to(caller, " Where 'request' is the suffixed string appended onto the request for cvar.");
340 void CommonCommand_ladder(float request, entity caller)
344 case CMD_REQUEST_COMMAND:
346 print_to(caller, ladder_reply);
347 return; // never fall through to usage
351 case CMD_REQUEST_USAGE:
353 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " ladder"));
354 print_to(caller, " No arguments required.");
360 void CommonCommand_lsmaps(float request, entity caller)
364 case CMD_REQUEST_COMMAND:
366 print_to(caller, lsmaps_reply);
367 return; // never fall through to usage
371 case CMD_REQUEST_USAGE:
373 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " lsmaps"));
374 print_to(caller, " No arguments required.");
380 void CommonCommand_printmaplist(float request, entity caller)
384 case CMD_REQUEST_COMMAND:
386 print_to(caller, maplist_reply);
387 return; // never fall through to usage
391 case CMD_REQUEST_USAGE:
393 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " printmaplist"));
394 print_to(caller, " No arguments required.");
400 void CommonCommand_rankings(float request, entity caller)
404 case CMD_REQUEST_COMMAND:
406 print_to(caller, rankings_reply);
407 return; // never fall through to usage
411 case CMD_REQUEST_USAGE:
413 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " rankings"));
414 print_to(caller, " No arguments required.");
420 void CommonCommand_records(float request, entity caller)
424 case CMD_REQUEST_COMMAND:
428 for(i = 0; i < 10; ++i)
429 if(records_reply[i] != "")
430 print_to(caller, records_reply[i]);
432 return; // never fall through to usage
436 case CMD_REQUEST_USAGE:
438 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " records"));
439 print_to(caller, " No arguments required.");
445 void CommonCommand_teamstatus(float request, entity caller)
449 case CMD_REQUEST_COMMAND:
451 Score_NicePrint(caller);
452 return; // never fall through to usage
456 case CMD_REQUEST_USAGE:
458 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " teamstatus"));
459 print_to(caller, " No arguments required.");
465 void CommonCommand_time(float request, entity caller)
469 case CMD_REQUEST_COMMAND:
471 print_to(caller, strcat("time = ", ftos(time)));
472 print_to(caller, strcat("frame start = ", ftos(gettime(GETTIME_FRAMESTART))));
473 print_to(caller, strcat("realtime = ", ftos(gettime(GETTIME_REALTIME))));
474 print_to(caller, strcat("hires = ", ftos(gettime(GETTIME_HIRES))));
475 print_to(caller, strcat("uptime = ", ftos(gettime(GETTIME_UPTIME))));
476 print_to(caller, strcat("localtime = ", strftime(true, "%a %b %e %H:%M:%S %Z %Y")));
477 print_to(caller, strcat("gmtime = ", strftime(false, "%a %b %e %H:%M:%S %Z %Y")));
482 case CMD_REQUEST_USAGE:
484 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " time"));
485 print_to(caller, " No arguments required.");
491 void CommonCommand_timein(float request, entity caller)
495 case CMD_REQUEST_COMMAND:
497 if(!caller || autocvar_sv_timeout)
499 if (!timeout_status) { print_to(caller, "^7Error: There is no active timeout called."); }
500 else if(caller && (caller != timeout_caller)) { print_to(caller, "^7Error: You are not allowed to stop the active timeout."); }
502 else // everything should be okay, continue aborting timeout
504 switch(timeout_status)
506 case TIMEOUT_LEADTIME:
508 timeout_status = TIMEOUT_INACTIVE;
510 timeout_handler.nextthink = time; // timeout_handler has to take care of it immediately
511 bprint(strcat("^7The timeout was aborted by ", GetCallerName(caller), " !\n"));
517 timeout_time = autocvar_sv_timeout_resumetime;
518 timeout_handler.nextthink = time; // timeout_handler has to take care of it immediately
519 bprint(strcat("^1Attention: ^7", GetCallerName(caller), " resumed the game! Prepare for battle!\n"));
523 default: dprint("timeout status was inactive, but this code was executed anyway?"); return;
527 else { print_to(caller, "^1Timeins are not allowed to be called, enable them with sv_timeout 1.\n"); }
529 return; // never fall through to usage
533 case CMD_REQUEST_USAGE:
535 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " timein"));
536 print_to(caller, " No arguments required.");
542 void CommonCommand_timeout(float request, entity caller) // DEAR GOD THIS COMMAND IS TERRIBLE.
546 case CMD_REQUEST_COMMAND:
548 if(!caller || autocvar_sv_timeout)
550 float last_possible_timeout = ((autocvar_timelimit * 60) - autocvar_sv_timeout_leadtime - 1);
552 if(timeout_status) { print_to(caller, "^7Error: A timeout is already active."); }
553 else if(vote_called) { print_to(caller, "^7Error: You can not call a timeout while a vote is active."); }
554 else if(warmup_stage && !g_warmup_allow_timeout) { print_to(caller, "^7Error: You can not call a timeout in warmup-stage."); }
555 else if(time < game_starttime) { print_to(caller, "^7Error: You can not call a timeout while the map is being restarted."); }
556 else if(caller && (caller.allowed_timeouts < 1)) { print_to(caller, "^7Error: You already used all your timeout calls for this map."); }
557 else if(caller && !IS_PLAYER(caller)) { print_to(caller, "^7Error: You must be a player to call a timeout."); }
558 else if((autocvar_timelimit) && (last_possible_timeout < time - game_starttime)) { print_to(caller, "^7Error: It is too late to call a timeout now!"); }
560 else // everything should be okay, proceed with starting the timeout
562 if(caller) { caller.allowed_timeouts -= 1; }
564 bprint(GetCallerName(caller), " ^7called a timeout", (caller ? strcat(" (", ftos(caller.allowed_timeouts), " timeout(s) left)") : ""), "!\n"); // write a bprint who started the timeout (and how many they have left)
566 timeout_status = TIMEOUT_LEADTIME;
567 timeout_caller = caller;
568 timeout_time = autocvar_sv_timeout_length;
569 timeout_leadtime = autocvar_sv_timeout_leadtime;
571 timeout_handler = spawn();
572 timeout_handler.think = timeout_handler_think;
573 timeout_handler.nextthink = time; // always let the entity think asap
575 Send_Notification(NOTIF_ALL, world, MSG_ANNCE, ANNCE_TIMEOUT);
578 else { print_to(caller, "^1Timeouts are not allowed to be called, enable them with sv_timeout 1.\n"); }
580 return; // never fall through to usage
584 case CMD_REQUEST_USAGE:
586 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " timeout"));
587 print_to(caller, " No arguments required.");
593 void CommonCommand_who(float request, entity caller, float argc)
597 case CMD_REQUEST_COMMAND:
599 float total_listed_players, is_bot;
602 float privacy = (caller && autocvar_sv_status_privacy);
603 string separator = strreplace("%", " ", strcat((argv(1) ? argv(1) : " "), "^7"));
604 string tmp_netaddress, tmp_crypto_idfp;
606 print_to(caller, strcat("List of client information", (privacy ? " (some data is hidden for privacy)" : ""), ":"));
607 print_to(caller, sprintf(strreplace(" ", separator, " %-4s %-20s %-5s %-3s %-9s %-16s %s "),
608 "ent", "nickname", "ping", "pl", "time", "ip", "crypto_id"));
610 total_listed_players = 0;
611 FOR_EACH_CLIENT(tmp_player)
613 is_bot = (IS_BOT_CLIENT(tmp_player));
617 tmp_netaddress = "null/botclient";
618 tmp_crypto_idfp = "null/botclient";
622 tmp_netaddress = "hidden";
623 tmp_crypto_idfp = "hidden";
627 tmp_netaddress = tmp_player.netaddress;
628 tmp_crypto_idfp = tmp_player.crypto_idfp;
631 print_to(caller, sprintf(strreplace(" ", separator, " #%-3d %-20.20s %-5d %-3d %-9s %-16s %s "),
632 num_for_edict(tmp_player),
635 tmp_player.ping_packetloss,
636 process_time(1, time - tmp_player.jointime),
640 ++total_listed_players;
643 print_to(caller, strcat("Finished listing ", ftos(total_listed_players), " client(s) out of ", ftos(maxclients), " slots."));
645 return; // never fall through to usage
649 case CMD_REQUEST_USAGE:
651 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " who [separator]"));
652 print_to(caller, " Where 'separator' is the optional string to separate the values with, default is a space.");
658 /* use this when creating a new command, making sure to place it in alphabetical order... also,
659 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
660 void CommonCommand_(float request, entity caller)
664 case CMD_REQUEST_COMMAND:
667 return; // never fall through to usage
671 case CMD_REQUEST_USAGE:
673 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " "));
674 print_to(caller, " No arguments required.");
682 // ==================================
683 // Macro system for common commands
684 // ==================================
686 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
687 #define COMMON_COMMANDS(request,caller,arguments,command) \
688 COMMON_COMMAND("cvar_changes", CommonCommand_cvar_changes(request, caller), "Prints a list of all changed server cvars") \
689 COMMON_COMMAND("cvar_purechanges", CommonCommand_cvar_purechanges(request, caller), "Prints a list of all changed gameplay cvars") \
690 COMMON_COMMAND("info", CommonCommand_info(request, caller, arguments), "Request for unique server information set up by admin") \
691 COMMON_COMMAND("ladder", CommonCommand_ladder(request, caller), "Get information about top players if supported") \
692 COMMON_COMMAND("lsmaps", CommonCommand_lsmaps(request, caller), "List maps which can be used with the current game mode") \
693 COMMON_COMMAND("printmaplist", CommonCommand_printmaplist(request, caller), "Display full server maplist reply") \
694 COMMON_COMMAND("rankings", CommonCommand_rankings(request, caller), "Print information about rankings") \
695 COMMON_COMMAND("records", CommonCommand_records(request, caller), "List top 10 records for the current map") \
696 COMMON_COMMAND("teamstatus", CommonCommand_teamstatus(request, caller), "Show information about player and team scores") \
697 COMMON_COMMAND("time", CommonCommand_time(request, caller), "Print different formats/readouts of time") \
698 COMMON_COMMAND("timein", CommonCommand_timein(request, caller), "Resume the game from being paused with a timeout") \
699 COMMON_COMMAND("timeout", CommonCommand_timeout(request, caller), "Call a timeout which pauses the game for certain amount of time unless unpaused") \
700 COMMON_COMMAND("vote", VoteCommand(request, caller, arguments, command), "Request an action to be voted upon by players") \
701 COMMON_COMMAND("who", CommonCommand_who(request, caller, arguments), "Display detailed client information about all players") \
704 void CommonCommand_macro_help(entity caller)
706 #define COMMON_COMMAND(name,function,description) \
707 { print_to(caller, strcat(" ^2", name, "^7: ", description)); }
709 COMMON_COMMANDS(0, caller, 0, "");
710 #undef COMMON_COMMAND
715 float CommonCommand_macro_command(float argc, entity caller, string command)
717 #define COMMON_COMMAND(name,function,description) \
718 { if(name == strtolower(argv(0))) { function; return true; } }
720 COMMON_COMMANDS(CMD_REQUEST_COMMAND, caller, argc, command);
721 #undef COMMON_COMMAND
726 float CommonCommand_macro_usage(float argc, entity caller)
728 #define COMMON_COMMAND(name,function,description) \
729 { if(name == strtolower(argv(1))) { function; return true; } }
731 COMMON_COMMANDS(CMD_REQUEST_USAGE, caller, argc, "");
732 #undef COMMON_COMMAND
737 void CommonCommand_macro_write_aliases(float fh)
739 #define COMMON_COMMAND(name,function,description) \
740 { CMD_Write_Alias("qc_cmd_svcmd", name, description); }
742 COMMON_COMMANDS(0, world, 0, "");
743 #undef COMMON_COMMAND