package org.bukkit.plugin; import com.google.common.collect.ImmutableSet; import java.io.File; import java.lang.reflect.Constructor; import java.util.ArrayList; import java.util.Comparator; import java.util.EnumMap; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.Set; import java.util.SortedSet; import java.util.TreeSet; import java.util.Arrays; import java.util.HashSet; import java.util.LinkedList; import java.util.Iterator; import java.util.LinkedHashMap; import java.util.WeakHashMap; import java.util.logging.Level; import java.util.regex.Matcher; import org.bukkit.Server; import java.util.regex.Pattern; import org.bukkit.command.Command; import org.bukkit.command.PluginCommandYamlParser; import org.bukkit.command.SimpleCommandMap; import org.bukkit.event.Event; import org.bukkit.event.Event.Priority; import org.bukkit.event.Listener; import org.bukkit.permissions.Permissible; import org.bukkit.permissions.Permission; import org.bukkit.permissions.PermissionDefault; import org.bukkit.util.FileUtil; /** * Handles all plugin management from the Server */ public final class SimplePluginManager implements PluginManager { private final Server server; private final Map fileAssociations = new HashMap(); private final List plugins = new ArrayList(); private final Map lookupNames = new HashMap(); private final Map> listeners = new EnumMap>(Event.Type.class); private static File updateDirectory = null; private final SimpleCommandMap commandMap; private final Map permissions = new HashMap(); private final Map> defaultPerms = new LinkedHashMap>(); private final Map> permSubs = new HashMap>(); private final Map> defSubs = new HashMap>(); private final Comparator comparer = new Comparator() { public int compare(RegisteredListener i, RegisteredListener j) { int result = i.getPriority().compareTo(j.getPriority()); if ((result == 0) && (i != j)) { result = 1; } return result; } }; public SimplePluginManager(Server instance, SimpleCommandMap commandMap) { server = instance; this.commandMap = commandMap; defaultPerms.put(true, new HashSet()); defaultPerms.put(false, new HashSet()); } /** * Registers the specified plugin loader * * @param loader Class name of the PluginLoader to register * @throws IllegalArgumentException Thrown when the given Class is not a valid PluginLoader */ public void registerInterface(Class loader) throws IllegalArgumentException { PluginLoader instance; if (PluginLoader.class.isAssignableFrom(loader)) { Constructor constructor; try { constructor = loader.getConstructor(Server.class); instance = constructor.newInstance(server); } catch (NoSuchMethodException ex) { String className = loader.getName(); throw new IllegalArgumentException(String.format("Class %s does not have a public %s(Server) constructor", className, className), ex); } catch (Exception ex) { throw new IllegalArgumentException(String.format("Unexpected exception %s while attempting to construct a new instance of %s", ex.getClass().getName(), loader.getName()), ex); } } else { throw new IllegalArgumentException(String.format("Class %s does not implement interface PluginLoader", loader.getName())); } Pattern[] patterns = instance.getPluginFileFilters(); synchronized (this) { for (Pattern pattern : patterns) { fileAssociations.put(pattern, instance); } } } /** * Loads the plugins contained within the specified directory * * @param directory Directory to check for plugins * @return A list of all plugins loaded */ public Plugin[] loadPlugins(File directory) { List result = new ArrayList(); File[] files = directory.listFiles(); boolean allFailed = false; boolean finalPass = false; LinkedList filesList = new LinkedList(Arrays.asList(files)); if (!(server.getUpdateFolder().equals(""))) { updateDirectory = new File(directory, server.getUpdateFolder()); } while (!allFailed || finalPass) { allFailed = true; Iterator itr = filesList.iterator(); while (itr.hasNext()) { File file = itr.next(); Plugin plugin = null; try { plugin = loadPlugin(file, finalPass); itr.remove(); } catch (UnknownDependencyException ex) { if (finalPass) { server.getLogger().log(Level.SEVERE, "Could not load '" + file.getPath() + "' in folder '" + directory.getPath() + "': " + ex.getMessage(), ex); itr.remove(); } else { plugin = null; } } catch (InvalidPluginException ex) { server.getLogger().log(Level.SEVERE, "Could not load '" + file.getPath() + "' in folder '" + directory.getPath() + "': ", ex.getCause()); itr.remove(); } catch (InvalidDescriptionException ex) { server.getLogger().log(Level.SEVERE, "Could not load '" + file.getPath() + "' in folder '" + directory.getPath() + "': " + ex.getMessage(), ex); itr.remove(); } if (plugin != null) { result.add(plugin); allFailed = false; finalPass = false; } } if (finalPass) { break; } else if (allFailed) { finalPass = true; } } return result.toArray(new Plugin[result.size()]); } /** * Loads the plugin in the specified file * * File must be valid according to the current enabled Plugin interfaces * * @param file File containing the plugin to load * @return The Plugin loaded, or null if it was invalid * @throws InvalidPluginException Thrown when the specified file is not a valid plugin * @throws InvalidDescriptionException Thrown when the specified file contains an invalid description * @throws UnknownDependencyException If a required dependency could not be found */ public synchronized Plugin loadPlugin(File file) throws InvalidPluginException, InvalidDescriptionException, UnknownDependencyException { return loadPlugin(file, true); } /** * Loads the plugin in the specified file * * File must be valid according to the current enabled Plugin interfaces * * @param file File containing the plugin to load * @param ignoreSoftDependencies Loader will ignore soft dependencies if this flag is set to true * @return The Plugin loaded, or null if it was invalid * @throws InvalidPluginException Thrown when the specified file is not a valid plugin * @throws InvalidDescriptionException Thrown when the specified file contains an invalid description * @throws UnknownDependencyException If a required dependency could not be found */ public synchronized Plugin loadPlugin(File file, boolean ignoreSoftDependencies) throws InvalidPluginException, InvalidDescriptionException, UnknownDependencyException { File updateFile = null; if (updateDirectory != null && updateDirectory.isDirectory() && (updateFile = new File(updateDirectory, file.getName())).isFile()) { if (FileUtil.copy(updateFile, file)) { updateFile.delete(); } } Set filters = fileAssociations.keySet(); Plugin result = null; for (Pattern filter : filters) { String name = file.getName(); Matcher match = filter.matcher(name); if (match.find()) { PluginLoader loader = fileAssociations.get(filter); result = loader.loadPlugin(file, ignoreSoftDependencies); } } if (result != null) { plugins.add(result); lookupNames.put(result.getDescription().getName(), result); } return result; } /** * Checks if the given plugin is loaded and returns it when applicable * * Please note that the name of the plugin is case-sensitive * * @param name Name of the plugin to check * @return Plugin if it exists, otherwise null */ public synchronized Plugin getPlugin(String name) { return lookupNames.get(name); } public synchronized Plugin[] getPlugins() { return plugins.toArray(new Plugin[0]); } /** * Checks if the given plugin is enabled or not * * Please note that the name of the plugin is case-sensitive. * * @param name Name of the plugin to check * @return true if the plugin is enabled, otherwise false */ public boolean isPluginEnabled(String name) { Plugin plugin = getPlugin(name); return isPluginEnabled(plugin); } /** * Checks if the given plugin is enabled or not * * @param plugin Plugin to check * @return true if the plugin is enabled, otherwise false */ public boolean isPluginEnabled(Plugin plugin) { if ((plugin != null) && (plugins.contains(plugin))) { return plugin.isEnabled(); } else { return false; } } public void enablePlugin(final Plugin plugin) { if (!plugin.isEnabled()) { List pluginCommands = PluginCommandYamlParser.parse(plugin); if (!pluginCommands.isEmpty()) { commandMap.registerAll(plugin.getDescription().getName(), pluginCommands); } try { plugin.getPluginLoader().enablePlugin(plugin); } catch (Throwable ex) { server.getLogger().log(Level.SEVERE, "Error occurred (in the plugin loader) while enabling " + plugin.getDescription().getFullName() + " (Is it up to date?): " + ex.getMessage(), ex); } } } public void disablePlugins() { for (Plugin plugin: getPlugins()) { disablePlugin(plugin); } } public void disablePlugin(final Plugin plugin) { if (plugin.isEnabled()) { try { plugin.getPluginLoader().disablePlugin(plugin); } catch (Throwable ex) { server.getLogger().log(Level.SEVERE, "Error occurred (in the plugin loader) while disabling " + plugin.getDescription().getFullName() + " (Is it up to date?): " + ex.getMessage(), ex); } try { server.getScheduler().cancelTasks(plugin); } catch (Throwable ex) { server.getLogger().log(Level.SEVERE, "Error occurred (in the plugin loader) while cancelling tasks for " + plugin.getDescription().getFullName() + " (Is it up to date?): " + ex.getMessage(), ex); } try { server.getServicesManager().unregisterAll(plugin); } catch (Throwable ex) { server.getLogger().log(Level.SEVERE, "Error occurred (in the plugin loader) while unregistering services for " + plugin.getDescription().getFullName() + " (Is it up to date?): " + ex.getMessage(), ex); } } } public void clearPlugins() { synchronized (this) { disablePlugins(); plugins.clear(); lookupNames.clear(); listeners.clear(); fileAssociations.clear(); permissions.clear(); defaultPerms.get(true).clear(); defaultPerms.get(false).clear(); } } /** * Calls an event with the given details * * @param event Event details */ public synchronized void callEvent(Event event) { SortedSet eventListeners = listeners.get(event.getType()); if (eventListeners != null) { for (RegisteredListener registration : eventListeners) { try { registration.callEvent(event); } catch (AuthorNagException ex) { Plugin plugin = registration.getPlugin(); if (plugin.isNaggable()) { plugin.setNaggable(false); String author = ""; if (plugin.getDescription().getAuthors().size() > 0) { author = plugin.getDescription().getAuthors().get(0); } server.getLogger().log(Level.SEVERE, String.format( "Nag author: '%s' of '%s' about the following: %s", author, plugin.getDescription().getName(), ex.getMessage() )); } } catch (Throwable ex) { server.getLogger().log(Level.SEVERE, "Could not pass event " + event.getType() + " to " + registration.getPlugin().getDescription().getName(), ex); } } } } /** * Registers the given event to the specified listener * * @param type EventType to register * @param listener PlayerListener to register * @param priority Priority of this event * @param plugin Plugin to register */ public void registerEvent(Event.Type type, Listener listener, Priority priority, Plugin plugin) { if (!plugin.isEnabled()) { throw new IllegalPluginAccessException("Plugin attempted to register " + type + " while not enabled"); } getEventListeners(type).add(new RegisteredListener(listener, priority, plugin, type)); } /** * Registers the given event to the specified listener using a directly passed EventExecutor * * @param type EventType to register * @param listener PlayerListener to register * @param executor EventExecutor to register * @param priority Priority of this event * @param plugin Plugin to register */ public void registerEvent(Event.Type type, Listener listener, EventExecutor executor, Priority priority, Plugin plugin) { if (!plugin.isEnabled()) { throw new IllegalPluginAccessException("Plugin attempted to register " + type + " while not enabled"); } getEventListeners(type).add(new RegisteredListener(listener, executor, priority, plugin)); } /** * Returns a SortedSet of RegisteredListener for the specified event type creating a new queue if needed * * @param type EventType to lookup * @return SortedSet the looked up or create queue matching the requested type */ private SortedSet getEventListeners(Event.Type type) { SortedSet eventListeners = listeners.get(type); if (eventListeners != null) { return eventListeners; } eventListeners = new TreeSet(comparer); listeners.put(type, eventListeners); return eventListeners; } public Permission getPermission(String name) { return permissions.get(name.toLowerCase()); } public void addPermission(Permission perm) { String name = perm.getName().toLowerCase(); if (permissions.containsKey(name)) { throw new IllegalArgumentException("The permission " + name + " is already defined!"); } permissions.put(name, perm); calculatePermissionDefault(perm); } public Set getDefaultPermissions(boolean op) { return ImmutableSet.copyOf(defaultPerms.get(op)); } public void removePermission(Permission perm) { removePermission(perm.getName().toLowerCase()); } public void removePermission(String name) { permissions.remove(name); } public void recalculatePermissionDefaults(Permission perm) { if (permissions.containsValue(perm)) { defaultPerms.get(true).remove(perm); defaultPerms.get(false).remove(perm); calculatePermissionDefault(perm); } } private void calculatePermissionDefault(Permission perm) { if ((perm.getDefault() == PermissionDefault.OP) || (perm.getDefault() == PermissionDefault.TRUE)) { defaultPerms.get(true).add(perm); dirtyPermissibles(true); } if ((perm.getDefault() == PermissionDefault.NOT_OP) || (perm.getDefault() == PermissionDefault.TRUE)) { defaultPerms.get(false).add(perm); dirtyPermissibles(false); } } private void dirtyPermissibles(boolean op) { Set permissibles = getDefaultPermSubscriptions(op); for (Permissible p : permissibles) { p.recalculatePermissions(); } } public void subscribeToPermission(String permission, Permissible permissible) { String name = permission.toLowerCase(); Map map = permSubs.get(name); if (map == null) { map = new WeakHashMap(); permSubs.put(name, map); } map.put(permissible, true); } public void unsubscribeFromPermission(String permission, Permissible permissible) { String name = permission.toLowerCase(); Map map = permSubs.get(name); if (map != null) { map.remove(permissible); if (map.isEmpty()) { permSubs.remove(name); } } } public Set getPermissionSubscriptions(String permission) { String name = permission.toLowerCase(); Map map = permSubs.get(name); if (map == null) { return ImmutableSet.of(); } else { return ImmutableSet.copyOf(map.keySet()); } } public void subscribeToDefaultPerms(boolean op, Permissible permissible) { Map map = defSubs.get(op); if (map == null) { map = new WeakHashMap(); defSubs.put(op, map); } map.put(permissible, true); } public void unsubscribeFromDefaultPerms(boolean op, Permissible permissible) { Map map = defSubs.get(op); if (map != null) { map.remove(permissible); if (map.isEmpty()) { defSubs.remove(op); } } } public Set getDefaultPermSubscriptions(boolean op) { Map map = defSubs.get(op); if (map == null) { return ImmutableSet.of(); } else { return ImmutableSet.copyOf(map.keySet()); } } public Set getPermissions() { return new HashSet(permissions.values()); } }