nodebb-plugin-discord-onekite 1.0.0

package/README.md

@@ -0,0 +1,20 @@
+# nodebb-plugin-discord-onekite (NodeBB v4.x)
+
+Plugin NodeBB qui notifie un salon Discord via **webhook** lors :
+- des **nouveaux sujets**
+- et optionnellement des **réponses**
+
+## Installation (local)
+Depuis le dossier NodeBB :
+
+```bash
+npm install /chemin/vers/nodebb-plugin-discord-onekite
+./nodebb build
+./nodebb restart
+```
+
+## Configuration
+ACP → Plugins → **Discord Onekite**
+- Webhook URL
+- (option) Notifier les réponses
+- Catégories à notifier (si aucune sélection : toutes)

package/lib/controllers.js

@@ -0,0 +1,9 @@
+'use strict';
+
+const controllers = {};
+
+controllers.renderAdminPage = async function (req, res) {
+  res.render('admin/plugins/discord-onekite', {});
+};
+
+module.exports = controllers;

package/library.js

@@ -0,0 +1,169 @@
+'use strict';
+
+const { request } = require('undici');
+
+const routeHelpers = require.main.require('./src/routes/helpers');
+const meta = require.main.require('./src/meta');
+
+const topics = require.main.require('./src/topics');
+const user = require.main.require('./src/user');
+
+const controllers = require('./lib/controllers');
+
+// Settings are stored under this key in NodeBB's settings system
+const SETTINGS_KEY = 'discord-onekite';
+
+function normalizeCids(value) {
+  if (!value) return [];
+  if (Array.isArray(value)) return value.map(v => String(v)).filter(Boolean);
+
+  // Sometimes saved as "1,2,3"
+  if (typeof value === 'string') {
+    return value
+      .split(',')
+      .map(s => s.trim())
+      .filter(Boolean);
+  }
+  return [];
+}
+
+async function getSettings() {
+  const s = await meta.settings.get(SETTINGS_KEY);
+  return {
+    webhookUrl: (s && s.webhookUrl) ? String(s.webhookUrl).trim() : '',
+    notifyReplies: !!(s && (s.notifyReplies === true || s.notifyReplies === 'on' || s.notifyReplies === 'true')),
+    cids: normalizeCids(s && s.cids),
+  };
+}
+
+function cidAllowed(topicCid, allowedCids) {
+  // IMPORTANT (per request): if no categories are selected => notify ALL categories.
+  if (!allowedCids || allowedCids.length === 0) return true;
+  return allowedCids.includes(String(topicCid));
+}
+
+async function postToDiscord(webhookUrl, payload) {
+  if (!webhookUrl) return;
+
+  const res = await request(webhookUrl, {
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json' },
+    body: JSON.stringify(payload),
+  });
+
+  // Discord webhook success is commonly 204 No Content
+  if (res.statusCode < 200 || res.statusCode >= 300) {
+    const text = await res.body.text().catch(() => '');
+    throw new Error(`[discord-onekite] Discord webhook HTTP ${res.statusCode}: ${text}`);
+  }
+}
+
+async function buildTopicEmbed({ tid, pid, type }) {
+  const baseUrl = meta.config.url;
+
+  // For v4.x, these fields are stable and enough for URL + title
+  const topicData = await topics.getTopicFields(tid, ['tid', 'uid', 'cid', 'title', 'slug', 'timestamp', 'mainPid']);
+  if (!topicData) return null;
+
+  const topicUrl = `${baseUrl}/topic/${topicData.slug || topicData.tid}`;
+
+  // Author (topic author). If you prefer reply author, adjust to read post author.
+  const u = await user.getUserFields(topicData.uid, ['username', 'picture']);
+
+  const isReply = type === 'reply';
+  const embed = {
+    title: topicData.title || (isReply ? 'Nouvelle réponse' : 'Nouveau sujet'),
+    url: isReply && pid ? `${topicUrl}/${pid}` : topicUrl,
+    timestamp: new Date(isReply ? Date.now() : (topicData.timestamp || Date.now())).toISOString(),
+    author: u?.username ? { name: u.username, icon_url: u.picture || undefined } : undefined,
+    footer: { text: 'NodeBB → Discord (Onekite)' },
+  };
+
+  if (isReply) {
+    embed.description = 'Nouvelle réponse dans un sujet.';
+  }
+
+  return { topicData, embed };
+}
+
+const Plugin = {};
+
+// Mount ACP page route (NodeBB v4.x)
+Plugin.init = async ({ router }) => {
+  routeHelpers.setupAdminPageRoute(
+    router,
+    '/admin/plugins/discord-onekite',
+    [],
+    controllers.renderAdminPage
+  );
+};
+
+// Add entry under ACP -> Plugins
+Plugin.addAdminNavigation = (header) => {
+  header.plugins.push({
+    route: '/plugins/discord-onekite',
+    icon: 'fa-bell',
+    name: 'Discord Onekite',
+  });
+  return header;
+};
+
+// NEW TOPICS ONLY (unless notifyReplies enabled for posts)
+Plugin.onTopicSave = async (data) => {
+  try {
+    const { webhookUrl, cids } = await getSettings();
+    if (!webhookUrl) return;
+
+    const tid = data?.tid || data?.topic?.tid;
+    if (!tid) return;
+
+    // In v4.x, new topics often expose isNew; as a fallback, we detect postcount=1 if present.
+    const isNew =
+      data?.isNew === true ||
+      data?.topic?.isNew === true ||
+      (typeof data?.topic?.postcount === 'number' && data.topic.postcount === 1);
+
+    if (!isNew) return;
+
+    const built = await buildTopicEmbed({ tid, type: 'topic' });
+    if (!built) return;
+
+    if (!cidAllowed(built.topicData.cid, cids)) return;
+
+    await postToDiscord(webhookUrl, { embeds: [built.embed] });
+  } catch (err) {
+    // eslint-disable-next-line no-console
+    console.error(err);
+  }
+};
+
+// REPLIES (optional)
+Plugin.onPostSave = async (data) => {
+  try {
+    const { webhookUrl, notifyReplies, cids } = await getSettings();
+    if (!webhookUrl || !notifyReplies) return;
+
+    const pid = data?.pid || data?.post?.pid;
+    const tid = data?.tid || data?.post?.tid;
+    if (!pid || !tid) return;
+
+    // Only new posts (avoid edits). v4.x commonly provides isNew for creates.
+    const isNew = data?.isNew === true || data?.post?.isNew === true;
+    if (!isNew) return;
+
+    const built = await buildTopicEmbed({ tid, pid, type: 'reply' });
+    if (!built) return;
+
+    // Avoid notifying the main post (already covered by topic.save)
+    if (built.topicData?.mainPid && String(built.topicData.mainPid) === String(pid)) return;
+
+    if (!cidAllowed(built.topicData.cid, cids)) return;
+
+    await postToDiscord(webhookUrl, { embeds: [built.embed] });
+  } catch (err) {
+    // eslint-disable-next-line no-console
+    console.error(err);
+  }
+};
+
+module.exports = Plugin;

package/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "nodebb-plugin-discord-onekite",
+  "version": "1.0.0",
+  "description": "Discord webhook notifier for Onekite (NodeBB v4.x only)",
+  "main": "library.js",
+  "license": "MIT",
+  "keywords": ["nodebb", "plugin", "discord", "webhook", "notifications"],
+  "dependencies": {
+    "undici": "^6.0.0"
+  },
+  "nbbpm": {
+    "compatibility": "^4.0.0"
+  }
+}

package/plugin.json

@@ -0,0 +1,14 @@
+{
+  "id": "nodebb-plugin-discord-onekite",
+  "name": "Discord Onekite Notifier",
+  "description": "Notifie Discord via webhook pour nouveaux sujets et/ou réponses, filtrable par catégories (NodeBB v4.x uniquement).",
+  "library": "./library.js",
+  "hooks": [
+    { "hook": "static:app.load", "method": "init" },
+    { "hook": "filter:admin.header.build", "method": "addAdminNavigation" },
+    { "hook": "action:topic.save", "method": "onTopicSave" },
+    { "hook": "action:post.save", "method": "onPostSave" }
+  ],
+  "templates": "static/templates",
+  "acpScripts": ["static/lib/admin.js"]
+}

package/static/lib/admin.js

@@ -0,0 +1,45 @@
+'use strict';
+
+/* global $, app */
+
+define('admin/plugins/discord-onekite', ['settings', 'api'], function (settings, api) {
+  const ACP = {};
+
+  ACP.init = async function () {
+    // Charge settings existants (webhookUrl, notifyReplies, cids)
+    settings.load('discord-onekite', $('.discord-onekite-settings'));
+
+    // Charge les catégories via l'API NodeBB (client api module ajoute /api) 
+    try {
+      const res = await api.get('/categories');
+      const categories = (res && res.categories) ? res.categories : [];
+
+      const $select = $('#cids');
+      $select.empty();
+
+      categories
+        .filter(c => c && typeof c.cid !== 'undefined' && c.name)
+        .forEach(c => {
+          $('<option />')
+            .val(String(c.cid))
+            .text(c.name)
+            .appendTo($select);
+        });
+
+      // Recharge settings pour re-sélectionner les catégories déjà sauvegardées
+      settings.load('discord-onekite', $('.discord-onekite-settings'));
+    } catch (e) {
+      // eslint-disable-next-line no-console
+      console.error('[discord-onekite] Could not load categories', e);
+      app.alertError('Impossible de charger la liste des catégories.');
+    }
+
+    $('#save').on('click', function () {
+      settings.save('discord-onekite', $('.discord-onekite-settings'), function () {
+        app.alertSuccess('Paramètres enregistrés !');
+      });
+    });
+  };
+
+  return ACP;
+});

package/static/templates/admin/plugins/discord-onekite.tpl

@@ -0,0 +1,33 @@
+<div class="acp-page-container">
+  <h4>Discord Onekite</h4>
+  <p class="text-muted">
+    Envoie une notification dans Discord via webhook, avec filtres par catégories.
+  </p>
+
+  <form role="form" class="discord-onekite-settings">
+    <div class="mb-3">
+      <label class="form-label" for="webhookUrl">Discord Webhook URL</label>
+      <input type="text" class="form-control" id="webhookUrl" name="webhookUrl" placeholder="https://discord.com/api/webhooks/..." />
+      <p class="form-text text-muted">
+        Discord → Salon #notifications → Intégrations → Webhooks → Copier l’URL.
+      </p>
+    </div>
+
+    <div class="form-check mb-3">
+      <input class="form-check-input" type="checkbox" id="notifyReplies" name="notifyReplies">
+      <label class="form-check-label" for="notifyReplies">
+        Notifier aussi les réponses (si décoché : uniquement les nouveaux sujets)
+      </label>
+    </div>
+
+    <div class="mb-3">
+      <label class="form-label" for="cids">Catégories à notifier</label>
+      <select class="form-select" id="cids" name="cids" multiple size="12"></select>
+      <p class="form-text text-muted">
+        Si aucune catégorie n’est sélectionnée : <strong>toutes les catégories</strong> seront notifiées.
+      </p>
+    </div>
+
+    <!-- IMPORT admin/partials/save_button.tpl -->
+  </form>
+</div>