Transformer::getDom() - Code Metrics - Inspection of "Re-factored Transformer class to use SafeFileHandl..." - Yapeal/yapeal-ng - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( eaf5ea...97c539 )

by Michael

created 2016-11-10 23:18 UTC

Transformer::getDom() A

↳ Parent: Transformer

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

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

<?php
declare(strict_types = 1);
/**
 * Contains Transformer 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) 2015-2016 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 2015-2016 Michael Cummings
 * @license   http://www.gnu.org/copyleft/lesser.html GNU LGPL
 * @author    Michael Cummings <[email protected]>
 */
namespace Yapeal\Xsl;

use Yapeal\Event\EveApiEventEmitterTrait;
use Yapeal\Event\EveApiEventInterface;
use Yapeal\Event\MediatorInterface;
use Yapeal\Exception\YapealFileSystemException;
use Yapeal\FileSystem\RelativeFileSearchTrait;
use Yapeal\FileSystem\SafeFileHandlingTrait;
use Yapeal\Log\Logger;
use Yapeal\Xml\EveApiReadWriteInterface;

/**
 * Class Transformer
 */
class Transformer implements TransformerInterface
{
    use EveApiEventEmitterTrait;
    use RelativeFileSearchTrait;
    use SafeFileHandlingTrait;
    /**
     * Transformer Constructor.
     *
     * @param string $dir Base directory where Eve API XSL files can be found.
     */
    public function __construct(string $dir = __DIR__)
    {
        $this->setRelativeBaseDir($dir . '/');
    }
    /**
     * @param EveApiEventInterface $event
     * @param string               $eventName
     * @param MediatorInterface    $yem
     *
     * @return EveApiEventInterface
     * @throws \DomainException
     * @throws \InvalidArgumentException
     * @throws \LogicException
     */
    public function transformEveApi(EveApiEventInterface $event, string $eventName, MediatorInterface $yem)
    {
        $this->setYem($yem);
        $data = $event->getData();
        $yem->triggerLogEvent('Yapeal.Log.log',
            Logger::DEBUG,
            $this->getReceivedEventMessage($data, $eventName, __CLASS__));
        try {
            $xslName = $this->findRelativeFileWithPath(ucfirst($data->getEveApiSectionName()),
                $data->getEveApiName(),
                'xsl');
        } catch (YapealFileSystemException $exc) {
            $mess = 'Failed to find accessible XSL transform file during';
            $yem->triggerLogEvent('Yapeal.Log.log',
                Logger::WARNING,
                $this->createEventMessage($mess, $data, $eventName),
                ['exception' => $exc]);
            return $event;
        }
        $mess = sprintf('Using %s file to transform', $xslName);
        $yem->triggerLogEvent('Yapeal.Log.log', Logger::DEBUG, $this->createEveApiMessage($mess, $data));
        $xml = $this->addYapealProcessingInstructionToXml($data)
            ->performTransform($xslName, $data);
        if (false === $xml) {
            $mess = 'Failed to transform xml during';
            $yem->triggerLogEvent('Yapeal.Log.log',
                Logger::WARNING,
                $this->createEventMessage($mess, $data, $eventName));
            return $event;
        }
        $xml = (new \tidy())->repairString($xml, $this->tidyConfig, 'utf8');
        return $event->setData($data->setEveApiXml($xml))
            ->setHandledSufficiently();
    }
    /**
     * Adds Processing Instruction to XML containing json encoding of any post used during retrieve.
     *
     * NOTE: This use to be done directly in the network retriever but felt modifying the XML like that belonged in
     * transform instead.
     *
     * @param EveApiReadWriteInterface $data
     *
     * @return self Fluent interface.
     * @throws \InvalidArgumentException
     * @throws \LogicException
     */
    private function addYapealProcessingInstructionToXml(EveApiReadWriteInterface $data): self
    {
        $xml = $data->getEveApiXml();
        if (false === $xml) {
            return $this;
        }
        $arguments = $data->getEveApiArguments();
        if (!empty($arguments['vCode'])) {
            $arguments['vCode'] = substr($arguments['vCode'], 0, 8) . '...';
        }
        unset($arguments['mask'], $arguments['rowCount']);
        ksort($arguments);
        $json = json_encode($arguments);
        $xml = str_replace(["encoding='UTF-8'?>\r\n<eveapi", "encoding='UTF-8'?>\n<eveapi"],
            [
                "encoding='UTF-8'?>\r\n<?yapeal.parameters.json " . $json . "?>\r\n<eveapi",
                "encoding='UTF-8'?>\n<?yapeal.parameters.json " . $json . "?>\n<eveapi"
            ],
            $xml);
        $data->setEveApiXml($xml);
        return $this;
    }
    private function checkLibXmlErrors()
    {
        $errors = libxml_get_errors();
        if (0 !== count($errors)) {
            foreach ($errors as $error) {
                $this->getYem()
                    ->triggerLogEvent('Yapeal.Log.log', Logger::NOTICE, $error->message);
            }
        }
    }
    /**
     * @return \XSLTProcessor
     */
    private function getXslt(): \XSLTProcessor
    {
        if (null === $this->xslt) {
            $this->xslt = new \XSLTProcessor();
        }
        return $this->xslt;
    }
    /**
     * Does actual XSL transform on the Eve API XML.
     *
     * @param string                   $xslName
     * @param EveApiReadWriteInterface $data
     *
     * @return string|false
     * @throws \DomainException
     * @throws \InvalidArgumentException
     * @throws \LogicException
     */
    private function performTransform(string $xslName, EveApiReadWriteInterface $data)
    {
        $xsl = $this->safeFileRead($xslName);
        if (false === $xsl) {
            $mess = sprintf('Failed to read XSL file %s during', $xslName);
            $this->getYem()
                ->triggerLogEvent('Yapeal.Log.log', Logger::NOTICE, $this->createEveApiMessage($mess, $data));
            return false;
        }
        if ('' === $xsl) {
            $mess = sprintf('Received an empty XSL file %s during', $xslName);
            $this->getYem()
                ->triggerLogEvent('Yapeal.Log.log', Logger::NOTICE, $this->createEveApiMessage($mess, $data));
            return false;
        }
        libxml_clear_errors();
        libxml_use_internal_errors(true);
        libxml_clear_errors();
        $xslt = $this->getXslt();
        try {
            $result = $xslt->importStylesheet(new \SimpleXMLElement($xsl));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
        } catch (\Exception $exc) {
            $mess = sprintf('XSL file %s cause SimpleXMLElement exception during', $xslName);
            $this->getYem()
                ->triggerLogEvent('Yapeal.log.log',
                    Logger::WARNING,
                    $this->createEveApiMessage($mess, $data),
                    ['exception' => $exc]);
            $this->checkLibXmlErrors();
            return false;
        }
        if (false === $result) {
            $mess = sprintf('XSLT could not import %s style sheet during', $xslName);
            $this->getYem()
                ->triggerLogEvent('Yapeal.Log.log', Logger::NOTICE, $this->createEveApiMessage($mess, $data));
            $this->checkLibXmlErrors();
            return false;
        }
        $result = false;
        try {
            $result = $xslt->transformToXml(new \SimpleXMLElement($data->getEveApiXml()));
        } catch (\Exception $exc) {
            $mess = 'XML cause SimpleXMLElement exception in';
            $this->getYem()
                ->triggerLogEvent('Yapeal.log.log',
                    Logger::WARNING,
                    $this->createEveApiMessage($mess, $data),
                    ['exception' => $exc]);
            // Fall through intended so any libxml errors are logged and the untransformed XML can be preserved.
        }
        if (false === $result) {
            $this->checkLibXmlErrors();
            $apiName = $data->getEveApiName();
            $data->setEveApiName('Untransformed_' . $apiName);
            // Cache error causing XML.
            $this->emitEvents($data, 'preserve', 'Yapeal.Xml.Error');
            $data->setEveApiName($apiName);
        }
        libxml_clear_errors();
        libxml_use_internal_errors(false);
        libxml_clear_errors();
        return $result;
    }
    /**
     * Holds tidy config settings.
     *
     * @var array $tidyConfig
     */
    private $tidyConfig = [
        'indent' => true,
        'indent-spaces' => 4,
        'input-xml' => true,
        'newline' => 'LF',
        'output-xml' => true,
        'wrap' => '1000'
    ];
    /**
     * @var \XSLTProcessor $xslt
     */
    private $xslt;
}


1		<?php
2		declare(strict_types = 1);
3		/**
4		* Contains Transformer 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) 2015-2016 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 2015-2016 Michael Cummings
32		* @license http://www.gnu.org/copyleft/lesser.html GNU LGPL
33		* @author Michael Cummings <[email protected]>
34		*/
35		namespace Yapeal\Xsl;
36
37		use Yapeal\Event\EveApiEventEmitterTrait;
38		use Yapeal\Event\EveApiEventInterface;
39		use Yapeal\Event\MediatorInterface;
40		use Yapeal\Exception\YapealFileSystemException;
41		use Yapeal\FileSystem\RelativeFileSearchTrait;
42		use Yapeal\FileSystem\SafeFileHandlingTrait;
43		use Yapeal\Log\Logger;
44		use Yapeal\Xml\EveApiReadWriteInterface;
45
46		/**
47		* Class Transformer
48		*/
49		class Transformer implements TransformerInterface
50		{
51		use EveApiEventEmitterTrait;
52		use RelativeFileSearchTrait;
53		use SafeFileHandlingTrait;
54		/**
55		* Transformer Constructor.
56	1	*
57		* @param string $dir Base directory where Eve API XSL files can be found.
58	1	*/
59		public function __construct(string $dir = __DIR__)
60		{
61		$this->setRelativeBaseDir($dir . '/');
62		}
63		/**
64		* @param EveApiEventInterface $event
65		* @param string $eventName
66		* @param MediatorInterface $yem
67		*
68		* @return EveApiEventInterface
69		* @throws \DomainException
70		* @throws \InvalidArgumentException
71		* @throws \LogicException
72		*/
73		public function transformEveApi(EveApiEventInterface $event, string $eventName, MediatorInterface $yem)
74		{
75		$this->setYem($yem);
76		$data = $event->getData();
77		$yem->triggerLogEvent('Yapeal.Log.log',
78		Logger::DEBUG,
79		$this->getReceivedEventMessage($data, $eventName, __CLASS__));
80		try {
81		$xslName = $this->findRelativeFileWithPath(ucfirst($data->getEveApiSectionName()),
82		$data->getEveApiName(),
83		'xsl');
84		} catch (YapealFileSystemException $exc) {
85		$mess = 'Failed to find accessible XSL transform file during';
86		$yem->triggerLogEvent('Yapeal.Log.log',
87		Logger::WARNING,
88		$this->createEventMessage($mess, $data, $eventName),
89		['exception' => $exc]);
90		return $event;
91		}
92		$mess = sprintf('Using %s file to transform', $xslName);
93		$yem->triggerLogEvent('Yapeal.Log.log', Logger::DEBUG, $this->createEveApiMessage($mess, $data));
94		$xml = $this->addYapealProcessingInstructionToXml($data)
95		->performTransform($xslName, $data);
96		if (false === $xml) {
97		$mess = 'Failed to transform xml during';
98		$yem->triggerLogEvent('Yapeal.Log.log',
99		Logger::WARNING,
100		$this->createEventMessage($mess, $data, $eventName));
101		return $event;
102		}
103		$xml = (new \tidy())->repairString($xml, $this->tidyConfig, 'utf8');
104		return $event->setData($data->setEveApiXml($xml))
105		->setHandledSufficiently();
106		}
107		/**
108		* Adds Processing Instruction to XML containing json encoding of any post used during retrieve.
109		*
110		* NOTE: This use to be done directly in the network retriever but felt modifying the XML like that belonged in
111		* transform instead.
112		*
113		* @param EveApiReadWriteInterface $data
114		*
115		* @return self Fluent interface.
116		* @throws \InvalidArgumentException
117		* @throws \LogicException
118		*/
119		private function addYapealProcessingInstructionToXml(EveApiReadWriteInterface $data): self
120		{
121		$xml = $data->getEveApiXml();
122		if (false === $xml) {
123		return $this;
124		}
125		$arguments = $data->getEveApiArguments();
126		if (!empty($arguments['vCode'])) {
127		$arguments['vCode'] = substr($arguments['vCode'], 0, 8) . '...';
128		}
129		unset($arguments['mask'], $arguments['rowCount']);
130		ksort($arguments);
131		$json = json_encode($arguments);
132		$xml = str_replace(["encoding='UTF-8'?>\r\n<eveapi", "encoding='UTF-8'?>\n<eveapi"],
133		[
134		"encoding='UTF-8'?>\r\n<?yapeal.parameters.json " . $json . "?>\r\n<eveapi",
135		"encoding='UTF-8'?>\n<?yapeal.parameters.json " . $json . "?>\n<eveapi"
136		],
137		$xml);
138		$data->setEveApiXml($xml);
139		return $this;
140		}
141		private function checkLibXmlErrors()
142		{
143		$errors = libxml_get_errors();
144		if (0 !== count($errors)) {
145		foreach ($errors as $error) {
146		$this->getYem()
147		->triggerLogEvent('Yapeal.Log.log', Logger::NOTICE, $error->message);
148		}
149		}
150		}
151		/**
152		* @return \XSLTProcessor
153		*/
154		private function getXslt(): \XSLTProcessor
155		{
156		if (null === $this->xslt) {
157		$this->xslt = new \XSLTProcessor();
158		}
159		return $this->xslt;
160		}
161		/**
162		* Does actual XSL transform on the Eve API XML.
163		*
164		* @param string $xslName
165		* @param EveApiReadWriteInterface $data
166		*
167		* @return string\|false
168		* @throws \DomainException
169		* @throws \InvalidArgumentException
170		* @throws \LogicException
171		*/
172		private function performTransform(string $xslName, EveApiReadWriteInterface $data)
173		{
174		$xsl = $this->safeFileRead($xslName);
175		if (false === $xsl) {
176		$mess = sprintf('Failed to read XSL file %s during', $xslName);
177		$this->getYem()
178		->triggerLogEvent('Yapeal.Log.log', Logger::NOTICE, $this->createEveApiMessage($mess, $data));
179		return false;
180		}
181		if ('' === $xsl) {
182		$mess = sprintf('Received an empty XSL file %s during', $xslName);
183		$this->getYem()
184		->triggerLogEvent('Yapeal.Log.log', Logger::NOTICE, $this->createEveApiMessage($mess, $data));
185		return false;
186		}
187		libxml_clear_errors();
188		libxml_use_internal_errors(true);
189		libxml_clear_errors();
190		$xslt = $this->getXslt();
191		try {
192		$result = $xslt->importStylesheet(new \SimpleXMLElement($xsl));
		0 ignored issues – show Bug introduced 2016-11-10 23:24 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$result` is correct as `$xslt->importStylesheet(...SimpleXMLElement($xsl))` (which targets `XSLTProcessor::importStylesheet()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
193		} catch (\Exception $exc) {
194		$mess = sprintf('XSL file %s cause SimpleXMLElement exception during', $xslName);
195		$this->getYem()
196		->triggerLogEvent('Yapeal.log.log',
197		Logger::WARNING,
198		$this->createEveApiMessage($mess, $data),
199		['exception' => $exc]);
200		$this->checkLibXmlErrors();
201		return false;
202		}
203		if (false === $result) {
204		$mess = sprintf('XSLT could not import %s style sheet during', $xslName);
205		$this->getYem()
206		->triggerLogEvent('Yapeal.Log.log', Logger::NOTICE, $this->createEveApiMessage($mess, $data));
207		$this->checkLibXmlErrors();
208		return false;
209		}
210		$result = false;
211		try {
212		$result = $xslt->transformToXml(new \SimpleXMLElement($data->getEveApiXml()));
213		} catch (\Exception $exc) {
214		$mess = 'XML cause SimpleXMLElement exception in';
215		$this->getYem()
216		->triggerLogEvent('Yapeal.log.log',
217		Logger::WARNING,
218		$this->createEveApiMessage($mess, $data),
219		['exception' => $exc]);
220		// Fall through intended so any libxml errors are logged and the untransformed XML can be preserved.
221		}
222		if (false === $result) {
223		$this->checkLibXmlErrors();
224		$apiName = $data->getEveApiName();
225		$data->setEveApiName('Untransformed_' . $apiName);
226		// Cache error causing XML.
227		$this->emitEvents($data, 'preserve', 'Yapeal.Xml.Error');
228		$data->setEveApiName($apiName);
229		}
230		libxml_clear_errors();
231		libxml_use_internal_errors(false);
232		libxml_clear_errors();
233		return $result;
234		}
235		/**
236		* Holds tidy config settings.
237		*
238		* @var array $tidyConfig
239		*/
240		private $tidyConfig = [
241		'indent' => true,
242		'indent-spaces' => 4,
243		'input-xml' => true,
244		'newline' => 'LF',
245		'output-xml' => true,
246		'wrap' => '1000'
247		];
248		/**
249		* @var \XSLTProcessor $xslt
250		*/
251		private $xslt;
252		}
253

Yapeal / yapeal-ng

Push — master ( eaf5ea...97c539 )

Transformer::getDom() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like