RevDelFileList.php

Go to the documentation of this file.

<?php
namespace MediaWiki\RevisionDelete;
 
use MediaWiki\Cache\HTMLCacheUpdater;
use MediaWiki\Context\IContextSource;
use MediaWiki\FileRepo\File\File;
use MediaWiki\FileRepo\File\FileSelectQueryBuilder;
use MediaWiki\FileRepo\FileRepo;
use MediaWiki\FileRepo\RepoGroup;
use MediaWiki\Page\PageIdentity;
use MediaWiki\Status\Status;
use Wikimedia\Rdbms\IReadableDatabase;
use Wikimedia\Rdbms\IResultWrapper;
use Wikimedia\Rdbms\LBFactory;
use Wikimedia\Rdbms\SelectQueryBuilder;
 
class RevDelFileList extends RevDelList {
 
    protected const SUPPRESS_BIT = File::DELETED_RESTRICTED;
 
    private $htmlCacheUpdater;
 
    private $repoGroup;
 
    public $storeBatch;
 
    public $deleteBatch;
 
    public $cleanupBatch;
 
    public function __construct(
        IContextSource $context,
        PageIdentity $page,
        array $ids,
        LBFactory $lbFactory,
        HTMLCacheUpdater $htmlCacheUpdater,
        RepoGroup $repoGroup
    ) {
        parent::__construct( $context, $page, $ids, $lbFactory );
        $this->htmlCacheUpdater = $htmlCacheUpdater;
        $this->repoGroup = $repoGroup;
    }
 
    public function getType() {
        return 'oldimage';
    }
 
    public static function getRelationType() {
        return 'oi_archive_name';
    }
 
    public static function getRestriction() {
        return 'deleterevision';
    }
 
    public static function getRevdelConstant() {
        return File::DELETED_FILE;
    }
 
    public function doQuery( $db ) {
        $archiveNames = [];
        foreach ( $this->ids as $timestamp ) {
            $archiveNames[] = $timestamp . '!' . $this->page->getDBkey();
        }
 
        $queryBuilder = FileSelectQueryBuilder::newForOldFile( $db );
        $queryBuilder
            ->where( [ 'oi_name' => $this->page->getDBkey(), 'oi_archive_name' => $archiveNames ] )
            ->orderBy( 'oi_timestamp', SelectQueryBuilder::SORT_DESC );
        return $queryBuilder->caller( __METHOD__ )->fetchResultSet();
    }
 
    public function newItem( $row ) {
        return new RevDelFileItem( $this, $row );
    }
 
    public function clearFileOps() {
        $this->deleteBatch = [];
        $this->storeBatch = [];
        $this->cleanupBatch = [];
    }
 
    public function doPreCommitUpdates() {
        $status = Status::newGood();
        $repo = $this->repoGroup->getLocalRepo();
        if ( $this->storeBatch ) {
            $status->merge( $repo->storeBatch( $this->storeBatch, FileRepo::OVERWRITE_SAME ) );
        }
        if ( !$status->isOK() ) {
            return $status;
        }
        if ( $this->deleteBatch ) {
            $status->merge( $repo->deleteBatch( $this->deleteBatch ) );
        }
        if ( !$status->isOK() ) {
            // Running cleanupDeletedBatch() after a failed storeBatch() with the DB already
            // modified (but destined for rollback) causes data loss
            return $status;
        }
        if ( $this->cleanupBatch ) {
            $status->merge( $repo->cleanupDeletedBatch( $this->cleanupBatch ) );
        }
 
        return $status;
    }
 
    public function doPostCommitUpdates( array $visibilityChangeMap ) {
        $file = $this->repoGroup->getLocalRepo()->newFile( $this->page );
        $file->purgeCache();
        $file->purgeDescription();
 
        // Purge full images from cache
        $purgeUrls = [];
        foreach ( $this->ids as $timestamp ) {
            $archiveName = $timestamp . '!' . $this->page->getDBkey();
            $file->purgeOldThumbnails( $archiveName );
            $purgeUrls[] = $file->getArchiveUrl( $archiveName );
        }
 
        $this->htmlCacheUpdater->purgeUrls(
            $purgeUrls,
            HTMLCacheUpdater::PURGE_INTENT_TXROUND_REFLECTED
        );
 
        return Status::newGood();
    }
 
}
 
class_alias( RevDelFileList::class, 'RevDelFileList' );