3 * =============================================================================
5 * Copyright (C) 2004-2008 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, "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++)
88 m_bFileNameLogged = false;
89 g_SourceMod.BuildPath(Path_SM, m_File, sizeof(m_File), "configs/admin_levels.cfg");
91 if ((error = textparsers->ParseFile_SMC(m_File, this, &states))
94 const char *err_string = textparsers->GetSMCErrorString(error);
97 err_string = "Unknown error";
99 ParseError(NULL, "Error %d (%s)", error, err_string);
105 void ReadSMC_ParseStart()
107 m_LevelState = LEVEL_STATE_NONE;
109 memset(g_FlagSet, 0, sizeof(g_FlagSet));
111 SMCResult ReadSMC_NewSection(const SMCStates *states, const char *name)
116 return SMCResult_Continue;
119 if (m_LevelState == LEVEL_STATE_NONE)
121 if (strcmp(name, "Levels") == 0)
123 m_LevelState = LEVEL_STATE_LEVELS;
129 } else if (m_LevelState == LEVEL_STATE_LEVELS) {
130 if (strcmp(name, "Flags") == 0)
132 m_LevelState = LEVEL_STATE_FLAGS;
144 return SMCResult_Continue;
146 SMCResult ReadSMC_KeyValue(const SMCStates *states, const char *key, const char *value)
148 if (m_LevelState != LEVEL_STATE_FLAGS || m_IgnoreLevel)
150 return SMCResult_Continue;
153 unsigned char c = (unsigned)value[0];
155 if (c < (unsigned)'a' || c > (unsigned)'z')
157 ParseError(states, "Flag \"%c\" is not a lower-case ASCII letter", c);
158 return SMCResult_Continue;
163 assert(c >= 0 && c < 26);
165 if (!g_Admins.FindFlag(key, &g_FlagLetters[c]))
167 ParseError(states, "Unrecognized admin level \"%s\"", key);
168 return SMCResult_Continue;
173 return SMCResult_Continue;
175 SMCResult ReadSMC_LeavingSection(const SMCStates *states)
180 return SMCResult_Continue;
183 if (m_LevelState == LEVEL_STATE_FLAGS)
185 m_LevelState = LEVEL_STATE_LEVELS;
186 return SMCResult_Halt;
188 else if (m_LevelState == LEVEL_STATE_LEVELS)
190 m_LevelState = LEVEL_STATE_NONE;
193 return SMCResult_Continue;
195 void ParseError(const SMCStates *states, const char *message, ...)
200 va_start(ap, message);
201 UTIL_FormatArgs(buffer, sizeof(buffer), message, ap);
204 if (!m_bFileNameLogged)
206 g_Logger.LogError("[SM] Parse error(s) detected in file \"%s\":", m_File);
207 m_bFileNameLogged = true;
210 g_Logger.LogError("[SM] (Line %d): %s", states ? states->line : 0, buffer);
213 bool m_bFileNameLogged;
214 char m_File[PLATFORM_MAX_PATH];
219 AdminCache::AdminCache()
221 m_pCmdOverrides = sm_trie_create();
222 m_pCmdGrpOverrides = sm_trie_create();
223 m_pStrings = new BaseStringTable(1024);
224 m_pMemory = m_pStrings->GetMemTable();
225 m_FreeGroupList = m_FirstGroup = m_LastGroup = INVALID_GROUP_ID;
226 m_FreeUserList = m_FirstUser = m_LastUser = INVALID_ADMIN_ID;
227 m_pGroups = sm_trie_create();
230 m_pAuthTables = sm_trie_create();
231 m_InvalidatingAdmins = false;
232 m_destroying = false;
233 m_pLevelNames = sm_trie_create();
236 AdminCache::~AdminCache()
239 DumpAdminCache(AdminCache_Overrides, false);
240 DumpAdminCache(AdminCache_Groups, false);
242 sm_trie_destroy(m_pCmdGrpOverrides);
243 sm_trie_destroy(m_pCmdOverrides);
247 sm_trie_destroy(m_pGroups);
250 List<AuthMethod>::iterator iter;
251 for (iter=m_AuthMethods.begin();
252 iter!=m_AuthMethods.end();
255 sm_trie_destroy((*iter).table);
258 sm_trie_destroy(m_pAuthTables);
262 sm_trie_destroy(m_pLevelNames);
265 void AdminCache::OnSourceModStartup(bool late)
267 RegisterAuthIdentType("steam");
268 RegisterAuthIdentType("name");
269 RegisterAuthIdentType("ip");
271 NameFlag("reservation", Admin_Reservation);
272 NameFlag("kick", Admin_Kick);
273 NameFlag("generic", Admin_Generic);
274 NameFlag("ban", Admin_Ban);
275 NameFlag("unban", Admin_Unban);
276 NameFlag("slay", Admin_Slay);
277 NameFlag("changemap", Admin_Changemap);
278 NameFlag("cvars", Admin_Convars);
279 NameFlag("config", Admin_Config);
280 NameFlag("chat", Admin_Chat);
281 NameFlag("vote", Admin_Vote);
282 NameFlag("password", Admin_Password);
283 NameFlag("rcon", Admin_RCON);
284 NameFlag("cheats", Admin_Cheats);
285 NameFlag("root", Admin_Root);
286 NameFlag("custom1", Admin_Custom1);
287 NameFlag("custom2", Admin_Custom2);
288 NameFlag("custom3", Admin_Custom3);
289 NameFlag("custom4", Admin_Custom4);
290 NameFlag("custom5", Admin_Custom5);
291 NameFlag("custom6", Admin_Custom6);
294 void AdminCache::OnSourceModAllInitialized()
296 m_pCacheFwd = g_Forwards.CreateForward("OnRebuildAdminCache", ET_Ignore, 1, NULL, Param_Cell);
297 g_ShareSys.AddInterface(NULL, this);
300 void AdminCache::OnSourceModLevelChange(const char *mapName)
302 /* For now, we only read these once per level. */
303 s_FlagReader.LoadLevels();
306 void AdminCache::OnSourceModShutdown()
308 g_Forwards.ReleaseForward(m_pCacheFwd);
312 void AdminCache::OnSourceModPluginsLoaded()
314 DumpAdminCache(AdminCache_Overrides, true);
315 DumpAdminCache(AdminCache_Groups, true);
318 void AdminCache::NameFlag(const char *str, AdminFlag flag)
320 sm_trie_insert(m_pLevelNames, str, (void *)flag);
323 bool AdminCache::FindFlag(const char *str, AdminFlag *pFlag)
326 if (!sm_trie_retrieve(m_pLevelNames, str, &obj))
333 *pFlag = (AdminFlag)(int)obj;
339 void AdminCache::AddCommandOverride(const char *cmd, OverrideType type, FlagBits flags)
342 if (type == Override_Command)
344 pTrie = m_pCmdOverrides;
345 } else if (type == Override_CommandGroup) {
346 pTrie = m_pCmdGrpOverrides;
351 sm_trie_insert(pTrie, cmd, (void *)(unsigned int)flags);
353 g_ConCmds.UpdateAdminCmdFlags(cmd, type, flags, false);
356 bool AdminCache::GetCommandOverride(const char *cmd, OverrideType type, FlagBits *pFlags)
360 if (type == Override_Command)
362 pTrie = m_pCmdOverrides;
363 } else if (type == Override_CommandGroup) {
364 pTrie = m_pCmdGrpOverrides;
370 if (sm_trie_retrieve(pTrie, cmd, &object))
374 *pFlags = (FlagBits)object;
382 void AdminCache::UnsetCommandOverride(const char *cmd, OverrideType type)
384 if (type == Override_Command)
386 return _UnsetCommandOverride(cmd);
387 } else if (type == Override_CommandGroup) {
388 return _UnsetCommandGroupOverride(cmd);
392 void AdminCache::_UnsetCommandGroupOverride(const char *group)
394 if (!m_pCmdGrpOverrides)
399 sm_trie_delete(m_pCmdGrpOverrides, group);
401 g_ConCmds.UpdateAdminCmdFlags(group, Override_CommandGroup, 0, true);
404 void AdminCache::_UnsetCommandOverride(const char *cmd)
406 if (!m_pCmdOverrides)
411 sm_trie_delete(m_pCmdOverrides, cmd);
413 g_ConCmds.UpdateAdminCmdFlags(cmd, Override_Command, 0, true);
416 void AdminCache::DumpCommandOverrideCache(OverrideType type)
418 if (type == Override_Command && m_pCmdOverrides)
420 sm_trie_clear(m_pCmdOverrides);
421 } else if (type == Override_CommandGroup && m_pCmdGrpOverrides) {
422 sm_trie_clear(m_pCmdGrpOverrides);
426 AdminId AdminCache::CreateAdmin(const char *name)
431 if (m_FreeUserList != INVALID_ADMIN_ID)
433 pUser = (AdminUser *)m_pMemory->GetAddress(m_FreeUserList);
434 assert(pUser->magic == USR_MAGIC_UNSET);
436 m_FreeUserList = pUser->next_user;
438 id = m_pMemory->CreateMem(sizeof(AdminUser), (void **)&pUser);
440 pUser->grp_table = -1;
445 pUser->grp_count = 0;
446 pUser->password = -1;
447 pUser->magic = USR_MAGIC_SET;
448 pUser->auth.identidx = -1;
449 pUser->auth.index = 0;
450 pUser->immunity_level = 0;
451 pUser->serialchange = 1;
453 if (m_FirstUser == INVALID_ADMIN_ID)
458 AdminUser *pPrev = (AdminUser *)m_pMemory->GetAddress(m_LastUser);
459 pPrev->next_user = id;
460 pUser->prev_user = m_LastUser;
464 if (name && name[0] != '\0')
466 int nameidx = m_pStrings->AddString(name);
467 pUser = (AdminUser *)m_pMemory->GetAddress(id);
468 pUser->nameidx = nameidx;
474 GroupId AdminCache::AddGroup(const char *group_name)
476 if (sm_trie_retrieve(m_pGroups, group_name, NULL))
478 return INVALID_GROUP_ID;
483 if (m_FreeGroupList != INVALID_GROUP_ID)
485 pGroup = (AdminGroup *)m_pMemory->GetAddress(m_FreeGroupList);
486 assert(pGroup->magic == GRP_MAGIC_UNSET);
487 id = m_FreeGroupList;
488 m_FreeGroupList = pGroup->next_grp;
490 id = m_pMemory->CreateMem(sizeof(AdminGroup), (void **)&pGroup);
493 pGroup->immunity_level = 0;
494 pGroup->immune_table = -1;
495 pGroup->magic = GRP_MAGIC_SET;
496 pGroup->next_grp = INVALID_GROUP_ID;
497 pGroup->pCmdGrpTable = NULL;
498 pGroup->pCmdTable = NULL;
499 pGroup->addflags = 0;
501 if (m_FirstGroup == INVALID_GROUP_ID)
505 pGroup->prev_grp = INVALID_GROUP_ID;
507 AdminGroup *pPrev = (AdminGroup *)m_pMemory->GetAddress(m_LastGroup);
508 assert(pPrev->magic == GRP_MAGIC_SET);
509 pPrev->next_grp = id;
510 pGroup->prev_grp = m_LastGroup;
514 int nameidx = m_pStrings->AddString(group_name);
515 pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
516 pGroup->nameidx = nameidx;
518 sm_trie_insert(m_pGroups, group_name, (void *)id);
523 GroupId AdminCache::FindGroupByName(const char *group_name)
527 if (!sm_trie_retrieve(m_pGroups, group_name, &object))
529 return INVALID_GROUP_ID;
532 GroupId id = (GroupId)object;
533 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
535 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
537 return INVALID_GROUP_ID;
543 void AdminCache::SetGroupAddFlag(GroupId id, AdminFlag flag, bool enabled)
545 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
546 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
551 if (flag < Admin_Reservation || flag >= AdminFlags_TOTAL)
556 FlagBits bits = (1<<(FlagBits)flag);
560 pGroup->addflags |= bits;
562 pGroup->addflags &= ~bits;
566 bool AdminCache::GetGroupAddFlag(GroupId id, AdminFlag flag)
568 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
569 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
574 if (flag < Admin_Reservation || flag >= AdminFlags_TOTAL)
579 FlagBits bit = 1<<(FlagBits)flag;
580 return ((pGroup->addflags & bit) == bit);
583 FlagBits AdminCache::GetGroupAddFlags(GroupId id)
585 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
586 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
591 return pGroup->addflags;
594 const char *AdminCache::GetGroupName(GroupId gid)
596 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(gid);
597 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
602 return m_pStrings->GetString(pGroup->nameidx);
605 void AdminCache::SetGroupGenericImmunity(GroupId id, ImmunityType type, bool enabled)
607 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
608 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
613 unsigned int level = 0;
617 if (type == Immunity_Default)
620 } else if (type == Immunity_Global) {
623 if (level > pGroup->immunity_level)
625 pGroup->immunity_level = level;
628 pGroup->immunity_level = 0;
632 bool AdminCache::GetGroupGenericImmunity(GroupId id, ImmunityType type)
634 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
635 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
640 if (type == Immunity_Default && pGroup->immunity_level >= 1)
643 } else if (type == Immunity_Global && pGroup->immunity_level >= 2) {
650 void AdminCache::AddGroupImmunity(GroupId id, GroupId other_id)
652 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(other_id);
653 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
658 pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
659 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
664 /* We always need to resize the immunity table */
666 if (pGroup->immune_table == -1)
668 tblidx = m_pMemory->CreateMem(sizeof(int) * 2, (void **)&table);
669 pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
672 int *old_table = (int *)m_pMemory->GetAddress(pGroup->immune_table);
673 /* Break out if this group is already in the list */
674 for (int i=0; i<old_table[0]; i++)
676 if (old_table[1+i] == other_id)
681 tblidx = m_pMemory->CreateMem(sizeof(int) * (old_table[0] + 2), (void **)&table);
682 /* Get the old address again in case of resize */
683 pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
684 old_table = (int *)m_pMemory->GetAddress(pGroup->immune_table);
685 table[0] = old_table[0];
686 for (unsigned int i=1; i<=(unsigned int)old_table[0]; i++)
688 table[i] = old_table[i];
693 pGroup->immune_table = tblidx;
695 /* Add to the array */
697 table[table[0]] = other_id;
700 unsigned int AdminCache::GetGroupImmunityCount(GroupId id)
702 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
703 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
708 if (pGroup->immune_table == -1)
713 int *table = (int *)m_pMemory->GetAddress(pGroup->immune_table);
718 GroupId AdminCache::GetGroupImmunity(GroupId id, unsigned int number)
720 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
721 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
723 return INVALID_GROUP_ID;
726 if (pGroup->immune_table == -1)
728 return INVALID_GROUP_ID;
731 int *table = (int *)m_pMemory->GetAddress(pGroup->immune_table);
732 if (number >= (unsigned int)table[0])
734 return INVALID_GROUP_ID;
737 return table[1 + number];
740 void AdminCache::AddGroupCommandOverride(GroupId id, const char *name, OverrideType type, OverrideRule rule)
742 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
743 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
749 if (type == Override_Command)
751 if (pGroup->pCmdTable == NULL)
753 pGroup->pCmdTable = sm_trie_create();
755 pTrie = pGroup->pCmdTable;
756 } else if (type == Override_CommandGroup) {
757 if (pGroup->pCmdGrpTable == NULL)
759 pGroup->pCmdGrpTable = sm_trie_create();
761 pTrie = pGroup->pCmdGrpTable;
766 sm_trie_insert(pTrie, name, (void *)(int)rule);
769 bool AdminCache::GetGroupCommandOverride(GroupId id, const char *name, OverrideType type, OverrideRule *pRule)
771 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
772 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
778 if (type == Override_Command)
780 if (pGroup->pCmdTable == NULL)
784 pTrie = pGroup->pCmdTable;
785 } else if (type == Override_CommandGroup) {
786 if (pGroup->pCmdGrpTable == NULL)
790 pTrie = pGroup->pCmdGrpTable;
796 if (!sm_trie_retrieve(pTrie, name, &object))
803 *pRule = (OverrideRule)(int)object;
809 Trie *AdminCache::GetMethodByIndex(unsigned int index)
811 List<AuthMethod>::iterator iter;
812 for (iter=m_AuthMethods.begin();
813 iter!=m_AuthMethods.end();
818 return (*iter).table;
825 bool AdminCache::InvalidateAdmin(AdminId id)
827 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
829 if (!pUser || pUser->magic != USR_MAGIC_SET)
834 if (!m_InvalidatingAdmins && !m_destroying)
836 g_Players.ClearAdminId(id);
839 /* Unlink from the dbl link list */
840 if (id == m_FirstUser && id == m_LastUser)
842 m_FirstUser = INVALID_ADMIN_ID;
843 m_LastUser = INVALID_ADMIN_ID;
844 } else if (id == m_FirstUser) {
845 m_FirstUser = pUser->next_user;
846 pOther = (AdminUser *)m_pMemory->GetAddress(m_FirstUser);
847 pOther->prev_user = INVALID_ADMIN_ID;
848 } else if (id == m_LastUser) {
849 m_LastUser = pUser->prev_user;
850 pOther = (AdminUser *)m_pMemory->GetAddress(m_LastUser);
851 pOther->next_user = INVALID_ADMIN_ID;
853 pOther = (AdminUser *)m_pMemory->GetAddress(pUser->prev_user);
854 pOther->next_user = pUser->next_user;
855 pOther = (AdminUser *)m_pMemory->GetAddress(pUser->next_user);
856 pOther->prev_user = pUser->prev_user;
859 /* Unlink from auth tables */
860 if (pUser->auth.identidx != -1)
862 Trie *pTrie = GetMethodByIndex(pUser->auth.index);
865 sm_trie_delete(pTrie, m_pStrings->GetString(pUser->auth.identidx));
869 /* Clear table counts */
870 pUser->grp_count = 0;
872 /* Link into free list */
873 pUser->magic = USR_MAGIC_UNSET;
874 pUser->next_user = m_FreeUserList;
877 /* Unset serial change */
878 pUser->serialchange = 0;
884 void AdminCache::InvalidateGroup(GroupId id)
886 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(id);
889 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
894 const char *str = m_pStrings->GetString(pGroup->nameidx);
895 sm_trie_delete(m_pGroups, str);
897 /* Unlink from the live dbllink list */
898 if (id == m_FirstGroup && id == m_LastGroup)
900 m_LastGroup = INVALID_GROUP_ID;
901 m_FirstGroup = INVALID_GROUP_ID;
902 } else if (id == m_FirstGroup) {
903 m_FirstGroup = pGroup->next_grp;
904 pOther = (AdminGroup *)m_pMemory->GetAddress(m_FirstGroup);
905 pOther->prev_grp = INVALID_GROUP_ID;
906 } else if (id == m_LastGroup) {
907 m_LastGroup = pGroup->prev_grp;
908 pOther = (AdminGroup *)m_pMemory->GetAddress(m_LastGroup);
909 pOther->next_grp = INVALID_GROUP_ID;
911 pOther = (AdminGroup *)m_pMemory->GetAddress(pGroup->prev_grp);
912 pOther->next_grp = pGroup->next_grp;
913 pOther = (AdminGroup *)m_pMemory->GetAddress(pGroup->next_grp);
914 pOther->prev_grp = pGroup->prev_grp;
917 /* Free any used memory to be safe */
918 if (pGroup->pCmdGrpTable)
920 sm_trie_destroy(pGroup->pCmdGrpTable);
921 pGroup->pCmdGrpTable = NULL;
923 if (pGroup->pCmdTable)
925 sm_trie_destroy(pGroup->pCmdTable);
926 pGroup->pCmdTable = NULL;
929 /* Link into the free list */
930 pGroup->magic = GRP_MAGIC_UNSET;
931 pGroup->next_grp = m_FreeGroupList;
932 m_FreeGroupList = id;
934 int idx = m_FirstUser;
937 while (idx != INVALID_ADMIN_ID)
939 pUser = (AdminUser *)m_pMemory->GetAddress(idx);
940 if (pUser->grp_count > 0)
942 table = (int *)m_pMemory->GetAddress(pUser->grp_table);
943 for (unsigned int i=0; i<pUser->grp_count; i++)
947 /* We have to remove this entry */
948 for (unsigned int j=i+1; j<pUser->grp_count; j++)
950 /* Move everything down by one */
951 table[j-1] = table[j];
955 /* Recalculate effective flags */
956 pUser->eflags = pUser->flags;
957 for (unsigned int j=0; j<pUser->grp_count; j++)
959 pOther = (AdminGroup *)m_pMemory->GetAddress(table[j]);
960 pUser->eflags |= pOther->addflags;
962 /* Mark as changed */
963 pUser->serialchange++;
964 /* Break now, duplicates aren't allowed */
969 idx = pUser->next_user;
973 void AdminCache::InvalidateGroupCache()
975 /* Nuke the free list */
976 m_FreeGroupList = -1;
978 /* Nuke reverse lookups */
979 sm_trie_clear(m_pGroups);
981 /* Free memory on groups */
982 GroupId cur = m_FirstGroup;
984 while (cur != INVALID_GROUP_ID)
986 pGroup = (AdminGroup *)m_pMemory->GetAddress(cur);
987 assert(pGroup->magic == GRP_MAGIC_SET);
988 if (pGroup->pCmdGrpTable)
990 sm_trie_destroy(pGroup->pCmdGrpTable);
992 if (pGroup->pCmdTable)
994 sm_trie_destroy(pGroup->pCmdTable);
996 cur = pGroup->next_grp;
999 m_FirstGroup = INVALID_GROUP_ID;
1000 m_LastGroup = INVALID_GROUP_ID;
1002 InvalidateAdminCache(false);
1004 /* Reset the memory table */
1008 void AdminCache::AddAdminListener(IAdminListener *pListener)
1010 m_hooks.push_back(pListener);
1013 void AdminCache::RemoveAdminListener(IAdminListener *pListener)
1015 m_hooks.remove(pListener);
1018 void AdminCache::RegisterAuthIdentType(const char *name)
1020 if (sm_trie_retrieve(m_pAuthTables, name, NULL))
1025 Trie *pAuth = sm_trie_create();
1028 method.name.assign(name);
1029 method.table = pAuth;
1031 m_AuthMethods.push_back(method);
1033 sm_trie_insert(m_pAuthTables, name, pAuth);
1036 void AdminCache::InvalidateAdminCache(bool unlink_admins)
1038 m_InvalidatingAdmins = true;
1041 g_Players.ClearAllAdmins();
1043 /* Wipe the identity cache first */
1044 List<AuthMethod>::iterator iter;
1045 for (iter=m_AuthMethods.begin();
1046 iter!=m_AuthMethods.end();
1049 sm_trie_clear((*iter).table);
1054 while (m_FirstUser != INVALID_ADMIN_ID)
1056 InvalidateAdmin(m_FirstUser);
1061 m_FreeUserList = -1;
1063 m_InvalidatingAdmins = false;
1066 void AdminCache::DumpAdminCache(AdminCachePart part, bool rebuild)
1068 List<IAdminListener *>::iterator iter;
1069 IAdminListener *pListener;
1072 if (part == AdminCache_Overrides)
1074 DumpCommandOverrideCache(Override_Command);
1075 DumpCommandOverrideCache(Override_CommandGroup);
1076 if (rebuild && !m_destroying)
1078 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
1080 pListener = (*iter);
1081 pListener->OnRebuildOverrideCache();
1083 m_pCacheFwd->PushCell(part);
1084 m_pCacheFwd->Execute(&result);
1086 } else if (part == AdminCache_Groups || part == AdminCache_Admins) {
1087 if (part == AdminCache_Groups)
1089 InvalidateGroupCache();
1090 if (rebuild && !m_destroying)
1092 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
1094 pListener = (*iter);
1095 pListener->OnRebuildGroupCache();
1097 m_pCacheFwd->PushCell(part);
1098 m_pCacheFwd->Execute(&result);
1101 InvalidateAdminCache(true);
1102 if (rebuild && !m_destroying)
1104 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
1106 pListener = (*iter);
1107 pListener->OnRebuildAdminCache((part == AdminCache_Groups));
1109 m_pCacheFwd->PushCell(AdminCache_Admins);
1110 m_pCacheFwd->Execute(&result);
1111 g_Players.RecheckAnyAdmins();
1116 const char *AdminCache::GetAdminName(AdminId id)
1118 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1119 if (!pUser || pUser->magic != USR_MAGIC_SET)
1124 return m_pStrings->GetString(pUser->nameidx);
1127 bool AdminCache::GetMethodIndex(const char *name, unsigned int *_index)
1129 List<AuthMethod>::iterator iter;
1130 unsigned int index = 0;
1131 for (iter=m_AuthMethods.begin();
1132 iter!=m_AuthMethods.end();
1135 if ((*iter).name.compare(name) == 0)
1145 bool AdminCache::BindAdminIdentity(AdminId id, const char *auth, const char *ident)
1147 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1148 if (!pUser || pUser->magic != USR_MAGIC_SET)
1154 if (!sm_trie_retrieve(m_pAuthTables, auth, (void **)&pTable))
1159 if (sm_trie_retrieve(pTable, ident, NULL))
1164 int i_ident = m_pStrings->AddString(ident);
1166 pUser = (AdminUser *)m_pMemory->GetAddress(id);
1167 pUser->auth.identidx = i_ident;
1168 GetMethodIndex(auth, &pUser->auth.index);
1170 return sm_trie_insert(pTable, ident, (void **)id);
1173 AdminId AdminCache::FindAdminByIdentity(const char *auth, const char *identity)
1176 if (!sm_trie_retrieve(m_pAuthTables, auth, (void **)&pTable))
1178 return INVALID_ADMIN_ID;
1182 if (!sm_trie_retrieve(pTable, identity, &object))
1184 return INVALID_ADMIN_ID;
1187 return (AdminId)object;
1190 void AdminCache::SetAdminFlag(AdminId id, AdminFlag flag, bool enabled)
1192 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1193 if (!pUser || pUser->magic != USR_MAGIC_SET)
1198 if (flag < Admin_Reservation
1199 || flag >= AdminFlags_TOTAL)
1204 FlagBits bits = (1<<(FlagBits)flag);
1208 pUser->flags |= bits;
1209 pUser->eflags |= bits;
1211 pUser->flags &= ~bits;
1212 pUser->eflags &= ~bits;
1215 pUser->serialchange++;
1218 bool AdminCache::GetAdminFlag(AdminId id, AdminFlag flag, AccessMode mode)
1220 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1221 if (!pUser || pUser->magic != USR_MAGIC_SET)
1226 if (flag < Admin_Reservation
1227 || flag >= AdminFlags_TOTAL)
1232 FlagBits bit = (1<<(FlagBits)flag);
1234 if (mode == Access_Real)
1236 return ((pUser->flags & bit) == bit);
1237 } else if (mode == Access_Effective) {
1238 bool has_bit = ((pUser->eflags & bit) == bit);
1239 if (!has_bit && flag != Admin_Root && ((pUser->eflags & ADMFLAG_ROOT) == ADMFLAG_ROOT))
1249 FlagBits AdminCache::GetAdminFlags(AdminId id, AccessMode mode)
1251 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1252 if (!pUser || pUser->magic != USR_MAGIC_SET)
1257 if (mode == Access_Real)
1259 return pUser->flags;
1260 } else if (mode == Access_Effective) {
1261 return pUser->eflags;
1267 void AdminCache::SetAdminFlags(AdminId id, AccessMode mode, FlagBits bits)
1269 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1270 if (!pUser || pUser->magic != USR_MAGIC_SET)
1275 if (mode == Access_Real)
1277 pUser->flags = bits;
1278 pUser->eflags = bits;
1279 } else if (mode == Access_Effective) {
1280 pUser->eflags = bits;
1283 pUser->serialchange++;
1286 bool AdminCache::AdminInheritGroup(AdminId id, GroupId gid)
1288 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1289 if (!pUser || pUser->magic != USR_MAGIC_SET)
1294 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(gid);
1295 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
1300 /* First check for duplicates */
1301 if (pUser->grp_count != 0)
1303 int *temp_table = (int *)m_pMemory->GetAddress(pUser->grp_table);
1304 for (unsigned int i=0; i<pUser->grp_count; i++)
1306 if (temp_table[i] == gid)
1314 if (pUser->grp_count + 1 > pUser->grp_size)
1319 if (pUser->grp_size == 0)
1323 new_size = pUser->grp_size * 2;
1326 /* Create and refresh pointers */
1327 tblidx = m_pMemory->CreateMem(new_size * sizeof(int), (void **)&table);
1328 pUser = (AdminUser *)m_pMemory->GetAddress(id);
1329 pGroup = (AdminGroup *)m_pMemory->GetAddress(gid);
1331 /* Copy old data if necessary */
1332 if (pUser->grp_table != -1)
1334 int *old_table = (int *)m_pMemory->GetAddress(pUser->grp_table);
1335 memcpy(table, old_table, sizeof(int) * pUser->grp_count);
1337 pUser->grp_table = tblidx;
1338 pUser->grp_size = new_size;
1340 table = (int *)m_pMemory->GetAddress(pUser->grp_table);
1343 table[pUser->grp_count] = gid;
1346 /* Compute new effective permissions */
1347 pUser->eflags |= pGroup->addflags;
1349 if (pGroup->immunity_level > pUser->immunity_level)
1351 pUser->immunity_level = pGroup->immunity_level;
1354 pUser->serialchange++;
1359 bool AdminCache::IsValidAdmin(AdminId id)
1361 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1362 return (pUser != NULL && pUser->magic == USR_MAGIC_SET);
1365 unsigned int AdminCache::GetAdminGroupCount(AdminId id)
1367 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1368 if (!pUser || pUser->magic != USR_MAGIC_SET)
1373 return pUser->grp_count;
1376 GroupId AdminCache::GetAdminGroup(AdminId id, unsigned int index, const char **name)
1378 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1379 if (!pUser || pUser->magic != USR_MAGIC_SET || index >= pUser->grp_count)
1381 return INVALID_GROUP_ID;
1384 int *table = (int *)m_pMemory->GetAddress(pUser->grp_table);
1386 GroupId gid = table[index];
1390 *name = GetGroupName(gid);
1396 const char *AdminCache::GetAdminPassword(AdminId id)
1398 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1399 if (!pUser || pUser->magic != USR_MAGIC_SET)
1404 return m_pStrings->GetString(pUser->password);
1407 void AdminCache::SetAdminPassword(AdminId id, const char *password)
1409 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1410 if (!pUser || pUser->magic != USR_MAGIC_SET)
1415 int i_password = m_pStrings->AddString(password);
1416 pUser = (AdminUser *)m_pMemory->GetAddress(id);
1417 pUser->password = i_password;
1420 unsigned int AdminCache::FlagBitsToBitArray(FlagBits bits, bool array[], unsigned int maxSize)
1423 for (i=0; i<maxSize && i<AdminFlags_TOTAL; i++)
1425 array[i] = ((bits & (1<<i)) == (unsigned)(1<<i));
1431 FlagBits AdminCache::FlagBitArrayToBits(const bool array[], unsigned int maxSize)
1434 for (unsigned int i=0; i<maxSize && i<AdminFlags_TOTAL; i++)
1445 FlagBits AdminCache::FlagArrayToBits(const AdminFlag array[], unsigned int numFlags)
1448 for (unsigned int i=0; i<numFlags && i<AdminFlags_TOTAL; i++)
1450 bits |= (1 << (FlagBits)array[i]);
1456 unsigned int AdminCache::FlagBitsToArray(FlagBits bits, AdminFlag array[], unsigned int maxSize)
1458 unsigned int i, num=0;
1459 for (i=0; num<maxSize && i<AdminFlags_TOTAL; i++)
1461 if ((bits & (1<<i)) == (unsigned)(1<<i))
1463 array[num++] = (AdminFlag)i;
1470 bool AdminCache::CheckAdminFlags(AdminId id, FlagBits bits)
1472 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1473 if (!pUser || pUser->magic != USR_MAGIC_SET)
1478 return ((pUser->eflags & bits) == bits);
1481 bool AdminCache::CanAdminTarget(AdminId id, AdminId target)
1484 * Zeroth, if the targeting AdminId is INVALID_ADMIN_ID, targeting fails.
1485 * First, if the targeted AdminId is INVALID_ADMIN_ID, targeting succeeds.
1488 if (id == INVALID_ADMIN_ID)
1493 if (target == INVALID_ADMIN_ID)
1503 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1504 if (!pUser || pUser->magic != USR_MAGIC_SET)
1509 AdminUser *pTarget = (AdminUser *)m_pMemory->GetAddress(target);
1510 if (!pTarget || pTarget->magic != USR_MAGIC_SET)
1516 * Second, if the targeting admin is root, targeting succeeds.
1518 if (pUser->eflags & ADMFLAG_ROOT)
1523 /** Fourth, if the targeted admin is immune from targeting admin. */
1524 int mode = sm_immunity_mode.GetInt();
1529 if (pTarget->immunity_level > pUser->immunity_level)
1537 /* If neither has any immunity, let this pass. */
1538 if (!pUser->immunity_level && !pTarget->immunity_level)
1542 /* Don't break, go to the next case. */
1546 if (pTarget->immunity_level >= pUser->immunity_level)
1555 * Fifth, if the targeted admin has specific immunity from the
1556 * targeting admin via group immunities, targeting fails.
1558 //:TODO: speed this up... maybe with trie hacks.
1559 //idea is to insert %d.%d in the trie after computing this and use it as a cache lookup.
1560 //problem is the trie cannot delete prefixes, so we'd have a problem with invalidations.
1561 if (pTarget->grp_count > 0 && pUser->grp_count > 0)
1563 int *grp_table = (int *)m_pMemory->GetAddress(pTarget->grp_table);
1564 int *src_table = (int *)m_pMemory->GetAddress(pUser->grp_table);
1567 for (unsigned int i=0; i<pTarget->grp_count; i++)
1570 num = GetGroupImmunityCount(id);
1571 for (unsigned int j=0; j<num; i++)
1573 other = GetGroupImmunity(id, j);
1574 for (unsigned int k=0; k<pUser->grp_count; k++)
1576 if (other == src_table[k])
1588 bool AdminCache::FindFlag(char c, AdminFlag *pAdmFlag)
1590 if (c < 'a' || c > 'z')
1597 *pAdmFlag = g_FlagLetters[(unsigned)c - (unsigned)'a'];
1603 FlagBits AdminCache::ReadFlagString(const char *flags, const char **end)
1607 while (flags && (*flags != '\0'))
1610 if (!FindFlag(*flags, &flag))
1614 bits |= FlagArrayToBits(&flag, 1);
1626 unsigned int AdminCache::GetAdminSerialChange(AdminId id)
1628 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1629 if (!pUser || pUser->magic != USR_MAGIC_SET)
1634 return pUser->serialchange;
1637 bool AdminCache::CanAdminUseCommand(int client, const char *cmd)
1640 OverrideType otype = Override_Command;
1644 otype = Override_CommandGroup;
1648 if (!g_ConCmds.LookForCommandAdminFlags(cmd, &bits))
1650 if (!GetCommandOverride(cmd, otype, &bits))
1656 return g_ConCmds.CheckCommandAccess(client, cmd, bits);
1659 unsigned int AdminCache::SetGroupImmunityLevel(GroupId gid, unsigned int level)
1661 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(gid);
1662 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
1667 unsigned int old_level = pGroup->immunity_level;
1669 pGroup->immunity_level = level;
1674 unsigned int AdminCache::GetGroupImmunityLevel(GroupId gid)
1676 AdminGroup *pGroup = (AdminGroup *)m_pMemory->GetAddress(gid);
1677 if (!pGroup || pGroup->magic != GRP_MAGIC_SET)
1682 return pGroup->immunity_level;
1685 unsigned int AdminCache::SetAdminImmunityLevel(AdminId id, unsigned int level)
1687 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1688 if (!pUser || pUser->magic != USR_MAGIC_SET)
1693 unsigned int old_level = pUser->immunity_level;
1695 pUser->immunity_level = level;
1700 unsigned int AdminCache::GetAdminImmunityLevel(AdminId id)
1702 AdminUser *pUser = (AdminUser *)m_pMemory->GetAddress(id);
1703 if (!pUser || pUser->magic != USR_MAGIC_SET)
1708 return pUser->immunity_level;
1711 bool AdminCache::CheckAccess(int client, const char *cmd, FlagBits flags, bool override_only)
1718 /* Auto-detect a command if we can */
1719 FlagBits bits = flags;
1720 bool found_command = false;
1723 found_command = g_ConCmds.LookForCommandAdminFlags(cmd, &bits);
1728 GetCommandOverride(cmd, Override_Command, &bits);
1731 return g_ConCmds.CheckCommandAccess(client, cmd, bits) ? 1 : 0;