vendor/contao/core-bundle/src/EventListener/MergeHttpHeadersListener.php line 63

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of Contao.
  7.  *
  8.  * (c) Leo Feyer
  9.  *
  10.  * @license LGPL-3.0-or-later
  11.  */
  13. namespace Contao\CoreBundle\EventListener;
  15. use Contao\CoreBundle\Framework\ContaoFramework;
  16. use Contao\CoreBundle\HttpKernel\Header\HeaderStorageInterface;
  17. use Contao\CoreBundle\HttpKernel\Header\NativeHeaderStorage;
  18. use Symfony\Component\HttpFoundation\Cookie;
  19. use Symfony\Component\HttpFoundation\Response;
  20. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  21. use Symfony\Contracts\Service\ResetInterface;
  23. /**
  24.  * @internal
  25.  */
  26. class MergeHttpHeadersListener implements ResetInterface
  27. {
  28.     /**
  29.      * @var ContaoFramework
  30.      */
  31.     private $framework;
  33.     /**
  34.      * @var HeaderStorageInterface
  35.      */
  36.     private $headerStorage;
  38.     /**
  39.      * @var array
  40.      */
  41.     private $headers = [];
  43.     /**
  44.      * @var array
  45.      */
  46.     private $multiHeaders = [
  47.         'set-cookie',
  48.         'link',
  49.         'vary',
  50.         'pragma',
  51.         'cache-control',
  52.     ];
  54.     public function __construct(ContaoFramework $framework, HeaderStorageInterface $headerStorage = null)
  55.     {
  56.         $this->framework = $framework;
  57.         $this->headerStorage = $headerStorage ?: new NativeHeaderStorage();
  58.     }
  60.     /**
  61.      * Adds the Contao headers to the Symfony response.
  62.      */
  63.     public function __invoke(ResponseEvent $event): void
  64.     {
  65.         if (!$this->framework->isInitialized()) {
  66.             return;
  67.         }
  69.         // Fetch remaining headers and add them to the response
  70.         $this->fetchHttpHeaders();
  71.         $this->setResponseHeaders($event->getResponse());
  72.     }
  74.     /**
  75.      * @return array<string>
  76.      */
  77.     public function getMultiHeaders(): array
  78.     {
  79.         return array_values($this->multiHeaders);
  80.     }
  82.     public function setMultiHeader(array $headers): void
  83.     {
  84.         $this->multiHeaders = $headers;
  85.     }
  87.     public function addMultiHeader(string $name): void
  88.     {
  89.         $uniqueKey = $this->getUniqueKey($name);
  91.         if (!\in_array($uniqueKey, $this->multiHeaders, true)) {
  92.             $this->multiHeaders[] = $uniqueKey;
  93.         }
  94.     }
  96.     public function removeMultiHeader(string $name): void
  97.     {
  98.         if (false !== ($i = array_search($this->getUniqueKey($name), $this->multiHeaders, true))) {
  99.             unset($this->multiHeaders[$i]);
  100.         }
  101.     }
  103.     public function reset(): void
  104.     {
  105.         $this->headers = [];
  106.     }
  108.     /**
  109.      * Fetches and stores HTTP headers from PHP.
  110.      */
  111.     private function fetchHttpHeaders(): void
  112.     {
  113.         $this->headers = array_merge($this->headers, $this->headerStorage->all());
  114.         $this->headerStorage->clear();
  115.     }
  117.     private function setResponseHeaders(Response $response): void
  118.     {
  119.         $allowOverrides = [];
  121.         foreach ($this->headers as $header) {
  122.             if (preg_match('/^HTTP\/[^ ]+ (\d{3})( (.+))?$/i', $header, $matches)) {
  123.                 $response->setStatusCode((int) $matches[1], $matches[3] ?? '');
  124.                 continue;
  125.             }
  127.             [$name, $content] = explode(':', $header, 2);
  129.             $uniqueKey = $this->getUniqueKey($name);
  131.             // Never merge cache-control headers (see #1246)
  132.             if ('cache-control' === $uniqueKey) {
  133.                 continue;
  134.             }
  136.             if ('set-cookie' === $uniqueKey) {
  137.                 $cookie = Cookie::fromString($content);
  139.                 if (session_name() === $cookie->getName()) {
  140.                     $this->headerStorage->add('Set-Cookie: '.$cookie);
  141.                     continue;
  142.                 }
  143.             }
  145.             if (\in_array($uniqueKey, $this->multiHeaders, true)) {
  146.                 $response->headers->set($uniqueKey, trim($content), false);
  147.             } elseif (isset($allowOverrides[$uniqueKey]) || !$response->headers->has($uniqueKey)) {
  148.                 $allowOverrides[$uniqueKey] = true;
  149.                 $response->headers->set($uniqueKey, trim($content));
  150.             }
  151.         }
  152.     }
  154.     private function getUniqueKey(string $name): string
  155.     {
  156.         return str_replace('_', '-', strtolower($name));
  157.     }
  158. }