[sync] : merge feature slash-manage-command into main

AppsSpamMonitorApp.ts

@@ -19,6 +19,12 @@ import {
 } from '@rocket.chat/apps-engine/definition/messages';
 import { IAppInfo } from '@rocket.chat/apps-engine/definition/metadata';
 import { ISetting } from '@rocket.chat/apps-engine/definition/settings';
+import {
+	IUIKitResponse,
+	UIKitBlockInteractionContext,
+	UIKitViewSubmitInteractionContext,
+} from '@rocket.chat/apps-engine/definition/uikit';
+import { IUIKitInteractionHandler } from '@rocket.chat/apps-engine/definition/uikit/IUIKitActionHandler';
 import { SpamProcessor } from './src/core/spamProcessor';
 import { MessageCache } from './src/core/cache/messageCache';
 import { SpamMonitorCommand } from './src/commands/commandUtilities';
@@ -35,10 +41,15 @@ import {
 	MS_PER_DAY,
 	MS_PER_SECOND,
 } from './src/constants/config';
+import { ViewSubmitHandler } from './src/handlers/viewSubmitHandler';
+import { BlockActionHandler } from './src/handlers/blockActionHandler';
 
 export class AppsSpamMonitorApp
 	extends App
-	implements IPreMessageSentPrevent, IPostMessageSent
+	implements
+		IPreMessageSentPrevent,
+		IPostMessageSent,
+		IUIKitInteractionHandler
 {
 	private processor: SpamProcessor | null = null;
 	private cache: MessageCache;
@@ -63,9 +74,8 @@ export class AppsSpamMonitorApp
 				configuration.settings.provideSetting(setting),
 			),
 		);
-
 		await configuration.slashCommands.provideSlashCommand(
-			new SpamMonitorCommand(),
+			new SpamMonitorCommand(this.getID()),
 		);
 	}
 
@@ -178,7 +188,6 @@ export class AppsSpamMonitorApp
 
 	private async loadSettings(env: IEnvironmentRead): Promise<void> {
 		const settings = env.getSettings();
-
 		const [
 			monitoringWindowDays,
 			slidingWindowSeconds,
@@ -213,9 +222,7 @@ export class AppsSpamMonitorApp
 		_read: IRead,
 		_http: IHttp,
 	): Promise<boolean> {
-		if (!message.sender || !message.room || !message.text) {
-			return false;
-		}
+		if (!message.sender || !message.room || !message.text) return false;
 		return message.room.type !== RoomType.DIRECT_MESSAGE;
 	}
 
@@ -225,9 +232,7 @@ export class AppsSpamMonitorApp
 		_http: IHttp,
 		persistence: IPersistence,
 	): Promise<boolean> {
-		if (!message.sender || !message.room) {
-			return false;
-		}
+		if (!message.sender || !message.room) return false;
 		try {
 			const { restricted } = await UserStatusStore.isRestricted(
 				read,
@@ -246,9 +251,8 @@ export class AppsSpamMonitorApp
 		_read: IRead,
 		_http: IHttp,
 	): Promise<boolean> {
-		if (!message.text || message.room.type === RoomType.DIRECT_MESSAGE) {
+		if (!message.text || message.room.type === RoomType.DIRECT_MESSAGE)
 			return false;
-		}
 		return true;
 	}
 
@@ -259,33 +263,60 @@ export class AppsSpamMonitorApp
 		persistence: IPersistence,
 		modify: IModify,
 	): Promise<void> {
-		if (!message.sender || !message.room) {
-			return;
-		}
-
+		if (!message.sender || !message.room) return;
 		const sender = await read.getUserReader().getById(message.sender.id);
-		if (!sender || !this.processor?.isNewUser(sender)) {
-			return;
-		}
-
+		if (!sender || !this.processor?.isNewUser(sender)) return;
 		try {
 			const result = await this.processor.analyzeMessage(
 				message,
 				read,
 				persistence,
 			);
-
 			if (result?.flagged && result.record && result.levelChanged) {
 				await RestrictionManager.applyAction(
 					read,
 					modify,
 					sender,
 					result.record,
-					{ levelChanged: result.levelChanged },
+					{
+						levelChanged: result.levelChanged,
+					},
 				);
 			}
 		} catch (err) {
 			this.getLogger().error('[antispam] Error in analyzeMessage:', err);
 		}
 	}
+
+	public async executeBlockActionHandler(
+		context: UIKitBlockInteractionContext,
+		read: IRead,
+		http: IHttp,
+		persistence: IPersistence,
+		modify: IModify,
+	): Promise<IUIKitResponse> {
+		return new BlockActionHandler(
+			read,
+			http,
+			persistence,
+			modify,
+			context,
+			this.getID(),
+		).handle();
+	}
+	public async executeViewSubmitHandler(
+		context: UIKitViewSubmitInteractionContext,
+		read: IRead,
+		http: IHttp,
+		persistence: IPersistence,
+		modify: IModify,
+	): Promise<IUIKitResponse> {
+		return new ViewSubmitHandler(
+			read,
+			http,
+			persistence,
+			modify,
+			context,
+		).handle();
+	}
 }

app.json

@@ -18,7 +18,8 @@
     "description": "Automatically detects and flags spam from new users before it reaches Rocket.Chats community",
     "implements": [
         "IPreMessageSentPrevent",
-        "IPostMessageSent"
+        "IPostMessageSent",
+        "IUIKitInteractionHandler"
     ],
     "permissions": [
         {

src/commands/commandUtilities.ts

@@ -12,13 +12,17 @@ import { SpamMonitorHandler } from '../handlers/handler';
 import { SpamMonitorParam } from '../enums/commandUtilities';
 import { slashCommandHelp, slashNotifications } from '../enums/notifications';
 import { ADMIN_CHANNEL_NAME } from '../constants/config';
+import { RoomInteractionStorage } from '../persistence/roomInteraction';
 
 export class SpamMonitorCommand implements ISlashCommand {
 	public command = 'spammonitor';
 	public i18nDescription = 'SpamMonitor_Command_Description';
-	public i18nParamsExample = 'list all | list timeout | list <Level>';
+	public i18nParamsExample =
+		'list all | list timeout | list <Level> | manage <username>';
 	public providesPreview = false;
 
+	constructor(private readonly appId: string) {}
+
 	public async executor(
 		context: SlashCommandContext,
 		read: IRead,
@@ -28,13 +32,23 @@ export class SpamMonitorCommand implements ISlashCommand {
 	): Promise<void> {
 		const sender = context.getSender();
 		const room = context.getRoom();
+		const triggerId = context.getTriggerId();
+
+		const roomInteractionStorage = new RoomInteractionStorage(
+			persistence,
+			read.getPersistenceReader(),
+			sender.id,
+		);
+		roomInteractionStorage.storeInteractionRoomId(room.id);
+
 		const handler = new SpamMonitorHandler(
 			sender,
 			room,
 			read,
 			modify,
 			http,
 			persistence,
+			this.appId,
 		);
 
 		if (room.slugifiedName !== ADMIN_CHANNEL_NAME) {
@@ -51,25 +65,40 @@ export class SpamMonitorCommand implements ISlashCommand {
 		}
 
 		const [subcommand, ...rest] = context.getArguments();
-		if (subcommand?.toLowerCase() !== SpamMonitorParam.LIST) {
-			await handler.sendNotification(slashCommandHelp.HELP);
-			return;
-		}
 
-		const filter = rest.join(' ').toLowerCase().trim();
-		switch (filter) {
-			case SpamMonitorParam.ALL:
-			case '':
-				await handler.listAll();
-				break;
-			case SpamMonitorParam.TIMEOUT:
-				await handler.listTimeout();
+		switch (subcommand?.toLowerCase()) {
+			case SpamMonitorParam.LIST: {
+				const filter = rest.join(' ').toLowerCase().trim();
+				switch (filter) {
+					case SpamMonitorParam.ALL:
+					case '':
+						await handler.listAll();
+						break;
+					case SpamMonitorParam.TIMEOUT:
+						await handler.listTimeout();
+						break;
+					case SpamMonitorParam.ADMIN_REVIEW:
+						await handler.listAdminReview();
+						break;
+					default:
+						await handler.listByLevel(filter);
+						break;
+				}
 				break;
-			case SpamMonitorParam.ADMIN_REVIEW:
-				await handler.listAdminReview();
+			}
+			case SpamMonitorParam.MANAGE: {
+				const username = rest[0]?.replace(/^@/, '').trim();
+				if (!triggerId) {
+					await handler.sendNotification(
+						slashNotifications.MANAGE_MISSING_USERNAME,
+					);
+					return;
+				}
+				await handler.manageUser(username, triggerId);
 				break;
+			}
 			default:
-				await handler.listByLevel(filter);
+				await handler.sendNotification(slashCommandHelp.HELP);
 				break;
 		}
 	}

src/handlers/blockActionHandler.ts

@@ -0,0 +1,107 @@
+import {
+	IHttp,
+	IModify,
+	IPersistence,
+	IRead,
+} from '@rocket.chat/apps-engine/definition/accessors';
+import {
+	IUIKitResponse,
+	UIKitBlockInteractionContext,
+} from '@rocket.chat/apps-engine/definition/uikit';
+import { buildConfirmActionModal } from '../modals/confirmationModal';
+import { buildManageUserModal } from '../modals/manageUsers';
+import { RoomInteractionStorage } from '../persistence/roomInteraction';
+import { UserStatusStore } from '../persistence/userStatusStore';
+import {
+	ACTIONS_REQUIRING_CONFIRM,
+	CONFIRM_TO_ACTION,
+	ManageUserActionId,
+} from '../enums/modals/manageUsers';
+
+export class BlockActionHandler {
+	constructor(
+		private readonly read: IRead,
+		private readonly http: IHttp,
+		private readonly persistence: IPersistence,
+		private readonly modify: IModify,
+		private readonly context: UIKitBlockInteractionContext,
+		private readonly appId: string,
+	) {}
+
+	public async handle(): Promise<IUIKitResponse> {
+		const { actionId, value, user, triggerId } =
+			this.context.getInteractionData();
+		const roomStorage = new RoomInteractionStorage(
+			this.persistence,
+			this.read.getPersistenceReader(),
+			user.id,
+		);
+
+		if (actionId === ManageUserActionId.OPEN_MANAGE_MODAL) {
+			if (!value || !triggerId) {
+				return this.context.getInteractionResponder().successResponse();
+			}
+			// value format: "<intent>::<userId>"
+			const [intent, userId] = value.split('::');
+
+			if (intent === ManageUserActionId.OPEN_MANAGE_MODAL) {
+				const targetUser = await this.read
+					.getUserReader()
+					.getById(userId);
+				if (!targetUser) {
+					return this.context
+						.getInteractionResponder()
+						.successResponse();
+				}
+
+				const record = await UserStatusStore.get(this.read, userId);
+				if (!record) {
+					return this.context
+						.getInteractionResponder()
+						.successResponse();
+				}
+
+				const modal = buildManageUserModal(record, this.appId);
+				await this.modify
+					.getUiController()
+					.openSurfaceView(modal, { triggerId }, user);
+
+				return this.context.getInteractionResponder().successResponse();
+			}
+
+			return this.context.getInteractionResponder().successResponse();
+		}
+
+		if (!ACTIONS_REQUIRING_CONFIRM.has(actionId)) {
+			return this.context.getInteractionResponder().successResponse();
+		}
+
+		if (!value || !triggerId) {
+			return this.context.getInteractionResponder().successResponse();
+		}
+
+		const roomId = await roomStorage.getInteractionRoomId();
+		if (!roomId) {
+			return this.context.getInteractionResponder().successResponse();
+		}
+
+		const targetUser = await this.read.getUserReader().getById(value);
+		if (!targetUser) {
+			return this.context.getInteractionResponder().successResponse();
+		}
+
+		const realAction = CONFIRM_TO_ACTION[actionId];
+		const modal = buildConfirmActionModal(
+			realAction,
+			targetUser.id,
+			targetUser.username,
+			this.appId,
+			roomId,
+		);
+		await this.modify
+			.getUiController()
+			.openSurfaceView(modal, { triggerId }, user);
+
+		return this.context.getInteractionResponder().successResponse();
+	}
+}