overleaf/services/web/app/coffee/Features/Compile/ClsiManager.coffee

165 lines
6.6 KiB
CoffeeScript
Raw Normal View History

2014-02-12 05:23:40 -05:00
Path = require "path"
async = require "async"
Settings = require "settings-sharelatex"
request = require('request')
Project = require("../../models/Project").Project
2014-05-06 07:54:26 -04:00
ProjectEntityHandler = require("../Project/ProjectEntityHandler")
2014-02-12 05:23:40 -05:00
logger = require "logger-sharelatex"
Url = require("url")
ClsiCookieManager = require("./ClsiCookieManager")
_ = require("underscore")
async = require("async")
2016-06-02 08:09:11 -04:00
ClsiFormatChecker = require("./ClsiFormatChecker")
2014-02-12 05:23:40 -05:00
module.exports = ClsiManager =
2016-04-19 11:48:51 -04:00
2016-06-02 08:09:11 -04:00
sendRequest: (project_id, options = {}, callback = (error, status, outputFiles, clsiServerId, validationProblems) ->) ->
ClsiManager._buildRequest project_id, options, (error, req) ->
2014-02-12 05:23:40 -05:00
return callback(error) if error?
2014-05-06 07:54:26 -04:00
logger.log project_id: project_id, "sending compile to CLSI"
2016-06-02 08:09:11 -04:00
ClsiFormatChecker.checkRecoursesForProblems req.compile?.resources, (err, validationProblems)->
if err?
logger.err err, project_id, "could not check resources for potential problems before sending to clsi"
return callback(err)
2016-06-02 08:09:11 -04:00
if validationProblems?
logger.log project_id:project_id, validationProblems:validationProblems, "problems with users latex before compile was attempted"
return callback(null, "validation-problems", null, null, validationProblems)
ClsiManager._postToClsi project_id, req, options.compileGroup, (error, response) ->
if error?
logger.err err:error, project_id:project_id, "error sending request to clsi"
return callback(error)
logger.log project_id: project_id, outputFilesLength: response?.outputFiles?.length, status: response?.status, "received compile response from CLSI"
ClsiCookieManager._getServerId project_id, (err, clsiServerId)->
if err?
logger.err err:err, project_id:project_id, "error getting server id"
return callback(err)
outputFiles = ClsiManager._parseOutputFiles(project_id, response?.compile?.outputFiles)
callback(null, response?.compile?.status, outputFiles, clsiServerId)
2014-02-12 05:23:40 -05:00
deleteAuxFiles: (project_id, options, callback = (error) ->) ->
compilerUrl = @_getCompilerUrl(options?.compileGroup)
2016-04-19 11:48:51 -04:00
opts =
url:"#{compilerUrl}/project/#{project_id}"
method:"DELETE"
ClsiManager._makeRequest project_id, opts, callback
_makeRequest: (project_id, opts, callback)->
ClsiCookieManager.getCookieJar project_id, (err, jar)->
if err?
logger.err err:err, "error getting cookie jar for clsi request"
return callback(err)
opts.jar = jar
request opts, (err, response, body)->
if err?
logger.err err:err, project_id:project_id, url:opts?.url, "error making request to clsi"
return callback(err)
ClsiCookieManager.setServerId project_id, response, (err)->
if err?
logger.warn err:err, project_id:project_id, "error setting server id"
return callback err, response, body
_getCompilerUrl: (compileGroup) ->
2016-05-20 07:46:14 -04:00
return Settings.apis.clsi.url
_postToClsi: (project_id, req, compileGroup, callback = (error, response) ->) ->
2016-05-20 07:46:14 -04:00
compilerUrl = Settings.apis.clsi.url
2016-04-19 11:48:51 -04:00
opts =
url: "#{compilerUrl}/project/#{project_id}/compile"
2014-02-12 05:23:40 -05:00
json: req
2016-04-19 11:48:51 -04:00
method: "POST"
ClsiManager._makeRequest project_id, opts, (error, response, body) ->
return callback(error) if error?
if 200 <= response.statusCode < 300
callback null, body
else if response.statusCode == 413
callback null, compile:status:"project-too-large"
else
error = new Error("CLSI returned non-success code: #{response.statusCode}")
logger.error err: error, project_id: project_id, "CLSI returned failure code"
callback error, body
2014-02-12 05:23:40 -05:00
_parseOutputFiles: (project_id, rawOutputFiles = []) ->
2014-02-12 05:23:40 -05:00
outputFiles = []
for file in rawOutputFiles
path = Url.parse(file.url).path
path = path.replace("/project/#{project_id}/output/", "")
2014-02-12 05:23:40 -05:00
outputFiles.push
path: path
2014-02-12 05:23:40 -05:00
type: file.type
build: file.build
2014-02-12 05:23:40 -05:00
return outputFiles
VALID_COMPILERS: ["pdflatex", "latex", "xelatex", "lualatex"]
2016-02-02 09:50:48 -05:00
_buildRequest: (project_id, options={}, callback = (error, request) ->) ->
2016-01-14 11:35:42 -05:00
Project.findById project_id, {compiler: 1, rootDoc_id: 1, imageName: 1}, (error, project) ->
2014-05-06 07:54:26 -04:00
return callback(error) if error?
return callback(new Errors.NotFoundError("project does not exist: #{project_id}")) if !project?
2014-02-12 05:23:40 -05:00
2014-05-06 07:54:26 -04:00
if project.compiler not in ClsiManager.VALID_COMPILERS
project.compiler = "pdflatex"
2014-02-12 05:23:40 -05:00
2014-05-06 07:54:26 -04:00
ProjectEntityHandler.getAllDocs project_id, (error, docs = {}) ->
return callback(error) if error?
ProjectEntityHandler.getAllFiles project_id, (error, files = {}) ->
return callback(error) if error?
2014-02-12 05:23:40 -05:00
2014-05-06 07:54:26 -04:00
resources = []
rootResourcePath = null
rootResourcePathOverride = null
2014-02-12 05:23:40 -05:00
2014-05-06 07:54:26 -04:00
for path, doc of docs
path = path.replace(/^\//, "") # Remove leading /
resources.push
path: path
content: doc.lines.join("\n")
if project.rootDoc_id? and doc._id.toString() == project.rootDoc_id.toString()
rootResourcePath = path
2016-02-02 09:50:48 -05:00
if options.rootDoc_id? and doc._id.toString() == options.rootDoc_id.toString()
rootResourcePathOverride = path
rootResourcePath = rootResourcePathOverride if rootResourcePathOverride?
if !rootResourcePath?
logger.warn {project_id}, "no root document found, setting to main.tex"
rootResourcePath = "main.tex"
2014-02-12 05:23:40 -05:00
2014-05-06 07:54:26 -04:00
for path, file of files
path = path.replace(/^\//, "") # Remove leading /
resources.push
path: path
url: "#{Settings.apis.filestore.url}/project/#{project._id}/file/#{file._id}"
modified: file.created?.getTime()
2014-02-12 05:23:40 -05:00
callback null, {
compile:
options:
compiler: project.compiler
timeout: options.timeout
imageName: project.imageName
draft: !!options.draft
rootResourcePath: rootResourcePath
resources: resources
}
2015-09-10 11:41:48 -04:00
2015-09-11 08:53:06 -04:00
wordCount: (project_id, file, options, callback = (error, response) ->) ->
ClsiManager._buildRequest project_id, options, (error, req) ->
compilerUrl = ClsiManager._getCompilerUrl(options?.compileGroup)
2015-10-19 17:14:52 -04:00
filename = file || req?.compile?.rootResourcePath
wordcount_url = "#{compilerUrl}/project/#{project_id}/wordcount?file=#{encodeURIComponent(filename)}"
if req.compile.options.imageName?
wordcount_url += "&image=#{encodeURIComponent(req.compile.options.imageName)}"
2016-04-19 11:48:51 -04:00
opts =
url: wordcount_url
2016-04-19 11:48:51 -04:00
method: "GET"
ClsiManager._makeRequest project_id, opts, (error, response, body) ->
2015-09-11 08:53:06 -04:00
return callback(error) if error?
if 200 <= response.statusCode < 300
callback null, body
else
error = new Error("CLSI returned non-success code: #{response.statusCode}")
logger.error err: error, project_id: project_id, "CLSI returned failure code"
callback error, body