16050929464

Committed 03 Jul 2025 12:51PM UTC coverage: 22.065% (+0.2%) from 21.821%

Build # 16050929464

Build Type

push

github

Committed by

soyuka

Commit Message

chore: todo improvement

Run Details

11516 of 52192 relevant lines covered (22.06%)

22.08 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

100.0

/src/Symfony/Security/ResourceAccessChecker.php

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <dunglas@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace ApiPlatform\Symfony\Security;

use ApiPlatform\Metadata\ResourceAccessCheckerInterface;
use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
use Symfony\Component\Security\Core\Authentication\AuthenticationTrustResolverInterface;
use Symfony\Component\Security\Core\Authentication\Token\NullToken;
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
use Symfony\Component\Security\Core\Role\RoleHierarchyInterface;

/**
 * Checks if the logged user has sufficient permissions to access the given resource.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 */
final class ResourceAccessChecker implements ResourceAccessCheckerInterface
{
    public function __construct(private readonly ?ExpressionLanguage $expressionLanguage = null, private readonly ?AuthenticationTrustResolverInterface $authenticationTrustResolver = null, private readonly ?RoleHierarchyInterface $roleHierarchy = null, private readonly ?TokenStorageInterface $tokenStorage = null, private readonly ?AuthorizationCheckerInterface $authorizationChecker = null)
    {
    }

    public function isGranted(string $resourceClass, string $expression, array $extraVariables = []): bool
    {
        if (null === $this->tokenStorage || null === $this->authenticationTrustResolver) {
            throw new \LogicException('The "symfony/security" library must be installed to use the "security" attribute.');
        }

        if (null === $this->expressionLanguage) {
            throw new \LogicException('The "symfony/expression-language" library must be installed to use the "security" attribute.');
        }

        $variables = array_merge($extraVariables, [
            'trust_resolver' => $this->authenticationTrustResolver,
            'auth_checker' => $this->authorizationChecker, // needed for the is_granted expression function
        ]);

        if (null === $token = $this->tokenStorage->getToken()) {
            $token = new NullToken();
        }

        $variables = array_merge($variables, $this->getVariables($token));

        return (bool) $this->expressionLanguage->evaluate($expression, $variables);
    }

    /**
     * @copyright Fabien Potencier <fabien@symfony.com>
     *
     * @see https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Security/Core/Authorization/Voter/ExpressionVoter.php
     */
    private function getVariables(TokenInterface $token): array
    {
        return [
            'token' => $token,
            'user' => $token->getUser(),
            'roles' => $this->getEffectiveRoles($token),
        ];
    }

    /**
     * @return string[]
     */
    private function getEffectiveRoles(TokenInterface $token): array
    {
        if (null === $this->roleHierarchy) {
            return $token->getRoleNames();
        }

        return $this->roleHierarchy->getReachableRoleNames($token->getRoleNames());
    }
}

1	<?php
2
3	/*
4	* This file is part of the API Platform project.
5	*
6	* (c) Kévin Dunglas <dunglas@gmail.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	declare(strict_types=1);
13
14	namespace ApiPlatform\Symfony\Security;
15
16	use ApiPlatform\Metadata\ResourceAccessCheckerInterface;
17	use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
18	use Symfony\Component\Security\Core\Authentication\AuthenticationTrustResolverInterface;
19	use Symfony\Component\Security\Core\Authentication\Token\NullToken;
20	use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
21	use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
22	use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
23	use Symfony\Component\Security\Core\Role\RoleHierarchyInterface;
24
25	/**
26	* Checks if the logged user has sufficient permissions to access the given resource.
27	*
28	* @author Kévin Dunglas <dunglas@gmail.com>
29	*/
30	final class ResourceAccessChecker implements ResourceAccessCheckerInterface
31	{
32	public function __construct(private readonly ?ExpressionLanguage $expressionLanguage = null, private readonly ?AuthenticationTrustResolverInterface $authenticationTrustResolver = null, private readonly ?RoleHierarchyInterface $roleHierarchy = null, private readonly ?TokenStorageInterface $tokenStorage = null, private readonly ?AuthorizationCheckerInterface $authorizationChecker = null)
33	{
34	}	530✔
35
36	public function isGranted(string $resourceClass, string $expression, array $extraVariables = []): bool
37	{
38	if (null === $this->tokenStorage \|\| null === $this->authenticationTrustResolver) {	42✔
39	throw new \LogicException('The "symfony/security" library must be installed to use the "security" attribute.');	2✔
40	}
41
42	if (null === $this->expressionLanguage) {	40✔
43	throw new \LogicException('The "symfony/expression-language" library must be installed to use the "security" attribute.');	2✔
44	}
45
46	$variables = array_merge($extraVariables, [	38✔
47	'trust_resolver' => $this->authenticationTrustResolver,	38✔
48	'auth_checker' => $this->authorizationChecker, // needed for the is_granted expression function	38✔
49	]);	38✔
50
51	if (null === $token = $this->tokenStorage->getToken()) {	38✔
52	$token = new NullToken();	18✔
53	}
54
55	$variables = array_merge($variables, $this->getVariables($token));	38✔
56
57	return (bool) $this->expressionLanguage->evaluate($expression, $variables);	38✔
58	}
59
60	/**
61	* @copyright Fabien Potencier <fabien@symfony.com>
62	*
63	* @see https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Security/Core/Authorization/Voter/ExpressionVoter.php
64	*/
65	private function getVariables(TokenInterface $token): array
66	{
67	return [	38✔
68	'token' => $token,	38✔
69	'user' => $token->getUser(),	38✔
70	'roles' => $this->getEffectiveRoles($token),	38✔
71	];	38✔
72	}
73
74	/**
75	* @return string[]
76	*/
77	private function getEffectiveRoles(TokenInterface $token): array
78	{
79	if (null === $this->roleHierarchy) {	38✔
80	return $token->getRoleNames();	6✔
81	}
82
83	return $this->roleHierarchy->getReachableRoleNames($token->getRoleNames());	32✔
84	}
85	}

api-platform / core / 16050929464

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous