/**
* This file is part of Hercules.
* http://herc.ws - http://github.com/HerculesWS/Hercules
*
* Copyright (C) 2012-2015 Hercules Dev Team
* Copyright (C) Athena Dev Teams
*
* Hercules is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef MAP_PC_GROUPS_H
#define MAP_PC_GROUPS_H
#include "common/hercules.h"
#include "common/db.h"
/* Forward Declarations */
struct config_setting_t;
/// PC permissions
enum e_pc_permission {
PC_PERM_NONE = 0, // #0
PC_PERM_TRADE = 0x000001, // #1
PC_PERM_PARTY = 0x000002,
PC_PERM_ALL_SKILL = 0x000004,
PC_PERM_USE_ALL_EQUIPMENT = 0x000008,
PC_PERM_SKILL_UNCONDITIONAL = 0x000010,
PC_PERM_JOIN_ALL_CHAT = 0x000020,
PC_PERM_NO_CHAT_KICK = 0x000040,
PC_PERM_HIDE_SESSION = 0x000080,
PC_PERM_WHO_DISPLAY_AID = 0x000100,
PC_PERM_RECEIVE_HACK_INFO = 0x000200, // #10
PC_PERM_WARP_ANYWHERE = 0x000400,
PC_PERM_VIEW_HPMETER = 0x000800,
PC_PERM_VIEW_EQUIPMENT = 0x001000,
PC_PERM_USE_CHECK = 0x002000,
PC_PERM_USE_CHANGEMAPTYPE = 0x004000,
PC_PERM_USE_ALL_COMMANDS = 0x008000,
PC_PERM_RECEIVE_REQUESTS = 0x010000,
PC_PERM_SHOW_BOSS = 0x020000,
PC_PERM_DISABLE_PVM = 0x040000,
PC_PERM_DISABLE_PVP = 0x080000, // #20
PC_PERM_DISABLE_CMD_DEAD = 0x100000,
PC_PERM_HCHSYS_ADMIN = 0x200000,
PC_PERM_TRADE_BOUND = 0x400000,
PC_PERM_DISABLE_PICK_UP = 0x800000,
PC_PERM_DISABLE_STORE = 0x1000000,
PC_PERM_DISABLE_EXP = 0x2000000,
PC_PERM_DISABLE_SKILL_USAGE = 0x4000000,
};
// Cached config settings for quick lookup
struct GroupSettings {
unsigned int id; // groups.[].id
int level; // groups.[].level
char *name; // copy of groups.[].name
unsigned int e_permissions; // packed groups.[].permissions
bool log_commands; // groups.[].log_commands
int index; // internal index of the group (contiguous range starting at 0) [Ind]
/// Following are used/available only during config reading
struct config_setting_t *commands; // groups.[].commands
struct config_setting_t *permissions; // groups.[].permissions
struct config_setting_t *inherit; // groups.[].inherit
bool inheritance_done; // have all inheritance rules been evaluated?
struct config_setting_t *root; // groups.[]
};
typedef struct GroupSettings GroupSettings;
struct pc_groups_permission_table {
char *name;
unsigned int permission;
};
/* used by plugins to list permissions */
struct pc_groups_new_permission {
unsigned int pID;/* plugin identity (for the future unload during runtime support) */
char *name;/* aStrdup' of the permission name */
unsigned int *mask;/* pointer to the plugin val that will store the value of the mask */
};
struct pc_groups_interface {
/* */
DBMap* db; // id -> GroupSettings
DBMap* name_db; // name -> GroupSettings
/* */
struct pc_groups_permission_table *permissions;
unsigned char permission_count;
/* */
struct pc_groups_new_permission *HPMpermissions;
unsigned char HPMpermissions_count;
/* */
void (*init) (void);
void (*final) (void);
void (*reload) (void);
/* */
GroupSettings* (*get_dummy_group) (void);
bool (*exists) (int group_id);
GroupSettings* (*id2group) (int group_id);
bool (*has_permission) (GroupSettings *group, unsigned int permission);
bool (*should_log_commands) (GroupSettings *group);
const char* (*get_name) (GroupSettings *group);
int (*get_level) (GroupSettings *group);
int (*get_idx) (GroupSettings *group);
};
#ifdef HERCULES_CORE
void pc_groups_defaults(void);
#endif // HERCULES_CORE
HPShared struct pc_groups_interface *pcg;
#endif /* MAP_PC_GROUPS_H */
