Handle directories with odd names

Previously, adding a directory with square brackets
resulted in a strange, silent error [1]. This happened
because directory names were being passed to a file-
matching glob designed to recursively stream files from
the directory. When filenames contained meaningful glob
symbols (like [ or *), the glob matching would fail.

This commit resolves this problem by escaping glob
characters on filenames, before the filename is inserted
into the main glob in src/get-file-streams.js L48.
We add a dependency to glob-escape in the process,
and a new test in test/ipfs-api/util.spec.js.

Author: elsehow

package.json

@@ -29,12 +29,13 @@
     "detect-node": "^2.0.3",
     "flatmap": "0.0.3",
     "glob": "^7.1.1",
+    "glob-escape": "0.0.2",
     "ipfs-block": "^0.5.0",
     "ipld-dag-pb": "^0.9.0",
     "is-ipfs": "^0.2.1",
     "isstream": "^0.1.2",
-    "multiaddr": "^2.0.3",
     "lru-cache": "^4.0.1",
+    "multiaddr": "^2.0.3",
     "multipart-stream": "^2.0.1",
     "ndjson": "^1.4.3",
     "once": "^1.4.0",
@@ -113,4 +114,4 @@
     "url": "https://github.com/ipfs/js-ipfs-api/issues"
   },
   "homepage": "https://github.com/ipfs/js-ipfs-api"
-}
+}

src/get-files-stream.js

@@ -3,6 +3,7 @@
 const isNode = require('detect-node')
 const Multipart = require('multipart-stream')
 const flatmap = require('flatmap')
+const escape = require('glob-escape')
 
 function headers (file) {
   const name = file.path || ''
@@ -44,7 +45,7 @@ function loadPaths (opts, file) {
   }
 
   if (stats.isDirectory() && opts.recursive) {
-    const mg = new glob.sync.GlobSync(`${file}/**/*`, {
+    const mg = new glob.sync.GlobSync(`${escape(file)}/**/*`, {
       follow: followSymlinks
     })
 

test/fixtures/weird name folder [v0]/add

@@ -0,0 +1,22 @@
+'use strict'
+
+const ipfs = require('../src')('localhost', 5001)
+
+const f1 = 'Hello'
+const f2 = 'World'
+
+ipfs.add([new Buffer(f1), new Buffer(f2)], function (err, res) {
+  if (err || !res) return console.log(err)
+
+  for (let i = 0; i < res.length; i++) {
+    console.log(res[i])
+  }
+})
+
+ipfs.add(['./files/hello.txt', './files/ipfs.txt'], function (err, res) {
+  if (err || !res) return console.log(err)
+
+  for (let i = 0; i < res.length; i++) {
+    console.log(res[i])
+  }
+})

test/fixtures/weird name folder [v0]/cat

@@ -0,0 +1,18 @@
+'use strict'
+
+const ipfs = require('../src')('localhost', 5001)
+
+const hash = [
+  'QmdFyxZXsFiP4csgfM5uPu99AvFiKH62CSPDw5TP92nr7w',
+  'QmY9cxiHqTFoWamkQVkpmmqzBrY3hCBEL2XNu3NtX74Fuu'
+]
+
+ipfs.cat(hash, function (err, res) {
+  if (err || !res) return console.log(err)
+
+  if (res.readable) {
+    res.pipe(process.stdout)
+  } else {
+    console.log(res)
+  }
+})

test/fixtures/weird name folder [v0]/files/hello.txt

@@ -0,0 +1 @@
+Hello

test/fixtures/weird name folder [v0]/files/ipfs.txt

@@ -0,0 +1 @@
+IPFS

test/fixtures/weird name folder [v0]/hello-link

@@ -0,0 +1 @@
+files/hello.txt

test/fixtures/weird name folder [v0]/ipfs-add

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+
+'use strict'
+
+const ipfs = require('../src')('localhost', 5001)
+const files = process.argv.slice(2)
+
+ipfs.add(files, {recursive: true}, function (err, res) {
+  if (err || !res) return console.log(err)
+
+  for (let i = 0; i < res.length; i++) {
+    console.log('added', res[i].Hash, res[i].Name)
+  }
+})

test/fixtures/weird name folder [v0]/ls

@@ -0,0 +1,18 @@
+'use strict'
+
+const ipfs = require('../src')('localhost', 5001)
+
+const hash = ['QmdbHK6gMiecyjjSoPnfJg6iKMF7v6E2NkoBgGpmyCoevh']
+
+ipfs.ls(hash, function (err, res) {
+  if (err || !res) return console.log(err)
+
+  res.Objects.forEach(function (node) {
+    console.log(node.Hash)
+
+    console.log('Links [%d]', node.Links.length)
+    node.Links.forEach(function (link, i) {
+      console.log('[%d]', i, link)
+    })
+  })
+})

test/fixtures/weird name folder [v0]/version

@@ -0,0 +1,8 @@
+'use strict'
+
+const ipfs = require('../src')('localhost', 5001)
+
+ipfs.commands(function (err, res) {
+  if (err) throw err
+  console.log(res)
+})

test/ipfs-api/util.spec.js

@@ -51,6 +51,15 @@ describe('.util', () => {
     })
   })
 
+  it('.fsAdd a directory with an odd name', (done) => {
+    const filesPath = path.join(__dirname, '../fixtures/weird name folder [v0]')
+    ipfs.util.addFromFs(filesPath, { recursive: true }, (err, result) => {
+      expect(err).to.not.exist
+      expect(result.length).to.be.above(8)
+      done()
+    })
+  })
+
   it('.fsAdd a file', (done) => {
     const filePath = path.join(__dirname, '../fixtures/testfile.txt')
     ipfs.util.addFromFs(filePath, (err, result) => {