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"
23 PlayerManager g_Players;
25 SH_DECL_HOOK5(IServerGameClients, ClientConnect, SH_NOATTRIB, 0, bool, edict_t *, const char *, const char *, char *, int);
26 SH_DECL_HOOK2_void(IServerGameClients, ClientPutInServer, SH_NOATTRIB, 0, edict_t *, const char *);
27 SH_DECL_HOOK1_void(IServerGameClients, ClientDisconnect, SH_NOATTRIB, 0, edict_t *);
28 SH_DECL_HOOK1_void(IServerGameClients, ClientCommand, SH_NOATTRIB, 0, edict_t *);
29 SH_DECL_HOOK1_void(IServerGameClients, ClientSettingsChanged, SH_NOATTRIB, 0, edict_t *);
30 SH_DECL_HOOK3_void(IServerGameDLL, ServerActivate, SH_NOATTRIB, 0, edict_t *, int, int);
32 PlayerManager::PlayerManager()
37 m_UserIdLookUp = new int[USHRT_MAX];
38 memset(m_UserIdLookUp, 0, sizeof(int) * USHRT_MAX);
41 PlayerManager::~PlayerManager()
43 delete [] m_AuthQueue;
44 delete [] m_UserIdLookUp;
47 void PlayerManager::OnSourceModAllInitialized()
49 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientConnect, serverClients, this, &PlayerManager::OnClientConnect, false);
50 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientConnect, serverClients, this, &PlayerManager::OnClientConnect_Post, true);
51 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientPutInServer, serverClients, this, &PlayerManager::OnClientPutInServer, true);
52 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, serverClients, this, &PlayerManager::OnClientDisconnect, false);
53 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, serverClients, this, &PlayerManager::OnClientDisconnect_Post, true);
54 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientCommand, serverClients, this, &PlayerManager::OnClientCommand, false);
55 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientSettingsChanged, serverClients, this, &PlayerManager::OnClientSettingsChanged, true);
56 SH_ADD_HOOK_MEMFUNC(IServerGameDLL, ServerActivate, gamedll, this, &PlayerManager::OnServerActivate, true);
58 g_ShareSys.AddInterface(NULL, this);
60 ParamType p1[] = {Param_Cell, Param_String, Param_Cell};
61 ParamType p2[] = {Param_Cell};
63 m_clconnect = g_Forwards.CreateForward("OnClientConnect", ET_Event, 3, p1);
64 m_clputinserver = g_Forwards.CreateForward("OnClientPutInServer", ET_Ignore, 1, p2);
65 m_cldisconnect = g_Forwards.CreateForward("OnClientDisconnect", ET_Ignore, 1, p2);
66 m_cldisconnect_post = g_Forwards.CreateForward("OnClientDisconnect_Post", ET_Ignore, 1, p2);
67 m_clcommand = g_Forwards.CreateForward("OnClientCommand", ET_Hook, 2, NULL, Param_Cell, Param_Cell);
68 m_clinfochanged = g_Forwards.CreateForward("OnClientSettingsChanged", ET_Ignore, 1, p2);
69 m_clauth = g_Forwards.CreateForward("OnClientAuthorized", ET_Ignore, 2, NULL, Param_Cell, Param_String);
70 m_onActivate = g_Forwards.CreateForward("OnServerLoad", ET_Ignore, 0, NULL);
71 m_onActivate2 = g_Forwards.CreateForward("OnMapStart", ET_Ignore, 0, NULL);
74 void PlayerManager::OnSourceModShutdown()
76 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientConnect, serverClients, this, &PlayerManager::OnClientConnect, false);
77 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientPutInServer, serverClients, this, &PlayerManager::OnClientPutInServer, true);
78 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, serverClients, this, &PlayerManager::OnClientDisconnect, false);
79 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, serverClients, this, &PlayerManager::OnClientDisconnect_Post, true);
80 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientCommand, serverClients, this, &PlayerManager::OnClientCommand, false);
81 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientSettingsChanged, serverClients, this, &PlayerManager::OnClientSettingsChanged, true);
82 SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, ServerActivate, gamedll, this, &PlayerManager::OnServerActivate, true);
84 /* Release forwards */
85 g_Forwards.ReleaseForward(m_clconnect);
86 g_Forwards.ReleaseForward(m_clputinserver);
87 g_Forwards.ReleaseForward(m_cldisconnect);
88 g_Forwards.ReleaseForward(m_cldisconnect_post);
89 g_Forwards.ReleaseForward(m_clcommand);
90 g_Forwards.ReleaseForward(m_clinfochanged);
91 g_Forwards.ReleaseForward(m_clauth);
92 g_Forwards.ReleaseForward(m_onActivate);
93 g_Forwards.ReleaseForward(m_onActivate2);
98 void PlayerManager::OnServerActivate(edict_t *pEdictList, int edictCount, int clientMax)
102 /* Initialize all players */
103 m_maxClients = clientMax;
105 m_Players = new CPlayer[m_maxClients + 1];
106 m_AuthQueue = new unsigned int[m_maxClients + 1];
109 memset(m_AuthQueue, 0, sizeof(unsigned int) * (m_maxClients + 1));
111 m_onActivate->Execute(NULL);
112 m_onActivate2->Execute(NULL);
115 void PlayerManager::RunAuthChecks()
119 unsigned int removed = 0;
120 for (unsigned int i=1; i<=m_AuthQueue[0]; i++)
122 pPlayer = GetPlayerByIndex(m_AuthQueue[i]);
123 authstr = engine->GetPlayerNetworkIDString(pPlayer->m_pEdict);
124 if (authstr && authstr[0] != '\0'
125 && (strcmp(authstr, "STEAM_ID_PENDING") != 0))
127 /* Set authorization */
128 pPlayer->m_AuthID.assign(authstr);
129 pPlayer->m_IsAuthorized = true;
131 /* Mark as removed from queue */
132 unsigned int client = m_AuthQueue[i];
136 /* Send to extensions */
137 List<IClientListener *>::iterator iter;
138 IClientListener *pListener;
139 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
142 pListener->OnClientAuthorized(client, authstr);
143 if (!pPlayer->IsConnected())
149 /* Send to plugins if player is still connected */
150 if (pPlayer->IsConnected() && m_clauth->GetFunctionCount())
152 /* :TODO: handle the case of a player disconnecting in the middle */
153 m_clauth->PushCell(client);
154 m_clauth->PushString(authstr);
155 m_clauth->Execute(NULL);
160 /* Clean up the queue */
163 /* We don't have to compact the list if it's empty */
164 if (removed != m_AuthQueue[0])
166 unsigned int diff = 0;
167 for (unsigned int i=1; i<=m_AuthQueue[0]; i++)
169 /* If this member is removed... */
170 if (m_AuthQueue[i] == 0)
172 /* Increase the differential */
175 /* diff cannot increase faster than i+1 */
177 assert(i - diff >= 1);
178 /* move this index down */
179 m_AuthQueue[i - diff] = m_AuthQueue[i];
182 m_AuthQueue[0] -= removed;
185 g_SourceMod.SetAuthChecking(false);
190 bool PlayerManager::OnClientConnect(edict_t *pEntity, const char *pszName, const char *pszAddress, char *reject, int maxrejectlen)
192 int client = engine->IndexOfEdict(pEntity);
194 List<IClientListener *>::iterator iter;
195 IClientListener *pListener = NULL;
196 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
199 if (!pListener->InterceptClientConnect(client, reject, maxrejectlen))
207 m_Players[client].Initialize(pszName, pszAddress, pEntity);
208 m_clconnect->PushCell(client);
209 m_clconnect->PushStringEx(reject, maxrejectlen, SM_PARAM_STRING_UTF8, SM_PARAM_COPYBACK);
210 m_clconnect->PushCell(maxrejectlen);
211 m_clconnect->Execute(&res, NULL);
215 if (!m_Players[client].IsAuthorized())
217 m_AuthQueue[++m_AuthQueue[0]] = client;
218 g_SourceMod.SetAuthChecking(true);
221 RETURN_META_VALUE(MRES_SUPERCEDE, false);
224 m_UserIdLookUp[engine->GetPlayerUserId(pEntity)] = client;
229 bool PlayerManager::OnClientConnect_Post(edict_t *pEntity, const char *pszName, const char *pszAddress, char *reject, int maxrejectlen)
231 int client = engine->IndexOfEdict(pEntity);
232 bool orig_value = META_RESULT_ORIG_RET(bool);
235 List<IClientListener *>::iterator iter;
236 IClientListener *pListener = NULL;
237 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
240 pListener->OnClientConnected(client);
247 void PlayerManager::OnClientPutInServer(edict_t *pEntity, const char *playername)
250 int client = engine->IndexOfEdict(pEntity);
252 CPlayer *pPlayer = GetPlayerByIndex(client);
253 /* If they're not connected, they're a bot */
254 if (!pPlayer->IsConnected())
256 /* Run manual connection routines */
258 const char *authid = engine->GetPlayerNetworkIDString(pEntity);
259 pPlayer->Authorize(authid);
260 if (!OnClientConnect(pEntity, playername, "127.0.0.1", error, sizeof(error)))
262 /* :TODO: kick the bot if it's rejected */
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 /* See if bot was kicked */
272 if (!pPlayer->IsConnected())
277 /* Now do authorization */
278 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
281 pListener->OnClientAuthorized(client, authid);
282 /* See if bot was kicked */
283 if (!pPlayer->IsConnected())
288 /* Finally, tell plugins */
289 if (m_clauth->GetFunctionCount())
291 m_clauth->PushCell(client);
292 m_clauth->PushString(authid);
293 m_clauth->Execute(NULL);
299 pPlayer->m_Info = playerinfo->GetPlayerInfo(pEntity);
302 List<IClientListener *>::iterator iter;
303 IClientListener *pListener = NULL;
304 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
307 pListener->OnClientPutInServer(client);
308 /* See if player was kicked */
309 if (!pPlayer->IsConnected())
315 m_Players[client].Connect();
317 m_clputinserver->PushCell(client);
318 m_clputinserver->Execute(&res, NULL);
321 void PlayerManager::OnClientDisconnect(edict_t *pEntity)
324 int client = engine->IndexOfEdict(pEntity);
326 if (m_Players[client].IsConnected())
328 m_cldisconnect->PushCell(client);
329 m_cldisconnect->Execute(&res, NULL);
332 if (m_Players[client].IsInGame())
337 List<IClientListener *>::iterator iter;
338 IClientListener *pListener = NULL;
339 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
342 pListener->OnClientDisconnecting(client);
346 * Remove client from auth queue if necessary
348 if (!m_Players[client].IsAuthorized())
350 for (unsigned int i=1; i<=m_AuthQueue[0]; i++)
352 if (m_AuthQueue[i] == (unsigned)client)
354 /* Move everything ahead of us back by one */
355 for (unsigned int j=i+1; j<=m_AuthQueue[0]; j++)
357 m_AuthQueue[j-1] = m_AuthQueue[j];
359 /* Remove us and break */
366 m_Players[client].Disconnect();
367 m_UserIdLookUp[engine->GetPlayerUserId(pEntity)] = 0;
370 void PlayerManager::OnClientDisconnect_Post(edict_t *pEntity)
373 int client = engine->IndexOfEdict(pEntity);
375 m_cldisconnect_post->PushCell(client);
376 m_cldisconnect_post->Execute(&res, NULL);
378 List<IClientListener *>::iterator iter;
379 IClientListener *pListener = NULL;
380 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
383 pListener->OnClientDisconnected(client);
387 void PlayerManager::OnClientCommand(edict_t *pEntity)
389 int client = engine->IndexOfEdict(pEntity);
390 cell_t res = Pl_Continue;
392 bool result = g_ValveMenuStyle.OnClientCommand(client);
397 result = g_RadioMenuStyle.OnClientCommand(client);
404 int args = engine->Cmd_Argc() - 1;
406 cell_t res2 = Pl_Continue;
407 m_clcommand->PushCell(client);
408 m_clcommand->PushCell(args);
409 m_clcommand->Execute(&res2, NULL);
418 RETURN_META(MRES_SUPERCEDE);
421 res = g_ConCmds.DispatchClientCommand(client, (ResultType)res);
423 if (res >= Pl_Handled)
425 RETURN_META(MRES_SUPERCEDE);
429 void PlayerManager::OnClientSettingsChanged(edict_t *pEntity)
432 int client = engine->IndexOfEdict(pEntity);
434 m_clinfochanged->PushCell(engine->IndexOfEdict(pEntity));
435 m_clinfochanged->Execute(&res, NULL);
436 m_Players[client].SetName(engine->GetClientConVarValue(client, "name"));
439 int PlayerManager::GetMaxClients()
444 CPlayer *PlayerManager::GetPlayerByIndex(int client) const
446 if (client > m_maxClients || client < 1)
450 return &m_Players[client];
453 int PlayerManager::GetNumPlayers()
455 return m_PlayerCount;
458 int PlayerManager::GetClientOfUserId(int userid)
460 if (userid < 0 || userid > USHRT_MAX)
465 int client = m_UserIdLookUp[userid];
467 /* Verify the userid. The cache can get messed up with older
468 * Valve engines. :TODO: If this gets fixed, do an old engine
469 * check before invoking this backwards compat code.
473 CPlayer *player = GetPlayerByIndex(client);
474 if (player && player->IsConnected())
476 int realUserId = engine->GetPlayerUserId(player->GetEdict());
477 if (realUserId == userid)
484 /* If we can't verify the userid, we have to do a manual loop */
486 for (int i = 1; i <= m_maxClients; i++)
488 player = GetPlayerByIndex(i);
489 if (!player || !player->IsConnected())
493 if (engine->GetPlayerUserId(player->GetEdict()) == userid)
495 m_UserIdLookUp[userid] = i;
503 void PlayerManager::AddClientListener(IClientListener *listener)
505 m_hooks.push_back(listener);
508 void PlayerManager::RemoveClientListener(IClientListener *listener)
510 m_hooks.remove(listener);
513 IGamePlayer *PlayerManager::GetGamePlayer(edict_t *pEdict)
515 int index = engine->IndexOfEdict(pEdict);
516 return GetGamePlayer(index);
519 IGamePlayer *PlayerManager::GetGamePlayer(int client)
521 return GetPlayerByIndex(client);
524 void PlayerManager::ClearAdminId(AdminId id)
526 for (int i=1; i<=m_maxClients; i++)
528 if (m_Players[i].m_Admin == id)
530 m_Players[i].DumpAdmin(true);
535 void PlayerManager::ClearAllAdmins()
537 for (int i=1; i<=m_maxClients; i++)
539 m_Players[i].DumpAdmin(true);
550 m_IsConnected = false;
552 m_IsAuthorized = false;
554 m_Admin = INVALID_ADMIN_ID;
559 void CPlayer::Initialize(const char *name, const char *ip, edict_t *pEntity)
561 m_IsConnected = true;
567 void CPlayer::Connect()
572 void CPlayer::Authorize(const char *steamid)
574 m_IsAuthorized = true;
575 m_AuthID.assign(steamid);
578 void CPlayer::Disconnect()
581 m_IsConnected = false;
583 m_IsAuthorized = false;
591 void CPlayer::SetName(const char *name)
596 const char *CPlayer::GetName()
598 return (m_Info) ? m_Info->GetName(): m_Name.c_str();
601 const char *CPlayer::GetIPAddress()
606 const char *CPlayer::GetAuthString()
608 return m_AuthID.c_str();
611 edict_t *CPlayer::GetEdict()
616 bool CPlayer::IsInGame()
621 bool CPlayer::IsConnected()
623 return m_IsConnected;
626 bool CPlayer::IsAuthorized()
628 return m_IsAuthorized;
631 IPlayerInfo *CPlayer::GetPlayerInfo()
636 bool CPlayer::IsFakeClient()
638 return (strcmp(m_AuthID.c_str(), "BOT") == 0);
641 void CPlayer::SetAdminId(AdminId id, bool temporary)
651 m_TempAdmin = temporary;
654 AdminId CPlayer::GetAdminId()
659 void CPlayer::DumpAdmin(bool deleting)
661 if (m_Admin != INVALID_ADMIN_ID)
663 if (m_TempAdmin && !deleting)
665 g_Admins.InvalidateAdmin(m_Admin);
667 m_Admin = INVALID_ADMIN_ID;