BrowscapUpdater::setConnectTimeout() - Code Metrics - Inspection of "Added Set timeout, required to increase the timeou..." - browscap/browscap-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#175)

by Thomas

created 2017-01-10 22:12 UTC

BrowscapUpdater::setConnectTimeout() A

↳ Parent: BrowscapUpdater

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	6
ccs	0
cts	3
cp	0
rs	9.4285
cc	1
eloc	3
nc	1
nop	1
crap	2

<?php
/**
 * Copyright (c) 1998-2015 Browser Capabilities Project
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 * @category   Browscap-PHP
 * @copyright  1998-2015 Browser Capabilities Project
 * @license    http://www.opensource.org/licenses/MIT MIT License
 * @link       https://github.com/browscap/browscap-php/
 */

namespace BrowscapPHP;

use BrowscapPHP\Cache\BrowscapCache;
use BrowscapPHP\Cache\BrowscapCacheInterface;
use BrowscapPHP\Exception\FetcherException;
use BrowscapPHP\Helper\Converter;
use BrowscapPHP\Helper\Filesystem;
use BrowscapPHP\Helper\IniLoader;
use GuzzleHttp\Client;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
use WurflCache\Adapter\AdapterInterface;
use WurflCache\Adapter\File;

/**
 * Browscap.ini parsing class with caching and update capabilities
 *
 * @category   Browscap-PHP
 * @author     Jonathan Stoppani <[email protected]>
 * @author     Vítor Brandão <[email protected]>
 * @author     Mikołaj Misiurewicz <[email protected]>
 * @author     Christoph Ziegenberg <[email protected]>
 * @author     Thomas Müller <[email protected]>
 * @copyright  Copyright (c) 1998-2015 Browser Capabilities Project
 * @version    3.0
 * @license    http://www.opensource.org/licenses/MIT MIT License
 * @link       https://github.com/browscap/browscap-php/
 */
class BrowscapUpdater
{
    /**
     * The cache instance
     *
     * @var \BrowscapPHP\Cache\BrowscapCacheInterface
     */
    private $cache = null;

    /**
     * @var @var \Psr\Log\LoggerInterface
     */
    private $logger = null;

    /**
     * @var \GuzzleHttp\Client
     */
    private $client = null;

    /**
     * Curl connect timeout in seconds
     *
     * @var int
     */
    private $connectTimeout = 5;

    /**
     * Gets a cache instance
     *
     * @return \BrowscapPHP\Cache\BrowscapCacheInterface
     */
    public function getCache()

    {
        if (null === $this->cache) {
            $cacheDirectory = __DIR__ . '/../resources/';

            $cacheAdapter = new File(
                [File::DIR => $cacheDirectory]
            );

            $this->cache = new BrowscapCache($cacheAdapter);
        }

        return $this->cache;
    }

    /**
     * Sets a cache instance
     *
     * @param \BrowscapPHP\Cache\BrowscapCacheInterface|\WurflCache\Adapter\AdapterInterface $cache
     *
     * @throws \BrowscapPHP\Exception
     * @return \BrowscapPHP\BrowscapUpdater
     */
    public function setCache($cache)

    {
        if ($cache instanceof BrowscapCacheInterface) {
            $this->cache = $cache;
        } elseif ($cache instanceof AdapterInterface) {
            $this->cache = new BrowscapCache($cache);
        } else {
            throw new Exception(
                'the cache has to be an instance of \BrowscapPHP\Cache\BrowscapCacheInterface or '
                . 'an instanceof of \WurflCache\Adapter\AdapterInterface',
                Exception::CACHE_INCOMPATIBLE
            );
        }

        return $this;
    }

    /**
     * Sets a logger instance
     *
     * @param \Psr\Log\LoggerInterface $logger
     *
     * @return \BrowscapPHP\BrowscapUpdater
     */
    public function setLogger(LoggerInterface $logger)
    {
        $this->logger = $logger;

        return $this;
    }

    /**
     * returns a logger instance
     *
     * @return \Psr\Log\LoggerInterface
     */
    public function getLogger()
    {
        if (null === $this->logger) {
            $this->logger = new NullLogger();
        }

        return $this->logger;
    }

    /**
     * Sets the Connection Timeout
     *
     * @param int $connectTimeout
     *
     * @return \BrowscapPHP\BrowscapUpdater
     */
    public function setConnectTimeout($connectTimeout)
    {
        $this->connectTimeout = (int) $connectTimeout;

        return $this;
    }

    /**
     * @return \GuzzleHttp\Client
     */
    public function getClient()
    {
        if (null === $this->client) {
            $this->client = new Client();
        }

        return $this->client;
    }

    /**
     * @param \GuzzleHttp\Client $client
     */
    public function setClient(Client $client)
    {
        $this->client = $client;
    }

    /**
     * reads and parses an ini file and writes the results into the cache
     *
     * @param string $iniFile
     *
     * @throws \BrowscapPHP\Exception
     */
    public function convertFile($iniFile)
    {
        if (empty($iniFile)) {
            throw new Exception('the file name can not be empty');
        }

        if (!is_readable($iniFile)) {
            throw new Exception('it was not possible to read the local file ' . $iniFile);
        }

        try {
            $iniString = file_get_contents($iniFile);
        } catch (Helper\Exception $e) {
            throw new Exception('an error occured while converting the local file into the cache', 0, $e);
        }

        $this->convertString($iniString);
    }

    /**
     * reads and parses an ini string and writes the results into the cache
     *
     * @param string $iniString
     */
    public function convertString($iniString)
    {
        $cachedVersion = $this->getCache()->getItem('browscap.version', false, $success);
        $converter     = new Converter($this->getLogger(), $this->getCache());

        $this->storeContent($converter, $iniString, $cachedVersion);
    }

    /**
     * fetches a remote file and stores it into a local folder
     *
     * @param string $file       The name of the file where to store the remote content
     * @param string $remoteFile The code for the remote file to load
     *
     * @throws \BrowscapPHP\Exception\FetcherException
     * @throws \BrowscapPHP\Helper\Exception
     */
    public function fetch($file, $remoteFile = IniLoader::PHP_INI)
    {
        if (null === ($cachedVersion = $this->checkUpdate())) {
            // no newer version available
            return;
        }

        $this->getLogger()->debug('started fetching remote file');

        $uri = (new IniLoader())->setRemoteFilename($remoteFile)->getRemoteIniUrl();

        /** @var \Psr\Http\Message\ResponseInterface $response */
        $response = $this->getClient()->get($uri, ['connect_timeout' => $this->connectTimeout]);

        if ($response->getStatusCode() !== 200) {

            throw new FetcherException(
                'an error occured while fetching remote data from URI ' . $uri . ': StatusCode was '
                . $response->getStatusCode()
            );
        }

        try {
            $content = $response->getBody()->getContents();
        } catch (\Exception $e) {
            throw new FetcherException('an error occured while fetching remote data', 0, $e);
        }

        if (empty($content)) {
            $error = error_get_last();
            throw FetcherException::httpError($uri, $error['message']);
        }

        $this->getLogger()->debug('finished fetching remote file');
        $this->getLogger()->debug('started storing remote file into local file');

        $content = $this->sanitizeContent($content);

        $converter  = new Converter($this->getLogger(), $this->getCache());
        $iniVersion = $converter->getIniVersion($content);

        if ($iniVersion > $cachedVersion) {
            $fs = new Filesystem();
            $fs->dumpFile($file, $content);
        }

        $this->getLogger()->debug('finished storing remote file into local file');
    }

    /**
     * fetches a remote file, parses it and writes the result into the cache
     *
     * if the local stored information are in the same version as the remote data no actions are
     * taken
     *
     * @param string $remoteFile The code for the remote file to load
     *
     * @throws \BrowscapPHP\Exception\FileNotFoundException
     * @throws \BrowscapPHP\Helper\Exception
     * @throws \BrowscapPHP\Exception\FetcherException
     */
    public function update($remoteFile = IniLoader::PHP_INI)
    {
        $this->getLogger()->debug('started fetching remote file');

        if (null === ($cachedVersion = $this->checkUpdate())) {
            // no newer version available
            return;
        }

        $uri = (new IniLoader())->setRemoteFilename($remoteFile)->getRemoteIniUrl();

        /** @var \Psr\Http\Message\ResponseInterface $response */
        $response = $this->getClient()->get($uri, ['connect_timeout' => $this->connectTimeout]);

        if ($response->getStatusCode() !== 200) {

            throw new FetcherException(
                'an error occured while fetching remote data from URI ' . $uri . ': StatusCode was '
                . $response->getStatusCode()
            );
        }

        try {
            $content = $response->getBody()->getContents();
        } catch (\Exception $e) {
            throw new FetcherException('an error occured while fetching remote data', 0, $e);
        }

        if (empty($content)) {
            $error = error_get_last();

            throw FetcherException::httpError($uri, $error['message']);
        }

        $this->getLogger()->debug('finished fetching remote file');

        $converter = new Converter($this->getLogger(), $this->getCache());

        $this->storeContent($converter, $content, $cachedVersion);
    }

    /**
     * checks if an update on a remote location for the local file or the cache
     *
     * @throws \BrowscapPHP\Helper\Exception
     * @throws \BrowscapPHP\Exception\FetcherException
     * @return int|null                                The actual cached version if a newer version is available, null otherwise
     * @return int|null                                The actual cached version if a newer version is available, null otherwise
     */
    public function checkUpdate()
    {
        $success       = null;
        $cachedVersion = $this->getCache()->getItem('browscap.version', false, $success);

        if (!$cachedVersion) {
            // could not load version from cache
            $this->getLogger()->info('there is no cached version available, please update from remote');

            return 0;
        }

        $uri = (new IniLoader())->getRemoteVersionUrl();

        /** @var \Psr\Http\Message\ResponseInterface $response */
        $response = $this->getClient()->get($uri, ['connect_timeout' => $this->connectTimeout]);

        if ($response->getStatusCode() !== 200) {

            throw new FetcherException(
                'an error occured while fetching version data from URI ' . $uri . ': StatusCode was '
                . $response->getStatusCode()
            );
        }

        try {
            $remoteVersion = $response->getBody()->getContents();
        } catch (\Exception $e) {
            throw new FetcherException(
                'an error occured while fetching version data from URI ' . $uri . ': StatusCode was '
                . $response->getStatusCode(),
                0,
                $e
            );
        }

        if (!$remoteVersion) {
            // could not load remote version
            $this->getLogger()->info('could not load version from remote location');

            return 0;
        }

        if ($cachedVersion && $remoteVersion && $remoteVersion <= $cachedVersion) {
            // no newer version available
            $this->getLogger()->info('there is no newer version available');

            return null;
        }

        $this->getLogger()->info(
            'a newer version is available, local version: ' . $cachedVersion . ', remote version: ' . $remoteVersion
        );

        return (int) $cachedVersion;
    }

    /**
     * @param string $content
     *
     * @return mixed
     */
    private function sanitizeContent($content)
    {
        // replace everything between opening and closing php and asp tags
        $content = preg_replace('/<[?%].*[?%]>/', '', $content);

        // replace opening and closing php and asp tags
        return str_replace(['<?', '<%', '?>', '%>'], '', $content);
    }

    /**
     * reads and parses an ini string and writes the results into the cache
     *
     * @param \BrowscapPHP\Helper\Converter $converter
     * @param string                        $content
     * @param int|null                      $cachedVersion
     */
    private function storeContent(Converter $converter, $content, $cachedVersion)
    {
        $iniString  = $this->sanitizeContent($content);
        $iniVersion = $converter->getIniVersion($iniString);

        if (!$cachedVersion || $iniVersion > $cachedVersion) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            $converter
                ->storeVersion()
                ->convertString($iniString);
        }
    }
}


1			<?php
2			/**
3			* Copyright (c) 1998-2015 Browser Capabilities Project
4			*
5			* Permission is hereby granted, free of charge, to any person obtaining a
6			* copy of this software and associated documentation files (the "Software"),
7			* to deal in the Software without restriction, including without limitation
8			* the rights to use, copy, modify, merge, publish, distribute, sublicense,
9			* and/or sell copies of the Software, and to permit persons to whom the
10			* Software is furnished to do so, subject to the following conditions:
11			*
12			* The above copyright notice and this permission notice shall be included
13			* in all copies or substantial portions of the Software.
14			*
15			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
16			* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17			* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18			* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20			* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21			* THE SOFTWARE.
22			*
23			* @category Browscap-PHP
24			* @copyright 1998-2015 Browser Capabilities Project
25			* @license http://www.opensource.org/licenses/MIT MIT License
26			* @link https://github.com/browscap/browscap-php/
27			*/
28
29			namespace BrowscapPHP;
30
31			use BrowscapPHP\Cache\BrowscapCache;
32			use BrowscapPHP\Cache\BrowscapCacheInterface;
33			use BrowscapPHP\Exception\FetcherException;
34			use BrowscapPHP\Helper\Converter;
35			use BrowscapPHP\Helper\Filesystem;
36			use BrowscapPHP\Helper\IniLoader;
37			use GuzzleHttp\Client;
38			use Psr\Log\LoggerInterface;
39			use Psr\Log\NullLogger;
40			use WurflCache\Adapter\AdapterInterface;
41			use WurflCache\Adapter\File;
42
43			/**
44			* Browscap.ini parsing class with caching and update capabilities
45			*
46			* @category Browscap-PHP
47			* @author Jonathan Stoppani <[email protected]>
48			* @author Vítor Brandão <[email protected]>
49			* @author Mikołaj Misiurewicz <[email protected]>
50			* @author Christoph Ziegenberg <[email protected]>
51			* @author Thomas Müller <[email protected]>
52			* @copyright Copyright (c) 1998-2015 Browser Capabilities Project
53			* @version 3.0
54			* @license http://www.opensource.org/licenses/MIT MIT License
55			* @link https://github.com/browscap/browscap-php/
56			*/
57			class BrowscapUpdater
58			{
59			/**
60			* The cache instance
61			*
62			* @var \BrowscapPHP\Cache\BrowscapCacheInterface
63			*/
64			private $cache = null;
65
66			/**
67			* @var @var \Psr\Log\LoggerInterface
68			*/
69			private $logger = null;
70
71			/**
72			* @var \GuzzleHttp\Client
73			*/
74			private $client = null;
75
76			/**
77			* Curl connect timeout in seconds
78			*
79			* @var int
80			*/
81			private $connectTimeout = 5;
82
83			/**
84			* Gets a cache instance
85			*
86			* @return \BrowscapPHP\Cache\BrowscapCacheInterface
87			*/
88	15	View Code Duplication	public function getCache()
			0 ignored issues – show Duplication introduced 2016-05-07 10:33 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...
89			{
90	15		if (null === $this->cache) {
91	2		$cacheDirectory = __DIR__ . '/../resources/';
92
93	1		$cacheAdapter = new File(
94	1		[File::DIR => $cacheDirectory]
95	1		);
96
97	1		$this->cache = new BrowscapCache($cacheAdapter);
98			}
99
100	15		return $this->cache;
101			}
102
103			/**
104			* Sets a cache instance
105			*
106			* @param \BrowscapPHP\Cache\BrowscapCacheInterface\|\WurflCache\Adapter\AdapterInterface $cache
107			*
108			* @throws \BrowscapPHP\Exception
109			* @return \BrowscapPHP\BrowscapUpdater
110			*/
111	15	View Code Duplication	public function setCache($cache)
			0 ignored issues – show Duplication introduced 2016-05-07 10:33 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...
112			{
113	15		if ($cache instanceof BrowscapCacheInterface) {
114	11		$this->cache = $cache;
115	15		} elseif ($cache instanceof AdapterInterface) {
116	3		$this->cache = new BrowscapCache($cache);
117	3		} else {
118	1		throw new Exception(
119			'the cache has to be an instance of \BrowscapPHP\Cache\BrowscapCacheInterface or '
120	1		. 'an instanceof of \WurflCache\Adapter\AdapterInterface',
121			Exception::CACHE_INCOMPATIBLE
122	1		);
123			}
124
125	14		return $this;
126			}
127
128			/**
129			* Sets a logger instance
130			*
131			* @param \Psr\Log\LoggerInterface $logger
132			*
133			* @return \BrowscapPHP\BrowscapUpdater
134			*/
135	11		public function setLogger(LoggerInterface $logger)
136			{
137	11		$this->logger = $logger;
138
139	11		return $this;
140			}
141
142			/**
143			* returns a logger instance
144			*
145			* @return \Psr\Log\LoggerInterface
146			*/
147	12		public function getLogger()
148			{
149	12		if (null === $this->logger) {
150	3		$this->logger = new NullLogger();
151			}
152
153	12		return $this->logger;
154	1		}
155
156			/**
157			* Sets the Connection Timeout
158			*
159			* @param int $connectTimeout
160			*
161			* @return \BrowscapPHP\BrowscapUpdater
162			*/
163			public function setConnectTimeout($connectTimeout)
164			{
165			$this->connectTimeout = (int) $connectTimeout;
166
167			return $this;
168			}
169
170			/**
171			* @return \GuzzleHttp\Client
172			*/
173	10		public function getClient()
174			{
175	10		if (null === $this->client) {
176	2		$this->client = new Client();
177			}
178
179	10		return $this->client;
180			}
181
182			/**
183			* @param \GuzzleHttp\Client $client
184			*/
185	10		public function setClient(Client $client)
186			{
187	10		$this->client = $client;
188	10		}
189
190			/**
191			* reads and parses an ini file and writes the results into the cache
192			*
193			* @param string $iniFile
194			*
195			* @throws \BrowscapPHP\Exception
196			*/
197	4		public function convertFile($iniFile)
198			{
199	4		if (empty($iniFile)) {
200	1		throw new Exception('the file name can not be empty');
201			}
202
203	3		if (!is_readable($iniFile)) {
204	1		throw new Exception('it was not possible to read the local file ' . $iniFile);
205			}
206
207			try {
208	2		$iniString = file_get_contents($iniFile);
209	2		} catch (Helper\Exception $e) {
210			throw new Exception('an error occured while converting the local file into the cache', 0, $e);
211			}
212
213	2		$this->convertString($iniString);
214	2		}
215
216			/**
217			* reads and parses an ini string and writes the results into the cache
218			*
219			* @param string $iniString
220			*/
221	3		public function convertString($iniString)
222			{
223	3		$cachedVersion = $this->getCache()->getItem('browscap.version', false, $success);
224	3		$converter = new Converter($this->getLogger(), $this->getCache());
225
226	3		$this->storeContent($converter, $iniString, $cachedVersion);
227	3		}
228
229			/**
230			* fetches a remote file and stores it into a local folder
231			*
232			* @param string $file The name of the file where to store the remote content
233			* @param string $remoteFile The code for the remote file to load
234			*
235			* @throws \BrowscapPHP\Exception\FetcherException
236			* @throws \BrowscapPHP\Helper\Exception
237			*/
238	3		public function fetch($file, $remoteFile = IniLoader::PHP_INI)
239			{
240	3		if (null === ($cachedVersion = $this->checkUpdate())) {
241			// no newer version available
242			return;
243	1		}
244
245	2		$this->getLogger()->debug('started fetching remote file');
246
247	2		$uri = (new IniLoader())->setRemoteFilename($remoteFile)->getRemoteIniUrl();
248
249			/** @var \Psr\Http\Message\ResponseInterface $response */
250	2		$response = $this->getClient()->get($uri, ['connect_timeout' => $this->connectTimeout]);
251
252	2	View Code Duplication	if ($response->getStatusCode() !== 200) {
			0 ignored issues – show Duplication introduced 2016-06-20 20:19 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
253			throw new FetcherException(
254			'an error occured while fetching remote data from URI ' . $uri . ': StatusCode was '
255			. $response->getStatusCode()
256			);
257			}
258
259			try {
260	2		$content = $response->getBody()->getContents();
261	2		} catch (\Exception $e) {
262			throw new FetcherException('an error occured while fetching remote data', 0, $e);
263			}
264
265	2		if (empty($content)) {
266			$error = error_get_last();
267			throw FetcherException::httpError($uri, $error['message']);
268			}
269
270	2		$this->getLogger()->debug('finished fetching remote file');
271	2		$this->getLogger()->debug('started storing remote file into local file');
272
273	2		$content = $this->sanitizeContent($content);
274
275	2		$converter = new Converter($this->getLogger(), $this->getCache());
276	2		$iniVersion = $converter->getIniVersion($content);
277
278	2		if ($iniVersion > $cachedVersion) {
279	2		$fs = new Filesystem();
280	2		$fs->dumpFile($file, $content);
281			}
282
283	2		$this->getLogger()->debug('finished storing remote file into local file');
284	2		}
285
286			/**
287			* fetches a remote file, parses it and writes the result into the cache
288			*
289			* if the local stored information are in the same version as the remote data no actions are
290			* taken
291			*
292			* @param string $remoteFile The code for the remote file to load
293			*
294			* @throws \BrowscapPHP\Exception\FileNotFoundException
295			* @throws \BrowscapPHP\Helper\Exception
296			* @throws \BrowscapPHP\Exception\FetcherException
297			*/
298	2		public function update($remoteFile = IniLoader::PHP_INI)
299			{
300	2		$this->getLogger()->debug('started fetching remote file');
301
302	2		if (null === ($cachedVersion = $this->checkUpdate())) {
303			// no newer version available
304			return;
305			}
306
307	2		$uri = (new IniLoader())->setRemoteFilename($remoteFile)->getRemoteIniUrl();
308
309			/** @var \Psr\Http\Message\ResponseInterface $response */
310	2		$response = $this->getClient()->get($uri, ['connect_timeout' => $this->connectTimeout]);
311
312	2	View Code Duplication	if ($response->getStatusCode() !== 200) {
			0 ignored issues – show Duplication introduced 2016-06-20 20:19 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
313			throw new FetcherException(
314			'an error occured while fetching remote data from URI ' . $uri . ': StatusCode was '
315			. $response->getStatusCode()
316			);
317			}
318
319			try {
320	2		$content = $response->getBody()->getContents();
321	2		} catch (\Exception $e) {
322			throw new FetcherException('an error occured while fetching remote data', 0, $e);
323			}
324
325	2		if (empty($content)) {
326	1		$error = error_get_last();
327
328	1		throw FetcherException::httpError($uri, $error['message']);
329			}
330
331	1		$this->getLogger()->debug('finished fetching remote file');
332
333	1		$converter = new Converter($this->getLogger(), $this->getCache());
334
335	1		$this->storeContent($converter, $content, $cachedVersion);
336	1		}
337
338			/**
339			* checks if an update on a remote location for the local file or the cache
340			*
341			* @throws \BrowscapPHP\Helper\Exception
342			* @throws \BrowscapPHP\Exception\FetcherException
343			* @return int\|null The actual cached version if a newer version is available, null otherwise
344			* @return int\|null The actual cached version if a newer version is available, null otherwise
345			*/
346	9		public function checkUpdate()
347			{
348	9		$success = null;
349	9		$cachedVersion = $this->getCache()->getItem('browscap.version', false, $success);
350
351	9		if (!$cachedVersion) {
352			// could not load version from cache
353	5		$this->getLogger()->info('there is no cached version available, please update from remote');
354
355	5		return 0;
356			}
357
358	4		$uri = (new IniLoader())->getRemoteVersionUrl();
359
360			/** @var \Psr\Http\Message\ResponseInterface $response */
361	4		$response = $this->getClient()->get($uri, ['connect_timeout' => $this->connectTimeout]);
362
363	4	View Code Duplication	if ($response->getStatusCode() !== 200) {
			0 ignored issues – show Duplication introduced 2016-06-20 20:19 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
364	1		throw new FetcherException(
365	1		'an error occured while fetching version data from URI ' . $uri . ': StatusCode was '
366	1		. $response->getStatusCode()
367	1		);
368			}
369
370			try {
371	3		$remoteVersion = $response->getBody()->getContents();
372	3		} catch (\Exception $e) {
373	1		throw new FetcherException(
374	1		'an error occured while fetching version data from URI ' . $uri . ': StatusCode was '
375	1		. $response->getStatusCode(),
376	1		0,
377			$e
378	1		);
379			}
380
381	2		if (!$remoteVersion) {
382			// could not load remote version
383			$this->getLogger()->info('could not load version from remote location');
384
385			return 0;
386			}
387
388	2		if ($cachedVersion && $remoteVersion && $remoteVersion <= $cachedVersion) {
389			// no newer version available
390	1		$this->getLogger()->info('there is no newer version available');
391
392	1		return null;
393			}
394
395	1		$this->getLogger()->info(
396	1		'a newer version is available, local version: ' . $cachedVersion . ', remote version: ' . $remoteVersion
397	1		);
398
399	1		return (int) $cachedVersion;
400			}
401
402			/**
403			* @param string $content
404			*
405			* @return mixed
406			*/
407	6		private function sanitizeContent($content)
408			{
409			// replace everything between opening and closing php and asp tags
410	6		$content = preg_replace('/<[?%].*[?%]>/', '', $content);
411
412			// replace opening and closing php and asp tags
413	6		return str_replace(['<?', '<%', '?>', '%>'], '', $content);
414			}
415
416			/**
417			* reads and parses an ini string and writes the results into the cache
418			*
419			* @param \BrowscapPHP\Helper\Converter $converter
420			* @param string $content
421			* @param int\|null $cachedVersion
422			*/
423	4		private function storeContent(Converter $converter, $content, $cachedVersion)
424			{
425	4		$iniString = $this->sanitizeContent($content);
426	4		$iniVersion = $converter->getIniVersion($iniString);
427
428	4		if (!$cachedVersion \|\| $iniVersion > $cachedVersion) {
			0 ignored issues – show Bug Best Practice introduced 2016-05-07 10:33 UTC by Report Bug Copy Issue Report The expression `$cachedVersion` of type `integer\|null` is loosely compared to `false`; this is ambiguous if the integer can be zero. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
429			$converter
430	4		->storeVersion()
431	4		->convertString($iniString);
432			}
433	4		}
434			}
435

browscap / browscap-php

Pull Request — master (#175)

BrowscapUpdater::setConnectTimeout() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like