includes/Linker.php

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