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 { log, logError } from "../../utils/Logger";
import { stringToTimeInterval } from "../../utils/datetime";
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 infraction = 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,
            abortOnTemplateNotFound: true
        });

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