CurlAdapter::triggerDisableSSLCertificateValidation() - Code Metrics - Inspection of "Added support for HTTP authentication in the reque..." - ossbrownie/http-client - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — master (6a7e64)

by Oss

created 2017-10-08 09:24 UTC

triggerDisableSSLCertificateValidation() A

↳ Parent: CurlAdapter

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
eloc	5
c	0
b	0
f	0
nc	2
nop	2
dl	0
loc	10
ccs	5
cts	5
cp	1
crap	2
rs	9.4285

<?php
/**
 * @category    Brownie/HttpClient
 * @author      Brownie <[email protected]>
 * @license     http://www.gnu.org/copyleft/lesser.html
 */

namespace Brownie\HttpClient\Client;

use Brownie\HttpClient\Request;
use Brownie\HttpClient\Response;
use Brownie\HttpClient\Client;
use Brownie\HttpClient\Exception\ClientException;
use Brownie\HttpClient\Headers;

/**
 * API(Adapter) for using CURL functions in HTTP requests.
 */
class CurlAdapter implements Client
{

    /**
     * API CURL functions.
     *
     * @var CurlAdaptee
     */
    private $adaptee;

    /**
     * Sets incoming data.
     *
     * @param CurlAdaptee       $adaptee        API CURL functions.
     */
    public function __construct(CurlAdaptee $adaptee)
    {
        $this->setAdaptee($adaptee);
    }

    /**
     * Sets API CURL functions wrapper.
     * Returns the current object.
     *
     * @param CurlAdaptee $adaptee
     *
     * @return self
     */
    private function setAdaptee(CurlAdaptee $adaptee)
    {
        $this->adaptee = $adaptee;
        return $this;
    }

    /**
     * Returns API CURL functions wrapper.
     *
     * @return CurlAdaptee
     */
    private function getAdaptee()
    {
        return $this->adaptee;
    }

    /**
     * Performs a network request.
     * Returns the response.
     *
     * @param Request       $request    HTTP request params.
     *
     * @throws ClientException
     *
     * @return Response
     */
    public function httpRequest(Request $request)
    {
        $curl = $this->getCurlClient($request);

        /**
         * Executes a network resource request.
         */
        $responseBody = $this->getAdaptee()->exec($curl);

        $httpCode = $this->getAdaptee()->getinfo($curl, CURLINFO_HTTP_CODE);

        /**
         * Network error checking.
         */
        if ((0 != $this->getAdaptee()->errno($curl)) || !is_string($responseBody)) {
            throw new ClientException($this->getAdaptee()->error($curl));
        }

        /**
         * Gets the execution time of the request.
         */
        $runtime = $this->getAdaptee()->getinfo($curl, CURLINFO_TOTAL_TIME);

        /**
         * Gets the HTTP headers and the body separately.
         */
        $headerSize = $this->getAdaptee()->getinfo($curl, CURLINFO_HEADER_SIZE);
        $body = substr($responseBody, $headerSize);

        $this->getAdaptee()->close($curl);

        $response = new Response();
        return $response
            ->setBody($body)
            ->setHttpCode($httpCode)
            ->setRuntime($runtime)
            ->setHttpHeaders(new Headers(substr($responseBody, 0, $headerSize)));
    }

    /**
     * Creates and returns a CURL resource.
     *
     * @param Request       $request        HTTP request params.
     *
     * @return resource
     */
    private function getCurlClient(Request $request)
    {

        /**
         * Build URL.
         */
        $url = $this->getUrl($request);

        /**
         * Initializing CURL.
         */
        $curl = $this->getAdaptee()->init($url);

        /**
         * Sets the request body.
         */
        $body = $request->getBody();
        if (!empty($body)) {
            $this->getAdaptee()->setopt($curl, CURLOPT_POSTFIELDS, $body);
        }

        /**
         * CURL setting.
         */
        $this->setBaseOpt($curl, $request, $url);

        /**
         * Configuring HTTP headers.
         */
        $this->setHedaers($curl, $request, $body);

        return $curl;
    }

    /**
     * Generates and returns URL.
     *
     * @param Request   $request    HTTP request params.
     *
     * @return string
     */
    private function getUrl(Request $request)
    {
        $url = $request->getUrl();

        /**
         * Adds GET parameters.
         */
        $params = $request->getParams();
        if (!empty($params)) {
            $url .= '?' . http_build_query($params);
        }

        return $url;
    }

    /**
     * Sets the basic options.
     *
     * @param resource  $curl       CURL resource.
     * @param Request   $request    HTTP request params.
     * @param string    $url        Request URL.
     */
    private function setBaseOpt($curl, Request $request, $url)
    {
        $this
            ->getAdaptee()
            ->setopt($curl, CURLOPT_CUSTOMREQUEST, $request->getMethod())
            ->setopt($curl, CURLOPT_TIMEOUT, $request->getTimeOut())
            ->setopt($curl, CURLOPT_NOPROGRESS, true)
            ->setopt($curl, CURLOPT_RETURNTRANSFER, true)
            ->setopt($curl, CURLOPT_URL, $url)
            ->setopt($curl, CURLOPT_HEADER, true);

        $this->triggerDisableSSLCertificateValidation($curl, $request);

        $this->triggerAuthentication($curl, $request);
    }

    /**
     * Controlling verification of SSL certificates.
     *
     * @param resource  $curl           CURL resource.
     * @param Request   $request        HTTP request params.
     */
    private function triggerDisableSSLCertificateValidation($curl, Request $request)
    {
        if ($request->isDisableSSLValidation()) {
            /**
             * Disable SSL validation.
             */
            $this
                ->getAdaptee()
                ->setopt($curl, CURLOPT_SSL_VERIFYPEER, false)
                ->setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
        }
    }

    /**
     * Controlling request authentication.
     *
     * @param resource  $curl           CURL resource.
     * @param Request   $request        HTTP request params.
     */
    private function triggerAuthentication($curl, Request $request)
    {
        $authentication = $request->getAuthentication();
        if (!empty($authentication)) {
            /**
             * Enable authentication.
             */
            $this
                ->getAdaptee()
                ->setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_ANY)
                ->setopt($curl, CURLOPT_USERPWD, $authentication);
        }
    }

    /**
     * Sets HTTP headers.
     *
     * @param resource  $curl       CURL resource.
     * @param Request   $request    HTTP request params.
     * @param string    $body       The body of the request.
     */
    private function setHedaers($curl, Request $request, $body)
    {
        $headers = array(
            'Connection: close',
            'Accept-Ranges: bytes',
            'Content-Length: ' . strlen($body),
            'Accept: ' . $request->getBodyFormat() . ',*/*',
            'Content-Type: ' . $request->getBodyFormat() . '; charset=utf-8',
            'User-Agent: ' . $this->getAdaptee()->getAgentString(),
        );
        foreach ($request->getHeaders() as $name => $value) {
            $headers[] = $name . ': ' . $value;
        }
        $this->getAdaptee()->setopt($curl, CURLOPT_HTTPHEADER, $headers);
    }
}


1		<?php
2		/**
3		* @category Brownie/HttpClient
4		* @author Brownie <[email protected]>
5		* @license http://www.gnu.org/copyleft/lesser.html
6		*/
7
8		namespace Brownie\HttpClient\Client;
9
10		use Brownie\HttpClient\Request;
11		use Brownie\HttpClient\Response;
12		use Brownie\HttpClient\Client;
13		use Brownie\HttpClient\Exception\ClientException;
14		use Brownie\HttpClient\Headers;
15
16		/**
17		* API(Adapter) for using CURL functions in HTTP requests.
18		*/
19		class CurlAdapter implements Client
20		{
21
22		/**
23		* API CURL functions.
24		*
25		* @var CurlAdaptee
26		*/
27		private $adaptee;
28
29		/**
30		* Sets incoming data.
31		*
32		* @param CurlAdaptee $adaptee API CURL functions.
33		*/
34	6	public function __construct(CurlAdaptee $adaptee)
35		{
36	6	$this->setAdaptee($adaptee);
37	6	}
38
39		/**
40		* Sets API CURL functions wrapper.
41		* Returns the current object.
42		*
43		* @param CurlAdaptee $adaptee
44		*
45		* @return self
46		*/
47	6	private function setAdaptee(CurlAdaptee $adaptee)
48		{
49	6	$this->adaptee = $adaptee;
50	6	return $this;
51		}
52
53		/**
54		* Returns API CURL functions wrapper.
55		*
56		* @return CurlAdaptee
57		*/
58	6	private function getAdaptee()
59		{
60	6	return $this->adaptee;
61		}
62
63		/**
64		* Performs a network request.
65		* Returns the response.
66		*
67		* @param Request $request HTTP request params.
68		*
69		* @throws ClientException
70		*
71		* @return Response
72		*/
73	6	public function httpRequest(Request $request)
74		{
75	6	$curl = $this->getCurlClient($request);
76
77		/**
78		* Executes a network resource request.
79		*/
80	6	$responseBody = $this->getAdaptee()->exec($curl);
81
82	6	$httpCode = $this->getAdaptee()->getinfo($curl, CURLINFO_HTTP_CODE);
83
84		/**
85		* Network error checking.
86		*/
87	6	if ((0 != $this->getAdaptee()->errno($curl)) \|\| !is_string($responseBody)) {
88	1	throw new ClientException($this->getAdaptee()->error($curl));
89		}
90
91		/**
92		* Gets the execution time of the request.
93		*/
94	5	$runtime = $this->getAdaptee()->getinfo($curl, CURLINFO_TOTAL_TIME);
95
96		/**
97		* Gets the HTTP headers and the body separately.
98		*/
99	5	$headerSize = $this->getAdaptee()->getinfo($curl, CURLINFO_HEADER_SIZE);
100	5	$body = substr($responseBody, $headerSize);
101
102	5	$this->getAdaptee()->close($curl);
103
104	5	$response = new Response();
105		return $response
106	5	->setBody($body)
107	5	->setHttpCode($httpCode)
108	5	->setRuntime($runtime)
109	5	->setHttpHeaders(new Headers(substr($responseBody, 0, $headerSize)));
110		}
111
112		/**
113		* Creates and returns a CURL resource.
114		*
115		* @param Request $request HTTP request params.
116		*
117		* @return resource
118		*/
119	6	private function getCurlClient(Request $request)
120		{
121
122		/**
123		* Build URL.
124		*/
125	6	$url = $this->getUrl($request);
126
127		/**
128		* Initializing CURL.
129		*/
130	6	$curl = $this->getAdaptee()->init($url);
131
132		/**
133		* Sets the request body.
134		*/
135	6	$body = $request->getBody();
136	6	if (!empty($body)) {
137	5	$this->getAdaptee()->setopt($curl, CURLOPT_POSTFIELDS, $body);
138		}
139
140		/**
141		* CURL setting.
142		*/
143	6	$this->setBaseOpt($curl, $request, $url);
144
145		/**
146		* Configuring HTTP headers.
147		*/
148	6	$this->setHedaers($curl, $request, $body);
149
150	6	return $curl;
151		}
152
153		/**
154		* Generates and returns URL.
155		*
156		* @param Request $request HTTP request params.
157		*
158		* @return string
159		*/
160	6	private function getUrl(Request $request)
161		{
162	6	$url = $request->getUrl();
163
164		/**
165		* Adds GET parameters.
166		*/
167	6	$params = $request->getParams();
168	6	if (!empty($params)) {
169	6	$url .= '?' . http_build_query($params);
170		}
171
172	6	return $url;
173		}
174
175		/**
176		* Sets the basic options.
177		*
178		* @param resource $curl CURL resource.
179		* @param Request $request HTTP request params.
180		* @param string $url Request URL.
181		*/
182	6	private function setBaseOpt($curl, Request $request, $url)
183		{
184		$this
185	6	->getAdaptee()
186	6	->setopt($curl, CURLOPT_CUSTOMREQUEST, $request->getMethod())
187	6	->setopt($curl, CURLOPT_TIMEOUT, $request->getTimeOut())
188	6	->setopt($curl, CURLOPT_NOPROGRESS, true)
189	6	->setopt($curl, CURLOPT_RETURNTRANSFER, true)
190	6	->setopt($curl, CURLOPT_URL, $url)
191	6	->setopt($curl, CURLOPT_HEADER, true);
192
193	6	$this->triggerDisableSSLCertificateValidation($curl, $request);
194
195	6	$this->triggerAuthentication($curl, $request);
196	6	}
197
198		/**
199		* Controlling verification of SSL certificates.
200		*
201		* @param resource $curl CURL resource.
202		* @param Request $request HTTP request params.
203		*/
204	6	private function triggerDisableSSLCertificateValidation($curl, Request $request)
205		{
206	6	if ($request->isDisableSSLValidation()) {
207		/**
208		* Disable SSL validation.
209		*/
210		$this
211	2	->getAdaptee()
212	2	->setopt($curl, CURLOPT_SSL_VERIFYPEER, false)
213	2	->setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
214		}
215	6	}
216
217		/**
218		* Controlling request authentication.
219		*
220		* @param resource $curl CURL resource.
221		* @param Request $request HTTP request params.
222		*/
223	6	private function triggerAuthentication($curl, Request $request)
224		{
225	6	$authentication = $request->getAuthentication();
226	6	if (!empty($authentication)) {
227		/**
228		* Enable authentication.
229		*/
230		$this
231	6	->getAdaptee()
232	6	->setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_ANY)
233	6	->setopt($curl, CURLOPT_USERPWD, $authentication);
234		}
235	6	}
236
237		/**
238		* Sets HTTP headers.
239		*
240		* @param resource $curl CURL resource.
241		* @param Request $request HTTP request params.
242		* @param string $body The body of the request.
243		*/
244	6	private function setHedaers($curl, Request $request, $body)
245		{
246		$headers = array(
247	6	'Connection: close',
248	6	'Accept-Ranges: bytes',
249	6	'Content-Length: ' . strlen($body),
250	6	'Accept: ' . $request->getBodyFormat() . ',/',
251	6	'Content-Type: ' . $request->getBodyFormat() . '; charset=utf-8',
252	6	'User-Agent: ' . $this->getAdaptee()->getAgentString(),
253		);
254	6	foreach ($request->getHeaders() as $name => $value) {
255	6	$headers[] = $name . ': ' . $value;
256		}
257	6	$this->getAdaptee()->setopt($curl, CURLOPT_HTTPHEADER, $headers);
258	6	}
259		}
260

ossbrownie / http-client

Branch — master (6a7e64)

triggerDisableSSLCertificateValidation() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like