[bugfix] Fix issue with not being able to resolve XSLT import/include from EXPath Packages

Author: adamretter

exist-core/pom.xml

@@ -698,7 +698,7 @@
                                 <include>src/test/resources/log4j2.xml</include>
                                 <include>src/test/resources-filtered/conf.xml</include>
                                 <include>src/test/resources-filtered/org/exist/storage/statistics/conf.xml</include>
-                                <include>src/test/resources-filtered/org/exist/xquery/functions/transform/conf.xml</include>
+                                <include>src/test/resources-filtered/org/exist/xquery/functions/transform/transform-from-pkg-test.conf.xml</include>
                                 <include>src/main/antlr/org/exist/xquery/parser/XQueryTree.g</include>
                                 <include>src/main/java/org/exist/client/ClientFrame.java</include>
                                 <include>src/main/java/org/exist/client/Connection.java</include>
@@ -782,7 +782,9 @@
                                 <include>src/test/java/org/exist/management/JmxRemoteTest.java</include>
                                 <include>src/test/java/org/exist/xmldb/CreateCollectionsTest.java</include>
                                 <include>src/test/java/org/exist/xquery/XQueryFunctionsTest.java</include>
+                                <include>src/test/java/org/exist/xquery/functions/transform/TransformFromPkgTest.java</include>
                                 <include>src/test/java/org/exist/xquery/value/Base64BinaryValueTypeTest.java</include>
+                                <include>src/main/java/org/exist/xslt/XsltURIResolverHelper.java</include>
                                 <include>src/test/resources/org/exist/validation/catalog.xml</include>
                                 <include>src/test/resources/standalone-webapp/WEB-INF/web.xml</include>
                                 <include>src/test/xquery/util/util.xml</include>
@@ -815,7 +817,7 @@
                                 <exclude>src/test/resources/log4j2.xml</exclude>
                                 <exclude>src/test/resources-filtered/conf.xml</exclude>
                                 <exclude>src/test/resources-filtered/org/exist/storage/statistics/conf.xml</exclude>
-                                <exclude>src/test/resources-filtered/org/exist/xquery/functions/transform/conf.xml</exclude>
+                                <exclude>src/test/resources-filtered/org/exist/xquery/functions/transform/transform-from-pkg-test.conf.xml</exclude>
                                 <exclude>src/main/antlr/org/exist/xquery/parser/XQueryTree.g</exclude>
                                 <exclude>src/main/java/org/exist/client/ClientFrame.java</exclude>
                                 <exclude>src/main/java/org/exist/client/Connection.java</exclude>
@@ -900,7 +902,9 @@
                                 <exclude>src/test/java/org/exist/management/JmxRemoteTest.java</exclude>
                                 <exclude>src/test/java/org/exist/xmldb/CreateCollectionsTest.java</exclude>
                                 <exclude>src/test/java/org/exist/xquery/XQueryFunctionsTest.java</exclude>
+                                <exclude>src/test/java/org/exist/xquery/functions/transform/TransformFromPkgTest.java</exclude>
                                 <exclude>src/test/java/org/exist/xquery/value/Base64BinaryValueTypeTest.java</exclude>
+                                <exclude>src/main/java/org/exist/xslt/XsltURIResolverHelper.java</exclude>
                                 <exclude>src/test/resources/org/exist/validation/catalog.xml</exclude>
                                 <exclude>src/test/resources/standalone-webapp/WEB-INF/web.xml</exclude>
                                 <exclude>src/test/xquery/util/util.xml</exclude>

exist-core/src/main/java/org/exist/xslt/EXistURIResolver.java

@@ -50,6 +50,7 @@
 import java.net.URI;
 import java.net.URISyntaxException;
 import java.net.URL;
+import javax.annotation.Nullable;
 import javax.xml.transform.Source;
 import javax.xml.transform.TransformerException;
 import javax.xml.transform.URIResolver;
@@ -69,18 +70,26 @@
 
 /**
  * Implementation of URIResolver which
- * will resolve paths from the eXist database
+ * will resolve paths from the Elemental database
+ * if they cannot be found we can optionally fallback
+ * to returning a StreamSource from a URL
  */
 public class EXistURIResolver implements URIResolver {
 
   private static final Logger LOG = LogManager.getLogger(EXistURIResolver.class);
 
   final BrokerPool db;
   final String basePath;
+  final boolean fallbackToUrlStreamSource;
 
   public EXistURIResolver(final BrokerPool db, final String docPath) {
+    this(db, docPath, false);
+  }
+
+  public EXistURIResolver(final BrokerPool db, final String docPath, final boolean fallbackToUrlStreamSource) {
     this.db = db;
     this.basePath = normalize(docPath);
+    this.fallbackToUrlStreamSource = fallbackToUrlStreamSource;
     if (LOG.isDebugEnabled()) {
       LOG.debug("EXistURIResolver base path set to {}", basePath);
     }
@@ -146,7 +155,7 @@ private String normalizePath(final String path) {
   }
 
   @Override
-  public Source resolve(final String href, String base) throws TransformerException {
+  public @Nullable Source resolve(final String href, String base) throws TransformerException {
     String path;
 
     if (href.isEmpty()) {
@@ -183,8 +192,12 @@ public Source resolve(final String href, String base) throws TransformerExceptio
     if (path.startsWith("/")) {
       path = normalizePath(path);
       return databaseSource(path);
-    } else {
+
+    } else if (fallbackToUrlStreamSource) {
       return urlSource(path);
+
+    } else {
+      return null;
     }
   }
 

exist-core/src/main/java/org/exist/xslt/XsltURIResolverHelper.java

@@ -1,4 +1,28 @@
 /*
+ * Elemental
+ * Copyright (C) 2024, Evolved Binary Ltd
+ *
+ * [email protected]
+ * https://www.evolvedbinary.com | https://www.elemental.xyz
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; version 2.1.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * NOTE: Parts of this file contain code from 'The eXist-db Authors'.
+ *       The original license header is included below.
+ *
+ * =====================================================================
+ *
  * eXist-db Open Source Native XML Database
  * Copyright (C) 2001 The eXist-db Authors
  *
@@ -54,7 +78,7 @@ public class XsltURIResolverHelper {
 
         if (base != null) {
             // database resolver
-            resolvers.add(new EXistURISchemeURIResolver(new EXistURIResolver(brokerPool, base)));
+            resolvers.add(new EXistURISchemeURIResolver(new EXistURIResolver(brokerPool, base, false)));
         }
 
         // EXpath Pkg resolver

exist-core/src/test/java/org/exist/xquery/functions/transform/TransformFromPkgTest.java

@@ -1,4 +1,28 @@
 /*
+ * Elemental
+ * Copyright (C) 2024, Evolved Binary Ltd
+ *
+ * [email protected]
+ * https://www.evolvedbinary.com | https://www.elemental.xyz
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; version 2.1.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * NOTE: Parts of this file contain code from 'The eXist-db Authors'.
+ *       The original license header is included below.
+ *
+ * =====================================================================
+ *
  * eXist-db Open Source Native XML Database
  * Copyright (C) 2001 The eXist-db Authors
  *
@@ -21,21 +45,18 @@
  */
 package org.exist.xquery.functions.transform;
 
-import org.exist.config.TwoDatabasesTest;
-import org.exist.repo.AutoDeploymentTrigger;
 import org.exist.test.ExistXmldbEmbeddedServer;
 import org.junit.*;
 import org.xmldb.api.base.ResourceSet;
 import org.xmldb.api.base.XMLDBException;
 
 import java.net.URISyntaxException;
-import java.net.URL;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 
-import static com.ibm.icu.impl.Assert.fail;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.fail;
 
 /**
  * @author <a href="mailto:[email protected]">Adam Retter</a>
@@ -48,9 +69,9 @@ private static Path getConfigFile() {
         final String packagePath = TransformFromPkgTest.class.getPackage().getName().replace('.', separator);
 
         try {
-            return Paths.get(loader.getResource(packagePath + separator + "conf.xml").toURI());
+            return Paths.get(loader.getResource(packagePath + separator + "transform-from-pkg-test.conf.xml").toURI());
         } catch (final URISyntaxException e) {
-            fail(e);
+            fail(e.getMessage());
             return null;
         }
     }

exist-core/src/test/resources-filtered/org/exist/xquery/functions/transform/conf.xml renamed to exist-core/src/test/resources-filtered/org/exist/xquery/functions/transform/transform-from-pkg-test.conf.xml

@@ -189,6 +189,7 @@
                                 <include>src/test/resources-filtered/conf.xml</include>
                                 <include>src/test/resources/log4j2.xml</include>
                                 <include>src/main/java/org/exist/xquery/modules/xslfo/ApacheFopProcessorAdapter.java</include>
+                                <include>src/main/java/org/exist/xquery/modules/xslfo/RenderXXepProcessorAdapter.java</include>
                             </includes>
                         </licenseSet>
 
@@ -202,6 +203,7 @@
                                 <exclude>src/test/resources-filtered/conf.xml</exclude>
                                 <exclude>src/test/resources/log4j2.xml</exclude>
                                 <exclude>src/main/java/org/exist/xquery/modules/xslfo/ApacheFopProcessorAdapter.java</exclude>
+                                <exclude>src/main/java/org/exist/xquery/modules/xslfo/RenderXXepProcessorAdapter.java</exclude>
                             </excludes>
                         </licenseSet>
 

extensions/modules/xslfo/pom.xml

@@ -185,7 +185,7 @@ private FOUserAgent setupFOUserAgent(final FOUserAgent foUserAgent, final Proper
     private ResourceResolver getResourceResolver(final DBBroker broker, final String baseUri) {
         final ResourceResolverFactory.SchemeAwareResourceResolverBuilder builder = ResourceResolverFactory.createSchemeAwareResourceResolverBuilder(ResourceResolverFactory.createDefaultResourceResolver());
         final URIResolverAdapter uriResolver = new URIResolverAdapter(
-                new EXistURISchemeURIResolver(new EXistURIResolver(broker.getBrokerPool(), baseUri))
+                new EXistURISchemeURIResolver(new EXistURIResolver(broker.getBrokerPool(), baseUri, true))
         );
         builder.registerResourceResolverForScheme("exist", uriResolver);
         builder.registerResourceResolverForScheme("http", uriResolver);

extensions/modules/xslfo/src/main/java/org/exist/xquery/modules/xslfo/ApacheFopProcessorAdapter.java

@@ -1,4 +1,28 @@
 /*
+ * Elemental
+ * Copyright (C) 2024, Evolved Binary Ltd
+ *
+ * [email protected]
+ * https://www.evolvedbinary.com | https://www.elemental.xyz
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; version 2.1.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * NOTE: Parts of this file contain code from 'The eXist-db Authors'.
+ *       The original license header is included below.
+ *
+ * =====================================================================
+ *
  * eXist-db Open Source Native XML Database
  * Copyright (C) 2001 The eXist-db Authors
  *
@@ -75,7 +99,7 @@ public Source resolve(final String href, final String base) throws TransformerEx
 
         private static URIResolver init() throws EXistException {
             final BrokerPool brokerPool = BrokerPool.getInstance();
-            return new EXistURISchemeURIResolver(new EXistURIResolver(brokerPool, DEFAULT_BASE_URI));
+            return new EXistURISchemeURIResolver(new EXistURIResolver(brokerPool, DEFAULT_BASE_URI, true));
         }
     }