CacheRetriever::setRetrieve() - Code Metrics - Yapeal/yapeal-ng - Measure and Improve Code Quality continuously with Scrutinizer

CacheRetriever::setRetrieve() A
last analyzed 2017-01-23 23:44 UTC

↳ Parent: CacheRetriever

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php
declare(strict_types = 1);
/**
 * Contains CacheRetriever class.
 *
 * PHP version 7.0+
 *
 * LICENSE:
 * This file is part of Yet Another Php Eve Api Library also know as Yapeal
 * which can be used to access the Eve Online API data and place it into a
 * database.
 * Copyright (C) 2014-2017 Michael Cummings
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see
 * <http://spdx.org/licenses/LGPL-3.0.html>.
 *
 * You should be able to find a copy of this license in the COPYING-LESSER.md
 * file. A copy of the GNU GPL should also be available in the COPYING.md file.
 *
 * @copyright 2014-2017 Michael Cummings
 * @license   LGPL-3.0+
 * @author    Michael Cummings <[email protected]>
 */
namespace Yapeal\FileSystem;

use Yapeal\Event\EveApiEventEmitterTrait;
use Yapeal\Event\EveApiEventInterface;
use Yapeal\Event\EveApiRetrieverInterface;
use Yapeal\Event\MediatorInterface;
use Yapeal\Log\Logger;
use Yapeal\Xml\EveApiReadWriteInterface;
use Yapeal\Xml\LibXmlChecksTrait;

/**
 * Class CacheRetriever
 */
class CacheRetriever implements EveApiRetrieverInterface
{
    use EveApiEventEmitterTrait;
    use LibXmlChecksTrait;
    use SafeFileHandlingTrait;
    /**
     * CacheRetriever constructor.
     *
     * @param string $cachePath
     */
    public function __construct(string $cachePath)
    {
        $this->setCachePath($cachePath);
    }
    /**
     * Method that is called for retrieve event.
     *
     * @param EveApiEventInterface $event
     * @param string               $eventName
     * @param MediatorInterface    $yem
     *
     * @return EveApiEventInterface
     * @throws \DomainException
     * @throws \InvalidArgumentException
     * @throws \LogicException
     * @throws \UnexpectedValueException
     */
    public function retrieveEveApi(
        EveApiEventInterface $event,
        string $eventName,
        MediatorInterface $yem
    ): EveApiEventInterface {
        if (!$this->shouldRetrieve()) {
            return $event;
        }
        $this->setYem($yem);
        $data = $event->getData();
        $yem->triggerLogEvent('Yapeal.Log.log',
            Logger::DEBUG,
            $this->getReceivedEventMessage($data, $eventName, __CLASS__));
        if (false === $xml = $this->getXmlFileContents($data)) {
            return $event;
        }
        $data->setEveApiXml($xml);
        $mess = 'Successfully retrieved the XML of';
        $yem->triggerLogEvent('Yapeal.Log.log', Logger::DEBUG, $this->createEveApiMessage($mess, $data));
        return $event->setData($data)
            ->setHandledSufficiently();
    }
    /**
     * Set cache path for Eve API XML.
     *
     * @param string $value Absolute path to cache/ directory.
     *
     * @return self Fluent interface.
     */
    public function setCachePath(string $value): self
    {
        $this->cachePath = $value;
        return $this;
    }
    /**
     * Turn on or off retrieving of Eve API data by this retriever.
     *
     * Allows class to stay registered for events but be enabled or disabled during runtime.
     *
     * @param bool $value
     *
     * @return self Fluent interface.
     */
    public function setRetrieve(bool $value = true): self
    {
        $this->retrieve = $value;
        return $this;
    }
    /**
     * Returns current cache path.
     *
     * @return string
     * @throws \LogicException
     */
    private function getCachePath(): string
    {
        if (null === $this->cachePath || '' === $this->cachePath) {
            $mess = 'Tried to access $cachePath before it was set';
            throw new \LogicException($mess);
        }
        return $this->cachePath;
    }
    /**
     * @param EveApiReadWriteInterface $data
     *
     * @return string|false
     * @throws \DomainException
     * @throws \InvalidArgumentException
     * @throws \LogicException
     * @throws \UnexpectedValueException
     */
    private function getXmlFileContents(EveApiReadWriteInterface $data)
    {
        // BaseSection/ApiHash.xml
        $cacheFile = sprintf('%s%s/%s%s.xml',
            $this->getCachePath(),
            ucfirst($data->getEveApiSectionName()),
            ucfirst($data->getEveApiName()),
            $data->getHash());
        if (false === $xml = $this->safeFileRead($cacheFile)) {
            $messagePrefix = sprintf('Failed to retrieve XML file %s during the retrieval of', $cacheFile);
            $this->getYem()
                ->triggerLogEvent('Yapeal.Log.log', Logger::INFO, $this->createEveApiMessage($messagePrefix, $data));
            return false;
        }
        if ('' === $xml) {
            $messagePrefix = sprintf('Received an empty XML file %s during the retrieval of', $cacheFile);
            $this->getYem()
                ->triggerLogEvent('Yapeal.Log.log', Logger::WARNING, $this->createEveApiMessage($messagePrefix, $data));
            return false;
        }
        $data->setEveApiXml($xml);
        if ($this->isExpired($data)) {
            $this->deleteWithRetry($cacheFile);
            $data->setEveApiXml('');
            return false;
        }
        $messagePrefix = sprintf('Using cached XML file %s during the retrieval of', $cacheFile);
        $this->getYem()
            ->triggerLogEvent('Yapeal.Log.log', Logger::DEBUG, $this->createEveApiMessage($messagePrefix, $data));
        return $xml;
    }
    /**
     * Enforces minimum 5 minute cache time and does some basic checks to see if XML DateTimes are valid.
     *
     * @param EveApiReadWriteInterface $data
     *
     * @return bool
     * @throws \DomainException
     * @throws \InvalidArgumentException
     * @throws \LogicException
     * @throws \UnexpectedValueException
     */
    private function isExpired(EveApiReadWriteInterface $data): bool
    {
        libxml_clear_errors();
        libxml_use_internal_errors(true);
        try {
            $simple = new \SimpleXMLElement($data->getEveApiXml());
        } catch (\Exception $exc) {
            $messagePrefix = 'The XML cause SimpleXMLElement exception during the retrieval of';
            $this->getYem()
                ->triggerLogEvent('Yapeal.Log.log',
                    Logger::WARNING,
                    $this->createEveApiMessage($messagePrefix, $data),
                    ['exception' => $exc]);
            $this->checkLibXmlErrors($data, $this->getYem());
            libxml_use_internal_errors(false);
            return true;
        }
        libxml_use_internal_errors(false);
        /** @noinspection PhpUndefinedFieldInspection */
        if (null === $currentTime = $simple->currentTime[0]) {
            $messagePrefix = 'Cached XML file missing required currentTime element during the retrieval of';
            $this->getYem()
                ->triggerLogEvent('Yapeal.Log.log', Logger::WARNING, $this->createEveApiMessage($messagePrefix, $data));
            return true;
        }
        /** @noinspection PhpUndefinedFieldInspection */
        if (null === $cachedUntil = $simple->cachedUntil[0]) {
            $messagePrefix = 'Cached XML file missing required cachedUntil element during the retrieval of';
            $this->getYem()
                ->triggerLogEvent('Yapeal.Log.log', Logger::WARNING, $this->createEveApiMessage($messagePrefix, $data));
            return true;
        }
        $eveFormat = 'Y-m-d H:i:sP';
        $now = new \DateTimeImmutable('now', new \DateTimeZone('UTC'));
        $current = \DateTimeImmutable::createFromFormat($eveFormat, $currentTime . '+00:00');
        $until = \DateTimeImmutable::createFromFormat($eveFormat, $cachedUntil . '+00:00');
        if (false === $now || false === $current || false === $until) {
            $messagePrefix = 'Failed to get DateTime instance for "now" or currentTime or cachedUntil during the retrieval of';

            $this->getYem()
                ->triggerLogEvent('Yapeal.Log.log', Logger::ERROR, $this->createEveApiMessage($messagePrefix, $data));
            return true;
        }
        // At minimum use cached XML for 5 minutes.
        if ($now <= $current->add(new \DateInterval('PT5M'))) {
            return false;
        }
        return ($until <= $now);
    }
    /**
     * @return bool
     */
    private function shouldRetrieve(): bool
    {
        return $this->retrieve;
    }
    /**
     * @var string $cachePath
     */
    private $cachePath;
    /**
     * @var bool $retrieve
     */
    private $retrieve = false;
}


1		<?php
2		declare(strict_types = 1);
3		/**
4		* Contains CacheRetriever class.
5		*
6		* PHP version 7.0+
7		*
8		* LICENSE:
9		* This file is part of Yet Another Php Eve Api Library also know as Yapeal
10		* which can be used to access the Eve Online API data and place it into a
11		* database.
12		* Copyright (C) 2014-2017 Michael Cummings
13		*
14		* This program is free software: you can redistribute it and/or modify it
15		* under the terms of the GNU Lesser General Public License as published by the
16		* Free Software Foundation, either version 3 of the License, or (at your
17		* option) any later version.
18		*
19		* This program is distributed in the hope that it will be useful, but WITHOUT
20		* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21		* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
22		* for more details.
23		*
24		* You should have received a copy of the GNU Lesser General Public License
25		* along with this program. If not, see
26		* <http://spdx.org/licenses/LGPL-3.0.html>.
27		*
28		* You should be able to find a copy of this license in the COPYING-LESSER.md
29		* file. A copy of the GNU GPL should also be available in the COPYING.md file.
30		*
31		* @copyright 2014-2017 Michael Cummings
32		* @license LGPL-3.0+
33		* @author Michael Cummings <[email protected]>
34		*/
35		namespace Yapeal\FileSystem;
36
37		use Yapeal\Event\EveApiEventEmitterTrait;
38		use Yapeal\Event\EveApiEventInterface;
39		use Yapeal\Event\EveApiRetrieverInterface;
40		use Yapeal\Event\MediatorInterface;
41		use Yapeal\Log\Logger;
42		use Yapeal\Xml\EveApiReadWriteInterface;
43		use Yapeal\Xml\LibXmlChecksTrait;
44
45		/**
46		* Class CacheRetriever
47		*/
48		class CacheRetriever implements EveApiRetrieverInterface
49		{
50		use EveApiEventEmitterTrait;
51		use LibXmlChecksTrait;
52		use SafeFileHandlingTrait;
53		/**
54		* CacheRetriever constructor.
55		*
56		* @param string $cachePath
57		*/
58	13	public function __construct(string $cachePath)
59		{
60	13	$this->setCachePath($cachePath);
61		}
62		/**
63		* Method that is called for retrieve event.
64		*
65		* @param EveApiEventInterface $event
66		* @param string $eventName
67		* @param MediatorInterface $yem
68		*
69		* @return EveApiEventInterface
70		* @throws \DomainException
71		* @throws \InvalidArgumentException
72		* @throws \LogicException
73		* @throws \UnexpectedValueException
74		*/
75	12	public function retrieveEveApi(
76		EveApiEventInterface $event,
77		string $eventName,
78		MediatorInterface $yem
79		): EveApiEventInterface {
80	12	if (!$this->shouldRetrieve()) {
81	1	return $event;
82		}
83	11	$this->setYem($yem);
84	11	$data = $event->getData();
85	11	$yem->triggerLogEvent('Yapeal.Log.log',
86	11	Logger::DEBUG,
87	11	$this->getReceivedEventMessage($data, $eventName, __CLASS__));
88	11	if (false === $xml = $this->getXmlFileContents($data)) {
89	8	return $event;
90		}
91	2	$data->setEveApiXml($xml);
92	2	$mess = 'Successfully retrieved the XML of';
93	2	$yem->triggerLogEvent('Yapeal.Log.log', Logger::DEBUG, $this->createEveApiMessage($mess, $data));
94	2	return $event->setData($data)
95	2	->setHandledSufficiently();
96		}
97		/**
98		* Set cache path for Eve API XML.
99		*
100		* @param string $value Absolute path to cache/ directory.
101		*
102		* @return self Fluent interface.
103		*/
104	13	public function setCachePath(string $value): self
105		{
106	13	$this->cachePath = $value;
107	13	return $this;
108		}
109		/**
110		* Turn on or off retrieving of Eve API data by this retriever.
111		*
112		* Allows class to stay registered for events but be enabled or disabled during runtime.
113		*
114		* @param bool $value
115		*
116		* @return self Fluent interface.
117		*/
118	13	public function setRetrieve(bool $value = true): self
119		{
120	13	$this->retrieve = $value;
121	13	return $this;
122		}
123		/**
124		* Returns current cache path.
125		*
126		* @return string
127		* @throws \LogicException
128		*/
129	11	private function getCachePath(): string
130		{
131	11	if (null === $this->cachePath \|\| '' === $this->cachePath) {
132	1	$mess = 'Tried to access $cachePath before it was set';
133	1	throw new \LogicException($mess);
134		}
135	10	return $this->cachePath;
136		}
137		/**
138		* @param EveApiReadWriteInterface $data
139		*
140		* @return string\|false
141		* @throws \DomainException
142		* @throws \InvalidArgumentException
143		* @throws \LogicException
144		* @throws \UnexpectedValueException
145		*/
146	11	private function getXmlFileContents(EveApiReadWriteInterface $data)
147		{
148		// BaseSection/ApiHash.xml
149	11	$cacheFile = sprintf('%s%s/%s%s.xml',
150	11	$this->getCachePath(),
151	10	ucfirst($data->getEveApiSectionName()),
152	10	ucfirst($data->getEveApiName()),
153	10	$data->getHash());
154	10	if (false === $xml = $this->safeFileRead($cacheFile)) {
155	1	$messagePrefix = sprintf('Failed to retrieve XML file %s during the retrieval of', $cacheFile);
156	1	$this->getYem()
157	1	->triggerLogEvent('Yapeal.Log.log', Logger::INFO, $this->createEveApiMessage($messagePrefix, $data));
158	1	return false;
159		}
160	9	if ('' === $xml) {
161	1	$messagePrefix = sprintf('Received an empty XML file %s during the retrieval of', $cacheFile);
162	1	$this->getYem()
163	1	->triggerLogEvent('Yapeal.Log.log', Logger::WARNING, $this->createEveApiMessage($messagePrefix, $data));
164	1	return false;
165		}
166	8	$data->setEveApiXml($xml);
167	8	if ($this->isExpired($data)) {
168	6	$this->deleteWithRetry($cacheFile);
169	6	$data->setEveApiXml('');
170	6	return false;
171		}
172	2	$messagePrefix = sprintf('Using cached XML file %s during the retrieval of', $cacheFile);
173	2	$this->getYem()
174	2	->triggerLogEvent('Yapeal.Log.log', Logger::DEBUG, $this->createEveApiMessage($messagePrefix, $data));
175	2	return $xml;
176		}
177		/**
178		* Enforces minimum 5 minute cache time and does some basic checks to see if XML DateTimes are valid.
179		*
180		* @param EveApiReadWriteInterface $data
181		*
182		* @return bool
183		* @throws \DomainException
184		* @throws \InvalidArgumentException
185		* @throws \LogicException
186		* @throws \UnexpectedValueException
187		*/
188	8	private function isExpired(EveApiReadWriteInterface $data): bool
189		{
190	8	libxml_clear_errors();
191	8	libxml_use_internal_errors(true);
192		try {
193	8	$simple = new \SimpleXMLElement($data->getEveApiXml());
194	1	} catch (\Exception $exc) {
195	1	$messagePrefix = 'The XML cause SimpleXMLElement exception during the retrieval of';
196	1	$this->getYem()
197	1	->triggerLogEvent('Yapeal.Log.log',
198	1	Logger::WARNING,
199	1	$this->createEveApiMessage($messagePrefix, $data),
200	1	['exception' => $exc]);
201	1	$this->checkLibXmlErrors($data, $this->getYem());
202	1	libxml_use_internal_errors(false);
203	1	return true;
204		}
205	7	libxml_use_internal_errors(false);
206		/** @noinspection PhpUndefinedFieldInspection */
207	7	if (null === $currentTime = $simple->currentTime[0]) {
208	1	$messagePrefix = 'Cached XML file missing required currentTime element during the retrieval of';
209	1	$this->getYem()
210	1	->triggerLogEvent('Yapeal.Log.log', Logger::WARNING, $this->createEveApiMessage($messagePrefix, $data));
211	1	return true;
212		}
213		/** @noinspection PhpUndefinedFieldInspection */
214	6	if (null === $cachedUntil = $simple->cachedUntil[0]) {
215	1	$messagePrefix = 'Cached XML file missing required cachedUntil element during the retrieval of';
216	1	$this->getYem()
217	1	->triggerLogEvent('Yapeal.Log.log', Logger::WARNING, $this->createEveApiMessage($messagePrefix, $data));
218	1	return true;
219		}
220	5	$eveFormat = 'Y-m-d H:i:sP';
221	5	$now = new \DateTimeImmutable('now', new \DateTimeZone('UTC'));
222	5	$current = \DateTimeImmutable::createFromFormat($eveFormat, $currentTime . '+00:00');
223	5	$until = \DateTimeImmutable::createFromFormat($eveFormat, $cachedUntil . '+00:00');
224	5	if (false === $now \|\| false === $current \|\| false === $until) {
225	1	$messagePrefix = 'Failed to get DateTime instance for "now" or currentTime or cachedUntil during the retrieval of';
		0 ignored issues – show Coding Style introduced 2016-12-13 00:05 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 127 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
226	1	$this->getYem()
227	1	->triggerLogEvent('Yapeal.Log.log', Logger::ERROR, $this->createEveApiMessage($messagePrefix, $data));
228	1	return true;
229		}
230		// At minimum use cached XML for 5 minutes.
231	4	if ($now <= $current->add(new \DateInterval('PT5M'))) {
232	1	return false;
233		}
234	3	return ($until <= $now);
235		}
236		/**
237		* @return bool
238		*/
239	12	private function shouldRetrieve(): bool
240		{
241	12	return $this->retrieve;
242		}
243		/**
244		* @var string $cachePath
245		*/
246		private $cachePath;
247		/**
248		* @var bool $retrieve
249		*/
250		private $retrieve = false;
251		}
252

Yapeal / yapeal-ng

CacheRetriever::setRetrieve() A last analyzed 2017-01-23 23:44 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

CacheRetriever::setRetrieve() A
last analyzed 2017-01-23 23:44 UTC