Yapeal\Xsl\Transformer

Complexity

Total Complexity

19

Size/Duplication

Total Lines	204
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

2.3%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
B	transformEveApi()	0	34	3
A	addYapealProcessingInstructionToXml()	0	22	3
A	checkLibXmlErrors()	0	10	3
A	getXslt()	0	7	2
B	performTransform()	0	63	7

<?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 <mgcummings@yahoo.com>
 */
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));

Are you sure the assignment to $result is correct as $xslt->importStylesheet(new \SimpleXMLElement($xsl)) (which targets XSLTProcessor::importStylesheet()) seems to always return null.

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