nodebb-plugin-markdown 12.2.8 → 13.0.0-pre.10

package/.jshintrc

@@ -1,86 +1,86 @@
-{
-    // 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
+{
+    // 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
 }

package/README.md

@@ -1,9 +1,9 @@
-# NodeBB Markdown Parser
-
-This NodeBB plugin is a parser that allows users to write posts using [Markdown](https://daringfireball.net/projects/markdown/).
-
-To customise options for the parser, please consult the "Markdown" page in the administration panel, under the "Plugins" heading.
-
-## Installation
-
-    npm install nodebb-plugin-markdown
+# NodeBB Markdown Parser
+
+This NodeBB plugin is a parser that allows users to write posts using [Markdown](https://daringfireball.net/projects/markdown/).
+
+To customise options for the parser, please consult the "Markdown" page in the administration panel, under the "Plugins" heading.
+
+## Installation
+
+    npm install nodebb-plugin-markdown

package/index.js

@@ -7,9 +7,9 @@ const path = require('path');
 const nconf = require.main.require('nconf');
 const winston = require.main.require('winston');
 const meta = require.main.require('./src/meta');
+const activitypub = require.main.require('./src/activitypub');
 const translator = require.main.require('./src/translator');
 const plugins = require.main.require('./src/plugins');
-const cacheCreate = require.main.require('./src/cacheCreate');
 
 const SocketPlugins = require.main.require('./src/socket.io/plugins');
 SocketPlugins.markdown = require('./websockets');
@@ -133,9 +133,10 @@ const Markdown = {
 
 	parsePost: async function (data) {
 		const env = await Markdown.beforeParse(data);
-		if (data && data.postData && data.postData.content && parser) {
+		if (env.parse && data && data.postData && data.postData.content && parser) {
 			data.postData.content = parser.render(data.postData.content, env || {});
 		}
+
 		return Markdown.afterParse(data);
 	},
 
@@ -157,11 +158,25 @@ const Markdown = {
 		return Markdown.afterParse(raw);
 	},
 
-	beforeParse: async (/* data */) => {
-		const env = {
-			images: new Map(),
+	beforeParse: async (data) => {
+		let env = {
+			parse: true,
+			type: data.type,
+			images: new Map(), // is this still used?
 		};
 
+		({ env } = await plugins.hooks.fire('filter:markdown.beforeParse', { env, data: Object.freeze({ ...data }) }));
+
+		if (activitypub.helpers.isUri(data.postData.pid)) {
+			if (data.postData.sourceContent) {
+				data.content = data.sourceContent;
+				delete data.sourceContent;
+			} else {
+				// content contained is likely already html, bypass parsing
+				env.parse = false;
+			}
+		}
+
 		return env;
 	},
 
@@ -283,6 +298,10 @@ const Markdown = {
 		parser.renderer.rules.image = function (tokens, idx, options, env, self) {
 			const token = tokens[idx];
 			const attributes = new Map(token.attrs);
+			if (env.type === 'plaintext') {
+				const filename = path.basename(attributes.get('src'));
+				return `[image: ${filename}]`;
+			}
 
 			// Validate the url
 			if (!Markdown.isUrlValid(attributes.get('src'))) { return ''; }
@@ -293,6 +312,10 @@ const Markdown = {
 		};
 
 		parser.renderer.rules.link_open = function (tokens, idx, options, env, self) {
+			if (env.type === 'plaintext') {
+				return '';
+			}
+
 			const attributes = new Map(tokens[idx].attrs);
 
 			if (attributes.has('href') && Markdown.isExternalLink(attributes.get('href'))) {
@@ -326,6 +349,15 @@ const Markdown = {
 			return renderLink(tokens, idx, options, env, self);
 		};
 
+		parser.renderer.rules.link_close = function (...args) {
+			const [,,, env, self] = args;
+			if (env === 'plaintext') {
+				return '';
+			}
+
+			return self.renderToken(...args);
+		};
+
 		parser.renderer.rules.table_open = function (tokens, idx, options, env, self) {
 			const classIdx = tokens[idx].attrIndex('class');