git.sesse.net Git - xml-template/blob - php5/xml-template.php

   1 <?php
   2
   3 function XML_Template_process_file($filename, $obj, $clean = 1)
   4 {
   5         $doc = new DOMDocument;
   6         $doc->load($filename);
   7         XML_Template_process($doc, $obj, $clean);
   8         return $doc;
   9 }
  10
  11 function XML_Template_process($node, $obj, $clean = 1)
  12 {
  13         if (is_a($obj, 'DOMNode')) {                          # overwrite
  14                 while ($node->childNodes->length > 0) {
  15                         $child = $node->childNodes->item(0);
  16                         $node->removeChild($child);
  17                 }
  18
  19                 if (is_a($obj, 'DOMDocument')) {
  20                         $obj = $obj->documentElement;
  21                 }
  22
  23                 $frag = $node->ownerDocument->createDocumentFragment();
  24                 $frag->appendChild($node->ownerDocument->importNode($obj, true));
  25                 XML_Template_process($frag, array(), $clean);
  26                 $node->appendChild($frag);
  27         } else if (!is_array($obj)) {                         # overwrite
  28                 while ($node->childNodes->length > 0) {
  29                         $node->removeChild($node->firstChild);
  30                 }
  31                 $doc = $node->ownerDocument;
  32                 $node->appendChild($doc->createTextNode($obj));
  33         } else if (is_associative_array($obj)) {              # substitute
  34                 $num_children = ($node->childNodes == null) ? 0 : $node->childNodes->length;
  35                 $children = array();
  36                 for ($i = 0; $i < $num_children; ++$i) {
  37                         $children[] = $node->childNodes->item($i);
  38                 }
  39
  40                 for ($i = 0; $i < $num_children; ++$i) {
  41                         $child = $children[$i];
  42                         $processed = false;
  43
  44                         if ($child->nodeType == XML_ELEMENT_NODE) {
  45                                 unset($id);
  46
  47                                 $tag = $child->localName;
  48                                 $attrs = $child->attributes;
  49
  50                                 if (isset($attrs)) {
  51                                         $replace_child = 0;
  52                                         $id_node = $child->getAttributeNodeNS('http://template.sesse.net/', 'id');
  53                                         if (isset($id_node)) {
  54                                                 $id = $id_node->value;
  55                                                 if ($clean) {
  56                                                         $child->removeAttributeNode($id_node);
  57                                                         $replace_child = 1;
  58                                                 }
  59                                         }
  60
  61                                         # This seems to be the only way to reliably get rid of the excess
  62                                         # XML namespace declarations.
  63                                         if ($replace_child == 1) {
  64                                                 $newchild = own_clone_element($child, $child->ownerDocument);
  65                                                 while ($child->childNodes->length > 0) {
  66                                                         $newchild->appendChild($child->firstChild);
  67                                                 }
  68                                                 $node->replaceChild($newchild, $child);
  69                                                 $child = $newchild;
  70                                         }
  71                                 }
  72
  73                                 # check all substitutions to see if we found anything
  74                                 # appropriate
  75                                 foreach (array_keys($obj) as $key) {
  76                                         # FIXME: we would want something like \Q and \E here...
  77                                         if (preg_match('/^' . $tag . '\/(.*)$/', $key, $matches) ||
  78                                             (isset($id) && preg_match('/^#' . $id . '\/(.*)$/', $key, $matches))) {
  79                                                 $child->setAttribute($matches[1], $obj[$key]);
  80                                         }
  81
  82                                         if ($processed) {
  83                                                 continue;
  84                                         }
  85                                         if ($key == $tag || (isset($id) && $key == ('#'.$id))) {
  86                                                 XML_Template_process($child, $obj[$key], $clean);
  87                                                 $processed = true;
  88                                         }
  89                                 }
  90                         }
  91
  92                         if (!$processed) {
  93                                 XML_Template_process($child, $obj, $clean);
  94                         }
  95                 }
  96         } else {                                                # repeat
  97                 $doc = $node->ownerDocument;
  98                 $frag = $doc->createDocumentFragment();
  99
 100                 while ($node->childNodes->length > 0) {
 101                         $child = $node->childNodes->item(0);
 102                         $node->removeChild($child);
 103                         $frag->appendChild($child);
 104                 }
 105
 106                 foreach ($obj as $instance) {
 107                         if (!isset($instance)) {
 108                                 continue;
 109                         }
 110
 111                         $newnode = own_clone_node($frag, $frag->ownerDocument);
 112                         XML_Template_process($newnode, $instance, $clean);
 113
 114                         $node->appendChild($newnode);
 115                         if ($clean) {
 116                                 XML_Template_clean($newnode);
 117                         }
 118                 }
 119         }
 120
 121         if ($clean) {
 122                 XML_Template_clean($node);
 123         }
 124 }
 125
 126 function XML_Template_clean($node)
 127 {
 128         if ($node->nodeType == XML_ELEMENT_NODE) {
 129                 if ($node->namespaceURI != 'http://template.sesse.net/') {
 130                         return;
 131                 }
 132
 133                 # as this is a dummy node, we want to remove it and move everything further up
 134                 # after we've done any required replacements
 135                 $doc = $node->ownerDocument;
 136                 $parent = $node->parentNode;
 137
 138                 while ($node->childNodes->length > 0) {
 139                         $child = $node->childNodes->item(0);
 140                         $node->removeChild($child);
 141                         $parent->insertBefore(own_clone_node($child, $doc), $node);
 142                 }
 143                 $parent->removeChild($node);
 144         }
 145 }
 146
 147 # FIXME: use varargs here
 148 function XML_Template_alternate($tag, $array, $elems)
 149 {
 150         $num = count($elems);
 151
 152         for ($i = 0, $j = 0; $i < count($array); $i++) {
 153                 if (isset($array[$i])) {
 154                         $array[$i][$tag] = $elems[$j++ % $num];
 155                 }
 156         }
 157
 158         return $array;
 159 }
 160
 161 # Ideally, this would be "return $obj->clone_node(true)". But surprise,
 162 # surprise, PHP is buggy; it does not preserve the prefix information on
 163 # attributes properly during a clone. (PHP4 and PHP5 are broken in different
 164 # ways here...) IOW, we'll have to clone everything ourselves.
 165 function own_clone_node($node, $doc)
 166 {
 167         // we only need these two
 168         if ($node->nodeType == XML_DOCUMENT_FRAG_NODE) {
 169                 $newnode = $doc->createDocumentFragment();
 170
 171                 for ($i = 0; $i < $node->childNodes->length; ++$i) {
 172                         $child = $node->childNodes->item($i);
 173                         $newnode->appendChild(own_clone_node($child, $doc));
 174                 }
 175                 return $newnode;
 176         } else if ($node->nodeType == XML_ELEMENT_NODE) {
 177                 $newnode = own_clone_element($node, $doc);
 178                 for ($i = 0; $i < $node->childNodes->length; ++$i) {
 179                         $child = $node->childNodes->item($i);
 180                         $newnode->appendChild(own_clone_node($child, $doc));
 181                 }
 182                 return $newnode;
 183         } else {
 184                 return $node->cloneNode(true);
 185         }
 186 }
 187
 188 function own_clone_element($node, $doc)
 189 {
 190         $nsuri = $node->namespaceURI;
 191         if (isset($nsuri) && $node->prefix != "default") {
 192                 $newnode = $doc->createElementNS($node->namespaceURI, $node->nodeName, $node->prefix);
 193
 194                 // remove useless empty text child
 195                 $newnode->removeChild($newnode->firstChild);
 196         } else {
 197                 $newnode = $doc->createElement($node->localName);
 198         }
 199
 200         $attrs = $node->attributes;
 201         if (isset($attrs)) {
 202                 foreach ($node->attributes as $attr) {
 203                         $nsuri = $attr->namespaceURI;
 204                         if (isset($nsuri) && $attr->prefix != "default") {
 205                                 $attr2 = $doc->createAttributeNS($nsuri, $attr->prefix . ":" . $attr->name);
 206                         } else {
 207                                 $attr2 = $doc->createAttribute($attr->localName);
 208                         }
 209
 210                         # You've got to be kidding me...
 211                         $attr2->value = preg_replace("/&/", "&amp;", $attr->value);
 212                         $newnode->appendChild($attr2);
 213                 }
 214         }
 215         return $newnode;
 216 }
 217
 218 function is_associative_array($arr)
 219 {
 220         if (!is_array($arr)) {
 221                 return false;
 222         }
 223         $diff = array_diff(range(0, count($arr) - 1), array_keys($arr));
 224         return (count($diff) > 0);
 225 }
 226 ?>