BlockRestrictionStore.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Block;
 
use MediaWiki\Block\Restriction\ActionRestriction;
use MediaWiki\Block\Restriction\NamespaceRestriction;
use MediaWiki\Block\Restriction\PageRestriction;
use MediaWiki\Block\Restriction\Restriction;
use MediaWiki\DAO\WikiAwareEntity;
use stdClass;
use Wikimedia\Rdbms\IConnectionProvider;
use Wikimedia\Rdbms\IResultWrapper;
 
class BlockRestrictionStore {
 
    private IConnectionProvider $dbProvider;
 
    private string|false $wikiId;
 
    public function __construct(
        IConnectionProvider $dbProvider,
        string|false $wikiId = WikiAwareEntity::LOCAL
    ) {
        $this->dbProvider = $dbProvider;
        $this->wikiId = $wikiId;
    }
 
    public function loadByBlockId( $blockId ) {
        if ( $blockId === null || $blockId === [] ) {
            return [];
        }
 
        $result = $this->dbProvider->getReplicaDatabase( $this->wikiId )
            ->newSelectQueryBuilder()
            ->select( [ 'ir_ipb_id', 'ir_type', 'ir_value', 'page_namespace', 'page_title' ] )
            ->from( 'ipblocks_restrictions' )
            ->leftJoin( 'page', null, [ 'ir_type' => PageRestriction::TYPE_ID, 'ir_value=page_id' ] )
            ->where( [ 'ir_ipb_id' => $blockId ] )
            ->caller( __METHOD__ )->fetchResultSet();
 
        return $this->resultToRestrictions( $result );
    }
 
    public function insert( array $restrictions ) {
        if ( !$restrictions ) {
            return false;
        }
 
        $rows = [];
        foreach ( $restrictions as $restriction ) {
            $rows[] = $restriction->toRow();
        }
 
        $dbw = $this->dbProvider->getPrimaryDatabase( $this->wikiId );
 
        $dbw->newInsertQueryBuilder()
            ->insertInto( 'ipblocks_restrictions' )
            ->ignore()
            ->rows( $rows )
            ->caller( __METHOD__ )->execute();
 
        return true;
    }
 
    public function update( array $restrictions ) {
        $dbw = $this->dbProvider->getPrimaryDatabase( $this->wikiId );
 
        $dbw->startAtomic( __METHOD__ );
 
        // Organize the restrictions by block ID.
        $restrictionList = $this->restrictionsByBlockId( $restrictions );
 
        // Load the existing restrictions and organize by block ID. Any block IDs
        // that were passed into this function will be used to load all of the
        // existing restrictions. This list might be the same, or may be completely
        // different.
        $existingList = [];
        $blockIds = array_keys( $restrictionList );
        if ( $blockIds ) {
            $result = $dbw->newSelectQueryBuilder()
                ->select( [ 'ir_ipb_id', 'ir_type', 'ir_value' ] )
                ->forUpdate()
                ->from( 'ipblocks_restrictions' )
                ->where( [ 'ir_ipb_id' => $blockIds ] )
                ->caller( __METHOD__ )->fetchResultSet();
 
            $existingList = $this->restrictionsByBlockId(
                $this->resultToRestrictions( $result )
            );
        }
 
        $result = true;
        // Perform the actions on a per block-ID basis.
        foreach ( $restrictionList as $blockId => $blockRestrictions ) {
            // Insert all of the restrictions first, ignoring ones that already exist.
            $success = $this->insert( $blockRestrictions );
 
            $result = $success && $result;
 
            $restrictionsToRemove = $this->restrictionsToRemove(
                $existingList[$blockId] ?? [],
                $restrictions
            );
 
            if ( !$restrictionsToRemove ) {
                continue;
            }
 
            $success = $this->delete( $restrictionsToRemove );
 
            $result = $success && $result;
        }
 
        $dbw->endAtomic( __METHOD__ );
 
        return $result;
    }
 
    public function updateByParentBlockId( $parentBlockId, array $restrictions ) {
        $parentBlockId = (int)$parentBlockId;
 
        $db = $this->dbProvider->getPrimaryDatabase( $this->wikiId );
 
        $blockIds = $db->newSelectQueryBuilder()
            ->select( 'bl_id' )
            ->forUpdate()
            ->from( 'block' )
            ->where( [ 'bl_parent_block_id' => $parentBlockId ] )
            ->caller( __METHOD__ )->fetchFieldValues();
        if ( !$blockIds ) {
            return true;
        }
 
        // If removing all of the restrictions, then just delete them all.
        if ( !$restrictions ) {
            $blockIds = array_map( 'intval', $blockIds );
            return $this->deleteByBlockId( $blockIds );
        }
 
        $db->startAtomic( __METHOD__ );
 
        $result = true;
        foreach ( $blockIds as $id ) {
            $success = $this->update( $this->setBlockId( $id, $restrictions ) );
            $result = $success && $result;
        }
 
        $db->endAtomic( __METHOD__ );
 
        return $result;
    }
 
    public function delete( array $restrictions ) {
        $dbw = $this->dbProvider->getPrimaryDatabase( $this->wikiId );
        foreach ( $restrictions as $restriction ) {
            $dbw->newDeleteQueryBuilder()
                ->deleteFrom( 'ipblocks_restrictions' )
                // The restriction row is made up of a compound primary key. Therefore,
                // the row and the delete conditions are the same.
                ->where( $restriction->toRow() )
                ->caller( __METHOD__ )->execute();
        }
 
        return true;
    }
 
    public function deleteByBlockId( $blockId ) {
        $this->dbProvider->getPrimaryDatabase( $this->wikiId )
            ->newDeleteQueryBuilder()
            ->deleteFrom( 'ipblocks_restrictions' )
            ->where( [ 'ir_ipb_id' => $blockId ] )
            ->caller( __METHOD__ )->execute();
        return true;
    }
 
    public function equals( array $a, array $b ) {
        $aCount = count( $a );
        $bCount = count( $b );
 
        // If the count is different, then they are obviously a different set.
        if ( $aCount !== $bCount ) {
            return false;
        }
 
        // If both sets contain no items, then they are the same set.
        if ( $aCount === 0 && $bCount === 0 ) {
            return true;
        }
 
        $hasher = static fn ( Restriction $r ) => $r->getHash();
 
        $aHashes = array_map( $hasher, $a );
        $bHashes = array_map( $hasher, $b );
 
        sort( $aHashes );
        sort( $bHashes );
 
        return $aHashes === $bHashes;
    }
 
    public function setBlockId( $blockId, array $restrictions ) {
        $blockRestrictions = [];
 
        foreach ( $restrictions as $restriction ) {
            // Clone the restriction so any references to the current restriction are
            // not suddenly changed to a different blockId.
            $restriction = clone $restriction;
            $restriction->setBlockId( $blockId );
 
            $blockRestrictions[] = $restriction;
        }
 
        return $blockRestrictions;
    }
 
    private function restrictionsToRemove( array $existing, array $new ) {
        $restrictionsByHash = [];
        foreach ( $existing as $restriction ) {
            $restrictionsByHash[$restriction->getHash()] = $restriction;
        }
        foreach ( $new as $restriction ) {
            unset( $restrictionsByHash[$restriction->getHash()] );
        }
        return array_values( $restrictionsByHash );
    }
 
    private function restrictionsByBlockId( array $restrictions ) {
        $blockRestrictions = [];
 
        foreach ( $restrictions as $restriction ) {
            $blockRestrictions[$restriction->getBlockId()][] = $restriction;
        }
 
        return $blockRestrictions;
    }
 
    private function resultToRestrictions( IResultWrapper $result ) {
        $restrictions = [];
        foreach ( $result as $row ) {
            $restriction = $this->rowToRestriction( $row );
 
            if ( !$restriction ) {
                continue;
            }
 
            $restrictions[] = $restriction;
        }
 
        return $restrictions;
    }
 
    private function rowToRestriction( stdClass $row ) {
        switch ( (int)$row->ir_type ) {
            case PageRestriction::TYPE_ID:
                return PageRestriction::newFromRow( $row );
            case NamespaceRestriction::TYPE_ID:
                return NamespaceRestriction::newFromRow( $row );
            case ActionRestriction::TYPE_ID:
                return ActionRestriction::newFromRow( $row );
            default:
                return null;
        }
    }
}