RemexDriver.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Tidy;
 
use MediaWiki\Config\ServiceOptions;
use MediaWiki\MainConfigNames;
use Wikimedia\RemexHtml\HTMLData;
use Wikimedia\RemexHtml\Serializer\Serializer;
use Wikimedia\RemexHtml\Serializer\SerializerWithTracer;
use Wikimedia\RemexHtml\Tokenizer\Tokenizer;
use Wikimedia\RemexHtml\TreeBuilder\Dispatcher;
use Wikimedia\RemexHtml\TreeBuilder\TreeBuilder;
use Wikimedia\RemexHtml\TreeBuilder\TreeMutationTracer;
 
class RemexDriver extends TidyDriverBase {
    private $treeMutationTrace;
    private $serializerTrace;
    private $mungerTrace;
    private $pwrap;
    private $enableLegacyMediaDOM;
 
    public const CONSTRUCTOR_OPTIONS = [
        MainConfigNames::TidyConfig,
        MainConfigNames::ParserEnableLegacyMediaDOM,
    ];
 
    public function __construct( $options ) {
        if ( is_array( $options ) ) {
            wfDeprecated( __METHOD__ . " with array argument", '1.36' );
            $config = $options;
        } else {
            $options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
            $config = $options->get( MainConfigNames::TidyConfig );
            $this->enableLegacyMediaDOM = $options->get( MainConfigNames::ParserEnableLegacyMediaDOM );
        }
        $config += [
            'treeMutationTrace' => false,
            'serializerTrace' => false,
            'mungerTrace' => false,
            'pwrap' => true
        ];
        $this->treeMutationTrace = $config['treeMutationTrace'];
        $this->serializerTrace = $config['serializerTrace'];
        $this->mungerTrace = $config['mungerTrace'];
        $this->pwrap = $config['pwrap'];
        parent::__construct( $config );
    }
 
    public function tidy( $text, ?callable $textProcessor = null ) {
        $traceCallback = static function ( $msg ) {
            wfDebug( "RemexHtml: $msg" );
        };
        $formatter = new RemexCompatFormatter( [ 'textProcessor' => $textProcessor ] );
        if ( $this->serializerTrace ) {
            $serializer = new SerializerWithTracer( $formatter, null, $traceCallback );
        } else {
            $serializer = new Serializer( $formatter );
        }
        if ( $this->pwrap ) {
            $munger = new RemexCompatMunger( $serializer, $this->mungerTrace );
        } else {
            $munger = $serializer;
        }
        if ( $this->treeMutationTrace ) {
            $tracer = new TreeMutationTracer( $munger, $traceCallback );
        } else {
            $tracer = $munger;
        }
        $treeBuilderClass = $this->enableLegacyMediaDOM ? TreeBuilder::class : RemexCompatBuilder::class;
        $treeBuilder = new $treeBuilderClass( $tracer, [
            'ignoreErrors' => true,
            'ignoreNulls' => true,
        ] );
        $dispatcher = new Dispatcher( $treeBuilder );
        $tokenizer = new Tokenizer( $dispatcher, $text, [
            'ignoreErrors' => true,
            'ignoreCharRefs' => true,
            'ignoreNulls' => true,
            'skipPreprocess' => true,
        ] );
 
        $tokenizer->execute( [
            'fragmentNamespace' => HTMLData::NS_HTML,
            'fragmentName' => 'body'
        ] );
        return $serializer->getResult();
    }
}