Chris@0: <?php
Chris@0: namespace GuzzleHttp\Handler;
Chris@0: 
Chris@0: use GuzzleHttp\Exception\RequestException;
Chris@0: use GuzzleHttp\Exception\ConnectException;
Chris@0: use GuzzleHttp\Promise\FulfilledPromise;
Chris@0: use GuzzleHttp\Promise\PromiseInterface;
Chris@0: use GuzzleHttp\Psr7;
Chris@0: use GuzzleHttp\TransferStats;
Chris@0: use Psr\Http\Message\RequestInterface;
Chris@0: use Psr\Http\Message\ResponseInterface;
Chris@0: use Psr\Http\Message\StreamInterface;
Chris@0: 
Chris@0: /**
Chris@0:  * HTTP handler that uses PHP's HTTP stream wrapper.
Chris@0:  */
Chris@0: class StreamHandler
Chris@0: {
Chris@0:     private $lastHeaders = [];
Chris@0: 
Chris@0:     /**
Chris@0:      * Sends an HTTP request.
Chris@0:      *
Chris@0:      * @param RequestInterface $request Request to send.
Chris@0:      * @param array            $options Request transfer options.
Chris@0:      *
Chris@0:      * @return PromiseInterface
Chris@0:      */
Chris@0:     public function __invoke(RequestInterface $request, array $options)
Chris@0:     {
Chris@0:         // Sleep if there is a delay specified.
Chris@0:         if (isset($options['delay'])) {
Chris@0:             usleep($options['delay'] * 1000);
Chris@0:         }
Chris@0: 
Chris@0:         $startTime = isset($options['on_stats']) ? microtime(true) : null;
Chris@0: 
Chris@0:         try {
Chris@0:             // Does not support the expect header.
Chris@0:             $request = $request->withoutHeader('Expect');
Chris@0: 
Chris@0:             // Append a content-length header if body size is zero to match
Chris@0:             // cURL's behavior.
Chris@0:             if (0 === $request->getBody()->getSize()) {
Chris@0:                 $request = $request->withHeader('Content-Length', 0);
Chris@0:             }
Chris@0: 
Chris@0:             return $this->createResponse(
Chris@0:                 $request,
Chris@0:                 $options,
Chris@0:                 $this->createStream($request, $options),
Chris@0:                 $startTime
Chris@0:             );
Chris@0:         } catch (\InvalidArgumentException $e) {
Chris@0:             throw $e;
Chris@0:         } catch (\Exception $e) {
Chris@0:             // Determine if the error was a networking error.
Chris@0:             $message = $e->getMessage();
Chris@0:             // This list can probably get more comprehensive.
Chris@0:             if (strpos($message, 'getaddrinfo') // DNS lookup failed
Chris@0:                 || strpos($message, 'Connection refused')
Chris@0:                 || strpos($message, "couldn't connect to host") // error on HHVM
Chris@13:                 || strpos($message, "connection attempt failed")
Chris@0:             ) {
Chris@0:                 $e = new ConnectException($e->getMessage(), $request, $e);
Chris@0:             }
Chris@0:             $e = RequestException::wrapException($request, $e);
Chris@0:             $this->invokeStats($options, $request, $startTime, null, $e);
Chris@0: 
Chris@0:             return \GuzzleHttp\Promise\rejection_for($e);
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     private function invokeStats(
Chris@0:         array $options,
Chris@0:         RequestInterface $request,
Chris@0:         $startTime,
Chris@0:         ResponseInterface $response = null,
Chris@0:         $error = null
Chris@0:     ) {
Chris@0:         if (isset($options['on_stats'])) {
Chris@0:             $stats = new TransferStats(
Chris@0:                 $request,
Chris@0:                 $response,
Chris@0:                 microtime(true) - $startTime,
Chris@0:                 $error,
Chris@0:                 []
Chris@0:             );
Chris@0:             call_user_func($options['on_stats'], $stats);
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     private function createResponse(
Chris@0:         RequestInterface $request,
Chris@0:         array $options,
Chris@0:         $stream,
Chris@0:         $startTime
Chris@0:     ) {
Chris@0:         $hdrs = $this->lastHeaders;
Chris@0:         $this->lastHeaders = [];
Chris@0:         $parts = explode(' ', array_shift($hdrs), 3);
Chris@0:         $ver = explode('/', $parts[0])[1];
Chris@0:         $status = $parts[1];
Chris@0:         $reason = isset($parts[2]) ? $parts[2] : null;
Chris@0:         $headers = \GuzzleHttp\headers_from_lines($hdrs);
Chris@13:         list($stream, $headers) = $this->checkDecode($options, $headers, $stream);
Chris@0:         $stream = Psr7\stream_for($stream);
Chris@0:         $sink = $stream;
Chris@0: 
Chris@0:         if (strcasecmp('HEAD', $request->getMethod())) {
Chris@0:             $sink = $this->createSink($stream, $options);
Chris@0:         }
Chris@0: 
Chris@0:         $response = new Psr7\Response($status, $headers, $sink, $ver, $reason);
Chris@0: 
Chris@0:         if (isset($options['on_headers'])) {
Chris@0:             try {
Chris@0:                 $options['on_headers']($response);
Chris@0:             } catch (\Exception $e) {
Chris@0:                 $msg = 'An error was encountered during the on_headers event';
Chris@0:                 $ex = new RequestException($msg, $request, $response, $e);
Chris@0:                 return \GuzzleHttp\Promise\rejection_for($ex);
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         // Do not drain when the request is a HEAD request because they have
Chris@0:         // no body.
Chris@0:         if ($sink !== $stream) {
Chris@0:             $this->drain(
Chris@0:                 $stream,
Chris@0:                 $sink,
Chris@0:                 $response->getHeaderLine('Content-Length')
Chris@0:             );
Chris@0:         }
Chris@0: 
Chris@0:         $this->invokeStats($options, $request, $startTime, $response, null);
Chris@0: 
Chris@0:         return new FulfilledPromise($response);
Chris@0:     }
Chris@0: 
Chris@0:     private function createSink(StreamInterface $stream, array $options)
Chris@0:     {
Chris@0:         if (!empty($options['stream'])) {
Chris@0:             return $stream;
Chris@0:         }
Chris@0: 
Chris@0:         $sink = isset($options['sink'])
Chris@0:             ? $options['sink']
Chris@0:             : fopen('php://temp', 'r+');
Chris@0: 
Chris@0:         return is_string($sink)
Chris@0:             ? new Psr7\LazyOpenStream($sink, 'w+')
Chris@0:             : Psr7\stream_for($sink);
Chris@0:     }
Chris@0: 
Chris@0:     private function checkDecode(array $options, array $headers, $stream)
Chris@0:     {
Chris@0:         // Automatically decode responses when instructed.
Chris@0:         if (!empty($options['decode_content'])) {
Chris@0:             $normalizedKeys = \GuzzleHttp\normalize_header_keys($headers);
Chris@0:             if (isset($normalizedKeys['content-encoding'])) {
Chris@0:                 $encoding = $headers[$normalizedKeys['content-encoding']];
Chris@0:                 if ($encoding[0] === 'gzip' || $encoding[0] === 'deflate') {
Chris@0:                     $stream = new Psr7\InflateStream(
Chris@0:                         Psr7\stream_for($stream)
Chris@0:                     );
Chris@0:                     $headers['x-encoded-content-encoding']
Chris@0:                         = $headers[$normalizedKeys['content-encoding']];
Chris@0:                     // Remove content-encoding header
Chris@0:                     unset($headers[$normalizedKeys['content-encoding']]);
Chris@0:                     // Fix content-length header
Chris@0:                     if (isset($normalizedKeys['content-length'])) {
Chris@0:                         $headers['x-encoded-content-length']
Chris@0:                             = $headers[$normalizedKeys['content-length']];
Chris@0: 
Chris@0:                         $length = (int) $stream->getSize();
Chris@0:                         if ($length === 0) {
Chris@0:                             unset($headers[$normalizedKeys['content-length']]);
Chris@0:                         } else {
Chris@0:                             $headers[$normalizedKeys['content-length']] = [$length];
Chris@0:                         }
Chris@0:                     }
Chris@0:                 }
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         return [$stream, $headers];
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Drains the source stream into the "sink" client option.
Chris@0:      *
Chris@0:      * @param StreamInterface $source
Chris@0:      * @param StreamInterface $sink
Chris@0:      * @param string          $contentLength Header specifying the amount of
Chris@0:      *                                       data to read.
Chris@0:      *
Chris@0:      * @return StreamInterface
Chris@0:      * @throws \RuntimeException when the sink option is invalid.
Chris@0:      */
Chris@0:     private function drain(
Chris@0:         StreamInterface $source,
Chris@0:         StreamInterface $sink,
Chris@0:         $contentLength
Chris@0:     ) {
Chris@0:         // If a content-length header is provided, then stop reading once
Chris@0:         // that number of bytes has been read. This can prevent infinitely
Chris@0:         // reading from a stream when dealing with servers that do not honor
Chris@0:         // Connection: Close headers.
Chris@0:         Psr7\copy_to_stream(
Chris@0:             $source,
Chris@0:             $sink,
Chris@0:             (strlen($contentLength) > 0 && (int) $contentLength > 0) ? (int) $contentLength : -1
Chris@0:         );
Chris@0: 
Chris@0:         $sink->seek(0);
Chris@0:         $source->close();
Chris@0: 
Chris@0:         return $sink;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Create a resource and check to ensure it was created successfully
Chris@0:      *
Chris@0:      * @param callable $callback Callable that returns stream resource
Chris@0:      *
Chris@0:      * @return resource
Chris@0:      * @throws \RuntimeException on error
Chris@0:      */
Chris@0:     private function createResource(callable $callback)
Chris@0:     {
Chris@0:         $errors = null;
Chris@0:         set_error_handler(function ($_, $msg, $file, $line) use (&$errors) {
Chris@0:             $errors[] = [
Chris@0:                 'message' => $msg,
Chris@0:                 'file'    => $file,
Chris@0:                 'line'    => $line
Chris@0:             ];
Chris@0:             return true;
Chris@0:         });
Chris@0: 
Chris@0:         $resource = $callback();
Chris@0:         restore_error_handler();
Chris@0: 
Chris@0:         if (!$resource) {
Chris@0:             $message = 'Error creating resource: ';
Chris@0:             foreach ($errors as $err) {
Chris@0:                 foreach ($err as $key => $value) {
Chris@0:                     $message .= "[$key] $value" . PHP_EOL;
Chris@0:                 }
Chris@0:             }
Chris@0:             throw new \RuntimeException(trim($message));
Chris@0:         }
Chris@0: 
Chris@0:         return $resource;
Chris@0:     }
Chris@0: 
Chris@0:     private function createStream(RequestInterface $request, array $options)
Chris@0:     {
Chris@0:         static $methods;
Chris@0:         if (!$methods) {
Chris@0:             $methods = array_flip(get_class_methods(__CLASS__));
Chris@0:         }
Chris@0: 
Chris@0:         // HTTP/1.1 streams using the PHP stream wrapper require a
Chris@0:         // Connection: close header
Chris@0:         if ($request->getProtocolVersion() == '1.1'
Chris@0:             && !$request->hasHeader('Connection')
Chris@0:         ) {
Chris@0:             $request = $request->withHeader('Connection', 'close');
Chris@0:         }
Chris@0: 
Chris@0:         // Ensure SSL is verified by default
Chris@0:         if (!isset($options['verify'])) {
Chris@0:             $options['verify'] = true;
Chris@0:         }
Chris@0: 
Chris@0:         $params = [];
Chris@13:         $context = $this->getDefaultContext($request);
Chris@0: 
Chris@0:         if (isset($options['on_headers']) && !is_callable($options['on_headers'])) {
Chris@0:             throw new \InvalidArgumentException('on_headers must be callable');
Chris@0:         }
Chris@0: 
Chris@0:         if (!empty($options)) {
Chris@0:             foreach ($options as $key => $value) {
Chris@0:                 $method = "add_{$key}";
Chris@0:                 if (isset($methods[$method])) {
Chris@0:                     $this->{$method}($request, $context, $value, $params);
Chris@0:                 }
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         if (isset($options['stream_context'])) {
Chris@0:             if (!is_array($options['stream_context'])) {
Chris@0:                 throw new \InvalidArgumentException('stream_context must be an array');
Chris@0:             }
Chris@0:             $context = array_replace_recursive(
Chris@0:                 $context,
Chris@0:                 $options['stream_context']
Chris@0:             );
Chris@0:         }
Chris@0: 
Chris@0:         // Microsoft NTLM authentication only supported with curl handler
Chris@0:         if (isset($options['auth'])
Chris@0:             && is_array($options['auth'])
Chris@0:             && isset($options['auth'][2])
Chris@0:             && 'ntlm' == $options['auth'][2]
Chris@0:         ) {
Chris@0:             throw new \InvalidArgumentException('Microsoft NTLM authentication only supported with curl handler');
Chris@0:         }
Chris@0: 
Chris@0:         $uri = $this->resolveHost($request, $options);
Chris@0: 
Chris@0:         $context = $this->createResource(
Chris@0:             function () use ($context, $params) {
Chris@0:                 return stream_context_create($context, $params);
Chris@0:             }
Chris@0:         );
Chris@0: 
Chris@0:         return $this->createResource(
Chris@0:             function () use ($uri, &$http_response_header, $context, $options) {
Chris@0:                 $resource = fopen((string) $uri, 'r', null, $context);
Chris@0:                 $this->lastHeaders = $http_response_header;
Chris@0: 
Chris@0:                 if (isset($options['read_timeout'])) {
Chris@0:                     $readTimeout = $options['read_timeout'];
Chris@0:                     $sec = (int) $readTimeout;
Chris@0:                     $usec = ($readTimeout - $sec) * 100000;
Chris@0:                     stream_set_timeout($resource, $sec, $usec);
Chris@0:                 }
Chris@0: 
Chris@0:                 return $resource;
Chris@0:             }
Chris@0:         );
Chris@0:     }
Chris@0: 
Chris@0:     private function resolveHost(RequestInterface $request, array $options)
Chris@0:     {
Chris@0:         $uri = $request->getUri();
Chris@0: 
Chris@0:         if (isset($options['force_ip_resolve']) && !filter_var($uri->getHost(), FILTER_VALIDATE_IP)) {
Chris@0:             if ('v4' === $options['force_ip_resolve']) {
Chris@0:                 $records = dns_get_record($uri->getHost(), DNS_A);
Chris@0:                 if (!isset($records[0]['ip'])) {
Chris@0:                     throw new ConnectException(sprintf("Could not resolve IPv4 address for host '%s'", $uri->getHost()), $request);
Chris@0:                 }
Chris@0:                 $uri = $uri->withHost($records[0]['ip']);
Chris@0:             } elseif ('v6' === $options['force_ip_resolve']) {
Chris@0:                 $records = dns_get_record($uri->getHost(), DNS_AAAA);
Chris@0:                 if (!isset($records[0]['ipv6'])) {
Chris@0:                     throw new ConnectException(sprintf("Could not resolve IPv6 address for host '%s'", $uri->getHost()), $request);
Chris@0:                 }
Chris@0:                 $uri = $uri->withHost('[' . $records[0]['ipv6'] . ']');
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         return $uri;
Chris@0:     }
Chris@0: 
Chris@0:     private function getDefaultContext(RequestInterface $request)
Chris@0:     {
Chris@0:         $headers = '';
Chris@0:         foreach ($request->getHeaders() as $name => $value) {
Chris@0:             foreach ($value as $val) {
Chris@0:                 $headers .= "$name: $val\r\n";
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         $context = [
Chris@0:             'http' => [
Chris@0:                 'method'           => $request->getMethod(),
Chris@0:                 'header'           => $headers,
Chris@0:                 'protocol_version' => $request->getProtocolVersion(),
Chris@0:                 'ignore_errors'    => true,
Chris@0:                 'follow_location'  => 0,
Chris@0:             ],
Chris@0:         ];
Chris@0: 
Chris@0:         $body = (string) $request->getBody();
Chris@0: 
Chris@0:         if (!empty($body)) {
Chris@0:             $context['http']['content'] = $body;
Chris@0:             // Prevent the HTTP handler from adding a Content-Type header.
Chris@0:             if (!$request->hasHeader('Content-Type')) {
Chris@0:                 $context['http']['header'] .= "Content-Type:\r\n";
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         $context['http']['header'] = rtrim($context['http']['header']);
Chris@0: 
Chris@0:         return $context;
Chris@0:     }
Chris@0: 
Chris@0:     private function add_proxy(RequestInterface $request, &$options, $value, &$params)
Chris@0:     {
Chris@0:         if (!is_array($value)) {
Chris@0:             $options['http']['proxy'] = $value;
Chris@0:         } else {
Chris@0:             $scheme = $request->getUri()->getScheme();
Chris@0:             if (isset($value[$scheme])) {
Chris@0:                 if (!isset($value['no'])
Chris@0:                     || !\GuzzleHttp\is_host_in_noproxy(
Chris@0:                         $request->getUri()->getHost(),
Chris@0:                         $value['no']
Chris@0:                     )
Chris@0:                 ) {
Chris@0:                     $options['http']['proxy'] = $value[$scheme];
Chris@0:                 }
Chris@0:             }
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     private function add_timeout(RequestInterface $request, &$options, $value, &$params)
Chris@0:     {
Chris@0:         if ($value > 0) {
Chris@0:             $options['http']['timeout'] = $value;
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     private function add_verify(RequestInterface $request, &$options, $value, &$params)
Chris@0:     {
Chris@0:         if ($value === true) {
Chris@0:             // PHP 5.6 or greater will find the system cert by default. When
Chris@0:             // < 5.6, use the Guzzle bundled cacert.
Chris@0:             if (PHP_VERSION_ID < 50600) {
Chris@0:                 $options['ssl']['cafile'] = \GuzzleHttp\default_ca_bundle();
Chris@0:             }
Chris@0:         } elseif (is_string($value)) {
Chris@0:             $options['ssl']['cafile'] = $value;
Chris@0:             if (!file_exists($value)) {
Chris@0:                 throw new \RuntimeException("SSL CA bundle not found: $value");
Chris@0:             }
Chris@0:         } elseif ($value === false) {
Chris@0:             $options['ssl']['verify_peer'] = false;
Chris@0:             $options['ssl']['verify_peer_name'] = false;
Chris@0:             return;
Chris@0:         } else {
Chris@0:             throw new \InvalidArgumentException('Invalid verify request option');
Chris@0:         }
Chris@0: 
Chris@0:         $options['ssl']['verify_peer'] = true;
Chris@0:         $options['ssl']['verify_peer_name'] = true;
Chris@0:         $options['ssl']['allow_self_signed'] = false;
Chris@0:     }
Chris@0: 
Chris@0:     private function add_cert(RequestInterface $request, &$options, $value, &$params)
Chris@0:     {
Chris@0:         if (is_array($value)) {
Chris@0:             $options['ssl']['passphrase'] = $value[1];
Chris@0:             $value = $value[0];
Chris@0:         }
Chris@0: 
Chris@0:         if (!file_exists($value)) {
Chris@0:             throw new \RuntimeException("SSL certificate not found: {$value}");
Chris@0:         }
Chris@0: 
Chris@0:         $options['ssl']['local_cert'] = $value;
Chris@0:     }
Chris@0: 
Chris@0:     private function add_progress(RequestInterface $request, &$options, $value, &$params)
Chris@0:     {
Chris@0:         $this->addNotification(
Chris@0:             $params,
Chris@0:             function ($code, $a, $b, $c, $transferred, $total) use ($value) {
Chris@0:                 if ($code == STREAM_NOTIFY_PROGRESS) {
Chris@0:                     $value($total, $transferred, null, null);
Chris@0:                 }
Chris@0:             }
Chris@0:         );
Chris@0:     }
Chris@0: 
Chris@0:     private function add_debug(RequestInterface $request, &$options, $value, &$params)
Chris@0:     {
Chris@0:         if ($value === false) {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         static $map = [
Chris@0:             STREAM_NOTIFY_CONNECT       => 'CONNECT',
Chris@0:             STREAM_NOTIFY_AUTH_REQUIRED => 'AUTH_REQUIRED',
Chris@0:             STREAM_NOTIFY_AUTH_RESULT   => 'AUTH_RESULT',
Chris@0:             STREAM_NOTIFY_MIME_TYPE_IS  => 'MIME_TYPE_IS',
Chris@0:             STREAM_NOTIFY_FILE_SIZE_IS  => 'FILE_SIZE_IS',
Chris@0:             STREAM_NOTIFY_REDIRECTED    => 'REDIRECTED',
Chris@0:             STREAM_NOTIFY_PROGRESS      => 'PROGRESS',
Chris@0:             STREAM_NOTIFY_FAILURE       => 'FAILURE',
Chris@0:             STREAM_NOTIFY_COMPLETED     => 'COMPLETED',
Chris@0:             STREAM_NOTIFY_RESOLVE       => 'RESOLVE',
Chris@0:         ];
Chris@0:         static $args = ['severity', 'message', 'message_code',
Chris@0:             'bytes_transferred', 'bytes_max'];
Chris@0: 
Chris@0:         $value = \GuzzleHttp\debug_resource($value);
Chris@0:         $ident = $request->getMethod() . ' ' . $request->getUri()->withFragment('');
Chris@0:         $this->addNotification(
Chris@0:             $params,
Chris@0:             function () use ($ident, $value, $map, $args) {
Chris@0:                 $passed = func_get_args();
Chris@0:                 $code = array_shift($passed);
Chris@0:                 fprintf($value, '<%s> [%s] ', $ident, $map[$code]);
Chris@0:                 foreach (array_filter($passed) as $i => $v) {
Chris@0:                     fwrite($value, $args[$i] . ': "' . $v . '" ');
Chris@0:                 }
Chris@0:                 fwrite($value, "\n");
Chris@0:             }
Chris@0:         );
Chris@0:     }
Chris@0: 
Chris@0:     private function addNotification(array &$params, callable $notify)
Chris@0:     {
Chris@0:         // Wrap the existing function if needed.
Chris@0:         if (!isset($params['notification'])) {
Chris@0:             $params['notification'] = $notify;
Chris@0:         } else {
Chris@0:             $params['notification'] = $this->callArray([
Chris@0:                 $params['notification'],
Chris@0:                 $notify
Chris@0:             ]);
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     private function callArray(array $functions)
Chris@0:     {
Chris@0:         return function () use ($functions) {
Chris@0:             $args = func_get_args();
Chris@0:             foreach ($functions as $fn) {
Chris@0:                 call_user_func_array($fn, $args);
Chris@0:             }
Chris@0:         };
Chris@0:     }
Chris@0: }