includes/Linker.php

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