feat: add illegal usernames as well

Author: barisusakli

index.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const validator = require('validator');
 var winston = require.main.require('winston');
 var meta = require.main.require('./src/meta');
 
@@ -25,6 +26,7 @@ var Beep = {
 	banned_words: null,
 	banned_urls: null,
 	illegal_words: null,
+	illegal_usernames: null,
 
 	parseContent: function (content, symbol) {
 		var nil = '^(?!x)x';
@@ -39,6 +41,7 @@ var Beep = {
 			}
 
 			Beep.illegal_words = Beep.toRegExp(hash.illegal, true);
+			Beep.illegal_usernames = Beep.toRegExp(hash['illegal-usernames'], true);
 
 			if (hash.id && hash.id.length) {
 				var words = hash.id.split(',').filter(function (word) {
@@ -146,17 +149,17 @@ var Beep = {
 		// from http://htmlarrows.com/symbols/
 		var starHTML = '*';
 
-    if (data.topic.hasOwnProperty('title')) {
-      data.topic.title = Beep.parseContent(data.topic.title, starHTML);
-    }
+		if (data.topic.hasOwnProperty('title')) {
+			data.topic.title = Beep.parseContent(data.topic.title, starHTML);
+		}
 
-    if (data.topic.hasOwnProperty('slug')) {
-      data.topic.slug = Beep.parseContent(data.topic.slug, starHTML);
-    }
+		if (data.topic.hasOwnProperty('slug')) {
+			data.topic.slug = Beep.parseContent(data.topic.slug, starHTML);
+		}
 
-    if (data.topic.hasOwnProperty('titleRaw')) {
-      data.topic.titleRaw = Beep.parseContent(data.topic.titleRaw, starHTML);
-    }
+		if (data.topic.hasOwnProperty('titleRaw')) {
+			data.topic.titleRaw = Beep.parseContent(data.topic.titleRaw, starHTML);
+		}
 
 		callback(null, data);
 	},
@@ -206,6 +209,16 @@ var Beep = {
 			callback(null, data);
 		},
 	},
+	filterUserCreate: function (hookData) {
+		const { user } = hookData;
+		if (user && user.username) {
+			const isIllegal = user.username.match(Beep.illegal_usernames);
+			if (isIllegal) {
+				throw new Error(`[[beep:username.error, ${validator.escape(user.username)}]]`);
+			}
+		}
+		return hookData;
+	},
 };
 
 module.exports = Beep;

languages/en_GB/beep.json

@@ -1,5 +1,6 @@
 {
 	"titleMatch.error": "You may not use the word \"%1\" in your title.",
 	"contentMatch.error": "You may not use the word \"%1\" in your post.",
-	"tagMatch.error": "You may not use the word \"%1\" in your tags."
+	"tagMatch.error": "You may not use the word \"%1\" in your tags.",
+	"username.error": "You may not use the word \"%1\" as your username."
 }

package-lock.json

@@ -1,15 +1,14 @@
 {
   "name": "@nodebb/nodebb-plugin-beep",
   "version": "1.0.0",
-  "description": "NodeBB Censor Curse Words Plugin",
-  "deprecated": false,
+  "description": "NodeBB Plugin that allows users to censor curse words in their posts.",
   "main": "index.js",
   "scripts": {
     "test": "node tests"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/ninenine/nodebb-plugin-beep"
+    "url": "https://github.com/NodeBB-Community/nodebb-plugin-beep"
   },
   "keywords": [
     "nodebb",
@@ -19,17 +18,18 @@
     "curse",
     "words"
   ],
+  "dependencies": {
+    "validator": "13.11.0"
+  },
   "author": {
     "name": "Davis Wainaina",
     "email": "davisjwn@gmail.com"
   },
   "license": "BSD-2-Clause",
   "bugs": {
-    "url": "https://github.com/ninenine/nodebb-plugin-beep/issues"
+    "url": "https://github.com/NodeBB-Community/nodebb-plugin-beep/issues"
   },
-  "readme": "",
   "readmeFilename": "README.md",
-  "_from": "nodebb-plugin-beep@0.4.4",
   "nbbpm": {
     "compatibility": "^3.2.0"
   }

package.json

@@ -1,8 +1,4 @@
 {
-	"id": "nodebb-plugin-beep",
-	"name": "NodeBB Censor Curse Words Plugin",
-	"description": "NodeBB Plugin that allows users to censor curse words in their posts.",
-	"url": "https://github.com/ninenine/nodebb-plugin-beep",
 	"library": "./index.js",
 	"templates":"public/templates",
 	"modules": {
@@ -29,7 +25,9 @@
 
 		{ "hook": "filter:config.get", "method": "appendConfig" },
 
-		{ "hook": "filter:messaging.getTeaser", "method": "messaging.getTeaser" }
+		{ "hook": "filter:messaging.getTeaser", "method": "messaging.getTeaser" },
+
+		{ "hook": "filter:user.create", "method": "filterUserCreate" }
 	],
 	"languages": "languages",
 	"defaultLang": "en_GB"

plugin.json

@@ -11,6 +11,13 @@
 						<textarea class="form-control" id="illegal" name="illegal" placeholder="eg. anal, anus, arse, ass, ballsack" rows="6"></textarea>
 					</div>
 				</div>
+				<div class="mb-3">
+					<h5 class="fw-bold tracking-tight settings-header">Illegal Usernames</h5>
+					<div>
+						<label class="form-label" for="illegal-usernames"><i>comma-separated</i> list of Illegal Usernames (user creation will not be allowed)</label>
+						<textarea class="form-control" id="illegal-usernames" name="illegal-usernames" placeholder="eg. anal, anus, arse, ass, ballsack" rows="6"></textarea>
+					</div>
+				</div>
 				<div class="mb-3">
 					<h5 class="fw-bold tracking-tight settings-header">Banned Words</h5>