commands/automation/ScheduleCommand.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 { Message, PermissionsBitField, SlashCommandBuilder, TextBasedChannel } from "discord.js";
import path from "path";
import Command, { ArgumentType, BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";
import QueueEntry from "../../utils/QueueEntry";
import { stringToTimeInterval } from "../../utils/datetime";
import { logError } from "../../utils/logger";

export default class ScheduleCommand extends Command {
    public readonly name = "schedule";

    public readonly validationRules: ValidationRule[] = [
        {
            types: [ArgumentType.TimeInterval],
            minValue: 1,
            minMaxErrorMessage: "Please specify a valid time interval!",
            requiredErrorMessage: "Please specify after how long the message should be sent!",
            typeErrorMessage: "Please specify a valid time interval!",
            timeMilliseconds: true,
            name: "time_interval"
        },
        {
            types: [ArgumentType.StringRest],
            optional: true,
            requiredErrorMessage: "Please specify a message content!",
            typeErrorMessage: "Please specify a valid message content!",
            name: "content"
        }
    ];
    public readonly permissions = [PermissionsBitField.Flags.ManageMessages];

    public readonly description = "Sends a message after the given timeframe.";
    public readonly argumentSyntaxes = ["<time_interval> [content]"];
    public readonly slashCommandBuilder = new SlashCommandBuilder()
        .addStringOption(option => option.setName("content").setDescription("The message content").setRequired(true))
        .addStringOption(option =>
            option
                .setName("time_interval")
                .setDescription("Specify the time after the bot should send the message")
                .setRequired(true)
        )
        .addChannelOption(option =>
            option
                .setName("channel")
                .setDescription("The channel where the message will be sent, defaults to the current channel")
        );

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

        let timeInterval = context.isLegacy
            ? context.parsedNamedArgs.time_interval
            : context.options.getString("time_interval", true);

        if (!context.isLegacy) {
            const { error, result } = stringToTimeInterval(timeInterval, {
                milliseconds: true
            });

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

            timeInterval = result;
        }

        const content: string = context.isLegacy ? context.parsedNamedArgs.content : context.options.getString("content");
        const channel = (
            context.isLegacy ? message.channel! : context.options.getChannel("channel") ?? message.channel!
        ) as TextBasedChannel;

        if (!channel.isTextBased()) {
            await this.error(message, "Cannot send messages to a non-text based channel!");
            return;
        }

        await this.client.queueManager.add(
            new QueueEntry({
                args: [channel.id, content],
                client: this.client,
                createdAt: new Date(),
                filePath: path.resolve(__dirname, "../../queues/ScheduleMessageQueue"),
                guild: message.guild!,
                name: "ScheduleMessageQueue",
                userId: message.member!.user.id,
                willRunAt: new Date(Date.now() + timeInterval)
            })
        );

        if (message instanceof Message) {
            await message.react(this.emoji("check")).catch(logError);
        } else {
            await this.success(message, "Successfully scheduled message.");
        }
    }
}
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 { Message, PermissionsBitField, SlashCommandBuilder, TextBasedChannel } from "discord.js";
21	import path from "path";
22	import Command, { ArgumentType, BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";
23	import QueueEntry from "../../utils/QueueEntry";
24	import { stringToTimeInterval } from "../../utils/datetime";
25	import { logError } from "../../utils/logger";
26
27	export default class ScheduleCommand extends Command {
28	public readonly name = "schedule";
29
30	public readonly validationRules: ValidationRule[] = [
31	{
32	types: [ArgumentType.TimeInterval],
33	minValue: 1,
34	minMaxErrorMessage: "Please specify a valid time interval!",
35	requiredErrorMessage: "Please specify after how long the message should be sent!",
36	typeErrorMessage: "Please specify a valid time interval!",
37	timeMilliseconds: true,
38	name: "time_interval"
39	},
40	{
41	types: [ArgumentType.StringRest],
42	optional: true,
43	requiredErrorMessage: "Please specify a message content!",
44	typeErrorMessage: "Please specify a valid message content!",
45	name: "content"
46	}
47	];
48	public readonly permissions = [PermissionsBitField.Flags.ManageMessages];
49
50	public readonly description = "Sends a message after the given timeframe.";
51	public readonly argumentSyntaxes = ["<time_interval> [content]"];
52	public readonly slashCommandBuilder = new SlashCommandBuilder()
53	.addStringOption(option => option.setName("content").setDescription("The message content").setRequired(true))
54	.addStringOption(option =>
55	option
56	.setName("time_interval")
57	.setDescription("Specify the time after the bot should send the message")
58	.setRequired(true)
59	)
60	.addChannelOption(option =>
61	option
62	.setName("channel")
63	.setDescription("The channel where the message will be sent, defaults to the current channel")
64	);
65
66	async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
67	await this.deferIfInteraction(message);
68
69	let timeInterval = context.isLegacy
70	? context.parsedNamedArgs.time_interval
71	: context.options.getString("time_interval", true);
72
73	if (!context.isLegacy) {
74	const { error, result } = stringToTimeInterval(timeInterval, {
75	milliseconds: true
76	});
77
78	if (error) {
79	await this.error(message, error);
80	return;
81	}
82
83	timeInterval = result;
84	}
85
86	const content: string = context.isLegacy ? context.parsedNamedArgs.content : context.options.getString("content");
87	const channel = (
88	context.isLegacy ? message.channel! : context.options.getChannel("channel") ?? message.channel!
89	) as TextBasedChannel;
90
91	if (!channel.isTextBased()) {
92	await this.error(message, "Cannot send messages to a non-text based channel!");
93	return;
94	}
95
96	await this.client.queueManager.add(
97	new QueueEntry({
98	args: [channel.id, content],
99	client: this.client,
100	createdAt: new Date(),
101	filePath: path.resolve(__dirname, "../../queues/ScheduleMessageQueue"),
102	guild: message.guild!,
103	name: "ScheduleMessageQueue",
104	userId: message.member!.user.id,
105	willRunAt: new Date(Date.now() + timeInterval)
106	})
107	);
108
109	if (message instanceof Message) {
110	await message.react(this.emoji("check")).catch(logError);
111	} else {
112	await this.success(message, "Successfully scheduled message.");
113	}
114	}
115	}