onEnable: Log an error if NCP is not there or already enabled. Spaces.

This commit is contained in:
asofold 2015-03-22 01:24:18 +01:00
parent 94fd56e66f
commit 21d54b48a4

View File

@ -47,412 +47,421 @@ import fr.neatmonster.nocheatplus.hooks.NCPHookManager;
*
*/
public class CompatNoCheatPlus extends JavaPlugin implements Listener {
private static CompatNoCheatPlus instance = null;
private final Settings settings = new Settings();
/** Hooks registered with cncp */
private static final Set<Hook> registeredHooks = new HashSet<Hook>();
private final List<Hook> builtinHooks = new LinkedList<Hook>();
/**
* Flag if plugin is enabled.
*/
private static boolean enabled = false;
/**
* Experimental: static method to enable this plugin, only enables if it is not already enabled.
* @return
*/
public static boolean enableCncp(){
if (enabled) return true;
return enablePlugin("CompatNoCheatPlus");
}
/**
* Static method to enable a plugin (might also be useful for hooks).
* @param plgName
* @return
*/
public static boolean enablePlugin(String plgName) {
PluginManager pm = Bukkit.getPluginManager();
Plugin plugin = pm.getPlugin(plgName);
if (plugin == null) return false;
if (pm.isPluginEnabled(plugin)) return true;
pm.enablePlugin(plugin);
return true;
}
/**
* Static method to disable a plugin (might also be useful for hooks).
* @param plgName
* @return
*/
public static boolean disablePlugin(String plgName){
PluginManager pm = Bukkit.getPluginManager();
Plugin plugin = pm.getPlugin(plgName);
if (plugin == null) return false;
if (!pm.isPluginEnabled(plugin)) return true;
pm.disablePlugin(plugin);
return true;
}
/**
* Get the plugin instance.
* @return
*/
public static CompatNoCheatPlus getInstance(){
return instance;
}
/**
* API to add a hook. Adds the hook AND registers listeners if enabled. Also respects the configuration for preventing hooks.<br>
* If you want to not register the listeners use NCPHookManager.
* @param hook
* @return
*/
public static boolean addHook(Hook hook){
if (Settings.preventAddHooks.contains(hook.getHookName())){
Bukkit.getLogger().info("[cncp] Prevented adding hook: "+hook.getHookName() + " / " + hook.getHookVersion());
return false;
}
registeredHooks.add(hook);
if (enabled) registerListeners(hook);
boolean added = checkAddNCPHook(hook); // Add if plugin is present, otherwise queue for adding.
Bukkit.getLogger().info("[cncp] Registered hook"+(added?"":"(NCPHook might get added later)")+": "+hook.getHookName() + " / " + hook.getHookVersion());
return true;
}
/**
* If already added to NCP
* @param hook
* @return
*/
private static boolean checkAddNCPHook(Hook hook) {
PluginManager pm = Bukkit.getPluginManager();
Plugin plugin = pm.getPlugin("NoCheatPlus");
if (plugin == null || !pm.isPluginEnabled(plugin))
return false;
NCPHook ncpHook = hook.getNCPHook();
if (ncpHook != null)
NCPHookManager.addHook(hook.getCheckTypes(), ncpHook);
return true;
}
private static CompatNoCheatPlus instance = null;
/**
* Conveniently register the listeners, do not use if you add/added the hook with addHook.
* @param hook
* @return
*/
public static boolean registerListeners(Hook hook) {
if (!enabled) return false;
Listener[] listeners = hook.getListeners();
if (listeners != null){
// attempt to register events:
PluginManager pm = Bukkit.getPluginManager();
Plugin plg = pm.getPlugin("CompatNoCheatPlus");
if (plg == null) return false;
for (Listener listener : listeners) {
pm.registerEvents(listener, plg);
}
}
return true;
}
/**
* Called before loading settings, adds available hooks into a list, so they will be able to read config.
*/
private void setupBuiltinHooks() {
builtinHooks.clear();
// Might-fail hooks:
// Set speed
try{
builtinHooks.add(new me.asofold.bpl.cncp.hooks.generic.HookSetSpeed());
}
catch (Throwable t){}
// Citizens 2
try{
builtinHooks.add(new me.asofold.bpl.cncp.hooks.citizens2.HookCitizens2());
}
catch (Throwable t){}
// mcMMO
try{
builtinHooks.add(new me.asofold.bpl.cncp.hooks.mcmmo.HookmcMMO());
}
catch (Throwable t){}
// MagicSpells
try{
builtinHooks.add(new me.asofold.bpl.cncp.hooks.magicspells.HookMagicSpells());
}
catch (Throwable t){}
// Simple generic hooks
for (Hook hook : new Hook[]{
new HookPlayerClass(),
new HookBlockBreak(),
new HookBlockPlace(),
new HookInstaBreak(),
new HookEntityDamageByEntity(),
}){
builtinHooks.add(hook);
}
}
private final Settings settings = new Settings();
/**
* Add standard hooks if enabled.
*/
private void addAvailableHooks() {
// Add built in hooks:
for (Hook hook : builtinHooks){
boolean add = true;
if (hook instanceof ConfigurableHook){
if (!((ConfigurableHook)hook).isEnabled()) add = false;
}
if (add){
try{
addHook(hook);
}
catch (Throwable t){}
}
}
}
@Override
public void onEnable() {
enabled = false; // make sure
instance = this;
// (no cleanup)
// Settings:
settings.clear();
setupBuiltinHooks();
loadSettings();
// Register own listener:
final PluginManager pm = getServer().getPluginManager();
pm.registerEvents(this, this);
super.onEnable();
// Add Hooks:
addAvailableHooks(); // add before enable is set to not yet register listeners.
enabled = true;
// register all listeners:
for (Hook hook : registeredHooks){
registerListeners(hook);
}
// Start ticktask 2
getServer().getScheduler().scheduleSyncRepeatingTask(this, new TickTask2(), 1, 1);
// Finished.
getLogger().info(getDescription().getFullName() + " is enabled. Some hooks might get registered with NoCheatPlus later on.");
}
/** Hooks registered with cncp */
private static final Set<Hook> registeredHooks = new HashSet<Hook>();
public boolean loadSettings() {
final Set<String> oldForceEnableLater = new LinkedHashSet<String>();
oldForceEnableLater.addAll(settings.forceEnableLater);
// Read and apply config to settings:
File file = new File(getDataFolder() , "cncp.yml");
CompatConfig cfg = new NewConfig(file);
cfg.load();
boolean changed = false;
// General settings:
if (Settings.addDefaults(cfg)) changed = true;
settings.fromConfig(cfg);
// Settings for builtin hooks:
for (Hook hook : builtinHooks){
if (hook instanceof ConfigurableHook){
try{
ConfigurableHook cfgHook = (ConfigurableHook) hook;
if (cfgHook.updateConfig(cfg, "hooks.")) changed = true;
cfgHook.applyConfig(cfg, "hooks.");
}
catch (Throwable t){
getLogger().severe("[cncp] Hook failed to process config ("+hook.getHookName() +" / " + hook.getHookVersion()+"): " + t.getClass().getSimpleName() + ": "+t.getMessage());
t.printStackTrace();
}
}
}
// save back config if changed:
if (changed) cfg.save();
private final List<Hook> builtinHooks = new LinkedList<Hook>();
// Re-enable plugins that were not yet on the list:
Server server = getServer();
Logger logger = server.getLogger();
for (String plgName : settings.loadPlugins){
try{
if (CompatNoCheatPlus.enablePlugin(plgName)){
System.out.println("[cncp] Ensured that the following plugin is enabled: " + plgName);
}
}
catch (Throwable t){
logger.severe("[cncp] Failed to enable the plugin: " + plgName);
logger.severe(Utils.toString(t));
}
}
BukkitScheduler sched = server.getScheduler();
for (String plgName : settings.forceEnableLater){
if (!oldForceEnableLater.remove(plgName)) oldForceEnableLater.add(plgName);
}
if (!oldForceEnableLater.isEmpty()){
System.out.println("[cncp] Schedule task to re-enable plugins later...");
sched.scheduleSyncDelayedTask(this, new Runnable() {
@Override
public void run() {
// (Later maybe re-enabling this plugin could be added.)
// TODO: log levels !
for (String plgName : oldForceEnableLater){
try{
if (disablePlugin(plgName)){
if (enablePlugin(plgName)) System.out.println("[cncp] Re-enabled plugin: " + plgName);
else System.out.println("[cncp] Could not re-enable plugin: "+plgName);
}
else{
System.out.println("[cncp] Could not disable plugin (already disabled?): "+plgName);
}
}
catch(Throwable t){
// TODO: maybe log ?
}
}
}
});
}
return true;
}
/**
* Flag if plugin is enabled.
*/
private static boolean enabled = false;
@Override
public void onDisable() {
unregisterNCPHooks(); // Just in case.
enabled = false;
instance = null; // Set last.
super.onDisable();
}
protected int unregisterNCPHooks() {
// TODO: Clear list here !? Currently done externally...
int n = 0;
for (Hook hook : registeredHooks) {
String hookDescr = null;
try {
NCPHook ncpHook = hook.getNCPHook();
if (ncpHook != null){
hookDescr = ncpHook.getHookName() + ": " + ncpHook.getHookVersion();
NCPHookManager.removeHook(ncpHook);
n ++;
}
} catch (Throwable e)
{
if (hookDescr != null) {
// Some error with removing a hook.
getLogger().log(Level.WARNING, "Failed to unregister hook: " + hookDescr, e);
}
}
}
getLogger().info("[cncp] Removed "+n+" registered hooks from NoCheatPlus.");
registeredHooks.clear();
return n;
}
private int registerHooks() {
int n = 0;
for (Hook hook : registeredHooks){
// TODO: try catch
NCPHook ncpHook = hook.getNCPHook();
if (ncpHook == null) continue;
NCPHookManager.addHook(hook.getCheckTypes(), ncpHook);
n ++;
}
getLogger().info("[cncp] Added "+n+" registered hooks to NoCheatPlus.");
return n;
}
@EventHandler(priority = EventPriority.NORMAL)
void onPluginEnable(PluginEnableEvent event){
Plugin plugin = event.getPlugin();
if (!plugin.getName().equals("NoCheatPlus")) {
return;
}
// Register to rmeove hooks when NCP is disabling.
NCPAPIProvider.getNoCheatPlusAPI().addComponent(new DisableListener(){
@Override
public void onDisable() {
// Remove all registered cncp hooks:
unregisterNCPHooks();
}
});
if (registeredHooks.isEmpty()) {
return;
}
registerHooks();
}
/**
* Experimental: static method to enable this plugin, only enables if it is not already enabled.
* @return
*/
public static boolean enableCncp(){
if (enabled) return true;
return enablePlugin("CompatNoCheatPlus");
}
/* (non-Javadoc)
* @see org.bukkit.plugin.java.JavaPlugin#onCommand(org.bukkit.command.CommandSender, org.bukkit.command.Command, java.lang.String, java.lang.String[])
*/
@Override
public boolean onCommand(CommandSender sender, Command command, String label, String[] args) {
// Permission has already been checked.
sendInfo(sender);
return true;
}
/**
* Static method to enable a plugin (might also be useful for hooks).
* @param plgName
* @return
*/
public static boolean enablePlugin(String plgName) {
PluginManager pm = Bukkit.getPluginManager();
Plugin plugin = pm.getPlugin(plgName);
if (plugin == null) return false;
if (pm.isPluginEnabled(plugin)) return true;
pm.enablePlugin(plugin);
return true;
}
/**
* Send general version and hooks info.
* @param sender
*/
private void sendInfo(CommandSender sender) {
List<String> infos = new LinkedList<String>();
infos.add("---- Version infomation ----");
// Server
infos.add("#### Server ####");
infos.add(getServer().getVersion());
// Core plugins (NCP + cncp)
infos.add("#### Core plugins ####");
infos.add(getDescription().getFullName());
String temp = getOtherVersion("NoCheatPlus");
infos.add(temp.isEmpty() ? "NoCheatPlus is missing or not yet enabled." : temp);
infos.add("#### Typical plugin dependencies ####");
for (String pluginName : new String[]{
"mcMMO", "Citizens", "MachinaCraft", "MagicSpells",
// TODO: extend
}){
temp = getOtherVersion(pluginName);
if (!temp.isEmpty()) infos.add(temp);
}
// Hooks
infos.add("#### Registered hooks (cncp) ###");
for (final Hook hook : registeredHooks){
temp = hook.getHookName() + ": " + hook.getHookVersion();
if (hook instanceof ConfigurableHook){
temp += ((ConfigurableHook) hook).isEnabled() ? " (enabled)" : " (disabled)";
}
infos.add(temp);
}
// TODO: Registered hooks (ncp) ?
infos.add("#### Registered hooks (ncp) ####");
for (final NCPHook hook : NCPHookManager.getAllHooks()){
infos.add(hook.getHookName() + ": " + hook.getHookVersion());
}
final String[] a = new String[infos.size()];
infos.toArray(a);
sender.sendMessage(a);
}
/**
*
* @param pluginName Empty string or "name: version".
*/
private String getOtherVersion(String pluginName){
Plugin plg = getServer().getPluginManager().getPlugin(pluginName);
if (plg == null) return "";
PluginDescriptionFile pdf = plg.getDescription();
return pdf.getFullName();
}
/**
* Static method to disable a plugin (might also be useful for hooks).
* @param plgName
* @return
*/
public static boolean disablePlugin(String plgName){
PluginManager pm = Bukkit.getPluginManager();
Plugin plugin = pm.getPlugin(plgName);
if (plugin == null) return false;
if (!pm.isPluginEnabled(plugin)) return true;
pm.disablePlugin(plugin);
return true;
}
/**
* Get the plugin instance.
* @return
*/
public static CompatNoCheatPlus getInstance(){
return instance;
}
/**
* API to add a hook. Adds the hook AND registers listeners if enabled. Also respects the configuration for preventing hooks.<br>
* If you want to not register the listeners use NCPHookManager.
* @param hook
* @return
*/
public static boolean addHook(Hook hook){
if (Settings.preventAddHooks.contains(hook.getHookName())){
Bukkit.getLogger().info("[cncp] Prevented adding hook: "+hook.getHookName() + " / " + hook.getHookVersion());
return false;
}
registeredHooks.add(hook);
if (enabled) registerListeners(hook);
boolean added = checkAddNCPHook(hook); // Add if plugin is present, otherwise queue for adding.
Bukkit.getLogger().info("[cncp] Registered hook"+(added?"":"(NCPHook might get added later)")+": "+hook.getHookName() + " / " + hook.getHookVersion());
return true;
}
/**
* If already added to NCP
* @param hook
* @return
*/
private static boolean checkAddNCPHook(Hook hook) {
PluginManager pm = Bukkit.getPluginManager();
Plugin plugin = pm.getPlugin("NoCheatPlus");
if (plugin == null || !pm.isPluginEnabled(plugin))
return false;
NCPHook ncpHook = hook.getNCPHook();
if (ncpHook != null)
NCPHookManager.addHook(hook.getCheckTypes(), ncpHook);
return true;
}
/**
* Conveniently register the listeners, do not use if you add/added the hook with addHook.
* @param hook
* @return
*/
public static boolean registerListeners(Hook hook) {
if (!enabled) return false;
Listener[] listeners = hook.getListeners();
if (listeners != null){
// attempt to register events:
PluginManager pm = Bukkit.getPluginManager();
Plugin plg = pm.getPlugin("CompatNoCheatPlus");
if (plg == null) return false;
for (Listener listener : listeners) {
pm.registerEvents(listener, plg);
}
}
return true;
}
/**
* Called before loading settings, adds available hooks into a list, so they will be able to read config.
*/
private void setupBuiltinHooks() {
builtinHooks.clear();
// Might-fail hooks:
// Set speed
try{
builtinHooks.add(new me.asofold.bpl.cncp.hooks.generic.HookSetSpeed());
}
catch (Throwable t){}
// Citizens 2
try{
builtinHooks.add(new me.asofold.bpl.cncp.hooks.citizens2.HookCitizens2());
}
catch (Throwable t){}
// mcMMO
try{
builtinHooks.add(new me.asofold.bpl.cncp.hooks.mcmmo.HookmcMMO());
}
catch (Throwable t){}
// MagicSpells
try{
builtinHooks.add(new me.asofold.bpl.cncp.hooks.magicspells.HookMagicSpells());
}
catch (Throwable t){}
// Simple generic hooks
for (Hook hook : new Hook[]{
new HookPlayerClass(),
new HookBlockBreak(),
new HookBlockPlace(),
new HookInstaBreak(),
new HookEntityDamageByEntity(),
}){
builtinHooks.add(hook);
}
}
/**
* Add standard hooks if enabled.
*/
private void addAvailableHooks() {
// Add built in hooks:
for (Hook hook : builtinHooks){
boolean add = true;
if (hook instanceof ConfigurableHook){
if (!((ConfigurableHook)hook).isEnabled()) add = false;
}
if (add){
try{
addHook(hook);
}
catch (Throwable t){}
}
}
}
@Override
public void onEnable() {
enabled = false; // make sure
instance = this;
// (no cleanup)
// Settings:
settings.clear();
setupBuiltinHooks();
loadSettings();
// Register own listener:
final PluginManager pm = getServer().getPluginManager();
pm.registerEvents(this, this);
super.onEnable();
// Add Hooks:
addAvailableHooks(); // add before enable is set to not yet register listeners.
enabled = true;
// register all listeners:
for (Hook hook : registeredHooks){
registerListeners(hook);
}
// Start ticktask 2
getServer().getScheduler().scheduleSyncRepeatingTask(this, new TickTask2(), 1, 1);
// Check for the NoCheatPlus plugin.
Plugin plugin = pm.getPlugin("NoCheatPlus");
if (plugin == null) {
getLogger().severe("[CompatNoCheatPlus] The NoCheatPlus plugin is not present.");
}
else if (plugin.isEnabled()) {
getLogger().severe("[CompatNoCheatPlus] The NoCheatPlus plugin already is enabled, this might break several hooks.");
}
// Finished.
getLogger().info(getDescription().getFullName() + " is enabled. Some hooks might get registered with NoCheatPlus later on.");
}
public boolean loadSettings() {
final Set<String> oldForceEnableLater = new LinkedHashSet<String>();
oldForceEnableLater.addAll(settings.forceEnableLater);
// Read and apply config to settings:
File file = new File(getDataFolder() , "cncp.yml");
CompatConfig cfg = new NewConfig(file);
cfg.load();
boolean changed = false;
// General settings:
if (Settings.addDefaults(cfg)) changed = true;
settings.fromConfig(cfg);
// Settings for builtin hooks:
for (Hook hook : builtinHooks){
if (hook instanceof ConfigurableHook){
try{
ConfigurableHook cfgHook = (ConfigurableHook) hook;
if (cfgHook.updateConfig(cfg, "hooks.")) changed = true;
cfgHook.applyConfig(cfg, "hooks.");
}
catch (Throwable t){
getLogger().severe("[cncp] Hook failed to process config ("+hook.getHookName() +" / " + hook.getHookVersion()+"): " + t.getClass().getSimpleName() + ": "+t.getMessage());
t.printStackTrace();
}
}
}
// save back config if changed:
if (changed) cfg.save();
// Re-enable plugins that were not yet on the list:
Server server = getServer();
Logger logger = server.getLogger();
for (String plgName : settings.loadPlugins){
try{
if (CompatNoCheatPlus.enablePlugin(plgName)){
System.out.println("[cncp] Ensured that the following plugin is enabled: " + plgName);
}
}
catch (Throwable t){
logger.severe("[cncp] Failed to enable the plugin: " + plgName);
logger.severe(Utils.toString(t));
}
}
BukkitScheduler sched = server.getScheduler();
for (String plgName : settings.forceEnableLater){
if (!oldForceEnableLater.remove(plgName)) oldForceEnableLater.add(plgName);
}
if (!oldForceEnableLater.isEmpty()){
System.out.println("[cncp] Schedule task to re-enable plugins later...");
sched.scheduleSyncDelayedTask(this, new Runnable() {
@Override
public void run() {
// (Later maybe re-enabling this plugin could be added.)
// TODO: log levels !
for (String plgName : oldForceEnableLater){
try{
if (disablePlugin(plgName)){
if (enablePlugin(plgName)) System.out.println("[cncp] Re-enabled plugin: " + plgName);
else System.out.println("[cncp] Could not re-enable plugin: "+plgName);
}
else{
System.out.println("[cncp] Could not disable plugin (already disabled?): "+plgName);
}
}
catch(Throwable t){
// TODO: maybe log ?
}
}
}
});
}
return true;
}
@Override
public void onDisable() {
unregisterNCPHooks(); // Just in case.
enabled = false;
instance = null; // Set last.
super.onDisable();
}
protected int unregisterNCPHooks() {
// TODO: Clear list here !? Currently done externally...
int n = 0;
for (Hook hook : registeredHooks) {
String hookDescr = null;
try {
NCPHook ncpHook = hook.getNCPHook();
if (ncpHook != null){
hookDescr = ncpHook.getHookName() + ": " + ncpHook.getHookVersion();
NCPHookManager.removeHook(ncpHook);
n ++;
}
} catch (Throwable e)
{
if (hookDescr != null) {
// Some error with removing a hook.
getLogger().log(Level.WARNING, "Failed to unregister hook: " + hookDescr, e);
}
}
}
getLogger().info("[cncp] Removed "+n+" registered hooks from NoCheatPlus.");
registeredHooks.clear();
return n;
}
private int registerHooks() {
int n = 0;
for (Hook hook : registeredHooks){
// TODO: try catch
NCPHook ncpHook = hook.getNCPHook();
if (ncpHook == null) continue;
NCPHookManager.addHook(hook.getCheckTypes(), ncpHook);
n ++;
}
getLogger().info("[cncp] Added "+n+" registered hooks to NoCheatPlus.");
return n;
}
@EventHandler(priority = EventPriority.NORMAL)
void onPluginEnable(PluginEnableEvent event){
Plugin plugin = event.getPlugin();
if (!plugin.getName().equals("NoCheatPlus")) {
return;
}
// Register to rmeove hooks when NCP is disabling.
NCPAPIProvider.getNoCheatPlusAPI().addComponent(new DisableListener(){
@Override
public void onDisable() {
// Remove all registered cncp hooks:
unregisterNCPHooks();
}
});
if (registeredHooks.isEmpty()) {
return;
}
registerHooks();
}
/* (non-Javadoc)
* @see org.bukkit.plugin.java.JavaPlugin#onCommand(org.bukkit.command.CommandSender, org.bukkit.command.Command, java.lang.String, java.lang.String[])
*/
@Override
public boolean onCommand(CommandSender sender, Command command, String label, String[] args) {
// Permission has already been checked.
sendInfo(sender);
return true;
}
/**
* Send general version and hooks info.
* @param sender
*/
private void sendInfo(CommandSender sender) {
List<String> infos = new LinkedList<String>();
infos.add("---- Version infomation ----");
// Server
infos.add("#### Server ####");
infos.add(getServer().getVersion());
// Core plugins (NCP + cncp)
infos.add("#### Core plugins ####");
infos.add(getDescription().getFullName());
String temp = getOtherVersion("NoCheatPlus");
infos.add(temp.isEmpty() ? "NoCheatPlus is missing or not yet enabled." : temp);
infos.add("#### Typical plugin dependencies ####");
for (String pluginName : new String[]{
"mcMMO", "Citizens", "MachinaCraft", "MagicSpells",
// TODO: extend
}){
temp = getOtherVersion(pluginName);
if (!temp.isEmpty()) infos.add(temp);
}
// Hooks
infos.add("#### Registered hooks (cncp) ###");
for (final Hook hook : registeredHooks){
temp = hook.getHookName() + ": " + hook.getHookVersion();
if (hook instanceof ConfigurableHook){
temp += ((ConfigurableHook) hook).isEnabled() ? " (enabled)" : " (disabled)";
}
infos.add(temp);
}
// TODO: Registered hooks (ncp) ?
infos.add("#### Registered hooks (ncp) ####");
for (final NCPHook hook : NCPHookManager.getAllHooks()){
infos.add(hook.getHookName() + ": " + hook.getHookVersion());
}
final String[] a = new String[infos.size()];
infos.toArray(a);
sender.sendMessage(a);
}
/**
*
* @param pluginName Empty string or "name: version".
*/
private String getOtherVersion(String pluginName){
Plugin plg = getServer().getPluginManager().getPlugin(pluginName);
if (plg == null) return "";
PluginDescriptionFile pdf = plg.getDescription();
return pdf.getFullName();
}
}