Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
90.91% covered (success)
90.91%
40 / 44
50.00% covered (danger)
50.00%
1 / 2
 CRAP
0.00% covered (danger)
0.00%
0 / 1
RemexDriver
90.91% covered (success)
90.91%
40 / 44
50.00% covered (danger)
50.00%
1 / 2
 6.03
0.00% covered (danger)
0.00%
0 / 1
 __construct
100.00% covered (success)
100.00%
14 / 14
100.00% covered (success)
100.00%
1 / 1
 1
 tidy
86.67% covered (warning)
86.67%
26 / 30
0.00% covered (danger)
0.00%
0 / 1
 5.06
1<?php
2
3namespace MediaWiki\Tidy;
4
5use MediaWiki\Config\ServiceOptions;
6use MediaWiki\MainConfigNames;
7use Wikimedia\RemexHtml\HTMLData;
8use Wikimedia\RemexHtml\Serializer\Serializer;
9use Wikimedia\RemexHtml\Serializer\SerializerWithTracer;
10use Wikimedia\RemexHtml\Tokenizer\Tokenizer;
11use Wikimedia\RemexHtml\TreeBuilder\Dispatcher;
12use Wikimedia\RemexHtml\TreeBuilder\TreeBuilder;
13use Wikimedia\RemexHtml\TreeBuilder\TreeMutationTracer;
14
15class RemexDriver extends TidyDriverBase {
16    private $treeMutationTrace;
17    private $serializerTrace;
18    private $mungerTrace;
19    private $pwrap;
20    private $enableLegacyMediaDOM;
21
22    /** @internal */
23    public const CONSTRUCTOR_OPTIONS = [
24        MainConfigNames::TidyConfig,
25        MainConfigNames::ParserEnableLegacyMediaDOM,
26    ];
27
28    /**
29     * @param ServiceOptions $options
30     */
31    public function __construct( ServiceOptions $options ) {
32        $options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
33        $config = $options->get( MainConfigNames::TidyConfig );
34        $this->enableLegacyMediaDOM = $options->get( MainConfigNames::ParserEnableLegacyMediaDOM );
35        $config += [
36            'treeMutationTrace' => false,
37            'serializerTrace' => false,
38            'mungerTrace' => false,
39            'pwrap' => true
40        ];
41        $this->treeMutationTrace = $config['treeMutationTrace'];
42        $this->serializerTrace = $config['serializerTrace'];
43        $this->mungerTrace = $config['mungerTrace'];
44        $this->pwrap = $config['pwrap'];
45        parent::__construct( $config );
46    }
47
48    /** @inheritDoc */
49    public function tidy( $text, ?callable $textProcessor = null ) {
50        $traceCallback = static function ( $msg ) {
51            wfDebug( "RemexHtml: $msg" );
52        };
53        $formatter = new RemexCompatFormatter( [ 'textProcessor' => $textProcessor ] );
54        if ( $this->serializerTrace ) {
55            $serializer = new SerializerWithTracer( $formatter, null, $traceCallback );
56        } else {
57            $serializer = new Serializer( $formatter );
58        }
59        if ( $this->pwrap ) {
60            $munger = new RemexCompatMunger( $serializer, $this->mungerTrace );
61        } else {
62            $munger = $serializer;
63        }
64        if ( $this->treeMutationTrace ) {
65            $tracer = new TreeMutationTracer( $munger, $traceCallback );
66        } else {
67            $tracer = $munger;
68        }
69        $treeBuilderClass = $this->enableLegacyMediaDOM ? TreeBuilder::class : RemexCompatBuilder::class;
70        $treeBuilder = new $treeBuilderClass( $tracer, [
71            'ignoreErrors' => true,
72            'ignoreNulls' => true,
73        ] );
74        $dispatcher = new Dispatcher( $treeBuilder );
75        $tokenizer = new Tokenizer( $dispatcher, $text, [
76            'ignoreErrors' => true,
77            'ignoreCharRefs' => true,
78            'ignoreNulls' => true,
79            'skipPreprocess' => true,
80        ] );
81
82        $tokenizer->execute( [
83            'fragmentNamespace' => HTMLData::NS_HTML,
84            'fragmentName' => 'body'
85        ] );
86        return $serializer->getResult();
87    }
88}