Merge pull request #337 from ipfs/feat/ipfs.files.get

feat/ipfs.files.get

Author: daviddias

package.json

@@ -30,11 +30,12 @@
     "url": "https://github.com/ipfs/js-ipfs-api"
   },
   "devDependencies": {
-    "aegir": "^5.0.1",
+    "aegir": "^6.0.0",
     "chai": "^3.5.0",
     "gulp": "^3.9.1",
-    "interface-ipfs-core": "^0.5.0",
+    "interface-ipfs-core": "^0.6.0",
     "ipfsd-ctl": "^0.14.0",
+    "passthrough-counter": "^1.0.0",
     "pre-commit": "^1.1.3",
     "stream-equal": "^0.1.8",
     "stream-http": "^2.3.1",

src/add-to-dagnode-transform.js

@@ -8,6 +8,7 @@ module.exports = function (err, res, send, done) {
   if (err) {
     return done(err)
   }
+
   async.map(res, function map (entry, next) {
     getDagNode(send, entry.Hash, function (err, node) {
       if (err) {

src/api/add-files.js

@@ -1,5 +1,6 @@
 'use strict'
 
+const isNode = require('detect-node')
 const addToDagNodesTransform = require('../add-to-dagnode-transform')
 
 module.exports = (send) => {
@@ -9,6 +10,10 @@ module.exports = (send) => {
       opts = {}
     }
 
+    if (!isNode) {
+      return cb(new Error('Recursive uploads are not supported in the browser'))
+    }
+
     if (typeof (path) !== 'string') {
       return cb(new Error('"path" must be a string'))
     }

src/api/cat.js

@@ -1,8 +1,7 @@
 'use strict'
 
-const bs58 = require('bs58')
-const isIPFS = require('is-ipfs')
 const promisify = require('promisify-es6')
+const cleanMultihash = require('../clean-multihash')
 
 module.exports = (send) => {
   const cat = promisify((multihash, callback) => {
@@ -15,13 +14,3 @@ module.exports = (send) => {
   })
   return cat
 }
-
-function cleanMultihash (multihash) {
-  if (!isIPFS.multihash(multihash)) {
-    throw new Error('not valid multihash')
-  }
-  if (Buffer.isBuffer(multihash)) {
-    return bs58.encode(multihash)
-  }
-  return multihash
-}

src/api/get.js

@@ -0,0 +1,30 @@
+'use strict'
+
+const tarStreamToObjects = require('../tar-stream-to-objects')
+const cleanMultihash = require('../clean-multihash')
+const promisify = require('promisify-es6')
+
+module.exports = (send) => {
+  return promisify(function get (path, opts, cb) {
+    if (typeof opts === 'function' && !cb) {
+      cb = opts
+      opts = {}
+    }
+
+    // opts is the real callback -- 'cb' is being injected by promisify
+    if (typeof opts === 'function' && typeof cb === 'function') {
+      cb = opts
+      opts = {}
+    }
+
+    try {
+      path = cleanMultihash(path)
+    } catch (err) {
+      return cb(err)
+    }
+
+    var sendWithTransform = send.withTransform(tarStreamToObjects)
+
+    return sendWithTransform('get', path, opts, null, cb)
+  })
+}

src/clean-multihash.js

@@ -0,0 +1,15 @@
+'use strict'
+
+const bs58 = require('bs58')
+const isIPFS = require('is-ipfs')
+
+module.exports = function (multihash) {
+  if (!isIPFS.multihash(multihash)) {
+    throw new Error('not valid multihash')
+  }
+  if (Buffer.isBuffer(multihash)) {
+    return bs58.encode(multihash)
+  }
+  return multihash
+}
+

src/load-commands.js

@@ -13,6 +13,7 @@ function requireCommands () {
     dht: require('./api/dht'),
     diag: require('./api/diag'),
     id: require('./api/id'),
+    get: require('./api/get'),
     log: require('./api/log'),
     ls: require('./api/ls'),
     mount: require('./api/mount'),
@@ -33,6 +34,12 @@ function requireCommands () {
     const files = require('./api/files')(send)
     files.add = require('./api/add')(send)
     files.createAddStream = require('./api/add-stream.js')(send)
+    files.get = require('./api/get')(send)
+
+    // aliases
+    cmds.add = files.add
+    cmds.createAddStream = files.createAddStream
+    cmds.get = files.get
 
     return files
   }

src/request-api.js

@@ -4,20 +4,27 @@ const Wreck = require('wreck')
 const Qs = require('qs')
 const ndjson = require('ndjson')
 const getFilesStream = require('./get-files-stream')
+const Counter = require('passthrough-counter')
 
 const isNode = require('detect-node')
 
 // -- Internal
 
 function parseChunkedJson (res, cb) {
   const parsed = []
+  const c = new Counter()
   res
+    .pipe(c)
     .pipe(ndjson.parse())
-    .on('data', parsed.push.bind(parsed))
-    .on('end', () => cb(null, parsed))
+    .on('data', (obj) => {
+      parsed.push(obj)
+    })
+    .on('end', () => {
+      cb(null, parsed)
+    })
 }
 
-function onRes (buffer, cb) {
+function onRes (buffer, cb, uri) {
   return (err, res) => {
     if (err) {
       return cb(err)
@@ -42,10 +49,14 @@ function onRes (buffer, cb) {
       })
     }
 
-    if (stream && !buffer) return cb(null, res)
+    if (stream && !buffer) {
+      return cb(null, res)
+    }
 
     if (chunkedObjects) {
-      if (isJson) return parseChunkedJson(res, cb)
+      if (isJson) {
+        return parseChunkedJson(res, cb)
+      }
 
       return Wreck.read(res, null, cb)
     }
@@ -56,6 +67,11 @@ function onRes (buffer, cb) {
 
 function requestAPI (config, path, args, qs, files, buffer, cb) {
   qs = qs || {}
+
+  if (Array.isArray(files)) {
+    qs.recursive = true
+  }
+
   if (Array.isArray(path)) path = path.join('/')
   if (args && !Array.isArray(args)) args = [args]
   if (args) qs.arg = args
@@ -67,10 +83,6 @@ function requestAPI (config, path, args, qs, files, buffer, cb) {
     delete qs.r
   }
 
-  if (!isNode && qs.recursive && path === 'add') {
-    return cb(new Error('Recursive uploads are not supported in the browser'))
-  }
-
   qs['stream-channels'] = true
 
   let stream
@@ -104,7 +116,7 @@ function requestAPI (config, path, args, qs, files, buffer, cb) {
     opts.payload = stream
   }
 
-  return Wreck.request(opts.method, opts.uri, opts, onRes(buffer, cb))
+  return Wreck.request(opts.method, opts.uri, opts, onRes(buffer, cb, opts.uri))
 }
 
 // -- Interface
@@ -128,9 +140,9 @@ exports = module.exports = function getRequestAPI (config) {
     return requestAPI(config, path, args, qs, files, buffer, cb)
   }
 
-  // Wraps the 'send' function such that an asynchronous transform may be
-  // applied to its result before passing it on to either its callback or
-  // promise.
+  // Wraps the 'send' function such that an asynchronous
+  // transform may be applied to its result before
+  // passing it on to either its callback or promise.
   send.withTransform = function (transform) {
     return function (path, args, qs, files, buffer, cb) {
       if (typeof buffer === 'function') {

src/tar-stream-to-objects.js

@@ -0,0 +1,32 @@
+'use strict'
+
+const tar = require('tar-stream')
+const Readable = require('readable-stream')
+
+// transform tar stream into readable stream of
+// { path: 'string', content: Readable }
+module.exports = function (err, res, send, done) {
+  if (err) {
+    return done(err)
+  }
+
+  var ex = tar.extract()
+  res.pipe(ex)
+
+  var objStream = new Readable({ objectMode: true })
+  objStream._read = function noop () {}
+
+  ex.on('entry', function (header, stream, next) {
+    objStream.push({
+      path: header.name,
+      content: header.type !== 'directory' ? stream : null
+    })
+    next()
+  })
+  ex.on('finish', () => {
+    objStream.push(null)
+  })
+
+  done(null, objStream)
+}
+

tasks/daemons.js

@@ -1,4 +1,5 @@
 'use strict'
+/* eslint max-nested-callbacks: ["error", 8] */ // TODO reduce nesteness
 
 const gulp = require('gulp')
 const fs = require('fs')