| 1 | var fs = require('fs') |
| 2 | var path = require('path') |
| 3 | var yauzl = require('yauzl') |
| 4 | var mkdirp = require('mkdirp') |
| 5 | var concat = require('concat-stream') |
| 6 | var debug = require('debug')('extract-zip') |
| 7 | |
| 8 | module.exports = function (zipPath, opts, cb) { |
| 9 | debug('creating target directory', opts.dir) |
| 10 | |
| 11 | if (path.isAbsolute(opts.dir) === false) { |
| 12 | return cb(new Error('Target directory is expected to be absolute')) |
| 13 | } |
| 14 | |
| 15 | mkdirp(opts.dir, function (err) { |
| 16 | if (err) return cb(err) |
| 17 | |
| 18 | fs.realpath(opts.dir, function (err, canonicalDir) { |
| 19 | if (err) return cb(err) |
| 20 | |
| 21 | opts.dir = canonicalDir |
| 22 | |
| 23 | openZip(opts) |
| 24 | }) |
| 25 | }) |
| 26 | |
| 27 | function openZip () { |
| 28 | debug('opening', zipPath, 'with opts', opts) |
| 29 | |
| 30 | yauzl.open(zipPath, {lazyEntries: true}, function (err, zipfile) { |
| 31 | if (err) return cb(err) |
| 32 | |
| 33 | var cancelled = false |
| 34 | |
| 35 | zipfile.readEntry() |
| 36 | |
| 37 | zipfile.on('close', function () { |
| 38 | if (!cancelled) { |
| 39 | debug('zip extraction complete') |
| 40 | cb() |
| 41 | } |
| 42 | }) |
| 43 | |
| 44 | zipfile.on('entry', function (entry) { |
| 45 | if (cancelled) { |
| 46 | debug('skipping entry', entry.fileName, {cancelled: cancelled}) |
| 47 | return |
| 48 | } |
| 49 | |
| 50 | debug('zipfile entry', entry.fileName) |
| 51 | |
| 52 | if (/^__MACOSX\//.test(entry.fileName)) { |
| 53 | // dir name starts with __MACOSX/ |
| 54 | zipfile.readEntry() |
| 55 | return |
| 56 | } |
| 57 | |
| 58 | var destDir = path.dirname(path.join(opts.dir, entry.fileName)) |
| 59 | |
| 60 | mkdirp(destDir, function (err) { |
| 61 | if (err) { |
| 62 | cancelled = true |
| 63 | zipfile.close() |
| 64 | return cb(err) |
| 65 | } |
| 66 | |
| 67 | fs.realpath(destDir, function (err, canonicalDestDir) { |
| 68 | if (err) { |
| 69 | cancelled = true |
| 70 | zipfile.close() |
| 71 | return cb(err) |
| 72 | } |
| 73 | |
| 74 | var relativeDestDir = path.relative(opts.dir, canonicalDestDir) |
| 75 | |
| 76 | if (relativeDestDir.split(path.sep).indexOf('..') !== -1) { |
| 77 | cancelled = true |
| 78 | zipfile.close() |
| 79 | return cb(new Error('Out of bound path "' + canonicalDestDir + '" found while processing file ' + entry.fileName)) |
| 80 | } |
| 81 | |
| 82 | extractEntry(entry, function (err) { |
| 83 | // if any extraction fails then abort everything |
| 84 | if (err) { |
| 85 | cancelled = true |
| 86 | zipfile.close() |
| 87 | return cb(err) |
| 88 | } |
| 89 | debug('finished processing', entry.fileName) |
| 90 | zipfile.readEntry() |
| 91 | }) |
| 92 | }) |
| 93 | }) |
| 94 | }) |
| 95 | |
| 96 | function extractEntry (entry, done) { |
| 97 | if (cancelled) { |
| 98 | debug('skipping entry extraction', entry.fileName, {cancelled: cancelled}) |
| 99 | return setImmediate(done) |
| 100 | } |
| 101 | |
| 102 | if (opts.onEntry) { |
| 103 | opts.onEntry(entry, zipfile) |
| 104 | } |
| 105 | |
| 106 | var dest = path.join(opts.dir, entry.fileName) |
| 107 | |
| 108 | // convert external file attr int into a fs stat mode int |
| 109 | var mode = (entry.externalFileAttributes >> 16) & 0xFFFF |
| 110 | // check if it's a symlink or dir (using stat mode constants) |
| 111 | var IFMT = 61440 |
| 112 | var IFDIR = 16384 |
| 113 | var IFLNK = 40960 |
| 114 | var symlink = (mode & IFMT) === IFLNK |
| 115 | var isDir = (mode & IFMT) === IFDIR |
| 116 | |
| 117 | // Failsafe, borrowed from jsZip |
| 118 | if (!isDir && entry.fileName.slice(-1) === '/') { |
| 119 | isDir = true |
| 120 | } |
| 121 | |
| 122 | // check for windows weird way of specifying a directory |
| 123 | // https://github.com/maxogden/extract-zip/issues/13#issuecomment-154494566 |
| 124 | var madeBy = entry.versionMadeBy >> 8 |
| 125 | if (!isDir) isDir = (madeBy === 0 && entry.externalFileAttributes === 16) |
| 126 | |
| 127 | // if no mode then default to default modes |
| 128 | if (mode === 0) { |
| 129 | if (isDir) { |
| 130 | if (opts.defaultDirMode) mode = parseInt(opts.defaultDirMode, 10) |
| 131 | if (!mode) mode = 493 // Default to 0755 |
| 132 | } else { |
| 133 | if (opts.defaultFileMode) mode = parseInt(opts.defaultFileMode, 10) |
| 134 | if (!mode) mode = 420 // Default to 0644 |
| 135 | } |
| 136 | } |
| 137 | |
| 138 | debug('extracting entry', { filename: entry.fileName, isDir: isDir, isSymlink: symlink }) |
| 139 | |
| 140 | // reverse umask first (~) |
| 141 | var umask = ~process.umask() |
| 142 | // & with processes umask to override invalid perms |
| 143 | var procMode = mode & umask |
| 144 | |
| 145 | // always ensure folders are created |
| 146 | var destDir = dest |
| 147 | if (!isDir) destDir = path.dirname(dest) |
| 148 | |
| 149 | debug('mkdirp', {dir: destDir}) |
| 150 | mkdirp(destDir, function (err) { |
| 151 | if (err) { |
| 152 | debug('mkdirp error', destDir, {error: err}) |
| 153 | cancelled = true |
| 154 | return done(err) |
| 155 | } |
| 156 | |
| 157 | if (isDir) return done() |
| 158 | |
| 159 | debug('opening read stream', dest) |
| 160 | zipfile.openReadStream(entry, function (err, readStream) { |
| 161 | if (err) { |
| 162 | debug('openReadStream error', err) |
| 163 | cancelled = true |
| 164 | return done(err) |
| 165 | } |
| 166 | |
| 167 | readStream.on('error', function (err) { |
| 168 | console.log('read err', err) |
| 169 | }) |
| 170 | |
| 171 | if (symlink) writeSymlink() |
| 172 | else writeStream() |
| 173 | |
| 174 | function writeStream () { |
| 175 | var writeStream = fs.createWriteStream(dest, {mode: procMode}) |
| 176 | readStream.pipe(writeStream) |
| 177 | |
| 178 | writeStream.on('finish', function () { |
| 179 | done() |
| 180 | }) |
| 181 | |
| 182 | writeStream.on('error', function (err) { |
| 183 | debug('write error', {error: err}) |
| 184 | cancelled = true |
| 185 | return done(err) |
| 186 | }) |
| 187 | } |
| 188 | |
| 189 | // AFAICT the content of the symlink file itself is the symlink target filename string |
| 190 | function writeSymlink () { |
| 191 | readStream.pipe(concat(function (data) { |
| 192 | var link = data.toString() |
| 193 | debug('creating symlink', link, dest) |
| 194 | fs.symlink(link, dest, function (err) { |
| 195 | if (err) cancelled = true |
| 196 | done(err) |
| 197 | }) |
| 198 | })) |
| 199 | } |
| 200 | }) |
| 201 | }) |
| 202 | } |
| 203 | }) |
| 204 | } |
| 205 | } |