Merge branch 'Maks3w-hotfix/http-header-format'

Close zendframework/zendframework#5302 Close zendframework/zendframework#5253 Close zendframework/zendframework#5290
zendframework · Oct 20, 2013 · c7b3fc6 · c7b3fc6
commit c7b3fc6
Show file tree

Hide file tree

Showing 48 changed files with 129 additions and 46 deletions.
diff --git a/src/Header/AbstractDate.php b/src/Header/AbstractDate.php
@@ -74,7 +74,7 @@ public static function fromString($headerLine)
     {
         $dateHeader = new static();
 
-        list($name, $date) = explode(': ', $headerLine, 2);
+        list($name, $date) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== strtolower($dateHeader->getFieldName())) {

diff --git a/src/Header/AbstractLocation.php b/src/Header/AbstractLocation.php
@@ -47,7 +47,7 @@ public static function fromString($headerLine)
         $locationHeader = new static();
 
         // ZF-5520 - IIS bug, no space after colon
-        list($name, $uri) = explode(':', $headerLine, 2);
+        list($name, $uri) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== strtolower($locationHeader->getFieldName())) {

diff --git a/src/Header/AcceptRanges.php b/src/Header/AcceptRanges.php
@@ -23,7 +23,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'accept-ranges') {

diff --git a/src/Header/Age.php b/src/Header/Age.php
@@ -34,7 +34,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'age') {

diff --git a/src/Header/Allow.php b/src/Header/Allow.php
@@ -48,7 +48,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'allow') {

diff --git a/src/Header/AuthenticationInfo.php b/src/Header/AuthenticationInfo.php
@@ -20,7 +20,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'authentication-info') {

diff --git a/src/Header/Authorization.php b/src/Header/Authorization.php
@@ -20,7 +20,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'authorization') {

diff --git a/src/Header/CacheControl.php b/src/Header/CacheControl.php
@@ -34,7 +34,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'cache-control') {

diff --git a/src/Header/Connection.php b/src/Header/Connection.php
@@ -35,7 +35,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'connection') {

diff --git a/src/Header/ContentDisposition.php b/src/Header/ContentDisposition.php
@@ -20,7 +20,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'content-disposition') {

diff --git a/src/Header/ContentEncoding.php b/src/Header/ContentEncoding.php
@@ -20,7 +20,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'content-encoding') {

diff --git a/src/Header/ContentLanguage.php b/src/Header/ContentLanguage.php
@@ -20,7 +20,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'content-language') {

diff --git a/src/Header/ContentLength.php b/src/Header/ContentLength.php
@@ -20,7 +20,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'content-length') {

diff --git a/src/Header/ContentMD5.php b/src/Header/ContentMD5.php
@@ -20,7 +20,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'content-md5') {

diff --git a/src/Header/ContentRange.php b/src/Header/ContentRange.php
@@ -20,7 +20,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'content-range') {

diff --git a/src/Header/ContentTransferEncoding.php b/src/Header/ContentTransferEncoding.php
@@ -20,7 +20,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'content-transfer-encoding') {

diff --git a/src/Header/ContentType.php b/src/Header/ContentType.php
@@ -20,7 +20,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'content-type') {

diff --git a/src/Header/Cookie.php b/src/Header/Cookie.php
@@ -41,7 +41,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'cookie') {

diff --git a/src/Header/Expect.php b/src/Header/Expect.php
@@ -20,7 +20,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'expect') {

diff --git a/src/Header/From.php b/src/Header/From.php
@@ -20,7 +20,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'from') {

diff --git a/src/Header/GenericHeader.php b/src/Header/GenericHeader.php
@@ -34,11 +34,30 @@ class GenericHeader implements HeaderInterface
      */
     public static function fromString($headerLine)
     {
-        list($fieldName, $fieldValue) = explode(': ', $headerLine, 2);
+        list($fieldName, $fieldValue) = GenericHeader::splitHeaderLine($headerLine);
         $header = new static($fieldName, $fieldValue);
         return $header;
     }
 
+    /**
+     * Splits the header line in `name` and `value` parts.
+     *
+     * @param string $headerLine
+     * @return string[] `name` in the first index and `value` in the second.
+     * @throws Exception\InvalidArgumentException If header does not match with the format ``name:value``
+     */
+    public static function splitHeaderLine($headerLine)
+    {
+        $parts = explode(':', $headerLine, 2);
+        if (count($parts) !== 2) {
+            throw new Exception\InvalidArgumentException('Header must match with the format "name:value"');
+        }
+
+        $parts[1] = ltrim($parts[1]);
+
+        return $parts;
+    }
+
     /**
      * Constructor
      *

diff --git a/src/Header/GenericMultiHeader.php b/src/Header/GenericMultiHeader.php
@@ -13,7 +13,7 @@ class GenericMultiHeader extends GenericHeader implements MultipleHeaderInterfac
 {
     public static function fromString($headerLine)
     {
-        list($fieldName, $fieldValue) = explode(': ', $headerLine, 2);
+        list($fieldName, $fieldValue) = GenericHeader::splitHeaderLine($headerLine);
 
         if (strpos($fieldValue, ',')) {
             $headers = array();

diff --git a/src/Header/HeaderInterface.php b/src/Header/HeaderInterface.php
@@ -9,10 +9,41 @@
 
 namespace Zend\Http\Header;
 
+/**
+ * Interface for HTTP Header classes.
+ */
 interface HeaderInterface
 {
+    /**
+     * Factory to generate a header object from a string
+     *
+     * @param string $headerLine
+     * @return self
+     * @throws Exception\InvalidArgumentException If the header does not match RFC 2616 definition.
+     * @see http://tools.ietf.org/html/rfc2616#section-4.2
+     */
     public static function fromString($headerLine);
+
+    /**
+     * Retrieve header name
+     *
+     * @return string
+     */
     public function getFieldName();
+
+    /**
+     * Retrieve header value
+     *
+     * @return string
+     */
     public function getFieldValue();
+
+    /**
+     * Cast to string
+     *
+     * Returns in form of "NAME: VALUE"
+     *
+     * @return string
+     */
     public function toString();
 }
diff --git a/src/Header/Host.php b/src/Header/Host.php
@@ -20,7 +20,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'host') {

diff --git a/src/Header/IfMatch.php b/src/Header/IfMatch.php
@@ -20,7 +20,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'if-match') {

diff --git a/src/Header/IfNoneMatch.php b/src/Header/IfNoneMatch.php
@@ -20,7 +20,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'if-none-match') {

diff --git a/src/Header/IfRange.php b/src/Header/IfRange.php
@@ -20,7 +20,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'if-range') {

diff --git a/src/Header/KeepAlive.php b/src/Header/KeepAlive.php
@@ -20,7 +20,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'keep-alive') {

diff --git a/src/Header/MaxForwards.php b/src/Header/MaxForwards.php
@@ -20,7 +20,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'max-forwards') {

diff --git a/src/Header/Pragma.php b/src/Header/Pragma.php
@@ -20,7 +20,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'pragma') {

diff --git a/src/Header/ProxyAuthenticate.php b/src/Header/ProxyAuthenticate.php
@@ -20,7 +20,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'proxy-authenticate') {

diff --git a/src/Header/ProxyAuthorization.php b/src/Header/ProxyAuthorization.php
@@ -20,7 +20,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'proxy-authorization') {

diff --git a/src/Header/Range.php b/src/Header/Range.php
@@ -20,7 +20,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'range') {

diff --git a/src/Header/Refresh.php b/src/Header/Refresh.php
@@ -20,7 +20,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'refresh') {

diff --git a/src/Header/RetryAfter.php b/src/Header/RetryAfter.php
@@ -35,7 +35,7 @@ public static function fromString($headerLine)
     {
         $dateHeader = new static();
 
-        list($name, $date) = explode(': ', $headerLine, 2);
+        list($name, $date) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== strtolower($dateHeader->getFieldName())) {

diff --git a/src/Header/Server.php b/src/Header/Server.php
@@ -20,7 +20,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'server') {

diff --git a/src/Header/SetCookie.php b/src/Header/SetCookie.php
@@ -133,8 +133,7 @@ public static function fromString($headerLine, $bypassHeaderFieldName = false)
             };
         }
 
-        list($name, $value) = explode(':', $headerLine, 2);
-        $value = ltrim($value);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // some sites return set-cookie::value, this is to get rid of the second :
         $name = (strtolower($name) =='set-cookie:') ? 'set-cookie' : $name;

diff --git a/src/Header/TE.php b/src/Header/TE.php
@@ -20,7 +20,7 @@ public static function fromString($headerLine)
     {
         $header = new static();
 
-        list($name, $value) = explode(': ', $headerLine, 2);
+        list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
 
         // check to ensure proper header type for this factory
         if (strtolower($name) !== 'te') {