3 * Methods to make links and related items.
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.
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.
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
22 use MediaWiki\Linker\LinkTarget
;
23 use MediaWiki\MediaWikiServices
;
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.
30 * @todo turn this into a legacy interface for HtmlPageLinkRenderer and similar services.
36 * Flags for userToolLinks()
38 const TOOL_LINKS_NOBLOCK
= 1;
39 const TOOL_LINKS_EMAIL
= 2;
42 * This function returns an HTML link to the given target. It serves a few
44 * 1) If $target is a Title, the correct URL to link to will be figured
46 * 2) It automatically adds the usual classes for various types of link
47 * targets: "new" for red links, "stub" for short articles, etc.
48 * 3) It escapes all attribute values safely so there's no risk of XSS.
49 * 4) It provides a default tooltip if the target is a Title (the page
50 * name of the target).
51 * link() replaces the old functions in the makeLink() family.
53 * @since 1.18 Method exists since 1.16 as non-static, made static in 1.18.
54 * @deprecated since 1.28, use MediaWiki\Linker\LinkRenderer instead
56 * @param LinkTarget $target Can currently only be a LinkTarget, but this may
57 * change to support Images, literal URLs, etc.
58 * @param string $html The HTML contents of the <a> element, i.e.,
59 * the link text. This is raw HTML and will not be escaped. If null,
60 * defaults to the prefixed text of the Title; or if the Title is just a
61 * fragment, the contents of the fragment.
62 * @param array $customAttribs A key => value array of extra HTML attributes,
63 * such as title and class. (href is ignored.) Classes will be
64 * merged with the default classes, while other attributes will replace
65 * default attributes. All passed attribute values will be HTML-escaped.
66 * A false attribute value means to suppress that attribute.
67 * @param array $query The query string to append to the URL
68 * you're linking to, in key => value array form. Query keys and values
69 * will be URL-encoded.
70 * @param string|array $options String or array of strings:
71 * 'known': Page is known to exist, so don't check if it does.
72 * 'broken': Page is known not to exist, so don't check if it does.
73 * 'noclasses': Don't add any classes automatically (includes "new",
74 * "stub", "mw-redirect", "extiw"). Only use the class attribute
75 * provided, if any, so you get a simple blue link with no funny i-
77 * 'forcearticlepath': Use the article path always, even with a querystring.
78 * Has compatibility issues on some setups, so avoid wherever possible.
79 * 'http': Force a full URL with http:// as the scheme.
80 * 'https': Force a full URL with https:// as the scheme.
81 * 'stubThreshold' => (int): Stub threshold to use when determining link classes.
82 * @return string HTML <a> attribute
84 public static function link(
85 $target, $html = null, $customAttribs = [], $query = [], $options = []
87 if ( !$target instanceof LinkTarget
) {
88 wfWarn( __METHOD__
. ': Requires $target to be a LinkTarget object.', 2 );
89 return "<!-- ERROR -->$html";
92 if ( is_string( $query ) ) {
93 // some functions withing core using this still hand over query strings
94 wfDeprecated( __METHOD__
. ' with parameter $query as string (should be array)', '1.20' );
95 $query = wfCgiToArray( $query );
98 $services = MediaWikiServices
::getInstance();
99 $options = (array)$options;
101 // Custom options, create new LinkRenderer
102 if ( !isset( $options['stubThreshold'] ) ) {
103 $defaultLinkRenderer = $services->getLinkRenderer();
104 $options['stubThreshold'] = $defaultLinkRenderer->getStubThreshold();
106 $linkRenderer = $services->getLinkRendererFactory()
107 ->createFromLegacyOptions( $options );
109 $linkRenderer = $services->getLinkRenderer();
112 if ( $html !== null ) {
113 $text = new HtmlArmor( $html );
115 $text = $html; // null
117 if ( in_array( 'known', $options, true ) ) {
118 return $linkRenderer->makeKnownLink( $target, $text, $customAttribs, $query );
119 } elseif ( in_array( 'broken', $options, true ) ) {
120 return $linkRenderer->makeBrokenLink( $target, $text, $customAttribs, $query );
121 } elseif ( in_array( 'noclasses', $options, true ) ) {
122 return $linkRenderer->makePreloadedLink( $target, $text, '', $customAttribs, $query );
124 return $linkRenderer->makeLink( $target, $text, $customAttribs, $query );
129 * Identical to link(), except $options defaults to 'known'.
132 * @deprecated since 1.28, use MediaWiki\Linker\LinkRenderer instead
134 * @param Title $target
135 * @param string $html
136 * @param array $customAttribs
137 * @param array $query
138 * @param string|array $options
141 public static function linkKnown(
142 $target, $html = null, $customAttribs = [],
143 $query = [], $options = [ 'known' ]
145 return self
::link( $target, $html, $customAttribs, $query, $options );
149 * Make appropriate markup for a link to the current article. This is since
150 * MediaWiki 1.29.0 rendered as an <a> tag without an href and with a class
151 * showing the link text. The calling sequence is the same as for the other
152 * make*LinkObj static functions, but $query is not used.
156 * @param string $html [optional]
157 * @param string $query [optional]
158 * @param string $trail [optional]
159 * @param string $prefix [optional]
163 public static function makeSelfLinkObj( $nt, $html = '', $query = '', $trail = '', $prefix = '' ) {
164 $ret = "<a class=\"mw-selflink selflink\">{$prefix}{$html}</a>{$trail}";
165 if ( !Hooks
::run( 'SelfLinkBegin', [ $nt, &$html, &$trail, &$prefix, &$ret ] ) ) {
170 $html = htmlspecialchars( $nt->getPrefixedText() );
172 list( $inside, $trail ) = self
::splitTrail( $trail );
173 return "<a class=\"mw-selflink selflink\">{$prefix}{$html}{$inside}</a>{$trail}";
177 * Get a message saying that an invalid title was encountered.
178 * This should be called after a method like Title::makeTitleSafe() returned
179 * a value indicating that the title object is invalid.
181 * @param IContextSource $context Context to use to get the messages
182 * @param int $namespace Namespace number
183 * @param string $title Text of the title, without the namespace part
186 public static function getInvalidTitleDescription( IContextSource
$context, $namespace, $title ) {
189 // First we check whether the namespace exists or not.
190 if ( MWNamespace
::exists( $namespace ) ) {
191 if ( $namespace == NS_MAIN
) {
192 $name = $context->msg( 'blanknamespace' )->text();
194 $name = $wgContLang->getFormattedNsText( $namespace );
196 return $context->msg( 'invalidtitle-knownnamespace', $namespace, $name, $title )->text();
198 return $context->msg( 'invalidtitle-unknownnamespace', $namespace, $title )->text();
204 * @param LinkTarget $target
207 public static function normaliseSpecialPage( LinkTarget
$target ) {
208 if ( $target->getNamespace() == NS_SPECIAL
&& !$target->isExternal() ) {
209 list( $name, $subpage ) = SpecialPageFactory
::resolveAlias( $target->getDBkey() );
213 $ret = SpecialPage
::getTitleValueFor( $name, $subpage, $target->getFragment() );
221 * Returns the filename part of an url.
222 * Used as alternative text for external images.
228 private static function fnamePart( $url ) {
229 $basename = strrchr( $url, '/' );
230 if ( false === $basename ) {
233 $basename = substr( $basename, 1 );
239 * Return the code for images which were added via external links,
240 * via Parser::maybeMakeExternalImage().
248 public static function makeExternalImage( $url, $alt = '' ) {
250 $alt = self
::fnamePart( $url );
253 $success = Hooks
::run( 'LinkerMakeExternalImage', [ &$url, &$alt, &$img ] );
255 wfDebug( "Hook LinkerMakeExternalImage changed the output of external image "
256 . "with url {$url} and alt text {$alt} to {$img}\n", true );
259 return Html
::element( 'img',
266 * Given parameters derived from [[Image:Foo|options...]], generate the
267 * HTML that that syntax inserts in the page.
269 * @param Parser $parser
270 * @param Title $title Title object of the file (not the currently viewed page)
271 * @param File $file File object, or false if it doesn't exist
272 * @param array $frameParams Associative array of parameters external to the media handler.
273 * Boolean parameters are indicated by presence or absence, the value is arbitrary and
274 * will often be false.
275 * thumbnail If present, downscale and frame
276 * manualthumb Image name to use as a thumbnail, instead of automatic scaling
277 * framed Shows image in original size in a frame
278 * frameless Downscale but don't frame
279 * upright If present, tweak default sizes for portrait orientation
280 * upright_factor Fudge factor for "upright" tweak (default 0.75)
281 * border If present, show a border around the image
282 * align Horizontal alignment (left, right, center, none)
283 * valign Vertical alignment (baseline, sub, super, top, text-top, middle,
284 * bottom, text-bottom)
285 * alt Alternate text for image (i.e. alt attribute). Plain text.
286 * class HTML for image classes. Plain text.
287 * caption HTML for image caption.
288 * link-url URL to link to
289 * link-title Title object to link to
290 * link-target Value for the target attribute, only with link-url
291 * no-link Boolean, suppress description link
293 * @param array $handlerParams Associative array of media handler parameters, to be passed
294 * to transform(). Typical keys are "width" and "page".
295 * @param string|bool $time Timestamp of the file, set as false for current
296 * @param string $query Query params for desc url
297 * @param int|null $widthOption Used by the parser to remember the user preference thumbnailsize
299 * @return string HTML for an image, with links, wrappers, etc.
301 public static function makeImageLink( Parser
$parser, Title
$title,
302 $file, $frameParams = [], $handlerParams = [], $time = false,
303 $query = "", $widthOption = null
306 $dummy = new DummyLinker
;
307 if ( !Hooks
::run( 'ImageBeforeProduceHTML', [ &$dummy, &$title,
308 &$file, &$frameParams, &$handlerParams, &$time, &$res,
309 $parser, &$query, &$widthOption
314 if ( $file && !$file->allowInlineDisplay() ) {
315 wfDebug( __METHOD__
. ': ' . $title->getPrefixedDBkey() . " does not allow inline display\n" );
316 return self
::link( $title );
319 // Clean up parameters
320 $page = $handlerParams['page'] ??
false;
321 if ( !isset( $frameParams['align'] ) ) {
322 $frameParams['align'] = '';
324 if ( !isset( $frameParams['alt'] ) ) {
325 $frameParams['alt'] = '';
327 if ( !isset( $frameParams['title'] ) ) {
328 $frameParams['title'] = '';
330 if ( !isset( $frameParams['class'] ) ) {
331 $frameParams['class'] = '';
334 $prefix = $postfix = '';
336 if ( 'center' == $frameParams['align'] ) {
337 $prefix = '<div class="center">';
339 $frameParams['align'] = 'none';
341 if ( $file && !isset( $handlerParams['width'] ) ) {
342 if ( isset( $handlerParams['height'] ) && $file->isVectorized() ) {
343 // If its a vector image, and user only specifies height
344 // we don't want it to be limited by its "normal" width.
345 global $wgSVGMaxSize;
346 $handlerParams['width'] = $wgSVGMaxSize;
348 $handlerParams['width'] = $file->getWidth( $page );
351 if ( isset( $frameParams['thumbnail'] )
352 ||
isset( $frameParams['manualthumb'] )
353 ||
isset( $frameParams['framed'] )
354 ||
isset( $frameParams['frameless'] )
355 ||
!$handlerParams['width']
357 global $wgThumbLimits, $wgThumbUpright;
359 if ( $widthOption === null ||
!isset( $wgThumbLimits[$widthOption] ) ) {
360 $widthOption = User
::getDefaultOption( 'thumbsize' );
363 // Reduce width for upright images when parameter 'upright' is used
364 if ( isset( $frameParams['upright'] ) && $frameParams['upright'] == 0 ) {
365 $frameParams['upright'] = $wgThumbUpright;
368 // For caching health: If width scaled down due to upright
369 // parameter, round to full __0 pixel to avoid the creation of a
370 // lot of odd thumbs.
371 $prefWidth = isset( $frameParams['upright'] ) ?
372 round( $wgThumbLimits[$widthOption] * $frameParams['upright'], -1 ) :
373 $wgThumbLimits[$widthOption];
375 // Use width which is smaller: real image width or user preference width
376 // Unless image is scalable vector.
377 if ( !isset( $handlerParams['height'] ) && ( $handlerParams['width'] <= 0 ||
378 $prefWidth < $handlerParams['width'] ||
$file->isVectorized() ) ) {
379 $handlerParams['width'] = $prefWidth;
384 if ( isset( $frameParams['thumbnail'] ) ||
isset( $frameParams['manualthumb'] )
385 ||
isset( $frameParams['framed'] )
387 # Create a thumbnail. Alignment depends on the writing direction of
388 # the page content language (right-aligned for LTR languages,
389 # left-aligned for RTL languages)
390 # If a thumbnail width has not been provided, it is set
391 # to the default user option as specified in Language*.php
392 if ( $frameParams['align'] == '' ) {
393 $frameParams['align'] = $parser->getTargetLanguage()->alignEnd();
396 self
::makeThumbLink2( $title, $file, $frameParams, $handlerParams, $time, $query ) .
400 if ( $file && isset( $frameParams['frameless'] ) ) {
401 $srcWidth = $file->getWidth( $page );
402 # For "frameless" option: do not present an image bigger than the
403 # source (for bitmap-style images). This is the same behavior as the
404 # "thumb" option does it already.
405 if ( $srcWidth && !$file->mustRender() && $handlerParams['width'] > $srcWidth ) {
406 $handlerParams['width'] = $srcWidth;
410 if ( $file && isset( $handlerParams['width'] ) ) {
411 # Create a resized image, without the additional thumbnail features
412 $thumb = $file->transform( $handlerParams );
418 $s = self
::makeBrokenImageLinkObj( $title, $frameParams['title'], '', '', '', $time == true );
420 self
::processResponsiveImages( $file, $thumb, $handlerParams );
422 'alt' => $frameParams['alt'],
423 'title' => $frameParams['title'],
424 'valign' => $frameParams['valign'] ??
false,
425 'img-class' => $frameParams['class'] ];
426 if ( isset( $frameParams['border'] ) ) {
427 $params['img-class'] .= ( $params['img-class'] !== '' ?
' ' : '' ) . 'thumbborder';
429 $params = self
::getImageLinkMTOParams( $frameParams, $query, $parser ) +
$params;
431 $s = $thumb->toHtml( $params );
433 if ( $frameParams['align'] != '' ) {
434 $s = "<div class=\"float{$frameParams['align']}\">{$s}</div>";
436 return str_replace( "\n", ' ', $prefix . $s . $postfix );
440 * Get the link parameters for MediaTransformOutput::toHtml() from given
441 * frame parameters supplied by the Parser.
442 * @param array $frameParams The frame parameters
443 * @param string $query An optional query string to add to description page links
444 * @param Parser|null $parser
447 private static function getImageLinkMTOParams( $frameParams, $query = '', $parser = null ) {
449 if ( isset( $frameParams['link-url'] ) && $frameParams['link-url'] !== '' ) {
450 $mtoParams['custom-url-link'] = $frameParams['link-url'];
451 if ( isset( $frameParams['link-target'] ) ) {
452 $mtoParams['custom-target-link'] = $frameParams['link-target'];
455 $extLinkAttrs = $parser->getExternalLinkAttribs( $frameParams['link-url'] );
456 foreach ( $extLinkAttrs as $name => $val ) {
457 // Currently could include 'rel' and 'target'
458 $mtoParams['parser-extlink-' . $name] = $val;
461 } elseif ( isset( $frameParams['link-title'] ) && $frameParams['link-title'] !== '' ) {
462 $mtoParams['custom-title-link'] = Title
::newFromLinkTarget(
463 self
::normaliseSpecialPage( $frameParams['link-title'] )
465 } elseif ( !empty( $frameParams['no-link'] ) ) {
468 $mtoParams['desc-link'] = true;
469 $mtoParams['desc-query'] = $query;
475 * Make HTML for a thumbnail including image, border and caption
476 * @param Title $title
477 * @param File|bool $file File object or false if it doesn't exist
478 * @param string $label
480 * @param string $align
481 * @param array $params
482 * @param bool $framed
483 * @param string $manualthumb
486 public static function makeThumbLinkObj( Title
$title, $file, $label = '', $alt = '',
487 $align = 'right', $params = [], $framed = false, $manualthumb = ""
495 $frameParams['framed'] = true;
497 if ( $manualthumb ) {
498 $frameParams['manualthumb'] = $manualthumb;
500 return self
::makeThumbLink2( $title, $file, $frameParams, $params );
504 * @param Title $title
506 * @param array $frameParams
507 * @param array $handlerParams
509 * @param string $query
512 public static function makeThumbLink2( Title
$title, $file, $frameParams = [],
513 $handlerParams = [], $time = false, $query = ""
515 $exists = $file && $file->exists();
517 $page = $handlerParams['page'] ??
false;
518 if ( !isset( $frameParams['align'] ) ) {
519 $frameParams['align'] = 'right';
521 if ( !isset( $frameParams['alt'] ) ) {
522 $frameParams['alt'] = '';
524 if ( !isset( $frameParams['title'] ) ) {
525 $frameParams['title'] = '';
527 if ( !isset( $frameParams['caption'] ) ) {
528 $frameParams['caption'] = '';
531 if ( empty( $handlerParams['width'] ) ) {
532 // Reduce width for upright images when parameter 'upright' is used
533 $handlerParams['width'] = isset( $frameParams['upright'] ) ?
130 : 180;
537 $manualthumb = false;
540 $outerWidth = $handlerParams['width'] +
2;
542 if ( isset( $frameParams['manualthumb'] ) ) {
543 # Use manually specified thumbnail
544 $manual_title = Title
::makeTitleSafe( NS_FILE
, $frameParams['manualthumb'] );
545 if ( $manual_title ) {
546 $manual_img = wfFindFile( $manual_title );
548 $thumb = $manual_img->getUnscaledThumb( $handlerParams );
554 } elseif ( isset( $frameParams['framed'] ) ) {
555 // Use image dimensions, don't scale
556 $thumb = $file->getUnscaledThumb( $handlerParams );
559 # Do not present an image bigger than the source, for bitmap-style images
560 # This is a hack to maintain compatibility with arbitrary pre-1.10 behavior
561 $srcWidth = $file->getWidth( $page );
562 if ( $srcWidth && !$file->mustRender() && $handlerParams['width'] > $srcWidth ) {
563 $handlerParams['width'] = $srcWidth;
565 $thumb = $file->transform( $handlerParams );
569 $outerWidth = $thumb->getWidth() +
2;
571 $outerWidth = $handlerParams['width'] +
2;
575 # ThumbnailImage::toHtml() already adds page= onto the end of DjVu URLs
576 # So we don't need to pass it here in $query. However, the URL for the
577 # zoom icon still needs it, so we make a unique query for it. See T16771
578 $url = $title->getLocalURL( $query );
580 $url = wfAppendQuery( $url, [ 'page' => $page ] );
583 && !isset( $frameParams['link-title'] )
584 && !isset( $frameParams['link-url'] )
585 && !isset( $frameParams['no-link'] ) ) {
586 $frameParams['link-url'] = $url;
589 $s = "<div class=\"thumb t{$frameParams['align']}\">"
590 . "<div class=\"thumbinner\" style=\"width:{$outerWidth}px;\">";
593 $s .= self
::makeBrokenImageLinkObj( $title, $frameParams['title'], '', '', '', $time == true );
595 } elseif ( !$thumb ) {
596 $s .= wfMessage( 'thumbnail_error', '' )->escaped();
599 if ( !$noscale && !$manualthumb ) {
600 self
::processResponsiveImages( $file, $thumb, $handlerParams );
603 'alt' => $frameParams['alt'],
604 'title' => $frameParams['title'],
605 'img-class' => ( isset( $frameParams['class'] ) && $frameParams['class'] !== ''
606 ?
$frameParams['class'] . ' '
607 : '' ) . 'thumbimage'
609 $params = self
::getImageLinkMTOParams( $frameParams, $query ) +
$params;
610 $s .= $thumb->toHtml( $params );
611 if ( isset( $frameParams['framed'] ) ) {
614 $zoomIcon = Html
::rawElement( 'div', [ 'class' => 'magnify' ],
615 Html
::rawElement( 'a', [
617 'class' => 'internal',
618 'title' => wfMessage( 'thumbnail-more' )->text() ],
622 $s .= ' <div class="thumbcaption">' . $zoomIcon . $frameParams['caption'] . "</div></div></div>";
623 return str_replace( "\n", ' ', $s );
627 * Process responsive images: add 1.5x and 2x subimages to the thumbnail, where
631 * @param MediaTransformOutput $thumb
632 * @param array $hp Image parameters
634 public static function processResponsiveImages( $file, $thumb, $hp ) {
635 global $wgResponsiveImages;
636 if ( $wgResponsiveImages && $thumb && !$thumb->isError() ) {
638 $hp15['width'] = round( $hp['width'] * 1.5 );
640 $hp20['width'] = $hp['width'] * 2;
641 if ( isset( $hp['height'] ) ) {
642 $hp15['height'] = round( $hp['height'] * 1.5 );
643 $hp20['height'] = $hp['height'] * 2;
646 $thumb15 = $file->transform( $hp15 );
647 $thumb20 = $file->transform( $hp20 );
648 if ( $thumb15 && !$thumb15->isError() && $thumb15->getUrl() !== $thumb->getUrl() ) {
649 $thumb->responsiveUrls
['1.5'] = $thumb15->getUrl();
651 if ( $thumb20 && !$thumb20->isError() && $thumb20->getUrl() !== $thumb->getUrl() ) {
652 $thumb->responsiveUrls
['2'] = $thumb20->getUrl();
658 * Make a "broken" link to an image
661 * @param Title $title
662 * @param string $label Link label (plain text)
663 * @param string $query Query string
664 * @param string $unused1 Unused parameter kept for b/c
665 * @param string $unused2 Unused parameter kept for b/c
666 * @param bool $time A file of a certain timestamp was requested
669 public static function makeBrokenImageLinkObj( $title, $label = '',
670 $query = '', $unused1 = '', $unused2 = '', $time = false
672 if ( !$title instanceof Title
) {
673 wfWarn( __METHOD__
. ': Requires $title to be a Title object.' );
674 return "<!-- ERROR -->" . htmlspecialchars( $label );
677 global $wgEnableUploads, $wgUploadMissingFileUrl, $wgUploadNavigationUrl;
678 if ( $label == '' ) {
679 $label = $title->getPrefixedText();
681 $encLabel = htmlspecialchars( $label );
682 $currentExists = $time ?
( wfFindFile( $title ) != false ) : false;
684 if ( ( $wgUploadMissingFileUrl ||
$wgUploadNavigationUrl ||
$wgEnableUploads )
687 $redir = RepoGroup
::singleton()->getLocalRepo()->checkRedirect( $title );
690 // We already know it's a redirect, so mark it
695 [ 'class' => 'mw-redirect' ],
696 wfCgiToArray( $query ),
697 [ 'known', 'noclasses' ]
701 $href = self
::getUploadUrl( $title, $query );
703 return '<a href="' . htmlspecialchars( $href ) . '" class="new" title="' .
704 htmlspecialchars( $title->getPrefixedText(), ENT_QUOTES
) . '">' .
708 return self
::link( $title, $encLabel, [], wfCgiToArray( $query ), [ 'known', 'noclasses' ] );
712 * Get the URL to upload a certain file
715 * @param Title $destFile Title object of the file to upload
716 * @param string $query Urlencoded query string to prepend
717 * @return string Urlencoded URL
719 protected static function getUploadUrl( $destFile, $query = '' ) {
720 global $wgUploadMissingFileUrl, $wgUploadNavigationUrl;
721 $q = 'wpDestFile=' . $destFile->getPartialURL();
722 if ( $query != '' ) {
726 if ( $wgUploadMissingFileUrl ) {
727 return wfAppendQuery( $wgUploadMissingFileUrl, $q );
728 } elseif ( $wgUploadNavigationUrl ) {
729 return wfAppendQuery( $wgUploadNavigationUrl, $q );
731 $upload = SpecialPage
::getTitleFor( 'Upload' );
732 return $upload->getLocalURL( $q );
737 * Create a direct link to a given uploaded file.
740 * @param Title $title
741 * @param string $html Pre-sanitized HTML
742 * @param string $time MW timestamp of file creation time
743 * @return string HTML
745 public static function makeMediaLinkObj( $title, $html = '', $time = false ) {
746 $img = wfFindFile( $title, [ 'time' => $time ] );
747 return self
::makeMediaLinkFile( $title, $img, $html );
751 * Create a direct link to a given uploaded file.
752 * This will make a broken link if $file is false.
755 * @param Title $title
756 * @param File|bool $file File object or false
757 * @param string $html Pre-sanitized HTML
758 * @return string HTML
760 * @todo Handle invalid or missing images better.
762 public static function makeMediaLinkFile( Title
$title, $file, $html = '' ) {
763 if ( $file && $file->exists() ) {
764 $url = $file->getUrl();
767 $url = self
::getUploadUrl( $title );
771 $alt = $title->getText();
783 if ( !Hooks
::run( 'LinkerMakeMediaLinkFile',
784 [ $title, $file, &$html, &$attribs, &$ret ] ) ) {
785 wfDebug( "Hook LinkerMakeMediaLinkFile changed the output of link "
786 . "with url {$url} and text {$html} to {$ret}\n", true );
790 return Html
::rawElement( 'a', $attribs, $html );
794 * Make a link to a special page given its name and, optionally,
795 * a message key from the link text.
796 * Usage example: Linker::specialLink( 'Recentchanges' )
799 * @param string $name
803 public static function specialLink( $name, $key = '' ) {
805 $key = strtolower( $name );
808 return self
::linkKnown( SpecialPage
::getTitleFor( $name ), wfMessage( $key )->escaped() );
812 * Make an external link
813 * @since 1.16.3. $title added in 1.21
814 * @param string $url URL to link to
815 * @param string $text Text of link
816 * @param bool $escape Do we escape the link text?
817 * @param string $linktype Type of external link. Gets added to the classes
818 * @param array $attribs Array of extra attributes to <a>
819 * @param Title|null $title Title object used for title specific link attributes
822 public static function makeExternalLink( $url, $text, $escape = true,
823 $linktype = '', $attribs = [], $title = null
828 $class .= " $linktype";
830 if ( isset( $attribs['class'] ) && $attribs['class'] ) {
831 $class .= " {$attribs['class']}";
833 $attribs['class'] = $class;
836 $text = htmlspecialchars( $text );
842 $newRel = Parser
::getExternalLinkRel( $url, $title );
843 if ( !isset( $attribs['rel'] ) ||
$attribs['rel'] === '' ) {
844 $attribs['rel'] = $newRel;
845 } elseif ( $newRel !== '' ) {
846 // Merge the rel attributes.
847 $newRels = explode( ' ', $newRel );
848 $oldRels = explode( ' ', $attribs['rel'] );
849 $combined = array_unique( array_merge( $newRels, $oldRels ) );
850 $attribs['rel'] = implode( ' ', $combined );
853 $success = Hooks
::run( 'LinkerMakeExternalLink',
854 [ &$url, &$text, &$link, &$attribs, $linktype ] );
856 wfDebug( "Hook LinkerMakeExternalLink changed the output of link "
857 . "with url {$url} and text {$text} to {$link}\n", true );
860 $attribs['href'] = $url;
861 return Html
::rawElement( 'a', $attribs, $text );
865 * Make user link (or user contributions for unregistered users)
866 * @param int $userId User id in database.
867 * @param string $userName User name in database.
868 * @param string $altUserName Text to display instead of the user name (optional)
869 * @return string HTML fragment
870 * @since 1.16.3. $altUserName was added in 1.19.
872 public static function userLink( $userId, $userName, $altUserName = false ) {
873 $classes = 'mw-userlink';
875 if ( $userId == 0 ) {
876 $page = ExternalUserNames
::getUserLinkTitle( $userName );
878 if ( ExternalUserNames
::isExternal( $userName ) ) {
879 $classes .= ' mw-extuserlink';
880 } elseif ( $altUserName === false ) {
881 $altUserName = IP
::prettifyIP( $userName );
883 $classes .= ' mw-anonuserlink'; // Separate link class for anons (T45179)
885 $page = Title
::makeTitle( NS_USER
, $userName );
888 // Wrap the output with <bdi> tags for directionality isolation
890 '<bdi>' . htmlspecialchars( $altUserName !== false ?
$altUserName : $userName ) . '</bdi>';
893 ? self
::link( $page, $linkText, [ 'class' => $classes ] )
894 : Html
::rawElement( 'span', [ 'class' => $classes ], $linkText );
898 * Generate standard user tool links (talk, contributions, block link, etc.)
901 * @param int $userId User identifier
902 * @param string $userText User name or IP address
903 * @param bool $redContribsWhenNoEdits Should the contributions link be
904 * red if the user has no edits?
905 * @param int $flags Customisation flags (e.g. Linker::TOOL_LINKS_NOBLOCK
906 * and Linker::TOOL_LINKS_EMAIL).
907 * @param int|null $edits User edit count (optional, for performance)
908 * @return string HTML fragment
910 public static function userToolLinks(
911 $userId, $userText, $redContribsWhenNoEdits = false, $flags = 0, $edits = null
913 global $wgUser, $wgDisableAnonTalk, $wgLang;
914 $talkable = !( $wgDisableAnonTalk && 0 == $userId );
915 $blockable = !( $flags & self
::TOOL_LINKS_NOBLOCK
);
916 $addEmailLink = $flags & self
::TOOL_LINKS_EMAIL
&& $userId;
918 if ( $userId == 0 && ExternalUserNames
::isExternal( $userText ) ) {
919 // No tools for an external user
925 $items[] = self
::userTalkLink( $userId, $userText );
928 // check if the user has an edit
930 $attribs['class'] = 'mw-usertoollinks-contribs';
931 if ( $redContribsWhenNoEdits ) {
932 if ( intval( $edits ) === 0 && $edits !== 0 ) {
933 $user = User
::newFromId( $userId );
934 $edits = $user->getEditCount();
936 if ( $edits === 0 ) {
937 $attribs['class'] .= ' new';
940 $contribsPage = SpecialPage
::getTitleFor( 'Contributions', $userText );
942 $items[] = self
::link( $contribsPage, wfMessage( 'contribslink' )->escaped(), $attribs );
944 if ( $blockable && $wgUser->isAllowed( 'block' ) ) {
945 $items[] = self
::blockLink( $userId, $userText );
948 if ( $addEmailLink && $wgUser->canSendEmail() ) {
949 $items[] = self
::emailLink( $userId, $userText );
952 Hooks
::run( 'UserToolLinksEdit', [ $userId, $userText, &$items ] );
955 return wfMessage( 'word-separator' )->escaped()
956 . '<span class="mw-usertoollinks">'
957 . wfMessage( 'parentheses' )->rawParams( $wgLang->pipeList( $items ) )->escaped()
965 * Alias for userToolLinks( $userId, $userText, true );
967 * @param int $userId User identifier
968 * @param string $userText User name or IP address
969 * @param int|null $edits User edit count (optional, for performance)
972 public static function userToolLinksRedContribs( $userId, $userText, $edits = null ) {
973 return self
::userToolLinks( $userId, $userText, true, 0, $edits );
978 * @param int $userId User id in database.
979 * @param string $userText User name in database.
980 * @return string HTML fragment with user talk link
982 public static function userTalkLink( $userId, $userText ) {
983 $userTalkPage = Title
::makeTitle( NS_USER_TALK
, $userText );
984 $moreLinkAttribs['class'] = 'mw-usertoollinks-talk';
985 $userTalkLink = self
::link( $userTalkPage,
986 wfMessage( 'talkpagelinktext' )->escaped(),
988 return $userTalkLink;
994 * @param string $userText User name in database.
995 * @return string HTML fragment with block link
997 public static function blockLink( $userId, $userText ) {
998 $blockPage = SpecialPage
::getTitleFor( 'Block', $userText );
999 $moreLinkAttribs['class'] = 'mw-usertoollinks-block';
1000 $blockLink = self
::link( $blockPage,
1001 wfMessage( 'blocklink' )->escaped(),
1007 * @param int $userId
1008 * @param string $userText User name in database.
1009 * @return string HTML fragment with e-mail user link
1011 public static function emailLink( $userId, $userText ) {
1012 $emailPage = SpecialPage
::getTitleFor( 'Emailuser', $userText );
1013 $moreLinkAttribs['class'] = 'mw-usertoollinks-mail';
1014 $emailLink = self
::link( $emailPage,
1015 wfMessage( 'emaillink' )->escaped(),
1021 * Generate a user link if the current user is allowed to view it
1023 * @param Revision $rev
1024 * @param bool $isPublic Show only if all users can see it
1025 * @return string HTML fragment
1027 public static function revUserLink( $rev, $isPublic = false ) {
1028 if ( $rev->isDeleted( Revision
::DELETED_USER
) && $isPublic ) {
1029 $link = wfMessage( 'rev-deleted-user' )->escaped();
1030 } elseif ( $rev->userCan( Revision
::DELETED_USER
) ) {
1031 $link = self
::userLink( $rev->getUser( Revision
::FOR_THIS_USER
),
1032 $rev->getUserText( Revision
::FOR_THIS_USER
) );
1034 $link = wfMessage( 'rev-deleted-user' )->escaped();
1036 if ( $rev->isDeleted( Revision
::DELETED_USER
) ) {
1037 return '<span class="history-deleted">' . $link . '</span>';
1043 * Generate a user tool link cluster if the current user is allowed to view it
1045 * @param Revision $rev
1046 * @param bool $isPublic Show only if all users can see it
1047 * @return string HTML
1049 public static function revUserTools( $rev, $isPublic = false ) {
1050 if ( $rev->isDeleted( Revision
::DELETED_USER
) && $isPublic ) {
1051 $link = wfMessage( 'rev-deleted-user' )->escaped();
1052 } elseif ( $rev->userCan( Revision
::DELETED_USER
) ) {
1053 $userId = $rev->getUser( Revision
::FOR_THIS_USER
);
1054 $userText = $rev->getUserText( Revision
::FOR_THIS_USER
);
1055 $link = self
::userLink( $userId, $userText )
1056 . self
::userToolLinks( $userId, $userText );
1058 $link = wfMessage( 'rev-deleted-user' )->escaped();
1060 if ( $rev->isDeleted( Revision
::DELETED_USER
) ) {
1061 return ' <span class="history-deleted">' . $link . '</span>';
1067 * This function is called by all recent changes variants, by the page history,
1068 * and by the user contributions list. It is responsible for formatting edit
1069 * summaries. It escapes any HTML in the summary, but adds some CSS to format
1070 * auto-generated comments (from section editing) and formats [[wikilinks]].
1072 * @author Erik Moeller <moeller@scireview.de>
1073 * @since 1.16.3. $wikiId added in 1.26
1075 * Note: there's not always a title to pass to this function.
1076 * Since you can't set a default parameter for a reference, I've turned it
1077 * temporarily to a value pass. Should be adjusted further. --brion
1079 * @param string $comment
1080 * @param Title|null $title Title object (to generate link to the section in autocomment)
1082 * @param bool $local Whether section links should refer to local page
1083 * @param string|null $wikiId Id (as used by WikiMap) of the wiki to generate links to.
1084 * For use with external changes.
1086 * @return mixed|string
1088 public static function formatComment(
1089 $comment, $title = null, $local = false, $wikiId = null
1091 # Sanitize text a bit:
1092 $comment = str_replace( "\n", " ", $comment );
1093 # Allow HTML entities (for T15815)
1094 $comment = Sanitizer
::escapeHtmlAllowEntities( $comment );
1096 # Render autocomments and make links:
1097 $comment = self
::formatAutocomments( $comment, $title, $local, $wikiId );
1098 $comment = self
::formatLinksInComment( $comment, $title, $local, $wikiId );
1104 * Converts autogenerated comments in edit summaries into section links.
1106 * The pattern for autogen comments is / * foo * /, which makes for
1108 * We look for all comments, match any text before and after the comment,
1109 * add a separator where needed and format the comment itself with CSS
1110 * Called by Linker::formatComment.
1112 * @param string $comment Comment text
1113 * @param Title|null $title An optional title object used to links to sections
1114 * @param bool $local Whether section links should refer to local page
1115 * @param string|null $wikiId Id of the wiki to link to (if not the local wiki),
1116 * as used by WikiMap.
1118 * @return string Formatted comment (wikitext)
1120 private static function formatAutocomments(
1121 $comment, $title = null, $local = false, $wikiId = null
1123 // @todo $append here is something of a hack to preserve the status
1124 // quo. Someone who knows more about bidi and such should decide
1125 // (1) what sane rendering even *is* for an LTR edit summary on an RTL
1126 // wiki, both when autocomments exist and when they don't, and
1127 // (2) what markup will make that actually happen.
1129 $comment = preg_replace_callback(
1130 // To detect the presence of content before or after the
1131 // auto-comment, we use capturing groups inside optional zero-width
1132 // assertions. But older versions of PCRE can't directly make
1133 // zero-width assertions optional, so wrap them in a non-capturing
1135 '!(?:(?<=(.)))?/\*\s*(.*?)\s*\*/(?:(?=(.)))?!',
1136 function ( $match ) use ( $title, $local, $wikiId, &$append ) {
1139 // Ensure all match positions are defined
1140 $match +
= [ '', '', '', '' ];
1142 $pre = $match[1] !== '';
1144 $post = $match[3] !== '';
1148 'FormatAutocomments',
1149 [ &$comment, $pre, $auto, $post, $title, $local, $wikiId ]
1152 if ( $comment === null ) {
1156 # Remove links that a user may have manually put in the autosummary
1157 # This could be improved by copying as much of Parser::stripSectionName as desired.
1158 $section = str_replace( '[[:', '', $section );
1159 $section = str_replace( '[[', '', $section );
1160 $section = str_replace( ']]', '', $section );
1162 $section = substr( Parser
::guessSectionNameFromStrippedText( $section ), 1 );
1164 $sectionTitle = Title
::makeTitleSafe( NS_MAIN
, '', $section );
1166 $sectionTitle = Title
::makeTitleSafe( $title->getNamespace(),
1167 $title->getDBkey(), $section );
1169 if ( $sectionTitle ) {
1170 $link = Linker
::makeCommentLink( $sectionTitle, $wgLang->getArrow(), $wikiId, 'noclasses' );
1176 # written summary $presep autocomment (summary /* section */)
1177 $pre = wfMessage( 'autocomment-prefix' )->inContentLanguage()->escaped();
1180 # autocomment $postsep written summary (/* section */ summary)
1181 $auto .= wfMessage( 'colon-separator' )->inContentLanguage()->escaped();
1183 $auto = '<span class="autocomment">' . $auto . '</span>';
1184 $comment = $pre . $link . $wgLang->getDirMark()
1185 . '<span dir="auto">' . $auto;
1186 $append .= '</span>';
1192 return $comment . $append;
1196 * Formats wiki links and media links in text; all other wiki formatting
1199 * @since 1.16.3. $wikiId added in 1.26
1200 * @todo FIXME: Doesn't handle sub-links as in image thumb texts like the main parser
1202 * @param string $comment Text to format links in. WARNING! Since the output of this
1203 * function is html, $comment must be sanitized for use as html. You probably want
1204 * to pass $comment through Sanitizer::escapeHtmlAllowEntities() before calling
1206 * @param Title|null $title An optional title object used to links to sections
1207 * @param bool $local Whether section links should refer to local page
1208 * @param string|null $wikiId Id of the wiki to link to (if not the local wiki),
1209 * as used by WikiMap.
1213 public static function formatLinksInComment(
1214 $comment, $title = null, $local = false, $wikiId = null
1216 return preg_replace_callback(
1219 :? # ignore optional leading colon
1220 ([^\]|]+) # 1. link target; page names cannot include ] or |
1223 # Stop matching at ]] without relying on backtracking.
1227 ([^[]*) # 3. link trail (the text up until the next link)
1229 function ( $match ) use ( $title, $local, $wikiId ) {
1232 $medians = '(?:' . preg_quote( MWNamespace
::getCanonicalName( NS_MEDIA
), '/' ) . '|';
1233 $medians .= preg_quote( $wgContLang->getNsText( NS_MEDIA
), '/' ) . '):';
1235 $comment = $match[0];
1237 # fix up urlencoded title texts (copied from Parser::replaceInternalLinks)
1238 if ( strpos( $match[1], '%' ) !== false ) {
1240 rawurldecode( $match[1] ),
1241 [ '<' => '<', '>' => '>' ]
1245 # Handle link renaming [[foo|text]] will show link as "text"
1246 if ( $match[2] != "" ) {
1253 if ( preg_match( '/^' . $medians . '(.*)$/i', $match[1], $submatch ) ) {
1254 # Media link; trail not supported.
1255 $linkRegexp = '/\[\[(.*?)\]\]/';
1256 $title = Title
::makeTitleSafe( NS_FILE
, $submatch[1] );
1258 $thelink = Linker
::makeMediaLinkObj( $title, $text );
1261 # Other kind of link
1262 # Make sure its target is non-empty
1263 if ( isset( $match[1][0] ) && $match[1][0] == ':' ) {
1264 $match[1] = substr( $match[1], 1 );
1266 if ( $match[1] !== false && $match[1] !== '' ) {
1267 if ( preg_match( $wgContLang->linkTrail(), $match[3], $submatch ) ) {
1268 $trail = $submatch[1];
1272 $linkRegexp = '/\[\[(.*?)\]\]' . preg_quote( $trail, '/' ) . '/';
1273 list( $inside, $trail ) = Linker
::splitTrail( $trail );
1276 $linkTarget = Linker
::normalizeSubpageLink( $title, $match[1], $linkText );
1278 $target = Title
::newFromText( $linkTarget );
1280 if ( $target->getText() == '' && !$target->isExternal()
1281 && !$local && $title
1283 $target = $title->createFragmentTarget( $target->getFragment() );
1286 $thelink = Linker
::makeCommentLink( $target, $linkText . $inside, $wikiId ) . $trail;
1291 // If the link is still valid, go ahead and replace it in!
1292 $comment = preg_replace(
1294 StringUtils
::escapeRegexReplacement( $thelink ),
1307 * Generates a link to the given Title
1309 * @note This is only public for technical reasons. It's not intended for use outside Linker.
1311 * @param LinkTarget $linkTarget
1312 * @param string $text
1313 * @param string|null $wikiId Id of the wiki to link to (if not the local wiki),
1314 * as used by WikiMap.
1315 * @param string|string[] $options See the $options parameter in Linker::link.
1317 * @return string HTML link
1319 public static function makeCommentLink(
1320 LinkTarget
$linkTarget, $text, $wikiId = null, $options = []
1322 if ( $wikiId !== null && !$linkTarget->isExternal() ) {
1323 $link = self
::makeExternalLink(
1324 WikiMap
::getForeignURL(
1326 $linkTarget->getNamespace() === 0
1327 ?
$linkTarget->getDBkey()
1328 : MWNamespace
::getCanonicalName( $linkTarget->getNamespace() ) . ':'
1329 . $linkTarget->getDBkey(),
1330 $linkTarget->getFragment()
1333 /* escape = */ false // Already escaped
1336 $link = self
::link( $linkTarget, $text, [], [], $options );
1343 * @param Title $contextTitle
1344 * @param string $target
1345 * @param string &$text
1348 public static function normalizeSubpageLink( $contextTitle, $target, &$text ) {
1351 # :Foobar -- override special treatment of prefix (images, language links)
1352 # /Foobar -- convert to CurrentPage/Foobar
1353 # /Foobar/ -- convert to CurrentPage/Foobar, strip the initial and final / from text
1354 # ../ -- convert to CurrentPage, from CurrentPage/CurrentSubPage
1355 # ../Foobar -- convert to CurrentPage/Foobar,
1356 # (from CurrentPage/CurrentSubPage)
1357 # ../Foobar/ -- convert to CurrentPage/Foobar, use 'Foobar' as text
1358 # (from CurrentPage/CurrentSubPage)
1360 $ret = $target; # default return value is no change
1362 # Some namespaces don't allow subpages,
1363 # so only perform processing if subpages are allowed
1364 if ( $contextTitle && MWNamespace
::hasSubpages( $contextTitle->getNamespace() ) ) {
1365 $hash = strpos( $target, '#' );
1366 if ( $hash !== false ) {
1367 $suffix = substr( $target, $hash );
1368 $target = substr( $target, 0, $hash );
1373 $target = trim( $target );
1374 # Look at the first character
1375 if ( $target != '' && $target[0] === '/' ) {
1376 # / at end means we don't want the slash to be shown
1378 $trailingSlashes = preg_match_all( '%(/+)$%', $target, $m );
1379 if ( $trailingSlashes ) {
1380 $noslash = $target = substr( $target, 1, -strlen( $m[0][0] ) );
1382 $noslash = substr( $target, 1 );
1385 $ret = $contextTitle->getPrefixedText() . '/' . trim( $noslash ) . $suffix;
1386 if ( $text === '' ) {
1387 $text = $target . $suffix;
1388 } # this might be changed for ugliness reasons
1390 # check for .. subpage backlinks
1392 $nodotdot = $target;
1393 while ( strncmp( $nodotdot, "../", 3 ) == 0 ) {
1395 $nodotdot = substr( $nodotdot, 3 );
1397 if ( $dotdotcount > 0 ) {
1398 $exploded = explode( '/', $contextTitle->getPrefixedText() );
1399 if ( count( $exploded ) > $dotdotcount ) { # not allowed to go below top level page
1400 $ret = implode( '/', array_slice( $exploded, 0, -$dotdotcount ) );
1401 # / at the end means don't show full path
1402 if ( substr( $nodotdot, -1, 1 ) === '/' ) {
1403 $nodotdot = rtrim( $nodotdot, '/' );
1404 if ( $text === '' ) {
1405 $text = $nodotdot . $suffix;
1408 $nodotdot = trim( $nodotdot );
1409 if ( $nodotdot != '' ) {
1410 $ret .= '/' . $nodotdot;
1422 * Wrap a comment in standard punctuation and formatting if
1423 * it's non-empty, otherwise return empty string.
1425 * @since 1.16.3. $wikiId added in 1.26
1426 * @param string $comment
1427 * @param Title|null $title Title object (to generate link to section in autocomment) or null
1428 * @param bool $local Whether section links should refer to local page
1429 * @param string|null $wikiId Id (as used by WikiMap) of the wiki to generate links to.
1430 * For use with external changes.
1434 public static function commentBlock(
1435 $comment, $title = null, $local = false, $wikiId = null
1437 // '*' used to be the comment inserted by the software way back
1438 // in antiquity in case none was provided, here for backwards
1439 // compatibility, acc. to brion -ævar
1440 if ( $comment == '' ||
$comment == '*' ) {
1443 $formatted = self
::formatComment( $comment, $title, $local, $wikiId );
1444 $formatted = wfMessage( 'parentheses' )->rawParams( $formatted )->escaped();
1445 return " <span class=\"comment\">$formatted</span>";
1450 * Wrap and format the given revision's comment block, if the current
1451 * user is allowed to view it.
1454 * @param Revision $rev
1455 * @param bool $local Whether section links should refer to local page
1456 * @param bool $isPublic Show only if all users can see it
1457 * @return string HTML fragment
1459 public static function revComment( Revision
$rev, $local = false, $isPublic = false ) {
1460 if ( $rev->getComment( Revision
::RAW
) == "" ) {
1463 if ( $rev->isDeleted( Revision
::DELETED_COMMENT
) && $isPublic ) {
1464 $block = " <span class=\"comment\">" . wfMessage( 'rev-deleted-comment' )->escaped() . "</span>";
1465 } elseif ( $rev->userCan( Revision
::DELETED_COMMENT
) ) {
1466 $block = self
::commentBlock( $rev->getComment( Revision
::FOR_THIS_USER
),
1467 $rev->getTitle(), $local );
1469 $block = " <span class=\"comment\">" . wfMessage( 'rev-deleted-comment' )->escaped() . "</span>";
1471 if ( $rev->isDeleted( Revision
::DELETED_COMMENT
) ) {
1472 return " <span class=\"history-deleted\">$block</span>";
1482 public static function formatRevisionSize( $size ) {
1484 $stxt = wfMessage( 'historyempty' )->escaped();
1486 $stxt = wfMessage( 'nbytes' )->numParams( $size )->escaped();
1487 $stxt = wfMessage( 'parentheses' )->rawParams( $stxt )->escaped();
1489 return "<span class=\"history-size\">$stxt</span>";
1493 * Add another level to the Table of Contents
1498 public static function tocIndent() {
1503 * Finish one or more sublevels on the Table of Contents
1509 public static function tocUnindent( $level ) {
1510 return "</li>\n" . str_repeat( "</ul>\n</li>\n", $level > 0 ?
$level : 0 );
1514 * parameter level defines if we are on an indentation level
1517 * @param string $anchor
1518 * @param string $tocline
1519 * @param string $tocnumber
1520 * @param string $level
1521 * @param string|bool $sectionIndex
1524 public static function tocLine( $anchor, $tocline, $tocnumber, $level, $sectionIndex = false ) {
1525 $classes = "toclevel-$level";
1526 if ( $sectionIndex !== false ) {
1527 $classes .= " tocsection-$sectionIndex";
1530 // <li class="$classes"><a href="#$anchor"><span class="tocnumber">
1531 // $tocnumber</span> <span class="toctext">$tocline</span></a>
1532 return Html
::openElement( 'li', [ 'class' => $classes ] )
1533 . Html
::rawElement( 'a',
1534 [ 'href' => "#$anchor" ],
1535 Html
::element( 'span', [ 'class' => 'tocnumber' ], $tocnumber )
1537 . Html
::rawElement( 'span', [ 'class' => 'toctext' ], $tocline )
1542 * End a Table Of Contents line.
1543 * tocUnindent() will be used instead if we're ending a line below
1548 public static function tocLineEnd() {
1553 * Wraps the TOC in a table and provides the hide/collapse javascript.
1556 * @param string $toc Html of the Table Of Contents
1557 * @param string|Language|bool $lang Language for the toc title, defaults to user language
1558 * @return string Full html of the TOC
1560 public static function tocList( $toc, $lang = false ) {
1561 $lang = wfGetLangObj( $lang );
1562 $title = wfMessage( 'toc' )->inLanguage( $lang )->escaped();
1564 return '<div id="toc" class="toc">'
1565 . Html
::element( 'input', [
1566 'type' => 'checkbox',
1567 'id' => 'toctogglecheckbox',
1568 'class' => 'toctogglecheckbox',
1569 'style' => 'display:none',
1571 . Html
::openElement( 'div', [
1572 'class' => 'toctitle',
1573 'lang' => $lang->getHtmlCode(),
1574 'dir' => $lang->getDir(),
1577 . '<span class="toctogglespan">'
1578 . Html
::label( '', 'toctogglecheckbox', [
1579 'class' => 'toctogglelabel',
1584 . "</ul>\n</div>\n";
1588 * Generate a table of contents from a section tree.
1590 * @since 1.16.3. $lang added in 1.17
1591 * @param array $tree Return value of ParserOutput::getSections()
1592 * @param string|Language|bool $lang Language for the toc title, defaults to user language
1593 * @return string HTML fragment
1595 public static function generateTOC( $tree, $lang = false ) {
1598 foreach ( $tree as $section ) {
1599 if ( $section['toclevel'] > $lastLevel ) {
1600 $toc .= self
::tocIndent();
1601 } elseif ( $section['toclevel'] < $lastLevel ) {
1602 $toc .= self
::tocUnindent(
1603 $lastLevel - $section['toclevel'] );
1605 $toc .= self
::tocLineEnd();
1608 $toc .= self
::tocLine( $section['anchor'],
1609 $section['line'], $section['number'],
1610 $section['toclevel'], $section['index'] );
1611 $lastLevel = $section['toclevel'];
1613 $toc .= self
::tocLineEnd();
1614 return self
::tocList( $toc, $lang );
1618 * Create a headline for content
1621 * @param int $level The level of the headline (1-6)
1622 * @param string $attribs Any attributes for the headline, starting with
1623 * a space and ending with '>'
1624 * This *must* be at least '>' for no attribs
1625 * @param string $anchor The anchor to give the headline (the bit after the #)
1626 * @param string $html HTML for the text of the header
1627 * @param string $link HTML to add for the section edit link
1628 * @param string|bool $fallbackAnchor A second, optional anchor to give for
1629 * backward compatibility (false to omit)
1631 * @return string HTML headline
1633 public static function makeHeadline( $level, $attribs, $anchor, $html,
1634 $link, $fallbackAnchor = false
1636 $anchorEscaped = htmlspecialchars( $anchor );
1638 if ( $fallbackAnchor !== false && $fallbackAnchor !== $anchor ) {
1639 $fallbackAnchor = htmlspecialchars( $fallbackAnchor );
1640 $fallback = "<span id=\"$fallbackAnchor\"></span>";
1642 $ret = "<h$level$attribs"
1643 . "$fallback<span class=\"mw-headline\" id=\"$anchorEscaped\">$html</span>"
1651 * Split a link trail, return the "inside" portion and the remainder of the trail
1652 * as a two-element array
1653 * @param string $trail
1656 static function splitTrail( $trail ) {
1658 $regex = $wgContLang->linkTrail();
1660 if ( $trail !== '' ) {
1662 if ( preg_match( $regex, $trail, $m ) ) {
1667 return [ $inside, $trail ];
1671 * Generate a rollback link for a given revision. Currently it's the
1672 * caller's responsibility to ensure that the revision is the top one. If
1673 * it's not, of course, the user will get an error message.
1675 * If the calling page is called with the parameter &bot=1, all rollback
1676 * links also get that parameter. It causes the edit itself and the rollback
1677 * to be marked as "bot" edits. Bot edits are hidden by default from recent
1678 * changes, so this allows sysops to combat a busy vandal without bothering
1681 * If the option verify is set this function will return the link only in case the
1682 * revision can be reverted. Please note that due to performance limitations
1683 * it might be assumed that a user isn't the only contributor of a page while
1684 * (s)he is, which will lead to useless rollback links. Furthermore this wont
1685 * work if $wgShowRollbackEditCount is disabled, so this can only function
1686 * as an additional check.
1688 * If the option noBrackets is set the rollback link wont be enclosed in "[]".
1690 * @since 1.16.3. $context added in 1.20. $options added in 1.21
1692 * @param Revision $rev
1693 * @param IContextSource|null $context Context to use or null for the main context.
1694 * @param array $options
1697 public static function generateRollback( $rev, IContextSource
$context = null,
1698 $options = [ 'verify' ]
1700 if ( $context === null ) {
1701 $context = RequestContext
::getMain();
1705 if ( in_array( 'verify', $options, true ) ) {
1706 $editCount = self
::getRollbackEditCount( $rev, true );
1707 if ( $editCount === false ) {
1712 $inner = self
::buildRollbackLink( $rev, $context, $editCount );
1714 if ( !in_array( 'noBrackets', $options, true ) ) {
1715 $inner = $context->msg( 'brackets' )->rawParams( $inner )->escaped();
1718 return '<span class="mw-rollback-link">' . $inner . '</span>';
1722 * This function will return the number of revisions which a rollback
1723 * would revert and, if $verify is set it will verify that a revision
1724 * can be reverted (that the user isn't the only contributor and the
1725 * revision we might rollback to isn't deleted). These checks can only
1726 * function as an additional check as this function only checks against
1727 * the last $wgShowRollbackEditCount edits.
1729 * Returns null if $wgShowRollbackEditCount is disabled or false if $verify
1730 * is set and the user is the only contributor of the page.
1732 * @param Revision $rev
1733 * @param bool $verify Try to verify that this revision can really be rolled back
1734 * @return int|bool|null
1736 public static function getRollbackEditCount( $rev, $verify ) {
1737 global $wgShowRollbackEditCount;
1738 if ( !is_int( $wgShowRollbackEditCount ) ||
!$wgShowRollbackEditCount > 0 ) {
1739 // Nothing has happened, indicate this by returning 'null'
1743 $dbr = wfGetDB( DB_REPLICA
);
1745 // Up to the value of $wgShowRollbackEditCount revisions are counted
1746 $revQuery = Revision
::getQueryInfo();
1747 $res = $dbr->select(
1748 $revQuery['tables'],
1749 [ 'rev_user_text' => $revQuery['fields']['rev_user_text'], 'rev_deleted' ],
1750 // $rev->getPage() returns null sometimes
1751 [ 'rev_page' => $rev->getTitle()->getArticleID() ],
1754 'USE INDEX' => [ 'revision' => 'page_timestamp' ],
1755 'ORDER BY' => 'rev_timestamp DESC',
1756 'LIMIT' => $wgShowRollbackEditCount +
1
1763 foreach ( $res as $row ) {
1764 if ( $rev->getUserText( Revision
::RAW
) != $row->rev_user_text
) {
1766 ( $row->rev_deleted
& Revision
::DELETED_TEXT
1767 ||
$row->rev_deleted
& Revision
::DELETED_USER
1769 // If the user or the text of the revision we might rollback
1770 // to is deleted in some way we can't rollback. Similar to
1771 // the sanity checks in WikiPage::commitRollback.
1780 if ( $verify && $editCount <= $wgShowRollbackEditCount && !$moreRevs ) {
1781 // We didn't find at least $wgShowRollbackEditCount revisions made by the current user
1782 // and there weren't any other revisions. That means that the current user is the only
1783 // editor, so we can't rollback
1790 * Build a raw rollback link, useful for collections of "tool" links
1792 * @since 1.16.3. $context added in 1.20. $editCount added in 1.21
1793 * @param Revision $rev
1794 * @param IContextSource|null $context Context to use or null for the main context.
1795 * @param int $editCount Number of edits that would be reverted
1796 * @return string HTML fragment
1798 public static function buildRollbackLink( $rev, IContextSource
$context = null,
1801 global $wgShowRollbackEditCount, $wgMiserMode;
1803 // To config which pages are affected by miser mode
1804 $disableRollbackEditCountSpecialPage = [ 'Recentchanges', 'Watchlist' ];
1806 if ( $context === null ) {
1807 $context = RequestContext
::getMain();
1810 $title = $rev->getTitle();
1812 'action' => 'rollback',
1813 'from' => $rev->getUserText(),
1814 'token' => $context->getUser()->getEditToken( 'rollback' ),
1817 'data-mw' => 'interface',
1818 'title' => $context->msg( 'tooltip-rollback' )->text(),
1820 $options = [ 'known', 'noclasses' ];
1822 if ( $context->getRequest()->getBool( 'bot' ) ) {
1823 $query['bot'] = '1';
1824 $query['hidediff'] = '1'; // T17999
1827 $disableRollbackEditCount = false;
1828 if ( $wgMiserMode ) {
1829 foreach ( $disableRollbackEditCountSpecialPage as $specialPage ) {
1830 if ( $context->getTitle()->isSpecial( $specialPage ) ) {
1831 $disableRollbackEditCount = true;
1837 if ( !$disableRollbackEditCount
1838 && is_int( $wgShowRollbackEditCount )
1839 && $wgShowRollbackEditCount > 0
1841 if ( !is_numeric( $editCount ) ) {
1842 $editCount = self
::getRollbackEditCount( $rev, false );
1845 if ( $editCount > $wgShowRollbackEditCount ) {
1846 $html = $context->msg( 'rollbacklinkcount-morethan' )
1847 ->numParams( $wgShowRollbackEditCount )->parse();
1849 $html = $context->msg( 'rollbacklinkcount' )->numParams( $editCount )->parse();
1852 return self
::link( $title, $html, $attrs, $query, $options );
1854 $html = $context->msg( 'rollbacklink' )->escaped();
1855 return self
::link( $title, $html, $attrs, $query, $options );
1860 * @deprecated since 1.28, use TemplatesOnThisPageFormatter directly
1862 * Returns HTML for the "templates used on this page" list.
1864 * Make an HTML list of templates, and then add a "More..." link at
1865 * the bottom. If $more is null, do not add a "More..." link. If $more
1866 * is a Title, make a link to that title and use it. If $more is a string,
1867 * directly paste it in as the link (escaping needs to be done manually).
1868 * Finally, if $more is a Message, call toString().
1870 * @since 1.16.3. $more added in 1.21
1871 * @param Title[] $templates Array of templates
1872 * @param bool $preview Whether this is for a preview
1873 * @param bool $section Whether this is for a section edit
1874 * @param Title|Message|string|null $more An escaped link for "More..." of the templates
1875 * @return string HTML output
1877 public static function formatTemplates( $templates, $preview = false,
1878 $section = false, $more = null
1880 wfDeprecated( __METHOD__
, '1.28' );
1885 } elseif ( $section ) {
1889 if ( $more instanceof Message
) {
1890 $more = $more->toString();
1893 $formatter = new TemplatesOnThisPageFormatter(
1894 RequestContext
::getMain(),
1895 MediaWikiServices
::getInstance()->getLinkRenderer()
1897 return $formatter->format( $templates, $type, $more );
1901 * Returns HTML for the "hidden categories on this page" list.
1904 * @param array $hiddencats Array of hidden categories from Article::getHiddenCategories
1906 * @return string HTML output
1908 public static function formatHiddenCategories( $hiddencats ) {
1910 if ( count( $hiddencats ) > 0 ) {
1911 # Construct the HTML
1912 $outText = '<div class="mw-hiddenCategoriesExplanation">';
1913 $outText .= wfMessage( 'hiddencategories' )->numParams( count( $hiddencats ) )->parseAsBlock();
1914 $outText .= "</div><ul>\n";
1916 foreach ( $hiddencats as $titleObj ) {
1917 # If it's hidden, it must exist - no need to check with a LinkBatch
1919 . self
::link( $titleObj, null, [], [], 'known' )
1922 $outText .= '</ul>';
1928 * @deprecated since 1.28, use Language::formatSize() directly
1930 * Format a size in bytes for output, using an appropriate
1931 * unit (B, KB, MB or GB) according to the magnitude in question
1934 * @param int $size Size to format
1937 public static function formatSize( $size ) {
1938 wfDeprecated( __METHOD__
, '1.28' );
1941 return htmlspecialchars( $wgLang->formatSize( $size ) );
1945 * Given the id of an interface element, constructs the appropriate title
1946 * attribute from the system messages. (Note, this is usually the id but
1947 * isn't always, because sometimes the accesskey needs to go on a different
1948 * element than the id, for reverse-compatibility, etc.)
1950 * @since 1.16.3 $msgParams added in 1.27
1951 * @param string $name Id of the element, minus prefixes.
1952 * @param string|array|null $options Null, string or array with some of the following options:
1953 * - 'withaccess' to add an access-key hint
1954 * - 'nonexisting' to add an accessibility hint that page does not exist
1955 * @param array $msgParams Parameters to pass to the message
1957 * @return string Contents of the title attribute (which you must HTML-
1958 * escape), or false for no title attribute
1960 public static function titleAttrib( $name, $options = null, array $msgParams = [] ) {
1961 $message = wfMessage( "tooltip-$name", $msgParams );
1962 if ( !$message->exists() ) {
1965 $tooltip = $message->text();
1966 # Compatibility: formerly some tooltips had [alt-.] hardcoded
1967 $tooltip = preg_replace( "/ ?\[alt-.\]$/", '', $tooltip );
1968 # Message equal to '-' means suppress it.
1969 if ( $tooltip == '-' ) {
1974 $options = (array)$options;
1976 if ( in_array( 'nonexisting', $options ) ) {
1977 $tooltip = wfMessage( 'red-link-title', $tooltip ?
: '' )->text();
1979 if ( in_array( 'withaccess', $options ) ) {
1980 $accesskey = self
::accesskey( $name );
1981 if ( $accesskey !== false ) {
1982 // Should be build the same as in jquery.accessKeyLabel.js
1983 if ( $tooltip === false ||
$tooltip === '' ) {
1984 $tooltip = wfMessage( 'brackets', $accesskey )->text();
1986 $tooltip .= wfMessage( 'word-separator' )->text();
1987 $tooltip .= wfMessage( 'brackets', $accesskey )->text();
1995 public static $accesskeycache;
1998 * Given the id of an interface element, constructs the appropriate
1999 * accesskey attribute from the system messages. (Note, this is usually
2000 * the id but isn't always, because sometimes the accesskey needs to go on
2001 * a different element than the id, for reverse-compatibility, etc.)
2004 * @param string $name Id of the element, minus prefixes.
2005 * @return string Contents of the accesskey attribute (which you must HTML-
2006 * escape), or false for no accesskey attribute
2008 public static function accesskey( $name ) {
2009 if ( isset( self
::$accesskeycache[$name] ) ) {
2010 return self
::$accesskeycache[$name];
2013 $message = wfMessage( "accesskey-$name" );
2015 if ( !$message->exists() ) {
2018 $accesskey = $message->plain();
2019 if ( $accesskey === '' ||
$accesskey === '-' ) {
2020 # @todo FIXME: Per standard MW behavior, a value of '-' means to suppress the
2021 # attribute, but this is broken for accesskey: that might be a useful
2027 self
::$accesskeycache[$name] = $accesskey;
2028 return self
::$accesskeycache[$name];
2032 * Get a revision-deletion link, or disabled link, or nothing, depending
2033 * on user permissions & the settings on the revision.
2035 * Will use forward-compatible revision ID in the Special:RevDelete link
2036 * if possible, otherwise the timestamp-based ID which may break after
2040 * @param Revision $rev
2041 * @param Title $title
2042 * @return string HTML fragment
2044 public static function getRevDeleteLink( User
$user, Revision
$rev, Title
$title ) {
2045 $canHide = $user->isAllowed( 'deleterevision' );
2046 if ( !$canHide && !( $rev->getVisibility() && $user->isAllowed( 'deletedhistory' ) ) ) {
2050 if ( !$rev->userCan( Revision
::DELETED_RESTRICTED
, $user ) ) {
2051 return self
::revDeleteLinkDisabled( $canHide ); // revision was hidden from sysops
2053 if ( $rev->getId() ) {
2054 // RevDelete links using revision ID are stable across
2055 // page deletion and undeletion; use when possible.
2057 'type' => 'revision',
2058 'target' => $title->getPrefixedDBkey(),
2059 'ids' => $rev->getId()
2062 // Older deleted entries didn't save a revision ID.
2063 // We have to refer to these by timestamp, ick!
2065 'type' => 'archive',
2066 'target' => $title->getPrefixedDBkey(),
2067 'ids' => $rev->getTimestamp()
2070 return self
::revDeleteLink( $query,
2071 $rev->isDeleted( Revision
::DELETED_RESTRICTED
), $canHide );
2076 * Creates a (show/hide) link for deleting revisions/log entries
2078 * @param array $query Query parameters to be passed to link()
2079 * @param bool $restricted Set to true to use a "<strong>" instead of a "<span>"
2080 * @param bool $delete Set to true to use (show/hide) rather than (show)
2082 * @return string HTML "<a>" link to Special:Revisiondelete, wrapped in a
2083 * span to allow for customization of appearance with CSS
2085 public static function revDeleteLink( $query = [], $restricted = false, $delete = true ) {
2086 $sp = SpecialPage
::getTitleFor( 'Revisiondelete' );
2087 $msgKey = $delete ?
'rev-delundel' : 'rev-showdeleted';
2088 $html = wfMessage( $msgKey )->escaped();
2089 $tag = $restricted ?
'strong' : 'span';
2090 $link = self
::link( $sp, $html, [], $query, [ 'known', 'noclasses' ] );
2093 [ 'class' => 'mw-revdelundel-link' ],
2094 wfMessage( 'parentheses' )->rawParams( $link )->escaped()
2099 * Creates a dead (show/hide) link for deleting revisions/log entries
2102 * @param bool $delete Set to true to use (show/hide) rather than (show)
2104 * @return string HTML text wrapped in a span to allow for customization
2105 * of appearance with CSS
2107 public static function revDeleteLinkDisabled( $delete = true ) {
2108 $msgKey = $delete ?
'rev-delundel' : 'rev-showdeleted';
2109 $html = wfMessage( $msgKey )->escaped();
2110 $htmlParentheses = wfMessage( 'parentheses' )->rawParams( $html )->escaped();
2111 return Xml
::tags( 'span', [ 'class' => 'mw-revdelundel-link' ], $htmlParentheses );
2115 * Returns the attributes for the tooltip and access key.
2117 * @since 1.16.3. $msgParams introduced in 1.27
2118 * @param string $name
2119 * @param array $msgParams Params for constructing the message
2120 * @param string|array|null $options Options to be passed to titleAttrib.
2122 * @see Linker::titleAttrib for what options could be passed to $options.
2126 public static function tooltipAndAccesskeyAttribs(
2128 array $msgParams = [],
2131 $options = (array)$options;
2132 $options[] = 'withaccess';
2135 'title' => self
::titleAttrib( $name, $options, $msgParams ),
2136 'accesskey' => self
::accesskey( $name )
2138 if ( $attribs['title'] === false ) {
2139 unset( $attribs['title'] );
2141 if ( $attribs['accesskey'] === false ) {
2142 unset( $attribs['accesskey'] );
2148 * Returns raw bits of HTML, use titleAttrib()
2150 * @param string $name
2151 * @param array|null $options
2152 * @return null|string
2154 public static function tooltip( $name, $options = null ) {
2155 $tooltip = self
::titleAttrib( $name, $options );
2156 if ( $tooltip === false ) {
2159 return Xml
::expandAttributes( [