From 4c30d59438a4b9436e0209f5acf54557ae31c712 Mon Sep 17 00:00:00 2001
From: Niels Dossche <7771979+nielsdos@users.noreply.github.com>
Date: Sun, 11 Jun 2023 23:44:58 +0200
Subject: [PATCH] Fix "invalid state error" while cloning namespace
declarations
---
ext/dom/php_dom.c | 57 +++++++++++++++++++++------
ext/dom/tests/clone_nodes.phpt | 72 ++++++++++++++++++++++++++++++++++
2 files changed, 116 insertions(+), 13 deletions(-)
create mode 100644 ext/dom/tests/clone_nodes.phpt
diff --git a/ext/dom/php_dom.c b/ext/dom/php_dom.c
index 9e0bb1f3d1d02..454dc54d8e211 100644
--- a/ext/dom/php_dom.c
+++ b/ext/dom/php_dom.c
@@ -89,6 +89,7 @@ static HashTable dom_xpath_prop_handlers;
static zend_object *dom_objects_namespace_node_new(zend_class_entry *class_type);
static void dom_object_namespace_node_free_storage(zend_object *object);
+static xmlNodePtr php_dom_create_fake_namespace_decl_node_ptr(xmlNodePtr nodep, xmlNsPtr original);
typedef int (*dom_read_t)(dom_object *obj, zval *retval);
typedef int (*dom_write_t)(dom_object *obj, zval *newval);
@@ -477,6 +478,19 @@ PHP_FUNCTION(dom_import_simplexml)
static dom_object* dom_objects_set_class(zend_class_entry *class_type);
+static void dom_update_refcount_after_clone(dom_object *original, xmlNodePtr original_node, dom_object *clone, xmlNodePtr cloned_node)
+{
+ /* If we cloned a document then we must create new doc proxy */
+ if (cloned_node->doc == original_node->doc) {
+ clone->document = original->document;
+ }
+ php_libxml_increment_doc_ref((php_libxml_node_object *)clone, cloned_node->doc);
+ php_libxml_increment_node_ptr((php_libxml_node_object *)clone, cloned_node, (void *)clone);
+ if (original->document != clone->document) {
+ dom_copy_doc_props(original->document, clone->document);
+ }
+}
+
static zend_object *dom_objects_store_clone_obj(zend_object *zobject) /* {{{ */
{
dom_object *intern = php_dom_obj_from_obj(zobject);
@@ -489,15 +503,7 @@ static zend_object *dom_objects_store_clone_obj(zend_object *zobject) /* {{{ */
if (node != NULL) {
xmlNodePtr cloned_node = xmlDocCopyNode(node, node->doc, 1);
if (cloned_node != NULL) {
- /* If we cloned a document then we must create new doc proxy */
- if (cloned_node->doc == node->doc) {
- clone->document = intern->document;
- }
- php_libxml_increment_doc_ref((php_libxml_node_object *)clone, cloned_node->doc);
- php_libxml_increment_node_ptr((php_libxml_node_object *)clone, cloned_node, (void *)clone);
- if (intern->document != clone->document) {
- dom_copy_doc_props(intern->document, clone->document);
- }
+ dom_update_refcount_after_clone(intern, node, clone, cloned_node);
}
}
@@ -509,6 +515,26 @@ static zend_object *dom_objects_store_clone_obj(zend_object *zobject) /* {{{ */
}
/* }}} */
+static zend_object *dom_object_namespace_node_clone_obj(zend_object *zobject)
+{
+ dom_object_namespace_node *intern = php_dom_namespace_node_obj_from_obj(zobject);
+ zend_object *clone = dom_objects_namespace_node_new(intern->dom.std.ce);
+ dom_object_namespace_node *clone_intern = php_dom_namespace_node_obj_from_obj(clone);
+
+ xmlNodePtr original_node = dom_object_get_node(&intern->dom);
+ ZEND_ASSERT(original_node->type == XML_NAMESPACE_DECL);
+ xmlNodePtr cloned_node = php_dom_create_fake_namespace_decl_node_ptr(original_node->parent, original_node->ns);
+
+ if (intern->parent_intern) {
+ clone_intern->parent_intern = intern->parent_intern;
+ GC_ADDREF(&clone_intern->parent_intern->std);
+ }
+ dom_update_refcount_after_clone(&intern->dom, original_node, &clone_intern->dom, cloned_node);
+
+ zend_objects_clone_members(clone, &intern->dom.std);
+ return clone;
+}
+
static void dom_copy_prop_handler(zval *zv) /* {{{ */
{
dom_prop_handler *hnd = Z_PTR_P(zv);
@@ -577,6 +603,7 @@ PHP_MINIT_FUNCTION(dom)
memcpy(&dom_object_namespace_node_handlers, &dom_object_handlers, sizeof(zend_object_handlers));
dom_object_namespace_node_handlers.offset = XtOffsetOf(dom_object_namespace_node, dom.std);
dom_object_namespace_node_handlers.free_obj = dom_object_namespace_node_free_storage;
+ dom_object_namespace_node_handlers.clone_obj = dom_object_namespace_node_clone_obj;
zend_hash_init(&classes, 0, NULL, NULL, 1);
@@ -1579,8 +1606,7 @@ xmlNsPtr dom_get_nsdecl(xmlNode *node, xmlChar *localName) {
}
/* }}} end dom_get_nsdecl */
-/* Note: Assumes the additional lifetime was already added in the caller. */
-xmlNodePtr php_dom_create_fake_namespace_decl(xmlNodePtr nodep, xmlNsPtr original, zval *return_value, dom_object *parent_intern)
+static xmlNodePtr php_dom_create_fake_namespace_decl_node_ptr(xmlNodePtr nodep, xmlNsPtr original)
{
xmlNodePtr attrp;
xmlNsPtr curns = xmlNewNs(NULL, original->href, NULL);
@@ -1593,11 +1619,16 @@ xmlNodePtr php_dom_create_fake_namespace_decl(xmlNodePtr nodep, xmlNsPtr origina
attrp->type = XML_NAMESPACE_DECL;
attrp->parent = nodep;
attrp->ns = curns;
+ return attrp;
+}
+/* Note: Assumes the additional lifetime was already added in the caller. */
+xmlNodePtr php_dom_create_fake_namespace_decl(xmlNodePtr nodep, xmlNsPtr original, zval *return_value, dom_object *parent_intern)
+{
+ xmlNodePtr attrp = php_dom_create_fake_namespace_decl_node_ptr(nodep, original);
php_dom_create_object(attrp, return_value, parent_intern);
/* This object must exist, because we just created an object for it via php_dom_create_object(). */
- dom_object *obj = ((php_libxml_node_ptr *)attrp->_private)->_private;
- php_dom_namespace_node_obj_from_obj(&obj->std)->parent_intern = parent_intern;
+ php_dom_namespace_node_obj_from_obj(Z_OBJ_P(return_value))->parent_intern = parent_intern;
return attrp;
}
diff --git a/ext/dom/tests/clone_nodes.phpt b/ext/dom/tests/clone_nodes.phpt
new file mode 100644
index 0000000000000..1841c702caf8d
--- /dev/null
+++ b/ext/dom/tests/clone_nodes.phpt
@@ -0,0 +1,72 @@
+--TEST--
+Clone nodes
+--EXTENSIONS--
+dom
+--FILE--
+loadXML('');
+
+$attr = $doc->documentElement->getAttributeNode('xmlns');
+var_dump($attr);
+
+$attrClone = clone $attr;
+var_dump($attrClone->nodeValue);
+var_dump($attrClone->parentNode->nodeName);
+
+unset($doc);
+unset($attr);
+
+var_dump($attrClone->nodeValue);
+var_dump($attrClone->parentNode->nodeName);
+
+echo "-- Clone DOMNode --\n";
+
+$doc = new DOMDocument;
+$doc->loadXML('');
+
+$bar = $doc->documentElement->firstChild;
+$barClone = clone $bar;
+$bar->remove();
+unset($bar);
+
+var_dump($barClone->nodeName);
+
+$doc->firstElementChild->remove();
+unset($doc);
+
+var_dump($barClone->nodeName);
+var_dump($barClone->parentNode);
+
+?>
+--EXPECT--
+-- Clone DOMNameSpaceNode --
+object(DOMNameSpaceNode)#3 (8) {
+ ["nodeName"]=>
+ string(5) "xmlns"
+ ["nodeValue"]=>
+ string(19) "http://php.net/test"
+ ["nodeType"]=>
+ int(18)
+ ["prefix"]=>
+ string(0) ""
+ ["localName"]=>
+ string(5) "xmlns"
+ ["namespaceURI"]=>
+ string(19) "http://php.net/test"
+ ["ownerDocument"]=>
+ string(22) "(object value omitted)"
+ ["parentNode"]=>
+ string(22) "(object value omitted)"
+}
+string(19) "http://php.net/test"
+string(3) "foo"
+string(19) "http://php.net/test"
+string(3) "foo"
+-- Clone DOMNode --
+string(3) "bar"
+string(3) "bar"
+NULL