Merge branch 'eXist-db:develop' into rest-client-encoding

marmoure · web-flow · commit 55308a3355d4 · 2022-07-06T04:10:42.000+01:00
diff --git a/exist-core/src/main/java/org/exist/dom/memtree/NodeImpl.java b/exist-core/src/main/java/org/exist/dom/memtree/NodeImpl.java
@@ -42,6 +42,7 @@
 import org.xml.sax.SAXException;
 import org.xml.sax.ext.LexicalHandler;
 
+import javax.annotation.Nullable;
 import javax.xml.XMLConstants;
 import java.util.Iterator;
 import java.util.Properties;
@@ -762,7 +763,7 @@ public boolean contains(final Item item) {
     }
 
     @Override
-    public void destroy(final XQueryContext context, final Sequence contextSequence) {
+    public void destroy(final XQueryContext context, @Nullable final Sequence contextSequence) {
     }
 
 
diff --git a/exist-core/src/main/java/org/exist/dom/persistent/NodeProxy.java b/exist-core/src/main/java/org/exist/dom/persistent/NodeProxy.java
@@ -45,6 +45,7 @@
 import org.xml.sax.SAXException;
 import org.xml.sax.ext.LexicalHandler;
 
+import javax.annotation.Nullable;
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.XMLStreamReader;
 import java.io.IOException;
@@ -987,7 +988,7 @@ public boolean contains(final Item item) {
     }
 
     @Override
-    public void destroy(final XQueryContext context, final Sequence contextSequence) {
+    public void destroy(final XQueryContext context, @Nullable final Sequence contextSequence) {
         // Nothing to do
     }
 
diff --git a/exist-core/src/main/java/org/exist/xquery/DeferredFunctionCall.java b/exist-core/src/main/java/org/exist/xquery/DeferredFunctionCall.java
@@ -35,6 +35,7 @@
 import org.exist.xquery.value.SequenceIterator;
 import org.exist.xquery.value.Type;
 
+import javax.annotation.Nullable;
 import java.util.Iterator;
 
 public abstract class DeferredFunctionCall implements Sequence {
@@ -309,7 +310,7 @@ public boolean isCacheable() {
     }
 
     @Override
-    public void destroy(XQueryContext context, Sequence contextSequence) {
+    public void destroy(final XQueryContext context, @Nullable final Sequence contextSequence) {
         // nothing to do
     }
 }
diff --git a/exist-core/src/main/java/org/exist/xquery/ModuleContext.java b/exist-core/src/main/java/org/exist/xquery/ModuleContext.java
@@ -311,7 +311,7 @@ public void popLocalVariables(final LocalVariable var) {
     }
 
     @Override
-    public void popLocalVariables(final LocalVariable var, final Sequence resultSequence) {
+    public void popLocalVariables(final LocalVariable var, @Nullable final Sequence resultSequence) {
         parentContext.popLocalVariables(var, resultSequence);
     }
 
diff --git a/exist-core/src/main/java/org/exist/xquery/VariableImpl.java b/exist-core/src/main/java/org/exist/xquery/VariableImpl.java
@@ -30,6 +30,8 @@
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
 
+import javax.annotation.Nullable;
+
 /**
  * An XQuery/XPath variable, consisting of a QName and a value.
  * 
@@ -164,9 +166,10 @@ public void setIsInitialized(boolean initialized) {
         this.initialized = initialized;
     }
 
-    public void destroy(XQueryContext context, Sequence contextSequence) {
-        if (value != null)
-            {value.destroy(context, contextSequence);}
+    public void destroy(final XQueryContext context, @Nullable final Sequence contextSequence) {
+        if (value != null) {
+			value.destroy(context, contextSequence);
+		}
     }
 
     @Override
diff --git a/exist-core/src/main/java/org/exist/xquery/XQueryContext.java b/exist-core/src/main/java/org/exist/xquery/XQueryContext.java
@@ -2354,7 +2354,7 @@ public void popLocalVariables(@Nullable final LocalVariable var) {
      * @param var       only clear variables after this variable, or null
      * @param resultSeq the result sequence
      */
-    public void popLocalVariables(@Nullable final LocalVariable var, final Sequence resultSeq) {
+    public void popLocalVariables(@Nullable final LocalVariable var, @Nullable final Sequence resultSeq) {
         if (var != null) {
             // clear all variables registered after var. they should be out of scope.
             LocalVariable outOfScope = var.after;
diff --git a/exist-core/src/main/java/org/exist/xquery/functions/fn/FnModule.java b/exist-core/src/main/java/org/exist/xquery/functions/fn/FnModule.java
@@ -52,6 +52,8 @@ public class FnModule extends AbstractInternalModule {
         new FunctionDef(FunCeiling.signature, FunCeiling.class),
         new FunctionDef(FunCodepointEqual.signature, FunCodepointEqual.class),
         new FunctionDef(FunCodepointsToString.signature, FunCodepointsToString.class),
+        new FunctionDef(FunCollationKey.FS_COLLATION_KEY_SIGNATURES[0], FunCollationKey.class),
+        new FunctionDef(FunCollationKey.FS_COLLATION_KEY_SIGNATURES[1], FunCollationKey.class),
         new FunctionDef(FunCompare.signatures[0], FunCompare.class),
         new FunctionDef(FunCompare.signatures[1], FunCompare.class),
         new FunctionDef(FunConcat.signature, FunConcat.class),
diff --git a/exist-core/src/main/java/org/exist/xquery/functions/fn/FunCollationKey.java b/exist-core/src/main/java/org/exist/xquery/functions/fn/FunCollationKey.java
@@ -0,0 +1,80 @@
+/*
+ * eXist-db Open Source Native XML Database
+ * Copyright (C) 2001 The eXist-db Authors
+ *
+ * info@exist-db.org
+ * http://www.exist-db.org
+ *
+ * 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; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * 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
+ */
+
+package org.exist.xquery.functions.fn;
+
+import org.apache.commons.codec.binary.Base64;
+import org.exist.util.Collations;
+import org.exist.xquery.*;
+import org.exist.xquery.value.*;
+
+import com.ibm.icu.text.Collator;
+
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+
+import static org.exist.xquery.FunctionDSL.*;
+import static org.exist.xquery.functions.fn.FnModule.functionSignatures;
+
+public class FunCollationKey extends BasicFunction {
+
+    private static final String FN_NAME = "collation-key";
+    private static final String FN_DESCRIPTION =
+            "Given a $value-string value and a $collation-string " +
+                    "collation, generates an internal value called a collation key, with the " +
+                    "property that the matching and ordering of collation " +
+                    "keys reflects the matching and ordering of strings " +
+                    "under the specified collation.";
+    private static final FunctionReturnSequenceType FN_RETURN = returnsOpt(Type.BASE64_BINARY, "the collation key");
+    private static final FunctionParameterSequenceType PARAM_VALUE_STRING = param("value-string", Type.STRING, "The value string");
+    private static final FunctionParameterSequenceType PARAM_COLLATION_STRING = param("collation-string", Type.STRING, "The collation string");
+    public static final FunctionSignature[] FS_COLLATION_KEY_SIGNATURES = functionSignatures(
+            FN_NAME,
+            FN_DESCRIPTION,
+            FN_RETURN,
+            arities(
+                    arity(PARAM_VALUE_STRING),
+                    arity(PARAM_VALUE_STRING, PARAM_COLLATION_STRING)
+            )
+        );
+
+    public FunCollationKey(final XQueryContext context, final FunctionSignature signature) {
+        super(context, signature);
+    }
+
+    public Sequence eval(final Sequence[] args, final Sequence contextSequence) throws XPathException {
+        final String source = (args.length >= 1) ? args[0].itemAt(0).toString() : "";
+        final Collator collator = (args.length >= 2) ? Collations.getCollationFromURI(args[1].itemAt(0).toString()) : null;
+        final Sequence sequence;
+        try (BinaryValueFromBinaryString binaryValue = new BinaryValueFromBinaryString(
+                new Base64BinaryValueType(),
+                Base64.encodeBase64String(
+                        (collator == null) ?
+                                source.getBytes(StandardCharsets.UTF_8) :
+                                new String(collator.getCollationKey(source).toByteArray()).getBytes(StandardCharsets.UTF_8)))) {
+            sequence = binaryValue.convertTo(new Base64BinaryValueType());
+        } catch (IOException e) {
+            return null;
+        }
+        return sequence;
+    }
+}
diff --git a/exist-core/src/main/java/org/exist/xquery/value/AbstractSequence.java b/exist-core/src/main/java/org/exist/xquery/value/AbstractSequence.java
@@ -32,6 +32,7 @@
 import org.exist.xquery.XPathException;
 import org.exist.xquery.XQueryContext;
 
+import javax.annotation.Nullable;
 import java.lang.reflect.Array;
 import java.util.ArrayList;
 import java.util.Iterator;
@@ -287,7 +288,7 @@ public boolean hasChanged(final int previousState) {
     }
 
     @Override
-    public void destroy(final XQueryContext context, final Sequence contextSequence) {
+    public void destroy(final XQueryContext context, @Nullable final Sequence contextSequence) {
         // do nothing by default
     }
 }
diff --git a/exist-core/src/main/java/org/exist/xquery/value/ArrayListValueSequence.java b/exist-core/src/main/java/org/exist/xquery/value/ArrayListValueSequence.java
@@ -255,7 +255,7 @@ public boolean contains(final Item item) {
     }
 
     @Override
-    public void destroy(final XQueryContext context, final Sequence contextSequence) {
+    public void destroy(final XQueryContext context, @Nullable final Sequence contextSequence) {
         for (final Item value : values) {
             value.destroy(context, contextSequence);
         }
diff --git a/exist-core/src/main/java/org/exist/xquery/value/AtomicValue.java b/exist-core/src/main/java/org/exist/xquery/value/AtomicValue.java
@@ -42,6 +42,7 @@
 import org.xml.sax.ContentHandler;
 import org.xml.sax.SAXException;
 
+import javax.annotation.Nullable;
 import java.util.Iterator;
 import java.util.Properties;
 
@@ -362,7 +363,7 @@ public boolean contains(final Item item) {
     }
 
     @Override
-    public void destroy(final XQueryContext context, final Sequence contextSequence) {
+    public void destroy(final XQueryContext context, @Nullable final Sequence contextSequence) {
         // nothing to be done by default
     }
 
diff --git a/exist-core/src/main/java/org/exist/xquery/value/BinaryValue.java b/exist-core/src/main/java/org/exist/xquery/value/BinaryValue.java
@@ -109,10 +109,13 @@ private int compareTo(BinaryValue otherValue) {
             return -1;
         } else if (otherIs == null) {
             return 1;
+        } else if (is == otherIs) {
+            return 0;
         } else {
-            int read = -1;
-            int otherRead = -1;
-            while (true) {
+            int read;
+            int otherRead;
+            do {
+
                 try {
                     read = is.read();
                 } catch (final IOException ioe) {
@@ -125,8 +128,12 @@ private int compareTo(BinaryValue otherValue) {
                     return 1;
                 }
 
-                return read - otherRead;
-            }
+                final int readComparison = Integer.compare(read, otherRead);
+                if (readComparison != 0) {
+                    return readComparison;
+                }
+            } while (read != -1 && otherRead != -1);
+            return 0;
         }
     }
 
@@ -276,4 +283,33 @@ public void streamTo(OutputStream os) throws IOException {
      * Increments the number of shared references to this binary value.
      */
     public abstract void incrementSharedReferences();
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        BinaryValue that = (BinaryValue) o;
+        return compareTo(that) == 0;
+    }
+
+    @Override
+    public int hashCode() {
+        final InputStream is = getInputStream();
+        int hash = 7;
+
+        if (is != null) {
+            int read;
+            do {
+                try {
+                    read = is.read();
+                    if (read != -1) {
+                        hash = 31 * hash + read;
+                    }
+                } catch (final IOException ioe) {
+                    read = -1;
+                }
+            } while (read != -1);
+        }
+        return hash;
+    }
 }
diff --git a/exist-core/src/main/java/org/exist/xquery/value/BinaryValueFromFile.java b/exist-core/src/main/java/org/exist/xquery/value/BinaryValueFromFile.java
@@ -26,6 +26,7 @@
 import org.exist.xquery.XPathException;
 import org.exist.xquery.XQueryContext;
 
+import javax.annotation.Nullable;
 import java.io.InputStream;
 import java.io.IOException;
 import java.io.OutputStream;
@@ -144,9 +145,9 @@ public Object toJavaObject() throws XPathException {
     }
 
     @Override
-    public void destroy(final XQueryContext context, final Sequence contextSequence) {
+    public void destroy(final XQueryContext context, @Nullable final Sequence contextSequence) {
         // do not close if this object is part of the contextSequence
-        if (contextSequence == this || contextSequence.containsReference(this)) {
+        if (contextSequence != null && (contextSequence == this || contextSequence.containsReference(this))) {
             return;
         }
         try {
diff --git a/exist-core/src/main/java/org/exist/xquery/value/BinaryValueFromInputStream.java b/exist-core/src/main/java/org/exist/xquery/value/BinaryValueFromInputStream.java
@@ -29,6 +29,7 @@
 import org.exist.xquery.XPathException;
 import org.exist.xquery.XQueryContext;
 
+import javax.annotation.Nullable;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
@@ -119,9 +120,9 @@ public void close() throws IOException {
     }
 
     @Override
-    public void destroy(XQueryContext context, final Sequence contextSequence) {
+    public void destroy(final XQueryContext context, @Nullable final Sequence contextSequence) {
         // do not close if this object is part of the contextSequence
-        if (contextSequence == this || contextSequence.containsReference(this)) {
+        if (contextSequence != null && (contextSequence == this || contextSequence.containsReference(this))) {
             return;
         }
         LOG.debug("Closing input stream");
diff --git a/exist-core/src/main/java/org/exist/xquery/value/Item.java b/exist-core/src/main/java/org/exist/xquery/value/Item.java
@@ -30,6 +30,7 @@
 import org.xml.sax.ContentHandler;
 import org.xml.sax.SAXException;
 
+import javax.annotation.Nullable;
 import java.util.Properties;
 
 /**
@@ -70,7 +71,7 @@ public interface Item {
      * @param context current context
      * @param contextSequence the sequence to clean up
      */
-    void destroy(XQueryContext context, Sequence contextSequence);
+    void destroy(XQueryContext context, @Nullable Sequence contextSequence);
 
     /**
      * Convert this item into an atomic value, whose type corresponds to
diff --git a/exist-core/src/main/java/org/exist/xquery/value/Sequence.java b/exist-core/src/main/java/org/exist/xquery/value/Sequence.java
@@ -356,7 +356,7 @@ default int getItemCount() {
      * @param context the XQuery context
      * @param contextSequence the context sequence
      */
-    void destroy(XQueryContext context, Sequence contextSequence);
+    void destroy(final XQueryContext context, @Nullable final Sequence contextSequence);
 
     static Sequence of(@Nullable final XmldbURI... uris) throws XPathException {
         if (uris == null || uris.length == 0 || (uris.length == 1 && uris[0] == null)) {
diff --git a/exist-core/src/main/java/org/exist/xquery/value/SubSequence.java b/exist-core/src/main/java/org/exist/xquery/value/SubSequence.java
@@ -472,7 +472,7 @@ public boolean contains(final Item item) {
     }
 
     @Override
-    public void destroy(final XQueryContext context, final Sequence contextSequence) {
+    public void destroy(final XQueryContext context, @Nullable final Sequence contextSequence) {
         sequence.destroy(context, contextSequence);
     }
 
diff --git a/exist-core/src/main/java/org/exist/xquery/value/ValueSequence.java b/exist-core/src/main/java/org/exist/xquery/value/ValueSequence.java
@@ -35,6 +35,7 @@
 import org.w3c.dom.Document;
 import org.w3c.dom.Node;
 
+import javax.annotation.Nullable;
 import java.util.*;
 
 /**
@@ -385,7 +386,7 @@ private void expand() {
     }
 
     @Override
-    public void destroy(final XQueryContext context, final Sequence contextSequence) {
+    public void destroy(final XQueryContext context, @Nullable final Sequence contextSequence) {
         holderVar = null;
         for (int i = 0; i <= size; i++) {
             values[i].destroy(context, contextSequence);
diff --git a/exist-core/src/test/xquery/xquery3/fnCodepointEqual.xqm b/exist-core/src/test/xquery/xquery3/fnCodepointEqual.xqm
diff --git a/exist-core/src/test/xquery/xquery3/fnCollationKey.xqm b/exist-core/src/test/xquery/xquery3/fnCollationKey.xqm
diff --git a/exist-parent/pom.xml b/exist-parent/pom.xml
diff --git a/extensions/modules/compression/src/test/xquery/modules/compression/zip-tests.xql b/extensions/modules/compression/src/test/xquery/modules/compression/zip-tests.xql

Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,7 @@`
`42`	`42`	`import org.xml.sax.SAXException;`
`43`	`43`	`import org.xml.sax.ext.LexicalHandler;`
`44`	`44`
	`45`	`+import javax.annotation.Nullable;`
`45`	`46`	`import javax.xml.XMLConstants;`
`46`	`47`	`import java.util.Iterator;`
`47`	`48`	`import java.util.Properties;`
`@@ -762,7 +763,7 @@ public boolean contains(final Item item) {`
`762`	`763`	`}`
`763`	`764`
`764`	`765`	`@Override`
`765`		`- public void destroy(final XQueryContext context, final Sequence contextSequence) {`
	`766`	`+ public void destroy(final XQueryContext context, @Nullable final Sequence contextSequence) {`
`766`	`767`	`}`
`767`	`768`
`768`	`769`
Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,7 @@`
`45`	`45`	`import org.xml.sax.SAXException;`
`46`	`46`	`import org.xml.sax.ext.LexicalHandler;`
`47`	`47`
	`48`	`+import javax.annotation.Nullable;`
`48`	`49`	`import javax.xml.stream.XMLStreamException;`
`49`	`50`	`import javax.xml.stream.XMLStreamReader;`
`50`	`51`	`import java.io.IOException;`
`@@ -987,7 +988,7 @@ public boolean contains(final Item item) {`
`987`	`988`	`}`
`988`	`989`
`989`	`990`	`@Override`
`990`		`- public void destroy(final XQueryContext context, final Sequence contextSequence) {`
	`991`	`+ public void destroy(final XQueryContext context, @Nullable final Sequence contextSequence) {`
`991`	`992`	`// Nothing to do`
`992`	`993`	`}`
`993`	`994`
Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,7 @@`
`35`	`35`	`import org.exist.xquery.value.SequenceIterator;`
`36`	`36`	`import org.exist.xquery.value.Type;`
`37`	`37`
	`38`	`+import javax.annotation.Nullable;`
`38`	`39`	`import java.util.Iterator;`
`39`	`40`
`40`	`41`	`public abstract class DeferredFunctionCall implements Sequence {`
`@@ -309,7 +310,7 @@ public boolean isCacheable() {`
`309`	`310`	`}`
`310`	`311`
`311`	`312`	`@Override`
`312`		`- public void destroy(XQueryContext context, Sequence contextSequence) {`
	`313`	`+ public void destroy(final XQueryContext context, @Nullable final Sequence contextSequence) {`
`313`	`314`	`// nothing to do`
`314`	`315`	`}`
`315`	`316`	`}`
Original file line number	Diff line number	Diff line change
`@@ -311,7 +311,7 @@ public void popLocalVariables(final LocalVariable var) {`
`311`	`311`	`}`
`312`	`312`
`313`	`313`	`@Override`
`314`		`- public void popLocalVariables(final LocalVariable var, final Sequence resultSequence) {`
	`314`	`+ public void popLocalVariables(final LocalVariable var, @Nullable final Sequence resultSequence) {`
`315`	`315`	`parentContext.popLocalVariables(var, resultSequence);`
`316`	`316`	`}`
`317`	`317`
Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,8 @@`
`30`	`30`	`import org.w3c.dom.Document;`
`31`	`31`	`import org.w3c.dom.Element;`
`32`	`32`
	`33`	`+import javax.annotation.Nullable;`
	`34`	`+`
`33`	`35`	`/**`
`34`	`36`	`* An XQuery/XPath variable, consisting of a QName and a value.`
`35`	`37`	`*`
`@@ -164,9 +166,10 @@ public void setIsInitialized(boolean initialized) {`
`164`	`166`	`this.initialized = initialized;`
`165`	`167`	`}`
`166`	`168`
`167`		`- public void destroy(XQueryContext context, Sequence contextSequence) {`
`168`		`- if (value != null)`
`169`		`- {value.destroy(context, contextSequence);}`
	`169`	`+ public void destroy(final XQueryContext context, @Nullable final Sequence contextSequence) {`
	`170`	`+ if (value != null) {`
	`171`	`+ value.destroy(context, contextSequence);`
	`172`	`+ }`
`170`	`173`	`}`
`171`	`174`
`172`	`175`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@`
`32`	`32`	`import org.exist.xquery.XPathException;`
`33`	`33`	`import org.exist.xquery.XQueryContext;`
`34`	`34`
	`35`	`+import javax.annotation.Nullable;`
`35`	`36`	`import java.lang.reflect.Array;`
`36`	`37`	`import java.util.ArrayList;`
`37`	`38`	`import java.util.Iterator;`
`@@ -287,7 +288,7 @@ public boolean hasChanged(final int previousState) {`
`287`	`288`	`}`
`288`	`289`
`289`	`290`	`@Override`
`290`		`- public void destroy(final XQueryContext context, final Sequence contextSequence) {`
	`291`	`+ public void destroy(final XQueryContext context, @Nullable final Sequence contextSequence) {`
`291`	`292`	`// do nothing by default`
`292`	`293`	`}`
`293`	`294`	`}`
Original file line number	Diff line number	Diff line change
`@@ -255,7 +255,7 @@ public boolean contains(final Item item) {`
`255`	`255`	`}`
`256`	`256`
`257`	`257`	`@Override`
`258`		`- public void destroy(final XQueryContext context, final Sequence contextSequence) {`
	`258`	`+ public void destroy(final XQueryContext context, @Nullable final Sequence contextSequence) {`
`259`	`259`	`for (final Item value : values) {`
`260`	`260`	`value.destroy(context, contextSequence);`
`261`	`261`	`}`