feature #18105 [HttpFoundation] Add support for sending raw cookies in the response (jakzal)

fabpot · fabpot · commit 98ba4b76d189 · 2016-03-15T14:40:46.000+01:00
This PR was merged into the 3.1-dev branch. Discussion ---------- [HttpFoundation] Add support for sending raw cookies in the response | Q | A | ------------- | --- | Branch | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #13646 | License | MIT | Doc PR | TODO Commits ------- 43760a6 [HttpFoundation] Add support for sending raw cookies in the response
diff --git a/src/Symfony/Component/HttpFoundation/Cookie.php b/src/Symfony/Component/HttpFoundation/Cookie.php
@@ -25,6 +25,7 @@ class Cookie
     protected $path;
     protected $secure;
     protected $httpOnly;
+    private $raw;
 
     /**
      * Constructor.
@@ -36,10 +37,11 @@ class Cookie
      * @param string                                  $domain   The domain that the cookie is available to
      * @param bool                                    $secure   Whether the cookie should only be transmitted over a secure HTTPS connection from the client
      * @param bool                                    $httpOnly Whether the cookie will be made accessible only through the HTTP protocol
+     * @param bool                                    $raw      Whether the cookie value should be sent with no url encoding
      *
      * @throws \InvalidArgumentException
      */
-    public function __construct($name, $value = null, $expire = 0, $path = '/', $domain = null, $secure = false, $httpOnly = true)
+    public function __construct($name, $value = null, $expire = 0, $path = '/', $domain = null, $secure = false, $httpOnly = true, $raw = false)
     {
         // from PHP source code
         if (preg_match("/[=,; \t\r\n\013\014]/", $name)) {
@@ -68,6 +70,7 @@ public function __construct($name, $value = null, $expire = 0, $path = '/', $dom
         $this->path = empty($path) ? '/' : $path;
         $this->secure = (bool) $secure;
         $this->httpOnly = (bool) $httpOnly;
+        $this->raw = (bool) $raw;
     }
 
     /**
@@ -187,4 +190,14 @@ public function isCleared()
     {
         return $this->expire < time();
     }
+
+    /**
+     * Checks if the cookie value should be sent with no url encoding.
+     *
+     * @return bool
+     */
+    public function isRaw()
+    {
+        return $this->raw;
+    }
 }
diff --git a/src/Symfony/Component/HttpFoundation/Response.php b/src/Symfony/Component/HttpFoundation/Response.php
@@ -343,7 +343,11 @@ public function sendHeaders()
 
         // cookies
         foreach ($this->headers->getCookies() as $cookie) {
-            setcookie($cookie->getName(), $cookie->getValue(), $cookie->getExpiresTime(), $cookie->getPath(), $cookie->getDomain(), $cookie->isSecure(), $cookie->isHttpOnly());
+            if ($cookie->isRaw()) {
+                setrawcookie($cookie->getName(), $cookie->getValue(), $cookie->getExpiresTime(), $cookie->getPath(), $cookie->getDomain(), $cookie->isSecure(), $cookie->isHttpOnly());
+            } else {
+                setcookie($cookie->getName(), $cookie->getValue(), $cookie->getExpiresTime(), $cookie->getPath(), $cookie->getDomain(), $cookie->isSecure(), $cookie->isHttpOnly());
+            }
         }
 
         return $this;
diff --git a/src/Symfony/Component/HttpFoundation/Tests/CookieTest.php b/src/Symfony/Component/HttpFoundation/Tests/CookieTest.php
@@ -151,4 +151,13 @@ public function testToString()
         $cookie = new Cookie('foo', 'bar', 0, '/', '');
         $this->assertEquals('foo=bar; path=/; httponly', $cookie->__toString());
     }
+
+    public function testRawCookie()
+    {
+        $cookie = new Cookie('foo', 'bar', 3600, '/', '.myfoodomain.com', false, true);
+        $this->assertFalse($cookie->isRaw());
+
+        $cookie = new Cookie('foo', 'bar', 3600, '/', '.myfoodomain.com', false, true, true);
+        $this->assertTrue($cookie->isRaw());
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -151,4 +151,13 @@ public function testToString()`
`151`	`151`	`$cookie = new Cookie('foo', 'bar', 0, '/', '');`
`152`	`152`	`$this->assertEquals('foo=bar; path=/; httponly', $cookie->__toString());`
`153`	`153`	`}`
	`154`	`+`
	`155`	`+ public function testRawCookie()`
	`156`	`+ {`
	`157`	`+ $cookie = new Cookie('foo', 'bar', 3600, '/', '.myfoodomain.com', false, true);`
	`158`	`+ $this->assertFalse($cookie->isRaw());`
	`159`	`+`
	`160`	`+ $cookie = new Cookie('foo', 'bar', 3600, '/', '.myfoodomain.com', false, true, true);`
	`161`	`+ $this->assertTrue($cookie->isRaw());`
	`162`	`+ }`
`154`	`163`	`}`