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) {
        this.client.configManager.config[guildId!]!.message_filter ??= {
            enabled: true,
            delete_message: true,
            send_logs: true
        } as any;

        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}`
                                }
                            });
                        }
                    });

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

                break;
        }
    }
}
1	/**
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	this.client.configManager.config[guildId!]!.message_filter ??= {
81	enabled: true,
82	delete_message: true,
83	send_logs: true
84	} as any;
85
86	this.client.configManager.config[guildId!]!.message_filter!.data ??= {
87	blocked_tokens: [],
88	blocked_words: [],
89	blocked_messages: []
90	};
91
92	this.client.configManager.config[guildId!]!.message_filter!.data!.blocked_words ??= [];
93	}
94
95	async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
96	const subcommand = (
97	context.isLegacy ? context.parsedNamedArgs.subcommand : context.options.getSubcommand(true)
98	)?.toString();
99
100	if (!this.subcommandsCustom.includes(subcommand)) {
101	await this.error(
102	message,
103	`Invalid subcommand provided. The valid subcommands are: \`${this.subcommandsCustom.join("`, `")}\`.`
104	);
105	return;
106	}
107
108	if (context.isLegacy && context.args[1] === undefined && subcommand !== "list") {
109	await this.error(
110	message,
111	`You must specify a word ${
112	subcommand === "add" ? "to block" : subcommand === "remove" ? "to remove" : "to check"
113	}!`
114	);
115	return;
116	}
117
118	if (!this.client.configManager.config[message.guildId!]) {
119	return;
120	}
121
122	await this.deferIfInteraction(message);
123
124	if (context.isLegacy) {
125	context.args.shift();
126	}
127
128	this.createConfigIfNotExists(message.guildId!);
129
130	switch (subcommand) {
131	case "add":
132	const words = context.isLegacy ? context.args : context.options.getString("words", true).split(/ +/);
133
134	for await (const word of words) {
135	if (this.client.configManager.config[message.guildId!]?.message_filter?.data?.blocked_words.includes(word)) {
136	continue;
137	}
138
139	this.client.configManager.config[message.guildId!]?.message_filter?.data?.blocked_words.push(word);
140	}
141
142	await this.client.configManager.write();
143	await this.success(message, `The given word(s) have been blocked.`);
144	break;
145
146	case "has":
147	const word = context.isLegacy ? context.args[0] : context.options.getString("word", true);
148
149	if (this.client.configManager.config[message.guildId!]?.message_filter?.data?.blocked_words.includes(word)) {
150	await this.success(message, `This word is in the blocklist.`);
151	} else {
152	await this.error(message, `This word is not in the blocklist.`);
153	}
154
155	return;
156
157	case "remove":
158	const wordsToRemove = context.isLegacy ? context.args : context.options.getString("words", true).split(/ +/);
159
160	for await (const word of wordsToRemove) {
161	const index =
162	this.client.configManager.config[message.guildId!]?.message_filter?.data?.blocked_words.indexOf(word);
163
164	if (!index \|\| index === -1) {
165	continue;
166	}
167
168	this.client.configManager.config[message.guildId!]?.message_filter?.data?.blocked_words.splice(index, 1);
169	}
170
171	await this.client.configManager.write();
172	await this.success(message, `The given word(s) have been unblocked.`);
173	break;
174
175	case "list":
176	{
177	const words: string[] =
178	this.client.configManager.config[message.guildId!]?.message_filter?.data?.blocked_words ?? [];
179	const safeWords: string[][] = [];
180	let length = 0;
181
182	for (const unsafeWord of words) {
183	if (safeWords.length === 0) safeWords.push([]);
184
185	const word = escapeMarkdown(unsafeWord);
186
187	if (length + word.length >= 3000) {
188	safeWords.push([word]);
189	length = word.length;
190	continue;
191	}
192
193	const index = safeWords.length - 1;
194
195	safeWords[index].push(word);
196	length += word.length;
197	}
198
199	const pagination = new Pagination(safeWords, {
200	channelId: message.channelId!,
201	guildId: message.guildId!,
202	limit: 1,
203	timeout: 120_000,
204	userId: message.member!.user.id,
205	client: this.client,
206	embedBuilder({ currentPage, data, maxPages }) {
207	return new EmbedBuilder({
208	author: {
209	name: `Blocked words in ${message.guild!.name}`,
210	iconURL: message.guild!.iconURL() ?? undefined
211	},
212	color: 0x007bff,
213	description: !data?.[0]?.length ? "No blocked words." : "`" + data?.[0]?.join("`, `") + "`",
214	footer: {
215	text: `Page ${currentPage} of ${maxPages}`
216	}
217	});
218	}
219	});
220
221	let reply = await this.deferredReply(message, await pagination.getMessageOptions());
222	await pagination.start(reply);
223	}
224
225	break;
226	}
227	}
228	}