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                 if ( $html == '' ) {
 412                         $html = htmlspecialchars( $nt->getPrefixedText() );
 413                 }
 414                 list( $inside, $trail ) = self::splitTrail( $trail );
 415                 return "<strong class=\"selflink\">{$prefix}{$html}{$inside}</strong>{$trail}";
 416         }
 417
 418         /**
 419          * Get a message saying that an invalid title was encountered.
 420          * This should be called after a method like Title::makeTitleSafe() returned
 421          * a value indicating that the title object is invalid.
 422          *
 423          * @param IContextSource $context Context to use to get the messages
 424          * @param int $namespace Namespace number
 425          * @param string $title Text of the title, without the namespace part
 426          * @return string
 427          */
 428         public static function getInvalidTitleDescription( IContextSource $context, $namespace, $title ) {
 429                 global $wgContLang;
 430
 431                 // First we check whether the namespace exists or not.
 432                 if ( MWNamespace::exists( $namespace ) ) {
 433                         if ( $namespace == NS_MAIN ) {
 434                                 $name = $context->msg( 'blanknamespace' )->text();
 435                         } else {
 436                                 $name = $wgContLang->getFormattedNsText( $namespace );
 437                         }
 438                         return $context->msg( 'invalidtitle-knownnamespace', $namespace, $name, $title )->text();
 439                 } else {
 440                         return $context->msg( 'invalidtitle-unknownnamespace', $namespace, $title )->text();
 441                 }
 442         }
 443
 444         /**
 445          * @param Title $title
 446          * @return Title
 447          */
 448         static function normaliseSpecialPage( Title $title ) {
 449                 if ( $title->isSpecialPage() ) {
 450                         list( $name, $subpage ) = SpecialPageFactory::resolveAlias( $title->getDBkey() );
 451                         if ( !$name ) {
 452                                 return $title;
 453                         }
 454                         $ret = SpecialPage::getTitleFor( $name, $subpage, $title->getFragment() );
 455                         return $ret;
 456                 } else {
 457                         return $title;
 458                 }
 459         }
 460
 461         /**
 462          * Returns the filename part of an url.
 463          * Used as alternative text for external images.
 464          *
 465          * @param string $url
 466          *
 467          * @return string
 468          */
 469         private static function fnamePart( $url ) {
 470                 $basename = strrchr( $url, '/' );
 471                 if ( false === $basename ) {
 472                         $basename = $url;
 473                 } else {
 474                         $basename = substr( $basename, 1 );
 475                 }
 476                 return $basename;
 477         }
 478
 479         /**
 480          * Return the code for images which were added via external links,
 481          * via Parser::maybeMakeExternalImage().
 482          *
 483          * @param string $url
 484          * @param string $alt
 485          *
 486          * @return string
 487          */
 488         public static function makeExternalImage( $url, $alt = '' ) {
 489                 if ( $alt == '' ) {
 490                         $alt = self::fnamePart( $url );
 491                 }
 492                 $img = '';
 493                 $success = wfRunHooks( 'LinkerMakeExternalImage', array( &$url, &$alt, &$img ) );
 494                 if ( !$success ) {
 495                         wfDebug( "Hook LinkerMakeExternalImage changed the output of external image "
 496                                 . "with url {$url} and alt text {$alt} to {$img}\n", true );
 497                         return $img;
 498                 }
 499                 return Html::element( 'img',
 500                         array(
 501                                 'src' => $url,
 502                                 'alt' => $alt ) );
 503         }
 504
 505         /**
 506          * Given parameters derived from [[Image:Foo|options...]], generate the
 507          * HTML that that syntax inserts in the page.
 508          *
 509          * @param Parser $parser
 510          * @param Title $title Title object of the file (not the currently viewed page)
 511          * @param File $file File object, or false if it doesn't exist
 512          * @param array $frameParams Associative array of parameters external to the media handler.
 513          *     Boolean parameters are indicated by presence or absence, the value is arbitrary and
 514          *     will often be false.
 515          *          thumbnail       If present, downscale and frame
 516          *          manualthumb     Image name to use as a thumbnail, instead of automatic scaling
 517          *          framed          Shows image in original size in a frame
 518          *          frameless       Downscale but don't frame
 519          *          upright         If present, tweak default sizes for portrait orientation
 520          *          upright_factor  Fudge factor for "upright" tweak (default 0.75)
 521          *          border          If present, show a border around the image
 522          *          align           Horizontal alignment (left, right, center, none)
 523          *          valign          Vertical alignment (baseline, sub, super, top, text-top, middle,
 524          *                          bottom, text-bottom)
 525          *          alt             Alternate text for image (i.e. alt attribute). Plain text.
 526          *          class           HTML for image classes. Plain text.
 527          *          caption         HTML for image caption.
 528          *          link-url        URL to link to
 529          *          link-title      Title object to link to
 530          *          link-target     Value for the target attribute, only with link-url
 531          *          no-link         Boolean, suppress description link
 532          *
 533          * @param array $handlerParams Associative array of media handler parameters, to be passed
 534          *       to transform(). Typical keys are "width" and "page".
 535          * @param string|bool $time Timestamp of the file, set as false for current
 536          * @param string $query Query params for desc url
 537          * @param int|null $widthOption Used by the parser to remember the user preference thumbnailsize
 538          * @since 1.20
 539          * @return string HTML for an image, with links, wrappers, etc.
 540          */
 541         public static function makeImageLink( /*Parser*/ $parser, Title $title,
 542                 $file, $frameParams = array(), $handlerParams = array(), $time = false,
 543                 $query = "", $widthOption = null
 544         ) {
 545                 $res = null;
 546                 $dummy = new DummyLinker;
 547                 if ( !wfRunHooks( 'ImageBeforeProduceHTML', array( &$dummy, &$title,
 548                         &$file, &$frameParams, &$handlerParams, &$time, &$res ) ) ) {
 549                         return $res;
 550                 }
 551
 552                 if ( $file && !$file->allowInlineDisplay() ) {
 553                         wfDebug( __METHOD__ . ': ' . $title->getPrefixedDBkey() . " does not allow inline display\n" );
 554                         return self::link( $title );
 555                 }
 556
 557                 // Shortcuts
 558                 $fp =& $frameParams;
 559                 $hp =& $handlerParams;
 560
 561                 // Clean up parameters
 562                 $page = isset( $hp['page'] ) ? $hp['page'] : false;
 563                 if ( !isset( $fp['align'] ) ) {
 564                         $fp['align'] = '';
 565                 }
 566                 if ( !isset( $fp['alt'] ) ) {
 567                         $fp['alt'] = '';
 568                 }
 569                 if ( !isset( $fp['title'] ) ) {
 570                         $fp['title'] = '';
 571                 }
 572                 if ( !isset( $fp['class'] ) ) {
 573                         $fp['class'] = '';
 574                 }
 575
 576                 $prefix = $postfix = '';
 577
 578                 if ( 'center' == $fp['align'] ) {
 579                         $prefix = '<div class="center">';
 580                         $postfix = '</div>';
 581                         $fp['align'] = 'none';
 582                 }
 583                 if ( $file && !isset( $hp['width'] ) ) {
 584                         if ( isset( $hp['height'] ) && $file->isVectorized() ) {
 585                                 // If its a vector image, and user only specifies height
 586                                 // we don't want it to be limited by its "normal" width.
 587                                 global $wgSVGMaxSize;
 588                                 $hp['width'] = $wgSVGMaxSize;
 589                         } else {
 590                                 $hp['width'] = $file->getWidth( $page );
 591                         }
 592
 593                         if ( isset( $fp['thumbnail'] )
 594                                 || isset( $fp['manualthumb'] )
 595                                 || isset( $fp['framed'] )
 596                                 || isset( $fp['frameless'] )
 597                                 || !$hp['width']
 598                         ) {
 599                                 global $wgThumbLimits, $wgThumbUpright;
 600
 601                                 if ( $widthOption === null || !isset( $wgThumbLimits[$widthOption] ) ) {
 602                                         $widthOption = User::getDefaultOption( 'thumbsize' );
 603                                 }
 604
 605                                 // Reduce width for upright images when parameter 'upright' is used
 606                                 $useSquare = !isset( $fp['upright'] );
 607                                 if ( isset( $fp['upright'] ) && $fp['upright'] == 0 ) {
 608                                         $fp['upright'] = $wgThumbUpright;
 609                                 }
 610
 611                                 // For caching health: If width scaled down due to upright
 612                                 // parameter, round to full __0 pixel to avoid the creation of a
 613                                 // lot of odd thumbs.
 614                                 $prefWidth = isset( $fp['upright'] ) ?
 615                                         round( $wgThumbLimits[$widthOption] * $fp['upright'], -1 ) :
 616                                         $wgThumbLimits[$widthOption];
 617
 618                                 // Use whichever is smaller: real image width or user preference width
 619                                 // Unless image is scalable vector.
 620                                 if ( !isset( $hp['height'] ) && ( $hp['width'] <= 0 ||
 621                                                 $prefWidth < $hp['width'] ||
 622                                                 ( $useSquare && $prefWidth < $file->getHeight( $page ) ) ||
 623                                                 $file->isVectorized() ) ) {
 624                                         $hp['width'] = $prefWidth;
 625                                         if ( $useSquare ) {
 626                                                 $hp['height'] = $prefWidth;
 627                                         }
 628                                 }
 629                         }
 630                 }
 631
 632                 if ( isset( $fp['thumbnail'] ) || isset( $fp['manualthumb'] ) || isset( $fp['framed'] ) ) {
 633                         # Create a thumbnail. Alignment depends on the writing direction of
 634                         # the page content language (right-aligned for LTR languages,
 635                         # left-aligned for RTL languages)
 636                         #
 637                         # If a thumbnail width has not been provided, it is set
 638                         # to the default user option as specified in Language*.php
 639                         if ( $fp['align'] == '' ) {
 640                                 if ( $parser instanceof Parser ) {
 641                                         $fp['align'] = $parser->getTargetLanguage()->alignEnd();
 642                                 } else {
 643                                         # backwards compatibility, remove with makeImageLink2()
 644                                         global $wgContLang;
 645                                         $fp['align'] = $wgContLang->alignEnd();
 646                                 }
 647                         }
 648                         return $prefix . self::makeThumbLink2( $title, $file, $fp, $hp, $time, $query ) . $postfix;
 649                 }
 650
 651                 if ( $file && isset( $fp['frameless'] ) ) {
 652                         $srcWidth = $file->getWidth( $page );
 653                         # For "frameless" option: do not present an image bigger than the
 654                         # source (for bitmap-style images). This is the same behavior as the
 655                         # "thumb" option does it already.
 656                         if ( $srcWidth && !$file->mustRender() && $hp['width'] > $srcWidth ) {
 657                                 $hp['width'] = $srcWidth;
 658                         }
 659                 }
 660
 661                 if ( $file && isset( $hp['width'] ) ) {
 662                         # Create a resized image, without the additional thumbnail features
 663                         $thumb = $file->transform( $hp );
 664                 } else {
 665                         $thumb = false;
 666                 }
 667
 668                 if ( !$thumb ) {
 669                         $s = self::makeBrokenImageLinkObj( $title, $fp['title'], '', '', '', $time == true );
 670                 } else {
 671                         self::processResponsiveImages( $file, $thumb, $hp );
 672                         $params = array(
 673                                 'alt' => $fp['alt'],
 674                                 'title' => $fp['title'],
 675                                 'valign' => isset( $fp['valign'] ) ? $fp['valign'] : false,
 676                                 'img-class' => $fp['class'] );
 677                         if ( isset( $fp['border'] ) ) {
 678                                 $params['img-class'] .= ( $params['img-class'] !== '' ? ' ' : '' ) . 'thumbborder';
 679                         }
 680                         $params = self::getImageLinkMTOParams( $fp, $query, $parser ) + $params;
 681
 682                         $s = $thumb->toHtml( $params );
 683                 }
 684                 if ( $fp['align'] != '' ) {
 685                         $s = "<div class=\"float{$fp['align']}\">{$s}</div>";
 686                 }
 687                 return str_replace( "\n", ' ', $prefix . $s . $postfix );
 688         }
 689
 690         /**
 691          * See makeImageLink()
 692          * When this function is removed, remove if( $parser instanceof Parser ) check there too
 693          * @deprecated since 1.20
 694          */
 695         public static function makeImageLink2( Title $title, $file, $frameParams = array(),
 696                 $handlerParams = array(), $time = false, $query = "", $widthOption = null ) {
 697                 return self::makeImageLink( null, $title, $file, $frameParams,
 698                         $handlerParams, $time, $query, $widthOption );
 699         }
 700
 701         /**
 702          * Get the link parameters for MediaTransformOutput::toHtml() from given
 703          * frame parameters supplied by the Parser.
 704          * @param array $frameParams The frame parameters
 705          * @param string $query An optional query string to add to description page links
 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         /** @var Title */
1322         private static $autocommentTitle;
1323
1324         /** @var bool Whether section links should refer to local page */
1325         private static $autocommentLocal;
1326
1327         /**
1328          * Converts autogenerated comments in edit summaries into section links.
1329          * The pattern for autogen comments is / * foo * /, which makes for
1330          * some nasty regex.
1331          * We look for all comments, match any text before and after the comment,
1332          * add a separator where needed and format the comment itself with CSS
1333          * Called by Linker::formatComment.
1334          *
1335          * @param string $comment Comment text
1336          * @param Title|null $title An optional title object used to links to sections
1337          * @param bool $local Whether section links should refer to local page
1338          * @return string Formatted comment
1339          */
1340         private static function formatAutocomments( $comment, $title = null, $local = false ) {
1341                 // Bah!
1342                 self::$autocommentTitle = $title;
1343                 self::$autocommentLocal = $local;
1344                 $comment = preg_replace_callback(
1345                         '!(.*)/\*\s*(.*?)\s*\*/(.*)!',
1346                         array( 'Linker', 'formatAutocommentsCallback' ),
1347                         $comment );
1348                 self::$autocommentTitle = null;
1349                 self::$autocommentLocal = null;
1350                 return $comment;
1351         }
1352
1353         /**
1354          * Helper function for Linker::formatAutocomments
1355          * @param array $match
1356          * @return string
1357          */
1358         private static function formatAutocommentsCallback( $match ) {
1359                 global $wgLang;
1360                 $title = self::$autocommentTitle;
1361                 $local = self::$autocommentLocal;
1362
1363                 $pre = $match[1];
1364                 $auto = $match[2];
1365                 $post = $match[3];
1366                 $comment = null;
1367                 wfRunHooks( 'FormatAutocomments', array( &$comment, $pre, $auto, $post, $title, $local ) );
1368                 if ( $comment === null ) {
1369                         $link = '';
1370                         if ( $title ) {
1371                                 $section = $auto;
1372
1373                                 # Remove links that a user may have manually put in the autosummary
1374                                 # This could be improved by copying as much of Parser::stripSectionName as desired.
1375                                 $section = str_replace( '[[:', '', $section );
1376                                 $section = str_replace( '[[', '', $section );
1377                                 $section = str_replace( ']]', '', $section );
1378
1379                                 $section = Sanitizer::normalizeSectionNameWhitespace( $section ); # bug 22784
1380                                 if ( $local ) {
1381                                         $sectionTitle = Title::newFromText( '#' . $section );
1382                                 } else {
1383                                         $sectionTitle = Title::makeTitleSafe( $title->getNamespace(),
1384                                                 $title->getDBkey(), $section );
1385                                 }
1386                                 if ( $sectionTitle ) {
1387                                         $link = self::link( $sectionTitle,
1388                                                 $wgLang->getArrow(), array(), array(),
1389                                                 'noclasses' );
1390                                 } else {
1391                                         $link = '';
1392                                 }
1393                         }
1394                         if ( $pre ) {
1395                                 # written summary $presep autocomment (summary /* section */)
1396                                 $pre .= wfMessage( 'autocomment-prefix' )->inContentLanguage()->escaped();
1397                         }
1398                         if ( $post ) {
1399                                 # autocomment $postsep written summary (/* section */ summary)
1400                                 $auto .= wfMessage( 'colon-separator' )->inContentLanguage()->escaped();
1401                         }
1402                         $auto = '<span class="autocomment">' . $auto . '</span>';
1403                         $comment = $pre . $link . $wgLang->getDirMark()
1404                                 . '<span dir="auto">' . $auto . $post . '</span>';
1405                 }
1406                 return $comment;
1407         }
1408
1409         /** @var Title */
1410         private static $commentContextTitle;
1411
1412         /** @var bool Whether section links should refer to local page */
1413         private static $commentLocal;
1414
1415         /**
1416          * Formats wiki links and media links in text; all other wiki formatting
1417          * is ignored
1418          *
1419          * @todo FIXME: Doesn't handle sub-links as in image thumb texts like the main parser
1420          * @param string $comment Text to format links in
1421          * @param Title|null $title An optional title object used to links to sections
1422          * @param bool $local Whether section links should refer to local page
1423          * @return string
1424          */
1425         public static function formatLinksInComment( $comment, $title = null, $local = false ) {
1426                 self::$commentContextTitle = $title;
1427                 self::$commentLocal = $local;
1428                 $html = preg_replace_callback(
1429                         '/
1430                                 \[\[
1431                                 :? # ignore optional leading colon
1432                                 ([^\]|]+) # 1. link target; page names cannot include ] or |
1433                                 (?:\|
1434                                         # 2. a pipe-separated substring; only the last is captured
1435                                         # Stop matching at | and ]] without relying on backtracking.
1436                                         ((?:]?[^\]|])*+)
1437                                 )*
1438                                 \]\]
1439                                 ([^[]*) # 3. link trail (the text up until the next link)
1440                         /x',
1441                         array( 'Linker', 'formatLinksInCommentCallback' ),
1442                         $comment );
1443                 self::$commentContextTitle = null;
1444                 self::$commentLocal = null;
1445                 return $html;
1446         }
1447
1448         /**
1449          * @param array $match
1450          * @return mixed
1451          */
1452         protected static function formatLinksInCommentCallback( $match ) {
1453                 global $wgContLang;
1454
1455                 $medians = '(?:' . preg_quote( MWNamespace::getCanonicalName( NS_MEDIA ), '/' ) . '|';
1456                 $medians .= preg_quote( $wgContLang->getNsText( NS_MEDIA ), '/' ) . '):';
1457
1458                 $comment = $match[0];
1459
1460                 # fix up urlencoded title texts (copied from Parser::replaceInternalLinks)
1461                 if ( strpos( $match[1], '%' ) !== false ) {
1462                         $match[1] = str_replace( array( '<', '>' ), array( '&lt;', '&gt;' ), rawurldecode( $match[1] ) );
1463                 }
1464
1465                 # Handle link renaming [[foo|text]] will show link as "text"
1466                 if ( $match[2] != "" ) {
1467                         $text = $match[2];
1468                 } else {
1469                         $text = $match[1];
1470                 }
1471                 $submatch = array();
1472                 $thelink = null;
1473                 if ( preg_match( '/^' . $medians . '(.*)$/i', $match[1], $submatch ) ) {
1474                         # Media link; trail not supported.
1475                         $linkRegexp = '/\[\[(.*?)\]\]/';
1476                         $title = Title::makeTitleSafe( NS_FILE, $submatch[1] );
1477                         if ( $title ) {
1478                                 $thelink = self::makeMediaLinkObj( $title, $text );
1479                         }
1480                 } else {
1481                         # Other kind of link
1482                         if ( preg_match( $wgContLang->linkTrail(), $match[3], $submatch ) ) {
1483                                 $trail = $submatch[1];
1484                         } else {
1485                                 $trail = "";
1486                         }
1487                         $linkRegexp = '/\[\[(.*?)\]\]' . preg_quote( $trail, '/' ) . '/';
1488                         if ( isset( $match[1][0] ) && $match[1][0] == ':' ) {
1489                                 $match[1] = substr( $match[1], 1 );
1490                         }
1491                         list( $inside, $trail ) = self::splitTrail( $trail );
1492
1493                         $linkText = $text;
1494                         $linkTarget = self::normalizeSubpageLink( self::$commentContextTitle,
1495                                 $match[1], $linkText );
1496
1497                         $target = Title::newFromText( $linkTarget );
1498                         if ( $target ) {
1499                                 if ( $target->getText() == '' && !$target->isExternal()
1500                                         && !self::$commentLocal && self::$commentContextTitle
1501                                 ) {
1502                                         $newTarget = clone ( self::$commentContextTitle );
1503                                         $newTarget->setFragment( '#' . $target->getFragment() );
1504                                         $target = $newTarget;
1505                                 }
1506                                 $thelink = self::link(
1507                                         $target,
1508                                         $linkText . $inside
1509                                 ) . $trail;
1510                         }
1511                 }
1512                 if ( $thelink ) {
1513                         // If the link is still valid, go ahead and replace it in!
1514                         $comment = preg_replace(
1515                                 $linkRegexp,
1516                                 StringUtils::escapeRegexReplacement( $thelink ),
1517                                 $comment,
1518                                 1
1519                         );
1520                 }
1521
1522                 return $comment;
1523         }
1524
1525         /**
1526          * @param Title $contextTitle
1527          * @param string $target
1528          * @param string $text
1529          * @return string
1530          */
1531         public static function normalizeSubpageLink( $contextTitle, $target, &$text ) {
1532                 # Valid link forms:
1533                 # Foobar -- normal
1534                 # :Foobar -- override special treatment of prefix (images, language links)
1535                 # /Foobar -- convert to CurrentPage/Foobar
1536                 # /Foobar/ -- convert to CurrentPage/Foobar, strip the initial / from text
1537                 # ../ -- convert to CurrentPage, from CurrentPage/CurrentSubPage
1538                 # ../Foobar -- convert to CurrentPage/Foobar, from CurrentPage/CurrentSubPage
1539
1540                 wfProfileIn( __METHOD__ );
1541                 $ret = $target; # default return value is no change
1542
1543                 # Some namespaces don't allow subpages,
1544                 # so only perform processing if subpages are allowed
1545                 if ( $contextTitle && MWNamespace::hasSubpages( $contextTitle->getNamespace() ) ) {
1546                         $hash = strpos( $target, '#' );
1547                         if ( $hash !== false ) {
1548                                 $suffix = substr( $target, $hash );
1549                                 $target = substr( $target, 0, $hash );
1550                         } else {
1551                                 $suffix = '';
1552                         }
1553                         # bug 7425
1554                         $target = trim( $target );
1555                         # Look at the first character
1556                         if ( $target != '' && $target[0] === '/' ) {
1557                                 # / at end means we don't want the slash to be shown
1558                                 $m = array();
1559                                 $trailingSlashes = preg_match_all( '%(/+)$%', $target, $m );
1560                                 if ( $trailingSlashes ) {
1561                                         $noslash = $target = substr( $target, 1, -strlen( $m[0][0] ) );
1562                                 } else {
1563                                         $noslash = substr( $target, 1 );
1564                                 }
1565
1566                                 $ret = $contextTitle->getPrefixedText() . '/' . trim( $noslash ) . $suffix;
1567                                 if ( $text === '' ) {
1568                                         $text = $target . $suffix;
1569                                 } # this might be changed for ugliness reasons
1570                         } else {
1571                                 # check for .. subpage backlinks
1572                                 $dotdotcount = 0;
1573                                 $nodotdot = $target;
1574                                 while ( strncmp( $nodotdot, "../", 3 ) == 0 ) {
1575                                         ++$dotdotcount;
1576                                         $nodotdot = substr( $nodotdot, 3 );
1577                                 }
1578                                 if ( $dotdotcount > 0 ) {
1579                                         $exploded = explode( '/', $contextTitle->getPrefixedText() );
1580                                         if ( count( $exploded ) > $dotdotcount ) { # not allowed to go below top level page
1581                                                 $ret = implode( '/', array_slice( $exploded, 0, -$dotdotcount ) );
1582                                                 # / at the end means don't show full path
1583                                                 if ( substr( $nodotdot, -1, 1 ) === '/' ) {
1584                                                         $nodotdot = substr( $nodotdot, 0, -1 );
1585                                                         if ( $text === '' ) {
1586                                                                 $text = $nodotdot . $suffix;
1587                                                         }
1588                                                 }
1589                                                 $nodotdot = trim( $nodotdot );
1590                                                 if ( $nodotdot != '' ) {
1591                                                         $ret .= '/' . $nodotdot;
1592                                                 }
1593                                                 $ret .= $suffix;
1594                                         }
1595                                 }
1596                         }
1597                 }
1598
1599                 wfProfileOut( __METHOD__ );
1600                 return $ret;
1601         }
1602
1603         /**
1604          * Wrap a comment in standard punctuation and formatting if
1605          * it's non-empty, otherwise return empty string.
1606          *
1607          * @param string $comment
1608          * @param Title|null $title Title object (to generate link to section in autocomment) or null
1609          * @param bool $local Whether section links should refer to local page
1610          *
1611          * @return string
1612          */
1613         public static function commentBlock( $comment, $title = null, $local = false ) {
1614                 // '*' used to be the comment inserted by the software way back
1615                 // in antiquity in case none was provided, here for backwards
1616                 // compatibility, acc. to brion -ævar
1617                 if ( $comment == '' || $comment == '*' ) {
1618                         return '';
1619                 } else {
1620                         $formatted = self::formatComment( $comment, $title, $local );
1621                         $formatted = wfMessage( 'parentheses' )->rawParams( $formatted )->escaped();
1622                         return " <span class=\"comment\">$formatted</span>";
1623                 }
1624         }
1625
1626         /**
1627          * Wrap and format the given revision's comment block, if the current
1628          * user is allowed to view it.
1629          *
1630          * @param Revision $rev
1631          * @param bool $local Whether section links should refer to local page
1632          * @param bool $isPublic Show only if all users can see it
1633          * @return string HTML fragment
1634          */
1635         public static function revComment( Revision $rev, $local = false, $isPublic = false ) {
1636                 if ( $rev->getRawComment() == "" ) {
1637                         return "";
1638                 }
1639                 if ( $rev->isDeleted( Revision::DELETED_COMMENT ) && $isPublic ) {
1640                         $block = " <span class=\"comment\">" . wfMessage( 'rev-deleted-comment' )->escaped() . "</span>";
1641                 } elseif ( $rev->userCan( Revision::DELETED_COMMENT ) ) {
1642                         $block = self::commentBlock( $rev->getComment( Revision::FOR_THIS_USER ),
1643                                 $rev->getTitle(), $local );
1644                 } else {
1645                         $block = " <span class=\"comment\">" . wfMessage( 'rev-deleted-comment' )->escaped() . "</span>";
1646                 }
1647                 if ( $rev->isDeleted( Revision::DELETED_COMMENT ) ) {
1648                         return " <span class=\"history-deleted\">$block</span>";
1649                 }
1650                 return $block;
1651         }
1652
1653         /**
1654          * @param int $size
1655          * @return string
1656          */
1657         public static function formatRevisionSize( $size ) {
1658                 if ( $size == 0 ) {
1659                         $stxt = wfMessage( 'historyempty' )->escaped();
1660                 } else {
1661                         $stxt = wfMessage( 'nbytes' )->numParams( $size )->escaped();
1662                         $stxt = wfMessage( 'parentheses' )->rawParams( $stxt )->escaped();
1663                 }
1664                 return "<span class=\"history-size\">$stxt</span>";
1665         }
1666
1667         /**
1668          * Add another level to the Table of Contents
1669          *
1670          * @return string
1671          */
1672         public static function tocIndent() {
1673                 return "\n<ul>";
1674         }
1675
1676         /**
1677          * Finish one or more sublevels on the Table of Contents
1678          *
1679          * @param int $level
1680          * @return string
1681          */
1682         public static function tocUnindent( $level ) {
1683                 return "</li>\n" . str_repeat( "</ul>\n</li>\n", $level > 0 ? $level : 0 );
1684         }
1685
1686         /**
1687          * parameter level defines if we are on an indentation level
1688          *
1689          * @param string $anchor
1690          * @param string $tocline
1691          * @param string $tocnumber
1692          * @param string $level
1693          * @param string|bool $sectionIndex
1694          * @return string
1695          */
1696         public static function tocLine( $anchor, $tocline, $tocnumber, $level, $sectionIndex = false ) {
1697                 $classes = "toclevel-$level";
1698                 if ( $sectionIndex !== false ) {
1699                         $classes .= " tocsection-$sectionIndex";
1700                 }
1701                 return "\n<li class=\"$classes\"><a href=\"#" .
1702                         $anchor . '"><span class="tocnumber">' .
1703                         $tocnumber . '</span> <span class="toctext">' .
1704                         $tocline . '</span></a>';
1705         }
1706
1707         /**
1708          * End a Table Of Contents line.
1709          * tocUnindent() will be used instead if we're ending a line below
1710          * the new level.
1711          * @return string
1712          */
1713         public static function tocLineEnd() {
1714                 return "</li>\n";
1715         }
1716
1717         /**
1718          * Wraps the TOC in a table and provides the hide/collapse javascript.
1719          *
1720          * @param string $toc Html of the Table Of Contents
1721          * @param string|Language|bool $lang Language for the toc title, defaults to user language
1722          * @return string Full html of the TOC
1723          */
1724         public static function tocList( $toc, $lang = false ) {
1725                 $lang = wfGetLangObj( $lang );
1726                 $title = wfMessage( 'toc' )->inLanguage( $lang )->escaped();
1727
1728                 return '<div id="toc" class="toc">'
1729                         . '<div id="toctitle"><h2>' . $title . "</h2></div>\n"
1730                         . $toc
1731                         . "</ul>\n</div>\n";
1732         }
1733
1734         /**
1735          * Generate a table of contents from a section tree
1736          * Currently unused.
1737          *
1738          * @param array $tree Return value of ParserOutput::getSections()
1739          * @return string HTML fragment
1740          */
1741         public static function generateTOC( $tree ) {
1742                 $toc = '';
1743                 $lastLevel = 0;
1744                 foreach ( $tree as $section ) {
1745                         if ( $section['toclevel'] > $lastLevel ) {
1746                                 $toc .= self::tocIndent();
1747                         } elseif ( $section['toclevel'] < $lastLevel ) {
1748                                 $toc .= self::tocUnindent(
1749                                         $lastLevel - $section['toclevel'] );
1750                         } else {
1751                                 $toc .= self::tocLineEnd();
1752                         }
1753
1754                         $toc .= self::tocLine( $section['anchor'],
1755                                 $section['line'], $section['number'],
1756                                 $section['toclevel'], $section['index'] );
1757                         $lastLevel = $section['toclevel'];
1758                 }
1759                 $toc .= self::tocLineEnd();
1760                 return self::tocList( $toc );
1761         }
1762
1763         /**
1764          * Create a headline for content
1765          *
1766          * @param int $level The level of the headline (1-6)
1767          * @param string $attribs Any attributes for the headline, starting with
1768          *   a space and ending with '>'
1769          *   This *must* be at least '>' for no attribs
1770          * @param string $anchor The anchor to give the headline (the bit after the #)
1771          * @param string $html Html for the text of the header
1772          * @param string $link HTML to add for the section edit link
1773          * @param bool|string $legacyAnchor A second, optional anchor to give for
1774          *   backward compatibility (false to omit)
1775          *
1776          * @return string HTML headline
1777          */
1778         public static function makeHeadline( $level, $attribs, $anchor, $html,
1779                 $link, $legacyAnchor = false
1780         ) {
1781                 $ret = "<h$level$attribs"
1782                         . "<span class=\"mw-headline\" id=\"$anchor\">$html</span>"
1783                         . $link
1784                         . "</h$level>";
1785                 if ( $legacyAnchor !== false ) {
1786                         $ret = "<div id=\"$legacyAnchor\"></div>$ret";
1787                 }
1788                 return $ret;
1789         }
1790
1791         /**
1792          * Split a link trail, return the "inside" portion and the remainder of the trail
1793          * as a two-element array
1794          * @param string $trail
1795          * @return array
1796          */
1797         static function splitTrail( $trail ) {
1798                 global $wgContLang;
1799                 $regex = $wgContLang->linkTrail();
1800                 $inside = '';
1801                 if ( $trail !== '' ) {
1802                         $m = array();
1803                         if ( preg_match( $regex, $trail, $m ) ) {
1804                                 $inside = $m[1];
1805                                 $trail = $m[2];
1806                         }
1807                 }
1808                 return array( $inside, $trail );
1809         }
1810
1811         /**
1812          * Generate a rollback link for a given revision.  Currently it's the
1813          * caller's responsibility to ensure that the revision is the top one. If
1814          * it's not, of course, the user will get an error message.
1815          *
1816          * If the calling page is called with the parameter &bot=1, all rollback
1817          * links also get that parameter. It causes the edit itself and the rollback
1818          * to be marked as "bot" edits. Bot edits are hidden by default from recent
1819          * changes, so this allows sysops to combat a busy vandal without bothering
1820          * other users.
1821          *
1822          * If the option verify is set this function will return the link only in case the
1823          * revision can be reverted. Please note that due to performance limitations
1824          * it might be assumed that a user isn't the only contributor of a page while
1825          * (s)he is, which will lead to useless rollback links. Furthermore this wont
1826          * work if $wgShowRollbackEditCount is disabled, so this can only function
1827          * as an additional check.
1828          *
1829          * If the option noBrackets is set the rollback link wont be enclosed in []
1830          *
1831          * @param Revision $rev
1832          * @param IContextSource $context Context to use or null for the main context.
1833          * @param array $options
1834          * @return string
1835          */
1836         public static function generateRollback( $rev, IContextSource $context = null,
1837                 $options = array( 'verify' )
1838         ) {
1839                 if ( $context === null ) {
1840                         $context = RequestContext::getMain();
1841                 }
1842
1843                 $editCount = false;
1844                 if ( in_array( 'verify', $options ) ) {
1845                         $editCount = self::getRollbackEditCount( $rev, true );
1846                         if ( $editCount === false ) {
1847                                 return '';
1848                         }
1849                 }
1850
1851                 $inner = self::buildRollbackLink( $rev, $context, $editCount );
1852
1853                 if ( !in_array( 'noBrackets', $options ) ) {
1854                         $inner = $context->msg( 'brackets' )->rawParams( $inner )->plain();
1855                 }
1856
1857                 return '<span class="mw-rollback-link">' . $inner . '</span>';
1858         }
1859
1860         /**
1861          * This function will return the number of revisions which a rollback
1862          * would revert and, if $verify is set it will verify that a revision
1863          * can be reverted (that the user isn't the only contributor and the
1864          * revision we might rollback to isn't deleted). These checks can only
1865          * function as an additional check as this function only checks against
1866          * the last $wgShowRollbackEditCount edits.
1867          *
1868          * Returns null if $wgShowRollbackEditCount is disabled or false if $verify
1869          * is set and the user is the only contributor of the page.
1870          *
1871          * @param Revision $rev
1872          * @param bool $verify Try to verify that this revision can really be rolled back
1873          * @return int|bool|null
1874          */
1875         public static function getRollbackEditCount( $rev, $verify ) {
1876                 global $wgShowRollbackEditCount;
1877                 if ( !is_int( $wgShowRollbackEditCount ) || !$wgShowRollbackEditCount > 0 ) {
1878                         // Nothing has happened, indicate this by returning 'null'
1879                         return null;
1880                 }
1881
1882                 $dbr = wfGetDB( DB_SLAVE );
1883
1884                 // Up to the value of $wgShowRollbackEditCount revisions are counted
1885                 $res = $dbr->select(
1886                         'revision',
1887                         array( 'rev_user_text', 'rev_deleted' ),
1888                         // $rev->getPage() returns null sometimes
1889                         array( 'rev_page' => $rev->getTitle()->getArticleID() ),
1890                         __METHOD__,
1891                         array(
1892                                 'USE INDEX' => array( 'revision' => 'page_timestamp' ),
1893                                 'ORDER BY' => 'rev_timestamp DESC',
1894                                 'LIMIT' => $wgShowRollbackEditCount + 1
1895                         )
1896                 );
1897
1898                 $editCount = 0;
1899                 $moreRevs = false;
1900                 foreach ( $res as $row ) {
1901                         if ( $rev->getRawUserText() != $row->rev_user_text ) {
1902                                 if ( $verify &&
1903                                         ( $row->rev_deleted & Revision::DELETED_TEXT
1904                                                 || $row->rev_deleted & Revision::DELETED_USER
1905                                 ) ) {
1906                                         // If the user or the text of the revision we might rollback
1907                                         // to is deleted in some way we can't rollback. Similar to
1908                                         // the sanity checks in WikiPage::commitRollback.
1909                                         return false;
1910                                 }
1911                                 $moreRevs = true;
1912                                 break;
1913                         }
1914                         $editCount++;
1915                 }
1916
1917                 if ( $verify && $editCount <= $wgShowRollbackEditCount && !$moreRevs ) {
1918                         // We didn't find at least $wgShowRollbackEditCount revisions made by the current user
1919                         // and there weren't any other revisions. That means that the current user is the only
1920                         // editor, so we can't rollback
1921                         return false;
1922                 }
1923                 return $editCount;
1924         }
1925
1926         /**
1927          * Build a raw rollback link, useful for collections of "tool" links
1928          *
1929          * @param Revision $rev
1930          * @param IContextSource|null $context Context to use or null for the main context.
1931          * @param int $editCount Number of edits that would be reverted
1932          * @return string HTML fragment
1933          */
1934         public static function buildRollbackLink( $rev, IContextSource $context = null,
1935                 $editCount = false
1936         ) {
1937                 global $wgShowRollbackEditCount, $wgMiserMode;
1938
1939                 // To config which pages are effected by miser mode
1940                 $disableRollbackEditCountSpecialPage = array( 'Recentchanges', 'Watchlist' );
1941
1942                 if ( $context === null ) {
1943                         $context = RequestContext::getMain();
1944                 }
1945
1946                 $title = $rev->getTitle();
1947                 $query = array(
1948                         'action' => 'rollback',
1949                         'from' => $rev->getUserText(),
1950                         'token' => $context->getUser()->getEditToken( array(
1951                                 $title->getPrefixedText(),
1952                                 $rev->getUserText()
1953                         ) ),
1954                 );
1955                 if ( $context->getRequest()->getBool( 'bot' ) ) {
1956                         $query['bot'] = '1';
1957                         $query['hidediff'] = '1'; // bug 15999
1958                 }
1959
1960                 $disableRollbackEditCount = false;
1961                 if ( $wgMiserMode ) {
1962                         foreach ( $disableRollbackEditCountSpecialPage as $specialPage ) {
1963                                 if ( $context->getTitle()->isSpecial( $specialPage ) ) {
1964                                         $disableRollbackEditCount = true;
1965                                         break;
1966                                 }
1967                         }
1968                 }
1969
1970                 if ( !$disableRollbackEditCount
1971                         && is_int( $wgShowRollbackEditCount )
1972                         && $wgShowRollbackEditCount > 0
1973                 ) {
1974                         if ( !is_numeric( $editCount ) ) {
1975                                 $editCount = self::getRollbackEditCount( $rev, false );
1976                         }
1977
1978                         if ( $editCount > $wgShowRollbackEditCount ) {
1979                                 $editCount_output = $context->msg( 'rollbacklinkcount-morethan' )
1980                                         ->numParams( $wgShowRollbackEditCount )->parse();
1981                         } else {
1982                                 $editCount_output = $context->msg( 'rollbacklinkcount' )->numParams( $editCount )->parse();
1983                         }
1984
1985                         return self::link(
1986                                 $title,
1987                                 $editCount_output,
1988                                 array( 'title' => $context->msg( 'tooltip-rollback' )->text() ),
1989                                 $query,
1990                                 array( 'known', 'noclasses' )
1991                         );
1992                 } else {
1993                         return self::link(
1994                                 $title,
1995                                 $context->msg( 'rollbacklink' )->escaped(),
1996                                 array( 'title' => $context->msg( 'tooltip-rollback' )->text() ),
1997                                 $query,
1998                                 array( 'known', 'noclasses' )
1999                         );
2000                 }
2001         }
2002
2003         /**
2004          * Returns HTML for the "templates used on this page" list.
2005          *
2006          * Make an HTML list of templates, and then add a "More..." link at
2007          * the bottom. If $more is null, do not add a "More..." link. If $more
2008          * is a Title, make a link to that title and use it. If $more is a string,
2009          * directly paste it in as the link (escaping needs to be done manually).
2010          * Finally, if $more is a Message, call toString().
2011          *
2012          * @param array $templates Array of templates from Article::getUsedTemplate or similar
2013          * @param bool $preview Whether this is for a preview
2014          * @param bool $section Whether this is for a section edit
2015          * @param Title|Message|string|null $more An escaped link for "More..." of the templates
2016          * @return string HTML output
2017          */
2018         public static function formatTemplates( $templates, $preview = false,
2019                 $section = false, $more = null
2020         ) {
2021                 global $wgLang;
2022                 wfProfileIn( __METHOD__ );
2023
2024                 $outText = '';
2025                 if ( count( $templates ) > 0 ) {
2026                         # Do a batch existence check
2027                         $batch = new LinkBatch;
2028                         foreach ( $templates as $title ) {
2029                                 $batch->addObj( $title );
2030                         }
2031                         $batch->execute();
2032
2033                         # Construct the HTML
2034                         $outText = '<div class="mw-templatesUsedExplanation">';
2035                         if ( $preview ) {
2036                                 $outText .= wfMessage( 'templatesusedpreview' )->numParams( count( $templates ) )
2037                                         ->parseAsBlock();
2038                         } elseif ( $section ) {
2039                                 $outText .= wfMessage( 'templatesusedsection' )->numParams( count( $templates ) )
2040                                         ->parseAsBlock();
2041                         } else {
2042                                 $outText .= wfMessage( 'templatesused' )->numParams( count( $templates ) )
2043                                         ->parseAsBlock();
2044                         }
2045                         $outText .= "</div><ul>\n";
2046
2047                         usort( $templates, 'Title::compare' );
2048                         foreach ( $templates as $titleObj ) {
2049                                 $protected = '';
2050                                 $restrictions = $titleObj->getRestrictions( 'edit' );
2051                                 if ( $restrictions ) {
2052                                         // Check backwards-compatible messages
2053                                         $msg = null;
2054                                         if ( $restrictions === array( 'sysop' ) ) {
2055                                                 $msg = wfMessage( 'template-protected' );
2056                                         } elseif ( $restrictions === array( 'autoconfirmed' ) ) {
2057                                                 $msg = wfMessage( 'template-semiprotected' );
2058                                         }
2059                                         if ( $msg && !$msg->isDisabled() ) {
2060                                                 $protected = $msg->parse();
2061                                         } else {
2062                                                 // Construct the message from restriction-level-*
2063                                                 // e.g. restriction-level-sysop, restriction-level-autoconfirmed
2064                                                 $msgs = array();
2065                                                 foreach ( $restrictions as $r ) {
2066                                                         $msgs[] = wfMessage( "restriction-level-$r" )->parse();
2067                                                 }
2068                                                 $protected = wfMessage( 'parentheses' )
2069                                                         ->rawParams( $wgLang->commaList( $msgs ) )->escaped();
2070                                         }
2071                                 }
2072                                 if ( $titleObj->quickUserCan( 'edit' ) ) {
2073                                         $editLink = self::link(
2074                                                 $titleObj,
2075                                                 wfMessage( 'editlink' )->text(),
2076                                                 array(),
2077                                                 array( 'action' => 'edit' )
2078                                         );
2079                                 } else {
2080                                         $editLink = self::link(
2081                                                 $titleObj,
2082                                                 wfMessage( 'viewsourcelink' )->text(),
2083                                                 array(),
2084                                                 array( 'action' => 'edit' )
2085                                         );
2086                                 }
2087                                 $outText .= '<li>' . self::link( $titleObj )
2088                                         . wfMessage( 'word-separator' )->escaped()
2089                                         . wfMessage( 'parentheses' )->rawParams( $editLink )->escaped()
2090                                         . wfMessage( 'word-separator' )->escaped()
2091                                         . $protected . '</li>';
2092                         }
2093
2094                         if ( $more instanceof Title ) {
2095                                 $outText .= '<li>' . self::link( $more, wfMessage( 'moredotdotdot' ) ) . '</li>';
2096                         } elseif ( $more ) {
2097                                 $outText .= "<li>$more</li>";
2098                         }
2099
2100                         $outText .= '</ul>';
2101                 }
2102                 wfProfileOut( __METHOD__ );
2103                 return $outText;
2104         }
2105
2106         /**
2107          * Returns HTML for the "hidden categories on this page" list.
2108          *
2109          * @param array $hiddencats Array of hidden categories from Article::getHiddenCategories
2110          *   or similar
2111          * @return string HTML output
2112          */
2113         public static function formatHiddenCategories( $hiddencats ) {
2114                 wfProfileIn( __METHOD__ );
2115
2116                 $outText = '';
2117                 if ( count( $hiddencats ) > 0 ) {
2118                         # Construct the HTML
2119                         $outText = '<div class="mw-hiddenCategoriesExplanation">';
2120                         $outText .= wfMessage( 'hiddencategories' )->numParams( count( $hiddencats ) )->parseAsBlock();
2121                         $outText .= "</div><ul>\n";
2122
2123                         foreach ( $hiddencats as $titleObj ) {
2124                                 # If it's hidden, it must exist - no need to check with a LinkBatch
2125                                 $outText .= '<li>'
2126                                         . self::link( $titleObj, null, array(), array(), 'known' )
2127                                         . "</li>\n";
2128                         }
2129                         $outText .= '</ul>';
2130                 }
2131                 wfProfileOut( __METHOD__ );
2132                 return $outText;
2133         }
2134
2135         /**
2136          * Format a size in bytes for output, using an appropriate
2137          * unit (B, KB, MB or GB) according to the magnitude in question
2138          *
2139          * @param int $size Size to format
2140          * @return string
2141          */
2142         public static function formatSize( $size ) {
2143                 global $wgLang;
2144                 return htmlspecialchars( $wgLang->formatSize( $size ) );
2145         }
2146
2147         /**
2148          * Given the id of an interface element, constructs the appropriate title
2149          * attribute from the system messages.  (Note, this is usually the id but
2150          * isn't always, because sometimes the accesskey needs to go on a different
2151          * element than the id, for reverse-compatibility, etc.)
2152          *
2153          * @param string $name Id of the element, minus prefixes.
2154          * @param string|null $options Null or the string 'withaccess' to add an access-
2155          *   key hint
2156          * @return string Contents of the title attribute (which you must HTML-
2157          *   escape), or false for no title attribute
2158          */
2159         public static function titleAttrib( $name, $options = null ) {
2160                 wfProfileIn( __METHOD__ );
2161
2162                 $message = wfMessage( "tooltip-$name" );
2163
2164                 if ( !$message->exists() ) {
2165                         $tooltip = false;
2166                 } else {
2167                         $tooltip = $message->text();
2168                         # Compatibility: formerly some tooltips had [alt-.] hardcoded
2169                         $tooltip = preg_replace( "/ ?\[alt-.\]$/", '', $tooltip );
2170                         # Message equal to '-' means suppress it.
2171                         if ( $tooltip == '-' ) {
2172                                 $tooltip = false;
2173                         }
2174                 }
2175
2176                 if ( $options == 'withaccess' ) {
2177                         $accesskey = self::accesskey( $name );
2178                         if ( $accesskey !== false ) {
2179                                 // Should be build the same as in jquery.accessKeyLabel.js
2180                                 if ( $tooltip === false || $tooltip === '' ) {
2181                                         $tooltip = wfMessage( 'brackets', $accesskey )->text();
2182                                 } else {
2183                                         $tooltip .= wfMessage( 'word-separator' )->text();
2184                                         $tooltip .= wfMessage( 'brackets', $accesskey )->text();
2185                                 }
2186                         }
2187                 }
2188
2189                 wfProfileOut( __METHOD__ );
2190                 return $tooltip;
2191         }
2192
2193         private static $accesskeycache;
2194
2195         /**
2196          * Given the id of an interface element, constructs the appropriate
2197          * accesskey attribute from the system messages.  (Note, this is usually
2198          * the id but isn't always, because sometimes the accesskey needs to go on
2199          * a different element than the id, for reverse-compatibility, etc.)
2200          *
2201          * @param string $name Id of the element, minus prefixes.
2202          * @return string Contents of the accesskey attribute (which you must HTML-
2203          *   escape), or false for no accesskey attribute
2204          */
2205         public static function accesskey( $name ) {
2206                 if ( isset( self::$accesskeycache[$name] ) ) {
2207                         return self::$accesskeycache[$name];
2208                 }
2209                 wfProfileIn( __METHOD__ );
2210
2211                 $message = wfMessage( "accesskey-$name" );
2212
2213                 if ( !$message->exists() ) {
2214                         $accesskey = false;
2215                 } else {
2216                         $accesskey = $message->plain();
2217                         if ( $accesskey === '' || $accesskey === '-' ) {
2218                                 # @todo FIXME: Per standard MW behavior, a value of '-' means to suppress the
2219                                 # attribute, but this is broken for accesskey: that might be a useful
2220                                 # value.
2221                                 $accesskey = false;
2222                         }
2223                 }
2224
2225                 wfProfileOut( __METHOD__ );
2226                 self::$accesskeycache[$name] = $accesskey;
2227                 return self::$accesskeycache[$name];
2228         }
2229
2230         /**
2231          * Get a revision-deletion link, or disabled link, or nothing, depending
2232          * on user permissions & the settings on the revision.
2233          *
2234          * Will use forward-compatible revision ID in the Special:RevDelete link
2235          * if possible, otherwise the timestamp-based ID which may break after
2236          * undeletion.
2237          *
2238          * @param User $user
2239          * @param Revision $rev
2240          * @param Revision $title
2241          * @return string HTML fragment
2242          */
2243         public static function getRevDeleteLink( User $user, Revision $rev, Title $title ) {
2244                 $canHide = $user->isAllowed( 'deleterevision' );
2245                 if ( !$canHide && !( $rev->getVisibility() && $user->isAllowed( 'deletedhistory' ) ) ) {
2246                         return '';
2247                 }
2248
2249                 if ( !$rev->userCan( Revision::DELETED_RESTRICTED, $user ) ) {
2250                         return Linker::revDeleteLinkDisabled( $canHide ); // revision was hidden from sysops
2251                 } else {
2252                         if ( $rev->getId() ) {
2253                                 // RevDelete links using revision ID are stable across
2254                                 // page deletion and undeletion; use when possible.
2255                                 $query = array(
2256                                         'type' => 'revision',
2257                                         'target' => $title->getPrefixedDBkey(),
2258                                         'ids' => $rev->getId()
2259                                 );
2260                         } else {
2261                                 // Older deleted entries didn't save a revision ID.
2262                                 // We have to refer to these by timestamp, ick!
2263                                 $query = array(
2264                                         'type' => 'archive',
2265                                         'target' => $title->getPrefixedDBkey(),
2266                                         'ids' => $rev->getTimestamp()
2267                                 );
2268                         }
2269                         return Linker::revDeleteLink( $query,
2270                                 $rev->isDeleted( Revision::DELETED_RESTRICTED ), $canHide );
2271                 }
2272         }
2273
2274         /**
2275          * Creates a (show/hide) link for deleting revisions/log entries
2276          *
2277          * @param array $query Query parameters to be passed to link()
2278          * @param bool $restricted Set to true to use a "<strong>" instead of a "<span>"
2279          * @param bool $delete Set to true to use (show/hide) rather than (show)
2280          *
2281          * @return string HTML "<a>" link to Special:Revisiondelete, wrapped in a
2282          * span to allow for customization of appearance with CSS
2283          */
2284         public static function revDeleteLink( $query = array(), $restricted = false, $delete = true ) {
2285                 $sp = SpecialPage::getTitleFor( 'Revisiondelete' );
2286                 $msgKey = $delete ? 'rev-delundel' : 'rev-showdeleted';
2287                 $html = wfMessage( $msgKey )->escaped();
2288                 $tag = $restricted ? 'strong' : 'span';
2289                 $link = self::link( $sp, $html, array(), $query, array( 'known', 'noclasses' ) );
2290                 return Xml::tags(
2291                         $tag,
2292                         array( 'class' => 'mw-revdelundel-link' ),
2293                         wfMessage( 'parentheses' )->rawParams( $link )->escaped()
2294                 );
2295         }
2296
2297         /**
2298          * Creates a dead (show/hide) link for deleting revisions/log entries
2299          *
2300          * @param bool $delete Set to true to use (show/hide) rather than (show)
2301          *
2302          * @return string HTML text wrapped in a span to allow for customization
2303          * of appearance with CSS
2304          */
2305         public static function revDeleteLinkDisabled( $delete = true ) {
2306                 $msgKey = $delete ? 'rev-delundel' : 'rev-showdeleted';
2307                 $html = wfMessage( $msgKey )->escaped();
2308                 $htmlParentheses = wfMessage( 'parentheses' )->rawParams( $html )->escaped();
2309                 return Xml::tags( 'span', array( 'class' => 'mw-revdelundel-link' ), $htmlParentheses );
2310         }
2311
2312         /* Deprecated methods */
2313
2314         /**
2315          * @deprecated since 1.16 Use link(); warnings since 1.21
2316          *
2317          * Make a link for a title which may or may not be in the database. If you need to
2318          * call this lots of times, pre-fill the link cache with a LinkBatch, otherwise each
2319          * call to this will result in a DB query.
2320          *
2321          * @param Title $nt The title object to make the link from, e.g. from Title::newFromText.
2322          * @param string $text Link text
2323          * @param string $query Optional query part
2324          * @param string $trail Optional trail. Alphabetic characters at the start of this string will
2325          *   be included in the link text. Other characters will be appended after
2326          *   the end of the link.
2327          * @param string $prefix Optional prefix. As trail, only before instead of after.
2328          * @return string
2329          */
2330         static function makeLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
2331                 wfDeprecated( __METHOD__, '1.21' );
2332
2333                 wfProfileIn( __METHOD__ );
2334                 $query = wfCgiToArray( $query );
2335                 list( $inside, $trail ) = self::splitTrail( $trail );
2336                 if ( $text === '' ) {
2337                         $text = self::linkText( $nt );
2338                 }
2339
2340                 $ret = self::link( $nt, "$prefix$text$inside", array(), $query ) . $trail;
2341
2342                 wfProfileOut( __METHOD__ );
2343                 return $ret;
2344         }
2345
2346         /**
2347          * @deprecated since 1.16 Use link(); warnings since 1.21
2348          *
2349          * Make a link for a title which definitely exists. This is faster than makeLinkObj because
2350          * it doesn't have to do a database query. It's also valid for interwiki titles and special
2351          * pages.
2352          *
2353          * @param Title $title Title object of target page
2354          * @param string $text Text to replace the title
2355          * @param string $query Link target
2356          * @param string $trail Text after link
2357          * @param string $prefix Text before link text
2358          * @param string $aprops Extra attributes to the a-element
2359          * @param string $style Style to apply - if empty, use getInternalLinkAttributesObj instead
2360          * @return string The a-element
2361          */
2362         static function makeKnownLinkObj(
2363                 $title, $text = '', $query = '', $trail = '', $prefix = '', $aprops = '', $style = ''
2364         ) {
2365                 wfDeprecated( __METHOD__, '1.21' );
2366
2367                 wfProfileIn( __METHOD__ );
2368
2369                 if ( $text == '' ) {
2370                         $text = self::linkText( $title );
2371                 }
2372                 $attribs = Sanitizer::mergeAttributes(
2373                         Sanitizer::decodeTagAttributes( $aprops ),
2374                         Sanitizer::decodeTagAttributes( $style )
2375                 );
2376                 $query = wfCgiToArray( $query );
2377                 list( $inside, $trail ) = self::splitTrail( $trail );
2378
2379                 $ret = self::link( $title, "$prefix$text$inside", $attribs, $query,
2380                         array( 'known', 'noclasses' ) ) . $trail;
2381
2382                 wfProfileOut( __METHOD__ );
2383                 return $ret;
2384         }
2385
2386         /**
2387          * Returns the attributes for the tooltip and access key.
2388          * @param string $name
2389          * @return array
2390          */
2391         public static function tooltipAndAccesskeyAttribs( $name ) {
2392                 # @todo FIXME: If Sanitizer::expandAttributes() treated "false" as "output
2393                 # no attribute" instead of "output '' as value for attribute", this
2394                 # would be three lines.
2395                 $attribs = array(
2396                         'title' => self::titleAttrib( $name, 'withaccess' ),
2397                         'accesskey' => self::accesskey( $name )
2398                 );
2399                 if ( $attribs['title'] === false ) {
2400                         unset( $attribs['title'] );
2401                 }
2402                 if ( $attribs['accesskey'] === false ) {
2403                         unset( $attribs['accesskey'] );
2404                 }
2405                 return $attribs;
2406         }
2407
2408         /**
2409          * Returns raw bits of HTML, use titleAttrib()
2410          * @param string $name
2411          * @param array|null $options
2412          * @return null|string
2413          */
2414         public static function tooltip( $name, $options = null ) {
2415                 # @todo FIXME: If Sanitizer::expandAttributes() treated "false" as "output
2416                 # no attribute" instead of "output '' as value for attribute", this
2417                 # would be two lines.
2418                 $tooltip = self::titleAttrib( $name, $options );
2419                 if ( $tooltip === false ) {
2420                         return '';
2421                 }
2422                 return Xml::expandAttributes( array(
2423                         'title' => $tooltip
2424                 ) );
2425         }
2426 }
2427
2428 /**
2429  * @since 1.18
2430  */
2431 class DummyLinker {
2432
2433         /**
2434          * Use PHP's magic __call handler to transform instance calls to a dummy instance
2435          * into static calls to the new Linker for backwards compatibility.
2436          *
2437          * @param string $fname Name of called method
2438          * @param array $args Arguments to the method
2439          * @return mixed
2440          */
2441         public function __call( $fname, $args ) {
2442                 return call_user_func_array( array( 'Linker', $fname ), $args );
2443         }
2444 }