[output-stream] Refactor StreamingResponse implementation to use an O…

…utputStream
symfony · igorw · Jan 15, 2012 · Jul 11, 2012 · Jul 11, 2012 · Jul 11, 2012
commit a2f32a9fc555ea0d2aef80d3c52cd5ef17935a0e
diff --git a/src/Symfony/Bundle/FrameworkBundle/HttpKernel.php b/src/Symfony/Bundle/FrameworkBundle/HttpKernel.php
@@ -169,7 +169,11 @@ public function render($controller, array $options = array())
                 return $response->getContent();
             }
 
+            $outputStream = $this->container->get('kernel.output_stream');
+
+            $response->setOutputStream($outputStream);
             $response->sendContent();
+            $outputStream->close();
         } catch (\Exception $e) {
             if ($options['alt']) {
                 $alt = $options['alt'];

diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/services.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/services.xml
@@ -11,6 +11,7 @@
         <parameter key="cache_warmer.class">Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerAggregate</parameter>
         <parameter key="cache_clearer.class">Symfony\Component\HttpKernel\CacheClearer\ChainCacheClearer</parameter>
         <parameter key="file_locator.class">Symfony\Component\HttpKernel\Config\FileLocator</parameter>
+        <parameter key="kernel.output_stream.class">Symfony\Component\HttpFoundation\OutputStream\StreamOutputStream</parameter>
     </parameters>
 
     <services>
@@ -51,5 +52,9 @@
             <argument type="service" id="kernel" />
             <argument>%kernel.root_dir%/Resources</argument>
         </service>
+
+        <service id="kernel.output_stream" class="%kernel.output_stream.class%" factory-class="%kernel.output_stream.class%" factory-method="create">
+            <argument>php://output</argument>
+        </service>
     </services>
 </container>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/web.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/web.xml
@@ -32,6 +32,7 @@
 
         <service id="streamed_response_listener" class="%streamed_response_listener.class%">
             <tag name="kernel.event_subscriber" />
+            <argument type="service" id="kernel.output_stream" />
         </service>
 
         <service id="locale_listener" class="%locale_listener.class%">

diff --git a/src/Symfony/Component/HttpFoundation/OutputStream/OutputStreamInterface.php b/src/Symfony/Component/HttpFoundation/OutputStream/OutputStreamInterface.php
@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\HttpFoundation\OutputStream;
+
+/**
+ * OutputStreamInterface defines how streaming responses
+ * send data to the client.
+ *
+ * @author Igor Wiedler <igor@wiedler.ch>
+ */
+interface OutputStreamInterface
+{
+    /**
+     * Write some data to the stream.
+     *
+     * @param string $data The data to write
+     */
+    function write($data);
+
+    /**
+     * Close the stream.
+     *
+     * This should be called after the sending of data
+     * has been completed. In case of persistent connections,
+     * it is never called.
+     */
+    function close();
+}
diff --git a/src/Symfony/Component/HttpFoundation/OutputStream/StreamOutputStream.php b/src/Symfony/Component/HttpFoundation/OutputStream/StreamOutputStream.php
@@ -0,0 +1,69 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\HttpFoundation\OutputStream;
+
+/**
+ * StreamOutputStream is an implementation of the OutputStreamInterface
+ * that uses any writable PHP stream as a target.
+ *
+ * Example usage:
+ *
+ * $stream = fopen('php://output');
+ * $output = new StreamOutputStream($stream, 'w');
+ * $output->write('foo');
+ * $output->write('bar');
+ * $output->close();
+ *
+ * @author Igor Wiedler <igor@wiedler.ch>
+ */
+class StreamOutputStream implements OutputStreamInterface
+{
+    private $stream;
+
+    /**
+     * @param resource $stream A valid stream resource, such as the return value of
+     *                     a fopen() call.
+     */
+    public function __construct($stream)
+    {
+        if (!is_resource($stream)) {
+            throw new \InvalidArgumentException('The supplied stream is invalid.');
+        }
+
+        $this->stream = $stream;
+    }
+
+    /**
+     * @{inheritdoc}
+     */
+    public function write($data)
+    {
+        fwrite($this->stream, $data);
+    }
+
+    /**
+     * @{inheritdoc}
+     */
+    public function close()
+    {
+        fclose($this->stream);
+    }
+
+    /**
+     * Static factory method
+     */
+    static public function create($filename)
+    {
+        $stream = fopen($filename, 'w');
+        return new static($stream);
+    }
+}
diff --git a/src/Symfony/Component/HttpFoundation/StreamedResponse.php b/src/Symfony/Component/HttpFoundation/StreamedResponse.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\HttpFoundation;
 
+use Symfony\Component\HttpFoundation\OutputStream\OutputStreamInterface;
+
 /**
  * StreamedResponse represents a streamed HTTP response.
  *
@@ -29,6 +31,7 @@
 class StreamedResponse extends Response
 {
     protected $callback;
+    protected $outputStream;
     protected $streamed;
 
     /**
@@ -71,6 +74,16 @@ public function setCallback($callback)
         $this->callback = $callback;
     }
 
+    /**
+     * Sets the output stream used for streaming the response.
+     *
+     * @param OutputStreamInterface $outputStream stream
+     */
+    public function setOutputStream(OutputStreamInterface $outputStream)
+    {
+        $this->outputStream = $outputStream;
+    }
+
     /**
      * @{inheritdoc}
      */
@@ -102,7 +115,11 @@ public function sendContent()
             throw new \LogicException('The Response callback must not be null.');
         }
 
-        call_user_func($this->callback);
+        if (null === $this->outputStream) {
+            throw new \LogicException('The Response output stream must not be null.');
+        }
+
+        call_user_func($this->callback, $this->outputStream);
     }
 
     /**

diff --git a/src/Symfony/Component/HttpFoundation/Tests/OutputStream/OutputStreamTest.php b/src/Symfony/Component/HttpFoundation/Tests/OutputStream/OutputStreamTest.php
@@ -0,0 +1,55 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\HttpFoundation\Tests\OutputStream;
+
+use Symfony\Component\HttpFoundation\OutputStream\StreamOutputStream;
+
+class OutputStreamTest extends \PHPUnit_Framework_TestCase
+{
+    public function testConstructor()
+    {
+        $fp = fopen('php://memory', 'rw');
+        $output = new StreamOutputStream($fp);
+    }
+
+    /**
+     * @expectedException InvalidArgumentException
+     */
+    public function testConstructorWithInvalidStream()
+    {
+        $fp = 'foobar';
+        $output = new StreamOutputStream($fp);
+    }
+
+    public function testWrite()
+    {
+        $fp = fopen('php://memory', 'rw');
+        $output = new StreamOutputStream($fp);
+
+        $output->write('sample output');
+        rewind($fp);
+        $this->assertEquals('sample output', fread($fp, 50));
+    }
+
+    public function testClose()
+    {
+        $fp = fopen('php://memory', 'rw');
+        $output = new StreamOutputStream($fp);
+
+        $output->close();
+        try {
+            fread($fp, 1);
+            $this->fail();
+        } catch (\PHPUnit_Framework_Error_Warning $e) {
+        }
+    }
+}
diff --git a/src/Symfony/Component/HttpFoundation/Tests/StreamedResponseTest.php b/src/Symfony/Component/HttpFoundation/Tests/StreamedResponseTest.php
@@ -13,6 +13,7 @@
 
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\StreamedResponse;
+use Symfony\Component\HttpFoundation\OutputStream\OutputStreamInterface;
 
 class StreamedResponseTest extends \PHPUnit_Framework_TestCase
 {
@@ -55,6 +56,7 @@ public function testSendContent()
         $called = 0;
 
         $response = new StreamedResponse(function () use (&$called) { ++$called; });
+        $response->setOutputStream($this->getOutputStreamMock());
 
         $response->sendContent();
         $this->assertEquals(1, $called);
@@ -63,12 +65,34 @@ public function testSendContent()
         $this->assertEquals(1, $called);
     }
 
+    public function testSendContentUsesOutputStream()
+    {
+        $output = $this->getOutputStreamMock();
+        $output->expects($this->once())
+            ->method('write')
+            ->with('foo');
+
+        $response = new StreamedResponse(function ($output) { $output->write('foo'); });
+        $response->setOutputStream($output);
+        $response->sendContent();
+    }
+
     /**
      * @expectedException \LogicException
      */
     public function testSendContentWithNonCallable()
     {
         $response = new StreamedResponse('foobar');
+        $response->setOutputStream($this->getOutputStreamMock());
+        $response->sendContent();
+    }
+
+    /**
+     * @expectedException \LogicException
+     */
+    public function testSendContentWithNoOutputStream()
+    {
+        $response = new StreamedResponse(function () {});
         $response->sendContent();
     }
 
@@ -94,4 +118,9 @@ public function testCreate()
         $this->assertInstanceOf('Symfony\Component\HttpFoundation\StreamedResponse', $response);
         $this->assertEquals(204, $response->getStatusCode());
     }
+
+    private function getOutputStreamMock()
+    {
+        return $this->getMock('Symfony\Component\HttpFoundation\OutputStream\OutputStreamInterface');
+    }
 }
diff --git a/src/Symfony/Component/HttpKernel/EventListener/StreamedResponseListener.php b/src/Symfony/Component/HttpKernel/EventListener/StreamedResponseListener.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\HttpKernel\EventListener;
 
 use Symfony\Component\HttpFoundation\StreamedResponse;
+use Symfony\Component\HttpFoundation\OutputStream\OutputStreamInterface;
 use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
 use Symfony\Component\HttpKernel\KernelEvents;
@@ -25,6 +26,11 @@
  */
 class StreamedResponseListener implements EventSubscriberInterface
 {
+    public function __construct(OutputStreamInterface $outputStream)
+    {
+        $this->outputStream = $outputStream;
+    }
+
     /**
      * Filters the Response.
      *
@@ -39,6 +45,7 @@ public function onKernelResponse(FilterResponseEvent $event)
         $response = $event->getResponse();
 
         if ($response instanceof StreamedResponse) {
+            $response->setOutputStream($this->outputStream);
             $response->send();
         }
     }