Better error messages for XML errors (#25)

* Better error messages for XML errors

* cs

Author: Nyholm

composer.json

@@ -6,6 +6,7 @@
         "php": ">=8.0",
         "ext-ctype": "*",
         "ext-iconv": "*",
+        "ext-libxml": "*",
         "doctrine/rst-parser": "^0.4",
         "symfony/console": "^5.2",
         "symfony/docs-builder": "^0.15.0",

src/Service/CodeValidator/JsonValidator.php

@@ -17,7 +17,7 @@ public function validate(CodeNode $node, IssueCollection $issues): void
         try {
             $data = json_decode($node->getValue(), true, 512, JSON_THROW_ON_ERROR);
         } catch (\JsonException $e) {
-            $issues->addIssue(new Issue($node, $e->getMessage(), 'Invalid syntax', $node->getEnvironment()->getCurrentFileName(), 0));
+            $issues->addIssue(new Issue($node, $e->getMessage(), 'JSON syntax', $node->getEnvironment()->getCurrentFileName(), 0));
         }
     }
 }

src/Service/CodeValidator/PhpValidator.php

@@ -32,7 +32,7 @@ public function validate(CodeNode $node, IssueCollection $issues): void
             $text = str_replace($matches[0], '', $text);
             $line = ((int) $matches[1]) - 1; // we added "<?php"
         }
-        $issues->addIssue(new Issue($node, $text, 'Invalid syntax', $node->getEnvironment()->getCurrentFileName(), $line));
+        $issues->addIssue(new Issue($node, $text, 'PHP syntax', $node->getEnvironment()->getCurrentFileName(), $line));
     }
 
     private function getContents(CodeNode $node, string $language): string

src/Service/CodeValidator/XmlValidator.php

@@ -14,26 +14,42 @@ public function validate(CodeNode $node, IssueCollection $issues): void
             return;
         }
 
-        try {
-            set_error_handler(static function ($errno, $errstr) {
-                throw new \RuntimeException($errstr, $errno);
-            });
-
-            try {
-                // Remove first comment only. (No multiline)
-                $xml = preg_replace('#^<!-- .* -->\n#', '', $node->getValue());
-                if ('' !== $xml) {
-                    $xmlObject = new \SimpleXMLElement($xml);
-                }
-            } finally {
-                restore_error_handler();
+        $count = 0;
+        $xml = trim(preg_replace('#^<!-- .* -->\n#', '', $node->getValue(), -1, $count));
+        if ('' === $xml) {
+            return;
+        }
+
+        libxml_use_internal_errors(true);
+        $doc = new \DOMDocument();
+        $doc->loadXML($xml);
+
+        /** @var \LibXMLError[] $errors */
+        $errors = libxml_get_errors();
+        libxml_clear_errors();
+
+        if (!$errors) {
+            return;
+        }
+
+        $error = null;
+        foreach ($errors as $candidate) {
+            if (preg_match('#^Namespace prefix .+ is not defined$#', $candidate->message)) {
+                // Ignore take namespace error
+                continue;
             }
-        } catch (\Throwable $e) {
-            if ('SimpleXMLElement::__construct(): namespace error : Namespace prefix' === substr($e->getMessage(), 0, 67)) {
-                return;
+
+            if (0 === strpos($candidate->message, 'Extra content at the end of the document')) {
+                // This is because there is not element wrapping the content
+                continue;
             }
 
-            $issues->addIssue(new Issue($node, $e->getMessage(), 'Invalid syntax', $node->getEnvironment()->getCurrentFileName(), 0));
+            $error = $candidate;
+            break;
+        }
+
+        if (null !== $error) {
+            $issues->addIssue(new Issue($node, $error->message, 'XML syntax', $node->getEnvironment()->getCurrentFileName(), $error->line + $count));
         }
     }
 }

src/Service/CodeValidator/YamlValidator.php

@@ -25,7 +25,7 @@ public function validate(CodeNode $node, IssueCollection $issues): void
                 return;
             }
 
-            $issues->addIssue(new Issue($node, $e->getMessage(), 'Invalid syntax', $node->getEnvironment()->getCurrentFileName(), $e->getParsedLine()));
+            $issues->addIssue(new Issue($node, $e->getMessage(), 'Yaml syntax', $node->getEnvironment()->getCurrentFileName(), $e->getParsedLine()));
         }
     }
 }