Skip to content
This repository has been archived by the owner on Jan 30, 2020. It is now read-only.

Commit

Permalink
Merge branch 'hotfix/4776' into develop
Browse files Browse the repository at this point in the history 
Forward port zendframework/zendframework#4776
  • Loading branch information
@weierophinney
weierophinney committed Jul 19, 2013
141 parents 257cea8 + 89a44d0 + 5c10b75 + db7d808 + 4ee93be + 9ecbeb2 + d240054 + 78d3205 + 8903b2d + 464835b + c59b54d + 14ad3a0 + f4ac37b + 0ec8036 + 8839d0e + 07564e2 + a65cb66 + ecb09fb + 6de3f68 + cb8f354 + d7ffaed + 1819a00 + e2ca906 + f897f74 + 0568c55 + d7f0623 + 8b4896f + 2f83acc + a44d7dd + 6bce797 + 6ad2b62 + 1e41fbd + a0078e6 + 9db875b + 2879406 + 9acc850 + eddeb7d + 5a77057 + 33c15ff + 9f13ebf + a2ad2a5 + c0ba21c + 94e82a8 + 459f1f9 + e0c8424 + 5ef6a39 + 58fd018 + 65e3b0b + d21655a + 1d20fd1 + fe81bc5 + 96fadae + 072c64d + d3c9780 + 9c15ae8 + 66a4342 + 85c9491 + 8ec8384 + 004366f + 55a086d + ac7c7af + f02a226 + 00c4ac3 + 3f52720 + 5508474 + 49ed2f6 + d562686 + 67b42b2 + bdb1dae + 9809630 + 7304e37 + 752a5af + 8181c8f + 53bdac2 + c2f9414 + f6341e9 + 57cde95 + c750616 + 293054e + 7432649 + 63f13f6 + 927c00d + 44e0d4b + bc03833 + 1fd7c61 + de0cb77 + 66e902f + 24354dc + 9f886a2 + 845333c + 96e9a1e + 52fbeb6 + 7f76d90 + fec4cec + 24efdcc + 219c9ad + 3025666 + 17d48b4 + 00f4506 + 0800032 + fc89677 + e89d79b + f329014 + a1bfde3 + 7dec05c + 734f9f2 + 2756031 + 408f714 + fd53447 + f1f6e0d + e193ac7 + dad06c3 + 03ab3c8 + d0b9eec + e47995d + 411b935 + ddc8029 + a6c1451 + e823524 + eb63995 + 2de2423 + a95575b + 03a862c + e195cc6 + f4ac757 + a53de82 + 42763a8 + 6b14b45 + 2c344a8 + ff8337b + 18b53cb + e669f19 + 592011d + 076244a + df3d273 + df0ceea + 52b821e + b5e6fa9 + be5e28e + cb6a993 + 7d5ff3a commit 472ac62
Show file tree
Hide file tree
Showing 2 changed files with 148 additions and 66 deletions.
126 changes: 60 additions & 66 deletions src/Header/SetCookie.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,56 +23,56 @@ class SetCookie implements MultipleHeaderInterface
/**
* Cookie name
*
* @var string
* @var string|null
*/
protected $name = null;

/**
* Cookie value
*
* @var string
* @var string|null
*/
protected $value = null;

/**
* Version
*
* @var int
* @var int|null
*/
protected $version = null;

/**
* Max Age
*
* @var int
* @var int|null
*/
protected $maxAge = null;

/**
* Cookie expiry date
*
* @var int
* @var int|null
*/
protected $expires = null;

/**
* Cookie domain
*
* @var string
* @var string|null
*/
protected $domain = null;

/**
* Cookie path
*
* @var string
* @var string|null
*/
protected $path = null;

/**
* Whether the cookie is secure or not
*
* @var bool
* @var bool|null
*/
protected $secure = null;

Expand Down Expand Up @@ -161,56 +161,30 @@ public static function fromString($headerLine, $bypassHeaderFieldName = false)
*
* @todo Add validation of each one of the parameters (legal domain, etc.)
*
* @param string $name
* @param string $value
* @param int $expires
* @param string $path
* @param string $domain
* @param bool $secure
* @param bool $httponly
* @param string $maxAge
* @param int $version
* @return SetCookie
* @param string $name
* @param string $value
* @param int|string $expires
* @param string $path
* @param string $domain
* @param bool $secure
* @param bool $httponly
* @param string $maxAge
* @param int $version
* @return SetCookie
*/
public function __construct($name = null, $value = null, $expires = null, $path = null, $domain = null, $secure = false, $httponly = false, $maxAge = null, $version = null)
{
$this->type = 'Cookie';

if ($name) {
$this->setName($name);
}

if ($value) {
$this->setValue($value); // in parent
}

if ($version!==null) {
$this->setVersion($version);
}

if ($maxAge!==null) {
$this->setMaxAge($maxAge);
}

if ($domain) {
$this->setDomain($domain);
}

if ($expires) {
$this->setExpires($expires);
}

if ($path) {
$this->setPath($path);
}

if ($secure) {
$this->setSecure($secure);
}

if ($httponly) {
$this->setHttpOnly($httponly);
}
$this->setName($name)
->setValue($value)
->setVersion($version)
->setMaxAge($maxAge)
->setDomain($domain)
->setExpires($expires)
->setPath($path)
->setSecure($secure)
->setHttpOnly($httponly);
}

/**
Expand Down Expand Up @@ -282,7 +256,7 @@ public function getFieldValue()
*/
public function setName($name)
{
if (preg_match("/[=,; \t\r\n\013\014]/", $name)) {
if ($name !== null && preg_match("/[=,; \t\r\n\013\014]/", $name)) {
throw new Exception\InvalidArgumentException("Cookie name cannot contain these characters: =,; \\t\\r\\n\\013\\014 ({$name})");
}

Expand All @@ -300,10 +274,12 @@ public function getName()

/**
* @param string $value
* @return SetCookie
*/
public function setValue($value)
{
$this->value = $value;
return $this;
}

/**
Expand All @@ -319,13 +295,15 @@ public function getValue()
*
* @param int $version
* @throws Exception\InvalidArgumentException
* @return SetCookie
*/
public function setVersion($version)
{
if (!is_int($version)) {
if ($version !== null && !is_int($version)) {
throw new Exception\InvalidArgumentException('Invalid Version number specified');
}
$this->version = $version;
return $this;
}

/**
Expand All @@ -343,13 +321,15 @@ public function getVersion()
*
* @param int $maxAge
* @throws Exception\InvalidArgumentException
* @return SetCookie
*/
public function setMaxAge($maxAge)
{
if (!is_int($maxAge) || ($maxAge<0)) {
if ($maxAge !== null && (!is_int($maxAge) || ($maxAge < 0))) {
throw new Exception\InvalidArgumentException('Invalid Max-Age number specified');
}
$this->maxAge = $maxAge;
return $this;
}

/**
Expand All @@ -363,30 +343,36 @@ public function getMaxAge()
}

/**
* @param int $expires
* @param int|string $expires
* @throws Exception\InvalidArgumentException
* @return SetCookie
*/
public function setExpires($expires)
{
if (!empty($expires)) {
if (is_string($expires)) {
$expires = strtotime($expires);
} elseif (!is_int($expires)) {
throw new Exception\InvalidArgumentException('Invalid expires time specified');
}
$this->expires = (int) $expires;
if ($expires === null) {
$this->expires = null;
return $this;
}

if (is_string($expires)) {
$expires = strtotime($expires);
}

if (!is_int($expires) || $expires < 0) {
throw new Exception\InvalidArgumentException('Invalid expires time specified');
}

$this->expires = $expires;
return $this;
}

/**
* @param bool $inSeconds
* @return int
* @return int|string
*/
public function getExpires($inSeconds = false)
{
if ($this->expires == null) {
if ($this->expires === null) {
return;
}
if ($inSeconds) {
Expand All @@ -397,10 +383,12 @@ public function getExpires($inSeconds = false)

/**
* @param string $domain
* @return SetCookie
*/
public function setDomain($domain)
{
$this->domain = $domain;
return $this;
}

/**
Expand All @@ -413,10 +401,12 @@ public function getDomain()

/**
* @param string $path
* @return SetCookie
*/
public function setPath($path)
{
$this->path = $path;
return $this;
}

/**
Expand All @@ -429,10 +419,12 @@ public function getPath()

/**
* @param bool $secure
* @return SetCookie
*/
public function setSecure($secure)
{
$this->secure = $secure;
return $this;
}

/**
Expand All @@ -445,10 +437,12 @@ public function isSecure()

/**
* @param bool $httponly
* @return SetCookie
*/
public function setHttponly($httponly)
{
$this->httponly = $httponly;
return $this;
}

/**
Expand Down
88 changes: 88 additions & 0 deletions test/Header/SetCookieTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,94 @@ public function testSetCookieCanAppendOtherHeadersInWhenCreatingString()
$this->assertEquals($target, $headerLine);
}

public function testSetCookieAttributesAreUnsettable()
{
$setCookieHeader = new SetCookie();
$setCookieHeader->setName('myname');
$setCookieHeader->setValue('myvalue');
$setCookieHeader->setExpires('Wed, 13-Jan-2021 22:23:01 GMT');
$setCookieHeader->setDomain('docs.foo.com');
$setCookieHeader->setPath('/accounts');
$setCookieHeader->setSecure(true);
$setCookieHeader->setHttponly(true);

$target = 'myname=myvalue; Expires=Wed, 13-Jan-2021 22:23:01 GMT;'
. ' Domain=docs.foo.com; Path=/accounts;'
. ' Secure; HttpOnly';
$this->assertSame($target, $setCookieHeader->getFieldValue()); // attributes set

$setCookieHeader->setExpires(NULL);
$setCookieHeader->setDomain(NULL);
$setCookieHeader->setPath(NULL);
$setCookieHeader->setSecure(NULL);
$setCookieHeader->setHttponly(NULL);
$this->assertSame('myname=myvalue', $setCookieHeader->getFieldValue()); // attributes unset

$setCookieHeader->setValue(NULL);
$this->assertSame('myname=', $setCookieHeader->getFieldValue());
$this->assertNull($setCookieHeader->getValue());
$this->assertNull($setCookieHeader->getExpires());
$this->assertNull($setCookieHeader->getDomain());
$this->assertNull($setCookieHeader->getPath());
$this->assertNull($setCookieHeader->isSecure());
$this->assertNull($setCookieHeader->isHttponly());
}

public function testSetCookieFieldValueIsEmptyStringWhenNameIsUnset()
{
$setCookieHeader = new SetCookie();
$this->assertSame('', $setCookieHeader->getFieldValue()); // empty

$setCookieHeader->setName('myname');
$setCookieHeader->setValue('myvalue');
$setCookieHeader->setExpires('Wed, 13-Jan-2021 22:23:01 GMT');
$setCookieHeader->setDomain('docs.foo.com');
$setCookieHeader->setPath('/accounts');
$setCookieHeader->setSecure(true);
$setCookieHeader->setHttponly(true);

$target = 'myname=myvalue; Expires=Wed, 13-Jan-2021 22:23:01 GMT;'
. ' Domain=docs.foo.com; Path=/accounts;'
. ' Secure; HttpOnly';
$this->assertSame($target, $setCookieHeader->getFieldValue()); // not empty

$setCookieHeader->setName(null);
$this->assertSame('', $setCookieHeader->getFieldValue()); // empty again
$this->assertNull($setCookieHeader->getName());
}

public function testSetCookieSetExpiresWithZeroTimeStamp()
{
$setCookieHeader = new SetCookie('myname', 'myvalue', 0);
$this->assertSame('Thu, 01-Jan-1970 00:00:00 GMT', $setCookieHeader->getExpires());

$setCookieHeader = new SetCookie('myname', 'myvalue', 1);
$this->assertSame('Thu, 01-Jan-1970 00:00:01 GMT', $setCookieHeader->getExpires());

$setCookieHeader->setExpires(0);
$this->assertSame('Thu, 01-Jan-1970 00:00:00 GMT', $setCookieHeader->getExpires());

$target = 'myname=myvalue; Expires=Thu, 01-Jan-1970 00:00:00 GMT';
$this->assertSame($target, $setCookieHeader->getFieldValue());
}

public function testSetCookieSetExpiresWithUnixEpochString()
{
$setCookieHeader = new SetCookie('myname', 'myvalue', 'Thu, 01-Jan-1970 00:00:00 GMT');
$this->assertSame('Thu, 01-Jan-1970 00:00:00 GMT', $setCookieHeader->getExpires());
$this->assertSame(0, $setCookieHeader->getExpires(true));

$setCookieHeader = new SetCookie('myname', 'myvalue', 1);
$this->assertSame('Thu, 01-Jan-1970 00:00:01 GMT', $setCookieHeader->getExpires());

$setCookieHeader->setExpires('Thu, 01-Jan-1970 00:00:00 GMT');
$this->assertSame('Thu, 01-Jan-1970 00:00:00 GMT', $setCookieHeader->getExpires());
$this->assertSame(0, $setCookieHeader->getExpires(true));

$target = 'myname=myvalue; Expires=Thu, 01-Jan-1970 00:00:00 GMT';
$this->assertSame($target, $setCookieHeader->getFieldValue());
}

public function testIsValidForRequestSubdomainMatch()
{
$setCookieHeader = new SetCookie(
Expand Down

0 comments on commit 472ac62

Please sign in to comment.