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  * @package MediaWiki
   8  */
   9
  10 /**
  11  * For the moment, Skin is a descendent class of Linker.
  12  * In the future, it should probably be further split
  13  * so that ever other bit of the wiki doesn't have to
  14  * go loading up Skin to get at it.
  15  *
  16  * @package MediaWiki
  17  */
  18 class Linker {
  19
  20         function Linker() {}
  21
  22         /**
  23          * OBSOLETE
  24          */
  25         function postParseLinkColour( $s = NULL ) {
  26                 return NULL;
  27         }
  28
  29         /** @todo document */
  30         function getExternalLinkAttributes( $link, $text, $class='' ) {
  31                 global $wgContLang;
  32
  33                 $same = ($link == $text);
  34                 $link = urldecode( $link );
  35                 $link = $wgContLang->checkTitleEncoding( $link );
  36                 $link = preg_replace( '/[\\x00-\\x1f_]/', ' ', $link );
  37                 $link = htmlspecialchars( $link );
  38
  39                 $r = ($class != '') ? " class='$class'" : " class='external'";
  40
  41                 $r .= " title=\"{$link}\"";
  42                 return $r;
  43         }
  44
  45         /** @todo document */
  46         function getInternalLinkAttributes( $link, $text, $broken = false ) {
  47                 $link = urldecode( $link );
  48                 $link = str_replace( '_', ' ', $link );
  49                 $link = htmlspecialchars( $link );
  50
  51                 if( $broken == 'stub' ) {
  52                         $r = ' class="stub"';
  53                 } else if ( $broken == 'yes' ) {
  54                         $r = ' class="new"';
  55                 } else {
  56                         $r = '';
  57                 }
  58
  59                 $r .= " title=\"{$link}\"";
  60                 return $r;
  61         }
  62
  63         /**
  64          * @param bool $broken
  65          */
  66         function getInternalLinkAttributesObj( &$nt, $text, $broken = false ) {
  67                 if( $broken == 'stub' ) {
  68                         $r = ' class="stub"';
  69                 } else if ( $broken == 'yes' ) {
  70                         $r = ' class="new"';
  71                 } else {
  72                         $r = '';
  73                 }
  74
  75                 $r .= ' title="' . $nt->getEscapedText() . '"';
  76                 return $r;
  77         }
  78
  79         /**
  80          * Note: This function MUST call getArticleID() on the link,
  81          * otherwise the cache won't get updated properly.  See LINKCACHE.DOC.
  82          */
  83         function makeLink( $title, $text = '', $query = '', $trail = '' ) {
  84                 wfProfileIn( 'Linker::makeLink' );
  85                 $nt = Title::newFromText( $title );
  86                 if ($nt) {
  87                         $result = $this->makeLinkObj( Title::newFromText( $title ), $text, $query, $trail );
  88                 } else {
  89                         wfDebug( 'Invalid title passed to Linker::makeLink(): "'.$title."\"\n" );
  90                         $result = $text == "" ? $title : $text;
  91                 }
  92
  93                 wfProfileOut( 'Linker::makeLink' );
  94                 return $result;
  95         }
  96
  97         /** @todo document */
  98         function makeKnownLink( $title, $text = '', $query = '', $trail = '', $prefix = '',$aprops = '') {
  99                 $nt = Title::newFromText( $title );
 100                 if ($nt) {
 101                         return $this->makeKnownLinkObj( Title::newFromText( $title ), $text, $query, $trail, $prefix , $aprops );
 102                 } else {
 103                         wfDebug( 'Invalid title passed to Linker::makeKnownLink(): "'.$title."\"\n" );
 104                         return $text == '' ? $title : $text;
 105                 }
 106         }
 107
 108         /** @todo document */
 109         function makeBrokenLink( $title, $text = '', $query = '', $trail = '' ) {
 110                 $nt = Title::newFromText( $title );
 111                 if ($nt) {
 112                         return $this->makeBrokenLinkObj( Title::newFromText( $title ), $text, $query, $trail );
 113                 } else {
 114                         wfDebug( 'Invalid title passed to Linker::makeBrokenLink(): "'.$title."\"\n" );
 115                         return $text == '' ? $title : $text;
 116                 }
 117         }
 118
 119         /** @todo document */
 120         function makeStubLink( $title, $text = '', $query = '', $trail = '' ) {
 121                 $nt = Title::newFromText( $title );
 122                 if ($nt) {
 123                         return $this->makeStubLinkObj( Title::newFromText( $title ), $text, $query, $trail );
 124                 } else {
 125                         wfDebug( 'Invalid title passed to Linker::makeStubLink(): "'.$title."\"\n" );
 126                         return $text == '' ? $title : $text;
 127                 }
 128         }
 129
 130         /**
 131          * Pass a title object, not a title string
 132          */
 133         function makeLinkObj( &$nt, $text= '', $query = '', $trail = '', $prefix = '' ) {
 134                 global $wgOut, $wgUser;
 135                 $fname = 'Linker::makeLinkObj';
 136                 wfProfileIn( $fname );
 137
 138                 # Fail gracefully
 139                 if ( ! is_object($nt) ) {
 140                         # wfDebugDieBacktrace();
 141                         wfProfileOut( $fname );
 142                         return "<!-- ERROR -->{$prefix}{$text}{$trail}";
 143                 }
 144
 145                 $ns = $nt->getNamespace();
 146                 $dbkey = $nt->getDBkey();
 147                 if ( $nt->isExternal() ) {
 148                         $u = $nt->getFullURL();
 149                         $link = $nt->getPrefixedURL();
 150                         if ( '' == $text ) { $text = $nt->getPrefixedText(); }
 151                         $style = $this->getExternalLinkAttributes( $link, $text, 'extiw' );
 152
 153                         $inside = '';
 154                         if ( '' != $trail ) {
 155                                 if ( preg_match( '/^([a-z]+)(.*)$$/sD', $trail, $m ) ) {
 156                                         $inside = $m[1];
 157                                         $trail = $m[2];
 158                                 }
 159                         }
 160
 161                         # Check for anchors, normalize the anchor
 162
 163                         $parts = explode( '#', $u, 2 );
 164                         if ( count( $parts ) == 2 ) {
 165                                 $anchor = urlencode( Sanitizer::decodeCharReferences( str_replace(' ', '_', $parts[1] ) ) );
 166                                 $replacearray = array(
 167                                         '%3A' => ':',
 168                                         '%' => '.'
 169                                 );
 170                                 $u = $parts[0] . '#' .
 171                                      str_replace( array_keys( $replacearray ),
 172                                                  array_values( $replacearray ),
 173                                                  $anchor );
 174                         }
 175
 176                         $t = "<a href=\"{$u}\"{$style}>{$text}{$inside}</a>";
 177
 178                         wfProfileOut( $fname );
 179                         return $t;
 180                 } elseif ( $nt->isAlwaysKnown() ) {
 181                         # Image links, special page links and self-links with fragements are always known.
 182                         $retVal = $this->makeKnownLinkObj( $nt, $text, $query, $trail, $prefix );
 183                 } else {
 184                         wfProfileIn( $fname.'-immediate' );
 185                         # Work out link colour immediately
 186                         $aid = $nt->getArticleID() ;
 187                         if ( 0 == $aid ) {
 188                                 $retVal = $this->makeBrokenLinkObj( $nt, $text, $query, $trail, $prefix );
 189                         } else {
 190                                 $threshold = $wgUser->getOption('stubthreshold') ;
 191                                 if ( $threshold > 0 ) {
 192                                         $dbr =& wfGetDB( DB_SLAVE );
 193                                         $s = $dbr->selectRow(
 194                                                 array( 'page' ),
 195                                                 array( 'page_len',
 196                                                         'page_namespace',
 197                                                         'page_is_redirect' ),
 198                                                 array( 'page_id' => $aid ), $fname ) ;
 199                                         if ( $s !== false ) {
 200                                                 $size = $s->page_len;
 201                                                 if ( $s->page_is_redirect OR $s->page_namespace != NS_MAIN ) {
 202                                                         $size = $threshold*2 ; # Really big
 203                                                 }
 204                                         } else {
 205                                                 $size = $threshold*2 ; # Really big
 206                                         }
 207                                 } else {
 208                                         $size = 1 ;
 209                                 }
 210                                 if ( $size < $threshold ) {
 211                                         $retVal = $this->makeStubLinkObj( $nt, $text, $query, $trail, $prefix );
 212                                 } else {
 213                                         $retVal = $this->makeKnownLinkObj( $nt, $text, $query, $trail, $prefix );
 214                                 }
 215                         }
 216                         wfProfileOut( $fname.'-immediate' );
 217                 }
 218                 wfProfileOut( $fname );
 219                 return $retVal;
 220         }
 221
 222         /**
 223          * Pass a title object, not a title string
 224          */
 225         function makeKnownLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' , $aprops = '' ) {
 226                 global $wgOut, $wgTitle;
 227
 228                 $fname = 'Linker::makeKnownLinkObj';
 229                 wfProfileIn( $fname );
 230
 231                 if ( !is_object( $nt ) ) {
 232                         wfProfileOut( $fname );
 233                         return $text;
 234                 }
 235
 236                 $u = $nt->escapeLocalURL( $query );
 237                 if ( '' != $nt->getFragment() ) {
 238                         if( $nt->getPrefixedDbkey() == '' ) {
 239                                 $u = '';
 240                                 if ( '' == $text ) {
 241                                         $text = htmlspecialchars( $nt->getFragment() );
 242                                 }
 243                         }
 244                         $anchor = urlencode( Sanitizer::decodeCharReferences( str_replace( ' ', '_', $nt->getFragment() ) ) );
 245                         $replacearray = array(
 246                                 '%3A' => ':',
 247                                 '%' => '.'
 248                         );
 249                         $u .= '#' . str_replace(array_keys($replacearray),array_values($replacearray),$anchor);
 250                 }
 251                 if ( '' == $text ) {
 252                         $text = htmlspecialchars( $nt->getPrefixedText() );
 253                 }
 254                 $style = $this->getInternalLinkAttributesObj( $nt, $text );
 255
 256                 list( $inside, $trail ) = Linker::splitTrail( $trail );
 257                 $r = "<a href=\"{$u}\"{$style}{$aprops}>{$prefix}{$text}{$inside}</a>{$trail}";
 258                 wfProfileOut( $fname );
 259                 return $r;
 260         }
 261
 262         /**
 263          * Pass a title object, not a title string
 264          */
 265         function makeBrokenLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
 266                 # Fail gracefully
 267                 if ( ! isset($nt) ) {
 268                         # wfDebugDieBacktrace();
 269                         return "<!-- ERROR -->{$prefix}{$text}{$trail}";
 270                 }
 271
 272                 $fname = 'Linker::makeBrokenLinkObj';
 273                 wfProfileIn( $fname );
 274
 275                 if ( '' == $query ) {
 276                         $q = 'action=edit';
 277                 } else {
 278                         $q = 'action=edit&'.$query;
 279                 }
 280                 $u = $nt->escapeLocalURL( $q );
 281
 282                 if ( '' == $text ) {
 283                         $text = htmlspecialchars( $nt->getPrefixedText() );
 284                 }
 285                 $style = $this->getInternalLinkAttributesObj( $nt, $text, "yes" );
 286
 287                 list( $inside, $trail ) = Linker::splitTrail( $trail );
 288                 $s = "<a href=\"{$u}\"{$style}>{$prefix}{$text}{$inside}</a>{$trail}";
 289
 290                 wfProfileOut( $fname );
 291                 return $s;
 292         }
 293
 294         /**
 295          * Pass a title object, not a title string
 296          */
 297         function makeStubLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
 298                 $link = $nt->getPrefixedURL();
 299
 300                 $u = $nt->escapeLocalURL( $query );
 301
 302                 if ( '' == $text ) {
 303                         $text = htmlspecialchars( $nt->getPrefixedText() );
 304                 }
 305                 $style = $this->getInternalLinkAttributesObj( $nt, $text, 'stub' );
 306
 307                 list( $inside, $trail ) = Linker::splitTrail( $trail );
 308                 $s = "<a href=\"{$u}\"{$style}>{$prefix}{$text}{$inside}</a>{$trail}";
 309                 return $s;
 310         }
 311
 312         /**
 313          * Generate either a normal exists-style link or a stub link, depending
 314          * on the given page size.
 315          *
 316          * @param int $size
 317          * @param Title $nt
 318          * @param string $text
 319          * @param string $query
 320          * @param string $trail
 321          * @param string $prefix
 322          * @return string HTML of link
 323          */
 324         function makeSizeLinkObj( $size, $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
 325                 global $wgUser;
 326                 $threshold = IntVal( $wgUser->getOption( 'stubthreshold' ) );
 327                 if( $size < $threshold ) {
 328                         return $this->makeStubLinkObj( $nt, $text, $query, $trail, $prefix );
 329                 } else {
 330                         return $this->makeKnownLinkObj( $nt, $text, $query, $trail, $prefix );
 331                 }
 332         }
 333
 334         /** @todo document */
 335         function makeSelfLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
 336                 $u = $nt->escapeLocalURL( $query );
 337                 if ( '' == $text ) {
 338                         $text = htmlspecialchars( $nt->getPrefixedText() );
 339                 }
 340                 list( $inside, $trail ) = Linker::splitTrail( $trail );
 341                 return "<strong>{$prefix}{$text}{$inside}</strong>{$trail}";
 342         }
 343
 344         /** @todo document */
 345         function fnamePart( $url ) {
 346                 $basename = strrchr( $url, '/' );
 347                 if ( false === $basename ) {
 348                         $basename = $url;
 349                 } else {
 350                         $basename = substr( $basename, 1 );
 351                 }
 352                 return htmlspecialchars( $basename );
 353         }
 354
 355         /** Obsolete alias */
 356         function makeImage( $url, $alt = '' ) {
 357                 return $this->makeExternalImage( $url, $alt );
 358         }
 359
 360         /** @todo document */
 361         function makeExternalImage( $url, $alt = '' ) {
 362                 global $wgOut;
 363                 if ( '' == $alt ) {
 364                         $alt = $this->fnamePart( $url );
 365                 }
 366                 $s = '<img src="'.$url.'" alt="'.$alt.'" />';
 367                 return $s;
 368         }
 369
 370         /** @todo document */
 371         function makeImageLinkObj( &$nt, $label, $alt, $align = '', $width = false, $height = false, $framed = false,
 372           $thumb = false, $manual_thumb = '' )
 373         {
 374                 global $wgContLang, $wgUser, $wgThumbLimits;
 375
 376                 $img   = new Image( $nt );
 377                 $url   = $img->getViewURL();
 378                 $prefix = $postfix = '';
 379
 380                 if ( 'center' == $align )
 381                 {
 382                         $prefix  = '<div class="center">';
 383                         $postfix = '</div>';
 384                         $align   = 'none';
 385                 }
 386
 387                 if ( $thumb || $framed ) {
 388
 389                         # Create a thumbnail. Alignment depends on language
 390                         # writing direction, # right aligned for left-to-right-
 391                         # languages ("Western languages"), left-aligned
 392                         # for right-to-left-languages ("Semitic languages")
 393                         #
 394                         # If  thumbnail width has not been provided, it is set
 395                         # to the default user option as specified in Language*.php
 396                         if ( $align == '' ) {
 397                                 $align = $wgContLang->isRTL() ? 'left' : 'right';
 398                         }
 399
 400
 401                         if ( $width === false ) {
 402                                 $wopt = $wgUser->getOption( 'thumbsize' );
 403
 404                                 if( !isset( $wgThumbLimits[$wopt] ) ) {
 405                                          $wopt = User::getDefaultOption( 'thumbsize' );
 406                                 }
 407
 408                                 $width = $wgThumbLimits[$wopt];
 409                         }
 410
 411                         return $prefix.$this->makeThumbLinkObj( $img, $label, $alt, $align, $width, $height, $framed, $manual_thumb ).$postfix;
 412
 413                 } elseif ( $width ) {
 414
 415                         # Create a resized image, without the additional thumbnail
 416                         # features
 417
 418                         if ( $height !== false && ( $img->getHeight() * $width / $img->getWidth() > $height ) ) {
 419                                 $width = $img->getWidth() * $height / $img->getHeight();
 420                         }
 421                         if ( '' == $manual_thumb ) {
 422                                 $thumb = $img->getThumbnail( $width );
 423                                 if ( $thumb ) {
 424                                         $height = $thumb->height;
 425                                         $url = $thumb->getUrl( );
 426                                 }
 427                         }
 428                 }
 429
 430                 $u = $nt->escapeLocalURL();
 431                 if ( $url == '' ) {
 432                         $s = $this->makeBrokenImageLinkObj( $img->getTitle() );
 433                         //$s .= "<br />{$alt}<br />{$url}<br />\n";
 434                 } else {
 435                         $s = '<a href="'.$u.'" class="image" title="'.$alt.'">' .
 436                                  '<img src="'.$url.'" alt="'.$alt.'" ' .
 437                                  'width="'.$width.'" height="'.$height.'" ' .
 438                                  'longdesc="'.$u.'" /></a>';
 439                 }
 440                 if ( '' != $align ) {
 441                         $s = "<div class=\"float{$align}\"><span>{$s}</span></div>";
 442                 }
 443                 return str_replace("\n", ' ',$prefix.$s.$postfix);
 444         }
 445
 446         /**
 447          * Make HTML for a thumbnail including image, border and caption
 448          * $img is an Image object
 449          */
 450         function makeThumbLinkObj( $img, $label = '', $alt, $align = 'right', $boxwidth = 180, $boxheight=false, $framed=false , $manual_thumb = "" ) {
 451                 global $wgStylePath, $wgContLang;
 452                 $url  = $img->getViewURL();
 453
 454                 $width = $height = 0;
 455                 if ( $img->exists() )
 456                 {
 457                         $width  = $img->getWidth();
 458                         $height = $img->getHeight();
 459                 }
 460                 if ( 0 == $width || 0 == $height )
 461                 {
 462                         $width = $height = 200;
 463                 }
 464                 if ( $boxwidth == 0 )
 465                 {
 466                         $boxwidth = 200;
 467                 }
 468                 if ( $framed )
 469                 {
 470                         // Use image dimensions, don't scale
 471                         $boxwidth  = $width;
 472                         $oboxwidth = $boxwidth + 2;
 473                         $boxheight = $height;
 474                         $thumbUrl  = $url;
 475                 } else {
 476                         $h  = intval( $height/($width/$boxwidth) );
 477                         $oboxwidth = $boxwidth + 2;
 478                         if ( ( ! $boxheight === false ) &&  ( $h > $boxheight ) )
 479                         {
 480                                 $boxwidth *= $boxheight/$h;
 481                         } else {
 482                                 $boxheight = $h;
 483                         }
 484                         if ( '' == $manual_thumb ) $thumbUrl = $img->createThumb( $boxwidth );
 485                 }
 486
 487                 if ( $manual_thumb != '' ) # Use manually specified thumbnail
 488                 {
 489                         $manual_title = Title::makeTitleSafe( NS_IMAGE, $manual_thumb ); #new Title ( $manual_thumb ) ;
 490                         $manual_img = new Image( $manual_title );
 491                         $thumbUrl = $manual_img->getViewURL();
 492                         if ( $manual_img->exists() )
 493                         {
 494                                 $width  = $manual_img->getWidth();
 495                                 $height = $manual_img->getHeight();
 496                                 $boxwidth = $width ;
 497                                 $boxheight = $height ;
 498                                 $oboxwidth = $boxwidth + 2 ;
 499                         }
 500                 }
 501
 502                 $u = $img->getEscapeLocalURL();
 503
 504                 $more = htmlspecialchars( wfMsg( 'thumbnail-more' ) );
 505                 $magnifyalign = $wgContLang->isRTL() ? 'left' : 'right';
 506                 $textalign = $wgContLang->isRTL() ? ' style="text-align:right"' : '';
 507
 508                 $s = "<div class=\"thumb t{$align}\"><div style=\"width:{$oboxwidth}px;\">";
 509                 if ( $thumbUrl == '' ) {
 510                         $s .= $this->makeBrokenImageLinkObj( $img->getTitle );
 511                         $zoomicon = '';
 512                 } else {
 513                         $s .= '<a href="'.$u.'" class="internal" title="'.$alt.'">'.
 514                                 '<img src="'.$thumbUrl.'" alt="'.$alt.'" ' .
 515                                 'width="'.$boxwidth.'" height="'.$boxheight.'" ' .
 516                                 'longdesc="'.$u.'" /></a>';
 517                         if ( $framed ) {
 518                                 $zoomicon="";
 519                         } else {
 520                                 $zoomicon =  '<div class="magnify" style="float:'.$magnifyalign.'">'.
 521                                         '<a href="'.$u.'" class="internal" title="'.$more.'">'.
 522                                         '<img src="'.$wgStylePath.'/common/images/magnify-clip.png" ' .
 523                                         'width="15" height="11" alt="'.$more.'" /></a></div>';
 524                         }
 525                 }
 526                 $s .= '  <div class="thumbcaption" '.$textalign.'>'.$zoomicon.$label."</div></div></div>";
 527                 return str_replace("\n", ' ', $s);
 528         }
 529
 530         /**
 531          * Pass a title object, not a title string
 532          */
 533         function makeBrokenImageLinkObj( &$nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
 534                 # Fail gracefully
 535                 if ( ! isset($nt) ) {
 536                         # wfDebugDieBacktrace();
 537                         return "<!-- ERROR -->{$prefix}{$text}{$trail}";
 538                 }
 539
 540                 $fname = 'Linker::makeBrokenImageLinkObj';
 541                 wfProfileIn( $fname );
 542
 543                 $q = 'wpDestFile=' . urlencode( $nt->getDBkey() );
 544                 if ( '' != $query ) {
 545                         $q .= "&$query";
 546                 }
 547                 $uploadTitle = Title::makeTitle( NS_SPECIAL, 'Upload' );
 548                 $url = $uploadTitle->escapeLocalURL( $q );
 549
 550                 if ( '' == $text ) {
 551                         $text = htmlspecialchars( $nt->getPrefixedText() );
 552                 }
 553                 $style = $this->getInternalLinkAttributesObj( $nt, $text, "yes" );
 554                 list( $inside, $trail ) = Linker::splitTrail( $trail );
 555                 $s = "<a href=\"{$url}\"{$style}>{$prefix}{$text}{$inside}</a>{$trail}";
 556
 557                 wfProfileOut( $fname );
 558                 return $s;
 559         }
 560
 561         /** @todo document */
 562         function makeMediaLink( $name, $url, $alt = '' ) {
 563                 $nt = Title::makeTitleSafe( NS_IMAGE, $name );
 564                 return $this->makeMediaLinkObj( $nt, $alt );
 565         }
 566
 567         /**
 568          * Create a direct link to a given uploaded file.
 569          *
 570          * @param Title  $title
 571          * @param string $text   pre-sanitized HTML
 572          * @param bool   $nourl  Mask absolute URLs, so the parser doesn't
 573          *                       linkify them (it is currently not context-aware)
 574          * @return string HTML
 575          *
 576          * @access public
 577          * @todo Handle invalid or missing images better.
 578          */
 579         function makeMediaLinkObj( $title, $text = '', $nourl=false ) {
 580                 if( is_null( $title ) ) {
 581                         ### HOTFIX. Instead of breaking, return empty string.
 582                         return $text;
 583                 } else {
 584                         $name = $title->getDBKey();
 585                         $img  = new Image( $title );
 586                         if( $img->exists() ) {
 587                                 $url  = $img->getURL();
 588                                 if( $nourl ) {
 589                                         $url = str_replace( "http://", "http-noparse://", $url );
 590                                 }
 591                                 $class = 'internal';
 592                         } else {
 593                                 $upload = Title::makeTitle( NS_SPECIAL, 'Upload' );
 594                                 $url = $upload->getLocalUrl( 'wpDestFile=' . urlencode( $img->getName() ) );
 595                                 $class = 'new';
 596                         }
 597                         $alt = htmlspecialchars( $title->getText() );
 598                         if( $text == '' ) {
 599                                 $text = $alt;
 600                         }
 601                         $u = htmlspecialchars( $url );
 602                         return "<a href=\"{$u}\" class='$class' title=\"{$alt}\">{$text}</a>";
 603                 }
 604         }
 605
 606         /** @todo document */
 607         function specialLink( $name, $key = '' ) {
 608                 global $wgContLang;
 609
 610                 if ( '' == $key ) { $key = strtolower( $name ); }
 611                 $pn = $wgContLang->ucfirst( $name );
 612                 return $this->makeKnownLink( $wgContLang->specialPage( $pn ),
 613                   wfMsg( $key ) );
 614         }
 615
 616         /** @todo document */
 617         function makeExternalLink( $url, $text, $escape = true, $linktype = '' ) {
 618                 $style = $this->getExternalLinkAttributes( $url, $text, 'external ' . $linktype );
 619                 global $wgNoFollowLinks;
 620                 if( $wgNoFollowLinks ) {
 621                         $style .= ' rel="nofollow"';
 622                 }
 623                 $url = htmlspecialchars( $url );
 624                 if( $escape ) {
 625                         $text = htmlspecialchars( $text );
 626                 }
 627                 return '<a href="'.$url.'"'.$style.'>'.$text.'</a>';
 628         }
 629
 630         /**
 631          * This function is called by all recent changes variants, by the page history,
 632          * and by the user contributions list. It is responsible for formatting edit
 633          * comments. It escapes any HTML in the comment, but adds some CSS to format
 634          * auto-generated comments (from section editing) and formats [[wikilinks]].
 635          *
 636          * The &$title parameter must be a title OBJECT. It is used to generate a
 637          * direct link to the section in the autocomment.
 638          * @author Erik Moeller <moeller@scireview.de>
 639          *
 640          * Note: there's not always a title to pass to this function.
 641          * Since you can't set a default parameter for a reference, I've turned it
 642          * temporarily to a value pass. Should be adjusted further. --brion
 643          */
 644         function formatComment($comment, $title = NULL) {
 645                 $fname = 'Linker::formatComment';
 646                 wfProfileIn( $fname );
 647
 648                 global $wgContLang;
 649                 $comment = str_replace( "\n", " ", $comment );
 650                 $comment = htmlspecialchars( $comment );
 651
 652                 # The pattern for autogen comments is / * foo * /, which makes for
 653                 # some nasty regex.
 654                 # We look for all comments, match any text before and after the comment,
 655                 # add a separator where needed and format the comment itself with CSS
 656                 while (preg_match('/(.*)\/\*\s*(.*?)\s*\*\/(.*)/', $comment,$match)) {
 657                         $pre=$match[1];
 658                         $auto=$match[2];
 659                         $post=$match[3];
 660                         $link='';
 661                         if($title) {
 662                                 $section=$auto;
 663
 664                                 # This is hackish but should work in most cases.
 665                                 $section=str_replace('[[','',$section);
 666                                 $section=str_replace(']]','',$section);
 667                                 $title->mFragment=$section;
 668                                 $link=$this->makeKnownLinkObj($title,wfMsg('sectionlink'));
 669                         }
 670                         $sep='-';
 671                         $auto=$link.$auto;
 672                         if($pre) { $auto = $sep.' '.$auto; }
 673                         if($post) { $auto .= ' '.$sep; }
 674                         $auto='<span class="autocomment">'.$auto.'</span>';
 675                         $comment=$pre.$auto.$post;
 676                 }
 677
 678                 # format regular and media links - all other wiki formatting
 679                 # is ignored
 680                 $medians = $wgContLang->getNsText( NS_MEDIA ) . ':';
 681                 while(preg_match('/\[\[(.*?)(\|(.*?))*\]\](.*)$/',$comment,$match)) {
 682                         # Handle link renaming [[foo|text]] will show link as "text"
 683                         if( "" != $match[3] ) {
 684                                 $text = $match[3];
 685                         } else {
 686                                 $text = $match[1];
 687                         }
 688                         if( preg_match( '/^' . $medians . '(.*)$/i', $match[1], $submatch ) ) {
 689                                 # Media link; trail not supported.
 690                                 $linkRegexp = '/\[\[(.*?)\]\]/';
 691                                 $thelink = $this->makeMediaLink( $submatch[1], "", $text );
 692                         } else {
 693                                 # Other kind of link
 694                                 if( preg_match( wfMsgForContent( "linktrail" ), $match[4], $submatch ) ) {
 695                                         $trail = $submatch[1];
 696                                 } else {
 697                                         $trail = "";
 698                                 }
 699                                 $linkRegexp = '/\[\[(.*?)\]\]' . preg_quote( $trail, '/' ) . '/';
 700                                 if ($match[1][0] == ':')
 701                                         $match[1] = substr($match[1], 1);
 702                                 $thelink = $this->makeLink( $match[1], $text, "", $trail );
 703                         }
 704                         $comment = preg_replace( $linkRegexp, $thelink, $comment, 1 );
 705                 }
 706                 wfProfileOut( $fname );
 707                 return $comment;
 708         }
 709
 710         /**
 711          * Wrap a comment in standard punctuation and formatting if
 712          * it's non-empty, otherwise return empty string.
 713          *
 714          * @param string $comment
 715          * @param Title $title
 716          * @return string
 717          * @access public
 718          */
 719         function commentBlock( $comment, $title = NULL ) {
 720                 if( $comment == '' || $comment == '*' ) {
 721                         return '';
 722                 } else {
 723                         $formatted = $this->formatComment( $comment, $title );
 724                         return " <span class='comment'>($formatted)</span>";
 725                 }
 726         }
 727
 728         /** @todo document */
 729         function tocIndent() {
 730                 return "\n<ul>";
 731         }
 732
 733         /** @todo document */
 734         function tocUnindent($level) {
 735                 return "</li>\n" . str_repeat( "</ul>\n</li>\n", $level>0 ? $level : 0 );
 736         }
 737
 738         /**
 739          * parameter level defines if we are on an indentation level
 740          */
 741         function tocLine( $anchor, $tocline, $tocnumber, $level ) {
 742                 return "\n<li class='toclevel-$level'><a href=\"#" .
 743                         $anchor . '"><span class="tocnumber">' .
 744                         $tocnumber . '</span> <span class="toctext">' .
 745                         $tocline . '</span></a>';
 746         }
 747
 748         /** @todo document */
 749         function tocLineEnd() {
 750                 return "</li>\n";
 751         }
 752
 753         /** @todo document */
 754         function tocList($toc) {
 755                 global $wgJsMimeType;
 756                 return "<table id='toc' class='toc'><tr><td>"
 757                            . "<div id='toctitle'><h2>" . wfMsgForContent('toc') . "</h2></div>\n"
 758                      . $toc
 759                                  . "</ul>\n</td></tr></table>\n"
 760                                  . '<script type="'.$wgJsMimeType.'">'
 761                                  . ' if (window.showTocToggle) {'
 762                                  . ' var tocShowText = "' . wfEscapeJsString( wfMsgForContent('showtoc') ) . '";'
 763                                  . ' var tocHideText = "' . wfEscapeJsString( wfMsgForContent('hidetoc') ) . '";'
 764                                  . ' showTocToggle();'
 765                                  . ' } '
 766                                  . "</script>\n";
 767         }
 768
 769         /** @todo document */
 770         function editSectionLinkForOther( $title, $section ) {
 771                 global $wgRequest;
 772                 global $wgContLang;
 773
 774                 $title = Title::newFromText($title);
 775                 $editurl = '&section='.$section;
 776                 $url = $this->makeKnownLink($title->getPrefixedText(),wfMsg('editsection'),'action=edit'.$editurl);
 777
 778                 if( $wgContLang->isRTL() ) {
 779                         $farside = 'left';
 780                         $nearside = 'right';
 781                 } else {
 782                         $farside = 'right';
 783                         $nearside = 'left';
 784                 }
 785                 return "<div class=\"editsection\" style=\"float:$farside;margin-$nearside:5px;\">[".$url."]</div>";
 786
 787         }
 788
 789         /** @todo document */
 790         function editSectionLink( $nt, $section ) {
 791                 global $wgRequest;
 792                 global $wgContLang;
 793
 794                 if( $wgRequest->getInt( 'oldid' ) && ( $wgRequest->getVal( 'diff' ) != '0' ) ) {
 795                         # Section edit links would be out of sync on an old page.
 796                         # But, if we're diffing to the current page, they'll be
 797                         # correct.
 798                         return '';
 799                 }
 800
 801                 $editurl = '&section='.$section;
 802                 $url = $this->makeKnownLink($nt->getPrefixedText(),wfMsg('editsection'),'action=edit'.$editurl);
 803
 804                 if( $wgContLang->isRTL() ) {
 805                         $farside = 'left';
 806                         $nearside = 'right';
 807                 } else {
 808                         $farside = 'right';
 809                         $nearside = 'left';
 810                 }
 811                 return "<div class=\"editsection\" style=\"float:$farside;margin-$nearside:5px;\">[".$url."]</div>";
 812         }
 813
 814         /**
 815          * Split a link trail, return the "inside" portion and the remainder of the trail
 816          * as a two-element array
 817          *
 818          * @static
 819          */
 820         function splitTrail( $trail ) {
 821                 static $regex = false;
 822                 if ( $regex === false ) {
 823                         global $wgContLang;
 824                         $regex = $wgContLang->linkTrail();
 825                 }
 826                 $inside = '';
 827                 if ( '' != $trail ) {
 828                         if ( preg_match( $regex, $trail, $m ) ) {
 829                                 $inside = $m[1];
 830                                 $trail = $m[2];
 831                         }
 832                 }
 833                 return array( $inside, $trail );
 834         }
 835
 836 }
 837 ?>