2010-05-03 10:40:23 +01:00
|
|
|
<?php
|
|
|
|
|
2010-07-09 08:26:22 +01:00
|
|
|
namespace Symfony\Components\HttpFoundation;
|
2010-05-03 10:40:23 +01:00
|
|
|
|
|
|
|
/*
|
|
|
|
* This file is part of the Symfony package.
|
|
|
|
*
|
|
|
|
* (c) Fabien Potencier <fabien.potencier@symfony-project.com>
|
|
|
|
*
|
|
|
|
* For the full copyright and license information, please view the LICENSE
|
|
|
|
* file that was distributed with this source code.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
2010-06-23 15:24:24 +01:00
|
|
|
* HeaderBag is a container for HTTP headers.
|
2010-05-03 10:40:23 +01:00
|
|
|
*
|
|
|
|
* @package Symfony
|
2010-07-09 08:26:22 +01:00
|
|
|
* @subpackage Components_HttpFoundation
|
2010-05-03 10:40:23 +01:00
|
|
|
* @author Fabien Potencier <fabien.potencier@symfony-project.com>
|
|
|
|
*/
|
2010-06-23 15:24:24 +01:00
|
|
|
class HeaderBag
|
2010-05-03 10:40:23 +01:00
|
|
|
{
|
2010-06-23 15:24:24 +01:00
|
|
|
protected $headers;
|
2010-05-06 12:25:53 +01:00
|
|
|
protected $cacheControl;
|
|
|
|
protected $type;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Constructor.
|
|
|
|
*
|
2010-06-23 15:24:24 +01:00
|
|
|
* @param array $headers An array of HTTP headers
|
2010-05-06 12:25:53 +01:00
|
|
|
* @param string $type The type (null, request, or response)
|
|
|
|
*/
|
2010-06-23 15:24:24 +01:00
|
|
|
public function __construct(array $headers = array(), $type = null)
|
2010-05-03 10:40:23 +01:00
|
|
|
{
|
2010-06-23 15:24:24 +01:00
|
|
|
$this->replace($headers);
|
2010-05-06 12:25:53 +01:00
|
|
|
|
2010-05-07 15:09:11 +01:00
|
|
|
if (null !== $type && !in_array($type, array('request', 'response'))) {
|
2010-05-06 12:25:53 +01:00
|
|
|
throw new \InvalidArgumentException(sprintf('The "%s" type is not supported by the HeaderBag constructor.', $type));
|
|
|
|
}
|
|
|
|
$this->type = $type;
|
|
|
|
}
|
|
|
|
|
2010-06-23 15:24:24 +01:00
|
|
|
/**
|
|
|
|
* Returns the headers.
|
|
|
|
*
|
|
|
|
* @return array An array of headers
|
|
|
|
*/
|
|
|
|
public function all()
|
|
|
|
{
|
|
|
|
return $this->headers;
|
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Replaces the current HTTP headers by a new set.
|
|
|
|
*
|
2010-06-23 15:24:24 +01:00
|
|
|
* @param array $headers An array of HTTP headers
|
2010-05-06 12:25:53 +01:00
|
|
|
*/
|
2010-06-23 15:24:24 +01:00
|
|
|
public function replace(array $headers = array())
|
2010-05-06 12:25:53 +01:00
|
|
|
{
|
|
|
|
$this->cacheControl = null;
|
2010-06-23 15:24:24 +01:00
|
|
|
$this->headers = array();
|
|
|
|
foreach ($headers as $key => $values) {
|
|
|
|
$this->set($key, $values);
|
2010-05-06 12:25:53 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns a header value by name.
|
|
|
|
*
|
2010-06-23 15:24:24 +01:00
|
|
|
* @param string $key The header name
|
|
|
|
* @param Boolean $first Whether to return the first value or all header values
|
|
|
|
*
|
|
|
|
* @return string|array The first header value if $first is true, an array of values otherwise
|
2010-05-06 12:25:53 +01:00
|
|
|
*/
|
2010-06-23 15:24:24 +01:00
|
|
|
public function get($key, $first = true)
|
2010-05-06 12:25:53 +01:00
|
|
|
{
|
|
|
|
$key = strtr(strtolower($key), '_', '-');
|
|
|
|
|
2010-06-23 15:24:24 +01:00
|
|
|
if (!array_key_exists($key, $this->headers)) {
|
|
|
|
return $first ? null : array();
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($first) {
|
|
|
|
return count($this->headers[$key]) ? $this->headers[$key][0] : '';
|
|
|
|
} else {
|
|
|
|
return $this->headers[$key];
|
|
|
|
}
|
2010-05-06 12:25:53 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets a header by name.
|
|
|
|
*
|
2010-06-23 15:24:24 +01:00
|
|
|
* @param string $key The key
|
|
|
|
* @param string|array $values The value or an array of values
|
|
|
|
* @param Boolean $replace Whether to replace the actual value of not (true by default)
|
2010-05-06 12:25:53 +01:00
|
|
|
*/
|
2010-06-23 15:24:24 +01:00
|
|
|
public function set($key, $values, $replace = true)
|
2010-05-06 12:25:53 +01:00
|
|
|
{
|
|
|
|
$key = strtr(strtolower($key), '_', '-');
|
|
|
|
|
2010-06-23 15:24:24 +01:00
|
|
|
if (!is_array($values)) {
|
|
|
|
$values = array($values);
|
2010-05-06 12:25:53 +01:00
|
|
|
}
|
|
|
|
|
2010-06-23 15:24:24 +01:00
|
|
|
if (true === $replace || !isset($this->headers[$key])) {
|
|
|
|
$this->headers[$key] = $values;
|
|
|
|
} else {
|
|
|
|
$this->headers[$key] = array_merge($this->headers[$key], $values);
|
|
|
|
}
|
2010-05-03 10:40:23 +01:00
|
|
|
}
|
2010-05-06 12:25:53 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns true if the HTTP header is defined.
|
|
|
|
*
|
|
|
|
* @param string $key The HTTP header
|
|
|
|
*
|
|
|
|
* @return Boolean true if the parameter exists, false otherwise
|
|
|
|
*/
|
|
|
|
public function has($key)
|
2010-05-03 17:10:24 +01:00
|
|
|
{
|
2010-06-23 15:24:24 +01:00
|
|
|
return array_key_exists(strtr(strtolower($key), '_', '-'), $this->headers);
|
2010-05-03 17:10:24 +01:00
|
|
|
}
|
2010-05-06 12:25:53 +01:00
|
|
|
|
[HttpKernel] removed Response assertions
They are too magic and they don't really add value:
$this->assertResponseStatusCodeEmpty($client);
$this->assertTrue($client->getResponse()->isEmpty());
$this->assertResponseStatusCodeNotFound($client);
$this->assertTrue($client->getResponse()->isNotFound());
$this->assertResponseStatusCodeForbidden($client);
$this->assertTrue($client->getResponse()->isForbidden());
$this->assertResponseStatusCodeOk($client);
$this->assertTrue($client->getResponse()->isOk());
$this->assertResponseStatusCodeServerError($client);
$this->assertTrue($client->getResponse()->isServerError());
$this->assertResponseStatusCodeClientError($client);
$this->assertTrue($client->getResponse()->isClientError());
$this->assertResponseStatusCodeRedirection($client);
$this->assertTrue($client->getResponse()->isRedirection());
$this->assertResponseStatusCodeSuccessful($client);
$this->assertTrue($client->getResponse()->isSuccessful());
$this->assertResponseStatusCodeInformational($client);
$this->assertTrue($client->getResponse()->isInformational());
$this->assertResponseStatusCode(200, $client);
$this->assertEquals(200, $client->getResponse()->getStatusCode());
$this->assertResponseStatusCodeRedirect('google.com', $client);
$this->assertTrue($client->getResponse()->isRedirected('google.com'));
$this->assertResponseNotRegExp('/foo/', $client);
$this->assertNotRegExp('/foo', $client->getResponse()->getContent());
$this->assertResponseRegExp('/foo/', $client);
$this->assertRegExp('/foo', $client->getResponse()->getContent());
$this->assertResponseNotSelectExists('h1', $client);
$this->assertTrue($crawler->filter('h1')->isEmpty());
$this->assertResponseSelectExists('h1', $client);
$this->assertFalse($crawler->filter('h1')->isEmpty());
$this->assertResponseSelectCount(3, 'h1', $client);
$this->assertEquals(3, $crawler->filter('h1')->count());
$this->assertResponseSelectEquals($expected, $selector, $arguments, $client);
$this->assertEquals($expected, $crawler->filter($selector)->extract($arguments));
$this->assertResponseHeaderEquals($value, $key, $client);
$this->assertTrue($client->getResponse()->headers->contains($key, $value));
$this->assertResponseNotHeaderEquals($value, $key, $client);
$this->assertFalse($client->getResponse()->headers->contains($key, $value));
$this->assertResponseHeaderRegExp($regex, $key, $client);
$this->assertRegExp($regex, $client->getResponse()->headers->get($key));
$this->assertResponseNotHeaderRegExp($regex, $key, $client);
$this->assertNotRegExp($regex, $client->getResponse()->headers->get($key));
$this->assertResponseCookie($value, $attributes, $name, $client);
$this->assertTrue($client->getResponse()->hasCookie($name));
2010-06-23 09:39:33 +01:00
|
|
|
/**
|
|
|
|
* Returns true if the given HTTP header contains the given value.
|
|
|
|
*
|
|
|
|
* @param string $key The HTTP header name
|
|
|
|
* @param string $value The HTTP value
|
|
|
|
*
|
|
|
|
* @return Boolean true if the value is contained in the header, false otherwise
|
|
|
|
*/
|
|
|
|
public function contains($key, $value)
|
|
|
|
{
|
2010-06-23 15:24:24 +01:00
|
|
|
return in_array($value, $this->get($key, false));
|
[HttpKernel] removed Response assertions
They are too magic and they don't really add value:
$this->assertResponseStatusCodeEmpty($client);
$this->assertTrue($client->getResponse()->isEmpty());
$this->assertResponseStatusCodeNotFound($client);
$this->assertTrue($client->getResponse()->isNotFound());
$this->assertResponseStatusCodeForbidden($client);
$this->assertTrue($client->getResponse()->isForbidden());
$this->assertResponseStatusCodeOk($client);
$this->assertTrue($client->getResponse()->isOk());
$this->assertResponseStatusCodeServerError($client);
$this->assertTrue($client->getResponse()->isServerError());
$this->assertResponseStatusCodeClientError($client);
$this->assertTrue($client->getResponse()->isClientError());
$this->assertResponseStatusCodeRedirection($client);
$this->assertTrue($client->getResponse()->isRedirection());
$this->assertResponseStatusCodeSuccessful($client);
$this->assertTrue($client->getResponse()->isSuccessful());
$this->assertResponseStatusCodeInformational($client);
$this->assertTrue($client->getResponse()->isInformational());
$this->assertResponseStatusCode(200, $client);
$this->assertEquals(200, $client->getResponse()->getStatusCode());
$this->assertResponseStatusCodeRedirect('google.com', $client);
$this->assertTrue($client->getResponse()->isRedirected('google.com'));
$this->assertResponseNotRegExp('/foo/', $client);
$this->assertNotRegExp('/foo', $client->getResponse()->getContent());
$this->assertResponseRegExp('/foo/', $client);
$this->assertRegExp('/foo', $client->getResponse()->getContent());
$this->assertResponseNotSelectExists('h1', $client);
$this->assertTrue($crawler->filter('h1')->isEmpty());
$this->assertResponseSelectExists('h1', $client);
$this->assertFalse($crawler->filter('h1')->isEmpty());
$this->assertResponseSelectCount(3, 'h1', $client);
$this->assertEquals(3, $crawler->filter('h1')->count());
$this->assertResponseSelectEquals($expected, $selector, $arguments, $client);
$this->assertEquals($expected, $crawler->filter($selector)->extract($arguments));
$this->assertResponseHeaderEquals($value, $key, $client);
$this->assertTrue($client->getResponse()->headers->contains($key, $value));
$this->assertResponseNotHeaderEquals($value, $key, $client);
$this->assertFalse($client->getResponse()->headers->contains($key, $value));
$this->assertResponseHeaderRegExp($regex, $key, $client);
$this->assertRegExp($regex, $client->getResponse()->headers->get($key));
$this->assertResponseNotHeaderRegExp($regex, $key, $client);
$this->assertNotRegExp($regex, $client->getResponse()->headers->get($key));
$this->assertResponseCookie($value, $attributes, $name, $client);
$this->assertTrue($client->getResponse()->hasCookie($name));
2010-06-23 09:39:33 +01:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Deletes a header.
|
|
|
|
*
|
|
|
|
* @param string $key The HTTP header name
|
|
|
|
*/
|
|
|
|
public function delete($key)
|
2010-05-03 10:40:23 +01:00
|
|
|
{
|
2010-06-23 15:24:24 +01:00
|
|
|
unset($this->headers[strtr(strtolower($key), '_', '-')]);
|
2010-05-03 10:40:23 +01:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Returns an instance able to manage the Cache-Control header.
|
|
|
|
*
|
2010-07-10 13:13:50 +01:00
|
|
|
* @return \Symfony\Components\HttpFoundation\CacheControl A CacheControl instance
|
2010-05-06 12:25:53 +01:00
|
|
|
*/
|
|
|
|
public function getCacheControl()
|
2010-05-03 10:40:23 +01:00
|
|
|
{
|
2010-05-07 15:09:11 +01:00
|
|
|
if (null === $this->cacheControl) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->cacheControl = new CacheControl($this, $this->get('Cache-Control'), $this->type);
|
|
|
|
}
|
|
|
|
|
|
|
|
return $this->cacheControl;
|
2010-05-03 10:40:23 +01:00
|
|
|
}
|
|
|
|
|
2010-06-23 15:24:24 +01:00
|
|
|
/**
|
|
|
|
* Sets a cookie.
|
|
|
|
*
|
|
|
|
* @param string $name The cookie name
|
|
|
|
* @param string $value The value of the cookie
|
|
|
|
* @param string $domain The domain that the cookie is available
|
|
|
|
* @param string $expire The time the cookie expires
|
|
|
|
* @param string $path The path on the server in which the cookie will be available on
|
|
|
|
* @param bool $secure Indicates that the cookie should only be transmitted over a secure HTTPS connection from the client
|
2010-07-24 17:17:00 +01:00
|
|
|
* @param bool $httponly When TRUE the cookie will not be made accessible to JavaScript, preventing XSS attacks from stealing cookies
|
2010-06-23 15:24:24 +01:00
|
|
|
*
|
|
|
|
* @throws \InvalidArgumentException When the cookie expire parameter is not valid
|
|
|
|
*/
|
|
|
|
public function setCookie($name, $value, $domain = null, $expires = null, $path = '/', $secure = false, $httponly = false)
|
|
|
|
{
|
|
|
|
// from PHP source code
|
|
|
|
if (preg_match("/[=,; \t\r\n\013\014]/", $name)) {
|
|
|
|
throw new \InvalidArgumentException(sprintf('The cookie name "%s" contains invalid characters.', $name));
|
|
|
|
}
|
|
|
|
|
|
|
|
if (preg_match("/[,; \t\r\n\013\014]/", $value)) {
|
|
|
|
throw new \InvalidArgumentException(sprintf('The cookie value "%s" contains invalid characters.', $name));
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!$name) {
|
|
|
|
throw new \InvalidArgumentException('The cookie name cannot be empty');
|
|
|
|
}
|
|
|
|
|
|
|
|
$cookie = sprintf('%s=%s', $name, urlencode($value));
|
|
|
|
|
|
|
|
if ('request' === $this->type) {
|
|
|
|
return $this->set('Cookie', $cookie);
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!$domain) {
|
|
|
|
throw new \InvalidArgumentException('The cookie domain cannot be empty');
|
|
|
|
}
|
|
|
|
|
|
|
|
if (null !== $expires) {
|
|
|
|
if (is_numeric($expires)) {
|
|
|
|
$expires = (int) $expires;
|
|
|
|
} elseif ($expires instanceof \DateTime) {
|
|
|
|
$expires = $expires->getTimestamp();
|
|
|
|
} else {
|
|
|
|
$expires = strtotime($expires);
|
|
|
|
if (false === $expires || -1 == $expires) {
|
2010-06-28 07:31:22 +01:00
|
|
|
throw new \InvalidArgumentException(sprintf('The "expires" cookie parameter is not valid.', $expires));
|
2010-06-23 15:24:24 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2010-06-26 12:00:25 +01:00
|
|
|
if (null !== $expires) {
|
2010-06-23 15:24:24 +01:00
|
|
|
$cookie .= '; expires='.substr(\DateTime::createFromFormat('U', $expires, new \DateTimeZone('UTC'))->format('D, d-M-Y H:i:s T'), 0, -5);
|
|
|
|
}
|
|
|
|
|
2010-06-28 07:31:22 +01:00
|
|
|
$cookie .= '; domain='.$domain;
|
|
|
|
|
2010-06-26 12:00:25 +01:00
|
|
|
if ('/' !== $path) {
|
2010-06-23 15:24:24 +01:00
|
|
|
$cookie .= '; path='.$path;
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($secure) {
|
|
|
|
$cookie .= '; secure';
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($httponly) {
|
|
|
|
$cookie .= '; httponly';
|
|
|
|
}
|
|
|
|
|
|
|
|
$this->set('Set-Cookie', $cookie, false);
|
|
|
|
}
|
|
|
|
|
2010-05-10 18:40:18 +01:00
|
|
|
/**
|
|
|
|
* Returns the HTTP header value converted to a date.
|
|
|
|
*
|
|
|
|
* @param string $key The parameter key
|
|
|
|
* @param \DateTime $default The default value
|
|
|
|
*
|
|
|
|
* @return \DateTime The filtered value
|
|
|
|
*/
|
|
|
|
public function getDate($key, \DateTime $default = null)
|
|
|
|
{
|
|
|
|
if (null === $value = $this->get($key)) {
|
|
|
|
return $default;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (false === $date = \DateTime::createFromFormat(DATE_RFC2822, $value)) {
|
|
|
|
throw new \RuntimeException(sprintf('The %s HTTP header is not parseable (%s).', $key, $value));
|
|
|
|
}
|
|
|
|
|
|
|
|
return $date;
|
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Normalizes a HTTP header name.
|
|
|
|
*
|
|
|
|
* @param string $key The HTTP header name
|
|
|
|
*
|
|
|
|
* @return string The normalized HTTP header name
|
|
|
|
*/
|
|
|
|
static public function normalizeHeaderName($key)
|
|
|
|
{
|
|
|
|
return strtr(strtolower($key), '_', '-');
|
|
|
|
}
|
2010-05-03 10:40:23 +01:00
|
|
|
}
|