Add tempbans (#139)

backend/src/plugins/ModActions/commands/BanCmd.ts

@@ -1,14 +1,16 @@
 import { modActionsCmd, IgnoredEventType } from "../types";
 import { commandTypeHelpers as ct } from "../../../commandTypes";
 import { canActOn, sendErrorMessage, hasPermission, sendSuccessMessage } from "../../../pluginUtils";
-import { resolveUser, resolveMember } from "../../../utils";
+import { resolveUser, resolveMember, stripObjectToScalars, noop } from "../../../utils";
 import { isBanned } from "../functions/isBanned";
 import { readContactMethodsFromArgs } from "../functions/readContactMethodsFromArgs";
 import { formatReasonWithAttachments } from "../functions/formatReasonWithAttachments";
 import { banUserId } from "../functions/banUserId";
-import { ignoreEvent } from "../functions/ignoreEvent";
-import { LogType } from "../../../data/LogType";
 import { getMemberLevel, waitForReaction } from "knub/dist/helpers";
+import humanizeDuration from "humanize-duration";
+import { CasesPlugin } from "src/plugins/Cases/CasesPlugin";
+import { CaseTypes } from "src/data/CaseTypes";
+import { LogType } from "src/data/LogType";
 
 const opts = {
   mod: ct.member({ option: true }),
@@ -20,9 +22,16 @@ const opts = {
 export const BanCmd = modActionsCmd({
   trigger: "ban",
   permission: "can_ban",
-  description: "Ban the specified member",
+  description: "Ban or Tempban the specified member",
 
   signature: [
+    {
+      user: ct.string(),
+      time: ct.delay(),
+      reason: ct.string({ required: false, catchAll: true }),
+
+      ...opts,
+    },
     {
       user: ct.string(),
       reason: ct.string({ required: false, catchAll: true }),
@@ -37,24 +46,90 @@ export const BanCmd = modActionsCmd({
       sendErrorMessage(pluginData, msg.channel, `User not found`);
       return;
     }
+    const time = args["time"] ? args["time"] : null;
 
+    const reason = formatReasonWithAttachments(args.reason, msg.attachments);
     const memberToBan = await resolveMember(pluginData.client, pluginData.guild, user.id);
-
-    let forceban = false;
-    if (!memberToBan) {
-      const banned = await isBanned(pluginData, user.id);
-
-      if (banned) {
-        sendErrorMessage(pluginData, msg.channel, `User is already banned`);
+    // The moderator who did the action is the message author or, if used, the specified -mod
+    let mod = msg.member;
+    if (args.mod) {
+      if (!hasPermission(pluginData, "can_act_as_other", { message: msg, channelId: msg.channel.id })) {
+        sendErrorMessage(pluginData, msg.channel, "No permission for -mod");
         return;
+      }
+
+      mod = args.mod;
+    }
+
+    // acquire a lock because of the needed user-inputs below (if banned/not on server)
+    const lock = await pluginData.locks.acquire(`ban-${user.id}`);
+    let forceban = false;
+    const existingTempban = await pluginData.state.tempbans.findExistingTempbanForUserId(user.id);
+    const banned = await isBanned(pluginData, user.id);
+    if (!memberToBan) {
+      if (banned) {
+        // Abort if trying to ban user indefinitely if they are already banned indefinitely
+        if (!existingTempban && !time) {
+          sendErrorMessage(pluginData, msg.channel, `User is already banned indefinitely.`);
+          return;
+        }
+
+        // Ask the mod if we should update the existing ban
+        const alreadyBannedMsg = await msg.channel.createMessage("User is already banned, update ban?");
+        const reply = await waitForReaction(pluginData.client, alreadyBannedMsg, ["✅", "❌"], msg.author.id);
+
+        alreadyBannedMsg.delete().catch(noop);
+        if (!reply || reply.name === "❌") {
+          sendErrorMessage(pluginData, msg.channel, "User already banned, update cancelled by moderator");
+          lock.unlock();
+          return;
+        } else {
+          // Update or add new tempban / remove old tempban
+          if (time && time > 0) {
+            if (existingTempban) {
+              pluginData.state.tempbans.updateExpiryTime(user.id, time, mod.id);
+            } else {
+              pluginData.state.tempbans.addTempban(user.id, time, mod.id);
+            }
+          } else if (existingTempban) {
+            pluginData.state.tempbans.clear(user.id);
+          }
+
+          // Create a new case for the updated ban since we never stored the old case id and log the action
+          const casesPlugin = pluginData.getPlugin(CasesPlugin);
+          const createdCase = await casesPlugin.createCase({
+            modId: mod.id,
+            type: CaseTypes.Ban,
+            userId: user.id,
+            reason,
+            noteDetails: [`Ban updated to ${time ? humanizeDuration(time) : "indefinite"}`],
+          });
+          const logtype = time ? LogType.MEMBER_TIMED_BAN : LogType.MEMBER_BAN;
+          pluginData.state.serverLogs.log(logtype, {
+            mod: stripObjectToScalars(mod.user),
+            user: stripObjectToScalars(user),
+            caseNumber: createdCase.case_number,
+            reason,
+            banTime: time ? humanizeDuration(time) : null,
+          });
+
+          sendSuccessMessage(
+            pluginData,
+            msg.channel,
+            `Ban updated to ${time ? "expire in " + humanizeDuration(time) + " from now" : "indefinite"}`,
+          );
+          lock.unlock();
+          return;
+        }
       } else {
         // Ask the mod if we should upgrade to a forceban as the user is not on the server
         const notOnServerMsg = await msg.channel.createMessage("User not found on the server, forceban instead?");
         const reply = await waitForReaction(pluginData.client, notOnServerMsg, ["✅", "❌"], msg.author.id);
 
-        notOnServerMsg.delete();
+        notOnServerMsg.delete().catch(noop);
         if (!reply || reply.name === "❌") {
           sendErrorMessage(pluginData, msg.channel, "User not on server, ban cancelled by moderator");
+          lock.unlock();
           return;
         } else {
           forceban = true;
@@ -71,53 +146,62 @@ export const BanCmd = modActionsCmd({
         msg.channel,
         `Cannot ban: target permission level is equal or higher to yours, ${targetLevel} >= ${ourLevel}`,
       );
+      lock.unlock();
       return;
     }
 
-    // The moderator who did the action is the message author or, if used, the specified -mod
-    let mod = msg.member;
-    if (args.mod) {
-      if (!hasPermission(pluginData, "can_act_as_other", { message: msg, channelId: msg.channel.id })) {
-        sendErrorMessage(pluginData, msg.channel, "No permission for -mod");
-        return;
-      }
-
-      mod = args.mod;
-    }
-
     let contactMethods;
     try {
       contactMethods = readContactMethodsFromArgs(args);
     } catch (e) {
       sendErrorMessage(pluginData, msg.channel, e.message);
+      lock.unlock();
       return;
     }
 
     const deleteMessageDays = args["delete-days"] ?? pluginData.config.getForMessage(msg).ban_delete_message_days;
-    const reason = formatReasonWithAttachments(args.reason, msg.attachments);
-    const banResult = await banUserId(pluginData, user.id, reason, {
-      contactMethods,
-      caseArgs: {
-        modId: mod.id,
-        ppId: mod.id !== msg.author.id ? msg.author.id : undefined,
+    const banResult = await banUserId(
+      pluginData,
+      user.id,
+      reason,
+      {
+        contactMethods,
+        caseArgs: {
+          modId: mod.id,
+          ppId: mod.id !== msg.author.id ? msg.author.id : undefined,
+        },
+        deleteMessageDays,
       },
-      deleteMessageDays,
-    });
+      time,
+    );
 
     if (banResult.status === "failed") {
       sendErrorMessage(pluginData, msg.channel, `Failed to ban member: ${banResult.error}`);
+      lock.unlock();
       return;
     }
 
+    let forTime = "";
+    if (time && time > 0) {
+      if (existingTempban) {
+        pluginData.state.tempbans.updateExpiryTime(user.id, time, mod.id);
+      } else {
+        pluginData.state.tempbans.addTempban(user.id, time, mod.id);
+      }
+
+      forTime = `for ${humanizeDuration(time)} `;
+    }
+
     // Confirm the action to the moderator
     let response = "";
     if (!forceban) {
-      response = `Banned **${user.username}#${user.discriminator}** (Case #${banResult.case.case_number})`;
+      response = `Banned **${user.username}#${user.discriminator}** ${forTime}(Case #${banResult.case.case_number})`;
       if (banResult.notifyResult.text) response += ` (${banResult.notifyResult.text})`;
     } else {
-      response = `Member forcebanned (Case #${banResult.case.case_number})`;
+      response = `Member forcebanned ${forTime}(Case #${banResult.case.case_number})`;
     }
 
+    lock.unlock();
     sendSuccessMessage(pluginData, msg.channel, response);
   },
 });

backend/src/plugins/ModActions/commands/UnbanCmd.ts

@@ -64,6 +64,8 @@ export const UnbanCmd = modActionsCmd({
       reason,
       ppId: mod.id !== msg.author.id ? msg.author.id : undefined,
     });
+    // Delete the tempban, if one exists
+    pluginData.state.tempbans.clear(user.id);
 
     // Confirm the action
     sendSuccessMessage(pluginData, msg.channel, `Member unbanned (Case #${createdCase.case_number})`);