includes/Linker.php

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