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