BrowscapUpdater::setLogger() - Code Metrics - Inspection of "add PHP 7.1 to travis tests" - browscap/browscap-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#177)

by Thomas

created 2017-01-24 20:43 UTC

BrowscapUpdater::setLogger() A

↳ Parent: BrowscapUpdater

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?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;
    }

    /**
     * @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			* @return \GuzzleHttp\Client
158			*/
159	10		public function getClient()
160			{
161	10		if (null === $this->client) {
162	1		$this->client = new Client();
163			}
164
165	10		return $this->client;
166			}
167
168			/**
169			* @param \GuzzleHttp\Client $client
170			*/
171	10		public function setClient(Client $client)
172			{
173	10		$this->client = $client;
174	10		}
175
176			/**
177			* reads and parses an ini file and writes the results into the cache
178			*
179			* @param string $iniFile
180			*
181			* @throws \BrowscapPHP\Exception
182			*/
183	4		public function convertFile($iniFile)
184			{
185	4		if (empty($iniFile)) {
186	1		throw new Exception('the file name can not be empty');
187			}
188
189	3		if (!is_readable($iniFile)) {
190	1		throw new Exception('it was not possible to read the local file ' . $iniFile);
191			}
192
193			try {
194	2		$iniString = file_get_contents($iniFile);
195	2		} catch (Helper\Exception $e) {
196			throw new Exception('an error occured while converting the local file into the cache', 0, $e);
197			}
198
199	2		$this->convertString($iniString);
200	2		}
201
202			/**
203			* reads and parses an ini string and writes the results into the cache
204			*
205			* @param string $iniString
206			*/
207	3		public function convertString($iniString)
208			{
209	3		$cachedVersion = $this->getCache()->getItem('browscap.version', false, $success);
210	3		$converter = new Converter($this->getLogger(), $this->getCache());
211
212	3		$this->storeContent($converter, $iniString, $cachedVersion);
213	3		}
214
215			/**
216			* fetches a remote file and stores it into a local folder
217			*
218			* @param string $file The name of the file where to store the remote content
219			* @param string $remoteFile The code for the remote file to load
220			*
221			* @throws \BrowscapPHP\Exception\FetcherException
222			* @throws \BrowscapPHP\Helper\Exception
223			*/
224	3		public function fetch($file, $remoteFile = IniLoader::PHP_INI)
225			{
226	3		if (null === ($cachedVersion = $this->checkUpdate())) {
227			// no newer version available
228			return;
229			}
230
231	2		$this->getLogger()->debug('started fetching remote file');
232
233	2		$uri = (new IniLoader())->setRemoteFilename($remoteFile)->getRemoteIniUrl();
234
235			/** @var \Psr\Http\Message\ResponseInterface $response */
236	2		$response = $this->getClient()->get($uri, ['connect_timeout' => $this->connectTimeout]);
237
238	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...
239			throw new FetcherException(
240			'an error occured while fetching remote data from URI ' . $uri . ': StatusCode was '
241			. $response->getStatusCode()
242			);
243	1		}
244
245			try {
246	2		$content = $response->getBody()->getContents();
247	2		} catch (\Exception $e) {
248			throw new FetcherException('an error occured while fetching remote data', 0, $e);
249			}
250
251	2		if (empty($content)) {
252			$error = error_get_last();
253			throw FetcherException::httpError($uri, $error['message']);
254			}
255
256	2		$this->getLogger()->debug('finished fetching remote file');
257	2		$this->getLogger()->debug('started storing remote file into local file');
258
259	2		$content = $this->sanitizeContent($content);
260
261	2		$converter = new Converter($this->getLogger(), $this->getCache());
262	2		$iniVersion = $converter->getIniVersion($content);
263
264	2		if ($iniVersion > $cachedVersion) {
265	2		$fs = new Filesystem();
266	2		$fs->dumpFile($file, $content);
267			}
268
269	2		$this->getLogger()->debug('finished storing remote file into local file');
270	2		}
271
272			/**
273			* fetches a remote file, parses it and writes the result into the cache
274			*
275			* if the local stored information are in the same version as the remote data no actions are
276			* taken
277			*
278			* @param string $remoteFile The code for the remote file to load
279			*
280			* @throws \BrowscapPHP\Exception\FileNotFoundException
281			* @throws \BrowscapPHP\Helper\Exception
282			* @throws \BrowscapPHP\Exception\FetcherException
283			*/
284	2		public function update($remoteFile = IniLoader::PHP_INI)
285			{
286	2		$this->getLogger()->debug('started fetching remote file');
287
288	2		if (null === ($cachedVersion = $this->checkUpdate())) {
289			// no newer version available
290			return;
291			}
292
293	2		$uri = (new IniLoader())->setRemoteFilename($remoteFile)->getRemoteIniUrl();
294
295			/** @var \Psr\Http\Message\ResponseInterface $response */
296	2		$response = $this->getClient()->get($uri, ['connect_timeout' => $this->connectTimeout]);
297
298	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...
299			throw new FetcherException(
300			'an error occured while fetching remote data from URI ' . $uri . ': StatusCode was '
301			. $response->getStatusCode()
302			);
303			}
304
305			try {
306	2		$content = $response->getBody()->getContents();
307	2		} catch (\Exception $e) {
308			throw new FetcherException('an error occured while fetching remote data', 0, $e);
309			}
310
311	2		if (empty($content)) {
312	1		$error = error_get_last();
313
314	1		throw FetcherException::httpError($uri, $error['message']);
315			}
316
317	1		$this->getLogger()->debug('finished fetching remote file');
318
319	1		$converter = new Converter($this->getLogger(), $this->getCache());
320
321	1		$this->storeContent($converter, $content, $cachedVersion);
322	1		}
323
324			/**
325			* checks if an update on a remote location for the local file or the cache
326			*
327			* @throws \BrowscapPHP\Helper\Exception
328			* @throws \BrowscapPHP\Exception\FetcherException
329			* @return int\|null The actual cached version if a newer version is available, null otherwise
330			* @return int\|null The actual cached version if a newer version is available, null otherwise
331			*/
332	9		public function checkUpdate()
333			{
334	9		$success = null;
335	9		$cachedVersion = $this->getCache()->getItem('browscap.version', false, $success);
336
337	9		if (!$cachedVersion) {
338			// could not load version from cache
339	5		$this->getLogger()->info('there is no cached version available, please update from remote');
340
341	5		return 0;
342			}
343
344	4		$uri = (new IniLoader())->getRemoteVersionUrl();
345
346			/** @var \Psr\Http\Message\ResponseInterface $response */
347	4		$response = $this->getClient()->get($uri, ['connect_timeout' => $this->connectTimeout]);
348
349	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...
350	1		throw new FetcherException(
351	1		'an error occured while fetching version data from URI ' . $uri . ': StatusCode was '
352	1		. $response->getStatusCode()
353	1		);
354			}
355
356			try {
357	3		$remoteVersion = $response->getBody()->getContents();
358	3		} catch (\Exception $e) {
359	1		throw new FetcherException(
360	1		'an error occured while fetching version data from URI ' . $uri . ': StatusCode was '
361	1		. $response->getStatusCode(),
362	1		0,
363			$e
364	1		);
365			}
366
367	2		if (!$remoteVersion) {
368			// could not load remote version
369			$this->getLogger()->info('could not load version from remote location');
370
371			return 0;
372			}
373
374	2		if ($cachedVersion && $remoteVersion && $remoteVersion <= $cachedVersion) {
375			// no newer version available
376	1		$this->getLogger()->info('there is no newer version available');
377
378	1		return null;
379			}
380
381	1		$this->getLogger()->info(
382	1		'a newer version is available, local version: ' . $cachedVersion . ', remote version: ' . $remoteVersion
383	1		);
384
385	1		return (int) $cachedVersion;
386			}
387
388			/**
389			* @param string $content
390			*
391			* @return mixed
392			*/
393	6		private function sanitizeContent($content)
394			{
395			// replace everything between opening and closing php and asp tags
396	6		$content = preg_replace('/<[?%].*[?%]>/', '', $content);
397
398			// replace opening and closing php and asp tags
399	6		return str_replace(['<?', '<%', '?>', '%>'], '', $content);
400			}
401
402			/**
403			* reads and parses an ini string and writes the results into the cache
404			*
405			* @param \BrowscapPHP\Helper\Converter $converter
406			* @param string $content
407			* @param int\|null $cachedVersion
408			*/
409	4		private function storeContent(Converter $converter, $content, $cachedVersion)
410			{
411	4		$iniString = $this->sanitizeContent($content);
412	4		$iniVersion = $converter->getIniVersion($iniString);
413
414	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...
415			$converter
416	4		->storeVersion()
417	4		->convertString($iniString);
418			}
419	4		}
420			}
421

browscap / browscap-php

Pull Request — master (#177)

BrowscapUpdater::setLogger() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like