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
|
<?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
*/
use MediaWiki\Linker\LinkRenderer;
use MediaWiki\Linker\LinkTarget;
/**
* Handles formatting for the "templates used on this page"
* lists. Formerly known as Linker::formatTemplates()
*
* @since 1.28
*/
class TemplatesOnThisPageFormatter {
/**
* @var IContextSource
*/
private $context;
/**
* @var LinkRenderer
*/
private $linkRenderer;
/**
* @param IContextSource $context
* @param LinkRenderer $linkRenderer
*/
public function __construct( IContextSource $context, LinkRenderer $linkRenderer ) {
$this->context = $context;
$this->linkRenderer = $linkRenderer;
}
/**
* Make an HTML list of templates, and then add a "More..." link at
* the bottom. If $more is null, do not add a "More..." link. If $more
* is a LinkTarget, make a link to that title and use it. If $more is a string,
* directly paste it in as the link (escaping needs to be done manually).
*
* @param LinkTarget[] $templates
* @param string|bool $type 'preview' if a preview, 'section' if a section edit, false if neither
* @param LinkTarget|string|null $more An escaped link for "More..." of the templates
* @return string HTML output
*/
public function format( array $templates, $type = false, $more = null ) {
if ( !$templates ) {
// No templates
return '';
}
# Do a batch existence check
$batch = new LinkBatch;
foreach ( $templates as $title ) {
$batch->addObj( $title );
}
$batch->execute();
# Construct the HTML
$outText = '<div class="mw-templatesUsedExplanation">';
$count = count( $templates );
if ( $type === 'preview' ) {
$outText .= $this->context->msg( 'templatesusedpreview' )->numParams( $count )
->parseAsBlock();
} elseif ( $type === 'section' ) {
$outText .= $this->context->msg( 'templatesusedsection' )->numParams( $count )
->parseAsBlock();
} else {
$outText .= $this->context->msg( 'templatesused' )->numParams( $count )
->parseAsBlock();
}
$outText .= "</div><ul>\n";
usort( $templates, 'Title::compare' );
foreach ( $templates as $template ) {
$outText .= $this->formatTemplate( $template );
}
if ( $more instanceof LinkTarget ) {
$outText .= Html::rawElement( 'li', [], $this->linkRenderer->makeLink(
$more, $this->context->msg( 'moredotdotdot' )->text() ) );
} elseif ( $more ) {
// Documented as should already be escaped
$outText .= Html::rawElement( 'li', [], $more );
}
$outText .= '</ul>';
return $outText;
}
/**
* Builds an <li> item for an individual template
*
* @param LinkTarget $target
* @return string
*/
private function formatTemplate( LinkTarget $target ) {
// TODO Would be nice if we didn't have to use Title here
$titleObj = Title::newFromLinkTarget( $target );
$protected = $this->getRestrictionsText( $titleObj->getRestrictions( 'edit' ) );
$editLink = $this->buildEditLink( $titleObj );
return '<li>' . $this->linkRenderer->makeLink( $target )
. $this->context->msg( 'word-separator' )->escaped()
. $this->context->msg( 'parentheses' )->rawParams( $editLink )->escaped()
. $this->context->msg( 'word-separator' )->escaped()
. $protected . '</li>';
}
/**
* If the page is protected, get the relevant text
* for those restrictions
*
* @param array $restrictions
* @return string
*/
private function getRestrictionsText( array $restrictions ) {
$protected = '';
if ( !$restrictions ) {
return $protected;
}
// Check backwards-compatible messages
$msg = null;
if ( $restrictions === [ 'sysop' ] ) {
$msg = $this->context->msg( 'template-protected' );
} elseif ( $restrictions === [ 'autoconfirmed' ] ) {
$msg = $this->context->msg( 'template-semiprotected' );
}
if ( $msg && !$msg->isDisabled() ) {
$protected = $msg->parse();
} else {
// Construct the message from restriction-level-*
// e.g. restriction-level-sysop, restriction-level-autoconfirmed
$msgs = [];
foreach ( $restrictions as $r ) {
$msgs[] = $this->context->msg( "restriction-level-$r" )->parse();
}
$protected = $this->context->msg( 'parentheses' )
->rawParams( $this->context->getLanguage()->commaList( $msgs ) )->escaped();
}
return $protected;
}
/**
* Return a link to the edit page, with the text
* saying "view source" if the user can't edit the page
*
* @param Title $titleObj
* @return string
*/
private function buildEditLink( Title $titleObj ) {
if ( $titleObj->quickUserCan( 'edit', $this->context->getUser() ) ) {
$linkMsg = 'editlink';
} else {
$linkMsg = 'viewsourcelink';
}
return $this->linkRenderer->makeLink(
$titleObj,
$this->context->msg( $linkMsg )->text(),
[],
[ 'action' => 'edit' ]
);
}
}
|
