Merge pull request #4473 from evolvedbinary/hotfix/local-name

Corrects issues with fn:local-name and unnecessary evaluation of path steps on empty sequences

Author: dizzzz

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

@@ -187,4 +187,9 @@ public Expression simplify() {
     public Expression getParent() {
         return null;
     }
+
+    @Override
+    public boolean evalNextExpressionOnEmptyContextSequence() {
+        return false;
+    }
 }

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

@@ -194,4 +194,9 @@ public Expression simplify() {
     public Expression getParent() {
         return null;
     }
+
+    @Override
+    public boolean evalNextExpressionOnEmptyContextSequence() {
+        return false;
+    }
 }

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

@@ -255,4 +255,13 @@ public interface Expression {
     public boolean allowMixedNodesInReturn();
 
     public Expression getParent();
+
+    /**
+     * Return true only if the next expression within a path expression
+     * should be evaluated even when this expression returns an
+     * empty sequence.
+     *
+     * @return true if the next expression should be evaluated, false otherwise.
+     */
+    boolean evalNextExpressionOnEmptyContextSequence();
 }

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

@@ -229,7 +229,7 @@ public Sequence eval(Sequence contextSequence, final Item contextItem) throws XP
             //TODO : let the parser do it ? -pb
             boolean gotAtomicResult = false;
             Expression prev = null;
-            for (Expression step : steps) {
+            for (final Expression step : steps) {
                 prev = expr;
                 expr = step;
                 context.getWatchDog().proceed(expr);
@@ -302,7 +302,22 @@ public Sequence eval(Sequence contextSequence, final Item contextItem) throws XP
                         // expression with more than one step
                         result.removeDuplicates();
                     }
+
+                    /**
+                     * If the result is an Empty Sequence, we don't need to process
+                     * any more steps as there is no Context Sequence for the next step!
+                     *
+                     * There is one exception to this rule, which is a TextConstructor
+                     * expression that only contains whitespace but has been configured
+                     * to strip-whitespace. In this instance the TextConstructor will
+                     * return true when {@link Expression#evalNextExpressionOnEmptyContextSequence()}
+                     * is called to indicate that.
+                     */
+                    if (result.isEmpty() && !step.evalNextExpressionOnEmptyContextSequence()) {
+                        break;
+                    }
                 }
+
                 if (!staticContext) {
                     currentContext = result;
                 }

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

@@ -96,4 +96,13 @@ public String getText() {
     public boolean allowMixedNodesInReturn() {
         return true;
     }
+
+    @Override
+    public boolean evalNextExpressionOnEmptyContextSequence() {
+        /*
+        When this TextConstructor only contains whitespace but has been configured
+        to strip-whitespace, return true so that the next expression is processed correctly.
+         */
+        return isWhitespaceOnly && context.stripWhitespace();
+    }
 }

exist-core/src/main/java/org/exist/xquery/functions/fn/FunLocalName.java

@@ -39,6 +39,7 @@
 import org.exist.xquery.value.StringValue;
 import org.exist.xquery.value.Type;
 import org.w3c.dom.Node;
+import org.w3c.dom.ProcessingInstruction;
 
 /**
  * Built-in function fn:local-name().
@@ -126,8 +127,14 @@ public Sequence eval(Sequence contextSequence, final Item contextItem) throws XP
             }
 
             //TODO : how to improve performance ?
+            final String localName;
             final Node n = ((NodeValue) item).getNode();
-            final String localName = n.getLocalName();
+            if (n.getNodeType() == Node.PROCESSING_INSTRUCTION_NODE) {
+                localName = ((ProcessingInstruction) n).getTarget();
+            } else {
+                localName = n.getLocalName();
+            }
+
             if (localName != null) {
                 result = new StringValue(this, localName);
             } else {

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

@@ -606,8 +606,7 @@ public void localName_contextItem_empty() throws XPathException, XMLDBException
         final ResourceSet result = existEmbeddedServer.executeQuery(
                 "let $a := <a><b/></a>" +
                         "return $a/b/c/fn:local-name()");
-        final String r = (String) result.getResource(0).getContent();
-        assertEquals("", r);
+        assertEquals(0, result.getSize());
     }
 
     @Test
@@ -657,8 +656,7 @@ public void name_contextItem_empty() throws XPathException, XMLDBException {
         final ResourceSet result = existEmbeddedServer.executeQuery(
                 "let $a := <a><b/></a>" +
                         "return $a/b/c/fn:name()");
-        final String r = (String) result.getResource(0).getContent();
-        assertEquals("", r);
+        assertEquals(0, result.getSize());
     }
 
     @Test
@@ -762,12 +760,11 @@ public void namespaceURI_contextItem() throws XPathException, XMLDBException {
     }
 
     @Test
-    public void namespaceURI_contextItem_empty() throws XPathException, XMLDBException {
+    public void namespaceURI_contextItem_empty() throws XMLDBException {
         final ResourceSet result = existEmbeddedServer.executeQuery(
                 "let $a := <a><b/></a>" +
                         "return $a/exist:b/c/fn:namespace-uri()");
-        final String r = (String) result.getResource(0).getContent();
-        assertEquals("", r);
+        assertEquals(0, result.getSize());
     }
 
     @Test

exist-core/src/test/xquery/fn.xql

@@ -145,7 +145,7 @@ function fnt:document-uri0_context() {
 };
 
 declare
-    %test:assertError("err:XPDY0002")
+    %test:assertEmpty
 function fnt:document-uri0_context_empty() {
      root(collection('/db/fn-test')//bookies)/document-uri()
 };