commands/automation/ScheduleAndExpireCommand.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 ScheduleAndExpireCommand extends Command {
    public readonly name = "scheduleandexpire";
    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_send"
        },
        {
            types: [ArgumentType.TimeInterval],
            number: {
                min: 1
            },
            errors: {
                "number:range:min": "Please specify a valid deletion time interval!",
                required: "Please specify after how long the message should be deleted!",
                "type:invalid": "Please specify a valid deletion time interval!"
            },
            time: {
                unit: "ms"
            },
            name: "time_interval_remove"
        },
        {
            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 aliases = ["expiresc", "scex", "schedulexp"];

    public readonly description = "Sends a message and deletes it after the given primary and secondary timeframe, respectively.";
    public readonly argumentSyntaxes = ["<send_after> <expire_after> [content]"];
    public readonly slashCommandBuilder = new SlashCommandBuilder()
        .addStringOption(option => option.setName("content").setDescription("The message content").setRequired(true))
        .addStringOption(option =>
            option
                .setName("send_after")
                .setDescription("Specify the time after the bot should send the message")
                .setRequired(true)
        )
        .addStringOption(option =>
            option
                .setName("expire_after")
                .setDescription("Specify the time after the bot should remove 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 timeIntervalSend = context.isLegacy
            ? context.parsedNamedArgs.time_interval_send
            : context.options.getString("send_after", true);

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

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

            timeIntervalSend = result;
        }

        let timeIntervalRemove = context.isLegacy
            ? context.parsedNamedArgs.time_interval_remove
            : context.options.getString("expire_after", true);

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

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

            timeIntervalRemove = 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, timeIntervalRemove.toString(), content],
                client: this.client,
                createdAt: new Date(),
                filePath: path.resolve(__dirname, "../../queues/ScheduleAndExpireMessageQueue"),
                guild: message.guild!,
                name: "ScheduleAndExpireMessageQueue",
                userId: message.member!.user.id,
                willRunAt: new Date(Date.now() + timeIntervalSend)
            })
        );

        if (message instanceof Message) {
            await message.react(getEmojiObject(this.client, "check") ?? "✅").catch(logError);
        } else {
            await this.success(message, "Successfully scheduled message.");
        }
    }
}
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 { 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 ScheduleAndExpireCommand extends Command {
29			public readonly name = "scheduleandexpire";
30			public readonly validationRules: ValidationRule[] = [
31			{
32			types: [ArgumentType.TimeInterval],
33			number: {
34			min: 1
35			},
36			errors: {
37			"number:range:min": "Please specify a valid time interval!",
38			required: "Please specify after how long the message should be sent!",
39			"type:invalid": "Please specify a valid time interval!"
40			},
41			time: {
42			unit: "ms"
43			},
44			name: "time_interval_send"
45			},
46			{
47			types: [ArgumentType.TimeInterval],
48			number: {
49			min: 1
50			},
51			errors: {
52			"number:range:min": "Please specify a valid deletion time interval!",
53			required: "Please specify after how long the message should be deleted!",
54			"type:invalid": "Please specify a valid deletion time interval!"
55			},
56			time: {
57			unit: "ms"
58			},
59			name: "time_interval_remove"
60			},
61			{
62			types: [ArgumentType.StringRest],
63			optional: true,
64			errors: {
65			required: "Please specify a message content!",
66			"type:invalid": "Please specify a valid message content!"
67			},
68			name: "content"
69			}
70			];
71			public readonly permissions = [PermissionsBitField.Flags.ManageMessages];
72			public readonly aliases = ["expiresc", "scex", "schedulexp"];
73
74			public readonly description = "Sends a message and deletes it after the given primary and secondary timeframe, respectively.";
75			public readonly argumentSyntaxes = ["<send_after> <expire_after> [content]"];
76			public readonly slashCommandBuilder = new SlashCommandBuilder()
77			.addStringOption(option => option.setName("content").setDescription("The message content").setRequired(true))
78			.addStringOption(option =>
79			option
80			.setName("send_after")
81			.setDescription("Specify the time after the bot should send the message")
82			.setRequired(true)
83			)
84			.addStringOption(option =>
85			option
86			.setName("expire_after")
87			.setDescription("Specify the time after the bot should remove the message")
88			.setRequired(true)
89			)
90			.addChannelOption(option =>
91			option
92			.setName("channel")
93			.setDescription("The channel where the message will be sent, defaults to the current channel")
94			);
95
96			async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
97			await this.deferIfInteraction(message);
98
99			let timeIntervalSend = context.isLegacy
100			? context.parsedNamedArgs.time_interval_send
101			: context.options.getString("send_after", true);
102
103			if (!context.isLegacy) {
104			const { error, result } = stringToTimeInterval(timeIntervalSend, {
105			milliseconds: true
106			});
107
108			if (error) {
109			await this.error(message, error);
110			return;
111			}
112
113			timeIntervalSend = result;
114			}
115
116			let timeIntervalRemove = context.isLegacy
117			? context.parsedNamedArgs.time_interval_remove
118			: context.options.getString("expire_after", true);
119
120			if (!context.isLegacy) {
121			const { error, result } = stringToTimeInterval(timeIntervalRemove, {
122			milliseconds: true
123			});
124
125			if (error) {
126			await this.error(message, error);
127			return;
128			}
129
130			timeIntervalRemove = result;
131			}
132
133			const content: string = context.isLegacy ? context.parsedNamedArgs.content : context.options.getString("content");
134			const channel = (
135			context.isLegacy ? message.channel! : context.options.getChannel("channel") ?? message.channel!
136			) as TextBasedChannel;
137
138			if (!isTextableChannel(channel)) {
139			await this.error(message, "Cannot send messages to a non-text based channel!");
140			return;
141			}
142
143			await this.client.queueManager.add(
144			new QueueEntry({
145			args: [channel.id, timeIntervalRemove.toString(), content],
146			client: this.client,
147			createdAt: new Date(),
148			filePath: path.resolve(__dirname, "../../queues/ScheduleAndExpireMessageQueue"),
149			guild: message.guild!,
150			name: "ScheduleAndExpireMessageQueue",
151			userId: message.member!.user.id,
152			willRunAt: new Date(Date.now() + timeIntervalSend)
153			})
154			);
155
156			if (message instanceof Message) {
157			await message.react(getEmojiObject(this.client, "check") ?? "✅").catch(logError);
158			} else {
159			await this.success(message, "Successfully scheduled message.");
160			}
161			}
162			}