[bugfix] When an external variable is declared in XQuery throw an error if it was not set before execution

Author: adamretter

exist-core/pom.xml

@@ -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
  *
@@ -314,28 +338,28 @@ private void finish(final TriggerEvent event, final DBBroker broker, final Txn t
 
 	private void declareExternalVariables(final XQueryContext context, final TriggerPhase phase, final TriggerEvent event, final XmldbURI src, final XmldbURI dst, final boolean isCollection) throws XPathException {
 		//declare external variables
-		context.declareVariable(bindingPrefix + "type", new StringValue(phase.legacyPhaseName()));
-		context.declareVariable(bindingPrefix + "event", new StringValue(event.legacyEventName()));
+		context.declareVariable(bindingPrefix + "type", true, new StringValue(phase.legacyPhaseName()));
+		context.declareVariable(bindingPrefix + "event", true, new StringValue(event.legacyEventName()));
 		if (isCollection) {
-			context.declareVariable(bindingPrefix + "collection", new AnyURIValue(src));
+			context.declareVariable(bindingPrefix + "collection", true, new AnyURIValue(src));
 		} else {
-			context.declareVariable(bindingPrefix + "collection", new AnyURIValue(src.removeLastSegment()));
+			context.declareVariable(bindingPrefix + "collection", true, new AnyURIValue(src.removeLastSegment()));
 		}
-		context.declareVariable(bindingPrefix + "uri", new AnyURIValue(src));
+		context.declareVariable(bindingPrefix + "uri", true, new AnyURIValue(src));
 		if (dst == null) {
-			context.declareVariable(bindingPrefix + "new-uri", Sequence.EMPTY_SEQUENCE);
+			context.declareVariable(bindingPrefix + "new-uri", true, Sequence.EMPTY_SEQUENCE);
 		} else {
-			context.declareVariable(bindingPrefix + "new-uri", new AnyURIValue(dst));
+			context.declareVariable(bindingPrefix + "new-uri", true, new AnyURIValue(dst));
 		}
 
 		// For backward compatibility
-		context.declareVariable(bindingPrefix + "eventType", new StringValue(phase.legacyPhaseName()));
-		context.declareVariable(bindingPrefix + "triggerEvent", new StringValue(event.legacyEventName()));
+		context.declareVariable(bindingPrefix + "eventType", true, new StringValue(phase.legacyPhaseName()));
+		context.declareVariable(bindingPrefix + "triggerEvent", true, new StringValue(event.legacyEventName()));
 		if (isCollection) {
-			context.declareVariable(bindingPrefix + "collectionName", new AnyURIValue(src));
+			context.declareVariable(bindingPrefix + "collectionName", true, new AnyURIValue(src));
 		} else {
-			context.declareVariable(bindingPrefix + "collectionName", new AnyURIValue(src.removeLastSegment()));
-			context.declareVariable(bindingPrefix + "documentName", new AnyURIValue(src));
+			context.declareVariable(bindingPrefix + "collectionName", true, new AnyURIValue(src.removeLastSegment()));
+			context.declareVariable(bindingPrefix + "documentName", true, new AnyURIValue(src));
 		}
 
 		//declare user defined parameters as external variables
@@ -344,7 +368,7 @@ private void declareExternalVariables(final XQueryContext context, final Trigger
 				final String varName = (String) o;
 				final String varValue = userDefinedVariables.getProperty(varName);
 
-				context.declareVariable(bindingPrefix + varName, new StringValue(varValue));
+				context.declareVariable(bindingPrefix + varName, true, new StringValue(varValue));
 			}
 		}
 	}
@@ -373,7 +397,7 @@ private CompiledXQuery getScript(final DBBroker broker, final Txn transaction) t
 					final String varName = (String) o;
 					final String varValue = userDefinedVariables.getProperty(varName);
 
-					context.declareVariable(bindingPrefix + varName, new StringValue(varValue));
+					context.declareVariable(bindingPrefix + varName, true, new StringValue(varValue));
 				}
 			}
 

exist-core/src/main/java/org/exist/collections/triggers/XQueryTrigger.java

@@ -1544,9 +1544,9 @@ private void declareExternalAndXQJVariables(final XQueryContext context,
 
             // now declare variable
             if (prefix != null) {
-                context.declareVariable(q.getPrefix() + ":" + q.getLocalPart(), sequence);
+                context.declareVariable(q.getPrefix() + ":" + q.getLocalPart(), true, sequence);
             } else {
-                context.declareVariable(q.getLocalPart(), sequence);
+                context.declareVariable(q.getLocalPart(), true, sequence);
             }
         }
     }
@@ -1651,22 +1651,22 @@ private void executeXProc(final DBBroker broker, final Txn transaction, final Do
                 context.prepareForReuse();
             }
 
-            context.declareVariable("pipeline", resource.getURI().toString());
+            context.declareVariable("pipeline", true, resource.getURI().toString());
 
             final String stdin = request.getParameter("stdin");
-            context.declareVariable("stdin", stdin == null ? "" : stdin);
+            context.declareVariable("stdin", true, stdin == null ? "" : stdin);
 
             final String debug = request.getParameter("debug");
-            context.declareVariable("debug", debug == null ? "0" : "1");
+            context.declareVariable("debug", true, debug == null ? "0" : "1");
 
             final String bindings = request.getParameter("bindings");
-            context.declareVariable("bindings", bindings == null ? "<bindings/>" : bindings);
+            context.declareVariable("bindings", true, bindings == null ? "<bindings/>" : bindings);
 
             final String autobind = request.getParameter("autobind");
-            context.declareVariable("autobind", autobind == null ? "0" : "1");
+            context.declareVariable("autobind", true, autobind == null ? "0" : "1");
 
             final String options = request.getParameter("options");
-            context.declareVariable("options", options == null ? "<options/>" : options);
+            context.declareVariable("options", true, options == null ? "<options/>" : options);
 
             // TODO: don't hardcode this?
             context.setModuleLoadPath(

exist-core/src/main/java/org/exist/http/RESTServer.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
  *
@@ -933,14 +957,14 @@ private void declareVariables(final XQueryContext context, final SourceInfo sour
         // RequestModule.NAMESPACE_URI);
         context.setHttpContext(new XQueryContext.HttpContext(reqw, respw));
 
-        context.declareVariable("exist:controller", sourceInfo.controllerPath);
+        context.declareVariable("exist:controller", true, sourceInfo.controllerPath);
         request.setAttribute("$exist:controller", sourceInfo.controllerPath);
-        context.declareVariable("exist:root", basePath);
+        context.declareVariable("exist:root", true, basePath);
         request.setAttribute("$exist:root", basePath);
-        context.declareVariable("exist:context", request.getContextPath());
+        context.declareVariable("exist:context", true, request.getContextPath());
         request.setAttribute("$exist:context", request.getContextPath());
         final String prefix = staticRewrite == null ? null : staticRewrite.getPrefix();
-        context.declareVariable("exist:prefix", prefix == null ? "" : prefix);
+        context.declareVariable("exist:prefix", true, prefix == null ? "" : prefix);
         request.setAttribute("$exist:prefix", prefix == null ? "" : prefix);
         String path;
         if (sourceInfo.controllerPath.length() > 0 && !"/".equals(sourceInfo.controllerPath)) {
@@ -952,15 +976,15 @@ private void declareVariables(final XQueryContext context, final SourceInfo sour
         if (p != Constants.STRING_NOT_FOUND) {
             path = path.substring(0, p);
         }
-        context.declareVariable("exist:path", path);
+        context.declareVariable("exist:path", true, path);
         request.setAttribute("$exist:path", path);
 
         String resource = "";
         final Matcher nameMatcher = NAME_REGEX.matcher(path);
         if (nameMatcher.matches()) {
             resource = nameMatcher.group(1);
         }
-        context.declareVariable("exist:resource", resource);
+        context.declareVariable("exist:resource", true, resource);
         request.setAttribute("$exist:resource", resource);
 
         if (LOG.isDebugEnabled()) {

exist-core/src/main/java/org/exist/http/urlrewrite/XQueryURLRewrite.java

@@ -712,17 +712,17 @@ private Sequence runQuery(final DBBroker broker, final XmldbURI targetCollection
         }
         final XQuery xqs = broker.getBrokerPool().getXQueryService();
         final XQueryContext ctx = new XQueryContext(broker.getBrokerPool());
-        ctx.declareVariable("dir", tempDir.toAbsolutePath().toString());
+        ctx.declareVariable("dir", true, tempDir.toAbsolutePath().toString());
         final Optional<Path> home = broker.getConfiguration().getExistHome();
         if(home.isPresent()) {
-            ctx.declareVariable("home", home.get().toAbsolutePath().toString());
+            ctx.declareVariable("home", true, home.get().toAbsolutePath().toString());
         }
 
         if (targetCollection != null) {
-            ctx.declareVariable("target", targetCollection.toString());
+            ctx.declareVariable("target", true, targetCollection.toString());
             ctx.setModuleLoadPath(XmldbURI.EMBEDDED_SERVER_URI + targetCollection.toString());
         } else
-            {ctx.declareVariable("target", Sequence.EMPTY_SEQUENCE);}
+            {ctx.declareVariable("target", true, Sequence.EMPTY_SEQUENCE);}
         if (QueryPurpose.PREINSTALL == purpose) {
             // when running pre-setup scripts, base path should point to directory
             // because the target collection does not yet exist

exist-core/src/main/java/org/exist/repo/Deployment.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
  *
@@ -226,7 +250,7 @@ private void executeXQuery(final BrokerPool pool, final DBBroker broker, final S
                 for (final Entry param : params.entrySet()) {
                     final String key = (String) param.getKey();
                     final String value = (String) param.getValue();
-                    context.declareVariable(bindingPrefix + ":" + key, new StringValue(value));
+                    context.declareVariable(bindingPrefix + ":" + key, true, new StringValue(value));
                 }
             }
 

exist-core/src/main/java/org/exist/scheduler/UserXQueryJob.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
  *
@@ -439,8 +463,8 @@ protected Optional<ResourceError> processXInclude(final String href, String xpoi
 
                 //TODO: change these to putting the XmldbURI in, but we need to warn users!
                 if (document != null) {
-                    context.declareVariable("xinclude:current-doc", document.getFileURI().toString());
-                    context.declareVariable("xinclude:current-collection", document.getCollection().getURI().toString());
+                    context.declareVariable("xinclude:current-doc", true, document.getFileURI().toString());
+                    context.declareVariable("xinclude:current-collection", true, document.getCollection().getURI().toString());
                 }
 
                 if (xpointer != null) {
@@ -454,7 +478,7 @@ protected Optional<ResourceError> processXInclude(final String href, String xpoi
                 // pass parameters as variables
                 if (params != null) {
                     for (final Map.Entry<String, String> entry : params.entrySet()) {
-                        context.declareVariable(entry.getKey(), entry.getValue());
+                        context.declareVariable(entry.getKey(), true, entry.getValue());
                     }
                 }
 

exist-core/src/main/java/org/exist/storage/serializers/XIncludeFilter.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.test.runner;
 
 import com.evolvedbinary.j8fu.tuple.Tuple2;
@@ -94,7 +117,7 @@ protected static Sequence executeQuery(final BrokerPool brokerPool, final Source
                 // declare variables for the query
                 for(final Function<XQueryContext, Tuple2<String, Object>> externalVariableBinding : externalVariableBindings) {
                     final Tuple2<String, Object> nameValue = externalVariableBinding.apply(context);
-                    context.declareVariable(nameValue._1, nameValue._2);
+                    context.declareVariable(nameValue._1, true, nameValue._2);
                 }
 
                 final XQuery xqueryService = brokerPool.getXQueryService();