chillerlan\HTTP\CurlUtils\CurlMultiClient

Complexity

Total Complexity

25

Size/Duplication

Total Lines	208
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	18	2
A	__destruct()	0	3	1
A	close()	0	7	2
A	setMultiResponseHandler()	0	5	1
A	addRequest()	0	5	1
A	addRequests()	0	12	3
B	process()	0	47	11
A	createHandle()	0	26	4

<?php
/**
 * Class CurlMultiClient
 *
 * @filesource   CurlMultiClient.php
 * @created      30.08.2018
 * @package      chillerlan\HTTP\CurlUtils
 * @author       smiley <smiley@chillerlan.net>
 * @copyright    2018 smiley
 * @license      MIT
 */

namespace chillerlan\HTTP\CurlUtils;

use chillerlan\HTTP\{HTTPOptions, Psr17\ResponseFactory, Psr18\ClientException};
use chillerlan\Settings\SettingsContainerInterface;
use Psr\Http\Message\{RequestInterface, ResponseFactoryInterface};
use Psr\Log\{LoggerAwareInterface, LoggerAwareTrait, LoggerInterface, NullLogger};

use function array_shift, curl_close, curl_getinfo, curl_multi_add_handle, curl_multi_close, curl_multi_exec,
	curl_multi_info_read, curl_multi_init, curl_multi_remove_handle, curl_multi_select, curl_multi_setopt,
	is_array, is_resource, usleep;

use const CURLM_OK, CURLMOPT_MAXCONNECTS, CURLMOPT_PIPELINING, CURLPIPE_HTTP1, CURLPIPE_MULTIPLEX;

class CurlMultiClient implements LoggerAwareInterface{
	use LoggerAwareTrait;

	/** @var \chillerlan\HTTP\HTTPOptions */
	protected $options;

	/** @var \Psr\Http\Message\ResponseFactoryInterface */
	protected $responseFactory;

	/** @var \chillerlan\HTTP\CurlUtils\MultiResponseHandlerInterface */
	protected $multiResponseHandler;

	/**
	 * the curl_multi master handle
	 *
	 * @var resource
	 */
	protected $curl_multi;

	/**
	 * An array of RequestInterface to run
	 *
	 * @var \Psr\Http\Message\RequestInterface[]
	 */
	protected $requests = [];

	/**
	 * the stack of running handles
	 *
	 * @var \chillerlan\HTTP\CurlUtils\CurlHandle[]
	 */
	protected $handles = [];

	/**
	 * @var int
	 */
	protected $handleCounter = 0;

	/**
	 * CurlMultiClient constructor.
	 *
	 * @param \chillerlan\Settings\SettingsContainerInterface|null $options
	 * @param \Psr\Http\Message\ResponseFactoryInterface|null      $responseFactory
	 * @param \Psr\Log\LoggerInterface|null                        $logger
	 */
	public function __construct(
		SettingsContainerInterface $options = null,
		ResponseFactoryInterface $responseFactory = null,
		LoggerInterface $logger = null
	){
		$this->options         = $options ?? new HTTPOptions;

$options ?? new \chillerlan\HTTP\HTTPOptions() is of type object<chillerlan\Settings\SettingsContainerInterface>, but the property $options was declared to be of type object<chillerlan\HTTP\HTTPOptions>. Are you sure that you always receive this specific sub-class here, or does it make sense to add an instanceof check?

		$this->responseFactory = $responseFactory ?? new ResponseFactory;
		$this->logger          = $logger ?? new NullLogger;
		$this->curl_multi      = curl_multi_init();

		curl_multi_setopt($this->curl_multi, CURLMOPT_PIPELINING, CURLPIPE_HTTP1 | CURLPIPE_MULTIPLEX);
		curl_multi_setopt($this->curl_multi, CURLMOPT_MAXCONNECTS, $this->options->windowSize);

		foreach($this->options->curl_multi_options as $k => $v){
			curl_multi_setopt($this->curl_multi, $k, $v);
		}

	}

	/**
	 * close an existing cURL multi handle on exit
	 */
	public function __destruct(){
		$this->close();
	}

	/**
	 * @return void
	 */
	public function close():void{

		if(is_resource($this->curl_multi)){
			curl_multi_close($this->curl_multi);
		}

	}

	/**
	 * @param \chillerlan\HTTP\CurlUtils\MultiResponseHandlerInterface $handler
	 *
	 * @return \chillerlan\HTTP\CurlUtils\CurlMultiClient
	 */
	public function setMultiResponseHandler(MultiResponseHandlerInterface $handler):CurlMultiClient{
		$this->multiResponseHandler = $handler;

		return $this;
	}

	/**
	 * @param \Psr\Http\Message\RequestInterface $request
	 *
	 * @return \chillerlan\HTTP\CurlUtils\CurlMultiClient
	 */
	public function addRequest(RequestInterface $request):CurlMultiClient{
		$this->requests[] = $request;

		return $this;
	}

	/**
	 * @param \Psr\Http\Message\RequestInterface[] $stack
	 *
	 * @return \chillerlan\HTTP\CurlUtils\CurlMultiClient
	 */
	public function addRequests(iterable $stack):CurlMultiClient{

		foreach($stack as $request){

			if($request instanceof RequestInterface){
				$this->requests[] = $request;
			}

		}

		return $this;
	}

	/**
	 * @throws \chillerlan\HTTP\Psr18\ClientException
	 */
	public function process():CurlMultiClient{

		if(empty($this->requests)){
			throw new ClientException('request stack is empty');
		}

		if(!$this->multiResponseHandler instanceof MultiResponseHandlerInterface){
			throw new ClientException('no response handler set');
		}

		// shoot out the first batch of requests
		for($i = 0; $i < $this->options->windowSize; $i++){
			$this->createHandle();
		}

		// ...and process the stack
		do{
			$status = curl_multi_exec($this->curl_multi, $active);

			if($active){
				curl_multi_select($this->curl_multi, $this->options->timeout);
			}

			while($state = curl_multi_info_read($this->curl_multi)){
				$id     = (int)$state['handle'];
				$handle = $this->handles[$id];
				$info   = curl_getinfo($handle->curl);
				$result = $this->multiResponseHandler->handleResponse($handle->response, $handle->request, $handle->id, (is_array($info) ? $info : []));

				curl_multi_remove_handle($this->curl_multi, $state['handle']);
				curl_close($state['handle']);
				unset($this->handles[$id]);

				if($result instanceof RequestInterface && $handle->retries < $this->options->retries){
					$this->createHandle($result, $handle->id, ++$handle->retries);

					continue;
				}

				$this->createHandle();
			}

		}
		while($active && $status === CURLM_OK);

		return $this;
	}

	/**
	 * @param \Psr\Http\Message\RequestInterface $request

Should the type for parameter $request not be null|\Psr\Http\Message\RequestInterface?

	 * @param int|null                           $id
	 * @param int|null                           $retries
	 *
	 * @return void
	 */
	protected function createHandle(RequestInterface $request = null, int $id = null, int $retries = null):void{

		if($request === null){

			if(empty($this->requests)){
				return;
			}

			$request = array_shift($this->requests);
		}

		/** @var \chillerlan\HTTP\CurlUtils\CurlHandle $handle */
		$handle          = new $this->options->curlHandle($request, $this->responseFactory->createResponse(), $this->options);
		$handle->id      = $id ?? $this->handleCounter++;
		$handle->retries = $retries ?? 1;

		$handle->init();
		curl_multi_add_handle($this->curl_multi, $handle->curl);

		$this->handles[(int)$handle->curl] = $handle;

		if($this->options->sleep > 0){
			usleep($this->options->sleep);
		}

	}

}