Implement ability to disable/enable plugins

This commit is contained in:
Frank van der Heijden 2020-06-11 12:20:57 +02:00
parent 0132c06483
commit 9097b06ed5
No known key found for this signature in database
GPG key ID: 26DA56488D314D11
6 changed files with 129 additions and 16 deletions

View file

@ -121,10 +121,16 @@ public class CommandServerUtils extends BaseCommand {
@Subcommand("unloadplugin") @Subcommand("unloadplugin")
@CommandCompletion("@plugins") @CommandCompletion("@plugins")
@CommandPermission("serverutils.unloadplugin") @CommandPermission("serverutils.unloadplugin")
@Description("Unloads the specified plugin.") @Description("Disables and unloads the specified plugin.")
public void onUnloadPlugin(CommandSender sender, String pluginName) { public void onUnloadPlugin(CommandSender sender, String pluginName) {
Result result = PluginManager.disablePlugin(pluginName); Result disableResult = PluginManager.disablePlugin(pluginName);
result.sendTo(sender, "unload", pluginName); if (disableResult != Result.SUCCESS && disableResult != Result.ALREADY_DISABLED) {
disableResult.sendTo(sender, "disabl", pluginName);
return;
}
Result unloadResult = PluginManager.unloadPlugin(pluginName);
unloadResult.sendTo(sender, "unload", pluginName);
} }
@Subcommand("reloadplugin") @Subcommand("reloadplugin")
@ -136,6 +142,24 @@ public class CommandServerUtils extends BaseCommand {
result.sendTo(sender, "reload", pluginName); result.sendTo(sender, "reload", pluginName);
} }
@Subcommand("enableplugin")
@CommandCompletion("@plugins")
@CommandPermission("serverutils.enableplugin")
@Description("Enables the loaded plugin.")
public void onEnablePlugin(CommandSender sender, String pluginName) {
Result result = PluginManager.enablePlugin(pluginName);
result.sendTo(sender, "enabl", pluginName);
}
@Subcommand("disableplugin")
@CommandCompletion("@plugins")
@CommandPermission("serverutils.disableplugin")
@Description("Disables the specified plugin.")
public void onDisablePlugin(CommandSender sender, String pluginName) {
Result result = PluginManager.disablePlugin(pluginName);
result.sendTo(sender, "disabl", pluginName);
}
@Subcommand("plugininfo") @Subcommand("plugininfo")
@CommandCompletion("@plugins") @CommandCompletion("@plugins")
@CommandPermission("serverutils.plugininfo") @CommandPermission("serverutils.plugininfo")

View file

@ -16,9 +16,12 @@ public class Messenger {
"error", "&cAn error occurred while %action%ing &4%what%&c, please check the console!", "error", "&cAn error occurred while %action%ing &4%what%&c, please check the console!",
"not_exists", "&cAn error occurred while %action%ing &4%what%&c, plugin does not exist!", "not_exists", "&cAn error occurred while %action%ing &4%what%&c, plugin does not exist!",
"not_enabled", "&cAn error occurred while %action%ing &4%what%&c, plugin is not enabled!", "not_enabled", "&cAn error occurred while %action%ing &4%what%&c, plugin is not enabled!",
"already_loaded", "&cAn error occurred while %action%ing &4%what%&c, plugin is already loaded!",
"already_enabled", "&cAn error occurred while %action%ing &4%what%&c, plugin is already enabled!", "already_enabled", "&cAn error occurred while %action%ing &4%what%&c, plugin is already enabled!",
"already_disabled", "&cAn error occurred while %action%ing &4%what%&c, plugin is already disabled!",
"file_changed", "&cAccessing the jar file while %action%ing &4%what%&c went wrong, please load the plugin manually!", "file_changed", "&cAccessing the jar file while %action%ing &4%what%&c went wrong, please load the plugin manually!",
"invalid_description", "&cAn error occurred while %action%ing &4%what%&c, plugin doesn't have a valid description!", "invalid_description", "&cAn error occurred while %action%ing &4%what%&c, plugin doesn't have a valid description!",
"invalid_plugin", "&cAn error occurred while %action%ing &4%what%&c, plugin is invalid!",
"update", Defaults.of( "update", Defaults.of(
"available", "&8&m------------=&r&8[ &b&lServerUtils Update&r &8]&m=--------------\n" "available", "&8&m------------=&r&8[ &b&lServerUtils Update&r &8]&m=--------------\n"
+ " &3Current version: &b%old%\n" + " &3Current version: &b%old%\n"

View file

@ -6,11 +6,15 @@ public class LoadResult {
private final Plugin plugin; private final Plugin plugin;
private final Result result; private final Result result;
public LoadResult(Plugin plugin, Result result) { private LoadResult(Plugin plugin, Result result) {
this.plugin = plugin; this.plugin = plugin;
this.result = result; this.result = result;
} }
public LoadResult(Plugin plugin) {
this(plugin, Result.SUCCESS);
}
public LoadResult(Result result) { public LoadResult(Result result) {
this(null, result); this(null, result);
} }

View file

@ -8,8 +8,11 @@ import org.bukkit.plugin.*;
import org.bukkit.plugin.java.PluginClassLoader; import org.bukkit.plugin.java.PluginClassLoader;
import java.io.File; import java.io.File;
import java.io.IOException;
import java.lang.reflect.InvocationTargetException; import java.lang.reflect.InvocationTargetException;
import java.util.Map; import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import static net.frankheijden.serverutils.reflection.ReflectionUtils.set; import static net.frankheijden.serverutils.reflection.ReflectionUtils.set;
@ -21,8 +24,13 @@ public class PluginManager {
public static LoadResult loadPlugin(File file) { public static LoadResult loadPlugin(File file) {
if (!file.exists()) return new LoadResult(Result.NOT_EXISTS); if (!file.exists()) return new LoadResult(Result.NOT_EXISTS);
Plugin loadedPlugin = getLoadedPlugin(file);
if (loadedPlugin != null) return new LoadResult(Result.ALREADY_LOADED);
Plugin plugin;
try { try {
return new LoadResult(Bukkit.getPluginManager().loadPlugin(file), Result.SUCCESS); plugin = Bukkit.getPluginManager().loadPlugin(file);
} catch (InvalidDescriptionException ex) { } catch (InvalidDescriptionException ex) {
return new LoadResult(Result.INVALID_DESCRIPTION); return new LoadResult(Result.INVALID_DESCRIPTION);
} catch (InvalidPluginException ex) { } catch (InvalidPluginException ex) {
@ -33,9 +41,12 @@ public class PluginManager {
} }
} }
ex.printStackTrace(); ex.printStackTrace();
return new LoadResult(Result.ERROR);
} }
return new LoadResult(Result.ERROR); if (plugin == null) return new LoadResult(Result.INVALID_PLUGIN);
plugin.onLoad();
return new LoadResult(plugin);
} }
public static Result disablePlugin(String pluginName) { public static Result disablePlugin(String pluginName) {
@ -44,11 +55,9 @@ public class PluginManager {
public static Result disablePlugin(Plugin plugin) { public static Result disablePlugin(Plugin plugin) {
if (plugin == null) return Result.NOT_ENABLED; if (plugin == null) return Result.NOT_ENABLED;
if (!plugin.isEnabled()) return Result.ALREADY_DISABLED;
try { try {
Bukkit.getPluginManager().disablePlugin(plugin); Bukkit.getPluginManager().disablePlugin(plugin);
RSimplePluginManager.getPlugins(Bukkit.getPluginManager()).remove(plugin);
RSimplePluginManager.removeLookupName(Bukkit.getPluginManager(), plugin.getName());
clearClassLoader(RJavaPlugin.getClassLoader(plugin));
RCraftingManager.removeRecipesFor(plugin); RCraftingManager.removeRecipesFor(plugin);
} catch (Exception ex) { } catch (Exception ex) {
ex.printStackTrace(); ex.printStackTrace();
@ -58,17 +67,39 @@ public class PluginManager {
return Result.SUCCESS; return Result.SUCCESS;
} }
public static void clearClassLoader(ClassLoader loader) throws IllegalAccessException { public static Result unloadPlugin(String pluginName) {
return unloadPlugin(Bukkit.getPluginManager().getPlugin(pluginName));
}
public static Result unloadPlugin(Plugin plugin) {
if (plugin == null) return Result.NOT_EXISTS;
try {
RSimplePluginManager.getPlugins(Bukkit.getPluginManager()).remove(plugin);
RSimplePluginManager.removeLookupName(Bukkit.getPluginManager(), plugin.getName());
clearClassLoader(RJavaPlugin.getClassLoader(plugin));
} catch (Exception ex) {
ex.printStackTrace();
return Result.ERROR;
}
return Result.SUCCESS;
}
public static void clearClassLoader(ClassLoader loader) throws IllegalAccessException, IOException {
if (loader == null) return; if (loader == null) return;
if (loader instanceof PluginClassLoader) { if (loader instanceof PluginClassLoader) {
clearClassLoader((PluginClassLoader) loader); clearClassLoader((PluginClassLoader) loader);
} }
} }
public static void clearClassLoader(PluginClassLoader loader) throws IllegalAccessException { public static void clearClassLoader(PluginClassLoader loader) throws IllegalAccessException, IOException {
if (loader == null) return; if (loader == null) return;
set(RPluginClassLoader.getFields(), loader, "plugin", null); set(RPluginClassLoader.getFields(), loader, "plugin", null);
set(RPluginClassLoader.getFields(), loader, "pluginInit", null); set(RPluginClassLoader.getFields(), loader, "pluginInit", null);
loader.close();
}
public static Result enablePlugin(String pluginName) {
return enablePlugin(Bukkit.getPluginManager().getPlugin(pluginName));
} }
public static Result enablePlugin(Plugin plugin) { public static Result enablePlugin(Plugin plugin) {
@ -89,7 +120,10 @@ public class PluginManager {
public static Result reloadPlugin(Plugin plugin) { public static Result reloadPlugin(Plugin plugin) {
Result disableResult = disablePlugin(plugin); Result disableResult = disablePlugin(plugin);
if (disableResult != Result.SUCCESS) return disableResult; if (disableResult != Result.SUCCESS && disableResult != Result.ALREADY_DISABLED) return disableResult;
Result unloadResult = unloadPlugin(plugin);
if (unloadResult != Result.SUCCESS) return unloadResult;
File pluginFile; File pluginFile;
try { try {
@ -138,4 +172,43 @@ public class PluginManager {
if (knownCommands == null) return null; if (knownCommands == null) return null;
return knownCommands.get(command); return knownCommands.get(command);
} }
public static Map<Pattern, PluginLoader> getFileAssociations() {
try {
return RSimplePluginManager.getFileAssociations(Bukkit.getPluginManager());
} catch (IllegalAccessException ex) {
ex.printStackTrace();
return null;
}
}
public static PluginLoader getPluginLoader(File file) {
Map<Pattern, PluginLoader> fileAssociations = getFileAssociations();
if (fileAssociations == null) return null;
for (Pattern filter : fileAssociations.keySet()) {
Matcher match = filter.matcher(file.getName());
if (match.find()) {
return fileAssociations.get(filter);
}
}
return null;
}
public static Plugin getLoadedPlugin(File file) {
PluginDescriptionFile descriptionFile;
try {
descriptionFile = getPluginDescription(file);
} catch (InvalidDescriptionException ex) {
return null;
}
if (descriptionFile == null) return null;
return Bukkit.getPluginManager().getPlugin(descriptionFile.getName());
}
public static PluginDescriptionFile getPluginDescription(File file) throws InvalidDescriptionException {
PluginLoader loader = getPluginLoader(file);
if (loader == null) return null;
return loader.getPluginDescription(file);
}
} }

View file

@ -6,9 +6,12 @@ import org.bukkit.command.CommandSender;
public enum Result { public enum Result {
NOT_EXISTS, NOT_EXISTS,
NOT_ENABLED, NOT_ENABLED,
ALREADY_LOADED,
ALREADY_ENABLED, ALREADY_ENABLED,
ALREADY_DISABLED,
FILE_CHANGED, FILE_CHANGED,
INVALID_DESCRIPTION, INVALID_DESCRIPTION,
INVALID_PLUGIN,
ERROR, ERROR,
SUCCESS; SUCCESS;

View file

@ -1,10 +1,10 @@
package net.frankheijden.serverutils.reflection; package net.frankheijden.serverutils.reflection;
import org.bukkit.plugin.Plugin; import org.bukkit.plugin.*;
import org.bukkit.plugin.SimplePluginManager;
import java.lang.reflect.Field; import java.lang.reflect.Field;
import java.util.*; import java.util.*;
import java.util.regex.Pattern;
import static net.frankheijden.serverutils.reflection.ReflectionUtils.FieldParam.fieldOf; import static net.frankheijden.serverutils.reflection.ReflectionUtils.FieldParam.fieldOf;
import static net.frankheijden.serverutils.reflection.ReflectionUtils.VersionParam.ALL_VERSIONS; import static net.frankheijden.serverutils.reflection.ReflectionUtils.VersionParam.ALL_VERSIONS;
@ -21,15 +21,21 @@ public class RSimplePluginManager {
simplePluginManagerClass = SimplePluginManager.class; simplePluginManagerClass = SimplePluginManager.class;
fields = getAllFields(simplePluginManagerClass, fields = getAllFields(simplePluginManagerClass,
fieldOf("plugins", ALL_VERSIONS), fieldOf("plugins", ALL_VERSIONS),
fieldOf("lookupNames", ALL_VERSIONS)); fieldOf("lookupNames", ALL_VERSIONS),
fieldOf("fileAssociations", ALL_VERSIONS));
} catch (Exception ex) { } catch (Exception ex) {
ex.printStackTrace(); ex.printStackTrace();
} }
} }
@SuppressWarnings("unchecked")
public static Map<Pattern, PluginLoader> getFileAssociations(Object manager) throws IllegalAccessException {
return (Map<Pattern, PluginLoader>) get(fields, manager, "fileAssociations");
}
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
public static List<Plugin> getPlugins(Object manager) throws IllegalAccessException { public static List<Plugin> getPlugins(Object manager) throws IllegalAccessException {
return (List<Plugin>) fields.get("plugins").get(manager); return (List<Plugin>) get(fields, manager, "plugins");
} }
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")