Add Speaking Frequency Limit

.idea/gradle.xml

@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project version="4">
+  <component name="GradleMigrationSettings" migrationVersion="1" />
   <component name="GradleSettings">
     <option name="linkedExternalProjectsSettings">
       <GradleProjectSettings>

README-en-US.md

@@ -9,9 +9,8 @@ Talking to the server account in the game is equivalent to sending to the world
 ## TODO List
 - [x] Chat between players
 - [x] Chat management commands
-- [ ] Chat speech limit
+- [x] Speaking Frequency Limit
 - [ ] Chat Moderation
-- [ ] Console talk
 - [ ] Chat api _(~~OneBot api~~)_
 - [ ] ...
 

README.md

@@ -9,9 +9,8 @@
 ## TODO List
 - [x] 玩家间聊天
 - [x] 聊天管理命令
-- [ ] 发言间隔限制
+- [x] 发言频率限制
 - [ ] 聊天内容审查
-- [ ] 控制台发言（运维用）
 - [ ] 聊天api _(~~OneBot api~~)_
 - [ ] ...
 

src/main/java/com/github/jie65535/openchat/OpenChatPlugin.java

@@ -29,7 +29,6 @@ import java.io.File;
 import java.io.FileWriter;
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
-import java.util.Date;
 
 public final class OpenChatPlugin extends Plugin {
     private static OpenChatPlugin instance;
@@ -122,14 +121,4 @@ public final class OpenChatPlugin extends Plugin {
         saveData();
         getLogger().info("[OpenChat] Disabled.");
     }
-
-    /**
-     * 更新禁言列表，清理所有解除禁言用户
-     */
-    public void updateBanList() {
-        if (getData().banList.isEmpty())
-            return;
-        var now = new Date();
-        getData().banList.entrySet().removeIf(entry -> entry.getValue().before(now));
-    }
 }

src/main/java/com/github/jie65535/openchat/OpenChatSystem.java

@@ -3,6 +3,11 @@ package com.github.jie65535.openchat;
 import emu.grasscutter.GameConstants;
 import emu.grasscutter.game.chat.ChatSystem;
 import emu.grasscutter.game.player.Player;
+import it.unimi.dsi.fastutil.ints.Int2ObjectMap;
+import it.unimi.dsi.fastutil.ints.Int2ObjectOpenHashMap;
+import it.unimi.dsi.fastutil.longs.LongArrayFIFOQueue;
+
+import java.util.Date;
 
 public class OpenChatSystem extends ChatSystem {
     private final OpenChatPlugin plugin;
@@ -39,19 +44,30 @@ public class OpenChatSystem extends ChatSystem {
         if (!plugin.getConfig().serverChatEnabled) {
             return;
         }
-        // 刷新列表
-        plugin.updateBanList();
+
         // 检测是否正在禁言中
-        if (plugin.getData().banList.containsKey(player.getUid())) {
-            return;
-        }
-        // 处理发言频率限制与发言内容审查
-        if (!checkMessageFre(player) || !checkMessageModeration(message)) {
+        if (checkIsBanning(player)) {
             // 可提示也可忽略，忽略可让玩家以为自己发送成功，其实别人看不到
-            plugin.getLogger().warn(String.format("Message blocked: player=%s(%d): \"%s\"",
+            plugin.getLogger().warn(String.format("Message blocked (banning): player=%s(%d): \"%s\"",
                     player.getNickname(), player.getUid(), message));
             return;
         }
+
+        // 处理发言频率限制
+        if (!checkMessageFre(player)) {
+            // 可提示也可忽略，忽略可让玩家以为自己发送成功，其实别人看不到
+            plugin.getLogger().warn(String.format("Message blocked (too often): player=%s(%d): \"%s\"",
+                    player.getNickname(), player.getUid(), message));
+            return;
+        }
+
+        // 处理发言内容审查
+        if (!checkMessageModeration(message)) {
+            plugin.getLogger().warn(String.format("Message blocked (moderation): player=%s(%d): \"%s\"",
+                    player.getNickname(), player.getUid(), message));
+            return;
+        }
+
         // 格式化消息
         message = OpenChatPlugin.getInstance().getConfig().serverChatFormat
                 .replace("{nickName}", player.getNickname())
@@ -66,23 +82,43 @@ public class OpenChatSystem extends ChatSystem {
         }
     }
 
+    private boolean checkIsBanning(Player player) {
+        var banList = plugin.getData().banList;
+        // 检测是否正在禁言中
+        if (banList.containsKey(player.getUid())) {
+            if (banList.get(player.getUid()).before(new Date())) {
+                banList.remove(player.getUid());
+            } else {
+                return true;
+            }
+        }
+        return false;
+    }
+
     /**
      * 消息内容审查
      * @param message 消息
      * @return 是否合法合规
      */
     private boolean checkMessageModeration(String message) {
-        // TODO
-        return true;
+        // TODO see https://github.com/houbb/sensitive-word
+        return !message.isEmpty();
     }
 
+    Int2ObjectMap<LongArrayFIFOQueue> speakingTimes = new Int2ObjectOpenHashMap<>();
+
     /**
      * 消息频率检查
      * @param player 玩家对象
      * @return 是否在约定阈值内
      */
     private boolean checkMessageFre(Player player) {
-        // TODO
-        return true;
+        var list = speakingTimes.computeIfAbsent(player.getUid(), i -> new LongArrayFIFOQueue());
+        var now = System.currentTimeMillis();
+        list.enqueue(now);
+        var t = now - 60_000;
+        while (list.firstLong() < t)
+            list.dequeueLong();
+        return list.size() <= plugin.getConfig().messageFreLimitPerMinute;
     }
 }