Add Message cloner

spec/MessageClonerSpec.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace spec\Http\Message;
+
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+use Psr\Http\Message\MessageInterface;
+use spec\Http\Message\Encoding\MemoryStream;
+
+class MessageClonerSpec extends ObjectBehavior
+{
+    public function it_is_initializable()
+    {
+        $this->shouldHaveType('Http\Message\MessageCloner');
+    }
+
+    public function it_clone_a_message(MessageInterface $message, MessageInterface $messageCloned)
+    {
+        $stream = new MemoryStream('test');
+        $message->getBody()->willReturn($stream);
+        $message->withBody(Argument::type('Http\Message\MemoryClonedStream'))->willReturn($messageCloned);
+
+        $this->cloneMessage($message)->shouldEqual($messageCloned);
+    }
+}

src/MemoryClonedStream.php

@@ -0,0 +1,182 @@
+<?php
+
+namespace Http\Message;
+
+use Psr\Http\Message\StreamInterface;
+
+/**
+ * Represent a stream cloned into memory.
+ */
+class MemoryClonedStream implements StreamInterface
+{
+    const COPY_BUFFER = 8192;
+
+    private $resource;
+
+    private $size;
+
+    /**
+     * @param StreamInterface $stream        Stream to clone
+     * @param bool            $useFileBuffer Use a file buffer to avoid memory consumption on PHP script (default to true)
+     * @param int             $memoryBuffer  The amount of memory of which the stream is buffer into a file when setting
+     *                                       $useFileBuffer to true (default to 2MB)
+     */
+    public function __construct(StreamInterface $stream, $useFileBuffer = true, $memoryBuffer = 2097152)
+    {
+        $this->size = 0;
+
+        if ($useFileBuffer) {
+            $this->resource = fopen('php://temp/maxmemory:'.$memoryBuffer, 'rw+');
+        } else {
+            $this->resource = fopen('php://memory', 'rw+');
+        }
+
+        $position = null;
+
+        if ($stream->isSeekable()) {
+            $position = $stream->tell();
+            $stream->rewind();
+        }
+
+        while (!$stream->eof()) {
+            $this->size += fwrite($this->resource, $stream->read(self::COPY_BUFFER));
+        }
+
+        if ($stream->isSeekable()) {
+            $stream->seek($position);
+        }
+
+        rewind($this->resource);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function __toString()
+    {
+        return $this->getContents();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function close()
+    {
+        fclose($this->resource);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function detach()
+    {
+        $resource = $this->resource;
+        $this->resource = null;
+
+        return $resource;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getSize()
+    {
+        return $this->size;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function tell()
+    {
+        return ftell($this->resource);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function eof()
+    {
+        return feof($this->resource);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isSeekable()
+    {
+        return true;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function seek($offset, $whence = SEEK_SET)
+    {
+        return fseek($this->resource, $offset);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function rewind()
+    {
+        return rewind($this->resource);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isWritable()
+    {
+        return true;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function write($string)
+    {
+        return fwrite($this->resource, $string);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isReadable()
+    {
+        return true;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function read($length)
+    {
+        return fread($this->resource, $length);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getContents()
+    {
+        $this->rewind();
+
+        return $this->read($this->size);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getMetadata($key = null)
+    {
+        $metadata = stream_get_meta_data($this->resource);
+
+        if (null === $key) {
+            return $metadata;
+        }
+
+        return $metadata[$key];
+    }
+}

src/MessageCloner.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Http\Message;
+
+use Psr\Http\Message\MessageInterface;
+
+/**
+ * Allow to clone request and response.
+ *
+ * A message cloner is only necessary when you also want to duplicate the stream of a request or a response, as by
+ * default object returned by `clone $message` call will have the same stream as the cloned one, so reading the body of
+ * one of the message will affect the other.
+ */
+class MessageCloner
+{
+    /**
+     * Clone a message.
+     *
+     * When cloning you have to be careful that the original stream is rewindable. If not the original stream will be
+     * readed and cannot be readed one more time. To avoid this behavior, when the original stream is not seekable, you
+     * can clone the cloned message, and replace the original message with one of the clone, as there are always rewindable.
+     *
+     * @param MessageInterface $message
+     *
+     * @return MessageInterface|static
+     */
+    public function cloneMessage(MessageInterface $message)
+    {
+        return $message->withBody(new MemoryClonedStream($message->getBody()));
+    }
+}