vendor/ibexa/http-cache/src/lib/EventListener/ConditionallyRemoveVaryHeaderListener.php line 49

Open in your IDE?
  1. <?php
  3. /**
  4.  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  5.  * @license For full copyright and license information view LICENSE file distributed with this source code.
  6.  */
  7. namespace Ibexa\HttpCache\EventListener;
  9. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  10. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  11. use Symfony\Component\HttpKernel\HttpKernelInterface;
  12. use Symfony\Component\HttpKernel\KernelEvents;
  14. /**
  15.  * Class ConditionallyRemoveVaryHeaderListener
  16.  * Unfortunately, FOS\HttpCacheBundle\EventListener\UserContextSubscriber will set Vary header on all requests.
  17.  * This event listeners removes the $userIdentifierHeaders headers again in responses to any of the given $routes.
  18.  * For such routes, the controller should instead set the Vary header explicitly.
  19.  */
  20. class ConditionallyRemoveVaryHeaderListener implements EventSubscriberInterface
  21. {
  22.     /**
  23.      * @var string[]
  24.      */
  25.     private $routes;
  27.     /**
  28.      * @var string[]
  29.      */
  30.     private $userIdentifierHeaders;
  32.     /**
  33.      * ConditionallyRemoveVaryHeaderListener constructor.
  34.      *
  35.      * @param array $routes List of routes which will not have default vary headers
  36.      * @param array $userIdentifierHeaders
  37.      */
  38.     public function __construct(array $routes, array $userIdentifierHeaders = ['Cookie', 'Authorization'])
  39.     {
  40.         $this->routes = $routes;
  41.         $this->userIdentifierHeaders = array_map('strtolower', $userIdentifierHeaders);
  42.     }
  44.     /**
  45.      * Remove Vary headers for matched routes.
  46.      *
  47.      * @param \Symfony\Component\HttpKernel\Event\ResponseEvent $event
  48.      */
  49.     public function onKernelResponse(ResponseEvent $event)
  50.     {
  51.         if (HttpKernelInterface::MAIN_REQUEST !== $event->getRequestType()) {
  52.             return;
  53.         }
  55.         if (!\in_array($event->getRequest()->get('_route'), $this->routes)) {
  56.             return;
  57.         }
  59.         $response = $event->getResponse();
  60.         $varyHeaders = array_map('strtolower', $response->headers->all('vary'));
  62.         foreach ($this->userIdentifierHeaders as $removableVary) {
  63.             $key = array_search($removableVary, $varyHeaders);
  64.             if ($key !== false) {
  65.                 unset($varyHeaders[$key]);
  66.             }
  67.         }
  68.         $response->setVary($varyHeaders, true);
  69.     }
  71.     /**
  72.      * {@inheritdoc}
  73.      */
  74.     public static function getSubscribedEvents()
  75.     {
  76.         return [
  77.             KernelEvents::RESPONSE => 'onKernelResponse',
  78.         ];
  79.     }
  80. }
  82. class_alias(ConditionallyRemoveVaryHeaderListener::class, 'EzSystems\PlatformHttpCacheBundle\EventListener\ConditionallyRemoveVaryHeaderListener');