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

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\ExpressionLanguage;
  20. use Symfony\Component\Security\Core\Role\RoleHierarchyInterface;
  22. /**
  23.  * ExpressionVoter votes based on the evaluation of an expression.
  24.  *
  25.  * @author Fabien Potencier <fabien@symfony.com>
  26.  */
  27. class ExpressionVoter implements VoterInterface
  28. {
  29.     private $expressionLanguage;
  30.     private $trustResolver;
  31.     private $roleHierarchy;
  33.     public function __construct(ExpressionLanguage $expressionLanguage, AuthenticationTrustResolverInterface $trustResolver, RoleHierarchyInterface $roleHierarchy = null)
  34.     {
  35.         $this->expressionLanguage = $expressionLanguage;
  36.         $this->trustResolver = $trustResolver;
  37.         $this->roleHierarchy = $roleHierarchy;
  38.     }
  40.     /**
  41.      * @deprecated since Symfony 4.1, register the provider directly on the injected ExpressionLanguage instance instead.
  42.      */
  43.     public function addExpressionLanguageProvider(ExpressionFunctionProviderInterface $provider)
  44.     {
  45.         @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);
  47.         $this->expressionLanguage->registerProvider($provider);
  48.     }
  50.     /**
  51.      * {@inheritdoc}
  52.      */
  53.     public function vote(TokenInterface $token, $subject, array $attributes)
  54.     {
  55.         $result = VoterInterface::ACCESS_ABSTAIN;
  56.         $variables = null;
  57.         foreach ($attributes as $attribute) {
  58.             if (!$attribute instanceof Expression) {
  59.                 continue;
  60.             }
  62.             if (null === $variables) {
  63.                 $variables = $this->getVariables($token, $subject);
  64.             }
  66.             $result = VoterInterface::ACCESS_DENIED;
  67.             if ($this->expressionLanguage->evaluate($attribute, $variables)) {
  68.                 return VoterInterface::ACCESS_GRANTED;
  69.             }
  70.         }
  72.         return $result;
  73.     }
  75.     private function getVariables(TokenInterface $token, $subject)
  76.     {
  77.         if (null !== $this->roleHierarchy) {
  78.             $roles = $this->roleHierarchy->getReachableRoles($token->getRoles());
  79.         } else {
  80.             $roles = $token->getRoles();
  81.         }
  83.         $variables = [
  84.             'token' => $token,
  85.             'user' => $token->getUser(),
  86.             'object' => $subject,
  87.             'subject' => $subject,
  88.             'roles' => array_map(function ($role) { return $role->getRole(); }, $roles),
  89.             'trust_resolver' => $this->trustResolver,
  90.         ];
  92.         // this is mainly to propose a better experience when the expression is used
  93.         // in an access control rule, as the developer does not know that it's going
  94.         // to be handled by this voter
  95.         if ($subject instanceof Request) {
  96.             $variables['request'] = $subject;
  97.         }
  99.         return $variables;
  100.     }
  101. }