Merge branch 'feature/111' into develop

Close #111
Fixes #107

Author: weierophinney

CHANGELOG.md

@@ -16,6 +16,10 @@ All notable changes to this project will be documented in this file, in reverse
   - `filterHeader()`
   The `SapiEmitter` implementation has been updated to remove those methods and
   instead compose the trait.
+- [#111](https://github.com/zendframework/zend-diactoros/pull/111) adds
+  a new emitter implementation, `SapiStreamEmitter`; this emitter type will
+  loop through the stream instead of emitting it in one go, and supports content
+  ranges.
 
 ### Deprecated
 

src/Response/SapiStreamEmitter.php

@@ -0,0 +1,113 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @see       http://github.com/zendframework/zend-diactoros for the canonical source repository
+ * @copyright Copyright (c) 2015 Oscar Otero (http://oscarotero.com) / Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   https://github.com/zendframework/zend-diactoros/blob/master/LICENSE.md New BSD License
+ */
+
+namespace Zend\Diactoros\Response;
+
+use Psr\Http\Message\ResponseInterface;
+use RuntimeException;
+
+class SapiStreamEmitter implements EmitterInterface
+{
+    use SapiEmitterTrait;
+
+    /**
+     * Emits a response for a PHP SAPI environment.
+     *
+     * Emits the status line and headers via the header() function, and the
+     * body content via the output buffer.
+     *
+     * @param ResponseInterface $response
+     * @param int $maxBufferLength Maximum output buffering size for each iteration
+     */
+    public function emit(ResponseInterface $response, $maxBufferLength = 8192)
+    {
+        if (headers_sent()) {
+            throw new RuntimeException('Unable to emit response; headers already sent');
+        }
+
+        $response = $this->injectContentLength($response);
+
+        $this->emitStatusLine($response);
+        $this->emitHeaders($response);
+        $this->flush();
+
+        $range = $this->parseContentRange($response->getHeaderLine('Content-Range'));
+
+        if (is_array($range)) {
+            $this->emitBodyRange($range, $response, $maxBufferLength);
+            return;
+        }
+
+        $this->emitBody($response, $maxBufferLength);
+    }
+
+    /**
+     * Emit the message body.
+     *
+     * @param ResponseInterface $response
+     * @param int $maxBufferLength
+     */
+    private function emitBody(ResponseInterface $response, $maxBufferLength)
+    {
+        $body = $response->getBody();
+        $body->rewind();
+
+        while (! $body->eof()) {
+            echo $body->read($maxBufferLength);
+        }
+    }
+
+    /**
+     * Emit a range of the message body.
+     *
+     * @param array $range
+     * @param ResponseInterface $response
+     * @param int $maxBufferLength
+     */
+    private function emitBodyRange(array $range, ResponseInterface $response, $maxBufferLength)
+    {
+        list($unit, $first, $last, $lenght) = $range;
+
+        ++$last; //zero-based position
+        $body = $response->getBody();
+        $body->seek($first);
+        $pos = $first;
+
+        while (! $body->eof() && $pos < $last) {
+            if (($pos + $maxBufferLength) > $last) {
+                echo $body->read($last - $pos);
+                break;
+            }
+
+            echo $body->read($maxBufferLength);
+            $pos = $body->tell();
+        }
+    }
+
+    /**
+     * Parse content-range header
+     * http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.16
+     *
+     * @param string $header
+     * @return false|array [unit, first, last, length]; returns false if no
+     *     content range or an invalid content range is provided
+     */
+    private function parseContentRange($header)
+    {
+        if (preg_match('/(?P<unit>[\w]+)\s+(?P<first>\d+)-(?P<last>\d+)\/(?P<length>\d+|\*)/', $header, $matches)) {
+            return [
+                $matches['unit'],
+                (int) $matches['first'],
+                (int) $matches['last'],
+                $matches['length'] === '*' ? '*' : (int) $matches['length'],
+            ];
+        }
+        return false;
+    }
+}

test/Response/SapiStreamEmitterTest.php

@@ -0,0 +1,69 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @see       http://github.com/zendframework/zend-diactoros for the canonical source repository
+ * @copyright Copyright (c) 2015 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   https://github.com/zendframework/zend-diactoros/blob/master/LICENSE.md New BSD License
+ */
+
+namespace ZendTest\Diactoros\Response;
+
+use PHPUnit_Framework_TestCase as TestCase;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\StreamInterface;
+use Zend\Diactoros\Response;
+use Zend\Diactoros\Response\SapiStreamEmitter;
+use ZendTest\Diactoros\TestAsset\HeaderStack;
+
+class SapiStreamEmitterTest extends SapiEmitterTest
+{
+    public function setUp()
+    {
+        HeaderStack::reset();
+        $this->emitter = new SapiStreamEmitter();
+    }
+
+    public function testDoesNotInjectContentLengthHeaderIfStreamSizeIsUnknown()
+    {
+        $stream = $this->prophesize('Psr\Http\Message\StreamInterface');
+        $stream->__toString()->willReturn('Content!');
+        $stream->isSeekable()->willReturn(false);
+        $stream->eof()->willReturn(true);
+        $stream->rewind()->willReturn(true);
+        $stream->getSize()->willReturn(null);
+        $response = (new Response())
+            ->withStatus(200)
+            ->withBody($stream->reveal());
+
+        ob_start();
+        $this->emitter->emit($response);
+        ob_end_clean();
+        foreach (HeaderStack::stack() as $header) {
+            $this->assertNotContains('Content-Length:', $header);
+        }
+    }
+
+    public function contentRangeProvider()
+    {
+        return [
+            ['bytes 0-2/*', 'Hello world', 'Hel'],
+            ['bytes 3-6/*', 'Hello world', 'lo w'],
+        ];
+    }
+
+    /**
+     * @dataProvider contentRangeProvider
+     */
+    public function testContentRange($header, $body, $expected)
+    {
+        $response = (new Response())
+            ->withHeader('Content-Range', $header);
+
+        $response->getBody()->write($body);
+
+        ob_start();
+        $this->emitter->emit($response);
+        $this->assertEquals($expected, ob_get_clean());
+    }
+}