SourceMod now does authentication in core; admin-auth gets removed. this has an added bonus that OnClientAuthorized reliably has whether an admin is validated
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"
24 PlayerManager g_Players;
25 bool g_OnMapStarted = false;
27 SH_DECL_HOOK5(IServerGameClients, ClientConnect, SH_NOATTRIB, 0, bool, edict_t *, const char *, const char *, char *, int);
28 SH_DECL_HOOK2_void(IServerGameClients, ClientPutInServer, SH_NOATTRIB, 0, edict_t *, const char *);
29 SH_DECL_HOOK1_void(IServerGameClients, ClientDisconnect, SH_NOATTRIB, 0, edict_t *);
30 SH_DECL_HOOK1_void(IServerGameClients, ClientCommand, SH_NOATTRIB, 0, edict_t *);
31 SH_DECL_HOOK1_void(IServerGameClients, ClientSettingsChanged, SH_NOATTRIB, 0, edict_t *);
32 SH_DECL_HOOK3_void(IServerGameDLL, ServerActivate, SH_NOATTRIB, 0, edict_t *, int, int);
34 PlayerManager::PlayerManager()
39 m_UserIdLookUp = new int[USHRT_MAX];
40 memset(m_UserIdLookUp, 0, sizeof(int) * USHRT_MAX);
43 PlayerManager::~PlayerManager()
45 delete [] m_AuthQueue;
46 delete [] m_UserIdLookUp;
49 void PlayerManager::OnSourceModAllInitialized()
51 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientConnect, serverClients, this, &PlayerManager::OnClientConnect, false);
52 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientConnect, serverClients, this, &PlayerManager::OnClientConnect_Post, true);
53 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientPutInServer, serverClients, this, &PlayerManager::OnClientPutInServer, true);
54 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, serverClients, this, &PlayerManager::OnClientDisconnect, false);
55 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, serverClients, this, &PlayerManager::OnClientDisconnect_Post, true);
56 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientCommand, serverClients, this, &PlayerManager::OnClientCommand, false);
57 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientSettingsChanged, serverClients, this, &PlayerManager::OnClientSettingsChanged, true);
58 SH_ADD_HOOK_MEMFUNC(IServerGameDLL, ServerActivate, gamedll, this, &PlayerManager::OnServerActivate, true);
60 g_ShareSys.AddInterface(NULL, this);
62 ParamType p1[] = {Param_Cell, Param_String, Param_Cell};
63 ParamType p2[] = {Param_Cell};
65 m_clconnect = g_Forwards.CreateForward("OnClientConnect", ET_Event, 3, p1);
66 m_clputinserver = g_Forwards.CreateForward("OnClientPutInServer", ET_Ignore, 1, p2);
67 m_cldisconnect = g_Forwards.CreateForward("OnClientDisconnect", ET_Ignore, 1, p2);
68 m_cldisconnect_post = g_Forwards.CreateForward("OnClientDisconnect_Post", ET_Ignore, 1, p2);
69 m_clcommand = g_Forwards.CreateForward("OnClientCommand", ET_Hook, 2, NULL, Param_Cell, Param_Cell);
70 m_clinfochanged = g_Forwards.CreateForward("OnClientSettingsChanged", ET_Ignore, 1, p2);
71 m_clauth = g_Forwards.CreateForward("OnClientAuthorized", ET_Ignore, 2, NULL, Param_Cell, Param_String);
72 m_onActivate = g_Forwards.CreateForward("OnServerLoad", ET_Ignore, 0, NULL);
73 m_onActivate2 = g_Forwards.CreateForward("OnMapStart", ET_Ignore, 0, NULL);
76 void PlayerManager::OnSourceModShutdown()
78 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientConnect, serverClients, this, &PlayerManager::OnClientConnect, false);
79 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientPutInServer, serverClients, this, &PlayerManager::OnClientPutInServer, true);
80 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, serverClients, this, &PlayerManager::OnClientDisconnect, false);
81 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, serverClients, this, &PlayerManager::OnClientDisconnect_Post, true);
82 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientCommand, serverClients, this, &PlayerManager::OnClientCommand, false);
83 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientSettingsChanged, serverClients, this, &PlayerManager::OnClientSettingsChanged, true);
84 SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, ServerActivate, gamedll, this, &PlayerManager::OnServerActivate, true);
86 /* Release forwards */
87 g_Forwards.ReleaseForward(m_clconnect);
88 g_Forwards.ReleaseForward(m_clputinserver);
89 g_Forwards.ReleaseForward(m_cldisconnect);
90 g_Forwards.ReleaseForward(m_cldisconnect_post);
91 g_Forwards.ReleaseForward(m_clcommand);
92 g_Forwards.ReleaseForward(m_clinfochanged);
93 g_Forwards.ReleaseForward(m_clauth);
94 g_Forwards.ReleaseForward(m_onActivate);
95 g_Forwards.ReleaseForward(m_onActivate2);
100 void PlayerManager::OnServerActivate(edict_t *pEdictList, int edictCount, int clientMax)
104 /* Initialize all players */
105 m_maxClients = clientMax;
107 m_Players = new CPlayer[m_maxClients + 1];
108 m_AuthQueue = new unsigned int[m_maxClients + 1];
111 memset(m_AuthQueue, 0, sizeof(unsigned int) * (m_maxClients + 1));
113 m_onActivate->Execute(NULL);
114 m_onActivate2->Execute(NULL);
116 g_OnMapStarted = true;
119 bool CheckSetAdmin(int index, CPlayer *pPlayer, AdminId id)
121 const char *password = g_Admins.GetAdminPassword(id);
122 if (password != NULL)
124 /* Whoa... the user needs a password! */
125 const char *given = engine->GetClientConVarValue(index, "_password");
126 if (!given || strcmp(given, password) != 0)
132 pPlayer->SetAdminId(id, false);
137 void PlayerManager::RunAuthChecks()
141 unsigned int removed = 0;
142 for (unsigned int i=1; i<=m_AuthQueue[0]; i++)
144 pPlayer = GetPlayerByIndex(m_AuthQueue[i]);
145 authstr = engine->GetPlayerNetworkIDString(pPlayer->m_pEdict);
146 if (authstr && authstr[0] != '\0'
147 && (strcmp(authstr, "STEAM_ID_PENDING") != 0))
149 /* Set authorization */
150 pPlayer->m_AuthID.assign(authstr);
151 pPlayer->m_IsAuthorized = true;
153 /* Mark as removed from queue */
154 unsigned int client = m_AuthQueue[i];
158 /* Do admin lookups */
159 AdminId id = g_Admins.FindAdminByIdentity("steam", authstr);
160 if (id != INVALID_ADMIN_ID)
162 CheckSetAdmin(client, pPlayer, id);
165 /* Send to extensions */
166 List<IClientListener *>::iterator iter;
167 IClientListener *pListener;
168 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
171 pListener->OnClientAuthorized(client, authstr);
172 if (!pPlayer->IsConnected())
178 /* Send to plugins if player is still connected */
179 if (pPlayer->IsConnected() && m_clauth->GetFunctionCount())
181 /* :TODO: handle the case of a player disconnecting in the middle */
182 m_clauth->PushCell(client);
183 m_clauth->PushString(authstr);
184 m_clauth->Execute(NULL);
189 /* Clean up the queue */
192 /* We don't have to compact the list if it's empty */
193 if (removed != m_AuthQueue[0])
195 unsigned int diff = 0;
196 for (unsigned int i=1; i<=m_AuthQueue[0]; i++)
198 /* If this member is removed... */
199 if (m_AuthQueue[i] == 0)
201 /* Increase the differential */
204 /* diff cannot increase faster than i+1 */
206 assert(i - diff >= 1);
207 /* move this index down */
208 m_AuthQueue[i - diff] = m_AuthQueue[i];
211 m_AuthQueue[0] -= removed;
214 g_SourceMod.SetAuthChecking(false);
219 bool PlayerManager::OnClientConnect(edict_t *pEntity, const char *pszName, const char *pszAddress, char *reject, int maxrejectlen)
221 int client = engine->IndexOfEdict(pEntity);
223 List<IClientListener *>::iterator iter;
224 IClientListener *pListener = NULL;
225 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
228 if (!pListener->InterceptClientConnect(client, reject, maxrejectlen))
236 m_Players[client].Initialize(pszName, pszAddress, pEntity);
237 m_clconnect->PushCell(client);
238 m_clconnect->PushStringEx(reject, maxrejectlen, SM_PARAM_STRING_UTF8, SM_PARAM_COPYBACK);
239 m_clconnect->PushCell(maxrejectlen);
240 m_clconnect->Execute(&res, NULL);
244 if (!m_Players[client].IsAuthorized())
246 m_AuthQueue[++m_AuthQueue[0]] = client;
247 g_SourceMod.SetAuthChecking(true);
250 RETURN_META_VALUE(MRES_SUPERCEDE, false);
253 m_UserIdLookUp[engine->GetPlayerUserId(pEntity)] = client;
258 bool PlayerManager::OnClientConnect_Post(edict_t *pEntity, const char *pszName, const char *pszAddress, char *reject, int maxrejectlen)
260 int client = engine->IndexOfEdict(pEntity);
261 bool orig_value = META_RESULT_ORIG_RET(bool);
262 CPlayer *pPlayer = GetPlayerByIndex(client);
265 List<IClientListener *>::iterator iter;
266 IClientListener *pListener = NULL;
267 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
270 pListener->OnClientConnected(client);
271 if (!pPlayer->IsConnected())
278 if (pPlayer->IsConnected())
280 /* Do an ip based lookup */
282 strncopy(ip, pszAddress, sizeof(ip));
283 if ((ptr = strchr(ip, ':')) != NULL)
288 AdminId id = g_Admins.FindAdminByIdentity("ip", pPlayer->GetIPAddress());
289 if (id != INVALID_ADMIN_ID)
291 CheckSetAdmin(client, pPlayer, id);
298 void PlayerManager::OnClientPutInServer(edict_t *pEntity, const char *playername)
301 int client = engine->IndexOfEdict(pEntity);
303 CPlayer *pPlayer = GetPlayerByIndex(client);
304 /* If they're not connected, they're a bot */
305 if (!pPlayer->IsConnected())
307 /* Run manual connection routines */
309 const char *authid = engine->GetPlayerNetworkIDString(pEntity);
310 pPlayer->Authorize(authid);
311 if (!OnClientConnect(pEntity, playername, "127.0.0.1", error, sizeof(error)))
313 /* :TODO: kick the bot if it's rejected */
316 List<IClientListener *>::iterator iter;
317 IClientListener *pListener = NULL;
318 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
321 pListener->OnClientConnected(client);
322 /* See if bot was kicked */
323 if (!pPlayer->IsConnected())
328 /* Now do authorization */
329 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
332 pListener->OnClientAuthorized(client, authid);
333 /* See if bot was kicked */
334 if (!pPlayer->IsConnected())
339 /* Finally, tell plugins */
340 if (m_clauth->GetFunctionCount())
342 m_clauth->PushCell(client);
343 m_clauth->PushString(authid);
344 m_clauth->Execute(NULL);
350 pPlayer->m_Info = playerinfo->GetPlayerInfo(pEntity);
353 List<IClientListener *>::iterator iter;
354 IClientListener *pListener = NULL;
355 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
358 pListener->OnClientPutInServer(client);
359 /* See if player was kicked */
360 if (!pPlayer->IsConnected())
366 m_Players[client].Connect();
368 m_clputinserver->PushCell(client);
369 m_clputinserver->Execute(&res, NULL);
372 void PlayerManager::OnSourceModLevelEnd()
374 /* Disconnect all bots still in game */
375 for (int i=1; i<=m_maxClients; i++)
377 if (m_Players[i].IsConnected() && m_Players[i].IsFakeClient())
379 OnClientDisconnect(m_Players[i].GetEdict());
384 void PlayerManager::OnClientDisconnect(edict_t *pEntity)
387 int client = engine->IndexOfEdict(pEntity);
389 if (m_Players[client].IsConnected())
391 m_cldisconnect->PushCell(client);
392 m_cldisconnect->Execute(&res, NULL);
395 if (m_Players[client].IsInGame())
400 List<IClientListener *>::iterator iter;
401 IClientListener *pListener = NULL;
402 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
405 pListener->OnClientDisconnecting(client);
409 * Remove client from auth queue if necessary
411 if (!m_Players[client].IsAuthorized())
413 for (unsigned int i=1; i<=m_AuthQueue[0]; i++)
415 if (m_AuthQueue[i] == (unsigned)client)
417 /* Move everything ahead of us back by one */
418 for (unsigned int j=i+1; j<=m_AuthQueue[0]; j++)
420 m_AuthQueue[j-1] = m_AuthQueue[j];
422 /* Remove us and break */
429 m_Players[client].Disconnect();
430 m_UserIdLookUp[engine->GetPlayerUserId(pEntity)] = 0;
433 void PlayerManager::OnClientDisconnect_Post(edict_t *pEntity)
436 int client = engine->IndexOfEdict(pEntity);
438 m_cldisconnect_post->PushCell(client);
439 m_cldisconnect_post->Execute(&res, NULL);
441 List<IClientListener *>::iterator iter;
442 IClientListener *pListener = NULL;
443 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
446 pListener->OnClientDisconnected(client);
450 void PlayerManager::OnClientCommand(edict_t *pEntity)
452 int client = engine->IndexOfEdict(pEntity);
453 cell_t res = Pl_Continue;
455 bool result = g_ValveMenuStyle.OnClientCommand(client);
460 result = g_RadioMenuStyle.OnClientCommand(client);
467 int args = engine->Cmd_Argc() - 1;
469 cell_t res2 = Pl_Continue;
470 m_clcommand->PushCell(client);
471 m_clcommand->PushCell(args);
472 m_clcommand->Execute(&res2, NULL);
481 RETURN_META(MRES_SUPERCEDE);
484 res = g_ConCmds.DispatchClientCommand(client, (ResultType)res);
486 if (res >= Pl_Handled)
488 RETURN_META(MRES_SUPERCEDE);
492 void PlayerManager::OnClientSettingsChanged(edict_t *pEntity)
495 int client = engine->IndexOfEdict(pEntity);
497 m_clinfochanged->PushCell(engine->IndexOfEdict(pEntity));
498 m_clinfochanged->Execute(&res, NULL);
499 m_Players[client].SetName(engine->GetClientConVarValue(client, "name"));
502 int PlayerManager::GetMaxClients()
507 CPlayer *PlayerManager::GetPlayerByIndex(int client) const
509 if (client > m_maxClients || client < 1)
513 return &m_Players[client];
516 int PlayerManager::GetNumPlayers()
518 return m_PlayerCount;
521 int PlayerManager::GetClientOfUserId(int userid)
523 if (userid < 0 || userid > USHRT_MAX)
528 int client = m_UserIdLookUp[userid];
530 /* Verify the userid. The cache can get messed up with older
531 * Valve engines. :TODO: If this gets fixed, do an old engine
532 * check before invoking this backwards compat code.
536 CPlayer *player = GetPlayerByIndex(client);
537 if (player && player->IsConnected())
539 int realUserId = engine->GetPlayerUserId(player->GetEdict());
540 if (realUserId == userid)
547 /* If we can't verify the userid, we have to do a manual loop */
549 for (int i = 1; i <= m_maxClients; i++)
551 player = GetPlayerByIndex(i);
552 if (!player || !player->IsConnected())
556 if (engine->GetPlayerUserId(player->GetEdict()) == userid)
558 m_UserIdLookUp[userid] = i;
566 void PlayerManager::AddClientListener(IClientListener *listener)
568 m_hooks.push_back(listener);
571 void PlayerManager::RemoveClientListener(IClientListener *listener)
573 m_hooks.remove(listener);
576 IGamePlayer *PlayerManager::GetGamePlayer(edict_t *pEdict)
578 int index = engine->IndexOfEdict(pEdict);
579 return GetGamePlayer(index);
582 IGamePlayer *PlayerManager::GetGamePlayer(int client)
584 return GetPlayerByIndex(client);
587 void PlayerManager::ClearAdminId(AdminId id)
589 for (int i=1; i<=m_maxClients; i++)
591 if (m_Players[i].m_Admin == id)
593 m_Players[i].DumpAdmin(true);
598 void PlayerManager::ClearAllAdmins()
600 for (int i=1; i<=m_maxClients; i++)
602 m_Players[i].DumpAdmin(true);
613 m_IsConnected = false;
615 m_IsAuthorized = false;
617 m_Admin = INVALID_ADMIN_ID;
622 void CPlayer::Initialize(const char *name, const char *ip, edict_t *pEntity)
624 m_IsConnected = true;
630 void CPlayer::Connect()
635 void CPlayer::Authorize(const char *steamid)
637 m_IsAuthorized = true;
638 m_AuthID.assign(steamid);
641 void CPlayer::Disconnect()
644 m_IsConnected = false;
646 m_IsAuthorized = false;
654 void CPlayer::SetName(const char *name)
659 const char *CPlayer::GetName()
661 return (m_Info) ? m_Info->GetName(): m_Name.c_str();
664 const char *CPlayer::GetIPAddress()
669 const char *CPlayer::GetAuthString()
671 return m_AuthID.c_str();
674 edict_t *CPlayer::GetEdict()
679 bool CPlayer::IsInGame()
684 bool CPlayer::IsConnected()
686 return m_IsConnected;
689 bool CPlayer::IsAuthorized()
691 return m_IsAuthorized;
694 IPlayerInfo *CPlayer::GetPlayerInfo()
699 bool CPlayer::IsFakeClient()
701 return (strcmp(m_AuthID.c_str(), "BOT") == 0);
704 void CPlayer::SetAdminId(AdminId id, bool temporary)
714 m_TempAdmin = temporary;
717 AdminId CPlayer::GetAdminId()
722 void CPlayer::DumpAdmin(bool deleting)
724 if (m_Admin != INVALID_ADMIN_ID)
726 if (m_TempAdmin && !deleting)
728 g_Admins.InvalidateAdmin(m_Admin);
730 m_Admin = INVALID_ADMIN_ID;