#!/usr/bin/perl -w
-#
-# Find dependencies on perl stuff
-# Remove .packlist files
+
+=head1 NAME
+
+dh_perl - calculates Perl dependencies and cleans up after MakeMaker
+
+=cut
use strict;
+use Config;
+use File::Find;
use Debian::Debhelper::Dh_Lib;
-init();
-my $perlext = '';
-my $lib_dir = 'usr/lib/perl5';
+=head1 SYNOPSIS
-# Figure out the version of perl. If $ENV{PERL} is set, query the perl binary
-# it points to, otherwise query perl directly.
-#
-# This is pretty gawd-aweful ugly, because we need "5.00[45]"
-# and "5.[6789]" to be returned depending on perl version.
-my $version;
-if (defined $ENV{PERL}) {
- $version=`$ENV{PERL} -e '\$] < 5.006 ? printf "%.3f", \$] : printf "%vd", substr \$^V, 0, -1'`;
-}
-else {
- $version=$] < 5.006 ? sprintf "%.3f", $] : sprintf "%vd", substr $^V, 0, -1;
-}
+B<dh_perl> [S<I<debhelper options>>] [B<-d>] [S<I<library dirs> ...>]
+
+=head1 DESCRIPTION
+
+B<dh_perl> is a debhelper program that is responsible for generating
+the B<${perl:Depends}> substitutions and adding them to substvars files.
+
+The program will look at Perl scripts and modules in your package,
+and will use this information to generate a dependency on B<perl> or
+B<perlapi>. The dependency will be substituted into your package's F<control>
+file wherever you place the token B<${perl:Depends}>.
+
+B<dh_perl> also cleans up empty directories that MakeMaker can generate when
+installing Perl modules.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-d>
+
+In some specific cases you may want to depend on B<perl-base> rather than the
+full B<perl> package. If so, you can pass the -d option to make B<dh_perl> generate
+a dependency on the correct base package. This is only necessary for some
+packages that are included in the base system.
+
+Note that this flag may cause no dependency on B<perl-base> to be generated at
+all. B<perl-base> is Essential, so its dependency can be left out, unless a
+versioned dependency is needed.
+
+=item B<-V>
+
+By default, scripts and architecture independent modules don't depend
+on any specific version of B<perl>. The B<-V> option causes the current
+version of the B<perl> (or B<perl-base> with B<-d>) package to be specified.
+
+=item I<library dirs>
+
+If your package installs Perl modules in non-standard
+directories, you can make B<dh_perl> check those directories by passing their
+names on the command line. It will only check the F<vendorlib> and F<vendorarch>
+directories by default.
+
+=back
+
+=head1 CONFORMS TO
+
+Debian policy, version 3.8.3
+
+Perl policy, version 1.20
+
+=cut
+
+init();
+
+my $vendorlib = substr $Config{vendorlib}, 1;
+my $vendorarch = substr $Config{vendorarch}, 1;
# Cleaning the paths given on the command line
foreach (@ARGV) {
s#^/##;
}
-# If -d is given, then we'll try to depend on one of the perl-5.00X-base
-# package instead of perl-5.00X
-$perlext='-base' if ($dh{'D_FLAG'});
+my $perl = 'perl';
+# If -d is given, then the dependency is on perl-base rather than perl.
+$perl .= '-base' if $dh{D_FLAG};
+my $version;
+
+# dependency types
+use constant PROGRAM => 1;
+use constant PM_MODULE => 2;
+use constant XS_MODULE => 4;
foreach my $package (@{$dh{DOPACKAGES}}) {
my $tmp=tmpdir($package);
- my $ext=pkgext($package);
-
- my ($file, $v, $arch);
- my $dep_arch = '';
- my $dep = '';
- my $found = 0;
# Check also for alternate locations given on the command line
- my $dirs = '';
- foreach ($lib_dir, @ARGV) {
- $dirs .= "$tmp/$_ " if (-d "$tmp/$_");
- }
- my $re = '(?:' . join('|', ($lib_dir, @ARGV)) . ')';
+ my @dirs = grep -d, map "$tmp/$_", $vendorlib, $vendorarch, @ARGV;
# Look for perl modules and check where they are installed
- if ($dirs) {
- foreach $file (split(/\n/,`find $dirs -type f \\( -name "*.pm" -or -name "*.so" \\)`)) {
- $found++;
- if ($file =~ m<^$tmp/$re/(\d\.\d+)/([^/]+)/>) {
- $v = $1;
- $arch = $2;
- check_module_version ($v, $version);
- $v .= '-thread' if ($arch =~ /-thread/);
- $dep_arch = add_deps ($dep_arch, "perl-$v");
- } elsif ($file =~ m<^$tmp/$re/(\d.\d+)/>) {
- $v = $1;
- check_module_version ($v, $version);
- $dep_arch = add_deps ($dep_arch, "perl-$v");
+ my $deps = 0;
+ find sub {
+ return unless -f;
+ $deps |= PM_MODULE if /\.pm$/;
+ $deps |= XS_MODULE if /\.so$/;
+ }, @dirs if @dirs;
+
+ # find scripts
+ find sub {
+ return unless -f and (-x or /\.pl$/);
+ return if $File::Find::dir=~/\/usr\/share\/doc\//;
+
+ local *F;
+ return unless open F, $_;
+ if (read F, local $_, 32 and m%^#!\s*(/usr/bin/perl|/usr/bin/env\s+perl)\s%) {
+ $deps |= PROGRAM;
}
- }
- }
-
- if ($found and not $dep_arch) {
- $dep = "perl5$perlext";
- } elsif ($dep_arch) {
- $dep = $dep_arch;
- }
-
- # Look for perl scripts
- my ($ff, $newdep);
- foreach $file (split(/\n/,`find $tmp -type f \\( -name "*.pl" -or -perm +111 \\)`)) {
- $ff=`file -b $file`;
- if ($ff =~ /perl/) {
- $newdep = dep_from_script ($file);
- $dep = add_deps ($dep, $newdep) if $newdep;
+ close F;
+ }, $tmp;
+
+ if ($deps) {
+ my $version="";
+ if ($deps & XS_MODULE or $dh{V_FLAG_SET}) {
+ ($version) = `dpkg -s $perl` =~ /^Version:\s*(\S+)/m
+ unless $version;
+ $version = ">= $version";
}
+
+ # no need to depend on an un-versioned perl-base -- it's
+ # essential
+ addsubstvar($package, "perl:Depends", $perl, $version)
+ unless $perl eq 'perl-base' && ! length($version);
+
+ # add perlapi-<ver> for XS modules
+ addsubstvar($package, "perl:Depends",
+ "perlapi-" . ($Config{debian_abi} || $Config{version}))
+ if $deps & XS_MODULE;
}
- # Remove .packlist files and eventually some empty directories
- if (not $dh{'K_FLAG'}) {
- foreach $file (split(/\n/,`find $tmp -type f -name .packlist`))
- {
- unlink($file);
- # Get the directory name
- while ($file =~ s#/[^/]+$##){
- last if (not -d $file);
- last if (not rmdir $file);
- }
+ # MakeMaker always makes lib and share dirs, but typically
+ # only one directory is installed into.
+ foreach my $dir ("$tmp/usr/share/perl5", "$tmp/usr/lib/perl5") {
+ if (-d $dir) {
+ doit("rmdir", "--ignore-fail-on-non-empty", "--parents",
+ "$dir");
}
}
+}
- next unless $dep;
+=head1 SEE ALSO
- if (-e "debian/${ext}substvars") {
- open (IN, "<debian/${ext}substvars");
- my @lines=grep { ! /^perl:Depends=/ } <IN>;
- close IN;
- open (OUT, ">debian/${ext}substvars");
- print OUT @lines;
- } else {
- open (OUT, ">debian/${ext}substvars");
- }
- print OUT "perl:Depends=$dep\n";
- close OUT;
-}
+L<debhelper(7)>
-sub add_deps {
- my ($dep, $new) = @_;
-
- # If the $new-base package can exist then add $perlext to $new
- $new = "$new$perlext" if ($new =~ m/^(?:perl5|perl-\d\.\d+)$/);
-
- # If $new = perl5 or perl5-thread check if perl-X.XXX(-thread)?
- # is not already in the dependencies
- if ($new eq "perl5") {
- return $dep if ($dep =~ m/(^|\s)perl-5\.\d+(\s|,|$)/);
- } elsif ($new eq "perl5-thread") {
- return $dep if ($dep =~ m/(^|\s)perl-5\.\d+-thread(\s|,|$)/);
- }
-
- if (not $dep) {
- $dep = $new;
- } else {
- $dep .= ", $new" unless ($dep =~ m/(^|\s)$new(\s|,|$)/);
- }
+This program is a part of debhelper.
- return $dep;
-}
+=head1 AUTHOR
-sub check_module_version {
- my ($v1, $v2) = @_;
- unless ($v1 eq $v2) {
- warning("A module has been found in perl-$v1 arch directory. But perl-$v2 is the perl currently used ...\n");
- }
-}
+Brendan O'Dea <bod@debian.org>
-sub dep_from_script {
- my $file = shift;
- my ($line, $perl, $dep);
- open (SCRIPT, "<$file") || die "Can't open $file: $!\n";
- $line = <SCRIPT>;
- close (SCRIPT);
- if ($line =~ m<^#!\s*/usr/bin/(perl\S*)(?:\s+|$)>) {
- $perl = $1;
- if ($perl eq "perl") {
- $dep = "perl5";
- } elsif ($perl eq "perl-thread") {
- $dep = "perl5-thread";
- } elsif ($perl =~ m/^perl-\d\.\d+(?:-thread)?$/) {
- $dep = $perl;
- } elsif ($perl =~ m/^perl(\d\.\d+)(\d\d)$/) {
- # Should never happen but ...
- $dep = "perl-$1 (=$1.$2)";
- }
- }
- return $dep;
-}
+=cut