diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.yml b/.github/ISSUE_TEMPLATE/1-bug-report.yml index 9b14349..b71ca24 100644 --- a/.github/ISSUE_TEMPLATE/1-bug-report.yml +++ b/.github/ISSUE_TEMPLATE/1-bug-report.yml @@ -16,7 +16,7 @@ body: attributes: label: "Plugin Version" description: "Which version of the plugin are you using?" - placeholder: "e.g. 4.3.12" + placeholder: "e.g. 5.0.0" - type: textarea id: expected-behavior attributes: diff --git a/.gitignore b/.gitignore index 2f43f95..2d85467 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,9 @@ dependency-reduced-pom.xml .gradle build + +DESIGN.md + +run + +old \ No newline at end of file diff --git a/README.md b/README.md index 0f18e56..3df4321 100644 --- a/README.md +++ b/README.md @@ -15,4 +15,10 @@ This plugin is especially useful for large servers or resource-constrained envir * Spawner Limits: Enforce per-chunk spawner limits. * Customizable: Adjust limits via configuration files. * Lightweight: Minimal performance impact on your server. -* Support for Multiple Versions: Works with Minecraft 1.13-1.18+. +* Support for Multiple Versions: Works with Minecraft 1.8.8-1.21.10. + +## Release Notes (5.0.0) + +### Known Limitations + +- **Async chunk scanning**: chunk block scans currently run asynchronously for performance. Some server implementations may treat Bukkit world access off the main thread as unsafe. If you encounter instability, consider disabling async scans or switching to synchronous scanning until a thread-safe scan path is introduced. diff --git a/build.gradle.kts b/build.gradle.kts index e2a54a8..f78d05b 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -4,31 +4,76 @@ plugins { java alias(libs.plugins.shadow) alias(libs.plugins.plugin.yml) + alias(libs.plugins.run.paper) } -version = "4.4.4" -description = "Limit entities in chunks." + +group = "com.github.sarhatabaot" +version = "5.0.0" +description = "Limit blocks & entities in chunks." dependencies { compileOnly(libs.spigot.api) + compileOnly(libs.nbt.api) implementation(libs.bstats) - implementation(libs.acf) implementation(libs.annotations) + implementation(libs.jcip) + + implementation(libs.commands) + + testImplementation(libs.mockbukkit) + testImplementation(libs.assertj.core) } +java { + toolchain { + languageVersion.set(JavaLanguageVersion.of(21)) + vendor.set(JvmVendorSpec.ADOPTIUM) + } +} bukkit { - name = "ChunkSpawnerLimiter" - main = "com.cyprias.chunkspawnerlimiter.ChunkSpawnerLimiter" + name = rootProject.name + main = "com.github.sarhatabaot.chunkspawnerlimiter.ChunkSpawnerLimiter" version = project.version.toString() - apiVersion = "1.14" + website = "https://github.com/sarhatabaot/ChunkSpawnerLimiter" authors = listOf("Cyprias", "sarhatabaot") - website = "https://github.com/Cyprias/ChunkSpawnerLimiter" - description = "Limit entities in chunks." load = BukkitPluginDescription.PluginLoadOrder.POSTWORLD prefix = "CSL" + apiVersion = "1.13" + softDepend = listOf("NBTAPI") //todo, this way we keep it small } tasks { + runServer { + //use this to manually test various version load, probably should use docker with ci/cd for the automated version + //todo amazing 1.13-1.16 breaks with jvm 21, the rest works, lmao, mention this on the website + minecraftVersion("1.20.1") + jvmArgs("-Dcom.mojang.eula.agree=true") + } + + + // Define your versions + val minecraftVersions = listOf("1.8.8", "1.9.4", "1.12.2", "1.16.5", "1.20.1", "1.21.10") + + // Create tasks for each version + minecraftVersions.forEach { version -> + // Convert version to valid task name (replace dots with underscores) + val taskName = "runServer${version.replace(".", "_")}" + + register(taskName) { + group = "minecraft" + description = "Run Minecraft server version $version" + dependsOn(runServer) + doFirst { + // Set the minecraft version on the base task + (runServer.get() as Task).extensions.extraProperties.set("minecraftVersion", version) + (runServer.get() as Task).extensions.extraProperties.set("jvmArgs", "-Dcom.mojang.eula.agree=true") + // Or if runServer has a property/method for setting version: + // runServer.get().setMinecraftVersion(version) + } + } + } + build { dependsOn(shadowJar) } @@ -36,26 +81,122 @@ tasks { shadowJar { minimize() - exclude("META-INF/**") - archiveFileName.set("chunkspawnerlimiter-${project.version}.jar") archiveClassifier.set("shadow") - relocate("org.bstats", "com.cyprias.chunkspawnerlimiter.libs.bstats") - relocate("co.aikar.commands", "com.cyprias.chunkspawnerlimiter.libs.acf") - relocate("co.aikar.locales", "com.cyprias.chunkspawnerlimiter.libs.locales") + exclude("META-INF/**") + + relocate("me.despical.commandframework","com.github.sarhatabaot.chunkspawnerlimiter.libs") + relocate("org.bstats", "com.github.sarhatabaot.chunkspawnerlimiter.libs") } compileJava { - options.compilerArgs.add("-parameters") - options.isFork = true options.encoding = "UTF-8" } } -java { - toolchain { - languageVersion.set(JavaLanguageVersion.of(8)) - vendor.set(JvmVendorSpec.ADOPTIUM) +testing { + suites { + // Unit tests - version agnostic + val test by getting(JvmTestSuite::class) { + useJUnitJupiter() + + dependencies { + implementation(libs.spigot.api) + implementation(libs.adventure.api) + implementation(libs.junit.api) + runtimeOnly(libs.junit.engine) + implementation(libs.mockito.core) + implementation(libs.mockito.junit.jupiter) + implementation(libs.assertj.core) + implementation(libs.commands) + } + + targets { + all { + testTask.configure { + useJUnitPlatform() + } + } + } + } + + // Legacy integration tests (1.8-1.12) + val testLegacy by creating(JvmTestSuite::class) { + useJUnitJupiter() + + sources { + java { + srcDir("src/testLegacy/java") + compileClasspath += project.sourceSets.main.get().output + runtimeClasspath += project.sourceSets.main.get().output + } + } + + dependencies { + implementation(libs.spigot.api) + implementation(libs.adventure.api) + implementation(libs.bstats) + implementation(libs.junit.api) + runtimeOnly(libs.junit.engine) + implementation(libs.mockito.core) + implementation(libs.mockito.junit.jupiter) + implementation(libs.assertj.core) + implementation(libs.mockbukkit.legacy) + implementation(libs.commands) + } + + targets { + all { + testTask.configure { + useJUnitPlatform() + group = "verification" + description = "Runs legacy integration tests for Minecraft 1.8-1.12" + } + } + } + } + + // Modern integration tests (1.17+) + val testModern by creating(JvmTestSuite::class) { + useJUnitJupiter() + + sources { + java { + srcDir("src/testModern/java") + compileClasspath += project.sourceSets.main.get().output + runtimeClasspath += project.sourceSets.main.get().output + } + } + + dependencies { + implementation(libs.paper.api) + implementation(libs.adventure.api) + implementation(libs.junit.api) + runtimeOnly(libs.junit.engine) + implementation(libs.mockito.core) + implementation(libs.mockito.junit.jupiter) + implementation(libs.assertj.core) + implementation(libs.mockbukkit) + implementation(libs.commands) + } + + targets { + all { + testTask.configure { + useJUnitPlatform() + group = "verification" + description = "Runs modern integration tests for Minecraft 1.17+" + } + } + } + } } -} \ No newline at end of file +} + +tasks.named("check") { + dependsOn( + testing.suites.named("testLegacy"), +// testing.suites.named("testModern") for now TODO + ) +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index 1b33c55..8bdaf60 100644 Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index d4081da..2e11132 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,6 +1,6 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.3-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-9.1.0-bin.zip networkTimeout=10000 validateDistributionUrl=true zipStoreBase=GRADLE_USER_HOME diff --git a/gradlew b/gradlew old mode 100644 new mode 100755 diff --git a/internal-messages/command.json b/internal-messages/command.json deleted file mode 100644 index a7053ee..0000000 --- a/internal-messages/command.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "reload": { - "command": "reload", - "alias": "cslreload", - "permission": "csl.reload", - "description": "Reloads the config file." - }, - "settings": { - "command": "settings", - "alias": "cslsettings", - "permission": "csl.settings", - "description": "Shows config settings." - }, - "info" : { - "command": "info", - "alias": "cslinfo", - "permission": "csl.info", - "description": "Shows config info." - } -} \ No newline at end of file diff --git a/internal-messages/debug.json b/internal-messages/debug.json deleted file mode 100644 index ad554c8..0000000 --- a/internal-messages/debug.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "ignore-entity": "Ignoring %s due spawn-reason: %s", - "removing-entity-at": "Removing %d %s @ %dx %dz", - "active-check": "Active check @ %dx %dz", - "register-listeners": "Registered listeners.", - "chunk-unload-event": "ChunkUnloadEvent %s %s", - "chunk-load-event": "ChunkLoadEvent %s %s", - "block-place-check": "Material=%s, Count=%d, Limit=%d" -} \ No newline at end of file diff --git a/settings.gradle.kts b/settings.gradle.kts index 651fe0b..d7d764d 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -2,21 +2,39 @@ rootProject.name = "ChunkSpawnerLimiter" dependencyResolutionManagement { repositories { + repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS) mavenCentral() + maven("https://jitpack.io") maven("https://hub.spigotmc.org/nexus/content/repositories/snapshots/") - maven("https://repo.codemc.org/repository/maven-public") - maven("https://repo.aikar.co/content/groups/aikar/") + maven("https://repo.loohpjames.com/repository/") + maven("https://repo.codemc.io/repository/maven-public/") + maven("https://repo.papermc.io/repository/maven-public/") } versionCatalogs { create("libs") { - library("spigot-api", "org.spigotmc:spigot-api:1.14.4-R0.1-SNAPSHOT") + library("spigot-api", "org.spigotmc:spigot-api:1.8.8-R0.1-SNAPSHOT") + library("paper-api", "io.papermc.paper:paper-api:1.21.11-R0.1-SNAPSHOT") library("bstats", "org.bstats:bstats-bukkit:3.1.0") - library("acf", "co.aikar:acf-paper:0.5.1-SNAPSHOT") - library("annotations", "org.jetbrains:annotations:26.0.2") + library("annotations", "org.jetbrains:annotations:26.0.2-1") + library("commands", "com.github.despical:command-framework:1.5.3") + library("nbt-api", "de.tr7zw:item-nbt-api-plugin:2.15.3") + library("jcip", "com.google.code.findbugs:jsr305:3.0.2") - plugin("plugin-yml","net.minecrell.plugin-yml.bukkit").version("0.6.0") - plugin("shadow","com.gradleup.shadow").version("8.3.1") + library("junit-api", "org.junit.jupiter:junit-jupiter-api:5.14.0") + library("junit-engine", "org.junit.jupiter:junit-jupiter-engine:5.14.0") + library("mockito-core", "org.mockito:mockito-core:5.14.0") + library("mockito-junit-jupiter", "org.mockito:mockito-junit-jupiter:5.14.0") + library("assertj-core", "org.assertj:assertj-core:3.26.3") + + library("adventure-api", "net.kyori:adventure-api:4.14.0") + library("mockbukkit", "org.mockbukkit.mockbukkit:mockbukkit-v1.21:4.98.4") + library("mockbukkit-legacy", "com.github.MockBukkit:MockBukkit:v1.8-SNAPSHOT") + + plugin("run-paper", "xyz.jpenilla.run-paper").version("2.3.1") + plugin("shadow", "com.gradleup.shadow").version("9.2.2") + plugin("plugin-yml", "de.eldoria.plugin-yml.bukkit").version("0.8.0") } } -} \ No newline at end of file + +} diff --git a/src/main/java/com/cyprias/chunkspawnerlimiter/ChunkSpawnerLimiter.java b/src/main/java/com/cyprias/chunkspawnerlimiter/ChunkSpawnerLimiter.java deleted file mode 100644 index 5b41435..0000000 --- a/src/main/java/com/cyprias/chunkspawnerlimiter/ChunkSpawnerLimiter.java +++ /dev/null @@ -1,91 +0,0 @@ -package com.cyprias.chunkspawnerlimiter; - -import co.aikar.commands.PaperCommandManager; -import com.cyprias.chunkspawnerlimiter.commands.CslCommand; -import com.cyprias.chunkspawnerlimiter.configs.impl.BlocksConfig; -import com.cyprias.chunkspawnerlimiter.configs.impl.CslConfig; -import com.cyprias.chunkspawnerlimiter.inspection.entities.EntityChunkInspector; -import com.cyprias.chunkspawnerlimiter.inspection.entities.EntityChunkInspectorScheduler; -import com.cyprias.chunkspawnerlimiter.listeners.EntityListener; -import com.cyprias.chunkspawnerlimiter.listeners.PlaceBlockListener; -import com.cyprias.chunkspawnerlimiter.listeners.WorldListener; -import com.cyprias.chunkspawnerlimiter.messages.Debug; -import com.cyprias.chunkspawnerlimiter.utils.ChatUtil; -import org.bstats.bukkit.Metrics; -import org.bukkit.Bukkit; -import org.bukkit.plugin.PluginManager; -import org.bukkit.plugin.java.JavaPlugin; - -public class ChunkSpawnerLimiter extends JavaPlugin { - private EntityChunkInspectorScheduler entityChunkInspectorScheduler; - private EntityChunkInspector entityChunkInspector; - private CslConfig cslConfig; - - private BlocksConfig blocksConfig; - - private Metrics metrics; - - @Override - public void onEnable() { - initConfigs(); - ChatUtil.init(this); - ChatUtil.logAndCheckArmorStandTickWarning(); - - this.entityChunkInspector = new EntityChunkInspector(this); - this.entityChunkInspectorScheduler = new EntityChunkInspectorScheduler(this, entityChunkInspector); - registerListeners(); - PaperCommandManager paperCommandManager = new PaperCommandManager(this); - paperCommandManager.enableUnstableAPI("help"); - paperCommandManager.enableUnstableAPI("brigadier"); - paperCommandManager.registerCommand(new CslCommand(this)); - initMetrics(); - } - - @Override - public void onDisable() { - getServer().getScheduler().cancelTasks(this); - } - - public void initMetrics() { - if (cslConfig.metrics() && metrics == null) { - this.metrics = new Metrics(this, 4195); - } - } - - - private void initConfigs() { - this.cslConfig = new CslConfig(this); - this.blocksConfig = new BlocksConfig(this); - } - - public void reloadConfigs() { - this.cslConfig.reloadConfig(); - this.blocksConfig.reloadConfig(); - - ChatUtil.logAndCheckArmorStandTickWarning(); - } - - private void registerListeners() { - PluginManager pm = getServer().getPluginManager(); - pm.registerEvents(new EntityListener(cslConfig, entityChunkInspectorScheduler), this); - pm.registerEvents(new WorldListener(this, entityChunkInspectorScheduler), this); - pm.registerEvents(new PlaceBlockListener(this),this); - ChatUtil.debug(Debug.REGISTER_LISTENERS); - } - - public static void cancelTask(int taskID) { - Bukkit.getServer().getScheduler().cancelTask(taskID); - } - - public BlocksConfig getBlocksConfig() { - return blocksConfig; - } - - public CslConfig getCslConfig() { - return cslConfig; - } - - public EntityChunkInspector getChunkInspector() { - return entityChunkInspector; - } -} diff --git a/src/main/java/com/cyprias/chunkspawnerlimiter/commands/CslCommand.java b/src/main/java/com/cyprias/chunkspawnerlimiter/commands/CslCommand.java deleted file mode 100644 index 04edd19..0000000 --- a/src/main/java/com/cyprias/chunkspawnerlimiter/commands/CslCommand.java +++ /dev/null @@ -1,135 +0,0 @@ -package com.cyprias.chunkspawnerlimiter.commands; - -import co.aikar.commands.BaseCommand; -import co.aikar.commands.CommandHelp; -import co.aikar.commands.annotation.*; -import com.cyprias.chunkspawnerlimiter.ChunkSpawnerLimiter; -import com.cyprias.chunkspawnerlimiter.messages.Command; -import com.cyprias.chunkspawnerlimiter.utils.ChatUtil; -import com.cyprias.chunkspawnerlimiter.utils.Util; -import org.apache.commons.lang.StringUtils; -import org.bukkit.Chunk; -import org.bukkit.World; -import org.bukkit.command.CommandSender; -import org.bukkit.entity.Entity; -import org.bukkit.entity.EntityType; -import org.bukkit.entity.Player; -import org.jetbrains.annotations.NotNull; - -import java.lang.ref.WeakReference; - -@CommandAlias("csl") -public class CslCommand extends BaseCommand { - private final ChunkSpawnerLimiter plugin; - - public CslCommand(final ChunkSpawnerLimiter plugin) { - this.plugin = plugin; - } - - @Subcommand(Command.Reload.COMMAND) - @CommandAlias(Command.Reload.ALIAS) - @CommandPermission(Command.Reload.PERMISSION) - @Description(Command.Reload.DESCRIPTION) - public void onReload(final CommandSender sender) { - plugin.reloadConfigs(); - plugin.initMetrics(); - ChatUtil.message(sender, plugin.getCslConfig().getReloadedConfig()); - } - - - @Subcommand(Command.Settings.COMMAND) - @CommandAlias(Command.Settings.ALIAS) - @CommandPermission(Command.Settings.PERMISSION) - @Description(Command.Settings.DESCRIPTION) - public void onSettings(final CommandSender sender) { - ChatUtil.message(sender, "&2&l-- ChunkSpawnerLimiter v%s --", plugin.getDescription().getVersion()); - ChatUtil.message(sender, "&2&l-- Properties --"); - ChatUtil.message(sender, "Debug Message: %s", plugin.getCslConfig().isDebugMessages()); - ChatUtil.message(sender, "Check Chunk Load: %s", plugin.getCslConfig().isCheckChunkLoad()); - ChatUtil.message(sender, "Check Chunk Unload: %s", plugin.getCslConfig().isCheckChunkUnload()); - ChatUtil.message(sender, "Active Inspection: %s", plugin.getCslConfig().isActiveInspections()); - ChatUtil.message(sender, "Watch Creature Spawns: %s", plugin.getCslConfig().isWatchCreatureSpawns()); - ChatUtil.message(sender, "Check Surrounding Chunks: %s", plugin.getCslConfig().getCheckSurroundingChunks()); - ChatUtil.message(sender, "Inspection Frequency: %d", plugin.getCslConfig().getInspectionFrequency()); - ChatUtil.message(sender, "Notify Players: %s", plugin.getCslConfig().isNotifyPlayers()); - ChatUtil.message(sender, "Preserve Named Entities: %s", plugin.getCslConfig().isPreserveNamedEntities()); - ChatUtil.message(sender, "Ignore Metadata: %s", plugin.getCslConfig().getIgnoreMetadata().toString()); - ChatUtil.message(sender, "Worlds Mode: %s", plugin.getCslConfig().getWorldsMode().name()); - ChatUtil.message(sender, "Worlds: %s", plugin.getCslConfig().getWorldNames()); - ChatUtil.message(sender, "&2&l-- Messages --"); - ChatUtil.message(sender, "Reloaded Config: %s", plugin.getCslConfig().getReloadedConfig()); - ChatUtil.message(sender, "Removed Entities: %s", plugin.getCslConfig().getRemovedEntities()); - } - - @Subcommand(Command.Info.COMMAND) - @CommandAlias(Command.Info.ALIAS) - @CommandPermission(Command.Info.PERMISSION) - @Description(Command.Info.DESCRIPTION) - public void onInfo(final CommandSender sender) { - ChatUtil.message(sender, "&2&l-- ChunkSpawnerLimiter v%s --", plugin.getDescription().getVersion()); - ChatUtil.message(sender, "&2&l-- Paper? %b, Armor Tick? %b", Util.isPaperServer(), Util.isArmorStandTickDisabled()); - ChatUtil.message(sender, "&2&l-- Reasons to cull on: --"); - ChatUtil.message(sender, plugin.getCslConfig().getFormattedSpawnReasons()); - ChatUtil.message(sender, "&2&l-- Entity Limits: --"); - ChatUtil.message(sender, plugin.getCslConfig().getFormattedEntityLimits()); - } - - @Subcommand(Command.Search.COMMAND) - @CommandAlias(Command.Search.ALIAS) - @CommandPermission(Command.Search.PERMISSION) - @Description(Command.Search.DESCRIPTION) - public void onSearch(final CommandSender sender, @Optional final EntityType entity) { - if (entity != null) { - ChatUtil.message(sender, entity.name()); - return; - } - - ChatUtil.message(sender, StringUtils.join(EntityType.values(), ", ")); - } - - @Private - @Subcommand("check") - @CommandAlias("cslcheck") - @CommandPermission("csl.check") - @Description("Debug command for checking the amount & limit of an entity in the current chunk") - public void onCheck(final @NotNull Player player, final @NotNull EntityType entityType) { - final int limit = plugin.getCslConfig().getEntityLimit(entityType.name()); - int size = 0; - final World playerWorld = player.getLocation().getWorld(); - if (playerWorld == null) { - ChatUtil.message(player, "World is null.. somehow"); - return; - } - - final WeakReference weakChunk = new WeakReference<>(playerWorld.getChunkAt(player.getLocation())); - if (weakChunk.get() == null) { - ChatUtil.message(player, "Chunk was unloaded.. somehow"); - return; - } - - final Chunk chunk = weakChunk.get(); - if (chunk == null) { - ChatUtil.message(player, "Chunk was unloaded.. somehow"); - return; - } - - for (final Entity entity : chunk.getEntities()) { - if (entity.getType() == entityType) { - size++; - } - } - - ChatUtil.message(player, "EntityType %s Limit: %d, Size: %d", entityType.name(), limit, size); - } - - - /** - * This function handles the help command for the ChunkSpawnerLimiter plugin. - * - * @param help An instance of the CommandHelp class, which provides methods for displaying help information. - */ - @HelpCommand - public void onHelp(final CommandHelp help) { - help.showHelp(); - } -} diff --git a/src/main/java/com/cyprias/chunkspawnerlimiter/compare/EntityCompare.java b/src/main/java/com/cyprias/chunkspawnerlimiter/compare/EntityCompare.java deleted file mode 100644 index 93ce1ca..0000000 --- a/src/main/java/com/cyprias/chunkspawnerlimiter/compare/EntityCompare.java +++ /dev/null @@ -1,13 +0,0 @@ -package com.cyprias.chunkspawnerlimiter.compare; - -import org.bukkit.entity.Entity; - -public interface EntityCompare { - /** - * Evaluates the given Entity against the specific criteria as defined by the implementing class. - * - * @param entity The entity to evaluate. - * @return Returns true if the entity is found to be similar. - */ - boolean isSimilar(Entity entity); -} diff --git a/src/main/java/com/cyprias/chunkspawnerlimiter/compare/MobGroupCompare.java b/src/main/java/com/cyprias/chunkspawnerlimiter/compare/MobGroupCompare.java deleted file mode 100644 index 3dba5fb..0000000 --- a/src/main/java/com/cyprias/chunkspawnerlimiter/compare/MobGroupCompare.java +++ /dev/null @@ -1,55 +0,0 @@ -package com.cyprias.chunkspawnerlimiter.compare; - -import org.bukkit.entity.*; -import org.jetbrains.annotations.Contract; -import org.jetbrains.annotations.NotNull; - -public class MobGroupCompare implements EntityCompare { - private final String mobGroup; - - public MobGroupCompare(String mobGroup) { - this.mobGroup = mobGroup; - } - - @Override - public boolean isSimilar(Entity entity) { - return (getMobGroup(entity).equals(this.mobGroup)); - } - - @Contract(pure = true) - public static @NotNull String getMobGroup(Entity entity) { - // Determine the general group this mob belongs to. - if (entity instanceof Animals) { - // Chicken, Cow, MushroomCow, Ocelot, Pig, Sheep, Wolf - return "ANIMAL"; - } - - if (entity instanceof Monster) { - // Blaze, CaveSpider, Creeper, Enderman, Giant, PigZombie, Silverfish, Skeleton, Spider, Witch, Wither, Zombie - return "MONSTER"; - } - - if (entity instanceof Ambient) { - // Bat - return "AMBIENT"; - } - - if (entity instanceof WaterMob) { - // Squid, Fish - return "WATER_MOB"; - } - - if (entity instanceof NPC) { - // Villager - return "NPC"; - } - - if (entity instanceof Vehicle) { - //Boat, Minecart, TnT Minecart etc. - return "VEHICLE"; - } - - // Anything else. - return "OTHER"; - } -} diff --git a/src/main/java/com/cyprias/chunkspawnerlimiter/configs/ConfigFile.java b/src/main/java/com/cyprias/chunkspawnerlimiter/configs/ConfigFile.java deleted file mode 100644 index aea44e8..0000000 --- a/src/main/java/com/cyprias/chunkspawnerlimiter/configs/ConfigFile.java +++ /dev/null @@ -1,104 +0,0 @@ -package com.cyprias.chunkspawnerlimiter.configs; - -import org.bukkit.configuration.file.FileConfiguration; -import org.bukkit.configuration.file.YamlConfiguration; -import org.bukkit.plugin.java.JavaPlugin; -import org.jetbrains.annotations.NotNull; - -import java.io.File; -import java.io.IOException; -import java.io.InputStream; -import java.io.InputStreamReader; -import java.io.Reader; -import java.nio.charset.StandardCharsets; -import java.util.logging.Level; - -/** - * @author sarhatabaot - * Extracted from KrakenCore, since it only supports JDK 16+ - */ -public abstract class ConfigFile { - private final String resourcePath; - - protected final T plugin; - protected final String fileName; - protected final File folder; - - protected File file; - protected FileConfiguration config; - - protected ConfigFile(final @NotNull T plugin, final String resourcePath, final String fileName, final String folder) { - this.plugin = plugin; - this.fileName = fileName; - this.resourcePath = resourcePath; - this.folder = new File(plugin.getDataFolder().getPath() + File.separator + folder); - } - - public void saveDefaultConfig() { - if (this.file == null) { - this.file = new File(folder, fileName); - } - - if (!this.file.exists()) { - plugin.saveResource(resourcePath + fileName, false); - } - - reloadConfig(); - } - - public void saveConfig() { - if (this.config == null) { - return; - } - - if (file == null) { - return; - } - - try { - config.save(file); - } catch (IOException ex) { - plugin.getLogger().warning(ex.getMessage()); - } - } - - - public void reloadConfig() { - if (file == null) { - file = new File(folder, fileName); - } - - config = YamlConfiguration.loadConfiguration(file); - initValues(); - } - - public void reloadDefaultConfig() { - if (file == null) { - file = new File(folder, fileName); - } - - if (!file.exists()) { - config = YamlConfiguration.loadConfiguration(file); - try (InputStream resource = plugin.getResource(resourcePath + fileName)) { - if (resource != null) { - try (Reader defConfigStream = new InputStreamReader(resource, StandardCharsets.UTF_8)) { - YamlConfiguration defConfig = YamlConfiguration.loadConfiguration(defConfigStream); - config.setDefaults(defConfig); - } - } - } catch (IOException e) { - plugin.getLogger().log(Level.SEVERE, e.getMessage(), e); - } - } - } - - @NotNull - public FileConfiguration getConfig() { - if (config == null) { - reloadConfig(); - } - return this.config; - } - - public abstract void initValues(); -} \ No newline at end of file diff --git a/src/main/java/com/cyprias/chunkspawnerlimiter/configs/impl/BlocksConfig.java b/src/main/java/com/cyprias/chunkspawnerlimiter/configs/impl/BlocksConfig.java deleted file mode 100644 index 248a176..0000000 --- a/src/main/java/com/cyprias/chunkspawnerlimiter/configs/impl/BlocksConfig.java +++ /dev/null @@ -1,165 +0,0 @@ -package com.cyprias.chunkspawnerlimiter.configs.impl; - -import com.cyprias.chunkspawnerlimiter.ChunkSpawnerLimiter; -import com.cyprias.chunkspawnerlimiter.configs.ConfigFile; -import org.bukkit.Material; -import org.bukkit.configuration.ConfigurationSection; -import org.jetbrains.annotations.NotNull; - -import java.util.*; - -/** - * @author sarhatabaot - */ -public class BlocksConfig extends ConfigFile { - private boolean enabled; - private Map materialLimits; - private boolean notifyMessage; - private boolean notifyTitle; - - private int minY; - private int maxY; - - private Map worldLimits; - - private int minLimitForCache; - - public BlocksConfig(final @NotNull ChunkSpawnerLimiter plugin) { - super(plugin, "", "blocks.yml", ""); - saveDefaultConfig(); - } - - @Override - public void initValues() { - this.enabled = config.getBoolean("enabled", false); - this.notifyMessage = config.getBoolean("notify.message", false); - this.notifyTitle = config.getBoolean("notify.title", true); - - this.materialLimits = loadMaterialLimits(); - this.minY = config.getInt("count.default.min-y", -64); - this.maxY = config.getInt("count.default.max-y", 256); - - this.worldLimits = loadWorldLimits(); - - this.minLimitForCache = config.getInt("cache.min-limit-for-cache", 50); - } - - - private @NotNull Map loadWorldLimits() { - final Map limits = new HashMap<>(); - final ConfigurationSection worldsSection = config.getConfigurationSection("count.worlds"); - - if (worldsSection == null) { - //This can happen and it's valid. - return Collections.emptyMap(); - } - - final List invalidEntries = new ArrayList<>(); - for (Map.Entry entry: worldsSection.getValues(false).entrySet()) { - final String worldName = entry.getKey(); - final Object value = entry.getValue(); - if (!(value instanceof ConfigurationSection)) { - invalidEntries.add("Invalid world limit configuration for: " + worldName); - continue; - } - final ConfigurationSection worldSection = (ConfigurationSection) value; //might work?, might just be a map Map, if it works, add an instanceof check - final int worldMinY = worldSection.getInt("min-y", this.minY); - final int worldMaxY = worldSection.getInt("max-y", this.maxY); - - limits.put(worldName, new WorldLimits(worldName, worldMaxY, worldMinY)); - } - - if (!invalidEntries.isEmpty()) { - plugin.getLogger().warning("Found issues in blocks.yml:"); - invalidEntries.forEach(plugin.getLogger()::warning); - plugin.getLogger().warning("Please fix the above issues in your configuration."); - } - return limits; - } - - public Map getMaterialLimits() { - return materialLimits; - } - - public Integer getLimit(final Material material) { - return materialLimits.get(material); - } - - public boolean hasLimit(final Material material) { - return materialLimits.containsKey(material); - } - - public int getMinLimitForCache() { - return minLimitForCache; - } - - private @NotNull Map loadMaterialLimits() { - final ConfigurationSection blockSection = config.getConfigurationSection("blocks"); - if (blockSection == null) { - return Collections.emptyMap(); - } - - final Map limits = new EnumMap<>(Material.class); - final List invalidEntries = new ArrayList<>(); - - blockSection.getValues(false).forEach((key, value) -> { - final Material material = Material.getMaterial(key); - if (material == null) { - invalidEntries.add("Invalid material name: " + key); - return; - } - - final int limit = blockSection.getInt(key, -1); - if (limit < 0) { - invalidEntries.add("Missing or invalid limit for material: " + material.name()); - return; - } - - limits.put(material, limit); - }); - - // Log all invalid entries at once - if (!invalidEntries.isEmpty()) { - plugin.getLogger().warning("Found issues in blocks.yml:"); - invalidEntries.forEach(plugin.getLogger()::warning); - plugin.getLogger().warning("Please fix the above issues in your configuration."); - } - - return limits; - } - - public boolean isNotifyMessage() { - return notifyMessage; - } - - public boolean isNotifyTitle() { - return notifyTitle; - } - - public int getMinY() { - return minY; - } - - public boolean hasWorld(final String worldName) { - return worldLimits.containsKey(worldName); - } - - public int getMinY(final String worldName) { - return worldLimits.get(worldName).getMinY(); - } - - public int getMaxY(final String worldName) { - return worldLimits.get(worldName).getMaxY(); - } - - public int getMaxY() { - return maxY; - } - - public boolean isEnabled() { - return enabled; - } - - - -} diff --git a/src/main/java/com/cyprias/chunkspawnerlimiter/configs/impl/CslConfig.java b/src/main/java/com/cyprias/chunkspawnerlimiter/configs/impl/CslConfig.java deleted file mode 100644 index bcc25d6..0000000 --- a/src/main/java/com/cyprias/chunkspawnerlimiter/configs/impl/CslConfig.java +++ /dev/null @@ -1,281 +0,0 @@ -package com.cyprias.chunkspawnerlimiter.configs.impl; - -import com.cyprias.chunkspawnerlimiter.ChunkSpawnerLimiter; -import com.cyprias.chunkspawnerlimiter.configs.ConfigFile; -import com.cyprias.chunkspawnerlimiter.exceptions.MissingConfigurationException; -import org.apache.commons.lang.StringUtils; -import org.bukkit.configuration.ConfigurationSection; -import org.jetbrains.annotations.NotNull; - -import java.util.*; -import java.util.logging.Logger; -import java.util.stream.Collectors; - -public class CslConfig extends ConfigFile { - private final Logger logger = Logger.getLogger(CslConfig.class.getName()); - private Map entityLimits; - private Set spawnReasons; - - private boolean metrics; - /* Properties */ - private boolean debugMessages; - private boolean checkChunkLoad; - private boolean checkChunkUnload; - private boolean activeInspections; - private boolean watchCreatureSpawns; - private boolean watchVehicleCreate; - private boolean watchEntitySpawns; - private int checkSurroundingChunks; - private int inspectionFrequency; - private boolean notifyPlayers; - private boolean preserveNamedEntities; - private boolean preserveRaidEntities; - private List ignoreMetadata; - private boolean killInsteadOfRemove; - private boolean dropItemsFromArmorStands; - private boolean logArmorStandTickWarning; - - /* Worlds */ - private List worldsNames; - private WorldsMode worldsMode; - - /* Messages */ - private String removedEntities; - private String reloadedConfig; - - private String maxAmountBlocks; - private String maxAmountBlocksTitle; - private String maxAmountBlocksSubtitle; - - public CslConfig(final @NotNull ChunkSpawnerLimiter plugin) { - super(plugin, "", "config.yml", ""); - saveDefaultConfig(); - } - - @Override - public void initValues() { - final ConfigurationSection propertiesSection = config.getConfigurationSection("properties"); - - if (propertiesSection == null) { - throw new MissingConfigurationException("Your properties section is missing! Disabling plugin."); - } - - this.debugMessages = propertiesSection.getBoolean("debug-messages", false); - this.checkChunkLoad = propertiesSection.getBoolean("check-chunk-load", false); - this.checkChunkUnload = propertiesSection.getBoolean("check-chunk-unload", false); - this.activeInspections = propertiesSection.getBoolean("active-inspections", true); - this.watchCreatureSpawns = propertiesSection.getBoolean("watch-creature-spawns", true); - this.watchVehicleCreate = propertiesSection.getBoolean("watch-vehicle-create-event", true); - this.watchEntitySpawns = propertiesSection.getBoolean("watch-entity-spawns", true); - this.checkSurroundingChunks = propertiesSection.getInt("check-surrounding-chunks", 1); - this.inspectionFrequency = propertiesSection.getInt("inspection-frequency", 300); - this.notifyPlayers = propertiesSection.getBoolean("notify-players", false); - this.preserveNamedEntities = propertiesSection.getBoolean("preserve-named-entities", true); - this.preserveRaidEntities = propertiesSection.getBoolean("preserve-raid-entities", true); - this.ignoreMetadata = propertiesSection.getStringList("ignore-metadata"); - this.killInsteadOfRemove = propertiesSection.getBoolean("kill-instead-of-remove", false); - this.dropItemsFromArmorStands = propertiesSection.getBoolean("drop-items-from-armor-stands", false); - this.logArmorStandTickWarning = propertiesSection.getBoolean("log-armor-stand-tick-warning", true); - - this.worldsNames = config.getStringList("worlds.worlds"); - this.worldsMode = initWorldsMode(); - - String messagesPath = "messages."; - this.removedEntities = config.getString(messagesPath + "removedEntities", "&7Removed %s %s in your chunk."); - this.reloadedConfig = config.getString(messagesPath + "reloadedConfig", "&cReloaded csl config."); - this.maxAmountBlocks = config.getString(messagesPath + "maxAmountBlocks", "&6Cannot place more &4{material}&6. Max amount per chunk &2{amount}."); - this.maxAmountBlocksTitle = config.getString(messagesPath + "maxAmountBlocksTitle", "&6Cannot place more &4{material}&6."); - this.maxAmountBlocksSubtitle = config.getString(messagesPath + "maxAmountBlocksSubtitle", "&6Max amount per chunk &2{amount}."); - this.metrics = config.getBoolean("metrics", true); - - this.entityLimits = loadEntityLimits(); - this.spawnReasons = loadSpawnReasons(); - } - - public boolean metrics() { - return metrics; - } - - private Set loadSpawnReasons() { - final ConfigurationSection spawnReasonsSection = config.getConfigurationSection("spawn-reasons"); - if (spawnReasonsSection == null) { - logger.warning("Spawn reasons section is missing. Returning an empty set."); - return Collections.emptySet(); - } - - return spawnReasonsSection.getValues(false).entrySet().stream() - .filter(entry -> { - if (!(entry.getValue() instanceof Boolean)) { - logger.warning("Spawn reason '" + entry.getKey() + "' has an invalid value (" + entry.getValue() + "). Expected Boolean. Skipping."); - return false; - } - return (Boolean) entry.getValue(); - }) - .map(Map.Entry::getKey) - .collect(Collectors.toSet()); - } - - - private Map loadEntityLimits() { - final ConfigurationSection entitySection = config.getConfigurationSection("entities"); - if (entitySection == null) { - logger.warning("Entity limits section is missing. Returning an empty map."); - return Collections.emptyMap(); - } - - return entitySection.getValues(false).entrySet().stream() - .filter(entry -> { - if (entry.getValue() == null) { - logger.warning("Entity limit for '" + entry.getKey() + "' is null. Skipping."); - return false; - } - if (!(entry.getValue() instanceof Integer)) { - logger.warning("Entity limit for '" + entry.getKey() + "' is not an integer (" + entry.getValue() + "). Skipping."); - return false; - } - return true; - }) - .collect(Collectors.toMap(Map.Entry::getKey, entry -> (Integer) entry.getValue())); - } - - - public int getEntityLimit(String entityType) { - return entityLimits.get(entityType); - } - - public boolean hasEntityLimit(String entityTypeOrGroup) { - return entityLimits.containsKey(entityTypeOrGroup); - } - - public boolean isSpawnReason(String reason) { - return spawnReasons.contains(reason); - } - - public String getFormattedSpawnReasons() { - return StringUtils.join(spawnReasons, ", "); - } - - public String getFormattedEntityLimits() { - return entityLimits.toString(); - } - - public boolean isWorldAllowed(final String worldName) { - final List worldNames = getWorldNames(); - if (getWorldsMode() == WorldsMode.EXCLUDED) { - return !worldNames.contains(worldName); - } - // INCLUDED - return worldNames.contains(worldName); - } - - public boolean isWorldNotAllowed(final String worldName) { - return !isWorldAllowed(worldName); - } - - public List getWorldNames() { - return worldsNames; - } - - private WorldsMode initWorldsMode() { - final String mode = config.getString("worlds.mode", "excluded"); - if (mode == null) { - return WorldsMode.EXCLUDED; - } - - return WorldsMode.valueOf(mode.toUpperCase()); - } - - public WorldsMode getWorldsMode() { - return worldsMode; - } - - - public boolean isDebugMessages() { - return debugMessages; - } - - public boolean isCheckChunkLoad() { - return checkChunkLoad; - } - - public boolean isCheckChunkUnload() { - return checkChunkUnload; - } - - public boolean isActiveInspections() { - return activeInspections; - } - - public boolean isWatchCreatureSpawns() { - return watchCreatureSpawns; - } - - public boolean isWatchVehicleCreate() { - return watchVehicleCreate; - } - - public int getCheckSurroundingChunks() { - return checkSurroundingChunks; - } - - public int getInspectionFrequency() { - return inspectionFrequency; - } - - public boolean isNotifyPlayers() { - return notifyPlayers; - } - - public boolean isPreserveNamedEntities() { - return preserveNamedEntities; - } - - public boolean isPreserveRaidEntities() { - return preserveRaidEntities; - } - - public List getIgnoreMetadata() { - return ignoreMetadata; - } - - public boolean isKillInsteadOfRemove() { - return killInsteadOfRemove; - } - - public String getRemovedEntities() { - return removedEntities; - } - - public String getReloadedConfig() { - return reloadedConfig; - } - - public String getMaxAmountBlocks() { - return maxAmountBlocks; - } - - public String getMaxAmountBlocksTitle() { - return maxAmountBlocksTitle; - } - - public String getMaxAmountBlocksSubtitle() { - return maxAmountBlocksSubtitle; - } - - public boolean isDropItemsFromArmorStands() { - return dropItemsFromArmorStands; - } - - public boolean isLogArmorStandTickWarning() { - return logArmorStandTickWarning; - } - - public boolean isWatchEntitySpawns() { - return watchEntitySpawns; - } - - public enum WorldsMode { - INCLUDED, - EXCLUDED - } -} diff --git a/src/main/java/com/cyprias/chunkspawnerlimiter/configs/impl/WorldLimits.java b/src/main/java/com/cyprias/chunkspawnerlimiter/configs/impl/WorldLimits.java deleted file mode 100644 index b2e8eab..0000000 --- a/src/main/java/com/cyprias/chunkspawnerlimiter/configs/impl/WorldLimits.java +++ /dev/null @@ -1,34 +0,0 @@ -package com.cyprias.chunkspawnerlimiter.configs.impl; - -public class WorldLimits { - private final String name; - private final int maxY; - private final int minY; - - public WorldLimits(String name, int maxY, int minY) { - this.name = name; - this.maxY = maxY; - this.minY = minY; - } - - @Override - public String toString() { - return "WorldLimits{" + - "name='" + name + '\'' + - ", maxY=" + maxY + - ", minY=" + minY + - '}'; - } - - public String getName() { - return name; - } - - public int getMaxY() { - return maxY; - } - - public int getMinY() { - return minY; - } -} diff --git a/src/main/java/com/cyprias/chunkspawnerlimiter/exceptions/MissingConfigurationException.java b/src/main/java/com/cyprias/chunkspawnerlimiter/exceptions/MissingConfigurationException.java deleted file mode 100644 index 3249e1c..0000000 --- a/src/main/java/com/cyprias/chunkspawnerlimiter/exceptions/MissingConfigurationException.java +++ /dev/null @@ -1,19 +0,0 @@ -package com.cyprias.chunkspawnerlimiter.exceptions; - -/** - * Thrown when a required configuration is missing or invalid. - */ -public class MissingConfigurationException extends RuntimeException { - - public MissingConfigurationException(String message) { - super(message); - } - - public MissingConfigurationException(String message, Throwable cause) { - super(message, cause); - } - - public MissingConfigurationException(Throwable cause) { - super(cause); - } -} diff --git a/src/main/java/com/cyprias/chunkspawnerlimiter/inspection/entities/EntityChunkInspectionResult.java b/src/main/java/com/cyprias/chunkspawnerlimiter/inspection/entities/EntityChunkInspectionResult.java deleted file mode 100644 index 5e5632c..0000000 --- a/src/main/java/com/cyprias/chunkspawnerlimiter/inspection/entities/EntityChunkInspectionResult.java +++ /dev/null @@ -1,17 +0,0 @@ -package com.cyprias.chunkspawnerlimiter.inspection.entities; - -import org.bukkit.entity.Entity; - -import java.util.List; - -public class EntityChunkInspectionResult { - private final List entitiesToRemove; - - public EntityChunkInspectionResult(List entitiesToRemove) { - this.entitiesToRemove = entitiesToRemove; - } - - public List getEntitiesToRemove() { - return entitiesToRemove; - } -} diff --git a/src/main/java/com/cyprias/chunkspawnerlimiter/inspection/entities/EntityChunkInspector.java b/src/main/java/com/cyprias/chunkspawnerlimiter/inspection/entities/EntityChunkInspector.java deleted file mode 100644 index e8bfb1d..0000000 --- a/src/main/java/com/cyprias/chunkspawnerlimiter/inspection/entities/EntityChunkInspector.java +++ /dev/null @@ -1,187 +0,0 @@ -package com.cyprias.chunkspawnerlimiter.inspection.entities; - - -import com.cyprias.chunkspawnerlimiter.ChunkSpawnerLimiter; -import com.cyprias.chunkspawnerlimiter.compare.MobGroupCompare; -import com.cyprias.chunkspawnerlimiter.configs.impl.CslConfig; -import com.cyprias.chunkspawnerlimiter.utils.ChatUtil; -import com.cyprias.chunkspawnerlimiter.utils.Util; -import org.bukkit.Chunk; -import org.bukkit.Raid; -import org.bukkit.entity.*; -import org.bukkit.inventory.EntityEquipment; -import org.bukkit.inventory.ItemStack; -import org.bukkit.scheduler.BukkitRunnable; -import org.jetbrains.annotations.NotNull; - -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -public class EntityChunkInspector { - private final ChunkSpawnerLimiter plugin; - private final CslConfig config; - - public EntityChunkInspector(@NotNull ChunkSpawnerLimiter plugin) { - this.plugin = plugin; - this.config = plugin.getCslConfig(); - } - - /** - * Checks the chunk for entities, removes entities if over the limit. - * - * @param chunk Chunk - */ - public void checkChunk(@NotNull Chunk chunk) { - String worldName = chunk.getWorld().getName(); - if (config.isWorldNotAllowed(worldName)) { - ChatUtil.debug("World %s is not allowed", worldName); - return; - } - - Entity[] entities = chunk.getEntities(); - - // Offload calculations to an async task - new BukkitRunnable() { - @Override - public void run() { - // Perform calculations async - Map> types = addEntitiesByConfig(entities); // should be cached on load (already is) - List entitiesToRemove = new ArrayList<>(); - - for (Map.Entry> entry : types.entrySet()) { - String entityType = entry.getKey(); - List entityList = entry.getValue(); - int limit = config.getEntityLimit(entityType); - - if (entityList.size() > limit) { - for (int i = entityList.size() - 1; i >= limit; i--) { - Entity entity = entityList.get(i); - if (!shouldPreserve(entity)) { - entitiesToRemove.add(entity); - } - } - } - } - - // Pass the results back to the main thread - EntityChunkInspectionResult result = new EntityChunkInspectionResult(entitiesToRemove); - new BukkitRunnable() { - @Override - public void run() { - applyChanges(result); // Apply changes on the main thread - } - }.runTask(plugin); - } - }.runTaskAsynchronously(plugin); - } - - public void applyChanges(final @NotNull EntityChunkInspectionResult result) { - for (Entity entity: result.getEntitiesToRemove()) { - if (entity instanceof ArmorStand) { - handleArmorStand(entity); // Handle Armor Stands - continue; - } - - removeOrKillEntity(entity); - } - } - - private void handleArmorStand(Entity entity) { - if (!(entity instanceof ArmorStand)) { - return; - } - - if (config.isDropItemsFromArmorStands()) { - EntityEquipment entityEquipment = ((ArmorStand) entity).getEquipment(); - if (entityEquipment != null) { - for (ItemStack itemStack : entityEquipment.getArmorContents()) { - entity.getWorld().dropItemNaturally(entity.getLocation(), itemStack); - } - } - } - - if (Util.isArmorStandTickDisabled()) { - ChatUtil.logArmorStandTickWarning(); - entity.remove(); - } - } - - private void removeOrKillEntity(Entity entity) { - if (!entity.isValid()) { - return; - } - - if (!config.isKillInsteadOfRemove() || !isKillable(entity)) { - entity.remove(); - return; - } - - killEntity(entity); - } - - private void killEntity(final Entity entity) { - ((Damageable) entity).setHealth(0.0D); - } - - - public static boolean isKillable(final Entity entity) { - return entity instanceof Damageable; - } - - - private @NotNull Map> addEntitiesByConfig(Entity @NotNull [] entities) { - HashMap> modifiedTypes = new HashMap<>(); - for (int i = entities.length - 1; i >= 0; i--) { - final Entity entity = entities[i]; - - String entityType = entity.getType().name(); - String entityMobGroup = MobGroupCompare.getMobGroup(entity); - - addEntityIfHasLimit(modifiedTypes, entityType, entity); - addEntityIfHasLimit(modifiedTypes, entityMobGroup, entity); - } - return modifiedTypes; - } - - private void addEntityIfHasLimit(Map> modifiedTypes, String key, Entity entity) { - if (config.hasEntityLimit(key)) { - modifiedTypes.computeIfAbsent(key, k -> new ArrayList<>()).add(entity); - } - } - - private boolean shouldPreserve(Entity entity) { - return hasMetaData(entity) || hasCustomName(entity) || entity instanceof Player || isPartOfRaid(entity); - } - - private boolean hasCustomName(Entity entity) { - return config.isPreserveNamedEntities() && entity.getCustomName() != null; - } - - private boolean hasMetaData(Entity entity) { - for (String metadata : config.getIgnoreMetadata()) { - if (entity.hasMetadata(metadata)) { - return true; - } - } - return false; - } - - private boolean isPartOfRaid(Entity entity) { - if (!config.isPreserveRaidEntities()) { - return false; - } - - if (entity instanceof Raider) { - Raider raider = (Raider) entity; - for (Raid raid : raider.getWorld().getRaids()) { - boolean potentialMatch = raid.getRaiders().stream().anyMatch(r -> r.equals(raider)); - if (potentialMatch) { - return true; - } - } - } - return false; - } -} diff --git a/src/main/java/com/cyprias/chunkspawnerlimiter/inspection/entities/EntityChunkInspectorScheduler.java b/src/main/java/com/cyprias/chunkspawnerlimiter/inspection/entities/EntityChunkInspectorScheduler.java deleted file mode 100644 index bb5817f..0000000 --- a/src/main/java/com/cyprias/chunkspawnerlimiter/inspection/entities/EntityChunkInspectorScheduler.java +++ /dev/null @@ -1,51 +0,0 @@ -package com.cyprias.chunkspawnerlimiter.inspection.entities; - - -import com.cyprias.chunkspawnerlimiter.ChunkSpawnerLimiter; -import org.bukkit.Chunk; -import org.bukkit.scheduler.BukkitTask; -import org.jetbrains.annotations.NotNull; - -import java.util.Map; -import java.util.WeakHashMap; - -public class EntityChunkInspectorScheduler { - private final ChunkSpawnerLimiter plugin; - private final EntityChunkInspector entityChunkInspector; - private final Map chunkTasks = new WeakHashMap<>(); - - public EntityChunkInspectorScheduler(ChunkSpawnerLimiter plugin, EntityChunkInspector entityChunkInspector) { - this.plugin = plugin; - this.entityChunkInspector = entityChunkInspector; - } - - /** - * Schedules an inspection task for the chunk - * @param chunk The chunk to inspect - * @param repeating Whether the task should repeat - */ - public void scheduleInspection(@NotNull Chunk chunk, boolean repeating) { - cancelExistingTask(chunk); - - EntityInspectTask task = new EntityInspectTask(chunk, entityChunkInspector); - long delay = plugin.getCslConfig().getInspectionFrequency() * 20L; - - BukkitTask bukkitTask = repeating ? - task.runTaskTimer(plugin, delay, delay) : - task.runTaskLater(plugin, 1L); - - task.setId(bukkitTask.getTaskId()); - chunkTasks.put(chunk, bukkitTask); - } - - /** - * Cancels any existing task for the chunk, also remove from map. - * @param chunk The chunk to cancel tasks for - */ - public void cancelExistingTask(@NotNull Chunk chunk) { - BukkitTask task = chunkTasks.remove(chunk); - if (task != null) { - task.cancel(); - } - } -} diff --git a/src/main/java/com/cyprias/chunkspawnerlimiter/inspection/entities/EntityInspectTask.java b/src/main/java/com/cyprias/chunkspawnerlimiter/inspection/entities/EntityInspectTask.java deleted file mode 100644 index ec6f2cf..0000000 --- a/src/main/java/com/cyprias/chunkspawnerlimiter/inspection/entities/EntityInspectTask.java +++ /dev/null @@ -1,70 +0,0 @@ -package com.cyprias.chunkspawnerlimiter.inspection.entities; - -import com.cyprias.chunkspawnerlimiter.ChunkSpawnerLimiter; -import com.cyprias.chunkspawnerlimiter.utils.ChatUtil; -import com.cyprias.chunkspawnerlimiter.messages.Debug; - -import org.bukkit.Chunk; -import org.bukkit.scheduler.BukkitRunnable; - -import java.lang.ref.WeakReference; - - -/** - * A BukkitRunnable task that inspects a chunk for potential spawner issues. - * The task checks if the chunk is loaded and then calls the checkChunk method. - * If the chunk is not loaded, the task cancels itself. - */ -public class EntityInspectTask extends BukkitRunnable { - private final EntityChunkInspector entityChunkInspector; - /** - * A WeakReference to the chunk being inspected. - * This is used to prevent memory leaks when the chunk is garbage collected. - */ - private final WeakReference refChunk; - - /** - * The ID of the task, used to cancel the task if necessary. - */ - private int id; - - /** - * {@inheritDoc} - * - * Performs the inspection of the chunk. - * If the chunk is null, logs a message and returns. - * If the chunk is not loaded, cancels the task. - * Otherwise, calls the checkChunk method. - */ - @Override - public void run() { - final Chunk chunk = this.refChunk.get(); - if (chunk == null || !chunk.isLoaded()) { - ChunkSpawnerLimiter.cancelTask(id); - return; - } - - ChatUtil.debug(Debug.ACTIVE_CHECK, chunk.getX(), chunk.getZ()); - - entityChunkInspector.checkChunk(chunk); - } - - /** - * Constructs a new InspectTask for the given chunk. - * - * @param chunk The chunk to be inspected - */ - public EntityInspectTask(final Chunk chunk, final EntityChunkInspector entityChunkInspector) { - this.refChunk = new WeakReference<>(chunk); - this.entityChunkInspector = entityChunkInspector; - } - - /** - * Sets the ID of the task. - * - * @param id The ID of the task - */ - public void setId(final int id) { - this.id = id; - } -} diff --git a/src/main/java/com/cyprias/chunkspawnerlimiter/listeners/EntityListener.java b/src/main/java/com/cyprias/chunkspawnerlimiter/listeners/EntityListener.java deleted file mode 100644 index c3bace4..0000000 --- a/src/main/java/com/cyprias/chunkspawnerlimiter/listeners/EntityListener.java +++ /dev/null @@ -1,84 +0,0 @@ -package com.cyprias.chunkspawnerlimiter.listeners; - -import com.cyprias.chunkspawnerlimiter.inspection.entities.EntityChunkInspectorScheduler; -import com.cyprias.chunkspawnerlimiter.utils.ChatUtil; -import com.cyprias.chunkspawnerlimiter.messages.Debug; -import org.bukkit.Chunk; -import org.bukkit.event.EventHandler; -import org.bukkit.event.Listener; -import org.bukkit.event.entity.CreatureSpawnEvent; - -import com.cyprias.chunkspawnerlimiter.configs.impl.CslConfig; -import org.bukkit.event.entity.EntitySpawnEvent; -import org.bukkit.event.vehicle.VehicleCreateEvent; -import org.jetbrains.annotations.NotNull; - -/** - * Spawn Reasons at CreatureSpawnEvent.SpawnReason - */ -public class EntityListener implements Listener { - private final CslConfig config; - private final EntityChunkInspectorScheduler entityChunkInspectorScheduler; - - public EntityListener(CslConfig config, EntityChunkInspectorScheduler entityChunkInspectorScheduler) { - this.config = config; - this.entityChunkInspectorScheduler = entityChunkInspectorScheduler; - } - - @EventHandler - public void onCreatureSpawnEvent(@NotNull CreatureSpawnEvent event) { - if (event.isCancelled() || !config.isWatchCreatureSpawns()) { - return; - } - - final String reason = event.getSpawnReason().toString(); - - if (!config.isSpawnReason(reason)) { - ChatUtil.debug(Debug.IGNORE_ENTITY, event.getEntity().getType(), reason); - return; - } - - final Chunk chunk = event.getLocation().getChunk(); - entityChunkInspectorScheduler.scheduleInspection(chunk,false); - checkSurroundings(chunk); - } - - - @EventHandler - public void onVehicleCreateEvent(@NotNull VehicleCreateEvent event) { - if (event.isCancelled() || !config.isWatchVehicleCreate()) { - return; - } - - final Chunk chunk = event.getVehicle().getLocation().getChunk(); - - ChatUtil.debug(Debug.VEHICLE_CREATE_EVENT, chunk.getX(), chunk.getZ()); - entityChunkInspectorScheduler.scheduleInspection(chunk,false); - checkSurroundings(chunk); - } - - @EventHandler - public void onEntitySpawnEvent(@NotNull EntitySpawnEvent event) { - if (event.isCancelled() || event instanceof CreatureSpawnEvent || !config.isWatchEntitySpawns()) { - return; - } - - final Chunk chunk = event.getEntity().getLocation().getChunk(); - - ChatUtil.debug("Entity Spawn Event: %s, %dx, %dz ", event.getEntity().getType().name(), chunk.getX(), chunk.getZ()); - entityChunkInspectorScheduler.scheduleInspection(chunk,false); - checkSurroundings(chunk); - } - - - private void checkSurroundings(Chunk chunk) { - int surrounding = config.getCheckSurroundingChunks(); - if (surrounding > 0) { - for (int x = chunk.getX() + surrounding; x >= (chunk.getX() - surrounding); x--) { - for (int z = chunk.getZ() + surrounding; z >= (chunk.getZ() - surrounding); z--) { - entityChunkInspectorScheduler.scheduleInspection(chunk.getWorld().getChunkAt(x, z),false); - } - } - } - } -} diff --git a/src/main/java/com/cyprias/chunkspawnerlimiter/listeners/PlaceBlockListener.java b/src/main/java/com/cyprias/chunkspawnerlimiter/listeners/PlaceBlockListener.java deleted file mode 100644 index 21d4eae..0000000 --- a/src/main/java/com/cyprias/chunkspawnerlimiter/listeners/PlaceBlockListener.java +++ /dev/null @@ -1,119 +0,0 @@ -package com.cyprias.chunkspawnerlimiter.listeners; - -import com.cyprias.chunkspawnerlimiter.messages.Debug; -import com.cyprias.chunkspawnerlimiter.utils.ChatUtil; -import com.cyprias.chunkspawnerlimiter.ChunkSpawnerLimiter; -import com.cyprias.chunkspawnerlimiter.utils.ChunkSnapshotCache; -import org.bukkit.Chunk; -import org.bukkit.Material; -import org.bukkit.World; -import org.bukkit.event.EventHandler; -import org.bukkit.event.EventPriority; -import org.bukkit.event.Listener; -import org.bukkit.event.block.BlockBreakEvent; -import org.bukkit.event.block.BlockPlaceEvent; -import org.bukkit.event.world.ChunkUnloadEvent; -import org.jetbrains.annotations.NotNull; - -/** - * @author sarhatabaot - */ -public class PlaceBlockListener implements Listener { - private final ChunkSpawnerLimiter plugin; - private final ChunkSnapshotCache chunkSnapshotCache; - - public PlaceBlockListener(final ChunkSpawnerLimiter plugin) { - this.plugin = plugin; - this.chunkSnapshotCache = new ChunkSnapshotCache(plugin); - } - - @EventHandler(priority = EventPriority.HIGHEST) - public void onPlace(@NotNull BlockPlaceEvent event) { - if (event.isCancelled() || !plugin.getBlocksConfig().isEnabled()) { - return; - } - - if (plugin.getCslConfig().isWorldNotAllowed(event.getBlock().getChunk().getWorld().getName())) { - return; - } - - final Material placedType = event.getBlock().getType(); - if (!plugin.getBlocksConfig().hasLimit(placedType)) { - return; - } - - - final Integer limit = plugin.getBlocksConfig().getLimit(placedType); - final int minY = getMinY(event.getBlock().getWorld()); - final int maxY = getMaxY(event.getBlock().getWorld()); - event.setCancelled(true); - - final Chunk chunk = event.getBlock().getChunk(); - - // Hybrid check - int currentCount = chunkSnapshotCache.getMaterialCount(chunk, placedType, minY, maxY, limit); - ChatUtil.debug(Debug.SCAN_LIMIT, placedType, currentCount, limit > plugin.getBlocksConfig().getMinLimitForCache()); - if (currentCount <= limit) { - event.setCancelled(false); - chunkSnapshotCache.updateMaterialCount(chunk, placedType, +1, limit); // Update cache if needed - return; - } - - // Blocked due to limit; cache remains valid - if (plugin.getBlocksConfig().isNotifyMessage()) { - ChatUtil.message( - event.getPlayer(), plugin.getCslConfig().getMaxAmountBlocks() - .replace("{material}", placedType.name()) - .replace("{amount}", String.valueOf(limit)) - ); - } - - if (plugin.getBlocksConfig().isNotifyTitle()) { - ChatUtil.title( - event.getPlayer(), - plugin.getCslConfig().getMaxAmountBlocksTitle(), - plugin.getCslConfig().getMaxAmountBlocksSubtitle(), - placedType.name(), - limit - ); - } - - ChatUtil.debug(Debug.BLOCK_PLACE_CHECK, placedType, currentCount, limit); - } - - @EventHandler - public void onBreak(@NotNull BlockBreakEvent event) { - Material brokenType = event.getBlock().getType(); - if (plugin.getBlocksConfig().hasLimit(brokenType)) { - int limit = plugin.getBlocksConfig().getLimit(brokenType); - chunkSnapshotCache.updateMaterialCount(event.getBlock().getChunk(), brokenType, -1, limit); - } - } - - @EventHandler - public void onChunkUnload(@NotNull ChunkUnloadEvent event) { - chunkSnapshotCache.invalidate(event.getChunk()); - } - - private int getMinY(final @NotNull World world) { - if (plugin.getBlocksConfig().hasWorld(world.getName())) { - return plugin.getBlocksConfig().getMinY(world.getName()); - } - switch (world.getEnvironment()) { - case NORMAL: - return plugin.getBlocksConfig().getMinY(); - case NETHER: - case THE_END: - default: - return 0; - } - } - - private int getMaxY(final @NotNull World world) { - if (plugin.getBlocksConfig().hasWorld(world.getName())) { - return plugin.getBlocksConfig().getMaxY(world.getName()); - } - return plugin.getBlocksConfig().getMaxY(); - } - -} diff --git a/src/main/java/com/cyprias/chunkspawnerlimiter/listeners/WorldListener.java b/src/main/java/com/cyprias/chunkspawnerlimiter/listeners/WorldListener.java deleted file mode 100644 index d136bd7..0000000 --- a/src/main/java/com/cyprias/chunkspawnerlimiter/listeners/WorldListener.java +++ /dev/null @@ -1,49 +0,0 @@ -package com.cyprias.chunkspawnerlimiter.listeners; - - -import com.cyprias.chunkspawnerlimiter.inspection.entities.EntityChunkInspectorScheduler; -import com.cyprias.chunkspawnerlimiter.utils.ChatUtil; -import com.cyprias.chunkspawnerlimiter.messages.Debug; -import org.bukkit.Chunk; -import org.bukkit.event.EventHandler; -import org.bukkit.event.Listener; -import org.bukkit.event.world.ChunkLoadEvent; -import org.bukkit.event.world.ChunkUnloadEvent; - -import com.cyprias.chunkspawnerlimiter.ChunkSpawnerLimiter; -import org.jetbrains.annotations.NotNull; - -public class WorldListener implements Listener { - private final ChunkSpawnerLimiter plugin; - private final EntityChunkInspectorScheduler chunkInspectorScheduler; - - public WorldListener(ChunkSpawnerLimiter plugin, EntityChunkInspectorScheduler chunkInspectorScheduler) { - this.plugin = plugin; - this.chunkInspectorScheduler = chunkInspectorScheduler; - } - - @EventHandler - public void onChunkLoadEvent(@NotNull ChunkLoadEvent event) { - final Chunk chunk = event.getChunk(); - - if (plugin.getCslConfig().isActiveInspections()) { - chunkInspectorScheduler.scheduleInspection(chunk, true); - } - - if (plugin.getCslConfig().isCheckChunkLoad()) { - ChatUtil.debug(Debug.CHUNK_LOAD_EVENT, chunk.getX(), chunk.getZ()); - chunkInspectorScheduler.scheduleInspection(chunk, false); - } - } - - @EventHandler - public void onChunkUnloadEvent(@NotNull ChunkUnloadEvent event) { - final Chunk chunk = event.getChunk(); - chunkInspectorScheduler.cancelExistingTask(chunk); - - if (plugin.getCslConfig().isCheckChunkUnload()) { - ChatUtil.debug(Debug.CHUNK_UNLOAD_EVENT, chunk.getX(), chunk.getZ()); - chunkInspectorScheduler.scheduleInspection(chunk, false); - } - } -} diff --git a/src/main/java/com/cyprias/chunkspawnerlimiter/messages/Command.java b/src/main/java/com/cyprias/chunkspawnerlimiter/messages/Command.java deleted file mode 100644 index 2ad598f..0000000 --- a/src/main/java/com/cyprias/chunkspawnerlimiter/messages/Command.java +++ /dev/null @@ -1,46 +0,0 @@ -package com.cyprias.chunkspawnerlimiter.messages; - -public final class Command { - public static class Reload { - public static final String COMMAND = "reload"; - public static final String ALIAS = "cslreload"; - public static final String PERMISSION = "csl.reload"; - public static final String DESCRIPTION = "Reloads the config file."; - - private Reload() { - throw new UnsupportedOperationException("This operation is not supported"); - } - } - - public static class Settings { - public static final String COMMAND = "settings"; - public static final String ALIAS = "cslsettings"; - public static final String PERMISSION = "csl.settings"; - public static final String DESCRIPTION = "Shows config settings."; - - private Settings() { - throw new UnsupportedOperationException("This operation is not supported"); - } - } - public static class Search { - public static final String COMMAND = "search"; - public static final String ALIAS = "cslsearch"; - public static final String PERMISSION = "csl.search"; - public static final String DESCRIPTION = "Shows entity search results."; - } - - public static class Info { - public static final String COMMAND = "info"; - public static final String ALIAS = "cslinfo"; - public static final String PERMISSION = "csl.info"; - public static final String DESCRIPTION = "Shows config info."; - - private Info() { - throw new UnsupportedOperationException("This operation is not supported"); - } - } - - private Command() { - throw new UnsupportedOperationException("This operation is not supported"); - } -} \ No newline at end of file diff --git a/src/main/java/com/cyprias/chunkspawnerlimiter/messages/Debug.java b/src/main/java/com/cyprias/chunkspawnerlimiter/messages/Debug.java deleted file mode 100644 index ca11f40..0000000 --- a/src/main/java/com/cyprias/chunkspawnerlimiter/messages/Debug.java +++ /dev/null @@ -1,18 +0,0 @@ -package com.cyprias.chunkspawnerlimiter.messages; - -public final class Debug { - public static final String IGNORE_ENTITY = "Ignoring %s due spawn-reason: %s"; - public static final String REMOVING_ENTITY_AT = "Removing %d %s @ %dx %dz"; - public static final String ACTIVE_CHECK = "Active check @ %dx %dz"; - public static final String CREATE_ACTIVE_CHECK = "Created active check %s %s"; - public static final String REGISTER_LISTENERS = "Registered listeners."; - public static final String CHUNK_UNLOAD_EVENT = "ChunkUnloadEvent %s %s"; - public static final String CHUNK_LOAD_EVENT = "ChunkLoadEvent %s %s"; - public static final String VEHICLE_CREATE_EVENT = "VehicleCreateEvent %s %s"; - public static final String BLOCK_PLACE_CHECK = "Material=%s, Count=%d, Limit=%d"; - public static final String SCAN_LIMIT = "Counted %s: %d | Used cache: %b"; - - private Debug() { - throw new UnsupportedOperationException("This operation is not supported"); - } -} \ No newline at end of file diff --git a/src/main/java/com/cyprias/chunkspawnerlimiter/utils/ChatUtil.java b/src/main/java/com/cyprias/chunkspawnerlimiter/utils/ChatUtil.java deleted file mode 100644 index 71bb732..0000000 --- a/src/main/java/com/cyprias/chunkspawnerlimiter/utils/ChatUtil.java +++ /dev/null @@ -1,88 +0,0 @@ -package com.cyprias.chunkspawnerlimiter.utils; - -import com.cyprias.chunkspawnerlimiter.ChunkSpawnerLimiter; -import com.cyprias.chunkspawnerlimiter.configs.impl.CslConfig; -import org.bukkit.Bukkit; -import org.bukkit.ChatColor; -import org.bukkit.command.CommandSender; -import org.bukkit.entity.Player; -import org.jetbrains.annotations.Contract; -import org.jetbrains.annotations.NotNull; - -/** - * ChatUtil - */ -public class ChatUtil { - private static CslConfig config; - private static ChunkSpawnerLimiter plugin; - - private ChatUtil() { - throw new UnsupportedOperationException("Util class."); - } - - public static void init(final @NotNull ChunkSpawnerLimiter plugin) { - ChatUtil.config = plugin.getCslConfig(); - ChatUtil.plugin = plugin; - } - - public static void message(@NotNull CommandSender target, String message) { - target.sendMessage(colorize(message)); - } - - public static void message(@NotNull CommandSender target, String message, Object... args) { - target.sendMessage(String.format(colorize(message), args)); - } - - public static void title(@NotNull Player player, final String title, final String subtitle, String material, int amount) { - - player.sendTitle( - replace(colorize(title), material, amount), - replace(colorize(subtitle), material, amount), - 10, - 70, - 20 - ); - } - - private static @NotNull String replace(@NotNull String message, String material, int amount) { - return message.replace("{material}", material) - .replace("{amount}", String.valueOf(amount)); - } - - @Contract("_ -> new") - public static @NotNull String colorize(String message) { - if (message == null) { - return ""; - } - - return ChatColor.translateAlternateColorCodes('&', message); - } - - public static void debug(String message) { - if (config.isDebugMessages()) { - plugin.getLogger().info(() -> "DEBUG " + message); - } - } - - public static void debug(String message, Object... args) { - if (config.isDebugMessages()) { - plugin.getLogger().info(() -> "DEBUG " + String.format(message, args)); - } - } - - public static void logAndCheckArmorStandTickWarning() { - if (Util.isArmorStandTickDisabled()) { - logArmorStandTickWarning(); - } - } - - public static void logArmorStandTickWarning() { - if (config.isLogArmorStandTickWarning()) { - Bukkit.getLogger().warning(() -> "[CSL] Armor Stand Ticks are disabled in your paper-world.yml or paper-world-defaults.yml file"); - Bukkit.getLogger().warning(() -> "[CSL] The kill instead of remove feature will not work properly with this setting enabled."); - Bukkit.getLogger().warning(() -> "[CSL] Instead, the armor stand will be removed normally instead of \"killed\""); - } - } - - -} diff --git a/src/main/java/com/cyprias/chunkspawnerlimiter/utils/ChunkSnapshotCache.java b/src/main/java/com/cyprias/chunkspawnerlimiter/utils/ChunkSnapshotCache.java deleted file mode 100644 index 5cdbae6..0000000 --- a/src/main/java/com/cyprias/chunkspawnerlimiter/utils/ChunkSnapshotCache.java +++ /dev/null @@ -1,105 +0,0 @@ -package com.cyprias.chunkspawnerlimiter.utils; - -import org.bukkit.Chunk; -import org.bukkit.Material; -import org.bukkit.ChunkSnapshot; -import com.cyprias.chunkspawnerlimiter.ChunkSpawnerLimiter; - -import java.util.Map; -import java.util.HashMap; -import java.util.concurrent.ConcurrentHashMap; -import java.util.concurrent.ConcurrentMap; - -/** - * Hybrid cache for chunk block counts (scans low-limit blocks, caches high-limit blocks). - */ -public final class ChunkSnapshotCache { - private final ChunkSpawnerLimiter plugin; - private final ConcurrentMap> materialCounts = new ConcurrentHashMap<>(); - private final ConcurrentMap chunkSnapshots = new ConcurrentHashMap<>(); - - public ChunkSnapshotCache(ChunkSpawnerLimiter plugin) { - this.plugin = plugin; - } - - private static String getChunkKey(Chunk chunk) { - return chunk.getWorld().getName() + ":" + chunk.getX() + ":" + chunk.getZ(); - } - - /** - * Gets a cached snapshot or creates a new one (thread-safe). - */ - public ChunkSnapshot getSnapshot(Chunk chunk) { - return chunkSnapshots.computeIfAbsent(getChunkKey(chunk), k -> chunk.getChunkSnapshot()); - } - - /** - * Gets block count for a material, using cache for high-limit blocks. - */ - public int getMaterialCount(Chunk chunk, Material material, int minY, int maxY, int limit) { - // Use cache only for high-limit materials - if (limit > plugin.getBlocksConfig().getMinLimitForCache()) { - String key = getChunkKey(chunk); - return materialCounts.getOrDefault(key, new HashMap<>()).getOrDefault(material, 0); - } - // Fall back to scanning for low-limit materials - return countBlocksInChunk(getSnapshot(chunk), material, minY, maxY); - } - - /** - * Updates material count cache (only for high-limit blocks). - */ - public void updateMaterialCount(Chunk chunk, Material material, int delta, int limit) { - if (limit > plugin.getBlocksConfig().getMinLimitForCache()) { // Only cache if limit is high - String key = getChunkKey(chunk); - materialCounts.compute(key, (k, counts) -> { - Map newCounts = (counts != null) ? new HashMap<>(counts) : new HashMap<>(); - newCounts.merge(material, delta, Integer::sum); - return newCounts; - }); - } - // Always invalidate snapshot on changes - invalidateSnapshot(chunk); - } - - /** - * Counts blocks in a chunk section. - */ - private int countBlocksInChunk(ChunkSnapshot snapshot, Material material, int minY, int maxY) { - int count = 0; - for (int y = minY; y < maxY; y++) { - for (int z = 0; z < 16; z++) { - for (int x = 0; x < 16; x++) { - if (snapshot.getBlockType(x, y, z) == material) { - count++; - } - } - } - } - return count; - } - - /** - * Invalidates all cached data for a chunk. - */ - public void invalidate(Chunk chunk) { - String key = getChunkKey(chunk); - materialCounts.remove(key); - chunkSnapshots.remove(key); - } - - /** - * Only invalidates the snapshot (keeps material counts). - */ - public void invalidateSnapshot(Chunk chunk) { - chunkSnapshots.remove(getChunkKey(chunk)); - } - - /** - * Clears the entire cache. - */ - public void clear() { - materialCounts.clear(); - chunkSnapshots.clear(); - } -} \ No newline at end of file diff --git a/src/main/java/com/cyprias/chunkspawnerlimiter/utils/Util.java b/src/main/java/com/cyprias/chunkspawnerlimiter/utils/Util.java deleted file mode 100644 index 6d61907..0000000 --- a/src/main/java/com/cyprias/chunkspawnerlimiter/utils/Util.java +++ /dev/null @@ -1,57 +0,0 @@ -package com.cyprias.chunkspawnerlimiter.utils; - - -import org.bukkit.Bukkit; -import org.bukkit.configuration.file.FileConfiguration; -import org.bukkit.configuration.file.YamlConfiguration; - -import java.io.File; - -public class Util { - private Util() { - throw new UnsupportedOperationException("Util class."); - } - /** - * Checks if the server software is Paper and if the configuration setting - * for ticking armor stands is disabled. - *

- * Specifically, this method verifies two conditions: - *

    - *
  • Whether the server is running Paper software (as opposed to Bukkit or Spigot).
    • - *
  • Whether the configuration option `entities.armor-stands.tick` is set to `false` - * in Paper's configuration file. This setting, if present, prevents armor stands from ticking.
    • - *
- * - * @return {@code true} if the server is running Paper and the armor stand tick option is set to {@code false}, - * {@code false} otherwise. - */ - public static boolean isArmorStandTickDisabled() { - // Check if the server is running Paper. If not, the setting does not apply. - if (!isPaperServer()) { - return false; - } - - // Load the primary paper.yml configuration file. - File paperConfigFile = new File(Bukkit.getServer().getWorldContainer(), "paper-world.yml"); - - // If the primary file does not exist, attempt to load a default configuration file. - if (!paperConfigFile.exists()) { - paperConfigFile = new File("config", "paper-world-defaults.yml"); - } - - // Parse the configuration file. - FileConfiguration paperConfig = YamlConfiguration.loadConfiguration(paperConfigFile); - - // Return the negation of the armor stand tick setting. Defaults to true if the setting is not specified. - return !paperConfig.getBoolean("entities.armor-stands.tick", true); - } - - public static boolean isPaperServer() { - try { - Class.forName("com.destroystokyo.paper.PaperConfig"); - return true; - } catch (ClassNotFoundException e) { - return false; - } - } -} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/CSLLogger.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/CSLLogger.java new file mode 100644 index 0000000..bdcdd09 --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/CSLLogger.java @@ -0,0 +1,52 @@ +package com.github.sarhatabaot.chunkspawnerlimiter; + + +import java.util.function.Supplier; +import java.util.logging.Level; +import java.util.logging.Logger; + +public final class CSLLogger { + private static PluginConfig pluginConfig; + private static final Logger LOGGER = Logger.getLogger("CSL"); + + private CSLLogger() { + } + + public static void setup(PluginConfig pluginConfig) { + CSLLogger.pluginConfig = pluginConfig; + } + + public static void info(String message) { + LOGGER.log(Level.INFO, message); + } + + public static void warn(String message) { + LOGGER.log(Level.WARNING, message); + } + + public static void error(String message) { + LOGGER.log(Level.SEVERE, message); + } + + public static void debug(Supplier messageSupplier) { + + if (pluginConfig != null && pluginConfig.isDebugMessages()) { + log("DEBUG " + messageSupplier.get()); + } + } + + // --- Core Implementation --- + + private static void log(String message) { + StackTraceElement[] stack = Thread.currentThread().getStackTrace(); + + String caller = "UnknownSource"; + if (stack.length > 3) { + StackTraceElement element = stack[3]; + caller = element.getClassName() + "#" + element.getMethodName() + ":" + element.getLineNumber(); + } + + LOGGER.log(Level.INFO, "[" + caller + "] " + message); + } + +} \ No newline at end of file diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/ChunkSpawnerLimiter.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/ChunkSpawnerLimiter.java new file mode 100644 index 0000000..a4d002d --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/ChunkSpawnerLimiter.java @@ -0,0 +1,109 @@ +package com.github.sarhatabaot.chunkspawnerlimiter; + + +import com.github.sarhatabaot.chunkspawnerlimiter.command.AdminCommand; +import com.github.sarhatabaot.chunkspawnerlimiter.counter.CounterDataManager; +import com.github.sarhatabaot.chunkspawnerlimiter.listener.ChunkListener; +import com.github.sarhatabaot.chunkspawnerlimiter.listener.EventListener; +import com.github.sarhatabaot.chunkspawnerlimiter.notification.NotificationService; +import com.github.sarhatabaot.chunkspawnerlimiter.removal.Checks; +import com.github.sarhatabaot.chunkspawnerlimiter.removal.ExternalChecks; +import com.github.sarhatabaot.chunkspawnerlimiter.removal.RemovalTaskManager; +import com.github.sarhatabaot.chunkspawnerlimiter.removal.modes.RemovalMode; +import me.despical.commandframework.CommandFramework; +import org.bstats.bukkit.Metrics; +import org.bstats.charts.SimplePie; +import org.bukkit.Bukkit; +import org.bukkit.plugin.PluginDescriptionFile; +import org.bukkit.plugin.PluginManager; +import org.bukkit.plugin.java.JavaPlugin; +import org.bukkit.plugin.java.JavaPluginLoader; + +import java.io.File; + +public class ChunkSpawnerLimiter extends JavaPlugin { + private RemovalTaskManager removalTaskManager; + private CounterDataManager counterDataManager; + private PluginConfig pluginConfig; + private NotificationService notificationService; + + @Override + public void onEnable() { + this.pluginConfig = new PluginConfig(this); + + CSLLogger.setup(this.pluginConfig); + Checks.setup(pluginConfig); + ExternalChecks.setup(this.pluginConfig); + + this.counterDataManager = new CounterDataManager(); + this.removalTaskManager = new RemovalTaskManager(this, counterDataManager, pluginConfig); + this.notificationService = new NotificationService(pluginConfig); + + try { + CommandFramework commandFramework = new CommandFramework(this); + commandFramework.registerCommands(new AdminCommand(this, removalTaskManager, pluginConfig)); + } catch (IllegalStateException e) { + if (e.getMessage().contains("Command Framework has not been relocated")) { + // During testing, the library may not be relocated, skip command framework initialization + getLogger().fine("Command Framework initialization skipped during testing: " + e.getMessage()); + } else { + throw e; + } + } + + RemovalMode.setup(removalTaskManager); + + PluginManager pluginManager = Bukkit.getPluginManager(); + pluginManager.registerEvents(new ChunkListener(this, pluginConfig, counterDataManager, removalTaskManager), this); + pluginManager.registerEvents(new EventListener(pluginConfig, counterDataManager, notificationService), this); + + if (pluginConfig.isMetrics()) { + try { + Metrics metrics = new Metrics(this, 4195); + metrics.addCustomChart(new SimplePie("removal_mode", () -> pluginConfig.getRemovalMode().getKey())); + //entities removed + //blocks removed + //average settings? + } catch (Exception e) { + // Silently skip bStats initialization if classes are not available (e.g., during testing) + getLogger().fine("bStats metrics initialization skipped: " + e.getMessage()); + } + } + } + + @Override + public void onDisable() { + this.counterDataManager = null; + this.removalTaskManager = null; + this.pluginConfig = null; + this.notificationService = null; + } + + public void onReload() { + this.pluginConfig.reload(); + } + + public CounterDataManager getCounterDataManager() { + return counterDataManager; + } + + public PluginConfig getPluginConfig() { + return pluginConfig; + } + + public NotificationService getNotificationService() { + return notificationService; + } + + public RemovalTaskManager getRemovalTaskManager() { + return removalTaskManager; + } + + public ChunkSpawnerLimiter() { + super(); + } + + protected ChunkSpawnerLimiter(JavaPluginLoader loader, PluginDescriptionFile description, File dataFolder, File file) { + super(loader, description, dataFolder, file); + } +} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/PluginConfig.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/PluginConfig.java new file mode 100644 index 0000000..8e0fb4a --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/PluginConfig.java @@ -0,0 +1,628 @@ +package com.github.sarhatabaot.chunkspawnerlimiter; + +import com.github.sarhatabaot.chunkspawnerlimiter.removal.modes.RemovalMode; +import org.bukkit.Material; +import org.bukkit.configuration.ConfigurationSection; +import org.bukkit.configuration.file.FileConfiguration; +import org.bukkit.entity.*; +import org.bukkit.event.entity.CreatureSpawnEvent; +import org.bukkit.plugin.java.JavaPlugin; +import org.jetbrains.annotations.NotNull; + +import java.util.*; +import java.util.stream.Collectors; + +/** + * Manages configuration settings for the ChunkSpawnerLimiter plugin. + * This class handles loading, caching, and providing access to all plugin configuration + * values including entity limits, block limits, spawn reasons, and various behavior settings. + * + *

The configuration supports both direct type limits and group-based limits, + * with direct limits taking precedence over group limits.

+ * + * @author sarhatabaot + * @version 1.0 + * @see JavaPlugin + * @see FileConfiguration + */ +public class PluginConfig { + private final JavaPlugin plugin; + private FileConfiguration config; + + // Entity limit mappings + private Map directEntityLimits; + private Map resolvedEntityLimits; + private Map entityToGroup; + + // Block limit mappings + private Map directBlockLimits; + private Map resolvedBlockLimits; + private Map blockToGroup; + + // Raw configuration data + private Map entityLimits; + private Map blockLimits; + private Set spawnReasons; + private List worldsList; + + /** + * Constructs a new PluginConfig instance and loads the initial configuration. + * + * @param plugin the JavaPlugin instance, must not be null + * @throws NullPointerException if plugin is null + */ + public PluginConfig(JavaPlugin plugin) { + this.plugin = Objects.requireNonNull(plugin, "Plugin cannot be null"); + this.plugin.saveDefaultConfig(); + reload(); + } + + /** + * Reloads the configuration from disk and updates all cached values. + * This method should be called when the configuration file is modified externally + * or when a reload command is executed. + */ + public void reload() { + plugin.reloadConfig(); + this.config = plugin.getConfig(); + + this.entityLimits = null; + + loadEntityGroups(); + loadEntityLimits(); + + this.blockLimits = null; + loadBlockGroups(); + loadBlockLimits(); + + loadSpawnReasons(); + loadWorldsList(); + } + + /** + * Checks if the plugin is enabled. + * + * @return true if the plugin is enabled, false otherwise + */ + public boolean isEnabled() { + return config.getBoolean("enabled", true); + } + + /** + * Checks if debug messages are enabled. + * + * @return true if debug messages should be printed, false otherwise + */ + public boolean isDebugMessages() { + return config.getBoolean("debug-messages", false); + } + + /** + * Checks if metrics collection is enabled. + * + * @return true if metrics should be collected, false otherwise + */ + public boolean isMetrics() { + // Disable metrics during testing to avoid bStats initialization issues + if (isRunningTests()) { + return false; + } + return config.getBoolean("metrics", true); + } + + /** + * Checks if the code is running in a test environment. + * This is determined by checking the class loader name or stack trace for test indicators. + * + * @return true if running tests, false otherwise + */ + private boolean isRunningTests() { + // Check if we're running from a test class loader + String classLoaderName = getClass().getClassLoader().getClass().getName(); + if (classLoaderName.contains("test") || classLoaderName.contains("junit") || + classLoaderName.contains("mockito") || classLoaderName.contains("mockbukkit")) { + return true; + } + + // Check stack trace for test-related classes + StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace(); + for (StackTraceElement element : stackTrace) { + String className = element.getClassName(); + if (className.contains("junit") || className.contains("testng") || + className.contains("mockbukkit") || className.startsWith("org.junit") || + className.contains("PluginIntegrationLegacyTest") || + className.contains("PluginIntegrationTest")) { + return true; + } + } + + return false; + } + + /** + * Checks if creature spawn events should be watched. + * Note: This is theoretically covered by EntitySpawnEvent. + * + * @return true if creature spawn events should be watched, false otherwise + */ + public boolean isCreatureSpawnWatch() { + return config.getBoolean("events.spawn.creature", true); + } + + /** + * Checks if vehicle spawn events should be watched. + * + * @return true if vehicle spawn events should be watched, false otherwise + */ + public boolean isVehicleSpawnWatch() { + return config.getBoolean("events.spawn.vehicle", true); + } + + /** + * Checks if entity spawn events should be watched. + * + * @return true if entity spawn events should be watched, false otherwise + */ + public boolean isEntitySpawnWatch() { + return config.getBoolean("events.spawn.entity", true); + } + + /** + * Checks if periodic chunk inspections are enabled. + * + * @return true if inspections should run periodically, false otherwise + */ + public boolean isActiveInspections() { + return config.getBoolean("events.inspections.enabled", true); + } + + /** + * Gets the frequency (in ticks) at which chunk inspections should occur. + * + * @return the inspection frequency in ticks + */ + public int getInspectionFrequency() { + return config.getInt("events.inspections.frequency", 300); + } + + + /** + * Loads block groups from the configuration. + * Block groups allow multiple block types to share a common limit. + */ + private void loadBlockGroups() { + blockToGroup = new EnumMap<>(Material.class); + + ConfigurationSection section = config.getConfigurationSection("blocks.block-groups"); + if (section == null) return; + + for (String group: section.getKeys(false)){ + for (String member : section.getStringList(group)) { + Material type = Material.valueOf(member.toUpperCase()); + blockToGroup.put(type, group.toUpperCase()); + } + } + } + + /** + * Loads block limits from the configuration, resolving direct limits and group limits. + * Direct limits take precedence over group limits. + */ + private void loadBlockLimits() { + directBlockLimits = new EnumMap<>(Material.class); + resolvedBlockLimits = new EnumMap<>(Material.class); + + Map rawLimits = getBlockLimits(); + + // 1️⃣ Direct type limits + for (Material type : Material.values()) { + Integer limit = rawLimits.get(type.name()); + if (limit != null) { + directBlockLimits.put(type, limit); + resolvedBlockLimits.put(type, limit); + } + } + + // 2️⃣ Group limits (only if no direct limit) + for (Map.Entry entry : blockToGroup.entrySet()) { + Material type = entry.getKey(); + String group = entry.getValue(); + + if (resolvedBlockLimits.containsKey(type)) { + continue; // type limit wins + } + + Integer groupLimit = rawLimits.get(group); + if (groupLimit != null) { + resolvedBlockLimits.put(type, groupLimit); + } + } + } + + /** + * Gets the resolved limit for a specific block material. + * The resolved limit considers both direct limits and group limits. + * + * @param type the block material to check + * @return the limit for the block material, or null if no limit is defined + */ + public Integer getResolvedBlockLimit(Material type) { + return resolvedBlockLimits.get(type); + } + + /** + * Checks if a resolved limit exists for a specific block material. + * + * @param type the block material to check + * @return true if a limit exists for the block material, false otherwise + */ + public boolean hasResolvedBlockLimit(Material type) { + return resolvedBlockLimits.containsKey(type); + } + + /** + * Loads entity groups from the configuration. + * Entity groups allow multiple entity types to share a common limit. + */ + private void loadEntityGroups() { + entityToGroup = new EnumMap<>(EntityType.class); + + ConfigurationSection section = config.getConfigurationSection("entities.entity-groups"); + if (section == null) return; + + for (String group : section.getKeys(false)) { + for (String member : section.getStringList(group)) { + EntityType type = EntityType.valueOf(member.toUpperCase()); + entityToGroup.put(type, group.toUpperCase()); + } + } + } + + /** + * Gets the raw entity limits from the configuration. + * + * @return a map of entity names/groups to their limits + */ + private Map getEntityLimits() { + if (this.entityLimits == null) { + this.entityLimits = new HashMap<>(); + + var limitsSection = config.getConfigurationSection("entities.limits"); + if (limitsSection == null) return Collections.emptyMap(); + + this.entityLimits = limitsSection.getKeys(false).stream() + .collect(Collectors.toMap( + key -> key, + limitsSection::getInt + )); + } + + return entityLimits; + } + + /** + * Loads entity limits from the configuration, resolving direct limits and group limits. + * Direct limits take precedence over group limits. + */ + private void loadEntityLimits() { + directEntityLimits = new EnumMap<>(EntityType.class); + resolvedEntityLimits = new EnumMap<>(EntityType.class); + + Map rawLimits = getEntityLimits(); + + // 1️⃣ Direct type limits + for (EntityType type : EntityType.values()) { + Integer limit = rawLimits.get(type.name()); + if (limit != null) { + directEntityLimits.put(type, limit); + resolvedEntityLimits.put(type, limit); + } + } + + // 2️⃣ Group limits (only if no direct limit) + for (Map.Entry entry : entityToGroup.entrySet()) { + EntityType type = entry.getKey(); + String group = entry.getValue(); + + if (resolvedEntityLimits.containsKey(type)) { + continue; // type limit wins + } + + Integer groupLimit = rawLimits.get(group); + if (groupLimit != null) { + resolvedEntityLimits.put(type, groupLimit); + } + } + } + + /** + * Gets the resolved limit for a specific entity type. + * The resolved limit considers both direct limits and group limits. + * + * @param type the entity type to check + * @return the limit for the entity type, or null if no limit is defined + */ + public Integer getResolvedEntityLimit(EntityType type) { + return resolvedEntityLimits.get(type); + } + + /** + * Checks if a resolved limit exists for a specific entity type. + * + * @param type the entity type to check + * @return true if a limit exists for the entity type, false otherwise + */ + public boolean hasResolvedEntityLimit(EntityType type) { + return resolvedEntityLimits.containsKey(type); + } + + /** + * Loads spawn reasons from the configuration. + * If no spawn reasons are configured, defaults to all spawn reasons. + */ + private void loadSpawnReasons() { + List reasonsList = config.getStringList("spawn-reasons"); + + if (reasonsList == null || reasonsList.isEmpty()) { + spawnReasons = getDefaultSpawnReasons(); + } else { + spawnReasons = new HashSet<>(reasonsList); + } + } + + /** + * Loads the world list from configuration and caches it locally. + * If no worlds are configured, defaults to an empty list. + */ + private void loadWorldsList() { + worldsList = Objects.requireNonNullElse( + config.getStringList("worlds.list"), + List.of() + ); + } + + /** + * Gets the removal mode for entities that exceed limits. + * + * @return the removal mode, defaults to "enforce" + * @see RemovalMode + */ + public RemovalMode getRemovalMode() { + var mode = config.getString("entities.removal.mode", "enforce"); + return RemovalMode.fromString(mode); + } + + /** + * Checks if items should be dropped when armor stands are removed. + * + * @return true if armor stand items should be dropped, false otherwise + */ + public boolean shouldDropArmorStandItems() { + return config.getBoolean("entities.removal.armor-stand.drop", false); + } + + /** + * Checks if warnings should be logged when armor stands are removed. + * + * @return true if armor stand removal warnings should be logged, false otherwise + */ + public boolean shouldLogArmorStandWarnings() { + return config.getBoolean("entities.removal.armor-stand.log-warnings", true); + } + + /** + * Checks if named entities should be preserved from removal. + * + * @return true if named entities should be preserved, false otherwise + */ + public boolean shouldPreserveNamedEntities() { + return config.getBoolean("entities.preservation.named-entities", true); + } + + /** + * Checks if raid-related entities should be preserved from removal. + * + * @return true if raid entities should be preserved, false otherwise + */ + public boolean shouldPreserveRaidEntities() { + return config.getBoolean("entities.preservation.raid-entities", true); + } + + /** + * Gets the list of metadata keys that should be ignored when checking entities. + * Entities with any of these metadata keys will not be counted or removed. + * + * @return list of metadata keys to ignore + */ + public List getIgnoreMetadata() { + return Objects.requireNonNullElse( + config.getStringList("entities.ignore.metadata"), + List.of("shopkeeper") + ); + } + + /** + * Gets the list of NBT tags that should be ignored when checking entities. + * Entities with any of these NBT tags will not be counted or removed. + * + * @return list of NBT tags to ignore + */ + public List getIgnoreNbt() { + return Objects.requireNonNullElse( + config.getStringList("entities.ignore.nbt"), + Collections.emptyList() + ); + } + + /** + * Gets the set of spawn reasons that should be monitored. + * + * @return set of spawn reason names + */ + public Set getSpawnReasons() { + return spawnReasons; + } + + /** + * Gets the default set of spawn reasons (all possible spawn reasons). + * + * @return an unmodifiable set of all spawn reason names + */ + private @NotNull Set getDefaultSpawnReasons() { + return Arrays.stream(CreatureSpawnEvent.SpawnReason.values()) + .map(CreatureSpawnEvent.SpawnReason::name).collect(Collectors.toUnmodifiableSet()); + } + + /** + * Gets the raw block limits from the configuration. + * + * @return a map of block names/groups to their limits + */ + private Map getBlockLimits() { + if (blockLimits == null) { + var blocksSection = config.getConfigurationSection("blocks.limits"); + if (blocksSection == null) return Collections.emptyMap(); + + this.blockLimits = blocksSection.getKeys(false).stream() + .collect(Collectors.toMap( + key -> key, + blocksSection::getInt + )); + } + + return blockLimits; + } + + /** + * Gets the worlds mode configuration. + * + * @return "excluded" or "included" depending on the mode + */ + public String getWorldsMode() { + return config.getString("worlds.mode", "excluded"); + } + + /** + * Gets the list of worlds configured for the current mode. + * + * @return list of world names + */ + public List getWorldsList() { + return worldsList; + } + + /** + * Checks if players in a chunk should be notified when entities are removed. + * + * @return true if players should be notified, false otherwise + */ + public boolean shouldNotifyPlayersInChunk() { + return config.getBoolean("notifications.enabled", false); + } + + /** + * Gets the cooldown time (in seconds) between notifications to the same player. + * + * @return the notification cooldown in seconds, defaults to 3 + */ + public int getNotificationCooldownSeconds() { + return config.getInt("notifications.cooldown-seconds", 3); + } + + /** + * Checks if title notifications should be used. + * + * @return true if title notifications are enabled, false otherwise + */ + public boolean shouldUseTitleNotifications() { + return config.getBoolean("notifications.method.title", true); + } + + /** + * Checks if chat message notifications should be used. + * + * @return true if message notifications are enabled, false otherwise + */ + public boolean shouldUseMessageNotifications() { + return config.getBoolean("notifications.method.message", false); + } + + /** + * Gets the message to display when entities are blocked from spawning. + * + * @return the entities blocked message with placeholders {count} and {type} + */ + public String getEntitiesBlockedMessage() { + return config.getString("notifications.messages.entities-blocked", + "&7Blocked {count} {type} from spawning in your chunk."); + } + + /** + * Gets the message to display when entities are removed. + * + * @return the entities removed message with placeholders {count} and {type} + */ + public String getEntitiesRemovedMessage() { + return config.getString("notifications.messages.entities-removed", + "&7Removed {count} {type} in your chunk."); + } + + /** + * Gets the message to display when configuration reload is complete. + * + * @return the reload complete message + */ + public String getReloadCompleteMessage() { + return config.getString("notifications.messages.reload-complete", "&cReloaded csl config."); + } + + /** + * Gets the message to display when a player tries to place more blocks than allowed. + * + * @return the max blocks message with placeholders + */ + public String getMaxBlocksMessage() { + return config.getString("notifications.messages.max-blocks", "&6Cannot place more &4{material}&6. Max amount per chunk &2{amount}."); + } + + /** + * Gets the title to display when a player tries to place more blocks than allowed. + * + * @return the max blocks title with placeholders + */ + public String getMaxBlocksTitle() { + return config.getString("notifications.messages.max-blocks-title", "&6Cannot place more &4{material}&6."); + } + + /** + * Gets the subtitle to display when a player tries to place more blocks than allowed. + * + * @return the max blocks subtitle with placeholders + */ + public String getMaxBlocksSubtitle() { + return config.getString("notifications.messages.max-blocks-subtitle", "&6Max amount per chunk &2{amount}."); + } + + /** + * Checks if a world is disabled based on the current world's mode. + * + * @param worldName the name of the world to check + * @return true if the world is disabled, false if it's enabled + */ + public boolean isWorldDisabled(final String worldName) { + if (getWorldsMode().equalsIgnoreCase("excluded")) { + return getWorldsList().contains(worldName); + } + return !getWorldsList().contains(worldName); + } + + /** + * Checks if players should be killed when they exceed entity limits. + * Warning: This is a dangerous setting and should be used with caution. + * + * @return true if players should be killed, false otherwise + */ + public boolean isKillPlayers() { + return config.getBoolean("entities.removal.kill-players", false); + } +} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/chunk/ChunkCoord.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/chunk/ChunkCoord.java new file mode 100644 index 0000000..fb8548d --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/chunk/ChunkCoord.java @@ -0,0 +1,64 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.chunk; + +import java.lang.ref.WeakReference; +import java.util.UUID; + +import org.bukkit.Bukkit; +import org.bukkit.Chunk; +import org.bukkit.World; +import org.bukkit.Location; +import org.bukkit.entity.Entity; +import org.jetbrains.annotations.Contract; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +public record ChunkCoord(UUID worldUuid, int chunkX, int chunkZ) { + + // Create from World and chunk coordinates + @Contract("_, _, _ -> new") + public static @NotNull ChunkCoord from(@NotNull World world, int chunkX, int chunkZ) { + return new ChunkCoord(world.getUID(), chunkX, chunkZ); + } + // Create from a Chunk object + @Contract("_ -> new") + public static @NotNull ChunkCoord from(@NotNull Chunk chunk) { + return new ChunkCoord(chunk.getWorld().getUID(), chunk.getX(), chunk.getZ()); + } + + // Create from a Location + @Contract("_ -> new") + public static @NotNull ChunkCoord from(@NotNull Location location) { + return from(location.getChunk()); + } + + // Create from an Entity + @Contract("_ -> new") + public static @NotNull ChunkCoord from(@NotNull Entity entity) { + return from(entity.getLocation()); + } + + // Get the World object (may return null if world is not loaded) + public World getWorld() { + return Bukkit.getWorld(worldUuid); + } + + public @Nullable Chunk getChunk() { + World world = getWorld(); + if (world == null || !world.isChunkLoaded(chunkX, chunkZ)) { + return null; + } + return world.getChunkAt(chunkX, chunkZ); + } + + // Check if this chunk is currently loaded + public boolean isLoaded() { + World world = getWorld(); + return world != null && world.isChunkLoaded(chunkX, chunkZ); + } + + @Contract(pure = true) + @Override + public @NotNull String toString() { + return String.format("ChunkCoord{world=%s, x=%d, z=%d}", worldUuid, chunkX, chunkZ); + } +} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/command/AdminCommand.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/command/AdminCommand.java new file mode 100644 index 0000000..e12eb69 --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/command/AdminCommand.java @@ -0,0 +1,155 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.command; + +import com.github.sarhatabaot.chunkspawnerlimiter.ChunkSpawnerLimiter; +import com.github.sarhatabaot.chunkspawnerlimiter.PluginConfig; +import com.github.sarhatabaot.chunkspawnerlimiter.removal.Checks; +import com.github.sarhatabaot.chunkspawnerlimiter.removal.ExternalChecks; +import com.github.sarhatabaot.chunkspawnerlimiter.removal.RemovalTaskManager; +import com.github.sarhatabaot.chunkspawnerlimiter.removal.modes.RemovalMode; +import me.despical.commandframework.CommandArguments; +import me.despical.commandframework.annotations.Command; +import me.despical.commandframework.annotations.Completer; +import org.bukkit.Material; +import org.bukkit.command.CommandSender; +import org.bukkit.entity.EntityType; +import org.jetbrains.annotations.NotNull; + +import java.util.Arrays; +import java.util.List; +import java.util.stream.Collectors; + +public class AdminCommand { + + + private final ChunkSpawnerLimiter plugin; + private final RemovalTaskManager removalTaskManager; + private final PluginConfig pluginConfig; + + public AdminCommand(ChunkSpawnerLimiter plugin, RemovalTaskManager removalTaskManager, PluginConfig pluginConfig) { + this.plugin = plugin; + this.removalTaskManager = removalTaskManager; + this.pluginConfig = pluginConfig; + } + + @Command( + name = "csl", + aliases = {"csl.help", "csl.version"}, + permission = "csl" + ) + public void onHelp(@NotNull CommandArguments arguments) { + int page = arguments.getArgumentAsInt(0); + + showHelpPage(arguments.getSender(), page); + } + + private void showHelpPage(CommandSender sender, int page) { + List helpPages = List.of( + // Page 1 - Basic Commands + """ + &6&lChunkSpawnerLimiter v%s Help &7(Page 1/2) + &e/csl chunk info &7- Show chunk spawner info + &7View current chunk's spawner counts + &e/csl help [page] &7- Show help menu + """.formatted(plugin.getDescription().getVersion()), + """ + &6&lChunkSpawnerLimiter Help &7(Page 2/2) + &6Admin Commands: + &e/csl version &7- Show plugin version + &e/csl reload &7- Reload configuration + &e/csl search entities &7- List entity types + &e/csl search blocks &7- List block materials + """ + ); + + int maxPage = helpPages.size(); + if (page < 1 || page > maxPage) { + page = 1; + } + + String pageContent = helpPages.get(page - 1); + for (String line : pageContent.split("\n")) { + sender.sendMessage(org.bukkit.ChatColor.translateAlternateColorCodes('&', line)); + } + + sender.sendMessage(org.bukkit.ChatColor.GRAY + + "Use /csl help " + (page % maxPage + 1) + " for next page"); + } + + @Command( + name = "csl.reload", + permission = "csl.reload" + ) + public void onReload(@NotNull CommandArguments arguments) { + this.plugin.onReload(); + + RemovalMode.reload(removalTaskManager); + Checks.setup(pluginConfig); + ExternalChecks.setup(pluginConfig); + + arguments.getSender().sendMessage("Reloaded config and updated all systems."); + } + + /* +TODO +5.0.0 RC3 +Show specific chunk info counters. Either in a clickable list format or something like that. +Optionally users should be able to view this, so they know when to stop placing? +Mention that the user can see all the entity amounts using /spark profiler +/csl chunk - shows all options - can click on a chunk to show info +/csl chunk info - show current chunk info +/csl chunk info - shows a specific chunk +*/ + @Command( + name = "csl.chunk.info" + ) + public void onChunkInfo(CommandArguments commandArguments) { + commandArguments.getSender().sendMessage("Not implemented yet."); + } + + private static final List ENTITY_NAMES = + Arrays.stream(EntityType.values()).map(Enum::name).toList(); + + private static final List MATERIAL_NAMES = + Arrays.stream(Material.values()) + .filter(m -> m != Material.AIR) + .map(Enum::name) + .toList(); + + @Command( + name = "csl.search.entities" + ) + public void onSearchEntities(@NotNull CommandArguments arguments) { + arguments.getSender().sendMessage(Arrays.stream(EntityType.values()) + .map(Enum::name) + .collect(Collectors.joining(", "))); + } + + @Completer( + name = "csl.search.entities" + ) + public List onSearchEntitiesCompletion() { + return ENTITY_NAMES; + } + + @Command( + name = "csl.search.blocks" + ) + public void onSearchBlocks(@NotNull CommandArguments arguments) { + arguments.getSender().sendMessage(Arrays.stream(Material.values()) + .filter(material -> material != Material.AIR) + .map(Enum::name) + .collect(Collectors.joining(", "))); + } + + @Completer( + name = "csl.search.blocks" + ) + public List onSearchBlocksCompletion() { + return MATERIAL_NAMES; + } + + + + + +} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/counter/CounterData.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/counter/CounterData.java new file mode 100644 index 0000000..80ebe2a --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/counter/CounterData.java @@ -0,0 +1,194 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.counter; + +import org.bukkit.Material; +import org.bukkit.entity.EntityType; + +import javax.annotation.concurrent.ThreadSafe; +import java.util.Collections; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.atomic.AtomicInteger; + +/** + * Stores and manages block and entity counts for a chunk. + *

+ * This class is thread-safe and designed to be used in concurrent environments + * such as asynchronous chunk scanning or entity tracking. + *

+ * Counts are never allowed to become negative. Decrements are clamped at zero. + */ +@ThreadSafe +public class CounterData { + + /** + * Map holding counts for tracked block types. + */ + private final Map blockCounts = new ConcurrentHashMap<>(); + + /** + * Map holding counts for tracked entity types. + */ + private final Map entityCounts = new ConcurrentHashMap<>(); + + // --------------------------------------------------------------------- + // Internal helpers + // --------------------------------------------------------------------- + + /** + * Safely increments the counter associated with the given key. + *

+ * If the key does not yet exist, it will be initialized with a count of {@code 0} + * before being incremented. + * + * @param map the map containing counters + * @param key the key whose counter should be incremented + */ + private static void safeIncrement(Map map, K key) { + map.computeIfAbsent(key, k -> new AtomicInteger(0)).incrementAndGet(); + } + + /** + * Safely decrements the counter associated with the given key. + *

+ * If the counter reaches zero, it will not go below zero. + * If the key does not exist, this method does nothing. + * + * @param map the map containing counters + * @param key the key whose counter should be decremented + */ + private static void safeDecrement(Map map, K key) { + AtomicInteger count = map.get(key); + if (count != null) { + count.updateAndGet(c -> Math.max(0, c - 1)); + } + } + + /** + * Sets the counter value for the given key. + * + * @param map the map containing counters + * @param key the key whose counter should be set + * @param value the new counter value (must be {@code >= 0}) + * + * @throws IllegalArgumentException if {@code value} is negative + */ + private static void safeSet(Map map, K key, int value) { + if (value < 0) { + throw new IllegalArgumentException("Count cannot be negative"); + } + map.put(key, new AtomicInteger(value)); + } + + // --------------------------------------------------------------------- + // Blocks + // --------------------------------------------------------------------- + + /** + * Increments the count for the given block type. + * + * @param type the block type to increment + */ + public void incrementBlock(Material type) { + safeIncrement(blockCounts, type); + } + + /** + * Decrements the count for the given block type. + *

+ * The count will not go below zero. + * + * @param type the block type to decrement + */ + public void decrementBlock(Material type) { + safeDecrement(blockCounts, type); + } + + /** + * Sets the count for the given block type. + * + * @param type the block type + * @param count the new count (must be {@code >= 0}) + * + * @throws IllegalArgumentException if {@code count} is negative + */ + public void setBlockCount(Material type, int count) { + safeSet(blockCounts, type, count); + } + + /** + * Returns the current count for the given block type. + * + * @param type the block type + * @return the current count, or {@code 0} if the block type is not tracked + */ + public int getBlockCount(Material type) { + AtomicInteger count = blockCounts.get(type); + return count != null ? count.get() : 0; + } + + /** + * Returns an unmodifiable view of all tracked block types. + * + * @return a set of tracked block types + */ + public Set getTrackedBlockTypes() { + return Collections.unmodifiableSet(blockCounts.keySet()); + } + + // --------------------------------------------------------------------- + // Entities + // --------------------------------------------------------------------- + + /** + * Increments the count for the given entity type. + * + * @param type the entity type to increment + */ + public void incrementEntity(EntityType type) { + safeIncrement(entityCounts, type); + } + + /** + * Decrements the count for the given entity type. + *

+ * The count will not go below zero. + * + * @param type the entity type to decrement + */ + public void decrementEntity(EntityType type) { + safeDecrement(entityCounts, type); + } + + /** + * Sets the count for the given entity type. + * + * @param type the entity type + * @param count the new count (must be {@code >= 0}) + * + * @throws IllegalArgumentException if {@code count} is negative + */ + public void setEntityCount(EntityType type, int count) { + safeSet(entityCounts, type, count); + } + + /** + * Returns the current count for the given entity type. + * + * @param type the entity type + * @return the current count, or {@code 0} if the entity type is not tracked + */ + public int getEntityCount(EntityType type) { + AtomicInteger count = entityCounts.get(type); + return count != null ? count.get() : 0; + } + + /** + * Returns an unmodifiable view of all tracked entity types. + * + * @return a set of tracked entity types + */ + public Set getTrackedEntityTypes() { + return Collections.unmodifiableSet(entityCounts.keySet()); + } +} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/counter/CounterDataManager.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/counter/CounterDataManager.java new file mode 100644 index 0000000..01cf385 --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/counter/CounterDataManager.java @@ -0,0 +1,20 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.counter; + +import com.github.sarhatabaot.chunkspawnerlimiter.chunk.ChunkCoord; + +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; + +public class CounterDataManager { + private final Map loadedChunkCounters = new ConcurrentHashMap<>(); + + public CounterData getCounterData(final ChunkCoord chunkCoord) { + return loadedChunkCounters.computeIfAbsent(chunkCoord, k -> new CounterData()); + } + + public void removeCounterData(final ChunkCoord chunkCoord) { + loadedChunkCounters.remove(chunkCoord); + } + + +} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/listener/ChunkListener.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/listener/ChunkListener.java new file mode 100644 index 0000000..cf705c8 --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/listener/ChunkListener.java @@ -0,0 +1,80 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.listener; + +import com.github.sarhatabaot.chunkspawnerlimiter.CSLLogger; +import com.github.sarhatabaot.chunkspawnerlimiter.PluginConfig; +import com.github.sarhatabaot.chunkspawnerlimiter.chunk.ChunkCoord; +import com.github.sarhatabaot.chunkspawnerlimiter.counter.CounterDataManager; +import com.github.sarhatabaot.chunkspawnerlimiter.reflection.scanner.BlockScanner; +import com.github.sarhatabaot.chunkspawnerlimiter.reflection.scanner.BlockScannerFactory; +import com.github.sarhatabaot.chunkspawnerlimiter.removal.Checks; +import com.github.sarhatabaot.chunkspawnerlimiter.removal.RemovalTaskManager; +import com.github.sarhatabaot.chunkspawnerlimiter.removal.modes.RemovalMode; +import org.bukkit.Chunk; +import org.bukkit.entity.*; +import org.bukkit.event.EventHandler; +import org.bukkit.event.Listener; +import org.bukkit.event.world.ChunkLoadEvent; +import org.bukkit.event.world.ChunkUnloadEvent; +import org.bukkit.plugin.Plugin; +import org.jetbrains.annotations.NotNull; + + +public class ChunkListener implements Listener { + private final PluginConfig pluginConfig; + private final CounterDataManager counterDataManager; + private final RemovalTaskManager removalTaskManager; + private final BlockScanner blockScanner; + + public ChunkListener(Plugin plugin, PluginConfig pluginConfig, CounterDataManager counterDataManager, RemovalTaskManager removalTaskManager) { + this.pluginConfig = pluginConfig; + this.counterDataManager = counterDataManager; + this.removalTaskManager = removalTaskManager; + this.blockScanner = BlockScannerFactory.create(plugin, pluginConfig, counterDataManager); + } + + @EventHandler + public void onChunkLoad(@NotNull ChunkLoadEvent event) { + if (pluginConfig.isWorldDisabled(event.getWorld().getName())) { + return; + } + + final Chunk chunk = event.getChunk(); + final ChunkCoord chunkCoord = ChunkCoord.from(chunk); + + addEntityLimits(chunk, chunkCoord); + + // Scan blocks asynchronously on chunk load + blockScanner.scanChunk(chunk, chunkCoord, true); + + RemovalMode removalMode = pluginConfig.getRemovalMode(); + removalTaskManager.queueChunkCheck(chunkCoord, removalMode.getEntityRemovalAction()); + + if (pluginConfig.isActiveInspections()) { + removalTaskManager.scheduleRecheck(chunkCoord, removalMode.getEntityRemovalAction(), pluginConfig.getInspectionFrequency()); + } + } + + @EventHandler + public void onChunkUnload(@NotNull ChunkUnloadEvent event) { + if (pluginConfig.isWorldDisabled(event.getWorld().getName())) { + return; + } + + final ChunkCoord chunkCoord = ChunkCoord.from(event.getChunk()); + counterDataManager.removeCounterData(chunkCoord); + removalTaskManager.removeChunkRecheck(chunkCoord); + } + + private void addEntityLimits(final @NotNull Chunk chunk, final ChunkCoord chunkCoord) { + final Entity[] entities = chunk.getEntities(); + for (Entity entity: entities) { + if (Checks.shouldSkipPlayers(entity)) { + continue; + } + + if (pluginConfig.hasResolvedEntityLimit(entity.getType())) { + counterDataManager.getCounterData(chunkCoord).incrementEntity(entity.getType()); + } + } + } +} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/listener/EventListener.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/listener/EventListener.java new file mode 100644 index 0000000..3ab373d --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/listener/EventListener.java @@ -0,0 +1,214 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.listener; + + +import com.github.sarhatabaot.chunkspawnerlimiter.CSLLogger; +import com.github.sarhatabaot.chunkspawnerlimiter.PluginConfig; +import com.github.sarhatabaot.chunkspawnerlimiter.chunk.ChunkCoord; +import com.github.sarhatabaot.chunkspawnerlimiter.counter.CounterData; +import com.github.sarhatabaot.chunkspawnerlimiter.counter.CounterDataManager; +import com.github.sarhatabaot.chunkspawnerlimiter.notification.NotificationService; +import com.github.sarhatabaot.chunkspawnerlimiter.removal.Checks; +import com.github.sarhatabaot.chunkspawnerlimiter.removal.modes.RemovalMode; +import com.github.sarhatabaot.chunkspawnerlimiter.util.SpawnEggUtil; +import org.bukkit.Chunk; +import org.bukkit.Material; +import org.bukkit.entity.Entity; +import org.bukkit.entity.EntityType; +import org.bukkit.event.EventHandler; +import org.bukkit.event.Listener; +import org.bukkit.event.block.BlockBreakEvent; +import org.bukkit.event.block.BlockPlaceEvent; +import org.bukkit.event.entity.CreatureSpawnEvent; +import org.bukkit.event.entity.EntityDeathEvent; +import org.bukkit.event.entity.EntitySpawnEvent; +import org.bukkit.event.vehicle.VehicleCreateEvent; +import org.bukkit.event.vehicle.VehicleDestroyEvent; +import org.jetbrains.annotations.NotNull; + + +public class EventListener implements Listener { + private final PluginConfig pluginConfig; + private final CounterDataManager counterDataManager; + private final NotificationService notificationService; + + public EventListener(PluginConfig pluginConfig, CounterDataManager counterDataManager, NotificationService notificationService) { + this.pluginConfig = pluginConfig; + this.counterDataManager = counterDataManager; + this.notificationService = notificationService; + } + + @EventHandler + public void onBlockPlace(@NotNull BlockPlaceEvent event) { + if (pluginConfig.isWorldDisabled(event.getBlock().getWorld().getName())) { + CSLLogger.debug(() -> "%s world is disabled.".formatted(event.getBlock().getWorld().getName())); + return; + } + + final Material material = event.getBlock().getType(); + if (!pluginConfig.hasResolvedBlockLimit(material)) { + CSLLogger.debug(() -> "%s block not in block limits.".formatted(material.name())); + return; + } + + + final ChunkCoord chunkCoord = ChunkCoord.from(event.getBlock().getLocation()); + final CounterData counterData = counterDataManager.getCounterData(chunkCoord); + + if (Checks.isUnderOrEqualToLimit(counterData.getBlockCount(material), pluginConfig.getResolvedBlockLimit(material))) { + CSLLogger.debug(() -> "%s block under block limits (%d/%d)".formatted(material.name(), counterData.getBlockCount(material), pluginConfig.getResolvedBlockLimit(material))); + counterData.incrementBlock(material); + return; + } + + // Notify player about block limit + notificationService.notifyBlockLimitReached( + event.getPlayer(), + material, + pluginConfig.getResolvedBlockLimit(material) + ); + + RemovalMode removalMode = pluginConfig.getRemovalMode(); + removalMode.handleBlock(event.getBlock(), event); + } + + @EventHandler + public void onBlockBreak(@NotNull BlockBreakEvent event) { + if (pluginConfig.isWorldDisabled(event.getBlock().getWorld().getName())) { + return; + } + + final ChunkCoord chunkCoord = ChunkCoord.from(event.getBlock().getLocation()); + counterDataManager.getCounterData(chunkCoord).decrementBlock(event.getBlock().getType()); + } + + @EventHandler + public void onEntitySpawn(@NotNull EntitySpawnEvent event) { + if (pluginConfig.isWorldDisabled(event.getLocation().getWorld().getName())) { + CSLLogger.debug(() -> "%s world is disabled.".formatted(event.getLocation().getWorld().getName())); + return; + } + + // Check spawn reason if this is a CreatureSpawnEvent + if (event instanceof CreatureSpawnEvent creatureSpawnEvent) { + String spawnReason = creatureSpawnEvent.getSpawnReason().name(); + if (!pluginConfig.getSpawnReasons().contains(spawnReason)) { + CSLLogger.debug(() -> "%s entity spawn ignored due to spawn reason: %s".formatted(event.getEntity().getType().name(), spawnReason)); + return; + } + } + + final Entity entity = event.getEntity(); + final EntityType entityType = entity.getType(); + if (!pluginConfig.hasResolvedEntityLimit(entityType)) { + CSLLogger.debug(() -> "%s entity not in entity limits.".formatted(entityType.name())); + return; + } + + if (Checks.shouldSkipPlayers(entity)) { + return; + } + + final Chunk chunk = entity.getLocation().getChunk(); + if (!chunk.isLoaded()) { + CSLLogger.debug(() -> "Chunk not loaded for entity spawn: %s".formatted(entityType.name())); + return; + } + + final ChunkCoord chunkCoord = ChunkCoord.from(chunk); + final CounterData counterData = counterDataManager.getCounterData(chunkCoord); + + // Check both entity type and entity group limits + final Integer entityTypeLimit = pluginConfig.getResolvedEntityLimit(entityType); + + // Check entity type limit + boolean withinTypeLimit = entityTypeLimit == null || + Checks.isUnderOrEqualToLimit(counterData.getEntityCount(entityType), entityTypeLimit); + + if (withinTypeLimit) { + CSLLogger.debug(() -> "%s entity under entity limits (type: %d/%s)".formatted( + entityType.name(), + counterData.getEntityCount(entityType), + entityTypeLimit != null ? String.valueOf(entityTypeLimit) : "unlimited" + )); + + counterData.incrementEntity(entityType); + return; + } + + // Notify players in chunk about blocked entity + notificationService.notifyEntitiesBlocked(chunk, entityType, 1); + + RemovalMode removalMode = pluginConfig.getRemovalMode(); + removalMode.handleEntity(entity, event); + + if (event.isCancelled() && event instanceof CreatureSpawnEvent creatureSpawnEvent) { + if (SpawnEggUtil.isSpawnEggSpawn(creatureSpawnEvent.getSpawnReason().name())) { + SpawnEggUtil.dropSpawnEgg(entity.getType(), event.getLocation()); + } + } + } + + @EventHandler + public void onEntityDeath(@NotNull EntityDeathEvent event) { //just to decrease counters for tracking. + if (pluginConfig.isWorldDisabled(event.getEntity().getWorld().getName())) { + return; + } + + final Entity entity = event.getEntity(); + final ChunkCoord chunkCoord = ChunkCoord.from(entity.getLocation()); + final CounterData counterData = counterDataManager.getCounterData(chunkCoord); + + counterData.decrementEntity(entity.getType()); + } + + + @EventHandler + public void onVehicleCreate(@NotNull VehicleCreateEvent event) { + if (pluginConfig.isWorldDisabled(event.getVehicle().getWorld().getName())) { + return; + } + + final Entity vehicle = event.getVehicle(); + final EntityType vehicleType = vehicle.getType(); + if (!pluginConfig.hasResolvedEntityLimit(vehicleType)) { + return; + } + + final Chunk chunk = vehicle.getLocation().getChunk(); + if (!chunk.isLoaded()) { + return; + } + + + final ChunkCoord chunkCoord = ChunkCoord.from(chunk); + final CounterData counterData = counterDataManager.getCounterData(chunkCoord); + + // Check both entity type and entity group limits + final Integer vehicleTypeLimit = pluginConfig.getResolvedEntityLimit(vehicleType); + boolean withinTypeLimit = vehicleTypeLimit == null || + Checks.isUnderOrEqualToLimit(counterData.getEntityCount(vehicleType), vehicleTypeLimit); + + if (withinTypeLimit) { + counterData.incrementEntity(vehicleType); + return; + } + + RemovalMode removalMode = pluginConfig.getRemovalMode(); + removalMode.handleEntity(vehicle, null); + } + + @EventHandler + public void onVehicleDestroy(@NotNull VehicleDestroyEvent event) { + if (pluginConfig.isWorldDisabled(event.getVehicle().getWorld().getName())) { + return; + } + + final Entity vehicle = event.getVehicle(); + final ChunkCoord chunkCoord = ChunkCoord.from(vehicle.getLocation()); + final CounterData counterData = counterDataManager.getCounterData(chunkCoord); + + counterData.decrementEntity(vehicle.getType()); + } + + +} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/notification/NotificationService.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/notification/NotificationService.java new file mode 100644 index 0000000..f8f6fd5 --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/notification/NotificationService.java @@ -0,0 +1,139 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.notification; + +import com.github.sarhatabaot.chunkspawnerlimiter.PluginConfig; +import org.bukkit.ChatColor; +import org.bukkit.Chunk; +import org.bukkit.Material; +import org.bukkit.entity.Entity; +import org.bukkit.entity.EntityType; +import org.bukkit.entity.Player; +import org.bukkit.plugin.Plugin; + +import java.util.Map; +import java.util.UUID; +import java.util.concurrent.ConcurrentHashMap; + +/** + * Handles player notifications for entity and block limit events. + * Includes throttling to prevent spam. + */ +public class NotificationService { + private final PluginConfig config; + + // Throttling: track last notification time per player + private final Map lastNotificationTime = new ConcurrentHashMap<>(); + + public NotificationService(PluginConfig config) { + this.config = config; + } + + /** + * Notify players in a chunk that entities were blocked from spawning + */ + public void notifyEntitiesBlocked(Chunk chunk, EntityType type, int count) { + if (!config.shouldNotifyPlayersInChunk()) return; + + String message = config.getEntitiesBlockedMessage() + .replace("{count}", String.valueOf(count)) + .replace("{type}", type.name()); + + notifyPlayersInChunk(chunk, message); + } + + /** + * Notify players in a chunk that entities were removed + */ + public void notifyEntitiesRemoved(Chunk chunk, EntityType type, int count) { + if (!config.shouldNotifyPlayersInChunk()) return; + + String message = config.getEntitiesRemovedMessage() + .replace("{count}", String.valueOf(count)) + .replace("{type}", type.name()); + + notifyPlayersInChunk(chunk, message); + } + + /** + * Notify a specific player that they've reached a block limit + */ + public void notifyBlockLimitReached(Player player, Material material, int limit) { + if (!shouldNotifyPlayer(player)) return; + + if (config.shouldUseTitleNotifications()) { + String title = config.getMaxBlocksTitle() + .replace("{material}", material.name()) + .replace("{amount}", String.valueOf(limit)); + String subtitle = config.getMaxBlocksSubtitle() + .replace("{material}", material.name()) + .replace("{amount}", String.valueOf(limit)); + + player.sendTitle( + ChatColor.translateAlternateColorCodes('&', title), + ChatColor.translateAlternateColorCodes('&', subtitle) + ); + } + + if (config.shouldUseMessageNotifications()) { + String message = config.getMaxBlocksMessage() + .replace("{material}", material.name()) + .replace("{amount}", String.valueOf(limit)); + player.sendMessage(ChatColor.translateAlternateColorCodes('&', message)); + } + + updateLastNotification(player); + } + + /** + * Send a notification message to all players in a chunk + */ + private void notifyPlayersInChunk(Chunk chunk, String message) { + for (Entity entity : chunk.getEntities()) { + if (entity instanceof Player player) { + if (shouldNotifyPlayer(player)) { + sendNotification(player, message); + updateLastNotification(player); + } + } + } + } + + /** + * Send a notification to a player using configured method(s) + */ + private void sendNotification(Player player, String message) { + String colored = ChatColor.translateAlternateColorCodes('&', message); + + if (config.shouldUseTitleNotifications()) { + player.sendTitle("", colored); + } + + if (config.shouldUseMessageNotifications()) { + player.sendMessage(colored); + } + } + + /** + * Check if enough time has passed since last notification to this player + */ + private boolean shouldNotifyPlayer(Player player) { + Long lastTime = lastNotificationTime.get(player.getUniqueId()); + if (lastTime == null) return true; + + long cooldownMs = config.getNotificationCooldownSeconds() * 1000L; + return System.currentTimeMillis() - lastTime > cooldownMs; + } + + /** + * Update the last notification time for a player + */ + private void updateLastNotification(Player player) { + lastNotificationTime.put(player.getUniqueId(), System.currentTimeMillis()); + } + + /** + * Clean up notification tracking for a player (e.g., on logout) + */ + public void cleanup(Player player) { + lastNotificationTime.remove(player.getUniqueId()); + } +} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/RaidReflection.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/RaidReflection.java new file mode 100644 index 0000000..0b7ebca --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/RaidReflection.java @@ -0,0 +1,83 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.reflection; + +import java.lang.reflect.Method; +import java.util.Collection; + +public final class RaidReflection { + + private static final boolean SUPPORTED; + private static final Class RAIDER_CLASS; + private static final Class RAID_CLASS; + private static final Method GET_WORLD; + private static final Method GET_RAIDS; + private static final Method GET_RAIDERS; + + static { + Class raider = null; + Class raid = null; + Method getWorld = null; + Method getRaids = null; + Method getRaiders = null; + boolean supported; + + try { + // Try to load classes (only available in 1.14+) + raider = Class.forName("org.bukkit.entity.Raider"); + raid = Class.forName("org.bukkit.Raid"); + + // Cache methods + getWorld = raider.getMethod("getWorld"); + getRaids = raider.getMethod("getWorld").getReturnType().getMethod("getRaids"); + getRaiders = raid.getMethod("getRaiders"); + + supported = true; + } catch (ClassNotFoundException | NoSuchMethodException e) { + // Older server version — feature not available + supported = false; + } + + RAIDER_CLASS = raider; + RAID_CLASS = raid; + GET_WORLD = getWorld; + GET_RAIDS = getRaids; + GET_RAIDERS = getRaiders; + SUPPORTED = supported; + } + + private RaidReflection() {} + + /** + * @return true if this server version supports raids. + */ + public static boolean isSupported() { + return SUPPORTED; + } + + /** + * Checks if a given entity is part of an active raid. + */ + public static boolean isEntityInRaid(Object entity) { + if (!SUPPORTED || entity == null || !RAIDER_CLASS.isInstance(entity)) { + return false; + } + + try { + Object world = GET_WORLD.invoke(entity); + @SuppressWarnings("unchecked") + Collection raids = (Collection) GET_RAIDS.invoke(world); + + for (Object raid : raids) { + @SuppressWarnings("unchecked") + Collection raiders = (Collection) GET_RAIDERS.invoke(raid); + if (raiders.contains(entity)) { + return true; + } + } + } catch (ReflectiveOperationException e) { + e.printStackTrace(); + } + + return false; + } +} + diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/WorldReflection.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/WorldReflection.java new file mode 100644 index 0000000..0284dd2 --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/WorldReflection.java @@ -0,0 +1,53 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.reflection; +import org.bukkit.World; +import java.lang.reflect.Method; + +public final class WorldReflection { + + private static final boolean SUPPORTED; + private static final Method GET_MIN_HEIGHT; + + static { + Method getMinHeight = null; + boolean supported; + + try { + // Try to find the method (MC 1.18+) + getMinHeight = World.class.getMethod("getMinHeight"); + supported = true; + } catch (NoSuchMethodException e) { + // Older version (like 1.8.8) — method doesn't exist + supported = false; + } + + GET_MIN_HEIGHT = getMinHeight; + SUPPORTED = supported; + } + + private WorldReflection() {} + + /** + * @return true if this server version supports getMinHeight(). + */ + public static boolean isSupported() { + return SUPPORTED; + } + + /** + * Returns the world's minimum height safely across all versions. + */ + public static int getWorldMinHeightSafe(World world) { + if (!SUPPORTED) { + // Old versions (pre-1.18) start at Y = 0 + return 0; + } + + try { + return (int) GET_MIN_HEIGHT.invoke(world); + } catch (ReflectiveOperationException e) { + // Fallback if reflection fails for any reason + e.printStackTrace(); + return 0; + } + } +} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/scanner/AbstractBlockScanner.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/scanner/AbstractBlockScanner.java new file mode 100644 index 0000000..d49204f --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/scanner/AbstractBlockScanner.java @@ -0,0 +1,107 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.reflection.scanner; + +import com.github.sarhatabaot.chunkspawnerlimiter.CSLLogger; +import com.github.sarhatabaot.chunkspawnerlimiter.PluginConfig; +import com.github.sarhatabaot.chunkspawnerlimiter.chunk.ChunkCoord; +import com.github.sarhatabaot.chunkspawnerlimiter.counter.CounterDataManager; +import com.github.sarhatabaot.chunkspawnerlimiter.reflection.WorldReflection; +import org.bukkit.Bukkit; +import org.bukkit.Chunk; +import org.bukkit.Material; +import org.bukkit.World; +import org.bukkit.plugin.Plugin; +import org.jetbrains.annotations.Nullable; + +/** + * Abstract base class for block scanners providing common scanning logic. + * Subclasses implement the version-specific material retrieval. + */ +public abstract class AbstractBlockScanner implements BlockScanner { + protected static final int CHUNK_SIZE = 16; + + protected final Plugin plugin; + protected final PluginConfig config; + protected final CounterDataManager counterManager; + + protected AbstractBlockScanner(Plugin plugin, PluginConfig config, CounterDataManager counterManager) { + this.plugin = plugin; + this.config = config; + this.counterManager = counterManager; + } + + /** + * Template method for getting material at coordinates. + * Subclasses implement the specific retrieval mechanism. + */ + protected abstract Material getMaterialAtImpl(World world, int x, int y, int z); + + @Override + @Nullable + public final Material getMaterialAt(World world, int x, int y, int z) { + try { + return getMaterialAtImpl(world, x, y, z); + } catch (Exception e) { + CSLLogger.debug(() -> "[" + getImplementationName() + "] Error getting material at " + + x + "," + y + "," + z + ": " + e.getMessage()); + return null; + } + } + + @Override + public final void scanChunk(Chunk chunk, ChunkCoord coord, boolean async) { + if (async) { + Bukkit.getScheduler().runTaskAsynchronously(plugin, () -> scanChunkSync(chunk, coord)); + } else { + scanChunkSync(chunk, coord); + } + } + + /** + * Perform the actual chunk scan synchronously. + * Only scans blocks that have configured limits to optimize performance. + */ + protected void scanChunkSync(Chunk chunk, ChunkCoord coord) { + final World world = chunk.getWorld(); + final int startX = chunk.getX() << 4; + final int startZ = chunk.getZ() << 4; + + // Get safe Y bounds + final int minY = WorldReflection.getWorldMinHeightSafe(world); + final int maxY = world.getMaxHeight(); + + CSLLogger.debug(() -> "[" + getImplementationName() + "] Scanning chunk " + coord + + " (Y: " + minY + " to " + maxY + ")"); + + int blocksScanned = 0; + int blocksFound = 0; + + for (int x = 0; x < CHUNK_SIZE; x++) { + for (int z = 0; z < CHUNK_SIZE; z++) { + for (int y = minY; y < maxY; y++) { + blocksScanned++; + + Material material = getMaterialAt(world, startX + x, y, startZ + z); + + // Skip if we couldn't get the material or it's not configured + if (material == null || !config.hasResolvedBlockLimit(material)) { + continue; + } + + // Increment counter for this material + counterManager.getCounterData(coord).incrementBlock(material); + blocksFound++; + } + } + } + + final int finalBlocks = blocksFound; + final int finalScanned = blocksScanned; + CSLLogger.debug(() -> "[" + getImplementationName() + "] Chunk scan complete: " + + finalBlocks + " tracked blocks found (scanned " + finalScanned + " total)"); + } + + @Override + public String toString() { + return getImplementationName() + " (supported: " + isSupported() + ")"; + } +} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/scanner/BlockScanner.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/scanner/BlockScanner.java new file mode 100644 index 0000000..76c078f --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/scanner/BlockScanner.java @@ -0,0 +1,48 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.reflection.scanner; + +import com.github.sarhatabaot.chunkspawnerlimiter.chunk.ChunkCoord; +import org.bukkit.Chunk; +import org.bukkit.Material; +import org.bukkit.World; +import org.jetbrains.annotations.Nullable; + +/** + * Interface for scanning chunks and retrieving block materials. + * Implementations may use NMS, reflection, or pure Bukkit API. + */ +public interface BlockScanner { + + /** + * Get the material of a block at specific coordinates. + * + * @param world the world containing the block + * @param x the x coordinate + * @param y the y coordinate + * @param z the z coordinate + * @return the material at the coordinates, or null if unable to determine + */ + @Nullable Material getMaterialAt(World world, int x, int y, int z); + + /** + * Scan an entire chunk and update block counters. + * + * @param chunk the chunk to scan + * @param coord the chunk coordinates + * @param async whether to perform the scan asynchronously + */ + void scanChunk(Chunk chunk, ChunkCoord coord, boolean async); + + /** + * Check if this scanner implementation is supported on the current server. + * + * @return true if this scanner can be used, false otherwise + */ + boolean isSupported(); + + /** + * Get the name of this scanner implementation for logging purposes. + * + * @return the scanner implementation name (e.g., "ModernNMS", "Bukkit", etc.) + */ + String getImplementationName(); +} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/scanner/BlockScannerFactory.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/scanner/BlockScannerFactory.java new file mode 100644 index 0000000..fa22ca7 --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/scanner/BlockScannerFactory.java @@ -0,0 +1,111 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.reflection.scanner; + +import com.github.sarhatabaot.chunkspawnerlimiter.PluginConfig; +import com.github.sarhatabaot.chunkspawnerlimiter.counter.CounterDataManager; +import com.github.sarhatabaot.chunkspawnerlimiter.reflection.scanner.impl.BukkitBlockScanner; +import com.github.sarhatabaot.chunkspawnerlimiter.reflection.scanner.impl.LegacyNmsScanner; +import com.github.sarhatabaot.chunkspawnerlimiter.reflection.scanner.impl.ModernNmsScanner; +import com.github.sarhatabaot.chunkspawnerlimiter.reflection.scanner.impl.SpigotNmsScanner; +import com.github.sarhatabaot.chunkspawnerlimiter.reflection.scanner.util.MinecraftVersion; +import org.bukkit.Bukkit; +import org.bukkit.plugin.Plugin; + +import java.util.logging.Level; + +/** + * Factory for creating the appropriate BlockScanner implementation based on the server version. + * Attempts version-specific NMS scanners before falling back to the universal Bukkit scanner. + */ +public class BlockScannerFactory { + + /** + * Create a BlockScanner instance optimized for the current server version. + * + * @param plugin the plugin instance + * @param config the plugin configuration + * @param counterManager the counter data manager + * @return the best available BlockScanner implementation + */ + public static BlockScanner create(Plugin plugin, PluginConfig config, CounterDataManager counterManager) { + MinecraftVersion version = MinecraftVersion.detect(); + + Bukkit.getLogger().log(Level.INFO, "[BlockScannerFactory] Detected Minecraft version: " + version); + + // Try version-specific scanners in order of preference + + // 1. Modern NMS (1.17+) + if (version.isModern()) { + BlockScanner scanner = new ModernNmsScanner(plugin, config, counterManager); + if (scanner.isSupported()) { + Bukkit.getLogger().log(Level.INFO, "[BlockScannerFactory] Using " + scanner.getImplementationName()); + return scanner; + } + Bukkit.getLogger().log(Level.WARNING, "[BlockScannerFactory] ModernNMS not supported, trying alternatives..."); + } + + // 2. Spigot NMS (1.13-1.16) + if (version.isSpigot()) { + BlockScanner scanner = new SpigotNmsScanner(plugin, config, counterManager); + if (scanner.isSupported()) { + Bukkit.getLogger().log(Level.INFO, "[BlockScannerFactory] Using " + scanner.getImplementationName()); + return scanner; + } + Bukkit.getLogger().log(Level.WARNING, "[BlockScannerFactory] SpigotNMS not supported, trying alternatives..."); + } + + // 3. Legacy NMS (1.8.8-1.12) + if (version.isLegacy()) { + BlockScanner scanner = new LegacyNmsScanner(plugin, config, counterManager); + if (scanner.isSupported()) { + Bukkit.getLogger().log(Level.INFO, "[BlockScannerFactory] Using " + scanner.getImplementationName()); + return scanner; + } + Bukkit.getLogger().log(Level.WARNING, "[BlockScannerFactory] LegacyNMS not supported, trying alternatives..."); + } + + // 4. Fallback: Pure Bukkit API (always works) + Bukkit.getLogger().log(Level.WARNING, "[BlockScannerFactory] NMS reflection failed for version " + version + + ", falling back to Bukkit API (slower performance)"); + BlockScanner fallback = new BukkitBlockScanner(plugin, config, counterManager); + Bukkit.getLogger().log(Level.INFO, "[BlockScannerFactory] Using " + fallback.getImplementationName()); + return fallback; + } + + /** + * Create a BlockScanner with explicit scanner type override. + * Useful for testing or forcing a specific implementation. + * + * @param plugin the plugin instance + * @param config the plugin configuration + * @param counterManager the counter data manager + * @param scannerType the specific scanner type to use + * @return the requested BlockScanner implementation + */ + public static BlockScanner createSpecific(Plugin plugin, PluginConfig config, CounterDataManager counterManager, ScannerType scannerType) { + BlockScanner scanner = switch (scannerType) { + case MODERN_NMS -> new ModernNmsScanner(plugin, config, counterManager); + case SPIGOT_NMS -> new SpigotNmsScanner(plugin, config, counterManager); + case LEGACY_NMS -> new LegacyNmsScanner(plugin, config, counterManager); + case BUKKIT -> new BukkitBlockScanner(plugin, config, counterManager); + }; + + if (!scanner.isSupported()) { + Bukkit.getLogger().log(Level.WARNING, "[BlockScannerFactory] Requested scanner " + scannerType + + " is not supported, falling back to Bukkit"); + return new BukkitBlockScanner(plugin, config, counterManager); + } + + Bukkit.getLogger().log(Level.INFO, "[BlockScannerFactory] Using explicitly requested " + scanner.getImplementationName()); + return scanner; + } + + /** + * Enumeration of available scanner types. + */ + public enum ScannerType { + MODERN_NMS, + SPIGOT_NMS, + LEGACY_NMS, + BUKKIT + } +} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/scanner/NmsBlockScanner.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/scanner/NmsBlockScanner.java new file mode 100644 index 0000000..b57f393 --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/scanner/NmsBlockScanner.java @@ -0,0 +1,426 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.reflection.scanner; +import com.github.sarhatabaot.chunkspawnerlimiter.PluginConfig; +import com.github.sarhatabaot.chunkspawnerlimiter.chunk.ChunkCoord; +import com.github.sarhatabaot.chunkspawnerlimiter.counter.CounterDataManager; +import com.github.sarhatabaot.chunkspawnerlimiter.reflection.WorldReflection; +import org.bukkit.Bukkit; +import org.bukkit.Chunk; +import org.bukkit.Material; +import org.bukkit.World; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +import java.lang.reflect.Constructor; +import java.lang.reflect.Method; +import java.util.Arrays; +import java.util.logging.Level; + + +/** + * NmsBlockScanner + *

+ * Provides utility to get block Material at coordinates using NMS when possible. + * Safe fallbacks to Bukkit API included. + */ +public class NmsBlockScanner { + private static final int CHUNK_SIZE = 16; + private final PluginConfig pluginConfig; + private final CounterDataManager counterDataManager; + + // Reflection-found classes & methods (nullable if not found) + private Class craftWorldClass; + private Method craftWorld_getHandle; + + private Class nmsWorldClass; // e.g. net.minecraft.server.level.WorldServer or net.minecraft.world.level.World or legacy + private Method nmsWorld_getBlockStateMethod; // candidate names: getBlockState, getType, getType + + private Class blockPosClass; + private Constructor blockPosConstructor; // (int x, int y, int z) or (double x,..) depending on version + + private Class iBlockDataClass; // net.minecraft.world.level.block.state.BlockState / IBlockData + private Method iBlockData_getBukkitMaterial; // Paper convenience method (if present) + private Method iBlockData_getBlock; // if IBlockData#getBlock() exists (legacy -> returns Block) + + // Optional CraftBukkit helper (fallback if plugin runs on CraftBukkit) + private Method craftMagicNumbers_getMaterial; // CraftMagicNumbers.getMaterial(Block) (fallback) + + // Whether we successfully found at least basic NMS wiring + private boolean initialized = false; + + public NmsBlockScanner(final PluginConfig pluginConfig, final CounterDataManager counterDataManager) { + this.pluginConfig = pluginConfig; + this.counterDataManager = counterDataManager; + try { + init(); + initialized = true; + Bukkit.getLogger().log(Level.INFO, "[NmsBlockScanner] Initialized (mojang-first)."); + } catch (Throwable t) { + // Do not fatal — keep initialized=false and provide safe fallbacks + initialized = false; + Bukkit.getLogger().log(Level.WARNING, "[NmsBlockScanner] Initialization partially failed. Falling back to Bukkit API. " + + "Detailed: " + t.getClass().getSimpleName() + ": " + t.getMessage()); + logDetailedInitError(t); + } + } + + private void init() throws Exception { + // 1) find CraftWorld class and getHandle() + try { + craftWorldClass = tryLoad( + "org.bukkit.craftbukkit.CraftWorld", // some shading might remove version segment + // ideally full name with version is not needed; Class.forName will succeed if present on classpath + "org.bukkit.craftbukkit." + detectCraftBukkitPackageSuffix() + ".CraftWorld", + "org.bukkit.craftbukkit.v1_0_R_NOTFOUND.CraftWorld" // dummy, ignored + ); + } catch (ClassNotFoundException e) { + // craftWorldClass may still be available via Bukkit world object's class' package + craftWorldClass = null; + } + + // If we couldn't load CraftWorld directly, still try to get handle method from any world instance's class + if (craftWorldClass != null) { + try { + craftWorld_getHandle = craftWorldClass.getMethod("getHandle"); + } catch (NoSuchMethodException ignored) { + craftWorld_getHandle = null; + } + } + + // 2) nms World candidates (modern-first) + String[] nmsWorldCandidates = new String[]{ + "net.minecraft.server.level.WorldServer", // modern server world (1.17+) + "net.minecraft.world.level.World", // alternative modern path + // legacy server world pattern (pre-1.17). We'll attempt to extract package suffix if possible: + "net.minecraft.server." + detectCraftBukkitPackageSuffix() + ".World" + }; + + nmsWorldClass = tryLoadNullable(nmsWorldCandidates); + + // 3) BlockPos candidates + String[] blockPosCandidates = new String[]{ + "net.minecraft.core.BlockPos", // modern (1.17+) + "net.minecraft.world.phys.BlockPos", // some variants, try conservative + "net.minecraft.server." + detectCraftBukkitPackageSuffix() + ".BlockPosition" + }; + + blockPosClass = tryLoadNullable(blockPosCandidates); + + if (blockPosClass != null) { + // prefer constructor (int,int,int) + try { + blockPosConstructor = blockPosClass.getConstructor(int.class, int.class, int.class); + } catch (NoSuchMethodException ex) { + // try long or three ints as alternative signatures sometimes exist; try (long) + try { + blockPosConstructor = blockPosClass.getConstructor(long.class); + } catch (NoSuchMethodException ex2) { + blockPosConstructor = null; + } + } + } + + // 4) IBlockData / BlockState class candidates + String[] iBlockCandidates = new String[]{ + "net.minecraft.world.level.block.state.BlockState", // possible modern name + "net.minecraft.world.level.block.state.IBlockData", // alternate + "net.minecraft.server." + detectCraftBukkitPackageSuffix() + ".IBlockData" // legacy + }; + + iBlockDataClass = tryLoadNullable(iBlockCandidates); + + if (iBlockDataClass != null) { + // try to find a Paper convenience method getBukkitMaterial() + try { + iBlockData_getBukkitMaterial = iBlockDataClass.getMethod("getBukkitMaterial"); + } catch (NoSuchMethodException ignored) { + iBlockData_getBukkitMaterial = null; + } + + // try legacy getBlock() + try { + iBlockData_getBlock = iBlockDataClass.getMethod("getBlock"); + } catch (NoSuchMethodException ignored) { + iBlockData_getBlock = null; + } + } + + // 5) find a method on nmsWorldClass to fetch block state + if (nmsWorldClass != null && blockPosClass != null) { + // candidate method names + String[] methodNames = new String[]{"getType", "getBlockState", "a", "getTypeAndData", "b"}; // 'a'/'b' are obf fallbacks + for (String name : methodNames) { + try { + nmsWorld_getBlockStateMethod = nmsWorldClass.getMethod(name, blockPosClass); + break; + } catch (NoSuchMethodException ignored) { + } + } + // if still null try methods with primitive coordinates (x,y,z) + if (nmsWorld_getBlockStateMethod == null) { + try { + nmsWorld_getBlockStateMethod = nmsWorldClass.getMethod("getType", int.class, int.class, int.class); + } catch (NoSuchMethodException ignored) { + nmsWorld_getBlockStateMethod = null; + } + } + } + + // 6) Attempt to locate CraftMagicNumbers.getMaterial(Block) as a last resort for conversion + try { + Class craftMagicNumbers = tryLoad("org.bukkit.craftbukkit.util.CraftMagicNumbers", + "org.bukkit.craftbukkit." + detectCraftBukkitPackageSuffix() + ".util.CraftMagicNumbers"); + craftMagicNumbers_getMaterial = craftMagicNumbers.getMethod("getMaterial", tryLoad( + "net.minecraft.server." + detectCraftBukkitPackageSuffix() + ".Block", + "net.minecraft.world.level.block.Block" // modern + )); + } catch (Throwable ignored) { + craftMagicNumbers_getMaterial = null; + } + + // log what we've found + String summary = String.format("NMS init summary: craftWorld=%s, nmsWorld=%s, blockPos=%s, iBlockData=%s, worldGetMethod=%s", + safeName(craftWorldClass), safeName(nmsWorldClass), safeName(blockPosClass), safeName(iBlockDataClass), + nmsWorld_getBlockStateMethod == null ? "null" : nmsWorld_getBlockStateMethod.getName()); + Bukkit.getLogger().log(Level.INFO, "[NmsBlockScanner] " + summary); + } + + /** + * Primary API: get the Bukkit Material at x,y,z in the provided Bukkit World. + * Tries NMS path first; if anything fails, falls back to Bukkit API (World#getBlockAt). + */ + public Material getMaterialAt(World bukkitWorld, int x, int y, int z) { + // If initialization partially failed, just fall back + if (!initialized && craftWorld_getHandle == null && nmsWorld_getBlockStateMethod == null) { + return fallbackBukkit(bukkitWorld, x, y, z); + } + + try { + Object nmsWorld = resolveNmsWorldFromBukkitWorld(bukkitWorld); + if (nmsWorld == null || nmsWorld_getBlockStateMethod == null) { + return fallbackBukkit(bukkitWorld, x, y, z); + } + + Object blockPos = createBlockPos(x, y, z); + if (blockPos == null) { + return fallbackBukkit(bukkitWorld, x, y, z); + } + + Object iBlock = invokeGetBlockState(nmsWorld, blockPos, x, y, z); + if (iBlock == null) { + return fallbackBukkit(bukkitWorld, x, y, z); + } + + // 1) try Paper / modern convenience + if (iBlockData_getBukkitMaterial != null) { + try { + Object matObj = iBlockData_getBukkitMaterial.invoke(iBlock); + if (matObj instanceof Material) return (Material) matObj; + if (matObj != null && matObj.toString() != null) { + try { + return Material.valueOf(matObj.toString()); + } catch (IllegalArgumentException ignored) {} + } + } catch (Throwable ignore) { /* continue to fallback */ } + } + + // 2) try IBlockData#getBlock() -> CraftMagicNumbers.getMaterial(block) + if (iBlockData_getBlock != null && craftMagicNumbers_getMaterial != null) { + try { + Object nmsBlock = iBlockData_getBlock.invoke(iBlock); + Object mat = craftMagicNumbers_getMaterial.invoke(null, nmsBlock); + if (mat instanceof Material) return (Material) mat; + } catch (Throwable ignore) { /* continue to fallback */ } + } + + // 3) As an additional path: if iBlock.toString contains block id name try mapping (not reliable) + try { + String s = iBlock.toString(); + if (s != null) { + for (Material m : Material.values()) { + if (s.contains(m.name())) return m; + } + } + } catch (Throwable ignore) {} + + // final fallback: Bukkit API + return fallbackBukkit(bukkitWorld, x, y, z); + + } catch (Throwable t) { + // On any reflection/runtime error, log and return safe fallback + Bukkit.getLogger().log(Level.WARNING, "[NmsBlockScanner] Failed to resolve material via NMS: " + t.getClass().getSimpleName() + ": " + t.getMessage()); + logDetailedInitError(t); + return fallbackBukkit(bukkitWorld, x, y, z); + } + } + + public void scanChunk(@NotNull Chunk chunk, @NotNull ChunkCoord chunkCoord, final int chunkSize) { + final World world = chunk.getWorld(); + + // Chunk → world coords + final int startX = chunk.getX() << 4; + final int startZ = chunk.getZ() << 4; + + // Safe min/max Y for all versions + final int minY = WorldReflection.getWorldMinHeightSafe(world); + final int maxY = world.getMaxHeight(); + + for (int x = 0; x < CHUNK_SIZE; x++) { + for (int z = 0; z < CHUNK_SIZE; z++) { + for (int y = minY; y < maxY; y++) { + + Material type = getMaterialAt(world, startX + x, y, startZ + z); + + if (type != null && pluginConfig.hasResolvedBlockLimit(type)) { + counterDataManager.getCounterData(chunkCoord).incrementBlock(type); + } + } + } + } + } + + + public void scanChunk(@NotNull Chunk chunk, @NotNull ChunkCoord chunkCoord) { + scanChunk(chunk, chunkCoord, CHUNK_SIZE); + } + + // ---------------------- + // Reflection helpers + // ---------------------- + + private @Nullable Object invokeGetBlockState(Object nmsWorld, Object blockPos, int x, int y, int z) throws Exception { + if (nmsWorld_getBlockStateMethod == null) return null; + try { + return nmsWorld_getBlockStateMethod.invoke(nmsWorld, blockPos); + } catch (IllegalArgumentException iae) { + // maybe method expects (int,int,int) + try { + return nmsWorld_getBlockStateMethod.invoke(nmsWorld, x, y, z); + } catch (IllegalArgumentException iae2) { + throw iae2; + } + } + } + + private @Nullable Object createBlockPos(int x, int y, int z) { + if (blockPosConstructor != null) { + try { + Class[] params = blockPosConstructor.getParameterTypes(); + if (params.length == 3 && params[0] == int.class) { + return blockPosConstructor.newInstance(x, y, z); + } else if (params.length == 1 && params[0] == long.class) { + long packed = ((long) x & 0x3FFFFFF) << 38 | ((long) z & 0x3FFFFFF) << 12 | ((long) y & 0xFFF); + return blockPosConstructor.newInstance(packed); + } else { + // last resort: attempt with ints via reflection boxing + Object[] args = new Object[]{x, y, z}; + return blockPosConstructor.newInstance(args); + } + } catch (Throwable t) { + // fall through + return null; + } + } + return null; + } + + private @Nullable Object resolveNmsWorldFromBukkitWorld(World bukkitWorld) throws Exception { + // If we have craftWorld_getHandle, prefer it + if (craftWorld_getHandle != null && craftWorldClass != null && craftWorldClass.isAssignableFrom(bukkitWorld.getClass())) { + // e.g. cast and call getHandle + try { + return craftWorld_getHandle.invoke(bukkitWorld); + } catch (Throwable ignored) { + } + } + + // If CraftWorld not available or not assignable, try to find a method 'getHandle' on the runtime class of the bukkit world + try { + Method maybeGetHandle = bukkitWorld.getClass().getMethod("getHandle"); + if (maybeGetHandle != null) { + return maybeGetHandle.invoke(bukkitWorld); + } + } catch (NoSuchMethodException ignored) { + } + + // Last resort: try to call Bukkit.getServer() class / internal mapping — but this is fragile. + return null; + } + + private Material fallbackBukkit(World world, int x, int y, int z) { + try { + return world.getBlockAt(x, y, z).getType(); + } catch (Throwable t) { + Bukkit.getLogger().log(Level.WARNING, "[NmsBlockScanner] Bukkit fallback failed: " + t.getMessage()); + return Material.BEDROCK; // safe default (shouldn't happen though) + } + } + + // ---------------------- + // Utility / loading helpers + // ---------------------- + + private String detectCraftBukkitPackageSuffix() { + try { + String serverClass = Bukkit.getServer().getClass().getPackage().getName(); // e.g. org.bukkit.craftbukkit.v1_20_R3 or io.papermc.paper + // If it contains "craftbukkit.", return the suffix after craftbukkit. + int idx = serverClass.indexOf("craftbukkit"); + if (idx != -1) { + String after = serverClass.substring(idx + "craftbukkit".length()); + // after example: ".v1_20_R3" + if (after.startsWith(".")) after = after.substring(1); + if (after.isEmpty()) return ""; // unusual + return after; + } + + // otherwise try to extract version-like segment (fallback) + String[] parts = serverClass.split("\\."); + if (parts.length >= 4) { + return parts[3]; + } + return serverClass; // last resort + } catch (Throwable t) { + return "unknown"; + } + } + + private Class tryLoad(String... names) throws ClassNotFoundException { + ClassNotFoundException last = null; + for (String n : names) { + if (n == null || n.trim().isEmpty()) continue; + try { + return Class.forName(n); + } catch (ClassNotFoundException ex) { + last = ex; + } catch (NoClassDefFoundError err) { + last = new ClassNotFoundException(err.toString(), err); + } + } + throw last == null ? new ClassNotFoundException(Arrays.toString(names)) : last; + } + + private Class tryLoadNullable(String... names) { + for (String n : names) { + if (n == null || n.trim().isEmpty()) continue; + try { + return Class.forName(n); + } catch (Throwable ignored) {} + } + return null; + } + + private String safeName(Class c) { + return c == null ? "null" : c.getName(); + } + + private void logDetailedInitError(Throwable t) { + // Avoid spamming stacktrace to console in production; show concise info. + Bukkit.getLogger().log(Level.INFO, "[NmsBlockScanner] Detailed failure: " + t.getClass().getName() + ": " + t.getMessage()); + // Optionally, to aid debugging, print the cause chain: + Throwable cause = t; + while (cause != null) { + Bukkit.getLogger().log(Level.FINER, "Cause: " + cause.getClass().getName() + ": " + cause.getMessage()); + cause = cause.getCause(); + } + } + +} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/scanner/impl/BukkitBlockScanner.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/scanner/impl/BukkitBlockScanner.java new file mode 100644 index 0000000..8a73e7f --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/scanner/impl/BukkitBlockScanner.java @@ -0,0 +1,35 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.reflection.scanner.impl; + +import com.github.sarhatabaot.chunkspawnerlimiter.PluginConfig; +import com.github.sarhatabaot.chunkspawnerlimiter.counter.CounterDataManager; +import com.github.sarhatabaot.chunkspawnerlimiter.reflection.scanner.AbstractBlockScanner; +import org.bukkit.Material; +import org.bukkit.World; +import org.bukkit.plugin.Plugin; + +/** + * Fallback block scanner using pure Bukkit API. + * This implementation is slow but always works on any server version. + * Used when NMS reflection fails or is unavailable. + */ +public class BukkitBlockScanner extends AbstractBlockScanner { + + public BukkitBlockScanner(Plugin plugin, PluginConfig config, CounterDataManager counterManager) { + super(plugin, config, counterManager); + } + + @Override + protected Material getMaterialAtImpl(World world, int x, int y, int z) { + return world.getBlockAt(x, y, z).getType(); + } + + @Override + public boolean isSupported() { + return true; // Always supported + } + + @Override + public String getImplementationName() { + return "Bukkit"; + } +} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/scanner/impl/LegacyNmsScanner.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/scanner/impl/LegacyNmsScanner.java new file mode 100644 index 0000000..6cde8fd --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/scanner/impl/LegacyNmsScanner.java @@ -0,0 +1,198 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.reflection.scanner.impl; + +import com.github.sarhatabaot.chunkspawnerlimiter.CSLLogger; +import com.github.sarhatabaot.chunkspawnerlimiter.PluginConfig; +import com.github.sarhatabaot.chunkspawnerlimiter.counter.CounterDataManager; +import com.github.sarhatabaot.chunkspawnerlimiter.reflection.scanner.AbstractBlockScanner; +import com.github.sarhatabaot.chunkspawnerlimiter.reflection.scanner.util.MinecraftVersion; +import org.bukkit.Bukkit; +import org.bukkit.Material; +import org.bukkit.World; +import org.bukkit.plugin.Plugin; + +import java.lang.reflect.Constructor; +import java.lang.reflect.Method; + +/** + * NMS block scanner for Minecraft 1.8.8-1.12 using legacy NMS structure. + * Package structure: net.minecraft.server.v1_12_R1.* + * Similar to Spigot scanner but with older NMS API differences. + */ +public class LegacyNmsScanner extends AbstractBlockScanner { + + private final boolean initialized; + private final String versionSuffix; + + // NMS classes (legacy with version suffix) + private Class worldClass; + private Class blockPositionClass; + private Class iBlockDataClass; + + // Methods + private Method craftWorld_getHandle; + private Method getType; // World.getType(BlockPosition) + private Method getBlock; // IBlockData.getBlock() + private Method craftMagicNumbers_getMaterial; + + // Constructor + private Constructor blockPositionConstructor; + + public LegacyNmsScanner(Plugin plugin, PluginConfig config, CounterDataManager counterManager) { + super(plugin, config, counterManager); + this.versionSuffix = MinecraftVersion.detectVersionSuffix(); + this.initialized = initialize(); + } + + private boolean initialize() { + if (versionSuffix == null || versionSuffix.isEmpty()) { + CSLLogger.debug(() -> "[LegacyNMS] No version suffix detected"); + return false; + } + + try { + CSLLogger.debug(() -> "[LegacyNMS] Detected version suffix: " + versionSuffix); + + // CraftWorld.getHandle() + Class craftWorldClass = loadClass("org.bukkit.craftbukkit." + versionSuffix + ".CraftWorld"); + if (craftWorldClass != null) { + craftWorld_getHandle = craftWorldClass.getMethod("getHandle"); + } else { + return false; + } + + // NMS classes with version suffix (legacy structure) + worldClass = loadClass("net.minecraft.server." + versionSuffix + ".World"); + + blockPositionClass = loadClass("net.minecraft.server." + versionSuffix + ".BlockPosition"); + + iBlockDataClass = loadClass("net.minecraft.server." + versionSuffix + ".IBlockData"); + + if (worldClass == null || blockPositionClass == null || iBlockDataClass == null) { + CSLLogger.debug(() -> "[LegacyNMS] Failed to load required NMS classes"); + return false; + } + + // BlockPosition constructor (int, int, int) + try { + blockPositionConstructor = blockPositionClass.getConstructor(int.class, int.class, int.class); + } catch (NoSuchMethodException e) { + // Try alternative signatures for very old versions + CSLLogger.debug(() -> "[LegacyNMS] BlockPosition(int,int,int) constructor not found"); + return false; + } + + // World.getType(BlockPosition) method + // In legacy versions, this might be called differently + getType = findMethod(worldClass, blockPositionClass, "getType", "a"); + if (getType == null) { + CSLLogger.debug(() -> "[LegacyNMS] getType method not found"); + return false; + } + + // IBlockData.getBlock() method + try { + getBlock = iBlockDataClass.getMethod("getBlock"); + } catch (NoSuchMethodException e) { + // Try obfuscated name + try { + getBlock = iBlockDataClass.getMethod("b"); + } catch (NoSuchMethodException e2) { + CSLLogger.debug(() -> "[LegacyNMS] getBlock method not found"); + getBlock = null; + } + } + + // CraftMagicNumbers.getMaterial(Block) for conversion + try { + Class craftMagicNumbers = loadClass("org.bukkit.craftbukkit." + versionSuffix + ".util.CraftMagicNumbers"); + Class blockClass = loadClass("net.minecraft.server." + versionSuffix + ".Block"); + if (craftMagicNumbers != null && blockClass != null) { + craftMagicNumbers_getMaterial = craftMagicNumbers.getMethod("getMaterial", blockClass); + } + } catch (NoSuchMethodException e) { + CSLLogger.debug(() -> "[LegacyNMS] CraftMagicNumbers.getMaterial not found"); + craftMagicNumbers_getMaterial = null; + } + + CSLLogger.debug(() -> "[LegacyNMS] Initialization successful for " + versionSuffix); + return true; + + } catch (Exception e) { + Bukkit.getLogger().warning("[LegacyNMS] Initialization failed: " + e.getMessage()); + return false; + } + } + + @Override + protected Material getMaterialAtImpl(World world, int x, int y, int z) { + if (!initialized) { + return null; + } + + try { + // Get NMS World from CraftWorld + Object nmsWorld = craftWorld_getHandle.invoke(world); + if (nmsWorld == null) { + return null; + } + + // Create BlockPosition + Object blockPosition = blockPositionConstructor.newInstance(x, y, z); + + // Get IBlockData + Object iBlockData = getType.invoke(nmsWorld, blockPosition); + if (iBlockData == null) { + return null; + } + + // Get Block from IBlockData + if (getBlock != null && craftMagicNumbers_getMaterial != null) { + try { + Object block = getBlock.invoke(iBlockData); + Object result = craftMagicNumbers_getMaterial.invoke(null, block); + if (result instanceof Material) { + return (Material) result; + } + } catch (Exception e) { + CSLLogger.debug(() -> "[LegacyNMS] Material conversion failed: " + e.getMessage()); + } + } + + return null; + + } catch (Exception e) { + CSLLogger.debug(() -> "[LegacyNMS] Error getting material: " + e.getMessage()); + return null; + } + } + + @Override + public boolean isSupported() { + return initialized; + } + + @Override + public String getImplementationName() { + return "LegacyNMS" + (versionSuffix != null ? " (" + versionSuffix + ")" : ""); + } + + // Helper methods + + private Class loadClass(String name) { + try { + return Class.forName(name); + } catch (ClassNotFoundException e) { + return null; + } + } + + private Method findMethod(Class clazz, Class paramType, String... names) { + for (String name : names) { + try { + return clazz.getMethod(name, paramType); + } catch (NoSuchMethodException ignored) { + } + } + return null; + } +} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/scanner/impl/ModernNmsScanner.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/scanner/impl/ModernNmsScanner.java new file mode 100644 index 0000000..7dc6aa5 --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/scanner/impl/ModernNmsScanner.java @@ -0,0 +1,256 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.reflection.scanner.impl; + +import com.github.sarhatabaot.chunkspawnerlimiter.CSLLogger; +import com.github.sarhatabaot.chunkspawnerlimiter.PluginConfig; +import com.github.sarhatabaot.chunkspawnerlimiter.counter.CounterDataManager; +import com.github.sarhatabaot.chunkspawnerlimiter.reflection.scanner.AbstractBlockScanner; +import com.github.sarhatabaot.chunkspawnerlimiter.reflection.scanner.util.MinecraftVersion; +import org.bukkit.Bukkit; +import org.bukkit.Material; +import org.bukkit.World; +import org.bukkit.plugin.Plugin; + +import java.lang.reflect.Constructor; +import java.lang.reflect.Method; + +/** + * NMS block scanner for Minecraft 1.17+ using Mojang-mapped classes. + * Supports modern package structure: net.minecraft.server.level, net.minecraft.core, etc. + */ +public class ModernNmsScanner extends AbstractBlockScanner { + + private final boolean initialized; + private final String versionSuffix; + + // NMS classes (Mojang-mapped) + private Class serverLevelClass; + private Class blockPosClass; + private Class blockStateClass; + + // Methods + private Method craftWorld_getHandle; + private Method getBlockState; + private Method getBukkitMaterial; // Paper optimization + private Method getBlock; + private Method craftMagicNumbers_getMaterial; + + // Constructor + private Constructor blockPosConstructor; + + public ModernNmsScanner(Plugin plugin, PluginConfig config, CounterDataManager counterManager) { + super(plugin, config, counterManager); + this.versionSuffix = MinecraftVersion.detectVersionSuffix(); + this.initialized = initialize(); + } + + private boolean initialize() { + if (versionSuffix == null || versionSuffix.isEmpty()) { + CSLLogger.debug(() -> "[ModernNMS] No version suffix detected"); + return false; + } + + try { + CSLLogger.debug(() -> "[ModernNMS] Starting initialization for " + versionSuffix); + + // CraftWorld.getHandle() - use versioned CraftBukkit package + Class craftWorldClass = loadClass("org.bukkit.craftbukkit." + versionSuffix + ".CraftWorld"); + if (craftWorldClass != null) { + try { + craftWorld_getHandle = craftWorldClass.getMethod("getHandle"); + CSLLogger.debug(() -> "[ModernNMS] Found CraftWorld.getHandle() method"); + } catch (NoSuchMethodException e) { + CSLLogger.debug(() -> "[ModernNMS] CraftWorld.getHandle() method not found: " + e.getMessage()); + return false; + } + } else { + CSLLogger.debug(() -> "[ModernNMS] CraftWorld class not found in versioned package: " + versionSuffix); + return false; + } + + // Modern NMS classes (Mojang-mapped) + serverLevelClass = loadClass( + "net.minecraft.server.level.ServerLevel", + "net.minecraft.server.level.WorldServer" + ); + if (serverLevelClass == null) { + CSLLogger.debug(() -> "[ModernNMS] ServerLevel class not found (tried: net.minecraft.server.level.ServerLevel, net.minecraft.server.level.WorldServer)"); + return false; + } else { + CSLLogger.debug(() -> "[ModernNMS] Found ServerLevel class: " + serverLevelClass.getName()); + } + + blockPosClass = loadClass("net.minecraft.core.BlockPosition", "net.minecraft.core.BlockPos"); + if (blockPosClass == null) { + CSLLogger.debug(() -> "[ModernNMS] BlockPos class not found (tried: net.minecraft.core.BlockPosition, net.minecraft.core.BlockPos)"); + return false; + } else { + CSLLogger.debug(() -> "[ModernNMS] Found BlockPos class: " + blockPosClass.getName()); + } + + blockStateClass = loadClass( + "net.minecraft.world.level.block.state.IBlockData", + "net.minecraft.world.level.block.state.BlockState" + ); + if (blockStateClass != null) { + CSLLogger.debug(() -> "[ModernNMS] Found BlockState class: " + blockStateClass.getName()); + } else { + CSLLogger.debug(() -> "[ModernNMS] BlockState class not found (tried: net.minecraft.world.level.block.state.IBlockData, net.minecraft.world.level.block.state.BlockState)"); + } + + // BlockPos constructor (int, int, int) + try { + blockPosConstructor = blockPosClass.getConstructor(int.class, int.class, int.class); + CSLLogger.debug(() -> "[ModernNMS] Found BlockPos(int,int,int) constructor"); + } catch (NoSuchMethodException e) { + CSLLogger.debug(() -> "[ModernNMS] BlockPos(int,int,int) constructor not found: " + e.getMessage()); + return false; + } + + // getBlockState(BlockPos) method + getBlockState = findMethod(serverLevelClass, blockPosClass, "getBlockState", "getType", "a", "a_"); + if (getBlockState == null) { + // Debug: List all methods that take a BlockPos parameter + CSLLogger.debug(() -> "[ModernNMS] Available methods on " + serverLevelClass.getName() + " that take BlockPos:"); + for (Method method : serverLevelClass.getMethods()) { + if (method.getParameterCount() == 1 && + method.getParameterTypes()[0].equals(blockPosClass)) { + CSLLogger.debug(() -> "[ModernNMS] " + method.getName() + "(" + blockPosClass.getSimpleName() + ") -> " + method.getReturnType().getSimpleName()); + } + } + CSLLogger.debug(() -> "[ModernNMS] getBlockState method not found on " + serverLevelClass.getName() + " (tried: getBlockState, getType, a)"); + return false; + } else { + CSLLogger.debug(() -> "[ModernNMS] Found getBlockState method: " + getBlockState.getName()); + } + + // Try to find Paper's getBukkitMaterial() optimization + if (blockStateClass != null) { + try { + getBukkitMaterial = blockStateClass.getMethod("getBukkitMaterial"); + CSLLogger.debug(() -> "[ModernNMS] Found Paper's getBukkitMaterial() optimization"); + } catch (NoSuchMethodException e) { + // Not Paper or method doesn't exist - that's okay + getBukkitMaterial = null; + } + + // Fallback: getBlock() method + try { + getBlock = blockStateClass.getMethod("getBlock"); + } catch (NoSuchMethodException e) { + try { + getBlock = blockStateClass.getMethod("b"); + } catch (NoSuchMethodException e2) { + getBlock = null; + } + } + } + + // CraftMagicNumbers.getMaterial(Block) for conversion + try { + Class craftMagicNumbers = loadClass("org.bukkit.craftbukkit.util.CraftMagicNumbers"); + Class blockClass = loadClass("net.minecraft.world.level.block.Block"); + if (craftMagicNumbers != null && blockClass != null) { + craftMagicNumbers_getMaterial = craftMagicNumbers.getMethod("getMaterial", blockClass); + } + } catch (NoSuchMethodException e) { + craftMagicNumbers_getMaterial = null; + } + + CSLLogger.debug(() -> "[ModernNMS] Initialization successful"); + return true; + + } catch (Exception e) { + Bukkit.getLogger().warning("[ModernNMS] Initialization failed: " + e.getMessage()); + return false; + } + } + + @Override + protected Material getMaterialAtImpl(World world, int x, int y, int z) { + if (!initialized) { + return null; + } + + try { + // Get NMS ServerLevel from CraftWorld + Object serverLevel = craftWorld_getHandle.invoke(world); + if (serverLevel == null) { + return null; + } + + // Create BlockPos + Object blockPos = blockPosConstructor.newInstance(x, y, z); + + // Get BlockState + Object blockState = getBlockState.invoke(serverLevel, blockPos); + if (blockState == null) { + return null; + } + + // Try Paper optimization first + if (getBukkitMaterial != null) { + try { + Object result = getBukkitMaterial.invoke(blockState); + if (result instanceof Material) { + return (Material) result; + } + } catch (Exception ignored) { + // Fall through to next method + } + } + + // Try getBlock() -> CraftMagicNumbers + if (getBlock != null && craftMagicNumbers_getMaterial != null) { + try { + Object block = getBlock.invoke(blockState); + Object result = craftMagicNumbers_getMaterial.invoke(null, block); + if (result instanceof Material) { + return (Material) result; + } + } catch (Exception ignored) { + // Fall through + } + } + + return null; + + } catch (Exception e) { + CSLLogger.debug(() -> "[ModernNMS] Error getting material: " + e.getMessage()); + return null; + } + } + + @Override + public boolean isSupported() { + return initialized; + } + + @Override + public String getImplementationName() { + return "ModernNMS"; + } + + // Helper methods + + private Class loadClass(String... names) { + for (String name : names) { + try { + return Class.forName(name); + } catch (ClassNotFoundException ignored) { + } + } + return null; + } + + private Method findMethod(Class clazz, Class paramType, String... names) { + for (String name : names) { + try { + return clazz.getMethod(name, paramType); + } catch (NoSuchMethodException ignored) { + } + } + return null; + } + + +} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/scanner/impl/SpigotNmsScanner.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/scanner/impl/SpigotNmsScanner.java new file mode 100644 index 0000000..0022e4f --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/scanner/impl/SpigotNmsScanner.java @@ -0,0 +1,198 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.reflection.scanner.impl; + +import com.github.sarhatabaot.chunkspawnerlimiter.CSLLogger; +import com.github.sarhatabaot.chunkspawnerlimiter.PluginConfig; +import com.github.sarhatabaot.chunkspawnerlimiter.counter.CounterDataManager; +import com.github.sarhatabaot.chunkspawnerlimiter.reflection.scanner.AbstractBlockScanner; +import com.github.sarhatabaot.chunkspawnerlimiter.reflection.scanner.util.MinecraftVersion; +import org.bukkit.Bukkit; +import org.bukkit.Material; +import org.bukkit.World; +import org.bukkit.plugin.Plugin; + +import java.lang.reflect.Constructor; +import java.lang.reflect.Method; + +/** + * NMS block scanner for Minecraft 1.13-1.16 using Spigot mappings with version suffixes. + * Package structure: net.minecraft.server.v1_16_R3.* + */ +public class SpigotNmsScanner extends AbstractBlockScanner { + + private final boolean initialized; + private final String versionSuffix; + + // NMS classes (Spigot-mapped with version suffix) + private Class worldServerClass; + private Class blockPositionClass; + private Class iBlockDataClass; + + // Methods + private Method craftWorld_getHandle; + private Method getType; // World.getType(BlockPosition) + private Method getBlock; // IBlockData.getBlock() + private Method craftMagicNumbers_getMaterial; + + // Constructor + private Constructor blockPositionConstructor; + + public SpigotNmsScanner(Plugin plugin, PluginConfig config, CounterDataManager counterManager) { + super(plugin, config, counterManager); + this.versionSuffix = MinecraftVersion.detectVersionSuffix(); + this.initialized = initialize(); + } + + private boolean initialize() { + if (versionSuffix == null || versionSuffix.isEmpty()) { + CSLLogger.debug(() -> "[SpigotNMS] No version suffix detected"); + return false; + } + + try { + CSLLogger.debug(() -> "[SpigotNMS] Detected version suffix: " + versionSuffix); + + // CraftWorld.getHandle() + Class craftWorldClass = loadClass("org.bukkit.craftbukkit." + versionSuffix + ".CraftWorld"); + if (craftWorldClass != null) { + craftWorld_getHandle = craftWorldClass.getMethod("getHandle"); + } else { + return false; + } + + // NMS classes with version suffix + worldServerClass = loadClass("net.minecraft.server." + versionSuffix + ".WorldServer"); + if (worldServerClass == null) { + worldServerClass = loadClass("net.minecraft.server." + versionSuffix + ".World"); + } + + blockPositionClass = loadClass("net.minecraft.server." + versionSuffix + ".BlockPosition"); + + iBlockDataClass = loadClass("net.minecraft.server." + versionSuffix + ".IBlockData"); + + if (worldServerClass == null || blockPositionClass == null || iBlockDataClass == null) { + CSLLogger.debug(() -> "[SpigotNMS] Failed to load required NMS classes"); + return false; + } + + // BlockPosition constructor (int, int, int) + try { + blockPositionConstructor = blockPositionClass.getConstructor(int.class, int.class, int.class); + } catch (NoSuchMethodException e) { + CSLLogger.debug(() -> "[SpigotNMS] BlockPosition(int,int,int) constructor not found"); + return false; + } + + // World.getType(BlockPosition) method + getType = findMethod(worldServerClass, blockPositionClass, "getType", "a"); + if (getType == null) { + CSLLogger.debug(() -> "[SpigotNMS] getType method not found"); + return false; + } + + // IBlockData.getBlock() method + try { + getBlock = iBlockDataClass.getMethod("getBlock"); + } catch (NoSuchMethodException e) { + // Try obfuscated name + try { + getBlock = iBlockDataClass.getMethod("b"); + } catch (NoSuchMethodException e2) { + CSLLogger.debug(() -> "[SpigotNMS] getBlock method not found"); + getBlock = null; + } + } + + // CraftMagicNumbers.getMaterial(Block) for conversion + try { + Class craftMagicNumbers = loadClass("org.bukkit.craftbukkit." + versionSuffix + ".util.CraftMagicNumbers"); + Class blockClass = loadClass("net.minecraft.server." + versionSuffix + ".Block"); + if (craftMagicNumbers != null && blockClass != null) { + craftMagicNumbers_getMaterial = craftMagicNumbers.getMethod("getMaterial", blockClass); + } + } catch (NoSuchMethodException e) { + CSLLogger.debug(() -> "[SpigotNMS] CraftMagicNumbers.getMaterial not found"); + craftMagicNumbers_getMaterial = null; + } + + CSLLogger.debug(() -> "[SpigotNMS] Initialization successful for " + versionSuffix); + return true; + + } catch (Exception e) { + Bukkit.getLogger().warning("[SpigotNMS] Initialization failed: " + e.getMessage()); + return false; + } + } + + @Override + protected Material getMaterialAtImpl(World world, int x, int y, int z) { + if (!initialized) { + return null; + } + + try { + // Get NMS WorldServer from CraftWorld + Object worldServer = craftWorld_getHandle.invoke(world); + if (worldServer == null) { + return null; + } + + // Create BlockPosition + Object blockPosition = blockPositionConstructor.newInstance(x, y, z); + + // Get IBlockData + Object iBlockData = getType.invoke(worldServer, blockPosition); + if (iBlockData == null) { + return null; + } + + // Get Block from IBlockData + if (getBlock != null && craftMagicNumbers_getMaterial != null) { + try { + Object block = getBlock.invoke(iBlockData); + Object result = craftMagicNumbers_getMaterial.invoke(null, block); + if (result instanceof Material) { + return (Material) result; + } + } catch (Exception e) { + CSLLogger.debug(() -> "[SpigotNMS] Material conversion failed: " + e.getMessage()); + } + } + + return null; + + } catch (Exception e) { + CSLLogger.debug(() -> "[SpigotNMS] Error getting material: " + e.getMessage()); + return null; + } + } + + @Override + public boolean isSupported() { + return initialized; + } + + @Override + public String getImplementationName() { + return "SpigotNMS" + (versionSuffix != null ? " (" + versionSuffix + ")" : ""); + } + + // Helper methods + + private Class loadClass(String name) { + try { + return Class.forName(name); + } catch (ClassNotFoundException e) { + return null; + } + } + + private Method findMethod(Class clazz, Class paramType, String... names) { + for (String name : names) { + try { + return clazz.getMethod(name, paramType); + } catch (NoSuchMethodException ignored) { + } + } + return null; + } +} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/scanner/util/MinecraftVersion.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/scanner/util/MinecraftVersion.java new file mode 100644 index 0000000..317a40f --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/reflection/scanner/util/MinecraftVersion.java @@ -0,0 +1,182 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.reflection.scanner.util; + +import org.bukkit.Bukkit; +import org.jetbrains.annotations.Contract; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +/** + * Utility for detecting and comparing Minecraft server versions. + * Supports version detection from Bukkit.getVersion() and package names. + */ +public class MinecraftVersion implements Comparable { + private final int major; + private final int minor; + private final int patch; + private final String raw; + + private static final Pattern VERSION_PATTERN = Pattern.compile("(\\d+)\\.(\\d+)(?:\\.(\\d+))?"); + + private MinecraftVersion(int major, int minor, int patch, String raw) { + this.major = major; + this.minor = minor; + this.patch = patch; + this.raw = raw; + } + + /** + * Detect the current Minecraft version from the running server. + */ + public static @NotNull MinecraftVersion detect() { + try { + String version = Bukkit.getVersion(); + return parse(version); + } catch (Exception e) { + Bukkit.getLogger().warning("[MinecraftVersion] Failed to detect version: " + e.getMessage()); + return new MinecraftVersion(1, 0, 0, "unknown"); + } + } + + /** + * Parse a version string like "1.20.4" or "git-Paper-448 (MC: 1.20.4)" + */ + @Contract("null -> new") + public static @NotNull MinecraftVersion parse(String versionString) { + if (versionString == null || versionString.isEmpty()) { + return new MinecraftVersion(1, 0, 0, versionString); + } + + Matcher matcher = VERSION_PATTERN.matcher(versionString); + if (matcher.find()) { + int major = Integer.parseInt(matcher.group(1)); + int minor = Integer.parseInt(matcher.group(2)); + int patch = matcher.group(3) != null ? Integer.parseInt(matcher.group(3)) : 0; + return new MinecraftVersion(major, minor, patch, versionString); + } + + return new MinecraftVersion(1, 0, 0, versionString); + } + + /** + * Check if this version is at least the specified version. + */ + public boolean isAtLeast(int major, int minor) { + return isAtLeast(major, minor, 0); + } + + /** + * Check if this version is at least the specified version. + */ + public boolean isAtLeast(int major, int minor, int patch) { + if (this.major > major) return true; + if (this.major < major) return false; + + if (this.minor > minor) return true; + if (this.minor < minor) return false; + + return this.patch >= patch; + } + + /** + * Check if this version is between min (inclusive) and max (exclusive). + */ + public boolean isBetween(MinecraftVersion min, MinecraftVersion max) { + return this.compareTo(min) >= 0 && this.compareTo(max) < 0; + } + + /** + * Check if this is a modern version (1.17+) with Mojang mappings. + */ + public boolean isModern() { + return isAtLeast(1, 17); + } + + /** + * Check if this is a Spigot-era version (1.13-1.16) with version suffixes. + */ + public boolean isSpigot() { + return isAtLeast(1, 13) && !isAtLeast(1, 17); + } + + /** + * Check if this is a legacy version (1.8.8-1.12) with old NMS structure. + */ + public boolean isLegacy() { + return isAtLeast(1, 8, 8) && !isAtLeast(1, 13); + } + + /** + * Get the version suffix from the CraftBukkit package (e.g., "v1_20_R3"). + * Returns null if not in legacy/spigot format. + */ + public static @Nullable String detectVersionSuffix() { + try { + String packageName = Bukkit.getServer().getClass().getPackage().getName(); + // e.g. "org.bukkit.craftbukkit.v1_20_R3" + + int index = packageName.indexOf("craftbukkit"); + if (index != -1) { + String after = packageName.substring(index + "craftbukkit".length()); + if (after.startsWith(".")) { + after = after.substring(1); + } + if (after.startsWith("v")) { + return after; + } + } + return null; + } catch (Exception e) { + return null; + } + } + + public int getMajor() { + return major; + } + + public int getMinor() { + return minor; + } + + public int getPatch() { + return patch; + } + + public String getRaw() { + return raw; + } + + @Override + public int compareTo(MinecraftVersion other) { + if (this.major != other.major) { + return Integer.compare(this.major, other.major); + } + if (this.minor != other.minor) { + return Integer.compare(this.minor, other.minor); + } + return Integer.compare(this.patch, other.patch); + } + + @Override + public String toString() { + return major + "." + minor + (patch > 0 ? "." + patch : ""); + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (!(o instanceof MinecraftVersion that)) return false; + return major == that.major && minor == that.minor && patch == that.patch; + } + + @Override + public int hashCode() { + int result = major; + result = 31 * result + minor; + result = 31 * result + patch; + return result; + } +} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/Checks.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/Checks.java new file mode 100644 index 0000000..632e61d --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/Checks.java @@ -0,0 +1,51 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.removal; + +import com.github.sarhatabaot.chunkspawnerlimiter.PluginConfig; +import com.github.sarhatabaot.chunkspawnerlimiter.reflection.RaidReflection; +import org.bukkit.entity.Entity; +import org.bukkit.entity.Player; + +public class Checks { + private static PluginConfig pluginConfig; + + public static void setup(PluginConfig pluginConfig) { + Checks.pluginConfig = pluginConfig; + } + + //is player & kill players is disabled + public static boolean shouldSkipPlayers(final Entity entity) { + return entity instanceof Player && !pluginConfig.isKillPlayers(); + } + + public static boolean hasCustomName(final Entity entity) { + if (!pluginConfig.shouldPreserveNamedEntities()) { + return false; + } + return entity.getCustomName() != null; + } + + + public static boolean isPartOfRaid(Entity entity) { + if (!pluginConfig.shouldPreserveRaidEntities()) { + return false; + } + + return RaidReflection.isEntityInRaid(entity); + } + + public static boolean hasMetaData(final Entity entity) { + if (pluginConfig.getIgnoreMetadata().isEmpty()) { + return false; + } + + for (final String metadata: pluginConfig.getIgnoreMetadata()) { + if (entity.hasMetadata(metadata)) + return true; + } + return false; + } + + public static boolean isUnderOrEqualToLimit(int count, int limit) { + return count + 1 <= limit; + } +} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/ExternalChecks.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/ExternalChecks.java new file mode 100644 index 0000000..0e0556f --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/ExternalChecks.java @@ -0,0 +1,35 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.removal; + +import com.github.sarhatabaot.chunkspawnerlimiter.PluginConfig; +import de.tr7zw.nbtapi.NBT; +import org.bukkit.Bukkit; +import org.bukkit.entity.Entity; + +public class ExternalChecks { + private static PluginConfig pluginConfig; + private static boolean hasNbtApi = false; + + public static void setup(PluginConfig pluginConfig) { + ExternalChecks.pluginConfig = pluginConfig; + + if (Bukkit.getPluginManager().getPlugin("NBT-API") != null) { + ExternalChecks.hasNbtApi = true; + } + + } + + public static boolean hasNbtData(final Entity entity) { + if (!hasNbtApi || pluginConfig.getIgnoreNbt().isEmpty()) + return false; + + for (String ignore: pluginConfig.getIgnoreNbt()) { + boolean hasNbt = NBT.get(entity, nbt -> { + return nbt.hasTag(ignore); + }); + if (hasNbt) { + return true; + } + } + return false; + } +} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/RemovalTaskManager.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/RemovalTaskManager.java new file mode 100644 index 0000000..7ceeacb --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/RemovalTaskManager.java @@ -0,0 +1,154 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.removal; + +import com.github.sarhatabaot.chunkspawnerlimiter.CSLLogger; +import com.github.sarhatabaot.chunkspawnerlimiter.ChunkSpawnerLimiter; +import com.github.sarhatabaot.chunkspawnerlimiter.PluginConfig; +import com.github.sarhatabaot.chunkspawnerlimiter.chunk.ChunkCoord; +import com.github.sarhatabaot.chunkspawnerlimiter.counter.CounterData; +import com.github.sarhatabaot.chunkspawnerlimiter.counter.CounterDataManager; +import org.bukkit.Bukkit; +import org.bukkit.Chunk; +import org.bukkit.entity.Entity; +import org.bukkit.entity.EntityType; + +import java.util.*; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.ConcurrentLinkedQueue; +import java.util.function.Consumer; + +public class RemovalTaskManager { + private final static long TICKS_PER_SECOND = 20L; + private final Queue pendingChunks = new ConcurrentLinkedQueue<>(); + private final Set queuedChunks = + Collections.newSetFromMap(new ConcurrentHashMap<>()); + + // Map of chunks that should be rechecked after a delay (timestamp in ms) + private final Map> scheduledRechecks = new ConcurrentHashMap<>(); + + private final CounterDataManager counterDataManager; + private final ChunkSpawnerLimiter plugin; + private final PluginConfig pluginConfig; + + public RemovalTaskManager(ChunkSpawnerLimiter plugin, CounterDataManager counterDataManager, PluginConfig pluginConfig) { + this.plugin = plugin; + this.counterDataManager = counterDataManager; + this.pluginConfig = pluginConfig; + startProcessingTask(); + } + + /** + * Schedule this chunk to be checked again after X seconds. + */ + public void scheduleRecheck(ChunkCoord coord, Consumer action, long delaySeconds) { + long nextCheck = System.currentTimeMillis() + (delaySeconds * 1000L); + scheduledRechecks.computeIfAbsent(coord, k -> new ArrayList<>()).add(new DelayedQueuedCheck(action, nextCheck)); + CSLLogger.debug(() -> "Scheduled recheck for chunk %s in %d seconds".formatted(coord, delaySeconds)); + } + + + public void queueChunkCheck(ChunkCoord coord, Consumer action) { + if (queuedChunks.add(coord)) { + pendingChunks.add(new QueuedCheck(coord, action)); + } + } + + public void removeChunkRecheck(ChunkCoord coord) { + scheduledRechecks.remove(coord); + } + + private void startProcessingTask() { + Bukkit.getScheduler().runTaskTimer(plugin, this::processQueue, TICKS_PER_SECOND, TICKS_PER_SECOND); // every 1 second + } + + private void processQueue() { + QueuedCheck check; + while ((check = pendingChunks.poll()) != null) { + processChunk(check.coord, check.action); + queuedChunks.remove(check.coord); + } + + long now = System.currentTimeMillis(); + for (Iterator>> it = scheduledRechecks.entrySet().iterator(); it.hasNext();) { + Map.Entry> entry = it.next(); + if (shouldPurgeScheduled(entry.getKey())) { + it.remove(); + continue; + } + List list = entry.getValue(); + list.removeIf(delayed -> { + if (delayed.timestamp <= now) { + queueChunkCheck(entry.getKey(), delayed.action); + return true; + } + return false; + }); + if (list.isEmpty()) { + it.remove(); + } + } + } + + private boolean shouldPurgeScheduled(ChunkCoord coord) { + var world = coord.getWorld(); + return world == null || pluginConfig.isWorldDisabled(world.getName()); + } + + public void processChunk(ChunkCoord coord, Consumer removalAction) { + CounterData data = counterDataManager.getCounterData(coord); + if (data == null) return; + + Chunk chunk = coord.getChunk(); + if (chunk == null || !chunk.isLoaded()) return; + + // Group entities by tracked type in a single pass + Map> entitiesByType = new EnumMap<>(EntityType.class); + + for (Entity entity : chunk.getEntities()) { + EntityType type = entity.getType(); + + if (!data.getTrackedEntityTypes().contains(type)) continue; + + entitiesByType + .computeIfAbsent(type, t -> new ArrayList<>()) + .add(entity); + } + + // Apply resolved limits per entity type (includes group limits already) + for (Map.Entry> entry : entitiesByType.entrySet()) { + EntityType type = entry.getKey(); + List entities = entry.getValue(); + + Integer allowed = pluginConfig.getResolvedEntityLimit(type); + if (allowed == null) { + CSLLogger.debug(() -> + "No limit found for entity type: %s, skipping".formatted(type.name()) + ); + continue; + } + + int toRemove = entities.size() - allowed; + if (toRemove <= 0) continue; + + int size = entities.size(); + for (int i = 0; i < toRemove && i < size; i++) { + Entity entity = entities.get(i); + if (shouldSkipRemoval(entity)) continue; + removalAction.accept(entity); + } + } + } + + private boolean shouldSkipRemoval(final Entity entity) { + // Return false (skip removal) if any preservation check passes + return Checks.hasCustomName(entity) || Checks.hasMetaData(entity) || ExternalChecks.hasNbtData(entity) || Checks.isPartOfRaid(entity); + } + + + private record QueuedCheck(ChunkCoord coord, Consumer action) { + } + + private record DelayedQueuedCheck(Consumer action, long timestamp) { + } + + +} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/modes/Enforce.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/modes/Enforce.java new file mode 100644 index 0000000..a605e92 --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/modes/Enforce.java @@ -0,0 +1,67 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.removal.modes; + +import com.github.sarhatabaot.chunkspawnerlimiter.chunk.ChunkCoord; +import com.github.sarhatabaot.chunkspawnerlimiter.removal.RemovalTaskManager; +import org.bukkit.block.Block; +import org.bukkit.entity.Entity; +import org.bukkit.entity.Player; +import org.bukkit.entity.Vehicle; +import org.bukkit.event.Cancellable; +import org.bukkit.event.block.BlockPlaceEvent; +import org.bukkit.inventory.ItemStack; +import org.jetbrains.annotations.Contract; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +import java.util.function.Consumer; + +public final class Enforce implements RemovalMode { + private final RemovalTaskManager removalTaskManager; + + public Enforce(RemovalTaskManager removalTaskManager) { + this.removalTaskManager = removalTaskManager; + } + + + @Contract(pure = true) + public @NotNull String getKey() { + return "enforce"; + } + + + @Override + public void handleEntity(@NotNull Entity entity, @Nullable Cancellable event) { + if (event != null) { + event.setCancelled(true); + } + + if (entity instanceof Vehicle) { + entity.remove(); + } + + ChunkCoord coord = ChunkCoord.from(entity.getLocation().getChunk()); + removalTaskManager.queueChunkCheck(coord, getEntityRemovalAction()); + } + + @Override + public Consumer getEntityRemovalAction() { + return e -> { + if (e instanceof Player player) { + player.setHealth(0); + } else { + e.remove(); + } + }; + } + + @Override + public void handleBlock(@NotNull Block block, @NotNull Cancellable event) { + event.setCancelled(true); + + if (event instanceof BlockPlaceEvent blockPlaceEvent) { + final ItemStack itemReturned = blockPlaceEvent.getItemInHand(); + itemReturned.setAmount(1); + blockPlaceEvent.getPlayer().getInventory().addItem(itemReturned); + } + } +} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/modes/EnforceKill.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/modes/EnforceKill.java new file mode 100644 index 0000000..c8cc3b1 --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/modes/EnforceKill.java @@ -0,0 +1,51 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.removal.modes; + +import com.github.sarhatabaot.chunkspawnerlimiter.chunk.ChunkCoord; +import com.github.sarhatabaot.chunkspawnerlimiter.removal.RemovalTaskManager; +import org.bukkit.block.Block; +import org.bukkit.entity.Entity; +import org.bukkit.entity.LivingEntity; +import org.bukkit.event.Cancellable; +import org.jetbrains.annotations.Contract; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +import java.util.function.Consumer; + +public final class EnforceKill implements RemovalMode { + private final RemovalTaskManager removalTaskManager; + public EnforceKill(RemovalTaskManager removalTaskManager) { + this.removalTaskManager = removalTaskManager; + } + + + @Contract(pure = true) + public @NotNull String getKey() { return "enforce-kill"; } + + @Override + public void handleEntity(@NotNull Entity entity, @Nullable Cancellable event) { + if (event != null) { + event.setCancelled(true); + } + + ChunkCoord coord = ChunkCoord.from(entity.getLocation().getChunk()); + removalTaskManager.queueChunkCheck(coord, getEntityRemovalAction()); + } + + @Contract(pure = true) + @Override + public @NotNull Consumer getEntityRemovalAction() { + return e -> { + if (e instanceof LivingEntity living) { + living.setHealth(0); + } else { + e.remove(); + } + }; + } + + @Override + public void handleBlock(@NotNull Block block, @NotNull Cancellable event) { + event.setCancelled(true); + } +} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/modes/Kill.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/modes/Kill.java new file mode 100644 index 0000000..f4419d4 --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/modes/Kill.java @@ -0,0 +1,49 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.removal.modes; + +import com.github.sarhatabaot.chunkspawnerlimiter.chunk.ChunkCoord; +import com.github.sarhatabaot.chunkspawnerlimiter.removal.RemovalTaskManager; +import org.bukkit.block.Block; +import org.bukkit.entity.Entity; +import org.bukkit.entity.LivingEntity; +import org.bukkit.event.Cancellable; +import org.jetbrains.annotations.Contract; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +import java.util.function.Consumer; + +public final class Kill implements RemovalMode { + private final RemovalTaskManager removalTaskManager; + public Kill(RemovalTaskManager removalTaskManager) { + this.removalTaskManager = removalTaskManager; + } + + @Contract(pure = true) + public @NotNull String getKey() { return "kill"; } + + @Override + public void handleEntity(@NotNull Entity entity, @Nullable Cancellable event) { + final Consumer action = getEntityRemovalAction(); + + action.accept(entity); + + ChunkCoord coord = ChunkCoord.from(entity.getLocation().getChunk()); + removalTaskManager.queueChunkCheck(coord, action); + } + + @Override + public Consumer getEntityRemovalAction() { + return e -> { + if (e instanceof LivingEntity living) { + living.setHealth(0); + } else { + e.remove(); + } + }; + } + + @Override + public void handleBlock(@NotNull Block block, @NotNull Cancellable event) { + block.breakNaturally(); + } +} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/modes/Prevent.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/modes/Prevent.java new file mode 100644 index 0000000..6f70000 --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/modes/Prevent.java @@ -0,0 +1,37 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.removal.modes; + +import org.bukkit.block.Block; +import org.bukkit.entity.Entity; +import org.bukkit.entity.Vehicle; +import org.bukkit.event.Cancellable; +import org.jetbrains.annotations.Contract; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +import java.util.function.Consumer; + +public final class Prevent implements RemovalMode { + @Contract(pure = true) + public @NotNull String getKey() { return "prevent"; } + + @Override + public void handleEntity(@NotNull Entity entity, @Nullable Cancellable event) { + if (event != null) { + event.setCancelled(true); + } + + if (entity instanceof Vehicle) { + entity.remove(); + } + } + + @Override + public Consumer getEntityRemovalAction() { + return null; + } + + @Override + public void handleBlock(@NotNull Block block,@NotNull Cancellable event) { + event.setCancelled(true); + } +} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/modes/RemovalMode.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/modes/RemovalMode.java new file mode 100644 index 0000000..504d153 --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/modes/RemovalMode.java @@ -0,0 +1,107 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.removal.modes; + +import com.github.sarhatabaot.chunkspawnerlimiter.removal.RemovalTaskManager; +import org.bukkit.block.Block; +import org.bukkit.entity.Entity; +import org.bukkit.event.Cancellable; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +import javax.annotation.concurrent.NotThreadSafe; +import java.util.HashMap; +import java.util.Map; +import java.util.function.Consumer; + +/** + * Defines a strategy for handling block and entity limit violations. + *

+ * Each {@link RemovalMode} represents a distinct behavior, such as preventing, + * removing, killing, or enforcing limits on entities or blocks. + *

+ * Implementations are registered via {@link #setup(RemovalTaskManager)} and + * retrieved using {@link #fromString(String)}. + * + *

Thread safety

+ * This interface is not thread-safe due to the use of a mutable + * static {@link HashMap} for mode registration. It is expected to be initialized + * during plugin startup on the main server thread. + */ +@NotThreadSafe +public sealed interface RemovalMode + permits Prevent, Remove, Kill, Enforce, EnforceKill { + + /** + * Returns the unique string key identifying this removal mode. + * + * @return the mode key (lowercase, human-readable) + */ + @NotNull + String getKey(); + + /** + * Handles an entity that violates a configured limit. + * + * @param entity the affected entity + * @param event the associated cancellable event, or {@code null} if none exists + */ + void handleEntity(@NotNull Entity entity, @Nullable Cancellable event); + + /** + * Handles a block that violates a configured limit. + * + * @param block the affected block + * @param event the cancellable event associated with the block placement or action + */ + void handleBlock(@NotNull Block block, @NotNull Cancellable event); + + /** + * Returns the action used to remove or otherwise process entities for this mode. + * + * @return a consumer that performs the entity removal action + */ + Consumer getEntityRemovalAction(); + + /** + * Registry of all available removal modes, keyed by their string identifiers. + *

+ * This map is populated during plugin initialization. + */ + Map MODES = new HashMap<>(); + + /** + * Initializes and registers all available removal modes. + *

+ * This method should be called once during plugin startup and is not safe + * to call concurrently. + * + * @param removalTaskManager the task manager used by modes that require + * scheduled or asynchronous removal logic + */ + static void setup(@NotNull RemovalTaskManager removalTaskManager) { + reload(removalTaskManager); + } + + static void reload(@NotNull RemovalTaskManager removalTaskManager) { + MODES.clear(); // Safe to clear and rebuild + MODES.put("prevent", new Prevent()); + MODES.put("remove", new Remove(removalTaskManager)); + MODES.put("kill", new Kill(removalTaskManager)); + MODES.put("enforce", new Enforce(removalTaskManager)); + MODES.put("enforce-kill", new EnforceKill(removalTaskManager)); + } + + /** + * Resolves a removal mode from its string representation. + * + * @param mode the mode name + * @return the corresponding {@link RemovalMode}, or {@code "enforce"} if the + * provided mode is unknown + */ + static @NotNull RemovalMode fromString(@NotNull String mode) { + if (mode == null) { + return MODES.get("enforce"); + } + + return MODES.getOrDefault(mode.toLowerCase(), MODES.get("enforce")); + } +} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/modes/Remove.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/modes/Remove.java new file mode 100644 index 0000000..8394905 --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/modes/Remove.java @@ -0,0 +1,47 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.removal.modes; + +import com.github.sarhatabaot.chunkspawnerlimiter.chunk.ChunkCoord; +import com.github.sarhatabaot.chunkspawnerlimiter.removal.RemovalTaskManager; +import org.bukkit.block.Block; +import org.bukkit.entity.Entity; +import org.bukkit.entity.Player; +import org.bukkit.event.Cancellable; +import org.jetbrains.annotations.Contract; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +import java.util.function.Consumer; + +public final class Remove implements RemovalMode { + private final RemovalTaskManager removalTaskManager; + public Remove(RemovalTaskManager removalTaskManager) { + this.removalTaskManager = removalTaskManager; + } + + @Contract(pure = true) + public @NotNull String getKey() { return "remove"; } + + @Override + public void handleEntity(@NotNull Entity entity, @Nullable Cancellable event) { + entity.remove(); + + ChunkCoord coord = ChunkCoord.from(entity.getLocation().getChunk()); + removalTaskManager.queueChunkCheck(coord, getEntityRemovalAction()); + } + + @Override + public void handleBlock(@NotNull Block block, @NotNull Cancellable event) { + block.setType(org.bukkit.Material.AIR); + } + + @Override + public Consumer getEntityRemovalAction() { + return e -> { + if (e instanceof Player player) { + player.setHealth(0); + } else { + e.remove(); + } + }; + } +} diff --git a/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/util/SpawnEggUtil.java b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/util/SpawnEggUtil.java new file mode 100644 index 0000000..5eb9fd3 --- /dev/null +++ b/src/main/java/com/github/sarhatabaot/chunkspawnerlimiter/util/SpawnEggUtil.java @@ -0,0 +1,101 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.util; + +import org.bukkit.Location; +import org.bukkit.Material; +import org.bukkit.entity.EntityType; +import org.bukkit.inventory.ItemStack; + +/** + * Utility class for handling spawn egg operations, specifically for returning eggs to players + * when entity spawn events are cancelled by removal modes. + * + * This class is designed to work with Minecraft 1.8.8 and uses the legacy MONSTER_EGG system. + */ +public class SpawnEggUtil { + + /** + * Checks if a spawn reason indicates the entity was spawned from a spawn egg. + * + * @param spawnReason the spawn reason to check + * @return true if the spawn reason indicates a spawn egg was used + */ + public static boolean isSpawnEggSpawn(String spawnReason) { + if (spawnReason == null) { + return false; + } + + // Convert to uppercase for comparison + String reason = spawnReason.toUpperCase(); + + // Check for various spawn egg related reasons + return reason.contains("EGG") || + reason.equals("SPAWNER") || + reason.equals("SPAWNER_EGG") || + reason.equals("DISPENSER"); // Dispenser can also spawn eggs + } + + /** + * Gets the corresponding spawn egg material for a given entity type. + * For Minecraft 1.8.8 compatibility, this uses the legacy MONSTER_EGG system. + * + * @param entityType the entity type to get the spawn egg for + * @return the Material for the spawn egg, or null if not found + */ + public static Material getSpawnEggMaterial(EntityType entityType) { + if (entityType == null) { + return null; + } + + try { + // For 1.8.8 compatibility, we use the legacy monster egg system + // Most entities use MONSTER_EGG with metadata to determine the entity type + return Material.MONSTER_EGG; + } catch (IllegalArgumentException e) { + // If MONSTER_EGG doesn't exist, try the modern system + try { + String materialName = entityType.name() + "_SPAWN_EGG"; + return Material.valueOf(materialName); + } catch (IllegalArgumentException e2) { + // If neither works, return null + return null; + } + } + } + + /** + * Creates an ItemStack representing a spawn egg for the given entity type. + * + * @param entityType the entity type + * @return an ItemStack for the spawn egg, or null if not supported + */ + public static ItemStack createSpawnEggItem(EntityType entityType) { + Material eggMaterial = getSpawnEggMaterial(entityType); + if (eggMaterial == null) { + return null; + } + + return new ItemStack(eggMaterial, 1); + } + + /** + * Drops a spawn egg at the specified location for the given entity type. + * + * @param entityType the entity type that was spawned + * @param location the location where the egg should be dropped + * @return true if the egg was successfully dropped, false otherwise + */ + public static boolean dropSpawnEgg(EntityType entityType, Location location) { + if (entityType == null || location == null) { + return false; + } + + ItemStack eggItem = createSpawnEggItem(entityType); + if (eggItem == null) { + return false; + } + + // Drop the item at the location + location.getWorld().dropItemNaturally(location, eggItem); + return true; + } +} diff --git a/src/main/resources/blocks.yml b/src/main/resources/blocks.yml deleted file mode 100644 index bcc85be..0000000 --- a/src/main/resources/blocks.yml +++ /dev/null @@ -1,28 +0,0 @@ -# Should this feature be enabled? -enabled: false - -# Should we notify the player via a message or a title? -notify: - title: true - message: false - -# Default values for the chunk checker, since y values can be different depending on the world generated. -# Leave this alone if you haven't modified your max world height. -count: - default: - min-y: -64 - max-y: 256 - # You can specify specific worlds to have a different checking range. - worlds: - world_nether: - min-y: 0 - max-y: 128 - -# Use cache only for high-limit materials -cache: - min-limit-for-cache: 50 - -# Set blocks to block per chunk -# Anything from https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html is supported. -blocks: - SPAWNER: 10 \ No newline at end of file diff --git a/src/main/resources/config.yml b/src/main/resources/config.yml index 0b2d8ba..39fe812 100644 --- a/src/main/resources/config.yml +++ b/src/main/resources/config.yml @@ -1,123 +1,119 @@ -properties: - # Show debug messages. - debug-messages: false - - # Check a chunk upon load (ChunkLoadEvent). - check-chunk-load: false - - # Check a chunk upon unload (ChunkUnloadEvent). - check-chunk-unload: false - - # When a chunk is loaded, recheck it periodically. - # Check-chunk-load must be true for this to work. - active-inspections: true - - # Check a chunk when a mob spawns (CreatureSpawnEvent). - watch-creature-spawns: true - - # Check a chunk when a vehicle spawns (VehicleCreateEvent). - watch-vehicle-create-event: true - - # Check a chunk when an entity spawns (ArmorStand) - watch-entity-spawns: true - - # Radius of surrounding chunks to check. - check-surrounding-chunks: 1 - - # How often, in seconds, to check the chunk. - inspection-frequency: 300 - - # Notify players in that chunk if stuff has been culled. - notify-players: false - - # Prioritize entities without names over older entities. - preserve-named-entities: true - - # Don't remove pillagers that are part of a raid. - preserve-raid-entities: true - - # Ignore entities with any of the following metadata. - ignore-metadata: - - shopkeeper - - kill-instead-of-remove: false - - # Only relevant if kill-instead-of-remove is used (unless paper's tick setting is set to false) - # Drops the items from the armor stands, i.e. helmet, etc - drop-items-from-armor-stands: false - - log-armor-stand-tick-warning: true - -# Spawn reasons to cull on. -spawn-reasons: - BREEDING: true - BUILD_IRONGOLEM: true - BUILD_SNOWMAN: true - BUILD_WITHER: true - CHUNK_GEN: true - DEFAULT: true - DISPENSE_EGG: true - DROWNED: true - EGG: true - JOCKEY: true - LIGHTNING: true - MOUNT: true - NATURAL: true - NETHER_PORTAL: true - OCELOT_BABY: true - REINFORCEMENTS: true #proabably animals - SILVERFISH_BLOCK: true - SPAWNER: true - SPAWNER_EGG: true - TRAP: true - VILLAGE_DEFENSE: true - VILLAGE_INVASION: true - +# Main toggle and debug settings +enabled: true +debug-messages: false +metrics: true + +# This config is written with 1.21.10 in mind, but is still compatible with earlier versions. Make sure to convert the values +# Event monitoring configuration +events: + spawn: + creature: true + vehicle: true + entity: true + inspections: + # This will recheck loaded chunks every {frequency} seconds + enabled: true + frequency: 60 + +# Entity management settings entities: - ANIMAL: 50 - MONSTER: 50 - NPC: 50 - OTHER: 500 -# WATER_MOB: 5 -# AMBIENT: 5 -# CREEPER: 10 -# SHEEP: 10 -# OCELOT: 10 -# GIANT: 10 -# SLIME: 10 -# GHAST: 10 -# PIG_ZOMBIE: 10 -# ENDERMAN: 10 -# SILVERFISH: 10 -# MAGMA_CUBE: 10 -# CHICKEN: 10 -# SQUID: 10 -# WOLF: 10 -# MUSHROOM_COW: 10 -# SNOWMAN: 10 -# VILLAGER: 10 -# SPIDER: 10 -# SKELETON: 10 -# ZOMBIE: 10 -# BLAZE: 10 -# CAVE_SPIDER: 10 -# IRON_GOLEM: 10 -# WITHER: 10 -# PIG: 10 -# HORSE: 10 -# WITCH: 10 - -# Exclude these worlds from limits. + entity-groups: + ANIMALS: + - COW + - SHEEP + - PIG + - CHICKEN + MONSTERS: + - ZOMBIE + - SKELETON + - CREEPER + NPC: + - VILLAGER + VEHICLE: + - MINECART + limits: + ANIMALS: 50 + MONSTERS: 50 + NPC: 50 + OTHER: 500 + preservation: + named-entities: true + raid-entities: true + removal: + mode: "enforce" + # Options: + # "enforce" - Actively clean up existing chunks (remove) AND prevent new violations + # "enforce-kill" - Actively clean up existing chunks (kill) AND prevent new violations + # "prevent" - Only prevent new entities/blocks from exceeding limits + # "remove" - Instantly remove excess entities without effects + # "kill" - Kill excess entities with death effects/drops + armor-stand: + drop: false + log-warnings: true + # This will allow players to be killed by CSL, if they reach the set limit in entities. + # This will work with kill, remove, enforce & enforce kill. Since we can't "remove" players in those modes the players will be killed. + kill-players: false + ignore: + metadata: + - shopkeeper + # This will only work if you have NBTAPI Installed https://modrinth.com/plugin/nbtapi + nbt: + - "tag" + +# Spawn reason filtering +# To disable, just remove what you don't want. +spawn-reasons: + - "BREEDING" + - "BUILD_IRONGOLEM" + - "BUILD_SNOWMAN" + - "BUILD_WITHER" + - "CHUNK_GEN" + - "DEFAULT" + - "DISPENSE_EGG" + - "DROWNED" + - "EGG" + - "JOCKEY" + - "LIGHTNING" + - "MOUNT" + - "NATURAL" + - "NETHER_PORTAL" + - "OCELOT_BABY" + - "REINFORCEMENTS" + - "SILVERFISH_BLOCK" + - "SPAWNER" + - "SPAWNER_EGG" + - "TRAP" + - "VILLAGE_DEFENSE" + - "VILLAGE_INVASION" + +# Block restrictions +blocks: + block-groups: + basic: + - "STONE" + - "DIRT" + ores: + - "DIAMOND_BLOCK" + - "GOLD_BLOCK" + limits: + SPAWNER: 10 + +# World configuration worlds: - # Can be "excluded" or "included" - mode: excluded - worlds: [] - -messages: - removedEntities: "&7Removed %s %s in your chunk." - reloadedConfig: "&cReloaded csl config." - maxAmountBlocks: "&6Cannot place more &4{material}&6. Max amount per chunk &2{amount}." - maxAmountBlocksTitle: "&6Cannot place more &4{material}&6." - maxAmountBlocksSubtitle: "&6Max amount per chunk &2{amount}." - -metrics: true \ No newline at end of file + mode: excluded # "excluded" or "included" + list: [] + +# Player notification settings +notifications: + enabled: false + cooldown-seconds: 3 + method: + title: true + message: false + messages: + entities-blocked: "&7Blocked {count} {type} from spawning in your chunk." + entities-removed: "&7Removed {count} {type} in your chunk." + reload-complete: "&cReloaded csl config." + max-blocks: "&6Cannot place more &4{material}&6. Max amount per chunk &2{amount}." + max-blocks-title: "&6Cannot place more &4{material}&6." + max-blocks-subtitle: "&6Max amount per chunk &2{amount}." diff --git a/src/test/java/com/github/sarhatabaot/chunkspawnerlimiter/ReflectionTests.java b/src/test/java/com/github/sarhatabaot/chunkspawnerlimiter/ReflectionTests.java new file mode 100644 index 0000000..0422eeb --- /dev/null +++ b/src/test/java/com/github/sarhatabaot/chunkspawnerlimiter/ReflectionTests.java @@ -0,0 +1,20 @@ +package com.github.sarhatabaot.chunkspawnerlimiter; + +import org.junit.jupiter.api.Test; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +public class ReflectionTests { + + @Test + public void testExtractVersionFromPackage() { + String pkg = "org.bukkit.craftbukkit.v1_20_R3"; + String[] parts = pkg.split("\\."); + + assertEquals("v1_20_R3", parts[3]); + + String className = "org.bukkit.craftbukkit." + parts[3] + ".CraftWorld"; + assertEquals("org.bukkit.craftbukkit.v1_20_R3.CraftWorld", className); + } + +} diff --git a/src/test/java/com/github/sarhatabaot/chunkspawnerlimiter/counter/CounterDataTest.java b/src/test/java/com/github/sarhatabaot/chunkspawnerlimiter/counter/CounterDataTest.java new file mode 100644 index 0000000..7267f8e --- /dev/null +++ b/src/test/java/com/github/sarhatabaot/chunkspawnerlimiter/counter/CounterDataTest.java @@ -0,0 +1,264 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.counter; + +import org.bukkit.Material; +import org.bukkit.entity.EntityType; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; + +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.TimeUnit; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Comprehensive test suite for CounterData. + * Tests thread-safe counting operations for blocks and entities. + */ +@DisplayName("CounterData Tests") +class CounterDataTest { + + private CounterData counterData; + + @BeforeEach + void setUp() { + counterData = new CounterData(); + } + + @Test + @DisplayName("Should initialize with zero counts") + void shouldInitializeWithZeroCounts() { + assertThat(counterData.getBlockCount(Material.STONE)).isZero(); + assertThat(counterData.getEntityCount(EntityType.ZOMBIE)).isZero(); + } + + @Test + @DisplayName("Should increment block counts correctly") + void shouldIncrementBlockCountsCorrectly() { + // When + counterData.incrementBlock(Material.STONE); + counterData.incrementBlock(Material.STONE); + counterData.incrementBlock(Material.DIRT); + + // Then + assertThat(counterData.getBlockCount(Material.STONE)).isEqualTo(2); + assertThat(counterData.getBlockCount(Material.DIRT)).isEqualTo(1); + assertThat(counterData.getBlockCount(Material.SAND)).isZero(); + } + + @Test + @DisplayName("Should increment entity counts correctly") + void shouldIncrementEntityCountsCorrectly() { + // When + counterData.incrementEntity(EntityType.ZOMBIE); + counterData.incrementEntity(EntityType.ZOMBIE); + counterData.incrementEntity(EntityType.SKELETON); + + // Then + assertThat(counterData.getEntityCount(EntityType.ZOMBIE)).isEqualTo(2); + assertThat(counterData.getEntityCount(EntityType.SKELETON)).isEqualTo(1); + assertThat(counterData.getEntityCount(EntityType.CREEPER)).isZero(); + } + + @Test + @DisplayName("Should decrement block counts correctly") + void shouldDecrementBlockCountsCorrectly() { + // Given + counterData.setBlockCount(Material.STONE, 5); + + // When + counterData.decrementBlock(Material.STONE); + counterData.decrementBlock(Material.STONE); + + // Then + assertThat(counterData.getBlockCount(Material.STONE)).isEqualTo(3); + } + + @Test + @DisplayName("Should not decrement below zero for blocks") + void shouldNotDecrementBelowZeroForBlocks() { + // Given + counterData.setBlockCount(Material.STONE, 1); + + // When + counterData.decrementBlock(Material.STONE); + counterData.decrementBlock(Material.STONE); // Should not go below 0 + + // Then + assertThat(counterData.getBlockCount(Material.STONE)).isZero(); + } + + @Test + @DisplayName("Should not decrement below zero for entities") + void shouldNotDecrementBelowZeroForEntities() { + // Given + counterData.setEntityCount(EntityType.ZOMBIE, 1); + + // When + counterData.decrementEntity(EntityType.ZOMBIE); + counterData.decrementEntity(EntityType.ZOMBIE); // Should not go below 0 + + // Then + assertThat(counterData.getEntityCount(EntityType.ZOMBIE)).isZero(); + } + + @Test + @DisplayName("Should set block count correctly") + void shouldSetBlockCountCorrectly() { + // When + counterData.setBlockCount(Material.STONE, 10); + + // Then + assertThat(counterData.getBlockCount(Material.STONE)).isEqualTo(10); + } + + @Test + @DisplayName("Should handle concurrent mixed operations correctly") + void shouldHandleConcurrentMixedOperationsCorrectly() throws InterruptedException { + // Given + int numberOfThreads = 5; + try (ExecutorService executor = Executors.newFixedThreadPool(numberOfThreads)) { + CountDownLatch latch = new CountDownLatch(numberOfThreads); + + // When - Multiple threads performing different operations on different counters + for (int i = 0; i < numberOfThreads; i++) { + final int threadId = i; + executor.submit(() -> { + try { + // Thread 0: Increment blocks (STONE) + if (threadId == 0) { + for (int j = 0; j < 50; j++) { + counterData.incrementBlock(Material.STONE); + } + } + // Thread 1: Increment entities (ZOMBIE) + else if (threadId == 1) { + for (int j = 0; j < 50; j++) { + counterData.incrementEntity(EntityType.ZOMBIE); + } + } + // Thread 2: Set and decrement blocks (DIRT) + else if (threadId == 2) { + counterData.setBlockCount(Material.DIRT, 100); + for (int j = 0; j < 30; j++) { + counterData.decrementBlock(Material.DIRT); + } + } + // Thread 3: Set and decrement entities (SKELETON) + else if (threadId == 3) { + counterData.setEntityCount(EntityType.SKELETON, 100); + for (int j = 0; j < 30; j++) { + counterData.decrementEntity(EntityType.SKELETON); + } + } + // Thread 4: Set operations (DIAMOND_BLOCK and CREEPER) + else if (threadId == 4) { + counterData.setBlockCount(Material.DIAMOND_BLOCK, 25); + counterData.setEntityCount(EntityType.CREEPER, 25); + } + } finally { + latch.countDown(); + } + }); + } + + assertThat(latch.await(5, TimeUnit.SECONDS)).isTrue(); + + // Then - Verify all operations completed correctly + assertThat(counterData.getBlockCount(Material.STONE)).isEqualTo(50); + assertThat(counterData.getEntityCount(EntityType.ZOMBIE)).isEqualTo(50); + assertThat(counterData.getBlockCount(Material.DIRT)).isEqualTo(70); // 100 - 30 + assertThat(counterData.getEntityCount(EntityType.SKELETON)).isEqualTo(70); // 100 - 30 + assertThat(counterData.getBlockCount(Material.DIAMOND_BLOCK)).isEqualTo(25); + assertThat(counterData.getEntityCount(EntityType.CREEPER)).isEqualTo(25); + } + } + + @Test + @DisplayName("Should handle concurrent block increments correctly") + void shouldHandleConcurrentBlockIncrementsCorrectly() throws InterruptedException { + // Given + int numberOfThreads = 10; + int incrementsPerThread = 100; + try (ExecutorService executor = Executors.newFixedThreadPool(numberOfThreads)) { + CountDownLatch latch = new CountDownLatch(numberOfThreads); + + // When + for (int i = 0; i < numberOfThreads; i++) { + executor.submit(() -> { + for (int j = 0; j < incrementsPerThread; j++) { + counterData.incrementBlock(Material.STONE); + } + latch.countDown(); + }); + } + + assertThat(latch.await(5, TimeUnit.SECONDS)).isTrue(); + + // Then + assertThat(counterData.getBlockCount(Material.STONE)) + .isEqualTo(numberOfThreads * incrementsPerThread); + } + } + + @Test + @DisplayName("Should handle concurrent entity increments correctly") + void shouldHandleConcurrentEntityIncrementsCorrectly() throws InterruptedException { + // Given + int numberOfThreads = 10; + int incrementsPerThread = 100; + try (ExecutorService executor = Executors.newFixedThreadPool(numberOfThreads)) { + CountDownLatch latch = new CountDownLatch(numberOfThreads); + + // When + for (int i = 0; i < numberOfThreads; i++) { + executor.submit(() -> { + for (int j = 0; j < incrementsPerThread; j++) { + counterData.incrementEntity(EntityType.ZOMBIE); + } + latch.countDown(); + }); + } + + assertThat(latch.await(5, TimeUnit.SECONDS)).isTrue(); + + // Then + assertThat(counterData.getEntityCount(EntityType.ZOMBIE)) + .isEqualTo(numberOfThreads * incrementsPerThread); + } + } + + @Test + @DisplayName("Should handle zero decrement operations gracefully") + void shouldHandleZeroDecrementOperationsGracefully() { + // When - Attempting to decrement non-existent counters + counterData.decrementBlock(Material.STONE); + counterData.decrementEntity(EntityType.ZOMBIE); + + // Then - Should not create negative counts + assertThat(counterData.getBlockCount(Material.STONE)).isZero(); + assertThat(counterData.getEntityCount(EntityType.ZOMBIE)).isZero(); + } + + @Test + @DisplayName("Should maintain separate counts for blocks and entities") + void shouldMaintainSeparateCountsForBlocksAndEntities() { + // Set initial count to be different + counterData.setBlockCount(Material.STONE, 0); + counterData.setEntityCount(EntityType.ZOMBIE, 1); + + // When + counterData.incrementBlock(Material.STONE); + counterData.incrementEntity(EntityType.ZOMBIE); + + // Then + assertThat(counterData.getBlockCount(Material.STONE)).isEqualTo(1); + assertThat(counterData.getEntityCount(EntityType.ZOMBIE)).isEqualTo(2); + + // And they shouldn't interfere with each other + assertThat(counterData.getBlockCount(Material.STONE)).isNotEqualTo( + counterData.getEntityCount(EntityType.ZOMBIE)); + } +} diff --git a/src/test/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/modes/RemovalModeTest.java b/src/test/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/modes/RemovalModeTest.java new file mode 100644 index 0000000..b026c39 --- /dev/null +++ b/src/test/java/com/github/sarhatabaot/chunkspawnerlimiter/removal/modes/RemovalModeTest.java @@ -0,0 +1,143 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.removal.modes; + +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Test suite for RemovalMode registry and factory methods. + * Tests the sealed interface and its implementations. + */ +@DisplayName("RemovalMode Tests") +class RemovalModeTest { + + @BeforeEach + void setUp() { + // Ensure clean state for each test + RemovalMode.reload(null); + } + + @AfterEach + void tearDown() { + // Clean up after each test + RemovalMode.reload(null); + } + + @Test + @DisplayName("Should register all removal modes correctly") + void shouldRegisterAllRemovalModesCorrectly() { + // When - reload is called in setUp + + // Then + assertThat(RemovalMode.fromString("prevent")).isInstanceOf(Prevent.class); + assertThat(RemovalMode.fromString("remove")).isInstanceOf(Remove.class); + assertThat(RemovalMode.fromString("kill")).isInstanceOf(Kill.class); + assertThat(RemovalMode.fromString("enforce")).isInstanceOf(Enforce.class); + assertThat(RemovalMode.fromString("enforce-kill")).isInstanceOf(EnforceKill.class); + } + + @Test + @DisplayName("Should return enforce mode for unknown mode strings") + void shouldReturnEnforceModeForUnknownModeStrings() { + // When + RemovalMode unknownMode = RemovalMode.fromString("nonexistent"); + + // Then + assertThat(unknownMode).isInstanceOf(Enforce.class); + assertThat(unknownMode.getKey()).isEqualTo("enforce"); + } + + @Test + @DisplayName("Should return enforce mode for null input") + void shouldReturnEnforceModeForNullInput() { + // When + RemovalMode nullMode = RemovalMode.fromString(null); + + // Then + assertThat(nullMode).isInstanceOf(Enforce.class); + assertThat(nullMode.getKey()).isEqualTo("enforce"); + } + + @Test + @DisplayName("Should handle case insensitive mode resolution") + void shouldHandleCaseInsensitiveModeResolution() { + // When + RemovalMode upperCase = RemovalMode.fromString("PREVENT"); + RemovalMode mixedCase = RemovalMode.fromString("ReMoVe"); + RemovalMode lowerCase = RemovalMode.fromString("kill"); + + // Then + assertThat(upperCase).isInstanceOf(Prevent.class); + assertThat(mixedCase).isInstanceOf(Remove.class); + assertThat(lowerCase).isInstanceOf(Kill.class); + } + + @Test + @DisplayName("Should have correct keys for all modes") + void shouldHaveCorrectKeysForAllModes() { + // When + RemovalMode prevent = RemovalMode.fromString("prevent"); + RemovalMode remove = RemovalMode.fromString("remove"); + RemovalMode kill = RemovalMode.fromString("kill"); + RemovalMode enforce = RemovalMode.fromString("enforce"); + RemovalMode enforceKill = RemovalMode.fromString("enforce-kill"); + + // Then + assertThat(prevent.getKey()).isEqualTo("prevent"); + assertThat(remove.getKey()).isEqualTo("remove"); + assertThat(kill.getKey()).isEqualTo("kill"); + assertThat(enforce.getKey()).isEqualTo("enforce"); + assertThat(enforceKill.getKey()).isEqualTo("enforce-kill"); + } + + @Test + @DisplayName("Should maintain consistent mode instances") + void shouldMaintainConsistentModeInstances() { + // When - Getting the same mode multiple times + RemovalMode prevent1 = RemovalMode.fromString("prevent"); + RemovalMode prevent2 = RemovalMode.fromString("prevent"); + RemovalMode prevent3 = RemovalMode.fromString("PREVENT"); + + // Then - Should be the same instance (singleton pattern) + assertThat(prevent1).isSameAs(prevent2); + assertThat(prevent2).isSameAs(prevent3); + } + + @Test + @DisplayName("Should have all expected removal modes registered") + void shouldHaveAllExpectedRemovalModesRegistered() { + // Given + String[] expectedModes = {"prevent", "remove", "kill", "enforce", "enforce-kill"}; + + // Then + for (String mode : expectedModes) { + assertThat(RemovalMode.fromString(mode)) + .isNotNull() + .extracting("key") + .isEqualTo(mode); + } + } + + @Test + @DisplayName("Should handle setup and reload operations") + void shouldHandleSetupAndReloadOperations() { + // Given + RemovalMode.setup(null); // Should work without task manager + + // When + RemovalMode reloadMode = RemovalMode.fromString("prevent"); + + // Then + assertThat(reloadMode).isInstanceOf(Prevent.class); + + // When - Reload again + RemovalMode.reload(null); + RemovalMode reloadMode2 = RemovalMode.fromString("prevent"); + + // Then - Should still work + assertThat(reloadMode2).isInstanceOf(Prevent.class); + } +} diff --git a/src/testLegacy/java/com/github/sarhatabaot/chunkspawnerlimiter/integration/PluginIntegrationLegacyTest.java b/src/testLegacy/java/com/github/sarhatabaot/chunkspawnerlimiter/integration/PluginIntegrationLegacyTest.java new file mode 100644 index 0000000..d74b2d2 --- /dev/null +++ b/src/testLegacy/java/com/github/sarhatabaot/chunkspawnerlimiter/integration/PluginIntegrationLegacyTest.java @@ -0,0 +1,137 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.integration; + +import be.seeseemelk.mockbukkit.MockBukkit; +import be.seeseemelk.mockbukkit.ServerMock; +import com.github.sarhatabaot.chunkspawnerlimiter.ChunkSpawnerLimiter; +import com.github.sarhatabaot.chunkspawnerlimiter.PluginConfig; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Integration tests for the full plugin lifecycle using MockBukkit 1.x. + * Tests plugin loading, configuration, and basic functionality for Minecraft 1.8-1.12. + * + * Note: This test suite uses MockBukkit 1.x which supports Minecraft 1.8-1.12. + * For modern versions (1.17+), see PluginIntegrationTest in testModern. + */ +@DisplayName("Plugin Integration Tests (Legacy)") +class PluginIntegrationLegacyTest { + + private ServerMock server; + private ChunkSpawnerLimiter plugin; + + @BeforeEach + void setUp() { + // Create a mock server with legacy MockBukkit + server = MockBukkit.mock(); + + // Load the plugin + plugin = MockBukkit.load(ChunkSpawnerLimiter.class); + } + + @AfterEach + void tearDown() { + // Clean up after each test + MockBukkit.unload(); + } + + @Test + @DisplayName("Should load plugin successfully with legacy MockBukkit") + void shouldLoadPluginSuccessfully() { + // Then + assertThat(plugin).isNotNull(); + assertThat(plugin.isEnabled()).isTrue(); // Should be enabled by default + assertThat(server.getPluginManager().getPlugin("ChunkSpawnerLimiter")).isEqualTo(plugin); + } + + @Test + @DisplayName("Should initialize plugin components correctly") + void shouldInitializePluginComponentsCorrectly() { + // Then + assertThat(plugin.getPluginConfig()).isNotNull(); + assertThat(plugin.getCounterDataManager()).isNotNull(); + assertThat(plugin.getRemovalTaskManager()).isNotNull(); + assertThat(plugin.getNotificationService()).isNotNull(); + } + + @Test + @DisplayName("Should have default configuration loaded") + void shouldHaveDefaultConfigurationLoaded() { + // Given + PluginConfig config = plugin.getPluginConfig(); + + // Then + assertThat(config.isEnabled()).isTrue(); // Default should be true + assertThat(config.isMetrics()).isFalse(); // Default should be true (but false during testing) + assertThat(config.isDebugMessages()).isFalse(); // Default should be false + } + + @Test + @DisplayName("Should handle plugin enable/disable cycle") + void shouldHandlePluginEnableDisableCycle() { + // Given - Plugin is loaded but not enabled + + // When - Enable the plugin + plugin.onEnable(); + + // Then - Should be enabled + assertThat(plugin.isEnabled()).isTrue(); + + // When - Disable the plugin + plugin.onDisable(); + + // Then - Components should be cleaned up + assertThat(plugin.getCounterDataManager()).isNull(); + assertThat(plugin.getRemovalTaskManager()).isNull(); + assertThat(plugin.getPluginConfig()).isNull(); + assertThat(plugin.getNotificationService()).isNull(); + } + + @Test + @DisplayName("Should handle configuration reload") + void shouldHandleConfigurationReload() { + // Given + PluginConfig config = plugin.getPluginConfig(); + + // When - Reload configuration + plugin.onReload(); + + // Then - Config should still be available and functional + assertThat(config).isNotNull(); + assertThat(config.isEnabled()).isTrue(); + } + + @Test + @DisplayName("Should have valid plugin metadata") + void shouldHaveValidPluginMetadata() { + // When - Get plugin description + var description = plugin.getDescription(); + + // Then + assertThat(description.getName()).isEqualTo("ChunkSpawnerLimiter"); + assertThat(description.getDescription()).contains("Limit blocks & entities in chunks"); + assertThat(description.getAuthors()).contains("Cyprias", "sarhatabaot"); + } + + @Test + @DisplayName("Should handle legacy Minecraft version compatibility") + void shouldHandleLegacyMinecraftVersionCompatibility() { + // Given - Plugin is loaded + + // When - Enable plugin + plugin.onEnable(); + + // Then - Plugin should function with legacy MockBukkit + // This test ensures the plugin can initialize and run with older Minecraft versions + assertThat(plugin.isEnabled()).isTrue(); + + // Test basic functionality works + PluginConfig config = plugin.getPluginConfig(); + assertThat(config).isNotNull(); + assertThat(config.getRemovalMode()).isNotNull(); + } +} diff --git a/src/testModern/java/com/github/sarhatabaot/chunkspawnerlimiter/ChunkSpawnerLimiterTest.java b/src/testModern/java/com/github/sarhatabaot/chunkspawnerlimiter/ChunkSpawnerLimiterTest.java new file mode 100644 index 0000000..8f446c3 --- /dev/null +++ b/src/testModern/java/com/github/sarhatabaot/chunkspawnerlimiter/ChunkSpawnerLimiterTest.java @@ -0,0 +1,49 @@ +package com.github.sarhatabaot.chunkspawnerlimiter; + +import org.bukkit.Server; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; +import org.mockbukkit.mockbukkit.MockBukkit; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Basic tests for the main ChunkSpawnerLimiter plugin class. + * More comprehensive tests are in the integration package. + */ +@DisplayName("ChunkSpawnerLimiter Main Class Tests") +class ChunkSpawnerLimiterTest { + + private Server server; + private ChunkSpawnerLimiter plugin; + + @BeforeEach + void setUp() { + // Load plugin with MockBukkit\ + server = MockBukkit.mock(); + plugin = MockBukkit.load(ChunkSpawnerLimiter.class); + } + + @AfterEach + void tearDown() { + MockBukkit.unmock(); + } + + @Test + @DisplayName("Should create plugin instance") + void shouldCreatePluginInstance() { + assertThat(plugin).isNotNull(); + assertThat(plugin.getDescription().getName()).isEqualTo("ChunkSpawnerLimiter"); + } + + @Test + @DisplayName("Should have plugin components after creation") + void shouldHavePluginComponentsAfterCreation() { + assertThat(plugin.getPluginConfig()).isNotNull(); + assertThat(plugin.getCounterDataManager()).isNotNull(); + assertThat(plugin.getRemovalTaskManager()).isNotNull(); + assertThat(plugin.getNotificationService()).isNotNull(); + } +} diff --git a/src/testModern/java/com/github/sarhatabaot/chunkspawnerlimiter/config/PluginConfigTest.java b/src/testModern/java/com/github/sarhatabaot/chunkspawnerlimiter/config/PluginConfigTest.java new file mode 100644 index 0000000..f44753c --- /dev/null +++ b/src/testModern/java/com/github/sarhatabaot/chunkspawnerlimiter/config/PluginConfigTest.java @@ -0,0 +1,298 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.config; + +import com.github.sarhatabaot.chunkspawnerlimiter.PluginConfig; +import org.bukkit.Material; +import org.bukkit.configuration.MemoryConfiguration; +import org.bukkit.entity.EntityType; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.Mock; +import org.mockito.junit.jupiter.MockitoExtension; + +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.Mockito.doNothing; +import static org.mockito.Mockito.when; + +/** + * Comprehensive test suite for PluginConfig. + * Tests configuration loading, parsing, and validation functionality. + */ +@ExtendWith(MockitoExtension.class) +@DisplayName("PluginConfig Tests") +class PluginConfigTest { + + @Mock + private org.bukkit.plugin.java.JavaPlugin mockPlugin; + + @Mock + private org.bukkit.configuration.file.FileConfiguration mockConfig; + + private PluginConfig pluginConfig; + + @BeforeEach + void setUp() { + // Mock the plugin to return our mock config + when(mockPlugin.getConfig()).thenReturn(mockConfig); + doNothing().when(mockPlugin).saveDefaultConfig(); + + // Create PluginConfig instance + pluginConfig = new PluginConfig(mockPlugin); + } + + @Test + @DisplayName("Should initialize with default values when config is empty") + void shouldInitializeWithDefaultsWhenConfigEmpty() { + // Given + when(mockConfig.getBoolean("enabled", false)).thenReturn(false); + when(mockConfig.getBoolean("debug-messages", false)).thenReturn(false); + when(mockConfig.getBoolean("metrics", true)).thenReturn(true); + + // When - reload is called in constructor + + // Then + assertThat(pluginConfig.isEnabled()).isFalse(); + assertThat(pluginConfig.isDebugMessages()).isFalse(); + assertThat(pluginConfig.isMetrics()).isTrue(); + } + + @Test + @DisplayName("Should load entity limits correctly") + void shouldLoadEntityLimitsCorrectly() { + // Given + when(mockConfig.getConfigurationSection("entities.limits")) + .thenReturn(new MemoryConfiguration().createSection("entities.limits", (Map) (Map) Map.of( + "ZOMBIE", 10, + "SKELETON", 5 + ))); + + // When + pluginConfig.reload(); + + // Then + assertThat(pluginConfig.getResolvedEntityLimit(EntityType.ZOMBIE)).isEqualTo(10); + assertThat(pluginConfig.getResolvedEntityLimit(EntityType.SKELETON)).isEqualTo(5); + assertThat(pluginConfig.hasResolvedEntityLimit(EntityType.ZOMBIE)).isTrue(); + assertThat(pluginConfig.hasResolvedEntityLimit(EntityType.CREEPER)).isFalse(); + } + + @Test + @DisplayName("Should load block limits correctly") + void shouldLoadBlockLimitsCorrectly() { + // Given + when(mockConfig.getConfigurationSection("blocks.limits")) + .thenReturn(new MemoryConfiguration().createSection("blocks.limits", (Map) (Map) Map.of( + "MOB_SPAWNER", 5, + "DIAMOND_BLOCK", 10 + ))); + + // When + pluginConfig.reload(); + + // Then + assertThat(pluginConfig.getResolvedBlockLimit(Material.SPAWNER)).isEqualTo(5); + assertThat(pluginConfig.getResolvedBlockLimit(Material.DIAMOND_BLOCK)).isEqualTo(10); + assertThat(pluginConfig.hasResolvedBlockLimit(Material.SPAWNER)).isTrue(); + assertThat(pluginConfig.hasResolvedBlockLimit(Material.STONE)).isFalse(); + } + + @Test + @DisplayName("Should handle entity groups correctly") + void shouldHandleEntityGroupsCorrectly() { + // Given + when(mockConfig.getConfigurationSection("entities.entity-groups")) + .thenReturn(new MemoryConfiguration().createSection("entities.entity-groups", (Map) (Map) Map.of( + "MONSTERS", List.of("ZOMBIE", "SKELETON", "CREEPER") + ))); + + when(mockConfig.getConfigurationSection("entities.limits")) + .thenReturn(new MemoryConfiguration().createSection("entities.limits", (Map) (Map) Map.of( + "MONSTERS", 20 + ))); + + // When + pluginConfig.reload(); + + // Then + assertThat(pluginConfig.getResolvedEntityLimit(EntityType.ZOMBIE)).isEqualTo(20); + assertThat(pluginConfig.getResolvedEntityLimit(EntityType.SKELETON)).isEqualTo(20); + assertThat(pluginConfig.getResolvedEntityLimit(EntityType.CREEPER)).isEqualTo(20); + } + + @Test + @DisplayName("Should prioritize direct entity limits over group limits") + void shouldPrioritizeDirectLimitsOverGroupLimits() { + // Given + when(mockConfig.getConfigurationSection("entities.entity-groups")) + .thenReturn(new MemoryConfiguration().createSection("entities.entity-groups", (Map) (Map) Map.of( + "MONSTERS", List.of("ZOMBIE", "SKELETON") + ))); + + Map limitsMap = new HashMap<>(); + limitsMap.put("MONSTERS", 20); + limitsMap.put("ZOMBIE", 5); // Direct limit should take precedence + when(mockConfig.getConfigurationSection("entities.limits")) + .thenReturn(new MemoryConfiguration().createSection("entities.limits", limitsMap)); + + // When + pluginConfig.reload(); + + // Then + assertThat(pluginConfig.getResolvedEntityLimit(EntityType.ZOMBIE)).isEqualTo(5); // Direct limit wins + assertThat(pluginConfig.getResolvedEntityLimit(EntityType.SKELETON)).isEqualTo(20); // Group limit + } + + @Test + @DisplayName("Should load spawn reasons correctly") + void shouldLoadSpawnReasonsCorrectly() { + // Given + when(mockConfig.getStringList("spawn-reasons")) + .thenReturn(List.of("SPAWNER", "NATURAL", "BREEDING")); + + // When + pluginConfig.reload(); + + // Then + assertThat(pluginConfig.getSpawnReasons()) + .containsExactlyInAnyOrder("SPAWNER", "NATURAL", "BREEDING"); + } + + @Test + @DisplayName("Should use default spawn reasons when none configured") + void shouldUseDefaultSpawnReasonsWhenNoneConfigured() { + // Given + when(mockConfig.getStringList("spawn-reasons")).thenReturn(null); + + // When + pluginConfig.reload(); + + // Then + assertThat(pluginConfig.getSpawnReasons()).isNotEmpty(); + assertThat(pluginConfig.getSpawnReasons()).contains("SPAWNER"); + } + + @Test + @DisplayName("Should parse removal mode correctly") + void shouldParseRemovalModeCorrectly() { + // Given + when(mockConfig.getString("entities.removal.mode", "enforce")).thenReturn("prevent"); + + // When + pluginConfig.reload(); + + // Then + assertThat(pluginConfig.getRemovalMode().getKey()).isEqualTo("prevent"); + } + + @Test + @DisplayName("Should default to enforce mode for unknown removal modes") + void shouldDefaultToEnforceModeForUnknownRemovalModes() { + // Given + when(mockConfig.getString("entities.removal.mode", "enforce")).thenReturn("unknown"); + + // When + pluginConfig.reload(); + + // Then + assertThat(pluginConfig.getRemovalMode().getKey()).isEqualTo("enforce"); + } + + @Test + @DisplayName("Should handle world filtering correctly") + void shouldHandleWorldFilteringCorrectly() { + // Given + when(mockConfig.getString("worlds.mode", "excluded")).thenReturn("excluded"); + when(mockConfig.getStringList("worlds.list")).thenReturn(List.of("world_nether", "world_the_end")); + + // When + pluginConfig.reload(); + + // Then + assertThat(pluginConfig.getWorldsMode()).isEqualTo("excluded"); + assertThat(pluginConfig.getWorldsList()).containsExactly("world_nether", "world_the_end"); + assertThat(pluginConfig.isWorldDisabled("world_nether")).isTrue(); + assertThat(pluginConfig.isWorldDisabled("world")).isFalse(); + } + + @Test + @DisplayName("Should handle notification settings correctly") + void shouldHandleNotificationSettingsCorrectly() { + // Given + when(mockConfig.getBoolean("notifications.enabled", false)).thenReturn(true); + when(mockConfig.getInt("notifications.cooldown-seconds", 3)).thenReturn(5); + when(mockConfig.getBoolean("notifications.method.title", true)).thenReturn(true); + when(mockConfig.getBoolean("notifications.method.message", false)).thenReturn(false); + + // When + pluginConfig.reload(); + + // Then + assertThat(pluginConfig.shouldNotifyPlayersInChunk()).isTrue(); + assertThat(pluginConfig.getNotificationCooldownSeconds()).isEqualTo(5); + assertThat(pluginConfig.shouldUseTitleNotifications()).isTrue(); + assertThat(pluginConfig.shouldUseMessageNotifications()).isFalse(); + } + + @Test + @DisplayName("Should handle preservation settings correctly") + void shouldHandlePreservationSettingsCorrectly() { + // Given + when(mockConfig.getBoolean("entities.preservation.named-entities", true)).thenReturn(true); + when(mockConfig.getBoolean("entities.preservation.raid-entities", true)).thenReturn(false); + + // When + pluginConfig.reload(); + + // Then + assertThat(pluginConfig.shouldPreserveNamedEntities()).isTrue(); + assertThat(pluginConfig.shouldPreserveRaidEntities()).isFalse(); + } + + @Test + @DisplayName("Should handle ignore metadata correctly") + void shouldHandleIgnoreMetadataCorrectly() { + // Given + when(mockConfig.getStringList("entities.ignore.metadata")) + .thenReturn(List.of("shopkeeper", "npc")); + + // When + pluginConfig.reload(); + + // Then + assertThat(pluginConfig.getIgnoreMetadata()) + .containsExactlyInAnyOrder("shopkeeper", "npc"); + } + + @Test + @DisplayName("Should use default ignore metadata when none configured") + void shouldUseDefaultIgnoreMetadataWhenNoneConfigured() { + // Given + when(mockConfig.getStringList("entities.ignore.metadata")).thenReturn(null); + + // When + pluginConfig.reload(); + + // Then + assertThat(pluginConfig.getIgnoreMetadata()).contains("shopkeeper"); + } + + @Test + @DisplayName("Should handle inspection settings correctly") + void shouldHandleInspectionSettingsCorrectly() { + // Given + when(mockConfig.getBoolean("events.inspections.enabled", true)).thenReturn(true); + when(mockConfig.getInt("events.inspections.frequency", 300)).thenReturn(600); + + // When + pluginConfig.reload(); + + // Then + assertThat(pluginConfig.isActiveInspections()).isTrue(); + assertThat(pluginConfig.getInspectionFrequency()).isEqualTo(600); + } +} diff --git a/src/testModern/java/com/github/sarhatabaot/chunkspawnerlimiter/integration/PluginIntegrationTest.java b/src/testModern/java/com/github/sarhatabaot/chunkspawnerlimiter/integration/PluginIntegrationTest.java new file mode 100644 index 0000000..b60f527 --- /dev/null +++ b/src/testModern/java/com/github/sarhatabaot/chunkspawnerlimiter/integration/PluginIntegrationTest.java @@ -0,0 +1,144 @@ +package com.github.sarhatabaot.chunkspawnerlimiter.integration; + + +import com.github.sarhatabaot.chunkspawnerlimiter.ChunkSpawnerLimiter; +import com.github.sarhatabaot.chunkspawnerlimiter.PluginConfig; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; +import org.mockbukkit.mockbukkit.MockBukkit; +import org.mockbukkit.mockbukkit.ServerMock; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Integration tests for the full plugin lifecycle using MockBukkit 3.x. + * Tests plugin loading, configuration, and basic functionality for Minecraft 1.17+. + *
+ * Note: This test suite uses MockBukkit 3.x which supports Minecraft 1.17+. + * For legacy versions (1.8-1.12), see PluginIntegrationLegacyTest. + */ +@DisplayName("Plugin Integration Tests (Modern)") +class PluginIntegrationTest { + + private ServerMock server; + private ChunkSpawnerLimiter plugin; + + @BeforeEach + void setUp() { + // Create a mock server + server = MockBukkit.mock(); + + // Load the plugin + plugin = MockBukkit.load(ChunkSpawnerLimiter.class); + } + + @AfterEach + void tearDown() { + // Clean up after each test + MockBukkit.unmock(); + } + + @Test + @DisplayName("Should load plugin successfully") + void shouldLoadPluginSuccessfully() { + // Then + assertThat(plugin).isNotNull(); + assertThat(plugin.isEnabled()).isFalse(); // Should be disabled by default + assertThat(server.getPluginManager().getPlugin("ChunkSpawnerLimiter")).isEqualTo(plugin); + } + + @Test + @DisplayName("Should initialize plugin components correctly") + void shouldInitializePluginComponentsCorrectly() { + // Then + assertThat(plugin.getPluginConfig()).isNotNull(); + assertThat(plugin.getCounterDataManager()).isNotNull(); + assertThat(plugin.getRemovalTaskManager()).isNotNull(); + assertThat(plugin.getNotificationService()).isNotNull(); + } + + @Test + @DisplayName("Should have default configuration loaded") + void shouldHaveDefaultConfigurationLoaded() { + // Given + PluginConfig config = plugin.getPluginConfig(); + + // Then + assertThat(config.isEnabled()).isFalse(); // Default should be false + assertThat(config.isMetrics()).isTrue(); // Default should be true + assertThat(config.isDebugMessages()).isFalse(); // Default should be false + } + + @Test + @DisplayName("Should register event listeners") + void shouldRegisterEventListeners() { + // When - Plugin is loaded (in setUp) + + // Then - Check that listeners are registered by verifying they exist + // Note: MockBukkit doesn't provide direct access to registered listeners, + // but we can verify the plugin manager calls were made by checking + // that the components were created successfully + assertThat(plugin.getPluginConfig()).isNotNull(); + } + + @Test + @DisplayName("Should handle plugin enable/disable cycle") + void shouldHandlePluginEnableDisableCycle() { + // Given - Plugin is loaded but not enabled + + // When - Enable the plugin + plugin.onEnable(); + + // Then - Should be enabled + assertThat(plugin.isEnabled()).isTrue(); + + // When - Disable the plugin + plugin.onDisable(); + + // Then - Components should be cleaned up + assertThat(plugin.getCounterDataManager()).isNull(); + assertThat(plugin.getRemovalTaskManager()).isNull(); + assertThat(plugin.getPluginConfig()).isNull(); + assertThat(plugin.getNotificationService()).isNull(); + } + + @Test + @DisplayName("Should handle configuration reload") + void shouldHandleConfigurationReload() { + // Given + PluginConfig config = plugin.getPluginConfig(); + + // When - Reload configuration + plugin.onReload(); + + // Then - Config should still be available and functional + assertThat(config).isNotNull(); + assertThat(config.isEnabled()).isFalse(); + } + + @Test + @DisplayName("Should have valid plugin metadata") + void shouldHaveValidPluginMetadata() { + // When - Get plugin description + var description = plugin.getDescription(); + + // Then + assertThat(description.getName()).isEqualTo("ChunkSpawnerLimiter"); + + assertThat(description.getDescription()).contains("Limit blocks & entities in chunks"); + assertThat(description.getAuthors()).contains("Cyprias", "sarhatabaot"); + } + + @Test + @DisplayName("Should register commands correctly") + void shouldRegisterCommandsCorrectly() { + // When - Plugin is loaded + + // Then - Commands should be registered + // Note: MockBukkit command registration testing is limited, + // but we can verify the command framework was initialized + assertThat(plugin).isNotNull(); + } +}