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 ConfigResult PlayerManager::OnSourceModConfigChanged(const char *key,
107 if (strcmp(key, "PassInfoVar") == 0)
109 if (strcmp(value, "_password") != 0)
111 m_PassInfoVar.assign(value);
113 return ConfigResult_Accept;
115 return ConfigResult_Ignore;
118 void PlayerManager::OnServerActivate(edict_t *pEdictList, int edictCount, int clientMax)
122 /* Initialize all players */
123 m_maxClients = clientMax;
125 m_Players = new CPlayer[m_maxClients + 1];
126 m_AuthQueue = new unsigned int[m_maxClients + 1];
129 memset(m_AuthQueue, 0, sizeof(unsigned int) * (m_maxClients + 1));
131 m_onActivate->Execute(NULL);
132 m_onActivate2->Execute(NULL);
134 g_OnMapStarted = true;
136 SM_ExecuteAllConfigs();
139 bool PlayerManager::CheckSetAdmin(int index, CPlayer *pPlayer, AdminId id)
141 const char *password = g_Admins.GetAdminPassword(id);
142 if (password != NULL)
144 if (m_PassInfoVar.size() < 1)
149 /* Whoa... the user needs a password! */
150 const char *given = engine->GetClientConVarValue(index, m_PassInfoVar.c_str());
151 if (!given || strcmp(given, password) != 0)
157 pPlayer->SetAdminId(id, false);
162 void PlayerManager::RunAuthChecks()
166 unsigned int removed = 0;
167 for (unsigned int i=1; i<=m_AuthQueue[0]; i++)
169 pPlayer = GetPlayerByIndex(m_AuthQueue[i]);
170 authstr = engine->GetPlayerNetworkIDString(pPlayer->m_pEdict);
171 if (authstr && authstr[0] != '\0'
172 && (strcmp(authstr, "STEAM_ID_PENDING") != 0))
174 /* Set authorization */
175 pPlayer->m_AuthID.assign(authstr);
176 pPlayer->m_IsAuthorized = true;
178 /* Mark as removed from queue */
179 unsigned int client = m_AuthQueue[i];
183 /* Do admin lookups */
184 if (pPlayer->GetAdminId() == INVALID_ADMIN_ID)
186 AdminId id = g_Admins.FindAdminByIdentity("steam", authstr);
187 if (id != INVALID_ADMIN_ID)
189 CheckSetAdmin(client, pPlayer, id);
193 /* Send to extensions */
194 List<IClientListener *>::iterator iter;
195 IClientListener *pListener;
196 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
199 pListener->OnClientAuthorized(client, authstr);
200 if (!pPlayer->IsConnected())
206 /* Send to plugins if player is still connected */
207 if (pPlayer->IsConnected() && m_clauth->GetFunctionCount())
209 /* :TODO: handle the case of a player disconnecting in the middle */
210 m_clauth->PushCell(client);
211 m_clauth->PushString(authstr);
212 m_clauth->Execute(NULL);
217 /* Clean up the queue */
220 /* We don't have to compact the list if it's empty */
221 if (removed != m_AuthQueue[0])
223 unsigned int diff = 0;
224 for (unsigned int i=1; i<=m_AuthQueue[0]; i++)
226 /* If this member is removed... */
227 if (m_AuthQueue[i] == 0)
229 /* Increase the differential */
232 /* diff cannot increase faster than i+1 */
234 assert(i - diff >= 1);
235 /* move this index down */
236 m_AuthQueue[i - diff] = m_AuthQueue[i];
239 m_AuthQueue[0] -= removed;
242 g_SourceMod.SetAuthChecking(false);
247 bool PlayerManager::OnClientConnect(edict_t *pEntity, const char *pszName, const char *pszAddress, char *reject, int maxrejectlen)
249 int client = engine->IndexOfEdict(pEntity);
251 List<IClientListener *>::iterator iter;
252 IClientListener *pListener = NULL;
253 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
256 if (!pListener->InterceptClientConnect(client, reject, maxrejectlen))
264 m_Players[client].Initialize(pszName, pszAddress, pEntity);
265 m_clconnect->PushCell(client);
266 m_clconnect->PushStringEx(reject, maxrejectlen, SM_PARAM_STRING_UTF8, SM_PARAM_COPYBACK);
267 m_clconnect->PushCell(maxrejectlen);
268 m_clconnect->Execute(&res, NULL);
272 if (!m_Players[client].IsAuthorized())
274 m_AuthQueue[++m_AuthQueue[0]] = client;
275 g_SourceMod.SetAuthChecking(true);
278 RETURN_META_VALUE(MRES_SUPERCEDE, false);
281 m_UserIdLookUp[engine->GetPlayerUserId(pEntity)] = client;
286 bool PlayerManager::OnClientConnect_Post(edict_t *pEntity, const char *pszName, const char *pszAddress, char *reject, int maxrejectlen)
288 int client = engine->IndexOfEdict(pEntity);
289 bool orig_value = META_RESULT_ORIG_RET(bool);
290 CPlayer *pPlayer = GetPlayerByIndex(client);
293 List<IClientListener *>::iterator iter;
294 IClientListener *pListener = NULL;
295 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
298 pListener->OnClientConnected(client);
299 if (!pPlayer->IsConnected())
306 if (pPlayer->IsConnected())
308 /* Do an ip based lookup */
310 strncopy(ip, pszAddress, sizeof(ip));
311 if ((ptr = strchr(ip, ':')) != NULL)
316 AdminId id = g_Admins.FindAdminByIdentity("ip", ip);
317 if (id != INVALID_ADMIN_ID)
319 CheckSetAdmin(client, pPlayer, id);
326 void PlayerManager::OnClientPutInServer(edict_t *pEntity, const char *playername)
329 int client = engine->IndexOfEdict(pEntity);
331 CPlayer *pPlayer = GetPlayerByIndex(client);
332 /* If they're not connected, they're a bot */
333 if (!pPlayer->IsConnected())
335 /* Run manual connection routines */
337 const char *authid = engine->GetPlayerNetworkIDString(pEntity);
338 pPlayer->Authorize(authid);
339 if (!OnClientConnect(pEntity, playername, "127.0.0.1", error, sizeof(error)))
341 /* :TODO: kick the bot if it's rejected */
344 List<IClientListener *>::iterator iter;
345 IClientListener *pListener = NULL;
346 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
349 pListener->OnClientConnected(client);
350 /* See if bot was kicked */
351 if (!pPlayer->IsConnected())
356 /* Now do authorization */
357 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
360 pListener->OnClientAuthorized(client, authid);
361 /* See if bot was kicked */
362 if (!pPlayer->IsConnected())
367 /* Finally, tell plugins */
368 if (m_clauth->GetFunctionCount())
370 m_clauth->PushCell(client);
371 m_clauth->PushString(authid);
372 m_clauth->Execute(NULL);
378 pPlayer->m_Info = playerinfo->GetPlayerInfo(pEntity);
381 List<IClientListener *>::iterator iter;
382 IClientListener *pListener = NULL;
383 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
386 pListener->OnClientPutInServer(client);
387 /* See if player was kicked */
388 if (!pPlayer->IsConnected())
394 m_Players[client].Connect();
396 m_clputinserver->PushCell(client);
397 m_clputinserver->Execute(&res, NULL);
400 void PlayerManager::OnSourceModLevelEnd()
402 /* Disconnect all bots still in game */
403 for (int i=1; i<=m_maxClients; i++)
405 if (m_Players[i].IsConnected() && m_Players[i].IsFakeClient())
407 OnClientDisconnect(m_Players[i].GetEdict());
412 void PlayerManager::OnClientDisconnect(edict_t *pEntity)
415 int client = engine->IndexOfEdict(pEntity);
417 if (m_Players[client].IsConnected())
419 m_cldisconnect->PushCell(client);
420 m_cldisconnect->Execute(&res, NULL);
423 if (m_Players[client].IsInGame())
428 List<IClientListener *>::iterator iter;
429 IClientListener *pListener = NULL;
430 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
433 pListener->OnClientDisconnecting(client);
437 * Remove client from auth queue if necessary
439 if (!m_Players[client].IsAuthorized())
441 for (unsigned int i=1; i<=m_AuthQueue[0]; i++)
443 if (m_AuthQueue[i] == (unsigned)client)
445 /* Move everything ahead of us back by one */
446 for (unsigned int j=i+1; j<=m_AuthQueue[0]; j++)
448 m_AuthQueue[j-1] = m_AuthQueue[j];
450 /* Remove us and break */
457 m_Players[client].Disconnect();
458 m_UserIdLookUp[engine->GetPlayerUserId(pEntity)] = 0;
461 void PlayerManager::OnClientDisconnect_Post(edict_t *pEntity)
464 int client = engine->IndexOfEdict(pEntity);
466 m_cldisconnect_post->PushCell(client);
467 m_cldisconnect_post->Execute(&res, NULL);
469 List<IClientListener *>::iterator iter;
470 IClientListener *pListener = NULL;
471 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
474 pListener->OnClientDisconnected(client);
478 void PlayerManager::OnClientCommand(edict_t *pEntity)
480 int client = engine->IndexOfEdict(pEntity);
481 cell_t res = Pl_Continue;
483 bool result = g_ValveMenuStyle.OnClientCommand(client);
488 result = g_RadioMenuStyle.OnClientCommand(client);
495 int args = engine->Cmd_Argc() - 1;
497 cell_t res2 = Pl_Continue;
498 m_clcommand->PushCell(client);
499 m_clcommand->PushCell(args);
500 m_clcommand->Execute(&res2, NULL);
509 RETURN_META(MRES_SUPERCEDE);
512 res = g_ConCmds.DispatchClientCommand(client, (ResultType)res);
514 if (res >= Pl_Handled)
516 RETURN_META(MRES_SUPERCEDE);
520 void PlayerManager::OnClientSettingsChanged(edict_t *pEntity)
523 int client = engine->IndexOfEdict(pEntity);
525 m_clinfochanged->PushCell(engine->IndexOfEdict(pEntity));
526 m_clinfochanged->Execute(&res, NULL);
527 m_Players[client].SetName(engine->GetClientConVarValue(client, "name"));
530 int PlayerManager::GetMaxClients()
535 CPlayer *PlayerManager::GetPlayerByIndex(int client) const
537 if (client > m_maxClients || client < 1)
541 return &m_Players[client];
544 int PlayerManager::GetNumPlayers()
546 return m_PlayerCount;
549 int PlayerManager::GetClientOfUserId(int userid)
551 if (userid < 0 || userid > USHRT_MAX)
556 int client = m_UserIdLookUp[userid];
558 /* Verify the userid. The cache can get messed up with older
559 * Valve engines. :TODO: If this gets fixed, do an old engine
560 * check before invoking this backwards compat code.
564 CPlayer *player = GetPlayerByIndex(client);
565 if (player && player->IsConnected())
567 int realUserId = engine->GetPlayerUserId(player->GetEdict());
568 if (realUserId == userid)
575 /* If we can't verify the userid, we have to do a manual loop */
577 for (int i = 1; i <= m_maxClients; i++)
579 player = GetPlayerByIndex(i);
580 if (!player || !player->IsConnected())
584 if (engine->GetPlayerUserId(player->GetEdict()) == userid)
586 m_UserIdLookUp[userid] = i;
594 void PlayerManager::AddClientListener(IClientListener *listener)
596 m_hooks.push_back(listener);
599 void PlayerManager::RemoveClientListener(IClientListener *listener)
601 m_hooks.remove(listener);
604 IGamePlayer *PlayerManager::GetGamePlayer(edict_t *pEdict)
606 int index = engine->IndexOfEdict(pEdict);
607 return GetGamePlayer(index);
610 IGamePlayer *PlayerManager::GetGamePlayer(int client)
612 return GetPlayerByIndex(client);
615 void PlayerManager::ClearAdminId(AdminId id)
617 for (int i=1; i<=m_maxClients; i++)
619 if (m_Players[i].m_Admin == id)
621 m_Players[i].DumpAdmin(true);
626 void PlayerManager::ClearAllAdmins()
628 for (int i=1; i<=m_maxClients; i++)
630 m_Players[i].DumpAdmin(true);
641 m_IsConnected = false;
643 m_IsAuthorized = false;
645 m_Admin = INVALID_ADMIN_ID;
650 void CPlayer::Initialize(const char *name, const char *ip, edict_t *pEntity)
652 m_IsConnected = true;
658 void CPlayer::Connect()
663 void CPlayer::Authorize(const char *steamid)
665 m_IsAuthorized = true;
666 m_AuthID.assign(steamid);
669 void CPlayer::Disconnect()
672 m_IsConnected = false;
674 m_IsAuthorized = false;
682 void CPlayer::SetName(const char *name)
687 const char *CPlayer::GetName()
689 return (m_Info) ? m_Info->GetName(): m_Name.c_str();
692 const char *CPlayer::GetIPAddress()
697 const char *CPlayer::GetAuthString()
699 return m_AuthID.c_str();
702 edict_t *CPlayer::GetEdict()
707 bool CPlayer::IsInGame()
712 bool CPlayer::IsConnected()
714 return m_IsConnected;
717 bool CPlayer::IsAuthorized()
719 return m_IsAuthorized;
722 IPlayerInfo *CPlayer::GetPlayerInfo()
727 bool CPlayer::IsFakeClient()
729 return (strcmp(m_AuthID.c_str(), "BOT") == 0);
732 void CPlayer::SetAdminId(AdminId id, bool temporary)
742 m_TempAdmin = temporary;
745 AdminId CPlayer::GetAdminId()
750 void CPlayer::DumpAdmin(bool deleting)
752 if (m_Admin != INVALID_ADMIN_ID)
754 if (m_TempAdmin && !deleting)
756 g_Admins.InvalidateAdmin(m_Admin);
758 m_Admin = INVALID_ADMIN_ID;