ActiveUsersPager.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Specials\Pager;
 
use MediaWiki\Block\HideUserUtils;
use MediaWiki\Context\IContextSource;
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\Html\FormOptions;
use MediaWiki\Html\Html;
use MediaWiki\Linker\Linker;
use MediaWiki\MainConfigNames;
use MediaWiki\Page\LinkBatchFactory;
use MediaWiki\RecentChanges\RecentChangeLookup;
use MediaWiki\Title\Title;
use MediaWiki\User\TempUser\TempUserConfig;
use MediaWiki\User\UserGroupManager;
use MediaWiki\User\UserIdentityLookup;
use MediaWiki\User\UserIdentityValue;
use Wikimedia\Rdbms\IConnectionProvider;
use Wikimedia\Rdbms\Subquery;
use Wikimedia\Timestamp\ConvertibleTimestamp;
use Wikimedia\Timestamp\TimestampFormat as TS;
 
class ActiveUsersPager extends UsersPager {
 
    protected $opts;
 
    protected $groups;
 
    private $blockStatusByUid;
 
    private $RCMaxAge;
 
    private $excludegroups;
 
    public function __construct(
        IContextSource $context,
        HookContainer $hookContainer,
        LinkBatchFactory $linkBatchFactory,
        IConnectionProvider $dbProvider,
        UserGroupManager $userGroupManager,
        UserIdentityLookup $userIdentityLookup,
        HideUserUtils $hideUserUtils,
        TempUserConfig $tempUserConfig,
        private readonly RecentChangeLookup $recentChangeLookup,
        FormOptions $opts,
    ) {
        parent::__construct(
            $context,
            $hookContainer,
            $linkBatchFactory,
            $dbProvider,
            $userGroupManager,
            $userIdentityLookup,
            $hideUserUtils,
            $tempUserConfig,
            null,
            null
        );
 
        $this->RCMaxAge = $this->getConfig()->get( MainConfigNames::ActiveUserDays );
        $this->requestedUser = '';
 
        $un = $opts->getValue( 'username' );
        if ( $un != '' ) {
            $username = Title::makeTitleSafe( NS_USER, $un );
            if ( $username !== null ) {
                $this->requestedUser = $username->getText();
            }
        }
 
        $this->groups = $opts->getValue( 'groups' );
        $this->excludegroups = $opts->getValue( 'excludegroups' );
        // Backwards-compatibility with old URLs
        if ( $opts->getValue( 'hidebots' ) ) {
            $this->excludegroups[] = 'bot';
        }
        if ( $opts->getValue( 'hidesysops' ) ) {
            $this->excludegroups[] = 'sysop';
        }
    }
 
    public function getIndexField() {
        return 'qcc_title';
    }
 
    public function getQueryInfo( $data = null ) {
        $dbr = $this->getDatabase();
 
        $activeUserSeconds = $this->getConfig()->get( MainConfigNames::ActiveUserDays ) * 86400;
        $timestamp = $dbr->timestamp( (int)ConvertibleTimestamp::now( TS::UNIX ) - $activeUserSeconds );
        $fname = __METHOD__ . ' (' . $this->getSqlComment() . ')';
 
        // Inner subselect to pull the active users out of querycachetwo
        $subquery = $dbr->newSelectQueryBuilder()
            ->select( [ 'qcc_title', 'user_id', 'actor_id' ] )
            ->from( 'querycachetwo' )
            ->join( 'user', null, 'user_name = qcc_title' )
            ->join( 'actor', null, 'actor_user = user_id' )
            ->where( [
                'qcc_type' => 'activeusers',
                'qcc_namespace' => NS_USER,
            ] )
            ->caller( $fname );
        if ( $data !== null ) {
            $subquery
                ->orderBy( 'qcc_title', $data['order'] )
                ->limit( $data['limit'] )
                ->andWhere( $data['conds'] );
        }
        if ( $this->requestedUser != '' ) {
            $subquery->andWhere( $dbr->expr( 'qcc_title', '>=', $this->requestedUser ) );
        }
        if ( $this->groups !== [] ) {
            $subquery
                ->join( 'user_groups', 'ug1', 'ug1.ug_user = user_id' )
                ->andWhere( [
                    'ug1.ug_group' => $this->groups,
                    $dbr->expr( 'ug1.ug_expiry', '=', null )->or( 'ug1.ug_expiry', '>=', $dbr->timestamp() ),
                ] );
        }
        if ( $this->excludegroups !== [] ) {
            $subquery
                ->leftJoin( 'user_groups', 'ug2', [
                    'ug2.ug_user = user_id',
                    'ug2.ug_group' => $this->excludegroups,
                    $dbr->expr( 'ug2.ug_expiry', '=', null )->or( 'ug2.ug_expiry', '>=', $dbr->timestamp() ),
                ] )
                ->andWhere( [ 'ug2.ug_user' => null ] );
        }
        if ( !$this->canSeeHideuser() ) {
            $subquery->andWhere( $this->hideUserUtils->getExpression( $dbr ) );
        }
 
        // Outer query to select the recent edit counts for the selected active users
        return [
            'tables' => [ 'qcc_users' => new Subquery( $subquery->getSQL() ), 'recentchanges' ],
            'fields' => [
                'qcc_title',
                'user_name' => 'qcc_title',
                'user_id' => 'user_id',
                'recentedits' => 'COUNT(DISTINCT rc_id)'
            ],
            'options' => [ 'GROUP BY' => [ 'qcc_title', 'user_id' ] ],
            'conds' => [],
            'join_conds' => [ 'recentchanges' => [ 'LEFT JOIN', [
                'rc_actor = actor_id',
                $dbr->expr( 'rc_source', '=', $this->recentChangeLookup->getPrimarySources() ),
                $dbr->expr( 'rc_log_type', '=', null )->or( 'rc_log_type', '!=', 'newusers' ),
                $dbr->expr( 'rc_timestamp', '>=', $timestamp ),
            ] ] ],
        ];
    }
 
    protected function buildQueryInfo( $offset, $limit, $order ) {
        $fname = __METHOD__ . ' (' . $this->getSqlComment() . ')';
 
        $sortColumns = [ $this->mIndexField, ...$this->mExtraSortFields ];
        if ( $order === self::QUERY_ASCENDING ) {
            $dir = 'ASC';
            $orderBy = $sortColumns;
            $operator = $this->mIncludeOffset ? '>=' : '>';
        } else {
            $dir = 'DESC';
            $orderBy = [];
            foreach ( $sortColumns as $col ) {
                $orderBy[] = $col . ' DESC';
            }
            $operator = $this->mIncludeOffset ? '<=' : '<';
        }
        $info = $this->getQueryInfo( [
            'limit' => intval( $limit ),
            'order' => $dir,
            'conds' =>
                $offset != '' ? [ $this->getDatabase()->expr( $this->mIndexField, $operator, $offset ) ] : [],
        ] );
 
        $tables = $info['tables'];
        $fields = $info['fields'];
        $conds = $info['conds'];
        $options = $info['options'];
        $join_conds = $info['join_conds'];
        $options['ORDER BY'] = $orderBy;
        return [ $tables, $fields, $conds, $fname, $options, $join_conds ];
    }
 
    protected function doBatchLookups() {
        parent::doBatchLookups();
 
        $uids = [];
        foreach ( $this->mResult as $row ) {
            $uids[] = (int)$row->user_id;
        }
        // Fetch the block status of the user for showing "(blocked)" text and for
        // striking out names of suppressed users when privileged user views the list.
        // Although the first query already hits the block table for un-privileged, this
        // is done in two queries to avoid huge quicksorts and to make COUNT(*) correct.
        $dbr = $this->getDatabase();
        $blockedUsers = $dbr->newSelectQueryBuilder()
            ->select( [
                'bt_user',
                'sitewide' => 'MAX(bl_sitewide)'
            ] )
            ->from( 'block_target' )
            ->join( 'block', null, 'bl_target=bt_id' )
            ->where( [
                'bt_user' => $uids,
                $dbr->expr( 'bl_expiry', '>=', $dbr->timestamp() ),
            ] )
            ->groupBy( [ 'bt_user' ] )
            ->caller( __METHOD__ )
            ->fetchResultSet();
 
        $hiddenUsers = $dbr->newSelectQueryBuilder()
            ->select( 'bt_user' )
            ->from( 'block_target' )
            ->join( 'block', null, 'bl_target=bt_id' )
            ->where( [
                'bt_user' => $uids,
                'bl_deleted' => 1,
                $dbr->expr( 'bl_expiry', '>=', $dbr->timestamp() ),
            ] )
            ->groupBy( 'bt_user' )
            ->caller( __METHOD__ )
            ->fetchFieldValues();
 
        $this->blockStatusByUid = [];
        foreach ( $blockedUsers as $row ) {
            $this->blockStatusByUid[$row->bt_user] = [
                'deleted' => in_array( $row->bt_user, $hiddenUsers, true ),
                'sitewide' => $row->sitewide,
            ];
        }
        $this->mResult->seek( 0 );
    }
 
    public function formatRow( $row ) {
        $userName = $row->user_name;
 
        $ulinks = Linker::userLink( $row->user_id, $userName );
        $ulinks .= Linker::userToolLinks(
            $row->user_id,
            $userName,
            // Should the contributions link be red if the user has no edits (using default)
            false,
            // Customisation flags (using default 0)
            0,
            // User edit count (using default)
            null,
            // do not wrap the message in parentheses (CSS will provide these)
            false
        );
 
        $lang = $this->getLanguage();
 
        $list = [];
 
        $userIdentity = new UserIdentityValue( intval( $row->user_id ), $userName );
        $ugms = $this->getGroupMemberships( $userIdentity );
        foreach ( $ugms as $ugm ) {
            $list[] = $this->buildGroupLink( $ugm, $userName );
        }
 
        $groups = $lang->commaList( $list );
 
        $item = $lang->specialList( $ulinks, $groups );
 
        // If there is a block, 'deleted' and 'sitewide' are both set on
        // $this->blockStatusByUid[$row->user_id].
        $blocked = '';
        $isBlocked = isset( $this->blockStatusByUid[$row->user_id] );
        if ( $isBlocked ) {
            if ( $this->blockStatusByUid[$row->user_id]['deleted'] == 1 ) {
                $item = "<span class=\"deleted\">$item</span>";
            }
            if ( $this->blockStatusByUid[$row->user_id]['sitewide'] == 1 ) {
                $blocked = ' ' . $this->msg( 'listusers-blocked', $userName )->escaped();
            }
        }
        $count = $this->msg( 'activeusers-count' )->numParams( $row->recentedits )
            ->params( $userName )->numParams( $this->RCMaxAge )->escaped();
 
        return Html::rawElement( 'li', [], "{$item} [{$count}]{$blocked}" );
    }
 
}
 
class_alias( ActiveUsersPager::class, 'ActiveUsersPager' );
 
class_alias( ActiveUsersPager::class, 'MediaWiki\\Pager\\ActiveUsersPager' );