[mms] Horde_Mime_Headers#parseHeaders() now accepts resources and Hor…

…de_Stream objects.
horde · Mar 5, 2014 · 719482a · 719482a
1 parent a890f1b
commit 719482a
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 12 deletions.
diff --git a/framework/Mime/doc/Horde/Mime/UPGRADING b/framework/Mime/doc/Horde/Mime/UPGRADING
@@ -11,6 +11,16 @@
 This lists the API changes between releases of the package.
 
 
+Upgrading to 2.3
+================
+
+  - Horde_Mime_Headers
+
+    - parseHeaders()
+
+      The $text parameter now accepts both resources and Horde_Stream objects.
+
+
 Upgrading to 2.2
 ================
 

diff --git a/framework/Mime/lib/Horde/Mime/Headers.php b/framework/Mime/lib/Horde/Mime/Headers.php
@@ -632,10 +632,9 @@ protected function _sanityCheck($data)
 
     /**
      * Builds a Horde_Mime_Headers object from header text.
-     * This function can be called statically:
-     *   $headers = Horde_Mime_Headers::parseHeaders().
      *
-     * @param string $text  A text string containing the headers.
+     * @param mixed $text  A text string (or, as of 2.3.0, a Horde_Stream
+     *                     object or stream resource) containing the headers.
      *
      * @return Horde_Mime_Headers  A new Horde_Mime_Headers object.
      */
@@ -645,9 +644,16 @@ static public function parseHeaders($text)
         $mime = self::mimeParamFields();
         $to_process = array();
 
-        foreach (explode("\n", $text) as $val) {
-            $val = rtrim($val, "\r\n");
-            if (empty($val)) {
+        if ($text instanceof Horde_Stream) {
+            $stream = $text;
+            $stream->rewind();
+        } else {
+            $stream = new Horde_Stream_Temp();
+            $stream->add($text, true);
+        }
+
+        while (!$stream->eof()) {
+            if (!($val = rtrim($stream->getToChar("\n", false), "\r"))) {
                 break;
             }
 

diff --git a/framework/Mime/package.xml b/framework/Mime/package.xml
@@ -19,16 +19,16 @@
  </lead>
  <date>2014-02-11</date>
  <version>
-  <release>2.2.10</release>
-  <api>2.2.0</api>
+  <release>2.3.0</release>
+  <api>2.3.0</api>
  </version>
  <stability>
   <release>stable</release>
   <api>stable</api>
  </stability>
  <license uri="http://www.horde.org/licenses/lgpl21">LGPL-2.1</license>
  <notes>
-* 
+* [mms] Horde_Mime_Headers#parseHeaders() now accepts resources and Horde_Stream objects.
  </notes>
  <contents>
   <dir baseinstalldir="/" name="/">
@@ -1257,15 +1257,15 @@
   </release>
   <release>
    <version>
-    <release>2.2.10</release>
-    <api>2.2.0</api></version>
+    <release>2.3.0</release>
+    <api>2.3.0</api></version>
    <stability>
     <release>stable</release>
     <api>stable</api></stability>
    <date>2014-02-10</date>
    <license uri="http://www.horde.org/licenses/lgpl21">LGPL-2.1</license>
    <notes>
-* 
+* [mms] Horde_Mime_Headers#parseHeaders() now accepts resources and Horde_Stream objects.
    </notes>
   </release>
  </changelog>

diff --git a/framework/Mime/test/Horde/Mime/HeadersTest.php b/framework/Mime/test/Horde/Mime/HeadersTest.php
@@ -183,4 +183,23 @@ public function testBug12189()
         $this->assertNotNull($hdrs->getValue('From'));
     }
 
+    public function testParseHeadersGivingStreamResource()
+    {
+        $fp = fopen(__DIR__ . '/fixtures/multiple_to.txt', 'r');
+        $hdrs = Horde_Mime_Headers::parseHeaders($fp);
+        fclose($fp);
+
+        $this->assertNotEmpty($hdrs->getValue('To'));
+    }
+
+    public function testParseHeadersGivingHordeStreamObject()
+    {
+        $stream = new Horde_Stream_Existing(array(
+            'stream' => fopen(__DIR__ . '/fixtures/multiple_to.txt', 'r')
+        ));
+        $hdrs = Horde_Mime_Headers::parseHeaders($stream);
+
+        $this->assertNotEmpty($hdrs->getValue('To'));
+    }
+
 }