Migrate DOM-classes to PHP 8.4's new DOM-API (#415)

* Migrate DOM-classes to PHP 8.4's new DOM-API

* Migrate DOM-classes to PHP 8.4's new DOM-API

* Migrate DOM-classes to PHP 8.4's new DOM-API

* Fix syntax

* Fix unit tests

* Fix unit tests

Author: tvdijen

composer.json

@@ -31,9 +31,9 @@
         "psr/http-message": "~2.0",
         "psr/log": "~3.0",
         "simplesamlphp/assert": "~2.0",
-        "simplesamlphp/xml-common": "~2.8",
-        "simplesamlphp/xml-security": "~2.3",
-        "simplesamlphp/xml-soap": "~2.3"
+        "simplesamlphp/xml-common": "dev-feature/dom-migration-php84",
+        "simplesamlphp/xml-security": "dev-feature/dom-migration-php84",
+        "simplesamlphp/xml-soap": "dev-feature/dom-migration-php84"
     },
     "require-dev": {
         "ext-intl": "*",

phpstan-baseline-dev.neon

@@ -30,12 +30,6 @@ parameters:
 			count: 1
 			path: tests/SAML2/Assertion/Validation/AssertionValidatorTest.php
 
-		-
-			message: '#^Parameter \#1 \$xml of static method SimpleSAML\\SAML2\\XML\\saml\\Assertion\:\:fromXML\(\) expects DOMElement, DOMNode\|null given\.$#'
-			identifier: argument.type
-			count: 2
-			path: tests/SAML2/Assertion/Validation/AssertionValidatorTest.php
-
 		-
 			message: '#^Result of method SimpleSAML\\SAML2\\Assertion\\Processor\:\:validateAssertion\(\) \(void\) is used\.$#'
 			identifier: method.void

src/Binding/HTTPArtifact.php

@@ -84,7 +84,9 @@ public function getRedirectURL(AbstractMessage $message): string
             "\x00\x04\x00\x00" . sha1($issuer->getContent()->getValue(), true) . $generatedId,
         );
         $artifactData = $message->toXML();
-        $artifactDataString = $artifactData->ownerDocument?->saveXML($artifactData);
+        /** @var \Dom\XMLDocument $ownerDocument */
+        $ownerDocument = $artifactData->ownerDocument;
+        $artifactDataString = $ownerDocument->saveXML($artifactData);
 
         $clock = Utils::getContainer()->getClock();
         $store->set('artifact', $artifact, $artifactDataString, $clock->now()->add(new DateInterval('PT15M')));

src/Binding/HTTPPost.php

@@ -53,7 +53,9 @@ public function send(AbstractMessage $message): ResponseInterface
         $msgStr = $message->toXML();
 
         Utils::getContainer()->debugMessage($msgStr, 'out');
-        $msgStr = $msgStr->ownerDocument?->saveXML($msgStr);
+        /** @var \Dom\XMLDocument $ownerDocument */
+        $ownerDocument = $msgStr->ownerDocument;
+        $msgStr = $ownerDocument?->saveXML($msgStr);
 
         $msgStr = base64_encode($msgStr);
 

src/Binding/HTTPRedirect.php

@@ -66,7 +66,9 @@ public function getRedirectURL(AbstractMessage $message): string
         $msgStr = $message->toXML();
 
         Utils::getContainer()->debugMessage($msgStr, 'out');
-        $msgStr = $msgStr->ownerDocument?->saveXML($msgStr);
+        /** @var \Dom\XMLDocument $ownerDocument */
+        $ownerDocument = $msgStr->ownerDocument;
+        $msgStr = $ownerDocument->saveXML($msgStr);
 
         $msgStr = gzdeflate($msgStr);
         $msgStr = base64_encode($msgStr);

src/Binding/SOAP.php

@@ -63,7 +63,9 @@ public function getOutputToSend(AbstractMessage $message): string|false
             new Body([$message]),
             $header,
         );
-        return $env->toXML()->ownerDocument?->saveXML();
+        /** @var \Dom\XMLDocument $ownerDocument */
+        $ownerDocument = $env->toXML()->ownerDocument;
+        return $ownerDocument->saveXML();
     }
 
 
@@ -99,12 +101,12 @@ public function receive(/** @scrutinizer ignore-unused */ServerRequestInterface
         }
 
         $document = DOMDocumentFactory::fromString($postText);
-        /** @var \DOMNode $xml */
+        /** @var \Dom\Node $xml */
         $xml = $document->firstChild;
         Utils::getContainer()->debugMessage($document->documentElement, 'in');
 
         $xpCache = XPath::getXPath($document->documentElement);
-        /** @var \DOMElement[] $results */
+        /** @var \Dom\Element[] $results */
         $results = XPath::xpQuery($xml, '/SOAP-ENV:Envelope/SOAP-ENV:Body/*[1]', $xpCache);
 
         return MessageFactory::fromXML($results[0]);

src/Compat/AbstractContainer.php

@@ -142,7 +142,7 @@ abstract public function getLogger(): LoggerInterface;
      * - **encrypt** XML that is about to be encrypted
      * - **decrypt** XML that was just decrypted
      *
-     * @param \DOMElement|string $message
+     * @param \Dom\Element|string $message
      */
     abstract public function debugMessage($message, string $type): void;
 

src/Compat/MockContainer.php

@@ -45,7 +45,7 @@ public function getLogger(): LoggerInterface
      * - **encrypt** XML that is about to be encrypted
      * - **decrypt** XML that was just decrypted
      *
-     * @param \DOMElement|string $message
+     * @param \Dom\Element|string $message
      */
     public function debugMessage($message, string $type): void
     {

src/SOAPClient.php

@@ -147,7 +147,9 @@ public function send(
 
         // Add soap-envelopes
         $env = (new Envelope(new Body([new Chunk($msg->toXML())])))->toXML();
-        $request = $env->ownerDocument?->saveXML();
+        /** @var \Dom\XMLDocument $ownerDocument */
+        $ownerDocument = $env->ownerDocument;
+        $request = $ownerDocument->saveXML();
 
         $container->debugMessage($request, 'out');
 
@@ -163,7 +165,9 @@ public function send(
 
         $dom = DOMDocumentFactory::fromString($soapresponsexml);
         $env = Envelope::fromXML($dom->documentElement);
-        $container->debugMessage($env->toXML()->ownerDocument?->saveXML(), 'in');
+        /** @var \Dom\XMLDocument $ownerDocument */
+        $ownerDocument = $env->toXML()->ownerDocument;
+        $container->debugMessage($ownerDocument->saveXML(), 'in');
 
         $soapfault = $this->getSOAPFault($dom);
         if ($soapfault !== null) {

src/Utils/XPath.php

@@ -4,8 +4,7 @@
 
 namespace SimpleSAML\SAML2\Utils;
 
-use DOMNode;
-use DOMXPath;
+use Dom;
 use SimpleSAML\SAML2\Constants as C;
 
 /**
@@ -16,15 +15,15 @@
 class XPath extends \SimpleSAML\XMLSecurity\Utils\XPath
 {
     /**
-     * Get a DOMXPath object that can be used to search for SAML elements.
+     * Get a Dom\XPath object that can be used to search for SAML elements.
      *
-     * @param \DOMNode $node The document to associate to the DOMXPath object.
+     * @param \Dom\Node $node The document to associate to the Dom\XPath object.
      * @param bool $autoregister Whether to auto-register all namespaces used in the document
      *
-     * @return \DOMXPath A DOMXPath object ready to use in the given document, with several
+     * @return \Dom\XPath A Dom\XPath object ready to use in the given document, with several
      *   saml-related namespaces already registered.
      */
-    public static function getXPath(DOMNode $node, bool $autoregister = false): DOMXPath
+    public static function getXPath(Dom\Node $node, bool $autoregister = false): Dom\XPath
     {
         $xp = parent::getXPath($node, $autoregister);