You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
341 lines
9.8 KiB
341 lines
9.8 KiB
12 months ago
|
<?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;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* ResponseHeaderBag is a container for Response HTTP headers.
|
||
|
|
*
|
||
|
|
* @author Fabien Potencier <fabien@symfony.com>
|
||
|
|
*/
|
||
|
|
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();
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the headers, with original capitalizations.
|
||
|
|
*
|
||
|
|
* @return array An array of headers
|
||
|
|
*/
|
||
|
|
public function allPreserveCase()
|
||
|
|
{
|
||
|
|
$headers = [];
|
||
|
|
foreach ($this->all() as $name => $value) {
|
||
|
|
$headers[isset($this->headerNames[$name]) ? $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;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* {@inheritdoc}
|
||
|
|
*/
|
||
|
|
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();
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* {@inheritdoc}
|
||
|
|
*/
|
||
|
|
public function all()
|
||
|
|
{
|
||
|
|
$headers = parent::all();
|
||
|
|
foreach ($this->getCookies() as $cookie) {
|
||
|
|
$headers['set-cookie'][] = (string) $cookie;
|
||
|
|
}
|
||
|
|
|
||
|
|
return $headers;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* {@inheritdoc}
|
||
|
|
*/
|
||
|
|
public function set($key, $values, $replace = true)
|
||
|
|
{
|
||
|
|
$uniqueKey = str_replace('_', '-', strtolower($key));
|
||
|
|
|
||
|
|
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);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* {@inheritdoc}
|
||
|
|
*/
|
||
|
|
public function remove($key)
|
||
|
|
{
|
||
|
|
$uniqueKey = str_replace('_', '-', strtolower($key));
|
||
|
|
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();
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* {@inheritdoc}
|
||
|
|
*/
|
||
|
|
public function hasCacheControlDirective($key)
|
||
|
|
{
|
||
|
|
return \array_key_exists($key, $this->computedCacheControl);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* {@inheritdoc}
|
||
|
|
*/
|
||
|
|
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';
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Removes a cookie from the array, but does not unset it in the browser.
|
||
|
|
*
|
||
|
|
* @param string $name
|
||
|
|
* @param string $path
|
||
|
|
* @param string $domain
|
||
|
|
*/
|
||
|
|
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']);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns an array with all cookies.
|
||
|
|
*
|
||
|
|
* @param string $format
|
||
|
|
*
|
||
|
|
* @return Cookie[]
|
||
|
|
*
|
||
|
|
* @throws \InvalidArgumentException When the $format is invalid
|
||
|
|
*/
|
||
|
|
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;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Clears a cookie in the browser.
|
||
|
|
*
|
||
|
|
* @param string $name
|
||
|
|
* @param string $path
|
||
|
|
* @param string $domain
|
||
|
|
* @param bool $secure
|
||
|
|
* @param bool $httpOnly
|
||
|
|
*/
|
||
|
|
public function clearCookie($name, $path = '/', $domain = null, $secure = false, $httpOnly = true)
|
||
|
|
{
|
||
|
|
$this->setCookie(new Cookie($name, null, 1, $path, $domain, $secure, $httpOnly));
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Generates a HTTP Content-Disposition field-value.
|
||
|
|
*
|
||
|
|
* @param string $disposition One of "inline" or "attachment"
|
||
|
|
* @param string $filename A unicode string
|
||
|
|
* @param string $filenameFallback A string containing only ASCII characters that
|
||
|
|
* is semantically equivalent to $filename. If the filename is already ASCII,
|
||
|
|
* it can be omitted, or just copied from $filename
|
||
|
|
*
|
||
|
|
* @return string A string suitable for use as a Content-Disposition field-value
|
||
|
|
*
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
*
|
||
|
|
* @see RFC 6266
|
||
|
|
*/
|
||
|
|
public function makeDisposition($disposition, $filename, $filenameFallback = '')
|
||
|
|
{
|
||
|
|
if (!\in_array($disposition, [self::DISPOSITION_ATTACHMENT, self::DISPOSITION_INLINE])) {
|
||
|
|
throw new \InvalidArgumentException(sprintf('The disposition must be either "%s" or "%s".', self::DISPOSITION_ATTACHMENT, self::DISPOSITION_INLINE));
|
||
|
|
}
|
||
|
|
|
||
|
|
if ('' == $filenameFallback) {
|
||
|
|
$filenameFallback = $filename;
|
||
|
|
}
|
||
|
|
|
||
|
|
// filenameFallback is not ASCII.
|
||
|
|
if (!preg_match('/^[\x20-\x7e]*$/', $filenameFallback)) {
|
||
|
|
throw new \InvalidArgumentException('The filename fallback must only contain ASCII characters.');
|
||
|
|
}
|
||
|
|
|
||
|
|
// percent characters aren't safe in fallback.
|
||
|
|
if (false !== strpos($filenameFallback, '%')) {
|
||
|
|
throw new \InvalidArgumentException('The filename fallback cannot contain the "%" character.');
|
||
|
|
}
|
||
|
|
|
||
|
|
// path separators aren't allowed in either.
|
||
|
|
if (false !== strpos($filename, '/') || false !== strpos($filename, '\\') || false !== strpos($filenameFallback, '/') || false !== strpos($filenameFallback, '\\')) {
|
||
|
|
throw new \InvalidArgumentException('The filename and the fallback cannot contain the "/" and "\\" characters.');
|
||
|
|
}
|
||
|
|
|
||
|
|
$output = sprintf('%s; filename="%s"', $disposition, str_replace('"', '\\"', $filenameFallback));
|
||
|
|
|
||
|
|
if ($filename !== $filenameFallback) {
|
||
|
|
$output .= sprintf("; filename*=utf-8''%s", rawurlencode($filename));
|
||
|
|
}
|
||
|
|
|
||
|
|
return $output;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the calculated value of the cache-control header.
|
||
|
|
*
|
||
|
|
* This considers several other headers and calculates or modifies the
|
||
|
|
* cache-control header to a sensible, conservative value.
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
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()
|
||
|
|
{
|
||
|
|
$now = \DateTime::createFromFormat('U', time());
|
||
|
|
$now->setTimezone(new \DateTimeZone('UTC'));
|
||
|
|
$this->set('Date', $now->format('D, d M Y H:i:s').' GMT');
|
||
|
|
}
|
||
|
|
}
|