RevDelList.php

Go to the documentation of this file.

<?php
use MediaWiki\Page\PageIdentity;
use MediaWiki\Revision\RevisionRecord;
use Wikimedia\Rdbms\LBFactory;
 
abstract class RevDelList extends RevisionListBase {
 
    private $lbFactory;
 
    public function __construct(
        IContextSource $context,
        PageIdentity $page,
        array $ids,
        LBFactory $lbFactory
    ) {
        parent::__construct( $context, $page );
 
        // ids is a protected variable in RevisionListBase
        $this->ids = $ids;
        $this->lbFactory = $lbFactory;
    }
 
    public static function getRelationType() {
        return null;
    }
 
    public static function getRestriction() {
        return null;
    }
 
    public static function getRevdelConstant() {
        return null;
    }
 
    public static function suggestTarget( $target, array $ids ) {
        return $target;
    }
 
    public function areAnySuppressed() {
        $bit = $this->getSuppressBit();
 
        foreach ( $this as $item ) {
            if ( $item->getBits() & $bit ) {
                return true;
            }
        }
 
        return false;
    }
 
    public function setVisibility( array $params ) {
        $status = Status::newGood();
 
        $bitPars = $params['value'];
        $comment = $params['comment'];
        $perItemStatus = $params['perItemStatus'] ?? false;
 
        // CAS-style checks are done on the _deleted fields so the select
        // does not need to use FOR UPDATE nor be in the atomic section
        $dbw = $this->lbFactory->getMainLB()->getConnectionRef( DB_PRIMARY );
        $this->res = $this->doQuery( $dbw );
 
        $status->merge( $this->acquireItemLocks() );
        if ( !$status->isGood() ) {
            return $status;
        }
 
        $dbw->startAtomic( __METHOD__, $dbw::ATOMIC_CANCELABLE );
        $dbw->onTransactionResolution(
            function () {
                // Release locks on commit or error
                $this->releaseItemLocks();
            },
            __METHOD__
        );
 
        $missing = array_fill_keys( $this->ids, true );
        $this->clearFileOps();
        $idsForLog = [];
        $authorActors = [];
 
        if ( $perItemStatus ) {
            $status->itemStatuses = [];
        }
 
        // For multi-item deletions, set the old/new bitfields in log_params such that "hid X"
        // shows in logs if field X was hidden from ANY item and likewise for "unhid Y". Note the
        // form does not let the same field get hidden and unhidden in different items at once.
        $virtualOldBits = 0;
        $virtualNewBits = 0;
        $logType = 'delete';
 
        // Will be filled with id => [old, new bits] information and
        // passed to doPostCommitUpdates().
        $visibilityChangeMap = [];
 
        foreach ( $this as $item ) {
            unset( $missing[$item->getId()] );
 
            if ( $perItemStatus ) {
                $itemStatus = Status::newGood();
                $status->itemStatuses[$item->getId()] = $itemStatus;
            } else {
                $itemStatus = $status;
            }
 
            $oldBits = $item->getBits();
            // Build the actual new rev_deleted bitfield
            $newBits = RevisionDeleter::extractBitfield( $bitPars, $oldBits );
 
            if ( $oldBits == $newBits ) {
                $itemStatus->warning(
                    'revdelete-no-change', $item->formatDate(), $item->formatTime() );
                $status->failCount++;
                continue;
            } elseif ( $oldBits == 0 && $newBits != 0 ) {
                $opType = 'hide';
            } elseif ( $oldBits != 0 && $newBits == 0 ) {
                $opType = 'show';
            } else {
                $opType = 'modify';
            }
 
            if ( $item->isHideCurrentOp( $newBits ) ) {
                // Cannot hide current version text
                $itemStatus->error(
                    'revdelete-hide-current', $item->formatDate(), $item->formatTime() );
                $status->failCount++;
                continue;
            } elseif ( !$item->canView() ) {
                // Cannot access this revision
                $msg = ( $opType == 'show' ) ?
                    'revdelete-show-no-access' : 'revdelete-modify-no-access';
                $itemStatus->error( $msg, $item->formatDate(), $item->formatTime() );
                $status->failCount++;
                continue;
            // Cannot just "hide from Sysops" without hiding any fields
            } elseif ( $newBits == RevisionRecord::DELETED_RESTRICTED ) {
                $itemStatus->warning(
                    'revdelete-only-restricted', $item->formatDate(), $item->formatTime() );
                $status->failCount++;
                continue;
            }
 
            // Update the revision
            $ok = $item->setBits( $newBits );
 
            if ( $ok ) {
                $idsForLog[] = $item->getId();
                // If any item field was suppressed or unsuppressed
                if ( ( $oldBits | $newBits ) & $this->getSuppressBit() ) {
                    $logType = 'suppress';
                }
                // Track which fields where (un)hidden for each item
                $addedBits = ( $oldBits ^ $newBits ) & $newBits;
                $removedBits = ( $oldBits ^ $newBits ) & $oldBits;
                $virtualNewBits |= $addedBits;
                $virtualOldBits |= $removedBits;
 
                $status->successCount++;
                $authorActors[] = $item->getAuthorActor();
 
                // Save the old and new bits in $visibilityChangeMap for
                // later use.
                $visibilityChangeMap[$item->getId()] = [
                    'oldBits' => $oldBits,
                    'newBits' => $newBits,
                ];
            } else {
                $itemStatus->error(
                    'revdelete-concurrent-change', $item->formatDate(), $item->formatTime() );
                $status->failCount++;
            }
        }
 
        // Handle missing revisions
        foreach ( $missing as $id => $unused ) {
            if ( $perItemStatus ) {
                $status->itemStatuses[$id] = Status::newFatal( 'revdelete-modify-missing', $id );
            } else {
                $status->error( 'revdelete-modify-missing', $id );
            }
            $status->failCount++;
        }
 
        if ( $status->successCount == 0 ) {
            $dbw->endAtomic( __METHOD__ );
            return $status;
        }
 
        // Save success count
        $successCount = $status->successCount;
 
        // Move files, if there are any
        $status->merge( $this->doPreCommitUpdates() );
        if ( !$status->isOK() ) {
            // Fatal error, such as no configured archive directory or I/O failures
            $dbw->cancelAtomic( __METHOD__ );
            return $status;
        }
 
        // Log it
        $authorFields = [];
        $authorFields['authorActors'] = $authorActors;
        $this->updateLog(
            $logType,
            [
                'page' => $this->page,
                'count' => $successCount,
                'newBits' => $virtualNewBits,
                'oldBits' => $virtualOldBits,
                'comment' => $comment,
                'ids' => $idsForLog,
                'tags' => $params['tags'] ?? [],
            ] + $authorFields
        );
 
        // Clear caches after commit
        DeferredUpdates::addCallableUpdate(
            function () use ( $visibilityChangeMap ) {
                $this->doPostCommitUpdates( $visibilityChangeMap );
            },
            DeferredUpdates::PRESEND,
            $dbw
        );
 
        $dbw->endAtomic( __METHOD__ );
 
        return $status;
    }
 
    final protected function acquireItemLocks() {
        $status = Status::newGood();
        foreach ( $this as $item ) {
            $status->merge( $item->lock() );
        }
 
        return $status;
    }
 
    final protected function releaseItemLocks() {
        $status = Status::newGood();
        foreach ( $this as $item ) {
            $status->merge( $item->unlock() );
        }
 
        return $status;
    }
 
    public function reloadFromPrimary() {
        $dbw = $this->lbFactory->getMainLB()->getConnectionRef( DB_PRIMARY );
        $this->res = $this->doQuery( $dbw );
    }
 
    public function reloadFromMaster() {
        wfDeprecated( __METHOD__, '1.37' );
        $this->reloadFromPrimary();
    }
 
    private function updateLog( $logType, $params ) {
        // Get the URL param's corresponding DB field
        $field = RevisionDeleter::getRelationType( $this->getType() );
        if ( !$field ) {
            throw new MWException( "Bad log URL param type!" );
        }
        // Add params for affected page and ids
        $logParams = $this->getLogParams( $params );
        // Actually add the deletion log entry
        $logEntry = new ManualLogEntry( $logType, $this->getLogAction() );
        $logEntry->setTarget( $params['page'] );
        $logEntry->setComment( $params['comment'] );
        $logEntry->setParameters( $logParams );
        $logEntry->setPerformer( $this->getUser() );
        // Allow for easy searching of deletion log items for revision/log items
        $relations = [
            $field => $params['ids'],
        ];
        if ( isset( $params['authorActors'] ) ) {
            $relations += [
                'target_author_actor' => $params['authorActors'],
            ];
        }
        $logEntry->setRelations( $relations );
        // Apply change tags to the log entry
        $logEntry->addTags( $params['tags'] );
        $logId = $logEntry->insert();
        $logEntry->publish( $logId );
    }
 
    public function getLogAction() {
        return 'revision';
    }
 
    public function getLogParams( $params ) {
        return [
            '4::type' => $this->getType(),
            '5::ids' => $params['ids'],
            '6::ofield' => $params['oldBits'],
            '7::nfield' => $params['newBits'],
        ];
    }
 
    public function clearFileOps() {
    }
 
    public function doPreCommitUpdates() {
        return Status::newGood();
    }
 
    public function doPostCommitUpdates( array $visibilityChangeMap ) {
        return Status::newGood();
    }
 
    abstract public function getSuppressBit();
}