Block.php

Go to the documentation of this file.

<?php
use Wikimedia\Rdbms\Database;
use Wikimedia\Rdbms\IDatabase;
use MediaWiki\MediaWikiServices;
 
class Block {
    public $mReason;
 
    public $mTimestamp;
 
    public $mAuto;
 
    public $mExpiry;
 
    public $mHideName;
 
    public $mParentBlockId;
 
    private $mId;
 
    private $mFromMaster;
 
    private $mBlockEmail;
 
    private $mDisableUsertalk;
 
    private $mCreateAccount;
 
    private $target;
 
    private $forcedTargetID;
 
    private $type;
 
    private $blocker;
 
    private $isHardblock;
 
    private $isAutoblocking;
 
    private $systemBlockType;
 
    # TYPE constants
    const TYPE_USER = 1;
    const TYPE_IP = 2;
    const TYPE_RANGE = 3;
    const TYPE_AUTO = 4;
    const TYPE_ID = 5;
 
    function __construct( $options = [] ) {
        $defaults = [
            'address'         => '',
            'user'            => null,
            'by'              => null,
            'reason'          => '',
            'timestamp'       => '',
            'auto'            => false,
            'expiry'          => '',
            'anonOnly'        => false,
            'createAccount'   => false,
            'enableAutoblock' => false,
            'hideName'        => false,
            'blockEmail'      => false,
            'allowUsertalk'   => false,
            'byText'          => '',
            'systemBlock'     => null,
        ];
 
        if ( func_num_args() > 1 || !is_array( $options ) ) {
            $options = array_combine(
                array_slice( array_keys( $defaults ), 0, func_num_args() ),
                func_get_args()
            );
            wfDeprecated( __METHOD__ . ' with multiple arguments', '1.26' );
        }
 
        $options += $defaults;
 
        $this->setTarget( $options['address'] );
 
        if ( $this->target instanceof User && $options['user'] ) {
            # Needed for foreign users
            $this->forcedTargetID = $options['user'];
        }
 
        if ( $options['by'] ) {
            # Local user
            $this->setBlocker( User::newFromId( $options['by'] ) );
        } else {
            # Foreign user
            $this->setBlocker( $options['byText'] );
        }
 
        $this->mReason = $options['reason'];
        $this->mTimestamp = wfTimestamp( TS_MW, $options['timestamp'] );
        $this->mExpiry = wfGetDB( DB_REPLICA )->decodeExpiry( $options['expiry'] );
 
        # Boolean settings
        $this->mAuto = (bool)$options['auto'];
        $this->mHideName = (bool)$options['hideName'];
        $this->isHardblock( !$options['anonOnly'] );
        $this->isAutoblocking( (bool)$options['enableAutoblock'] );
 
        # Prevention measures
        $this->prevents( 'sendemail', (bool)$options['blockEmail'] );
        $this->prevents( 'editownusertalk', !$options['allowUsertalk'] );
        $this->prevents( 'createaccount', (bool)$options['createAccount'] );
 
        $this->mFromMaster = false;
        $this->systemBlockType = $options['systemBlock'];
    }
 
    public static function newFromID( $id ) {
        $dbr = wfGetDB( DB_REPLICA );
        $blockQuery = self::getQueryInfo();
        $res = $dbr->selectRow(
            $blockQuery['tables'],
            $blockQuery['fields'],
            [ 'ipb_id' => $id ],
            __METHOD__,
            [],
            $blockQuery['joins']
        );
        if ( $res ) {
            return self::newFromRow( $res );
        } else {
            return null;
        }
    }
 
    public static function selectFields() {
        global $wgActorTableSchemaMigrationStage;
 
        if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW ) {
            // If code is using this instead of self::getQueryInfo(), there's a
            // decent chance it's going to try to directly access
            // $row->ipb_by or $row->ipb_by_text and we can't give it
            // useful values here once those aren't being used anymore.
            throw new BadMethodCallException(
                'Cannot use ' . __METHOD__
                    . ' when $wgActorTableSchemaMigrationStage has SCHEMA_COMPAT_READ_NEW'
            );
        }
 
        wfDeprecated( __METHOD__, '1.31' );
        return [
            'ipb_id',
            'ipb_address',
            'ipb_by',
            'ipb_by_text',
            'ipb_by_actor' => 'NULL',
            'ipb_timestamp',
            'ipb_auto',
            'ipb_anon_only',
            'ipb_create_account',
            'ipb_enable_autoblock',
            'ipb_expiry',
            'ipb_deleted',
            'ipb_block_email',
            'ipb_allow_usertalk',
            'ipb_parent_block_id',
        ] + CommentStore::getStore()->getFields( 'ipb_reason' );
    }
 
    public static function getQueryInfo() {
        $commentQuery = CommentStore::getStore()->getJoin( 'ipb_reason' );
        $actorQuery = ActorMigration::newMigration()->getJoin( 'ipb_by' );
        return [
            'tables' => [ 'ipblocks' ] + $commentQuery['tables'] + $actorQuery['tables'],
            'fields' => [
                'ipb_id',
                'ipb_address',
                'ipb_timestamp',
                'ipb_auto',
                'ipb_anon_only',
                'ipb_create_account',
                'ipb_enable_autoblock',
                'ipb_expiry',
                'ipb_deleted',
                'ipb_block_email',
                'ipb_allow_usertalk',
                'ipb_parent_block_id',
            ] + $commentQuery['fields'] + $actorQuery['fields'],
            'joins' => $commentQuery['joins'] + $actorQuery['joins'],
        ];
    }
 
    public function equals( Block $block ) {
        return (
            (string)$this->target == (string)$block->target
            && $this->type == $block->type
            && $this->mAuto == $block->mAuto
            && $this->isHardblock() == $block->isHardblock()
            && $this->prevents( 'createaccount' ) == $block->prevents( 'createaccount' )
            && $this->mExpiry == $block->mExpiry
            && $this->isAutoblocking() == $block->isAutoblocking()
            && $this->mHideName == $block->mHideName
            && $this->prevents( 'sendemail' ) == $block->prevents( 'sendemail' )
            && $this->prevents( 'editownusertalk' ) == $block->prevents( 'editownusertalk' )
            && $this->mReason == $block->mReason
        );
    }
 
    protected function newLoad( $vagueTarget = null ) {
        $db = wfGetDB( $this->mFromMaster ? DB_MASTER : DB_REPLICA );
 
        if ( $this->type !== null ) {
            $conds = [
                'ipb_address' => [ (string)$this->target ],
            ];
        } else {
            $conds = [ 'ipb_address' => [] ];
        }
 
        # Be aware that the != '' check is explicit, since empty values will be
        # passed by some callers (T31116)
        if ( $vagueTarget != '' ) {
            list( $target, $type ) = self::parseTarget( $vagueTarget );
            switch ( $type ) {
                case self::TYPE_USER:
                    # Slightly weird, but who are we to argue?
                    $conds['ipb_address'][] = (string)$target;
                    break;
 
                case self::TYPE_IP:
                    $conds['ipb_address'][] = (string)$target;
                    $conds[] = self::getRangeCond( IP::toHex( $target ) );
                    $conds = $db->makeList( $conds, LIST_OR );
                    break;
 
                case self::TYPE_RANGE:
                    list( $start, $end ) = IP::parseRange( $target );
                    $conds['ipb_address'][] = (string)$target;
                    $conds[] = self::getRangeCond( $start, $end );
                    $conds = $db->makeList( $conds, LIST_OR );
                    break;
 
                default:
                    throw new MWException( "Tried to load block with invalid type" );
            }
        }
 
        $blockQuery = self::getQueryInfo();
        $res = $db->select(
            $blockQuery['tables'], $blockQuery['fields'], $conds, __METHOD__, [], $blockQuery['joins']
        );
 
        # This result could contain a block on the user, a block on the IP, and a russian-doll
        # set of rangeblocks.  We want to choose the most specific one, so keep a leader board.
        $bestRow = null;
 
        # Lower will be better
        $bestBlockScore = 100;
 
        # This is begging for $this = $bestBlock, but that's not allowed in PHP :(
        $bestBlockPreventsEdit = null;
 
        foreach ( $res as $row ) {
            $block = self::newFromRow( $row );
 
            # Don't use expired blocks
            if ( $block->isExpired() ) {
                continue;
            }
 
            # Don't use anon only blocks on users
            if ( $this->type == self::TYPE_USER && !$block->isHardblock() ) {
                continue;
            }
 
            if ( $block->getType() == self::TYPE_RANGE ) {
                # This is the number of bits that are allowed to vary in the block, give
                # or take some floating point errors
                $end = Wikimedia\base_convert( $block->getRangeEnd(), 16, 10 );
                $start = Wikimedia\base_convert( $block->getRangeStart(), 16, 10 );
                $size = log( $end - $start + 1, 2 );
 
                # This has the nice property that a /32 block is ranked equally with a
                # single-IP block, which is exactly what it is...
                $score = self::TYPE_RANGE - 1 + ( $size / 128 );
 
            } else {
                $score = $block->getType();
            }
 
            if ( $score < $bestBlockScore ) {
                $bestBlockScore = $score;
                $bestRow = $row;
                $bestBlockPreventsEdit = $block->prevents( 'edit' );
            }
        }
 
        if ( $bestRow !== null ) {
            $this->initFromRow( $bestRow );
            $this->prevents( 'edit', $bestBlockPreventsEdit );
            return true;
        } else {
            return false;
        }
    }
 
    public static function getRangeCond( $start, $end = null ) {
        if ( $end === null ) {
            $end = $start;
        }
        # Per T16634, we want to include relevant active rangeblocks; for
        # rangeblocks, we want to include larger ranges which enclose the given
        # range. We know that all blocks must be smaller than $wgBlockCIDRLimit,
        # so we can improve performance by filtering on a LIKE clause
        $chunk = self::getIpFragment( $start );
        $dbr = wfGetDB( DB_REPLICA );
        $like = $dbr->buildLike( $chunk, $dbr->anyString() );
 
        # Fairly hard to make a malicious SQL statement out of hex characters,
        # but stranger things have happened...
        $safeStart = $dbr->addQuotes( $start );
        $safeEnd = $dbr->addQuotes( $end );
 
        return $dbr->makeList(
            [
                "ipb_range_start $like",
                "ipb_range_start <= $safeStart",
                "ipb_range_end >= $safeEnd",
            ],
            LIST_AND
        );
    }
 
    protected static function getIpFragment( $hex ) {
        global $wgBlockCIDRLimit;
        if ( substr( $hex, 0, 3 ) == 'v6-' ) {
            return 'v6-' . substr( substr( $hex, 3 ), 0, floor( $wgBlockCIDRLimit['IPv6'] / 4 ) );
        } else {
            return substr( $hex, 0, floor( $wgBlockCIDRLimit['IPv4'] / 4 ) );
        }
    }
 
    protected function initFromRow( $row ) {
        $this->setTarget( $row->ipb_address );
        $this->setBlocker( User::newFromAnyId(
            $row->ipb_by, $row->ipb_by_text, $row->ipb_by_actor ?? null
        ) );
 
        $this->mTimestamp = wfTimestamp( TS_MW, $row->ipb_timestamp );
        $this->mAuto = $row->ipb_auto;
        $this->mHideName = $row->ipb_deleted;
        $this->mId = (int)$row->ipb_id;
        $this->mParentBlockId = $row->ipb_parent_block_id;
 
        // I wish I didn't have to do this
        $db = wfGetDB( DB_REPLICA );
        $this->mExpiry = $db->decodeExpiry( $row->ipb_expiry );
        $this->mReason = CommentStore::getStore()
            // Legacy because $row may have come from self::selectFields()
            ->getCommentLegacy( $db, 'ipb_reason', $row )->text;
 
        $this->isHardblock( !$row->ipb_anon_only );
        $this->isAutoblocking( $row->ipb_enable_autoblock );
 
        $this->prevents( 'createaccount', $row->ipb_create_account );
        $this->prevents( 'sendemail', $row->ipb_block_email );
        $this->prevents( 'editownusertalk', !$row->ipb_allow_usertalk );
    }
 
    public static function newFromRow( $row ) {
        $block = new Block;
        $block->initFromRow( $row );
        return $block;
    }
 
    public function delete() {
        if ( wfReadOnly() ) {
            return false;
        }
 
        if ( !$this->getId() ) {
            throw new MWException( "Block::delete() requires that the mId member be filled\n" );
        }
 
        $dbw = wfGetDB( DB_MASTER );
        $dbw->delete( 'ipblocks', [ 'ipb_parent_block_id' => $this->getId() ], __METHOD__ );
        $dbw->delete( 'ipblocks', [ 'ipb_id' => $this->getId() ], __METHOD__ );
 
        return $dbw->affectedRows() > 0;
    }
 
    public function insert( $dbw = null ) {
        global $wgBlockDisablesLogin;
 
        if ( $this->getSystemBlockType() !== null ) {
            throw new MWException( 'Cannot insert a system block into the database' );
        }
        if ( !$this->getBlocker() || $this->getBlocker()->getName() === '' ) {
            throw new MWException( 'Cannot insert a block without a blocker set' );
        }
 
        wfDebug( "Block::insert; timestamp {$this->mTimestamp}\n" );
 
        if ( $dbw === null ) {
            $dbw = wfGetDB( DB_MASTER );
        }
 
        self::purgeExpired();
 
        $row = $this->getDatabaseArray( $dbw );
 
        $dbw->insert( 'ipblocks', $row, __METHOD__, [ 'IGNORE' ] );
        $affected = $dbw->affectedRows();
        $this->mId = $dbw->insertId();
 
        # Don't collide with expired blocks.
        # Do this after trying to insert to avoid locking.
        if ( !$affected ) {
            # T96428: The ipb_address index uses a prefix on a field, so
            # use a standard SELECT + DELETE to avoid annoying gap locks.
            $ids = $dbw->selectFieldValues( 'ipblocks',
                'ipb_id',
                [
                    'ipb_address' => $row['ipb_address'],
                    'ipb_user' => $row['ipb_user'],
                    'ipb_expiry < ' . $dbw->addQuotes( $dbw->timestamp() )
                ],
                __METHOD__
            );
            if ( $ids ) {
                $dbw->delete( 'ipblocks', [ 'ipb_id' => $ids ], __METHOD__ );
                $dbw->insert( 'ipblocks', $row, __METHOD__, [ 'IGNORE' ] );
                $affected = $dbw->affectedRows();
                $this->mId = $dbw->insertId();
            }
        }
 
        if ( $affected ) {
            $auto_ipd_ids = $this->doRetroactiveAutoblock();
 
            if ( $wgBlockDisablesLogin && $this->target instanceof User ) {
                // Change user login token to force them to be logged out.
                $this->target->setToken();
                $this->target->saveSettings();
            }
 
            return [ 'id' => $this->mId, 'autoIds' => $auto_ipd_ids ];
        }
 
        return false;
    }
 
    public function update() {
        wfDebug( "Block::update; timestamp {$this->mTimestamp}\n" );
        $dbw = wfGetDB( DB_MASTER );
 
        $dbw->startAtomic( __METHOD__ );
 
        $dbw->update(
            'ipblocks',
            $this->getDatabaseArray( $dbw ),
            [ 'ipb_id' => $this->getId() ],
            __METHOD__
        );
 
        $affected = $dbw->affectedRows();
 
        if ( $this->isAutoblocking() ) {
            // update corresponding autoblock(s) (T50813)
            $dbw->update(
                'ipblocks',
                $this->getAutoblockUpdateArray( $dbw ),
                [ 'ipb_parent_block_id' => $this->getId() ],
                __METHOD__
            );
        } else {
            // autoblock no longer required, delete corresponding autoblock(s)
            $dbw->delete(
                'ipblocks',
                [ 'ipb_parent_block_id' => $this->getId() ],
                __METHOD__
            );
        }
 
        $dbw->endAtomic( __METHOD__ );
 
        if ( $affected ) {
            $auto_ipd_ids = $this->doRetroactiveAutoblock();
            return [ 'id' => $this->mId, 'autoIds' => $auto_ipd_ids ];
        }
 
        return false;
    }
 
    protected function getDatabaseArray( IDatabase $dbw ) {
        $expiry = $dbw->encodeExpiry( $this->mExpiry );
 
        if ( $this->forcedTargetID ) {
            $uid = $this->forcedTargetID;
        } else {
            $uid = $this->target instanceof User ? $this->target->getId() : 0;
        }
 
        $a = [
            'ipb_address'          => (string)$this->target,
            'ipb_user'             => $uid,
            'ipb_timestamp'        => $dbw->timestamp( $this->mTimestamp ),
            'ipb_auto'             => $this->mAuto,
            'ipb_anon_only'        => !$this->isHardblock(),
            'ipb_create_account'   => $this->prevents( 'createaccount' ),
            'ipb_enable_autoblock' => $this->isAutoblocking(),
            'ipb_expiry'           => $expiry,
            'ipb_range_start'      => $this->getRangeStart(),
            'ipb_range_end'        => $this->getRangeEnd(),
            'ipb_deleted'          => intval( $this->mHideName ), // typecast required for SQLite
            'ipb_block_email'      => $this->prevents( 'sendemail' ),
            'ipb_allow_usertalk'   => !$this->prevents( 'editownusertalk' ),
            'ipb_parent_block_id'  => $this->mParentBlockId
        ] + CommentStore::getStore()->insert( $dbw, 'ipb_reason', $this->mReason )
            + ActorMigration::newMigration()->getInsertValues( $dbw, 'ipb_by', $this->getBlocker() );
 
        return $a;
    }
 
    protected function getAutoblockUpdateArray( IDatabase $dbw ) {
        return [
            'ipb_create_account'   => $this->prevents( 'createaccount' ),
            'ipb_deleted'          => (int)$this->mHideName, // typecast required for SQLite
            'ipb_allow_usertalk'   => !$this->prevents( 'editownusertalk' ),
        ] + CommentStore::getStore()->insert( $dbw, 'ipb_reason', $this->mReason )
            + ActorMigration::newMigration()->getInsertValues( $dbw, 'ipb_by', $this->getBlocker() );
    }
 
    protected function doRetroactiveAutoblock() {
        $blockIds = [];
        # If autoblock is enabled, autoblock the LAST IP(s) used
        if ( $this->isAutoblocking() && $this->getType() == self::TYPE_USER ) {
            wfDebug( "Doing retroactive autoblocks for " . $this->getTarget() . "\n" );
 
            $continue = Hooks::run(
                'PerformRetroactiveAutoblock', [ $this, &$blockIds ] );
 
            if ( $continue ) {
                self::defaultRetroactiveAutoblock( $this, $blockIds );
            }
        }
        return $blockIds;
    }
 
    protected static function defaultRetroactiveAutoblock( Block $block, array &$blockIds ) {
        global $wgPutIPinRC;
 
        // No IPs are in recentchanges table, so nothing to select
        if ( !$wgPutIPinRC ) {
            return;
        }
 
        $target = $block->getTarget();
        if ( is_string( $target ) ) {
            $target = User::newFromName( $target, false );
        }
 
        $dbr = wfGetDB( DB_REPLICA );
        $rcQuery = ActorMigration::newMigration()->getWhere( $dbr, 'rc_user', $target, false );
 
        $options = [ 'ORDER BY' => 'rc_timestamp DESC' ];
 
        // Just the last IP used.
        $options['LIMIT'] = 1;
 
        $res = $dbr->select(
            [ 'recentchanges' ] + $rcQuery['tables'],
            [ 'rc_ip' ],
            $rcQuery['conds'],
            __METHOD__,
            $options,
            $rcQuery['joins']
        );
 
        if ( !$res->numRows() ) {
            # No results, don't autoblock anything
            wfDebug( "No IP found to retroactively autoblock\n" );
        } else {
            foreach ( $res as $row ) {
                if ( $row->rc_ip ) {
                    $id = $block->doAutoblock( $row->rc_ip );
                    if ( $id ) {
                        $blockIds[] = $id;
                    }
                }
            }
        }
    }
 
    public static function isWhitelistedFromAutoblocks( $ip ) {
        // Try to get the autoblock_whitelist from the cache, as it's faster
        // than getting the msg raw and explode()'ing it.
        $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
        $lines = $cache->getWithSetCallback(
            $cache->makeKey( 'ip-autoblock', 'whitelist' ),
            $cache::TTL_DAY,
            function ( $curValue, &$ttl, array &$setOpts ) {
                $setOpts += Database::getCacheSetOptions( wfGetDB( DB_REPLICA ) );
 
                return explode( "\n",
                    wfMessage( 'autoblock_whitelist' )->inContentLanguage()->plain() );
            }
        );
 
        wfDebug( "Checking the autoblock whitelist..\n" );
 
        foreach ( $lines as $line ) {
            # List items only
            if ( substr( $line, 0, 1 ) !== '*' ) {
                continue;
            }
 
            $wlEntry = substr( $line, 1 );
            $wlEntry = trim( $wlEntry );
 
            wfDebug( "Checking $ip against $wlEntry..." );
 
            # Is the IP in this range?
            if ( IP::isInRange( $ip, $wlEntry ) ) {
                wfDebug( " IP $ip matches $wlEntry, not autoblocking\n" );
                return true;
            } else {
                wfDebug( " No match\n" );
            }
        }
 
        return false;
    }
 
    public function doAutoblock( $autoblockIP ) {
        # If autoblocks are disabled, go away.
        if ( !$this->isAutoblocking() ) {
            return false;
        }
 
        # Don't autoblock for system blocks
        if ( $this->getSystemBlockType() !== null ) {
            throw new MWException( 'Cannot autoblock from a system block' );
        }
 
        # Check for presence on the autoblock whitelist.
        if ( self::isWhitelistedFromAutoblocks( $autoblockIP ) ) {
            return false;
        }
 
        // Avoid PHP 7.1 warning of passing $this by reference
        $block = $this;
        # Allow hooks to cancel the autoblock.
        if ( !Hooks::run( 'AbortAutoblock', [ $autoblockIP, &$block ] ) ) {
            wfDebug( "Autoblock aborted by hook.\n" );
            return false;
        }
 
        # It's okay to autoblock. Go ahead and insert/update the block...
 
        # Do not add a *new* block if the IP is already blocked.
        $ipblock = self::newFromTarget( $autoblockIP );
        if ( $ipblock ) {
            # Check if the block is an autoblock and would exceed the user block
            # if renewed. If so, do nothing, otherwise prolong the block time...
            if ( $ipblock->mAuto && // @todo Why not compare $ipblock->mExpiry?
                $this->mExpiry > self::getAutoblockExpiry( $ipblock->mTimestamp )
            ) {
                # Reset block timestamp to now and its expiry to
                # $wgAutoblockExpiry in the future
                $ipblock->updateTimestamp();
            }
            return false;
        }
 
        # Make a new block object with the desired properties.
        $autoblock = new Block;
        wfDebug( "Autoblocking {$this->getTarget()}@" . $autoblockIP . "\n" );
        $autoblock->setTarget( $autoblockIP );
        $autoblock->setBlocker( $this->getBlocker() );
        $autoblock->mReason = wfMessage( 'autoblocker', $this->getTarget(), $this->mReason )
            ->inContentLanguage()->plain();
        $timestamp = wfTimestampNow();
        $autoblock->mTimestamp = $timestamp;
        $autoblock->mAuto = 1;
        $autoblock->prevents( 'createaccount', $this->prevents( 'createaccount' ) );
        # Continue suppressing the name if needed
        $autoblock->mHideName = $this->mHideName;
        $autoblock->prevents( 'editownusertalk', $this->prevents( 'editownusertalk' ) );
        $autoblock->mParentBlockId = $this->mId;
 
        if ( $this->mExpiry == 'infinity' ) {
            # Original block was indefinite, start an autoblock now
            $autoblock->mExpiry = self::getAutoblockExpiry( $timestamp );
        } else {
            # If the user is already blocked with an expiry date, we don't
            # want to pile on top of that.
            $autoblock->mExpiry = min( $this->mExpiry, self::getAutoblockExpiry( $timestamp ) );
        }
 
        # Insert the block...
        $status = $autoblock->insert();
        return $status
            ? $status['id']
            : false;
    }
 
    public function deleteIfExpired() {
        if ( $this->isExpired() ) {
            wfDebug( "Block::deleteIfExpired() -- deleting\n" );
            $this->delete();
            $retVal = true;
        } else {
            wfDebug( "Block::deleteIfExpired() -- not expired\n" );
            $retVal = false;
        }
 
        return $retVal;
    }
 
    public function isExpired() {
        $timestamp = wfTimestampNow();
        wfDebug( "Block::isExpired() checking current " . $timestamp . " vs $this->mExpiry\n" );
 
        if ( !$this->mExpiry ) {
            return false;
        } else {
            return $timestamp > $this->mExpiry;
        }
    }
 
    public function isValid() {
        return $this->getTarget() != null;
    }
 
    public function updateTimestamp() {
        if ( $this->mAuto ) {
            $this->mTimestamp = wfTimestamp();
            $this->mExpiry = self::getAutoblockExpiry( $this->mTimestamp );
 
            $dbw = wfGetDB( DB_MASTER );
            $dbw->update( 'ipblocks',
                [ /* SET */
                    'ipb_timestamp' => $dbw->timestamp( $this->mTimestamp ),
                    'ipb_expiry' => $dbw->timestamp( $this->mExpiry ),
                ],
                [ /* WHERE */
                    'ipb_id' => $this->getId(),
                ],
                __METHOD__
            );
        }
    }
 
    public function getRangeStart() {
        switch ( $this->type ) {
            case self::TYPE_USER:
                return '';
            case self::TYPE_IP:
                return IP::toHex( $this->target );
            case self::TYPE_RANGE:
                list( $start, /*...*/ ) = IP::parseRange( $this->target );
                return $start;
            default:
                throw new MWException( "Block with invalid type" );
        }
    }
 
    public function getRangeEnd() {
        switch ( $this->type ) {
            case self::TYPE_USER:
                return '';
            case self::TYPE_IP:
                return IP::toHex( $this->target );
            case self::TYPE_RANGE:
                list( /*...*/, $end ) = IP::parseRange( $this->target );
                return $end;
            default:
                throw new MWException( "Block with invalid type" );
        }
    }
 
    public function getBy() {
        $blocker = $this->getBlocker();
        return ( $blocker instanceof User )
            ? $blocker->getId()
            : 0;
    }
 
    public function getByName() {
        $blocker = $this->getBlocker();
        return ( $blocker instanceof User )
            ? $blocker->getName()
            : (string)$blocker; // username
    }
 
    public function getId() {
        return $this->mId;
    }
 
    public function getSystemBlockType() {
        return $this->systemBlockType;
    }
 
    public function fromMaster( $x = null ) {
        return wfSetVar( $this->mFromMaster, $x );
    }
 
    public function isHardblock( $x = null ) {
        wfSetVar( $this->isHardblock, $x );
 
        # You can't *not* hardblock a user
        return $this->getType() == self::TYPE_USER
            ? true
            : $this->isHardblock;
    }
 
    public function isAutoblocking( $x = null ) {
        wfSetVar( $this->isAutoblocking, $x );
 
        # You can't put an autoblock on an IP or range as we don't have any history to
        # look over to get more IPs from
        return $this->getType() == self::TYPE_USER
            ? $this->isAutoblocking
            : false;
    }
 
    public function prevents( $action, $x = null ) {
        global $wgBlockDisablesLogin;
        $res = null;
        switch ( $action ) {
            case 'edit':
                # For now... <evil laugh>
                $res = true;
                break;
            case 'createaccount':
                $res = wfSetVar( $this->mCreateAccount, $x );
                break;
            case 'sendemail':
                $res = wfSetVar( $this->mBlockEmail, $x );
                break;
            case 'editownusertalk':
                $res = wfSetVar( $this->mDisableUsertalk, $x );
                break;
            case 'read':
                $res = false;
                break;
        }
        if ( !$res && $wgBlockDisablesLogin ) {
            // If a block would disable login, then it should
            // prevent any action that all users cannot do
            $anon = new User;
            $res = $anon->isAllowed( $action ) ? $res : true;
        }
 
        return $res;
    }
 
    public function getRedactedName() {
        if ( $this->mAuto ) {
            return Html::rawElement(
                'span',
                [ 'class' => 'mw-autoblockid' ],
                wfMessage( 'autoblockid', $this->mId )
            );
        } else {
            return htmlspecialchars( $this->getTarget() );
        }
    }
 
    public static function getAutoblockExpiry( $timestamp ) {
        global $wgAutoblockExpiry;
 
        return wfTimestamp( TS_MW, wfTimestamp( TS_UNIX, $timestamp ) + $wgAutoblockExpiry );
    }
 
    public static function purgeExpired() {
        if ( wfReadOnly() ) {
            return;
        }
 
        DeferredUpdates::addUpdate( new AutoCommitUpdate(
            wfGetDB( DB_MASTER ),
            __METHOD__,
            function ( IDatabase $dbw, $fname ) {
                $ids = $dbw->selectFieldValues( 'ipblocks',
                    'ipb_id',
                    [ 'ipb_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ],
                    $fname
                );
                if ( $ids ) {
                    $dbw->delete( 'ipblocks', [ 'ipb_id' => $ids ], $fname );
                }
            }
        ) );
    }
 
    public static function newFromTarget( $specificTarget, $vagueTarget = null, $fromMaster = false ) {
        list( $target, $type ) = self::parseTarget( $specificTarget );
        if ( $type == self::TYPE_ID || $type == self::TYPE_AUTO ) {
            return self::newFromID( $target );
 
        } elseif ( $target === null && $vagueTarget == '' ) {
            # We're not going to find anything useful here
            # Be aware that the == '' check is explicit, since empty values will be
            # passed by some callers (T31116)
            return null;
 
        } elseif ( in_array(
            $type,
            [ self::TYPE_USER, self::TYPE_IP, self::TYPE_RANGE, null ] )
        ) {
            $block = new Block();
            $block->fromMaster( $fromMaster );
 
            if ( $type !== null ) {
                $block->setTarget( $target );
            }
 
            if ( $block->newLoad( $vagueTarget ) ) {
                return $block;
            }
        }
        return null;
    }
 
    public static function getBlocksForIPList( array $ipChain, $isAnon, $fromMaster = false ) {
        if ( !count( $ipChain ) ) {
            return [];
        }
 
        $conds = [];
        $proxyLookup = MediaWikiServices::getInstance()->getProxyLookup();
        foreach ( array_unique( $ipChain ) as $ipaddr ) {
            # Discard invalid IP addresses. Since XFF can be spoofed and we do not
            # necessarily trust the header given to us, make sure that we are only
            # checking for blocks on well-formatted IP addresses (IPv4 and IPv6).
            # Do not treat private IP spaces as special as it may be desirable for wikis
            # to block those IP ranges in order to stop misbehaving proxies that spoof XFF.
            if ( !IP::isValid( $ipaddr ) ) {
                continue;
            }
            # Don't check trusted IPs (includes local squids which will be in every request)
            if ( $proxyLookup->isTrustedProxy( $ipaddr ) ) {
                continue;
            }
            # Check both the original IP (to check against single blocks), as well as build
            # the clause to check for rangeblocks for the given IP.
            $conds['ipb_address'][] = $ipaddr;
            $conds[] = self::getRangeCond( IP::toHex( $ipaddr ) );
        }
 
        if ( !count( $conds ) ) {
            return [];
        }
 
        if ( $fromMaster ) {
            $db = wfGetDB( DB_MASTER );
        } else {
            $db = wfGetDB( DB_REPLICA );
        }
        $conds = $db->makeList( $conds, LIST_OR );
        if ( !$isAnon ) {
            $conds = [ $conds, 'ipb_anon_only' => 0 ];
        }
        $blockQuery = self::getQueryInfo();
        $rows = $db->select(
            $blockQuery['tables'],
            array_merge( [ 'ipb_range_start', 'ipb_range_end' ], $blockQuery['fields'] ),
            $conds,
            __METHOD__,
            [],
            $blockQuery['joins']
        );
 
        $blocks = [];
        foreach ( $rows as $row ) {
            $block = self::newFromRow( $row );
            if ( !$block->isExpired() ) {
                $blocks[] = $block;
            }
        }
 
        return $blocks;
    }
 
    public static function chooseBlock( array $blocks, array $ipChain ) {
        if ( !count( $blocks ) ) {
            return null;
        } elseif ( count( $blocks ) == 1 ) {
            return $blocks[0];
        }
 
        // Sort hard blocks before soft ones and secondarily sort blocks
        // that disable account creation before those that don't.
        usort( $blocks, function ( Block $a, Block $b ) {
            $aWeight = (int)$a->isHardblock() . (int)$a->prevents( 'createaccount' );
            $bWeight = (int)$b->isHardblock() . (int)$b->prevents( 'createaccount' );
            return strcmp( $bWeight, $aWeight ); // highest weight first
        } );
 
        $blocksListExact = [
            'hard' => false,
            'disable_create' => false,
            'other' => false,
            'auto' => false
        ];
        $blocksListRange = [
            'hard' => false,
            'disable_create' => false,
            'other' => false,
            'auto' => false
        ];
        $ipChain = array_reverse( $ipChain );
 
        foreach ( $blocks as $block ) {
            // Stop searching if we have already have a "better" block. This
            // is why the order of the blocks matters
            if ( !$block->isHardblock() && $blocksListExact['hard'] ) {
                break;
            } elseif ( !$block->prevents( 'createaccount' ) && $blocksListExact['disable_create'] ) {
                break;
            }
 
            foreach ( $ipChain as $checkip ) {
                $checkipHex = IP::toHex( $checkip );
                if ( (string)$block->getTarget() === $checkip ) {
                    if ( $block->isHardblock() ) {
                        $blocksListExact['hard'] = $blocksListExact['hard'] ?: $block;
                    } elseif ( $block->prevents( 'createaccount' ) ) {
                        $blocksListExact['disable_create'] = $blocksListExact['disable_create'] ?: $block;
                    } elseif ( $block->mAuto ) {
                        $blocksListExact['auto'] = $blocksListExact['auto'] ?: $block;
                    } else {
                        $blocksListExact['other'] = $blocksListExact['other'] ?: $block;
                    }
                    // We found closest exact match in the ip list, so go to the next Block
                    break;
                } elseif ( array_filter( $blocksListExact ) == []
                    && $block->getRangeStart() <= $checkipHex
                    && $block->getRangeEnd() >= $checkipHex
                ) {
                    if ( $block->isHardblock() ) {
                        $blocksListRange['hard'] = $blocksListRange['hard'] ?: $block;
                    } elseif ( $block->prevents( 'createaccount' ) ) {
                        $blocksListRange['disable_create'] = $blocksListRange['disable_create'] ?: $block;
                    } elseif ( $block->mAuto ) {
                        $blocksListRange['auto'] = $blocksListRange['auto'] ?: $block;
                    } else {
                        $blocksListRange['other'] = $blocksListRange['other'] ?: $block;
                    }
                    break;
                }
            }
        }
 
        if ( array_filter( $blocksListExact ) == [] ) {
            $blocksList = &$blocksListRange;
        } else {
            $blocksList = &$blocksListExact;
        }
 
        $chosenBlock = null;
        if ( $blocksList['hard'] ) {
            $chosenBlock = $blocksList['hard'];
        } elseif ( $blocksList['disable_create'] ) {
            $chosenBlock = $blocksList['disable_create'];
        } elseif ( $blocksList['other'] ) {
            $chosenBlock = $blocksList['other'];
        } elseif ( $blocksList['auto'] ) {
            $chosenBlock = $blocksList['auto'];
        } else {
            throw new MWException( "Proxy block found, but couldn't be classified." );
        }
 
        return $chosenBlock;
    }
 
    public static function parseTarget( $target ) {
        # We may have been through this before
        if ( $target instanceof User ) {
            if ( IP::isValid( $target->getName() ) ) {
                return [ $target, self::TYPE_IP ];
            } else {
                return [ $target, self::TYPE_USER ];
            }
        } elseif ( $target === null ) {
            return [ null, null ];
        }
 
        $target = trim( $target );
 
        if ( IP::isValid( $target ) ) {
            # We can still create a User if it's an IP address, but we need to turn
            # off validation checking (which would exclude IP addresses)
            return [
                User::newFromName( IP::sanitizeIP( $target ), false ),
                self::TYPE_IP
            ];
 
        } elseif ( IP::isValidRange( $target ) ) {
            # Can't create a User from an IP range
            return [ IP::sanitizeRange( $target ), self::TYPE_RANGE ];
        }
 
        # Consider the possibility that this is not a username at all
        # but actually an old subpage (T31797)
        if ( strpos( $target, '/' ) !== false ) {
            # An old subpage, drill down to the user behind it
            $target = explode( '/', $target )[0];
        }
 
        $userObj = User::newFromName( $target );
        if ( $userObj instanceof User ) {
            # Note that since numbers are valid usernames, a $target of "12345" will be
            # considered a User.  If you want to pass a block ID, prepend a hash "#12345",
            # since hash characters are not valid in usernames or titles generally.
            return [ $userObj, self::TYPE_USER ];
 
        } elseif ( preg_match( '/^#\d+$/', $target ) ) {
            # Autoblock reference in the form "#12345"
            return [ substr( $target, 1 ), self::TYPE_AUTO ];
 
        } else {
            # WTF?
            return [ null, null ];
        }
    }
 
    public function getType() {
        return $this->mAuto
            ? self::TYPE_AUTO
            : $this->type;
    }
 
    public function getTargetAndType() {
        return [ $this->getTarget(), $this->getType() ];
    }
 
    public function getTarget() {
        return $this->target;
    }
 
    public function getExpiry() {
        return $this->mExpiry;
    }
 
    public function setTarget( $target ) {
        list( $this->target, $this->type ) = self::parseTarget( $target );
    }
 
    public function getBlocker() {
        return $this->blocker;
    }
 
    public function setBlocker( $user ) {
        if ( is_string( $user ) ) {
            $user = User::newFromName( $user, false );
        }
 
        if ( $user->isAnon() && User::isUsableName( $user->getName() ) ) {
            throw new InvalidArgumentException(
                'Blocker must be a local user or a name that cannot be a local user'
            );
        }
 
        $this->blocker = $user;
    }
 
    public function setCookie( WebResponse $response ) {
        // Calculate the default expiry time.
        $maxExpiryTime = wfTimestamp( TS_MW, wfTimestamp() + ( 24 * 60 * 60 ) );
 
        // Use the Block's expiry time only if it's less than the default.
        $expiryTime = $this->getExpiry();
        if ( $expiryTime === 'infinity' || $expiryTime > $maxExpiryTime ) {
            $expiryTime = $maxExpiryTime;
        }
 
        // Set the cookie. Reformat the MediaWiki datetime as a Unix timestamp for the cookie.
        $expiryValue = DateTime::createFromFormat( 'YmdHis', $expiryTime )->format( 'U' );
        $cookieOptions = [ 'httpOnly' => false ];
        $cookieValue = $this->getCookieValue();
        $response->setCookie( 'BlockID', $cookieValue, $expiryValue, $cookieOptions );
    }
 
    public static function clearCookie( WebResponse $response ) {
        $response->clearCookie( 'BlockID', [ 'httpOnly' => false ] );
    }
 
    public function getCookieValue() {
        $config = RequestContext::getMain()->getConfig();
        $id = $this->getId();
        $secretKey = $config->get( 'SecretKey' );
        if ( !$secretKey ) {
            // If there's no secret key, don't append a HMAC.
            return $id;
        }
        $hmac = MWCryptHash::hmac( $id, $secretKey, false );
        $cookieValue = $id . '!' . $hmac;
        return $cookieValue;
    }
 
    public static function getIdFromCookieValue( $cookieValue ) {
        // Extract the ID prefix from the cookie value (may be the whole value, if no bang found).
        $bangPos = strpos( $cookieValue, '!' );
        $id = ( $bangPos === false ) ? $cookieValue : substr( $cookieValue, 0, $bangPos );
        // Get the site-wide secret key.
        $config = RequestContext::getMain()->getConfig();
        $secretKey = $config->get( 'SecretKey' );
        if ( !$secretKey ) {
            // If there's no secret key, just use the ID as given.
            return $id;
        }
        $storedHmac = substr( $cookieValue, $bangPos + 1 );
        $calculatedHmac = MWCryptHash::hmac( $id, $secretKey, false );
        if ( $calculatedHmac === $storedHmac ) {
            return $id;
        } else {
            return null;
        }
    }
 
    public function getPermissionsError( IContextSource $context ) {
        $blocker = $this->getBlocker();
        if ( $blocker instanceof User ) { // local user
            $blockerUserpage = $blocker->getUserPage();
            $link = "[[{$blockerUserpage->getPrefixedText()}|{$blockerUserpage->getText()}]]";
        } else { // foreign user
            $link = $blocker;
        }
 
        $reason = $this->mReason;
        if ( $reason == '' ) {
            $reason = $context->msg( 'blockednoreason' )->text();
        }
 
        /* $ip returns who *is* being blocked, $intended contains who was meant to be blocked.
         * This could be a username, an IP range, or a single IP. */
        $intended = $this->getTarget();
 
        $systemBlockType = $this->getSystemBlockType();
 
        $lang = $context->getLanguage();
        return [
            $systemBlockType !== null
                ? 'systemblockedtext'
                : ( $this->mAuto ? 'autoblockedtext' : 'blockedtext' ),
            $link,
            $reason,
            $context->getRequest()->getIP(),
            $this->getByName(),
            $systemBlockType ?? $this->getId(),
            $lang->formatExpiry( $this->mExpiry ),
            (string)$intended,
            $lang->userTimeAndDate( $this->mTimestamp, $context->getUser() ),
        ];
    }
}