nodebb-plugin-link-preview 1.3.2 → 2.0.0

package/library.js

@@ -9,8 +9,8 @@ const dns = require('dns');
 
 const { getLinkPreview } = require('link-preview-js');
 const { load } = require('cheerio');
+const { isURL } = require('validator');
 
-const db = require.main.require('./src/database');
 const meta = require.main.require('./src/meta');
 const cache = require.main.require('./src/cache');
 const posts = require.main.require('./src/posts');
@@ -82,64 +82,24 @@ async function preview(url) {
 	});
 }
 
-async function processAttachments({ content, pid, tid }) {
-	// Retrieve attachments
-	const hashes = await db.getSortedSetMembers(`post:${pid}:attachments`);
-	if (!hashes.length) {
+async function process(content, opts) {
+	const { embedHtml, embedImage, embedAudio, embedVideo } = await meta.settings.get('link-preview');
+	if (![embedHtml, embedImage, embedAudio, embedVideo].some(prop => prop === 'on')) {
 		return content;
 	}
 
-	const keys = hashes.map(hash => `attachment:${hash}`);
-	const attachments = (await db.getObjects(keys)).filter(Boolean);
-	const urls = attachments
-		.filter(attachment => cache.has(`link-preview:${attachment.url}`))
-		.map(attachment => attachment.url);
-
-	const previews = urls.map(url => cache.get(`link-preview:${url}`));
-	const html = await Promise.all(previews.map(async preview => await render(preview)));
-
-	// Append all readily-available previews to content
-	content = `${content}\n\n<div class="row">${html.map(html => `<div class="col-6">${html}</div>`).join('\n')}</div>`;
+	const requests = new Map();
 
-	// Kickstart preview
-	const toFetch = attachments.filter(attachment => !cache.has(`link-preview:${attachment.url}`));
-	if (toFetch.length) {
-		Promise.all(toFetch.map(async attachment => preview(attachment.url))).then(async () => {
-			// bust posts cache item
-			if (await posts.exists(pid)) {
-				postsCache.del(String(pid));
-
-				// fire post edit event with mocked data
-				if (await topics.exists(tid)) {
-					const urls = attachments.map(attachment => attachment.url);
-
-					const previews = urls.map(url => cache.get(`link-preview:${url}`));
-					let html = await Promise.all(previews.map(async preview => await render(preview)));
-					html = `${content}\n\n<div class="row">${html.map(html => `<div class="col-6">${html}</div>`).join('\n')}</div>`;
-
-					websockets.in(`topic_${tid}`).emit('event:post_edited', {
-						post: {
-							tid,
-							pid,
-							changed: true,
-							content: html,
-						},
-						topic: {},
-					});
-				}
-			}
+	// Retrieve attachments
+	if (opts.hasOwnProperty('pid') && await posts.exists(opts.pid)) {
+		const attachments = await posts.attachments.get(opts.pid);
+		attachments.forEach(({ url, _type }) => {
+			const type = _type || 'attachment';
+			requests.set(url, { type });
 		});
 	}
 
-	return content;
-}
-
-async function process(content, opts) {
-	const { embedHtml, embedImage, embedAudio, embedVideo } = await meta.settings.get('link-preview');
-	if (![embedHtml, embedImage, embedAudio, embedVideo].some(prop => prop === 'on')) {
-		return content;
-	}
-
+	// Parse inline urls
 	const $ = load(content, null, false);
 	for (const anchor of $('a')) {
 		const $anchor = $(anchor);
@@ -162,28 +122,73 @@ async function process(content, opts) {
 			continue;
 		}
 
+		// Inline url takes precedence over attachment
+		requests.set(url, {
+			type: 'inline',
+			target: $anchor,
+		});
+	}
+
+	// Render cache hits immediately
+	let attachmentHtml = '';
+	const cold = new Set();
+	await Promise.all(Array.from(requests.keys()).map(async (url) => {
+		const options = requests.get(url);
 		const cached = cache.get(`link-preview:${url}`);
 		if (cached) {
 			const html = await render(cached);
 			if (html) {
-				$anchor.replaceWith($(html));
+				switch (options.type) {
+					case 'inline': {
+						const $anchor = options.target;
+						$anchor.replaceWith($(html));
+						break;
+					}
+
+					case 'attachment': {
+						attachmentHtml += `<div class="col-6">${html}</div>`;
+						break;
+					}
+				}
 			}
-			continue;
+		} else {
+			cold.add(url);
 		}
+	}));
+
+	// Start preview for cache misses, but continue for now so as to not block response
+	if (cold.size) {
+		const coldArr = Array.from(cold);
+		Promise.all(coldArr.map(preview)).then(async (previews) => {
+			await Promise.all(previews.map(async (preview, idx) => {
+				if (!preview) {
+					return;
+				}
 
-		// Generate the preview, but continue for now so as to not block response
-		preview(url).then(async (preview) => {
-			if (!preview) {
-				return;
-			}
-
-			const parsedUrl = new URL(url);
-			preview.hostname = parsedUrl.hostname;
+				const url = coldArr[idx];
+				const options = requests.get(url);
+				const parsedUrl = new URL(url);
+				preview.hostname = parsedUrl.hostname;
+
+				const html = await render(preview);
+				if (html) {
+					switch (options.type) {
+						case 'inline': {
+							const $anchor = options.target;
+							$anchor.replaceWith($(html));
+							break;
+						}
+
+						case 'attachment': {
+							attachmentHtml += `<div class="col-6">${html}</div>`;
+							break;
+						}
+					}
+				}
+			}));
 
-			const html = await render(preview);
-			if (!html) {
-				return;
-			}
+			let content = $.html();
+			content += attachmentHtml ? `\n\n<div class="row">${attachmentHtml}</div>` : '';
 
 			// bust posts cache item
 			if (opts.hasOwnProperty('pid') && await posts.exists(opts.pid)) {
@@ -191,13 +196,12 @@ async function process(content, opts) {
 
 				// fire post edit event with mocked data
 				if (opts.hasOwnProperty('tid') && await topics.exists(opts.tid)) {
-					$anchor.replaceWith($(html));
 					websockets.in(`topic_${opts.tid}`).emit('event:post_edited', {
 						post: {
 							tid: opts.tid,
 							pid: opts.pid,
 							changed: true,
-							content: $.html(),
+							content,
 						},
 						topic: {},
 					});
@@ -206,7 +210,9 @@ async function process(content, opts) {
 		});
 	}
 
-	return $.html();
+	content = $.html();
+	content += attachmentHtml ? `\n\n<div class="row">${attachmentHtml}</div>` : '';
+	return content;
 }
 
 async function render(preview) {
@@ -285,14 +291,32 @@ plugin.onParse = async (payload) => {
 	if (typeof payload === 'string') { // raw
 		payload = await process(payload, {});
 	} else if (payload && payload.postData && payload.postData.content) { // post
-		let { content, pid, tid } = payload.postData;
-		content = await processAttachments({ content, pid, tid });
+		const { content, pid, tid } = payload.postData;
 		payload.postData.content = await process(content, { pid, tid });
 	}
 
 	return payload;
 };
 
+plugin.onPost = async ({ post }) => {
+	if (post._activitypub) {
+		return; // no attachment parsing for content from activitypub; attachments saved via notes.assert
+	}
+
+	// Only match standalone URLs on their own line
+	const lines = post.content.split('\n');
+	const urls = lines.filter(line => isURL(line));
+
+	let previews = await Promise.all(urls.map(async url => await preview(url)));
+	previews = previews.map(({ url, contentType: mediaType }) => ({
+		type: 'inline',
+		url,
+		mediaType,
+	})).filter(Boolean);
+
+	posts.attachments.update(post.pid, previews);
+};
+
 plugin.addAdminNavigation = (header) => {
 	header.plugins.push({
 		route: '/plugins/link-preview',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodebb-plugin-link-preview",
-  "version": "1.3.2",
+  "version": "2.0.0",
   "description": "A starter kit for quickly creating NodeBB plugins",
   "main": "library.js",
   "repository": {
@@ -31,7 +31,7 @@
   },
   "readmeFilename": "README.md",
   "nbbpm": {
-    "compatibility": "^3.2.0"
+    "compatibility": "^4.0.0"
   },
   "devDependencies": {
     "@commitlint/cli": "17.6.5",
@@ -44,6 +44,7 @@
   },
   "dependencies": {
     "cheerio": "^1.0.0-rc.12",
-    "link-preview-js": "^3.0.4"
+    "link-preview-js": "^3.0.4",
+    "validator": "^13.11.0"
   }
 }

package/plugin.json

@@ -7,7 +7,9 @@
 		{ "hook": "filter:admin.header.build", "method": "addAdminNavigation" },
 		{ "hook": "filter:settings.get", "method": "applyDefaults" },
 		{ "hook": "filter:parse.post", "method": "onParse" },
-		{ "hook": "filter:parse.raw", "method": "onParse" }
+		{ "hook": "filter:parse.raw", "method": "onParse" },
+		{ "hook": "action:post.save", "method": "onPost" },
+		{ "hook": "action:post.edit", "method": "onPost" }
 	],
 	"scss": [
 		"static/scss/link-preview.scss"