CurlHttpClient::useProxy() - Code Metrics - Inspection of "refactoring + proxy helpers" - seregazhuk/php-pinterest-bot - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#220)

by Sergey

created 2016-12-02 19:36 UTC

CurlHttpClient::useProxy() A

↳ Parent: CurlHttpClient

Complexity

Conditions	3
Paths	4

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	12
c	0
b	0
f	0
rs	9.4285
cc	3
eloc	7
nc	4
nop	4

<?php

namespace seregazhuk\PinterestBot\Api;

use seregazhuk\PinterestBot\Helpers\Cookies;
use seregazhuk\PinterestBot\Helpers\UrlBuilder;
use seregazhuk\PinterestBot\Api\Contracts\HttpClient;

/**
 * Class CurlAdapter.
 */
class CurlHttpClient implements HttpClient
{
    /**
     * Custom CURL options for requests.
     *
     * @var array
     */
    protected $options = [
        CURLOPT_USERAGENT => 'Mozilla/5.0 (X11; Linux x86_64; rv:31.0) Gecko/20100101 Firefox/31.0'
    ];

    /**
     * @var array
     */
    protected $headers = [];

    /**
     * Contains the curl instance.
     *
     * @var resource
     */
    protected $curl;

    /**
     * Path to cookies file
     * @var string
     */
    protected $cookieJar;

    /**
     * Cookies container
     *
     * @var Cookies
     */
    protected $cookies;

    /**
     * @var string
     */
    protected $currentUrl;

    /**
     * Path to directory to store cookie file
     * @var string
     */
    protected $cookiesPath;

    public function __construct(Cookies $cookies)
    {
        $this->cookies = $cookies;
    }

    /**
     * Load cookies for specified username
     *
     * @param string $username
     * @return HttpClient
     */
    public function loadCookies($username = '')
    {
        return $this->initCookieJar($username)
            ->fillCookies();
    }

    /**
     * Executes curl request.
     *
     * @param string $url
     * @param string $postString
     * @param array $headers
     * @return string
     */
    public function execute($url, $postString = '', array $headers = [])
    {
        return $this
            ->init($url, $postString, $headers)
            ->callCurl();
    }

    /**
     * @return mixed
     */
    protected function callCurl()
    {
        $res = curl_exec($this->curl);

        $this->currentUrl = curl_getinfo($this->curl, CURLINFO_EFFECTIVE_URL);

        curl_close($this->curl);

        $this->fillCookies();

        return $res;
    }

    /**
     * Initializes curl resource with options.
     *
     * @param string $url
     * @param string $postString
     * @param array $headers
     * @return $this
     */
    protected function init($url, $postString, $headers)
    {
        $this->headers = $headers;

        $this->curl = curl_init($url);

        if (empty($this->cookieJar)) {
            $this->loadCookies();
        }

        curl_setopt_array($this->curl, $this->makeHttpOptions($postString));

        return $this;
    }

    /**
     * @return array
     */
    protected function getDefaultHttpOptions()
    {
        return [
            CURLOPT_RETURNTRANSFER => true,
            CURLOPT_SSL_VERIFYPEER => false,
            CURLOPT_FOLLOWLOCATION => true,
            CURLOPT_ENCODING       => 'gzip,deflate',
            CURLOPT_HTTPHEADER     => $this->headers,
            CURLOPT_REFERER        => UrlBuilder::URL_BASE,
            CURLOPT_COOKIEFILE     => $this->cookieJar,
            CURLOPT_COOKIEJAR      => $this->cookieJar,
        ];
    }

    /**
     * Adds necessary curl options for query.
     *
     * @param string $postString POST query string
     *
     * @return array
     */
    protected function makeHttpOptions($postString = '')
    {
        // Union custom Curl options and default.
        $options = array_replace(
            $this->options,
            $this->getDefaultHttpOptions()
        );

        if (!empty($postString)) {
            $options[CURLOPT_POST] = true;
            $options[CURLOPT_POSTFIELDS] = $postString;
        }

        return $options;
    }

    /**
     * Set custom Curl options to override default
     *
     * @param array $options
     * @return HttpClient
     */
    public function setOptions(array $options)
    {
        $this->options = $options;

        return $this;
    }

    /**
     * Get a cookie value by name
     *
     * @param $name
     * @return mixed
     */
    public function cookie($name)
    {
        return $this->cookies->get($name);
    }

    /**
     * Get all cookies
     *
     * @return array
     */
    public function cookies()
    {
        return $this->cookies->all();
    }

    /**
     * Set directory to store all cookie files.
     * @param string $path
     * @return $this
     */
    public function setCookiesPath($path)
    {
        $this->cookiesPath = $path;

        return $this;
    }

    /**
     * @return $this
     */
    public function removeCookies()
    {
        if (file_exists($this->cookieJar)) {
            unlink($this->cookieJar);
        }

        return $this;
    }

    /**
     * Init cookie file for a specified username. If username is empty we use
     * common cookie file for all sessions. If file does not exist it will
     * be created in system temp directory.
     *
     * @param $username
     * @return $this
     */
    protected function initCookieJar($username = '')
    {
        $this->cookieJar = $this->initCookieFile($username);

        return $this;
    }

    /**
     * Returns cookie file name by username. If username is empty we use a
     * random cookie name, to be sure we have different cookies
     * in parallel sessions.
     *
     * @param string $username
     * @return string
     */
    protected function initCookieFile($username)
    {
        if(empty($username)) {
            return tempnam($this->getCookiesPath(), self::COOKIE_PREFIX);
        }

        $cookieName = self::COOKIE_PREFIX . $username;
        $cookieFilePath = $this->getCookiesPath() . DIRECTORY_SEPARATOR . $cookieName;

        if (!file_exists($cookieFilePath)) {
            touch($cookieFilePath);
        }

        return $cookieFilePath;
    }

    /**
     * @return string
     */
    public function getCookiesPath()
    {
        return $this->cookiesPath ? : sys_get_temp_dir();
    }

    /**
     * @return $this
     */
    protected function fillCookies()
    {
        $this->cookies->fill($this->cookieJar);

        return $this;
    }

    /**
     * @return string
     */
    public function getCurrentUrl()
    {
        return $this->currentUrl;
    }

    /**
     * @param string $host '192.168.1.1'
     * @param string $port '12345'
     * @param string $auth Authentication string: 'username:password'
     * @param string $type HTTP|SOCKS
     * @return HttpClient
     */
    public function useProxy($host, $port, $auth = null, $type = null)
    {
        $proxy = [
            CURLOPT_PROXY     => $host,
            CURLOPT_PROXYPORT => $port,
            CURLOPT_PROXYTYPE => $type ? $type : CURLPROXY_HTTP,
        ];

        if($auth) $proxy[CURLOPT_PROXYUSERPWD] = $auth;
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false

        return $this->setOptions($proxy);
    }

    /**
     * @param string $host
     * @param string $port
     * @param null $auth
     * @return HttpClient
     */
    public function useSocksProxy($host, $port, $auth = null)
    {
        return $this->useProxy($host, $port, CURLPROXY_SOCKS5, $auth);
    }
}

1			<?php
2
3			namespace seregazhuk\PinterestBot\Api;
4
5			use seregazhuk\PinterestBot\Helpers\Cookies;
6			use seregazhuk\PinterestBot\Helpers\UrlBuilder;
7			use seregazhuk\PinterestBot\Api\Contracts\HttpClient;
8
9			/**
10			* Class CurlAdapter.
11			*/
12			class CurlHttpClient implements HttpClient
13			{
14			/**
15			* Custom CURL options for requests.
16			*
17			* @var array
18			*/
19			protected $options = [
20			CURLOPT_USERAGENT => 'Mozilla/5.0 (X11; Linux x86_64; rv:31.0) Gecko/20100101 Firefox/31.0'
21			];
22
23			/**
24			* @var array
25			*/
26			protected $headers = [];
27
28			/**
29			* Contains the curl instance.
30			*
31			* @var resource
32			*/
33			protected $curl;
34
35			/**
36			* Path to cookies file
37			* @var string
38			*/
39			protected $cookieJar;
40
41			/**
42			* Cookies container
43			*
44			* @var Cookies
45			*/
46			protected $cookies;
47
48			/**
49			* @var string
50			*/
51			protected $currentUrl;
52
53			/**
54			* Path to directory to store cookie file
55			* @var string
56			*/
57			protected $cookiesPath;
58
59			public function __construct(Cookies $cookies)
60			{
61			$this->cookies = $cookies;
62			}
63
64			/**
65			* Load cookies for specified username
66			*
67			* @param string $username
68			* @return HttpClient
69			*/
70			public function loadCookies($username = '')
71			{
72			return $this->initCookieJar($username)
73			->fillCookies();
74			}
75
76			/**
77			* Executes curl request.
78			*
79			* @param string $url
80			* @param string $postString
81			* @param array $headers
82			* @return string
83			*/
84			public function execute($url, $postString = '', array $headers = [])
85			{
86			return $this
87			->init($url, $postString, $headers)
88			->callCurl();
89			}
90
91			/**
92			* @return mixed
93			*/
94			protected function callCurl()
95			{
96			$res = curl_exec($this->curl);
97
98			$this->currentUrl = curl_getinfo($this->curl, CURLINFO_EFFECTIVE_URL);
99
100			curl_close($this->curl);
101
102			$this->fillCookies();
103
104			return $res;
105			}
106
107			/**
108			* Initializes curl resource with options.
109			*
110			* @param string $url
111			* @param string $postString
112			* @param array $headers
113			* @return $this
114			*/
115			protected function init($url, $postString, $headers)
116			{
117			$this->headers = $headers;
118
119			$this->curl = curl_init($url);
120
121			if (empty($this->cookieJar)) {
122			$this->loadCookies();
123			}
124
125			curl_setopt_array($this->curl, $this->makeHttpOptions($postString));
126
127			return $this;
128			}
129
130			/**
131			* @return array
132			*/
133			protected function getDefaultHttpOptions()
134			{
135			return [
136			CURLOPT_RETURNTRANSFER => true,
137			CURLOPT_SSL_VERIFYPEER => false,
138			CURLOPT_FOLLOWLOCATION => true,
139			CURLOPT_ENCODING => 'gzip,deflate',
140			CURLOPT_HTTPHEADER => $this->headers,
141			CURLOPT_REFERER => UrlBuilder::URL_BASE,
142			CURLOPT_COOKIEFILE => $this->cookieJar,
143			CURLOPT_COOKIEJAR => $this->cookieJar,
144			];
145			}
146
147			/**
148			* Adds necessary curl options for query.
149			*
150			* @param string $postString POST query string
151			*
152			* @return array
153			*/
154			protected function makeHttpOptions($postString = '')
155			{
156			// Union custom Curl options and default.
157			$options = array_replace(
158			$this->options,
159			$this->getDefaultHttpOptions()
160			);
161
162			if (!empty($postString)) {
163			$options[CURLOPT_POST] = true;
164			$options[CURLOPT_POSTFIELDS] = $postString;
165			}
166
167			return $options;
168			}
169
170			/**
171			* Set custom Curl options to override default
172			*
173			* @param array $options
174			* @return HttpClient
175			*/
176			public function setOptions(array $options)
177			{
178			$this->options = $options;
179
180			return $this;
181			}
182
183			/**
184			* Get a cookie value by name
185			*
186			* @param $name
187			* @return mixed
188			*/
189			public function cookie($name)
190			{
191			return $this->cookies->get($name);
192			}
193
194			/**
195			* Get all cookies
196			*
197			* @return array
198			*/
199			public function cookies()
200			{
201			return $this->cookies->all();
202			}
203
204			/**
205			* Set directory to store all cookie files.
206			* @param string $path
207			* @return $this
208			*/
209			public function setCookiesPath($path)
210			{
211			$this->cookiesPath = $path;
212
213			return $this;
214			}
215
216			/**
217			* @return $this
218			*/
219			public function removeCookies()
220			{
221			if (file_exists($this->cookieJar)) {
222			unlink($this->cookieJar);
223			}
224
225			return $this;
226			}
227
228			/**
229			* Init cookie file for a specified username. If username is empty we use
230			* common cookie file for all sessions. If file does not exist it will
231			* be created in system temp directory.
232			*
233			* @param $username
234			* @return $this
235			*/
236			protected function initCookieJar($username = '')
237			{
238			$this->cookieJar = $this->initCookieFile($username);
239
240			return $this;
241			}
242
243			/**
244			* Returns cookie file name by username. If username is empty we use a
245			* random cookie name, to be sure we have different cookies
246			* in parallel sessions.
247			*
248			* @param string $username
249			* @return string
250			*/
251			protected function initCookieFile($username)
252			{
253			if(empty($username)) {
254			return tempnam($this->getCookiesPath(), self::COOKIE_PREFIX);
255			}
256
257			$cookieName = self::COOKIE_PREFIX . $username;
258			$cookieFilePath = $this->getCookiesPath() . DIRECTORY_SEPARATOR . $cookieName;
259
260			if (!file_exists($cookieFilePath)) {
261			touch($cookieFilePath);
262			}
263
264			return $cookieFilePath;
265			}
266
267			/**
268			* @return string
269			*/
270			public function getCookiesPath()
271			{
272			return $this->cookiesPath ? : sys_get_temp_dir();
273			}
274
275			/**
276			* @return $this
277			*/
278			protected function fillCookies()
279			{
280			$this->cookies->fill($this->cookieJar);
281
282			return $this;
283			}
284
285			/**
286			* @return string
287			*/
288			public function getCurrentUrl()
289			{
290			return $this->currentUrl;
291			}
292
293			/**
294			* @param string $host '192.168.1.1'
295			* @param string $port '12345'
296			* @param string $auth Authentication string: 'username:password'
297			* @param string $type HTTP\|SOCKS
298			* @return HttpClient
299			*/
300			public function useProxy($host, $port, $auth = null, $type = null)
301			{
302			$proxy = [
303			CURLOPT_PROXY => $host,
304			CURLOPT_PROXYPORT => $port,
305			CURLOPT_PROXYTYPE => $type ? $type : CURLPROXY_HTTP,
306			];
307
308			if($auth) $proxy[CURLOPT_PROXYUSERPWD] = $auth;
			0 ignored issues – show Bug Best Practice introduced 2016-12-02 19:40 UTC by Report Bug Copy Issue Report The expression `$auth` of type `string\|null` is loosely compared to `true`; 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...
309
310			return $this->setOptions($proxy);
311			}
312
313			/**
314			* @param string $host
315			* @param string $port
316			* @param null $auth
317			* @return HttpClient
318			*/
319			public function useSocksProxy($host, $port, $auth = null)
320			{
321			return $this->useProxy($host, $port, CURLPROXY_SOCKS5, $auth);
322			}
323			}

seregazhuk / php-pinterest-bot

Pull Request — master (#220)

CurlHttpClient::useProxy() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like