fs: add the fs.mkdtemp() function.

This uses libuv's mkdtemp function to provide a way to create a temporary folder, using a prefix as the path. The prefix is appended six random characters. The callback function will receive the name of the folder that was created. Usage example: fs.mkdtemp('/tmp/foo-', function(err, folder){console.log(folder); // Prints: /tmp/foo-Tedi42 }); The fs.mkdtempSync version is also provided. Usage example: console.log(fs.mkdtemp('/tmp/foo-')); // Prints: tmp/foo-Tedi42 This pull request also includes the relevant documentation changes and tests. PR-URL: #5333 Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Trevor Norris <[email protected]>

Author: ralt

doc/api/fs.md

@@ -851,6 +851,30 @@ added: v0.1.21
 
 Synchronous mkdir(2). Returns `undefined`.
 
+## fs.mkdtemp(prefix, callback)
+
+Creates a unique temporary directory.
+
+Generates six random characters to be appended behind a required
+`prefix` to create a unique temporary directory.
+
+The created folder path is passed as a string to the callback's second
+parameter.
+
+Example:
+
+```js
+fs.mkdtemp('/tmp/foo-', (err, folder) =>{
+console.log(folder);
+// Prints: /tmp/foo-itXde2
+});
+```
+
+## fs.mkdtempSync(template)
+
+The synchronous version of [`fs.mkdtemp()`][]. Returns the created
+folder path.
+
 ## fs.open(path, flags[, mode], callback)
 <!-- YAML
 added: v0.0.2

lib/fs.js

@@ -1990,3 +1990,24 @@ SyncWriteStream.prototype.destroy = function(){
 };
 
 SyncWriteStream.prototype.destroySoon=SyncWriteStream.prototype.destroy;
+
+fs.mkdtemp=function(prefix,callback){
+if(typeofcallback!=='function'){
+thrownewTypeError('"callback" argument must be a function');
+}
+
+if(!nullCheck(prefix,callback)){
+return;
+}
+
+varreq=newFSReqWrap();
+req.oncomplete=callback;
+
+binding.mkdtemp(prefix+'XXXXXX',req);
+};
+
+fs.mkdtempSync=function(prefix){
+nullCheck(prefix);
+
+returnbinding.mkdtemp(prefix+'XXXXXX');
+};

src/node_file.cc

@@ -200,6 +200,11 @@ static void After(uv_fs_t *req){
 static_cast<constuv_stat_t*>(req->ptr));
 break;
 
+case UV_FS_MKDTEMP:
+ argv[1] = String::NewFromUtf8(env->isolate(),
+static_cast<constchar*>(req->path));
+break;
+
 case UV_FS_READLINK:
  argv[1] = String::NewFromUtf8(env->isolate(),
 static_cast<constchar*>(req->ptr));
@@ -1264,6 +1269,25 @@ static void FUTimes(const FunctionCallbackInfo<Value>& args){
  }
 }
 
+staticvoidMkdtemp(const FunctionCallbackInfo<Value>& args){
+ Environment* env = Environment::GetCurrent(args);
+
+if (args.Length() < 1)
+returnTYPE_ERROR("template is required");
+if (!args[0]->IsString())
+returnTYPE_ERROR("template must be a string");
+
+ node::Utf8Value tmpl(env->isolate(), args[0]);
+
+if (args[1]->IsObject()){
+ASYNC_CALL(mkdtemp, args[1], *tmpl);
+ } else{
+SYNC_CALL(mkdtemp, *tmpl, *tmpl);
+ args.GetReturnValue().Set(String::NewFromUtf8(env->isolate(),
+ SYNC_REQ.path));
+ }
+}
+
 voidFSInitialize(const FunctionCallbackInfo<Value>& args){
  Local<Function> stats_constructor = args[0].As<Function>();
 CHECK(stats_constructor->IsFunction());
@@ -1317,6 +1341,8 @@ void InitFs(Local<Object> target,
  env->SetMethod(target, "utimes", UTimes);
  env->SetMethod(target, "futimes", FUTimes);
 
+ env->SetMethod(target, "mkdtemp", Mkdtemp);
+
 StatWatcher::Initialize(env, target);
 
 // Create FunctionTemplate for FSReqWrap

test/parallel/test-fs-mkdtemp.js

@@ -0,0 +1,27 @@
+'use strict';
+
+constcommon=require('../common');
+constassert=require('assert');
+constfs=require('fs');
+constpath=require('path');
+constBuffer=require('buffer').Buffer;
+
+common.refreshTmpDir();
+
+consttmpFolder=fs.mkdtempSync(path.join(common.tmpDir,'foo.'));
+
+assert(path.basename(tmpFolder).length==='foo.XXXXXX'.length);
+assert(common.fileExists(tmpFolder));
+
+constutf8=fs.mkdtempSync(path.join(common.tmpDir,'\u0222abc.'));
+assert.equal(Buffer.byteLength(path.basename(utf8)),
+Buffer.byteLength('\u0222abc.XXXXXX'));
+assert(common.fileExists(utf8));
+
+fs.mkdtemp(
+path.join(common.tmpDir,'bar.'),
+common.mustCall(function(err,folder){
+assert.ifError(err);
+assert(common.fileExists(folder));
+})
+);