ApiQueryBlockInfoTrait.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Api;
 
use MediaWiki\Block\CompositeBlock;
use MediaWiki\Block\HideUserUtils;
use MediaWiki\MediaWikiServices;
use MediaWiki\Permissions\Authority;
use stdClass;
use Wikimedia\Rdbms\IExpression;
use Wikimedia\Rdbms\IReadableDatabase;
use Wikimedia\Rdbms\IResultWrapper;
use Wikimedia\Rdbms\SelectQueryBuilder;
 
trait ApiQueryBlockInfoTrait {
    use ApiBlockInfoTrait;
 
    private function addDeletedUserFilter() {
        // TODO: inject dependencies the way ApiWatchlistTrait does
        $utils = MediaWikiServices::getInstance()->getHideUserUtils();
        if ( !$this->getAuthority()->isAllowed( 'hideuser' ) ) {
            $this->addWhere( $utils->getExpression( $this->getDB() ) );
            // The field is always false since we are filtering out rows where it is true
            $this->addFields( [ 'hu_deleted' => '1=0' ] );
        } else {
            $this->addFields( [
                'hu_deleted' => $utils->getExpression(
                    $this->getDB(),
                    'user_id',
                    HideUserUtils::HIDDEN_USERS
                )
            ] );
        }
    }
 
    private function getBlockDetailsForRows( $rows ) {
        $ids = [];
        foreach ( $rows as $row ) {
            $ids[] = (int)$row->user_id;
        }
        if ( !$ids ) {
            return [];
        }
        $blocks = MediaWikiServices::getInstance()->getDatabaseBlockStore()
            ->newListFromConds( [ 'bt_user' => $ids ] );
        $blocksByUser = [];
        foreach ( $blocks as $block ) {
            $blocksByUser[$block->getTargetUserIdentity()->getId()][] = $block;
        }
        $infoByUser = [];
        foreach ( $blocksByUser as $id => $userBlocks ) {
            if ( count( $userBlocks ) > 1 ) {
                $maybeCompositeBlock = CompositeBlock::createFromBlocks( ...$userBlocks );
            } else {
                $maybeCompositeBlock = $userBlocks[0];
            }
            $infoByUser[$id] = $this->getBlockDetails( $maybeCompositeBlock );
        }
        return $infoByUser;
    }
 
    /***************************************************************************/
    // region   Methods required from ApiQueryBase
    abstract protected function getDB();
 
    abstract public function getAuthority();
 
    abstract protected function addTables( $tables, $alias = null );
 
    abstract protected function addFields( $fields );
 
    abstract protected function addWhere( $conds );
 
    abstract protected function addJoinConds( $conds );
 
    abstract protected function getQueryBuilder();
 
    // endregion -- end of methods required from ApiQueryBase
 
}
 
class_alias( ApiQueryBlockInfoTrait::class, 'ApiQueryBlockInfoTrait' );