vendor/symfony/security-core/Authorization/AccessDecisionManager.php line 82

  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;
  14. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  15. use Symfony\Component\Security\Core\Authorization\Strategy\AccessDecisionStrategyInterface;
  16. use Symfony\Component\Security\Core\Authorization\Strategy\AffirmativeStrategy;
  17. use Symfony\Component\Security\Core\Authorization\Voter\CacheableVoterInterface;
  18. use Symfony\Component\Security\Core\Authorization\Voter\VoterInterface;
  19. use Symfony\Component\Security\Core\Exception\InvalidArgumentException;
  21. /**
  22.  * AccessDecisionManager is the base class for all access decision managers
  23.  * that use decision voters.
  24.  *
  25.  * @author Fabien Potencier <fabien@symfony.com>
  26.  */
  27. final class AccessDecisionManager implements AccessDecisionManagerInterface
  28. {
  29.     private const VALID_VOTES = [
  30.         VoterInterface::ACCESS_GRANTED => true,
  31.         VoterInterface::ACCESS_DENIED => true,
  32.         VoterInterface::ACCESS_ABSTAIN => true,
  33.     ];
  35.     private iterable $voters;
  36.     private array $votersCacheAttributes = [];
  37.     private array $votersCacheObject = [];
  38.     private AccessDecisionStrategyInterface $strategy;
  40.     /**
  41.      * @param iterable<mixed, VoterInterface> $voters An array or an iterator of VoterInterface instances
  42.      */
  43.     public function __construct(iterable $voters = [], AccessDecisionStrategyInterface $strategy = null)
  44.     {
  45.         $this->voters = $voters;
  46.         $this->strategy = $strategy ?? new AffirmativeStrategy();
  47.     }
  49.     /**
  50.      * @param bool $allowMultipleAttributes Whether to allow passing multiple values to the $attributes array
  51.      */
  52.     public function decide(TokenInterface $token, array $attributes, mixed $object = null, bool $allowMultipleAttributes = false): bool
  53.     {
  54.         // Special case for AccessListener, do not remove the right side of the condition before 6.0
  55.         if (\count($attributes) > 1 && !$allowMultipleAttributes) {
  56.             throw new InvalidArgumentException(sprintf('Passing more than one Security attribute to "%s()" is not supported.', __METHOD__));
  57.         }
  59.         return $this->strategy->decide(
  60.             $this->collectResults($token, $attributes, $object)
  61.         );
  62.     }
  64.     /**
  65.      * @return \Traversable<int, int>
  66.      */
  67.     private function collectResults(TokenInterface $token, array $attributes, mixed $object): \Traversable
  68.     {
  69.         foreach ($this->getVoters($attributes, $object) as $voter) {
  70.             $result = $voter->vote($token, $object, $attributes);
  71.             if (!\is_int($result) || !(self::VALID_VOTES[$result] ?? false)) {
  72.                 throw new \LogicException(sprintf('"%s::vote()" must return one of "%s" constants ("ACCESS_GRANTED", "ACCESS_DENIED" or "ACCESS_ABSTAIN"), "%s" returned.', get_debug_type($voter), VoterInterface::class, var_export($result, true)));
  73.             }
  75.             yield $result;
  76.         }
  77.     }
  79.     /**
  80.      * @return iterable<mixed, VoterInterface>
  81.      */
  82.     private function getVoters(array $attributes, $object = null): iterable
  83.     {
  84.         $keyAttributes = [];
  85.         foreach ($attributes as $attribute) {
  86.             $keyAttributes[] = \is_string($attribute) ? $attribute : null;
  87.         }
  88.         // use `get_class` to handle anonymous classes
  89.         $keyObject = \is_object($object) ? $object::class : get_debug_type($object);
  90.         foreach ($this->voters as $key => $voter) {
  91.             if (!$voter instanceof CacheableVoterInterface) {
  92.                 yield $voter;
  93.                 continue;
  94.             }
  96.             $supports = true;
  97.             // The voter supports the attributes if it supports at least one attribute of the list
  98.             foreach ($keyAttributes as $keyAttribute) {
  99.                 if (null === $keyAttribute) {
  100.                     $supports = true;
  101.                 } elseif (!isset($this->votersCacheAttributes[$keyAttribute][$key])) {
  102.                     $this->votersCacheAttributes[$keyAttribute][$key] = $supports = $voter->supportsAttribute($keyAttribute);
  103.                 } else {
  104.                     $supports = $this->votersCacheAttributes[$keyAttribute][$key];
  105.                 }
  106.                 if ($supports) {
  107.                     break;
  108.                 }
  109.             }
  110.             if (!$supports) {
  111.                 continue;
  112.             }
  114.             if (!isset($this->votersCacheObject[$keyObject][$key])) {
  115.                 $this->votersCacheObject[$keyObject][$key] = $supports = $voter->supportsType($keyObject);
  116.             } else {
  117.                 $supports = $this->votersCacheObject[$keyObject][$key];
  118.             }
  119.             if (!$supports) {
  120.                 continue;
  121.             }
  122.             yield $voter;
  123.         }
  124.     }
  125. }