dvander@372: /**
dvander@375:  * vim: set ts=4 :
dvander@372:  * ===============================================================
dvander@376:  * SourceMod, Copyright (C) 2004-2007 AlliedModders LLC. 
dvander@376:  * All rights reserved.
dvander@372:  * ===============================================================
dvander@372:  *
dvander@379:  *  This file is part of the SourceMod/SourcePawn SDK.  This file may only be 
dvander@379:  * used or modified under the Terms and Conditions of its License Agreement, 
dvander@379:  * which is found in public/licenses/LICENSE.txt.  As of this notice, derivative 
dvander@379:  * works must be licensed under the GNU General Public License (version 2 or 
dvander@379:  * greater).  A copy of the GPL is included under public/licenses/GPL.txt.
dvander@379:  * 
dvander@379:  * To view the latest information, see: http://www.sourcemod.net/license.php
dvander@372:  *
dvander@372:  * Version: $Id$
dvander@372:  */
dvander@372: 
dvander@335: #ifndef _INCLUDE_SOURCEMOD_ADMINISTRATION_SYSTEM_H_
dvander@335: #define _INCLUDE_SOURCEMOD_ADMINISTRATION_SYSTEM_H_
dvander@335: 
dvander@335: #include <IShareSys.h>
dvander@335: 
dvander@335: #define SMINTERFACE_ADMINSYS_NAME		"IAdminSys"
dvander@335: #define SMINTERFACE_ADMINSYS_VERSION	1
dvander@335: 
dvander@335: /**
dvander@372:  * @file IAdminSystem.h
dvander@372:  * @brief Defines the interface to manage the Admin Users/Groups and Override caches.
dvander@372:  *
dvander@335:  *   The administration system is more of a volatile cache than a system.  It is designed to be 
dvander@335:  * temporary rather than permanent, in order to compensate for more storage methods.  For example,
dvander@335:  * a flat file might be read into the cache all at once.  But a MySQL-based system might only cache
dvander@335:  * admin permissions when that specific admin connects.  
dvander@335:  *
dvander@335:  *   The override cache is the simplest to explain.  Any time an override is added, any existing 
dvander@335:  * and all future commands will gain a new access level set by the override.  If unset, the default
dvander@335:  * access level is restored.  This cache is dynamically changeable.
dvander@335:  *
dvander@335:  *   The group cache contains, for each group:
dvander@335:  *	1] A set of inherent flags - fully readable/writable.
dvander@335:  *  2] An immunity table - insertion and retrieval only.
dvander@335:  *  3] An override table - insertion and retrieval only.
dvander@335:  *   Individual groups can be invalidated entirely.  It should be considered an expensive
dvander@335:  *  operation, since each admin needs to be patched up to not reference the group.
dvander@404:  *
dvander@404:  *   For more information, see the SourceMod Development wiki.
dvander@335:  */
dvander@335: 
dvander@335: namespace SourceMod
dvander@335: {
dvander@372: 	/**
dvander@372: 	 * @brief Access levels (flags) for admins.
dvander@372: 	 */
dvander@335: 	enum AdminFlag
dvander@335: 	{
dvander@335: 		Admin_None = 0,
dvander@372: 		Admin_Reservation,		/**< Reserved slot */
dvander@372: 		Admin_Kick,				/**< Kick another user */
dvander@372: 		Admin_Ban,				/**< Ban another user */
dvander@372: 		Admin_Unban,			/**< Unban another user */
dvander@372: 		Admin_Slay,				/**< Slay/kill/damage another user */
dvander@372: 		Admin_Changemap,		/**< Change the map */
dvander@372: 		Admin_Convars,			/**< Change basic convars */
dvander@372: 		Admin_Configs,			/**< Change configs */
dvander@372: 		Admin_Chat,				/**< Special chat privileges */
dvander@372: 		Admin_Vote,				/**< Special vote privileges */
dvander@372: 		Admin_Password,			/**< Set a server password */
dvander@372: 		Admin_RCON,				/**< Use RCON */
dvander@372: 		Admin_Cheats,			/**< Change sv_cheats and use its commands */
dvander@372: 		Admin_Root,				/**< All access by default */
dvander@335: 		/* --- */
dvander@335: 		AdminFlags_TOTAL,
dvander@335: 	};
dvander@335: 
dvander@372: 	/**
dvander@372: 	 * @brief Specifies which type of command to override (command or command group).
dvander@372: 	 */
dvander@335: 	enum OverrideType
dvander@335: 	{
dvander@372: 		Override_Command = 1,	/**< Command */
dvander@372: 		Override_CommandGroup,	/**< Command group */
dvander@335: 	};
dvander@335: 
dvander@372: 	/**
dvander@372: 	 * @brief Specifies how a command is overridden for a user group.
dvander@372: 	 */
dvander@335: 	enum OverrideRule
dvander@335: 	{
dvander@372: 		Command_Deny = 0,		/**< Deny access */
dvander@372: 		Command_Allow = 1,		/**< Allow access */
dvander@335: 	};
dvander@335: 
dvander@372: 	/**
dvander@372: 	 * @brief Specifies a generic immunity type.
dvander@372: 	 */
dvander@335: 	enum ImmunityType
dvander@335: 	{
dvander@372: 		Immunity_Default = 1,	/**< Immune from everyone with no immunity */
dvander@372: 		Immunity_Global,		/**< Immune from everyone (except root admins) */
dvander@335: 	};
dvander@335: 
dvander@372: 	/**
dvander@404: 	 * @brief Defines user access modes.
dvander@404: 	 */
dvander@404: 	enum AccessMode
dvander@404: 	{
dvander@404: 		Access_Real,		/**< Access the user has inherently */
dvander@404: 		Access_Effective,	/**< Access the user has from their groups */
dvander@404: 	};
dvander@404: 
dvander@404: 	/**
dvander@372: 	 * @brief Represents an index to one group.
dvander@372: 	 */
dvander@335: 	typedef int		GroupId;
dvander@335: 
dvander@404: 	/**
dvander@404: 	 * @brief Represents an index to one user entry.
dvander@404: 	 */
dvander@404: 	typedef int		AdminId;
dvander@404: 
dvander@336: 	#define ADMIN_CACHE_OVERRIDES	(1<<0)
dvander@336: 	#define ADMIN_CACHE_ADMINS		(1<<1)
dvander@336: 	#define ADMIN_CACHE_GROUPS		((1<<2)|ADMIN_CACHE_ADMINS)
dvander@336: 
dvander@372: 	/**
dvander@372: 	 * @brief Represents an invalid/nonexistant group or an erroneous operation.
dvander@372: 	 */
dvander@335: 	#define INVALID_GROUP_ID	-1
dvander@335: 
dvander@372: 	/**
dvander@404: 	 * @brief Represents an invalid/nonexistant user or an erroneous operation.
dvander@404: 	 */
dvander@404: 	#define INVALID_ADMIN_ID	-1
dvander@404: 
dvander@404: 	/**
dvander@372: 	 * @brief Provides callbacks for admin cache operations.
dvander@372: 	 */
dvander@336: 	class IAdminListener
dvander@336: 	{
dvander@336: 	public:
dvander@336: 		/**
dvander@336: 		 * Called when part of the admin cache needs to be rebuilt.  
dvander@336: 		 * Groups should always be rebuilt before admins.
dvander@336: 		 *
dvander@336: 		 * @param cache_flags	Flags for which cache to dump.
dvander@336: 		 */
dvander@336: 		virtual void OnRebuildAdminCache(int cache_flags) =0;
dvander@336: 	};
dvander@336: 
dvander@335: 	/**
dvander@372: 	 * @brief Provides functions for manipulating the admin options cache.
dvander@335: 	 */
dvander@335: 	class IAdminSystem : public SMInterface
dvander@335: 	{
dvander@335: 	public:
dvander@335: 		const char *GetInterfaceName()
dvander@335: 		{
dvander@335: 			return SMINTERFACE_ADMINSYS_NAME;
dvander@335: 		}
dvander@335: 		unsigned int GetInterfaceVersion()
dvander@335: 		{
dvander@335: 			return SMINTERFACE_ADMINSYS_VERSION;
dvander@335: 		}
dvander@335: 	public:
dvander@335: 		/**
dvander@335: 		 * @brief Adds a global command flag override.  Any command registered with this name
dvander@335: 		 * will assume the new flag.  This is applied retroactively as well.
dvander@335: 		 *
dvander@335: 		 * @param cmd			String containing command name (case sensitive).
dvander@335: 		 * @param type			Override type (specific command or group).
dvander@335: 		 * @param flag			New admin flag.
dvander@335: 		 */
dvander@335: 		virtual void AddCommandOverride(const char *cmd, OverrideType type, AdminFlag flag) =0;
dvander@335: 
dvander@335: 		/**
dvander@335: 		 * @brief Returns a command override.
dvander@335: 		 *
dvander@335: 		 * @param cmd			String containing command name (case sensitive).
dvander@335: 		 * @param type			Override type (specific command or group).
dvander@335: 		 * @param pFlag			Optional pointer to the set flag.
dvander@335: 		 * @return				True if there is an override, false otherwise.
dvander@335: 		 */
dvander@335: 		virtual bool GetCommandOverride(const char *cmd, OverrideType type, AdminFlag *pFlag) =0;
dvander@335: 
dvander@335: 		/**
dvander@335: 		 * @brief Unsets a command override.
dvander@335: 		 *
dvander@335: 		 * @param cmd			String containing command name (case sensitive).
dvander@335: 		 * @param type			Override type (specific command or group).
dvander@335: 		 */
dvander@335: 		virtual void UnsetCommandOverride(const char *cmd, OverrideType type) =0;
dvander@335: 
dvander@335: 		/**
dvander@335: 		 * @brief Adds a new group.  Name must be unique.
dvander@335: 		 *
dvander@335: 		 * @param group_name	String containing the group name.
dvander@335: 		 * @return				A new group id, INVALID_GROUP_ID if it already exists.
dvander@335: 		 */
dvander@335: 		virtual GroupId AddGroup(const char *group_name) =0;
dvander@335: 
dvander@335: 		/**
dvander@335: 		 * @brief Finds a group by name.
dvander@335: 		 *
dvander@335: 		 * @param group_name	String containing the group name.
dvander@335: 		 * @return				A group id, or INVALID_GROUP_ID if not found.
dvander@335: 		 */
dvander@335: 		virtual GroupId FindGroupByName(const char *group_name) =0;
dvander@335: 
dvander@335: 		/**
dvander@335: 		 * @brief Adds or removes a flag from a group's flag set.
dvander@335: 		 * Note: These are called "add flags" because they add to a user's flags.
dvander@335: 		 *
dvander@335: 		 * @param id			Group id.
dvander@335: 		 * @param flag			Admin flag to toggle.
dvander@335: 		 * @param enabled		True to set the flag, false to unset/disable.
dvander@335: 		 */
dvander@335: 		virtual void SetGroupAddFlag(GroupId id, AdminFlag flag, bool enabled) =0;
dvander@335: 
dvander@335: 		/**
dvander@335: 		 * @brief Gets the set value of an add flag on a group's flag set.
dvander@335: 		 *
dvander@335: 		 * @param id			Group id.
dvander@335: 		 * @param flag			Admin flag to retrieve.
dvander@335: 		 * @return				True if enabled, false otherwise,
dvander@335: 		 */
dvander@335: 		virtual bool GetGroupAddFlag(GroupId id, AdminFlag flag) =0;
dvander@335: 
dvander@335: 		/**
dvander@336: 		 * @brief Returns an array of flag bits that are added to a user from their group.
dvander@335: 		 * Note: These are called "add flags" because they add to a user's flags.
dvander@335: 		 *
dvander@335: 		 * @param id			GroupId of the group.
dvander@336: 		 * @param flags			Array to store flags bits in.
dvander@335: 		 * @param total			Total number of flags that can be stored in the array.
dvander@335: 		 * @return				Number of flags that were written to the array.
dvander@335: 		 */
dvander@336: 		virtual unsigned int GetGroupAddFlagBits(GroupId id, bool flags[], unsigned int total) =0;
dvander@335: 
dvander@335: 		/**
dvander@335: 		 * @brief Toggles a generic immunity type.
dvander@335: 		 *
dvander@335: 		 * @param id			Group id.
dvander@335: 		 * @param type			Generic immunity type.
dvander@335: 		 * @param enabled		True to enable, false otherwise.
dvander@335: 		 */
dvander@335: 		virtual void SetGroupGenericImmunity(GroupId id, ImmunityType type, bool enabled) =0;
dvander@335: 
dvander@335: 		/**
dvander@335: 		 * @brief Returns whether or not a group has global immunity.
dvander@335: 		 *
dvander@335: 		 * @param id			Group id.
dvander@335: 		 * @param type			Generic immunity type.
dvander@335: 		 * @return				True if the group has this immunity, false otherwise.
dvander@335: 		 */
dvander@335: 		virtual bool GetGroupGenericImmunity(GroupId id, ImmunityType type) =0;
dvander@335: 
dvander@335: 		/**
dvander@335: 		 * @brief Adds immunity to a specific group.
dvander@335: 		 *
dvander@335: 		 * @param id			Group id.
dvander@335: 		 * @param other_id		Group id to receive immunity to.
dvander@335: 		 */
dvander@335: 		virtual void AddGroupImmunity(GroupId id, GroupId other_id) =0;
dvander@335: 
dvander@335: 		/**
dvander@335: 		 * @brief Returns the number of specific group immunities.
dvander@335: 		 *
dvander@335: 		 * @param id			Group id.
dvander@335: 		 * @return				Number of group immunities.
dvander@335: 		 */
dvander@335: 		virtual unsigned int GetGroupImmunityCount(GroupId id) =0;
dvander@335: 
dvander@335: 		/**
dvander@335: 		 * @brief Returns a group that this group is immune to given an index.
dvander@335: 		 *
dvander@335: 		 * @param id			Group id.
dvander@335: 		 * @param number		Index from 0 to N-1, from GetGroupImmunities().
dvander@335: 		 * @return				GroupId that this group is immune to.
dvander@335: 		 */
dvander@335: 		virtual GroupId GetGroupImmunity(GroupId id, unsigned int number) =0;
dvander@335: 
dvander@335: 		/**
dvander@335: 		 * @brief Adds a group-specific override type.
dvander@335: 		 *
dvander@335: 		 * @param id			Group id.
dvander@335: 		 * @param name			String containing command name (case sensitive).
dvander@335: 		 * @param type			Override type (specific command or group).
dvander@335: 		 * @param rule			Override allow/deny setting.
dvander@335: 		 */
dvander@335: 		virtual void AddGroupCommandOverride(GroupId id,
dvander@335: 											 const char *name,
dvander@335: 											 OverrideType type,
dvander@335: 											 OverrideRule rule) =0;
dvander@335: 
dvander@335: 		/**
dvander@335: 		 * @brief Retrieves a group-specific command override.
dvander@335: 		 *
dvander@335: 		 * @param id			Group id.
dvander@335: 		 * @param name			String containing command name (case sensitive).
dvander@335: 		 * @param type			Override type (specific command or group).
dvander@372: 		 * @param pRule			Optional pointer to store allow/deny setting.
dvander@335: 		 * @return				True if an override exists, false otherwise.
dvander@335: 		 */
dvander@335: 		virtual bool GetGroupCommandOverride(GroupId id,
dvander@335: 											 const char *name,
dvander@335: 											 OverrideType type,
dvander@335: 											 OverrideRule *pRule) =0;
dvander@335: 
dvander@335: 		/**
dvander@336: 		 * @brief Tells the admin system to dump a portion of the cache.  
dvander@336: 		 * This calls into plugin forwards to rebuild the cache.
dvander@336: 		 *
dvander@336: 		 * @param cache_flags	Flags for which cache to dump.  Specifying groups also dumps admins.
dvander@336: 		 * @param rebuild		If true, the rebuild forwards/events will fire.
dvander@335: 		 */
dvander@336: 		virtual void DumpAdminCache(int cache_flags, bool rebuild) =0;
dvander@336: 
dvander@336: 		/**
dvander@336: 		 * @brief Adds an admin interface listener.
dvander@336: 		 *
dvander@336: 		 * @param pListener		Pointer to an IAdminListener to add.
dvander@336: 		 */
dvander@336: 		virtual void AddAdminListener(IAdminListener *pListener) =0;
dvander@336: 
dvander@336: 		/**
dvander@336: 		 * @brief Removes an admin interface listener.
dvander@336: 		 *
dvander@336: 		 * @param pListener		Pointer to an IAdminListener to remove.
dvander@336: 		 */
dvander@336: 		virtual void RemoveAdminListener(IAdminListener *pListener) =0;
dvander@404: 
dvander@404: 		/**
dvander@404: 		 * @brief Registers an authentication identity type.
dvander@404: 		 * Note: Default types are "steam," "name," and "ip."
dvander@404: 		 *
dvander@404: 		 * @param name			String containing the type name.
dvander@404: 		 */
dvander@404: 		virtual void RegisterAuthIdentType(const char *name) =0;
dvander@404: 
dvander@404: 		/**
dvander@404: 		 * @brief Creates a new user entry.
dvander@404: 		 *
dvander@404: 		 * @param name		Name for this entry (does not have to be unique).
dvander@404: 		 *					Specify NULL for an anonymous admin.
dvander@404: 		 * @return			A new AdminId index.
dvander@404: 		 */
dvander@404: 		virtual AdminId CreateAdmin(const char *name) =0;
dvander@404: 
dvander@404: 		/**
dvander@404: 		 * @brief Gets an admin's user name.
dvander@404: 		 *
dvander@404: 		 * @param id		AdminId index for this admin.
dvander@404: 		 * @return			A string containing the admin's name, or NULL
dvander@404: 		 *					if the admin was created anonymously.
dvander@404: 		 */
dvander@404: 		virtual const char *GetAdminName(AdminId id) =0;
dvander@404: 
dvander@404: 		/**
dvander@404: 		 * @brief Binds a user entry to a particular auth method.
dvander@404: 		 * This bind must be unique.
dvander@404: 		 *
dvander@404: 		 * @param id		AdminId index of the admin.
dvander@404: 		 * @param auth		Auth method to use.
dvander@404: 		 * @param ident		Identity string to bind to.
dvander@404: 		 * @return			True on success, false if auth method was not found,
dvander@404: 		 *					id was invalid, or ident was already taken.
dvander@404: 		 */
dvander@404: 		virtual bool BindAdminIdentity(AdminId id, const char *auth, const char *ident) =0;
dvander@404: 
dvander@404: 		/**
dvander@404: 		 * @brief Sets whether or not a flag is enabled on an admin.
dvander@404: 		 *
dvander@404: 		 * @param id		AdminId index of the admin.
dvander@404: 		 * @param flag		Admin flag to use.
dvander@404: 		 * @param enabled	True to enable, false to disable.
dvander@404: 		 */
dvander@404: 		virtual void SetAdminFlag(AdminId id, AdminFlag flag, bool enabled) =0;
dvander@404: 
dvander@404: 		/**
dvander@404: 		 * @brief Returns whether or not a flag is enabled on an admin.
dvander@404: 		 *
dvander@404: 		 * @param id		AdminId index of the admin.
dvander@404: 		 * @param flag		Admin flag to use.
dvander@404: 		 * @param mode		Access mode to check.
dvander@404: 		 * @return			True if enabled, false otherwise.
dvander@404: 		 */
dvander@404: 		virtual bool GetAdminFlag(AdminId id, AdminFlag flag, AccessMode mode) =0;
dvander@404: 
dvander@404: 		/**
dvander@404: 		 * @brief Returns a bitarray of flags enabled on an admin.
dvander@404: 		 *
dvander@404: 		 * @param id		AdminId index of the admin.
dvander@404: 		 * @param flag		Array to store flag bits in.
dvander@404: 		 * @param total		Maximum size of the flag array.
dvander@404: 		 * @param mode		Access mode to use.
dvander@404: 		 * @return			Number of flags written to the array.
dvander@404: 		 */
dvander@404: 		virtual unsigned int GetAdminFlags(AdminId id, 
dvander@404: 										   bool flags[], 
dvander@404: 										   unsigned int total, 
dvander@404: 										   AccessMode mode) =0;
dvander@404: 
dvander@404: 		/**
dvander@404: 		 * @brief Adds a group to an admin's inherited group list.  
dvander@404: 		 * Any flags the group has will be added to the admin's effective flags.
dvander@404: 		 *
dvander@404: 		 * @param id		AdminId index of the admin.
dvander@404: 		 * @param gid		GroupId index of the group.
dvander@404: 		 * @return			True on success, false on invalid input or duplicate membership.
dvander@404: 		 */
dvander@404: 		virtual bool AdminInheritGroup(AdminId id, GroupId gid) =0;
dvander@404: 
dvander@404: 		/**
dvander@404: 		 * @brief Returns the number of groups this admin is a member of.
dvander@404: 		 * 
dvander@404: 		 * @param id		AdminId index of the admin.
dvander@404: 		 * @return			Number of groups this admin is a member of.
dvander@404: 		 */
dvander@404: 		virtual unsigned int GetAdminGroupCount(AdminId id) =0;
dvander@404: 
dvander@404: 		/**
dvander@404: 		 * @brief Returns group information from an admin.
dvander@404: 		 *
dvander@404: 		 * @param id		AdminId index of the admin.
dvander@404: 		 * @param index		Group number to retrieve, from 0 to N-1, where N
dvander@404: 		 *					is the value of GetAdminGroupCount(id).
dvander@404: 		 * @param name		Optional pointer to store the group's name.
dvander@404: 		 * @return			A GroupId index and a name pointer, or
dvander@404: 		 *					INVALID_GROUP_ID and NULL if an error occurred.
dvander@404: 		 */
dvander@404: 		virtual GroupId GetAdminGroup(AdminId id, unsigned int index, const char **name) =0;
dvander@404: 		
dvander@404: 		/**
dvander@404: 		 * @brief Sets a password on an admin.
dvander@404: 		 *
dvander@404: 		 * @param id		AdminId index of the admin.
dvander@404: 		 * @param passwd	String containing the password.
dvander@404: 		 */
dvander@404: 		virtual void SetAdminPassword(AdminId id, const char *password) =0;
dvander@404: 
dvander@404: 		/**
dvander@404: 		 * @brief Gets an admin's password.
dvander@404: 		 *
dvander@404: 		 * @param id		AdminId index of the admin.
dvander@404: 		 * @return			Password of the admin, or NULL if none.
dvander@404: 		 */
dvander@404: 		virtual const char *GetAdminPassword(AdminId id) =0;
dvander@404: 		
dvander@404: 		/**
dvander@404: 		 * @brief Attempts to find an admin by an auth method and an identity.
dvander@404: 		 *
dvander@404: 		 * @param auth		Auth method to try.
dvander@404: 		 * @param identity	Identity string to look up.
dvander@404: 		 * @return			An AdminId index if found, INVALID_ADMIN_ID otherwise.
dvander@404: 		 */
dvander@404: 		virtual AdminId FindAdminByIdentity(const char *auth, const char *identity) =0;
dvander@404: 
dvander@404: 		/**
dvander@404: 		 * @brief Invalidates an admin from the cache so its resources can be re-used.
dvander@404: 		 *
dvander@404: 		 * @param id		AdminId index to invalidate.
dvander@404: 		 * @return			True on success, false otherwise.
dvander@404: 		 */
dvander@404: 		virtual bool InvalidateAdmin(AdminId id) =0;
dvander@335: 	};
ds@432: }
dvander@335: 
dvander@335: #endif //_INCLUDE_SOURCEMOD_ADMINISTRATION_SYSTEM_H_