dmt-software / jms-soap-serializer

src/SoapMessageEventSubscriber.php

<?php

namespace DMT\Soap\Serializer;

use JMS\Serializer\EventDispatcher\EventSubscriberInterface;
use JMS\Serializer\EventDispatcher\PreDeserializeEvent;
use JMS\Serializer\EventDispatcher\PreSerializeEvent;
use JMS\Serializer\Exception\InvalidArgumentException;
use JMS\Serializer\Exception\RuntimeException;
use JMS\Serializer\SerializationContext;
use JMS\Serializer\XmlSerializationVisitor;
use Metadata\ClassMetadata;
use SimpleXMLElement;

/**
 * Class SoapMessageEventSubscriber
 *
 * @package DMT\Soap
 */
class SoapMessageEventSubscriber implements EventSubscriberInterface, SoapNamespaceInterface
{
    /**
     * {@inheritdoc}
     */
    public static function getSubscribedEvents(): array
    {
        return [
            [
                'event' => 'serializer.pre_serialize',
                'method' => 'addMessage',
                'format' => 'soap',
            ],
            [
                'event' => 'serializer.pre_deserialize',
                'method' => 'getMessage',
                'format' => 'soap',
            ],
        ];
    }

    /**
     * @param PreSerializeEvent $event
     */
    public function addMessage(PreSerializeEvent $event)
    {
        /** @var SerializationContext $context */
        $context = $event->getContext();
        /** @var XmlSerializationVisitor $visitor */
        $visitor = $context->getVisitor();

        if ($context->getDepth() === 1 && $visitor->getCurrentNode()->nodeName === 'soap:Body') {
            /** @var ClassMetadata $metadata */
            $metadata = $context->getMetadataFactory()->getMetadataForClass($event->getType()['name']);

            if (!isset($metadata->xmlRootName, $metadata->xmlRootNamespace)) {
                throw new RuntimeException('Missing XmlRootName or XmlRootNamespace for ' . $event->getType()['name']);
            }

            $tagName = $metadata->xmlRootName;
            if ($metadata->xmlRootPrefix !== null) {
                $tagName = $metadata->xmlRootPrefix . ':' . $metadata->xmlRootName;
            }
            
            $document = $visitor->getDocument();
            $message = $document->createElementNS($metadata->xmlRootNamespace, $tagName);

            $visitor->getCurrentNode()->appendChild($message);
            $visitor->setCurrentNode($message);
        }
    }

    /**
     * @param PreDeserializeEvent $event
     */
    public function getMessage(PreDeserializeEvent $event)
    {
        /** @var SerializationContext $context */
        $context = $event->getContext();

        if ($context->getDepth() === 1) {
            $element = $this->moveChildNamespacesToEnvelope($event->getData());

            $version = array_search(current($element->getNamespaces()), static::SOAP_NAMESPACES);
            if (!$version) {
                throw new InvalidArgumentException('Unsupported SOAP version');
            }

            $messages = $element->xpath('*[local-name()="Body"]/*');
            if (count($messages) === 1) {
                $element = $messages[0];
            }

            if ($element->getName() === 'Fault') {
                if ($version == static::SOAP_1_1) {
                    $this->throwSoap11Fault($element);
                } else {
                    $this->throwSoap12Fault($element);
                }
            }

            $event->setData($element);
        }
    }

    /**
     * Move all underlying namespaces to root element.
     *
     * @param SimpleXMLElement $element
     *
     * @return SimpleXMLElement
     */
    protected function moveChildNamespacesToEnvelope(SimpleXMLElement $element): SimpleXMLElement
    {
        $dom = dom_import_simplexml($element);

        foreach ($element->getNamespaces(true) as $prefix => $namespace) {
            if (!in_array($namespace, $element->getDocNamespaces())) {
                $dom->setAttributeNS(
                    'http://www.w3.org/2000/xmlns/',
                    $prefix ? 'xmlns:' . $prefix : 'xmlns',
                    $namespace
                );
            }
        }

        return simplexml_import_dom($dom->ownerDocument);

The expression return simplexml_import_dom($dom->ownerDocument) could return the type null which is incompatible with the type-hinted return SimpleXMLElement. Consider adding an additional type-check to rule them out.

It seems like $dom->ownerDocument can also be of type null; however, parameter $node of simplexml_import_dom() does only seem to accept DOMNode, maybe add an additional type check?

    }

    /**
     * @param SimpleXMLElement $fault
     *
     * @throws SoapFaultException
     */
    protected function throwSoap11Fault(SimpleXMLElement $fault)
    {
        $faultcode = $faultstring = '';
        $faultactor = $detail = null;

        $elements = array_filter($this->elementToArray($fault));
        extract($elements, EXTR_IF_EXISTS);

        throw new SoapFaultException($this->removePrefix($faultcode), $faultstring, $faultactor, $detail);
    }

    /**
     * @param SimpleXMLElement $fault
     *
     * @throws SoapFaultException
     */
    protected function throwSoap12Fault(SimpleXMLElement $fault)
    {
        $lang = substr(locale_get_default(), 0, 2);
        $path = '*[local-name()="Reason"]/*[local-name()="Text" and @xml:lang="' . $lang . '"]';

        $messages = $fault->xpath($path);
        if (count($messages) === 0) {
            $messages = $fault->xpath('*[local-name()="Reason"]/*[local-name()="Text"]');
        }

        $code = array_map(
            [$this, 'removePrefix'],
            $fault->xpath('//*[local-name()="Code" or local-name()="Subcode"]/*[local-name()="Value"]')
        );

        $node = $fault->xpath('*[local-name()="Node"]')[0] ?? null;
        $detail = $fault->xpath('*[local-name()="Detail"]')[0] ?? null;

        if ($detail !== null) {
            $detail = $this->elementToArray($detail);
        }

        throw new SoapFaultException(implode('.', $code), $messages[0], $node, $detail);
    }

    /**
     * @param SimpleXMLElement $element
     *
     * @return array
     */
    protected function elementToArray(SimpleXMLElement $element): array
    {
        $result = [];
        foreach ($element->xpath('*') as $node) {
            if (count($node->xpath('*')) > 0) {
                $value = $this->elementToArray($node);
            } else {
                $value = strval($node);
            }
            $result = array_merge_recursive($result, [$node->getName() => $value]);
        }

        return $result;
    }

    /**
     * Remove a prefix from text node.
     *
     * @param string $value A node value containing a namespace prefix, eg SOAP-ENV:Client.
     *
     * @return string
     */
    protected function removePrefix(string $value): string
    {
        return preg_replace('~^(.+:)?(.*)$~', "$2", $value);
    }
}