ApiBlockTest.php

Go to the documentation of this file.

<?php
 
class ApiBlockTest extends ApiTestCase {
    protected $mUser = null;
 
    protected function setUp() {
        parent::setUp();
        $this->tablesUsed = array_merge(
            $this->tablesUsed,
            [ 'ipblocks', 'change_tag', 'change_tag_def', 'logging' ]
        );
 
        $this->mUser = $this->getMutableTestUser()->getUser();
    }
 
    protected function getTokens() {
        return $this->getTokenList( self::$users['sysop'] );
    }
 
    private function doBlock( array $extraParams = [], User $blocker = null ) {
        if ( $blocker === null ) {
            $blocker = self::$users['sysop']->getUser();
        }
 
        $tokens = $this->getTokens();
 
        $this->assertNotNull( $this->mUser, 'Sanity check' );
        $this->assertNotSame( 0, $this->mUser->getId(), 'Sanity check' );
 
        $this->assertArrayHasKey( 'blocktoken', $tokens, 'Sanity check' );
 
        $params = [
            'action' => 'block',
            'user' => $this->mUser->getName(),
            'reason' => 'Some reason',
            'token' => $tokens['blocktoken'],
        ];
        if ( array_key_exists( 'userid', $extraParams ) ) {
            // Make sure we don't have both user and userid
            unset( $params['user'] );
        }
        $ret = $this->doApiRequest( array_merge( $params, $extraParams ), null,
            false, $blocker );
 
        $block = Block::newFromTarget( $this->mUser->getName() );
 
        $this->assertTrue( !is_null( $block ), 'Block is valid' );
 
        $this->assertSame( $this->mUser->getName(), (string)$block->getTarget() );
        $this->assertSame( 'Some reason', $block->mReason );
 
        return $ret;
    }
 
    public function testNormalBlock() {
        $this->doBlock();
    }
 
    public function testBlockById() {
        $this->doBlock( [ 'userid' => $this->mUser->getId() ] );
    }
 
    public function testBlockByBlockedUser() {
        $this->setExpectedException( ApiUsageException::class,
            'You cannot block or unblock other users because you are yourself blocked.' );
 
        $blocked = $this->getMutableTestUser( [ 'sysop' ] )->getUser();
        $block = new Block( [
            'address' => $blocked->getName(),
            'by' => self::$users['sysop']->getUser()->getId(),
            'reason' => 'Capriciousness',
            'timestamp' => '19370101000000',
            'expiry' => 'infinity',
        ] );
        $block->insert();
 
        $this->doBlock( [], $blocked );
    }
 
    public function testBlockOfNonexistentUser() {
        $this->setExpectedException( ApiUsageException::class,
            'There is no user by the name "Nonexistent". Check your spelling.' );
 
        $this->doBlock( [ 'user' => 'Nonexistent' ] );
    }
 
    public function testBlockOfNonexistentUserId() {
        $id = 948206325;
        $this->setExpectedException( ApiUsageException::class,
            "There is no user with ID $id." );
 
        $this->assertFalse( User::whoIs( $id ), 'Sanity check' );
 
        $this->doBlock( [ 'userid' => $id ] );
    }
 
    public function testBlockWithTag() {
        $this->setMwGlobals( 'wgChangeTagsSchemaMigrationStage', MIGRATION_WRITE_BOTH );
        ChangeTags::defineTag( 'custom tag' );
 
        $this->doBlock( [ 'tags' => 'custom tag' ] );
 
        $dbw = wfGetDB( DB_MASTER );
        $this->assertSame( 1, (int)$dbw->selectField(
            [ 'change_tag', 'logging' ],
            'COUNT(*)',
            [ 'log_type' => 'block', 'ct_tag' => 'custom tag' ],
            __METHOD__,
            [],
            [ 'change_tag' => [ 'INNER JOIN', 'ct_log_id = log_id' ] ]
        ) );
    }
 
    public function testBlockWithTagNewBackend() {
        $this->setMwGlobals( 'wgChangeTagsSchemaMigrationStage', MIGRATION_NEW );
        ChangeTags::defineTag( 'custom tag' );
 
        $this->doBlock( [ 'tags' => 'custom tag' ] );
 
        $dbw = wfGetDB( DB_MASTER );
        $this->assertSame( 1, (int)$dbw->selectField(
            [ 'change_tag', 'logging', 'change_tag_def' ],
            'COUNT(*)',
            [ 'log_type' => 'block', 'ctd_name' => 'custom tag' ],
            __METHOD__,
            [],
            [
                'change_tag' => [ 'INNER JOIN', 'ct_log_id = log_id' ],
                'change_tag_def' => [ 'INNER JOIN', 'ctd_id = ct_tag_id' ],
            ]
        ) );
    }
 
    public function testBlockWithProhibitedTag() {
        $this->setExpectedException( ApiUsageException::class,
            'You do not have permission to apply change tags along with your changes.' );
 
        ChangeTags::defineTag( 'custom tag' );
 
        $this->setMwGlobals( 'wgRevokePermissions',
            [ 'user' => [ 'applychangetags' => true ] ] );
 
        $this->doBlock( [ 'tags' => 'custom tag' ] );
    }
 
    public function testBlockWithHide() {
        global $wgGroupPermissions;
        $newPermissions = $wgGroupPermissions['sysop'];
        $newPermissions['hideuser'] = true;
        $this->mergeMwGlobalArrayValue( 'wgGroupPermissions',
            [ 'sysop' => $newPermissions ] );
 
        $res = $this->doBlock( [ 'hidename' => '' ] );
 
        $dbw = wfGetDB( DB_MASTER );
        $this->assertSame( '1', $dbw->selectField(
            'ipblocks',
            'ipb_deleted',
            [ 'ipb_id' => $res[0]['block']['id'] ],
            __METHOD__
        ) );
    }
 
    public function testBlockWithProhibitedHide() {
        $this->setExpectedException( ApiUsageException::class,
            "You don't have permission to hide user names from the block log." );
 
        $this->doBlock( [ 'hidename' => '' ] );
    }
 
    public function testBlockWithEmailBlock() {
        $res = $this->doBlock( [ 'noemail' => '' ] );
 
        $dbw = wfGetDB( DB_MASTER );
        $this->assertSame( '1', $dbw->selectField(
            'ipblocks',
            'ipb_block_email',
            [ 'ipb_id' => $res[0]['block']['id'] ],
            __METHOD__
        ) );
    }
 
    public function testBlockWithProhibitedEmailBlock() {
        $this->setExpectedException( ApiUsageException::class,
            "You don't have permission to block users from sending email through the wiki." );
 
        $this->setMwGlobals( 'wgRevokePermissions',
            [ 'sysop' => [ 'blockemail' => true ] ] );
 
        $this->doBlock( [ 'noemail' => '' ] );
    }
 
    public function testBlockWithExpiry() {
        $res = $this->doBlock( [ 'expiry' => '1 day' ] );
 
        $dbw = wfGetDB( DB_MASTER );
        $expiry = $dbw->selectField(
            'ipblocks',
            'ipb_expiry',
            [ 'ipb_id' => $res[0]['block']['id'] ],
            __METHOD__
        );
 
        // Allow flakiness up to one second
        $this->assertLessThanOrEqual( 1,
            abs( wfTimestamp( TS_UNIX, $expiry ) - ( time() + 86400 ) ) );
    }
 
    public function testBlockWithInvalidExpiry() {
        $this->setExpectedException( ApiUsageException::class, "Expiry time invalid." );
 
        $this->doBlock( [ 'expiry' => '' ] );
    }
 
    public function testBlockingActionWithNoToken() {
        $this->doApiRequest(
            [
                'action' => 'block',
                'user' => $this->mUser->getName(),
                'reason' => 'Some reason',
            ],
            null,
            false,
            self::$users['sysop']->getUser()
        );
    }
}