Merge branch 'master' of github.com:ZeppelinBot/Zeppelin into feat/application-commands

2025-05-14 13:55:03 +00:00 · 2024-02-16 14:26:34 +01:00 · 2024-02-16 14:26:34 +01:00 · 2c0e4b37ca
commit 2c0e4b37ca
parent 592d037148 ffa9eeb3f5
235 changed files with 3464 additions and 4799 deletions
--- a/backend/src/plugins/ModActions/functions/actualCommands/actualAddCaseCmd.ts
+++ b/backend/src/plugins/ModActions/functions/actualCommands/actualAddCaseCmd.ts
@ -3,7 +3,7 @@ import { GuildPluginData } from "knub";
 import { CaseTypes } from "../../../../data/CaseTypes";
 import { Case } from "../../../../data/entities/Case";
 import { canActOn } from "../../../../pluginUtils";
-import { UnknownUser, renderUserUsername, resolveMember } from "../../../../utils";
+import { UnknownUser, renderUsername, resolveMember } from "../../../../utils";
 import { CasesPlugin } from "../../../Cases/CasesPlugin";
 import { CommonPlugin } from "../../../Common/CommonPlugin";
 import { LogsPlugin } from "../../../Logs/LogsPlugin";
@ -49,7 +49,7 @@ export async function actualAddCaseCmd(
  if (user) {
    pluginData
      .getPlugin(CommonPlugin)
-      .sendSuccessMessage(context, `Case #${theCase.case_number} created for **${renderUserUsername(user)}**`);
+      .sendSuccessMessage(context, `Case #${theCase.case_number} created for **${renderUsername(user)}**`);
  } else {
    pluginData.getPlugin(CommonPlugin).sendSuccessMessage(context, `Case #${theCase.case_number} created`);
  }
--- a/backend/src/plugins/ModActions/functions/actualCommands/actualBanCmd.ts
+++ b/backend/src/plugins/ModActions/functions/actualCommands/actualBanCmd.ts
@ -5,7 +5,7 @@ import { getMemberLevel } from "knub/helpers";
 import { CaseTypes } from "../../../../data/CaseTypes";
 import { clearExpiringTempban, registerExpiringTempban } from "../../../../data/loops/expiringTempbansLoop";
 import { canActOn, getContextChannel } from "../../../../pluginUtils";
-import { UnknownUser, UserNotificationMethod, renderUserUsername, resolveMember } from "../../../../utils";
+import { UnknownUser, UserNotificationMethod, renderUsername, resolveMember } from "../../../../utils";
 import { banLock } from "../../../../utils/lockNameHelpers";
 import { waitForButtonConfirm } from "../../../../utils/waitForInteraction";
 import { CasesPlugin } from "../../../Cases/CasesPlugin";
@ -183,7 +183,7 @@ export async function actualBanCmd(
  // Confirm the action to the moderator
  let response = "";
  if (!forceban) {
-    response = `Banned **${renderUserUsername(user)}** ${forTime}(Case #${banResult.case.case_number})`;
+    response = `Banned **${renderUsername(user)}** ${forTime}(Case #${banResult.case.case_number})`;
    if (banResult.notifyResult.text) response += ` (${banResult.notifyResult.text})`;
  } else {
    response = `Member forcebanned ${forTime}(Case #${banResult.case.case_number})`;
--- a/backend/src/plugins/ModActions/functions/actualCommands/actualCasesCmd.ts
+++ b/backend/src/plugins/ModActions/functions/actualCommands/actualCasesCmd.ts
@ -1,4 +1,4 @@
-import { APIEmbed, ChatInputCommandInteraction, Message, User } from "discord.js";
+import { APIEmbed, ChatInputCommandInteraction, GuildMember, Message, User } from "discord.js";
 import { GuildPluginData } from "knub";
 import { In } from "typeorm";
 import { FindOptionsWhere } from "typeorm/find-options/FindOptionsWhere";
@ -9,13 +9,13 @@ import {
  UnknownUser,
  chunkArray,
  emptyEmbedValue,
-  renderUserUsername,
+  renderUsername,
+  resolveMember,
  resolveUser,
  trimLines,
 } from "../../../../utils";
 import { asyncMap } from "../../../../utils/async";
 import { createPaginatedMessage } from "../../../../utils/createPaginatedMessage";
-import { getChunkedEmbedFields } from "../../../../utils/getChunkedEmbedFields";
 import { getGuildPrefix } from "../../../../utils/getGuildPrefix";
 import { CasesPlugin } from "../../../Cases/CasesPlugin";
 import { CommonPlugin } from "../../../Common/CommonPlugin";
@ -49,7 +49,7 @@ async function casesUserCmd(
  context: Message | ChatInputCommandInteraction,
  author: User,
  modId: string | null,
-  user: User | UnknownUser,
+  user: GuildMember | User | UnknownUser,
  modName: string,
  typesToShow: CaseTypes[],
  hidden: boolean | null,
@ -67,7 +67,7 @@ async function casesUserCmd(
  const hiddenCases = cases.filter((c) => c.is_hidden);

  const userName =
-    user instanceof UnknownUser && cases.length ? cases[cases.length - 1].user_name : renderUserUsername(user);
+    user instanceof UnknownUser && cases.length ? cases[cases.length - 1].user_name : renderUsername(user);

  if (cases.length === 0) {
    await sendContextResponse(context, `No cases found for **${userName}**${modId ? ` by ${modName}` : ""}.`);
@ -92,7 +92,6 @@ async function casesUserCmd(

  // Compact view (= regular message with a preview of each case)
  const lines = await asyncMap(casesToDisplay, (c) => casesPlugin.getCaseSummary(c, true, author.id));
-
  const prefix = getGuildPrefix(pluginData);
  const linesPerChunk = 10;
  const lineChunks = chunkArray(lines, linesPerChunk);
@ -124,12 +123,10 @@ async function casesUserCmd(
          lineChunks.length === 1
            ? `Cases for ${userName}${modId ? ` by ${modName}` : ""} (${lines.length} total)`
            : `Cases ${chunkStart}–${chunkEnd} of ${lines.length} for ${userName}`,
-        icon_url: user instanceof User ? user.displayAvatarURL() : undefined,
+        icon_url: user instanceof UnknownUser ? undefined : user.displayAvatarURL(),
      },
-      fields: [
-        ...getChunkedEmbedFields(emptyEmbedValue, linesInChunk.join("\n")),
-        ...(isLastChunk ? [footerField] : []),
-      ],
+      description: linesInChunk.join("\n"),
+      fields: [...(isLastChunk ? [footerField] : [])],
    } satisfies APIEmbed;

    sendContextResponse(context, { embeds: [embed] });
@ -141,7 +138,7 @@ async function casesModCmd(
  context: Message | ChatInputCommandInteraction,
  author: User,
  modId: string | null,
-  mod: User | UnknownUser,
+  mod: GuildMember | User | UnknownUser,
  modName: string,
  typesToShow: CaseTypes[],
  hidden: boolean | null,
@ -188,10 +185,10 @@ async function casesModCmd(
      const embed = {
        author: {
          name: title,
-          icon_url: mod instanceof User ? mod.displayAvatarURL() : undefined,
+          icon_url: mod instanceof UnknownUser ? undefined : mod.displayAvatarURL(),
        },
+        description: lines.join("\n"),
        fields: [
-          ...getChunkedEmbedFields(emptyEmbedValue, lines.join("\n")),
          {
            name: emptyEmbedValue,
            value: trimLines(`
@ -214,7 +211,7 @@ export async function actualCasesCmd(
  pluginData: GuildPluginData<ModActionsPluginType>,
  context: Message | ChatInputCommandInteraction,
  modId: string | null,
-  user: User | UnknownUser | null,
+  user: GuildMember | User | UnknownUser | null,
  author: User,
  notes: boolean | null,
  warns: boolean | null,
@ -226,8 +223,10 @@ export async function actualCasesCmd(
  hidden: boolean | null,
  expand: boolean | null,
 ) {
-  const mod = modId ? await resolveUser(pluginData.client, modId) : null;
-  const modName = modId ? (mod instanceof User ? renderUserUsername(mod) : modId) : renderUserUsername(author);
+  const mod = modId
+    ? (await resolveMember(pluginData.client, pluginData.guild, modId)) || (await resolveUser(pluginData.client, modId))
+    : null;
+  const modName = modId ? (mod instanceof UnknownUser ? modId : renderUsername(mod!)) : renderUsername(author);

  let typesToShow: CaseTypes[] = [];

--- a/backend/src/plugins/ModActions/functions/actualCommands/actualDeleteCaseCmd.ts
+++ b/backend/src/plugins/ModActions/functions/actualCommands/actualDeleteCaseCmd.ts
@ -2,7 +2,7 @@ import { ChatInputCommandInteraction, GuildMember, Message } from "discord.js";
 import { GuildPluginData, helpers } from "knub";
 import { Case } from "../../../../data/entities/Case";
 import { getContextChannel, sendContextResponse } from "../../../../pluginUtils";
-import { SECONDS } from "../../../../utils";
+import { SECONDS, renderUsername } from "../../../../utils";
 import { CasesPlugin } from "../../../Cases/CasesPlugin";
 import { CommonPlugin } from "../../../Common/CommonPlugin";
 import { LogsPlugin } from "../../../Logs/LogsPlugin";
@ -58,7 +58,7 @@ export async function actualDeleteCaseCmd(
      }
    }

-    const deletedByName = author.user.tag;
+    const deletedByName = renderUsername(author);

    const timeAndDate = pluginData.getPlugin(TimeAndDatePlugin);
    const deletedAt = timeAndDate.inGuildTz().format(timeAndDate.getDateFormat("pretty_datetime"));
--- a/backend/src/plugins/ModActions/functions/actualCommands/actualKickCmd.ts
+++ b/backend/src/plugins/ModActions/functions/actualCommands/actualKickCmd.ts
@ -2,14 +2,7 @@ import { Attachment, ChatInputCommandInteraction, GuildMember, Message, User } f
 import { GuildPluginData } from "knub";
 import { LogType } from "../../../../data/LogType";
 import { canActOn } from "../../../../pluginUtils";
-import {
-  DAYS,
-  SECONDS,
-  UnknownUser,
-  UserNotificationMethod,
-  renderUserUsername,
-  resolveMember,
-} from "../../../../utils";
+import { DAYS, SECONDS, UnknownUser, UserNotificationMethod, renderUsername, resolveMember } from "../../../../utils";
 import { CommonPlugin } from "../../../Common/CommonPlugin";
 import { IgnoredEventType, ModActionsPluginType } from "../../types";
 import { handleAttachmentLinkDetectionAndGetRestriction } from "../attachmentLinkReaction";
@ -91,7 +84,7 @@ export async function actualKickCmd(
  }

  // Confirm the action to the moderator
-  let response = `Kicked **${renderUserUsername(memberToKick.user)}** (Case #${kickResult.case.case_number})`;
+  let response = `Kicked **${renderUsername(memberToKick.user)}** (Case #${kickResult.case.case_number})`;

  if (kickResult.notifyResult.text) response += ` (${kickResult.notifyResult.text})`;
  pluginData.getPlugin(CommonPlugin).sendSuccessMessage(context, response);
--- a/backend/src/plugins/ModActions/functions/actualCommands/actualMuteCmd.ts
+++ b/backend/src/plugins/ModActions/functions/actualCommands/actualMuteCmd.ts
@ -8,7 +8,7 @@ import {
  UserNotificationMethod,
  asSingleLine,
  isDiscordAPIError,
-  renderUserUsername,
+  renderUsername,
 } from "../../../../utils";
 import { CommonPlugin } from "../../../Common/CommonPlugin";
 import { MutesPlugin } from "../../../Mutes/MutesPlugin";
@ -80,24 +80,24 @@ export async function actualMuteCmd(
  if (time) {
    if (muteResult.updatedExistingMute) {
      response = asSingleLine(`
-        Updated **${renderUserUsername(user)}**'s
+        Updated **${renderUsername(user)}**'s
        mute to ${timeUntilUnmute} (Case #${muteResult.case.case_number})
      `);
    } else {
      response = asSingleLine(`
-        Muted **${renderUserUsername(user)}**
+        Muted **${renderUsername(user)}**
        for ${timeUntilUnmute} (Case #${muteResult.case.case_number})
      `);
    }
  } else {
    if (muteResult.updatedExistingMute) {
      response = asSingleLine(`
-        Updated **${renderUserUsername(user)}**'s
+        Updated **${renderUsername(user)}**'s
        mute to indefinite (Case #${muteResult.case.case_number})
      `);
    } else {
      response = asSingleLine(`
-        Muted **${renderUserUsername(user)}**
+        Muted **${renderUsername(user)}**
        indefinitely (Case #${muteResult.case.case_number})
      `);
    }
--- a/backend/src/plugins/ModActions/functions/actualCommands/actualNoteCmd.ts
+++ b/backend/src/plugins/ModActions/functions/actualCommands/actualNoteCmd.ts
@ -1,7 +1,7 @@
 import { Attachment, ChatInputCommandInteraction, Message, User } from "discord.js";
 import { GuildPluginData } from "knub";
 import { CaseTypes } from "../../../../data/CaseTypes";
-import { UnknownUser, renderUserUsername } from "../../../../utils";
+import { UnknownUser, renderUsername } from "../../../../utils";
 import { CasesPlugin } from "../../../Cases/CasesPlugin";
 import { CommonPlugin } from "../../../Common/CommonPlugin";
 import { LogsPlugin } from "../../../Logs/LogsPlugin";
@ -21,7 +21,7 @@ export async function actualNoteCmd(
    return;
  }

-  const userName = renderUserUsername(user);
+  const userName = renderUsername(user);
  const reason = await formatReasonWithMessageLinkForAttachments(pluginData, note, context, attachments);

  const casesPlugin = pluginData.getPlugin(CasesPlugin);
--- a/backend/src/plugins/ModActions/functions/actualCommands/actualUnmuteCmd.ts
+++ b/backend/src/plugins/ModActions/functions/actualCommands/actualUnmuteCmd.ts
@ -1,7 +1,7 @@
 import { Attachment, ChatInputCommandInteraction, GuildMember, Message, User } from "discord.js";
 import humanizeDuration from "humanize-duration";
 import { GuildPluginData } from "knub";
-import { UnknownUser, asSingleLine, renderUserUsername } from "../../../../utils";
+import { UnknownUser, asSingleLine, renderUsername } from "../../../../utils";
 import { CommonPlugin } from "../../../Common/CommonPlugin";
 import { MutesPlugin } from "../../../Mutes/MutesPlugin";
 import { ModActionsPluginType } from "../../types";
@ -45,7 +45,7 @@ export async function actualUnmuteCmd(
    pluginData.getPlugin(CommonPlugin).sendSuccessMessage(
      context,
      asSingleLine(`
-        Unmuting **${renderUserUsername(user)}**
+        Unmuting **${renderUsername(user)}**
        in ${timeUntilUnmute} (Case #${result.case.case_number})
      `),
    );
@ -53,7 +53,7 @@ export async function actualUnmuteCmd(
    pluginData.getPlugin(CommonPlugin).sendSuccessMessage(
      context,
      asSingleLine(`
-        Unmuted **${renderUserUsername(user)}**
+        Unmuted **${renderUsername(user)}**
        (Case #${result.case.case_number})
      `),
    );
--- a/backend/src/plugins/ModActions/functions/actualCommands/actualWarnCmd.ts
+++ b/backend/src/plugins/ModActions/functions/actualCommands/actualWarnCmd.ts
@ -1,7 +1,7 @@
 import { Attachment, ChatInputCommandInteraction, GuildMember, Message } from "discord.js";
 import { GuildPluginData } from "knub";
 import { CaseTypes } from "../../../../data/CaseTypes";
-import { UserNotificationMethod, renderUserUsername } from "../../../../utils";
+import { UserNotificationMethod, renderUsername } from "../../../../utils";
 import { waitForButtonConfirm } from "../../../../utils/waitForInteraction";
 import { CasesPlugin } from "../../../Cases/CasesPlugin";
 import { CommonPlugin } from "../../../Common/CommonPlugin";
@ -63,6 +63,6 @@ export async function actualWarnCmd(
    .getPlugin(CommonPlugin)
    .sendSuccessMessage(
      context,
-      `Warned **${renderUserUsername(memberToWarn.user)}** (Case #${warnResult.case.case_number})${messageResultText}`,
+      `Warned **${renderUsername(memberToWarn.user)}** (Case #${warnResult.case.case_number})${messageResultText}`,
    );
 }
--- a/backend/src/plugins/ModActions/functions/banUserId.ts
+++ b/backend/src/plugins/ModActions/functions/banUserId.ts
@ -5,7 +5,7 @@ import { CaseTypes } from "../../../data/CaseTypes";
 import { LogType } from "../../../data/LogType";
 import { registerExpiringTempban } from "../../../data/loops/expiringTempbansLoop";
 import { logger } from "../../../logger";
-import { TemplateSafeValueContainer, renderTemplate } from "../../../templateFormatter";
+import { TemplateParseError, TemplateSafeValueContainer, renderTemplate } from "../../../templateFormatter";
 import {
  DAYS,
  SECONDS,
@ -53,30 +53,52 @@ export async function banUserId(

    if (contactMethods.length) {
      if (!banTime && config.ban_message) {
-        const banMessage = await renderTemplate(
-          config.ban_message,
-          new TemplateSafeValueContainer({
-            guildName: pluginData.guild.name,
-            reason: reasonWithAttachments,
-            moderator: banOptions.caseArgs?.modId
-              ? userToTemplateSafeUser(await resolveUser(pluginData.client, banOptions.caseArgs.modId))
-              : null,
-          }),
-        );
+        let banMessage: string;
+        try {
+          banMessage = await renderTemplate(
+            config.ban_message,
+            new TemplateSafeValueContainer({
+              guildName: pluginData.guild.name,
+              reason: reasonWithAttachments,
+              moderator: banOptions.caseArgs?.modId
+                ? userToTemplateSafeUser(await resolveUser(pluginData.client, banOptions.caseArgs.modId))
+                : null,
+            }),
+          );
+        } catch (err) {
+          if (err instanceof TemplateParseError) {
+            return {
+              status: "failed",
+              error: `Invalid ban_message format: ${err.message}`,
+            };
+          }
+          throw err;
+        }

        notifyResult = await notifyUser(member.user, banMessage, contactMethods);
      } else if (banTime && config.tempban_message) {
-        const banMessage = await renderTemplate(
-          config.tempban_message,
-          new TemplateSafeValueContainer({
-            guildName: pluginData.guild.name,
-            reason: reasonWithAttachments,
-            moderator: banOptions.caseArgs?.modId
-              ? userToTemplateSafeUser(await resolveUser(pluginData.client, banOptions.caseArgs.modId))
-              : null,
-            banTime: humanizeDuration(banTime),
-          }),
-        );
+        let banMessage: string;
+        try {
+          banMessage = await renderTemplate(
+            config.tempban_message,
+            new TemplateSafeValueContainer({
+              guildName: pluginData.guild.name,
+              reason: reasonWithAttachments,
+              moderator: banOptions.caseArgs?.modId
+                ? userToTemplateSafeUser(await resolveUser(pluginData.client, banOptions.caseArgs.modId))
+                : null,
+              banTime: humanizeDuration(banTime),
+            }),
+          );
+        } catch (err) {
+          if (err instanceof TemplateParseError) {
+            return {
+              status: "failed",
+              error: `Invalid tempban_message format: ${err.message}`,
+            };
+          }
+          throw err;
+        }

        notifyResult = await notifyUser(member.user, banMessage, contactMethods);
      } else {
--- a/backend/src/plugins/ModActions/functions/clearTempban.ts
+++ b/backend/src/plugins/ModActions/functions/clearTempban.ts
@ -2,10 +2,10 @@ import { Snowflake } from "discord.js";
 import humanizeDuration from "humanize-duration";
 import { GuildPluginData } from "knub";
 import moment from "moment-timezone";
-import { LogType } from "src/data/LogType";
-import { logger } from "src/logger";
 import { CaseTypes } from "../../../data/CaseTypes";
+import { LogType } from "../../../data/LogType";
 import { Tempban } from "../../../data/entities/Tempban";
+import { logger } from "../../../logger";
 import { resolveUser } from "../../../utils";
 import { CasesPlugin } from "../../Cases/CasesPlugin";
 import { LogsPlugin } from "../../Logs/LogsPlugin";
--- a/backend/src/plugins/ModActions/functions/kickMember.ts
+++ b/backend/src/plugins/ModActions/functions/kickMember.ts
@ -2,7 +2,7 @@ import { GuildMember } from "discord.js";
 import { GuildPluginData } from "knub";
 import { CaseTypes } from "../../../data/CaseTypes";
 import { LogType } from "../../../data/LogType";
-import { renderTemplate, TemplateSafeValueContainer } from "../../../templateFormatter";
+import { renderTemplate, TemplateParseError, TemplateSafeValueContainer } from "../../../templateFormatter";
 import { createUserNotificationError, notifyUser, resolveUser, ucfirst, UserNotificationResult } from "../../../utils";
 import { userToTemplateSafeUser } from "../../../utils/templateSafeObjects";
 import { CasesPlugin } from "../../Cases/CasesPlugin";
@ -32,16 +32,27 @@ export async function kickMember(

    if (contactMethods.length) {
      if (config.kick_message) {
-        const kickMessage = await renderTemplate(
-          config.kick_message,
-          new TemplateSafeValueContainer({
-            guildName: pluginData.guild.name,
-            reason: reasonWithAttachments,
-            moderator: kickOptions.caseArgs?.modId
-              ? userToTemplateSafeUser(await resolveUser(pluginData.client, kickOptions.caseArgs.modId))
-              : null,
-          }),
-        );
+        let kickMessage: string;
+        try {
+          kickMessage = await renderTemplate(
+            config.kick_message,
+            new TemplateSafeValueContainer({
+              guildName: pluginData.guild.name,
+              reason: reasonWithAttachments,
+              moderator: kickOptions.caseArgs?.modId
+                ? userToTemplateSafeUser(await resolveUser(pluginData.client, kickOptions.caseArgs.modId))
+                : null,
+            }),
+          );
+        } catch (err) {
+          if (err instanceof TemplateParseError) {
+            return {
+              status: "failed",
+              error: `Invalid kick_message format: ${err.message}`,
+            };
+          }
+          throw err;
+        }

        notifyResult = await notifyUser(member.user, kickMessage, contactMethods);
      } else {
--- a/backend/src/plugins/ModActions/functions/warnMember.ts
+++ b/backend/src/plugins/ModActions/functions/warnMember.ts
@ -2,7 +2,7 @@ import { GuildMember, Snowflake } from "discord.js";
 import { GuildPluginData } from "knub";
 import { CaseTypes } from "../../../data/CaseTypes";
 import { getContextChannel, isContextInteraction } from "../../../pluginUtils";
-import { TemplateSafeValueContainer, renderTemplate } from "../../../templateFormatter";
+import { TemplateParseError, TemplateSafeValueContainer, renderTemplate } from "../../../templateFormatter";
 import { UserNotificationResult, createUserNotificationError, notifyUser, resolveUser, ucfirst } from "../../../utils";
 import { userToTemplateSafeUser } from "../../../utils/templateSafeObjects";
 import { waitForButtonConfirm } from "../../../utils/waitForInteraction";
@ -22,16 +22,27 @@ export async function warnMember(

  let notifyResult: UserNotificationResult;
  if (config.warn_message) {
-    const warnMessage = await renderTemplate(
-      config.warn_message,
-      new TemplateSafeValueContainer({
-        guildName: pluginData.guild.name,
-        reason: reasonWithAttachments,
-        moderator: warnOptions.caseArgs?.modId
-          ? userToTemplateSafeUser(await resolveUser(pluginData.client, warnOptions.caseArgs.modId))
-          : null,
-      }),
-    );
+    let warnMessage: string;
+    try {
+      warnMessage = await renderTemplate(
+        config.warn_message,
+        new TemplateSafeValueContainer({
+          guildName: pluginData.guild.name,
+          reason: reasonWithAttachments,
+          moderator: warnOptions.caseArgs?.modId
+            ? userToTemplateSafeUser(await resolveUser(pluginData.client, warnOptions.caseArgs.modId))
+            : null,
+        }),
+      );
+    } catch (err) {
+      if (err instanceof TemplateParseError) {
+        return {
+          status: "failed",
+          error: `Invalid warn_message format: ${err.message}`,
+        };
+      }
+      throw err;
+    }
    const contactMethods = warnOptions?.contactMethods
      ? warnOptions.contactMethods
      : getDefaultContactMethods(pluginData, "warn");