From c8d7183187e86ac7fdbe7bbaa4310312cdf9ac0e Mon Sep 17 00:00:00 2001
From: Michael Dowling <mtdowling@gmail.com>
Date: Sun, 3 Mar 2013 20:04:06 -0800
Subject: [PATCH] Adding a way to create PHP streams based on request objects

---
 src/Guzzle/Stream/PhpStreamRequestFactory.php | 163 ++++++++++++++++++
 .../Stream/StreamRequestFactoryInterface.php  |  22 +++
 src/Guzzle/Stream/composer.json               |   3 +-
 3 files changed, 187 insertions(+), 1 deletion(-)
 create mode 100644 src/Guzzle/Stream/PhpStreamRequestFactory.php
 create mode 100644 src/Guzzle/Stream/StreamRequestFactoryInterface.php

diff --git a/src/Guzzle/Stream/PhpStreamRequestFactory.php b/src/Guzzle/Stream/PhpStreamRequestFactory.php
new file mode 100644
index 00000000..bfb806ac
--- /dev/null
+++ b/src/Guzzle/Stream/PhpStreamRequestFactory.php
@@ -0,0 +1,163 @@
+<?php
+
+namespace Guzzle\Stream;
+
+use Guzzle\Common\Exception\RuntimeException;
+use Guzzle\Http\Message\EntityEnclosingRequestInterface;
+use Guzzle\Http\Message\RequestInterface;
+use Guzzle\Http\Url;
+
+/**
+ * Factory used to create fopen streams using PHP's http and https stream wrappers
+ */
+class PhpStreamRequestFactory implements StreamRequestFactoryInterface
+{
+    /**
+     * @var array Stream context
+     */
+    protected $context;
+
+    /**
+     * @var Url Stream URL
+     */
+    protected $url;
+
+    /**
+     * {@inheritdoc}
+     */
+    public function fromRequest(RequestInterface $request, array $contextOptions = null)
+    {
+        // Add default HTTP context options
+        $this->createDefaultContext($request);
+
+        // Use the request's URL
+        $this->setUrl($request);
+
+        // Add SSL options if needed
+        if ($request->getScheme() == 'https') {
+            $this->addSslOptions($request);
+        }
+
+        // Add the content for the request if needed
+        if ($request instanceof EntityEnclosingRequestInterface) {
+            $this->addBodyOptions($request);
+        }
+
+        // Merge in custom context options
+        if ($contextOptions) {
+            $this->mergeContextOptions($contextOptions);
+        }
+
+        // Create the file handle but silence errors
+        return $this->createStream();
+    }
+
+    /**
+     * Adds the default context options to the stream context options
+     *
+     * @param RequestInterface $request Request
+     */
+    protected function createDefaultContext(RequestInterface $request)
+    {
+        $this->context = array(
+            'http' => array(
+                'method'           => $request->getMethod(),
+                'header'           => $request->getHeaderLines(),
+                'protocol_version' => '1.0',
+                'ignore_errors'    => '1'
+            )
+        );
+    }
+
+    /**
+     * Set the URL to use with the factory
+     *
+     * @param RequestInterface $request Request that owns the URL
+     */
+    protected function setUrl(RequestInterface $request)
+    {
+        $this->url = $request->getUrl(true);
+
+        // Check for basic Auth username
+        if ($request->getUsername()) {
+            $this->url->setUsername($request->getUsername());
+        }
+
+        // Check for basic Auth password
+        if ($request->getPassword()) {
+            $this->url->setPassword($request->getPassword());
+        }
+    }
+
+    /**
+     * Add SSL options to the stream context
+     *
+     * @param RequestInterface $request Request
+     */
+    protected function addSslOptions(RequestInterface $request)
+    {
+        if ($verify = $request->getCurlOptions()->get(CURLOPT_SSL_VERIFYPEER)) {
+            $this->context['ssl']['verify_peer'] = true;
+        }
+
+        if ($cafile = $request->getCurlOptions()->get(CURLOPT_CAINFO)) {
+            $this->context['ssl']['cafile'] = $cafile;
+        }
+    }
+
+    /**
+     * Add body (content) specific options to the context options
+     *
+     * @param EntityEnclosingRequestInterface $request
+     */
+    protected function addBodyOptions(EntityEnclosingRequestInterface $request)
+    {
+        if ($request->getPostFields()) {
+            $this->context['http']['content'] = (string) $request->getPostFields();
+        } elseif ($request->getBody()) {
+            $this->context['http']['content'] = (string) $request->getBody();
+        }
+        if ($this->context['http']['content']) {
+            $this->context['http']['header'][] = 'Content-Length: ' . strlen($this->context['http']['content']);
+        }
+    }
+
+    /**
+     * Merge custom context options into the default context options
+     *
+     * @param array $contextOptions Context options
+     */
+    protected function mergeContextOptions(array $contextOptions)
+    {
+        foreach ($contextOptions as $wrapper => $options) {
+            if (!isset($this->context[$wrapper])) {
+                $this->context[$wrapper] = array();
+            }
+            if (is_array($options)) {
+                foreach ($options as $optionName => $optionValue) {
+                    $this->context[$wrapper][$optionName] = $optionValue;
+                }
+            }
+        }
+    }
+
+    /**
+     * Create the stream for the request with the context options
+     *
+     * @return resource
+     * @throws RuntimeException If an error occurs
+     */
+    protected function createStream()
+    {
+        $level = error_reporting(0);
+        $fp = fopen((string) $this->url, 'r', false, stream_context_create($this->context));
+        error_reporting($level);
+        if (false === $fp) {
+            // If the file could not be created, then grab the last error and throw an exception
+            $error = error_get_last();
+            throw new RuntimeException($error['message']);
+        }
+
+        return $fp;
+    }
+}
diff --git a/src/Guzzle/Stream/StreamRequestFactoryInterface.php b/src/Guzzle/Stream/StreamRequestFactoryInterface.php
new file mode 100644
index 00000000..7b51e408
--- /dev/null
+++ b/src/Guzzle/Stream/StreamRequestFactoryInterface.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace Guzzle\Stream;
+
+use Guzzle\Http\Message\RequestInterface;
+
+/**
+ * Interface used for creating streams from requests
+ */
+interface StreamRequestFactoryInterface
+{
+    /**
+     * Create a stream based on a request object
+     *
+     * @param RequestInterface $request        Base the stream on a request
+     * @param array            $contextOptions Custom context options to merge into the default context options
+     *
+     * @return resource Returns a stream resource that can be used like fopen resources
+     * @throws \Guzzle\Common\Exception\RuntimeException if the stream cannot be opened or an error occurs
+     */
+    public function fromRequest(RequestInterface $request, array $contextOptions = null);
+}
diff --git a/src/Guzzle/Stream/composer.json b/src/Guzzle/Stream/composer.json
index f19a54f7..4fc3d7e8 100644
--- a/src/Guzzle/Stream/composer.json
+++ b/src/Guzzle/Stream/composer.json
@@ -13,7 +13,8 @@
     ],
     "require": {
         "php": ">=5.3.2",
-        "guzzle/common": "self.version"
+        "guzzle/common": "self.version",
+        "guzzle/http": "self.version"
     },
     "autoload": {
         "psr-0": { "Guzzle\\Stream": "" }