RestrictedUserGroupConfigReader.php

Go to the documentation of this file.

<?php
/*
 * @license GPL-2.0-or-later
 * @file
 */
 
namespace MediaWiki\User;
 
use MediaWiki\Config\ServiceOptions;
use MediaWiki\MainConfigNames;
use MediaWiki\WikiMap\WikiMap;
 
class RestrictedUserGroupConfigReader {
 
    public const CONSTRUCTOR_OPTIONS = [
        MainConfigNames::RestrictedGroups,
    ];
 
    public const SCOPE_LOCAL = 'local';
 
    public function __construct(
        private readonly ServiceOptions $options,
        private readonly UserRequirementsConditionValidator $userRequirementsConditionValidator,
    ) {
    }
 
    public function getConfig( false|string $wiki = false, string $scope = self::SCOPE_LOCAL ): array {
        $isLocal = $wiki === false || $wiki === WikiMap::getCurrentWikiId();
        if ( $isLocal ) {
            $rawConfig = $this->getConfigForLocalWiki();
        } else {
            $rawConfig = $this->getConfigForRemoteWiki( $wiki );
        }
 
        $result = [];
        foreach ( $rawConfig as $groupName => $spec ) {
            if ( isset( $spec['scope'] ) && !in_array( $scope, $spec['scope'], true ) ) {
                continue;
            }
            $result[$groupName] = UserGroupRestrictions::newFromSpecValidated(
                $spec,
                $this->userRequirementsConditionValidator
            );
        }
        return $result;
    }
 
    private function getConfigForLocalWiki(): array {
        $this->options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
        return $this->options->get( MainConfigNames::RestrictedGroups );
    }
 
    private function getConfigForRemoteWiki( string $wiki ): array {
        global $wgConf;
        '@phan-var \MediaWiki\Config\SiteConfiguration $wgConf';
 
        return $wgConf->get( 'wgRestrictedGroups', $wiki ) ?? [];
    }
}