commands/automation/ExpireCommand.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 ExpireCommand extends Command {
    public readonly name = "expire";
    public readonly validationRules: ValidationRule[] = [
        {
            types: [ArgumentType.TimeInterval],
            minValue: 1,
            minMaxErrorMessage: "Please specify a valid time interval!",
            requiredErrorMessage: "Please specify after how long the message will expire!",
            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 and deletes it 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 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 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 | undefined = 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;
        }

        try {
            const sentMessage = await message.channel!.send({
                content
            });

            await this.client.queueManager.add(
                new QueueEntry({
                    args: [channel.id, sentMessage.id],
                    client: this.client,
                    createdAt: new Date(),
                    filePath: path.resolve(__dirname, "../../queues/ExpireMessageQueue"),
                    guild: message.guild!,
                    name: "ExpireMessageQueue",
                    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 queued message deletion.");
            }
        } catch (e) {
            logError(e);
            await this.error(message, "Could not send message, make sure I have enough permissions.");
            return;
        }
    }
}
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 ExpireCommand extends Command {
28			public readonly name = "expire";
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 will expire!",
35			typeErrorMessage: "Please specify a valid time interval!",
36			timeMilliseconds: true,
37			name: "time_interval"
38			},
39			{
40			types: [ArgumentType.StringRest],
41			optional: true,
42			requiredErrorMessage: "Please specify a message content!",
43			typeErrorMessage: "Please specify a valid message content!",
44			name: "content"
45			}
46			];
47			public readonly permissions = [PermissionsBitField.Flags.ManageMessages];
48
49			public readonly description = "Sends a message and deletes it after the given timeframe.";
50			public readonly argumentSyntaxes = ["<time_interval> [content]"];
51			public readonly slashCommandBuilder = new SlashCommandBuilder()
52			.addStringOption(option => option.setName("content").setDescription("The message content").setRequired(true))
53			.addStringOption(option =>
54			option
55			.setName("time_interval")
56			.setDescription("Specify the time after the bot should remove the message")
57			.setRequired(true)
58			)
59			.addChannelOption(option =>
60			option
61			.setName("channel")
62			.setDescription("The channel where the message will be sent, defaults to the current channel")
63			);
64
65			async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
66			await this.deferIfInteraction(message);
67
68			let timeInterval = context.isLegacy
69			? context.parsedNamedArgs.time_interval
70			: context.options.getString("time_interval", true);
71
72			if (!context.isLegacy) {
73			const { error, result } = stringToTimeInterval(timeInterval, {
74			milliseconds: true
75			});
76
77			if (error) {
78			await this.error(message, error);
79			return;
80			}
81
82			timeInterval = result;
83			}
84
85			const content: string \| undefined = context.isLegacy
86			? context.parsedNamedArgs.content
87			: context.options.getString("content");
88			const channel = (
89			context.isLegacy ? message.channel! : context.options.getChannel("channel") ?? message.channel!
90			) as TextBasedChannel;
91
92			if (!channel.isTextBased()) {
93			await this.error(message, "Cannot send messages to a non-text based channel!");
94			return;
95			}
96
97			try {
98			const sentMessage = await message.channel!.send({
99			content
100			});
101
102			await this.client.queueManager.add(
103			new QueueEntry({
104			args: [channel.id, sentMessage.id],
105			client: this.client,
106			createdAt: new Date(),
107			filePath: path.resolve(__dirname, "../../queues/ExpireMessageQueue"),
108			guild: message.guild!,
109			name: "ExpireMessageQueue",
110			userId: message.member!.user.id,
111			willRunAt: new Date(Date.now() + timeInterval)
112			})
113			);
114
115			if (message instanceof Message) {
116			await message.react(this.emoji("check")).catch(logError);
117			} else {
118			await this.success(message, "Successfully queued message deletion.");
119			}
120			} catch (e) {
121			logError(e);
122			await this.error(message, "Could not send message, make sure I have enough permissions.");
123			return;
124			}
125			}
126			}