3 # Library functions for debhelper programs, perl version.
5 # Joey Hess, GPL copyright 1997-2008.
7 package Debian::Debhelper::Dh_Lib;
11 use vars qw(@ISA @EXPORT %dh);
13 @EXPORT=qw(&init &doit &complex_doit &verbose_print &error &warning &tmpdir
14 &pkgfile &pkgext &pkgfilename &isnative &autoscript &filearray
15 &filedoublearray &getpackages &basename &dirname &xargs %dh
16 &compat &addsubstvar &delsubstvar &excludefile &package_arch
17 &is_udeb &udeb_filename &debhelper_script_subst &escape_shell
25 # Check to see if an option line starts with a dash,
26 # or DH_OPTIONS is set.
27 # If so, we need to pass this off to the resource intensive
28 # Getopt::Long, which I'd prefer to avoid loading at all if possible.
29 if ((defined $ENV{DH_OPTIONS} && length $ENV{DH_OPTIONS}) ||
30 (defined $ENV{DH_INTERNAL_OPTIONS} && length $ENV{DH_INTERNAL_OPTIONS}) ||
32 eval "use Debian::Debhelper::Dh_Getopt";
34 Debian::Debhelper::Dh_Getopt::parseopts($params{options});
37 # Another way to set excludes.
38 if (exists $ENV{DH_ALWAYS_EXCLUDE} && length $ENV{DH_ALWAYS_EXCLUDE}) {
39 push @{$dh{EXCLUDE}}, split(":", $ENV{DH_ALWAYS_EXCLUDE});
42 # Generate EXCLUDE_FIND.
45 foreach (@{$dh{EXCLUDE}}) {
49 $dh{EXCLUDE_FIND}.="-regex .\\*$x.\\* -or ";
51 $dh{EXCLUDE_FIND}=~s/ -or $//;
54 # Check to see if DH_VERBOSE environment variable was set, if so,
55 # make sure verbose is on.
56 if (defined $ENV{DH_VERBOSE} && $ENV{DH_VERBOSE} ne "") {
60 # Check to see if DH_NO_ACT environment variable was set, if so,
61 # make sure no act mode is on.
62 if (defined $ENV{DH_NO_ACT} && $ENV{DH_NO_ACT} ne "") {
66 my @allpackages=getpackages();
67 # Get the name of the main binary package (first one listed in
68 # debian/control). Only if the main package was not set on the
70 if (! exists $dh{MAINPACKAGE} || ! defined $dh{MAINPACKAGE}) {
71 $dh{MAINPACKAGE}=$allpackages[0];
74 # Check if packages to build have been specified, if not, fall back to
75 # the default, doing them all.
76 if (! defined $dh{DOPACKAGES} || ! @{$dh{DOPACKAGES}}) {
77 if ($dh{DOINDEP} || $dh{DOARCH} || $dh{DOSAME}) {
78 error("You asked that all arch in(dep) packages be built, but there are none of that type.");
80 push @{$dh{DOPACKAGES}},@allpackages;
83 # Check to see if -P was specified. If so, we can only act on a single
85 if ($dh{TMPDIR} && $#{$dh{DOPACKAGES}} > 0) {
86 error("-P was specified, but multiple packages would be acted on (".join(",",@{$dh{DOPACKAGES}}).").");
89 # Figure out which package is the first one we were instructed to build.
90 # This package gets special treatement: files and directories specified on
91 # the command line may affect it.
92 $dh{FIRSTPACKAGE}=${$dh{DOPACKAGES}}[0];
94 # If no error handling function was specified, just propigate
96 if (! exists $dh{ERROR_HANDLER} || ! defined $dh{ERROR_HANDLER}) {
97 $dh{ERROR_HANDLER}='exit \$?';
101 # Run at exit. Add the command to the log files for the packages it acted
102 # on, if it's exiting successfully.
105 if ($? == 0 && $write_log) {
106 write_log(basename($0), @{$dh{DOPACKAGES}});
114 foreach my $package (@packages) {
115 my $ext=pkgext($package);
116 my $log="debian/${ext}debhelper.log";
117 open(LOG, ">>", $log) || error("failed to write to ${log}: $!");
127 # Pass it an array containing the arguments of a shell command like would
128 # be run by exec(). It turns that into a line like you might enter at the
129 # shell, escaping metacharacters and quoting arguments that contain spaces.
134 foreach my $word (@args) {
136 # Escape only a few things since it will be quoted.
137 # Note we use double quotes because you cannot
138 # escape ' in single quotes, while " can be escaped
140 # This does make -V"foo bar" turn into "-Vfoo bar",
141 # but that will be parsed identically by the shell
143 $word=~s/([\n`\$"\\])/\\$1/g;
144 push @ret, "\"$word\"";
147 # This list is from _Unix in a Nutshell_. (except '#')
148 $word=~s/([\s!"\$()*+#;<>?@\[\]\\`|~])/\\$1/g;
152 return join(' ', @ret);
155 # Run a command, and display the command to stdout if verbose mode is on.
156 # All commands that modifiy files in $TMP should be ran via this
159 # Note that this cannot handle complex commands, especially anything
160 # involving redirection. Use complex_doit instead.
162 verbose_print(escape_shell(@_));
165 system(@_) == 0 || _error_exitcode($_[0]);
169 # Run a command and display the command to stdout if verbose mode is on.
170 # Use doit() if you can, instead of this function, because this function
171 # forks a shell. However, this function can handle more complicated stuff
174 verbose_print(join(" ",@_));
177 # The join makes system get a scalar so it forks off a shell.
178 system(join(" ", @_)) == 0 || _error_exitcode(join(" ", @_))
182 sub _error_exitcode {
185 error("$command failed to to execute: $!");
188 error("$command died with signal ".($? & 127));
191 error("$command returned exit code ".($? >> 8));
195 # Run a command that may have a huge number of arguments, like xargs does.
196 # Pass in a reference to an array containing the arguments, and then other
197 # parameters that are the command and any parameters that should be passed to
202 # The kernel can accept command lines up to 20k worth of characters.
203 my $command_max=20000; # LINUX SPECIFIC!!
204 # I could use POSIX::ARG_MAX, but that would be slow.
206 # Figure out length of static portion of command.
209 $static_length+=length($_)+1;
213 my $length=$static_length;
215 if (length($_) + 1 + $static_length > $command_max) {
216 error("This command is greater than the maximum command size allowed by the kernel, and cannot be split up further. What on earth are you doing? \"@_ $_\"");
218 $length+=length($_) + 1;
219 if ($length < $command_max) {
223 doit(@_,@collect) if $#collect > -1;
225 $length=$static_length + length($_) + 1;
228 doit(@_,@collect) if $#collect > -1;
231 # Print something if the verbose flag is on.
236 print "\t$message\n";
240 # Output an error message and exit.
252 print STDERR basename($0).": $message\n";
255 # Returns the basename of the argument passed to it.
259 $fn=~s/\/$//g; # ignore trailing slashes
260 $fn=~s:^.*/(.*?)$:$1:;
264 # Returns the directory name of the argument passed to it.
268 $fn=~s/\/$//g; # ignore trailing slashes
269 $fn=~s:^(.*)/.*?$:$1:;
273 # Pass in a number, will return true iff the current compatibility level
274 # is less than or equal to that number.
284 if (defined $ENV{DH_COMPAT}) {
287 elsif (-e 'debian/compat') {
289 open (COMPAT_IN, "debian/compat") || error "debian/compat: $!";
291 if (! defined $l || ! length $l) {
292 warning("debian/compat is empty, assuming level $c");
301 if ($c < 4 && ! $warned_compat) {
302 warning("Compatibility levels before 4 are deprecated.");
306 if ($c > $max_compat) {
307 error("Sorry, but $max_compat is the highest compatibility level supported by this debhelper.");
314 # Pass it a name of a binary package, it returns the name of the tmp dir to
315 # use, for that package.
322 elsif (compat(1) && $package eq $dh{MAINPACKAGE}) {
323 # This is for back-compatibility with the debian/tmp tradition.
327 return "debian/$package";
331 # Pass this the name of a binary package, and the name of the file wanted
332 # for the package, and it will return the actual existing filename to use.
334 # It tries several filenames:
335 # * debian/package.filename.buildarch
336 # * debian/package.filename
337 # * debian/file (if the package is the main package)
338 # If --name was specified then tonly the first two are tried, and they must
339 # have the name after the pacage name:
340 # * debian/package.name.filename.buildarch
341 # * debian/package.name.filename
346 if (defined $dh{NAME}) {
347 $filename="$dh{NAME}.$filename";
350 my @try=("debian/$package.$filename.".buildarch(),
351 "debian/$package.$filename");
352 if ($package eq $dh{MAINPACKAGE}) {
353 push @try, "debian/$filename";
356 foreach my $file (@try) {
358 (! $dh{IGNORE} || ! exists $dh{IGNORE}->{$file})) {
368 # Pass it a name of a binary package, it returns the name to prefix to files
369 # in debian/ for this package.
373 if (compat(1) and $package eq $dh{MAINPACKAGE}) {
379 # Pass it the name of a binary package, it returns the name to install
380 # files by in eg, etc. Normally this is the same, but --name can override
385 if (defined $dh{NAME}) {
391 # Returns 1 if the package is a native debian package, null otherwise.
392 # As a side effect, sets $dh{VERSION} to the version of this package.
394 # Caches return code so it only needs to run dpkg-parsechangelog once.
400 return $isnative_cache{$package} if defined $isnative_cache{$package};
402 # Make sure we look at the correct changelog.
403 my $isnative_changelog=pkgfile($package,"changelog");
404 if (! $isnative_changelog) {
405 $isnative_changelog="debian/changelog";
407 # Get the package version.
408 my $version=`dpkg-parsechangelog -l$isnative_changelog`;
409 ($dh{VERSION})=$version=~m/Version:\s*(.*)/m;
410 # Did the changelog parse fail?
411 if (! defined $dh{VERSION}) {
412 error("changelog parse failure");
415 # Is this a native Debian package?
416 if ($dh{VERSION}=~m/.*-/) {
417 return $isnative_cache{$package}=0;
420 return $isnative_cache{$package}=1;
425 # Automatically add a shell script snippet to a debian script.
426 # Only works if the script has #DEBHELPER# in it.
430 # 2: script to add to
431 # 3: filename of snippet
432 # 4: sed to run on the snippet. Ie, s/#PACKAGE#/$PACKAGE/
439 # This is the file we will modify.
440 my $outfile="debian/".pkgext($package)."$script.debhelper";
442 # Figure out what shell script snippet to use.
444 if (defined($ENV{DH_AUTOSCRIPTDIR}) &&
445 -e "$ENV{DH_AUTOSCRIPTDIR}/$filename") {
446 $infile="$ENV{DH_AUTOSCRIPTDIR}/$filename";
449 if (-e "/usr/share/debhelper/autoscripts/$filename") {
450 $infile="/usr/share/debhelper/autoscripts/$filename";
453 error("/usr/share/debhelper/autoscripts/$filename does not exist");
457 if (-e $outfile && ($script eq 'postrm' || $script eq 'prerm')
459 # Add fragments to top so they run in reverse order when removing.
460 complex_doit("echo \"# Automatically added by ".basename($0)."\"> $outfile.new");
461 complex_doit("sed \"$sed\" $infile >> $outfile.new");
462 complex_doit("echo '# End automatically added section' >> $outfile.new");
463 complex_doit("cat $outfile >> $outfile.new");
464 complex_doit("mv $outfile.new $outfile");
467 complex_doit("echo \"# Automatically added by ".basename($0)."\">> $outfile");
468 complex_doit("sed \"$sed\" $infile >> $outfile");
469 complex_doit("echo '# End automatically added section' >> $outfile");
473 # Removes a whole substvar line.
478 my $ext=pkgext($package);
479 my $substvarfile="debian/${ext}substvars";
481 if (-e $substvarfile) {
482 complex_doit("grep -s -v '^${substvar}=' $substvarfile > $substvarfile.new || true");
483 doit("mv", "$substvarfile.new","$substvarfile");
487 # Adds a dependency on some package to the specified
488 # substvar in a package's substvar's file.
492 my $deppackage=shift;
496 my $ext=pkgext($package);
497 my $substvarfile="debian/${ext}substvars";
499 $str.=" ($verinfo)" if defined $verinfo && length $verinfo;
501 # Figure out what the line will look like, based on what's there
502 # now, and what we're to add or remove.
504 if (-e $substvarfile) {
506 open(SUBSTVARS_IN, "$substvarfile") || error "read $substvarfile: $!";
507 while (<SUBSTVARS_IN>) {
509 if (/^\Q$substvar\E=(.*)/) {
510 %items = map { $_ => 1} split(", ", $1);
522 $line=join(", ", sort keys %items);
529 complex_doit("(grep -s -v ${substvar} $substvarfile; echo ".escape_shell("${substvar}=$line").") > $substvarfile.new");
530 doit("mv", "$substvarfile.new", $substvarfile);
533 delsubstvar($package,$substvar);
537 # Reads in the specified file, one line at a time. splits on words,
538 # and returns an array of arrays of the contents.
539 # If a value is passed in as the second parameter, then glob
540 # expansion is done in the directory specified by the parameter ("." is
541 # frequently a good choice).
542 sub filedoublearray {
547 open (DH_FARRAY_IN, $file) || error("cannot read $file: $1");
548 while (<DH_FARRAY_IN>) {
550 # Only ignore comments and empty lines in v5 mode.
552 next if /^#/ || /^$/;
555 # Only do glob expansion in v3 mode.
557 # The tricky bit is that the glob expansion is done
558 # as if we were in the specified directory, so the
559 # filenames that come out are relative to it.
560 if (defined $globdir && ! compat(2)) {
561 for (map { glob "$globdir/$_" } split) {
576 # Reads in the specified file, one word at a time, and returns an array of
577 # the result. Can do globbing as does filedoublearray.
579 return map { @$_ } filedoublearray(@_);
582 # Passed a filename, returns true if -X says that file should be excluded.
584 my $filename = shift;
585 foreach my $f (@{$dh{EXCLUDE}}) {
586 return 1 if $filename =~ /\Q$f\E/;
591 # Returns the build architecture. (Memoized)
596 return $arch if defined $arch;
598 $arch=`dpkg-architecture -qDEB_HOST_ARCH 2>/dev/null` || error("dpkg-architecture failed");
604 # Passed an arch and a list of arches to match against, returns true if matched
607 my @archlist=split(/\s+/,shift);
609 foreach my $a (@archlist) {
610 system("dpkg-architecture", "-a$arch", "-i$a") == 0 && return 1;
616 # Returns a list of packages in the control file.
617 # Must pass "arch" or "indep" or "same" to specify arch-dependant or
618 # -independant or same arch packages. If nothing is specified, returns all
620 # As a side effect, populates %package_arches and %package_types with the
621 # types of all packages (not only those returned).
622 my (%package_types, %package_arches);
629 $type="" if ! defined $type;
631 # Look up the build arch if we need to.
633 if ($type eq 'same') {
634 $buildarch=buildarch();
642 open (CONTROL, 'debian/control') ||
643 error("cannot read debian/control: $!\n");
647 if (/^Package:\s*(.*)/) {
649 # Detect duplicate package names in the same control file.
650 if (! $seen{$package}) {
654 error("debian/control has a duplicate entry for $package");
658 if (/^Architecture:\s*(.*)/) {
661 if (/^(?:X[BC]*-)?Package-Type:\s*(.*)/) {
665 if (!$_ or eof) { # end of stanza.
667 $package_types{$package}=$package_type;
668 $package_arches{$package}=$arch;
671 (($type eq 'indep' && $arch eq 'all') ||
672 ($type eq 'arch' && $arch ne 'all') ||
673 ($type eq 'same' && ($arch eq 'any' || samearch($buildarch, $arch))) ||
675 push @list, $package;
686 # Returns the arch a package will build for.
690 if (! exists $package_arches{$package}) {
691 warning "package $package is not in control info";
694 return $package_arches{$package} eq 'all' ? "all" : buildarch();
697 # Return true if a given package is really a udeb.
701 if (! exists $package_types{$package}) {
702 warning "package $package is not in control info";
705 return $package_types{$package} eq 'udeb';
708 # Generates the filename that is used for a udeb package.
712 my $filearch=package_arch($package);
713 isnative($package); # side effect
714 my $version=$dh{VERSION};
715 $version=~s/^[0-9]+://; # strip any epoch
716 return "${package}_${version}_$filearch.udeb";
719 # Handles #DEBHELPER# substitution in a script; also can generate a new
720 # script from scratch if none exists but there is a .debhelper file for it.
721 sub debhelper_script_subst {
725 my $tmp=tmpdir($package);
726 my $ext=pkgext($package);
727 my $file=pkgfile($package,$script);
730 if (-f "debian/$ext$script.debhelper") {
731 # Add this into the script, where it has #DEBHELPER#
732 complex_doit("perl -pe 's~#DEBHELPER#~qx{cat debian/$ext$script.debhelper}~eg' < $file > $tmp/DEBIAN/$script");
735 # Just get rid of any #DEBHELPER# in the script.
736 complex_doit("sed s/#DEBHELPER#// < $file > $tmp/DEBIAN/$script");
738 doit("chown","0:0","$tmp/DEBIAN/$script");
739 doit("chmod",755,"$tmp/DEBIAN/$script");
741 elsif ( -f "debian/$ext$script.debhelper" ) {
742 complex_doit("printf '#!/bin/sh\nset -e\n' > $tmp/DEBIAN/$script");
743 complex_doit("cat debian/$ext$script.debhelper >> $tmp/DEBIAN/$script");
744 doit("chown","0:0","$tmp/DEBIAN/$script");
745 doit("chmod",755,"$tmp/DEBIAN/$script");