git://git.exim.org / exim-website.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Move static files into separate staticroot directory
[exim-website.git] / script / gen.pl
diff --git a/script/gen.pl b/script/gen.pl
index 9667a7cbdd8d0ea05bae78e6f3bfa1d830814e6f..6febf7f5725c54f40a6e290123ea2307ea0c258f 100755 (executable)
--- a/script/gen.pl
+++ b/script/gen.pl
@@ -20,73 +20,107 @@ my $canonical_url = 'http://www.exim.org/';
 ## Parse arguments
 my %opt = parse_arguments();
 
 ## Parse arguments
 my %opt = parse_arguments();
 
+## setup static root location
+## TODO: for doc generation only this should be within the docs dir
+$opt{staticroot} = File::Spec->catdir( $opt{docroot}, 'static' );
+
 ## Generate the pages
 ## Generate the pages
+my %cache;    # General cache object
 do_doc( 'spec',   $_ ) foreach @{ $opt{spec}   || [] };
 do_doc( 'filter', $_ ) foreach @{ $opt{filter} || [] };
 do_doc( 'spec',   $_ ) foreach @{ $opt{spec}   || [] };
 do_doc( 'filter', $_ ) foreach @{ $opt{filter} || [] };
-do_web() if exists $opt{web};
+do_web() if ( $opt{web} );
+do_static();    # need this for all other pages generated
 
 ## Add the exim-html-current symlink
 
 ## Add the exim-html-current symlink
-print "Symlinking exim-html-current to exim-html-$opt{latest}\n";
+print "Symlinking exim-html-current to exim-html-$opt{latest}\n" if ( $opt{verbose} );
 unlink("$opt{docroot}/exim-html-current") if ( -l "$opt{docroot}/exim-html-current" );
 symlink( "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";
+    || die "symlink to $opt{docroot}/exim-html-current failed";
 
 
+# ------------------------------------------------------------------
 ## Generate the website files
 sub do_web {
 
 ## Generate the website files
 sub do_web {
 
+    ## copy these templates to docroot...
+    copy_transform_files( "$opt{tmpl}/web", $opt{docroot}, 0 );
+}
+
+# ------------------------------------------------------------------
+## Generate the static file set
+sub do_static {
+
+    ## make sure I have a directory
+    mkdir( $opt{staticroot} ) or die "Unable to make staticroot: $!\n" unless ( -d $opt{staticroot} );
+
+    ## copy these templates to docroot...
+    copy_transform_files( "$opt{tmpl}/static", $opt{staticroot}, 1 );
+}
+
+# ------------------------------------------------------------------
+## Generate the website files
+sub copy_transform_files {
+    my $source = shift;
+    my $target = shift;
+    my $static = shift;
+
     ## Make sure the template web directory exists
     ## Make sure the template web directory exists
-    die "No such directory: $opt{tmpl}/web\n" unless -d "$opt{tmpl}/web";
+    die "No such directory: $source\n" unless ( -d $source );
 
     ## 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("$source"), length($File::Find::name) ) =~ m#^/*(.*)$#;
 
 
-            if ( -d "$opt{tmpl}/web/$path" ) {
+            if ( -d "$source/$path" ) {
 
 
-                ## Create the directory in the doc root if it doesn't exist
-                if ( !-d "$opt{docroot}/$path" ) {
-                    mkdir("$opt{docroot}/$path") or die "Unable to make $opt{docroot}/$path: $!\n";
+                ## Create the directory in the target if it doesn't exist
+                if ( !-d "$target/$path" ) {
+                    mkdir("$target/$path") or die "Unable to make $target/$path: $!\n";
                 }
 
             }
             else {
 
                 ## Build HTML from XSL files and simply copy static files which have changed
                 }
 
             }
             else {
 
                 ## Build HTML from XSL files and simply copy static files which have changed
-                if ( $path =~ /(.+)\.xsl$/ ) {
-                    print "Generating  : docroot:/$1.html\n" if ($opt{verbose});
-                    transform( undef, "$opt{tmpl}/web/$path", "$opt{docroot}/$1.html" );
+                if ( ( !$static ) and ( $path =~ /(.+)\.xsl$/ ) ) {
+                    print "Generating  : /$1.html\n" if ( $opt{verbose} );
+                    transform( undef, "$source/$path", "$target/$1.html" );
                 }
                 }
-                elsif ( -f "$opt{tmpl}/web/$path" ) {
+                elsif ( -f "$source/$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];
+                    ## Skip if the file hasn't changed (mtime/size based)
+                    return
+                        if (( -f "$target/$path" )
+                        and ( ( stat("$source/$path") )[9] == ( stat("$target/$path") )[9] )
+                        and ( ( stat("$source/$path") )[7] == ( stat("$target/$path") )[7] ) );
 
                     if ( $path =~ /(.+)\.css$/ ) {
 
                     if ( $path =~ /(.+)\.css$/ ) {
-                        print "CSS to  : docroot:/$path\n" if ($opt{verbose});
-                        my $content = read_file("$opt{tmpl}/web/$path");
-                        write_file( "$opt{docroot}/$path", $opt{minify} ? CSS::Minifier::XS::minify($content) : $content );
+                        print "CSS to  : /$path\n" if ( $opt{verbose} );
+                        my $content = read_file("$source/$path");
+                        write_file( "$target/$path", $opt{minify} ? CSS::Minifier::XS::minify($content) : $content );
                     }
                     elsif ( $path =~ /(.+)\.js$/ ) {
                     }
                     elsif ( $path =~ /(.+)\.js$/ ) {
-                        print "JS to  : docroot:/$path\n" if ($opt{verbose});
-                        my $content = read_file("$opt{tmpl}/web/$path");
-                        write_file( "$opt{docroot}/$path", $opt{minify} ? JavaScript::Minifier::XS::minify($content) : $content );
+                        print "JS to  : /$path\n" if ( $opt{verbose} );
+                        my $content = read_file("$source/$path");
+                        write_file( "$target/$path",
+                            $opt{minify} ? JavaScript::Minifier::XS::minify($content) : $content );
                     }
                     else {
                         ## Copy
                     }
                     else {
                         ## Copy
-                        print "Copying to  : docroot:/$path\n" if ($opt{verbose});
-                        copy( "$opt{tmpl}/web/$path", "$opt{docroot}/$path" ) or die "$path: $!";
+                        print "Copying to  : /$path\n" if ( $opt{verbose} );
+                        copy( "$source/$path", "$target/$path" ) or die "$path: $!";
                     }
                     ## Set mtime
                     }
                     ## Set mtime
-                    utime( time, ( stat("$opt{tmpl}/web/$path") )[9], "$opt{docroot}/$path" );
+                    utime( time, ( stat("$source/$path") )[9], "$target/$path" );
                 }
             }
 
         },
                 }
             }
 
         },
-        "$opt{tmpl}/web"
+        "$source"
     );
 }
 
     );
 }
 
+# ------------------------------------------------------------------
 ## Generate index/chapter files for a doc
 sub do_doc {
     my ( $type, $xml_path ) = @_;
 ## Generate index/chapter files for a doc
 sub do_doc {
     my ( $type, $xml_path ) = @_;
@@ -103,29 +137,38 @@ 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" );
 
         "${canonical_url}exim-html-current/doc/html/spec_html/" . ( $type eq 'spec' ? 'index' : 'filter' ) . ".html" );
 
+    ## Add a url for the latest version of this document
+    if ( $version ne $opt{latest} ) {
+        $xml->documentElement()
+            ->appendTextChild( 'current_url',
+            "../../../../exim-html-current/doc/html/spec_html/" . ( $type eq 'spec' ? 'index' : 'filter' ) . ".html" );
+    }
+
     ## Fixup the XML
     xref_fixup( $xml, $prepend_chapter );
 
     ## Generate the front page
     {
         my $path = "exim-html-$version/doc/html/spec_html/" . ( $type eq 'filter' ? $type : 'index' ) . ".html";
     ## Fixup the XML
     xref_fixup( $xml, $prepend_chapter );
 
     ## Generate the front page
     {
         my $path = "exim-html-$version/doc/html/spec_html/" . ( $type eq 'filter' ? $type : 'index' ) . ".html";
-        print "Generating  : docroot:/$path\n";
+        print "Generating  : docroot:/$path\n" if ( $opt{verbose} );
         transform( $xml, "$opt{tmpl}/doc/index.xsl", "$opt{docroot}/$path", );
     }
 
     ## Generate a Table of Contents XML file
     {
         transform( $xml, "$opt{tmpl}/doc/index.xsl", "$opt{docroot}/$path", );
     }
 
     ## 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" if ($opt{verbose});
+        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 );
@@ -135,12 +178,28 @@ 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( 'toc_url', ( $type eq 'filter' ? 'filter' : 'index' ) . '.html' );
+            $chapter->appendTextChild(
+                'canonical_url',
+                sprintf(
+                    'http://www.exim.org/exim-html-current/doc/html/spec_html/%sch%02d.html',
+                    $prepend_chapter, $counter
+                )
+            );
+            if ( $version ne $opt{latest} ) {
+                $chapter->appendTextChild(
+                    'current_url',
+                    sprintf(
+                        '../../../../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
@@ -150,12 +209,13 @@ 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" if ($opt{verbose});
+            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", );
         }
     }
 }
 
+# ------------------------------------------------------------------
 ## Fixup xref tags
 sub xref_fixup {
     my ( $xml, $prepend_chapter ) = @_;
 ## Fixup xref tags
 sub xref_fixup {
     my ( $xml, $prepend_chapter ) = @_;
@@ -208,15 +268,17 @@ 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 : '' ) );
         }
     }
 }
 
         }
     }
 }
 
+# ------------------------------------------------------------------
 ## Build indexes
 sub build_indexes {
     my ( $xml, $prepend_chapter, $xref ) = @_;
 ## Build indexes
 sub build_indexes {
     my ( $xml, $prepend_chapter, $xref ) = @_;
@@ -227,9 +289,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;
         }
@@ -278,7 +340,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 );
@@ -290,6 +352,7 @@ sub build_indexes {
     }
 }
 
     }
 }
 
+# ------------------------------------------------------------------
 ## Handle the transformation
 sub transform {
     my ( $xml, $xsl_path, $out_path ) = @_;
 ## Handle the transformation
 sub transform {
     my ( $xml, $xsl_path, $out_path ) = @_;
@@ -303,17 +366,24 @@ sub transform {
     ## Add the current version of Exim to the XML
     $xml->documentElement()->appendTextChild( 'current_version', $opt{latest} );
 
     ## Add the current version of Exim to the XML
     $xml->documentElement()->appendTextChild( 'current_version', $opt{latest} );
 
+    ## Add the old versions of Exim to the XML
+    $xml->documentElement()->appendTextChild( 'old_versions', $_ ) foreach old_docs_versions();
+
     ## Parse the ".xsl" file as XML
     my $xsl = XML::LibXML->new()->parse_file($xsl_path) or die $!;
 
     ## Generate a stylesheet from the ".xsl" XML.
     my $stylesheet = XML::LibXSLT->new()->parse_stylesheet($xsl);
 
     ## Parse the ".xsl" file as XML
     my $xsl = XML::LibXML->new()->parse_file($xsl_path) or die $!;
 
     ## Generate a stylesheet from the ".xsl" XML.
     my $stylesheet = XML::LibXSLT->new()->parse_stylesheet($xsl);
 
+    ## work out the static root relative to the target
+    my $target_dir = ( File::Spec->splitpath($out_path) )[1];
+    my $staticroot = File::Spec->abs2rel( $opt{staticroot}, $target_dir );
+
     ## Generate a doc from the XML transformed with the XSL
     ## Generate a doc from the XML transformed with the XSL
-    my $doc = $stylesheet->transform($xml);
+    my $doc = $stylesheet->transform( $xml, staticroot => sprintf( "'%s'", $staticroot ) );
 
     ## Make the containing directory if it doesn't exist
 
     ## Make the containing directory if it doesn't exist
-    make_path( ( $out_path =~ /^(.+)\/.+$/ )[0], { verbose => 1 } );
+    make_path( ( $out_path =~ /^(.+)\/.+$/ )[0], { verbose => $opt{verbose} } );
 
     ## Write out the document
     open my $out, '>', $out_path or die "Unable to write $out_path - $!";
 
     ## Write out the document
     open my $out, '>', $out_path or die "Unable to write $out_path - $!";
@@ -321,6 +391,20 @@ sub transform {
     close $out;
 }
 
     close $out;
 }
 
+# ------------------------------------------------------------------
+## Look in the docroot for old versions of the documentation
+sub old_docs_versions {
+    if ( !exists $cache{old_docs_versions} ) {
+        my @versions;
+        foreach ( glob("$opt{docroot}/exim-html-*") ) {
+            push @versions, $1 if /-(\d+(?:\.\d+)?)$/ && $1 < $opt{latest} && -d $_;
+        }
+        $cache{old_docs_versions} = [ reverse sort { $a <=> $b } @versions ];
+    }
+    return @{ $cache{old_docs_versions} };
+}
+
+# ------------------------------------------------------------------
 ## error_help
 sub error_help {
     my $msg = shift;
 ## error_help
 sub error_help {
     my $msg = shift;
@@ -329,12 +413,15 @@ sub error_help {
     pod2usage( -exitval => 1, -verbose => 0 );
 }
 
     pod2usage( -exitval => 1, -verbose => 0 );
 }
 
+# ------------------------------------------------------------------
 ## Parse arguments
 sub parse_arguments {
 
     my %opt = ( spec => [], filter => [], help => 0, man => 0, web => 0, minify => 1, verbose => 0 );
 ## Parse arguments
 sub parse_arguments {
 
     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 );
+    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} );
@@ -342,7 +429,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} ) );
@@ -358,11 +447,12 @@ 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 ( $opt{web} || scalar( @{ $opt{spec} || [] } ) || scalar( @{ $opt{filter} || [] } ) );
+        unless ( $opt{web} || scalar( @{ $opt{spec} || [] } ) || scalar( @{ $opt{filter} || [] } ) );
 
     return %opt;
 }
 
 
     return %opt;
 }
 
+# ------------------------------------------------------------------
 1;
 
 __END__
 1;
 
 __END__
@@ -465,7 +555,6 @@ Mike produced.
 
 =head1 COPYRIGHT
 
 
 =head1 COPYRIGHT
 
-Copyright 2010 Exim Maintainers. All rights reserved.
+Copyright 2010-2012 Exim Maintainers. All rights reserved.
 
 =cut
 
 =cut
-
Exim website sources and generation scripts