Whitelist of file extensions

constwhitelist=[// images'.jpg','.jpeg',// image/jpeg'.png',// image/png, image/x-png'.gif',// image/gif'.bmp',// image/bmp'.wbmp',// image/vnd.wap.wbmp'.webp','.tif','.psd',// text'.svg','.js','.jsx','.json','.css','.less','.html','.htm','.xml',// tar'.zip','.gz','.tgz','.gzip',// video'.mp3','.mp4','.avi',];

fileSize

// config/config.default.jsexports.multipart={fileSize:'50mb',};

Custom Config

// config/config.default.jsexports.multipart={// will append to whilelistfileExtensions:['.foo','.apk',],};

// config/config.default.jsexports.multipart={whitelist:['.png',],};

exports.multipart={whitelist:(filename)=>['.png'].includes(path.extname(filename)||'')};

Examples

file mode: the easy way

Enablefile mode on config

// config/config.default.jsexports.multipart={mode:'file',};

config.multipart={mode:'file',tmpdir:path.join(os.tmpdir(),'egg-multipart-tmp',appInfo.name),cleanSchedule:{// run tmpdir clean job on every day 04:30 am// cron style see https://github.com/eggjs/egg-schedule#cron-style-schedulingcron:'0 30 4 * * *',disable:false,},};

// config/config.default.jsexports.multipart={mode:'file',allowArrayField:true,};

Upload One File

<formmethod="POST"action="/upload?_csrf={{ ctx.csrf | safe }}"enctype="multipart/form-data">  title:<inputname="title"/>  file:<inputname="file"type="file"/><buttontype="submit">Upload</button></form>

// app/controller/upload.jsconstController=require('egg').Controller;constfs=require('mz/fs');module.exports=classextendsController{asyncupload(){const{ ctx}=this;constfile=ctx.request.files[0];constname='egg-multipart-test/'+path.basename(file.filename);letresult;try{// process file or upload to cloud storageresult=awaitctx.oss.put(name,file.filepath);}finally{// remove tmp files and don't block the request's response// cleanupRequestFiles won't throw error even remove file io error happenctx.cleanupRequestFiles();// remove tmp files before send response// await ctx.cleanupRequestFiles();}ctx.body={url:result.url,// get all field valuesrequestBody:ctx.request.body,};}};

Upload Multiple Files

<formmethod="POST"action="/upload?_csrf={{ ctx.csrf | safe }}"enctype="multipart/form-data">  title:<inputname="title"/>  file1:<inputname="file1"type="file"/>  file2:<inputname="file2"type="file"/><buttontype="submit">Upload</button></form>

// app/controller/upload.jsconstController=require('egg').Controller;constfs=require('mz/fs');module.exports=classextendsController{asyncupload(){const{ ctx}=this;console.log(ctx.request.body);console.log('got %d files',ctx.request.files.length);for(constfileofctx.request.files){console.log('field: '+file.fieldname);console.log('filename: '+file.filename);console.log('encoding: '+file.encoding);console.log('mime: '+file.mime);console.log('tmp filepath: '+file.filepath);letresult;try{// process file or upload to cloud storageresult=awaitctx.oss.put('egg-multipart-test/'+file.filename,file.filepath);}finally{// remove tmp files and don't block the request's response// cleanupRequestFiles won't throw error even remove file io error happenctx.cleanupRequestFiles([file]);}console.log(result);}}};

stream mode: the hard way

Use withfor await...of

<formmethod="POST"action="/upload?_csrf={{ ctx.csrf | safe }}"enctype="multipart/form-data">  title:<inputname="title"/>  file1:<inputname="file1"type="file"/>  file2:<inputname="file2"type="file"/><buttontype="submit">Upload</button></form>

// app/controller/upload.jsconst{ Controller}=require('egg');constfs=require('fs');conststream=require('stream');constutil=require('util');const{ randomUUID}=require('crypto');constpipeline=util.promisify(stream.pipeline);module.exports=classUploadControllerextendsController{asyncupload(){constparts=this.ctx.multipart();constfields={};constfiles={};forawait(constpartofparts){if(Array.isArray(part)){// fieldsconsole.log('field: '+part[0]);console.log('value: '+part[1]);}else{// otherwise, it's a streamconst{ filename, fieldname, encoding, mime}=part;console.log('field: '+fieldname);console.log('filename: '+filename);console.log('encoding: '+encoding);console.log('mime: '+mime);// how to handler?// 1. save to tmpdir with pipeline// 2. or send to oss// 3. or just consume it with another for await// WARNING: You should almost never use the origin filename as it could contain malicious input.consttargetPath=path.join(os.tmpdir(),randomUUID()+path.extname(filename));awaitpipeline(part,createWriteStream(targetPath));// use `pipeline` not `pipe`}}this.ctx.body='ok';}};

Upload One File (DEPRECATED)

<formmethod="POST"action="/upload?_csrf={{ ctx.csrf | safe }}"enctype="multipart/form-data">  title:<inputname="title"/>  file:<inputname="file"type="file"/><buttontype="submit">Upload</button></form>

// app/controller/upload.jsconstpath=require('node:path');const{ sendToWormhole}=require('stream-wormhole');const{ Controller}=require('egg');module.exports=classextendsController{asyncupload(){const{ ctx}=this;// file not exists will response 400 errorconststream=awaitctx.getFileStream();constname='egg-multipart-test/'+path.basename(stream.filename);// process file or upload to cloud storageconstresult=awaitctx.oss.put(name,stream);ctx.body={url:result.url,// process form fields by `stream.fields`fields:stream.fields,};}asyncuploadNotRequiredFile(){const{ ctx}=this;// file not requiredconststream=awaitctx.getFileStream({requireFile:false});letresult;if(stream.filename){constname='egg-multipart-test/'+path.basename(stream.filename);// process file or upload to cloud storageconstresult=awaitctx.oss.put(name,stream);}else{// must consume the empty streamawaitsendToWormhole(stream);}ctx.body={url:result&&result.url,// process form fields by `stream.fields`fields:stream.fields,};}};

Upload Multiple Files (DEPRECATED)

<formmethod="POST"action="/upload?_csrf={{ ctx.csrf | safe }}"enctype="multipart/form-data">  title:<inputname="title"/>  file1:<inputname="file1"type="file"/>  file2:<inputname="file2"type="file"/><buttontype="submit">Upload</button></form>

// app/controller/upload.jsconstController=require('egg').Controller;module.exports=classextendsController{asyncupload(){const{ ctx}=this;constparts=ctx.multipart();letpart;while((part=awaitparts())!=null){if(part.length){// arrays are busboy fieldsconsole.log('field: '+part[0]);console.log('value: '+part[1]);console.log('valueTruncated: '+part[2]);console.log('fieldnameTruncated: '+part[3]);}else{if(!part.filename){// user click `upload` before choose a file,// `part` will be file stream, but `part.filename` is empty// must handler this, such as log error.continue;}// otherwise, it's a streamconsole.log('field: '+part.fieldname);console.log('filename: '+part.filename);console.log('encoding: '+part.encoding);console.log('mime: '+part.mime);constresult=awaitctx.oss.put('egg-multipart-test/'+part.filename,part);console.log(result);}}console.log('and we are done parsing the form!');}};

Supportfile andstream mode in the same time

config.multipart={mode:'stream',// let POST /upload_file request use the file mode, other requests use the stream mode.fileModeMatch:/^\/upload_file$/,// or glob// fileModeMatch: '/upload_file',};

License

Contributors