file-reader.js 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  1. // Basically just a wrapper around an fs.ReadStream
  2. module.exports = FileReader
  3. var fs = require("graceful-fs")
  4. , fstream = require("../fstream.js")
  5. , Reader = fstream.Reader
  6. , inherits = require("inherits")
  7. , mkdir = require("mkdirp")
  8. , Reader = require("./reader.js")
  9. , EOF = {EOF: true}
  10. , CLOSE = {CLOSE: true}
  11. inherits(FileReader, Reader)
  12. function FileReader (props) {
  13. // console.error(" FR create", props.path, props.size, new Error().stack)
  14. var me = this
  15. if (!(me instanceof FileReader)) throw new Error(
  16. "FileReader must be called as constructor.")
  17. // should already be established as a File type
  18. // XXX Todo: preserve hardlinks by tracking dev+inode+nlink,
  19. // with a HardLinkReader class.
  20. if (!((props.type === "Link" && props.Link) ||
  21. (props.type === "File" && props.File))) {
  22. throw new Error("Non-file type "+ props.type)
  23. }
  24. me._buffer = []
  25. me._bytesEmitted = 0
  26. Reader.call(me, props)
  27. }
  28. FileReader.prototype._getStream = function () {
  29. var me = this
  30. , stream = me._stream = fs.createReadStream(me._path, me.props)
  31. if (me.props.blksize) {
  32. stream.bufferSize = me.props.blksize
  33. }
  34. stream.on("open", me.emit.bind(me, "open"))
  35. stream.on("data", function (c) {
  36. // console.error("\t\t%d %s", c.length, me.basename)
  37. me._bytesEmitted += c.length
  38. // no point saving empty chunks
  39. if (!c.length) return
  40. else if (me._paused || me._buffer.length) {
  41. me._buffer.push(c)
  42. me._read()
  43. } else me.emit("data", c)
  44. })
  45. stream.on("end", function () {
  46. if (me._paused || me._buffer.length) {
  47. // console.error("FR Buffering End", me._path)
  48. me._buffer.push(EOF)
  49. me._read()
  50. } else {
  51. me.emit("end")
  52. }
  53. if (me._bytesEmitted !== me.props.size) {
  54. me.error("Didn't get expected byte count\n"+
  55. "expect: "+me.props.size + "\n" +
  56. "actual: "+me._bytesEmitted)
  57. }
  58. })
  59. stream.on("close", function () {
  60. if (me._paused || me._buffer.length) {
  61. // console.error("FR Buffering Close", me._path)
  62. me._buffer.push(CLOSE)
  63. me._read()
  64. } else {
  65. // console.error("FR close 1", me._path)
  66. me.emit("close")
  67. }
  68. })
  69. me._read()
  70. }
  71. FileReader.prototype._read = function () {
  72. var me = this
  73. // console.error("FR _read", me._path)
  74. if (me._paused) {
  75. // console.error("FR _read paused", me._path)
  76. return
  77. }
  78. if (!me._stream) {
  79. // console.error("FR _getStream calling", me._path)
  80. return me._getStream()
  81. }
  82. // clear out the buffer, if there is one.
  83. if (me._buffer.length) {
  84. // console.error("FR _read has buffer", me._buffer.length, me._path)
  85. var buf = me._buffer
  86. for (var i = 0, l = buf.length; i < l; i ++) {
  87. var c = buf[i]
  88. if (c === EOF) {
  89. // console.error("FR Read emitting buffered end", me._path)
  90. me.emit("end")
  91. } else if (c === CLOSE) {
  92. // console.error("FR Read emitting buffered close", me._path)
  93. me.emit("close")
  94. } else {
  95. // console.error("FR Read emitting buffered data", me._path)
  96. me.emit("data", c)
  97. }
  98. if (me._paused) {
  99. // console.error("FR Read Re-pausing at "+i, me._path)
  100. me._buffer = buf.slice(i)
  101. return
  102. }
  103. }
  104. me._buffer.length = 0
  105. }
  106. // console.error("FR _read done")
  107. // that's about all there is to it.
  108. }
  109. FileReader.prototype.pause = function (who) {
  110. var me = this
  111. // console.error("FR Pause", me._path)
  112. if (me._paused) return
  113. who = who || me
  114. me._paused = true
  115. if (me._stream) me._stream.pause()
  116. me.emit("pause", who)
  117. }
  118. FileReader.prototype.resume = function (who) {
  119. var me = this
  120. // console.error("FR Resume", me._path)
  121. if (!me._paused) return
  122. who = who || me
  123. me.emit("resume", who)
  124. me._paused = false
  125. if (me._stream) me._stream.resume()
  126. me._read()
  127. }