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 id = 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
        });

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

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