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