refactor: new moderation stack

TODO.md

@@ -20,7 +20,7 @@
   - [x] /report to allow user to report (@admin is not implemented)
   - [x] track ban, mute and kick done via telegram UI (not by command)
 - [ ] controlled moderation flow (see #42)
-  - [ ] audit log (implemented, need to audit every mod action)
+  - [x] audit log (implemented, need to audit every mod action)
   - [ ] send in-chat action log (deprived of chat ids and stuff)
 - [x] automatic moderation
   - [x] delete non-latin alphabet characters 

package.json

@@ -37,7 +37,7 @@
     "@grammyjs/menu": "^1.3.1",
     "@grammyjs/parse-mode": "^1.11.1",
     "@grammyjs/runner": "^2.0.3",
-    "@polinetwork/backend": "^0.15.2",
+    "@polinetwork/backend": "^0.15.3",
     "@t3-oss/env-core": "^0.13.4",
     "@trpc/client": "^11.5.1",
     "@types/ssdeep.js": "^0.0.2",

src/bot.ts

@@ -15,8 +15,8 @@ import { checkUsername } from "./middlewares/check-username"
 import { GroupSpecificActions } from "./middlewares/group-specific-actions"
 import { messageLink } from "./middlewares/message-link"
 import { MessageUserStorage } from "./middlewares/message-user-storage"
-import { UIActionsLogger } from "./middlewares/ui-actions-logger"
 import { modules, sharedDataInit } from "./modules"
+import { Moderation } from "./modules/moderation"
 import { redis } from "./redis"
 import { once } from "./utils/once"
 import { setTelegramId } from "./utils/telegram-id"
@@ -78,7 +78,7 @@ bot.use(commands)
 bot.use(new BotMembershipHandler())
 bot.use(new AutoModerationStack())
 bot.use(new GroupSpecificActions())
-bot.use(new UIActionsLogger())
+bot.use(Moderation)
 
 bot.on("message", async (ctx, next) => {
   const { username, id } = ctx.message.from

src/commands/ban.ts

@@ -1,10 +1,11 @@
 import { logger } from "@/logger"
-import { ban, unban } from "@/modules/moderation"
+import { Moderation } from "@/modules/moderation"
 import { duration } from "@/utils/duration"
 import { fmt } from "@/utils/format"
 import { getTelegramId } from "@/utils/telegram-id"
+import { numberOrString } from "@/utils/types"
+import { getUser } from "@/utils/users"
 import { wait } from "@/utils/wait"
-
 import { _commandsBase } from "./_base"
 
 _commandsBase
@@ -25,22 +26,10 @@ _commandsBase
         return
       }
 
-      const res = await ban({
-        ctx: context,
-        target: repliedTo.from,
-        from: context.from,
-        message: repliedTo,
-        reason: args.reason,
-      })
-
-      if (res.isErr()) {
-        const msg = await context.reply(res.error)
-        await wait(5000)
-        await msg.delete()
-        return
-      }
-
-      await context.reply(res.value)
+      const res = await Moderation.ban(repliedTo.from, context.chat, context.from, null, [repliedTo], args.reason)
+      const msg = await context.reply(res.isErr() ? res.error.fmtError : "OK")
+      await wait(5000)
+      await msg.delete()
     },
   })
   .createCommand({
@@ -68,28 +57,22 @@ _commandsBase
         return
       }
 
-      const res = await ban({
-        ctx: context,
-        target: repliedTo.from,
-        from: context.from,
-        message: repliedTo,
-        duration: args.duration,
-        reason: args.reason,
-      })
-
-      if (res.isErr()) {
-        const msg = await context.reply(res.error)
-        await wait(5000)
-        await msg.delete()
-        return
-      }
-
-      await context.reply(res.value)
+      const res = await Moderation.ban(
+        repliedTo.from,
+        context.chat,
+        context.from,
+        args.duration,
+        [repliedTo],
+        args.reason
+      )
+      const msg = await context.reply(res.isErr() ? res.error.fmtError : "OK")
+      await wait(5000)
+      await msg.delete()
     },
   })
   .createCommand({
     trigger: "unban",
-    args: [{ key: "username", optional: false, description: "Username (or user id) to unban" }],
+    args: [{ key: "username", type: numberOrString, description: "Username (or user id) to unban" }],
     description: "Unban a user from a group",
     scope: "group",
     permissions: {
@@ -98,7 +81,9 @@ _commandsBase
     },
     handler: async ({ args, context }) => {
       await context.deleteMessage()
-      const userId = args.username.startsWith("@") ? await getTelegramId(args.username) : parseInt(args.username, 10)
+      const userId: number | null =
+        typeof args.username === "string" ? await getTelegramId(args.username.replaceAll("@", "")) : args.username
+
       if (!userId) {
         logger.debug(`unban: no userId for username ${args.username}`)
         const msg = await context.reply(fmt(({ b }) => b`@${context.from.username} user not found`))
@@ -107,12 +92,18 @@ _commandsBase
         return
       }
 
-      const res = await unban({ ctx: context, from: context.from, targetId: userId })
-      if (res.isErr()) {
-        const msg = await context.reply(res.error)
+      const user = await getUser(userId, context)
+      if (!user) {
+        const msg = await context.reply("Error: cannot find this user")
+        logger.error({ userId }, "UNBAN: cannot retrieve the user")
         await wait(5000)
         await msg.delete()
         return
       }
+
+      const res = await Moderation.unban(user, context.chat, context.from)
+      const msg = await context.reply(res.isErr() ? res.error.fmtError : "OK")
+      await wait(5000)
+      await msg.delete()
     },
   })

src/commands/del.ts

@@ -1,6 +1,7 @@
 import { logger } from "@/logger"
-import { modules } from "@/modules"
+import { Moderation } from "@/modules/moderation"
 import { getText } from "@/utils/messages"
+import { wait } from "@/utils/wait"
 import { _commandsBase } from "./_base"
 
 _commandsBase.createCommand({
@@ -13,6 +14,7 @@ _commandsBase.createCommand({
   description: "Deletes the replied to message",
   reply: "required",
   handler: async ({ repliedTo, context }) => {
+    await context.deleteMessage()
     const { text, type } = getText(repliedTo)
     logger.info({
       action: "delete_message",
@@ -21,7 +23,10 @@ _commandsBase.createCommand({
       sender: repliedTo.from?.username,
     })
 
-    await modules.get("tgLogger").delete([repliedTo], "Command /del", context.from) // actual message to delete
-    await context.deleteMessage() // /del message
+    const res = await Moderation.deleteMessages([repliedTo], context.from, "Command /del")
+    // TODO: better error and ok response
+    const msg = await context.reply(res.isErr() ? "Cannot delete the message" : "OK")
+    await wait(5000)
+    await msg.delete()
   },
 })

src/commands/kick.ts

@@ -1,5 +1,5 @@
 import { logger } from "@/logger"
-import { kick } from "@/modules/moderation"
+import { Moderation } from "@/modules/moderation"
 import { wait } from "@/utils/wait"
 
 import { _commandsBase } from "./_base"
@@ -21,20 +21,9 @@ _commandsBase.createCommand({
       return
     }
 
-    const res = await kick({
-      ctx: context,
-      target: repliedTo.from,
-      from: context.from,
-      message: repliedTo,
-      reason: args.reason,
-    })
-    if (res.isErr()) {
-      const msg = await context.reply(res.error)
-      await wait(5000)
-      await msg.delete()
-      return
-    }
-
-    await context.reply(res.value)
+    const res = await Moderation.kick(repliedTo.from, context.chat, context.from, [repliedTo], args.reason)
+    const msg = await context.reply(res.isErr() ? res.error.fmtError : "OK")
+    await wait(5000)
+    await msg.delete()
   },
 })

src/commands/mute.ts

@@ -1,10 +1,11 @@
 import { logger } from "@/logger"
-import { mute, unmute } from "@/modules/moderation"
+import { Moderation } from "@/modules/moderation"
 import { duration } from "@/utils/duration"
 import { fmt } from "@/utils/format"
 import { getTelegramId } from "@/utils/telegram-id"
+import { numberOrString } from "@/utils/types"
+import { getUser } from "@/utils/users"
 import { wait } from "@/utils/wait"
-
 import { _commandsBase } from "./_base"
 
 _commandsBase
@@ -33,21 +34,17 @@ _commandsBase
         return
       }
 
-      const res = await mute({
-        ctx: context,
-        target: repliedTo.from,
-        message: repliedTo,
-        from: context.from,
-        duration: args.duration,
-        reason: args.reason,
-      })
-
-      if (res.isErr()) {
-        const msg = await context.reply(res.error)
-        await wait(5000)
-        await msg.delete()
-        return
-      }
+      const res = await Moderation.mute(
+        repliedTo.from,
+        context.chat,
+        context.from,
+        args.duration,
+        [repliedTo],
+        args.reason
+      )
+      const msg = await context.reply(res.isErr() ? res.error.fmtError : "OK")
+      await wait(5000)
+      await msg.delete()
     },
   })
   .createCommand({
@@ -67,25 +64,15 @@ _commandsBase
         return
       }
 
-      const res = await mute({
-        ctx: context,
-        target: repliedTo.from,
-        message: repliedTo,
-        from: context.from,
-        reason: args.reason,
-      })
-
-      if (res.isErr()) {
-        const msg = await context.reply(res.error)
-        await wait(5000)
-        await msg.delete()
-        return
-      }
+      const res = await Moderation.mute(repliedTo.from, context.chat, context.from, null, [repliedTo], args.reason)
+      const msg = await context.reply(res.isErr() ? res.error.fmtError : "OK")
+      await wait(5000)
+      await msg.delete()
     },
   })
   .createCommand({
     trigger: "unmute",
-    args: [{ key: "username", optional: false, description: "Username (or user id) to unmute" }],
+    args: [{ key: "username", type: numberOrString, description: "Username (or user id) to unmute" }],
     description: "Unmute a user from a group",
     scope: "group",
     permissions: {
@@ -94,7 +81,8 @@ _commandsBase
     },
     handler: async ({ args, context }) => {
       await context.deleteMessage()
-      const userId = args.username.startsWith("@") ? await getTelegramId(args.username) : parseInt(args.username, 10)
+      const userId: number | null =
+        typeof args.username === "string" ? await getTelegramId(args.username.replaceAll("@", "")) : args.username
       if (!userId) {
         logger.debug(`unmute: no userId for username ${args.username}`)
         const msg = await context.reply(fmt(({ b }) => b`@${context.from.username} user not found`))
@@ -103,12 +91,18 @@ _commandsBase
         return
       }
 
-      const res = await unmute({ ctx: context, from: context.from, targetId: userId })
-      if (res.isErr()) {
-        const msg = await context.reply(res.error)
+      const user = await getUser(userId, context)
+      if (!user) {
+        const msg = await context.reply("Error: cannot find this user")
+        logger.error({ userId }, "UNMUTE: cannot retrieve the user")
         await wait(5000)
         await msg.delete()
         return
       }
+
+      const res = await Moderation.unmute(user, context.chat, context.from)
+      const msg = await context.reply(res.isErr() ? res.error.fmtError : "OK")
+      await wait(5000)
+      await msg.delete()
     },
   })