UriClient::validUntil() - Code Metrics - Inspection of "- Refactoring" - VIPnytt/RobotsTxtParser - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0489e6...065a8d )

by Jan-Petter

created 2016-07-05 20:56 UTC

UriClient::validUntil() A

↳ Parent: UriClient

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php
namespace vipnytt\RobotsTxtParser;

use Composer\CaBundle\CaBundle;

/**
 * Class UriClient
 *
 * @package vipnytt\RobotsTxtParser
 */
class UriClient extends TxtClient
{
    /**
     * User-agent
     */
    const CURL_USER_AGENT = 'RobotsTxtParser-VIPnytt/2.0 (+https://github.com/VIPnytt/RobotsTxtParser/blob/master/README.md)';

    /**
     * Base uri
     * @var string
     */
    private $base;

    /**
     * Header parser
     * @var Parser\HeaderParser
     */
    private $headerParser;

    /**
     * RequestClient timestamp
     * @var int
     */
    private $time;

    /**
     * Status code
     * @var int|null
     */
    private $statusCode;


    /**
     * Effective uri
     * @var string
     */
    private $effectiveUri;

    /**
     * Cache-Control max-age
     * @var int
     */
    private $maxAge;

    /**
     * Robots.txt contents
     * @var string
     */
    private $contents;

    /**
     * Robots.txt character encoding
     * @var string
     */
    private $encoding;


    /**
     * RequestClient constructor.
     *
     * @param string $baseUri
     * @param array $curlOptions
     * @param int|null $byteLimit
     */
    public function __construct($baseUri, array $curlOptions = [], $byteLimit = self::BYTE_LIMIT)
    {
        $this->base = $this->urlBase($this->urlEncode($baseUri));
        if ($this->request($curlOptions) === false) {
            $this->time = time();
            $this->effectiveUri = $this->base . self::PATH;
            $this->statusCode = null;
            $this->contents = '';
            $this->encoding = self::ENCODING;
            $this->maxAge = 0;
        }
        parent::__construct($this->base, $this->statusCode, $this->contents, $this->encoding, $this->effectiveUri, $byteLimit);
    }

    /**
     * cURL request
     *
     * @param array $options
     * @return bool
     */
    private function request($options = [])
    {
        $this->headerParser = new Parser\HeaderParser();
        $ch = curl_init();
        curl_setopt_array($ch, [
            CURLOPT_AUTOREFERER => true,
            CURLOPT_CAINFO => CaBundle::getSystemCaRootBundlePath(),
            CURLOPT_CONNECTTIMEOUT => 30,
            CURLOPT_ENCODING => 'identity',
            CURLOPT_FAILONERROR => false,
            CURLOPT_FOLLOWLOCATION => true,
            CURLOPT_FTPSSLAUTH => CURLFTPAUTH_DEFAULT,
            CURLOPT_HEADER => false,
            CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_NONE,
            CURLOPT_IPRESOLVE => CURL_IPRESOLVE_WHATEVER,
            CURLOPT_NOBODY => false,
            CURLOPT_MAXREDIRS => self::MAX_REDIRECTS,
            CURLOPT_RETURNTRANSFER => true,
            CURLOPT_SSL_VERIFYHOST => 2,
            CURLOPT_SSL_VERIFYPEER => true,
            //CURLOPT_SSL_VERIFYSTATUS => true, // PHP 7.0.7
            CURLOPT_TIMEOUT => 120,
            CURLOPT_USERAGENT => self::CURL_USER_AGENT,
            CURLOPT_USERPWD => 'anonymous:',
        ]);
        curl_setopt_array($ch, $options);
        curl_setopt($ch, CURLOPT_HEADERFUNCTION, [$this->headerParser, 'curlCallback']);
        curl_setopt($ch, CURLOPT_URL, $this->base . self::PATH);
        if (($this->contents = curl_exec($ch)) === false) {
            return false;
        }
        $this->time = time();
        $this->statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE); // also works with FTP status codes
        $this->effectiveUri = curl_getinfo($ch, CURLINFO_EFFECTIVE_URL);
        curl_close($ch);
        $this->encoding = $this->headerParser->getCharset();
        $this->maxAge = $this->headerParser->getMaxAge();
        return true;
    }

    /**
     * Base uri
     *
     * @return string
     */
    public function getBaseUri()
    {
        return $this->base;
    }

    /**
     * Effective uri
     *
     * @return string
     */
    public function getEffectiveUri()
    {
        return $this->effectiveUri;
    }

    /**
     * Status code
     *
     * @return int|null
     */
    public function getStatusCode()
    {
        return $this->statusCode;
    }

    /**
     * Body content
     *
     * @return string
     */
    public function getContents()
    {
        return $this->contents;
    }

    /**
     * Encoding
     *
     * @return string
     */
    public function getEncoding()
    {
        return $this->encoding;
    }

    /**
     * Next update timestamp
     *
     * @return int
     */
    public function nextUpdate()
    {
        if ($this->statusCode === 503) {
            return $this->time + min(self::CACHE_TIME, $this->headerParser->getRetryAfter($this->time));
        }
        return $this->time + self::CACHE_TIME;
    }

    /**
     * Valid until timestamp
     *
     * @return int
     */
    public function validUntil()
    {
        return $this->time + max(self::CACHE_TIME, $this->maxAge);
    }
}


1			<?php
2			namespace vipnytt\RobotsTxtParser;
3
4			use Composer\CaBundle\CaBundle;
5
6			/**
7			* Class UriClient
8			*
9			* @package vipnytt\RobotsTxtParser
10			*/
11			class UriClient extends TxtClient
12			{
13			/**
14			* User-agent
15			*/
16			const CURL_USER_AGENT = 'RobotsTxtParser-VIPnytt/2.0 (+https://github.com/VIPnytt/RobotsTxtParser/blob/master/README.md)';
17
18			/**
19			* Base uri
20			* @var string
21			*/
22			private $base;
23
24			/**
25			* Header parser
26			* @var Parser\HeaderParser
27			*/
28			private $headerParser;
29
30			/**
31			* RequestClient timestamp
32			* @var int
33			*/
34			private $time;
35
36			/**
37			* Status code
38			* @var int\|null
39			*/
40			private $statusCode;
			0 ignored issues – show Comprehensibility introduced 2016-07-05 21:00 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
41
42			/**
43			* Effective uri
44			* @var string
45			*/
46			private $effectiveUri;
47
48			/**
49			* Cache-Control max-age
50			* @var int
51			*/
52			private $maxAge;
53
54			/**
55			* Robots.txt contents
56			* @var string
57			*/
58			private $contents;
59
60			/**
61			* Robots.txt character encoding
62			* @var string
63			*/
64			private $encoding;
			0 ignored issues – show Comprehensibility introduced 2016-07-05 21:00 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
65
66			/**
67			* RequestClient constructor.
68			*
69			* @param string $baseUri
70			* @param array $curlOptions
71			* @param int\|null $byteLimit
72			*/
73			public function __construct($baseUri, array $curlOptions = [], $byteLimit = self::BYTE_LIMIT)
74			{
75			$this->base = $this->urlBase($this->urlEncode($baseUri));
76			if ($this->request($curlOptions) === false) {
77			$this->time = time();
78			$this->effectiveUri = $this->base . self::PATH;
79			$this->statusCode = null;
80			$this->contents = '';
81			$this->encoding = self::ENCODING;
82			$this->maxAge = 0;
83			}
84			parent::__construct($this->base, $this->statusCode, $this->contents, $this->encoding, $this->effectiveUri, $byteLimit);
85			}
86
87			/**
88			* cURL request
89			*
90			* @param array $options
91			* @return bool
92			*/
93			private function request($options = [])
94			{
95			$this->headerParser = new Parser\HeaderParser();
96			$ch = curl_init();
97			curl_setopt_array($ch, [
98			CURLOPT_AUTOREFERER => true,
99			CURLOPT_CAINFO => CaBundle::getSystemCaRootBundlePath(),
100			CURLOPT_CONNECTTIMEOUT => 30,
101			CURLOPT_ENCODING => 'identity',
102			CURLOPT_FAILONERROR => false,
103			CURLOPT_FOLLOWLOCATION => true,
104			CURLOPT_FTPSSLAUTH => CURLFTPAUTH_DEFAULT,
105			CURLOPT_HEADER => false,
106			CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_NONE,
107			CURLOPT_IPRESOLVE => CURL_IPRESOLVE_WHATEVER,
108			CURLOPT_NOBODY => false,
109			CURLOPT_MAXREDIRS => self::MAX_REDIRECTS,
110			CURLOPT_RETURNTRANSFER => true,
111			CURLOPT_SSL_VERIFYHOST => 2,
112			CURLOPT_SSL_VERIFYPEER => true,
113			//CURLOPT_SSL_VERIFYSTATUS => true, // PHP 7.0.7
114			CURLOPT_TIMEOUT => 120,
115			CURLOPT_USERAGENT => self::CURL_USER_AGENT,
116			CURLOPT_USERPWD => 'anonymous:',
117			]);
118			curl_setopt_array($ch, $options);
119			curl_setopt($ch, CURLOPT_HEADERFUNCTION, [$this->headerParser, 'curlCallback']);
120			curl_setopt($ch, CURLOPT_URL, $this->base . self::PATH);
121			if (($this->contents = curl_exec($ch)) === false) {
122			return false;
123			}
124			$this->time = time();
125			$this->statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE); // also works with FTP status codes
126			$this->effectiveUri = curl_getinfo($ch, CURLINFO_EFFECTIVE_URL);
127			curl_close($ch);
128			$this->encoding = $this->headerParser->getCharset();
129			$this->maxAge = $this->headerParser->getMaxAge();
130			return true;
131			}
132
133			/**
134			* Base uri
135			*
136			* @return string
137			*/
138			public function getBaseUri()
139			{
140			return $this->base;
141			}
142
143			/**
144			* Effective uri
145			*
146			* @return string
147			*/
148			public function getEffectiveUri()
149			{
150			return $this->effectiveUri;
151			}
152
153			/**
154			* Status code
155			*
156			* @return int\|null
157			*/
158			public function getStatusCode()
159			{
160			return $this->statusCode;
161			}
162
163			/**
164			* Body content
165			*
166			* @return string
167			*/
168			public function getContents()
169			{
170			return $this->contents;
171			}
172
173			/**
174			* Encoding
175			*
176			* @return string
177			*/
178			public function getEncoding()
179			{
180			return $this->encoding;
181			}
182
183			/**
184			* Next update timestamp
185			*
186			* @return int
187			*/
188			public function nextUpdate()
189			{
190			if ($this->statusCode === 503) {
191			return $this->time + min(self::CACHE_TIME, $this->headerParser->getRetryAfter($this->time));
192			}
193			return $this->time + self::CACHE_TIME;
194			}
195
196			/**
197			* Valid until timestamp
198			*
199			* @return int
200			*/
201			public function validUntil()
202			{
203			return $this->time + max(self::CACHE_TIME, $this->maxAge);
204			}
205			}
206

VIPnytt / RobotsTxtParser

Push — master ( 0489e6...065a8d )

UriClient::validUntil() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like