dvander@374: /**
ds@475: * vim: set ts=4 :
ds@1330: * =============================================================================
ds@1947: * SourceMod (C)2004-2008 AlliedModders LLC. All rights reserved.
ds@1330: * =============================================================================
ds@1330: *
ds@1330: * This file is part of the SourceMod/SourcePawn SDK.
dvander@374: *
ds@1330: * This program is free software; you can redistribute it and/or modify it under
ds@1330: * the terms of the GNU General Public License, version 3.0, as published by the
ds@1330: * Free Software Foundation.
ds@1330: *
ds@1330: * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1330: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1330: * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
ds@1330: * details.
ds@1330: *
ds@1330: * You should have received a copy of the GNU General Public License along with
ds@1330: * this program. If not, see .
ds@1330: *
ds@1330: * As a special exception, AlliedModders LLC gives you permission to link the
ds@1330: * code of this program (as well as its derivative works) to "Half-Life 2," the
ds@1330: * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1330: * by the Valve Corporation. You must obey the GNU General Public License in
ds@1330: * all respects for all other code used. Additionally, AlliedModders LLC grants
ds@1330: * this exception to all derivative works. AlliedModders LLC defines further
ds@1330: * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1330: * or .
dvander@374: *
dvander@374: * Version: $Id$
dvander@374: */
dvander@374:
dvander@336: #if defined _admin_included
dvander@336: #endinput
dvander@336: #endif
dvander@336: #define _admin_included
dvander@336:
dvander@433: /**
dvander@433: * Access levels (flags) for admins.
dvander@433: */
dvander@336: enum AdminFlag
dvander@336: {
dvander@433: Admin_Reservation = 0, /**< Reserved slot */
dvander@433: Admin_Generic, /**< Generic admin abilities */
dvander@433: Admin_Kick, /**< Kick another user */
dvander@433: Admin_Ban, /**< Ban another user */
dvander@433: Admin_Unban, /**< Unban another user */
dvander@433: Admin_Slay, /**< Slay/kill/damage another user */
dvander@433: Admin_Changemap, /**< Change the map */
dvander@433: Admin_Convars, /**< Change basic convars */
dvander@433: Admin_Config, /**< Change configuration */
dvander@433: Admin_Chat, /**< Special chat privileges */
dvander@433: Admin_Vote, /**< Special vote privileges */
dvander@433: Admin_Password, /**< Set a server password */
dvander@433: Admin_RCON, /**< Use RCON */
dvander@433: Admin_Cheats, /**< Change sv_cheats and use its commands */
dvander@433: Admin_Root, /**< All access by default */
dvander@433: Admin_Custom1, /**< First custom flag type */
dvander@433: Admin_Custom2, /**< Second custom flag type */
dvander@433: Admin_Custom3, /**< Third custom flag type */
dvander@433: Admin_Custom4, /**< Fourth custom flag type */
dvander@433: Admin_Custom5, /**< Fifth custom flag type */
dvander@433: Admin_Custom6, /**< Sixth custom flag type */
dvander@336: /* --- */
dvander@336: };
dvander@336:
dvander@619: #define AdminFlags_TOTAL 21 /**< Total number of admin flags */
dvander@439:
dvander@433: /**
dvander@813: * @section Bitwise values definitions for admin flags.
dvander@433: */
dvander@433: #define ADMFLAG_RESERVATION (1<<0) /**< Convenience macro for Admin_Reservation as a FlagBit */
dvander@433: #define ADMFLAG_GENERIC (1<<1) /**< Convenience macro for Admin_Generic as a FlagBit */
dvander@433: #define ADMFLAG_KICK (1<<2) /**< Convenience macro for Admin_Kick as a FlagBit */
dvander@433: #define ADMFLAG_BAN (1<<3) /**< Convenience macro for Admin_Ban as a FlagBit */
dvander@433: #define ADMFLAG_UNBAN (1<<4) /**< Convenience macro for Admin_Unban as a FlagBit */
dvander@433: #define ADMFLAG_SLAY (1<<5) /**< Convenience macro for Admin_Slay as a FlagBit */
dvander@433: #define ADMFLAG_CHANGEMAP (1<<6) /**< Convenience macro for Admin_Changemap as a FlagBit */
dvander@433: #define ADMFLAG_CONVARS (1<<7) /**< Convenience macro for Admin_Convars as a FlagBit */
dvander@433: #define ADMFLAG_CONFIG (1<<8) /**< Convenience macro for Admin_Config as a FlagBit */
dvander@433: #define ADMFLAG_CHAT (1<<9) /**< Convenience macro for Admin_Chat as a FlagBit */
dvander@433: #define ADMFLAG_VOTE (1<<10) /**< Convenience macro for Admin_Vote as a FlagBit */
dvander@433: #define ADMFLAG_PASSWORD (1<<11) /**< Convenience macro for Admin_Password as a FlagBit */
dvander@433: #define ADMFLAG_RCON (1<<12) /**< Convenience macro for Admin_RCON as a FlagBit */
dvander@433: #define ADMFLAG_CHEATS (1<<13) /**< Convenience macro for Admin_Cheats as a FlagBit */
dvander@433: #define ADMFLAG_ROOT (1<<14) /**< Convenience macro for Admin_Root as a FlagBit */
dvander@433: #define ADMFLAG_CUSTOM1 (1<<15) /**< Convenience macro for Admin_Custom1 as a FlagBit */
dvander@433: #define ADMFLAG_CUSTOM2 (1<<16) /**< Convenience macro for Admin_Custom2 as a FlagBit */
dvander@433: #define ADMFLAG_CUSTOM3 (1<<17) /**< Convenience macro for Admin_Custom3 as a FlagBit */
dvander@433: #define ADMFLAG_CUSTOM4 (1<<18) /**< Convenience macro for Admin_Custom4 as a FlagBit */
dvander@433: #define ADMFLAG_CUSTOM5 (1<<19) /**< Convenience macro for Admin_Custom5 as a FlagBit */
dvander@433: #define ADMFLAG_CUSTOM6 (1<<20) /**< Convenience macro for Admin_Custom6 as a FlagBit */
dvander@433:
dvander@619: /**
dvander@619: * @endsection
dvander@619: */
dvander@619:
dvander@619: /**
dvander@619: * @section Hardcoded authentication methods
dvander@619: */
dvander@813: #define AUTHMETHOD_STEAM "steam" /**< SteamID based authentication */
dvander@813: #define AUTHMETHOD_IP "ip" /**< IP based authentication */
dvander@813: #define AUTHMETHOD_NAME "name" /**< Name based authentication */
dvander@433:
dvander@619: /**
dvander@619: * @endsection
dvander@619: */
dvander@619:
dvander@619: /**
dvander@813: * Access override types.
dvander@619: */
dvander@336: enum OverrideType
dvander@336: {
dvander@813: Override_Command = 1, /**< Command */
dvander@813: Override_CommandGroup, /**< Command group */
dvander@336: };
dvander@336:
dvander@619: /**
dvander@813: * Access override rules.
dvander@619: */
dvander@336: enum OverrideRule
dvander@336: {
dvander@336: Command_Deny = 0,
dvander@336: Command_Allow = 1,
dvander@336: };
dvander@336:
dvander@619: /**
dvander@1403: * DEPRECATED, do not use.
dvander@619: */
dvander@336: enum ImmunityType
dvander@336: {
dvander@1403: Immunity_Default = 1, /**< Deprecated. */
dvander@1403: Immunity_Global, /**< Deprecated. */
dvander@336: };
dvander@336:
dvander@813: /**
dvander@813: * Identifies a unique entry in the group permissions cache. These are not Handles.
dvander@813: */
dvander@336: enum GroupId
dvander@336: {
dvander@813: INVALID_GROUP_ID = -1, /**< An invalid/nonexistant group */
dvander@336: };
dvander@336:
dvander@813: /**
dvander@813: * Identifies a unique entry in the admin permissions cache. These are not Handles.
dvander@813: */
dvander@420: enum AdminId
dvander@420: {
dvander@813: INVALID_ADMIN_ID = -1, /**< An invalid/nonexistant admin */
dvander@420: };
dvander@420:
dvander@813: /**
dvander@813: * Methods of computing access permissions.
dvander@813: */
dvander@436: enum AdmAccessMode
dvander@436: {
dvander@436: Access_Real, /**< Access the user has inherently */
dvander@436: Access_Effective, /**< Access the user has from their groups */
dvander@436: };
dvander@436:
dvander@438: /**
dvander@812: * Represents the various cache regions.
dvander@438: */
dvander@438: enum AdminCachePart
dvander@438: {
dvander@438: AdminCache_Overrides = 0, /**< Global overrides */
dvander@438: AdminCache_Groups = 1, /**< All groups (automatically invalidates admins too) */
dvander@438: AdminCache_Admins = 2, /**< All admins */
dvander@438: };
dvander@336:
dvander@336: /**
dvander@438: * Called when part of the cache which needs to be rebuilt.
dvander@336: *
ds@475: * @param part Part of the admin cache to rebuild.
dvander@336: */
dvander@438: forward OnRebuildAdminCache(AdminCachePart:part);
dvander@336:
dvander@336: /**
dvander@336: * Tells the admin system to dump a portion of the cache.
dvander@336: *
dvander@438: * @param part Part of the cache to dump. Specifying groups also dumps admins.
dvander@336: * @param rebuild If true, the rebuild forwards will fire.
dvander@336: * @noreturn
dvander@336: */
dvander@438: native DumpAdminCache(AdminCachePart:part, bool:rebuild);
dvander@336:
dvander@336: /**
dvander@336: * Adds a global command flag override. Any command registered with this name
dvander@336: * will assume the new flag. This is applied retroactively as well.
dvander@336: *
dvander@336: * @param cmd String containing command name (case sensitive).
dvander@336: * @param type Override type (specific command or group).
dvander@433: * @param flags New admin flag.
dvander@336: * @noreturn
dvander@336: */
dvander@433: native AddCommandOverride(const String:cmd[], OverrideType:type, flags);
dvander@336:
dvander@336: /**
dvander@336: * Returns a command override.
dvander@336: *
dvander@336: * @param cmd String containing command name (case sensitive).
dvander@336: * @param type Override type (specific command or group).
dvander@433: * @param flags By-reference cell to store the flag (undefined if not found).
dvander@336: * @return True if there is an override, false otherwise.
dvander@336: */
dvander@433: native bool:GetCommandOverride(const String:cmd[], OverrideType:type, &flags);
dvander@336:
dvander@336: /**
dvander@336: * Unsets a command override.
dvander@336: *
dvander@336: * @param cmd String containing command name (case sensitive).
dvander@336: * @param type Override type (specific command or group).
dvander@336: * @noreturn
dvander@336: */
dvander@336: native UnsetCommandOverride(const String:cmd[], OverrideType:type);
dvander@336:
dvander@336: /**
dvander@336: * Adds a new group. Name must be unique.
dvander@336: *
dvander@336: * @param group_name String containing the group name.
dvander@336: * @return A new group id, INVALID_GROUP_ID if it already exists.
dvander@336: */
dvander@336: native GroupId:CreateAdmGroup(const String:group_name[]);
dvander@336:
dvander@336: /**
dvander@812: * Finds a group by name.
dvander@336: *
dvander@336: * @param group_name String containing the group name.
dvander@336: * @return A group id, or INVALID_GROUP_ID if not found.
dvander@336: */
dvander@421: native GroupId:FindAdmGroup(const String:group_name[]);
dvander@336:
dvander@336: /**
dvander@336: * Adds or removes a flag from a group's flag set.
dvander@336: * @note These are called "add flags" because they add to a user's flags.
dvander@336: *
dvander@336: * @param id Group id.
dvander@336: * @param flag Admin flag to toggle.
dvander@336: * @param enabled True to set the flag, false to unset/disable.
dvander@336: * @noreturn
dvander@336: */
dvander@336: native SetAdmGroupAddFlag(GroupId:id, AdminFlag:flag, bool:enabled);
dvander@336:
dvander@336: /**
dvander@336: * Gets the set value of an add flag on a group's flag set.
dvander@336: * @note These are called "add flags" because they add to a user's flags.
dvander@336: *
dvander@336: * @param id Group id.
dvander@336: * @param flag Admin flag to retrieve.
dvander@336: * @return True if enabled, false otherwise,
dvander@336: */
dvander@336: native bool:GetAdmGroupAddFlag(GroupId:id, AdminFlag:flag);
dvander@336:
dvander@336: /**
dvander@336: * Returns the flag set that is added to a user from their group.
dvander@336: * @note These are called "add flags" because they add to a user's flags.
dvander@336: *
dvander@336: * @param id GroupId of the group.
dvander@433: * @return Bitstring containing the flags enabled.
dvander@336: */
dvander@433: native GetAdmGroupAddFlags(GroupId:id);
dvander@336:
dvander@336: /**
dvander@1403: * @deprecated Functionality removed.
dvander@336: */
dvander@1403: #pragma deprecated Use SetAdmGroupImmunityLevel() instead.
dvander@336: native SetAdmGroupImmunity(GroupId:id, ImmunityType:type, bool:enabled);
dvander@336:
dvander@336: /**
dvander@1403: * @deprecated Functionality removed.
dvander@336: */
dvander@1403: #pragma deprecated Use GetAdmGroupImmunityLevel() instead.
dvander@336: native bool:GetAdmGroupImmunity(GroupId:id, ImmunityType:type);
dvander@336:
dvander@336: /**
dvander@336: * Adds immunity to a specific group.
dvander@336: *
dvander@336: * @param id Group id.
dvander@336: * @param other_id Group id to receive immunity to.
dvander@336: * @noreturn
dvander@336: */
dvander@336: native SetAdmGroupImmuneFrom(GroupId:id, GroupId:other_id);
dvander@336:
dvander@336: /**
dvander@336: * Returns the number of specific group immunities.
dvander@336: *
dvander@336: * @param id Group id.
dvander@336: * @return Number of group immunities.
dvander@336: */
dvander@336: native GetAdmGroupImmuneCount(GroupId:id);
dvander@336:
dvander@336: /**
dvander@336: * Returns a group that this group is immune to given an index.
dvander@336: *
dvander@336: * @param id Group id.
dvander@336: * @param number Index from 0 to N-1, from GetAdmGroupImmuneCount().
dvander@336: * @return GroupId that this group is immune to, or INVALID_GROUP_ID on failure.
dvander@336: */
dvander@336: native GroupId:GetAdmGroupImmuneFrom(GroupId:id, number);
dvander@336:
dvander@336: /**
dvander@336: * Adds a group-specific override type.
dvander@336: *
dvander@336: * @param id Group id.
dvander@336: * @param name String containing command name (case sensitive).
dvander@336: * @param type Override type (specific command or group).
dvander@336: * @param rule Override allow/deny setting.
dvander@336: * @noreturn
dvander@336: */
dvander@336: native AddAdmGroupCmdOverride(GroupId:id, const String:name[], OverrideType:type, OverrideRule:rule);
dvander@336:
dvander@336: /**
dvander@336: * Retrieves a group-specific command override.
dvander@336: *
dvander@336: * @param id Group id.
dvander@336: * @param name String containing command name (case sensitive).
dvander@336: * @param type Override type (specific command or group).
dvander@336: * @param rule Optional pointer to store allow/deny setting.
dvander@336: * @return True if an override exists, false otherwise.
dvander@336: */
dvander@336: native bool:GetAdmGroupCmdOverride(GroupId:id, const String:name[], OverrideType:type, &OverrideRule:rule);
dvander@436:
dvander@436: /**
dvander@436: * Registers an authentication identity type. You normally never need to call this except for
dvander@436: * very specific systems.
dvander@436: *
dvander@436: * @param codename Codename to use for your authentication type.
dvander@436: * @noreturn
dvander@436: */
dvander@436: native RegisterAuthIdentType(const String:name[]);
dvander@436:
dvander@436: /**
dvander@436: * Creates a new admin entry in the permissions cache.
dvander@436: *
dvander@436: * @param name Name for this entry (does not have to be unique).
dvander@436: * Specify an empty string for an anonymous admin.
dvander@436: */
dvander@436: native AdminId:CreateAdmin(const String:name[]="");
dvander@436:
dvander@436: /**
dvander@436: * Retrieves an admin's user name as made with CreateAdmin().
dvander@813: *
dvander@619: * @note This function can return UTF-8 strings, and will safely chop UTF-8 strings.
dvander@436: *
dvander@436: * @param id AdminId of the admin.
dvander@436: * @param name String buffer to store name.
dvander@436: * @param maxlength Maximum size of string buffer.
dvander@436: * @return Number of bytes written.
dvander@436: */
asherkin@3531: native GetAdminUsername(AdminId:id, String:name[], maxlength);
dvander@436:
dvander@436: /**
dvander@436: * Binds an admin to an identity for fast lookup later on. The bind must be unique.
dvander@436: *
dvander@436: * @param id AdminId of the admin.
dvander@436: * @param auth Auth method to use, predefined or from RegisterAuthIdentType().
dvander@436: * @param ident String containing the arbitrary, unique identity.
dvander@436: * @return True on success, false if the auth method was not found,
dvander@436: * or ident was already taken.
dvander@436: */
dvander@436: native bool:BindAdminIdentity(AdminId:id, const String:auth[], const String:ident[]);
dvander@436:
dvander@436: /**
dvander@436: * Sets whether or not a flag is enabled on an admin.
dvander@436: *
ds@475: * @param id AdminId index of the admin.
ds@475: * @param flag Admin flag to use.
ds@475: * @param enabled True to enable, false to disable.
dvander@436: * @noreturn
dvander@436: */
dvander@436: native SetAdminFlag(AdminId:id, AdminFlag:flag, bool:enabled);
dvander@436:
dvander@436: /**
dvander@436: * Returns whether or not a flag is enabled on an admin.
dvander@436: *
ds@475: * @param id AdminId index of the admin.
ds@475: * @param flag Admin flag to use.
ds@475: * @param mode Access mode to check.
ds@475: * @return True if enabled, false otherwise.
dvander@436: */
dvander@1374: native bool:GetAdminFlag(AdminId:id, AdminFlag:flag, AdmAccessMode:mode=Access_Effective);
dvander@436:
dvander@436: /**
dvander@436: * Returns the bitstring of access flags on an admin.
dvander@436: *
ds@475: * @param id AdminId index of the admin.
ds@475: * @param mode Access mode to use.
ds@475: * @return A bitstring containing which flags are enabled.
dvander@436: */
dvander@436: native GetAdminFlags(AdminId:id, AdmAccessMode:mode);
dvander@436:
dvander@436: /**
dvander@436: * Adds a group to an admin's inherited group list. Any flags the group has
dvander@436: * will be added to the admin's effective flags.
dvander@436: *
ds@475: * @param id AdminId index of the admin.
ds@475: * @param gid GroupId index of the group.
ds@475: * @return True on success, false on invalid input or duplicate membership.
dvander@436: */
dvander@436: native bool:AdminInheritGroup(AdminId:id, GroupId:gid);
dvander@436:
dvander@436: /**
dvander@436: * Returns the number of groups this admin is a member of.
dvander@436: *
ds@475: * @param id AdminId index of the admin.
ds@475: * @return Number of groups this admin is a member of.
dvander@436: */
dvander@436: native GetAdminGroupCount(AdminId:id);
dvander@436:
dvander@436: /**
dvander@436: * Returns group information from an admin.
dvander@436: *
ds@475: * @param id AdminId index of the admin.
ds@475: * @param index Group number to retrieve, from 0 to N-1, where N
ds@475: * is the value of GetAdminGroupCount(id).
ds@475: * @param name Buffer to store the group's name.
ds@475: * Note: This will safely chop UTF-8 strings.
ds@475: * @param maxlength Maximum size of the output name buffer.
ds@475: * @return A GroupId index and a name pointer, or
ds@475: * INVALID_GROUP_ID and NULL if an error occurred.
dvander@436: */
dvander@814: native GroupId:GetAdminGroup(AdminId:id, index, const String:name[], maxlength);
dvander@436:
dvander@436: /**
dvander@436: * Sets a password on an admin.
dvander@436: *
ds@475: * @param id AdminId index of the admin.
ds@475: * @param passwd String containing the password.
dvander@436: * @noreturn
dvander@436: */
dvander@436: native SetAdminPassword(AdminId:id, const String:password[]);
dvander@436:
dvander@436: /**
dvander@436: * Gets an admin's password.
dvander@436: *
ds@475: * @param id AdminId index of the admin.
ds@475: * @param name Optional buffer to store the admin's password.
ds@475: * @param maxlength Maximum size of the output name buffer.
ds@475: * Note: This will safely chop UTF-8 strings.
ds@475: * @return True if there was a password set, false otherwise.
dvander@436: */
dvander@436: native bool:GetAdminPassword(AdminId:id, const String:buffer[]="", maxlength=0);
dvander@436:
dvander@436: /**
dvander@436: * Attempts to find an admin by an auth method and an identity.
dvander@436: *
ds@475: * @param auth Auth method to try.
ds@475: * @param identity Identity string to look up.
ds@475: * @return An AdminId index if found, INVALID_ADMIN_ID otherwise.
dvander@436: */
dvander@436: native AdminId:FindAdminByIdentity(const String:auth[], const String:identity[]);
dvander@436:
dvander@436: /**
dvander@436: * Removes an admin entry from the cache.
dvander@813: *
dvander@619: * @note This will remove any bindings to a specific user.
dvander@436: *
ds@475: * @param id AdminId index to remove/invalidate.
ds@475: * @return True on success, false otherwise.
dvander@436: */
dvander@436: native bool:RemoveAdmin(AdminId:id);
dvander@436:
dvander@436: /**
dvander@436: * Converts a flag bit string to a bit array.
dvander@436: *
ds@475: * @param bits Bit string containing the flags.
ds@475: * @param array Array to write the flags to. Enabled flags will be 'true'.
ds@475: * @param maxSize Maximum number of flags the array can store.
ds@475: * @return Number of flags written.
dvander@436: */
dvander@436: native FlagBitsToBitArray(bits, bool:array[], maxSize);
dvander@436:
dvander@436: /**
dvander@436: * Converts a flag array to a bit string.
dvander@436: *
ds@475: * @param array Array containing true or false for each AdminFlag.
ds@475: * @param maxSize Maximum size of the flag array.
ds@475: * @return A bit string composed of the array bits.
dvander@436: */
dvander@436: native FlagBitArrayToBits(const bool:array[], maxSize);
dvander@436:
dvander@436: /**
dvander@436: * Converts an array of flags to bits.
dvander@436: *
ds@475: * @param array Array containing flags that are enabled.
ds@475: * @param numFlags Number of flags in the array.
ds@475: * @return A bit string composed of the array flags.
dvander@436: */
dvander@814: native FlagArrayToBits(const AdminFlag:array[], numFlags);
dvander@436:
dvander@436: /**
dvander@436: * Converts a bit string to an array of flags.
dvander@436: *
ds@475: * @param bits Bit string containing the flags.
ds@475: * @param array Output array to write flags.
ds@475: * @param maxSize Maximum size of the flag array.
ds@475: * @return Number of flags written.
dvander@436: */
dvander@814: native FlagBitsToArray(bits, AdminFlag:array[], maxSize);
dvander@436:
dvander@540: /**
dvander@1298: * Finds a flag by its string name.
dvander@1298: *
dvander@1298: * @param name Flag name (like "kick"), case sensitive.
dvander@1298: * @param flag Variable to store flag in.
dvander@1298: * @return True on success, false if not found.
dvander@1298: */
dvander@1298: native bool:FindFlagByName(const String:name[], &AdminFlag:flag);
dvander@1298:
dvander@1298: /**
dvander@1298: * Finds a flag by a given character.
dvander@1298: *
dvander@1298: * @param c Flag ASCII character/token.
dvander@1298: * @param flag Variable to store flag in.
dvander@1298: * @return True on success, false if not found.
dvander@1298: */
dvander@1298: native bool:FindFlagByChar(c, &AdminFlag:flag);
dvander@1298:
dvander@1298: /**
kaspars@3055: * Finds a flag char by a gived admin flag.
kaspars@3055: *
kaspars@3055: * @param flag Flag to look up.
kaspars@3055: * @param c Variable to store flag char.
kaspars@3055: * @return True on success, false if not found.
kaspars@3055: */
kaspars@3055: native bool:FindFlagChar(AdminFlag:flag, &c);
kaspars@3055:
kaspars@3055: /**
dvander@1298: * Converts a string of flag characters to a bit string.
dvander@1298: *
dvander@1298: * @param flags Flag ASCII string.
dvander@1298: * @param numchars Optional variable to store the number of bytes read.
dvander@1298: * @return Bit string of ADMFLAG values.
dvander@1298: */
dvander@1298: native ReadFlagString(const String:flags[], &numchars=0);
dvander@1298:
dvander@1298: /**
dvander@540: * Tests whether one admin can target another.
dvander@540: *
dvander@1403: * The hueristics for this check are as follows:
dvander@1403: * 0. If the targeting AdminId is INVALID_ADMIN_ID, targeting fails.
dvander@1403: * 1. If the targeted AdminId is INVALID_ADMIN_ID, targeting succeeds.
dvander@1403: * 2. If the targeted AdminId is the same as the targeting AdminId,
dvander@1403: * (self) targeting succeeds.
dvander@1403: * 3. If the targeting admin is root, targeting succeeds.
dvander@1403: * 4. If the targeted admin has access higher (as interpreted by
dvander@1403: * (sm_immunity_mode) than the targeting admin, then targeting fails.
dvander@1403: * 5. If the targeted admin has specific immunity from the
dvander@1403: * targeting admin via group immunities, targeting fails.
dvander@1403: * 6. Targeting succeeds.
dvander@1403: *
dvander@540: * @param admin Admin doing the targetting (may be INVALID_ADMIN_ID).
dvander@540: * @param target Target admin (may be INVALID_ADMIN_ID).
dvander@540: * @return True if targetable, false if immune.
dvander@540: */
dvander@540: native CanAdminTarget(AdminId:admin, AdminId:target);
dvander@436:
dvander@540: /**
dvander@646: * Creates an admin auth method. This does not need to be called more than once
dvander@646: * per method, ever.
dvander@646: *
dvander@646: * @param method Name of the authentication method.
dvander@646: * @return True on success, false on failure.
dvander@646: */
dvander@646: native bool:CreateAuthMethod(const String:method[]);
dvander@646:
dvander@646: /**
dvander@1403: * Sets a group's immunity level.
dvander@1403: *
dvander@1403: * @param gid Group Id.
dvander@1403: * @param level Immunity level value.
dvander@1403: * @return Old immunity level value.
dvander@1403: */
dvander@1403: native SetAdmGroupImmunityLevel(GroupId:gid, level);
dvander@1403:
dvander@1403: /**
dvander@1403: * Gets a group's immunity level (defaults to 0).
dvander@1403: *
dvander@1403: * @param gid Group Id.
dvander@1403: * @return Immunity level value.
dvander@1403: */
dvander@1403: native GetAdmGroupImmunityLevel(GroupId:gid);
dvander@1403:
dvander@1403: /**
dvander@1403: * Sets an admin's immunity level.
dvander@1403: *
dvander@1403: * @param id Admin Id.
dvander@1403: * @param level Immunity level value.
dvander@1403: * @return Old immunity level value.
dvander@1403: */
dvander@1403: native SetAdminImmunityLevel(AdminId:id, level);
dvander@1403:
dvander@1403: /**
dvander@1403: * Gets an admin's immunity level.
dvander@1403: *
dvander@1403: * @param id Admin Id.
dvander@1403: * @return Immunity level value.
dvander@1403: */
dvander@1403: native GetAdminImmunityLevel(AdminId:id);
dvander@1403:
dvander@1403: /**
dvander@540: * Converts a flag to its single bit.
dvander@540: *
dvander@540: * @param flag Flag to convert.
dvander@540: * @return Bit representation of the flag.
dvander@540: */
dvander@436: stock FlagToBit(AdminFlag:flag)
dvander@436: {
dvander@436: return (1<<_:flag);
dvander@436: }
dvander@436:
dvander@540: /**
dvander@540: * Converts a bit to an AdminFlag.
dvander@540: *
dvander@540: * @param bit Bit to convert.
dvander@540: * @param flag Stores the converted flag by reference.
dvander@540: * @return True on success, false otherwise.
dvander@540: */
dvander@436: stock bool:BitToFlag(bit, &AdminFlag:flag)
dvander@436: {
dvander@436: new AdminFlag:array[1];
dvander@436:
dvander@436: if (FlagBitsToArray(bit, array, 1))
dvander@436: {
dvander@436: flag = array[0];
dvander@436: return true;
dvander@436: }
dvander@436:
dvander@436: return false;
dvander@436: }
dvander@813: