vendor/sensio/framework-extra-bundle/src/EventListener/IsGrantedListener.php line 39

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 Sensio\Bundle\FrameworkExtraBundle\EventListener;
  14. use Sensio\Bundle\FrameworkExtraBundle\Configuration\IsGranted;
  15. use Sensio\Bundle\FrameworkExtraBundle\Request\ArgumentNameConverter;
  16. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  17. use Symfony\Component\HttpKernel\Event\KernelEvent;
  18. use Symfony\Component\HttpKernel\Exception\HttpException;
  19. use Symfony\Component\HttpKernel\KernelEvents;
  20. use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
  21. use Symfony\Component\Security\Core\Exception\AccessDeniedException;
  23. /**
  24.  * Handles the IsGranted annotation on controllers.
  25.  *
  26.  * @author Ryan Weaver <ryan@knpuniversity.com>
  27.  */
  28. class IsGrantedListener implements EventSubscriberInterface
  29. {
  30.     private $argumentNameConverter;
  31.     private $authChecker;
  33.     public function __construct(ArgumentNameConverter $argumentNameConverter, AuthorizationCheckerInterface $authChecker = null)
  34.     {
  35.         $this->argumentNameConverter = $argumentNameConverter;
  36.         $this->authChecker = $authChecker;
  37.     }
  39.     public function onKernelControllerArguments(KernelEvent $event)
  40.     {
  41.         $request = $event->getRequest();
  43.         /** @var $configurations IsGranted[] */
  44.         if (!$configurations = $request->attributes->get('_is_granted')) {
  45.             return;
  46.         }
  48.         if (null === $this->authChecker) {
  49.             throw new \LogicException('To use the @IsGranted tag, you need to install symfony/security-bundle and configure your security system.');
  50.         }
  52.         $arguments = $this->argumentNameConverter->getControllerArguments($event);
  54.         foreach ($configurations as $configuration) {
  55.             $subjectRef = $configuration->getSubject();
  56.             $subject = null;
  58.             if ($subjectRef) {
  59.                 if (\is_array($subjectRef)) {
  60.                     foreach ($subjectRef as $ref) {
  61.                         if (!\array_key_exists($ref, $arguments)) {
  62.                             throw $this->createMissingSubjectException($ref);
  63.                         }
  65.                         $subject[$ref] = $arguments[$ref];
  66.                     }
  67.                 } else {
  68.                     if (!\array_key_exists($subjectRef, $arguments)) {
  69.                         throw $this->createMissingSubjectException($subjectRef);
  70.                     }
  72.                     $subject = $arguments[$subjectRef];
  73.                 }
  74.             }
  76.             if (!$this->authChecker->isGranted($configuration->getAttributes(), $subject)) {
  77.                 $argsString = $this->getIsGrantedString($configuration);
  79.                 $message = $configuration->getMessage() ?: sprintf('Access Denied by controller annotation @IsGranted(%s)', $argsString);
  81.                 if ($statusCode = $configuration->getStatusCode()) {
  82.                     throw new HttpException($statusCode, $message);
  83.                 }
  85.                 $accessDeniedException = new AccessDeniedException($message);
  86.                 $accessDeniedException->setAttributes($configuration->getAttributes());
  87.                 $accessDeniedException->setSubject($subject);
  89.                 throw $accessDeniedException;
  90.             }
  91.         }
  92.     }
  94.     private function createMissingSubjectException(string $subject)
  95.     {
  96.         return new \RuntimeException(sprintf('Could not find the subject "%s" for the @IsGranted annotation. Try adding a "$%s" argument to your controller method.', $subject, $subject));
  97.     }
  99.     private function getIsGrantedString(IsGranted $isGranted)
  100.     {
  101.         $attributes = array_map(function ($attribute) {
  102.             return sprintf('"%s"', $attribute);
  103.         }, (array) $isGranted->getAttributes());
  104.         if (1 === \count($attributes)) {
  105.             $argsString = reset($attributes);
  106.         } else {
  107.             $argsString = sprintf('[%s]', implode(', ', $attributes));
  108.         }
  110.         if (null !== $isGranted->getSubject()) {
  111.             $argsString = sprintf('%s, %s', $argsString, $isGranted->getSubject());
  112.         }
  114.         return $argsString;
  115.     }
  117.     /**
  118.      * @return array
  119.      */
  120.     public static function getSubscribedEvents()
  121.     {
  122.         return [KernelEvents::CONTROLLER_ARGUMENTS => 'onKernelControllerArguments'];
  123.     }
  124. }