thelounge-plugin-janitor 1.0.0

package/.github/workflows/build.yml.disabled

@@ -0,0 +1,28 @@
+name: Build package
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18.20.8
+
+      - name: Install dependencies
+        run: npm ci
+
+      # - name: Lint
+      #   run: npm run lint --if-present
+
+      # - name: Test
+      #   run: npm test --if-present
+
+      # - name: Build
+      #   run: npm run build --if-present

package/.github/workflows/publish.yml

@@ -0,0 +1,36 @@
+name: Publish to npm
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18.20.8
+          registry-url: https://registry.npmjs.org
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build --if-present
+
+      - name: Test
+        run: npm test --if-present
+
+      - name: Publish to npm
+        run: npm publish --provenance --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/README.md

@@ -0,0 +1,33 @@
+# The Lounge Janitor Plugin
+
+![NPM Version](https://img.shields.io/npm/v/thelounge-plugin-janitor?style=for-the-badge)
+![NPM Downloads](https://img.shields.io/npm/dy/thelounge-plugin-janitor?style=for-the-badge)
+
+A plugin for [The Lounge](https://thelounge.chat/) that cleans up old uploads
+
+## Installation
+
+Via the `thelounge` command line:
+
+```bash
+thelounge install thelounge-plugin-janitor
+```
+
+Add a `deleteUploadsAfter` entry in the `config.js` of your instance representing how long uploads stay on the server before getting deleted in minutes:
+
+```js
+"use strict";
+module.exports = {
+  deleteUploadsAfter: 1440, // 1 day in minutes
+  // rest of config...
+```
+
+Restart The Lounge after installation
+
+## Usage
+
+The plugin runs every minute in the background, users do not need to do anything.
+
+## License
+
+This plugin is licensed under [MIT](https://opensource.org/license/mit)

package/index.js

@@ -0,0 +1,91 @@
+"use strict";
+
+const path = require("path");
+const fs = require("fs");
+
+let logger;
+
+function deleteOldUploads(dir, maxAgeMinutes) {
+  if (!fs.existsSync(dir)) {
+    return;
+  }
+
+  const now = Date.now();
+  const maxAgeMs = maxAgeMinutes * 60 * 1000;
+  let count = 0;
+
+  // Uploads are stored in subdirectories named by the upload ID, so we need to read those first
+  const uploadDirs = fs
+    .readdirSync(dir, { withFileTypes: true })
+    .filter((d) => d.isDirectory());
+
+  for (const uploadDir of uploadDirs) {
+    const uploadPath = path.join(dir, uploadDir.name);
+    const files = fs.readdirSync(uploadPath);
+
+    for (const file of files) {
+      const filePath = path.join(uploadPath, file);
+      const stats = fs.statSync(filePath);
+      const ageMs = now - stats.mtimeMs;
+
+      if (ageMs > maxAgeMs) {
+        try {
+          fs.unlinkSync(filePath);
+          count++;
+          logger.debug(`Deleted ${filePath} (age: ${ageMs} ms)`);
+        } catch (err) {
+          logger.error(`Failed to delete ${filePath}: ${err.message}`);
+        }
+      }
+    }
+
+    // If the upload directory is empty after deleting old files, remove it
+    if (fs.readdirSync(uploadPath).length === 0) {
+      try {
+        fs.rmdirSync(uploadPath);
+        logger.debug(`Deleted empty upload directory: ${uploadPath}`);
+      } catch (err) {
+        logger.error(
+          `Failed to delete directory ${uploadPath}: ${err.message}`,
+        );
+      }
+    }
+  }
+
+  if (count > 0) {
+    logger.info(`Deleted ${count} upload${count > 1 ? "s" : ""}`);
+  }
+}
+
+module.exports = {
+  onServerStart(tl) {
+    logger = tl.Logger;
+    const config = tl.Config.getConfig();
+
+    if (config.deleteUploadsAfter && config.deleteUploadsAfter > 0) {
+      const tlDir = process.env.THELOUNGE_HOME;
+
+      if (!tlDir) {
+        logger.error(
+          "THELOUNGE_HOME environment variable is not set, cannot determine uploads directory",
+        );
+        return;
+      }
+
+      const uploadsDir = path.join(tlDir, "uploads");
+
+      logger.info(
+        `Watching ${uploadsDir} to delete uploads older than ${config.deleteUploadsAfter} minutes`,
+      );
+
+      // Run the janitor every 1 minute
+      setInterval(() => {
+        deleteOldUploads(uploadsDir, config.deleteUploadsAfter);
+      }, 60 * 1000);
+    } else {
+      logger.warn(
+        "deleteUploadsAfter is not set or is not greater than 0, janitor will not run",
+      );
+    }
+  },
+};

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "thelounge-plugin-janitor",
+  "version": "1.0.0",
+  "description": "A plugin for The Lounge that cleans up old uploads",
+  "keywords": [
+    "thelounge",
+    "thelounge-plugin"
+  ],
+  "thelounge": {
+    "name": "janitor",
+    "type": "plugin",
+    "supports": ">=4.0.0"
+  },
+  "homepage": "https://github.com/cy1der/thelounge-plugin-janitor#readme",
+  "bugs": {
+    "url": "https://github.com/cy1der/thelounge-plugin-janitor/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cy1der/thelounge-plugin-janitor.git"
+  },
+  "license": "MIT",
+  "author": "cy1der",
+  "type": "commonjs",
+  "main": "index.js",
+  "dependencies": {
+    "thelounge": "^4.4.3"
+  }
+}