Skip to content

Tofu in xi:include fixups, block/warning against functional xi:fallback #332

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alfsb wants to merge 1 commit into
base: master
Choose a base branch
from
+48 −9
Open

Tofu in xi:include fixups, block/warning against functional xi:fallback #332

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 37 additions & 9 deletions configure.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -716,18 +716,43 @@ function individual_xml_broken_check()
}
}

echo "Expanding XIncludes... ";
xinclude_no_fallback( $dom );

echo "Expanding XIncludes... ";
$total = xinclude_run_byid( $dom );
$total += xinclude_run_xpointer( $dom );

if ( $total == 0 )
echo "failed.\n";
else
echo "done: $total tags replaced.\n";

xinclude_residual_fixup( $dom );

function xinclude_no_fallback( DOMDocument $dom )
{
// Check if there is reachable <xi:fallback>s.
// Not permited in doc-en, warning on translations.

$xpath = new DOMXPath( $dom );
$xpath->registerNamespace( "xi" , "http://www.w3.org/2001/XInclude" );

$xifallbacks = $xpath->query( "//xi:fallback" );

if ( $xifallbacks->length > 0 )
{
if ( $GLOBALS['ac']['LANG'] == 'en' )
{
print "\n<xi:fallback> cause silent errors in all languages.\n";
print "Not allowed on doc-en.\n";
errors_are_bad( 1 );
}
else
{
print "Translation contains <xi:fallback>. Manual parts will be missing.\n";
}
}
}

function xinclude_run_byid( DOMDocument $dom )
{
// libxml does not implements the XInclude 1.1 feature,
Expand All @@ -737,8 +762,9 @@ function xinclude_run_byid( DOMDocument $dom )
$xpath = new DOMXPath( $dom );
$xpath->registerNamespace( "xi" , "http://www.w3.org/2001/XInclude" );

// Resolve xpointers via a precomputed map; on duplicate xml:ids, first wins.
// Collect IDs in one go. On duplicate xml:ids, first wins.
// Avoids quadratic tree walks (~ 90% performance gain).

$byId = [];
foreach( $xpath->query( "//*[@xml:id]" ) as $node ) {
$byId[$node->getAttribute("xml:id")] ??= $node;
Expand Down Expand Up @@ -818,22 +844,24 @@ function xinclude_residual_fixup( DOMDocument $dom )
$fixups = 0;
$hardfail = false;

dom_saveload( $dom , __DIR__ . "/temp/manual.err" );
dom_saveload( $dom , __DIR__ . "/temp/debug.xi" );
$nodes = xinclude_residual_list( $dom );

foreach( $nodes as $node )
{
$fixup = null;
$parent = $node->parentNode->nodeName;
$target = $node->getAttribute("xpointer");
$alert = "[[[Failed XInclude '$target']]]";
$alert = "[[[Failed XInclude<!-- $target -->']]]";

if ( $fixups === 0 )
echo "\nFailed XIncludes, manual parts will be missing. Unresolved xpointers:\n";
echo "\nFailed XIncludes, manual parts will be missing. Failed xpointer:\n";

echo "- {$target}\n";
$fixups++;

// Empty elements are bad in PhD, so tofu �. See https://github.com/php/phd/issues/181

switch( $parent )
{
case "listitem":
Expand All @@ -842,13 +870,13 @@ function xinclude_residual_fixup( DOMDocument $dom )
$fixup = "";
break;
case "refsect1":
$fixup = "<title>_</title><simpara>$alert</simpara>"; // https://github.com/php/phd/issues/181
$fixup = "<title>�</title><simpara>$alert</simpara>";
break;
case "tbody":
$fixup = "<row><entry>$alert</entry></row>";
break;
case "variablelist":
$fixup = "<varlistentry><term></term><listitem><simpara>$alert</simpara></listitem></varlistentry>";
$fixup = "<varlistentry><term>�</term><listitem><simpara>$alert</simpara></listitem></varlistentry>";
break;
case "classsynopsis":
$fixup = "<classsynopsisinfo role='comment'>$alert</classsynopsisinfo>";
Expand All @@ -874,7 +902,7 @@ function xinclude_residual_fixup( DOMDocument $dom )
unset( $nodes );

if ( $fixups > 0 )
echo "Dumped file: temp/manual.err. Inspect residual xi:include tags in this file.\n\n";
echo "Dumped file: temp/debug.xi. Inspect residual xi:include tags in this file.\n\n";

if ( $hardfail )
{
Expand Down
11 changes: 11 additions & 0 deletions scripts/broken.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,17 @@ function testFile( string $filename , bool $checkDnt , bool $fragmentDir = false
echo "\n";
return;
}

$xpath = new DOMXPath( $doc );
$xpath->registerNamespace( "xi" , "http://www.w3.org/2001/XInclude" );
$list = $xpath->query( "//xi:fallback" );
if ( $list->length > 0 )
{
echo "File contains functional <xi:fallback>.\n";
echo " Issue: Manual parts will be missing.\n";
echo " Path: $filename\n";
echo "\n";
}
}

function testDir( string $dir , bool $checkDnt )
Expand Down
Loading