chillerlan / php-httpinterface

src/CurlUtils/CurlMultiClient.php

<?php
/**
 * Class CurlMultiClient
 *
 * @created      30.08.2018
 * @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 CurlMultiHandle as CMH;

use function array_shift, curl_close, 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, usleep;

use const CURLM_OK, CURLMOPT_MAXCONNECTS, CURLMOPT_PIPELINING, CURLPIPE_MULTIPLEX;

class CurlMultiClient implements LoggerAwareInterface{
	use LoggerAwareTrait;

	protected HTTPOptions|SettingsContainerInterface $options;
	protected ResponseFactoryInterface               $responseFactory;
	protected MultiResponseHandlerInterface          $multiResponseHandler;
	protected ?CMH                                   $curl_multi           = null;
	protected int                                    $handleCounter        = 0;

	/**
	 * An array of RequestInterface to run
	 */
	protected array $requests = [];

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

	/**
	 * CurlMultiClient constructor.
	 */
	public function __construct(
		MultiResponseHandlerInterface $multiResponseHandler,
		HTTPOptions|SettingsContainerInterface $options = null,
		ResponseFactoryInterface $responseFactory = null,
		LoggerInterface $logger = null
	){
		$this->multiResponseHandler = $multiResponseHandler;
		$this->options              = $options ?? new HTTPOptions;
		$this->responseFactory      = $responseFactory ?? new ResponseFactory;
		$this->logger               = $logger ?? new NullLogger;
		$this->curl_multi           = curl_multi_init();

		$curl_multi_options = [
			CURLMOPT_PIPELINING  => CURLPIPE_MULTIPLEX,
			CURLMOPT_MAXCONNECTS => $this->options->window_size,

The property $window_size is declared protected in chillerlan\HTTP\HTTPOptions. Since you implement __get, consider adding a @property or @property-read.

		] + $this->options->curl_multi_options;

The property $curl_multi_options is declared protected in chillerlan\HTTP\HTTPOptions. Since you implement __get, consider adding a @property or @property-read.

		foreach($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();
	}

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

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

	}

	/**
	 *
	 */
	public function addRequest(RequestInterface $request):CurlMultiClient{
		$this->requests[] = $request;

		return $this;
	}

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

		foreach($stack as $request){

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

		}

		return $this;
	}

	/**
	 * @phan-suppress PhanTypeInvalidThrowsIsInterface
	 * @throws \Psr\Http\Client\ClientExceptionInterface
	 */
	public function process():CurlMultiClient{

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

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

The property $window_size is declared protected in chillerlan\HTTP\HTTPOptions. Since you implement __get, consider adding a @property or @property-read.

			$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);

The property $timeout is declared protected in chillerlan\HTTP\HTTPOptions. Since you implement __get, consider adding a @property or @property-read.

			}

			while($state = curl_multi_info_read($this->curl_multi)){
				$id     = (int)$state['handle'];
				$handle = $this->handles[$id];
				$result = $handle->handleResponse();

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

				if($result instanceof RequestInterface && $handle->getRetries() < $this->options->retries){

The property $retries is declared protected in chillerlan\HTTP\HTTPOptions. Since you implement __get, consider adding a @property or @property-read.

					$this->createHandle($result, $handle->getID(), $handle->addRetry());

					continue;
				}

				$this->createHandle();
			}

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

		return $this;
	}

	/**
	 *
	 */
	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);
		}

		$handle = new CurlMultiHandle(
			$this->multiResponseHandler,
			$request,
			$this->responseFactory->createResponse(),
			$this->options
		);

		$curl = $handle
			->setID($id ?? $this->handleCounter++)
			->setRetries($retries ?? 1)
			->init()
		;

		/** @phan-suppress-next-line PhanTypeMismatchArgumentNullableInternal */
		curl_multi_add_handle($this->curl_multi, $curl);

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

		if($this->options->sleep > 0){

The property $sleep is declared protected in chillerlan\HTTP\HTTPOptions. Since you implement __get, consider adding a @property or @property-read.

			usleep($this->options->sleep);

It seems like $this->options->sleep can also be of type null; however, parameter $microseconds of usleep() does only seem to accept integer, maybe add an additional type check?

		}

	}

}