This repository has been archived by the owner on Aug 12, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Add reader to read files or part of files as streams
- Loading branch information
1 parent
bd7624d
commit 66be6b3
Showing
7 changed files
with
477 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| 'use strict' | ||
|
|
||
| const CID = require('cids') | ||
| const pull = require('pull-stream') | ||
| const asyncValues = require('pull-async-values') | ||
| const asyncMap = require('pull-stream/throughs/async-map') | ||
| const map = require('pull-stream/throughs/map') | ||
| const UnixFS = require('ipfs-unixfs') | ||
| const toB58String = require('multihashes').toB58String | ||
| const waterfall = require('async/waterfall') | ||
|
|
||
| module.exports = (path, ipldResolver, begin = 0, end) => { | ||
| let streamPosition = 0 | ||
|
|
||
| return pull( | ||
| asyncValues((cb) => { | ||
| waterfall([ | ||
| (next) => toCid(path, next), | ||
| (cid, next) => ipldResolver.get(cid, next), | ||
| (node, next) => { | ||
| const meta = UnixFS.unmarshal(node.value.data) | ||
|
|
||
| if (meta.type !== 'file') { | ||
| return next(new Error(`Path ${path} was not a file (was ${meta.type}), can only read files`)) | ||
| } | ||
|
|
||
| const fileSize = meta.fileSize() | ||
|
|
||
| if (!end || end > fileSize) { | ||
| end = fileSize | ||
| } | ||
|
|
||
| if (begin < 0) { | ||
| begin = fileSize + begin | ||
| } | ||
|
|
||
| if (end < 0) { | ||
| end = fileSize + end | ||
| } | ||
|
|
||
| const links = node.value.links | ||
|
|
||
| if (!links || !links.length) { | ||
| if (meta.data && meta.data.length) { | ||
| // file was small enough to fit in one DAGNode so has no links | ||
| return next(null, [(done) => done(null, meta.data)]) | ||
| } | ||
|
|
||
| return next(new Error(`Path ${path} had no links or data`)) | ||
| } | ||
|
|
||
| const linkedDataSize = links.reduce((acc, curr) => acc + curr.size, 0) | ||
| const overhead = (linkedDataSize - meta.fileSize()) / links.length | ||
|
|
||
| // create an array of functions to fetch link data | ||
| next(null, links.map((link) => (done) => { | ||
| // DAGNode Links report unixfs object data sizes $overhead bytes (typically 14) | ||
| // larger than they actually are due to the protobuf wrapper | ||
| const bytesInLinkedObjectData = link.size - overhead | ||
|
|
||
| if (begin > (streamPosition + bytesInLinkedObjectData)) { | ||
| // Start byte is after this block so skip it | ||
| streamPosition += bytesInLinkedObjectData | ||
|
|
||
| return done() | ||
| } | ||
|
|
||
| if (end < streamPosition) { | ||
| // End byte was before this block so skip it | ||
| streamPosition += bytesInLinkedObjectData | ||
|
|
||
| return done() | ||
| } | ||
|
|
||
| // transform the multihash to a cid, the cid to a node and the node to some data | ||
| waterfall([ | ||
| (next) => toCid(link.multihash, next), | ||
| (cid, next) => ipldResolver.get(cid, next), | ||
| (node, next) => next(null, node.value.data), | ||
| (data, next) => next(null, UnixFS.unmarshal(data).data) | ||
| ], done) | ||
| })) | ||
| } | ||
| ], cb) | ||
| }), | ||
| asyncMap((loadLinkData, cb) => loadLinkData(cb)), | ||
| pull.filter(Boolean), | ||
| map((data) => { | ||
| const block = extractDataFromBlock(data, streamPosition, begin, end) | ||
|
|
||
| streamPosition += data.length | ||
|
|
||
| return block | ||
| }) | ||
| ) | ||
| } | ||
|
|
||
| function toCid (input, callback) { | ||
| let path = input | ||
|
|
||
| try { | ||
| if (Buffer.isBuffer(path)) { | ||
| path = toB58String(path) | ||
| } | ||
|
|
||
| if (path.indexOf('/ipfs/') === 0) { | ||
| path = path.substring('/ipfs/'.length) | ||
| } | ||
|
|
||
| if (path.charAt(path.length - 1) === '/') { | ||
| path = path.substring(0, path.length - 1) | ||
| } | ||
|
|
||
| callback(null, new CID(path)) | ||
| } catch (error) { | ||
| callback(new Error(`Path '${input}' was invalid: ${error.message}`)) | ||
| } | ||
| } | ||
|
|
||
| function extractDataFromBlock (block, streamPosition, begin, end) { | ||
| const blockLength = block.length | ||
|
|
||
| if (end - streamPosition < blockLength) { | ||
| // If the end byte is in the current block, truncate the block to the end byte | ||
| block = block.slice(0, end - streamPosition) | ||
| } | ||
|
|
||
| if (begin > streamPosition && begin < (streamPosition + blockLength)) { | ||
| // If the start byte is in the current block, skip to the start byte | ||
| block = block.slice(begin - streamPosition) | ||
| } | ||
|
|
||
| return block | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.