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 &dpkg_architecture_value
19 &sourcepackage &get_make_jobserver_status);
26 # Check to see if an option line starts with a dash,
27 # or DH_OPTIONS is set.
28 # If so, we need to pass this off to the resource intensive
29 # Getopt::Long, which I'd prefer to avoid loading at all if possible.
30 if ((defined $ENV{DH_OPTIONS} && length $ENV{DH_OPTIONS}) ||
31 (defined $ENV{DH_INTERNAL_OPTIONS} && length $ENV{DH_INTERNAL_OPTIONS}) ||
33 eval "use Debian::Debhelper::Dh_Getopt";
35 Debian::Debhelper::Dh_Getopt::parseopts($params{options});
38 # Another way to set excludes.
39 if (exists $ENV{DH_ALWAYS_EXCLUDE} && length $ENV{DH_ALWAYS_EXCLUDE}) {
40 push @{$dh{EXCLUDE}}, split(":", $ENV{DH_ALWAYS_EXCLUDE});
43 # Generate EXCLUDE_FIND.
46 foreach (@{$dh{EXCLUDE}}) {
50 $dh{EXCLUDE_FIND}.="-regex .\\*$x.\\* -or ";
52 $dh{EXCLUDE_FIND}=~s/ -or $//;
55 # Check to see if DH_VERBOSE environment variable was set, if so,
56 # make sure verbose is on.
57 if (defined $ENV{DH_VERBOSE} && $ENV{DH_VERBOSE} ne "") {
61 # Check to see if DH_NO_ACT environment variable was set, if so,
62 # make sure no act mode is on.
63 if (defined $ENV{DH_NO_ACT} && $ENV{DH_NO_ACT} ne "") {
67 my @allpackages=getpackages();
68 # Get the name of the main binary package (first one listed in
69 # debian/control). Only if the main package was not set on the
71 if (! exists $dh{MAINPACKAGE} || ! defined $dh{MAINPACKAGE}) {
72 $dh{MAINPACKAGE}=$allpackages[0];
75 # Check if packages to build have been specified, if not, fall back to
76 # the default, doing them all.
77 if (! defined $dh{DOPACKAGES} || ! @{$dh{DOPACKAGES}}) {
78 push @{$dh{DOPACKAGES}},@allpackages;
81 # Check to see if -P was specified. If so, we can only act on a single
83 if ($dh{TMPDIR} && $#{$dh{DOPACKAGES}} > 0) {
84 error("-P was specified, but multiple packages would be acted on (".join(",",@{$dh{DOPACKAGES}}).").");
87 # Figure out which package is the first one we were instructed to build.
88 # This package gets special treatement: files and directories specified on
89 # the command line may affect it.
90 $dh{FIRSTPACKAGE}=${$dh{DOPACKAGES}}[0];
92 # If no error handling function was specified, just propigate
94 if (! exists $dh{ERROR_HANDLER} || ! defined $dh{ERROR_HANDLER}) {
95 $dh{ERROR_HANDLER}='exit \$?';
99 # Run at exit. Add the command to the log files for the packages it acted
100 # on, if it's exiting successfully.
103 if ($? == 0 && $write_log) {
104 write_log(basename($0), @{$dh{DOPACKAGES}});
109 my ($package, $db)=@_;
110 my $ext=pkgext($package);
113 open(LOG, "<", "debian/${ext}debhelper.log") || return;
117 $db->{$package}{$_}=1 if defined $db;
127 foreach my $package (@packages) {
128 my $ext=pkgext($package);
129 my $log="debian/${ext}debhelper.log";
130 open(LOG, ">>", $log) || error("failed to write to ${log}: $!");
140 # Pass it an array containing the arguments of a shell command like would
141 # be run by exec(). It turns that into a line like you might enter at the
142 # shell, escaping metacharacters and quoting arguments that contain spaces.
147 foreach my $word (@args) {
149 # Escape only a few things since it will be quoted.
150 # Note we use double quotes because you cannot
151 # escape ' in single quotes, while " can be escaped
153 # This does make -V"foo bar" turn into "-Vfoo bar",
154 # but that will be parsed identically by the shell
156 $word=~s/([\n`\$"\\])/\\$1/g;
157 push @ret, "\"$word\"";
160 # This list is from _Unix in a Nutshell_. (except '#')
161 $word=~s/([\s!"\$()*+#;<>?@\[\]\\`|~])/\\$1/g;
165 return join(' ', @ret);
168 # Run a command, and display the command to stdout if verbose mode is on.
169 # All commands that modifiy files in $TMP should be ran via this
172 # Note that this cannot handle complex commands, especially anything
173 # involving redirection. Use complex_doit instead.
175 verbose_print(escape_shell(@_));
178 system(@_) == 0 || _error_exitcode(join(" ", @_));
182 # Run a command and display the command to stdout if verbose mode is on.
183 # Use doit() if you can, instead of this function, because this function
184 # forks a shell. However, this function can handle more complicated stuff
187 verbose_print(join(" ",@_));
190 # The join makes system get a scalar so it forks off a shell.
191 system(join(" ", @_)) == 0 || _error_exitcode(join(" ", @_))
195 sub _error_exitcode {
198 error("$command failed to to execute: $!");
201 error("$command died with signal ".($? & 127));
204 error("$command returned exit code ".($? >> 8));
208 # A helper subroutine for detecting (based on MAKEFLAGS) if make jobserver
209 # is enabled, if it is available or MAKEFLAGS contains "jobs" option.
210 # It returns current status (jobserver, jobserver-unavailable or jobs-N where
211 # N is number of jobs, 0 if infinite) and MAKEFLAGS cleaned up from
212 # job control options.
213 sub get_make_jobserver_status {
214 my $jobsre = qr/(?:^|\s)(?:(?:-j\s*|--jobs(?:=|\s+))(\d+)?|--jobs)\b/;
218 if (exists $ENV{MAKEFLAGS}) {
219 $makeflags = $ENV{MAKEFLAGS};
220 if ($makeflags =~ /(?:^|\s)--jobserver-fds=(\d+)/) {
221 $status = "jobserver";
222 if (!open(my $in, "<&", "$1")) {
223 # Job server is unavailable
224 $status .= "-unavailable";
230 $makeflags =~ s/(?:^|\s)--jobserver-fds=\S+//g;
231 $makeflags =~ s/(?:^|\s)-j\b//g;
233 elsif (my @m = ($makeflags =~ /$jobsre/g)) {
234 # Job count is specified in MAKEFLAGS. Whenever make reads it, a new
235 # jobserver will be started. Job count returned is 0 if infinite.
236 $status = "jobs-" . (defined $m[$#m] ? $m[$#m] : "0");
237 # Clean makeflags up from "jobs" option(s)
238 $makeflags =~ s/$jobsre//g;
242 # MAKEFLAGS could be unset if it is empty
243 $makeflags = undef if $makeflags =~ /^\s*$/;
245 return wantarray ? ($status, $makeflags) : $status;
248 # Run a command that may have a huge number of arguments, like xargs does.
249 # Pass in a reference to an array containing the arguments, and then other
250 # parameters that are the command and any parameters that should be passed to
255 # The kernel can accept command lines up to 20k worth of characters.
256 my $command_max=20000; # LINUX SPECIFIC!!
257 # I could use POSIX::ARG_MAX, but that would be slow.
259 # Figure out length of static portion of command.
262 $static_length+=length($_)+1;
266 my $length=$static_length;
268 if (length($_) + 1 + $static_length > $command_max) {
269 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? \"@_ $_\"");
271 $length+=length($_) + 1;
272 if ($length < $command_max) {
276 doit(@_,@collect) if $#collect > -1;
278 $length=$static_length + length($_) + 1;
281 doit(@_,@collect) if $#collect > -1;
284 # Print something if the verbose flag is on.
289 print "\t$message\n";
293 # Output an error message and exit.
305 print STDERR basename($0).": $message\n";
308 # Returns the basename of the argument passed to it.
312 $fn=~s/\/$//g; # ignore trailing slashes
313 $fn=~s:^.*/(.*?)$:$1:;
317 # Returns the directory name of the argument passed to it.
321 $fn=~s/\/$//g; # ignore trailing slashes
322 $fn=~s:^(.*)/.*?$:$1:;
326 # Pass in a number, will return true iff the current compatibility level
327 # is less than or equal to that number.
337 if (defined $ENV{DH_COMPAT}) {
340 elsif (-e 'debian/compat') {
342 open (COMPAT_IN, "debian/compat") || error "debian/compat: $!";
345 if (! defined $l || ! length $l) {
346 warning("debian/compat is empty, assuming level $c");
355 if ($c < 4 && ! $warned_compat) {
356 warning("Compatibility levels before 5 are deprecated.");
360 if ($c > $max_compat) {
361 error("Sorry, but $max_compat is the highest compatibility level supported by this debhelper.");
368 # Pass it a name of a binary package, it returns the name of the tmp dir to
369 # use, for that package.
376 elsif (compat(1) && $package eq $dh{MAINPACKAGE}) {
377 # This is for back-compatibility with the debian/tmp tradition.
381 return "debian/$package";
385 # Pass this the name of a binary package, and the name of the file wanted
386 # for the package, and it will return the actual existing filename to use.
388 # It tries several filenames:
389 # * debian/package.filename.buildarch
390 # * debian/package.filename.buildos
391 # * debian/package.filename
392 # * debian/filename (if the package is the main package)
393 # If --name was specified then the files
394 # must have the name after the package name:
395 # * debian/package.name.filename.buildarch
396 # * debian/package.name.filename.buildos
397 # * debian/package.name.filename
398 # * debian/name.filename (if the package is the main package)
403 if (defined $dh{NAME}) {
404 $filename="$dh{NAME}.$filename";
407 my @try=("debian/$package.$filename.".buildarch(),
408 "debian/$package.$filename.".buildos(),
409 "debian/$package.$filename");
410 if ($package eq $dh{MAINPACKAGE}) {
411 push @try, "debian/$filename";
414 foreach my $file (@try) {
416 (! $dh{IGNORE} || ! exists $dh{IGNORE}->{$file})) {
426 # Pass it a name of a binary package, it returns the name to prefix to files
427 # in debian/ for this package.
431 if (compat(1) and $package eq $dh{MAINPACKAGE}) {
437 # Pass it the name of a binary package, it returns the name to install
438 # files by in eg, etc. Normally this is the same, but --name can override
443 if (defined $dh{NAME}) {
449 # Returns 1 if the package is a native debian package, null otherwise.
450 # As a side effect, sets $dh{VERSION} to the version of this package.
452 # Caches return code so it only needs to run dpkg-parsechangelog once.
458 return $isnative_cache{$package} if defined $isnative_cache{$package};
460 # Make sure we look at the correct changelog.
461 my $isnative_changelog=pkgfile($package,"changelog");
462 if (! $isnative_changelog) {
463 $isnative_changelog="debian/changelog";
465 # Get the package version.
466 my $version=`dpkg-parsechangelog -l$isnative_changelog`;
467 ($dh{VERSION})=$version=~m/Version:\s*(.*)/m;
468 # Did the changelog parse fail?
469 if (! defined $dh{VERSION}) {
470 error("changelog parse failure");
473 # Is this a native Debian package?
474 if ($dh{VERSION}=~m/.*-/) {
475 return $isnative_cache{$package}=0;
478 return $isnative_cache{$package}=1;
483 # Automatically add a shell script snippet to a debian script.
484 # Only works if the script has #DEBHELPER# in it.
488 # 2: script to add to
489 # 3: filename of snippet
490 # 4: sed to run on the snippet. Ie, s/#PACKAGE#/$PACKAGE/
497 # This is the file we will modify.
498 my $outfile="debian/".pkgext($package)."$script.debhelper";
500 # Figure out what shell script snippet to use.
502 if (defined($ENV{DH_AUTOSCRIPTDIR}) &&
503 -e "$ENV{DH_AUTOSCRIPTDIR}/$filename") {
504 $infile="$ENV{DH_AUTOSCRIPTDIR}/$filename";
507 if (-e "/usr/share/debhelper/autoscripts/$filename") {
508 $infile="/usr/share/debhelper/autoscripts/$filename";
511 error("/usr/share/debhelper/autoscripts/$filename does not exist");
515 if (-e $outfile && ($script eq 'postrm' || $script eq 'prerm')
517 # Add fragments to top so they run in reverse order when removing.
518 complex_doit("echo \"# Automatically added by ".basename($0)."\"> $outfile.new");
519 complex_doit("sed \"$sed\" $infile >> $outfile.new");
520 complex_doit("echo '# End automatically added section' >> $outfile.new");
521 complex_doit("cat $outfile >> $outfile.new");
522 complex_doit("mv $outfile.new $outfile");
525 complex_doit("echo \"# Automatically added by ".basename($0)."\">> $outfile");
526 complex_doit("sed \"$sed\" $infile >> $outfile");
527 complex_doit("echo '# End automatically added section' >> $outfile");
531 # Removes a whole substvar line.
536 my $ext=pkgext($package);
537 my $substvarfile="debian/${ext}substvars";
539 if (-e $substvarfile) {
540 complex_doit("grep -s -v '^${substvar}=' $substvarfile > $substvarfile.new || true");
541 doit("mv", "$substvarfile.new","$substvarfile");
545 # Adds a dependency on some package to the specified
546 # substvar in a package's substvar's file.
550 my $deppackage=shift;
554 my $ext=pkgext($package);
555 my $substvarfile="debian/${ext}substvars";
557 $str.=" ($verinfo)" if defined $verinfo && length $verinfo;
559 # Figure out what the line will look like, based on what's there
560 # now, and what we're to add or remove.
562 if (-e $substvarfile) {
564 open(SUBSTVARS_IN, "$substvarfile") || error "read $substvarfile: $!";
565 while (<SUBSTVARS_IN>) {
567 if (/^\Q$substvar\E=(.*)/) {
568 %items = map { $_ => 1} split(", ", $1);
580 $line=join(", ", sort keys %items);
587 complex_doit("(grep -s -v ${substvar} $substvarfile; echo ".escape_shell("${substvar}=$line").") > $substvarfile.new");
588 doit("mv", "$substvarfile.new", $substvarfile);
591 delsubstvar($package,$substvar);
595 # Reads in the specified file, one line at a time. splits on words,
596 # and returns an array of arrays of the contents.
597 # If a value is passed in as the second parameter, then glob
598 # expansion is done in the directory specified by the parameter ("." is
599 # frequently a good choice).
600 sub filedoublearray {
605 open (DH_FARRAY_IN, $file) || error("cannot read $file: $1");
606 while (<DH_FARRAY_IN>) {
608 # Only ignore comments and empty lines in v5 mode.
610 next if /^#/ || /^$/;
613 # Only do glob expansion in v3 mode.
615 # The tricky bit is that the glob expansion is done
616 # as if we were in the specified directory, so the
617 # filenames that come out are relative to it.
618 if (defined $globdir && ! compat(2)) {
619 for (map { glob "$globdir/$_" } split) {
634 # Reads in the specified file, one word at a time, and returns an array of
635 # the result. Can do globbing as does filedoublearray.
637 return map { @$_ } filedoublearray(@_);
640 # Passed a filename, returns true if -X says that file should be excluded.
642 my $filename = shift;
643 foreach my $f (@{$dh{EXCLUDE}}) {
644 return 1 if $filename =~ /\Q$f\E/;
649 sub dpkg_architecture_value {
651 my $value=`dpkg-architecture -q$var` || error("dpkg-architecture failed");
656 # Returns the build architecture. (Memoized)
661 if (!defined $arch) {
662 $arch=dpkg_architecture_value('DEB_HOST_ARCH');
668 # Returns the build OS. (Memoized)
674 $os=dpkg_architecture_value("DEB_HOST_ARCH_OS");
680 # Passed an arch and a list of arches to match against, returns true if matched
683 my @archlist=split(/\s+/,shift);
685 foreach my $a (@archlist) {
686 system("dpkg-architecture", "-a$arch", "-i$a") == 0 && return 1;
692 # Returns source package name
694 open (CONTROL, 'debian/control') ||
695 error("cannot read debian/control: $!\n");
699 if (/^Source:\s*(.*)/) {
706 error("could not find Source: line in control file.");
709 # Returns a list of packages in the control file.
710 # Pass "arch" or "indep" to specify arch-dependant or
711 # independant. If nothing is specified, returns all packages.
712 # As a side effect, populates %package_arches and %package_types with the
713 # types of all packages (not only those returned).
714 my (%package_types, %package_arches);
721 $type="" if ! defined $type;
728 open (CONTROL, 'debian/control') ||
729 error("cannot read debian/control: $!\n");
733 if (/^Package:\s*(.*)/) {
735 # Detect duplicate package names in the same control file.
736 if (! $seen{$package}) {
740 error("debian/control has a duplicate entry for $package");
744 if (/^Architecture:\s*(.*)/) {
747 if (/^(?:X[BC]*-)?Package-Type:\s*(.*)/) {
751 if (!$_ or eof) { # end of stanza.
753 $package_types{$package}=$package_type;
754 $package_arches{$package}=$arch;
758 (($type eq 'indep' && $arch eq 'all') ||
759 ($type eq 'arch' && ($arch eq 'any' ||
761 samearch(buildarch(), $arch)))) ||
763 push @list, $package;
774 # Returns the arch a package will build for.
778 if (! exists $package_arches{$package}) {
779 warning "package $package is not in control info";
782 return $package_arches{$package} eq 'all' ? "all" : buildarch();
785 # Return true if a given package is really a udeb.
789 if (! exists $package_types{$package}) {
790 warning "package $package is not in control info";
793 return $package_types{$package} eq 'udeb';
796 # Generates the filename that is used for a udeb package.
800 my $filearch=package_arch($package);
801 isnative($package); # side effect
802 my $version=$dh{VERSION};
803 $version=~s/^[0-9]+://; # strip any epoch
804 return "${package}_${version}_$filearch.udeb";
807 # Handles #DEBHELPER# substitution in a script; also can generate a new
808 # script from scratch if none exists but there is a .debhelper file for it.
809 sub debhelper_script_subst {
813 my $tmp=tmpdir($package);
814 my $ext=pkgext($package);
815 my $file=pkgfile($package,$script);
818 if (-f "debian/$ext$script.debhelper") {
819 # Add this into the script, where it has #DEBHELPER#
820 complex_doit("perl -pe 's~#DEBHELPER#~qx{cat debian/$ext$script.debhelper}~eg' < $file > $tmp/DEBIAN/$script");
823 # Just get rid of any #DEBHELPER# in the script.
824 complex_doit("sed s/#DEBHELPER#// < $file > $tmp/DEBIAN/$script");
826 doit("chown","0:0","$tmp/DEBIAN/$script");
827 doit("chmod",755,"$tmp/DEBIAN/$script");
829 elsif ( -f "debian/$ext$script.debhelper" ) {
830 complex_doit("printf '#!/bin/sh\nset -e\n' > $tmp/DEBIAN/$script");
831 complex_doit("cat debian/$ext$script.debhelper >> $tmp/DEBIAN/$script");
832 doit("chown","0:0","$tmp/DEBIAN/$script");
833 doit("chmod",755,"$tmp/DEBIAN/$script");