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