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";
import { getEmojiObject, isTextableChannel } from "../../utils/utils";

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

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