nodebb-plugin-mentions 4.8.10 → 4.8.12

package/library.js

@@ -10,7 +10,6 @@ const nconf = require.main.require('nconf');
 const winston = require.main.require('winston');
 
 const db = require.main.require('./src/database');
-const api = require.main.require('./src/api');
 const meta = require.main.require('./src/meta');
 const categories = require.main.require('./src/categories');
 const Topics = require.main.require('./src/topics');
@@ -27,12 +26,13 @@ const batch = require.main.require('./src/batch');
 const utils = require.main.require('./src/utils');
 const SocketPlugins = require.main.require('./src/socket.io/plugins');
 const translator = require.main.require('./src/translator');
+const privileges = require.main.require('./src/privileges');
 
 const utility = require('./lib/utility');
 
 const parts = {
 	before: '(?<=(^|\\P{L}))', // a single unicode non-letter character or start of line
-	main: '(@[\\p{L}\\d\\-_.@]+)', // unicode letters, numbers, dashes, underscores, or periods
+	main: '(@[\\p{L}\\d\\-_.@]+(?<![.-]))', // unicode letters, numbers, dashes, underscores, or periods, negative lookbehind to guard against periods/dashes at end
 	after: '((?=\\b)(?=[^-])|(?=[^\\p{L}\\d\\-_.@])|$)', // used to figure out where latin mentions end
 };
 const regex = RegExp(`${parts.before}${parts.main}`, 'gu');
@@ -40,10 +40,9 @@ const isLatinMention = /@[\w\d\-_.@]+$/;
 
 const Mentions = module.exports;
 
-Mentions._settings = {};
 Mentions._defaults = {
 	disableFollowedTopics: 'off',
-	autofillGroups: 'off',
+	autofillGroups: 'on',
 	disableGroupMentions: '[]',
 	overrideIgnores: 'off',
 	display: '',
@@ -57,11 +56,13 @@ Mentions.init = async (data) => {
 	const controllers = require('./controllers');
 
 	routeHelpers.setupAdminPageRoute(data.router, '/admin/plugins/mentions', controllers.renderAdminPage);
-
-	// Retrieve settings
-	Object.assign(Mentions._settings, Mentions._defaults, await Meta.settings.get('mentions'));
 };
 
+async function getSettings() {
+	const settings = await Meta.settings.get('mentions');
+	return { ...Mentions._defaults, ...settings };
+}
+
 Mentions.addAdminNavigation = async (header) => {
 	header.plugins.push({
 		route: '/plugins/mentions',
@@ -71,10 +72,11 @@ Mentions.addAdminNavigation = async (header) => {
 	return header;
 };
 
-function getNoMentionGroups() {
-	let noMentionGroups = ['registered-users', 'verified-users', 'unverified-users', 'guests'];
+async function getNoMentionGroups() {
+	let noMentionGroups = ['registered-users', 'verified-users', 'unverified-users', 'guests', 'banned-users'];
 	try {
-		noMentionGroups = noMentionGroups.concat(JSON.parse(Mentions._settings.disableGroupMentions));
+		const settings = await getSettings();
+		noMentionGroups = noMentionGroups.concat(JSON.parse(settings.disableGroupMentions));
 	} catch (err) {
 		winston.error(err);
 	}
@@ -93,7 +95,7 @@ Mentions.notify = async function ({ post }) {
 			return;
 		}
 
-		const noMentionGroups = getNoMentionGroups();
+		const noMentionGroups = await getNoMentionGroups();
 		matches = _.uniq(
 			matches
 				.map(match => slugify(match.slice(1)))
@@ -129,11 +131,11 @@ Mentions.notify = async function ({ post }) {
 	if ((!uidsToNotify && !groupsToNotify) || (!uidsToNotify.length && !groupsToNotify.length)) {
 		return;
 	}
-
+	const settings = await getSettings();
 	const [topic, userData, topicFollowers] = await Promise.all([
 		Topics.getTopicFields(post.tid, ['title', 'cid']),
 		User.getUserFields(post.uid, ['username']),
-		Mentions._settings.disableFollowedTopics === 'on' ? Topics.getFollowers(post.tid) : [],
+		settings.disableFollowedTopics === 'on' ? Topics.getFollowers(post.tid) : [],
 	]);
 	const { displayname } = userData;
 	const title = entitiesDecode(topic.title);
@@ -142,7 +144,7 @@ Mentions.notify = async function ({ post }) {
 		uid => uid !== postOwner && !topicFollowers.includes(uid)
 	);
 
-	if (Mentions._settings.privilegedDirectReplies === 'on') {
+	if (settings.privilegedDirectReplies === 'on') {
 		const toPid = await posts.getPostField(post.pid, 'toPid');
 		uids = await filterPrivilegedUids(uids, post.cid, toPid);
 	}
@@ -298,10 +300,10 @@ async function sendNotificationToUids(postData, uids, nidType, notificationText)
 	if (!notification) {
 		return;
 	}
-
+	const settings = await getSettings();
 	await batch.processArray(uids, async (uids) => {
 		uids = await Privileges.topics.filterUids('read', postData.tid, uids);
-		if (Mentions._settings.overrideIgnores !== 'on') {
+		if (settings.overrideIgnores !== 'on') {
 			uids = await Topics.filterIgnoringUids(postData.tid, uids);
 		}
 		filteredUids.push(...uids);
@@ -423,6 +425,8 @@ Mentions.parseRaw = async (content, type = 'default') => {
 		return content;
 	}
 
+	const settings = await getSettings();
+
 	matches = _.uniq(matches).map((match) => {
 		/**
 		 * Javascript-flavour of regex does not support lookaround,
@@ -434,6 +438,7 @@ Mentions.parseRaw = async (content, type = 'default') => {
 	});
 
 	// Convert matches to anchor html
+	let replacements = new Set();
 	await Promise.all(matches.map(async (match) => {
 		const slug = slugify(match.slice(1));
 		match = removePunctuationSuffix(match);
@@ -475,6 +480,16 @@ Mentions.parseRaw = async (content, type = 'default') => {
 				}
 			}
 
+			replacements.add({ match, url, user, mentionType });
+		}
+	}));
+
+
+	replacements = Array.from(replacements)
+		.sort((a, b) => {
+			return b.user.userslug.length - a.user.userslug.length;
+		})
+		.forEach(({ match, url, user, mentionType }) => {
 			const regex = isLatinMention.test(match) ?
 				RegExp(`${parts.before}${match}${parts.after}`, 'gu') :
 				RegExp(`${parts.before}${match}`, 'gu');
@@ -492,7 +507,7 @@ Mentions.parseRaw = async (content, type = 'default') => {
 					const plain = match.slice(0, atIndex);
 					match = match.slice(atIndex + 1);
 					if (user && user.uid) {
-						switch (Mentions._settings.display) {
+						switch (settings.display) {
 							case 'fullname':
 								match = user.displayname || match;
 								break;
@@ -504,16 +519,15 @@ Mentions.parseRaw = async (content, type = 'default') => {
 
 					let str;
 					if (type === 'markdown') {
-						str = `[${!Mentions._settings.display ? '@' : ''}${match}](${nconf.get('url')}${url})`;
+						str = `[${!settings.display ? '@' : ''}${match}](${nconf.get('url')}${url})`;
 					} else {
-						str = `<a class="plugin-mentions-${mentionType} plugin-mentions-a" href="${nconf.get('relative_path')}${url}" aria-label="Profile: ${match}">${!Mentions._settings.display ? '@' : ''}<bdi>${match}</bdi></a>`;
+						str = `<a class="plugin-mentions-${mentionType} plugin-mentions-a" href="${nconf.get('relative_path')}${url}" aria-label="Profile: ${match}">${!settings.display ? '@' : ''}<bdi>${match}</bdi></a>`;
 					}
 
 					return plain + str;
 				});
 			});
-		}
-	}));
+		});
 
 	return splitContent.join('');
 };
@@ -553,17 +567,18 @@ async function filterPrivilegedUids(uids, cid, toPid) {
 }
 
 async function filterDisallowedFullnames(users) {
+	if (!users.length) return [];
 	const userSettings = await User.getMultipleUserSettings(users.map(user => user.uid));
-	return users.filter((user, index) => userSettings[index].showfullname);
+	return users.filter((user, index) => userSettings[index] && userSettings[index].showfullname);
 }
 
 async function stripDisallowedFullnames(users) {
+	if (!users.length) return [];
 	const userSettings = await User.getMultipleUserSettings(users.map(user => user.uid));
-	return users.map((user, index) => {
-		if (!userSettings[index].showfullname) {
+	users.forEach((user, index) => {
+		if (user && userSettings[index] && !userSettings[index].showfullname) {
 			user.fullname = null;
 		}
-		return user;
 	});
 }
 
@@ -578,39 +593,62 @@ SocketPlugins.mentions.getTopicUsers = async (socket, data) => {
 	if (Meta.config.hideFullname) {
 		return users;
 	}
-	return stripDisallowedFullnames(users);
+	await stripDisallowedFullnames(users);
+	return users;
 };
 
 SocketPlugins.mentions.listGroups = async function () {
-	if (Mentions._settings.autofillGroups === 'off') {
+	const settings = await getSettings();
+	if (settings.autofillGroups === 'off') {
 		return [];
 	}
 
 	const groups = await Groups.getGroups('groups:visible:createtime', 0, -1);
-	const noMentionGroups = getNoMentionGroups();
-	return groups.filter(g => g && !noMentionGroups.includes(g)).map(g => validator.escape(String(g)));
+	const noMentionGroups = await getNoMentionGroups();
+	const filteredGroups = groups.filter(g => g && !noMentionGroups.includes(g))
+		.map(g => validator.escape(String(g)));
+
+	return filteredGroups;
 };
 
 SocketPlugins.mentions.userSearch = async (socket, data) => {
-	// Search by username
-	let { users } = await api.users.search(socket, data);
+	const allowed = await privileges.global.can('search:users', socket.uid);
+	if (!allowed) {
+		throw new Error('[[error:no-privileges]]');
+	}
 
-	if (!Meta.config.hideFullname) {
-		// Strip fullnames of users that do not allow their full name to be visible
-		users = await stripDisallowedFullnames(users);
+	const searchOpts = {
+		uid: socket.uid,
+		query: data.query,
+		sortBy: 'postcount',
+		hardCap: 1000,
+		paginate: true,
+		resultsPerPage: 100,
+	};
+
+	const [byUsername, byFullname, settings] = await Promise.all([
+		User.search({ ...searchOpts, searchBy: 'username' }),
+		!Meta.config.hideFullname ?
+			User.search({ ...searchOpts, searchBy: 'fullname' }) :
+			Promise.resolve({ users : [] }),
+		getSettings(),
+	]);
+
+	let { users } = byUsername;
 
-		// Search by fullname
-		let { users: fullnameUsers } = await api.users.search(socket, { query: data.query, searchBy: 'fullname' });
+	const [fullnameUsers] = await Promise.all([
 		// Hide results of users that do not allow their full name to be visible (prevents "enumeration attack")
-		fullnameUsers = await filterDisallowedFullnames(fullnameUsers);
+		filterDisallowedFullnames(byFullname.users),
+		// Strip fullnames of users that do not allow their full name to be visible
+		stripDisallowedFullnames(users),
+	]);
 
-		// Merge results, filter duplicates (from username search, leave fullname results)
-		users = users.filter(
-			userObj => fullnameUsers.filter(userObj2 => userObj.uid === userObj2.uid).length === 0
-		).concat(fullnameUsers);
-	}
+	// Merge results, filter duplicates (from username search, leave fullname results)
+	const fullnameUidSet = new Set(fullnameUsers.map(u => u.uid));
+	users = users.filter(u => !fullnameUidSet.has(u.uid)).concat(fullnameUsers);
+	users.sort((a, b) => b.postcount - a.postcount);
 
-	if (Mentions._settings.privilegedDirectReplies === 'on') {
+	if (settings.privilegedDirectReplies === 'on') {
 		if (data.composerObj) {
 			const cid = Topics.getTopicField(data.composerObj.tid, 'cid');
 			const filteredUids = await filterPrivilegedUids(users.map(userObj => userObj.uid), cid, data.composerObj.toPid);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodebb-plugin-mentions",
-  "version": "4.8.10",
+  "version": "4.8.12",
   "description": "NodeBB Plugin that allows users to mention other users by prepending an '@' sign to their username",
   "main": "library.js",
   "repository": {
@@ -30,8 +30,8 @@
     "validator": "^13.0.0"
   },
   "devDependencies": {
-    "eslint": "^9.25.1",
-    "eslint-config-nodebb": "^1.1.4",
+    "eslint": "^10.0.0",
+    "eslint-config-nodebb": "^2.0.0",
     "eslint-plugin-import": "^2.31.0",
     "mocha": "11.7.5"
   }

package/static/admin.js

@@ -6,30 +6,12 @@ define('admin/plugins/mentions', ['settings', 'alerts'], function (Settings, ale
 	ACP.init = function () {
 		Settings.load('mentions', $('.mentions-settings'));
 
-		$(window).on('action:admin.settingsLoaded', applyDefaults);
-
 		$('#save').on('click', function () {
 			Settings.save('mentions', $('.mentions-settings'), function () {
-				alerts.alert({
-					type: 'success',
-					alert_id: 'mentions-saved',
-					title: 'Settings Saved',
-					message: 'Please reload your NodeBB to apply these settings',
-					timeout: 5000,
-					clickfn: function () {
-						socket.emit('admin.reload');
-					},
-				});
+				alerts.success('Settings Saved');
 			});
 		});
 	};
 
-	function applyDefaults() {
-		if (!ajaxify.data.settings || !ajaxify.data.settings.hasOwnProperty('autofillGroups')) {
-			$('input#autofillGroups').parents('.mdl-switch').toggleClass('is-checked', false);
-			$('input#autofillGroups').prop('checked', false);
-		}
-	}
-
 	return ACP;
 });

package/static/autofill.js

@@ -8,6 +8,12 @@ $(document).ready(function () {
 	let localUserList = [];
 	let helpers;
 
+	function showAlert(type, message) {
+		require(['alerts'], function (alerts) {
+			alerts[type](message);
+		});
+	}
+
 	$(window).on('composer:autocomplete:init chat:autocomplete:init', function (ev, data) {
 		loadTopicUsers(data.element);
 
@@ -36,37 +42,30 @@ $(document).ready(function () {
 						composerObj: composer.posts[uuid],
 					}, function (err, users) {
 						if (err) {
-							require(['alerts'], function (alerts) {
-								alerts.alert({
-									id: 'mention-error',
-									type: 'danger',
-									message: err.message,
-									timeout: 5000,
-								});
-							});
+							showAlert('error', err.message);
 							return callback([]);
 						}
 						const termLowerCase = term.toLocaleLowerCase();
 						const localMatches = localUserList.filter(
 							u => u.username.toLocaleLowerCase().startsWith(termLowerCase)
 						);
-						const categoryMatches = categoryList.filter(c => c && c.handle && c.handle.startsWith(termLowerCase));
+						const categoryMatches = categoryList.filter(
+							c => c && c.handle && c.handle.startsWith(termLowerCase)
+						);
 
 						// remove local matches from search results, add category matches
 						users = users.filter(u => !localMatches.find(lu => lu.uid === u.uid));
-						users = sortEntries(localMatches).concat(sortEntries([...users, ...categoryMatches]));
-						// mentions = entriesToMentions(users, helpers);
+
+						users = sortEntries(localMatches).concat(users).concat(sortEntries(categoryMatches));
 
 						// Add groups that start with the search term
-						const groupMentions = groupList.filter(function (groupName) {
-							return groupName.toLocaleLowerCase().startsWith(termLowerCase);
-						}).sort(function (a, b) {
-							return a.toLocaleLowerCase() > b.toLocaleLowerCase() ? 1 : -1;
-						});
+						const groupMentions = groupList.filter(
+							group => group.name.toLocaleLowerCase().startsWith(termLowerCase) ||
+								group.slug.startsWith(termLowerCase)
+						).sort((a, b) =>a.name.toLocaleLowerCase() > b.name.toLocaleLowerCase() ? 1 : -1)
+							.map(group => group.name);
 
 						// Add group mentions at the bottom of dropdown
-						// mentions = mentions.concat(groupMentions);
-
 						callback([...users, ...groupMentions]);
 					});
 				});
@@ -86,6 +85,12 @@ $(document).ready(function () {
 		};
 
 		data.strategies.push(strategy);
+		data.options = {
+			...data.options,
+			...{
+				maxCount: 100,
+			},
+		};
 	});
 
 	$(window).on('action:composer.loaded', function (ev, data) {
@@ -121,7 +126,7 @@ $(document).ready(function () {
 	}
 
 	function loadTopicUsers(element) {
-		require(['composer', 'alerts'], function (composer, alerts) {
+		require(['composer'], function (composer) {
 			function findTid() {
 				const composerEl = element.parents('.composer').get(0);
 				if (composerEl) {
@@ -146,7 +151,7 @@ $(document).ready(function () {
 				tid: tid,
 			}, function (err, users) {
 				if (err) {
-					return alerts.error(err);
+					return showAlert('error', err);
 				}
 				localUserList = users;
 			});
@@ -154,14 +159,12 @@ $(document).ready(function () {
 	}
 
 	function loadGroupList() {
-		socket.emit('plugins.mentions.listGroups', function (err, groupNames) {
+		socket.emit('plugins.mentions.listGroups', async function (err, groupNames) {
 			if (err) {
-				require(['alerts'], function (alerts) {
-					alerts.error(err);
-				});
-				return;
+				return showAlert('error', err.message);
 			}
-			groupList = groupNames;
+			const s = await app.require('slugify');
+			groupList = groupNames.map(name => ({ name, slug: s(name) }));
 		});
 	}
 

package/test/index.js

@@ -38,7 +38,7 @@ describe('regex', () => {
 		it('should match a mention in all test strings', () => {
 			const matches = string.match(matcher);
 			assert(matches, `@testUser was not found in this string: ${string}`);
-			assert.equal(slugify(matches[0]), 'testuser');
+			assert(['@testuser', '@testuser.'].includes(slugify(matches[0])));
 		});
 	});
 
@@ -163,7 +163,7 @@ describe('parser', () => {
 	beforeEach(async () => {
 		slug = utils.generateUUID().slice(0, 10);
 		uid = await user.create({ username: slug });
-		emailUid = await user.create({ username: `${slug}@test.nodebb.org` });
+		// emailUid = await user.create({ username: `${slug}@test.nodebb.org` });
 	});
 
 	it('should properly parse both users even if one user\'s username is a subset of the other', async () => {
@@ -172,7 +172,7 @@ describe('parser', () => {
 
 		const html = await main.parseRaw(md);
 
-		assert.strictEqual(html, `This sentence contains two mentions: <a class="plugin-mentions-user plugin-mentions-a" href="http://127.0.0.1:4567/uid/1">@${slug}</a> and <a class="plugin-mentions-user plugin-mentions-a" href="http://127.0.0.1:4567/uid/2">@${slug}-two</a>`);
+		assert.strictEqual(html, `This sentence contains two mentions: <a class="plugin-mentions-user plugin-mentions-a" href="/user/${slug}" aria-label="Profile: ${slug}">@<bdi>${slug}</bdi></a> and <a class="plugin-mentions-user plugin-mentions-a" href="/user/${slug}-two" aria-label="Profile: ${slug}-two">@<bdi>${slug}-two</bdi></a>`);
 	});
 
 	strings.forEach((string) => {
@@ -180,8 +180,9 @@ describe('parser', () => {
 			const index = string.indexOf('@testUser');
 			let check = string;
 			if (!index || string[index - 1] !== '>') {
-				check = string.replace(/@testUser/g, `<a class="plugin-mentions-user plugin-mentions-a" href="http://127.0.0.1:4567/uid/${uid}">@${slug}</a>`);
-				string = string.replace(/testUser/g, slug);
+				check = string.replace(/@testUser\.?/g, `<a class="plugin-mentions-user plugin-mentions-a" href="/user/${slug}" aria-label="Profile: ${slug}">@<bdi>${slug}</bdi></a>`);
+				// check = string.replace(/@testUser/g, `<a class="plugin-mentions-user plugin-mentions-a" href="http://127.0.0.1:4567/uid/${uid}">@${slug}</a>`);
+				string = string.replace(/testUser\.?/g, slug);
 			}
 			const html = await main.parseRaw(string);
 
@@ -205,3 +206,15 @@ describe('parser', () => {
 		});
 	});
 });
+
+describe('.getMatches() edge cases', () => {
+	before(async function () {
+		this.slug = slugify(utils.generateUUID().slice(0, 8));
+		this.uid = await user.create({ username: this.slug });
+	});
+
+	it('should match a mention at the end of a sentence', async function () {
+		const matches = await main.getMatches(`test sentence @${this.slug}.`);
+		console.log(matches);
+	});
+});