DefaultOptionsLookup.php

Go to the documentation of this file.

<?php
namespace MediaWiki\User\Options;
 
use MediaWiki\Config\ServiceOptions;
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\Language\LanguageCode;
use MediaWiki\Language\LanguageConverter;
use MediaWiki\MainConfigNames;
use MediaWiki\Skin\Skin;
use MediaWiki\Title\NamespaceInfo;
use MediaWiki\User\UserIdentity;
use MediaWiki\User\UserIdentityLookup;
use MediaWiki\User\UserNameUtils;
use Wikimedia\Assert\Assert;
use Wikimedia\Rdbms\IDBAccessObject;
 
class DefaultOptionsLookup extends UserOptionsLookup {
 
    public const CONSTRUCTOR_OPTIONS = [
        MainConfigNames::DefaultSkin,
        MainConfigNames::DefaultUserOptions,
        MainConfigNames::NamespacesToBeSearchedDefault
    ];
 
    private ServiceOptions $serviceOptions;
    private LanguageCode $contentLang;
    private NamespaceInfo $nsInfo;
    private ConditionalDefaultsLookup $conditionalDefaultsLookup;
    private UserIdentityLookup $userIdentityLookup;
 
    private $cache = [];
 
    private $defaultOptions = null;
 
    private HookRunner $hookRunner;
 
    public function __construct(
        ServiceOptions $options,
        LanguageCode $contentLang,
        HookContainer $hookContainer,
        NamespaceInfo $nsInfo,
        ConditionalDefaultsLookup $conditionalUserOptionsDefaultsLookup,
        UserIdentityLookup $userIdentityLookup,
        UserNameUtils $userNameUtils
    ) {
        parent::__construct( $userNameUtils );
        $options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
        $this->serviceOptions = $options;
        $this->contentLang = $contentLang;
        $this->hookRunner = new HookRunner( $hookContainer );
        $this->nsInfo = $nsInfo;
        $this->conditionalDefaultsLookup = $conditionalUserOptionsDefaultsLookup;
        $this->userIdentityLookup = $userIdentityLookup;
    }
 
    private function getGenericDefaultOptions(): array {
        if ( $this->defaultOptions !== null ) {
            return $this->defaultOptions;
        }
 
        $this->defaultOptions = $this->serviceOptions->get( MainConfigNames::DefaultUserOptions );
 
        // Default language setting
        // NOTE: don't use the content language code since the static default variant would
        //  NOT always be the same as the content language code.
        $contentLangCode = $this->contentLang->toString();
        $LangsWithStaticDefaultVariant = LanguageConverter::$languagesWithStaticDefaultVariant;
        $staticDefaultVariant = $LangsWithStaticDefaultVariant[$contentLangCode] ?? $contentLangCode;
        $this->defaultOptions['language'] = $contentLangCode;
        $this->defaultOptions['variant'] = $staticDefaultVariant;
        foreach ( LanguageConverter::$languagesWithVariants as $langCode ) {
            $staticDefaultVariant = $LangsWithStaticDefaultVariant[$langCode] ?? $langCode;
            $this->defaultOptions["variant-$langCode"] = $staticDefaultVariant;
        }
 
        // NOTE: don't use SearchEngineConfig::getSearchableNamespaces here,
        // since extensions may change the set of searchable namespaces depending
        // on user groups/permissions.
        $nsSearchDefault = $this->serviceOptions->get( MainConfigNames::NamespacesToBeSearchedDefault );
        foreach ( $this->nsInfo->getValidNamespaces() as $n ) {
            $this->defaultOptions['searchNs' . $n] = ( $nsSearchDefault[$n] ?? false ) ? 1 : 0;
        }
        $this->defaultOptions['skin'] = Skin::normalizeKey(
            $this->serviceOptions->get( MainConfigNames::DefaultSkin ) );
 
        $this->hookRunner->onUserGetDefaultOptions( $this->defaultOptions );
 
        return $this->defaultOptions;
    }
 
    public function getDefaultOptions( ?UserIdentity $userIdentity = null ): array {
        $defaultOptions = $this->getGenericDefaultOptions();
 
        // If requested, process any conditional defaults
        if ( $userIdentity ) {
            $cacheKey = $this->getCacheKey( $userIdentity );
            if ( isset( $this->cache[$cacheKey] ) ) {
                return $this->cache[$cacheKey];
            }
            $conditionallyDefaultOptions = $this->conditionalDefaultsLookup->getConditionallyDefaultOptions();
            foreach ( $conditionallyDefaultOptions as $optionName ) {
                $conditionalDefault = $this->conditionalDefaultsLookup->getOptionDefaultForUser(
                    $optionName, $userIdentity
                );
                if ( $conditionalDefault !== null ) {
                    $defaultOptions[$optionName] = $conditionalDefault;
                }
            }
            $this->cache[$cacheKey] = $defaultOptions;
        }
 
        return $defaultOptions;
    }
 
    public function getOption(
        UserIdentity $user,
        string $oname,
        $defaultOverride = null,
        bool $ignoreHidden = false,
        int $queryFlags = IDBAccessObject::READ_NORMAL
    ) {
        $this->verifyUsable( $user, __METHOD__ );
        return $this->getDefaultOption( $oname ) ?? $defaultOverride;
    }
 
    public function getOptions(
        UserIdentity $user,
        int $flags = 0,
        int $queryFlags = IDBAccessObject::READ_NORMAL
    ): array {
        $this->verifyUsable( $user, __METHOD__ );
        if ( $flags & self::EXCLUDE_DEFAULTS ) {
            return [];
        }
        return $this->getDefaultOptions();
    }
 
    private function verifyUsable( UserIdentity $user, string $fname ) {
        if ( defined( 'MEDIAWIKI_INSTALL' ) ) {
            return;
        }
        Assert::precondition( !$user->isRegistered(), "$fname called on a registered user" );
    }
 
    public function getOptionBatchForUserNames( array $users, string $key ) {
        $genericDefault = $this->getGenericDefaultOptions()[$key] ?? '';
        $options = array_fill_keys( $users, $genericDefault );
        if ( $this->conditionalDefaultsLookup->hasConditionalDefault( $key ) ) {
            $userIdentities = $this->userIdentityLookup->newSelectQueryBuilder()
                ->whereUserNames( $users )
                ->caller( __METHOD__ )
                ->fetchUserIdentities();
            foreach ( $userIdentities as $user ) {
                $options[$user->getName()] = $this->conditionalDefaultsLookup
                    ->getOptionDefaultForUser( $key, $user );
            }
        }
        return $options;
    }
}
 
class_alias( DefaultOptionsLookup::class, 'MediaWiki\\User\\DefaultOptionsLookup' );