vendor/symfony/workflow/EventListener/GuardListener.php line 46

  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\Workflow\EventListener;
  14. use Symfony\Component\Security\Core\Authentication\AuthenticationTrustResolverInterface;
  15. use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
  16. use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
  17. use Symfony\Component\Security\Core\Role\RoleHierarchyInterface;
  18. use Symfony\Component\Validator\Validator\ValidatorInterface;
  19. use Symfony\Component\Workflow\Event\GuardEvent;
  20. use Symfony\Component\Workflow\TransitionBlocker;
  22. /**
  23.  * @author Grégoire Pineau <lyrixx@lyrixx.info>
  24.  */
  25. class GuardListener
  26. {
  27.     private array $configuration;
  28.     private ExpressionLanguage $expressionLanguage;
  29.     private TokenStorageInterface $tokenStorage;
  30.     private AuthorizationCheckerInterface $authorizationChecker;
  31.     private AuthenticationTrustResolverInterface $trustResolver;
  32.     private ?RoleHierarchyInterface $roleHierarchy;
  33.     private ?ValidatorInterface $validator;
  35.     public function __construct(array $configuration, ExpressionLanguage $expressionLanguage, TokenStorageInterface $tokenStorage, AuthorizationCheckerInterface $authorizationChecker, AuthenticationTrustResolverInterface $trustResolver, RoleHierarchyInterface $roleHierarchy = null, ValidatorInterface $validator = null)
  36.     {
  37.         $this->configuration = $configuration;
  38.         $this->expressionLanguage = $expressionLanguage;
  39.         $this->tokenStorage = $tokenStorage;
  40.         $this->authorizationChecker = $authorizationChecker;
  41.         $this->trustResolver = $trustResolver;
  42.         $this->roleHierarchy = $roleHierarchy;
  43.         $this->validator = $validator;
  44.     }
  46.     public function onTransition(GuardEvent $event, string $eventName)
  47.     {
  48.         if (!isset($this->configuration[$eventName])) {
  49.             return;
  50.         }
  52.         $eventConfiguration = (array) $this->configuration[$eventName];
  53.         foreach ($eventConfiguration as $guard) {
  54.             if ($guard instanceof GuardExpression) {
  55.                 if ($guard->getTransition() !== $event->getTransition()) {
  56.                     continue;
  57.                 }
  58.                 $this->validateGuardExpression($event, $guard->getExpression());
  59.             } else {
  60.                 $this->validateGuardExpression($event, $guard);
  61.             }
  62.         }
  63.     }
  65.     private function validateGuardExpression(GuardEvent $event, string $expression)
  66.     {
  67.         if (!$this->expressionLanguage->evaluate($expression, $this->getVariables($event))) {
  68.             $blocker = TransitionBlocker::createBlockedByExpressionGuardListener($expression);
  69.             $event->addTransitionBlocker($blocker);
  70.         }
  71.     }
  73.     // code should be sync with Symfony\Component\Security\Core\Authorization\Voter\ExpressionVoter
  74.     private function getVariables(GuardEvent $event): array
  75.     {
  76.         $token = $this->tokenStorage->getToken();
  78.         $variables = [
  79.             'subject' => $event->getSubject(),
  80.             // needed for the is_granted expression function
  81.             'auth_checker' => $this->authorizationChecker,
  82.             // needed for the is_* expression function
  83.             'trust_resolver' => $this->trustResolver,
  84.             // needed for the is_valid expression function
  85.             'validator' => $this->validator,
  86.         ];
  88.         if (null === $token) {
  89.             return $variables + [
  90.                 'token' => null,
  91.                 'user' => null,
  92.                 'role_names' => [],
  93.             ];
  94.         }
  96.         return $variables + [
  97.             'token' => $token,
  98.             'user' => $token->getUser(),
  99.             'role_names' => $this->roleHierarchy->getReachableRoleNames($token->getRoleNames()),
  100.         ];
  101.     }
  102. }