SimpleSAML\XML\Type\QNameValue

Complexity

Total Complexity

15

Size/Duplication

Total Lines	162
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	fromParts()	0	15	3
A	getNamespaceURI()	0	3	1
A	validateValue()	0	22	5
A	getValue()	0	3	1
A	getLocalName()	0	3	1
A	fromDocument()	0	16	2
A	getNamespacePrefix()	0	3	1
A	sanitizeValue()	0	3	1

<?php

declare(strict_types=1);

namespace SimpleSAML\XML\Type;

use DOMElement;
use SimpleSAML\XML\Assert\Assert;
use SimpleSAML\XML\Exception\SchemaViolationException;

use function preg_match;

/**
 * @package simplesaml/xml-common
 */
class QNameValue extends AbstractValueType
{
    /** @var string */
    public const SCHEMA_TYPE = 'QName';

    /** @var \SimpleSAML\XML\Type\AnyURIValue|null */
    protected ?AnyURIValue $namespaceURI;

    /** @var \SimpleSAML\XML\Type\NCNameValue|null */
    protected ?NCNameValue $namespacePrefix;

    /** @var \SimpleSAML\XML\Type\NCNameValue */
    protected NCNameValue $localName;

    /** @var string */
    private static string $qname_regex = '/^
        (?:
          \{                 # Match a literal {
            (\S+)            # Match one or more non-whitespace character
          \}                 # Match a literal }
          (?:
            ([\w_][\w.-]*)   # Match a-z or underscore followed by any word-character, dot or dash
            :                # Match a literal :
          )?
        )?                   # Namespace and prefix are optional
        ([\w_][\w.-]*)       # Match a-z or underscore followed by any word-character, dot or dash
        $/Dimx';


    /**
     * Sanitize the value.
     *
     * @param string $value  The unsanitized value
     * @return string
     */
    protected function sanitizeValue(string $value): string
    {
        return static::collapseWhitespace(static::normalizeWhitespace($value));
    }


    /**
     * Validate the value.
     *
     * @param string $value
     * @throws \SimpleSAML\XML\Exception\SchemaViolationException on failure
     * @return void
     */
    protected function validateValue(string $value): void
    {
        $qName = $this->sanitizeValue($value);

        /**
         * Split our custom format of {<namespaceURI>}<prefix>:<localName> into individual parts
         */
        $result = preg_match(
            self::$qname_regex,
            $qName,
            $matches,
            PREG_UNMATCHED_AS_NULL,
        );

        if ($result && count($matches) === 4) {
            list($qName, $namespaceURI, $namespacePrefix, $localName) = $matches;

            $this->namespaceURI = ($namespaceURI !== null) ? AnyURIValue::fromString($namespaceURI) : null;
            $this->namespacePrefix = ($namespacePrefix !== null) ? NCNameValue::fromString($namespacePrefix) : null;
            $this->localName = NCNameValue::fromString($localName);
        } else {
            throw new SchemaViolationException(sprintf('\'%s\' is not a valid xs:QName.', $qName));
        }
    }


    /**
     * Get the value.
     *
     * @return string
     */
    public function getValue(): string
    {
        return $this->getNamespacePrefix() . ':' . $this->getLocalName();
    }


    /**
     * Get the namespaceURI for this qualified name.
     *
     * @return \SimpleSAML\XML\Type\AnyURIValue|null
     */
    public function getNamespaceURI(): ?AnyURIValue
    {
        return $this->namespaceURI;
    }


    /**
     * Get the namespace-prefix for this qualified name.
     *
     * @return \SimpleSAML\XML\Type\NCNameValue|null
     */
    public function getNamespacePrefix(): ?NCNameValue
    {
        return $this->namespacePrefix;
    }


    /**
     * Get the local name for this qualified name.
     *
     * @return \SimpleSAML\XML\Type\NCNameValue
     */
    public function getLocalName(): NCNameValue
    {
        return $this->localName;
    }


    /**
     * @param \SimpleSAML\XML\Type\NCNameValue $localName
     * @param \SimpleSAML\XML\Type\AnyURIValue|null $namespaceURI
     * @param \SimpleSAML\XML\Type\NCNameValue|null $namespacePrefix
     * @return static
     */
    public static function fromParts(
        NCNameValue $localName,
        ?AnyURIValue $namespaceURI,
        ?NCNameValue $namespacePrefix,
    ): static {
        if ($namespaceURI === null) {
            // If we don't have a namespace, we can't have a prefix either
            Assert::null($namespacePrefix, SchemaViolationException::class);
            return new static($localName->getValue());
        }

        return new static(
            '{' . $namespaceURI->getValue() . '}'
            . ($namespacePrefix ? ($namespacePrefix->getValue() . ':') : '')
            . $localName,
        );
    }


    /**
     * @param string $qName
     */
    public static function fromDocument(
        string $qName,
        DOMElement $element,
    ): static {
        $namespacePrefix = null;
        if (str_contains($qName, ':')) {
            list($namespacePrefix, $localName) = explode(':', $qName, 2);
        } else {
            // No prefix
            $localName = $qName;
        }

        // Will return the default namespace (if any) when prefix is NULL
        $namespaceURI = $element->lookupNamespaceUri($namespacePrefix);

        return new static('{' . $namespaceURI . '}' . $namespacePrefix . ':' . $localName);
    }
}