@strapi/provider-upload-local
Version:
Local provider for strapi upload
141 lines (138 loc) • 6.55 kB
JavaScript
import { pipeline } from 'stream';
import fs from 'fs';
import path from 'path';
import fse from 'fs-extra';
import * as utils from '@strapi/utils';
const { PayloadTooLargeError } = utils.errors;
const { kbytesToBytes, bytesToHumanReadable } = utils.file;
const UPLOADS_FOLDER_NAME = 'uploads';
var index = {
init ({ sizeLimit: providerOptionsSizeLimit } = {}) {
// TODO V5: remove providerOptions sizeLimit
if (providerOptionsSizeLimit) {
process.emitWarning('[deprecated] In future versions, "sizeLimit" argument will be ignored from upload.config.providerOptions. Move it to upload.config');
}
// Ensure uploads folder exists
const uploadPath = path.resolve(strapi.dirs.static.public, UPLOADS_FOLDER_NAME);
if (!fse.pathExistsSync(uploadPath)) {
throw new Error(`The upload folder (${uploadPath}) doesn't exist or is not accessible. Please make sure it exists.`);
}
return {
checkFileSize (file, options) {
const { sizeLimit } = options ?? {};
// TODO V5: remove providerOptions sizeLimit
if (providerOptionsSizeLimit) {
if (kbytesToBytes(file.size) > providerOptionsSizeLimit) throw new PayloadTooLargeError(`${file.name} exceeds size limit of ${bytesToHumanReadable(providerOptionsSizeLimit)}.`);
} else if (sizeLimit) {
if (kbytesToBytes(file.size) > sizeLimit) throw new PayloadTooLargeError(`${file.name} exceeds size limit of ${bytesToHumanReadable(sizeLimit)}.`);
}
},
uploadStream (file) {
if (!file.stream) {
return Promise.reject(new Error('Missing file stream'));
}
const { stream } = file;
return new Promise((resolve, reject)=>{
pipeline(stream, fs.createWriteStream(path.join(uploadPath, `${file.hash}${file.ext}`)), (err)=>{
if (err) {
return reject(err);
}
file.url = `/${UPLOADS_FOLDER_NAME}/${file.hash}${file.ext}`;
resolve();
});
});
},
upload (file) {
if (!file.buffer) {
return Promise.reject(new Error('Missing file buffer'));
}
const { buffer } = file;
return new Promise((resolve, reject)=>{
// write file in public/assets folder
fs.writeFile(path.join(uploadPath, `${file.hash}${file.ext}`), buffer, (err)=>{
if (err) {
return reject(err);
}
file.url = `/${UPLOADS_FOLDER_NAME}/${file.hash}${file.ext}`;
resolve();
});
});
},
replaceStream (newFile, oldFile) {
if (!newFile.stream) {
return Promise.reject(new Error('Missing file stream'));
}
// If the destination path is unchanged, writing the new file overwrites
// the old one atomically. If the hash or extension changed, write the
// new file first then unlink the old one so we never leave a gap.
const newPath = path.join(uploadPath, `${newFile.hash}${newFile.ext}`);
const oldPath = path.join(uploadPath, `${oldFile.hash}${oldFile.ext}`);
const samePath = newPath === oldPath;
const { stream } = newFile;
return new Promise((resolve, reject)=>{
pipeline(stream, fs.createWriteStream(newPath), (err)=>{
if (err) {
return reject(err);
}
newFile.url = `/${UPLOADS_FOLDER_NAME}/${newFile.hash}${newFile.ext}`;
if (!samePath && fs.existsSync(oldPath)) {
fs.unlink(oldPath, (unlinkErr)=>{
if (unlinkErr) {
return reject(unlinkErr);
}
resolve();
});
return;
}
resolve();
});
});
},
replace (newFile, oldFile) {
if (!newFile.buffer) {
return Promise.reject(new Error('Missing file buffer'));
}
const newPath = path.join(uploadPath, `${newFile.hash}${newFile.ext}`);
const oldPath = path.join(uploadPath, `${oldFile.hash}${oldFile.ext}`);
const samePath = newPath === oldPath;
const { buffer } = newFile;
return new Promise((resolve, reject)=>{
fs.writeFile(newPath, buffer, (err)=>{
if (err) {
return reject(err);
}
newFile.url = `/${UPLOADS_FOLDER_NAME}/${newFile.hash}${newFile.ext}`;
if (!samePath && fs.existsSync(oldPath)) {
fs.unlink(oldPath, (unlinkErr)=>{
if (unlinkErr) {
return reject(unlinkErr);
}
resolve();
});
return;
}
resolve();
});
});
},
delete (file) {
return new Promise((resolve, reject)=>{
const filePath = path.join(uploadPath, `${file.hash}${file.ext}`);
if (!fs.existsSync(filePath)) {
resolve("File doesn't exist");
return;
}
// remove file from public/assets folder
fs.unlink(filePath, (err)=>{
if (err) {
return reject(err);
}
resolve();
});
});
}
};
}
};
export { index as default };
//# sourceMappingURL=index.mjs.map