nodebb-plugin-audio-embed 2.0.1 → 3.0.0

package/eslint.config.mjs

@@ -0,0 +1,10 @@
+'use strict';
+
+import serverConfig from 'eslint-config-nodebb';
+import publicConfig from 'eslint-config-nodebb/public';
+
+export default [
+	...publicConfig,
+	...serverConfig,
+];
+

package/lib/controllers.js

@@ -1,25 +1,67 @@
 'use strict';
 
+const fs = require('fs').promises;
+const path = require('path');
+
+const nconf = nodebb.require('nconf');
+const db = nodebb.require('./src/database');
+
 const Controllers = module.exports;
 
-Controllers.renderAdminPage = function (req, res, next) {
+Controllers.renderAdminPage = function (req, res) {
 	res.render('admin/plugins/audio-embed', {
 		title: 'Audio Embed',
 	});
 };
 
-Controllers.upload = function(req, res, next) {
-	var main = module.parent.exports;
-
-	main.processUpload(req.files.files[0], function(err, payload) {
-		if (!err) {
-			res.json([{
-				url: payload.id
-			}]);
-		} else {
-			res.json({
-				error: err.message === 'invalid-file-type' ? 'Invalid File Type Uploaded. Please check the file format or extension to ensure it is an audio file.' : 'An unknown error occured'
-			});
-		}
-	});
+Controllers.upload = async function (req, res) {
+	try {
+		const payload = await processUpload(req.files[0]);
+		res.json([{
+			url: payload.id,
+		}]);
+	} catch (err) {
+		res.status(400);
+		res.json({
+			error: err.message === 'invalid-file-type' ?
+				'Invalid File Type Uploaded. Please check the file format or extension to ensure it is an audio file.' :
+				err.message,
+		});
+	}
 };
+
+async function processUpload(payload) {
+	if (!payload || !payload.path || !payload.name || !payload.size) {
+		throw new Error('invalid-file');
+	}
+	if (!payload.type.startsWith('audio/')) {
+		throw new Error('invalid-file-type');
+	}
+
+	const id = path.basename(payload.path);
+	const uploadPath = path.join(nconf.get('upload_path'), 'audio-embed', id);
+
+	await move(payload.path, uploadPath);
+	await db.setObject('audio-embed:id:' + id, {
+		name: payload.name,
+		size: payload.size,
+	});
+	await db.sortedSetAdd('audio-embed:date', +new Date(), id);
+
+	return {
+		id: id,
+	};
+}
+
+async function move(path, uploadPath) {
+	try {
+		await fs.rename(path, uploadPath);
+	} catch (err) {
+		if (err.code !== 'EXDEV') {
+			throw err;
+		}
+
+		await fs.copyFile(path, uploadPath);
+		await fs.unlink(path);
+	}
+}

package/library.js

@@ -1,121 +1,90 @@
-"use strict";
-/* globals require, module */
+'use strict';
 
-var path = require('path'),
-    fs = require('fs'),
-    mkdirp = require('mkdirp'),
-    mv = require('mv'),
-    async = require('async'),
-    nconf = require.main.require('nconf');
+const path = require('path');
+const { mkdirp } = require('mkdirp');
 
-var db = require.main.require('./src/database');
+const nconf = nodebb.require('nconf');
 
-var controllers = require('./lib/controllers');
+const db = nodebb.require('./src/database');
+const routeHelpers = nodebb.require('./src/routes/helpers');
 
-var plugin = {
-        embedRegex: /\[audio\/([\w\-_.]+)\]/g
-    },
-    app;
+const controllers = require('./lib/controllers');
 
-plugin.init = function(params, callback) {
-    var router = params.router,
-        hostMiddleware = params.middleware,
-        multiparty = require.main.require('connect-multiparty')();
+const plugin = {
+	embedRegex: /\[audio\/([\w\-_.]+)\]/g,
+};
+let app;
 
-    app = params.app;
+plugin.init = async function (params) {
+	const { router, middleware } = params;
 
-    router.get('/admin/plugins/audio-embed', hostMiddleware.admin.buildHeader, controllers.renderAdminPage);
-    router.get('/api/admin/plugins/audio-embed', controllers.renderAdminPage);
-    router.post('/plugins/nodebb-plugin-audio-embed/upload', multiparty, hostMiddleware.validateFiles, hostMiddleware.applyCSRF, controllers.upload);
+	app = params.app;
 
-    mkdirp(path.join(nconf.get('upload_path'), 'audio-embed'), callback);
-};
+	routeHelpers.setupAdminPageRoute(router, '/admin/plugins/audio-embed', controllers.renderAdminPage);
 
-plugin.addAdminNavigation = function(header, callback) {
-    header.plugins.push({
-        route: '/plugins/audio-embed',
-        icon: 'fa-volume-up',
-        name: 'Audio Embed'
-    });
+	const upload = nodebb.require('./src/middleware/multer');
 
-    callback(null, header);
-};
+	router.post('/plugins/nodebb-plugin-audio-embed/upload', upload.any(), middleware.validateFiles, middleware.applyCSRF, routeHelpers.tryRoute(controllers.upload));
 
-plugin.registerFormatting = function(payload, callback) {
-    payload.options.push({ name: 'audio-embed', className: 'fa fa-file-audio-o' });
-    callback(null, payload);
+	await mkdirp(path.join(nconf.get('upload_path'), 'audio-embed'));
 };
 
-plugin.processUpload = function(payload, callback) {
-    if (payload.type.startsWith('audio/')) {
-        var id = path.basename(payload.path),
-            uploadPath = path.join(nconf.get('upload_path'), 'audio-embed', id);
-
-        async.waterfall([
-            async.apply(mv, payload.path, uploadPath),
-            async.apply(db.setObject, 'audio-embed:id:' + id, {
-                name: payload.name,
-                size: payload.size
-            }),
-            async.apply(db.sortedSetAdd, 'audio-embed:date', +new Date(), id)
-        ], function(err) {
-            if (err) {
-                return callback(err);
-            }
-
-            callback(null, {
-                id: id
-            });
-        });
-    } else {
-        callback(new Error('invalid-file-type'));
-    }
+plugin.addAdminNavigation = function (header) {
+	header.plugins.push({
+		route: '/plugins/audio-embed',
+		icon: 'fa-volume-up',
+		name: 'Audio Embed',
+	});
+	return header;
 };
 
-plugin.parsePost = function(data, callback) {
-    if (!data || !data.postData || !data.postData.content) {
-        return callback(null, data);
-    }
+plugin.registerFormatting = function (payload) {
+	payload.options.push({
+		name: 'audio-embed',
+		className: 'fa fa-file-audio-o',
+		title: 'Embed Audio',
+	});
+	return payload;
+};
 
-    plugin.parseRaw(data.postData.content, function(err, content) {
-        if (err) {
-            return callback(err);
-        }
+plugin.parsePost = async function (data) {
+	if (!data || !data.postData || !data.postData.content) {
+		return data;
+	}
 
-        data.postData.content = content;
-        callback(null, data);
-    });
+	data.postData.content = await plugin.parseRaw(data.postData.content);
+	return data;
 };
 
-plugin.parseRaw = function(content, callback) {
-    var matches = content.match(plugin.embedRegex);
-
-    if (!matches) {
-        return callback(null, content);
-    }
-
-    // Filter out duplicates
-    matches = matches.filter(function(match, idx) {
-        return idx === matches.indexOf(match);
-    }).map(function(match) {
-        return match.slice(7, -1);
-    });
-
-    async.filter(matches, plugin.exists, function(err, ids) {
-        async.reduce(ids, content, function(content, id, next) {
-            app.render('partials/audio-embed', {
-                id: id,
-                path: path.join(nconf.get('relative_path'), '/uploads/audio-embed', id)
-            }, function(err, html) {
-                content = content.replace('[audio/' + id + ']', html);
-                next(err, content);
-            });
-        }, callback);
-    });
+plugin.parseRaw = async function (content) {
+	const matches = [...new Set(content.match(plugin.embedRegex) || [])]
+		.map(match => match.slice(7, -1));
+
+	if (!matches.length) {
+		return content;
+	}
+
+	const existence = await db.isSortedSetMembers('audio-embed:date', matches);
+	const ids = matches.filter((id, index) => existence[index]);
+
+	let parsedContent = content;
+	const renderedEmbeds = await Promise.all(ids.map(async id => ({
+		id,
+		html: await app.renderAsync('partials/audio-embed', {
+			id,
+			path: path.join(nconf.get('relative_path'), '/uploads/audio-embed', id),
+		}),
+	})));
+
+	for (const { id, html } of renderedEmbeds) {
+		parsedContent = parsedContent.replace(`[audio/${id}]`, html);
+	}
+
+	return parsedContent;
 };
 
-plugin.exists = function(id, callback) {
-    db.isSortedSetMember('audio-embed:date', id, callback);
+plugin.exists = async function (id) {
+	return await db.isSortedSetMember('audio-embed:date', id);
 };
 
 module.exports = plugin;

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "nodebb-plugin-audio-embed",
-  "version": "2.0.1",
+  "version": "3.0.0",
   "description": "",
   "main": "library.js",
   "repository": {
     "type": "git",
     "url": "https://github.com/julianlam/nodebb-plugin-audio-embed"
   },
+  "scripts": {
+    "lint": "eslint ."
+  },
   "keywords": [
     "nodebb",
     "plugin"
@@ -21,11 +24,13 @@
   },
   "readmeFilename": "README.md",
   "nbbpm": {
-    "compatibility": "^3.2.0"
+    "compatibility": "^4.14.0"
   },
   "dependencies": {
-    "async": "^3.2.2",
-    "mkdirp": "^0.5.1",
-    "mv": "^2.1.1"
+    "mkdirp": "^3.0.1"
+  },
+  "devDependencies": {
+    "eslint": "10.6.0",
+    "eslint-config-nodebb": "^2.0.3"
   }
 }

package/static/lib/admin.js

@@ -1,23 +1,22 @@
 'use strict';
-/* globals $, app, socket, define */
 
-define('admin/plugins/audio-embed', ['settings', 'alerts'], function(Settings, alerts) {
+define('admin/plugins/audio-embed', ['settings', 'alerts'], function (Settings, alerts) {
 
-	var ACP = {};
+	const ACP = {};
 
-	ACP.init = function() {
+	ACP.init = function () {
 		Settings.load('audio-embed', $('.audio-embed-settings'));
 
-		$('#save').on('click', function() {
-			Settings.save('audio-embed', $('.audio-embed-settings'), function() {
+		$('#save').on('click', function () {
+			Settings.save('audio-embed', $('.audio-embed-settings'), function () {
 				alerts.alert({
 					type: 'success',
 					alert_id: 'audio-embed-saved',
 					title: 'Settings Saved',
 					message: 'Please reload your NodeBB to apply these settings',
-					clickfn: function() {
+					clickfn: function () {
 						socket.emit('admin.reload');
-					}
+					},
 				});
 			});
 		});

package/static/lib/main.js

@@ -1,21 +1,20 @@
-"use strict";
-/* globals $, require */
+'use strict';
 
-$(document).ready(function() {
+$(document).ready(function () {
 	function upload(callback) {
 		require(['uploader'], function (uploader) {
 			uploader.show({
 				title: 'Upload Audio',
 				description: 'Upload an audio file for embedding into your post',
-				route: config.relative_path + '/plugins/nodebb-plugin-audio-embed/upload'
+				route: config.relative_path + '/plugins/nodebb-plugin-audio-embed/upload',
 			}, callback);
 		});
 	}
 
-	$(window).on('action:composer.loaded', function (ev, data) {
-		require(['composer/formatting', 'composer/controls'], function(formatting, controls) {
+	$(window).on('action:composer.loaded', function () {
+		require(['composer/formatting', 'composer/controls'], function (formatting, controls) {
 			if (formatting && controls) {
-				formatting.addButtonDispatch('audio-embed', function(textarea, selectionStart, selectionEnd){
+				formatting.addButtonDispatch('audio-embed', function (textarea) {
 					upload(function (id) {
 						controls.insertIntoTextarea(textarea, '[audio/' + id + ']');
 						controls.updateTextareaSelection(textarea, id.length + 8, id.length + 8);
@@ -29,33 +28,33 @@ $(document).ready(function() {
 		}
 	});
 
-	$(window).on('action:redactor.load', function() {
+	$(window).on('action:redactor.load', function () {
 		$.Redactor.prototype['audio-embed'] = function () {
 			return {
 				init: function () {
-					var self = this;
+					const self = this;
 
 					// require translator as such because it was undefined without it
 					require(['translator'], function (translator) {
 						translator.translate('Embed Audio', function (translated) {
-							var button = self.button.add('audio-embed', translated);
+							const button = self.button.add('audio-embed', translated);
 							self.button.setIcon(button, '<i class="fa fa-file-audio-o"></i>');
 							self.button.addCallback(button, self['audio-embed'].onClick);
 						});
 					});
 				},
 				onClick: function () {
-					var self = this;
+					const self = this;
 					upload(function (id) {
 						require(['benchpress'], (Benchpress) => {
 							Benchpress.parse('partials/audio-embed', {
-								path: config.relative_path + '/uploads/audio-embed/' + id
+								path: config.relative_path + '/uploads/audio-embed/' + id,
 							}, function (html) {
 								self.insert.html(html);
 							});
 						});
 					});
-				}
+				},
 			};
 		};
 	});