.travis.yml

@@ -1,5 +1,10 @@
 language: node_js
 node_js:
+ - "lts/*"
+ - "17"
+ - "16"
+ - "15"
+ - "14"
  - "13"
  - "12"
  - "10"

README.md

@@ -145,7 +145,7 @@ Example:
 ```js
 fs.createReadStream('path/to/archive.zip')
   .pipe(unzipper.ParseOne())
-  .pipe(fs.createReadStream('firstFile.txt'));
+  .pipe(fs.createWriteStream('firstFile.txt'));
 ```
 
 ### Buffering the content of an entry into memory
@@ -220,7 +220,7 @@ Example:
 ```js
 async function main() {
   const directory = await unzipper.Open.file('path/to/archive.zip');
-  console.log('directory', d);
+  console.log('directory', directory);
   return new Promise( (resolve, reject) => {
     directory.files[0]
       .stream()
@@ -317,6 +317,41 @@ async function main() {
 main();
 ```
 
+### Open.custom(source, [options])
+This function can be used to provide a custom source implementation. The source parameter expects a `stream` and a `size` function to be implemented. The size function should return a `Promise` that resolves the total size of the file. The stream function should return a `Readable` stream according to the supplied offset and length parameters.
+
+Example:
+
+```js
+// Custom source implementation for reading a zip file from Google Cloud Storage
+const { Storage } = require('@google-cloud/storage');
+
+async function main() {
+  const storage = new Storage();
+  const bucket = storage.bucket('my-bucket');
+  const zipFile = bucket.file('my-zip-file.zip');
+
+  const customSource = {
+    stream: function(offset, length) {
+      return zipFile.createReadStream({
+        start: offset,
+        end: length && offset + length
+      })
+    },
+    size: async function() {
+      const objMetadata = (await zipFile.getMetadata())[0];
+      return objMetadata.size;
+    }
+  };
+
+  const directory = await unzipper.Open.custom(customSource);
+  console.log('directory', directory);
+  // ...
+}
+
+main();
+```
+
 ### Open.[method].extract()
 
 The directory object returned from `Open.[method]` provides an `extract` method which extracts all the files to a specified `path`, with an optional `concurrency` (default: 1).

lib/Open/directory.js

@@ -141,11 +141,18 @@ module.exports = function centralDirectory(source, options) {
         vars.offsetToStartOfCentralDirectory += startOffset;
       }
     })
+    .then(function() {
+      if (vars.commentLength) return endDir.pull(vars.commentLength).then(function(comment) {
+        vars.comment = comment.toString('utf8');
+      });
+    })
     .then(function() {
       source.stream(vars.offsetToStartOfCentralDirectory).pipe(records);
 
       vars.extract = function(opts) {
         if (!opts || !opts.path) throw new Error('PATH_MISSING');
+        // make sure path is normalized before using it
+        opts.path = path.resolve(path.normalize(opts.path));
         return vars.files.then(function(files) {
           return Promise.map(files, function(entry) {
             if (entry.type == 'Directory') return;
@@ -166,7 +173,7 @@ module.exports = function centralDirectory(source, options) {
                 .on('close',resolve)
                 .on('error',reject);
             });
-          }, opts.concurrency > 1 ? {concurrency: opts.concurrency || undefined} : undefined);
+          }, { concurrency: opts.concurrency > 1 ? opts.concurrency : 1 });
         });
       };
 
@@ -198,7 +205,7 @@ module.exports = function centralDirectory(source, options) {
         return records.pull(vars.fileNameLength).then(function(fileNameBuffer) {
           vars.pathBuffer = fileNameBuffer;
           vars.path = fileNameBuffer.toString('utf8');
-          vars.isUnicode = vars.flags & 0x11;
+          vars.isUnicode = (vars.flags & 0x800) != 0;
           return records.pull(vars.extraFieldLength);
         })
         .then(function(extraField) {

lib/Open/index.js

@@ -92,6 +92,10 @@ module.exports = {
       }
     };
 
+    return directory(source, options);
+  },
+
+  custom: function(source, options) {
     return directory(source, options);
   }
 };

lib/Open/unzip.js

@@ -106,7 +106,9 @@ module.exports = function unzip(source,offset,_password, directoryVars) {
         .on('error',function(err) { entry.emit('error',err);})
         .pipe(entry)
         .on('finish', function() {
-          if (req.abort)
+          if(req.destroy)
+            req.destroy()
+          else if (req.abort)
             req.abort();
           else if (req.close)
             req.close();

lib/PullStream.js

@@ -78,10 +78,9 @@ PullStream.prototype.stream = function(eof,includeEof) {
     }
 
     if (!done) {
-      if (self.finished && !this.__ended) {
+      if (self.finished) {
         self.removeListener('chunk',pull);
         self.emit('error', new Error('FILE_ENDED'));
-        this.__ended = true;
         return;
       }
 

lib/parse.js

@@ -26,6 +26,7 @@ function Parse(opts) {
 
   PullStream.call(self, self._opts);
   self.on('finish',function() {
+    self.emit('end');
     self.emit('close');
   });
   self._readRecord().catch(function(e) {
@@ -51,16 +52,19 @@ Parse.prototype._readRecord = function () {
       return self._readFile();
     }
     else if (signature === 0x02014b50) {
-      self.__ended = true;
+      self.reachedCD = true;
       return self._readCentralDirectoryFileHeader();
     }
     else if (signature === 0x06054b50) {
       return self._readEndOfCentralDirectoryRecord();
     }
-    else if (self.__ended) {
-      return self.pull(endDirectorySignature).then(function() {
-          return self._readEndOfCentralDirectoryRecord();
-        });
+    else if (self.reachedCD) {
+      // _readEndOfCentralDirectoryRecord expects the EOCD
+      // signature to be consumed so set includeEof=true
+      var includeEof = true;
+      return self.pull(endDirectorySignature, includeEof).then(function() {
+        return self._readEndOfCentralDirectoryRecord();
+      });
     }
     else
       self.emit('error', new Error('invalid signature: 0x' + signature.toString(16)));
@@ -130,7 +134,7 @@ Parse.prototype._readFile = function () {
       entry.props.path = fileName;
       entry.props.pathBuffer = fileNameBuffer;
       entry.props.flags = {
-        "isUnicode": vars.flags & 0x11
+        "isUnicode": (vars.flags & 0x800) != 0
       };
       entry.type = (vars.uncompressedSize === 0 && /[\/\\]$/.test(fileName)) ? 'Directory' : 'File';
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "unzipper",
-  "version": "0.10.11",
+  "version": "0.10.14",
   "description": "Unzip cross-platform streaming API ",
   "author": "Evan Oxfeld <eoxfeld@gmail.com>",
   "contributors": [

test/compressed-crx.js

@@ -56,8 +56,8 @@ test('open methods', function(t) {
   var tests = [
     {name: 'buffer',args: [buffer]},
     {name: 'file', args: [archive]},
-    {name: 'url', args: [request, 'https://s3.amazonaws.com/unzipper/archive.crx']},
-    {name: 's3', args: [s3, { Bucket: 'unzipper', Key: 'archive.crx'}]}
+    // {name: 'url', args: [request, 'https://s3.amazonaws.com/unzipper/archive.crx']},
+    // {name: 's3', args: [s3, { Bucket: 'unzipper', Key: 'archive.crx'}]}
   ];
 
   tests.forEach(function(test) {
@@ -75,4 +75,4 @@ test('open methods', function(t) {
       });
     });
   });
-});
+});

test/extractFromUrl.js

@@ -0,0 +1,27 @@
+"use strict";
+
+var test = require("tap").test;
+var fs = require("fs");
+var unzip = require("../");
+var os = require("os");
+var request = require("request");
+
+test("extract zip from url", function (t) {
+  var extractPath = os.tmpdir() + "/node-unzip-extract-fromURL"; // Not using path resolve, cause it should be resolved in extract() function
+  unzip.Open.url(
+    request,
+    "https://github.com/h5bp/html5-boilerplate/releases/download/v7.3.0/html5-boilerplate_v7.3.0.zip"
+  )
+    .then(function(d) { return d.extract({ path: extractPath }); })
+    .then(function(d) {
+      var dirFiles = fs.readdirSync(extractPath);
+      var isPassing =
+        dirFiles.length > 10 &&
+        dirFiles.indexOf("css") > -1 &&
+        dirFiles.indexOf("index.html") > -1 &&
+        dirFiles.indexOf("favicon.ico") > -1;
+
+      t.equal(isPassing, true);
+      t.end();
+    });
+});

test/openComment.js

@@ -0,0 +1,16 @@
+'use strict';
+
+var test = require('tap').test;
+var path = require('path');
+var unzip = require('../');
+
+
+test("get comment out of a zip", function (t) {
+  var archive = path.join(__dirname, '../testData/compressed-comment/archive.zip');
+
+  unzip.Open.file(archive)
+    .then(function(d) {
+        t.equal('Zipfile has a comment', d.comment);
+        t.end();
+    });
+});

test/openCustom.js

@@ -0,0 +1,41 @@
+'use strict';
+
+var test = require('tap').test;
+var fs = require('fs');
+var path = require('path');
+var unzip = require('../unzip');
+var Promise = require('bluebird');
+
+test("get content of a single file entry out of a zip", function (t) {
+  var archive = path.join(__dirname, '../testData/compressed-standard/archive.zip');
+
+  var customSource = {
+    stream: function(offset,length) {
+      return fs.createReadStream(archive, {start: offset, end: length && offset+length});
+    },
+    size: function() {
+      return new Promise(function(resolve, reject) {
+        fs.stat(archive, function(err, d) {
+          if (err)
+            reject(err);
+          else
+            resolve(d.size);
+        });
+      });
+    }
+  };
+
+  return unzip.Open.custom(customSource)
+    .then(function(d) {
+      var file = d.files.filter(function(file) {
+        return file.path == 'file.txt';
+      })[0];
+
+      return file.buffer()
+        .then(function(str) {
+          var fileStr = fs.readFileSync(path.join(__dirname, '../testData/compressed-standard/inflated/file.txt'), 'utf8');
+          t.equal(str.toString(), fileStr);
+          t.end();
+        });
+    });
+});

test/openS3.js

@@ -17,7 +17,7 @@ s3.headObject = function(params,cb) {
   return s3.makeUnauthenticatedRequest('headObject',params,cb);
 };
 
-test("get content of a single file entry out of a zip", function (t) {
+test("get content of a single file entry out of a zip", { skip: true }, function(t) {
   return unzip.Open.s3(s3,{ Bucket: 'unzipper', Key: 'archive.zip' })
     .then(function(d) {
       var file = d.files.filter(function(file) {
@@ -31,4 +31,4 @@ test("get content of a single file entry out of a zip", function (t) {
           t.end();
         });
     });
-});
+});

test/zip64.js

@@ -5,6 +5,7 @@ var path = require('path');
 var unzip = require('../');
 var fs = require('fs');
 var Stream = require('stream');
+var temp = require('temp');
 
 var UNCOMPRESSED_SIZE = 5368709120;
 var ZIP64_OFFSET = 72;
@@ -76,8 +77,19 @@ t.test('Parse files from zip64 format correctly', function (t) {
       .pipe(unzip.Parse())
       .on('entry', function(entry) {
         t.same(entry.vars.uncompressedSize, ZIP64_SIZE, 'Parse: File header');
-        t.end();
-      });
+      })
+      .on('close', function() { t.end(); });
+  });
+
+  t.test('in unzipper.extract', function (t) {
+    temp.mkdir('node-unzip-', function (err, dirPath) {
+      if (err) {
+        throw err;
+      }
+      fs.createReadStream(archive)
+        .pipe(unzip.Extract({ path: dirPath }))
+        .on('close', function() { t.end(); });
+    });
   });
 
   t.end();  

testData/compressed-comment/inflated/dir/fileInsideDir.txt

@@ -0,0 +1 @@
+42

testData/compressed-comment/inflated/file.txt

@@ -0,0 +1 @@
+node.js rocks