includes/Linker.php

   1 <?php
   2 /**
   3  * Split off some of the internal bits from Skin.php.
   4  * These functions are used for primarily page content:
   5  * links, embedded images, table of contents. Links are
   6  * also used in the skin.
   7  * For the moment, Skin is a descendent class of Linker.
   8  * In the future, it should probably be further split
   9  * so that ever other bit of the wiki doesn't have to
  10  * go loading up Skin to get at it.
  11  *
  12  * @addtogroup Skins
  13  */
  14 class Linker {
  15
  16         /**
  17          * Flags for userToolLinks()
  18          */
  19         const TOOL_LINKS_NOBLOCK = 1;
  20
  21         function __construct() {}
  22
  23         /**
  24          * @deprecated
  25          */
  26         function postParseLinkColour( $s = NULL ) {
  27                 return NULL;
  28         }
  29
  30         /** @todo document */
  31         function getExternalLinkAttributes( $link, $text, $class='' ) {
  32                 $link = htmlspecialchars( $link );
  33
  34                 $r = ($class != '') ? " class=\"$class\"" : " class=\"external\"";
  35
  36                 $r .= " title=\"{$link}\"";
  37                 return $r;
  38         }
  39
  40         function getInterwikiLinkAttributes( $link, $text, $class='' ) {
  41                 global $wgContLang;
  42
  43                 $link = urldecode( $link );
  44                 $link = $wgContLang->checkTitleEncoding( $link );
  45                 $link = preg_replace( '/[\\x00-\\x1f]/', ' ', $link );
  46                 $link = htmlspecialchars( $link );
  47
  48                 $r = ($class != '') ? " class=\"$class\"" : " class=\"external\"";
  49
  50                 $r .= " title=\"{$link}\"";
  51                 return $r;
  52         }
  53
  54         /** @todo document */
  55         function getInternalLinkAttributes( $link, $text, $broken = false ) {
  56                 $link = urldecode( $link );
  57                 $link = str_replace( '_', ' ', $link );
  58                 $link = htmlspecialchars( $link );
  59
  60                 if( $broken == 'stub' ) {
  61                         $r = ' class="stub"';
  62                 } else if ( $broken == 'yes' ) {
  63                         $r = ' class="new"';
  64                 } else {
  65                         $r = '';
  66                 }
  67
  68                 $r .= " title=\"{$link}\"";
  69                 return $r;
  70         }
  71
  72         /**
  73          * @param $nt Title object.
  74          * @param $text String: FIXME
  75          * @param $broken Boolean: FIXME, default 'false'.
  76          */
  77         function getInternalLinkAttributesObj( &$nt, $text, $broken = false ) {
  78                 if( $broken == 'stub' ) {
  79                         $r = ' class="stub"';
  80                 } else if ( $broken == 'yes' ) {
  81                         $r = ' class="new"';
  82                 } else {
  83                         $r = '';
  84                 }
  85
  86                 $r .= ' title="' . $nt->getEscapedText() . '"';
  87                 return $r;
  88         }
  89
  90         /**
  91          * This function is a shortcut to makeLinkObj(Title::newFromText($title),...). Do not call
  92          * it if you already have a title object handy. See makeLinkObj for further documentation.
  93          *
  94          * @param $title String: the text of the title
  95          * @param $text  String: link text
  96          * @param $query String: optional query part
  97          * @param $trail String: optional trail. Alphabetic characters at the start of this string will
  98          *                      be included in the link text. Other characters will be appended after
  99          *                      the end of the link.
 100          */
 101         function makeLink( $title, $text = '', $query = '', $trail = '' ) {
 102                 wfProfileIn( 'Linker::makeLink' );
 103                 $nt = Title::newFromText( $title );
 104                 if ($nt) {
 105                         $result = $this->makeLinkObj( $nt, $text, $query, $trail );
 106                 } else {
 107                         wfDebug( 'Invalid title passed to Linker::makeLink(): "'.$title."\"\n" );
 108                         $result = $text == "" ? $title : $text;
 109                 }
 110
 111                 wfProfileOut( 'Linker::makeLink' );
 112                 return $result;
 113         }
 114
 115         /**
 116          * This function is a shortcut to makeKnownLinkObj(Title::newFromText($title),...). Do not call
 117          * it if you already have a title object handy. See makeKnownLinkObj for further documentation.
 118          *
 119          * @param $title String: the text of the title
 120          * @param $text  String: link text
 121          * @param $query String: optional query part
 122          * @param $trail String: optional trail. Alphabetic characters at the start of this string will
 123          *                      be included in the link text. Other characters will be appended after
 124          *                      the end of the link.
 125          */
 126         function makeKnownLink( $title, $text = '', $query = '', $trail = '', $prefix = '',$aprops = '') {
 127                 $nt = Title::newFromText( $title );
 128                 if ($nt) {
 129                         return $this->makeKnownLinkObj( Title::newFromText( $title ), $text, $query, $trail, $prefix , $aprops );
 130                 } else {
 131                         wfDebug( 'Invalid title passed to Linker::makeKnownLink(): "'.$title."\"\n" );
 132                         return $text == '' ? $title : $text;
 133                 }
 134         }
 135
 136         /**
 137          * This function is a shortcut to makeBrokenLinkObj(Title::newFromText($title),...). Do not call
 138          * it if you already have a title object handy. See makeBrokenLinkObj for further documentation.
 139          *
 140          * @param string $title The text of the title
 141          * @param string $text Link text
 142          * @param string $query Optional query part
 143          * @param string $trail Optional trail. Alphabetic characters at the start of this string will
 144          *                      be included in the link text. Other characters will be appended after
 145          *                      the end of the link.
 146          */
 147         function makeBrokenLink( $title, $text = '', $query = '', $trail = '' ) {
 148                 $nt = Title::newFromText( $title );
 149                 if ($nt) {
 150                         return $this->makeBrokenLinkObj( Title::newFromText( $title ), $text, $query, $trail );
 151                 } else {
 152                         wfDebug( 'Invalid title passed to Linker::makeBrokenLink(): "'.$title."\"\n" );
 153                         return $text == '' ? $title : $text;
 154                 }
 155         }
 156
 157         /**
 158          * This function is a shortcut to makeStubLinkObj(Title::newFromText($title),...). Do not call
 159          * it if you already have a title object handy. See makeStubLinkObj for further documentation.
 160          *
 161          * @param $title String: the text of the title
 162          * @param $text  String: link text
 163          * @param $query String: optional query part
 164          * @param $trail String: optional trail. Alphabetic characters at the start of this string will
 165          *                      be included in the link text. Other characters will be appended after
 166          *                      the end of the link.
 167          */
 168         function makeStubLink( $title, $text = '', $query = '', $trail = '' ) {
 169                 $nt = Title::newFromText( $title );
 170                 if ($nt) {
 171                         return $this->makeStubLinkObj( Title::newFromText( $title ), $text, $query, $trail );
 172                 } else {
 173                         wfDebug( 'Invalid title passed to Linker::makeStubLink(): "'.$title."\"\n" );
 174                         return $text == '' ? $title : $text;
 175                 }
 176         }
 177
 178         /**
 179          * Make a link for a title which may or may not be in the database. If you need to
 180          * call this lots of times, pre-fill the link cache with a LinkBatch, otherwise each
 181          * call to this will result in a DB query.
 182          *
 183          * @param $nt     Title: the title object to make the link from, e.g. from
 184          *                      Title::newFromText.
 185          * @param $text  String: link text
 186          * @param $query String: optional query part
 187          * @param $trail String: optional trail. Alphabetic characters at the start of this string will
 188          *                      be included in the link text. Other characters will be appended after
 189          *                      the end of the link.
 190          * @param $prefix String: optional prefix. As trail, only before instead of after.
 191          */
 192         function makeLinkObj( $nt, $text= '', $query = '', $trail = '', $prefix = '' ) {
 193                 global $wgUser;
 194                 $fname = 'Linker::makeLinkObj';
 195                 wfProfileIn( $fname );
 196
 197                 # Fail gracefully
 198                 if ( ! is_object($nt) ) {
 199                         # throw new MWException();
 200                         wfProfileOut( $fname );
 201                         return "<!-- ERROR -->{$prefix}{$text}{$trail}";
 202                 }
 203
 204                 if ( $nt->isExternal() ) {
 205                         $u = $nt->getFullURL();
 206                         $link = $nt->getPrefixedURL();
 207                         if ( '' == $text ) { $text = $nt->getPrefixedText(); }
 208                         $style = $this->getInterwikiLinkAttributes( $link, $text, 'extiw' );
 209
 210                         $inside = '';
 211                         if ( '' != $trail ) {
 212                                 $m = array();
 213                                 if ( preg_match( '/^([a-z]+)(.*)$$/sD', $trail, $m ) ) {
 214                                         $inside = $m[1];
 215                                         $trail = $m[2];
 216                                 }
 217                         }
 218                         $t = "<a href=\"{$u}\"{$style}>{$text}{$inside}</a>";
 219
 220                         wfProfileOut( $fname );
 221                         return $t;
 222                 } elseif ( $nt->isAlwaysKnown() ) {
 223                         # Image links, special page links and self-links with fragements are always known.
 224                         $retVal = $this->makeKnownLinkObj( $nt, $text, $query, $trail, $prefix );
 225                 } else {
 226                         wfProfileIn( $fname.'-immediate' );
 227
 228                         # Handles links to special pages wich do not exist in the database:
 229                         if( $nt->getNamespace() == NS_SPECIAL ) {
 230                                 if( SpecialPage::exists( $nt->getDbKey() ) ) {
 231                                         $retVal = $this->makeKnownLinkObj( $nt, $text, $query, $trail, $prefix );
 232                                 } else {
 233                                         $retVal = $this->makeBrokenLinkObj( $nt, $text, $query, $trail, $prefix );
 234                                 }
 235                                 wfProfileOut( $fname.'-immediate' );
 236                                 wfProfileOut( $fname );
 237                                 return $retVal;
 238                         }
 239
 240                         # Work out link colour immediately
 241                         $aid = $nt->getArticleID() ;
 242                         if ( 0 == $aid ) {
 243                                 $retVal = $this->makeBrokenLinkObj( $nt, $text, $query, $trail, $prefix );
 244                         } else {
 245                                 $stub = false;
 246                                 if ( $nt->isContentPage() ) {
 247                                         $threshold = $wgUser->getOption('stubthreshold');
 248                                         if ( $threshold > 0 ) {
 249                                                 $dbr = wfGetDB( DB_SLAVE );
 250                                                 $s = $dbr->selectRow(
 251                                                         array( 'page' ),
 252                                                         array( 'page_len',
 253                                                                'page_is_redirect' ),
 254                                                         array( 'page_id' => $aid ), $fname ) ;
 255                                                 $stub = ( $s !== false && !$s->page_is_redirect &&
 256                                                           $s->page_len < $threshold );
 257                                         }
 258                                 }
 259                                 if ( $stub ) {
 260                                         $retVal = $this->makeStubLinkObj( $nt, $text, $query, $trail, $prefix );
 261                                 } else {
 262                                         $retVal = $this->makeKnownLinkObj( $nt, $text, $query, $trail, $prefix );
 263                                 }
 264                         }
 265                         wfProfileOut( $fname.'-immediate' );
 266                 }
 267                 wfProfileOut( $fname );
 268                 return $retVal;
 269         }
 270
 271         /**
 272          * Make a link for a title which definitely exists. This is faster than makeLinkObj because
 273          * it doesn't have to do a database query. It's also valid for interwiki titles and special
 274          * pages.
 275          *
 276          * @param $nt Title object of target page
 277          * @param $text   String: text to replace the title
 278          * @param $query  String: link target
 279          * @param $trail  String: text after link
 280          * @param $prefix String: text before link text
 281          * @param $aprops String: extra attributes to the a-element
 282          * @param $style  String: style to apply - if empty, use getInternalLinkAttributesObj instead
 283          * @return the a-element
 284          */
 285         function makeKnownLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' , $aprops = '', $style = '' ) {
 286
 287                 $fname = 'Linker::makeKnownLinkObj';
 288                 wfProfileIn( $fname );
 289
 290                 if ( !is_object( $nt ) ) {
 291                         wfProfileOut( $fname );
 292                         return $text;
 293                 }
 294
 295                 $u = $nt->escapeLocalURL( $query );
 296                 if ( $nt->getFragment() != '' ) {
 297                         if( $nt->getPrefixedDbkey() == '' ) {
 298                                 $u = '';
 299                                 if ( '' == $text ) {
 300                                         $text = htmlspecialchars( $nt->getFragment() );
 301                                 }
 302                         }
 303                         $u .= $nt->getFragmentForURL();
 304                 }
 305                 if ( $text == '' ) {
 306                         $text = htmlspecialchars( $nt->getPrefixedText() );
 307                 }
 308                 if ( $style == '' ) {
 309                         $style = $this->getInternalLinkAttributesObj( $nt, $text );
 310                 }
 311
 312                 if ( $aprops !== '' ) $aprops = ' ' . $aprops;
 313
 314                 list( $inside, $trail ) = Linker::splitTrail( $trail );
 315                 $r = "<a href=\"{$u}\"{$style}{$aprops}>{$prefix}{$text}{$inside}</a>{$trail}";
 316                 wfProfileOut( $fname );
 317                 return $r;
 318         }
 319
 320         /**
 321          * Make a red link to the edit page of a given title.
 322          *
 323          * @param $title String: The text of the title
 324          * @param $text  String: Link text
 325          * @param $query String: Optional query part
 326          * @param $trail String: Optional trail. Alphabetic characters at the start of this string will
 327          *                      be included in the link text. Other characters will be appended after
 328          *                      the end of the link.
 329          */
 330         function makeBrokenLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
 331                 # Fail gracefully
 332                 if ( ! isset($nt) ) {
 333                         # throw new MWException();
 334                         return "<!-- ERROR -->{$prefix}{$text}{$trail}";
 335                 }
 336
 337                 $fname = 'Linker::makeBrokenLinkObj';
 338                 wfProfileIn( $fname );
 339
 340                 if( $nt->getNamespace() == NS_SPECIAL ) {
 341                         $q = $query;
 342                 } else if ( '' == $query ) {
 343                         $q = 'action=edit';
 344                 } else {
 345                         $q = 'action=edit&'.$query;
 346                 }
 347                 $u = $nt->escapeLocalURL( $q );
 348
 349                 if ( '' == $text ) {
 350                         $text = htmlspecialchars( $nt->getPrefixedText() );
 351                 }
 352                 $style = $this->getInternalLinkAttributesObj( $nt, $text, "yes" );
 353
 354                 list( $inside, $trail ) = Linker::splitTrail( $trail );
 355                 $s = "<a href=\"{$u}\"{$style}>{$prefix}{$text}{$inside}</a>{$trail}";
 356
 357                 wfProfileOut( $fname );
 358                 return $s;
 359         }
 360
 361         /**
 362          * Make a brown link to a short article.
 363          *
 364          * @param $title String: the text of the title
 365          * @param $text  String: link text
 366          * @param $query String: optional query part
 367          * @param $trail String: optional trail. Alphabetic characters at the start of this string will
 368          *                      be included in the link text. Other characters will be appended after
 369          *                      the end of the link.
 370          */
 371         function makeStubLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
 372                 $style = $this->getInternalLinkAttributesObj( $nt, $text, 'stub' );
 373                 return $this->makeKnownLinkObj( $nt, $text, $query, $trail, $prefix, '', $style );
 374         }
 375
 376         /**
 377          * Generate either a normal exists-style link or a stub link, depending
 378          * on the given page size.
 379          *
 380          * @param $size Integer
 381          * @param $nt Title object.
 382          * @param $text String
 383          * @param $query String
 384          * @param $trail String
 385          * @param $prefix String
 386          * @return string HTML of link
 387          */
 388         function makeSizeLinkObj( $size, $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
 389                 global $wgUser;
 390                 $threshold = intval( $wgUser->getOption( 'stubthreshold' ) );
 391                 if( $size < $threshold ) {
 392                         return $this->makeStubLinkObj( $nt, $text, $query, $trail, $prefix );
 393                 } else {
 394                         return $this->makeKnownLinkObj( $nt, $text, $query, $trail, $prefix );
 395                 }
 396         }
 397
 398         /**
 399          * Make appropriate markup for a link to the current article. This is currently rendered
 400          * as the bold link text. The calling sequence is the same as the other make*LinkObj functions,
 401          * despite $query not being used.
 402          */
 403         function makeSelfLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
 404                 if ( '' == $text ) {
 405                         $text = htmlspecialchars( $nt->getPrefixedText() );
 406                 }
 407                 list( $inside, $trail ) = Linker::splitTrail( $trail );
 408                 return "<strong class=\"selflink\">{$prefix}{$text}{$inside}</strong>{$trail}";
 409         }
 410
 411         /** @todo document */
 412         function fnamePart( $url ) {
 413                 $basename = strrchr( $url, '/' );
 414                 if ( false === $basename ) {
 415                         $basename = $url;
 416                 } else {
 417                         $basename = substr( $basename, 1 );
 418                 }
 419                 return htmlspecialchars( $basename );
 420         }
 421
 422         /** Obsolete alias */
 423         function makeImage( $url, $alt = '' ) {
 424                 return $this->makeExternalImage( $url, $alt );
 425         }
 426
 427         /** @todo document */
 428         function makeExternalImage( $url, $alt = '' ) {
 429                 if ( '' == $alt ) {
 430                         $alt = $this->fnamePart( $url );
 431                 }
 432                 $s = '<img src="'.$url.'" alt="'.$alt.'" />';
 433                 return $s;
 434         }
 435
 436         /**
 437          * Creates the HTML source for images
 438          * @deprecated use makeImageLink2
 439          *
 440          * @param object $title
 441          * @param string $label label text
 442          * @param string $alt alt text
 443          * @param string $align horizontal alignment: none, left, center, right)
 444          * @param array $handlerParams Parameters to be passed to the media handler
 445          * @param boolean $framed shows image in original size in a frame
 446          * @param boolean $thumb shows image as thumbnail in a frame
 447          * @param string $manualthumb image name for the manual thumbnail
 448          * @param string $valign vertical alignment: baseline, sub, super, top, text-top, middle, bottom, text-bottom
 449          * @return string
 450          */
 451         function makeImageLinkObj( $title, $label, $alt, $align = '', $handlerParams = array(), $framed = false,
 452           $thumb = false, $manualthumb = '', $valign = '', $time = false )
 453         {
 454                 $frameParams = array( 'alt' => $alt, 'caption' => $label );
 455                 if ( $align ) {
 456                         $frameParams['align'] = $align;
 457                 }
 458                 if ( $framed ) {
 459                         $frameParams['framed'] = true;
 460                 }
 461                 if ( $thumb ) {
 462                         $frameParams['thumbnail'] = true;
 463                 }
 464                 if ( $manualthumb ) {
 465                         $frameParams['manualthumb'] = $manualthumb;
 466                 }
 467                 if ( $valign ) {
 468                         $frameParams['valign'] = $valign;
 469                 }
 470                 $file = wfFindFile( $title, $time );
 471                 return $this->makeImageLink2( $title, $file, $frameParams, $handlerParams );
 472         }
 473
 474         /**
 475          * Make an image link
 476          * @param Title $title Title object
 477          * @param File $file File object, or false if it doesn't exist
 478          *
 479      * @param array $frameParams Associative array of parameters external to the media handler.
 480      *     Boolean parameters are indicated by presence or absence, the value is arbitrary and
 481      *     will often be false.
 482      *          thumbnail       If present, downscale and frame
 483      *          manualthumb     Image name to use as a thumbnail, instead of automatic scaling
 484      *          framed          Shows image in original size in a frame
 485      *          frameless       Downscale but don't frame
 486      *          upright         If present, tweak default sizes for portrait orientation
 487      *          upright_factor  Fudge factor for "upright" tweak (default 0.75)
 488      *          border          If present, show a border around the image
 489      *          align           Horizontal alignment (left, right, center, none)
 490      *          valign          Vertical alignment (baseline, sub, super, top, text-top, middle,
 491      *                          bottom, text-bottom)
 492      *          alt             Alternate text for image (i.e. alt attribute). Plain text.
 493      *          caption         HTML for image caption.
 494          *
 495      * @param array $handlerParams Associative array of media handler parameters, to be passed
 496      *       to transform(). Typical keys are "width" and "page".
 497          */
 498         function makeImageLink2( Title $title, $file, $frameParams = array(), $handlerParams = array() ) {
 499                 global $wgContLang, $wgUser, $wgThumbLimits, $wgThumbUpright;
 500                 if ( $file && !$file->allowInlineDisplay() ) {
 501                         wfDebug( __METHOD__.': '.$title->getPrefixedDBkey()." does not allow inline display\n" );
 502                         return $this->makeKnownLinkObj( $title );
 503                 }
 504
 505                 // Shortcuts
 506                 $fp =& $frameParams;
 507                 $hp =& $handlerParams;
 508
 509                 // Clean up parameters
 510                 $page = isset( $hp['page'] ) ? $hp['page'] : false;
 511                 if ( !isset( $fp['align'] ) ) $fp['align'] = '';
 512                 if ( !isset( $fp['alt'] ) ) $fp['alt'] = '';
 513
 514                 $prefix = $postfix = '';
 515
 516                 if ( 'center' == $fp['align'] )
 517                 {
 518                         $prefix  = '<div class="center">';
 519                         $postfix = '</div>';
 520                         $fp['align']   = 'none';
 521                 }
 522                 if ( $file && !isset( $hp['width'] ) ) {
 523                         $hp['width'] = $file->getWidth( $page );
 524
 525                         if( isset( $fp['thumbnail'] ) || isset( $fp['framed'] ) || isset( $fp['frameless'] ) || !$hp['width'] ) {
 526                                 $wopt = $wgUser->getOption( 'thumbsize' );
 527
 528                                 if( !isset( $wgThumbLimits[$wopt] ) ) {
 529                                          $wopt = User::getDefaultOption( 'thumbsize' );
 530                                 }
 531
 532                                 // Reduce width for upright images when parameter 'upright' is used
 533                                 if ( isset( $fp['upright'] ) && $fp['upright'] == 0 ) {
 534                                         $fp['upright'] = $wgThumbUpright;
 535                                 }
 536                                 // Use width which is smaller: real image width or user preference width
 537                                 // 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
 538                                 $prefWidth = isset( $fp['upright'] ) ?
 539                                         round( $wgThumbLimits[$wopt] * $fp['upright'], -1 ) :
 540                                         $wgThumbLimits[$wopt];
 541                                 if ( $hp['width'] <= 0 || $prefWidth < $hp['width'] ) {
 542                                         $hp['width'] = $prefWidth;
 543                                 }
 544                         }
 545                 }
 546
 547                 if ( isset( $fp['thumbnail'] ) || isset( $fp['manualthumb'] ) || isset( $fp['framed'] ) ) {
 548
 549                         # Create a thumbnail. Alignment depends on language
 550                         # writing direction, # right aligned for left-to-right-
 551                         # languages ("Western languages"), left-aligned
 552                         # for right-to-left-languages ("Semitic languages")
 553                         #
 554                         # If  thumbnail width has not been provided, it is set
 555                         # to the default user option as specified in Language*.php
 556                         if ( $fp['align'] == '' ) {
 557                                 $fp['align'] = $wgContLang->isRTL() ? 'left' : 'right';
 558                         }
 559                         return $prefix.$this->makeThumbLink2( $title, $file, $fp, $hp ).$postfix;
 560                 }
 561
 562                 if ( $file && $hp['width'] ) {
 563                         # Create a resized image, without the additional thumbnail features
 564                         $thumb = $file->transform( $hp );
 565                 } else {
 566                         $thumb = false;
 567                 }
 568
 569                 if ( !$thumb ) {
 570                         $s = $this->makeBrokenImageLinkObj( $title );
 571                 } else {
 572                         $s = $thumb->toHtml( array(
 573                                 'desc-link' => true,
 574                                 'alt' => $fp['alt'],
 575                                 'valign' => isset( $fp['valign'] ) ? $fp['valign'] : false ) );
 576                 }
 577                 if ( '' != $fp['align'] ) {
 578                         $s = "<div class=\"float{$fp['align']}\"><span>{$s}</span></div>";
 579                 }
 580                 return str_replace("\n", ' ',$prefix.$s.$postfix);
 581         }
 582
 583         /**
 584          * Make HTML for a thumbnail including image, border and caption
 585          * @param Title $title
 586          * @param File $file File object or false if it doesn't exist
 587          */
 588         function makeThumbLinkObj( Title $title, $file, $label = '', $alt, $align = 'right', $params = array(), $framed=false , $manualthumb = "" ) {
 589                 $frameParams = array(
 590                         'alt' => $alt,
 591                         'caption' => $label,
 592                         'align' => $align
 593                 );
 594                 if ( $framed ) $frameParams['framed'] = true;
 595                 if ( $manualthumb ) $frameParams['manualthumb'] = $manualthumb;
 596                 return $this->makeThumbLink2( $title, $file, $frameParams, $params );
 597         }
 598
 599         function makeThumbLink2( Title $title, $file, $frameParams = array(), $handlerParams = array() ) {
 600                 global $wgStylePath, $wgContLang;
 601                 $exists = $file && $file->exists();
 602
 603                 # Shortcuts
 604                 $fp =& $frameParams;
 605                 $hp =& $handlerParams;
 606
 607                 $page = isset( $hp['page'] ) ? $hp['page'] : false;
 608                 if ( !isset( $fp['align'] ) ) $fp['align'] = 'right';
 609                 if ( !isset( $fp['alt'] ) ) $fp['alt'] = '';
 610                 if ( !isset( $fp['caption'] ) ) $fp['caption'] = '';
 611
 612                 if ( empty( $hp['width'] ) ) {
 613                         // Reduce width for upright images when parameter 'upright' is used
 614                         $hp['width'] = isset( $fp['upright'] ) ? 130 : 180;
 615                 }
 616                 $thumb = false;
 617
 618                 if ( !$exists ) {
 619                         $outerWidth = $hp['width'] + 2;
 620                 } else {
 621                         if ( isset( $fp['manualthumb'] ) ) {
 622                                 # Use manually specified thumbnail
 623                                 $manual_title = Title::makeTitleSafe( NS_IMAGE, $fp['manualthumb'] );
 624                                 if( $manual_title ) {
 625                                         $manual_img = wfFindFile( $manual_title );
 626                                         if ( $manual_img ) {
 627                                                 $thumb = $manual_img->getUnscaledThumb();
 628                                         } else {
 629                                                 $exists = false;
 630                                         }
 631                                 }
 632                         } elseif ( isset( $fp['framed'] ) ) {
 633                                 // Use image dimensions, don't scale
 634                                 $thumb = $file->getUnscaledThumb( $page );
 635                         } else {
 636                                 # Do not present an image bigger than the source, for bitmap-style images
 637                                 # This is a hack to maintain compatibility with arbitrary pre-1.10 behaviour
 638                                 $srcWidth = $file->getWidth( $page );
 639                                 if ( $srcWidth && !$file->mustRender() && $hp['width'] > $srcWidth ) {
 640                                         $hp['width'] = $srcWidth;
 641                                 }
 642                                 $thumb = $file->transform( $hp );
 643                         }
 644
 645                         if ( $thumb ) {
 646                                 $outerWidth = $thumb->getWidth() + 2;
 647                         } else {
 648                                 $outerWidth = $hp['width'] + 2;
 649                         }
 650                 }
 651
 652                 $query = $page ? 'page=' . urlencode( $page ) : '';
 653                 $url = $title->getLocalURL( $query );
 654
 655                 $more = htmlspecialchars( wfMsg( 'thumbnail-more' ) );
 656                 $magnifyalign = $wgContLang->isRTL() ? 'left' : 'right';
 657                 $textalign = $wgContLang->isRTL() ? ' style="text-align:right"' : '';
 658
 659                 $s = "<div class=\"thumb t{$fp['align']}\"><div class=\"thumbinner\" style=\"width:{$outerWidth}px;\">";
 660                 if( !$exists ) {
 661                         $s .= $this->makeBrokenImageLinkObj( $title );
 662                         $zoomicon = '';
 663                 } elseif ( !$thumb ) {
 664                         $s .= htmlspecialchars( wfMsg( 'thumbnail_error', '' ) );
 665                         $zoomicon = '';
 666                 } else {
 667                         $s .= $thumb->toHtml( array(
 668                                 'alt' => $fp['alt'],
 669                                 'img-class' => 'thumbimage',
 670                                 'desc-link' => true ) );
 671                         if ( isset( $fp['framed'] ) ) {
 672                                 $zoomicon="";
 673                         } else {
 674                                 $zoomicon =  '<div class="magnify" style="float:'.$magnifyalign.'">'.
 675                                         '<a href="'.$url.'" class="internal" title="'.$more.'">'.
 676                                         '<img src="'.$wgStylePath.'/common/images/magnify-clip.png" ' .
 677                                         'width="15" height="11" alt="" /></a></div>';
 678                         }
 679                 }
 680                 $s .= '  <div class="thumbcaption"'.$textalign.'>'.$zoomicon.$fp['caption']."</div></div></div>";
 681                 return str_replace("\n", ' ', $s);
 682         }
 683
 684         /**
 685          * Make a "broken" link to an image
 686          *
 687          * @param Title $title Image title
 688          * @param string $text Link label
 689          * @param string $query Query string
 690          * @param string $trail Link trail
 691          * @param string $prefix Link prefix
 692          * @return string
 693          */
 694         public function makeBrokenImageLinkObj( $title, $text = '', $query = '', $trail = '', $prefix = '' ) {
 695                 global $wgEnableUploads;
 696                 if( $title instanceof Title ) {
 697                         wfProfileIn( __METHOD__ );
 698                         if( $wgEnableUploads ) {
 699                                 $upload = SpecialPage::getTitleFor( 'Upload' );
 700                                 if( $text == '' )
 701                                         $text = htmlspecialchars( $title->getPrefixedText() );
 702                                 $q = 'wpDestFile=' . $title->getPartialUrl();
 703                                 if( $query != '' )
 704                                         $q .= '&' . $query;
 705                                 list( $inside, $trail ) = self::splitTrail( $trail );
 706                                 $style = $this->getInternalLinkAttributesObj( $title, $text, 'yes' );
 707                                 wfProfileOut( __METHOD__ );
 708                                 return '<a href="' . $upload->escapeLocalUrl( $q ) . '"'
 709                                         . $style . '>' . $prefix . $text . $inside . '</a>' . $trail;
 710                         } else {
 711                                 wfProfileOut( __METHOD__ );
 712                                 return $this->makeKnownLinkObj( $title, $text, $query, $trail, $prefix );
 713                         }
 714                 } else {
 715                         return "<!-- ERROR -->{$prefix}{$text}{$trail}";
 716                 }
 717         }
 718
 719         /** @deprecated use Linker::makeMediaLinkObj() */
 720         function makeMediaLink( $name, $unused = '', $text = '' ) {
 721                 $nt = Title::makeTitleSafe( NS_IMAGE, $name );
 722                 return $this->makeMediaLinkObj( $nt, $text );
 723         }
 724
 725         /**
 726          * Create a direct link to a given uploaded file.
 727          *
 728          * @param $title Title object.
 729          * @param $text  String: pre-sanitized HTML
 730          * @return string HTML
 731          *
 732          * @public
 733          * @todo Handle invalid or missing images better.
 734          */
 735         function makeMediaLinkObj( $title, $text = '' ) {
 736                 if( is_null( $title ) ) {
 737                         ### HOTFIX. Instead of breaking, return empty string.
 738                         return $text;
 739                 } else {
 740                         $img  = wfFindFile( $title );
 741                         if( $img ) {
 742                                 $url  = $img->getURL();
 743                                 $class = 'internal';
 744                         } else {
 745                                 $upload = SpecialPage::getTitleFor( 'Upload' );
 746                                 $url = $upload->getLocalUrl( 'wpDestFile=' . urlencode( $title->getDbKey() ) );
 747                                 $class = 'new';
 748                         }
 749                         $alt = htmlspecialchars( $title->getText() );
 750                         if( $text == '' ) {
 751                                 $text = $alt;
 752                         }
 753                         $u = htmlspecialchars( $url );
 754                         return "<a href=\"{$u}\" class=\"$class\" title=\"{$alt}\">{$text}</a>";
 755                 }
 756         }
 757
 758         /** @todo document */
 759         function specialLink( $name, $key = '' ) {
 760                 global $wgContLang;
 761
 762                 if ( '' == $key ) { $key = strtolower( $name ); }
 763                 $pn = $wgContLang->ucfirst( $name );
 764                 return $this->makeKnownLink( $wgContLang->specialPage( $pn ),
 765                   wfMsg( $key ) );
 766         }
 767
 768         /** @todo document */
 769         function makeExternalLink( $url, $text, $escape = true, $linktype = '', $ns = null ) {
 770                 $style = $this->getExternalLinkAttributes( $url, $text, 'external ' . $linktype );
 771                 global $wgNoFollowLinks, $wgNoFollowNsExceptions;
 772                 if( $wgNoFollowLinks && !(isset($ns) && in_array($ns, $wgNoFollowNsExceptions)) ) {
 773                         $style .= ' rel="nofollow"';
 774                 }
 775                 $url = htmlspecialchars( $url );
 776                 if( $escape ) {
 777                         $text = htmlspecialchars( $text );
 778                 }
 779                 return '<a href="'.$url.'"'.$style.'>'.$text.'</a>';
 780         }
 781
 782         /**
 783          * Make user link (or user contributions for unregistered users)
 784          * @param $userId   Integer: user id in database.
 785          * @param $userText String: user name in database
 786          * @return string HTML fragment
 787          * @private
 788          */
 789         function userLink( $userId, $userText ) {
 790                 $encName = htmlspecialchars( $userText );
 791                 if( $userId == 0 ) {
 792                         $contribsPage = SpecialPage::getTitleFor( 'Contributions', $userText );
 793                         return $this->makeKnownLinkObj( $contribsPage,
 794                                 $encName);
 795                 } else {
 796                         $userPage = Title::makeTitle( NS_USER, $userText );
 797                         return $this->makeLinkObj( $userPage, $encName );
 798                 }
 799         }
 800
 801         /**
 802          * Generate standard user tool links (talk, contributions, block link, etc.)
 803          *
 804          * @param int $userId User identifier
 805          * @param string $userText User name or IP address
 806          * @param bool $redContribsWhenNoEdits Should the contributions link be red if the user has no edits?
 807          * @param int $flags Customisation flags (e.g. self::TOOL_LINKS_NOBLOCK)
 808          * @return string
 809          */
 810         public function userToolLinks( $userId, $userText, $redContribsWhenNoEdits = false, $flags = 0 ) {
 811                 global $wgUser, $wgDisableAnonTalk, $wgSysopUserBans;
 812                 $talkable = !( $wgDisableAnonTalk && 0 == $userId );
 813                 $blockable = ( $wgSysopUserBans || 0 == $userId ) && !$flags & self::TOOL_LINKS_NOBLOCK;
 814
 815                 $items = array();
 816                 if( $talkable ) {
 817                         $items[] = $this->userTalkLink( $userId, $userText );
 818                 }
 819                 if( $userId ) {
 820                         // check if the user has an edit
 821                         if( $redContribsWhenNoEdits && User::edits( $userId ) == 0 ) {
 822                                 $style = " class='new'";
 823                         } else {
 824                                 $style = '';
 825                         }
 826                         $contribsPage = SpecialPage::getTitleFor( 'Contributions', $userText );
 827
 828                         $items[] = $this->makeKnownLinkObj( $contribsPage, wfMsgHtml( 'contribslink' ), '', '', '', '', $style );
 829                 }
 830                 if( $blockable && $wgUser->isAllowed( 'block' ) ) {
 831                         $items[] = $this->blockLink( $userId, $userText );
 832                 }
 833
 834                 if( $items ) {
 835                         return ' (' . implode( ' | ', $items ) . ')';
 836                 } else {
 837                         return '';
 838                 }
 839         }
 840
 841         /**
 842          * Alias for userToolLinks( $userId, $userText, true );
 843          */
 844         public function userToolLinksRedContribs( $userId, $userText ) {
 845                 return $this->userToolLinks( $userId, $userText, true );
 846         }
 847
 848
 849         /**
 850          * @param $userId Integer: user id in database.
 851          * @param $userText String: user name in database.
 852          * @return string HTML fragment with user talk link
 853          * @private
 854          */
 855         function userTalkLink( $userId, $userText ) {
 856                 $userTalkPage = Title::makeTitle( NS_USER_TALK, $userText );
 857                 $userTalkLink = $this->makeLinkObj( $userTalkPage, wfMsgHtml( 'talkpagelinktext' ) );
 858                 return $userTalkLink;
 859         }
 860
 861         /**
 862          * @param $userId Integer: userid
 863          * @param $userText String: user name in database.
 864          * @return string HTML fragment with block link
 865          * @private
 866          */
 867         function blockLink( $userId, $userText ) {
 868                 $blockPage = SpecialPage::getTitleFor( 'Blockip', $userText );
 869                 $blockLink = $this->makeKnownLinkObj( $blockPage,
 870                         wfMsgHtml( 'blocklink' ) );
 871                 return $blockLink;
 872         }
 873
 874         /**
 875          * Generate a user link if the current user is allowed to view it
 876          * @param $rev Revision object.
 877          * @return string HTML
 878          */
 879         function revUserLink( $rev ) {
 880                 if( $rev->userCan( Revision::DELETED_USER ) ) {
 881                         $link = $this->userLink( $rev->getRawUser(), $rev->getRawUserText() );
 882                 } else {
 883                         $link = wfMsgHtml( 'rev-deleted-user' );
 884                 }
 885                 if( $rev->isDeleted( Revision::DELETED_USER ) ) {
 886                         return '<span class="history-deleted">' . $link . '</span>';
 887                 }
 888                 return $link;
 889         }
 890
 891         /**
 892          * Generate a user tool link cluster if the current user is allowed to view it
 893          * @param $rev Revision object.
 894          * @return string HTML
 895          */
 896         function revUserTools( $rev ) {
 897                 if( $rev->userCan( Revision::DELETED_USER ) ) {
 898                         $link = $this->userLink( $rev->getRawUser(), $rev->getRawUserText() ) .
 899                                 ' ' .
 900                                 $this->userToolLinks( $rev->getRawUser(), $rev->getRawUserText() );
 901                 } else {
 902                         $link = wfMsgHtml( 'rev-deleted-user' );
 903                 }
 904                 if( $rev->isDeleted( Revision::DELETED_USER ) ) {
 905                         return '<span class="history-deleted">' . $link . '</span>';
 906                 }
 907                 return $link;
 908         }
 909
 910         /**
 911          * This function is called by all recent changes variants, by the page history,
 912          * and by the user contributions list. It is responsible for formatting edit
 913          * comments. It escapes any HTML in the comment, but adds some CSS to format
 914          * auto-generated comments (from section editing) and formats [[wikilinks]].
 915          *
 916          * @author Erik Moeller <moeller@scireview.de>
 917          *
 918          * Note: there's not always a title to pass to this function.
 919          * Since you can't set a default parameter for a reference, I've turned it
 920          * temporarily to a value pass. Should be adjusted further. --brion
 921          *
 922          * @param string $comment
 923          * @param mixed $title Title object (to generate link to the section in autocomment) or null
 924          * @param bool $local Whether section links should refer to local page
 925          */
 926         function formatComment($comment, $title = NULL, $local = false) {
 927                 wfProfileIn( __METHOD__ );
 928
 929                 # Sanitize text a bit:
 930                 $comment = str_replace( "\n", " ", $comment );
 931                 $comment = htmlspecialchars( $comment );
 932
 933                 # Render autocomments and make links:
 934                 $comment = $this->formatAutoComments( $comment, $title, $local );
 935                 $comment = $this->formatLinksInComment( $comment );
 936
 937                 wfProfileOut( __METHOD__ );
 938                 return $comment;
 939         }
 940
 941         /**
 942          * The pattern for autogen comments is / * foo * /, which makes for
 943          * some nasty regex.
 944          * We look for all comments, match any text before and after the comment,
 945          * add a separator where needed and format the comment itself with CSS
 946          * Called by Linker::formatComment.
 947          *
 948          * @param $comment Comment text
 949          * @param $title An optional title object used to links to sections
 950          *
 951          * @todo Document the $local parameter.
 952          */
 953         private function formatAutocomments( $comment, $title = NULL, $local = false ) {
 954                 $match = array();
 955                 while (preg_match('!(.*)/\*\s*(.*?)\s*\*/(.*)!', $comment,$match)) {
 956                         $pre=$match[1];
 957                         $auto=$match[2];
 958                         $post=$match[3];
 959                         $link='';
 960                         if( $title ) {
 961                                 $section = $auto;
 962
 963                                 # Generate a valid anchor name from the section title.
 964                                 # Hackish, but should generally work - we strip wiki
 965                                 # syntax, including the magic [[: that is used to
 966                                 # "link rather than show" in case of images and
 967                                 # interlanguage links.
 968                                 $section = str_replace( '[[:', '', $section );
 969                                 $section = str_replace( '[[', '', $section );
 970                                 $section = str_replace( ']]', '', $section );
 971                                 if ( $local ) {
 972                                         $sectionTitle = Title::newFromText( '#' . $section);
 973                                 } else {
 974                                         $sectionTitle = wfClone( $title );
 975                                         $sectionTitle->mFragment = $section;
 976                                 }
 977                                 $link = $this->makeKnownLinkObj( $sectionTitle, wfMsg( 'sectionlink' ) );
 978                         }
 979                         $sep='-';
 980                         $auto=$link.$auto;
 981                         if($pre) { $auto = $sep.' '.$auto; }
 982                         if($post) { $auto .= ' '.$sep; }
 983                         $auto='<span class="autocomment">'.$auto.'</span>';
 984                         $comment=$pre.$auto.$post;
 985                 }
 986
 987                 return $comment;
 988         }
 989
 990         /**
 991          * Formats wiki links and media links in text; all other wiki formatting
 992          * is ignored
 993          *
 994          * @param string $comment Text to format links in
 995          * @return string
 996          */
 997         public function formatLinksInComment( $comment ) {
 998                 global $wgContLang;
 999
1000                 $medians = '(?:' . preg_quote( Namespace::getCanonicalName( NS_MEDIA ), '/' ) . '|';
1001                 $medians .= preg_quote( $wgContLang->getNsText( NS_MEDIA ), '/' ) . '):';
1002
1003                 $match = array();
1004                 while(preg_match('/\[\[:?(.*?)(\|(.*?))*\]\](.*)$/',$comment,$match)) {
1005                         # Handle link renaming [[foo|text]] will show link as "text"
1006                         if( "" != $match[3] ) {
1007                                 $text = $match[3];
1008                         } else {
1009                                 $text = $match[1];
1010                         }
1011                         $submatch = array();
1012                         if( preg_match( '/^' . $medians . '(.*)$/i', $match[1], $submatch ) ) {
1013                                 # Media link; trail not supported.
1014                                 $linkRegexp = '/\[\[(.*?)\]\]/';
1015                                 $thelink = $this->makeMediaLink( $submatch[1], "", $text );
1016                         } else {
1017                                 # Other kind of link
1018                                 if( preg_match( $wgContLang->linkTrail(), $match[4], $submatch ) ) {
1019                                         $trail = $submatch[1];
1020                                 } else {
1021                                         $trail = "";
1022                                 }
1023                                 $linkRegexp = '/\[\[(.*?)\]\]' . preg_quote( $trail, '/' ) . '/';
1024                                 if (isset($match[1][0]) && $match[1][0] == ':')
1025                                         $match[1] = substr($match[1], 1);
1026                                 $thelink = $this->makeLink( $match[1], $text, "", $trail );
1027                         }
1028                         $comment = preg_replace( $linkRegexp, StringUtils::escapeRegexReplacement( $thelink ), $comment, 1 );
1029                 }
1030
1031                 return $comment;
1032         }
1033
1034         /**
1035          * Wrap a comment in standard punctuation and formatting if
1036          * it's non-empty, otherwise return empty string.
1037          *
1038          * @param string $comment
1039          * @param mixed $title Title object (to generate link to section in autocomment) or null
1040          * @param bool $local Whether section links should refer to local page
1041          *
1042          * @return string
1043          */
1044         function commentBlock( $comment, $title = NULL, $local = false ) {
1045                 // '*' used to be the comment inserted by the software way back
1046                 // in antiquity in case none was provided, here for backwards
1047                 // compatability, acc. to brion -ævar
1048                 if( $comment == '' || $comment == '*' ) {
1049                         return '';
1050                 } else {
1051                         $formatted = $this->formatComment( $comment, $title, $local );
1052                         return " <span class=\"comment\">($formatted)</span>";
1053                 }
1054         }
1055
1056         /**
1057          * Wrap and format the given revision's comment block, if the current
1058          * user is allowed to view it.
1059          *
1060          * @param Revision $rev
1061          * @param bool $local Whether section links should refer to local page
1062          * @return string HTML
1063          */
1064         function revComment( Revision $rev, $local = false ) {
1065                 if( $rev->userCan( Revision::DELETED_COMMENT ) ) {
1066                         $block = $this->commentBlock( $rev->getRawComment(), $rev->getTitle(), $local );
1067                 } else {
1068                         $block = " <span class=\"comment\">" .
1069                                 wfMsgHtml( 'rev-deleted-comment' ) . "</span>";
1070                 }
1071                 if( $rev->isDeleted( Revision::DELETED_COMMENT ) ) {
1072                         return " <span class=\"history-deleted\">$block</span>";
1073                 }
1074                 return $block;
1075         }
1076
1077         /** @todo document */
1078         function tocIndent() {
1079                 return "\n<ul>";
1080         }
1081
1082         /** @todo document */
1083         function tocUnindent($level) {
1084                 return "</li>\n" . str_repeat( "</ul>\n</li>\n", $level>0 ? $level : 0 );
1085         }
1086
1087         /**
1088          * parameter level defines if we are on an indentation level
1089          */
1090         function tocLine( $anchor, $tocline, $tocnumber, $level ) {
1091                 return "\n<li class=\"toclevel-$level\"><a href=\"#" .
1092                         $anchor . '"><span class="tocnumber">' .
1093                         $tocnumber . '</span> <span class="toctext">' .
1094                         $tocline . '</span></a>';
1095         }
1096
1097         /** @todo document */
1098         function tocLineEnd() {
1099                 return "</li>\n";
1100         }
1101
1102         /** @todo document */
1103         function tocList($toc) {
1104                 global $wgJsMimeType;
1105                 $title =  wfMsgHtml('toc') ;
1106                 return
1107                    '<table id="toc" class="toc" summary="' . $title .'"><tr><td>'
1108                  . '<div id="toctitle"><h2>' . $title . "</h2></div>\n"
1109                  . $toc
1110                  # no trailing newline, script should not be wrapped in a
1111                  # paragraph
1112                  . "</ul>\n</td></tr></table>"
1113                  . '<script type="' . $wgJsMimeType . '">'
1114                  . ' if (window.showTocToggle) {'
1115                  . ' var tocShowText = "' . wfEscapeJsString( wfMsg('showtoc') ) . '";'
1116                  . ' var tocHideText = "' . wfEscapeJsString( wfMsg('hidetoc') ) . '";'
1117                  . ' showTocToggle();'
1118                  . ' } '
1119                  . "</script>\n";
1120         }
1121
1122         /**
1123          * Used to generate section edit links that point to "other" pages
1124          * (sections that are really part of included pages).
1125          *
1126          * @param $title Title string.
1127          * @param $section Integer: section number.
1128          */
1129         public function editSectionLinkForOther( $title, $section ) {
1130                 $title = Title::newFromText( $title );
1131                 return $this->doEditSectionLink( $title, $section, '', 'EditSectionLinkForOther' );
1132         }
1133
1134         /**
1135          * @param $nt Title object.
1136          * @param $section Integer: section number.
1137          * @param $hint Link String: title, or default if omitted or empty
1138          */
1139         public function editSectionLink( Title $nt, $section, $hint='' ) {
1140                 if( $hint != '' ) {
1141                         $hint = wfMsgHtml( 'editsectionhint', htmlspecialchars( $hint ) );
1142                         $hint = " title=\"$hint\"";
1143                 }
1144                 return $this->doEditSectionLink( $nt, $section, $hint, 'EditSectionLink' );
1145         }
1146
1147         /**
1148          * Implement editSectionLink and editSectionLinkForOther.
1149          *
1150          * @param $nt      Title object
1151          * @param $section Integer, section number
1152          * @param $hint    String, for HTML title attribute
1153          * @param $hook    String, name of hook to run
1154          * @return         String, HTML to use for edit link
1155          */
1156         protected function doEditSectionLink( Title $nt, $section, $hint, $hook ) {
1157                 global $wgContLang;
1158                 $editurl = '&section='.$section;
1159                 $url = $this->makeKnownLinkObj(
1160                         $nt,
1161                         wfMsg('editsection'),
1162                         'action=edit'.$editurl,
1163                         '', '', '',  $hint
1164                 );
1165                 $result = null;
1166
1167                 // The two hooks have slightly different interfaces . . .
1168                 if( $hook == 'EditSectionLink' ) {
1169                         wfRunHooks( $hook, array( &$this, $nt, $section, $hint, $url, &$result ) );
1170                 } elseif( $hook == 'EditSectionLinkForOther' ) {
1171                         wfRunHooks( $hook, array( &$this, $nt, $section, $url, &$result ) );
1172                 }
1173
1174                 // For reverse compatibility, add the brackets *after* the hook is run,
1175                 // and even add them to hook-provided text.
1176                 if( is_null( $result ) ) {
1177                         $result = wfMsg( 'editsection-brackets', $url );
1178                 } else {
1179                         $result = wfMsg( 'editsection-brackets', $result );
1180                 }
1181                 return "<span class=\"editsection\">$result</span>";
1182         }
1183
1184         /**
1185          * Create a headline for content
1186          *
1187          * @param int    $level   The level of the headline (1-6)
1188          * @param string $attribs Any attributes for the headline, starting with a space and ending with '>'
1189          *                        This *must* be at least '>' for no attribs
1190          * @param string $anchor  The anchor to give the headline (the bit after the #)
1191          * @param string $text    The text of the header
1192          * @param string $link    HTML to add for the section edit link
1193          *
1194          * @return string HTML headline
1195          */
1196         public function makeHeadline( $level, $attribs, $anchor, $text, $link ) {
1197                 return "<a name=\"$anchor\"></a><h$level$attribs$link <span class=\"mw-headline\">$text</span></h$level>";
1198         }
1199
1200         /**
1201          * Split a link trail, return the "inside" portion and the remainder of the trail
1202          * as a two-element array
1203          *
1204          * @static
1205          */
1206         static function splitTrail( $trail ) {
1207                 static $regex = false;
1208                 if ( $regex === false ) {
1209                         global $wgContLang;
1210                         $regex = $wgContLang->linkTrail();
1211                 }
1212                 $inside = '';
1213                 if ( '' != $trail ) {
1214                         $m = array();
1215                         if ( preg_match( $regex, $trail, $m ) ) {
1216                                 $inside = $m[1];
1217                                 $trail = $m[2];
1218                         }
1219                 }
1220                 return array( $inside, $trail );
1221         }
1222
1223         /**
1224          * Generate a rollback link for a given revision.  Currently it's the
1225          * caller's responsibility to ensure that the revision is the top one. If
1226          * it's not, of course, the user will get an error message.
1227          *
1228          * If the calling page is called with the parameter &bot=1, all rollback
1229          * links also get that parameter. It causes the edit itself and the rollback
1230          * to be marked as "bot" edits. Bot edits are hidden by default from recent
1231          * changes, so this allows sysops to combat a busy vandal without bothering
1232          * other users.
1233          *
1234          * @param Revision $rev
1235          */
1236         function generateRollback( $rev ) {
1237                 return '<span class="mw-rollback-link">['
1238                         . $this->buildRollbackLink( $rev )
1239                         . ']</span>';
1240         }
1241
1242         /**
1243          * Build a raw rollback link, useful for collections of "tool" links
1244          *
1245          * @param Revision $rev
1246          * @return string
1247          */
1248         public function buildRollbackLink( $rev ) {
1249                 global $wgRequest, $wgUser;
1250                 $title = $rev->getTitle();
1251                 $extra  = $wgRequest->getBool( 'bot' ) ? '&bot=1' : '';
1252                 $extra .= '&token=' . urlencode( $wgUser->editToken( array( $title->getPrefixedText(),
1253                         $rev->getUserText() ) ) );
1254                 return $this->makeKnownLinkObj(
1255                         $title,
1256                         wfMsgHtml( 'rollbacklink' ),
1257                         'action=rollback&from=' . urlencode( $rev->getUserText() ) . $extra
1258                 );
1259         }
1260
1261         /**
1262          * Returns HTML for the "templates used on this page" list.
1263          *
1264          * @param array $templates Array of templates from Article::getUsedTemplate
1265          * or similar
1266          * @param bool $preview Whether this is for a preview
1267          * @param bool $section Whether this is for a section edit
1268          * @return string HTML output
1269          */
1270         public function formatTemplates( $templates, $preview = false, $section = false) {
1271                 global $wgUser;
1272                 wfProfileIn( __METHOD__ );
1273
1274                 $sk = $wgUser->getSkin();
1275
1276                 $outText = '';
1277                 if ( count( $templates ) > 0 ) {
1278                         # Do a batch existence check
1279                         $batch = new LinkBatch;
1280                         foreach( $templates as $title ) {
1281                                 $batch->addObj( $title );
1282                         }
1283                         $batch->execute();
1284
1285                         # Construct the HTML
1286                         $outText = '<div class="mw-templatesUsedExplanation">';
1287                         if ( $preview ) {
1288                                 $outText .= wfMsgExt( 'templatesusedpreview', array( 'parse' ) );
1289                         } elseif ( $section ) {
1290                                 $outText .= wfMsgExt( 'templatesusedsection', array( 'parse' ) );
1291                         } else {
1292                                 $outText .= wfMsgExt( 'templatesused', array( 'parse' ) );
1293                         }
1294                         $outText .= '</div><ul>';
1295
1296                         foreach ( $templates as $titleObj ) {
1297                                 $r = $titleObj->getRestrictions( 'edit' );
1298                                 if ( in_array( 'sysop', $r ) ) {
1299                                         $protected = wfMsgExt( 'template-protected', array( 'parseinline' ) );
1300                                 } elseif ( in_array( 'autoconfirmed', $r ) ) {
1301                                         $protected = wfMsgExt( 'template-semiprotected', array( 'parseinline' ) );
1302                                 } else {
1303                                         $protected = '';
1304                                 }
1305                                 $outText .= '<li>' . $sk->makeLinkObj( $titleObj ) . ' ' . $protected . '</li>';
1306                         }
1307                         $outText .= '</ul>';
1308                 }
1309                 wfProfileOut( __METHOD__  );
1310                 return $outText;
1311         }
1312
1313         /**
1314          * Format a size in bytes for output, using an appropriate
1315          * unit (B, KB, MB or GB) according to the magnitude in question
1316          *
1317          * @param $size Size to format
1318          * @return string
1319          */
1320         public function formatSize( $size ) {
1321                 global $wgLang;
1322                 return htmlspecialchars( $wgLang->formatSize( $size ) );
1323         }
1324
1325         /**
1326          * Given the id of an interface element, constructs the appropriate title
1327          * and accesskey attributes from the system messages.  (Note, this is usu-
1328          * ally the id but isn't always, because sometimes the accesskey needs to
1329          * go on a different element than the id, for reverse-compatibility, etc.)
1330          *
1331          * @param string $name Id of the element, minus prefixes.
1332          * @return string title and accesskey attributes, ready to drop in an
1333          *   element (e.g., ' title="This does something [x]" accesskey="x"').
1334          */
1335         public function tooltipAndAccesskey($name) {
1336                 $out = '';
1337
1338                 $tooltip = wfMsg('tooltip-'.$name);
1339                 if (!wfEmptyMsg('tooltip-'.$name, $tooltip) && $tooltip != '-') {
1340                         // Compatibility: formerly some tooltips had [alt-.] hardcoded
1341                         $tooltip = preg_replace( "/ ?\[alt-.\]$/", '', $tooltip );
1342                         $out .= ' title="'.htmlspecialchars($tooltip);
1343                 }
1344                 $accesskey = wfMsg('accesskey-'.$name);
1345                 if ($accesskey && $accesskey != '-' && !wfEmptyMsg('accesskey-'.$name, $accesskey)) {
1346                         if ($out) $out .= " [$accesskey]\" accesskey=\"$accesskey\"";
1347                         else $out .= " title=\"[$accesskey]\" accesskey=\"$accesskey\"";
1348                 } elseif ($out) {
1349                         $out .= '"';
1350                 }
1351                 return $out;
1352         }
1353
1354         /**
1355          * Given the id of an interface element, constructs the appropriate title
1356          * attribute from the system messages.  (Note, this is usually the id but
1357          * isn't always, because sometimes the accesskey needs to go on a different
1358          * element than the id, for reverse-compatibility, etc.)
1359          *
1360          * @param string $name Id of the element, minus prefixes.
1361          * @return string title attribute, ready to drop in an element
1362          * (e.g., ' title="This does something"').
1363          */
1364         public function tooltip($name) {
1365                 $out = '';
1366
1367                 $tooltip = wfMsg('tooltip-'.$name);
1368                 if (!wfEmptyMsg('tooltip-'.$name, $tooltip) && $tooltip != '-') {
1369                         $out = ' title="'.htmlspecialchars($tooltip).'"';
1370                 }
1371
1372                 return $out;
1373         }
1374 }
1375
1376
1377
1378