vendor/symfony/security-core/Authorization/TraceableAccessDecisionManager.php line 54

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;
  14. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  15. use Symfony\Component\Security\Core\Authorization\Voter\VoterInterface;
  17. /**
  18.  * Decorates the original AccessDecisionManager class to log information
  19.  * about the security voters and the decisions made by them.
  20.  *
  21.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  22.  *
  23.  * @internal
  24.  */
  25. class TraceableAccessDecisionManager implements AccessDecisionManagerInterface
  26. {
  27.     private $manager;
  28.     private $strategy;
  29.     /** @var iterable<mixed, VoterInterface> */
  30.     private $voters = [];
  31.     private $decisionLog = []; // All decision logs
  32.     private $currentLog = [];  // Logs being filled in
  34.     public function __construct(AccessDecisionManagerInterface $manager)
  35.     {
  36.         $this->manager = $manager;
  38.         if ($this->manager instanceof AccessDecisionManager) {
  39.             // The strategy and voters are stored in a private properties of the decorated service
  40.             $reflection = new \ReflectionProperty(AccessDecisionManager::class, 'strategy');
  41.             $reflection->setAccessible(true);
  42.             $this->strategy = $reflection->getValue($manager);
  43.             $reflection = new \ReflectionProperty(AccessDecisionManager::class, 'voters');
  44.             $reflection->setAccessible(true);
  45.             $this->voters = $reflection->getValue($manager);
  46.         }
  47.     }
  49.     /**
  50.      * {@inheritdoc}
  51.      *
  52.      * @param bool $allowMultipleAttributes Whether to allow passing multiple values to the $attributes array
  53.      */
  54.     public function decide(TokenInterface $token, array $attributes, $object = null/* , bool $allowMultipleAttributes = false */): bool
  55.     {
  56.         $currentDecisionLog = [
  57.             'attributes' => $attributes,
  58.             'object' => $object,
  59.             'voterDetails' => [],
  60.         ];
  62.         $this->currentLog[] = &$currentDecisionLog;
  64.         $result = $this->manager->decide($token, $attributes, $object, 3 < \func_num_args() && func_get_arg(3));
  66.         $currentDecisionLog['result'] = $result;
  68.         $this->decisionLog[] = array_pop($this->currentLog); // Using a stack since decide can be called by voters
  70.         return $result;
  71.     }
  73.     /**
  74.      * Adds voter vote and class to the voter details.
  75.      *
  76.      * @param array $attributes attributes used for the vote
  77.      * @param int   $vote       vote of the voter
  78.      */
  79.     public function addVoterVote(VoterInterface $voter, array $attributes, int $vote)
  80.     {
  81.         $currentLogIndex = \count($this->currentLog) - 1;
  82.         $this->currentLog[$currentLogIndex]['voterDetails'][] = [
  83.             'voter' => $voter,
  84.             'attributes' => $attributes,
  85.             'vote' => $vote,
  86.         ];
  87.     }
  89.     public function getStrategy(): string
  90.     {
  91.         if (null === $this->strategy) {
  92.             return '-';
  93.         }
  94.         if (method_exists($this->strategy, '__toString')) {
  95.             return (string) $this->strategy;
  96.         }
  98.         return get_debug_type($this->strategy);
  99.     }
  101.     /**
  102.      * @return iterable<mixed, VoterInterface>
  103.      */
  104.     public function getVoters(): iterable
  105.     {
  106.         return $this->voters;
  107.     }
  109.     public function getDecisionLog(): array
  110.     {
  111.         return $this->decisionLog;
  112.     }
  113. }
  115. if (!class_exists(DebugAccessDecisionManager::class, false)) {
  116.     class_alias(TraceableAccessDecisionManager::class, DebugAccessDecisionManager::class);
  117. }