commands/moderation/UnlockCommand.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 { PermissionsBitField, SlashCommandBuilder, TextChannel, User } from "discord.js";
import Command, { ArgumentType, BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";
import { logError } from "../../utils/Logger";
import { isTextableChannel } from "../../utils/utils";

export default class UnlockCommand extends Command {
    public readonly name = "unlock";
    public readonly validationRules: ValidationRule[] = [
        {
            types: [ArgumentType.Channel, ArgumentType.String],
            optional: true,
            name: "channel",
            errors: {
                "type:invalid": "Please provide a valid channel to unlock!"
            }
        }
    ];
    public readonly permissions = [PermissionsBitField.Flags.ManageChannels];

    public readonly description = "Unlocks a channel.";
    public readonly detailedDescription =
        "This command unlocks down a channel. If no channel is given, the current channel will be unlocked.";
    public readonly argumentSyntaxes = ["[ChannelID|ChannelMention]"];

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

    public readonly slashCommandBuilder = new SlashCommandBuilder()
        .addSubcommand(subcommand => subcommand.setName("server").setDescription("Unlock the entire server"))
        .addSubcommand(subcommand =>
            subcommand
                .setName("channel")
                .setDescription("Unlock one single channel")
                .addChannelOption(option =>
                    option.setName("channel").setDescription("The channel that will be unlocked. Default is the current channel")
                )
        );

    async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
        if (
            (!context.isLegacy && context.options.getSubcommand(true) === "server") ||
            (context.isLegacy && context.parsedNamedArgs.channel === "server")
        ) {
            return await this.client.commands.get("unlock__unlockall")?.execute(message, context);
        }

        if (context.isLegacy && typeof context.parsedNamedArgs.channel === "string") {
            await this.error(
                message,
                "Please provide a text channel to unlock, or specify `server` to unlock the entire server!"
            );
            return;
        }

        const channel: TextChannel =
            (context.isLegacy ? context.parsedNamedArgs.channel : context.options.getChannel("channel")) ?? message.channel!;

        if (!isTextableChannel(channel)) {
            await this.error(message, "Please provide a valid text channel to unlock!");
            return;
        }

        const result = await this.client.channelLockManager.unlock(channel, message.member!.user as User);

        if (result === false) await this.error(message, "Failed to unlock this channel.");
        else await this.deferredReply(message, `${this.emoji("check")} This channel has been unlocked.`).catch(logError);
    }
}
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 { PermissionsBitField, SlashCommandBuilder, TextChannel, User } from "discord.js";
21			import Command, { ArgumentType, BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";
22			import { logError } from "../../utils/Logger";
23			import { isTextableChannel } from "../../utils/utils";
24
25			export default class UnlockCommand extends Command {
26			public readonly name = "unlock";
27			public readonly validationRules: ValidationRule[] = [
28			{
29			types: [ArgumentType.Channel, ArgumentType.String],
30			optional: true,
31			name: "channel",
32			errors: {
33			"type:invalid": "Please provide a valid channel to unlock!"
34			}
35			}
36			];
37			public readonly permissions = [PermissionsBitField.Flags.ManageChannels];
38
39			public readonly description = "Unlocks a channel.";
40			public readonly detailedDescription =
41			"This command unlocks down a channel. If no channel is given, the current channel will be unlocked.";
42			public readonly argumentSyntaxes = ["[ChannelID\|ChannelMention]"];
43
44			public readonly botRequiredPermissions = [PermissionsBitField.Flags.ManageChannels];
45
46			public readonly slashCommandBuilder = new SlashCommandBuilder()
47			.addSubcommand(subcommand => subcommand.setName("server").setDescription("Unlock the entire server"))
48			.addSubcommand(subcommand =>
49			subcommand
50			.setName("channel")
51			.setDescription("Unlock one single channel")
52			.addChannelOption(option =>
53			option.setName("channel").setDescription("The channel that will be unlocked. Default is the current channel")
54			)
55			);
56
57			async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
58			if (
59			(!context.isLegacy && context.options.getSubcommand(true) === "server") \|\|
60			(context.isLegacy && context.parsedNamedArgs.channel === "server")
61			) {
62			return await this.client.commands.get("unlock__unlockall")?.execute(message, context);
63			}
64
65			if (context.isLegacy && typeof context.parsedNamedArgs.channel === "string") {
66			await this.error(
67			message,
68			"Please provide a text channel to unlock, or specify `server` to unlock the entire server!"
69			);
70			return;
71			}
72
73			const channel: TextChannel =
74			(context.isLegacy ? context.parsedNamedArgs.channel : context.options.getChannel("channel")) ?? message.channel!;
75
76			if (!isTextableChannel(channel)) {
77			await this.error(message, "Please provide a valid text channel to unlock!");
78			return;
79			}
80
81			const result = await this.client.channelLockManager.unlock(channel, message.member!.user as User);
82
83			if (result === false) await this.error(message, "Failed to unlock this channel.");
84			else await this.deferredReply(message, `${this.emoji("check")} This channel has been unlocked.`).catch(logError);
85			}
86			}