GitInfo: Don't try shelling out if it's disabled
[lhc/web/wiklou.git] / includes / Linker.php
1 <?php
2 /**
3 * Methods to make links and related items.
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
19 *
20 * @file
21 */
22 use MediaWiki\Linker\LinkTarget;
23 use MediaWiki\MediaWikiServices;
24
25 /**
26 * Some internal bits split of from Skin.php. These functions are used
27 * for primarily page content: links, embedded images, table of contents. Links
28 * are also used in the skin.
29 *
30 * @todo turn this into a legacy interface for HtmlPageLinkRenderer and similar services.
31 *
32 * @ingroup Skins
33 */
34 class Linker {
35 /**
36 * Flags for userToolLinks()
37 */
38 const TOOL_LINKS_NOBLOCK = 1;
39 const TOOL_LINKS_EMAIL = 2;
40
41 /**
42 * Return the CSS colour of a known link
43 *
44 * @deprecated since 1.28, use LinkRenderer::getLinkClasses() instead
45 *
46 * @since 1.16.3
47 * @param LinkTarget $t
48 * @param int $threshold User defined threshold
49 * @return string CSS class
50 */
51 public static function getLinkColour( LinkTarget $t, $threshold ) {
52 wfDeprecated( __METHOD__, '1.28' );
53 $services = MediaWikiServices::getInstance();
54 $linkRenderer = $services->getLinkRenderer();
55 if ( $threshold !== $linkRenderer->getStubThreshold() ) {
56 // Need to create a new instance with the right stub threshold...
57 $linkRenderer = $services->getLinkRendererFactory()->create();
58 $linkRenderer->setStubThreshold( $threshold );
59 }
60
61 return $linkRenderer->getLinkClasses( $t );
62 }
63
64 /**
65 * This function returns an HTML link to the given target. It serves a few
66 * purposes:
67 * 1) If $target is a Title, the correct URL to link to will be figured
68 * out automatically.
69 * 2) It automatically adds the usual classes for various types of link
70 * targets: "new" for red links, "stub" for short articles, etc.
71 * 3) It escapes all attribute values safely so there's no risk of XSS.
72 * 4) It provides a default tooltip if the target is a Title (the page
73 * name of the target).
74 * link() replaces the old functions in the makeLink() family.
75 *
76 * @since 1.18 Method exists since 1.16 as non-static, made static in 1.18.
77 * @deprecated since 1.28, use MediaWiki\Linker\LinkRenderer instead
78 *
79 * @param LinkTarget $target Can currently only be a LinkTarget, but this may
80 * change to support Images, literal URLs, etc.
81 * @param string $html The HTML contents of the <a> element, i.e.,
82 * the link text. This is raw HTML and will not be escaped. If null,
83 * defaults to the prefixed text of the Title; or if the Title is just a
84 * fragment, the contents of the fragment.
85 * @param array $customAttribs A key => value array of extra HTML attributes,
86 * such as title and class. (href is ignored.) Classes will be
87 * merged with the default classes, while other attributes will replace
88 * default attributes. All passed attribute values will be HTML-escaped.
89 * A false attribute value means to suppress that attribute.
90 * @param array $query The query string to append to the URL
91 * you're linking to, in key => value array form. Query keys and values
92 * will be URL-encoded.
93 * @param string|array $options String or array of strings:
94 * 'known': Page is known to exist, so don't check if it does.
95 * 'broken': Page is known not to exist, so don't check if it does.
96 * 'noclasses': Don't add any classes automatically (includes "new",
97 * "stub", "mw-redirect", "extiw"). Only use the class attribute
98 * provided, if any, so you get a simple blue link with no funny i-
99 * cons.
100 * 'forcearticlepath': Use the article path always, even with a querystring.
101 * Has compatibility issues on some setups, so avoid wherever possible.
102 * 'http': Force a full URL with http:// as the scheme.
103 * 'https': Force a full URL with https:// as the scheme.
104 * 'stubThreshold' => (int): Stub threshold to use when determining link classes.
105 * @return string HTML <a> attribute
106 */
107 public static function link(
108 $target, $html = null, $customAttribs = [], $query = [], $options = []
109 ) {
110 if ( !$target instanceof LinkTarget ) {
111 wfWarn( __METHOD__ . ': Requires $target to be a LinkTarget object.', 2 );
112 return "<!-- ERROR -->$html";
113 }
114
115 if ( is_string( $query ) ) {
116 // some functions withing core using this still hand over query strings
117 wfDeprecated( __METHOD__ . ' with parameter $query as string (should be array)', '1.20' );
118 $query = wfCgiToArray( $query );
119 }
120
121 $services = MediaWikiServices::getInstance();
122 $options = (array)$options;
123 if ( $options ) {
124 // Custom options, create new LinkRenderer
125 if ( !isset( $options['stubThreshold'] ) ) {
126 $defaultLinkRenderer = $services->getLinkRenderer();
127 $options['stubThreshold'] = $defaultLinkRenderer->getStubThreshold();
128 }
129 $linkRenderer = $services->getLinkRendererFactory()
130 ->createFromLegacyOptions( $options );
131 } else {
132 $linkRenderer = $services->getLinkRenderer();
133 }
134
135 if ( $html !== null ) {
136 $text = new HtmlArmor( $html );
137 } else {
138 $text = $html; // null
139 }
140 if ( in_array( 'known', $options, true ) ) {
141 return $linkRenderer->makeKnownLink( $target, $text, $customAttribs, $query );
142 } elseif ( in_array( 'broken', $options, true ) ) {
143 return $linkRenderer->makeBrokenLink( $target, $text, $customAttribs, $query );
144 } elseif ( in_array( 'noclasses', $options, true ) ) {
145 return $linkRenderer->makePreloadedLink( $target, $text, '', $customAttribs, $query );
146 } else {
147 return $linkRenderer->makeLink( $target, $text, $customAttribs, $query );
148 }
149 }
150
151 /**
152 * Identical to link(), except $options defaults to 'known'.
153 *
154 * @since 1.16.3
155 * @deprecated since 1.28, use MediaWiki\Linker\LinkRenderer instead
156 * @see Linker::link
157 * @param Title $target
158 * @param string $html
159 * @param array $customAttribs
160 * @param array $query
161 * @param string|array $options
162 * @return string
163 */
164 public static function linkKnown(
165 $target, $html = null, $customAttribs = [],
166 $query = [], $options = [ 'known' ]
167 ) {
168 return self::link( $target, $html, $customAttribs, $query, $options );
169 }
170
171 /**
172 * Make appropriate markup for a link to the current article. This is since
173 * MediaWiki 1.29.0 rendered as an <a> tag without an href and with a class
174 * showing the link text. The calling sequence is the same as for the other
175 * make*LinkObj static functions, but $query is not used.
176 *
177 * @since 1.16.3
178 * @param Title $nt
179 * @param string $html [optional]
180 * @param string $query [optional]
181 * @param string $trail [optional]
182 * @param string $prefix [optional]
183 *
184 * @return string
185 */
186 public static function makeSelfLinkObj( $nt, $html = '', $query = '', $trail = '', $prefix = '' ) {
187 $ret = "<a class=\"mw-selflink selflink\">{$prefix}{$html}</a>{$trail}";
188 if ( !Hooks::run( 'SelfLinkBegin', [ $nt, &$html, &$trail, &$prefix, &$ret ] ) ) {
189 return $ret;
190 }
191
192 if ( $html == '' ) {
193 $html = htmlspecialchars( $nt->getPrefixedText() );
194 }
195 list( $inside, $trail ) = self::splitTrail( $trail );
196 return "<a class=\"mw-selflink selflink\">{$prefix}{$html}{$inside}</a>{$trail}";
197 }
198
199 /**
200 * Get a message saying that an invalid title was encountered.
201 * This should be called after a method like Title::makeTitleSafe() returned
202 * a value indicating that the title object is invalid.
203 *
204 * @param IContextSource $context Context to use to get the messages
205 * @param int $namespace Namespace number
206 * @param string $title Text of the title, without the namespace part
207 * @return string
208 */
209 public static function getInvalidTitleDescription( IContextSource $context, $namespace, $title ) {
210 global $wgContLang;
211
212 // First we check whether the namespace exists or not.
213 if ( MWNamespace::exists( $namespace ) ) {
214 if ( $namespace == NS_MAIN ) {
215 $name = $context->msg( 'blanknamespace' )->text();
216 } else {
217 $name = $wgContLang->getFormattedNsText( $namespace );
218 }
219 return $context->msg( 'invalidtitle-knownnamespace', $namespace, $name, $title )->text();
220 } else {
221 return $context->msg( 'invalidtitle-unknownnamespace', $namespace, $title )->text();
222 }
223 }
224
225 /**
226 * @since 1.16.3
227 * @param LinkTarget $target
228 * @return LinkTarget
229 */
230 public static function normaliseSpecialPage( LinkTarget $target ) {
231 if ( $target->getNamespace() == NS_SPECIAL && !$target->isExternal() ) {
232 list( $name, $subpage ) = SpecialPageFactory::resolveAlias( $target->getDBkey() );
233 if ( !$name ) {
234 return $target;
235 }
236 $ret = SpecialPage::getTitleValueFor( $name, $subpage, $target->getFragment() );
237 return $ret;
238 } else {
239 return $target;
240 }
241 }
242
243 /**
244 * Returns the filename part of an url.
245 * Used as alternative text for external images.
246 *
247 * @param string $url
248 *
249 * @return string
250 */
251 private static function fnamePart( $url ) {
252 $basename = strrchr( $url, '/' );
253 if ( false === $basename ) {
254 $basename = $url;
255 } else {
256 $basename = substr( $basename, 1 );
257 }
258 return $basename;
259 }
260
261 /**
262 * Return the code for images which were added via external links,
263 * via Parser::maybeMakeExternalImage().
264 *
265 * @since 1.16.3
266 * @param string $url
267 * @param string $alt
268 *
269 * @return string
270 */
271 public static function makeExternalImage( $url, $alt = '' ) {
272 if ( $alt == '' ) {
273 $alt = self::fnamePart( $url );
274 }
275 $img = '';
276 $success = Hooks::run( 'LinkerMakeExternalImage', [ &$url, &$alt, &$img ] );
277 if ( !$success ) {
278 wfDebug( "Hook LinkerMakeExternalImage changed the output of external image "
279 . "with url {$url} and alt text {$alt} to {$img}\n", true );
280 return $img;
281 }
282 return Html::element( 'img',
283 [
284 'src' => $url,
285 'alt' => $alt ] );
286 }
287
288 /**
289 * Given parameters derived from [[Image:Foo|options...]], generate the
290 * HTML that that syntax inserts in the page.
291 *
292 * @param Parser $parser
293 * @param Title $title Title object of the file (not the currently viewed page)
294 * @param File $file File object, or false if it doesn't exist
295 * @param array $frameParams Associative array of parameters external to the media handler.
296 * Boolean parameters are indicated by presence or absence, the value is arbitrary and
297 * will often be false.
298 * thumbnail If present, downscale and frame
299 * manualthumb Image name to use as a thumbnail, instead of automatic scaling
300 * framed Shows image in original size in a frame
301 * frameless Downscale but don't frame
302 * upright If present, tweak default sizes for portrait orientation
303 * upright_factor Fudge factor for "upright" tweak (default 0.75)
304 * border If present, show a border around the image
305 * align Horizontal alignment (left, right, center, none)
306 * valign Vertical alignment (baseline, sub, super, top, text-top, middle,
307 * bottom, text-bottom)
308 * alt Alternate text for image (i.e. alt attribute). Plain text.
309 * class HTML for image classes. Plain text.
310 * caption HTML for image caption.
311 * link-url URL to link to
312 * link-title Title object to link to
313 * link-target Value for the target attribute, only with link-url
314 * no-link Boolean, suppress description link
315 *
316 * @param array $handlerParams Associative array of media handler parameters, to be passed
317 * to transform(). Typical keys are "width" and "page".
318 * @param string|bool $time Timestamp of the file, set as false for current
319 * @param string $query Query params for desc url
320 * @param int|null $widthOption Used by the parser to remember the user preference thumbnailsize
321 * @since 1.20
322 * @return string HTML for an image, with links, wrappers, etc.
323 */
324 public static function makeImageLink( Parser $parser, Title $title,
325 $file, $frameParams = [], $handlerParams = [], $time = false,
326 $query = "", $widthOption = null
327 ) {
328 $res = null;
329 $dummy = new DummyLinker;
330 if ( !Hooks::run( 'ImageBeforeProduceHTML', [ &$dummy, &$title,
331 &$file, &$frameParams, &$handlerParams, &$time, &$res ] ) ) {
332 return $res;
333 }
334
335 if ( $file && !$file->allowInlineDisplay() ) {
336 wfDebug( __METHOD__ . ': ' . $title->getPrefixedDBkey() . " does not allow inline display\n" );
337 return self::link( $title );
338 }
339
340 // Clean up parameters
341 $page = isset( $handlerParams['page'] ) ? $handlerParams['page'] : false;
342 if ( !isset( $frameParams['align'] ) ) {
343 $frameParams['align'] = '';
344 }
345 if ( !isset( $frameParams['alt'] ) ) {
346 $frameParams['alt'] = '';
347 }
348 if ( !isset( $frameParams['title'] ) ) {
349 $frameParams['title'] = '';
350 }
351 if ( !isset( $frameParams['class'] ) ) {
352 $frameParams['class'] = '';
353 }
354
355 $prefix = $postfix = '';
356
357 if ( 'center' == $frameParams['align'] ) {
358 $prefix = '<div class="center">';
359 $postfix = '</div>';
360 $frameParams['align'] = 'none';
361 }
362 if ( $file && !isset( $handlerParams['width'] ) ) {
363 if ( isset( $handlerParams['height'] ) && $file->isVectorized() ) {
364 // If its a vector image, and user only specifies height
365 // we don't want it to be limited by its "normal" width.
366 global $wgSVGMaxSize;
367 $handlerParams['width'] = $wgSVGMaxSize;
368 } else {
369 $handlerParams['width'] = $file->getWidth( $page );
370 }
371
372 if ( isset( $frameParams['thumbnail'] )
373 || isset( $frameParams['manualthumb'] )
374 || isset( $frameParams['framed'] )
375 || isset( $frameParams['frameless'] )
376 || !$handlerParams['width']
377 ) {
378 global $wgThumbLimits, $wgThumbUpright;
379
380 if ( $widthOption === null || !isset( $wgThumbLimits[$widthOption] ) ) {
381 $widthOption = User::getDefaultOption( 'thumbsize' );
382 }
383
384 // Reduce width for upright images when parameter 'upright' is used
385 if ( isset( $frameParams['upright'] ) && $frameParams['upright'] == 0 ) {
386 $frameParams['upright'] = $wgThumbUpright;
387 }
388
389 // For caching health: If width scaled down due to upright
390 // parameter, round to full __0 pixel to avoid the creation of a
391 // lot of odd thumbs.
392 $prefWidth = isset( $frameParams['upright'] ) ?
393 round( $wgThumbLimits[$widthOption] * $frameParams['upright'], -1 ) :
394 $wgThumbLimits[$widthOption];
395
396 // Use width which is smaller: real image width or user preference width
397 // Unless image is scalable vector.
398 if ( !isset( $handlerParams['height'] ) && ( $handlerParams['width'] <= 0 ||
399 $prefWidth < $handlerParams['width'] || $file->isVectorized() ) ) {
400 $handlerParams['width'] = $prefWidth;
401 }
402 }
403 }
404
405 if ( isset( $frameParams['thumbnail'] ) || isset( $frameParams['manualthumb'] )
406 || isset( $frameParams['framed'] )
407 ) {
408 # Create a thumbnail. Alignment depends on the writing direction of
409 # the page content language (right-aligned for LTR languages,
410 # left-aligned for RTL languages)
411 # If a thumbnail width has not been provided, it is set
412 # to the default user option as specified in Language*.php
413 if ( $frameParams['align'] == '' ) {
414 $frameParams['align'] = $parser->getTargetLanguage()->alignEnd();
415 }
416 return $prefix .
417 self::makeThumbLink2( $title, $file, $frameParams, $handlerParams, $time, $query ) .
418 $postfix;
419 }
420
421 if ( $file && isset( $frameParams['frameless'] ) ) {
422 $srcWidth = $file->getWidth( $page );
423 # For "frameless" option: do not present an image bigger than the
424 # source (for bitmap-style images). This is the same behavior as the
425 # "thumb" option does it already.
426 if ( $srcWidth && !$file->mustRender() && $handlerParams['width'] > $srcWidth ) {
427 $handlerParams['width'] = $srcWidth;
428 }
429 }
430
431 if ( $file && isset( $handlerParams['width'] ) ) {
432 # Create a resized image, without the additional thumbnail features
433 $thumb = $file->transform( $handlerParams );
434 } else {
435 $thumb = false;
436 }
437
438 if ( !$thumb ) {
439 $s = self::makeBrokenImageLinkObj( $title, $frameParams['title'], '', '', '', $time == true );
440 } else {
441 self::processResponsiveImages( $file, $thumb, $handlerParams );
442 $params = [
443 'alt' => $frameParams['alt'],
444 'title' => $frameParams['title'],
445 'valign' => isset( $frameParams['valign'] ) ? $frameParams['valign'] : false,
446 'img-class' => $frameParams['class'] ];
447 if ( isset( $frameParams['border'] ) ) {
448 $params['img-class'] .= ( $params['img-class'] !== '' ? ' ' : '' ) . 'thumbborder';
449 }
450 $params = self::getImageLinkMTOParams( $frameParams, $query, $parser ) + $params;
451
452 $s = $thumb->toHtml( $params );
453 }
454 if ( $frameParams['align'] != '' ) {
455 $s = "<div class=\"float{$frameParams['align']}\">{$s}</div>";
456 }
457 return str_replace( "\n", ' ', $prefix . $s . $postfix );
458 }
459
460 /**
461 * Get the link parameters for MediaTransformOutput::toHtml() from given
462 * frame parameters supplied by the Parser.
463 * @param array $frameParams The frame parameters
464 * @param string $query An optional query string to add to description page links
465 * @param Parser|null $parser
466 * @return array
467 */
468 private static function getImageLinkMTOParams( $frameParams, $query = '', $parser = null ) {
469 $mtoParams = [];
470 if ( isset( $frameParams['link-url'] ) && $frameParams['link-url'] !== '' ) {
471 $mtoParams['custom-url-link'] = $frameParams['link-url'];
472 if ( isset( $frameParams['link-target'] ) ) {
473 $mtoParams['custom-target-link'] = $frameParams['link-target'];
474 }
475 if ( $parser ) {
476 $extLinkAttrs = $parser->getExternalLinkAttribs( $frameParams['link-url'] );
477 foreach ( $extLinkAttrs as $name => $val ) {
478 // Currently could include 'rel' and 'target'
479 $mtoParams['parser-extlink-' . $name] = $val;
480 }
481 }
482 } elseif ( isset( $frameParams['link-title'] ) && $frameParams['link-title'] !== '' ) {
483 $mtoParams['custom-title-link'] = Title::newFromLinkTarget(
484 self::normaliseSpecialPage( $frameParams['link-title'] )
485 );
486 } elseif ( !empty( $frameParams['no-link'] ) ) {
487 // No link
488 } else {
489 $mtoParams['desc-link'] = true;
490 $mtoParams['desc-query'] = $query;
491 }
492 return $mtoParams;
493 }
494
495 /**
496 * Make HTML for a thumbnail including image, border and caption
497 * @param Title $title
498 * @param File|bool $file File object or false if it doesn't exist
499 * @param string $label
500 * @param string $alt
501 * @param string $align
502 * @param array $params
503 * @param bool $framed
504 * @param string $manualthumb
505 * @return string
506 */
507 public static function makeThumbLinkObj( Title $title, $file, $label = '', $alt,
508 $align = 'right', $params = [], $framed = false, $manualthumb = ""
509 ) {
510 $frameParams = [
511 'alt' => $alt,
512 'caption' => $label,
513 'align' => $align
514 ];
515 if ( $framed ) {
516 $frameParams['framed'] = true;
517 }
518 if ( $manualthumb ) {
519 $frameParams['manualthumb'] = $manualthumb;
520 }
521 return self::makeThumbLink2( $title, $file, $frameParams, $params );
522 }
523
524 /**
525 * @param Title $title
526 * @param File $file
527 * @param array $frameParams
528 * @param array $handlerParams
529 * @param bool $time
530 * @param string $query
531 * @return string
532 */
533 public static function makeThumbLink2( Title $title, $file, $frameParams = [],
534 $handlerParams = [], $time = false, $query = ""
535 ) {
536 $exists = $file && $file->exists();
537
538 $page = isset( $handlerParams['page'] ) ? $handlerParams['page'] : false;
539 if ( !isset( $frameParams['align'] ) ) {
540 $frameParams['align'] = 'right';
541 }
542 if ( !isset( $frameParams['alt'] ) ) {
543 $frameParams['alt'] = '';
544 }
545 if ( !isset( $frameParams['title'] ) ) {
546 $frameParams['title'] = '';
547 }
548 if ( !isset( $frameParams['caption'] ) ) {
549 $frameParams['caption'] = '';
550 }
551
552 if ( empty( $handlerParams['width'] ) ) {
553 // Reduce width for upright images when parameter 'upright' is used
554 $handlerParams['width'] = isset( $frameParams['upright'] ) ? 130 : 180;
555 }
556 $thumb = false;
557 $noscale = false;
558 $manualthumb = false;
559
560 if ( !$exists ) {
561 $outerWidth = $handlerParams['width'] + 2;
562 } else {
563 if ( isset( $frameParams['manualthumb'] ) ) {
564 # Use manually specified thumbnail
565 $manual_title = Title::makeTitleSafe( NS_FILE, $frameParams['manualthumb'] );
566 if ( $manual_title ) {
567 $manual_img = wfFindFile( $manual_title );
568 if ( $manual_img ) {
569 $thumb = $manual_img->getUnscaledThumb( $handlerParams );
570 $manualthumb = true;
571 } else {
572 $exists = false;
573 }
574 }
575 } elseif ( isset( $frameParams['framed'] ) ) {
576 // Use image dimensions, don't scale
577 $thumb = $file->getUnscaledThumb( $handlerParams );
578 $noscale = true;
579 } else {
580 # Do not present an image bigger than the source, for bitmap-style images
581 # This is a hack to maintain compatibility with arbitrary pre-1.10 behavior
582 $srcWidth = $file->getWidth( $page );
583 if ( $srcWidth && !$file->mustRender() && $handlerParams['width'] > $srcWidth ) {
584 $handlerParams['width'] = $srcWidth;
585 }
586 $thumb = $file->transform( $handlerParams );
587 }
588
589 if ( $thumb ) {
590 $outerWidth = $thumb->getWidth() + 2;
591 } else {
592 $outerWidth = $handlerParams['width'] + 2;
593 }
594 }
595
596 # ThumbnailImage::toHtml() already adds page= onto the end of DjVu URLs
597 # So we don't need to pass it here in $query. However, the URL for the
598 # zoom icon still needs it, so we make a unique query for it. See T16771
599 $url = $title->getLocalURL( $query );
600 if ( $page ) {
601 $url = wfAppendQuery( $url, [ 'page' => $page ] );
602 }
603 if ( $manualthumb
604 && !isset( $frameParams['link-title'] )
605 && !isset( $frameParams['link-url'] )
606 && !isset( $frameParams['no-link'] ) ) {
607 $frameParams['link-url'] = $url;
608 }
609
610 $s = "<div class=\"thumb t{$frameParams['align']}\">"
611 . "<div class=\"thumbinner\" style=\"width:{$outerWidth}px;\">";
612
613 if ( !$exists ) {
614 $s .= self::makeBrokenImageLinkObj( $title, $frameParams['title'], '', '', '', $time == true );
615 $zoomIcon = '';
616 } elseif ( !$thumb ) {
617 $s .= wfMessage( 'thumbnail_error', '' )->escaped();
618 $zoomIcon = '';
619 } else {
620 if ( !$noscale && !$manualthumb ) {
621 self::processResponsiveImages( $file, $thumb, $handlerParams );
622 }
623 $params = [
624 'alt' => $frameParams['alt'],
625 'title' => $frameParams['title'],
626 'img-class' => ( isset( $frameParams['class'] ) && $frameParams['class'] !== ''
627 ? $frameParams['class'] . ' '
628 : '' ) . 'thumbimage'
629 ];
630 $params = self::getImageLinkMTOParams( $frameParams, $query ) + $params;
631 $s .= $thumb->toHtml( $params );
632 if ( isset( $frameParams['framed'] ) ) {
633 $zoomIcon = "";
634 } else {
635 $zoomIcon = Html::rawElement( 'div', [ 'class' => 'magnify' ],
636 Html::rawElement( 'a', [
637 'href' => $url,
638 'class' => 'internal',
639 'title' => wfMessage( 'thumbnail-more' )->text() ],
640 "" ) );
641 }
642 }
643 $s .= ' <div class="thumbcaption">' . $zoomIcon . $frameParams['caption'] . "</div></div></div>";
644 return str_replace( "\n", ' ', $s );
645 }
646
647 /**
648 * Process responsive images: add 1.5x and 2x subimages to the thumbnail, where
649 * applicable.
650 *
651 * @param File $file
652 * @param MediaTransformOutput $thumb
653 * @param array $hp Image parameters
654 */
655 public static function processResponsiveImages( $file, $thumb, $hp ) {
656 global $wgResponsiveImages;
657 if ( $wgResponsiveImages && $thumb && !$thumb->isError() ) {
658 $hp15 = $hp;
659 $hp15['width'] = round( $hp['width'] * 1.5 );
660 $hp20 = $hp;
661 $hp20['width'] = $hp['width'] * 2;
662 if ( isset( $hp['height'] ) ) {
663 $hp15['height'] = round( $hp['height'] * 1.5 );
664 $hp20['height'] = $hp['height'] * 2;
665 }
666
667 $thumb15 = $file->transform( $hp15 );
668 $thumb20 = $file->transform( $hp20 );
669 if ( $thumb15 && !$thumb15->isError() && $thumb15->getUrl() !== $thumb->getUrl() ) {
670 $thumb->responsiveUrls['1.5'] = $thumb15->getUrl();
671 }
672 if ( $thumb20 && !$thumb20->isError() && $thumb20->getUrl() !== $thumb->getUrl() ) {
673 $thumb->responsiveUrls['2'] = $thumb20->getUrl();
674 }
675 }
676 }
677
678 /**
679 * Make a "broken" link to an image
680 *
681 * @since 1.16.3
682 * @param Title $title
683 * @param string $label Link label (plain text)
684 * @param string $query Query string
685 * @param string $unused1 Unused parameter kept for b/c
686 * @param string $unused2 Unused parameter kept for b/c
687 * @param bool $time A file of a certain timestamp was requested
688 * @return string
689 */
690 public static function makeBrokenImageLinkObj( $title, $label = '',
691 $query = '', $unused1 = '', $unused2 = '', $time = false
692 ) {
693 if ( !$title instanceof Title ) {
694 wfWarn( __METHOD__ . ': Requires $title to be a Title object.' );
695 return "<!-- ERROR -->" . htmlspecialchars( $label );
696 }
697
698 global $wgEnableUploads, $wgUploadMissingFileUrl, $wgUploadNavigationUrl;
699 if ( $label == '' ) {
700 $label = $title->getPrefixedText();
701 }
702 $encLabel = htmlspecialchars( $label );
703 $currentExists = $time ? ( wfFindFile( $title ) != false ) : false;
704
705 if ( ( $wgUploadMissingFileUrl || $wgUploadNavigationUrl || $wgEnableUploads )
706 && !$currentExists
707 ) {
708 $redir = RepoGroup::singleton()->getLocalRepo()->checkRedirect( $title );
709
710 if ( $redir ) {
711 // We already know it's a redirect, so mark it
712 // accordingly
713 return self::link(
714 $title,
715 $encLabel,
716 [ 'class' => 'mw-redirect' ],
717 wfCgiToArray( $query ),
718 [ 'known', 'noclasses' ]
719 );
720 }
721
722 $href = self::getUploadUrl( $title, $query );
723
724 return '<a href="' . htmlspecialchars( $href ) . '" class="new" title="' .
725 htmlspecialchars( $title->getPrefixedText(), ENT_QUOTES ) . '">' .
726 $encLabel . '</a>';
727 }
728
729 return self::link( $title, $encLabel, [], wfCgiToArray( $query ), [ 'known', 'noclasses' ] );
730 }
731
732 /**
733 * Get the URL to upload a certain file
734 *
735 * @since 1.16.3
736 * @param Title $destFile Title object of the file to upload
737 * @param string $query Urlencoded query string to prepend
738 * @return string Urlencoded URL
739 */
740 protected static function getUploadUrl( $destFile, $query = '' ) {
741 global $wgUploadMissingFileUrl, $wgUploadNavigationUrl;
742 $q = 'wpDestFile=' . $destFile->getPartialURL();
743 if ( $query != '' ) {
744 $q .= '&' . $query;
745 }
746
747 if ( $wgUploadMissingFileUrl ) {
748 return wfAppendQuery( $wgUploadMissingFileUrl, $q );
749 } elseif ( $wgUploadNavigationUrl ) {
750 return wfAppendQuery( $wgUploadNavigationUrl, $q );
751 } else {
752 $upload = SpecialPage::getTitleFor( 'Upload' );
753 return $upload->getLocalURL( $q );
754 }
755 }
756
757 /**
758 * Create a direct link to a given uploaded file.
759 *
760 * @since 1.16.3
761 * @param Title $title
762 * @param string $html Pre-sanitized HTML
763 * @param string $time MW timestamp of file creation time
764 * @return string HTML
765 */
766 public static function makeMediaLinkObj( $title, $html = '', $time = false ) {
767 $img = wfFindFile( $title, [ 'time' => $time ] );
768 return self::makeMediaLinkFile( $title, $img, $html );
769 }
770
771 /**
772 * Create a direct link to a given uploaded file.
773 * This will make a broken link if $file is false.
774 *
775 * @since 1.16.3
776 * @param Title $title
777 * @param File|bool $file File object or false
778 * @param string $html Pre-sanitized HTML
779 * @return string HTML
780 *
781 * @todo Handle invalid or missing images better.
782 */
783 public static function makeMediaLinkFile( Title $title, $file, $html = '' ) {
784 if ( $file && $file->exists() ) {
785 $url = $file->getUrl();
786 $class = 'internal';
787 } else {
788 $url = self::getUploadUrl( $title );
789 $class = 'new';
790 }
791
792 $alt = $title->getText();
793 if ( $html == '' ) {
794 $html = $alt;
795 }
796
797 $ret = '';
798 $attribs = [
799 'href' => $url,
800 'class' => $class,
801 'title' => $alt
802 ];
803
804 if ( !Hooks::run( 'LinkerMakeMediaLinkFile',
805 [ $title, $file, &$html, &$attribs, &$ret ] ) ) {
806 wfDebug( "Hook LinkerMakeMediaLinkFile changed the output of link "
807 . "with url {$url} and text {$html} to {$ret}\n", true );
808 return $ret;
809 }
810
811 return Html::rawElement( 'a', $attribs, $html );
812 }
813
814 /**
815 * Make a link to a special page given its name and, optionally,
816 * a message key from the link text.
817 * Usage example: Linker::specialLink( 'Recentchanges' )
818 *
819 * @since 1.16.3
820 * @param string $name
821 * @param string $key
822 * @return string
823 */
824 public static function specialLink( $name, $key = '' ) {
825 if ( $key == '' ) {
826 $key = strtolower( $name );
827 }
828
829 return self::linkKnown( SpecialPage::getTitleFor( $name ), wfMessage( $key )->text() );
830 }
831
832 /**
833 * Make an external link
834 * @since 1.16.3. $title added in 1.21
835 * @param string $url URL to link to
836 * @param string $text Text of link
837 * @param bool $escape Do we escape the link text?
838 * @param string $linktype Type of external link. Gets added to the classes
839 * @param array $attribs Array of extra attributes to <a>
840 * @param Title|null $title Title object used for title specific link attributes
841 * @return string
842 */
843 public static function makeExternalLink( $url, $text, $escape = true,
844 $linktype = '', $attribs = [], $title = null
845 ) {
846 global $wgTitle;
847 $class = "external";
848 if ( $linktype ) {
849 $class .= " $linktype";
850 }
851 if ( isset( $attribs['class'] ) && $attribs['class'] ) {
852 $class .= " {$attribs['class']}";
853 }
854 $attribs['class'] = $class;
855
856 if ( $escape ) {
857 $text = htmlspecialchars( $text );
858 }
859
860 if ( !$title ) {
861 $title = $wgTitle;
862 }
863 $newRel = Parser::getExternalLinkRel( $url, $title );
864 if ( !isset( $attribs['rel'] ) || $attribs['rel'] === '' ) {
865 $attribs['rel'] = $newRel;
866 } elseif ( $newRel !== '' ) {
867 // Merge the rel attributes.
868 $newRels = explode( ' ', $newRel );
869 $oldRels = explode( ' ', $attribs['rel'] );
870 $combined = array_unique( array_merge( $newRels, $oldRels ) );
871 $attribs['rel'] = implode( ' ', $combined );
872 }
873 $link = '';
874 $success = Hooks::run( 'LinkerMakeExternalLink',
875 [ &$url, &$text, &$link, &$attribs, $linktype ] );
876 if ( !$success ) {
877 wfDebug( "Hook LinkerMakeExternalLink changed the output of link "
878 . "with url {$url} and text {$text} to {$link}\n", true );
879 return $link;
880 }
881 $attribs['href'] = $url;
882 return Html::rawElement( 'a', $attribs, $text );
883 }
884
885 /**
886 * Make user link (or user contributions for unregistered users)
887 * @param int $userId User id in database.
888 * @param string $userName User name in database.
889 * @param string $altUserName Text to display instead of the user name (optional)
890 * @return string HTML fragment
891 * @since 1.16.3. $altUserName was added in 1.19.
892 */
893 public static function userLink( $userId, $userName, $altUserName = false ) {
894 $classes = 'mw-userlink';
895 $page = null;
896 if ( $userId == 0 ) {
897 $page = ExternalUserNames::getUserLinkTitle( $userName );
898
899 if ( ExternalUserNames::isExternal( $userName ) ) {
900 $classes .= ' mw-extuserlink';
901 } elseif ( $altUserName === false ) {
902 $altUserName = IP::prettifyIP( $userName );
903 }
904 $classes .= ' mw-anonuserlink'; // Separate link class for anons (T45179)
905 } else {
906 $page = Title::makeTitle( NS_USER, $userName );
907 }
908
909 // Wrap the output with <bdi> tags for directionality isolation
910 $linkText =
911 '<bdi>' . htmlspecialchars( $altUserName !== false ? $altUserName : $userName ) . '</bdi>';
912
913 return $page
914 ? self::link( $page, $linkText, [ 'class' => $classes ] )
915 : Html::rawElement( 'span', [ 'class' => $classes ], $linkText );
916 }
917
918 /**
919 * Generate standard user tool links (talk, contributions, block link, etc.)
920 *
921 * @since 1.16.3
922 * @param int $userId User identifier
923 * @param string $userText User name or IP address
924 * @param bool $redContribsWhenNoEdits Should the contributions link be
925 * red if the user has no edits?
926 * @param int $flags Customisation flags (e.g. Linker::TOOL_LINKS_NOBLOCK
927 * and Linker::TOOL_LINKS_EMAIL).
928 * @param int $edits User edit count (optional, for performance)
929 * @return string HTML fragment
930 */
931 public static function userToolLinks(
932 $userId, $userText, $redContribsWhenNoEdits = false, $flags = 0, $edits = null
933 ) {
934 global $wgUser, $wgDisableAnonTalk, $wgLang;
935 $talkable = !( $wgDisableAnonTalk && 0 == $userId );
936 $blockable = !( $flags & self::TOOL_LINKS_NOBLOCK );
937 $addEmailLink = $flags & self::TOOL_LINKS_EMAIL && $userId;
938
939 if ( $userId == 0 && ExternalUserNames::isExternal( $userText ) ) {
940 // No tools for an external user
941 return '';
942 }
943
944 $items = [];
945 if ( $talkable ) {
946 $items[] = self::userTalkLink( $userId, $userText );
947 }
948 if ( $userId ) {
949 // check if the user has an edit
950 $attribs = [];
951 $attribs['class'] = 'mw-usertoollinks-contribs';
952 if ( $redContribsWhenNoEdits ) {
953 if ( intval( $edits ) === 0 && $edits !== 0 ) {
954 $user = User::newFromId( $userId );
955 $edits = $user->getEditCount();
956 }
957 if ( $edits === 0 ) {
958 $attribs['class'] .= ' new';
959 }
960 }
961 $contribsPage = SpecialPage::getTitleFor( 'Contributions', $userText );
962
963 $items[] = self::link( $contribsPage, wfMessage( 'contribslink' )->escaped(), $attribs );
964 }
965 if ( $blockable && $wgUser->isAllowed( 'block' ) ) {
966 $items[] = self::blockLink( $userId, $userText );
967 }
968
969 if ( $addEmailLink && $wgUser->canSendEmail() ) {
970 $items[] = self::emailLink( $userId, $userText );
971 }
972
973 Hooks::run( 'UserToolLinksEdit', [ $userId, $userText, &$items ] );
974
975 if ( $items ) {
976 return wfMessage( 'word-separator' )->escaped()
977 . '<span class="mw-usertoollinks">'
978 . wfMessage( 'parentheses' )->rawParams( $wgLang->pipeList( $items ) )->escaped()
979 . '</span>';
980 } else {
981 return '';
982 }
983 }
984
985 /**
986 * Alias for userToolLinks( $userId, $userText, true );
987 * @since 1.16.3
988 * @param int $userId User identifier
989 * @param string $userText User name or IP address
990 * @param int $edits User edit count (optional, for performance)
991 * @return string
992 */
993 public static function userToolLinksRedContribs( $userId, $userText, $edits = null ) {
994 return self::userToolLinks( $userId, $userText, true, 0, $edits );
995 }
996
997 /**
998 * @since 1.16.3
999 * @param int $userId User id in database.
1000 * @param string $userText User name in database.
1001 * @return string HTML fragment with user talk link
1002 */
1003 public static function userTalkLink( $userId, $userText ) {
1004 $userTalkPage = Title::makeTitle( NS_USER_TALK, $userText );
1005 $moreLinkAttribs['class'] = 'mw-usertoollinks-talk';
1006 $userTalkLink = self::link( $userTalkPage,
1007 wfMessage( 'talkpagelinktext' )->escaped(),
1008 $moreLinkAttribs );
1009 return $userTalkLink;
1010 }
1011
1012 /**
1013 * @since 1.16.3
1014 * @param int $userId
1015 * @param string $userText User name in database.
1016 * @return string HTML fragment with block link
1017 */
1018 public static function blockLink( $userId, $userText ) {
1019 $blockPage = SpecialPage::getTitleFor( 'Block', $userText );
1020 $moreLinkAttribs['class'] = 'mw-usertoollinks-block';
1021 $blockLink = self::link( $blockPage,
1022 wfMessage( 'blocklink' )->escaped(),
1023 $moreLinkAttribs );
1024 return $blockLink;
1025 }
1026
1027 /**
1028 * @param int $userId
1029 * @param string $userText User name in database.
1030 * @return string HTML fragment with e-mail user link
1031 */
1032 public static function emailLink( $userId, $userText ) {
1033 $emailPage = SpecialPage::getTitleFor( 'Emailuser', $userText );
1034 $moreLinkAttribs['class'] = 'mw-usertoollinks-mail';
1035 $emailLink = self::link( $emailPage,
1036 wfMessage( 'emaillink' )->escaped(),
1037 $moreLinkAttribs );
1038 return $emailLink;
1039 }
1040
1041 /**
1042 * Generate a user link if the current user is allowed to view it
1043 * @since 1.16.3
1044 * @param Revision $rev
1045 * @param bool $isPublic Show only if all users can see it
1046 * @return string HTML fragment
1047 */
1048 public static function revUserLink( $rev, $isPublic = false ) {
1049 if ( $rev->isDeleted( Revision::DELETED_USER ) && $isPublic ) {
1050 $link = wfMessage( 'rev-deleted-user' )->escaped();
1051 } elseif ( $rev->userCan( Revision::DELETED_USER ) ) {
1052 $link = self::userLink( $rev->getUser( Revision::FOR_THIS_USER ),
1053 $rev->getUserText( Revision::FOR_THIS_USER ) );
1054 } else {
1055 $link = wfMessage( 'rev-deleted-user' )->escaped();
1056 }
1057 if ( $rev->isDeleted( Revision::DELETED_USER ) ) {
1058 return '<span class="history-deleted">' . $link . '</span>';
1059 }
1060 return $link;
1061 }
1062
1063 /**
1064 * Generate a user tool link cluster if the current user is allowed to view it
1065 * @since 1.16.3
1066 * @param Revision $rev
1067 * @param bool $isPublic Show only if all users can see it
1068 * @return string HTML
1069 */
1070 public static function revUserTools( $rev, $isPublic = false ) {
1071 if ( $rev->isDeleted( Revision::DELETED_USER ) && $isPublic ) {
1072 $link = wfMessage( 'rev-deleted-user' )->escaped();
1073 } elseif ( $rev->userCan( Revision::DELETED_USER ) ) {
1074 $userId = $rev->getUser( Revision::FOR_THIS_USER );
1075 $userText = $rev->getUserText( Revision::FOR_THIS_USER );
1076 $link = self::userLink( $userId, $userText )
1077 . self::userToolLinks( $userId, $userText );
1078 } else {
1079 $link = wfMessage( 'rev-deleted-user' )->escaped();
1080 }
1081 if ( $rev->isDeleted( Revision::DELETED_USER ) ) {
1082 return ' <span class="history-deleted">' . $link . '</span>';
1083 }
1084 return $link;
1085 }
1086
1087 /**
1088 * This function is called by all recent changes variants, by the page history,
1089 * and by the user contributions list. It is responsible for formatting edit
1090 * summaries. It escapes any HTML in the summary, but adds some CSS to format
1091 * auto-generated comments (from section editing) and formats [[wikilinks]].
1092 *
1093 * @author Erik Moeller <moeller@scireview.de>
1094 * @since 1.16.3. $wikiId added in 1.26
1095 *
1096 * Note: there's not always a title to pass to this function.
1097 * Since you can't set a default parameter for a reference, I've turned it
1098 * temporarily to a value pass. Should be adjusted further. --brion
1099 *
1100 * @param string $comment
1101 * @param Title|null $title Title object (to generate link to the section in autocomment)
1102 * or null
1103 * @param bool $local Whether section links should refer to local page
1104 * @param string|null $wikiId Id (as used by WikiMap) of the wiki to generate links to.
1105 * For use with external changes.
1106 *
1107 * @return mixed|string
1108 */
1109 public static function formatComment(
1110 $comment, $title = null, $local = false, $wikiId = null
1111 ) {
1112 # Sanitize text a bit:
1113 $comment = str_replace( "\n", " ", $comment );
1114 # Allow HTML entities (for T15815)
1115 $comment = Sanitizer::escapeHtmlAllowEntities( $comment );
1116
1117 # Render autocomments and make links:
1118 $comment = self::formatAutocomments( $comment, $title, $local, $wikiId );
1119 $comment = self::formatLinksInComment( $comment, $title, $local, $wikiId );
1120
1121 return $comment;
1122 }
1123
1124 /**
1125 * Converts autogenerated comments in edit summaries into section links.
1126 *
1127 * The pattern for autogen comments is / * foo * /, which makes for
1128 * some nasty regex.
1129 * We look for all comments, match any text before and after the comment,
1130 * add a separator where needed and format the comment itself with CSS
1131 * Called by Linker::formatComment.
1132 *
1133 * @param string $comment Comment text
1134 * @param Title|null $title An optional title object used to links to sections
1135 * @param bool $local Whether section links should refer to local page
1136 * @param string|null $wikiId Id of the wiki to link to (if not the local wiki),
1137 * as used by WikiMap.
1138 *
1139 * @return string Formatted comment (wikitext)
1140 */
1141 private static function formatAutocomments(
1142 $comment, $title = null, $local = false, $wikiId = null
1143 ) {
1144 // @todo $append here is something of a hack to preserve the status
1145 // quo. Someone who knows more about bidi and such should decide
1146 // (1) what sane rendering even *is* for an LTR edit summary on an RTL
1147 // wiki, both when autocomments exist and when they don't, and
1148 // (2) what markup will make that actually happen.
1149 $append = '';
1150 $comment = preg_replace_callback(
1151 // To detect the presence of content before or after the
1152 // auto-comment, we use capturing groups inside optional zero-width
1153 // assertions. But older versions of PCRE can't directly make
1154 // zero-width assertions optional, so wrap them in a non-capturing
1155 // group.
1156 '!(?:(?<=(.)))?/\*\s*(.*?)\s*\*/(?:(?=(.)))?!',
1157 function ( $match ) use ( $title, $local, $wikiId, &$append ) {
1158 global $wgLang;
1159
1160 // Ensure all match positions are defined
1161 $match += [ '', '', '', '' ];
1162
1163 $pre = $match[1] !== '';
1164 $auto = $match[2];
1165 $post = $match[3] !== '';
1166 $comment = null;
1167
1168 Hooks::run(
1169 'FormatAutocomments',
1170 [ &$comment, $pre, $auto, $post, $title, $local, $wikiId ]
1171 );
1172
1173 if ( $comment === null ) {
1174 $link = '';
1175 if ( $title ) {
1176 $section = $auto;
1177 # Remove links that a user may have manually put in the autosummary
1178 # This could be improved by copying as much of Parser::stripSectionName as desired.
1179 $section = str_replace( '[[:', '', $section );
1180 $section = str_replace( '[[', '', $section );
1181 $section = str_replace( ']]', '', $section );
1182
1183 $section = substr( Parser::guessSectionNameFromStrippedText( $section ), 1 );
1184 if ( $local ) {
1185 $sectionTitle = Title::makeTitleSafe( NS_MAIN, '', $section );
1186 } else {
1187 $sectionTitle = Title::makeTitleSafe( $title->getNamespace(),
1188 $title->getDBkey(), $section );
1189 }
1190 if ( $sectionTitle ) {
1191 $link = Linker::makeCommentLink( $sectionTitle, $wgLang->getArrow(), $wikiId, 'noclasses' );
1192 } else {
1193 $link = '';
1194 }
1195 }
1196 if ( $pre ) {
1197 # written summary $presep autocomment (summary /* section */)
1198 $pre = wfMessage( 'autocomment-prefix' )->inContentLanguage()->escaped();
1199 }
1200 if ( $post ) {
1201 # autocomment $postsep written summary (/* section */ summary)
1202 $auto .= wfMessage( 'colon-separator' )->inContentLanguage()->escaped();
1203 }
1204 $auto = '<span class="autocomment">' . $auto . '</span>';
1205 $comment = $pre . $link . $wgLang->getDirMark()
1206 . '<span dir="auto">' . $auto;
1207 $append .= '</span>';
1208 }
1209 return $comment;
1210 },
1211 $comment
1212 );
1213 return $comment . $append;
1214 }
1215
1216 /**
1217 * Formats wiki links and media links in text; all other wiki formatting
1218 * is ignored
1219 *
1220 * @since 1.16.3. $wikiId added in 1.26
1221 * @todo FIXME: Doesn't handle sub-links as in image thumb texts like the main parser
1222 *
1223 * @param string $comment Text to format links in. WARNING! Since the output of this
1224 * function is html, $comment must be sanitized for use as html. You probably want
1225 * to pass $comment through Sanitizer::escapeHtmlAllowEntities() before calling
1226 * this function.
1227 * @param Title|null $title An optional title object used to links to sections
1228 * @param bool $local Whether section links should refer to local page
1229 * @param string|null $wikiId Id of the wiki to link to (if not the local wiki),
1230 * as used by WikiMap.
1231 *
1232 * @return string
1233 */
1234 public static function formatLinksInComment(
1235 $comment, $title = null, $local = false, $wikiId = null
1236 ) {
1237 return preg_replace_callback(
1238 '/
1239 \[\[
1240 :? # ignore optional leading colon
1241 ([^\]|]+) # 1. link target; page names cannot include ] or |
1242 (?:\|
1243 # 2. link text
1244 # Stop matching at ]] without relying on backtracking.
1245 ((?:]?[^\]])*+)
1246 )?
1247 \]\]
1248 ([^[]*) # 3. link trail (the text up until the next link)
1249 /x',
1250 function ( $match ) use ( $title, $local, $wikiId ) {
1251 global $wgContLang;
1252
1253 $medians = '(?:' . preg_quote( MWNamespace::getCanonicalName( NS_MEDIA ), '/' ) . '|';
1254 $medians .= preg_quote( $wgContLang->getNsText( NS_MEDIA ), '/' ) . '):';
1255
1256 $comment = $match[0];
1257
1258 # fix up urlencoded title texts (copied from Parser::replaceInternalLinks)
1259 if ( strpos( $match[1], '%' ) !== false ) {
1260 $match[1] = strtr(
1261 rawurldecode( $match[1] ),
1262 [ '<' => '&lt;', '>' => '&gt;' ]
1263 );
1264 }
1265
1266 # Handle link renaming [[foo|text]] will show link as "text"
1267 if ( $match[2] != "" ) {
1268 $text = $match[2];
1269 } else {
1270 $text = $match[1];
1271 }
1272 $submatch = [];
1273 $thelink = null;
1274 if ( preg_match( '/^' . $medians . '(.*)$/i', $match[1], $submatch ) ) {
1275 # Media link; trail not supported.
1276 $linkRegexp = '/\[\[(.*?)\]\]/';
1277 $title = Title::makeTitleSafe( NS_FILE, $submatch[1] );
1278 if ( $title ) {
1279 $thelink = Linker::makeMediaLinkObj( $title, $text );
1280 }
1281 } else {
1282 # Other kind of link
1283 # Make sure its target is non-empty
1284 if ( isset( $match[1][0] ) && $match[1][0] == ':' ) {
1285 $match[1] = substr( $match[1], 1 );
1286 }
1287 if ( $match[1] !== false && $match[1] !== '' ) {
1288 if ( preg_match( $wgContLang->linkTrail(), $match[3], $submatch ) ) {
1289 $trail = $submatch[1];
1290 } else {
1291 $trail = "";
1292 }
1293 $linkRegexp = '/\[\[(.*?)\]\]' . preg_quote( $trail, '/' ) . '/';
1294 list( $inside, $trail ) = Linker::splitTrail( $trail );
1295
1296 $linkText = $text;
1297 $linkTarget = Linker::normalizeSubpageLink( $title, $match[1], $linkText );
1298
1299 $target = Title::newFromText( $linkTarget );
1300 if ( $target ) {
1301 if ( $target->getText() == '' && !$target->isExternal()
1302 && !$local && $title
1303 ) {
1304 $target = $title->createFragmentTarget( $target->getFragment() );
1305 }
1306
1307 $thelink = Linker::makeCommentLink( $target, $linkText . $inside, $wikiId ) . $trail;
1308 }
1309 }
1310 }
1311 if ( $thelink ) {
1312 // If the link is still valid, go ahead and replace it in!
1313 $comment = preg_replace(
1314 $linkRegexp,
1315 StringUtils::escapeRegexReplacement( $thelink ),
1316 $comment,
1317 1
1318 );
1319 }
1320
1321 return $comment;
1322 },
1323 $comment
1324 );
1325 }
1326
1327 /**
1328 * Generates a link to the given Title
1329 *
1330 * @note This is only public for technical reasons. It's not intended for use outside Linker.
1331 *
1332 * @param LinkTarget $linkTarget
1333 * @param string $text
1334 * @param string|null $wikiId Id of the wiki to link to (if not the local wiki),
1335 * as used by WikiMap.
1336 * @param string|string[] $options See the $options parameter in Linker::link.
1337 *
1338 * @return string HTML link
1339 */
1340 public static function makeCommentLink(
1341 LinkTarget $linkTarget, $text, $wikiId = null, $options = []
1342 ) {
1343 if ( $wikiId !== null && !$linkTarget->isExternal() ) {
1344 $link = self::makeExternalLink(
1345 WikiMap::getForeignURL(
1346 $wikiId,
1347 $linkTarget->getNamespace() === 0
1348 ? $linkTarget->getDBkey()
1349 : MWNamespace::getCanonicalName( $linkTarget->getNamespace() ) . ':'
1350 . $linkTarget->getDBkey(),
1351 $linkTarget->getFragment()
1352 ),
1353 $text,
1354 /* escape = */ false // Already escaped
1355 );
1356 } else {
1357 $link = self::link( $linkTarget, $text, [], [], $options );
1358 }
1359
1360 return $link;
1361 }
1362
1363 /**
1364 * @param Title $contextTitle
1365 * @param string $target
1366 * @param string &$text
1367 * @return string
1368 */
1369 public static function normalizeSubpageLink( $contextTitle, $target, &$text ) {
1370 # Valid link forms:
1371 # Foobar -- normal
1372 # :Foobar -- override special treatment of prefix (images, language links)
1373 # /Foobar -- convert to CurrentPage/Foobar
1374 # /Foobar/ -- convert to CurrentPage/Foobar, strip the initial and final / from text
1375 # ../ -- convert to CurrentPage, from CurrentPage/CurrentSubPage
1376 # ../Foobar -- convert to CurrentPage/Foobar,
1377 # (from CurrentPage/CurrentSubPage)
1378 # ../Foobar/ -- convert to CurrentPage/Foobar, use 'Foobar' as text
1379 # (from CurrentPage/CurrentSubPage)
1380
1381 $ret = $target; # default return value is no change
1382
1383 # Some namespaces don't allow subpages,
1384 # so only perform processing if subpages are allowed
1385 if ( $contextTitle && MWNamespace::hasSubpages( $contextTitle->getNamespace() ) ) {
1386 $hash = strpos( $target, '#' );
1387 if ( $hash !== false ) {
1388 $suffix = substr( $target, $hash );
1389 $target = substr( $target, 0, $hash );
1390 } else {
1391 $suffix = '';
1392 }
1393 # T9425
1394 $target = trim( $target );
1395 # Look at the first character
1396 if ( $target != '' && $target[0] === '/' ) {
1397 # / at end means we don't want the slash to be shown
1398 $m = [];
1399 $trailingSlashes = preg_match_all( '%(/+)$%', $target, $m );
1400 if ( $trailingSlashes ) {
1401 $noslash = $target = substr( $target, 1, -strlen( $m[0][0] ) );
1402 } else {
1403 $noslash = substr( $target, 1 );
1404 }
1405
1406 $ret = $contextTitle->getPrefixedText() . '/' . trim( $noslash ) . $suffix;
1407 if ( $text === '' ) {
1408 $text = $target . $suffix;
1409 } # this might be changed for ugliness reasons
1410 } else {
1411 # check for .. subpage backlinks
1412 $dotdotcount = 0;
1413 $nodotdot = $target;
1414 while ( strncmp( $nodotdot, "../", 3 ) == 0 ) {
1415 ++$dotdotcount;
1416 $nodotdot = substr( $nodotdot, 3 );
1417 }
1418 if ( $dotdotcount > 0 ) {
1419 $exploded = explode( '/', $contextTitle->getPrefixedText() );
1420 if ( count( $exploded ) > $dotdotcount ) { # not allowed to go below top level page
1421 $ret = implode( '/', array_slice( $exploded, 0, -$dotdotcount ) );
1422 # / at the end means don't show full path
1423 if ( substr( $nodotdot, -1, 1 ) === '/' ) {
1424 $nodotdot = rtrim( $nodotdot, '/' );
1425 if ( $text === '' ) {
1426 $text = $nodotdot . $suffix;
1427 }
1428 }
1429 $nodotdot = trim( $nodotdot );
1430 if ( $nodotdot != '' ) {
1431 $ret .= '/' . $nodotdot;
1432 }
1433 $ret .= $suffix;
1434 }
1435 }
1436 }
1437 }
1438
1439 return $ret;
1440 }
1441
1442 /**
1443 * Wrap a comment in standard punctuation and formatting if
1444 * it's non-empty, otherwise return empty string.
1445 *
1446 * @since 1.16.3. $wikiId added in 1.26
1447 * @param string $comment
1448 * @param Title|null $title Title object (to generate link to section in autocomment) or null
1449 * @param bool $local Whether section links should refer to local page
1450 * @param string|null $wikiId Id (as used by WikiMap) of the wiki to generate links to.
1451 * For use with external changes.
1452 *
1453 * @return string
1454 */
1455 public static function commentBlock(
1456 $comment, $title = null, $local = false, $wikiId = null
1457 ) {
1458 // '*' used to be the comment inserted by the software way back
1459 // in antiquity in case none was provided, here for backwards
1460 // compatibility, acc. to brion -ævar
1461 if ( $comment == '' || $comment == '*' ) {
1462 return '';
1463 } else {
1464 $formatted = self::formatComment( $comment, $title, $local, $wikiId );
1465 $formatted = wfMessage( 'parentheses' )->rawParams( $formatted )->escaped();
1466 return " <span class=\"comment\">$formatted</span>";
1467 }
1468 }
1469
1470 /**
1471 * Wrap and format the given revision's comment block, if the current
1472 * user is allowed to view it.
1473 *
1474 * @since 1.16.3
1475 * @param Revision $rev
1476 * @param bool $local Whether section links should refer to local page
1477 * @param bool $isPublic Show only if all users can see it
1478 * @return string HTML fragment
1479 */
1480 public static function revComment( Revision $rev, $local = false, $isPublic = false ) {
1481 if ( $rev->getComment( Revision::RAW ) == "" ) {
1482 return "";
1483 }
1484 if ( $rev->isDeleted( Revision::DELETED_COMMENT ) && $isPublic ) {
1485 $block = " <span class=\"comment\">" . wfMessage( 'rev-deleted-comment' )->escaped() . "</span>";
1486 } elseif ( $rev->userCan( Revision::DELETED_COMMENT ) ) {
1487 $block = self::commentBlock( $rev->getComment( Revision::FOR_THIS_USER ),
1488 $rev->getTitle(), $local );
1489 } else {
1490 $block = " <span class=\"comment\">" . wfMessage( 'rev-deleted-comment' )->escaped() . "</span>";
1491 }
1492 if ( $rev->isDeleted( Revision::DELETED_COMMENT ) ) {
1493 return " <span class=\"history-deleted\">$block</span>";
1494 }
1495 return $block;
1496 }
1497
1498 /**
1499 * @since 1.16.3
1500 * @param int $size
1501 * @return string
1502 */
1503 public static function formatRevisionSize( $size ) {
1504 if ( $size == 0 ) {
1505 $stxt = wfMessage( 'historyempty' )->escaped();
1506 } else {
1507 $stxt = wfMessage( 'nbytes' )->numParams( $size )->escaped();
1508 $stxt = wfMessage( 'parentheses' )->rawParams( $stxt )->escaped();
1509 }
1510 return "<span class=\"history-size\">$stxt</span>";
1511 }
1512
1513 /**
1514 * Add another level to the Table of Contents
1515 *
1516 * @since 1.16.3
1517 * @return string
1518 */
1519 public static function tocIndent() {
1520 return "\n<ul>";
1521 }
1522
1523 /**
1524 * Finish one or more sublevels on the Table of Contents
1525 *
1526 * @since 1.16.3
1527 * @param int $level
1528 * @return string
1529 */
1530 public static function tocUnindent( $level ) {
1531 return "</li>\n" . str_repeat( "</ul>\n</li>\n", $level > 0 ? $level : 0 );
1532 }
1533
1534 /**
1535 * parameter level defines if we are on an indentation level
1536 *
1537 * @since 1.16.3
1538 * @param string $anchor
1539 * @param string $tocline
1540 * @param string $tocnumber
1541 * @param string $level
1542 * @param string|bool $sectionIndex
1543 * @return string
1544 */
1545 public static function tocLine( $anchor, $tocline, $tocnumber, $level, $sectionIndex = false ) {
1546 $classes = "toclevel-$level";
1547 if ( $sectionIndex !== false ) {
1548 $classes .= " tocsection-$sectionIndex";
1549 }
1550
1551 // \n<li class="$classes"><a href="#$anchor"><span class="tocnumber">
1552 // $tocnumber</span> <span class="toctext">$tocline</span></a>
1553 return "\n" . Html::openElement( 'li', [ 'class' => $classes ] )
1554 . Html::rawElement( 'a',
1555 [ 'href' => "#$anchor" ],
1556 Html::element( 'span', [ 'class' => 'tocnumber' ], $tocnumber )
1557 . ' '
1558 . Html::rawElement( 'span', [ 'class' => 'toctext' ], $tocline )
1559 );
1560 }
1561
1562 /**
1563 * End a Table Of Contents line.
1564 * tocUnindent() will be used instead if we're ending a line below
1565 * the new level.
1566 * @since 1.16.3
1567 * @return string
1568 */
1569 public static function tocLineEnd() {
1570 return "</li>\n";
1571 }
1572
1573 /**
1574 * Wraps the TOC in a table and provides the hide/collapse javascript.
1575 *
1576 * @since 1.16.3
1577 * @param string $toc Html of the Table Of Contents
1578 * @param string|Language|bool $lang Language for the toc title, defaults to user language
1579 * @return string Full html of the TOC
1580 */
1581 public static function tocList( $toc, $lang = false ) {
1582 $lang = wfGetLangObj( $lang );
1583 $title = wfMessage( 'toc' )->inLanguage( $lang )->escaped();
1584
1585 return '<div id="toc" class="toc">'
1586 . Html::openElement( 'div', [
1587 'class' => 'toctitle',
1588 'lang' => $lang->getHtmlCode(),
1589 'dir' => $lang->getDir(),
1590 ] )
1591 . '<h2>' . $title . "</h2></div>\n"
1592 . $toc
1593 . "</ul>\n</div>\n";
1594 }
1595
1596 /**
1597 * Generate a table of contents from a section tree.
1598 *
1599 * @since 1.16.3. $lang added in 1.17
1600 * @param array $tree Return value of ParserOutput::getSections()
1601 * @param string|Language|bool $lang Language for the toc title, defaults to user language
1602 * @return string HTML fragment
1603 */
1604 public static function generateTOC( $tree, $lang = false ) {
1605 $toc = '';
1606 $lastLevel = 0;
1607 foreach ( $tree as $section ) {
1608 if ( $section['toclevel'] > $lastLevel ) {
1609 $toc .= self::tocIndent();
1610 } elseif ( $section['toclevel'] < $lastLevel ) {
1611 $toc .= self::tocUnindent(
1612 $lastLevel - $section['toclevel'] );
1613 } else {
1614 $toc .= self::tocLineEnd();
1615 }
1616
1617 $toc .= self::tocLine( $section['anchor'],
1618 $section['line'], $section['number'],
1619 $section['toclevel'], $section['index'] );
1620 $lastLevel = $section['toclevel'];
1621 }
1622 $toc .= self::tocLineEnd();
1623 return self::tocList( $toc, $lang );
1624 }
1625
1626 /**
1627 * Create a headline for content
1628 *
1629 * @since 1.16.3
1630 * @param int $level The level of the headline (1-6)
1631 * @param string $attribs Any attributes for the headline, starting with
1632 * a space and ending with '>'
1633 * This *must* be at least '>' for no attribs
1634 * @param string $anchor The anchor to give the headline (the bit after the #)
1635 * @param string $html HTML for the text of the header
1636 * @param string $link HTML to add for the section edit link
1637 * @param string|bool $fallbackAnchor A second, optional anchor to give for
1638 * backward compatibility (false to omit)
1639 *
1640 * @return string HTML headline
1641 */
1642 public static function makeHeadline( $level, $attribs, $anchor, $html,
1643 $link, $fallbackAnchor = false
1644 ) {
1645 $anchorEscaped = htmlspecialchars( $anchor );
1646 $fallback = '';
1647 if ( $fallbackAnchor !== false && $fallbackAnchor !== $anchor ) {
1648 $fallbackAnchor = htmlspecialchars( $fallbackAnchor );
1649 $fallback = "<span id=\"$fallbackAnchor\"></span>";
1650 }
1651 $ret = "<h$level$attribs"
1652 . "$fallback<span class=\"mw-headline\" id=\"$anchorEscaped\">$html</span>"
1653 . $link
1654 . "</h$level>";
1655
1656 return $ret;
1657 }
1658
1659 /**
1660 * Split a link trail, return the "inside" portion and the remainder of the trail
1661 * as a two-element array
1662 * @param string $trail
1663 * @return array
1664 */
1665 static function splitTrail( $trail ) {
1666 global $wgContLang;
1667 $regex = $wgContLang->linkTrail();
1668 $inside = '';
1669 if ( $trail !== '' ) {
1670 $m = [];
1671 if ( preg_match( $regex, $trail, $m ) ) {
1672 $inside = $m[1];
1673 $trail = $m[2];
1674 }
1675 }
1676 return [ $inside, $trail ];
1677 }
1678
1679 /**
1680 * Generate a rollback link for a given revision. Currently it's the
1681 * caller's responsibility to ensure that the revision is the top one. If
1682 * it's not, of course, the user will get an error message.
1683 *
1684 * If the calling page is called with the parameter &bot=1, all rollback
1685 * links also get that parameter. It causes the edit itself and the rollback
1686 * to be marked as "bot" edits. Bot edits are hidden by default from recent
1687 * changes, so this allows sysops to combat a busy vandal without bothering
1688 * other users.
1689 *
1690 * If the option verify is set this function will return the link only in case the
1691 * revision can be reverted. Please note that due to performance limitations
1692 * it might be assumed that a user isn't the only contributor of a page while
1693 * (s)he is, which will lead to useless rollback links. Furthermore this wont
1694 * work if $wgShowRollbackEditCount is disabled, so this can only function
1695 * as an additional check.
1696 *
1697 * If the option noBrackets is set the rollback link wont be enclosed in "[]".
1698 *
1699 * @since 1.16.3. $context added in 1.20. $options added in 1.21
1700 *
1701 * @param Revision $rev
1702 * @param IContextSource $context Context to use or null for the main context.
1703 * @param array $options
1704 * @return string
1705 */
1706 public static function generateRollback( $rev, IContextSource $context = null,
1707 $options = [ 'verify' ]
1708 ) {
1709 if ( $context === null ) {
1710 $context = RequestContext::getMain();
1711 }
1712
1713 $editCount = false;
1714 if ( in_array( 'verify', $options, true ) ) {
1715 $editCount = self::getRollbackEditCount( $rev, true );
1716 if ( $editCount === false ) {
1717 return '';
1718 }
1719 }
1720
1721 $inner = self::buildRollbackLink( $rev, $context, $editCount );
1722
1723 if ( !in_array( 'noBrackets', $options, true ) ) {
1724 $inner = $context->msg( 'brackets' )->rawParams( $inner )->escaped();
1725 }
1726
1727 return '<span class="mw-rollback-link">' . $inner . '</span>';
1728 }
1729
1730 /**
1731 * This function will return the number of revisions which a rollback
1732 * would revert and, if $verify is set it will verify that a revision
1733 * can be reverted (that the user isn't the only contributor and the
1734 * revision we might rollback to isn't deleted). These checks can only
1735 * function as an additional check as this function only checks against
1736 * the last $wgShowRollbackEditCount edits.
1737 *
1738 * Returns null if $wgShowRollbackEditCount is disabled or false if $verify
1739 * is set and the user is the only contributor of the page.
1740 *
1741 * @param Revision $rev
1742 * @param bool $verify Try to verify that this revision can really be rolled back
1743 * @return int|bool|null
1744 */
1745 public static function getRollbackEditCount( $rev, $verify ) {
1746 global $wgShowRollbackEditCount;
1747 if ( !is_int( $wgShowRollbackEditCount ) || !$wgShowRollbackEditCount > 0 ) {
1748 // Nothing has happened, indicate this by returning 'null'
1749 return null;
1750 }
1751
1752 $dbr = wfGetDB( DB_REPLICA );
1753
1754 // Up to the value of $wgShowRollbackEditCount revisions are counted
1755 $revQuery = Revision::getQueryInfo();
1756 $res = $dbr->select(
1757 $revQuery['tables'],
1758 [ 'rev_user_text' => $revQuery['fields']['rev_user_text'], 'rev_deleted' ],
1759 // $rev->getPage() returns null sometimes
1760 [ 'rev_page' => $rev->getTitle()->getArticleID() ],
1761 __METHOD__,
1762 [
1763 'USE INDEX' => [ 'revision' => 'page_timestamp' ],
1764 'ORDER BY' => 'rev_timestamp DESC',
1765 'LIMIT' => $wgShowRollbackEditCount + 1
1766 ],
1767 $revQuery['joins']
1768 );
1769
1770 $editCount = 0;
1771 $moreRevs = false;
1772 foreach ( $res as $row ) {
1773 if ( $rev->getUserText( Revision::RAW ) != $row->rev_user_text ) {
1774 if ( $verify &&
1775 ( $row->rev_deleted & Revision::DELETED_TEXT
1776 || $row->rev_deleted & Revision::DELETED_USER
1777 ) ) {
1778 // If the user or the text of the revision we might rollback
1779 // to is deleted in some way we can't rollback. Similar to
1780 // the sanity checks in WikiPage::commitRollback.
1781 return false;
1782 }
1783 $moreRevs = true;
1784 break;
1785 }
1786 $editCount++;
1787 }
1788
1789 if ( $verify && $editCount <= $wgShowRollbackEditCount && !$moreRevs ) {
1790 // We didn't find at least $wgShowRollbackEditCount revisions made by the current user
1791 // and there weren't any other revisions. That means that the current user is the only
1792 // editor, so we can't rollback
1793 return false;
1794 }
1795 return $editCount;
1796 }
1797
1798 /**
1799 * Build a raw rollback link, useful for collections of "tool" links
1800 *
1801 * @since 1.16.3. $context added in 1.20. $editCount added in 1.21
1802 * @param Revision $rev
1803 * @param IContextSource|null $context Context to use or null for the main context.
1804 * @param int $editCount Number of edits that would be reverted
1805 * @return string HTML fragment
1806 */
1807 public static function buildRollbackLink( $rev, IContextSource $context = null,
1808 $editCount = false
1809 ) {
1810 global $wgShowRollbackEditCount, $wgMiserMode;
1811
1812 // To config which pages are affected by miser mode
1813 $disableRollbackEditCountSpecialPage = [ 'Recentchanges', 'Watchlist' ];
1814
1815 if ( $context === null ) {
1816 $context = RequestContext::getMain();
1817 }
1818
1819 $title = $rev->getTitle();
1820 $query = [
1821 'action' => 'rollback',
1822 'from' => $rev->getUserText(),
1823 'token' => $context->getUser()->getEditToken( 'rollback' ),
1824 ];
1825 $attrs = [
1826 'data-mw' => 'interface',
1827 'title' => $context->msg( 'tooltip-rollback' )->text(),
1828 ];
1829 $options = [ 'known', 'noclasses' ];
1830
1831 if ( $context->getRequest()->getBool( 'bot' ) ) {
1832 $query['bot'] = '1';
1833 $query['hidediff'] = '1'; // T17999
1834 }
1835
1836 $disableRollbackEditCount = false;
1837 if ( $wgMiserMode ) {
1838 foreach ( $disableRollbackEditCountSpecialPage as $specialPage ) {
1839 if ( $context->getTitle()->isSpecial( $specialPage ) ) {
1840 $disableRollbackEditCount = true;
1841 break;
1842 }
1843 }
1844 }
1845
1846 if ( !$disableRollbackEditCount
1847 && is_int( $wgShowRollbackEditCount )
1848 && $wgShowRollbackEditCount > 0
1849 ) {
1850 if ( !is_numeric( $editCount ) ) {
1851 $editCount = self::getRollbackEditCount( $rev, false );
1852 }
1853
1854 if ( $editCount > $wgShowRollbackEditCount ) {
1855 $html = $context->msg( 'rollbacklinkcount-morethan' )
1856 ->numParams( $wgShowRollbackEditCount )->parse();
1857 } else {
1858 $html = $context->msg( 'rollbacklinkcount' )->numParams( $editCount )->parse();
1859 }
1860
1861 return self::link( $title, $html, $attrs, $query, $options );
1862 } else {
1863 $html = $context->msg( 'rollbacklink' )->escaped();
1864 return self::link( $title, $html, $attrs, $query, $options );
1865 }
1866 }
1867
1868 /**
1869 * @deprecated since 1.28, use TemplatesOnThisPageFormatter directly
1870 *
1871 * Returns HTML for the "templates used on this page" list.
1872 *
1873 * Make an HTML list of templates, and then add a "More..." link at
1874 * the bottom. If $more is null, do not add a "More..." link. If $more
1875 * is a Title, make a link to that title and use it. If $more is a string,
1876 * directly paste it in as the link (escaping needs to be done manually).
1877 * Finally, if $more is a Message, call toString().
1878 *
1879 * @since 1.16.3. $more added in 1.21
1880 * @param Title[] $templates Array of templates
1881 * @param bool $preview Whether this is for a preview
1882 * @param bool $section Whether this is for a section edit
1883 * @param Title|Message|string|null $more An escaped link for "More..." of the templates
1884 * @return string HTML output
1885 */
1886 public static function formatTemplates( $templates, $preview = false,
1887 $section = false, $more = null
1888 ) {
1889 wfDeprecated( __METHOD__, '1.28' );
1890
1891 $type = false;
1892 if ( $preview ) {
1893 $type = 'preview';
1894 } elseif ( $section ) {
1895 $type = 'section';
1896 }
1897
1898 if ( $more instanceof Message ) {
1899 $more = $more->toString();
1900 }
1901
1902 $formatter = new TemplatesOnThisPageFormatter(
1903 RequestContext::getMain(),
1904 MediaWikiServices::getInstance()->getLinkRenderer()
1905 );
1906 return $formatter->format( $templates, $type, $more );
1907 }
1908
1909 /**
1910 * Returns HTML for the "hidden categories on this page" list.
1911 *
1912 * @since 1.16.3
1913 * @param array $hiddencats Array of hidden categories from Article::getHiddenCategories
1914 * or similar
1915 * @return string HTML output
1916 */
1917 public static function formatHiddenCategories( $hiddencats ) {
1918 $outText = '';
1919 if ( count( $hiddencats ) > 0 ) {
1920 # Construct the HTML
1921 $outText = '<div class="mw-hiddenCategoriesExplanation">';
1922 $outText .= wfMessage( 'hiddencategories' )->numParams( count( $hiddencats ) )->parseAsBlock();
1923 $outText .= "</div><ul>\n";
1924
1925 foreach ( $hiddencats as $titleObj ) {
1926 # If it's hidden, it must exist - no need to check with a LinkBatch
1927 $outText .= '<li>'
1928 . self::link( $titleObj, null, [], [], 'known' )
1929 . "</li>\n";
1930 }
1931 $outText .= '</ul>';
1932 }
1933 return $outText;
1934 }
1935
1936 /**
1937 * @deprecated since 1.28, use Language::formatSize() directly
1938 *
1939 * Format a size in bytes for output, using an appropriate
1940 * unit (B, KB, MB or GB) according to the magnitude in question
1941 *
1942 * @since 1.16.3
1943 * @param int $size Size to format
1944 * @return string
1945 */
1946 public static function formatSize( $size ) {
1947 wfDeprecated( __METHOD__, '1.28' );
1948
1949 global $wgLang;
1950 return htmlspecialchars( $wgLang->formatSize( $size ) );
1951 }
1952
1953 /**
1954 * Given the id of an interface element, constructs the appropriate title
1955 * attribute from the system messages. (Note, this is usually the id but
1956 * isn't always, because sometimes the accesskey needs to go on a different
1957 * element than the id, for reverse-compatibility, etc.)
1958 *
1959 * @since 1.16.3 $msgParams added in 1.27
1960 * @param string $name Id of the element, minus prefixes.
1961 * @param string|array|null $options Null, string or array with some of the following options:
1962 * - 'withaccess' to add an access-key hint
1963 * - 'nonexisting' to add an accessibility hint that page does not exist
1964 * @param array $msgParams Parameters to pass to the message
1965 *
1966 * @return string Contents of the title attribute (which you must HTML-
1967 * escape), or false for no title attribute
1968 */
1969 public static function titleAttrib( $name, $options = null, array $msgParams = [] ) {
1970 $message = wfMessage( "tooltip-$name", $msgParams );
1971 if ( !$message->exists() ) {
1972 $tooltip = false;
1973 } else {
1974 $tooltip = $message->text();
1975 # Compatibility: formerly some tooltips had [alt-.] hardcoded
1976 $tooltip = preg_replace( "/ ?\[alt-.\]$/", '', $tooltip );
1977 # Message equal to '-' means suppress it.
1978 if ( $tooltip == '-' ) {
1979 $tooltip = false;
1980 }
1981 }
1982
1983 $options = (array)$options;
1984
1985 if ( in_array( 'nonexisting', $options ) ) {
1986 $tooltip = wfMessage( 'red-link-title', $tooltip ?: '' )->text();
1987 }
1988 if ( in_array( 'withaccess', $options ) ) {
1989 $accesskey = self::accesskey( $name );
1990 if ( $accesskey !== false ) {
1991 // Should be build the same as in jquery.accessKeyLabel.js
1992 if ( $tooltip === false || $tooltip === '' ) {
1993 $tooltip = wfMessage( 'brackets', $accesskey )->text();
1994 } else {
1995 $tooltip .= wfMessage( 'word-separator' )->text();
1996 $tooltip .= wfMessage( 'brackets', $accesskey )->text();
1997 }
1998 }
1999 }
2000
2001 return $tooltip;
2002 }
2003
2004 public static $accesskeycache;
2005
2006 /**
2007 * Given the id of an interface element, constructs the appropriate
2008 * accesskey attribute from the system messages. (Note, this is usually
2009 * the id but isn't always, because sometimes the accesskey needs to go on
2010 * a different element than the id, for reverse-compatibility, etc.)
2011 *
2012 * @since 1.16.3
2013 * @param string $name Id of the element, minus prefixes.
2014 * @return string Contents of the accesskey attribute (which you must HTML-
2015 * escape), or false for no accesskey attribute
2016 */
2017 public static function accesskey( $name ) {
2018 if ( isset( self::$accesskeycache[$name] ) ) {
2019 return self::$accesskeycache[$name];
2020 }
2021
2022 $message = wfMessage( "accesskey-$name" );
2023
2024 if ( !$message->exists() ) {
2025 $accesskey = false;
2026 } else {
2027 $accesskey = $message->plain();
2028 if ( $accesskey === '' || $accesskey === '-' ) {
2029 # @todo FIXME: Per standard MW behavior, a value of '-' means to suppress the
2030 # attribute, but this is broken for accesskey: that might be a useful
2031 # value.
2032 $accesskey = false;
2033 }
2034 }
2035
2036 self::$accesskeycache[$name] = $accesskey;
2037 return self::$accesskeycache[$name];
2038 }
2039
2040 /**
2041 * Get a revision-deletion link, or disabled link, or nothing, depending
2042 * on user permissions & the settings on the revision.
2043 *
2044 * Will use forward-compatible revision ID in the Special:RevDelete link
2045 * if possible, otherwise the timestamp-based ID which may break after
2046 * undeletion.
2047 *
2048 * @param User $user
2049 * @param Revision $rev
2050 * @param Title $title
2051 * @return string HTML fragment
2052 */
2053 public static function getRevDeleteLink( User $user, Revision $rev, Title $title ) {
2054 $canHide = $user->isAllowed( 'deleterevision' );
2055 if ( !$canHide && !( $rev->getVisibility() && $user->isAllowed( 'deletedhistory' ) ) ) {
2056 return '';
2057 }
2058
2059 if ( !$rev->userCan( Revision::DELETED_RESTRICTED, $user ) ) {
2060 return self::revDeleteLinkDisabled( $canHide ); // revision was hidden from sysops
2061 } else {
2062 if ( $rev->getId() ) {
2063 // RevDelete links using revision ID are stable across
2064 // page deletion and undeletion; use when possible.
2065 $query = [
2066 'type' => 'revision',
2067 'target' => $title->getPrefixedDBkey(),
2068 'ids' => $rev->getId()
2069 ];
2070 } else {
2071 // Older deleted entries didn't save a revision ID.
2072 // We have to refer to these by timestamp, ick!
2073 $query = [
2074 'type' => 'archive',
2075 'target' => $title->getPrefixedDBkey(),
2076 'ids' => $rev->getTimestamp()
2077 ];
2078 }
2079 return self::revDeleteLink( $query,
2080 $rev->isDeleted( Revision::DELETED_RESTRICTED ), $canHide );
2081 }
2082 }
2083
2084 /**
2085 * Creates a (show/hide) link for deleting revisions/log entries
2086 *
2087 * @param array $query Query parameters to be passed to link()
2088 * @param bool $restricted Set to true to use a "<strong>" instead of a "<span>"
2089 * @param bool $delete Set to true to use (show/hide) rather than (show)
2090 *
2091 * @return string HTML "<a>" link to Special:Revisiondelete, wrapped in a
2092 * span to allow for customization of appearance with CSS
2093 */
2094 public static function revDeleteLink( $query = [], $restricted = false, $delete = true ) {
2095 $sp = SpecialPage::getTitleFor( 'Revisiondelete' );
2096 $msgKey = $delete ? 'rev-delundel' : 'rev-showdeleted';
2097 $html = wfMessage( $msgKey )->escaped();
2098 $tag = $restricted ? 'strong' : 'span';
2099 $link = self::link( $sp, $html, [], $query, [ 'known', 'noclasses' ] );
2100 return Xml::tags(
2101 $tag,
2102 [ 'class' => 'mw-revdelundel-link' ],
2103 wfMessage( 'parentheses' )->rawParams( $link )->escaped()
2104 );
2105 }
2106
2107 /**
2108 * Creates a dead (show/hide) link for deleting revisions/log entries
2109 *
2110 * @since 1.16.3
2111 * @param bool $delete Set to true to use (show/hide) rather than (show)
2112 *
2113 * @return string HTML text wrapped in a span to allow for customization
2114 * of appearance with CSS
2115 */
2116 public static function revDeleteLinkDisabled( $delete = true ) {
2117 $msgKey = $delete ? 'rev-delundel' : 'rev-showdeleted';
2118 $html = wfMessage( $msgKey )->escaped();
2119 $htmlParentheses = wfMessage( 'parentheses' )->rawParams( $html )->escaped();
2120 return Xml::tags( 'span', [ 'class' => 'mw-revdelundel-link' ], $htmlParentheses );
2121 }
2122
2123 /**
2124 * Returns the attributes for the tooltip and access key.
2125 *
2126 * @since 1.16.3. $msgParams introduced in 1.27
2127 * @param string $name
2128 * @param array $msgParams Params for constructing the message
2129 * @param string|array|null $options Options to be passed to titleAttrib.
2130 *
2131 * @see Linker::titleAttrib for what options could be passed to $options.
2132 *
2133 * @return array
2134 */
2135 public static function tooltipAndAccesskeyAttribs(
2136 $name,
2137 array $msgParams = [],
2138 $options = null
2139 ) {
2140 $options = (array)$options;
2141 $options[] = 'withaccess';
2142
2143 $attribs = [
2144 'title' => self::titleAttrib( $name, $options, $msgParams ),
2145 'accesskey' => self::accesskey( $name )
2146 ];
2147 if ( $attribs['title'] === false ) {
2148 unset( $attribs['title'] );
2149 }
2150 if ( $attribs['accesskey'] === false ) {
2151 unset( $attribs['accesskey'] );
2152 }
2153 return $attribs;
2154 }
2155
2156 /**
2157 * Returns raw bits of HTML, use titleAttrib()
2158 * @since 1.16.3
2159 * @param string $name
2160 * @param array|null $options
2161 * @return null|string
2162 */
2163 public static function tooltip( $name, $options = null ) {
2164 $tooltip = self::titleAttrib( $name, $options );
2165 if ( $tooltip === false ) {
2166 return '';
2167 }
2168 return Xml::expandAttributes( [
2169 'title' => $tooltip
2170 ] );
2171 }
2172
2173 }