XInclude by xml:id

Author: André L F S Bacci

configure.php

@@ -774,47 +774,108 @@ function getFileModificationHistory(): array {
 }
 echo "done.\n";
 
-echo "Running XInclude/XPointer... ";
-$total = 0;
-$maxrun = 10; //LIBXML_VERSION >= 21100 ? 1 : 10;
-for( $run = 0 ; $run < $maxrun ; $run++ )
+echo "Running XInclude... ";
+
+$total  = xinclude_run_byid( $dom );
+$total += xinclude_run_xpointer( $dom );
+
+if ( $total == 0 )
+    echo "failed.\n";
+else
+    echo "done. Performed $total XIncludes.\n";
+
+xinclude_report();
+xinclude_residual( $dom );
+
+function xinclude_run_byid( DOMDocument $dom )
 {
-    if ( $run > 0 )
-        echo "$run ";
-    libxml_clear_errors();
-    $status = (int) $dom->xinclude();
-    if ( $status <= 0 )
-        break;
-    $total += $status;
-    if ( $maxrun > 1 && $run + 1 >= $maxrun )
+    $total = 0;
+    $maxrun = 10; //LIBXML_VERSION >= 21100 ? 1 : 10;
+    for( $run = 0 ; $run < $maxrun ; $run++ )
     {
-        echo "Recursive XInclude is too deep.\n";
-        errors_are_bad(-1);
+        $xpath = new DOMXPath( $dom );
+        $xpath->registerNamespace( "xi" , "http://www.w3.org/2001/XInclude" );
+        $xincludes = $xpath->query( "//xi:include" );
+
+        $progress = false;
+        foreach( $xincludes as $xinclude )
+        {
+            $xpointer = $xinclude->getAttribute( "xpointer" );
+            $target = $xinclude->ownerDocument->getElementById( $xpointer );
+
+            if ( $target == null )
+                continue;
+
+            $other = new DOMDocument( '1.0' , 'utf8' );
+            $frags = $other->createDocumentFragment();
+            $other->append( $frags );
+            $frags->append( $other->importNode( $target , true ) ); // dup add
+
+            // "attributes in xml: namespace are not copied"
+
+            $oxpth = new DOMXPath( $other );
+            $attribs = $oxpth->query( "//@*" );
+
+            foreach( $attribs as $attrib )
+                if ( $attrib->prefix == "xml" )
+                    $attrib->parentNode->removeAttribute( $attrib->nodeName );
+
+            $insert = $dom->importNode( $frags , true );                // dup
+            $xinclude->parentNode->insertBefore( $insert , $xinclude ); // add
+            $xinclude->parentNode->removeChild( $xinclude );            // del
+
+            $progress = true;
+            $total++;
+        }
+
+        if ( $progress )
+            continue;
+        else
+            return $total;
     }
+    echo "XInclude nested too deeply (xml:id).\n";
+    errors_are_bad( -1 );
 }
 
-if ($total == 0) {
-    echo "failed.\n";
-} else {
-    echo "done. Performed $total XIncludes.\n";
+function xinclude_run_xpointer( DOMDocument $dom ) : int
+{
+    $total = 0;
+    $maxrun = 10; //LIBXML_VERSION >= 21100 ? 1 : 10;
+    for( $run = 0 ; $run < $maxrun ; $run++ )
+    {
+        echo ".";
+        libxml_clear_errors();
+        $status = (int) $dom->xinclude();
+        if ( $status <= 0 )
+            return $total;
+        $total += $status;
+    }
+    echo "XInclude nested too deeply (xpointer).\n";
+    errors_are_bad( -1 );
 }
-flush();
 
-if ( $ac['XPOINTER_REPORTING'] == 'yes' || $ac['LANG'] == 'en' )
+function xinclude_report()
 {
+    global $ac;
+
+    $report = $ac['XPOINTER_REPORTING'] == 'yes' || $ac['LANG'] == 'en';
+    $output = $ac['STDERR_TO_STDOUT'] == 'yes' ? STDOUT : STDERR;
+    $fatal  = $ac['LANG'] == 'en';
+
     $errors = libxml_get_errors();
-    $output = ( $ac['STDERR_TO_STDOUT'] == 'yes' ) ? STDOUT : STDERR;
-    if ( count( $errors ) > 0 )
+    libxml_clear_errors();
+
+    if ( count( $errors ) > 0 && $report )
     {
-        fprintf( $output , "\n");
+        fprintf( $output , "\n\n");
         foreach( $errors as $error )
-            fprintf( $output , "{$error->message}\n");
-        if ( $ac['LANG'] == 'en' )
-            errors_are_bad(1);
+            fprintf( $output , rtrim( $error->message ) . "\n\n" );
+        if ( $fatal )
+            errors_are_bad( 1 );
     }
 }
 
-if ( $ac['LANG'] != 'en' )
+function xinclude_residual( DOMDocument $dom )
 {
     // XInclude failures are soft errors on translations, so remove
     // residual XInclude tags on translations to keep them building.
@@ -869,6 +930,23 @@ function getFileModificationHistory(): array {
 MSG;
         exit(-1); // stop here, do not let more messages further confuse the matter
     }
+
+    // XInclude by xml:id never duplicates xml:id, horever, also using
+    // XInclude by XPath/XPointer may start causing duplications.
+    // Crude and ugly fixup ahead, beware!
+
+    $list = array();
+    $nodes = $xpath->query( "//*[@xml:id]" );
+    foreach( $nodes as $node )
+    {
+        $id = $node->getAttribute( "xml:id" );
+        if ( isset( $list[ $id ] ) )
+        {
+            echo "  Random removing duplicated xml:id: $id\n";
+            $node->removeAttribute( "xml:id" );
+        }
+        $list[ $id ] = $id;
+    }
 }
 
 echo "Validating {$ac["INPUT_FILENAME"]}... ";