Skip to content

Commit

Permalink
Idempotent build: configure.php (#202)
Browse files Browse the repository at this point in the history
  • Loading branch information
@alfsb
alfsb authored Dec 10, 2024
1 parent df18cd2 commit 4309883
Showing 1 changed file with 69 additions and 65 deletions.
134 changes: 69 additions & 65 deletions configure.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,12 @@
+----------------------------------------------------------------------+
*/

error_reporting(-1);
$cvs_id = '$Id$';
ini_set( 'display_errors' , 1 );
ini_set( 'display_startup_errors' , 1 );
error_reporting( E_ALL );
ob_implicit_flush();

echo "configure.php: $cvs_id\n";
echo "configure.php on PHP " . phpversion() . "\n\n";

const RNG_SCHEMA_DIR = __DIR__ . DIRECTORY_SEPARATOR . 'docbook' . DIRECTORY_SEPARATOR . 'docbook-v5.2-os' . DIRECTORY_SEPARATOR . 'rng' . DIRECTORY_SEPARATOR;
const RNG_SCHEMA_FILE = RNG_SCHEMA_DIR . 'docbook.rng';
Expand Down Expand Up @@ -101,7 +103,6 @@ function checking($for) // {{{

if ($ac['quiet'] != 'yes') {
echo "Checking {$for}... ";
flush();
}
} // }}}

Expand Down Expand Up @@ -191,40 +192,44 @@ function make_scripts_executable($filename) // {{{
}
} // }}}

// Loop through and print out all XML validation errors {{{
function print_xml_errors($details = true) {
function print_xml_errors()
{
global $ac;
$report = $ac['LANG'] == 'en' || $ac['XPOINTER_REPORTING'] == 'yes';
$output = ( $ac['STDERR_TO_STDOUT'] == 'yes' ) ? STDOUT : STDERR ;

$errors = libxml_get_errors();
$output = ( $ac['STDERR_TO_STDOUT'] == 'yes' ) ? STDOUT : STDERR;
if ($errors && count($errors) > 0) {
foreach($errors as $err) {
if ($ac['LANG'] != 'en' && // translations
$ac['XPOINTER_REPORTING'] != 'yes' && // can disable
strncmp($err->message, 'XPointer evaluation failed:', 27) == 0) {
continue;
}
$errmsg = wordwrap(" " . trim($err->message), 80, "\n ");
if ($details && $err->file) {
$file = file(urldecode($err->file)); // libxml appears to urlencode() its errors strings
if (isset($file[$err->line])) {
$line = rtrim($file[$err->line - 1]);
$padding = str_repeat("-", $err->column) . "^";
fprintf($output, "\nERROR (%s:%s:%s)\n%s\n%s\n%s\n", $err->file, $err->line, $err->column, $line, $padding, $errmsg);
} else {
fprintf($output, "\nERROR (%s:unknown)\n%s\n", $err->file, $errmsg);
}
} else {
fprintf($output, "%s\n", $errmsg);
}
// Error too severe, stopping
if ($err->level === LIBXML_ERR_FATAL) {
fprintf($output, "\n\nPrevious errors too severe. Stopping here.\n\n");
break;
}
}
}
libxml_clear_errors();
} // }}}

$filePrefix = "file:///";
$tempPrefix = realpath( __DIR__ . "/temp" ) . "/";
$rootPrefix = realpath( __DIR__ . "/.." ) . "/";

if ( count( $errors ) > 0 )
fprintf( $output , "\n" );

foreach( $errors as $error )
{
$mssg = rtrim( $error->message );
$file = $error->file;
$line = $error->line;
$clmn = $error->column;

if ( str_starts_with( $mssg , 'XPointer evaluation failed:' ) && ! $report )
continue; // Translations can omit these, to focus on fatal errors

if ( str_starts_with( $file , $filePrefix ) )
$file = substr( $file , strlen( $filePrefix ) );
if ( str_starts_with( $file , $tempPrefix ) )
$file = substr( $file , strlen( $tempPrefix ) );
if ( str_starts_with( $file , $rootPrefix ) )
$file = substr( $file , strlen( $rootPrefix ) );

$prefix = $error->level === LIBXML_ERR_FATAL ? "FATAL" : "error";

fwrite( $output , "[$prefix $file {$line}:{$clmn}] {$mssg}\n" );
}
}

function find_xml_files($path) // {{{
{
Expand Down Expand Up @@ -351,16 +356,6 @@ function getFileModificationHistory(): array {
$php_bin_names = array('php', 'php5', 'cli/php', 'php.exe', 'php5.exe', 'php-cli.exe', 'php-cgi.exe');
// }}}

// Reject old PHP installations {{{
if (phpversion() < 5) {
echo "PHP 5 or above is required. Version detected: " . phpversion() . "\n";
exit(100);
} else {
echo "PHP version: " . phpversion() . "\n";
} // }}}

echo "\n";

$acd = array( // {{{
'srcdir' => $srcdir,
'basedir' => $basedir,
Expand Down Expand Up @@ -676,10 +671,6 @@ function getFileModificationHistory(): array {
libxml_use_internal_errors(true);
}

$compact = defined('LIBXML_COMPACT') ? LIBXML_COMPACT : 0;
$big_lines = defined('LIBXML_BIGLINES') ? LIBXML_BIGLINES : 0;
$LIBXML_OPTS = LIBXML_NOENT | $big_lines | $compact;

if ($ac['VERSION_FILES'] === 'yes') {
$dom = new DOMDocument;
$dom->preserveWhiteSpace = false;
Expand Down Expand Up @@ -777,22 +768,39 @@ function getFileModificationHistory(): array {
checking('whether to save an invalid .manual.xml');
checkvalue($ac['FORCE_DOM_SAVE']);

echo "Loading and parsing {$ac["INPUT_FILENAME"]}... ";
flush();

$dom = new DOMDocument();

// realpath() is important: omitting it causes severe performance degradation
// and doubled memory usage on Windows.
$didLoad = $dom->load(realpath("{$ac['srcdir']}/{$ac["INPUT_FILENAME"]}"), $LIBXML_OPTS);
function dom_load( DOMDocument $dom , string $filename ) : bool
{
$filename = realpath( $filename );
$options = LIBXML_NOENT | LIBXML_COMPACT | LIBXML_BIGLINES | LIBXML_PARSEHUGE;
return $dom->load( $filename , $options );
}

function dom_saveload( DOMDocument $dom , string $filename = "" )
{
if ( $filename == "" )
$filename = __DIR__ . "/temp/manual.xml";

$dom->save( $filename );
dom_load( $dom , $filename );
}

// Check if the XML was simply broken, if so then just bail out
if ($didLoad === false) {
echo "Loading and parsing {$ac["INPUT_FILENAME"]}... ";

if ( dom_load( $dom , "{$ac['srcdir']}/{$ac["INPUT_FILENAME"]}" ) )
{
dom_saveload( $dom ); // correct file/line/column on error messages
echo "done.\n";
}
else
{
echo "failed.\n";
print_xml_errors();
errors_are_bad(1);
}
echo "done.\n";


echo "Running XInclude/XPointer... ";
$total = 0;
Expand Down Expand Up @@ -892,7 +900,7 @@ function getFileModificationHistory(): array {
}

echo "Validating {$ac["INPUT_FILENAME"]}... ";
flush();

if ($ac['PARTIAL'] != '' && $ac['PARTIAL'] != 'no') { // {{{
$dom->relaxNGValidate(RNG_SCHEMA_FILE); // we don't care if the validation works or not
$node = $dom->getElementById($ac['PARTIAL']);
Expand Down Expand Up @@ -934,15 +942,11 @@ function getFileModificationHistory(): array {
$mxml = $ac["OUTPUT_FILENAME"];

/* TODO: For some reason libxml does not validate the RelaxNG schema unless reloading the document in full */
$dom->save($mxml);
$dom->load($mxml, $LIBXML_OPTS);
dom_saveload( $dom ); // idempotent path
$dom->save($mxml); // non idempotent, historical path
if ($dom->relaxNGValidate(RNG_SCHEMA_FILE)) {
echo "done.\n";
printf("\nAll good. Saving %s... ", basename($ac["OUTPUT_FILENAME"]));
flush();
$dom->save($mxml);

echo "done.\n";
printf("\nAll good. Saved %s\n", basename($ac["OUTPUT_FILENAME"]));
echo "All you have to do now is run 'phd -d {$mxml}'\n";
echo "If the script hangs here, you can abort with ^C.\n";
echo <<<CAT
Expand Down

0 comments on commit 4309883

Please sign in to comment.