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 * Get the appropriate HTML attributes to add to the "a" element of an interwiki link.
45 * @deprecated since 1.25
47 * @param string $title The title text for the link, URL-encoded (???) but
49 * @param string $unused Unused
50 * @param string $class The contents of the class attribute; if an empty
51 * string is passed, which is the default value, defaults to 'external'.
54 static function getInterwikiLinkAttributes( $title, $unused = null, $class = 'external' ) {
57 wfDeprecated( __METHOD__
, '1.25' );
59 # @todo FIXME: We have a whole bunch of handling here that doesn't happen in
60 # getExternalLinkAttributes, why?
61 $title = urldecode( $title );
62 $title = $wgContLang->checkTitleEncoding( $title );
63 $title = preg_replace( '/[\\x00-\\x1f]/', ' ', $title );
65 return self
::getLinkAttributesInternal( $title, $class );
69 * Get the appropriate HTML attributes to add to the "a" element of an internal link.
72 * @deprecated since 1.25
74 * @param string $title The title text for the link, URL-encoded (???) but
76 * @param string $unused Unused
77 * @param string $class The contents of the class attribute, default none
80 static function getInternalLinkAttributes( $title, $unused = null, $class = '' ) {
81 wfDeprecated( __METHOD__
, '1.25' );
83 $title = urldecode( $title );
84 $title = strtr( $title, '_', ' ' );
85 return self
::getLinkAttributesInternal( $title, $class );
89 * Get the appropriate HTML attributes to add to the "a" element of an internal
90 * link, given the Title object for the page we want to link to.
93 * @deprecated since 1.25
96 * @param string $unused Unused
97 * @param string $class The contents of the class attribute, default none
98 * @param string|bool $title Optional (unescaped) string to use in the title
99 * attribute; if false, default to the name of the page we're linking to
102 static function getInternalLinkAttributesObj( $nt, $unused = null, $class = '', $title = false ) {
103 wfDeprecated( __METHOD__
, '1.25' );
105 if ( $title === false ) {
106 $title = $nt->getPrefixedText();
108 return self
::getLinkAttributesInternal( $title, $class );
112 * Common code for getLinkAttributesX functions
115 * @deprecated since 1.25
117 * @param string $title
118 * @param string $class
122 private static function getLinkAttributesInternal( $title, $class ) {
123 wfDeprecated( __METHOD__
, '1.25' );
125 $title = htmlspecialchars( $title );
126 $class = htmlspecialchars( $class );
128 if ( $class != '' ) {
129 $r .= " class=\"$class\"";
131 if ( $title != '' ) {
132 $r .= " title=\"$title\"";
138 * Return the CSS colour of a known link
140 * @deprecated since 1.28, use LinkRenderer::getLinkClasses() instead
143 * @param LinkTarget $t
144 * @param int $threshold User defined threshold
145 * @return string CSS class
147 public static function getLinkColour( LinkTarget
$t, $threshold ) {
148 wfDeprecated( __METHOD__
, '1.28' );
149 $services = MediaWikiServices
::getInstance();
150 $linkRenderer = $services->getLinkRenderer();
151 if ( $threshold !== $linkRenderer->getStubThreshold() ) {
152 // Need to create a new instance with the right stub threshold...
153 $linkRenderer = $services->getLinkRendererFactory()->create();
154 $linkRenderer->setStubThreshold( $threshold );
157 return $linkRenderer->getLinkClasses( $t );
161 * This function returns an HTML link to the given target. It serves a few
163 * 1) If $target is a Title, the correct URL to link to will be figured
165 * 2) It automatically adds the usual classes for various types of link
166 * targets: "new" for red links, "stub" for short articles, etc.
167 * 3) It escapes all attribute values safely so there's no risk of XSS.
168 * 4) It provides a default tooltip if the target is a Title (the page
169 * name of the target).
170 * link() replaces the old functions in the makeLink() family.
172 * @since 1.18 Method exists since 1.16 as non-static, made static in 1.18.
173 * @deprecated since 1.28, use MediaWiki\Linker\LinkRenderer instead
175 * @param Title $target Can currently only be a Title, but this may
176 * change to support Images, literal URLs, etc.
177 * @param string $html The HTML contents of the <a> element, i.e.,
178 * the link text. This is raw HTML and will not be escaped. If null,
179 * defaults to the prefixed text of the Title; or if the Title is just a
180 * fragment, the contents of the fragment.
181 * @param array $customAttribs A key => value array of extra HTML attributes,
182 * such as title and class. (href is ignored.) Classes will be
183 * merged with the default classes, while other attributes will replace
184 * default attributes. All passed attribute values will be HTML-escaped.
185 * A false attribute value means to suppress that attribute.
186 * @param array $query The query string to append to the URL
187 * you're linking to, in key => value array form. Query keys and values
188 * will be URL-encoded.
189 * @param string|array $options String or array of strings:
190 * 'known': Page is known to exist, so don't check if it does.
191 * 'broken': Page is known not to exist, so don't check if it does.
192 * 'noclasses': Don't add any classes automatically (includes "new",
193 * "stub", "mw-redirect", "extiw"). Only use the class attribute
194 * provided, if any, so you get a simple blue link with no funny i-
196 * 'forcearticlepath': Use the article path always, even with a querystring.
197 * Has compatibility issues on some setups, so avoid wherever possible.
198 * 'http': Force a full URL with http:// as the scheme.
199 * 'https': Force a full URL with https:// as the scheme.
200 * 'stubThreshold' => (int): Stub threshold to use when determining link classes.
201 * @return string HTML <a> attribute
203 public static function link(
204 $target, $html = null, $customAttribs = [], $query = [], $options = []
206 if ( !$target instanceof Title
) {
207 wfWarn( __METHOD__
. ': Requires $target to be a Title object.', 2 );
208 return "<!-- ERROR -->$html";
211 if ( is_string( $query ) ) {
212 // some functions withing core using this still hand over query strings
213 wfDeprecated( __METHOD__
. ' with parameter $query as string (should be array)', '1.20' );
214 $query = wfCgiToArray( $query );
217 $services = MediaWikiServices
::getInstance();
218 $options = (array)$options;
220 // Custom options, create new LinkRenderer
221 if ( !isset( $options['stubThreshold'] ) ) {
222 $defaultLinkRenderer = $services->getLinkRenderer();
223 $options['stubThreshold'] = $defaultLinkRenderer->getStubThreshold();
225 $linkRenderer = $services->getLinkRendererFactory()
226 ->createFromLegacyOptions( $options );
228 $linkRenderer = $services->getLinkRenderer();
231 if ( $html !== null ) {
232 $text = new HtmlArmor( $html );
234 $text = $html; // null
236 if ( in_array( 'known', $options, true ) ) {
237 return $linkRenderer->makeKnownLink( $target, $text, $customAttribs, $query );
238 } elseif ( in_array( 'broken', $options, true ) ) {
239 return $linkRenderer->makeBrokenLink( $target, $text, $customAttribs, $query );
240 } elseif ( in_array( 'noclasses', $options, true ) ) {
241 return $linkRenderer->makePreloadedLink( $target, $text, '', $customAttribs, $query );
243 return $linkRenderer->makeLink( $target, $text, $customAttribs, $query );
248 * Identical to link(), except $options defaults to 'known'.
251 * @deprecated since 1.28, use MediaWiki\Linker\LinkRenderer instead
255 public static function linkKnown(
256 $target, $html = null, $customAttribs = [],
257 $query = [], $options = [ 'known' ]
259 return self
::link( $target, $html, $customAttribs, $query, $options );
263 * Make appropriate markup for a link to the current article. This is
264 * currently rendered as the bold link text. The calling sequence is the
265 * same as the other make*LinkObj static functions, despite $query not
270 * @param string $html [optional]
271 * @param string $query [optional]
272 * @param string $trail [optional]
273 * @param string $prefix [optional]
277 public static function makeSelfLinkObj( $nt, $html = '', $query = '', $trail = '', $prefix = '' ) {
278 $ret = "<strong class=\"selflink\">{$prefix}{$html}</strong>{$trail}";
279 if ( !Hooks
::run( 'SelfLinkBegin', [ $nt, &$html, &$trail, &$prefix, &$ret ] ) ) {
284 $html = htmlspecialchars( $nt->getPrefixedText() );
286 list( $inside, $trail ) = self
::splitTrail( $trail );
287 return "<strong class=\"selflink\">{$prefix}{$html}{$inside}</strong>{$trail}";
291 * Get a message saying that an invalid title was encountered.
292 * This should be called after a method like Title::makeTitleSafe() returned
293 * a value indicating that the title object is invalid.
295 * @param IContextSource $context Context to use to get the messages
296 * @param int $namespace Namespace number
297 * @param string $title Text of the title, without the namespace part
300 public static function getInvalidTitleDescription( IContextSource
$context, $namespace, $title ) {
303 // First we check whether the namespace exists or not.
304 if ( MWNamespace
::exists( $namespace ) ) {
305 if ( $namespace == NS_MAIN
) {
306 $name = $context->msg( 'blanknamespace' )->text();
308 $name = $wgContLang->getFormattedNsText( $namespace );
310 return $context->msg( 'invalidtitle-knownnamespace', $namespace, $name, $title )->text();
312 return $context->msg( 'invalidtitle-unknownnamespace', $namespace, $title )->text();
318 * @param LinkTarget $target
321 public static function normaliseSpecialPage( LinkTarget
$target ) {
322 if ( $target->getNamespace() == NS_SPECIAL
) {
323 list( $name, $subpage ) = SpecialPageFactory
::resolveAlias( $target->getDBkey() );
327 $ret = SpecialPage
::getTitleValueFor( $name, $subpage, $target->getFragment() );
335 * Returns the filename part of an url.
336 * Used as alternative text for external images.
342 private static function fnamePart( $url ) {
343 $basename = strrchr( $url, '/' );
344 if ( false === $basename ) {
347 $basename = substr( $basename, 1 );
353 * Return the code for images which were added via external links,
354 * via Parser::maybeMakeExternalImage().
362 public static function makeExternalImage( $url, $alt = '' ) {
364 $alt = self
::fnamePart( $url );
367 $success = Hooks
::run( 'LinkerMakeExternalImage', [ &$url, &$alt, &$img ] );
369 wfDebug( "Hook LinkerMakeExternalImage changed the output of external image "
370 . "with url {$url} and alt text {$alt} to {$img}\n", true );
373 return Html
::element( 'img',
380 * Given parameters derived from [[Image:Foo|options...]], generate the
381 * HTML that that syntax inserts in the page.
383 * @param Parser $parser
384 * @param Title $title Title object of the file (not the currently viewed page)
385 * @param File $file File object, or false if it doesn't exist
386 * @param array $frameParams Associative array of parameters external to the media handler.
387 * Boolean parameters are indicated by presence or absence, the value is arbitrary and
388 * will often be false.
389 * thumbnail If present, downscale and frame
390 * manualthumb Image name to use as a thumbnail, instead of automatic scaling
391 * framed Shows image in original size in a frame
392 * frameless Downscale but don't frame
393 * upright If present, tweak default sizes for portrait orientation
394 * upright_factor Fudge factor for "upright" tweak (default 0.75)
395 * border If present, show a border around the image
396 * align Horizontal alignment (left, right, center, none)
397 * valign Vertical alignment (baseline, sub, super, top, text-top, middle,
398 * bottom, text-bottom)
399 * alt Alternate text for image (i.e. alt attribute). Plain text.
400 * class HTML for image classes. Plain text.
401 * caption HTML for image caption.
402 * link-url URL to link to
403 * link-title Title object to link to
404 * link-target Value for the target attribute, only with link-url
405 * no-link Boolean, suppress description link
407 * @param array $handlerParams Associative array of media handler parameters, to be passed
408 * to transform(). Typical keys are "width" and "page".
409 * @param string|bool $time Timestamp of the file, set as false for current
410 * @param string $query Query params for desc url
411 * @param int|null $widthOption Used by the parser to remember the user preference thumbnailsize
413 * @return string HTML for an image, with links, wrappers, etc.
415 public static function makeImageLink( Parser
$parser, Title
$title,
416 $file, $frameParams = [], $handlerParams = [], $time = false,
417 $query = "", $widthOption = null
420 $dummy = new DummyLinker
;
421 if ( !Hooks
::run( 'ImageBeforeProduceHTML', [ &$dummy, &$title,
422 &$file, &$frameParams, &$handlerParams, &$time, &$res ] ) ) {
426 if ( $file && !$file->allowInlineDisplay() ) {
427 wfDebug( __METHOD__
. ': ' . $title->getPrefixedDBkey() . " does not allow inline display\n" );
428 return self
::link( $title );
431 // Clean up parameters
432 $page = isset( $handlerParams['page'] ) ?
$handlerParams['page'] : false;
433 if ( !isset( $frameParams['align'] ) ) {
434 $frameParams['align'] = '';
436 if ( !isset( $frameParams['alt'] ) ) {
437 $frameParams['alt'] = '';
439 if ( !isset( $frameParams['title'] ) ) {
440 $frameParams['title'] = '';
442 if ( !isset( $frameParams['class'] ) ) {
443 $frameParams['class'] = '';
446 $prefix = $postfix = '';
448 if ( 'center' == $frameParams['align'] ) {
449 $prefix = '<div class="center">';
451 $frameParams['align'] = 'none';
453 if ( $file && !isset( $handlerParams['width'] ) ) {
454 if ( isset( $handlerParams['height'] ) && $file->isVectorized() ) {
455 // If its a vector image, and user only specifies height
456 // we don't want it to be limited by its "normal" width.
457 global $wgSVGMaxSize;
458 $handlerParams['width'] = $wgSVGMaxSize;
460 $handlerParams['width'] = $file->getWidth( $page );
463 if ( isset( $frameParams['thumbnail'] )
464 ||
isset( $frameParams['manualthumb'] )
465 ||
isset( $frameParams['framed'] )
466 ||
isset( $frameParams['frameless'] )
467 ||
!$handlerParams['width']
469 global $wgThumbLimits, $wgThumbUpright;
471 if ( $widthOption === null ||
!isset( $wgThumbLimits[$widthOption] ) ) {
472 $widthOption = User
::getDefaultOption( 'thumbsize' );
475 // Reduce width for upright images when parameter 'upright' is used
476 if ( isset( $frameParams['upright'] ) && $frameParams['upright'] == 0 ) {
477 $frameParams['upright'] = $wgThumbUpright;
480 // For caching health: If width scaled down due to upright
481 // parameter, round to full __0 pixel to avoid the creation of a
482 // lot of odd thumbs.
483 $prefWidth = isset( $frameParams['upright'] ) ?
484 round( $wgThumbLimits[$widthOption] * $frameParams['upright'], -1 ) :
485 $wgThumbLimits[$widthOption];
487 // Use width which is smaller: real image width or user preference width
488 // Unless image is scalable vector.
489 if ( !isset( $handlerParams['height'] ) && ( $handlerParams['width'] <= 0 ||
490 $prefWidth < $handlerParams['width'] ||
$file->isVectorized() ) ) {
491 $handlerParams['width'] = $prefWidth;
496 if ( isset( $frameParams['thumbnail'] ) ||
isset( $frameParams['manualthumb'] )
497 ||
isset( $frameParams['framed'] )
499 # Create a thumbnail. Alignment depends on the writing direction of
500 # the page content language (right-aligned for LTR languages,
501 # left-aligned for RTL languages)
502 # If a thumbnail width has not been provided, it is set
503 # to the default user option as specified in Language*.php
504 if ( $frameParams['align'] == '' ) {
505 $frameParams['align'] = $parser->getTargetLanguage()->alignEnd();
508 self
::makeThumbLink2( $title, $file, $frameParams, $handlerParams, $time, $query ) .
512 if ( $file && isset( $frameParams['frameless'] ) ) {
513 $srcWidth = $file->getWidth( $page );
514 # For "frameless" option: do not present an image bigger than the
515 # source (for bitmap-style images). This is the same behavior as the
516 # "thumb" option does it already.
517 if ( $srcWidth && !$file->mustRender() && $handlerParams['width'] > $srcWidth ) {
518 $handlerParams['width'] = $srcWidth;
522 if ( $file && isset( $handlerParams['width'] ) ) {
523 # Create a resized image, without the additional thumbnail features
524 $thumb = $file->transform( $handlerParams );
530 $s = self
::makeBrokenImageLinkObj( $title, $frameParams['title'], '', '', '', $time == true );
532 self
::processResponsiveImages( $file, $thumb, $handlerParams );
534 'alt' => $frameParams['alt'],
535 'title' => $frameParams['title'],
536 'valign' => isset( $frameParams['valign'] ) ?
$frameParams['valign'] : false,
537 'img-class' => $frameParams['class'] ];
538 if ( isset( $frameParams['border'] ) ) {
539 $params['img-class'] .= ( $params['img-class'] !== '' ?
' ' : '' ) . 'thumbborder';
541 $params = self
::getImageLinkMTOParams( $frameParams, $query, $parser ) +
$params;
543 $s = $thumb->toHtml( $params );
545 if ( $frameParams['align'] != '' ) {
546 $s = "<div class=\"float{$frameParams['align']}\">{$s}</div>";
548 return str_replace( "\n", ' ', $prefix . $s . $postfix );
552 * Get the link parameters for MediaTransformOutput::toHtml() from given
553 * frame parameters supplied by the Parser.
554 * @param array $frameParams The frame parameters
555 * @param string $query An optional query string to add to description page links
556 * @param Parser|null $parser
559 private static function getImageLinkMTOParams( $frameParams, $query = '', $parser = null ) {
561 if ( isset( $frameParams['link-url'] ) && $frameParams['link-url'] !== '' ) {
562 $mtoParams['custom-url-link'] = $frameParams['link-url'];
563 if ( isset( $frameParams['link-target'] ) ) {
564 $mtoParams['custom-target-link'] = $frameParams['link-target'];
567 $extLinkAttrs = $parser->getExternalLinkAttribs( $frameParams['link-url'] );
568 foreach ( $extLinkAttrs as $name => $val ) {
569 // Currently could include 'rel' and 'target'
570 $mtoParams['parser-extlink-' . $name] = $val;
573 } elseif ( isset( $frameParams['link-title'] ) && $frameParams['link-title'] !== '' ) {
574 $mtoParams['custom-title-link'] = Title
::newFromLinkTarget(
575 self
::normaliseSpecialPage( $frameParams['link-title'] )
577 } elseif ( !empty( $frameParams['no-link'] ) ) {
580 $mtoParams['desc-link'] = true;
581 $mtoParams['desc-query'] = $query;
587 * Make HTML for a thumbnail including image, border and caption
588 * @param Title $title
589 * @param File|bool $file File object or false if it doesn't exist
590 * @param string $label
592 * @param string $align
593 * @param array $params
594 * @param bool $framed
595 * @param string $manualthumb
598 public static function makeThumbLinkObj( Title
$title, $file, $label = '', $alt,
599 $align = 'right', $params = [], $framed = false, $manualthumb = ""
607 $frameParams['framed'] = true;
609 if ( $manualthumb ) {
610 $frameParams['manualthumb'] = $manualthumb;
612 return self
::makeThumbLink2( $title, $file, $frameParams, $params );
616 * @param Title $title
618 * @param array $frameParams
619 * @param array $handlerParams
621 * @param string $query
624 public static function makeThumbLink2( Title
$title, $file, $frameParams = [],
625 $handlerParams = [], $time = false, $query = ""
627 $exists = $file && $file->exists();
629 $page = isset( $handlerParams['page'] ) ?
$handlerParams['page'] : false;
630 if ( !isset( $frameParams['align'] ) ) {
631 $frameParams['align'] = 'right';
633 if ( !isset( $frameParams['alt'] ) ) {
634 $frameParams['alt'] = '';
636 if ( !isset( $frameParams['title'] ) ) {
637 $frameParams['title'] = '';
639 if ( !isset( $frameParams['caption'] ) ) {
640 $frameParams['caption'] = '';
643 if ( empty( $handlerParams['width'] ) ) {
644 // Reduce width for upright images when parameter 'upright' is used
645 $handlerParams['width'] = isset( $frameParams['upright'] ) ?
130 : 180;
649 $manualthumb = false;
652 $outerWidth = $handlerParams['width'] +
2;
654 if ( isset( $frameParams['manualthumb'] ) ) {
655 # Use manually specified thumbnail
656 $manual_title = Title
::makeTitleSafe( NS_FILE
, $frameParams['manualthumb'] );
657 if ( $manual_title ) {
658 $manual_img = wfFindFile( $manual_title );
660 $thumb = $manual_img->getUnscaledThumb( $handlerParams );
666 } elseif ( isset( $frameParams['framed'] ) ) {
667 // Use image dimensions, don't scale
668 $thumb = $file->getUnscaledThumb( $handlerParams );
671 # Do not present an image bigger than the source, for bitmap-style images
672 # This is a hack to maintain compatibility with arbitrary pre-1.10 behavior
673 $srcWidth = $file->getWidth( $page );
674 if ( $srcWidth && !$file->mustRender() && $handlerParams['width'] > $srcWidth ) {
675 $handlerParams['width'] = $srcWidth;
677 $thumb = $file->transform( $handlerParams );
681 $outerWidth = $thumb->getWidth() +
2;
683 $outerWidth = $handlerParams['width'] +
2;
687 # ThumbnailImage::toHtml() already adds page= onto the end of DjVu URLs
688 # So we don't need to pass it here in $query. However, the URL for the
689 # zoom icon still needs it, so we make a unique query for it. See bug 14771
690 $url = $title->getLocalURL( $query );
692 $url = wfAppendQuery( $url, [ 'page' => $page ] );
695 && !isset( $frameParams['link-title'] )
696 && !isset( $frameParams['link-url'] )
697 && !isset( $frameParams['no-link'] ) ) {
698 $frameParams['link-url'] = $url;
701 $s = "<div class=\"thumb t{$frameParams['align']}\">"
702 . "<div class=\"thumbinner\" style=\"width:{$outerWidth}px;\">";
705 $s .= self
::makeBrokenImageLinkObj( $title, $frameParams['title'], '', '', '', $time == true );
707 } elseif ( !$thumb ) {
708 $s .= wfMessage( 'thumbnail_error', '' )->escaped();
711 if ( !$noscale && !$manualthumb ) {
712 self
::processResponsiveImages( $file, $thumb, $handlerParams );
715 'alt' => $frameParams['alt'],
716 'title' => $frameParams['title'],
717 'img-class' => ( isset( $frameParams['class'] ) && $frameParams['class'] !== ''
718 ?
$frameParams['class'] . ' '
719 : '' ) . 'thumbimage'
721 $params = self
::getImageLinkMTOParams( $frameParams, $query ) +
$params;
722 $s .= $thumb->toHtml( $params );
723 if ( isset( $frameParams['framed'] ) ) {
726 $zoomIcon = Html
::rawElement( 'div', [ 'class' => 'magnify' ],
727 Html
::rawElement( 'a', [
729 'class' => 'internal',
730 'title' => wfMessage( 'thumbnail-more' )->text() ],
734 $s .= ' <div class="thumbcaption">' . $zoomIcon . $frameParams['caption'] . "</div></div></div>";
735 return str_replace( "\n", ' ', $s );
739 * Process responsive images: add 1.5x and 2x subimages to the thumbnail, where
743 * @param MediaTransformOutput $thumb
744 * @param array $hp Image parameters
746 public static function processResponsiveImages( $file, $thumb, $hp ) {
747 global $wgResponsiveImages;
748 if ( $wgResponsiveImages && $thumb && !$thumb->isError() ) {
750 $hp15['width'] = round( $hp['width'] * 1.5 );
752 $hp20['width'] = $hp['width'] * 2;
753 if ( isset( $hp['height'] ) ) {
754 $hp15['height'] = round( $hp['height'] * 1.5 );
755 $hp20['height'] = $hp['height'] * 2;
758 $thumb15 = $file->transform( $hp15 );
759 $thumb20 = $file->transform( $hp20 );
760 if ( $thumb15 && !$thumb15->isError() && $thumb15->getUrl() !== $thumb->getUrl() ) {
761 $thumb->responsiveUrls
['1.5'] = $thumb15->getUrl();
763 if ( $thumb20 && !$thumb20->isError() && $thumb20->getUrl() !== $thumb->getUrl() ) {
764 $thumb->responsiveUrls
['2'] = $thumb20->getUrl();
770 * Make a "broken" link to an image
773 * @param Title $title
774 * @param string $label Link label (plain text)
775 * @param string $query Query string
776 * @param string $unused1 Unused parameter kept for b/c
777 * @param string $unused2 Unused parameter kept for b/c
778 * @param bool $time A file of a certain timestamp was requested
781 public static function makeBrokenImageLinkObj( $title, $label = '',
782 $query = '', $unused1 = '', $unused2 = '', $time = false
784 if ( !$title instanceof Title
) {
785 wfWarn( __METHOD__
. ': Requires $title to be a Title object.' );
786 return "<!-- ERROR -->" . htmlspecialchars( $label );
789 global $wgEnableUploads, $wgUploadMissingFileUrl, $wgUploadNavigationUrl;
790 if ( $label == '' ) {
791 $label = $title->getPrefixedText();
793 $encLabel = htmlspecialchars( $label );
794 $currentExists = $time ?
( wfFindFile( $title ) != false ) : false;
796 if ( ( $wgUploadMissingFileUrl ||
$wgUploadNavigationUrl ||
$wgEnableUploads )
799 $redir = RepoGroup
::singleton()->getLocalRepo()->checkRedirect( $title );
802 // We already know it's a redirect, so mark it
807 [ 'class' => 'mw-redirect' ],
808 wfCgiToArray( $query ),
809 [ 'known', 'noclasses' ]
813 $href = self
::getUploadUrl( $title, $query );
815 return '<a href="' . htmlspecialchars( $href ) . '" class="new" title="' .
816 htmlspecialchars( $title->getPrefixedText(), ENT_QUOTES
) . '">' .
820 return self
::link( $title, $encLabel, [], wfCgiToArray( $query ), [ 'known', 'noclasses' ] );
824 * Get the URL to upload a certain file
827 * @param Title $destFile Title object of the file to upload
828 * @param string $query Urlencoded query string to prepend
829 * @return string Urlencoded URL
831 protected static function getUploadUrl( $destFile, $query = '' ) {
832 global $wgUploadMissingFileUrl, $wgUploadNavigationUrl;
833 $q = 'wpDestFile=' . $destFile->getPartialURL();
834 if ( $query != '' ) {
838 if ( $wgUploadMissingFileUrl ) {
839 return wfAppendQuery( $wgUploadMissingFileUrl, $q );
840 } elseif ( $wgUploadNavigationUrl ) {
841 return wfAppendQuery( $wgUploadNavigationUrl, $q );
843 $upload = SpecialPage
::getTitleFor( 'Upload' );
844 return $upload->getLocalURL( $q );
849 * Create a direct link to a given uploaded file.
852 * @param Title $title
853 * @param string $html Pre-sanitized HTML
854 * @param string $time MW timestamp of file creation time
855 * @return string HTML
857 public static function makeMediaLinkObj( $title, $html = '', $time = false ) {
858 $img = wfFindFile( $title, [ 'time' => $time ] );
859 return self
::makeMediaLinkFile( $title, $img, $html );
863 * Create a direct link to a given uploaded file.
864 * This will make a broken link if $file is false.
867 * @param Title $title
868 * @param File|bool $file File object or false
869 * @param string $html Pre-sanitized HTML
870 * @return string HTML
872 * @todo Handle invalid or missing images better.
874 public static function makeMediaLinkFile( Title
$title, $file, $html = '' ) {
875 if ( $file && $file->exists() ) {
876 $url = $file->getUrl();
879 $url = self
::getUploadUrl( $title );
883 $alt = $title->getText();
895 if ( !Hooks
::run( 'LinkerMakeMediaLinkFile',
896 [ $title, $file, &$html, &$attribs, &$ret ] ) ) {
897 wfDebug( "Hook LinkerMakeMediaLinkFile changed the output of link "
898 . "with url {$url} and text {$html} to {$ret}\n", true );
902 return Html
::rawElement( 'a', $attribs, $html );
906 * Make a link to a special page given its name and, optionally,
907 * a message key from the link text.
908 * Usage example: Linker::specialLink( 'Recentchanges' )
911 * @param string $name
915 public static function specialLink( $name, $key = '' ) {
917 $key = strtolower( $name );
920 return self
::linkKnown( SpecialPage
::getTitleFor( $name ), wfMessage( $key )->text() );
924 * Make an external link
925 * @since 1.16.3. $title added in 1.21
926 * @param string $url URL to link to
927 * @param string $text Text of link
928 * @param bool $escape Do we escape the link text?
929 * @param string $linktype Type of external link. Gets added to the classes
930 * @param array $attribs Array of extra attributes to <a>
931 * @param Title|null $title Title object used for title specific link attributes
934 public static function makeExternalLink( $url, $text, $escape = true,
935 $linktype = '', $attribs = [], $title = null
940 $class .= " $linktype";
942 if ( isset( $attribs['class'] ) && $attribs['class'] ) {
943 $class .= " {$attribs['class']}";
945 $attribs['class'] = $class;
948 $text = htmlspecialchars( $text );
954 $newRel = Parser
::getExternalLinkRel( $url, $title );
955 if ( !isset( $attribs['rel'] ) ||
$attribs['rel'] === '' ) {
956 $attribs['rel'] = $newRel;
957 } elseif ( $newRel !== '' ) {
958 // Merge the rel attributes.
959 $newRels = explode( ' ', $newRel );
960 $oldRels = explode( ' ', $attribs['rel'] );
961 $combined = array_unique( array_merge( $newRels, $oldRels ) );
962 $attribs['rel'] = implode( ' ', $combined );
965 $success = Hooks
::run( 'LinkerMakeExternalLink',
966 [ &$url, &$text, &$link, &$attribs, $linktype ] );
968 wfDebug( "Hook LinkerMakeExternalLink changed the output of link "
969 . "with url {$url} and text {$text} to {$link}\n", true );
972 $attribs['href'] = $url;
973 return Html
::rawElement( 'a', $attribs, $text );
977 * Make user link (or user contributions for unregistered users)
978 * @param int $userId User id in database.
979 * @param string $userName User name in database.
980 * @param string $altUserName Text to display instead of the user name (optional)
981 * @return string HTML fragment
982 * @since 1.16.3. $altUserName was added in 1.19.
984 public static function userLink( $userId, $userName, $altUserName = false ) {
985 $classes = 'mw-userlink';
986 if ( $userId == 0 ) {
987 $page = SpecialPage
::getTitleFor( 'Contributions', $userName );
988 if ( $altUserName === false ) {
989 $altUserName = IP
::prettifyIP( $userName );
991 $classes .= ' mw-anonuserlink'; // Separate link class for anons (bug 43179)
993 $page = Title
::makeTitle( NS_USER
, $userName );
998 htmlspecialchars( $altUserName !== false ?
$altUserName : $userName ),
999 [ 'class' => $classes ]
1004 * Generate standard user tool links (talk, contributions, block link, etc.)
1007 * @param int $userId User identifier
1008 * @param string $userText User name or IP address
1009 * @param bool $redContribsWhenNoEdits Should the contributions link be
1010 * red if the user has no edits?
1011 * @param int $flags Customisation flags (e.g. Linker::TOOL_LINKS_NOBLOCK
1012 * and Linker::TOOL_LINKS_EMAIL).
1013 * @param int $edits User edit count (optional, for performance)
1014 * @return string HTML fragment
1016 public static function userToolLinks(
1017 $userId, $userText, $redContribsWhenNoEdits = false, $flags = 0, $edits = null
1019 global $wgUser, $wgDisableAnonTalk, $wgLang;
1020 $talkable = !( $wgDisableAnonTalk && 0 == $userId );
1021 $blockable = !( $flags & self
::TOOL_LINKS_NOBLOCK
);
1022 $addEmailLink = $flags & self
::TOOL_LINKS_EMAIL
&& $userId;
1026 $items[] = self
::userTalkLink( $userId, $userText );
1029 // check if the user has an edit
1031 if ( $redContribsWhenNoEdits ) {
1032 if ( intval( $edits ) === 0 && $edits !== 0 ) {
1033 $user = User
::newFromId( $userId );
1034 $edits = $user->getEditCount();
1036 if ( $edits === 0 ) {
1037 $attribs['class'] = 'new';
1040 $contribsPage = SpecialPage
::getTitleFor( 'Contributions', $userText );
1042 $items[] = self
::link( $contribsPage, wfMessage( 'contribslink' )->escaped(), $attribs );
1044 if ( $blockable && $wgUser->isAllowed( 'block' ) ) {
1045 $items[] = self
::blockLink( $userId, $userText );
1048 if ( $addEmailLink && $wgUser->canSendEmail() ) {
1049 $items[] = self
::emailLink( $userId, $userText );
1052 Hooks
::run( 'UserToolLinksEdit', [ $userId, $userText, &$items ] );
1055 return wfMessage( 'word-separator' )->escaped()
1056 . '<span class="mw-usertoollinks">'
1057 . wfMessage( 'parentheses' )->rawParams( $wgLang->pipeList( $items ) )->escaped()
1065 * Alias for userToolLinks( $userId, $userText, true );
1067 * @param int $userId User identifier
1068 * @param string $userText User name or IP address
1069 * @param int $edits User edit count (optional, for performance)
1072 public static function userToolLinksRedContribs( $userId, $userText, $edits = null ) {
1073 return self
::userToolLinks( $userId, $userText, true, 0, $edits );
1078 * @param int $userId User id in database.
1079 * @param string $userText User name in database.
1080 * @return string HTML fragment with user talk link
1082 public static function userTalkLink( $userId, $userText ) {
1083 $userTalkPage = Title
::makeTitle( NS_USER_TALK
, $userText );
1084 $userTalkLink = self
::link( $userTalkPage, wfMessage( 'talkpagelinktext' )->escaped() );
1085 return $userTalkLink;
1090 * @param int $userId Userid
1091 * @param string $userText User name in database.
1092 * @return string HTML fragment with block link
1094 public static function blockLink( $userId, $userText ) {
1095 $blockPage = SpecialPage
::getTitleFor( 'Block', $userText );
1096 $blockLink = self
::link( $blockPage, wfMessage( 'blocklink' )->escaped() );
1101 * @param int $userId Userid
1102 * @param string $userText User name in database.
1103 * @return string HTML fragment with e-mail user link
1105 public static function emailLink( $userId, $userText ) {
1106 $emailPage = SpecialPage
::getTitleFor( 'Emailuser', $userText );
1107 $emailLink = self
::link( $emailPage, wfMessage( 'emaillink' )->escaped() );
1112 * Generate a user link if the current user is allowed to view it
1114 * @param Revision $rev
1115 * @param bool $isPublic Show only if all users can see it
1116 * @return string HTML fragment
1118 public static function revUserLink( $rev, $isPublic = false ) {
1119 if ( $rev->isDeleted( Revision
::DELETED_USER
) && $isPublic ) {
1120 $link = wfMessage( 'rev-deleted-user' )->escaped();
1121 } elseif ( $rev->userCan( Revision
::DELETED_USER
) ) {
1122 $link = self
::userLink( $rev->getUser( Revision
::FOR_THIS_USER
),
1123 $rev->getUserText( Revision
::FOR_THIS_USER
) );
1125 $link = wfMessage( 'rev-deleted-user' )->escaped();
1127 if ( $rev->isDeleted( Revision
::DELETED_USER
) ) {
1128 return '<span class="history-deleted">' . $link . '</span>';
1134 * Generate a user tool link cluster if the current user is allowed to view it
1136 * @param Revision $rev
1137 * @param bool $isPublic Show only if all users can see it
1138 * @return string HTML
1140 public static function revUserTools( $rev, $isPublic = false ) {
1141 if ( $rev->isDeleted( Revision
::DELETED_USER
) && $isPublic ) {
1142 $link = wfMessage( 'rev-deleted-user' )->escaped();
1143 } elseif ( $rev->userCan( Revision
::DELETED_USER
) ) {
1144 $userId = $rev->getUser( Revision
::FOR_THIS_USER
);
1145 $userText = $rev->getUserText( Revision
::FOR_THIS_USER
);
1146 $link = self
::userLink( $userId, $userText )
1147 . self
::userToolLinks( $userId, $userText );
1149 $link = wfMessage( 'rev-deleted-user' )->escaped();
1151 if ( $rev->isDeleted( Revision
::DELETED_USER
) ) {
1152 return ' <span class="history-deleted">' . $link . '</span>';
1158 * This function is called by all recent changes variants, by the page history,
1159 * and by the user contributions list. It is responsible for formatting edit
1160 * summaries. It escapes any HTML in the summary, but adds some CSS to format
1161 * auto-generated comments (from section editing) and formats [[wikilinks]].
1163 * @author Erik Moeller <moeller@scireview.de>
1164 * @since 1.16.3. $wikiId added in 1.26
1166 * Note: there's not always a title to pass to this function.
1167 * Since you can't set a default parameter for a reference, I've turned it
1168 * temporarily to a value pass. Should be adjusted further. --brion
1170 * @param string $comment
1171 * @param Title|null $title Title object (to generate link to the section in autocomment)
1173 * @param bool $local Whether section links should refer to local page
1174 * @param string|null $wikiId Id (as used by WikiMap) of the wiki to generate links to.
1175 * For use with external changes.
1177 * @return mixed|string
1179 public static function formatComment(
1180 $comment, $title = null, $local = false, $wikiId = null
1182 # Sanitize text a bit:
1183 $comment = str_replace( "\n", " ", $comment );
1184 # Allow HTML entities (for bug 13815)
1185 $comment = Sanitizer
::escapeHtmlAllowEntities( $comment );
1187 # Render autocomments and make links:
1188 $comment = self
::formatAutocomments( $comment, $title, $local, $wikiId );
1189 $comment = self
::formatLinksInComment( $comment, $title, $local, $wikiId );
1195 * Converts autogenerated comments in edit summaries into section links.
1197 * The pattern for autogen comments is / * foo * /, which makes for
1199 * We look for all comments, match any text before and after the comment,
1200 * add a separator where needed and format the comment itself with CSS
1201 * Called by Linker::formatComment.
1203 * @param string $comment Comment text
1204 * @param Title|null $title An optional title object used to links to sections
1205 * @param bool $local Whether section links should refer to local page
1206 * @param string|null $wikiId Id of the wiki to link to (if not the local wiki),
1207 * as used by WikiMap.
1209 * @return string Formatted comment (wikitext)
1211 private static function formatAutocomments(
1212 $comment, $title = null, $local = false, $wikiId = null
1214 // @todo $append here is something of a hack to preserve the status
1215 // quo. Someone who knows more about bidi and such should decide
1216 // (1) what sane rendering even *is* for an LTR edit summary on an RTL
1217 // wiki, both when autocomments exist and when they don't, and
1218 // (2) what markup will make that actually happen.
1220 $comment = preg_replace_callback(
1221 // To detect the presence of content before or after the
1222 // auto-comment, we use capturing groups inside optional zero-width
1223 // assertions. But older versions of PCRE can't directly make
1224 // zero-width assertions optional, so wrap them in a non-capturing
1226 '!(?:(?<=(.)))?/\*\s*(.*?)\s*\*/(?:(?=(.)))?!',
1227 function ( $match ) use ( $title, $local, $wikiId, &$append ) {
1230 // Ensure all match positions are defined
1231 $match +
= [ '', '', '', '' ];
1233 $pre = $match[1] !== '';
1235 $post = $match[3] !== '';
1239 'FormatAutocomments',
1240 [ &$comment, $pre, $auto, $post, $title, $local, $wikiId ]
1243 if ( $comment === null ) {
1247 # Remove links that a user may have manually put in the autosummary
1248 # This could be improved by copying as much of Parser::stripSectionName as desired.
1249 $section = str_replace( '[[:', '', $section );
1250 $section = str_replace( '[[', '', $section );
1251 $section = str_replace( ']]', '', $section );
1253 $section = Sanitizer
::normalizeSectionNameWhitespace( $section ); # bug 22784
1255 $sectionTitle = Title
::newFromText( '#' . $section );
1257 $sectionTitle = Title
::makeTitleSafe( $title->getNamespace(),
1258 $title->getDBkey(), $section );
1260 if ( $sectionTitle ) {
1261 $link = Linker
::makeCommentLink( $sectionTitle, $wgLang->getArrow(), $wikiId, 'noclasses' );
1267 # written summary $presep autocomment (summary /* section */)
1268 $pre = wfMessage( 'autocomment-prefix' )->inContentLanguage()->escaped();
1271 # autocomment $postsep written summary (/* section */ summary)
1272 $auto .= wfMessage( 'colon-separator' )->inContentLanguage()->escaped();
1274 $auto = '<span class="autocomment">' . $auto . '</span>';
1275 $comment = $pre . $link . $wgLang->getDirMark()
1276 . '<span dir="auto">' . $auto;
1277 $append .= '</span>';
1283 return $comment . $append;
1287 * Formats wiki links and media links in text; all other wiki formatting
1290 * @since 1.16.3. $wikiId added in 1.26
1291 * @todo FIXME: Doesn't handle sub-links as in image thumb texts like the main parser
1293 * @param string $comment Text to format links in. WARNING! Since the output of this
1294 * function is html, $comment must be sanitized for use as html. You probably want
1295 * to pass $comment through Sanitizer::escapeHtmlAllowEntities() before calling
1297 * @param Title|null $title An optional title object used to links to sections
1298 * @param bool $local Whether section links should refer to local page
1299 * @param string|null $wikiId Id of the wiki to link to (if not the local wiki),
1300 * as used by WikiMap.
1304 public static function formatLinksInComment(
1305 $comment, $title = null, $local = false, $wikiId = null
1307 return preg_replace_callback(
1310 :? # ignore optional leading colon
1311 ([^\]|]+) # 1. link target; page names cannot include ] or |
1313 # 2. a pipe-separated substring; only the last is captured
1314 # Stop matching at | and ]] without relying on backtracking.
1318 ([^[]*) # 3. link trail (the text up until the next link)
1320 function ( $match ) use ( $title, $local, $wikiId ) {
1323 $medians = '(?:' . preg_quote( MWNamespace
::getCanonicalName( NS_MEDIA
), '/' ) . '|';
1324 $medians .= preg_quote( $wgContLang->getNsText( NS_MEDIA
), '/' ) . '):';
1326 $comment = $match[0];
1328 # fix up urlencoded title texts (copied from Parser::replaceInternalLinks)
1329 if ( strpos( $match[1], '%' ) !== false ) {
1331 rawurldecode( $match[1] ),
1332 [ '<' => '<', '>' => '>' ]
1336 # Handle link renaming [[foo|text]] will show link as "text"
1337 if ( $match[2] != "" ) {
1344 if ( preg_match( '/^' . $medians . '(.*)$/i', $match[1], $submatch ) ) {
1345 # Media link; trail not supported.
1346 $linkRegexp = '/\[\[(.*?)\]\]/';
1347 $title = Title
::makeTitleSafe( NS_FILE
, $submatch[1] );
1349 $thelink = Linker
::makeMediaLinkObj( $title, $text );
1352 # Other kind of link
1353 # Make sure its target is non-empty
1354 if ( isset( $match[1][0] ) && $match[1][0] == ':' ) {
1355 $match[1] = substr( $match[1], 1 );
1357 if ( $match[1] !== false && $match[1] !== '' ) {
1358 if ( preg_match( $wgContLang->linkTrail(), $match[3], $submatch ) ) {
1359 $trail = $submatch[1];
1363 $linkRegexp = '/\[\[(.*?)\]\]' . preg_quote( $trail, '/' ) . '/';
1364 list( $inside, $trail ) = Linker
::splitTrail( $trail );
1367 $linkTarget = Linker
::normalizeSubpageLink( $title, $match[1], $linkText );
1369 $target = Title
::newFromText( $linkTarget );
1371 if ( $target->getText() == '' && !$target->isExternal()
1372 && !$local && $title
1374 $newTarget = clone $title;
1375 $newTarget->setFragment( '#' . $target->getFragment() );
1376 $target = $newTarget;
1379 $thelink = Linker
::makeCommentLink( $target, $linkText . $inside, $wikiId ) . $trail;
1384 // If the link is still valid, go ahead and replace it in!
1385 $comment = preg_replace(
1387 StringUtils
::escapeRegexReplacement( $thelink ),
1400 * Generates a link to the given Title
1402 * @note This is only public for technical reasons. It's not intended for use outside Linker.
1404 * @param Title $title
1405 * @param string $text
1406 * @param string|null $wikiId Id of the wiki to link to (if not the local wiki),
1407 * as used by WikiMap.
1408 * @param string|string[] $options See the $options parameter in Linker::link.
1410 * @return string HTML link
1412 public static function makeCommentLink(
1413 Title
$title, $text, $wikiId = null, $options = []
1415 if ( $wikiId !== null && !$title->isExternal() ) {
1416 $link = Linker
::makeExternalLink(
1417 WikiMap
::getForeignURL(
1419 $title->getPrefixedText(),
1420 $title->getFragment()
1423 /* escape = */ false // Already escaped
1426 $link = Linker
::link( $title, $text, [], [], $options );
1433 * @param Title $contextTitle
1434 * @param string $target
1435 * @param string $text
1438 public static function normalizeSubpageLink( $contextTitle, $target, &$text ) {
1441 # :Foobar -- override special treatment of prefix (images, language links)
1442 # /Foobar -- convert to CurrentPage/Foobar
1443 # /Foobar/ -- convert to CurrentPage/Foobar, strip the initial and final / from text
1444 # ../ -- convert to CurrentPage, from CurrentPage/CurrentSubPage
1445 # ../Foobar -- convert to CurrentPage/Foobar,
1446 # (from CurrentPage/CurrentSubPage)
1447 # ../Foobar/ -- convert to CurrentPage/Foobar, use 'Foobar' as text
1448 # (from CurrentPage/CurrentSubPage)
1450 $ret = $target; # default return value is no change
1452 # Some namespaces don't allow subpages,
1453 # so only perform processing if subpages are allowed
1454 if ( $contextTitle && MWNamespace
::hasSubpages( $contextTitle->getNamespace() ) ) {
1455 $hash = strpos( $target, '#' );
1456 if ( $hash !== false ) {
1457 $suffix = substr( $target, $hash );
1458 $target = substr( $target, 0, $hash );
1463 $target = trim( $target );
1464 # Look at the first character
1465 if ( $target != '' && $target[0] === '/' ) {
1466 # / at end means we don't want the slash to be shown
1468 $trailingSlashes = preg_match_all( '%(/+)$%', $target, $m );
1469 if ( $trailingSlashes ) {
1470 $noslash = $target = substr( $target, 1, -strlen( $m[0][0] ) );
1472 $noslash = substr( $target, 1 );
1475 $ret = $contextTitle->getPrefixedText() . '/' . trim( $noslash ) . $suffix;
1476 if ( $text === '' ) {
1477 $text = $target . $suffix;
1478 } # this might be changed for ugliness reasons
1480 # check for .. subpage backlinks
1482 $nodotdot = $target;
1483 while ( strncmp( $nodotdot, "../", 3 ) == 0 ) {
1485 $nodotdot = substr( $nodotdot, 3 );
1487 if ( $dotdotcount > 0 ) {
1488 $exploded = explode( '/', $contextTitle->getPrefixedText() );
1489 if ( count( $exploded ) > $dotdotcount ) { # not allowed to go below top level page
1490 $ret = implode( '/', array_slice( $exploded, 0, -$dotdotcount ) );
1491 # / at the end means don't show full path
1492 if ( substr( $nodotdot, -1, 1 ) === '/' ) {
1493 $nodotdot = rtrim( $nodotdot, '/' );
1494 if ( $text === '' ) {
1495 $text = $nodotdot . $suffix;
1498 $nodotdot = trim( $nodotdot );
1499 if ( $nodotdot != '' ) {
1500 $ret .= '/' . $nodotdot;
1512 * Wrap a comment in standard punctuation and formatting if
1513 * it's non-empty, otherwise return empty string.
1515 * @since 1.16.3. $wikiId added in 1.26
1516 * @param string $comment
1517 * @param Title|null $title Title object (to generate link to section in autocomment) or null
1518 * @param bool $local Whether section links should refer to local page
1519 * @param string|null $wikiId Id (as used by WikiMap) of the wiki to generate links to.
1520 * For use with external changes.
1524 public static function commentBlock(
1525 $comment, $title = null, $local = false, $wikiId = null
1527 // '*' used to be the comment inserted by the software way back
1528 // in antiquity in case none was provided, here for backwards
1529 // compatibility, acc. to brion -ævar
1530 if ( $comment == '' ||
$comment == '*' ) {
1533 $formatted = self
::formatComment( $comment, $title, $local, $wikiId );
1534 $formatted = wfMessage( 'parentheses' )->rawParams( $formatted )->escaped();
1535 return " <span class=\"comment\">$formatted</span>";
1540 * Wrap and format the given revision's comment block, if the current
1541 * user is allowed to view it.
1544 * @param Revision $rev
1545 * @param bool $local Whether section links should refer to local page
1546 * @param bool $isPublic Show only if all users can see it
1547 * @return string HTML fragment
1549 public static function revComment( Revision
$rev, $local = false, $isPublic = false ) {
1550 if ( $rev->getComment( Revision
::RAW
) == "" ) {
1553 if ( $rev->isDeleted( Revision
::DELETED_COMMENT
) && $isPublic ) {
1554 $block = " <span class=\"comment\">" . wfMessage( 'rev-deleted-comment' )->escaped() . "</span>";
1555 } elseif ( $rev->userCan( Revision
::DELETED_COMMENT
) ) {
1556 $block = self
::commentBlock( $rev->getComment( Revision
::FOR_THIS_USER
),
1557 $rev->getTitle(), $local );
1559 $block = " <span class=\"comment\">" . wfMessage( 'rev-deleted-comment' )->escaped() . "</span>";
1561 if ( $rev->isDeleted( Revision
::DELETED_COMMENT
) ) {
1562 return " <span class=\"history-deleted\">$block</span>";
1572 public static function formatRevisionSize( $size ) {
1574 $stxt = wfMessage( 'historyempty' )->escaped();
1576 $stxt = wfMessage( 'nbytes' )->numParams( $size )->escaped();
1577 $stxt = wfMessage( 'parentheses' )->rawParams( $stxt )->escaped();
1579 return "<span class=\"history-size\">$stxt</span>";
1583 * Add another level to the Table of Contents
1588 public static function tocIndent() {
1593 * Finish one or more sublevels on the Table of Contents
1599 public static function tocUnindent( $level ) {
1600 return "</li>\n" . str_repeat( "</ul>\n</li>\n", $level > 0 ?
$level : 0 );
1604 * parameter level defines if we are on an indentation level
1607 * @param string $anchor
1608 * @param string $tocline
1609 * @param string $tocnumber
1610 * @param string $level
1611 * @param string|bool $sectionIndex
1614 public static function tocLine( $anchor, $tocline, $tocnumber, $level, $sectionIndex = false ) {
1615 $classes = "toclevel-$level";
1616 if ( $sectionIndex !== false ) {
1617 $classes .= " tocsection-$sectionIndex";
1619 return "\n<li class=\"$classes\"><a href=\"#" .
1620 $anchor . '"><span class="tocnumber">' .
1621 $tocnumber . '</span> <span class="toctext">' .
1622 $tocline . '</span></a>';
1626 * End a Table Of Contents line.
1627 * tocUnindent() will be used instead if we're ending a line below
1632 public static function tocLineEnd() {
1637 * Wraps the TOC in a table and provides the hide/collapse javascript.
1640 * @param string $toc Html of the Table Of Contents
1641 * @param string|Language|bool $lang Language for the toc title, defaults to user language
1642 * @return string Full html of the TOC
1644 public static function tocList( $toc, $lang = false ) {
1645 $lang = wfGetLangObj( $lang );
1646 $title = wfMessage( 'toc' )->inLanguage( $lang )->escaped();
1648 return '<div id="toc" class="toc">'
1649 . '<div id="toctitle"><h2>' . $title . "</h2></div>\n"
1651 . "</ul>\n</div>\n";
1655 * Generate a table of contents from a section tree.
1657 * @since 1.16.3. $lang added in 1.17
1658 * @param array $tree Return value of ParserOutput::getSections()
1659 * @param string|Language|bool $lang Language for the toc title, defaults to user language
1660 * @return string HTML fragment
1662 public static function generateTOC( $tree, $lang = false ) {
1665 foreach ( $tree as $section ) {
1666 if ( $section['toclevel'] > $lastLevel ) {
1667 $toc .= self
::tocIndent();
1668 } elseif ( $section['toclevel'] < $lastLevel ) {
1669 $toc .= self
::tocUnindent(
1670 $lastLevel - $section['toclevel'] );
1672 $toc .= self
::tocLineEnd();
1675 $toc .= self
::tocLine( $section['anchor'],
1676 $section['line'], $section['number'],
1677 $section['toclevel'], $section['index'] );
1678 $lastLevel = $section['toclevel'];
1680 $toc .= self
::tocLineEnd();
1681 return self
::tocList( $toc, $lang );
1685 * Create a headline for content
1688 * @param int $level The level of the headline (1-6)
1689 * @param string $attribs Any attributes for the headline, starting with
1690 * a space and ending with '>'
1691 * This *must* be at least '>' for no attribs
1692 * @param string $anchor The anchor to give the headline (the bit after the #)
1693 * @param string $html Html for the text of the header
1694 * @param string $link HTML to add for the section edit link
1695 * @param bool|string $legacyAnchor A second, optional anchor to give for
1696 * backward compatibility (false to omit)
1698 * @return string HTML headline
1700 public static function makeHeadline( $level, $attribs, $anchor, $html,
1701 $link, $legacyAnchor = false
1703 $ret = "<h$level$attribs"
1704 . "<span class=\"mw-headline\" id=\"$anchor\">$html</span>"
1707 if ( $legacyAnchor !== false ) {
1708 $ret = "<div id=\"$legacyAnchor\"></div>$ret";
1714 * Split a link trail, return the "inside" portion and the remainder of the trail
1715 * as a two-element array
1716 * @param string $trail
1719 static function splitTrail( $trail ) {
1721 $regex = $wgContLang->linkTrail();
1723 if ( $trail !== '' ) {
1725 if ( preg_match( $regex, $trail, $m ) ) {
1730 return [ $inside, $trail ];
1734 * Generate a rollback link for a given revision. Currently it's the
1735 * caller's responsibility to ensure that the revision is the top one. If
1736 * it's not, of course, the user will get an error message.
1738 * If the calling page is called with the parameter &bot=1, all rollback
1739 * links also get that parameter. It causes the edit itself and the rollback
1740 * to be marked as "bot" edits. Bot edits are hidden by default from recent
1741 * changes, so this allows sysops to combat a busy vandal without bothering
1744 * If the option verify is set this function will return the link only in case the
1745 * revision can be reverted. Please note that due to performance limitations
1746 * it might be assumed that a user isn't the only contributor of a page while
1747 * (s)he is, which will lead to useless rollback links. Furthermore this wont
1748 * work if $wgShowRollbackEditCount is disabled, so this can only function
1749 * as an additional check.
1751 * If the option noBrackets is set the rollback link wont be enclosed in "[]".
1753 * @since 1.16.3. $context added in 1.20. $options added in 1.21
1755 * @param Revision $rev
1756 * @param IContextSource $context Context to use or null for the main context.
1757 * @param array $options
1760 public static function generateRollback( $rev, IContextSource
$context = null,
1761 $options = [ 'verify' ]
1763 if ( $context === null ) {
1764 $context = RequestContext
::getMain();
1768 if ( in_array( 'verify', $options, true ) ) {
1769 $editCount = self
::getRollbackEditCount( $rev, true );
1770 if ( $editCount === false ) {
1775 $inner = self
::buildRollbackLink( $rev, $context, $editCount );
1777 if ( !in_array( 'noBrackets', $options, true ) ) {
1778 $inner = $context->msg( 'brackets' )->rawParams( $inner )->escaped();
1781 return '<span class="mw-rollback-link">' . $inner . '</span>';
1785 * This function will return the number of revisions which a rollback
1786 * would revert and, if $verify is set it will verify that a revision
1787 * can be reverted (that the user isn't the only contributor and the
1788 * revision we might rollback to isn't deleted). These checks can only
1789 * function as an additional check as this function only checks against
1790 * the last $wgShowRollbackEditCount edits.
1792 * Returns null if $wgShowRollbackEditCount is disabled or false if $verify
1793 * is set and the user is the only contributor of the page.
1795 * @param Revision $rev
1796 * @param bool $verify Try to verify that this revision can really be rolled back
1797 * @return int|bool|null
1799 public static function getRollbackEditCount( $rev, $verify ) {
1800 global $wgShowRollbackEditCount;
1801 if ( !is_int( $wgShowRollbackEditCount ) ||
!$wgShowRollbackEditCount > 0 ) {
1802 // Nothing has happened, indicate this by returning 'null'
1806 $dbr = wfGetDB( DB_SLAVE
);
1808 // Up to the value of $wgShowRollbackEditCount revisions are counted
1809 $res = $dbr->select(
1811 [ 'rev_user_text', 'rev_deleted' ],
1812 // $rev->getPage() returns null sometimes
1813 [ 'rev_page' => $rev->getTitle()->getArticleID() ],
1816 'USE INDEX' => [ 'revision' => 'page_timestamp' ],
1817 'ORDER BY' => 'rev_timestamp DESC',
1818 'LIMIT' => $wgShowRollbackEditCount +
1
1824 foreach ( $res as $row ) {
1825 if ( $rev->getUserText( Revision
::RAW
) != $row->rev_user_text
) {
1827 ( $row->rev_deleted
& Revision
::DELETED_TEXT
1828 ||
$row->rev_deleted
& Revision
::DELETED_USER
1830 // If the user or the text of the revision we might rollback
1831 // to is deleted in some way we can't rollback. Similar to
1832 // the sanity checks in WikiPage::commitRollback.
1841 if ( $verify && $editCount <= $wgShowRollbackEditCount && !$moreRevs ) {
1842 // We didn't find at least $wgShowRollbackEditCount revisions made by the current user
1843 // and there weren't any other revisions. That means that the current user is the only
1844 // editor, so we can't rollback
1851 * Build a raw rollback link, useful for collections of "tool" links
1853 * @since 1.16.3. $context added in 1.20. $editCount added in 1.21
1854 * @param Revision $rev
1855 * @param IContextSource|null $context Context to use or null for the main context.
1856 * @param int $editCount Number of edits that would be reverted
1857 * @return string HTML fragment
1859 public static function buildRollbackLink( $rev, IContextSource
$context = null,
1862 global $wgShowRollbackEditCount, $wgMiserMode;
1864 // To config which pages are affected by miser mode
1865 $disableRollbackEditCountSpecialPage = [ 'Recentchanges', 'Watchlist' ];
1867 if ( $context === null ) {
1868 $context = RequestContext
::getMain();
1871 $title = $rev->getTitle();
1873 'action' => 'rollback',
1874 'from' => $rev->getUserText(),
1875 'token' => $context->getUser()->getEditToken( 'rollback' ),
1878 'data-mw' => 'interface',
1879 'title' => $context->msg( 'tooltip-rollback' )->text(),
1881 $options = [ 'known', 'noclasses' ];
1883 if ( $context->getRequest()->getBool( 'bot' ) ) {
1884 $query['bot'] = '1';
1885 $query['hidediff'] = '1'; // bug 15999
1888 $disableRollbackEditCount = false;
1889 if ( $wgMiserMode ) {
1890 foreach ( $disableRollbackEditCountSpecialPage as $specialPage ) {
1891 if ( $context->getTitle()->isSpecial( $specialPage ) ) {
1892 $disableRollbackEditCount = true;
1898 if ( !$disableRollbackEditCount
1899 && is_int( $wgShowRollbackEditCount )
1900 && $wgShowRollbackEditCount > 0
1902 if ( !is_numeric( $editCount ) ) {
1903 $editCount = self
::getRollbackEditCount( $rev, false );
1906 if ( $editCount > $wgShowRollbackEditCount ) {
1907 $html = $context->msg( 'rollbacklinkcount-morethan' )
1908 ->numParams( $wgShowRollbackEditCount )->parse();
1910 $html = $context->msg( 'rollbacklinkcount' )->numParams( $editCount )->parse();
1913 return self
::link( $title, $html, $attrs, $query, $options );
1915 $html = $context->msg( 'rollbacklink' )->escaped();
1916 return self
::link( $title, $html, $attrs, $query, $options );
1921 * Returns HTML for the "templates used on this page" list.
1923 * Make an HTML list of templates, and then add a "More..." link at
1924 * the bottom. If $more is null, do not add a "More..." link. If $more
1925 * is a Title, make a link to that title and use it. If $more is a string,
1926 * directly paste it in as the link (escaping needs to be done manually).
1927 * Finally, if $more is a Message, call toString().
1929 * @since 1.16.3. $more added in 1.21
1930 * @param Title[] $templates Array of templates
1931 * @param bool $preview Whether this is for a preview
1932 * @param bool $section Whether this is for a section edit
1933 * @param Title|Message|string|null $more An escaped link for "More..." of the templates
1934 * @return string HTML output
1936 public static function formatTemplates( $templates, $preview = false,
1937 $section = false, $more = null
1942 if ( count( $templates ) > 0 ) {
1943 # Do a batch existence check
1944 $batch = new LinkBatch
;
1945 foreach ( $templates as $title ) {
1946 $batch->addObj( $title );
1950 # Construct the HTML
1951 $outText = '<div class="mw-templatesUsedExplanation">';
1953 $outText .= wfMessage( 'templatesusedpreview' )->numParams( count( $templates ) )
1955 } elseif ( $section ) {
1956 $outText .= wfMessage( 'templatesusedsection' )->numParams( count( $templates ) )
1959 $outText .= wfMessage( 'templatesused' )->numParams( count( $templates ) )
1962 $outText .= "</div><ul>\n";
1964 usort( $templates, 'Title::compare' );
1965 foreach ( $templates as $titleObj ) {
1967 $restrictions = $titleObj->getRestrictions( 'edit' );
1968 if ( $restrictions ) {
1969 // Check backwards-compatible messages
1971 if ( $restrictions === [ 'sysop' ] ) {
1972 $msg = wfMessage( 'template-protected' );
1973 } elseif ( $restrictions === [ 'autoconfirmed' ] ) {
1974 $msg = wfMessage( 'template-semiprotected' );
1976 if ( $msg && !$msg->isDisabled() ) {
1977 $protected = $msg->parse();
1979 // Construct the message from restriction-level-*
1980 // e.g. restriction-level-sysop, restriction-level-autoconfirmed
1982 foreach ( $restrictions as $r ) {
1983 $msgs[] = wfMessage( "restriction-level-$r" )->parse();
1985 $protected = wfMessage( 'parentheses' )
1986 ->rawParams( $wgLang->commaList( $msgs ) )->escaped();
1989 if ( $titleObj->quickUserCan( 'edit' ) ) {
1990 $editLink = self
::link(
1992 wfMessage( 'editlink' )->escaped(),
1994 [ 'action' => 'edit' ]
1997 $editLink = self
::link(
1999 wfMessage( 'viewsourcelink' )->escaped(),
2001 [ 'action' => 'edit' ]
2004 $outText .= '<li>' . self
::link( $titleObj )
2005 . wfMessage( 'word-separator' )->escaped()
2006 . wfMessage( 'parentheses' )->rawParams( $editLink )->escaped()
2007 . wfMessage( 'word-separator' )->escaped()
2008 . $protected . '</li>';
2011 if ( $more instanceof Title
) {
2012 $outText .= '<li>' . self
::link( $more, wfMessage( 'moredotdotdot' ) ) . '</li>';
2013 } elseif ( $more ) {
2014 $outText .= "<li>$more</li>";
2017 $outText .= '</ul>';
2023 * Returns HTML for the "hidden categories on this page" list.
2026 * @param array $hiddencats Array of hidden categories from Article::getHiddenCategories
2028 * @return string HTML output
2030 public static function formatHiddenCategories( $hiddencats ) {
2033 if ( count( $hiddencats ) > 0 ) {
2034 # Construct the HTML
2035 $outText = '<div class="mw-hiddenCategoriesExplanation">';
2036 $outText .= wfMessage( 'hiddencategories' )->numParams( count( $hiddencats ) )->parseAsBlock();
2037 $outText .= "</div><ul>\n";
2039 foreach ( $hiddencats as $titleObj ) {
2040 # If it's hidden, it must exist - no need to check with a LinkBatch
2042 . self
::link( $titleObj, null, [], [], 'known' )
2045 $outText .= '</ul>';
2051 * Format a size in bytes for output, using an appropriate
2052 * unit (B, KB, MB or GB) according to the magnitude in question
2055 * @param int $size Size to format
2058 public static function formatSize( $size ) {
2060 return htmlspecialchars( $wgLang->formatSize( $size ) );
2064 * Given the id of an interface element, constructs the appropriate title
2065 * attribute from the system messages. (Note, this is usually the id but
2066 * isn't always, because sometimes the accesskey needs to go on a different
2067 * element than the id, for reverse-compatibility, etc.)
2069 * @since 1.16.3 $msgParams added in 1.27
2070 * @param string $name Id of the element, minus prefixes.
2071 * @param string|null $options Null or the string 'withaccess' to add an access-
2073 * @param array $msgParams Parameters to pass to the message
2075 * @return string Contents of the title attribute (which you must HTML-
2076 * escape), or false for no title attribute
2078 public static function titleAttrib( $name, $options = null, array $msgParams = [] ) {
2079 $message = wfMessage( "tooltip-$name", $msgParams );
2080 if ( !$message->exists() ) {
2083 $tooltip = $message->text();
2084 # Compatibility: formerly some tooltips had [alt-.] hardcoded
2085 $tooltip = preg_replace( "/ ?\[alt-.\]$/", '', $tooltip );
2086 # Message equal to '-' means suppress it.
2087 if ( $tooltip == '-' ) {
2092 if ( $options == 'withaccess' ) {
2093 $accesskey = self
::accesskey( $name );
2094 if ( $accesskey !== false ) {
2095 // Should be build the same as in jquery.accessKeyLabel.js
2096 if ( $tooltip === false ||
$tooltip === '' ) {
2097 $tooltip = wfMessage( 'brackets', $accesskey )->text();
2099 $tooltip .= wfMessage( 'word-separator' )->text();
2100 $tooltip .= wfMessage( 'brackets', $accesskey )->text();
2108 public static $accesskeycache;
2111 * Given the id of an interface element, constructs the appropriate
2112 * accesskey attribute from the system messages. (Note, this is usually
2113 * the id but isn't always, because sometimes the accesskey needs to go on
2114 * a different element than the id, for reverse-compatibility, etc.)
2117 * @param string $name Id of the element, minus prefixes.
2118 * @return string Contents of the accesskey attribute (which you must HTML-
2119 * escape), or false for no accesskey attribute
2121 public static function accesskey( $name ) {
2122 if ( isset( self
::$accesskeycache[$name] ) ) {
2123 return self
::$accesskeycache[$name];
2126 $message = wfMessage( "accesskey-$name" );
2128 if ( !$message->exists() ) {
2131 $accesskey = $message->plain();
2132 if ( $accesskey === '' ||
$accesskey === '-' ) {
2133 # @todo FIXME: Per standard MW behavior, a value of '-' means to suppress the
2134 # attribute, but this is broken for accesskey: that might be a useful
2140 self
::$accesskeycache[$name] = $accesskey;
2141 return self
::$accesskeycache[$name];
2145 * Get a revision-deletion link, or disabled link, or nothing, depending
2146 * on user permissions & the settings on the revision.
2148 * Will use forward-compatible revision ID in the Special:RevDelete link
2149 * if possible, otherwise the timestamp-based ID which may break after
2153 * @param Revision $rev
2154 * @param Title $title
2155 * @return string HTML fragment
2157 public static function getRevDeleteLink( User
$user, Revision
$rev, Title
$title ) {
2158 $canHide = $user->isAllowed( 'deleterevision' );
2159 if ( !$canHide && !( $rev->getVisibility() && $user->isAllowed( 'deletedhistory' ) ) ) {
2163 if ( !$rev->userCan( Revision
::DELETED_RESTRICTED
, $user ) ) {
2164 return Linker
::revDeleteLinkDisabled( $canHide ); // revision was hidden from sysops
2166 if ( $rev->getId() ) {
2167 // RevDelete links using revision ID are stable across
2168 // page deletion and undeletion; use when possible.
2170 'type' => 'revision',
2171 'target' => $title->getPrefixedDBkey(),
2172 'ids' => $rev->getId()
2175 // Older deleted entries didn't save a revision ID.
2176 // We have to refer to these by timestamp, ick!
2178 'type' => 'archive',
2179 'target' => $title->getPrefixedDBkey(),
2180 'ids' => $rev->getTimestamp()
2183 return Linker
::revDeleteLink( $query,
2184 $rev->isDeleted( Revision
::DELETED_RESTRICTED
), $canHide );
2189 * Creates a (show/hide) link for deleting revisions/log entries
2191 * @param array $query Query parameters to be passed to link()
2192 * @param bool $restricted Set to true to use a "<strong>" instead of a "<span>"
2193 * @param bool $delete Set to true to use (show/hide) rather than (show)
2195 * @return string HTML "<a>" link to Special:Revisiondelete, wrapped in a
2196 * span to allow for customization of appearance with CSS
2198 public static function revDeleteLink( $query = [], $restricted = false, $delete = true ) {
2199 $sp = SpecialPage
::getTitleFor( 'Revisiondelete' );
2200 $msgKey = $delete ?
'rev-delundel' : 'rev-showdeleted';
2201 $html = wfMessage( $msgKey )->escaped();
2202 $tag = $restricted ?
'strong' : 'span';
2203 $link = self
::link( $sp, $html, [], $query, [ 'known', 'noclasses' ] );
2206 [ 'class' => 'mw-revdelundel-link' ],
2207 wfMessage( 'parentheses' )->rawParams( $link )->escaped()
2212 * Creates a dead (show/hide) link for deleting revisions/log entries
2215 * @param bool $delete Set to true to use (show/hide) rather than (show)
2217 * @return string HTML text wrapped in a span to allow for customization
2218 * of appearance with CSS
2220 public static function revDeleteLinkDisabled( $delete = true ) {
2221 $msgKey = $delete ?
'rev-delundel' : 'rev-showdeleted';
2222 $html = wfMessage( $msgKey )->escaped();
2223 $htmlParentheses = wfMessage( 'parentheses' )->rawParams( $html )->escaped();
2224 return Xml
::tags( 'span', [ 'class' => 'mw-revdelundel-link' ], $htmlParentheses );
2227 /* Deprecated methods */
2230 * Returns the attributes for the tooltip and access key.
2232 * @since 1.16.3. $msgParams introduced in 1.27
2233 * @param string $name
2234 * @param array $msgParams Params for constructing the message
2238 public static function tooltipAndAccesskeyAttribs( $name, array $msgParams = [] ) {
2239 # @todo FIXME: If Sanitizer::expandAttributes() treated "false" as "output
2240 # no attribute" instead of "output '' as value for attribute", this
2241 # would be three lines.
2243 'title' => self
::titleAttrib( $name, 'withaccess', $msgParams ),
2244 'accesskey' => self
::accesskey( $name )
2246 if ( $attribs['title'] === false ) {
2247 unset( $attribs['title'] );
2249 if ( $attribs['accesskey'] === false ) {
2250 unset( $attribs['accesskey'] );
2256 * Returns raw bits of HTML, use titleAttrib()
2258 * @param string $name
2259 * @param array|null $options
2260 * @return null|string
2262 public static function tooltip( $name, $options = null ) {
2263 # @todo FIXME: If Sanitizer::expandAttributes() treated "false" as "output
2264 # no attribute" instead of "output '' as value for attribute", this
2265 # would be two lines.
2266 $tooltip = self
::titleAttrib( $name, $options );
2267 if ( $tooltip === false ) {
2270 return Xml
::expandAttributes( [