Don't display a "Next" link when we get to the last page in the

[exim-website.git] / script / gen.pl

diff --git a/script/gen.pl b/script/gen.pl
index eb61e05d9967646db876689347fc6ba28bd70334..ac3d3d605d646891eff10d17f2cfcc3ebf0a8c80 100755 (executable)
--- a/script/gen.pl
+++ b/script/gen.pl
@@ -1,4 +1,4 @@
-#!/usr/bin/perl
+#!/usr/bin/env perl

 #
 use strict;
 use warnings;
 #
 use strict;
 use warnings;


@@ -6,6 +6,7 @@ use warnings;
 use CSS::Minifier::XS 0.07;
 use File::Copy;
 use File::Find;
 use CSS::Minifier::XS 0.07;
 use File::Copy;
 use File::Find;

+use File::Path qw(make_path);

 use File::Slurp;
 use File::Spec;
 use Getopt::Long;
 use File::Slurp;
 use File::Spec;
 use Getopt::Long;


@@ -26,7 +27,9 @@ do_web() if exists $opt{web};
 
 ## Add the exim-html-current symlink
 print "Symlinking exim-html-current to exim-html-$opt{latest}\n";
 
 ## Add the exim-html-current symlink
 print "Symlinking exim-html-current to exim-html-$opt{latest}\n";

-symlink( "$opt{docroot}/exim-html-$opt{latest}", "$opt{docroot}/exim-html-current" );
+unlink("$opt{docroot}/exim-html-current") if ( -l "$opt{docroot}/exim-html-current" );
+symlink( "exim-html-$opt{latest}", "$opt{docroot}/exim-html-current" )
+    || die "symlink to $opt{docroot}/exim-html-current failed";

 
 ## Generate the website files
 sub do_web {
 
 ## Generate the website files
 sub do_web {


@@ -37,7 +40,8 @@ sub do_web {
     ## Scan the web templates
     find(
         sub {
     ## Scan the web templates
     find(
         sub {

-            my ($path) = substr( $File::Find::name, length("$opt{tmpl}/web"), length($File::Find::name) ) =~ m#^/*(.*)$#;
+            my ($path) =
+                substr( $File::Find::name, length("$opt{tmpl}/web"), length($File::Find::name) ) =~ m#^/*(.*)$#;

 
             if ( -d "$opt{tmpl}/web/$path" ) {
 
 
             if ( -d "$opt{tmpl}/web/$path" ) {
 


@@ -51,27 +55,31 @@ sub do_web {
 
                 ## Build HTML from XSL files and simply copy static files which have changed
                 if ( $path =~ /(.+)\.xsl$/ ) {
 
                 ## Build HTML from XSL files and simply copy static files which have changed
                 if ( $path =~ /(.+)\.xsl$/ ) {

-                    print "Generating  : docroot:/$1.html\n";
+                    print "Generating  : docroot:/$1.html\n" if ( $opt{verbose} );

                     transform( undef, "$opt{tmpl}/web/$path", "$opt{docroot}/$1.html" );
                 }
                 elsif ( -f "$opt{tmpl}/web/$path" ) {
 
                     ## Skip if the file hasn't changed (mtime based)
                     transform( undef, "$opt{tmpl}/web/$path", "$opt{docroot}/$1.html" );
                 }
                 elsif ( -f "$opt{tmpl}/web/$path" ) {
 
                     ## Skip if the file hasn't changed (mtime based)

-                    return if -f "$opt{docroot}/$path" && ( stat("$opt{tmpl}/web/$path") )[9] == ( stat("$opt{docroot}/$path") )[9];
+                    return
+                        if -f "$opt{docroot}/$path"
+                            && ( stat("$opt{tmpl}/web/$path") )[9] == ( stat("$opt{docroot}/$path") )[9];

 
                     if ( $path =~ /(.+)\.css$/ ) {
 
                     if ( $path =~ /(.+)\.css$/ ) {

-                        print "CSS to  : docroot:/$path\n";
+                        print "CSS to  : docroot:/$path\n" if ( $opt{verbose} );

                         my $content = read_file("$opt{tmpl}/web/$path");
                         my $content = read_file("$opt{tmpl}/web/$path");

-                        write_file( "$opt{docroot}/$path", $opt{minify} ? CSS::Minifier::XS::minify($content) : $content );
+                        write_file( "$opt{docroot}/$path",
+                            $opt{minify} ? CSS::Minifier::XS::minify($content) : $content );

                     }
                     elsif ( $path =~ /(.+)\.js$/ ) {
                     }
                     elsif ( $path =~ /(.+)\.js$/ ) {

-                        print "JS to  : docroot:/$path\n";
+                        print "JS to  : docroot:/$path\n" if ( $opt{verbose} );

                         my $content = read_file("$opt{tmpl}/web/$path");
                         my $content = read_file("$opt{tmpl}/web/$path");

-                        write_file( "$opt{docroot}/$path", $opt{minify} ? JavaScript::Minifier::XS::minify($content) : $content );
+                        write_file( "$opt{docroot}/$path",
+                            $opt{minify} ? JavaScript::Minifier::XS::minify($content) : $content );

                     }
                     else {
                         ## Copy
                     }
                     else {
                         ## Copy

-                        print "Copying to  : docroot:/$path\n";
+                        print "Copying to  : docroot:/$path\n" if ( $opt{verbose} );

                         copy( "$opt{tmpl}/web/$path", "$opt{docroot}/$path" ) or die "$path: $!";
                     }
                     ## Set mtime
                         copy( "$opt{tmpl}/web/$path", "$opt{docroot}/$path" ) or die "$path: $!";
                     }
                     ## Set mtime


@@ -100,7 +108,7 @@ sub do_doc {
 
     ## Add the canonical url for this document
     $xml->documentElement()
 
     ## Add the canonical url for this document
     $xml->documentElement()

-      ->appendTextChild( 'canonical_url',
+        ->appendTextChild( 'canonical_url',

         "${canonical_url}exim-html-current/doc/html/spec_html/" . ( $type eq 'spec' ? 'index' : 'filter' ) . ".html" );
 
     ## Fixup the XML
         "${canonical_url}exim-html-current/doc/html/spec_html/" . ( $type eq 'spec' ? 'index' : 'filter' ) . ".html" );
 
     ## Fixup the XML


@@ -115,14 +123,16 @@ sub do_doc {
 
     ## Generate a Table of Contents XML file
     {
 
     ## Generate a Table of Contents XML file
     {

-        my $path = "exim-html-$version/doc/html/spec_html/" . ( $type eq 'filter' ? 'filter_toc' : 'index_toc' ) . ".xml";
-        print "Generating  : docroot:/$path\n";
+        my $path =
+            "exim-html-$version/doc/html/spec_html/" . ( $type eq 'filter' ? 'filter_toc' : 'index_toc' ) . ".xml";
+        print "Generating  : docroot:/$path\n" if ( $opt{verbose} );

         transform( $xml, "$opt{tmpl}/doc/toc.xsl", "$opt{docroot}/$path", );
     }
 
     ## Generate the chapters
     my $counter = 0;
         transform( $xml, "$opt{tmpl}/doc/toc.xsl", "$opt{docroot}/$path", );
     }
 
     ## Generate the chapters
     my $counter = 0;

-    foreach my $chapter ( map { $_->cloneNode(1) } $xml->findnodes('/book/chapter') ) {
+    my @chapters = map { $_->cloneNode(1) } $xml->findnodes('/book/chapter');
+    foreach my $chapter ( @chapters ) {

 
         ## Add a <chapter_id>N</chapter_id> node for the stylesheet to use
         $chapter->appendTextChild( 'chapter_id', ++$counter );
 
         ## Add a <chapter_id>N</chapter_id> node for the stylesheet to use
         $chapter->appendTextChild( 'chapter_id', ++$counter );


@@ -132,12 +142,17 @@ sub do_doc {
             $chapter->appendTextChild( 'prev_url',
                   $counter == 1
                 ? $type eq 'filter'
             $chapter->appendTextChild( 'prev_url',
                   $counter == 1
                 ? $type eq 'filter'

-                      ? 'filter.html'
-                      : 'index.html'
+                        ? 'filter.html'
+                        : 'index.html'

                 : sprintf( '%sch%02d.html', $prepend_chapter, $counter - 1 ) );
                 : sprintf( '%sch%02d.html', $prepend_chapter, $counter - 1 ) );

-            $chapter->appendTextChild( 'next_url', sprintf( '%sch%02d.html', $prepend_chapter, $counter + 1 ) );
-            $chapter->appendTextChild( 'canonical_url',
-                sprintf( 'http://www.exim.org/exim-html-current/doc/html/spec_html/%sch%02d.html', $prepend_chapter, $counter ) );
+            $chapter->appendTextChild( 'next_url', sprintf( '%sch%02d.html', $prepend_chapter, $counter + 1 ) ) unless int(@chapters) == $counter;
+            $chapter->appendTextChild(
+                'canonical_url',
+                sprintf(
+                    'http://www.exim.org/exim-html-current/doc/html/spec_html/%sch%02d.html',
+                    $prepend_chapter, $counter
+                )
+            );

         }
 
         ## Create an XML document from the chapter
         }
 
         ## Create an XML document from the chapter


@@ -147,7 +162,7 @@ sub do_doc {
         ## Transform the chapter into html
         {
             my $path = sprintf( 'exim-html-%s/doc/html/spec_html/%sch%02d.html', $version, $prepend_chapter, $counter );
         ## Transform the chapter into html
         {
             my $path = sprintf( 'exim-html-%s/doc/html/spec_html/%sch%02d.html', $version, $prepend_chapter, $counter );

-            print "Generating  : docroot:/$path\n";
+            print "Generating  : docroot:/$path\n" if ( $opt{verbose} );

             transform( $doc, "$opt{tmpl}/doc/chapter.xsl", "$opt{docroot}/$path", );
         }
     }
             transform( $doc, "$opt{tmpl}/doc/chapter.xsl", "$opt{docroot}/$path", );
         }
     }


@@ -205,11 +220,12 @@ sub xref_fixup {
         if ( exists $index{$linkend} ) {
             $xref->setAttribute( 'chapter_id',    $index{$linkend}{'chapter_id'} );
             $xref->setAttribute( 'chapter_title', $index{$linkend}{'chapter_title'} );
         if ( exists $index{$linkend} ) {
             $xref->setAttribute( 'chapter_id',    $index{$linkend}{'chapter_id'} );
             $xref->setAttribute( 'chapter_title', $index{$linkend}{'chapter_title'} );

-            $xref->setAttribute( 'section_id',    $index{$linkend}{'section_id'} ) if ( $index{$linkend}{'section_id'} );
-            $xref->setAttribute( 'section_title', $index{$linkend}{'section_title'} ) if ( $index{$linkend}{'section_title'} );
+            $xref->setAttribute( 'section_id', $index{$linkend}{'section_id'} ) if ( $index{$linkend}{'section_id'} );
+            $xref->setAttribute( 'section_title', $index{$linkend}{'section_title'} )
+                if ( $index{$linkend}{'section_title'} );

             $xref->setAttribute( 'url',
                 sprintf( '%sch%02d.html', $prepend_chapter, $index{$linkend}{'chapter_id'} )
             $xref->setAttribute( 'url',
                 sprintf( '%sch%02d.html', $prepend_chapter, $index{$linkend}{'chapter_id'} )

-                  . ( $index{$linkend}{'section_id'} ? '#' . $linkend : '' ) );
+                    . ( $index{$linkend}{'section_id'} ? '#' . $linkend : '' ) );

         }
     }
 }
         }
     }
 }


@@ -224,9 +240,9 @@ sub build_indexes {
         if ( $node->nodeName eq 'indexterm' ) {
             my $role      = $node->getAttribute('role') || 'concept';
             my $primary   = $node->findvalue('child::primary');
         if ( $node->nodeName eq 'indexterm' ) {
             my $role      = $node->getAttribute('role') || 'concept';
             my $primary   = $node->findvalue('child::primary');

-            my $first     = ( $primary =~ /^[A-Za-z]/ ) ? uc( substr( $primary, 0, 1 ) ) : '';    # first letter or marker
+            my $first     = ( $primary =~ /^[A-Za-z]/ ) ? uc( substr( $primary, 0, 1 ) ) : '';  # first letter or marker

             my $secondary = $node->findvalue('child::secondary') || '';
             my $secondary = $node->findvalue('child::secondary') || '';

-            next unless ( $primary || $secondary );                                               # skip blank entries for now...
+            next unless ( $primary || $secondary );    # skip blank entries for now...

             $index_hash->{$role}{$first}{$primary}{$secondary} ||= [];
             push @{ $index_hash->{$role}{$first}{$primary}{$secondary} }, $current_id;
         }
             $index_hash->{$role}{$first}{$primary}{$secondary} ||= [];
             push @{ $index_hash->{$role}{$first}{$primary}{$secondary} }, $current_id;
         }


@@ -275,7 +291,7 @@ sub build_indexes {
                     my $count = 0;
                     foreach my $ref ( @{ $index_hash->{$role}{$first}{$primary}{$secondary} } ) {
                         $para->appendText(', ')
                     my $count = 0;
                     foreach my $ref ( @{ $index_hash->{$role}{$first}{$primary}{$secondary} } ) {
                         $para->appendText(', ')

-                          if ( $count++ );
+                            if ( $count++ );

                         my $xrefel = XML::LibXML::Element->new('xref');
                         $xrefel->setAttribute( linkend => $ref );
                         $xrefel->setAttribute( longref => 1 );
                         my $xrefel = XML::LibXML::Element->new('xref');
                         $xrefel->setAttribute( linkend => $ref );
                         $xrefel->setAttribute( longref => 1 );


@@ -310,28 +326,14 @@ sub transform {
     my $doc = $stylesheet->transform($xml);
 
     ## Make the containing directory if it doesn't exist
     my $doc = $stylesheet->transform($xml);
 
     ## Make the containing directory if it doesn't exist

-    mkdirp( ( $out_path =~ /^(.+)\/.+$/ )[0] );
+    make_path( ( $out_path =~ /^(.+)\/.+$/ )[0], { verbose => 1 } );

 
     ## Write out the document
 
     ## Write out the document

-    open my $out, '>', $out_path or die $!;
+    open my $out, '>', $out_path or die "Unable to write $out_path - $!";

     print $out $stylesheet->output_as_bytes($doc);
     close $out;
 }
 
     print $out $stylesheet->output_as_bytes($doc);
     close $out;
 }
 

-## "mkdir -p "
-sub mkdirp {
-    my $path = shift;
-
-    my @parts = ();
-    foreach ( split( /\//, $path ) ) {
-        push @parts, $_;
-        my $make = join( '/', @parts );
-        next unless length($make);
-        next if -d $make;
-        mkdir($make) or die "Unable to mkdir $make: $!\n";
-    }
-}
-

 ## error_help
 sub error_help {
     my $msg = shift;
 ## error_help
 sub error_help {
     my $msg = shift;


@@ -343,9 +345,11 @@ sub error_help {
 ## Parse arguments
 sub parse_arguments {
 
 ## Parse arguments
 sub parse_arguments {
 

-    my %opt = ( spec => [], filter => [], help => 0, man => 0, web => 0, minify => 1 );
-    GetOptions( \%opt, 'help|h!', 'man!', 'web!', 'spec=s{1,}', 'filter=s{1,}', 'latest=s', 'tmpl=s', 'docroot=s', 'minify!' )
-      || pod2usage( -exitval => 1, -verbose => 0 );
+    my %opt = ( spec => [], filter => [], help => 0, man => 0, web => 0, minify => 1, verbose => 0 );
+    GetOptions(
+        \%opt,      'help|h!', 'man!',      'web!',    'spec=s{1,}', 'filter=s{1,}',
+        'latest=s', 'tmpl=s',  'docroot=s', 'minify!', 'verbose!'
+    ) || pod2usage( -exitval => 1, -verbose => 0 );

 
     ## --help
     pod2usage(0) if ( $opt{help} );
 
     ## --help
     pod2usage(0) if ( $opt{help} );


@@ -353,7 +357,9 @@ sub parse_arguments {
 
     ## --spec and --filter lists
     foreach my $set (qw[spec filter]) {
 
     ## --spec and --filter lists
     foreach my $set (qw[spec filter]) {

-        $opt{$set} = [ map { my $f = File::Spec->rel2abs($_); help( 1, 'No such file: ' . $_ ) unless -f $f; $f } @{ $opt{$set} } ];
+        $opt{$set} =
+            [ map { my $f = File::Spec->rel2abs($_); help( 1, 'No such file: ' . $_ ) unless -f $f; $f }
+                @{ $opt{$set} } ];

     }
     ## --latest
     error_help('Missing value for latest') unless ( exists( $opt{latest} ) && defined( $opt{latest} ) );
     }
     ## --latest
     error_help('Missing value for latest') unless ( exists( $opt{latest} ) && defined( $opt{latest} ) );


@@ -369,7 +375,7 @@ sub parse_arguments {
     error_help('Excess arguments') if ( scalar(@ARGV) );
 
     error_help('Must include at least one of --web, --spec or --filter')
     error_help('Excess arguments') if ( scalar(@ARGV) );
 
     error_help('Must include at least one of --web, --spec or --filter')

-      unless ( defined $opt{web} || scalar( @{ $opt{spec} } ) || scalar( @{ $opt{web} } ) );
+        unless ( $opt{web} || scalar( @{ $opt{spec} || [] } ) || scalar( @{ $opt{filter} || [] } ) );

 
     return %opt;
 }
 
     return %opt;
 }


@@ -479,4 +485,3 @@ Mike produced.
 Copyright 2010 Exim Maintainers. All rights reserved.
 
 =cut
 Copyright 2010 Exim Maintainers. All rights reserved.
 
 =cut

-