1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
|
<?php
namespace MediaWiki\OutputTransform;
use MediaWiki\Parser\ParserOptions;
use MediaWiki\Parser\ParserOutput;
use MediaWiki\Parser\Parsoid\PageBundleParserOutputConverter;
use stdClass;
use Wikimedia\Parsoid\Core\PageBundle;
use Wikimedia\Parsoid\DOM\Document;
use Wikimedia\Parsoid\DOM\Element;
use Wikimedia\Parsoid\Mocks\MockEnv;
use Wikimedia\Parsoid\Utils\ContentUtils;
use Wikimedia\Parsoid\Utils\DOMCompat;
use Wikimedia\Parsoid\Utils\DOMDataUtils;
use Wikimedia\Parsoid\Utils\DOMUtils;
use Wikimedia\Parsoid\Utils\PHPUtils;
use Wikimedia\Parsoid\Utils\Utils;
/**
* OutputTransformStages that modify the content as a HTML DOM tree.
*
* Subclasses are expected to implement ::transformDOM() to mutate the
* DOM-structured content as a Document in-place.
*
* @internal
*/
abstract class ContentDOMTransformStage extends OutputTransformStage {
/**
* @inheritDoc
*/
public function transform(
ParserOutput $po, ?ParserOptions $popts, array &$options
): ParserOutput {
if ( $options['isParsoidContent'] ?? false ) {
return $this->parsoidTransform( $po, $popts, $options );
} else {
return $this->legacyTransform( $po, $popts, $options );
}
}
private function legacyTransform(
ParserOutput $po, ?ParserOptions $popts, array &$options
): ParserOutput {
$text = $po->getContentHolderText();
$doc = DOMUtils::parseHTML( $text );
$doc = $this->transformDOM( $doc, $po, $popts, $options );
$body = DOMCompat::getBody( $doc );
$text = ContentUtils::toXML( $body, [
'innerXML' => true,
] );
$po->setContentHolderText( $text );
return $po;
}
private function parsoidTransform(
ParserOutput $po, ?ParserOptions $popts, array &$options
): ParserOutput {
// TODO will use HTMLHolder in the future
$doc = null;
$hasPageBundle = PageBundleParserOutputConverter::hasPageBundle( $po );
$origPb = null;
if ( $hasPageBundle ) {
$origPb = PageBundleParserOutputConverter::pageBundleFromParserOutput( $po );
$doc = DOMUtils::parseHTML( $po->getContentHolderText() );
PageBundle::apply( $doc, $origPb );
DOMDataUtils::prepareDoc( $doc );
$body = DOMCompat::getBody( $doc );
'@phan-var Element $body'; // assert non-null
DOMDataUtils::visitAndLoadDataAttribs( $body );
} else {
$doc = ContentUtils::createAndLoadDocument(
$po->getContentHolderText(),
);
}
$doc = $this->transformDOM( $doc, $po, $popts, $options );
// TODO will use HTMLHolder in the future
$body = DOMCompat::getBody( $doc );
'@phan-var Element $body'; // assert non-null
if ( $hasPageBundle ) {
DOMDataUtils::visitAndStoreDataAttribs(
$body,
[
'storeInPageBundle' => true,
'env' => new MockEnv( [] ),
]
);
$pb = DOMDataUtils::getPageBundle( $doc );
$pb = self::workaroundT365036( $pb );
$pb = self::combinePageBundles( $pb, $origPb );
PageBundleParserOutputConverter::applyPageBundleDataToParserOutput( $pb, $po );
$text = ContentUtils::toXML( $body, [
'innerXML' => true,
] );
} else {
$text = ContentUtils::ppToXML( $body, [
'innerXML' => true,
] );
}
$po->setContentHolderText( $text );
return $po;
}
private function combinePageBundles( stdClass $pb, ?PageBundle $origPb ): stdClass {
if ( $origPb === null ) {
return $pb;
}
$headers = $origPb->headers;
$pb->headers = $headers ? Utils::clone( $headers ) : null;
$pb->version = $origPb->version;
$pb->contentmodel = $origPb->contentmodel;
return $pb;
}
/**
* This function is necessary (T365036) because PageBundle can have
* non-serializable DataParsoid inside which need
* to be converted to stdClass and string, respectively. We should replace this
* ugly workaround with something nicer.
*/
private function workaroundT365036( PageBundle $pb ): stdClass {
$arrayPageBundle = PHPUtils::jsonDecode( PHPUtils::jsonEncode( $pb ) );
return (object)$arrayPageBundle;
}
/** Applies the transformation to a DOM document */
abstract public function transformDOM(
Document $dom, ParserOutput $po, ?ParserOptions $popts, array &$options
): Document;
}
|
