feat: add topic summary support

Author: barisusakli

languages/en-GB/openai.json

@@ -1,3 +1,5 @@
 {
-	"error.need-x-reputation-to-mention": "You need at least %1 reputation for mentioning chatgpt"
+	"error.need-x-reputation-to-mention": "You need at least %1 reputation for mentioning chatgpt",
+	"summarize-topic": "Summarize Topic",
+	"topic-summary": "Topic Summary"
 }

languages/en-US/openai.json

@@ -1,3 +1,5 @@
 {
-	"error.need-x-reputation-to-mention": "You need at least %1 reputation for mentioning chatgpt"
+	"error.need-x-reputation-to-mention": "You need at least %1 reputation for mentioning chatgpt",
+	"summarize-topic": "Summarize Topic",
+	"topic-summary": "Topic Summary"
 }

lib/summary.js

@@ -0,0 +1,112 @@
+'use strict';
+
+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');
+
+function formatPosts(posts) {
+	return posts
+		.map((post) => `User ${post.username}:\n${post.content}`)
+		.join('\n---\n');
+}
+
+function chunkPosts(posts, maxTokensPerChunk = 3000) {
+	const chunks = [];
+	let currentChunk = [];
+	let currentTokens = 0;
+
+	// eslint-disable-next-line no-restricted-syntax
+	for (const post of posts) {
+		const estimatedTokens = Math.ceil(post.content.length / 4) + 10;
+		if (currentTokens + estimatedTokens > maxTokensPerChunk) {
+			chunks.push(currentChunk);
+			currentChunk = [];
+			currentTokens = 0;
+		}
+		currentChunk.push(post);
+		currentTokens += estimatedTokens;
+	}
+
+	if (currentChunk.length > 0) {
+		chunks.push(currentChunk);
+	}
+
+	return chunks;
+}
+
+async function summarizeChunk(chunk, openai, settings) {
+	const threadText = formatPosts(chunk);
+	const response = await openai.chat.completions.create({
+		model: settings.model || 'gpt-3.5-turbo',
+		messages: [
+			{
+				role: 'system',
+				content: 'You summarize discussion forum threads into concise summaries.',
+			},
+			{
+				role: 'user',
+				content: `Summarize the following discussion thread:\n\n${threadText}`,
+			},
+		],
+		temperature: 0.5,
+	});
+
+	return response.choices[0].message.content.trim();
+}
+
+exports.summarizeTopic = async function(tid, openai, settings) {
+	const allPids = await topics.getPids(tid);
+
+	const userMap = {};
+
+	const chunkSummaries = [];
+
+	await batch.processArray(allPids, async function (pids) {
+		const postData = await posts.getPostsFields(pids, ['uid', 'content']);
+
+		const missingUids = [];
+		postData.forEach((p) => {
+			if (!userMap.hasOwnProperty(p.uid)) {
+				missingUids.push(p.uid)
+			}
+		});
+		const userData = await user.getUsersFields(missingUids, ['username']);
+		userData.forEach((u) => {
+			userMap[u.uid] = u.displayname;
+		});
+		postData.forEach((p) => {
+			p.username = userMap[p.uid];
+		});
+
+		const chunks = chunkPosts(postData);
+
+		chunkSummaries.push(...await Promise.all(chunks.map(async (chunk) => {
+			return summarizeChunk(chunk, openai, settings)
+		})));
+	}, {
+		batch: 500,
+	});
+
+	if (chunkSummaries.length === 1) {
+		return chunkSummaries[0];
+	}
+	// Final summary from all summaries
+	const finalInput = chunkSummaries.join("\n\n");
+	const finalResponse = await openai.chat.completions.create({
+		model: settings.model || 'gpt-3.5-turbo',
+		messages: [
+			{
+				role: 'system',
+				content: 'You are an assistant that summarizes forum thread summaries into a single cohesive summary.',
+			},
+			{
+				role: 'user',
+				content: `Here are summaries of parts of a forum discussion:\n\n${finalInput}\n\nPlease write a final, concise summary of the full discussion.`,
+			},
+		],
+		temperature: 0.5,
+	});
+
+	return finalResponse.choices[0].message.content.trim();
+};

library.js

@@ -10,12 +10,15 @@ 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 posts = require.main.require('./src/posts');
 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 plugin = module.exports;
 
@@ -166,21 +169,21 @@ plugin.actionMessagingSave = async function (hookData) {
 	}
 };
 
-async function canUseOpenAI(uid, settings) {
-	if (!await checkReputation(uid, settings)) {
+async function canUseOpenAI(uid, settings, silent = false) {
+	if (!await checkReputation(uid, settings, silent)) {
 		return false;
 	}
-	if (!await checkGroupMembership(uid, settings)) {
+	if (!await checkGroupMembership(uid, settings, silent)) {
 		return false;
 	}
 	return true;
 }
 
-async function checkReputation(uid, settings) {
+async function checkReputation(uid, settings, silent) {
 	const reputation = await user.getUserField(uid, 'reputation');
 	const hasEnoughRep = parseInt(settings.minimumReputation, 10) === 0 || parseInt(reputation, 10) >= parseInt(settings.minimumReputation, 10);
 
-	if (!hasEnoughRep) {
+	if (!hasEnoughRep && !silent) {
 		sockets.server.in(`uid_${uid}`).emit('event:alert', {
 			type: 'danger',
 			title: '[[global:alert.error]]',
@@ -190,7 +193,7 @@ async function checkReputation(uid, settings) {
 	return hasEnoughRep;
 }
 
-async function checkGroupMembership(uid, settings) {
+async function checkGroupMembership(uid, settings, silent) {
 	let allowedGroups = [];
 	try {
 		allowedGroups = JSON.parse(settings.allowedGroups) || [];
@@ -205,7 +208,7 @@ async function checkGroupMembership(uid, settings) {
 
 	const isMembers = await groups.isMemberOfGroups(uid, allowedGroups);
 	const memberOfAny = isMembers.includes(true);
-	if (!memberOfAny) {
+	if (!memberOfAny && !silent) {
 		sockets.server.in(`uid_${uid}`).emit('event:alert', {
 			type: 'danger',
 			title: '[[global:alert.error]]',
@@ -262,3 +265,29 @@ plugin.addAdminNavigation = (header) => {
 	return header;
 };
 
+plugin.filterTopicThreadTools = async (hookData) => {
+	if (!await canUseOpenAI(hookData.uid, await getSettings(), true)) {
+		return hookData;
+	}
+	hookData.tools.push({
+		class: 'openai-summarize-topic',
+		icon: 'fa-wand-magic-sparkles',
+		title: '[[openai:summarize-topic]]',
+	});
+	return hookData;
+};
+
+socketPlugins.openai = {};
+
+socketPlugins.openai.summarizeTopic = async function (socket, data) {
+	const { tid } = 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;
+	}
+
+	return summary.summarizeTopic(tid, openai, settings);
+};

plugin.json

@@ -6,7 +6,11 @@
 		{ "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" }
+		{ "hook": "action:messaging.save", "method": "actionMessagingSave" },
+		{ "hook": "filter:topic.thread_tools", "method": "filterTopicThreadTools" }
+	],
+	"scripts": [
+		"./public/lib/main.js"
 	],
 	"modules": {
 		"../admin/plugins/openai.js": "./public/lib/admin.js"

public/lib/main.js

@@ -0,0 +1,41 @@
+'use strict';
+
+$('document').ready(function () {
+
+	function alertType(type, message) {
+		require(['alerts'], function (alerts) {
+			alerts[type](message);
+		});
+	}
+
+	$(window).on('action:topic.tools.load', function () {
+		$('.openai-summarize-topic').on('click', summarizeTopic);
+	});
+
+	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: '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');
+				}
+			});
+		});
+	}
+});

templates/admin/plugins/openai.tpl

@@ -42,7 +42,7 @@
 					</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>
+						<textarea class="form-control" id="systemPrompt" name="systemPrompt" title="System prompt" placeholder="You are a helpful assistant" rows="8"></textarea>
 					</div>
 				</div>