3 * ===============================================================
4 * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved.
5 * ===============================================================
7 * This file is not open source and may not be copied without explicit
8 * written permission of AlliedModders LLC. This file may not be redistributed
9 * in whole or significant part.
10 * For information, see LICENSE.txt or http://www.sourcemod.net/license.php
15 #include "PlayerManager.h"
16 #include "ForwardSys.h"
18 #include "AdminCache.h"
19 #include "ConCmdManager.h"
21 PlayerManager g_Players;
23 SH_DECL_HOOK5(IServerGameClients, ClientConnect, SH_NOATTRIB, 0, bool, edict_t *, const char *, const char *, char *, int);
24 SH_DECL_HOOK2_void(IServerGameClients, ClientPutInServer, SH_NOATTRIB, 0, edict_t *, const char *);
25 SH_DECL_HOOK1_void(IServerGameClients, ClientDisconnect, SH_NOATTRIB, 0, edict_t *);
26 SH_DECL_HOOK1_void(IServerGameClients, ClientCommand, SH_NOATTRIB, 0, edict_t *);
27 SH_DECL_HOOK1_void(IServerGameClients, ClientSettingsChanged, SH_NOATTRIB, 0, edict_t *);
28 SH_DECL_HOOK3_void(IServerGameDLL, ServerActivate, SH_NOATTRIB, 0, edict_t *, int, int);
30 PlayerManager::PlayerManager()
35 m_UserIdLookUp = new int[USHRT_MAX];
36 memset(m_UserIdLookUp, 0, sizeof(int) * USHRT_MAX);
39 PlayerManager::~PlayerManager()
41 delete [] m_AuthQueue;
42 delete [] m_UserIdLookUp;
45 void PlayerManager::OnSourceModAllInitialized()
47 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientConnect, serverClients, this, &PlayerManager::OnClientConnect, false);
48 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientConnect, serverClients, this, &PlayerManager::OnClientConnect_Post, true);
49 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientPutInServer, serverClients, this, &PlayerManager::OnClientPutInServer, true);
50 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, serverClients, this, &PlayerManager::OnClientDisconnect, false);
51 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, serverClients, this, &PlayerManager::OnClientDisconnect_Post, true);
52 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientCommand, serverClients, this, &PlayerManager::OnClientCommand, false);
53 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientSettingsChanged, serverClients, this, &PlayerManager::OnClientSettingsChanged, true);
54 SH_ADD_HOOK_MEMFUNC(IServerGameDLL, ServerActivate, gamedll, this, &PlayerManager::OnServerActivate, true);
56 g_ShareSys.AddInterface(NULL, this);
58 ParamType p1[] = {Param_Cell, Param_String, Param_Cell};
59 ParamType p2[] = {Param_Cell};
61 m_clconnect = g_Forwards.CreateForward("OnClientConnect", ET_Event, 3, p1);
62 m_clputinserver = g_Forwards.CreateForward("OnClientPutInServer", ET_Ignore, 1, p2);
63 m_cldisconnect = g_Forwards.CreateForward("OnClientDisconnect", ET_Ignore, 1, p2);
64 m_cldisconnect_post = g_Forwards.CreateForward("OnClientDisconnect_Post", ET_Ignore, 1, p2);
65 m_clcommand = g_Forwards.CreateForward("OnClientCommand", ET_Hook, 2, NULL, Param_Cell, Param_Cell);
66 m_clinfochanged = g_Forwards.CreateForward("OnClientSettingsChanged", ET_Ignore, 1, p2);
67 m_clauth = g_Forwards.CreateForward("OnClientAuthorized", ET_Ignore, 2, NULL, Param_Cell, Param_String);
68 m_onActivate = g_Forwards.CreateForward("OnServerLoad", ET_Ignore, 0, NULL);
69 m_onActivate2 = g_Forwards.CreateForward("OnMapStart", ET_Ignore, 0, NULL);
72 void PlayerManager::OnSourceModShutdown()
74 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientConnect, serverClients, this, &PlayerManager::OnClientConnect, false);
75 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientPutInServer, serverClients, this, &PlayerManager::OnClientPutInServer, true);
76 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, serverClients, this, &PlayerManager::OnClientDisconnect, false);
77 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, serverClients, this, &PlayerManager::OnClientDisconnect_Post, true);
78 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientCommand, serverClients, this, &PlayerManager::OnClientCommand, false);
79 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientSettingsChanged, serverClients, this, &PlayerManager::OnClientSettingsChanged, true);
80 SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, ServerActivate, gamedll, this, &PlayerManager::OnServerActivate, true);
82 /* Release forwards */
83 g_Forwards.ReleaseForward(m_clconnect);
84 g_Forwards.ReleaseForward(m_clputinserver);
85 g_Forwards.ReleaseForward(m_cldisconnect);
86 g_Forwards.ReleaseForward(m_cldisconnect_post);
87 g_Forwards.ReleaseForward(m_clcommand);
88 g_Forwards.ReleaseForward(m_clinfochanged);
89 g_Forwards.ReleaseForward(m_clauth);
90 g_Forwards.ReleaseForward(m_onActivate);
91 g_Forwards.ReleaseForward(m_onActivate2);
96 void PlayerManager::OnServerActivate(edict_t *pEdictList, int edictCount, int clientMax)
100 /* Initialize all players */
101 m_maxClients = clientMax;
103 m_Players = new CPlayer[m_maxClients + 1];
104 m_AuthQueue = new unsigned int[m_maxClients + 1];
107 memset(m_AuthQueue, 0, sizeof(unsigned int) * (m_maxClients + 1));
109 m_onActivate->Execute(NULL);
110 m_onActivate2->Execute(NULL);
112 static int g_userid_test = 1;
113 int client = GetClientOfUserId(++g_userid_test);
116 void PlayerManager::RunAuthChecks()
120 unsigned int removed = 0;
121 for (unsigned int i=1; i<=m_AuthQueue[0]; i++)
123 pPlayer = GetPlayerByIndex(m_AuthQueue[i]);
124 authstr = engine->GetPlayerNetworkIDString(pPlayer->m_pEdict);
125 if (authstr && authstr[0] != '\0'
126 && (strcmp(authstr, "STEAM_ID_PENDING") != 0))
128 /* Set authorization */
129 pPlayer->m_AuthID.assign(authstr);
130 pPlayer->m_IsAuthorized = true;
132 /* Mark as removed from queue */
133 unsigned int client = m_AuthQueue[i];
137 /* Send to extensions */
138 List<IClientListener *>::iterator iter;
139 IClientListener *pListener;
140 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
143 pListener->OnClientAuthorized(client, authstr);
144 if (!pPlayer->IsConnected())
150 /* Send to plugins if player is still connected */
151 if (pPlayer->IsConnected() && m_clauth->GetFunctionCount())
153 /* :TODO: handle the case of a player disconnecting in the middle */
154 m_clauth->PushCell(client);
155 m_clauth->PushString(authstr);
156 m_clauth->Execute(NULL);
161 /* Clean up the queue */
164 /* We don't have to compcat the list if it's empty */
165 if (removed != m_AuthQueue[0])
167 unsigned int diff = 0;
168 for (unsigned int i=1; i<=m_AuthQueue[0]; i++)
170 /* If this member is removed... */
171 if (m_AuthQueue[i] == 0)
173 /* Increase the differential */
176 /* diff cannot increase faster than i+1 */
178 assert(i - diff >= 1);
179 /* move this index down */
180 m_AuthQueue[i - diff] = m_AuthQueue[i];
183 m_AuthQueue[0] -= removed;
186 g_SourceMod.SetAuthChecking(false);
191 bool PlayerManager::OnClientConnect(edict_t *pEntity, const char *pszName, const char *pszAddress, char *reject, int maxrejectlen)
193 int client = engine->IndexOfEdict(pEntity);
195 List<IClientListener *>::iterator iter;
196 IClientListener *pListener = NULL;
197 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
200 if (!pListener->InterceptClientConnect(client, reject, maxrejectlen))
208 m_Players[client].Initialize(pszName, pszAddress, pEntity);
209 m_clconnect->PushCell(client);
210 m_clconnect->PushStringEx(reject, maxrejectlen, SM_PARAM_STRING_UTF8, SM_PARAM_COPYBACK);
211 m_clconnect->PushCell(maxrejectlen);
212 m_clconnect->Execute(&res, NULL);
216 if (!m_Players[client].IsAuthorized())
218 m_AuthQueue[++m_AuthQueue[0]] = client;
219 g_SourceMod.SetAuthChecking(true);
222 RETURN_META_VALUE(MRES_SUPERCEDE, false);
225 m_UserIdLookUp[engine->GetPlayerUserId(pEntity)] = client;
230 bool PlayerManager::OnClientConnect_Post(edict_t *pEntity, const char *pszName, const char *pszAddress, char *reject, int maxrejectlen)
232 int client = engine->IndexOfEdict(pEntity);
233 bool orig_value = META_RESULT_ORIG_RET(bool);
236 List<IClientListener *>::iterator iter;
237 IClientListener *pListener = NULL;
238 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
241 pListener->OnClientConnected(client);
248 void PlayerManager::OnClientPutInServer(edict_t *pEntity, const char *playername)
251 int client = engine->IndexOfEdict(pEntity);
253 CPlayer *pPlayer = GetPlayerByIndex(client);
254 /* If they're not connected, they're a bot */
255 if (!pPlayer->IsConnected())
257 /* Run manual connection routines */
259 const char *authid = engine->GetPlayerNetworkIDString(pEntity);
260 pPlayer->Authorize(authid);
261 if (!OnClientConnect(pEntity, playername, "127.0.0.1", error, sizeof(error)))
263 /* :TODO: kick the bot if it's rejected */
266 List<IClientListener *>::iterator iter;
267 IClientListener *pListener = NULL;
268 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
271 pListener->OnClientConnected(client);
272 /* See if bot was kicked */
273 if (!pPlayer->IsConnected())
278 /* Now do authorization */
279 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
282 pListener->OnClientAuthorized(client, authid);
283 /* See if bot was kicked */
284 if (!pPlayer->IsConnected())
289 /* Finally, tell plugins */
290 if (m_clauth->GetFunctionCount())
292 m_clauth->PushCell(client);
293 m_clauth->PushString(authid);
294 m_clauth->Execute(NULL);
300 pPlayer->m_Info = playerinfo->GetPlayerInfo(pEntity);
303 List<IClientListener *>::iterator iter;
304 IClientListener *pListener = NULL;
305 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
308 pListener->OnClientPutInServer(client);
309 /* See if player was kicked */
310 if (!pPlayer->IsConnected())
316 m_Players[client].Connect();
318 m_clputinserver->PushCell(client);
319 m_clputinserver->Execute(&res, NULL);
322 void PlayerManager::OnClientDisconnect(edict_t *pEntity)
325 int client = engine->IndexOfEdict(pEntity);
327 if (m_Players[client].IsConnected())
329 m_cldisconnect->PushCell(client);
330 m_cldisconnect->Execute(&res, NULL);
333 if (m_Players[client].IsInGame())
338 List<IClientListener *>::iterator iter;
339 IClientListener *pListener = NULL;
340 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
343 pListener->OnClientDisconnecting(client);
347 * Remove client from auth queue if necessary
349 if (!m_Players[client].IsAuthorized())
351 for (unsigned int i=1; i<=m_AuthQueue[0]; i++)
353 if (m_AuthQueue[i] == (unsigned)client)
355 /* Move everything ahead of us back by one */
356 for (unsigned int j=i+1; j<=m_AuthQueue[0]; j++)
358 m_AuthQueue[j-1] = m_AuthQueue[j];
360 /* Remove us and break */
367 m_Players[client].Disconnect();
368 m_UserIdLookUp[engine->GetPlayerUserId(pEntity)] = 0;
371 void PlayerManager::OnClientDisconnect_Post(edict_t *pEntity)
374 int client = engine->IndexOfEdict(pEntity);
376 m_cldisconnect_post->PushCell(client);
377 m_cldisconnect_post->Execute(&res, NULL);
379 List<IClientListener *>::iterator iter;
380 IClientListener *pListener = NULL;
381 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
384 pListener->OnClientDisconnected(client);
388 void PlayerManager::OnClientCommand(edict_t *pEntity)
390 cell_t res = Pl_Continue;
391 int client = engine->IndexOfEdict(pEntity);
393 int args = engine->Cmd_Argc() - 1;
395 m_clcommand->PushCell(client);
396 m_clcommand->PushCell(args);
397 m_clcommand->Execute(&res, NULL);
401 RETURN_META(MRES_SUPERCEDE);
404 res = g_ConCmds.DispatchClientCommand(client, (ResultType)res);
406 if (res >= Pl_Handled)
408 RETURN_META(MRES_SUPERCEDE);
412 void PlayerManager::OnClientSettingsChanged(edict_t *pEntity)
415 int client = engine->IndexOfEdict(pEntity);
417 m_clinfochanged->PushCell(engine->IndexOfEdict(pEntity));
418 m_clinfochanged->Execute(&res, NULL);
419 m_Players[client].SetName(engine->GetClientConVarValue(client, "name"));
422 int PlayerManager::GetMaxClients()
427 CPlayer *PlayerManager::GetPlayerByIndex(int client) const
429 if (client > m_maxClients || client < 1)
433 return &m_Players[client];
436 int PlayerManager::GetNumPlayers()
438 return m_PlayerCount;
441 int PlayerManager::GetClientOfUserId(int userid)
443 if (userid < 0 || userid > USHRT_MAX)
448 int client = m_UserIdLookUp[userid];
450 /* Verify the userid. The cache can get messed up with older
451 * Valve engines. :TODO: If this gets fixed, do an old engine
452 * check before invoking this backwards compat code.
456 CPlayer *player = GetPlayerByIndex(client);
457 if (player && player->IsConnected())
459 int realUserId = engine->GetPlayerUserId(player->GetEdict());
460 if (realUserId == userid)
467 /* If we can't verify the userid, we have to do a manual loop */
469 for (int i = 1; i <= m_maxClients; i++)
471 player = GetPlayerByIndex(i);
472 if (!player || !player->IsConnected())
476 if (engine->GetPlayerUserId(player->GetEdict()) == userid)
485 void PlayerManager::AddClientListener(IClientListener *listener)
487 m_hooks.push_back(listener);
490 void PlayerManager::RemoveClientListener(IClientListener *listener)
492 m_hooks.remove(listener);
495 IGamePlayer *PlayerManager::GetGamePlayer(edict_t *pEdict)
497 int index = engine->IndexOfEdict(pEdict);
498 return GetGamePlayer(index);
501 IGamePlayer *PlayerManager::GetGamePlayer(int client)
503 return GetPlayerByIndex(client);
506 void PlayerManager::ClearAdminId(AdminId id)
508 for (int i=1; i<=m_maxClients; i++)
510 if (m_Players[i].m_Admin == id)
512 m_Players[i].DumpAdmin(true);
517 void PlayerManager::ClearAllAdmins()
519 for (int i=1; i<=m_maxClients; i++)
521 m_Players[i].DumpAdmin(true);
532 m_IsConnected = false;
534 m_IsAuthorized = false;
536 m_Admin = INVALID_ADMIN_ID;
541 void CPlayer::Initialize(const char *name, const char *ip, edict_t *pEntity)
543 m_IsConnected = true;
549 void CPlayer::Connect()
554 void CPlayer::Authorize(const char *steamid)
556 m_IsAuthorized = true;
557 m_AuthID.assign(steamid);
560 void CPlayer::Disconnect()
563 m_IsConnected = false;
565 m_IsAuthorized = false;
573 void CPlayer::SetName(const char *name)
578 const char *CPlayer::GetName()
580 return (m_Info) ? m_Info->GetName(): m_Name.c_str();
583 const char *CPlayer::GetIPAddress()
588 const char *CPlayer::GetAuthString()
590 return m_AuthID.c_str();
593 edict_t *CPlayer::GetEdict()
598 bool CPlayer::IsInGame()
603 bool CPlayer::IsConnected()
605 return m_IsConnected;
608 bool CPlayer::IsAuthorized()
610 return m_IsAuthorized;
613 IPlayerInfo *CPlayer::GetPlayerInfo()
618 bool CPlayer::IsFakeClient()
620 return (strcmp(m_AuthID.c_str(), "BOT") == 0);
623 void CPlayer::SetAdminId(AdminId id, bool temporary)
633 m_TempAdmin = temporary;
636 AdminId CPlayer::GetAdminId()
641 void CPlayer::DumpAdmin(bool deleting)
643 if (m_Admin != INVALID_ADMIN_ID)
645 if (m_TempAdmin && !deleting)
647 g_Admins.InvalidateAdmin(m_Admin);
649 m_Admin = INVALID_ADMIN_ID;