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          * @deprecated
  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 $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          * @param object Title of target page
 225          * @param string Text to replace the title
 226          * @param string Link target
 227          * @param string Text after link
 228          * @param string Text before link text
 229          * @param string Extra attributes to the a-element
 230          * @return the a-element
 231          */
 232         function makeKnownLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' , $aprops = '' ) {
 233
 234                 $fname = 'Linker::makeKnownLinkObj';
 235                 wfProfileIn( $fname );
 236
 237                 if ( !is_object( $nt ) ) {
 238                         wfProfileOut( $fname );
 239                         return $text;
 240                 }
 241
 242                 $u = $nt->escapeLocalURL( $query );
 243                 if ( '' != $nt->getFragment() ) {
 244                         if( $nt->getPrefixedDbkey() == '' ) {
 245                                 $u = '';
 246                                 if ( '' == $text ) {
 247                                         $text = htmlspecialchars( $nt->getFragment() );
 248                                 }
 249                         }
 250                         $anchor = urlencode( Sanitizer::decodeCharReferences( str_replace( ' ', '_', $nt->getFragment() ) ) );
 251                         $replacearray = array(
 252                                 '%3A' => ':',
 253                                 '%' => '.'
 254                         );
 255                         $u .= '#' . str_replace(array_keys($replacearray),array_values($replacearray),$anchor);
 256                 }
 257                 if ( '' == $text ) {
 258                         $text = htmlspecialchars( $nt->getPrefixedText() );
 259                 }
 260                 $style = $this->getInternalLinkAttributesObj( $nt, $text );
 261
 262                 if ( $aprops !== '' ) $aprops = ' ' . $aprops;
 263
 264                 list( $inside, $trail ) = Linker::splitTrail( $trail );
 265                 $r = "<a href=\"{$u}\"{$style}{$aprops}>{$prefix}{$text}{$inside}</a>{$trail}";
 266                 wfProfileOut( $fname );
 267                 return $r;
 268         }
 269
 270         /**
 271          * Pass a title object, not a title string
 272          */
 273         function makeBrokenLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
 274                 # Fail gracefully
 275                 if ( ! isset($nt) ) {
 276                         # wfDebugDieBacktrace();
 277                         return "<!-- ERROR -->{$prefix}{$text}{$trail}";
 278                 }
 279
 280                 $fname = 'Linker::makeBrokenLinkObj';
 281                 wfProfileIn( $fname );
 282
 283                 if ( '' == $query ) {
 284                         $q = 'action=edit';
 285                 } else {
 286                         $q = 'action=edit&'.$query;
 287                 }
 288                 $u = $nt->escapeLocalURL( $q );
 289
 290                 if ( '' == $text ) {
 291                         $text = htmlspecialchars( $nt->getPrefixedText() );
 292                 }
 293                 $style = $this->getInternalLinkAttributesObj( $nt, $text, "yes" );
 294
 295                 list( $inside, $trail ) = Linker::splitTrail( $trail );
 296                 $s = "<a href=\"{$u}\"{$style}>{$prefix}{$text}{$inside}</a>{$trail}";
 297
 298                 wfProfileOut( $fname );
 299                 return $s;
 300         }
 301
 302         /**
 303          * Pass a title object, not a title string
 304          */
 305         function makeStubLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
 306                 $link = $nt->getPrefixedURL();
 307
 308                 $u = $nt->escapeLocalURL( $query );
 309
 310                 if ( '' == $text ) {
 311                         $text = htmlspecialchars( $nt->getPrefixedText() );
 312                 }
 313                 $style = $this->getInternalLinkAttributesObj( $nt, $text, 'stub' );
 314
 315                 list( $inside, $trail ) = Linker::splitTrail( $trail );
 316                 $s = "<a href=\"{$u}\"{$style}>{$prefix}{$text}{$inside}</a>{$trail}";
 317                 return $s;
 318         }
 319
 320         /**
 321          * Generate either a normal exists-style link or a stub link, depending
 322          * on the given page size.
 323          *
 324          * @param int $size
 325          * @param Title $nt
 326          * @param string $text
 327          * @param string $query
 328          * @param string $trail
 329          * @param string $prefix
 330          * @return string HTML of link
 331          */
 332         function makeSizeLinkObj( $size, $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
 333                 global $wgUser;
 334                 $threshold = intval( $wgUser->getOption( 'stubthreshold' ) );
 335                 if( $size < $threshold ) {
 336                         return $this->makeStubLinkObj( $nt, $text, $query, $trail, $prefix );
 337                 } else {
 338                         return $this->makeKnownLinkObj( $nt, $text, $query, $trail, $prefix );
 339                 }
 340         }
 341
 342         /** @todo document */
 343         function makeSelfLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
 344                 $u = $nt->escapeLocalURL( $query );
 345                 if ( '' == $text ) {
 346                         $text = htmlspecialchars( $nt->getPrefixedText() );
 347                 }
 348                 list( $inside, $trail ) = Linker::splitTrail( $trail );
 349                 return "<strong>{$prefix}{$text}{$inside}</strong>{$trail}";
 350         }
 351
 352         /** @todo document */
 353         function fnamePart( $url ) {
 354                 $basename = strrchr( $url, '/' );
 355                 if ( false === $basename ) {
 356                         $basename = $url;
 357                 } else {
 358                         $basename = substr( $basename, 1 );
 359                 }
 360                 return htmlspecialchars( $basename );
 361         }
 362
 363         /** Obsolete alias */
 364         function makeImage( $url, $alt = '' ) {
 365                 return $this->makeExternalImage( $url, $alt );
 366         }
 367
 368         /** @todo document */
 369         function makeExternalImage( $url, $alt = '' ) {
 370                 if ( '' == $alt ) {
 371                         $alt = $this->fnamePart( $url );
 372                 }
 373                 $s = '<img src="'.$url.'" alt="'.$alt.'" />';
 374                 return $s;
 375         }
 376
 377         /** @todo document */
 378         function makeImageLinkObj( $nt, $label, $alt, $align = '', $width = false, $height = false, $framed = false,
 379           $thumb = false, $manual_thumb = '' )
 380         {
 381                 global $wgContLang, $wgUser, $wgThumbLimits;
 382
 383                 $img   = new Image( $nt );
 384                 $url   = $img->getViewURL();
 385                 $prefix = $postfix = '';
 386
 387                 wfDebug( "makeImageLinkObj: '$width'x'$height'\n" );
 388
 389                 if ( 'center' == $align )
 390                 {
 391                         $prefix  = '<div class="center">';
 392                         $postfix = '</div>';
 393                         $align   = 'none';
 394                 }
 395
 396                 if ( $thumb || $framed ) {
 397
 398                         # Create a thumbnail. Alignment depends on language
 399                         # writing direction, # right aligned for left-to-right-
 400                         # languages ("Western languages"), left-aligned
 401                         # for right-to-left-languages ("Semitic languages")
 402                         #
 403                         # If  thumbnail width has not been provided, it is set
 404                         # to the default user option as specified in Language*.php
 405                         if ( $align == '' ) {
 406                                 $align = $wgContLang->isRTL() ? 'left' : 'right';
 407                         }
 408
 409
 410                         if ( $width === false ) {
 411                                 $wopt = $wgUser->getOption( 'thumbsize' );
 412
 413                                 if( !isset( $wgThumbLimits[$wopt] ) ) {
 414                                          $wopt = User::getDefaultOption( 'thumbsize' );
 415                                 }
 416
 417                                 $width = min( $img->getWidth(), $wgThumbLimits[$wopt] );
 418                         }
 419
 420                         return $prefix.$this->makeThumbLinkObj( $img, $label, $alt, $align, $width, $height, $framed, $manual_thumb ).$postfix;
 421                 }
 422
 423                 if ( $width && $img->exists() ) {
 424
 425                         # Create a resized image, without the additional thumbnail
 426                         # features
 427
 428                         if ( $height == false )
 429                                 $height = -1;
 430                         if ( $manual_thumb == '') {
 431                                 $thumb = $img->getThumbnail( $width, $height );
 432                                 if ( $thumb ) {
 433                                         if( $width > $img->width && ( $height == -1 || $height > $img->height )) {
 434                                                 // Requested a display size larger than the actual image;
 435                                                 // fake it up!
 436                                                 $height = round($thumb->height * $width / $thumb->width);
 437                                                 wfDebug( "makeImageLinkObj: client-size height set to '$height'\n" );
 438                                         } else {
 439                                                 $width = $thumb->width;
 440                                                 $height = $thumb->height;
 441                                                 wfDebug( "makeImageLinkObj: thumb height set to '$height'\n" );
 442                                         }
 443                                         $url = $thumb->getUrl();
 444                                 }
 445                         }
 446                 } else {
 447                         $width = $img->width;
 448                         $height = $img->height;
 449                 }
 450
 451                 wfDebug( "makeImageLinkObj2: '$width'x'$height'\n" );
 452                 $u = $nt->escapeLocalURL();
 453                 if ( $url == '' ) {
 454                         $s = $this->makeBrokenImageLinkObj( $img->getTitle() );
 455                         //$s .= "<br />{$alt}<br />{$url}<br />\n";
 456                 } else {
 457                         $s = '<a href="'.$u.'" class="image" title="'.$alt.'">' .
 458                                  '<img src="'.$url.'" alt="'.$alt.'" ' .
 459                                  ( $width
 460                                         ? ( 'width="'.$width.'" height="'.$height.'" ' )
 461                                         : '' ) .
 462                                  'longdesc="'.$u.'" /></a>';
 463                 }
 464                 if ( '' != $align ) {
 465                         $s = "<div class=\"float{$align}\"><span>{$s}</span></div>";
 466                 }
 467                 return str_replace("\n", ' ',$prefix.$s.$postfix);
 468         }
 469
 470         /**
 471          * Make HTML for a thumbnail including image, border and caption
 472          * $img is an Image object
 473          */
 474         function makeThumbLinkObj( $img, $label = '', $alt, $align = 'right', $boxwidth = 180, $boxheight=false, $framed=false , $manual_thumb = "" ) {
 475                 global $wgStylePath, $wgContLang;
 476                 $url  = $img->getViewURL();
 477
 478                 $width = $height = 0;
 479                 if ( $img->exists() )
 480                 {
 481                         $width  = $img->getWidth();
 482                         $height = $img->getHeight();
 483                 }
 484                 if ( 0 == $width || 0 == $height )
 485                 {
 486                         $width = $height = 200;
 487                 }
 488                 if ( $boxwidth == 0 )
 489                 {
 490                         $boxwidth = 200;
 491                 }
 492                 if ( $framed )
 493                 {
 494                         // Use image dimensions, don't scale
 495                         $boxwidth  = $width;
 496                         $boxheight = $height;
 497                         $thumbUrl  = $url;
 498                 } else {
 499                         if ( $boxheight === false )
 500                                 $boxheight = -1;
 501                         if ( '' == $manual_thumb ) {
 502                                 $thumb = $img->getThumbnail( $boxwidth, $boxheight );
 503                                 $thumbUrl = $thumb->getUrl();
 504                                 $boxwidth = $thumb->width;
 505                                 $boxheight = $thumb->height;
 506                         }
 507                 }
 508                 $oboxwidth = $boxwidth + 2;
 509
 510                 if ( $manual_thumb != '' ) # Use manually specified thumbnail
 511                 {
 512                         $manual_title = Title::makeTitleSafe( NS_IMAGE, $manual_thumb ); #new Title ( $manual_thumb ) ;
 513                         $manual_img = new Image( $manual_title );
 514                         $thumbUrl = $manual_img->getViewURL();
 515                         if ( $manual_img->exists() )
 516                         {
 517                                 $width  = $manual_img->getWidth();
 518                                 $height = $manual_img->getHeight();
 519                                 $boxwidth = $width ;
 520                                 $boxheight = $height ;
 521                                 $oboxwidth = $boxwidth + 2 ;
 522                         }
 523                 }
 524
 525                 $u = $img->getEscapeLocalURL();
 526
 527                 $more = htmlspecialchars( wfMsg( 'thumbnail-more' ) );
 528                 $magnifyalign = $wgContLang->isRTL() ? 'left' : 'right';
 529                 $textalign = $wgContLang->isRTL() ? ' style="text-align:right"' : '';
 530
 531                 $s = "<div class=\"thumb t{$align}\"><div style=\"width:{$oboxwidth}px;\">";
 532                 if( $thumbUrl == '' ) {
 533                         // Couldn't generate thumbnail? Scale the image client-side.
 534                         $thumbUrl = $url;
 535                 }
 536                 if( !$img->exists() ) {
 537                         $s .= $this->makeBrokenImageLinkObj( $img->getTitle() );
 538                         $zoomicon = '';
 539                 } else {
 540                         $s .= '<a href="'.$u.'" class="internal" title="'.$alt.'">'.
 541                                 '<img src="'.$thumbUrl.'" alt="'.$alt.'" ' .
 542                                 'width="'.$boxwidth.'" height="'.$boxheight.'" ' .
 543                                 'longdesc="'.$u.'" /></a>';
 544                         if ( $framed ) {
 545                                 $zoomicon="";
 546                         } else {
 547                                 $zoomicon =  '<div class="magnify" style="float:'.$magnifyalign.'">'.
 548                                         '<a href="'.$u.'" class="internal" title="'.$more.'">'.
 549                                         '<img src="'.$wgStylePath.'/common/images/magnify-clip.png" ' .
 550                                         'width="15" height="11" alt="'.$more.'" /></a></div>';
 551                         }
 552                 }
 553                 $s .= '  <div class="thumbcaption" '.$textalign.'>'.$zoomicon.$label."</div></div></div>";
 554                 return str_replace("\n", ' ', $s);
 555         }
 556
 557         /**
 558          * Pass a title object, not a title string
 559          */
 560         function makeBrokenImageLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
 561                 # Fail gracefully
 562                 if ( ! isset($nt) ) {
 563                         # wfDebugDieBacktrace();
 564                         return "<!-- ERROR -->{$prefix}{$text}{$trail}";
 565                 }
 566
 567                 $fname = 'Linker::makeBrokenImageLinkObj';
 568                 wfProfileIn( $fname );
 569
 570                 $q = 'wpDestFile=' . urlencode( $nt->getDBkey() );
 571                 if ( '' != $query ) {
 572                         $q .= "&$query";
 573                 }
 574                 $uploadTitle = Title::makeTitle( NS_SPECIAL, 'Upload' );
 575                 $url = $uploadTitle->escapeLocalURL( $q );
 576
 577                 if ( '' == $text ) {
 578                         $text = htmlspecialchars( $nt->getPrefixedText() );
 579                 }
 580                 $style = $this->getInternalLinkAttributesObj( $nt, $text, "yes" );
 581                 list( $inside, $trail ) = Linker::splitTrail( $trail );
 582                 $s = "<a href=\"{$url}\"{$style}>{$prefix}{$text}{$inside}</a>{$trail}";
 583
 584                 wfProfileOut( $fname );
 585                 return $s;
 586         }
 587
 588         /** @todo document */
 589         function makeMediaLink( $name, /* wtf?! */ $url, $alt = '' ) {
 590                 $nt = Title::makeTitleSafe( NS_IMAGE, $name );
 591                 return $this->makeMediaLinkObj( $nt, $alt );
 592         }
 593
 594         /**
 595          * Create a direct link to a given uploaded file.
 596          *
 597          * @param Title  $title
 598          * @param string $text   pre-sanitized HTML
 599          * @param bool   $nourl  Mask absolute URLs, so the parser doesn't
 600          *                       linkify them (it is currently not context-aware)
 601          * @return string HTML
 602          *
 603          * @access public
 604          * @todo Handle invalid or missing images better.
 605          */
 606         function makeMediaLinkObj( $title, $text = '', $nourl=false ) {
 607                 if( is_null( $title ) ) {
 608                         ### HOTFIX. Instead of breaking, return empty string.
 609                         return $text;
 610                 } else {
 611                         $name = $title->getDBKey();
 612                         $img  = new Image( $title );
 613                         if( $img->exists() ) {
 614                                 $url  = $img->getURL();
 615                                 if( $nourl ) {
 616                                         $url = str_replace( "http://", UNIQ_PREFIX . "NOPARSEhttp://", $url );
 617                                 }
 618                                 $class = 'internal';
 619                         } else {
 620                                 $upload = Title::makeTitle( NS_SPECIAL, 'Upload' );
 621                                 $url = $upload->getLocalUrl( 'wpDestFile=' . urlencode( $img->getName() ) );
 622                                 $class = 'new';
 623                         }
 624                         $alt = htmlspecialchars( $title->getText() );
 625                         if( $text == '' ) {
 626                                 $text = $alt;
 627                         }
 628                         $u = htmlspecialchars( $url );
 629                         return "<a href=\"{$u}\" class='$class' title=\"{$alt}\">{$text}</a>";
 630                 }
 631         }
 632
 633         /** @todo document */
 634         function specialLink( $name, $key = '' ) {
 635                 global $wgContLang;
 636
 637                 if ( '' == $key ) { $key = strtolower( $name ); }
 638                 $pn = $wgContLang->ucfirst( $name );
 639                 return $this->makeKnownLink( $wgContLang->specialPage( $pn ),
 640                   wfMsg( $key ) );
 641         }
 642
 643         /** @todo document */
 644         function makeExternalLink( $url, $text, $escape = true, $linktype = '' ) {
 645                 $style = $this->getExternalLinkAttributes( $url, $text, 'external ' . $linktype );
 646                 global $wgNoFollowLinks;
 647                 if( $wgNoFollowLinks ) {
 648                         $style .= ' rel="nofollow"';
 649                 }
 650                 $url = htmlspecialchars( $url );
 651                 if( $escape ) {
 652                         $text = htmlspecialchars( $text );
 653                 }
 654                 return '<a href="'.$url.'"'.$style.'>'.$text.'</a>';
 655         }
 656
 657         /**
 658          * This function is called by all recent changes variants, by the page history,
 659          * and by the user contributions list. It is responsible for formatting edit
 660          * comments. It escapes any HTML in the comment, but adds some CSS to format
 661          * auto-generated comments (from section editing) and formats [[wikilinks]].
 662          *
 663          * The &$title parameter must be a title OBJECT. It is used to generate a
 664          * direct link to the section in the autocomment.
 665          * @author Erik Moeller <moeller@scireview.de>
 666          *
 667          * Note: there's not always a title to pass to this function.
 668          * Since you can't set a default parameter for a reference, I've turned it
 669          * temporarily to a value pass. Should be adjusted further. --brion
 670          */
 671         function formatComment($comment, $title = NULL) {
 672                 $fname = 'Linker::formatComment';
 673                 wfProfileIn( $fname );
 674
 675                 global $wgContLang;
 676                 $comment = str_replace( "\n", " ", $comment );
 677                 $comment = htmlspecialchars( $comment );
 678
 679                 # The pattern for autogen comments is / * foo * /, which makes for
 680                 # some nasty regex.
 681                 # We look for all comments, match any text before and after the comment,
 682                 # add a separator where needed and format the comment itself with CSS
 683                 while (preg_match('/(.*)\/\*\s*(.*?)\s*\*\/(.*)/', $comment,$match)) {
 684                         $pre=$match[1];
 685                         $auto=$match[2];
 686                         $post=$match[3];
 687                         $link='';
 688                         if($title) {
 689                                 $section=$auto;
 690
 691                                 # This is hackish but should work in most cases.
 692                                 $section=str_replace('[[','',$section);
 693                                 $section=str_replace(']]','',$section);
 694                                 $title->mFragment=$section;
 695                                 $link=$this->makeKnownLinkObj($title,wfMsg('sectionlink'));
 696                         }
 697                         $sep='-';
 698                         $auto=$link.$auto;
 699                         if($pre) { $auto = $sep.' '.$auto; }
 700                         if($post) { $auto .= ' '.$sep; }
 701                         $auto='<span class="autocomment">'.$auto.'</span>';
 702                         $comment=$pre.$auto.$post;
 703                 }
 704
 705                 # format regular and media links - all other wiki formatting
 706                 # is ignored
 707                 $medians = $wgContLang->getNsText( NS_MEDIA ) . ':';
 708                 while(preg_match('/\[\[(.*?)(\|(.*?))*\]\](.*)$/',$comment,$match)) {
 709                         # Handle link renaming [[foo|text]] will show link as "text"
 710                         if( "" != $match[3] ) {
 711                                 $text = $match[3];
 712                         } else {
 713                                 $text = $match[1];
 714                         }
 715                         if( preg_match( '/^' . $medians . '(.*)$/i', $match[1], $submatch ) ) {
 716                                 # Media link; trail not supported.
 717                                 $linkRegexp = '/\[\[(.*?)\]\]/';
 718                                 $thelink = $this->makeMediaLink( $submatch[1], "", $text );
 719                         } else {
 720                                 # Other kind of link
 721                                 if( preg_match( $wgContLang->linkTrail(), $match[4], $submatch ) ) {
 722                                         $trail = $submatch[1];
 723                                 } else {
 724                                         $trail = "";
 725                                 }
 726                                 $linkRegexp = '/\[\[(.*?)\]\]' . preg_quote( $trail, '/' ) . '/';
 727                                 if ($match[1][0] == ':')
 728                                         $match[1] = substr($match[1], 1);
 729                                 $thelink = $this->makeLink( $match[1], $text, "", $trail );
 730                         }
 731                         # Quote backreferences, then run preg_replace
 732                         $thelink = strtr( $thelink, array( "\\" => "\\\\", '$' => "\\$" ) );
 733                         $comment = preg_replace( $linkRegexp, $thelink, $comment, 1 );
 734                 }
 735                 wfProfileOut( $fname );
 736                 return $comment;
 737         }
 738
 739         /**
 740          * Wrap a comment in standard punctuation and formatting if
 741          * it's non-empty, otherwise return empty string.
 742          *
 743          * @param string $comment
 744          * @param Title $title
 745          * @return string
 746          * @access public
 747          */
 748         function commentBlock( $comment, $title = NULL ) {
 749                 if( $comment == '' || $comment == '*' ) {
 750                         return '';
 751                 } else {
 752                         $formatted = $this->formatComment( $comment, $title );
 753                         return " <span class='comment'>($formatted)</span>";
 754                 }
 755         }
 756
 757         /** @todo document */
 758         function tocIndent() {
 759                 return "\n<ul>";
 760         }
 761
 762         /** @todo document */
 763         function tocUnindent($level) {
 764                 return "</li>\n" . str_repeat( "</ul>\n</li>\n", $level>0 ? $level : 0 );
 765         }
 766
 767         /**
 768          * parameter level defines if we are on an indentation level
 769          */
 770         function tocLine( $anchor, $tocline, $tocnumber, $level ) {
 771                 return "\n<li class='toclevel-$level'><a href=\"#" .
 772                         $anchor . '"><span class="tocnumber">' .
 773                         $tocnumber . '</span> <span class="toctext">' .
 774                         $tocline . '</span></a>';
 775         }
 776
 777         /** @todo document */
 778         function tocLineEnd() {
 779                 return "</li>\n";
 780         }
 781
 782         /** @todo document */
 783         function tocList($toc) {
 784                 global $wgJsMimeType;
 785                 $title =  wfMsgForContent('toc') ;
 786                 return
 787                    '<table id="toc" class="toc" summary="' . $title .'"><tr><td>'
 788                  . '<div id="toctitle"><h2>' . $title . "</h2></div>\n"
 789                  . $toc
 790                  . "</ul>\n</td></tr></table>\n"
 791                  . '<script type="' . $wgJsMimeType . '">'
 792                  . ' if (window.showTocToggle) {'
 793                  . ' var tocShowText = "' . wfEscapeJsString( wfMsgForContent('showtoc') ) . '";'
 794                  . ' var tocHideText = "' . wfEscapeJsString( wfMsgForContent('hidetoc') ) . '";'
 795                  . ' showTocToggle();'
 796                  . ' } '
 797                  . "</script>\n";
 798         }
 799
 800         /** @todo document */
 801         function editSectionLinkForOther( $title, $section ) {
 802                 global $wgContLang;
 803
 804                 $title = Title::newFromText($title);
 805                 $editurl = '&section='.$section;
 806                 $url = $this->makeKnownLink($title->getPrefixedText(),wfMsg('editsection'),'action=edit'.$editurl);
 807
 808                 if( $wgContLang->isRTL() ) {
 809                         $farside = 'left';
 810                         $nearside = 'right';
 811                 } else {
 812                         $farside = 'right';
 813                         $nearside = 'left';
 814                 }
 815                 return "<div class=\"editsection\" style=\"float:$farside;margin-$nearside:5px;\">[".$url."]</div>";
 816
 817         }
 818
 819         /** @todo document */
 820         function editSectionLink( $nt, $section ) {
 821                 global $wgContLang;
 822
 823                 $editurl = '&section='.$section;
 824                 $url = $this->makeKnownLink($nt->getPrefixedText(),wfMsg('editsection'),'action=edit'.$editurl);
 825
 826                 if( $wgContLang->isRTL() ) {
 827                         $farside = 'left';
 828                         $nearside = 'right';
 829                 } else {
 830                         $farside = 'right';
 831                         $nearside = 'left';
 832                 }
 833                 return "<div class=\"editsection\" style=\"float:$farside;margin-$nearside:5px;\">[".$url."]</div>";
 834         }
 835
 836         /**
 837          * Split a link trail, return the "inside" portion and the remainder of the trail
 838          * as a two-element array
 839          *
 840          * @static
 841          */
 842         function splitTrail( $trail ) {
 843                 static $regex = false;
 844                 if ( $regex === false ) {
 845                         global $wgContLang;
 846                         $regex = $wgContLang->linkTrail();
 847                 }
 848                 $inside = '';
 849                 if ( '' != $trail ) {
 850                         if ( preg_match( $regex, $trail, $m ) ) {
 851                                 $inside = $m[1];
 852                                 $trail = $m[2];
 853                         }
 854                 }
 855                 return array( $inside, $trail );
 856         }
 857
 858 }
 859 ?>