commands/settings/BlockedWordCommand.ts

/**
 * This file is part of SudoBot.
 *
 * Copyright (C) 2021-2023 OSN Developers.
 *
 * SudoBot is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * SudoBot is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with SudoBot. If not, see <https://www.gnu.org/licenses/>.
 */

import { EmbedBuilder, PermissionFlagsBits, SlashCommandBuilder, Snowflake, escapeMarkdown } from "discord.js";
import Command, { ArgumentType, BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";
import Pagination from "../../utils/Pagination";

export default class BlockedWordCommand extends Command {
    public readonly subcommandsCustom = ["add", "remove", "has", "list"];
    public readonly name = "blockedword";
    public readonly validationRules: ValidationRule[] = [
        {
            types: [ArgumentType.String],
            errors: {
                required: `Please provide a subcommand! The valid subcommands are: \`${this.subcommandsCustom.join("`, `")}\`.`,
                "type:invalid": `Please provide a __valid__ subcommand! The valid subcommands are: \`${this.subcommandsCustom.join(
                    "`, `"
                )}\`.`
            },
            name: "subcommand"
        }
    ];
    public readonly permissions = [PermissionFlagsBits.ManageGuild, PermissionFlagsBits.BanMembers];
    public readonly permissionMode = "or";

    public readonly description = "Manage blocked words.";

    public readonly detailedDescription = [
        "Add/remove/check/view the blocked words. All arguments, separated by spaces will be treated as different words.\n",
        "**Subcommands**",
        "* `add <...words>` - Add blocked word(s)",
        "* `remove <...words>` - Remove blocked word(s)",
        "* `has <word>` - Check if the given word is blocked",
        "* `list` - List all the blocked words"
    ].join("\n");

    public readonly argumentSyntaxes = ["<subcommand> [...args]"];

    public readonly slashCommandBuilder = new SlashCommandBuilder()
        .addSubcommand(subcommand =>
            subcommand
                .setName("add")
                .setDescription("Add blocked words")
                .addStringOption(option => option.setName("words").setDescription("The words to block").setRequired(true))
        )
        .addSubcommand(subcommand =>
            subcommand
                .setName("remove")
                .setDescription("Remove blocked words")
                .addStringOption(option =>
                    option.setName("words").setDescription("The words to remove from blocklist").setRequired(true)
                )
        )
        .addSubcommand(subcommand =>
            subcommand
                .setName("has")
                .setDescription("Check if a blocked word exists in the blocklist")
                .addStringOption(option => option.setName("word").setDescription("The word to check").setRequired(true))
        )
        .addSubcommand(subcommand => subcommand.setName("list").setDescription("Show the blocked word list"));
    public readonly aliases = ["blockedwords"];

    createConfigIfNotExists(guildId: Snowflake) {
        type RecordType = NonNullable<(typeof this.client.configManager.config)[string]>["message_filter"];

        this.client.configManager.config[guildId!]!.message_filter ??= {
            enabled: true,
            delete_message: true,
            send_logs: true
        } as RecordType;

        this.client.configManager.config[guildId!]!.message_filter!.data ??= {
            blocked_tokens: [],
            blocked_words: [],
            blocked_messages: []
        };

        this.client.configManager.config[guildId!]!.message_filter!.data!.blocked_words ??= [];
    }

    async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
        const subcommand = (
            context.isLegacy ? context.parsedNamedArgs.subcommand : context.options.getSubcommand(true)
        )?.toString();

        if (!this.subcommandsCustom.includes(subcommand)) {
            await this.error(
                message,
                `Invalid subcommand provided. The valid subcommands are: \`${this.subcommandsCustom.join("`, `")}\`.`
            );
            return;
        }

        if (context.isLegacy && context.args[1] === undefined && subcommand !== "list") {
            await this.error(
                message,
                `You must specify a word ${
                    subcommand === "add" ? "to block" : subcommand === "remove" ? "to remove" : "to check"
                }!`
            );
            return;
        }

        if (!this.client.configManager.config[message.guildId!]) {
            return;
        }

        await this.deferIfInteraction(message);

        if (context.isLegacy) {
            context.args.shift();
        }

        this.createConfigIfNotExists(message.guildId!);

        switch (subcommand) {
            case "add":
                {
                    const words = context.isLegacy ? context.args : context.options.getString("words", true).split(/ +/);

                    for await (const word of words) {
                        if (
                            this.client.configManager.config[message.guildId!]?.message_filter?.data?.blocked_words.includes(word)
                        ) {
                            continue;
                        }

                        this.client.configManager.config[message.guildId!]?.message_filter?.data?.blocked_words.push(word);
                    }

                    await this.client.configManager.write();
                    await this.success(message, "The given word(s) have been blocked.");
                }
                break;

            case "has":
                {
                    const word = context.isLegacy ? context.args[0] : context.options.getString("word", true);

                    if (this.client.configManager.config[message.guildId!]?.message_filter?.data?.blocked_words.includes(word)) {
                        await this.success(message, "This word is in the blocklist.");
                    } else {
                        await this.error(message, "This word is not in the blocklist.");
                    }
                }

                return;

            case "remove":
                {
                    const wordsToRemove = context.isLegacy ? context.args : context.options.getString("words", true).split(/ +/);

                    for await (const word of wordsToRemove) {
                        const index =
                            this.client.configManager.config[message.guildId!]?.message_filter?.data?.blocked_words.indexOf(word);

                        if (!index || index === -1) {
                            continue;
                        }

                        this.client.configManager.config[message.guildId!]?.message_filter?.data?.blocked_words.splice(index, 1);
                    }

                    await this.client.configManager.write();
                    await this.success(message, "The given word(s) have been unblocked.");
                }
                break;

            case "list":
                {
                    const words: string[] =
                        this.client.configManager.config[message.guildId!]?.message_filter?.data?.blocked_words ?? [];
                    const safeWords: string[][] = [];
                    let length = 0;

                    for (const unsafeWord of words) {
                        if (safeWords.length === 0) safeWords.push([]);

                        const word = escapeMarkdown(unsafeWord);

                        if (length + word.length >= 3000) {
                            safeWords.push([word]);
                            length = word.length;
                            continue;
                        }

                        const index = safeWords.length - 1;

                        safeWords[index].push(word);
                        length += word.length;
                    }

                    const pagination = new Pagination(safeWords, {
                        channelId: message.channelId!,
                        guildId: message.guildId!,
                        limit: 1,
                        timeout: 120_000,
                        userId: message.member!.user.id,
                        client: this.client,
                        embedBuilder({ currentPage, data, maxPages }) {
                            return new EmbedBuilder({
                                author: {
                                    name: `Blocked words in ${message.guild!.name}`,
                                    iconURL: message.guild!.iconURL() ?? undefined
                                },
                                color: 0x007bff,
                                description: !data?.[0]?.length ? "*No blocked words.*" : "`" + data?.[0]?.join("`, `") + "`",
                                footer: {
                                    text: `Page ${currentPage} of ${maxPages}`
                                }
                            });
                        }
                    });

                    const reply = await this.deferredReply(message, await pagination.getMessageOptions());
                    await pagination.start(reply);
                }

                break;
        }
    }
}
1	rakinar2	577	/**
2			* This file is part of SudoBot.
3			*
4			* Copyright (C) 2021-2023 OSN Developers.
5			*
6			* SudoBot is free software; you can redistribute it and/or modify it
7			* under the terms of the GNU Affero General Public License as published by
8			* the Free Software Foundation, either version 3 of the License, or
9			* (at your option) any later version.
10			*
11			* SudoBot is distributed in the hope that it will be useful, but
12			* WITHOUT ANY WARRANTY; without even the implied warranty of
13			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14			* GNU Affero General Public License for more details.
15			*
16			* You should have received a copy of the GNU Affero General Public License
17			* along with SudoBot. If not, see <https://www.gnu.org/licenses/>.
18			*/
19
20			import { EmbedBuilder, PermissionFlagsBits, SlashCommandBuilder, Snowflake, escapeMarkdown } from "discord.js";
21			import Command, { ArgumentType, BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";
22			import Pagination from "../../utils/Pagination";
23
24			export default class BlockedWordCommand extends Command {
25			public readonly subcommandsCustom = ["add", "remove", "has", "list"];
26			public readonly name = "blockedword";
27			public readonly validationRules: ValidationRule[] = [
28			{
29			types: [ArgumentType.String],
30			errors: {
31			required: `Please provide a subcommand! The valid subcommands are: \`${this.subcommandsCustom.join("`, `")}\`.`,
32			"type:invalid": `Please provide a __valid__ subcommand! The valid subcommands are: \`${this.subcommandsCustom.join(
33			"`, `"
34			)}\`.`
35			},
36			name: "subcommand"
37			}
38			];
39			public readonly permissions = [PermissionFlagsBits.ManageGuild, PermissionFlagsBits.BanMembers];
40			public readonly permissionMode = "or";
41
42			public readonly description = "Manage blocked words.";
43
44			public readonly detailedDescription = [
45			"Add/remove/check/view the blocked words. All arguments, separated by spaces will be treated as different words.\n",
46			"Subcommands",
47			"* `add <...words>` - Add blocked word(s)",
48			"* `remove <...words>` - Remove blocked word(s)",
49			"* `has <word>` - Check if the given word is blocked",
50			"* `list` - List all the blocked words"
51			].join("\n");
52
53			public readonly argumentSyntaxes = ["<subcommand> [...args]"];
54
55			public readonly slashCommandBuilder = new SlashCommandBuilder()
56			.addSubcommand(subcommand =>
57			subcommand
58			.setName("add")
59			.setDescription("Add blocked words")
60			.addStringOption(option => option.setName("words").setDescription("The words to block").setRequired(true))
61			)
62			.addSubcommand(subcommand =>
63			subcommand
64			.setName("remove")
65			.setDescription("Remove blocked words")
66			.addStringOption(option =>
67			option.setName("words").setDescription("The words to remove from blocklist").setRequired(true)
68			)
69			)
70			.addSubcommand(subcommand =>
71			subcommand
72			.setName("has")
73			.setDescription("Check if a blocked word exists in the blocklist")
74			.addStringOption(option => option.setName("word").setDescription("The word to check").setRequired(true))
75			)
76			.addSubcommand(subcommand => subcommand.setName("list").setDescription("Show the blocked word list"));
77			public readonly aliases = ["blockedwords"];
78
79			createConfigIfNotExists(guildId: Snowflake) {
80			type RecordType = NonNullable<(typeof this.client.configManager.config)[string]>["message_filter"];
81
82			this.client.configManager.config[guildId!]!.message_filter ??= {
83			enabled: true,
84			delete_message: true,
85			send_logs: true
86			} as RecordType;
87
88			this.client.configManager.config[guildId!]!.message_filter!.data ??= {
89			blocked_tokens: [],
90			blocked_words: [],
91			blocked_messages: []
92			};
93
94			this.client.configManager.config[guildId!]!.message_filter!.data!.blocked_words ??= [];
95			}
96
97			async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
98			const subcommand = (
99			context.isLegacy ? context.parsedNamedArgs.subcommand : context.options.getSubcommand(true)
100			)?.toString();
101
102			if (!this.subcommandsCustom.includes(subcommand)) {
103			await this.error(
104			message,
105			`Invalid subcommand provided. The valid subcommands are: \`${this.subcommandsCustom.join("`, `")}\`.`
106			);
107			return;
108			}
109
110			if (context.isLegacy && context.args[1] === undefined && subcommand !== "list") {
111			await this.error(
112			message,
113			`You must specify a word ${
114			subcommand === "add" ? "to block" : subcommand === "remove" ? "to remove" : "to check"
115			}!`
116			);
117			return;
118			}
119
120			if (!this.client.configManager.config[message.guildId!]) {
121			return;
122			}
123
124			await this.deferIfInteraction(message);
125
126			if (context.isLegacy) {
127			context.args.shift();
128			}
129
130			this.createConfigIfNotExists(message.guildId!);
131
132			switch (subcommand) {
133			case "add":
134			{
135			const words = context.isLegacy ? context.args : context.options.getString("words", true).split(/ +/);
136
137			for await (const word of words) {
138			if (
139			this.client.configManager.config[message.guildId!]?.message_filter?.data?.blocked_words.includes(word)
140			) {
141			continue;
142			}
143
144			this.client.configManager.config[message.guildId!]?.message_filter?.data?.blocked_words.push(word);
145			}
146
147			await this.client.configManager.write();
148			await this.success(message, "The given word(s) have been blocked.");
149			}
150			break;
151
152			case "has":
153			{
154			const word = context.isLegacy ? context.args[0] : context.options.getString("word", true);
155
156			if (this.client.configManager.config[message.guildId!]?.message_filter?.data?.blocked_words.includes(word)) {
157			await this.success(message, "This word is in the blocklist.");
158			} else {
159			await this.error(message, "This word is not in the blocklist.");
160			}
161			}
162
163			return;
164
165			case "remove":
166			{
167			const wordsToRemove = context.isLegacy ? context.args : context.options.getString("words", true).split(/ +/);
168
169			for await (const word of wordsToRemove) {
170			const index =
171			this.client.configManager.config[message.guildId!]?.message_filter?.data?.blocked_words.indexOf(word);
172
173			if (!index \|\| index === -1) {
174			continue;
175			}
176
177			this.client.configManager.config[message.guildId!]?.message_filter?.data?.blocked_words.splice(index, 1);
178			}
179
180			await this.client.configManager.write();
181			await this.success(message, "The given word(s) have been unblocked.");
182			}
183			break;
184
185			case "list":
186			{
187			const words: string[] =
188			this.client.configManager.config[message.guildId!]?.message_filter?.data?.blocked_words ?? [];
189			const safeWords: string[][] = [];
190			let length = 0;
191
192			for (const unsafeWord of words) {
193			if (safeWords.length === 0) safeWords.push([]);
194
195			const word = escapeMarkdown(unsafeWord);
196
197			if (length + word.length >= 3000) {
198			safeWords.push([word]);
199			length = word.length;
200			continue;
201			}
202
203			const index = safeWords.length - 1;
204
205			safeWords[index].push(word);
206			length += word.length;
207			}
208
209			const pagination = new Pagination(safeWords, {
210			channelId: message.channelId!,
211			guildId: message.guildId!,
212			limit: 1,
213			timeout: 120_000,
214			userId: message.member!.user.id,
215			client: this.client,
216			embedBuilder({ currentPage, data, maxPages }) {
217			return new EmbedBuilder({
218			author: {
219			name: `Blocked words in ${message.guild!.name}`,
220			iconURL: message.guild!.iconURL() ?? undefined
221			},
222			color: 0x007bff,
223			description: !data?.[0]?.length ? "No blocked words." : "`" + data?.[0]?.join("`, `") + "`",
224			footer: {
225			text: `Page ${currentPage} of ${maxPages}`
226			}
227			});
228			}
229			});
230
231			const reply = await this.deferredReply(message, await pagination.getMessageOptions());
232			await pagination.start(reply);
233			}
234
235			break;
236			}
237			}
238			}