nodebb-plugin-openai 1.0.0 → 1.2.0

package/languages/en-GB/openai.json

@@ -0,0 +1,3 @@
+{
+	"error.need-x-reputation-to-mention": "You need at least %1 reputation for mentioning chatgpt"
+}

package/languages/en-US/openai.json

@@ -0,0 +1,3 @@
+{
+	"error.need-x-reputation-to-mention": "You need at least %1 reputation for mentioning chatgpt"
+}

package/lib/controllers.js

@@ -1,9 +1,14 @@
 'use strict';
 
+const groups = require.main.require('./src/groups');
+
 const Controllers = module.exports;
 
-Controllers.renderAdminPage = function (req, res/* , next */) {
+Controllers.renderAdminPage = async function (req, res/* , next */) {
+	const groupsData = await groups.getNonPrivilegeGroups('groups:createtime', 0, -1);
+	groupsData.sort((a, b) => b.system - a.system);
 	res.render('admin/plugins/openai', {
 		title: 'OpenAI',
+		groups: groupsData,
 	});
 };

package/library.js

@@ -13,9 +13,23 @@ 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 plugin = module.exports;
 
+const defaults = {
+	apikey: '',
+	'chatgpt-username': '',
+	enablePrivateMessages: 'off',
+	model: 'gpt-3.5-turbo',
+	minimumReputation: 0,
+	allowedGroups: '[]',
+	systemPrompt: 'You are a helpful assistant',
+};
+
+
 plugin.init = async (params) => {
 	const { router /* , middleware , controllers */ } = params;
 	const settings = await meta.settings.get('openai')
@@ -28,6 +42,11 @@ plugin.init = async (params) => {
 	routeHelpers.setupAdminPageRoute(router, '/admin/plugins/openai', controllers.renderAdminPage);
 };
 
+async function getSettings() {
+	const settings = await meta.settings.get('openai')
+	return {...defaults, ...settings };
+}
+
 plugin.actionMentionsNotify = async function (hookData) {
 	try {
 		const { notification } = hookData;
@@ -35,13 +54,21 @@ plugin.actionMentionsNotify = async function (hookData) {
 			return;
 		}
 
-		const settings = (await meta.settings.get('openai')) || {};
+		const settings = await getSettings();
+		if (!await canUseOpenAI(notification.from, settings)) {
+			return;
+		}
+
 		const chatgptusername = settings['chatgpt-username'];
 		const chatgptUid = await user.getUidByUsername(chatgptusername);
 		if (!chatgptUid) {
 			return;
 		}
 		if (notification.tid && notification.bodyLong.startsWith(`@${chatgptusername}`)) {
+			const canReply = await privileges.topics.can('topics:reply', notification.tid, chatgptUid);
+			if (!canReply) {
+				return;
+			}
 			const message = notification.bodyLong.replace(new RegExp(`^@${chatgptusername}`), '');
 			if (message.length) {
 				const response = await chatComplete(message);
@@ -74,7 +101,11 @@ plugin.actionMessagingSave = async function (hookData) {
 		if (message.system) {
 			return;
 		}
-		const settings = (await meta.settings.get('openai')) || {};
+		const settings = await getSettings();
+		if (!await canUseOpenAI(message.fromuid, settings)) {
+			return;
+		}
+
 		const chatgptusername = settings['chatgpt-username'];
 		const chatgptUid = await user.getUidByUsername(chatgptusername);
 		const { roomId, content, fromuid } = message;
@@ -135,6 +166,55 @@ plugin.actionMessagingSave = async function (hookData) {
 	}
 };
 
+async function canUseOpenAI(uid, settings) {
+	if (!await checkReputation(uid, settings)) {
+		return false;
+	}
+	if (!await checkGroupMembership(uid, settings)) {
+		return false;
+	}
+	return true;
+}
+
+async function checkReputation(uid, settings) {
+	const reputation = await user.getUserField(uid, 'reputation');
+	const hasEnoughRep = parseInt(settings.minimumReputation, 10) === 0 || parseInt(reputation, 10) >= parseInt(settings.minimumReputation, 10);
+
+	if (!hasEnoughRep) {
+		sockets.server.in(`uid_${uid}`).emit('event:alert', {
+			type: 'danger',
+			title: '[[global:alert.error]]',
+			message: `[[openai:error.need-x-reputation-to-mention, ${settings.minimumReputation}]]`,
+		});
+	}
+	return hasEnoughRep;
+}
+
+async function checkGroupMembership(uid, settings) {
+	let allowedGroups = [];
+	try {
+		allowedGroups = JSON.parse(settings.allowedGroups) || [];
+	} catch (err) {
+		console.error(err);
+		allowedGroups = [];
+	}
+
+	if (!allowedGroups.length) {
+		return true;
+	}
+
+	const isMembers = await groups.isMemberOfGroups(uid, allowedGroups);
+	const memberOfAny = isMembers.includes(true);
+	if (!memberOfAny) {
+		sockets.server.in(`uid_${uid}`).emit('event:alert', {
+			type: 'danger',
+			title: '[[global:alert.error]]',
+			message: `[[error:no-privileges]]`,
+		});
+	}
+	return memberOfAny;
+}
+
 async function getMessageIds(roomId, uid, start, stop) {
 	const isPublic = await db.getObjectField(`chat:room:${roomId}`, 'public');
 	if (parseInt(isPublic, 10) === 1) {
@@ -148,15 +228,25 @@ async function getMessageIds(roomId, uid, start, stop) {
 	);
 }
 
-async function chatComplete(message) {
+async function chatComplete(messages) {
 	if (!openai) {
 		throw new Error('API not created!');
 	}
-	const isConversation = Array.isArray(message);
-	const { model } = await meta.settings.get('openai');
+	const isConversation = Array.isArray(messages);
+	const { model, systemPrompt } = await getSettings();
+	const conversation = [];
+	if (systemPrompt) {
+		conversation.push({ role: 'system', content: systemPrompt });
+	}
+	if (isConversation) {
+		conversation.push(...messages);
+	} else {
+		conversation.push({ role: 'user', content: messages });
+	}
+
 	const chatCompletion = await openai.chat.completions.create({
 		model: model || 'gpt-3.5-turbo',
-		messages: isConversation ? message : [{ role: 'user', content: message }],
+		messages: conversation,
 	});
 
 	return chatCompletion.choices[0]?.message?.content;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodebb-plugin-openai",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "A NodeBB OpenAI plugin",
   "main": "library.js",
   "repository": {
@@ -33,7 +33,7 @@
     "compatibility": "^3.2.0"
   },
   "dependencies": {
-    "openai": "4.53.0"
+    "openai": "4.53.2"
   },
   "devDependencies": {
     "@commitlint/cli": "19.3.0",

package/plugin.json

@@ -11,5 +11,6 @@
 	"modules": {
 		"../admin/plugins/openai.js": "./public/lib/admin.js"
 	},
-	"templates": "templates"
+	"templates": "templates",
+	"languages": "languages"
 }

package/templates/admin/plugins/openai.tpl

@@ -40,6 +40,33 @@
 							<option value="gpt-4">gpt-4</option>
 						</select>
 					</div>
+					<div class="">
+						<label class="form-label" for="systemPrompt">System Prompt</label>
+						<textarea class="form-control" id="systemPrompt" name="systemPrompt" title="System prompt" placeholder="You are a helpful assistant"></textarea>
+					</div>
+				</div>
+
+				<div class="">
+					<h5 class="fw-bold tracking-tight settings-header">Restrictions</h5>
+
+					<div class="mb-3">
+						<label class="form-label" for="minimumReputation">Minimum Reputation</label>
+						<input type="text" id="minimumReputation" name="minimumReputation" title="Minimum Reputation" class="form-control">
+						<p class="form-text">
+							Minimum reputation required to mention chatgpt user. (0 to disable)
+						</p>
+					</div>
+					<div class="mb-3">
+						<label class="form-label" form="allowedGroups">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">
+							Only users in these groups will be able to mention the chatgpt user. Leave blank to allow all groups.
+						</p>
+					</div>
 				</div>
 			</form>
 		</div>