Code coverage report for tar/lib/write-entry.js

# All files / tar/lib write-entry.js

99.53% Statements 213/214
97.87% Branches 184/188
100% Functions 31/31
99.53% Lines 210/211

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    6x
    6x
    6x
    6x
    6x
    6x

    6x
    6x
    6x
    6x
    6x
    6x
    6x
    6x
    6x
    6x
    6x
    6x
    6x
    6x
    6x
    6x
    6x
    6x

    6x

    6570x
    6570x
    6570x
    1x
    6569x

    6569x

    6569x
    6569x
    6569x
    6569x
    6569x
    6569x
    6569x
    6569x
    6569x
    6569x

    6569x
    6515x

    6569x

    4x
    4x
    2x

    6567x
    6567x
    2x
    2x

    6567x

    6567x
    1x

    6567x
    6513x

    54x

    34x
    34x
    1x
    33x

    6566x
    6566x
    6566x
    902x
    6566x
    6566x
    6566x

    6566x
    5664x
    867x
    34x

    1x

    6563x
    4x

    6563x

    6563x
    17x

    6563x

    867x
    859x
    867x
    867x
    867x

    32x
    32x
    1x
    31x

    32x
    32x
    32x

    1x
    1x
    1x
    1x
    1x

    5664x
    7x
    7x
    2x
    2x
    1x

    6x

    5663x
    5663x
    42x

    5621x

    5568x
    5568x
    2x
    5566x

    5617x
    5617x
    5617x
    5617x

    7336x
    7336x
    1x
    7335x

    5566x

    7393x
    2x
    2x
    2x
    2x
    2x

    7392x
    5614x
    1700449x
    1700449x
    1700449x

    7392x

    7392x
    7392x
    7392x
    7392x

    7392x

    7392x
    5614x
    2x
    5614x
    5614x
    5614x

    1778x
    1754x
    1754x

    1778x
    1778x

    99x

    20x

    2x

    53x

    59x
    59x
    59x
    58x
    57x

    59x
    2x

    51x

    6x

    33x
    33x
    33x
    33x
    33x
    33x
    33x

    33x
    33x
    33x

    33x
    33x
    33x
    26x
    33x
    33x
    33x
    33x
    33x
    33x
    33x
    33x
    33x

    33x
    27x

    33x
    2x
    2x

    1x

    32x
    32x

    32x

    32x
    14x

    32x
    32x

    52x
    52x
    1x
    51x
    51x

    29x
    22x
    29x

    6x
    6x

    6x
    6566x

    6x
     'use strict'
    const MiniPass = require('minipass')
    const Pax = require('./pax.js')
    const Header = require('./header.js')
    const ReadEntry = require('./read-entry.js')
    const fs = require('fs')
    const path = require('path')

    const types = require('./types.js')
    const maxReadSize = 16 * 1024 * 1024
    const PROCESS = Symbol('process')
    const FILE = Symbol('file')
    const DIRECTORY = Symbol('directory')
    const SYMLINK = Symbol('symlink')
    const HARDLINK = Symbol('hardlink')
    const HEADER = Symbol('header')
    const READ = Symbol('read')
    const LSTAT = Symbol('lstat')
    const ONLSTAT = Symbol('onlstat')
    const ONREAD = Symbol('onread')
    const ONREADLINK = Symbol('onreadlink')
    const OPENFILE = Symbol('openfile')
    const ONOPENFILE = Symbol('onopenfile')
    const CLOSE = Symbol('close')
    const warner = require('./warn-mixin.js')
    const winchars = require('./winchars.js')

    const WriteEntry = warner(class WriteEntry extends MiniPass {
      constructor (p, opt) {
        opt = opt || {}
        super(opt)
        if (typeof p !== 'string')
          throw new TypeError('path is required')
        this.path = p
        // suppress atime, ctime, uid, gid, uname, gname
        this.portable = !!opt.portable
        // until node has builtin pwnam functions, this'll have to do
        this.myuid = process.getuid && process.getuid()
        this.myuser = process.env.USER || ''
        this.maxReadSize = opt.maxReadSize || maxReadSize
        this.linkCache = opt.linkCache || new Map()
        this.statCache = opt.statCache || new Map()
        this.preservePaths = !!opt.preservePaths
        this.cwd = opt.cwd || process.cwd()
        this.strict = !!opt.strict
        this.noPax = !!opt.noPax
        this.noMtime = !!opt.noMtime

        if (typeof opt.onwarn === 'function')
          this.on('warn', opt.onwarn)

        if (!this.preservePaths && path.win32.isAbsolute(p)) {
          // absolutes on posix are also absolutes on win32
          // so we only need to test this one to get both
          const parsed = path.win32.parse(p)
          this.warn('stripping ' + parsed.root + ' from absolute path', p)
          this.path = p.substr(parsed.root.length)
        }

        this.win32 = !!opt.win32 || process.platform === 'win32'
        if (this.win32) {
          this.path = winchars.decode(this.path.replace(/\\/g, '/'))
          p = p.replace(/\\/g, '/')
        }

        this.absolute = opt.absolute || path.resolve(this.cwd, p)

        if (this.path === '')
          this.path = './'

        if (this.statCache.has(this.absolute))
          this[ONLSTAT](this.statCache.get(this.absolute))
        else
          this[LSTAT]()
      }

      [LSTAT] () {
        fs.lstat(this.absolute, (er, stat) => {
          if (er)
            return this.emit('error', er)
          this[ONLSTAT](stat)
        })
      }

      [ONLSTAT] (stat) {
        this.statCache.set(this.absolute, stat)
        this.stat = stat
        if (!stat.isFile())
          stat.size = 0
        this.type = getType(stat)
        this.emit('stat', stat)
        this[PROCESS]()
      }

      [PROCESS] () {
        switch (this.type) {
          case 'File': return this[FILE]()
          case 'Directory': return this[DIRECTORY]()
          case 'SymbolicLink': return this[SYMLINK]()
          // unsupported types are ignored.
          default: return this.end()
        }
      }

      [HEADER] () {
        if (this.type === 'Directory' && this.portable)
          this.noMtime = true

        this.header = new Header({
          path: this.path,
          linkpath: this.linkpath,
          // only the permissions and setuid/setgid/sticky bitflags
          // not the higher-order bits that specify file type
          mode: this.stat.mode & 0o7777,
          uid: this.portable ? null : this.stat.uid,
          gid: this.portable ? null : this.stat.gid,
          size: this.stat.size,
          mtime: this.noMtime ? null : this.stat.mtime,
          type: this.type,
          uname: this.portable ? null :
            this.stat.uid === this.myuid ? this.myuser : '',
          atime: this.portable ? null : this.stat.atime,
          ctime: this.portable ? null : this.stat.ctime
        })

        if (this.header.encode() && !this.noPax)
          this.write(new Pax({
            atime: this.portable ? null : this.header.atime,
            ctime: this.portable ? null : this.header.ctime,
            gid: this.portable ? null : this.header.gid,
            mtime: this.noMtime ? null : this.header.mtime,
            path: this.path,
            linkpath: this.linkpath,
            size: this.header.size,
            uid: this.portable ? null : this.header.uid,
            uname: this.portable ? null : this.header.uname,
            dev: this.portable ? null : this.stat.dev,
            ino: this.portable ? null : this.stat.ino,
            nlink: this.portable ? null : this.stat.nlink
          }).encode())
        this.write(this.header.block)
      }

      [DIRECTORY] () {
        if (this.path.substr(-1) !== '/')
          this.path += '/'
        this.stat.size = 0
        this[HEADER]()
        this.end()
      }

      [SYMLINK] () {
        fs.readlink(this.absolute, (er, linkpath) => {
          if (er)
            return this.emit('error', er)
          this[ONREADLINK](linkpath)
        })
      }

      [ONREADLINK] (linkpath) {
        this.linkpath = linkpath
        this[HEADER]()
        this.end()
      }

      [HARDLINK] (linkpath) {
        this.type = 'Link'
        this.linkpath = path.relative(this.cwd, linkpath)
        this.stat.size = 0
        this[HEADER]()
        this.end()
      }

      [FILE] () {
        if (this.stat.nlink > 1) {
          const linkKey = this.stat.dev + ':' + this.stat.ino
          if (this.linkCache.has(linkKey)) {
            const linkpath = this.linkCache.get(linkKey)
            if (linkpath.indexOf(this.cwd) === 0)
              return this[HARDLINK](linkpath)
          }
          this.linkCache.set(linkKey, this.absolute)
        }

        this[HEADER]()
        if (this.stat.size === 0)
          return this.end()

        this[OPENFILE]()
      }

      [OPENFILE] () {
        fs.open(this.absolute, 'r', (er, fd) => {
          if (er)
            return this.emit('error', er)
          this[ONOPENFILE](fd)
        })
      }

      [ONOPENFILE] (fd) {
        const blockLen = 512 * Math.ceil(this.stat.size / 512)
        const bufLen = Math.min(blockLen, this.maxReadSize)
        const buf = Buffer.allocUnsafe(bufLen)
        this[READ](fd, buf, 0, buf.length, 0, this.stat.size, blockLen)
      }

      [READ] (fd, buf, offset, length, pos, remain, blockRemain) {
        fs.read(fd, buf, offset, length, pos, (er, bytesRead) => {
          if (er)
            return this[CLOSE](fd, _ => this.emit('error', er))
          this[ONREAD](fd, buf, offset, length, pos, remain, blockRemain, bytesRead)
        })
      }

      [CLOSE] (fd, cb) {
        fs.close(fd, cb)
      }

      [ONREAD] (fd, buf, offset, length, pos, remain, blockRemain, bytesRead) {
        if (bytesRead <= 0 && remain > 0) {
          const er = new Error('unexpected EOF')
          er.path = this.absolute
          er.syscall = 'read'
          er.code = 'EOF'
          this.emit('error', er)
        }

        // null out the rest of the buffer, if we could fit the block padding
        if (bytesRead === remain) {
          for (let i = bytesRead; i < length && bytesRead < blockRemain; i++) {
            buf[i + offset] = 0
            bytesRead ++
            remain ++
          }
        }

        const writeBuf = offset === 0 && bytesRead === buf.length ?
          buf : buf.slice(offset, offset + bytesRead)
        remain -= bytesRead
        blockRemain -= bytesRead
        pos += bytesRead
        offset += bytesRead

        this.write(writeBuf)

        if (!remain) {
          if (blockRemain)
            this.write(Buffer.alloc(blockRemain))
          this.end()
          this[CLOSE](fd, _ => _)
          return
        }

        if (offset >= length) {
          buf = Buffer.allocUnsafe(length)
          offset = 0
        }
        length = buf.length - offset
        this[READ](fd, buf, offset, length, pos, remain, blockRemain)
      }
    })

    class WriteEntrySync extends WriteEntry {
      constructor (path, opt) {
        super(path, opt)
      }

      [LSTAT] () {
        this[ONLSTAT](fs.lstatSync(this.absolute))
      }

      [SYMLINK] () {
        this[ONREADLINK](fs.readlinkSync(this.absolute))
      }

      [OPENFILE] () {
        this[ONOPENFILE](fs.openSync(this.absolute, 'r'))
      }

      [READ] (fd, buf, offset, length, pos, remain, blockRemain) {
        let threw = true
        try {
          const bytesRead = fs.readSync(fd, buf, offset, length, pos)
          this[ONREAD](fd, buf, offset, length, pos, remain, blockRemain, bytesRead)
          threw = false
        } finally {
          if (threw)
            try { this[CLOSE](fd) } catch (er) {}
        }
      }

      [CLOSE] (fd) {
        fs.closeSync(fd)
      }
    }

    const WriteEntryTar = warner(class WriteEntryTar extends MiniPass {
      constructor (readEntry, opt) {
        opt = opt || {}
        super(opt)
        this.preservePaths = !!opt.preservePaths
        this.portable = !!opt.portable
        this.strict = !!opt.strict
        this.noPax = !!opt.noPax
        this.noMtime = !!opt.noMtime

        this.readEntry = readEntry
        this.type = readEntry.type
        Iif (this.type === 'Directory' && this.portable)
          this.noMtime = true

        this.path = readEntry.path
        this.mode = readEntry.mode
        if (this.mode)
          this.mode = this.mode & 0o7777
        this.uid = this.portable ? null : readEntry.uid
        this.gid = this.portable ? null : readEntry.gid
        this.uname = this.portable ? null : readEntry.uname
        this.gname = this.portable ? null : readEntry.gname
        this.size = readEntry.size
        this.mtime = this.noMtime ? null : readEntry.mtime
        this.atime = this.portable ? null : readEntry.atime
        this.ctime = this.portable ? null : readEntry.ctime
        this.linkpath = readEntry.linkpath

        if (typeof opt.onwarn === 'function')
          this.on('warn', opt.onwarn)

        if (path.isAbsolute(this.path) && !this.preservePaths) {
          const parsed = path.parse(this.path)
          this.warn(
            'stripping ' + parsed.root + ' from absolute path',
            this.path
          )
          this.path = this.path.substr(parsed.root.length)
        }

        this.remain = readEntry.size
        this.blockRemain = readEntry.startBlockSize

        this.header = new Header({
          path: this.path,
          linkpath: this.linkpath,
          // only the permissions and setuid/setgid/sticky bitflags
          // not the higher-order bits that specify file type
          mode: this.mode,
          uid: this.portable ? null : this.uid,
          gid: this.portable ? null : this.gid,
          size: this.size,
          mtime: this.noMtime ? null : this.mtime,
          type: this.type,
          uname: this.portable ? null : this.uname,
          atime: this.portable ? null : this.atime,
          ctime: this.portable ? null : this.ctime
        })

        if (this.header.encode() && !this.noPax)
          super.write(new Pax({
            atime: this.portable ? null : this.atime,
            ctime: this.portable ? null : this.ctime,
            gid: this.portable ? null : this.gid,
            mtime: this.noMtime ? null : this.mtime,
            path: this.path,
            linkpath: this.linkpath,
            size: this.size,
            uid: this.portable ? null : this.uid,
            uname: this.portable ? null : this.uname,
            dev: this.portable ? null : this.readEntry.dev,
            ino: this.portable ? null : this.readEntry.ino,
            nlink: this.portable ? null : this.readEntry.nlink
          }).encode())

        super.write(this.header.block)
        readEntry.pipe(this)
      }

      write (data) {
        const writeLen = data.length
        if (writeLen > this.blockRemain)
          throw new Error('writing more to entry than is appropriate')
        this.blockRemain -= writeLen
        return super.write(data)
      }

      end () {
        if (this.blockRemain)
          this.write(Buffer.alloc(this.blockRemain))
        return super.end()
      }
    })

    WriteEntry.Sync = WriteEntrySync
    WriteEntry.Tar = WriteEntryTar

    const getType = stat =>
      stat.isFile() ? 'File'
      : stat.isDirectory() ? 'Directory'
      : stat.isSymbolicLink() ? 'SymbolicLink'
      : 'Unsupported'

    module.exports = WriteEntry