vendor/symfony/http-kernel/EventListener/FragmentListener.php line 53

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\HttpKernel\EventListener;
  14. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\HttpKernel\Event\RequestEvent;
  17. use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
  18. use Symfony\Component\HttpKernel\KernelEvents;
  19. use Symfony\Component\HttpKernel\UriSigner;
  21. /**
  22.  * Handles content fragments represented by special URIs.
  23.  *
  24.  * All URL paths starting with /_fragment are handled as
  25.  * content fragments by this listener.
  26.  *
  27.  * Throws an AccessDeniedHttpException exception if the request
  28.  * is not signed or if it is not an internal sub-request.
  29.  *
  30.  * @author Fabien Potencier <fabien@symfony.com>
  31.  *
  32.  * @final
  33.  */
  34. class FragmentListener implements EventSubscriberInterface
  35. {
  36.     private $signer;
  37.     private $fragmentPath;
  39.     /**
  40.      * @param string $fragmentPath The path that triggers this listener
  41.      */
  42.     public function __construct(UriSigner $signer, string $fragmentPath = '/_fragment')
  43.     {
  44.         $this->signer = $signer;
  45.         $this->fragmentPath = $fragmentPath;
  46.     }
  48.     /**
  49.      * Fixes request attributes when the path is '/_fragment'.
  50.      *
  51.      * @throws AccessDeniedHttpException if the request does not come from a trusted IP
  52.      */
  53.     public function onKernelRequest(RequestEvent $event)
  54.     {
  55.         $request = $event->getRequest();
  57.         if ($this->fragmentPath !== rawurldecode($request->getPathInfo())) {
  58.             return;
  59.         }
  61.         if ($request->attributes->has('_controller')) {
  62.             // Is a sub-request: no need to parse _path but it should still be removed from query parameters as below.
  63.             $request->query->remove('_path');
  65.             return;
  66.         }
  68.         if ($event->isMasterRequest()) {
  69.             $this->validateRequest($request);
  70.         }
  72.         parse_str($request->query->get('_path', ''), $attributes);
  73.         $request->attributes->add($attributes);
  74.         $request->attributes->set('_route_params', array_replace($request->attributes->get('_route_params', []), $attributes));
  75.         $request->query->remove('_path');
  76.     }
  78.     protected function validateRequest(Request $request)
  79.     {
  80.         // is the Request safe?
  81.         if (!$request->isMethodSafe()) {
  82.             throw new AccessDeniedHttpException();
  83.         }
  85.         // is the Request signed?
  86.         if ($this->signer->checkRequest($request)) {
  87.             return;
  88.         }
  90.         throw new AccessDeniedHttpException();
  91.     }
  93.     public static function getSubscribedEvents(): array
  94.     {
  95.         return [
  96.             KernelEvents::REQUEST => [['onKernelRequest', 48]],
  97.         ];
  98.     }
  99. }