3 * Implements basic admin commands.
4 * This file is part of SourceMod, Copyright (C) 2004-2007 AlliedModders LLC
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
27 public Plugin:myinfo =
29 name = "Basic Commands",
30 author = "AlliedModders LLC",
31 description = "Basic Admin Commands",
32 version = SOURCEMOD_VERSION,
33 url = "http://www.sourcemod.net/"
36 new Handle:hBanForward = INVALID_HANDLE;
37 new Handle:hAddBanForward = INVALID_HANDLE;
38 new Handle:hBanRemoved = INVALID_HANDLE;
40 public OnPluginStart()
42 LoadTranslations("common.cfg");
43 LoadTranslations("plugin.basecommands.cfg");
44 RegAdminCmd("sm_kick", Command_Kick, ADMFLAG_KICK, "sm_kick <#userid|name> [reason]");
45 RegAdminCmd("sm_map", Command_Map, ADMFLAG_CHANGEMAP, "sm_map <map>");
46 RegAdminCmd("sm_rcon", Command_Rcon, ADMFLAG_RCON, "sm_rcon <args>");
47 RegAdminCmd("sm_cvar", Command_Cvar, ADMFLAG_CONVARS, "sm_cvar <cvar> [value]");
48 RegAdminCmd("sm_execcfg", Command_ExecCfg, ADMFLAG_CONFIG, "sm_execcfg <filename>");
49 RegAdminCmd("sm_who", Command_Who, ADMFLAG_GENERIC, "sm_who [#userid|name]");
50 RegAdminCmd("sm_ban", Command_Ban, ADMFLAG_BAN, "sm_ban <#userid|name> <minutes|0> [reason]");
51 RegAdminCmd("sm_unban", Command_Unban, ADMFLAG_UNBAN, "sm_unban <steamid>");
52 RegAdminCmd("sm_addban", Command_AddBan, ADMFLAG_RCON, "sm_addban <time> <steamid> [reason]");
53 RegAdminCmd("sm_banip", Command_BanIp, ADMFLAG_RCON, "sm_banip <time> <ip> [reason]");
55 hBanForward = CreateGlobalForward("OnClientBanned", ET_Ignore, Param_Cell, Param_Cell, Param_Cell, Param_String);
56 hAddBanForward = CreateGlobalForward("OnBanAdded", ET_Ignore, Param_Cell, Param_String, Param_Cell, Param_String);
57 hBanRemoved = CreateGlobalForward("OnBanRemoved", ET_Ignore, Param_Cell, Param_String);
60 public Action:Command_BanIp(client, args)
64 ReplyToCommand(client, "[SM] Usage: sm_banip <time> <ip> [reason]");
65 return Plugin_Handled;
68 new String:arg[50], String:time[20];
69 GetCmdArg(1, time, sizeof(time));
70 GetCmdArg(2, arg, sizeof(arg));
72 new minutes = StringToInt(time);
74 new String:reason[128];
77 GetCmdArg(3, reason, sizeof(reason));
80 LogMessage("\"%L\" added ban (minutes \"%d\") (ip \"%s\") (reason \"%s\")", client, minutes, arg, reason);
82 Call_StartForward(hAddBanForward);
83 Call_PushCell(client);
85 Call_PushCell(minutes);
86 Call_PushString(reason);
89 ServerCommand("banip %d %s", minutes, arg);
90 ServerCommand("writeip");
91 ReplyToCommand(client, "[SM] %t", "Ban added");
93 return Plugin_Handled;
96 public Action:Command_AddBan(client, args)
100 ReplyToCommand(client, "[SM] Usage: sm_addban <time> <steamid> [reason]");
101 return Plugin_Handled;
104 new String:arg[50], String:time[20];
105 GetCmdArg(1, time, sizeof(time));
106 GetCmdArg(2, arg, sizeof(arg));
108 new minutes = StringToInt(time);
110 new String:reason[128];
113 GetCmdArg(3, reason, sizeof(reason));
116 LogMessage("\"%L\" added ban (minutes \"%d\") (id \"%s\") (reason \"%s\")", client, minutes, arg, reason);
118 Call_StartForward(hAddBanForward);
119 Call_PushCell(client);
120 Call_PushString(arg);
121 Call_PushCell(minutes);
122 Call_PushString(reason);
125 ServerCommand("banid %d %s", minutes, arg);
126 ServerCommand("writeid");
127 ReplyToCommand(client, "[SM] %t", "Ban added");
129 return Plugin_Handled;
132 public Action:Command_Unban(client, args)
136 ReplyToCommand(client, "[SM] Usage: sm_unban <steamid>");
137 return Plugin_Handled;
140 new String:arg[50], start=0;
141 new String:new_arg[50];
142 GetCmdArgString(arg, sizeof(arg));
144 if (strncmp(arg, "STEAM_0:", 8) == 0)
147 } else if (strncmp(arg, "0:1:", 4) == 0 || strncmp(arg, "0:0:", 4) == 0)
152 LogMessage("\"%L\" removed ban (filter \"%s\")", arg[start]);
154 Format(new_arg, sizeof(new_arg), "STEAM_0:%s", arg[start]);
155 Call_StartForward(hBanRemoved);
156 Call_PushCell(client);
157 Call_PushString(new_arg);
160 ServerCommand("removeid \"%s\"", arg[start]);
161 ServerCommand("writeid");
162 ReplyToCommand(client, "[SM] %t", "Removed bans matching", arg);
164 return Plugin_Handled;
167 public Action:Command_Ban(client, args)
171 ReplyToCommand(client, "[SM] Usage: sm_ban <#userid|name> <minutes|0> [reason]");
172 return Plugin_Handled;
176 GetCmdArg(1, arg, sizeof(arg));
179 new numClients = SearchForClients(arg, clients, 2);
183 ReplyToCommand(client, "[SM] %t", "No matching client");
184 return Plugin_Handled;
185 } else if (numClients > 1) {
186 ReplyToCommand(client, "[SM] %t", "More than one client matches", arg);
187 return Plugin_Handled;
188 } else if (!CanUserTarget(client, clients[0])) {
189 ReplyToCommand(client, "[SM] %t", "Unable to target");
190 return Plugin_Handled;
191 } else if (IsFakeClient(clients[0])) {
192 ReplyToCommand(client, "[SM] %t", "Cannot target bot");
193 return Plugin_Handled;
196 new String:s_time[12];
197 GetCmdArg(2, s_time, sizeof(s_time));
199 new time = StringToInt(s_time);
201 decl String:reason[128];
204 GetCmdArg(3, reason, sizeof(reason));
209 new userid = GetClientUserId(clients[0]);
210 GetClientName(clients[0], arg, sizeof(arg));
214 if (reason[0] == '\0')
216 ShowActivity(client, "%t", "Permabanned player", arg);
218 ShowActivity(client, "%t", "Permabanned player reason", arg, reason);
221 if (reason[0] == '\0')
223 ShowActivity(client, "%t", "Banned player", arg, time);
225 ShowActivity(client, "%t", "Banned player reason", arg, time, reason);
229 LogMessage("\"%L\" banned \"%L\" (minutes \"%d\") (reason \"%s\")", client, clients[0], time, reason);
231 /* Fire the ban forward */
232 Call_StartForward(hBanForward);
233 Call_PushCell(client);
234 Call_PushCell(clients[0]);
236 Call_PushString(reason);
239 if (reason[0] == '\0')
241 strcopy(reason, sizeof(reason), "Banned");
244 ServerCommand("banid %d %d", time, userid);
245 ServerCommand("kickid %d \"%s\"", userid, reason);
249 ServerCommand("writeid");
252 return Plugin_Handled;
255 #define FLAG_STRINGS 14
256 new String:g_FlagNames[FLAG_STRINGS][20] =
274 FlagsToString(String:buffer[], maxlength, flags)
276 new String:joins[FLAG_STRINGS][20];
279 for (new i=0; i<FLAG_STRINGS; i++)
283 strcopy(joins[total++], 20, g_FlagNames[i]);
287 ImplodeStrings(joins, total, ", ", buffer, maxlength);
290 public Action:Command_Who(client, args)
295 new String:t_access[16], String:t_name[16];
296 Format(t_access, sizeof(t_access), "%t", "Access", client);
297 Format(t_name, sizeof(t_name), "%t", "Name", client);
299 PrintToConsole(client, "%-24.23s %s", t_name, t_access);
301 /* List all players */
302 new maxClients = GetMaxClients();
303 new String:flagstring[255];
305 for (new i=1; i<=maxClients; i++)
307 if (!IsClientInGame(i))
311 new flags = GetUserFlagBits(i);
314 strcopy(flagstring, sizeof(flagstring), "none");
315 } else if (flags & ADMFLAG_ROOT) {
316 strcopy(flagstring, sizeof(flagstring), "root");
318 FlagsToString(flagstring, sizeof(flagstring), flags);
320 decl String:name[65];
321 GetClientName(i, name, sizeof(name));
322 PrintToConsole(client, "%d. %-24.23s %s", i, name, flagstring);
325 if (GetCmdReplySource() == SM_REPLY_TO_CHAT)
327 ReplyToCommand(client, "[SM] %t", "See console for output");
330 return Plugin_Handled;
334 GetCmdArg(1, arg, sizeof(arg));
337 new numClients = SearchForClients(arg, clients, 2);
341 ReplyToCommand(client, "[SM] %t", "No matching client");
342 return Plugin_Handled;
343 } else if (numClients > 1) {
344 ReplyToCommand(client, "[SM] %t", "More than one client matches", arg);
345 return Plugin_Handled;
348 new flags = GetUserFlagBits(clients[0]);
349 new String:flagstring[255];
352 strcopy(flagstring, sizeof(flagstring), "none");
353 } else if (flags & ADMFLAG_ROOT) {
354 strcopy(flagstring, sizeof(flagstring), "root");
356 FlagsToString(flagstring, sizeof(flagstring), flags);
359 ReplyToCommand(client, "[SM] %t: %s", "Access", flagstring);
361 return Plugin_Handled;
364 public Action:Command_ExecCfg(client, args)
368 ReplyToCommand(client, "[SM] Usage: sm_execcfg <filename>");
369 return Plugin_Handled;
372 new String:path[64] = "cfg/";
373 GetCmdArg(1, path[4], sizeof(path)-4);
375 if (!FileExists(path))
377 ReplyToCommand(client, "[SM] %t", "Config not found", path[4]);
378 return Plugin_Handled;
381 ShowActivity(client, "%t", "Executed config", path[4]);
383 LogMessage("\"%L\" executed config (file \"%s\")", client, path[4]);
385 ServerCommand("exec \"%s\"", path[4]);
387 return Plugin_Handled;
390 public Action:Command_Cvar(client, args)
394 ReplyToCommand(client, "[SM] Usage: sm_cvar <cvar> [value]");
395 return Plugin_Handled;
398 new String:cvarname[33];
399 GetCmdArg(1, cvarname, sizeof(cvarname));
401 new Handle:hndl = FindConVar(cvarname);
402 if (hndl == INVALID_HANDLE)
404 ReplyToCommand(client, "[SM] %t", "Unable to find cvar", cvarname);
405 return Plugin_Handled;
408 new bool:allowed = false;
409 if (GetConVarFlags(hndl) & FCVAR_PROTECTED)
411 /* If they're root, allow anything */
412 if ((GetUserFlagBits(client) & ADMFLAG_ROOT) == ADMFLAG_ROOT)
416 /* If they're not root, and getting sv_password, see if they have ADMFLAG_PASSWORD */
417 else if (StrEqual(cvarname, "sv_password") && (GetUserFlagBits(client) & ADMFLAG_PASSWORD))
422 /* Do a check for the cheat cvar */
423 else if (StrEqual(cvarname, "sv_cheats"))
425 if (GetUserFlagBits(client) & ADMFLAG_CHEATS
426 || GetUserFlagBits(client) & ADMFLAG_ROOT)
431 /* If we drop down to here, it was a normal cvar. */
439 ReplyToCommand(client, "[SM] %t", "No access to cvar");
440 return Plugin_Handled;
443 decl String:value[255];
446 GetConVarString(hndl, value, sizeof(value));
448 ReplyToCommand(client, "[SM] %t", "Value of cvar", cvarname, value);
449 return Plugin_Handled;
452 GetCmdArg(2, value, sizeof(value));
454 if ((GetConVarFlags(hndl) & FCVAR_PROTECTED) != FCVAR_PROTECTED)
456 ShowActivity(client, "%t", "Cvar changed", cvarname, value);
458 ReplyToCommand(client, "[SM] %t", "Cvar changed", cvarname, value);
461 LogMessage("\"%L\" changed cvar (cvar \"%s\") (value \"%s\")", client, cvarname, value);
463 SetConVarString(hndl, value, true);
465 return Plugin_Handled;
468 public Action:Command_Rcon(client, args)
472 ReplyToCommand(client, "[SM] Usage: sm_rcon <args>");
473 return Plugin_Handled;
476 decl String:argstring[255];
477 GetCmdArgString(argstring, sizeof(argstring));
479 LogMessage("\"%L\" console command (cmdline \"%s\")", client, argstring);
481 ServerCommand("%s", argstring);
483 return Plugin_Handled;
486 public Action:Command_Map(client, args)
490 ReplyToCommand(client, "[SM] Usage: sm_map <map>");
491 return Plugin_Handled;
495 GetCmdArg(1, map, sizeof(map));
497 if (!IsMapValid(map))
499 ReplyToCommand(client, "[SM] %t", "Map was not found", map);
500 return Plugin_Handled;
503 ShowActivity(client, "%t", "Changing map", map);
505 LogMessage("\"%L\" changed map to \"%s\"", client, map);
508 CreateDataTimer(3.0, Timer_ChangeMap, dp);
509 WritePackString(dp, map);
511 return Plugin_Handled;
514 public Action:Timer_ChangeMap(Handle:timer, Handle:dp)
519 ReadPackString(dp, map, sizeof(map));
521 ServerCommand("changelevel \"%s\"", map);
526 public Action:Command_Kick(client, args)
530 ReplyToCommand(client, "[SM] Usage: sm_kick <#userid|name> [reason]");
531 return Plugin_Handled;
535 GetCmdArg(1, arg, sizeof(arg));
538 new numClients = SearchForClients(arg, clients, 2);
542 ReplyToCommand(client, "[SM] %t", "No matching client");
543 return Plugin_Handled;
544 } else if (numClients > 1) {
545 ReplyToCommand(client, "[SM] %t", "More than one client matches", arg);
546 return Plugin_Handled;
547 } else if (!CanUserTarget(client, clients[0])) {
548 ReplyToCommand(client, "[SM] %t", "Unable to target");
549 return Plugin_Handled;
552 new userid = GetClientUserId(clients[0]);
555 GetClientName(clients[0], name, sizeof(name));
557 decl String:reason[256];
560 /* Safely null terminate */
563 GetCmdArg(2, reason, sizeof(reason));
566 ShowActivity(client, "%t", "Kicked player", name);
568 LogMessage("\"%L\" kicked \"%L\" (reason \"%s\")", client, clients[0], reason);
572 ServerCommand("kickid %d", userid);
574 ServerCommand("kickid %d \"%s\"", userid, reason);
577 return Plugin_Handled;