Merge pull request #57 from CMU-313/feature/llm-ui

sittingthyme · web-flow · commit 9205010795dd · 2026-03-26T23:34:24.000-04:00
Add post translation fields with API docs and topic UI
diff --git a/public/openapi/components/schemas/PostObject.yaml b/public/openapi/components/schemas/PostObject.yaml
@@ -18,6 +18,10 @@ PostObject:
         For posts received via ActivityPub, it is the url of the original piece of content.
     content:
       type: string
+    isEnglish:
+      type: boolean
+    translatedContent:
+      type: string
     sourceContent:
       type: string
       nullable: true
@@ -170,6 +174,10 @@ PostDataObject:
           description: A topic identifier
         content:
           type: string
+        isEnglish:
+          type: boolean
+        translatedContent:
+          type: string
         timestamp:
           type: number
         votes:
diff --git a/public/openapi/components/schemas/TopicObject.yaml b/public/openapi/components/schemas/TopicObject.yaml
@@ -109,6 +109,9 @@ TopicObject:
             sourceContent:
               type: string
               nullable: true
+            translatedContent:
+              type: string
+              nullable: true
             timestampISO:
               type: string
               description: An ISO 8601 formatted date string (complementing `timestamp`)
@@ -146,6 +149,8 @@ TopicObject:
                   example: "#f44336"
             index:
               type: number
+            isEnglish:
+              type: boolean
           nullable: true
         tags:
           type: array
@@ -295,4 +300,4 @@ TopicObjectSlim:
           type: number
           description: The number of thumbnails associated with this topic
       required:
-        - tid
+        - tid
diff --git a/public/openapi/read/categories.yaml b/public/openapi/read/categories.yaml
@@ -82,6 +82,10 @@ get:
                                               type: number
                                             content:
                                               type: string
+                                            isEnglish:
+                                              type: boolean
+                                            translatedContent:
+                                              type: string
                                             timestampISO:
                                               type: string
                                               description: An ISO 8601 formatted date string (complementing `timestamp`)
@@ -142,6 +146,10 @@ get:
                                     type: number
                                   content:
                                     type: string
+                                  isEnglish:
+                                    type: boolean
+                                  translatedContent:
+                                    type: string
                                   sourceContent:
                                     type: string
                                     nullable: true
@@ -253,4 +261,4 @@ get:
                               type: string
               - $ref: ../components/schemas/Pagination.yaml#/Pagination
               - $ref: ../components/schemas/Breadcrumbs.yaml#/Breadcrumbs
-              - $ref: ../components/schemas/CommonProps.yaml#/CommonProps
+              - $ref: ../components/schemas/CommonProps.yaml#/CommonProps
diff --git a/public/openapi/read/index.yaml b/public/openapi/read/index.yaml
@@ -77,6 +77,10 @@ get:
                                               type: number
                                             content:
                                               type: string
+                                            isEnglish:
+                                              type: boolean
+                                            translatedContent:
+                                              type: string
                                             timestampISO:
                                               type: string
                                               description: An ISO 8601 formatted date string (complementing `timestamp`)
@@ -144,6 +148,10 @@ get:
                                     type: number
                                   content:
                                     type: string
+                                  isEnglish:
+                                    type: boolean
+                                  translatedContent:
+                                    type: string
                                   sourceContent:
                                     type: string
                                     nullable: true
@@ -254,4 +262,4 @@ get:
                             imageClass:
                               type: string
               - $ref: ../components/schemas/Pagination.yaml#/Pagination
-              - $ref: ../components/schemas/CommonProps.yaml#/CommonProps
+              - $ref: ../components/schemas/CommonProps.yaml#/CommonProps
diff --git a/public/openapi/read/unread.yaml b/public/openapi/read/unread.yaml
@@ -143,6 +143,9 @@ get:
                                 sourceContent:
                                   type: string
                                   nullable: true
+                                translatedContent:
+                                  type: string
+                                  nullable: true
                                 timestampISO:
                                   type: string
                                   description: An ISO 8601 formatted date string (complementing `timestamp`)
@@ -180,6 +183,8 @@ get:
                                       example: "#f44336"
                                 index:
                                   type: number
+                                isEnglish:
+                                  type: boolean
                             tags:
                               type: array
                               items:
@@ -270,4 +275,4 @@ get:
                         type: string
               - $ref: ../components/schemas/Pagination.yaml#/Pagination
               - $ref: ../components/schemas/Breadcrumbs.yaml#/Breadcrumbs
-              - $ref: ../components/schemas/CommonProps.yaml#/CommonProps
+              - $ref: ../components/schemas/CommonProps.yaml#/CommonProps
diff --git a/public/openapi/write/posts/pid.yaml b/public/openapi/write/posts/pid.yaml
@@ -35,6 +35,10 @@ get:
                         description: A topic identifier
                       content:
                         type: string
+                      isEnglish:
+                        type: boolean
+                      translatedContent:
+                        type: string
                       timestamp:
                         type: number
                       flagId:
@@ -155,4 +159,4 @@ delete:
                 $ref: ../../components/schemas/Status.yaml#/Status
               response:
                 type: object
-                properties: {}
+                properties: {}
diff --git a/public/src/client/topic.js b/public/src/client/topic.js
@@ -72,12 +72,28 @@ define('forum/topic', [
 		addCrosspostsHandler();
 
 		$(window).on('scroll', utils.debounce(updateTopicTitle, 250));
+		configurePostToggle();
 
 		handleTopicSearch();
 
 		hooks.fire('action:topic.loaded', ajaxify.data);
 	};
 
+	function configurePostToggle() {
+		$('.topic').on('click', '.view-translated-btn', function () {
+			// Toggle the visibility of the next .translated-content div
+			$(this).closest('.sensitive-content-message').next('.translated-content').toggle();
+			// Optionally, change the button text based on visibility
+			var isVisible = $(this).closest('.sensitive-content-message').next('.translated-content').is(':visible');
+			if (isVisible) {
+				$(this).text('Hide the translated message.');
+			} else {
+				$(this).text('Click here to view the translated message.');
+			}
+		});
+	}
+
+
 	function handleTopicSearch() {
 		require(['mousetrap'], (mousetrap) => {
 			if (config.topicSearchEnabled) {
diff --git a/src/posts/create.js b/src/posts/create.js
@@ -9,6 +9,7 @@ const categories = require('../categories');
 const groups = require('../groups');
 const activitypub = require('../activitypub');
 const utils = require('../utils');
+const translate = require('../translate');
 
 module.exports = function (Posts) {
 	Posts.create = async function (data) {
@@ -18,6 +19,8 @@ module.exports = function (Posts) {
 		const timestamp = data.timestamp || Date.now();
 		const isMain = data.isMain || false;
 		let hasAttachment = false;
+		const [isEnglish, translatedContent] = await translate.translate(data);
+
 
 		if (!uid && parseInt(uid, 10) !== 0) {
 			throw new Error('[[error:invalid-uid]]');
@@ -28,7 +31,7 @@ module.exports = function (Posts) {
 		}
 
 		const pid = data.pid || await db.incrObjectField('global', 'nextPid');
-		let postData = { pid, uid, tid, content, sourceContent, timestamp };
+		let postData = { pid, uid, tid, content, sourceContent, timestamp, isEnglish, translatedContent};
 
 		if (data.toPid) {
 			postData.toPid = data.toPid;
diff --git a/src/posts/data.js b/src/posts/data.js
@@ -78,5 +78,11 @@ function modifyPost(post, fields) {
 				post.uploads = [];
 			}
 		}
+		// Mark post as "English" if decided by translator service or if it has no info
+		post.isEnglish = post.isEnglish == 'true' || post.isEnglish === undefined;
+		// If translatedContent is undefined, default to empty string (no translation needed for English posts)
+		if (post.translatedContent === undefined) {
+			post.translatedContent = '';
+		}
 	}
 }
diff --git a/src/posts/summary.js b/src/posts/summary.js
@@ -22,7 +22,7 @@ module.exports = function (Posts) {
 		options.escape = options.hasOwnProperty('escape') ? options.escape : false;
 		options.extraFields = options.hasOwnProperty('extraFields') ? options.extraFields : [];
 
-		const fields = ['pid', 'tid', 'toPid', 'url', 'content', 'sourceContent', 'uid', 'timestamp', 'deleted', 'upvotes', 'downvotes', 'replies', 'handle'].concat(options.extraFields);
+		const fields = ['pid', 'tid', 'toPid', 'url', 'content', 'sourceContent', 'uid', 'timestamp', 'deleted', 'upvotes', 'downvotes', 'replies', 'handle', 'isEnglish', 'translatedContent'].concat(options.extraFields);
 
 		let posts = await Posts.getPostsFields(pids, fields);
 		posts = posts.filter(Boolean);
diff --git a/src/translate/index.js b/src/translate/index.js
@@ -0,0 +1,30 @@
+
+/* eslint-disable strict */
+//var request = require('request');
+
+const translatorApi = module.exports;
+
+/**
+ * @returns {Promise<[boolean, string]>}
+ * Second value must always be a string — Redis hashes persist fields with
+ * String(value), so objects become "[object Object]".
+ */
+translatorApi.translate = async function (postData) {
+	// Stub: real implementation would call a translation API and assign a string to translatedContent.
+	const isEnglish = false;
+	let translatedContent = 'This is a hardcoded English translation returned from the translator API.';
+
+	if (postData) {
+		translatedContent = 'This is a hardcoded English translation returned from the translator API.';
+	}
+
+	return [isEnglish, translatedContent];
+};
+
+// translatorApi.translate = async function (postData) {
+//  Edit the translator URL below
+//  const TRANSLATOR_API = "TODO"
+//  const response = await fetch(TRANSLATOR_API+'/?content='+postData.content);
+//  const data = await response.json();
+//  return ['is_english','translated_content'];
+// };
diff --git a/test/api.js b/test/api.js
@@ -700,7 +700,7 @@ describe('API', async () => {
 				return;
 			}
 
-			assert(schema[prop], `"${prop}" was found in response, but is not defined in schema (path: ${method} ${path}, context: ${context}), SCHEMA ${JSON.stringify(response)}`);
+			assert(schema[prop], `"${prop}" was found in response, but is not defined in schema (path: ${method} ${path}, context: ${context}), SCHEMA ${util.inspect(schema, { depth: 2, maxArrayLength: 20 })}`);
 		});
 	}
 });
diff --git a/vendor/nodebb-theme-harmony-2.1.35/templates/partials/topic/post.tpl b/vendor/nodebb-theme-harmony-2.1.35/templates/partials/topic/post.tpl
@@ -82,6 +82,14 @@
 
 		<div class="content text-break" component="post/content" itemprop="text">
 			{posts.content}
+			{{{if !posts.isEnglish }}}
+			<div class="sensitive-content-message">
+			<a class="btn btn-sm btn-primary view-translated-btn">Click here to view the translated message.</a>
+			</div>
+			<div class="translated-content" style="display:none;">
+			{posts.translatedContent}
+			</div>
+	        {{{end}}}
 		</div>
 
 		<div component="post/footer" class="post-footer border-bottom pb-2">
@@ -149,4 +157,4 @@
 	{widgets.mainpost-footer.html}
 	{{{ end }}}
 </div>
-{{{ end }}}
+{{{ end }}}

Original file line number	Diff line number	Diff line change
`@@ -78,5 +78,11 @@ function modifyPost(post, fields) {`
`78`	`78`	`post.uploads = [];`
`79`	`79`	`}`
`80`	`80`	`}`
	`81`	`+ // Mark post as "English" if decided by translator service or if it has no info`
	`82`	`+ post.isEnglish = post.isEnglish == 'true' \|\| post.isEnglish === undefined;`
	`83`	`+ // If translatedContent is undefined, default to empty string (no translation needed for English posts)`
	`84`	`+ if (post.translatedContent === undefined) {`
	`85`	`+ post.translatedContent = '';`
	`86`	`+ }`
`81`	`87`	`}`
`82`	`88`	`}`