nodebb-plugin-mentions 4.8.11 → 4.8.13

package/LICENSE

@@ -1,8 +1,8 @@
-Copyright (c) 2013-2014, Julian Lam <julian@designcreateplay.com>
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+Copyright (c) 2013-2014, Julian Lam <julian@designcreateplay.com>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -1,14 +1,14 @@
-# Username/Group Mentions
-
-This NodeBB plugin allows posters to reference (or *mention*) other users or groups on a NodeBB by simply
-precluding the `@` symbol before a username.
-
-A link is automatically added to the post.
-
-## Installation
-
-This plugin is bundled with every NodeBB install. If not, you can install it via the Plugins page of the ACP.
-
-Alternatively,
-
+# Username/Group Mentions
+
+This NodeBB plugin allows posters to reference (or *mention*) other users or groups on a NodeBB by simply
+precluding the `@` symbol before a username.
+
+A link is automatically added to the post.
+
+## Installation
+
+This plugin is bundled with every NodeBB install. If not, you can install it via the Plugins page of the ACP.
+
+Alternatively,
+
     npm install nodebb-plugin-mentions

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,6 +26,7 @@ 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');
 
@@ -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,
@@ -480,9 +484,10 @@ Mentions.parseRaw = async (content, type = 'default') => {
 		}
 	}));
 
+
 	replacements = Array.from(replacements)
 		.sort((a, b) => {
-			return b.user.userslug.length - a.user.userslug.length;
+			return b.user && a.user ? b.user.userslug.length - a.user.userslug.length : 0;
 		})
 		.forEach(({ match, url, user, mentionType }) => {
 			const regex = isLatinMention.test(match) ?
@@ -502,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;
@@ -514,9 +519,9 @@ 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;
@@ -562,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;
 	});
 }
 
@@ -587,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(),
+	]);
 
-		// Search by fullname
-		let { users: fullnameUsers } = await api.users.search(socket, { query: data.query, searchBy: 'fullname' });
+	let { users } = byUsername;
+
+	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.11",
+  "version": "4.8.13",
   "description": "NodeBB Plugin that allows users to mention other users by prepending an '@' sign to their username",
   "main": "library.js",
   "repository": {

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) }));
 		});
 	}