ds@1952: /**
ds@1952: * vim: set ts=4 :
ds@1952: * =============================================================================
ds@1952: * SourceMod
ds@1952: * Copyright (C) 2004-2008 AlliedModders LLC. All rights reserved.
ds@1952: * =============================================================================
ds@1952: *
ds@1952: * This program is free software; you can redistribute it and/or modify it under
ds@1952: * the terms of the GNU General Public License, version 3.0, as published by the
ds@1952: * Free Software Foundation.
ds@1952: *
ds@1952: * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1952: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1952: * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
ds@1952: * details.
ds@1952: *
ds@1952: * You should have received a copy of the GNU General Public License along with
ds@1952: * this program. If not, see .
ds@1952: *
ds@1952: * As a special exception, AlliedModders LLC gives you permission to link the
ds@1952: * code of this program (as well as its derivative works) to "Half-Life 2," the
ds@1952: * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1952: * by the Valve Corporation. You must obey the GNU General Public License in
ds@1952: * all respects for all other code used. Additionally, AlliedModders LLC grants
ds@1952: * this exception to all derivative works. AlliedModders LLC defines further
ds@1952: * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1952: * or .
ds@1952: *
ds@1952: * Version: $Id$
ds@1952: */
ds@1952:
ds@1952: #ifndef _INCLUDE_SOURCEMOD_ADMINISTRATION_SYSTEM_H_
ds@1952: #define _INCLUDE_SOURCEMOD_ADMINISTRATION_SYSTEM_H_
ds@1952:
ds@1952: #include
ds@1952:
ds@1952: #define SMINTERFACE_ADMINSYS_NAME "IAdminSys"
ds@1952: #define SMINTERFACE_ADMINSYS_VERSION 5
ds@1952:
ds@1952: /**
ds@1952: * @file IAdminSystem.h
ds@1952: * @brief Defines the interface to manage the Admin Users/Groups and Override caches.
ds@1952: *
ds@1952: * The administration system is more of a volatile cache than a system. It is designed to be
ds@1952: * temporary rather than permanent, in order to compensate for more storage methods. For example,
ds@1952: * a flat file might be read into the cache all at once. But a MySQL-based system might only cache
ds@1952: * admin permissions when that specific admin connects.
ds@1952: *
ds@1952: * The override cache is the simplest to explain. Any time an override is added, any existing
ds@1952: * and all future commands will gain a new access level set by the override. If unset, the default
ds@1952: * access level is restored. This cache is dynamically changeable.
ds@1952: *
ds@1952: * The group cache contains, for each group:
ds@1952: * 1] A set of inherent flags - fully readable/writable.
ds@1952: * 2] An immunity table - insertion and retrieval only.
ds@1952: * 3] An override table - insertion and retrieval only.
ds@1952: * Individual groups can be invalidated entirely. It should be considered an expensive
ds@1952: * operation, since each admin needs to be patched up to not reference the group.
ds@1952: *
ds@1952: * For more information, see the SourceMod Development wiki.
ds@1952: */
ds@1952:
ds@1952: namespace SourceMod
ds@1952: {
ds@1952: /**
ds@1952: * @brief Access levels (flags) for admins.
ds@1952: */
ds@1952: enum AdminFlag
ds@1952: {
ds@1952: Admin_Reservation = 0, /**< Reserved slot */
ds@1952: Admin_Generic, /**< Generic admin abilities */
ds@1952: Admin_Kick, /**< Kick another user */
ds@1952: Admin_Ban, /**< Ban another user */
ds@1952: Admin_Unban, /**< Unban another user */
ds@1952: Admin_Slay, /**< Slay/kill/damage another user */
ds@1952: Admin_Changemap, /**< Change the map */
ds@1952: Admin_Convars, /**< Change basic convars */
ds@1952: Admin_Config, /**< Change configuration */
ds@1952: Admin_Chat, /**< Special chat privileges */
ds@1952: Admin_Vote, /**< Special vote privileges */
ds@1952: Admin_Password, /**< Set a server password */
ds@1952: Admin_RCON, /**< Use RCON */
ds@1952: Admin_Cheats, /**< Change sv_cheats and use its commands */
ds@1952: Admin_Root, /**< All access by default */
ds@1952: Admin_Custom1, /**< First custom flag type */
ds@1952: Admin_Custom2, /**< Second custom flag type */
ds@1952: Admin_Custom3, /**< Third custom flag type */
ds@1952: Admin_Custom4, /**< Fourth custom flag type */
ds@1952: Admin_Custom5, /**< Fifth custom flag type */
ds@1952: Admin_Custom6, /**< Sixth custom flag type */
ds@1952: /* --- */
ds@1952: AdminFlags_TOTAL,
ds@1952: };
ds@1952:
ds@1952: #define ADMFLAG_RESERVATION (1<<0) /**< Convenience macro for Admin_Reservation as a FlagBit */
ds@1952: #define ADMFLAG_GENERIC (1<<1) /**< Convenience macro for Admin_Generic as a FlagBit */
ds@1952: #define ADMFLAG_KICK (1<<2) /**< Convenience macro for Admin_Kick as a FlagBit */
ds@1952: #define ADMFLAG_BAN (1<<3) /**< Convenience macro for Admin_Ban as a FlagBit */
ds@1952: #define ADMFLAG_UNBAN (1<<4) /**< Convenience macro for Admin_Unban as a FlagBit */
ds@1952: #define ADMFLAG_SLAY (1<<5) /**< Convenience macro for Admin_Slay as a FlagBit */
ds@1952: #define ADMFLAG_CHANGEMAP (1<<6) /**< Convenience macro for Admin_Changemap as a FlagBit */
ds@1952: #define ADMFLAG_CONVARS (1<<7) /**< Convenience macro for Admin_Convars as a FlagBit */
ds@1952: #define ADMFLAG_CONFIG (1<<8) /**< Convenience macro for Admin_Config as a FlagBit */
ds@1952: #define ADMFLAG_CHAT (1<<9) /**< Convenience macro for Admin_Chat as a FlagBit */
ds@1952: #define ADMFLAG_VOTE (1<<10) /**< Convenience macro for Admin_Vote as a FlagBit */
ds@1952: #define ADMFLAG_PASSWORD (1<<11) /**< Convenience macro for Admin_Password as a FlagBit */
ds@1952: #define ADMFLAG_RCON (1<<12) /**< Convenience macro for Admin_RCON as a FlagBit */
ds@1952: #define ADMFLAG_CHEATS (1<<13) /**< Convenience macro for Admin_Cheats as a FlagBit */
ds@1952: #define ADMFLAG_ROOT (1<<14) /**< Convenience macro for Admin_Root as a FlagBit */
ds@1952: #define ADMFLAG_CUSTOM1 (1<<15) /**< Convenience macro for Admin_Custom1 as a FlagBit */
ds@1952: #define ADMFLAG_CUSTOM2 (1<<16) /**< Convenience macro for Admin_Custom2 as a FlagBit */
ds@1952: #define ADMFLAG_CUSTOM3 (1<<17) /**< Convenience macro for Admin_Custom3 as a FlagBit */
ds@1952: #define ADMFLAG_CUSTOM4 (1<<18) /**< Convenience macro for Admin_Custom4 as a FlagBit */
ds@1952: #define ADMFLAG_CUSTOM5 (1<<19) /**< Convenience macro for Admin_Custom5 as a FlagBit */
ds@1952: #define ADMFLAG_CUSTOM6 (1<<20) /**< Convenience macro for Admin_Custom6 as a FlagBit */
ds@1952:
ds@1952: /**
ds@1952: * @brief Specifies which type of command to override (command or command group).
ds@1952: */
ds@1952: enum OverrideType
ds@1952: {
ds@1952: Override_Command = 1, /**< Command */
ds@1952: Override_CommandGroup, /**< Command group */
ds@1952: };
ds@1952:
ds@1952: /**
ds@1952: * @brief Specifies how a command is overridden for a user group.
ds@1952: */
ds@1952: enum OverrideRule
ds@1952: {
ds@1952: Command_Deny = 0, /**< Deny access */
ds@1952: Command_Allow = 1, /**< Allow access */
ds@1952: };
ds@1952:
ds@1952: /**
ds@1952: * @brief DEPRECATED. Specifies a generic immunity type.
ds@1952: */
ds@1952: enum ImmunityType
ds@1952: {
ds@1952: Immunity_Default = 1, /**< Immunity value of 1 */
ds@1952: Immunity_Global, /**< Immunity value of 2 */
ds@1952: };
ds@1952:
ds@1952: /**
ds@1952: * @brief Defines user access modes.
ds@1952: */
ds@1952: enum AccessMode
ds@1952: {
ds@1952: Access_Real, /**< Access the user has inherently */
ds@1952: Access_Effective, /**< Access the user has from their groups */
ds@1952: };
ds@1952:
ds@1952: /**
ds@1952: * @brief Represents an index to one group.
ds@1952: */
ds@1952: typedef int GroupId;
ds@1952:
ds@1952: /**
ds@1952: * @brief Represents an index to one user entry.
ds@1952: */
ds@1952: typedef int AdminId;
ds@1952:
ds@1952: /**
ds@1952: * @brief Represents an invalid/nonexistent group or an erroneous operation.
ds@1952: */
ds@1952: #define INVALID_GROUP_ID -1
ds@1952:
ds@1952: /**
ds@1952: * @brief Represents an invalid/nonexistent user or an erroneous operation.
ds@1952: */
ds@1952: #define INVALID_ADMIN_ID -1
ds@1952:
ds@1952: /**
ds@1952: * @brief Represents the various cache regions.
ds@1952: */
ds@1952: enum AdminCachePart
ds@1952: {
ds@1952: AdminCache_Overrides = 0, /**< Global overrides */
ds@1952: AdminCache_Groups = 1, /**< All groups (automatically invalidates admins too) */
ds@1952: AdminCache_Admins = 2, /**< All admins */
ds@1952: };
ds@1952:
ds@1952: /**
ds@1952: * @brief Provides callbacks for admin cache operations.
ds@1952: */
ds@1952: class IAdminListener
ds@1952: {
ds@1952: public:
ds@1952: virtual unsigned int GetInterfaceVersion()
ds@1952: {
ds@1952: return SMINTERFACE_ADMINSYS_VERSION;
ds@1952: }
ds@1952: public:
ds@1952: /**
ds@1952: * @brief Called when the admin cache needs to be rebuilt.
ds@1952: *
ds@1952: * @param auto_rebuild True if this is being called because of a group rebuild.
ds@1952: */
ds@1952: virtual void OnRebuildAdminCache(bool auto_rebuild) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Called when the group cache needs to be rebuilt.
ds@1952: */
ds@1952: virtual void OnRebuildGroupCache() =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Called when the global override cache needs to be rebuilt.
ds@1952: */
ds@1952: virtual void OnRebuildOverrideCache() =0;
ds@1952: };
ds@1952:
ds@1952: /**
ds@1952: * @brief Admin permission levels.
ds@1952: */
ds@1952: typedef unsigned int FlagBits;
ds@1952:
ds@1952: /**
ds@1952: * @brief Provides functions for manipulating the admin options cache.
ds@1952: */
ds@1952: class IAdminSystem : public SMInterface
ds@1952: {
ds@1952: public:
ds@1952: const char *GetInterfaceName()
ds@1952: {
ds@1952: return SMINTERFACE_ADMINSYS_NAME;
ds@1952: }
ds@1952: unsigned int GetInterfaceVersion()
ds@1952: {
ds@1952: return SMINTERFACE_ADMINSYS_VERSION;
ds@1952: }
ds@1952: public:
ds@1952: /**
ds@1952: * @brief Adds a global command flag override. Any command registered with this name
ds@1952: * will assume the new flag. This is applied retroactively as well.
ds@1952: *
ds@1952: * @param cmd String containing command name (case sensitive).
ds@1952: * @param type Override type (specific command or group).
ds@1952: * @param flags New admin flag.
ds@1952: */
ds@1952: virtual void AddCommandOverride(const char *cmd, OverrideType type, FlagBits flags) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Returns a command override.
ds@1952: *
ds@1952: * @param cmd String containing command name (case sensitive).
ds@1952: * @param type Override type (specific command or group).
ds@1952: * @param pFlags Optional pointer to the set flag.
ds@1952: * @return True if there is an override, false otherwise.
ds@1952: */
ds@1952: virtual bool GetCommandOverride(const char *cmd, OverrideType type, FlagBits *pFlags) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Unsets a command override.
ds@1952: *
ds@1952: * @param cmd String containing command name (case sensitive).
ds@1952: * @param type Override type (specific command or group).
ds@1952: */
ds@1952: virtual void UnsetCommandOverride(const char *cmd, OverrideType type) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Adds a new group. Name must be unique.
ds@1952: *
ds@1952: * @param group_name String containing the group name.
ds@1952: * @return A new group id, INVALID_GROUP_ID if it already exists.
ds@1952: */
ds@1952: virtual GroupId AddGroup(const char *group_name) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Finds a group by name.
ds@1952: *
ds@1952: * @param group_name String containing the group name.
ds@1952: * @return A group id, or INVALID_GROUP_ID if not found.
ds@1952: */
ds@1952: virtual GroupId FindGroupByName(const char *group_name) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Adds or removes a flag from a group's flag set.
ds@1952: * Note: These are called "add flags" because they add to a user's flags.
ds@1952: *
ds@1952: * @param id Group id.
ds@1952: * @param flag Admin flag to toggle.
ds@1952: * @param enabled True to set the flag, false to unset/disable.
ds@1952: */
ds@1952: virtual void SetGroupAddFlag(GroupId id, AdminFlag flag, bool enabled) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Gets the set value of an add flag on a group's flag set.
ds@1952: *
ds@1952: * @param id Group id.
ds@1952: * @param flag Admin flag to retrieve.
ds@1952: * @return True if enabled, false otherwise,
ds@1952: */
ds@1952: virtual bool GetGroupAddFlag(GroupId id, AdminFlag flag) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Returns an array of flag bits that are added to a user from their group.
ds@1952: * Note: These are called "add flags" because they add to a user's flags.
ds@1952: *
ds@1952: * @param id GroupId of the group.
ds@1952: * @return Bit string containing the bits of each flag.
ds@1952: */
ds@1952: virtual FlagBits GetGroupAddFlags(GroupId id) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief DEPRECATED. Sets a group's immunity level using backwards
ds@1952: * compatible types.
ds@1952: *
ds@1952: * If the new level being set is lower than the group's actual immunity
ds@1952: * level, no operation takes place.
ds@1952: *
ds@1952: * @param id Group id.
ds@1952: * @param type Immunity type which will be converted to a
ds@1952: * numerical level.
ds@1952: * @param enabled True to set the level. False sets the
ds@1952: * group's immunity value to 0.
ds@1952: */
ds@1952: virtual void SetGroupGenericImmunity(GroupId id, ImmunityType type, bool enabled) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief DEPRECATED. Returns whether a group has an immunity level
ds@1952: * using backwards compatible types.
ds@1952: *
ds@1952: * This simply checks whether the group's immunity value is greater
ds@1952: * than or equal to the new-style value for the old type.
ds@1952: *
ds@1952: * @param id Group id.
ds@1952: * @param type Generic immunity type.
ds@1952: * @return True if the group has this immunity, false
ds@1952: * otherwise.
ds@1952: */
ds@1952: virtual bool GetGroupGenericImmunity(GroupId id, ImmunityType type) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Adds immunity to a specific group.
ds@1952: *
ds@1952: * @param id Group id.
ds@1952: * @param other_id Group id to receive immunity to.
ds@1952: */
ds@1952: virtual void AddGroupImmunity(GroupId id, GroupId other_id) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Returns the number of specific group immunities.
ds@1952: *
ds@1952: * @param id Group id.
ds@1952: * @return Number of group immunities.
ds@1952: */
ds@1952: virtual unsigned int GetGroupImmunityCount(GroupId id) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Returns a group that this group is immune to given an index.
ds@1952: *
ds@1952: * @param id Group id.
ds@1952: * @param number Index from 0 to N-1, from GetGroupImmunities().
ds@1952: * @return GroupId that this group is immune to.
ds@1952: */
ds@1952: virtual GroupId GetGroupImmunity(GroupId id, unsigned int number) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Adds a group-specific override type.
ds@1952: *
ds@1952: * @param id Group id.
ds@1952: * @param name String containing command name (case sensitive).
ds@1952: * @param type Override type (specific command or group).
ds@1952: * @param rule Override allow/deny setting.
ds@1952: */
ds@1952: virtual void AddGroupCommandOverride(GroupId id,
ds@1952: const char *name,
ds@1952: OverrideType type,
ds@1952: OverrideRule rule) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Retrieves a group-specific command override.
ds@1952: *
ds@1952: * @param id Group id.
ds@1952: * @param name String containing command name (case sensitive).
ds@1952: * @param type Override type (specific command or group).
ds@1952: * @param pRule Optional pointer to store allow/deny setting.
ds@1952: * @return True if an override exists, false otherwise.
ds@1952: */
ds@1952: virtual bool GetGroupCommandOverride(GroupId id,
ds@1952: const char *name,
ds@1952: OverrideType type,
ds@1952: OverrideRule *pRule) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Tells the admin system to dump a portion of the cache.
ds@1952: * This calls into plugin forwards to rebuild the cache.
ds@1952: *
ds@1952: * @param part Portion of the cache to dump.
ds@1952: * @param rebuild If true, the rebuild forwards/events will fire.
ds@1952: */
ds@1952: virtual void DumpAdminCache(AdminCachePart part, bool rebuild) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Adds an admin interface listener.
ds@1952: *
ds@1952: * @param pListener Pointer to an IAdminListener to add.
ds@1952: */
ds@1952: virtual void AddAdminListener(IAdminListener *pListener) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Removes an admin interface listener.
ds@1952: *
ds@1952: * @param pListener Pointer to an IAdminListener to remove.
ds@1952: */
ds@1952: virtual void RemoveAdminListener(IAdminListener *pListener) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Registers an authentication identity type.
ds@1952: * Note: Default types are "steam," "name," and "ip."
ds@1952: *
ds@1952: * @param name String containing the type name.
ds@1952: */
ds@1952: virtual void RegisterAuthIdentType(const char *name) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Creates a new user entry.
ds@1952: *
ds@1952: * @param name Name for this entry (does not have to be unique).
ds@1952: * Specify NULL for an anonymous admin.
ds@1952: * @return A new AdminId index.
ds@1952: */
ds@1952: virtual AdminId CreateAdmin(const char *name) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Gets an admin's user name.
ds@1952: *
ds@1952: * @param id AdminId index for this admin.
ds@1952: * @return A string containing the admin's name, or NULL
ds@1952: * if the admin was created anonymously.
ds@1952: */
ds@1952: virtual const char *GetAdminName(AdminId id) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Binds a user entry to a particular auth method.
ds@1952: * This bind must be unique.
ds@1952: *
ds@1952: * @param id AdminId index of the admin.
ds@1952: * @param auth Auth method to use.
ds@1952: * @param ident Identity string to bind to.
ds@1952: * @return True on success, false if auth method was not found,
ds@1952: * id was invalid, or ident was already taken.
ds@1952: */
ds@1952: virtual bool BindAdminIdentity(AdminId id, const char *auth, const char *ident) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Sets whether or not a flag is enabled on an admin.
ds@1952: *
ds@1952: * @param id AdminId index of the admin.
ds@1952: * @param flag Admin flag to use.
ds@1952: * @param enabled True to enable, false to disable.
ds@1952: */
ds@1952: virtual void SetAdminFlag(AdminId id, AdminFlag flag, bool enabled) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Returns whether or not a flag is enabled on an admin.
ds@1952: *
ds@1952: * @param id AdminId index of the admin.
ds@1952: * @param flag Admin flag to use.
ds@1952: * @param mode Access mode to check.
ds@1952: * @return True if enabled, false otherwise.
ds@1952: */
ds@1952: virtual bool GetAdminFlag(AdminId id, AdminFlag flag, AccessMode mode) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Returns the bitstring of access flags on an admin.
ds@1952: *
ds@1952: * @param id AdminId index of the admin.
ds@1952: * @param mode Access mode to use.
ds@1952: * @return A bit string containing which flags are enabled.
ds@1952: */
ds@1952: virtual FlagBits GetAdminFlags(AdminId id, AccessMode mode) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Sets the bitstring of access flags on an admin.
ds@1952: *
ds@1952: * @param id AdminId index of the admin.
ds@1952: * @param mode Access mode to use (real affects both).
ds@1952: * @param bits Bitstring to set.
ds@1952: */
ds@1952: virtual void SetAdminFlags(AdminId id, AccessMode mode, FlagBits bits) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Adds a group to an admin's inherited group list.
ds@1952: * Any flags the group has will be added to the admin's effective flags.
ds@1952: *
ds@1952: * @param id AdminId index of the admin.
ds@1952: * @param gid GroupId index of the group.
ds@1952: * @return True on success, false on invalid input or duplicate membership.
ds@1952: */
ds@1952: virtual bool AdminInheritGroup(AdminId id, GroupId gid) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Returns the number of groups this admin is a member of.
ds@1952: *
ds@1952: * @param id AdminId index of the admin.
ds@1952: * @return Number of groups this admin is a member of.
ds@1952: */
ds@1952: virtual unsigned int GetAdminGroupCount(AdminId id) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Returns group information from an admin.
ds@1952: *
ds@1952: * @param id AdminId index of the admin.
ds@1952: * @param index Group number to retrieve, from 0 to N-1, where N
ds@1952: * is the value of GetAdminGroupCount(id).
ds@1952: * @param name Optional pointer to store the group's name.
ds@1952: * @return A GroupId index and a name pointer, or
ds@1952: * INVALID_GROUP_ID and NULL if an error occurred.
ds@1952: */
ds@1952: virtual GroupId GetAdminGroup(AdminId id, unsigned int index, const char **name) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Sets a password on an admin.
ds@1952: *
ds@1952: * @param id AdminId index of the admin.
ds@1952: * @param password String containing the password.
ds@1952: */
ds@1952: virtual void SetAdminPassword(AdminId id, const char *password) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Gets an admin's password.
ds@1952: *
ds@1952: * @param id AdminId index of the admin.
ds@1952: * @return Password of the admin, or NULL if none.
ds@1952: */
ds@1952: virtual const char *GetAdminPassword(AdminId id) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Attempts to find an admin by an auth method and an identity.
ds@1952: *
ds@1952: * @param auth Auth method to try.
ds@1952: * @param identity Identity string to look up.
ds@1952: * @return An AdminId index if found, INVALID_ADMIN_ID otherwise.
ds@1952: */
ds@1952: virtual AdminId FindAdminByIdentity(const char *auth, const char *identity) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Invalidates an admin from the cache so its resources can be re-used.
ds@1952: *
ds@1952: * @param id AdminId index to invalidate.
ds@1952: * @return True on success, false otherwise.
ds@1952: */
ds@1952: virtual bool InvalidateAdmin(AdminId id) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Converts a flag bit string to a bit array.
ds@1952: *
ds@1952: * @param bits Bit string containing the flags.
ds@1952: * @param array Array to write the flags to. Enabled flags will be 'true'.
ds@1952: * @param maxSize Maximum number of flags the array can store.
ds@1952: * @return Number of flags written.
ds@1952: */
ds@1952: virtual unsigned int FlagBitsToBitArray(FlagBits bits, bool array[], unsigned int maxSize) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Converts a flag array to a bit string.
ds@1952: *
ds@1952: * @param array Array containing true or false for each AdminFlag.
ds@1952: * @param maxSize Maximum size of the flag array.
ds@1952: * @return A bit string composed of the array bits.
ds@1952: */
ds@1952: virtual FlagBits FlagBitArrayToBits(const bool array[], unsigned int maxSize) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Converts an array of flags to bits.
ds@1952: *
ds@1952: * @param array Array containing flags that are enabled.
ds@1952: * @param numFlags Number of flags in the array.
ds@1952: * @return A bit string composed of the array flags.
ds@1952: */
ds@1952: virtual FlagBits FlagArrayToBits(const AdminFlag array[], unsigned int numFlags) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Converts a bit string to an array of flags.
ds@1952: *
ds@1952: * @param bits Bit string containing the flags.
ds@1952: * @param array Output array to write flags.
ds@1952: * @param maxSize Maximum size of the flag array.
ds@1952: * @return Number of flags written.
ds@1952: */
ds@1952: virtual unsigned int FlagBitsToArray(FlagBits bits, AdminFlag array[], unsigned int maxSize) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Checks whether a user has access to a given set of flag bits.
ds@1952: * Note: This is a wrapper around GetAdminFlags().
ds@1952: *
ds@1952: * @param id AdminId index of admin.
ds@1952: * @param bits Bitstring containing the permissions to check.
ds@1952: * @return True if user has permission, false otherwise.
ds@1952: */
ds@1952: virtual bool CheckAdminFlags(AdminId id, FlagBits bits) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Checks whether an AdminId can target another AdminId.
ds@1952: *
ds@1952: * The hueristics for this check are as follows:
ds@1952: * 0. If the targeting AdminId is INVALID_ADMIN_ID, targeting fails.
ds@1952: * 1. If the targeted AdminId is INVALID_ADMIN_ID, targeting succeeds.
ds@1952: * 2. If the targeted AdminId is the same as the targeting AdminId,
ds@1952: * (self) targeting succeeds.
ds@1952: * 3. If the targeting admin is root, targeting succeeds.
ds@1952: * 4. If the targeted admin has access higher (as interpreted by
ds@1952: * (sm_immunity_mode) than the targeting admin, then targeting fails.
ds@1952: * 5. If the targeted admin has specific immunity from the
ds@1952: * targeting admin via group immunities, targeting fails.
ds@1952: * 6. Targeting succeeds.
ds@1952: *
ds@1952: * @param id AdminId index of admin doing the targeting. Can be INVALID_ADMIN_ID.
ds@1952: * @param target AdminId index of the target admin. Can be INVALID_ADMIN_ID.
ds@1952: * @return True if this admin has permission to target the other admin.
ds@1952: */
ds@1952: virtual bool CanAdminTarget(AdminId id, AdminId target) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Returns a flag from a named string.
ds@1952: *
ds@1952: * @param flagname Case sensitive flag name string (like "kick").
ds@1952: * @param pAdmFlag Pointer to store the found admin flag in.
ds@1952: * @return True on success, false on failure.
ds@1952: */
ds@1952: virtual bool FindFlag(const char *flagname, AdminFlag *pAdmFlag) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Reads a single character as a flag.
ds@1952: *
ds@1952: * @param c Flag character.
ds@1952: * @param pAdmFlag Pointer to store the admin flag.
ds@1952: * @return True on success, false if invalid.
ds@1952: */
ds@1952: virtual bool FindFlag(char c, AdminFlag *pAdmFlag) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Reads a string of flag letters and returns its access value.
ds@1952: *
ds@1952: * @param flags Flag string.
ds@1952: * @param end Pointer to store the last value read. On success,
ds@1952: * this will store a pointer to the null terminator.
ds@1952: * @return FlagBits value of the flags.
ds@1952: */
ds@1952: virtual FlagBits ReadFlagString(const char *flags, const char **end) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Returns a "serial number" for an AdminId. If the serial
ds@1952: * number has changed for a given AdminId, it means the permissions
ds@1952: * have changed.
ds@1952: *
ds@1952: * @param id AdminId value.
ds@1952: * @return Serial number, or 0 on failure.
ds@1952: */
ds@1952: virtual unsigned int GetAdminSerialChange(AdminId id) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Checks whether an admin can use the given command name.
ds@1952: *
ds@1952: * If the command does not exist, this will return true.
ds@1952: *
ds@1952: * @param client Client index.
ds@1952: * @param cmd Command name.
ds@1952: * @return True on success, false on failure.
ds@1952: */
ds@1952: virtual bool CanAdminUseCommand(int client, const char *cmd) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Returns the name of a group.
ds@1952: *
ds@1952: * @param gid Group Id.
ds@1952: * @return Group name, or NULL on failure.
ds@1952: */
ds@1952: virtual const char *GetGroupName(GroupId gid) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Sets the immunity level of a group.
ds@1952: *
ds@1952: * @param gid Group Id.
ds@1952: * @param level Immunity level value.
ds@1952: * @return Old immunity level.
ds@1952: */
ds@1952: virtual unsigned int SetGroupImmunityLevel(GroupId gid, unsigned int level) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Retrieves the immunity level of a group.
ds@1952: *
ds@1952: * @param gid Group Id.
ds@1952: * @return Immunity level value.
ds@1952: */
ds@1952: virtual unsigned int GetGroupImmunityLevel(GroupId gid) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Sets the immunity level of an admin.
ds@1952: *
ds@1952: * @param id Admin Id.
ds@1952: * @param level Immunity level value.
ds@1952: * @return Old immunity level.
ds@1952: */
ds@1952: virtual unsigned int SetAdminImmunityLevel(AdminId id, unsigned int level) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Retrieves the immunity level of an admin.
ds@1952: *
ds@1952: * @param id Admin Id.
ds@1952: * @return Immunity level value.
ds@1952: */
ds@1952: virtual unsigned int GetAdminImmunityLevel(AdminId id) =0;
ds@1952:
ds@1952: /**
ds@1952: * @brief Computers access to an override.
ds@1952: *
ds@1952: * @param client Client index.
ds@1952: * @param cmd Override name.
ds@1952: * @param flags Default flags.
ds@1952: * @param override_only If false, if a command matches the override,
ds@1952: * then its flags will override the default.
ds@1952: * @return True if the client has access, false otherwise.
ds@1952: */
ds@1952: virtual bool CheckAccess(int client,
ds@1952: const char *cmd,
ds@1952: FlagBits flags,
ds@1952: bool override_only) =0;
ds@1952: };
ds@1952: }
ds@1952:
ds@1952: #endif //_INCLUDE_SOURCEMOD_ADMINISTRATION_SYSTEM_H_
ds@1952: