2a4cda0709
- Move permission check inside PurgeTask to perform it with OfflinePlayer objects instead of lowercase names - Move purge members into child "purge" package - Unify online and offline default permission behavior in DefaultPermission
465 lines
15 KiB
Java
465 lines
15 KiB
Java
package fr.xephi.authme.permission;
|
|
|
|
import fr.xephi.authme.ConsoleLogger;
|
|
import fr.xephi.authme.initialization.Reloadable;
|
|
import fr.xephi.authme.permission.handlers.BPermissionsHandler;
|
|
import fr.xephi.authme.permission.handlers.GroupManagerHandler;
|
|
import fr.xephi.authme.permission.handlers.PermissionHandler;
|
|
import fr.xephi.authme.permission.handlers.PermissionHandlerException;
|
|
import fr.xephi.authme.permission.handlers.PermissionsBukkitHandler;
|
|
import fr.xephi.authme.permission.handlers.PermissionsExHandler;
|
|
import fr.xephi.authme.permission.handlers.VaultHandler;
|
|
import fr.xephi.authme.permission.handlers.ZPermissionsHandler;
|
|
import fr.xephi.authme.util.StringUtils;
|
|
import org.anjocaido.groupmanager.GroupManager;
|
|
import org.bukkit.OfflinePlayer;
|
|
import org.bukkit.Server;
|
|
import org.bukkit.command.CommandSender;
|
|
import org.bukkit.entity.Player;
|
|
import org.bukkit.plugin.Plugin;
|
|
import org.bukkit.plugin.PluginManager;
|
|
|
|
import javax.annotation.PostConstruct;
|
|
import javax.inject.Inject;
|
|
import java.util.ArrayList;
|
|
import java.util.List;
|
|
|
|
/**
|
|
* <p>
|
|
* PermissionsManager.
|
|
* </p><p>
|
|
* A permissions manager, to manage and use various permissions systems.
|
|
* This manager supports dynamic plugin hooking and various other features.
|
|
* </p><p>
|
|
* Written by Tim Visée.
|
|
* </p>
|
|
* @author Tim Visée, http://timvisee.com
|
|
* @version 0.3
|
|
*/
|
|
public class PermissionsManager implements Reloadable {
|
|
|
|
private final Server server;
|
|
private final PluginManager pluginManager;
|
|
|
|
/**
|
|
* The permission handler that is currently in use.
|
|
* Null if no permission system is hooked.
|
|
*/
|
|
private PermissionHandler handler = null;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param server Server instance
|
|
* @param pluginManager Bukkit plugin manager
|
|
*/
|
|
@Inject
|
|
public PermissionsManager(Server server, PluginManager pluginManager) {
|
|
this.server = server;
|
|
this.pluginManager = pluginManager;
|
|
}
|
|
|
|
/**
|
|
* Check if the permissions manager is currently hooked into any of the supported permissions systems.
|
|
*
|
|
* @return False if there isn't any permissions system used.
|
|
*/
|
|
public boolean isEnabled() {
|
|
return handler != null;
|
|
}
|
|
|
|
/**
|
|
* Setup and hook into the permissions systems.
|
|
*/
|
|
@PostConstruct
|
|
private void setup() {
|
|
// Loop through all the available permissions system types
|
|
for (PermissionsSystemType type : PermissionsSystemType.values()) {
|
|
try {
|
|
PermissionHandler handler = getPermissionHandler(type);
|
|
if (handler != null) {
|
|
// Show a success message and return
|
|
this.handler = handler;
|
|
ConsoleLogger.info("Hooked into " + type.getName() + "!");
|
|
return;
|
|
}
|
|
} catch (Exception ex) {
|
|
// An error occurred, show a warning message
|
|
ConsoleLogger.logException("Error while hooking into " + type.getName(), ex);
|
|
}
|
|
}
|
|
|
|
// No recognized permissions system found, show a message and return
|
|
ConsoleLogger.info("No supported permissions system found! Permissions are disabled!");
|
|
}
|
|
|
|
private PermissionHandler getPermissionHandler(PermissionsSystemType type) throws PermissionHandlerException {
|
|
// Try to find the plugin for the current permissions system
|
|
Plugin plugin = pluginManager.getPlugin(type.getPluginName());
|
|
|
|
if (plugin == null) {
|
|
return null;
|
|
}
|
|
|
|
// Make sure the plugin is enabled before hooking
|
|
if (!plugin.isEnabled()) {
|
|
ConsoleLogger.info("Not hooking into " + type.getName() + " because it's disabled!");
|
|
return null;
|
|
}
|
|
|
|
switch (type) {
|
|
case PERMISSIONS_EX:
|
|
return new PermissionsExHandler();
|
|
case ESSENTIALS_GROUP_MANAGER:
|
|
return new GroupManagerHandler((GroupManager) plugin);
|
|
case Z_PERMISSIONS:
|
|
return new ZPermissionsHandler();
|
|
case VAULT:
|
|
return new VaultHandler(server);
|
|
case B_PERMISSIONS:
|
|
return new BPermissionsHandler();
|
|
case PERMISSIONS_BUKKIT:
|
|
return new PermissionsBukkitHandler();
|
|
default:
|
|
throw new IllegalStateException("Unhandled permission type '" + type + "'");
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Break the hook with all permission systems.
|
|
*/
|
|
private void unhook() {
|
|
// Reset the current used permissions system
|
|
this.handler = null;
|
|
|
|
// Print a status message to the console
|
|
ConsoleLogger.info("Unhooked from Permissions!");
|
|
}
|
|
|
|
/**
|
|
* Reload the permissions manager, and re-hook all permission plugins.
|
|
*/
|
|
@Override
|
|
public void reload() {
|
|
// Unhook all permission plugins
|
|
unhook();
|
|
|
|
// Set up the permissions manager again
|
|
setup();
|
|
}
|
|
|
|
/**
|
|
* Method called when a plugin is being enabled.
|
|
*
|
|
* @param pluginName The name of the plugin being enabled.
|
|
*/
|
|
public void onPluginEnable(String pluginName) {
|
|
// Check if any known permissions system is enabling
|
|
if (PermissionsSystemType.isPermissionSystem(pluginName)) {
|
|
ConsoleLogger.info(pluginName + " plugin enabled, dynamically updating permissions hooks!");
|
|
setup();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Method called when a plugin is being disabled.
|
|
*
|
|
* @param pluginName The name of the plugin being disabled.
|
|
*/
|
|
public void onPluginDisable(String pluginName) {
|
|
// Check if any known permission system is being disabled
|
|
if (PermissionsSystemType.isPermissionSystem(pluginName)) {
|
|
ConsoleLogger.info(pluginName + " plugin disabled, updating hooks!");
|
|
setup();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return the permissions system that is hooked into.
|
|
*
|
|
* @return The permissions system, or null.
|
|
*/
|
|
public PermissionsSystemType getPermissionSystem() {
|
|
return isEnabled() ? handler.getPermissionSystem() : null;
|
|
}
|
|
|
|
/**
|
|
* Check if the command sender has permission for the given permissions node. If no permissions system is used or
|
|
* if the sender is not a player (e.g. console user), the player has to be OP in order to have the permission.
|
|
*
|
|
* @param sender The command sender.
|
|
* @param permissionNode The permissions node to verify.
|
|
*
|
|
* @return True if the sender has the permission, false otherwise.
|
|
*/
|
|
public boolean hasPermission(CommandSender sender, PermissionNode permissionNode) {
|
|
// Check if the permission node is null
|
|
if (permissionNode == null) {
|
|
return true;
|
|
}
|
|
|
|
// Return if the player is an Op if sender is console or no permission system in use
|
|
if (!(sender instanceof Player) || !isEnabled()) {
|
|
return permissionNode.getDefaultPermission().evaluate(sender);
|
|
}
|
|
|
|
Player player = (Player) sender;
|
|
return handler.hasPermission(player, permissionNode);
|
|
}
|
|
|
|
/**
|
|
* Check if a player has permission for the given permission node. This is for offline player checks. If no permissions
|
|
* system is used, then the player will not have permission.
|
|
*
|
|
* @param player The offline player
|
|
* @param permissionNode The permission node to verify
|
|
*
|
|
* @return true if the player has permission, false otherwise
|
|
*/
|
|
public boolean hasPermissionOffline(OfflinePlayer player, PermissionNode permissionNode) {
|
|
// Check if the permission node is null
|
|
if (permissionNode == null) {
|
|
return true;
|
|
}
|
|
|
|
if (!isEnabled()) {
|
|
return permissionNode.getDefaultPermission().evaluate(player);
|
|
}
|
|
|
|
return handler.hasPermissionOffline(player.getName(), permissionNode);
|
|
}
|
|
|
|
public boolean hasPermissionOffline(String name, PermissionNode permissionNode) {
|
|
if (permissionNode == null) {
|
|
return true;
|
|
}
|
|
if (!isEnabled()) {
|
|
return permissionNode.getDefaultPermission().evaluate(null);
|
|
}
|
|
|
|
return handler.hasPermissionOffline(name, permissionNode);
|
|
}
|
|
|
|
/**
|
|
* Check whether the current permissions system has group support.
|
|
* If no permissions system is hooked, false will be returned.
|
|
*
|
|
* @return True if the current permissions system supports groups, false otherwise.
|
|
*/
|
|
public boolean hasGroupSupport() {
|
|
// If no permissions system is used, return false
|
|
if (!isEnabled())
|
|
return false;
|
|
|
|
return handler.hasGroupSupport();
|
|
}
|
|
|
|
/**
|
|
* Get the permission groups of a player, if available.
|
|
*
|
|
* @param player The player.
|
|
*
|
|
* @return Permission groups, or an empty list if this feature is not supported.
|
|
*/
|
|
public List<String> getGroups(Player player) {
|
|
// If no permissions system is used, return an empty list
|
|
if (!isEnabled())
|
|
return new ArrayList<>();
|
|
|
|
return handler.getGroups(player);
|
|
}
|
|
|
|
/**
|
|
* Get the primary group of a player, if available.
|
|
*
|
|
* @param player The player.
|
|
*
|
|
* @return The name of the primary permission group. Or null.
|
|
*/
|
|
public String getPrimaryGroup(Player player) {
|
|
// If no permissions system is used, return an empty list
|
|
if (!isEnabled())
|
|
return null;
|
|
|
|
return handler.getPrimaryGroup(player);
|
|
}
|
|
|
|
/**
|
|
* Check whether the player is in the specified group.
|
|
*
|
|
* @param player The player.
|
|
* @param groupName The group name.
|
|
*
|
|
* @return True if the player is in the specified group, false otherwise.
|
|
* False is also returned if groups aren't supported by the used permissions system.
|
|
*/
|
|
public boolean inGroup(Player player, String groupName) {
|
|
// If no permissions system is used, return false
|
|
if (!isEnabled())
|
|
return false;
|
|
|
|
return handler.isInGroup(player, groupName);
|
|
}
|
|
|
|
/**
|
|
* Add the permission group of a player, if supported.
|
|
*
|
|
* @param player The player
|
|
* @param groupName The name of the group.
|
|
*
|
|
* @return True if succeed, false otherwise.
|
|
* False is also returned if this feature isn't supported for the current permissions system.
|
|
*/
|
|
public boolean addGroup(Player player, String groupName) {
|
|
if (StringUtils.isEmpty(groupName)) {
|
|
return false;
|
|
}
|
|
|
|
// If no permissions system is used, return false
|
|
if (!isEnabled()) {
|
|
return false;
|
|
}
|
|
|
|
return handler.addToGroup(player, groupName);
|
|
}
|
|
|
|
/**
|
|
* Add the permission groups of a player, if supported.
|
|
*
|
|
* @param player The player
|
|
* @param groupNames The name of the groups to add.
|
|
*
|
|
* @return True if succeed, false otherwise.
|
|
* False is also returned if this feature isn't supported for the current permissions system.
|
|
*/
|
|
public boolean addGroups(Player player, List<String> groupNames) {
|
|
// If no permissions system is used, return false
|
|
if (!isEnabled())
|
|
return false;
|
|
|
|
// Add each group to the user
|
|
boolean result = true;
|
|
for (String groupName : groupNames)
|
|
if (!addGroup(player, groupName))
|
|
result = false;
|
|
|
|
// Return the result
|
|
return result;
|
|
}
|
|
|
|
/**
|
|
* Remove the permission group of a player, if supported.
|
|
*
|
|
* @param player The player
|
|
* @param groupName The name of the group.
|
|
*
|
|
* @return True if succeed, false otherwise.
|
|
* False is also returned if this feature isn't supported for the current permissions system.
|
|
*/
|
|
public boolean removeGroup(Player player, String groupName) {
|
|
// If no permissions system is used, return false
|
|
if (!isEnabled())
|
|
return false;
|
|
|
|
return handler.removeFromGroup(player, groupName);
|
|
}
|
|
|
|
/**
|
|
* Remove the permission groups of a player, if supported.
|
|
*
|
|
* @param player The player
|
|
* @param groupNames The name of the groups to add.
|
|
*
|
|
* @return True if succeed, false otherwise.
|
|
* False is also returned if this feature isn't supported for the current permissions system.
|
|
*/
|
|
public boolean removeGroups(Player player, List<String> groupNames) {
|
|
// If no permissions system is used, return false
|
|
if (!isEnabled())
|
|
return false;
|
|
|
|
// Add each group to the user
|
|
boolean result = true;
|
|
for (String groupName : groupNames)
|
|
if (!removeGroup(player, groupName))
|
|
result = false;
|
|
|
|
// Return the result
|
|
return result;
|
|
}
|
|
|
|
/**
|
|
* Set the permission group of a player, if supported.
|
|
* This clears the current groups of the player.
|
|
*
|
|
* @param player The player
|
|
* @param groupName The name of the group.
|
|
*
|
|
* @return True if succeed, false otherwise.
|
|
* False is also returned if this feature isn't supported for the current permissions system.
|
|
*/
|
|
public boolean setGroup(Player player, String groupName) {
|
|
// If no permissions system is used, return false
|
|
if (!isEnabled())
|
|
return false;
|
|
|
|
return handler.setGroup(player, groupName);
|
|
}
|
|
|
|
/**
|
|
* Set the permission groups of a player, if supported.
|
|
* This clears the current groups of the player.
|
|
*
|
|
* @param player The player
|
|
* @param groupNames The name of the groups to set.
|
|
*
|
|
* @return True if succeed, false otherwise.
|
|
* False is also returned if this feature isn't supported for the current permissions system.
|
|
*/
|
|
public boolean setGroups(Player player, List<String> groupNames) {
|
|
// If no permissions system is used or if there's no group supplied, return false
|
|
if (!isEnabled() || groupNames.size() <= 0)
|
|
return false;
|
|
|
|
// Set the main group
|
|
if (!setGroup(player, groupNames.get(0)))
|
|
return false;
|
|
|
|
// Add the rest of the groups
|
|
boolean result = true;
|
|
for (int i = 1; i < groupNames.size(); i++) {
|
|
// Get the group name
|
|
String groupName = groupNames.get(0);
|
|
|
|
// Add this group
|
|
if (!addGroup(player, groupName))
|
|
result = false;
|
|
}
|
|
|
|
// Return the result
|
|
return result;
|
|
}
|
|
|
|
/**
|
|
* Remove all groups of the specified player, if supported.
|
|
* Systems like Essentials GroupManager don't allow all groups to be removed from a player, thus the user will stay
|
|
* in its primary group. All the subgroups are removed just fine.
|
|
*
|
|
* @param player The player to remove all groups from.
|
|
*
|
|
* @return True if succeed, false otherwise.
|
|
* False will also be returned if this feature isn't supported for the used permissions system.
|
|
*/
|
|
public boolean removeAllGroups(Player player) {
|
|
// If no permissions system is used, return false
|
|
if (!isEnabled())
|
|
return false;
|
|
|
|
// Get a list of current groups
|
|
List<String> groupNames = getGroups(player);
|
|
|
|
// Remove each group
|
|
return removeGroups(player, groupNames);
|
|
}
|
|
}
|