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}) ||
31 eval "use Debian::Debhelper::Dh_Getopt";
33 Debian::Debhelper::Dh_Getopt::parseopts($params{options});
36 # Another way to set excludes.
37 if (exists $ENV{DH_ALWAYS_EXCLUDE} && length $ENV{DH_ALWAYS_EXCLUDE}) {
38 push @{$dh{EXCLUDE}}, split(":", $ENV{DH_ALWAYS_EXCLUDE});
41 # Generate EXCLUDE_FIND.
44 foreach (@{$dh{EXCLUDE}}) {
48 $dh{EXCLUDE_FIND}.="-regex .\\*$x.\\* -or ";
50 $dh{EXCLUDE_FIND}=~s/ -or $//;
53 # Check to see if DH_VERBOSE environment variable was set, if so,
54 # make sure verbose is on.
55 if (defined $ENV{DH_VERBOSE} && $ENV{DH_VERBOSE} ne "") {
59 # Check to see if DH_NO_ACT environment variable was set, if so,
60 # make sure no act mode is on.
61 if (defined $ENV{DH_NO_ACT} && $ENV{DH_NO_ACT} ne "") {
65 my @allpackages=getpackages();
66 # Get the name of the main binary package (first one listed in
67 # debian/control). Only if the main package was not set on the
69 if (! exists $dh{MAINPACKAGE} || ! defined $dh{MAINPACKAGE}) {
70 $dh{MAINPACKAGE}=$allpackages[0];
73 # Check if packages to build have been specified, if not, fall back to
74 # the default, doing them all.
75 if (! defined $dh{DOPACKAGES} || ! @{$dh{DOPACKAGES}}) {
76 if ($dh{DOINDEP} || $dh{DOARCH} || $dh{DOSAME}) {
77 error("You asked that all arch in(dep) packages be built, but there are none of that type.");
79 push @{$dh{DOPACKAGES}},@allpackages;
82 # Check to see if -P was specified. If so, we can only act on a single
84 if ($dh{TMPDIR} && $#{$dh{DOPACKAGES}} > 0) {
85 error("-P was specified, but multiple packages would be acted on (".join(",",@{$dh{DOPACKAGES}}).").");
88 # Figure out which package is the first one we were instructed to build.
89 # This package gets special treatement: files and directories specified on
90 # the command line may affect it.
91 $dh{FIRSTPACKAGE}=${$dh{DOPACKAGES}}[0];
93 # If no error handling function was specified, just propigate
95 if (! exists $dh{ERROR_HANDLER} || ! defined $dh{ERROR_HANDLER}) {
96 $dh{ERROR_HANDLER}='exit \$?';
100 # Run at exit. Add the command to the log files for the packages it acted
101 # on, if it's exiting successfully.
104 if ($? == 0 && $write_log) {
105 my $cmd=basename($0);
106 foreach my $package (@{$dh{DOPACKAGES}}) {
107 my $ext=pkgext($package);
108 my $log="debian/${ext}debhelper.log";
109 open(LOG, ">>", $log) || error("failed to write to ${log}: $!");
120 # Pass it an array containing the arguments of a shell command like would
121 # be run by exec(). It turns that into a line like you might enter at the
122 # shell, escaping metacharacters and quoting arguments that contain spaces.
127 foreach my $word (@args) {
129 # Escape only a few things since it will be quoted.
130 # Note we use double quotes because you cannot
131 # escape ' in single quotes, while " can be escaped
133 # This does make -V"foo bar" turn into "-Vfoo bar",
134 # but that will be parsed identically by the shell
136 $word=~s/([\n`\$"\\])/\\$1/g;
137 push @ret, "\"$word\"";
140 # This list is from _Unix in a Nutshell_. (except '#')
141 $word=~s/([\s!"\$()*+#;<>?@\[\]\\`|~])/\\$1/g;
145 return join(' ', @ret);
148 # Run a command, and display the command to stdout if verbose mode is on.
149 # All commands that modifiy files in $TMP should be ran via this
152 # Note that this cannot handle complex commands, especially anything
153 # involving redirection. Use complex_doit instead.
155 verbose_print(escape_shell(@_));
159 $ret == 0 || error("command returned error code $ret");
163 # Run a command and display the command to stdout if verbose mode is on.
164 # Use doit() if you can, instead of this function, because this function
165 # forks a shell. However, this function can handle more complicated stuff
168 verbose_print(join(" ",@_));
171 # The join makes system get a scalar so it forks off a shell.
172 system(join(" ",@_)) == 0
173 || error("command returned error code");
177 # Run a command that may have a huge number of arguments, like xargs does.
178 # Pass in a reference to an array containing the arguments, and then other
179 # parameters that are the command and any parameters that should be passed to
184 # The kernel can accept command lines up to 20k worth of characters.
185 my $command_max=20000; # LINUX SPECIFIC!!
186 # I could use POSIX::ARG_MAX, but that would be slow.
188 # Figure out length of static portion of command.
191 $static_length+=length($_)+1;
195 my $length=$static_length;
197 if (length($_) + 1 + $static_length > $command_max) {
198 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? \"@_ $_\"");
200 $length+=length($_) + 1;
201 if ($length < $command_max) {
205 doit(@_,@collect) if $#collect > -1;
207 $length=$static_length + length($_) + 1;
210 doit(@_,@collect) if $#collect > -1;
213 # Print something if the verbose flag is on.
218 print "\t$message\n";
222 # Output an error message and exit.
234 print STDERR basename($0).": $message\n";
237 # Returns the basename of the argument passed to it.
241 $fn=~s/\/$//g; # ignore trailing slashes
242 $fn=~s:^.*/(.*?)$:$1:;
246 # Returns the directory name of the argument passed to it.
250 $fn=~s/\/$//g; # ignore trailing slashes
251 $fn=~s:^(.*)/.*?$:$1:;
255 # Pass in a number, will return true iff the current compatibility level
256 # is less than or equal to that number.
266 if (defined $ENV{DH_COMPAT}) {
269 elsif (-e 'debian/compat') {
271 open (COMPAT_IN, "debian/compat") || error "debian/compat: $!";
273 if (! defined $l || ! length $l) {
274 warning("debian/compat is empty, assuming level $c");
283 if ($c < 4 && ! $warned_compat) {
284 warning("Compatibility levels before 4 are deprecated.");
288 if ($c > $max_compat) {
289 error("Sorry, but $max_compat is the highest compatibility level supported by this debhelper.");
296 # Pass it a name of a binary package, it returns the name of the tmp dir to
297 # use, for that package.
304 elsif (compat(1) && $package eq $dh{MAINPACKAGE}) {
305 # This is for back-compatibility with the debian/tmp tradition.
309 return "debian/$package";
313 # Pass this the name of a binary package, and the name of the file wanted
314 # for the package, and it will return the actual existing filename to use.
316 # It tries several filenames:
317 # * debian/package.filename.buildarch
318 # * debian/package.filename
319 # * debian/file (if the package is the main package)
320 # If --name was specified then tonly the first two are tried, and they must
321 # have the name after the pacage name:
322 # * debian/package.name.filename.buildarch
323 # * debian/package.name.filename
328 if (defined $dh{NAME}) {
329 $filename="$dh{NAME}.$filename";
332 my @try=("debian/$package.$filename.".buildarch(),
333 "debian/$package.$filename");
334 if ($package eq $dh{MAINPACKAGE}) {
335 push @try, "debian/$filename";
338 foreach my $file (@try) {
340 (! $dh{IGNORE} || ! exists $dh{IGNORE}->{$file})) {
350 # Pass it a name of a binary package, it returns the name to prefix to files
351 # in debian/ for this package.
355 if (compat(1) and $package eq $dh{MAINPACKAGE}) {
361 # Pass it the name of a binary package, it returns the name to install
362 # files by in eg, etc. Normally this is the same, but --name can override
367 if (defined $dh{NAME}) {
373 # Returns 1 if the package is a native debian package, null otherwise.
374 # As a side effect, sets $dh{VERSION} to the version of this package.
376 # Caches return code so it only needs to run dpkg-parsechangelog once.
382 return $isnative_cache{$package} if defined $isnative_cache{$package};
384 # Make sure we look at the correct changelog.
385 my $isnative_changelog=pkgfile($package,"changelog");
386 if (! $isnative_changelog) {
387 $isnative_changelog="debian/changelog";
389 # Get the package version.
390 my $version=`dpkg-parsechangelog -l$isnative_changelog`;
391 ($dh{VERSION})=$version=~m/Version:\s*(.*)/m;
392 # Did the changelog parse fail?
393 if (! defined $dh{VERSION}) {
394 error("changelog parse failure");
397 # Is this a native Debian package?
398 if ($dh{VERSION}=~m/.*-/) {
399 return $isnative_cache{$package}=0;
402 return $isnative_cache{$package}=1;
407 # Automatically add a shell script snippet to a debian script.
408 # Only works if the script has #DEBHELPER# in it.
412 # 2: script to add to
413 # 3: filename of snippet
414 # 4: sed to run on the snippet. Ie, s/#PACKAGE#/$PACKAGE/
421 # This is the file we will modify.
422 my $outfile="debian/".pkgext($package)."$script.debhelper";
424 # Figure out what shell script snippet to use.
426 if (defined($ENV{DH_AUTOSCRIPTDIR}) &&
427 -e "$ENV{DH_AUTOSCRIPTDIR}/$filename") {
428 $infile="$ENV{DH_AUTOSCRIPTDIR}/$filename";
431 if (-e "/usr/share/debhelper/autoscripts/$filename") {
432 $infile="/usr/share/debhelper/autoscripts/$filename";
435 error("/usr/share/debhelper/autoscripts/$filename does not exist");
439 if (-e $outfile && ($script eq 'postrm' || $script eq 'prerm')
441 # Add fragments to top so they run in reverse order when removing.
442 complex_doit("echo \"# Automatically added by ".basename($0)."\"> $outfile.new");
443 complex_doit("sed \"$sed\" $infile >> $outfile.new");
444 complex_doit("echo '# End automatically added section' >> $outfile.new");
445 complex_doit("cat $outfile >> $outfile.new");
446 complex_doit("mv $outfile.new $outfile");
449 complex_doit("echo \"# Automatically added by ".basename($0)."\">> $outfile");
450 complex_doit("sed \"$sed\" $infile >> $outfile");
451 complex_doit("echo '# End automatically added section' >> $outfile");
455 # Removes a whole substvar line.
460 my $ext=pkgext($package);
461 my $substvarfile="debian/${ext}substvars";
463 if (-e $substvarfile) {
464 complex_doit("grep -s -v '^${substvar}=' $substvarfile > $substvarfile.new || true");
465 doit("mv", "$substvarfile.new","$substvarfile");
469 # Adds a dependency on some package to the specified
470 # substvar in a package's substvar's file.
474 my $deppackage=shift;
478 my $ext=pkgext($package);
479 my $substvarfile="debian/${ext}substvars";
481 $str.=" ($verinfo)" if defined $verinfo && length $verinfo;
483 # Figure out what the line will look like, based on what's there
484 # now, and what we're to add or remove.
486 if (-e $substvarfile) {
488 open(SUBSTVARS_IN, "$substvarfile") || error "read $substvarfile: $!";
489 while (<SUBSTVARS_IN>) {
491 if (/^\Q$substvar\E=(.*)/) {
492 %items = map { $_ => 1} split(", ", $1);
504 $line=join(", ", sort keys %items);
511 complex_doit("(grep -s -v ${substvar} $substvarfile; echo ".escape_shell("${substvar}=$line").") > $substvarfile.new");
512 doit("mv", "$substvarfile.new", $substvarfile);
515 delsubstvar($package,$substvar);
519 # Reads in the specified file, one line at a time. splits on words,
520 # and returns an array of arrays of the contents.
521 # If a value is passed in as the second parameter, then glob
522 # expansion is done in the directory specified by the parameter ("." is
523 # frequently a good choice).
524 sub filedoublearray {
529 open (DH_FARRAY_IN, $file) || error("cannot read $file: $1");
530 while (<DH_FARRAY_IN>) {
532 # Only ignore comments and empty lines in v5 mode.
534 next if /^#/ || /^$/;
537 # Only do glob expansion in v3 mode.
539 # The tricky bit is that the glob expansion is done
540 # as if we were in the specified directory, so the
541 # filenames that come out are relative to it.
542 if (defined $globdir && ! compat(2)) {
543 for (map { glob "$globdir/$_" } split) {
558 # Reads in the specified file, one word at a time, and returns an array of
559 # the result. Can do globbing as does filedoublearray.
561 return map { @$_ } filedoublearray(@_);
564 # Passed a filename, returns true if -X says that file should be excluded.
566 my $filename = shift;
567 foreach my $f (@{$dh{EXCLUDE}}) {
568 return 1 if $filename =~ /\Q$f\E/;
573 # Returns the build architecture. (Memoized)
578 return $arch if defined $arch;
580 $arch=`dpkg-architecture -qDEB_HOST_ARCH 2>/dev/null` || error("dpkg-architecture failed");
586 # Passed an arch and a list of arches to match against, returns true if matched
589 my @archlist=split(/\s+/,shift);
591 foreach my $a (@archlist) {
592 system("dpkg-architecture", "-a$arch", "-i$a") == 0 && return 1;
598 # Returns a list of packages in the control file.
599 # Must pass "arch" or "indep" or "same" to specify arch-dependant or
600 # -independant or same arch packages. If nothing is specified, returns all
602 # As a side effect, populates %package_arches and %package_types with the
603 # types of all packages (not only those returned).
604 my (%package_types, %package_arches);
611 $type="" if ! defined $type;
613 # Look up the build arch if we need to.
615 if ($type eq 'same') {
616 $buildarch=buildarch();
624 open (CONTROL, 'debian/control') ||
625 error("cannot read debian/control: $!\n");
629 if (/^Package:\s*(.*)/) {
631 # Detect duplicate package names in the same control file.
632 if (! $seen{$package}) {
636 error("debian/control has a duplicate entry for $package");
640 if (/^Architecture:\s*(.*)/) {
643 if (/^(?:X[BC]*-)?Package-Type:\s*(.*)/) {
647 if (!$_ or eof) { # end of stanza.
649 $package_types{$package}=$package_type;
650 $package_arches{$package}=$arch;
653 (($type eq 'indep' && $arch eq 'all') ||
654 ($type eq 'arch' && $arch ne 'all') ||
655 ($type eq 'same' && ($arch eq 'any' || samearch($buildarch, $arch))) ||
657 push @list, $package;
668 # Returns the arch a package will build for.
672 if (! exists $package_arches{$package}) {
673 warning "package $package is not in control info";
676 return $package_arches{$package} eq 'all' ? "all" : buildarch();
679 # Return true if a given package is really a udeb.
683 if (! exists $package_types{$package}) {
684 warning "package $package is not in control info";
687 return $package_types{$package} eq 'udeb';
690 # Generates the filename that is used for a udeb package.
694 my $filearch=package_arch($package);
695 isnative($package); # side effect
696 my $version=$dh{VERSION};
697 $version=~s/^[0-9]+://; # strip any epoch
698 return "${package}_${version}_$filearch.udeb";
701 # Handles #DEBHELPER# substitution in a script; also can generate a new
702 # script from scratch if none exists but there is a .debhelper file for it.
703 sub debhelper_script_subst {
707 my $tmp=tmpdir($package);
708 my $ext=pkgext($package);
709 my $file=pkgfile($package,$script);
712 if (-f "debian/$ext$script.debhelper") {
713 # Add this into the script, where it has #DEBHELPER#
714 complex_doit("perl -pe 's~#DEBHELPER#~qx{cat debian/$ext$script.debhelper}~eg' < $file > $tmp/DEBIAN/$script");
717 # Just get rid of any #DEBHELPER# in the script.
718 complex_doit("sed s/#DEBHELPER#// < $file > $tmp/DEBIAN/$script");
720 doit("chown","0:0","$tmp/DEBIAN/$script");
721 doit("chmod",755,"$tmp/DEBIAN/$script");
723 elsif ( -f "debian/$ext$script.debhelper" ) {
724 complex_doit("printf '#!/bin/sh\nset -e\n' > $tmp/DEBIAN/$script");
725 complex_doit("cat debian/$ext$script.debhelper >> $tmp/DEBIAN/$script");
726 doit("chown","0:0","$tmp/DEBIAN/$script");
727 doit("chmod",755,"$tmp/DEBIAN/$script");