3 * Holder of replacement pairs for wiki links
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 use MediaWiki\MediaWikiServices
;
29 class LinkHolderArray
{
30 public $internals = [];
31 public $interwikis = [];
38 protected $tempIdOffset;
41 * @param Parser $parent
43 public function __construct( $parent ) {
44 $this->parent
= $parent;
48 * Reduce memory usage to reduce the impact of circular references
50 public function __destruct() {
51 foreach ( $this as $name => $value ) {
52 unset( $this->$name );
57 * Don't serialize the parent object, it is big, and not needed when it is
58 * a parameter to mergeForeign(), which is the only application of
59 * serializing at present.
61 * Compact the titles, only serialize the text form.
64 public function __sleep() {
65 foreach ( $this->internals
as &$nsLinks ) {
66 foreach ( $nsLinks as &$entry ) {
67 unset( $entry['title'] );
73 foreach ( $this->interwikis
as &$entry ) {
74 unset( $entry['title'] );
78 return [ 'internals', 'interwikis', 'size' ];
82 * Recreate the Title objects
84 public function __wakeup() {
85 foreach ( $this->internals
as &$nsLinks ) {
86 foreach ( $nsLinks as &$entry ) {
87 $entry['title'] = Title
::newFromText( $entry['pdbk'] );
93 foreach ( $this->interwikis
as &$entry ) {
94 $entry['title'] = Title
::newFromText( $entry['pdbk'] );
100 * Merge another LinkHolderArray into this one
101 * @param LinkHolderArray $other
103 public function merge( $other ) {
104 foreach ( $other->internals
as $ns => $entries ) {
105 $this->size +
= count( $entries );
106 if ( !isset( $this->internals
[$ns] ) ) {
107 $this->internals
[$ns] = $entries;
109 $this->internals
[$ns] +
= $entries;
112 $this->interwikis +
= $other->interwikis
;
116 * Merge a LinkHolderArray from another parser instance into this one. The
117 * keys will not be preserved. Any text which went with the old
118 * LinkHolderArray and needs to work with the new one should be passed in
119 * the $texts array. The strings in this array will have their link holders
120 * converted for use in the destination link holder. The resulting array of
121 * strings will be returned.
123 * @param LinkHolderArray $other
124 * @param array $texts Array of strings
127 public function mergeForeign( $other, $texts ) {
128 $this->tempIdOffset
= $idOffset = $this->parent
->nextLinkID();
131 # Renumber internal links
132 foreach ( $other->internals
as $ns => $nsLinks ) {
133 foreach ( $nsLinks as $key => $entry ) {
134 $newKey = $idOffset +
$key;
135 $this->internals
[$ns][$newKey] = $entry;
136 $maxId = $newKey > $maxId ?
$newKey : $maxId;
139 $texts = preg_replace_callback( '/(<!--LINK\'" \d+:)(\d+)(-->)/',
140 [ $this, 'mergeForeignCallback' ], $texts );
142 # Renumber interwiki links
143 foreach ( $other->interwikis
as $key => $entry ) {
144 $newKey = $idOffset +
$key;
145 $this->interwikis
[$newKey] = $entry;
146 $maxId = $newKey > $maxId ?
$newKey : $maxId;
148 $texts = preg_replace_callback( '/(<!--IWLINK\'" )(\d+)(-->)/',
149 [ $this, 'mergeForeignCallback' ], $texts );
151 # Set the parent link ID to be beyond the highest used ID
152 $this->parent
->setLinkID( $maxId +
1 );
153 $this->tempIdOffset
= null;
161 protected function mergeForeignCallback( $m ) {
162 return $m[1] . ( $m[2] +
$this->tempIdOffset
) . $m[3];
166 * Get a subset of the current LinkHolderArray which is sufficient to
167 * interpret the given text.
168 * @param string $text
169 * @return LinkHolderArray
171 public function getSubArray( $text ) {
172 $sub = new LinkHolderArray( $this->parent
);
176 while ( $pos < strlen( $text ) ) {
177 if ( !preg_match( '/<!--LINK\'" (\d+):(\d+)-->/',
178 $text, $m, PREG_OFFSET_CAPTURE
, $pos )
184 $sub->internals
[$ns][$key] = $this->internals
[$ns][$key];
185 $pos = $m[0][1] +
strlen( $m[0][0] );
190 while ( $pos < strlen( $text ) ) {
191 if ( !preg_match( '/<!--IWLINK\'" (\d+)-->/', $text, $m, PREG_OFFSET_CAPTURE
, $pos ) ) {
195 $sub->interwikis
[$key] = $this->interwikis
[$key];
196 $pos = $m[0][1] +
strlen( $m[0][0] );
202 * Returns true if the memory requirements of this object are getting large
205 public function isBig() {
206 global $wgLinkHolderBatchSize;
207 return $this->size
> $wgLinkHolderBatchSize;
211 * Clear all stored link holders.
212 * Make sure you don't have any text left using these link holders, before you call this
214 public function clear() {
215 $this->internals
= [];
216 $this->interwikis
= [];
221 * Make a link placeholder. The text returned can be later resolved to a real link with
222 * replaceLinkHolders(). This is done for two reasons: firstly to avoid further
223 * parsing of interwiki links, and secondly to allow all existence checks and
224 * article length checks (for stub links) to be bundled into a single query.
227 * @param string $text
228 * @param array $query [optional]
229 * @param string $trail [optional]
230 * @param string $prefix [optional]
233 public function makeHolder( $nt, $text = '', $query = [], $trail = '', $prefix = '' ) {
234 if ( !is_object( $nt ) ) {
236 $retVal = "<!-- ERROR -->{$prefix}{$text}{$trail}";
238 # Separate the link trail from the rest of the link
239 list( $inside, $trail ) = Linker
::splitTrail( $trail );
243 'text' => $prefix . $text . $inside,
244 'pdbk' => $nt->getPrefixedDBkey(),
246 if ( $query !== [] ) {
247 $entry['query'] = $query;
250 if ( $nt->isExternal() ) {
251 // Use a globally unique ID to keep the objects mergable
252 $key = $this->parent
->nextLinkID();
253 $this->interwikis
[$key] = $entry;
254 $retVal = "<!--IWLINK'\" $key-->{$trail}";
256 $key = $this->parent
->nextLinkID();
257 $ns = $nt->getNamespace();
258 $this->internals
[$ns][$key] = $entry;
259 $retVal = "<!--LINK'\" $ns:$key-->{$trail}";
267 * Replace <!--LINK--> link placeholders with actual links, in the buffer
269 * @param string &$text
271 public function replace( &$text ) {
272 $this->replaceInternal( $text );
273 $this->replaceInterwiki( $text );
277 * Replace internal links
278 * @suppress SecurityCheck-XSS Gets confused with $entry['pdbk']
279 * @param string &$text
281 protected function replaceInternal( &$text ) {
282 if ( !$this->internals
) {
287 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
288 $output = $this->parent
->getOutput();
289 $linkRenderer = $this->parent
->getLinkRenderer();
291 $dbr = wfGetDB( DB_REPLICA
);
294 ksort( $this->internals
);
296 $linkcolour_ids = [];
299 $lb = new LinkBatch();
300 $lb->setCaller( __METHOD__
);
302 foreach ( $this->internals
as $ns => $entries ) {
303 foreach ( $entries as $entry ) {
304 /** @var Title $title */
305 $title = $entry['title'];
306 $pdbk = $entry['pdbk'];
308 # Skip invalid entries.
309 # Result will be ugly, but prevents crash.
310 if ( is_null( $title ) ) {
314 # Check if it's a static known link, e.g. interwiki
315 if ( $title->isAlwaysKnown() ) {
316 $colours[$pdbk] = '';
317 } elseif ( $ns == NS_SPECIAL
) {
318 $colours[$pdbk] = 'new';
320 $id = $linkCache->getGoodLinkID( $pdbk );
322 $colours[$pdbk] = $linkRenderer->getLinkClasses( $title );
323 $output->addLink( $title, $id );
324 $linkcolour_ids[$id] = $pdbk;
325 } elseif ( $linkCache->isBadLink( $pdbk ) ) {
326 $colours[$pdbk] = 'new';
328 # Not in the link cache, add it to the query
329 $lb->addObj( $title );
334 if ( !$lb->isEmpty() ) {
335 $fields = array_merge(
336 LinkCache
::getSelectFields(),
337 [ 'page_namespace', 'page_title' ]
343 $lb->constructSet( 'page', $dbr ),
347 # Fetch data and form into an associative array
348 # non-existent = broken
349 foreach ( $res as $s ) {
350 $title = Title
::makeTitle( $s->page_namespace
, $s->page_title
);
351 $pdbk = $title->getPrefixedDBkey();
352 $linkCache->addGoodLinkObjFromRow( $title, $s );
353 $output->addLink( $title, $s->page_id
);
354 $colours[$pdbk] = $linkRenderer->getLinkClasses( $title );
355 // add id to the extension todolist
356 $linkcolour_ids[$s->page_id
] = $pdbk;
360 if ( count( $linkcolour_ids ) ) {
361 // pass an array of page_ids to an extension
362 Hooks
::run( 'GetLinkColours', [ $linkcolour_ids, &$colours, $this->parent
->getTitle() ] );
365 # Do a second query for different language variants of links and categories
366 if ( $this->parent
->getContentLanguage()->hasVariants() ) {
367 $this->doVariants( $colours );
370 # Construct search and replace arrays
372 foreach ( $this->internals
as $ns => $entries ) {
373 foreach ( $entries as $index => $entry ) {
374 $pdbk = $entry['pdbk'];
375 $title = $entry['title'];
376 $query = $entry['query'] ??
[];
378 $searchkey = "<!--LINK'\" $key-->";
379 $displayText = $entry['text'];
380 if ( isset( $entry['selflink'] ) ) {
381 $replacePairs[$searchkey] = Linker
::makeSelfLinkObj( $title, $displayText, $query );
384 if ( $displayText === '' ) {
387 $displayText = new HtmlArmor( $displayText );
389 if ( !isset( $colours[$pdbk] ) ) {
390 $colours[$pdbk] = 'new';
393 if ( $colours[$pdbk] == 'new' ) {
394 $linkCache->addBadLinkObj( $title );
395 $output->addLink( $title, 0 );
396 $link = $linkRenderer->makeBrokenLink(
397 $title, $displayText, $attribs, $query
400 $link = $linkRenderer->makePreloadedLink(
401 $title, $displayText, $colours[$pdbk], $attribs, $query
405 $replacePairs[$searchkey] = $link;
410 $text = preg_replace_callback(
411 '/(<!--LINK\'" .*?-->)/',
412 function ( array $matches ) use ( $replacePairs ) {
413 return $replacePairs[$matches[1]];
420 * Replace interwiki links
421 * @param string &$text
422 * @suppress SecurityCheck-XSS Gets confused with $this->interwikis['pdbk']
424 protected function replaceInterwiki( &$text ) {
425 if ( empty( $this->interwikis
) ) {
429 # Make interwiki link HTML
430 $output = $this->parent
->getOutput();
432 $linkRenderer = $this->parent
->getLinkRenderer();
433 foreach ( $this->interwikis
as $key => $link ) {
434 $replacePairs[$key] = $linkRenderer->makeLink(
436 new HtmlArmor( $link['text'] )
438 $output->addInterwikiLink( $link['title'] );
441 $text = preg_replace_callback(
442 '/<!--IWLINK\'" (.*?)-->/',
443 function ( array $matches ) use ( $replacePairs ) {
444 return $replacePairs[$matches[1]];
451 * Modify $this->internals and $colours according to language variant linking rules
452 * @param array &$colours
454 protected function doVariants( &$colours ) {
455 $linkBatch = new LinkBatch();
456 $variantMap = []; // maps $pdbkey_Variant => $keys (of link holders)
457 $output = $this->parent
->getOutput();
458 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
459 $titlesToBeConverted = '';
462 // Concatenate titles to a single string, thus we only need auto convert the
463 // single string to all variants. This would improve parser's performance
465 foreach ( $this->internals
as $ns => $entries ) {
466 if ( $ns == NS_SPECIAL
) {
469 foreach ( $entries as $index => $entry ) {
470 $pdbk = $entry['pdbk'];
471 // we only deal with new links (in its first query)
472 if ( !isset( $colours[$pdbk] ) ||
$colours[$pdbk] === 'new' ) {
473 $titlesAttrs[] = [ $index, $entry['title'] ];
474 // separate titles with \0 because it would never appears
476 $titlesToBeConverted .= $entry['title']->getText() . "\0";
481 // Now do the conversion and explode string to text of titles
482 $titlesAllVariants = $this->parent
->getContentLanguage()->
483 autoConvertToAllVariants( rtrim( $titlesToBeConverted, "\0" ) );
484 $allVariantsName = array_keys( $titlesAllVariants );
485 foreach ( $titlesAllVariants as &$titlesVariant ) {
486 $titlesVariant = explode( "\0", $titlesVariant );
489 // Then add variants of links to link batch
490 $parentTitle = $this->parent
->getTitle();
491 foreach ( $titlesAttrs as $i => $attrs ) {
492 /** @var Title $title */
493 list( $index, $title ) = $attrs;
494 $ns = $title->getNamespace();
495 $text = $title->getText();
497 foreach ( $allVariantsName as $variantName ) {
498 $textVariant = $titlesAllVariants[$variantName][$i];
499 if ( $textVariant === $text ) {
503 $variantTitle = Title
::makeTitle( $ns, $textVariant );
505 // Self-link checking for mixed/different variant titles. At this point, we
506 // already know the exact title does not exist, so the link cannot be to a
507 // variant of the current title that exists as a separate page.
508 if ( $variantTitle->equals( $parentTitle ) && !$title->hasFragment() ) {
509 $this->internals
[$ns][$index]['selflink'] = true;
513 $linkBatch->addObj( $variantTitle );
514 $variantMap[$variantTitle->getPrefixedDBkey()][] = "$ns:$index";
518 // process categories, check if a category exists in some variant
519 $categoryMap = []; // maps $category_variant => $category (dbkeys)
520 $varCategories = []; // category replacements oldDBkey => newDBkey
521 foreach ( $output->getCategoryLinks() as $category ) {
522 $categoryTitle = Title
::makeTitleSafe( NS_CATEGORY
, $category );
523 $linkBatch->addObj( $categoryTitle );
524 $variants = $this->parent
->getContentLanguage()->autoConvertToAllVariants( $category );
525 foreach ( $variants as $variant ) {
526 if ( $variant !== $category ) {
527 $variantTitle = Title
::makeTitleSafe( NS_CATEGORY
, $variant );
528 if ( is_null( $variantTitle ) ) {
531 $linkBatch->addObj( $variantTitle );
532 $categoryMap[$variant] = [ $category, $categoryTitle ];
537 if ( !$linkBatch->isEmpty() ) {
539 $dbr = wfGetDB( DB_REPLICA
);
540 $fields = array_merge(
541 LinkCache
::getSelectFields(),
542 [ 'page_namespace', 'page_title' ]
545 $varRes = $dbr->select( 'page',
547 $linkBatch->constructSet( 'page', $dbr ),
551 $linkcolour_ids = [];
552 $linkRenderer = $this->parent
->getLinkRenderer();
554 // for each found variants, figure out link holders and replace
555 foreach ( $varRes as $s ) {
556 $variantTitle = Title
::makeTitle( $s->page_namespace
, $s->page_title
);
557 $varPdbk = $variantTitle->getPrefixedDBkey();
558 $vardbk = $variantTitle->getDBkey();
561 if ( isset( $variantMap[$varPdbk] ) ) {
562 $holderKeys = $variantMap[$varPdbk];
563 $linkCache->addGoodLinkObjFromRow( $variantTitle, $s );
564 $output->addLink( $variantTitle, $s->page_id
);
567 // loop over link holders
568 foreach ( $holderKeys as $key ) {
569 list( $ns, $index ) = explode( ':', $key, 2 );
570 $entry =& $this->internals
[$ns][$index];
571 $pdbk = $entry['pdbk'];
573 if ( !isset( $colours[$pdbk] ) ||
$colours[$pdbk] === 'new' ) {
574 // found link in some of the variants, replace the link holder data
575 $entry['title'] = $variantTitle;
576 $entry['pdbk'] = $varPdbk;
578 // set pdbk and colour
579 $colours[$varPdbk] = $linkRenderer->getLinkClasses( $variantTitle );
580 $linkcolour_ids[$s->page_id
] = $pdbk;
584 // check if the object is a variant of a category
585 if ( isset( $categoryMap[$vardbk] ) ) {
586 list( $oldkey, $oldtitle ) = $categoryMap[$vardbk];
587 if ( !isset( $varCategories[$oldkey] ) && !$oldtitle->exists() ) {
588 $varCategories[$oldkey] = $vardbk;
592 Hooks
::run( 'GetLinkColours', [ $linkcolour_ids, &$colours, $this->parent
->getTitle() ] );
594 // rebuild the categories in original order (if there are replacements)
595 if ( count( $varCategories ) > 0 ) {
597 $originalCats = $output->getCategories();
598 foreach ( $originalCats as $cat => $sortkey ) {
599 // make the replacement
600 if ( array_key_exists( $cat, $varCategories ) ) {
601 $newCats[$varCategories[$cat]] = $sortkey;
603 $newCats[$cat] = $sortkey;
606 $output->setCategoryLinks( $newCats );
612 * Replace <!--LINK--> link placeholders with plain text of links
613 * (not HTML-formatted).
615 * @param string $text
618 public function replaceText( $text ) {
619 $text = preg_replace_callback(
620 '/<!--(LINK|IWLINK)\'" (.*?)-->/',
621 [ $this, 'replaceTextCallback' ],
628 * Callback for replaceText()
630 * @param array $matches
634 public function replaceTextCallback( $matches ) {
637 if ( $type == 'LINK' ) {
638 list( $ns, $index ) = explode( ':', $key, 2 );
639 if ( isset( $this->internals
[$ns][$index]['text'] ) ) {
640 return $this->internals
[$ns][$index]['text'];
642 } elseif ( $type == 'IWLINK' ) {
643 if ( isset( $this->interwikis
[$key]['text'] ) ) {
644 return $this->interwikis
[$key]['text'];