core/PlayerManager.cpp
author David Anderson <dvander@alliedmods.net>
Mon Mar 19 01:44:09 2007 +0000 (2007-03-19)
changeset 647 1e29dcc9ca97
parent 644 2a90d4324fc0
child 648 a351d398632b
permissions -rw-r--r--
fixed a potential bug with kicking players during authorization
     1 /**
     2  * ===============================================================
     3  * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.
     4  * ===============================================================
     5  *
     6  * This file is not open source and may not be copied without explicit
     7  * written permission of AlliedModders LLC.  This file may not be redistributed 
     8  * in whole or significant part.
     9  * For information, see LICENSE.txt or http://www.sourcemod.net/license.php
    10  *
    11  * Version: $Id$
    12  */
    13 
    14 #include "PlayerManager.h"
    15 #include "ForwardSys.h"
    16 #include "ShareSys.h"
    17 #include "AdminCache.h"
    18 #include "ConCmdManager.h"
    19 
    20 PlayerManager g_Players;
    21 
    22 SH_DECL_HOOK5(IServerGameClients, ClientConnect, SH_NOATTRIB, 0, bool, edict_t *, const char *, const char *, char *, int);
    23 SH_DECL_HOOK2_void(IServerGameClients, ClientPutInServer, SH_NOATTRIB, 0, edict_t *, const char *);
    24 SH_DECL_HOOK1_void(IServerGameClients, ClientDisconnect, SH_NOATTRIB, 0, edict_t *);
    25 SH_DECL_HOOK1_void(IServerGameClients, ClientCommand, SH_NOATTRIB, 0, edict_t *);
    26 SH_DECL_HOOK1_void(IServerGameClients, ClientSettingsChanged, SH_NOATTRIB, 0, edict_t *);
    27 SH_DECL_HOOK3_void(IServerGameDLL, ServerActivate, SH_NOATTRIB, 0, edict_t *, int, int);
    28 
    29 PlayerManager::PlayerManager()
    30 {
    31 	m_AuthQueue = NULL;
    32 	m_FirstPass = true;
    33 }
    34 
    35 PlayerManager::~PlayerManager()
    36 {
    37 	delete [] m_AuthQueue;
    38 }
    39 
    40 void PlayerManager::OnSourceModAllInitialized()
    41 {
    42 	SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientConnect, serverClients, this, &PlayerManager::OnClientConnect, false);
    43 	SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientConnect, serverClients, this, &PlayerManager::OnClientConnect_Post, true);
    44 	SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientPutInServer, serverClients, this, &PlayerManager::OnClientPutInServer, true);
    45 	SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, serverClients, this, &PlayerManager::OnClientDisconnect, false);
    46 	SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, serverClients, this, &PlayerManager::OnClientDisconnect_Post, true);
    47 	SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientCommand, serverClients, this, &PlayerManager::OnClientCommand, false);
    48 	SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientSettingsChanged, serverClients, this, &PlayerManager::OnClientSettingsChanged, true);
    49 	SH_ADD_HOOK_MEMFUNC(IServerGameDLL, ServerActivate, gamedll, this, &PlayerManager::OnServerActivate, true);
    50 
    51 	g_ShareSys.AddInterface(NULL, this);
    52 
    53 	ParamType p1[] = {Param_Cell, Param_String, Param_Cell};
    54 	ParamType p2[] = {Param_Cell};
    55 
    56 	m_clconnect = g_Forwards.CreateForward("OnClientConnect", ET_Event, 3, p1);
    57 	m_clputinserver = g_Forwards.CreateForward("OnClientPutInServer", ET_Ignore, 1, p2);
    58 	m_cldisconnect = g_Forwards.CreateForward("OnClientDisconnect", ET_Ignore, 1, p2);
    59 	m_cldisconnect_post = g_Forwards.CreateForward("OnClientDisconnect_Post", ET_Ignore, 1, p2);
    60 	m_clcommand = g_Forwards.CreateForward("OnClientCommand", ET_Hook, 2, NULL, Param_Cell, Param_Cell);
    61 	m_clinfochanged = g_Forwards.CreateForward("OnClientSettingsChanged", ET_Ignore, 1, p2);
    62 	m_clauth = g_Forwards.CreateForward("OnClientAuthorized", ET_Ignore, 2, NULL, Param_Cell, Param_String);
    63 	m_onActivate = g_Forwards.CreateForward("OnServerLoad", ET_Ignore, 0, NULL);
    64 }
    65 
    66 void PlayerManager::OnSourceModShutdown()
    67 {
    68 	SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientConnect, serverClients, this, &PlayerManager::OnClientConnect, false);
    69 	SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientPutInServer, serverClients, this, &PlayerManager::OnClientPutInServer, true);
    70 	SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, serverClients, this, &PlayerManager::OnClientDisconnect, false);
    71 	SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, serverClients, this, &PlayerManager::OnClientDisconnect_Post, true);
    72 	SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientCommand, serverClients, this, &PlayerManager::OnClientCommand, false);
    73 	SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientSettingsChanged, serverClients, this, &PlayerManager::OnClientSettingsChanged, true);
    74 	SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, ServerActivate, gamedll, this, &PlayerManager::OnServerActivate, true);
    75 
    76 	/* Release forwards */
    77 	g_Forwards.ReleaseForward(m_clconnect);
    78 	g_Forwards.ReleaseForward(m_clputinserver);
    79 	g_Forwards.ReleaseForward(m_cldisconnect);
    80 	g_Forwards.ReleaseForward(m_cldisconnect_post);
    81 	g_Forwards.ReleaseForward(m_clcommand);
    82 	g_Forwards.ReleaseForward(m_clinfochanged);
    83 	g_Forwards.ReleaseForward(m_clauth);
    84 	g_Forwards.ReleaseForward(m_onActivate);
    85 
    86 	delete [] m_Players;
    87 }
    88 
    89 void PlayerManager::OnServerActivate(edict_t *pEdictList, int edictCount, int clientMax)
    90 {
    91 	if (m_FirstPass)
    92 	{
    93 		/* Initialize all players */
    94 		m_maxClients = clientMax;
    95 		m_PlayerCount = 0;
    96 		m_Players = new CPlayer[m_maxClients + 1];
    97 		m_AuthQueue = new unsigned int[m_maxClients + 1];
    98 		m_FirstPass = false;
    99 
   100 		memset(m_AuthQueue, 0, sizeof(unsigned int) * (m_maxClients + 1));
   101 	}
   102 	m_onActivate->Execute(NULL);
   103 }
   104 
   105 void PlayerManager::RunAuthChecks()
   106 {
   107 	CPlayer *pPlayer;
   108 	const char *authstr;
   109 	unsigned int removed = 0;
   110 	for (unsigned int i=1; i<=m_AuthQueue[0]; i++)
   111 	{
   112 		pPlayer = GetPlayerByIndex(m_AuthQueue[i]);
   113 		authstr = engine->GetPlayerNetworkIDString(pPlayer->m_pEdict);
   114 		if (authstr && authstr[0] != '\0'
   115 			&& (strcmp(authstr, "STEAM_ID_PENDING") != 0))
   116 		{
   117 			/* Set authorization */
   118 			pPlayer->m_AuthID.assign(authstr);
   119 			pPlayer->m_IsAuthorized = true;
   120 
   121 			/* Mark as removed from queue */
   122 			m_AuthQueue[i] = 0;
   123 			removed++;
   124 
   125 			/* Send to extensions */
   126 			List<IClientListener *>::iterator iter;
   127 			IClientListener *pListener;
   128 			for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
   129 			{
   130 				pListener = (*iter);
   131 				pListener->OnClientAuthorized(m_AuthQueue[i], authstr);
   132 				if (!pPlayer->IsConnected())
   133 				{
   134 					break;
   135 				}
   136 			}
   137 
   138 			/* Send to plugins if player is still connected */
   139 			if (pPlayer->IsConnected() && m_clauth->GetFunctionCount())
   140 			{
   141 				/* :TODO: handle the case of a player disconnecting in the middle */
   142 				m_clauth->PushCell(m_AuthQueue[i]);
   143 				m_clauth->PushString(authstr);
   144 				m_clauth->Execute(NULL);
   145 			}
   146 		}
   147 	}
   148 
   149 	/* Clean up the queue */
   150 	if (removed)
   151 	{
   152 		/* We don't have to compcat the list if it's empty */
   153 		if (removed != m_AuthQueue[0])
   154 		{
   155 			unsigned int diff = 0;
   156 			for (unsigned int i=1; i<=m_AuthQueue[0]; i++)
   157 			{
   158 				/* If this member is removed... */
   159 				if (m_AuthQueue[i] == 0)
   160 				{
   161 					/* Increase the differential */
   162 					diff++;
   163 				} else {
   164 					/* diff cannot increase faster than i+1 */
   165 					assert(i > diff);
   166 					assert(i - diff >= 1);
   167 					/* move this index down */
   168 					m_AuthQueue[i - diff] = m_AuthQueue[i];
   169 				}
   170 			}
   171 			m_AuthQueue[0] -= removed;
   172 		} else {
   173 			m_AuthQueue[0] = 0;
   174 			g_SourceMod.SetAuthChecking(false);
   175 		}
   176 	}
   177 }
   178 
   179 bool PlayerManager::OnClientConnect(edict_t *pEntity, const char *pszName, const char *pszAddress, char *reject, int maxrejectlen)
   180 {
   181 	int client = engine->IndexOfEdict(pEntity);
   182 
   183 	List<IClientListener *>::iterator iter;
   184 	IClientListener *pListener = NULL;
   185 	for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
   186 	{
   187 		pListener = (*iter);
   188 		if (!pListener->InterceptClientConnect(client, reject, maxrejectlen))
   189 		{
   190 			return false;
   191 		}
   192 	}
   193 
   194 	cell_t res = 1;
   195 
   196 	m_Players[client].Initialize(pszName, pszAddress, pEntity);
   197 	m_clconnect->PushCell(client);
   198 	m_clconnect->PushStringEx(reject, maxrejectlen, SM_PARAM_STRING_UTF8, SM_PARAM_COPYBACK);
   199 	m_clconnect->PushCell(maxrejectlen);
   200 	m_clconnect->Execute(&res, NULL);
   201 
   202 	if (res)
   203 	{
   204 		if (!m_Players[client].IsAuthorized())
   205 		{
   206 			m_AuthQueue[++m_AuthQueue[0]] = client;
   207 			g_SourceMod.SetAuthChecking(true);
   208 		}
   209 	} else {
   210 		RETURN_META_VALUE(MRES_SUPERCEDE, false);
   211 	}
   212 
   213 	return true;
   214 }
   215 
   216 bool PlayerManager::OnClientConnect_Post(edict_t *pEntity, const char *pszName, const char *pszAddress, char *reject, int maxrejectlen)
   217 {
   218 	int client = engine->IndexOfEdict(pEntity);
   219 	bool orig_value = META_RESULT_ORIG_RET(bool);
   220 	if (orig_value)
   221 	{
   222 		List<IClientListener *>::iterator iter;
   223 		IClientListener *pListener = NULL;
   224 		for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
   225 		{
   226 			pListener = (*iter);
   227 			pListener->OnClientConnected(client);
   228 		}
   229 	}
   230 
   231 	return true;
   232 }
   233 
   234 void PlayerManager::OnClientPutInServer(edict_t *pEntity, const char *playername)
   235 {
   236 	cell_t res;
   237 	int client = engine->IndexOfEdict(pEntity);
   238 
   239 	CPlayer *pPlayer = GetPlayerByIndex(client);
   240 	/* If they're not connected, they're a bot */
   241 	if (!pPlayer->IsConnected())
   242 	{
   243 		/* Run manual connection routines */
   244 		char error[255];
   245 		const char *authid = engine->GetPlayerNetworkIDString(pEntity);
   246 		pPlayer->Authorize(authid);
   247 		if (!OnClientConnect(pEntity, playername, "127.0.0.1", error, sizeof(error)))
   248 		{
   249 			/* :TODO: kick the bot if it's rejected */
   250 			return;
   251 		}
   252 		List<IClientListener *>::iterator iter;
   253 		IClientListener *pListener = NULL;
   254 		for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
   255 		{
   256 			pListener = (*iter);
   257 			pListener->OnClientConnected(client);
   258 			/* See if bot was kicked */
   259 			if (!pPlayer->IsConnected())
   260 			{
   261 				return;
   262 			}
   263 		}
   264 		/* Now do authorization */
   265 		for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
   266 		{
   267 			pListener = (*iter);
   268 			pListener->OnClientAuthorized(client, authid);
   269 			/* See if bot was kicked */
   270 			if (!pPlayer->IsConnected())
   271 			{
   272 				return;
   273 			}
   274 		}
   275 		/* Finally, tell plugins */
   276 		if (m_clauth->GetFunctionCount())
   277 		{
   278 			m_clauth->PushCell(client);
   279 			m_clauth->PushString(authid);
   280 			m_clauth->Execute(NULL);
   281 		}
   282 	}
   283 
   284 	if (playerinfo)
   285 	{
   286 		pPlayer->m_Info = playerinfo->GetPlayerInfo(pEntity);
   287 	}
   288 
   289 	List<IClientListener *>::iterator iter;
   290 	IClientListener *pListener = NULL;
   291 	for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
   292 	{
   293 		pListener = (*iter);
   294 		pListener->OnClientPutInServer(client);
   295 		/* See if player was kicked */
   296 		if (!pPlayer->IsConnected())
   297 		{
   298 			return;
   299 		}
   300 	}
   301 
   302 	m_Players[client].Connect();
   303 	m_PlayerCount++;
   304 	m_clputinserver->PushCell(client);
   305 	m_clputinserver->Execute(&res, NULL);
   306 }
   307 
   308 void PlayerManager::OnClientDisconnect(edict_t *pEntity)
   309 {
   310 	cell_t res;
   311 	int client = engine->IndexOfEdict(pEntity);
   312 
   313 	if (m_Players[client].IsConnected())
   314 	{
   315 		m_cldisconnect->PushCell(client);
   316 		m_cldisconnect->Execute(&res, NULL);
   317 	}
   318 
   319 	if (m_Players[client].IsInGame())
   320 	{
   321 		m_PlayerCount--;
   322 	}
   323 
   324 	List<IClientListener *>::iterator iter;
   325 	IClientListener *pListener = NULL;
   326 	for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
   327 	{
   328 		pListener = (*iter);
   329 		pListener->OnClientDisconnecting(client);
   330 	}
   331 
   332 	/**
   333 	 * Remove client from auth queue if necessary
   334 	 */
   335 	if (!m_Players[client].IsAuthorized())
   336 	{
   337 		for (unsigned int i=1; i<=m_AuthQueue[0]; i++)
   338 		{
   339 			if (m_AuthQueue[i] == (unsigned)client)
   340 			{
   341 				/* Move everything ahead of us back by one */
   342 				for (unsigned int j=i+1; j<=m_AuthQueue[0]; j++)
   343 				{
   344 					m_AuthQueue[j-1] = m_AuthQueue[j];
   345 				}
   346 				/* Remove us and break */
   347 				m_AuthQueue[0]--;
   348 				break;
   349 			}
   350 		}
   351 	}
   352 
   353 	m_Players[client].Disconnect();
   354 }
   355 
   356 void PlayerManager::OnClientDisconnect_Post(edict_t *pEntity)
   357 {
   358 	cell_t res;
   359 	int client = engine->IndexOfEdict(pEntity);
   360 
   361 	m_cldisconnect_post->PushCell(client);
   362 	m_cldisconnect_post->Execute(&res, NULL);
   363 
   364 	List<IClientListener *>::iterator iter;
   365 	IClientListener *pListener = NULL;
   366 	for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
   367 	{
   368 		pListener = (*iter);
   369 		pListener->OnClientDisconnected(client);
   370 	}
   371 }
   372 
   373 void PlayerManager::OnClientCommand(edict_t *pEntity)
   374 {
   375 	cell_t res = Pl_Continue;
   376 	int client = engine->IndexOfEdict(pEntity);
   377 
   378 	int args = engine->Cmd_Argc() - 1;
   379 
   380 	m_clcommand->PushCell(client);
   381 	m_clcommand->PushCell(args);
   382 	m_clcommand->Execute(&res, NULL);
   383 
   384 	if (res >= Pl_Stop)
   385 	{
   386 		RETURN_META(MRES_SUPERCEDE);
   387 	}
   388 
   389 	res = g_ConCmds.DispatchClientCommand(client, (ResultType)res);
   390 
   391 	if (res >= Pl_Handled)
   392 	{
   393 		RETURN_META(MRES_SUPERCEDE);
   394 	}
   395 }
   396 
   397 void PlayerManager::OnClientSettingsChanged(edict_t *pEntity)
   398 {
   399 	cell_t res;
   400 	int client = engine->IndexOfEdict(pEntity);
   401 
   402 	m_clinfochanged->PushCell(engine->IndexOfEdict(pEntity));
   403 	m_clinfochanged->Execute(&res, NULL);
   404 	m_Players[client].SetName(engine->GetClientConVarValue(client, "name"));
   405 }
   406 
   407 int PlayerManager::GetMaxClients()
   408 {
   409 	return m_maxClients;
   410 }
   411 
   412 CPlayer *PlayerManager::GetPlayerByIndex(int client) const
   413 {
   414 	if (client > m_maxClients || client < 1)
   415 	{
   416 		return NULL;
   417 	}
   418 	return &m_Players[client];
   419 }
   420 
   421 int PlayerManager::GetNumPlayers()
   422 {
   423 	return m_PlayerCount;
   424 }
   425 
   426 void PlayerManager::AddClientListener(IClientListener *listener)
   427 {
   428 	m_hooks.push_back(listener);
   429 }
   430 
   431 void PlayerManager::RemoveClientListener(IClientListener *listener)
   432 {
   433 	m_hooks.remove(listener);
   434 }
   435 
   436 IGamePlayer *PlayerManager::GetGamePlayer(edict_t *pEdict)
   437 {
   438 	int index = engine->IndexOfEdict(pEdict);
   439 	return GetGamePlayer(index);
   440 }
   441 
   442 IGamePlayer *PlayerManager::GetGamePlayer(int client)
   443 {
   444 	return GetPlayerByIndex(client);
   445 }
   446 
   447 void PlayerManager::ClearAdminId(AdminId id)
   448 {
   449 	for (int i=1; i<=m_maxClients; i++)
   450 	{
   451 		if (m_Players[i].m_Admin == id)
   452 		{
   453 			m_Players[i].DumpAdmin(true);
   454 		}
   455 	}
   456 }
   457 
   458 void PlayerManager::ClearAllAdmins()
   459 {
   460 	for (int i=1; i<=m_maxClients; i++)
   461 	{
   462 		m_Players[i].DumpAdmin(true);
   463 	}
   464 }
   465 
   466 
   467 /*******************
   468  *** PLAYER CODE ***
   469  *******************/
   470 
   471 CPlayer::CPlayer()
   472 {
   473 	m_IsConnected = false;
   474 	m_IsInGame = false;
   475 	m_IsAuthorized = false;
   476 	m_pEdict = NULL;
   477 	m_Admin = INVALID_ADMIN_ID;
   478 	m_TempAdmin = false;
   479 	m_Info = NULL;
   480 }
   481 
   482 void CPlayer::Initialize(const char *name, const char *ip, edict_t *pEntity)
   483 {
   484 	m_IsConnected = true;
   485 	m_Name.assign(name);
   486 	m_Ip.assign(ip);
   487 	m_pEdict = pEntity;
   488 }
   489 
   490 void CPlayer::Connect()
   491 {
   492 	m_IsInGame = true;
   493 }
   494 
   495 void CPlayer::Authorize(const char *steamid)
   496 {
   497 	m_IsAuthorized = true;
   498 	m_AuthID.assign(steamid);
   499 }
   500 
   501 void CPlayer::Disconnect()
   502 {
   503 	DumpAdmin(false);
   504 	m_IsConnected = false;
   505 	m_IsInGame = false;
   506 	m_IsAuthorized = false;
   507 	m_Name.clear();
   508 	m_Ip.clear();
   509 	m_AuthID.clear();
   510 	m_pEdict = NULL;
   511 	m_Info = NULL;
   512 }
   513 
   514 void CPlayer::SetName(const char *name)
   515 {
   516 	m_Name.assign(name);
   517 }
   518 
   519 const char *CPlayer::GetName()
   520 {
   521 	return m_Name.c_str();
   522 }
   523 
   524 const char *CPlayer::GetIPAddress()
   525 {
   526 	return m_Ip.c_str();
   527 }
   528 
   529 const char *CPlayer::GetAuthString()
   530 {
   531 	return m_AuthID.c_str();
   532 }
   533 
   534 edict_t *CPlayer::GetEdict()
   535 {
   536 	return m_pEdict;
   537 }
   538 
   539 bool CPlayer::IsInGame()
   540 {
   541 	return m_IsInGame;
   542 }
   543 
   544 bool CPlayer::IsConnected()
   545 {
   546 	return m_IsConnected;
   547 }
   548 
   549 bool CPlayer::IsAuthorized()
   550 {
   551 	return m_IsAuthorized;
   552 }
   553 
   554 IPlayerInfo *CPlayer::GetPlayerInfo()
   555 {
   556 	return m_Info;
   557 }
   558 
   559 bool CPlayer::IsFakeClient()
   560 {
   561 	return (strcmp(m_AuthID.c_str(), "BOT") == 0);
   562 }
   563 
   564 void CPlayer::SetAdminId(AdminId id, bool temporary)
   565 {
   566 	if (!m_IsConnected)
   567 	{
   568 		return;
   569 	}
   570 
   571 	DumpAdmin(false);
   572 
   573 	m_Admin = id;
   574 	m_TempAdmin = temporary;
   575 }
   576 
   577 AdminId CPlayer::GetAdminId()
   578 {
   579 	return m_Admin;
   580 }
   581 
   582 void CPlayer::DumpAdmin(bool deleting)
   583 {
   584 	if (m_Admin != INVALID_ADMIN_ID)
   585 	{
   586 		if (m_TempAdmin && !deleting)
   587 		{
   588 			g_Admins.InvalidateAdmin(m_Admin);
   589 		}
   590 		m_Admin = INVALID_ADMIN_ID;
   591 		m_TempAdmin = false;
   592 	}
   593 }