Import QNameElementTrait

Author: tvdijen

composer.json

@@ -23,7 +23,7 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "SimpleSAML\\Test\\XML\\": ["tests/src", "tests/PHPUnit/", "tests/Utils"]
+            "SimpleSAML\\Test\\XML\\": ["tests/XML", "tests/PHPUnit/", "tests/Utils"]
         }
     },
     "require": {

src/QNameElementTrait.php

@@ -0,0 +1,159 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML;
+
+use DOMElement;
+use SimpleSAML\Assert\Assert;
+use SimpleSAML\XML\Constants;
+use SimpleSAML\XML\Exception\InvalidDOMElementException;
+use SimpleSAML\XML\Exception\SchemaViolationException;
+
+use function preg_split;
+
+/**
+ * Trait grouping common functionality for simple elements with QName textContent
+ *
+ * @package simplesamlphp/xml-common
+ */
+trait QNameElementTrait
+{
+    /** @var string */
+    protected string $content;
+
+    /** @var string|null */
+    protected ?string $namespaceUri;
+
+
+    /**
+     * Set the content of the element.
+     *
+     * @param string $content  The value to go in the XML textContent
+     */
+    protected function setContent(string $content): void
+    {
+        Assert::validQName($content, SchemaViolationException::class);
+        $this->content = $content;
+    }
+
+
+    /**
+     * Get the content of the element.
+     *
+     * @return string
+     */
+    public function getContent(): string
+    {
+        return $this->content;
+    }
+
+
+    /**
+     * Set the namespaceUri.
+     *
+     * @param string|null $namespaceUri
+     */
+    protected function setContentNamespaceUri(?string $namespaceUri): void
+    {
+        Assert::nullOrValidURI($namespaceUri, SchemaViolationException::class);
+        $this->namespaceUri = $namespaceUri;
+    }
+
+
+    /**
+     * Get the namespace URI.
+     *
+     * @return string|null
+     */
+    public function getContentNamespaceUri(): ?string
+    {
+        return $this->namespaceUri;
+    }
+
+
+    /**
+     * Splits a QName into an array holding the prefix (or null if no prefix is available) and the localName
+     *
+     * @param string $qName  The qualified name
+     * @return string[]
+     */
+    private static function parseQName(string $qName): array
+    {
+        Assert::validQName($qName);
+
+        @list($prefix, $localName) = preg_split('/:/', $qName, 2);
+        if ($localName === null) {
+            $prefix = null;
+            $localName = $qName;
+        }
+
+        Assert::nullOrValidNCName($prefix);
+        Assert::validNCName($localName);
+
+        return [$prefix, $localName];
+    }
+
+
+    /**
+     * Convert XML into a class instance
+     *
+     * @param \DOMElement $xml The XML element we should load
+     * @return static
+     *
+     * @throws \SimpleSAML\XML\Exception\InvalidDOMElementException
+     *   If the qualified name of the supplied element is wrong
+     */
+    public static function fromXML(DOMElement $xml): static
+    {
+        Assert::same($xml->localName, static::getLocalName(), InvalidDOMElementException::class);
+        Assert::same($xml->namespaceURI, static::NS, InvalidDOMElementException::class);
+
+        list($prefix, $localName) = self::parseQName($xml->textContent);
+        if ($localName === null) {
+            // We don't have a prefixed value here; use target namespace
+            $namespace = $xml->lookupNamespaceUri(null);
+        } else {
+            $namespace = $xml->lookupNamespaceUri($prefix);
+        }
+
+        return new static($xml->textContent, $namespace);
+    }
+
+
+    /**
+     * Convert this element to XML.
+     *
+     * @param \DOMElement|null $parent The element we should append this element to.
+     * @return \DOMElement
+     */
+    public function toXML(DOMElement $parent = null): DOMElement
+    {
+        $e = $this->instantiateParentElement($parent);
+
+        list($prefix, $localName) = self::parseQName($this->content);
+        if ($this->namespaceUri !== null && $prefix !== null) {
+            if ($e->lookupNamespaceUri($prefix) === null && $e->lookupPrefix($this->namespaceUri) === null) {
+                // The namespace is not yet available in the document - insert it
+                $e->setAttribute('xmlns:' . $prefix, $this->namespaceUri);
+            }
+        }
+
+        $e->textContent = ($prefix === null) ? $localName : ($prefix . ':' . $localName);
+
+        return $e;
+    }
+
+
+    /** @return string */
+    abstract public static function getLocalName(): string;
+
+
+    /**
+     * Create a document structure for this element
+     *
+     * @param \DOMElement|null $parent The element we should append to.
+     * @return \DOMElement
+     */
+    abstract public function instantiateParentElement(DOMElement $parent = null): DOMElement;
+}

tests/Utils/QNameElement.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\Test\XML;
+
+use SimpleSAML\XML\QNameElementTrait;
+use SimpleSAML\XML\AbstractElement;
+
+/**
+ * Empty shell class for testing QNameElement.
+ *
+ * @package simplesaml/xml-common
+ */
+final class QNameElement extends AbstractElement
+{
+    use QNameElementTrait;
+
+    /** @var string */
+    public const NS = 'urn:x-simplesamlphp:namespace';
+
+    /** @var string */
+    public const NS_PREFIX = 'ssp';
+
+
+    /**
+     * @param string $qname
+     * @param string|null $namespaceUri
+     */
+    public function __construct(string $qname, ?string $namespaceUri = null)
+    {
+        $this->setContent($qname);
+        $this->setContentNamespaceUri($namespaceUri);
+    }
+}

tests/src/AbstractElementTest.php renamed to tests/XML/AbstractElementTest.php

@@ -0,0 +1,73 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\Test\XML;
+
+use PHPUnit\Framework\TestCase;
+use SimpleSAML\Assert\Assert;
+use SimpleSAML\Test\XML\QNamelement;
+use SimpleSAML\Test\XML\SerializableElementTestTrait;
+use SimpleSAML\XML\AbstractElement;
+use SimpleSAML\XML\DOMDocumentFactory;
+use SimpleSAML\XML\Exception\SchemaViolationException;
+
+use function dirname;
+use function strval;
+
+/**
+ * Class \SimpleSAML\Test\XML\QNameElementTraitTest
+ *
+ * @covers \SimpleSAML\XML\QNameElementTrait
+ *
+ * @package simplesamlphp\xml-common
+ */
+final class QNameElementTraitTest extends TestCase
+{
+    use SerializableElementTestTrait;
+
+    /**
+     */
+    public function setup(): void
+    {
+        $this->testedClass = QNameElement::class;
+
+        $this->xmlRepresentation = DOMDocumentFactory::fromFile(
+            dirname(dirname(__FILE__)) . '/resources/xml/ssp_QNameElement.xml',
+        );
+    }
+
+
+    /**
+     */
+    public function testMarshalling(): void
+    {
+        $qnameElement = new QNameElement('env:Sender', 'http://www.w3.org/2003/05/soap-envelope');
+
+        $this->assertEquals(
+            $this->xmlRepresentation->saveXML($this->xmlRepresentation->documentElement),
+            strval($qnameElement)
+        );
+    }
+
+
+    /**
+     */
+    public function testMarshallingInvalidQualifiedNameThrowsException(): void
+    {
+        $this->expectException(SchemaViolationException::class);
+
+        new QNameElement('0:Sender', 'http://www.w3.org/2003/05/soap-envelope');
+    }
+
+
+    /**
+     */
+    public function testUnmarshalling(): void
+    {
+        $qnameElement = QNameElement::fromXML($this->xmlRepresentation->documentElement);
+
+        $this->assertEquals('env:Sender', $qnameElement->getContent());
+        $this->assertEquals('http://www.w3.org/2003/05/soap-envelope', $qnameElement->getContentNamespaceUri());
+    }
+}

tests/src/Base64ElementTraitTest.php renamed to tests/XML/Base64ElementTraitTest.php

@@ -0,0 +1 @@
+<ssp:QNameElement xmlns:ssp="urn:x-simplesamlphp:namespace" xmlns:env="http://www.w3.org/2003/05/soap-envelope">env:Sender</ssp:QNameElement>