includes/Linker.php

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