add spawner protection module

#78

src/main/java/org/purpurmc/purpurextras/modules/listeners/SpawnersProtectionModule.java

@@ -0,0 +1,100 @@
+package org.purpurmc.purpurextras.modules.listeners;
+
+import net.kyori.adventure.text.Component;
+import net.kyori.adventure.text.minimessage.MiniMessage;
+import org.bukkit.block.BlockState;
+import org.bukkit.block.CreatureSpawner;
+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.BlockExplodeEvent;
+import org.bukkit.event.entity.EntityExplodeEvent;
+import org.bukkit.permissions.PermissionDefault;
+import org.bukkit.util.permissions.DefaultPermissions;
+import org.purpurmc.purpurextras.PurpurConfig;
+import org.purpurmc.purpurextras.PurpurExtras;
+import org.purpurmc.purpurextras.modules.PurpurExtrasModule;
+import org.purpurmc.purpurextras.util.MessageType;
+
+/**
+ * Prevents players from breaking spawners.
+ */
+public class SpawnersProtectionModule implements PurpurExtrasModule, Listener {
+
+    private final Component message;
+    private MessageType messageType;
+    private final boolean allowBreakingInSneak;
+    private final boolean blocksImmuneToExplosions;
+
+    private final String permission = "purpurextras.spawnerprotectionbypass";
+
+    protected SpawnersProtectionModule() {
+        PurpurConfig config = PurpurExtras.getPurpurConfig();
+
+        DefaultPermissions.registerPermission(
+                permission,
+                "Players with this permission will be able to destroy spawners",
+                PermissionDefault.OP
+        );
+
+        String defaultMessage = "<red>Prevented you from breaking this block. Sneak to break it anyway.";
+        message = MiniMessage.miniMessage().deserialize(
+                config.getString("settings.protect-spawners.message", defaultMessage)
+        );
+        allowBreakingInSneak = config.getBoolean("settings.protect-spawners.allow-breaking-in-sneak", true);
+        blocksImmuneToExplosions = config.getBoolean("settings.protect-spawners.immune-to-explosions", false);
+        try {
+            messageType = MessageType.valueOf(
+                    config.getString("settings.protect-spawners.message-type", "CHAT").toUpperCase()
+            );
+        } catch (IllegalArgumentException e) {
+            messageType = MessageType.CHAT;
+        }
+    }
+
+    @Override
+    public void enable() {
+        PurpurExtras plugin = PurpurExtras.getInstance();
+        plugin.getServer().getPluginManager().registerEvents(this, plugin);
+    }
+
+    @Override
+    public boolean shouldEnable() {
+        return PurpurExtras.getPurpurConfig().getBoolean("settings.protect-spawners.enabled", false);
+    }
+
+    @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)
+    public void onDestroySpawner(BlockBreakEvent event) {
+        if (isProtected(event.getBlock().getState(true))) {
+            handleLootBlockDestruction(event);
+        }
+    }
+
+    @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)
+    public void onExplodingSpawner(EntityExplodeEvent event) {
+        if (!blocksImmuneToExplosions) return;
+        event.blockList().removeIf(block -> isProtected(block.getState(true)));
+    }
+
+    @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)
+    public void onExplodingSpawner(BlockExplodeEvent event) {
+        if (!blocksImmuneToExplosions) return;
+        event.blockList().removeIf(block -> isProtected(block.getState(true)));
+    }
+
+    private void handleLootBlockDestruction(BlockBreakEvent event) {
+        if (event.getPlayer().hasPermission(permission)) return;
+        if (allowBreakingInSneak && event.getPlayer().isSneaking()) return;
+        event.setCancelled(true);
+        switch (messageType) {
+            case CHAT -> event.getPlayer().sendMessage(message);
+            case ACTION_BAR -> event.getPlayer().sendActionBar(message);
+        }
+    }
+
+    private boolean isProtected(BlockState blockState) {
+        return blockState instanceof CreatureSpawner;
+    }
+
+}