[bugfix] Ensure backwards compatibility with eXist-db URL Rewrite Controllers (controller.xq) that use exist: variables but do not declare them as external variables

Closes eXist-db/exist#2060

Author: adamretter

exist-core/pom.xml

@@ -1067,6 +1067,7 @@
                                 <include>src/test/java/org/exist/xquery/ForwardReferenceTest.java</include>
                                 <include>src/main/java/org/exist/xquery/Function.java</include>
                                 <include>src/main/java/org/exist/xquery/FunctionFactory.java</include>
+                                <include>src/test/java/org/exist/xquery/InternalModuleTest.java</include>
                                 <include>src/main/java/org/exist/xquery/LocationStep.java</include>
                                 <include>src/main/java/org/exist/xquery/Module.java</include>
                                 <include>src/main/java/org/exist/xquery/NamedFunctionReference.java</include>
@@ -1082,6 +1083,7 @@
                                 <include>src/main/java/org/exist/xquery/Variable.java</include>
                                 <include>src/main/java/org/exist/xquery/VariableDeclaration.java</include>
                                 <include>src/main/java/org/exist/xquery/VariableImpl.java</include>
+                                <include>src/main/java/org/exist/xquery/VariableReference.java</include>
                                 <include>src/test/java/org/exist/xquery/XmldbBinariesTest.java</include>
                                 <include>src/test/java/org/exist/xquery/XPathOpOrSpecialCaseTest.java</include>
                                 <include>src/test/java/org/exist/xquery/XPathQueryTest.java</include>
@@ -1720,6 +1722,7 @@
                                 <exclude>src/test/resources-filtered/org/exist/xquery/import-from-pkg-test.conf.xml</exclude>
                                 <exclude>src/test/java/org/exist/xquery/ImportFromPkgTest.java</exclude>
                                 <exclude>src/test/java/org/exist/xquery/ImportModuleTest.java</exclude>
+                                <exclude>src/test/java/org/exist/xquery/InternalModuleTest.java</exclude>
                                 <exclude>src/main/java/org/exist/xquery/JavaBinding.java</exclude>
                                 <exclude>src/test/resources-filtered/org/exist/xquery/JavaBindingTest.conf.xml</exclude>
                                 <exclude>src/test/java/org/exist/xquery/JavaBindingTest.java</exclude>
@@ -1739,6 +1742,7 @@
                                 <exclude>src/main/java/org/exist/xquery/Variable.java</exclude>
                                 <exclude>src/main/java/org/exist/xquery/VariableDeclaration.java</exclude>
                                 <exclude>src/main/java/org/exist/xquery/VariableImpl.java</exclude>
+                                <exclude>src/main/java/org/exist/xquery/VariableReference.java</exclude>
                                 <exclude>src/test/java/org/exist/xquery/WatchdogTest.java</exclude>
                                 <exclude>src/test/java/org/exist/xquery/XmldbBinariesTest.java</exclude>
                                 <exclude>src/test/java/org/exist/xquery/XPathOpOrSpecialCaseTest.java</exclude>

exist-core/src/main/java/org/exist/xquery/VariableReference.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,6 +45,7 @@
  */
 package org.exist.xquery;
 
+import org.exist.Namespaces;
 import org.exist.dom.QName;
 import org.exist.dom.persistent.DocumentSet;
 import org.exist.xquery.util.ExpressionDumper;
@@ -59,16 +84,22 @@ public void analyze(final AnalyzeContextInfo contextInfo) throws XPathException
             // ignore: variable might not be known yet
             return;
         }
-        if (var == null) {
-            throw new XPathException(this, ErrorCodes.XPDY0002,
-                    "variable '$" + qname + "' is not set.");
+
+        // TODO(AR) this `if` guard statement is a workaround for controller.xq files that use controller variables (e.g. exist:path) but do not declare them as external
+        if (var == null && !Namespaces.EXIST_NS.equals(qname.getNamespaceURI())) {
+            throw new XPathException(this, ErrorCodes.XPST0008,
+                "Variable '$" + qname + "' is not declared.");
         }
-        if (!var.isInitialized()) {
+
+        if (var != null && !var.isInitialized()) {
             throw new XPathException(this, ErrorCodes.XQST0054,
-                    "variable declaration of '$" + qname + "' cannot " +
-                            "be executed because of a circularity.");
+                "variable declaration of '$" + qname + "' cannot " +
+                    "be executed because of a circularity.");
+        }
+
+        if (var != null) {
+            contextInfo.setStaticReturnType(var.getStaticType());
         }
-        contextInfo.setStaticReturnType(var.getStaticType());
     }
 
     @Override

exist-core/src/test/java/org/exist/xquery/InternalModuleTest.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
  *
@@ -19,7 +43,6 @@
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
-
 package org.exist.xquery;
 
 import org.exist.dom.QName;
@@ -104,9 +127,7 @@ public void requestResponseSessionVariables_4_x_x_Api() throws XMLDBException {
         } catch (final XMLDBException e) {
             assertTrue(e.getCause() instanceof XPathException);
             final XPathException xpe = (XPathException)e.getCause();
-
-            //TODO(AR) should be XPST0008, eXist-db has a bug with the error code, see: https://github.com/eXist-db/exist/issues/2060
-            assertEquals(ErrorCodes.XPDY0002, xpe.getErrorCode());
+            assertEquals(ErrorCodes.XPST0008, xpe.getErrorCode());
         }
     }
 

exist-core/src/test/java/org/exist/xquery/XQueryTest.java

@@ -1065,25 +1065,25 @@ public void module() throws XMLDBException {
         assertEquals("XQuery: " + query, "bar1", result.getResource(1).getContent());
         assertEquals("XQuery: " + query, "bar2", result.getResource(2).getContent());
 
-//			Non-heritance check
+//			Non-transitive inheritance check
         query = "xquery version \"1.0\";\n" + "import module namespace foo=\"foo\" at \"" + URI + "/test/" + FATHER_MODULE_NAME + "\";\n" + "declare namespace foo1=\"foo1\"; \n" + "$foo1:bar";
         try {
             message = "";
             result = service.query(query);
         } catch (XMLDBException e) {
             message = e.getMessage();
         }
-        assertTrue(message.indexOf("XPDY0002") > -1);
+        assertTrue(message.indexOf("XPST0008") > -1);
 
-//			Non-heritance check
+//			Non-transitive inheritance check
         query = "xquery version \"1.0\";\n" + "import module namespace foo=\"foo\" at \"" + URI + "/test/" + FATHER_MODULE_NAME + "\";\n" + "declare namespace foo2=\"foo2\"; \n" + "$foo2:bar";
         try {
             message = "";
             result = service.query(query);
         } catch (XMLDBException e) {
             message = e.getMessage();
         }
-        assertTrue(message.indexOf("XPDY0002") > -1);
+        assertTrue(message.indexOf("XPST0008") > -1);
         query = "xquery version \"1.0\";\n" + "import module namespace foo1=\"foo\" at \"" + URI + "/test/" + CHILD1_MODULE_NAME + "\";\n" + "import module namespace foo2=\"foo\" at \"" + URI + "/test/" + CHILD1_MODULE_NAME + "\";\n" + "$foo1:bar";
         try {
             message = "";

exist-jetty-config/pom.xml

@@ -104,7 +104,7 @@
                             <includes>
                                 <include>pom.xml</include>
                                 <include>src/main/resources/org/exist/jetty/etc/webapps/portal/index.html</include>
-                                <include>src/main/resources/webapp/controller.xql</include>
+                                <include>src/main/resources/webapp/controller.xq</include>
                                 <include>src/main/resources/webapp/404.html</include>
                             </includes>
                         </licenseSet>

…src/main/resources/webapp/controller.xql …/src/main/resources/webapp/controller.xqexist-jetty-config/src/main/resources/webapp/controller.xql renamed to exist-jetty-config/src/main/resources/webapp/controller.xq exist-jetty-config/src/main/resources/webapp/controller.xql renamed to exist-jetty-config/src/main/resources/webapp/controller.xq

@@ -52,11 +52,14 @@ xquery version "3.0";
     sub-controllers.
     ------------------------------------------------------- :)
 
-declare namespace c="http://exist-db.org/xquery/controller";
-declare namespace expath="http://expath.org/ns/pkg";
+declare namespace exist = "http://exist.sourceforge.net/NS/exist";
+declare namespace expath = "http://expath.org/ns/pkg";
 
-import module namespace request="http://exist-db.org/xquery/request";
-import module namespace xdb = "http://exist-db.org/xquery/xmldb";
+import module namespace repo = "http://exist-db.org/xquery/repo";
+import module namespace request = "http://exist-db.org/xquery/request";
+import module namespace util = "http://exist-db.org/xquery/util";
+
+declare variable $exist:path external;
 
 declare function local:get-dashboard() {
 	let $path := collection(repo:get-root())//expath:package[@name = "http://exist-db.org/apps/dashboard"]

extensions/modules/expathrepo/expathrepo-trigger-test/pom.xml

@@ -179,6 +179,7 @@
                                 <include>pom.xml</include>
                                 <include>src/main/java/org/exist/repo/ExampleModule.java</include>
                                 <include>src/test/resources/conf.xml</include>
+                                <include>src/main/xar-resources/controller.xq</include>
                                 <include>xar-assembly.xml</include>
                             </includes>
                         </licenseSet>
@@ -192,6 +193,7 @@
                                 <exclude>pom.xml</exclude>
                                 <exclude>src/main/java/org/exist/repo/ExampleModule.java</exclude>
                                 <exclude>src/test/resources/conf.xml</exclude>
+                                <exclude>src/main/xar-resources/controller.xq</exclude>
                                 <exclude>xar-assembly.xml</exclude>
                             </excludes>
                         </licenseSet>

…st/src/main/xar-resources/controller.xql …est/src/main/xar-resources/controller.xqextensions/modules/expathrepo/expathrepo-trigger-test/src/main/xar-resources/controller.xql renamed to extensions/modules/expathrepo/expathrepo-trigger-test/src/main/xar-resources/controller.xq extensions/modules/expathrepo/expathrepo-trigger-test/src/main/xar-resources/controller.xql renamed to extensions/modules/expathrepo/expathrepo-trigger-test/src/main/xar-resources/controller.xq

@@ -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
  :
@@ -23,6 +47,8 @@ xquery version "3.1";
 
 declare namespace exist = "http://exist.sourceforge.net/NS/exist";
 
+import module namespace request = "http://exist-db.org/xquery/request";
+
 declare variable $exist:path external;
 declare variable $exist:resource external;
 declare variable $exist:controller external;