Onoi\HttpRequest\MultiCurlRequest

Complexity

Total Complexity

31

Size/Duplication

Total Lines	225
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	2
A	ping()	0	14	3
A	addHttpRequest()	0	3	1
A	setCallback()	0	3	1
A	setOption()	0	15	2
A	getOption()	0	3	2
A	getLastTransferInfo()	0	3	1
A	getLastError()	0	3	2
A	getLastErrorCode()	0	3	1
A	execute()	0	16	2
C	doMakeMultiRequest()	0	33	8
B	doCheckRequestResponse()	0	21	5
A	__destruct()	0	3	1

<?php

namespace Onoi\HttpRequest;

use InvalidArgumentException;
use Closure;

/**
 * @license GNU GPL v2+
 * @since 1.0
 *
 * @author mwjames
 */
class MultiCurlRequest implements HttpRequest {

	/**
	 * @var resource
	 */
	private $handle;

	/**
	 * @var array
	 */
	protected $options = array();

	/**
	 * @var CurlRequest[]
	 */
	private $httpRequests = array();

	/**
	 * @var integer
	 */
	private $lastErrorCode = 0;

	/**
	 * @since 1.0
	 *
	 * @param resource $handle
	 */
	public function __construct( $handle ) {

		if ( get_resource_type( $handle ) !== 'curl_multi' ) {
			throw new InvalidArgumentException( "Expected a cURL multi resource type" );
		}

		$this->handle = $handle;
	}

	/**
	 * @since 1.0
	 *
	 * @return boolean
	 */
	public function ping() {

		$canConnect = false;

		foreach ( $this->httpRequests as $httpRequest ) {
			if ( !$httpRequest->ping() ) {
				return false;
			}

			$canConnect = true;
		}

		return $canConnect;
	}

	/**
	 * @since 1.0
	 *
	 * @param CurlRequest $httpRequest
	 */
	public function addHttpRequest( CurlRequest $httpRequest ) {
		$this->httpRequests[] = $httpRequest;
	}

	/**
	 * @since 1.0
	 * @deprecated since 1.1, use ONOI_HTTP_REQUEST_ON_COMPLETED_CALLBACK instead
	 *
	 * @param Closure $callback
	 */
	public function setCallback( Closure $callback ) {
		$this->setOption( ONOI_HTTP_REQUEST_ON_COMPLETED_CALLBACK, $callback );
	}

	/**
	 * @since 1.0
	 *
	 * @param string $name
	 * @param mixed $value
	 */
	public function setOption( $name, $value ) {

		$this->options[$name] = $value;

		// Internal ONOI options are not further relayed
		if ( strpos( $name, 'ONOI_HTTP_REQUEST' ) !== false ) {
			return;
		}

		curl_multi_setopt(
			$this->handle,
			$name,
			$value
		);
	}

	/**
	 * @since 1.0
	 *
	 * @param string $name
	 *
	 * @return mixed|null
	 */
	public function getOption( $name ) {
		return isset( $this->options[$name] ) ? $this->options[$name] : null;
	}

	/**
	 * @since 1.0
	 *
	 * @param string|null $name
	 *
	 * @return mixed
	 */
	public function getLastTransferInfo( $name = null ) {
		return curl_multi_info_read( $this->handle );
	}

	/**
	 * @note PHP 5.5.0
	 *
	 * @since 1.0
	 *
	 * @return string
	 */
	public function getLastError() {
		return function_exists( 'curl_multi_strerror' ) ?  curl_multi_strerror( $this->lastErrorCode ) : '';
	}

	/**
	 * @since 1.0
	 *
	 * @return integer
	 */
	public function getLastErrorCode() {
		return $this->lastErrorCode;
	}

	/**
	 * @since 1.0
	 *
	 * @return array|null
	 */
	public function execute() {

		// Register all handles and monitor that
		// all requests are executed
		$handleExecutionCounter = array();

		foreach( $this->httpRequests as $httpRequest ) {
			$httpRequest->setOption( CURLOPT_RETURNTRANSFER, true );
			$handleExecutionCounter[(int)  $httpRequest() ] = true;
			curl_multi_add_handle( $this->handle, $httpRequest() );
		}

		$response = $this->doMakeMultiRequest( $handleExecutionCounter );

		return $response;
	}

	private function doMakeMultiRequest( $handleExecutionCounter ) {

		$active = null;
		$responses = array();

		// http://php.net/manual/en/function.curl-multi-init.php
		// https://gist.github.com/Xeoncross/2362936
		do {
			$this->lastErrorCode = curl_multi_exec( $this->handle, $active );

			// Wait for activity on any curl-connection
			if ( curl_multi_select( $this->handle ) == -1 ) {
				usleep( 100 );
			}

		} while ( $this->lastErrorCode == CURLM_CALL_MULTI_PERFORM );

		while ( ( $active && $this->lastErrorCode == CURLM_OK ) || $handleExecutionCounter !== array() ) {

			$requestResponse = $this->doCheckRequestResponse( $handleExecutionCounter );

			if ( $requestResponse !== null ) {
				$responses[] = $requestResponse;
			}

			// Continue to exec until curl is ready
			do {
				$this->lastErrorCode = curl_multi_exec( $this->handle, $active );
			} while ( $this->lastErrorCode == CURLM_CALL_MULTI_PERFORM );
		}

		return $responses;
	}

	private function doCheckRequestResponse( &$handleExecutionCounter ) {

		$requestResponse = null;

		if ( ( $state = curl_multi_info_read( $this->handle ) ) && $state["msg"] == CURLMSG_DONE ) {

			$requestResponse = new RequestResponse( array(
				'contents' => curl_multi_getcontent( $state['handle'] ),
				'info'     => curl_getinfo( $state['handle'] )
			) );

			unset( $handleExecutionCounter[(int) $state['handle']] );
			curl_multi_remove_handle( $this->handle, $state['handle'] );
		}

		if ( is_callable( $this->getOption( ONOI_HTTP_REQUEST_ON_COMPLETED_CALLBACK ) ) && $requestResponse !== null ) {
			call_user_func_array( $this->getOption( ONOI_HTTP_REQUEST_ON_COMPLETED_CALLBACK ), array( $requestResponse ) );
		}

		return $requestResponse;
	}

	/**
	 * @since 1.0
	 */
	public function __destruct() {
		curl_multi_close( $this->handle );
	}

}