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";

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