Page MenuHomeWickedGov Phorge
Files F4136492

ParserHooksHandler.php
No OneTemporary
Actions

Size
5 KB
Referenced Files
None
Subscribers
None

ParserHooksHandler.php
View Options

<?php
namespace MediaWiki\Extension\Math\HookHandlers;
use MediaWiki\Extension\Math\Hooks\HookRunner;
use MediaWiki\Extension\Math\MathConfig;
use MediaWiki\Extension\Math\MathMathML;
use MediaWiki\Extension\Math\MathMathMLCli;
use MediaWiki\Extension\Math\MathRenderer;
use MediaWiki\Extension\Math\Render\RendererFactory;
use MediaWiki\Hook\ParserAfterTidyHook;
use MediaWiki\Hook\ParserFirstCallInitHook;
use MediaWiki\Hook\ParserOptionsRegisterHook;
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\Parser\Parser;
use MediaWiki\Parser\ParserOptions;
use MediaWiki\User\Options\UserOptionsLookup;
/**
* Hook handler for Parser hooks
*/
class ParserHooksHandler implements
ParserFirstCallInitHook,
ParserAfterTidyHook,
ParserOptionsRegisterHook
{
/** @var int */
private $mathTagCounter = 1;
/** @var array[] renders delayed to be done as a batch [ MathRenderer, Parser ] */
private $mathLazyRenderBatch = [];
/** @var RendererFactory */
private $rendererFactory;
/** @var UserOptionsLookup */
private $userOptionsLookup;
/** @var HookRunner */
private $hookRunner;
/**
* @param RendererFactory $rendererFactory
* @param UserOptionsLookup $userOptionsLookup
* @param HookContainer $hookContainer
*/
public function __construct(
RendererFactory $rendererFactory,
UserOptionsLookup $userOptionsLookup,
HookContainer $hookContainer
) {
$this->rendererFactory = $rendererFactory;
$this->userOptionsLookup = $userOptionsLookup;
$this->hookRunner = new HookRunner( $hookContainer );
}
/**
* Register the <math> tag with the Parser.
*
* @param Parser $parser
*/
public function onParserFirstCallInit( $parser ) {
$parser->setHook( 'math', [ $this, 'mathTagHook' ] );
// @deprecated the ce tag is deprecated in favour of chem cf. T153606
$parser->setHook( 'ce', [ $this, 'chemTagHook' ] );
$parser->setHook( 'chem', [ $this, 'chemTagHook' ] );
}
/**
* Callback function for the <math> parser hook.
*
* @param ?string $content (the LaTeX input)
* @param array $attributes
* @param Parser $parser
* @return array|string
*/
public function mathTagHook( ?string $content, array $attributes, Parser $parser ) {
global $wgMathSvgRenderer;
$mode = $parser->getOptions()->getOption( 'math' );
if ( $mode === MathConfig::MODE_NATIVE_JAX ) {
$parser->getOutput()->addModules( [ 'ext.math.mathjax' ] );
$mode = MathConfig::MODE_NATIVE_MML;
}
$renderer = $this->rendererFactory->getRenderer( $content ?? '', $attributes, $mode );
$parser->getOutput()->addModuleStyles( [ 'ext.math.styles' ] );
if ( array_key_exists( "qid", $attributes ) ) {
$parser->getOutput()->addModules( [ 'ext.math.popup' ] );
}
if ( $wgMathSvgRenderer === 'restbase' && $mode == MathConfig::MODE_MATHML ) {
$marker = Parser::MARKER_PREFIX .
'-postMath-' . sprintf( '%08X', $this->mathTagCounter++ ) .
Parser::MARKER_SUFFIX;
$this->mathLazyRenderBatch[$marker] = [ $renderer, $parser ];
return $marker;
}
return [ $this->mathPostTagHook( $renderer, $parser ), 'markerType' => 'nowiki' ];
}
/**
* Callback function for the <ce> parser hook.
*
* @param ?string $content (the LaTeX input)
* @param array $attributes
* @param Parser $parser
* @return array|string
*/
public function chemTagHook( ?string $content, array $attributes, Parser $parser ) {
$attributes['chem'] = true;
return $this->mathTagHook( '\ce{' . $content . '}', $attributes, $parser );
}
/**
* Callback function for the <math> parser hook.
*
* @param MathRenderer $renderer
* @param Parser $parser
* @return string
*/
private function mathPostTagHook( MathRenderer $renderer, Parser $parser ) {
$checkResult = $renderer->checkTeX();
if ( $checkResult !== true ) {
$renderer->addTrackingCategories( $parser );
return $renderer->getLastError();
}
if ( $renderer->render() ) {
LoggerFactory::getInstance( 'Math' )->debug( "Rendering successful. Writing output" );
$renderedMath = $renderer->getHtmlOutput();
$renderer->addTrackingCategories( $parser );
} else {
LoggerFactory::getInstance( 'Math' )->warning(
"Rendering failed. Printing error message." );
// Set a short parser cache time (10 minutes) after encountering
// render issues, but not syntax issues.
$parser->getOutput()->updateCacheExpiry( 600 );
$renderer->addTrackingCategories( $parser );
return $renderer->getLastError();
}
$this->hookRunner->onMathFormulaPostRender(
$parser, $renderer, $renderedMath
); // Enables indexing of math formula
// Writes cache if rendering was successful
$renderer->writeCache();
return $renderedMath;
}
/**
* @param Parser $parser
* @param string &$text
*/
public function onParserAfterTidy( $parser, &$text ) {
global $wgMathoidCli;
$renderers = array_column( $this->mathLazyRenderBatch, 0 );
if ( $wgMathoidCli ) {
MathMathMLCli::batchEvaluate( $renderers );
} else {
MathMathML::batchEvaluate( $renderers );
}
foreach ( $this->mathLazyRenderBatch as $key => [ $renderer, $renderParser ] ) {
$value = $this->mathPostTagHook( $renderer, $renderParser );
$count = 0;
$text = str_replace( $key, $value, $text, $count );
if ( $count ) {
// This hook might be called multiple times. However once the tag is rendered the job is done.
unset( $this->mathLazyRenderBatch[ $key ] );
}
}
}
/** @inheritDoc */
public function onParserOptionsRegister( &$defaults, &$inCacheKey, &$lazyLoad ) {
$defaults['math'] = $this->userOptionsLookup->getDefaultOption( 'math' );
$inCacheKey['math'] = true;
$lazyLoad['math'] = function ( ParserOptions $options ) {
return MathConfig::normalizeRenderingMode(
$this->userOptionsLookup->getOption( $options->getUserIdentity(), 'math' )
);
};
}
}

File Metadata

Mime Type
text/x-php
Expires
Wed, Aug 19, 13:43 (3 w, 3 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
68/20/3bd386c1575923d0717edfcb6787
Default Alt Text
ParserHooksHandler.php (5 KB)

Event Timeline