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

export default class BanCommand extends Command {
    public readonly name = "ban";
    public readonly validationRules: ValidationRule[] = [
        {
            types: [ArgumentType.User],
            entityNotNull: true,
            requiredErrorMessage: "You must specify a user to ban!",
            typeErrorMessage: "You have specified an invalid user mention or ID.",
            entityNotNullErrorMessage: "The given user does not exist!"
        },
        {
            types: [ArgumentType.TimeInterval, ArgumentType.StringRest],
            optional: true,
            minMaxErrorMessage: "The message deletion range must be a time interval from 0 second to 604800 seconds (7 days).",
            typeErrorMessage:
                "You have specified an invalid argument. The system expected you to provide a ban reason or the message deletion range here.",
            minValue: 0,
            maxValue: 604800,
            lengthMax: 3999,
            timeMilliseconds: false
        },
        {
            types: [ArgumentType.StringRest],
            optional: true,
            typeErrorMessage: "You have specified an invalid ban reason.",
            lengthMax: 3999
        }
    ];
    public readonly permissions = [PermissionsBitField.Flags.BanMembers];

    public readonly description = "Bans a user.";
    public readonly detailedDescription =
        "This command can ban users in the server or outside of the server. If the user is not in the server, you must specify their ID to ban them.";
    public readonly argumentSyntaxes = ["<UserID|UserMention> [Reason]", "<UserID|UserMention> [MessageDeletionTime] [Reason]"];

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

    public readonly slashCommandBuilder = new SlashCommandBuilder()
        .addUserOption(option => option.setName("user").setDescription("The user").setRequired(true))
        .addStringOption(option => option.setName("reason").setDescription("The reason for banning this user"))
        .addStringOption(option =>
            option.setName("deletion_timeframe").setDescription("The message deletion timeframe (must be in range 0-604800s)")
        )
        .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> {
        if (message instanceof ChatInputCommandInteraction) await message.deferReply();

        const user: User = context.isLegacy ? context.parsedArgs[0] : context.options.getUser("user", true);
        let deleteMessageSeconds = !context.isLegacy
            ? undefined
            : typeof context.parsedArgs[1] === "number"
            ? context.parsedArgs[1]
            : undefined;
        const reason = !context.isLegacy
            ? context.options.getString("reason") ?? undefined
            : typeof context.parsedArgs[1] === "string"
            ? context.parsedArgs[1]
            : context.parsedArgs[2];
        let durationMs: undefined | number = undefined;

        ifContextIsNotLegacyForDeleteTimeframe: if (!context.isLegacy) {
            const input = context.options.getString("deletion_timeframe");

            if (!input) break ifContextIsNotLegacyForDeleteTimeframe;

            const { result, error } = stringToTimeInterval(input);

            if (error) {
                await this.deferredReply(message, {
                    content: `${this.emoji("error")} ${error} provided in the \`deletion_timeframe\` option`
                });

                return;
            }

            if (result < 0 || result > 604800) {
                await this.deferredReply(
                    message,
                    `${this.emoji(
                        "error"
                    )} The message deletion range must be a time interval from 0 second to 604800 seconds (7 days).`
                );
                return;
            }

            deleteMessageSeconds = result;
        }

        ifContextIsNotLegacy: if (!context.isLegacy) {
            const input = context.options.getString("duration");

            if (!input) break ifContextIsNotLegacy;

            const { result, error } = stringToTimeInterval(input, { milliseconds: true });

            if (error) {
                await this.deferredReply(message, {
                    content: `${this.emoji("error")} ${error} provided in the \`duration\` option`
                });

                return;
            }

            durationMs = result;
        }

        try {
            const member = message.guild!.members.cache.get(user.id) ?? (await message.guild!.members.fetch(user.id));

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

        const id = await this.client.infractionManager.createUserBan(user, {
            guild: message.guild!,
            moderator: message.member!.user as User,
            deleteMessageSeconds,
            reason,
            notifyUser: context.isLegacy ? true : !context.options.getBoolean("silent"),
            sendLog: true,
            duration: durationMs,
            autoRemoveQueue: true
        });

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

        await this.deferredReply(message, {
            embeds: [
                await createModerationEmbed({
                    user,
                    actionDoneName: "banned",
                    description: `**${escapeMarkdown(user.tag)}** has been banned from this server.`,
                    fields: [
                        {
                            name: "Message Deletion",
                            value: deleteMessageSeconds
                                ? `Timeframe: ${formatDistanceToNow(
                                      new Date(Date.now() - deleteMessageSeconds * 1000)
                                  )}\nMessages in this timeframe by this user will be removed.`
                                : "*No message will be deleted*"
                        }
                    ],
                    id: `${id}`,
                    reason
                })
            ]
        });
    }
}
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 { formatDistanceToNow } from "date-fns";
21	import {
22	ChatInputCommandInteraction,
23	GuildMember,
24	PermissionsBitField,
25	SlashCommandBuilder,
26	User,
27	escapeMarkdown
28	} from "discord.js";
29	import Command, { ArgumentType, BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";
30	import { stringToTimeInterval } from "../../utils/datetime";
31	import { logError } from "../../utils/logger";
32	import { createModerationEmbed } from "../../utils/utils";
33
34	export default class BanCommand extends Command {
35	public readonly name = "ban";
36	public readonly validationRules: ValidationRule[] = [
37	{
38	types: [ArgumentType.User],
39	entityNotNull: true,
40	requiredErrorMessage: "You must specify a user to ban!",
41	typeErrorMessage: "You have specified an invalid user mention or ID.",
42	entityNotNullErrorMessage: "The given user does not exist!"
43	},
44	{
45	types: [ArgumentType.TimeInterval, ArgumentType.StringRest],
46	optional: true,
47	minMaxErrorMessage: "The message deletion range must be a time interval from 0 second to 604800 seconds (7 days).",
48	typeErrorMessage:
49	"You have specified an invalid argument. The system expected you to provide a ban reason or the message deletion range here.",
50	minValue: 0,
51	maxValue: 604800,
52	lengthMax: 3999,
53	timeMilliseconds: false
54	},
55	{
56	types: [ArgumentType.StringRest],
57	optional: true,
58	typeErrorMessage: "You have specified an invalid ban reason.",
59	lengthMax: 3999
60	}
61	];
62	public readonly permissions = [PermissionsBitField.Flags.BanMembers];
63
64	public readonly description = "Bans a user.";
65	public readonly detailedDescription =
66	"This command can ban users in the server or outside of the server. If the user is not in the server, you must specify their ID to ban them.";
67	public readonly argumentSyntaxes = ["<UserID\|UserMention> [Reason]", "<UserID\|UserMention> [MessageDeletionTime] [Reason]"];
68
69	public readonly botRequiredPermissions = [PermissionsBitField.Flags.BanMembers];
70
71	public readonly slashCommandBuilder = new SlashCommandBuilder()
72	.addUserOption(option => option.setName("user").setDescription("The user").setRequired(true))
73	.addStringOption(option => option.setName("reason").setDescription("The reason for banning this user"))
74	.addStringOption(option =>
75	option.setName("deletion_timeframe").setDescription("The message deletion timeframe (must be in range 0-604800s)")
76	)
77	.addBooleanOption(option =>
78	option
79	.setName("silent")
80	.setDescription("Specify if the system should not notify the user about this action. Defaults to false")
81	);
82
83	async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
84	if (message instanceof ChatInputCommandInteraction) await message.deferReply();
85
86	const user: User = context.isLegacy ? context.parsedArgs[0] : context.options.getUser("user", true);
87	let deleteMessageSeconds = !context.isLegacy
88	? undefined
89	: typeof context.parsedArgs[1] === "number"
90	? context.parsedArgs[1]
91	: undefined;
92	const reason = !context.isLegacy
93	? context.options.getString("reason") ?? undefined
94	: typeof context.parsedArgs[1] === "string"
95	? context.parsedArgs[1]
96	: context.parsedArgs[2];
97	let durationMs: undefined \| number = undefined;
98
99	ifContextIsNotLegacyForDeleteTimeframe: if (!context.isLegacy) {
100	const input = context.options.getString("deletion_timeframe");
101
102	if (!input) break ifContextIsNotLegacyForDeleteTimeframe;
103
104	const { result, error } = stringToTimeInterval(input);
105
106	if (error) {
107	await this.deferredReply(message, {
108	content: `${this.emoji("error")} ${error} provided in the \`deletion_timeframe\` option`
109	});
110
111	return;
112	}
113
114	if (result < 0 \|\| result > 604800) {
115	await this.deferredReply(
116	message,
117	`${this.emoji(
118	"error"
119	)} The message deletion range must be a time interval from 0 second to 604800 seconds (7 days).`
120	);
121	return;
122	}
123
124	deleteMessageSeconds = result;
125	}
126
127	ifContextIsNotLegacy: if (!context.isLegacy) {
128	const input = context.options.getString("duration");
129
130	if (!input) break ifContextIsNotLegacy;
131
132	const { result, error } = stringToTimeInterval(input, { milliseconds: true });
133
134	if (error) {
135	await this.deferredReply(message, {
136	content: `${this.emoji("error")} ${error} provided in the \`duration\` option`
137	});
138
139	return;
140	}
141
142	durationMs = result;
143	}
144
145	try {
146	const member = message.guild!.members.cache.get(user.id) ?? (await message.guild!.members.fetch(user.id));
147
148	if (!this.client.permissionManager.shouldModerate(member, message.member! as GuildMember)) {
149	await this.error(message, "You don't have permission to ban this user!");
150	return;
151	}
152	} catch (e) {
153	logError(e);
154	}
155
156	const id = await this.client.infractionManager.createUserBan(user, {
157	guild: message.guild!,
158	moderator: message.member!.user as User,
159	deleteMessageSeconds,
160	reason,
161	notifyUser: context.isLegacy ? true : !context.options.getBoolean("silent"),
162	sendLog: true,
163	duration: durationMs,
164	autoRemoveQueue: true
165	});
166
167	if (!id) {
168	await this.error(message);
169	return;
170	}
171
172	await this.deferredReply(message, {
173	embeds: [
174	await createModerationEmbed({
175	user,
176	actionDoneName: "banned",
177	description: `${escapeMarkdown(user.tag)} has been banned from this server.`,
178	fields: [
179	{
180	name: "Message Deletion",
181	value: deleteMessageSeconds
182	? `Timeframe: ${formatDistanceToNow(
183	new Date(Date.now() - deleteMessageSeconds * 1000)
184	)}\nMessages in this timeframe by this user will be removed.`
185	: "No message will be deleted"
186	}
187	],
188	id: `${id}`,
189	reason
190	})
191	]
192	});
193	}
194	}