3 * =============================================================================
5 * Copyright (C) 2004-2007 AlliedModders LLC. All rights reserved.
6 * =============================================================================
8 * This program is free software; you can redistribute it and/or modify it under
9 * the terms of the GNU General Public License, version 3.0, as published by the
10 * Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but WITHOUT
13 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
14 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
17 * You should have received a copy of the GNU General Public License along with
18 * this program. If not, see <http://www.gnu.org/licenses/>.
20 * As a special exception, AlliedModders LLC gives you permission to link the
21 * code of this program (as well as its derivative works) to "Half-Life 2," the
22 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
23 * by the Valve Corporation. You must obey the GNU General Public License in
24 * all respects for all other code used. Additionally, AlliedModders LLC grants
25 * this exception to all derivative works. AlliedModders LLC defines further
26 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
27 * or <http://www.sourcemod.net/license.php>.
34 #include <ITextParsers.h>
35 #include "AdminCache.h"
37 #include "ForwardSys.h"
38 #include "PlayerManager.h"
39 #include "ConCmdManager.h"
41 #include "sourcemod.h"
42 #include "sm_stringutil.h"
43 #include "sourcemm_api.h"
45 #define LEVEL_STATE_NONE 0
46 #define LEVEL_STATE_LEVELS 1
47 #define LEVEL_STATE_FLAGS 2
50 AdminFlag g_FlagLetters[26];
53 ConVar sm_immunity_mode("sm_immunity_mode", "1", FCVAR_SPONLY|FCVAR_PROTECTED, "Mode for deciding immunity protection");
56 AdminFlag g_DefaultFlags[26] =
58 Admin_Reservation, Admin_Generic, Admin_Kick, Admin_Ban, Admin_Unban,
59 Admin_Slay, Admin_Changemap, Admin_Convars, Admin_Config, Admin_Chat,
60 Admin_Vote, Admin_Password, Admin_RCON, Admin_Cheats, Admin_Custom1,
61 Admin_Custom2, Admin_Custom3, Admin_Custom4, Admin_Custom5, Admin_Custom6,
62 Admin_Generic, Admin_Generic, Admin_Generic, Admin_Generic, Admin_Generic,
67 class FlagReader : public ITextListener_SMC
74 memcpy(g_FlagLetters, g_DefaultFlags, sizeof(AdminFlag) * 26);
75 for (unsigned int i=0; i<20; i++)
85 unsigned int line = 0;
89 m_bFileNameLogged = false;
90 g_SourceMod.BuildPath(Path_SM, m_File, sizeof(m_File), "configs/admin_levels.cfg");
92 if ((error = textparsers->ParseFile_SMC(m_File, this, &line, NULL))
95 const char *err_string = textparsers->GetSMCErrorString(error);
98 err_string = "Unknown error";
100 ParseError("Error %d (%s)", error, err_string);
106 void ReadSMC_ParseStart()
108 m_LevelState = LEVEL_STATE_NONE;
110 memset(g_FlagSet, 0, sizeof(g_FlagSet));
112 SMCParseResult ReadSMC_NewSection(const char *name, bool opt_quotes)
117 return SMCParse_Continue;
120 if (m_LevelState == LEVEL_STATE_NONE)
122 if (strcmp(name, "Levels") == 0)
124 m_LevelState = LEVEL_STATE_LEVELS;
128 } else if (m_LevelState == LEVEL_STATE_LEVELS) {
129 if (strcmp(name, "Flags") == 0)
131 m_LevelState = LEVEL_STATE_FLAGS;
139 return SMCParse_Continue;
141 SMCParseResult ReadSMC_KeyValue(const char *key, const char *value, bool key_quotes, bool value_quotes)
143 if (m_LevelState != LEVEL_STATE_FLAGS || m_IgnoreLevel)
145 return SMCParse_Continue;
148 unsigned char c = (unsigned)value[0];
150 if (c < (unsigned)'a' || c > (unsigned)'z')
152 ParseError("Flag \"%c\" is not a lower-case ASCII letter", c);
153 return SMCParse_Continue;
158 assert(c >= 0 && c < 26);
160 if (!g_Admins.FindFlag(key, &g_FlagLetters[c]))
162 ParseError("Unrecognized admin level \"%s\"", key);
163 return SMCParse_Continue;
168 return SMCParse_Continue;
170 SMCParseResult ReadSMC_LeavingSection()
175 return SMCParse_Continue;
178 if (m_LevelState == LEVEL_STATE_FLAGS)
180 m_LevelState = LEVEL_STATE_LEVELS;
181 return SMCParse_Halt;
182 } else if (m_LevelState == LEVEL_STATE_LEVELS) {
183 m_LevelState = LEVEL_STATE_NONE;
186 return SMCParse_Continue;
188 SMCParseResult ReadSMC_RawLine(const char *line, unsigned int curline)
191 return SMCParse_Continue;
193 void ParseError(const char *message, ...)
198 va_start(ap, message);
199 UTIL_FormatArgs(buffer, sizeof(buffer), message, ap);
202 if (!m_bFileNameLogged)
204 g_Logger.LogError("[SM] Parse error(s) detected in file \"%s\":", m_File);
205 m_bFileNameLogged = true;
208 g_Logger.LogError("[SM] (Line %d): %s", m_Line, buffer);
211 bool m_bFileNameLogged;
212 char m_File[PLATFORM_MAX_PATH];
218 AdminCache::AdminCache()
220 m_pCmdOverrides = sm_trie_create();
221 m_pCmdGrpOverrides = sm_trie_create();
222 m_pStrings = new BaseStringTable(1024);
223 m_pMemory = m_pStrings->GetMemTable();
224 m_FreeGroupList = m_FirstGroup = m_LastGroup = INVALID_GROUP_ID;
225 m_FreeUserList = m_FirstUser = m_LastUser = INVALID_ADMIN_ID;
226 m_pGroups = sm_trie_create();
229 m_pAuthTables = sm_trie_create();
230 m_InvalidatingAdmins = false;
231 m_destroying = false;
232 m_pLevelNames = sm_trie_create();
235 AdminCache::~AdminCache()
238 DumpAdminCache(AdminCache_Overrides, false);
239 DumpAdminCache(AdminCache_Groups, false);
241 sm_trie_destroy(m_pCmdGrpOverrides);
242 sm_trie_destroy(m_pCmdOverrides);
246 sm_trie_destroy(m_pGroups);
249 List<AuthMethod>::iterator iter;
250 for (iter=m_AuthMethods.begin();
251 iter!=m_AuthMethods.end();
254 sm_trie_destroy((*iter).table);
257 sm_trie_destroy(m_pAuthTables);
261 sm_trie_destroy(m_pLevelNames);
264 void AdminCache::OnSourceModStartup(bool late)
266 RegisterAuthIdentType("steam");
267 RegisterAuthIdentType("name");
268 RegisterAuthIdentType("ip");
270 NameFlag("reservation", Admin_Reservation);
271 NameFlag("kick", Admin_Kick);
272 NameFlag("generic", Admin_Generic);
273 NameFlag("ban", Admin_Ban);
274 NameFlag("unban", Admin_Unban);
275 NameFlag("slay", Admin_Slay);
276 NameFlag("changemap", Admin_Changemap);
277 NameFlag("cvars", Admin_Convars);
278 NameFlag("config", Admin_Config);
279 NameFlag("chat", Admin_Chat);
280 NameFlag("vote", Admin_Vote);
281 NameFlag("password", Admin_Password);
282 NameFlag("rcon", Admin_RCON);
283 NameFlag("cheats", Admin_Cheats);
284 NameFlag("root", Admin_Root);
285 NameFlag("custom1", Admin_Custom1);
286 NameFlag("custom2", Admin_Custom2);
287 NameFlag("custom3", Admin_Custom3);
288 NameFlag("custom4", Admin_Custom4);
289 NameFlag("custom5", Admin_Custom5);
290 NameFlag("custom6", Admin_Custom6);
293 void AdminCache::OnSourceModAllInitialized()
295 m_pCacheFwd = g_Forwards.CreateForward("OnRebuildAdminCache", ET_Ignore, 1, NULL, Param_Cell);
296 g_ShareSys.AddInterface(NULL, this);
299 void AdminCache::OnSourceModLevelChange(const char *mapName)
301 /* For now, we only read these once per level. */
302 s_FlagReader.LoadLevels();
305 void AdminCache::OnSourceModShutdown()
307 g_Forwards.ReleaseForward(m_pCacheFwd);
311 void AdminCache::OnSourceModPluginsLoaded()
313 DumpAdminCache(AdminCache_Overrides, true);
314 DumpAdminCache(AdminCache_Groups, true);
317 void AdminCache::NameFlag(const char *str, AdminFlag flag)
319 sm_trie_insert(m_pLevelNames, str, (void *)flag);
322 bool AdminCache::FindFlag(const char *str, AdminFlag *pFlag)
325 if (!sm_trie_retrieve(m_pLevelNames, str, &obj))
332 *pFlag = (AdminFlag)(int)obj;
338 void AdminCache::AddCommandOverride(const char *cmd, OverrideType type, FlagBits flags)
341 if (type == Override_Command)
343 pTrie = m_pCmdOverrides;
344 } else if (type == Override_CommandGroup) {
345 pTrie = m_pCmdGrpOverrides;
350 sm_trie_insert(pTrie, cmd, (void *)(unsigned int)flags);
352 g_ConCmds.UpdateAdminCmdFlags(cmd, type, flags);
355 bool AdminCache::GetCommandOverride(const char *cmd, OverrideType type, FlagBits *pFlags)
359 if (type == Override_Command)
361 pTrie = m_pCmdOverrides;
362 } else if (type == Override_CommandGroup) {
363 pTrie = m_pCmdGrpOverrides;
369 if (sm_trie_retrieve(pTrie, cmd, &object))
373 *pFlags = (FlagBits)object;
381 void AdminCache::UnsetCommandOverride(const char *cmd, OverrideType type)
383 if (type == Override_Command)
385 return _UnsetCommandOverride(cmd);
386 } else if (type == Override_CommandGroup) {
387 return _UnsetCommandGroupOverride(cmd);
391 void AdminCache::_UnsetCommandGroupOverride(const char *group)
393 if (!m_pCmdGrpOverrides)
398 sm_trie_delete(m_pCmdGrpOverrides, group);
400 g_ConCmds.UpdateAdminCmdFlags(group, Override_CommandGroup, 0);
403 void AdminCache::_UnsetCommandOverride(const char *cmd)
405 if (!m_pCmdOverrides)
410 sm_trie_delete(m_pCmdOverrides, cmd);
412 g_ConCmds.UpdateAdminCmdFlags(cmd, Override_Command, 0);
415 void AdminCache::DumpCommandOverrideCache(OverrideType type)
417 if (type == Override_Command && m_pCmdOverrides)
419 sm_trie_clear(m_pCmdOverrides);
420 } else if (type == Override_CommandGroup && m_pCmdGrpOverrides) {
421 sm_trie_clear(m_pCmdGrpOverrides);
425 AdminId AdminCache::CreateAdmin(const char *name)
430 if (m_FreeUserList != INVALID_ADMIN_ID)
432 pUser = (AdminUser *)m_pMemory->GetAddress(m_FreeUserList);
433 assert(pUser->magic == USR_MAGIC_UNSET);
435 m_FreeUserList = pUser->next_user;
437 id = m_pMemory->CreateMem(sizeof(AdminUser), (void **)&pUser);
439 pUser->grp_table = -1;
444 pUser->grp_count = 0;
445 pUser->password = -1;
446 pUser->magic = USR_MAGIC_SET;
447 pUser->auth.identidx = -1;
448 pUser->auth.index = 0;
449 pUser->immunity_level = 0;
450 pUser->serialchange = 1;
452 if (m_FirstUser == INVALID_ADMIN_ID)
457 AdminUser *pPrev = (AdminUser *)m_pMemory->GetAddress(m_LastUser);
458 pPrev->next_user = id;
459 pUser->prev_user = m_LastUser;
463 if (name && name[0] != '\0')
465 int nameidx = m_pStrings->AddString(name);
466 pUser = (AdminUser *)m_pMemory->GetAddress(id);
467 pUser->nameidx = nameidx;
473 GroupId AdminCache::AddGroup(const char *group_name)
475 if (sm_trie_retrieve(m_pGroups, group_name, NULL))
477 return INVALID_GROUP_ID;
482 if (m_FreeGroupList != INVALID_GROUP_ID)
484 pGroup = (AdminGroup *)m_pMemory->GetAddress(m_FreeGroupList);
485 assert(pGroup->magic == GRP_MAGIC_UNSET);
486 id = m_FreeGroupList;
487 m_FreeGroupList = pGroup->next_grp;
489 id = m_pMemory->CreateMem(sizeof(AdminGroup), (void **)&pGroup);
492 pGroup->immunity_level = 0;
493 pGroup->immune_table = -1;
494 pGroup->magic = GRP_MAGIC_SET;
495 pGroup->next_grp = INVALID_GROUP_ID;
496 pGroup->pCmdGrpTable = NULL;
497 pGroup->pCmdTable = NULL;
498 pGroup->addflags = 0;
500 if (m_FirstGroup == INVALID_GROUP_ID)
504 pGroup->prev_grp = INVALID_GROUP_ID;
506 AdminGroup *pPrev = (AdminGroup *)m_pMemory->GetAddress(m_LastGroup);
507 assert(pPrev->magic == GRP_MAGIC_SET);
508 pPrev->next_grp = id;
509 pGroup->prev_grp = m_LastGroup;
513 int nameidx = m_pStrings->AddString(group_name);
514 pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
515 pGroup->nameidx = nameidx;
517 sm_trie_insert(m_pGroups, group_name, (void *)id);
522 GroupId AdminCache::FindGroupByName(const char *group_name)
526 if (!sm_trie_retrieve(m_pGroups, group_name, &object))
528 return INVALID_GROUP_ID;
531 GroupId id = (GroupId)object;
532 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
534 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
536 return INVALID_GROUP_ID;
542 void AdminCache::SetGroupAddFlag(GroupId id, AdminFlag flag, bool enabled)
544 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
545 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
550 if (flag < Admin_Reservation || flag >= AdminFlags_TOTAL)
555 FlagBits bits = (1<<(FlagBits)flag);
559 pGroup->addflags |= bits;
561 pGroup->addflags &= ~bits;
565 bool AdminCache::GetGroupAddFlag(GroupId id, AdminFlag flag)
567 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
568 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
573 if (flag < Admin_Reservation || flag >= AdminFlags_TOTAL)
578 FlagBits bit = 1<<(FlagBits)flag;
579 return ((pGroup->addflags & bit) == bit);
582 FlagBits AdminCache::GetGroupAddFlags(GroupId id)
584 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
585 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
590 return pGroup->addflags;
593 const char *AdminCache::GetGroupName(GroupId gid)
595 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(gid);
596 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
601 return m_pStrings->GetString(pGroup->nameidx);
604 void AdminCache::SetGroupGenericImmunity(GroupId id, ImmunityType type, bool enabled)
606 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
607 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
612 unsigned int level = 0;
616 if (type == Immunity_Default)
619 } else if (type == Immunity_Global) {
622 if (level > pGroup->immunity_level)
624 pGroup->immunity_level = level;
627 pGroup->immunity_level = 0;
631 bool AdminCache::GetGroupGenericImmunity(GroupId id, ImmunityType type)
633 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
634 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
639 if (type == Immunity_Default && pGroup->immunity_level >= 1)
642 } else if (type == Immunity_Global && pGroup->immunity_level >= 2) {
649 void AdminCache::AddGroupImmunity(GroupId id, GroupId other_id)
651 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(other_id);
652 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
657 pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
658 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
663 /* We always need to resize the immunity table */
665 if (pGroup->immune_table == -1)
667 tblidx = m_pMemory->CreateMem(sizeof(int) * 2, (void **)&table);
668 pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
671 int *old_table = (int *)m_pMemory->GetAddress(pGroup->immune_table);
672 /* Break out if this group is already in the list */
673 for (int i=0; i<old_table[0]; i++)
675 if (old_table[1+i] == other_id)
680 tblidx = m_pMemory->CreateMem(sizeof(int) * (old_table[0] + 2), (void **)&table);
681 /* Get the old address again in case of resize */
682 pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
683 old_table = (int *)m_pMemory->GetAddress(pGroup->immune_table);
684 table[0] = old_table[0];
685 for (unsigned int i=1; i<=(unsigned int)old_table[0]; i++)
687 table[i] = old_table[i];
692 pGroup->immune_table = tblidx;
694 /* Add to the array */
696 table[table[0]] = other_id;
699 unsigned int AdminCache::GetGroupImmunityCount(GroupId id)
701 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
702 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
707 if (pGroup->immune_table == -1)
712 int *table = (int *)m_pMemory->GetAddress(pGroup->immune_table);
717 GroupId AdminCache::GetGroupImmunity(GroupId id, unsigned int number)
719 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
720 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
722 return INVALID_GROUP_ID;
725 if (pGroup->immune_table == -1)
727 return INVALID_GROUP_ID;
730 int *table = (int *)m_pMemory->GetAddress(pGroup->immune_table);
731 if (number >= (unsigned int)table[0])
733 return INVALID_GROUP_ID;
736 return table[1 + number];
739 void AdminCache::AddGroupCommandOverride(GroupId id, const char *name, OverrideType type, OverrideRule rule)
741 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
742 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
748 if (type == Override_Command)
750 if (pGroup->pCmdTable == NULL)
752 pGroup->pCmdTable = sm_trie_create();
754 pTrie = pGroup->pCmdTable;
755 } else if (type == Override_CommandGroup) {
756 if (pGroup->pCmdGrpTable == NULL)
758 pGroup->pCmdGrpTable = sm_trie_create();
760 pTrie = pGroup->pCmdGrpTable;
765 sm_trie_insert(pTrie, name, (void *)(int)rule);
768 bool AdminCache::GetGroupCommandOverride(GroupId id, const char *name, OverrideType type, OverrideRule *pRule)
770 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
771 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
777 if (type == Override_Command)
779 if (pGroup->pCmdTable == NULL)
783 pTrie = pGroup->pCmdTable;
784 } else if (type == Override_CommandGroup) {
785 if (pGroup->pCmdGrpTable == NULL)
789 pTrie = pGroup->pCmdGrpTable;
795 if (!sm_trie_retrieve(pTrie, name, &object))
802 *pRule = (OverrideRule)(int)object;
808 Trie *AdminCache::GetMethodByIndex(unsigned int index)
810 List<AuthMethod>::iterator iter;
811 for (iter=m_AuthMethods.begin();
812 iter!=m_AuthMethods.end();
817 return (*iter).table;
824 bool AdminCache::InvalidateAdmin(AdminId id)
826 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
828 if (!pUser || pUser->magic != USR_MAGIC_SET)
833 if (!m_InvalidatingAdmins && !m_destroying)
835 g_Players.ClearAdminId(id);
838 /* Unlink from the dbl link list */
839 if (id == m_FirstUser && id == m_LastUser)
841 m_FirstUser = INVALID_ADMIN_ID;
842 m_LastUser = INVALID_ADMIN_ID;
843 } else if (id == m_FirstUser) {
844 m_FirstUser = pUser->next_user;
845 pOther = (AdminUser *)m_pMemory->GetAddress(m_FirstUser);
846 pOther->prev_user = INVALID_ADMIN_ID;
847 } else if (id == m_LastUser) {
848 m_LastUser = pUser->prev_user;
849 pOther = (AdminUser *)m_pMemory->GetAddress(m_LastUser);
850 pOther->next_user = INVALID_ADMIN_ID;
852 pOther = (AdminUser *)m_pMemory->GetAddress(pUser->prev_user);
853 pOther->next_user = pUser->next_user;
854 pOther = (AdminUser *)m_pMemory->GetAddress(pUser->next_user);
855 pOther->prev_user = pUser->prev_user;
858 /* Unlink from auth tables */
859 if (pUser->auth.identidx != -1)
861 Trie *pTrie = GetMethodByIndex(pUser->auth.index);
864 sm_trie_delete(pTrie, m_pStrings->GetString(pUser->auth.identidx));
868 /* Clear table counts */
869 pUser->grp_count = 0;
871 /* Link into free list */
872 pUser->magic = USR_MAGIC_UNSET;
873 pUser->next_user = m_FreeUserList;
876 /* Unset serial change */
877 pUser->serialchange = 0;
883 void AdminCache::InvalidateGroup(GroupId id)
885 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
888 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
893 const char *str = m_pStrings->GetString(pGroup->nameidx);
894 sm_trie_delete(m_pGroups, str);
896 /* Unlink from the live dbllink list */
897 if (id == m_FirstGroup && id == m_LastGroup)
899 m_LastGroup = INVALID_GROUP_ID;
900 m_FirstGroup = INVALID_GROUP_ID;
901 } else if (id == m_FirstGroup) {
902 m_FirstGroup = pGroup->next_grp;
903 pOther = (AdminGroup *)m_pMemory->GetAddress(m_FirstGroup);
904 pOther->prev_grp = INVALID_GROUP_ID;
905 } else if (id == m_LastGroup) {
906 m_LastGroup = pGroup->prev_grp;
907 pOther = (AdminGroup *)m_pMemory->GetAddress(m_LastGroup);
908 pOther->next_grp = INVALID_GROUP_ID;
910 pOther = (AdminGroup *)m_pMemory->GetAddress(pGroup->prev_grp);
911 pOther->next_grp = pGroup->next_grp;
912 pOther = (AdminGroup *)m_pMemory->GetAddress(pGroup->next_grp);
913 pOther->prev_grp = pGroup->prev_grp;
916 /* Free any used memory to be safe */
917 if (pGroup->pCmdGrpTable)
919 sm_trie_destroy(pGroup->pCmdGrpTable);
920 pGroup->pCmdGrpTable = NULL;
922 if (pGroup->pCmdTable)
924 sm_trie_destroy(pGroup->pCmdTable);
925 pGroup->pCmdTable = NULL;
928 /* Link into the free list */
929 pGroup->magic = GRP_MAGIC_UNSET;
930 pGroup->next_grp = m_FreeGroupList;
931 m_FreeGroupList = id;
933 int idx = m_FirstUser;
936 while (idx != INVALID_ADMIN_ID)
938 pUser = (AdminUser *)m_pMemory->GetAddress(idx);
939 if (pUser->grp_count > 0)
941 table = (int *)m_pMemory->GetAddress(pUser->grp_table);
942 for (unsigned int i=0; i<pUser->grp_count; i++)
946 /* We have to remove this entry */
947 for (unsigned int j=i+1; j<pUser->grp_count; j++)
949 /* Move everything down by one */
950 table[j-1] = table[j];
954 /* Recalculate effective flags */
955 pUser->eflags = pUser->flags;
956 for (unsigned int j=0; j<pUser->grp_count; j++)
958 pOther = (AdminGroup *)m_pMemory->GetAddress(table[j]);
959 pUser->eflags |= pOther->addflags;
961 /* Mark as changed */
962 pUser->serialchange++;
963 /* Break now, duplicates aren't allowed */
968 idx = pUser->next_user;
972 void AdminCache::InvalidateGroupCache()
974 /* Nuke the free list */
975 m_FreeGroupList = -1;
977 /* Nuke reverse lookups */
978 sm_trie_clear(m_pGroups);
980 /* Free memory on groups */
981 GroupId cur = m_FirstGroup;
983 while (cur != INVALID_GROUP_ID)
985 pGroup = (AdminGroup *)m_pMemory->GetAddress(cur);
986 assert(pGroup->magic == GRP_MAGIC_SET);
987 if (pGroup->pCmdGrpTable)
989 sm_trie_destroy(pGroup->pCmdGrpTable);
991 if (pGroup->pCmdTable)
993 sm_trie_destroy(pGroup->pCmdTable);
995 cur = pGroup->next_grp;
998 m_FirstGroup = INVALID_GROUP_ID;
999 m_LastGroup = INVALID_GROUP_ID;
1001 InvalidateAdminCache(false);
1003 /* Reset the memory table */
1007 void AdminCache::AddAdminListener(IAdminListener *pListener)
1009 m_hooks.push_back(pListener);
1012 void AdminCache::RemoveAdminListener(IAdminListener *pListener)
1014 m_hooks.remove(pListener);
1017 void AdminCache::RegisterAuthIdentType(const char *name)
1019 if (sm_trie_retrieve(m_pAuthTables, name, NULL))
1024 Trie *pAuth = sm_trie_create();
1027 method.name.assign(name);
1028 method.table = pAuth;
1030 m_AuthMethods.push_back(method);
1032 sm_trie_insert(m_pAuthTables, name, pAuth);
1035 void AdminCache::InvalidateAdminCache(bool unlink_admins)
1037 m_InvalidatingAdmins = true;
1040 g_Players.ClearAllAdmins();
1042 /* Wipe the identity cache first */
1043 List<AuthMethod>::iterator iter;
1044 for (iter=m_AuthMethods.begin();
1045 iter!=m_AuthMethods.end();
1048 sm_trie_clear((*iter).table);
1053 while (m_FirstUser != INVALID_ADMIN_ID)
1055 InvalidateAdmin(m_FirstUser);
1060 m_FreeUserList = -1;
1062 m_InvalidatingAdmins = false;
1065 void AdminCache::DumpAdminCache(AdminCachePart part, bool rebuild)
1067 List<IAdminListener *>::iterator iter;
1068 IAdminListener *pListener;
1071 if (part == AdminCache_Overrides)
1073 DumpCommandOverrideCache(Override_Command);
1074 DumpCommandOverrideCache(Override_CommandGroup);
1075 if (rebuild && !m_destroying)
1077 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
1079 pListener = (*iter);
1080 pListener->OnRebuildOverrideCache();
1082 m_pCacheFwd->PushCell(part);
1083 m_pCacheFwd->Execute(&result);
1085 } else if (part == AdminCache_Groups || part == AdminCache_Admins) {
1086 if (part == AdminCache_Groups)
1088 InvalidateGroupCache();
1089 if (rebuild && !m_destroying)
1091 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
1093 pListener = (*iter);
1094 pListener->OnRebuildGroupCache();
1096 m_pCacheFwd->PushCell(part);
1097 m_pCacheFwd->Execute(&result);
1100 InvalidateAdminCache(true);
1101 if (rebuild && !m_destroying)
1103 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
1105 pListener = (*iter);
1106 pListener->OnRebuildAdminCache((part == AdminCache_Groups));
1108 m_pCacheFwd->PushCell(AdminCache_Admins);
1109 m_pCacheFwd->Execute(&result);
1110 g_Players.RecheckAnyAdmins();
1115 const char *AdminCache::GetAdminName(AdminId id)
1117 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1118 if (!pUser || pUser->magic != USR_MAGIC_SET)
1123 return m_pStrings->GetString(pUser->nameidx);
1126 bool AdminCache::GetMethodIndex(const char *name, unsigned int *_index)
1128 List<AuthMethod>::iterator iter;
1129 unsigned int index = 0;
1130 for (iter=m_AuthMethods.begin();
1131 iter!=m_AuthMethods.end();
1134 if ((*iter).name.compare(name) == 0)
1144 bool AdminCache::BindAdminIdentity(AdminId id, const char *auth, const char *ident)
1146 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1147 if (!pUser || pUser->magic != USR_MAGIC_SET)
1153 if (!sm_trie_retrieve(m_pAuthTables, auth, (void **)&pTable))
1158 if (sm_trie_retrieve(pTable, ident, NULL))
1163 int i_ident = m_pStrings->AddString(ident);
1165 pUser = (AdminUser *)m_pMemory->GetAddress(id);
1166 pUser->auth.identidx = i_ident;
1167 GetMethodIndex(auth, &pUser->auth.index);
1169 return sm_trie_insert(pTable, ident, (void **)id);
1172 AdminId AdminCache::FindAdminByIdentity(const char *auth, const char *identity)
1175 if (!sm_trie_retrieve(m_pAuthTables, auth, (void **)&pTable))
1177 return INVALID_ADMIN_ID;
1181 if (!sm_trie_retrieve(pTable, identity, &object))
1183 return INVALID_ADMIN_ID;
1186 return (AdminId)object;
1189 void AdminCache::SetAdminFlag(AdminId id, AdminFlag flag, bool enabled)
1191 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1192 if (!pUser || pUser->magic != USR_MAGIC_SET)
1197 if (flag < Admin_Reservation
1198 || flag >= AdminFlags_TOTAL)
1203 FlagBits bits = (1<<(FlagBits)flag);
1207 pUser->flags |= bits;
1208 pUser->eflags |= bits;
1210 pUser->flags &= ~bits;
1211 pUser->eflags &= ~bits;
1214 pUser->serialchange++;
1217 bool AdminCache::GetAdminFlag(AdminId id, AdminFlag flag, AccessMode mode)
1219 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1220 if (!pUser || pUser->magic != USR_MAGIC_SET)
1225 if (flag < Admin_Reservation
1226 || flag >= AdminFlags_TOTAL)
1231 FlagBits bit = (1<<(FlagBits)flag);
1233 if (mode == Access_Real)
1235 return ((pUser->flags & bit) == bit);
1236 } else if (mode == Access_Effective) {
1237 bool has_bit = ((pUser->eflags & bit) == bit);
1238 if (!has_bit && flag != Admin_Root && ((pUser->eflags & ADMFLAG_ROOT) == ADMFLAG_ROOT))
1248 FlagBits AdminCache::GetAdminFlags(AdminId id, AccessMode mode)
1250 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1251 if (!pUser || pUser->magic != USR_MAGIC_SET)
1256 if (mode == Access_Real)
1258 return pUser->flags;
1259 } else if (mode == Access_Effective) {
1260 return pUser->eflags;
1266 void AdminCache::SetAdminFlags(AdminId id, AccessMode mode, FlagBits bits)
1268 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1269 if (!pUser || pUser->magic != USR_MAGIC_SET)
1274 if (mode == Access_Real)
1276 pUser->flags = bits;
1277 pUser->eflags = bits;
1278 } else if (mode == Access_Effective) {
1279 pUser->eflags = bits;
1282 pUser->serialchange++;
1285 bool AdminCache::AdminInheritGroup(AdminId id, GroupId gid)
1287 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1288 if (!pUser || pUser->magic != USR_MAGIC_SET)
1293 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(gid);
1294 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
1299 /* First check for duplicates */
1300 if (pUser->grp_count != 0)
1302 int *temp_table = (int *)m_pMemory->GetAddress(pUser->grp_table);
1303 for (unsigned int i=0; i<pUser->grp_count; i++)
1305 if (temp_table[i] == gid)
1313 if (pUser->grp_count + 1 > pUser->grp_size)
1318 if (pUser->grp_size == 0)
1322 new_size = pUser->grp_size * 2;
1325 /* Create and refresh pointers */
1326 tblidx = m_pMemory->CreateMem(new_size * sizeof(int), (void **)&table);
1327 pUser = (AdminUser *)m_pMemory->GetAddress(id);
1328 pGroup = (AdminGroup *)m_pMemory->GetAddress(gid);
1330 /* Copy old data if necessary */
1331 if (pUser->grp_table != -1)
1333 int *old_table = (int *)m_pMemory->GetAddress(pUser->grp_table);
1334 memcpy(table, old_table, sizeof(int) * pUser->grp_count);
1336 pUser->grp_table = tblidx;
1337 pUser->grp_size = new_size;
1339 table = (int *)m_pMemory->GetAddress(pUser->grp_table);
1342 table[pUser->grp_count] = gid;
1345 /* Compute new effective permissions */
1346 pUser->eflags |= pGroup->addflags;
1348 if (pGroup->immunity_level > pUser->immunity_level)
1350 pUser->immunity_level = pGroup->immunity_level;
1353 pUser->serialchange++;
1358 bool AdminCache::IsValidAdmin(AdminId id)
1360 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1361 return (pUser != NULL && pUser->magic == USR_MAGIC_SET);
1364 unsigned int AdminCache::GetAdminGroupCount(AdminId id)
1366 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1367 if (!pUser || pUser->magic != USR_MAGIC_SET)
1372 return pUser->grp_count;
1375 GroupId AdminCache::GetAdminGroup(AdminId id, unsigned int index, const char **name)
1377 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1378 if (!pUser || pUser->magic != USR_MAGIC_SET || index >= pUser->grp_count)
1380 return INVALID_GROUP_ID;
1383 int *table = (int *)m_pMemory->GetAddress(pUser->grp_table);
1385 GroupId gid = table[index];
1389 *name = GetGroupName(gid);
1395 const char *AdminCache::GetAdminPassword(AdminId id)
1397 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1398 if (!pUser || pUser->magic != USR_MAGIC_SET)
1403 return m_pStrings->GetString(pUser->password);
1406 void AdminCache::SetAdminPassword(AdminId id, const char *password)
1408 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1409 if (!pUser || pUser->magic != USR_MAGIC_SET)
1414 int i_password = m_pStrings->AddString(password);
1415 pUser = (AdminUser *)m_pMemory->GetAddress(id);
1416 pUser->password = i_password;
1419 unsigned int AdminCache::FlagBitsToBitArray(FlagBits bits, bool array[], unsigned int maxSize)
1422 for (i=0; i<maxSize && i<AdminFlags_TOTAL; i++)
1424 array[i] = ((bits & (1<<i)) == (unsigned)(1<<i));
1430 FlagBits AdminCache::FlagBitArrayToBits(const bool array[], unsigned int maxSize)
1433 for (unsigned int i=0; i<maxSize && i<AdminFlags_TOTAL; i++)
1444 FlagBits AdminCache::FlagArrayToBits(const AdminFlag array[], unsigned int numFlags)
1447 for (unsigned int i=0; i<numFlags && i<AdminFlags_TOTAL; i++)
1449 bits |= (1 << (FlagBits)array[i]);
1455 unsigned int AdminCache::FlagBitsToArray(FlagBits bits, AdminFlag array[], unsigned int maxSize)
1457 unsigned int i, num=0;
1458 for (i=0; num<maxSize && i<AdminFlags_TOTAL; i++)
1460 if ((bits & (1<<i)) == (unsigned)(1<<i))
1462 array[num++] = (AdminFlag)i;
1469 bool AdminCache::CheckAdminFlags(AdminId id, FlagBits bits)
1471 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1472 if (!pUser || pUser->magic != USR_MAGIC_SET)
1477 return ((pUser->eflags & bits) == bits);
1480 bool AdminCache::CanAdminTarget(AdminId id, AdminId target)
1483 * Zeroth, if the targeting AdminId is INVALID_ADMIN_ID, targeting fails.
1484 * First, if the targeted AdminId is INVALID_ADMIN_ID, targeting succeeds.
1487 if (id == INVALID_ADMIN_ID)
1492 if (target == INVALID_ADMIN_ID)
1502 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1503 if (!pUser || pUser->magic != USR_MAGIC_SET)
1508 AdminUser *pTarget = (AdminUser *)m_pMemory->GetAddress(target);
1509 if (!pTarget || pTarget->magic != USR_MAGIC_SET)
1515 * Second, if the targeting admin is root, targeting succeeds.
1517 if (pUser->eflags & ADMFLAG_ROOT)
1522 /** Fourth, if the targeted admin is immune from targeting admin. */
1523 int mode = sm_immunity_mode.GetInt();
1528 if (pTarget->immunity_level > pUser->immunity_level)
1536 /* If neither has any immunity, let this pass. */
1537 if (!pUser->immunity_level && !pTarget->immunity_level)
1541 /* Don't break, go to the next case. */
1545 if (pTarget->immunity_level >= pUser->immunity_level)
1554 * Fifth, if the targeted admin has specific immunity from the
1555 * targeting admin via group immunities, targeting fails.
1557 //:TODO: speed this up... maybe with trie hacks.
1558 //idea is to insert %d.%d in the trie after computing this and use it as a cache lookup.
1559 //problem is the trie cannot delete prefixes, so we'd have a problem with invalidations.
1560 if (pTarget->grp_count > 0 && pUser->grp_count > 0)
1562 int *grp_table = (int *)m_pMemory->GetAddress(pTarget->grp_table);
1563 int *src_table = (int *)m_pMemory->GetAddress(pUser->grp_table);
1566 for (unsigned int i=0; i<pTarget->grp_count; i++)
1569 num = GetGroupImmunityCount(id);
1570 for (unsigned int j=0; j<num; i++)
1572 other = GetGroupImmunity(id, j);
1573 for (unsigned int k=0; k<pUser->grp_count; k++)
1575 if (other == src_table[k])
1587 bool AdminCache::FindFlag(char c, AdminFlag *pAdmFlag)
1589 if (c < 'a' || c > 'z')
1596 *pAdmFlag = g_FlagLetters[(unsigned)c - (unsigned)'a'];
1602 FlagBits AdminCache::ReadFlagString(const char *flags, const char **end)
1606 while (flags && (*flags != '\0'))
1609 if (!FindFlag(*flags, &flag))
1613 bits |= FlagArrayToBits(&flag, 1);
1625 unsigned int AdminCache::GetAdminSerialChange(AdminId id)
1627 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1628 if (!pUser || pUser->magic != USR_MAGIC_SET)
1633 return pUser->serialchange;
1636 bool AdminCache::CanAdminUseCommand(int client, const char *cmd)
1639 OverrideType otype = Override_Command;
1643 otype = Override_CommandGroup;
1647 if (!g_ConCmds.LookForCommandAdminFlags(cmd, &bits))
1649 if (!GetCommandOverride(cmd, otype, &bits))
1655 return g_ConCmds.CheckCommandAccess(client, cmd, bits);
1658 unsigned int AdminCache::SetGroupImmunityLevel(GroupId gid, unsigned int level)
1660 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(gid);
1661 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
1666 unsigned int old_level = pGroup->immunity_level;
1668 pGroup->immunity_level = level;
1673 unsigned int AdminCache::GetGroupImmunityLevel(GroupId gid)
1675 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(gid);
1676 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
1681 return pGroup->immunity_level;
1684 unsigned int AdminCache::SetAdminImmunityLevel(AdminId id, unsigned int level)
1686 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1687 if (!pUser || pUser->magic != USR_MAGIC_SET)
1692 unsigned int old_level = pUser->immunity_level;
1694 pUser->immunity_level = level;
1699 unsigned int AdminCache::GetAdminImmunityLevel(AdminId id)
1701 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1702 if (!pUser || pUser->magic != USR_MAGIC_SET)
1707 return pUser->immunity_level;