Browser::detectScriptedAgent() - Code Metrics - Inspection of "Edge versions" - sinergi/php-browser-detector - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Pull Request — master (#85)

by Gabriel

created 2017-04-12 13:03 UTC

Browser::detectScriptedAgent() C

↳ Parent: Browser

Complexity

Conditions	40
Paths	3

Size

Total Lines	50
Code Lines	45

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	1640

Importance

Changes

Metric	Value
dl	0
loc	50
rs	5.1666
c	0
b	0
f	0
ccs	0
cts	14
cp	0
cc	40
eloc	45
nc	3
nop	0
crap	1640

How to fix Complexity

<?php

namespace Sinergi\BrowserDetector;

class Browser
{
    const UNKNOWN = 'unknown';
    const VIVALDI = 'Vivaldi';
    const OPERA = 'Opera';
    const OPERA_MINI = 'Opera Mini';
    const WEBTV = 'WebTV';
    const IE = 'Internet Explorer';
    const POCKET_IE = 'Pocket Internet Explorer';
    const KONQUEROR = 'Konqueror';
    const ICAB = 'iCab';
    const OMNIWEB = 'OmniWeb';
    const FIREBIRD = 'Firebird';
    const FIREFOX = 'Firefox';
    const SEAMONKEY = 'SeaMonkey';
    const ICEWEASEL = 'Iceweasel';
    const SHIRETOKO = 'Shiretoko';
    const MOZILLA = 'Mozilla';
    const AMAYA = 'Amaya';
    const LYNX = 'Lynx';
    const SAFARI = 'Safari';
    const SAMSUNG_BROWSER = 'SamsungBrowser';
    const CHROME = 'Chrome';
    const NAVIGATOR = 'Android Navigator';
    const BLACKBERRY = 'BlackBerry';
    const ICECAT = 'IceCat';
    const NOKIA_S60 = 'Nokia S60 OSS Browser';
    const NOKIA = 'Nokia Browser';
    const MSN = 'MSN Browser';
    const NETSCAPE_NAVIGATOR = 'Netscape Navigator';
    const GALEON = 'Galeon';
    const NETPOSITIVE = 'NetPositive';
    const PHOENIX = 'Phoenix';
    const GSA = 'Google Search Appliance';
    const YANDEX = 'Yandex';
    const EDGE = 'Edge';
    const EDGE_HTML = 'EdgeHTML';
    const DRAGON = 'Dragon';
    const NSPLAYER = 'Windows Media Player';
    const UCBROWSER = 'UC Browser';
    const MICROSOFT_OFFICE = 'Microsoft Office';
    const APPLE_NEWS = 'Apple News';
    const DALVIK = 'Android';

    const VERSION_UNKNOWN = 'unknown';

    /**
     * @var UserAgent
     */
    private $userAgent;

    /**
     * @var string
     */
    private $name;
    /**
     * @var string
     */
    private $version;

    /**
     * @var bool
     */
    private $isChromeFrame = false;

    /**
     * @var bool
     */
    private $isWebkit = false;

    /**
     * @var bool
     */
    private $isFacebookWebView = false;

    /**
     * @var bool
     */
    private $isTwitterWebView = false;

    /**
     * @var bool
     */
    private $isCompatibilityMode = false;

    /**
     * @param null|string|UserAgent $userAgent
     * @throws \Sinergi\BrowserDetector\InvalidArgumentException
     */
    public function __construct($userAgent = null)

    {
        if ($userAgent instanceof UserAgent) {
            $this->setUserAgent($userAgent);
        } elseif (null === $userAgent || is_string($userAgent)) {
            $this->setUserAgent(new UserAgent($userAgent));
        } else {
            throw new InvalidArgumentException();
        }
    }

    /**
     * Set the name of the Browser.
     *
     * @param string $name
     * @return $this
     */
    public function setName($name)
    {
        $this->name = (string)$name;
        return $this;
    }

    /**
     * Return the name of the Browser.
     *
     * @return string
     */
    public function getName()
    {
        if (!isset($this->name)) {
            BrowserDetector::detect($this, $this->getUserAgent());
        }

        return $this->name;
    }

    /**
     * Check to see if the specific browser is valid.
     *
     * @param string $name
     * @return bool
     */
    public function isBrowser($name)
    {
        return (0 == strcasecmp($this->getName(), trim($name)));
    }

    /**
     * Set the version of the browser.
     *
     * @param string $version
     * @return $this
     */
    public function setVersion($version)
    {
        $this->version = (string)$version;
        return $this;
    }

    /**
     * The version of the browser.
     *
     * @return string
     */
    public function getVersion()
    {
        if (!isset($this->name)) {
            BrowserDetector::detect($this, $this->getUserAgent());
        }

        return (string) $this->version;
    }

    /**
     * Detects scripted agents (robots / bots)
     * Returns a resolved ScriptedAgent object if detected.
     * Otherwise returns false.
     *
     * @return ScriptedAgent|bool
     */
    public function detectScriptedAgent()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

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

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $ua = $this->getUserAgent()->getUserAgentString();
        if (stripos($ua, 'bot') !== false ||
            stripos($ua, 'spider') !== false ||
            stripos($ua, 'crawler') !== false ||
            stripos($ua, 'preview') !== false ||
            stripos($ua, 'slurp') !== false ||
            stripos($ua, 'facebookexternalhit') !== false ||
            stripos($ua, 'mediapartners') !== false ||
            stripos($ua, 'google-adwords') !== false ||
            stripos($ua, 'adxvastfetcher') !== false ||
            stripos($ua, 'adbeat') !== false ||
            stripos($ua, 'google favicon') !== false ||
            stripos($ua, 'webdav client') !== false ||
            stripos($ua, 'metauri api') !== false ||
            stripos($ua, 'tlsprobe') !== false ||
            stripos($ua, 'wpif') !== false ||
            stripos($ua, 'imgsizer') !== false ||
            stripos($ua, 'netcraft ssl server survey') !== false ||
            stripos($ua, 'curl/') !== false ||
            stripos($ua, 'go-http-client/') !== false ||
            stripos($ua, 'python') !== false ||
            stripos($ua, 'libwww') !== false ||
            stripos($ua, 'wget/') !== false ||
            stripos($ua, 'zgrab/') !== false ||
            stripos($ua, 'Java/') !== false ||
            stripos($ua, '() { :;}; /bin/bash -c') !== false ||
            stripos($ua, 'browsershots') !== false ||
            stripos($ua, 'magereport') !== false ||
            stripos($ua, 'ubermetrics-technologies') !== false ||
            stripos($ua, 'W3C') !== false ||
            stripos($ua, 'Validator') !== false ||
            stripos($ua, 'Jigsaw/') !== false ||
            stripos($ua, 'bing') !== false ||
            stripos($ua, 'msn') !== false ||
            stripos($ua, 'Google Web Preview') !== false ||
            stripos($ua, 'ips-agent') !== false ||
            (stripos($ua, 'Chrome/51.0.2704.103') !== false && !isset($_SERVER['HTTP_UPGRADE_INSECURE_REQUESTS']) && stristr($_SERVER['HTTP_ACCEPT_LANGUAGE'], "ru-RU") !== false) //ICQ Preview
        ) {
            $scriptedAgent = new ScriptedAgent($ua);
            if ($scriptedAgent->getName()==ScriptedAgent::UNKNOWN) {
                return false;
            } else {
                return $scriptedAgent;
            }
        } else {
            return false;
        }
    }

    /**
     * @param bool $isChromeFrame
     * @return $this
     */
    public function setIsChromeFrame($isChromeFrame)
    {
        $this->isChromeFrame = (bool)$isChromeFrame;
        return $this;
    }

    /**
     * Used to determine if the browser is actually "chromeframe".
     *
     * @return bool
     */
    public function getIsChromeFrame()
    {
        if (!isset($this->name)) {
            BrowserDetector::detect($this, $this->getUserAgent());
        }

        return $this->isChromeFrame;
    }

    /**
     * @return bool
     */
    public function isChromeFrame()
    {
        return $this->getIsChromeFrame();
    }

    /**
     * @param bool $isWebkit
     * @return $this
     */
    public function setIsWebkit($isWebkit)
    {
        $this->isWebkit = (bool)$isWebkit;
        return $this;
    }

    /**
     * Used to determine if the browser is actually "chromeframe".
     *
     * @return bool
     */
    public function getIsWebkit()
    {
        if (!isset($this->name)) {
            BrowserDetector::detect($this, $this->getUserAgent());
        }

        return $this->isWebkit;
    }

    /**
     * @return bool
     */
    public function isWebkit()
    {
        return $this->getIsWebkit();
    }

    /**
     * @param bool $isFacebookWebView
     * @return $this
     */
    public function setIsFacebookWebView($isFacebookWebView)
    {
        $this->isFacebookWebView = (bool) $isFacebookWebView;
        return $this;
    }

    /**
     * Used to determine if the browser is actually "facebook".
     *
     * @return bool
     */
    public function getIsFacebookWebView()
    {
        if (!isset($this->name)) {
            BrowserDetector::detect($this, $this->getUserAgent());
        }

        return $this->isFacebookWebView;
    }

    /**
     * @return bool
     */
    public function isFacebookWebView()
    {
        return $this->getIsFacebookWebView();
    }

    /**
     * @param bool $isTwitterWebView
     * @return $this
     */
    public function setIsTwitterWebView($isTwitterWebView)
    {
        $this->isTwitterWebView = (bool) $isTwitterWebView;
        return $this;
    }

    /**
     * Used to determine if the browser is actually "Twitter".
     *
     * @return bool
     */
    public function getIsTwitterWebView()
    {
        if (!isset($this->name)) {
            BrowserDetector::detect($this, $this->getUserAgent());
        }

        return $this->isTwitterWebView;
    }

    /**
     * @return bool
     */
    public function isTwitterWebView()
    {
        return $this->getIsTwitterWebView();
    }

    /**
     * @param UserAgent $userAgent
     * @return $this
     */
    public function setUserAgent(UserAgent $userAgent)
    {
        $this->userAgent = $userAgent;
        return $this;
    }

    /**
     * @return UserAgent
     */
    public function getUserAgent()
    {
        return $this->userAgent;
    }

    /**
     * @param bool
     *
     * @return $this
     */
    public function setIsCompatibilityMode($isCompatibilityMode)
    {
        $this->isCompatibilityMode = $isCompatibilityMode;
        return $this;
    }

    /**
     * @return bool
     */
    public function isCompatibilityMode()
    {
        return $this->isCompatibilityMode;
    }

    /**
     * Render pages outside of IE's compatibility mode.
     */
    public function endCompatibilityMode()
    {
        header('X-UA-Compatible: IE=edge');
    }
}


1			<?php
2
3			namespace Sinergi\BrowserDetector;
4
5			class Browser
6			{
7			const UNKNOWN = 'unknown';
8			const VIVALDI = 'Vivaldi';
9			const OPERA = 'Opera';
10			const OPERA_MINI = 'Opera Mini';
11			const WEBTV = 'WebTV';
12			const IE = 'Internet Explorer';
13			const POCKET_IE = 'Pocket Internet Explorer';
14			const KONQUEROR = 'Konqueror';
15			const ICAB = 'iCab';
16			const OMNIWEB = 'OmniWeb';
17			const FIREBIRD = 'Firebird';
18			const FIREFOX = 'Firefox';
19			const SEAMONKEY = 'SeaMonkey';
20			const ICEWEASEL = 'Iceweasel';
21			const SHIRETOKO = 'Shiretoko';
22			const MOZILLA = 'Mozilla';
23			const AMAYA = 'Amaya';
24			const LYNX = 'Lynx';
25			const SAFARI = 'Safari';
26			const SAMSUNG_BROWSER = 'SamsungBrowser';
27			const CHROME = 'Chrome';
28			const NAVIGATOR = 'Android Navigator';
29			const BLACKBERRY = 'BlackBerry';
30			const ICECAT = 'IceCat';
31			const NOKIA_S60 = 'Nokia S60 OSS Browser';
32			const NOKIA = 'Nokia Browser';
33			const MSN = 'MSN Browser';
34			const NETSCAPE_NAVIGATOR = 'Netscape Navigator';
35			const GALEON = 'Galeon';
36			const NETPOSITIVE = 'NetPositive';
37			const PHOENIX = 'Phoenix';
38			const GSA = 'Google Search Appliance';
39			const YANDEX = 'Yandex';
40			const EDGE = 'Edge';
41			const EDGE_HTML = 'EdgeHTML';
42			const DRAGON = 'Dragon';
43			const NSPLAYER = 'Windows Media Player';
44			const UCBROWSER = 'UC Browser';
45			const MICROSOFT_OFFICE = 'Microsoft Office';
46			const APPLE_NEWS = 'Apple News';
47			const DALVIK = 'Android';
48
49			const VERSION_UNKNOWN = 'unknown';
50
51			/**
52			* @var UserAgent
53			*/
54			private $userAgent;
55
56			/**
57			* @var string
58			*/
59			private $name;
60			/**
61			* @var string
62			*/
63			private $version;
64
65			/**
66			* @var bool
67			*/
68			private $isChromeFrame = false;
69
70			/**
71			* @var bool
72			*/
73			private $isWebkit = false;
74
75			/**
76			* @var bool
77			*/
78			private $isFacebookWebView = false;
79
80			/**
81			* @var bool
82			*/
83			private $isTwitterWebView = false;
84
85			/**
86			* @var bool
87			*/
88			private $isCompatibilityMode = false;
89
90			/**
91			* @param null\|string\|UserAgent $userAgent
92	8		* @throws \Sinergi\BrowserDetector\InvalidArgumentException
93			*/
94	8	View Code Duplication	public function __construct($userAgent = null)
			0 ignored issues – show Duplication introduced 2015-11-21 03:38 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
95			{
96	8		if ($userAgent instanceof UserAgent) {
97	8		$this->setUserAgent($userAgent);
98	8		} elseif (null === $userAgent \|\| is_string($userAgent)) {
99			$this->setUserAgent(new UserAgent($userAgent));
100			} else {
101	8		throw new InvalidArgumentException();
102			}
103			}
104
105			/**
106			* Set the name of the Browser.
107			*
108			* @param string $name
109			* @return $this
110	8		*/
111			public function setName($name)
112	8		{
113			$this->name = (string)$name;
114	8		return $this;
115			}
116
117			/**
118			* Return the name of the Browser.
119			*
120			* @return string
121			*/
122	7		public function getName()
123			{
124	7		if (!isset($this->name)) {
125	7		BrowserDetector::detect($this, $this->getUserAgent());
126	7		}
127
128	7		return $this->name;
129			}
130
131			/**
132			* Check to see if the specific browser is valid.
133			*
134			* @param string $name
135			* @return bool
136			*/
137			public function isBrowser($name)
138			{
139			return (0 == strcasecmp($this->getName(), trim($name)));
140			}
141
142			/**
143			* Set the version of the browser.
144			*
145			* @param string $version
146			* @return $this
147			*/
148			public function setVersion($version)
149			{
150	8		$this->version = (string)$version;
151			return $this;
152	8		}
153
154	8		/**
155			* The version of the browser.
156			*
157			* @return string
158			*/
159			public function getVersion()
160			{
161			if (!isset($this->name)) {
162	7		BrowserDetector::detect($this, $this->getUserAgent());
163			}
164	7
165			return (string) $this->version;
166			}
167
168	7		/**
169			* Detects scripted agents (robots / bots)
170			* Returns a resolved ScriptedAgent object if detected.
171			* Otherwise returns false.
172			*
173			* @return ScriptedAgent\|bool
174			*/
175			public function detectScriptedAgent()
			0 ignored issues – show Coding Style introduced 2017-03-31 16:14 UTC by Report Bug Copy Issue Report `detectScriptedAgent` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
176			{
177			$ua = $this->getUserAgent()->getUserAgentString();
178			if (stripos($ua, 'bot') !== false \|\|
179			stripos($ua, 'spider') !== false \|\|
180			stripos($ua, 'crawler') !== false \|\|
181			stripos($ua, 'preview') !== false \|\|
182			stripos($ua, 'slurp') !== false \|\|
183			stripos($ua, 'facebookexternalhit') !== false \|\|
184			stripos($ua, 'mediapartners') !== false \|\|
185			stripos($ua, 'google-adwords') !== false \|\|
186			stripos($ua, 'adxvastfetcher') !== false \|\|
187			stripos($ua, 'adbeat') !== false \|\|
188			stripos($ua, 'google favicon') !== false \|\|
189			stripos($ua, 'webdav client') !== false \|\|
190			stripos($ua, 'metauri api') !== false \|\|
191			stripos($ua, 'tlsprobe') !== false \|\|
192			stripos($ua, 'wpif') !== false \|\|
193			stripos($ua, 'imgsizer') !== false \|\|
194			stripos($ua, 'netcraft ssl server survey') !== false \|\|
195			stripos($ua, 'curl/') !== false \|\|
196			stripos($ua, 'go-http-client/') !== false \|\|
197			stripos($ua, 'python') !== false \|\|
198			stripos($ua, 'libwww') !== false \|\|
199			stripos($ua, 'wget/') !== false \|\|
200			stripos($ua, 'zgrab/') !== false \|\|
201			stripos($ua, 'Java/') !== false \|\|
202			stripos($ua, '() { :;}; /bin/bash -c') !== false \|\|
203			stripos($ua, 'browsershots') !== false \|\|
204			stripos($ua, 'magereport') !== false \|\|
205			stripos($ua, 'ubermetrics-technologies') !== false \|\|
206			stripos($ua, 'W3C') !== false \|\|
207			stripos($ua, 'Validator') !== false \|\|
208			stripos($ua, 'Jigsaw/') !== false \|\|
209			stripos($ua, 'bing') !== false \|\|
210			stripos($ua, 'msn') !== false \|\|
211			stripos($ua, 'Google Web Preview') !== false \|\|
212			stripos($ua, 'ips-agent') !== false \|\|
213			(stripos($ua, 'Chrome/51.0.2704.103') !== false && !isset($_SERVER['HTTP_UPGRADE_INSECURE_REQUESTS']) && stristr($_SERVER['HTTP_ACCEPT_LANGUAGE'], "ru-RU") !== false) //ICQ Preview
214			) {
215			$scriptedAgent = new ScriptedAgent($ua);
216			if ($scriptedAgent->getName()==ScriptedAgent::UNKNOWN) {
217			return false;
218			} else {
219			return $scriptedAgent;
220			}
221			} else {
222			return false;
223			}
224			}
225
226			/**
227			* @param bool $isChromeFrame
228			* @return $this
229			*/
230			public function setIsChromeFrame($isChromeFrame)
231			{
232			$this->isChromeFrame = (bool)$isChromeFrame;
233			return $this;
234			}
235
236			/**
237			* Used to determine if the browser is actually "chromeframe".
238			*
239			* @return bool
240			*/
241			public function getIsChromeFrame()
242			{
243			if (!isset($this->name)) {
244			BrowserDetector::detect($this, $this->getUserAgent());
245			}
246	1
247			return $this->isChromeFrame;
248	1		}
249
250	1		/**
251			* @return bool
252			*/
253			public function isChromeFrame()
254			{
255			return $this->getIsChromeFrame();
256			}
257
258	1		/**
259			* @param bool $isWebkit
260	1		* @return $this
261	1		*/
262	1		public function setIsWebkit($isWebkit)
263			{
264	1		$this->isWebkit = (bool)$isWebkit;
265			return $this;
266			}
267
268			/**
269			* Used to determine if the browser is actually "chromeframe".
270	1		*
271			* @return bool
272	1		*/
273			public function getIsWebkit()
274			{
275			if (!isset($this->name)) {
276			BrowserDetector::detect($this, $this->getUserAgent());
277			}
278
279			return $this->isWebkit;
280	8		}
281
282	8		/**
283			* @return bool
284	8		*/
285			public function isWebkit()
286			{
287			return $this->getIsWebkit();
288			}
289
290	8		/**
291			* @param bool $isFacebookWebView
292	8		* @return $this
293			*/
294			public function setIsFacebookWebView($isFacebookWebView)
295			{
296			$this->isFacebookWebView = (bool) $isFacebookWebView;
297			return $this;
298			}
299
300	1		/**
301			* Used to determine if the browser is actually "facebook".
302	1		*
303			* @return bool
304	1		*/
305			public function getIsFacebookWebView()
306			{
307			if (!isset($this->name)) {
308			BrowserDetector::detect($this, $this->getUserAgent());
309			}
310
311			return $this->isFacebookWebView;
312			}
313
314			/**
315			* @return bool
316			*/
317			public function isFacebookWebView()
318			{
319			return $this->getIsFacebookWebView();
320			}
321
322			/**
323			* @param bool $isTwitterWebView
324			* @return $this
325			*/
326			public function setIsTwitterWebView($isTwitterWebView)
327			{
328			$this->isTwitterWebView = (bool) $isTwitterWebView;
329			return $this;
330			}
331
332			/**
333			* Used to determine if the browser is actually "Twitter".
334			*
335			* @return bool
336			*/
337			public function getIsTwitterWebView()
338			{
339			if (!isset($this->name)) {
340			BrowserDetector::detect($this, $this->getUserAgent());
341			}
342
343			return $this->isTwitterWebView;
344			}
345
346			/**
347			* @return bool
348			*/
349			public function isTwitterWebView()
350			{
351			return $this->getIsTwitterWebView();
352			}
353
354			/**
355			* @param UserAgent $userAgent
356			* @return $this
357			*/
358			public function setUserAgent(UserAgent $userAgent)
359			{
360			$this->userAgent = $userAgent;
361			return $this;
362			}
363
364			/**
365			* @return UserAgent
366			*/
367			public function getUserAgent()
368			{
369			return $this->userAgent;
370			}
371
372			/**
373			* @param bool
374			*
375			* @return $this
376			*/
377			public function setIsCompatibilityMode($isCompatibilityMode)
378			{
379			$this->isCompatibilityMode = $isCompatibilityMode;
380			return $this;
381			}
382
383			/**
384			* @return bool
385			*/
386			public function isCompatibilityMode()
387			{
388			return $this->isCompatibilityMode;
389			}
390
391			/**
392			* Render pages outside of IE's compatibility mode.
393			*/
394			public function endCompatibilityMode()
395			{
396			header('X-UA-Compatible: IE=edge');
397			}
398			}
399

sinergi / php-browser-detector

Pull Request — master (#85)

Browser::detectScriptedAgent() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like