includes/Linker.php

   1 <?php
   2 /**
   3  * Methods to make links and related items.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22 use MediaWiki\Linker\LinkTarget;
  23 use MediaWiki\MediaWikiServices;
  24
  25 /**
  26  * Some internal bits split of from Skin.php. These functions are used
  27  * for primarily page content: links, embedded images, table of contents. Links
  28  * are also used in the skin.
  29  *
  30  * @todo turn this into a legacy interface for HtmlPageLinkRenderer and similar services.
  31  *
  32  * @ingroup Skins
  33  */
  34 class Linker {
  35         /**
  36          * Flags for userToolLinks()
  37          */
  38         const TOOL_LINKS_NOBLOCK = 1;
  39         const TOOL_LINKS_EMAIL = 2;
  40
  41         /**
  42          * Get the appropriate HTML attributes to add to the "a" element of an interwiki link.
  43          *
  44          * @since 1.16.3
  45          * @deprecated since 1.25
  46          *
  47          * @param string $title The title text for the link, URL-encoded (???) but
  48          *   not HTML-escaped
  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'.
  52          * @return string
  53          */
  54         static function getInterwikiLinkAttributes( $title, $unused = null, $class = 'external' ) {
  55                 global $wgContLang;
  56
  57                 wfDeprecated( __METHOD__, '1.25' );
  58
  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 );
  64
  65                 return self::getLinkAttributesInternal( $title, $class );
  66         }
  67
  68         /**
  69          * Get the appropriate HTML attributes to add to the "a" element of an internal link.
  70          *
  71          * @since 1.16.3
  72          * @deprecated since 1.25
  73          *
  74          * @param string $title The title text for the link, URL-encoded (???) but
  75          *   not HTML-escaped
  76          * @param string $unused Unused
  77          * @param string $class The contents of the class attribute, default none
  78          * @return string
  79          */
  80         static function getInternalLinkAttributes( $title, $unused = null, $class = '' ) {
  81                 wfDeprecated( __METHOD__, '1.25' );
  82
  83                 $title = urldecode( $title );
  84                 $title = strtr( $title, '_', ' ' );
  85                 return self::getLinkAttributesInternal( $title, $class );
  86         }
  87
  88         /**
  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.
  91          *
  92          * @since 1.16.3
  93          * @deprecated since 1.25
  94          *
  95          * @param Title $nt
  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
 100          * @return string
 101          */
 102         static function getInternalLinkAttributesObj( $nt, $unused = null, $class = '', $title = false ) {
 103                 wfDeprecated( __METHOD__, '1.25' );
 104
 105                 if ( $title === false ) {
 106                         $title = $nt->getPrefixedText();
 107                 }
 108                 return self::getLinkAttributesInternal( $title, $class );
 109         }
 110
 111         /**
 112          * Common code for getLinkAttributesX functions
 113          *
 114          * @since 1.16.3
 115          * @deprecated since 1.25
 116          *
 117          * @param string $title
 118          * @param string $class
 119          *
 120          * @return string
 121          */
 122         private static function getLinkAttributesInternal( $title, $class ) {
 123                 wfDeprecated( __METHOD__, '1.25' );
 124
 125                 $title = htmlspecialchars( $title );
 126                 $class = htmlspecialchars( $class );
 127                 $r = '';
 128                 if ( $class != '' ) {
 129                         $r .= " class=\"$class\"";
 130                 }
 131                 if ( $title != '' ) {
 132                         $r .= " title=\"$title\"";
 133                 }
 134                 return $r;
 135         }
 136
 137         /**
 138          * Return the CSS colour of a known link
 139          *
 140          * @deprecated since 1.28, use LinkRenderer::getLinkClasses() instead
 141          *
 142          * @since 1.16.3
 143          * @param LinkTarget $t
 144          * @param int $threshold User defined threshold
 145          * @return string CSS class
 146          */
 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 );
 155                 }
 156
 157                 return $linkRenderer->getLinkClasses( $t );
 158         }
 159
 160         /**
 161          * This function returns an HTML link to the given target.  It serves a few
 162          * purposes:
 163          *   1) If $target is a Title, the correct URL to link to will be figured
 164          *      out automatically.
 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.
 171          *
 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
 174          *
 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-
 195          *       cons.
 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
 202          */
 203         public static function link(
 204                 $target, $html = null, $customAttribs = [], $query = [], $options = []
 205         ) {
 206                 if ( !$target instanceof Title ) {
 207                         wfWarn( __METHOD__ . ': Requires $target to be a Title object.', 2 );
 208                         return "<!-- ERROR -->$html";
 209                 }
 210
 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 );
 215                 }
 216
 217                 $services = MediaWikiServices::getInstance();
 218                 $options = (array)$options;
 219                 if ( $options ) {
 220                         // Custom options, create new LinkRenderer
 221                         if ( !isset( $options['stubThreshold'] ) ) {
 222                                 $defaultLinkRenderer = $services->getLinkRenderer();
 223                                 $options['stubThreshold'] = $defaultLinkRenderer->getStubThreshold();
 224                         }
 225                         $linkRenderer = $services->getLinkRendererFactory()
 226                                 ->createFromLegacyOptions( $options );
 227                 } else {
 228                         $linkRenderer = $services->getLinkRenderer();
 229                 }
 230
 231                 if ( $html !== null ) {
 232                         $text = new HtmlArmor( $html );
 233                 } else {
 234                         $text = $html; // null
 235                 }
 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 );
 242                 } else {
 243                         return $linkRenderer->makeLink( $target, $text, $customAttribs, $query );
 244                 }
 245         }
 246
 247         /**
 248          * Identical to link(), except $options defaults to 'known'.
 249          *
 250          * @since 1.16.3
 251          * @deprecated since 1.28, use MediaWiki\Linker\LinkRenderer instead
 252          * @see Linker::link
 253          * @return string
 254          */
 255         public static function linkKnown(
 256                 $target, $html = null, $customAttribs = [],
 257                 $query = [], $options = [ 'known' ]
 258         ) {
 259                 return self::link( $target, $html, $customAttribs, $query, $options );
 260         }
 261
 262         /**
 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
 266          * being used.
 267          *
 268          * @since 1.16.3
 269          * @param Title $nt
 270          * @param string $html [optional]
 271          * @param string $query [optional]
 272          * @param string $trail [optional]
 273          * @param string $prefix [optional]
 274          *
 275          * @return string
 276          */
 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 ] ) ) {
 280                         return $ret;
 281                 }
 282
 283                 if ( $html == '' ) {
 284                         $html = htmlspecialchars( $nt->getPrefixedText() );
 285                 }
 286                 list( $inside, $trail ) = self::splitTrail( $trail );
 287                 return "<strong class=\"selflink\">{$prefix}{$html}{$inside}</strong>{$trail}";
 288         }
 289
 290         /**
 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.
 294          *
 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
 298          * @return string
 299          */
 300         public static function getInvalidTitleDescription( IContextSource $context, $namespace, $title ) {
 301                 global $wgContLang;
 302
 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();
 307                         } else {
 308                                 $name = $wgContLang->getFormattedNsText( $namespace );
 309                         }
 310                         return $context->msg( 'invalidtitle-knownnamespace', $namespace, $name, $title )->text();
 311                 } else {
 312                         return $context->msg( 'invalidtitle-unknownnamespace', $namespace, $title )->text();
 313                 }
 314         }
 315
 316         /**
 317          * @since 1.16.3
 318          * @param LinkTarget $target
 319          * @return LinkTarget
 320          */
 321         public static function normaliseSpecialPage( LinkTarget $target ) {
 322                 if ( $target->getNamespace() == NS_SPECIAL ) {
 323                         list( $name, $subpage ) = SpecialPageFactory::resolveAlias( $target->getDBkey() );
 324                         if ( !$name ) {
 325                                 return $target;
 326                         }
 327                         $ret = SpecialPage::getTitleValueFor( $name, $subpage, $target->getFragment() );
 328                         return $ret;
 329                 } else {
 330                         return $target;
 331                 }
 332         }
 333
 334         /**
 335          * Returns the filename part of an url.
 336          * Used as alternative text for external images.
 337          *
 338          * @param string $url
 339          *
 340          * @return string
 341          */
 342         private static function fnamePart( $url ) {
 343                 $basename = strrchr( $url, '/' );
 344                 if ( false === $basename ) {
 345                         $basename = $url;
 346                 } else {
 347                         $basename = substr( $basename, 1 );
 348                 }
 349                 return $basename;
 350         }
 351
 352         /**
 353          * Return the code for images which were added via external links,
 354          * via Parser::maybeMakeExternalImage().
 355          *
 356          * @since 1.16.3
 357          * @param string $url
 358          * @param string $alt
 359          *
 360          * @return string
 361          */
 362         public static function makeExternalImage( $url, $alt = '' ) {
 363                 if ( $alt == '' ) {
 364                         $alt = self::fnamePart( $url );
 365                 }
 366                 $img = '';
 367                 $success = Hooks::run( 'LinkerMakeExternalImage', [ &$url, &$alt, &$img ] );
 368                 if ( !$success ) {
 369                         wfDebug( "Hook LinkerMakeExternalImage changed the output of external image "
 370                                 . "with url {$url} and alt text {$alt} to {$img}\n", true );
 371                         return $img;
 372                 }
 373                 return Html::element( 'img',
 374                         [
 375                                 'src' => $url,
 376                                 'alt' => $alt ] );
 377         }
 378
 379         /**
 380          * Given parameters derived from [[Image:Foo|options...]], generate the
 381          * HTML that that syntax inserts in the page.
 382          *
 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
 406          *
 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
 412          * @since 1.20
 413          * @return string HTML for an image, with links, wrappers, etc.
 414          */
 415         public static function makeImageLink( Parser $parser, Title $title,
 416                 $file, $frameParams = [], $handlerParams = [], $time = false,
 417                 $query = "", $widthOption = null
 418         ) {
 419                 $res = null;
 420                 $dummy = new DummyLinker;
 421                 if ( !Hooks::run( 'ImageBeforeProduceHTML', [ &$dummy, &$title,
 422                         &$file, &$frameParams, &$handlerParams, &$time, &$res ] ) ) {
 423                         return $res;
 424                 }
 425
 426                 if ( $file && !$file->allowInlineDisplay() ) {
 427                         wfDebug( __METHOD__ . ': ' . $title->getPrefixedDBkey() . " does not allow inline display\n" );
 428                         return self::link( $title );
 429                 }
 430
 431                 // Clean up parameters
 432                 $page = isset( $handlerParams['page'] ) ? $handlerParams['page'] : false;
 433                 if ( !isset( $frameParams['align'] ) ) {
 434                         $frameParams['align'] = '';
 435                 }
 436                 if ( !isset( $frameParams['alt'] ) ) {
 437                         $frameParams['alt'] = '';
 438                 }
 439                 if ( !isset( $frameParams['title'] ) ) {
 440                         $frameParams['title'] = '';
 441                 }
 442                 if ( !isset( $frameParams['class'] ) ) {
 443                         $frameParams['class'] = '';
 444                 }
 445
 446                 $prefix = $postfix = '';
 447
 448                 if ( 'center' == $frameParams['align'] ) {
 449                         $prefix = '<div class="center">';
 450                         $postfix = '</div>';
 451                         $frameParams['align'] = 'none';
 452                 }
 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;
 459                         } else {
 460                                 $handlerParams['width'] = $file->getWidth( $page );
 461                         }
 462
 463                         if ( isset( $frameParams['thumbnail'] )
 464                                 || isset( $frameParams['manualthumb'] )
 465                                 || isset( $frameParams['framed'] )
 466                                 || isset( $frameParams['frameless'] )
 467                                 || !$handlerParams['width']
 468                         ) {
 469                                 global $wgThumbLimits, $wgThumbUpright;
 470
 471                                 if ( $widthOption === null || !isset( $wgThumbLimits[$widthOption] ) ) {
 472                                         $widthOption = User::getDefaultOption( 'thumbsize' );
 473                                 }
 474
 475                                 // Reduce width for upright images when parameter 'upright' is used
 476                                 if ( isset( $frameParams['upright'] ) && $frameParams['upright'] == 0 ) {
 477                                         $frameParams['upright'] = $wgThumbUpright;
 478                                 }
 479
 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];
 486
 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;
 492                                 }
 493                         }
 494                 }
 495
 496                 if ( isset( $frameParams['thumbnail'] ) || isset( $frameParams['manualthumb'] )
 497                         || isset( $frameParams['framed'] )
 498                 ) {
 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();
 506                         }
 507                         return $prefix .
 508                                 self::makeThumbLink2( $title, $file, $frameParams, $handlerParams, $time, $query ) .
 509                                 $postfix;
 510                 }
 511
 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;
 519                         }
 520                 }
 521
 522                 if ( $file && isset( $handlerParams['width'] ) ) {
 523                         # Create a resized image, without the additional thumbnail features
 524                         $thumb = $file->transform( $handlerParams );
 525                 } else {
 526                         $thumb = false;
 527                 }
 528
 529                 if ( !$thumb ) {
 530                         $s = self::makeBrokenImageLinkObj( $title, $frameParams['title'], '', '', '', $time == true );
 531                 } else {
 532                         self::processResponsiveImages( $file, $thumb, $handlerParams );
 533                         $params = [
 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';
 540                         }
 541                         $params = self::getImageLinkMTOParams( $frameParams, $query, $parser ) + $params;
 542
 543                         $s = $thumb->toHtml( $params );
 544                 }
 545                 if ( $frameParams['align'] != '' ) {
 546                         $s = "<div class=\"float{$frameParams['align']}\">{$s}</div>";
 547                 }
 548                 return str_replace( "\n", ' ', $prefix . $s . $postfix );
 549         }
 550
 551         /**
 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
 557          * @return array
 558          */
 559         private static function getImageLinkMTOParams( $frameParams, $query = '', $parser = null ) {
 560                 $mtoParams = [];
 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'];
 565                         }
 566                         if ( $parser ) {
 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;
 571                                 }
 572                         }
 573                 } elseif ( isset( $frameParams['link-title'] ) && $frameParams['link-title'] !== '' ) {
 574                         $mtoParams['custom-title-link'] = Title::newFromLinkTarget(
 575                                 self::normaliseSpecialPage( $frameParams['link-title'] )
 576                         );
 577                 } elseif ( !empty( $frameParams['no-link'] ) ) {
 578                         // No link
 579                 } else {
 580                         $mtoParams['desc-link'] = true;
 581                         $mtoParams['desc-query'] = $query;
 582                 }
 583                 return $mtoParams;
 584         }
 585
 586         /**
 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
 591          * @param string $alt
 592          * @param string $align
 593          * @param array $params
 594          * @param bool $framed
 595          * @param string $manualthumb
 596          * @return string
 597          */
 598         public static function makeThumbLinkObj( Title $title, $file, $label = '', $alt,
 599                 $align = 'right', $params = [], $framed = false, $manualthumb = ""
 600         ) {
 601                 $frameParams = [
 602                         'alt' => $alt,
 603                         'caption' => $label,
 604                         'align' => $align
 605                 ];
 606                 if ( $framed ) {
 607                         $frameParams['framed'] = true;
 608                 }
 609                 if ( $manualthumb ) {
 610                         $frameParams['manualthumb'] = $manualthumb;
 611                 }
 612                 return self::makeThumbLink2( $title, $file, $frameParams, $params );
 613         }
 614
 615         /**
 616          * @param Title $title
 617          * @param File $file
 618          * @param array $frameParams
 619          * @param array $handlerParams
 620          * @param bool $time
 621          * @param string $query
 622          * @return string
 623          */
 624         public static function makeThumbLink2( Title $title, $file, $frameParams = [],
 625                 $handlerParams = [], $time = false, $query = ""
 626         ) {
 627                 $exists = $file && $file->exists();
 628
 629                 $page = isset( $handlerParams['page'] ) ? $handlerParams['page'] : false;
 630                 if ( !isset( $frameParams['align'] ) ) {
 631                         $frameParams['align'] = 'right';
 632                 }
 633                 if ( !isset( $frameParams['alt'] ) ) {
 634                         $frameParams['alt'] = '';
 635                 }
 636                 if ( !isset( $frameParams['title'] ) ) {
 637                         $frameParams['title'] = '';
 638                 }
 639                 if ( !isset( $frameParams['caption'] ) ) {
 640                         $frameParams['caption'] = '';
 641                 }
 642
 643                 if ( empty( $handlerParams['width'] ) ) {
 644                         // Reduce width for upright images when parameter 'upright' is used
 645                         $handlerParams['width'] = isset( $frameParams['upright'] ) ? 130 : 180;
 646                 }
 647                 $thumb = false;
 648                 $noscale = false;
 649                 $manualthumb = false;
 650
 651                 if ( !$exists ) {
 652                         $outerWidth = $handlerParams['width'] + 2;
 653                 } else {
 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 );
 659                                         if ( $manual_img ) {
 660                                                 $thumb = $manual_img->getUnscaledThumb( $handlerParams );
 661                                                 $manualthumb = true;
 662                                         } else {
 663                                                 $exists = false;
 664                                         }
 665                                 }
 666                         } elseif ( isset( $frameParams['framed'] ) ) {
 667                                 // Use image dimensions, don't scale
 668                                 $thumb = $file->getUnscaledThumb( $handlerParams );
 669                                 $noscale = true;
 670                         } else {
 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;
 676                                 }
 677                                 $thumb = $file->transform( $handlerParams );
 678                         }
 679
 680                         if ( $thumb ) {
 681                                 $outerWidth = $thumb->getWidth() + 2;
 682                         } else {
 683                                 $outerWidth = $handlerParams['width'] + 2;
 684                         }
 685                 }
 686
 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 );
 691                 if ( $page ) {
 692                         $url = wfAppendQuery( $url, [ 'page' => $page ] );
 693                 }
 694                 if ( $manualthumb
 695                         && !isset( $frameParams['link-title'] )
 696                         && !isset( $frameParams['link-url'] )
 697                         && !isset( $frameParams['no-link'] ) ) {
 698                         $frameParams['link-url'] = $url;
 699                 }
 700
 701                 $s = "<div class=\"thumb t{$frameParams['align']}\">"
 702                         . "<div class=\"thumbinner\" style=\"width:{$outerWidth}px;\">";
 703
 704                 if ( !$exists ) {
 705                         $s .= self::makeBrokenImageLinkObj( $title, $frameParams['title'], '', '', '', $time == true );
 706                         $zoomIcon = '';
 707                 } elseif ( !$thumb ) {
 708                         $s .= wfMessage( 'thumbnail_error', '' )->escaped();
 709                         $zoomIcon = '';
 710                 } else {
 711                         if ( !$noscale && !$manualthumb ) {
 712                                 self::processResponsiveImages( $file, $thumb, $handlerParams );
 713                         }
 714                         $params = [
 715                                 'alt' => $frameParams['alt'],
 716                                 'title' => $frameParams['title'],
 717                                 'img-class' => ( isset( $frameParams['class'] ) && $frameParams['class'] !== ''
 718                                         ? $frameParams['class'] . ' '
 719                                         : '' ) . 'thumbimage'
 720                         ];
 721                         $params = self::getImageLinkMTOParams( $frameParams, $query ) + $params;
 722                         $s .= $thumb->toHtml( $params );
 723                         if ( isset( $frameParams['framed'] ) ) {
 724                                 $zoomIcon = "";
 725                         } else {
 726                                 $zoomIcon = Html::rawElement( 'div', [ 'class' => 'magnify' ],
 727                                         Html::rawElement( 'a', [
 728                                                 'href' => $url,
 729                                                 'class' => 'internal',
 730                                                 'title' => wfMessage( 'thumbnail-more' )->text() ],
 731                                                 "" ) );
 732                         }
 733                 }
 734                 $s .= '  <div class="thumbcaption">' . $zoomIcon . $frameParams['caption'] . "</div></div></div>";
 735                 return str_replace( "\n", ' ', $s );
 736         }
 737
 738         /**
 739          * Process responsive images: add 1.5x and 2x subimages to the thumbnail, where
 740          * applicable.
 741          *
 742          * @param File $file
 743          * @param MediaTransformOutput $thumb
 744          * @param array $hp Image parameters
 745          */
 746         public static function processResponsiveImages( $file, $thumb, $hp ) {
 747                 global $wgResponsiveImages;
 748                 if ( $wgResponsiveImages && $thumb && !$thumb->isError() ) {
 749                         $hp15 = $hp;
 750                         $hp15['width'] = round( $hp['width'] * 1.5 );
 751                         $hp20 = $hp;
 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;
 756                         }
 757
 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();
 762                         }
 763                         if ( $thumb20 && !$thumb20->isError() && $thumb20->getUrl() !== $thumb->getUrl() ) {
 764                                 $thumb->responsiveUrls['2'] = $thumb20->getUrl();
 765                         }
 766                 }
 767         }
 768
 769         /**
 770          * Make a "broken" link to an image
 771          *
 772          * @since 1.16.3
 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
 779          * @return string
 780          */
 781         public static function makeBrokenImageLinkObj( $title, $label = '',
 782                 $query = '', $unused1 = '', $unused2 = '', $time = false
 783         ) {
 784                 if ( !$title instanceof Title ) {
 785                         wfWarn( __METHOD__ . ': Requires $title to be a Title object.' );
 786                         return "<!-- ERROR -->" . htmlspecialchars( $label );
 787                 }
 788
 789                 global $wgEnableUploads, $wgUploadMissingFileUrl, $wgUploadNavigationUrl;
 790                 if ( $label == '' ) {
 791                         $label = $title->getPrefixedText();
 792                 }
 793                 $encLabel = htmlspecialchars( $label );
 794                 $currentExists = $time ? ( wfFindFile( $title ) != false ) : false;
 795
 796                 if ( ( $wgUploadMissingFileUrl || $wgUploadNavigationUrl || $wgEnableUploads )
 797                         && !$currentExists
 798                 ) {
 799                         $redir = RepoGroup::singleton()->getLocalRepo()->checkRedirect( $title );
 800
 801                         if ( $redir ) {
 802                                 // We already know it's a redirect, so mark it
 803                                 // accordingly
 804                                 return self::link(
 805                                         $title,
 806                                         $encLabel,
 807                                         [ 'class' => 'mw-redirect' ],
 808                                         wfCgiToArray( $query ),
 809                                         [ 'known', 'noclasses' ]
 810                                 );
 811                         }
 812
 813                         $href = self::getUploadUrl( $title, $query );
 814
 815                         return '<a href="' . htmlspecialchars( $href ) . '" class="new" title="' .
 816                                 htmlspecialchars( $title->getPrefixedText(), ENT_QUOTES ) . '">' .
 817                                 $encLabel . '</a>';
 818                 }
 819
 820                 return self::link( $title, $encLabel, [], wfCgiToArray( $query ), [ 'known', 'noclasses' ] );
 821         }
 822
 823         /**
 824          * Get the URL to upload a certain file
 825          *
 826          * @since 1.16.3
 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
 830          */
 831         protected static function getUploadUrl( $destFile, $query = '' ) {
 832                 global $wgUploadMissingFileUrl, $wgUploadNavigationUrl;
 833                 $q = 'wpDestFile=' . $destFile->getPartialURL();
 834                 if ( $query != '' ) {
 835                         $q .= '&' . $query;
 836                 }
 837
 838                 if ( $wgUploadMissingFileUrl ) {
 839                         return wfAppendQuery( $wgUploadMissingFileUrl, $q );
 840                 } elseif ( $wgUploadNavigationUrl ) {
 841                         return wfAppendQuery( $wgUploadNavigationUrl, $q );
 842                 } else {
 843                         $upload = SpecialPage::getTitleFor( 'Upload' );
 844                         return $upload->getLocalURL( $q );
 845                 }
 846         }
 847
 848         /**
 849          * Create a direct link to a given uploaded file.
 850          *
 851          * @since 1.16.3
 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
 856          */
 857         public static function makeMediaLinkObj( $title, $html = '', $time = false ) {
 858                 $img = wfFindFile( $title, [ 'time' => $time ] );
 859                 return self::makeMediaLinkFile( $title, $img, $html );
 860         }
 861
 862         /**
 863          * Create a direct link to a given uploaded file.
 864          * This will make a broken link if $file is false.
 865          *
 866          * @since 1.16.3
 867          * @param Title $title
 868          * @param File|bool $file File object or false
 869          * @param string $html Pre-sanitized HTML
 870          * @return string HTML
 871          *
 872          * @todo Handle invalid or missing images better.
 873          */
 874         public static function makeMediaLinkFile( Title $title, $file, $html = '' ) {
 875                 if ( $file && $file->exists() ) {
 876                         $url = $file->getUrl();
 877                         $class = 'internal';
 878                 } else {
 879                         $url = self::getUploadUrl( $title );
 880                         $class = 'new';
 881                 }
 882
 883                 $alt = $title->getText();
 884                 if ( $html == '' ) {
 885                         $html = $alt;
 886                 }
 887
 888                 $ret = '';
 889                 $attribs = [
 890                         'href' => $url,
 891                         'class' => $class,
 892                         'title' => $alt
 893                 ];
 894
 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 );
 899                         return $ret;
 900                 }
 901
 902                 return Html::rawElement( 'a', $attribs, $html );
 903         }
 904
 905         /**
 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' )
 909          *
 910          * @since 1.16.3
 911          * @param string $name
 912          * @param string $key
 913          * @return string
 914          */
 915         public static function specialLink( $name, $key = '' ) {
 916                 if ( $key == '' ) {
 917                         $key = strtolower( $name );
 918                 }
 919
 920                 return self::linkKnown( SpecialPage::getTitleFor( $name ), wfMessage( $key )->text() );
 921         }
 922
 923         /**
 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
 932          * @return string
 933          */
 934         public static function makeExternalLink( $url, $text, $escape = true,
 935                 $linktype = '', $attribs = [], $title = null
 936         ) {
 937                 global $wgTitle;
 938                 $class = "external";
 939                 if ( $linktype ) {
 940                         $class .= " $linktype";
 941                 }
 942                 if ( isset( $attribs['class'] ) && $attribs['class'] ) {
 943                         $class .= " {$attribs['class']}";
 944                 }
 945                 $attribs['class'] = $class;
 946
 947                 if ( $escape ) {
 948                         $text = htmlspecialchars( $text );
 949                 }
 950
 951                 if ( !$title ) {
 952                         $title = $wgTitle;
 953                 }
 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 );
 963                 }
 964                 $link = '';
 965                 $success = Hooks::run( 'LinkerMakeExternalLink',
 966                         [ &$url, &$text, &$link, &$attribs, $linktype ] );
 967                 if ( !$success ) {
 968                         wfDebug( "Hook LinkerMakeExternalLink changed the output of link "
 969                                 . "with url {$url} and text {$text} to {$link}\n", true );
 970                         return $link;
 971                 }
 972                 $attribs['href'] = $url;
 973                 return Html::rawElement( 'a', $attribs, $text );
 974         }
 975
 976         /**
 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.
 983          */
 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 );
 990                         }
 991                         $classes .= ' mw-anonuserlink'; // Separate link class for anons (bug 43179)
 992                 } else {
 993                         $page = Title::makeTitle( NS_USER, $userName );
 994                 }
 995
 996                 return self::link(
 997                         $page,
 998                         htmlspecialchars( $altUserName !== false ? $altUserName : $userName ),
 999                         [ 'class' => $classes ]
1000                 );
1001         }
1002
1003         /**
1004          * Generate standard user tool links (talk, contributions, block link, etc.)
1005          *
1006          * @since 1.16.3
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
1015          */
1016         public static function userToolLinks(
1017                 $userId, $userText, $redContribsWhenNoEdits = false, $flags = 0, $edits = null
1018         ) {
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;
1023
1024                 $items = [];
1025                 if ( $talkable ) {
1026                         $items[] = self::userTalkLink( $userId, $userText );
1027                 }
1028                 if ( $userId ) {
1029                         // check if the user has an edit
1030                         $attribs = [];
1031                         if ( $redContribsWhenNoEdits ) {
1032                                 if ( intval( $edits ) === 0 && $edits !== 0 ) {
1033                                         $user = User::newFromId( $userId );
1034                                         $edits = $user->getEditCount();
1035                                 }
1036                                 if ( $edits === 0 ) {
1037                                         $attribs['class'] = 'new';
1038                                 }
1039                         }
1040                         $contribsPage = SpecialPage::getTitleFor( 'Contributions', $userText );
1041
1042                         $items[] = self::link( $contribsPage, wfMessage( 'contribslink' )->escaped(), $attribs );
1043                 }
1044                 if ( $blockable && $wgUser->isAllowed( 'block' ) ) {
1045                         $items[] = self::blockLink( $userId, $userText );
1046                 }
1047
1048                 if ( $addEmailLink && $wgUser->canSendEmail() ) {
1049                         $items[] = self::emailLink( $userId, $userText );
1050                 }
1051
1052                 Hooks::run( 'UserToolLinksEdit', [ $userId, $userText, &$items ] );
1053
1054                 if ( $items ) {
1055                         return wfMessage( 'word-separator' )->escaped()
1056                                 . '<span class="mw-usertoollinks">'
1057                                 . wfMessage( 'parentheses' )->rawParams( $wgLang->pipeList( $items ) )->escaped()
1058                                 . '</span>';
1059                 } else {
1060                         return '';
1061                 }
1062         }
1063
1064         /**
1065          * Alias for userToolLinks( $userId, $userText, true );
1066          * @since 1.16.3
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)
1070          * @return string
1071          */
1072         public static function userToolLinksRedContribs( $userId, $userText, $edits = null ) {
1073                 return self::userToolLinks( $userId, $userText, true, 0, $edits );
1074         }
1075
1076         /**
1077          * @since 1.16.3
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
1081          */
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;
1086         }
1087
1088         /**
1089          * @since 1.16.3
1090          * @param int $userId Userid
1091          * @param string $userText User name in database.
1092          * @return string HTML fragment with block link
1093          */
1094         public static function blockLink( $userId, $userText ) {
1095                 $blockPage = SpecialPage::getTitleFor( 'Block', $userText );
1096                 $blockLink = self::link( $blockPage, wfMessage( 'blocklink' )->escaped() );
1097                 return $blockLink;
1098         }
1099
1100         /**
1101          * @param int $userId Userid
1102          * @param string $userText User name in database.
1103          * @return string HTML fragment with e-mail user link
1104          */
1105         public static function emailLink( $userId, $userText ) {
1106                 $emailPage = SpecialPage::getTitleFor( 'Emailuser', $userText );
1107                 $emailLink = self::link( $emailPage, wfMessage( 'emaillink' )->escaped() );
1108                 return $emailLink;
1109         }
1110
1111         /**
1112          * Generate a user link if the current user is allowed to view it
1113          * @since 1.16.3
1114          * @param Revision $rev
1115          * @param bool $isPublic Show only if all users can see it
1116          * @return string HTML fragment
1117          */
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 ) );
1124                 } else {
1125                         $link = wfMessage( 'rev-deleted-user' )->escaped();
1126                 }
1127                 if ( $rev->isDeleted( Revision::DELETED_USER ) ) {
1128                         return '<span class="history-deleted">' . $link . '</span>';
1129                 }
1130                 return $link;
1131         }
1132
1133         /**
1134          * Generate a user tool link cluster if the current user is allowed to view it
1135          * @since 1.16.3
1136          * @param Revision $rev
1137          * @param bool $isPublic Show only if all users can see it
1138          * @return string HTML
1139          */
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 );
1148                 } else {
1149                         $link = wfMessage( 'rev-deleted-user' )->escaped();
1150                 }
1151                 if ( $rev->isDeleted( Revision::DELETED_USER ) ) {
1152                         return ' <span class="history-deleted">' . $link . '</span>';
1153                 }
1154                 return $link;
1155         }
1156
1157         /**
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]].
1162          *
1163          * @author Erik Moeller <moeller@scireview.de>
1164          * @since 1.16.3. $wikiId added in 1.26
1165          *
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
1169          *
1170          * @param string $comment
1171          * @param Title|null $title Title object (to generate link to the section in autocomment)
1172          *  or null
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.
1176          *
1177          * @return mixed|string
1178          */
1179         public static function formatComment(
1180                 $comment, $title = null, $local = false, $wikiId = null
1181         ) {
1182                 # Sanitize text a bit:
1183                 $comment = str_replace( "\n", " ", $comment );
1184                 # Allow HTML entities (for bug 13815)
1185                 $comment = Sanitizer::escapeHtmlAllowEntities( $comment );
1186
1187                 # Render autocomments and make links:
1188                 $comment = self::formatAutocomments( $comment, $title, $local, $wikiId );
1189                 $comment = self::formatLinksInComment( $comment, $title, $local, $wikiId );
1190
1191                 return $comment;
1192         }
1193
1194         /**
1195          * Converts autogenerated comments in edit summaries into section links.
1196          *
1197          * The pattern for autogen comments is / * foo * /, which makes for
1198          * some nasty regex.
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.
1202          *
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.
1208          *
1209          * @return string Formatted comment (wikitext)
1210          */
1211         private static function formatAutocomments(
1212                 $comment, $title = null, $local = false, $wikiId = null
1213         ) {
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.
1219                 $append = '';
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
1225                         // group.
1226                         '!(?:(?<=(.)))?/\*\s*(.*?)\s*\*/(?:(?=(.)))?!',
1227                         function ( $match ) use ( $title, $local, $wikiId, &$append ) {
1228                                 global $wgLang;
1229
1230                                 // Ensure all match positions are defined
1231                                 $match += [ '', '', '', '' ];
1232
1233                                 $pre = $match[1] !== '';
1234                                 $auto = $match[2];
1235                                 $post = $match[3] !== '';
1236                                 $comment = null;
1237
1238                                 Hooks::run(
1239                                         'FormatAutocomments',
1240                                         [ &$comment, $pre, $auto, $post, $title, $local, $wikiId ]
1241                                 );
1242
1243                                 if ( $comment === null ) {
1244                                         $link = '';
1245                                         if ( $title ) {
1246                                                 $section = $auto;
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 );
1252
1253                                                 $section = Sanitizer::normalizeSectionNameWhitespace( $section ); # bug 22784
1254                                                 if ( $local ) {
1255                                                         $sectionTitle = Title::newFromText( '#' . $section );
1256                                                 } else {
1257                                                         $sectionTitle = Title::makeTitleSafe( $title->getNamespace(),
1258                                                                 $title->getDBkey(), $section );
1259                                                 }
1260                                                 if ( $sectionTitle ) {
1261                                                         $link = Linker::makeCommentLink( $sectionTitle, $wgLang->getArrow(), $wikiId, 'noclasses' );
1262                                                 } else {
1263                                                         $link = '';
1264                                                 }
1265                                         }
1266                                         if ( $pre ) {
1267                                                 # written summary $presep autocomment (summary /* section */)
1268                                                 $pre = wfMessage( 'autocomment-prefix' )->inContentLanguage()->escaped();
1269                                         }
1270                                         if ( $post ) {
1271                                                 # autocomment $postsep written summary (/* section */ summary)
1272                                                 $auto .= wfMessage( 'colon-separator' )->inContentLanguage()->escaped();
1273                                         }
1274                                         $auto = '<span class="autocomment">' . $auto . '</span>';
1275                                         $comment = $pre . $link . $wgLang->getDirMark()
1276                                                 . '<span dir="auto">' . $auto;
1277                                         $append .= '</span>';
1278                                 }
1279                                 return $comment;
1280                         },
1281                         $comment
1282                 );
1283                 return $comment . $append;
1284         }
1285
1286         /**
1287          * Formats wiki links and media links in text; all other wiki formatting
1288          * is ignored
1289          *
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
1292          *
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
1296          *      this function.
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.
1301          *
1302          * @return string
1303          */
1304         public static function formatLinksInComment(
1305                 $comment, $title = null, $local = false, $wikiId = null
1306         ) {
1307                 return preg_replace_callback(
1308                         '/
1309                                 \[\[
1310                                 :? # ignore optional leading colon
1311                                 ([^\]|]+) # 1. link target; page names cannot include ] or |
1312                                 (?:\|
1313                                         # 2. a pipe-separated substring; only the last is captured
1314                                         # Stop matching at | and ]] without relying on backtracking.
1315                                         ((?:]?[^\]|])*+)
1316                                 )*
1317                                 \]\]
1318                                 ([^[]*) # 3. link trail (the text up until the next link)
1319                         /x',
1320                         function ( $match ) use ( $title, $local, $wikiId ) {
1321                                 global $wgContLang;
1322
1323                                 $medians = '(?:' . preg_quote( MWNamespace::getCanonicalName( NS_MEDIA ), '/' ) . '|';
1324                                 $medians .= preg_quote( $wgContLang->getNsText( NS_MEDIA ), '/' ) . '):';
1325
1326                                 $comment = $match[0];
1327
1328                                 # fix up urlencoded title texts (copied from Parser::replaceInternalLinks)
1329                                 if ( strpos( $match[1], '%' ) !== false ) {
1330                                         $match[1] = strtr(
1331                                                 rawurldecode( $match[1] ),
1332                                                 [ '<' => '&lt;', '>' => '&gt;' ]
1333                                         );
1334                                 }
1335
1336                                 # Handle link renaming [[foo|text]] will show link as "text"
1337                                 if ( $match[2] != "" ) {
1338                                         $text = $match[2];
1339                                 } else {
1340                                         $text = $match[1];
1341                                 }
1342                                 $submatch = [];
1343                                 $thelink = null;
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] );
1348                                         if ( $title ) {
1349                                                 $thelink = Linker::makeMediaLinkObj( $title, $text );
1350                                         }
1351                                 } else {
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 );
1356                                         }
1357                                         if ( $match[1] !== false && $match[1] !== '' ) {
1358                                                 if ( preg_match( $wgContLang->linkTrail(), $match[3], $submatch ) ) {
1359                                                         $trail = $submatch[1];
1360                                                 } else {
1361                                                         $trail = "";
1362                                                 }
1363                                                 $linkRegexp = '/\[\[(.*?)\]\]' . preg_quote( $trail, '/' ) . '/';
1364                                                 list( $inside, $trail ) = Linker::splitTrail( $trail );
1365
1366                                                 $linkText = $text;
1367                                                 $linkTarget = Linker::normalizeSubpageLink( $title, $match[1], $linkText );
1368
1369                                                 $target = Title::newFromText( $linkTarget );
1370                                                 if ( $target ) {
1371                                                         if ( $target->getText() == '' && !$target->isExternal()
1372                                                                 && !$local && $title
1373                                                         ) {
1374                                                                 $newTarget = clone $title;
1375                                                                 $newTarget->setFragment( '#' . $target->getFragment() );
1376                                                                 $target = $newTarget;
1377                                                         }
1378
1379                                                         $thelink = Linker::makeCommentLink( $target, $linkText . $inside, $wikiId ) . $trail;
1380                                                 }
1381                                         }
1382                                 }
1383                                 if ( $thelink ) {
1384                                         // If the link is still valid, go ahead and replace it in!
1385                                         $comment = preg_replace(
1386                                                 $linkRegexp,
1387                                                 StringUtils::escapeRegexReplacement( $thelink ),
1388                                                 $comment,
1389                                                 1
1390                                         );
1391                                 }
1392
1393                                 return $comment;
1394                         },
1395                         $comment
1396                 );
1397         }
1398
1399         /**
1400          * Generates a link to the given Title
1401          *
1402          * @note This is only public for technical reasons. It's not intended for use outside Linker.
1403          *
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.
1409          *
1410          * @return string HTML link
1411          */
1412         public static function makeCommentLink(
1413                 Title $title, $text, $wikiId = null, $options = []
1414         ) {
1415                 if ( $wikiId !== null && !$title->isExternal() ) {
1416                         $link = Linker::makeExternalLink(
1417                                 WikiMap::getForeignURL(
1418                                         $wikiId,
1419                                         $title->getPrefixedText(),
1420                                         $title->getFragment()
1421                                 ),
1422                                 $text,
1423                                 /* escape = */ false // Already escaped
1424                         );
1425                 } else {
1426                         $link = Linker::link( $title, $text, [], [], $options );
1427                 }
1428
1429                 return $link;
1430         }
1431
1432         /**
1433          * @param Title $contextTitle
1434          * @param string $target
1435          * @param string $text
1436          * @return string
1437          */
1438         public static function normalizeSubpageLink( $contextTitle, $target, &$text ) {
1439                 # Valid link forms:
1440                 # Foobar -- normal
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)
1449
1450                 $ret = $target; # default return value is no change
1451
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 );
1459                         } else {
1460                                 $suffix = '';
1461                         }
1462                         # bug 7425
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
1467                                 $m = [];
1468                                 $trailingSlashes = preg_match_all( '%(/+)$%', $target, $m );
1469                                 if ( $trailingSlashes ) {
1470                                         $noslash = $target = substr( $target, 1, -strlen( $m[0][0] ) );
1471                                 } else {
1472                                         $noslash = substr( $target, 1 );
1473                                 }
1474
1475                                 $ret = $contextTitle->getPrefixedText() . '/' . trim( $noslash ) . $suffix;
1476                                 if ( $text === '' ) {
1477                                         $text = $target . $suffix;
1478                                 } # this might be changed for ugliness reasons
1479                         } else {
1480                                 # check for .. subpage backlinks
1481                                 $dotdotcount = 0;
1482                                 $nodotdot = $target;
1483                                 while ( strncmp( $nodotdot, "../", 3 ) == 0 ) {
1484                                         ++$dotdotcount;
1485                                         $nodotdot = substr( $nodotdot, 3 );
1486                                 }
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;
1496                                                         }
1497                                                 }
1498                                                 $nodotdot = trim( $nodotdot );
1499                                                 if ( $nodotdot != '' ) {
1500                                                         $ret .= '/' . $nodotdot;
1501                                                 }
1502                                                 $ret .= $suffix;
1503                                         }
1504                                 }
1505                         }
1506                 }
1507
1508                 return $ret;
1509         }
1510
1511         /**
1512          * Wrap a comment in standard punctuation and formatting if
1513          * it's non-empty, otherwise return empty string.
1514          *
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.
1521          *
1522          * @return string
1523          */
1524         public static function commentBlock(
1525                 $comment, $title = null, $local = false, $wikiId = null
1526         ) {
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 == '*' ) {
1531                         return '';
1532                 } else {
1533                         $formatted = self::formatComment( $comment, $title, $local, $wikiId );
1534                         $formatted = wfMessage( 'parentheses' )->rawParams( $formatted )->escaped();
1535                         return " <span class=\"comment\">$formatted</span>";
1536                 }
1537         }
1538
1539         /**
1540          * Wrap and format the given revision's comment block, if the current
1541          * user is allowed to view it.
1542          *
1543          * @since 1.16.3
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
1548          */
1549         public static function revComment( Revision $rev, $local = false, $isPublic = false ) {
1550                 if ( $rev->getComment( Revision::RAW ) == "" ) {
1551                         return "";
1552                 }
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 );
1558                 } else {
1559                         $block = " <span class=\"comment\">" . wfMessage( 'rev-deleted-comment' )->escaped() . "</span>";
1560                 }
1561                 if ( $rev->isDeleted( Revision::DELETED_COMMENT ) ) {
1562                         return " <span class=\"history-deleted\">$block</span>";
1563                 }
1564                 return $block;
1565         }
1566
1567         /**
1568          * @since 1.16.3
1569          * @param int $size
1570          * @return string
1571          */
1572         public static function formatRevisionSize( $size ) {
1573                 if ( $size == 0 ) {
1574                         $stxt = wfMessage( 'historyempty' )->escaped();
1575                 } else {
1576                         $stxt = wfMessage( 'nbytes' )->numParams( $size )->escaped();
1577                         $stxt = wfMessage( 'parentheses' )->rawParams( $stxt )->escaped();
1578                 }
1579                 return "<span class=\"history-size\">$stxt</span>";
1580         }
1581
1582         /**
1583          * Add another level to the Table of Contents
1584          *
1585          * @since 1.16.3
1586          * @return string
1587          */
1588         public static function tocIndent() {
1589                 return "\n<ul>";
1590         }
1591
1592         /**
1593          * Finish one or more sublevels on the Table of Contents
1594          *
1595          * @since 1.16.3
1596          * @param int $level
1597          * @return string
1598          */
1599         public static function tocUnindent( $level ) {
1600                 return "</li>\n" . str_repeat( "</ul>\n</li>\n", $level > 0 ? $level : 0 );
1601         }
1602
1603         /**
1604          * parameter level defines if we are on an indentation level
1605          *
1606          * @since 1.16.3
1607          * @param string $anchor
1608          * @param string $tocline
1609          * @param string $tocnumber
1610          * @param string $level
1611          * @param string|bool $sectionIndex
1612          * @return string
1613          */
1614         public static function tocLine( $anchor, $tocline, $tocnumber, $level, $sectionIndex = false ) {
1615                 $classes = "toclevel-$level";
1616                 if ( $sectionIndex !== false ) {
1617                         $classes .= " tocsection-$sectionIndex";
1618                 }
1619                 return "\n<li class=\"$classes\"><a href=\"#" .
1620                         $anchor . '"><span class="tocnumber">' .
1621                         $tocnumber . '</span> <span class="toctext">' .
1622                         $tocline . '</span></a>';
1623         }
1624
1625         /**
1626          * End a Table Of Contents line.
1627          * tocUnindent() will be used instead if we're ending a line below
1628          * the new level.
1629          * @since 1.16.3
1630          * @return string
1631          */
1632         public static function tocLineEnd() {
1633                 return "</li>\n";
1634         }
1635
1636         /**
1637          * Wraps the TOC in a table and provides the hide/collapse javascript.
1638          *
1639          * @since 1.16.3
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
1643          */
1644         public static function tocList( $toc, $lang = false ) {
1645                 $lang = wfGetLangObj( $lang );
1646                 $title = wfMessage( 'toc' )->inLanguage( $lang )->escaped();
1647
1648                 return '<div id="toc" class="toc">'
1649                         . '<div id="toctitle"><h2>' . $title . "</h2></div>\n"
1650                         . $toc
1651                         . "</ul>\n</div>\n";
1652         }
1653
1654         /**
1655          * Generate a table of contents from a section tree.
1656          *
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
1661          */
1662         public static function generateTOC( $tree, $lang = false ) {
1663                 $toc = '';
1664                 $lastLevel = 0;
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'] );
1671                         } else {
1672                                 $toc .= self::tocLineEnd();
1673                         }
1674
1675                         $toc .= self::tocLine( $section['anchor'],
1676                                 $section['line'], $section['number'],
1677                                 $section['toclevel'], $section['index'] );
1678                         $lastLevel = $section['toclevel'];
1679                 }
1680                 $toc .= self::tocLineEnd();
1681                 return self::tocList( $toc, $lang );
1682         }
1683
1684         /**
1685          * Create a headline for content
1686          *
1687          * @since 1.16.3
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)
1697          *
1698          * @return string HTML headline
1699          */
1700         public static function makeHeadline( $level, $attribs, $anchor, $html,
1701                 $link, $legacyAnchor = false
1702         ) {
1703                 $ret = "<h$level$attribs"
1704                         . "<span class=\"mw-headline\" id=\"$anchor\">$html</span>"
1705                         . $link
1706                         . "</h$level>";
1707                 if ( $legacyAnchor !== false ) {
1708                         $ret = "<div id=\"$legacyAnchor\"></div>$ret";
1709                 }
1710                 return $ret;
1711         }
1712
1713         /**
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
1717          * @return array
1718          */
1719         static function splitTrail( $trail ) {
1720                 global $wgContLang;
1721                 $regex = $wgContLang->linkTrail();
1722                 $inside = '';
1723                 if ( $trail !== '' ) {
1724                         $m = [];
1725                         if ( preg_match( $regex, $trail, $m ) ) {
1726                                 $inside = $m[1];
1727                                 $trail = $m[2];
1728                         }
1729                 }
1730                 return [ $inside, $trail ];
1731         }
1732
1733         /**
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.
1737          *
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
1742          * other users.
1743          *
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.
1750          *
1751          * If the option noBrackets is set the rollback link wont be enclosed in "[]".
1752          *
1753          * @since 1.16.3. $context added in 1.20. $options added in 1.21
1754          *
1755          * @param Revision $rev
1756          * @param IContextSource $context Context to use or null for the main context.
1757          * @param array $options
1758          * @return string
1759          */
1760         public static function generateRollback( $rev, IContextSource $context = null,
1761                 $options = [ 'verify' ]
1762         ) {
1763                 if ( $context === null ) {
1764                         $context = RequestContext::getMain();
1765                 }
1766
1767                 $editCount = false;
1768                 if ( in_array( 'verify', $options, true ) ) {
1769                         $editCount = self::getRollbackEditCount( $rev, true );
1770                         if ( $editCount === false ) {
1771                                 return '';
1772                         }
1773                 }
1774
1775                 $inner = self::buildRollbackLink( $rev, $context, $editCount );
1776
1777                 if ( !in_array( 'noBrackets', $options, true ) ) {
1778                         $inner = $context->msg( 'brackets' )->rawParams( $inner )->escaped();
1779                 }
1780
1781                 return '<span class="mw-rollback-link">' . $inner . '</span>';
1782         }
1783
1784         /**
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.
1791          *
1792          * Returns null if $wgShowRollbackEditCount is disabled or false if $verify
1793          * is set and the user is the only contributor of the page.
1794          *
1795          * @param Revision $rev
1796          * @param bool $verify Try to verify that this revision can really be rolled back
1797          * @return int|bool|null
1798          */
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'
1803                         return null;
1804                 }
1805
1806                 $dbr = wfGetDB( DB_SLAVE );
1807
1808                 // Up to the value of $wgShowRollbackEditCount revisions are counted
1809                 $res = $dbr->select(
1810                         'revision',
1811                         [ 'rev_user_text', 'rev_deleted' ],
1812                         // $rev->getPage() returns null sometimes
1813                         [ 'rev_page' => $rev->getTitle()->getArticleID() ],
1814                         __METHOD__,
1815                         [
1816                                 'USE INDEX' => [ 'revision' => 'page_timestamp' ],
1817                                 'ORDER BY' => 'rev_timestamp DESC',
1818                                 'LIMIT' => $wgShowRollbackEditCount + 1
1819                         ]
1820                 );
1821
1822                 $editCount = 0;
1823                 $moreRevs = false;
1824                 foreach ( $res as $row ) {
1825                         if ( $rev->getUserText( Revision::RAW ) != $row->rev_user_text ) {
1826                                 if ( $verify &&
1827                                         ( $row->rev_deleted & Revision::DELETED_TEXT
1828                                                 || $row->rev_deleted & Revision::DELETED_USER
1829                                 ) ) {
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.
1833                                         return false;
1834                                 }
1835                                 $moreRevs = true;
1836                                 break;
1837                         }
1838                         $editCount++;
1839                 }
1840
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
1845                         return false;
1846                 }
1847                 return $editCount;
1848         }
1849
1850         /**
1851          * Build a raw rollback link, useful for collections of "tool" links
1852          *
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
1858          */
1859         public static function buildRollbackLink( $rev, IContextSource $context = null,
1860                 $editCount = false
1861         ) {
1862                 global $wgShowRollbackEditCount, $wgMiserMode;
1863
1864                 // To config which pages are affected by miser mode
1865                 $disableRollbackEditCountSpecialPage = [ 'Recentchanges', 'Watchlist' ];
1866
1867                 if ( $context === null ) {
1868                         $context = RequestContext::getMain();
1869                 }
1870
1871                 $title = $rev->getTitle();
1872                 $query = [
1873                         'action' => 'rollback',
1874                         'from' => $rev->getUserText(),
1875                         'token' => $context->getUser()->getEditToken( 'rollback' ),
1876                 ];
1877                 $attrs = [
1878                         'data-mw' => 'interface',
1879                         'title' => $context->msg( 'tooltip-rollback' )->text(),
1880                 ];
1881                 $options = [ 'known', 'noclasses' ];
1882
1883                 if ( $context->getRequest()->getBool( 'bot' ) ) {
1884                         $query['bot'] = '1';
1885                         $query['hidediff'] = '1'; // bug 15999
1886                 }
1887
1888                 $disableRollbackEditCount = false;
1889                 if ( $wgMiserMode ) {
1890                         foreach ( $disableRollbackEditCountSpecialPage as $specialPage ) {
1891                                 if ( $context->getTitle()->isSpecial( $specialPage ) ) {
1892                                         $disableRollbackEditCount = true;
1893                                         break;
1894                                 }
1895                         }
1896                 }
1897
1898                 if ( !$disableRollbackEditCount
1899                         && is_int( $wgShowRollbackEditCount )
1900                         && $wgShowRollbackEditCount > 0
1901                 ) {
1902                         if ( !is_numeric( $editCount ) ) {
1903                                 $editCount = self::getRollbackEditCount( $rev, false );
1904                         }
1905
1906                         if ( $editCount > $wgShowRollbackEditCount ) {
1907                                 $html = $context->msg( 'rollbacklinkcount-morethan' )
1908                                         ->numParams( $wgShowRollbackEditCount )->parse();
1909                         } else {
1910                                 $html = $context->msg( 'rollbacklinkcount' )->numParams( $editCount )->parse();
1911                         }
1912
1913                         return self::link( $title, $html, $attrs, $query, $options );
1914                 } else {
1915                         $html = $context->msg( 'rollbacklink' )->escaped();
1916                         return self::link( $title, $html, $attrs, $query, $options );
1917                 }
1918         }
1919
1920         /**
1921          * Returns HTML for the "templates used on this page" list.
1922          *
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().
1928          *
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
1935          */
1936         public static function formatTemplates( $templates, $preview = false,
1937                 $section = false, $more = null
1938         ) {
1939                 global $wgLang;
1940
1941                 $outText = '';
1942                 if ( count( $templates ) > 0 ) {
1943                         # Do a batch existence check
1944                         $batch = new LinkBatch;
1945                         foreach ( $templates as $title ) {
1946                                 $batch->addObj( $title );
1947                         }
1948                         $batch->execute();
1949
1950                         # Construct the HTML
1951                         $outText = '<div class="mw-templatesUsedExplanation">';
1952                         if ( $preview ) {
1953                                 $outText .= wfMessage( 'templatesusedpreview' )->numParams( count( $templates ) )
1954                                         ->parseAsBlock();
1955                         } elseif ( $section ) {
1956                                 $outText .= wfMessage( 'templatesusedsection' )->numParams( count( $templates ) )
1957                                         ->parseAsBlock();
1958                         } else {
1959                                 $outText .= wfMessage( 'templatesused' )->numParams( count( $templates ) )
1960                                         ->parseAsBlock();
1961                         }
1962                         $outText .= "</div><ul>\n";
1963
1964                         usort( $templates, 'Title::compare' );
1965                         foreach ( $templates as $titleObj ) {
1966                                 $protected = '';
1967                                 $restrictions = $titleObj->getRestrictions( 'edit' );
1968                                 if ( $restrictions ) {
1969                                         // Check backwards-compatible messages
1970                                         $msg = null;
1971                                         if ( $restrictions === [ 'sysop' ] ) {
1972                                                 $msg = wfMessage( 'template-protected' );
1973                                         } elseif ( $restrictions === [ 'autoconfirmed' ] ) {
1974                                                 $msg = wfMessage( 'template-semiprotected' );
1975                                         }
1976                                         if ( $msg && !$msg->isDisabled() ) {
1977                                                 $protected = $msg->parse();
1978                                         } else {
1979                                                 // Construct the message from restriction-level-*
1980                                                 // e.g. restriction-level-sysop, restriction-level-autoconfirmed
1981                                                 $msgs = [];
1982                                                 foreach ( $restrictions as $r ) {
1983                                                         $msgs[] = wfMessage( "restriction-level-$r" )->parse();
1984                                                 }
1985                                                 $protected = wfMessage( 'parentheses' )
1986                                                         ->rawParams( $wgLang->commaList( $msgs ) )->escaped();
1987                                         }
1988                                 }
1989                                 if ( $titleObj->quickUserCan( 'edit' ) ) {
1990                                         $editLink = self::link(
1991                                                 $titleObj,
1992                                                 wfMessage( 'editlink' )->escaped(),
1993                                                 [],
1994                                                 [ 'action' => 'edit' ]
1995                                         );
1996                                 } else {
1997                                         $editLink = self::link(
1998                                                 $titleObj,
1999                                                 wfMessage( 'viewsourcelink' )->escaped(),
2000                                                 [],
2001                                                 [ 'action' => 'edit' ]
2002                                         );
2003                                 }
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>';
2009                         }
2010
2011                         if ( $more instanceof Title ) {
2012                                 $outText .= '<li>' . self::link( $more, wfMessage( 'moredotdotdot' ) ) . '</li>';
2013                         } elseif ( $more ) {
2014                                 $outText .= "<li>$more</li>";
2015                         }
2016
2017                         $outText .= '</ul>';
2018                 }
2019                 return $outText;
2020         }
2021
2022         /**
2023          * Returns HTML for the "hidden categories on this page" list.
2024          *
2025          * @since 1.16.3
2026          * @param array $hiddencats Array of hidden categories from Article::getHiddenCategories
2027          *   or similar
2028          * @return string HTML output
2029          */
2030         public static function formatHiddenCategories( $hiddencats ) {
2031
2032                 $outText = '';
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";
2038
2039                         foreach ( $hiddencats as $titleObj ) {
2040                                 # If it's hidden, it must exist - no need to check with a LinkBatch
2041                                 $outText .= '<li>'
2042                                         . self::link( $titleObj, null, [], [], 'known' )
2043                                         . "</li>\n";
2044                         }
2045                         $outText .= '</ul>';
2046                 }
2047                 return $outText;
2048         }
2049
2050         /**
2051          * Format a size in bytes for output, using an appropriate
2052          * unit (B, KB, MB or GB) according to the magnitude in question
2053          *
2054          * @since 1.16.3
2055          * @param int $size Size to format
2056          * @return string
2057          */
2058         public static function formatSize( $size ) {
2059                 global $wgLang;
2060                 return htmlspecialchars( $wgLang->formatSize( $size ) );
2061         }
2062
2063         /**
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.)
2068          *
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-
2072          *   key hint
2073          * @param array $msgParams Parameters to pass to the message
2074          *
2075          * @return string Contents of the title attribute (which you must HTML-
2076          *   escape), or false for no title attribute
2077          */
2078         public static function titleAttrib( $name, $options = null, array $msgParams = [] ) {
2079                 $message = wfMessage( "tooltip-$name", $msgParams );
2080                 if ( !$message->exists() ) {
2081                         $tooltip = false;
2082                 } else {
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 == '-' ) {
2088                                 $tooltip = false;
2089                         }
2090                 }
2091
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();
2098                                 } else {
2099                                         $tooltip .= wfMessage( 'word-separator' )->text();
2100                                         $tooltip .= wfMessage( 'brackets', $accesskey )->text();
2101                                 }
2102                         }
2103                 }
2104
2105                 return $tooltip;
2106         }
2107
2108         public static $accesskeycache;
2109
2110         /**
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.)
2115          *
2116          * @since 1.16.3
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
2120          */
2121         public static function accesskey( $name ) {
2122                 if ( isset( self::$accesskeycache[$name] ) ) {
2123                         return self::$accesskeycache[$name];
2124                 }
2125
2126                 $message = wfMessage( "accesskey-$name" );
2127
2128                 if ( !$message->exists() ) {
2129                         $accesskey = false;
2130                 } else {
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
2135                                 # value.
2136                                 $accesskey = false;
2137                         }
2138                 }
2139
2140                 self::$accesskeycache[$name] = $accesskey;
2141                 return self::$accesskeycache[$name];
2142         }
2143
2144         /**
2145          * Get a revision-deletion link, or disabled link, or nothing, depending
2146          * on user permissions & the settings on the revision.
2147          *
2148          * Will use forward-compatible revision ID in the Special:RevDelete link
2149          * if possible, otherwise the timestamp-based ID which may break after
2150          * undeletion.
2151          *
2152          * @param User $user
2153          * @param Revision $rev
2154          * @param Title $title
2155          * @return string HTML fragment
2156          */
2157         public static function getRevDeleteLink( User $user, Revision $rev, Title $title ) {
2158                 $canHide = $user->isAllowed( 'deleterevision' );
2159                 if ( !$canHide && !( $rev->getVisibility() && $user->isAllowed( 'deletedhistory' ) ) ) {
2160                         return '';
2161                 }
2162
2163                 if ( !$rev->userCan( Revision::DELETED_RESTRICTED, $user ) ) {
2164                         return Linker::revDeleteLinkDisabled( $canHide ); // revision was hidden from sysops
2165                 } else {
2166                         if ( $rev->getId() ) {
2167                                 // RevDelete links using revision ID are stable across
2168                                 // page deletion and undeletion; use when possible.
2169                                 $query = [
2170                                         'type' => 'revision',
2171                                         'target' => $title->getPrefixedDBkey(),
2172                                         'ids' => $rev->getId()
2173                                 ];
2174                         } else {
2175                                 // Older deleted entries didn't save a revision ID.
2176                                 // We have to refer to these by timestamp, ick!
2177                                 $query = [
2178                                         'type' => 'archive',
2179                                         'target' => $title->getPrefixedDBkey(),
2180                                         'ids' => $rev->getTimestamp()
2181                                 ];
2182                         }
2183                         return Linker::revDeleteLink( $query,
2184                                 $rev->isDeleted( Revision::DELETED_RESTRICTED ), $canHide );
2185                 }
2186         }
2187
2188         /**
2189          * Creates a (show/hide) link for deleting revisions/log entries
2190          *
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)
2194          *
2195          * @return string HTML "<a>" link to Special:Revisiondelete, wrapped in a
2196          * span to allow for customization of appearance with CSS
2197          */
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' ] );
2204                 return Xml::tags(
2205                         $tag,
2206                         [ 'class' => 'mw-revdelundel-link' ],
2207                         wfMessage( 'parentheses' )->rawParams( $link )->escaped()
2208                 );
2209         }
2210
2211         /**
2212          * Creates a dead (show/hide) link for deleting revisions/log entries
2213          *
2214          * @since 1.16.3
2215          * @param bool $delete Set to true to use (show/hide) rather than (show)
2216          *
2217          * @return string HTML text wrapped in a span to allow for customization
2218          * of appearance with CSS
2219          */
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 );
2225         }
2226
2227         /* Deprecated methods */
2228
2229         /**
2230          * Returns the attributes for the tooltip and access key.
2231          *
2232          * @since 1.16.3. $msgParams introduced in 1.27
2233          * @param string $name
2234          * @param array $msgParams Params for constructing the message
2235          *
2236          * @return array
2237          */
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.
2242                 $attribs = [
2243                         'title' => self::titleAttrib( $name, 'withaccess', $msgParams ),
2244                         'accesskey' => self::accesskey( $name )
2245                 ];
2246                 if ( $attribs['title'] === false ) {
2247                         unset( $attribs['title'] );
2248                 }
2249                 if ( $attribs['accesskey'] === false ) {
2250                         unset( $attribs['accesskey'] );
2251                 }
2252                 return $attribs;
2253         }
2254
2255         /**
2256          * Returns raw bits of HTML, use titleAttrib()
2257          * @since 1.16.3
2258          * @param string $name
2259          * @param array|null $options
2260          * @return null|string
2261          */
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 ) {
2268                         return '';
2269                 }
2270                 return Xml::expandAttributes( [
2271                         'title' => $tooltip
2272                 ] );
2273         }
2274
2275 }
2276