mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/Math
synced 2024-11-15 03:34:10 +00:00
118 lines
3.2 KiB
PHP
118 lines
3.2 KiB
PHP
<?php
|
|
/**
|
|
* MediaWiki math extension
|
|
*
|
|
* @copyright 2002-2015 Tomasz Wegrzanowski, Brion Vibber, Moritz Schubotz,
|
|
* and other MediaWiki contributors
|
|
* @license GPL-2.0-or-later
|
|
* @author Moritz Schubotz
|
|
*/
|
|
|
|
use MediaWiki\Logger\LoggerFactory;
|
|
|
|
class MathInputCheckTexvc extends MathInputCheck {
|
|
|
|
/**
|
|
* Converts an error returned by texvc to a localized exception
|
|
*
|
|
* @param string $texvcResult error result returned by texvc
|
|
* @param bool|MathRenderer $errorRenderer
|
|
* @return string
|
|
*/
|
|
public function convertTexvcError( $texvcResult, $errorRenderer = false ) {
|
|
$texvcStatus = substr( $texvcResult, 0, 1 );
|
|
$errDetails = htmlspecialchars( substr( $texvcResult, 1 ) );
|
|
|
|
if ( $errorRenderer === false ) {
|
|
$errorRenderer = new MathSource( $this->inputTeX );
|
|
}
|
|
|
|
switch ( $texvcStatus ) {
|
|
case 'E':
|
|
$errMsg = $errorRenderer->getError( 'math_lexing_error' );
|
|
break;
|
|
case 'S':
|
|
$errMsg = $errorRenderer->getError( 'math_syntax_error' );
|
|
break;
|
|
case 'F':
|
|
$errMsg = $errorRenderer->getError( 'math_unknown_function', $errDetails );
|
|
break;
|
|
default:
|
|
$errMsg = $errorRenderer->getError( 'math_unknown_error' );
|
|
}
|
|
|
|
return $errMsg;
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function isValid() {
|
|
$us = $this;
|
|
$checkWork = new PoolCounterWorkViaCallback( 'MathTexvc-check', "", [
|
|
'doWork' => function () use ( $us ) {
|
|
return $us->doValidCheck();
|
|
}
|
|
] );
|
|
return $checkWork->execute();
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function doValidCheck() {
|
|
global $wgMathTexvcCheckExecutable;
|
|
if ( $wgMathTexvcCheckExecutable === false ) {
|
|
$texvcCheckExecutable = __DIR__ . '/texvccheck/texvccheck';
|
|
} else {
|
|
$texvcCheckExecutable = $wgMathTexvcCheckExecutable;
|
|
}
|
|
if ( !is_executable( $texvcCheckExecutable ) ) {
|
|
$msg = 'Missing "texvccheck" executable. Please see math/README to configure.';
|
|
trigger_error( $msg, E_USER_NOTICE );
|
|
LoggerFactory::getInstance( 'Math' )->error( $msg );
|
|
return true;
|
|
}
|
|
|
|
$cmd = $texvcCheckExecutable . ' ' . wfEscapeShellArg( $this->inputTeX );
|
|
|
|
if ( wfIsWindows() ) {
|
|
# Invoke it within cygwin sh, because texvc expects sh features in its default shell
|
|
$cmd = 'sh -c ' . wfEscapeShellArg( $cmd );
|
|
}
|
|
|
|
LoggerFactory::getInstance( 'Math' )->debug( "TeX check command: $cmd" );
|
|
if ( strlen( $cmd ) > SHELL_MAX_ARG_STRLEN ) {
|
|
LoggerFactory::getInstance( 'Math' )->error(
|
|
"User input exceeded SHELL_MAX_ARG_STRLEN." );
|
|
return $this->convertTexvcError( '' );
|
|
}
|
|
$contents = wfShellExec( $cmd );
|
|
LoggerFactory::getInstance( 'Math' )->debug( "TeX check result: $contents\n---" );
|
|
|
|
if ( strlen( $contents ) === 0 ) {
|
|
LoggerFactory::getInstance( 'Math' )->warning( 'TeX check output was empty.' );
|
|
$this->lastError = $this->convertTexvcError( $contents );
|
|
|
|
return false;
|
|
}
|
|
|
|
$retval = substr( $contents, 0, 1 );
|
|
|
|
if ( $retval !== '+' ) {
|
|
$this->lastError = $this->convertTexvcError( $contents );
|
|
LoggerFactory::getInstance( 'Math' )->warning( 'checkTex failed: ' . $this->lastError );
|
|
|
|
return false;
|
|
} else {
|
|
$this->validTeX = substr( $contents, 1 );
|
|
$this->isValid = true;
|
|
LoggerFactory::getInstance( 'Math' )->debug(
|
|
'checkTex successful tex is now: ' . $this->validTeX );
|
|
|
|
return true;
|
|
}
|
|
}
|
|
|
|
}
|