Map normalized header names to original capitalization

gigablah · gigablah · commit 63a228c45613 · 2012-10-05T18:34:13.000+08:00
diff --git a/src/Symfony/Component/HttpFoundation/Response.php b/src/Symfony/Component/HttpFoundation/Response.php
@@ -259,7 +259,7 @@ public function sendHeaders()
         header(sprintf('HTTP/%s %s %s', $this->version, $this->statusCode, $this->statusText));
 
         // headers
-        foreach ($this->headers->all() as $name => $values) {
+        foreach ($this->headers->allPreserveCase() as $name => $values) {
             foreach ($values as $value) {
                 header($name.': '.$value, false);
             }
diff --git a/src/Symfony/Component/HttpFoundation/ResponseHeaderBag.php b/src/Symfony/Component/HttpFoundation/ResponseHeaderBag.php
@@ -36,6 +36,11 @@ class ResponseHeaderBag extends HeaderBag
      */
     protected $cookies              = array();
 
+    /**
+     * @var array
+     */
+    protected $headerNames          = array();
+
     /**
      * Constructor.
      *
@@ -48,7 +53,7 @@ public function __construct(array $headers = array())
         parent::__construct($headers);
 
         if (!isset($this->headers['cache-control'])) {
-            $this->set('cache-control', '');
+            $this->set('Cache-Control', '');
         }
     }
 
@@ -65,17 +70,29 @@ public function __toString()
         return parent::__toString().$cookies;
     }
 
+    /**
+     * Returns the headers, with original capitalizations.
+     *
+     * @return array An array of headers
+     */
+    public function allPreserveCase()
+    {
+        return array_combine($this->headerNames, $this->headers);
+    }
+
     /**
      * {@inheritdoc}
      *
      * @api
      */
     public function replace(array $headers = array())
     {
+        $this->headerNames = array();
+
         parent::replace($headers);
 
         if (!isset($this->headers['cache-control'])) {
-            $this->set('cache-control', '');
+            $this->set('Cache-Control', '');
         }
     }
 
@@ -88,10 +105,14 @@ public function set($key, $values, $replace = true)
     {
         parent::set($key, $values, $replace);
 
+        $uniqueKey = strtr(strtolower($key), '_', '-');
+        $this->headerNames[$uniqueKey] = $key;
+
         // ensure the cache-control header has sensible defaults
-        if (in_array(strtr(strtolower($key), '_', '-'), array('cache-control', 'etag', 'last-modified', 'expires'))) {
+        if (in_array($uniqueKey, array('cache-control', 'etag', 'last-modified', 'expires'))) {
             $computed = $this->computeCacheControlValue();
             $this->headers['cache-control'] = array($computed);
+            $this->headerNames['cache-control'] = 'Cache-Control';
             $this->computedCacheControl = $this->parseCacheControl($computed);
         }
     }
@@ -105,7 +126,10 @@ public function remove($key)
     {
         parent::remove($key);
 
-        if ('cache-control' === strtr(strtolower($key), '_', '-')) {
+        $uniqueKey = strtr(strtolower($key), '_', '-');
+        unset($this->headerNames[$uniqueKey]);
+
+        if ('cache-control' === $uniqueKey) {
             $this->computedCacheControl = array();
         }
     }
diff --git a/src/Symfony/Component/HttpFoundation/Tests/ResponseHeaderBagTest.php b/src/Symfony/Component/HttpFoundation/Tests/ResponseHeaderBagTest.php
@@ -16,6 +16,51 @@
 
 class ResponseHeaderBagTest extends \PHPUnit_Framework_TestCase
 {
+    /**
+     * @covers Symfony\Component\HttpFoundation\ResponseHeaderBag::allPreserveCase
+     * @dataProvider provideAllPreserveCase
+     */
+    public function testAllPreserveCase($headers, $expected)
+    {
+        $bag = new ResponseHeaderBag($headers);
+
+        $this->assertEquals($expected, $bag->allPreserveCase(), '->allPreserveCase() gets all input keys in original case');
+    }
+
+    public function provideAllPreserveCase()
+    {
+        return array(
+            array(
+                array('fOo' => 'BAR'),
+                array('fOo' => array('BAR'), 'Cache-Control' => array('no-cache'))
+            ),
+            array(
+                array('ETag' => 'xyzzy'),
+                array('ETag' => array('xyzzy'), 'Cache-Control' => array('private, must-revalidate'))
+            ),
+            array(
+                array('Content-MD5' => 'Q2hlY2sgSW50ZWdyaXR5IQ=='),
+                array('Content-MD5' => array('Q2hlY2sgSW50ZWdyaXR5IQ=='), 'Cache-Control' => array('no-cache'))
+            ),
+            array(
+                array('P3P' => 'CP="CAO PSA OUR"'),
+                array('P3P' => array('CP="CAO PSA OUR"'), 'Cache-Control' => array('no-cache'))
+            ),
+            array(
+                array('WWW-Authenticate' => 'Basic realm="WallyWorld"'),
+                array('WWW-Authenticate' => array('Basic realm="WallyWorld"'), 'Cache-Control' => array('no-cache'))
+            ),
+            array(
+                array('X-UA-Compatible' => 'IE=edge,chrome=1'),
+                array('X-UA-Compatible' => array('IE=edge,chrome=1'), 'Cache-Control' => array('no-cache'))
+            ),
+            array(
+                array('X-XSS-Protection' => '1; mode=block'),
+                array('X-XSS-Protection' => array('1; mode=block'), 'Cache-Control' => array('no-cache'))
+            ),
+        );
+    }
+
     public function testCacheControlHeader()
     {
         $bag = new ResponseHeaderBag(array());

Original file line number	Diff line number	Diff line change
`@@ -259,7 +259,7 @@ public function sendHeaders()`
`259`	`259`	`header(sprintf('HTTP/%s %s %s', $this->version, $this->statusCode, $this->statusText));`
`260`	`260`
`261`	`261`	`// headers`
`262`		`- foreach ($this->headers->all() as $name => $values) {`
	`262`	`+ foreach ($this->headers->allPreserveCase() as $name => $values) {`
`263`	`263`	`foreach ($values as $value) {`
`264`	`264`	`header($name.': '.$value, false);`
`265`	`265`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,11 @@ class ResponseHeaderBag extends HeaderBag`
`36`	`36`	`*/`
`37`	`37`	`protected $cookies = array();`
`38`	`38`
	`39`	`+ /**`
	`40`	`+ * @var array`
	`41`	`+ */`
	`42`	`+ protected $headerNames = array();`
	`43`	`+`
`39`	`44`	`/**`
`40`	`45`	`* Constructor.`
`41`	`46`	`*`
`@@ -48,7 +53,7 @@ public function __construct(array $headers = array())`
`48`	`53`	`parent::__construct($headers);`
`49`	`54`
`50`	`55`	`if (!isset($this->headers['cache-control'])) {`
`51`		`- $this->set('cache-control', '');`
	`56`	`+ $this->set('Cache-Control', '');`
`52`	`57`	`}`
`53`	`58`	`}`
`54`	`59`
`@@ -65,17 +70,29 @@ public function __toString()`
`65`	`70`	`return parent::__toString().$cookies;`
`66`	`71`	`}`
`67`	`72`
	`73`	`+ /**`
	`74`	`+ * Returns the headers, with original capitalizations.`
	`75`	`+ *`
	`76`	`+ * @return array An array of headers`
	`77`	`+ */`
	`78`	`+ public function allPreserveCase()`
	`79`	`+ {`
	`80`	`+ return array_combine($this->headerNames, $this->headers);`
	`81`	`+ }`
	`82`	`+`
`68`	`83`	`/**`
`69`	`84`	`* {@inheritdoc}`
`70`	`85`	`*`
`71`	`86`	`* @api`
`72`	`87`	`*/`
`73`	`88`	`public function replace(array $headers = array())`
`74`	`89`	`{`
	`90`	`+ $this->headerNames = array();`
	`91`	`+`
`75`	`92`	`parent::replace($headers);`
`76`	`93`
`77`	`94`	`if (!isset($this->headers['cache-control'])) {`
`78`		`- $this->set('cache-control', '');`
	`95`	`+ $this->set('Cache-Control', '');`
`79`	`96`	`}`
`80`	`97`	`}`
`81`	`98`
`@@ -88,10 +105,14 @@ public function set($key, $values, $replace = true)`
`88`	`105`	`{`
`89`	`106`	`parent::set($key, $values, $replace);`
`90`	`107`
	`108`	`+ $uniqueKey = strtr(strtolower($key), '_', '-');`
	`109`	`+ $this->headerNames[$uniqueKey] = $key;`
	`110`	`+`
`91`	`111`	`// ensure the cache-control header has sensible defaults`
`92`		`- if (in_array(strtr(strtolower($key), '_', '-'), array('cache-control', 'etag', 'last-modified', 'expires'))) {`
	`112`	`+ if (in_array($uniqueKey, array('cache-control', 'etag', 'last-modified', 'expires'))) {`
`93`	`113`	`$computed = $this->computeCacheControlValue();`
`94`	`114`	`$this->headers['cache-control'] = array($computed);`
	`115`	`+ $this->headerNames['cache-control'] = 'Cache-Control';`
`95`	`116`	`$this->computedCacheControl = $this->parseCacheControl($computed);`
`96`	`117`	`}`
`97`	`118`	`}`
`@@ -105,7 +126,10 @@ public function remove($key)`
`105`	`126`	`{`
`106`	`127`	`parent::remove($key);`
`107`	`128`
`108`		`- if ('cache-control' === strtr(strtolower($key), '_', '-')) {`
	`129`	`+ $uniqueKey = strtr(strtolower($key), '_', '-');`
	`130`	`+ unset($this->headerNames[$uniqueKey]);`
	`131`	`+`
	`132`	`+ if ('cache-control' === $uniqueKey) {`
`109`	`133`	`$this->computedCacheControl = array();`
`110`	`134`	`}`
`111`	`135`	`}`