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

export default class UnbanCommand extends Command {
    public readonly name = "unban";
    public readonly validationRules: ValidationRule[] = [
        {
            types: [ArgumentType.User],
            entityNotNull: true,
            requiredErrorMessage: "You must specify a user to unban!",
            typeErrorMessage: "You have specified an invalid user mention or ID.",
            entityNotNullErrorMessage: "The given user does not exist!",
            name: "user"
        },
        {
            types: [ArgumentType.StringRest],
            optional: true,
            typeErrorMessage: "You have specified an invalid unban reason.",
            lengthMax: 3999,
            name: "reason"
        }
    ];
    public readonly permissions = [PermissionsBitField.Flags.BanMembers];

    public readonly description = "Unbans a user.";
    public readonly detailedDescription = "This command unbans the given user.";
    public readonly argumentSyntaxes = ["<UserID|UserMention> [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 unbanning this user"));

    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);
        const reason: string | undefined = (!context.isLegacy ? context.options.getString("reason") : context.parsedNamedArgs.reason) ?? undefined;

        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 unban this user!");
                return;
            }
        } catch (e) {
            logError(e);
        }

        const id = await this.client.infractionManager
            .removeUserBan(user, {
                guild: message.guild!,
                moderator: message.member!.user! as User,
                reason,
                sendLog: true
            })
            .catch(logError);

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

        await this.deferredReply(message, {
            embeds: [
                await createModerationEmbed({
                    user,
                    actionDoneName: "unbanned",
                    description: `**${escapeMarkdown(user.tag)}** has been unbanned.`,
                    id: `${id}`,
                    reason,
                    color: "Green"
                })
            ]
        });
    }
}
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 { GuildMember, PermissionsBitField, SlashCommandBuilder, User, escapeMarkdown } from "discord.js";
21	import Command, { ArgumentType, BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";
22	import { logError } from "../../utils/logger";
23	import { createModerationEmbed } from "../../utils/utils";
24
25	export default class UnbanCommand extends Command {
26	public readonly name = "unban";
27	public readonly validationRules: ValidationRule[] = [
28	{
29	types: [ArgumentType.User],
30	entityNotNull: true,
31	requiredErrorMessage: "You must specify a user to unban!",
32	typeErrorMessage: "You have specified an invalid user mention or ID.",
33	entityNotNullErrorMessage: "The given user does not exist!",
34	name: "user"
35	},
36	{
37	types: [ArgumentType.StringRest],
38	optional: true,
39	typeErrorMessage: "You have specified an invalid unban reason.",
40	lengthMax: 3999,
41	name: "reason"
42	}
43	];
44	public readonly permissions = [PermissionsBitField.Flags.BanMembers];
45
46	public readonly description = "Unbans a user.";
47	public readonly detailedDescription = "This command unbans the given user.";
48	public readonly argumentSyntaxes = ["<UserID\|UserMention> [Reason]"];
49
50	public readonly botRequiredPermissions = [PermissionsBitField.Flags.BanMembers];
51
52	public readonly slashCommandBuilder = new SlashCommandBuilder()
53	.addUserOption(option => option.setName("user").setDescription("The user").setRequired(true))
54	.addStringOption(option => option.setName("reason").setDescription("The reason for unbanning this user"));
55
56	async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
57	await this.deferIfInteraction(message);
58
59	const user: User = context.isLegacy ? context.parsedNamedArgs.user : context.options.getUser("user", true);
60	const reason: string \| undefined = (!context.isLegacy ? context.options.getString("reason") : context.parsedNamedArgs.reason) ?? undefined;
61
62	try {
63	const member = message.guild!.members.cache.get(user.id) ?? (await message.guild!.members.fetch(user.id));
64
65	if (!this.client.permissionManager.shouldModerate(member, message.member! as GuildMember)) {
66	await this.error(message, "You don't have permission to unban this user!");
67	return;
68	}
69	} catch (e) {
70	logError(e);
71	}
72
73	const id = await this.client.infractionManager
74	.removeUserBan(user, {
75	guild: message.guild!,
76	moderator: message.member!.user! as User,
77	reason,
78	sendLog: true
79	})
80	.catch(logError);
81
82	if (!id) {
83	await this.error(message);
84	return;
85	}
86
87	await this.deferredReply(message, {
88	embeds: [
89	await createModerationEmbed({
90	user,
91	actionDoneName: "unbanned",
92	description: `${escapeMarkdown(user.tag)} has been unbanned.`,
93	id: `${id}`,
94	reason,
95	color: "Green"
96	})
97	]
98	});
99	}
100	}