Enhance detection functionality and reporting options

- Added ability to remove posts with an optional removal message when AI-generated content is detected.
- Updated detection methods to return arrays of messages instead of single strings for better handling.
- Introduced new settings for auto-check actions and removal message placeholders in the configuration.
- Updated README to reflect changes in functionality and versioning.

Author: fsvreddit

README.md

@@ -28,12 +28,18 @@ You can also set the app up to proactively check new posts, or posts approved ou
 
 Consider setting a suitable account age and karma threshold to restrict this feature to accounts who are more likely to break rules. Posts from moderators will never be checked, and by default content from approved users will not be checked (but this can be changed).
 
-If an image is detected as AI, a report like this will be made:
+You can configure the app to either report the post (the default option) or remove with an optional removal reason.
+
+By default, a report will be made:
 
 ![screenshot](https://github.com/fsvreddit/image-moderator/blob/main/doc_images/screenshot.png?raw=true)
 
 ## Change History
 
+### v1.2
+
+* Added ability to remove posts if a match occurs, with an optional removal message
+
 ### v1.1.2
 
 * Add additional detection types

src/checkNewPost.ts

@@ -2,7 +2,7 @@ import { ModAction, PostCreate } from "@devvit/protos";
 import { Post, SettingsValues, TriggerContext, User } from "@devvit/public-api";
 import { getSightengineResults } from "./checkSightEngineAPI.js";
 import { postIsImage } from "./utility.js";
-import { AppSetting } from "./settings.js";
+import { AppSetting, AutoCheckActionOption } from "./settings.js";
 import { DateTime } from "luxon";
 import { userIsModerator } from "./moderatorChecks.js";
 import { getModels, getRelevantDetectors } from "./detections/allDetections.js";
@@ -11,7 +11,7 @@ function getFilterKeyForPost (postId: string) {
     return `filtered_post:${postId}`;
 }
 
-async function checkAndReportPost (postId: string, source: "PostCreate" | "PostApprovalAction", settings: SettingsValues, context: TriggerContext) {
+async function checkAndActionPost (postId: string, source: "PostCreate" | "PostApprovalAction", settings: SettingsValues, context: TriggerContext) {
     let post: Post | undefined;
     try {
         post = await context.reddit.getPostById(postId);
@@ -90,9 +90,9 @@ async function checkAndReportPost (postId: string, source: "PostCreate" | "PostA
     const detectionResults: string[] = [];
     for (const Detection of detectors) {
         const detectionInstance = new Detection(settings);
-        const detectionResult = detectionInstance.detectProactive(result);
-        if (detectionResult) {
-            detectionResults.push(detectionResult);
+        const instanceDetectionResults = detectionInstance.detectProactive(result);
+        if (instanceDetectionResults && instanceDetectionResults.length > 0) {
+            detectionResults.push(...instanceDetectionResults);
         }
     }
 
@@ -101,8 +101,42 @@ async function checkAndReportPost (postId: string, source: "PostCreate" | "PostA
         return;
     }
 
+    const [actionToTake] = settings[AppSetting.AutoCheckAction] as AutoCheckActionOption[] | undefined ?? [AutoCheckActionOption.ReportPost];
+    if (actionToTake === AutoCheckActionOption.ReportPost) {
+        await reportPost(post, detectionResults, context);
+    } else { // Remove post is the only other option
+        await removePost(post, detectionResults, settings[AppSetting.RemovalMessagePlaceholder] as string | undefined, context);
+    }
+}
+
+async function reportPost (post: Post, detectionResults: string[], context: TriggerContext) {
     await context.reddit.report(post, { reason: detectionResults.join(", ") });
-    console.log(`${source}: Post ${post.id} matched: ${detectionResults.join(", ")}. Reported.`);
+    console.log(`Reported post ${post.id} for: ${detectionResults.join(", ")}`);
+}
+
+async function removePost (post: Post, detectionResults: string[], removalMessagePlaceholder: string | undefined, context: TriggerContext) {
+    await post.remove();
+    console.log(`Removed post ${post.id} for: ${detectionResults.join(", ")}`);
+    if (removalMessagePlaceholder) {
+        const subredditName = context.subredditName ?? await context.reddit.getCurrentSubredditName();
+        let removalMessage = removalMessagePlaceholder
+            .replaceAll("{{subreddit}}", subredditName)
+            .replaceAll("{{author}}", post.authorName)
+            .replaceAll("{{reasons}}", detectionResults.map(r => `- ${r}`).join("\n"));
+
+        removalMessage = removalMessage.trim();
+        removalMessage += `\n\n*I am a bot, and this action was performed automatically. Please [contact the moderators of this subreddit](/message/compose/?to=/r/${subredditName}) if you have any questions or concerns.*`;
+
+        const newComment = await post.addComment({
+            text: removalMessage,
+        });
+
+        await Promise.all([
+            newComment.distinguish(true),
+            newComment.lock(),
+        ]);
+        console.log(`Added removal comment to post ${post.id}`);
+    }
 }
 
 export async function handlePostCreate (event: PostCreate, context: TriggerContext) {
@@ -119,7 +153,7 @@ export async function handlePostCreate (event: PostCreate, context: TriggerConte
         return;
     }
 
-    await checkAndReportPost(event.post.id, "PostCreate", settings, context);
+    await checkAndActionPost(event.post.id, "PostCreate", settings, context);
 }
 
 export async function handlePostApprovalAction (event: ModAction, context: TriggerContext) {
@@ -143,6 +177,6 @@ export async function handlePostApprovalAction (event: ModAction, context: Trigg
         return;
     }
 
-    await checkAndReportPost(event.targetPost.id, "PostApprovalAction", settings, context);
+    await checkAndActionPost(event.targetPost.id, "PostApprovalAction", settings, context);
     await context.redis.del(getFilterKeyForPost(event.targetPost.id));
 }

src/detections/DetectDeepfake.ts

@@ -33,14 +33,14 @@ export class DetectDeepfake extends DetectionBase {
         return Math.round(sightEngineResponse.type.deepfake * 100);
     }
 
-    public detectProactive (sightEngineResponse: SightengineResponse): string | undefined {
+    public detectProactive (sightEngineResponse: SightengineResponse): string[] | undefined {
         const deepfakeLikelihood = this.getDeepfakeLikelihood(sightEngineResponse);
         if (!deepfakeLikelihood) {
             return;
         }
 
         if (deepfakeLikelihood > this.getSetting<number>(ModuleSetting.Threshold, 80)) {
-            return `Deepfake Likelihood: ${deepfakeLikelihood}%`;
+            return [`Deepfake Likelihood: ${deepfakeLikelihood}%`];
         }
     }
 

src/detections/DetectDrugs.test.ts

@@ -23,7 +23,7 @@ test("Cannabis detection", () => {
     };
 
     const result = detector.detectProactive(sightEngineResponse);
-    expect(result).toBe("Drug likelihood: 99%");
+    expect(result).toEqual(["Drug likelihood: 99%"]);
 });
 
 test("Cannabis ignored when option is chosen", () => {
@@ -73,5 +73,5 @@ test("Other drugs detected when Allow Cannabis is chosen", () => {
     };
 
     const result = detector.detectProactive(sightEngineResponse);
-    expect(result).toBe("Drug likelihood: 99%");
+    expect(result).toEqual(["Drug likelihood: 99%"]);
 });

src/detections/DetectDrugs.ts

@@ -57,14 +57,14 @@ export class DetectDrugs extends DetectionBase {
         return Math.round(sightEngineResponse.recreational_drug.prob * 100);
     }
 
-    public detectProactive (sightEngineResponse: SightengineResponse): string | undefined {
+    public detectProactive (sightEngineResponse: SightengineResponse): string[] | undefined {
         const drugLikelihood = this.getDetectionResult(sightEngineResponse);
         if (drugLikelihood === undefined) {
             return;
         }
 
         if (drugLikelihood > this.getSetting<number>(ModuleSetting.Threshold, 80)) {
-            return `Drug likelihood: ${drugLikelihood}%`;
+            return [`Drug likelihood: ${drugLikelihood}%`];
         }
     }
 

src/detections/DetectGenAI.ts

@@ -33,14 +33,14 @@ export class DetectGenAI extends DetectionBase {
         return Math.round(sightEngineResponse.type.ai_generated * 100);
     }
 
-    public detectProactive (sightEngineResponse: SightengineResponse): string | undefined {
+    public detectProactive (sightEngineResponse: SightengineResponse): string[] | undefined {
         const aiLikelihood = this.getAILikelihood(sightEngineResponse);
         if (aiLikelihood === undefined) {
             return;
         }
 
         if (aiLikelihood > this.getSetting<number>(ModuleSetting.Threshold, 80)) {
-            return `AI Likelihood: ${aiLikelihood}%`;
+            return [`AI Likelihood: ${aiLikelihood}%`];
         }
     }
 

src/detections/DetectImageQuality.ts

@@ -33,12 +33,11 @@ export class DetectImageQuality extends DetectionBase {
         return Math.round(sightEngineResponse.quality.score * 100);
     }
 
-    public detectProactive (sightEngineResponse: SightengineResponse): string | undefined {
+    public detectProactive (sightEngineResponse: SightengineResponse): string[] | undefined {
         const quality = this.getQualityScore(sightEngineResponse);
         if (quality && quality < this.getSetting(ModuleSetting.QualityThreshold, 50)) {
-            return `Image quality is low (${quality})`;
+            return [`Image quality is low (${quality})`];
         }
-        return undefined;
     }
 
     public detectByMenu (sightEngineResponse: SightengineResponse): string | undefined {

src/detections/DetectImageType.ts

@@ -64,12 +64,12 @@ export class DetectImageType extends DetectionBase {
         return selectedType[0] as "photo" | "illustration";
     }
 
-    public detectProactive (sightEngineResponse: SightengineResponse): string | undefined {
+    public detectProactive (sightEngineResponse: SightengineResponse): string[] | undefined {
         const detectedType = this.getImageType(sightEngineResponse);
         const reportableType = this.getReportableImageType();
 
         if (detectedType && detectedType !== reportableType) {
-            return `Detected image type: ${detectedType}`;
+            return [`Detected image type: ${detectedType}`];
         }
     }
 

src/detections/DetectMinors.ts

@@ -31,10 +31,10 @@ export class DetectMinors extends DetectionBase {
         return max(minorLikelihoods.map(likelihood => Math.round(likelihood * 100)));
     }
 
-    public detectProactive (sightEngineResponse: SightengineResponse): string | undefined {
+    public detectProactive (sightEngineResponse: SightengineResponse): string[] | undefined {
         const minorLikelihood = this.getMinorLikelihood(sightEngineResponse);
         if (minorLikelihood && minorLikelihood > this.getSetting(ModuleSetting.MinorThreshold, 80)) {
-            return `Likely minor: ${minorLikelihood}%`;
+            return [`Likely minor: ${minorLikelihood}%`];
         }
     }
 

src/detections/DetectOffensiveContent.ts

@@ -107,10 +107,10 @@ export class DetectOffensiveContent extends DetectionBase {
         return results;
     }
 
-    public detectProactive (sightEngineResponse: SightengineResponse): string | undefined {
+    public detectProactive (sightEngineResponse: SightengineResponse): string[] | undefined {
         const results = this.getDetectionResults(sightEngineResponse);
         if (results.length > 0) {
-            return results.join(", ");
+            return results;
         }
     }