1 #include "../../common/command/command.qh"
5 #include "../scores.qh"
7 #include "../../common/notifications.qh"
8 #include "../../common/counting.qh"
11 // ====================================================
12 // Shared code for server commands, written by Samual
13 // Last updated: December 27th, 2011
14 // ====================================================
16 // select the proper prefix for usage and other messages
17 string GetCommandPrefix(entity caller)
25 // if client return player nickname, or if server return admin nickname
26 string GetCallerName(entity caller)
29 return caller.netname;
31 return admin_name(); //((autocvar_sv_adminnick != "") ? autocvar_sv_adminnick : autocvar_hostname);
34 // verify that the client provided is acceptable for kicking
35 float VerifyKickableEntity(entity client)
37 if (!IS_REAL_CLIENT(client))
38 return CLIENT_NOT_REAL;
39 return CLIENT_ACCEPTABLE;
42 // verify that the client provided is acceptable for use
43 float VerifyClientEntity(entity client, float must_be_real, float must_be_bots)
45 if (!IS_CLIENT(client))
46 return CLIENT_DOESNT_EXIST;
47 else if(must_be_real && !IS_REAL_CLIENT(client))
48 return CLIENT_NOT_REAL;
49 else if(must_be_bots && !IS_BOT_CLIENT(client))
50 return CLIENT_NOT_BOT;
52 return CLIENT_ACCEPTABLE;
55 // if the client is not acceptable, return a string to be used for error messages
56 string GetClientErrorString_color(float clienterror, string original_input, string col)
60 case CLIENT_DOESNT_EXIST: { return strcat(col, "Client '", original_input, col, "' doesn't exist"); }
61 case CLIENT_NOT_REAL: { return strcat(col, "Client '", original_input, col, "' is not real"); }
62 case CLIENT_NOT_BOT: { return strcat(col, "Client '", original_input, col, "' is not a bot"); }
63 default: { return "Incorrect usage of GetClientErrorString"; }
67 // is this entity number even in the possible range of entities?
68 float VerifyClientNumber(float tmp_number)
70 if((tmp_number < 1) || (tmp_number > maxclients))
76 entity GetIndexedEntity(float argc, float start_index)
78 entity tmp_player, selection;
79 float tmp_number, index;
86 if(argc > start_index)
88 if(substring(argv(index), 0, 1) == "#")
90 tmp_string = substring(argv(index), 1, -1);
93 if(tmp_string != "") // is it all one token? like #1
95 tmp_number = stof(tmp_string);
97 else if(argc > index) // no, it's two tokens? # 1
99 tmp_number = stof(argv(index));
105 else // maybe it's ONLY a number?
107 tmp_number = stof(argv(index));
111 if(VerifyClientNumber(tmp_number))
113 selection = edict_num(tmp_number); // yes, it was a number
115 else // no, maybe it's a name?
117 FOR_EACH_CLIENT(tmp_player)
118 if (strdecolorize(tmp_player.netname) == strdecolorize(argv(start_index)))
119 selection = tmp_player;
121 index = (start_index + 1);
126 //print(strcat("start_index: ", ftos(start_index), ", next_token: ", ftos(next_token), ", edict: ", ftos(num_for_edict(selection)), ".\n"));
130 // find a player which matches the input string, and return their entity
131 entity GetFilteredEntity(string input)
133 entity tmp_player, selection;
136 if(substring(input, 0, 1) == "#")
137 tmp_number = stof(substring(input, 1, -1));
139 tmp_number = stof(input);
141 if(VerifyClientNumber(tmp_number))
143 selection = edict_num(tmp_number);
148 FOR_EACH_CLIENT(tmp_player)
149 if (strdecolorize(tmp_player.netname) == strdecolorize(input))
150 selection = tmp_player;
156 // same thing, but instead return their edict number
157 float GetFilteredNumber(string input)
159 entity selection = GetFilteredEntity(input);
162 output = num_for_edict(selection);
167 // switch between sprint and print depending on whether the receiver is the server or a player
168 void print_to(entity to, string input)
171 sprint(to, strcat(input, "\n"));
176 // ==========================================
177 // Supporting functions for common commands
178 // ==========================================
180 // used by CommonCommand_timeout() and CommonCommand_timein() to handle game pausing and messaging and such.
181 void timeout_handler_reset()
183 timeout_caller = world;
185 timeout_leadtime = 0;
190 void timeout_handler_think()
194 switch(timeout_status)
198 if(timeout_time > 0) // countdown is still going
200 Send_Notification(NOTIF_ALL, world, MSG_CENTER, CENTER_TIMEOUT_ENDING, timeout_time);
202 if(timeout_time == autocvar_sv_timeout_resumetime) // play a warning sound when only <sv_timeout_resumetime> seconds are left
203 Send_Notification(NOTIF_ALL, world, MSG_ANNCE, ANNCE_PREPARE);
205 self.nextthink = time + TIMEOUT_SLOWMO_VALUE; // think again in one second
206 timeout_time -= 1; // decrease the time counter
208 else // time to end the timeout
210 timeout_status = TIMEOUT_INACTIVE;
212 // reset the slowmo value back to normal
213 cvar_set("slowmo", ftos(orig_slowmo));
215 // unlock the view for players so they can move around again
216 FOR_EACH_REALPLAYER(tmp_player)
217 tmp_player.fixangle = false;
219 timeout_handler_reset();
225 case TIMEOUT_LEADTIME:
227 if(timeout_leadtime > 0) // countdown is still going
229 Send_Notification(NOTIF_ALL, world, MSG_CENTER, CENTER_TIMEOUT_BEGINNING, timeout_leadtime);
231 self.nextthink = time + 1; // think again in one second
232 timeout_leadtime -= 1; // decrease the time counter
234 else // time to begin the timeout
236 timeout_status = TIMEOUT_ACTIVE;
238 // set the slowmo value to the timeout default slowmo value
239 cvar_set("slowmo", ftos(TIMEOUT_SLOWMO_VALUE));
241 // reset all the flood variables
242 FOR_EACH_CLIENT(tmp_player)
243 tmp_player.nickspamcount = tmp_player.nickspamtime = tmp_player.floodcontrol_chat =
244 tmp_player.floodcontrol_chatteam = tmp_player.floodcontrol_chattell =
245 tmp_player.floodcontrol_voice = tmp_player.floodcontrol_voiceteam = 0;
247 // copy .v_angle to .lastV_angle for every player in order to fix their view during pause (see PlayerPreThink)
248 FOR_EACH_REALPLAYER(tmp_player)
249 tmp_player.lastV_angle = tmp_player.v_angle;
251 self.nextthink = time; // think again next frame to handle it under TIMEOUT_ACTIVE code
258 case TIMEOUT_INACTIVE:
261 timeout_handler_reset();
269 // ===================================================
270 // Common commands used in both sv_cmd.qc and cmd.qc
271 // ===================================================
273 void CommonCommand_cvar_changes(float request, entity caller)
277 case CMD_REQUEST_COMMAND:
279 print_to(caller, cvar_changes);
280 return; // never fall through to usage
284 case CMD_REQUEST_USAGE:
286 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " cvar_changes"));
287 print_to(caller, " No arguments required.");
288 print_to(caller, "See also: ^2cvar_purechanges^7");
294 void CommonCommand_cvar_purechanges(float request, entity caller)
298 case CMD_REQUEST_COMMAND:
300 print_to(caller, cvar_purechanges);
301 return; // never fall through to usage
305 case CMD_REQUEST_USAGE:
307 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " cvar_purechanges"));
308 print_to(caller, " No arguments required.");
309 print_to(caller, "See also: ^2cvar_changes^7");
315 void CommonCommand_info(float request, entity caller, float argc)
319 case CMD_REQUEST_COMMAND:
321 string command = builtin_cvar_string(strcat("sv_info_", argv(1)));
324 wordwrap_sprint(command, 1000);
326 print_to(caller, "ERROR: unsupported info command");
328 return; // never fall through to usage
332 case CMD_REQUEST_USAGE:
334 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " info request"));
335 print_to(caller, " Where 'request' is the suffixed string appended onto the request for cvar.");
341 void CommonCommand_ladder(float request, entity caller)
345 case CMD_REQUEST_COMMAND:
347 print_to(caller, ladder_reply);
348 return; // never fall through to usage
352 case CMD_REQUEST_USAGE:
354 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " ladder"));
355 print_to(caller, " No arguments required.");
361 void CommonCommand_lsmaps(float request, entity caller)
365 case CMD_REQUEST_COMMAND:
367 print_to(caller, lsmaps_reply);
368 return; // never fall through to usage
372 case CMD_REQUEST_USAGE:
374 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " lsmaps"));
375 print_to(caller, " No arguments required.");
381 void CommonCommand_printmaplist(float request, entity caller)
385 case CMD_REQUEST_COMMAND:
387 print_to(caller, maplist_reply);
388 return; // never fall through to usage
392 case CMD_REQUEST_USAGE:
394 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " printmaplist"));
395 print_to(caller, " No arguments required.");
401 void CommonCommand_rankings(float request, entity caller)
405 case CMD_REQUEST_COMMAND:
407 print_to(caller, rankings_reply);
408 return; // never fall through to usage
412 case CMD_REQUEST_USAGE:
414 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " rankings"));
415 print_to(caller, " No arguments required.");
421 void CommonCommand_records(float request, entity caller)
425 case CMD_REQUEST_COMMAND:
427 for(int i = 0; i < 10; ++i)
428 if(records_reply[i] != "")
429 print_to(caller, records_reply[i]);
431 return; // never fall through to usage
435 case CMD_REQUEST_USAGE:
437 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " records"));
438 print_to(caller, " No arguments required.");
444 void CommonCommand_teamstatus(float request, entity caller)
448 case CMD_REQUEST_COMMAND:
450 Score_NicePrint(caller);
451 return; // never fall through to usage
455 case CMD_REQUEST_USAGE:
457 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " teamstatus"));
458 print_to(caller, " No arguments required.");
464 void CommonCommand_time(float request, entity caller)
468 case CMD_REQUEST_COMMAND:
470 print_to(caller, strcat("time = ", ftos(time)));
471 print_to(caller, strcat("frame start = ", ftos(gettime(GETTIME_FRAMESTART))));
472 print_to(caller, strcat("realtime = ", ftos(gettime(GETTIME_REALTIME))));
473 print_to(caller, strcat("hires = ", ftos(gettime(GETTIME_HIRES))));
474 print_to(caller, strcat("uptime = ", ftos(gettime(GETTIME_UPTIME))));
475 print_to(caller, strcat("localtime = ", strftime(true, "%a %b %e %H:%M:%S %Z %Y")));
476 print_to(caller, strcat("gmtime = ", strftime(false, "%a %b %e %H:%M:%S %Z %Y")));
481 case CMD_REQUEST_USAGE:
483 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " time"));
484 print_to(caller, " No arguments required.");
490 void CommonCommand_timein(float request, entity caller)
494 case CMD_REQUEST_COMMAND:
496 if(!caller || autocvar_sv_timeout)
498 if (!timeout_status) { print_to(caller, "^7Error: There is no active timeout called."); }
499 else if(caller && (caller != timeout_caller)) { print_to(caller, "^7Error: You are not allowed to stop the active timeout."); }
501 else // everything should be okay, continue aborting timeout
503 switch(timeout_status)
505 case TIMEOUT_LEADTIME:
507 timeout_status = TIMEOUT_INACTIVE;
509 timeout_handler.nextthink = time; // timeout_handler has to take care of it immediately
510 bprint(strcat("^7The timeout was aborted by ", GetCallerName(caller), " !\n"));
516 timeout_time = autocvar_sv_timeout_resumetime;
517 timeout_handler.nextthink = time; // timeout_handler has to take care of it immediately
518 bprint(strcat("^1Attention: ^7", GetCallerName(caller), " resumed the game! Prepare for battle!\n"));
522 default: dprint("timeout status was inactive, but this code was executed anyway?"); return;
526 else { print_to(caller, "^1Timeins are not allowed to be called, enable them with sv_timeout 1.\n"); }
528 return; // never fall through to usage
532 case CMD_REQUEST_USAGE:
534 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " timein"));
535 print_to(caller, " No arguments required.");
541 void CommonCommand_timeout(float request, entity caller) // DEAR GOD THIS COMMAND IS TERRIBLE.
545 case CMD_REQUEST_COMMAND:
547 if(!caller || autocvar_sv_timeout)
549 float last_possible_timeout = ((autocvar_timelimit * 60) - autocvar_sv_timeout_leadtime - 1);
551 if(timeout_status) { print_to(caller, "^7Error: A timeout is already active."); }
552 else if(vote_called) { print_to(caller, "^7Error: You can not call a timeout while a vote is active."); }
553 else if(warmup_stage && !g_warmup_allow_timeout) { print_to(caller, "^7Error: You can not call a timeout in warmup-stage."); }
554 else if(time < game_starttime) { print_to(caller, "^7Error: You can not call a timeout while the map is being restarted."); }
555 else if(caller && (caller.allowed_timeouts < 1)) { print_to(caller, "^7Error: You already used all your timeout calls for this map."); }
556 else if(caller && !IS_PLAYER(caller)) { print_to(caller, "^7Error: You must be a player to call a timeout."); }
557 else if((autocvar_timelimit) && (last_possible_timeout < time - game_starttime)) { print_to(caller, "^7Error: It is too late to call a timeout now!"); }
559 else // everything should be okay, proceed with starting the timeout
561 if(caller) { caller.allowed_timeouts -= 1; }
563 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)
565 timeout_status = TIMEOUT_LEADTIME;
566 timeout_caller = caller;
567 timeout_time = autocvar_sv_timeout_length;
568 timeout_leadtime = autocvar_sv_timeout_leadtime;
570 timeout_handler = spawn();
571 timeout_handler.think = timeout_handler_think;
572 timeout_handler.nextthink = time; // always let the entity think asap
574 Send_Notification(NOTIF_ALL, world, MSG_ANNCE, ANNCE_TIMEOUT);
577 else { print_to(caller, "^1Timeouts are not allowed to be called, enable them with sv_timeout 1.\n"); }
579 return; // never fall through to usage
583 case CMD_REQUEST_USAGE:
585 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " timeout"));
586 print_to(caller, " No arguments required.");
592 void CommonCommand_who(float request, entity caller, float argc)
596 case CMD_REQUEST_COMMAND:
598 float total_listed_players, is_bot;
601 float privacy = (caller && autocvar_sv_status_privacy);
602 string separator = strreplace("%", " ", strcat((argv(1) ? argv(1) : " "), "^7"));
603 string tmp_netaddress, tmp_crypto_idfp;
605 print_to(caller, strcat("List of client information", (privacy ? " (some data is hidden for privacy)" : ""), ":"));
606 print_to(caller, sprintf(strreplace(" ", separator, " %-4s %-20s %-5s %-3s %-9s %-16s %s "),
607 "ent", "nickname", "ping", "pl", "time", "ip", "crypto_id"));
609 total_listed_players = 0;
610 FOR_EACH_CLIENT(tmp_player)
612 is_bot = (IS_BOT_CLIENT(tmp_player));
616 tmp_netaddress = "null/botclient";
617 tmp_crypto_idfp = "null/botclient";
621 tmp_netaddress = "hidden";
622 tmp_crypto_idfp = "hidden";
626 tmp_netaddress = tmp_player.netaddress;
627 tmp_crypto_idfp = tmp_player.crypto_idfp;
630 print_to(caller, sprintf(strreplace(" ", separator, " #%-3d %-20.20s %-5d %-3d %-9s %-16s %s "),
631 num_for_edict(tmp_player),
634 tmp_player.ping_packetloss,
635 process_time(1, time - tmp_player.jointime),
639 ++total_listed_players;
642 print_to(caller, strcat("Finished listing ", ftos(total_listed_players), " client(s) out of ", ftos(maxclients), " slots."));
644 return; // never fall through to usage
648 case CMD_REQUEST_USAGE:
650 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " who [separator]"));
651 print_to(caller, " Where 'separator' is the optional string to separate the values with, default is a space.");
657 /* use this when creating a new command, making sure to place it in alphabetical order... also,
658 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
659 void CommonCommand_(float request, entity caller)
663 case CMD_REQUEST_COMMAND:
666 return; // never fall through to usage
670 case CMD_REQUEST_USAGE:
672 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " "));
673 print_to(caller, " No arguments required.");