0c96f63ca9a2ae0c9e41f5d1f882ee4e44d962c4
package ExtUtils
::Manifest
;
use vars
qw($VERSION @ISA @EXPORT_OK
$Debug $Verbose $Quiet $MANIFEST $DEFAULT_MSKIP);
@EXPORT_OK = qw(mkmanifest
manicheck filecheck fullcheck skipcheck
manifind maniread manicopy maniadd
$Is_MacOS = $^O
eq 'MacOS';
require VMS
::Filespec
if $Is_VMS;
$Debug = $ENV{PERL_MM_MANIFEST_DEBUG
} || 0;
$Verbose = defined $ENV{PERL_MM_MANIFEST_VERBOSE
} ?
$ENV{PERL_MM_MANIFEST_VERBOSE
} : 1;
$DEFAULT_MSKIP = File
::Spec
->catfile( dirname
(__FILE__
), "$MANIFEST.SKIP" );
ExtUtils::Manifest - utilities to write and check a MANIFEST file
use ExtUtils::Manifest qw(...funcs to import...);
my @missing_files = manicheck;
my @extra_files = filecheck;
my($missing, $extra) = fullcheck;
my $manifest = maniread();
maniadd({$file => $comment, ...});
ExtUtils::Manifest exports no functions by default. The following are
Writes all files in and below the current directory to your F<MANIFEST>.
All files that match any regular expression in a file F<MANIFEST.SKIP>
(if it exists) are ignored.
Any existing F<MANIFEST> file will be saved as F<MANIFEST.bak>. Lines
from the old F<MANIFEST> file is preserved, including any comments
that are found in the existing F<MANIFEST> file in the new one.
return sort { lc $a cmp lc $b } @_;
my $read = (-r
'MANIFEST' && maniread
()) or $manimiss++;
rename $MANIFEST, "$MANIFEST.bak" unless $manimiss;
open M
, ">$MANIFEST" or die "Could not open $MANIFEST: $!";
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) {
# Policy: only remove files if they're listed in MANIFEST.SKIP.
# Don't remove files just because they don't exist.
warn "Removed from $MANIFEST: $file\n" if $Verbose and exists $read->{$file};
warn "Added to $MANIFEST: $file\n" unless exists $read->{$file};
($file,$text) = split(/\s+/,$text,2) if $Is_VMS && $text;
$file = _unmacify
($file);
my $tabs = (5 - (length($file)+1)/8);
print M
$file, "\t" x
$tabs, $text, "\n";
# Geez, shouldn't this use File::Spec or File::Basename or something?
# Why so careful about dependencies?
$filename =~ s/^:([^:]+)$/$1/ if $Is_MacOS;
returns a hash reference. The keys of the hash are the files found
below the current directory.
my $name = clean_up_filename
($File::Find
::name
);
warn "Debug: diskfile $name\n" if $Debug;
$name =~ s
#(.*)\.$#\L$1#;
$name = uc($name) if $name =~ /^MANIFEST(\.SKIP)?$/i;
# We have to use "$File::Find::dir/$_" in preprocess, because
# $File::Find::name is unavailable.
# Also, it's okay to use / here, because MANIFEST files use Unix-style
find
({wanted
=> $wanted},
my @missing_files = manicheck();
checks if all the files within a C<MANIFEST> in the current directory
really do exist. If C<MANIFEST> and the tree below the current
directory are in sync it silently returns an empty list.
Otherwise it returns a list of files which are listed in the
C<MANIFEST> but missing from the directory, and by default also
outputs these names to STDERR.
my @extra_files = 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. The list of any
extraneous files found is returned, and by default also reported to
return _check_manifest
();
my($missing, $extra) = fullcheck();
does both a manicheck() and a filecheck(), returning then as two array
return [_check_files
()], [_check_manifest
()];
my @skipped = skipcheck();
lists all the files that are skipped due to your C<MANIFEST.SKIP>
my $matches = _maniskip
();
foreach my $file (_sort
keys %$found){
my $dosnames=(defined(&Dos
::UseLFN
) && Dos
::UseLFN
()==0);
my $read = maniread
() || {};
my $found = manifind
($p);
foreach my $file (_sort
keys %$read){
warn "Debug: manicheck checking from $MANIFEST $file\n" if $Debug;
$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;
my $read = maniread
() || {};
my $found = manifind
($p);
foreach my $file (_sort
keys %$found){
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;
my $manifest = maniread();
my $manifest = maniread($manifest_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.
my($file, $comment) = /^(\S+)\s*(.*)/;
$file =~ s/\\([0-3][0-7][0-7])/sprintf("%c", oct($1))/ge;
my($base,$dir) = File
::Basename
::fileparse
($file);
# Resolve illegal file specifications in the same way as tar
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 = lc($file) unless $file =~ /^MANIFEST(\.SKIP)?$/;
$read->{$file} = $comment;
# returns an anonymous sub that decides if an argument matches
my $mfile = "$MANIFEST.SKIP";
open M
, $mfile or open M
, $DEFAULT_MSKIP or return sub {0};
my $opts = $Is_VMS ?
'(?i)' : '';
# Make sure each entry is isolated in its own parentheses, in case
# any of them contain alternations
my $regex = join '|', map "(?:$_)", @skip;
return sub { $_[0] =~ qr{$opts$regex} };
manicopy(\%src, $dest_dir);
manicopy(\%src, $dest_dir, $how);
Copies the files that are the keys in %src to the $dest_dir. %src is
typically returned by the maniread() function.
manicopy( maniread(), $dest_dir );
This function is useful for producing a directory tree identical to the
intended distribution tree.
$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. C<cp> is the
my($read,$target,$how)=@_;
croak
"manicopy() called without target argument" unless defined $target;
$target = VMS
::Filespec
::unixify
($target) if $Is_VMS;
File
::Path
::mkpath
([ $target ],! $Quiet,$Is_VMS ?
undef : 0755);
foreach my $file (keys %$read){
my $dir = _maccat
($target, $file);
File
::Path
::mkpath
($dir,1,0755);
cp_if_diff
($file, _maccat
($target, $file), $how);
$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);
-f
$from or carp
"$0: $from not found";
open(F
,"< $from\0") or die "Can't read $from: $!\n";
while (<F
>) { $diff++,last if $_ ne <T
>; }
unlink($to) or confess
"unlink $to: $!";
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'.");
my ($srcFile, $dstFile) = @_;
my ($access,$mod) = (stat $srcFile)[8,9];
utime $access, $mod + ($Is_VMS ?
1 : 0), $dstFile;
_manicopy_chmod
($dstFile);
my ($srcFile, $dstFile) = @_;
return &cp
if $Is_VMS or ($^O
eq 'MSWin32' and Win32
::IsWin95
());
link($srcFile, $dstFile);
unless( _manicopy_chmod
($dstFile) ) {
# 1) Strip off all group and world permissions.
# 2) Let everyone read it.
# 3) If the owner can execute it, everyone can.
my $perm = 0444 | (stat $file)[2] & 0700;
chmod( $perm | ( $perm & 0100 ?
0111 : 0 ), $file );
# Files that are often modified in the distdir. Don't hard link them.
my @Exceptions = qw(MANIFEST META.yml SIGNATURE);
my ($srcFile, $dstFile) = @_;
my $is_exception = grep $srcFile =~ /$_/, @Exceptions;
if ($is_exception or !$Config{d_link
} or -l
$srcFile) {
ln
($srcFile, $dstFile) or cp
($srcFile, $dstFile);
return $file unless $Is_MacOS;
return "$f1/$f2" unless $Is_MacOS;
return $file unless $Is_MacOS;
$file =~ s
|([/ \n])|sprintf("\\%03o", unpack("c", $1))|ge;
maniadd({ $file => $comment, ...});
Adds an entry to an existing F<MANIFEST> unless its already there.
$file will be normalized (ie. Unixified). B<UNIMPLEMENTED>
_fix_manifest
($MANIFEST);
my $manifest = maniread
();
my @needed = grep { !exists $manifest->{$_} } keys %$additions;
open(MANIFEST
, ">>$MANIFEST") or
die "maniadd() could not open $MANIFEST: $!";
foreach my $file (_sort
@needed) {
my $comment = $additions->{$file} || '';
printf MANIFEST
"%-40s %s\n", $file, $comment;
close MANIFEST
or die "Error closing $MANIFEST: $!";
# Sometimes MANIFESTs are missing a trailing newline. Fix this.
my $manifest_file = shift;
open MANIFEST
, $MANIFEST or die "Could not open $MANIFEST: $!";
# Yes, we should be using seek(), but I'd like to avoid loading POSIX
my @manifest = <MANIFEST
>;
unless( $manifest[-1] =~ /\n\z/ ) {
open MANIFEST
, ">>$MANIFEST" or die "Could not open $MANIFEST: $!";
A list of files in the distribution, one file per line. The MANIFEST
always uses Unix filepath conventions even if you're not on Unix. This
means F<foo/bar> style not F<foo\bar>.
Anything between white space and an end of line within a C<MANIFEST>
file is considered to be a comment. Any line beginning with # is also
some/other/file comment about some/file
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 C<#>.
# Version control files and dirs.
# Makemaker generated files and dirs.
# Temp, old and emacs backup files.
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.
C<&mkmanifest>, C<&manicheck>, C<&filecheck>, C<&fullcheck>,
C<&maniread>, and C<&manicopy> are exportable.
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
All diagnostic output is sent to C<STDERR>.
=item C<Not in MANIFEST:> I<file>
is reported if a file is found which is not in C<MANIFEST>.
=item C<Skipping> I<file>
is reported if a file is skipped due to an entry in C<MANIFEST.SKIP>.
=item C<No such file:> I<file>
is reported if a file mentioned in a C<MANIFEST> file does not
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.
=item B<PERL_MM_MANIFEST_DEBUG>
L<ExtUtils::MakeMaker> which has handy targets for most of the functionality.
Andreas Koenig C<andreas.koenig@anima.de>
Currently maintained by Michael G Schwern C<schwern@pobox.com>