Chris@0: <?php
Chris@0: 
Chris@0: /*
Chris@0:  * This file is part of the Symfony package.
Chris@0:  *
Chris@0:  * (c) Fabien Potencier <fabien@symfony.com>
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: namespace Symfony\Component\HttpFoundation;
Chris@0: 
Chris@0: /**
Chris@0:  * ResponseHeaderBag is a container for Response HTTP headers.
Chris@0:  *
Chris@0:  * @author Fabien Potencier <fabien@symfony.com>
Chris@0:  */
Chris@0: class ResponseHeaderBag extends HeaderBag
Chris@0: {
Chris@0:     const COOKIES_FLAT = 'flat';
Chris@0:     const COOKIES_ARRAY = 'array';
Chris@0: 
Chris@0:     const DISPOSITION_ATTACHMENT = 'attachment';
Chris@0:     const DISPOSITION_INLINE = 'inline';
Chris@0: 
Chris@17:     protected $computedCacheControl = [];
Chris@17:     protected $cookies = [];
Chris@17:     protected $headerNames = [];
Chris@0: 
Chris@17:     public function __construct(array $headers = [])
Chris@0:     {
Chris@0:         parent::__construct($headers);
Chris@0: 
Chris@0:         if (!isset($this->headers['cache-control'])) {
Chris@0:             $this->set('Cache-Control', '');
Chris@0:         }
Chris@0: 
Chris@14:         /* RFC2616 - 14.18 says all Responses need to have a Date */
Chris@14:         if (!isset($this->headers['date'])) {
Chris@14:             $this->initDate();
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns the headers, with original capitalizations.
Chris@0:      *
Chris@0:      * @return array An array of headers
Chris@0:      */
Chris@0:     public function allPreserveCase()
Chris@0:     {
Chris@17:         $headers = [];
Chris@14:         foreach ($this->all() as $name => $value) {
Chris@14:             $headers[isset($this->headerNames[$name]) ? $this->headerNames[$name] : $name] = $value;
Chris@14:         }
Chris@14: 
Chris@14:         return $headers;
Chris@14:     }
Chris@14: 
Chris@14:     public function allPreserveCaseWithoutCookies()
Chris@14:     {
Chris@14:         $headers = $this->allPreserveCase();
Chris@14:         if (isset($this->headerNames['set-cookie'])) {
Chris@14:             unset($headers[$this->headerNames['set-cookie']]);
Chris@14:         }
Chris@14: 
Chris@14:         return $headers;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@17:     public function replace(array $headers = [])
Chris@0:     {
Chris@17:         $this->headerNames = [];
Chris@0: 
Chris@0:         parent::replace($headers);
Chris@0: 
Chris@0:         if (!isset($this->headers['cache-control'])) {
Chris@0:             $this->set('Cache-Control', '');
Chris@0:         }
Chris@14: 
Chris@14:         if (!isset($this->headers['date'])) {
Chris@14:             $this->initDate();
Chris@14:         }
Chris@14:     }
Chris@14: 
Chris@14:     /**
Chris@14:      * {@inheritdoc}
Chris@14:      */
Chris@14:     public function all()
Chris@14:     {
Chris@14:         $headers = parent::all();
Chris@14:         foreach ($this->getCookies() as $cookie) {
Chris@14:             $headers['set-cookie'][] = (string) $cookie;
Chris@14:         }
Chris@14: 
Chris@14:         return $headers;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function set($key, $values, $replace = true)
Chris@0:     {
Chris@14:         $uniqueKey = str_replace('_', '-', strtolower($key));
Chris@14: 
Chris@14:         if ('set-cookie' === $uniqueKey) {
Chris@14:             if ($replace) {
Chris@17:                 $this->cookies = [];
Chris@14:             }
Chris@14:             foreach ((array) $values as $cookie) {
Chris@14:                 $this->setCookie(Cookie::fromString($cookie));
Chris@14:             }
Chris@14:             $this->headerNames[$uniqueKey] = $key;
Chris@14: 
Chris@14:             return;
Chris@14:         }
Chris@14: 
Chris@14:         $this->headerNames[$uniqueKey] = $key;
Chris@14: 
Chris@0:         parent::set($key, $values, $replace);
Chris@0: 
Chris@0:         // ensure the cache-control header has sensible defaults
Chris@17:         if (\in_array($uniqueKey, ['cache-control', 'etag', 'last-modified', 'expires'], true)) {
Chris@0:             $computed = $this->computeCacheControlValue();
Chris@17:             $this->headers['cache-control'] = [$computed];
Chris@0:             $this->headerNames['cache-control'] = 'Cache-Control';
Chris@0:             $this->computedCacheControl = $this->parseCacheControl($computed);
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function remove($key)
Chris@0:     {
Chris@0:         $uniqueKey = str_replace('_', '-', strtolower($key));
Chris@0:         unset($this->headerNames[$uniqueKey]);
Chris@0: 
Chris@14:         if ('set-cookie' === $uniqueKey) {
Chris@17:             $this->cookies = [];
Chris@14: 
Chris@14:             return;
Chris@14:         }
Chris@14: 
Chris@14:         parent::remove($key);
Chris@14: 
Chris@0:         if ('cache-control' === $uniqueKey) {
Chris@17:             $this->computedCacheControl = [];
Chris@0:         }
Chris@14: 
Chris@14:         if ('date' === $uniqueKey) {
Chris@14:             $this->initDate();
Chris@14:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function hasCacheControlDirective($key)
Chris@0:     {
Chris@18:         return \array_key_exists($key, $this->computedCacheControl);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function getCacheControlDirective($key)
Chris@0:     {
Chris@18:         return \array_key_exists($key, $this->computedCacheControl) ? $this->computedCacheControl[$key] : null;
Chris@0:     }
Chris@0: 
Chris@0:     public function setCookie(Cookie $cookie)
Chris@0:     {
Chris@0:         $this->cookies[$cookie->getDomain()][$cookie->getPath()][$cookie->getName()] = $cookie;
Chris@14:         $this->headerNames['set-cookie'] = 'Set-Cookie';
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Removes a cookie from the array, but does not unset it in the browser.
Chris@0:      *
Chris@0:      * @param string $name
Chris@0:      * @param string $path
Chris@0:      * @param string $domain
Chris@0:      */
Chris@0:     public function removeCookie($name, $path = '/', $domain = null)
Chris@0:     {
Chris@0:         if (null === $path) {
Chris@0:             $path = '/';
Chris@0:         }
Chris@0: 
Chris@0:         unset($this->cookies[$domain][$path][$name]);
Chris@0: 
Chris@0:         if (empty($this->cookies[$domain][$path])) {
Chris@0:             unset($this->cookies[$domain][$path]);
Chris@0: 
Chris@0:             if (empty($this->cookies[$domain])) {
Chris@0:                 unset($this->cookies[$domain]);
Chris@0:             }
Chris@0:         }
Chris@14: 
Chris@14:         if (empty($this->cookies)) {
Chris@14:             unset($this->headerNames['set-cookie']);
Chris@14:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns an array with all cookies.
Chris@0:      *
Chris@0:      * @param string $format
Chris@0:      *
Chris@16:      * @return Cookie[]
Chris@0:      *
Chris@0:      * @throws \InvalidArgumentException When the $format is invalid
Chris@0:      */
Chris@0:     public function getCookies($format = self::COOKIES_FLAT)
Chris@0:     {
Chris@17:         if (!\in_array($format, [self::COOKIES_FLAT, self::COOKIES_ARRAY])) {
Chris@17:             throw new \InvalidArgumentException(sprintf('Format "%s" invalid (%s).', $format, implode(', ', [self::COOKIES_FLAT, self::COOKIES_ARRAY])));
Chris@0:         }
Chris@0: 
Chris@0:         if (self::COOKIES_ARRAY === $format) {
Chris@0:             return $this->cookies;
Chris@0:         }
Chris@0: 
Chris@17:         $flattenedCookies = [];
Chris@0:         foreach ($this->cookies as $path) {
Chris@0:             foreach ($path as $cookies) {
Chris@0:                 foreach ($cookies as $cookie) {
Chris@0:                     $flattenedCookies[] = $cookie;
Chris@0:                 }
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         return $flattenedCookies;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Clears a cookie in the browser.
Chris@0:      *
Chris@0:      * @param string $name
Chris@0:      * @param string $path
Chris@0:      * @param string $domain
Chris@0:      * @param bool   $secure
Chris@0:      * @param bool   $httpOnly
Chris@0:      */
Chris@0:     public function clearCookie($name, $path = '/', $domain = null, $secure = false, $httpOnly = true)
Chris@0:     {
Chris@0:         $this->setCookie(new Cookie($name, null, 1, $path, $domain, $secure, $httpOnly));
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Generates a HTTP Content-Disposition field-value.
Chris@0:      *
Chris@0:      * @param string $disposition      One of "inline" or "attachment"
Chris@0:      * @param string $filename         A unicode string
Chris@0:      * @param string $filenameFallback A string containing only ASCII characters that
Chris@0:      *                                 is semantically equivalent to $filename. If the filename is already ASCII,
Chris@0:      *                                 it can be omitted, or just copied from $filename
Chris@0:      *
Chris@0:      * @return string A string suitable for use as a Content-Disposition field-value
Chris@0:      *
Chris@0:      * @throws \InvalidArgumentException
Chris@0:      *
Chris@0:      * @see RFC 6266
Chris@0:      */
Chris@0:     public function makeDisposition($disposition, $filename, $filenameFallback = '')
Chris@0:     {
Chris@17:         if (!\in_array($disposition, [self::DISPOSITION_ATTACHMENT, self::DISPOSITION_INLINE])) {
Chris@0:             throw new \InvalidArgumentException(sprintf('The disposition must be either "%s" or "%s".', self::DISPOSITION_ATTACHMENT, self::DISPOSITION_INLINE));
Chris@0:         }
Chris@0: 
Chris@0:         if ('' == $filenameFallback) {
Chris@0:             $filenameFallback = $filename;
Chris@0:         }
Chris@0: 
Chris@0:         // filenameFallback is not ASCII.
Chris@0:         if (!preg_match('/^[\x20-\x7e]*$/', $filenameFallback)) {
Chris@0:             throw new \InvalidArgumentException('The filename fallback must only contain ASCII characters.');
Chris@0:         }
Chris@0: 
Chris@0:         // percent characters aren't safe in fallback.
Chris@0:         if (false !== strpos($filenameFallback, '%')) {
Chris@0:             throw new \InvalidArgumentException('The filename fallback cannot contain the "%" character.');
Chris@0:         }
Chris@0: 
Chris@0:         // path separators aren't allowed in either.
Chris@0:         if (false !== strpos($filename, '/') || false !== strpos($filename, '\\') || false !== strpos($filenameFallback, '/') || false !== strpos($filenameFallback, '\\')) {
Chris@0:             throw new \InvalidArgumentException('The filename and the fallback cannot contain the "/" and "\\" characters.');
Chris@0:         }
Chris@0: 
Chris@0:         $output = sprintf('%s; filename="%s"', $disposition, str_replace('"', '\\"', $filenameFallback));
Chris@0: 
Chris@0:         if ($filename !== $filenameFallback) {
Chris@0:             $output .= sprintf("; filename*=utf-8''%s", rawurlencode($filename));
Chris@0:         }
Chris@0: 
Chris@0:         return $output;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns the calculated value of the cache-control header.
Chris@0:      *
Chris@0:      * This considers several other headers and calculates or modifies the
Chris@0:      * cache-control header to a sensible, conservative value.
Chris@0:      *
Chris@0:      * @return string
Chris@0:      */
Chris@0:     protected function computeCacheControlValue()
Chris@0:     {
Chris@0:         if (!$this->cacheControl && !$this->has('ETag') && !$this->has('Last-Modified') && !$this->has('Expires')) {
Chris@0:             return 'no-cache, private';
Chris@0:         }
Chris@0: 
Chris@0:         if (!$this->cacheControl) {
Chris@0:             // conservative by default
Chris@0:             return 'private, must-revalidate';
Chris@0:         }
Chris@0: 
Chris@0:         $header = $this->getCacheControlHeader();
Chris@0:         if (isset($this->cacheControl['public']) || isset($this->cacheControl['private'])) {
Chris@0:             return $header;
Chris@0:         }
Chris@0: 
Chris@0:         // public if s-maxage is defined, private otherwise
Chris@0:         if (!isset($this->cacheControl['s-maxage'])) {
Chris@0:             return $header.', private';
Chris@0:         }
Chris@0: 
Chris@0:         return $header;
Chris@0:     }
Chris@14: 
Chris@14:     private function initDate()
Chris@14:     {
Chris@14:         $now = \DateTime::createFromFormat('U', time());
Chris@14:         $now->setTimezone(new \DateTimeZone('UTC'));
Chris@14:         $this->set('Date', $now->format('D, d M Y H:i:s').' GMT');
Chris@14:     }
Chris@0: }