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
|
<?php
/**
* 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.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\Rest\Handler\Helper;
use MediaWiki\Language\LanguageCode;
use MediaWiki\Message\Message;
use MediaWiki\Page\PageIdentity;
use MediaWiki\Parser\ParserOutput;
use MediaWiki\Rest\ResponseInterface;
use MediaWiki\Title\Title;
use Wikimedia\Parsoid\Utils\ContentUtils;
use Wikimedia\Parsoid\Utils\DOMUtils;
/**
* @since 1.40
* @unstable
*/
class HtmlMessageOutputHelper implements HtmlOutputHelper {
private ?PageIdentity $page;
/**
* @note Since 1.43 setting $page to null has been deprecated.
*/
public function __construct( ?PageIdentity $page = null ) {
if ( $page === null ) {
wfDeprecated( __METHOD__ . ' without $page', '1.43' );
}
$this->page = $page;
}
/**
* Initializes the helper with the given parameters like the page
* we're dealing with.
*
* @param PageIdentity $page
* @deprecated since 1.43, use constructor argument instead
*/
public function init( PageIdentity $page ): void {
wfDeprecated( __METHOD__, '1.43' );
$this->page = $page;
}
/**
* @return Message|null
*/
private function getDefaultSystemMessage(): ?Message {
$title = Title::castFromPageIdentity( $this->page );
return $title ? $title->getDefaultSystemMessage() : null;
}
/**
* @inheritDoc
*/
public function getHtml(): ParserOutput {
$message = $this->getDefaultSystemMessage();
// NOTE: This class should be used only for system messages,
// so failing hard here is fine if we're not dealing with one.
$messageDom = DOMUtils::parseHTML( $message->parse() );
DOMUtils::appendToHead( $messageDom, 'meta', [
'http-equiv' => 'content-language',
'content' => LanguageCode::bcp47( $message->getLanguage()->getCode() ),
] );
$messageDocHtml = ContentUtils::toXML( $messageDom );
return new ParserOutput( $messageDocHtml );
}
/**
* @inheritDoc
*/
public function getETag( string $suffix = '' ): ?string {
// XXX: We end up generating the HTML twice. Would be nice to avoid that.
// But messages are small, and not hit a lot...
$output = $this->getHtml();
return '"message/' . sha1( $output->getRawText() ) . '/' . $suffix . '"';
}
/**
* @inheritDoc
*
* @note This is guaranteed to always return NULL since
* proper system messages (with no DB entry) have no
* revision, so they should have no last modified time.
*/
public function getLastModified(): ?string {
return null;
}
/**
* @inheritDoc
*/
public static function getParamSettings(): array {
return [];
}
/**
* @inheritDoc
*/
public function setVariantConversionLanguage(
$targetLanguage,
$sourceLanguage = null
): void {
// TODO: Set language in the response headers.
}
public function putHeaders(
ResponseInterface $response,
bool $forHtml = true
): void {
// TODO: Set language in the response headers.
}
}
|
