CurlSoapClient::__doRequest() - Code Metrics - Inspection of "ignore composer.lock" - aaharu/curlsoapclient - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c312b3...d35487 )

by Haruaki

created 2016-01-16 12:12 UTC

CurlSoapClient::__doRequest() D

↳ Parent: CurlSoapClient

Complexity

Conditions	10
Paths	16

Size

Total Lines	34
Code Lines	22

Duplication

Lines	3
Ratio	8.82 %

Code Coverage

Tests	22
CRAP Score	10.0082

Importance

Changes	10
Bugs	0	Features	1

Metric	Value
c	10
b	0
f	1
dl	3
loc	34
ccs	22
cts	23
cp	0.9565
rs	4.8196
cc	10
eloc	22
nc	16
nop	5
crap	10.0082

How to fix Complexity

<?php
/**
 * curlsoapclient - SoapClient with ext-curl. -
 *
 * @author    aaharu
 * @copyright Copyright (c) 2014 aaharu
 * @license   MIT License
 */

namespace Aaharu\Soap;

use SoapClient;

/**
 * @see https://github.com/php/php-src/tree/master/ext/soap
 */
class CurlSoapClient extends SoapClient
{
    protected $curl = null; ///< cURL handle
    protected $redirect_max; ///< max redirect counts
    protected $curl_timeout; ///< cURL request time-out seconds
    private $redirect_count = 0;

    public function __construct($wsdl, array $options)
    {
        parent::__construct($wsdl, $options);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $this->redirect_max = 5;
        if (isset($options['redirect_max'])) {
            $this->redirect_max = (int)$options['redirect_max'];
        }
        $this->curl_timeout = 30;
        if (isset($options['curl_timeout'])) {
            $this->curl_timeout = (int)$options['curl_timeout'];
        }
        $this->curl = curl_init();
        $this->_cookies = array();
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    public function __destruct()
    {
        if (isset($this->curl)) {
            curl_close($this->curl);
        }
    }

    public function ___curlSetOpt($option, $value)
    {
        curl_setopt($this->curl, $option, $value);
    }

    public function __getCookies()
    {
        return $this->_cookies;
    }

    public function __setCookie($name, $value = null)
    {
        if (!isset($value)) {
            unset($this->_cookies[$name]);
            return;
        }
        $this->_cookies[$name] = (array)$value;
    }

    /**
     * Execute SOAP requests.
     *
     * @param string $request SOAP request
     * @param string $location SOAP address
     * @param string $action SOAP action
     * @param int $version SOAP version
     * @param int $one_way
     * @throws \Exception
     * @throws \SoapFault
     * @return mixed (string) SOAP response / (object) SoapFault object
     */
    public function __doRequest($request, $location, $action, $version, $one_way = 0)
    {
        curl_setopt($this->curl, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($this->curl, CURLOPT_HEADER, true);
        curl_setopt($this->curl, CURLOPT_POSTFIELDS, $request);
        if (isset($this->trace) && $this->trace) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            curl_setopt($this->curl, CURLINFO_HEADER_OUT, true);
        }

        $this->___configHeader($action, $version);
        $this->___configCompression();
        $this->___configTimeout();
        if (isset($this->_user_agent) && is_string($this->_user_agent) && strlen($this->_user_agent) > 0) {

            curl_setopt($this->curl, CURLOPT_USERAGENT, $this->_user_agent);
class MyClass { }

$x = new MyClass();
$x->foo = true;
        }
        $this->___configHttpAuthentication();
        $this->___configProxy();

        try {
            $response = $this->___curlCall($location);
        } catch (\SoapFault $fault) {
            if (isset($this->_exceptions) && empty($this->_exceptions)) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
                // if exceptions option is false, return \SoapFault object
                return $fault;
            }
            throw $fault;
        }

        if ($one_way) {
            return '';
        }

        return $response;
    }

    /**
     * set CURLOPT_HTTPHEADER.
     *
     * @param string $action SOAP action
     * @param int $version SOAP version
     * @return void
     */
    private function ___configHeader($action, $version)
    {
        $header = array();
        if (isset($this->_keep_alive) && empty($this->_keep_alive)) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $header[] = 'Connection: close';
        } else {
            $header[] = 'Connection: Keep-Alive';
        }
        if ($version === SOAP_1_2) {
            $header[] = "Content-Type: application/soap+xml; charset=utf-8; action=\"{$action}\"";
        } else {
            $header[] = 'Content-Type: text/xml; charset=utf-8';
            $header[] = "SOAPAction: \"{$action}\"";
        }
        curl_setopt($this->curl, CURLOPT_HTTPHEADER, $header);
    }

    /**
     * set CURLOPT_ENCODING.
     *
     * @return void
     */
    private function ___configCompression()
    {
        if (isset($this->compression)) {
            if ($this->compression & SOAP_COMPRESSION_ACCEPT) {
                curl_setopt($this->curl, CURLOPT_ENCODING, '');
            } elseif ($this->compression & SOAP_COMPRESSION_DEFLATE) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
                curl_setopt($this->curl, CURLOPT_ENCODING, 'deflate');
            } else {
                curl_setopt($this->curl, CURLOPT_ENCODING, 'gzip');
            }
        }
    }

    /**
     * set CURLOPT_CONNECTTIMEOUT and CURLOPT_TIMEOUT.
     *
     * @return void
     */
    private function ___configTimeout()
    {
        $connection_timeout = 10; // default
        if (isset($this->_connection_timeout) && is_int($this->_connection_timeout)) {
            $connection_timeout = $this->_connection_timeout;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        }
        curl_setopt($this->curl, CURLOPT_CONNECTTIMEOUT, $connection_timeout);
        curl_setopt($this->curl, CURLOPT_TIMEOUT, $this->curl_timeout);
    }

    /**
     * set CURLOPT_HTTPAUTH.
     *
     * @return void
     */
    private function ___configHttpAuthentication()
    {
        if (isset($this->_login) && is_string($this->_login) && strlen($this->_login) > 0 &&

            isset($this->_password) && is_string($this->_password) && strlen($this->_password) > 0) {
            curl_setopt($this->curl, CURLOPT_USERPWD, $this->_login . ':' . $this->_password);
class MyClass { }

$x = new MyClass();
$x->foo = true;
            if (property_exists($this, '_digest')) {
                curl_setopt($this->curl, CURLOPT_HTTPAUTH, CURLAUTH_ANYSAFE);
            } else {
                curl_setopt($this->curl, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
            }
        }
    }

    /**
     * set proxy options.
     *
     * @return void
     */
    private function ___configProxy()
    {
        if (isset($this->_proxy_host) && is_string($this->_proxy_host) && strlen($this->_proxy_host) > 0) {

            curl_setopt($this->curl, CURLOPT_PROXY, $this->_proxy_host);
class MyClass { }

$x = new MyClass();
$x->foo = true;
        }
        if (isset($this->_proxy_port) && is_integer($this->_proxy_port)) {
            curl_setopt($this->curl, CURLOPT_PROXYPORT, $this->_proxy_port);
class MyClass { }

$x = new MyClass();
$x->foo = true;
        }
        if (isset($this->_proxy_login) && is_string($this->_proxy_login) && strlen($this->_proxy_login) > 0 &&

            isset($this->_proxy_password) && is_string($this->_proxy_password) && strlen($this->_proxy_password) > 0) {

            curl_setopt($this->curl, CURLOPT_PROXYUSERPWD, $this->_proxy_login . ':' . $this->_proxy_password);

            if (property_exists($this, '_digest')) {
                curl_setopt($this->curl, CURLOPT_PROXYAUTH, CURLAUTH_ANYSAFE);
            } else {
                curl_setopt($this->curl, CURLOPT_PROXYAUTH, CURLAUTH_ANY);
            }
        }
    }

    /**
     * Request cURL.
     *
     * @param[in] string $location SOAP address
     * @throws \SoapFault
     * @return mixed response body
     */
    private function ___curlCall($location)
    {
        curl_setopt($this->curl, CURLOPT_URL, $location);

        if (!empty($this->_cookies)) {
            $cookies = array();
            foreach ($this->_cookies as $cookie_name => $cookie_value) {
                $cookies[] = $cookie_name . '=' . $cookie_value[0];
            }
            curl_setopt($this->curl, CURLOPT_COOKIE, implode('; ', $cookies));
        }

        $response = curl_exec($this->curl);
        if ($response === false) {
            throw new \SoapFault(
                'HTTP',
                'Error Fetching http, ' . curl_error($this->curl) . ' (' . curl_errno($this->curl) . ')'
            );
        }

        $header_size = curl_getinfo($this->curl, CURLINFO_HEADER_SIZE);
        $response_header = substr($response, 0, $header_size);
        $response_body = substr($response, $header_size);
        $http_code = curl_getinfo($this->curl, CURLINFO_HTTP_CODE);

        if (isset($this->trace) && $this->trace) {
            $this->__last_request_headers = curl_getinfo($this->curl, CURLINFO_HEADER_OUT);
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $this->__last_response_headers = $response_header;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        }

        if ($http_code >= 300 && $http_code < 400) {
            $tmp = stristr($response_header, 'Location:');
            $line_end = strpos($tmp, "\n"); // "\r" will be trimmed
            if ($line_end === false) {
                throw new \SoapFault('HTTP', 'Error Redirecting, No Location');
            }
            $new_location = trim(substr($tmp, 9, $line_end - 9));
            $url = parse_url($new_location);
            if ($url === false ||
                empty($url['scheme']) ||
                preg_match('/^https?$/i', $url['scheme']) !== 1
            ) {
                throw new \SoapFault('HTTP', 'Error Redirecting, Invalid Location');
            }
            if (++$this->redirect_count > $this->redirect_max) {
                throw new \SoapFault('HTTP', 'Redirection limit reached, aborting');
            }
            return $this->___curlCall($new_location);
        }

        if ($http_code >= 400) {
            $is_error = false;
            $response_length = strlen($response_body);
            if ($response_length === 0) {
                $is_error = true;
            } elseif ($response_length > 0) {
                $is_xml = false;
                $content_type = curl_getinfo($this->curl, CURLINFO_CONTENT_TYPE);
                if ($content_type !== null) {
                    $separator_position = strpos($content_type, ';');
                    if ($separator_position !== false) {
                        $content_type = substr($content_type, 0, $separator_position);
                    }
                    if ($content_type === 'text/xml' || $content_type === 'application/soap+xml') {
                        $is_xml = true;
                    }
                }
                if (!$is_xml) {
                    $str = ltrim($response_body);
                    if (strncmp($str, '<?xml', 5)) {
                        $is_error = true;
                    }
                }
            }

            if ($is_error) {
                $string_http_code = (string)$http_code;
                $code_position = strpos($response_header, $string_http_code);
                $tmp = substr($response_header, $code_position + strlen($string_http_code));
                $http_message = trim(strstr($tmp, "\n", true));
                throw new \SoapFault('HTTP', $http_message);
            }
        }

        return $response_body;
    }
}


Push — master ( c312b3...d35487 )

CurlSoapClient::__doRequest() D

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Complexity

Long Method

Available Fixes

1		<?php
2		/**
3		* curlsoapclient - SoapClient with ext-curl. -
4		*
5		* @author aaharu
6		* @copyright Copyright (c) 2014 aaharu
7		* @license MIT License
8		*/
9
10		namespace Aaharu\Soap;
11
12		use SoapClient;
13
14		/**
15		* @see https://github.com/php/php-src/tree/master/ext/soap
16		*/
17		class CurlSoapClient extends SoapClient
18		{
19		protected $curl = null; ///< cURL handle
20		protected $redirect_max; ///< max redirect counts
21		protected $curl_timeout; ///< cURL request time-out seconds
22		private $redirect_count = 0;
23
24	12	public function __construct($wsdl, array $options)
25		{
26	12	parent::__construct($wsdl, $options);
		1 ignored issue – show Bug introduced 2016-01-16 12:01 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `SoapClient` as the method `__construct()` does only exist in the following sub-classes of `SoapClient`: `Aaharu\Soap\CurlSoapClient`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
27	12	$this->redirect_max = 5;
28	12	if (isset($options['redirect_max'])) {
29	1	$this->redirect_max = (int)$options['redirect_max'];
30	1	}
31	12	$this->curl_timeout = 30;
32	12	if (isset($options['curl_timeout'])) {
33	1	$this->curl_timeout = (int)$options['curl_timeout'];
34	1	}
35	12	$this->curl = curl_init();
36	12	$this->_cookies = array();
		1 ignored issue – show Bug introduced 2016-01-16 12:01 UTC by Report Bug Copy Issue Report The property `_cookies` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
37	12	}
38

aaharu / curlsoapclient

Push — master ( c312b3...d35487 )

CurlSoapClient::__doRequest() D

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Complexity

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like