includes/Linker.php

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