vendor/symfony/security/Core/Authorization/Voter/ExpressionVoter.php line 28

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Security\Core\Authorization\Voter;
  14. use Symfony\Component\ExpressionLanguage\Expression;
  15. use Symfony\Component\ExpressionLanguage\ExpressionFunctionProviderInterface;
  16. use Symfony\Component\HttpFoundation\Request;
  17. use Symfony\Component\Security\Core\Authentication\AuthenticationTrustResolverInterface;
  18. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  19. use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
  20. use Symfony\Component\Security\Core\Authorization\ExpressionLanguage;
  21. use Symfony\Component\Security\Core\Role\RoleHierarchyInterface;
  23. /**
  24.  * ExpressionVoter votes based on the evaluation of an expression.
  25.  *
  26.  * @author Fabien Potencier <fabien@symfony.com>
  27.  */
  28. class ExpressionVoter implements VoterInterface
  29. {
  30.     private $expressionLanguage;
  31.     private $trustResolver;
  32.     private $authChecker;
  33.     private $roleHierarchy;
  35.     /**
  36.      * @param AuthorizationCheckerInterface $authChecker
  37.      */
  38.     public function __construct(ExpressionLanguage $expressionLanguage, AuthenticationTrustResolverInterface $trustResolver, $authChecker = null, RoleHierarchyInterface $roleHierarchy = null)
  39.     {
  40.         if ($authChecker instanceof RoleHierarchyInterface) {
  41.             @trigger_error(sprintf('Passing a RoleHierarchyInterface to "%s()" is deprecated since Symfony 4.2. Pass an AuthorizationCheckerInterface instead.', __METHOD__), E_USER_DEPRECATED);
  42.             $roleHierarchy = $authChecker;
  43.             $authChecker = null;
  44.         } elseif (null === $authChecker) {
  45.             @trigger_error(sprintf('Argument 3 passed to "%s()" should be an instance of AuthorizationCheckerInterface, not passing it is deprecated since Symfony 4.2.', __METHOD__), E_USER_DEPRECATED);
  46.         } elseif (!$authChecker instanceof AuthorizationCheckerInterface) {
  47.             throw new \TypeError(sprintf('Argument 3 passed to %s() must be an instance of %s or null, %s given.', __METHOD__, AuthorizationCheckerInterface::class, \is_object($authChecker) ? \get_class($authChecker) : \gettype($authChecker)));
  48.         }
  50.         $this->expressionLanguage = $expressionLanguage;
  51.         $this->trustResolver = $trustResolver;
  52.         $this->authChecker = $authChecker;
  53.         $this->roleHierarchy = $roleHierarchy;
  54.     }
  56.     /**
  57.      * @deprecated since Symfony 4.1, register the provider directly on the injected ExpressionLanguage instance instead.
  58.      */
  59.     public function addExpressionLanguageProvider(ExpressionFunctionProviderInterface $provider)
  60.     {
  61.         @trigger_error(sprintf('The "%s()" method is deprecated since Symfony 4.1, register the provider directly on the injected ExpressionLanguage instance instead.', __METHOD__), E_USER_DEPRECATED);
  63.         $this->expressionLanguage->registerProvider($provider);
  64.     }
  66.     /**
  67.      * {@inheritdoc}
  68.      */
  69.     public function vote(TokenInterface $token, $subject, array $attributes)
  70.     {
  71.         $result = VoterInterface::ACCESS_ABSTAIN;
  72.         $variables = null;
  73.         foreach ($attributes as $attribute) {
  74.             if (!$attribute instanceof Expression) {
  75.                 continue;
  76.             }
  78.             if (null === $variables) {
  79.                 $variables = $this->getVariables($token, $subject);
  80.             }
  82.             $result = VoterInterface::ACCESS_DENIED;
  83.             if ($this->expressionLanguage->evaluate($attribute, $variables)) {
  84.                 return VoterInterface::ACCESS_GRANTED;
  85.             }
  86.         }
  88.         return $result;
  89.     }
  91.     private function getVariables(TokenInterface $token, $subject)
  92.     {
  93.         if (null !== $this->roleHierarchy) {
  94.             $roles = $this->roleHierarchy->getReachableRoles($token->getRoles());
  95.         } else {
  96.             $roles = $token->getRoles();
  97.         }
  99.         $variables = [
  100.             'token' => $token,
  101.             'user' => $token->getUser(),
  102.             'object' => $subject,
  103.             'subject' => $subject,
  104.             'roles' => array_map(function ($role) { return $role->getRole(); }, $roles),
  105.             'trust_resolver' => $this->trustResolver,
  106.             'auth_checker' => $this->authChecker,
  107.         ];
  109.         // this is mainly to propose a better experience when the expression is used
  110.         // in an access control rule, as the developer does not know that it's going
  111.         // to be handled by this voter
  112.         if ($subject instanceof Request) {
  113.             $variables['request'] = $subject;
  114.         }
  116.         return $variables;
  117.     }
  118. }