[MNG-5862] XML entities support

Author: gnodet

maven-core/src/main/java/org/apache/maven/internal/transformation/ConsumerPomArtifactTransformer.java

@@ -21,6 +21,8 @@
 import javax.annotation.PreDestroy;
 import javax.inject.Named;
 import javax.inject.Singleton;
+import javax.xml.stream.XMLInputFactory;
+import javax.xml.stream.XMLResolver;
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.XMLStreamReader;
 
@@ -36,6 +38,7 @@
 import java.util.concurrent.CopyOnWriteArraySet;
 import java.util.function.BiConsumer;
 
+import com.ctc.wstx.api.WstxInputProperties;
 import org.apache.maven.feature.Features;
 import org.apache.maven.model.building.DefaultBuildPomXMLFilterFactory;
 import org.apache.maven.model.building.TransformerContext;
@@ -186,6 +189,18 @@ static InputStream transform(Path pomFile, TransformerContext context) throws IO
         try (InputStream input = Files.newInputStream(pomFile)) {
             XMLInputFactory2 factory = new com.ctc.wstx.stax.WstxInputFactory();
             factory.configureForRoundTripping();
+            XMLResolver resolver = (String publicID, String systemID, String baseURI, String namespace) -> {
+                if (systemID != null && systemID.startsWith("file:")) {
+                    return pomFile.resolveSibling(systemID.substring("file:".length()))
+                            .toFile();
+                }
+                return null;
+            };
+            factory.setProperty(XMLInputFactory.IS_REPLACING_ENTITY_REFERENCES, true);
+            factory.setProperty(XMLInputFactory.IS_SUPPORTING_EXTERNAL_ENTITIES, true);
+            factory.setProperty(WstxInputProperties.P_TREAT_CHAR_REFS_AS_ENTS, false);
+            factory.setProperty(WstxInputProperties.P_ENTITY_RESOLVER, resolver);
+            factory.setProperty(WstxInputProperties.P_UNDECLARED_ENTITY_RESOLVER, null);
             XMLStreamReader reader = factory.createXMLStreamReader(input);
             reader = new RawToConsumerPomXMLFilterFactory(new DefaultBuildPomXMLFilterFactory(context, true))
                     .get(reader, pomFile);

maven-model-builder/src/main/java/org/apache/maven/model/io/DefaultModelReader.java

@@ -23,6 +23,7 @@
 import javax.inject.Singleton;
 import javax.xml.stream.Location;
 import javax.xml.stream.XMLInputFactory;
+import javax.xml.stream.XMLResolver;
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.XMLStreamReader;
 
@@ -35,6 +36,7 @@
 import java.util.Map;
 import java.util.Objects;
 
+import com.ctc.wstx.api.WstxInputProperties;
 import org.apache.maven.model.InputSource;
 import org.apache.maven.model.Model;
 import org.apache.maven.model.building.ModelSourceTransformer;
@@ -104,16 +106,26 @@ private TransformerContext getTransformerContext(Map<String, ?> options) {
 
     private Model read(InputStream input, Path pomFile, Map<String, ?> options) throws IOException {
         try {
+            InputSource source = getSource(options);
+            boolean strict = isStrict(options);
             XMLInputFactory factory = new com.ctc.wstx.stax.WstxInputFactory();
-            factory.setProperty(XMLInputFactory.IS_REPLACING_ENTITY_REFERENCES, false);
+            XMLResolver resolver = (String publicID, String systemID, String baseURI, String namespace) -> {
+                if (systemID != null && systemID.startsWith("file:") && pomFile != null) {
+                    return pomFile.resolveSibling(systemID.substring("file:".length()))
+                            .toFile();
+                }
+                return null;
+            };
+            factory.setProperty(XMLInputFactory.IS_REPLACING_ENTITY_REFERENCES, true);
+            factory.setProperty(XMLInputFactory.IS_SUPPORTING_EXTERNAL_ENTITIES, true);
+            factory.setProperty(WstxInputProperties.P_UNDECLARED_ENTITY_RESOLVER, resolver);
+            factory.setProperty(WstxInputProperties.P_ENTITY_RESOLVER, resolver);
             XMLStreamReader parser = factory.createXMLStreamReader(input);
 
             TransformerContext context = getTransformerContext(options);
             XMLStreamReader transformingParser =
                     context != null ? transformer.transform(parser, pomFile, context) : parser;
 
-            InputSource source = getSource(options);
-            boolean strict = isStrict(options);
             if (source != null) {
                 return readModelEx(transformingParser, source, strict);
             } else {

maven-model-transform/src/main/java/org/apache/maven/model/transform/stax/BufferingParser.java

@@ -30,9 +30,11 @@
 import java.util.Objects;
 import java.util.regex.Pattern;
 
+import org.codehaus.stax2.DTDInfo;
 import org.codehaus.stax2.XMLStreamReader2;
+import org.codehaus.stax2.validation.DTDValidationSchema;
 
-public class BufferingParser implements XMLStreamReader {
+public class BufferingParser implements XMLStreamReader, DTDInfo {
 
     private static final Pattern WHITESPACE_REGEX = Pattern.compile("[ \r\t\n]+");
 
@@ -90,6 +92,8 @@ public String toString() {
                 case COMMENT:
                 case SPACE:
                     return "Event{event=" + TYPES[event] + ", text='" + text + "'}";
+                case DTD:
+                    return "Event{event=" + TYPES[event] + ", text='" + text + "'}";
                 case START_ELEMENT:
                     return "Event{" + "event=START_TAG"
                             + ", name='"
@@ -396,6 +400,36 @@ public int getEventType() {
         return current != null ? current.event : delegate.getEventType();
     }
 
+    @Override
+    public Object getProcessedDTD() {
+        return delegate instanceof DTDInfo ? ((DTDInfo) delegate).getProcessedDTD() : null;
+    }
+
+    @Override
+    public String getDTDRootName() {
+        return delegate instanceof DTDInfo ? ((DTDInfo) delegate).getDTDRootName() : null;
+    }
+
+    @Override
+    public String getDTDSystemId() {
+        return delegate instanceof DTDInfo ? ((DTDInfo) delegate).getDTDSystemId() : null;
+    }
+
+    @Override
+    public String getDTDPublicId() {
+        return delegate instanceof DTDInfo ? ((DTDInfo) delegate).getDTDPublicId() : null;
+    }
+
+    @Override
+    public String getDTDInternalSubset() {
+        return delegate instanceof DTDInfo ? ((DTDInfo) delegate).getDTDInternalSubset() : null;
+    }
+
+    @Override
+    public DTDValidationSchema getProcessedDTDSchema() {
+        return delegate instanceof DTDInfo ? ((DTDInfo) delegate).getProcessedDTDSchema() : null;
+    }
+
     @Override
     public int next() throws XMLStreamException {
         while (true) {
@@ -476,13 +510,20 @@ protected Event bufferEvent() throws XMLStreamException {
                 event.name = pp.getLocalName();
                 event.namespace = pp.getNamespaceURI();
                 event.prefix = pp.getPrefix();
-                // event.text = pp.getText();
                 break;
             case CHARACTERS:
             case COMMENT:
             case SPACE:
+                event.text = pp.getText();
+                break;
+            case DTD:
+                event.text = pp.getText();
+                break;
             case CDATA:
+                event.text = pp.getText();
+                break;
             case ENTITY_REFERENCE:
+                event.name = pp.getLocalName();
                 event.text = pp.getText();
                 break;
             default:

maven-model-transform/src/main/java/org/apache/maven/model/transform/stax/XmlUtils.java

@@ -18,6 +18,7 @@
  */
 package org.apache.maven.model.transform.stax;
 
+import javax.xml.stream.XMLInputFactory;
 import javax.xml.stream.XMLOutputFactory;
 import javax.xml.stream.XMLStreamConstants;
 import javax.xml.stream.XMLStreamException;
@@ -101,20 +102,17 @@ public static void copy(XMLStreamReader reader, XMLStreamWriter writer, boolean
                         elementCount = countStack.pop();
                     }
                     break;
-                case XMLStreamConstants.CHARACTERS:
-                    writer.writeCharacters(normalize(reader.getText()));
+                case XMLStreamConstants.PROCESSING_INSTRUCTION:
+                    writer.writeProcessingInstruction(reader.getPITarget(), reader.getPIData());
                     break;
-                case XMLStreamConstants.SPACE:
+                case XMLStreamConstants.CHARACTERS:
                     writer.writeCharacters(normalize(reader.getText()));
                     break;
-                case XMLStreamConstants.ENTITY_REFERENCE:
-                    writer.writeEntityRef(reader.getLocalName());
-                    break;
                 case XMLStreamConstants.COMMENT:
                     writer.writeComment(normalize(reader.getText()));
                     break;
-                case XMLStreamConstants.CDATA:
-                    writer.writeCData(normalize(reader.getText()));
+                case XMLStreamConstants.SPACE:
+                    writer.writeCharacters(normalize(reader.getText()));
                     break;
                 case XMLStreamConstants.START_DOCUMENT:
                     if (reader.getVersion() != null) {
@@ -124,6 +122,38 @@ public static void copy(XMLStreamReader reader, XMLStreamWriter writer, boolean
                 case XMLStreamConstants.END_DOCUMENT:
                     writer.writeEndDocument();
                     return;
+                case XMLStreamConstants.ENTITY_REFERENCE:
+                    if (!((Boolean) reader.getProperty(XMLInputFactory.IS_REPLACING_ENTITY_REFERENCES))) {
+                        writer.writeEntityRef(reader.getLocalName());
+                    }
+                    break;
+                case XMLStreamConstants.ATTRIBUTE:
+                    throw new IllegalStateException();
+                case XMLStreamConstants.DTD:
+                    /*
+                    if (reader instanceof DTDInfo) {
+                        DTDInfo dtd = (DTDInfo) reader;
+                        String name = dtd.getDTDRootName();
+                        String pid = dtd.getDTDPublicId();
+                        String sid = dtd.getDTDSystemId();
+                        String is = reader.getText();
+                        if (pid != null) {
+                            writer.writeDTD("<!DOCTYPE " + name + " PUBLIC " + pid + " " + sid + " [" + is + "]>");
+                        } else if (sid != null) {
+                            writer.writeDTD("<!DOCTYPE " + name + " SYSTEM " + sid + " [" + is + "]>");
+                        } else {
+                            writer.writeDTD("<!DOCTYPE " + name + " [" + is + "]>");
+                        }
+                    }
+                    */
+                    break;
+                case XMLStreamConstants.CDATA:
+                    writer.writeCData(normalize(reader.getText()));
+                    break;
+                case XMLStreamConstants.NAMESPACE:
+                case XMLStreamConstants.NOTATION_DECLARATION:
+                case XMLStreamConstants.ENTITY_DECLARATION:
+                    throw new IllegalStateException();
                 default:
                     break;
             }

maven-model-transform/src/test/java/org/apache/maven/model/transform/ConsumerPomXMLFilterTest.java

@@ -18,16 +18,25 @@
  */
 package org.apache.maven.model.transform;
 
+import javax.xml.stream.XMLInputFactory;
+import javax.xml.stream.XMLResolver;
+import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.XMLStreamReader;
 
+import java.io.ByteArrayOutputStream;
+import java.io.StringReader;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.Optional;
 import java.util.function.BiFunction;
 import java.util.function.Function;
 
+import com.ctc.wstx.api.WstxInputProperties;
+import com.ctc.wstx.stax.WstxInputFactory;
+import org.apache.maven.model.transform.stax.XmlUtils;
 import org.junit.jupiter.api.Test;
 
+import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.xmlunit.assertj.XmlAssert.assertThat;
 
 class ConsumerPomXMLFilterTest extends AbstractXMLFilterTests {
@@ -98,7 +107,7 @@ void aggregatorWithCliFriendlyVersion() throws Exception {
                 + "<project xmlns=\"http://maven.apache.org/POM/4.0.0\"\n"
                 + "       xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n"
                 + "       xsi:schemaLocation=\"http://maven.apache.org/POM/4.0.0\n"
-                + "                           http://maven.apache.org/xsd/maven-4.0.0.xsd\">\n"
+                + "                           https://maven.apache.org/xsd/maven-4.0.0.xsd\">\n"
                 + "  <modelVersion>4.0.0</modelVersion>\n"
                 + "  <groupId>org.sonatype.mavenbook.multispring</groupId>\n"
                 + "  <artifactId>parent</artifactId>\n"
@@ -120,7 +129,7 @@ void aggregatorWithCliFriendlyVersion() throws Exception {
                 + "<project xmlns=\"http://maven.apache.org/POM/4.0.0\"\n"
                 + "       xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n"
                 + "       xsi:schemaLocation=\"http://maven.apache.org/POM/4.0.0\n"
-                + "                           http://maven.apache.org/xsd/maven-4.0.0.xsd\">\n"
+                + "                           https://maven.apache.org/xsd/maven-4.0.0.xsd\">\n"
                 + "  <modelVersion>4.0.0</modelVersion>\n"
                 + "  <groupId>org.sonatype.mavenbook.multispring</groupId>\n"
                 + "  <artifactId>parent</artifactId>\n"
@@ -163,7 +172,7 @@ void licenseHeader() throws Exception {
                 + "\n"
                 + "<project xmlns=\"http://maven.apache.org/POM/4.0.0\"\n"
                 + "  xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n"
-                + "  xsi:schemaLocation=\"http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd\">\n"
+                + "  xsi:schemaLocation=\"http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd\">\n"
                 + "  <modelVersion>4.0.0</modelVersion>\n"
                 + "  <parent>\n"
                 + "    <groupId>org.apache.maven</groupId>\n"
@@ -226,4 +235,40 @@ void lexicalHandler() throws Exception {
         String actual = transform(input);
         assertThat(actual).and(expected).areIdentical();
     }
+
+    @Test
+    void testWithEntities() throws Exception {
+        String input = "<!DOCTYPE foo [\n"
+                + "  <!ENTITY desc SYSTEM \"file:desc.xml\">\n"
+                + "]>\n"
+                + "<project>"
+                + "&desc;"
+                + "</project>";
+        String expected = "<project>" + "<description>foo</description>" + "</project>";
+
+        XMLResolver resolver = new XMLResolver() {
+            @Override
+            public Object resolveEntity(String publicID, String systemID, String baseURI, String namespace)
+                    throws XMLStreamException {
+                if ("file:desc.xml".equals(systemID)) {
+                    return "<?xml version='1.0' encoding='UTF-8'?><description>foo</description>";
+                }
+                return null;
+            }
+        };
+        WstxInputFactory factory = new WstxInputFactory();
+        factory.setProperty(XMLInputFactory.IS_REPLACING_ENTITY_REFERENCES, true);
+        factory.setProperty(XMLInputFactory.IS_SUPPORTING_EXTERNAL_ENTITIES, true);
+        factory.setProperty(WstxInputProperties.P_TREAT_CHAR_REFS_AS_ENTS, false);
+        factory.setProperty(WstxInputProperties.P_UNDECLARED_ENTITY_RESOLVER, resolver);
+        factory.setProperty(WstxInputProperties.P_ENTITY_RESOLVER, resolver);
+        XMLStreamReader parser = factory.createXMLStreamReader(new StringReader(input));
+        XMLStreamReader filter = getFilter(parser);
+        ByteArrayOutputStream baos = new ByteArrayOutputStream();
+        XmlUtils.writeDocument(filter, baos);
+        String actual = baos.toString();
+
+        System.out.println(actual);
+        assertEquals(expected, actual);
+    }
 }

maven-model-transform/src/test/java/org/apache/maven/model/transform/stax/XmlUtilsTest.java

@@ -0,0 +1,50 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.maven.model.transform.stax;
+
+import javax.xml.stream.XMLInputFactory;
+import javax.xml.stream.XMLStreamReader;
+
+import java.io.ByteArrayOutputStream;
+import java.io.StringReader;
+
+import com.ctc.wstx.api.WstxInputProperties;
+import org.codehaus.stax2.XMLInputFactory2;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+public class XmlUtilsTest {
+
+    @Test
+    void testRoundtrip() throws Exception {
+        String xml = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" + "<project>"
+                + "<?foo?>"
+                + "<name>&oelig;</name>"
+                + "</project>";
+        XMLInputFactory2 factory = new com.ctc.wstx.stax.WstxInputFactory();
+        factory.configureForRoundTripping();
+        factory.setProperty(XMLInputFactory.IS_REPLACING_ENTITY_REFERENCES, false);
+        factory.setProperty(WstxInputProperties.P_TREAT_CHAR_REFS_AS_ENTS, false);
+        XMLStreamReader reader = factory.createXMLStreamReader(new StringReader(xml));
+        ByteArrayOutputStream output = new ByteArrayOutputStream();
+        XmlUtils.writeDocument(reader, output);
+        assertEquals(xml, output.toString());
+    }
+}