Missing whitespace in the copyright declaration

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

diff --git a/script/gen.pl b/script/gen.pl
index c96468990f151999d2aec6522e3f1a90aa983fc0..3c1137bce534eee1fa487179a576bddfb0cf2023 100755 (executable)
--- a/script/gen.pl
+++ b/script/gen.pl
@@ -1,9 +1,16 @@
 #!/usr/bin/perl
 #!/usr/bin/perl

+#

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

+
+use CSS::Minifier::XS 0.07;

 use File::Copy;
 use File::Find;
 use File::Copy;
 use File::Find;

+use File::Slurp;

 use File::Spec;
 use File::Spec;

+use Getopt::Long;
+use JavaScript::Minifier::XS;
+use Pod::Usage;

 use XML::LibXML;
 use XML::LibXSLT;
 
 use XML::LibXML;
 use XML::LibXSLT;
 


@@ -52,10 +59,21 @@ sub do_web {
                     ## 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];
 
                     ## 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];
 

-                    ## Copy
-                    print "Copying to  : docroot:/$path\n";
-                    copy( "$opt{tmpl}/web/$path", "$opt{docroot}/$path" ) or die "$path: $!";
-
+                    if ( $path =~ /(.+)\.css$/ ) {
+                        print "CSS to  : docroot:/$path\n";
+                        my $content = read_file("$opt{tmpl}/web/$path");
+                        write_file( "$opt{docroot}/$path", $opt{minify} ? CSS::Minifier::XS::minify($content) : $content );
+                    }
+                    elsif ( $path =~ /(.+)\.js$/ ) {
+                        print "JS to  : docroot:/$path\n";
+                        my $content = read_file("$opt{tmpl}/web/$path");
+                        write_file( "$opt{docroot}/$path", $opt{minify} ? JavaScript::Minifier::XS::minify($content) : $content );
+                    }
+                    else {
+                        ## Copy
+                        print "Copying to  : docroot:/$path\n";
+                        copy( "$opt{tmpl}/web/$path", "$opt{docroot}/$path" ) or die "$path: $!";
+                    }

                     ## Set mtime
                     utime( time, ( stat("$opt{tmpl}/web/$path") )[9], "$opt{docroot}/$path" );
                 }
                     ## Set mtime
                     utime( time, ( stat("$opt{tmpl}/web/$path") )[9], "$opt{docroot}/$path" );
                 }


@@ -149,7 +167,11 @@ sub xref_fixup {
     foreach my $chapter ( $xml->findnodes('/book/chapter') ) {
         ++$chapter_counter;
 
     foreach my $chapter ( $xml->findnodes('/book/chapter') ) {
         ++$chapter_counter;
 

-        my $chapter_id    = $chapter->getAttribute('id');
+        my $chapter_id = $chapter->getAttribute('id');
+        unless ($chapter_id) {    # synthesise missing id
+            $chapter_id = sprintf( 'chapter_noid_%04d', $chapter_counter );
+            $chapter->setAttribute( 'id', $chapter_id );
+        }

         my $chapter_title = $chapter->findvalue('title');
 
         $index{$chapter_id} = { chapter_id => $chapter_counter, chapter_title => $chapter_title };
         my $chapter_title = $chapter->findvalue('title');
 
         $index{$chapter_id} = { chapter_id => $chapter_counter, chapter_title => $chapter_title };


@@ -159,13 +181,23 @@ sub xref_fixup {
         foreach my $section ( $chapter->findnodes('section') ) {
             ++$section_counter;
 
         foreach my $section ( $chapter->findnodes('section') ) {
             ++$section_counter;
 

-            my $section_id    = $section->getAttribute('id');
+            my $section_id = $section->getAttribute('id');
+            unless ($section_id) {    # synthesise missing id
+                $section_id = sprintf( 'section_noid_%04d_%04d', $chapter_counter, $section_counter );
+                $section->setAttribute( 'id', $section_id );
+            }

             my $section_title = $section->findvalue('title');
 
             my $section_title = $section->findvalue('title');
 

-            $index{$section_id} =
-              { chapter_id => $chapter_counter, chapter_title => $chapter_title, section_id => $section_counter };
+            $index{$section_id} = {
+                chapter_id    => $chapter_counter,
+                chapter_title => $chapter_title,
+                section_id    => $section_counter,
+                section_title => $section_title
+            };

         }
     }
         }
     }

+    ## Build indexes as new chapters
+    build_indexes( $xml, $prepend_chapter, \%index );

 
     ## Replace all of the xrefs in the XML
     foreach my $xref ( $xml->findnodes('//xref') ) {
 
     ## Replace all of the xrefs in the XML
     foreach my $xref ( $xml->findnodes('//xref') ) {


@@ -173,7 +205,8 @@ 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_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'} )
                   . ( $index{$linkend}{'section_id'} ? '#' . $linkend : '' ) );
             $xref->setAttribute( 'url',
                 sprintf( '%sch%02d.html', $prepend_chapter, $index{$linkend}{'chapter_id'} )
                   . ( $index{$linkend}{'section_id'} ? '#' . $linkend : '' ) );


@@ -181,6 +214,79 @@ sub xref_fixup {
     }
 }
 
     }
 }
 

+## Build indexes
+sub build_indexes {
+    my ( $xml, $prepend_chapter, $xref ) = @_;
+
+    my $index_hash = {};
+    my $current_id;
+    foreach my $node ( $xml->findnodes('//section | //chapter | //indexterm') ) {
+        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 $secondary = $node->findvalue('child::secondary') || '';
+            next unless ( $primary || $secondary );                                               # skip blank entries for now...
+            $index_hash->{$role}{$first}{$primary}{$secondary} ||= [];
+            push @{ $index_hash->{$role}{$first}{$primary}{$secondary} }, $current_id;
+        }
+        else {
+            $current_id = $node->getAttribute('id');
+        }
+    }
+
+    # now we build a set of new chapters with the index data in
+    my $book = ( $xml->findnodes('/book') )[0];
+    foreach my $role ( sort { $a cmp $b } keys %{$index_hash} ) {
+        my $chapter = XML::LibXML::Element->new('chapter');
+        $book->appendChild($chapter);
+        $chapter->setAttribute( 'id', join( '_', 'index', $role ) );
+        $chapter->setAttribute( 'class', 'index' );
+        $chapter->appendTextChild( 'title', ( ucfirst($role) . ' Index' ) );
+        foreach my $first ( sort { $a cmp $b } keys %{ $index_hash->{$role} } ) {
+            my $section = XML::LibXML::Element->new('section');
+            my $list    = XML::LibXML::Element->new('variablelist');
+            $chapter->appendChild($section);
+            $section->setAttribute( 'id', join( '_', 'index', $role, $first ) );
+            $section->setAttribute( 'class', 'index' );
+            $section->appendTextChild( 'title', $first ? $first : 'Symbols' );
+            $section->appendChild($list);
+            foreach my $primary ( sort { $a cmp $b } keys %{ $index_hash->{$role}{$first} } ) {
+                my $entry = XML::LibXML::Element->new('varlistentry');
+                my $item  = XML::LibXML::Element->new('listitem');
+                $list->appendChild($entry)->appendTextChild( 'term', $primary );
+                $entry->appendChild($item);
+                my $slist;
+                foreach my $secondary ( sort { $a cmp $b } keys %{ $index_hash->{$role}{$first}{$primary} } ) {
+                    my $para = XML::LibXML::Element->new('para');
+                    if ( $secondary eq '' ) {
+                        $item->appendChild($para);    # skip having extra layer of heirarchy
+                    }
+                    else {
+                        unless ($slist) {
+                            $slist = XML::LibXML::Element->new('variablelist');
+                            $item->appendChild($slist);
+                        }
+                        my $sentry = XML::LibXML::Element->new('varlistentry');
+                        my $sitem  = XML::LibXML::Element->new('listitem');
+                        $slist->appendChild($sentry)->appendTextChild( 'term', $secondary );
+                        $sentry->appendChild($sitem)->appendChild($para);
+                    }
+                    my $count = 0;
+                    foreach my $ref ( @{ $index_hash->{$role}{$first}{$primary}{$secondary} } ) {
+                        $para->appendText(', ')
+                          if ( $count++ );
+                        my $xrefel = XML::LibXML::Element->new('xref');
+                        $xrefel->setAttribute( linkend => $ref );
+                        $xrefel->setAttribute( longref => 1 );
+                        $para->appendChild($xrefel);
+                    }
+                }
+            }
+        }
+    }
+}
+

 ## Handle the transformation
 sub transform {
     my ( $xml, $xsl_path, $out_path ) = @_;
 ## Handle the transformation
 sub transform {
     my ( $xml, $xsl_path, $out_path ) = @_;


@@ -207,7 +313,7 @@ sub transform {
     mkdirp( ( $out_path =~ /^(.+)\/.+$/ )[0] );
 
     ## Write out the document
     mkdirp( ( $out_path =~ /^(.+)\/.+$/ )[0] );
 
     ## 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;
 }


@@ -226,107 +332,151 @@ sub mkdirp {
     }
 }
 
     }
 }
 

+## error_help
+sub error_help {
+    my $msg = shift;
+
+    warn $msg;
+    pod2usage( -exitval => 1, -verbose => 0 );
+}
+

 ## Parse arguments
 sub parse_arguments {
 ## Parse arguments
 sub parse_arguments {

-    my %opt = ();
+
+    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 );

 
     ## --help
 
     ## --help

-    help(0) if int(@ARGV) == 0 || grep( /^--help|-h$/, @ARGV );
+    pod2usage(0) if ( $opt{help} );
+    pod2usage( -verbose => 2 ) if ( $opt{man} );

 
 

-    my @collection = @ARGV;
-    while (@collection) {
-        my $key = shift @collection;
+    ## --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} } ];
+    }
+    ## --latest
+    error_help('Missing value for latest') unless ( exists( $opt{latest} ) && defined( $opt{latest} ) );
+    error_help('Invalid value for latest') unless $opt{latest} =~ /^\d+(?:\.\d+)*$/;
+
+    ## --tmpl and --docroot
+    foreach my $set (qw[tmpl docroot]) {
+        error_help( 'Missing value for ' . $set ) unless ( exists( $opt{$set} ) && defined( $opt{$set} ) );
+        my $f = File::Spec->rel2abs( $opt{$set} );
+        error_help( 'No such directory: ' . $opt{$set} ) unless -d $f;
+        $opt{$set} = $f;
+    }
+    error_help('Excess arguments') if ( scalar(@ARGV) );

 
 

-        if ( $key eq '--web' ) {
+    error_help('Must include at least one of --web, --spec or --filter')
+      unless ( defined $opt{web} || scalar( @{ $opt{spec} } ) || scalar( @{ $opt{web} } ) );

 
 

-            ## --web
-            $opt{web} = 1;
-        }
-        elsif ( $key =~ /^--(spec|filter)$/ ) {
+    return %opt;
+}

 
 

-            ## --spec and --filter
-            my $continue = 1;
-            while ( $continue && @collection ) {
-                my $value = shift @collection;
+1;

 
 

-                if ( $value =~ /^--/ ) {
-                    unshift @collection, $value;
-                    $continue = 0;
-                }
-                else {
-                    $value = File::Spec->rel2abs($value);
-                    help( 1, 'No such file: ' . $value ) unless -f $value;
-                    push @{ $opt{$1} }, $value unless grep( $_ eq $value, @{ $opt{$1} } );
-                }
-            }
-            help( 1, 'Missing value for ' . $key ) unless exists $opt{$1};
-        }
-        elsif ( $key eq '--latest' ) {
+__END__

 
 

-            ## --latest
-            my $value = shift @collection;
-            help( 1, 'Missing value for ' . $key ) unless defined $value;
-            help( 1, 'Invalid value for ' . $key ) unless $value =~ /^\d+(?:\.\d+)*$/;
-            $opt{latest} = $value;
-        }
-        elsif ( $key =~ /^--(tmpl|docroot)$/ ) {
-
-            ## --tmpl and --docroot
-            my $value = shift @collection;
-            help( 1, 'Missing value for ' . $key ) unless defined $value;
-            $value = File::Spec->rel2abs($value);
-            help( 1, 'No such directory: ' . $value ) unless -d $value;
-            $opt{$1} = $value;
-            $opt{$1} =~ s#/+$##;
-        }
-        else {
-            help( 1, 'Bad argument: ' . $key );
-        }
-    }
+=head1 NAME

 
 

-    help( 1, 'Must include at least one of --web, --spec or --filter' )
-      unless exists $opt{web} || exists $opt{spec} || exists $opt{filter};
-    foreach (qw( latest tmpl docroot )) {
-        help( 1, 'Missing argument: --' . $_ ) unless exists $opt{$_};
-    }
+gen.pl - Generate exim html documentation and website

 
 

-    return %opt;
-}
+=head1 SYNOPSIS

 
 

-## Help information
-sub help {
-    my ( $exit_code, $msg ) = @_;
+gen.pl [options]

 
 

-    print "$msg\n\n" if defined $msg;
+ Options:
+   --help              display this help and exits
+   --man               displays man page
+   --spec file...      spec docbook/XML source files
+   --filter file...    filter docbook/XML source files
+   --web               Generate the general website pages
+   --latest VERSION    Required. Specify the latest stable version of Exim.
+   --tmpl PATH         Required. Path to the templates directory
+   --docroot PATH      Required. Path to the website document root
+   --[no-]minify       [Don't] minify CSS and Javascript    

 
 

-    print << "END_HELP";
-Options:
-   --help or -h  : Print this help information and then exit
+=head1 OPTIONS

 
 

-   --web         : Generate the general website pages
-   --spec PATH   : Generate the spec pages. PATH is the path to the spec.xml
-   --filter PATH : Generate the filter pages. PATH is the path to the filter.xml
+=over 4

 
 

-   One or more of the above three options are required. --spec and --filter can
-   take multiple values to generate different sets of documentation for
-   different versions at the same time.
+=item B<--help>

 
 

-   --latest VERSION : Required. Specify the latest stable version of Exim.
-   --tmpl PATH      : Required. Path to the templates directory
-   --docroot PATH   : Required. Path to the website document root
+Display help and exits

 
 

-   If CSS::Minifier::XS is installed, then CSS will be minified.
-   If JavaScript::Minifier::XS is installed, then JavaScript will be minified.
+=item B<--man>

 
 

-Example:
+Display man page

 
 

-   ./gen.pl --latest 4.72
-            --web
-            --spec spec.xml 4.71/spec.xml
-            --filter filter.xml 4.71/filter.xml
-            --tmpl ~/www/templates
-            --docroot ~/www/docroot
-END_HELP
+=item B<--spec> I<file...>
+
+List of files that make up the specification documentation
+docbook/XML source files.
+
+=item B<--filter> I<file...>
+
+List of files that make up the filter documentation docbook/XML
+source files.
+
+=item B<--web>
+
+Generate the website from the template files.
+
+=item B<--latest> I<version>
+
+Specify the current exim version. This is used to create links to
+the current documentation.
+
+This option is I<required>
+
+=item B<--tmpl> I<directory>
+
+Specify the directory that the templates are kept in.
+
+This option is I<required>
+
+=item B<--docroot> I<directory>
+
+Specify the directory that the output should be generated into.
+This is the website C<docroot> directory.
+
+This option is I<required>
+
+=item B<--minify>
+
+If this option is set then both the CSS and Javascript files
+processed are minified using L<CSS::Minifier::XS> and
+L<JavaScript::Minifier::XS> respectively.
+
+This option is set by default - to disable it specify C<--no-minify>
+
+=back
+
+=head1 DESCRIPTION
+
+Generates the exim website and HTML documentation.
+
+=head1 EXAMPLE
+
+    script/gen.pl \
+      --web \
+      --spec docbook/*/spec.xml \
+      --filter  docbook/*/filter.xml \
+      --latest 4.72 \
+      --tmpl templates \
+      --docroot /tmp/website
+
+=head1 AUTHOR
+
+Mike Cardwell
+
+Nigel Metheringham <nigel@exim.org> - mostly broke the framework
+Mike produced.
+
+=head1 COPYRIGHT
+
+Copyright 2010 Exim Maintainers. All rights reserved.
+
+=cut

 
 

-    exit($exit_code);
-}