@kkuffour/solid-moderation-plugin 0.1.0

package/src/providers/SightEngineProvider.ts

@@ -0,0 +1,367 @@
+import { createReadStream } from 'node:fs';
+import { getLoggerFor } from '@solid/community-server';
+
+interface ApiResponse {
+  nudity?: { raw: number };
+  violence?: { prob?: number } | number;
+  gore?: { prob?: number } | number;
+  weapon?: { prob?: number } | number;
+  alcohol?: { prob?: number } | number;
+  offensive?: { prob?: number } | number;
+  selfHarm?: { prob?: number } | number;
+  gambling?: { prob?: number } | number;
+  recreationalDrug?: { prob?: number } | number;
+  tobacco?: { prob?: number } | number;
+  profanity?: { matches?: Match[] };
+  personal?: { matches?: unknown[] };
+  // eslint-disable-next-line @typescript-eslint/naming-convention -- API response field name
+  'self-harm'?: { prob?: number } | number;
+  // eslint-disable-next-line @typescript-eslint/naming-convention -- API response field name
+  recreational_drug?: { prob?: number } | number;
+}
+
+interface Match {
+  type: string;
+  intensity: 'high' | 'medium' | 'low';
+}
+
+export interface SightEngineResult {
+  nudity?: { raw: number };
+  violence: number;
+  gore: number;
+  weapon: number;
+  alcohol: number;
+  drugs: number;
+  offensive: number;
+  selfharm: number;
+  gambling: number;
+  profanity: number;
+  personalInfo: number;
+}
+
+export interface SightEngineTextResult {
+  sexual: number;
+  discriminatory: number;
+  insulting: number;
+  violent: number;
+  toxic: number;
+  selfharm: number;
+  personalInfo: number;
+}
+
+export interface SightEngineVideoResult {
+  nudity?: { raw: number };
+  violence: number;
+  gore: number;
+  weapon: number;
+  alcohol: number;
+  offensive: number;
+  selfharm: number;
+  gambling: number;
+  drugs: number;
+  tobacco: number;
+}
+
+/**
+ * SightEngine implementation of content moderation provider.
+ */
+export class SightEngineProvider {
+  protected readonly logger = getLoggerFor(this);
+
+  private readonly apiUser: string;
+  private readonly apiSecret: string;
+
+  public constructor(apiUser: string, apiSecret: string) {
+    this.apiUser = apiUser;
+    this.apiSecret = apiSecret;
+  }
+
+  public async analyzeImage(filePath: string): Promise<SightEngineResult> {
+    this.logger.info(`SIGHTENGINE: Starting analysis for ${filePath}`);
+
+    // eslint-disable-next-line @typescript-eslint/naming-convention -- External module class name
+    const FormData = (await import('form-data')).default;
+
+    this.logger.info(`SIGHTENGINE: Creating form data for ${filePath}`);
+
+    const form = new FormData();
+    form.append('media', createReadStream(filePath));
+    form.append('models', 'nudity-2.1,violence,gore,weapon,alcohol,offensive,self-harm,gambling');
+    form.append('api_user', this.apiUser);
+    form.append('api_secret', this.apiSecret);
+
+    this.logger.info(`SIGHTENGINE: Sending request to API for ${filePath}`);
+    const startTime = Date.now();
+
+    const result = await new Promise<ApiResponse>((resolve, reject): void => {
+      form.submit('https://api.sightengine.com/1.0/check.json', (err, res): void => {
+        if (err) {
+          reject(err);
+          return;
+        }
+
+        let data = '';
+        res.on('data', (chunk: Buffer): void => {
+          data += chunk.toString();
+        });
+        res.on('end', (): void => {
+          const requestTime = Date.now() - startTime;
+          this.logger.info(`SIGHTENGINE: API response received in ${requestTime}ms for ${filePath}`);
+
+          if (res.statusCode !== 200) {
+            this.logger.error(`SIGHTENGINE: API error ${res.statusCode} ${data} for ${filePath}`);
+            reject(new Error(`SightEngine API error: ${res.statusCode} ${data}`));
+            return;
+          }
+
+          this.logger.info(`SIGHTENGINE: Parsing JSON response for ${filePath}`);
+          try {
+            resolve(JSON.parse(data) as ApiResponse);
+          } catch (parseErr) {
+            reject(new Error(`Failed to parse response: ${String(parseErr)}`));
+          }
+        });
+      });
+    });
+
+    const analysisResult = {
+      nudity: result.nudity,
+      violence: result.violence && typeof result.violence === 'object' ?
+        result.violence.prob ?? 0 :
+        result.violence ?? 0,
+      gore: result.gore && typeof result.gore === 'object' ?
+        result.gore.prob ?? 0 :
+        result.gore ?? 0,
+      weapon: typeof result.weapon === 'object' && result.weapon ?
+        result.weapon.prob ?? 0 :
+        result.weapon ?? 0,
+      alcohol: result.alcohol && typeof result.alcohol === 'object' ?
+        result.alcohol.prob ?? 0 :
+        result.alcohol ?? 0,
+      drugs: 0,
+      offensive: result.offensive && typeof result.offensive === 'object' ?
+        result.offensive.prob ?? 0 :
+        result.offensive ?? 0,
+      selfharm: result['self-harm'] && typeof result['self-harm'] === 'object' ?
+        result['self-harm'].prob ?? 0 :
+        result['self-harm'] ?? 0,
+      gambling: result.gambling && typeof result.gambling === 'object' ?
+        result.gambling.prob ?? 0 :
+        result.gambling ?? 0,
+      profanity: 0,
+      personalInfo: 0,
+    };
+
+    this.logger.info(`SIGHTENGINE: Analysis complete for ${filePath}`);
+    const logMsg = `SIGHTENGINE: Results - Nudity: ${analysisResult.nudity?.raw ?? 0}, ` +
+      `Violence: ${analysisResult.violence}, Gore: ${analysisResult.gore}, ` +
+      `Weapon: ${analysisResult.weapon}, Alcohol: ${analysisResult.alcohol}, ` +
+      `Drugs: ${analysisResult.drugs}, Offensive: ${analysisResult.offensive}, ` +
+      `Self-harm: ${analysisResult.selfharm}, Gambling: ${analysisResult.gambling}, ` +
+      `Profanity: ${analysisResult.profanity}, Personal Info: ${analysisResult.personalInfo}`;
+    this.logger.info(logMsg);
+
+    return analysisResult;
+  }
+
+  public async analyzeText(text: string): Promise<SightEngineTextResult> {
+    this.logger.info('SIGHTENGINE: Starting text analysis');
+
+    // Skip analysis for empty or very short text
+    if (!text || text.trim().length < 3) {
+      this.logger.info(`SIGHTENGINE: Skipping analysis for empty/short text (length: ${text?.length ?? 0})`);
+      return {
+        sexual: 0,
+        discriminatory: 0,
+        insulting: 0,
+        violent: 0,
+        toxic: 0,
+        selfharm: 0,
+        personalInfo: 0,
+      };
+    }
+
+    const params = new URLSearchParams();
+    params.append('text', text);
+    params.append('models', 'text-content,personal-info');
+    params.append('mode', 'standard');
+    params.append('lang', 'en,es,fr,de,it,pt,nl,pl,ru');
+    params.append('api_user', this.apiUser);
+    params.append('api_secret', this.apiSecret);
+
+    this.logger.info('SIGHTENGINE: Sending text request to API');
+    const startTime = Date.now();
+
+    const response = await fetch('https://api.sightengine.com/1.0/text/check.json', {
+      method: 'POST',
+      headers: {
+        // eslint-disable-next-line @typescript-eslint/naming-convention -- HTTP header name
+        'content-type': 'application/x-www-form-urlencoded',
+      },
+      body: params,
+    });
+
+    const requestTime = Date.now() - startTime;
+    this.logger.info(`SIGHTENGINE: Text API response received in ${requestTime}ms`);
+
+    if (!response.ok) {
+      const errorText = await response.text();
+      this.logger.error(`SIGHTENGINE: Text API error ${response.status} ${errorText}`);
+      throw new Error(`SightEngine Text API error: ${response.status} ${errorText}`);
+    }
+
+    this.logger.info('SIGHTENGINE: Parsing text JSON response');
+    const result = await response.json() as ApiResponse;
+
+    // Log the raw API response for debugging
+    this.logger.debug(`SIGHTENGINE: Raw API response: ${JSON.stringify(result)}`);
+
+    const analysisResult = {
+      sexual: this.getMatchScore(result.profanity?.matches ?? [], 'sexual'),
+      discriminatory: this.getMatchScore(result.profanity?.matches ?? [], 'discriminatory'),
+      insulting: this.getMatchScore(result.profanity?.matches ?? [], 'insulting'),
+      violent: this.getMatchScore(result.profanity?.matches ?? [], 'violent'),
+      toxic: this.getMatchScore(result.profanity?.matches ?? [], 'toxic'),
+      selfharm: this.getMatchScore(result.profanity?.matches ?? [], 'self-harm'),
+      personalInfo: result.personal?.matches && result.personal.matches.length > 0 ? 1 : 0,
+    };
+
+    // If all scores are 0, log a warning
+    let totalScore = 0;
+    for (const score of Object.values(analysisResult)) {
+      totalScore += score;
+    }
+    if (totalScore === 0) {
+      this.logger.warn('SIGHTENGINE: All moderation scores are 0 - this may indicate an API issue');
+    }
+
+    this.logger.info('SIGHTENGINE: Text analysis complete');
+    const logMsg = `SIGHTENGINE: Text Results - Sexual: ${analysisResult.sexual}, ` +
+      `Discriminatory: ${analysisResult.discriminatory}, Insulting: ${analysisResult.insulting}, ` +
+      `Violent: ${analysisResult.violent}, Toxic: ${analysisResult.toxic}, ` +
+      `Self-harm: ${analysisResult.selfharm}, Personal Info: ${analysisResult.personalInfo}`;
+    this.logger.info(logMsg);
+
+    return analysisResult;
+  }
+
+  private getMatchScore(matches: Match[], type: string): number {
+    if (!matches || matches.length === 0) {
+      return 0;
+    }
+
+    const typeMatches = matches.filter((match): boolean => match.type === type);
+    if (typeMatches.length === 0) {
+      return 0;
+    }
+
+    // Convert intensity to score: high=1.0, medium=0.7, low=0.4
+    let maxIntensity = 0;
+    for (const match of typeMatches) {
+      let score: number;
+      if (match.intensity === 'high') {
+        score = 1;
+      } else if (match.intensity === 'medium') {
+        score = 0.7;
+      } else {
+        score = 0.4;
+      }
+      maxIntensity = Math.max(maxIntensity, score);
+    }
+
+    return maxIntensity;
+  }
+
+  public async analyzeVideo(filePath: string): Promise<SightEngineVideoResult> {
+    this.logger.info(`SIGHTENGINE: Starting video analysis for ${filePath}`);
+
+    // eslint-disable-next-line @typescript-eslint/naming-convention -- External module class name
+    const FormData = (await import('form-data')).default;
+
+    this.logger.info(`SIGHTENGINE: Creating form data for video ${filePath}`);
+
+    const form = new FormData();
+    form.append('media', createReadStream(filePath));
+    const models = 'nudity-2.1,violence,gore-2.0,weapon,alcohol,offensive,self-harm,' +
+      'gambling,recreational_drug,tobacco';
+    form.append('models', models);
+    form.append('api_user', this.apiUser);
+    form.append('api_secret', this.apiSecret);
+
+    this.logger.info(`SIGHTENGINE: Sending video request to API for ${filePath}`);
+    const startTime = Date.now();
+
+    const result = await new Promise<ApiResponse>((resolve, reject): void => {
+      form.submit('https://api.sightengine.com/1.0/video/check.json', (err, res): void => {
+        if (err) {
+          reject(err);
+          return;
+        }
+
+        let data = '';
+        res.on('data', (chunk: Buffer): void => {
+          data += chunk.toString();
+        });
+        res.on('end', (): void => {
+          const requestTime = Date.now() - startTime;
+          this.logger.info(`SIGHTENGINE: Video API response received in ${requestTime}ms for ${filePath}`);
+
+          if (res.statusCode !== 200) {
+            this.logger.error(`SIGHTENGINE: Video API error ${res.statusCode} ${data} for ${filePath}`);
+            reject(new Error(`SightEngine Video API error: ${res.statusCode} ${data}`));
+            return;
+          }
+
+          this.logger.info(`SIGHTENGINE: Parsing video JSON response for ${filePath}`);
+          try {
+            resolve(JSON.parse(data) as ApiResponse);
+          } catch (parseErr) {
+            reject(new Error(`Failed to parse response: ${String(parseErr)}`));
+          }
+        });
+      });
+    });
+
+    const analysisResult = {
+      nudity: result.nudity,
+      violence: result.violence && typeof result.violence === 'object' ?
+        result.violence.prob ?? 0 :
+        result.violence ?? 0,
+      gore: result.gore && typeof result.gore === 'object' ?
+        result.gore.prob ?? 0 :
+        result.gore ?? 0,
+      weapon: typeof result.weapon === 'object' && result.weapon ?
+        result.weapon.prob ?? 0 :
+        result.weapon ?? 0,
+      alcohol: result.alcohol && typeof result.alcohol === 'object' ?
+        result.alcohol.prob ?? 0 :
+        result.alcohol ?? 0,
+      offensive: result.offensive && typeof result.offensive === 'object' ?
+        result.offensive.prob ?? 0 :
+        result.offensive ?? 0,
+      selfharm: result['self-harm'] && typeof result['self-harm'] === 'object' ?
+        result['self-harm'].prob ?? 0 :
+        result['self-harm'] ?? 0,
+      gambling: result.gambling && typeof result.gambling === 'object' ?
+        result.gambling.prob ?? 0 :
+        result.gambling ?? 0,
+      drugs: result.recreational_drug && typeof result.recreational_drug === 'object' ?
+        result.recreational_drug.prob ?? 0 :
+        result.recreational_drug ?? 0,
+      tobacco: result.tobacco && typeof result.tobacco === 'object' ?
+        result.tobacco.prob ?? 0 :
+        result.tobacco ?? 0,
+    };
+
+    this.logger.info(`SIGHTENGINE: Video analysis complete for ${filePath}`);
+    const logMsg = `SIGHTENGINE: Video Results - Nudity: ${analysisResult.nudity?.raw ?? 0}, ` +
+      `Violence: ${analysisResult.violence}, Gore: ${analysisResult.gore}, ` +
+      `Weapon: ${analysisResult.weapon}, Alcohol: ${analysisResult.alcohol}, ` +
+      `Offensive: ${analysisResult.offensive}, Self-harm: ${analysisResult.selfharm}, ` +
+      `Gambling: ${analysisResult.gambling}, Drugs: ${analysisResult.drugs}, ` +
+      `Tobacco: ${analysisResult.tobacco}`;
+    this.logger.info(logMsg);
+
+    return analysisResult;
+  }
+}

package/src/util/GuardedStream.ts

@@ -0,0 +1,101 @@
+import { getLoggerFor } from '@solid/community-server';
+
+const logger = getLoggerFor('GuardedStream');
+
+// Using symbols to make sure we don't override existing parameters
+const guardedErrors = Symbol('guardedErrors');
+const guardedTimeout = Symbol('guardedTimeout');
+
+// Private fields for guarded streams
+class Guard {
+  // Workaround for the fact that we don't initialize this variable as expected
+  declare private [guardedErrors]: Error[];
+  private [guardedTimeout]?: NodeJS.Timeout;
+}
+
+/**
+ * A stream that is guarded from emitting errors when there are no listeners.
+ * If an error occurs while no listener is attached,
+ * it will store the error and emit it once a listener is added (or a timeout occurs).
+ */
+export type Guarded<T extends NodeJS.EventEmitter = NodeJS.EventEmitter> = T & Guard;
+
+/**
+ * Determines whether the stream is guarded against emitting errors.
+ */
+export function isGuarded<T extends NodeJS.EventEmitter>(stream: T): stream is Guarded<T> {
+  return typeof (stream as unknown as Guarded)[guardedErrors] === 'object';
+}
+
+/**
+ * Callback that is used when a stream emits an error and no other error listener is attached.
+ * Used to store the error and start the logger timer.
+ *
+ * It is important that this listener always remains attached for edge cases where an error listener gets removed
+ * and the number of error listeners is checked immediately afterwards.
+ * See https://github.com/CommunitySolidServer/CommunitySolidServer/pull/462#issuecomment-758013492 .
+ */
+function guardingErrorListener(this: Guarded, error: Error): void {
+  // Only fall back to this if no new listeners are attached since guarding started.
+  const errorListeners = this.listeners('error');
+  if (errorListeners.at(-1) === guardingErrorListener) {
+    this[guardedErrors].push(error);
+    if (!this[guardedTimeout]) {
+      this[guardedTimeout] = setTimeout((): void => {
+        logger.error(`No error listener was attached but error was thrown: ${error.message}`);
+      }, 1000);
+    }
+  }
+}
+
+/**
+ * Callback that is used when a new listener is attached and there are errors that were not emitted yet.
+ */
+function emitStoredErrors(this: Guarded, event: string, func: (error: Error) => void): void {
+  if (event === 'error' && func !== guardingErrorListener) {
+    // Cancel an error timeout
+    if (this[guardedTimeout]) {
+      clearTimeout(this[guardedTimeout]);
+      this[guardedTimeout] = undefined;
+    }
+
+    // Emit any errors that were guarded
+    const errors = this[guardedErrors];
+    if (errors.length > 0) {
+      this[guardedErrors] = [];
+      setImmediate((): void => {
+        for (const error of errors) {
+          this.emit('error', error);
+        }
+      });
+    }
+  }
+}
+
+/**
+ * Makes sure that listeners always receive the error event of a stream,
+ * even if it was thrown before the listener was attached.
+ *
+ * When guarding a stream it is assumed that error listeners already attached should be ignored,
+ * only error listeners attached after the stream is guarded will prevent an error from being logged.
+ *
+ * If the input is already guarded the guard will be reset,
+ * which means ignoring error listeners already attached.
+ *
+ * @param stream - Stream that can potentially throw an error.
+ *
+ * @returns The stream.
+ */
+export function guardStream<T extends NodeJS.EventEmitter>(stream: T): Guarded<T> {
+  const guarded = stream as Guarded<T>;
+  if (isGuarded(stream)) {
+    // This makes sure the guarding error listener is the last one in the list again
+    guarded.removeListener('error', guardingErrorListener);
+    guarded.on('error', guardingErrorListener);
+  } else {
+    guarded[guardedErrors] = [];
+    guarded.on('error', guardingErrorListener);
+    guarded.on('newListener', emitStoredErrors);
+  }
+  return guarded;
+}

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "lib": ["ES2021"],
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "test"]
+}