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