[FrameworkBundle] fixed guard event names for transitions

Author: destillat

EventListener/GuardExpression.php

@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Workflow\EventListener;
+
+use Symfony\Component\Workflow\Transition;
+
+class GuardExpression
+{
+    private $transition;
+
+    private $expression;
+
+    public function getTransition(): Transition
+    {
+        return $this->transition;
+    }
+
+    public function getExpression(): string
+    {
+        return $this->expression;
+    }
+
+    public function __construct(Transition $transition, string $expression)
+    {
+        $this->transition = $transition;
+        $this->expression = $expression;
+    }
+}

EventListener/GuardListener.php

@@ -18,6 +18,7 @@
 use Symfony\Component\Validator\Validator\ValidatorInterface;
 use Symfony\Component\Workflow\Event\GuardEvent;
 use Symfony\Component\Workflow\Exception\InvalidTokenConfigurationException;
+use Symfony\Component\Workflow\TransitionBlocker;
 
 /**
  * @author Grégoire Pineau <lyrixx@lyrixx.info>
@@ -32,7 +33,7 @@ class GuardListener
     private $roleHierarchy;
     private $validator;
 
-    public function __construct($configuration, ExpressionLanguage $expressionLanguage, TokenStorageInterface $tokenStorage, AuthorizationCheckerInterface $authenticationChecker, AuthenticationTrustResolverInterface $trustResolver, RoleHierarchyInterface $roleHierarchy = null, ValidatorInterface $validator = null)
+    public function __construct(array $configuration, ExpressionLanguage $expressionLanguage, TokenStorageInterface $tokenStorage, AuthorizationCheckerInterface $authenticationChecker, AuthenticationTrustResolverInterface $trustResolver, RoleHierarchyInterface $roleHierarchy = null, ValidatorInterface $validator = null)
     {
         $this->configuration = $configuration;
         $this->expressionLanguage = $expressionLanguage;
@@ -49,13 +50,29 @@ public function onTransition(GuardEvent $event, $eventName)
             return;
         }
 
-        if (!$this->expressionLanguage->evaluate($this->configuration[$eventName], $this->getVariables($event))) {
-            $event->setBlocked(true);
+        $eventConfiguration = (array) $this->configuration[$eventName];
+        foreach ($eventConfiguration as $guard) {
+            if ($guard instanceof GuardExpression) {
+                if ($guard->getTransition() !== $event->getTransition()) {
+                    continue;
+                }
+                $this->validateGuardExpression($event, $guard->getExpression());
+            } else {
+                $this->validateGuardExpression($event, $guard);
+            }
+        }
+    }
+
+    private function validateGuardExpression(GuardEvent $event, string $expression)
+    {
+        if (!$this->expressionLanguage->evaluate($expression, $this->getVariables($event))) {
+            $blocker = TransitionBlocker::createBlockedByExpressionGuardListener($expression);
+            $event->addTransitionBlocker($blocker);
         }
     }
 
     // code should be sync with Symfony\Component\Security\Core\Authorization\Voter\ExpressionVoter
-    private function getVariables(GuardEvent $event)
+    private function getVariables(GuardEvent $event): array
     {
         $token = $this->tokenStorage->getToken();
 

Tests/EventListener/GuardListenerTest.php

@@ -11,6 +11,7 @@
 use Symfony\Component\Validator\Validator\ValidatorInterface;
 use Symfony\Component\Workflow\Event\GuardEvent;
 use Symfony\Component\Workflow\EventListener\ExpressionLanguage;
+use Symfony\Component\Workflow\EventListener\GuardExpression;
 use Symfony\Component\Workflow\EventListener\GuardListener;
 use Symfony\Component\Workflow\Marking;
 use Symfony\Component\Workflow\Transition;
@@ -20,12 +21,17 @@ class GuardListenerTest extends TestCase
     private $authenticationChecker;
     private $validator;
     private $listener;
+    private $transition;
 
     protected function setUp()
     {
         $configuration = array(
             'test_is_granted' => 'is_granted("something")',
             'test_is_valid' => 'is_valid(subject)',
+            'test_expression' => array(
+                new GuardExpression($this->getTransition(true), '!is_valid(subject)'),
+                new GuardExpression($this->getTransition(true), 'is_valid(subject)'),
+            ),
         );
         $expressionLanguage = new ExpressionLanguage();
         $token = $this->getMockBuilder(TokenInterface::class)->getMock();
@@ -96,11 +102,38 @@ public function testWithValidatorSupportedEventAndAccept()
         $this->assertFalse($event->isBlocked());
     }
 
-    private function createEvent()
+    public function testWithGuardExpressionWithNotSupportedTransition()
+    {
+        $event = $this->createEvent(true);
+        $this->configureValidator(false, false);
+        $this->listener->onTransition($event, 'test_expression');
+
+        $this->assertFalse($event->isBlocked());
+    }
+
+    public function testWithGuardExpressionWithSupportedTransition()
+    {
+        $event = $this->createEvent();
+        $this->configureValidator(true, true);
+        $this->listener->onTransition($event, 'test_expression');
+
+        $this->assertFalse($event->isBlocked());
+    }
+
+    public function testGuardExpressionBlocks()
+    {
+        $event = $this->createEvent();
+        $this->configureValidator(true, false);
+        $this->listener->onTransition($event, 'test_expression');
+
+        $this->assertTrue($event->isBlocked());
+    }
+
+    private function createEvent($newTransition = false)
     {
         $subject = new \stdClass();
         $subject->marking = new Marking();
-        $transition = new Transition('name', 'from', 'to');
+        $transition = $this->getTransition($newTransition);
 
         return new GuardEvent($subject, $subject->marking, $transition);
     }
@@ -140,4 +173,13 @@ private function configureValidator($isUsed, $valid = true)
             ->willReturn($valid ? array() : array('a violation'))
         ;
     }
+
+    private function getTransition($new = false)
+    {
+        if ($new || !$this->transition) {
+            $this->transition = new Transition('name', 'from', 'to');
+        }
+
+        return $this->transition;
+    }
 }