ResponseHeaderBag.php 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\HttpFoundation;
  11. /**
  12. * ResponseHeaderBag is a container for Response HTTP headers.
  13. *
  14. * @author Fabien Potencier <fabien@symfony.com>
  15. */
  16. class ResponseHeaderBag extends HeaderBag
  17. {
  18. public const COOKIES_FLAT = 'flat';
  19. public const COOKIES_ARRAY = 'array';
  20. public const DISPOSITION_ATTACHMENT = 'attachment';
  21. public const DISPOSITION_INLINE = 'inline';
  22. protected array $computedCacheControl = [];
  23. protected array $cookies = [];
  24. protected array $headerNames = [];
  25. public function __construct(array $headers = [])
  26. {
  27. parent::__construct($headers);
  28. if (!isset($this->headers['cache-control'])) {
  29. $this->set('Cache-Control', '');
  30. }
  31. /* RFC2616 - 14.18 says all Responses need to have a Date */
  32. if (!isset($this->headers['date'])) {
  33. $this->initDate();
  34. }
  35. }
  36. /**
  37. * Returns the headers, with original capitalizations.
  38. */
  39. public function allPreserveCase(): array
  40. {
  41. $headers = [];
  42. foreach ($this->all() as $name => $value) {
  43. $headers[$this->headerNames[$name] ?? $name] = $value;
  44. }
  45. return $headers;
  46. }
  47. public function allPreserveCaseWithoutCookies(): array
  48. {
  49. $headers = $this->allPreserveCase();
  50. if (isset($this->headerNames['set-cookie'])) {
  51. unset($headers[$this->headerNames['set-cookie']]);
  52. }
  53. return $headers;
  54. }
  55. public function replace(array $headers = []): void
  56. {
  57. $this->headerNames = [];
  58. parent::replace($headers);
  59. if (!isset($this->headers['cache-control'])) {
  60. $this->set('Cache-Control', '');
  61. }
  62. if (!isset($this->headers['date'])) {
  63. $this->initDate();
  64. }
  65. }
  66. public function all(?string $key = null): array
  67. {
  68. $headers = parent::all();
  69. if (null !== $key) {
  70. $key = strtr($key, self::UPPER, self::LOWER);
  71. return 'set-cookie' !== $key ? $headers[$key] ?? [] : array_map('strval', $this->getCookies());
  72. }
  73. foreach ($this->getCookies() as $cookie) {
  74. $headers['set-cookie'][] = (string) $cookie;
  75. }
  76. return $headers;
  77. }
  78. public function set(string $key, string|array|null $values, bool $replace = true): void
  79. {
  80. $uniqueKey = strtr($key, self::UPPER, self::LOWER);
  81. if ('set-cookie' === $uniqueKey) {
  82. if ($replace) {
  83. $this->cookies = [];
  84. }
  85. foreach ((array) $values as $cookie) {
  86. $this->setCookie(Cookie::fromString($cookie));
  87. }
  88. $this->headerNames[$uniqueKey] = $key;
  89. return;
  90. }
  91. $this->headerNames[$uniqueKey] = $key;
  92. parent::set($key, $values, $replace);
  93. // ensure the cache-control header has sensible defaults
  94. if (\in_array($uniqueKey, ['cache-control', 'etag', 'last-modified', 'expires'], true) && '' !== $computed = $this->computeCacheControlValue()) {
  95. $this->headers['cache-control'] = [$computed];
  96. $this->headerNames['cache-control'] = 'Cache-Control';
  97. $this->computedCacheControl = $this->parseCacheControl($computed);
  98. }
  99. }
  100. public function remove(string $key): void
  101. {
  102. $uniqueKey = strtr($key, self::UPPER, self::LOWER);
  103. unset($this->headerNames[$uniqueKey]);
  104. if ('set-cookie' === $uniqueKey) {
  105. $this->cookies = [];
  106. return;
  107. }
  108. parent::remove($key);
  109. if ('cache-control' === $uniqueKey) {
  110. $this->computedCacheControl = [];
  111. }
  112. if ('date' === $uniqueKey) {
  113. $this->initDate();
  114. }
  115. }
  116. public function hasCacheControlDirective(string $key): bool
  117. {
  118. return \array_key_exists($key, $this->computedCacheControl);
  119. }
  120. public function getCacheControlDirective(string $key): bool|string|null
  121. {
  122. return $this->computedCacheControl[$key] ?? null;
  123. }
  124. public function setCookie(Cookie $cookie): void
  125. {
  126. $this->cookies[$cookie->getDomain()][$cookie->getPath()][$cookie->getName()] = $cookie;
  127. $this->headerNames['set-cookie'] = 'Set-Cookie';
  128. }
  129. /**
  130. * Removes a cookie from the array, but does not unset it in the browser.
  131. */
  132. public function removeCookie(string $name, ?string $path = '/', ?string $domain = null): void
  133. {
  134. $path ??= '/';
  135. unset($this->cookies[$domain][$path][$name]);
  136. if (empty($this->cookies[$domain][$path])) {
  137. unset($this->cookies[$domain][$path]);
  138. if (empty($this->cookies[$domain])) {
  139. unset($this->cookies[$domain]);
  140. }
  141. }
  142. if (!$this->cookies) {
  143. unset($this->headerNames['set-cookie']);
  144. }
  145. }
  146. /**
  147. * Returns an array with all cookies.
  148. *
  149. * @return Cookie[]
  150. *
  151. * @throws \InvalidArgumentException When the $format is invalid
  152. */
  153. public function getCookies(string $format = self::COOKIES_FLAT): array
  154. {
  155. if (!\in_array($format, [self::COOKIES_FLAT, self::COOKIES_ARRAY])) {
  156. throw new \InvalidArgumentException(sprintf('Format "%s" invalid (%s).', $format, implode(', ', [self::COOKIES_FLAT, self::COOKIES_ARRAY])));
  157. }
  158. if (self::COOKIES_ARRAY === $format) {
  159. return $this->cookies;
  160. }
  161. $flattenedCookies = [];
  162. foreach ($this->cookies as $path) {
  163. foreach ($path as $cookies) {
  164. foreach ($cookies as $cookie) {
  165. $flattenedCookies[] = $cookie;
  166. }
  167. }
  168. }
  169. return $flattenedCookies;
  170. }
  171. /**
  172. * Clears a cookie in the browser.
  173. *
  174. * @param bool $partitioned
  175. */
  176. public function clearCookie(string $name, ?string $path = '/', ?string $domain = null, bool $secure = false, bool $httpOnly = true, ?string $sameSite = null /* , bool $partitioned = false */): void
  177. {
  178. $partitioned = 6 < \func_num_args() ? \func_get_arg(6) : false;
  179. $this->setCookie(new Cookie($name, null, 1, $path, $domain, $secure, $httpOnly, false, $sameSite, $partitioned));
  180. }
  181. /**
  182. * @see HeaderUtils::makeDisposition()
  183. */
  184. public function makeDisposition(string $disposition, string $filename, string $filenameFallback = ''): string
  185. {
  186. return HeaderUtils::makeDisposition($disposition, $filename, $filenameFallback);
  187. }
  188. /**
  189. * Returns the calculated value of the cache-control header.
  190. *
  191. * This considers several other headers and calculates or modifies the
  192. * cache-control header to a sensible, conservative value.
  193. */
  194. protected function computeCacheControlValue(): string
  195. {
  196. if (!$this->cacheControl) {
  197. if ($this->has('Last-Modified') || $this->has('Expires')) {
  198. return 'private, must-revalidate'; // allows for heuristic expiration (RFC 7234 Section 4.2.2) in the case of "Last-Modified"
  199. }
  200. // conservative by default
  201. return 'no-cache, private';
  202. }
  203. $header = $this->getCacheControlHeader();
  204. if (isset($this->cacheControl['public']) || isset($this->cacheControl['private'])) {
  205. return $header;
  206. }
  207. // public if s-maxage is defined, private otherwise
  208. if (!isset($this->cacheControl['s-maxage'])) {
  209. return $header.', private';
  210. }
  211. return $header;
  212. }
  213. private function initDate(): void
  214. {
  215. $this->set('Date', gmdate('D, d M Y H:i:s').' GMT');
  216. }
  217. }