commands/tools/SetSlowmodeCommand.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 { formatDistanceToNowStrict } from "date-fns";
import { GuildChannel, PermissionsBitField, SlashCommandBuilder } from "discord.js";
import Command, { ArgumentType, BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";
import { stringToTimeInterval } from "../../utils/datetime";
import { logError } from "../../utils/Logger";

export default class SetSlowmodeCommand extends Command {
    public readonly name = "setslowmode";
    public readonly validationRules: ValidationRule[] = [
        {
            types: [ArgumentType.TimeInterval],
            time: {
                unit: "s",
                min: 0,
                max: 6 * 60 * 60 // 6 hours
            },
            errors: {
                required: "Please provide a slowmode duration to set!",
                "time:range": "The slowmode duration must be in range 0 seconds to 6 hours!",
                "type:invalid": "Please provide a valid slowmode duration to set!"
            },
            name: "duration"
        },
        {
            types: [ArgumentType.Channel],
            optional: true,
            entity: true,
            errors: {
                "entity:null": "That channel does not exist!",
                "type:invalid": "Please provide a valid channel!"
            },
            name: "channel"
        }
    ];
    public readonly permissions = [PermissionsBitField.Flags.ManageChannels];
    public readonly aliases = ["slow", "sm", "slowmode"];
    public readonly description = "Sets slowmode for a channel.";
    public readonly argumentSyntaxes = ["<duration> [channel]"];
    public readonly since = "6.44.0";
    public readonly slashCommandBuilder = new SlashCommandBuilder()
        .addStringOption(option =>
            option
                .setName("duration")
                .setDescription("The new slowmode duration to set (put 0 here to remove slowmode)")
                .setRequired(true)
        )
        .addChannelOption(option =>
            option.setName("channel").setDescription("The target text-based channel (defaults to current channel)")
        );

    async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
        await this.deferIfInteraction(message);

        const duration: number = context.isLegacy
            ? context.parsedNamedArgs.duration
            : stringToTimeInterval(context.options.getString("duration", true), {
                  milliseconds: false
              }).result;
        const channel: GuildChannel =
            (context.isLegacy ? context.parsedNamedArgs.channel : context.options.getChannel("channel")) ?? message.channel;

        if (!channel.isTextBased()) {
            await this.error(message, "Cannot set slowmode for a non-text based channel!");
            return;
        }

        if (!channel.manageable) {
            await this.error(message, "I'm not allowed to manage this channel.");
            return;
        }

        try {
            await channel.setRateLimitPerUser(duration, "Changing the slowmode as the user has commanded me to do so");
            await this.success(
                message,
                `Successfully changed slowmode to ${formatDistanceToNowStrict(
                    new Date(Date.now() - duration * 1000)
                )} for channel ${channel.toString()}`
            );
        } catch (error) {
            logError(error);
            await this.error(message, "Failed to change slowmode.");
        }
    }
}
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 { formatDistanceToNowStrict } from "date-fns";
21	import { GuildChannel, PermissionsBitField, SlashCommandBuilder } from "discord.js";
22	import Command, { ArgumentType, BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";
23	import { stringToTimeInterval } from "../../utils/datetime";
24	import { logError } from "../../utils/Logger";
25
26	export default class SetSlowmodeCommand extends Command {
27	public readonly name = "setslowmode";
28	public readonly validationRules: ValidationRule[] = [
29	{
30	types: [ArgumentType.TimeInterval],
31	time: {
32	unit: "s",
33	min: 0,
34	max: 6 * 60 * 60 // 6 hours
35	},
36	errors: {
37	required: "Please provide a slowmode duration to set!",
38	"time:range": "The slowmode duration must be in range 0 seconds to 6 hours!",
39	"type:invalid": "Please provide a valid slowmode duration to set!"
40	},
41	name: "duration"
42	},
43	{
44	types: [ArgumentType.Channel],
45	optional: true,
46	entity: true,
47	errors: {
48	"entity:null": "That channel does not exist!",
49	"type:invalid": "Please provide a valid channel!"
50	},
51	name: "channel"
52	}
53	];
54	public readonly permissions = [PermissionsBitField.Flags.ManageChannels];
55	public readonly aliases = ["slow", "sm", "slowmode"];
56	public readonly description = "Sets slowmode for a channel.";
57	public readonly argumentSyntaxes = ["<duration> [channel]"];
58	public readonly since = "6.44.0";
59	public readonly slashCommandBuilder = new SlashCommandBuilder()
60	.addStringOption(option =>
61	option
62	.setName("duration")
63	.setDescription("The new slowmode duration to set (put 0 here to remove slowmode)")
64	.setRequired(true)
65	)
66	.addChannelOption(option =>
67	option.setName("channel").setDescription("The target text-based channel (defaults to current channel)")
68	);
69
70	async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
71	await this.deferIfInteraction(message);
72
73	const duration: number = context.isLegacy
74	? context.parsedNamedArgs.duration
75	: stringToTimeInterval(context.options.getString("duration", true), {
76	milliseconds: false
77	}).result;
78	const channel: GuildChannel =
79	(context.isLegacy ? context.parsedNamedArgs.channel : context.options.getChannel("channel")) ?? message.channel;
80
81	if (!channel.isTextBased()) {
82	await this.error(message, "Cannot set slowmode for a non-text based channel!");
83	return;
84	}
85
86	if (!channel.manageable) {
87	await this.error(message, "I'm not allowed to manage this channel.");
88	return;
89	}
90
91	try {
92	await channel.setRateLimitPerUser(duration, "Changing the slowmode as the user has commanded me to do so");
93	await this.success(
94	message,
95	`Successfully changed slowmode to ${formatDistanceToNowStrict(
96	new Date(Date.now() - duration * 1000)
97	)} for channel ${channel.toString()}`
98	);
99	} catch (error) {
100	logError(error);
101	await this.error(message, "Failed to change slowmode.");
102	}
103	}
104	}