commands/moderation/UnmuteCommand.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 UnmuteCommand extends Command {
    public readonly name = "unmute";
    public readonly validationRules: ValidationRule[] = [
        {
            types: [ArgumentType.Member],
            entity: true,
            errors: {
                required: "You must specify a member to unmute!",
                "type:invalid": "You have specified an invalid member mention or ID.",
                "entity:null": "The given member does not exist!"
            },
            name: "member"
        },
        {
            types: [ArgumentType.StringRest],
            optional: true,
            errors: {
                "type:invalid": "You have specified an invalid unmute reason.",
                "string:rest:length:max": "The unmute reason must be less than 4000 characters long."
            },
            string: {
                maxLength: 3999
            },
            name: "reason"
        }
    ];
    public readonly permissions = [PermissionsBitField.Flags.ModerateMembers];

    public readonly description = "Unmutes a server member.";
    public readonly detailedDescription =
        "This command unmutes a server member. The muted role needs to be configured for this command to work!";
    public readonly argumentSyntaxes = ["<UserID|UserMention> [reason]"];

    public readonly botRequiredPermissions = [PermissionsBitField.Flags.ModerateMembers];

    public readonly slashCommandBuilder = new SlashCommandBuilder()
        .addUserOption(option => option.setName("member").setDescription("The member").setRequired(true))
        .addStringOption(option => option.setName("reason").setDescription("The reason for unmuting this user"))
        .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> {
        const member: GuildMember = context.isLegacy ? context.parsedNamedArgs.member : context.options.getMember("member");

        if (!member) {
            return {
                __reply: true,
                ephemeral: true,
                content: `${this.emoji("error")} Invalid member specified.`
            };
        }

        await this.deferIfInteraction(message);
        const reason: string | undefined =
            (!context.isLegacy ? context.options.getString("reason") : context.parsedNamedArgs.reason) ?? undefined;

        if (!(await this.client.permissionManager.shouldModerate(member, message.member! as GuildMember))) {
            await this.error(message, "You don't have permission to unmute this user!");
            return;
        }

        const { id } = <any>await this.client.infractionManager
            .removeMemberMute(member, {
                guild: message.guild!,
                moderator: message.member!.user as User,
                notifyUser: !context.isLegacy ? !context.options.getBoolean("silent") ?? true : true,
                reason,
                sendLog: true
            })
            .catch(logError);

        if (!id) {
            await this.error(message, "Failed to unmute this user or I'm missing permissions to mute this user!");
            return;
        }

        await this.deferredReply(
            message,
            {
                embeds: [
                    await createModerationEmbed({
                        moderator: message.member!.user as User,
                        user: member.user,
                        actionDoneName: "unmuted",
                        description: `**${escapeMarkdown(member.user.tag)}** has been unmuted.`,
                        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 UnmuteCommand extends Command {
26	public readonly name = "unmute";
27	public readonly validationRules: ValidationRule[] = [
28	{
29	types: [ArgumentType.Member],
30	entity: true,
31	errors: {
32	required: "You must specify a member to unmute!",
33	"type:invalid": "You have specified an invalid member mention or ID.",
34	"entity:null": "The given member does not exist!"
35	},
36	name: "member"
37	},
38	{
39	types: [ArgumentType.StringRest],
40	optional: true,
41	errors: {
42	"type:invalid": "You have specified an invalid unmute reason.",
43	"string:rest:length:max": "The unmute reason must be less than 4000 characters long."
44	},
45	string: {
46	maxLength: 3999
47	},
48	name: "reason"
49	}
50	];
51	public readonly permissions = [PermissionsBitField.Flags.ModerateMembers];
52
53	public readonly description = "Unmutes a server member.";
54	public readonly detailedDescription =
55	"This command unmutes a server member. The muted role needs to be configured for this command to work!";
56	public readonly argumentSyntaxes = ["<UserID\|UserMention> [reason]"];
57
58	public readonly botRequiredPermissions = [PermissionsBitField.Flags.ModerateMembers];
59
60	public readonly slashCommandBuilder = new SlashCommandBuilder()
61	.addUserOption(option => option.setName("member").setDescription("The member").setRequired(true))
62	.addStringOption(option => option.setName("reason").setDescription("The reason for unmuting this user"))
63	.addBooleanOption(option =>
64	option
65	.setName("silent")
66	.setDescription("Specify if the system should not notify the user about this action. Defaults to false")
67	);
68
69	async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
70	const member: GuildMember = context.isLegacy ? context.parsedNamedArgs.member : context.options.getMember("member");
71
72	if (!member) {
73	return {
74	__reply: true,
75	ephemeral: true,
76	content: `${this.emoji("error")} Invalid member specified.`
77	};
78	}
79
80	await this.deferIfInteraction(message);
81	const reason: string \| undefined =
82	(!context.isLegacy ? context.options.getString("reason") : context.parsedNamedArgs.reason) ?? undefined;
83
84	if (!(await this.client.permissionManager.shouldModerate(member, message.member! as GuildMember))) {
85	await this.error(message, "You don't have permission to unmute this user!");
86	return;
87	}
88
89	const { id } = <any>await this.client.infractionManager
90	.removeMemberMute(member, {
91	guild: message.guild!,
92	moderator: message.member!.user as User,
93	notifyUser: !context.isLegacy ? !context.options.getBoolean("silent") ?? true : true,
94	reason,
95	sendLog: true
96	})
97	.catch(logError);
98
99	if (!id) {
100	await this.error(message, "Failed to unmute this user or I'm missing permissions to mute this user!");
101	return;
102	}
103
104	await this.deferredReply(
105	message,
106	{
107	embeds: [
108	await createModerationEmbed({
109	moderator: message.member!.user as User,
110	user: member.user,
111	actionDoneName: "unmuted",
112	description: `${escapeMarkdown(member.user.tag)} has been unmuted.`,
113	id: `${id}`,
114	reason,
115	color: "Green"
116	})
117	]
118	},
119	"auto"
120	);
121	}
122	}