Overhaul voice moderation: Add voice mutes, add voice notes, remove voice quarantine, allow voice mods to pull up mod logs, and record voice take in the moderation system

Author: jeremy-rifkin

src/modules/wheatley/components/moderation/moderation-common.ts

@@ -27,6 +27,7 @@ import {
     moderation_entry,
     basic_moderation_with_user,
     basic_moderation,
+    note_moderation_types,
 } from "./schemata.js";
 import { set_interval } from "../../../../utils/node.js";
 
@@ -76,6 +77,10 @@ export class ParseError extends Error {
     }
 }
 
+export type revoke_handler_options = {
+    allow_no_entry?: boolean;
+};
+
 // Returns the corresponding duration in milliseconds,
 // or null for permanent duration.
 // Throws ParseError when parsing fails.
@@ -145,7 +150,7 @@ export abstract class ModerationComponent extends BotComponent {
     sleep_list: SleepList<mongo.WithId<moderation_entry>, mongo.BSON.ObjectId>;
     timer: NodeJS.Timer | null = null;
 
-    static non_duration_moderation_set = new Set(["warn", "kick", "softban", "note"]);
+    static non_duration_moderation_set = new Set(["warn", "kick", "softban", "note", "voice_note"]);
 
     static moderations_count = new PromClient.Gauge({
         name: "tccpp_moderations_count",
@@ -306,6 +311,12 @@ export abstract class ModerationComponent extends BotComponent {
     // Check if the moderation is currently applied in Discord (role present, ban in place, etc.)
     abstract is_moderation_applied_in_discord(moderation: basic_moderation_with_user): Promise<boolean>;
 
+    // Apply revoke action to Discord without an existing moderation entry.
+    // Must be overridden in subclasses that use allow_no_entry mode.
+    async apply_revoke_to_discord(_member: Discord.GuildMember): Promise<void> {
+        throw new Error("apply_revoke_to_discord must be overridden when using allow_no_entry");
+    }
+
     // Check if there are other active moderations of the same type for this user (excluding the given entry)
     async has_other_active_moderations(entry: mongo.WithId<moderation_entry>): Promise<boolean> {
         const query: mongo.Filter<moderation_entry> = {
@@ -576,7 +587,7 @@ export abstract class ModerationComponent extends BotComponent {
                 ];
             }
             this.staff_action_log.send(message_options).catch(this.wheatley.critical_error.bind(this.wheatley));
-            if (moderation.type !== "note") {
+            if (!note_moderation_types.includes(moderation.type)) {
                 this.public_action_log
                     .send({
                         embeds: [
@@ -727,8 +738,24 @@ export abstract class ModerationComponent extends BotComponent {
                 expunged: null,
                 link: command.get_or_forge_url(),
             };
-            const cant_dm = !(await this.notify_user(user, this.past_participle, moderation));
+            const is_note_type = note_moderation_types.includes(this.type);
+            const notification_failed = await (async () => {
+                if (!is_note_type) {
+                    return !(await this.notify_user(user, this.past_participle, moderation));
+                } else {
+                    return false;
+                }
+            })();
             await this.issue_moderation(moderation);
+            const success_message = is_note_type
+                ? `Note added for ${user.displayName}`
+                : `${user.displayName} was ${this.past_participle}`;
+            const reason_line = (() => {
+                if (!command.is_slash() || !reason) {
+                    return null;
+                }
+                return is_note_type ? `**Note:** ${reason}` : `**Reason:** ${reason}`;
+            })();
             await command.reply({
                 content:
                     basic_moderation_info.type === "ban"
@@ -739,8 +766,8 @@ export abstract class ModerationComponent extends BotComponent {
                         .setColor(colors.wheatley)
                         .setDescription(
                             build_description(
-                                `${this.wheatley.emoji.success} ***${user.displayName} was ${this.past_participle}***`,
-                                command.is_slash() && reason ? `**Reason:** ${reason}` : null,
+                                `${this.wheatley.emoji.success} ***${success_message}***`,
+                                reason_line,
                                 (!this.is_once_off && duration_string === null) || reason === null
                                     ? `Remember to provide a ${[
                                           !this.is_once_off && duration_string === null ? "duration" : null,
@@ -752,13 +779,16 @@ export abstract class ModerationComponent extends BotComponent {
                                 !this.is_once_off && duration_string !== null
                                     ? `**Duration**: ${duration == null ? "permanent" : time_to_human(duration)}`
                                     : null,
-                                cant_dm ? "Note: Couldn't notify user (DM and thread fallback both failed)." : null,
+                                notification_failed
+                                    ? "Note: Couldn't notify user (DM and thread fallback both failed)."
+                                    : null,
                             ),
                         )
                         .setFooter({
                             text: `Case ${moderation.case_number}`,
                         }),
                 ],
+                ephemeral_if_possible: is_note_type,
             });
         } catch (e) {
             if (e instanceof ParseError) {
@@ -841,6 +871,7 @@ export abstract class ModerationComponent extends BotComponent {
         user: Discord.User,
         reason: string | null,
         additional_moderation_properties: any = {},
+        options: revoke_handler_options = {},
     ) {
         assert(!this.is_once_off);
         try {
@@ -862,7 +893,17 @@ export abstract class ModerationComponent extends BotComponent {
                     sort: { issued_at: -1 },
                 },
             );
-            if (!res) {
+            if (!res && options.allow_no_entry) {
+                const member = await this.wheatley.try_fetch_guild_member(user);
+                if (member) {
+                    await this.apply_revoke_to_discord(member);
+                }
+                const message =
+                    `${this.wheatley.emoji.success} ` + `***${user.displayName} was un${this.past_participle}***`;
+                await command.reply({
+                    embeds: [new Discord.EmbedBuilder().setColor(colors.wheatley).setDescription(message)],
+                });
+            } else if (!res) {
                 await this.reply_with_error(command, `User is not ${this.past_participle}`);
             } else {
                 this.sleep_list.remove(res._id);
@@ -904,7 +945,7 @@ export abstract class ModerationComponent extends BotComponent {
                             .setDescription(remaining_message),
                     ],
                 });
-                if (res.type !== "note") {
+                if (!note_moderation_types.includes(res.type)) {
                     await this.public_action_log.send({
                         embeds: [
                             Modlogs.case_summary(

src/modules/wheatley/components/moderation/moderation-control.ts

@@ -7,7 +7,7 @@ import { M } from "../../../../utils/debugging-and-logging.js";
 import { BotComponent } from "../../../../bot-component.js";
 import { Wheatley } from "../../../../wheatley.js";
 import { ModerationComponent, parse_duration } from "./moderation-common.js";
-import { moderation_entry } from "./schemata.js";
+import { moderation_entry, note_moderation_types, voice_moderation_types } from "./schemata.js";
 import { CommandSetBuilder } from "../../../../command-abstractions/command-set-builder.js";
 import { colors } from "../../../../common.js";
 import Modlogs, { staff_moderation_display_options, public_moderation_display_options } from "./modlogs.js";
@@ -102,7 +102,7 @@ export default class ModerationControl extends BotComponent {
             new TextBasedCommandBuilder("expunge", EarlyReplyMode.visible)
                 .set_category("Moderation")
                 .set_description("Expunge a case")
-                .set_permissions(Discord.PermissionFlagsBits.BanMembers)
+                .set_permissions(Discord.PermissionFlagsBits.BanMembers | Discord.PermissionFlagsBits.MuteMembers)
                 .add_number_option({
                     title: "case",
                     description: "Case to expunge",
@@ -157,7 +157,7 @@ export default class ModerationControl extends BotComponent {
                     ).setTitle(`Case ${res.case_number} reason updated`),
                 ],
             });
-            if (res.type !== "note") {
+            if (!note_moderation_types.includes(res.type)) {
                 await this.public_action_log.send({
                     embeds: [
                         Modlogs.case_summary(
@@ -237,7 +237,7 @@ export default class ModerationControl extends BotComponent {
                     ).setTitle(`Case ${res.case_number} duration updated`),
                 ],
             });
-            if (res.type !== "note") {
+            if (!note_moderation_types.includes(res.type)) {
                 await this.public_action_log.send({
                     embeds: [
                         Modlogs.case_summary(
@@ -254,14 +254,27 @@ export default class ModerationControl extends BotComponent {
     }
 
     async expunge(command: TextBasedCommand, case_number: number, reason: string | null) {
+        const member = await command.get_member();
+        const has_ban_members = member.permissions.has(Discord.PermissionFlagsBits.BanMembers);
+        if (!has_ban_members) {
+            const moderation = await this.database.moderations.findOne({ case_number });
+            if (!moderation) {
+                await this.reply_with_error(command, `Case ${case_number} not found`);
+                return;
+            }
+            if (!voice_moderation_types.includes(moderation.type)) {
+                await this.reply_with_error(command, "You can only expunge voice moderation cases");
+                return;
+            }
+        }
         const res = await this.database.moderations.findOneAndUpdate(
             { case_number },
             {
                 $set: {
                     active: false, // moderation update handler will handle the removal if necessary
                     expunged: {
                         moderator: command.user.id,
-                        moderator_name: (await command.get_member()).displayName,
+                        moderator_name: member.displayName,
                         reason,
                         timestamp: Date.now(),
                     },
@@ -284,7 +297,7 @@ export default class ModerationControl extends BotComponent {
                     ).setTitle(`Case ${res.case_number} expunged`),
                 ],
             });
-            if (res.type !== "note") {
+            if (!note_moderation_types.includes(res.type)) {
                 await this.public_action_log.send({
                     embeds: [
                         Modlogs.case_summary(

src/modules/wheatley/components/moderation/modlogs.ts

@@ -20,7 +20,7 @@ import {
     TextBasedCommand,
 } from "../../../../command-abstractions/text-based-command.js";
 import { remove } from "../../../../utils/arrays.js";
-import { moderation_entry } from "./schemata.js";
+import { moderation_entry, voice_moderation_types } from "./schemata.js";
 import { discord_timestamp } from "../../../../utils/discord.js";
 import { unwrap } from "../../../../utils/misc.js";
 import LinkedAccounts from "../linked-accounts.js";
@@ -114,9 +114,11 @@ export default class Modlogs extends BotComponent {
         moderation: moderation_entry,
     ): modlog_display_options {
         const is_mod_only = Modlogs.is_mod_only(channel);
+        const is_voice_mod_channel = Modlogs.is_voice_mod_channel(channel);
+        const is_voice_moderation = voice_moderation_types.includes(moderation.type);
         return {
             show_private_logs: is_mod_only,
-            show_moderator: is_mod_only,
+            show_moderator: is_mod_only || (is_voice_mod_channel && is_voice_moderation),
         };
     }
 

src/modules/wheatley/components/moderation/note.ts

@@ -1,19 +1,16 @@
-import { strict as assert } from "assert";
-
 import * as Discord from "discord.js";
 import * as mongo from "mongodb";
 
-import { Wheatley } from "../../../../wheatley.js";
+import { strict as assert } from "assert";
+
 import { ModerationComponent } from "./moderation-common.js";
 import { CommandSetBuilder } from "../../../../command-abstractions/command-set-builder.js";
 import {
     EarlyReplyMode,
     TextBasedCommandBuilder,
 } from "../../../../command-abstractions/text-based-command-builder.js";
 import { TextBasedCommand } from "../../../../command-abstractions/text-based-command.js";
-import { moderation_entry, basic_moderation } from "./schemata.js";
-import { colors } from "../../../../common.js";
-import { build_description } from "../../../../utils/strings.js";
+import { moderation_entry, basic_moderation_with_user } from "./schemata.js";
 
 export default class Note extends ModerationComponent {
     get type() {
@@ -52,54 +49,7 @@ export default class Note extends ModerationComponent {
         );
     }
 
-    override async moderation_issue_handler(
-        command: TextBasedCommand,
-        user: Discord.User,
-        duration: string | null,
-        reason: string | null,
-        basic_moderation_info: basic_moderation,
-    ) {
-        try {
-            const moderation: moderation_entry = {
-                ...basic_moderation_info,
-                case_number: -1,
-                user: user.id,
-                user_name: user.displayName,
-                moderator: command.user.id,
-                moderator_name: (await command.get_member()).displayName,
-                reason,
-                issued_at: Date.now(),
-                duration: null,
-                active: false,
-                removed: null,
-                expunged: null,
-                link: command.get_or_forge_url(),
-            };
-            await this.issue_moderation(moderation);
-            await command.reply({
-                embeds: [
-                    new Discord.EmbedBuilder()
-                        .setColor(colors.wheatley)
-                        .setDescription(
-                            build_description(
-                                `${this.wheatley.emoji.success} ***Note added for ${user.displayName}***`,
-                                command.is_slash() && reason ? `**Reason:** ${reason}` : null,
-                            ),
-                        )
-                        .setFooter({
-                            text: `Case ${moderation.case_number}`,
-                        }),
-                ],
-                ephemeral_if_possible: true,
-            });
-        } catch (e) {
-            await this.reply_with_error(command, `Error issuing ${this.type}`);
-            this.wheatley.critical_error(e);
-        }
-    }
-
     async apply_moderation(entry: moderation_entry) {
-        // nop
         void entry;
     }
 
@@ -108,7 +58,7 @@ export default class Note extends ModerationComponent {
         assert(false);
     }
 
-    is_moderation_applied_in_discord(moderation: basic_moderation): never {
+    is_moderation_applied_in_discord(moderation: basic_moderation_with_user): never {
         void moderation;
         assert(false);
     }

src/modules/wheatley/components/moderation/schemata.ts

@@ -4,7 +4,22 @@ export type moderation_state = {
     modmail_id: number;
 };
 
-export type moderation_type = "mute" | "warn" | "ban" | "kick" | "rolepersist" | "timeout" | "softban" | "note";
+export type moderation_type =
+    | "mute"
+    | "warn"
+    | "ban"
+    | "kick"
+    | "rolepersist"
+    | "timeout"
+    | "softban"
+    | "note"
+    | "voice_note"
+    | "voice_mute"
+    | "voice_take";
+
+export const voice_moderation_types: moderation_type[] = ["voice_note", "voice_mute", "voice_take"];
+
+export const note_moderation_types: moderation_type[] = ["note", "voice_note"];
 
 export type moderation_edit_info = {
     moderator: string;