LocalIdLookup.php

Go to the documentation of this file.

<?php
namespace MediaWiki\User\CentralId;
 
use MediaWiki\Block\HideUserUtils;
use MediaWiki\Config\Config;
use MediaWiki\MainConfigNames;
use MediaWiki\User\UserIdentity;
use MediaWiki\WikiMap\WikiMap;
use Wikimedia\Rdbms\DBAccessObjectUtils;
use Wikimedia\Rdbms\IConnectionProvider;
use Wikimedia\Rdbms\IDBAccessObject;
 
class LocalIdLookup extends CentralIdLookup {
 
    private IConnectionProvider $dbProvider;
    private HideUserUtils $hideUserUtils;
 
    private $sharedDB;
 
    private $sharedTables;
 
    private $localDatabases;
 
    public function __construct(
        Config $config,
        IConnectionProvider $dbProvider,
        HideUserUtils $hideUserUtils
    ) {
        $this->sharedDB = $config->get( MainConfigNames::SharedDB );
        $this->sharedTables = $config->get( MainConfigNames::SharedTables );
        $this->localDatabases = $config->get( MainConfigNames::LocalDatabases );
        $this->dbProvider = $dbProvider;
        $this->hideUserUtils = $hideUserUtils;
    }
 
    public function isAttached( UserIdentity $user, $wikiId = UserIdentity::LOCAL ): bool {
        // If the user has no ID, it can't be attached
        if ( !$user->isRegistered() ) {
            return false;
        }
 
        return $this->isWikiSharingOurUsers( $wikiId );
    }
 
    private function isWikiSharingOurUsers( $wikiId ) {
        // Easy case, the local wiki
        if ( !$wikiId || WikiMap::isCurrentWikiId( $wikiId ) ) {
            return true;
        }
 
        // Assume that shared user tables are set up as described above, if
        // they're being used at all.
        return $this->sharedDB !== null &&
            in_array( 'user', $this->sharedTables, true ) &&
            in_array( $wikiId, $this->localDatabases, true );
    }
 
    public function lookupCentralIds(
        array $idToName, $audience = self::AUDIENCE_PUBLIC, $flags = IDBAccessObject::READ_NORMAL
    ): array {
        if ( !$idToName ) {
            return [];
        }
        $audience = $this->checkAudience( $audience );
        $db = DBAccessObjectUtils::getDBFromRecency( $this->dbProvider, $flags );
        $queryBuilder = $db->newSelectQueryBuilder();
        $queryBuilder
            ->select( [ 'user_id', 'user_name' ] )
            ->from( 'user' )
            ->where( [ 'user_id' => array_map( 'intval', array_keys( $idToName ) ) ] )
            ->recency( $flags );
 
        if ( $audience && !$audience->isAllowed( 'hideuser' ) ) {
            $this->hideUserUtils->addFieldToBuilder( $queryBuilder );
        }
 
        $res = $queryBuilder->caller( __METHOD__ )->fetchResultSet();
        foreach ( $res as $row ) {
            $idToName[$row->user_id] = empty( $row->hu_deleted ) ? $row->user_name : '';
        }
 
        return $idToName;
    }
 
    public function lookupUserNamesWithFilter(
        array $nameToId, $filter, $audience = self::AUDIENCE_PUBLIC,
        $flags = IDBAccessObject::READ_NORMAL,
        $wikiId = UserIdentity::LOCAL
    ): array {
        if ( !$nameToId ) {
            return [];
        }
        if ( ( $filter === self::FILTER_ATTACHED || $filter === self::FILTER_OWNED )
            && !$this->isWikiSharingOurUsers( $wikiId )
        ) {
            // No users pass the filter
            return $nameToId;
        }
 
        $audience = $this->checkAudience( $audience );
        $db = DBAccessObjectUtils::getDBFromRecency( $this->dbProvider, $flags );
        $queryBuilder = $db->newSelectQueryBuilder();
        $queryBuilder
            ->select( [ 'user_id', 'user_name' ] )
            ->from( 'user' )
            ->where( [ 'user_name' => array_map( 'strval', array_keys( $nameToId ) ) ] )
            ->recency( $flags );
 
        if ( $audience && !$audience->isAllowed( 'hideuser' ) ) {
            $queryBuilder->andWhere( $this->hideUserUtils->getExpression( $db ) );
        }
 
        $res = $queryBuilder->caller( __METHOD__ )->fetchResultSet();
        foreach ( $res as $row ) {
            $nameToId[$row->user_name] = (int)$row->user_id;
        }
 
        return $nameToId;
    }
}
 
class_alias( LocalIdLookup::class, 'LocalIdLookup' );