mirror of
https://github.com/overleaf/overleaf.git
synced 2024-11-07 20:31:06 -05:00
638ac52e40
By default, no timing information will be taken. On Linux with GNU user land, this value should be configured to `["/usr/bin/time", "-v"]`. On Mac, gnu-time should be installed and configured to `["/usr/local/bin/gtime", "-v"]`.
79 lines
3 KiB
CoffeeScript
79 lines
3 KiB
CoffeeScript
Path = require "path"
|
|
Settings = require "settings-sharelatex"
|
|
logger = require "logger-sharelatex"
|
|
Metrics = require "./Metrics"
|
|
CommandRunner = require(Settings.clsi?.commandRunner or "./CommandRunner")
|
|
|
|
module.exports = LatexRunner =
|
|
runLatex: (project_id, options, callback = (error) ->) ->
|
|
{directory, mainFile, compiler, timeout, image} = options
|
|
compiler ||= "pdflatex"
|
|
timeout ||= 60000 # milliseconds
|
|
|
|
logger.log directory: directory, compiler: compiler, timeout: timeout, mainFile: mainFile, "starting compile"
|
|
|
|
# We want to run latexmk on the tex file which we will automatically
|
|
# generate from the Rtex/Rmd/md file.
|
|
mainFile = mainFile.replace(/\.(Rtex|md|Rmd)$/, ".tex")
|
|
|
|
if compiler == "pdflatex"
|
|
command = LatexRunner._pdflatexCommand mainFile
|
|
else if compiler == "latex"
|
|
command = LatexRunner._latexCommand mainFile
|
|
else if compiler == "xelatex"
|
|
command = LatexRunner._xelatexCommand mainFile
|
|
else if compiler == "lualatex"
|
|
command = LatexRunner._lualatexCommand mainFile
|
|
else
|
|
return callback new Error("unknown compiler: #{compiler}")
|
|
|
|
if Settings.clsi?.strace
|
|
command = ["strace", "-o", "strace", "-ff"].concat(command)
|
|
|
|
CommandRunner.run project_id, command, directory, image, timeout, (error, output) ->
|
|
return callback(error) if error?
|
|
runs = output?.stderr?.match(/^Run number \d+ of .*latex/mg)?.length or 0
|
|
failed = if output?.stdout?.match(/^Latexmk: Errors/m)? then 1 else 0
|
|
# counters from latexmk output
|
|
stats = {}
|
|
stats["latexmk-errors"] = failed
|
|
stats["latex-runs"] = runs
|
|
stats["latex-runs-with-errors"] = if failed then runs else 0
|
|
stats["latex-runs-#{runs}"] = 1
|
|
stats["latex-runs-with-errors-#{runs}"] = if failed then 1 else 0
|
|
# timing information from /usr/bin/time
|
|
timings = {}
|
|
stderr = output?.stderr
|
|
timings["cpu-percent"] = stderr?.match(/Percent of CPU this job got: (\d+)/m)?[1] or 0
|
|
timings["cpu-time"] = stderr?.match(/User time.*: (\d+.\d+)/m)?[1] or 0
|
|
timings["sys-time"] = stderr?.match(/System time.*: (\d+.\d+)/m)?[1] or 0
|
|
callback error, output, stats, timings
|
|
|
|
_latexmkBaseCommand: (Settings?.clsi?.latexmkCommandPrefix || []).concat(
|
|
["latexmk", "-cd", "-f", "-jobname=output", "-auxdir=$COMPILE_DIR", "-outdir=$COMPILE_DIR"]
|
|
)
|
|
|
|
_pdflatexCommand: (mainFile) ->
|
|
LatexRunner._latexmkBaseCommand.concat [
|
|
"-pdf", "-e", "$pdflatex='pdflatex -synctex=1 -interaction=batchmode %O %S'",
|
|
Path.join("$COMPILE_DIR", mainFile)
|
|
]
|
|
|
|
_latexCommand: (mainFile) ->
|
|
LatexRunner._latexmkBaseCommand.concat [
|
|
"-pdfdvi", "-e", "$latex='latex -synctex=1 -interaction=batchmode %O %S'",
|
|
Path.join("$COMPILE_DIR", mainFile)
|
|
]
|
|
|
|
_xelatexCommand: (mainFile) ->
|
|
LatexRunner._latexmkBaseCommand.concat [
|
|
"-xelatex", "-e", "$pdflatex='xelatex -synctex=1 -interaction=batchmode %O %S'",
|
|
Path.join("$COMPILE_DIR", mainFile)
|
|
]
|
|
|
|
_lualatexCommand: (mainFile) ->
|
|
LatexRunner._latexmkBaseCommand.concat [
|
|
"-pdf", "-e", "$pdflatex='lualatex -synctex=1 -interaction=batchmode %O %S'",
|
|
Path.join("$COMPILE_DIR", mainFile)
|
|
]
|
|
|