nodebb-plugin-mentions 4.5.2 → 4.6.0

package/languages/th/mentions.json

@@ -0,0 +1,3 @@
+{
+	"user-mentioned-you-in": "<strong>%1</strong> กล่าวถึงคุณใน <strong>%2</strong>"
+}

package/languages/th/notifications.json

@@ -0,0 +1,7 @@
+{
+	"mentions": "การถูกกล่าวถึง",
+	"user-mentioned-you-in": "<strong>%1</strong> ได้กล่าวถึงคุณใน <strong>%2</strong>",
+	"user-mentioned-you-in-room": "<strong>%1</strong> ได้กล่าวถึงคุณใน <strong class=\"text-nowrap\"><i class=\"fa %2\"></i>%3</strong>",
+	"user-mentioned-group-in": "<strong>%1</strong> ได้กล่าวถึง <strong>%2</strong> ใน <strong>%3</strong>",
+	"notificationType-mention": "เมื่อบางคนได้กล่าวถึงคุณ"
+}

package/library.js

@@ -5,6 +5,7 @@
 const _ = require('lodash');
 const validator = require('validator');
 const entitiesDecode = require('html-entities').decode;
+const cheerio = require('cheerio');
 
 const nconf = require.main.require('nconf');
 const winston = require.main.require('winston');
@@ -93,7 +94,11 @@ Mentions.notify = async function ({ post }) {
 		}
 
 		const noMentionGroups = getNoMentionGroups();
-		matches = _.uniq(matches.map(match => slugify(match))).filter(match => match && !noMentionGroups.includes(match));
+		matches = _.uniq(
+			matches
+				.map(match => slugify(match.slice(1)))
+				.filter(match => match && !noMentionGroups.includes(match))
+		);
 		if (!matches.length) {
 			return;
 		}
@@ -185,7 +190,8 @@ Mentions.notifyMessage = async (hookData) => {
 	}
 	const { message } = hookData;
 	const { roomId } = message;
-	matches = _.uniq(matches.map(slugify));
+	matches = _.uniq(matches.map(match => slugify(match.slice(1))));
+
 	const [matchedUids, roomData] = await Promise.all([
 		getUidsToNotify(matches),
 		Messaging.getRoomData(roomId),
@@ -327,11 +333,12 @@ async function createNotification(postData, nidType, notificationText) {
 }
 
 Mentions.parsePost = async (data) => {
-	if (!data || !data.postData || !data.postData.content) {
+	const { postData, type } = data;
+	if (!postData.content) {
 		return data;
 	}
 
-	const parsed = await Mentions.parseRaw(data.postData.content);
+	const parsed = await Mentions.parseRaw(postData.content, type);
 	data.postData.content = parsed;
 	return data;
 };
@@ -340,7 +347,7 @@ function removePunctuationSuffix(string) {
 	return string.replace(/[!?.]*$/, '');
 }
 
-function getMatches(content, isMarkdown = false) {
+async function getMatches(content, isMarkdown = false) {
 	const splitContent = utility.split(content, isMarkdown, false, true);
 	let matches = [];
 	splitContent.forEach((cleanedContent, i) => {
@@ -349,12 +356,38 @@ function getMatches(content, isMarkdown = false) {
 		}
 	});
 
-	return { splitContent, matches };
+	const $ = cheerio.load(splitContent.join(''));
+	const anchors = $('a');
+	const urls = new Set();
+	Array.from(anchors).forEach((anchor) => {
+		const text = $(anchor).prop('innerText');
+		const match = text.match(regex);
+		if (match) {
+			urls.add($(anchor).attr('href'));
+		}
+	});
+
+	// Filter out urls that don't backreference to a remote id
+	const backrefs = await db.getObjectFields('remoteUrl:uid', Array.from(urls));
+	const urlAsIdExists = await db.isSortedSetMembers('usersRemote:lastCrawled', Array.from(urls));
+	const urlMap = new Map();
+	Array.from(urls).map(async (url, index) => {
+		if (backrefs[url] || urlAsIdExists[index]) {
+			urlMap.set(url, backrefs[url] || url);
+		}
+	});
+	let slugs = await User.getUsersFields(Array.from(urlMap.values()), ['userslug']);
+	slugs = slugs.map(({ userslug }) => userslug);
+	Array.from(urlMap.keys()).forEach((url, idx) => {
+		urlMap.set(url, `/user/${encodeURIComponent(slugs[idx])}`);
+	});
+
+	return { splitContent, matches, urlMap };
 }
 
 Mentions.getMatches = async (content) => {
 	// Exported method only accepts markdown, also filters out dupes and matches to ensure slugs exist
-	let { matches } = getMatches(content, true);
+	let { matches } = await getMatches(content, true);
 	matches = await filterMatches(matches);
 	const ids = await Promise.all(matches.map(async m => User.getUidByUserslug(m.slice(1).toLowerCase())));
 	matches = matches.map((slug, idx) => (ids[idx] ? {
@@ -372,11 +405,15 @@ async function filterMatches(matches) {
 	return matches.filter((m, i) => exists[[i]]);
 }
 
-Mentions.parseRaw = async (content) => {
+Mentions.parseRaw = async (content, type = 'default') => {
+	if (type === 'plaintext') {
+		return content;
+	}
+
 	// Note: Mentions.clean explicitly can't be called here because I need the content unstripped
-	let { splitContent, matches } = getMatches(content);
+	let { splitContent, matches, urlMap } = await getMatches(content);
 
-	if (!matches.length) {
+	if (!matches.length && !urlMap.size) {
 		return content;
 	}
 
@@ -390,6 +427,7 @@ Mentions.parseRaw = async (content) => {
 		return atIndex !== 0 ? match.slice(atIndex) : match;
 	});
 
+	// Convert matches to anchor html
 	await Promise.all(matches.map(async (match) => {
 		const slug = slugify(match.slice(1));
 		match = removePunctuationSuffix(match);
@@ -397,7 +435,7 @@ Mentions.parseRaw = async (content) => {
 		const cid = await categories.getCidByHandle(slug);
 		const { groupExists, user, category } = await utils.promiseParallel({
 			groupExists: Groups.existsBySlug(slug),
-			user: User.getUserFields(uid, ['uid', 'username', 'fullname', 'url']),
+			user: User.getUserFields(uid, ['uid', 'username', 'userslug', 'fullname', 'url']),
 			category: categories.getCategoryFields(cid, ['slug']),
 		});
 
@@ -406,17 +444,20 @@ Mentions.parseRaw = async (content) => {
 
 			switch (true) {
 				case !!uid: {
-					url = utils.isNumber(user.uid) ? `${nconf.get('url')}/user/${slug}` : (user.url || user.uid);
+					url = `/user/${encodeURIComponent(user.userslug)}`;
+					if (type.startsWith('activitypub') && !utils.isNumber(uid)) {
+						url = user.url || user.uid;
+					}
 					break;
 				}
 
 				case !!cid: {
-					url = `${nconf.get('url')}/category/${category.slug}`;
+					url = `/category/${category.slug}`;
 					break;
 				}
 
 				case !!groupExists: {
-					url = `${nconf.get('url')}/groups/${slug}`;
+					url = `/groups/${slug}`;
 					break;
 				}
 			}
@@ -456,7 +497,20 @@ Mentions.parseRaw = async (content) => {
 		}
 	}));
 
-	return splitContent.join('');
+	const parsed = splitContent.join('');
+
+	// Modify existing anchors to local profile
+	const $ = cheerio.load(parsed);
+	const anchors = $('a');
+	Array.from(anchors).forEach((anchor) => {
+		const $anchor = $(anchor);
+		const url = $anchor.attr('href');
+		if (urlMap.has(url)) {
+			$anchor.attr('href', urlMap.get(url));
+		}
+	});
+
+	return $.html();
 };
 
 Mentions.clean = function (input, isMarkdown, stripBlockquote, stripCode) {

package/package.json

@@ -1,11 +1,8 @@
 {
   "name": "nodebb-plugin-mentions",
-  "version": "4.5.2",
+  "version": "4.6.0",
   "description": "NodeBB Plugin that allows users to mention other users by prepending an '@' sign to their username",
   "main": "library.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
   "repository": {
     "type": "git",
     "url": "https://github.com/julianlam/nodebb-plugin-mentions"
@@ -16,22 +13,24 @@
     "username",
     "mentions"
   ],
-  "author": "Julian Lam <julian@designcreateplay.com>",
-  "license": "BSD-2-Clause",
+  "author": "Julian Lam <julian@nodebb.org>",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/julianlam/nodebb-plugin-mentions/issues"
   },
   "nbbpm": {
-    "compatibility": "^3.3.0"
+    "compatibility": "^4.0.0"
   },
   "dependencies": {
+    "cheerio": "^1.0.0-rc.12",
     "html-entities": "^2.3.2",
     "lodash": "4.17.21",
+    "sanitize-html": "^2.13.0",
     "validator": "^13.0.0"
   },
   "devDependencies": {
     "mocha": "10.4.0",
-    "eslint": "9.0.0",
+    "eslint": "9.3.0",
     "eslint-config-nodebb": "0.2.1",
     "eslint-plugin-import": "2.29.1"
   }