includes/Linker.php

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