commands/moderation/FakeBanCommand.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, Message, 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 { protectSystemAdminsFromCommands } from "../../utils/troll";
import { createModerationEmbed } from "../../utils/utils";

export default class FakeBanCommand extends Command {
    public readonly name = "fakeban";
    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.",
                "string:rest:length:max": "The ban reason must be less than 4000 characters long."
            },
            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:rest:length:max": "The ban reason must be less than 4000 characters long."
            },
            string: {
                maxLength: 3999
            }
        }
    ];
    public readonly permissions = [PermissionsBitField.Flags.BanMembers];

    public readonly aliases = ["fban"];

    public readonly description = "Fakebans a user.";
    public readonly detailedDescription = "This commands simulates a user ban.";
    public readonly argumentSyntaxes = ["<UserID|UserMention> [Reason]", "<UserID|UserMention> [MessageDeletionTime] [Reason]"];

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

        if (await protectSystemAdminsFromCommands(this.client, message, user.id, "fakeban_safe")) {
            return;
        }

        const {
            commands: { moderation_command_behaviour }
        } = context.config;
        const deleteResponse = moderation_command_behaviour === "delete";

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

        if (deleteResponse && message instanceof Message) {
            await message.delete().catch(logError);
        }

        const infraction = await this.client.infractionManager.createUserFakeBan(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, undefined, "channel");
            return;
        }

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