vendor/friendsofsymfony/rest-bundle/EventListener/AccessDeniedListener.php line 14

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the FOSRestBundle package.
  5.  *
  6.  * (c) FriendsOfSymfony <http://friendsofsymfony.github.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 FOS\RestBundle\EventListener;
  14. @trigger_error(sprintf('The %s\AccessDeniedListener class is deprecated since FOSRestBundle 2.8.', __NAMESPACE__), E_USER_DEPRECATED);
  16. use FOS\RestBundle\FOSRestBundle;
  17. use Symfony\Component\HttpKernel\Event\ExceptionEvent;
  18. use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
  19. use Symfony\Component\HttpKernel\Exception\HttpException;
  20. use Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException;
  21. use Symfony\Component\HttpKernel\KernelEvents;
  22. use Symfony\Component\Security\Core\Exception\AccessDeniedException;
  23. use Symfony\Component\Security\Core\Exception\AuthenticationException;
  24. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  26. /**
  27.  * This listener handles ensures that for specific formats AccessDeniedExceptions
  28.  * will return a 403 regardless of how the firewall is configured.
  29.  *
  30.  * @author Lukas Kahwe Smith <smith@pooteeweet.org>
  31.  *
  32.  * @internal
  33.  */
  34. class AccessDeniedListener implements EventSubscriberInterface
  35. {
  36.     private $formats;
  37.     private $challenge;
  39.     /**
  40.      * @param array $formats An array with keys corresponding to request formats or content types
  41.      *                       that must be processed by this listener
  42.      */
  43.     public function __construct(array $formats, ?string $challenge)
  44.     {
  45.         $this->formats = $formats;
  46.         $this->challenge = $challenge;
  47.     }
  49.     /**
  50.      * @param ExceptionEvent $event
  51.      */
  52.     public function onKernelException($event)
  53.     {
  54.         static $handling;
  56.         if (true === $handling) {
  57.             return false;
  58.         }
  60.         $request = $event->getRequest();
  62.         if (!$request->attributes->get(FOSRestBundle::ZONE_ATTRIBUTE, true)) {
  63.             return false;
  64.         }
  66.         if (empty($this->formats[$request->getRequestFormat()]) && empty($this->formats[$request->getContentType()])) {
  67.             return false;
  68.         }
  70.         $handling = true;
  72.         if (method_exists($event, 'getThrowable')) {
  73.             $exception = $event->getThrowable();
  74.         } else {
  75.             $exception = $event->getException();
  76.         }
  78.         if ($exception instanceof AccessDeniedException) {
  79.             $exception = new AccessDeniedHttpException('You do not have the necessary permissions');
  80.         } elseif ($exception instanceof AuthenticationException) {
  81.             if ($this->challenge) {
  82.                 $exception = new UnauthorizedHttpException($this->challenge, 'You are not authenticated');
  83.             } else {
  84.                 $exception = new HttpException(401, 'You are not authenticated');
  85.             }
  86.         }
  88.         if (method_exists($event, 'setThrowable')) {
  89.             $event->setThrowable($exception);
  90.         } else {
  91.             $event->setException($exception);
  92.         }
  94.         $handling = false;
  95.     }
  97.     public static function getSubscribedEvents(): array
  98.     {
  99.         return [
  100.             KernelEvents::EXCEPTION => ['onKernelException', 5],
  101.         ];
  102.     }
  103. }