[perl5.git] / lib / ExtUtils / Manifest.pm

package ExtUtils::Manifest;

require Exporter;
use Config;
use File::Find;
use File::Copy 'copy';
use File::Spec::Functions qw(splitpath);
use Carp;
use strict;

our ($VERSION,@ISA,@EXPORT_OK,
	    $Is_MacOS,$Is_VMS,
	    $Debug,$Verbose,$Quiet,$MANIFEST,$found,$DEFAULT_MSKIP);

$VERSION = substr(q$Revision: 1.35 $, 10);
@ISA=('Exporter');
@EXPORT_OK = ('mkmanifest', 'manicheck', 'fullcheck', 'filecheck', 
	      'skipcheck', 'maniread', 'manicopy');

$Is_MacOS = $^O eq 'MacOS';
$Is_VMS = $^O eq 'VMS';
if ($Is_VMS) { require File::Basename }

$Debug = $ENV{PERL_MM_MANIFEST_DEBUG} || 0;
$Verbose = 1;
$Quiet = 0;
$MANIFEST = 'MANIFEST';
$DEFAULT_MSKIP = (splitpath($INC{"ExtUtils/Manifest.pm"}))[1]."$MANIFEST.SKIP";

# Really cool fix from Ilya :)
unless (defined $Config{d_link}) {
    no warnings;
    *ln = \&cp;
}

sub mkmanifest {
    my $manimiss = 0;
    my $read = (-r 'MANIFEST' && maniread()) or $manimiss++;
    $read = {} if $manimiss;
    local *M;
    rename $MANIFEST, "$MANIFEST.bak" unless $manimiss;
    open M, ">$MANIFEST" or die "Could not open $MANIFEST: $!";
    my $matches = _maniskip();
    my $found = manifind();
    my($key,$val,$file,%all);
    %all = (%$found, %$read);
    $all{$MANIFEST} = ($Is_VMS ? "$MANIFEST\t\t" : '') . 'This list of files'
        if $manimiss; # add new MANIFEST to known file list
    foreach $file (sort keys %all) {
	next if &$matches($file);
	if ($Verbose){
	    warn "Added to $MANIFEST: $file\n" unless exists $read->{$file};
	}
	my $text = $all{$file};
	($file,$text) = split(/\s+/,$text,2) if $Is_VMS && $text;
	$file = _unmacify($file);
	my $tabs = (5 - (length($file)+1)/8);
	$tabs = 1 if $tabs < 1;
	$tabs = 0 unless $text;
	print M $file, "\t" x $tabs, $text, "\n";
    }
    close M;
}

sub manifind {
    local $found = {};
    find(sub {return if -d $_;
	      (my $name = $File::Find::name) =~ s|^\./||;
	      $name =~ s/^:([^:]+)$/$1/ if $Is_MacOS;
	      warn "Debug: diskfile $name\n" if $Debug;
	      $name =~ s#(.*)\.$#\L$1# if $Is_VMS;
	      $name = uc($name) if /^MANIFEST/i && $Is_VMS;
	      $found->{$name} = "";}, $Is_MacOS ? ":" : ".");
    $found;
}

sub fullcheck {
    _manicheck({check_files => 1, check_MANIFEST => 1});
}

sub manicheck {
    return @{(_manicheck({check_files => 1}))[0]};
}

sub filecheck {
    return @{(_manicheck({check_MANIFEST => 1}))[1]};
}

sub skipcheck {
    _manicheck({check_MANIFEST => 1, warn_on_skip => 1});
}

sub _manicheck {
    my($p) = @_;
    my $read = maniread();
    my $found = manifind();
    my $file;
    my $dosnames=(defined(&Dos::UseLFN) && Dos::UseLFN()==0);
    my(@missfile,@missentry);
    if ($p->{check_files}){
	foreach $file (sort keys %$read){
	    warn "Debug: manicheck checking from $MANIFEST $file\n" if $Debug;
            if ($dosnames){
                $file = lc $file;
                $file =~ s=(\.(\w|-)+)=substr ($1,0,4)=ge;
                $file =~ s=((\w|-)+)=substr ($1,0,8)=ge;
            }
	    unless ( exists $found->{$file} ) {
		warn "No such file: $file\n" unless $Quiet;
		push @missfile, $file;
	    }
	}
    }
    if ($p->{check_MANIFEST}){
	$read ||= {};
	my $matches = _maniskip();
	foreach $file (sort keys %$found){
	    if (&$matches($file)){
		warn "Skipping $file\n" if $p->{warn_on_skip};
		next;
	    }
	    warn "Debug: manicheck checking from disk $file\n" if $Debug;
	    unless ( exists $read->{$file} ) {
		my $canon = $Is_MacOS ? "\t" . _unmacify($file) : '';
		warn "Not in $MANIFEST: $file$canon\n" unless $Quiet;
		push @missentry, $file;
	    }
	}
    }
    (\@missfile,\@missentry);
}

sub maniread {
    my ($mfile) = @_;
    $mfile ||= $MANIFEST;
    my $read = {};
    local *M;
    unless (open M, $mfile){
	warn "$mfile: $!";
	return $read;
    }
    while (<M>){
	chomp;
	next if /^#/;

        my($file, $comment) = /^(\S+)\s*(.*)/;
        next unless $file;

	if ($Is_MacOS) {
	    $file = _macify($file);
	    $file =~ s/\\([0-3][0-7][0-7])/sprintf("%c", oct($1))/ge;
	}
	elsif ($Is_VMS) {
	    my($base,$dir) = File::Basename::fileparse($file);
	    # Resolve illegal file specifications in the same way as tar
	    $dir =~ tr/./_/;
	    my(@pieces) = split(/\./,$base);
	    if (@pieces > 2) { $base = shift(@pieces) . '.' . join('_',@pieces); }
	    my $okfile = "$dir$base";
	    warn "Debug: Illegal name $file changed to $okfile\n" if $Debug;
            $file = $okfile;
            $file = lc($file) unless $file =~ /^MANIFEST/i;
	}

        $read->{$file} = $comment;
    }
    close M;
    $read;
}

# returns an anonymous sub that decides if an argument matches
sub _maniskip {
    my ($mfile) = @_;
    my $matches = sub {0};
    my @skip ;
    $mfile ||= "$MANIFEST.SKIP";
    local *M;
    open M, $mfile or open M, $DEFAULT_MSKIP or return $matches;
    while (<M>){
	chomp;
	next if /^#/;
	next if /^\s*$/;
	push @skip, _macify($_);
    }
    close M;
    my $opts = $Is_VMS ? 'oi ' : 'o ';
    my $sub = "\$matches = "
	. "sub { my(\$arg)=\@_; return 1 if "
	. join (" || ",  (map {s!/!\\/!g; "\$arg =~ m/$_/$opts"} @skip), 0)
	. " }";
    eval $sub;
    print "Debug: $sub\n" if $Debug;
    $matches;
}

sub manicopy {
    my($read,$target,$how)=@_;
    croak "manicopy() called without target argument" unless defined $target;
    $how ||= 'cp';
    require File::Path;
    require File::Basename;
    my(%dirs,$file);
    $target = VMS::Filespec::unixify($target) if $Is_VMS;
    File::Path::mkpath([ $target ],! $Quiet,$Is_VMS ? undef : 0755);
    foreach $file (keys %$read){
    	if ($Is_MacOS) {
	    if ($file =~ m!:!) { 
	   	my $dir = _maccat($target, $file);
		$dir =~ s/[^:]+$//;
	    	File::Path::mkpath($dir,1,0755);
	    }
	    cp_if_diff($file, _maccat($target, $file), $how);
	} else {
	    $file = VMS::Filespec::unixify($file) if $Is_VMS;
	    if ($file =~ m!/!) { # Ilya, that hurts, I fear, or maybe not?
		my $dir = File::Basename::dirname($file);
		$dir = VMS::Filespec::unixify($dir) if $Is_VMS;
		File::Path::mkpath(["$target/$dir"],! $Quiet,$Is_VMS ? undef : 0755);
	    }
	    cp_if_diff($file, "$target/$file", $how);
	}
    }
}

sub cp_if_diff {
    my($from, $to, $how)=@_;
    -f $from or carp "$0: $from not found";
    my($diff) = 0;
    local(*F,*T);
    open(F,"< $from\0") or croak "Can't read $from: $!\n";
    if (open(T,"< $to\0")) {
	while (<F>) { $diff++,last if $_ ne <T>; }
	$diff++ unless eof(T);
	close T;
    }
    else { $diff++; }
    close F;
    if ($diff) {
	if (-e $to) {
	    unlink($to) or confess "unlink $to: $!";
	}
      STRICT_SWITCH: {
	    best($from,$to), last STRICT_SWITCH if $how eq 'best';
	    cp($from,$to), last STRICT_SWITCH if $how eq 'cp';
	    ln($from,$to), last STRICT_SWITCH if $how eq 'ln';
	    croak("ExtUtils::Manifest::cp_if_diff " .
		  "called with illegal how argument [$how]. " .
		  "Legal values are 'best', 'cp', and 'ln'.");
	}
    }
}

sub cp {
    my ($srcFile, $dstFile) = @_;
    my ($perm,$access,$mod) = (stat $srcFile)[2,8,9];
    copy($srcFile,$dstFile);
    utime $access, $mod + ($Is_VMS ? 1 : 0), $dstFile;
    # chmod a+rX-w,go-w
    chmod(  0444 | ( $perm & 0111 ? 0111 : 0 ),  $dstFile ) unless ($^O eq 'MacOS');
}

sub ln {
    my ($srcFile, $dstFile) = @_;
    return &cp if $Is_VMS or ($^O eq 'MSWin32' and Win32::IsWin95());
    link($srcFile, $dstFile);
    local($_) = $dstFile; # chmod a+r,go-w+X (except "X" only applies to u=x)
    my $mode= 0444 | (stat)[2] & 0700;
    if (! chmod(  $mode | ( $mode & 0100 ? 0111 : 0 ),  $_  )) {
       unlink $dstFile;
       return;
    }
    1;
}

sub best {
    my ($srcFile, $dstFile) = @_;
    if (-l $srcFile) {
	cp($srcFile, $dstFile);
    } else {
	ln($srcFile, $dstFile) or cp($srcFile, $dstFile);
    }
}

sub _macify {
    my($file) = @_;

    return $file unless $Is_MacOS;
    
    $file =~ s|^\./||;
    if ($file =~ m|/|) {
	$file =~ s|/+|:|g;
	$file = ":$file";
    }
    
    $file;
}

sub _maccat {
    my($f1, $f2) = @_;
    
    return "$f1/$f2" unless $Is_MacOS;
    
    $f1 .= ":$f2";
    $f1 =~ s/([^:]:):/$1/g;
    return $f1;
}

sub _unmacify {
    my($file) = @_;

    return $file unless $Is_MacOS;
    
    $file =~ s|^:||;
    $file =~ s|([/ \n])|sprintf("\\%03o", unpack("c", $1))|ge;
    $file =~ y|:|/|;
    
    $file;
}

1;

__END__

=head1 NAME

ExtUtils::Manifest - utilities to write and check a MANIFEST file

=head1 SYNOPSIS

    require ExtUtils::Manifest;

    ExtUtils::Manifest::mkmanifest;

    ExtUtils::Manifest::manicheck;

    ExtUtils::Manifest::filecheck;

    ExtUtils::Manifest::fullcheck;

    ExtUtils::Manifest::skipcheck;

    ExtUtils::Manifest::manifind();

    ExtUtils::Manifest::maniread($file);

    ExtUtils::Manifest::manicopy($read,$target,$how);

=head1 DESCRIPTION

mkmanifest() writes all files in and below the current directory to a
file named in the global variable $ExtUtils::Manifest::MANIFEST (which
defaults to C<MANIFEST>) in the current directory. It works similar to

    find . -print

but in doing so checks each line in an existing C<MANIFEST> file and
includes any comments that are found in the existing C<MANIFEST> file
in the new one. Anything between white space and an end of line within
a C<MANIFEST> file is considered to be a comment. Filenames and
comments are separated by one or more TAB characters in the
output. All files that match any regular expression in a file
C<MANIFEST.SKIP> (if such a file exists) are ignored.

manicheck() checks if all the files within a C<MANIFEST> in the
current directory really do exist. It only reports discrepancies and
exits silently if MANIFEST and the tree below the current directory
are in sync.

filecheck() finds files below the current directory that are not
mentioned in the C<MANIFEST> file. An optional file C<MANIFEST.SKIP>
will be consulted. Any file matching a regular expression in such a
file will not be reported as missing in the C<MANIFEST> file.

fullcheck() does both a manicheck() and a filecheck().

skipcheck() lists all the files that are skipped due to your
C<MANIFEST.SKIP> file.

manifind() returns a hash reference. The keys of the hash are the
files found below the current directory.

maniread($file) reads a named C<MANIFEST> file (defaults to
C<MANIFEST> in the current directory) and returns a HASH reference
with files being the keys and comments being the values of the HASH.
Blank lines and lines which start with C<#> in the C<MANIFEST> file
are discarded.

C<manicopy($read,$target,$how)> copies the files that are the keys in
the HASH I<%$read> to the named target directory. The HASH reference
$read is typically returned by the maniread() function. This
function is useful for producing a directory tree identical to the
intended distribution tree. The third parameter $how can be used to
specify a different methods of "copying". Valid values are C<cp>,
which actually copies the files, C<ln> which creates hard links, and
C<best> which mostly links the files but copies any symbolic link to
make a tree without any symbolic link. Best is the default.

=head1 MANIFEST.SKIP

The file MANIFEST.SKIP may contain regular expressions of files that
should be ignored by mkmanifest() and filecheck(). The regular
expressions should appear one on each line. Blank lines and lines
which start with C<#> are skipped.  Use C<\#> if you need a regular
expression to start with a sharp character. A typical example:

    # Version control files and dirs.
    \bRCS\b
    \bCVS\b
    ,v$

    # Makemaker generated files and dirs.
    ^MANIFEST\.
    ^Makefile$
    ^blib/
    ^MakeMaker-\d

    # Temp, old and emacs backup files.
    ~$
    \.old$
    ^#.*#$
    ^\.#

If no MANIFEST.SKIP file is found, a default set of skips will be
used, similar to the example above.  If you want nothing skipped,
simply make an empty MANIFEST.SKIP file.


=head1 EXPORT_OK

C<&mkmanifest>, C<&manicheck>, C<&filecheck>, C<&fullcheck>,
C<&maniread>, and C<&manicopy> are exportable.

=head1 GLOBAL VARIABLES

C<$ExtUtils::Manifest::MANIFEST> defaults to C<MANIFEST>. Changing it
results in both a different C<MANIFEST> and a different
C<MANIFEST.SKIP> file. This is useful if you want to maintain
different distributions for different audiences (say a user version
and a developer version including RCS).

C<$ExtUtils::Manifest::Quiet> defaults to 0. If set to a true value,
all functions act silently.

C<$ExtUtils::Manifest::Debug> defaults to 0.  If set to a true value,
or if PERL_MM_MANIFEST_DEBUG is true, debugging output will be
produced.

=head1 DIAGNOSTICS

All diagnostic output is sent to C<STDERR>.

=over 4

=item C<Not in MANIFEST:> I<file>

is reported if a file is found, that is missing in the C<MANIFEST>
file which is excluded by a regular expression in the file
C<MANIFEST.SKIP>.

=item C<No such file:> I<file>

is reported if a file mentioned in a C<MANIFEST> file does not
exist.

=item C<MANIFEST:> I<$!>

is reported if C<MANIFEST> could not be opened.

=item C<Added to MANIFEST:> I<file>

is reported by mkmanifest() if $Verbose is set and a file is added
to MANIFEST. $Verbose is set to 1 by default.

=back

=head1 ENVIRONMENT

=over 4

=item B<PERL_MM_MANIFEST_DEBUG>

Turns on debugging

=back

=head1 SEE ALSO

L<ExtUtils::MakeMaker> which has handy targets for most of the functionality.

=head1 AUTHOR

Andreas Koenig <F<andreas.koenig@anima.de>>

=cut
Commit	Line	Data
005c1a0e AD	1	package ExtUtils::Manifest;
005c1a0e AD	2
005c1a0e	3	require Exporter;
8e07c86e	4	use Config;
005c1a0e	5	use File::Find;
79dd614e	6	use File::Copy 'copy';
0b9c804f	7	use File::Spec::Functions qw(splitpath);
005c1a0e	8	use Carp;
8a1da95f	9	use strict;
8a1da95f	10
f168a5e7	11	our ($VERSION,@ISA,@EXPORT_OK,
5d31cce8 JH	12	$Is_MacOS,$Is_VMS,
5d31cce8 JH	13	$Debug,$Verbose,$Quiet,$MANIFEST,$found,$DEFAULT_MSKIP);
8a1da95f	14
88d01e8d	15	$VERSION = substr(q$Revision: 1.35 $, 10);
8a1da95f	16	@ISA=('Exporter');
	17	@EXPORT_OK = ('mkmanifest', 'manicheck', 'fullcheck', 'filecheck',
	18	'skipcheck', 'maniread', 'manicopy');
005c1a0e	19
db5fd395	20	$Is_MacOS = $^O eq 'MacOS';
79dd614e	21	$Is_VMS = $^O eq 'VMS';
9607fc9c	22	if ($Is_VMS) { require File::Basename }
005c1a0e	23
0b9c804f	24	$Debug = $ENV{PERL_MM_MANIFEST_DEBUG} \|\| 0;
9607fc9c	25	$Verbose = 1;
005c1a0e	26	$Quiet = 0;
cb1a09d0	27	$MANIFEST = 'MANIFEST';
0b9c804f	28	$DEFAULT_MSKIP = (splitpath($INC{"ExtUtils/Manifest.pm"}))[1]."$MANIFEST.SKIP";
cb1a09d0	29
4e68a208 AD	30	# Really cool fix from Ilya :)
4e68a208 AD	31	unless (defined $Config{d_link}) {
db376a24	32	no warnings;
4e68a208 AD	33	*ln = \&cp;
	34	}
	35
005c1a0e AD	36	sub mkmanifest {
005c1a0e AD	37	my $manimiss = 0;
0300da75	38	my $read = (-r 'MANIFEST' && maniread()) or $manimiss++;
005c1a0e	39	$read = {} if $manimiss;
864a5fa8	40	local *M;
cb1a09d0 AD	41	rename $MANIFEST, "$MANIFEST.bak" unless $manimiss;
cb1a09d0 AD	42	open M, ">$MANIFEST" or die "Could not open $MANIFEST: $!";
005c1a0e AD	43	my $matches = _maniskip();
	44	my $found = manifind();
	45	my($key,$val,$file,%all);
f1387719	46	%all = (%$found, %$read);
84876ac5	47	$all{$MANIFEST} = ($Is_VMS ? "$MANIFEST\t\t" : '') . 'This list of files'
84876ac5	48	if $manimiss; # add new MANIFEST to known file list
005c1a0e AD	49	foreach $file (sort keys %all) {
	50	next if &$matches($file);
	51	if ($Verbose){
cb1a09d0	52	warn "Added to $MANIFEST: $file\n" unless exists $read->{$file};
005c1a0e	53	}
8e07c86e	54	my $text = $all{$file};
84876ac5	55	($file,$text) = split(/\s+/,$text,2) if $Is_VMS && $text;
db5fd395	56	$file = _unmacify($file);
005c1a0e AD	57	my $tabs = (5 - (length($file)+1)/8);
005c1a0e AD	58	$tabs = 1 if $tabs < 1;
8e07c86e AD	59	$tabs = 0 unless $text;
8e07c86e AD	60	print M $file, "\t" x $tabs, $text, "\n";
005c1a0e AD	61	}
	62	close M;
	63	}
	64
	65	sub manifind {
	66	local $found = {};
4633a7c4	67	find(sub {return if -d $_;
db5fd395 CN	68	(my $name = $File::Find::name) =~ s\|^\./\|\|;
db5fd395 CN	69	$name =~ s/^:([^:]+)$/$1/ if $Is_MacOS;
005c1a0e	70	warn "Debug: diskfile $name\n" if $Debug;
db5fd395	71	$name =~ s#(.*)\.$#\L$1# if $Is_VMS;
349e1be1	72	$name = uc($name) if /^MANIFEST/i && $Is_VMS;
db5fd395	73	$found->{$name} = "";}, $Is_MacOS ? ":" : ".");
005c1a0e AD	74	$found;
	75	}
	76
	77	sub fullcheck {
6aa71d6e	78	_manicheck({check_files => 1, check_MANIFEST => 1});
005c1a0e AD	79	}
	80
	81	sub manicheck {
6aa71d6e	82	return @{(_manicheck({check_files => 1}))[0]};
005c1a0e AD	83	}
	84
	85	sub filecheck {
6aa71d6e	86	return @{(_manicheck({check_MANIFEST => 1}))[1]};
005c1a0e AD	87	}
005c1a0e AD	88
8e07c86e	89	sub skipcheck {
6aa71d6e	90	_manicheck({check_MANIFEST => 1, warn_on_skip => 1});
8e07c86e AD	91	}
8e07c86e AD	92
005c1a0e	93	sub _manicheck {
6aa71d6e	94	my($p) = @_;
005c1a0e	95	my $read = maniread();
15a074ca	96	my $found = manifind();
005c1a0e	97	my $file;
39e571d4	98	my $dosnames=(defined(&Dos::UseLFN) && Dos::UseLFN()==0);
005c1a0e	99	my(@missfile,@missentry);
6aa71d6e	100	if ($p->{check_files}){
005c1a0e	101	foreach $file (sort keys %$read){
cb1a09d0	102	warn "Debug: manicheck checking from $MANIFEST $file\n" if $Debug;
39e571d4 LM	103	if ($dosnames){
	104	$file = lc $file;
	105	$file =~ s=(\.(\w\|-)+)=substr ($1,0,4)=ge;
	106	$file =~ s=((\w\|-)+)=substr ($1,0,8)=ge;
	107	}
005c1a0e	108	unless ( exists $found->{$file} ) {
8e07c86e AD	109	warn "No such file: $file\n" unless $Quiet;
8e07c86e AD	110	push @missfile, $file;
005c1a0e AD	111	}
	112	}
	113	}
6aa71d6e	114	if ($p->{check_MANIFEST}){
005c1a0e AD	115	$read \|\|= {};
005c1a0e AD	116	my $matches = _maniskip();
005c1a0e	117	foreach $file (sort keys %$found){
8e07c86e	118	if (&$matches($file)){
6aa71d6e	119	warn "Skipping $file\n" if $p->{warn_on_skip};
8e07c86e AD	120	next;
8e07c86e AD	121	}
005c1a0e AD	122	warn "Debug: manicheck checking from disk $file\n" if $Debug;
005c1a0e AD	123	unless ( exists $read->{$file} ) {
c4968b8c	124	my $canon = $Is_MacOS ? "\t" . _unmacify($file) : '';
db5fd395	125	warn "Not in $MANIFEST: $file$canon\n" unless $Quiet;
8e07c86e	126	push @missentry, $file;
005c1a0e AD	127	}
	128	}
	129	}
	130	(\@missfile,\@missentry);
	131	}
	132
	133	sub maniread {
	134	my ($mfile) = @_;
15a074ca	135	$mfile \|\|= $MANIFEST;
005c1a0e AD	136	my $read = {};
	137	local *M;
	138	unless (open M, $mfile){
	139	warn "$mfile: $!";
	140	return $read;
	141	}
	142	while (<M>){
	143	chomp;
15a074ca	144	next if /^#/;
0e3309e2 MS	145
	146	my($file, $comment) = /^(\S+)\s(.)/;
	147	next unless $file;
	148
db5fd395	149	if ($Is_MacOS) {
0e3309e2 MS	150	$file = _macify($file);
0e3309e2 MS	151	$file =~ s/\\([0-3][0-7][0-7])/sprintf("%c", oct($1))/ge;
db5fd395 CN	152	}
db5fd395 CN	153	elsif ($Is_VMS) {
9607fc9c	154	my($base,$dir) = File::Basename::fileparse($file);
	155	# Resolve illegal file specifications in the same way as tar
	156	$dir =~ tr/./_/;
	157	my(@pieces) = split(/\./,$base);
	158	if (@pieces > 2) { $base = shift(@pieces) . '.' . join('_',@pieces); }
	159	my $okfile = "$dir$base";
	160	warn "Debug: Illegal name $file changed to $okfile\n" if $Debug;
349e1be1 JH	161	$file = $okfile;
349e1be1 JH	162	$file = lc($file) unless $file =~ /^MANIFEST/i;
9607fc9c	163	}
0e3309e2 MS	164
0e3309e2 MS	165	$read->{$file} = $comment;
005c1a0e AD	166	}
	167	close M;
	168	$read;
	169	}
	170
	171	# returns an anonymous sub that decides if an argument matches
	172	sub _maniskip {
	173	my ($mfile) = @_;
	174	my $matches = sub {0};
	175	my @skip ;
15a074ca	176	$mfile \|\|= "$MANIFEST.SKIP";
005c1a0e	177	local *M;
0b9c804f	178	open M, $mfile or open M, $DEFAULT_MSKIP or return $matches;
005c1a0e AD	179	while (<M>){
005c1a0e AD	180	chomp;
15a074ca	181	next if /^#/;
005c1a0e	182	next if /^\s*$/;
db5fd395	183	push @skip, _macify($_);
005c1a0e AD	184	}
005c1a0e AD	185	close M;
8e07c86e	186	my $opts = $Is_VMS ? 'oi ' : 'o ';
005c1a0e AD	187	my $sub = "\$matches = "
005c1a0e AD	188	. "sub { my(\$arg)=\@_; return 1 if "
8e07c86e	189	. join (" \|\| ", (map {s!/!\\/!g; "\$arg =~ m/$_/$opts"} @skip), 0)
005c1a0e AD	190	. " }";
	191	eval $sub;
	192	print "Debug: $sub\n" if $Debug;
	193	$matches;
	194	}
	195
	196	sub manicopy {
8e07c86e	197	my($read,$target,$how)=@_;
005c1a0e	198	croak "manicopy() called without target argument" unless defined $target;
15a074ca	199	$how \|\|= 'cp';
005c1a0e AD	200	require File::Path;
	201	require File::Basename;
	202	my(%dirs,$file);
8e07c86e	203	$target = VMS::Filespec::unixify($target) if $Is_VMS;
553c0e07	204	File::Path::mkpath([ $target ],! $Quiet,$Is_VMS ? undef : 0755);
005c1a0e	205	foreach $file (keys %$read){
db5fd395 CN	206	if ($Is_MacOS) {
	207	if ($file =~ m!:!) {
	208	my $dir = _maccat($target, $file);
	209	$dir =~ s/[^:]+$//;
	210	File::Path::mkpath($dir,1,0755);
	211	}
	212	cp_if_diff($file, _maccat($target, $file), $how);
	213	} else {
	214	$file = VMS::Filespec::unixify($file) if $Is_VMS;
	215	if ($file =~ m!/!) { # Ilya, that hurts, I fear, or maybe not?
	216	my $dir = File::Basename::dirname($file);
	217	$dir = VMS::Filespec::unixify($dir) if $Is_VMS;
	218	File::Path::mkpath(["$target/$dir"],! $Quiet,$Is_VMS ? undef : 0755);
	219	}
	220	cp_if_diff($file, "$target/$file", $how);
84876ac5	221	}
005c1a0e AD	222	}
	223	}
	224
	225	sub cp_if_diff {
8a1da95f	226	my($from, $to, $how)=@_;
15a074ca	227	-f $from or carp "$0: $from not found";
8e07c86e AD	228	my($diff) = 0;
8e07c86e AD	229	local(F,T);
db5fd395 CN	230	open(F,"< $from\0") or croak "Can't read $from: $!\n";
db5fd395 CN	231	if (open(T,"< $to\0")) {
8e07c86e AD	232	while (<F>) { $diff++,last if $_ ne <T>; }
	233	$diff++ unless eof(T);
	234	close T;
	235	}
	236	else { $diff++; }
	237	close F;
	238	if ($diff) {
	239	if (-e $to) {
	240	unlink($to) or confess "unlink $to: $!";
	241	}
15a074ca A	242	STRICT_SWITCH: {
	243	best($from,$to), last STRICT_SWITCH if $how eq 'best';
	244	cp($from,$to), last STRICT_SWITCH if $how eq 'cp';
	245	ln($from,$to), last STRICT_SWITCH if $how eq 'ln';
	246	croak("ExtUtils::Manifest::cp_if_diff " .
	247	"called with illegal how argument [$how]. " .
	248	"Legal values are 'best', 'cp', and 'ln'.");
	249	}
8e07c86e AD	250	}
	251	}
	252
8e07c86e AD	253	sub cp {
8e07c86e AD	254	my ($srcFile, $dstFile) = @_;
79dd614e	255	my ($perm,$access,$mod) = (stat $srcFile)[2,8,9];
79dd614e	256	copy($srcFile,$dstFile);
9607fc9c	257	utime $access, $mod + ($Is_VMS ? 1 : 0), $dstFile;
8e07c86e	258	# chmod a+rX-w,go-w
db5fd395	259	chmod( 0444 \| ( $perm & 0111 ? 0111 : 0 ), $dstFile ) unless ($^O eq 'MacOS');
8e07c86e AD	260	}
	261
	262	sub ln {
	263	my ($srcFile, $dstFile) = @_;
f0f13d0e	264	return &cp if $Is_VMS or ($^O eq 'MSWin32' and Win32::IsWin95());
8e07c86e AD	265	link($srcFile, $dstFile);
	266	local($_) = $dstFile; # chmod a+r,go-w+X (except "X" only applies to u=x)
	267	my $mode= 0444 \| (stat)[2] & 0700;
4e6ea2c3 GS	268	if (! chmod( $mode \| ( $mode & 0100 ? 0111 : 0 ), $_ )) {
	269	unlink $dstFile;
	270	return;
	271	}
	272	1;
8e07c86e AD	273	}
8e07c86e AD	274
4633a7c4 LW	275	sub best {
	276	my ($srcFile, $dstFile) = @_;
	277	if (-l $srcFile) {
	278	cp($srcFile, $dstFile);
	279	} else {
3dee4013	280	ln($srcFile, $dstFile) or cp($srcFile, $dstFile);
4633a7c4 LW	281	}
	282	}
	283
db5fd395 CN	284	sub _macify {
	285	my($file) = @_;
	286
	287	return $file unless $Is_MacOS;
	288
	289	$file =~ s\|^\./\|\|;
	290	if ($file =~ m\|/\|) {
	291	$file =~ s\|/+\|:\|g;
	292	$file = ":$file";
	293	}
	294
	295	$file;
	296	}
	297
	298	sub _maccat {
	299	my($f1, $f2) = @_;
	300
	301	return "$f1/$f2" unless $Is_MacOS;
	302
	303	$f1 .= ":$f2";
	304	$f1 =~ s/([^:]:):/$1/g;
	305	return $f1;
	306	}
	307
	308	sub _unmacify {
	309	my($file) = @_;
	310
	311	return $file unless $Is_MacOS;
	312
	313	$file =~ s\|^:\|\|;
	314	$file =~ s\|([/ \n])\|sprintf("\\%03o", unpack("c", $1))\|ge;
	315	$file =~ y\|:\|/\|;
	316
	317	$file;
	318	}
	319
005c1a0e	320	1;
79dd614e	321
	322	__END__
	323
	324	=head1 NAME
	325
	326	ExtUtils::Manifest - utilities to write and check a MANIFEST file
	327
	328	=head1 SYNOPSIS
	329
d962e1c0	330	require ExtUtils::Manifest;
79dd614e	331
d962e1c0	332	ExtUtils::Manifest::mkmanifest;
79dd614e	333
d962e1c0	334	ExtUtils::Manifest::manicheck;
79dd614e	335
d962e1c0	336	ExtUtils::Manifest::filecheck;
79dd614e	337
d962e1c0	338	ExtUtils::Manifest::fullcheck;
79dd614e	339
d962e1c0	340	ExtUtils::Manifest::skipcheck;
79dd614e	341
d962e1c0	342	ExtUtils::Manifest::manifind();
79dd614e	343
d962e1c0	344	ExtUtils::Manifest::maniread($file);
79dd614e	345
d962e1c0	346	ExtUtils::Manifest::manicopy($read,$target,$how);
79dd614e	347
	348	=head1 DESCRIPTION
	349
d962e1c0	350	mkmanifest() writes all files in and below the current directory to a
79dd614e	351	file named in the global variable $ExtUtils::Manifest::MANIFEST (which
	352	defaults to C<MANIFEST>) in the current directory. It works similar to
	353
	354	find . -print
	355
	356	but in doing so checks each line in an existing C<MANIFEST> file and
	357	includes any comments that are found in the existing C<MANIFEST> file
	358	in the new one. Anything between white space and an end of line within
	359	a C<MANIFEST> file is considered to be a comment. Filenames and
de592821	360	comments are separated by one or more TAB characters in the
79dd614e	361	output. All files that match any regular expression in a file
	362	C<MANIFEST.SKIP> (if such a file exists) are ignored.
	363
d962e1c0	364	manicheck() checks if all the files within a C<MANIFEST> in the
f1387719	365	current directory really do exist. It only reports discrepancies and
	366	exits silently if MANIFEST and the tree below the current directory
	367	are in sync.
79dd614e	368
d962e1c0	369	filecheck() finds files below the current directory that are not
79dd614e	370	mentioned in the C<MANIFEST> file. An optional file C<MANIFEST.SKIP>
	371	will be consulted. Any file matching a regular expression in such a
	372	file will not be reported as missing in the C<MANIFEST> file.
	373
d962e1c0	374	fullcheck() does both a manicheck() and a filecheck().
79dd614e	375
d962e1c0	376	skipcheck() lists all the files that are skipped due to your
79dd614e	377	C<MANIFEST.SKIP> file.
79dd614e	378
d962e1c0	379	manifind() returns a hash reference. The keys of the hash are the
79dd614e	380	files found below the current directory.
79dd614e	381
d962e1c0	382	maniread($file) reads a named C<MANIFEST> file (defaults to
79dd614e	383	C<MANIFEST> in the current directory) and returns a HASH reference
79dd614e	384	with files being the keys and comments being the values of the HASH.
15a074ca A	385	Blank lines and lines which start with C<#> in the C<MANIFEST> file
15a074ca A	386	are discarded.
79dd614e	387
d962e1c0	388	C<manicopy($read,$target,$how)> copies the files that are the keys in
79dd614e	389	the HASH I<%$read> to the named target directory. The HASH reference
d962e1c0	390	$read is typically returned by the maniread() function. This
79dd614e	391	function is useful for producing a directory tree identical to the
	392	intended distribution tree. The third parameter $how can be used to
	393	specify a different methods of "copying". Valid values are C<cp>,
	394	which actually copies the files, C<ln> which creates hard links, and
	395	C<best> which mostly links the files but copies any symbolic link to
	396	make a tree without any symbolic link. Best is the default.
	397
	398	=head1 MANIFEST.SKIP
	399
	400	The file MANIFEST.SKIP may contain regular expressions of files that
	401	should be ignored by mkmanifest() and filecheck(). The regular
15a074ca A	402	expressions should appear one on each line. Blank lines and lines
	403	which start with C<#> are skipped. Use C<\#> if you need a regular
	404	expression to start with a sharp character. A typical example:
79dd614e	405
0b9c804f	406	# Version control files and dirs.
79dd614e	407	\bRCS\b
0b9c804f MS	408	\bCVS\b
	409	,v$
	410
	411	# Makemaker generated files and dirs.
79dd614e	412	^MANIFEST\.
79dd614e	413	^Makefile$
79dd614e	414	^blib/
	415	^MakeMaker-\d
	416
0b9c804f MS	417	# Temp, old and emacs backup files.
	418	~$
	419	\.old$
	420	^#.*#$
cfcce72b	421	^\.#
0b9c804f MS	422
	423	If no MANIFEST.SKIP file is found, a default set of skips will be
	424	used, similar to the example above. If you want nothing skipped,
	425	simply make an empty MANIFEST.SKIP file.
	426
	427
79dd614e	428	=head1 EXPORT_OK
	429
	430	C<&mkmanifest>, C<&manicheck>, C<&filecheck>, C<&fullcheck>,
	431	C<&maniread>, and C<&manicopy> are exportable.
	432
	433	=head1 GLOBAL VARIABLES
	434
	435	C<$ExtUtils::Manifest::MANIFEST> defaults to C<MANIFEST>. Changing it
	436	results in both a different C<MANIFEST> and a different
	437	C<MANIFEST.SKIP> file. This is useful if you want to maintain
	438	different distributions for different audiences (say a user version
	439	and a developer version including RCS).
	440
81ff29e3	441	C<$ExtUtils::Manifest::Quiet> defaults to 0. If set to a true value,
79dd614e	442	all functions act silently.
79dd614e	443
0b9c804f MS	444	C<$ExtUtils::Manifest::Debug> defaults to 0. If set to a true value,
	445	or if PERL_MM_MANIFEST_DEBUG is true, debugging output will be
	446	produced.
	447
79dd614e	448	=head1 DIAGNOSTICS
	449
	450	All diagnostic output is sent to C<STDERR>.
	451
bbc7dcd2	452	=over 4
79dd614e	453
	454	=item C<Not in MANIFEST:> I<file>
	455
	456	is reported if a file is found, that is missing in the C<MANIFEST>
	457	file which is excluded by a regular expression in the file
	458	C<MANIFEST.SKIP>.
	459
	460	=item C<No such file:> I<file>
	461
	462	is reported if a file mentioned in a C<MANIFEST> file does not
	463	exist.
	464
	465	=item C<MANIFEST:> I<$!>
	466
	467	is reported if C<MANIFEST> could not be opened.
	468
	469	=item C<Added to MANIFEST:> I<file>
	470
	471	is reported by mkmanifest() if $Verbose is set and a file is added
	472	to MANIFEST. $Verbose is set to 1 by default.
	473
	474	=back
	475
0b9c804f MS	476	=head1 ENVIRONMENT
	477
	478	=over 4
	479
	480	=item B<PERL_MM_MANIFEST_DEBUG>
	481
	482	Turns on debugging
	483
	484	=back
	485
79dd614e	486	=head1 SEE ALSO
	487
	488	L<ExtUtils::MakeMaker> which has handy targets for most of the functionality.
	489
	490	=head1 AUTHOR
	491
e309c560	492	Andreas Koenig <F<andreas.koenig@anima.de>>
79dd614e	493
79dd614e	494	=cut