commands/automation/AFKRemoveCommand.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 { EmbedBuilder, PermissionsBitField, User } from "discord.js";
import Command, { ArgumentType, BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";
import { isSystemAdmin } from "../../utils/utils";
import { AFKsCommandScope } from "./AFKsCommand";

export default class AFKRemoveCommand extends Command {
    public readonly name = "afks__remove";
    public readonly validationRules: ValidationRule[] = [
        {
            types: [ArgumentType.User],
            name: "user",
            entity: {
                notNull: false
            },
            errors: {
                required: "Please provide a user to remove their AFK!",
                "type:invalid": "Please provide a valid user!",
                "entity:null": "Please provide a valid user!",
            }
        }
    ];
    public readonly permissions = [PermissionsBitField.Flags.ModerateMembers];
    public readonly description = "Removes AFK status for a user.";
    public readonly availableOptions = {
        "-s, --scope=[everywhere|guild|global]": "Change the scope of this removal [System Admin Only]"
    };

    async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
        await this.deferIfInteraction(message);

        const optionIndex = context.isLegacy ? context.args.findIndex(value => value === "-s" || value === "--scope") : -1;

        if (context.isLegacy && optionIndex !== -1 && !context.args[optionIndex + 1]) {
            await this.error(
                message,
                `Option \`${context.args[optionIndex]}\` requires an argument with one of the following values: \`everywhere\`, \`global\`, \`guild\`.`
            );
            return;
        }

        const scope =
            <AFKsCommandScope | null>(
                (context.isLegacy
                    ? optionIndex === -1
                        ? null
                        : context.args[optionIndex + 1]
                    : context.options.getString("scope"))
            ) ?? "guild";

        if (scope !== "guild" && !isSystemAdmin(this.client, message.member?.user.id as string)) {
            await this.error(message, `Only system admins can remove ${scope}-scoped AFK entries.`);
            return;
        }

        const user: User = context.isLegacy ? context.parsedNamedArgs.user : context.options.getString("user", true);
        const result: [guild: boolean, global: boolean] = [false, false];
        let mentions = 0;

        if (scope === "everywhere" || scope === "guild") {
            const entry = await this.client.afkService.removeAFK(message.guildId!, user.id, true, true);
            result[0] = !!entry;
            mentions += entry?.mentions.length ?? 0;
        }

        if (scope === "everywhere" || scope === "global") {
            const entry = await this.client.afkService.removeAFK("global", user.id, true, true);
            result[1] = !!entry;
            mentions += entry?.mentions.length ?? 0;
        }

        if (!result[0] && !result[1]) {
            await this.error(message, "That user is not AFK in the given scope.");
            return;
        }

        await this.deferredReply(message, {
            embeds: [
                new EmbedBuilder({
                    author: {
                        name: user.username,
                        icon_url: user.displayAvatarURL()
                    },
                    color: 0x007bff,
                    description: `Successfully removed AFK status for this user. They had **${mentions}** mentions total in the given scope.`,
                    fields: [
                        {
                            name: "Scope",
                            value: `${scope[0].toUpperCase()}${scope.substring(1)}`
                        }
                    ],
                    footer: {
                        text: "Removed"
                    }
                }).setTimestamp()
            ]
        });
    }
}
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 { EmbedBuilder, PermissionsBitField, User } from "discord.js";
21	import Command, { ArgumentType, BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";
22	import { isSystemAdmin } from "../../utils/utils";
23	import { AFKsCommandScope } from "./AFKsCommand";
24
25	export default class AFKRemoveCommand extends Command {
26	public readonly name = "afks__remove";
27	public readonly validationRules: ValidationRule[] = [
28	{
29	types: [ArgumentType.User],
30	name: "user",
31	entity: {
32	notNull: false
33	},
34	errors: {
35	required: "Please provide a user to remove their AFK!",
36	"type:invalid": "Please provide a valid user!",
37	"entity:null": "Please provide a valid user!",
38	}
39	}
40	];
41	public readonly permissions = [PermissionsBitField.Flags.ModerateMembers];
42	public readonly description = "Removes AFK status for a user.";
43	public readonly availableOptions = {
44	"-s, --scope=[everywhere\|guild\|global]": "Change the scope of this removal [System Admin Only]"
45	};
46
47	async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
48	await this.deferIfInteraction(message);
49
50	const optionIndex = context.isLegacy ? context.args.findIndex(value => value === "-s" \|\| value === "--scope") : -1;
51
52	if (context.isLegacy && optionIndex !== -1 && !context.args[optionIndex + 1]) {
53	await this.error(
54	message,
55	`Option \`${context.args[optionIndex]}\` requires an argument with one of the following values: \`everywhere\`, \`global\`, \`guild\`.`
56	);
57	return;
58	}
59
60	const scope =
61	<AFKsCommandScope \| null>(
62	(context.isLegacy
63	? optionIndex === -1
64	? null
65	: context.args[optionIndex + 1]
66	: context.options.getString("scope"))
67	) ?? "guild";
68
69	if (scope !== "guild" && !isSystemAdmin(this.client, message.member?.user.id as string)) {
70	await this.error(message, `Only system admins can remove ${scope}-scoped AFK entries.`);
71	return;
72	}
73
74	const user: User = context.isLegacy ? context.parsedNamedArgs.user : context.options.getString("user", true);
75	const result: [guild: boolean, global: boolean] = [false, false];
76	let mentions = 0;
77
78	if (scope === "everywhere" \|\| scope === "guild") {
79	const entry = await this.client.afkService.removeAFK(message.guildId!, user.id, true, true);
80	result[0] = !!entry;
81	mentions += entry?.mentions.length ?? 0;
82	}
83
84	if (scope === "everywhere" \|\| scope === "global") {
85	const entry = await this.client.afkService.removeAFK("global", user.id, true, true);
86	result[1] = !!entry;
87	mentions += entry?.mentions.length ?? 0;
88	}
89
90	if (!result[0] && !result[1]) {
91	await this.error(message, "That user is not AFK in the given scope.");
92	return;
93	}
94
95	await this.deferredReply(message, {
96	embeds: [
97	new EmbedBuilder({
98	author: {
99	name: user.username,
100	icon_url: user.displayAvatarURL()
101	},
102	color: 0x007bff,
103	description: `Successfully removed AFK status for this user. They had ${mentions} mentions total in the given scope.`,
104	fields: [
105	{
106	name: "Scope",
107	value: `${scope[0].toUpperCase()}${scope.substring(1)}`
108	}
109	],
110	footer: {
111	text: "Removed"
112	}
113	}).setTimestamp()
114	]
115	});
116	}
117	}