simplesamlphp / saml2

src/XML/saml/AttributeValue.php

<?php

declare(strict_types=1);

namespace SimpleSAML\SAML2\XML\saml;

use DateTimeImmutable;
use DateTimeInterface;
use DOMElement;
use SimpleSAML\SAML2\Assert\Assert;
use SimpleSAML\SAML2\Constants as C;
use SimpleSAML\XML\AbstractElement;
use SimpleSAML\XML\Chunk;
use SimpleSAML\XML\SchemaValidatableElementInterface;
use SimpleSAML\XML\SchemaValidatableElementTrait;
use SimpleSAML\XMLSchema\Constants as C_XSI;
use SimpleSAML\XMLSchema\Exception\InvalidDOMElementException;

use function class_exists;
use function explode;
use function gettype;
use function intval;
use function str_contains;

/**
 * Serializable class representing an AttributeValue.
 *
 * @package simplesamlphp/saml2
 */
class AttributeValue extends AbstractSamlElement implements SchemaValidatableElementInterface
{
    use SchemaValidatableElementTrait;


    /**
     * Create an AttributeValue.
     *
     * The value of this element. Can be one of:
     *  - string
     *  - int
     *  - null
     *  - \DateTimeInterface
     *  - \SimpleSAML\XML\AbstractElement
     *
     * @param string|int|null|\DateTimeInterface|\SimpleSAML\XML\AbstractElement $value
     * @throws \SimpleSAML\Assert\AssertionFailedException if the supplied value is neither a string or a DOMElement
     */
    final public function __construct(
        protected string|int|null|DateTimeInterface|AbstractElement $value,
    ) {
    }


    /**
     * Get the XSI type of this attribute value.
     *
     * @return string
     */
    public function getXsiType(): string
    {
        $value = $this->getValue();
        $type = gettype($value);

        switch ($type) {
            case "integer":
                return "xs:integer";
            case "NULL":
                return "xs:nil";
            case "object":
                if ($value instanceof DateTimeInterface) {
                    return 'xs:dateTime';
                }

                return sprintf(
                    '%s:%s',
                    $value::getNamespacePrefix(),
                    AbstractElement::getClassName(get_class($value)),
                );
            default:
                return "xs:string";
        }
    }


    /**
     * Get this attribute value.
     *
     * @return string|int|\SimpleSAML\XML\AbstractElement|null
     */
    public function getValue()
    {
        return $this->value;
    }


    /**
     * Convert XML into a AttributeValue
     *
     * @param \DOMElement $xml The XML element we should load
     * @return static
     *
     * @throws \SimpleSAML\XMLSchema\Exception\InvalidDOMElementException
     *   if the qualified name of the supplied element is wrong
     */
    public static function fromXML(DOMElement $xml): static
    {
        Assert::same($xml->localName, 'AttributeValue', InvalidDOMElementException::class);
        Assert::same($xml->namespaceURI, AttributeValue::NS, InvalidDOMElementException::class);

        if ($xml->childElementCount > 0) {
            $node = $xml->firstElementChild;

            if (str_contains($node->tagName, ':')) {
                list($prefix, $eltName) = explode(':', $node->tagName);
                $className = sprintf('\SimpleSAML\SAML2\XML\%s\%s', $prefix, $eltName);

                if (class_exists($className)) {
                    $value = $className::fromXML($node);
                } else {
                    $value = Chunk::fromXML($node);

It seems like $node can also be of type null; however, parameter $xml of SimpleSAML\XML\Chunk::fromXML() does only seem to accept DOMElement, maybe add an additional type check?

                }
            } else {
                $value = Chunk::fromXML($node);
            }
        } elseif (
            $xml->hasAttributeNS(C_XSI::NS_XSI, "type") &&
            $xml->getAttributeNS(C_XSI::NS_XSI, "type") === "xs:integer"
        ) {
            Assert::numeric($xml->textContent);

            // we have an integer as value
            $value = intval($xml->textContent);
        } elseif (
            $xml->hasAttributeNS(C_XSI::NS_XSI, "type") &&
            $xml->getAttributeNS(C_XSI::NS_XSI, "type") === "xs:dateTime"
        ) {
            Assert::validDateTime($xml->textContent);

            // we have a dateTime as value
            $value = new DateTimeImmutable($xml->textContent);
        } elseif (
            // null value
            $xml->hasAttributeNS(C_XSI::NS_XSI, "nil") &&
            ($xml->getAttributeNS(C_XSI::NS_XSI, "nil") === "1" ||
                $xml->getAttributeNS(C_XSI::NS_XSI, "nil") === "true")
        ) {
            Assert::isEmpty($xml->nodeValue);
            Assert::isEmpty($xml->textContent);

            $value = null;
        } else {
            $value = $xml->textContent;
        }

        return new static($value);
    }


    /**
     * Append this attribute value to an element.
     *
     * @param \DOMElement|null $parent The element we should append this attribute value to.
     *
     * @return \DOMElement The generated AttributeValue element.
     */
    public function toXML(?DOMElement $parent = null): DOMElement
    {
        $e = parent::instantiateParentElement($parent);

        $value = $this->getValue();
        $type = gettype($value);

        switch ($type) {
            case "integer":
                // make sure that the xs namespace is available in the AttributeValue
                $e->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:xsi', C_XSI::NS_XSI);
                $e->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:xs', C_XSI::NS_XS);
                $e->setAttributeNS(C_XSI::NS_XSI, 'xsi:type', 'xs:integer');
                $e->textContent = strval($value);
                break;
            case "NULL":
                $e->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:xsi', C_XSI::NS_XSI);
                $e->setAttributeNS(C_XSI::NS_XSI, 'xsi:nil', '1');
                break;
            case "object":
                if ($value instanceof DateTimeInterface) {
                    $e->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:xsi', C_XSI::NS_XSI);
                    $e->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:xs', C_XSI::NS_XS);
                    $e->setAttributeNS(C_XSI::NS_XSI, 'xsi:type', 'xs:dateTime');
                    $e->textContent = $value->format(C::DATETIME_FORMAT);
                } else {
                    $value->toXML($e);
                }
                break;
            default: // string
                $e->textContent = $value;
                break;
        }

        return $e;
    }
}