rhertogh\Yii2Oauth2Server\components\repositories\Oauth2ScopeRepository

Complexity

Total Complexity

15

Size/Duplication

Total Lines	108
Duplicated Lines	0 %

Test Coverage

Coverage

96.3%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getModelClass()	0	3	1
A	getScopeEntityByIdentifier()	0	3	1
C	finalizeScopes()	0	83	13

<?php

namespace rhertogh\Yii2Oauth2Server\components\repositories;

use League\OAuth2\Server\Entities\ClientEntityInterface;
use rhertogh\Yii2Oauth2Server\components\repositories\base\Oauth2BaseRepository;
use rhertogh\Yii2Oauth2Server\components\repositories\traits\Oauth2RepositoryIdentifierTrait;
use rhertogh\Yii2Oauth2Server\exceptions\Oauth2ServerException;
use rhertogh\Yii2Oauth2Server\helpers\DiHelper;
use rhertogh\Yii2Oauth2Server\interfaces\components\repositories\Oauth2ScopeRepositoryInterface;
use rhertogh\Yii2Oauth2Server\interfaces\models\Oauth2ClientInterface;
use rhertogh\Yii2Oauth2Server\interfaces\models\Oauth2ScopeInterface;
use rhertogh\Yii2Oauth2Server\models\Oauth2Scope;
use rhertogh\Yii2Oauth2Server\Oauth2Module;
use yii\base\InvalidArgumentException;
use yii\base\InvalidConfigException;

class Oauth2ScopeRepository extends Oauth2BaseRepository implements Oauth2ScopeRepositoryInterface
{
    use Oauth2RepositoryIdentifierTrait;

    /**
     * @inheritDoc
     * @return class-string<Oauth2ScopeInterface>

The doc comment class-string<Oauth2ScopeInterface> at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string<Oauth2ScopeInterface>.

     */
    public function getModelClass()
    {
        return Oauth2ScopeInterface::class;
    }

    /**
     * @inheritDoc
     * @throws InvalidConfigException
     */
    public function getScopeEntityByIdentifier($identifier)
    {
        return $this->findModelByIdentifier($identifier);
    }

    /**
     * @inheritDoc
     */
    public function finalizeScopes(
        array $scopes,
        $grantType,
        ClientEntityInterface $clientEntity,
        $userIdentifier = null
    ) {
        if (!($clientEntity instanceof Oauth2ClientInterface)) {
            throw new InvalidArgumentException(
                get_class($clientEntity) . ' must implement ' . Oauth2ClientInterface::class
            );
        } else {
            /** @var Oauth2ClientInterface $client */
            $client = $clientEntity;
        }

        // Only allow scopes without user if grant type is 'client_credentials'.
        if (empty($userIdentifier)) {
            if ($grantType === Oauth2Module::GRANT_TYPE_IDENTIFIER_CLIENT_CREDENTIALS) {
                $userIdentifier = $client->getClientCredentialsGrantUserId();
            } else {
                throw new InvalidArgumentException(
                    '$userIdentifier is required when $grantType is not "client_credentials".'
                );
            }
        }

        $requestedScopeIdentifiers = array_map(fn(Oauth2ScopeInterface $scope) => $scope->getIdentifier(), $scopes);

        // Validate requested scopes if they haven't been checked before (based on the grant type)

Inline comments must end in full-stops, exclamation marks, or question marks

        if (!in_array($grantType, [

The first expression of a multi-line control structure must be on the line after the opening parenthesis

            Oauth2Module::GRANT_TYPE_IDENTIFIER_AUTH_CODE,
            Oauth2Module::GRANT_TYPE_IDENTIFIER_IMPLICIT,
            Oauth2Module::GRANT_TYPE_IDENTIFIER_REFRESH_TOKEN,
        ])) {

Each line in a multi-line control structure must be indented at least once; expected at least 12 spaces, but found 8

The closing parenthesis of a multi-line control structure must be on the line after the last expression

            if (!$client->validateAuthRequestScopes($requestedScopeIdentifiers, $unauthorizedScopes)) {
                throw Oauth2ServerException::scopeNotAllowedForClient(array_shift($unauthorizedScopes));
            }
        }

        $clientAllowedScopes = $client->getAllowedScopes($requestedScopeIdentifiers);

        /** @var class-string<Oauth2ScopeInterface> $scopeClass */
        $scopeClass = DiHelper::getValidatedClassName(Oauth2ScopeInterface::class);

        if ($userIdentifier) {
            $clientAllowedScopeIds = array_map(fn($scope) => $scope->getPrimaryKey(), $clientAllowedScopes);

            $approvedScopes = $scopeClass::find()
                ->alias('scope')
                ->innerJoinWith('userClientScopes user_client_scope', false)
                ->andWhere([
                    'scope.id' => $clientAllowedScopeIds,
                    'user_client_scope.user_id' => $userIdentifier,
                    'user_client_scope.client_id' => $client->getPrimaryKey(),
                    'user_client_scope.enabled' => 1,
                ])
                ->orderBy('id')
                ->indexBy('id')
                ->all();
        } else {
            $approvedScopes = [];
        }

        foreach ($clientAllowedScopes as $clientAllowedScope) {
            $clientScope = $clientAllowedScope->getClientScope($client->getPrimaryKey());
            $appliedByDefault = ($clientScope ? $clientScope->getAppliedByDefault() : null)
                ?? $clientAllowedScope->getAppliedByDefault();
            $scopeId = $clientAllowedScope->getPrimaryKey();
            if (
                !array_key_exists($scopeId, $approvedScopes)
                && (
                    $appliedByDefault === Oauth2ScopeInterface::APPLIED_BY_DEFAULT_AUTOMATICALLY
                    || (
                        $appliedByDefault === Oauth2ScopeInterface::APPLIED_BY_DEFAULT_IF_REQUESTED
                        && in_array($clientAllowedScope->getIdentifier(), $requestedScopeIdentifiers)
                    )
                )
            ) {
                $approvedScopes[$scopeId] = $clientAllowedScope;
            }
        }

        return array_values($approvedScopes);
    }
}