vipnytt\RobotsTxtParser\URI

Complexity

Total Complexity

16

Size/Duplication

Total Lines	192
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	3
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	27	2
A	headerEncoding()	0	7	2
A	parseHeader()	0	11	4
A	headerMaxAge()	0	7	2
A	getBaseUri()	0	4	1
A	getStatusCode()	0	4	1
A	getContents()	0	4	1
A	getEncoding()	0	4	1
A	nextUpdate()	0	4	1
A	validUntil()	0	4	1

<?php
namespace vipnytt\RobotsTxtParser;

use GuzzleHttp;

/**
 * Class ClientURI
 *
 * @package vipnytt\RobotsTxtParser
 */
class URI extends Basic
{
    const GUZZLE_HTTP_CONFIG = [
        'allow_redirects' => [
            'max' => self::MAX_REDIRECTS,
            'referer' => true,
            'strict' => true,
        ],
        'decode_content' => true,
        'headers' => [
            'Accept' => 'text/plain;q=1.0, text/*;q=0.8, */*;q=0.1',
            'Accept-Charset' => 'utf-8;q=1.0, *;q=0.1',
            'Accept-Encoding' => 'identity;q=1.0, *;q=0.1',
            'User-Agent' => 'RobotsTxtParser-VIPnytt/2.0 (+https://github.com/VIPnytt/RobotsTxtParser/blob/master/README.md)',
        ],
        'http_errors' => false,
        'verify' => true,
    ];

    /**
     * Status code
     * @var int
     */
    protected $statusCode;

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

    /**
     * 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 $guzzleConfig
     * @param int|null $byteLimit
     */
    public function __construct($baseUri, array $guzzleConfig = [], $byteLimit = self::BYTE_LIMIT)
    {
        $baseUri = $this->urlBase($this->urlEncode($baseUri));
        try {
            $client = new GuzzleHttp\Client(
                array_merge_recursive(
                    self::GUZZLE_HTTP_CONFIG,
                    $guzzleConfig,
                    [
                        'base_uri' => $baseUri,
                    ]
                )
            );
            $response = $client->request('GET', self::PATH);
            $this->time = time();
            $this->statusCode = $response->getStatusCode();
            $this->contents = $response->getBody()->getContents();
            $this->encoding = $this->headerEncoding($response->getHeader('content-type'));
            $this->maxAge = $this->headerMaxAge($response->getHeader('cache-control'));
        } catch (GuzzleHttp\Exception\TransferException $e) {
            $this->statusCode = 523;
            $this->contents = '';
            $this->encoding = self::ENCODING;
            $this->maxAge = 0;
        }
        parent::__construct($baseUri, $this->statusCode, $this->contents, $this->encoding, $byteLimit);
    }

    /**
     * Content-Type encoding HTTP header
     *
     * @param string[] $headers
     * @return string
     */
    private function headerEncoding(array $headers)
    {
        if (($value = $this->parseHeader($headers, 'charset', ';')) !== false) {
            return $value;
        }
        return self::ENCODING;
    }

    /**
     * Client header
     *
     * @param string[] $headers
     * @param string $part
     * @param string $delimiter
     * @return string|false
     */
    private function parseHeader(array $headers, $part, $delimiter = ";")
    {
        foreach ($headers as $header) {
            foreach (array_map('trim', mb_split($delimiter, $header)) as $string) {
                if (mb_stripos($string, $part . '=') === 0) {
                    return mb_split('=', $string, 2)[1];
                }
            }
        }
        return false;
    }

    /**
     * Cache-Control max-age HTTP header
     *
     * @param string[] $headers
     * @return int
     */
    private function headerMaxAge(array $headers)
    {
        if (($value = $this->parseHeader($headers, 'max-age', ',')) !== false) {
            return intval($value);
        }
        return 0;
    }

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

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

    /**
     * URL 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()
    {
        return $this->time + self::CACHE_TIME;
    }

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