XRobotsTagParser::selectHeaderSource() - Code Metrics - Inspection of "Adapters + Refactoring" - VIPnytt/RobotsTagParser - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9b56e4...2c514d )

by Jan-Petter

created 2016-04-07 18:43 UTC

XRobotsTagParser::selectHeaderSource() A

↳ Parent: XRobotsTagParser

Complexity

Conditions	3
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	0

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

<?php
namespace vipnytt;

/**
 * X-Robots-Tag HTTP header parser class
 *
 * @author VIP nytt ([email protected])
 * @author Jan-Petter Gundersen ([email protected])
 *
 * Project:
 * @link https://github.com/VIPnytt/X-Robots-Tag-parser
 * @license https://opensource.org/licenses/MIT MIT license
 *
 * Specification:
 * @link https://developers.google.com/webmasters/control-crawl-index/docs/robots_meta_tag#using-the-x-robots-tag-http-header
 */

use vipnytt\XRobotsTagParser\Exceptions\XRobotsTagParserException;
use vipnytt\XRobotsTagParser\Rebuild;
use vipnytt\XRobotsTagParser\UserAgentParser;

class XRobotsTagParser
{
    const HEADER_RULE_IDENTIFIER = 'X-Robots-Tag';

    const DIRECTIVE_ALL = 'all';
    const DIRECTIVE_NONE = 'none';
    const DIRECTIVE_NO_ARCHIVE = 'noarchive';
    const DIRECTIVE_NO_FOLLOW = 'nofollow';
    const DIRECTIVE_NO_IMAGE_INDEX = 'noimageindex';
    const DIRECTIVE_NO_INDEX = 'noindex';
    const DIRECTIVE_NO_ODP = 'noodp';
    const DIRECTIVE_NO_SNIPPET = 'nosnippet';
    const DIRECTIVE_NO_TRANSLATE = 'notranslate';
    const DIRECTIVE_UNAVAILABLE_AFTER = 'unavailable_after';

    protected $userAgent = '';
    protected $userAgentMatch = '';

    protected $currentRule = '';
    protected $currentUserAgent;

    protected $rules = [];

    /**
     * Constructor
     *
     * @param string $userAgent
     * @param array $headers
     */
    public function __construct($userAgent = '', $headers = null)
    {
        $this->userAgent = $userAgent;
        if (isset($headers)) {
            $this->parse($headers);
        }
    }

    /**
     * Parse HTTP headers
     *
     * @param array $headers
     * @return void
     */
    public function parse(array $headers)
    {
        foreach ($headers as $header) {
            $parts = array_map('trim', explode(':', mb_strtolower($header), 2));
            if (count($parts) < 2 || $parts[0] != mb_strtolower(self::HEADER_RULE_IDENTIFIER)) {
                // Header is not a rule
                continue;
            }
            $this->currentRule = $parts[1];
            $this->detectDirectives();
        }
        $userAgentParser = new UserAgentParser($this->userAgent);
        $this->userAgentMatch = $userAgentParser->match(array_keys($this->rules), '');
class Id
{
    public $id;

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

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
    }

    /**
     * Detect directives in rule
     *
     * @return void
     */
    protected function detectDirectives()
    {
        $directives = array_map('trim', explode(',', $this->currentRule));
        $pair = array_map('trim', explode(':', $directives[0], 2));
        if (count($pair) == 2 && !in_array($pair[0], array_keys($this->directiveClasses()))) {
            $this->currentUserAgent = $pair[0];
            $directives[0] = $pair[1];
        }
        foreach ($directives as $rule) {
            $directive = trim(explode(':', $rule, 2)[0]);
            if (in_array($directive, array_keys($this->directiveClasses()))) {
                $this->addRule($directive);
            }
        }
        $this->cleanup();
    }

    /**
     * Array of directives and their class names
     *
     * @return array
     */
    protected function directiveClasses()
    {
        return [
            self::DIRECTIVE_ALL => 'All',
            self::DIRECTIVE_NO_ARCHIVE => 'NoArchive',
            self::DIRECTIVE_NO_FOLLOW => 'NoFollow',
            self::DIRECTIVE_NO_IMAGE_INDEX => 'NoImageIndex',
            self::DIRECTIVE_NO_INDEX => 'NoIndex',
            self::DIRECTIVE_NONE => 'None',
            self::DIRECTIVE_NO_ODP => 'NoODP',
            self::DIRECTIVE_NO_SNIPPET => 'NoSnippet',
            self::DIRECTIVE_NO_TRANSLATE => 'NoTranslate',
            self::DIRECTIVE_UNAVAILABLE_AFTER => 'UnavailableAfter',
        ];
    }

    /**
     * Add rule
     *
     * @param string $directive
     * @return void
     * @throws XRobotsTagParserException
     */
    protected function addRule($directive)
    {
        if (!isset($this->rules[$this->currentUserAgent])) {
            $this->rules[$this->currentUserAgent] = [];
        }
        $class = "\\" . __CLASS__ . "\\directives\\" . $this->directiveClasses()[$directive];
        $object = new $class($this->currentRule);
        if (!$object instanceof XRobotsTagParser\directives\directiveInterface) {
            throw new XRobotsTagParserException('Unsupported directive class');
        }
        $this->rules[$this->currentUserAgent] = array_merge($this->rules[$this->currentUserAgent], [$object->getDirective() => $object->getValue()]);
    }

    /**
     * Cleanup before next rule is read
     *
     * @return void
     */
    protected function cleanup()
    {
        $this->currentRule = '';
        $this->currentUserAgent = '';
    }

    /**
     * Return all applicable rules
     *
     * @param bool $raw
     * @return array
     */
    public function getRules($raw = false)
    {
        $rules = [];
        // Default UserAgent
        if (isset($this->rules[''])) {
            $rules = array_merge($rules, $this->rules['']);
        }
        // Matching UserAgent
        if (isset($this->rules[$this->userAgentMatch])) {
            $rules = array_merge($rules, $this->rules[$this->userAgentMatch]);
        }
        if (!$raw) {
            $rebuild = new Rebuild($rules);
            $rules = $rebuild->getResult();
        }
        // Result
        return $rules;
    }

    /**
     * Export all rules for all UserAgents
     *
     * @return array
     */
    public function export()
    {
        return $this->rules;
    }

    /**
     * Get the meaning of an Directive
     *
     * @param string $directive
     * @return string
     * @throws XRobotsTagParserException
     */
    public function getDirectiveMeaning($directive)
    {
        if (!in_array($directive, array_keys($this->directiveClasses()))) {
            throw new XRobotsTagParserException('Unknown directive');
        }
        $class = "\\" . __CLASS__ . "\\directives\\" . $this->directiveClasses()[$directive];
        $object = new $class($this->directiveClasses()[$directive]);
        if (!$object instanceof XRobotsTagParser\directives\directiveInterface) {
            throw new XRobotsTagParserException('Unsupported directive class');
        }
        return $object->getMeaning();
    }
}


1			<?php
2			namespace vipnytt;
3
4			/**
5			* X-Robots-Tag HTTP header parser class
6			*
7			* @author VIP nytt ([email protected])
8			* @author Jan-Petter Gundersen ([email protected])
9			*
10			* Project:
11			* @link https://github.com/VIPnytt/X-Robots-Tag-parser
12			* @license https://opensource.org/licenses/MIT MIT license
13			*
14			* Specification:
15			* @link https://developers.google.com/webmasters/control-crawl-index/docs/robots_meta_tag#using-the-x-robots-tag-http-header
16			*/
17
18			use vipnytt\XRobotsTagParser\Exceptions\XRobotsTagParserException;
19			use vipnytt\XRobotsTagParser\Rebuild;
20			use vipnytt\XRobotsTagParser\UserAgentParser;
21
22			class XRobotsTagParser
23			{
24			const HEADER_RULE_IDENTIFIER = 'X-Robots-Tag';
25
26			const DIRECTIVE_ALL = 'all';
27			const DIRECTIVE_NONE = 'none';
28			const DIRECTIVE_NO_ARCHIVE = 'noarchive';
29			const DIRECTIVE_NO_FOLLOW = 'nofollow';
30			const DIRECTIVE_NO_IMAGE_INDEX = 'noimageindex';
31			const DIRECTIVE_NO_INDEX = 'noindex';
32			const DIRECTIVE_NO_ODP = 'noodp';
33			const DIRECTIVE_NO_SNIPPET = 'nosnippet';
34			const DIRECTIVE_NO_TRANSLATE = 'notranslate';
35			const DIRECTIVE_UNAVAILABLE_AFTER = 'unavailable_after';
36
37			protected $userAgent = '';
38			protected $userAgentMatch = '';
39
40			protected $currentRule = '';
41			protected $currentUserAgent;
42
43			protected $rules = [];
44
45			/**
46			* Constructor
47			*
48			* @param string $userAgent
49			* @param array $headers
50			*/
51			public function __construct($userAgent = '', $headers = null)
52			{
53			$this->userAgent = $userAgent;
54			if (isset($headers)) {
55			$this->parse($headers);
56			}
57			}
58
59			/**
60			* Parse HTTP headers
61			*
62			* @param array $headers
63			* @return void
64			*/
65			public function parse(array $headers)
66			{
67			foreach ($headers as $header) {
68			$parts = array_map('trim', explode(':', mb_strtolower($header), 2));
69			if (count($parts) < 2 \|\| $parts[0] != mb_strtolower(self::HEADER_RULE_IDENTIFIER)) {
70			// Header is not a rule
71			continue;
72			}
73			$this->currentRule = $parts[1];
74			$this->detectDirectives();
75			}
76			$userAgentParser = new UserAgentParser($this->userAgent);
77			$this->userAgentMatch = $userAgentParser->match(array_keys($this->rules), '');
			0 ignored issues – show Documentation Bug introduced 2016-04-07 18:45 UTC by Report Bug Copy Issue Report It seems like `$userAgentParser->match(...keys($this->rules), '')` can also be of type `false`. However, the property `$userAgentMatch` is declared as type `string`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
78			}
79
80			/**
81			* Detect directives in rule
82			*
83			* @return void
84			*/
85			protected function detectDirectives()
86			{
87			$directives = array_map('trim', explode(',', $this->currentRule));
88			$pair = array_map('trim', explode(':', $directives[0], 2));
89			if (count($pair) == 2 && !in_array($pair[0], array_keys($this->directiveClasses()))) {
90			$this->currentUserAgent = $pair[0];
91			$directives[0] = $pair[1];
92			}
93			foreach ($directives as $rule) {
94			$directive = trim(explode(':', $rule, 2)[0]);
95			if (in_array($directive, array_keys($this->directiveClasses()))) {
96			$this->addRule($directive);
97			}
98			}
99			$this->cleanup();
100			}
101
102			/**
103			* Array of directives and their class names
104			*
105			* @return array
106			*/
107			protected function directiveClasses()
108			{
109			return [
110			self::DIRECTIVE_ALL => 'All',
111			self::DIRECTIVE_NO_ARCHIVE => 'NoArchive',
112			self::DIRECTIVE_NO_FOLLOW => 'NoFollow',
113			self::DIRECTIVE_NO_IMAGE_INDEX => 'NoImageIndex',
114			self::DIRECTIVE_NO_INDEX => 'NoIndex',
115			self::DIRECTIVE_NONE => 'None',
116			self::DIRECTIVE_NO_ODP => 'NoODP',
117			self::DIRECTIVE_NO_SNIPPET => 'NoSnippet',
118			self::DIRECTIVE_NO_TRANSLATE => 'NoTranslate',
119			self::DIRECTIVE_UNAVAILABLE_AFTER => 'UnavailableAfter',
120			];
121			}
122
123			/**
124			* Add rule
125			*
126			* @param string $directive
127			* @return void
128			* @throws XRobotsTagParserException
129			*/
130			protected function addRule($directive)
131			{
132			if (!isset($this->rules[$this->currentUserAgent])) {
133			$this->rules[$this->currentUserAgent] = [];
134			}
135			$class = "\\" . __CLASS__ . "\\directives\\" . $this->directiveClasses()[$directive];
136			$object = new $class($this->currentRule);
137			if (!$object instanceof XRobotsTagParser\directives\directiveInterface) {
138			throw new XRobotsTagParserException('Unsupported directive class');
139			}
140			$this->rules[$this->currentUserAgent] = array_merge($this->rules[$this->currentUserAgent], [$object->getDirective() => $object->getValue()]);
141			}
142
143			/**
144			* Cleanup before next rule is read
145			*
146			* @return void
147			*/
148			protected function cleanup()
149			{
150			$this->currentRule = '';
151			$this->currentUserAgent = '';
152			}
153
154			/**
155			* Return all applicable rules
156			*
157			* @param bool $raw
158			* @return array
159			*/
160			public function getRules($raw = false)
161			{
162			$rules = [];
163			// Default UserAgent
164			if (isset($this->rules[''])) {
165			$rules = array_merge($rules, $this->rules['']);
166			}
167			// Matching UserAgent
168			if (isset($this->rules[$this->userAgentMatch])) {
169			$rules = array_merge($rules, $this->rules[$this->userAgentMatch]);
170			}
171			if (!$raw) {
172			$rebuild = new Rebuild($rules);
173			$rules = $rebuild->getResult();
174			}
175			// Result
176			return $rules;
177			}
178
179			/**
180			* Export all rules for all UserAgents
181			*
182			* @return array
183			*/
184			public function export()
185			{
186			return $this->rules;
187			}
188
189			/**
190			* Get the meaning of an Directive
191			*
192			* @param string $directive
193			* @return string
194			* @throws XRobotsTagParserException
195			*/
196			public function getDirectiveMeaning($directive)
197			{
198			if (!in_array($directive, array_keys($this->directiveClasses()))) {
199			throw new XRobotsTagParserException('Unknown directive');
200			}
201			$class = "\\" . __CLASS__ . "\\directives\\" . $this->directiveClasses()[$directive];
202			$object = new $class($this->directiveClasses()[$directive]);
203			if (!$object instanceof XRobotsTagParser\directives\directiveInterface) {
204			throw new XRobotsTagParserException('Unsupported directive class');
205			}
206			return $object->getMeaning();
207			}
208			}
209

VIPnytt / RobotsTagParser

Push — master ( 9b56e4...2c514d )

XRobotsTagParser::selectHeaderSource() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like