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