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

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