Merge pull request #84 from evolvedbinary/7.x.x/hotfix/profiling-fots-prefix

[7.x.x] Show prefix of XPath standard library functions in the profiling output

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
  *
@@ -41,7 +65,8 @@ public interface Namespaces {
 	String SCHEMA_INSTANCE_NS = XMLConstants.W3C_XML_SCHEMA_INSTANCE_NS_URI;
 
     // Move this here from Function.BUILTIN_FUNCTION_NS? /ljo
-	String XPATH_FUNCTIONS_NS = "http://www.w3.org/2005/xpath-functions";	
+	String XPATH_FUNCTIONS_NS = "http://www.w3.org/2005/xpath-functions";
+	String XPATH_FUNCTIONS_PREFIX = "fn";
     String XQUERY_LOCAL_NS = "http://www.w3.org/2005/xquery-local-functions";
 	String XPATH_DATATYPES_NS = "http://www.w3.org/2003/05/xpath-datatypes";
 

exist-core/src/main/java/org/exist/Namespaces.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
  *
@@ -55,10 +79,6 @@
  */
 public abstract class Function extends PathExpr {
 
-    // Declare it in Namespaces instead? /ljo
-    public final static String BUILTIN_FUNCTION_NS =
-            "http://www.w3.org/2005/xpath-functions";
-
     /**
      * The module that declared the function.
      */

exist-core/src/main/java/org/exist/xquery/Function.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
  *
@@ -25,6 +49,7 @@
 import java.util.List;
 
 import org.exist.dom.QName;
+import org.exist.xquery.functions.fn.FnModule;
 import org.exist.xquery.parser.XQueryAST;
 import org.exist.xquery.util.ExpressionDumper;
 import org.exist.xquery.value.FunctionReference;
@@ -53,7 +78,7 @@ public void analyze(AnalyzeContextInfo contextInfo) throws XPathException {
 	}
 
 	public static FunctionCall lookupFunction(Expression self, XQueryContext context, QName funcName, int arity) throws XPathException {
-		if (Function.BUILTIN_FUNCTION_NS.equals(funcName.getNamespaceURI())
+		if (FnModule.NAMESPACE_URI.equals(funcName.getNamespaceURI())
 				&& "concat".equals(funcName.getLocalPart())
 				&& arity < 2) {
 			throw new XPathException(self, ErrorCodes.XPST0017, "No such function; fn:concat requires at least two arguments");

exist-core/src/main/java/org/exist/xquery/NamedFunctionReference.java

@@ -62,6 +62,9 @@
 import java.util.Map;
 import java.util.Set;
 
+import static org.exist.Namespaces.XPATH_FUNCTIONS_NS;
+import static org.exist.Namespaces.XPATH_FUNCTIONS_PREFIX;
+
 /**
  * Implementation of a PerformanceStats that is designed
  * to be used from a single XQuery via its {@link XQueryContext}
@@ -271,11 +274,16 @@ public void recordQuery(final String source, final long elapsed) {
     }
 
     @Override
-    public void recordFunctionCall(final QName qname, final String source, final long elapsed) {
+    public void recordFunctionCall(QName qname, final String source, final long elapsed) {
         if (!isEnabled()) {
             return;
         }
 
+        if (XPATH_FUNCTIONS_NS.equals(qname.getNamespaceURI()) && qname.getPrefix() == null) {
+            // make sure that functions from the XPath/XQuery standard library are shown correctly in the output
+            qname = new QName(qname.getLocalPart(), qname.getNamespaceURI(), XPATH_FUNCTIONS_PREFIX, qname.getNameType());
+        }
+
         final FunctionStats newStats = new FunctionStats(source, qname);
         final FunctionStats stats = functions.get(newStats);
         if (stats == null) {
@@ -437,4 +445,4 @@ public void reset() {
         indexStats.clear();
         optimizations.clear();
     }
-}
+}

exist-core/src/main/java/org/exist/xquery/PerformanceStatsImpl.java

@@ -320,7 +320,7 @@ public class XQueryContext implements BinaryValueManager, Context {
 
     protected String moduleLoadPath = ".";
 
-    private String defaultFunctionNamespace = Function.BUILTIN_FUNCTION_NS;
+    private String defaultFunctionNamespace = Namespaces.XPATH_FUNCTIONS_NS;
     private AnyURIValue defaultElementNamespace = AnyURIValue.EMPTY_URI;
     private AnyURIValue defaultElementNamespaceSchema = AnyURIValue.EMPTY_URI;
 
@@ -441,8 +441,9 @@ public class XQueryContext implements BinaryValueManager, Context {
      * is executing, or null if there is no
      * HTTP context.
      */
-    private @Nullable HttpContext httpContext = null;
-    private static final QName UNNAMED_DECIMAL_FORMAT = new QName("__UNNAMED__", Function.BUILTIN_FUNCTION_NS);
+    @Nullable
+    private HttpContext httpContext = null;
+    private static final QName UNNAMED_DECIMAL_FORMAT = new QName("__UNNAMED__", Namespaces.XPATH_FUNCTIONS_NS);
 
     private final Map<QName, DecimalFormat> staticDecimalFormats = hashMap(Tuple(UNNAMED_DECIMAL_FORMAT, DecimalFormat.UNNAMED));
 
@@ -1046,11 +1047,8 @@ public String getDefaultFunctionNamespace() {
     @Override
     public void setDefaultFunctionNamespace(final String uri) throws XPathException {
         //Not sure for the 2nd clause : eXist-db forces the function NS as default.
-        if (defaultFunctionNamespace != null
-                && !defaultFunctionNamespace.equals(Function.BUILTIN_FUNCTION_NS)
-                && !defaultFunctionNamespace.equals(uri)) {
-            throw new XPathException(rootExpression, ErrorCodes.XQST0066,
-                    "Default function namespace is already set to: '" + defaultFunctionNamespace + "'");
+        if ((defaultFunctionNamespace != null) && !defaultFunctionNamespace.equals(Namespaces.XPATH_FUNCTIONS_NS) && !defaultFunctionNamespace.equals(uri)) {
+            throw new XPathException(rootExpression, ErrorCodes.XQST0066, "Default function namespace is already set to: '" + defaultFunctionNamespace + "'");
         }
         defaultFunctionNamespace = uri;
     }

exist-core/src/main/java/org/exist/xquery/XQueryContext.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
  *
@@ -51,7 +75,7 @@ public class ExtCollection extends BasicFunction {
 
     private static final String FS_COLLECTION_NAME = "collection";
     static final FunctionSignature[] FS_COLLECTION = functionSignatures(
-            new QName(FS_COLLECTION_NAME, Function.BUILTIN_FUNCTION_NS),
+            new QName(FS_COLLECTION_NAME, FnModule.NAMESPACE_URI),
             "Returns the documents contained in the Collection specified in the input sequence. "
                     + XMLDBModule.COLLECTION_URI + " Documents contained in sub-collections are also included. "
                     + "If no value is supplied, the statically know documents are used; for the REST Server this could be the collection in the URI path.",

exist-core/src/main/java/org/exist/xquery/functions/fn/ExtCollection.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
  *
@@ -30,7 +54,7 @@
 public class FnDefaultLanguage extends BasicFunction {
 
     public static final FunctionSignature FS_DEFAULT_LANGUAGE = FunctionDSL.functionSignature(
-            new QName("default-language", Function.BUILTIN_FUNCTION_NS),
+            new QName("default-language", FnModule.NAMESPACE_URI),
             "Returns the xs:language that is " +
                     "the value of the default language property from the dynamic context " +
                     "during the evaluation of a query or transformation in which " +

exist-core/src/main/java/org/exist/xquery/functions/fn/FnDefaultLanguage.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
  *
@@ -69,7 +93,7 @@ public class FnFormatDates extends BasicFunction {
 
 
     public final static FunctionSignature FNS_FORMAT_DATETIME_2 = new FunctionSignature(
-        new QName("format-dateTime", Function.BUILTIN_FUNCTION_NS),
+        new QName("format-dateTime", FnModule.NAMESPACE_URI),
         "Returns a string containing an xs:date value formatted for display.",
         new SequenceType[] {
             DATETIME,
@@ -79,7 +103,7 @@ public class FnFormatDates extends BasicFunction {
     );
 
     public final static FunctionSignature FNS_FORMAT_DATETIME_5 = new FunctionSignature(
-        new QName("format-dateTime", Function.BUILTIN_FUNCTION_NS),
+        new QName("format-dateTime", FnModule.NAMESPACE_URI),
         "Returns a string containing an xs:date value formatted for display.",
         new SequenceType[] {
             DATETIME,
@@ -92,7 +116,7 @@ public class FnFormatDates extends BasicFunction {
     );
 
     public final static FunctionSignature FNS_FORMAT_DATE_2 = new FunctionSignature(
-        new QName("format-date", Function.BUILTIN_FUNCTION_NS),
+        new QName("format-date", FnModule.NAMESPACE_URI),
         "Returns a string containing an xs:date value formatted for display.",
         new SequenceType[] {
             DATE,
@@ -102,7 +126,7 @@ public class FnFormatDates extends BasicFunction {
     );
 
     public final static FunctionSignature FNS_FORMAT_DATE_5 = new FunctionSignature(
-        new QName("format-date", Function.BUILTIN_FUNCTION_NS),
+        new QName("format-date", FnModule.NAMESPACE_URI),
         "Returns a string containing an xs:date value formatted for display.",
         new SequenceType[] {
             DATE,
@@ -115,7 +139,7 @@ public class FnFormatDates extends BasicFunction {
     );
 
     public final static FunctionSignature FNS_FORMAT_TIME_2 = new FunctionSignature(
-        new QName("format-time", Function.BUILTIN_FUNCTION_NS),
+        new QName("format-time", FnModule.NAMESPACE_URI),
         "Returns a string containing an xs:time value formatted for display.",
         new SequenceType[] {
             TIME,
@@ -125,7 +149,7 @@ public class FnFormatDates extends BasicFunction {
     );
 
     public final static FunctionSignature FNS_FORMAT_TIME_5 = new FunctionSignature(
-        new QName("format-time", Function.BUILTIN_FUNCTION_NS),
+        new QName("format-time", FnModule.NAMESPACE_URI),
         "Returns a string containing an xs:time value formatted for display.",
         new SequenceType[] {
             TIME,

exist-core/src/main/java/org/exist/xquery/functions/fn/FnFormatDates.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
  *
@@ -29,7 +53,7 @@
 
 public class FnHasChildren extends Function {
 
-    private final static QName QN_HAS_CHILDREN = new QName("has-children", Function.BUILTIN_FUNCTION_NS);
+    private final static QName QN_HAS_CHILDREN = new QName("has-children", FnModule.NAMESPACE_URI);
 
     public final static FunctionSignature FNS_HAS_CHILDREN_0 = new FunctionSignature(
             QN_HAS_CHILDREN,