LinksUpdate.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Deferred\LinksUpdate;
 
use AutoCommitUpdate;
use BacklinkCache;
use DataUpdate;
use DeferredUpdates;
use DeprecationHelper;
use Job;
use JobQueueGroup;
use MediaWiki\HookContainer\ProtectedHookAccessorTrait;
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\MediaWikiServices;
use MediaWiki\Page\PageIdentity;
use MediaWiki\Page\PageReference;
use MediaWiki\Page\PageReferenceValue;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\User\UserIdentity;
use MWException;
use ParserOutput;
use RefreshLinksJob;
use RuntimeException;
use Title;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\ScopedCallback;
 
class LinksUpdate extends DataUpdate {
    use ProtectedHookAccessorTrait;
    use DeprecationHelper;
 
    // @todo make members protected, but make sure extensions don't break
 
    protected $mId;
 
    protected $mTitle;
 
    protected $mParserOutput;
 
    protected $mRecursive;
 
    private $mRevisionRecord;
 
    private $user;
 
    private $db;
 
    private $tableFactory;
 
    public function __construct( PageIdentity $page, ParserOutput $parserOutput, $recursive = true ) {
        parent::__construct();
 
        $this->mTitle = Title::castFromPageIdentity( $page );
        $this->mParserOutput = $parserOutput;
 
        $this->deprecatePublicProperty( 'mId', '1.38', __CLASS__ );
        $this->deprecatePublicProperty( 'mTitle', '1.38', __CLASS__ );
        $this->deprecatePublicProperty( 'mParserOutput', '1.38', __CLASS__ );
 
        $this->deprecatePublicPropertyFallback( 'mLinks', '1.38',
            function () {
                return $this->getParserOutput()->getLinks();
            },
            null, __CLASS__
        );
        $this->deprecatePublicPropertyFallback( 'mImages', '1.38',
            function () {
                return $this->getParserOutput()->getImages();
            },
            null, __CLASS__
        );
        $this->deprecatePublicPropertyFallback( 'mTemplates', '1.38',
            function () {
                return $this->getParserOutput()->getTemplates();
            },
            null, __CLASS__
        );
        $this->deprecatePublicPropertyFallback( 'mExternals', '1.38',
            function () {
                return $this->getParserOutput()->getExternalLinks();
            },
            null, __CLASS__
        );
        $this->deprecatePublicPropertyFallback( 'mCategories', '1.38',
            function () {
                return $this->getParserOutput()->getCategories();
            },
            null, __CLASS__
        );
        $this->deprecatePublicPropertyFallback( 'mProperties', '1.38',
            function () {
                return $this->getParserOutput()->getPageProperties();
            },
            null, __CLASS__
        );
        $this->deprecatePublicPropertyFallback( 'mInterwikis', '1.38',
            function () {
                return $this->getParserOutput()->getInterwikiLinks();
            },
            null, __CLASS__
        );
        $this->deprecatePublicPropertyFallback( 'mInterlangs', '1.38',
            function () {
                $ill = $this->getParserOutput()->getLanguageLinks();
                $res = [];
                foreach ( $ill as $link ) {
                    list( $key, $title ) = explode( ':', $link, 2 );
                    $res[$key] = $title;
                }
                return $res;
            },
            null, __CLASS__
        );
        $this->deprecatePublicPropertyFallback( 'mCategories', '1.38',
            function () {
                $cats = $this->getParserOutput()->getCategories();
                foreach ( $cats as &$sortkey ) {
                    # If the sortkey is longer then 255 bytes, it is truncated by DB, and then doesn't match
                    # when comparing existing vs current categories, causing T27254.
                    $sortkey = mb_strcut( $sortkey, 0, 255 );
                }
            },
            null, __CLASS__
        );
 
        $this->mRecursive = $recursive;
        $this->deprecatePublicProperty( 'mRecursive', '1.38', __CLASS__ );
 
        $services = MediaWikiServices::getInstance();
        $config = $services->getMainConfig();
        $this->tableFactory = new LinksTableGroup(
            $services->getObjectFactory(),
            $services->getDBLoadBalancerFactory(),
            $services->getCollationFactory(),
            $page,
            $config->get( 'UpdateRowsPerQuery' ),
            function ( $table, $rows ) {
                $this->getHookRunner()->onLinksUpdateAfterInsert( $this, $table, $rows );
            },
            $config->get( 'TempCategoryCollations' )
        );
        // TODO: this does not have to be called in LinksDeletionUpdate
        $this->tableFactory->setParserOutput( $parserOutput );
 
        $this->getHookRunner()->onLinksUpdateConstructed( $this );
    }
 
    public function setTransactionTicket( $ticket ) {
        parent::setTransactionTicket( $ticket );
        $this->tableFactory->setTransactionTicket( $ticket );
    }
 
    public function setMoveDetails( PageReference $oldPage ) {
        $this->tableFactory->setMoveDetails( $oldPage );
    }
 
    public function doUpdate() {
        if ( !$this->mId ) {
            // NOTE: subclasses may initialize mId directly!
            $this->mId = $this->mTitle->getArticleID( Title::READ_LATEST );
        }
 
        if ( !$this->mId ) {
            // Probably due to concurrent deletion or renaming of the page
            $logger = LoggerFactory::getInstance( 'SecondaryDataUpdate' );
            $logger->notice(
                'LinksUpdate: The Title object yields no ID. Perhaps the page was deleted?',
                [
                    'page_title' => $this->mTitle->getPrefixedDBkey(),
                    'cause_action' => $this->getCauseAction(),
                    'cause_agent' => $this->getCauseAgent()
                ]
            );
 
            // nothing to do
            return;
        }
 
        // Do any setup that needs to be done prior to acquiring the lock
        // Calling getAll() here has the side-effect of calling
        // LinksUpdateBatch::setParserOutput() on all subclasses, allowing
        // those methods to also do pre-lock operations.
        foreach ( $this->tableFactory->getAll() as $table ) {
            $table->beforeLock();
        }
 
        if ( $this->ticket ) {
            // Make sure all links update threads see the changes of each other.
            // This handles the case when updates have to batched into several COMMITs.
            $scopedLock = self::acquirePageLock( $this->getDB(), $this->mId );
            if ( !$scopedLock ) {
                throw new RuntimeException( "Could not acquire lock for page ID '{$this->mId}'." );
            }
        }
 
        $this->getHookRunner()->onLinksUpdate( $this );
        $this->doIncrementalUpdate();
 
        // Commit and release the lock (if set)
        ScopedCallback::consume( $scopedLock );
        // Run post-commit hook handlers without DBO_TRX
        DeferredUpdates::addUpdate( new AutoCommitUpdate(
            $this->getDB(),
            __METHOD__,
            function () {
                $this->getHookRunner()->onLinksUpdateComplete( $this, $this->ticket );
            }
        ) );
    }
 
    public static function acquirePageLock( IDatabase $dbw, $pageId, $why = 'atomicity' ) {
        $key = "{$dbw->getDomainID()}:LinksUpdate:$why:pageid:$pageId"; // per-wiki
        $scopedLock = $dbw->getScopedLockAndFlush( $key, __METHOD__, 15 );
        if ( !$scopedLock ) {
            $logger = LoggerFactory::getInstance( 'SecondaryDataUpdate' );
            $logger->info( "Could not acquire lock '{key}' for page ID '{page_id}'.", [
                'key' => $key,
                'page_id' => $pageId,
            ] );
            return null;
        }
 
        return $scopedLock;
    }
 
    protected function doIncrementalUpdate() {
        foreach ( $this->tableFactory->getAll() as $table ) {
            $table->update();
        }
 
        # Refresh links of all pages including this page
        # This will be in a separate transaction
        if ( $this->mRecursive ) {
            $this->queueRecursiveJobs();
        }
 
        # Update the links table freshness for this title
        $this->updateLinksTimestamp();
    }
 
    protected function queueRecursiveJobs() {
        $backlinkCache = MediaWikiServices::getInstance()->getBacklinkCacheFactory()
            ->getBacklinkCache( $this->mTitle );
        $action = $this->getCauseAction();
        $agent = $this->getCauseAgent();
 
        self::queueRecursiveJobsForTable(
            $this->mTitle, 'templatelinks', $action, $agent, $backlinkCache
        );
        if ( $this->mTitle->getNamespace() === NS_FILE ) {
            // Process imagelinks in case the title is or was a redirect
            self::queueRecursiveJobsForTable(
                $this->mTitle, 'imagelinks', $action, $agent, $backlinkCache
            );
        }
 
        // Get jobs for cascade-protected backlinks for a high priority queue.
        // If meta-templates change to using a new template, the new template
        // should be implicitly protected as soon as possible, if applicable.
        // These jobs duplicate a subset of the above ones, but can run sooner.
        // Which ever runs first generally no-ops the other one.
        $jobs = [];
        foreach ( $backlinkCache->getCascadeProtectedLinkPages() as $page ) {
            $jobs[] = RefreshLinksJob::newPrioritized(
                $page,
                [
                    'causeAction' => $action,
                    'causeAgent' => $agent
                ]
            );
        }
        JobQueueGroup::singleton()->push( $jobs );
    }
 
    public static function queueRecursiveJobsForTable(
        PageIdentity $page, $table, $action = 'unknown', $userName = 'unknown', ?BacklinkCache $backlinkCache = null
    ) {
        $title = Title::castFromPageIdentity( $page );
        if ( !$backlinkCache ) {
            wfDeprecatedMsg( __METHOD__ . " needs a BacklinkCache object, null passed", '1.37' );
            $backlinkCache = MediaWikiServices::getInstance()->getBacklinkCacheFactory()
                ->getBacklinkCache( $title );
        }
        if ( $backlinkCache->hasLinks( $table ) ) {
            $job = new RefreshLinksJob(
                $title,
                [
                    'table' => $table,
                    'recursive' => true,
                ] + Job::newRootJobParams( // "overall" refresh links job info
                    "refreshlinks:{$table}:{$title->getPrefixedText()}"
                ) + [ 'causeAction' => $action, 'causeAgent' => $userName ]
            );
 
            JobQueueGroup::singleton()->push( $job );
        }
    }
 
    public function setStrictTestMode( $mode = true ) {
        $this->tableFactory->setStrictTestMode( $mode );
    }
 
    public function getTitle() {
        return $this->mTitle;
    }
 
    public function getPageId() {
        if ( $this->mId ) {
            return $this->mId;
        } else {
            return $this->mTitle->getArticleID();
        }
    }
 
    public function getParserOutput() {
        return $this->mParserOutput;
    }
 
    public function getImages() {
        return $this->getParserOutput()->getImages();
    }
 
    public function setRevisionRecord( RevisionRecord $revisionRecord ) {
        $this->mRevisionRecord = $revisionRecord;
        $this->tableFactory->setRevision( $revisionRecord );
    }
 
    public function getRevisionRecord() {
        return $this->mRevisionRecord;
    }
 
    public function setTriggeringUser( UserIdentity $user ) {
        $this->user = $user;
    }
 
    public function getTriggeringUser(): ?UserIdentity {
        return $this->user;
    }
 
    protected function getPageLinksTable(): PageLinksTable {
        // @phan-suppress-next-line PhanTypeMismatchReturnSuperType
        return $this->tableFactory->get( 'pagelinks' );
    }
 
    protected function getExternalLinksTable(): ExternalLinksTable {
        // @phan-suppress-next-line PhanTypeMismatchReturnSuperType
        return $this->tableFactory->get( 'externallinks' );
    }
 
    protected function getPagePropsTable(): PagePropsTable {
        // @phan-suppress-next-line PhanTypeMismatchReturnSuperType
        return $this->tableFactory->get( 'page_props' );
    }
 
    public function getAddedLinks() {
        return $this->getPageLinksTable()->getTitleArray( LinksTable::INSERTED );
    }
 
    public function getRemovedLinks() {
        return $this->getPageLinksTable()->getTitleArray( LinksTable::DELETED );
    }
 
    public function getAddedExternalLinks() {
        return $this->getExternalLinksTable()->getStringArray( LinksTable::INSERTED );
    }
 
    public function getRemovedExternalLinks() {
        return $this->getExternalLinksTable()->getStringArray( LinksTable::DELETED );
    }
 
    public function getAddedProperties() {
        return $this->getPagePropsTable()->getAssocArray( LinksTable::INSERTED );
    }
 
    public function getRemovedProperties() {
        return $this->getPagePropsTable()->getAssocArray( LinksTable::DELETED );
    }
 
    public function getPageReferenceIterator( $tableName, $setType ) {
        $table = $this->tableFactory->get( $tableName );
        if ( $table instanceof TitleLinksTable ) {
            return $table->getPageReferenceIterator( $setType );
        } else {
            throw new \InvalidArgumentException(
                __METHOD__ . ": $tableName does not have a list of titles" );
        }
    }
 
    public function getPageReferenceArray( $tableName, $setType ) {
        return iterator_to_array( $this->getPageReferenceIterator( $tableName, $setType ) );
    }
 
    private function updateLinksTimestamp() {
        if ( $this->mId ) {
            // The link updates made here only reflect the freshness of the parser output
            $timestamp = $this->mParserOutput->getCacheTime();
            $this->getDB()->update( 'page',
                [ 'page_links_updated' => $this->getDB()->timestamp( $timestamp ) ],
                [ 'page_id' => $this->mId ],
                __METHOD__
            );
        }
    }
 
    protected function getDB() {
        if ( !$this->db ) {
            $this->db = wfGetDB( DB_PRIMARY );
        }
 
        return $this->db;
    }
 
    public function isRecursive() {
        return $this->mRecursive;
    }
}
 
class_alias( LinksUpdate::class, 'LinksUpdate' );