commands/moderation/BeanCommand.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 { PermissionsBitField, SlashCommandBuilder, User } from "discord.js";
import Command, {
    ArgumentType,
    BasicCommandContext,
    CommandMessage,
    CommandReturn,
    ValidationRule
} from "../../core/Command";
import { protectSystemAdminsFromCommands } from "../../utils/troll";
import { createModerationEmbed } from "../../utils/utils";

export default class BeanCommand extends Command {
    public readonly name = "bean";
    public readonly validationRules: ValidationRule[] = [
        {
            types: [ArgumentType.User],
            entity: {
                notNull: true
            },
            errors: {
                required: "You must specify a user to bean!",
                "type:invalid": "You have specified an invalid user mention or ID.",
                "entity:null": "The given user does not exist!"
            },
            name: "user"
        },
        {
            types: [ArgumentType.StringRest],
            optional: true,
            errors: {
                "type:invalid": "You have specified an invalid bean reason.",
                "string:length:max": "Max length was exceeded for the reason."
            },
            string: {
                maxLength: 3999
            },
            name: "reason"
        }
    ];
    public readonly permissions = [
        PermissionsBitField.Flags.ManageMessages,
        PermissionsBitField.Flags.BanMembers
    ];
    public readonly permissionMode = "or";

    public readonly description = "Beans a user.";
    public readonly detailedDescription =
        "This command doesn't do anything special except DMing the user and telling them that they've been beaned.";

    public readonly slashCommandBuilder = new SlashCommandBuilder()
        .addUserOption(option =>
            option.setName("user").setDescription("The target user").setRequired(true)
        )
        .addStringOption(option =>
            option.setName("reason").setDescription("Reason for beaning this user")
        );

    async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
        await this.deferIfInteraction(message);

        const user = context.isLegacy
            ? context.parsedNamedArgs.user
            : context.options.getUser("user", true);
        const {
            commands: { moderation_command_behaviour }
        } = context.config;
        const deleteResponse = moderation_command_behaviour === "delete";

        if (await protectSystemAdminsFromCommands(this.client, message, user.id, "bean_safe")) {
            return;
        }

        const reason = context.isLegacy
            ? context.parsedNamedArgs.reason
            : context.options.getString("reason");

        const { id, reason: finalReason } = await this.client.infractionManager.createUserBean(
            user,
            {
                reason,
                guild: message.guild!,
                moderator: message.member!.user as User,
                abortOnTemplateNotFound: true
            }
        );

        await this.deferredReply(
            message,
            {
                embeds: [
                    await createModerationEmbed({
                        moderator: message.member!.user as User,
                        user,
                        actionDoneName: "beaned",
                        id,
                        color: 0x007bff,
                        reason: finalReason
                    })
                ]
            },
            deleteResponse ? "delete" : "default"
        );
    }
}
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 { PermissionsBitField, SlashCommandBuilder, User } from "discord.js";
21	import Command, {
22	ArgumentType,
23	BasicCommandContext,
24	CommandMessage,
25	CommandReturn,
26	ValidationRule
27	} from "../../core/Command";
28	import { protectSystemAdminsFromCommands } from "../../utils/troll";
29	import { createModerationEmbed } from "../../utils/utils";
30
31	export default class BeanCommand extends Command {
32	public readonly name = "bean";
33	public readonly validationRules: ValidationRule[] = [
34	{
35	types: [ArgumentType.User],
36	entity: {
37	notNull: true
38	},
39	errors: {
40	required: "You must specify a user to bean!",
41	"type:invalid": "You have specified an invalid user mention or ID.",
42	"entity:null": "The given user does not exist!"
43	},
44	name: "user"
45	},
46	{
47	types: [ArgumentType.StringRest],
48	optional: true,
49	errors: {
50	"type:invalid": "You have specified an invalid bean reason.",
51	"string:length:max": "Max length was exceeded for the reason."
52	},
53	string: {
54	maxLength: 3999
55	},
56	name: "reason"
57	}
58	];
59	public readonly permissions = [
60	PermissionsBitField.Flags.ManageMessages,
61	PermissionsBitField.Flags.BanMembers
62	];
63	public readonly permissionMode = "or";
64
65	public readonly description = "Beans a user.";
66	public readonly detailedDescription =
67	"This command doesn't do anything special except DMing the user and telling them that they've been beaned.";
68
69	public readonly slashCommandBuilder = new SlashCommandBuilder()
70	.addUserOption(option =>
71	option.setName("user").setDescription("The target user").setRequired(true)
72	)
73	.addStringOption(option =>
74	option.setName("reason").setDescription("Reason for beaning this user")
75	);
76
77	async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
78	await this.deferIfInteraction(message);
79
80	const user = context.isLegacy
81	? context.parsedNamedArgs.user
82	: context.options.getUser("user", true);
83	const {
84	commands: { moderation_command_behaviour }
85	} = context.config;
86	const deleteResponse = moderation_command_behaviour === "delete";
87
88	if (await protectSystemAdminsFromCommands(this.client, message, user.id, "bean_safe")) {
89	return;
90	}
91
92	const reason = context.isLegacy
93	? context.parsedNamedArgs.reason
94	: context.options.getString("reason");
95
96	const { id, reason: finalReason } = await this.client.infractionManager.createUserBean(
97	user,
98	{
99	reason,
100	guild: message.guild!,
101	moderator: message.member!.user as User,
102	abortOnTemplateNotFound: true
103	}
104	);
105
106	await this.deferredReply(
107	message,
108	{
109	embeds: [
110	await createModerationEmbed({
111	moderator: message.member!.user as User,
112	user,
113	actionDoneName: "beaned",
114	id,
115	color: 0x007bff,
116	reason: finalReason
117	})
118	]
119	},
120	deleteResponse ? "delete" : "default"
121	);
122	}
123	}