core/PlayerManager.h
author Kyle Sanderson <kyle.leet@gmail.com>
Sun Mar 17 21:58:56 2013 +0000 (2013-03-17)
changeset 3837 f86a51ee4eb4
parent 3825 ecd2382ca37e
child 3899 fd4ec50a0d6c
permissions -rw-r--r--
Check for cloned handles when dumping (bug 5245, r=asherkin).
dvander@591
     1
/**
ds@653
     2
 * vim: set ts=4 :
ds@1330
     3
 * =============================================================================
dvander@1231
     4
 * SourceMod
ds@1947
     5
 * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
ds@1330
     6
 * =============================================================================
dvander@591
     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>.
dvander@591
    28
 *
dvander@591
    29
 * Version: $Id$
dvander@591
    30
 */
dvander@591
    31
dvander@591
    32
#ifndef _INCLUDE_SOURCEMOD_CPLAYERMANAGER_H_
dvander@591
    33
#define _INCLUDE_SOURCEMOD_CPLAYERMANAGER_H_
dvander@591
    34
dvander@591
    35
#include "sm_globals.h"
dvander@591
    36
#include <eiface.h>
dvander@591
    37
#include "sourcemm_api.h"
dvander@591
    38
#include <IForwardSys.h>
dvander@591
    39
#include <IPlayerHelpers.h>
dvander@591
    40
#include <IAdminSystem.h>
dvander@591
    41
#include <sh_string.h>
dvander@591
    42
#include <sh_list.h>
dvander@591
    43
#include <sh_vector.h>
pred@2323
    44
#include "ConVarManager.h"
dvander@591
    45
dvander@591
    46
using namespace SourceHook;
dvander@591
    47
dvander@1621
    48
#define PLAYER_LIFE_UNKNOWN	0
dvander@1621
    49
#define PLAYER_LIFE_ALIVE	1
dvander@1621
    50
#define PLAYER_LIFE_DEAD	2
dvander@1621
    51
dvander@1688
    52
#define MIN_API_FOR_ADMINCALLS		7
dvander@1688
    53
pred@2591
    54
union serial_t
pred@2591
    55
{
pred@2591
    56
	uint32_t   value;
pred@2591
    57
	struct
pred@2591
    58
	{
asherkin@3488
    59
		uint32_t index  :  8;
pred@2591
    60
		uint32_t serial : 24;
pred@2591
    61
	} bits;
pred@2591
    62
};
pred@2591
    63
dvander@591
    64
class CPlayer : public IGamePlayer
dvander@591
    65
{
dvander@616
    66
	friend class PlayerManager;
dvander@591
    67
public:
dvander@591
    68
	CPlayer();
dvander@591
    69
public:
dvander@615
    70
	const char *GetName();
dvander@615
    71
	const char *GetIPAddress();
asherkin@3808
    72
	const char *GetAuthString(bool validated = true);
kyle@3825
    73
	unsigned int GetSteamAccountID(bool validated = true);
dvander@615
    74
	edict_t *GetEdict();
dvander@615
    75
	bool IsInGame();
dvander@1358
    76
	bool WasCountedAsInGame();
dvander@615
    77
	bool IsConnected();
dvander@615
    78
	bool IsAuthorized();
dvander@615
    79
	bool IsFakeClient();
skamonkey@3418
    80
	bool IsSourceTV() const;
skamonkey@3418
    81
	bool IsReplay() const;
dvander@591
    82
	void SetAdminId(AdminId id, bool temporary);
dvander@615
    83
	AdminId GetAdminId();
dvander@1161
    84
	void Kick(const char *str);
theY4Kman@2777
    85
	bool IsInKickQueue();
dvander@1273
    86
	IPlayerInfo *GetPlayerInfo();
faluco@1352
    87
	unsigned int GetLanguageId();
skamonkey@3213
    88
	void SetLanguageId(unsigned int id);
dvander@1350
    89
	int GetUserId();
dvander@1688
    90
	bool RunAdminCacheChecks();
dvander@1688
    91
	void NotifyPostAdminChecks();
pred@2591
    92
	unsigned int GetSerial();
dvander@644
    93
public:
dvander@1273
    94
	void DoBasicAdminChecks();
dvander@1509
    95
	void MarkAsBeingKicked();
dvander@1621
    96
	int GetLifeState();
dvander@591
    97
private:
dvander@591
    98
	void Initialize(const char *name, const char *ip, edict_t *pEntity);
dvander@591
    99
	void Connect();
dvander@591
   100
	void Disconnect();
dvander@591
   101
	void SetName(const char *name);
dvander@591
   102
	void DumpAdmin(bool deleting);
asherkin@3808
   103
	void SetAuthString(const char *auth);
asherkin@3808
   104
	void Authorize();
dvander@1161
   105
	void Authorize_Post();
dvander@1273
   106
	void DoPostConnectAuthorization();
asherkin@3808
   107
	bool IsAuthStringValidated();
dvander@591
   108
private:
dvander@591
   109
	bool m_IsConnected;
dvander@591
   110
	bool m_IsInGame;
dvander@591
   111
	bool m_IsAuthorized;
dvander@1509
   112
	bool m_bIsInKickQueue;
dvander@591
   113
	String m_Name;
dvander@591
   114
	String m_Ip;
dvander@1161
   115
	String m_IpNoPort;
dvander@591
   116
	String m_AuthID;
dvander@591
   117
	AdminId m_Admin;
dvander@591
   118
	bool m_TempAdmin;
dvander@591
   119
	edict_t *m_pEdict;
dvander@644
   120
	IPlayerInfo *m_Info;
dvander@1161
   121
	String m_LastPassword;
dvander@1273
   122
	bool m_bAdminCheckSignalled;
dvander@1273
   123
	int m_iIndex;
faluco@1352
   124
	unsigned int m_LangId;
dvander@1350
   125
	int m_UserId;
ds@2238
   126
	bool m_bFakeClient;
skamonkey@3418
   127
	bool m_bIsSourceTV;
skamonkey@3418
   128
	bool m_bIsReplay;
pred@2591
   129
	serial_t m_Serial;
kyle@3825
   130
	unsigned int m_SteamAccountID;
dvander@591
   131
};
dvander@591
   132
dvander@616
   133
class PlayerManager : 
dvander@591
   134
	public SMGlobalClass,
skamonkey@3186
   135
	public IPlayerManager
dvander@591
   136
{
dvander@1688
   137
	friend class CPlayer;
dvander@591
   138
public:
dvander@616
   139
	PlayerManager();
dvander@616
   140
	~PlayerManager();
dvander@591
   141
public: //SMGlobalClass
dvander@591
   142
	void OnSourceModAllInitialized();
dvander@591
   143
	void OnSourceModShutdown();
dvander@916
   144
	void OnSourceModLevelEnd();
dvander@1160
   145
	ConfigResult OnSourceModConfigChanged(const char *key, const char *value, ConfigSource source, char *error, size_t maxlength);
skamonkey@3350
   146
	void OnSourceModMaxPlayersChanged(int newvalue);
dvander@591
   147
public:
dvander@591
   148
	CPlayer *GetPlayerByIndex(int client) const;
dvander@591
   149
	void RunAuthChecks();
dvander@591
   150
	void ClearAdminId(AdminId id);
dvander@591
   151
	void ClearAllAdmins();
dvander@591
   152
public:
dvander@591
   153
	bool OnClientConnect(edict_t *pEntity, const char *pszName, const char *pszAddress, char *reject, int maxrejectlen);
dvander@591
   154
	bool OnClientConnect_Post(edict_t *pEntity, const char *pszName, const char *pszAddress, char *reject, int maxrejectlen);
dvander@591
   155
	void OnClientPutInServer(edict_t *pEntity, char const *playername);
dvander@591
   156
	void OnClientDisconnect(edict_t *pEntity);
dvander@591
   157
	void OnClientDisconnect_Post(edict_t *pEntity);
ds@2400
   158
#if SOURCE_ENGINE >= SE_ORANGEBOX
faluco@1541
   159
	void OnClientCommand(edict_t *pEntity, const CCommand &args);
faluco@1541
   160
#else
dvander@591
   161
	void OnClientCommand(edict_t *pEntity);
faluco@1541
   162
#endif
dvander@591
   163
	void OnClientSettingsChanged(edict_t *pEntity);
dvander@1161
   164
	//void OnClientSettingsChanged_Pre(edict_t *pEntity);
dvander@591
   165
public: //IPlayerManager
dvander@591
   166
	void AddClientListener(IClientListener *listener);
dvander@591
   167
	void RemoveClientListener(IClientListener *listener);
dvander@591
   168
	IGamePlayer *GetGamePlayer(int client);
dvander@591
   169
	IGamePlayer *GetGamePlayer(edict_t *pEdict);
dvander@591
   170
	int GetMaxClients();
dvander@591
   171
	int GetNumPlayers();
faluco@682
   172
	int GetClientOfUserId(int userid);
skamonkey@3347
   173
	bool IsServerActivated();
dvander@1621
   174
	int FilterCommandTarget(IGamePlayer *pAdmin, IGamePlayer *pTarget, int flags);
dvander@1621
   175
	int InternalFilterCommandTarget(CPlayer *pAdmin, CPlayer *pTarget, int flags);
dvander@1621
   176
	void RegisterCommandTargetProcessor(ICommandTargetProcessor *pHandler);
dvander@1621
   177
	void UnregisterCommandTargetProcessor(ICommandTargetProcessor *pHandler);
dvander@1621
   178
	void ProcessCommandTarget(cmd_target_info_t *info);
pred@2591
   179
	int GetClientFromSerial(unsigned int serial);
dvander@591
   180
public:
dvander@591
   181
	inline int MaxClients()
dvander@591
   182
	{
skamonkey@3350
   183
		return m_maxClients;
dvander@591
   184
	}
dvander@591
   185
	inline int NumPlayers()
dvander@591
   186
	{
dvander@591
   187
		return m_PlayerCount;
dvander@591
   188
	}
dvander@1996
   189
	inline int ListenClient()
dvander@1996
   190
	{
dvander@1996
   191
		return m_ListenClient;
dvander@1996
   192
	}
dvander@1161
   193
	bool CheckSetAdmin(int index, CPlayer *pPlayer, AdminId id);
dvander@1161
   194
	bool CheckSetAdminName(int index, CPlayer *pPlayer, AdminId id);
dvander@1161
   195
	const char *GetPassInfoVar();
dvander@1162
   196
	void RecheckAnyAdmins();
dvander@1519
   197
	unsigned int GetReplyTo();
dvander@1519
   198
	unsigned int SetReplyTo(unsigned int reply);
pred@2323
   199
	void MaxPlayersChanged(int newvalue = -1);
dvander@591
   200
private:
dvander@591
   201
	void OnServerActivate(edict_t *pEdictList, int edictCount, int clientMax);
ds@2181
   202
	void InvalidatePlayer(CPlayer *pPlayer);
dvander@591
   203
private:
dvander@591
   204
	List<IClientListener *> m_hooks;
dvander@591
   205
	IForward *m_clconnect;
asherkin@3177
   206
	IForward *m_clconnect_post;
dvander@591
   207
	IForward *m_cldisconnect;
dvander@591
   208
	IForward *m_cldisconnect_post;
dvander@591
   209
	IForward *m_clputinserver;
dvander@591
   210
	IForward *m_clcommand;
dvander@591
   211
	IForward *m_clinfochanged;
dvander@591
   212
	IForward *m_clauth;
dvander@643
   213
	IForward *m_onActivate;
dvander@717
   214
	IForward *m_onActivate2;
dvander@591
   215
	CPlayer *m_Players;
faluco@682
   216
	int *m_UserIdLookUp;
skamonkey@3350
   217
	int m_maxClients;
dvander@591
   218
	int m_PlayerCount;
skamonkey@3418
   219
	int m_PlayersSinceActive;
dvander@591
   220
	bool m_FirstPass;
dvander@591
   221
	unsigned int *m_AuthQueue;
dvander@1160
   222
	String m_PassInfoVar;
faluco@1352
   223
	bool m_QueryLang;
asherkin@3808
   224
	bool m_bAuthstringValidation; // are we validating admins with steam before authorizing?
dvander@1996
   225
	bool m_bIsListenServer;
dvander@1996
   226
	int m_ListenClient;
skamonkey@3418
   227
	bool m_bIsSourceTVActive;
skamonkey@3418
   228
	bool m_bIsReplayActive;
skamonkey@3418
   229
	int m_SourceTVUserId;
skamonkey@3418
   230
	int m_ReplayUserId;
dvander@591
   231
};
dvander@591
   232
ds@2400
   233
#if SOURCE_ENGINE >= SE_ORANGEBOX
pred@2323
   234
void CmdMaxplayersCallback(const CCommand &command);
pred@2323
   235
#else
pred@2323
   236
void CmdMaxplayersCallback();
pred@2323
   237
#endif
pred@2323
   238
dvander@2547
   239
extern void ClientConsolePrint(edict_t *e, const char *fmt, ...);
dvander@2547
   240
dvander@616
   241
extern PlayerManager g_Players;
dvander@848
   242
extern bool g_OnMapStarted;
dvander@1412
   243
extern const unsigned int *g_NumPlayersToAuth;
dvander@591
   244
dvander@591
   245
#endif //_INCLUDE_SOURCEMOD_CPLAYERMANAGER_H_