5ae946d3a6
Make ::setCategory() consistent with the corresponding singular method, which is ::addCategory(), not ::addCategoryLink(). Also, don't return a value. This renaming is in preparation for factoring out a write-only base class from ParserOutput suitable to be used by Parsoid. Note that OutputPage does distinguish a 'category link' from a 'category list', and there are separate OutputPage::getCategories() and OutputPage::getCategoryLinks() methods. However, the category map in ParserOutput isn't exactly the same as either of these: it's actually a map (or list of pairs) of category name to sort key. Rename ParserOutput::getCategoryLinks() to ::getCategoryNames() in order to clarify that the concept involved is not the same as the OutputPage "category links" methods. Code search: https://codesearch.wmcloud.org/deployed/?q=-%3E(get%7Cset)CategoryLinks%5C(&i=nope&files=&excludeFiles=&repos= (Note that many of the code search matches are for the methods in OutputPage, which we are trying to disambiguate here.) Bug: T287216 Change-Id: Idb383d3d9ef7b76f8a0208a057a3cb8c639465c9
519 lines
15 KiB
PHP
519 lines
15 KiB
PHP
<?php
|
|
/**
|
|
* Holder of replacement pairs for wiki links
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
* @ingroup Parser
|
|
*/
|
|
|
|
use MediaWiki\HookContainer\HookContainer;
|
|
use MediaWiki\HookContainer\HookRunner;
|
|
use MediaWiki\MediaWikiServices;
|
|
|
|
/**
|
|
* @internal for using in Parser only.
|
|
*
|
|
* @ingroup Parser
|
|
*/
|
|
class LinkHolderArray {
|
|
/** @var array[][] */
|
|
public $internals = [];
|
|
/** @var array[] */
|
|
public $interwikis = [];
|
|
/** @var int */
|
|
public $size = 0;
|
|
|
|
/**
|
|
* @var Parser
|
|
*/
|
|
public $parent;
|
|
|
|
/**
|
|
* Current language converter
|
|
* @var ILanguageConverter
|
|
*/
|
|
private $languageConverter;
|
|
|
|
/**
|
|
* @var HookRunner
|
|
*/
|
|
private $hookRunner;
|
|
|
|
/**
|
|
* @param Parser $parent
|
|
* @param ILanguageConverter|null $languageConverter
|
|
* @param HookContainer|null $hookContainer
|
|
*/
|
|
public function __construct( Parser $parent, ILanguageConverter $languageConverter = null,
|
|
HookContainer $hookContainer = null
|
|
) {
|
|
$this->parent = $parent;
|
|
|
|
if ( !$languageConverter ) {
|
|
wfDeprecated( __METHOD__ . ' without $languageConverter parameter', '1.35' );
|
|
$languageConverter = MediaWikiServices::getInstance()
|
|
->getLanguageConverterFactory()
|
|
->getLanguageConverter( $parent->getTargetLanguage() );
|
|
}
|
|
$this->languageConverter = $languageConverter;
|
|
if ( !$hookContainer ) {
|
|
wfDeprecated( __METHOD__ . ' without $hookContainer parameter', '1.35' );
|
|
$hookContainer = MediaWikiServices::getInstance()->getHookContainer();
|
|
}
|
|
$this->hookRunner = new HookRunner( $hookContainer );
|
|
}
|
|
|
|
/**
|
|
* Reduce memory usage to reduce the impact of circular references
|
|
*/
|
|
public function __destruct() {
|
|
// @phan-suppress-next-line PhanTypeSuspiciousNonTraversableForeach
|
|
foreach ( $this as $name => $_ ) {
|
|
unset( $this->$name );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Merge another LinkHolderArray into this one
|
|
* @param LinkHolderArray $other
|
|
*/
|
|
public function merge( $other ) {
|
|
foreach ( $other->internals as $ns => $entries ) {
|
|
$this->size += count( $entries );
|
|
if ( !isset( $this->internals[$ns] ) ) {
|
|
$this->internals[$ns] = $entries;
|
|
} else {
|
|
$this->internals[$ns] += $entries;
|
|
}
|
|
}
|
|
$this->interwikis += $other->interwikis;
|
|
}
|
|
|
|
/**
|
|
* Returns true if the memory requirements of this object are getting large
|
|
* @return bool
|
|
*/
|
|
public function isBig() {
|
|
global $wgLinkHolderBatchSize;
|
|
return $this->size > $wgLinkHolderBatchSize;
|
|
}
|
|
|
|
/**
|
|
* Clear all stored link holders.
|
|
* Make sure you don't have any text left using these link holders, before you call this
|
|
*/
|
|
public function clear() {
|
|
$this->internals = [];
|
|
$this->interwikis = [];
|
|
$this->size = 0;
|
|
}
|
|
|
|
/**
|
|
* Make a link placeholder. The text returned can be later resolved to a real link with
|
|
* replaceLinkHolders(). This is done for two reasons: firstly to avoid further
|
|
* parsing of interwiki links, and secondly to allow all existence checks and
|
|
* article length checks (for stub links) to be bundled into a single query.
|
|
*
|
|
* @param Title $nt
|
|
* @param string $text
|
|
* @param string $trail [optional]
|
|
* @param string $prefix [optional]
|
|
* @return string
|
|
*/
|
|
public function makeHolder( Title $nt, $text = '', $trail = '', $prefix = '' ) {
|
|
# Separate the link trail from the rest of the link
|
|
list( $inside, $trail ) = Linker::splitTrail( $trail );
|
|
|
|
$key = $this->parent->nextLinkID();
|
|
$entry = [
|
|
'title' => $nt,
|
|
'text' => $prefix . $text . $inside,
|
|
'pdbk' => $nt->getPrefixedDBkey(),
|
|
];
|
|
|
|
$this->size++;
|
|
if ( $nt->isExternal() ) {
|
|
// Use a globally unique ID to keep the objects mergable
|
|
$this->interwikis[$key] = $entry;
|
|
return "<!--IWLINK'\" $key-->{$trail}";
|
|
} else {
|
|
$ns = $nt->getNamespace();
|
|
$this->internals[$ns][$key] = $entry;
|
|
return "<!--LINK'\" $ns:$key-->{$trail}";
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Replace <!--LINK--> link placeholders with actual links, in the buffer
|
|
*
|
|
* @param string &$text
|
|
*/
|
|
public function replace( &$text ) {
|
|
$this->replaceInternal( $text );
|
|
$this->replaceInterwiki( $text );
|
|
}
|
|
|
|
/**
|
|
* Replace internal links
|
|
* @param string &$text
|
|
*/
|
|
protected function replaceInternal( &$text ) {
|
|
if ( !$this->internals ) {
|
|
return;
|
|
}
|
|
|
|
$classes = [];
|
|
$services = MediaWikiServices::getInstance();
|
|
$linkCache = $services->getLinkCache();
|
|
$output = $this->parent->getOutput();
|
|
$linkRenderer = $this->parent->getLinkRenderer();
|
|
|
|
$dbr = wfGetDB( DB_REPLICA );
|
|
|
|
# Sort by namespace
|
|
ksort( $this->internals );
|
|
|
|
$pagemap = [];
|
|
|
|
# Generate query
|
|
$linkBatchFactory = $services->getLinkBatchFactory();
|
|
$lb = $linkBatchFactory->newLinkBatch();
|
|
$lb->setCaller( __METHOD__ );
|
|
|
|
foreach ( $this->internals as $ns => $entries ) {
|
|
foreach ( $entries as [ 'title' => $title, 'pdbk' => $pdbk ] ) {
|
|
/** @var Title $title */
|
|
|
|
# Skip invalid entries.
|
|
# Result will be ugly, but prevents crash.
|
|
if ( $title === null ) {
|
|
continue;
|
|
}
|
|
|
|
# Check if it's a static known link, e.g. interwiki
|
|
if ( $title->isAlwaysKnown() ) {
|
|
$classes[$pdbk] = '';
|
|
} elseif ( $ns == NS_SPECIAL ) {
|
|
$classes[$pdbk] = 'new';
|
|
} else {
|
|
$id = $linkCache->getGoodLinkID( $pdbk );
|
|
if ( $id != 0 ) {
|
|
$classes[$pdbk] = $linkRenderer->getLinkClasses( $title );
|
|
$output->addLink( $title, $id );
|
|
$pagemap[$id] = $pdbk;
|
|
} elseif ( $linkCache->isBadLink( $pdbk ) ) {
|
|
$classes[$pdbk] = 'new';
|
|
} else {
|
|
# Not in the link cache, add it to the query
|
|
$lb->addObj( $title );
|
|
}
|
|
}
|
|
}
|
|
}
|
|
if ( !$lb->isEmpty() ) {
|
|
$fields = array_merge(
|
|
LinkCache::getSelectFields(),
|
|
[ 'page_namespace', 'page_title' ]
|
|
);
|
|
|
|
$res = $dbr->select(
|
|
'page',
|
|
$fields,
|
|
$lb->constructSet( 'page', $dbr ),
|
|
__METHOD__
|
|
);
|
|
|
|
# Fetch data and form into an associative array
|
|
# non-existent = broken
|
|
foreach ( $res as $s ) {
|
|
$title = Title::makeTitle( $s->page_namespace, $s->page_title );
|
|
$pdbk = $title->getPrefixedDBkey();
|
|
$linkCache->addGoodLinkObjFromRow( $title, $s );
|
|
$output->addLink( $title, $s->page_id );
|
|
$classes[$pdbk] = $linkRenderer->getLinkClasses( $title );
|
|
// add id to the extension todolist
|
|
$pagemap[$s->page_id] = $pdbk;
|
|
}
|
|
unset( $res );
|
|
}
|
|
if ( $pagemap !== [] ) {
|
|
// pass an array of page_ids to an extension
|
|
$this->hookRunner->onGetLinkColours( $pagemap, $classes, $this->parent->getTitle() );
|
|
}
|
|
|
|
# Do a second query for different language variants of links and categories
|
|
if ( $this->languageConverter->hasVariants() ) {
|
|
$this->doVariants( $classes );
|
|
}
|
|
|
|
# Construct search and replace arrays
|
|
$replacePairs = [];
|
|
foreach ( $this->internals as $ns => $entries ) {
|
|
foreach ( $entries as $index => $entry ) {
|
|
$pdbk = $entry['pdbk'];
|
|
$title = $entry['title'];
|
|
$query = $entry['query'] ?? [];
|
|
$searchkey = "<!--LINK'\" $ns:$index-->";
|
|
$displayTextHtml = $entry['text'];
|
|
if ( isset( $entry['selflink'] ) ) {
|
|
$replacePairs[$searchkey] = Linker::makeSelfLinkObj( $title, $displayTextHtml, $query );
|
|
continue;
|
|
}
|
|
if ( $displayTextHtml === '' ) {
|
|
$displayText = null;
|
|
} else {
|
|
$displayText = new HtmlArmor( $displayTextHtml );
|
|
}
|
|
if ( !isset( $classes[$pdbk] ) ) {
|
|
$classes[$pdbk] = 'new';
|
|
}
|
|
if ( $classes[$pdbk] == 'new' ) {
|
|
$linkCache->addBadLinkObj( $title );
|
|
$output->addLink( $title, 0 );
|
|
$link = $linkRenderer->makeBrokenLink(
|
|
$title, $displayText, [], $query
|
|
);
|
|
} else {
|
|
$link = $linkRenderer->makePreloadedLink(
|
|
$title, $displayText, $classes[$pdbk], [], $query
|
|
);
|
|
}
|
|
|
|
$replacePairs[$searchkey] = $link;
|
|
}
|
|
}
|
|
|
|
# Do the thing
|
|
$text = preg_replace_callback(
|
|
'/(<!--LINK\'" .*?-->)/',
|
|
static function ( array $matches ) use ( $replacePairs ) {
|
|
return $replacePairs[$matches[1]];
|
|
},
|
|
$text
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Replace interwiki links
|
|
* @param string &$text
|
|
*/
|
|
protected function replaceInterwiki( &$text ) {
|
|
if ( empty( $this->interwikis ) ) {
|
|
return;
|
|
}
|
|
|
|
# Make interwiki link HTML
|
|
$output = $this->parent->getOutput();
|
|
$replacePairs = [];
|
|
$linkRenderer = $this->parent->getLinkRenderer();
|
|
foreach ( $this->interwikis as $key => $link ) {
|
|
$replacePairs[$key] = $linkRenderer->makeLink(
|
|
$link['title'],
|
|
new HtmlArmor( $link['text'] )
|
|
);
|
|
$output->addInterwikiLink( $link['title'] );
|
|
}
|
|
|
|
$text = preg_replace_callback(
|
|
'/<!--IWLINK\'" (.*?)-->/',
|
|
static function ( array $matches ) use ( $replacePairs ) {
|
|
return $replacePairs[$matches[1]];
|
|
},
|
|
$text
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Modify $this->internals and $classes according to language variant linking rules
|
|
* @param array &$classes
|
|
*/
|
|
protected function doVariants( &$classes ) {
|
|
$linkBatchFactory = MediaWikiServices::getInstance()->getLinkBatchFactory();
|
|
$linkBatch = $linkBatchFactory->newLinkBatch();
|
|
$variantMap = []; // maps $pdbkey_Variant => $keys (of link holders)
|
|
$output = $this->parent->getOutput();
|
|
$linkCache = MediaWikiServices::getInstance()->getLinkCache();
|
|
$titlesToBeConverted = '';
|
|
$titlesAttrs = [];
|
|
|
|
// Concatenate titles to a single string, thus we only need auto convert the
|
|
// single string to all variants. This would improve parser's performance
|
|
// significantly.
|
|
foreach ( $this->internals as $ns => $entries ) {
|
|
if ( $ns == NS_SPECIAL ) {
|
|
continue;
|
|
}
|
|
foreach ( $entries as $index => [ 'title' => $title, 'pdbk' => $pdbk ] ) {
|
|
// we only deal with new links (in its first query)
|
|
if ( !isset( $classes[$pdbk] ) || $classes[$pdbk] === 'new' ) {
|
|
$titlesAttrs[] = [ $index, $title ];
|
|
// separate titles with \0 because it would never appears
|
|
// in a valid title
|
|
$titlesToBeConverted .= $title->getText() . "\0";
|
|
}
|
|
}
|
|
}
|
|
|
|
// Now do the conversion and explode string to text of titles
|
|
$titlesAllVariants = $this->languageConverter->
|
|
autoConvertToAllVariants( rtrim( $titlesToBeConverted, "\0" ) );
|
|
foreach ( $titlesAllVariants as &$titlesVariant ) {
|
|
$titlesVariant = explode( "\0", $titlesVariant );
|
|
}
|
|
|
|
// Then add variants of links to link batch
|
|
$parentTitle = $this->parent->getTitle();
|
|
foreach ( $titlesAttrs as $i => [ $index, $title ] ) {
|
|
/** @var Title $title */
|
|
$ns = $title->getNamespace();
|
|
$text = $title->getText();
|
|
|
|
foreach ( $titlesAllVariants as $variantName => $textVariants ) {
|
|
$textVariant = $textVariants[$i];
|
|
if ( $textVariant === $text ) {
|
|
continue;
|
|
}
|
|
|
|
$variantTitle = Title::makeTitle( $ns, $textVariant );
|
|
|
|
// Self-link checking for mixed/different variant titles. At this point, we
|
|
// already know the exact title does not exist, so the link cannot be to a
|
|
// variant of the current title that exists as a separate page.
|
|
if ( $variantTitle->equals( $parentTitle ) && !$title->hasFragment() ) {
|
|
$this->internals[$ns][$index]['selflink'] = true;
|
|
continue 2;
|
|
}
|
|
|
|
$linkBatch->addObj( $variantTitle );
|
|
$variantMap[$variantTitle->getPrefixedDBkey()][] = "$ns:$index";
|
|
}
|
|
}
|
|
|
|
// process categories, check if a category exists in some variant
|
|
$categoryMap = []; // maps $category_variant => $category (dbkeys)
|
|
$varCategories = []; // category replacements oldDBkey => newDBkey
|
|
foreach ( $output->getCategoryNames() as $category ) {
|
|
$categoryTitle = Title::makeTitleSafe( NS_CATEGORY, $category );
|
|
$linkBatch->addObj( $categoryTitle );
|
|
$variants = $this->languageConverter->autoConvertToAllVariants( $category );
|
|
foreach ( $variants as $variant ) {
|
|
if ( $variant !== $category ) {
|
|
$variantTitle = Title::makeTitleSafe( NS_CATEGORY, $variant );
|
|
if ( $variantTitle === null ) {
|
|
continue;
|
|
}
|
|
$linkBatch->addObj( $variantTitle );
|
|
$categoryMap[$variant] = [ $category, $categoryTitle ];
|
|
}
|
|
}
|
|
}
|
|
|
|
if ( !$linkBatch->isEmpty() ) {
|
|
// construct query
|
|
$dbr = wfGetDB( DB_REPLICA );
|
|
$fields = array_merge(
|
|
LinkCache::getSelectFields(),
|
|
[ 'page_namespace', 'page_title' ]
|
|
);
|
|
|
|
$varRes = $dbr->select( 'page',
|
|
$fields,
|
|
$linkBatch->constructSet( 'page', $dbr ),
|
|
__METHOD__
|
|
);
|
|
|
|
$pagemap = [];
|
|
$linkRenderer = $this->parent->getLinkRenderer();
|
|
|
|
// for each found variants, figure out link holders and replace
|
|
foreach ( $varRes as $s ) {
|
|
$variantTitle = Title::makeTitle( $s->page_namespace, $s->page_title );
|
|
$varPdbk = $variantTitle->getPrefixedDBkey();
|
|
$vardbk = $variantTitle->getDBkey();
|
|
|
|
$holderKeys = [];
|
|
if ( isset( $variantMap[$varPdbk] ) ) {
|
|
$holderKeys = $variantMap[$varPdbk];
|
|
$linkCache->addGoodLinkObjFromRow( $variantTitle, $s );
|
|
$output->addLink( $variantTitle, $s->page_id );
|
|
}
|
|
|
|
// loop over link holders
|
|
foreach ( $holderKeys as $key ) {
|
|
list( $ns, $index ) = explode( ':', $key, 2 );
|
|
$entry =& $this->internals[$ns][$index];
|
|
$pdbk = $entry['pdbk'];
|
|
|
|
if ( !isset( $classes[$pdbk] ) || $classes[$pdbk] === 'new' ) {
|
|
// found link in some of the variants, replace the link holder data
|
|
$entry['title'] = $variantTitle;
|
|
$entry['pdbk'] = $varPdbk;
|
|
|
|
// set pdbk and colour
|
|
$classes[$varPdbk] = $linkRenderer->getLinkClasses( $variantTitle );
|
|
$pagemap[$s->page_id] = $pdbk;
|
|
}
|
|
}
|
|
|
|
// check if the object is a variant of a category
|
|
if ( isset( $categoryMap[$vardbk] ) ) {
|
|
list( $oldkey, $oldtitle ) = $categoryMap[$vardbk];
|
|
if ( !isset( $varCategories[$oldkey] ) && !$oldtitle->exists() ) {
|
|
$varCategories[$oldkey] = $vardbk;
|
|
}
|
|
}
|
|
}
|
|
$this->hookRunner->onGetLinkColours( $pagemap, $classes, $this->parent->getTitle() );
|
|
|
|
// rebuild the categories in original order (if there are replacements)
|
|
if ( $varCategories !== [] ) {
|
|
$newCats = [];
|
|
$originalCats = $output->getCategories();
|
|
foreach ( $originalCats as $cat => $sortkey ) {
|
|
// make the replacement
|
|
$newCats[$varCategories[$cat] ?? $cat] = $sortkey;
|
|
}
|
|
$output->setCategories( $newCats );
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Replace <!--LINK--> and <!--IWLINK--> link placeholders with plain text of links
|
|
* (not HTML-formatted).
|
|
*
|
|
* @param string $text
|
|
* @return string
|
|
*/
|
|
public function replaceText( $text ) {
|
|
return preg_replace_callback(
|
|
'/<!--(IW)?LINK\'" (.*?)-->/',
|
|
function ( $matches ) {
|
|
list( $unchanged, $isInterwiki, $key ) = $matches;
|
|
|
|
if ( !$isInterwiki ) {
|
|
list( $ns, $index ) = explode( ':', $key, 2 );
|
|
return $this->internals[$ns][$index]['text'] ?? $unchanged;
|
|
} else {
|
|
return $this->interwikis[$key]['text'] ?? $unchanged;
|
|
}
|
|
},
|
|
$text
|
|
);
|
|
}
|
|
}
|