#
# Library functions for debhelper programs, perl version.
#
-# Joey Hess, GPL copyright 1997, 1998.
+# Joey Hess, GPL copyright 1997-2000.
package Debian::Debhelper::Dh_Lib;
use strict;
@ISA=qw(Exporter);
@EXPORT=qw(&init &doit &complex_doit &verbose_print &error &warning &tmpdir
&pkgfile &pkgext &isnative &autoscript &filearray &GetPackages
- &xargs
- %dh);
+ &basename &xargs %dh &compat);
my $max_compat=3;
# the default, doing them all.
if (! defined $dh{DOPACKAGES} || ! @{$dh{DOPACKAGES}}) {
if ($dh{DOINDEP} || $dh{DOARCH} || $dh{DOSAME}) {
- # User specified that all arch (in)dep package be
- # built, and there are none of that type.
- error("I have no package to act on");
+ error("You asked that all arch in(dep) packages be built, but there are none of that type.");
}
push @{$dh{DOPACKAGES}},@allpackages;
}
# This package gets special treatement: files and directories specified on
# the command line may affect it.
$dh{FIRSTPACKAGE}=${$dh{DOPACKAGES}}[0];
-
- # Split the U_PARAMS up into an array.
- my $u=$dh{U_PARAMS};
- undef $dh{U_PARAMS};
- if (defined $u) {
- push @{$dh{U_PARAMS}}, split(/\s+/,$u);
- }
}
-# Escapes out shell metacharacters in a word of shell script.
-sub escape_shell { my $word=shift;
- # This list is from _Unix in a Nutshell_. (except '#')
- $word=~s/([\s!"\$()*+#;<>?@\[\]\\`|~])/\\$1/g;
- return $word;
+# Pass it an array containing the arguments of a shell command like would
+# be run by exec(). It turns that into a line like you might enter at the
+# shell, escaping metacharacters and quoting qrguments that contain spaces.
+sub escape_shell {
+ my @args=@_;
+ my $line="";
+ my @ret;
+ foreach my $word (@args) {
+ if ($word=~/\s/) {
+ # Escape only a few things since it will be quoted.
+ # Note we use double quotes because you cannot
+ # escape ' in qingle quotes, while " can be escaped
+ # in double.
+ # This does make -V"foo bar" turn into "-Vfoo bar",
+ # but that will be parsed identically by the shell
+ # anyway..
+ $word=~s/([\n`\$"\\])/\$1/g;
+ push @ret, "\"$word\"";
+ }
+ else {
+ # This list is from _Unix in a Nutshell_. (except '#')
+ $word=~s/([\s!"\$()*+#;<>?@\[\]\\`|~])/\\$1/g;
+ push @ret,$word;
+ }
+ }
+ return join(' ', @ret);
}
# Run a command, and display the command to stdout if verbose mode is on.
# Note that this cannot handle complex commands, especially anything
# involving redirection. Use complex_doit instead.
sub doit {
- verbose_print(join(" ",map { escape_shell($_) } @_));
-
+ verbose_print(escape_shell(@_));
+
if (! $dh{NO_ACT}) {
- system(@_) == 0
- || error("command returned error code");
-
+ system(@_) == 0 || error("command returned error code");
}
}
my $args=shift;
# The kernel can accept command lines up to 20k worth of characters.
- my $command_max=20000;
+ my $command_max=20000; # LINUX SPECIFIC!!
+ # I could use POSIX::ARG_MAX, but that would be slow.
# Figure out length of static portion of command.
my $static_length=0;
}
# Print something if the verbose flag is on.
-sub verbose_print { my $message=shift;
+sub verbose_print {
+ my $message=shift;
+
if ($dh{VERBOSE}) {
print "\t$message\n";
}
}
# Output an error message and exit.
-sub error { my $message=shift;
+sub error {
+ my $message=shift;
+
warning($message);
exit 1;
}
# Output a warning.
-sub warning { my $message=shift;
+sub warning {
+ my $message=shift;
+
print STDERR basename($0).": $message\n";
}
# Returns the basename of the argument passed to it.
-sub basename { my $fn=shift;
+sub basename {
+ my $fn=shift;
+
$fn=~s:^.*/(.*?)$:$1:;
return $fn;
}
# Returns the directory name of the argument passed to it.
-sub dirname { my $fn=shift;
+sub dirname {
+ my $fn=shift;
+
$fn=~s:^(.*)/.*?$:$1:;
return $fn;
}
# Pass in a number, will return true iff the current compatability level
-# is equal to that number.
+# is less than or equal to that number.
sub compat {
my $num=shift;
error("Sorry, but $max_compat is the highest compatability level of debhelper currently supported.");
}
- return ($c == $num);
+ return ($c <= $num);
}
# Pass it a name of a binary package, it returns the name of the tmp dir to
# use, for that package.
-sub tmpdir { my $package=shift;
+sub tmpdir {
+ my $package=shift;
+
if ($dh{TMPDIR}) {
return $dh{TMPDIR};
}
# Pass it a name of a binary package, it returns the name to prefix to files
# in debian for this package.
-sub pkgext { my $package=shift;
- if ($package ne $dh{MAINPACKAGE}) {
- return "$package.";
+sub pkgext {
+ my $package=shift;
+
+ if (compat(1) and $package eq $dh{MAINPACKAGE}) {
+ return "";
}
- return "";
+ return "$package.";
}
# Returns 1 if the package is a native debian package, null otherwise.
# Caches return code so it only needs to run dpkg-parsechangelog once.
my %isnative_cache;
- sub isnative { my $package=shift;
- if (! defined $isnative_cache{$package}) {
- # Make sure we look at the correct changelog.
- my $isnative_changelog=pkgfile($package,"changelog");
- if (! $isnative_changelog) {
- $isnative_changelog="debian/changelog";
- }
-
- # Get the package version.
- my $version=`dpkg-parsechangelog -l$isnative_changelog`;
- ($dh{VERSION})=$version=~m/Version:\s*(.*)/m;
+ sub isnative {
+ my $package=shift;
- # Did the changelog parse fail?
- if (! defined $dh{VERSION}) {
- error("changelog parse failure");
- }
+ return $isnative_cache{$package} if defined $isnative_cache{$package};
+
+ # Make sure we look at the correct changelog.
+ my $isnative_changelog=pkgfile($package,"changelog");
+ if (! $isnative_changelog) {
+ $isnative_changelog="debian/changelog";
+ }
+ # Get the package version.
+ my $version=`dpkg-parsechangelog -l$isnative_changelog`;
+ ($dh{VERSION})=$version=~m/Version:\s*(.*)/m;
+ # Did the changelog parse fail?
+ if (! defined $dh{VERSION}) {
+ error("changelog parse failure");
+ }
- # Is this a native Debian package?
- if ($dh{VERSION}=~m/.*-/) {
- $isnative_cache{$package}=0;
- }
- else {
- $isnative_cache{$package}=1;
- }
+ # Is this a native Debian package?
+ if ($dh{VERSION}=~m/.*-/) {
+ return $isnative_cache{$package}=0;
+ }
+ else {
+ return $isnative_cache{$package}=1;
}
-
- return $isnative_cache{$package};
}
}
# 2: script to add to
# 3: filename of snippet
# 4: sed to run on the snippet. Ie, s/#PACKAGE#/$PACKAGE/
-sub autoscript { my $package=shift; my $script=shift; my $filename=shift; my $sed=shift || "";
+sub autoscript {
+ my $package=shift;
+ my $script=shift;
+ my $filename=shift;
+ my $sed=shift || "";
+
# This is the file we will append to.
my $outfile="debian/".pkgext($package)."$script.debhelper";
}
}
- # TODO: do this in perl, perhaps?
complex_doit("echo \"# Automatically added by ".basename($0)."\">> $outfile");
complex_doit("sed \"$sed\" $infile >> $outfile");
complex_doit("echo '# End automatically added section' >> $outfile");
}
# Reads in the specified file, one word at a time, and returns an array of
-# the result.
-sub filearray { my $file=shift;
+# the result. If a value is passed in as the second parameter, then glob
+# expansion is done in the directory specified by the parameter ("." is
+# frequently a good choice).
+sub filearray {
+ my $file=shift;
+ my $globdir=shift;
+
my @ret;
- open (DH_FARRAY_IN,"<$file") || error("cannot read $file: $1");
+ open (DH_FARRAY_IN, $file) || error("cannot read $file: $1");
while (<DH_FARRAY_IN>) {
- push @ret,split(' ',$_);
+ # Only do glob expansion in v3 mode.
+ #
+ # The tricky bit is that the glob expansion is done
+ # as if we were in the specified directory, so the
+ # filenames that come out are relative to it.
+ if (defined $globdir && ! compat(2)) {
+ for (map { glob "$globdir/$_" } split) {
+ s#^$globdir/##;
+ push @ret, $_;
+ }
+ }
+ else {
+ push @ret, split;
+ }
}
close DH_FARRAY_IN;
# Must pass "arch" or "indep" or "same" to specify arch-dependant or
# -independant or same arch packages. If nothing is specified, returns all
# packages.
-sub GetPackages { my $type=shift;
+sub GetPackages {
+ my $type=shift;
+
$type="" if ! defined $type;
# Look up the build arch if we need to.
my $package="";
my $arch="";
my @list=();
- open (CONTROL,"<debian/control") ||
+ open (CONTROL, 'debian/control') ||
error("cannot read debian/control: $!\n");
while (<CONTROL>) {
chomp;