# all files / lib/ dir-reader.js

11.49% Statements 17/148
0% Branches 0/79
0% Functions 0/19
12.41% Lines 17/137

    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

    1×

    1×
    1×
    1×
    1×
    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

     // A thing that emits "entry" events with Reader objects
    // Pausing it causes it to stop emitting entry events, and also
    // pauses the current entry if there is one.

    module.exports = DirReader

    var fs = require('graceful-fs')
    var inherits = require('inherits')
    var path = require('path')
    var Reader = require('./reader.js')
    var assert = require('assert').ok

    inherits(DirReader, Reader)

    function DirReader (props) {
      var self = this
      if (!(self instanceof DirReader)) {
        throw new Error('DirReader must be called as constructor.')
      }

      // should already be established as a Directory type
      if (props.type !== 'Directory' || !props.Directory) {
        throw new Error('Non-directory type ' + props.type)
      }

      self.entries = null
      self._entries = []
      self._index = -1
      self._paused = false
      self._length = -1

      if (props.sort) {
        this.sort = props.sort
      }

      Reader.call(this, props)
    }

    DirReader.prototype._getEntries = function () {
      var self = this

      // race condition.  might pause() before calling _getEntries,
      // and then resume, and try to get them a second time.
      if (self._gotEntries) return
      self._gotEntries = true

      fs.readdir(self._path, function (er, entries) {
        if (er) return self.error(er)

        self.entries = entries
        self._entries = entries.slice()

        self.emit('entries', entries)
        if (self._paused) self.once('resume', processEntries)
        else processEntries()

        function processEntries () {
          self._length = self.entries.length
          if (typeof self.sort === 'function') {
            self.entries = self.entries.sort(self.sort.bind(self))
          }
          self._read()
        }
      })
    }

    // start walking the dir, and emit an "entry" event for each one.
    DirReader.prototype._read = function () {
      var self = this

      if (!self.entries) return self._getEntries()

      if (self._paused || self._currentEntry || self._aborted) {
        // console.error('DR paused=%j, current=%j, aborted=%j', self._paused, !!self._currentEntry, self._aborted)
        return
      }

      self._index++
      if (self._index >= self._entries.length) {
        if (!self._ended) {
          self._ended = true
          self.emit('end')
          self.emit('close')
        }
        return
      }

      // save creating a proxy, by stat'ing the thing now.
      var nextEntry = self._entries[self._index]
      if (!nextEntry) return this._read()

      // ok, handle this one, then.
      var p = path.resolve(self._path, nextEntry)
      assert(p !== self._path)
      assert(nextEntry)

      // set this to prevent trying to _read() again in the stat time.
      self._currentEntry = p
      fs[ self.props.follow ? 'stat' : 'lstat' ](p, function (er, stat) {
        if (er) return self.error(er)

        var who = self._proxy || self

        stat.path = p
        stat.basename = path.basename(p)
        stat.dirname = path.dirname(p)
        var childProps = self.getChildProps.call(who, stat)
        childProps.path = p
        childProps.basename = path.basename(p)
        childProps.dirname = path.dirname(p)

        var entry = Reader(childProps, stat)

        // console.error("DR Entry", p, stat.size)

        self._currentEntry = entry

        // "entry" events are for direct entries in a specific dir.
        // "child" events are for any and all children at all levels.
        // This nomenclature is not completely final.

        entry.on('pause', function (who) {
          if (!self._paused && !entry._disowned) {
            self.pause(who)
          }
        })

        entry.on('resume', function (who) {
          if (self._paused && !entry._disowned) {
            self.resume(who)
          }
        })

        entry.on('stat', function (props) {
          self.emit('_entryStat', entry, props)
          if (entry._aborted) return
          if (entry._paused) {
            entry.once('resume', function () {
              self.emit('entryStat', entry, props)
            })
          } else self.emit('entryStat', entry, props)
        })

        entry.on('ready', function EMITCHILD () {
          // console.error("DR emit child", entry._path)
          if (self._paused) {
            // console.error("  DR emit child - try again later")
            // pause the child, and emit the "entry" event once we drain.
            // console.error("DR pausing child entry")
            entry.pause(self)
            return self.once('resume', EMITCHILD)
          }

          // skip over sockets.  they can't be piped around properly,
          // so there's really no sense even acknowledging them.
          // if someone really wants to see them, they can listen to
          // the "socket" events.
          if (entry.type === 'Socket') {
            self.emit('socket', entry)
          } else {
            self.emitEntry(entry)
          }
        })

        var ended = false
        entry.on('close', onend)
        entry.on('disown', onend)
        function onend () {
          if (ended) return
          ended = true
          self.emit('childEnd', entry)
          self.emit('entryEnd', entry)
          self._currentEntry = null
          if (!self._paused) {
            self._read()
          }
        }

        // XXX Remove this.  Works in node as of 0.6.2 or so.
        // Long filenames should not break stuff.
        entry.on('error', function (er) {
          if (entry._swallowErrors) {
            self.warn(er)
            entry.emit('end')
            entry.emit('close')
          } else {
            self.emit('error', er)
          }
        })

        // proxy up some events.
        ;[
          'child',
          'childEnd',
          'warn'
        ].forEach(function (ev) {
          entry.on(ev, self.emit.bind(self, ev))
        })
      })
    }

    DirReader.prototype.disown = function (entry) {
      entry.emit('beforeDisown')
      entry._disowned = true
      entry.parent = entry.root = null
      if (entry === this._currentEntry) {
        this._currentEntry = null
      }
      entry.emit('disown')
    }

    DirReader.prototype.getChildProps = function () {
      return {
        depth: this.depth + 1,
        root: this.root || this,
        parent: this,
        follow: this.follow,
        filter: this.filter,
        sort: this.props.sort,
        hardlinks: this.props.hardlinks
      }
    }

    DirReader.prototype.pause = function (who) {
      var self = this
      if (self._paused) return
      who = who || self
      self._paused = true
      if (self._currentEntry && self._currentEntry.pause) {
        self._currentEntry.pause(who)
      }
      self.emit('pause', who)
    }

    DirReader.prototype.resume = function (who) {
      var self = this
      if (!self._paused) return
      who = who || self

      self._paused = false
      // console.error('DR Emit Resume', self._path)
      self.emit('resume', who)
      if (self._paused) {
        // console.error('DR Re-paused', self._path)
        return
      }

      if (self._currentEntry) {
        if (self._currentEntry.resume) self._currentEntry.resume(who)
      } else self._read()
    }

    DirReader.prototype.emitEntry = function (entry) {
      this.emit('entry', entry)
      this.emit('child', entry)
    }