Upstream
/
PlaceholderAPI
mirror of https://github.com/PlaceholderAPI/PlaceholderAPI.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add queue system to expansion registration

This commit is contained in:
Andre601 2022-05-04 22:22:34 +02:00
parent a56b3b62b9
commit 0de03a5064
7 changed files with 203 additions and 167 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/main/java/me/clip/placeholderapi/PlaceholderAPIPlugin.java
View File

@ -53,6 +53,7 @@ public final class PlaceholderAPIPlugin extends JavaPlugin {
@NotNull
private static final Version VERSION;
private static PlaceholderAPIPlugin instance;
private boolean loaded = false;
static {
final String version = Bukkit.getServer().getClass().getPackage().getName().split("\\.")[3];
@ -167,6 +168,7 @@ public final class PlaceholderAPIPlugin extends JavaPlugin {
adventure = null;
instance = null;
loaded = false;
}
public void reloadConf(@NotNull final CommandSender sender) {
@ -212,6 +214,10 @@ public final class PlaceholderAPIPlugin extends JavaPlugin {
return config;
}
public boolean isLoaded() {
return loaded;
}
private void setupCommand() {
final PluginCommand pluginCommand = getCommand("placeholderapi");
if (pluginCommand == null) {
@ -245,6 +251,7 @@ public final class PlaceholderAPIPlugin extends JavaPlugin {
private void setupExpansions() {
Bukkit.getPluginManager().registerEvents(getLocalExpansionManager(), this);
this.loaded = true;
try {
Class.forName("org.bukkit.event.server.ServerLoadEvent");
new ServerLoadEventListener(this);

9
src/main/java/me/clip/placeholderapi/commands/impl/cloud/CommandECloudUpdate.java
View File

@ -25,7 +25,6 @@ import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import java.util.Objects;
import java.util.Optional;
import java.util.concurrent.CompletableFuture;
import java.util.stream.Collectors;
import me.clip.placeholderapi.PlaceholderAPIPlugin;
@ -48,12 +47,12 @@ public final class CommandECloudUpdate extends PlaceholderCommand {
super("update");
}
private static CompletableFuture<List<@Nullable Class<? extends PlaceholderExpansion>>> downloadAndDiscover(
private static CompletableFuture<List<@Nullable PlaceholderExpansion>> downloadAndDiscover(
@NotNull final List<CloudExpansion> expansions, @NotNull final PlaceholderAPIPlugin plugin) {
return expansions.stream()
.map(expansion -> plugin.getCloudExpansionManager()
.downloadExpansion(expansion, expansion.getVersion()))
.map(future -> future.thenCompose(plugin.getLocalExpansionManager()::findExpansionInFile))
.map(future -> future.thenCompose(plugin.getLocalExpansionManager()::findExpansion))
.collect(Futures.collector());
}
@ -104,9 +103,7 @@ public final class CommandECloudUpdate extends PlaceholderCommand {
final String message = classes.stream()
.filter(Objects::nonNull)
.map(plugin.getLocalExpansionManager()::register)
.filter(Optional::isPresent)
.map(Optional::get)
.filter(plugin.getLocalExpansionManager()::addToQueue)
.map(expansion -> " &a" + expansion.getName() + " &f" + expansion.getVersion())
.collect(Collectors.joining("\n"));

20
src/main/java/me/clip/placeholderapi/commands/impl/local/CommandExpansionRegister.java
View File

@ -23,11 +23,9 @@ package me.clip.placeholderapi.commands.impl.local;
import java.io.File;
import java.util.Arrays;
import java.util.List;
import java.util.Optional;
import java.util.logging.Level;
import me.clip.placeholderapi.PlaceholderAPIPlugin;
import me.clip.placeholderapi.commands.PlaceholderCommand;
import me.clip.placeholderapi.expansion.PlaceholderExpansion;
import me.clip.placeholderapi.expansion.manager.LocalExpansionManager;
import me.clip.placeholderapi.util.Futures;
import me.clip.placeholderapi.util.Msg;
@ -60,31 +58,31 @@ public final class CommandExpansionRegister extends PlaceholderCommand {
return;
}
Futures.onMainThread(plugin, manager.findExpansionInFile(file), (clazz, exception) -> {
Futures.onMainThread(plugin, manager.findExpansion(file), (expansion, exception) -> {
if (exception != null) {
Msg.msg(sender,
"&cFailed to find expansion in file: &f" + file);
"&cFailed to find expansion in file: &f" + file.getName());
plugin.getLogger()
.log(Level.WARNING, "failed to find expansion in file: " + file, exception);
.log(Level.WARNING, "failed to find expansion in file: " + file.getName(), exception);
return;
}
if (clazz == null) {
if (expansion == null) {
Msg.msg(sender,
"&cNo expansion class found in file: &f" + file);
"&cNo expansion class found in file: &f" + file.getName());
return;
}
final Optional<PlaceholderExpansion> expansion = manager.register(clazz);
if (!expansion.isPresent()) {
if (!manager.addToQueue(expansion)) {
Msg.msg(sender,
"&cFailed to register expansion from &f" + params.get(0));
return;
}
Msg.msg(sender,
"&aSuccessfully registered expansion: &f" + expansion.get().getName());
"&aSuccessfully registered expansion: &f" + expansion.getIdentifier());
});
}

2
src/main/java/me/clip/placeholderapi/commands/impl/local/CommandInfo.java
View File

@ -60,7 +60,7 @@ public final class CommandInfo extends PlaceholderCommand {
.append(expansion.getName())
.append('\n')
.append("&7Status: &r")
.append(expansion.isRegistered() ? "&aRegistered" : "7cNotRegistered")
.append(expansion.isRegistered() ? "&aRegistered" : "&cNot Registered")
.append('\n');
final String author = expansion.getAuthor();

2
src/main/java/me/clip/placeholderapi/expansion/PlaceholderExpansion.java
View File

@ -136,7 +136,7 @@ public abstract class PlaceholderExpansion extends PlaceholderHook {
* @return true if this expansion is now registered with PlaceholderAPI
*/
public boolean register() {
return getPlaceholderAPI().getLocalExpansionManager().register(this);
return getPlaceholderAPI().getLocalExpansionManager().addToQueue(this);
}
/**

328
src/main/java/me/clip/placeholderapi/expansion/manager/LocalExpansionManager.java
View File

@ -22,11 +22,33 @@ package me.clip.placeholderapi.expansion.manager;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Sets;
import java.io.File;
import java.lang.reflect.Modifier;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.locks.ReentrantLock;
import java.util.logging.Level;
import java.util.stream.Collectors;
import me.clip.placeholderapi.PlaceholderAPIPlugin;
import me.clip.placeholderapi.events.ExpansionRegisterEvent;
import me.clip.placeholderapi.events.ExpansionUnregisterEvent;
import me.clip.placeholderapi.events.ExpansionsLoadedEvent;
import me.clip.placeholderapi.expansion.*;
import me.clip.placeholderapi.expansion.Cacheable;
import me.clip.placeholderapi.expansion.Cleanable;
import me.clip.placeholderapi.expansion.Configurable;
import me.clip.placeholderapi.expansion.PlaceholderExpansion;
import me.clip.placeholderapi.expansion.Taskable;
import me.clip.placeholderapi.expansion.Version;
import me.clip.placeholderapi.expansion.VersionSpecific;
import me.clip.placeholderapi.expansion.cloud.CloudExpansion;
import me.clip.placeholderapi.util.FileUtil;
import me.clip.placeholderapi.util.Futures;
@ -45,16 +67,6 @@ import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.annotations.Unmodifiable;
import java.io.File;
import java.lang.reflect.Modifier;
import java.util.*;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CompletionException;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.locks.ReentrantLock;
import java.util.logging.Level;
import java.util.stream.Collectors;
public final class LocalExpansionManager implements Listener {
@NotNull
@ -65,6 +77,8 @@ public final class LocalExpansionManager implements Listener {
.filter(method -> Modifier.isAbstract(method.getModifiers()))
.map(method -> new MethodSignature(method.getName(), method.getParameterTypes()))
.collect(Collectors.toSet());
@NotNull
private final List<PlaceholderExpansion> expansionQueue = new ArrayList<>();
@NotNull
private final File folder;
@ -74,7 +88,8 @@ public final class LocalExpansionManager implements Listener {
@NotNull
private final Map<String, PlaceholderExpansion> expansions = new ConcurrentHashMap<>();
private final ReentrantLock expansionsLock = new ReentrantLock();
private boolean loaded = false;
public LocalExpansionManager(@NotNull final PlaceholderAPIPlugin plugin) {
this.plugin = plugin;
@ -154,8 +169,8 @@ public final class LocalExpansionManager implements Listener {
@NotNull final String identifier) {
return Optional.ofNullable(getExpansion(identifier));
}
public Optional<PlaceholderExpansion> register(
@NotNull final Class<? extends PlaceholderExpansion> clazz) {
try {
@ -190,98 +205,19 @@ public final class LocalExpansionManager implements Listener {
return Optional.empty();
}
@ApiStatus.Internal
public boolean register(@NotNull final PlaceholderExpansion expansion) {
final String identifier = expansion.getIdentifier().toLowerCase(Locale.ROOT);
public boolean addToQueue(@NotNull final PlaceholderExpansion expansion) {
if (!expansion.canRegister()) {
return false;
}
if (expansion instanceof Configurable) {
Map<String, Object> defaults = ((Configurable) expansion).getDefaults();
String pre = "expansions." + identifier + ".";
FileConfiguration cfg = plugin.getConfig();
boolean save = false;
if (defaults != null) {
for (Map.Entry<String, Object> entries : defaults.entrySet()) {
if (entries.getKey() == null || entries.getKey().isEmpty()) {
continue;
}
if (entries.getValue() == null) {
if (cfg.contains(pre + entries.getKey())) {
save = true;
cfg.set(pre + entries.getKey(), null);
}
} else {
if (!cfg.contains(pre + entries.getKey())) {
save = true;
cfg.set(pre + entries.getKey(), entries.getValue());
}
}
}
}
if (save) {
plugin.saveConfig();
plugin.reloadConfig();
}
if (loaded) {
return loadExpansion(expansion);
}
if (expansion instanceof VersionSpecific) {
VersionSpecific nms = (VersionSpecific) expansion;
if (!nms.isCompatibleWith(PlaceholderAPIPlugin.getServerVersion())) {
plugin.getLogger().warning("Your server version is not compatible with expansion " +
expansion.getIdentifier() + " " + expansion.getVersion());
return false;
}
}
final PlaceholderExpansion removed = getExpansion(identifier);
if (removed != null && !removed.unregister()) {
return false;
}
final ExpansionRegisterEvent event = new ExpansionRegisterEvent(expansion);
Bukkit.getPluginManager().callEvent(event);
if (event.isCancelled()) {
return false;
}
expansionsLock.lock();
try {
expansions.put(identifier, expansion);
} finally {
expansionsLock.unlock();
}
if (expansion instanceof Listener) {
Bukkit.getPluginManager().registerEvents(((Listener) expansion), plugin);
}
plugin.getLogger().info("Successfully registered expansion: " + expansion.getIdentifier() +
" [" + expansion.getVersion() + "]");
if (expansion instanceof Taskable) {
((Taskable) expansion).start();
}
if (plugin.getPlaceholderAPIConfig().isCloudEnabled()) {
final Optional<CloudExpansion> cloudExpansionOptional =
plugin.getCloudExpansionManager().findCloudExpansionByName(identifier);
if (cloudExpansionOptional.isPresent()) {
CloudExpansion cloudExpansion = cloudExpansionOptional.get();
cloudExpansion.setHasExpansion(true);
cloudExpansion.setShouldUpdate(
!cloudExpansion.getLatestVersion().equals(expansion.getVersion()));
}
}
return true;
plugin.getLogger().info("Adding " + expansion.getIdentifier() + " to Expansion Queue...");
return expansionQueue.add(expansion);
}
@ApiStatus.Internal
@ -315,21 +251,113 @@ public final class LocalExpansionManager implements Listener {
return true;
}
private boolean loadExpansion(@NotNull final PlaceholderExpansion expansion) {
final String identifier = expansion.getIdentifier().toLowerCase(Locale.ROOT);
if (expansion instanceof Configurable) {
Map<String, Object> defaults = ((Configurable) expansion).getDefaults();
String pre = "expansions." + identifier + ".";
FileConfiguration cfg = plugin.getConfig();
boolean save = false;
if (defaults != null) {
for (Map.Entry<String, Object> entry : defaults.entrySet()) {
if (entry.getKey() == null || entry.getKey().isEmpty()) {
continue;
}
if (entry.getValue() == null) {
if (cfg.contains(pre + entry.getKey())) {
save = true;
cfg.set(pre + entry.getKey(), null);
}
} else {
if (!cfg.contains(pre + entry.getKey())) {
save = true;
cfg.set(pre + entry.getKey(), entry.getValue());
}
}
}
}
if (save) {
plugin.saveConfig();
plugin.reloadConfig();
}
}
if (expansion instanceof VersionSpecific) {
VersionSpecific nms = (VersionSpecific) expansion;
Version serverVersion = PlaceholderAPIPlugin.getServerVersion();
if (!nms.isCompatibleWith(serverVersion)) {
plugin.getLogger().warning("PlaceholderExpansion " + expansion.getIdentifier() +
" is incompatible with your server version (" + serverVersion.getVersion() + ").");
return false;
}
}
final PlaceholderExpansion removed = getExpansion(identifier);
if (removed != null && !removed.unregister()) {
plugin.getLogger().warning("PlaceholderExpansion " + expansion.getIdentifier() +
"could not be registered as it has been already loaded and couldn't be unloaded.");
return false;
}
final ExpansionRegisterEvent event = new ExpansionRegisterEvent(expansion);
Bukkit.getPluginManager().callEvent(event);
if (event.isCancelled()) {
return false;
}
expansionsLock.lock();
try {
expansions.put(identifier, expansion);
} finally {
expansionsLock.unlock();
}
if (expansion instanceof Listener) {
plugin.getLogger().info("PlaceholderExpansion " + expansion.getIdentifier() +
" registered as a Listener for Events.");
Bukkit.getPluginManager().registerEvents((Listener) expansion, plugin);
}
plugin.getLogger().info("Successfully registered " + expansion.getIdentifier() +
" [" + expansion.getVersion() + "]");
if (expansion instanceof Taskable) {
((Taskable) expansion).start();
}
if (plugin.getPlaceholderAPIConfig().isCloudEnabled()) {
final Optional<CloudExpansion> optionalCloudExpansion = plugin.getCloudExpansionManager()
.findCloudExpansionByName(identifier);
if (optionalCloudExpansion.isPresent()) {
CloudExpansion cloudExpansion = optionalCloudExpansion.get();
cloudExpansion.setHasExpansion(true);
cloudExpansion.setShouldUpdate(
!cloudExpansion.getLatestVersion().equals(expansion.getVersion())
);
}
}
return true;
}
private void registerAll(@NotNull final CommandSender sender) {
plugin.getLogger().info("Placeholder expansion registration initializing...");
Futures.onMainThread(plugin, findExpansionsOnDisk(), (classes, exception) -> {
loaded = true;
Futures.onMainThread(plugin, collectExpansions(), (expansions, exception) -> {
if (exception != null) {
plugin.getLogger().log(Level.SEVERE, "failed to load class files of expansions", exception);
return;
}
final List<PlaceholderExpansion> registered = classes.stream()
final List<PlaceholderExpansion> registered = expansions.stream()
.filter(Objects::nonNull)
.map(this::register)
.filter(Optional::isPresent)
.map(Optional::get)
.filter(this::loadExpansion)
.collect(Collectors.toList());
final long needsUpdate = registered.stream()
@ -351,7 +379,6 @@ public final class LocalExpansionManager implements Listener {
.append("placeholder hook(s) have an update available.");
}
Msg.msg(sender, message.toString());
Bukkit.getPluginManager().callEvent(new ExpansionsLoadedEvent(registered));
@ -367,52 +394,59 @@ public final class LocalExpansionManager implements Listener {
expansion.unregister();
}
}
@NotNull
public CompletableFuture<@NotNull List<@Nullable Class<? extends PlaceholderExpansion>>> findExpansionsOnDisk() {
public CompletableFuture<@NotNull List<@Nullable PlaceholderExpansion>> collectExpansions() {
File[] files = folder.listFiles((dir, name) -> name.endsWith(".jar"));
if(files == null){
return CompletableFuture.completedFuture(Collections.emptyList());
if (files == null) {
return CompletableFuture.completedFuture(expansionQueue);
}
return Arrays.stream(files)
.map(this::findExpansionInFile)
.collect(Futures.collector());
}
@NotNull
public CompletableFuture<@Nullable Class<? extends PlaceholderExpansion>> findExpansionInFile(
@NotNull final File file) {
return CompletableFuture.supplyAsync(() -> {
try {
final Class<? extends PlaceholderExpansion> expansionClass = FileUtil.findClass(file, PlaceholderExpansion.class);
if (expansionClass == null) {
plugin.getLogger().severe("Failed to load Expansion: " + file.getName() + ", as it does not have" +
" a class which extends PlaceholderExpansion.");
return null;
}
Set<MethodSignature> expansionMethods = Arrays.stream(expansionClass.getDeclaredMethods())
.map(method -> new MethodSignature(method.getName(), method.getParameterTypes()))
.collect(Collectors.toSet());
if (!expansionMethods.containsAll(ABSTRACT_EXPANSION_METHODS)) {
plugin.getLogger().severe("Failed to load Expansion: " + file.getName() + ", as it does not have the" +
" required methods declared for a PlaceholderExpansion.");
return null;
}
return expansionClass;
} catch (final VerifyError ex) {
plugin.getLogger().severe("Failed to load Expansion class " + file.getName() +
" (Is a dependency missing?)");
plugin.getLogger().severe("Cause: " + ex.getClass().getSimpleName() + " " + ex.getMessage());
return null;
} catch (final Exception ex) {
throw new CompletionException(ex);
}
Arrays.stream(files)
.map(this::findExpansions)
.forEach(expansionQueue::add);
return expansionQueue;
});
}
@Nullable
public PlaceholderExpansion findExpansions(@NotNull File file) {
try {
final Class<? extends PlaceholderExpansion> expansion = FileUtil.findClass(file,
PlaceholderExpansion.class);
if (expansion == null) {
plugin.getLogger()
.severe("Failed to load Expansion " + file.getName() + ". File does not have " +
"a class which extends PlaceholderExpansion.");
return null;
}
Set<MethodSignature> expansionMethods = Arrays.stream(expansion.getDeclaredMethods())
.map(method -> new MethodSignature(method.getName(), method.getParameterTypes()))
.collect(Collectors.toSet());
if (!expansionMethods.containsAll(ABSTRACT_EXPANSION_METHODS)) {
plugin.getLogger()
.severe("Failed to load Expansion " + file.getName() + ". File does not have " +
"the required methods declared for a PlaceholderExpansion.");
return null;
}
return expansion.getDeclaredConstructor().newInstance();
} catch (Exception ex) {
plugin.getLogger()
.severe("Failed to load Expansion " + file.getName() + ". (Is a dependency missing?)");
plugin.getLogger().severe("Cause: " + ex.getClass().getSimpleName() + " " + ex.getMessage());
return null;
}
}
@NotNull
public CompletableFuture<@Nullable PlaceholderExpansion> findExpansion(@NotNull final File file) {
return CompletableFuture.supplyAsync(() -> findExpansions(file));
}
@Nullable

2
src/main/java/me/clip/placeholderapi/util/FileUtil.java
View File

@ -50,7 +50,7 @@ public class FileUtil {
JarEntry entry;
while ((entry = stream.getNextJarEntry()) != null) {
final String name = entry.getName();
if (name.isEmpty() || !name.endsWith(".class")) {
if (!name.endsWith(".class")) {
continue;
}