[exim.git] / release-process / scripts / mk_exim_release.pl

#!/usr/bin/env perl
# Copyright (c) The Exim Maintainers 2016

use strict;
use warnings;
use Carp;
use File::Copy;
use File::Spec;
use File::Path;
use File::Temp;
use FindBin;
use Getopt::Long;
use IO::File;
use Pod::Usage;

my $debug   = 0;
my $verbose = 0;

# ------------------------------------------------------------------

sub get_and_check_version {
    my $release = shift;
    my $context = shift;

    # make sure this looks like a real release version
    # which should (currently) be 4.xx[.y] or 4.xx[.y]_RCx
    unless ( $release =~ /^(?<release>(?<major>4\.\d\d)(?:\.(?<minor>\d+))?(?:_RC\d+)?)$/ ) {
        croak "The given version number does not look right - $release";
    }
    $context->{release}  = $+{release};
    $context->{major} = $+{major};
    $context->{minor} = $+{minor};

    ($context->{trelease} = $+{release}) =~ s/_RC\d+//;
}

# ------------------------------------------------------------------

sub build_tag {
    my $context = shift;

    # The CVS tag consists of exim-$version where $version
    # is the version number with . replaced with _
    my $modversion = $context->{release};
    $modversion =~ tr/0-9RC/_/cs;

    return sprintf( 'exim-%s', $modversion );
}

# ------------------------------------------------------------------

sub deal_with_working_directory {
    my $context = shift;
    my $delete  = shift;

    # Set default directory
    $context->{directory} ||= File::Spec->rel2abs( sprintf( 'exim-packaging-%s', $context->{release} ) );
    my $directory = $context->{directory};

    # ensure the working directory is not in place
    if ( -d $directory ) {
        if ($delete) {
            print "Deleting existing $directory\n" if ($verbose);
            rmtree( $directory, { verbose => $debug } );
        }
        if ( -d $directory ) {
            croak "Working directory $directory exists";
        }
    }

    # create base directory
    mkpath( $context->{directory}, { verbose => ( $verbose || $debug ) } );

    # set and create subdirectories
    foreach (qw(release_tree pkgs pkgdirs docbook tmp)) {
        $context->{$_} = File::Spec->catdir( $context->{directory}, $_ );
        mkpath( $context->{$_}, { verbose => ( $verbose || $debug ) } );
    }
}

# ------------------------------------------------------------------

sub export_git_tree {
    my $context = shift;

    # build git command
    my $archive_file = sprintf( '%s/%s-%s.tar', $context->{tmp}, $context->{pkgname}, $context->{release} );
    $context->{tmp_archive_file} = $archive_file;
    my @cmd = ( 'git', 'archive', '--format=tar', "--output=$archive_file", $context->{tag} );
    # run git command
    print( "Running: ", join( ' ', @cmd ), "\n" ) if ($verbose);
    system(@cmd) == 0 || croak "Export failed";
}

# ------------------------------------------------------------------

sub unpack_tree {
    my $context = shift;

    die "Cannot see archive file\n" unless ( -f $context->{tmp_archive_file} );
    my @cmd = ( 'tar', 'xf', $context->{tmp_archive_file}, '-C', $context->{release_tree} );

    # run  command
    print( "Running: ", join( ' ', @cmd ), "\n" ) if ($verbose);
    system(@cmd) == 0 || croak "Unpack failed";
}

# ------------------------------------------------------------------

sub make_version_script {
    my $context = shift;

    my $variant = substr( $context->{release}, length($context->{trelease}) );
    if ( $context->{release} ne $context->{trelease} . $variant ) {
        die "Broken version numbering, I'm buggy";
    }

    my $srcdir    = File::Spec->catdir( $context->{release_tree}, 'src', 'src' );
    chdir $srcdir or die "chdir $srcdir: $!\n";

    if ( -f "version.sh" ) {
        print( "WARNING: version.sh already exists - leaving it in place\n" );
        return;
    }

    # Currently (25. Feb. 2016) the mk_exim_release.pl up to now can't
    # deal with security releases.!? So we need a current
    # mk_exim_release.pl. But if we use a current (master), the
    # reversion script returns wrong version info (it's running inside
    # the Git tree and uses git --describe, which always returns the
    # current version of master.) I do not want to change the old
    # reversion scripts (in 4.86.1, 4.85.1).
    #
    # Thus we've to provide the version.sh, based on the info we have
    # about the release. If reversion finds this, it doesn't try to find
    # it's own way to get a valid version number from the git.
    open(my $v, '>', 'version.sh') or die "Can't open '>version.sh' $!\n";
    print {$v} <<__;
# initial version automatically generated from $0
EXIM_RELEASE_VERSION=$context->{major}
EXIM_VARIANT_VERSION=@{[$context->{minor}?'_'.$context->{minor}:'']}
EXIM_COMPILE_NUMBER=0
__
    close($v);
    unlink 'version.h';
    return;

    # Later, if we get the reversion script fixed, we can call it again.
    # For now (25. Feb. 2016) we'll leave it unused.
    my @cmd = ("../scripts/reversion", "release", $context->{tag});
    print( "Running: ", join( ' ', @cmd ), "\n" ) if ($verbose);
    system(@cmd) == 0 || croak "reversion failed";

    unlink "version.h";

    -f "version.sh" or die "failed to create version.sh";
}

# ------------------------------------------------------------------

sub build_html_documentation {
    my $context = shift;

    my $genpath   = $context->{webgen_base} . '/script/gen.pl';
    my $templates = $context->{webgen_base} . '/templates';
    my $dir       = File::Spec->catdir( $context->{release_tree}, 'html' );
    my $spec      = File::Spec->catfile( $context->{docbook}, 'spec.xml' );
    my $filter    = File::Spec->catfile( $context->{docbook}, 'filter.xml' );

    mkdir($dir);

    my @cmd = (
        $genpath,   '--spec',    $spec,                '--filter',
        $filter,    '--latest',  $context->{trelease}, '--tmpl',
        $templates, '--docroot', $dir,                 '--localstatic'
    );
    push @cmd, '--verbose' if $verbose or $debug;

    print "Executing ", join( ' ', @cmd ), "\n";
    system(@cmd);

    # move directory into right place
    my $sourcedir = File::Spec->catdir( $context->{docbook}, 'filter.xml' );

    rename(
        File::Spec->catdir( $dir,                sprintf( 'exim-html-%s', $context->{trelease} ) ),
        File::Spec->catdir( $context->{pkgdirs}, sprintf( 'exim-html-%s', $context->{release} ) )
    );
}

# ------------------------------------------------------------------

sub copy_docbook_files {
    my $context = shift;

    # where the generated docbook files can be found
    my $docdir = File::Spec->catdir( $context->{release_tree}, 'doc', 'doc-docbook' );

    # where the website docbook source dir is - push files to here
    my $webdir = File::Spec->catdir( $context->{webgen_base}, 'docbook', $context->{trelease} );
    mkpath( $webdir, { verbose => ( $verbose || $debug ) } );

    foreach my $file ( 'spec.xml', 'filter.xml' ) {
        my $from  = File::Spec->catfile( $docdir,             $file );
        my $to    = File::Spec->catfile( $context->{docbook}, $file );
        my $webto = File::Spec->catfile( $webdir,             $file );
        copy( $from, $to );
        copy( $from, $webto );
    }
}

# ------------------------------------------------------------------

sub build_documentation {
    my $context = shift;

    my $docdir = File::Spec->catdir( $context->{release_tree}, 'doc', 'doc-docbook' );
    # documentation building gets the truncated release, without RC
    system("cd '$docdir' && ./OS-Fixups && $context->{make_cmd} EXIM_VER=$context->{trelease} everything") == 0
      || croak "Doc build failed";

    copy_docbook_files($context);
    build_html_documentation($context);
}

# ------------------------------------------------------------------

sub move_text_docs_into_pkg {
    my $context = shift;

    my $old_docdir = File::Spec->catdir( $context->{release_tree}, 'doc', 'doc-docbook' );
    my $old_txtdir = File::Spec->catdir( $context->{release_tree}, 'doc', 'doc-txt' );
    my $new_docdir = File::Spec->catdir( $context->{eximpkgdir}, 'doc' );
    mkpath( $new_docdir, { verbose => ( $verbose || $debug ) } );

    # move generated documents from docbook stuff
    foreach my $file (qw/exim.8 spec.txt filter.txt/) {
        move( File::Spec->catfile( $old_docdir, $file ), File::Spec->catfile( $new_docdir, $file ) );
    }

    # move text documents across
    foreach my $file ( glob( File::Spec->catfile( $old_txtdir, '*' ) ) ) {

        # skip a few we dont want
        my $fn = ( File::Spec->splitpath($file) )[2];
        next
          if ( ( $fn eq 'ABOUT' )
            || ( $fn eq 'ChangeLog.0' )
            || ( $fn eq 'test-harness.txt' )
            # Debian issue re licensing of RFCs
            || ( $fn =~ /^draft-ietf-.*/ )
            || ( $fn =~ /^rfc.*/ )
             );
        move( $file, File::Spec->catfile( $new_docdir, $fn ) );
    }
}

# ------------------------------------------------------------------

sub build_pspdfinfo_directory {
    my $context = shift;

    ##foreach my $format (qw/pdf postscript texinfo info/) {
    foreach my $format (qw/pdf postscript/) {
        my $target = File::Spec->catdir( $context->{pkgdirs}, sprintf( 'exim-%s-%s', $format, $context->{release} ), 'doc' );
        mkpath( $target, { verbose => ( $verbose || $debug ) } );

        # move documents across
        foreach my $file (
            glob(
                File::Spec->catfile(
                    $context->{release_tree},
                    'doc',
                    'doc-docbook',
                    (
                        ( $format eq 'postscript' )
                        ? '*.ps'
                        : ( '*.' . $format )
                    )
                )
            )
          )
        {
            move( $file, File::Spec->catfile( $target, ( File::Spec->splitpath($file) )[2] ) );
        }
    }
}

# ------------------------------------------------------------------

sub build_main_package_directory {
    my $context = shift;

    # build the exim package directory path
    $context->{eximpkgdir} = File::Spec->catdir( $context->{pkgdirs}, sprintf( 'exim-%s', $context->{release} ) );

    # initially we move the exim-src directory to the new directory name
    rename( File::Spec->catdir( $context->{release_tree}, 'src' ), $context->{eximpkgdir} )
      || croak "Rename of src dir failed - $!";

    # add Local subdirectory
    mkpath( File::Spec->catdir( $context->{eximpkgdir}, 'Local' ), { verbose => ( $verbose || $debug ) } );

    # now add the text docs
    move_text_docs_into_pkg($context);
}

# ------------------------------------------------------------------

sub build_package_directories {
    my $context = shift;

    build_main_package_directory($context);
    build_pspdfinfo_directory($context) if $context->{build_docs};
}

# ------------------------------------------------------------------

sub do_cleanup {
    my $context = shift;

    print "Cleaning up\n" if ($verbose);
    chdir( $context->{directory} ) || die;
    rmtree( $context->{release_tree}, { verbose => $debug } );
    rmtree( $context->{docbook},      { verbose => $debug } );
    rmtree( $context->{pkgdirs},      { verbose => $debug } );
}

# ------------------------------------------------------------------

# We prefer gtar to tar if gtar exists in $PATH

sub fix_paths_tar {
    my $context = shift;
    my $tar = $context->{tar_cmd};

    return unless $tar eq 'tar';

    foreach my $d (File::Spec->path()) {
        my $p = File::Spec->catfile($d, 'gtar');
        if (-x $p) {
            $context->{tar_cmd} = $p;
            print "Switched tar command to: $p\n" if ($verbose);
            return;
        }
    }
}

# ------------------------------------------------------------------

sub create_tar_files {
    my $context = shift;

    my $pkgs    = $context->{pkgs};
    my $pkgdirs = $context->{pkgdirs};
    my $tar     = $context->{tar_cmd};
    if ($verbose) {
        foreach my $c (keys %{ $context->{compressors} }) {
            print "Compression: $c\t$context->{compressors}{$c}\n";
        }
    }

    foreach my $dir ( glob( File::Spec->catdir( $pkgdirs, ( 'exim*-' . $context->{release} ) ) ) ) {
        my $dirname = ( File::Spec->splitdir($dir) )[-1];
        if ($context->{compressors}{gzip}) {
            print "Creating: ${pkgs}/${dirname}.tar.gz\n" if ($verbose || $debug);
            system("$tar cf  ${pkgs}/${dirname}.tar.gz  --gzip  -C ${pkgdirs} ${dirname}")
        }
        if ($context->{compressors}{bzip2}) {
            print "Creating: ${pkgs}/${dirname}.tar.bz2\n" if ($verbose || $debug);
            system("$tar cf  ${pkgs}/${dirname}.tar.bz2 --bzip2 -C ${pkgdirs} ${dirname}")
        }
        if ($context->{compressors}{lzip}) {
            print "Creating: ${pkgs}/${dirname}.tar.lz\n" if ($verbose || $debug);
            system("$tar cf  ${pkgs}/${dirname}.tar.lz  --lzip  -C ${pkgdirs} ${dirname}")
        }
    }
}

# ------------------------------------------------------------------
{
    my $man;
    my $help;
    my $context = {
        pkgname     => 'exim',
        orig_dir    => File::Spec->curdir(),
        tmp_dir     => File::Temp->newdir(),
        webgen_base => "$FindBin::Bin/../../../exim-website",
        tar_cmd     => 'tar',
        make_cmd    => 'make',
        compressors => {
                gzip    => 1,
                bzip2   => 1,
                lzip    => 0,
        },
        build_docs   => 1,
    };
    my $delete;
    my $cleanup = 1;
    ##$ENV{'PATH'} = '/opt/local/bin:' . $ENV{'PATH'};

    unless (
        GetOptions(
            'directory=s'   => \$context->{directory},
            'webgen_base=s' => \$context->{webgen_base},
            'tar=s'         => \$context->{tar_cmd},
            'make=s'        => \$context->{make_cmd},
            'lzip!'         => \$context->{compressors}{lzip},
            'verbose!'      => \$verbose,
            'debug!'        => \$debug,
            'help|?'        => \$help,
            'man!'          => \$man,
            'delete!'       => \$delete,
            'cleanup!'      => \$cleanup,
            'build-docs!'   => \$context->{build_docs},
        )
      )
    {
        pod2usage( -exitval => 1, -verbose => 0 );
    }
    pod2usage(0) if $help;
    pod2usage( -verbose => 2 ) if $man;

    get_and_check_version( shift, $context );
    fix_paths_tar($context);
    $context->{tag} = build_tag($context);
    deal_with_working_directory( $context, $delete );
    export_git_tree($context);
    chdir( $context->{directory} ) || die;
    unpack_tree($context);
    make_version_script($context);
    build_documentation($context) if $context->{build_docs};
    build_package_directories($context);
    create_tar_files($context);
    do_cleanup($context) if ($cleanup);
}

1;

__END__

=head1 NAME

mk_exim_release.pl - Build an exim release

=head1 SYNOPSIS

mk_exim_release.pl [options] version

 Options:
   --debug             force debug mode
   --verbose           force verbose mode
   --help              display this help and exits
   --man               displays man page
   --tar=cmd           command to use for tar
   --make=cmd          command to use for make
   --directory=dir     dir to package
   --no-lzip           do not create .tar.lz files
   --delete            Delete packaging directory at start
   --noweb             skip the website generation

=head1 OPTIONS

=over 4

=item B<--debug>

Forces debug mode.

=item B<--tar>

Use to override the path to the tar command; without this, will search for
gtar, and if not found use tar.  Need GNU tar for lzip, unless --no-lzip is
used.

=item B<--make>

Use to override the path/name of the make command.
Useful sometimes to force gmake.

=item B<--lzip>

Build the lzip tarballs.

=item B<--verbose>

Force verbose mode

=item B<--help>

Display help and exits

=item B<--man>

Display man page

=back

=head1 DESCRIPTION

Builds an exim release.

Starting in a populated git repo that has already been tagged for
release, build docs, build packages etc.

Parameter is the version number to build as - ie 4.72 4.72RC1, 4.86.1, etc

=head1 AUTHOR

Nigel Metheringham <Nigel.Metheringham@dev.intechnology.co.uk>

=head1 COPYRIGHT

Copyright 2010 Exim Maintainers. All rights reserved.

=cut
# vim: set sw=4 et :
Commit	Line	Data
46c573de	1	#!/usr/bin/env perl
80fea873	2	# Copyright (c) The Exim Maintainers 2016
3634fc25	3
8a483da6 NM	4	use strict;
	5	use warnings;
	6	use Carp;
	7	use File::Copy;
	8	use File::Spec;
	9	use File::Path;
8f29c950	10	use File::Temp;
be914e6c	11	use FindBin;
8a483da6	12	use Getopt::Long;
ba41f854	13	use IO::File;
8a483da6 NM	14	use Pod::Usage;
	15
	16	my $debug = 0;
	17	my $verbose = 0;
	18
	19	# ------------------------------------------------------------------
	20
	21	sub get_and_check_version {
	22	my $release = shift;
be914e6c	23	my $context = shift;
8a483da6 NM	24
8a483da6 NM	25	# make sure this looks like a real release version
9677df8a HSHR	26	# which should (currently) be 4.xx[.y] or 4.xx[.y]_RCx
9677df8a HSHR	27	unless ( $release =~ /^(?<release>(?<major>4\.\d\d)(?:\.(?<minor>\d+))?(?:_RC\d+)?)$/ ) {
8a483da6 NM	28	croak "The given version number does not look right - $release";
8a483da6 NM	29	}
9677df8a HSHR	30	$context->{release} = $+{release};
	31	$context->{major} = $+{major};
	32	$context->{minor} = $+{minor};
be914e6c	33
9677df8a	34	($context->{trelease} = $+{release}) =~ s/_RC\d+//;
8a483da6 NM	35	}
	36
	37	# ------------------------------------------------------------------
	38
8f29c950	39	sub build_tag {
8a483da6 NM	40	my $context = shift;
	41
	42	# The CVS tag consists of exim-$version where $version
	43	# is the version number with . replaced with _
	44	my $modversion = $context->{release};
	45	$modversion =~ tr/0-9RC/_/cs;
	46
	47	return sprintf( 'exim-%s', $modversion );
	48	}
	49
	50	# ------------------------------------------------------------------
	51
	52	sub deal_with_working_directory {
	53	my $context = shift;
	54	my $delete = shift;
	55
	56	# Set default directory
	57	$context->{directory} \|\|= File::Spec->rel2abs( sprintf( 'exim-packaging-%s', $context->{release} ) );
	58	my $directory = $context->{directory};
	59
	60	# ensure the working directory is not in place
	61	if ( -d $directory ) {
	62	if ($delete) {
	63	print "Deleting existing $directory\n" if ($verbose);
	64	rmtree( $directory, { verbose => $debug } );
	65	}
	66	if ( -d $directory ) {
	67	croak "Working directory $directory exists";
	68	}
	69	}
	70
46c573de	71	# create base directory
8a483da6	72	mkpath( $context->{directory}, { verbose => ( $verbose \|\| $debug ) } );
46c573de NM	73
46c573de NM	74	# set and create subdirectories
5901f0ab	75	foreach (qw(release_tree pkgs pkgdirs docbook tmp)) {
46c573de NM	76	$context->{$_} = File::Spec->catdir( $context->{directory}, $_ );
	77	mkpath( $context->{$_}, { verbose => ( $verbose \|\| $debug ) } );
	78	}
8a483da6 NM	79	}
	80
	81	# ------------------------------------------------------------------
	82
8f29c950	83	sub export_git_tree {
8a483da6 NM	84	my $context = shift;
8a483da6 NM	85
8f29c950	86	# build git command
5901f0ab	87	my $archive_file = sprintf( '%s/%s-%s.tar', $context->{tmp}, $context->{pkgname}, $context->{release} );
8f29c950 NM	88	$context->{tmp_archive_file} = $archive_file;
8f29c950 NM	89	my @cmd = ( 'git', 'archive', '--format=tar', "--output=$archive_file", $context->{tag} );
8f29c950	90	# run git command
8a483da6 NM	91	print( "Running: ", join( ' ', @cmd ), "\n" ) if ($verbose);
	92	system(@cmd) == 0 \|\| croak "Export failed";
	93	}
	94
	95	# ------------------------------------------------------------------
	96
8f29c950 NM	97	sub unpack_tree {
	98	my $context = shift;
	99
	100	die "Cannot see archive file\n" unless ( -f $context->{tmp_archive_file} );
46c573de	101	my @cmd = ( 'tar', 'xf', $context->{tmp_archive_file}, '-C', $context->{release_tree} );
8f29c950 NM	102
	103	# run command
	104	print( "Running: ", join( ' ', @cmd ), "\n" ) if ($verbose);
	105	system(@cmd) == 0 \|\| croak "Unpack failed";
	106	}
	107
	108	# ------------------------------------------------------------------
	109
5901f0ab	110	sub make_version_script {
ba41f854 PP	111	my $context = shift;
ba41f854 PP	112
ba41f854 PP	113	my $variant = substr( $context->{release}, length($context->{trelease}) );
	114	if ( $context->{release} ne $context->{trelease} . $variant ) {
	115	die "Broken version numbering, I'm buggy";
	116	}
5901f0ab	117
ba41f854	118	my $srcdir = File::Spec->catdir( $context->{release_tree}, 'src', 'src' );
3ec6ea71	119	chdir $srcdir or die "chdir $srcdir: $!\n";
5901f0ab TF	120
	121	if ( -f "version.sh" ) {
	122	print( "WARNING: version.sh already exists - leaving it in place\n" );
ba41f854 PP	123	return;
	124	}
	125
9677df8a HSHR	126	# Currently (25. Feb. 2016) the mk_exim_release.pl up to now can't
	127	# deal with security releases.!? So we need a current
	128	# mk_exim_release.pl. But if we use a current (master), the
	129	# reversion script returns wrong version info (it's running inside
	130	# the Git tree and uses git --describe, which always returns the
	131	# current version of master.) I do not want to change the old
	132	# reversion scripts (in 4.86.1, 4.85.1).
	133	#
	134	# Thus we've to provide the version.sh, based on the info we have
	135	# about the release. If reversion finds this, it doesn't try to find
	136	# it's own way to get a valid version number from the git.
	137	open(my $v, '>', 'version.sh') or die "Can't open '>version.sh' $!\n";
	138	print {$v} <<__;
	139	# initial version automatically generated from $0
	140	EXIM_RELEASE_VERSION=$context->{major}
	141	EXIM_VARIANT_VERSION=@{[$context->{minor}?'_'.$context->{minor}:'']}
	142	EXIM_COMPILE_NUMBER=0
	143	__
	144	close($v);
	145	unlink 'version.h';
	146	return;
	147
	148	# Later, if we get the reversion script fixed, we can call it again.
	149	# For now (25. Feb. 2016) we'll leave it unused.
	150	my @cmd = ("../scripts/reversion", "release", $context->{tag});
5901f0ab TF	151	print( "Running: ", join( ' ', @cmd ), "\n" ) if ($verbose);
	152	system(@cmd) == 0 \|\| croak "reversion failed";
	153
	154	unlink "version.h";
ba41f854	155
9677df8a	156	-f "version.sh" or die "failed to create version.sh";
ba41f854 PP	157	}
	158
	159	# ------------------------------------------------------------------
	160
be914e6c NM	161	sub build_html_documentation {
	162	my $context = shift;
	163
	164	my $genpath = $context->{webgen_base} . '/script/gen.pl';
	165	my $templates = $context->{webgen_base} . '/templates';
46c573de NM	166	my $dir = File::Spec->catdir( $context->{release_tree}, 'html' );
	167	my $spec = File::Spec->catfile( $context->{docbook}, 'spec.xml' );
	168	my $filter = File::Spec->catfile( $context->{docbook}, 'filter.xml' );
	169
be914e6c NM	170	mkdir($dir);
be914e6c NM	171
cd6d74ab NM	172	my @cmd = (
	173	$genpath, '--spec', $spec, '--filter',
	174	$filter, '--latest', $context->{trelease}, '--tmpl',
e14fcb3b	175	$templates, '--docroot', $dir, '--localstatic'
cd6d74ab	176	);
e14fcb3b	177	push @cmd, '--verbose' if $verbose or $debug;
be914e6c NM	178
	179	print "Executing ", join( ' ', @cmd ), "\n";
	180	system(@cmd);
	181
	182	# move directory into right place
46c573de NM	183	my $sourcedir = File::Spec->catdir( $context->{docbook}, 'filter.xml' );
	184
	185	rename(
	186	File::Spec->catdir( $dir, sprintf( 'exim-html-%s', $context->{trelease} ) ),
	187	File::Spec->catdir( $context->{pkgdirs}, sprintf( 'exim-html-%s', $context->{release} ) )
	188	);
	189	}
	190
	191	# ------------------------------------------------------------------
	192
	193	sub copy_docbook_files {
	194	my $context = shift;
	195
	196	# where the generated docbook files can be found
	197	my $docdir = File::Spec->catdir( $context->{release_tree}, 'doc', 'doc-docbook' );
	198
	199	# where the website docbook source dir is - push files to here
	200	my $webdir = File::Spec->catdir( $context->{webgen_base}, 'docbook', $context->{trelease} );
	201	mkpath( $webdir, { verbose => ( $verbose \|\| $debug ) } );
	202
	203	foreach my $file ( 'spec.xml', 'filter.xml' ) {
	204	my $from = File::Spec->catfile( $docdir, $file );
	205	my $to = File::Spec->catfile( $context->{docbook}, $file );
	206	my $webto = File::Spec->catfile( $webdir, $file );
	207	copy( $from, $to );
	208	copy( $from, $webto );
	209	}
be914e6c NM	210	}
	211
	212	# ------------------------------------------------------------------
	213
8a483da6	214	sub build_documentation {
be914e6c NM	215	my $context = shift;
be914e6c NM	216
46c573de	217	my $docdir = File::Spec->catdir( $context->{release_tree}, 'doc', 'doc-docbook' );
39d16d73	218	# documentation building gets the truncated release, without RC
a7637438	219	system("cd '$docdir' && ./OS-Fixups && $context->{make_cmd} EXIM_VER=$context->{trelease} everything") == 0
8a483da6	220	\|\| croak "Doc build failed";
be914e6c	221
46c573de	222	copy_docbook_files($context);
be914e6c	223	build_html_documentation($context);
8a483da6 NM	224	}
	225
	226	# ------------------------------------------------------------------
	227
	228	sub move_text_docs_into_pkg {
	229	my $context = shift;
	230
821bc55f PP	231	my $old_docdir = File::Spec->catdir( $context->{release_tree}, 'doc', 'doc-docbook' );
821bc55f PP	232	my $old_txtdir = File::Spec->catdir( $context->{release_tree}, 'doc', 'doc-txt' );
46c573de	233	my $new_docdir = File::Spec->catdir( $context->{eximpkgdir}, 'doc' );
8a483da6 NM	234	mkpath( $new_docdir, { verbose => ( $verbose \|\| $debug ) } );
	235
	236	# move generated documents from docbook stuff
	237	foreach my $file (qw/exim.8 spec.txt filter.txt/) {
	238	move( File::Spec->catfile( $old_docdir, $file ), File::Spec->catfile( $new_docdir, $file ) );
	239	}
	240
	241	# move text documents across
821bc55f	242	foreach my $file ( glob( File::Spec->catfile( $old_txtdir, '*' ) ) ) {
8a483da6 NM	243
	244	# skip a few we dont want
	245	my $fn = ( File::Spec->splitpath($file) )[2];
	246	next
	247	if ( ( $fn eq 'ABOUT' )
	248	\|\| ( $fn eq 'ChangeLog.0' )
3394b36a TL	249	\|\| ( $fn eq 'test-harness.txt' )
	250	# Debian issue re licensing of RFCs
	251	\|\| ( $fn =~ /^draft-ietf-.*/ )
	252	\|\| ( $fn =~ /^rfc.*/ )
	253	);
8a483da6 NM	254	move( $file, File::Spec->catfile( $new_docdir, $fn ) );
	255	}
	256	}
	257
	258	# ------------------------------------------------------------------
	259
	260	sub build_pspdfinfo_directory {
	261	my $context = shift;
	262
	263	##foreach my $format (qw/pdf postscript texinfo info/) {
	264	foreach my $format (qw/pdf postscript/) {
46c573de	265	my $target = File::Spec->catdir( $context->{pkgdirs}, sprintf( 'exim-%s-%s', $format, $context->{release} ), 'doc' );
8a483da6 NM	266	mkpath( $target, { verbose => ( $verbose \|\| $debug ) } );
	267
	268	# move documents across
	269	foreach my $file (
	270	glob(
	271	File::Spec->catfile(
46c573de NM	272	$context->{release_tree},
	273	'doc',
	274	'doc-docbook',
8a483da6 NM	275	(
	276	( $format eq 'postscript' )
	277	? '*.ps'
	278	: ( '*.' . $format )
	279	)
	280	)
	281	)
	282	)
	283	{
46c573de	284	move( $file, File::Spec->catfile( $target, ( File::Spec->splitpath($file) )[2] ) );
8a483da6 NM	285	}
	286	}
	287	}
	288
	289	# ------------------------------------------------------------------
	290
8a483da6 NM	291	sub build_main_package_directory {
	292	my $context = shift;
	293
46c573de NM	294	# build the exim package directory path
	295	$context->{eximpkgdir} = File::Spec->catdir( $context->{pkgdirs}, sprintf( 'exim-%s', $context->{release} ) );
	296
8a483da6	297	# initially we move the exim-src directory to the new directory name
46c573de NM	298	rename( File::Spec->catdir( $context->{release_tree}, 'src' ), $context->{eximpkgdir} )
46c573de NM	299	\|\| croak "Rename of src dir failed - $!";
8a483da6 NM	300
8a483da6 NM	301	# add Local subdirectory
46c573de	302	mkpath( File::Spec->catdir( $context->{eximpkgdir}, 'Local' ), { verbose => ( $verbose \|\| $debug ) } );
8a483da6 NM	303
	304	# now add the text docs
	305	move_text_docs_into_pkg($context);
	306	}
	307
	308	# ------------------------------------------------------------------
	309
	310	sub build_package_directories {
	311	my $context = shift;
	312
	313	build_main_package_directory($context);
9677df8a	314	build_pspdfinfo_directory($context) if $context->{build_docs};
8a483da6 NM	315	}
	316
	317	# ------------------------------------------------------------------
	318
46c573de NM	319	sub do_cleanup {
	320	my $context = shift;
	321
	322	print "Cleaning up\n" if ($verbose);
3ec6ea71	323	chdir( $context->{directory} ) \|\| die;
46c573de NM	324	rmtree( $context->{release_tree}, { verbose => $debug } );
	325	rmtree( $context->{docbook}, { verbose => $debug } );
	326	rmtree( $context->{pkgdirs}, { verbose => $debug } );
	327	}
	328
	329	# ------------------------------------------------------------------
	330
9d0311ff PP	331	# We prefer gtar to tar if gtar exists in $PATH
	332
	333	sub fix_paths_tar {
	334	my $context = shift;
	335	my $tar = $context->{tar_cmd};
	336
	337	return unless $tar eq 'tar';
	338
	339	foreach my $d (File::Spec->path()) {
	340	my $p = File::Spec->catfile($d, 'gtar');
	341	if (-x $p) {
	342	$context->{tar_cmd} = $p;
	343	print "Switched tar command to: $p\n" if ($verbose);
	344	return;
	345	}
	346	}
	347	}
	348
	349	# ------------------------------------------------------------------
	350
8a483da6 NM	351	sub create_tar_files {
	352	my $context = shift;
	353
46c573de NM	354	my $pkgs = $context->{pkgs};
46c573de NM	355	my $pkgdirs = $context->{pkgdirs};
9d0311ff PP	356	my $tar = $context->{tar_cmd};
	357	if ($verbose) {
	358	foreach my $c (keys %{ $context->{compressors} }) {
	359	print "Compression: $c\t$context->{compressors}{$c}\n";
	360	}
	361	}
	362
46c573de NM	363	foreach my $dir ( glob( File::Spec->catdir( $pkgdirs, ( 'exim*-' . $context->{release} ) ) ) ) {
46c573de NM	364	my $dirname = ( File::Spec->splitdir($dir) )[-1];
9d0311ff	365	if ($context->{compressors}{gzip}) {
03b76468	366	print "Creating: ${pkgs}/${dirname}.tar.gz\n" if ($verbose \|\| $debug);
9d0311ff PP	367	system("$tar cf ${pkgs}/${dirname}.tar.gz --gzip -C ${pkgdirs} ${dirname}")
	368	}
	369	if ($context->{compressors}{bzip2}) {
03b76468	370	print "Creating: ${pkgs}/${dirname}.tar.bz2\n" if ($verbose \|\| $debug);
9d0311ff PP	371	system("$tar cf ${pkgs}/${dirname}.tar.bz2 --bzip2 -C ${pkgdirs} ${dirname}")
	372	}
	373	if ($context->{compressors}{lzip}) {
03b76468	374	print "Creating: ${pkgs}/${dirname}.tar.lz\n" if ($verbose \|\| $debug);
9d0311ff PP	375	system("$tar cf ${pkgs}/${dirname}.tar.lz --lzip -C ${pkgdirs} ${dirname}")
9d0311ff PP	376	}
8a483da6 NM	377	}
	378	}
	379
	380	# ------------------------------------------------------------------
	381	{
	382	my $man;
	383	my $help;
	384	my $context = {
be914e6c NM	385	pkgname => 'exim',
	386	orig_dir => File::Spec->curdir(),
	387	tmp_dir => File::Temp->newdir(),
	388	webgen_base => "$FindBin::Bin/../../../exim-website",
9d0311ff	389	tar_cmd => 'tar',
a7637438	390	make_cmd => 'make',
9d0311ff PP	391	compressors => {
	392	gzip => 1,
	393	bzip2 => 1,
e099cd0d	394	lzip => 0,
9d0311ff	395	},
9677df8a	396	build_docs => 1,
8a483da6 NM	397	};
8a483da6 NM	398	my $delete;
46c573de	399	my $cleanup = 1;
8f29c950	400	##$ENV{'PATH'} = '/opt/local/bin:' . $ENV{'PATH'};
8a483da6 NM	401
	402	unless (
	403	GetOptions(
be914e6c NM	404	'directory=s' => \$context->{directory},
be914e6c NM	405	'webgen_base=s' => \$context->{webgen_base},
a7637438 PP	406	'tar=s' => \$context->{tar_cmd},
a7637438 PP	407	'make=s' => \$context->{make_cmd},
9d0311ff	408	'lzip!' => \$context->{compressors}{lzip},
be914e6c NM	409	'verbose!' => \$verbose,
	410	'debug!' => \$debug,
	411	'help\|?' => \$help,
	412	'man!' => \$man,
	413	'delete!' => \$delete,
46c573de	414	'cleanup!' => \$cleanup,
9677df8a	415	'build-docs!' => \$context->{build_docs},
8a483da6 NM	416	)
	417	)
	418	{
	419	pod2usage( -exitval => 1, -verbose => 0 );
	420	}
	421	pod2usage(0) if $help;
	422	pod2usage( -verbose => 2 ) if $man;
	423
be914e6c	424	get_and_check_version( shift, $context );
9d0311ff	425	fix_paths_tar($context);
be914e6c	426	$context->{tag} = build_tag($context);
8a483da6	427	deal_with_working_directory( $context, $delete );
8f29c950	428	export_git_tree($context);
8a483da6	429	chdir( $context->{directory} ) \|\| die;
8f29c950	430	unpack_tree($context);
5901f0ab	431	make_version_script($context);
9677df8a	432	build_documentation($context) if $context->{build_docs};
8a483da6 NM	433	build_package_directories($context);
8a483da6 NM	434	create_tar_files($context);
46c573de	435	do_cleanup($context) if ($cleanup);
8a483da6 NM	436	}
	437
	438	1;
	439
	440	__END__
	441
	442	=head1 NAME
	443
	444	mk_exim_release.pl - Build an exim release
	445
	446	=head1 SYNOPSIS
	447
	448	mk_exim_release.pl [options] version
	449
	450	Options:
9677df8a	451	--debug force debug mode
8a483da6 NM	452	--verbose force verbose mode
	453	--help display this help and exits
	454	--man displays man page
9d0311ff	455	--tar=cmd command to use for tar
a7637438	456	--make=cmd command to use for make
8a483da6	457	--directory=dir dir to package
9d0311ff	458	--no-lzip do not create .tar.lz files
8a483da6	459	--delete Delete packaging directory at start
9677df8a	460	--noweb skip the website generation
8a483da6 NM	461
	462	=head1 OPTIONS
	463
	464	=over 4
	465
	466	=item B<--debug>
	467
9677df8a	468	Forces debug mode.
8a483da6	469
9d0311ff PP	470	=item B<--tar>
	471
	472	Use to override the path to the tar command; without this, will search for
	473	gtar, and if not found use tar. Need GNU tar for lzip, unless --no-lzip is
	474	used.
	475
a7637438 PP	476	=item B<--make>
	477
	478	Use to override the path/name of the make command.
	479	Useful sometimes to force gmake.
	480
e099cd0d	481	=item B<--lzip>
9d0311ff	482
e099cd0d	483	Build the lzip tarballs.
9d0311ff	484
8a483da6 NM	485	=item B<--verbose>
8a483da6 NM	486
9d0311ff	487	Force verbose mode
8a483da6 NM	488
	489	=item B<--help>
	490
	491	Display help and exits
	492
	493	=item B<--man>
	494
	495	Display man page
	496
	497	=back
	498
	499	=head1 DESCRIPTION
	500
	501	Builds an exim release.
	502
8f29c950 NM	503	Starting in a populated git repo that has already been tagged for
8f29c950 NM	504	release, build docs, build packages etc.
8a483da6	505
9677df8a	506	Parameter is the version number to build as - ie 4.72 4.72RC1, 4.86.1, etc
8a483da6 NM	507
	508	=head1 AUTHOR
	509
	510	Nigel Metheringham <Nigel.Metheringham@dev.intechnology.co.uk>
	511
	512	=head1 COPYRIGHT
	513
8f29c950	514	Copyright 2010 Exim Maintainers. All rights reserved.
8a483da6 NM	515
8a483da6 NM	516	=cut
9d0311ff	517	# vim: set sw=4 et :