nodebb-plugin-openai 1.0.0

package/.eslintrc

@@ -0,0 +1,3 @@
+{
+	"extends": "nodebb/public"
+}

package/.gitattributes

@@ -0,0 +1,22 @@
+# Auto detect text files and perform LF normalization
+* text=auto
+
+# Custom for Visual Studio
+*.cs     diff=csharp
+*.sln    merge=union
+*.csproj merge=union
+*.vbproj merge=union
+*.fsproj merge=union
+*.dbproj merge=union
+
+# Standard to msysgit
+*.doc	 diff=astextplain
+*.DOC	 diff=astextplain
+*.docx diff=astextplain
+*.DOCX diff=astextplain
+*.dot  diff=astextplain
+*.DOT  diff=astextplain
+*.pdf  diff=astextplain
+*.PDF	 diff=astextplain
+*.rtf	 diff=astextplain
+*.RTF	 diff=astextplain

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 NodeBB
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,23 @@
+# OpenAI Plugin for NodeBB
+
+This plugin let's users ask questions to ChatGPT in their forum posts by mentioning the chatgpt user with @<chat_gpt_username>. The user is created by admins and their username is set in the ACP page.
+
+You can also allow users to send private messages to the chatgpt user.
+
+If the chat gpt user is added to a public room it can answer questions by mentioning like in topics.
+
+The model used can be changed in the ACP page.
+
+Get an API key from openai at https://platform.openai.com/api-keys and save it in the ACP page of the plugin and restart your forum.
+
+## Dependencies
+
+This plugin requires nodebb-plugin-mentions to be installed and active.
+
+## Installation
+
+    npm install nodebb-plugin-openai
+
+## Screenshots
+
+![](./screenshots/screenshot1.png)

package/commitlint.config.js

@@ -0,0 +1,26 @@
+'use strict';
+
+module.exports = {
+	extends: ['@commitlint/config-angular'],
+	rules: {
+		'header-max-length': [1, 'always', 72],
+		'type-enum': [
+			2,
+			'always',
+			[
+				'breaking',
+				'build',
+				'chore',
+				'ci',
+				'docs',
+				'feat',
+				'fix',
+				'perf',
+				'refactor',
+				'revert',
+				'style',
+				'test',
+			],
+		],
+	},
+};

package/lib/controllers.js

@@ -0,0 +1,9 @@
+'use strict';
+
+const Controllers = module.exports;
+
+Controllers.renderAdminPage = function (req, res/* , next */) {
+	res.render('admin/plugins/openai', {
+		title: 'OpenAI',
+	});
+};

package/library.js

@@ -0,0 +1,174 @@
+'use strict';
+
+const { OpenAI } = require('openai');
+
+let openai;
+
+const db = require.main.require('./src/database');
+const meta = require.main.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 plugin = module.exports;
+
+plugin.init = async (params) => {
+	const { router /* , middleware , controllers */ } = params;
+	const settings = await meta.settings.get('openai')
+	if (settings && settings.apikey) {
+		openai = new OpenAI({
+			apiKey: settings.apikey,
+		});
+	}
+
+	routeHelpers.setupAdminPageRoute(router, '/admin/plugins/openai', controllers.renderAdminPage);
+};
+
+plugin.actionMentionsNotify = async function (hookData) {
+	try {
+		const { notification } = hookData;
+		if (!notification) {
+			return;
+		}
+
+		const settings = (await meta.settings.get('openai')) || {};
+		const chatgptusername = settings['chatgpt-username'];
+		const chatgptUid = await user.getUidByUsername(chatgptusername);
+		if (!chatgptUid) {
+			return;
+		}
+		if (notification.tid && notification.bodyLong.startsWith(`@${chatgptusername}`)) {
+			const message = notification.bodyLong.replace(new RegExp(`^@${chatgptusername}`), '');
+			if (message.length) {
+				const response = await chatComplete(message);
+
+				if (response) {
+					const postData = await topics.reply({
+						uid: chatgptUid,
+						content: response,
+						tid: notification.tid,
+						toPid: notification.pid,
+					});
+
+					await user.updateOnlineUsers(chatgptUid);
+					await socketHelpers.notifyNew(chatgptUid, 'newPost', {
+						posts: [postData],
+						'reputation:disabled': meta.config['reputation:disabled'] === 1,
+						'downvote:disabled': meta.config['downvote:disabled'] === 1,
+					});
+				}
+			}
+		}
+	} catch (err) {
+		console.error(err.stack);
+	}
+};
+
+plugin.actionMessagingSave = async function (hookData) {
+	try {
+		const { message } = hookData;
+		if (message.system) {
+			return;
+		}
+		const settings = (await meta.settings.get('openai')) || {};
+		const chatgptusername = settings['chatgpt-username'];
+		const chatgptUid = await user.getUidByUsername(chatgptusername);
+		const { roomId, content, fromuid } = message;
+		// don't reply to self
+		if (parseInt(fromuid, 10) === parseInt(chatgptUid, 10)) {
+			return;
+		}
+
+		const [roomData, inRoom] = await Promise.all([
+			messaging.getRoomData(roomId),
+			messaging.isUserInRoom(chatgptUid, roomId),
+		]);
+
+		if (!roomData || !inRoom) {
+			return;
+		}
+		const isPrivate = !roomData.public && !roomData.groupChat;
+		if (isPrivate && settings.enablePrivateMessages === 'off') {
+			return;
+		}
+		const shouldReply = isPrivate || content.startsWith(`@${chatgptusername}`);
+
+		// only reply in 1v1 chats or in public group chats when @<chat-gpt-username> is used
+		if (!shouldReply) {
+			return;
+		}
+		let conversation = [{ role: 'user', content: message.content }];
+		if (isPrivate) {
+			const mids = await getMessageIds(roomId, chatgptUid, 0, 20);
+
+			// dont allow chats to get too long
+			if (mids.length > 20) {
+				await api.chats.post({ uid: chatgptUid, session: {} }, {
+					roomId,
+					message: 'Conversation too long, please start a new chat',
+					toMid: message.mid,
+				});
+				return;
+			}
+			let messages = await messaging.getMessagesFields(mids, ['fromuid', 'content', 'system']);
+			messages = messages.filter(m => m && !m.system);
+			conversation = messages.map(
+				(msg) => ({ role: msg.fromuid === chatgptUid ? 'assistant' : 'user', content: msg.content })
+			);
+		}
+
+		const response = await chatComplete(conversation);
+
+		if (response) {
+			await api.chats.post({ uid: chatgptUid, session: {} }, {
+				roomId,
+				message: response,
+				toMid: isPrivate ? undefined : message.mid,
+			});
+		}
+	} catch (err) {
+		console.error(err.stack);
+	}
+};
+
+async function getMessageIds(roomId, uid, start, stop) {
+	const isPublic = await db.getObjectField(`chat:room:${roomId}`, 'public');
+	if (parseInt(isPublic, 10) === 1) {
+		return await db.getSortedSetRange(
+			`chat:room:${roomId}:mids`, start, stop
+		);
+	}
+	const userjoinTimestamp = await db.sortedSetScore(`chat:room:${roomId}:uids`, uid);
+	return await db.getSortedSetRangeByScore(
+		`chat:room:${roomId}:mids`, start, stop === -1 ? -1 : stop - start + 1, userjoinTimestamp, '+inf'
+	);
+}
+
+async function chatComplete(message) {
+	if (!openai) {
+		throw new Error('API not created!');
+	}
+	const isConversation = Array.isArray(message);
+	const { model } = await meta.settings.get('openai');
+	const chatCompletion = await openai.chat.completions.create({
+		model: model || 'gpt-3.5-turbo',
+		messages: isConversation ? message : [{ role: 'user', content: message }],
+	});
+
+	return chatCompletion.choices[0]?.message?.content;
+}
+
+plugin.addAdminNavigation = (header) => {
+	header.plugins.push({
+		route: '/plugins/openai',
+		icon: 'fa-robot',
+		name: 'OpenAI',
+	});
+
+	return header;
+};
+

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "nodebb-plugin-openai",
+  "version": "1.0.0",
+  "description": "A NodeBB OpenAI plugin",
+  "main": "library.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/nodebb/nodebb-plugin-openai"
+  },
+  "keywords": [
+    "nodebb",
+    "plugin",
+    "openai"
+  ],
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged",
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
+    }
+  },
+  "lint-staged": {
+    "*.js": [
+      "eslint --fix",
+      "git add"
+    ]
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/nodebb/nodebb-plugin-openai/issues"
+  },
+  "readmeFilename": "README.md",
+  "nbbpm": {
+    "compatibility": "^3.2.0"
+  },
+  "dependencies": {
+    "openai": "4.53.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "19.3.0",
+    "@commitlint/config-angular": "19.3.0",
+    "eslint": "8.57.0",
+    "eslint-config-nodebb": "0.2.1",
+    "eslint-plugin-import": "2.29.1",
+    "husky": "9.0.11",
+    "lint-staged": "15.2.7"
+  }
+}

package/plugin.json

@@ -0,0 +1,15 @@
+{
+	"id": "nodebb-plugin-openai",
+	"url": "https://github.com/NodeBB/nodebb-plugin-openai",
+	"library": "./library.js",
+	"hooks": [
+		{ "hook": "static:app.load", "method": "init" },
+		{ "hook": "filter:admin.header.build", "method": "addAdminNavigation" },
+		{ "hook": "action:mentions.notify", "method": "actionMentionsNotify" },
+		{ "hook": "action:messaging.save", "method": "actionMessagingSave" }
+	],
+	"modules": {
+		"../admin/plugins/openai.js": "./public/lib/admin.js"
+	},
+	"templates": "templates"
+}

package/public/lib/.eslintrc

@@ -0,0 +1,3 @@
+{
+	"extends": "nodebb/public"
+}

package/public/lib/admin.js

@@ -0,0 +1,17 @@
+'use strict';
+
+import { save, load } from 'settings';
+
+export function init() {
+	handleSettingsForm();
+};
+
+function handleSettingsForm() {
+	load('openai', $('.openai-settings'), function () {
+
+	});
+
+	$('#save').on('click', () => {
+		save('openai', $('.openai-settings'));
+	});
+}

package/renovate.json

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "config:base"
+  ]
+}

package/templates/admin/plugins/openai.tpl

@@ -0,0 +1,49 @@
+<div class="acp-page-container">
+	<!-- IMPORT admin/partials/settings/header.tpl -->
+
+	<div class="row m-0">
+		<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">General</h5>
+
+					<div class="mb-3">
+						<label class="form-label" for="apikey">API Key</label>
+						<input type="text" id="apikey" name="apikey" title="API Key" class="form-control">
+						<p class="form-text">
+							Get your <a href="https://platform.openai.com/api-keys">API Key</a> and enter it above. Requires a restart.
+						</p>
+					</div>
+					<div class="mb-3">
+						<label class="form-label" for="chatgpt-username">ChatGPT Username</label>
+						<input type="text" id="chatgpt-username" name="chatgpt-username" title="ChatGPT Username" class="form-control">
+						<p class="form-text">
+							<a href="{config.relative_path}/admin/manage/users">Create a user</a> and enter their username. Other users can mention this user to ask questions to ChatGPT or send private messages if enabled below.
+						</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">Enable Private Messages</label>
+						<p class="form-text">
+							If enabled users can send ChatGPT user private messages.
+						</p>
+					</div>
+
+					<div class="mb-3">
+						<label class="form-label" for="model">Model</label>
+						<select class="form-select" id="model" name="model" title="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>
+						</select>
+					</div>
+				</div>
+			</form>
+		</div>
+
+		<!-- IMPORT admin/partials/settings/toc.tpl -->
+	</div>
+</div>