commands/settings/BlockedTokenCommand.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, Message, 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 BlockedTokenCommand extends Command {
    public readonly subcommandsCustom = ["add", "remove", "has", "list"];
    public readonly name = "blockedtoken";
    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 tokens.";
    public readonly detailedDescription = [
        "Add/remove/check/view the blocked tokens. All arguments, separated by spaces will also be treated as a single token.\n",
        "**Subcommands**",
        "* `add <token>` - Add a blocked token",
        "* `remove <token>` - Remove a blocked token",
        "* `has <token>` - Check if the given token is blocked",
        "* `list` - List all the blocked tokens"
    ].join("\n");

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

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

    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_tokens ??= [];
    }

    getToken(message: CommandMessage, subcommand: string, context: BasicCommandContext) {
        return context.isLegacy
            ? (message as Message).content
                  .slice(this.client.configManager.config[message.guildId!]?.prefix.length)
                  .trimStart()
                  .slice(context.argv[0].length)
                  .trimStart()
                  .slice(subcommand.length)
                  .trimStart()
            : context.options.getString("token", true);
    }

    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 token ${
                    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 token = this.getToken(message, subcommand, context);

                    if (
                        !this.client.configManager.config[message.guildId!]?.message_filter?.data?.blocked_tokens.includes(token)
                    ) {
                        this.client.configManager.config[message.guildId!]?.message_filter?.data?.blocked_tokens.push(token);
                        await this.client.configManager.write();
                    }

                    await this.success(message, "The given token(s) have been blocked.");
                }
                break;

            case "has": {
                const token = this.getToken(message, subcommand, context);

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

                return;
            }

            case "remove":
                {
                    const token = this.getToken(message, subcommand, context);
                    const index =
                        this.client.configManager.config[message.guildId!]?.message_filter?.data?.blocked_tokens.indexOf(token);

                    if (index && index !== -1) {
                        this.client.configManager.config[message.guildId!]?.message_filter?.data?.blocked_tokens.splice(index, 1);
                        await this.client.configManager.write();
                    }

                    await this.success(message, "The given token(s) have been unblocked.");
                }
                break;

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

                    for (const unsafeToken of token) {
                        if (safeTokens.length === 0) safeTokens.push([]);

                        const token = escapeMarkdown(unsafeToken);

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

                        const index = safeTokens.length - 1;

                        safeTokens[index].push(token);
                        length += token.length;
                    }

                    const pagination = new Pagination(safeTokens, {
                        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 tokens in ${message.guild!.name}`,
                                    iconURL: message.guild!.iconURL() ?? undefined
                                },
                                color: 0x007bff,
                                description: !data?.[0]?.length ? "*No blocked tokens.*" : "`" + data[0].join("`\n`") + "`",
                                footer: {
                                    text: `Page ${currentPage} of ${maxPages}`
                                }
                            });
                        }
                    });

                    const 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, Message, 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 BlockedTokenCommand extends Command {
25	public readonly subcommandsCustom = ["add", "remove", "has", "list"];
26	public readonly name = "blockedtoken";
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
40	public readonly permissions = [PermissionFlagsBits.ManageGuild, PermissionFlagsBits.BanMembers];
41	public readonly permissionMode = "or";
42
43	public readonly description = "Manage blocked tokens.";
44	public readonly detailedDescription = [
45	"Add/remove/check/view the blocked tokens. All arguments, separated by spaces will also be treated as a single token.\n",
46	"Subcommands",
47	"* `add <token>` - Add a blocked token",
48	"* `remove <token>` - Remove a blocked token",
49	"* `has <token>` - Check if the given token is blocked",
50	"* `list` - List all the blocked tokens"
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("Adds a blocked token")
60	.addStringOption(option => option.setName("token").setDescription("The token to block").setRequired(true))
61	)
62	.addSubcommand(subcommand =>
63	subcommand
64	.setName("remove")
65	.setDescription("Remove blocked token")
66	.addStringOption(option =>
67	option.setName("token").setDescription("The token to remove from blocklist").setRequired(true)
68	)
69	)
70	.addSubcommand(subcommand =>
71	subcommand
72	.setName("has")
73	.setDescription("Check if a blocked token exists in the blocklist")
74	.addStringOption(option => option.setName("token").setDescription("The token to check").setRequired(true))
75	)
76	.addSubcommand(subcommand => subcommand.setName("list").setDescription("Show the blocked token list"));
77	public readonly aliases = ["blockedtokens"];
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_tokens ??= [];
95	}
96
97	getToken(message: CommandMessage, subcommand: string, context: BasicCommandContext) {
98	return context.isLegacy
99	? (message as Message).content
100	.slice(this.client.configManager.config[message.guildId!]?.prefix.length)
101	.trimStart()
102	.slice(context.argv[0].length)
103	.trimStart()
104	.slice(subcommand.length)
105	.trimStart()
106	: context.options.getString("token", true);
107	}
108
109	async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
110	const subcommand = (
111	context.isLegacy ? context.parsedNamedArgs.subcommand : context.options.getSubcommand(true)
112	)?.toString();
113
114	if (!this.subcommandsCustom.includes(subcommand)) {
115	await this.error(
116	message,
117	`Invalid subcommand provided. The valid subcommands are: \`${this.subcommandsCustom.join("`, `")}\`.`
118	);
119	return;
120	}
121
122	if (context.isLegacy && context.args[1] === undefined && subcommand !== "list") {
123	await this.error(
124	message,
125	`You must specify a token ${
126	subcommand === "add" ? "to block" : subcommand === "remove" ? "to remove" : "to check"
127	}!`
128	);
129	return;
130	}
131
132	if (!this.client.configManager.config[message.guildId!]) {
133	return;
134	}
135
136	await this.deferIfInteraction(message);
137
138	if (context.isLegacy) {
139	context.args.shift();
140	}
141
142	this.createConfigIfNotExists(message.guildId!);
143
144	switch (subcommand) {
145	case "add":
146	{
147	const token = this.getToken(message, subcommand, context);
148
149	if (
150	!this.client.configManager.config[message.guildId!]?.message_filter?.data?.blocked_tokens.includes(token)
151	) {
152	this.client.configManager.config[message.guildId!]?.message_filter?.data?.blocked_tokens.push(token);
153	await this.client.configManager.write();
154	}
155
156	await this.success(message, "The given token(s) have been blocked.");
157	}
158	break;
159
160	case "has": {
161	const token = this.getToken(message, subcommand, context);
162
163	if (this.client.configManager.config[message.guildId!]?.message_filter?.data?.blocked_tokens.includes(token)) {
164	await this.success(message, "This token is in the blocklist.");
165	} else {
166	await this.error(message, "This token is not in the blocklist.");
167	}
168
169	return;
170	}
171
172	case "remove":
173	{
174	const token = this.getToken(message, subcommand, context);
175	const index =
176	this.client.configManager.config[message.guildId!]?.message_filter?.data?.blocked_tokens.indexOf(token);
177
178	if (index && index !== -1) {
179	this.client.configManager.config[message.guildId!]?.message_filter?.data?.blocked_tokens.splice(index, 1);
180	await this.client.configManager.write();
181	}
182
183	await this.success(message, "The given token(s) have been unblocked.");
184	}
185	break;
186
187	case "list":
188	{
189	const token: string[] =
190	this.client.configManager.config[message.guildId!]?.message_filter?.data?.blocked_tokens ?? [];
191	const safeTokens: string[][] = [];
192	let length = 0;
193
194	for (const unsafeToken of token) {
195	if (safeTokens.length === 0) safeTokens.push([]);
196
197	const token = escapeMarkdown(unsafeToken);
198
199	if (length + token.length >= 3000) {
200	safeTokens.push([token]);
201	length = token.length;
202	continue;
203	}
204
205	const index = safeTokens.length - 1;
206
207	safeTokens[index].push(token);
208	length += token.length;
209	}
210
211	const pagination = new Pagination(safeTokens, {
212	channelId: message.channelId!,
213	guildId: message.guildId!,
214	limit: 1,
215	timeout: 120_000,
216	userId: message.member!.user.id,
217	client: this.client,
218	embedBuilder({ currentPage, data, maxPages }) {
219	return new EmbedBuilder({
220	author: {
221	name: `Blocked tokens in ${message.guild!.name}`,
222	iconURL: message.guild!.iconURL() ?? undefined
223	},
224	color: 0x007bff,
225	description: !data?.[0]?.length ? "No blocked tokens." : "`" + data[0].join("`\n`") + "`",
226	footer: {
227	text: `Page ${currentPage} of ${maxPages}`
228	}
229	});
230	}
231	});
232
233	const reply = await this.deferredReply(message, await pagination.getMessageOptions());
234	await pagination.start(reply);
235	}
236
237	break;
238	}
239	}
240	}