ActiveUsersPager.php

Go to the documentation of this file.

<?php
class ActiveUsersPager extends UsersPager {

    protected $opts;

    protected $hideGroups = [];

    protected $hideRights = [];

    private $blockStatusByUid;

    function __construct( IContextSource $context = null, $group = null, $par = null ) {
        parent::__construct( $context );

        $this->RCMaxAge = $this->getConfig()->get( 'ActiveUserDays' );
        $un = $this->getRequest()->getText( 'username', $par );
        $this->requestedUser = '';
        if ( $un != '' ) {
            $username = Title::makeTitleSafe( NS_USER, $un );
            if ( !is_null( $username ) ) {
                $this->requestedUser = $username->getText();
            }
        }

        $this->setupOptions();
    }

    public function setupOptions() {
        $this->opts = new FormOptions();

        $this->opts->add( 'hidebots', false, FormOptions::BOOL );
        $this->opts->add( 'hidesysops', false, FormOptions::BOOL );

        $this->opts->fetchValuesFromRequest( $this->getRequest() );

        if ( $this->opts->getValue( 'hidebots' ) == 1 ) {
            $this->hideRights[] = 'bot';
        }
        if ( $this->opts->getValue( 'hidesysops' ) == 1 ) {
            $this->hideGroups[] = 'sysop';
        }
    }

    function getIndexField() {
        return 'qcc_title';
    }

    function getQueryInfo() {
        $dbr = $this->getDatabase();

        $activeUserSeconds = $this->getConfig()->get( 'ActiveUserDays' ) * 86400;
        $timestamp = $dbr->timestamp( wfTimestamp( TS_UNIX ) - $activeUserSeconds );
        $conds = [
            'qcc_type' => 'activeusers',
            'qcc_namespace' => NS_USER,
            'user_name = qcc_title',
            'rc_user_text = qcc_title',
            'rc_type != ' . $dbr->addQuotes( RC_EXTERNAL ), // Don't count wikidata.
            'rc_type != ' . $dbr->addQuotes( RC_CATEGORIZE ), // Don't count categorization changes.
            'rc_log_type IS NULL OR rc_log_type != ' . $dbr->addQuotes( 'newusers' ),
            'rc_timestamp >= ' . $dbr->addQuotes( $timestamp ),
        ];
        if ( $this->requestedUser != '' ) {
            $conds[] = 'qcc_title >= ' . $dbr->addQuotes( $this->requestedUser );
        }
        if ( !$this->getUser()->isAllowed( 'hideuser' ) ) {
            $conds[] = 'NOT EXISTS (' . $dbr->selectSQLText(
                    'ipblocks', '1', [ 'ipb_user=user_id', 'ipb_deleted' => 1 ]
                ) . ')';
        }

        return [
            'tables' => [ 'querycachetwo', 'user', 'recentchanges' ],
            'fields' => [ 'user_name', 'user_id', 'recentedits' => 'COUNT(*)', 'qcc_title' ],
            'options' => [ 'GROUP BY' => [ 'qcc_title' ] ],
            'conds' => $conds
        ];
    }

    function doBatchLookups() {
        parent::doBatchLookups();

        $uids = [];
        foreach ( $this->mResult as $row ) {
            $uids[] = $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();
        $res = $dbr->select( 'ipblocks',
            [ 'ipb_user', 'MAX(ipb_deleted) AS block_status' ],
            [ 'ipb_user' => $uids ],
            __METHOD__,
            [ 'GROUP BY' => [ 'ipb_user' ] ]
        );
        $this->blockStatusByUid = [];
        foreach ( $res as $row ) {
            $this->blockStatusByUid[$row->ipb_user] = $row->block_status; // 0 or 1
        }
        $this->mResult->seek( 0 );
    }

    function formatRow( $row ) {
        $userName = $row->user_name;

        $ulinks = Linker::userLink( $row->user_id, $userName );
        $ulinks .= Linker::userToolLinks( $row->user_id, $userName );

        $lang = $this->getLanguage();

        $list = [];
        $user = User::newFromId( $row->user_id );

        // User right filter
        foreach ( $this->hideRights as $right ) {
            // Calling User::getRights() within the loop so that
            // if the hideRights() filter is empty, we don't have to
            // trigger the lazy-init of the big userrights array in the
            // User object
            if ( in_array( $right, $user->getRights() ) ) {
                return '';
            }
        }

        // User group filter
        // Note: This is a different loop than for user rights,
        // because we're reusing it to build the group links
        // at the same time
        $groups_list = self::getGroups( intval( $row->user_id ), $this->userGroupCache );
        foreach ( $groups_list as $group ) {
            if ( in_array( $group, $this->hideGroups ) ) {
                return '';
            }
            $list[] = self::buildGroupLink( $group, $userName );
        }

        $groups = $lang->commaList( $list );

        $item = $lang->specialList( $ulinks, $groups );

        $isBlocked = isset( $this->blockStatusByUid[$row->user_id] );
        if ( $isBlocked && $this->blockStatusByUid[$row->user_id] == 1 ) {
            $item = "<span class=\"deleted\">$item</span>";
        }
        $count = $this->msg( 'activeusers-count' )->numParams( $row->recentedits )
            ->params( $userName )->numParams( $this->RCMaxAge )->escaped();
        $blocked = $isBlocked ? ' ' . $this->msg( 'listusers-blocked', $userName )->escaped() : '';

        return Html::rawElement( 'li', [], "{$item} [{$count}]{$blocked}" );
    }

    function getPageHeader() {
        $self = $this->getTitle();
        $limit = $this->mLimit ? Html::hidden( 'limit', $this->mLimit ) : '';

        # Form tag
        $out = Xml::openElement( 'form', [ 'method' => 'get', 'action' => wfScript() ] );
        $out .= Xml::fieldset( $this->msg( 'activeusers' )->text() ) . "\n";
        $out .= Html::hidden( 'title', $self->getPrefixedDBkey() ) . $limit . "\n";

        # Username field (with autocompletion support)
        $this->getOutput()->addModules( 'mediawiki.userSuggest' );
        $out .= Xml::inputLabel(
                $this->msg( 'activeusers-from' )->text(),
                'username',
                'offset',
                20,
                $this->requestedUser,
                [
                    'class' => 'mw-ui-input-inline mw-autocomplete-user',
                    'tabindex' => 1,
                ] + (
                    // Set autofocus on blank input
                $this->requestedUser === '' ? [ 'autofocus' => '' ] : []
                )
            ) . '<br />';

        $out .= Xml::checkLabel( $this->msg( 'activeusers-hidebots' )->text(),
            'hidebots', 'hidebots', $this->opts->getValue( 'hidebots' ), [ 'tabindex' => 2 ] );

        $out .= Xml::checkLabel(
                $this->msg( 'activeusers-hidesysops' )->text(),
                'hidesysops',
                'hidesysops',
                $this->opts->getValue( 'hidesysops' ),
                [ 'tabindex' => 3 ]
            ) . '<br />';

        # Submit button and form bottom
        $out .= Xml::submitButton(
                $this->msg( 'activeusers-submit' )->text(),
                [ 'tabindex' => 4 ]
            ) . "\n";
        $out .= Xml::closeElement( 'fieldset' );
        $out .= Xml::closeElement( 'form' );

        return $out;
    }

}