Merge pull request #27 from veewee/fix-xsd-includes-without-target-namespace

Fix XSD includes without targetNamespace

Author: veewee

src/Xml/Configurator/FlattenXsdImports.php

@@ -85,22 +85,39 @@ private function includeSchema(DOMElement $include): ?DOMElement
         }
 
         /*
-         * Currently we do not validate the namespace of includes - we assume the provided imports are valid!
+         * Target namespace rules:
          *
          * @see https://docs.microsoft.com/en-us/previous-versions/dotnet/netframework-4.0/ms256198(v=vs.100)
          * The included schema document must meet one of the following conditions.
-            -    It must have the same target namespace as the containing schema document.
-            -    It must not have a target namespace specified (no targetNamespace attribute).
+            - It must have the same target namespace as the containing schema document.
+            - It must not have a target namespace specified (no targetNamespace attribute).
+              In that case, the including schema document provides the target namespace for the new one.
          */
 
+        // Detect namespaces from both the current schema and the import
+        $parentSchema = $this->detectParentSchemaNode($include);
+        $parentTns = $parentSchema->getAttribute('targetNamespace');
+
         $schema = $this->loadSchema($location);
+        if ($schema) {
+            // If the included schema has no targetNamespace, it will inherit the parent schema's namespace.
+            if (!$schema->hasAttribute('targetNamespace')) {
+                $schema->setAttribute('targetNamespace', $parentTns);
+            }
+
+            // Validate if the namespaces of the included document match the parent schema.
+            $schemaTns = $schema->getAttribute('targetNamespace');
+            if ($schemaTns !== $parentTns) {
+                throw FlattenException::invalidIncludeTargetNamespace($parentTns, $schemaTns);
+            }
 
-        // Redefines overwrite tags from includes.
-        // The children of redefine elements are appended to the newly loaded schema.
-        if ($schema && $include->localName === 'redefine') {
-            children($include)->map(
-                static fn (DOMNode $node) => append_external_node($schema, $node)
-            );
+            // Redefines overwrite tags from includes.
+            // The children of redefine elements are appended to the newly loaded schema.
+            if ($include->localName === 'redefine') {
+                children($include)->map(
+                    static fn (DOMNode $node) => append_external_node($schema, $node)
+                );
+            }
         }
 
         // Include tags can be removed, since the schema will be made available in the types
@@ -123,19 +140,14 @@ private function importSchema(DOMElement $import): ?DOMElement
             return null;
         }
 
-        // Find the schema that wants to import the new schema:
-        $doc = Document::fromUnsafeDocument($import->ownerDocument);
-        $xpath = $doc->xpath(new WsdlPreset($doc));
-        /** @var DOMElement $schema */
-        $schema = $xpath->querySingle('ancestor::schema:schema', $import);
-
         // Detect namespaces from both the current schema and the import
         $namespace = $import->getAttribute('namespace');
-        $tns = $schema->getAttribute('targetNamespace');
+        $parentSchema = $this->detectParentSchemaNode($import);
+        $parentTns = $parentSchema->getAttribute('targetNamespace');
 
         // Imports can only deal with different namespaces.
         // You'll need to use "include" if you want to inject something in the same namespace.
-        if ($tns && $namespace && $tns === $namespace) {
+        if ($parentTns && $namespace && $parentTns === $namespace) {
             throw FlattenException::unableToImportXsd($location);
         }
 
@@ -147,6 +159,20 @@ private function importSchema(DOMElement $import): ?DOMElement
         return $schema;
     }
 
+    /**
+     * This function will return the parent declaring <schema /> tag for elements like import | include, ...
+     *
+     * @throws RuntimeException
+     */
+    private function detectParentSchemaNode(DOMElement $element): DOMElement
+    {
+        $parent = Document::fromUnsafeDocument($element->ownerDocument);
+        $xpath = $parent->xpath(new WsdlPreset($parent));
+
+        /** @var DOMElement */
+        return $xpath->querySingle('ancestor::schema:schema', $element);
+    }
+
     /**
      * @throws RuntimeException
      * @throws UnloadableWsdlException

src/Xml/Exception/FlattenException.php

@@ -13,6 +13,11 @@ public static function noLocation(string $elementName): self
         return new self("Parsing Schema: {$elementName} has no 'schemaLocation' attribute");
     }
 
+    public static function invalidIncludeTargetNamespace(string $parentTns, string $currentTns): self
+    {
+        return new self("Parsing Schema: include has an invalid targetNamespace of '$currentTns'. Expected '$parentTns'");
+    }
+
     public static function unableToImportXsd(string $location): self
     {
         $target = $location ? ' from '.$location : '';

tests/fixtures/flattening/result/tnsless-xsd-result.wsdl

@@ -6,12 +6,9 @@
         xmlns:xsd="http://www.w3.org/2001/XMLSchema">
     <types>
         <xsd:schema targetNamespace="http://soapinterop.org/store1">
-            
-        </xsd:schema>
-        <xsd:schema xmlns="http://www.w3.org/2001/XMLSchema" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
             <xsd:complexType name="Store">
                 <xsd:sequence>
-                    <element minOccurs="1" maxOccurs="1" name="Attribute1" type="string"/>
+                    <xsd:element minOccurs="1" maxOccurs="1" name="Attribute1" type="xsd:string"/>
                 </xsd:sequence>
             </xsd:complexType>
         </xsd:schema>

tests/fixtures/flattening/xsd/tnsless.xsd

@@ -1,7 +1,7 @@
 <schema xmlns="http://www.w3.org/2001/XMLSchema" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
     <xsd:complexType name="Store">
         <xsd:sequence>
-            <element minOccurs="1" maxOccurs="1" name="Attribute1" type="string"/>
+            <element minOccurs="1" maxOccurs="1" name="Attribute1" type="xsd:string"/>
         </xsd:sequence>
     </xsd:complexType>
 </schema>