Merge pull request #2788 from BentoBoxWorld/develop

Release 3.11.1

Author: tastybento

.github/workflows/build.yml

@@ -37,4 +37,4 @@ jobs:
       - name: Build and analyze
         env:
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
-        run: ./gradlew build sonar --info
+        run: ./gradlew build test jacocoTestReport sonar --info

README.md

@@ -1,7 +1,7 @@
 # BentoBox
 
 [![Discord](https://img.shields.io/discord/272499714048524288.svg?logo=discord)](https://discord.bentobox.world)
-[![Build Status](https://ci.codemc.io/job/BentoBoxWorld/job/BentoBox-Gradle/badge/icon)](https://ci.codemc.io/job/BentoBoxWorld/job/BentoBox-Gradle/)
+[![Build Status](https://ci.codemc.io/job/BentoBoxWorld/job/BentoBox/badge/icon)](https://ci.codemc.io/job/BentoBoxWorld/job/BentoBox/)
 [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=BentoBoxWorld_BentoBox&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=BentoBoxWorld_BentoBox)
 [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=BentoBoxWorld_BentoBox&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=BentoBoxWorld_BentoBox)
 [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=BentoBoxWorld_BentoBox&metric=security_rating)](https://sonarcloud.io/dashboard?id=BentoBoxWorld_BentoBox)

build.gradle.kts

@@ -46,7 +46,7 @@ paperweight.reobfArtifactConfiguration = io.papermc.paperweight.userdev.ReobfArt
 group = "world.bentobox" // From <groupId>
 
 // Base properties from <properties>
-val buildVersion = "3.11.0"
+val buildVersion = "3.11.1"
 val buildNumberDefault = "-LOCAL" // Local build identifier
 val snapshotSuffix = "-SNAPSHOT"  // Indicates development/snapshot version
 
@@ -93,6 +93,22 @@ val vaultVersion = "1.7.1"
 val levelVersion = "2.21.3"
 val placeholderapiVersion = "2.11.7"
 val myworldsVersion = "1.19.3-v1"
+val awaitilityVersion = "4.2.2"
+val mythicDistVersion = "5.9.5"
+val multiverseCore5Version = "5.0.0-SNAPSHOT"
+val multiverseCore4Version = "4.3.16"
+val langUtilsVersion = "3.2.2"
+val slimefun4Version = "RC-37"
+val itemsAdderVersion = "4.0.2-beta-release-11"
+val fancyNpcsVersion = "2.4.4"
+val znpcsplusApiVersion = "2.0.0-SNAPSHOT"
+val fancyHologramsVersion = "2.4.1"
+val commonsLangVersion = "2.6"
+val jaxbApiVersion = "2.3.0"
+val gsonRecordTypeAdapterFactoryVersion = "0.3.0"
+val jdtAnnotationVersion = "2.2.600"
+val multilibVersion = "1.1.13"
+val oraxenVersion = "1.193.1"
 
 // Store versions in extra properties for resource filtering (used in plugin.yml, config.yml)
 extra["java.version"] = javaVersion
@@ -176,59 +192,40 @@ dependencies {
     testImplementation("org.junit.jupiter:junit-jupiter-api")
     testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine")
     testRuntimeOnly("org.junit.platform:junit-platform-launcher:$junitVersion")
-    testImplementation("org.mockito:mockito-junit-jupiter:$mockitoVersion") // Mocking framework
+    testImplementation("org.mockito:mockito-junit-jupiter:$mockitoVersion")
     testImplementation("org.mockito:mockito-core:$mockitoVersion")
-    testImplementation("com.github.MockBukkit:MockBukkit:$mockBukkitVersion") // Bukkit mock server
-    testImplementation("org.awaitility:awaitility:4.2.2") // Async testing helper
-    testImplementation("io.papermc.paper:paper-api:1.21.10-R0.1-SNAPSHOT") // Paper API for tests
+    testImplementation("com.github.MockBukkit:MockBukkit:$mockBukkitVersion")
+    testImplementation("org.awaitility:awaitility:$awaitilityVersion")
+    testImplementation("io.papermc.paper:paper-api:$paperVersion")
     testImplementation("com.github.MilkBowl:VaultAPI:$vaultVersion")
     testImplementation("me.clip:placeholderapi:$placeholderapiVersion")
+    testImplementation("commons-lang:commons-lang:$commonsLangVersion")
 
-    // --- Provided/Compile-Only Dependencies: Available at compile time but provided by server ---
-    // These are NOT shaded into the final JAR (the server provides them at runtime)
-    //compileOnly("io.papermc.paper:paper-api:1.21.10-R0.1-SNAPSHOT") // Bukkit/Spigot/Paper API
-    paperweight.paperDevBundle("1.21.10-R0.1-SNAPSHOT")
-    
-    // Spigot NMS - Used for internal Minecraft code (chunk deletion and pasting)
+    // --- Compile Only Dependencies: Provided by the server at runtime ---
     compileOnly("org.spigotmc:spigot:$spigotVersion") {
-        exclude(group = "org.spigotmc", module = "spigot-api") // Already provided by Paper
+        exclude(group = "org.spigotmc", module = "spigot-api")
     }
-
-    // Optional plugins that may be installed on the server
     compileOnly("org.mongodb:mongodb-driver:$mongodbVersion")
-    compileOnly("com.zaxxer:HikariCP:$hikaricpVersion") // Database connection pooling
-    compileOnly("com.github.MilkBowl:VaultAPI:$vaultVersion") // Economy/permission API
-    compileOnly("me.clip:placeholderapi:$placeholderapiVersion") // Placeholder API
+    compileOnly("com.zaxxer:HikariCP:$hikaricpVersion")
+    compileOnly("com.github.MilkBowl:VaultAPI:$vaultVersion")
+    compileOnly("me.clip:placeholderapi:$placeholderapiVersion")
     compileOnly("com.bergerkiller.bukkit:MyWorlds:$myworldsVersion") {
         exclude(group = "org.spigotmc", module = "spigot-api")
     }
-    compileOnly("io.lumine:Mythic-Dist:5.9.5") // Mythic Mobs
-    compileOnly("org.mvplugins.multiverse.core:multiverse-core:5.0.0-SNAPSHOT")
-    compileOnly("com.onarandombox.multiversecore:multiverse-core:4.3.16") {
+    compileOnly("io.lumine:Mythic-Dist:$mythicDistVersion")
+    compileOnly("org.mvplugins.multiverse.core:multiverse-core:$multiverseCore5Version")
+    compileOnly("com.onarandombox.multiversecore:multiverse-core:$multiverseCore4Version") {
         exclude(group = "org.spigotmc", module = "spigot-api")
     }
-    compileOnly("com.github.apachezy:LangUtils:3.2.2")
-    compileOnly("com.github.Slimefun:Slimefun4:RC-37") // Slimefun custom items
-    compileOnly("dev.lone:api-itemsadder:4.0.2-beta-release-11") // ItemsAdder custom items
-    compileOnly("de.oliver:FancyNpcs:2.4.4") // NPC plugin
-    compileOnly("lol.pyr:znpcsplus-api:2.0.0-SNAPSHOT") // Alternative NPC plugin
-    compileOnly("de.oliver:FancyHolograms:2.4.1") // Hologram plugin
-    compileOnly("world.bentobox:level:2.21.3-SNAPSHOT") // BentoBox Level addon
-
-    // Apache Commons Lang - utility library
-    compileOnly("commons-lang:commons-lang:2.6")
-    testImplementation("commons-lang:commons-lang:2.6")
-
-    // --- Implementation Dependencies: Shaded into final JAR ---
-    // These are embedded in the final JAR since they're not commonly available
-    implementation("org.bstats:bstats-bukkit:$bstatsVersion") // Plugin metrics
-    implementation("javax.xml.bind:jaxb-api:2.3.0") // XML serialization
-    implementation("com.github.Marcono1234:gson-record-type-adapter-factory:0.3.0") // JSON serialization
-    implementation("org.eclipse.jdt:org.eclipse.jdt.annotation:2.2.600") // Nullability annotations
-    implementation("com.github.puregero:multilib:1.1.13") // Multi-library support
-
-    // Oraxen with custom exclusions (embed only what we need)
-    compileOnly("io.th0rgal:oraxen:1.193.1") {
+    compileOnly("com.github.apachezy:LangUtils:$langUtilsVersion")
+    compileOnly("com.github.Slimefun:Slimefun4:$slimefun4Version")
+    compileOnly("dev.lone:api-itemsadder:$itemsAdderVersion")
+    compileOnly("de.oliver:FancyNpcs:$fancyNpcsVersion")
+    compileOnly("lol.pyr:znpcsplus-api:$znpcsplusApiVersion")
+    compileOnly("de.oliver:FancyHolograms:$fancyHologramsVersion")
+    compileOnly("world.bentobox:level:$levelVersion-SNAPSHOT")
+    compileOnly("commons-lang:commons-lang:$commonsLangVersion")
+    compileOnly("io.th0rgal:oraxen:$oraxenVersion") {
         exclude(group = "me.gabytm.util", module = "actions-spigot")
         exclude(group = "org.jetbrains", module = "annotations")
         exclude(group = "com.ticxo", module = "PlayerAnimator")
@@ -238,9 +235,19 @@ dependencies {
         exclude(group = "org.bstats", module = "bstats-bukkit")
         exclude(group = "com.jeff-media", module = "custom-block-data")
         exclude(group = "com.jeff-media", module = "persistent-data-serializer")
-        exclude(group = "com.jeff_media", module = "MorePersistentDataTypes")
+        exclude(group = "com.jeff-media", module = "MorePersistentDataTypes")
         exclude(group = "gs.mclo", module = "java")
     }
+
+    // --- Implementation Dependencies: Shaded into final JAR ---
+    implementation("org.bstats:bstats-bukkit:$bstatsVersion")
+    implementation("javax.xml.bind:jaxb-api:$jaxbApiVersion")
+    implementation("com.github.Marcono1234:gson-record-type-adapter-factory:$gsonRecordTypeAdapterFactoryVersion")
+    implementation("org.eclipse.jdt:org.eclipse.jdt.annotation:$jdtAnnotationVersion")
+    implementation("com.github.puregero:multilib:$multilibVersion")
+
+    // --- Paperweight Development Bundle (Provided by plugin development tools) ---
+    paperweight.paperDevBundle(paperVersion)
 }
 
 paperweight {
@@ -276,15 +283,15 @@ tasks.processResources {
     // This allows version info to be read at runtime by the plugin
     filesMatching(listOf("plugin.yml", "config.yml")) {
         filter { line ->
-            line.replace("\${mysql.version}", mysqlVersion)
-                .replace("\${mariadb.version}", mariadbVersion)
-                .replace("\${postgresql.version}", postgresqlVersion)
-                .replace("\${mongodb.version}", mongodbVersion)
-                .replace("\${hikaricp.version}", hikaricpVersion)
-                .replace("\${build.number}", finalBuildNumber)
-                .replace("\${project.version}", project.version.toString())
-                .replace("\${project.description}", project.description ?: "")
-                .replace("\${revision}", project.version.toString())
+            line.replace($$"${mysql.version}", mysqlVersion)
+                .replace($$"${mariadb.version}", mariadbVersion)
+                .replace($$"${postgresql.version}", postgresqlVersion)
+                .replace($$"${mongodb.version}", mongodbVersion)
+                .replace($$"${hikaricp.version}", hikaricpVersion)
+                .replace($$"${build.number}", finalBuildNumber)
+                .replace($$"${project.version}", project.version.toString())
+                .replace($$"${project.description}", project.description ?: "")
+                .replace($$"${revision}", project.version.toString())
         }
     }
 

src/main/java/world/bentobox/bentobox/BStats.java

@@ -157,7 +157,7 @@ private void registerPlayersPerServerChart() {
             int players = this.connectedPlayerSet.size();
             this.connectedPlayerSet.clear();
 
-            if (players <= 0) return "0";
+            if (players == 0) return "0";
             else if (players <= 10) return "1-10";
             else if (players <= 30) return "11-30";
             else if (players <= 50) return "31-50";

src/main/java/world/bentobox/bentobox/BentoBox.java

@@ -9,9 +9,7 @@
 
 import org.apache.commons.lang3.exception.ExceptionUtils;
 import org.bukkit.Bukkit;
-import org.bukkit.event.EventHandler;
 import org.bukkit.event.Listener;
-import org.bukkit.event.server.ServerCommandEvent;
 import org.bukkit.generator.ChunkGenerator;
 import org.bukkit.plugin.PluginManager;
 import org.bukkit.plugin.java.JavaPlugin;
@@ -72,6 +70,8 @@
  */
 public class BentoBox extends JavaPlugin implements Listener {
 
+    private static final String PANELS = "panels";
+
     private static BentoBox instance;
 
     // Databases
@@ -149,7 +149,7 @@ public void onEnable(){
         saveConfig();
 
         // Set up click timeout
-        lastClick = new ExpiringMap<Pair<UUID, String>, Boolean>(getSettings().getClickCooldownMs(), TimeUnit.MILLISECONDS);
+        lastClick = new ExpiringMap<>(getSettings().getClickCooldownMs(), TimeUnit.MILLISECONDS);
 
         // Start Database managers
         playersManager = new PlayersManager(this);
@@ -194,7 +194,7 @@ public void onEnable(){
                 completeSetup(loadTime);
             } catch (Exception e) {
                 fireCriticalError(e.getMessage(), "");
-                e.printStackTrace();
+                logStacktrace(e);
             }
         });
     }
@@ -374,18 +374,6 @@ public void onDisable() {
 
     }
 
-    @EventHandler
-    public void onServerStop(ServerCommandEvent e) {
-        /* This is no longer needed as with https://github.com/Multiverse/Multiverse-Core/releases/tag/4.3.12 (or maybe earlier) the issue
-         * is fixed where the generator was not remembered across reboots.
-         */
-        /*
-        if (islandWorldManager != null && (e.getCommand().equalsIgnoreCase("stop") || e.getCommand().equalsIgnoreCase("restart"))) {
-            // Unregister any MV worlds            if () {
-            //islandWorldManager.registerWorldsToMultiverse(false);
-        }*/
-    }
-
     /**
      * Returns the player manager
      * @return the player manager
@@ -502,27 +490,27 @@ public boolean loadSettings() {
         }
         log("Saving default panels...");
 
-        if (!Files.exists(Path.of(this.getDataFolder().getPath(), "panels", "island_creation_panel.yml"))) {
+        if (!Files.exists(Path.of(this.getDataFolder().getPath(), PANELS, "island_creation_panel.yml"))) {
             log("Saving default island_creation_panel...");
             this.saveResource("panels/island_creation_panel.yml", false);
         }
 
-        if (!Files.exists(Path.of(this.getDataFolder().getPath(), "panels", "language_panel.yml"))) {
+        if (!Files.exists(Path.of(this.getDataFolder().getPath(), PANELS, "language_panel.yml"))) {
             log("Saving default language_panel...");
             this.saveResource("panels/language_panel.yml", false);
         }
 
-        if (!Files.exists(Path.of(this.getDataFolder().getPath(), "panels", "island_homes_panel.yml"))) {
+        if (!Files.exists(Path.of(this.getDataFolder().getPath(), PANELS, "island_homes_panel.yml"))) {
             log("Saving default island_homes_panel...");
             this.saveResource("panels/island_homes_panel.yml", false);
         }
 
-        if (!Files.exists(Path.of(this.getDataFolder().getPath(), "panels", "team_invite_panel.yml"))) {
+        if (!Files.exists(Path.of(this.getDataFolder().getPath(), PANELS, "team_invite_panel.yml"))) {
             log("Saving default team_invite_panel...");
             this.saveResource("panels/team_invite_panel.yml", false);
         }
 
-        if (!Files.exists(Path.of(this.getDataFolder().getPath(), "panels", "team_panel.yml"))) {
+        if (!Files.exists(Path.of(this.getDataFolder().getPath(), PANELS, "team_panel.yml"))) {
             log("Saving default team_panel...");
             this.saveResource("panels/team_panel.yml", false);
         }
@@ -673,11 +661,11 @@ public boolean isShutdown() {
      * @return false if they can click and the timeout is started, otherwise true.
      */
     public boolean onTimeout(User user, Panel panel) {
-        if (lastClick.containsKey(new Pair<UUID, String>(user.getUniqueId(), panel.getName()))) {
+        if (lastClick.containsKey(new Pair<>(user.getUniqueId(), panel.getName()))) {
             user.notify("general.errors.slow-down");
             return true;
         }
-        lastClick.put(new Pair<UUID, String>(user.getUniqueId(), panel.getName()), true);
+        lastClick.put(new Pair<>(user.getUniqueId(), panel.getName()), true);
         return false;
     }
 }

src/main/java/world/bentobox/bentobox/api/addons/Addon.java

@@ -324,7 +324,7 @@ public File saveResource(String jarResource, File destinationFolder, boolean rep
                         "The embedded resource '" + jarResource + "' cannot be found in " + jar.getName());
             }
         } catch (IOException e) {
-            e.printStackTrace();
+            BentoBox.getInstance().logStacktrace(e);
             BentoBox.getInstance().logError(
                     "Could not save from jar file. From " + jarResource + " to " + destinationFolder.getAbsolutePath());
         }

src/main/java/world/bentobox/bentobox/api/addons/AddonClassLoader.java

@@ -31,7 +31,7 @@
  * Each addon is loaded with its own {@link AddonClassLoader}, which allows for
  * class isolation and management. This loader also facilitates inter-addon
  * class sharing by coordinating with the {@link AddonsManager}.
- * 
+ * <p>
  * This approach is now rarely used as most addons are now Plugin-based and so are loaded by the server as plugins.
  *
  * @author tastybento, ComminQ

src/main/java/world/bentobox/bentobox/api/addons/package-info.java

@@ -1,15 +1,15 @@
 /**
  * This package contains classes and interfaces related to BentoBox addons.
- * 
+ * <p>
  * Addons are modular extensions that enhance BentoBox functionality. Game-specific
  * addons (e.g., BSkyBlock, AcidIsland) as well as generic addons (e.g., Challenges, Warps)
  * are supported by this system. Developers can create custom addons to introduce
  * new features or gamemodes.
- * 
+ * <p>
  * Since BentoBox was created, server tech has changed and code remapping is done and that
  * is usually only applied when a Plugin is loaded, so developers should use Pladdons
  * which are a wrapper for Addons in a Plugin.
- * 
+ * <p>
  * Key components:
  * - AddonLoader: Manages the lifecycle of addons.
  * - AddonConfig: Handles addon-specific configurations.