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
18 &inhibit_log &load_log &write_log &commit_override_log
19 &dpkg_architecture_value &sourcepackage
20 &is_make_jobserver_unavailable &clean_jobserver_makeflags
21 &cross_command &set_buildflags &get_buildoption);
28 # Check to see if an option line starts with a dash,
29 # or DH_OPTIONS is set.
30 # If so, we need to pass this off to the resource intensive
31 # Getopt::Long, which I'd prefer to avoid loading at all if possible.
32 if ((defined $ENV{DH_OPTIONS} && length $ENV{DH_OPTIONS}) ||
33 (defined $ENV{DH_INTERNAL_OPTIONS} && length $ENV{DH_INTERNAL_OPTIONS}) ||
35 eval "use Debian::Debhelper::Dh_Getopt";
37 Debian::Debhelper::Dh_Getopt::parseopts(%params);
40 # Another way to set excludes.
41 if (exists $ENV{DH_ALWAYS_EXCLUDE} && length $ENV{DH_ALWAYS_EXCLUDE}) {
42 push @{$dh{EXCLUDE}}, split(":", $ENV{DH_ALWAYS_EXCLUDE});
45 # Generate EXCLUDE_FIND.
48 foreach (@{$dh{EXCLUDE}}) {
52 $dh{EXCLUDE_FIND}.="-regex .\\*$x.\\* -or ";
54 $dh{EXCLUDE_FIND}=~s/ -or $//;
57 # Check to see if DH_VERBOSE environment variable was set, if so,
58 # make sure verbose is on.
59 if (defined $ENV{DH_VERBOSE} && $ENV{DH_VERBOSE} ne "") {
63 # Check to see if DH_NO_ACT environment variable was set, if so,
64 # make sure no act mode is on.
65 if (defined $ENV{DH_NO_ACT} && $ENV{DH_NO_ACT} ne "") {
69 # Get the name of the main binary package (first one listed in
70 # debian/control). Only if the main package was not set on the
72 if (! exists $dh{MAINPACKAGE} || ! defined $dh{MAINPACKAGE}) {
73 my @allpackages=getpackages();
74 $dh{MAINPACKAGE}=$allpackages[0];
77 # Check if packages to build have been specified, if not, fall back to
78 # the default, building all relevant packages.
79 if (! defined $dh{DOPACKAGES} || ! @{$dh{DOPACKAGES}}) {
80 push @{$dh{DOPACKAGES}}, getpackages('both');
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}});
112 my $ext=pkgext($package);
113 return "debian/${ext}debhelper.log"
118 $line="override_$ENV{DH_INTERNAL_OVERRIDE} $line"
119 if defined $ENV{DH_INTERNAL_OVERRIDE};
123 sub remove_override {
125 $line=~s/^\Qoverride_$ENV{DH_INTERNAL_OVERRIDE}\E\s+//
126 if defined $ENV{DH_INTERNAL_OVERRIDE};
131 my ($package, $db)=@_;
134 open(LOG, "<", logfile($package)) || return;
137 my $command=remove_override($_);
139 $db->{$package}{$command}=1 if defined $db;
149 return if $dh{NO_ACT};
151 foreach my $package (@packages) {
152 my $log=logfile($package);
153 open(LOG, ">>", $log) || error("failed to write to ${log}: $!");
154 print LOG add_override($cmd)."\n";
159 sub commit_override_log {
162 return if $dh{NO_ACT};
164 foreach my $package (@packages) {
165 my @log=map { remove_override($_) } load_log($package);
166 my $log=logfile($package);
167 open(LOG, ">", $log) || error("failed to write to ${log}: $!");
168 print LOG $_."\n" foreach @log;
177 # Pass it an array containing the arguments of a shell command like would
178 # be run by exec(). It turns that into a line like you might enter at the
179 # shell, escaping metacharacters and quoting arguments that contain spaces.
184 foreach my $word (@args) {
186 # Escape only a few things since it will be quoted.
187 # Note we use double quotes because you cannot
188 # escape ' in single quotes, while " can be escaped
190 # This does make -V"foo bar" turn into "-Vfoo bar",
191 # but that will be parsed identically by the shell
193 $word=~s/([\n`\$"\\])/\\$1/g;
194 push @ret, "\"$word\"";
197 # This list is from _Unix in a Nutshell_. (except '#')
198 $word=~s/([\s!"\$()*+#;<>?@\[\]\\`|~])/\\$1/g;
202 return join(' ', @ret);
205 # Run a command, and display the command to stdout if verbose mode is on.
206 # All commands that modifiy files in $TMP should be ran via this
209 # Note that this cannot handle complex commands, especially anything
210 # involving redirection. Use complex_doit instead.
212 verbose_print(escape_shell(@_));
215 system(@_) == 0 || _error_exitcode(join(" ", @_));
219 # Run a command and display the command to stdout if verbose mode is on.
220 # Use doit() if you can, instead of this function, because this function
221 # forks a shell. However, this function can handle more complicated stuff
224 verbose_print(join(" ",@_));
227 # The join makes system get a scalar so it forks off a shell.
228 system(join(" ", @_)) == 0 || _error_exitcode(join(" ", @_))
232 sub _error_exitcode {
235 error("$command failed to to execute: $!");
238 error("$command died with signal ".($? & 127));
241 error("$command returned exit code ".($? >> 8));
245 # Run a command that may have a huge number of arguments, like xargs does.
246 # Pass in a reference to an array containing the arguments, and then other
247 # parameters that are the command and any parameters that should be passed to
252 # The kernel can accept command lines up to 20k worth of characters.
253 my $command_max=20000; # LINUX SPECIFIC!!
254 # (And obsolete; it's bigger now.)
255 # I could use POSIX::ARG_MAX, but that would be slow.
257 # Figure out length of static portion of command.
260 $static_length+=length($_)+1;
264 my $length=$static_length;
266 if (length($_) + 1 + $static_length > $command_max) {
267 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? \"@_ $_\"");
269 $length+=length($_) + 1;
270 if ($length < $command_max) {
274 doit(@_,@collect) if $#collect > -1;
276 $length=$static_length + length($_) + 1;
279 doit(@_,@collect) if $#collect > -1;
282 # Print something if the verbose flag is on.
287 print "\t$message\n";
291 # Output an error message and die (can be caught).
295 die basename($0).": $message\n";
302 print STDERR basename($0).": $message\n";
305 # Returns the basename of the argument passed to it.
309 $fn=~s/\/$//g; # ignore trailing slashes
310 $fn=~s:^.*/(.*?)$:$1:;
314 # Returns the directory name of the argument passed to it.
318 $fn=~s/\/$//g; # ignore trailing slashes
319 $fn=~s:^(.*)/.*?$:$1:;
323 # Pass in a number, will return true iff the current compatibility level
324 # is less than or equal to that number.
334 if (defined $ENV{DH_COMPAT}) {
337 elsif (-e 'debian/compat') {
339 open (COMPAT_IN, "debian/compat") || error "debian/compat: $!";
342 if (! defined $l || ! length $l) {
343 warning("debian/compat is empty, assuming level $c");
352 if ($c <= 4 && ! $warned_compat) {
353 warning("Compatibility levels before 5 are deprecated.");
357 if ($c > $max_compat) {
358 error("Sorry, but $max_compat is the highest compatibility level supported by this debhelper.");
365 # Pass it a name of a binary package, it returns the name of the tmp dir to
366 # use, for that package.
373 elsif (compat(1) && $package eq $dh{MAINPACKAGE}) {
374 # This is for back-compatibility with the debian/tmp tradition.
378 return "debian/$package";
382 # Pass this the name of a binary package, and the name of the file wanted
383 # for the package, and it will return the actual existing filename to use.
385 # It tries several filenames:
386 # * debian/package.filename.buildarch
387 # * debian/package.filename.buildos
388 # * debian/package.filename
389 # * debian/filename (if the package is the main package)
390 # If --name was specified then the files
391 # must have the name after the package name:
392 # * debian/package.name.filename.buildarch
393 # * debian/package.name.filename.buildos
394 # * debian/package.name.filename
395 # * debian/name.filename (if the package is the main package)
400 if (defined $dh{NAME}) {
401 $filename="$dh{NAME}.$filename";
404 # First, check for files ending in buildarch and buildos.
406 foreach my $file (glob("debian/$package.$filename.*")) {
408 next if $dh{IGNORE} && exists $dh{IGNORE}->{$file};
409 if ($file eq "debian/$package.$filename.".buildarch()) {
411 # buildarch files are used in preference to buildos files.
414 elsif ($file eq "debian/$package.$filename.".buildos()) {
418 return $match if defined $match;
420 my @try=("debian/$package.$filename");
421 if ($package eq $dh{MAINPACKAGE}) {
422 push @try, "debian/$filename";
425 foreach my $file (@try) {
427 (! $dh{IGNORE} || ! exists $dh{IGNORE}->{$file})) {
437 # Pass it a name of a binary package, it returns the name to prefix to files
438 # in debian/ for this package.
442 if (compat(1) and $package eq $dh{MAINPACKAGE}) {
448 # Pass it the name of a binary package, it returns the name to install
449 # files by in eg, etc. Normally this is the same, but --name can override
454 if (defined $dh{NAME}) {
460 # Returns 1 if the package is a native debian package, null otherwise.
461 # As a side effect, sets $dh{VERSION} to the version of this package.
463 # Caches return code so it only needs to run dpkg-parsechangelog once.
469 return $isnative_cache{$package} if defined $isnative_cache{$package};
471 # Make sure we look at the correct changelog.
472 my $isnative_changelog=pkgfile($package,"changelog");
473 if (! $isnative_changelog) {
474 $isnative_changelog="debian/changelog";
476 # Get the package version.
477 my $version=`dpkg-parsechangelog -l$isnative_changelog`;
478 ($dh{VERSION})=$version=~m/Version:\s*(.*)/m;
479 # Did the changelog parse fail?
480 if (! defined $dh{VERSION}) {
481 error("changelog parse failure");
484 # Is this a native Debian package?
485 if ($dh{VERSION}=~m/.*-/) {
486 return $isnative_cache{$package}=0;
489 return $isnative_cache{$package}=1;
494 # Automatically add a shell script snippet to a debian script.
495 # Only works if the script has #DEBHELPER# in it.
499 # 2: script to add to
500 # 3: filename of snippet
501 # 4: sed to run on the snippet. Ie, s/#PACKAGE#/$PACKAGE/
508 # This is the file we will modify.
509 my $outfile="debian/".pkgext($package)."$script.debhelper";
511 # Figure out what shell script snippet to use.
513 if (defined($ENV{DH_AUTOSCRIPTDIR}) &&
514 -e "$ENV{DH_AUTOSCRIPTDIR}/$filename") {
515 $infile="$ENV{DH_AUTOSCRIPTDIR}/$filename";
518 if (-e "/usr/share/debhelper/autoscripts/$filename") {
519 $infile="/usr/share/debhelper/autoscripts/$filename";
522 error("/usr/share/debhelper/autoscripts/$filename does not exist");
526 if (-e $outfile && ($script eq 'postrm' || $script eq 'prerm')
528 # Add fragments to top so they run in reverse order when removing.
529 complex_doit("echo \"# Automatically added by ".basename($0)."\"> $outfile.new");
530 complex_doit("sed \"$sed\" $infile >> $outfile.new");
531 complex_doit("echo '# End automatically added section' >> $outfile.new");
532 complex_doit("cat $outfile >> $outfile.new");
533 complex_doit("mv $outfile.new $outfile");
536 complex_doit("echo \"# Automatically added by ".basename($0)."\">> $outfile");
537 complex_doit("sed \"$sed\" $infile >> $outfile");
538 complex_doit("echo '# End automatically added section' >> $outfile");
542 # Removes a whole substvar line.
547 my $ext=pkgext($package);
548 my $substvarfile="debian/${ext}substvars";
550 if (-e $substvarfile) {
551 complex_doit("grep -s -v '^${substvar}=' $substvarfile > $substvarfile.new || true");
552 doit("mv", "$substvarfile.new","$substvarfile");
556 # Adds a dependency on some package to the specified
557 # substvar in a package's substvar's file.
561 my $deppackage=shift;
565 my $ext=pkgext($package);
566 my $substvarfile="debian/${ext}substvars";
568 $str.=" ($verinfo)" if defined $verinfo && length $verinfo;
570 # Figure out what the line will look like, based on what's there
571 # now, and what we're to add or remove.
573 if (-e $substvarfile) {
575 open(SUBSTVARS_IN, "$substvarfile") || error "read $substvarfile: $!";
576 while (<SUBSTVARS_IN>) {
578 if (/^\Q$substvar\E=(.*)/) {
579 %items = map { $_ => 1} split(", ", $1);
591 $line=join(", ", sort keys %items);
598 complex_doit("(grep -s -v ${substvar} $substvarfile; echo ".escape_shell("${substvar}=$line").") > $substvarfile.new");
599 doit("mv", "$substvarfile.new", $substvarfile);
602 delsubstvar($package,$substvar);
606 # Reads in the specified file, one line at a time. splits on words,
607 # and returns an array of arrays of the contents.
608 # If a value is passed in as the second parameter, then glob
609 # expansion is done in the directory specified by the parameter ("." is
610 # frequently a good choice).
611 sub filedoublearray {
616 open (DH_FARRAY_IN, $file) || error("cannot read $file: $!");
617 while (<DH_FARRAY_IN>) {
619 # Only ignore comments and empty lines in v5 mode.
621 next if /^#/ || /^$/;
624 # Only do glob expansion in v3 mode.
626 # The tricky bit is that the glob expansion is done
627 # as if we were in the specified directory, so the
628 # filenames that come out are relative to it.
629 if (defined $globdir && ! compat(2)) {
630 foreach (map { glob "$globdir/$_" } split) {
645 # Reads in the specified file, one word at a time, and returns an array of
646 # the result. Can do globbing as does filedoublearray.
648 return map { @$_ } filedoublearray(@_);
651 # Passed a filename, returns true if -X says that file should be excluded.
653 my $filename = shift;
654 foreach my $f (@{$dh{EXCLUDE}}) {
655 return 1 if $filename =~ /\Q$f\E/;
661 my %dpkg_arch_output;
662 sub dpkg_architecture_value {
664 if (! exists($dpkg_arch_output{$var})) {
666 open(PIPE, '-|', 'dpkg-architecture')
667 or error("dpkg-architecture failed");
670 my ($k, $v) = split(/=/, $_, 2);
671 $dpkg_arch_output{$k} = $v;
675 return $dpkg_arch_output{$var};
679 # Returns the build architecture.
681 dpkg_architecture_value('DEB_HOST_ARCH');
684 # Returns the build OS.
686 dpkg_architecture_value("DEB_HOST_ARCH_OS");
689 # Passed an arch and a list of arches to match against, returns true if matched
695 my @archlist=split(/\s+/,shift);
697 foreach my $a (@archlist) {
698 # Avoid expensive dpkg-architecture call to compare
699 # with a simple architecture name. "linux-any" and
700 # other architecture wildcards are (currently)
703 return 1 if $arch eq $a;
705 elsif (exists $knownsame{$arch}{$a}) {
706 return 1 if $knownsame{$arch}{$a};
708 elsif (system("dpkg-architecture", "-a$arch", "-i$a") == 0) {
709 return $knownsame{$arch}{$a}=1;
712 $knownsame{$arch}{$a}=0;
720 # Returns source package name
722 open (CONTROL, 'debian/control') ||
723 error("cannot read debian/control: $!\n");
727 if (/^Source:\s*(.*)/) {
734 error("could not find Source: line in control file.");
737 # Returns a list of packages in the control file.
738 # Pass "arch" or "indep" to specify arch-dependant (that will be built
739 # for the system's arch) or independant. If nothing is specified,
740 # returns all packages. Also, "both" returns the union of "arch" and "indep"
742 # As a side effect, populates %package_arches and %package_types with the
743 # types of all packages (not only those returned).
744 my (%package_types, %package_arches);
751 $type="" if ! defined $type;
758 open (CONTROL, 'debian/control') ||
759 error("cannot read debian/control: $!\n");
763 if (/^Package:\s*(.*)/) {
765 # Detect duplicate package names in the same control file.
766 if (! $seen{$package}) {
770 error("debian/control has a duplicate entry for $package");
774 if (/^Architecture:\s*(.*)/) {
777 if (/^(?:X[BC]*-)?Package-Type:\s*(.*)/) {
781 if (!$_ or eof) { # end of stanza.
783 $package_types{$package}=$package_type;
784 $package_arches{$package}=$arch;
788 ((($type eq 'indep' || $type eq 'both') && $arch eq 'all') ||
789 (($type eq 'arch' || $type eq 'both') && ($arch eq 'any' ||
791 samearch(buildarch(), $arch)))) ||
793 push @list, $package;
804 # Returns the arch a package will build for.
808 if (! exists $package_arches{$package}) {
809 warning "package $package is not in control info";
812 return $package_arches{$package} eq 'all' ? "all" : buildarch();
815 # Return true if a given package is really a udeb.
819 if (! exists $package_types{$package}) {
820 warning "package $package is not in control info";
823 return $package_types{$package} eq 'udeb';
826 # Generates the filename that is used for a udeb package.
830 my $filearch=package_arch($package);
831 isnative($package); # side effect
832 my $version=$dh{VERSION};
833 $version=~s/^[0-9]+://; # strip any epoch
834 return "${package}_${version}_$filearch.udeb";
837 # Handles #DEBHELPER# substitution in a script; also can generate a new
838 # script from scratch if none exists but there is a .debhelper file for it.
839 sub debhelper_script_subst {
843 my $tmp=tmpdir($package);
844 my $ext=pkgext($package);
845 my $file=pkgfile($package,$script);
848 if (-f "debian/$ext$script.debhelper") {
849 # Add this into the script, where it has #DEBHELPER#
850 complex_doit("perl -pe 's~#DEBHELPER#~qx{cat debian/$ext$script.debhelper}~eg' < $file > $tmp/DEBIAN/$script");
853 # Just get rid of any #DEBHELPER# in the script.
854 complex_doit("sed s/#DEBHELPER#// < $file > $tmp/DEBIAN/$script");
856 doit("chown","0:0","$tmp/DEBIAN/$script");
857 doit("chmod",755,"$tmp/DEBIAN/$script");
859 elsif ( -f "debian/$ext$script.debhelper" ) {
860 complex_doit("printf '#!/bin/sh\nset -e\n' > $tmp/DEBIAN/$script");
861 complex_doit("cat debian/$ext$script.debhelper >> $tmp/DEBIAN/$script");
862 doit("chown","0:0","$tmp/DEBIAN/$script");
863 doit("chmod",755,"$tmp/DEBIAN/$script");
867 # Checks if make's jobserver is enabled via MAKEFLAGS, but
868 # the FD used to communicate with it is actually not available.
869 sub is_make_jobserver_unavailable {
870 if (exists $ENV{MAKEFLAGS} &&
871 $ENV{MAKEFLAGS} =~ /(?:^|\s)--jobserver-fds=(\d+)/) {
872 if (!open(my $in, "<&$1")) {
873 return 1; # unavailable
877 return 0; # available
881 return; # no jobserver specified
884 # Cleans out jobserver options from MAKEFLAGS.
885 sub clean_jobserver_makeflags {
886 if (exists $ENV{MAKEFLAGS}) {
887 if ($ENV{MAKEFLAGS} =~ /(?:^|\s)--jobserver-fds=(\d+)/) {
888 $ENV{MAKEFLAGS} =~ s/(?:^|\s)--jobserver-fds=\S+//g;
889 $ENV{MAKEFLAGS} =~ s/(?:^|\s)-j\b//g;
891 delete $ENV{MAKEFLAGS} if $ENV{MAKEFLAGS} =~ /^\s*$/;
895 # If cross-compiling, returns appropriate cross version of command.
898 if (dpkg_architecture_value("DEB_BUILD_GNU_TYPE")
899 ne dpkg_architecture_value("DEB_HOST_GNU_TYPE")) {
900 return dpkg_architecture_value("DEB_HOST_GNU_TYPE")."-$command";
907 # Sets environment variables from dpkg-buildflags. Avoids changing
908 # any existing environment variables.
910 return if $ENV{DH_INTERNAL_BUILDFLAGS} || compat(8);
911 $ENV{DH_INTERNAL_BUILDFLAGS}=1;
913 eval "use Dpkg::BuildFlags";
915 warning "unable to load build flags: $@";
919 my $buildflags = Dpkg::BuildFlags->new();
920 $buildflags->load_config();
921 foreach my $flag ($buildflags->list()) {
922 next unless $flag =~ /^[A-Z]/; # Skip flags starting with lowercase
923 if (! exists $ENV{$flag}) {
924 $ENV{$flag} = $buildflags->get($flag);
929 # Gets a DEB_BUILD_OPTIONS option, if set.
930 sub get_buildoption {
933 return undef unless exists $ENV{DEB_BUILD_OPTIONS};
935 foreach my $opt (split(/\s+/, $ENV{DEB_BUILD_OPTIONS})) {
936 # currently parallel= is the only one with a parameter
937 if ($opt =~ /^parallel=(-?\d+)$/ && $wanted eq 'parallel') {
940 elsif ($opt eq $wanted) {