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

export default class TempBanCommand extends Command {
    public readonly name = "tempban";
    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!",
            name: "user"
        },
        {
            types: [ArgumentType.TimeInterval],
            typeErrorMessage: "You have specified an invalid argument. The system expected you to provide a duration here.",
            requiredErrorMessage: "Please specify a ban duration!",
            lengthMax: 3999,
            name: "duration",
            timeMilliseconds: true
        },
        {
            types: [ArgumentType.TimeInterval, ArgumentType.StringRest],
            optional: true,
            typeErrorMessage:
                "You have specified an invalid argument. The system expected you to provide a ban reason or the message deletion timeframe here.",
            lengthMax: 3999,
            minValue: 0,
            maxValue: 604800,
            name: "timeframeOrReason",
            minMaxErrorMessage: "The message deletion range must be a time interval from 0 second to 604800 seconds (7 days)."
        },
        {
            types: [ArgumentType.StringRest],
            optional: true,
            typeErrorMessage: "You have specified an invalid ban reason.",
            lengthMax: 3999,
            name: "reason"
        }
    ];
    public readonly permissions = [PermissionsBitField.Flags.BanMembers];

    public readonly description = "Temporarily bans a user.";
    public readonly detailedDescription =
        "This command temporarily bans a user. They'll be automatically unbanned after the specified duration.";
    public readonly argumentSyntaxes = ["<UserID|UserMention> <duration> [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("duration").setDescription("Ban duration"))
        .addStringOption(option =>
            option.setName("deletion_timeframe").setDescription("The message deletion timeframe (must be in range 0-604800)")
        )
        .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> {
        await this.deferIfInteraction(message);

        const user: User = context.isLegacy ? context.parsedNamedArgs.user : context.options.getUser("user", true);

        let duration = !context.isLegacy ? undefined : context.parsedNamedArgs.duration;
        let messageDeletionTimeframe = !context.isLegacy
            ? undefined
            : typeof context.parsedNamedArgs.timeframeOrReason === "number"
            ? context.parsedNamedArgs.timeframeOrReason
            : undefined;
        const reason = !context.isLegacy
            ? context.options.getString("reason") ?? undefined
            : typeof context.parsedNamedArgs.timeframeOrReason === "string"
            ? context.parsedNamedArgs.timeframeOrReason
            : context.parsedNamedArgs.reason;

        log(user.id, duration, messageDeletionTimeframe, reason);

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

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

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

                return;
            }

            duration = result;
        }

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

            if (!input) break ifContextIsNotLegacy;

            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;
            }

            messageDeletionTimeframe = 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: messageDeletionTimeframe,
            reason,
            notifyUser: context.isLegacy ? true : !context.options.getBoolean("silent"),
            sendLog: true,
            duration,
            autoRemoveQueue: true
        });

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

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