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
|
<?php
namespace MediaWiki\Content\Renderer;
use MediaWiki\Content\Content;
use MediaWiki\Content\IContentHandlerFactory;
use MediaWiki\Page\PageReference;
use MediaWiki\Parser\ParserOptions;
use MediaWiki\Parser\ParserOutput;
use MediaWiki\Revision\RevisionRecord;
use Wikimedia\UUID\GlobalIdGenerator;
/**
* A service to render content.
*
* @since 1.38
*/
class ContentRenderer {
/** @var IContentHandlerFactory */
private $contentHandlerFactory;
private GlobalIdGenerator $globalIdGenerator;
public function __construct(
IContentHandlerFactory $contentHandlerFactory,
GlobalIdGenerator $globalIdGenerator
) {
$this->contentHandlerFactory = $contentHandlerFactory;
$this->globalIdGenerator = $globalIdGenerator;
}
/**
* Returns a ParserOutput object containing information derived from this content.
*
* @param Content $content
* @param PageReference $page
* @param RevisionRecord|null $revision
* @param ParserOptions|null $parserOptions
* @param bool|array{generate-html?:bool,previous-output?:?ParserOutput} $hints
* For back-compatibility, passing a bool is equivalent to setting
* the 'generate-html' hint.
*
* @return ParserOutput
* @note Passing an integer as $rev was deprecated in MW 1.42
*/
public function getParserOutput(
Content $content,
PageReference $page,
$revision = null,
?ParserOptions $parserOptions = null,
$hints = []
): ParserOutput {
$revId = null;
$revTimestamp = null;
if ( is_int( $revision ) ) {
wfDeprecated( __METHOD__ . ' with integer revision id', '1.42' );
$revId = $revision;
} elseif ( $revision !== null ) {
$revId = $revision->getId();
$revTimestamp = $revision->getTimestamp();
}
if ( is_bool( $hints ) ) {
// For backward compatibility.
$hints = [ 'generate-html' => $hints ];
}
$cacheTime = wfTimestampNow();
$contentHandler = $this->contentHandlerFactory->getContentHandler( $content->getModel() );
$cpoParams = new ContentParseParams(
$page,
$revId,
$parserOptions,
$hints['generate-html'] ?? true,
$hints['previous-output'] ?? null
);
$parserOutput = $contentHandler->getParserOutput( $content, $cpoParams );
// Set the cache parameters, if not previously set.
//
// It is expected that this will be where most are set for the first
// time, but a ContentHandler can (for example) use a content-based
// hash for the render id by setting it inside
// ContentHandler::getParserOutput(); any such custom render id
// will not be overwritten here. Similarly, a ContentHandler can
// continue to use the semi-documented feature of ::setCacheTime(-1)
// to indicate "not cacheable", and that will not be overwritten
// either.
if ( !$parserOutput->hasCacheTime() ) {
$parserOutput->setCacheTime( $cacheTime );
}
if ( $parserOutput->getRenderId() === null ) {
$parserOutput->setRenderId( $this->globalIdGenerator->newUUIDv1() );
}
// Revision ID and Revision Timestamp are set here so that we don't
// have to load the revision row on view.
if ( $parserOutput->getCacheRevisionId() === null && $revId !== null ) {
$parserOutput->setCacheRevisionId( $revId );
}
if ( $parserOutput->getRevisionTimestamp() === null && $revTimestamp !== null ) {
$parserOutput->setRevisionTimestamp( $revTimestamp );
}
return $parserOutput;
}
}
|
