Allow for passing in a JXE hardened SAX parser factory explicitly.

Related: io7m-com/jxe#20
io7m-com · Sep 1, 2024 · 4b7e95b · 4b7e95b
1 parent 8d8a059
commit 4b7e95b
Show file tree

Hide file tree

Showing 14 changed files with 50 additions and 21 deletions.
diff --git a/README-CHANGES.xml b/README-CHANGES.xml
@@ -34,7 +34,7 @@
         <c:change date="2024-05-10T00:00:00+00:00" summary="Update com.io7m.blackthorne.version:2.0.0 → 2.0.1."/>
       </c:changes>
     </c:release>
-    <c:release date="2024-09-01T10:28:42+00:00" is-open="false" ticket-system="com.github.io7m.trasco" version="2.0.1">
+    <c:release date="2024-09-01T00:00:00+00:00" is-open="false" ticket-system="com.github.io7m.trasco" version="2.0.1">
       <c:changes>
         <c:change date="2024-05-27T00:00:00+00:00" summary="Update jqwik.version:1.8.4 → 1.8.5."/>
         <c:change date="2024-06-28T00:00:00+00:00" summary="Update junit.version:5.10.2 → 5.10.3."/>
@@ -49,6 +49,11 @@
         <c:change date="2024-09-01T00:00:00+00:00" summary="Only require JDK 17."/>
       </c:changes>
     </c:release>
+    <c:release date="2024-09-01T11:44:44+00:00" is-open="true" ticket-system="com.github.io7m.trasco" version="3.0.0">
+      <c:changes>
+        <c:change compatible="false" date="2024-09-01T11:44:44+00:00" summary="Allow for passing in a JXE hardened SAX parser factory explicitly."/>
+      </c:changes>
+    </c:release>
   </c:releases>
   <c:ticket-systems>
     <c:ticket-system default="true" id="com.github.io7m.trasco" url="https://www.github.com/io7m-com/trasco/issues/"/>

diff --git a/com.io7m.trasco.api/pom.xml b/com.io7m.trasco.api/pom.xml
@@ -9,7 +9,7 @@
   <parent>
     <artifactId>com.io7m.trasco</artifactId>
     <groupId>com.io7m.trasco</groupId>
-    <version>2.0.2-SNAPSHOT</version>
+    <version>3.0.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>com.io7m.trasco.api</artifactId>
@@ -38,6 +38,10 @@
       <groupId>com.io7m.anethum</groupId>
       <artifactId>com.io7m.anethum.api</artifactId>
     </dependency>
+    <dependency>
+      <groupId>com.io7m.jxe</groupId>
+      <artifactId>com.io7m.jxe.core</artifactId>
+    </dependency>
   </dependencies>
 
 </project>
diff --git a/...7m.trasco.api/src/main/java/com/io7m/trasco/api/TrSchemaRevisionSetParserFactoryType.java b/...7m.trasco.api/src/main/java/com/io7m/trasco/api/TrSchemaRevisionSetParserFactoryType.java
@@ -18,13 +18,14 @@
 package com.io7m.trasco.api;
 
 import com.io7m.anethum.api.ParserFactoryType;
+import com.io7m.jxe.core.JXEHardenedSAXParsers;
 
 /**
  * A factory of revision set parsers.
  */
 
 public interface TrSchemaRevisionSetParserFactoryType
-  extends ParserFactoryType<Object, TrSchemaRevisionSet, TrSchemaRevisionSetParserType>
+  extends ParserFactoryType<JXEHardenedSAXParsers, TrSchemaRevisionSet, TrSchemaRevisionSetParserType>
 {
 
 }
diff --git a/com.io7m.trasco.api/src/main/java/module-info.java b/com.io7m.trasco.api/src/main/java/module-info.java
@@ -23,9 +23,10 @@
   requires static org.osgi.annotation.bundle;
   requires static org.osgi.annotation.versioning;
 
-  requires transitive com.io7m.anethum.api;
-  requires transitive com.io7m.seltzer.api;
-  requires transitive java.sql;
+  requires com.io7m.anethum.api;
+  requires com.io7m.jxe.core;
+  requires com.io7m.seltzer.api;
+  requires java.sql;
 
   exports com.io7m.trasco.api;
 }
diff --git a/com.io7m.trasco.tests/pom.xml b/com.io7m.trasco.tests/pom.xml
@@ -9,7 +9,7 @@
   <parent>
     <artifactId>com.io7m.trasco</artifactId>
     <groupId>com.io7m.trasco</groupId>
-    <version>2.0.2-SNAPSHOT</version>
+    <version>3.0.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>com.io7m.trasco.tests</artifactId>

diff --git a/com.io7m.trasco.tests/src/main/java/module-info.java b/com.io7m.trasco.tests/src/main/java/module-info.java
@@ -26,10 +26,11 @@
   requires org.junit.platform.engine;
   requires org.junit.platform.launcher;
 
-  requires org.xerial.sqlitejdbc;
+  requires com.io7m.anethum.api;
   requires com.io7m.trasco.api;
   requires com.io7m.trasco.vanilla;
   requires org.slf4j;
+  requires org.xerial.sqlitejdbc;
 
   exports com.io7m.trasco.tests;
 }
diff --git a/com.io7m.trasco.vanilla/pom.xml b/com.io7m.trasco.vanilla/pom.xml
@@ -9,7 +9,7 @@
   <parent>
     <artifactId>com.io7m.trasco</artifactId>
     <groupId>com.io7m.trasco</groupId>
-    <version>2.0.2-SNAPSHOT</version>
+    <version>3.0.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>com.io7m.trasco.vanilla</artifactId>

diff --git a/...io7m.trasco.vanilla/src/main/java/com/io7m/trasco/vanilla/TrSchemaRevisionSetParsers.java b/...io7m.trasco.vanilla/src/main/java/com/io7m/trasco/vanilla/TrSchemaRevisionSetParsers.java
@@ -17,6 +17,7 @@
 package com.io7m.trasco.vanilla;
 
 import com.io7m.anethum.api.ParseStatus;
+import com.io7m.jxe.core.JXEHardenedSAXParsers;
 import com.io7m.trasco.api.TrSchemaRevisionSetParserFactoryType;
 import com.io7m.trasco.api.TrSchemaRevisionSetParserType;
 import com.io7m.trasco.vanilla.internal.TrSchemaSetRevisionParser;
@@ -44,7 +45,7 @@ public TrSchemaRevisionSetParsers()
 
   @Override
   public TrSchemaRevisionSetParserType createParserWithContext(
-    final Object context,
+    final JXEHardenedSAXParsers context,
     final URI source,
     final InputStream stream,
     final Consumer<ParseStatus> statusConsumer)
@@ -53,6 +54,11 @@ public TrSchemaRevisionSetParserType createParserWithContext(
     Objects.requireNonNull(stream, "stream");
     Objects.requireNonNull(statusConsumer, "statusConsumer");
 
-    return new TrSchemaSetRevisionParser(source, stream, statusConsumer);
+    return new TrSchemaSetRevisionParser(
+      Objects.requireNonNullElse(context, new JXEHardenedSAXParsers()),
+      source,
+      stream,
+      statusConsumer
+    );
   }
 }
diff --git a/...sco.vanilla/src/main/java/com/io7m/trasco/vanilla/internal/TrSchemaSetRevisionParser.java b/...sco.vanilla/src/main/java/com/io7m/trasco/vanilla/internal/TrSchemaSetRevisionParser.java
@@ -24,6 +24,8 @@
 import com.io7m.blackthorne.core.BTParseError;
 import com.io7m.blackthorne.core.BTPreserveLexical;
 import com.io7m.blackthorne.jxe.BlackthorneJXE;
+import com.io7m.jxe.core.JXEHardenedSAXParsers;
+import com.io7m.jxe.core.JXEXInclude;
 import com.io7m.trasco.api.TrSchemaRevisionSet;
 import com.io7m.trasco.api.TrSchemaRevisionSetParserType;
 import com.io7m.trasco.vanilla.internal.v1.TrV1SchemaDeclSetParser;
@@ -35,6 +37,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
+import java.util.Optional;
 import java.util.function.Consumer;
 import java.util.stream.Collectors;
 
@@ -50,20 +53,25 @@ public final class TrSchemaSetRevisionParser
   private final URI source;
   private final InputStream stream;
   private final Consumer<ParseStatus> statusConsumer;
+  private final JXEHardenedSAXParsers parsers;
 
   /**
    * A parser of revision sets.
    *
+   * @param inParsers        The SAX parser provider
+   * @param inSource         The source
    * @param inStream         The stream
    * @param inStatusConsumer A status consumer
-   * @param inSource         The source
    */
 
   public TrSchemaSetRevisionParser(
+    final JXEHardenedSAXParsers inParsers,
     final URI inSource,
     final InputStream inStream,
     final Consumer<ParseStatus> inStatusConsumer)
   {
+    this.parsers =
+      Objects.requireNonNull(inParsers, "inParsers");
     this.source =
       Objects.requireNonNull(inSource, "source");
     this.stream =
@@ -96,7 +104,7 @@ public TrSchemaRevisionSet execute()
   {
     try {
       final TrSchemaRevisionSet schemas =
-        BlackthorneJXE.parse(
+        BlackthorneJXE.parseAll(
           this.source,
           this.stream,
           Map.ofEntries(
@@ -105,8 +113,11 @@ public TrSchemaRevisionSet execute()
               TrV1SchemaDeclSetParser::new
             )
           ),
-          TrSchemas.schemas(),
-          BTPreserveLexical.PRESERVE_LEXICAL_INFORMATION
+          this.parsers,
+          Optional.empty(),
+          JXEXInclude.XINCLUDE_DISABLED,
+          BTPreserveLexical.PRESERVE_LEXICAL_INFORMATION,
+          TrSchemas.schemas()
         );
 
       return schemas;

diff --git a/com.io7m.trasco.vanilla/src/main/java/com/io7m/trasco/vanilla/internal/package-info.java b/com.io7m.trasco.vanilla/src/main/java/com/io7m/trasco/vanilla/internal/package-info.java
@@ -18,7 +18,7 @@
  * SQL revision system (Vanilla implementation [internals])
  */
 
-@Version("1.0.0")
+@Version("2.0.0")
 package com.io7m.trasco.vanilla.internal;
 
 import org.osgi.annotation.versioning.Version;
diff --git a/com.io7m.trasco.vanilla/src/main/java/com/io7m/trasco/vanilla/package-info.java b/com.io7m.trasco.vanilla/src/main/java/com/io7m/trasco/vanilla/package-info.java
@@ -19,7 +19,7 @@
  */
 
 @Export
-@Version("1.0.0")
+@Version("2.0.0")
 package com.io7m.trasco.vanilla;
 
 import org.osgi.annotation.bundle.Export;

diff --git a/com.io7m.trasco.vanilla/src/main/java/module-info.java b/com.io7m.trasco.vanilla/src/main/java/module-info.java
@@ -23,15 +23,15 @@
   requires static org.osgi.annotation.bundle;
   requires static org.osgi.annotation.versioning;
 
-  requires transitive com.io7m.trasco.api;
-
+  requires com.io7m.trasco.api;
   requires com.io7m.trasco.xml.schemas;
 
   requires com.io7m.anethum.api;
   requires com.io7m.blackthorne.core;
   requires com.io7m.blackthorne.jxe;
   requires com.io7m.junreachable.core;
   requires com.io7m.jxe.core;
+  requires java.sql;
   requires org.apache.commons.text;
   requires org.slf4j;
 

diff --git a/com.io7m.trasco.xml.schemas/pom.xml b/com.io7m.trasco.xml.schemas/pom.xml
@@ -9,7 +9,7 @@
   <parent>
     <artifactId>com.io7m.trasco</artifactId>
     <groupId>com.io7m.trasco</groupId>
-    <version>2.0.2-SNAPSHOT</version>
+    <version>3.0.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>com.io7m.trasco.xml.schemas</artifactId>

diff --git a/pom.xml b/pom.xml
@@ -13,7 +13,7 @@
 
   <groupId>com.io7m.trasco</groupId>
   <artifactId>com.io7m.trasco</artifactId>
-  <version>2.0.2-SNAPSHOT</version>
+  <version>3.0.0-SNAPSHOT</version>
 
   <packaging>pom</packaging>
   <name>com.io7m.trasco</name>