first commit
This commit is contained in:
229
services/web/frontend/js/ide/log-parser/bib-log-parser.js
Normal file
229
services/web/frontend/js/ide/log-parser/bib-log-parser.js
Normal file
@@ -0,0 +1,229 @@
|
||||
// [fullLine, lineNumber, messageType, message]
|
||||
const LINE_SPLITTER_REGEX = /^\[(\d+)].*>\s(INFO|WARN|ERROR)\s-\s(.*)$/
|
||||
|
||||
const MULTILINE_WARNING_REGEX = /^Warning--(.+)\n--line (\d+) of file (.+)$/m
|
||||
const SINGLELINE_WARNING_REGEX = /^Warning--(.+)$/m
|
||||
const MULTILINE_ERROR_REGEX =
|
||||
/^(.*)---line (\d+) of file (.*)\n([^]+?)\nI'm skipping whatever remains of this entry$/m
|
||||
const BAD_CROSS_REFERENCE_REGEX =
|
||||
/^(A bad cross reference---entry ".+?"\nrefers to entry.+?, which doesn't exist)$/m
|
||||
const MULTILINE_COMMAND_ERROR_REGEX =
|
||||
/^(.*)\n?---line (\d+) of file (.*)\n([^]+?)\nI'm skipping whatever remains of this command$/m
|
||||
// Errors hit in BST file have a slightly different format
|
||||
const BST_ERROR_REGEX = /^(.*?)\nwhile executing---line (\d+) of file (.*)/m
|
||||
|
||||
const MESSAGE_LEVELS = {
|
||||
INFO: 'info',
|
||||
WARN: 'warning',
|
||||
ERROR: 'error',
|
||||
}
|
||||
|
||||
const parserReducer = function (maxErrors) {
|
||||
return function (accumulator, parser) {
|
||||
const consume = function (logText, regex, process) {
|
||||
let match
|
||||
let text = logText
|
||||
const result = []
|
||||
let iterationCount = 0
|
||||
|
||||
while ((match = regex.exec(text))) {
|
||||
iterationCount++
|
||||
const newEntry = process(match)
|
||||
|
||||
// Too many log entries can cause browser crashes
|
||||
// Construct a too many files error from the last match
|
||||
if (maxErrors != null && iterationCount >= maxErrors) {
|
||||
return [result, '']
|
||||
}
|
||||
|
||||
result.push(newEntry)
|
||||
text =
|
||||
match.input.slice(0, match.index) +
|
||||
match.input.slice(
|
||||
match.index + match[0].length + 1,
|
||||
match.input.length
|
||||
)
|
||||
}
|
||||
|
||||
return [result, text]
|
||||
}
|
||||
|
||||
const [currentErrors, text] = accumulator
|
||||
const [regex, process] = parser
|
||||
const [errors, _remainingText] = consume(text, regex, process)
|
||||
return [currentErrors.concat(errors), _remainingText]
|
||||
}
|
||||
}
|
||||
|
||||
export default class BibLogParser {
|
||||
constructor(text, options = {}) {
|
||||
if (typeof text !== 'string') {
|
||||
throw new Error('BibLogParser Error: text parameter must be a string')
|
||||
}
|
||||
this.text = text.replace(/(\r\n)|\r/g, '\n')
|
||||
this.options = options
|
||||
this.lines = text.split('\n')
|
||||
|
||||
// each parser is a pair of [regex, processFunction], where processFunction
|
||||
// describes how to transform the regex mactch into a log entry object.
|
||||
this.warningParsers = [
|
||||
[
|
||||
MULTILINE_WARNING_REGEX,
|
||||
function (match) {
|
||||
const [fullMatch, message, lineNumber, fileName] = match
|
||||
return {
|
||||
file: fileName,
|
||||
level: 'warning',
|
||||
message,
|
||||
line: lineNumber,
|
||||
raw: fullMatch,
|
||||
}
|
||||
},
|
||||
],
|
||||
[
|
||||
SINGLELINE_WARNING_REGEX,
|
||||
function (match) {
|
||||
const [fullMatch, message] = match
|
||||
return {
|
||||
file: '',
|
||||
level: 'warning',
|
||||
message,
|
||||
line: '',
|
||||
raw: fullMatch,
|
||||
}
|
||||
},
|
||||
],
|
||||
]
|
||||
this.errorParsers = [
|
||||
[
|
||||
MULTILINE_ERROR_REGEX,
|
||||
function (match) {
|
||||
const [fullMatch, firstMessage, lineNumber, fileName, secondMessage] =
|
||||
match
|
||||
return {
|
||||
file: fileName,
|
||||
level: 'error',
|
||||
message: firstMessage + '\n' + secondMessage,
|
||||
line: lineNumber,
|
||||
raw: fullMatch,
|
||||
}
|
||||
},
|
||||
],
|
||||
[
|
||||
BAD_CROSS_REFERENCE_REGEX,
|
||||
function (match) {
|
||||
const [fullMatch, message] = match
|
||||
return {
|
||||
file: '',
|
||||
level: 'error',
|
||||
message,
|
||||
line: '',
|
||||
raw: fullMatch,
|
||||
}
|
||||
},
|
||||
],
|
||||
[
|
||||
MULTILINE_COMMAND_ERROR_REGEX,
|
||||
function (match) {
|
||||
const [fullMatch, firstMessage, lineNumber, fileName, secondMessage] =
|
||||
match
|
||||
return {
|
||||
file: fileName,
|
||||
level: 'error',
|
||||
message: firstMessage + '\n' + secondMessage,
|
||||
line: lineNumber,
|
||||
raw: fullMatch,
|
||||
}
|
||||
},
|
||||
],
|
||||
[
|
||||
BST_ERROR_REGEX,
|
||||
function (match) {
|
||||
const [fullMatch, firstMessage, lineNumber, fileName] = match
|
||||
return {
|
||||
file: fileName,
|
||||
level: 'error',
|
||||
message: firstMessage,
|
||||
line: lineNumber,
|
||||
raw: fullMatch,
|
||||
}
|
||||
},
|
||||
],
|
||||
]
|
||||
}
|
||||
|
||||
parseBibtex() {
|
||||
// reduce over the parsers, starting with the log text,
|
||||
const [allWarnings, remainingText] = this.warningParsers.reduce(
|
||||
parserReducer(this.options.maxErrors),
|
||||
[[], this.text]
|
||||
)
|
||||
const [allErrors] = this.errorParsers.reduce(
|
||||
parserReducer(this.options.maxErrors),
|
||||
[[], remainingText]
|
||||
)
|
||||
|
||||
return {
|
||||
all: allWarnings.concat(allErrors),
|
||||
errors: allErrors,
|
||||
warnings: allWarnings,
|
||||
files: [], // not used
|
||||
typesetting: [], // not used
|
||||
}
|
||||
}
|
||||
|
||||
parseBiber() {
|
||||
const result = {
|
||||
all: [],
|
||||
errors: [],
|
||||
warnings: [],
|
||||
files: [], // not used
|
||||
typesetting: [], // not used
|
||||
}
|
||||
this.lines.forEach(function (line) {
|
||||
const match = line.match(LINE_SPLITTER_REGEX)
|
||||
if (match) {
|
||||
const [fullLine, , messageType, message] = match
|
||||
const newEntry = {
|
||||
file: '',
|
||||
level: MESSAGE_LEVELS[messageType] || 'INFO',
|
||||
message,
|
||||
line: '',
|
||||
raw: fullLine,
|
||||
}
|
||||
// try extract file, line-number and the 'real' message from lines like:
|
||||
// BibTeX subsystem: /.../original.bib_123.utf8, line 8, syntax error: it's bad
|
||||
const lineMatch = newEntry.message.match(
|
||||
/^BibTeX subsystem: \/.+\/(\w+\.\w+)_.+, line (\d+), (.+)$/
|
||||
)
|
||||
if (lineMatch) {
|
||||
const [, fileName, lineNumber, realMessage] = lineMatch
|
||||
newEntry.file = fileName
|
||||
newEntry.line = lineNumber
|
||||
newEntry.message = realMessage
|
||||
}
|
||||
result.all.push(newEntry)
|
||||
switch (newEntry.level) {
|
||||
case 'error':
|
||||
return result.errors.push(newEntry)
|
||||
case 'warning':
|
||||
return result.warnings.push(newEntry)
|
||||
}
|
||||
}
|
||||
})
|
||||
return result
|
||||
}
|
||||
|
||||
parse() {
|
||||
const firstLine = this.lines[0]
|
||||
if (firstLine.match(/^.*INFO - This is Biber.*$/)) {
|
||||
return this.parseBiber()
|
||||
} else if (firstLine.match(/^This is BibTeX, Version.+$/)) {
|
||||
return this.parseBibtex()
|
||||
} else {
|
||||
throw new Error(
|
||||
'BibLogParser Error: cannot determine whether text is biber or bibtex output'
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
399
services/web/frontend/js/ide/log-parser/latex-log-parser.js
Normal file
399
services/web/frontend/js/ide/log-parser/latex-log-parser.js
Normal file
@@ -0,0 +1,399 @@
|
||||
// Define some constants
|
||||
const LOG_WRAP_LIMIT = 79
|
||||
const LATEX_WARNING_REGEX = /^LaTeX(?:3| Font)? Warning: (.*)$/
|
||||
const HBOX_WARNING_REGEX = /^(Over|Under)full \\(v|h)box/
|
||||
const PACKAGE_WARNING_REGEX = /^((?:Package|Class|Module) \b.+\b Warning:.*)$/
|
||||
// This is used to parse the line number from common latex warnings
|
||||
const LINES_REGEX = /lines? ([0-9]+)/
|
||||
// This is used to parse the package name from the package warnings
|
||||
const PACKAGE_REGEX = /^(?:Package|Class|Module) (\b.+\b) Warning/
|
||||
const FILE_LINE_ERROR_REGEX = /^([./].*):(\d+): (.*)/
|
||||
|
||||
const STATE = {
|
||||
NORMAL: 0,
|
||||
ERROR: 1,
|
||||
}
|
||||
|
||||
export default class LatexParser {
|
||||
constructor(text, options = {}) {
|
||||
this.state = STATE.NORMAL
|
||||
this.fileBaseNames = options.fileBaseNames || [/compiles/, /\/usr\/local/]
|
||||
this.ignoreDuplicates = options.ignoreDuplicates
|
||||
this.data = []
|
||||
this.fileStack = []
|
||||
this.currentFileList = this.rootFileList = []
|
||||
this.openParens = 0
|
||||
this.latexWarningRegex = LATEX_WARNING_REGEX
|
||||
this.packageWarningRegex = PACKAGE_WARNING_REGEX
|
||||
this.packageRegex = PACKAGE_REGEX
|
||||
this.log = new LogText(text)
|
||||
}
|
||||
|
||||
parse() {
|
||||
while ((this.currentLine = this.log.nextLine()) !== false) {
|
||||
if (this.state === STATE.NORMAL) {
|
||||
if (this.currentLineIsError()) {
|
||||
this.state = STATE.ERROR
|
||||
this.currentError = {
|
||||
line: null,
|
||||
file: this.currentFilePath,
|
||||
level: 'error',
|
||||
message: this.currentLine.slice(2),
|
||||
content: '',
|
||||
raw: this.currentLine + '\n',
|
||||
}
|
||||
} else if (this.currentLineIsFileLineError()) {
|
||||
this.state = STATE.ERROR
|
||||
this.parseFileLineError()
|
||||
} else if (this.currentLineIsRunawayArgument()) {
|
||||
this.parseRunawayArgumentError()
|
||||
} else if (this.currentLineIsWarning()) {
|
||||
this.parseSingleWarningLine(this.latexWarningRegex)
|
||||
} else if (this.currentLineIsHboxWarning()) {
|
||||
this.parseHboxLine()
|
||||
} else if (this.currentLineIsPackageWarning()) {
|
||||
this.parseMultipleWarningLine()
|
||||
} else {
|
||||
this.parseParensForFilenames()
|
||||
}
|
||||
}
|
||||
if (this.state === STATE.ERROR) {
|
||||
this.currentError.content += this.log
|
||||
.linesUpToNextMatchingLine(/^l\.[0-9]+/)
|
||||
.join('\n')
|
||||
this.currentError.content += '\n'
|
||||
this.currentError.content += this.log
|
||||
.linesUpToNextWhitespaceLine(true)
|
||||
.join('\n')
|
||||
this.currentError.content += '\n'
|
||||
this.currentError.content += this.log
|
||||
.linesUpToNextWhitespaceLine(true)
|
||||
.join('\n')
|
||||
this.currentError.raw += this.currentError.content
|
||||
const lineNo = this.currentError.raw.match(/l\.([0-9]+)/)
|
||||
if (lineNo && this.currentError.line === null) {
|
||||
this.currentError.line = parseInt(lineNo[1], 10)
|
||||
}
|
||||
this.data.push(this.currentError)
|
||||
this.state = STATE.NORMAL
|
||||
}
|
||||
}
|
||||
return this.postProcess(this.data)
|
||||
}
|
||||
|
||||
currentLineIsError() {
|
||||
return (
|
||||
this.currentLine[0] === '!' &&
|
||||
this.currentLine !==
|
||||
'! ==> Fatal error occurred, no output PDF file produced!'
|
||||
)
|
||||
}
|
||||
|
||||
currentLineIsFileLineError() {
|
||||
return FILE_LINE_ERROR_REGEX.test(this.currentLine)
|
||||
}
|
||||
|
||||
currentLineIsRunawayArgument() {
|
||||
return this.currentLine.match(/^Runaway argument/)
|
||||
}
|
||||
|
||||
currentLineIsWarning() {
|
||||
return !!this.currentLine.match(this.latexWarningRegex)
|
||||
}
|
||||
|
||||
currentLineIsPackageWarning() {
|
||||
return !!this.currentLine.match(this.packageWarningRegex)
|
||||
}
|
||||
|
||||
currentLineIsHboxWarning() {
|
||||
return !!this.currentLine.match(HBOX_WARNING_REGEX)
|
||||
}
|
||||
|
||||
parseFileLineError() {
|
||||
const result = this.currentLine.match(FILE_LINE_ERROR_REGEX)
|
||||
this.currentError = {
|
||||
line: result[2],
|
||||
file: result[1],
|
||||
level: 'error',
|
||||
message: result[3],
|
||||
content: '',
|
||||
raw: this.currentLine + '\n',
|
||||
}
|
||||
}
|
||||
|
||||
parseRunawayArgumentError() {
|
||||
this.currentError = {
|
||||
line: null,
|
||||
file: this.currentFilePath,
|
||||
level: 'error',
|
||||
message: this.currentLine,
|
||||
content: '',
|
||||
raw: this.currentLine + '\n',
|
||||
}
|
||||
this.currentError.content += this.log
|
||||
.linesUpToNextWhitespaceLine()
|
||||
.join('\n')
|
||||
this.currentError.content += '\n'
|
||||
this.currentError.content += this.log
|
||||
.linesUpToNextWhitespaceLine()
|
||||
.join('\n')
|
||||
this.currentError.raw += this.currentError.content
|
||||
const lineNo = this.currentError.raw.match(/l\.([0-9]+)/)
|
||||
if (lineNo) {
|
||||
this.currentError.line = parseInt(lineNo[1], 10)
|
||||
}
|
||||
return this.data.push(this.currentError)
|
||||
}
|
||||
|
||||
parseSingleWarningLine(prefixRegex) {
|
||||
const warningMatch = this.currentLine.match(prefixRegex)
|
||||
if (!warningMatch) {
|
||||
return
|
||||
}
|
||||
const warning = warningMatch[1]
|
||||
const lineMatch = warning.match(LINES_REGEX)
|
||||
const line = lineMatch ? parseInt(lineMatch[1], 10) : null
|
||||
this.data.push({
|
||||
line,
|
||||
file: this.currentFilePath,
|
||||
level: 'warning',
|
||||
message: warning,
|
||||
raw: warning,
|
||||
})
|
||||
}
|
||||
|
||||
parseMultipleWarningLine() {
|
||||
// Some package warnings are multiple lines, let's parse the first line
|
||||
let warningMatch = this.currentLine.match(this.packageWarningRegex)
|
||||
// Something strange happened, return early
|
||||
if (!warningMatch) {
|
||||
return
|
||||
}
|
||||
const warningLines = [warningMatch[1]]
|
||||
let lineMatch = this.currentLine.match(LINES_REGEX)
|
||||
let line = lineMatch ? parseInt(lineMatch[1], 10) : null
|
||||
const packageMatch = this.currentLine.match(this.packageRegex)
|
||||
const packageName = packageMatch[1]
|
||||
// Regex to get rid of the unnecesary (packagename) prefix in most multi-line warnings
|
||||
const prefixRegex = new RegExp(
|
||||
'(?:\\(' + packageName + '\\))*[\\s]*(.*)',
|
||||
'i'
|
||||
)
|
||||
// After every warning message there's a blank line, let's use it
|
||||
while ((this.currentLine = this.log.nextLine())) {
|
||||
lineMatch = this.currentLine.match(LINES_REGEX)
|
||||
line = lineMatch ? parseInt(lineMatch[1], 10) : line
|
||||
warningMatch = this.currentLine.match(prefixRegex)
|
||||
warningLines.push(warningMatch[1])
|
||||
}
|
||||
const rawMessage = warningLines.join(' ')
|
||||
this.data.push({
|
||||
line,
|
||||
file: this.currentFilePath,
|
||||
level: 'warning',
|
||||
message: rawMessage,
|
||||
raw: rawMessage,
|
||||
})
|
||||
}
|
||||
|
||||
parseHboxLine() {
|
||||
const lineMatch = this.currentLine.match(LINES_REGEX)
|
||||
const line = lineMatch ? parseInt(lineMatch[1], 10) : null
|
||||
this.data.push({
|
||||
line,
|
||||
file: this.currentFilePath,
|
||||
level: 'typesetting',
|
||||
message: this.currentLine,
|
||||
raw: this.currentLine,
|
||||
})
|
||||
}
|
||||
|
||||
// Check if we're entering or leaving a new file in this line
|
||||
|
||||
parseParensForFilenames() {
|
||||
const pos = this.currentLine.search(/[()]/)
|
||||
if (pos !== -1) {
|
||||
const token = this.currentLine[pos]
|
||||
this.currentLine = this.currentLine.slice(pos + 1)
|
||||
if (token === '(') {
|
||||
const filePath = this.consumeFilePath()
|
||||
if (filePath) {
|
||||
this.currentFilePath = filePath
|
||||
const newFile = {
|
||||
path: filePath,
|
||||
files: [],
|
||||
}
|
||||
this.fileStack.push(newFile)
|
||||
this.currentFileList.push(newFile)
|
||||
this.currentFileList = newFile.files
|
||||
} else {
|
||||
this.openParens++
|
||||
}
|
||||
} else if (token === ')') {
|
||||
if (this.openParens > 0) {
|
||||
this.openParens--
|
||||
} else {
|
||||
if (this.fileStack.length > 1) {
|
||||
this.fileStack.pop()
|
||||
const previousFile = this.fileStack[this.fileStack.length - 1]
|
||||
this.currentFilePath = previousFile.path
|
||||
this.currentFileList = previousFile.files
|
||||
}
|
||||
}
|
||||
}
|
||||
// else {
|
||||
// Something has gone wrong but all we can do now is ignore it :(
|
||||
// }
|
||||
// Process the rest of the line
|
||||
this.parseParensForFilenames()
|
||||
}
|
||||
}
|
||||
|
||||
consumeFilePath() {
|
||||
// Our heuristic for detecting file names are rather crude
|
||||
|
||||
// To contain a file path this line must have at least one / before any '(', ')' or '\'
|
||||
if (!this.currentLine.match(/^\/?([^ ()\\]+\/)+/)) {
|
||||
return false
|
||||
}
|
||||
|
||||
// A file may not contain a '(', ')' or '\'
|
||||
let endOfFilePath = this.currentLine.search(/[ ()\\]/)
|
||||
|
||||
// handle the case where there is a space in a filename
|
||||
while (endOfFilePath !== -1 && this.currentLine[endOfFilePath] === ' ') {
|
||||
const partialPath = this.currentLine.slice(0, endOfFilePath)
|
||||
// consider the file matching done if the space is preceded by a file extension (e.g. ".tex")
|
||||
if (/\.\w+$/.test(partialPath)) {
|
||||
break
|
||||
}
|
||||
// advance to next space or ) or end of line
|
||||
const remainingPath = this.currentLine.slice(endOfFilePath + 1)
|
||||
// consider file matching done if current path is followed by any of "()[]
|
||||
if (/^\s*["()[\]]/.test(remainingPath)) {
|
||||
break
|
||||
}
|
||||
const nextEndOfPath = remainingPath.search(/[ "()[\]]/)
|
||||
if (nextEndOfPath === -1) {
|
||||
endOfFilePath = -1
|
||||
} else {
|
||||
endOfFilePath += nextEndOfPath + 1
|
||||
}
|
||||
}
|
||||
let path
|
||||
if (endOfFilePath === -1) {
|
||||
path = this.currentLine
|
||||
this.currentLine = ''
|
||||
} else {
|
||||
path = this.currentLine.slice(0, endOfFilePath)
|
||||
this.currentLine = this.currentLine.slice(endOfFilePath)
|
||||
}
|
||||
return path
|
||||
}
|
||||
|
||||
postProcess(data) {
|
||||
const all = []
|
||||
const errorsByLevel = {
|
||||
error: [],
|
||||
warning: [],
|
||||
typesetting: [],
|
||||
}
|
||||
const hashes = new Set()
|
||||
|
||||
const hashEntry = entry => entry.raw
|
||||
|
||||
data.forEach(item => {
|
||||
const hash = hashEntry(item)
|
||||
|
||||
if (this.ignoreDuplicates && hashes.has(hash)) {
|
||||
return
|
||||
}
|
||||
|
||||
errorsByLevel[item.level]?.push(item)
|
||||
|
||||
all.push(item)
|
||||
hashes.add(hash)
|
||||
})
|
||||
|
||||
return {
|
||||
errors: errorsByLevel.error,
|
||||
warnings: errorsByLevel.warning,
|
||||
typesetting: errorsByLevel.typesetting,
|
||||
all,
|
||||
files: this.rootFileList,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
class LogText {
|
||||
constructor(text) {
|
||||
this.text = text.replace(/(\r\n)|\r/g, '\n')
|
||||
// Join any lines which look like they have wrapped.
|
||||
const wrappedLines = this.text.split('\n')
|
||||
this.lines = [wrappedLines[0]]
|
||||
|
||||
for (let i = 1; i < wrappedLines.length; i++) {
|
||||
// If the previous line is as long as the wrap limit then
|
||||
// append this line to it.
|
||||
// Some lines end with ... when LaTeX knows it's hit the limit
|
||||
// These shouldn't be wrapped.
|
||||
// If the next line looks like it could be an error (i.e. start with a !),
|
||||
// do not unwrap the line.
|
||||
const prevLine = wrappedLines[i - 1]
|
||||
const currentLine = wrappedLines[i]
|
||||
|
||||
if (
|
||||
prevLine.length === LOG_WRAP_LIMIT &&
|
||||
prevLine.slice(-3) !== '...' &&
|
||||
currentLine.charAt(0) !== '!'
|
||||
) {
|
||||
this.lines[this.lines.length - 1] += currentLine
|
||||
} else {
|
||||
this.lines.push(currentLine)
|
||||
}
|
||||
}
|
||||
this.row = 0
|
||||
}
|
||||
|
||||
nextLine() {
|
||||
this.row++
|
||||
if (this.row >= this.lines.length) {
|
||||
return false
|
||||
} else {
|
||||
return this.lines[this.row]
|
||||
}
|
||||
}
|
||||
|
||||
rewindLine() {
|
||||
this.row--
|
||||
}
|
||||
|
||||
linesUpToNextWhitespaceLine(stopAtError) {
|
||||
return this.linesUpToNextMatchingLine(/^ *$/, stopAtError)
|
||||
}
|
||||
|
||||
linesUpToNextMatchingLine(match, stopAtError) {
|
||||
const lines = []
|
||||
|
||||
while (true) {
|
||||
const nextLine = this.nextLine()
|
||||
|
||||
if (nextLine === false) {
|
||||
break
|
||||
}
|
||||
|
||||
if (stopAtError && nextLine.match(/^! /)) {
|
||||
this.rewindLine()
|
||||
break
|
||||
}
|
||||
|
||||
lines.push(nextLine)
|
||||
|
||||
if (nextLine.match(match)) {
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
return lines
|
||||
}
|
||||
}
|
Reference in New Issue
Block a user