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);
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 push @{$dh{DOPACKAGES}},@allpackages;
80 # Check to see if -P was specified. If so, we can only act on a single
82 if ($dh{TMPDIR} && $#{$dh{DOPACKAGES}} > 0) {
83 error("-P was specified, but multiple packages would be acted on (".join(",",@{$dh{DOPACKAGES}}).").");
86 # Figure out which package is the first one we were instructed to build.
87 # This package gets special treatement: files and directories specified on
88 # the command line may affect it.
89 $dh{FIRSTPACKAGE}=${$dh{DOPACKAGES}}[0];
91 # If no error handling function was specified, just propigate
93 if (! exists $dh{ERROR_HANDLER} || ! defined $dh{ERROR_HANDLER}) {
94 $dh{ERROR_HANDLER}='exit \$?';
98 # Run at exit. Add the command to the log files for the packages it acted
99 # on, if it's exiting successfully.
102 if ($? == 0 && $write_log) {
103 write_log(basename($0), @{$dh{DOPACKAGES}});
108 my ($package, $db)=@_;
109 my $ext=pkgext($package);
112 open(LOG, "<", "debian/${ext}debhelper.log") || return;
116 $db->{$package}{$_}=1 if defined $db;
126 foreach my $package (@packages) {
127 my $ext=pkgext($package);
128 my $log="debian/${ext}debhelper.log";
129 open(LOG, ">>", $log) || error("failed to write to ${log}: $!");
139 # Pass it an array containing the arguments of a shell command like would
140 # be run by exec(). It turns that into a line like you might enter at the
141 # shell, escaping metacharacters and quoting arguments that contain spaces.
146 foreach my $word (@args) {
148 # Escape only a few things since it will be quoted.
149 # Note we use double quotes because you cannot
150 # escape ' in single quotes, while " can be escaped
152 # This does make -V"foo bar" turn into "-Vfoo bar",
153 # but that will be parsed identically by the shell
155 $word=~s/([\n`\$"\\])/\\$1/g;
156 push @ret, "\"$word\"";
159 # This list is from _Unix in a Nutshell_. (except '#')
160 $word=~s/([\s!"\$()*+#;<>?@\[\]\\`|~])/\\$1/g;
164 return join(' ', @ret);
167 # Run a command, and display the command to stdout if verbose mode is on.
168 # All commands that modifiy files in $TMP should be ran via this
171 # Note that this cannot handle complex commands, especially anything
172 # involving redirection. Use complex_doit instead.
174 verbose_print(escape_shell(@_));
177 system(@_) == 0 || _error_exitcode($_[0]);
181 # Run a command and display the command to stdout if verbose mode is on.
182 # Use doit() if you can, instead of this function, because this function
183 # forks a shell. However, this function can handle more complicated stuff
186 verbose_print(join(" ",@_));
189 # The join makes system get a scalar so it forks off a shell.
190 system(join(" ", @_)) == 0 || _error_exitcode(join(" ", @_))
194 sub _error_exitcode {
197 error("$command failed to to execute: $!");
200 error("$command died with signal ".($? & 127));
203 error("$command returned exit code ".($? >> 8));
207 # Run a command that may have a huge number of arguments, like xargs does.
208 # Pass in a reference to an array containing the arguments, and then other
209 # parameters that are the command and any parameters that should be passed to
214 # The kernel can accept command lines up to 20k worth of characters.
215 my $command_max=20000; # LINUX SPECIFIC!!
216 # I could use POSIX::ARG_MAX, but that would be slow.
218 # Figure out length of static portion of command.
221 $static_length+=length($_)+1;
225 my $length=$static_length;
227 if (length($_) + 1 + $static_length > $command_max) {
228 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? \"@_ $_\"");
230 $length+=length($_) + 1;
231 if ($length < $command_max) {
235 doit(@_,@collect) if $#collect > -1;
237 $length=$static_length + length($_) + 1;
240 doit(@_,@collect) if $#collect > -1;
243 # Print something if the verbose flag is on.
248 print "\t$message\n";
252 # Output an error message and exit.
264 print STDERR basename($0).": $message\n";
267 # Returns the basename of the argument passed to it.
271 $fn=~s/\/$//g; # ignore trailing slashes
272 $fn=~s:^.*/(.*?)$:$1:;
276 # Returns the directory name of the argument passed to it.
280 $fn=~s/\/$//g; # ignore trailing slashes
281 $fn=~s:^(.*)/.*?$:$1:;
285 # Pass in a number, will return true iff the current compatibility level
286 # is less than or equal to that number.
296 if (defined $ENV{DH_COMPAT}) {
299 elsif (-e 'debian/compat') {
301 open (COMPAT_IN, "debian/compat") || error "debian/compat: $!";
304 if (! defined $l || ! length $l) {
305 warning("debian/compat is empty, assuming level $c");
314 if ($c < 4 && ! $warned_compat) {
315 warning("Compatibility levels before 5 are deprecated.");
319 if ($c > $max_compat) {
320 error("Sorry, but $max_compat is the highest compatibility level supported by this debhelper.");
327 # Pass it a name of a binary package, it returns the name of the tmp dir to
328 # use, for that package.
335 elsif (compat(1) && $package eq $dh{MAINPACKAGE}) {
336 # This is for back-compatibility with the debian/tmp tradition.
340 return "debian/$package";
344 # Pass this the name of a binary package, and the name of the file wanted
345 # for the package, and it will return the actual existing filename to use.
347 # It tries several filenames:
348 # * debian/package.filename.buildarch
349 # * debian/package.filename.buildos
350 # * debian/package.filename
351 # * debian/filename (if the package is the main package)
352 # If --name was specified then the files
353 # must have the name after the package name:
354 # * debian/package.name.filename.buildarch
355 # * debian/package.name.filename.buildos
356 # * debian/package.name.filename
357 # * debian/name.filename (if the package is the main package)
362 if (defined $dh{NAME}) {
363 $filename="$dh{NAME}.$filename";
366 my @try=("debian/$package.$filename.".buildarch(),
367 "debian/$package.$filename.".buildos(),
368 "debian/$package.$filename");
369 if ($package eq $dh{MAINPACKAGE}) {
370 push @try, "debian/$filename";
373 foreach my $file (@try) {
375 (! $dh{IGNORE} || ! exists $dh{IGNORE}->{$file})) {
385 # Pass it a name of a binary package, it returns the name to prefix to files
386 # in debian/ for this package.
390 if (compat(1) and $package eq $dh{MAINPACKAGE}) {
396 # Pass it the name of a binary package, it returns the name to install
397 # files by in eg, etc. Normally this is the same, but --name can override
402 if (defined $dh{NAME}) {
408 # Returns 1 if the package is a native debian package, null otherwise.
409 # As a side effect, sets $dh{VERSION} to the version of this package.
411 # Caches return code so it only needs to run dpkg-parsechangelog once.
417 return $isnative_cache{$package} if defined $isnative_cache{$package};
419 # Make sure we look at the correct changelog.
420 my $isnative_changelog=pkgfile($package,"changelog");
421 if (! $isnative_changelog) {
422 $isnative_changelog="debian/changelog";
424 # Get the package version.
425 my $version=`dpkg-parsechangelog -l$isnative_changelog`;
426 ($dh{VERSION})=$version=~m/Version:\s*(.*)/m;
427 # Did the changelog parse fail?
428 if (! defined $dh{VERSION}) {
429 error("changelog parse failure");
432 # Is this a native Debian package?
433 if ($dh{VERSION}=~m/.*-/) {
434 return $isnative_cache{$package}=0;
437 return $isnative_cache{$package}=1;
442 # Automatically add a shell script snippet to a debian script.
443 # Only works if the script has #DEBHELPER# in it.
447 # 2: script to add to
448 # 3: filename of snippet
449 # 4: sed to run on the snippet. Ie, s/#PACKAGE#/$PACKAGE/
456 # This is the file we will modify.
457 my $outfile="debian/".pkgext($package)."$script.debhelper";
459 # Figure out what shell script snippet to use.
461 if (defined($ENV{DH_AUTOSCRIPTDIR}) &&
462 -e "$ENV{DH_AUTOSCRIPTDIR}/$filename") {
463 $infile="$ENV{DH_AUTOSCRIPTDIR}/$filename";
466 if (-e "/usr/share/debhelper/autoscripts/$filename") {
467 $infile="/usr/share/debhelper/autoscripts/$filename";
470 error("/usr/share/debhelper/autoscripts/$filename does not exist");
474 if (-e $outfile && ($script eq 'postrm' || $script eq 'prerm')
476 # Add fragments to top so they run in reverse order when removing.
477 complex_doit("echo \"# Automatically added by ".basename($0)."\"> $outfile.new");
478 complex_doit("sed \"$sed\" $infile >> $outfile.new");
479 complex_doit("echo '# End automatically added section' >> $outfile.new");
480 complex_doit("cat $outfile >> $outfile.new");
481 complex_doit("mv $outfile.new $outfile");
484 complex_doit("echo \"# Automatically added by ".basename($0)."\">> $outfile");
485 complex_doit("sed \"$sed\" $infile >> $outfile");
486 complex_doit("echo '# End automatically added section' >> $outfile");
490 # Removes a whole substvar line.
495 my $ext=pkgext($package);
496 my $substvarfile="debian/${ext}substvars";
498 if (-e $substvarfile) {
499 complex_doit("grep -s -v '^${substvar}=' $substvarfile > $substvarfile.new || true");
500 doit("mv", "$substvarfile.new","$substvarfile");
504 # Adds a dependency on some package to the specified
505 # substvar in a package's substvar's file.
509 my $deppackage=shift;
513 my $ext=pkgext($package);
514 my $substvarfile="debian/${ext}substvars";
516 $str.=" ($verinfo)" if defined $verinfo && length $verinfo;
518 # Figure out what the line will look like, based on what's there
519 # now, and what we're to add or remove.
521 if (-e $substvarfile) {
523 open(SUBSTVARS_IN, "$substvarfile") || error "read $substvarfile: $!";
524 while (<SUBSTVARS_IN>) {
526 if (/^\Q$substvar\E=(.*)/) {
527 %items = map { $_ => 1} split(", ", $1);
539 $line=join(", ", sort keys %items);
546 complex_doit("(grep -s -v ${substvar} $substvarfile; echo ".escape_shell("${substvar}=$line").") > $substvarfile.new");
547 doit("mv", "$substvarfile.new", $substvarfile);
550 delsubstvar($package,$substvar);
554 # Reads in the specified file, one line at a time. splits on words,
555 # and returns an array of arrays of the contents.
556 # If a value is passed in as the second parameter, then glob
557 # expansion is done in the directory specified by the parameter ("." is
558 # frequently a good choice).
559 sub filedoublearray {
564 open (DH_FARRAY_IN, $file) || error("cannot read $file: $1");
565 while (<DH_FARRAY_IN>) {
567 # Only ignore comments and empty lines in v5 mode.
569 next if /^#/ || /^$/;
572 # Only do glob expansion in v3 mode.
574 # The tricky bit is that the glob expansion is done
575 # as if we were in the specified directory, so the
576 # filenames that come out are relative to it.
577 if (defined $globdir && ! compat(2)) {
578 for (map { glob "$globdir/$_" } split) {
593 # Reads in the specified file, one word at a time, and returns an array of
594 # the result. Can do globbing as does filedoublearray.
596 return map { @$_ } filedoublearray(@_);
599 # Passed a filename, returns true if -X says that file should be excluded.
601 my $filename = shift;
602 foreach my $f (@{$dh{EXCLUDE}}) {
603 return 1 if $filename =~ /\Q$f\E/;
608 # Returns the build architecture. (Memoized)
613 return $arch if defined $arch;
615 $arch=`dpkg-architecture -qDEB_HOST_ARCH 2>/dev/null` || error("dpkg-architecture failed");
621 # Returns the build OS. (Memoized)
626 return $os if defined $os;
628 $os=`dpkg-architecture -qDEB_HOST_ARCH_OS 2>/dev/null` || error("dpkg-architecture failed");
634 # Passed an arch and a list of arches to match against, returns true if matched
637 my @archlist=split(/\s+/,shift);
639 foreach my $a (@archlist) {
640 system("dpkg-architecture", "-a$arch", "-i$a") == 0 && return 1;
646 # Returns a list of packages in the control file.
647 # Must pass "arch" or "indep" or "same" to specify arch-dependant or
648 # -independant or same arch packages. If nothing is specified, returns all
650 # As a side effect, populates %package_arches and %package_types with the
651 # types of all packages (not only those returned).
652 my (%package_types, %package_arches);
659 $type="" if ! defined $type;
661 # Look up the build arch if we need to.
663 if ($type eq 'same') {
664 $buildarch=buildarch();
672 open (CONTROL, 'debian/control') ||
673 error("cannot read debian/control: $!\n");
677 if (/^Package:\s*(.*)/) {
679 # Detect duplicate package names in the same control file.
680 if (! $seen{$package}) {
684 error("debian/control has a duplicate entry for $package");
688 if (/^Architecture:\s*(.*)/) {
691 if (/^(?:X[BC]*-)?Package-Type:\s*(.*)/) {
695 if (!$_ or eof) { # end of stanza.
697 $package_types{$package}=$package_type;
698 $package_arches{$package}=$arch;
701 (($type eq 'indep' && $arch eq 'all') ||
702 ($type eq 'arch' && $arch ne 'all') ||
703 ($type eq 'same' && ($arch eq 'any' || samearch($buildarch, $arch))) ||
705 push @list, $package;
716 # Returns the arch a package will build for.
720 if (! exists $package_arches{$package}) {
721 warning "package $package is not in control info";
724 return $package_arches{$package} eq 'all' ? "all" : buildarch();
727 # Return true if a given package is really a udeb.
731 if (! exists $package_types{$package}) {
732 warning "package $package is not in control info";
735 return $package_types{$package} eq 'udeb';
738 # Generates the filename that is used for a udeb package.
742 my $filearch=package_arch($package);
743 isnative($package); # side effect
744 my $version=$dh{VERSION};
745 $version=~s/^[0-9]+://; # strip any epoch
746 return "${package}_${version}_$filearch.udeb";
749 # Handles #DEBHELPER# substitution in a script; also can generate a new
750 # script from scratch if none exists but there is a .debhelper file for it.
751 sub debhelper_script_subst {
755 my $tmp=tmpdir($package);
756 my $ext=pkgext($package);
757 my $file=pkgfile($package,$script);
760 if (-f "debian/$ext$script.debhelper") {
761 # Add this into the script, where it has #DEBHELPER#
762 complex_doit("perl -pe 's~#DEBHELPER#~qx{cat debian/$ext$script.debhelper}~eg' < $file > $tmp/DEBIAN/$script");
765 # Just get rid of any #DEBHELPER# in the script.
766 complex_doit("sed s/#DEBHELPER#// < $file > $tmp/DEBIAN/$script");
768 doit("chown","0:0","$tmp/DEBIAN/$script");
769 doit("chmod",755,"$tmp/DEBIAN/$script");
771 elsif ( -f "debian/$ext$script.debhelper" ) {
772 complex_doit("printf '#!/bin/sh\nset -e\n' > $tmp/DEBIAN/$script");
773 complex_doit("cat debian/$ext$script.debhelper >> $tmp/DEBIAN/$script");
774 doit("chown","0:0","$tmp/DEBIAN/$script");
775 doit("chmod",755,"$tmp/DEBIAN/$script");