1. module extract-zip
   1. function extract-zip (zipPath, opts, cb)

module extract-zip

function extract-zip (zipPath, opts, cb)

• description and source-code

  extract-zip = function (zipPath, opts, cb) {
    debug('creating target directory', opts.dir)
  
    mkdirp(opts.dir, function (err) {
      if (err) return cb(err)
      openZip()
    })
  
    function openZip () {
      debug('opening', zipPath, 'with opts', opts)
  
      yauzl.open(zipPath, {lazyEntries: true}, function (err, zipfile) {
        if (err) return cb(err)
  
        var cancelled = false
  
        zipfile.readEntry()
  
        zipfile.on('close', function () {
          if (!cancelled) {
            debug('zip extraction complete')
            cb()
          }
        })
  
        zipfile.on('entry', function (entry) {
          if (cancelled) {
            debug('skipping entry', entry.fileName, {cancelled: cancelled})
            return
          }
  
          debug('zipfile entry', entry.fileName)
  
          if (/^__MACOSX\//.test(entry.fileName)) {
            // dir name starts with __MACOSX/
            zipfile.readEntry()
            return
          }
  
          extractEntry(entry, function (err) {
            // if any extraction fails then abort everything
            if (err) {
              cancelled = true
              zipfile.close()
              return cb(err)
            }
            debug('finished processing', entry.fileName)
            zipfile.readEntry()
          })
        })
  
        function extractEntry (entry, done) {
          if (cancelled) {
            debug('skipping entry extraction', entry.fileName, {cancelled: cancelled})
            return setImmediate(done)
          }
  
          if (opts.onEntry) {
            opts.onEntry(entry, zipfile)
          }
  
          var dest = path.join(opts.dir, entry.fileName)
  
          // convert external file attr int into a fs stat mode int
          var mode = (entry.externalFileAttributes >> 16) & 0xFFFF
          // check if it's a symlink or dir (using stat mode constants)
          var IFMT = 61440
          var IFDIR = 16384
          var IFLNK = 40960
          var symlink = (mode & IFMT) === IFLNK
          var isDir = (mode & IFMT) === IFDIR
  
          // check for windows weird way of specifying a directory
          // https://github.com/maxogden/extract-zip/issues/13#issuecomment-154494566
          var madeBy = entry.versionMadeBy >> 8
          if (!isDir) isDir = (madeBy === 0 && entry.externalFileAttributes === 16)
  
          // if no mode then default to default modes
          if (mode === 0) {
            if (isDir) {
              if (opts.defaultDirMode) mode = parseInt(opts.defaultDirMode, 10)
              if (!mode) mode = 493 // Default to 0755
            } else {
              if (opts.defaultFileMode) mode = parseInt(opts.defaultFileMode, 10)
              if (!mode) mode = 420 // Default to 0644
            }
          }
  
          debug('extracting entry', { filename: entry.fileName, isDir: isDir, isSymlink: symlink })
  
          // reverse umask first (~)
          var umask = ~process.umask()
          // & with processes umask to override invalid perms
          var procMode = mode & umask
  
          // always ensure folders are created
          var destDir = dest
          if (!isDir) destDir = path.dirname(dest)
  
          debug('mkdirp', {dir: destDir})
          mkdirp(destDir, function (err) {
            if (err) {
              debug('mkdirp error', destDir, {error: err})
              cancelled = true
              return done(err)
            }
  
            if (isDir) return done()
  
            debug('opening read stream', dest)
            zipfile.openReadStream(entry, function (err, readStream) {
              if (err) {
                debug('openReadStream error', err)
                cancelled = true
                return done(err)
              }
  
              readStream.on('error', function (err) {
                console.log('read err', err)
              })
  
              if (symlink) writeSymlink()
              else writeStream()
  
              function writeStream () {
                var writeStream = fs.createWriteStream(dest, {mode: procMode})
                readStream.pipe(writeStream)
  
                writeStream.on('finish', function () {
                  done()
                })
  
                writeStream.on('error', function (err) {
                  debug('write error', {error: err}) ...

• example usage

  n/a