ApiQueryUsers.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Api;
 
use MediaWiki\Auth\AuthManager;
use MediaWiki\Cache\GenderCache;
use MediaWiki\User\TempUser\TempUserConfig;
use MediaWiki\User\TempUser\TempUserDetailsLookup;
use MediaWiki\User\User;
use MediaWiki\User\UserFactory;
use MediaWiki\User\UserGroupManager;
use MediaWiki\User\UserIdentityValue;
use MediaWiki\User\UserNameUtils;
use Wikimedia\ParamValidator\ParamValidator;
use Wikimedia\Timestamp\TimestampFormat as TS;
 
class ApiQueryUsers extends ApiQueryBase {
    use ApiQueryBlockInfoTrait;
 
    private $prop;
 
    protected static $publicProps = [
        // everything except 'blockinfo' which might show hidden records if the user
        // making the request has the appropriate permissions
        'groups',
        'groupmemberships',
        'implicitgroups',
        'rights',
        'editcount',
        'registration',
        'emailable',
        'gender',
        'centralids',
        'cancreate',
        'tempexpired',
    ];
 
    public function __construct(
        ApiQuery $query,
        string $moduleName,
        private readonly UserNameUtils $userNameUtils,
        private readonly UserFactory $userFactory,
        private readonly UserGroupManager $userGroupManager,
        private readonly GenderCache $genderCache,
        private readonly AuthManager $authManager,
        private readonly TempUserConfig $tempUserConfig,
        private readonly TempUserDetailsLookup $tempUserDetailsLookup
    ) {
        parent::__construct( $query, $moduleName, 'us' );
    }
 
    public function execute() {
        $db = $this->getDB();
        $params = $this->extractRequestParams();
        $this->requireMaxOneParameter( $params, 'userids', 'users' );
 
        if ( $params['prop'] !== null ) {
            $this->prop = array_fill_keys( $params['prop'], true );
        } else {
            $this->prop = [];
        }
        $useNames = $params['users'] !== null;
 
        $users = (array)$params['users'];
        $userids = (array)$params['userids'];
 
        $goodNames = $done = [];
        $result = $this->getResult();
        // Canonicalize user names
        foreach ( $users as $u ) {
            $n = $this->userNameUtils->getCanonical( $u );
            if ( $n === false || $n === '' ) {
                $vals = [ 'name' => $u, 'invalid' => true ];
                $fit = $result->addValue( [ 'query', $this->getModuleName() ],
                    null, $vals );
                if ( !$fit ) {
                    $this->setContinueEnumParameter( 'users',
                        implode( '|', array_diff( $users, $done ) ) );
                    $goodNames = [];
                    break;
                }
                $done[] = $u;
            } else {
                $goodNames[] = $n;
            }
        }
 
        if ( $useNames ) {
            $parameters = &$goodNames;
        } else {
            $parameters = &$userids;
        }
 
        $result = $this->getResult();
 
        if ( count( $parameters ) ) {
            $this->getQueryBuilder()->merge( User::newQueryBuilder( $db ) );
            if ( $useNames ) {
                $this->addWhereFld( 'user_name', $goodNames );
            } else {
                $this->addWhereFld( 'user_id', $userids );
            }
 
            $this->addDeletedUserFilter();
 
            $data = [];
            $res = $this->select( __METHOD__ );
            $this->resetQueryParams();
 
            // get user groups if needed
            if ( isset( $this->prop['groups'] ) || isset( $this->prop['rights'] ) ) {
                $userGroups = [];
 
                $this->addTables( 'user' );
                if ( $useNames ) {
                    $this->addWhereFld( 'user_name', $goodNames );
                } else {
                    $this->addWhereFld( 'user_id', $userids );
                }
 
                $this->addTables( 'user_groups' );
                $this->addJoinConds( [ 'user_groups' => [ 'JOIN', 'ug_user=user_id' ] ] );
                $this->addFields( [ 'user_name' ] );
                $this->addFields( [ 'ug_user', 'ug_group', 'ug_expiry' ] );
                $this->addWhere(
                    $db->expr( 'ug_expiry', '=', null )->or( 'ug_expiry', '>=', $db->timestamp() )
                );
                $userGroupsRes = $this->select( __METHOD__ );
 
                foreach ( $userGroupsRes as $row ) {
                    $userGroups[$row->user_name][] = $row;
                }
            }
            if ( isset( $this->prop['gender'] ) ) {
                $userNames = [];
                foreach ( $res as $row ) {
                    $userNames[] = $row->user_name;
                }
                $this->genderCache->doQuery( $userNames, __METHOD__ );
            }
 
            if ( isset( $this->prop['blockinfo'] ) ) {
                $blockInfos = $this->getBlockDetailsForRows( $res );
            } else {
                $blockInfos = null;
            }
 
            if ( isset( $this->prop['tempexpired'] ) ) {
                $tempUsers = [];
                foreach ( $res as $row ) {
                    if ( $this->tempUserConfig->isTempName( $row->user_name ) ) {
                        $tempUsers[] = UserIdentityValue::newRegistered( $row->user_id, $row->user_name );
                    }
                }
                $this->tempUserDetailsLookup->preloadExpirationStatus( $tempUsers );
            }
 
            foreach ( $res as $row ) {
                // create user object and pass along $userGroups if set
                // that reduces the number of database queries needed in User dramatically
                if ( !isset( $userGroups ) ) {
                    $user = $this->userFactory->newFromRow( $row );
                } else {
                    if ( !isset( $userGroups[$row->user_name] ) || !is_array( $userGroups[$row->user_name] ) ) {
                        $userGroups[$row->user_name] = [];
                    }
                    $user = $this->userFactory->newFromRow( $row, [ 'user_groups' => $userGroups[$row->user_name] ] );
                }
                if ( $useNames ) {
                    $key = $user->getName();
                } else {
                    $key = $user->getId();
                }
                $data[$key]['userid'] = $user->getId();
                $data[$key]['name'] = $user->getName();
 
                if ( $user->isSystemUser() ) {
                    $data[$key]['systemuser'] = true;
                }
 
                if ( isset( $this->prop['editcount'] ) ) {
                    $data[$key]['editcount'] = $user->getEditCount();
                }
 
                if ( isset( $this->prop['registration'] ) ) {
                    $data[$key]['registration'] = wfTimestampOrNull( TS::ISO_8601, $user->getRegistration() );
                }
 
                if ( isset( $this->prop['groups'] ) ) {
                    $data[$key]['groups'] = $this->userGroupManager->getUserEffectiveGroups( $user );
                }
 
                if ( isset( $this->prop['groupmemberships'] ) ) {
                    $data[$key]['groupmemberships'] = array_map( static function ( $ugm ) {
                        return [
                            'group' => $ugm->getGroup(),
                            'expiry' => ApiResult::formatExpiry( $ugm->getExpiry() ),
                        ];
                    }, $this->userGroupManager->getUserGroupMemberships( $user ) );
                }
 
                if ( isset( $this->prop['implicitgroups'] ) ) {
                    $data[$key]['implicitgroups'] = $this->userGroupManager->getUserImplicitGroups( $user );
                }
 
                if ( isset( $this->prop['rights'] ) ) {
                    $data[$key]['rights'] = $this->getPermissionManager()
                        ->getUserPermissions( $user );
                }
                if ( $row->hu_deleted ) {
                    $data[$key]['hidden'] = true;
                }
                if ( isset( $this->prop['blockinfo'] ) && isset( $blockInfos[$row->user_id] ) ) {
                    $data[$key] += $blockInfos[$row->user_id];
                }
 
                if ( isset( $this->prop['emailable'] ) ) {
                    $data[$key]['emailable'] = $user->canReceiveEmail();
                }
 
                if ( isset( $this->prop['gender'] ) ) {
                    $data[$key]['gender'] = $this->genderCache->getGenderOf( $user, __METHOD__ );
                }
 
                if ( isset( $this->prop['centralids'] ) ) {
                    $data[$key] += ApiQueryUserInfo::getCentralUserInfo(
                        $this->getConfig(), $user, $params['attachedwiki']
                    );
                }
 
                if ( isset( $this->prop['tempexpired'] ) ) {
                    if ( $this->tempUserConfig->isTempName( $row->user_name ) ) {
                        $data[$key]['tempexpired'] = $this->tempUserDetailsLookup->isExpired( $user );
                    } else {
                        $data[$key]['tempexpired'] = null;
                    }
                }
            }
        }
 
        // Second pass: add result data to $retval
        foreach ( $parameters as $u ) {
            if ( !isset( $data[$u] ) ) {
                if ( $useNames ) {
                    $data[$u] = [ 'name' => $u, 'missing' => true ];
                    if ( isset( $this->prop['cancreate'] ) ) {
                        $status = $this->authManager->canCreateAccount( $u );
                        $data[$u]['cancreate'] = $status->isGood();
                        if ( !$status->isGood() ) {
                            $data[$u]['cancreateerror'] = $this->getErrorFormatter()->arrayFromStatus( $status );
                        }
                    }
                } else {
                    $data[$u] = [ 'userid' => $u, 'missing' => true ];
                }
 
            } else {
                if ( isset( $this->prop['groups'] ) && isset( $data[$u]['groups'] ) ) {
                    ApiResult::setArrayType( $data[$u]['groups'], 'array' );
                    ApiResult::setIndexedTagName( $data[$u]['groups'], 'g' );
                }
                if ( isset( $this->prop['groupmemberships'] ) && isset( $data[$u]['groupmemberships'] ) ) {
                    ApiResult::setArrayType( $data[$u]['groupmemberships'], 'array' );
                    ApiResult::setIndexedTagName( $data[$u]['groupmemberships'], 'groupmembership' );
                }
                if ( isset( $this->prop['implicitgroups'] ) && isset( $data[$u]['implicitgroups'] ) ) {
                    ApiResult::setArrayType( $data[$u]['implicitgroups'], 'array' );
                    ApiResult::setIndexedTagName( $data[$u]['implicitgroups'], 'g' );
                }
                if ( isset( $this->prop['rights'] ) && isset( $data[$u]['rights'] ) ) {
                    ApiResult::setArrayType( $data[$u]['rights'], 'array' );
                    ApiResult::setIndexedTagName( $data[$u]['rights'], 'r' );
                }
            }
 
            $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $data[$u] );
            if ( !$fit ) {
                if ( $useNames ) {
                    $this->setContinueEnumParameter( 'users',
                        implode( '|', array_diff( $users, $done ) ) );
                } else {
                    $this->setContinueEnumParameter( 'userids',
                        implode( '|', array_diff( $userids, $done ) ) );
                }
                break;
            }
            $done[] = $u;
        }
        $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'user' );
    }
 
    public function getCacheMode( $params ) {
        if ( array_diff( (array)$params['prop'], static::$publicProps ) ) {
            return 'anon-public-user-private';
        } else {
            return 'public';
        }
    }
 
    public function getAllowedParams() {
        return [
            'prop' => [
                ParamValidator::PARAM_ISMULTI => true,
                ParamValidator::PARAM_TYPE => [
                    'blockinfo',
                    'groups',
                    'groupmemberships',
                    'implicitgroups',
                    'rights',
                    'editcount',
                    'registration',
                    'emailable',
                    'gender',
                    'centralids',
                    'cancreate',
                    'tempexpired',
                    // When adding a prop, consider whether it should be added
                    // to self::$publicProps
                ],
                ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
            ],
            'attachedwiki' => null,
            'users' => [
                ParamValidator::PARAM_ISMULTI => true
            ],
            'userids' => [
                ParamValidator::PARAM_ISMULTI => true,
                ParamValidator::PARAM_TYPE => 'integer'
            ],
        ];
    }
 
    protected function getExamplesMessages() {
        return [
            'action=query&list=users&ususers=Example&usprop=groups|editcount|gender'
                => 'apihelp-query+users-example-simple',
        ];
    }
 
    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Users';
    }
}
 
class_alias( ApiQueryUsers::class, 'ApiQueryUsers' );