SitemapParser::addArray() - Code Metrics - Inspection of "Strict standards option" - VIPnytt/SitemapParser - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6e711f...768f08 )

by Jan-Petter

created 2016-04-05 00:36 UTC

SitemapParser::addArray() B

↳ Parent: SitemapParser

Complexity

Conditions	5
Paths	4

Size

Total Lines	14
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

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

<?php
namespace vipnytt;

use GuzzleHttp;
use SimpleXMLElement;
use vipnytt\SitemapParser\Exceptions\SitemapParserException;

/**
 * SitemapParser class
 *
 * @license https://opensource.org/licenses/MIT MIT license
 * @link https://github.com/VIPnytt/SitemapParser
 *
 * Specifications:
 * @link http://www.sitemaps.org/protocol.html
 */
class SitemapParser
{
    /**
     * User-Agent to send with every HTTP(S) request
     * @var string
     */
    protected $userAgent;

    /**
     * Configuration options
     * @var array
     */
    protected $config = [];

    /**
     * Sitemaps discovered
     * @var array
     */
    protected $sitemaps = [];

    /**
     * URLs discovered
     * @var array
     */
    protected $urls = [];

    /**
     * Sitemap URLs discovered but not yet parsed
     * @var array
     */
    protected $queue = [];

    /**
     * Parsed URLs history
     * @var array
     */
    protected $history = [];

    /**
     * Current URL being parsed
     * @var null|string
     */
    protected $currentURL;

    /**
     * Constructor
     *
     * @param string $userAgent User-Agent to send with every HTTP(S) request
     * @param array $config Configuration options
     * @throws SitemapParserException
     */
    public function __construct($userAgent = 'SitemapParser', $config = [])
    {
        if (!extension_loaded('simplexml')) {
            throw new SitemapParserException('The extension `simplexml` must be installed and loaded for this library');
        }
        if (!extension_loaded('mbstring')) {
            throw new SitemapParserException('The extension `mbstring` must be installed and loaded for this library');
        }
        mb_language("uni");
        if (!mb_internal_encoding('UTF-8')) {
            throw new SitemapParserException('Unable to set internal character encoding to UTF-8');
        }
        $this->userAgent = (isset($config['user-agent'])) ? $config['user-agent'] : $userAgent;
        $this->config = $config;
    }

    /**
     * Parse Recursive
     *
     * @param string $url
     * @return void
     * @throws SitemapParserException
     */
    public function parseRecursive($url)
    {
        $this->addToQueue([$url]);
        while (count($todo = $this->getQueue()) > 0) {
            $sitemaps = $this->sitemaps;
            $urls = $this->urls;
            $this->parse($todo[0]);
            $this->sitemaps = array_merge_recursive($sitemaps, $this->sitemaps);
            $this->urls = array_merge_recursive($urls, $this->urls);
        }
    }

    /**
     * Add an array of URLs to the parser queue
     *
     * @param array $urlArray
     */
    public function addToQueue($urlArray)
    {
        foreach ($urlArray as $url) {
            $this->queue[] = $url;
        }
    }

    /**
     * Sitemap URLs discovered but not yet parsed
     *
     * @return array
     */
    public function getQueue()
    {
        $this->queue = array_values(array_diff(array_unique(array_merge($this->queue, array_keys($this->sitemaps))), $this->history));
        return $this->queue;
    }

    /**
     * Parse
     *
     * @param string $url URL to parse
     * @param string|null $urlContent URL body content (skip download)
     * @return void
     * @throws SitemapParserException
     */
    public function parse($url, $urlContent = null)
    {
        $this->clean();
        $this->currentURL = $url;
        $response = (is_string($urlContent)) ? $urlContent : $this->getContent();
        $this->history[] = $this->currentURL;
        if (parse_url($this->currentURL, PHP_URL_PATH) == '/robots.txt') {
            $this->parseRobotstxt($response);
            return;
        }
        // Check if content is an gzip file
        if (mb_strpos($response, "\x1f\x8b\x08", 0, "US-ASCII") === 0) {
            $response = gzdecode($response);
        }
        $sitemapJson = $this->generateXMLObject($response);
        if ($sitemapJson instanceof SimpleXMLElement === false) {
            $this->parseString($response);
            return;
        }
        if (isset($sitemapJson->sitemap)) {
            $this->parseJson('sitemap', $sitemapJson->sitemap);
        }
        if (isset($sitemapJson->url)) {
            $this->parseJson('url', $sitemapJson->url);
        }
    }

    /**
     * Cleanup between each parse
     *
     * @return void
     */
    protected function clean()
    {
        $this->sitemaps = [];
        $this->urls = [];
    }

    /**
     * Request the body content of an URL
     *
     * @return string Raw body content
     * @throws SitemapParserException
     */
    protected function getContent()
    {
        if (!filter_var($this->currentURL, FILTER_VALIDATE_URL)) {
            throw new SitemapParserException('Passed URL not valid according to filter_var function');
        }
        try {
            if (!isset($this->config['guzzle']['headers']['User-Agent'])) {
                $this->config['guzzle']['headers']['User-Agent'] = $this->userAgent;
            }
            $client = new GuzzleHttp\Client();
            $res = $client->request('GET', $this->currentURL, $this->config['guzzle']);
            return $res->getBody();
        } catch (GuzzleHttp\Exception\TransferException $e) {
            throw new SitemapParserException($e->getMessage());
        }
    }

    /**
     * Search for sitemaps in the robots.txt content
     *
     * @param string $robotstxt
     * @return void
     */
    protected function parseRobotstxt($robotstxt)
    {
        preg_match_all('#Sitemap:*(.*)#', $robotstxt, $match);
        if (isset($match[1])) {
            foreach ($match[1] as $sitemap) {
                $sitemap = trim($sitemap);
                $this->addArray('sitemap', ['loc' => $sitemap]);
            }
        }
    }

    /**
     * Validate URL arrays and add them to their corresponding arrays
     *
     * @param string $type sitemap|url
     * @param array $array Tag array
     * @return bool
     */
    protected function addArray($type, $array)
    {
        if (isset($array['loc']) && filter_var($array['loc'], FILTER_VALIDATE_URL) !== false) {
            switch ($type) {
                case 'sitemap':
                    $this->sitemaps[$array['loc']] = $array;
                    return true;
                case 'url':
                    $this->urls[$array['loc']] = $array;
                    return true;
            }
        }
        return false;
    }

    /**
     * Generate the \SimpleXMLElement object if the XML is valid
     *
     * @param string $xml
     * @return \SimpleXMLElement|false
     */
    protected function generateXMLObject($xml)
    {
        try {
            libxml_use_internal_errors(true);
            return new SimpleXMLElement($xml, LIBXML_NOCDATA);
        } catch (\Exception $e) {
            return false;
        }
    }

    /**
     * Parse plain text
     *
     * @param string $string
     * @return bool
     */
    protected function parseString($string)
    {
        if ($this->config['strict']) {
            // Strings are not part of any sitemap standard
            return false;
        }
        $offset = 0;
        while (preg_match('/(\S+)/', $string, $match, PREG_OFFSET_CAPTURE, $offset)) {
            $offset = $match[0][1] + strlen($match[0][0]);
            if (filter_var($match[0][0], FILTER_VALIDATE_URL) !== false) {
                if ($this->isSitemapURL($match[0][0])) {
                    $this->addArray('sitemap', ['loc' => $match[0][0]]);
                    continue;
                }
                $this->addArray('url', ['loc' => $match[0][0]]);
            }
        }
        return true;
    }

    /**
     * Check if the URL may contain an Sitemap
     *
     * @param string $url
     * @return bool
     */
    protected function isSitemapURL($url)
    {
        $path = parse_url($url, PHP_URL_PATH);
        return filter_var($url, FILTER_VALIDATE_URL) !== false && (
            substr($path, -4) === ".xml" ||
            substr($path, -7) === '.xml.gz'
        );
    }

    /**
     * Parse Json object
     *
     * @param string $type Sitemap or URL
     * @param \SimpleXMLElement $json object
     * @return void
     */
    protected function parseJson($type, $json)
    {
        foreach ($json as $url) {
            $this->addArray($type, (array)$url);
        }
    }

    /**
     * Strict standards
     * Limit parsing to XML documents and robots.txt only
     *
     * @param bool $bool
     * @return void
     */
    public function setStrict($bool = true)
    {
        $this->config['strict'] = $bool;
    }

    /**
     * Sitemaps discovered
     *
     * @return array
     */
    public function getSitemaps()
    {
        return $this->sitemaps;
    }

    /**
     * URLs discovered
     *
     * @return array
     */
    public function getURLs()
    {
        return $this->urls;
    }
}


1			<?php
2			namespace vipnytt;
3
4			use GuzzleHttp;
5			use SimpleXMLElement;
6			use vipnytt\SitemapParser\Exceptions\SitemapParserException;
7
8			/**
9			* SitemapParser class
10			*
11			* @license https://opensource.org/licenses/MIT MIT license
12			* @link https://github.com/VIPnytt/SitemapParser
13			*
14			* Specifications:
15			* @link http://www.sitemaps.org/protocol.html
16			*/
17			class SitemapParser
18			{
19			/**
20			* User-Agent to send with every HTTP(S) request
21			* @var string
22			*/
23			protected $userAgent;
24
25			/**
26			* Configuration options
27			* @var array
28			*/
29			protected $config = [];
30
31			/**
32			* Sitemaps discovered
33			* @var array
34			*/
35			protected $sitemaps = [];
36
37			/**
38			* URLs discovered
39			* @var array
40			*/
41			protected $urls = [];
42
43			/**
44			* Sitemap URLs discovered but not yet parsed
45			* @var array
46			*/
47			protected $queue = [];
48
49			/**
50			* Parsed URLs history
51			* @var array
52			*/
53			protected $history = [];
54
55			/**
56			* Current URL being parsed
57			* @var null\|string
58			*/
59			protected $currentURL;
60
61			/**
62			* Constructor
63			*
64			* @param string $userAgent User-Agent to send with every HTTP(S) request
65			* @param array $config Configuration options
66			* @throws SitemapParserException
67			*/
68			public function __construct($userAgent = 'SitemapParser', $config = [])
69			{
70			if (!extension_loaded('simplexml')) {
71			throw new SitemapParserException('The extension `simplexml` must be installed and loaded for this library');
72			}
73			if (!extension_loaded('mbstring')) {
74			throw new SitemapParserException('The extension `mbstring` must be installed and loaded for this library');
75			}
76			mb_language("uni");
77			if (!mb_internal_encoding('UTF-8')) {
78			throw new SitemapParserException('Unable to set internal character encoding to UTF-8');
79			}
80			$this->userAgent = (isset($config['user-agent'])) ? $config['user-agent'] : $userAgent;
81			$this->config = $config;
82			}
83
84			/**
85			* Parse Recursive
86			*
87			* @param string $url
88			* @return void
89			* @throws SitemapParserException
90			*/
91			public function parseRecursive($url)
92			{
93			$this->addToQueue([$url]);
94			while (count($todo = $this->getQueue()) > 0) {
95			$sitemaps = $this->sitemaps;
96			$urls = $this->urls;
97			$this->parse($todo[0]);
98			$this->sitemaps = array_merge_recursive($sitemaps, $this->sitemaps);
99			$this->urls = array_merge_recursive($urls, $this->urls);
100			}
101			}
102
103			/**
104			* Add an array of URLs to the parser queue
105			*
106			* @param array $urlArray
107			*/
108			public function addToQueue($urlArray)
109			{
110			foreach ($urlArray as $url) {
111			$this->queue[] = $url;
112			}
113			}
114
115			/**
116			* Sitemap URLs discovered but not yet parsed
117			*
118			* @return array
119			*/
120			public function getQueue()
121			{
122			$this->queue = array_values(array_diff(array_unique(array_merge($this->queue, array_keys($this->sitemaps))), $this->history));
123			return $this->queue;
124			}
125
126			/**
127			* Parse
128			*
129			* @param string $url URL to parse
130			* @param string\|null $urlContent URL body content (skip download)
131			* @return void
132			* @throws SitemapParserException
133			*/
134			public function parse($url, $urlContent = null)
135			{
136			$this->clean();
137			$this->currentURL = $url;
138			$response = (is_string($urlContent)) ? $urlContent : $this->getContent();
139			$this->history[] = $this->currentURL;
140			if (parse_url($this->currentURL, PHP_URL_PATH) == '/robots.txt') {
141			$this->parseRobotstxt($response);
142			return;
143			}
144			// Check if content is an gzip file
145			if (mb_strpos($response, "\x1f\x8b\x08", 0, "US-ASCII") === 0) {
146			$response = gzdecode($response);
147			}
148			$sitemapJson = $this->generateXMLObject($response);
149			if ($sitemapJson instanceof SimpleXMLElement === false) {
150			$this->parseString($response);
151			return;
152			}
153			if (isset($sitemapJson->sitemap)) {
154			$this->parseJson('sitemap', $sitemapJson->sitemap);
155			}
156			if (isset($sitemapJson->url)) {
157			$this->parseJson('url', $sitemapJson->url);
158			}
159			}
160
161			/**
162			* Cleanup between each parse
163			*
164			* @return void
165			*/
166			protected function clean()
167			{
168			$this->sitemaps = [];
169			$this->urls = [];
170			}
171
172			/**
173			* Request the body content of an URL
174			*
175			* @return string Raw body content
176			* @throws SitemapParserException
177			*/
178			protected function getContent()
179			{
180			if (!filter_var($this->currentURL, FILTER_VALIDATE_URL)) {
181			throw new SitemapParserException('Passed URL not valid according to filter_var function');
182			}
183			try {
184			if (!isset($this->config['guzzle']['headers']['User-Agent'])) {
185			$this->config['guzzle']['headers']['User-Agent'] = $this->userAgent;
186			}
187			$client = new GuzzleHttp\Client();
188			$res = $client->request('GET', $this->currentURL, $this->config['guzzle']);
189			return $res->getBody();
190			} catch (GuzzleHttp\Exception\TransferException $e) {
191			throw new SitemapParserException($e->getMessage());
192			}
193			}
194
195			/**
196			* Search for sitemaps in the robots.txt content
197			*
198			* @param string $robotstxt
199			* @return void
200			*/
201			protected function parseRobotstxt($robotstxt)
202			{
203			preg_match_all('#Sitemap:(.)#', $robotstxt, $match);
204			if (isset($match[1])) {
205			foreach ($match[1] as $sitemap) {
206			$sitemap = trim($sitemap);
207			$this->addArray('sitemap', ['loc' => $sitemap]);
208			}
209			}
210			}
211
212			/**
213			* Validate URL arrays and add them to their corresponding arrays
214			*
215			* @param string $type sitemap\|url
216			* @param array $array Tag array
217			* @return bool
218			*/
219			protected function addArray($type, $array)
220			{
221			if (isset($array['loc']) && filter_var($array['loc'], FILTER_VALIDATE_URL) !== false) {
222			switch ($type) {
223			case 'sitemap':
224			$this->sitemaps[$array['loc']] = $array;
225			return true;
226			case 'url':
227			$this->urls[$array['loc']] = $array;
228			return true;
229			}
230			}
231			return false;
232			}
233
234			/**
235			* Generate the \SimpleXMLElement object if the XML is valid
236			*
237			* @param string $xml
238			* @return \SimpleXMLElement\|false
239			*/
240			protected function generateXMLObject($xml)
241			{
242			try {
243			libxml_use_internal_errors(true);
244			return new SimpleXMLElement($xml, LIBXML_NOCDATA);
245			} catch (\Exception $e) {
246			return false;
247			}
248			}
249
250			/**
251			* Parse plain text
252			*
253			* @param string $string
254			* @return bool
255			*/
256			protected function parseString($string)
257			{
258			if ($this->config['strict']) {
259			// Strings are not part of any sitemap standard
260			return false;
261			}
262			$offset = 0;
263			while (preg_match('/(\S+)/', $string, $match, PREG_OFFSET_CAPTURE, $offset)) {
264			$offset = $match[0][1] + strlen($match[0][0]);
265			if (filter_var($match[0][0], FILTER_VALIDATE_URL) !== false) {
266			if ($this->isSitemapURL($match[0][0])) {
267			$this->addArray('sitemap', ['loc' => $match[0][0]]);
268			continue;
269			}
270			$this->addArray('url', ['loc' => $match[0][0]]);
271			}
272			}
273			return true;
274			}
275
276			/**
277			* Check if the URL may contain an Sitemap
278			*
279			* @param string $url
280			* @return bool
281			*/
282			protected function isSitemapURL($url)
283			{
284			$path = parse_url($url, PHP_URL_PATH);
285			return filter_var($url, FILTER_VALIDATE_URL) !== false && (
286			substr($path, -4) === ".xml" \|\|
287			substr($path, -7) === '.xml.gz'
288			);
289			}
290
291			/**
292			* Parse Json object
293			*
294			* @param string $type Sitemap or URL
295			* @param \SimpleXMLElement $json object
296			* @return void
297			*/
298			protected function parseJson($type, $json)
299			{
300			foreach ($json as $url) {
301			$this->addArray($type, (array)$url);
302			}
303			}
304
305			/**
306			* Strict standards
307			* Limit parsing to XML documents and robots.txt only
308			*
309			* @param bool $bool
310			* @return void
311			*/
312			public function setStrict($bool = true)
313			{
314			$this->config['strict'] = $bool;
315			}
316
317			/**
318			* Sitemaps discovered
319			*
320			* @return array
321			*/
322			public function getSitemaps()
323			{
324			return $this->sitemaps;
325			}
326
327			/**
328			* URLs discovered
329			*
330			* @return array
331			*/
332			public function getURLs()
333			{
334			return $this->urls;
335			}
336			}
337

VIPnytt / SitemapParser

Push — master ( 6e711f...768f08 )

SitemapParser::addArray() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like