nodebb-plugin-openai 1.4.3 → 2.0.0

package/languages/en-GB/openai.json

@@ -2,6 +2,7 @@
 	"error.need-x-reputation-to-mention": "You need at least %1 reputation for mentioning chatgpt",
 	"summarize-topic": "Summarize Topic",
 	"topic-summary": "Topic Summary",
+	"summary-cooldown-error": "You must wait before summarizing a topic again.",
 
 	"admin.general": "General",
 	"admin.apikey": "API Key",

package/languages/en-US/openai.json

@@ -2,6 +2,7 @@
 	"error.need-x-reputation-to-mention": "You need at least %1 reputation for mentioning chatgpt",
 	"summarize-topic": "Summarize Topic",
 	"topic-summary": "Topic Summary",
+	"summary-cooldown-error": "You must wait before summarizing a topic again.",
 
 	"admin.general": "General",
 	"admin.apikey": "API Key",

package/languages/he/openai.json

@@ -2,6 +2,7 @@
 	"error.need-x-reputation-to-mention": "דרושה לך מוניטין של %1 לפחות כדי לאזכר את chatgpt",
 	"summarize-topic": "סכם נושא",
 	"topic-summary": "סיכום הנושא",
+	"summary-cooldown-error": "עליך להמתין לפני שתסכם את הנושא שוב.",
 
 	"admin.general": "כללי",
 	"admin.apikey": "מפתח API",

package/languages/zh-CN/openai.json

@@ -1,5 +1,6 @@
 {
 	"error.need-x-reputation-to-mention": "提及 chatgpt 至少需要 %1 声望值",
 	"summarize-topic": "总结主题",
-	"topic-summary": "主题摘要"
+	"topic-summary": "主题摘要",
+	"summary-cooldown-error": "在再次总结主题之前，您必须等待。"
 }

package/lib/controllers.js

@@ -1,14 +1,57 @@
 'use strict';
 
-const groups = require.main.require('./src/groups');
+const groups = nodebb.require('./src/groups');
 
 const Controllers = module.exports;
 
 Controllers.renderAdminPage = async function (req, res/* , next */) {
 	const groupsData = await groups.getNonPrivilegeGroups('groups:createtime', 0, -1);
 	groupsData.sort((a, b) => b.system - a.system);
+	// Uncomment the following lines to list available models
+	// const list = await openai.models.list();
+	// for await (const model of list) {
+	// console.log(model.id);
+	// }
+
 	res.render('admin/plugins/openai', {
 		title: 'OpenAI',
 		groups: groupsData,
+		models: [
+			{ id: 'gpt-3.5-turbo' },
+			{ id: 'gpt-4' },
+			{ id: 'gpt-4-turbo' },
+			{ id: 'gpt-4.1' },
+			{ id: 'gpt-4.1-mini' },
+			{ id: 'gpt-4.1-nano' },
+			{ id: 'gpt-4o' },
+			{ id: 'gpt-4o-mini' },
+			{ id: 'gpt-5-codex' },
+			{ id: 'gpt-5-mini' },
+			{ id: 'gpt-5-nano' },
+			{ id: 'gpt-5-pro' },
+			{ id: 'gpt-5.1' },
+			{ id: 'gpt-5.1-codex' },
+			{ id: 'gpt-5.1-codex-max' },
+			{ id: 'gpt-5.1-codex-mini' },
+			{ id: 'gpt-5.2' },
+			{ id: 'gpt-5.2-codex' },
+			{ id: 'gpt-5.2-pro' },
+			{ id: 'gpt-5.3-codex' },
+			{ id: 'gpt-5.4' },
+			{ id: 'gpt-5.4-mini' },
+			{ id: 'gpt-5.4-nano' },
+			{ id: 'gpt-5.4-pro' },
+			{ id: 'gpt-5.5' },
+			{ id: 'gpt-5.5-pro' },
+			{ id: 'gpt-5.6-luna' },
+			{ id: 'gpt-5.6-sol' },
+			{ id: 'gpt-5.6-terra' },
+			{ id: 'gpt-5.6' },
+			{ id: 'gpt-6-astra' },
+			{ id: 'gpt-6-luna' },
+			{ id: 'gpt-6-sol' },
+			{ id: 'gpt-6.1-sol' },
+			{ id: 'gemini-2.0-flash' },
+		],
 	});
 };

package/lib/summary.js

@@ -1,10 +1,10 @@
 'use strict';
 
-const db = require.main.require('./src/database');
-const batch = require.main.require('./src/batch');
-const topics = require.main.require('./src/topics');
-const posts = require.main.require('./src/posts');
-const user = require.main.require('./src/user');
+const db = nodebb.require('./src/database');
+const batch = nodebb.require('./src/batch');
+const topics = nodebb.require('./src/topics');
+const posts = nodebb.require('./src/posts');
+const user = nodebb.require('./src/user');
 
 function formatPosts(posts) {
 	return posts

package/library.js

@@ -4,21 +4,28 @@ const { OpenAI } = require('openai');
 
 let openai;
 
-const db = require.main.require('./src/database');
-const meta = require.main.require('./src/meta');
+const db = nodebb.require('./src/database');
+const meta = nodebb.require('./src/meta');
 const controllers = require('./lib/controllers');
-const routeHelpers = require.main.require('./src/routes/helpers');
-const socketHelpers = require.main.require('./src/socket.io/helpers');
-const topics = require.main.require('./src/topics');
-const user = require.main.require('./src/user');
-const messaging = require.main.require('./src/messaging');
-const api = require.main.require('./src/api');
-const privileges = require.main.require('./src/privileges');
-const groups = require.main.require('./src/groups');
-const sockets = require.main.require('./src/socket.io');
-const socketPlugins = require.main.require('./src/socket.io/plugins');
 const summary = require('./lib/summary');
 
+const routeHelpers = nodebb.require('./src/routes/helpers');
+const socketHelpers = nodebb.require('./src/socket.io/helpers');
+const topics = nodebb.require('./src/topics');
+const user = nodebb.require('./src/user');
+const messaging = nodebb.require('./src/messaging');
+const api = nodebb.require('./src/api');
+const privileges = nodebb.require('./src/privileges');
+const groups = nodebb.require('./src/groups');
+const sockets = nodebb.require('./src/socket.io');
+const socketPlugins = nodebb.require('./src/socket.io/plugins');
+const cacheCreate = nodebb.require('./src/cache/lru');
+
+const summaryCache = cacheCreate({
+	name: 'openai-summary',
+	max: 200,
+});
+
 const plugin = module.exports;
 
 const defaults = {
@@ -26,7 +33,7 @@ const defaults = {
 	'chatgpt-username': '',
 	enablePrivateMessages: 'off',
 	model: 'gpt-3.5-turbo',
-	minimumReputation: 0,
+	minimumReputation: 2,
 	allowedGroups: '[]',
 	systemPrompt: 'You are a helpful assistant',
 };
@@ -41,12 +48,6 @@ plugin.init = async (params) => {
 			baseURL: settings.apiBaseUrl || 'https://api.openai.com/v1',
 		});
 
-		// Uncomment the following lines to list available models
-		// const list = await openai.models.list();
-		// for await (const model of list) {
-		// console.log(model.id);
-		// }
-
 		plugin.openai = openai;
 	}
 
@@ -330,16 +331,22 @@ socketPlugins.openai.summarizeTopic = async function (socket, data) {
 	if (!await privileges.topics.can('topics:read', tid, socket.uid)) {
 		throw new Error('[[error:no-privileges]]');
 	}
-	const settings = await getSettings();
-	if (!await canUseOpenAI(socket.uid, settings)) {
-		return;
-	}
 
 	let openaiSummary = await topics.getTopicField(tid, 'openai:summary');
 	if (openaiSummary) {
 		return openaiSummary;
 	}
+	const settings = await getSettings();
+	if (!await canUseOpenAI(socket.uid, settings)) {
+		return;
+	}
+	const cooldown = summaryCache.get(`uid:${socket.uid}`);
+	if (cooldown) {
+		throw new Error('[[openai:summary-cooldown-error]]');
+	}
+
 	openaiSummary = await summary.summarizeTopic(tid, openai, settings);
+	summaryCache.set(`uid:${socket.uid}`, 1, 60000);
 	await topics.setTopicField(tid, 'openai:summary', openaiSummary);
 	return openaiSummary;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodebb-plugin-openai",
-  "version": "1.4.3",
+  "version": "2.0.0",
   "description": "A NodeBB OpenAI plugin",
   "main": "library.js",
   "repository": {
@@ -33,7 +33,7 @@
   },
   "readmeFilename": "README.md",
   "nbbpm": {
-    "compatibility": "^3.2.0 || ^4.0.0"
+    "compatibility": "4.15.0"
   },
   "dependencies": {
     "openai": "4.103.0"
@@ -41,7 +41,7 @@
   "devDependencies": {
     "@commitlint/cli": "19.3.0",
     "@commitlint/config-angular": "19.3.0",
-    "eslint": "10.5.0",
+    "eslint": "10.11.0",
     "eslint-config-nodebb": "^2.0.3",
     "husky": "9.0.11",
     "lint-staged": "15.2.7"

package/public/lib/main.js

@@ -12,30 +12,30 @@ $('document').ready(function () {
 		$('.openai-summarize-topic').on('click', summarizeTopic);
 	});
 
-	function summarizeTopic() {
+	async function summarizeTopic() {
 		const tid = ajaxify.data.tid;
-		require(['bootbox'], function (bootbox) {
-			const modal = bootbox.dialog({
-				title: '[[openai:topic-summary]]',
-				message: `<div class="openai-summarize-topic"><div class="loading text-center"><i class="fa-solid fa-spinner fa-spin fa-2x"></i></div></div>`,
-				size: 'large',
-				buttons: {
-					ok: {
-						label: '[[global:ok]]',
-						className: 'btn-primary',
-					},
+		const modals = await app.require('modals');
+
+		const modal = await modals.dialog({
+			title: '[[openai:topic-summary]]',
+			message: `<div class="openai-summarize-topic"><div class="loading text-center"><i class="fa-solid fa-spinner fa-spin fa-2x"></i></div></div>`,
+			size: 'large',
+			buttons: {
+				ok: {
+					label: '[[modules:bootbox.ok]]',
+					className: 'btn-primary',
 				},
-			});
-			socket.emit('plugins.openai.summarizeTopic', { tid }, function (err, data) {
-				if (err) {
-					return alertType('error', err.message);
-				}
-				if (data) {
-					modal.find('.openai-summarize-topic').text(data);
-				} else {
-					modal.modal('hide');
-				}
-			});
+			},
+		});
+		socket.emit('plugins.openai.summarizeTopic', { tid }, function (err, data) {
+			if (err) {
+				return alertType('error', err.message);
+			}
+			if (data) {
+				modal.find('.openai-summarize-topic').text(data);
+			} else {
+				modal.modal('hide');
+			}
 		});
 	}
 });

package/templates/admin/plugins/openai.tpl

@@ -5,78 +5,73 @@
 		<div id="spy-container" class="col-12 col-md-8 px-0 mb-4" tabindex="0">
 			<form role="form" class="openai-settings">
 				<div class="mb-4">
-					<h5 class="fw-bold tracking-tight settings-header">[[openai:admin.general]]</h5>
+					<h5 class="fw-bold tracking-tight settings-header">{{tx("openai:admin.general")}}</h5>
 
 					<div class="mb-3">
-						<label class="form-label" for="apikey">[[openai:admin.apikey]]</label>
+						<label class="form-label" for="apikey">{{tx("openai:admin.apikey")}}</label>
 						<input type="text" id="apikey" name="apikey" title="[[openai:admin.apikey]]" class="form-control">
 						<p class="form-text">
-							[[openai:admin.apikey-help]]
+							{{tx("openai:admin.apikey-help")}}
 						</p>
 					</div>
 
 					<div class="mb-3">
-						<label class="form-label" for="apiBaseUrl">[[openai:admin.api-base-url]]</label>
+						<label class="form-label" for="apiBaseUrl">{{tx("openai:admin.api-base-url")}}</label>
 						<input type="text" id="apiBaseUrl" name="apiBaseUrl" title="[[openai:admin.api-base-url]]" class="form-control">
 						<p class="form-text">
-							[[openai:admin.api-base-url-help]]
+							{{tx("openai:admin.api-base-url-help")}}
 						</p>
 					</div>
 
 					<div class="mb-3">
-						<label class="form-label" for="chatgpt-username">[[openai:admin.chatgpt-username]]</label>
+						<label class="form-label" for="chatgpt-username">{{tx("openai:admin.chatgpt-username")}}</label>
 						<input type="text" id="chatgpt-username" name="chatgpt-username" title="[[openai:admin.chatgpt-username]]" class="form-control">
 						<p class="form-text">
-							[[openai:admin.chatgpt-username-help, {config.relative_path}]]
+							{{tx("openai:admin.chatgpt-username-help", config.relative_path)}}
 						</p>
 					</div>
 
 					<div class="form-check form-switch">
 						<input type="checkbox" class="form-check-input" id="enablePrivateMessages" name="enablePrivateMessages">
-						<label for="enablePrivateMessages" class="form-check-label">[[openai:admin.enable-private-messages]]</label>
+						<label for="enablePrivateMessages" class="form-check-label">{{tx("openai:admin.enable-private-messages")}}</label>
 						<p class="form-text">
-							[[openai:admin.enable-private-messages-help]]
+							{{tx("openai:admin.enable-private-messages-help")}}
 						</p>
 					</div>
 
 					<div class="mb-3">
-						<label class="form-label" for="model">[[openai:admin.model]]</label>
+						<label class="form-label" for="model">{{tx("openai:admin.model")}}</label>
 						<select class="form-select" id="model" name="model" title="[[openai:admin.model]]">
-							<option value="gpt-3.5-turbo">gpt-3.5-turbo</option>
-							<option value="gpt-4o-mini">gpt-4o-mini</option>
-							<option value="gpt-4o">gpt-4o</option>
-							<option value="gpt-4-turbo">gpt-4-turbo</option>
-							<option value="gpt-4">gpt-4</option>
-							<option value="gpt-4.1-mini">gpt-4.1-mini</option>
-							<option value="gpt-4.1">gpt-4.1</option>
-							<option value="gemini-2.0-flash">gemini-2.0-flash</option>
+							{{{ each models }}}
+							<option value="{./id}">{./id}</option>
+							{{{ end }}}
 						</select>
 					</div>
 					<div class="">
-						<label class="form-label" for="systemPrompt">[[openai:admin.system-prompt]]</label>
-						<textarea class="form-control" id="systemPrompt" name="systemPrompt" title="[[openai:admin.system-prompt]]" placeholder="[[openai:admin.system-prompt-placeholder]]" rows="8"></textarea>
+						<label class="form-label" for="systemPrompt">{{tx("openai:admin.system-prompt")}}</label>
+						<textarea class="form-control" id="systemPrompt" name="systemPrompt" title="{{tx("openai:admin.system-prompt")}}" placeholder="{{tx("openai:admin.system-prompt-placeholder")}}" rows="8"></textarea>
 					</div>
 				</div>
 
 				<div class="">
-					<h5 class="fw-bold tracking-tight settings-header">[[openai:admin.restrictions]]</h5>
+					<h5 class="fw-bold tracking-tight settings-header">{{tx("openai:admin.restrictions")}}</h5>
 
 					<div class="mb-3">
-						<label class="form-label" for="minimumReputation">[[openai:admin.minimum-reputation]]</label>
+						<label class="form-label" for="minimumReputation">{{tx("openai:admin.minimum-reputation")}}</label>
 						<input type="text" id="minimumReputation" name="minimumReputation" title="[[openai:admin.minimum-reputation]]" class="form-control">
 						<p class="form-text">
-							[[openai:admin.minimum-reputation-help]]
+							{{tx("openai:admin.minimum-reputation-help")}}
 						</p>
 					</div>
 					<div class="mb-3">
-						<label class="form-label" form="allowedGroups">[[openai:admin.allowed-groups]]</label>
+						<label class="form-label" form="allowedGroups">{{tx("openai:admin.allowed-groups")}}</label>
 						<select class="form-select" multiple id="allowedGroups" name="allowedGroups" size="10">
 							{{{ each groups }}}
 							<option value="{./displayName}">{./displayName}</option>
 							{{{ end }}}
 						</select>
 						<p class="form-text">
-							[[openai:admin.allowed-groups-help]]
+							{{tx("openai:admin.allowed-groups-help")}}
 						</p>
 					</div>
 				</div>