censoring

README.md

@@ -5,6 +5,16 @@ A Discord bot that checks Discord channel names for banned words and prevents re
 ### /logchanel [channel?]
 Sets the channel where the bot will log if a channel meets the banned word criteria. If channel is omitted, the log channel will be disabled.
 
+### /blocklist
+#### /blocklist get
+Gets the global and server specific banned word list and returns it
+
+#### /blocklist add [word]
+Adds the word to the server specific blocklist
+
+#### /blocklist remove [word]
+Removes the word from the server specific blocklist
+
 ## Environment variables
 | Name        | Description                                                   | Required | Example             |
 | :---------- | :------------------------------------------------------------ | :------: | :------------------ |

index.ts

@@ -6,6 +6,7 @@ swapConsole();
 
 import "./src/client/init";
 import "./src/commands";
+import "./src/events";
 import client from "./src/client";
 
 function shutdown() {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "eu.astrogd.white-leopard",
-  "version": "1.0.0-alpha.1",
+  "version": "1.0.0-alpha.4",
   "description": "A Discord bot that checks channel names for blacklisted words and reverts the changes if necessary",
   "main": "build/index.js",
   "scripts": {

src/commands/blocklist.ts

@@ -0,0 +1,197 @@
+import { ChatInputCommandInteraction, PermissionFlagsBits, SlashCommandBuilder } from "discord.js";
+import { database, Badword } from "../data";
+import { IsNull } from "typeorm";
+import { getGuildSetting, isPremiumActive } from "../tools/data";
+import getDefaultEmbed, { getFailedEmbed, getSuccessEmbed } from "../tools/defaultEmbeds";
+import { getGuildChannel } from "../tools/discord";
+import { Color, Emoji } from "../tools/design";
+
+const builder = new SlashCommandBuilder();
+builder.setName("blocklist");
+builder.setDescription("Configures the servers blocklist");
+builder.setDefaultMemberPermissions(PermissionFlagsBits.ManageGuild);
+builder.setDMPermission(false);
+builder.addSubcommand((builder) => {
+    builder.setName("add");
+    builder.setDescription("Adds a word to the servers blocklist");
+    builder.addStringOption((option) => {
+        option.setName("word");
+        option.setDescription("The word to add");
+        option.setRequired(true);
+        option.setMaxLength(50);
+        return option;
+    });
+    return builder;
+});
+builder.addSubcommand((builder) => {
+    builder.setName("remove");
+    builder.setDescription("Removes a word from the servers blocklist");
+    builder.addStringOption((option) => {
+        option.setName("word");
+        option.setDescription("The word to remove");
+        option.setRequired(true);
+        option.setMaxLength(50);
+        return option;
+    });
+    return builder;
+});
+builder.addSubcommand((builder) => {
+    builder.setName("get");
+    builder.setDescription("Returns all words from the servers blocklist");
+    return builder;
+});
+
+async function execute(interaction: ChatInputCommandInteraction): Promise<void> {
+    if (!interaction.guildId) throw new Error("Command was executed in DM context");
+
+    const settings = await getGuildSetting(interaction.guildId);
+    const isPremium = isPremiumActive(settings.isPremiumUntil);
+
+    const logChannel = settings.notificationChannelID ? await getGuildChannel(interaction.guildId, settings.notificationChannelID) : null;
+
+    switch (interaction.options.getSubcommand(true)) {
+        case "get": {
+            const guildBadWords = await database.getRepository(Badword).find({
+                select: {
+                    value: true
+                },
+                where: {
+                    guildID: interaction.guildId
+                }
+            });
+            const globalBadWords = await database.getRepository(Badword).find({
+                where: {
+                    guildID: IsNull()
+                }
+            });
+
+            interaction.reply({
+                content: `\`\`\`Global bad word list\`\`\`\n||${globalBadWords.map((word) => word.value).reduce((prev, next) => prev + ", " + next, "").slice(2)} ||\n\`\`\`Local server bad word list (${guildBadWords.length}/${isPremium ? 100 : 10})\`\`\`\n||${guildBadWords.map((word) => word.value).reduce((prev, next) => prev + ", " + next, "").slice(2)} ||`,
+                ephemeral: true
+            }).catch();
+            break;
+        }
+
+        case "add": {
+            const count = await database.getRepository(Badword).count({
+                where: {
+                    guildID: interaction.guildId
+                }
+            });
+
+            const limit = isPremium ? 100 : 10;
+            if (count >= limit) {
+                const embed = getFailedEmbed();
+                embed.setDescription(`You reached the word limit for your guild. Please delete a word before adding a new one`);
+                interaction.reply({
+                    embeds: [embed],
+                    ephemeral: true
+                }).catch();
+                return;
+            }
+
+            const word = interaction.options.getString("word", true).toLowerCase();
+
+            const exists = await database.getRepository(Badword).count({
+                where: [
+                    {guildID: interaction.guildId, value: word},
+                    {guildID: IsNull(), value: word}
+                ]
+            }) > 0;
+
+            if (exists) {
+                const embed = getFailedEmbed();
+                embed.setDescription(`"${word}" already exists in the blocklist`);
+                interaction.reply({
+                    embeds: [embed],
+                    ephemeral: true
+                }).catch();
+                return;
+            }
+
+            const entry = new Badword();
+            entry.guildID = interaction.guildId;
+            entry.value = word;
+
+            await database.getRepository(Badword).save(entry);
+
+            const embed = getSuccessEmbed();
+            embed.setDescription(`"${word}" has been added to the blocklist`);
+            interaction.reply({
+                embeds: [embed],
+                ephemeral: true
+            });
+
+            const logMessage = getDefaultEmbed();
+            logMessage.setTitle(`${Emoji.SETTINGS} Word added`);
+            logMessage.setColor(Color.INFORMING_BLUE);
+            logMessage.setDescription(`"||${word}||" has been added to the blocklist`);
+            logMessage.addFields({
+                name: "This action was performed by",
+                value: `${interaction.user.tag} (${interaction.user.id})`
+            });
+            if (logChannel && logChannel.isTextBased()) {
+                logChannel.send({
+                    embeds: [logMessage]
+                }).catch();
+            }
+            break;
+        }
+
+        case "remove": {
+            const word = interaction.options.getString("word", true).toLowerCase();
+
+            const entry = await database.getRepository(Badword).findOne({
+                where: {
+                    guildID: interaction.guildId,
+                    value: word
+                }
+            });
+
+            if (!entry) {
+                const embed = getFailedEmbed();
+                embed.setDescription(`"${word}" was not found in the blocklist`);
+                interaction.reply({
+                    embeds: [embed],
+                    ephemeral: true
+                }).catch();
+                return;
+            }
+
+            await database.getRepository(Badword).delete({
+                id: entry.id
+            });
+
+            const embed = getSuccessEmbed();
+            embed.setDescription(`"${word}" has been removed from the blocklist`);
+            interaction.reply({
+                embeds: [embed],
+                ephemeral: true
+            }).catch();
+
+            const logMessage = getDefaultEmbed();
+            logMessage.setTitle(`${Emoji.SETTINGS} Word removed`);
+            logMessage.setColor(Color.INFORMING_BLUE);
+            logMessage.setDescription(`"||${word}||" has been removed from the blocklist`);
+            logMessage.addFields({
+                name: "This action was performed by",
+                value: `${interaction.user.tag} (${interaction.user.id})`
+            });
+            if (logChannel && logChannel.isTextBased()) {
+                logChannel.send({
+                    embeds: [logMessage]
+                }).catch();
+            }
+            break;
+        }
+
+        default: {
+            throw new Error(`"${interaction.options.getSubcommand(true)}" cannot be executed`);
+        }
+    }
+}
+
+export {
+    builder,
+    execute
+}

src/commands/ci.ts

@@ -1,6 +1,8 @@
 import * as notification from "./notification";
+import * as blocklist from "./blocklist";
+import * as info from "./info";
 
-const array = [notification.builder.toJSON()];
+const array = [notification.builder.toJSON(), blocklist.builder.toJSON(), info.builder.toJSON()];
 
 export {
     array

src/commands/index.ts

@@ -1,10 +1,14 @@
 import { ChatInputCommandInteraction, Collection, Events, SlashCommandBuilder } from "discord.js";
 import * as notification from "./notification";
+import * as blocklist from "./blocklist";
+import * as info from "./info";
 import client from "../client";
 import getDefaultEmbed from "../tools/defaultEmbeds";
 
 const commands = new Collection<string, { builder: SlashCommandBuilder, execute: (interaction: ChatInputCommandInteraction) => Promise<void> }>();
 commands.set(notification.builder.name, notification);
+commands.set(blocklist.builder.name, blocklist);
+commands.set(info.builder.name, info);
 
 client.on(Events.InteractionCreate, async (interaction) => {
     if (!interaction.isChatInputCommand()) return;

src/commands/info.ts

@@ -0,0 +1,66 @@
+import { ChatInputCommandInteraction, SlashCommandBuilder } from "discord.js";
+import { IsNull } from "typeorm";
+import { Badword, database } from "../data";
+import { getGuildSetting, isPremiumActive } from "../tools/data";
+import getDefaultEmbed from "../tools/defaultEmbeds";
+import pack from "../../package.json";
+import { Color, Emoji } from "../tools/design";
+
+const builder = new SlashCommandBuilder();
+builder.setName("info");
+builder.setDescription("Shows information about this bot and the server settings");
+builder.setDMPermission(false);
+
+async function execute(interaction: ChatInputCommandInteraction): Promise<void> {
+    if (!interaction.inGuild()) throw new Error("Command was executed outside guild context");
+
+    const settings = await getGuildSetting(interaction.guildId);
+    const isPremium = isPremiumActive(settings.isPremiumUntil);
+    const globalBlockedWordsCount = await database.getRepository(Badword).count({
+        where: {
+            guildID: IsNull()
+        }
+    });
+    const localBlockedWordsCount = await database.getRepository(Badword).count({
+        where: {
+            guildID: interaction.guildId
+        }
+    });
+
+    const embed = getDefaultEmbed();
+    embed.setTitle(`${Emoji.SECURITY_CHALLENGE} Channel filter V${pack.version} by AstroGD®`);
+    embed.setDescription(`Codename eu.astrogd.white-leopard`);
+    embed.setColor(isPremium ? Color.PREMIUM_ORANGE : Color.INFORMING_BLUE);
+    embed.addFields({
+        name: "What does this bot do?",
+        value: "This bot checks for blocked words contained in channel names and reverts the changes if found."
+    },{
+        name: "Author",
+        value: `This bot was created by AstroGD#0001 ${Emoji.ASTROGD} mainly for the official r/Overwatch2 Subreddit Discord server`
+    },{
+        name: "Server status",
+        value: `${isPremium ? Emoji.PREMIUM : Emoji.SWITCH_OFF} Premium features are ${isPremium ? "enabled" : "disabled"} on this server`,
+        inline: true
+    },{
+        name: "Global word count",
+        value: globalBlockedWordsCount.toString(),
+        inline: true
+    },{
+        name: "Local word count",
+        value: localBlockedWordsCount.toString(),
+        inline: true
+    },{
+        name: `${Emoji.WAVING} Have a question or want to say hello?`,
+        value: "Join the support Discord server at https://go.astrogd.eu/discord"
+    });
+
+    interaction.reply({
+        embeds: [embed],
+        ephemeral: true
+    }).catch();
+}
+
+export {
+    builder,
+    execute
+}

src/commands/notification.ts

@@ -1,7 +1,8 @@
-import { SlashCommandBuilder, PermissionFlagsBits, ChannelType, ChatInputCommandInteraction, NewsChannel, TextBasedChannel, CategoryChannel, StageChannel, TextChannel, PrivateThreadChannel, PublicThreadChannel, VoiceChannel, APIInteractionDataResolvedChannel, ForumChannel, GuildBasedChannel } from "discord.js";
+import { SlashCommandBuilder, PermissionFlagsBits, ChannelType, ChatInputCommandInteraction, NewsChannel, TextBasedChannel, CategoryChannel, StageChannel, TextChannel, PrivateThreadChannel, PublicThreadChannel, VoiceChannel, APIInteractionDataResolvedChannel, ForumChannel } from "discord.js";
 import getDefaultEmbed, { getSuccessEmbed } from "../tools/defaultEmbeds";
 import { database, GuildSetting } from "../data";
-import client from "../client";
+import { getGuildSetting } from "../tools/data";
+import { getGuildChannel } from "../tools/discord";
 
 const builder = new SlashCommandBuilder();
 builder.setName("logchannel");
@@ -16,31 +17,6 @@ builder.addChannelOption((option) => {
     return option;
 });
 
-async function getGuildSetting(guildID: string): Promise<GuildSetting> {
-    let guildSetting = await database.getRepository(GuildSetting).findOne({
-        where: {
-            id: guildID
-        }
-    });
-
-    if (!guildSetting) {
-        guildSetting = new GuildSetting();
-        guildSetting.id = guildID;
-        guildSetting.isPremiumUntil = null;
-        guildSetting.notificationChannelID = null;
-    }
-
-    return guildSetting;
-}
-
-async function getGuildChannel(guildID: string, channelID: string): Promise<GuildBasedChannel | null> {
-    const guild = await client.guilds.fetch(guildID);
-    if (!guild) return null;
-
-    const channel = await guild.channels.fetch(channelID);
-    return channel;
-}
-
 async function resetNotificationChannel(guildSetting: GuildSetting, interaction: ChatInputCommandInteraction): Promise<void> {
     const logChannel = guildSetting.notificationChannelID ? await getGuildChannel(guildSetting.id, guildSetting.notificationChannelID) : null;
     

src/data/migrations/1669300160536-data.ts

@@ -0,0 +1,26 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class data1669300160536 implements MigrationInterface {
+    name = 'data1669300160536'
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`
+            ALTER TABLE "guild_setting" DROP COLUMN "isPremiumUntil"
+        `);
+        await queryRunner.query(`
+            ALTER TABLE "guild_setting"
+            ADD "isPremiumUntil" TIMESTAMP
+        `);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`
+            ALTER TABLE "guild_setting" DROP COLUMN "isPremiumUntil"
+        `);
+        await queryRunner.query(`
+            ALTER TABLE "guild_setting"
+            ADD "isPremiumUntil" date
+        `);
+    }
+
+}

src/data/model/guildSetting.ts

@@ -8,6 +8,6 @@ export class GuildSetting {
     @Column("varchar", { nullable: true, default: null })
     notificationChannelID!: string | null;
 
-    @Column("date", { nullable: true, default: null })
+    @Column("timestamp", { nullable: true, default: null })
     isPremiumUntil!: Date | null;
 }

src/events/channelUpdate.ts

@@ -0,0 +1,85 @@
+import client from "../client";
+import { Events } from "discord.js";
+import { getGuildSetting, isPremiumActive } from "../tools/data";
+import { Badword, database } from "../data";
+import { IsNull } from "typeorm";
+import getDefaultEmbed, { getFailedEmbed } from "../tools/defaultEmbeds";
+import { getGuildChannel } from "../tools/discord";
+import { Color, Emoji } from "../tools/design";
+
+client.on(Events.ChannelUpdate, async (oldChannel, newChannel) => {
+    if (oldChannel.isDMBased() || newChannel.isDMBased()) return;
+    const name = newChannel.name.toLowerCase();
+    if (name === "censored") return;
+
+    const guild = oldChannel.guild;
+    const settings = await getGuildSetting(guild.id);
+    const isPremium = isPremiumActive(settings.isPremiumUntil);
+
+    const globalBlocklist = await database.getRepository(Badword).find({
+        where: {
+            guildID: IsNull()
+        }
+    });
+    const localBlocklist = await database.getRepository(Badword).find({
+        where: {
+            guildID: guild.id
+        }
+    });
+
+    const blocklist = [...globalBlocklist, ...localBlocklist];
+    let found: string | null = null;
+    
+    for (let i = 0; i < blocklist.length; i++) {
+        const word = blocklist[i];
+        if (!word) continue;
+
+        if (!name.includes(word.value)) continue;
+        found = word.value;
+        break;
+    }
+
+    if (found === null) return;
+
+    const logChannel = settings.notificationChannelID ? await getGuildChannel(guild.id, settings.notificationChannelID) : null;
+
+    try {
+        await newChannel.setName("CENSORED", `[Automated] Detected blocked word in channel name. Name has been censored`);
+    } catch (error) {
+        if (!logChannel || !logChannel.isTextBased()) return;
+        const embed = getFailedEmbed();
+        embed.setDescription(`Couldn't censor <#${newChannel.id}> (${newChannel.id}): ${error instanceof Error ? error.message : error}`);
+        if (isPremium) embed.addFields({
+            name: "Detected banned word:",
+            value: `||${found}||`
+        },{
+            name: "Old channel name:",
+            value: `||${name}||`,
+            inline: true
+        });
+
+        logChannel.send({
+            embeds: [embed]
+        }).catch();
+        return;
+    }
+
+    if (!logChannel || !logChannel.isTextBased()) return;
+    const embed = getDefaultEmbed();
+    embed.setTitle(`${Emoji.SECURITY_CHALLENGE_FAILED} Blocked word detected`);
+    embed.setDescription(`<#${newChannel.id}> (${newChannel.id}) has been renamed because its name contained a blocked word.`);
+    embed.setColor(Color.WARNING_YELLOW);
+    if (isPremium) embed.addFields({
+        name: "Detected banned word:",
+        value: `||${found}||`,
+        inline: true
+    },{
+        name: "Old channel name:",
+        value: `||${name}||`,
+        inline: true
+    });
+
+    logChannel.send({
+        embeds: [embed]
+    }).catch();
+});

src/events/index.ts

@@ -0,0 +1 @@
+import "./channelUpdate";

src/tools/data.ts

@@ -0,0 +1,26 @@
+import { database, GuildSetting } from "../data";
+
+export async function getGuildSetting(guildID: string): Promise<GuildSetting> {
+    let guildSetting = await database.getRepository(GuildSetting).findOne({
+        where: {
+            id: guildID
+        }
+    });
+
+    if (!guildSetting) {
+        guildSetting = new GuildSetting();
+        guildSetting.id = guildID;
+        guildSetting.isPremiumUntil = null;
+        guildSetting.notificationChannelID = null;
+    }
+
+    return guildSetting;
+}
+
+export function isPremiumActive(timestamp: Date | null): boolean {
+    if (timestamp === null) return false;
+    const now = Number(new Date());
+    const activeUntil = Number(timestamp);
+
+    return now < activeUntil;
+}

src/tools/defaultEmbeds.ts

@@ -1,6 +1,7 @@
 import pack from "../../package.json";
 import { EmbedBuilder } from "discord.js";
 import client from "../client";
+import { Color, Emoji } from "./design";
 
 // const _coolColors = [0x054566];
 
@@ -11,14 +12,21 @@ export default function getDefaultEmbed(): EmbedBuilder {
         iconURL: client.user?.avatarURL() || undefined,
     });
     embed.setTimestamp(new Date());
-    embed.setColor(0x3682cc);
+    embed.setColor(Color.ANONYMOUS_GRAY);
 
     return embed;
 }
 
 export function getSuccessEmbed(): EmbedBuilder {
     const embed = getDefaultEmbed();
-    embed.setTitle("Success");
-    embed.setColor(0x32d122);
+    embed.setTitle(`${Emoji.CHAT_APPROVE} Success`);
+    embed.setColor(Color.SUCCESSFUL_GREEN);
+    return embed;
+}
+
+export function getFailedEmbed(): EmbedBuilder {
+    const embed = getDefaultEmbed();
+    embed.setTitle(`${Emoji.CHAT_DENY} Failed`);
+    embed.setColor(Color.STOPSIGN_RED);
     return embed;
 }

src/tools/design.ts

@@ -0,0 +1,30 @@
+export enum Emoji {
+    DOUBLE_ARROW_RIGHT = "<:double_arrow_right:918922668936413267>",
+    SETTINGS = "<:settings:918912063970099232>",
+    TIME = "<:time:918913616743387156>",
+    DOCS = "<:docs:918917779283918899>",
+    MESSAGE = "<:message:918920872683786280>",
+    WAVING = "<:waving:918949572804505640>",
+    CHAT_APPROVE = "<:chat_approve:918910607317667860>",
+    CHAT_DENY = "<:chat_deny:918911411663544410>",
+    WARN = "<:warn:918914600181825556>",
+    INFORMATION = "<:information:918912973874028614>",
+    ERROR = "<:error:918915254447136841>",
+    SWITCH_ON = "<:switch_on:918915977662586892>",
+    SWITCH_OFF = "<:switch_off:918917065899925584>",
+    SWITCH_UNSET = "<:switch_unset:918917082807156796>",
+    SECURITY_CHALLENGE = "<:security_challenge:918919903405305946>",
+    SECURITY_CHALLENGE_SUCCESS = "<:security_challenge_success:918919918672576562>",
+    SECURITY_CHALLENGE_FAILED = "<:security_challenge_failed:918919932887064696>",
+    ASTROGD = "<:astrogd:918906741125697626>",
+    PREMIUM = "<:premium:918909591255908442>",
+}
+
+export enum Color {
+    PREMIUM_ORANGE = 0xFFC800,
+    SUCCESSFUL_GREEN = 0x77DE37,
+    STOPSIGN_RED = 0xDA2132,
+    WARNING_YELLOW = 0xF0E210,
+    INFORMING_BLUE = 0x2FAAE2,
+    ANONYMOUS_GRAY = 0x7B7B7B
+}

src/tools/discord.ts

@@ -0,0 +1,10 @@
+import { GuildBasedChannel } from "discord.js";
+import client from "../client";
+
+export async function getGuildChannel(guildID: string, channelID: string): Promise<GuildBasedChannel | null> {
+    const guild = await client.guilds.fetch(guildID);
+    if (!guild) return null;
+
+    const channel = await guild.channels.fetch(channelID);
+    return channel;
+}