plugins/basecommands.sp
author David Anderson <dvander@alliedmods.net>
Fri Feb 22 21:01:08 2008 +0000 (2008-02-22)
changeset 1889 5b4d6acc4d82
parent 1844 eff718469d84
child 1947 e73a1e51833b
permissions -rw-r--r--
deprecated LoadMaps() and its usage in three plugins
renamed basefun* to fun*
removed map file list cvars
dvander@910
     1
/**
ds@1330
     2
 * vim: set ts=4 :
ds@1330
     3
 * =============================================================================
ds@1330
     4
 * SourceMod Basic Commands Plugin
ds@913
     5
 * Implements basic admin commands.
ds@1330
     6
 *
ds@1330
     7
 * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.
ds@1330
     8
 * =============================================================================
dvander@910
     9
 *
ds@1330
    10
 * This program is free software; you can redistribute it and/or modify it under
ds@1330
    11
 * the terms of the GNU General Public License, version 3.0, as published by the
ds@1330
    12
 * Free Software Foundation.
ds@1330
    13
 * 
ds@1330
    14
 * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1330
    15
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1330
    16
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
ds@1330
    17
 * details.
dvander@910
    18
 *
ds@1330
    19
 * You should have received a copy of the GNU General Public License along with
ds@1330
    20
 * this program.  If not, see <http://www.gnu.org/licenses/>.
teame06@1211
    21
 *
ds@1330
    22
 * As a special exception, AlliedModders LLC gives you permission to link the
dvander@1624
    23
 * code of this program (as well as its derivative 1works) to "Half-Life 2," the
ds@1330
    24
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1330
    25
 * by the Valve Corporation.  You must obey the GNU General Public License in
ds@1330
    26
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
ds@1330
    27
 * this exception to all derivative works.  AlliedModders LLC defines further
ds@1330
    28
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1330
    29
 * or <http://www.sourcemod.net/license.php>.
ds@913
    30
 *
ds@913
    31
 * Version: $Id$
dvander@910
    32
 */
dvander@910
    33
ds@989
    34
#pragma semicolon 1
dvander@910
    35
ds@989
    36
#include <sourcemod>
dvander@1510
    37
#undef REQUIRE_PLUGIN
dvander@1510
    38
#include <adminmenu>
ds@913
    39
teame06@1211
    40
public Plugin:myinfo =
dvander@910
    41
{
dvander@910
    42
	name = "Basic Commands",
dvander@910
    43
	author = "AlliedModders LLC",
dvander@910
    44
	description = "Basic Admin Commands",
dvander@910
    45
	version = SOURCEMOD_VERSION,
dvander@910
    46
	url = "http://www.sourcemod.net/"
dvander@910
    47
};
dvander@910
    48
dvander@1510
    49
new Handle:hTopMenu = INVALID_HANDLE;
dvander@1510
    50
pred@1536
    51
new Handle:g_MapList;
dvander@1839
    52
new Handle:g_ProtectedVars;
pred@1536
    53
dvander@1510
    54
#include "basecommands/kick.sp"
dvander@1518
    55
#include "basecommands/reloadadmins.sp"
dvander@1523
    56
#include "basecommands/cancelvote.sp"
pred@1536
    57
#include "basecommands/who.sp"
pred@1536
    58
#include "basecommands/map.sp"
pred@1536
    59
#include "basecommands/execcfg.sp"
dvander@1510
    60
dvander@910
    61
public OnPluginStart()
dvander@910
    62
{
dvander@1027
    63
	LoadTranslations("common.phrases");
dvander@1521
    64
	LoadTranslations("plugin.basecommands");
teame06@1211
    65
dvander@910
    66
	RegAdminCmd("sm_kick", Command_Kick, ADMFLAG_KICK, "sm_kick <#userid|name> [reason]");
dvander@917
    67
	RegAdminCmd("sm_map", Command_Map, ADMFLAG_CHANGEMAP, "sm_map <map>");
dvander@918
    68
	RegAdminCmd("sm_rcon", Command_Rcon, ADMFLAG_RCON, "sm_rcon <args>");
dvander@920
    69
	RegAdminCmd("sm_cvar", Command_Cvar, ADMFLAG_CONVARS, "sm_cvar <cvar> [value]");
dvander@921
    70
	RegAdminCmd("sm_execcfg", Command_ExecCfg, ADMFLAG_CONFIG, "sm_execcfg <filename>");
dvander@923
    71
	RegAdminCmd("sm_who", Command_Who, ADMFLAG_GENERIC, "sm_who [#userid|name]");
dvander@1162
    72
	RegAdminCmd("sm_reloadadmins", Command_ReloadAdmins, ADMFLAG_BAN, "sm_reloadadmins");
ferret99gt@1276
    73
	RegAdminCmd("sm_cancelvote", Command_CancelVote, ADMFLAG_VOTE, "sm_cancelvote");
dvander@1510
    74
	
dvander@1510
    75
	/* Account for late loading */
dvander@1510
    76
	new Handle:topmenu;
dvander@1510
    77
	if (LibraryExists("adminmenu") && ((topmenu = GetAdminTopMenu()) != INVALID_HANDLE))
dvander@1510
    78
	{
dvander@1510
    79
		OnAdminMenuReady(topmenu);
dvander@1510
    80
	}
pred@1536
    81
	
pred@1536
    82
	g_MapList = CreateMenu(MenuHandler_ChangeMap);
pred@1536
    83
	SetMenuTitle(g_MapList, "Please select a map");
pred@1536
    84
	SetMenuExitBackButton(g_MapList, true);
dvander@1738
    85
	
dvander@1738
    86
	decl String:mapListPath[PLATFORM_MAX_PATH];
dvander@1738
    87
	BuildPath(Path_SM, mapListPath, sizeof(mapListPath), "configs/adminmenu_maplist.ini");
pred@1740
    88
	SetMapListCompatBind("sm_map menu", mapListPath);
dvander@1839
    89
	
dvander@1839
    90
	g_ProtectedVars = CreateTrie();
dvander@1839
    91
	ProtectVar("rcon_password");
dvander@1839
    92
	ProtectVar("sm_show_activity");
dvander@1839
    93
	ProtectVar("sm_immunity_mode");
pred@1536
    94
}
pred@1536
    95
pred@1536
    96
public OnMapStart()
pred@1536
    97
{
pred@1740
    98
	ParseConfigs();
pred@1740
    99
}
pred@1740
   100
pred@1740
   101
public OnConfigsExecuted()
pred@1740
   102
{
ferret99gt@1606
   103
	LoadMapList(g_MapList);
pred@1536
   104
}
pred@1536
   105
dvander@1839
   106
ProtectVar(const String:cvar[])
dvander@1839
   107
{
dvander@1839
   108
	SetTrieValue(g_ProtectedVars, cvar, 1);
dvander@1839
   109
}
dvander@1839
   110
dvander@1839
   111
bool:IsVarProtected(const String:cvar[])
dvander@1839
   112
{
dvander@1839
   113
	decl dummy_value;
dvander@1839
   114
	return GetTrieValue(g_ProtectedVars, cvar, dummy_value);
dvander@1839
   115
}
dvander@1839
   116
dvander@1510
   117
public OnAdminMenuReady(Handle:topmenu)
dvander@1510
   118
{
dvander@1510
   119
	/* Block us from being called twice */
dvander@1510
   120
	if (topmenu == hTopMenu)
dvander@1510
   121
	{
dvander@1510
   122
		return;
dvander@1510
   123
	}
dvander@1510
   124
	
dvander@1510
   125
	/* Save the Handle */
dvander@1510
   126
	hTopMenu = topmenu;
dvander@1510
   127
	
dvander@1510
   128
	/* Build the "Player Commands" category */
dvander@1510
   129
	new TopMenuObject:player_commands = FindTopMenuCategory(hTopMenu, ADMINMENU_PLAYERCOMMANDS);
dvander@1510
   130
	
dvander@1510
   131
	if (player_commands != INVALID_TOPMENUOBJECT)
dvander@1510
   132
	{
dvander@1510
   133
		AddToTopMenu(hTopMenu, 
dvander@1600
   134
			"sm_kick",
dvander@1510
   135
			TopMenuObject_Item,
dvander@1510
   136
			AdminMenu_Kick,
dvander@1510
   137
			player_commands,
dvander@1510
   138
			"sm_kick",
dvander@1510
   139
			ADMFLAG_KICK);
pred@1536
   140
			
pred@1536
   141
		AddToTopMenu(hTopMenu,
dvander@1600
   142
			"sm_who",
pred@1536
   143
			TopMenuObject_Item,
pred@1536
   144
			AdminMenu_Who,
pred@1536
   145
			player_commands,
pred@1536
   146
			"sm_who",
pred@1536
   147
			ADMFLAG_GENERIC);
dvander@1510
   148
	}
dvander@1518
   149
dvander@1518
   150
	new TopMenuObject:server_commands = FindTopMenuCategory(hTopMenu, ADMINMENU_SERVERCOMMANDS);
dvander@1518
   151
dvander@1518
   152
	if (server_commands != INVALID_TOPMENUOBJECT)
dvander@1518
   153
	{
dvander@1518
   154
		AddToTopMenu(hTopMenu,
dvander@1600
   155
			"sm_reloadadmins",
dvander@1518
   156
			TopMenuObject_Item,
dvander@1518
   157
			AdminMenu_ReloadAdmins,
dvander@1518
   158
			server_commands,
dvander@1518
   159
			"sm_reloadadmins",
dvander@1518
   160
			ADMFLAG_BAN);
pred@1536
   161
			
pred@1536
   162
		AddToTopMenu(hTopMenu,
dvander@1600
   163
			"sm_map",
pred@1536
   164
			TopMenuObject_Item,
pred@1536
   165
			AdminMenu_Map,
pred@1536
   166
			server_commands,
pred@1536
   167
			"sm_map",
pred@1536
   168
			ADMFLAG_CHANGEMAP);
pred@1536
   169
			
pred@1536
   170
		AddToTopMenu(hTopMenu,
dvander@1600
   171
			"sm_execcfg",
pred@1536
   172
			TopMenuObject_Item,
pred@1536
   173
			AdminMenu_ExecCFG,
pred@1536
   174
			server_commands,
pred@1536
   175
			"sm_execcfg",
pred@1536
   176
			ADMFLAG_CONFIG);		
dvander@1518
   177
	}
dvander@1523
   178
dvander@1523
   179
	new TopMenuObject:voting_commands = FindTopMenuCategory(hTopMenu, ADMINMENU_VOTINGCOMMANDS);
dvander@1523
   180
dvander@1523
   181
	if (voting_commands != INVALID_TOPMENUOBJECT)
dvander@1523
   182
	{
dvander@1523
   183
		AddToTopMenu(hTopMenu,
dvander@1600
   184
			"sm_cancelvote",
dvander@1523
   185
			TopMenuObject_Item,
dvander@1523
   186
			AdminMenu_CancelVote,
dvander@1523
   187
			voting_commands,
dvander@1523
   188
			"sm_cancelvote",
dvander@1523
   189
			ADMFLAG_VOTE);
dvander@1523
   190
	}
dvander@1510
   191
}
dvander@1510
   192
dvander@1510
   193
public OnLibraryRemoved(const String:name[])
dvander@1510
   194
{
dvander@1510
   195
	if (strcmp(name, "adminmenu") == 0)
dvander@1510
   196
	{
dvander@1510
   197
		hTopMenu = INVALID_HANDLE;
dvander@1510
   198
	}
dvander@927
   199
}
dvander@927
   200
dvander@923
   201
#define FLAG_STRINGS		14
dvander@923
   202
new String:g_FlagNames[FLAG_STRINGS][20] =
dvander@923
   203
{
dvander@1376
   204
	"res",
dvander@923
   205
	"admin",
dvander@923
   206
	"kick",
dvander@923
   207
	"ban",
dvander@923
   208
	"unban",
dvander@923
   209
	"slay",
dvander@923
   210
	"map",
dvander@923
   211
	"cvars",
dvander@923
   212
	"cfg",
dvander@923
   213
	"chat",
dvander@923
   214
	"vote",
dvander@923
   215
	"pass",
dvander@923
   216
	"rcon",
dvander@923
   217
	"cheat"
dvander@923
   218
};
dvander@923
   219
dvander@1376
   220
CustomFlagsToString(String:buffer[], maxlength, flags)
dvander@1376
   221
{
dvander@1376
   222
	decl String:joins[6][6];
dvander@1376
   223
	new total;
dvander@1376
   224
	
dvander@1376
   225
	for (new i=_:Admin_Custom1; i<=_:Admin_Custom6; i++)
dvander@1376
   226
	{
dvander@1376
   227
		if (flags & (1<<i))
dvander@1376
   228
		{
dvander@1376
   229
			IntToString(i - _:Admin_Custom1 + 1, joins[total++], 6);
dvander@1376
   230
		}
dvander@1376
   231
	}
dvander@1376
   232
	
dvander@1376
   233
	ImplodeStrings(joins, total, ",", buffer, maxlength);
dvander@1376
   234
	
dvander@1376
   235
	return total;
dvander@1376
   236
}
dvander@1376
   237
dvander@923
   238
FlagsToString(String:buffer[], maxlength, flags)
dvander@923
   239
{
dvander@1376
   240
	decl String:joins[FLAG_STRINGS+1][32];
dvander@923
   241
	new total;
teame06@1211
   242
dvander@923
   243
	for (new i=0; i<FLAG_STRINGS; i++)
dvander@923
   244
	{
dvander@923
   245
		if (flags & (1<<i))
dvander@923
   246
		{
dvander@1376
   247
			strcopy(joins[total++], 32, g_FlagNames[i]);
dvander@923
   248
		}
dvander@923
   249
	}
dvander@1376
   250
	
dvander@1376
   251
	decl String:custom_flags[32];
dvander@1376
   252
	if (CustomFlagsToString(custom_flags, sizeof(custom_flags), flags))
dvander@1376
   253
	{
dvander@1376
   254
		Format(joins[total++], 32, "custom(%s)", custom_flags);
dvander@1376
   255
	}
teame06@1211
   256
dvander@923
   257
	ImplodeStrings(joins, total, ", ", buffer, maxlength);
dvander@923
   258
}
dvander@923
   259
dvander@920
   260
public Action:Command_Cvar(client, args)
dvander@920
   261
{
dvander@920
   262
	if (args < 1)
dvander@920
   263
	{
dvander@1839
   264
		if (client == 0)
dvander@1839
   265
		{
dvander@1839
   266
			ReplyToCommand(client, "[SM] Usage: sm_cvar <cvar|protect> [value]");
dvander@1839
   267
		}
dvander@1839
   268
		else
dvander@1839
   269
		{
dvander@1839
   270
			ReplyToCommand(client, "[SM] Usage: sm_cvar <cvar> [value]");
dvander@1839
   271
		}
dvander@920
   272
		return Plugin_Handled;
dvander@920
   273
	}
teame06@1211
   274
dvander@1671
   275
	decl String:cvarname[64];
dvander@920
   276
	GetCmdArg(1, cvarname, sizeof(cvarname));
dvander@1839
   277
	
dvander@1839
   278
	if (client == 0 && StrEqual(cvarname, "protect"))
dvander@1839
   279
	{
dvander@1839
   280
		if (args < 2)
dvander@1839
   281
		{
dvander@1839
   282
			ReplyToCommand(client, "[SM] Usage: sm_cvar <protect> <cvar>");
dvander@1839
   283
			return Plugin_Handled;
dvander@1839
   284
		}
dvander@1839
   285
		GetCmdArg(2, cvarname, sizeof(cvarname));
dvander@1839
   286
		ProtectVar(cvarname);
dvander@1839
   287
		ReplyToCommand(client, "[SM] %t", "Cvar is now protected", cvarname);
dvander@1839
   288
		return Plugin_Handled;
dvander@1839
   289
	}
teame06@1211
   290
dvander@920
   291
	new Handle:hndl = FindConVar(cvarname);
dvander@920
   292
	if (hndl == INVALID_HANDLE)
dvander@920
   293
	{
dvander@920
   294
		ReplyToCommand(client, "[SM] %t", "Unable to find cvar", cvarname);
dvander@920
   295
		return Plugin_Handled;
dvander@920
   296
	}
dvander@1839
   297
	
dvander@920
   298
	new bool:allowed = false;
dvander@1844
   299
	new client_flags = client == 0 ? ADMFLAG_ROOT : GetUserFlagBits(client);
dvander@1839
   300
	
dvander@1839
   301
	if (client_flags & ADMFLAG_ROOT)
dvander@1839
   302
	{
dvander@1839
   303
		allowed = true;
dvander@1839
   304
	}
dvander@1839
   305
	else
dvander@920
   306
	{
dvander@1839
   307
		if (GetConVarFlags(hndl) & FCVAR_PROTECTED)
dvander@920
   308
		{
dvander@1839
   309
			allowed = ((client_flags & ADMFLAG_PASSWORD) == ADMFLAG_PASSWORD);
dvander@920
   310
		}
dvander@1839
   311
		else if (StrEqual(cvarname, "sv_cheats"))
dvander@1839
   312
		{
dvander@1839
   313
			allowed = ((client_flags & ADMFLAG_CHEATS) == ADMFLAG_CHEATS);
dvander@1839
   314
		}
dvander@1839
   315
		else if (!IsVarProtected(cvarname))
dvander@920
   316
		{
dvander@920
   317
			allowed = true;
dvander@920
   318
		}
teame06@1211
   319
	}
dvander@1839
   320
	
dvander@920
   321
	if (!allowed)
dvander@920
   322
	{
dvander@920
   323
		ReplyToCommand(client, "[SM] %t", "No access to cvar");
dvander@920
   324
		return Plugin_Handled;
dvander@920
   325
	}
teame06@1211
   326
dvander@920
   327
	decl String:value[255];
dvander@920
   328
	if (args < 2)
dvander@920
   329
	{
dvander@920
   330
		GetConVarString(hndl, value, sizeof(value));
teame06@1211
   331
dvander@920
   332
		ReplyToCommand(client, "[SM] %t", "Value of cvar", cvarname, value);
dvander@920
   333
		return Plugin_Handled;
dvander@920
   334
	}
teame06@1211
   335
dvander@920
   336
	GetCmdArg(2, value, sizeof(value));
teame06@1211
   337
dvander@920
   338
	if ((GetConVarFlags(hndl) & FCVAR_PROTECTED) != FCVAR_PROTECTED)
dvander@920
   339
	{
dvander@1623
   340
		ShowActivity2(client, "[SM] ", "%t", "Cvar changed", cvarname, value);
dvander@1623
   341
	}
dvander@1623
   342
	else
dvander@1623
   343
	{
dvander@924
   344
		ReplyToCommand(client, "[SM] %t", "Cvar changed", cvarname, value);
dvander@920
   345
	}
teame06@1211
   346
dvander@1378
   347
	LogAction(client, -1, "\"%L\" changed cvar (cvar \"%s\") (value \"%s\")", client, cvarname, value);
teame06@1211
   348
ds@937
   349
	SetConVarString(hndl, value, true);
teame06@1211
   350
dvander@920
   351
	return Plugin_Handled;
dvander@918
   352
}
dvander@918
   353
dvander@918
   354
public Action:Command_Rcon(client, args)
dvander@918
   355
{
dvander@918
   356
	if (args < 1)
dvander@918
   357
	{
dvander@918
   358
		ReplyToCommand(client, "[SM] Usage: sm_rcon <args>");
dvander@918
   359
		return Plugin_Handled;
dvander@918
   360
	}
teame06@1211
   361
dvander@918
   362
	decl String:argstring[255];
dvander@918
   363
	GetCmdArgString(argstring, sizeof(argstring));
teame06@1211
   364
dvander@1378
   365
	LogAction(client, -1, "\"%L\" console command (cmdline \"%s\")", client, argstring);
teame06@1211
   366
dvander@918
   367
	ServerCommand("%s", argstring);
teame06@1211
   368
dvander@918
   369
	return Plugin_Handled;
dvander@917
   370
}