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"
20 #include "MenuStyle_Valve.h"
21 #include "MenuStyle_Radio.h"
22 #include "sm_stringutil.h"
23 #include "CoreConfig.h"
25 PlayerManager g_Players;
26 bool g_OnMapStarted = false;
28 SH_DECL_HOOK5(IServerGameClients, ClientConnect, SH_NOATTRIB, 0, bool, edict_t *, const char *, const char *, char *, int);
29 SH_DECL_HOOK2_void(IServerGameClients, ClientPutInServer, SH_NOATTRIB, 0, edict_t *, const char *);
30 SH_DECL_HOOK1_void(IServerGameClients, ClientDisconnect, SH_NOATTRIB, 0, edict_t *);
31 SH_DECL_HOOK1_void(IServerGameClients, ClientCommand, SH_NOATTRIB, 0, edict_t *);
32 SH_DECL_HOOK1_void(IServerGameClients, ClientSettingsChanged, SH_NOATTRIB, 0, edict_t *);
33 SH_DECL_HOOK3_void(IServerGameDLL, ServerActivate, SH_NOATTRIB, 0, edict_t *, int, int);
35 PlayerManager::PlayerManager()
40 m_UserIdLookUp = new int[USHRT_MAX];
41 memset(m_UserIdLookUp, 0, sizeof(int) * USHRT_MAX);
44 PlayerManager::~PlayerManager()
46 delete [] m_AuthQueue;
47 delete [] m_UserIdLookUp;
50 void PlayerManager::OnSourceModAllInitialized()
52 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientConnect, serverClients, this, &PlayerManager::OnClientConnect, false);
53 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientConnect, serverClients, this, &PlayerManager::OnClientConnect_Post, true);
54 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientPutInServer, serverClients, this, &PlayerManager::OnClientPutInServer, true);
55 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, serverClients, this, &PlayerManager::OnClientDisconnect, false);
56 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, serverClients, this, &PlayerManager::OnClientDisconnect_Post, true);
57 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientCommand, serverClients, this, &PlayerManager::OnClientCommand, false);
58 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientSettingsChanged, serverClients, this, &PlayerManager::OnClientSettingsChanged, true);
59 SH_ADD_HOOK_MEMFUNC(IServerGameDLL, ServerActivate, gamedll, this, &PlayerManager::OnServerActivate, true);
61 g_ShareSys.AddInterface(NULL, this);
63 ParamType p1[] = {Param_Cell, Param_String, Param_Cell};
64 ParamType p2[] = {Param_Cell};
66 m_clconnect = g_Forwards.CreateForward("OnClientConnect", ET_Event, 3, p1);
67 m_clputinserver = g_Forwards.CreateForward("OnClientPutInServer", ET_Ignore, 1, p2);
68 m_cldisconnect = g_Forwards.CreateForward("OnClientDisconnect", ET_Ignore, 1, p2);
69 m_cldisconnect_post = g_Forwards.CreateForward("OnClientDisconnect_Post", ET_Ignore, 1, p2);
70 m_clcommand = g_Forwards.CreateForward("OnClientCommand", ET_Hook, 2, NULL, Param_Cell, Param_Cell);
71 m_clinfochanged = g_Forwards.CreateForward("OnClientSettingsChanged", ET_Ignore, 1, p2);
72 m_clauth = g_Forwards.CreateForward("OnClientAuthorized", ET_Ignore, 2, NULL, Param_Cell, Param_String);
73 m_onActivate = g_Forwards.CreateForward("OnServerLoad", ET_Ignore, 0, NULL);
74 m_onActivate2 = g_Forwards.CreateForward("OnMapStart", ET_Ignore, 0, NULL);
77 void PlayerManager::OnSourceModShutdown()
79 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientConnect, serverClients, this, &PlayerManager::OnClientConnect, false);
80 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientPutInServer, serverClients, this, &PlayerManager::OnClientPutInServer, true);
81 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, serverClients, this, &PlayerManager::OnClientDisconnect, false);
82 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, serverClients, this, &PlayerManager::OnClientDisconnect_Post, true);
83 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientCommand, serverClients, this, &PlayerManager::OnClientCommand, false);
84 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientSettingsChanged, serverClients, this, &PlayerManager::OnClientSettingsChanged, true);
85 SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, ServerActivate, gamedll, this, &PlayerManager::OnServerActivate, true);
87 /* Release forwards */
88 g_Forwards.ReleaseForward(m_clconnect);
89 g_Forwards.ReleaseForward(m_clputinserver);
90 g_Forwards.ReleaseForward(m_cldisconnect);
91 g_Forwards.ReleaseForward(m_cldisconnect_post);
92 g_Forwards.ReleaseForward(m_clcommand);
93 g_Forwards.ReleaseForward(m_clinfochanged);
94 g_Forwards.ReleaseForward(m_clauth);
95 g_Forwards.ReleaseForward(m_onActivate);
96 g_Forwards.ReleaseForward(m_onActivate2);
101 void PlayerManager::OnServerActivate(edict_t *pEdictList, int edictCount, int clientMax)
105 /* Initialize all players */
106 m_maxClients = clientMax;
108 m_Players = new CPlayer[m_maxClients + 1];
109 m_AuthQueue = new unsigned int[m_maxClients + 1];
112 memset(m_AuthQueue, 0, sizeof(unsigned int) * (m_maxClients + 1));
114 m_onActivate->Execute(NULL);
115 m_onActivate2->Execute(NULL);
117 g_OnMapStarted = true;
119 SM_ExecuteAllConfigs();
122 bool CheckSetAdmin(int index, CPlayer *pPlayer, AdminId id)
124 const char *password = g_Admins.GetAdminPassword(id);
125 if (password != NULL)
127 /* Whoa... the user needs a password! */
128 const char *given = engine->GetClientConVarValue(index, "_password");
129 if (!given || strcmp(given, password) != 0)
135 pPlayer->SetAdminId(id, false);
140 void PlayerManager::RunAuthChecks()
144 unsigned int removed = 0;
145 for (unsigned int i=1; i<=m_AuthQueue[0]; i++)
147 pPlayer = GetPlayerByIndex(m_AuthQueue[i]);
148 authstr = engine->GetPlayerNetworkIDString(pPlayer->m_pEdict);
149 if (authstr && authstr[0] != '\0'
150 && (strcmp(authstr, "STEAM_ID_PENDING") != 0))
152 /* Set authorization */
153 pPlayer->m_AuthID.assign(authstr);
154 pPlayer->m_IsAuthorized = true;
156 /* Mark as removed from queue */
157 unsigned int client = m_AuthQueue[i];
161 /* Do admin lookups */
162 if (pPlayer->GetAdminId() == INVALID_ADMIN_ID)
164 AdminId id = g_Admins.FindAdminByIdentity("steam", authstr);
165 if (id != INVALID_ADMIN_ID)
167 CheckSetAdmin(client, pPlayer, id);
171 /* Send to extensions */
172 List<IClientListener *>::iterator iter;
173 IClientListener *pListener;
174 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
177 pListener->OnClientAuthorized(client, authstr);
178 if (!pPlayer->IsConnected())
184 /* Send to plugins if player is still connected */
185 if (pPlayer->IsConnected() && m_clauth->GetFunctionCount())
187 /* :TODO: handle the case of a player disconnecting in the middle */
188 m_clauth->PushCell(client);
189 m_clauth->PushString(authstr);
190 m_clauth->Execute(NULL);
195 /* Clean up the queue */
198 /* We don't have to compact the list if it's empty */
199 if (removed != m_AuthQueue[0])
201 unsigned int diff = 0;
202 for (unsigned int i=1; i<=m_AuthQueue[0]; i++)
204 /* If this member is removed... */
205 if (m_AuthQueue[i] == 0)
207 /* Increase the differential */
210 /* diff cannot increase faster than i+1 */
212 assert(i - diff >= 1);
213 /* move this index down */
214 m_AuthQueue[i - diff] = m_AuthQueue[i];
217 m_AuthQueue[0] -= removed;
220 g_SourceMod.SetAuthChecking(false);
225 bool PlayerManager::OnClientConnect(edict_t *pEntity, const char *pszName, const char *pszAddress, char *reject, int maxrejectlen)
227 int client = engine->IndexOfEdict(pEntity);
229 List<IClientListener *>::iterator iter;
230 IClientListener *pListener = NULL;
231 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
234 if (!pListener->InterceptClientConnect(client, reject, maxrejectlen))
242 m_Players[client].Initialize(pszName, pszAddress, pEntity);
243 m_clconnect->PushCell(client);
244 m_clconnect->PushStringEx(reject, maxrejectlen, SM_PARAM_STRING_UTF8, SM_PARAM_COPYBACK);
245 m_clconnect->PushCell(maxrejectlen);
246 m_clconnect->Execute(&res, NULL);
250 if (!m_Players[client].IsAuthorized())
252 m_AuthQueue[++m_AuthQueue[0]] = client;
253 g_SourceMod.SetAuthChecking(true);
256 RETURN_META_VALUE(MRES_SUPERCEDE, false);
259 m_UserIdLookUp[engine->GetPlayerUserId(pEntity)] = client;
264 bool PlayerManager::OnClientConnect_Post(edict_t *pEntity, const char *pszName, const char *pszAddress, char *reject, int maxrejectlen)
266 int client = engine->IndexOfEdict(pEntity);
267 bool orig_value = META_RESULT_ORIG_RET(bool);
268 CPlayer *pPlayer = GetPlayerByIndex(client);
271 List<IClientListener *>::iterator iter;
272 IClientListener *pListener = NULL;
273 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
276 pListener->OnClientConnected(client);
277 if (!pPlayer->IsConnected())
284 if (pPlayer->IsConnected())
286 /* Do an ip based lookup */
288 strncopy(ip, pszAddress, sizeof(ip));
289 if ((ptr = strchr(ip, ':')) != NULL)
294 AdminId id = g_Admins.FindAdminByIdentity("ip", ip);
295 if (id != INVALID_ADMIN_ID)
297 CheckSetAdmin(client, pPlayer, id);
304 void PlayerManager::OnClientPutInServer(edict_t *pEntity, const char *playername)
307 int client = engine->IndexOfEdict(pEntity);
309 CPlayer *pPlayer = GetPlayerByIndex(client);
310 /* If they're not connected, they're a bot */
311 if (!pPlayer->IsConnected())
313 /* Run manual connection routines */
315 const char *authid = engine->GetPlayerNetworkIDString(pEntity);
316 pPlayer->Authorize(authid);
317 if (!OnClientConnect(pEntity, playername, "127.0.0.1", error, sizeof(error)))
319 /* :TODO: kick the bot if it's rejected */
322 List<IClientListener *>::iterator iter;
323 IClientListener *pListener = NULL;
324 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
327 pListener->OnClientConnected(client);
328 /* See if bot was kicked */
329 if (!pPlayer->IsConnected())
334 /* Now do authorization */
335 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
338 pListener->OnClientAuthorized(client, authid);
339 /* See if bot was kicked */
340 if (!pPlayer->IsConnected())
345 /* Finally, tell plugins */
346 if (m_clauth->GetFunctionCount())
348 m_clauth->PushCell(client);
349 m_clauth->PushString(authid);
350 m_clauth->Execute(NULL);
356 pPlayer->m_Info = playerinfo->GetPlayerInfo(pEntity);
359 List<IClientListener *>::iterator iter;
360 IClientListener *pListener = NULL;
361 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
364 pListener->OnClientPutInServer(client);
365 /* See if player was kicked */
366 if (!pPlayer->IsConnected())
372 m_Players[client].Connect();
374 m_clputinserver->PushCell(client);
375 m_clputinserver->Execute(&res, NULL);
378 void PlayerManager::OnSourceModLevelEnd()
380 /* Disconnect all bots still in game */
381 for (int i=1; i<=m_maxClients; i++)
383 if (m_Players[i].IsConnected() && m_Players[i].IsFakeClient())
385 OnClientDisconnect(m_Players[i].GetEdict());
390 void PlayerManager::OnClientDisconnect(edict_t *pEntity)
393 int client = engine->IndexOfEdict(pEntity);
395 if (m_Players[client].IsConnected())
397 m_cldisconnect->PushCell(client);
398 m_cldisconnect->Execute(&res, NULL);
401 if (m_Players[client].IsInGame())
406 List<IClientListener *>::iterator iter;
407 IClientListener *pListener = NULL;
408 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
411 pListener->OnClientDisconnecting(client);
415 * Remove client from auth queue if necessary
417 if (!m_Players[client].IsAuthorized())
419 for (unsigned int i=1; i<=m_AuthQueue[0]; i++)
421 if (m_AuthQueue[i] == (unsigned)client)
423 /* Move everything ahead of us back by one */
424 for (unsigned int j=i+1; j<=m_AuthQueue[0]; j++)
426 m_AuthQueue[j-1] = m_AuthQueue[j];
428 /* Remove us and break */
435 m_Players[client].Disconnect();
436 m_UserIdLookUp[engine->GetPlayerUserId(pEntity)] = 0;
439 void PlayerManager::OnClientDisconnect_Post(edict_t *pEntity)
442 int client = engine->IndexOfEdict(pEntity);
444 m_cldisconnect_post->PushCell(client);
445 m_cldisconnect_post->Execute(&res, NULL);
447 List<IClientListener *>::iterator iter;
448 IClientListener *pListener = NULL;
449 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
452 pListener->OnClientDisconnected(client);
456 void PlayerManager::OnClientCommand(edict_t *pEntity)
458 int client = engine->IndexOfEdict(pEntity);
459 cell_t res = Pl_Continue;
461 bool result = g_ValveMenuStyle.OnClientCommand(client);
466 result = g_RadioMenuStyle.OnClientCommand(client);
473 int args = engine->Cmd_Argc() - 1;
475 cell_t res2 = Pl_Continue;
476 m_clcommand->PushCell(client);
477 m_clcommand->PushCell(args);
478 m_clcommand->Execute(&res2, NULL);
487 RETURN_META(MRES_SUPERCEDE);
490 res = g_ConCmds.DispatchClientCommand(client, (ResultType)res);
492 if (res >= Pl_Handled)
494 RETURN_META(MRES_SUPERCEDE);
498 void PlayerManager::OnClientSettingsChanged(edict_t *pEntity)
501 int client = engine->IndexOfEdict(pEntity);
503 m_clinfochanged->PushCell(engine->IndexOfEdict(pEntity));
504 m_clinfochanged->Execute(&res, NULL);
505 m_Players[client].SetName(engine->GetClientConVarValue(client, "name"));
508 int PlayerManager::GetMaxClients()
513 CPlayer *PlayerManager::GetPlayerByIndex(int client) const
515 if (client > m_maxClients || client < 1)
519 return &m_Players[client];
522 int PlayerManager::GetNumPlayers()
524 return m_PlayerCount;
527 int PlayerManager::GetClientOfUserId(int userid)
529 if (userid < 0 || userid > USHRT_MAX)
534 int client = m_UserIdLookUp[userid];
536 /* Verify the userid. The cache can get messed up with older
537 * Valve engines. :TODO: If this gets fixed, do an old engine
538 * check before invoking this backwards compat code.
542 CPlayer *player = GetPlayerByIndex(client);
543 if (player && player->IsConnected())
545 int realUserId = engine->GetPlayerUserId(player->GetEdict());
546 if (realUserId == userid)
553 /* If we can't verify the userid, we have to do a manual loop */
555 for (int i = 1; i <= m_maxClients; i++)
557 player = GetPlayerByIndex(i);
558 if (!player || !player->IsConnected())
562 if (engine->GetPlayerUserId(player->GetEdict()) == userid)
564 m_UserIdLookUp[userid] = i;
572 void PlayerManager::AddClientListener(IClientListener *listener)
574 m_hooks.push_back(listener);
577 void PlayerManager::RemoveClientListener(IClientListener *listener)
579 m_hooks.remove(listener);
582 IGamePlayer *PlayerManager::GetGamePlayer(edict_t *pEdict)
584 int index = engine->IndexOfEdict(pEdict);
585 return GetGamePlayer(index);
588 IGamePlayer *PlayerManager::GetGamePlayer(int client)
590 return GetPlayerByIndex(client);
593 void PlayerManager::ClearAdminId(AdminId id)
595 for (int i=1; i<=m_maxClients; i++)
597 if (m_Players[i].m_Admin == id)
599 m_Players[i].DumpAdmin(true);
604 void PlayerManager::ClearAllAdmins()
606 for (int i=1; i<=m_maxClients; i++)
608 m_Players[i].DumpAdmin(true);
619 m_IsConnected = false;
621 m_IsAuthorized = false;
623 m_Admin = INVALID_ADMIN_ID;
628 void CPlayer::Initialize(const char *name, const char *ip, edict_t *pEntity)
630 m_IsConnected = true;
636 void CPlayer::Connect()
641 void CPlayer::Authorize(const char *steamid)
643 m_IsAuthorized = true;
644 m_AuthID.assign(steamid);
647 void CPlayer::Disconnect()
650 m_IsConnected = false;
652 m_IsAuthorized = false;
660 void CPlayer::SetName(const char *name)
665 const char *CPlayer::GetName()
667 return (m_Info) ? m_Info->GetName(): m_Name.c_str();
670 const char *CPlayer::GetIPAddress()
675 const char *CPlayer::GetAuthString()
677 return m_AuthID.c_str();
680 edict_t *CPlayer::GetEdict()
685 bool CPlayer::IsInGame()
690 bool CPlayer::IsConnected()
692 return m_IsConnected;
695 bool CPlayer::IsAuthorized()
697 return m_IsAuthorized;
700 IPlayerInfo *CPlayer::GetPlayerInfo()
705 bool CPlayer::IsFakeClient()
707 return (strcmp(m_AuthID.c_str(), "BOT") == 0);
710 void CPlayer::SetAdminId(AdminId id, bool temporary)
720 m_TempAdmin = temporary;
723 AdminId CPlayer::GetAdminId()
728 void CPlayer::DumpAdmin(bool deleting)
730 if (m_Admin != INVALID_ADMIN_ID)
732 if (m_TempAdmin && !deleting)
734 g_Admins.InvalidateAdmin(m_Admin);
736 m_Admin = INVALID_ADMIN_ID;