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(@_));
166 $ret == 0 || error("command returned error code $ret");
170 # Run a command and display the command to stdout if verbose mode is on.
171 # Use doit() if you can, instead of this function, because this function
172 # forks a shell. However, this function can handle more complicated stuff
175 verbose_print(join(" ",@_));
178 # The join makes system get a scalar so it forks off a shell.
179 system(join(" ",@_)) == 0
180 || error("command returned error code");
184 # Run a command that may have a huge number of arguments, like xargs does.
185 # Pass in a reference to an array containing the arguments, and then other
186 # parameters that are the command and any parameters that should be passed to
191 # The kernel can accept command lines up to 20k worth of characters.
192 my $command_max=20000; # LINUX SPECIFIC!!
193 # I could use POSIX::ARG_MAX, but that would be slow.
195 # Figure out length of static portion of command.
198 $static_length+=length($_)+1;
202 my $length=$static_length;
204 if (length($_) + 1 + $static_length > $command_max) {
205 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? \"@_ $_\"");
207 $length+=length($_) + 1;
208 if ($length < $command_max) {
212 doit(@_,@collect) if $#collect > -1;
214 $length=$static_length + length($_) + 1;
217 doit(@_,@collect) if $#collect > -1;
220 # Print something if the verbose flag is on.
225 print "\t$message\n";
229 # Output an error message and exit.
241 print STDERR basename($0).": $message\n";
244 # Returns the basename of the argument passed to it.
248 $fn=~s/\/$//g; # ignore trailing slashes
249 $fn=~s:^.*/(.*?)$:$1:;
253 # Returns the directory name of the argument passed to it.
257 $fn=~s/\/$//g; # ignore trailing slashes
258 $fn=~s:^(.*)/.*?$:$1:;
262 # Pass in a number, will return true iff the current compatibility level
263 # is less than or equal to that number.
273 if (defined $ENV{DH_COMPAT}) {
276 elsif (-e 'debian/compat') {
278 open (COMPAT_IN, "debian/compat") || error "debian/compat: $!";
280 if (! defined $l || ! length $l) {
281 warning("debian/compat is empty, assuming level $c");
290 if ($c < 4 && ! $warned_compat) {
291 warning("Compatibility levels before 4 are deprecated.");
295 if ($c > $max_compat) {
296 error("Sorry, but $max_compat is the highest compatibility level supported by this debhelper.");
303 # Pass it a name of a binary package, it returns the name of the tmp dir to
304 # use, for that package.
311 elsif (compat(1) && $package eq $dh{MAINPACKAGE}) {
312 # This is for back-compatibility with the debian/tmp tradition.
316 return "debian/$package";
320 # Pass this the name of a binary package, and the name of the file wanted
321 # for the package, and it will return the actual existing filename to use.
323 # It tries several filenames:
324 # * debian/package.filename.buildarch
325 # * debian/package.filename
326 # * debian/file (if the package is the main package)
327 # If --name was specified then tonly the first two are tried, and they must
328 # have the name after the pacage name:
329 # * debian/package.name.filename.buildarch
330 # * debian/package.name.filename
335 if (defined $dh{NAME}) {
336 $filename="$dh{NAME}.$filename";
339 my @try=("debian/$package.$filename.".buildarch(),
340 "debian/$package.$filename");
341 if ($package eq $dh{MAINPACKAGE}) {
342 push @try, "debian/$filename";
345 foreach my $file (@try) {
347 (! $dh{IGNORE} || ! exists $dh{IGNORE}->{$file})) {
357 # Pass it a name of a binary package, it returns the name to prefix to files
358 # in debian/ for this package.
362 if (compat(1) and $package eq $dh{MAINPACKAGE}) {
368 # Pass it the name of a binary package, it returns the name to install
369 # files by in eg, etc. Normally this is the same, but --name can override
374 if (defined $dh{NAME}) {
380 # Returns 1 if the package is a native debian package, null otherwise.
381 # As a side effect, sets $dh{VERSION} to the version of this package.
383 # Caches return code so it only needs to run dpkg-parsechangelog once.
389 return $isnative_cache{$package} if defined $isnative_cache{$package};
391 # Make sure we look at the correct changelog.
392 my $isnative_changelog=pkgfile($package,"changelog");
393 if (! $isnative_changelog) {
394 $isnative_changelog="debian/changelog";
396 # Get the package version.
397 my $version=`dpkg-parsechangelog -l$isnative_changelog`;
398 ($dh{VERSION})=$version=~m/Version:\s*(.*)/m;
399 # Did the changelog parse fail?
400 if (! defined $dh{VERSION}) {
401 error("changelog parse failure");
404 # Is this a native Debian package?
405 if ($dh{VERSION}=~m/.*-/) {
406 return $isnative_cache{$package}=0;
409 return $isnative_cache{$package}=1;
414 # Automatically add a shell script snippet to a debian script.
415 # Only works if the script has #DEBHELPER# in it.
419 # 2: script to add to
420 # 3: filename of snippet
421 # 4: sed to run on the snippet. Ie, s/#PACKAGE#/$PACKAGE/
428 # This is the file we will modify.
429 my $outfile="debian/".pkgext($package)."$script.debhelper";
431 # Figure out what shell script snippet to use.
433 if (defined($ENV{DH_AUTOSCRIPTDIR}) &&
434 -e "$ENV{DH_AUTOSCRIPTDIR}/$filename") {
435 $infile="$ENV{DH_AUTOSCRIPTDIR}/$filename";
438 if (-e "/usr/share/debhelper/autoscripts/$filename") {
439 $infile="/usr/share/debhelper/autoscripts/$filename";
442 error("/usr/share/debhelper/autoscripts/$filename does not exist");
446 if (-e $outfile && ($script eq 'postrm' || $script eq 'prerm')
448 # Add fragments to top so they run in reverse order when removing.
449 complex_doit("echo \"# Automatically added by ".basename($0)."\"> $outfile.new");
450 complex_doit("sed \"$sed\" $infile >> $outfile.new");
451 complex_doit("echo '# End automatically added section' >> $outfile.new");
452 complex_doit("cat $outfile >> $outfile.new");
453 complex_doit("mv $outfile.new $outfile");
456 complex_doit("echo \"# Automatically added by ".basename($0)."\">> $outfile");
457 complex_doit("sed \"$sed\" $infile >> $outfile");
458 complex_doit("echo '# End automatically added section' >> $outfile");
462 # Removes a whole substvar line.
467 my $ext=pkgext($package);
468 my $substvarfile="debian/${ext}substvars";
470 if (-e $substvarfile) {
471 complex_doit("grep -s -v '^${substvar}=' $substvarfile > $substvarfile.new || true");
472 doit("mv", "$substvarfile.new","$substvarfile");
476 # Adds a dependency on some package to the specified
477 # substvar in a package's substvar's file.
481 my $deppackage=shift;
485 my $ext=pkgext($package);
486 my $substvarfile="debian/${ext}substvars";
488 $str.=" ($verinfo)" if defined $verinfo && length $verinfo;
490 # Figure out what the line will look like, based on what's there
491 # now, and what we're to add or remove.
493 if (-e $substvarfile) {
495 open(SUBSTVARS_IN, "$substvarfile") || error "read $substvarfile: $!";
496 while (<SUBSTVARS_IN>) {
498 if (/^\Q$substvar\E=(.*)/) {
499 %items = map { $_ => 1} split(", ", $1);
511 $line=join(", ", sort keys %items);
518 complex_doit("(grep -s -v ${substvar} $substvarfile; echo ".escape_shell("${substvar}=$line").") > $substvarfile.new");
519 doit("mv", "$substvarfile.new", $substvarfile);
522 delsubstvar($package,$substvar);
526 # Reads in the specified file, one line at a time. splits on words,
527 # and returns an array of arrays of the contents.
528 # If a value is passed in as the second parameter, then glob
529 # expansion is done in the directory specified by the parameter ("." is
530 # frequently a good choice).
531 sub filedoublearray {
536 open (DH_FARRAY_IN, $file) || error("cannot read $file: $1");
537 while (<DH_FARRAY_IN>) {
539 # Only ignore comments and empty lines in v5 mode.
541 next if /^#/ || /^$/;
544 # Only do glob expansion in v3 mode.
546 # The tricky bit is that the glob expansion is done
547 # as if we were in the specified directory, so the
548 # filenames that come out are relative to it.
549 if (defined $globdir && ! compat(2)) {
550 for (map { glob "$globdir/$_" } split) {
565 # Reads in the specified file, one word at a time, and returns an array of
566 # the result. Can do globbing as does filedoublearray.
568 return map { @$_ } filedoublearray(@_);
571 # Passed a filename, returns true if -X says that file should be excluded.
573 my $filename = shift;
574 foreach my $f (@{$dh{EXCLUDE}}) {
575 return 1 if $filename =~ /\Q$f\E/;
580 # Returns the build architecture. (Memoized)
585 return $arch if defined $arch;
587 $arch=`dpkg-architecture -qDEB_HOST_ARCH 2>/dev/null` || error("dpkg-architecture failed");
593 # Passed an arch and a list of arches to match against, returns true if matched
596 my @archlist=split(/\s+/,shift);
598 foreach my $a (@archlist) {
599 system("dpkg-architecture", "-a$arch", "-i$a") == 0 && return 1;
605 # Returns a list of packages in the control file.
606 # Must pass "arch" or "indep" or "same" to specify arch-dependant or
607 # -independant or same arch packages. If nothing is specified, returns all
609 # As a side effect, populates %package_arches and %package_types with the
610 # types of all packages (not only those returned).
611 my (%package_types, %package_arches);
618 $type="" if ! defined $type;
620 # Look up the build arch if we need to.
622 if ($type eq 'same') {
623 $buildarch=buildarch();
631 open (CONTROL, 'debian/control') ||
632 error("cannot read debian/control: $!\n");
636 if (/^Package:\s*(.*)/) {
638 # Detect duplicate package names in the same control file.
639 if (! $seen{$package}) {
643 error("debian/control has a duplicate entry for $package");
647 if (/^Architecture:\s*(.*)/) {
650 if (/^(?:X[BC]*-)?Package-Type:\s*(.*)/) {
654 if (!$_ or eof) { # end of stanza.
656 $package_types{$package}=$package_type;
657 $package_arches{$package}=$arch;
660 (($type eq 'indep' && $arch eq 'all') ||
661 ($type eq 'arch' && $arch ne 'all') ||
662 ($type eq 'same' && ($arch eq 'any' || samearch($buildarch, $arch))) ||
664 push @list, $package;
675 # Returns the arch a package will build for.
679 if (! exists $package_arches{$package}) {
680 warning "package $package is not in control info";
683 return $package_arches{$package} eq 'all' ? "all" : buildarch();
686 # Return true if a given package is really a udeb.
690 if (! exists $package_types{$package}) {
691 warning "package $package is not in control info";
694 return $package_types{$package} eq 'udeb';
697 # Generates the filename that is used for a udeb package.
701 my $filearch=package_arch($package);
702 isnative($package); # side effect
703 my $version=$dh{VERSION};
704 $version=~s/^[0-9]+://; # strip any epoch
705 return "${package}_${version}_$filearch.udeb";
708 # Handles #DEBHELPER# substitution in a script; also can generate a new
709 # script from scratch if none exists but there is a .debhelper file for it.
710 sub debhelper_script_subst {
714 my $tmp=tmpdir($package);
715 my $ext=pkgext($package);
716 my $file=pkgfile($package,$script);
719 if (-f "debian/$ext$script.debhelper") {
720 # Add this into the script, where it has #DEBHELPER#
721 complex_doit("perl -pe 's~#DEBHELPER#~qx{cat debian/$ext$script.debhelper}~eg' < $file > $tmp/DEBIAN/$script");
724 # Just get rid of any #DEBHELPER# in the script.
725 complex_doit("sed s/#DEBHELPER#// < $file > $tmp/DEBIAN/$script");
727 doit("chown","0:0","$tmp/DEBIAN/$script");
728 doit("chmod",755,"$tmp/DEBIAN/$script");
730 elsif ( -f "debian/$ext$script.debhelper" ) {
731 complex_doit("printf '#!/bin/sh\nset -e\n' > $tmp/DEBIAN/$script");
732 complex_doit("cat debian/$ext$script.debhelper >> $tmp/DEBIAN/$script");
733 doit("chown","0:0","$tmp/DEBIAN/$script");
734 doit("chmod",755,"$tmp/DEBIAN/$script");