Bug 319374, XPath should ignore changes to anonymous content, r+sr=sicking, a=1.9+

content/xslt/Makefile.in

@@ -48,4 +48,8 @@ ifdef ENABLE_TESTS
 DIRS += tests/buster
 endif
 
+ifdef MOZ_MOCHITEST
+DIRS += tests/mochitest
+endif
+
 include $(topsrcdir)/config/rules.mk

content/xslt/src/xpath/nsXPathExpression.cpp

@@ -88,7 +88,8 @@ nsXPathExpression::EvaluateWithContext(nsIDOMNode *aContextNode,
                                        nsISupports *aInResult,
                                        nsISupports **aResult)
 {
-    NS_ENSURE_ARG(aContextNode);
+    nsCOMPtr<nsINode> context = do_QueryInterface(aContextNode);
+    NS_ENSURE_ARG(context);
 
     if (aContextPosition > aContextSize)
         return NS_ERROR_FAILURE;
@@ -177,7 +178,7 @@ nsXPathExpression::EvaluateWithContext(nsIDOMNode *aContextNode,
         xpathResult = new nsXPathResult();
         NS_ENSURE_TRUE(xpathResult, NS_ERROR_OUT_OF_MEMORY);
     }
-    rv = xpathResult->SetExprResult(exprResult, resultType);
+    rv = xpathResult->SetExprResult(exprResult, resultType, context);
     NS_ENSURE_SUCCESS(rv, rv);
 
     return CallQueryInterface(xpathResult, aResult);

content/xslt/src/xpath/nsXPathResult.cpp

@@ -41,6 +41,7 @@
 #include "txNodeSet.h"
 #include "nsDOMError.h"
 #include "nsIContent.h"
+#include "nsIAttribute.h"
 #include "nsIDOMClassInfo.h"
 #include "nsIDOMNode.h"
 #include "nsIDOMDocument.h"
@@ -204,7 +205,8 @@ nsXPathResult::NodeWillBeDestroyed(const nsINode* aNode)
 {
     // Set to null to avoid unregistring unnecessarily
     mDocument = nsnull;
-    Invalidate();
+    Invalidate(aNode->IsNodeOfType(nsINode::eCONTENT) ?
+               static_cast<const nsIContent*>(aNode) : nsnull);
 }
 
 void
@@ -212,7 +214,7 @@ nsXPathResult::CharacterDataChanged(nsIDocument* aDocument,
                                     nsIContent *aContent,
                                     CharacterDataChangeInfo* aInfo)
 {
-    Invalidate();
+    Invalidate(aContent);
 }
 
 void
@@ -223,7 +225,7 @@ nsXPathResult::AttributeChanged(nsIDocument* aDocument,
                                 PRInt32 aModType,
                                 PRUint32 aStateMask)
 {
-    Invalidate();
+    Invalidate(aContent);
 }
 
 void
@@ -231,7 +233,7 @@ nsXPathResult::ContentAppended(nsIDocument* aDocument,
                                nsIContent* aContainer,
                                PRInt32 aNewIndexInContainer)
 {
-    Invalidate();
+    Invalidate(aContainer);
 }
 
 void
@@ -240,7 +242,7 @@ nsXPathResult::ContentInserted(nsIDocument* aDocument,
                                nsIContent* aChild,
                                PRInt32 aIndexInContainer)
 {
-    Invalidate();
+    Invalidate(aContainer);
 }
 
 void
@@ -249,13 +251,15 @@ nsXPathResult::ContentRemoved(nsIDocument* aDocument,
                               nsIContent* aChild,
                               PRInt32 aIndexInContainer)
 {
-    Invalidate();
+    Invalidate(aContainer);
 }
 
 nsresult
-nsXPathResult::SetExprResult(txAExprResult* aExprResult, PRUint16 aResultType)
+nsXPathResult::SetExprResult(txAExprResult* aExprResult, PRUint16 aResultType,
+                             nsINode* aContextNode)
 {
     mResultType = aResultType;
+    mContextNode = do_GetWeakReference(aContextNode);
 
     if ((isSnapshot() || isIterator() || isNode()) &&
         aExprResult->getResultType() != txAExprResult::NODESET) {
@@ -303,8 +307,31 @@ nsXPathResult::SetExprResult(txAExprResult* aExprResult, PRUint16 aResultType)
 }
 
 void
-nsXPathResult::Invalidate()
+nsXPathResult::Invalidate(const nsIContent* aChangeRoot)
 {
+    nsCOMPtr<nsINode> contextNode = do_QueryReferent(mContextNode);
+    if (contextNode && aChangeRoot && aChangeRoot->GetBindingParent()) {
+        // If context node is in anonymous content, changes to
+        // non-anonymous content need to invalidate the XPathResult. If
+        // the changes are happening in a different anonymous trees, no
+        // invalidation should happen.
+        nsIContent* ctxBindingParent = nsnull;
+        if (contextNode->IsNodeOfType(nsINode::eCONTENT)) {
+            ctxBindingParent =
+                static_cast<nsIContent*>(contextNode.get())
+                    ->GetBindingParent();
+        } else if (contextNode->IsNodeOfType(nsINode::eATTRIBUTE)) {
+            nsIContent* parent =
+              static_cast<nsIAttribute*>(contextNode.get())->GetContent();
+            if (parent) {
+                ctxBindingParent = parent->GetBindingParent();
+            }
+        }
+        if (ctxBindingParent != aChangeRoot->GetBindingParent()) {
+          return;
+        }
+    }
+
     if (mDocument) {
         mDocument->RemoveMutationObserver(this);
         mDocument = nsnull;
@@ -343,7 +370,9 @@ nsXPathResult::Clone(nsIXPathResult **aResult)
         return NS_ERROR_OUT_OF_MEMORY;
     }
 
-    nsresult rv = result->SetExprResult(mResult.get(), mResultType);
+    nsCOMPtr<nsINode> contextNode = do_QueryReferent(mContextNode);
+    nsresult rv = result->SetExprResult(mResult.get(), mResultType,
+                                        contextNode);
     NS_ENSURE_SUCCESS(rv, rv);
 
     result.swap(*aResult);

content/xslt/src/xpath/nsXPathResult.h

@@ -45,17 +45,19 @@
 #include "nsStubMutationObserver.h"
 #include "nsCOMPtr.h"
 #include "nsCOMArray.h"
+#include "nsWeakPtr.h"
 
-// {15b9b301-2012-11d6-a7f2-e6d0a678995c}
+// {662f2c9a-c7cd-4cab-9349-e733df5a838c}
 #define NS_IXPATHRESULT_IID \
-{ 0x15b9b301, 0x2012, 0x11d6, {0xa7, 0xf2, 0xe6, 0xd0, 0xa6, 0x78, 0x99, 0x5c }}
+{ 0x662f2c9a, 0xc7cd, 0x4cab, {0x93, 0x49, 0xe7, 0x33, 0xdf, 0x5a, 0x83, 0x8c }}
 
 class nsIXPathResult : public nsISupports
 {
 public:
     NS_DECLARE_STATIC_IID_ACCESSOR(NS_IXPATHRESULT_IID)
     virtual nsresult SetExprResult(txAExprResult *aExprResult,
-                                   PRUint16 aResultType) = 0;
+                                   PRUint16 aResultType,
+                                   nsINode* aContextNode) = 0;
     virtual nsresult GetExprResult(txAExprResult **aExprResult) = 0;
     virtual nsresult Clone(nsIXPathResult **aResult) = 0;
 };
@@ -112,7 +114,8 @@ public:
     NS_DECL_NSIMUTATIONOBSERVER_NODEWILLBEDESTROYED
 
     // nsIXPathResult interface
-    nsresult SetExprResult(txAExprResult *aExprResult, PRUint16 aResultType);
+    nsresult SetExprResult(txAExprResult *aExprResult, PRUint16 aResultType,
+                           nsINode* aContextNode);
     nsresult GetExprResult(txAExprResult **aExprResult);
     nsresult Clone(nsIXPathResult **aResult);
 
@@ -133,12 +136,13 @@ private:
                mResultType == ANY_UNORDERED_NODE_TYPE;
     }
 
-    void Invalidate();
+    void Invalidate(const nsIContent* aChangeRoot);
 
     txResultHolder mResult;
     nsCOMPtr<nsIDocument> mDocument;
     PRUint32 mCurrentPos;
     PRUint16 mResultType;
+    nsWeakPtr mContextNode;
     PRPackedBool mInvalidIteratorState;
 };
 

content/xslt/tests/mochitest/Makefile.in

@@ -0,0 +1,51 @@
+#
+# ***** BEGIN LICENSE BLOCK *****
+# Version: MPL 1.1/GPL 2.0/LGPL 2.1
+#
+# The contents of this file are subject to the Mozilla Public License Version
+# 1.1 (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+# http://www.mozilla.org/MPL/
+#
+# Software distributed under the License is distributed on an "AS IS" basis,
+# WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+# for the specific language governing rights and limitations under the
+# License.
+#
+# The Original Code is mozilla.org code.
+#
+# The Initial Developer of the Original Code is
+# Mozilla Foundation.
+# Portions created by the Initial Developer are Copyright (C) 2007
+# the Initial Developer. All Rights Reserved.
+#
+# Contributor(s):
+#
+# Alternatively, the contents of this file may be used under the terms of
+# either of the GNU General Public License Version 2 or later (the "GPL"),
+# or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
+# in which case the provisions of the GPL or the LGPL are applicable instead
+# of those above. If you wish to allow use of your version of this file only
+# under the terms of either the GPL or the LGPL, and not to allow others to
+# use your version of this file under the terms of the MPL, indicate your
+# decision by deleting the provisions above and replace them with the notice
+# and other provisions required by the GPL or the LGPL. If you do not delete
+# the provisions above, a recipient may use your version of this file under
+# the terms of any one of the MPL, the GPL or the LGPL.
+#
+# ***** END LICENSE BLOCK *****
+
+DEPTH		= ../../../..
+topsrcdir	= @top_srcdir@
+srcdir		= @srcdir@
+VPATH		= @srcdir@
+relativesrcdir  = content/xslt/tests/mochitest
+
+include $(DEPTH)/config/autoconf.mk
+include $(topsrcdir)/config/rules.mk
+
+_TEST_FILES = 	test_bug319374.xhtml \
+		$(NULL)
+
+libs:: $(_TEST_FILES)
+	$(INSTALL) $(foreach f,$^,"$f") $(DEPTH)/_tests/testing/mochitest/tests/$(relativesrcdir)

content/xslt/tests/mochitest/test_bug319374.xhtml

@@ -0,0 +1,110 @@
+<?xml version="1.0"?>
+<html xmlns="http://www.w3.org/1999/xhtml"
+      xmlns:xbl="http://www.mozilla.org/xbl">
+<!--
+https://bugzilla.mozilla.org/show_bug.cgi?id=319374
+-->
+<head>
+  <title>Test for Bug 319374</title>
+  <script type="text/javascript" src="/MochiKit/packed.js"></script>
+  <script type="text/javascript" src="/tests/SimpleTest/SimpleTest.js"></script>
+  <link rel="stylesheet" type="text/css" href="/tests/SimpleTest/test.css" />
+  <xbl:bindings>                                  
+    <xbl:binding id="test">
+      <xbl:content>
+        <span attr="attribute"><span></span></span><span> anon text </span><br/>
+      </xbl:content>
+    </xbl:binding>
+  </xbl:bindings>
+</head>
+<body>
+<a target="_blank" href="https://bugzilla.mozilla.org/show_bug.cgi?id=319374">Mozilla Bug 319374</a>
+<p id="display"></p>
+<div id="content"><span style="-moz-binding: url(#test)"/><span style="-moz-binding: url(#test)"/><span style="-moz-binding: url(#test)"/></div>
+<pre id="test">
+<script class="testbody" type="text/javascript">
+<![CDATA[
+
+/** Test for Bug 319374 **/
+
+  function testChangesInAnonymousTree() {
+    // Test 1: Make sure that modifying anonymous content doesn't 
+    //         cause non-anonymous XPath result to throw exceptions..
+    var counter = 0;
+    var error = null;
+    try {
+      var xp = new XPathEvaluator();
+      var result = xp.evaluate("*",
+                               document.getElementById('content'),
+                               null,
+                               Components.interfaces.nsIDOMXPathResult.
+                                 UNORDERED_NODE_ITERATOR_TYPE,
+                               null);
+      var res = null;
+      while (res = result.iterateNext()) {
+        ++counter; 
+        var anon = document.getAnonymousNodes(res);
+        anon[0].removeChild(anon[0].firstChild); // Removing a child node
+        anon[0].removeAttribute("attr1"); // Removing an attribute
+        anon[1].firstChild.data = "anon text changed" // Modifying text data
+      }
+    } catch (e) {
+      error = e;
+    }
+    ok(!error, error);
+    ok(counter == 3, "XPathEvaluator should have found 3 elements.")
+
+    // Test 2: If the context node is in anonymous content, changing some
+    //         other anonymous tree shouldn't cause XPath result to throw.
+    var anonAttr1 =
+      document.getAnonymousNodes(document.getElementById('content').
+        firstChild)[0].getAttributeNode('attr');
+    var anonAttr2 =
+      document.getAnonymousNodes(document.getElementById('content').
+        lastChild)[0].getAttributeNode('attr');
+    var resultAttr = null;
+    try {
+      var xp2 = xp.evaluate(".",
+                            anonAttr1,
+                            null,
+                            Components.interfaces.nsIDOMXPathResult.
+                              UNORDERED_NODE_ITERATOR_TYPE,
+                            null);
+      // Attribute changing in a different anonymous tree.
+      anonAttr2.value = "foo";
+      resultAttr = xp2.iterateNext();
+      ok(resultAttr == anonAttr1, "XPathEvaluator returned wrong attribute!")
+    } catch (e) {
+      ok(false, e);
+    }
+
+    // Test 3: If the anonymous tree in which context node is in is modified,
+    //         XPath result should throw when iterateNext() is called.
+    resultAttr = null;
+    try {
+      var xp3 = xp.evaluate(".",
+                            anonAttr1,
+                            null,
+                            Components.interfaces.nsIDOMXPathResult.
+                              UNORDERED_NODE_ITERATOR_TYPE,
+                            null);
+      // Attribute changing in the same anonymous tree.
+      anonAttr1.ownerElement.setAttribute("foo", "bar");
+      resultAttr = xp3.iterateNext();
+      ok(resultAttr == anonAttr1,
+         "XPathEvaluator should have thrown an exception!")
+    } catch (e) {
+      ok(true, e);
+    }
+
+    SimpleTest.finish();
+  }
+
+  SimpleTest.waitForExplicitFinish();
+  addLoadEvent(testChangesInAnonymousTree);
+]]>
+</script>
+</pre>
+</body>
+</html>
+