4 * This file is part of the Symfony package.
6 * (c) Fabien Potencier <fabien@symfony.com>
8 * For the full copyright and license information, please view the LICENSE
9 * file that was distributed with this source code.
12 namespace Symfony\Component\HttpFoundation;
15 * ResponseHeaderBag is a container for Response HTTP headers.
17 * @author Fabien Potencier <fabien@symfony.com>
19 class ResponseHeaderBag extends HeaderBag
21 const COOKIES_FLAT = 'flat';
22 const COOKIES_ARRAY = 'array';
24 const DISPOSITION_ATTACHMENT = 'attachment';
25 const DISPOSITION_INLINE = 'inline';
27 protected $computedCacheControl = array();
28 protected $cookies = array();
29 protected $headerNames = array();
31 public function __construct(array $headers = array())
33 parent::__construct($headers);
35 if (!isset($this->headers['cache-control'])) {
36 $this->set('Cache-Control', '');
39 /* RFC2616 - 14.18 says all Responses need to have a Date */
40 if (!isset($this->headers['date'])) {
46 * Returns the headers, with original capitalizations.
48 * @return array An array of headers
50 public function allPreserveCase()
53 foreach ($this->all() as $name => $value) {
54 $headers[isset($this->headerNames[$name]) ? $this->headerNames[$name] : $name] = $value;
60 public function allPreserveCaseWithoutCookies()
62 $headers = $this->allPreserveCase();
63 if (isset($this->headerNames['set-cookie'])) {
64 unset($headers[$this->headerNames['set-cookie']]);
73 public function replace(array $headers = array())
75 $this->headerNames = array();
77 parent::replace($headers);
79 if (!isset($this->headers['cache-control'])) {
80 $this->set('Cache-Control', '');
83 if (!isset($this->headers['date'])) {
93 $headers = parent::all();
94 foreach ($this->getCookies() as $cookie) {
95 $headers['set-cookie'][] = (string) $cookie;
104 public function set($key, $values, $replace = true)
106 $uniqueKey = str_replace('_', '-', strtolower($key));
108 if ('set-cookie' === $uniqueKey) {
110 $this->cookies = array();
112 foreach ((array) $values as $cookie) {
113 $this->setCookie(Cookie::fromString($cookie));
115 $this->headerNames[$uniqueKey] = $key;
120 $this->headerNames[$uniqueKey] = $key;
122 parent::set($key, $values, $replace);
124 // ensure the cache-control header has sensible defaults
125 if (\in_array($uniqueKey, array('cache-control', 'etag', 'last-modified', 'expires'), true)) {
126 $computed = $this->computeCacheControlValue();
127 $this->headers['cache-control'] = array($computed);
128 $this->headerNames['cache-control'] = 'Cache-Control';
129 $this->computedCacheControl = $this->parseCacheControl($computed);
136 public function remove($key)
138 $uniqueKey = str_replace('_', '-', strtolower($key));
139 unset($this->headerNames[$uniqueKey]);
141 if ('set-cookie' === $uniqueKey) {
142 $this->cookies = array();
147 parent::remove($key);
149 if ('cache-control' === $uniqueKey) {
150 $this->computedCacheControl = array();
153 if ('date' === $uniqueKey) {
161 public function hasCacheControlDirective($key)
163 return array_key_exists($key, $this->computedCacheControl);
169 public function getCacheControlDirective($key)
171 return array_key_exists($key, $this->computedCacheControl) ? $this->computedCacheControl[$key] : null;
174 public function setCookie(Cookie $cookie)
176 $this->cookies[$cookie->getDomain()][$cookie->getPath()][$cookie->getName()] = $cookie;
177 $this->headerNames['set-cookie'] = 'Set-Cookie';
181 * Removes a cookie from the array, but does not unset it in the browser.
183 * @param string $name
184 * @param string $path
185 * @param string $domain
187 public function removeCookie($name, $path = '/', $domain = null)
189 if (null === $path) {
193 unset($this->cookies[$domain][$path][$name]);
195 if (empty($this->cookies[$domain][$path])) {
196 unset($this->cookies[$domain][$path]);
198 if (empty($this->cookies[$domain])) {
199 unset($this->cookies[$domain]);
203 if (empty($this->cookies)) {
204 unset($this->headerNames['set-cookie']);
209 * Returns an array with all cookies.
211 * @param string $format
215 * @throws \InvalidArgumentException When the $format is invalid
217 public function getCookies($format = self::COOKIES_FLAT)
219 if (!\in_array($format, array(self::COOKIES_FLAT, self::COOKIES_ARRAY))) {
220 throw new \InvalidArgumentException(sprintf('Format "%s" invalid (%s).', $format, implode(', ', array(self::COOKIES_FLAT, self::COOKIES_ARRAY))));
223 if (self::COOKIES_ARRAY === $format) {
224 return $this->cookies;
227 $flattenedCookies = array();
228 foreach ($this->cookies as $path) {
229 foreach ($path as $cookies) {
230 foreach ($cookies as $cookie) {
231 $flattenedCookies[] = $cookie;
236 return $flattenedCookies;
240 * Clears a cookie in the browser.
242 * @param string $name
243 * @param string $path
244 * @param string $domain
245 * @param bool $secure
246 * @param bool $httpOnly
248 public function clearCookie($name, $path = '/', $domain = null, $secure = false, $httpOnly = true)
250 $this->setCookie(new Cookie($name, null, 1, $path, $domain, $secure, $httpOnly));
254 * Generates a HTTP Content-Disposition field-value.
256 * @param string $disposition One of "inline" or "attachment"
257 * @param string $filename A unicode string
258 * @param string $filenameFallback A string containing only ASCII characters that
259 * is semantically equivalent to $filename. If the filename is already ASCII,
260 * it can be omitted, or just copied from $filename
262 * @return string A string suitable for use as a Content-Disposition field-value
264 * @throws \InvalidArgumentException
268 public function makeDisposition($disposition, $filename, $filenameFallback = '')
270 if (!\in_array($disposition, array(self::DISPOSITION_ATTACHMENT, self::DISPOSITION_INLINE))) {
271 throw new \InvalidArgumentException(sprintf('The disposition must be either "%s" or "%s".', self::DISPOSITION_ATTACHMENT, self::DISPOSITION_INLINE));
274 if ('' == $filenameFallback) {
275 $filenameFallback = $filename;
278 // filenameFallback is not ASCII.
279 if (!preg_match('/^[\x20-\x7e]*$/', $filenameFallback)) {
280 throw new \InvalidArgumentException('The filename fallback must only contain ASCII characters.');
283 // percent characters aren't safe in fallback.
284 if (false !== strpos($filenameFallback, '%')) {
285 throw new \InvalidArgumentException('The filename fallback cannot contain the "%" character.');
288 // path separators aren't allowed in either.
289 if (false !== strpos($filename, '/') || false !== strpos($filename, '\\') || false !== strpos($filenameFallback, '/') || false !== strpos($filenameFallback, '\\')) {
290 throw new \InvalidArgumentException('The filename and the fallback cannot contain the "/" and "\\" characters.');
293 $output = sprintf('%s; filename="%s"', $disposition, str_replace('"', '\\"', $filenameFallback));
295 if ($filename !== $filenameFallback) {
296 $output .= sprintf("; filename*=utf-8''%s", rawurlencode($filename));
303 * Returns the calculated value of the cache-control header.
305 * This considers several other headers and calculates or modifies the
306 * cache-control header to a sensible, conservative value.
310 protected function computeCacheControlValue()
312 if (!$this->cacheControl && !$this->has('ETag') && !$this->has('Last-Modified') && !$this->has('Expires')) {
313 return 'no-cache, private';
316 if (!$this->cacheControl) {
317 // conservative by default
318 return 'private, must-revalidate';
321 $header = $this->getCacheControlHeader();
322 if (isset($this->cacheControl['public']) || isset($this->cacheControl['private'])) {
326 // public if s-maxage is defined, private otherwise
327 if (!isset($this->cacheControl['s-maxage'])) {
328 return $header.', private';
334 private function initDate()
336 $now = \DateTime::createFromFormat('U', time());
337 $now->setTimezone(new \DateTimeZone('UTC'));
338 $this->set('Date', $now->format('D, d M Y H:i:s').' GMT');