Fix the oddest PHP5 bug in the world...

[xml-template] / php5 / xml-template.php

diff --git a/php5/xml-template.php b/php5/xml-template.php
index e68c2be45842a4c4da9bd389de21cee26ee1be7a..ed1e8f85529fc389120184c8023dee97a516518a 100644 (file)
--- a/php5/xml-template.php
+++ b/php5/xml-template.php
@@ -11,28 +11,28 @@ function XML_Template_process_file($filename, $obj, $clean = 1)
 function XML_Template_process($node, $obj, $clean = 1)
 {
        if (is_a($obj, 'DOMNode')) {                          # overwrite
-               for ($i = 0; $i < $node->childNodes->length; ++$i) {
-                       $child = $node->childNodes->item($i);
+               while ($node->childNodes->length > 0) {
+                       $child = $node->childNodes->item(0);
                        $node->removeChild($child);
                }
 
                if (is_a($obj, 'DOMDocument')) {
-                       $obj = $obj->document_element();
+                       $obj = $obj->documentElement;
                }
 
-               $newobj = $obj->cloneNode(true);
-               $node->appendChild($newobj);
-
-               XML_Template_process($newobj, array(), $clean);
+               $frag = $node->ownerDocument->createDocumentFragment();
+               $frag->appendChild($node->ownerDocument->importNode($obj, true));
+               XML_Template_process($frag, array(), $clean);
+               $node->appendChild($frag);
        } else if (!is_array($obj)) {                         # overwrite
-               for ($i = 0; $i < $node->childNodes->length; ++$i) {
-                       $child = $node->childNodes->item($i);
-                       $node->removeChild($child);
+               while ($node->childNodes->length > 0) {
+                       $node->removeChild($node->firstChild);
                }
                $doc = $node->ownerDocument;
                $node->appendChild($doc->createTextNode($obj));
        } else if (is_associative_array($obj)) {              # substitute
-               for ($i = 0; $i < $node->childNodes->length; ++$i) {
+               $num_children = ($node->childNodes == null) ? 0 : $node->childNodes->length;
+               for ($i = 0; $i < $num_children; ++$i) {
                        $child = $node->childNodes->item($i);
                        $processed = false;
 
@@ -43,14 +43,27 @@ function XML_Template_process($node, $obj, $clean = 1)
                                $attrs = $child->attributes;
 
                                if (isset($attrs)) {
+                                       $replace_child = 0;
                                        foreach ($child->attributes as $attr) {
                                                if ($attr->namespaceURI == 'http://template.sesse.net/' && $attr->name == 'id') {
                                                        $id = $attr->value;
                                                        if ($clean) {
                                                                $child->removeAttributeNode($attr);
+                                                               $replace_child = 1;
                                                        }
                                                }
                                        }
+
+                                       # This seems to be the only way to reliably get rid of the excess
+                                       # XML namespace declarations.
+                                       if ($replace_child == 1) {
+                                               $newchild = own_clone_element($child, $child->ownerDocument);
+                                               while ($child->childNodes->length > 0) {
+                                                       $newchild->appendChild($child->firstChild);
+                                               }
+                                               $node->replaceChild($newchild, $child);
+                                               $child = $newchild;
+                                       }
                                }
                        
                                # check all substitutions to see if we found anything
@@ -91,8 +104,9 @@ function XML_Template_process($node, $obj, $clean = 1)
                                continue;
                        }
 
-                       $newnode = $frag->cloneNode(true);
+                       $newnode = own_clone_node($frag, $frag->ownerDocument);
                        XML_Template_process($newnode, $instance, $clean);
+
                        $node->appendChild($newnode);
                        if ($clean) {
                                XML_Template_clean($newnode);
@@ -140,6 +154,63 @@ function XML_Template_alternate($tag, $array, $elems)
        return $array;
 }
                
+# Ideally, this would be "return $obj->clone_node(true)". But surprise,
+# surprise, PHP is buggy; it does not preserve the prefix information on
+# attributes properly during a clone. (PHP4 and PHP5 are broken in different
+# ways here...) IOW, we'll have to clone everything ourselves.
+function own_clone_node($node, $doc)
+{
+       // we only need these two
+       if ($node->nodeType == XML_DOCUMENT_FRAG_NODE) {
+               $newnode = $doc->createDocumentFragment();
+
+               for ($i = 0; $i < $node->childNodes->length; ++$i) {
+                       $child = $node->childNodes->item($i);
+                       $newnode->appendChild(own_clone_node($child, $doc));
+               }
+               return $newnode;
+       } else if ($node->nodeType == XML_ELEMENT_NODE) {
+               $newnode = own_clone_element($node, $doc);
+               for ($i = 0; $i < $node->childNodes->length; ++$i) {
+                       $child = $node->childNodes->item($i);
+                       $newnode->appendChild(own_clone_node($child, $doc));
+               }
+               return $newnode;
+       } else {
+               return $node->cloneNode(true);
+       }
+}
+               
+function own_clone_element($node, $doc)
+{
+       $nsuri = $node->namespaceURI;
+       if (isset($nsuri) && $node->prefix != "default") {
+               $newnode = $doc->createElementNS($node->namespaceURI, $node->nodeName, $node->prefix);
+       
+               // remove useless empty text child
+               $newnode->removeChild($newnode->firstChild);
+       } else {
+               $newnode = $doc->createElement($node->localName);
+       }
+       
+       $attrs = $node->attributes;
+       if (isset($attrs)) {
+               foreach ($node->attributes as $attr) {
+                       $nsuri = $attr->namespaceURI;
+                       if (isset($nsuri) && $attr->prefix != "default") {
+                               $attr2 = $doc->createAttributeNS($nsuri, $attr->prefix . ":" . $attr->name);
+                       } else {
+                               $attr2 = $doc->createAttribute($attr->localName);
+                       }
+
+                       # You've got to be kidding me...
+                       $attr2->value = htmlentities($attr->value);
+                       $newnode->appendChild($attr2);
+               }
+       }
+       return $newnode;
+}
+
 function is_associative_array($arr)
 {
        if (!is_array($arr)) {