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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
<?php
/**
* Copyright (C) 2011-2022 Wikimedia Foundation and others.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
namespace MediaWiki\Parser\Parsoid\Config;
use MediaWiki\Parser\ParserOptions;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Revision\SlotRecord;
use MediaWiki\Revision\SlotRoleHandler;
use MediaWiki\Title\Title;
use Wikimedia\Bcp47Code\Bcp47Code;
use Wikimedia\Parsoid\Config\PageConfig as IPageConfig;
use Wikimedia\Parsoid\Config\PageContent as IPageContent;
/**
* Page-level configuration interface for Parsoid
*
* This is effectively "Parsoid's view of ParserOptions".
*
* @since 1.39
* @internal
*/
class PageConfig extends IPageConfig {
private ParserOptions $parserOptions;
private SlotRoleHandler $slotRoleHandler;
private Title $title;
private ?RevisionRecord $revision = null;
private Bcp47Code $pageLanguage;
private string $pageLanguageDir;
/**
* @param ParserOptions $parserOptions
* @param SlotRoleHandler $slotRoleHandler
* @param Title $title Title being parsed
* @param ?RevisionRecord $revision
* @param Bcp47Code $pageLanguage
* @param string $pageLanguageDir
*/
public function __construct(
ParserOptions $parserOptions,
SlotRoleHandler $slotRoleHandler,
Title $title,
?RevisionRecord $revision,
Bcp47Code $pageLanguage,
string $pageLanguageDir
) {
$this->parserOptions = $parserOptions;
$this->slotRoleHandler = $slotRoleHandler;
$this->title = $title;
$this->revision = $revision;
$this->pageLanguage = $pageLanguage;
$this->pageLanguageDir = $pageLanguageDir;
}
public function getContentModel(): string {
// @todo Check just the main slot, or all slots, or what?
$rev = $this->getRevision();
if ( $rev ) {
$content = $rev->getContent( SlotRecord::MAIN );
if ( $content ) {
return $content->getModel();
} else {
// The page does have a content model but we can't see it. Returning the
// default model is not really correct. But we can't see the content either
// so it won't matter much what we do here.
return $this->slotRoleHandler->getDefaultModel( $this->title );
}
} else {
return $this->slotRoleHandler->getDefaultModel( $this->title );
}
}
/** @inheritDoc */
public function getLinkTarget(): Title {
return $this->title;
}
/** @inheritDoc */
public function getPageId(): int {
return $this->title->getArticleID();
}
/** @inheritDoc */
public function getPageLanguageBcp47(): Bcp47Code {
return $this->pageLanguage;
}
/** @inheritDoc */
public function getPageLanguageDir(): string {
return $this->pageLanguageDir;
}
/**
* @internal Used by DataAccess; not part of Parsoid's interface.
* @return ParserOptions
*/
public function getParserOptions(): ParserOptions {
return $this->parserOptions;
}
/**
* Use ParserOptions::getTemplateCallback() to fetch the correct
* (usually latest) RevisionRecord for the given title.
*
* @param Title $title
* @return ?RevisionRecord
*/
public function fetchRevisionRecordOfTemplate( Title $title ): ?RevisionRecord {
// See Parser::fetchTemplateAndTitle(), but stateless
// (Parsoid will track dependencies, etc, itself.)
// The callback defaults to Parser::statelessFetchTemplate()
$templateCb = $this->parserOptions->getTemplateCallback();
$stuff = $templateCb( $title, $this );
return $stuff['revision-record'] ?? null;
}
private function getRevision(): ?RevisionRecord {
return $this->revision;
}
/** @inheritDoc */
public function getRevisionId(): ?int {
$rev = $this->getRevision();
return $rev ? $rev->getId() : null;
}
/** @inheritDoc */
public function getParentRevisionId(): ?int {
$rev = $this->getRevision();
return $rev ? $rev->getParentId() : null;
}
/** @inheritDoc */
public function getRevisionTimestamp(): ?string {
$rev = $this->getRevision();
return $rev ? $rev->getTimestamp() : null;
}
/** @inheritDoc */
public function getRevisionUser(): ?string {
$rev = $this->getRevision();
$user = $rev ? $rev->getUser() : null;
return $user ? $user->getName() : null;
}
/** @inheritDoc */
public function getRevisionUserId(): ?int {
$rev = $this->getRevision();
$user = $rev ? $rev->getUser() : null;
return $user ? $user->getId() : null;
}
/** @inheritDoc */
public function getRevisionSha1(): ?string {
$rev = $this->getRevision();
if ( $rev ) {
// This matches what the Parsoid/JS gets from the API
// FIXME: Maybe we don't need to do this in the future?
return \Wikimedia\base_convert( $rev->getSha1(), 36, 16, 40 );
} else {
return null;
}
}
/** @inheritDoc */
public function getRevisionSize(): ?int {
$rev = $this->getRevision();
return $rev ? $rev->getSize() : null;
}
/** @inheritDoc */
public function getRevisionContent(): ?IPageContent {
$rev = $this->getRevision();
return $rev ? new PageContent( $rev ) : null;
}
}
|
