includes/parser/LinkHolderArray.php

   1 <?php
   2 /**
   3  * Holder of replacement pairs for wiki links
   4  *
   5  * @file
   6  */
   7
   8 /**
   9  * @ingroup Parser
  10  */
  11 class LinkHolderArray {
  12         var $internals = array(), $interwikis = array();
  13         var $size = 0;
  14         var $parent;
  15         protected $tempIdOffset;
  16
  17         function __construct( $parent ) {
  18                 $this->parent = $parent;
  19         }
  20
  21         /**
  22          * Reduce memory usage to reduce the impact of circular references
  23          */
  24         function __destruct() {
  25                 foreach ( $this as $name => $value ) {
  26                         unset( $this->$name );
  27                 }
  28         }
  29
  30         /**
  31          * Don't serialize the parent object, it is big, and not needed when it is
  32          * a parameter to mergeForeign(), which is the only application of
  33          * serializing at present.
  34          *
  35          * Compact the titles, only serialize the text form.
  36          */
  37         function __sleep() {
  38                 foreach ( $this->internals as &$nsLinks ) {
  39                         foreach ( $nsLinks as &$entry ) {
  40                                 unset( $entry['title'] );
  41                         }
  42                 }
  43                 unset( $nsLinks );
  44                 unset( $entry );
  45
  46                 foreach ( $this->interwikis as &$entry ) {
  47                         unset( $entry['title'] );
  48                 }
  49                 unset( $entry );
  50
  51                 return array( 'internals', 'interwikis', 'size' );
  52         }
  53
  54         /**
  55          * Recreate the Title objects
  56          */
  57         function __wakeup() {
  58                 foreach ( $this->internals as &$nsLinks ) {
  59                         foreach ( $nsLinks as &$entry ) {
  60                                 $entry['title'] = Title::newFromText( $entry['pdbk'] );
  61                         }
  62                 }
  63                 unset( $nsLinks );
  64                 unset( $entry );
  65
  66                 foreach ( $this->interwikis as &$entry ) {
  67                         $entry['title'] = Title::newFromText( $entry['pdbk'] );
  68                 }
  69                 unset( $entry );
  70         }
  71
  72         /**
  73          * Merge another LinkHolderArray into this one
  74          * @param $other LinkHolderArray
  75          */
  76         function merge( $other ) {
  77                 foreach ( $other->internals as $ns => $entries ) {
  78                         $this->size += count( $entries );
  79                         if ( !isset( $this->internals[$ns] ) ) {
  80                                 $this->internals[$ns] = $entries;
  81                         } else {
  82                                 $this->internals[$ns] += $entries;
  83                         }
  84                 }
  85                 $this->interwikis += $other->interwikis;
  86         }
  87
  88         /**
  89          * Merge a LinkHolderArray from another parser instance into this one. The
  90          * keys will not be preserved. Any text which went with the old
  91          * LinkHolderArray and needs to work with the new one should be passed in
  92          * the $texts array. The strings in this array will have their link holders
  93          * converted for use in the destination link holder. The resulting array of
  94          * strings will be returned.
  95          *
  96          * @param $other LinkHolderArray
  97          * @param $texts Array of strings
  98          * @return Array
  99          */
 100         function mergeForeign( $other, $texts ) {
 101                 $this->tempIdOffset = $idOffset = $this->parent->nextLinkID();
 102                 $maxId = 0;
 103
 104                 # Renumber internal links
 105                 foreach ( $other->internals as $ns => $nsLinks ) {
 106                         foreach ( $nsLinks as $key => $entry ) {
 107                                 $newKey = $idOffset + $key;
 108                                 $this->internals[$ns][$newKey] = $entry;
 109                                 $maxId = $newKey > $maxId ? $newKey : $maxId;
 110                         }
 111                 }
 112                 $texts = preg_replace_callback( '/(<!--LINK \d+:)(\d+)(-->)/',
 113                         array( $this, 'mergeForeignCallback' ), $texts );
 114
 115                 # Renumber interwiki links
 116                 foreach ( $other->interwikis as $key => $entry ) {
 117                         $newKey = $idOffset + $key;
 118                         $this->interwikis[$newKey] = $entry;
 119                         $maxId = $newKey > $maxId ? $newKey : $maxId;
 120                 }
 121                 $texts = preg_replace_callback( '/(<!--IWLINK )(\d+)(-->)/',
 122                         array( $this, 'mergeForeignCallback' ), $texts );
 123
 124                 # Set the parent link ID to be beyond the highest used ID
 125                 $this->parent->setLinkID( $maxId + 1 );
 126                 $this->tempIdOffset = null;
 127                 return $texts;
 128         }
 129
 130         protected function mergeForeignCallback( $m ) {
 131                 return $m[1] . ( $m[2] + $this->tempIdOffset ) . $m[3];
 132         }
 133
 134         /**
 135          * Get a subset of the current LinkHolderArray which is sufficient to
 136          * interpret the given text.
 137          */
 138         function getSubArray( $text ) {
 139                 $sub = new LinkHolderArray( $this->parent );
 140
 141                 # Internal links
 142                 $pos = 0;
 143                 while ( $pos < strlen( $text ) ) {
 144                         if ( !preg_match( '/<!--LINK (\d+):(\d+)-->/',
 145                                 $text, $m, PREG_OFFSET_CAPTURE, $pos ) )
 146                         {
 147                                 break;
 148                         }
 149                         $ns = $m[1][0];
 150                         $key = $m[2][0];
 151                         $sub->internals[$ns][$key] = $this->internals[$ns][$key];
 152                         $pos = $m[0][1] + strlen( $m[0][0] );
 153                 }
 154
 155                 # Interwiki links
 156                 $pos = 0;
 157                 while ( $pos < strlen( $text ) ) {
 158                         if ( !preg_match( '/<!--IWLINK (\d+)-->/', $text, $m, PREG_OFFSET_CAPTURE, $pos ) ) {
 159                                 break;
 160                         }
 161                         $key = $m[1][0];
 162                         $sub->interwikis[$key] = $this->interwikis[$key];
 163                         $pos = $m[0][1] + strlen( $m[0][0] );
 164                 }
 165                 return $sub;
 166         }
 167
 168         /**
 169          * Returns true if the memory requirements of this object are getting large
 170          */
 171         function isBig() {
 172                 global $wgLinkHolderBatchSize;
 173                 return $this->size > $wgLinkHolderBatchSize;
 174         }
 175
 176         /**
 177          * Clear all stored link holders.
 178          * Make sure you don't have any text left using these link holders, before you call this
 179          */
 180         function clear() {
 181                 $this->internals = array();
 182                 $this->interwikis = array();
 183                 $this->size = 0;
 184         }
 185
 186         /**
 187          * Make a link placeholder. The text returned can be later resolved to a real link with
 188          * replaceLinkHolders(). This is done for two reasons: firstly to avoid further
 189          * parsing of interwiki links, and secondly to allow all existence checks and
 190          * article length checks (for stub links) to be bundled into a single query.
 191          *
 192          * @param $nt Title
 193          */
 194         function makeHolder( $nt, $text = '', $query = array(), $trail = '', $prefix = ''  ) {
 195                 wfProfileIn( __METHOD__ );
 196                 if ( ! is_object($nt) ) {
 197                         # Fail gracefully
 198                         $retVal = "<!-- ERROR -->{$prefix}{$text}{$trail}";
 199                 } else {
 200                         # Separate the link trail from the rest of the link
 201                         list( $inside, $trail ) = Linker::splitTrail( $trail );
 202
 203                         $entry = array(
 204                                 'title' => $nt,
 205                                 'text' => $prefix.$text.$inside,
 206                                 'pdbk' => $nt->getPrefixedDBkey(),
 207                         );
 208                         if ( $query !== array() ) {
 209                                 $entry['query'] = $query;
 210                         }
 211
 212                         if ( $nt->isExternal() ) {
 213                                 // Use a globally unique ID to keep the objects mergable
 214                                 $key = $this->parent->nextLinkID();
 215                                 $this->interwikis[$key] = $entry;
 216                                 $retVal = "<!--IWLINK $key-->{$trail}";
 217                         } else {
 218                                 $key = $this->parent->nextLinkID();
 219                                 $ns = $nt->getNamespace();
 220                                 $this->internals[$ns][$key] = $entry;
 221                                 $retVal = "<!--LINK $ns:$key-->{$trail}";
 222                         }
 223                         $this->size++;
 224                 }
 225                 wfProfileOut( __METHOD__ );
 226                 return $retVal;
 227         }
 228
 229         /**
 230          * @todo FIXME: Update documentation. makeLinkObj() is deprecated.
 231          * Replace <!--LINK--> link placeholders with actual links, in the buffer
 232          * Placeholders created in Skin::makeLinkObj()
 233          * Returns an array of link CSS classes, indexed by PDBK.
 234          */
 235         function replace( &$text ) {
 236                 wfProfileIn( __METHOD__ );
 237
 238                 $colours = $this->replaceInternal( $text );
 239                 $this->replaceInterwiki( $text );
 240
 241                 wfProfileOut( __METHOD__ );
 242                 return $colours;
 243         }
 244
 245         /**
 246          * Replace internal links
 247          */
 248         protected function replaceInternal( &$text ) {
 249                 if ( !$this->internals ) {
 250                         return;
 251                 }
 252
 253                 wfProfileIn( __METHOD__ );
 254                 global $wgContLang;
 255
 256                 $colours = array();
 257                 $linkCache = LinkCache::singleton();
 258                 $output = $this->parent->getOutput();
 259
 260                 wfProfileIn( __METHOD__.'-check' );
 261                 $dbr = wfGetDB( DB_SLAVE );
 262                 $threshold = $this->parent->getOptions()->getStubThreshold();
 263
 264                 # Sort by namespace
 265                 ksort( $this->internals );
 266
 267                 $linkcolour_ids = array();
 268
 269                 # Generate query
 270                 $queries = array();
 271                 foreach ( $this->internals as $ns => $entries ) {
 272                         foreach ( $entries as $entry ) {
 273                                 $title = $entry['title'];
 274                                 $pdbk = $entry['pdbk'];
 275
 276                                 # Skip invalid entries.
 277                                 # Result will be ugly, but prevents crash.
 278                                 if ( is_null( $title ) ) {
 279                                         continue;
 280                                 }
 281
 282                                 # Check if it's a static known link, e.g. interwiki
 283                                 if ( $title->isAlwaysKnown() ) {
 284                                         $colours[$pdbk] = '';
 285                                 } elseif ( $ns == NS_SPECIAL ) {
 286                                         $colours[$pdbk] = 'new';
 287                                 } elseif ( ( $id = $linkCache->getGoodLinkID( $pdbk ) ) != 0 ) {
 288                                         $colours[$pdbk] = Linker::getLinkColour( $title, $threshold );
 289                                         $output->addLink( $title, $id );
 290                                         $linkcolour_ids[$id] = $pdbk;
 291                                 } elseif ( $linkCache->isBadLink( $pdbk ) ) {
 292                                         $colours[$pdbk] = 'new';
 293                                 } else {
 294                                         # Not in the link cache, add it to the query
 295                                         $queries[$ns][] = $title->getDBkey();
 296                                 }
 297                         }
 298                 }
 299                 if ( $queries ) {
 300                         $where = array();
 301                         foreach( $queries as $ns => $pages ){
 302                                 $where[] = $dbr->makeList(
 303                                         array(
 304                                                 'page_namespace' => $ns,
 305                                                 'page_title' => $pages,
 306                                         ),
 307                                         LIST_AND
 308                                 );
 309                         }
 310
 311                         $res = $dbr->select(
 312                                 'page',
 313                                 array( 'page_id', 'page_namespace', 'page_title', 'page_is_redirect', 'page_len', 'page_latest' ),
 314                                 $dbr->makeList( $where, LIST_OR ),
 315                                 __METHOD__
 316                         );
 317
 318                         # Fetch data and form into an associative array
 319                         # non-existent = broken
 320                         foreach ( $res as $s ) {
 321                                 $title = Title::makeTitle( $s->page_namespace, $s->page_title );
 322                                 $pdbk = $title->getPrefixedDBkey();
 323                                 $linkCache->addGoodLinkObjFromRow( $title, $s );
 324                                 $output->addLink( $title, $s->page_id );
 325                                 # @todo FIXME: Convoluted data flow
 326                                 # The redirect status and length is passed to getLinkColour via the LinkCache
 327                                 # Use formal parameters instead
 328                                 $colours[$pdbk] = Linker::getLinkColour( $title, $threshold );
 329                                 //add id to the extension todolist
 330                                 $linkcolour_ids[$s->page_id] = $pdbk;
 331                         }
 332                         unset( $res );
 333                 }
 334                 if ( count($linkcolour_ids) ) {
 335                         //pass an array of page_ids to an extension
 336                         wfRunHooks( 'GetLinkColours', array( $linkcolour_ids, &$colours ) );
 337                 }
 338                 wfProfileOut( __METHOD__.'-check' );
 339
 340                 # Do a second query for different language variants of links and categories
 341                 if($wgContLang->hasVariants()) {
 342                         $this->doVariants( $colours );
 343                 }
 344
 345                 # Construct search and replace arrays
 346                 wfProfileIn( __METHOD__.'-construct' );
 347                 $replacePairs = array();
 348                 foreach ( $this->internals as $ns => $entries ) {
 349                         foreach ( $entries as $index => $entry ) {
 350                                 $pdbk = $entry['pdbk'];
 351                                 $title = $entry['title'];
 352                                 $query = isset( $entry['query'] ) ? $entry['query'] : array();
 353                                 $key = "$ns:$index";
 354                                 $searchkey = "<!--LINK $key-->";
 355                                 $displayText = $entry['text'];
 356                                 if ( $displayText === '' ) {
 357                                         $displayText = null;
 358                                 }
 359                                 if ( !isset( $colours[$pdbk] ) ) {
 360                                         $colours[$pdbk] = 'new';
 361                                 }
 362                                 $attribs = array();
 363                                 if ( $colours[$pdbk] == 'new' ) {
 364                                         $linkCache->addBadLinkObj( $title );
 365                                         $output->addLink( $title, 0 );
 366                                         $type = array( 'broken',
 367                                                 'language' => $this->parent->getOptions()->getUserLangObj() );
 368                                 } else {
 369                                         if ( $colours[$pdbk] != '' ) {
 370                                                 $attribs['class'] = $colours[$pdbk];
 371                                         }
 372                                         $type = array( 'known', 'noclasses' );
 373                                 }
 374                                 $replacePairs[$searchkey] = Linker::link( $title, $displayText,
 375                                                 $attribs, $query, $type );
 376                         }
 377                 }
 378                 $replacer = new HashtableReplacer( $replacePairs, 1 );
 379                 wfProfileOut( __METHOD__.'-construct' );
 380
 381                 # Do the thing
 382                 wfProfileIn( __METHOD__.'-replace' );
 383                 $text = preg_replace_callback(
 384                         '/(<!--LINK .*?-->)/',
 385                         $replacer->cb(),
 386                         $text);
 387
 388                 wfProfileOut( __METHOD__.'-replace' );
 389                 wfProfileOut( __METHOD__ );
 390         }
 391
 392         /**
 393          * Replace interwiki links
 394          */
 395         protected function replaceInterwiki( &$text ) {
 396                 if ( empty( $this->interwikis ) ) {
 397                         return;
 398                 }
 399
 400                 wfProfileIn( __METHOD__ );
 401                 # Make interwiki link HTML
 402                 $output = $this->parent->getOutput();
 403                 $replacePairs = array();
 404                 foreach( $this->interwikis as $key => $link ) {
 405                         $replacePairs[$key] = Linker::link( $link['title'], $link['text'] );
 406                         $output->addInterwikiLink( $link['title'] );
 407                 }
 408                 $replacer = new HashtableReplacer( $replacePairs, 1 );
 409
 410                 $text = preg_replace_callback(
 411                         '/<!--IWLINK (.*?)-->/',
 412                         $replacer->cb(),
 413                         $text );
 414                 wfProfileOut( __METHOD__ );
 415         }
 416
 417         /**
 418          * Modify $this->internals and $colours according to language variant linking rules
 419          */
 420         protected function doVariants( &$colours ) {
 421                 global $wgContLang;
 422                 $linkBatch = new LinkBatch();
 423                 $variantMap = array(); // maps $pdbkey_Variant => $keys (of link holders)
 424                 $output = $this->parent->getOutput();
 425                 $linkCache = LinkCache::singleton();
 426                 $threshold = $this->parent->getOptions()->getStubThreshold();
 427                 $titlesToBeConverted = '';
 428                 $titlesAttrs = array();
 429
 430                 // Concatenate titles to a single string, thus we only need auto convert the
 431                 // single string to all variants. This would improve parser's performance
 432                 // significantly.
 433                 foreach ( $this->internals as $ns => $entries ) {
 434                         foreach ( $entries as $index => $entry ) {
 435                                 $pdbk = $entry['pdbk'];
 436                                 // we only deal with new links (in its first query)
 437                                 if ( !isset( $colours[$pdbk] ) ) {
 438                                         $title = $entry['title'];
 439                                         $titleText = $title->getText();
 440                                         $titlesAttrs[] = array(
 441                                                 'ns' => $ns,
 442                                                 'key' => "$ns:$index",
 443                                                 'titleText' => $titleText,
 444                                         );
 445                                         // separate titles with \0 because it would never appears
 446                                         // in a valid title
 447                                         $titlesToBeConverted .= $titleText . "\0";
 448                                 }
 449                         }
 450                 }
 451
 452                 // Now do the conversion and explode string to text of titles
 453                 $titlesAllVariants = $wgContLang->autoConvertToAllVariants( $titlesToBeConverted );
 454                 $allVariantsName = array_keys( $titlesAllVariants );
 455                 foreach ( $titlesAllVariants as &$titlesVariant ) {
 456                         $titlesVariant = explode( "\0", $titlesVariant );
 457                 }
 458                 $l = count( $titlesAttrs );
 459                 // Then add variants of links to link batch
 460                 for ( $i = 0; $i < $l; $i ++ ) {
 461                         foreach ( $allVariantsName as $variantName ) {
 462                                 $textVariant = $titlesAllVariants[$variantName][$i];
 463                                 if ( $textVariant != $titlesAttrs[$i]['titleText'] ) {
 464                                         $variantTitle = Title::makeTitle( $titlesAttrs[$i]['ns'], $textVariant );
 465                                         if( is_null( $variantTitle ) ) {
 466                                                 continue;
 467                                         }
 468                                         $linkBatch->addObj( $variantTitle );
 469                                         $variantMap[$variantTitle->getPrefixedDBkey()][] = $titlesAttrs[$i]['key'];
 470                                 }
 471                         }
 472                 }
 473
 474                 // process categories, check if a category exists in some variant
 475                 $categoryMap = array(); // maps $category_variant => $category (dbkeys)
 476                 $varCategories = array(); // category replacements oldDBkey => newDBkey
 477                 foreach( $output->getCategoryLinks() as $category ){
 478                         $variants = $wgContLang->autoConvertToAllVariants( $category );
 479                         foreach($variants as $variant){
 480                                 if($variant != $category){
 481                                         $variantTitle = Title::newFromDBkey( Title::makeName(NS_CATEGORY,$variant) );
 482                                         if(is_null($variantTitle)) continue;
 483                                         $linkBatch->addObj( $variantTitle );
 484                                         $categoryMap[$variant] = $category;
 485                                 }
 486                         }
 487                 }
 488
 489
 490                 if(!$linkBatch->isEmpty()){
 491                         // construct query
 492                         $dbr = wfGetDB( DB_SLAVE );
 493                         $varRes = $dbr->select( 'page',
 494                                 array( 'page_id', 'page_namespace', 'page_title', 'page_is_redirect', 'page_len', 'page_latest' ),
 495                                 $linkBatch->constructSet( 'page', $dbr ),
 496                                 __METHOD__
 497                         );
 498
 499                         $linkcolour_ids = array();
 500
 501                         // for each found variants, figure out link holders and replace
 502                         foreach ( $varRes as $s ) {
 503
 504                                 $variantTitle = Title::makeTitle( $s->page_namespace, $s->page_title );
 505                                 $varPdbk = $variantTitle->getPrefixedDBkey();
 506                                 $vardbk = $variantTitle->getDBkey();
 507
 508                                 $holderKeys = array();
 509                                 if( isset( $variantMap[$varPdbk] ) ) {
 510                                         $holderKeys = $variantMap[$varPdbk];
 511                                         $linkCache->addGoodLinkObjFromRow( $variantTitle, $s );
 512                                         $output->addLink( $variantTitle, $s->page_id );
 513                                 }
 514
 515                                 // loop over link holders
 516                                 foreach( $holderKeys as $key ) {
 517                                         list( $ns, $index ) = explode( ':', $key, 2 );
 518                                         $entry =& $this->internals[$ns][$index];
 519                                         $pdbk = $entry['pdbk'];
 520
 521                                         if(!isset($colours[$pdbk])){
 522                                                 // found link in some of the variants, replace the link holder data
 523                                                 $entry['title'] = $variantTitle;
 524                                                 $entry['pdbk'] = $varPdbk;
 525
 526                                                 // set pdbk and colour
 527                                                 # @todo FIXME: Convoluted data flow
 528                                                 # The redirect status and length is passed to getLinkColour via the LinkCache
 529                                                 # Use formal parameters instead
 530                                                 $colours[$varPdbk] = Linker::getLinkColour( $variantTitle, $threshold );
 531                                                 $linkcolour_ids[$s->page_id] = $pdbk;
 532                                         }
 533                                 }
 534
 535                                 // check if the object is a variant of a category
 536                                 if(isset($categoryMap[$vardbk])){
 537                                         $oldkey = $categoryMap[$vardbk];
 538                                         if($oldkey != $vardbk)
 539                                                 $varCategories[$oldkey]=$vardbk;
 540                                 }
 541                         }
 542                         wfRunHooks( 'GetLinkColours', array( $linkcolour_ids, &$colours ) );
 543
 544                         // rebuild the categories in original order (if there are replacements)
 545                         if(count($varCategories)>0){
 546                                 $newCats = array();
 547                                 $originalCats = $output->getCategories();
 548                                 foreach($originalCats as $cat => $sortkey){
 549                                         // make the replacement
 550                                         if( array_key_exists($cat,$varCategories) )
 551                                                 $newCats[$varCategories[$cat]] = $sortkey;
 552                                         else $newCats[$cat] = $sortkey;
 553                                 }
 554                                 $output->setCategoryLinks($newCats);
 555                         }
 556                 }
 557         }
 558
 559         /**
 560          * Replace <!--LINK--> link placeholders with plain text of links
 561          * (not HTML-formatted).
 562          *
 563          * @param $text String
 564          * @return String
 565          */
 566         function replaceText( $text ) {
 567                 wfProfileIn( __METHOD__ );
 568
 569                 $text = preg_replace_callback(
 570                         '/<!--(LINK|IWLINK) (.*?)-->/',
 571                         array( &$this, 'replaceTextCallback' ),
 572                         $text );
 573
 574                 wfProfileOut( __METHOD__ );
 575                 return $text;
 576         }
 577
 578         /**
 579          * Callback for replaceText()
 580          *
 581          * @param $matches Array
 582          * @return string
 583          * @private
 584          */
 585         function replaceTextCallback( $matches ) {
 586                 $type = $matches[1];
 587                 $key  = $matches[2];
 588                 if( $type == 'LINK' ) {
 589                         list( $ns, $index ) = explode( ':', $key, 2 );
 590                         if( isset( $this->internals[$ns][$index]['text'] ) ) {
 591                                 return $this->internals[$ns][$index]['text'];
 592                         }
 593                 } elseif( $type == 'IWLINK' ) {
 594                         if( isset( $this->interwikis[$key]['text'] ) ) {
 595                                 return $this->interwikis[$key]['text'];
 596                         }
 597                 }
 598                 return $matches[0];
 599         }
 600 }