core/PlayerManager.h
author David Anderson <dvander@alliedmods.net>
Sun Feb 01 02:33:31 2009 -0500 (2009-02-01)
changeset 2547 5917289f3c73
parent 2400 76b7b4575e21
child 2591 15213de19689
permissions -rw-r--r--
Added client "sm", "sm credits", and "sm plugins" commands (bug 3570, r=ds,pred).
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
dvander@591
    54
class CPlayer : public IGamePlayer
dvander@591
    55
{
dvander@616
    56
	friend class PlayerManager;
dvander@591
    57
public:
dvander@591
    58
	CPlayer();
dvander@591
    59
public:
dvander@615
    60
	const char *GetName();
dvander@615
    61
	const char *GetIPAddress();
dvander@615
    62
	const char *GetAuthString();
dvander@615
    63
	edict_t *GetEdict();
dvander@615
    64
	bool IsInGame();
dvander@1358
    65
	bool WasCountedAsInGame();
dvander@615
    66
	bool IsConnected();
dvander@615
    67
	bool IsAuthorized();
dvander@615
    68
	bool IsFakeClient();
dvander@591
    69
	void SetAdminId(AdminId id, bool temporary);
dvander@615
    70
	AdminId GetAdminId();
dvander@1161
    71
	void Kick(const char *str);
dvander@1273
    72
	IPlayerInfo *GetPlayerInfo();
faluco@1352
    73
	unsigned int GetLanguageId();
dvander@1350
    74
	int GetUserId();
dvander@1688
    75
	bool RunAdminCacheChecks();
dvander@1688
    76
	void NotifyPostAdminChecks();
dvander@644
    77
public:
dvander@1273
    78
	void DoBasicAdminChecks();
dvander@1509
    79
	bool IsInKickQueue();
dvander@1509
    80
	void MarkAsBeingKicked();
dvander@1621
    81
	int GetLifeState();
dvander@591
    82
private:
dvander@591
    83
	void Initialize(const char *name, const char *ip, edict_t *pEntity);
dvander@591
    84
	void Connect();
dvander@591
    85
	void Disconnect();
dvander@591
    86
	void SetName(const char *name);
dvander@591
    87
	void DumpAdmin(bool deleting);
dvander@1161
    88
	void Authorize(const char *auth);
dvander@1161
    89
	void Authorize_Post();
dvander@1273
    90
	void DoPostConnectAuthorization();
dvander@591
    91
private:
dvander@591
    92
	bool m_IsConnected;
dvander@591
    93
	bool m_IsInGame;
dvander@591
    94
	bool m_IsAuthorized;
dvander@1509
    95
	bool m_bIsInKickQueue;
dvander@591
    96
	String m_Name;
dvander@591
    97
	String m_Ip;
dvander@1161
    98
	String m_IpNoPort;
dvander@591
    99
	String m_AuthID;
dvander@591
   100
	AdminId m_Admin;
dvander@591
   101
	bool m_TempAdmin;
dvander@591
   102
	edict_t *m_pEdict;
dvander@644
   103
	IPlayerInfo *m_Info;
dvander@1161
   104
	String m_LastPassword;
dvander@1273
   105
	bool m_bAdminCheckSignalled;
dvander@1273
   106
	int m_iIndex;
faluco@1352
   107
	unsigned int m_LangId;
dvander@1350
   108
	int m_UserId;
ds@2238
   109
	bool m_bFakeClient;
dvander@591
   110
};
dvander@591
   111
dvander@616
   112
class PlayerManager : 
dvander@591
   113
	public SMGlobalClass,
pred@2323
   114
	public IPlayerManager,
pred@2323
   115
	public IConVarChangeListener
dvander@591
   116
{
dvander@1688
   117
	friend class CPlayer;
dvander@591
   118
public:
dvander@616
   119
	PlayerManager();
dvander@616
   120
	~PlayerManager();
dvander@591
   121
public: //SMGlobalClass
dvander@591
   122
	void OnSourceModAllInitialized();
dvander@591
   123
	void OnSourceModShutdown();
dvander@916
   124
	void OnSourceModLevelEnd();
dvander@1160
   125
	ConfigResult OnSourceModConfigChanged(const char *key, const char *value, ConfigSource source, char *error, size_t maxlength);
pred@2323
   126
	void OnSourceModMaxPlayersChanged(int newvalue);
dvander@591
   127
public:
dvander@591
   128
	CPlayer *GetPlayerByIndex(int client) const;
dvander@591
   129
	void RunAuthChecks();
dvander@591
   130
	void ClearAdminId(AdminId id);
dvander@591
   131
	void ClearAllAdmins();
dvander@591
   132
public:
dvander@591
   133
	bool OnClientConnect(edict_t *pEntity, const char *pszName, const char *pszAddress, char *reject, int maxrejectlen);
dvander@591
   134
	bool OnClientConnect_Post(edict_t *pEntity, const char *pszName, const char *pszAddress, char *reject, int maxrejectlen);
dvander@591
   135
	void OnClientPutInServer(edict_t *pEntity, char const *playername);
dvander@591
   136
	void OnClientDisconnect(edict_t *pEntity);
dvander@591
   137
	void OnClientDisconnect_Post(edict_t *pEntity);
ds@2400
   138
#if SOURCE_ENGINE >= SE_ORANGEBOX
faluco@1541
   139
	void OnClientCommand(edict_t *pEntity, const CCommand &args);
faluco@1541
   140
#else
dvander@591
   141
	void OnClientCommand(edict_t *pEntity);
faluco@1541
   142
#endif
dvander@591
   143
	void OnClientSettingsChanged(edict_t *pEntity);
dvander@1161
   144
	//void OnClientSettingsChanged_Pre(edict_t *pEntity);
dvander@591
   145
public: //IPlayerManager
dvander@591
   146
	void AddClientListener(IClientListener *listener);
dvander@591
   147
	void RemoveClientListener(IClientListener *listener);
dvander@591
   148
	IGamePlayer *GetGamePlayer(int client);
dvander@591
   149
	IGamePlayer *GetGamePlayer(edict_t *pEdict);
dvander@591
   150
	int GetMaxClients();
dvander@591
   151
	int GetNumPlayers();
faluco@682
   152
	int GetClientOfUserId(int userid);
dvander@1485
   153
	bool IsServerActivated();
dvander@1621
   154
	int FilterCommandTarget(IGamePlayer *pAdmin, IGamePlayer *pTarget, int flags);
dvander@1621
   155
	int InternalFilterCommandTarget(CPlayer *pAdmin, CPlayer *pTarget, int flags);
dvander@1621
   156
	void RegisterCommandTargetProcessor(ICommandTargetProcessor *pHandler);
dvander@1621
   157
	void UnregisterCommandTargetProcessor(ICommandTargetProcessor *pHandler);
dvander@1621
   158
	void ProcessCommandTarget(cmd_target_info_t *info);
pred@2323
   159
public: // IConVarChangeListener
pred@2323
   160
	void OnConVarChanged(ConVar *pConVar, const char *oldValue, float flOldValue);
dvander@591
   161
public:
dvander@591
   162
	inline int MaxClients()
dvander@591
   163
	{
dvander@591
   164
		return m_maxClients;
dvander@591
   165
	}
dvander@591
   166
	inline int NumPlayers()
dvander@591
   167
	{
dvander@591
   168
		return m_PlayerCount;
dvander@591
   169
	}
dvander@1996
   170
	inline int ListenClient()
dvander@1996
   171
	{
dvander@1996
   172
		return m_ListenClient;
dvander@1996
   173
	}
dvander@1161
   174
	bool CheckSetAdmin(int index, CPlayer *pPlayer, AdminId id);
dvander@1161
   175
	bool CheckSetAdminName(int index, CPlayer *pPlayer, AdminId id);
dvander@1161
   176
	const char *GetPassInfoVar();
dvander@1162
   177
	void RecheckAnyAdmins();
dvander@1519
   178
	unsigned int GetReplyTo();
dvander@1519
   179
	unsigned int SetReplyTo(unsigned int reply);
pred@2323
   180
	void MaxPlayersChanged(int newvalue = -1);
dvander@591
   181
private:
dvander@591
   182
	void OnServerActivate(edict_t *pEdictList, int edictCount, int clientMax);
ds@2181
   183
	void InvalidatePlayer(CPlayer *pPlayer);
dvander@591
   184
private:
dvander@591
   185
	List<IClientListener *> m_hooks;
dvander@591
   186
	IForward *m_clconnect;
dvander@591
   187
	IForward *m_cldisconnect;
dvander@591
   188
	IForward *m_cldisconnect_post;
dvander@591
   189
	IForward *m_clputinserver;
dvander@591
   190
	IForward *m_clcommand;
dvander@591
   191
	IForward *m_clinfochanged;
dvander@591
   192
	IForward *m_clauth;
dvander@643
   193
	IForward *m_onActivate;
dvander@717
   194
	IForward *m_onActivate2;
dvander@591
   195
	CPlayer *m_Players;
faluco@682
   196
	int *m_UserIdLookUp;
dvander@591
   197
	int m_maxClients;
dvander@591
   198
	int m_PlayerCount;
dvander@591
   199
	bool m_FirstPass;
dvander@591
   200
	unsigned int *m_AuthQueue;
dvander@1160
   201
	String m_PassInfoVar;
faluco@1352
   202
	bool m_QueryLang;
dvander@1996
   203
	bool m_bIsListenServer;
dvander@1996
   204
	int m_ListenClient;
dvander@591
   205
};
dvander@591
   206
ds@2400
   207
#if SOURCE_ENGINE >= SE_ORANGEBOX
pred@2323
   208
void CmdMaxplayersCallback(const CCommand &command);
pred@2323
   209
#else
pred@2323
   210
void CmdMaxplayersCallback();
pred@2323
   211
#endif
pred@2323
   212
dvander@2547
   213
extern void ClientConsolePrint(edict_t *e, const char *fmt, ...);
dvander@2547
   214
dvander@616
   215
extern PlayerManager g_Players;
dvander@848
   216
extern bool g_OnMapStarted;
dvander@1412
   217
extern const unsigned int *g_NumPlayersToAuth;
dvander@591
   218
dvander@591
   219
#endif //_INCLUDE_SOURCEMOD_CPLAYERMANAGER_H_