1 // =====================================================
2 // Banning and kicking command code, written by Samual
3 // Last updated: December 29th, 2011
4 // =====================================================
6 void BanCommand_ban(float request, float argc, string command)
10 case CMD_REQUEST_COMMAND:
15 float reason_arg, bantime;
20 GET_BAN_ARG(bantime, autocvar_g_ban_default_bantime);
21 GET_BAN_REASON(reason, "No reason provided");
23 Ban_Insert(ip, bantime, reason, 1);
29 print("Incorrect parameters for ^2ban^7\n");
30 case CMD_REQUEST_USAGE:
32 print("\nUsage:^3 sv_cmd ban address [bantime] [reason]\n");
33 print(" 'address' is the IP address or range of the player to ban,\n");
34 print(" 'bantime' is the amount of time that the ban is active (default if not provided),\n");
35 print(" and 'reason' is the string to label the ban with as reason for banning.\n");
36 print("See also: ^2banlist, kickban, unban^7\n");
42 void BanCommand_banlist(float request)
46 case CMD_REQUEST_COMMAND:
53 case CMD_REQUEST_USAGE:
55 print("\nUsage:^3 sv_cmd banlist\n");
56 print(" No arguments required.\n");
57 print("See also: ^2ban, kickban, unban^7\n");
63 void BanCommand_kickban(float request, float argc, string command)
67 case CMD_REQUEST_COMMAND:
71 entity client = GetIndexedEntity(argc, 1);
72 float accepted = VerifyKickableEntity(client);
73 float reason_arg, bantime, masksize;
78 reason_arg = next_token;
80 GET_BAN_ARG(bantime, autocvar_g_ban_default_bantime);
81 GET_BAN_ARG(masksize, autocvar_g_ban_default_masksize);
82 GET_BAN_REASON(reason, "No reason provided");
84 Ban_KickBanClient(client, bantime, masksize, reason);
90 print("kickban: ", GetClientErrorString(accepted, argv(1)), ".\n");
96 print("Incorrect parameters for ^2kickban^7\n");
97 case CMD_REQUEST_USAGE:
99 print("\nUsage:^3 sv_cmd kickban client [bantime] [masksize] [reason]\n");
100 print(" 'client' is the entity number or name of the player to ban,\n");
101 print(" 'bantime' is the amount of time that the ban is active (default if not provided),\n");
102 print(" 'masksize' is the range of the IP address (1-thru-4, default if not provided),\n");
103 print(" and 'reason' is the string to label the ban with as reason for banning.\n");
104 print("See also: ^2ban, banlist, unban^7\n");
110 void BanCommand_mute(float request, float argc, string command) // TODO: Add a sort of mute-"ban" which allows players to be muted based on IP/cryptokey
114 case CMD_REQUEST_COMMAND:
118 entity client = GetFilteredEntity(argv(1));
119 float accepted = VerifyClientEntity(client, TRUE, FALSE);
128 print("mute: ", GetClientErrorString(accepted, argv(1)), ".\n");
134 print("Incorrect parameters for ^2mute^7\n");
135 case CMD_REQUEST_USAGE:
137 print("\nUsage:^3 sv_cmd mute client\n");
138 print(" 'client' is the entity number or name of the player to mute.\n");
139 print("See also: ^2unmute^7\n");
145 void BanCommand_unban(float request, float argc)
149 case CMD_REQUEST_COMMAND:
153 float tmp_number = -1;
156 if(substring(argv(1), 0, 1) == "#")
158 tmp_string = substring(argv(1), 1, -1);
160 if(tmp_string != "") // is it all one token? like #1
162 tmp_number = stof(tmp_string);
164 else if(argc > 2) // no, it's two tokens? # 1
166 tmp_number = stof(argv(2));
171 else // maybe it's ONLY a number?
173 tmp_number = stof(argv(1));
175 if((tmp_number == 0) && (argv(1) != "0"))
181 Ban_Delete(tmp_number);
188 case CMD_REQUEST_USAGE:
190 print("\nUsage:^3 sv_cmd unban banid\n");
191 print(" Where 'banid' is the ID of the ban of which to remove.\n");
192 print("See also: ^2ban, banlist, kickban^7\n");
198 void BanCommand_unmute(float request, float argc)
202 case CMD_REQUEST_COMMAND:
206 entity client = GetFilteredEntity(argv(1));
207 float accepted = VerifyClientEntity(client, TRUE, FALSE);
211 client.muted = FALSE;
216 print("unmute: ", GetClientErrorString(accepted, argv(1)), ".\n");
222 print("Incorrect parameters for ^2mute^7\n");
223 case CMD_REQUEST_USAGE:
225 print("\nUsage:^3 sv_cmd unmute client\n");
226 print(" 'client' is the entity number or name of the player to unmute.\n");
227 print("See also: ^2mute^7\n");
233 /* use this when creating a new command, making sure to place it in alphabetical order... also,
234 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
235 void BanCommand_(float request)
239 case CMD_REQUEST_COMMAND:
246 case CMD_REQUEST_USAGE:
248 print("\nUsage:^3 sv_cmd \n");
249 print(" No arguments required.\n");
257 // ==================================
258 // Macro system for server commands
259 // ==================================
261 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
262 #define BAN_COMMANDS(request,arguments,command) \
263 BAN_COMMAND("ban", BanCommand_ban(request, arguments, command), "Ban an IP address or a range of addresses (like 1.2.3)") \
264 BAN_COMMAND("banlist", BanCommand_banlist(request), "List all existing bans") \
265 BAN_COMMAND("kickban", BanCommand_kickban(request, arguments, command), "Disconnect a client and ban it at the same time") \
266 BAN_COMMAND("mute", BanCommand_mute(request, arguments, command), "Disallow a client from talking by muting them") \
267 BAN_COMMAND("unban", BanCommand_unban(request, arguments), "Remove an existing ban") \
268 BAN_COMMAND("unmute", BanCommand_unmute(request, arguments), "Unmute a client") \
271 void BanCommand_macro_help()
273 #define BAN_COMMAND(name,function,description) \
274 { if(strtolower(description) != "") { print(" ^2", name, "^7: ", description, "\n"); } }
276 BAN_COMMANDS(0, 0, "")
282 float BanCommand_macro_command(float argc, string command)
284 #define BAN_COMMAND(name,function,description) \
285 { if(name == strtolower(argv(0))) { function; return TRUE; } }
287 BAN_COMMANDS(CMD_REQUEST_COMMAND, argc, command)
293 float BanCommand_macro_usage(float argc)
295 #define BAN_COMMAND(name,function,description) \
296 { if(name == strtolower(argv(1))) { function; return TRUE; } }
298 BAN_COMMANDS(CMD_REQUEST_USAGE, argc, "")
304 void BanCommand_macro_write_aliases(float fh)
306 #define BAN_COMMAND(name,function,description) \
307 { if(strtolower(description) != "") { CMD_Write_Alias("qc_cmd_sv", name, description); } }
309 BAN_COMMANDS(0, 0, "")
315 float BanCommand(string command)
317 float argc = tokenize_console(command);
319 // Guide for working with argc arguments by example:
320 // argc: 1 - 2 - 3 - 4
321 // argv: 0 - 1 - 2 - 3
322 // cmd vote - master - login - password
324 if(BanCommand_macro_command(argc, command)) // continue as usual and scan for normal commands
326 return TRUE; // handled by one of the above GenericCommand_* functions