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

export default class KickCommand extends Command {
    public readonly name = "kick";
    public readonly validationRules: ValidationRule[] = [
        {
            types: [ArgumentType.Member],
            entity: true,
            errors: {
                required: "You must specify a member to kick!",
                "type:invalid": "You have specified an invalid user mention or ID.",
                "entity:null": "The given member does not exist in the server!"
            },
            name: "member"
        },
        {
            types: [ArgumentType.StringRest],
            optional: true,
            errors: {
                "string:rest:length:max": "The kick reason must be less than 4000 characters long."
            },
            string: {
                maxLength: 3999
            },
            name: "reason"
        }
    ];
    public readonly permissions = [PermissionsBitField.Flags.KickMembers];

    public readonly description = "Kicks a server member.";
    public readonly detailedDescription = "This command kicks a server member.";
    public readonly argumentSyntaxes = ["<UserID|UserMention> [reason]"];

    public readonly botRequiredPermissions = [PermissionsBitField.Flags.KickMembers];

    public readonly slashCommandBuilder = new SlashCommandBuilder()
        .addUserOption(option =>
            option.setName("member").setDescription("The member").setRequired(true)
        )
        .addStringOption(option =>
            option.setName("reason").setDescription("The reason for kicking this user")
        )
        .addBooleanOption(option =>
            option
                .setName("silent")
                .setDescription(
                    "Specify if the system should not notify the user about this action. Defaults to false"
                )
        );

    async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
        const member: GuildMember | null = context.isLegacy
            ? context.parsedNamedArgs.member
            : context.options.getMember("member");

        if (!member) {
            return {
                __reply: true,
                ephemeral: true,
                content: "Invalid member given. Probably that user isn't a member of this server?"
            };
        }

        const reason: string | undefined = !context.isLegacy
            ? context.options.getString("reason") ?? undefined
            : context.parsedNamedArgs.reason ?? undefined;

        if (message instanceof ChatInputCommandInteraction) await message.deferReply();

        if (
            !(await this.client.permissionManager.shouldModerate(
                member,
                message.member! as GuildMember
            ))
        ) {
            await this.error(message, "You don't have permission to kick this user!");
            return;
        }

        const infraction = await this.client.infractionManager.createMemberKick(member, {
            guild: message.guild!,
            moderator: message.member!.user as User,
            reason,
            notifyUser: context.isLegacy ? true : !context.options.getBoolean("silent"),
            sendLog: true,
            abortOnTemplateNotFound: true
        });

        if (!infraction) {
            await this.error(message);
            return;
        }

        await this.deferredReply(
            message,
            {
                embeds: [
                    await createModerationEmbed({
                        moderator: message.member!.user as User,
                        user: member.user,
                        actionDoneName: "kicked",
                        id: infraction.id,
                        reason: infraction.reason,
                        description: `**${escapeMarkdown(
                            member.user.tag
                        )}** has been kicked from this server.`
                    })
                ]
            },
            "auto"
        );
    }
}
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 {
21	ChatInputCommandInteraction,
22	GuildMember,
23	PermissionsBitField,
24	SlashCommandBuilder,
25	User,
26	escapeMarkdown
27	} from "discord.js";
28	import Command, {
29	ArgumentType,
30	BasicCommandContext,
31	CommandMessage,
32	CommandReturn,
33	ValidationRule
34	} from "../../core/Command";
35	import { createModerationEmbed } from "../../utils/utils";
36
37	export default class KickCommand extends Command {
38	public readonly name = "kick";
39	public readonly validationRules: ValidationRule[] = [
40	{
41	types: [ArgumentType.Member],
42	entity: true,
43	errors: {
44	required: "You must specify a member to kick!",
45	"type:invalid": "You have specified an invalid user mention or ID.",
46	"entity:null": "The given member does not exist in the server!"
47	},
48	name: "member"
49	},
50	{
51	types: [ArgumentType.StringRest],
52	optional: true,
53	errors: {
54	"string:rest:length:max": "The kick reason must be less than 4000 characters long."
55	},
56	string: {
57	maxLength: 3999
58	},
59	name: "reason"
60	}
61	];
62	public readonly permissions = [PermissionsBitField.Flags.KickMembers];
63
64	public readonly description = "Kicks a server member.";
65	public readonly detailedDescription = "This command kicks a server member.";
66	public readonly argumentSyntaxes = ["<UserID\|UserMention> [reason]"];
67
68	public readonly botRequiredPermissions = [PermissionsBitField.Flags.KickMembers];
69
70	public readonly slashCommandBuilder = new SlashCommandBuilder()
71	.addUserOption(option =>
72	option.setName("member").setDescription("The member").setRequired(true)
73	)
74	.addStringOption(option =>
75	option.setName("reason").setDescription("The reason for kicking this user")
76	)
77	.addBooleanOption(option =>
78	option
79	.setName("silent")
80	.setDescription(
81	"Specify if the system should not notify the user about this action. Defaults to false"
82	)
83	);
84
85	async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
86	const member: GuildMember \| null = context.isLegacy
87	? context.parsedNamedArgs.member
88	: context.options.getMember("member");
89
90	if (!member) {
91	return {
92	__reply: true,
93	ephemeral: true,
94	content: "Invalid member given. Probably that user isn't a member of this server?"
95	};
96	}
97
98	const reason: string \| undefined = !context.isLegacy
99	? context.options.getString("reason") ?? undefined
100	: context.parsedNamedArgs.reason ?? undefined;
101
102	if (message instanceof ChatInputCommandInteraction) await message.deferReply();
103
104	if (
105	!(await this.client.permissionManager.shouldModerate(
106	member,
107	message.member! as GuildMember
108	))
109	) {
110	await this.error(message, "You don't have permission to kick this user!");
111	return;
112	}
113
114	const infraction = await this.client.infractionManager.createMemberKick(member, {
115	guild: message.guild!,
116	moderator: message.member!.user as User,
117	reason,
118	notifyUser: context.isLegacy ? true : !context.options.getBoolean("silent"),
119	sendLog: true,
120	abortOnTemplateNotFound: true
121	});
122
123	if (!infraction) {
124	await this.error(message);
125	return;
126	}
127
128	await this.deferredReply(
129	message,
130	{
131	embeds: [
132	await createModerationEmbed({
133	moderator: message.member!.user as User,
134	user: member.user,
135	actionDoneName: "kicked",
136	id: infraction.id,
137	reason: infraction.reason,
138	description: `**${escapeMarkdown(
139	member.user.tag
140	)}** has been kicked from this server.`
141	})
142	]
143	},
144	"auto"
145	);
146	}
147	}