feat: Add new notification system. (#177)

TheMeinerLP · web-flow · commit afee780e9bf2 · 2025-10-04T01:03:26.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -15,6 +15,7 @@ build/
 out/
 !**/src/main/**/out/
 !**/src/test/**/out/
+.idea/*
 
 ### Eclipse ###
 .apt_generated
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,21 @@
+# [2.4.0-beta.1](https://github.com/OneLiteFeatherNET/AntiRedstoneClock-Remastered/compare/v2.3.0...v2.4.0-beta.1) (2025-10-03)
+
+
+### Bug Fixes
+
+* correct notification configuration keys and method name for clarity ([bf77855](https://github.com/OneLiteFeatherNET/AntiRedstoneClock-Remastered/commit/bf77855b6cc963b100a8cb9b86f98c182daab4ef))
+* enhance error logging for webhook client creation failures ([201b18e](https://github.com/OneLiteFeatherNET/AntiRedstoneClock-Remastered/commit/201b18e9d86e657b2dc9da0e1a5f6723236607fa))
+* update Discord notification configuration keys for consistency and improve error handling ([89c46fc](https://github.com/OneLiteFeatherNET/AntiRedstoneClock-Remastered/commit/89c46fccbe699614fcae5aac05348af1d721c8c1))
+
+
+### Features
+
+* add Discord notification service with webhook integration ([c527a2e](https://github.com/OneLiteFeatherNET/AntiRedstoneClock-Remastered/commit/c527a2e9b24da2e9ff83af853802021a2b6e6401))
+* enhance notification system with new services and configuration options ([7b2e5ef](https://github.com/OneLiteFeatherNET/AntiRedstoneClock-Remastered/commit/7b2e5efb46dca0a3dc2bff98342b6c0e27e69425))
+* implement notification system for redstone clock detection ([9a42292](https://github.com/OneLiteFeatherNET/AntiRedstoneClock-Remastered/commit/9a422921687670fa53af6365fe9498d1f0f1d99a))
+* implement sign block break handling and metadata management ([d737be4](https://github.com/OneLiteFeatherNET/AntiRedstoneClock-Remastered/commit/d737be4be32760383b588ffd6bb9736c2b54a41a))
+* improve Discord webhook handling and error logging ([b9f196b](https://github.com/OneLiteFeatherNET/AntiRedstoneClock-Remastered/commit/b9f196b8bb839f96e7d3b805710150136b7f5497))
+
 # [2.3.0](https://github.com/OneLiteFeatherNET/AntiRedstoneClock-Remastered/compare/v2.2.8...v2.3.0) (2025-10-03)
 
 
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -62,6 +62,9 @@ dependencies {
     implementation(libs.cloud.command.annotations)
     implementation(libs.semver)
     implementation(libs.adventure.text.feature.pagination)
+    implementation(libs.adventure.text.discord)
+    implementation(libs.jda.webhook)
+    implementation(libs.jda)
     implementation(libs.guice)
     implementation(libs.jakarta.inject)
     annotationProcessor(libs.cloud.command.annotations)
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -31,6 +31,10 @@ dependencyResolutionManagement {
             version("cloudcommandExtras", "2.0.0-SNAPSHOT")
 
             version("adventure-text-feature-pagination", "4.0.0-SNAPSHOT")
+            version("adventure-text-discord-serializer", "4.3.0")
+            version("jda", "5.6.1")
+            version("jda-webhook", "0.8.4")
+
             version("semver", "0.10.2")
             version("guice", "7.0.0")
             version("jakarta-inject", "2.0.1")
@@ -64,6 +68,9 @@ dependencyResolutionManagement {
 
             library("paper", "io.papermc.paper", "paper-api").versionRef("paper")
             library("adventure.text.feature.pagination", "net.kyori", "adventure-text-feature-pagination").versionRef("adventure-text-feature-pagination")
+            library("adventure.text.discord", "dev.vankka", "mcdiscordreserializer").versionRef("adventure-text-discord-serializer")
+            library("jda", "net.dv8tion", "JDA").versionRef("jda")
+            library("jda-webhook", "club.minnced", "discord-webhooks").versionRef("jda-webhook")
             library("bstats", "org.bstats", "bstats-bukkit").versionRef("bstats")
 
             library("cloud.command.paper", "org.incendo", "cloud-paper").versionRef("cloudcommandPaper")
diff --git a/src/main/java/net/onelitefeather/antiredstoneclockremastered/AntiRedstoneClockRemastered.java b/src/main/java/net/onelitefeather/antiredstoneclockremastered/AntiRedstoneClockRemastered.java
@@ -30,6 +30,7 @@ public final class AntiRedstoneClockRemastered extends JavaPlugin {
     public void onLoad() {
         saveDefaultConfig();
         reloadConfig();
+        saveConfig();
         injector = Guice.createInjector(Stage.PRODUCTION, Arrays.asList(
                 new PlatformModule(this),
                 new TranslationModule(),
diff --git a/src/main/java/net/onelitefeather/antiredstoneclockremastered/injection/ServiceModule.java b/src/main/java/net/onelitefeather/antiredstoneclockremastered/injection/ServiceModule.java
@@ -7,13 +7,13 @@
 import net.onelitefeather.antiredstoneclockremastered.AntiRedstoneClockRemastered;
 import net.onelitefeather.antiredstoneclockremastered.api.PlotsquaredSupport;
 import net.onelitefeather.antiredstoneclockremastered.api.WorldGuardSupport;
+import net.onelitefeather.antiredstoneclockremastered.service.api.NotificationService;
 import net.onelitefeather.antiredstoneclockremastered.service.api.RedstoneClockService;
 import net.onelitefeather.antiredstoneclockremastered.service.api.RegionService;
 import net.onelitefeather.antiredstoneclockremastered.service.factory.RedstoneClockServiceFactory;
 import net.onelitefeather.antiredstoneclockremastered.service.UpdateService;
 import net.onelitefeather.antiredstoneclockremastered.service.api.TranslationService;
-import net.onelitefeather.antiredstoneclockremastered.service.impl.LegacyTranslationService;
-import net.onelitefeather.antiredstoneclockremastered.service.impl.ModernTranslationService;
+import net.onelitefeather.antiredstoneclockremastered.service.impl.*;
 import net.onelitefeather.antiredstoneclockremastered.utils.CheckTPS;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -37,8 +37,24 @@ protected void configure() {
     
     @Provides
     @Singleton
-    public RedstoneClockService provideRedstoneClockService(AntiRedstoneClockRemastered plugin, RegionService regionService,
-                                                            PlotsquaredSupport plotsquaredSupport, WorldGuardSupport worldGuardSupport) {
-        return RedstoneClockServiceFactory.createService(plugin, regionService, plotsquaredSupport, worldGuardSupport);
+    public RedstoneClockService provideRedstoneClockService(AntiRedstoneClockRemastered plugin,
+                                                            RegionService regionService,
+                                                            PlotsquaredSupport plotsquaredSupport,
+                                                            WorldGuardSupport worldGuardSupport,
+                                                            NotificationService notificationService) {
+        return RedstoneClockServiceFactory.createService(plugin, regionService, plotsquaredSupport, worldGuardSupport,
+                notificationService);
     }
+
+    @Provides
+    @Singleton
+    public NotificationService providesNotificationService(AntiRedstoneClockRemastered antiRedstoneClockRemastered,
+                                                           RegionService regionService) {
+        var adminNotifications = new AdminNotificationService(antiRedstoneClockRemastered, null);
+        var consoleNotification = new ConsoleNotificationService(antiRedstoneClockRemastered, adminNotifications);
+        var signNotifications = new SignNotificationService(antiRedstoneClockRemastered, consoleNotification, regionService);
+        var discordNotification = new DiscordNotificationService(antiRedstoneClockRemastered, signNotifications);
+        return discordNotification;
+    }
+
 }
diff --git a/src/main/java/net/onelitefeather/antiredstoneclockremastered/listener/PlayerListener.java b/src/main/java/net/onelitefeather/antiredstoneclockremastered/listener/PlayerListener.java
@@ -46,4 +46,13 @@ private void onBlockBreak(BlockBreakEvent blockBreakEvent) {
             break recheck;
         }
     }
+
+    @EventHandler(priority = EventPriority.HIGHEST)
+    private void onSignBlockBreak(BlockBreakEvent blockBreakEvent) {
+        var block = blockBreakEvent.getBlock();
+        var hasKey = block.hasMetadata(Constants.META_KEY_ARCR_SIGN);
+        if (hasKey) {
+            blockBreakEvent.setDropItems(false);
+        }
+    }
 }
diff --git a/src/main/java/net/onelitefeather/antiredstoneclockremastered/service/api/NotificationService.java b/src/main/java/net/onelitefeather/antiredstoneclockremastered/service/api/NotificationService.java
@@ -0,0 +1,30 @@
+package net.onelitefeather.antiredstoneclockremastered.service.api;
+
+import net.kyori.adventure.text.Component;
+import org.bukkit.Location;
+import org.jetbrains.annotations.Nullable;
+
+/**
+ * Service for sending notifications.
+ *
+ * @author TheMeinerLP
+ * @version 1.0.0
+ * @since 2.4.0
+ */
+public interface NotificationService {
+
+    /**
+     * Get the notification message for the given location.
+     * @param location where the notification gets sent from
+     * @return the notification message
+     */
+    @Nullable Component getNotificationMessage(Location location);
+
+    /**
+     * Send a notification message to the given audience.
+     * @param location where the notification gets sent from
+     */
+    void sendNotificationMessage(Location location);
+
+    boolean isEnabled();
+}
diff --git a/src/main/java/net/onelitefeather/antiredstoneclockremastered/service/api/RegionService.java b/src/main/java/net/onelitefeather/antiredstoneclockremastered/service/api/RegionService.java
@@ -19,6 +19,14 @@ public interface RegionService {
      */
     void executeInRegion(Location location, Runnable task);
 
+    /**
+     * Executes a task within the context of a specific region.
+     * @param location The location to determine the region.
+     * @param task The task to execute.
+     * @param delay The delay in ticks before the task is executed.
+     */
+    void executeInRegion(Location location, Runnable task, long delay);
+
     /**
      * Checks if the current server instance is the owner of the region at the specified location.
      *
diff --git a/src/main/java/net/onelitefeather/antiredstoneclockremastered/service/factory/RedstoneClockServiceFactory.java b/src/main/java/net/onelitefeather/antiredstoneclockremastered/service/factory/RedstoneClockServiceFactory.java
@@ -3,6 +3,7 @@
 import net.onelitefeather.antiredstoneclockremastered.AntiRedstoneClockRemastered;
 import net.onelitefeather.antiredstoneclockremastered.api.PlotsquaredSupport;
 import net.onelitefeather.antiredstoneclockremastered.api.WorldGuardSupport;
+import net.onelitefeather.antiredstoneclockremastered.service.api.NotificationService;
 import net.onelitefeather.antiredstoneclockremastered.service.api.RedstoneClockService;
 import net.onelitefeather.antiredstoneclockremastered.service.api.RegionService;
 import net.onelitefeather.antiredstoneclockremastered.service.impl.BukkitRedstoneClockService;
@@ -35,7 +36,10 @@ private RedstoneClockServiceFactory() {
      * @return the appropriate RedstoneClockService implementation
      */
     @NotNull
-    public static RedstoneClockService createService(@NotNull AntiRedstoneClockRemastered plugin, RegionService regionService, PlotsquaredSupport plotsquaredSupport, WorldGuardSupport worldGuardSupport) {
+    public static RedstoneClockService createService(@NotNull AntiRedstoneClockRemastered plugin,
+                                                     RegionService regionService, PlotsquaredSupport plotsquaredSupport,
+                                                     WorldGuardSupport worldGuardSupport,
+                                                     NotificationService notificationService) {
         if (FoliaHelper.isFolia()) {
             LOGGER.info("Folia detected - using FoliaRedstoneClockService");
             // Uncomment when ready to enable Folia support:
@@ -44,6 +48,6 @@ public static RedstoneClockService createService(@NotNull AntiRedstoneClockRemas
         }
         
         LOGGER.info("Using BukkitRedstoneClockService");
-        return new BukkitRedstoneClockService(plugin, regionService, worldGuardSupport, plotsquaredSupport);
+        return new BukkitRedstoneClockService(plugin, regionService, worldGuardSupport, plotsquaredSupport, notificationService);
     }
 }
diff --git a/src/main/java/net/onelitefeather/antiredstoneclockremastered/service/impl/AdminNotificationService.java b/src/main/java/net/onelitefeather/antiredstoneclockremastered/service/impl/AdminNotificationService.java
@@ -0,0 +1,56 @@
+package net.onelitefeather.antiredstoneclockremastered.service.impl;
+
+import net.kyori.adventure.text.Component;
+import net.kyori.adventure.text.event.ClickEvent;
+import net.onelitefeather.antiredstoneclockremastered.AntiRedstoneClockRemastered;
+import net.onelitefeather.antiredstoneclockremastered.service.api.NotificationService;
+import net.onelitefeather.antiredstoneclockremastered.utils.Constants;
+import org.bukkit.Bukkit;
+import org.bukkit.Location;
+import org.bukkit.entity.Player;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+public final class AdminNotificationService implements NotificationService {
+
+    private final AntiRedstoneClockRemastered plugin;
+    private final NotificationService notificationService;
+
+    public AdminNotificationService(@NotNull AntiRedstoneClockRemastered plugin,
+                                      @Nullable NotificationService notificationService) {
+        this.plugin = plugin;
+        this.notificationService = notificationService;
+    }
+
+    @Override
+    public Component getNotificationMessage(@NotNull Location location) {
+        return Component.translatable("service.notify.detected.clock")
+                .arguments(AntiRedstoneClockRemastered.PREFIX,
+                        Component.text(location.getBlockX()),
+                        Component.text(location.getBlockY()),
+                        Component.text(location.getBlockZ()),
+                        Component.empty().clickEvent(ClickEvent.callback(audience -> {
+                            if (audience instanceof final Player executor) {
+                                executor.teleport(location);
+                            }
+                        })));
+    }
+
+    @Override
+    public void sendNotificationMessage(@NotNull Location location) {
+        if (this.notificationService != null) {
+            this.notificationService.sendNotificationMessage(location);
+        }
+        if (!isEnabled()) return;
+        for (final Player player : Bukkit.getOnlinePlayers()) {
+            if (!player.hasPermission(Constants.PERMISSION_NOTIFY) || !player.isOp()) continue;
+            player.sendMessage(getNotificationMessage(location));
+        }
+    }
+
+    @Override
+    public boolean isEnabled() {
+        return  this.plugin.getConfig().getBoolean("clock.notifyAdmins", true)
+                || this.plugin.getConfig().getStringList("notification.enabled").contains("admins");
+    }
+}
diff --git a/src/main/java/net/onelitefeather/antiredstoneclockremastered/service/impl/BukkitRedstoneClockService.java b/src/main/java/net/onelitefeather/antiredstoneclockremastered/service/impl/BukkitRedstoneClockService.java
@@ -7,6 +7,7 @@
 import net.onelitefeather.antiredstoneclockremastered.api.PlotsquaredSupport;
 import net.onelitefeather.antiredstoneclockremastered.api.WorldGuardSupport;
 import net.onelitefeather.antiredstoneclockremastered.model.RedstoneClock;
+import net.onelitefeather.antiredstoneclockremastered.service.api.NotificationService;
 import net.onelitefeather.antiredstoneclockremastered.service.api.RedstoneClockService;
 import net.onelitefeather.antiredstoneclockremastered.service.api.RegionService;
 import net.onelitefeather.antiredstoneclockremastered.utils.Constants;
@@ -41,30 +42,30 @@ public final class BukkitRedstoneClockService implements RedstoneClockService {
     private final RegionService regionService;
     private final WorldGuardSupport worldGuardSupport;
     private final PlotsquaredSupport plotsquaredSupport;
+    private final NotificationService notificationService;
     private int endTimeDelay;
     private int maxClockCount;
     private boolean autoBreakBlock;
-    private boolean notifyAdmins;
-    private boolean notifyConsole;
     private boolean dropItems;
     private List<String> ignoredWorlds;
 
     private final ConcurrentHashMap<Location, RedstoneClock> activeClockTesters = new ConcurrentHashMap<>();
     private final ItemStack SILK_TOUCH_PICKAXE = new ItemStack(Material.DIAMOND_PICKAXE);
 
     @Inject
-    public BukkitRedstoneClockService(@NotNull AntiRedstoneClockRemastered antiRedstoneClockRemastered, RegionService regionService, WorldGuardSupport worldGuardSupport, PlotsquaredSupport plotsquaredSupport) {
+    public BukkitRedstoneClockService(@NotNull AntiRedstoneClockRemastered antiRedstoneClockRemastered,
+                                      RegionService regionService, WorldGuardSupport worldGuardSupport,
+                                      PlotsquaredSupport plotsquaredSupport, NotificationService notificationService) {
         this.antiRedstoneClockRemastered = antiRedstoneClockRemastered;
         this.endTimeDelay = antiRedstoneClockRemastered.getConfig().getInt("clock.endDelay", 300);
         this.maxClockCount = antiRedstoneClockRemastered.getConfig().getInt("clock.maxCount", 150);
         this.autoBreakBlock = antiRedstoneClockRemastered.getConfig().getBoolean("clock.autoBreak", true);
-        this.notifyAdmins = antiRedstoneClockRemastered.getConfig().getBoolean("clock.notifyAdmins", true);
-        this.notifyConsole = antiRedstoneClockRemastered.getConfig().getBoolean("clock.notifyConsole", true);
         this.dropItems = antiRedstoneClockRemastered.getConfig().getBoolean("clock.drop", false);
         this.ignoredWorlds = antiRedstoneClockRemastered.getConfig().getStringList("check.ignoredWorlds");
         this.regionService = regionService;
         this.worldGuardSupport = worldGuardSupport;
         this.plotsquaredSupport = plotsquaredSupport;
+        this.notificationService = notificationService;
         SILK_TOUCH_PICKAXE.addEnchantment(Enchantment.SILK_TOUCH, 1);
     }
 
@@ -166,35 +167,11 @@ private void destroyRedstoneClock(@NotNull Location location, @NotNull RedstoneC
         if (this.autoBreakBlock) breakBlock(location);
         if (!clock.isDetected()) {
             clock.setDetected(true);
-            if (this.notifyConsole) {
-                this.antiRedstoneClockRemastered.getLogger().log(Level.WARNING, "Redstone Clock detected at: X,Y,Z({0},{1},{2})", new Object[]{location.getBlockX(), location.getBlockY(), location.getBlockZ()});
-            }
-            if (this.notifyAdmins) {
-                for (final Player player : Bukkit.getOnlinePlayers()) {
-                    if (player.isOp() || player.hasPermission(Constants.PERMISSION_NOTIFY)) {
-                        sendNotification(player, location);
-                    }
-                }
-            }
-
+            this.notificationService.sendNotificationMessage(location);
         }
         removeClockByClock(clock);
     }
 
-    private void sendNotification(final Player player, final Location location) {
-        final var component = Component.translatable("service.notify.detected.clock")
-                .arguments(AntiRedstoneClockRemastered.PREFIX,
-                        Component.text(location.getBlockX()),
-                        Component.text(location.getBlockY()),
-                        Component.text(location.getBlockZ()),
-                        Component.empty().clickEvent(ClickEvent.callback(audience -> {
-                            if (audience instanceof final Player executor) {
-                                executor.teleport(location);
-                            }
-                        })));
-        player.sendMessage(component);
-    }
-
     private void breakBlock(@NotNull Location location) {
         Block block = location.getBlock();
         if (this.dropItems) {
@@ -219,8 +196,6 @@ public void reload() {
         this.endTimeDelay = antiRedstoneClockRemastered.getConfig().getInt("clock.endDelay", 300);
         this.maxClockCount = antiRedstoneClockRemastered.getConfig().getInt("clock.maxCount", 150);
         this.autoBreakBlock = antiRedstoneClockRemastered.getConfig().getBoolean("clock.autoBreak", true);
-        this.notifyAdmins = antiRedstoneClockRemastered.getConfig().getBoolean("clock.notifyAdmins", true);
-        this.notifyConsole = antiRedstoneClockRemastered.getConfig().getBoolean("clock.notifyConsole", true);
         this.dropItems = antiRedstoneClockRemastered.getConfig().getBoolean("clock.drop", false);
         this.ignoredWorlds = antiRedstoneClockRemastered.getConfig().getStringList("check.ignoredWorlds");
     }
diff --git a/src/main/java/net/onelitefeather/antiredstoneclockremastered/service/impl/BukkitRegionService.java b/src/main/java/net/onelitefeather/antiredstoneclockremastered/service/impl/BukkitRegionService.java
@@ -17,6 +17,11 @@ public void executeInRegion(Location location, Runnable task) {
         this.plugin.getServer().getScheduler().runTaskLater(this.plugin, task, 1);
     }
 
+    @Override
+    public void executeInRegion(Location location, Runnable task, long delay) {
+        this.plugin.getServer().getScheduler().runTaskLater(this.plugin, task, delay);
+    }
+
     @Override
     public boolean isRegionOwner(Location location) {
         // Always true for non-Folia
diff --git a/src/main/java/net/onelitefeather/antiredstoneclockremastered/service/impl/ConsoleNotificationService.java b/src/main/java/net/onelitefeather/antiredstoneclockremastered/service/impl/ConsoleNotificationService.java
diff --git a/src/main/java/net/onelitefeather/antiredstoneclockremastered/service/impl/DiscordNotificationService.java b/src/main/java/net/onelitefeather/antiredstoneclockremastered/service/impl/DiscordNotificationService.java
diff --git a/src/main/java/net/onelitefeather/antiredstoneclockremastered/service/impl/FoliaRegionService.java b/src/main/java/net/onelitefeather/antiredstoneclockremastered/service/impl/FoliaRegionService.java
diff --git a/src/main/java/net/onelitefeather/antiredstoneclockremastered/service/impl/SignNotificationService.java b/src/main/java/net/onelitefeather/antiredstoneclockremastered/service/impl/SignNotificationService.java
diff --git a/src/main/java/net/onelitefeather/antiredstoneclockremastered/utils/Constants.java b/src/main/java/net/onelitefeather/antiredstoneclockremastered/utils/Constants.java
diff --git a/src/main/resources/config.yml b/src/main/resources/config.yml

Original file line number	Diff line number	Diff line change
`@@ -46,4 +46,13 @@ private void onBlockBreak(BlockBreakEvent blockBreakEvent) {`
`46`	`46`	`break recheck;`
`47`	`47`	`}`
`48`	`48`	`}`
	`49`	`+`
	`50`	`+ @EventHandler(priority = EventPriority.HIGHEST)`
	`51`	`+ private void onSignBlockBreak(BlockBreakEvent blockBreakEvent) {`
	`52`	`+ var block = blockBreakEvent.getBlock();`
	`53`	`+ var hasKey = block.hasMetadata(Constants.META_KEY_ARCR_SIGN);`
	`54`	`+ if (hasKey) {`
	`55`	`+ blockBreakEvent.setDropItems(false);`
	`56`	`+ }`
	`57`	`+ }`
`49`	`58`	`}`