HideUserUtils.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Block;
 
use Wikimedia\Rdbms\IReadableDatabase;
use Wikimedia\Rdbms\SelectQueryBuilder;
 
class HideUserUtils {
    public const SHOWN_USERS = 1;
 
    public const HIDDEN_USERS = 2;
 
    public function getExpression(
        IReadableDatabase $dbr,
        string $userIdField = 'user_id',
        $status = self::SHOWN_USERS
    ) {
        // Use a scalar subquery, not IN/EXISTS, to avoid materialization (T360160)
        return '(' .
            $dbr->newSelectQueryBuilder()
                ->select( '1' )
                // $userIdField may be e.g. block_target.bt_user so an inner table
                // alias is necessary to ensure that that refers to the outer copy
                // of the block_target table.
                ->from( 'block_target', 'hu_block_target' )
                ->join( 'block', 'hu_block', 'hu_block.bl_target=hu_block_target.bt_id' )
                ->where( [ "hu_block_target.bt_user=$userIdField", 'hu_block.bl_deleted' => 1 ] )
                ->limit( 1 )
                ->caller( __METHOD__ )
                ->getSQL() .
            ') ' .
            ( $status === self::HIDDEN_USERS ? 'IS NOT NULL' : 'IS NULL' );
    }
 
    public function addFieldToBuilder(
        SelectQueryBuilder $qb,
        $userIdField = 'user_id',
        $deletedFieldAlias = 'hu_deleted'
    ) {
        $cond = '(' .
            $qb->newSubquery()
                ->select( '1' )
                // $userIdField may be e.g. block_target.bt_user so an inner table
                // alias is necessary to ensure that that refers to the outer copy
                // of the block_target table.
                ->from( 'block_target', 'hu_block_target' )
                ->join( 'block', 'hu_block', 'hu_block.bl_target=hu_block_target.bt_id' )
                ->where( [ "hu_block_target.bt_user=$userIdField", 'hu_block.bl_deleted' => 1 ] )
                ->limit( 1 )
                ->caller( __METHOD__ )
                ->getSQL() .
            ') IS NOT NULL';
        $qb->select( [ $deletedFieldAlias => $cond ] );
    }
}