RevDelRevisionList.php

Go to the documentation of this file.

<?php
namespace MediaWiki\RevisionDelete;
 
use InvalidArgumentException;
use MediaWiki\Cache\HTMLCacheUpdater;
use MediaWiki\ChangeTags\ChangeTagsFormatter;
use MediaWiki\Context\IContextSource;
use MediaWiki\DomainEvent\DomainEventDispatcher;
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\Logging\LogEntry;
use MediaWiki\MediaWikiServices;
use MediaWiki\Page\Event\PageHistoryVisibilityChangedEvent;
use MediaWiki\Page\PageIdentity;
use MediaWiki\Page\ProperPageIdentity;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Revision\RevisionStore;
use MediaWiki\Status\Status;
use MediaWiki\Title\Title;
use Wikimedia\Rdbms\FakeResultWrapper;
use Wikimedia\Rdbms\IResultWrapper;
use Wikimedia\Rdbms\LBFactory;
 
class RevDelRevisionList extends RevDelList {
 
    private $hookRunner;
 
    public $currentRevId;
 
    public function __construct(
        IContextSource $context,
        PageIdentity $page,
        array $ids,
        private readonly LBFactory $lbFactory,
        HookContainer $hookContainer,
        private readonly HTMLCacheUpdater $htmlCacheUpdater,
        private readonly RevisionStore $revisionStore,
        private readonly DomainEventDispatcher $eventDispatcher,
        private readonly ChangeTagsFormatter $changeTagsFormatter,
    ) {
        parent::__construct( $context, $page, $ids, $this->lbFactory );
        $this->hookRunner = new HookRunner( $hookContainer );
    }
 
    public function getType() {
        return 'revision';
    }
 
    public static function getRelationType() {
        return 'rev_id';
    }
 
    public static function getRestriction() {
        return 'deleterevision';
    }
 
    public static function getRevdelConstant() {
        return RevisionRecord::DELETED_TEXT;
    }
 
    public static function suggestTarget( $target, array $ids ) {
        $revisionRecord = MediaWikiServices::getInstance()
            ->getRevisionLookup()
            ->getRevisionById( $ids[0] );
 
        if ( $revisionRecord ) {
            return Title::newFromPageIdentity( $revisionRecord->getPage() );
        }
        return $target;
    }
 
    public function doQuery( $db ) {
        $ids = array_map( 'intval', $this->ids );
        $queryBuilder = $this->revisionStore->newSelectQueryBuilder( $db )
            ->joinComment()
            ->joinUser()
            ->joinPage()
            ->where( [ 'rev_page' => $this->page->getId(), 'rev_id' => $ids ] )
            ->orderBy( 'rev_id', \Wikimedia\Rdbms\SelectQueryBuilder::SORT_DESC )
            // workaround for MySQL bug (T104313)
            ->useIndex( [ 'revision' => 'PRIMARY' ] );
 
        MediaWikiServices::getInstance()->getChangeTagsStore()->modifyDisplayQueryBuilder( $queryBuilder, 'revision' );
 
        $live = $queryBuilder->caller( __METHOD__ )->fetchResultSet();
        if ( $live->numRows() >= count( $ids ) ) {
            // All requested revisions are live, keeps things simple!
            return $live;
        }
 
        $queryBuilder = $this->revisionStore->newArchiveSelectQueryBuilder( $db )
            ->joinComment()
            ->where( [ 'ar_rev_id' => $ids ] )
            ->orderBy( 'ar_rev_id', \Wikimedia\Rdbms\SelectQueryBuilder::SORT_DESC );
 
        MediaWikiServices::getInstance()->getChangeTagsStore()->modifyDisplayQueryBuilder( $queryBuilder, 'archive' );
 
        // Check if any requested revisions are available fully deleted.
        $archived = $queryBuilder->caller( __METHOD__ )->fetchResultSet();
 
        if ( $archived->numRows() == 0 ) {
            return $live;
        } elseif ( $live->numRows() == 0 ) {
            return $archived;
        } else {
            // Combine the two! Whee
            $rows = [];
            foreach ( $live as $row ) {
                $rows[$row->rev_id] = $row;
            }
            foreach ( $archived as $row ) {
                $rows[$row->ar_rev_id] = $row;
            }
            krsort( $rows );
            return new FakeResultWrapper( array_values( $rows ) );
        }
    }
 
    public function newItem( $row ) {
        if ( isset( $row->rev_id ) ) {
            return new RevDelRevisionItem( $this, $row, $this->changeTagsFormatter );
        } elseif ( isset( $row->ar_rev_id ) ) {
            return new RevDelArchivedRevisionItem( $this, $row, $this->lbFactory, $this->changeTagsFormatter );
        } else {
            // This shouldn't happen. :)
            throw new InvalidArgumentException( 'Invalid row type in RevDelRevisionList' );
        }
    }
 
    public function getCurrent() {
        if ( $this->currentRevId === null ) {
            $dbw = $this->lbFactory->getPrimaryDatabase();
            $this->currentRevId = $dbw->newSelectQueryBuilder()
                ->select( 'page_latest' )
                ->from( 'page' )
                ->where( [ 'page_namespace' => $this->page->getNamespace(), 'page_title' => $this->page->getDBkey() ] )
                ->caller( __METHOD__ )->fetchField();
        }
        return $this->currentRevId;
    }
 
    protected function emitEvents(
        array $bitPars,
        array $visibilityChangeMap,
        array $tags,
        LogEntry $logEntry,
        bool $suppressed
    ) {
        // Figure out which bits got set, and which got unset.
        $bitsSet = RevisionDeleter::extractBitfield( $bitPars, 0 );
        $bitsUnset = RevisionRecord::SUPPRESSED_ALL &
            ( ~ RevisionDeleter::extractBitfield( $bitPars, RevisionRecord::SUPPRESSED_ALL ) );
 
        $page = $this->getPage();
        $performer = $this->getUser();
 
        // Hack: make sure we have a *proper* PageIdentity
        if ( !$page instanceof ProperPageIdentity ) {
            if ( !$page instanceof Title ) {
                $page = Title::newFromPageIdentity( $page );
            }
 
            $page = $page->toPageIdentity();
        }
 
        $flags = [
            PageHistoryVisibilityChangedEvent::FLAG_SUPPRESSED => $suppressed
        ];
 
        $this->eventDispatcher->dispatch(
            new PageHistoryVisibilityChangedEvent(
                $page,
                $performer,
                $this->getCurrent(),
                $bitsSet,
                $bitsUnset,
                $visibilityChangeMap,
                $logEntry->getComment(),
                $tags,
                $flags,
                $logEntry->getTimestamp()
            ),
            $this->lbFactory
        );
    }
 
    public function doPreCommitUpdates() {
        Title::newFromPageIdentity( $this->page )->invalidateCache();
        return Status::newGood();
    }
 
    public function doPostCommitUpdates( array $visibilityChangeMap ) {
        $this->htmlCacheUpdater->purgeTitleUrls(
            $this->page,
            HTMLCacheUpdater::PURGE_INTENT_TXROUND_REFLECTED
        );
        // Extensions that require referencing previous revisions may need this
        $this->hookRunner->onArticleRevisionVisibilitySet(
            Title::newFromPageIdentity( $this->page ),
            $this->ids,
            $visibilityChangeMap
        );
 
        return Status::newGood();
    }
}
 
class_alias( RevDelRevisionList::class, 'RevDelRevisionList' );