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],
            entity: true,
            errors: {
                required: "You must specify a user to unban!",
                "type:invalid": "You have specified an invalid user mention or ID.",
                "entity:null": "The given user does not exist!"
            },
            name: "user"
        },
        {
            types: [ArgumentType.StringRest],
            optional: true,
            errors: {
                "type:invalid": "You have specified an invalid unban reason."
            },
            string: {
                maxLength: 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 (!(await 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, noSuchBan } = await this.client.infractionManager.removeUserBan(user, {
            guild: message.guild!,
            moderator: message.member!.user! as User,
            reason,
            sendLog: true
        });

        if (noSuchBan) {
            await this.error(message, "This user wasn't banned.");
            return;
        }

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

        await this.deferredReply(
            message,
            {
                embeds: [
                    await createModerationEmbed({
                        moderator: message.member!.user as User,
                        user,
                        actionDoneName: "unbanned",
                        description: `**${escapeMarkdown(user.tag)}** has been unbanned.`,
                        id: `${id}`,
                        reason,
                        color: "Green"
                    })
                ]
            },
            "auto"
        );
    }
}
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	entity: true,
31	errors: {
32	required: "You must specify a user to unban!",
33	"type:invalid": "You have specified an invalid user mention or ID.",
34	"entity:null": "The given user does not exist!"
35	},
36	name: "user"
37	},
38	{
39	types: [ArgumentType.StringRest],
40	optional: true,
41	errors: {
42	"type:invalid": "You have specified an invalid unban reason."
43	},
44	string: {
45	maxLength: 3999
46	},
47	name: "reason"
48	}
49	];
50	public readonly permissions = [PermissionsBitField.Flags.BanMembers];
51
52	public readonly description = "Unbans a user.";
53	public readonly detailedDescription = "This command unbans the given user.";
54	public readonly argumentSyntaxes = ["<UserID\|UserMention> [Reason]"];
55
56	public readonly botRequiredPermissions = [PermissionsBitField.Flags.BanMembers];
57
58	public readonly slashCommandBuilder = new SlashCommandBuilder()
59	.addUserOption(option => option.setName("user").setDescription("The user").setRequired(true))
60	.addStringOption(option => option.setName("reason").setDescription("The reason for unbanning this user"));
61
62	async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
63	await this.deferIfInteraction(message);
64
65	const user: User = context.isLegacy ? context.parsedNamedArgs.user : context.options.getUser("user", true);
66	const reason: string \| undefined =
67	(!context.isLegacy ? context.options.getString("reason") : context.parsedNamedArgs.reason) ?? undefined;
68
69	try {
70	const member = message.guild!.members.cache.get(user.id) ?? (await message.guild!.members.fetch(user.id));
71
72	if (!(await this.client.permissionManager.shouldModerate(member, message.member! as GuildMember))) {
73	await this.error(message, "You don't have permission to unban this user!");
74	return;
75	}
76	} catch (e) {
77	logError(e);
78	}
79
80	const { id, noSuchBan } = await this.client.infractionManager.removeUserBan(user, {
81	guild: message.guild!,
82	moderator: message.member!.user! as User,
83	reason,
84	sendLog: true
85	});
86
87	if (noSuchBan) {
88	await this.error(message, "This user wasn't banned.");
89	return;
90	}
91
92	if (!id) {
93	await this.error(message);
94	return;
95	}
96
97	await this.deferredReply(
98	message,
99	{
100	embeds: [
101	await createModerationEmbed({
102	moderator: message.member!.user as User,
103	user,
104	actionDoneName: "unbanned",
105	description: `${escapeMarkdown(user.tag)} has been unbanned.`,
106	id: `${id}`,
107	reason,
108	color: "Green"
109	})
110	]
111	},
112	"auto"
113	);
114	}
115	}