IAdminSystem.h

Go to the documentation of this file.

#ifndef _INCLUDE_SOURCEMOD_ADMINISTRATION_SYSTEM_H_
#define _INCLUDE_SOURCEMOD_ADMINISTRATION_SYSTEM_H_

#include <IShareSys.h>

#define SMINTERFACE_ADMINSYS_NAME               "IAdminSys"
#define SMINTERFACE_ADMINSYS_VERSION    8

namespace SourceMod
{
        enum AdminFlag
        {
                Admin_Reservation = 0,  
                Admin_Generic,                  
                Admin_Kick,                             
                Admin_Ban,                              
                Admin_Unban,                    
                Admin_Slay,                             
                Admin_Changemap,                
                Admin_Convars,                  
                Admin_Config,                   
                Admin_Chat,                             
                Admin_Vote,                             
                Admin_Password,                 
                Admin_RCON,                             
                Admin_Cheats,                   
                Admin_Root,                             
                Admin_Custom1,                  
                Admin_Custom2,                  
                Admin_Custom3,                  
                Admin_Custom4,                  
                Admin_Custom5,                  
                Admin_Custom6,                  
                /* --- */
                AdminFlags_TOTAL,
        };

        #define ADMFLAG_RESERVATION                     (1<<0)          
        #define ADMFLAG_GENERIC                         (1<<1)          
        #define ADMFLAG_KICK                            (1<<2)          
        #define ADMFLAG_BAN                                     (1<<3)          
        #define ADMFLAG_UNBAN                           (1<<4)          
        #define ADMFLAG_SLAY                            (1<<5)          
        #define ADMFLAG_CHANGEMAP                       (1<<6)          
        #define ADMFLAG_CONVARS                         (1<<7)          
        #define ADMFLAG_CONFIG                          (1<<8)          
        #define ADMFLAG_CHAT                            (1<<9)          
        #define ADMFLAG_VOTE                            (1<<10)         
        #define ADMFLAG_PASSWORD                        (1<<11)         
        #define ADMFLAG_RCON                            (1<<12)         
        #define ADMFLAG_CHEATS                          (1<<13)         
        #define ADMFLAG_ROOT                            (1<<14)         
        #define ADMFLAG_CUSTOM1                         (1<<15)         
        #define ADMFLAG_CUSTOM2                         (1<<16)         
        #define ADMFLAG_CUSTOM3                         (1<<17)         
        #define ADMFLAG_CUSTOM4                         (1<<18)         
        #define ADMFLAG_CUSTOM5                         (1<<19)         
        #define ADMFLAG_CUSTOM6                         (1<<20)         
        enum OverrideType
        {
                Override_Command = 1,   
                Override_CommandGroup,  
        };

        enum OverrideRule
        {
                Command_Deny = 0,               
                Command_Allow = 1,              
        };

        enum ImmunityType
        {
                Immunity_Default = 1,   
                Immunity_Global,                
        };

        enum AccessMode
        {
                Access_Real,            
                Access_Effective,       
        };

        typedef int             GroupId;

        typedef int             AdminId;

        #define INVALID_GROUP_ID        -1

        #define INVALID_ADMIN_ID        -1

        enum AdminCachePart
        {
                AdminCache_Overrides = 0,               
                AdminCache_Groups = 1,                  
                AdminCache_Admins = 2,                  
        };

        class IAdminListener
        {
        public:
                virtual unsigned int GetInterfaceVersion()
                {
                        return SMINTERFACE_ADMINSYS_VERSION;
                }
        public:
                virtual void OnRebuildAdminCache(bool auto_rebuild) =0;

                virtual void OnRebuildGroupCache() =0;
                
                virtual void OnRebuildOverrideCache() =0;
        };

        typedef unsigned int FlagBits;

        class IAdminSystem : public SMInterface
        {
        public:
                const char *GetInterfaceName()
                {
                        return SMINTERFACE_ADMINSYS_NAME;
                }
                unsigned int GetInterfaceVersion()
                {
                        return SMINTERFACE_ADMINSYS_VERSION;
                }
        public:
                virtual void AddCommandOverride(const char *cmd, OverrideType type, FlagBits flags) =0;

                virtual bool GetCommandOverride(const char *cmd, OverrideType type, FlagBits *pFlags) =0;

                virtual void UnsetCommandOverride(const char *cmd, OverrideType type) =0;

                virtual GroupId AddGroup(const char *group_name) =0;

                virtual GroupId FindGroupByName(const char *group_name) =0;

                virtual void SetGroupAddFlag(GroupId id, AdminFlag flag, bool enabled) =0;

                virtual bool GetGroupAddFlag(GroupId id, AdminFlag flag) =0;

                virtual FlagBits GetGroupAddFlags(GroupId id) =0;

                virtual void SetGroupGenericImmunity(GroupId id, ImmunityType type, bool enabled) =0;

                virtual bool GetGroupGenericImmunity(GroupId id, ImmunityType type) =0;

                virtual void AddGroupImmunity(GroupId id, GroupId other_id) =0;

                virtual unsigned int GetGroupImmunityCount(GroupId id) =0;

                virtual GroupId GetGroupImmunity(GroupId id, unsigned int number) =0;

                virtual void AddGroupCommandOverride(GroupId id,
                                                                                         const char *name,
                                                                                         OverrideType type,
                                                                                         OverrideRule rule) =0;

                virtual bool GetGroupCommandOverride(GroupId id,
                                                                                         const char *name,
                                                                                         OverrideType type,
                                                                                         OverrideRule *pRule) =0;

                virtual void DumpAdminCache(AdminCachePart part, bool rebuild) =0;

                virtual void AddAdminListener(IAdminListener *pListener) =0;

                virtual void RemoveAdminListener(IAdminListener *pListener) =0;

                virtual void RegisterAuthIdentType(const char *name) =0;

                virtual AdminId CreateAdmin(const char *name) =0;

                virtual const char *GetAdminName(AdminId id) =0;

                virtual bool BindAdminIdentity(AdminId id, const char *auth, const char *ident) =0;

                virtual void SetAdminFlag(AdminId id, AdminFlag flag, bool enabled) =0;

                virtual bool GetAdminFlag(AdminId id, AdminFlag flag, AccessMode mode) =0;

                virtual FlagBits GetAdminFlags(AdminId id, AccessMode mode) =0;

                virtual void SetAdminFlags(AdminId id, AccessMode mode, FlagBits bits) =0;

                virtual bool AdminInheritGroup(AdminId id, GroupId gid) =0;

                virtual unsigned int GetAdminGroupCount(AdminId id) =0;

                virtual GroupId GetAdminGroup(AdminId id, unsigned int index, const char **name) =0;
                
                virtual void SetAdminPassword(AdminId id, const char *password) =0;

                virtual const char *GetAdminPassword(AdminId id) =0;
                
                virtual AdminId FindAdminByIdentity(const char *auth, const char *identity) =0;

                virtual bool InvalidateAdmin(AdminId id) =0;

                virtual unsigned int FlagBitsToBitArray(FlagBits bits, bool array[], unsigned int maxSize) =0;

                virtual FlagBits FlagBitArrayToBits(const bool array[], unsigned int maxSize) =0;

                virtual FlagBits FlagArrayToBits(const AdminFlag array[], unsigned int numFlags) =0;

                virtual unsigned int FlagBitsToArray(FlagBits bits, AdminFlag array[], unsigned int maxSize) =0;

                virtual bool CheckAdminFlags(AdminId id, FlagBits bits) =0;

                virtual bool CanAdminTarget(AdminId id, AdminId target) =0;

                virtual bool FindFlag(const char *flagname, AdminFlag *pAdmFlag) =0;

                virtual bool FindFlag(char c, AdminFlag *pAdmFlag) =0;

                virtual FlagBits ReadFlagString(const char *flags, const char **end) =0;

                virtual unsigned int GetAdminSerialChange(AdminId id) =0;

                virtual bool CanAdminUseCommand(int client, const char *cmd) =0;

                virtual const char *GetGroupName(GroupId gid) =0;

                virtual unsigned int SetGroupImmunityLevel(GroupId gid, unsigned int level) =0;

                virtual unsigned int GetGroupImmunityLevel(GroupId gid) =0;

                virtual unsigned int SetAdminImmunityLevel(AdminId id, unsigned int level) =0;

                virtual unsigned int GetAdminImmunityLevel(AdminId id) =0;

                virtual bool CheckAccess(int client, 
                        const char *cmd, 
                        FlagBits flags, 
                        bool override_only) =0;

                virtual bool FindFlagChar(AdminFlag flag, char *c) =0;

                virtual bool IsValidAdmin(AdminId id) =0;

                virtual bool CheckClientCommandAccess(int client, const char *cmd, FlagBits cmdflags) =0;
        };
}

#endif //_INCLUDE_SOURCEMOD_ADMINISTRATION_SYSTEM_H_