Use Express router for assets + "files" endpoints

I've split out the "file/upload" endpoint into its own module, and
renamed it to "files" to be consistent with the existing naming scheme.
This commit is contained in:
valadaptive 2023-12-04 12:40:53 -05:00
parent 414c9bd5fb
commit d24c1dde10
4 changed files with 286 additions and 253 deletions

View File

@ -152,7 +152,7 @@ export async function populateFileAttachment(message, inputId = 'file_form_input
*/ */
export async function uploadFileAttachment(fileName, base64Data) { export async function uploadFileAttachment(fileName, base64Data) {
try { try {
const result = await fetch('/api/file/upload', { const result = await fetch('/api/files/upload', {
method: 'POST', method: 'POST',
headers: getRequestHeaders(), headers: getRequestHeaders(),
body: JSON.stringify({ body: JSON.stringify({

View File

@ -3597,7 +3597,10 @@ require('./src/endpoints/novelai').registerEndpoints(app, jsonParser);
require('./src/endpoints/extensions').registerEndpoints(app, jsonParser); require('./src/endpoints/extensions').registerEndpoints(app, jsonParser);
// Asset management // Asset management
require('./src/endpoints/assets').registerEndpoints(app, jsonParser); app.use('/api/assets', require('./src/endpoints/assets').router);
// File management
app.use('/api/files', require('./src/endpoints/files').router);
// Character sprite management // Character sprite management
require('./src/endpoints/sprites').registerEndpoints(app, jsonParser, urlencodedParser); require('./src/endpoints/sprites').registerEndpoints(app, jsonParser, urlencodedParser);

View File

@ -1,10 +1,12 @@
const path = require('path'); const path = require('path');
const fs = require('fs'); const fs = require('fs');
const express = require('express');
const sanitize = require('sanitize-filename'); const sanitize = require('sanitize-filename');
const fetch = require('node-fetch').default; const fetch = require('node-fetch').default;
const { finished } = require('stream/promises'); const { finished } = require('stream/promises');
const writeFileSyncAtomic = require('write-file-atomic').sync; const writeFileSyncAtomic = require('write-file-atomic').sync;
const { DIRECTORIES, UNSAFE_EXTENSIONS } = require('../constants'); const { DIRECTORIES, UNSAFE_EXTENSIONS } = require('../constants');
const { jsonParser } = require('../express-common');
const VALID_CATEGORIES = ['bgm', 'ambient', 'blip', 'live2d']; const VALID_CATEGORIES = ['bgm', 'ambient', 'blip', 'live2d'];
@ -57,13 +59,9 @@ function getFiles(dir, files = []) {
return files; return files;
} }
const router = express.Router();
/** /**
* Registers the endpoints for the asset management.
* @param {import('express').Express} app Express app
* @param {any} jsonParser JSON parser middleware
*/
function registerEndpoints(app, jsonParser) {
/**
* HTTP POST handler function to retrieve name of all files of a given folder path. * HTTP POST handler function to retrieve name of all files of a given folder path.
* *
* @param {Object} request - HTTP Request object. Require folder path in query * @param {Object} request - HTTP Request object. Require folder path in query
@ -71,7 +69,7 @@ function registerEndpoints(app, jsonParser) {
* *
* @returns {void} * @returns {void}
*/ */
app.post('/api/assets/get', jsonParser, async (_, response) => { router.post('/get', jsonParser, async (_, response) => {
const folderPath = path.join(DIRECTORIES.assets); const folderPath = path.join(DIRECTORIES.assets);
let output = {}; let output = {};
//console.info("Checking files into",folderPath); //console.info("Checking files into",folderPath);
@ -119,9 +117,9 @@ function registerEndpoints(app, jsonParser) {
console.log(err); console.log(err);
} }
return response.send(output); return response.send(output);
}); });
/** /**
* HTTP POST handler function to download the requested asset. * HTTP POST handler function to download the requested asset.
* *
* @param {Object} request - HTTP Request object, expects a url, a category and a filename. * @param {Object} request - HTTP Request object, expects a url, a category and a filename.
@ -129,7 +127,7 @@ function registerEndpoints(app, jsonParser) {
* *
* @returns {void} * @returns {void}
*/ */
app.post('/api/assets/download', jsonParser, async (request, response) => { router.post('/download', jsonParser, async (request, response) => {
const url = request.body.url; const url = request.body.url;
const inputCategory = request.body.category; const inputCategory = request.body.category;
const inputFilename = sanitize(request.body.filename); const inputFilename = sanitize(request.body.filename);
@ -179,9 +177,9 @@ function registerEndpoints(app, jsonParser) {
console.log(error); console.log(error);
response.sendStatus(500); response.sendStatus(500);
} }
}); });
/** /**
* HTTP POST handler function to delete the requested asset. * HTTP POST handler function to delete the requested asset.
* *
* @param {Object} request - HTTP Request object, expects a category and a filename * @param {Object} request - HTTP Request object, expects a category and a filename
@ -189,7 +187,7 @@ function registerEndpoints(app, jsonParser) {
* *
* @returns {void} * @returns {void}
*/ */
app.post('/api/assets/delete', jsonParser, async (request, response) => { router.post('/delete', jsonParser, async (request, response) => {
const inputCategory = request.body.category; const inputCategory = request.body.category;
const inputFilename = sanitize(request.body.filename); const inputFilename = sanitize(request.body.filename);
@ -231,10 +229,10 @@ function registerEndpoints(app, jsonParser) {
console.log(error); console.log(error);
response.sendStatus(500); response.sendStatus(500);
} }
}); });
/////////////////////////////// ///////////////////////////////
/** /**
* HTTP POST handler function to retrieve a character background music list. * HTTP POST handler function to retrieve a character background music list.
* *
* @param {Object} request - HTTP Request object, expects a character name in the query. * @param {Object} request - HTTP Request object, expects a character name in the query.
@ -242,7 +240,7 @@ function registerEndpoints(app, jsonParser) {
* *
* @returns {void} * @returns {void}
*/ */
app.post('/api/assets/character', jsonParser, async (request, response) => { router.post('/character', jsonParser, async (request, response) => {
if (request.query.name === undefined) return response.sendStatus(400); if (request.query.name === undefined) return response.sendStatus(400);
const name = sanitize(request.query.name.toString()); const name = sanitize(request.query.name.toString());
const inputCategory = request.query.category; const inputCategory = request.query.category;
@ -295,9 +293,9 @@ function registerEndpoints(app, jsonParser) {
console.log(err); console.log(err);
return response.sendStatus(500); return response.sendStatus(500);
} }
}); });
app.post('/api/file/upload', jsonParser, async (request, response) => { router.post('/upload', jsonParser, async (request, response) => {
try { try {
if (!request.body.name) { if (!request.body.name) {
return response.status(400).send('No upload name specified'); return response.status(400).send('No upload name specified');
@ -321,9 +319,6 @@ function registerEndpoints(app, jsonParser) {
console.log(error); console.log(error);
return response.sendStatus(500); return response.sendStatus(500);
} }
}); });
}
module.exports = { module.exports = { router, checkAssetFileName };
registerEndpoints,
};

35
src/endpoints/files.js Normal file
View File

@ -0,0 +1,35 @@
const path = require('path');
const writeFileSyncAtomic = require('write-file-atomic').sync;
const express = require('express');
const router = express.Router();
const { checkAssetFileName } = require('./assets');
const { jsonParser } = require('../express-common');
const { DIRECTORIES } = require('../constants');
router.post('/upload', jsonParser, async (request, response) => {
try {
if (!request.body.name) {
return response.status(400).send('No upload name specified');
}
if (!request.body.data) {
return response.status(400).send('No upload data specified');
}
const safeInput = checkAssetFileName(request.body.name);
if (!safeInput) {
return response.status(400).send('Invalid upload name');
}
const pathToUpload = path.join(DIRECTORIES.files, safeInput);
writeFileSyncAtomic(pathToUpload, request.body.data, 'base64');
const url = path.normalize(pathToUpload.replace('public' + path.sep, ''));
return response.send({ path: url });
} catch (error) {
console.log(error);
return response.sendStatus(500);
}
});
module.exports = { router };