core/ConCmdManager.h
author David Anderson <dvander@alliedmods.net>
Sun Aug 26 17:41:02 2007 +0000 (2007-08-26)
changeset 1369 bd9ccced1b1a
parent 1349 0d84046ec139
child 1435 18b0febf4e60
permissions -rw-r--r--
fixed amb834 - command callbacks could potentially occur on invalid clients in very rare cases
ds@579
     1
/**
ds@579
     2
 * vim: set ts=4 :
ds@1330
     3
 * =============================================================================
dvander@1231
     4
 * SourceMod
dvander@1231
     5
 * Copyright (C) 2004-2007 AlliedModders LLC.  All rights reserved.
ds@1330
     6
 * =============================================================================
ds@579
     7
 *
ds@1330
     8
 * This program is free software; you can redistribute it and/or modify it under
ds@1330
     9
 * the terms of the GNU General Public License, version 3.0, as published by the
ds@1330
    10
 * Free Software Foundation.
dvander@1231
    11
 * 
ds@1330
    12
 * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1330
    13
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1330
    14
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
ds@1330
    15
 * details.
dvander@1231
    16
 *
ds@1330
    17
 * You should have received a copy of the GNU General Public License along with
ds@1330
    18
 * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1231
    19
 *
ds@1330
    20
 * As a special exception, AlliedModders LLC gives you permission to link the
ds@1330
    21
 * code of this program (as well as its derivative works) to "Half-Life 2," the
ds@1330
    22
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1330
    23
 * by the Valve Corporation.  You must obey the GNU General Public License in
ds@1330
    24
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
ds@1330
    25
 * this exception to all derivative works.  AlliedModders LLC defines further
ds@1330
    26
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1330
    27
 * or <http://www.sourcemod.net/license.php>.
ds@579
    28
 *
ds@579
    29
 * Version: $Id$
ds@579
    30
 */
ds@579
    31
ds@579
    32
#ifndef _INCLUDE_SOURCEMOD_CONCMDMANAGER_H_
ds@579
    33
#define _INCLUDE_SOURCEMOD_CONCMDMANAGER_H_
ds@579
    34
ds@579
    35
#include "sm_globals.h"
ds@579
    36
#include "sourcemm_api.h"
ds@579
    37
#include "ForwardSys.h"
ds@579
    38
#include "sm_trie.h"
ds@579
    39
#include "sm_memtable.h"
ds@579
    40
#include <sh_list.h>
ds@579
    41
#include <sh_string.h>
ds@579
    42
#include <IRootConsoleMenu.h>
ds@579
    43
#include <IAdminSystem.h>
ds@579
    44
ds@579
    45
using namespace SourceHook;
ds@579
    46
ds@579
    47
enum CmdType
ds@579
    48
{
ds@579
    49
	Cmd_Server,
ds@579
    50
	Cmd_Console,
ds@579
    51
	Cmd_Admin,
ds@579
    52
};
ds@579
    53
ds@579
    54
struct AdminCmdInfo
ds@579
    55
{
ds@579
    56
	AdminCmdInfo()
ds@579
    57
	{
ds@579
    58
		cmdGrpId = -1;
ds@579
    59
		flags = 0;
ds@579
    60
		eflags = 0;
ds@579
    61
	}
ds@579
    62
	int cmdGrpId;			/* index into cmdgroup string table */
ds@579
    63
	FlagBits flags;			/* default flags */
ds@579
    64
	FlagBits eflags;		/* effective flags */
ds@579
    65
};
ds@579
    66
ds@579
    67
struct CmdHook
ds@579
    68
{
ds@579
    69
	CmdHook()
ds@579
    70
	{
ds@579
    71
		pf = NULL;
ds@579
    72
		pAdmin = NULL;
ds@579
    73
	}
ds@579
    74
	IPluginFunction *pf;	/* function hook */
ds@579
    75
	String helptext;		/* help text */
ds@579
    76
	AdminCmdInfo *pAdmin;	/* admin requirements, if any */
ds@579
    77
};
ds@579
    78
ds@579
    79
struct ConCmdInfo
ds@579
    80
{
ds@579
    81
	ConCmdInfo()
ds@579
    82
	{
ds@579
    83
		sourceMod = false;
ds@579
    84
		pCmd = NULL;
ds@579
    85
	}
ds@579
    86
	bool sourceMod;					/**< Determines whether or not concmd was created by a SourceMod plugin */
ds@579
    87
	ConCommand *pCmd;				/**< Pointer to the command itself */
ds@579
    88
	List<CmdHook *> srvhooks;		/**< Hooks as a server command */
ds@579
    89
	List<CmdHook *> conhooks;		/**< Hooks as a console command */
dvander@1119
    90
	AdminCmdInfo admin;				/**< Admin info, if any */
dvander@1349
    91
	bool is_admin_set;				/**< Whether or not admin info is set */
ds@579
    92
};
ds@579
    93
ds@579
    94
class ConCmdManager :
ds@579
    95
	public SMGlobalClass,
ds@579
    96
	public IRootConsoleCommand,
ds@579
    97
	public IPluginsListener
ds@579
    98
{
ds@579
    99
	friend void CommandCallback();
ds@579
   100
public:
ds@579
   101
	ConCmdManager();
ds@579
   102
	~ConCmdManager();
ds@579
   103
public: //SMGlobalClass
ds@579
   104
	void OnSourceModAllInitialized();
ds@579
   105
	void OnSourceModShutdown();
ds@579
   106
public: //IPluginsListener
ds@579
   107
	void OnPluginDestroyed(IPlugin *plugin);
ds@579
   108
public: //IRootConsoleCommand
ds@579
   109
	void OnRootConsoleCommand(const char *command, unsigned int argcount);
ds@579
   110
public:
ds@579
   111
	bool AddServerCommand(IPluginFunction *pFunction, const char *name, const char *description, int flags);
ds@579
   112
	bool AddConsoleCommand(IPluginFunction *pFunction, const char *name, const char *description, int flags);
ds@579
   113
	bool AddAdminCommand(IPluginFunction *pFunction, 
ds@579
   114
						 const char *name, 
ds@579
   115
						 const char *group,
ds@579
   116
						 int adminflags,
ds@579
   117
						 const char *description, 
ds@579
   118
						 int flags);
dvander@1335
   119
	ResultType DispatchClientCommand(int client, const char *cmd, int args, ResultType type);
ds@579
   120
	void UpdateAdminCmdFlags(const char *cmd, OverrideType type, FlagBits bits);
dvander@893
   121
	bool LookForSourceModCommand(const char *cmd);
dvander@1349
   122
	bool LookForCommandAdminFlags(const char *cmd, FlagBits *pFlags);
dvander@1119
   123
	bool CheckCommandAccess(int client, const char *cmd, FlagBits flags);
ds@579
   124
private:
ds@579
   125
	void InternalDispatch();
ds@579
   126
	ResultType RunAdminCommand(ConCmdInfo *pInfo, int client, int args);
ds@579
   127
	ConCmdInfo *AddOrFindCommand(const char *name, const char *description, int flags);
ds@579
   128
	void SetCommandClient(int client);
ds@579
   129
	void AddToCmdList(ConCmdInfo *info);
ds@579
   130
	void RemoveConCmd(ConCmdInfo *info);
ds@579
   131
	void RemoveConCmds(List<CmdHook *> &cmdlist, IPluginContext *pContext);
ds@579
   132
	bool CheckAccess(int client, const char *cmd, AdminCmdInfo *pAdmin);
dvander@769
   133
public:
dvander@769
   134
	inline int GetCommandClient()
dvander@769
   135
	{
dvander@769
   136
		return m_CmdClient;
dvander@769
   137
	}
dvander@1119
   138
	inline const List<ConCmdInfo *> & GetCommandList()
dvander@1119
   139
	{
dvander@1119
   140
		return m_CmdList;
dvander@1119
   141
	}
ds@579
   142
private:
ds@579
   143
	Trie *m_pCmds;					/* command lookup */
ds@579
   144
	Trie *m_pCmdGrps;				/* command group lookup */
ds@579
   145
	List<ConCmdInfo *> m_CmdList;	/* command list */
ds@579
   146
	int m_CmdClient;				/* current client */
ds@579
   147
	BaseStringTable m_Strings;		/* string table */
ds@579
   148
};
ds@579
   149
ds@579
   150
extern ConCmdManager g_ConCmds;
ds@579
   151
ds@579
   152
#endif // _INCLUDE_SOURCEMOD_CONCMDMANAGER_H_