Node.js based forum software built for the modern web
refactor: move temp file deletion to multer middleware, closes #14593
Barış Soner Uşaklı815e4c2b3e65
diff --git a/src/controllers/accounts/edit.js b/src/controllers/accounts/edit.jsindex c02bb7563d..57dc0e035c 100644--- a/src/controllers/accounts/edit.js+++ b/src/controllers/accounts/edit.js@@ -6,7 +6,6 @@ const helpers = require('../helpers');const groups = require('../../groups');const privileges = require('../../privileges');const plugins = require('../../plugins');-const file = require('../../file');const accountHelpers = require('./helpers');const editController = module.exports;@@ -160,7 +159,5 @@ editController.uploadPicture = async function (req, res, next) {}]);} catch (err) {next(err);- } finally {- await file.delete(userPhoto.path);}};diff --git a/src/controllers/admin/uploads.js b/src/controllers/admin/uploads.jsindex 14b17d83d5..1278a020ca 100644--- a/src/controllers/admin/uploads.js+++ b/src/controllers/admin/uploads.js@@ -154,7 +154,6 @@ uploadsController.uploadCategoryPicture = async function (req, res, next) {try {params = JSON.parse(req.body.params);} catch (e) {- file.delete(uploadedFile.path);return next(new Error('[[error:invalid-json]]'));}@@ -193,8 +192,6 @@ uploadsController.uploadTouchIcon = async function (req, res, next) {res.json([{ name: uploadedFile.name, url: imageObj.url }]);} catch (err) {next(err);- } finally {- file.delete(uploadedFile.path);}};@@ -208,8 +205,6 @@ uploadsController.uploadMaskableIcon = async function (req, res, next) {res.json([{ name: uploadedFile.name, url: imageObj.url }]);} catch (err) {next(err);- } finally {- file.delete(uploadedFile.path);}};@@ -223,8 +218,6 @@ uploadsController.uploadScreenshot = async function (req, res, next) {res.json([{ name: uploadedFile.name, url: imageObj.url }]);} catch (err) {next(err);- } finally {- file.delete(uploadedFile.path);}};@@ -234,7 +227,6 @@ uploadsController.uploadFile = async function (req, res, next) {try {params = JSON.parse(req.body.params);} catch (e) {- file.delete(uploadedFile.path);return next(new Error('[[error:invalid-json]]'));}@@ -246,8 +238,6 @@ uploadsController.uploadFile = async function (req, res, next) {res.json([{ url: data.url }]);} catch (err) {next(err);- } finally {- file.delete(uploadedFile.path);}};@@ -273,7 +263,6 @@ async function upload(name, req, res, next) {async function validateUpload(uploadedFile, allowedTypes) {if (!allowedTypes.includes(uploadedFile.type)) {- file.delete(uploadedFile.path);throw new Error(`[[error:invalid-image-type, ${uploadedFile.type}, ${allowedTypes.join(', ')}]]`);}}@@ -321,7 +310,5 @@ async function uploadImage(filename, folder, uploadedFile, req, res, next) {]);} catch (err) {next(err);- } finally {- file.delete(uploadedFile.path);}}diff --git a/src/controllers/uploads.js b/src/controllers/uploads.jsindex 4a2e9a3f2d..6f60456b5a 100644--- a/src/controllers/uploads.js+++ b/src/controllers/uploads.js@@ -34,8 +34,6 @@ uploadsController.upload = async function (req, res, filesIterator) {return images;} catch (err) {return helpers.formatApiResponse(500, res, err);- } finally {- deleteTempFiles(files);}};@@ -119,7 +117,6 @@ async function resizeImage(fileObj) {uploadsController.uploadThumb = async function (req, res) {if (!meta.config.allowTopicsThumbnail) {- deleteTempFiles(req.files);return helpers.formatApiResponse(503, res, new Error('[[error:topic-thumbnails-are-disabled]]'));}@@ -225,10 +222,4 @@ async function validateFileExtension(uploadedFile) {}}-function deleteTempFiles(files) {- if (Array.isArray(files)) {- files.forEach(fileObj => file.delete(fileObj.path));- }-}-require('../promisify')(uploadsController, ['upload', 'uploadPost', 'uploadThumb']);diff --git a/src/middleware/multer.js b/src/middleware/multer.jsindex e288fe309e..d5015411cb 100644--- a/src/middleware/multer.js+++ b/src/middleware/multer.js@@ -1,17 +1,68 @@'use strict';+const meta = require('../meta');+const file = require('../file');+const multer = require('multer');const storage = multer.diskStorage({});-const upload = multer({- storage,- // from https://github.com/TriliumNext/Trilium/pull/3058/files- fileFilter: (req, file, cb) => {- // UTF-8 file names are not well decoded by multer/busboy, so we handle the conversion on our side.- // See https://github.com/expressjs/multer/pull/1102.- file.originalname = Buffer.from(file.originalname, 'latin1').toString('utf-8');- cb(null, true);- },-});--module.exports = upload;++// create middlware dynamically so maximumFileSize can be updated without restarting the server+function multerUpload() {+ return multer({+ storage,+ // from https://github.com/TriliumNext/Trilium/pull/3058/files+ fileFilter: (req, file, cb) => {+ // UTF-8 file names are not well decoded by multer/busboy, so we handle the conversion on our side.+ // See https://github.com/expressjs/multer/pull/1102.+ file.originalname = Buffer.from(file.originalname, 'latin1').toString('utf-8');+ cb(null, true);+ },+ limits: {+ fields: 20,+ files: 20,+ parts: 40,+ fileSize: meta.config.maximumFileSize * 1024,+ fieldNestingDepth: 3,+ },+ });+}++function withCleanup(middleware) {+ return (req, res, next) => {+ let cleaned = false;+ const cleanup = () => {+ if (cleaned) {+ return;+ }+ cleaned = true;+ deleteTempFiles(req.files || (req.file ? [req.file] : []));+ };++ res.once('finish', cleanup);+ res.once('close', cleanup);++ middleware(req, res, next);+ };+}++function dynamicUpload(method, ...args) {+ return withCleanup((req, res, next) => {+ multerUpload()[method](...args)(req, res, next);+ });+}++function deleteTempFiles(files) {+ if (Array.isArray(files)) {+ files.forEach(fileObj => file.delete(fileObj.path));+ }+}++module.exports = {+ array: (field, maxCount) => dynamicUpload('array', field, maxCount),+ single: field => dynamicUpload('single', field),+ fields: fields => dynamicUpload('fields', fields),+ none: () => dynamicUpload('none'),+ any: () => dynamicUpload('any'),+};+diff --git a/src/middleware/uploads.js b/src/middleware/uploads.jsindex fdbfc3dbda..0c7c5bbde0 100644--- a/src/middleware/uploads.js+++ b/src/middleware/uploads.js@@ -15,7 +15,7 @@ exports.clearCache = function () {exports.ratelimit = helpers.try(async (req, res, next) => {const { uid } = req;- if (!meta.config.uploadRateLimitThreshold || (uid && await user.isAdminOrGlobalMod(uid))) {+ if (!meta.config.uploadRateLimitThreshold || (uid > 0 && await user.isAdminOrGlobalMod(uid))) {return next();}if (!cache) {diff --git a/src/routes/admin.js b/src/routes/admin.jsindex 3e7b5d6f82..05bca9b21f 100644--- a/src/routes/admin.js+++ b/src/routes/admin.js@@ -97,10 +97,10 @@ function apiRoutes(router, name, middleware, controllers) {const upload = require('../middleware/multer');const middlewares = [- upload.array('files[]', 20),- middleware.validateFiles,middleware.applyCSRF,middleware.ensureLoggedIn,+ upload.array('files[]', 20),+ middleware.validateFiles,];router.post(`/api/${name}/category/uploadpicture`, middlewares, helpers.tryRoute(controllers.admin.uploads.uploadCategoryPicture));diff --git a/src/routes/api.js b/src/routes/api.jsindex 79fb83b811..c370803dab 100644--- a/src/routes/api.js+++ b/src/routes/api.js@@ -27,10 +27,10 @@ module.exports = function (app, middleware, controllers) {const postMiddlewares = [middleware.maintenanceMode,+ middleware.applyCSRF,upload.array('files[]', 20),middleware.validateFiles,middleware.uploads.ratelimit,- middleware.applyCSRF,];router.post('/post/upload', postMiddlewares, helpers.tryRoute(uploadsController.uploadPost));diff --git a/src/routes/authentication.js b/src/routes/authentication.jsindex bfb01a124e..5ac48ded9d 100644--- a/src/routes/authentication.js+++ b/src/routes/authentication.js@@ -159,9 +159,9 @@ Auth.reloadRoutes = async function (params) {const upload = require('../middleware/multer');const middlewares = [- upload.any(),Auth.middleware.applyCSRF,Auth.middleware.applyBlacklist,+ upload.any(),];router.post('/register', middlewares, controllers.authentication.register);diff --git a/src/routes/helpers.js b/src/routes/helpers.jsindex 32dee23939..108f698337 100644--- a/src/routes/helpers.js+++ b/src/routes/helpers.js@@ -59,6 +59,7 @@ helpers.setupApiRoute = function (...args) {let middlewares = args.length > 4 ? args[args.length - 2] : [];const controller = args[args.length - 1];const upload = require('../middleware/multer');+ const uploadVerbs = new Set(['post', 'put', 'patch']);middlewares = [middleware.autoLocale,middleware.applyBlacklist,@@ -67,7 +68,7 @@ helpers.setupApiRoute = function (...args) {middleware.registrationComplete,middleware.pluginHooks,middleware.logApiUsage,- upload.any(),+ ...(uploadVerbs.has(verb) ? [upload.any()] : []),...middlewares,];