Context menu button, Ban Spammer

new-era-commands/context-menu/ban-spammer.js

@@ -0,0 +1,16 @@
+const {
+  ContextMenuCommandBuilder,
+  ApplicationCommandType,
+  PermissionFlagsBits,
+} = require('discord.js');
+const SpamBanningService = require('../../services/spam-ban/spam-banning.service');
+
+module.exports = {
+  data: new ContextMenuCommandBuilder()
+    .setName('Ban Spammer')
+    .setType(ApplicationCommandType.Message)
+    .setDefaultMemberPermissions(PermissionFlagsBits.BanMembers),
+  execute: async (interaction) => {
+    await SpamBanningService.handleInteraction(interaction);
+  },
+};

services/spam-ban/__snapshots__/spam-banning.service.test.js.snap

@@ -0,0 +1,202 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Attempting to ban a bot or team member Does not ban admins 1`] = `
+{
+  "content": "You do not have the permission to ban this user",
+  "ephemeral": true,
+}
+`;
+
+exports[`Attempting to ban a bot or team member Does not ban bots 1`] = `
+{
+  "content": "You do not have the permission to ban this user",
+  "ephemeral": true,
+}
+`;
+
+exports[`Attempting to ban a bot or team member Does not ban core 1`] = `
+{
+  "content": "You do not have the permission to ban this user",
+  "ephemeral": true,
+}
+`;
+
+exports[`Attempting to ban a bot or team member Does not ban maintainers 1`] = `
+{
+  "content": "You do not have the permission to ban this user",
+  "ephemeral": true,
+}
+`;
+
+exports[`Attempting to ban a bot or team member Does not ban moderators 1`] = `
+{
+  "content": "You do not have the permission to ban this user",
+  "ephemeral": true,
+}
+`;
+
+exports[`Attempting to log banned user in moderation log channel Sends log to the correct channel 1`] = `
+{
+  "embeds": [
+    {
+      "author": {
+        "icon_url": "image.jpg",
+        "name": "Ban | bad.spammer",
+      },
+      "color": 15747399,
+      "fields": [
+        {
+          "inline": true,
+          "name": "User",
+          "value": "<@123>",
+        },
+        {
+          "inline": true,
+          "name": "Moderator",
+          "value": "<@007>",
+        },
+        {
+          "inline": true,
+          "name": "Reason",
+          "value": "Account is compromised and spamming phishing links.",
+        },
+      ],
+      "footer": {
+        "text": "ID: 123",
+      },
+      "timestamp": "2024-02-01T00:00:00.000Z",
+    },
+  ],
+}
+`;
+
+exports[`Banning spammer that has left the server Reacts with the correct emoji to automod message 1`] = `"❌"`;
+
+exports[`Banning spammer that has left the server Sends back correct interaction reply to calling moderator 1`] = `
+{
+  "content": "Couldn't ban <@123>. User is not on the server.",
+  "ephemeral": true,
+}
+`;
+
+exports[`Banning spammer who has DM set to private Discord ban api is called with the correct reason 1`] = `
+{
+  "reason": "Account is compromised",
+}
+`;
+
+exports[`Banning spammer who has DM set to private Reacts with the correct emoji 1`] = `"✅"`;
+
+exports[`Banning spammer who has DM set to private Sends back correct interaction reply to calling moderator 1`] = `
+{
+  "content": "Banned <@123> for spam but wasn't able to contact the user.",
+  "ephemeral": true,
+}
+`;
+
+exports[`Banning spammer who has DM set to private Sends log to the correct channel 1`] = `
+{
+  "embeds": [
+    {
+      "author": {
+        "icon_url": "image.jpg",
+        "name": "Ban | bad.spammer",
+      },
+      "color": 15747399,
+      "fields": [
+        {
+          "inline": true,
+          "name": "User",
+          "value": "<@123>",
+        },
+        {
+          "inline": true,
+          "name": "Moderator",
+          "value": "<@007>",
+        },
+        {
+          "inline": true,
+          "name": "Reason",
+          "value": "Account is compromised and spamming phishing links.",
+        },
+      ],
+      "footer": {
+        "text": "ID: 123",
+      },
+      "timestamp": "2024-02-01T00:00:00.000Z",
+    },
+  ],
+}
+`;
+
+exports[`Banning spammer with DM enabled Discord ban api is called with the correct reason 1`] = `
+{
+  "reason": "Account is compromised",
+}
+`;
+
+exports[`Banning spammer with DM enabled Discord message api is called with the correct message 1`] = `
+{
+  "content": "Your account has been banned. Please enable embeds in Discord settings if you cannot see the message below.",
+  "embeds": [
+    {
+      "description": "Your account has been banned from The Odin Project Discord server for sending spam. If this account is compromised, please follow the steps linked in this [Discord support article about securing your account](https://support.discord.com/hc/en-us/articles/24160905919511-My-Discord-Account-was-Hacked-or-Compromised).
+
+Once your account is secure, you may appeal your ban by emailing \`[email protected]\` with the following template:
+
+- Banned username:
+- Reason for ban:
+- Date of ban:
+- Steps taken to secure my account:
+- Additional comments (optional):
+
+Please note that it may take at least several days for our volunteer staff to process your request.",
+      "title": "Banned: Compromised account / Spam",
+    },
+  ],
+}
+`;
+
+exports[`Banning spammer with DM enabled Reacts with the correct emoji 1`] = `"✅"`;
+
+exports[`Banning spammer with DM enabled Sends back correct interaction reply to calling moderator 1`] = `
+{
+  "content": "Successfully banned <@123> for spam.",
+  "ephemeral": true,
+}
+`;
+
+exports[`Banning spammer with DM enabled Sends log to the correct channel 1`] = `
+{
+  "embeds": [
+    {
+      "author": {
+        "icon_url": "image.jpg",
+        "name": "Ban | bad.spammer",
+      },
+      "color": 15747399,
+      "fields": [
+        {
+          "inline": true,
+          "name": "User",
+          "value": "<@123>",
+        },
+        {
+          "inline": true,
+          "name": "Moderator",
+          "value": "<@007>",
+        },
+        {
+          "inline": true,
+          "name": "Reason",
+          "value": "Account is compromised and spamming phishing links.",
+        },
+      ],
+      "footer": {
+        "text": "ID: 123",
+      },
+      "timestamp": "2024-02-01T00:00:00.000Z",
+    },
+  ],
+}
+`;

services/spam-ban/index.js

@@ -0,0 +1,3 @@
+const SpamBanningService = require('./spam-banning.service');
+
+module.exports = SpamBanningService;

services/spam-ban/spam-banning.service.js

@@ -0,0 +1,111 @@
+const { EmbedBuilder } = require('discord.js');
+const { isAdmin } = require('../../utils/is-admin');
+const config = require('../../config');
+
+class SpamBanningService {
+  static async handleInteraction(interaction) {
+    const message = interaction.options.getMessage('message');
+    if (message.author.bot || isAdmin(message.member)) {
+      interaction.reply({
+        content: 'You do not have the permission to ban this user',
+        ephemeral: true,
+      });
+      return;
+    }
+
+    try {
+      let reply;
+
+      if (!message.member) {
+        message.react('❌');
+        reply = `Couldn't ban <@${message.author.id}>. User is not on the server.`;
+      } else {
+        reply = await SpamBanningService.#banUser(message);
+        await SpamBanningService.#announceBan(interaction, message);
+      }
+
+      interaction.reply({ content: reply, ephemeral: true });
+    } catch (error) {
+      console.error(error);
+    }
+  }
+
+  static async #banUser(message) {
+    let reply = `Successfully banned <@${message.author.id}> for spam.`;
+    try {
+      // Make sure to send the message before banning otherwise user will not be found
+      await SpamBanningService.#sendMessageToUser(message.author);
+    } catch (error) {
+      reply = `Banned <@${message.author.id}> for spam but wasn't able to contact the user.`;
+    }
+
+    message.member.ban({ reason: 'Account is compromised' });
+    message.react('✅');
+    return reply;
+  }
+
+  static async #sendMessageToUser(author) {
+    const embedMessage = new EmbedBuilder()
+      .setTitle('Banned: Compromised account / Spam')
+      .setDescription(
+        `Your account has been banned from The Odin Project Discord server for sending spam. If this account is compromised, please follow the steps linked in this [Discord support article about securing your account](https://support.discord.com/hc/en-us/articles/24160905919511-My-Discord-Account-was-Hacked-or-Compromised).
+
+Once your account is secure, you may appeal your ban by emailing \`[email protected]\` with the following template:
+
+- Banned username:
+- Reason for ban:
+- Date of ban:
+- Steps taken to secure my account:
+- Additional comments (optional):
+
+Please note that it may take at least several days for our volunteer staff to process your request.`,
+      );
+
+    await author.send({
+      content:
+        'Your account has been banned. Please enable embeds in Discord settings if you cannot see the message below.',
+      embeds: [embedMessage],
+    });
+  }
+
+  static async #announceBan(interaction, message) {
+    const channelID = config.channels.moderationLogChannelId;
+    const channel = await interaction.guild.channels.fetch(channelID);
+    if (channel == null) {
+      throw new Error(`No channel with the ID ${channelID} was found.`);
+    }
+
+    const embed = {
+      timestamp: `${new Date().toISOString()}`,
+      color: 15747399,
+      footer: {
+        text: `ID: ${message.author.id}`,
+      },
+      author: {
+        name: `Ban | ${message.author.username}`,
+        icon_url: `${message.author.displayAvatarURL()}`,
+      },
+      fields: [
+        {
+          value: `<@${message.author.id}>`,
+          name: 'User',
+          inline: true,
+        },
+        {
+          value: `<@${interaction.user.id}>`,
+          name: 'Moderator',
+          inline: true,
+        },
+        {
+          value: 'Account is compromised and spamming phishing links.',
+          name: 'Reason',
+          inline: true,
+        },
+      ],
+    };
+
+    channel.send({ embeds: [embed] });
+  }
+}
+
+module.exports = SpamBanningService;