vendor/symfony/http-foundation/ResponseHeaderBag.php

<?php
 
/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
 
namespace Symfony\Component\HttpFoundation;
 
class ResponseHeaderBag extends HeaderBag
{
    const COOKIES_FLAT = 'flat';
    const COOKIES_ARRAY = 'array';
 
    const DISPOSITION_ATTACHMENT = 'attachment';
    const DISPOSITION_INLINE = 'inline';
 
    protected $computedCacheControl = [];
    protected $cookies = [];
    protected $headerNames = [];
 
    public function __construct(array $headers = [])
    {
        parent::__construct($headers);
 
        if (!isset($this->headers['cache-control'])) {
            $this->set('Cache-Control', '');
        }
 
        /* RFC2616 - 14.18 says all Responses need to have a Date */
        if (!isset($this->headers['date'])) {
            $this->initDate();
        }
    }
 
    public function allPreserveCase()
    {
        $headers = [];
        foreach ($this->all() as $name => $value) {
            $headers[$this->headerNames[$name] ?? $name] = $value;
        }
 
        return $headers;
    }
 
    public function allPreserveCaseWithoutCookies()
    {
        $headers = $this->allPreserveCase();
        if (isset($this->headerNames['set-cookie'])) {
            unset($headers[$this->headerNames['set-cookie']]);
        }
 
        return $headers;
    }
 
    public function replace(array $headers = [])
    {
        $this->headerNames = [];
 
        parent::replace($headers);
 
        if (!isset($this->headers['cache-control'])) {
            $this->set('Cache-Control', '');
        }
 
        if (!isset($this->headers['date'])) {
            $this->initDate();
        }
    }
 
    public function all(/*string $key = null*/)
    {
        $headers = parent::all();
 
        if (1 <= \func_num_args() && null !== $key = func_get_arg(0)) {
            $key = strtr($key, self::UPPER, self::LOWER);
 
            return 'set-cookie' !== $key ? $headers[$key] ?? [] : array_map('strval', $this->getCookies());
        }
 
        foreach ($this->getCookies() as $cookie) {
            $headers['set-cookie'][] = (string) $cookie;
        }
 
        return $headers;
    }
 
    public function set($key, $values, $replace = true)
    {
        $uniqueKey = strtr($key, self::UPPER, self::LOWER);
 
        if ('set-cookie' === $uniqueKey) {
            if ($replace) {
                $this->cookies = [];
            }
            foreach ((array) $values as $cookie) {
                $this->setCookie(Cookie::fromString($cookie));
            }
            $this->headerNames[$uniqueKey] = $key;
 
            return;
        }
 
        $this->headerNames[$uniqueKey] = $key;
 
        parent::set($key, $values, $replace);
 
        // ensure the cache-control header has sensible defaults
        if (\in_array($uniqueKey, ['cache-control', 'etag', 'last-modified', 'expires'], true) && '' !== $computed = $this->computeCacheControlValue()) {
            $this->headers['cache-control'] = [$computed];
            $this->headerNames['cache-control'] = 'Cache-Control';
            $this->computedCacheControl = $this->parseCacheControl($computed);
        }
    }
 
    public function remove($key)
    {
        $uniqueKey = strtr($key, self::UPPER, self::LOWER);
        unset($this->headerNames[$uniqueKey]);
 
        if ('set-cookie' === $uniqueKey) {
            $this->cookies = [];
 
            return;
        }
 
        parent::remove($key);
 
        if ('cache-control' === $uniqueKey) {
            $this->computedCacheControl = [];
        }
 
        if ('date' === $uniqueKey) {
            $this->initDate();
        }
    }
 
    public function hasCacheControlDirective($key)
    {
        return \array_key_exists($key, $this->computedCacheControl);
    }
 
    public function getCacheControlDirective($key)
    {
        return \array_key_exists($key, $this->computedCacheControl) ? $this->computedCacheControl[$key] : null;
    }
 
    public function setCookie(Cookie $cookie)
    {
        $this->cookies[$cookie->getDomain()][$cookie->getPath()][$cookie->getName()] = $cookie;
        $this->headerNames['set-cookie'] = 'Set-Cookie';
    }
 
    public function removeCookie($name, $path = '/', $domain = null)
    {
        if (null === $path) {
            $path = '/';
        }
 
        unset($this->cookies[$domain][$path][$name]);
 
        if (empty($this->cookies[$domain][$path])) {
            unset($this->cookies[$domain][$path]);
 
            if (empty($this->cookies[$domain])) {
                unset($this->cookies[$domain]);
            }
        }
 
        if (empty($this->cookies)) {
            unset($this->headerNames['set-cookie']);
        }
    }
 
    public function getCookies($format = self::COOKIES_FLAT)
    {
        if (!\in_array($format, [self::COOKIES_FLAT, self::COOKIES_ARRAY])) {
            throw new \InvalidArgumentException(sprintf('Format "%s" invalid (%s).', $format, implode(', ', [self::COOKIES_FLAT, self::COOKIES_ARRAY])));
        }
 
        if (self::COOKIES_ARRAY === $format) {
            return $this->cookies;
        }
 
        $flattenedCookies = [];
        foreach ($this->cookies as $path) {
            foreach ($path as $cookies) {
                foreach ($cookies as $cookie) {
                    $flattenedCookies[] = $cookie;
                }
            }
        }
 
        return $flattenedCookies;
    }
 
    public function clearCookie($name, $path = '/', $domain = null, $secure = false, $httpOnly = true/*, $sameSite = null*/)
    {
        $sameSite = \func_num_args() > 5 ? func_get_arg(5) : null;
 
        $this->setCookie(new Cookie($name, null, 1, $path, $domain, $secure, $httpOnly, false, $sameSite));
    }
 
    public function makeDisposition($disposition, $filename, $filenameFallback = '')
    {
        return HeaderUtils::makeDisposition((string) $disposition, (string) $filename, (string) $filenameFallback);
    }
 
    protected function computeCacheControlValue()
    {
        if (!$this->cacheControl) {
            if ($this->has('Last-Modified') || $this->has('Expires')) {
                return 'private, must-revalidate'; // allows for heuristic expiration (RFC 7234 Section 4.2.2) in the case of "Last-Modified"
            }
 
            // conservative by default
            return 'no-cache, private';
        }
 
        $header = $this->getCacheControlHeader();
        if (isset($this->cacheControl['public']) || isset($this->cacheControl['private'])) {
            return $header;
        }
 
        // public if s-maxage is defined, private otherwise
        if (!isset($this->cacheControl['s-maxage'])) {
            return $header.', private';
        }
 
        return $header;
    }
 
    private function initDate(): void
    {
        $now = \DateTime::createFromFormat('U', time());
        $now->setTimezone(new \DateTimeZone('UTC'));
        $this->set('Date', $now->format('D, d M Y H:i:s').' GMT');
    }
}