Merge branch 'ZeppelinBot:master' into stock

Author: rubyowo

.cursorignore

@@ -0,0 +1,93 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Node template
+# Logs
+/logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.clinic
+.clinic-bot
+.clinic-api
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+*.env
+.env
+
+# windows folder options
+desktop.ini
+
+# PHPStorm
+.idea/
+
+# Misc
+/convert.js
+/startscript.js
+.cache
+npm-ls.txt
+npm-audit.txt
+.vscode/launch.json
+
+# Debug files
+*.debug.ts
+*.debug.js
+
+.vscode/
+
+config-errors.txt
+/config-schema.json
+
+*.tsbuildinfo
+
+# Legacy data folders
+/docker/development/data
+/docker/production/data

.env.example

@@ -50,6 +50,9 @@ DEVELOPMENT_SSH_PASSWORD=password
 # If your user has a different UID than 1000, you might have to fill that in here to avoid permission issues
 #DEVELOPMENT_UID=1000
 
+# If using the cftunnel docker compose profile, set your Cloudflare Tunnel token here
+#CF_TUNNEL_TOKEN=
+
 
 # ==========================
 # PRODUCTION - STANDALONE

AGENTS.md

@@ -0,0 +1,21 @@
+The project is called Zeppelin. It's a Discord bot that uses Discord.js. The bot is built on the Knub framework.
+
+This repository is a monorepository that contains these projects:
+1. **Backend**: The shared codebase of the bot and API. Located in `backend`.
+2. **Dashboard**: The web dashboard that contains the bot's management interface and documentation. Located in `dashboard`.
+3. **Config checker**: A tool to check the configuration of the bot. Located in `config-checker`.
+
+There is also a `shared` folder that contains shared code used by all projects, such as types and utilities.
+
+# Backend
+The backend codebase is located in the `backend` directory. It contains the main bot code, API code, and shared code used by both the bot and API.
+Zeppelin's functionality is split into plugins, which are located in the `src/plugins` directory.
+Each plugin has its own directory, with a `types.ts` for config types, `docs.ts` for a `ZeppelinPluginDocs` structure, and the plugin's main file.
+Each plugin has an internal name, such as "common". In this example, the folder would be `src/plugins/Common` (note the capitalization). The plugin's main file would be `src/plugins/CommonPlugin.ts`.
+There are two types of plugins: "guild plugins" and "global plugins". Guild plugins are loaded on a per-guild basis, while global plugins are loaded once for the entire bot.
+Plugins can specify dependencies on other plugins and call their public methods. Likewise, plugins can specify public methods in the main file.
+Available plugins are specified in `src/plugins/availablePlugins.ts`.
+
+Zeppelin's data layer uses TypeORM. Entities are located in `src/data/entities`, while repositories are in `src/data`. If the repository name is prefixed with "Guild", it's a guild-specific repository. If it's prefixed with "User", it's a user-specific repository. If it has no prefix, it's a global repository.
+
+Environment variables are parsed in `src/env.ts`.

backend/src/data/entities/ApiPermissionAssignment.ts

@@ -1,4 +1,4 @@
-import { Column, Entity, JoinColumn, ManyToOne, PrimaryColumn } from "typeorm";
+import { Column, Entity, JoinColumn, ManyToOne, PrimaryColumn, Relation } from "typeorm";
 import { ApiPermissionTypes } from "../ApiPermissionAssignments.js";
 import { ApiUserInfo } from "./ApiUserInfo.js";
 
@@ -24,5 +24,5 @@ export class ApiPermissionAssignment {
 
   @ManyToOne(() => ApiUserInfo, (userInfo) => userInfo.permissionAssignments)
   @JoinColumn({ name: "target_id" })
-  userInfo: ApiUserInfo;
+  userInfo: Relation<ApiUserInfo>;
 }

backend/src/data/loops/expiringMutesLoop.ts

@@ -42,7 +42,6 @@ async function broadcastExpiredMute(guildId: string, userId: string, tries = 0):
 }
 
 function broadcastTimeoutMuteToRenew(mute: Mute, tries = 0) {
-  console.log(`[EXPIRING MUTES LOOP] Broadcasting timeout mute to renew: ${mute.guild_id}/${mute.user_id}`);
   if (!hasGuildEventListener(mute.guild_id, "timeoutMuteToRenew")) {
     // If there are no listeners registered for the server yet, try again in a bit
     if (tries < MAX_TRIES_PER_SERVER) {
@@ -53,6 +52,7 @@ function broadcastTimeoutMuteToRenew(mute: Mute, tries = 0) {
     }
     return;
   }
+  console.log(`[EXPIRING MUTES LOOP] Broadcasting timeout mute to renew: ${mute.guild_id}/${mute.user_id}`);
   emitGuildEvent(mute.guild_id, "timeoutMuteToRenew", [mute]);
 }
 

backend/src/data/loops/expiringTempbansLoop.ts

@@ -17,7 +17,6 @@ function tempbanToKey(tempban: Tempban) {
 }
 
 function broadcastExpiredTempban(tempban: Tempban, tries = 0) {
-  console.log(`[EXPIRING TEMPBANS LOOP] Broadcasting expired tempban: ${tempban.guild_id}/${tempban.user_id}`);
   if (!hasGuildEventListener(tempban.guild_id, "expiredTempban")) {
     // If there are no listeners registered for the server yet, try again in a bit
     if (tries < MAX_TRIES_PER_SERVER) {
@@ -28,6 +27,7 @@ function broadcastExpiredTempban(tempban: Tempban, tries = 0) {
     }
     return;
   }
+  console.log(`[EXPIRING TEMPBANS LOOP] Broadcasting expired tempban: ${tempban.guild_id}/${tempban.user_id}`);
   emitGuildEvent(tempban.guild_id, "expiredTempban", [tempban]);
 }
 

backend/src/data/loops/upcomingScheduledPostsLoop.ts

@@ -53,21 +53,21 @@ export function registerUpcomingScheduledPost(post: ScheduledPost) {
     return;
   }
 
-  console.log("[SCHEDULED POSTS LOOP] Registering new upcoming scheduled post");
   const remaining = Math.max(0, moment.utc(post.post_at).diff(moment.utc()));
   if (remaining > LOOP_INTERVAL) {
     return;
   }
 
+  console.log("[SCHEDULED POSTS LOOP] Registering new upcoming scheduled post");
   timeouts.set(
     post.id,
     setTimeout(() => broadcastScheduledPost(post), remaining),
   );
 }
 
 export function clearUpcomingScheduledPost(post: ScheduledPost) {
-  console.log("[SCHEDULED POSTS LOOP] Clearing upcoming scheduled post");
   if (timeouts.has(post.id)) {
+    console.log("[SCHEDULED POSTS LOOP] Clearing upcoming scheduled post");
     clearTimeout(timeouts.get(post.id)!);
   }
 }

backend/src/index.ts

@@ -276,9 +276,12 @@ connect().then(async () => {
     }
   });
 
+  let ignorePluginLoadErrors = true;
   client.on("error", (err) => {
     if (err instanceof PluginLoadError) {
-      errorHandler(err);
+      if (!ignorePluginLoadErrors) {
+        errorHandler(err);
+      }
       return;
     }
     errorHandler(new DiscordJSError(err.message, (err as any).code, 0));
@@ -411,6 +414,8 @@ connect().then(async () => {
       enableProfiling();
     }
 
+    ignorePluginLoadErrors = false;
+
     initFishFish();
 
     runExpiringMutesLoop();

backend/src/plugins/Automod/AutomodPlugin.ts

@@ -33,6 +33,7 @@ import { clearOldRecentNicknameChanges } from "./functions/clearOldNicknameChang
 import { clearOldRecentActions } from "./functions/clearOldRecentActions.js";
 import { clearOldRecentSpam } from "./functions/clearOldRecentSpam.js";
 import { AutomodPluginType, zAutomodConfig } from "./types.js";
+import { DebugAutomodCmd } from "./commands/DebugAutomodCmd.js";
 
 export const AutomodPlugin = guildPlugin<AutomodPluginType>()({
   name: "automod",
@@ -67,7 +68,7 @@ export const AutomodPlugin = guildPlugin<AutomodPluginType>()({
     // Messages use message events from SavedMessages, see onLoad below
   ],
 
-  messageCommands: [AntiraidClearCmd, SetAntiraidCmd, ViewAntiraidCmd],
+  messageCommands: [AntiraidClearCmd, SetAntiraidCmd, ViewAntiraidCmd, DebugAutomodCmd],
 
   async beforeLoad(pluginData) {
     const { state, guild } = pluginData;

backend/src/plugins/Automod/commands/DebugAutomodCmd.ts

@@ -0,0 +1,48 @@
+import { guildPluginMessageCommand } from "knub";
+import moment from "moment-timezone";
+import { commandTypeHelpers as ct } from "../../../commandTypes.js";
+import { AutomodContext, AutomodPluginType } from "../types.js";
+import { runAutomod } from "../functions/runAutomod.js";
+import { createChunkedMessage } from "../../../utils.js";
+import { getOrFetchGuildMember } from "../../../utils/getOrFetchGuildMember.js";
+import { getOrFetchUser } from "../../../utils/getOrFetchUser.js";
+
+export const DebugAutomodCmd = guildPluginMessageCommand<AutomodPluginType>()({
+  trigger: "debug_automod",
+  permission: "can_debug_automod",
+  
+  signature: {
+    messageId: ct.string(),
+  },
+
+  async run({ pluginData, message, args }) {
+    const targetMessage = await pluginData.state.savedMessages.find(args.messageId);
+    if (!targetMessage || targetMessage.guild_id !== pluginData.guild.id) {
+      pluginData.state.common.sendErrorMessage(message, "Message not found");
+      return;
+    }
+
+    const member = await getOrFetchGuildMember(pluginData.guild, targetMessage.user_id);
+    const user = await getOrFetchUser(pluginData.client, targetMessage.user_id);
+    const context: AutomodContext = {
+      timestamp: moment.utc(targetMessage.posted_at).valueOf(),
+      message: targetMessage,
+      user,
+      member,
+    };
+
+    const result = await runAutomod(pluginData, context, true);
+
+    let resultText = `**${result.triggered ? "✔️ Triggered" : "❌ Not triggered"}**\n\nRules checked:\n\n`;
+    for (const ruleResult of result.rulesChecked) {
+      resultText += `**${ruleResult.ruleName}**\n`;
+      if (ruleResult.outcome.success) {
+        resultText += `\\- Matched trigger: ${ruleResult.outcome.matchedTrigger.name} (trigger #${ruleResult.outcome.matchedTrigger.num})\n`;
+      } else {
+        resultText += `\\- No match (${ruleResult.outcome.reason})\n`;
+      }
+    }
+
+    createChunkedMessage(message.channel, resultText.trim());
+  },
+});