🛀

Author: codemasher

src/ClientException.php

@@ -13,8 +13,5 @@
 namespace chillerlan\HTTP;
 
 use Psr\Http\Client\ClientExceptionInterface;
-use Exception;
 
-class ClientException extends Exception implements ClientExceptionInterface{
-
-}
+class ClientException extends \Exception implements ClientExceptionInterface{}

src/CurlClient.php

@@ -69,7 +69,8 @@ public function __construct(
 	 * @throws \Exception                                If processing the request is impossible (eg. bad configuration).
 	 */
 	public function sendRequest(RequestInterface $request):ResponseInterface{
-		$handle = new CurlHandle($request, $this->responseFactory->createResponse(), $this->options);
+		/** @var \chillerlan\HTTP\CurlHandle $handle */
+		$handle = new $this->options->curlHandle($request, $this->responseFactory->createResponse(), $this->options);
 		$handle->init();
 
 		curl_exec($handle->curl);

src/CurlHandle.php

@@ -93,25 +93,22 @@ public function reset():void{
 	}
 
 	/**
-	 * @return \Psr\Http\Message\ResponseInterface
+	 * @return array
 	 */
-	public function init(){
-
-		$v = $this->request->getProtocolVersion();
+	protected function initCurlOptions():array{
 
-		switch($v){
-			case '1.0': $v = CURL_HTTP_VERSION_1_0; break;
-			case '1.1': $v = CURL_HTTP_VERSION_1_1; break;
-			case '2.0': $v = CURL_HTTP_VERSION_2_0; break;
-			default:    $v = CURL_HTTP_VERSION_NONE;
-		}
+		$v = [
+			'1.0' => CURL_HTTP_VERSION_1_0,
+			'1.1' => CURL_HTTP_VERSION_1_1,
+			'2.0' => CURL_HTTP_VERSION_2_0,
+		];
 
-		$options = [
+		return [
 			CURLOPT_HEADER         => false,
 			CURLOPT_RETURNTRANSFER => false,
 			CURLOPT_FOLLOWLOCATION => false,
 			CURLOPT_URL            => (string)$this->request->getUri()->withFragment(''),
-			CURLOPT_HTTP_VERSION   => $v,
+			CURLOPT_HTTP_VERSION   => $v[$this->request->getProtocolVersion()] ?? CURL_HTTP_VERSION_NONE,
 			CURLOPT_USERAGENT      => $this->options->user_agent,
 			CURLOPT_PROTOCOLS      => CURLPROTO_HTTP | CURLPROTO_HTTPS,
 			CURLOPT_SSL_VERIFYPEER => true,
@@ -122,59 +119,50 @@ public function init(){
 			CURLOPT_WRITEFUNCTION  => [$this, 'writefunction'],
 			CURLOPT_HEADERFUNCTION => [$this, 'headerfunction'],
 		];
+	}
 
-		$userinfo = $this->request->getUri()->getUserInfo();
-
-		if(!empty($userinfo)){
-			$options[CURLOPT_USERPWD] = $userinfo;
-		}
-
-		/*
-		 * Some HTTP methods cannot have payload:
-		 *
-		 * - GET   — cURL will automatically change method to PUT or POST
-		 *           if we set CURLOPT_UPLOAD or CURLOPT_POSTFIELDS.
-		 * - HEAD  — cURL treats HEAD as GET request with a same restrictions.
-		 * - TRACE — According to RFC7231: a client MUST NOT send a message body in a TRACE request.
-		 */
-		$method   = $this->request->getMethod();
+	/**
+	 * @param array $options
+	 *
+	 * @return void
+	 */
+	protected function setBodyOptions(array &$options):void{
 		$body     = $this->request->getBody();
 		$bodySize = $body->getSize();
 
-		if(in_array($method, ['DELETE', 'PATCH', 'POST', 'PUT'], true) && $bodySize !== 0){
-
-			if($body->isSeekable()){
-				$body->rewind();
-			}
+		if($bodySize === 0){
+			return;
+		}
 
-			// Message has non empty body.
-			if($bodySize === null || $bodySize > 1 << 20){
-				// Avoid full loading large or unknown size body into memory
-				$options[CURLOPT_UPLOAD] = true;
+		if($body->isSeekable()){
+			$body->rewind();
+		}
 
-				if($bodySize !== null){
-					$options[CURLOPT_INFILESIZE] = $bodySize;
-				}
+		// Message has non empty body.
+		if($bodySize === null || $bodySize > 1 << 20){
+			// Avoid full loading large or unknown size body into memory
+			$options[CURLOPT_UPLOAD] = true;
 
-				$options[CURLOPT_READFUNCTION] = [$this, 'readfunction'];
-			}
-			// Small body can be loaded into memory
-			else{
-				$options[CURLOPT_POSTFIELDS] = (string)$body;
+			if($bodySize !== null){
+				$options[CURLOPT_INFILESIZE] = $bodySize;
 			}
 
+			$options[CURLOPT_READFUNCTION] = [$this, 'readfunction'];
 		}
-
-		// This will set HTTP method to "HEAD".
-		if($method === 'HEAD'){
-			$options[CURLOPT_NOBODY] = true;
-		}
-		// GET is a default method. Other methods should be specified explicitly.
-		elseif($method !== 'GET'){
-			$options[CURLOPT_CUSTOMREQUEST] = $method;
+		// Small body can be loaded into memory
+		else{
+			$options[CURLOPT_POSTFIELDS] = (string)$body;
 		}
 
-		$curlHeaders = [];
+	}
+
+	/**
+	 * @param array $options
+	 *
+	 * @return array
+	 */
+	protected function initCurlHeaders(array $options):array{
+		$headers = [];
 
 		foreach($this->request->getHeaders() as $name => $values){
 			$header = strtolower($name);
@@ -202,22 +190,59 @@ public function init(){
 
 				// cURL requires a special format for empty headers.
 				// See https://github.com/guzzle/guzzle/issues/1882 for more details.
-				$curlHeaders[] = $value === ''
-					? $name.';'
-					: $name.': '.$value;
+				$headers[] = $value === '' ? $name.';' : $name.': '.$value;
 			}
 
 		}
 
-		$options[CURLOPT_HTTPHEADER] = $curlHeaders;
+		return $headers;
+	}
+
+	/**
+	 * @return resource cURL handle
+	 */
+	public function init(){
+		$options = $this->initCurlOptions();
+
+		$userinfo = $this->request->getUri()->getUserInfo();
+
+		if(!empty($userinfo)){
+			$options[CURLOPT_USERPWD] = $userinfo;
+		}
+
+		/*
+		 * Some HTTP methods cannot have payload:
+		 *
+		 * - GET   — cURL will automatically change method to PUT or POST
+		 *           if we set CURLOPT_UPLOAD or CURLOPT_POSTFIELDS.
+		 * - HEAD  — cURL treats HEAD as GET request with a same restrictions.
+		 * - TRACE — According to RFC7231: a client MUST NOT send a message body in a TRACE request.
+		 */
+		$method = $this->request->getMethod();
+
+		if(in_array($method, ['DELETE', 'PATCH', 'POST', 'PUT'], true)){
+			$this->setBodyOptions($options);
+		}
+
+		// This will set HTTP method to "HEAD".
+		if($method === 'HEAD'){
+			$options[CURLOPT_NOBODY] = true;
+		}
+
+		// GET is a default method. Other methods should be specified explicitly.
+		if($method !== 'GET'){
+			$options[CURLOPT_CUSTOMREQUEST] = $method;
+		}
+
+		$options[CURLOPT_HTTPHEADER] = $this->initCurlHeaders($options);
 
 		// If the Expect header is not present, prevent curl from adding it
-		if (!$this->request->hasHeader('Expect')) {
+		if(!$this->request->hasHeader('Expect')){
 			$options[CURLOPT_HTTPHEADER][] = 'Expect:';
 		}
 
 		// cURL sometimes adds a content-type by default. Prevent this.
-		if (!$this->request->hasHeader('Content-Type')) {
+		if(!$this->request->hasHeader('Content-Type')){
 			$options[CURLOPT_HTTPHEADER][] = 'Content-Type:';
 		}
 

src/HTTPOptions.php

@@ -19,6 +19,7 @@
  * @property array  $curl_options
  * @property string $ca_info
  * @property bool   $ssl_verifypeer
+ * @property string $curlHandle
  */
 class HTTPOptions extends SettingsContainerAbstract{
 	use HTTPOptionsTrait;

src/HTTPOptionsTrait.php

@@ -49,6 +49,13 @@ trait HTTPOptionsTrait{
 	 */
 	protected $ssl_verifypeer = true;
 
+	/**
+	 * The CurlHandleInterface to use in CurlClient::sendRequest()
+	 *
+	 * @var string
+	 */
+	protected $curlHandle = CurlHandle::class;
+
 	/**
 	 * HTTPOptionsTrait constructor
 	 *
@@ -166,6 +173,7 @@ protected function setCA():void{
 			}
 		}
 
+		// @codeCoverageIgnoreStart
 		$msg = 'No system CA bundle could be found in any of the the common system locations. '
 			.'In order to verify peer certificates, you will need to supply the path on disk to a certificate bundle via  '
 			.'HTTPOptions::$ca_info or HTTPOptions::$curl_options. If you do not need a specific certificate bundle, '
@@ -174,7 +182,8 @@ protected function setCA():void{
 			.'to the path of the file, allowing you to omit the $ca_info or $curl_options setting. '
 			.'See http://curl.haxx.se/docs/sslcerts.html for more information.';
 
-		throw new ClientException($msg); // @codeCoverageIgnore
+		throw new ClientException($msg);
+		// @codeCoverageIgnoreEnd
 	}
 
 }

src/Psr7/MultipartStream.php

@@ -18,7 +18,7 @@
 use InvalidArgumentException, RuntimeException;
 
 /**
- * @property \chillerlan\HTTP\Psr7\AppendStream $stream
+ * @property \chillerlan\HTTP\Psr7\Stream $stream
  */
 final class MultipartStream extends StreamAbstract{
 
@@ -27,11 +27,6 @@ final class MultipartStream extends StreamAbstract{
 	 */
 	protected $boundary;
 
-	/**
-	 * @var \Psr\Http\Message\StreamFactoryInterface
-	 */
-	protected $streamFactory;
-
 	/**
 	 * @var bool
 	 */
@@ -72,12 +67,12 @@ public function build():MultipartStream{
 
 		if(!$this->built){
 			$this->stream->write("--{$this->getBoundary()}--\r\n");
+
+			$this->built = true;
 		}
 
 		$this->stream->rewind();
 
-		$this->built = true;
-
 		return $this;
 	}
 
@@ -135,7 +130,6 @@ public function addElement(array $e):MultipartStream{
 			}
 		}
 
-
 		$this->stream->write('--'.$this->boundary."\r\n");
 
 		foreach($e['headers'] as $key => $value){
@@ -144,7 +138,6 @@ public function addElement(array $e):MultipartStream{
 
 		$this->stream->write("\r\n".$e['contents']->getContents()."\r\n");
 
-
 		return $this;
 	}
 
@@ -191,7 +184,7 @@ public function isWritable():bool{
 	 * @inheritdoc
 	 */
 	public function write($string):int{
-		throw new RuntimeException('Cannot write to a MultipartStream, use the "addElement" method instead.');
+		throw new RuntimeException('Cannot write to a MultipartStream, use MultipartStream::addElement() instead.');
 	}
 
 	/**

src/Psr7/Stream.php

@@ -84,7 +84,7 @@ public function __toString(){
 		}
 		catch(Exception $e){
 			// https://bugs.php.net/bug.php?id=53648
-			trigger_error('StreamDecoratorTrait::__toString exception: '.$e->getMessage(), E_USER_ERROR);
+			trigger_error('Stream::__toString exception: '.$e->getMessage(), E_USER_ERROR);
 
 			return '';
 		}