LinksTableGroup.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Deferred\LinksUpdate;
 
use MediaWiki\Collation\CollationFactory;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\Linker\LinkTargetLookup;
use MediaWiki\MediaWikiServices;
use MediaWiki\Page\PageIdentity;
use MediaWiki\Page\PageReference;
use MediaWiki\Parser\ParserOutput;
use MediaWiki\Revision\RevisionRecord;
use Wikimedia\ObjectFactory\ObjectFactory;
use Wikimedia\Rdbms\LBFactory;
 
class LinksTableGroup {
    private const CORE_LIST = [
        'categorylinks' => [
            'class' => CategoryLinksTable::class,
            'services' => [
                'LanguageConverterFactory',
                'NamespaceInfo',
                'WikiPageFactory'
            ],
            'needCollation' => true,
        ],
        'externallinks' => [
            'class' => ExternalLinksTable::class,
        ],
        'imagelinks' => [
            'class' => ImageLinksTable::class
        ],
        'iwlinks' => [
            'class' => InterwikiLinksTable::class
        ],
        'langlinks' => [
            'class' => LangLinksTable::class
        ],
        'pagelinks' => [
            'class' => PageLinksTable::class,
            'services' => [
                'MainConfig'
            ],
        ],
        'page_props' => [
            'class' => PagePropsTable::class,
            'services' => [
                'JobQueueGroup'
            ],
            'serviceOptions' => PagePropsTable::CONSTRUCTOR_OPTIONS
        ],
        'templatelinks' => [
            'class' => TemplateLinksTable::class,
            'services' => [
                'MainConfig'
            ],
        ]
    ];
 
    private $objectFactory;
 
    private $lbFactory;
 
    private $collationFactory;
 
    private $page;
 
    private $movedPage;
 
    private $parserOutput;
 
    private $linkTargetLookup;
 
    private $batchSize;
 
    private $ticket;
 
    private $revision;
 
    private $tables = [];
 
    private $tempCollations;
 
    public function __construct(
        ObjectFactory $objectFactory,
        LBFactory $lbFactory,
        CollationFactory $collationFactory,
        PageIdentity $page,
        LinkTargetLookup $linkTargetLookup,
        $batchSize,
        array $tempCollations
    ) {
        $this->objectFactory = $objectFactory;
        $this->lbFactory = $lbFactory;
        $this->collationFactory = $collationFactory;
        $this->page = $page;
        $this->batchSize = $batchSize;
        $this->linkTargetLookup = $linkTargetLookup;
        $this->tempCollations = [];
        foreach ( $tempCollations as $info ) {
            $this->tempCollations[$info['table']] = $info;
        }
    }
 
    public function setParserOutput( ParserOutput $parserOutput ) {
        $this->parserOutput = $parserOutput;
        foreach ( $this->tables as $table ) {
            $table->setParserOutput( $parserOutput );
        }
    }
 
    public function setMoveDetails( PageReference $oldPage ) {
        $this->movedPage = $oldPage;
        foreach ( $this->tables as $table ) {
            $table->setMoveDetails( $oldPage );
        }
    }
 
    public function setTransactionTicket( $ticket ) {
        $this->ticket = $ticket;
        foreach ( $this->tables as $table ) {
            $table->setTransactionTicket( $ticket );
        }
    }
 
    public function setRevision( RevisionRecord $revision ) {
        $this->revision = $revision;
        foreach ( $this->tables as $table ) {
            $table->setRevision( $revision );
        }
    }
 
    public function setStrictTestMode( $mode = true ) {
        foreach ( $this->getAll() as $table ) {
            $table->setStrictTestMode( $mode );
        }
    }
 
    private function getSpec( $tableName ) {
        if ( isset( self::CORE_LIST[$tableName] ) ) {
            $spec = self::CORE_LIST[$tableName];
            return $this->addCollationArgs( $spec, $tableName, false );
        }
        if ( isset( $this->tempCollations[$tableName] ) ) {
            $info = $this->tempCollations[$tableName];
            $spec = self::CORE_LIST['categorylinks'];
            return $this->addCollationArgs( $spec, $tableName, true, $info );
        }
        throw new \InvalidArgumentException(
            __CLASS__ . ": unknown table name \"$tableName\"" );
    }
 
    private function addCollationArgs( $spec, $tableName, $isTempTable, $info = [] ) {
        if ( isset( $spec['needCollation'] ) ) {
            if ( isset( $info['collation'] ) ) {
                $collation = $this->collationFactory->makeCollation( $info['collation'] );
                $collationName = $info['fakeCollation'] ?? $info['collation'];
            } else {
                $collation = $this->collationFactory->getCategoryCollation();
                $collationName = $this->collationFactory->getDefaultCollationName();
            }
            $spec['args'] = [
                $collation,
                $info['fakeCollation'] ?? $collationName,
                $tableName,
                $isTempTable
            ];
            unset( $spec['needCollation'] );
        }
        return $spec;
    }
 
    public function get( $tableName ) {
        if ( !isset( $this->tables[$tableName] ) ) {
            $spec = $this->getSpec( $tableName );
            if ( isset( $spec['serviceOptions'] ) ) {
                $config = MediaWikiServices::getInstance()->getMainConfig();
                $extraArgs = [ new ServiceOptions( $spec['serviceOptions'], $config ) ];
                unset( $spec['serviceOptions'] );
            } else {
                $extraArgs = [];
            }
            $table = $this->objectFactory->createObject( $spec, [ 'extraArgs' => $extraArgs ] );
            $table->injectBaseDependencies(
                $this->lbFactory,
                $this->linkTargetLookup,
                $this->page,
                $this->batchSize
            );
            if ( $this->parserOutput ) {
                $table->setParserOutput( $this->parserOutput );
            }
            if ( $this->movedPage ) {
                $table->setMoveDetails( $this->movedPage );
            }
            if ( $this->ticket ) {
                $table->setTransactionTicket( $this->ticket );
            }
            if ( $this->revision ) {
                $table->setRevision( $this->revision );
            }
            $this->tables[$tableName] = $table;
        }
        return $this->tables[$tableName];
    }
 
    public function getAll() {
        foreach ( self::CORE_LIST as $tableName => $spec ) {
            yield $this->get( $tableName );
        }
        foreach ( $this->tempCollations as $tableName => $collation ) {
            yield $this->get( $tableName );
        }
    }
}