Filename can be a nested path

sebdeckers · sebdeckers · commit a8f6303542f8 · 2017-06-11T13:40:36.000+08:00
diff --git a/Readme.md b/Readme.md
@@ -132,7 +132,8 @@ someModule.stream(function(err, stdout, stderr) {
   var form = new FormData();
 
   form.append('file', stdout, {
-    filename: 'unicycle.jpg',
+    filename: 'unicycle.jpg', // ... or:
+    filepath: 'photos/toys/unicycle.jpg',
     contentType: 'image/jpg',
     knownLength: 19806
   });
@@ -144,6 +145,8 @@ someModule.stream(function(err, stdout, stderr) {
 });
 ```
 
+The `filepath` property overrides `filename` and may contain a relative path. This is typically used when uploading [multiple files from a directory](https://wicg.github.io/entries-api/#dom-htmlinputelement-webkitdirectory).
+
 For edge cases, like POST request to URL with query string or to pass HTTP auth credentials, object can be passed to `form.submit()` as first parameter:
 
 ``` javascript
diff --git a/lib/form_data.js b/lib/form_data.js
@@ -8,6 +8,7 @@ var fs = require('fs');
 var mime = require('mime-types');
 var asynckit = require('asynckit');
 var populate = require('./populate.js');
+var normalize = require('normalize-path');
 
 // Public API
 module.exports = FormData;
@@ -209,20 +210,25 @@ FormData.prototype._multiPartHeader = function(field, value, options) {
 
 FormData.prototype._getContentDisposition = function(value, options) {
 
-  var contentDisposition;
-
-  // custom filename takes precedence
-  // fs- and request- streams have path property
-  // formidable and the browser add a name property.
-  var filename = options.filename || value.name || value.path;
+  var filename
+    , contentDisposition
+    ;
 
-  // or try http response
-  if (!filename && value.readable && value.hasOwnProperty('httpVersion')) {
-    filename = value.client._httpMessage.path;
+  if (options.filepath) {
+    // custom filepath for relative paths
+    filename = normalize(options.filepath);
+  } else if (options.filename || value.name || value.path) {
+    // custom filename take precedence
+    // formidable and the browser add a name property
+    // fs- and request- streams have path property
+    filename = path.basename(options.filename || value.name || value.path);
+  } else if (value.readable && value.hasOwnProperty('httpVersion')) {
+    // or try http response
+    filename = path.basename(value.client._httpMessage.path);
   }
 
   if (filename) {
-    contentDisposition = 'filename="' + path.basename(filename) + '"';
+    contentDisposition = 'filename="' + filename + '"';
   }
 
   return contentDisposition;
@@ -248,9 +254,9 @@ FormData.prototype._getContentType = function(value, options) {
     contentType = value.headers['content-type'];
   }
 
-  // or guess it from the filename
-  if (!contentType && options.filename) {
-    contentType = mime.lookup(options.filename);
+  // or guess it from the filepath or filename
+  if (!contentType && (options.filepath || options.filename)) {
+    contentType = mime.lookup(options.filepath || options.filename);
   }
 
   // fallback to the default content type if `value` is not simple value
diff --git a/package.json b/package.json
@@ -39,7 +39,8 @@
   "dependencies": {
     "asynckit": "^0.4.0",
     "combined-stream": "^1.0.5",
-    "mime-types": "^2.1.12"
+    "mime-types": "^2.1.12",
+    "normalize-path": "^2.1.1"
   },
   "devDependencies": {
     "browserify": "^13.1.1",
diff --git a/test/integration/test-custom-filename.js b/test/integration/test-custom-filename.js
@@ -8,6 +8,7 @@ var assert       = common.assert;
 var mime         = require('mime-types');
 var http         = require('http');
 var fs           = require('fs');
+var normalize    = require('normalize-path');
 
 var FormData     = require(common.dir.lib + '/form_data');
 var IncomingForm = require('formidable').IncomingForm;
@@ -35,6 +36,10 @@ var server = http.createServer(function(req, res) {
     assert.strictEqual(files['custom_filename'].name, options.filename, 'Expects custom filename');
     assert.strictEqual(files['custom_filename'].type, mime.lookup(knownFile), 'Expects original content-type');
 
+    assert('custom_filepath' in files);
+    assert.strictEqual(files['custom_filepath'].name, normalize(knownFile), 'Expects custom filename');
+    assert.strictEqual(files['custom_filepath'].type, mime.lookup(knownFile), 'Expects original content-type');
+
     assert('unknown_with_filename' in files);
     assert.strictEqual(files['unknown_with_filename'].name, options.filename, 'Expects custom filename');
     assert.strictEqual(files['unknown_with_filename'].type, mime.lookup(options.filename), 'Expects filename-derived content-type');
@@ -67,6 +72,8 @@ server.listen(common.port, function() {
   form.append('unknown_with_filename', fs.createReadStream(unknownFile), options.filename);
   // Filename only with unknown file
   form.append('unknown_with_filename_as_object', fs.createReadStream(unknownFile), {filename: options.filename});
+  // Filename with nested path
+  form.append('custom_filepath', fs.createReadStream(knownFile), {filepath: knownFile});
   // No options or implicit file type from extension on name property.
   var customNameStream = fs.createReadStream(unknownFile);
   customNameStream.name = options.filename;
