ArchiveManager.coffee 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143
  1. logger = require "logger-sharelatex"
  2. metrics = require "metrics-sharelatex"
  3. fs = require "fs"
  4. Path = require "path"
  5. fse = require "fs-extra"
  6. yauzl = require "yauzl"
  7. Settings = require "settings-sharelatex"
  8. Errors = require "../Errors/Errors"
  9. _ = require("underscore")
  10. ONE_MEG = 1024 * 1024
  11. module.exports = ArchiveManager =
  12. _isZipTooLarge: (source, callback = (err, isTooLarge)->)->
  13. callback = _.once callback
  14. totalSizeInBytes = null
  15. yauzl.open source, {lazyEntries: true}, (err, zipfile) ->
  16. return callback(new Errors.InvalidError("invalid_zip_file")) if err?
  17. if Settings.maxEntitiesPerProject? and zipfile.entryCount > Settings.maxEntitiesPerProject
  18. return callback(null, true) # too many files in zip file
  19. zipfile.on "error", callback
  20. # read all the entries
  21. zipfile.readEntry()
  22. zipfile.on "entry", (entry) ->
  23. totalSizeInBytes += entry.uncompressedSize
  24. zipfile.readEntry() # get the next entry
  25. # no more entries to read
  26. zipfile.on "end", () ->
  27. if !totalSizeInBytes? or isNaN(totalSizeInBytes)
  28. logger.err source:source, totalSizeInBytes:totalSizeInBytes, "error getting bytes of zip"
  29. return callback(new Error("error getting bytes of zip"))
  30. isTooLarge = totalSizeInBytes > (ONE_MEG * 300)
  31. callback(null, isTooLarge)
  32. _checkFilePath: (entry, destination, callback = (err, destFile) ->) ->
  33. # transform backslashes to forwardslashes to accommodate badly-behaved zip archives
  34. transformedFilename = entry.fileName.replace(/\\/g, '/')
  35. # check if the entry is a directory
  36. endsWithSlash = /\/$/
  37. if endsWithSlash.test(transformedFilename)
  38. return callback() # don't give a destfile for directory
  39. # check that the file does not use a relative path
  40. for dir in transformedFilename.split('/')
  41. if dir == '..'
  42. return callback(new Error("relative path"))
  43. # check that the destination file path is normalized
  44. dest = "#{destination}/#{transformedFilename}"
  45. if dest != Path.normalize(dest)
  46. return callback(new Error("unnormalized path"))
  47. else
  48. return callback(null, dest)
  49. _writeFileEntry: (zipfile, entry, destFile, callback = (err)->) ->
  50. callback = _.once callback
  51. zipfile.openReadStream entry, (err, readStream) ->
  52. return callback(err) if err?
  53. readStream.on "error", callback
  54. readStream.on "end", callback
  55. errorHandler = (err) -> # clean up before calling callback
  56. readStream.unpipe()
  57. readStream.destroy()
  58. callback(err)
  59. fse.ensureDir Path.dirname(destFile), (err) ->
  60. return errorHandler(err) if err?
  61. writeStream = fs.createWriteStream destFile
  62. writeStream.on 'error', errorHandler
  63. readStream.pipe(writeStream)
  64. _extractZipFiles: (source, destination, callback = (err) ->) ->
  65. callback = _.once callback
  66. yauzl.open source, {lazyEntries: true}, (err, zipfile) ->
  67. return callback(err) if err?
  68. zipfile.on "error", callback
  69. # read all the entries
  70. zipfile.readEntry()
  71. zipfile.on "entry", (entry) ->
  72. logger.log {source:source, fileName: entry.fileName}, "processing zip file entry"
  73. ArchiveManager._checkFilePath entry, destination, (err, destFile) ->
  74. if err?
  75. logger.warn err:err, source:source, destination:destination, "skipping bad file path"
  76. zipfile.readEntry() # bad path, just skip to the next file
  77. return
  78. if destFile? # only write files
  79. ArchiveManager._writeFileEntry zipfile, entry, destFile, (err) ->
  80. if err?
  81. logger.error err:err, source:source, destFile:destFile, "error unzipping file entry"
  82. zipfile.close() # bail out, stop reading file entries
  83. return callback(err)
  84. else
  85. zipfile.readEntry() # continue to the next file
  86. else # if it's a directory, continue
  87. zipfile.readEntry()
  88. # no more entries to read
  89. zipfile.on "end", callback
  90. extractZipArchive: (source, destination, _callback = (err) ->) ->
  91. callback = (args...) ->
  92. _callback(args...)
  93. _callback = () ->
  94. ArchiveManager._isZipTooLarge source, (err, isTooLarge)->
  95. if err?
  96. logger.err err:err, "error checking size of zip file"
  97. return callback(err)
  98. if isTooLarge
  99. return callback(new Errors.InvalidError("zip_contents_too_large"))
  100. timer = new metrics.Timer("unzipDirectory")
  101. logger.log source: source, destination: destination, "unzipping file"
  102. ArchiveManager._extractZipFiles source, destination, (err) ->
  103. timer.done()
  104. if err?
  105. logger.error {err, source, destination}, "unzip failed"
  106. callback(err)
  107. else
  108. callback()
  109. findTopLevelDirectory: (directory, callback = (error, topLevelDir) ->) ->
  110. fs.readdir directory, (error, files) ->
  111. return callback(error) if error?
  112. if files.length == 1
  113. childPath = Path.join(directory, files[0])
  114. fs.stat childPath, (error, stat) ->
  115. return callback(error) if error?
  116. if stat.isDirectory()
  117. return callback(null, childPath)
  118. else
  119. return callback(null, directory)
  120. else
  121. return callback(null, directory)