CurlBuilder::getHeaders() - Code Metrics - Inspection of "Add changes" - dirkgroenen/pinterest-api-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3758f0...0a4cf0 )

by Dirk

created 2016-02-02 14:45 UTC

CurlBuilder::getHeaders() A

↳ Parent: CurlBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	2
Bugs	0	Features	0

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

<?php
/**
 * Copyright 2015 Dirk Groenen
 *
 * (c) Dirk Groenen <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace DirkGroenen\Pinterest\Utils;

class CurlBuilder {

    /**
     * Contains the curl instance
     *
     * @var resource
     */
    private $curl;

    /**
     * Array containing headers from last performed request
     *
     * @var array
     */
    private $headers;

    /**
     * Constructor
     */
    public function __construct()
    {
        $this->curl = curl_init();
    }

    /**
     * Return a new instance of the CurlBuilder
     *
     * @access public
     * @return CurlBuilder
     */
    public function create()
    {
        return new self();
    }

    /**
     * Sets an option in the curl instance
     *
     * @access public
     * @param  string   $option
     * @param  false|string    $value
     * @return $this
     */
    public function setOption($option, $value)
    {
        curl_setopt($this->curl, $option, $value);

        return $this;
    }

    /**
     * Sets multiple options at the same time
     *
     * @access public
     * @param  array   $options
     * @return $this
     */
    public function setOptions(array $options = [])
    {
        curl_setopt_array($this->curl, $options);

        return $this;
    }

    /**
     * Execute the curl request
     *
     * @access public
     * @return false|string
     */
    public function execute()
    {
        return $this->execFollow();
    }

    /**
     * Check if the curl request ended up with errors
     *
     * @access public
     * @return integer
     */
    public function hasErrors()
    {
        return curl_errno($this->curl);
    }

    /**
     * Get curl errors
     *
     * @access public
     * @return string
     */
    public function getErrors()
    {
        return curl_error($this->curl);
    }

    /**
     * Get last curl error number
     *
     * @access public
     * @return int
     */
    public function getErrorNumber()
    {
        return curl_errno($this->curl);
    }

    /**
     * Get curl info key
     *
     * @access public
     * @param  string  $key
     * @return string
     */
    public function getInfo($key)
    {
        return curl_getinfo($this->curl, $key);
    }

    /**
     * Get headers
     *
     * @access public
     * @return string
     */
    public function getHeaders()
    {
        return $this->headers;
    }

    /**
     * Close the curl resource
     *
     * @access public
     * @return void
     */
    public function close()
    {
        curl_close($this->curl);
    }

    /**
     * Parse string headers into array
     *
     * @access private
     * @param string $headers
     * @return array
     */
    private function parseHeaders($headers) {
        $result = array();
        foreach (explode("\n", $headers) as $row) {
            $header = explode(':', $row, 2);
            if (count($header) == 2) {
                $result[$header[0]] = trim($header[1]);
            } else {
                $result[] = $header[0];
            }
        }
        return $result;
    }

    /**
     * Function which acts as a replacement for curl's default
     * FOLLOW_LOCATION option, since that gives errors when
     * combining it with open basedir.
     *
     * @see http://slopjong.de/2012/03/31/curl-follow-locations-with-safe_mode-enabled-or-open_basedir-set/
     * @access private
     * @return false|string
     */
    private function execFollow() {
        $mr = 5;
        $body = null;

        if (ini_get("open_basedir") == "" && ini_get("safe_mode" == "Off")) {
            $this->setOptions(array(
                CURLOPT_FOLLOWLOCATION => $mr > 0,
                CURLOPT_MAXREDIRS => $mr
            ));
        } else {
            $this->setOption(CURLOPT_FOLLOWLOCATION, false);

            if ($mr > 0) {
                $original_url = $this->getInfo(CURLINFO_EFFECTIVE_URL);
                $newurl = $original_url;

                $this->setOptions(array(
                    CURLOPT_HEADER => true,
                    CURLOPT_FORBID_REUSE => false
                ));

                do {
                    $this->setOption(CURLOPT_URL, $newurl);

                    $response = curl_exec($this->curl);

                    $header_size = $this->getInfo(CURLINFO_HEADER_SIZE);
                    $header = substr($response, 0, $header_size);
                    $body = substr($response, $header_size);

                    if ($this->getErrorNumber()) {
                        $code = 0;
                    } else {
                        $code = $this->getInfo(CURLINFO_HTTP_CODE);

                        if ($code == 301 || $code == 302) {
                            preg_match('/Location:(.*?)\n/i', $header, $matches);
                            $newurl = trim(array_pop($matches));
                        } else {
                            $code = 0;
                        }
                    }
                } while ($code && --$mr);

                if (!$mr) {
                    if ($mr === null) {
                        trigger_error('Too many redirects.', E_USER_WARNING);
                    }

                    return false;
                }

                $this->headers = $this->parseHeaders($header);
            }
        }

        if (!$body) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->setOption(CURLOPT_HEADER, true);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $response = $this->execute();

            $header_size = $this->getInfo(CURLINFO_HEADER_SIZE);
            $header = substr($response, 0, $header_size);
            $body = substr($response, $header_size);

            $this->headers = $this->parseHeaders($header);
        }

        return $body;
    }
}

1		<?php
2		/**
3		* Copyright 2015 Dirk Groenen
4		*
5		* (c) Dirk Groenen <[email protected]>
6		*
7		* For the full copyright and license information, please view the LICENSE
8		* file that was distributed with this source code.
9		*/
10
11		namespace DirkGroenen\Pinterest\Utils;
12
13		class CurlBuilder {
14
15		/**
16		* Contains the curl instance
17		*
18		* @var resource
19		*/
20		private $curl;
21
22		/**
23		* Array containing headers from last performed request
24		*
25		* @var array
26		*/
27		private $headers;
28
29		/**
30		* Constructor
31		*/
32	37	public function __construct()
33		{
34	37	$this->curl = curl_init();
35	37	}
36
37		/**
38		* Return a new instance of the CurlBuilder
39		*
40		* @access public
41		* @return CurlBuilder
42		*/
43		public function create()
44		{
45		return new self();
46		}
47
48		/**
49		* Sets an option in the curl instance
50		*
51		* @access public
52		* @param string $option
53		* @param false\|string $value
54		* @return $this
55		*/
56		public function setOption($option, $value)
57		{
58		curl_setopt($this->curl, $option, $value);
59
60		return $this;
61		}
62
63		/**
64		* Sets multiple options at the same time
65		*
66		* @access public
67		* @param array $options
68		* @return $this
69		*/
70		public function setOptions(array $options = [])
71		{
72		curl_setopt_array($this->curl, $options);
73
74		return $this;
75		}
76
77		/**
78		* Execute the curl request
79		*
80		* @access public
81		* @return false\|string
82		*/
83		public function execute()
84		{
85		return $this->execFollow();
86		}
87
88		/**
89		* Check if the curl request ended up with errors
90		*
91		* @access public
92		* @return integer
93		*/
94		public function hasErrors()
95		{
96		return curl_errno($this->curl);
97		}
98
99		/**
100		* Get curl errors
101		*
102		* @access public
103		* @return string
104		*/
105		public function getErrors()
106		{
107		return curl_error($this->curl);
108		}
109
110		/**
111		* Get last curl error number
112		*
113		* @access public
114		* @return int
115		*/
116		public function getErrorNumber()
117		{
118		return curl_errno($this->curl);
119		}
120
121		/**
122		* Get curl info key
123		*
124		* @access public
125		* @param string $key
126		* @return string
127		*/
128		public function getInfo($key)
129		{
130		return curl_getinfo($this->curl, $key);
131		}
132
133		/**
134		* Get headers
135		*
136		* @access public
137		* @return string
138		*/
139		public function getHeaders()
140		{
141		return $this->headers;
142		}
143
144		/**
145		* Close the curl resource
146		*
147		* @access public
148		* @return void
149		*/
150		public function close()
151		{
152		curl_close($this->curl);
153		}
154
155		/**
156		* Parse string headers into array
157		*
158		* @access private
159		* @param string $headers
160		* @return array
161		*/
162		private function parseHeaders($headers) {
163		$result = array();
164		foreach (explode("\n", $headers) as $row) {
165		$header = explode(':', $row, 2);
166		if (count($header) == 2) {
167		$result[$header[0]] = trim($header[1]);
168		} else {
169		$result[] = $header[0];
170		}
171		}
172		return $result;
173		}
174
175		/**
176		* Function which acts as a replacement for curl's default
177		* FOLLOW_LOCATION option, since that gives errors when
178		* combining it with open basedir.
179		*
180		* @see http://slopjong.de/2012/03/31/curl-follow-locations-with-safe_mode-enabled-or-open_basedir-set/
181		* @access private
182		* @return false\|string
183		*/
184		private function execFollow() {
185		$mr = 5;
186		$body = null;
187
188		if (ini_get("open_basedir") == "" && ini_get("safe_mode" == "Off")) {
189		$this->setOptions(array(
190		CURLOPT_FOLLOWLOCATION => $mr > 0,
191		CURLOPT_MAXREDIRS => $mr
192		));
193		} else {
194		$this->setOption(CURLOPT_FOLLOWLOCATION, false);
195
196		if ($mr > 0) {
197		$original_url = $this->getInfo(CURLINFO_EFFECTIVE_URL);
198		$newurl = $original_url;
199
200		$this->setOptions(array(
201		CURLOPT_HEADER => true,
202		CURLOPT_FORBID_REUSE => false
203		));
204
205		do {
206		$this->setOption(CURLOPT_URL, $newurl);
207
208		$response = curl_exec($this->curl);
209
210		$header_size = $this->getInfo(CURLINFO_HEADER_SIZE);
211		$header = substr($response, 0, $header_size);
212		$body = substr($response, $header_size);
213
214		if ($this->getErrorNumber()) {
215		$code = 0;
216		} else {
217		$code = $this->getInfo(CURLINFO_HTTP_CODE);
218
219		if ($code == 301 \|\| $code == 302) {
220		preg_match('/Location:(.*?)\n/i', $header, $matches);
221		$newurl = trim(array_pop($matches));
222		} else {
223		$code = 0;
224		}
225		}
226		} while ($code && --$mr);
227
228		if (!$mr) {
229		if ($mr === null) {
230		trigger_error('Too many redirects.', E_USER_WARNING);
231		}
232
233		return false;
234		}
235
236		$this->headers = $this->parseHeaders($header);
237		}
238		}
239
240		if (!$body) {
		0 ignored issues – show Bug Best Practice introduced 2016-01-09 15:07 UTC by Report Bug Copy Issue Report The expression `$body` of type `string\|null` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
241		$this->setOption(CURLOPT_HEADER, true);
		0 ignored issues – show Documentation introduced 2016-02-02 14:47 UTC by Report Bug Copy Issue Report `true` is of type `boolean`, but the function expects a `false\|string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
242		$response = $this->execute();
243
244		$header_size = $this->getInfo(CURLINFO_HEADER_SIZE);
245		$header = substr($response, 0, $header_size);
246		$body = substr($response, $header_size);
247
248		$this->headers = $this->parseHeaders($header);
249		}
250
251		return $body;
252		}
253		}

dirkgroenen / pinterest-api-php

GitHub Access Token became invalid

Push — master ( 3758f0...0a4cf0 )

CurlBuilder::getHeaders() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like