feat: first batch of emojis 🎉

backend/src/plugins/ModActions/functions/actualCommands/actualMassUnbanCmd.ts

@@ -0,0 +1,127 @@
+import { ChatInputCommandInteraction, GuildMember, Snowflake, TextBasedChannel } from "discord.js";
+import { GuildPluginData } from "knub";
+import { waitForReply } from "knub/helpers";
+import { CaseTypes } from "../../../../data/CaseTypes";
+import { LogType } from "../../../../data/LogType";
+import {
+  isContextInteraction,
+  sendContextResponse,
+  sendErrorMessage,
+  sendSuccessMessage,
+} from "../../../../pluginUtils";
+import { CasesPlugin } from "../../../Cases/CasesPlugin";
+import { LogsPlugin } from "../../../Logs/LogsPlugin";
+import { IgnoredEventType, ModActionsPluginType } from "../../types";
+import { formatReasonWithAttachments } from "../formatReasonWithAttachments";
+import { ignoreEvent } from "../ignoreEvent";
+import { isBanned } from "../isBanned";
+
+export async function actualMassUnbanCmd(
+  pluginData: GuildPluginData<ModActionsPluginType>,
+  context: TextBasedChannel | ChatInputCommandInteraction,
+  userIds: string[],
+  author: GuildMember,
+) {
+  // Limit to 100 users at once (arbitrary?)
+  if (userIds.length > 100) {
+    sendErrorMessage(pluginData, context, `Can only mass-unban max 100 users at once`);
+    return;
+  }
+
+  // Ask for unban reason (cleaner this way instead of trying to cram it into the args)
+  sendContextResponse(context, "Unban reason? `cancel` to cancel");
+  const unbanReasonReply = await waitForReply(
+    pluginData.client,
+    isContextInteraction(context) ? context.channel! : context,
+    author.id,
+  );
+  if (!unbanReasonReply || !unbanReasonReply.content || unbanReasonReply.content.toLowerCase().trim() === "cancel") {
+    sendErrorMessage(pluginData, context, "Cancelled");
+    return;
+  }
+
+  const unbanReason = formatReasonWithAttachments(unbanReasonReply.content, [...unbanReasonReply.attachments.values()]);
+
+  // Ignore automatic unban cases and logs for these users
+  // We'll create our own cases below and post a single "mass unbanned" log instead
+  userIds.forEach((userId) => {
+    // Use longer timeouts since this can take a while
+    ignoreEvent(pluginData, IgnoredEventType.Unban, userId, 120 * 1000);
+    pluginData.state.serverLogs.ignoreLog(LogType.MEMBER_UNBAN, userId, 120 * 1000);
+  });
+
+  // Show a loading indicator since this can take a while
+  const loadingMsg = await sendContextResponse(context, "Unbanning...");
+
+  // Unban each user and count failed unbans (if any)
+  const failedUnbans: Array<{ userId: string; reason: UnbanFailReasons }> = [];
+  const casesPlugin = pluginData.getPlugin(CasesPlugin);
+  for (const userId of userIds) {
+    if (!(await isBanned(pluginData, userId))) {
+      failedUnbans.push({ userId, reason: UnbanFailReasons.NOT_BANNED });
+      continue;
+    }
+
+    try {
+      await pluginData.guild.bans.remove(userId as Snowflake, unbanReason ?? undefined);
+
+      await casesPlugin.createCase({
+        userId,
+        modId: author.id,
+        type: CaseTypes.Unban,
+        reason: `Mass unban: ${unbanReason}`,
+        postInCaseLogOverride: false,
+      });
+    } catch {
+      failedUnbans.push({ userId, reason: UnbanFailReasons.UNBAN_FAILED });
+    }
+  }
+
+  // Clear loading indicator
+  loadingMsg.delete();
+
+  const successfulUnbanCount = userIds.length - failedUnbans.length;
+  if (successfulUnbanCount === 0) {
+    // All unbans failed - don't create a log entry and notify the user
+    sendErrorMessage(pluginData, context, "All unbans failed. Make sure the IDs are valid and banned.");
+  } else {
+    // Some or all unbans were successful. Create a log entry for the mass unban and notify the user.
+    pluginData.getPlugin(LogsPlugin).logMassUnban({
+      mod: author.user,
+      count: successfulUnbanCount,
+      reason: unbanReason,
+    });
+
+    if (failedUnbans.length) {
+      const notBanned = failedUnbans.filter((x) => x.reason === UnbanFailReasons.NOT_BANNED);
+      const unbanFailed = failedUnbans.filter((x) => x.reason === UnbanFailReasons.UNBAN_FAILED);
+
+      let failedMsg = "";
+      if (notBanned.length > 0) {
+        failedMsg += `${notBanned.length}x ${UnbanFailReasons.NOT_BANNED}:`;
+        notBanned.forEach((fail) => {
+          failedMsg += " " + fail.userId;
+        });
+      }
+      if (unbanFailed.length > 0) {
+        failedMsg += `\n${unbanFailed.length}x ${UnbanFailReasons.UNBAN_FAILED}:`;
+        unbanFailed.forEach((fail) => {
+          failedMsg += " " + fail.userId;
+        });
+      }
+
+      sendSuccessMessage(
+        pluginData,
+        context,
+        `Unbanned ${successfulUnbanCount} users, ${failedUnbans.length} failed:\n${failedMsg}`,
+      );
+    } else {
+      sendSuccessMessage(pluginData, context, `Unbanned ${successfulUnbanCount} users successfully`);
+    }
+  }
+}
+
+enum UnbanFailReasons {
+  NOT_BANNED = "Not banned",
+  UNBAN_FAILED = "Unban failed",
+}