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 { logError } from "../../utils/Logger";
import { stringToTimeInterval } from "../../utils/datetime";
import { createModerationEmbed } from "../../utils/utils";

export default class BanCommand extends Command {
    public readonly name = "ban";
    public readonly validationRules: ValidationRule[] = [
        {
            types: [ArgumentType.User],
            entity: {
                notNull: true
            },
            errors: {
                required: "You must specify a user to ban!",
                "type:invalid": "You have specified an invalid user mention or ID.",
                "entity:null": "The given user does not exist!"
            }
        },
        {
            types: [ArgumentType.TimeInterval, ArgumentType.StringRest],
            optional: true,
            errors: {
                "time:range":
                    "The message deletion range must be a time interval from 0 second to 604800 seconds (7 days).",
                "type:invalid":
                    "You have specified an invalid argument. The system expected you to provide a ban reason or the message deletion range here."
            },
            time: {
                min: 0,
                max: 604800,
                unit: "s"
            },
            string: {
                maxLength: 3999
            }
        },
        {
            types: [ArgumentType.StringRest],
            optional: true,
            errors: {
                "type:invalid": "You have specified an invalid ban reason."
            },
            string: {
                maxLength: 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 (
                !(await 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 infraction = 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,
            abortOnTemplateNotFound: true
        });

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

        await this.deferredReply(
            message,
            {
                embeds: [
                    await createModerationEmbed({
                        user,
                        moderator: message.member!.user as 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: `${infraction.id}`,
                        reason: infraction.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 { 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, {
30	ArgumentType,
31	BasicCommandContext,
32	CommandMessage,
33	CommandReturn,
34	ValidationRule
35	} from "../../core/Command";
36	import { logError } from "../../utils/Logger";
37	import { stringToTimeInterval } from "../../utils/datetime";
38	import { createModerationEmbed } from "../../utils/utils";
39
40	export default class BanCommand extends Command {
41	public readonly name = "ban";
42	public readonly validationRules: ValidationRule[] = [
43	{
44	types: [ArgumentType.User],
45	entity: {
46	notNull: true
47	},
48	errors: {
49	required: "You must specify a user to ban!",
50	"type:invalid": "You have specified an invalid user mention or ID.",
51	"entity:null": "The given user does not exist!"
52	}
53	},
54	{
55	types: [ArgumentType.TimeInterval, ArgumentType.StringRest],
56	optional: true,
57	errors: {
58	"time:range":
59	"The message deletion range must be a time interval from 0 second to 604800 seconds (7 days).",
60	"type:invalid":
61	"You have specified an invalid argument. The system expected you to provide a ban reason or the message deletion range here."
62	},
63	time: {
64	min: 0,
65	max: 604800,
66	unit: "s"
67	},
68	string: {
69	maxLength: 3999
70	}
71	},
72	{
73	types: [ArgumentType.StringRest],
74	optional: true,
75	errors: {
76	"type:invalid": "You have specified an invalid ban reason."
77	},
78	string: {
79	maxLength: 3999
80	}
81	}
82	];
83	public readonly permissions = [PermissionsBitField.Flags.BanMembers];
84
85	public readonly description = "Bans a user.";
86	public readonly detailedDescription =
87	"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.";
88	public readonly argumentSyntaxes = [
89	"<UserID\|UserMention> [Reason]",
90	"<UserID\|UserMention> [MessageDeletionTime] [Reason]"
91	];
92
93	public readonly botRequiredPermissions = [PermissionsBitField.Flags.BanMembers];
94
95	public readonly slashCommandBuilder = new SlashCommandBuilder()
96	.addUserOption(option =>
97	option.setName("user").setDescription("The user").setRequired(true)
98	)
99	.addStringOption(option =>
100	option.setName("reason").setDescription("The reason for banning this user")
101	)
102	.addStringOption(option =>
103	option
104	.setName("deletion_timeframe")
105	.setDescription("The message deletion timeframe (must be in range 0-604800s)")
106	)
107	.addBooleanOption(option =>
108	option
109	.setName("silent")
110	.setDescription(
111	"Specify if the system should not notify the user about this action. Defaults to false"
112	)
113	);
114
115	async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
116	if (message instanceof ChatInputCommandInteraction) await message.deferReply();
117
118	const user: User = context.isLegacy
119	? context.parsedArgs[0]
120	: context.options.getUser("user", true);
121	let deleteMessageSeconds = !context.isLegacy
122	? undefined
123	: typeof context.parsedArgs[1] === "number"
124	? context.parsedArgs[1]
125	: undefined;
126	const reason = !context.isLegacy
127	? context.options.getString("reason") ?? undefined
128	: typeof context.parsedArgs[1] === "string"
129	? context.parsedArgs[1]
130	: context.parsedArgs[2];
131	let durationMs: undefined \| number = undefined;
132
133	ifContextIsNotLegacyForDeleteTimeframe: if (!context.isLegacy) {
134	const input = context.options.getString("deletion_timeframe");
135
136	if (!input) break ifContextIsNotLegacyForDeleteTimeframe;
137
138	const { result, error } = stringToTimeInterval(input);
139
140	if (error) {
141	await this.deferredReply(message, {
142	content: `${this.emoji(
143	"error"
144	)} ${error} provided in the \`deletion_timeframe\` option`
145	});
146
147	return;
148	}
149
150	if (result < 0 \|\| result > 604800) {
151	await this.deferredReply(
152	message,
153	`${this.emoji(
154	"error"
155	)} The message deletion range must be a time interval from 0 second to 604800 seconds (7 days).`
156	);
157	return;
158	}
159
160	deleteMessageSeconds = result;
161	}
162
163	ifContextIsNotLegacy: if (!context.isLegacy) {
164	const input = context.options.getString("duration");
165
166	if (!input) break ifContextIsNotLegacy;
167
168	const { result, error } = stringToTimeInterval(input, { milliseconds: true });
169
170	if (error) {
171	await this.deferredReply(message, {
172	content: `${this.emoji("error")} ${error} provided in the \`duration\` option`
173	});
174
175	return;
176	}
177
178	durationMs = result;
179	}
180
181	try {
182	const member =
183	message.guild!.members.cache.get(user.id) ??
184	(await message.guild!.members.fetch(user.id));
185
186	if (
187	!(await this.client.permissionManager.shouldModerate(
188	member,
189	message.member! as GuildMember
190	))
191	) {
192	await this.error(message, "You don't have permission to ban this user!");
193	return;
194	}
195	} catch (e) {
196	logError(e);
197	}
198
199	const infraction = await this.client.infractionManager.createUserBan(user, {
200	guild: message.guild!,
201	moderator: message.member!.user as User,
202	deleteMessageSeconds,
203	reason,
204	notifyUser: context.isLegacy ? true : !context.options.getBoolean("silent"),
205	sendLog: true,
206	duration: durationMs,
207	autoRemoveQueue: true,
208	abortOnTemplateNotFound: true
209	});
210
211	if (!infraction) {
212	await this.error(message);
213	return;
214	}
215
216	await this.deferredReply(
217	message,
218	{
219	embeds: [
220	await createModerationEmbed({
221	user,
222	moderator: message.member!.user as User,
223	actionDoneName: "banned",
224	description: `**${escapeMarkdown(
225	user.tag
226	)}** has been banned from this server.`,
227	fields: [
228	{
229	name: "Message Deletion",
230	value: deleteMessageSeconds
231	? `Timeframe: ${formatDistanceToNow(
232	new Date(Date.now() - deleteMessageSeconds * 1000)
233	)}\nMessages in this timeframe by this user will be removed.`
234	: "No message will be deleted"
235	}
236	],
237	id: `${infraction.id}`,
238	reason: infraction.reason
239	})
240	]
241	},
242	"auto"
243	);
244	}
245	}