2024-05-01 09:52:12 -04:00
|
|
|
let OutputFileArchiveManager
|
|
|
|
const archiver = require('archiver')
|
|
|
|
const OutputCacheManager = require('./OutputCacheManager')
|
|
|
|
const OutputFileFinder = require('./OutputFileFinder')
|
|
|
|
const Settings = require('@overleaf/settings')
|
|
|
|
const { open } = require('node:fs/promises')
|
2024-06-06 04:51:16 -04:00
|
|
|
const path = require('path')
|
2024-05-01 09:52:12 -04:00
|
|
|
const { NotFoundError } = require('./Errors')
|
|
|
|
|
|
|
|
function getContentDir(projectId, userId) {
|
|
|
|
let subDir
|
|
|
|
if (userId != null) {
|
|
|
|
subDir = `${projectId}-${userId}`
|
|
|
|
} else {
|
|
|
|
subDir = projectId
|
|
|
|
}
|
|
|
|
return `${Settings.path.outputDir}/${subDir}/`
|
|
|
|
}
|
|
|
|
|
|
|
|
module.exports = OutputFileArchiveManager = {
|
|
|
|
async archiveFilesForBuild(projectId, userId, build, files = []) {
|
|
|
|
const validFiles = await (files.length > 0
|
|
|
|
? this._getRequestedOutputFiles(projectId, userId, build, files)
|
|
|
|
: this._getAllOutputFiles(projectId, userId, build))
|
|
|
|
|
|
|
|
const archive = archiver('zip')
|
|
|
|
|
|
|
|
const missingFiles = files.filter(
|
|
|
|
file => !validFiles.includes(path.basename(file))
|
|
|
|
)
|
|
|
|
|
|
|
|
for (const file of validFiles) {
|
|
|
|
try {
|
2024-06-06 04:51:16 -04:00
|
|
|
const fileHandle = await open(file, 'r')
|
2024-05-01 09:52:12 -04:00
|
|
|
const fileStream = fileHandle.createReadStream()
|
2024-06-06 04:51:16 -04:00
|
|
|
archive.append(fileStream, { name: path.basename(file) })
|
2024-05-01 09:52:12 -04:00
|
|
|
} catch (error) {
|
|
|
|
missingFiles.push(file)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if (missingFiles.length > 0) {
|
|
|
|
archive.append(missingFiles.join('\n'), {
|
|
|
|
name: 'missing_files.txt',
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
await archive.finalize()
|
|
|
|
|
|
|
|
return archive
|
|
|
|
},
|
|
|
|
|
|
|
|
async _getAllOutputFiles(projectId, userId, build) {
|
|
|
|
const contentDir = getContentDir(projectId, userId)
|
|
|
|
|
|
|
|
try {
|
|
|
|
const { outputFiles } = await OutputFileFinder.promises.findOutputFiles(
|
|
|
|
[],
|
|
|
|
`${contentDir}${OutputCacheManager.path(build, '.')}`
|
|
|
|
)
|
|
|
|
|
2024-06-06 04:51:16 -04:00
|
|
|
return outputFiles.map(
|
|
|
|
({ path }) => `${contentDir}${OutputCacheManager.path(build, path)}`
|
|
|
|
)
|
2024-05-01 09:52:12 -04:00
|
|
|
} catch (error) {
|
|
|
|
if (
|
|
|
|
error.code === 'ENOENT' ||
|
|
|
|
error.code === 'ENOTDIR' ||
|
|
|
|
error.code === 'EACCES'
|
|
|
|
) {
|
|
|
|
throw new NotFoundError('Output files not found')
|
|
|
|
}
|
|
|
|
throw error
|
|
|
|
}
|
|
|
|
},
|
|
|
|
|
|
|
|
async _getRequestedOutputFiles(projectId, userId, build, files) {
|
2024-06-06 04:51:16 -04:00
|
|
|
const outputFiles = await OutputFileArchiveManager._getAllOutputFiles(
|
|
|
|
projectId,
|
|
|
|
userId,
|
|
|
|
build
|
2024-05-01 09:52:12 -04:00
|
|
|
)
|
|
|
|
|
2024-06-06 04:51:16 -04:00
|
|
|
return files.filter(file =>
|
|
|
|
outputFiles.some(outputFile => file === path.basename(outputFile))
|
|
|
|
)
|
2024-05-01 09:52:12 -04:00
|
|
|
},
|
|
|
|
}
|