unzipper - npm Package Compare versions

Comparing version 0.9.0-rc1 to 0.9.0-rc10

lib/Open/directory.js

@@ -1,6 +0,5 @@
-var binary = require('binary');
 var PullStream = require('../PullStream');
-var unzip = require('./unzip');
 var Promise = require('bluebird');
 var BufferStream = require('../BufferStream');
+var read = require('../read');
 
@@ -12,5 +11,3 @@ var signature = Buffer(4);
   var endDir = PullStream(),
-      records = PullStream(),
-      self = this,
-      vars;
+      records = PullStream();
 
@@ -23,62 +20,33 @@ return source.size()
     .then(function() {
-      return endDir.pull(22);
+      return read.endOfDirectory(endDir);
     })
-    .then(function(data) {
-      vars = binary.parse(data)
-        .word32lu('signature')
-        .word16lu('diskNumber')
-        .word16lu('diskStart')
-        .word16lu('numberOfRecordsOnDisk')
-        .word16lu('numberOfRecords')
-        .word32lu('sizeOfCentralDirectory')
-        .word32lu('offsetToStartOfCentralDirectory')
-        .word16lu('commentLength')
-        .vars;
-
+    .then(function(vars) {
+      Object.defineProperty(vars,'source',{value: source});
       source.stream(vars.offsetToStartOfCentralDirectory).pipe(records);
 
       vars.files = Promise.mapSeries(Array(vars.numberOfRecords),function() {
-        return records.pull(46).then(function(data) {    
-          var vars = binary.parse(data)
-            .word32lu('signature')
-            .word16lu('versionMadeBy')
-            .word16lu('versionsNeededToExtract')
-            .word16lu('flags')
-            .word16lu('compressionMethod')
-            .word16lu('lastModifiedTime')
-            .word16lu('lastModifiedDate')
-            .word32lu('crc32')
-            .word32lu('compressedSize')
-            .word32lu('uncompressedSize')
-            .word16lu('fileNameLength')
-            .word16lu('extraFieldLength')
-            .word16lu('fileCommentLength')
-            .word16lu('diskNumber')
-            .word16lu('internalFileAttributes')
-            .word32lu('externalFileAttributes')
-            .word32lu('offsetToLocalFileHeader')
-            .vars;
+        return read.directoryFileHeader(records)
+          .then(function(file) {
+            file.stream = function(_password, _raw) {
+              var input = source.stream(file.offsetToLocalFileHeader);
+              var output = read.fileStream(input.pipe(PullStream()),{password:_password, raw: _raw});
 
-        return records.pull(vars.fileNameLength).then(function(fileName) {
-          vars.path = fileName.toString('utf8');
-          return records.pull(vars.extraFieldLength);
-        })
-        .then(function(extraField) {
-          return records.pull(vars.fileCommentLength);
-        })
-        .then(function(comment) {
-          vars.comment = comment;
-          vars.stream = function(_password) {
-            return unzip(source, vars.offsetToLocalFileHeader,_password);
-          };
-          vars.buffer = function(_password) {
-            return BufferStream(vars.stream(_password));
-          };
-          return vars;
-        });
+              input.on('error',function(err) {
+                output.emit('error',err);
+              });
+                
+              return output;
+            };
+
+            file.buffer = function(_password) {
+              return BufferStream(file.stream(_password));
+            };
+            return file;
+          });
       });
+
+      return Promise.props(vars);
     });
 
-    return Promise.props(vars);
-  });
+    
 };

lib/Open/index.js

@@ -51,4 +51,28 @@ var fs = require('fs');
     return directory(source);
+  },
+
+  s3 : function(client,params) {
+    var source = {
+      size: function() {
+        return new Promise(function(resolve,reject) {
+          client.headObject(params, function(err,d) {
+            if (err)
+              reject(err);
+            else
+              resolve(d.ContentLength);
+          });
+        });
+      },
+      stream: function(offset,length) {
+        var d = {};
+        for (var key in params)
+          d[key] = params[key];
+        d.Range = 'bytes='+offset+'-' + (length ? length : '');
+        return client.getObject(d).createReadStream();
+      }
+    };
+
+    return directory(source);
   }
 };
 

lib/parse.js

 var util = require('util');
-var zlib = require('zlib');
 var Stream = require('stream');
-var binary = require('binary');
 var Promise = require('bluebird');
 var PullStream = require('./PullStream');
-var NoopStream = require('./NoopStream');
-var BufferStream = require('./BufferStream');
+var read = require('./read');
 
@@ -39,17 +36,22 @@ // Backwards compatibility for node 0.8
 
+    // Read signature and put back on buffer
     var signature = data.readUInt32LE(0);
+    self.buffer = Buffer.concat([data,self.buffer]);
 
-    if (signature === 0x04034b50) {
+    if (signature === 0x04034b50)
       return self._readFile();
-    }
     else if (signature === 0x02014b50) {
       self.__ended = true;
-      return self._readCentralDirectoryFileHeader();
+      return read.directoryFileHeader(self)
+        .then(function(vars) {
+          return self._readRecord();
+        });
     }
-    else if (signature === 0x06054b50) {
-      return self._readEndOfCentralDirectoryRecord();
-    }
-    else if (self.__ended) {
+    else if (signature === 0x06054b50 || self.__ended) { 
       return self.pull(endDirectorySignature).then(function() {
-          return self._readEndOfCentralDirectoryRecord();
+        return read.endOfDirectory(self);
+      })
+      .then(function() {
+          self.end();
+          self.push(null);
         });
@@ -64,176 +66,38 @@ }
   var self = this;
-  self.pull(26).then(function(data) {
-    var vars = binary.parse(data)
-      .word16lu('versionsNeededToExtract')
-      .word16lu('flags')
-      .word16lu('compressionMethod')
-      .word16lu('lastModifiedTime')
-      .word16lu('lastModifiedDate')
-      .word32lu('crc32')
-      .word32lu('compressedSize')
-      .word32lu('uncompressedSize')
-      .word16lu('fileNameLength')
-      .word16lu('extraFieldLength')
-      .vars;
+  var entry =  read.fileStream(self,self._opts);
 
-    return self.pull(vars.fileNameLength).then(function(fileName) {
-      fileName = fileName.toString('utf8');
-      var entry = Stream.PassThrough();
-      
-      entry.autodrain = function() {
-        return new Promise(function(resolve,reject) {
-          entry.pipe(NoopStream());
-          entry.on('finish',resolve);
-          entry.on('error',reject);
-        });
-      };
+  entry.header.then(function(vars) {
+    var fileSizeKnown = !(vars.flags & 0x08);
+    entry.path = vars.path;
+    entry.props = {};
+    entry.props.path = vars.fileName;
+    entry.type = (vars.compressedSize === 0 && /[\/\\]$/.test(vars.path)) ? 'Directory' : 'File';
 
-      entry.buffer = function() {
-        return BufferStream(entry);
-      };
+    entry.autodrain = function() {
+      entry.autodraining = true;
+      return new Promise(function(resolve,reject) {
+        entry.on('finish',resolve);
+        entry.on('error',reject);
+      });
+    };
 
-      entry.path = fileName;
-      entry.props = {};
-      entry.props.path = fileName;
-      entry.type = (vars.compressedSize === 0 && /[\/\\]$/.test(fileName)) ? 'Directory' : 'File';
+    self.emit('entry',entry);
 
-      if (self._opts.verbose) {
-        if (entry.type === 'Directory') {
-          console.log('   creating:', fileName);
-        } else if (entry.type === 'File') {
-          if (vars.compressionMethod === 0) {
-            console.log(' extracting:', fileName);
-          } else {
-            console.log('  inflating:', fileName);
-          }
-        }
-      }
+    if (self._readableState.pipesCount)
+      self.push(entry);
 
-      self.emit('entry', entry);
-
-      if (self._readableState.pipesCount)
-        self.push(entry);
+    entry
+      .on('finish', function() {
+        Promise.resolve(!fileSizeKnown && read.dataDescriptor(self))
+        .then(function() {
+          return self._readRecord();
+        });
         
-      self.pull(vars.extraFieldLength).then(function(extraField) {
-        var extra = binary.parse(extraField)
-          .word16lu('signature')
-          .word16lu('partsize')
-          .word64lu('uncompressedSize')
-          .word64lu('compressedSize')
-          .word64lu('offset')
-          .word64lu('disknum')
-          .vars;
-       
-        if (vars.compressedSize === 0xffffffff)
-          vars.compressedSize = extra.compressedSize;
-        
-        if (vars.uncompressedSize  === 0xffffffff)
-          vars.uncompressedSize= extra.uncompressedSize;
-
-        if (self._opts.verbose)
-          console.log({
-            filename:fileName,
-            vars: vars,
-            extra: extra
-          });
-
-        var fileSizeKnown = !(vars.flags & 0x08),
-            eof;
-
-        var inflater = vars.compressionMethod ? zlib.createInflateRaw() : Stream.PassThrough();
-
-        if (fileSizeKnown) {
-          entry.size = vars.uncompressedSize;
-          eof = vars.compressedSize;
-        } else {
-          eof = new Buffer(4);
-          eof.writeUInt32LE(0x08074b50, 0);
-        }
-
-        self.stream(eof)
-          .pipe(inflater)
-          .on('error',function(err) { self.emit('error',err);})
-          .pipe(entry)
-          .on('finish', function() {
-            return fileSizeKnown ? self._readRecord() : self._processDataDescriptor(entry);
-          });
       });
-    });
   });
-};
 
-Parse.prototype._processDataDescriptor = function (entry) {
-  var self = this;
-  self.pull(16).then(function(data) {
-    var vars = binary.parse(data)
-      .word32lu('dataDescriptorSignature')
-      .word32lu('crc32')
-      .word32lu('compressedSize')
-      .word32lu('uncompressedSize')
-      .vars;
-
-    entry.size = vars.uncompressedSize;
-    self._readRecord();
-  });
 };
 
-Parse.prototype._readCentralDirectoryFileHeader = function () {
-  var self = this;
-  self.pull(42).then(function(data) {
-    
-    var vars = binary.parse(data)
-      .word16lu('versionMadeBy')
-      .word16lu('versionsNeededToExtract')
-      .word16lu('flags')
-      .word16lu('compressionMethod')
-      .word16lu('lastModifiedTime')
-      .word16lu('lastModifiedDate')
-      .word32lu('crc32')
-      .word32lu('compressedSize')
-      .word32lu('uncompressedSize')
-      .word16lu('fileNameLength')
-      .word16lu('extraFieldLength')
-      .word16lu('fileCommentLength')
-      .word16lu('diskNumber')
-      .word16lu('internalFileAttributes')
-      .word32lu('externalFileAttributes')
-      .word32lu('offsetToLocalFileHeader')
-      .vars;
 
-    return self.pull(vars.fileNameLength).then(function(fileName) {
-      vars.fileName = fileName.toString('utf8');
-      return self.pull(vars.extraFieldLength);
-    })
-    .then(function(extraField) {
-      return self.pull(vars.fileCommentLength);
-    })
-    .then(function(fileComment) {
-      return self._readRecord();
-    });
-  });
-};
 
-Parse.prototype._readEndOfCentralDirectoryRecord = function() {
-  var self = this;
-  self.pull(18).then(function(data) {
-    
-    var vars = binary.parse(data)
-      .word16lu('diskNumber')
-      .word16lu('diskStart')
-      .word16lu('numberOfRecordsOnDisk')
-      .word16lu('numberOfRecords')
-      .word32lu('sizeOfCentralDirectory')
-      .word32lu('offsetToStartOfCentralDirectory')
-      .word16lu('commentLength')
-      .vars;
-
-    self.pull(vars.commentLength).then(function(comment) {
-      comment = comment.toString('utf8');
-      self.end();
-      self.push(null);
-    });
-    
-  });
-};
-
 Parse.prototype.promise = function() {
@@ -240,0 +104,0 @@ var self = this;

lib/parseOne.js

 var Stream = require('stream');
 var Parse = require('./parse');
 var duplexer2 = require('duplexer2');
+var BufferStream = require('./BufferStream');
 
@@ -10,2 +11,3 @@ // Backwards compatibility for node 0.8
 function parseOne(match,opts) {
+  opts = opts || {};
   var inStream = Stream.PassThrough({objectMode:true});
@@ -18,2 +20,3 @@ var outStream = Stream.PassThrough();
   transform._transform = function(entry,e,cb) {
+    entry.password = opts.password;
     if (found || (re && !re.exec(entry.path))) {
@@ -24,2 +27,6 @@ entry.autodrain();
       found = true;
+      out.emit('entry',entry);
+      entry.on('error',function(e) {
+        outStream.emit('error',e);
+      });
       entry.pipe(outStream)
@@ -36,3 +43,7 @@ .on('error',function(err) {
   inStream.pipe(Parse(opts))
+    .on('error',function(err) {
+      outStream.emit('error',err);
+    })
     .pipe(transform)
+    .on('error',Object)  // Silence error as its already addressed in transform
     .on('finish',function() {
@@ -45,3 +56,8 @@ if (!found)
 
-  return duplexer2(inStream,outStream);
+  var out = duplexer2(inStream,outStream);
+  out.buffer = function() {
+    return BufferStream(outStream);
+  };
+
+  return out;
 }
@@ -48,0 +64,0 @@

lib/PullStream.js

@@ -36,3 +36,3 @@ var Stream = require('stream');
   var p = Stream.PassThrough();
-  var count = 0,done,packet,self= this;
+  var done,packet,self= this;
 
@@ -60,3 +60,3 @@ function pull() {
       p.write(packet,function() {
-        if (!self.buffer.length) self.cb();
+        if (self.buffer.length === (eof.length || 0)) self.cb();
       });
@@ -66,9 +66,8 @@ }
     if (!done) {
-      if (self.finished && !this.__ended) {
+      if (self.finished && !self.__ended) {
         self.removeListener('chunk',pull);
-        p.emit('error','FILE_ENDED');
+        p.emit('error',new Error('FILE_ENDED'));
         this.__ended = true;
         return;
       }
-      
     } else {
@@ -108,3 +107,3 @@ self.removeListener('chunk',pull);
     if (self.finished)
-      return reject('FILE_ENDED');
+      return reject(new Error('FILE_ENDED'));
     self.stream(eof,includeEof)
@@ -111,0 +110,0 @@ .on('error',reject)

package.json

 {
   "name": "unzipper",
-  "version": "0.9.0-rc1",
+  "version": "0.9.0-rc10",
   "description": "Unzip cross-platform streaming API ",
@@ -24,5 +24,2 @@ "author": "Evan Oxfeld <[e-mail]>",
   },
-  "bin": {
-    "webunzip": "bin/webunzip.js"
-  },
   "license": "MIT",
@@ -41,4 +38,5 @@ "dependencies": {
   "devDependencies": {
+    "aws-sdk": "^2.77.0",
     "request": "^2.79.0",
-    "tap": ">= 0.3.0 < 1",
+    "tap": "^10.3.2",
     "temp": ">= 0.4.0 < 1",
@@ -48,10 +46,2 @@ "dirdiff": ">= 0.0.1 < 1",
   },
-  "dependencies": {
-    "fstream": "~1.0.10",
-    "inquirer": "~2.0.0",
-    "minimist": "~1.2.0",
-    "multi-progress": "~2.0.0",
-    "progress": "~1.1.8",
-    "request": "~2.79.0"
-  },
   "directories": {
@@ -58,0 +48,0 @@ "example": "examples",

README.md

@@ -64,3 +64,3 @@ # unzipper [![Build Status](https://api.travis-ci.org/ZJONSSON/node-unzipper.png)](https://api.travis-ci.org/ZJONSSON/node-unzipper)
     objectMode: true,
-    _transform: function(entry,e,cb) {
+    transform: function(entry,e,cb) {
       var fileName = entry.path;
@@ -185,3 +185,26 @@ var type = entry.type; // 'Directory' or 'File'
 
+### Open.s3([aws-sdk], [params])
+This function will return a Promise to the central directory information from a zipfile on S3.  Range-headers are used to avoid reading the whole file.    Unzipper does not ship with with the aws-sdk so you have to provide an instanciated client as first arguments.    The params object requires `Bucket` and `Key` to fetch the correct file.
+
+Example:
+
+```js
+var unzipper = require('./unzip');
+var AWS = require('aws-sdk');
+var s3Client = AWS.S3(config);
+
+unzipper.Open.s3(s3Client,{Bucket: 'unzipper', Key: 'archive.zip'})
+  .then(function(d) {
+    console.log('directory',d);
+    return new Promise(function(resolve,reject) {
+      d.files[0].stream()
+        .pipe(fs.createWriteStream('firstFile'))
+        .on('error',reject);
+        .on('finish',resolve)
+     });
+  });
+```
+
+
 ## Licenses
-See LICENCE
+See LICENCE

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

209

12.97%

Number of low supply chain risk alerts

2

-86.67%

Worsened metrics

Total package byte prevSize

30792

-68.59%

Dependency count

9

50%

Dev dependency count

6

20%

Number of package files

20

-55.56%

Lines of code

633

-43.93%

Number of medium supply chain risk alerts

1

Infinity%

Dependency changes

• + Added

  big-integer@^1.6.17

• + Added

  binary@~0.3.0

• + Added

  bluebird@~3.4.1

• + Added

  buffer-indexof-polyfill@~1.0.0

• + Added

  duplexer2@~0.1.4

• + Added

  listenercount@~1.0.1

• + Added

  readable-stream@~2.1.5

• + Added

  setimmediate@~1.0.4

• + Added

  big-integer@1.6.52
  (transitive)

• + Added

  binary@0.3.0
  (transitive)

• + Added

  bluebird@3.4.7
  (transitive)

• + Added

  buffer-indexof-polyfill@1.0.2
  (transitive)

• + Added

  buffer-shims@1.0.0
  (transitive)

• + Added

  buffers@0.1.1
  (transitive)

• + Added

  chainsaw@0.1.0
  (transitive)

• + Added

  duplexer2@0.1.4
  (transitive)

• + Added

  listenercount@1.0.1
  (transitive)

• + Added

  process-nextick-args@1.0.7
  (transitive)

• + Added

  readable-stream@2.1.5
  (transitive)

• + Added

  setimmediate@1.0.5
  (transitive)

• + Added

  string_decoder@0.10.31
  (transitive)

• + Added

  traverse@0.3.9
  (transitive)

• - Removed

  inquirer@~2.0.0

• - Removed

  minimist@~1.2.0

• - Removed

  multi-progress@~2.0.0

• - Removed

  progress@~1.1.8

• - Removed

  request@~2.79.0

• - Removed

  ansi-escapes@1.4.0
  (transitive)

• - Removed

  ansi-regex@2.1.13.0.1
  (transitive)

• - Removed

  ansi-styles@2.2.1
  (transitive)

• - Removed

  asn1@0.2.6
  (transitive)

• - Removed

  assert-plus@0.2.01.0.0
  (transitive)

• - Removed

  asynckit@0.4.0
  (transitive)

• - Removed

  aws-sign2@0.6.0
  (transitive)

• - Removed

  aws4@1.13.2
  (transitive)

• - Removed

  bcrypt-pbkdf@1.0.2
  (transitive)

• - Removed

  boom@2.10.1
  (transitive)

• - Removed

  buffer-from@1.1.2
  (transitive)

• - Removed

  caseless@0.11.0
  (transitive)

• - Removed

  chalk@1.1.3
  (transitive)

• - Removed

  cli-cursor@1.0.2
  (transitive)

• - Removed

  cli-width@2.2.1
  (transitive)

• - Removed

  combined-stream@1.0.8
  (transitive)

• - Removed

  commander@2.20.3
  (transitive)

• - Removed

  concat-stream@1.6.2
  (transitive)

• - Removed

  core-util-is@1.0.2
  (transitive)

• - Removed

  cryptiles@2.0.5
  (transitive)

• - Removed

  dashdash@1.14.1
  (transitive)

• - Removed

  delayed-stream@1.0.0
  (transitive)

• - Removed

  ecc-jsbn@0.1.2
  (transitive)

• - Removed

  escape-string-regexp@1.0.5
  (transitive)

• - Removed

  exit-hook@1.1.1
  (transitive)

• - Removed

  extend@3.0.2
  (transitive)

• - Removed

  external-editor@1.1.1
  (transitive)

• - Removed

  extsprintf@1.3.0
  (transitive)

• - Removed

  figures@2.0.0
  (transitive)

• - Removed

  forever-agent@0.6.1
  (transitive)

• - Removed

  form-data@2.1.4
  (transitive)

• - Removed

  generate-function@2.3.1
  (transitive)

• - Removed

  generate-object-property@1.2.0
  (transitive)

• - Removed

  getpass@0.1.7
  (transitive)

• - Removed

  har-validator@2.0.6
  (transitive)

• - Removed

  has-ansi@2.0.0
  (transitive)

• - Removed

  hawk@3.1.3
  (transitive)

• - Removed

  hoek@2.16.3
  (transitive)

• - Removed

  http-signature@1.1.1
  (transitive)

• - Removed

  inquirer@2.0.0
  (transitive)

• - Removed

  is-fullwidth-code-point@2.0.0
  (transitive)

• - Removed

  is-my-ip-valid@1.0.1
  (transitive)

• - Removed

  is-my-json-valid@2.20.6
  (transitive)

• - Removed

  is-property@1.0.2
  (transitive)

• - Removed

  is-typedarray@1.0.0
  (transitive)

• - Removed

  isstream@0.1.2
  (transitive)

• - Removed

  jsbn@0.1.1
  (transitive)

• - Removed

  json-schema@0.4.0
  (transitive)

• - Removed

  json-stringify-safe@5.0.1
  (transitive)

• - Removed

  jsonpointer@5.0.1
  (transitive)

• - Removed

  jsprim@1.4.2
  (transitive)

• - Removed

  lodash@4.17.21
  (transitive)

• - Removed

  mime-db@1.52.0
  (transitive)

• - Removed

  mime-types@2.1.35
  (transitive)

• - Removed

  multi-progress@2.0.0
  (transitive)

• - Removed

  mute-stream@0.0.6
  (transitive)

• - Removed

  oauth-sign@0.8.2
  (transitive)

• - Removed

  onetime@1.1.0
  (transitive)

• - Removed

  os-shim@0.1.3
  (transitive)

• - Removed

  os-tmpdir@1.0.2
  (transitive)

• - Removed

  pinkie@2.0.4
  (transitive)

• - Removed

  pinkie-promise@2.0.1
  (transitive)

• - Removed

  process-nextick-args@2.0.1
  (transitive)

• - Removed

  progress@1.1.8
  (transitive)

• - Removed

  punycode@1.4.1
  (transitive)

• - Removed

  qs@6.3.3
  (transitive)

• - Removed

  readable-stream@2.3.8
  (transitive)

• - Removed

  request@2.79.0
  (transitive)

• - Removed

  restore-cursor@1.0.1
  (transitive)

• - Removed

  run-async@2.4.1
  (transitive)

• - Removed

  rx@4.1.0
  (transitive)

• - Removed

  safe-buffer@5.1.2
  (transitive)

• - Removed

  safer-buffer@2.1.2
  (transitive)

• - Removed

  sntp@1.0.9
  (transitive)

• - Removed

  spawn-sync@1.0.15
  (transitive)

• - Removed

  sshpk@1.18.0
  (transitive)

• - Removed

  string-width@2.1.1
  (transitive)

• - Removed

  string_decoder@1.1.1
  (transitive)

• - Removed

  stringstream@0.0.6
  (transitive)

• - Removed

  strip-ansi@3.0.14.0.0
  (transitive)

• - Removed

  supports-color@2.0.0
  (transitive)

• - Removed

  through@2.3.8
  (transitive)

• - Removed

  tmp@0.0.29
  (transitive)

• - Removed

  tough-cookie@2.3.4
  (transitive)

• - Removed

  tunnel-agent@0.4.3
  (transitive)

• - Removed

  tweetnacl@0.14.5
  (transitive)

• - Removed

  typedarray@0.0.6
  (transitive)

• - Removed

  uuid@3.4.0
  (transitive)

• - Removed

  verror@1.10.0
  (transitive)

• - Removed

  xtend@4.0.2
  (transitive)