core/PlayerManager.h
author David Anderson <dvander@alliedmods.net>
Mon Oct 26 23:51:39 2009 -0700 (2009-10-26)
changeset 2832 bf5d37088b6d
parent 2777 d2c1c4ace151
child 3177 c31089f82da4
permissions -rw-r--r--
Don't pass unconnected clients into OnClientCommand (bug 3732, r=fyren).
     1 /**
     2  * vim: set ts=4 :
     3  * =============================================================================
     4  * SourceMod
     5  * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
     6  * =============================================================================
     7  *
     8  * This program is free software; you can redistribute it and/or modify it under
     9  * the terms of the GNU General Public License, version 3.0, as published by the
    10  * Free Software Foundation.
    11  * 
    12  * This program is distributed in the hope that it will be useful, but WITHOUT
    13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    14  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
    15  * details.
    16  *
    17  * You should have received a copy of the GNU General Public License along with
    18  * this program.  If not, see <http://www.gnu.org/licenses/>.
    19  *
    20  * As a special exception, AlliedModders LLC gives you permission to link the
    21  * code of this program (as well as its derivative works) to "Half-Life 2," the
    22  * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
    23  * by the Valve Corporation.  You must obey the GNU General Public License in
    24  * all respects for all other code used.  Additionally, AlliedModders LLC grants
    25  * this exception to all derivative works.  AlliedModders LLC defines further
    26  * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
    27  * or <http://www.sourcemod.net/license.php>.
    28  *
    29  * Version: $Id$
    30  */
    31 
    32 #ifndef _INCLUDE_SOURCEMOD_CPLAYERMANAGER_H_
    33 #define _INCLUDE_SOURCEMOD_CPLAYERMANAGER_H_
    34 
    35 #include "sm_globals.h"
    36 #include <eiface.h>
    37 #include "sourcemm_api.h"
    38 #include <IForwardSys.h>
    39 #include <IPlayerHelpers.h>
    40 #include <IAdminSystem.h>
    41 #include <sh_string.h>
    42 #include <sh_list.h>
    43 #include <sh_vector.h>
    44 #include "ConVarManager.h"
    45 
    46 using namespace SourceHook;
    47 
    48 #define PLAYER_LIFE_UNKNOWN	0
    49 #define PLAYER_LIFE_ALIVE	1
    50 #define PLAYER_LIFE_DEAD	2
    51 
    52 #define MIN_API_FOR_ADMINCALLS		7
    53 
    54 union serial_t
    55 {
    56 	uint32_t   value;
    57 	struct
    58 	{
    59 		uint8_t  index;
    60 		uint32_t serial : 24;
    61 	} bits;
    62 };
    63 
    64 class CPlayer : public IGamePlayer
    65 {
    66 	friend class PlayerManager;
    67 public:
    68 	CPlayer();
    69 public:
    70 	const char *GetName();
    71 	const char *GetIPAddress();
    72 	const char *GetAuthString();
    73 	edict_t *GetEdict();
    74 	bool IsInGame();
    75 	bool WasCountedAsInGame();
    76 	bool IsConnected();
    77 	bool IsAuthorized();
    78 	bool IsFakeClient();
    79 	void SetAdminId(AdminId id, bool temporary);
    80 	AdminId GetAdminId();
    81 	void Kick(const char *str);
    82 	bool IsInKickQueue();
    83 	IPlayerInfo *GetPlayerInfo();
    84 	unsigned int GetLanguageId();
    85 	int GetUserId();
    86 	bool RunAdminCacheChecks();
    87 	void NotifyPostAdminChecks();
    88 	unsigned int GetSerial();
    89 public:
    90 	void DoBasicAdminChecks();
    91 	void MarkAsBeingKicked();
    92 	int GetLifeState();
    93 private:
    94 	void Initialize(const char *name, const char *ip, edict_t *pEntity);
    95 	void Connect();
    96 	void Disconnect();
    97 	void SetName(const char *name);
    98 	void DumpAdmin(bool deleting);
    99 	void Authorize(const char *auth);
   100 	void Authorize_Post();
   101 	void DoPostConnectAuthorization();
   102 private:
   103 	bool m_IsConnected;
   104 	bool m_IsInGame;
   105 	bool m_IsAuthorized;
   106 	bool m_bIsInKickQueue;
   107 	String m_Name;
   108 	String m_Ip;
   109 	String m_IpNoPort;
   110 	String m_AuthID;
   111 	AdminId m_Admin;
   112 	bool m_TempAdmin;
   113 	edict_t *m_pEdict;
   114 	IPlayerInfo *m_Info;
   115 	String m_LastPassword;
   116 	bool m_bAdminCheckSignalled;
   117 	int m_iIndex;
   118 	unsigned int m_LangId;
   119 	int m_UserId;
   120 	bool m_bFakeClient;
   121 	serial_t m_Serial;
   122 };
   123 
   124 class PlayerManager : 
   125 	public SMGlobalClass,
   126 	public IPlayerManager,
   127 	public IConVarChangeListener
   128 {
   129 	friend class CPlayer;
   130 public:
   131 	PlayerManager();
   132 	~PlayerManager();
   133 public: //SMGlobalClass
   134 	void OnSourceModAllInitialized();
   135 	void OnSourceModShutdown();
   136 	void OnSourceModLevelEnd();
   137 	ConfigResult OnSourceModConfigChanged(const char *key, const char *value, ConfigSource source, char *error, size_t maxlength);
   138 	void OnSourceModMaxPlayersChanged(int newvalue);
   139 public:
   140 	CPlayer *GetPlayerByIndex(int client) const;
   141 	void RunAuthChecks();
   142 	void ClearAdminId(AdminId id);
   143 	void ClearAllAdmins();
   144 public:
   145 	bool OnClientConnect(edict_t *pEntity, const char *pszName, const char *pszAddress, char *reject, int maxrejectlen);
   146 	bool OnClientConnect_Post(edict_t *pEntity, const char *pszName, const char *pszAddress, char *reject, int maxrejectlen);
   147 	void OnClientPutInServer(edict_t *pEntity, char const *playername);
   148 	void OnClientDisconnect(edict_t *pEntity);
   149 	void OnClientDisconnect_Post(edict_t *pEntity);
   150 #if SOURCE_ENGINE >= SE_ORANGEBOX
   151 	void OnClientCommand(edict_t *pEntity, const CCommand &args);
   152 #else
   153 	void OnClientCommand(edict_t *pEntity);
   154 #endif
   155 	void OnClientSettingsChanged(edict_t *pEntity);
   156 	//void OnClientSettingsChanged_Pre(edict_t *pEntity);
   157 public: //IPlayerManager
   158 	void AddClientListener(IClientListener *listener);
   159 	void RemoveClientListener(IClientListener *listener);
   160 	IGamePlayer *GetGamePlayer(int client);
   161 	IGamePlayer *GetGamePlayer(edict_t *pEdict);
   162 	int GetMaxClients();
   163 	int GetNumPlayers();
   164 	int GetClientOfUserId(int userid);
   165 	bool IsServerActivated();
   166 	int FilterCommandTarget(IGamePlayer *pAdmin, IGamePlayer *pTarget, int flags);
   167 	int InternalFilterCommandTarget(CPlayer *pAdmin, CPlayer *pTarget, int flags);
   168 	void RegisterCommandTargetProcessor(ICommandTargetProcessor *pHandler);
   169 	void UnregisterCommandTargetProcessor(ICommandTargetProcessor *pHandler);
   170 	void ProcessCommandTarget(cmd_target_info_t *info);
   171 	int GetClientFromSerial(unsigned int serial);
   172 public: // IConVarChangeListener
   173 	void OnConVarChanged(ConVar *pConVar, const char *oldValue, float flOldValue);
   174 public:
   175 	inline int MaxClients()
   176 	{
   177 		return m_maxClients;
   178 	}
   179 	inline int NumPlayers()
   180 	{
   181 		return m_PlayerCount;
   182 	}
   183 	inline int ListenClient()
   184 	{
   185 		return m_ListenClient;
   186 	}
   187 	bool CheckSetAdmin(int index, CPlayer *pPlayer, AdminId id);
   188 	bool CheckSetAdminName(int index, CPlayer *pPlayer, AdminId id);
   189 	const char *GetPassInfoVar();
   190 	void RecheckAnyAdmins();
   191 	unsigned int GetReplyTo();
   192 	unsigned int SetReplyTo(unsigned int reply);
   193 	void MaxPlayersChanged(int newvalue = -1);
   194 private:
   195 	void OnServerActivate(edict_t *pEdictList, int edictCount, int clientMax);
   196 	void InvalidatePlayer(CPlayer *pPlayer);
   197 private:
   198 	List<IClientListener *> m_hooks;
   199 	IForward *m_clconnect;
   200 	IForward *m_cldisconnect;
   201 	IForward *m_cldisconnect_post;
   202 	IForward *m_clputinserver;
   203 	IForward *m_clcommand;
   204 	IForward *m_clinfochanged;
   205 	IForward *m_clauth;
   206 	IForward *m_onActivate;
   207 	IForward *m_onActivate2;
   208 	CPlayer *m_Players;
   209 	int *m_UserIdLookUp;
   210 	int m_maxClients;
   211 	int m_PlayerCount;
   212 	bool m_FirstPass;
   213 	unsigned int *m_AuthQueue;
   214 	String m_PassInfoVar;
   215 	bool m_QueryLang;
   216 	bool m_bIsListenServer;
   217 	int m_ListenClient;
   218 };
   219 
   220 #if SOURCE_ENGINE >= SE_ORANGEBOX
   221 void CmdMaxplayersCallback(const CCommand &command);
   222 #else
   223 void CmdMaxplayersCallback();
   224 #endif
   225 
   226 extern void ClientConsolePrint(edict_t *e, const char *fmt, ...);
   227 
   228 extern PlayerManager g_Players;
   229 extern bool g_OnMapStarted;
   230 extern const unsigned int *g_NumPlayersToAuth;
   231 
   232 #endif //_INCLUDE_SOURCEMOD_CPLAYERMANAGER_H_