nodebb-plugin-mentions 2.14.1 → 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodebb-plugin-mentions",
-  "version": "2.14.1",
+  "version": "3.0.0",
   "description": "NodeBB Plugin that allows users to mention other users by prepending an '@' sign to their username",
   "main": "library.js",
   "scripts": {
@@ -25,12 +25,15 @@
     "compatibility": "^1.15.0"
   },
   "dependencies": {
-    "async": "^2",
-    "html-entities": "^1.2.1",
-    "validator": "^9.1.1",
+    "html-entities": "^2.3.2",
+    "lodash": "4.17.21",
+    "validator": "^13.0.0",
     "xregexp": "^5.1.0"
   },
   "devDependencies": {
-    "mocha": "9.1.2"
+    "mocha": "9.1.3",
+    "eslint": "8.1.0",
+    "eslint-config-nodebb": "^0.0.3",
+    "eslint-plugin-import": "^2.24.2"
   }
 }

package/plugin.json

@@ -1,27 +1,31 @@
-{
-	"id": "nodebb-plugin-mentions",
-	"name": "Username Mentions",
-	"description": "NodeBB Plugin that allows users to mention other users by prepending an '@' sign to their username",
-	"url": "https://github.com/julianlam/nodebb-plugin-mentions",
-	"library": "./library.js",
-	"hooks": [
-		{ "hook": "static:app.load", "method": "init" },
-		{ "hook": "filter:admin.header.build", "method": "addAdminNavigation" },
-		{ "hook": "filter:parse.post", "method": "parsePost" },
-		{ "hook": "filter:parse.raw", "method": "parseRaw" },
-		{ "hook": "action:post.save", "method": "notify" },
-		{ "hook": "action:post.edit", "method": "notify" },
-		{ "hook": "filter:notifications.addFilters", "method": "addFilters" },
-		{ "hook": "filter:user.notificationTypes", "method": "notificationTypes" },
-		{ "hook": "filter:users.addFields", "method": "addFields" }
-	],
-	"scripts": [
-		"static/autofill.js"
-	],
-	"acpScripts": [
-		"static/admin.js"
-	],
-	"languages": "languages",
-	"defaultLang": "en_GB",
-	"templates": "templates"
+{
+	"id": "nodebb-plugin-mentions",
+	"name": "Username Mentions",
+	"description": "NodeBB Plugin that allows users to mention other users by prepending an '@' sign to their username",
+	"url": "https://github.com/julianlam/nodebb-plugin-mentions",
+	"library": "./library.js",
+	"upgrades": [
+        "upgrades/mentions_delete_mentions_set_zset.js"
+    ],
+	"hooks": [
+		{ "hook": "static:app.load", "method": "init" },
+		{ "hook": "filter:admin.header.build", "method": "addAdminNavigation" },
+		{ "hook": "filter:parse.post", "method": "parsePost" },
+		{ "hook": "filter:parse.raw", "method": "parseRaw" },
+		{ "hook": "action:post.save", "method": "notify" },
+		{ "hook": "action:post.edit", "method": "notify" },
+		{ "hook": "action:post.purge", "method": "actionPostPurge" },
+		{ "hook": "filter:notifications.addFilters", "method": "addFilters" },
+		{ "hook": "filter:user.notificationTypes", "method": "notificationTypes" },
+		{ "hook": "filter:users.addFields", "method": "addFields" }
+	],
+	"scripts": [
+		"static/autofill.js"
+	],
+	"acpScripts": [
+		"static/admin.js"
+	],
+	"languages": "languages",
+	"defaultLang": "en_GB",
+	"templates": "templates"
 }

package/static/admin.js

@@ -1,36 +1,36 @@
-'use strict';
-/* globals $, app, socket */
-
-define('admin/plugins/mentions', ['settings'], function (Settings) {
-
-	var ACP = {};
-
-	ACP.init = function () {
-		Settings.load('mentions', $('.mentions-settings'));
-
-		$(window).on('action:admin.settingsLoaded', applyDefaults);
-
-		$('#save').on('click', function () {
-			Settings.save('mentions', $('.mentions-settings'), function () {
-				app.alert({
-					type: 'success',
-					alert_id: 'mentions-saved',
-					title: 'Settings Saved',
-					message: 'Please reload your NodeBB to apply these settings',
-					clickfn: function () {
-						socket.emit('admin.reload');
-					}
-				});
-			});
-		});
-	};
-
-	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;
+'use strict';
+/* globals $, app, socket */
+
+define('admin/plugins/mentions', ['settings'], function (Settings) {
+
+	var ACP = {};
+
+	ACP.init = function () {
+		Settings.load('mentions', $('.mentions-settings'));
+
+		$(window).on('action:admin.settingsLoaded', applyDefaults);
+
+		$('#save').on('click', function () {
+			Settings.save('mentions', $('.mentions-settings'), function () {
+				app.alert({
+					type: 'success',
+					alert_id: 'mentions-saved',
+					title: 'Settings Saved',
+					message: 'Please reload your NodeBB to apply these settings',
+					clickfn: function () {
+						socket.emit('admin.reload');
+					}
+				});
+			});
+		});
+	};
+
+	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/templates/admin/plugins/mentions.tpl

@@ -1,65 +1,65 @@
-<form role="form" class="mentions-settings">
-	<div class="row">
-		<div class="col-sm-2 col-xs-12 settings-header">General</div>
-		<div class="col-sm-10 col-xs-12">
-			<div class="form-group">
-				<div class="checkbox">
-					<label for="autofillGroups" class="mdl-switch mdl-js-switch mdl-js-ripple-effect">
-						<input type="checkbox" class="mdl-switch__input" id="autofillGroups" name="autofillGroups" />
-						<span class="mdl-switch__label">Allow mentioning User Groups</span>
-					</label>
-				</div>
-			</div>
-			<div class="form-group">
-				<div class="checkbox">
-					<label for="overrideIgnores" class="mdl-switch mdl-js-switch mdl-js-ripple-effect">
-						<input type="checkbox" class="mdl-switch__input" id="overrideIgnores" name="overrideIgnores" />
-						<span class="mdl-switch__label">Notify recipients of mentions even if topic is explictly ignored</span>
-					</label>
-				</div>
-			</div>
-			<div class="form-group">
-				<label for="disableGroupMentions">Select groups you wish to disable mentions</label>
-				<select class="form-control" id="disableGroupMentions" name="disableGroupMentions" multiple>
-					<!-- BEGIN groups -->
-					<option value="{groups.displayName}">{groups.displayName}</option>
-					<!-- END groups -->
-				</select>
-			</div>
-			<div class="form-group">
-				<label for="display">Mentions will display ...</label>
-				<select class="form-control" id="display" name="display">
-					<option value="">... as written</option>
-					<option value="fullname">... as user&apos;s full name (if set)</option>
-					<option value="username">... as user&apos;s username</option>
-				</select>
-			</div>
-		</div>
-	</div>
-
-	<div class="row">
-		<div class="col-sm-2 col-xs-12 settings-header">Restrictions</div>
-		<div class="col-sm-10 col-xs-12">
-			<div class="form-group">
-				<div class="checkbox">
-					<label for="disableFollowedTopics" class="mdl-switch mdl-js-switch mdl-js-ripple-effect">
-						<input type="checkbox" class="mdl-switch__input" id="disableFollowedTopics" name="disableFollowedTopics" />
-						<span class="mdl-switch__label">Disable mentions for followed topics</span>
-					</label>
-				</div>
-			</div>
-			<div class="form-group">
-				<div class="checkbox">
-					<label for="privilegedDirectReplies" class="mdl-switch mdl-js-switch mdl-js-ripple-effect">
-						<input type="checkbox" class="mdl-switch__input" id="privilegedDirectReplies" name="privilegedDirectReplies" />
-						<span class="mdl-switch__label">Restrict mentions to privileged users (mods, global mods, administrators), unless it is a direct reply to a post</span>
-					</label>
-				</div>
-			</div>
-		</div>
-	</div>
-</form>
-
-<button id="save" class="floating-button mdl-button mdl-js-button mdl-button--fab mdl-js-ripple-effect mdl-button--colored">
-	<i class="material-icons">save</i>
+<form role="form" class="mentions-settings">
+	<div class="row">
+		<div class="col-sm-2 col-xs-12 settings-header">General</div>
+		<div class="col-sm-10 col-xs-12">
+			<div class="form-group">
+				<div class="checkbox">
+					<label for="autofillGroups" class="mdl-switch mdl-js-switch mdl-js-ripple-effect">
+						<input type="checkbox" class="mdl-switch__input" id="autofillGroups" name="autofillGroups" />
+						<span class="mdl-switch__label">Allow mentioning User Groups</span>
+					</label>
+				</div>
+			</div>
+			<div class="form-group">
+				<div class="checkbox">
+					<label for="overrideIgnores" class="mdl-switch mdl-js-switch mdl-js-ripple-effect">
+						<input type="checkbox" class="mdl-switch__input" id="overrideIgnores" name="overrideIgnores" />
+						<span class="mdl-switch__label">Notify recipients of mentions even if topic is explictly ignored</span>
+					</label>
+				</div>
+			</div>
+			<div class="form-group">
+				<label for="disableGroupMentions">Select groups you wish to disable mentions</label>
+				<select class="form-control" id="disableGroupMentions" name="disableGroupMentions" multiple>
+					<!-- BEGIN groups -->
+					<option value="{groups.displayName}">{groups.displayName}</option>
+					<!-- END groups -->
+				</select>
+			</div>
+			<div class="form-group">
+				<label for="display">Mentions will display ...</label>
+				<select class="form-control" id="display" name="display">
+					<option value="">... as written</option>
+					<option value="fullname">... as user&apos;s full name (if set)</option>
+					<option value="username">... as user&apos;s username</option>
+				</select>
+			</div>
+		</div>
+	</div>
+
+	<div class="row">
+		<div class="col-sm-2 col-xs-12 settings-header">Restrictions</div>
+		<div class="col-sm-10 col-xs-12">
+			<div class="form-group">
+				<div class="checkbox">
+					<label for="disableFollowedTopics" class="mdl-switch mdl-js-switch mdl-js-ripple-effect">
+						<input type="checkbox" class="mdl-switch__input" id="disableFollowedTopics" name="disableFollowedTopics" />
+						<span class="mdl-switch__label">Disable mentions for followed topics</span>
+					</label>
+				</div>
+			</div>
+			<div class="form-group">
+				<div class="checkbox">
+					<label for="privilegedDirectReplies" class="mdl-switch mdl-js-switch mdl-js-ripple-effect">
+						<input type="checkbox" class="mdl-switch__input" id="privilegedDirectReplies" name="privilegedDirectReplies" />
+						<span class="mdl-switch__label">Restrict mentions to privileged users (mods, global mods, administrators), unless it is a direct reply to a post</span>
+					</label>
+				</div>
+			</div>
+		</div>
+	</div>
+</form>
+
+<button id="save" class="floating-button mdl-button mdl-js-button mdl-button--fab mdl-js-ripple-effect mdl-button--colored">
+	<i class="material-icons">save</i>
 </button>

package/upgrades/mentions_delete_mentions_set_zset.js

@@ -0,0 +1,21 @@
+'use strict';
+
+
+const db = module.parent.require('./database');
+const batch = module.parent.require('./batch');
+module.exports = {
+	name: 'Delete mentions:sent:<pid> sorted sets',
+	timestamp: Date.UTC(2021, 10, 2),
+	method: async function () {
+        const nextPid = await db.getObjectField('global', 'nextPid');
+        const allPids = [];
+        for (let pid = 1; pid < nextPid; ++ pid) {
+            allPids.push(pid);
+        }
+        await batch.processArray(allPids, async (pids) => {
+            await db.deleteAll(pids.map(pid => `mentions:sent:${pid}`));
+        }, {
+            batch: 500,
+        });
+	},
+};

package/.jshintrc

@@ -1,86 +0,0 @@
-{
-    // JSHint Default Configuration File (as on JSHint website)
-    // See http://jshint.com/docs/ for more details
-
-    "maxerr" : 50, // {int} Maximum error before stopping
-
-    // Enforcing
-    "bitwise" : true, // true: Prohibit bitwise operators (&, |, ^, etc.)
-    "camelcase" : false, // true: Identifiers must be in camelCase
-    "curly" : true, // true: Require {} for every new block or scope
-    "eqeqeq" : true, // true: Require triple equals (===) for comparison
-    "forin" : true, // true: Require filtering for..in loops with obj.hasOwnProperty()
-    "immed" : false, // true: Require immediate invocations to be wrapped in parens e.g. `(function () { } ());`
-    "indent" : 4, // {int} Number of spaces to use for indentation
-    "latedef" : false, // true: Require variables/functions to be defined before being used
-    "newcap" : false, // true: Require capitalization of all constructor functions e.g. `new F()`
-    "noarg" : true, // true: Prohibit use of `arguments.caller` and `arguments.callee`
-    "noempty" : true, // true: Prohibit use of empty blocks
-    "nonew" : false, // true: Prohibit use of constructors for side-effects (without assignment)
-    "plusplus" : false, // true: Prohibit use of `++` & `--`
-    "quotmark" : false, // Quotation mark consistency:
-                                // false : do nothing (default)
-                                // true : ensure whatever is used is consistent
-                                // "single" : require single quotes
-                                // "double" : require double quotes
-    "undef" : true, // true: Require all non-global variables to be declared (prevents global leaks)
-    "unused" : true, // true: Require all defined variables be used
-    "strict" : true, // true: Requires all functions run in ES5 Strict Mode
-    "trailing" : false, // true: Prohibit trailing whitespaces
-    "maxparams" : false, // {int} Max number of formal params allowed per function
-    "maxdepth" : false, // {int} Max depth of nested blocks (within functions)
-    "maxstatements" : false, // {int} Max number statements per function
-    "maxcomplexity" : false, // {int} Max cyclomatic complexity per function
-    "maxlen" : false, // {int} Max number of characters per line
-
-    // Relaxing
-    "asi" : false, // true: Tolerate Automatic Semicolon Insertion (no semicolons)
-    "boss" : false, // true: Tolerate assignments where comparisons would be expected
-    "debug" : false, // true: Allow debugger statements e.g. browser breakpoints.
-    "eqnull" : false, // true: Tolerate use of `== null`
-    "es5" : false, // true: Allow ES5 syntax (ex: getters and setters)
-    "esnext" : false, // true: Allow ES.next (ES6) syntax (ex: `const`)
-    "moz" : false, // true: Allow Mozilla specific syntax (extends and overrides esnext features)
-                                 // (ex: `for each`, multiple try/catch, function expression…)
-    "evil" : false, // true: Tolerate use of `eval` and `new Function()`
-    "expr" : false, // true: Tolerate `ExpressionStatement` as Programs
-    "funcscope" : false, // true: Tolerate defining variables inside control statements"
-    "globalstrict" : false, // true: Allow global "use strict" (also enables 'strict')
-    "iterator" : false, // true: Tolerate using the `__iterator__` property
-    "lastsemic" : false, // true: Tolerate omitting a semicolon for the last statement of a 1-line block
-    "laxbreak" : false, // true: Tolerate possibly unsafe line breakings
-    "laxcomma" : false, // true: Tolerate comma-first style coding
-    "loopfunc" : false, // true: Tolerate functions being defined in loops
-    "multistr" : false, // true: Tolerate multi-line strings
-    "proto" : false, // true: Tolerate using the `__proto__` property
-    "scripturl" : false, // true: Tolerate script-targeted URLs
-    "smarttabs" : false, // true: Tolerate mixed tabs/spaces when used for alignment
-    "shadow" : false, // true: Allows re-define variables later in code e.g. `var x=1; x=2;`
-    "sub" : false, // true: Tolerate using `[]` notation when it can still be expressed in dot notation
-    "supernew" : false, // true: Tolerate `new function () { ... };` and `new Object;`
-    "validthis" : false, // true: Tolerate using this in a non-constructor function
-
-    // Environments
-    "browser" : true, // Web Browser (window, document, etc)
-    "couch" : false, // CouchDB
-    "devel" : true, // Development/debugging (alert, confirm, etc)
-    "dojo" : false, // Dojo Toolkit
-    "jquery" : true, // jQuery
-    "mootools" : false, // MooTools
-    "node" : true, // Node.js
-    "nonstandard" : false, // Widely adopted globals (escape, unescape, etc)
-    "prototypejs" : false, // Prototype and Scriptaculous
-    "rhino" : false, // Rhino
-    "worker" : false, // Web Workers
-    "wsh" : false, // Windows Scripting Host
-    "yui" : false, // Yahoo User Interface
-
-    // Legacy
-    "nomen" : false, // true: Prohibit dangling `_` in variables
-    "onevar" : false, // true: Allow only one `var` statement per function
-    "passfail" : false, // true: Stop on first error
-    "white" : false, // true: Check against strict whitespace and indentation rules
-
-    // Custom Globals
-    "globals" : {} // additional predefined global variables
-}