From 01d139f43510200808e07d4c5b01deea1b333471 Mon Sep 17 00:00:00 2001 From: ajgeiss0702 Date: Mon, 28 Aug 2023 16:41:23 -0700 Subject: [PATCH] Folia support! --- build.gradle.kts | 10 +- .../java/us/ajg0702/leaderboards/Debug.java | 4 + .../leaderboards/LeaderboardPlugin.java | 76 +- .../us/ajg0702/leaderboards/Listeners.java | 4 +- .../leaderboards/boards/TopManager.java | 2 +- .../commands/main/subcommands/Add.java | 2 +- .../commands/main/subcommands/Export.java | 2 +- .../commands/main/subcommands/Import.java | 2 +- .../commands/main/subcommands/ListBoards.java | 2 +- .../commands/main/subcommands/Remove.java | 2 +- .../main/subcommands/RemovePlayer.java | 2 +- .../commands/main/subcommands/Reset.java | 2 +- .../main/subcommands/UpdatePlayer.java | 2 +- .../commands/main/subcommands/Viewer.java | 2 +- .../main/subcommands/signs/Teleport.java | 3 +- .../armorstands/ArmorStandManager.java | 69 +- .../displays/heads/HeadManager.java | 2 +- .../displays/signs/BoardSign.java | 9 +- .../displays/signs/SignManager.java | 33 +- .../ajg0702/leaderboards/utils/Metrics.java | 882 ++++++++++++++++++ .../leaderboards/utils/OfflineUpdater.java | 2 +- src/main/resources/plugin.yml | 1 + 22 files changed, 1022 insertions(+), 93 deletions(-) create mode 100644 src/main/java/us/ajg0702/leaderboards/utils/Metrics.java diff --git a/build.gradle.kts b/build.gradle.kts index 0b916164..52321a56 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -20,6 +20,9 @@ repositories { maven { url = uri("https://repo.citizensnpcs.co/") } maven { url = uri("https://oss.sonatype.org/content/groups/public/") } maven { url = uri("https://s01.oss.sonatype.org/content/repositories/snapshots/") } + maven { url = uri("https://papermc.io/repo/repository/maven-public/") } + + mavenLocal() } dependencies { @@ -32,18 +35,18 @@ dependencies { compileOnly("org.xerial:sqlite-jdbc:3.32.3.2") compileOnly("org.spongepowered:configurate-yaml:4.0.0") - implementation("org.bstats:bstats-bukkit:1.7") - implementation("net.kyori:adventure-api:4.12.0") implementation("net.kyori:adventure-text-minimessage:4.12.0") implementation("net.kyori:adventure-platform-bukkit:4.3.0") - implementation("us.ajg0702:ajUtils:1.2.12") + implementation("us.ajg0702:ajUtils:1.2.23") implementation("us.ajg0702.commands.platforms.bukkit:bukkit:1.0.0") implementation("us.ajg0702.commands.api:api:1.0.0") compileOnly("net.luckperms:api:5.4") + implementation("io.papermc:paperlib:1.0.7") + implementation(project(":nms:nms-legacy")) implementation(project(":nms:nms-19")) @@ -83,6 +86,7 @@ tasks.shadowJar { relocate("org.spongepowered", "us.ajg0702.leaderboards.libs") relocate("org.yaml", "us.ajg0702.leaderboards.libs") relocate("io.leangen", "us.ajg0702.leaderboards.libs") + relocate("io.papermc.lib", "us.ajg0702.leaderboards.libs.paperlib") archiveBaseName.set("ajLeaderboards") archiveClassifier.set("") diff --git a/src/main/java/us/ajg0702/leaderboards/Debug.java b/src/main/java/us/ajg0702/leaderboards/Debug.java index b7826a8a..9d715230 100644 --- a/src/main/java/us/ajg0702/leaderboards/Debug.java +++ b/src/main/java/us/ajg0702/leaderboards/Debug.java @@ -23,6 +23,10 @@ public static void info(String message) { logger.info("[DEBUG] "+message); } + public static boolean isDebug() { + return debug; + } + private static boolean particles = false; public static void setParticles(boolean particles) { diff --git a/src/main/java/us/ajg0702/leaderboards/LeaderboardPlugin.java b/src/main/java/us/ajg0702/leaderboards/LeaderboardPlugin.java index d6307c3b..81c305df 100644 --- a/src/main/java/us/ajg0702/leaderboards/LeaderboardPlugin.java +++ b/src/main/java/us/ajg0702/leaderboards/LeaderboardPlugin.java @@ -8,8 +8,9 @@ import net.kyori.adventure.text.Component; import net.kyori.adventure.text.minimessage.MiniMessage; import net.milkbowl.vault.chat.Chat; -import org.bstats.bukkit.Metrics; import org.bukkit.Bukkit; +import org.bukkit.Location; +import org.bukkit.Material; import org.bukkit.entity.Player; import org.bukkit.plugin.RegisteredServiceProvider; import org.bukkit.plugin.java.JavaPlugin; @@ -36,12 +37,11 @@ import us.ajg0702.leaderboards.loaders.MessageLoader; import us.ajg0702.leaderboards.nms.legacy.HeadUtils; import us.ajg0702.leaderboards.placeholders.PlaceholderExpansion; -import us.ajg0702.leaderboards.utils.Exporter; -import us.ajg0702.leaderboards.utils.OfflineUpdater; -import us.ajg0702.leaderboards.utils.ResetSaver; -import us.ajg0702.leaderboards.utils.SlimJarLogger; +import us.ajg0702.leaderboards.utils.*; import us.ajg0702.utils.common.Config; import us.ajg0702.utils.common.Messages; +import us.ajg0702.utils.foliacompat.CompatScheduler; +import us.ajg0702.utils.foliacompat.Task; import java.io.File; import java.io.IOException; @@ -82,6 +82,8 @@ public class LeaderboardPlugin extends JavaPlugin { private boolean shuttingDown = false; + private final CompatScheduler compatScheduler = new CompatScheduler(this); + @Override public void onLoad() { try { @@ -150,7 +152,7 @@ public void onEnable() { TimeUtils.setStrings(messages); - Bukkit.getScheduler().runTaskAsynchronously(this, () -> { + getScheduler().runTaskAsynchronously(() -> { if(Bukkit.getPluginManager().isPluginEnabled("Vault")) { RegisteredServiceProvider rsp = getServer().getServicesManager().getRegistration(Chat.class); if(rsp == null) { @@ -183,9 +185,8 @@ public void onEnable() { reloadInterval(); - Bukkit.getScheduler().runTaskTimerAsynchronously(this, this::scheduleResets, 0, 15 * 60 * 20); - Bukkit.getScheduler().runTaskTimerAsynchronously( - this, + getScheduler().runTaskTimerAsynchronously(this::scheduleResets, 0, 15 * 60 * 20); + getScheduler().runTaskTimerAsynchronously( () -> offlineUpdaters.forEach((b, u) -> u.progressLog()), 5 * 20, 30 * 20 @@ -220,7 +221,7 @@ private Iterable getSignPath(String end) { public void onDisable() { shuttingDown = true; if(getContextLoader() != null) getContextLoader().checkReload(false); - Bukkit.getScheduler().cancelTasks(this); + getScheduler().cancelTasks(); if(getTopManager() != null) getTopManager().shutdown(); if(getCache() != null) { @@ -247,7 +248,7 @@ public void onDisable() { getLogger().info("ajLeaderboards v"+getDescription().getVersion()+" disabled."); - Bukkit.getScheduler().getActiveWorkers().forEach(bukkitWorker -> { + getScheduler().getActiveWorkers().forEach(bukkitWorker -> { Debug.info("Active worker: "+bukkitWorker.getOwner().getDescription().getName()+" "+bukkitWorker.getTaskId()); for (StackTraceElement stackTraceElement : bukkitWorker.getThread().getStackTrace()) { Debug.info(" - "+stackTraceElement); @@ -256,7 +257,7 @@ public void onDisable() { } private void killWorkers(int waitForDeath) { - List workers = new ArrayList<>(Bukkit.getScheduler().getActiveWorkers()); + List workers = new ArrayList<>(getScheduler().getActiveWorkers()); List killedWorkers = new ArrayList<>(); workers.forEach(bukkitWorker -> { if(!bukkitWorker.getOwner().equals(this)) return; @@ -341,15 +342,23 @@ public ResetSaver getResetSaver() { return resetSaver; } - int updateTaskId = -1; + public CompatScheduler getCompatScheduler() { + return compatScheduler; + } + + public CompatScheduler getScheduler() { + return getCompatScheduler(); + } + + Task updateTask; public void reloadInterval() { - if(updateTaskId != -1) { + if(updateTask != null) { try { - Bukkit.getScheduler().cancelTask(updateTaskId); + updateTask.cancel(); } catch(IllegalArgumentException ignored) {} - updateTaskId = -1; + updateTask = null; } - updateTaskId = Bukkit.getScheduler().runTaskTimerAsynchronously(this, () -> { + updateTask = getScheduler().runTaskTimerAsynchronously(() -> { if(!config.getBoolean("update-stats")) return; if(getTopManager().getFetchingAverage() > 100) { getLogger().warning("Database is overloaded! Skipping update of players."); @@ -359,21 +368,20 @@ public void reloadInterval() { if(isShuttingDown()) return; getTopManager().submit(() -> getCache().updatePlayerStats(p)); } - }, 10*20, config.getInt("stat-refresh")).getTaskId(); - Debug.info("Update task id is "+updateTaskId); + }, 10*20, config.getInt("stat-refresh")); } - final HashMap resetIds = new HashMap<>(); + final HashMap resetTasks = new HashMap<>(); public void scheduleResets() { - resetIds.values().forEach(Bukkit.getScheduler()::cancelTask); - resetIds.clear(); + resetTasks.values().forEach(Task::cancel); + resetTasks.clear(); for(TimedType type : TimedType.values()) { try { scheduleReset(type); } catch (ExecutionException | InterruptedException e) { if(isShuttingDown()) return; - getLogger().log(Level.WARNING, "Scheduling reset interupted:", e); + getLogger().log(Level.WARNING, "Scheduling reset interrupted:", e); } } } @@ -400,7 +408,7 @@ public void scheduleReset(TimedType type) throws ExecutionException, Interrupted } if(resetNow.size() > 0) { - Bukkit.getScheduler().runTaskAsynchronously(this, () -> { + getScheduler().runTaskAsynchronously(() -> { try { for (String board : resetNow) { cache.reset(board, type); @@ -424,8 +432,7 @@ public void scheduleReset(TimedType type) throws ExecutionException, Interrupted Debug.info(TimeUtils.formatTimeSeconds(secsTilNextReset)+" until the reset for "+type.lowerName()+" (next formatted: "+type.getNextReset().atOffset(ZoneOffset.UTC).format(DateTimeFormatter.RFC_1123_DATE_TIME)+" next: "+nextReset+")"); if(isShuttingDown()) return; - int taskId = Bukkit.getScheduler().runTaskLaterAsynchronously( - this, + Task task = getScheduler().runTaskLaterAsynchronously( () -> { try { for (String board : getTopManager().getBoards()) { @@ -437,8 +444,8 @@ public void scheduleReset(TimedType type) throws ExecutionException, Interrupted } }, secsTilNextReset*20L - ).getTaskId(); - resetIds.put(type, taskId); + ); + resetTasks.put(type, task); } public boolean validatePlaceholder(String placeholder, CommandSender sayOutput) { @@ -525,4 +532,17 @@ public void timePlaceholderUsed() { } doublePrevention = false; } + + public Future safeGetBlockType(Location location) { + CompletableFuture future = new CompletableFuture<>(); + Runnable runnable = () -> { + future.complete(location.getBlock().getType()); + }; + if(CompatScheduler.isFolia()) { + getScheduler().runSync(location, runnable); + } else { + runnable.run(); + } + return future; + } } diff --git a/src/main/java/us/ajg0702/leaderboards/Listeners.java b/src/main/java/us/ajg0702/leaderboards/Listeners.java index ab3384cb..61ba92fe 100644 --- a/src/main/java/us/ajg0702/leaderboards/Listeners.java +++ b/src/main/java/us/ajg0702/leaderboards/Listeners.java @@ -20,7 +20,7 @@ public Listeners(LeaderboardPlugin plugin) { @EventHandler public void onJoin(PlayerJoinEvent e) { if(plugin.getCache().getMethod().getName().equals("sqlite") && e.getPlayer().hasPermission("ajleaderboards.use")) { - Bukkit.getScheduler().runTaskLaterAsynchronously(plugin, () -> { + plugin.getScheduler().runTaskLaterAsynchronously(() -> { plugin.getAdventure().player(e.getPlayer()) .sendMessage(message( "\n&6[ajLeaderboards] &cSQLite is not recommended and will be removed! &7Please switch to h2 for a faster (and more stable) cache storage.\n" + @@ -36,7 +36,7 @@ public void onJoin(PlayerJoinEvent e) { } if(!plugin.getAConfig().getBoolean("update-stats")) return; if(!plugin.getAConfig().getBoolean("update-on-join")) return; - Bukkit.getScheduler().runTaskAsynchronously(plugin, () -> plugin.getCache().updatePlayerStats(e.getPlayer())); + plugin.getScheduler().runTaskAsynchronously(() -> plugin.getCache().updatePlayerStats(e.getPlayer())); } @EventHandler diff --git a/src/main/java/us/ajg0702/leaderboards/boards/TopManager.java b/src/main/java/us/ajg0702/leaderboards/boards/TopManager.java index e336ced8..a7b0fae2 100644 --- a/src/main/java/us/ajg0702/leaderboards/boards/TopManager.java +++ b/src/main/java/us/ajg0702/leaderboards/boards/TopManager.java @@ -51,7 +51,7 @@ public TopManager(LeaderboardPlugin pl, List initialBoards) { ThreadFactoryProxy.getDefaultThreadFactory("AJLBFETCH") ); fetchService.allowCoreThreadTimeOut(true); - Bukkit.getScheduler().runTaskTimerAsynchronously(plugin, () -> { + plugin.getScheduler().runTaskTimerAsynchronously(() -> { rolling.add(getQueuedTasks()+getActiveFetchers()); if(rolling.size() > 50) { rolling.remove(0); diff --git a/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/Add.java b/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/Add.java index 8ac97676..bc82bb69 100644 --- a/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/Add.java +++ b/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/Add.java @@ -27,7 +27,7 @@ public List autoComplete(CommandSender commandSender, String[] args) { @Override public void execute(CommandSender sender, String[] args, String label) { - Bukkit.getScheduler().runTaskAsynchronously(plugin, () -> { + plugin.getScheduler().runTaskAsynchronously(() -> { if(args.length < 1) { sender.sendMessage(message("&cPlease provide a placeholder to track.\n&7Usage: /"+label+" add ")); return; diff --git a/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/Export.java b/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/Export.java index 2b5cea5e..505dd8b8 100644 --- a/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/Export.java +++ b/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/Export.java @@ -37,7 +37,7 @@ public void execute(CommandSender sender, String[] args, String label) { sender.sendMessage(message("&cPlease provide a file name.\n&7Usage: /"+label+" export ")); return; } - Bukkit.getScheduler().runTaskAsynchronously(plugin, () -> { + plugin.getScheduler().runTaskAsynchronously(() -> { String fileName = addJsonEnding(args[0]); File file = new File(plugin.getDataFolder(), fileName); diff --git a/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/Import.java b/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/Import.java index c235cf5e..7bd4e90b 100644 --- a/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/Import.java +++ b/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/Import.java @@ -42,7 +42,7 @@ public void execute(CommandSender sender, String[] args, String label) { sender.sendMessage(message("&cPlease provide a file name.\n&7Usage: /"+label+" import ")); return; } - Bukkit.getScheduler().runTaskAsynchronously(plugin, () -> { + plugin.getScheduler().runTaskAsynchronously(() -> { File file = new File(plugin.getDataFolder(), args[0]); if(!file.exists()) { sender.sendMessage(plugin.getMessages().getComponent("commands.import.nofile", "FILE:"+file.getName())); diff --git a/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/ListBoards.java b/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/ListBoards.java index 5b398388..d27c71a9 100644 --- a/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/ListBoards.java +++ b/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/ListBoards.java @@ -26,7 +26,7 @@ public java.util.List autoComplete(CommandSender commandSender, String[] @Override public void execute(CommandSender sender, String[] args, String label) { - Bukkit.getScheduler().runTaskAsynchronously(plugin, () -> { + plugin.getScheduler().runTaskAsynchronously(() -> { if(args.length < 1) { StringBuilder list = new StringBuilder("&6Boards"); for(String boardn : plugin.getTopManager().getBoards()) { diff --git a/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/Remove.java b/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/Remove.java index 6b9d0d7c..4cc10cba 100644 --- a/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/Remove.java +++ b/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/Remove.java @@ -50,7 +50,7 @@ public void execute(CommandSender sender, String[] args, String label) { "")); confirmDeletes.put(sender.getHandle(), board); Debug.info("Added confirmDelete: "+confirmDeletes.keySet().size()); - Bukkit.getScheduler().runTaskLater(plugin, () -> { + plugin.getScheduler().runTaskLaterAsynchronously(() -> { Debug.info("Removing confirmDelete"); if(confirmDeletes.containsKey(sender.getHandle()) && confirmDeletes.get(sender.getHandle()).equals(board)) { confirmDeletes.remove(sender.getHandle()); diff --git a/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/RemovePlayer.java b/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/RemovePlayer.java index a4178a9e..29416d47 100644 --- a/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/RemovePlayer.java +++ b/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/RemovePlayer.java @@ -54,7 +54,7 @@ public void execute(CommandSender sender, String[] args, String label) { boards = plugin.getCache().getBoards(); } List finalBoards = boards; - Bukkit.getScheduler().runTaskAsynchronously(plugin, () -> { + plugin.getScheduler().runTaskAsynchronously(() -> { for(String b : finalBoards) { if(plugin.getCache().removePlayer(b, playername)) { sender.sendMessage(message("&aRemoved "+playername+" from "+b+"!")); diff --git a/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/Reset.java b/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/Reset.java index a02538a6..bea5c5bb 100644 --- a/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/Reset.java +++ b/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/Reset.java @@ -53,7 +53,7 @@ public void execute(CommandSender sender, String[] args, String label) { "")); confirmResets.put(sender.getHandle(), board); Debug.info("Added confirmDelete: "+ confirmResets.keySet().size()); - Bukkit.getScheduler().runTaskLater(plugin, () -> { + plugin.getScheduler().runTaskLaterAsynchronously(() -> { if(confirmResets.containsKey(sender.getHandle()) && confirmResets.get(sender.getHandle()).equals(board)) { confirmResets.remove(sender.getHandle()); } diff --git a/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/UpdatePlayer.java b/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/UpdatePlayer.java index 5a53ec87..b649638d 100644 --- a/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/UpdatePlayer.java +++ b/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/UpdatePlayer.java @@ -37,7 +37,7 @@ public void execute(CommandSender sender, String[] args, String label) { sender.sendMessage(message("&cPlease provide a board and player to update\n&7Usage: /"+label+" update ")); return; } - Bukkit.getScheduler().runTaskAsynchronously(plugin, () -> { + plugin.getScheduler().runTaskAsynchronously(() -> { String board = args[0]; if(!plugin.getCache().boardExists(board) && !board.equals("*")) { sender.sendMessage(message("&cThe board '"+board+"' does not exist.")); diff --git a/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/Viewer.java b/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/Viewer.java index 98e3a8eb..983ab231 100644 --- a/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/Viewer.java +++ b/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/Viewer.java @@ -35,7 +35,7 @@ public List autoComplete(CommandSender sender, String[] args) { @Override public void execute(CommandSender sender, String[] args, String label) { - Bukkit.getScheduler().runTaskAsynchronously(plugin, () -> { + plugin.getScheduler().runTaskAsynchronously(() -> { JsonObject obj = plugin.getExporter().export(sender); if(obj == null) { sender.sendMessage(plugin.getMessages().getComponent("commands.export.fail")); diff --git a/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/signs/Teleport.java b/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/signs/Teleport.java index d39faf25..b4cdde2d 100644 --- a/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/signs/Teleport.java +++ b/src/main/java/us/ajg0702/leaderboards/commands/main/subcommands/signs/Teleport.java @@ -1,5 +1,6 @@ package us.ajg0702.leaderboards.commands.main.subcommands.signs; +import io.papermc.lib.PaperLib; import org.bukkit.Location; import org.bukkit.entity.Player; import us.ajg0702.commands.CommandSender; @@ -65,6 +66,6 @@ public void execute(CommandSender sender, String[] args, String label) { loc.setX(loc.getBlockX()+0.5); loc.setZ(loc.getBlockZ()+0.5); - player.teleport(loc); + PaperLib.teleportAsync(player, loc); } } diff --git a/src/main/java/us/ajg0702/leaderboards/displays/armorstands/ArmorStandManager.java b/src/main/java/us/ajg0702/leaderboards/displays/armorstands/ArmorStandManager.java index ed1efdba..a542f874 100644 --- a/src/main/java/us/ajg0702/leaderboards/displays/armorstands/ArmorStandManager.java +++ b/src/main/java/us/ajg0702/leaderboards/displays/armorstands/ArmorStandManager.java @@ -14,6 +14,7 @@ import us.ajg0702.leaderboards.Debug; import us.ajg0702.leaderboards.LeaderboardPlugin; import us.ajg0702.leaderboards.displays.signs.BoardSign; +import us.ajg0702.utils.foliacompat.CompatScheduler; import us.ajg0702.utils.spigot.VersionSupport; import java.util.*; @@ -58,46 +59,53 @@ private void checkArmorstand(BoardSign sign, Location loc, String name, UUID id) private void setArmorstandHead(ArmorStand stand, String name, UUID uuid) { Debug.info("Updating armorstand"); - if(VersionSupport.getMinorVersion() >= 10) { - stand.setSilent(true); - } ItemStack item; if(plugin.getHeadUtils().getVersionedHeadUtils() != null) { item = plugin.getHeadUtils().getVersionedHeadUtils().getHeadItem(uuid, name); } else { item = plugin.getHeadUtils().getHeadItem(uuid, name); } - //noinspection deprecation - stand.setHelmet(item); - } - public void search(BoardSign sign, String name, UUID id) { - if(!sign.getLocation().getBlock().getType().toString().contains("SIGN")) return; - if(!plugin.getTopManager().getBoards().contains(sign.getBoard())) return; - if(id == null) return; - Sign ss = sign.getSign(); - if(ss == null) return; - BlockFace face; - if(VersionSupport.getMinorVersion() > 12) { - BlockData bd = ss.getBlockData(); - if(bd instanceof org.bukkit.block.data.type.Sign) { - org.bukkit.block.data.type.Sign bs = (org.bukkit.block.data.type.Sign) bd; - face = bs.getRotation(); - } else if(bd instanceof WallSign) { - WallSign bs = (WallSign) bd; - face = bs.getFacing(); - } else { - Debug.info("Skipping getting face for sign because it is an unknown type! " + bd.getClass()); - return; + Runnable runnable = () -> { + if(VersionSupport.getMinorVersion() >= 10) { + stand.setSilent(true); } + //noinspection deprecation + stand.setHelmet(item); + }; + if(CompatScheduler.isFolia()) { + plugin.getScheduler().runSync(stand, runnable); } else { - @SuppressWarnings("deprecation") org.bukkit.material.Sign bs = (org.bukkit.material.Sign) ss.getData(); - face = bs.getFacing(); + runnable.run(); } + } - Location sl = sign.getLocation(); - + public void search(BoardSign sign, String name, UUID id) { try { + if(!plugin.safeGetBlockType(sign.getLocation()).get(1, TimeUnit.SECONDS).toString().contains("SIGN")) return; + if(!plugin.getTopManager().getBoards().contains(sign.getBoard())) return; + if(id == null) return; + Sign ss = sign.getSign(); + if(ss == null) return; + BlockFace face; + if(VersionSupport.getMinorVersion() > 12) { + BlockData bd = ss.getBlockData(); + if(bd instanceof org.bukkit.block.data.type.Sign) { + org.bukkit.block.data.type.Sign bs = (org.bukkit.block.data.type.Sign) bd; + face = bs.getRotation(); + } else if(bd instanceof WallSign) { + WallSign bs = (WallSign) bd; + face = bs.getFacing(); + } else { + Debug.info("Skipping getting face for sign because it is an unknown type! " + bd.getClass()); + return; + } + } else { + @SuppressWarnings("deprecation") org.bukkit.material.Sign bs = (org.bukkit.material.Sign) ss.getData(); + face = bs.getFacing(); + } + + Location sl = sign.getLocation(); switch(face) { case NORTH: @@ -176,12 +184,13 @@ private Future> getNearbyEntities(Location loc) { if(world == null) { throw new IllegalArgumentException("Invalid world"); } - Bukkit.getScheduler().runTask( - plugin, + plugin.getScheduler().runSync( + loc, () -> future.complete(world.getNearbyEntities(loc, 1, 1, 1)) ); return future; } + public static void debugParticles(Location curloc) { if(!Debug.particles()) return; World world = curloc.getWorld(); diff --git a/src/main/java/us/ajg0702/leaderboards/displays/heads/HeadManager.java b/src/main/java/us/ajg0702/leaderboards/displays/heads/HeadManager.java index ccf3e27b..b108850f 100644 --- a/src/main/java/us/ajg0702/leaderboards/displays/heads/HeadManager.java +++ b/src/main/java/us/ajg0702/leaderboards/displays/heads/HeadManager.java @@ -140,7 +140,7 @@ public void checkHead(Location loc, String name, UUID id) { OfflinePlayer op = VersionSupport.getMinorVersion() > 9 ? Bukkit.getOfflinePlayer(id) : null; - Bukkit.getScheduler().runTask(plugin, () -> { + plugin.getScheduler().runSync(loc, () -> { if(plugin.getHeadUtils().getVersionedHeadUtils() != null) { plugin.getHeadUtils().getVersionedHeadUtils().setHeadBlock(loc.getBlock(), id, name); } else { diff --git a/src/main/java/us/ajg0702/leaderboards/displays/signs/BoardSign.java b/src/main/java/us/ajg0702/leaderboards/displays/signs/BoardSign.java index 2faf1512..1f2121f7 100644 --- a/src/main/java/us/ajg0702/leaderboards/displays/signs/BoardSign.java +++ b/src/main/java/us/ajg0702/leaderboards/displays/signs/BoardSign.java @@ -6,6 +6,7 @@ import org.bukkit.block.BlockState; import org.bukkit.block.Sign; import org.bukkit.plugin.Plugin; +import us.ajg0702.leaderboards.Debug; import us.ajg0702.leaderboards.LeaderboardPlugin; import us.ajg0702.leaderboards.boards.TimedType; import us.ajg0702.utils.spigot.LocUtils; @@ -34,8 +35,8 @@ public BoardSign(Location location, String board, int position, TimedType type) this.board = board; this.position = position; - this.x = location.getChunk().getX(); - this.z = location.getChunk().getZ(); + this.x = location.getBlockX() >> 4; + this.z = location.getBlockZ() >> 4; this.world = location.getWorld(); this.type = type; @@ -47,7 +48,7 @@ public BoardSign(Location location, String board, int position, TimedType type) private Future setSign() { CompletableFuture future = new CompletableFuture<>(); - Bukkit.getScheduler().runTask(plugin, () -> { + plugin.getScheduler().runSync(location, () -> { BlockState state = location.getBlock().getState(); if(!(state instanceof Sign)) { sign = null; @@ -112,7 +113,7 @@ private Future getBlockType(Location location) { future.completeExceptionally(new InterruptedException()); return future; } - Bukkit.getScheduler().runTask(plugin, () -> future.complete(location.getBlock().getType().toString())); + plugin.getScheduler().runSync(location, () -> future.complete(location.getBlock().getType().toString())); return future; } diff --git a/src/main/java/us/ajg0702/leaderboards/displays/signs/SignManager.java b/src/main/java/us/ajg0702/leaderboards/displays/signs/SignManager.java index 095d1279..69b8bce4 100644 --- a/src/main/java/us/ajg0702/leaderboards/displays/signs/SignManager.java +++ b/src/main/java/us/ajg0702/leaderboards/displays/signs/SignManager.java @@ -5,10 +5,12 @@ import org.bukkit.Bukkit; import org.bukkit.Location; import org.bukkit.configuration.file.YamlConfiguration; +import us.ajg0702.leaderboards.Debug; import us.ajg0702.leaderboards.LeaderboardPlugin; import us.ajg0702.leaderboards.boards.StatEntry; import us.ajg0702.leaderboards.boards.TimedType; import us.ajg0702.utils.common.Messages; +import us.ajg0702.utils.foliacompat.Task; import us.ajg0702.utils.spigot.VersionSupport; import java.io.File; @@ -33,7 +35,7 @@ public class SignManager { public SignManager(LeaderboardPlugin plugin) { this.plugin = plugin; - Bukkit.getScheduler().runTask(plugin, this::reload); + plugin.getScheduler().runTaskAsynchronously(this::reload); } @@ -42,7 +44,7 @@ public List getSigns() { return signs; } - int updateIntervalId = -1; + Task updateInterval; public void reload() { cfgFile = new File(plugin.getDataFolder(), "displays.yml"); @@ -68,15 +70,15 @@ public void reload() { } updateNameCache(); - if(updateIntervalId != -1) { + if(updateInterval != null) { try { - Bukkit.getScheduler().cancelTask(updateIntervalId); - updateIntervalId = -1; + updateInterval.cancel(); + updateInterval = null; } catch(IllegalStateException e) { - updateIntervalId = -1; + updateInterval = null; } } - updateIntervalId = Bukkit.getScheduler().runTaskTimerAsynchronously(plugin, this::updateSigns, 10*20, plugin.getAConfig().getInt("sign-update")).getTaskId(); + updateInterval = plugin.getScheduler().runTaskTimerAsynchronously(this::updateSigns, 10*20, plugin.getAConfig().getInt("sign-update")); } /** @@ -103,7 +105,7 @@ public boolean removeSign(Location l, boolean removeText) { signs.remove(s); save = true; s.setRemoved(true); - if(removeText) Bukkit.getScheduler().runTask(plugin, () -> s.setText("", "", "", "")); + if(removeText) plugin.getScheduler().runSync(l, () -> s.setText("", "", "", "")); break; } } @@ -166,7 +168,9 @@ public Map getNames() { } public void updateSign(BoardSign sign) { - if(!isSignChunkLoaded(sign)) return; + if(!isSignChunkLoaded(sign)) { + return; + } try { if(!sign.isPlaced()) return; @@ -206,14 +210,17 @@ public void updateSign(BoardSign sign) { List pLines = new ArrayList<>(); lines.forEach(c -> pLines.add(LEGACY_SIGN_SERIALIZER.serialize(c))); - if(plugin.isShuttingDown()) return; if(r.hasPlayer()) { - plugin.getHeadManager().search(sign, r.getPlayerName(), r.getPlayerID()); - if(plugin.isShuttingDown()) return; plugin.getArmorStandManager().search(sign, r.getPlayerName(), r.getPlayerID()); } + if(plugin.isShuttingDown()) return; - Bukkit.getScheduler().runTask(plugin, () -> sign.setText(pLines.get(0), pLines.get(1), pLines.get(2), pLines.get(3))); + plugin.getScheduler().runSync(sign.getLocation(), () -> { + sign.setText(pLines.get(0), pLines.get(1), pLines.get(2), pLines.get(3)); + if(r.hasPlayer()) { + plugin.getHeadManager().search(sign, r.getPlayerName(), r.getPlayerID()); + } + }); } public boolean isSignChunkLoaded(BoardSign sign) { diff --git a/src/main/java/us/ajg0702/leaderboards/utils/Metrics.java b/src/main/java/us/ajg0702/leaderboards/utils/Metrics.java new file mode 100644 index 00000000..5d505eb5 --- /dev/null +++ b/src/main/java/us/ajg0702/leaderboards/utils/Metrics.java @@ -0,0 +1,882 @@ +/* + * This Metrics class was auto-generated and can be copied into your project if you are + * not using a build tool like Gradle or Maven for dependency management. + * + * IMPORTANT: You are not allowed to modify this class, except changing the package. + * + * Disallowed modifications include but are not limited to: + * - Remove the option for users to opt-out + * - Change the frequency for data submission + * - Obfuscate the code (every obfuscator should allow you to make an exception for specific files) + * - Reformat the code (if you use a linter, add an exception) + * + * Violations will result in a ban of your plugin and account from bStats. + */ +package us.ajg0702.leaderboards.utils; + +import java.io.BufferedReader; +import java.io.ByteArrayOutputStream; +import java.io.DataOutputStream; +import java.io.File; +import java.io.IOException; +import java.io.InputStreamReader; +import java.lang.reflect.Method; +import java.net.URL; +import java.nio.charset.StandardCharsets; +import java.util.Arrays; +import java.util.Collection; +import java.util.HashSet; +import java.util.Map; +import java.util.Objects; +import java.util.Set; +import java.util.UUID; +import java.util.concurrent.Callable; +import java.util.concurrent.ScheduledExecutorService; +import java.util.concurrent.ScheduledThreadPoolExecutor; +import java.util.concurrent.TimeUnit; +import java.util.function.BiConsumer; +import java.util.function.Consumer; +import java.util.function.Supplier; +import java.util.logging.Level; +import java.util.stream.Collectors; +import java.util.zip.GZIPOutputStream; +import javax.net.ssl.HttpsURLConnection; +import org.bukkit.Bukkit; +import org.bukkit.configuration.file.YamlConfiguration; +import org.bukkit.entity.Player; +import org.bukkit.plugin.Plugin; +import us.ajg0702.leaderboards.LeaderboardPlugin; + +public class Metrics { + + private final LeaderboardPlugin plugin; + + private final MetricsBase metricsBase; + + /** + * Creates a new Metrics instance. + * + * @param plugin Your plugin instance. + * @param serviceId The id of the service. It can be found at What is my plugin id? + */ + public Metrics(LeaderboardPlugin plugin, int serviceId) { + this.plugin = plugin; + // Get the config file + File bStatsFolder = new File(plugin.getDataFolder().getParentFile(), "bStats"); + File configFile = new File(bStatsFolder, "config.yml"); + YamlConfiguration config = YamlConfiguration.loadConfiguration(configFile); + if (!config.isSet("serverUuid")) { + config.addDefault("enabled", true); + config.addDefault("serverUuid", UUID.randomUUID().toString()); + config.addDefault("logFailedRequests", false); + config.addDefault("logSentData", false); + config.addDefault("logResponseStatusText", false); + // Inform the server owners about bStats + config + .options() + .header( + "bStats (https://bStats.org) collects some basic information for plugin authors, like how\n" + + "many people use their plugin and their total player count. It's recommended to keep bStats\n" + + "enabled, but if you're not comfortable with this, you can turn this setting off. There is no\n" + + "performance penalty associated with having metrics enabled, and data sent to bStats is fully\n" + + "anonymous.") + .copyDefaults(true); + try { + config.save(configFile); + } catch (IOException ignored) { + } + } + // Load the data + boolean enabled = config.getBoolean("enabled", true); + String serverUUID = config.getString("serverUuid"); + boolean logErrors = config.getBoolean("logFailedRequests", false); + boolean logSentData = config.getBoolean("logSentData", false); + boolean logResponseStatusText = config.getBoolean("logResponseStatusText", false); + metricsBase = + new MetricsBase( + "bukkit", + serverUUID, + serviceId, + enabled, + this::appendPlatformData, + this::appendServiceData, + submitDataTask -> plugin.getScheduler().runTaskAsynchronously(submitDataTask), + plugin::isEnabled, + (message, error) -> this.plugin.getLogger().log(Level.WARNING, message, error), + (message) -> this.plugin.getLogger().log(Level.INFO, message), + logErrors, + logSentData, + logResponseStatusText); + } + + /** Shuts down the underlying scheduler service. */ + public void shutdown() { + metricsBase.shutdown(); + } + + /** + * Adds a custom chart. + * + * @param chart The chart to add. + */ + public void addCustomChart(CustomChart chart) { + metricsBase.addCustomChart(chart); + } + + private void appendPlatformData(JsonObjectBuilder builder) { + builder.appendField("playerAmount", getPlayerAmount()); + builder.appendField("onlineMode", Bukkit.getOnlineMode() ? 1 : 0); + builder.appendField("bukkitVersion", Bukkit.getVersion()); + builder.appendField("bukkitName", Bukkit.getName()); + builder.appendField("javaVersion", System.getProperty("java.version")); + builder.appendField("osName", System.getProperty("os.name")); + builder.appendField("osArch", System.getProperty("os.arch")); + builder.appendField("osVersion", System.getProperty("os.version")); + builder.appendField("coreCount", Runtime.getRuntime().availableProcessors()); + } + + private void appendServiceData(JsonObjectBuilder builder) { + builder.appendField("pluginVersion", plugin.getDescription().getVersion()); + } + + private int getPlayerAmount() { + try { + // Around MC 1.8 the return type was changed from an array to a collection, + // This fixes java.lang.NoSuchMethodError: + // org.bukkit.Bukkit.getOnlinePlayers()Ljava/util/Collection; + Method onlinePlayersMethod = Class.forName("org.bukkit.Server").getMethod("getOnlinePlayers"); + return onlinePlayersMethod.getReturnType().equals(Collection.class) + ? ((Collection) onlinePlayersMethod.invoke(Bukkit.getServer())).size() + : ((Player[]) onlinePlayersMethod.invoke(Bukkit.getServer())).length; + } catch (Exception e) { + // Just use the new method if the reflection failed + return Bukkit.getOnlinePlayers().size(); + } + } + + public static class MetricsBase { + + /** The version of the Metrics class. */ + public static final String METRICS_VERSION = "3.0.2"; + + private static final String REPORT_URL = "https://bStats.org/api/v2/data/%s"; + + private final ScheduledExecutorService scheduler; + + private final String platform; + + private final String serverUuid; + + private final int serviceId; + + private final Consumer appendPlatformDataConsumer; + + private final Consumer appendServiceDataConsumer; + + private final Consumer submitTaskConsumer; + + private final Supplier checkServiceEnabledSupplier; + + private final BiConsumer errorLogger; + + private final Consumer infoLogger; + + private final boolean logErrors; + + private final boolean logSentData; + + private final boolean logResponseStatusText; + + private final Set customCharts = new HashSet<>(); + + private final boolean enabled; + + /** + * Creates a new MetricsBase class instance. + * + * @param platform The platform of the service. + * @param serviceId The id of the service. + * @param serverUuid The server uuid. + * @param enabled Whether or not data sending is enabled. + * @param appendPlatformDataConsumer A consumer that receives a {@code JsonObjectBuilder} and + * appends all platform-specific data. + * @param appendServiceDataConsumer A consumer that receives a {@code JsonObjectBuilder} and + * appends all service-specific data. + * @param submitTaskConsumer A consumer that takes a runnable with the submit task. This can be + * used to delegate the data collection to a another thread to prevent errors caused by + * concurrency. Can be {@code null}. + * @param checkServiceEnabledSupplier A supplier to check if the service is still enabled. + * @param errorLogger A consumer that accepts log message and an error. + * @param infoLogger A consumer that accepts info log messages. + * @param logErrors Whether or not errors should be logged. + * @param logSentData Whether or not the sent data should be logged. + * @param logResponseStatusText Whether or not the response status text should be logged. + */ + public MetricsBase( + String platform, + String serverUuid, + int serviceId, + boolean enabled, + Consumer appendPlatformDataConsumer, + Consumer appendServiceDataConsumer, + Consumer submitTaskConsumer, + Supplier checkServiceEnabledSupplier, + BiConsumer errorLogger, + Consumer infoLogger, + boolean logErrors, + boolean logSentData, + boolean logResponseStatusText) { + ScheduledThreadPoolExecutor scheduler = + new ScheduledThreadPoolExecutor(1, task -> new Thread(task, "bStats-Metrics")); + // We want delayed tasks (non-periodic) that will execute in the future to be + // cancelled when the scheduler is shutdown. + // Otherwise, we risk preventing the server from shutting down even when + // MetricsBase#shutdown() is called + scheduler.setExecuteExistingDelayedTasksAfterShutdownPolicy(false); + this.scheduler = scheduler; + this.platform = platform; + this.serverUuid = serverUuid; + this.serviceId = serviceId; + this.enabled = enabled; + this.appendPlatformDataConsumer = appendPlatformDataConsumer; + this.appendServiceDataConsumer = appendServiceDataConsumer; + this.submitTaskConsumer = submitTaskConsumer; + this.checkServiceEnabledSupplier = checkServiceEnabledSupplier; + this.errorLogger = errorLogger; + this.infoLogger = infoLogger; + this.logErrors = logErrors; + this.logSentData = logSentData; + this.logResponseStatusText = logResponseStatusText; + checkRelocation(); + if (enabled) { + // WARNING: Removing the option to opt-out will get your plugin banned from + // bStats + startSubmitting(); + } + } + + public void addCustomChart(CustomChart chart) { + this.customCharts.add(chart); + } + + public void shutdown() { + scheduler.shutdown(); + } + + private void startSubmitting() { + final Runnable submitTask = + () -> { + if (!enabled || !checkServiceEnabledSupplier.get()) { + // Submitting data or service is disabled + scheduler.shutdown(); + return; + } + if (submitTaskConsumer != null) { + submitTaskConsumer.accept(this::submitData); + } else { + this.submitData(); + } + }; + // Many servers tend to restart at a fixed time at xx:00 which causes an uneven + // distribution of requests on the + // bStats backend. To circumvent this problem, we introduce some randomness into + // the initial and second delay. + // WARNING: You must not modify and part of this Metrics class, including the + // submit delay or frequency! + // WARNING: Modifying this code will get your plugin banned on bStats. Just + // don't do it! + long initialDelay = (long) (1000 * 60 * (3 + Math.random() * 3)); + long secondDelay = (long) (1000 * 60 * (Math.random() * 30)); + scheduler.schedule(submitTask, initialDelay, TimeUnit.MILLISECONDS); + scheduler.scheduleAtFixedRate( + submitTask, initialDelay + secondDelay, 1000 * 60 * 30, TimeUnit.MILLISECONDS); + } + + private void submitData() { + final JsonObjectBuilder baseJsonBuilder = new JsonObjectBuilder(); + appendPlatformDataConsumer.accept(baseJsonBuilder); + final JsonObjectBuilder serviceJsonBuilder = new JsonObjectBuilder(); + appendServiceDataConsumer.accept(serviceJsonBuilder); + JsonObjectBuilder.JsonObject[] chartData = + customCharts.stream() + .map(customChart -> customChart.getRequestJsonObject(errorLogger, logErrors)) + .filter(Objects::nonNull) + .toArray(JsonObjectBuilder.JsonObject[]::new); + serviceJsonBuilder.appendField("id", serviceId); + serviceJsonBuilder.appendField("customCharts", chartData); + baseJsonBuilder.appendField("service", serviceJsonBuilder.build()); + baseJsonBuilder.appendField("serverUUID", serverUuid); + baseJsonBuilder.appendField("metricsVersion", METRICS_VERSION); + JsonObjectBuilder.JsonObject data = baseJsonBuilder.build(); + scheduler.execute( + () -> { + try { + // Send the data + sendData(data); + } catch (Exception e) { + // Something went wrong! :( + if (logErrors) { + errorLogger.accept("Could not submit bStats metrics data", e); + } + } + }); + } + + private void sendData(JsonObjectBuilder.JsonObject data) throws Exception { + if (logSentData) { + infoLogger.accept("Sent bStats metrics data: " + data.toString()); + } + String url = String.format(REPORT_URL, platform); + HttpsURLConnection connection = (HttpsURLConnection) new URL(url).openConnection(); + // Compress the data to save bandwidth + byte[] compressedData = compress(data.toString()); + connection.setRequestMethod("POST"); + connection.addRequestProperty("Accept", "application/json"); + connection.addRequestProperty("Connection", "close"); + connection.addRequestProperty("Content-Encoding", "gzip"); + connection.addRequestProperty("Content-Length", String.valueOf(compressedData.length)); + connection.setRequestProperty("Content-Type", "application/json"); + connection.setRequestProperty("User-Agent", "Metrics-Service/1"); + connection.setDoOutput(true); + try (DataOutputStream outputStream = new DataOutputStream(connection.getOutputStream())) { + outputStream.write(compressedData); + } + StringBuilder builder = new StringBuilder(); + try (BufferedReader bufferedReader = + new BufferedReader(new InputStreamReader(connection.getInputStream()))) { + String line; + while ((line = bufferedReader.readLine()) != null) { + builder.append(line); + } + } + if (logResponseStatusText) { + infoLogger.accept("Sent data to bStats and received response: " + builder); + } + } + + /** Checks that the class was properly relocated. */ + private void checkRelocation() { + // You can use the property to disable the check in your test environment + if (System.getProperty("bstats.relocatecheck") == null + || !System.getProperty("bstats.relocatecheck").equals("false")) { + // Maven's Relocate is clever and changes strings, too. So we have to use this + // little "trick" ... :D + final String defaultPackage = + new String(new byte[] {'o', 'r', 'g', '.', 'b', 's', 't', 'a', 't', 's'}); + final String examplePackage = + new String(new byte[] {'y', 'o', 'u', 'r', '.', 'p', 'a', 'c', 'k', 'a', 'g', 'e'}); + // We want to make sure no one just copy & pastes the example and uses the wrong + // package names + if (MetricsBase.class.getPackage().getName().startsWith(defaultPackage) + || MetricsBase.class.getPackage().getName().startsWith(examplePackage)) { + throw new IllegalStateException("bStats Metrics class has not been relocated correctly!"); + } + } + } + + /** + * Gzips the given string. + * + * @param str The string to gzip. + * @return The gzipped string. + */ + private static byte[] compress(final String str) throws IOException { + if (str == null) { + return null; + } + ByteArrayOutputStream outputStream = new ByteArrayOutputStream(); + try (GZIPOutputStream gzip = new GZIPOutputStream(outputStream)) { + gzip.write(str.getBytes(StandardCharsets.UTF_8)); + } + return outputStream.toByteArray(); + } + } + + public static class SimplePie extends CustomChart { + + private final Callable callable; + + /** + * Class constructor. + * + * @param chartId The id of the chart. + * @param callable The callable which is used to request the chart data. + */ + public SimplePie(String chartId, Callable callable) { + super(chartId); + this.callable = callable; + } + + @Override + protected JsonObjectBuilder.JsonObject getChartData() throws Exception { + String value = callable.call(); + if (value == null || value.isEmpty()) { + // Null = skip the chart + return null; + } + return new JsonObjectBuilder().appendField("value", value).build(); + } + } + + public static class MultiLineChart extends CustomChart { + + private final Callable> callable; + + /** + * Class constructor. + * + * @param chartId The id of the chart. + * @param callable The callable which is used to request the chart data. + */ + public MultiLineChart(String chartId, Callable> callable) { + super(chartId); + this.callable = callable; + } + + @Override + protected JsonObjectBuilder.JsonObject getChartData() throws Exception { + JsonObjectBuilder valuesBuilder = new JsonObjectBuilder(); + Map map = callable.call(); + if (map == null || map.isEmpty()) { + // Null = skip the chart + return null; + } + boolean allSkipped = true; + for (Map.Entry entry : map.entrySet()) { + if (entry.getValue() == 0) { + // Skip this invalid + continue; + } + allSkipped = false; + valuesBuilder.appendField(entry.getKey(), entry.getValue()); + } + if (allSkipped) { + // Null = skip the chart + return null; + } + return new JsonObjectBuilder().appendField("values", valuesBuilder.build()).build(); + } + } + + public static class AdvancedPie extends CustomChart { + + private final Callable> callable; + + /** + * Class constructor. + * + * @param chartId The id of the chart. + * @param callable The callable which is used to request the chart data. + */ + public AdvancedPie(String chartId, Callable> callable) { + super(chartId); + this.callable = callable; + } + + @Override + protected JsonObjectBuilder.JsonObject getChartData() throws Exception { + JsonObjectBuilder valuesBuilder = new JsonObjectBuilder(); + Map map = callable.call(); + if (map == null || map.isEmpty()) { + // Null = skip the chart + return null; + } + boolean allSkipped = true; + for (Map.Entry entry : map.entrySet()) { + if (entry.getValue() == 0) { + // Skip this invalid + continue; + } + allSkipped = false; + valuesBuilder.appendField(entry.getKey(), entry.getValue()); + } + if (allSkipped) { + // Null = skip the chart + return null; + } + return new JsonObjectBuilder().appendField("values", valuesBuilder.build()).build(); + } + } + + public static class SimpleBarChart extends CustomChart { + + private final Callable> callable; + + /** + * Class constructor. + * + * @param chartId The id of the chart. + * @param callable The callable which is used to request the chart data. + */ + public SimpleBarChart(String chartId, Callable> callable) { + super(chartId); + this.callable = callable; + } + + @Override + protected JsonObjectBuilder.JsonObject getChartData() throws Exception { + JsonObjectBuilder valuesBuilder = new JsonObjectBuilder(); + Map map = callable.call(); + if (map == null || map.isEmpty()) { + // Null = skip the chart + return null; + } + for (Map.Entry entry : map.entrySet()) { + valuesBuilder.appendField(entry.getKey(), new int[] {entry.getValue()}); + } + return new JsonObjectBuilder().appendField("values", valuesBuilder.build()).build(); + } + } + + public static class AdvancedBarChart extends CustomChart { + + private final Callable> callable; + + /** + * Class constructor. + * + * @param chartId The id of the chart. + * @param callable The callable which is used to request the chart data. + */ + public AdvancedBarChart(String chartId, Callable> callable) { + super(chartId); + this.callable = callable; + } + + @Override + protected JsonObjectBuilder.JsonObject getChartData() throws Exception { + JsonObjectBuilder valuesBuilder = new JsonObjectBuilder(); + Map map = callable.call(); + if (map == null || map.isEmpty()) { + // Null = skip the chart + return null; + } + boolean allSkipped = true; + for (Map.Entry entry : map.entrySet()) { + if (entry.getValue().length == 0) { + // Skip this invalid + continue; + } + allSkipped = false; + valuesBuilder.appendField(entry.getKey(), entry.getValue()); + } + if (allSkipped) { + // Null = skip the chart + return null; + } + return new JsonObjectBuilder().appendField("values", valuesBuilder.build()).build(); + } + } + + public static class DrilldownPie extends CustomChart { + + private final Callable>> callable; + + /** + * Class constructor. + * + * @param chartId The id of the chart. + * @param callable The callable which is used to request the chart data. + */ + public DrilldownPie(String chartId, Callable>> callable) { + super(chartId); + this.callable = callable; + } + + @Override + public JsonObjectBuilder.JsonObject getChartData() throws Exception { + JsonObjectBuilder valuesBuilder = new JsonObjectBuilder(); + Map> map = callable.call(); + if (map == null || map.isEmpty()) { + // Null = skip the chart + return null; + } + boolean reallyAllSkipped = true; + for (Map.Entry> entryValues : map.entrySet()) { + JsonObjectBuilder valueBuilder = new JsonObjectBuilder(); + boolean allSkipped = true; + for (Map.Entry valueEntry : map.get(entryValues.getKey()).entrySet()) { + valueBuilder.appendField(valueEntry.getKey(), valueEntry.getValue()); + allSkipped = false; + } + if (!allSkipped) { + reallyAllSkipped = false; + valuesBuilder.appendField(entryValues.getKey(), valueBuilder.build()); + } + } + if (reallyAllSkipped) { + // Null = skip the chart + return null; + } + return new JsonObjectBuilder().appendField("values", valuesBuilder.build()).build(); + } + } + + public abstract static class CustomChart { + + private final String chartId; + + protected CustomChart(String chartId) { + if (chartId == null) { + throw new IllegalArgumentException("chartId must not be null"); + } + this.chartId = chartId; + } + + public JsonObjectBuilder.JsonObject getRequestJsonObject( + BiConsumer errorLogger, boolean logErrors) { + JsonObjectBuilder builder = new JsonObjectBuilder(); + builder.appendField("chartId", chartId); + try { + JsonObjectBuilder.JsonObject data = getChartData(); + if (data == null) { + // If the data is null we don't send the chart. + return null; + } + builder.appendField("data", data); + } catch (Throwable t) { + if (logErrors) { + errorLogger.accept("Failed to get data for custom chart with id " + chartId, t); + } + return null; + } + return builder.build(); + } + + protected abstract JsonObjectBuilder.JsonObject getChartData() throws Exception; + } + + public static class SingleLineChart extends CustomChart { + + private final Callable callable; + + /** + * Class constructor. + * + * @param chartId The id of the chart. + * @param callable The callable which is used to request the chart data. + */ + public SingleLineChart(String chartId, Callable callable) { + super(chartId); + this.callable = callable; + } + + @Override + protected JsonObjectBuilder.JsonObject getChartData() throws Exception { + int value = callable.call(); + if (value == 0) { + // Null = skip the chart + return null; + } + return new JsonObjectBuilder().appendField("value", value).build(); + } + } + + /** + * An extremely simple JSON builder. + * + *

While this class is neither feature-rich nor the most performant one, it's sufficient enough + * for its use-case. + */ + public static class JsonObjectBuilder { + + private StringBuilder builder = new StringBuilder(); + + private boolean hasAtLeastOneField = false; + + public JsonObjectBuilder() { + builder.append("{"); + } + + /** + * Appends a null field to the JSON. + * + * @param key The key of the field. + * @return A reference to this object. + */ + public JsonObjectBuilder appendNull(String key) { + appendFieldUnescaped(key, "null"); + return this; + } + + /** + * Appends a string field to the JSON. + * + * @param key The key of the field. + * @param value The value of the field. + * @return A reference to this object. + */ + public JsonObjectBuilder appendField(String key, String value) { + if (value == null) { + throw new IllegalArgumentException("JSON value must not be null"); + } + appendFieldUnescaped(key, "\"" + escape(value) + "\""); + return this; + } + + /** + * Appends an integer field to the JSON. + * + * @param key The key of the field. + * @param value The value of the field. + * @return A reference to this object. + */ + public JsonObjectBuilder appendField(String key, int value) { + appendFieldUnescaped(key, String.valueOf(value)); + return this; + } + + /** + * Appends an object to the JSON. + * + * @param key The key of the field. + * @param object The object. + * @return A reference to this object. + */ + public JsonObjectBuilder appendField(String key, JsonObject object) { + if (object == null) { + throw new IllegalArgumentException("JSON object must not be null"); + } + appendFieldUnescaped(key, object.toString()); + return this; + } + + /** + * Appends a string array to the JSON. + * + * @param key The key of the field. + * @param values The string array. + * @return A reference to this object. + */ + public JsonObjectBuilder appendField(String key, String[] values) { + if (values == null) { + throw new IllegalArgumentException("JSON values must not be null"); + } + String escapedValues = + Arrays.stream(values) + .map(value -> "\"" + escape(value) + "\"") + .collect(Collectors.joining(",")); + appendFieldUnescaped(key, "[" + escapedValues + "]"); + return this; + } + + /** + * Appends an integer array to the JSON. + * + * @param key The key of the field. + * @param values The integer array. + * @return A reference to this object. + */ + public JsonObjectBuilder appendField(String key, int[] values) { + if (values == null) { + throw new IllegalArgumentException("JSON values must not be null"); + } + String escapedValues = + Arrays.stream(values).mapToObj(String::valueOf).collect(Collectors.joining(",")); + appendFieldUnescaped(key, "[" + escapedValues + "]"); + return this; + } + + /** + * Appends an object array to the JSON. + * + * @param key The key of the field. + * @param values The integer array. + * @return A reference to this object. + */ + public JsonObjectBuilder appendField(String key, JsonObject[] values) { + if (values == null) { + throw new IllegalArgumentException("JSON values must not be null"); + } + String escapedValues = + Arrays.stream(values).map(JsonObject::toString).collect(Collectors.joining(",")); + appendFieldUnescaped(key, "[" + escapedValues + "]"); + return this; + } + + /** + * Appends a field to the object. + * + * @param key The key of the field. + * @param escapedValue The escaped value of the field. + */ + private void appendFieldUnescaped(String key, String escapedValue) { + if (builder == null) { + throw new IllegalStateException("JSON has already been built"); + } + if (key == null) { + throw new IllegalArgumentException("JSON key must not be null"); + } + if (hasAtLeastOneField) { + builder.append(","); + } + builder.append("\"").append(escape(key)).append("\":").append(escapedValue); + hasAtLeastOneField = true; + } + + /** + * Builds the JSON string and invalidates this builder. + * + * @return The built JSON string. + */ + public JsonObject build() { + if (builder == null) { + throw new IllegalStateException("JSON has already been built"); + } + JsonObject object = new JsonObject(builder.append("}").toString()); + builder = null; + return object; + } + + /** + * Escapes the given string like stated in https://www.ietf.org/rfc/rfc4627.txt. + * + *

This method escapes only the necessary characters '"', '\'. and '\u0000' - '\u001F'. + * Compact escapes are not used (e.g., '\n' is escaped as "\u000a" and not as "\n"). + * + * @param value The value to escape. + * @return The escaped value. + */ + private static String escape(String value) { + final StringBuilder builder = new StringBuilder(); + for (int i = 0; i < value.length(); i++) { + char c = value.charAt(i); + if (c == '"') { + builder.append("\\\""); + } else if (c == '\\') { + builder.append("\\\\"); + } else if (c <= '\u000F') { + builder.append("\\u000").append(Integer.toHexString(c)); + } else if (c <= '\u001F') { + builder.append("\\u00").append(Integer.toHexString(c)); + } else { + builder.append(c); + } + } + return builder.toString(); + } + + /** + * A super simple representation of a JSON object. + * + *

This class only exists to make methods of the {@link JsonObjectBuilder} type-safe and not + * allow a raw string inputs for methods like {@link JsonObjectBuilder#appendField(String, + * JsonObject)}. + */ + public static class JsonObject { + + private final String value; + + private JsonObject(String value) { + this.value = value; + } + + @Override + public String toString() { + return value; + } + } + } +} + diff --git a/src/main/java/us/ajg0702/leaderboards/utils/OfflineUpdater.java b/src/main/java/us/ajg0702/leaderboards/utils/OfflineUpdater.java index efe008ea..8277a1c4 100644 --- a/src/main/java/us/ajg0702/leaderboards/utils/OfflineUpdater.java +++ b/src/main/java/us/ajg0702/leaderboards/utils/OfflineUpdater.java @@ -25,7 +25,7 @@ public OfflineUpdater(LeaderboardPlugin plugin, String board, OfflinePlayer[] pl offlinePlayerQueue.addAll(Arrays.asList(players)); started = offlinePlayerQueue.size(); - Bukkit.getScheduler().runTaskAsynchronously(this.plugin, () -> { + plugin.getScheduler().runTaskAsynchronously(() -> { startedTime = System.currentTimeMillis(); while(!offlinePlayerQueue.isEmpty() && !plugin.isShuttingDown()) { OfflinePlayer player = offlinePlayerQueue.pop(); diff --git a/src/main/resources/plugin.yml b/src/main/resources/plugin.yml index 6386fbfc..447ec53f 100644 --- a/src/main/resources/plugin.yml +++ b/src/main/resources/plugin.yml @@ -1,6 +1,7 @@ name: ajLeaderboards version: "@VERSION@" main: us.ajg0702.leaderboards.LeaderboardPlugin +folia-supported: true author: ajgeiss0702 depend: [PlaceholderAPI] softdepend: [Vault, SkinsRestorer]