commands/automation/QueueListCommand.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 { formatDistanceStrict } from "date-fns";
import { EmbedBuilder, PermissionsBitField } from "discord.js";
import Command, { BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";
import Pagination from "../../utils/Pagination";

export default class QueueListCommand extends Command {
    public readonly name = "queue__list";
    public readonly validationRules: ValidationRule[] = [];
    public readonly aliases = ["queues", "queuelist", "listqueue", "listqueues"];
    public readonly permissions = [PermissionsBitField.Flags.ManageMessages];
    public readonly description = "Lists all the queued jobs";
    public readonly since = "5.57.0";

    async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
        const queues = this.client.queueManager.queues.filter(queue => queue.options.guild.id === message.guildId!);

        const pagination = new Pagination(queues.toJSON(), {
            channelId: message.channelId!,
            guildId: message.guildId!,
            limit: 10,
            userId: message.member!.user.id,
            client: this.client,
            timeout: 180_000,
            embedBuilder({ data, currentPage, maxPages }) {
                let description = "";

                for (const queue of data) {
                    description += `**ID**: \`${queue.id}\`\n`;
                    description += `Type: \`${queue.options.name}\`\n`;
                    description += `Runs in: ${formatDistanceStrict(new Date(), queue.options.willRunAt)}\n\n`;
                }

                description = description === "" ? "No queued jobs." : description;

                return new EmbedBuilder({
                    title: "Queue job list",
                    color: 0x007bff,
                    description,
                    footer: {
                        text: `Page ${currentPage} of ${maxPages}`
                    }
                });
            }
        });

        const reply = await message.reply({
            ...(await pagination.getMessageOptions(1)),
            fetchReply: true
        });

        await pagination.start(reply);
    }
}
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 { formatDistanceStrict } from "date-fns";
21			import { EmbedBuilder, PermissionsBitField } from "discord.js";
22			import Command, { BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";
23			import Pagination from "../../utils/Pagination";
24
25			export default class QueueListCommand extends Command {
26			public readonly name = "queue__list";
27			public readonly validationRules: ValidationRule[] = [];
28			public readonly aliases = ["queues", "queuelist", "listqueue", "listqueues"];
29			public readonly permissions = [PermissionsBitField.Flags.ManageMessages];
30			public readonly description = "Lists all the queued jobs";
31			public readonly since = "5.57.0";
32
33			async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
34			const queues = this.client.queueManager.queues.filter(queue => queue.options.guild.id === message.guildId!);
35
36			const pagination = new Pagination(queues.toJSON(), {
37			channelId: message.channelId!,
38			guildId: message.guildId!,
39			limit: 10,
40			userId: message.member!.user.id,
41			client: this.client,
42			timeout: 180_000,
43			embedBuilder({ data, currentPage, maxPages }) {
44			let description = "";
45
46			for (const queue of data) {
47			description += `ID: \`${queue.id}\`\n`;
48			description += `Type: \`${queue.options.name}\`\n`;
49			description += `Runs in: ${formatDistanceStrict(new Date(), queue.options.willRunAt)}\n\n`;
50			}
51
52			description = description === "" ? "No queued jobs." : description;
53
54			return new EmbedBuilder({
55			title: "Queue job list",
56			color: 0x007bff,
57			description,
58			footer: {
59			text: `Page ${currentPage} of ${maxPages}`
60			}
61			});
62			}
63			});
64
65			const reply = await message.reply({
66			...(await pagination.getMessageOptions(1)),
67			fetchReply: true
68			});
69
70			await pagination.start(reply);
71			}
72			}