dvander@370: /**
dvander@407:  * vim: set ts=4 :
dvander@370:  * ===============================================================
dvander@370:  * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.
dvander@370:  * ===============================================================
dvander@370:  *
dvander@370:  * This file is not open source and may not be copied without explicit
dvander@370:  * written permission of AlliedModders LLC.  This file may not be redistributed 
dvander@370:  * in whole or significant part.
dvander@370:  * For information, see LICENSE.txt or http://www.sourcemod.net/license.php
dvander@370:  *
dvander@370:  * Version: $Id$
dvander@370:  */
dvander@370: 
dvander@335: #ifndef _INCLUDE_SOURCEMOD_ADMINCACHE_H_
dvander@335: #define _INCLUDE_SOURCEMOD_ADMINCACHE_H_
dvander@335: 
dvander@335: #include "sm_memtable.h"
dvander@335: #include <sm_trie.h>
dvander@336: #include <sh_list.h>
dvander@404: #include <sh_string.h>
dvander@335: #include <IAdminSystem.h>
dvander@335: #include "sm_globals.h"
dvander@336: #include <IForwardSys.h>
dvander@336: 
dvander@336: using namespace SourceHook;
dvander@335: 
dvander@335: #define GRP_MAGIC_SET		0xDEADFADE
dvander@335: #define GRP_MAGIC_UNSET		0xFACEFACE
dvander@404: #define USR_MAGIC_SET		0xDEADFACE
dvander@404: #define USR_MAGIC_UNSET		0xFADEDEAD
dvander@335: 
dvander@335: struct AdminGroup
dvander@335: {
dvander@335: 	uint32_t magic;					/* Magic flag, for memory validation (ugh) */
dvander@335: 	bool immune_global;				/* Global immunity? */
dvander@335: 	bool immune_default;			/* Default immunity? */
dvander@335: 	/* Immune from target table (-1 = nonexistant)
dvander@335: 	 * [0] = number of entries
dvander@335: 	 * [1...N] = immune targets
dvander@335: 	 */
dvander@335: 	int immune_table;			
dvander@335: 	Trie *pCmdTable;				/* Command override table (can be NULL) */
dvander@335: 	Trie *pCmdGrpTable;				/* Command group override table (can be NULL) */
dvander@335: 	int next_grp;					/* Next group in the chain */
dvander@335: 	int prev_grp;					/* Previous group in the chain */
dvander@335: 	int nameidx;					/* Name */
dvander@433: 	FlagBits addflags;				/* Additive flags */
dvander@335: };
dvander@335: 
dvander@404: struct AuthMethod
dvander@404: {
dvander@404: 	String name;
dvander@404: 	Trie *table;
dvander@404: };
dvander@404: 
dvander@404: struct UserAuth
dvander@404: {
dvander@404: 	unsigned int index;				/* Index into auth table */
dvander@404: 	int identidx;					/* Index into the string table */
dvander@404: };
dvander@404: 
dvander@404: struct AdminUser
dvander@404: {
dvander@433: 	uint32_t magic;					/* Magic flag, for memory validation */
dvander@433: 	FlagBits flags;					/* Flags */
dvander@433: 	FlagBits eflags;				/* Effective flags */
dvander@404: 	int nameidx;					/* Name index */
dvander@404: 	int password;					/* Password index */
dvander@404: 	unsigned int grp_count;			/* Number of groups */
dvander@404: 	unsigned int grp_size;			/* Size of groups table */
dvander@404: 	int grp_table;					/* Group table itself */
dvander@404: 	int next_user;					/* Next user in ze list */
dvander@404: 	int prev_user;					/* Prev user in the list */
dvander@405: 	UserAuth auth;					/* Auth method for this user */
dvander@434: 	bool immune_global;				/* Whether globally immune */
dvander@434: 	bool immune_default;			/* Whether defaultly immune */
dvander@404: };
dvander@404: 
dvander@335: class AdminCache : 
dvander@335: 	public IAdminSystem,
dvander@335: 	public SMGlobalClass
dvander@335: {
dvander@335: public:
dvander@335: 	AdminCache();
dvander@335: 	~AdminCache();
dvander@335: public: //SMGlobalClass
dvander@404: 	void OnSourceModStartup(bool late);
dvander@335: 	void OnSourceModAllInitialized();
dvander@336: 	void OnSourceModShutdown();
dvander@335: public: //IAdminSystem
dvander@335: 	/** Command cache stuff */
dvander@433: 	void AddCommandOverride(const char *cmd, OverrideType type, FlagBits flags);
dvander@433: 	bool GetCommandOverride(const char *cmd, OverrideType type, FlagBits *flags);
dvander@335: 	void UnsetCommandOverride(const char *cmd, OverrideType type);
dvander@335: 	/** Group cache stuff */
dvander@335: 	GroupId AddGroup(const char *group_name);
dvander@335: 	GroupId FindGroupByName(const char *group_name);
dvander@335: 	void SetGroupAddFlag(GroupId id, AdminFlag flag, bool enabled);
dvander@335: 	bool GetGroupAddFlag(GroupId id, AdminFlag flag);
dvander@433: 	FlagBits GetGroupAddFlags(GroupId id);
dvander@335: 	void SetGroupGenericImmunity(GroupId id, ImmunityType type, bool enabled);
dvander@335: 	bool GetGroupGenericImmunity(GroupId id, ImmunityType type);
dvander@335: 	void InvalidateGroup(GroupId id);
dvander@335: 	void AddGroupImmunity(GroupId id, GroupId other_id);
dvander@335: 	unsigned int GetGroupImmunityCount(GroupId id);
dvander@335: 	GroupId GetGroupImmunity(GroupId id, unsigned int number);
dvander@335: 	void AddGroupCommandOverride(GroupId id, const char *name, OverrideType type, OverrideRule rule);
dvander@335: 	bool GetGroupCommandOverride(GroupId id, const char *name, OverrideType type, OverrideRule *pRule);
dvander@438: 	void DumpAdminCache(AdminCachePart part, bool rebuild);
dvander@336: 	void AddAdminListener(IAdminListener *pListener);
dvander@336: 	void RemoveAdminListener(IAdminListener *pListener);
dvander@404: 	/** User stuff */
dvander@404: 	void RegisterAuthIdentType(const char *name);
dvander@404: 	AdminId CreateAdmin(const char *name);
dvander@404: 	const char *GetAdminName(AdminId id);
dvander@404: 	bool BindAdminIdentity(AdminId id, const char *auth, const char *ident);
dvander@404: 	virtual void SetAdminFlag(AdminId id, AdminFlag flag, bool enabled);
dvander@404: 	bool GetAdminFlag(AdminId id, AdminFlag flag, AccessMode mode);
dvander@433: 	FlagBits GetAdminFlags(AdminId id, AccessMode mode);
dvander@404: 	bool AdminInheritGroup(AdminId id, GroupId gid);
dvander@404: 	unsigned int GetAdminGroupCount(AdminId id);
dvander@404: 	GroupId GetAdminGroup(AdminId id, unsigned int index, const char **name);
dvander@404: 	void SetAdminPassword(AdminId id, const char *password);
dvander@404: 	const char *GetAdminPassword(AdminId id);
dvander@404: 	AdminId FindAdminByIdentity(const char *auth, const char *identity);
dvander@404: 	bool InvalidateAdmin(AdminId id);
dvander@433: 	unsigned int FlagBitsToBitArray(FlagBits bits, bool array[], unsigned int maxSize);
dvander@433: 	FlagBits FlagBitArrayToBits(const bool array[], unsigned int maxSize);
dvander@433: 	FlagBits FlagArrayToBits(const AdminFlag array[], unsigned int numFlags);
dvander@433: 	unsigned int FlagBitsToArray(FlagBits bits, AdminFlag array[], unsigned int maxSize);
dvander@434: 	bool CheckAdminFlags(AdminId id, FlagBits bits);
dvander@434: 	bool CanAdminTarget(AdminId id, AdminId target);
dvander@335: private:
dvander@335: 	void _UnsetCommandOverride(const char *cmd);
dvander@335: 	void _UnsetCommandGroupOverride(const char *group);
dvander@336: 	void InvalidateGroupCache();
dvander@404: 	void InvalidateAdminCache(bool unlink_admins);
dvander@336: 	void DumpCommandOverrideCache(OverrideType type);
dvander@404: 	Trie *GetMethodByIndex(unsigned int index);
dvander@405: 	bool GetMethodIndex(const char *name, unsigned int *_index);
dvander@335: public:
dvander@335: 	BaseStringTable *m_pStrings;
dvander@335: 	BaseMemTable *m_pMemory;
dvander@335: 	Trie *m_pCmdOverrides;
dvander@335: 	Trie *m_pCmdGrpOverrides;
dvander@335: 	int m_FirstGroup;
dvander@335: 	int m_LastGroup;
dvander@335: 	int m_FreeGroupList;
dvander@335: 	Trie *m_pGroups;
dvander@336: 	List<IAdminListener *> m_hooks;
dvander@404: 	List<AuthMethod> m_AuthMethods;
dvander@404: 	Trie *m_pAuthTables;
dvander@336: 	IForward *m_pCacheFwd;
dvander@404: 	int m_FirstUser;
dvander@404: 	int m_LastUser;
dvander@404: 	int m_FreeUserList;
dvander@335: };
dvander@335: 
dvander@335: extern AdminCache g_Admins;
dvander@335: 
dvander@335: #endif //_INCLUDE_SOURCEMOD_ADMINCACHE_H_