merged branch SamsonIT/fixedMessedUpHeaders (PR #7189)

fabpot · fabpot · commit 287dbbe99d92 · 2013-02-26T10:42:13.000+01:00
This PR was squashed before being merged into the 2.2 branch (closes #7189). Commits ------- 850bd5a [HttpFoundation] Fixed messed up headers Discussion ---------- [HttpFoundation] Fixed messed up headers | Q | A | ------------- | --- | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | n/a I ran into this when somewhere in our code the Response object was cast into a string. After that, when send()'ing the Response, the headers would be all mixed up. This is because the __toString in HeaderBag ksorts the headers, while the __toString in ResponseHeaderBag doesn't ksort the corresponding headerNames. This patch ksorts that one as well. allPreserveCase() is new to 2.2, so this bug doesn't seem to affect earlier versions. To be exact, this is where it got introduced: 63a228c45613bb --------------------------------------------------------------------------- by Burgov at 2013-02-26T09:27:20Z B.t.w. another option was to ksort a copy of the headers array in the ResponseBag and leaving the actual thing as-is. Not sure which one would be the best option?
diff --git a/src/Symfony/Component/HttpFoundation/ResponseHeaderBag.php b/src/Symfony/Component/HttpFoundation/ResponseHeaderBag.php
@@ -67,6 +67,8 @@ public function __toString()
             $cookies .= 'Set-Cookie: '.$cookie."\r\n";
         }
 
+        ksort($this->headerNames);
+
         return parent::__toString().$cookies;
     }
 
diff --git a/src/Symfony/Component/HttpFoundation/Tests/ResponseHeaderBagTest.php b/src/Symfony/Component/HttpFoundation/Tests/ResponseHeaderBagTest.php
@@ -235,6 +235,20 @@ public function testMakeDisposition($disposition, $filename, $filenameFallback,
         $this->assertEquals($expected, $headers->makeDisposition($disposition, $filename, $filenameFallback));
     }
 
+    public function testToStringDoesntMessUpHeaders()
+    {
+        $headers = new ResponseHeaderBag();
+
+        $headers->set('Location', 'http://www.symfony.com');
+        $headers->set('Content-type', 'text/html');
+
+        (string) $headers;
+
+        $allHeaders = $headers->allPreserveCase();
+        $this->assertEquals(array('http://www.symfony.com'), $allHeaders['Location']);
+        $this->assertEquals(array('text/html'), $allHeaders['Content-type']);
+    }
+
     public function provideMakeDisposition()
     {
         return array(

Original file line number	Diff line number	Diff line change
`@@ -67,6 +67,8 @@ public function __toString()`
`67`	`67`	`$cookies .= 'Set-Cookie: '.$cookie."\r\n";`
`68`	`68`	`}`
`69`	`69`
	`70`	`+ ksort($this->headerNames);`
	`71`	`+`
`70`	`72`	`return parent::__toString().$cookies;`
`71`	`73`	`}`
`72`	`74`