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
23 # If DH_OPTIONS is set, prepend it @ARGV.
24 if (defined($ENV{DH_OPTIONS})) {
25 # Ignore leading/trailing whitespace.
26 $ENV{DH_OPTIONS}=~s/^\s+//;
27 $ENV{DH_OPTIONS}=~s/\s+$//;
28 unshift @ARGV,split(/\s+/,$ENV{DH_OPTIONS});
31 # Check to see if an argument on the command line starts with a dash.
32 # if so, we need to pass this off to the resource intensive
33 # Getopt::Long, which I'd prefer to avoid loading at all if possible.
34 if ((defined $ENV{DH_OPTIONS} && length $ENV{DH_OPTIONS}) ||
35 (defined $ENV{DH_INTERNAL_OPTIONS} && length $ENV{DH_INTERNAL_OPTIONS}) ||
37 eval "use Debian::Debhelper::Dh_Getopt";
39 %dh=Debian::Debhelper::Dh_Getopt::parseopts();
42 # Another way to set excludes.
43 if (exists $ENV{DH_ALWAYS_EXCLUDE} && length $ENV{DH_ALWAYS_EXCLUDE}) {
44 push @{$dh{EXCLUDE}}, split(":", $ENV{DH_ALWAYS_EXCLUDE});
47 # Generate EXCLUDE_FIND.
50 foreach (@{$dh{EXCLUDE}}) {
54 $dh{EXCLUDE_FIND}.="-regex .\\*$x.\\* -or ";
56 $dh{EXCLUDE_FIND}=~s/ -or $//;
59 # Check to see if DH_VERBOSE environment variable was set, if so,
60 # make sure verbose is on.
61 if (defined $ENV{DH_VERBOSE} && $ENV{DH_VERBOSE} ne "") {
65 # Check to see if DH_NO_ACT environment variable was set, if so,
66 # make sure no act mode is on.
67 if (defined $ENV{DH_NO_ACT} && $ENV{DH_NO_ACT} ne "") {
71 my @allpackages=getpackages();
72 # Get the name of the main binary package (first one listed in
73 # debian/control). Only if the main package was not set on the
75 if (! exists $dh{MAINPACKAGE} || ! defined $dh{MAINPACKAGE}) {
76 $dh{MAINPACKAGE}=$allpackages[0];
79 # Check if packages to build have been specified, if not, fall back to
80 # the default, doing them all.
81 if (! defined $dh{DOPACKAGES} || ! @{$dh{DOPACKAGES}}) {
82 if ($dh{DOINDEP} || $dh{DOARCH} || $dh{DOSAME}) {
83 error("You asked that all arch in(dep) packages be built, but there are none of that type.");
85 push @{$dh{DOPACKAGES}},@allpackages;
88 # Check to see if -P was specified. If so, we can only act on a single
90 if ($dh{TMPDIR} && $#{$dh{DOPACKAGES}} > 0) {
91 error("-P was specified, but multiple packages would be acted on (".join(",",@{$dh{DOPACKAGES}}).").");
94 # Figure out which package is the first one we were instructed to build.
95 # This package gets special treatement: files and directories specified on
96 # the command line may affect it.
97 $dh{FIRSTPACKAGE}=${$dh{DOPACKAGES}}[0];
99 # If no error handling function was specified, just propigate
101 if (! exists $dh{ERROR_HANDLER} || ! defined $dh{ERROR_HANDLER}) {
102 $dh{ERROR_HANDLER}='exit \$?';
106 # Run at exit. Add the command to the log files for the packages it acted
107 # on, if it's exiting successfully.
110 if ($? == 0 && $write_log) {
111 write_log(basename($0), @{$dh{DOPACKAGES}});
119 foreach my $package (@packages) {
120 my $ext=pkgext($package);
121 my $log="debian/${ext}debhelper.log";
122 open(LOG, ">>", $log) || error("failed to write to ${log}: $!");
132 # Pass it an array containing the arguments of a shell command like would
133 # be run by exec(). It turns that into a line like you might enter at the
134 # shell, escaping metacharacters and quoting arguments that contain spaces.
139 foreach my $word (@args) {
141 # Escape only a few things since it will be quoted.
142 # Note we use double quotes because you cannot
143 # escape ' in single quotes, while " can be escaped
145 # This does make -V"foo bar" turn into "-Vfoo bar",
146 # but that will be parsed identically by the shell
148 $word=~s/([\n`\$"\\])/\\$1/g;
149 push @ret, "\"$word\"";
152 # This list is from _Unix in a Nutshell_. (except '#')
153 $word=~s/([\s!"\$()*+#;<>?@\[\]\\`|~])/\\$1/g;
157 return join(' ', @ret);
160 # Run a command, and display the command to stdout if verbose mode is on.
161 # All commands that modifiy files in $TMP should be ran via this
164 # Note that this cannot handle complex commands, especially anything
165 # involving redirection. Use complex_doit instead.
167 verbose_print(escape_shell(@_));
171 $ret == 0 || error("command returned error code $ret");
175 # Run a command and display the command to stdout if verbose mode is on.
176 # Use doit() if you can, instead of this function, because this function
177 # forks a shell. However, this function can handle more complicated stuff
180 verbose_print(join(" ",@_));
183 # The join makes system get a scalar so it forks off a shell.
184 system(join(" ",@_)) == 0
185 || error("command returned error code");
189 # Run a command that may have a huge number of arguments, like xargs does.
190 # Pass in a reference to an array containing the arguments, and then other
191 # parameters that are the command and any parameters that should be passed to
196 # The kernel can accept command lines up to 20k worth of characters.
197 my $command_max=20000; # LINUX SPECIFIC!!
198 # I could use POSIX::ARG_MAX, but that would be slow.
200 # Figure out length of static portion of command.
203 $static_length+=length($_)+1;
207 my $length=$static_length;
209 if (length($_) + 1 + $static_length > $command_max) {
210 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? \"@_ $_\"");
212 $length+=length($_) + 1;
213 if ($length < $command_max) {
217 doit(@_,@collect) if $#collect > -1;
219 $length=$static_length + length($_) + 1;
222 doit(@_,@collect) if $#collect > -1;
225 # Print something if the verbose flag is on.
230 print "\t$message\n";
234 # Output an error message and exit.
246 print STDERR basename($0).": $message\n";
249 # Returns the basename of the argument passed to it.
253 $fn=~s/\/$//g; # ignore trailing slashes
254 $fn=~s:^.*/(.*?)$:$1:;
258 # Returns the directory name of the argument passed to it.
262 $fn=~s/\/$//g; # ignore trailing slashes
263 $fn=~s:^(.*)/.*?$:$1:;
267 # Pass in a number, will return true iff the current compatibility level
268 # is less than or equal to that number.
278 if (defined $ENV{DH_COMPAT}) {
281 elsif (-e 'debian/compat') {
283 open (COMPAT_IN, "debian/compat") || error "debian/compat: $!";
285 if (! defined $l || ! length $l) {
286 warning("debian/compat is empty, assuming level $c");
295 if ($c < 4 && ! $warned_compat) {
296 warning("Compatibility levels before 4 are deprecated.");
300 if ($c > $max_compat) {
301 error("Sorry, but $max_compat is the highest compatibility level supported by this debhelper.");
308 # Pass it a name of a binary package, it returns the name of the tmp dir to
309 # use, for that package.
316 elsif (compat(1) && $package eq $dh{MAINPACKAGE}) {
317 # This is for back-compatibility with the debian/tmp tradition.
321 return "debian/$package";
325 # Pass this the name of a binary package, and the name of the file wanted
326 # for the package, and it will return the actual existing filename to use.
328 # It tries several filenames:
329 # * debian/package.filename.buildarch
330 # * debian/package.filename
331 # * debian/file (if the package is the main package)
332 # If --name was specified then tonly the first two are tried, and they must
333 # have the name after the pacage name:
334 # * debian/package.name.filename.buildarch
335 # * debian/package.name.filename
340 if (defined $dh{NAME}) {
341 $filename="$dh{NAME}.$filename";
344 my @try=("debian/$package.$filename.".buildarch(),
345 "debian/$package.$filename");
346 if ($package eq $dh{MAINPACKAGE}) {
347 push @try, "debian/$filename";
350 foreach my $file (@try) {
352 (! $dh{IGNORE} || ! exists $dh{IGNORE}->{$file})) {
362 # Pass it a name of a binary package, it returns the name to prefix to files
363 # in debian/ for this package.
367 if (compat(1) and $package eq $dh{MAINPACKAGE}) {
373 # Pass it the name of a binary package, it returns the name to install
374 # files by in eg, etc. Normally this is the same, but --name can override
379 if (defined $dh{NAME}) {
385 # Returns 1 if the package is a native debian package, null otherwise.
386 # As a side effect, sets $dh{VERSION} to the version of this package.
388 # Caches return code so it only needs to run dpkg-parsechangelog once.
394 return $isnative_cache{$package} if defined $isnative_cache{$package};
396 # Make sure we look at the correct changelog.
397 my $isnative_changelog=pkgfile($package,"changelog");
398 if (! $isnative_changelog) {
399 $isnative_changelog="debian/changelog";
401 # Get the package version.
402 my $version=`dpkg-parsechangelog -l$isnative_changelog`;
403 ($dh{VERSION})=$version=~m/Version:\s*(.*)/m;
404 # Did the changelog parse fail?
405 if (! defined $dh{VERSION}) {
406 error("changelog parse failure");
409 # Is this a native Debian package?
410 if ($dh{VERSION}=~m/.*-/) {
411 return $isnative_cache{$package}=0;
414 return $isnative_cache{$package}=1;
419 # Automatically add a shell script snippet to a debian script.
420 # Only works if the script has #DEBHELPER# in it.
424 # 2: script to add to
425 # 3: filename of snippet
426 # 4: sed to run on the snippet. Ie, s/#PACKAGE#/$PACKAGE/
433 # This is the file we will modify.
434 my $outfile="debian/".pkgext($package)."$script.debhelper";
436 # Figure out what shell script snippet to use.
438 if (defined($ENV{DH_AUTOSCRIPTDIR}) &&
439 -e "$ENV{DH_AUTOSCRIPTDIR}/$filename") {
440 $infile="$ENV{DH_AUTOSCRIPTDIR}/$filename";
443 if (-e "/usr/share/debhelper/autoscripts/$filename") {
444 $infile="/usr/share/debhelper/autoscripts/$filename";
447 error("/usr/share/debhelper/autoscripts/$filename does not exist");
451 if (-e $outfile && ($script eq 'postrm' || $script eq 'prerm')
453 # Add fragments to top so they run in reverse order when removing.
454 complex_doit("echo \"# Automatically added by ".basename($0)."\"> $outfile.new");
455 complex_doit("sed \"$sed\" $infile >> $outfile.new");
456 complex_doit("echo '# End automatically added section' >> $outfile.new");
457 complex_doit("cat $outfile >> $outfile.new");
458 complex_doit("mv $outfile.new $outfile");
461 complex_doit("echo \"# Automatically added by ".basename($0)."\">> $outfile");
462 complex_doit("sed \"$sed\" $infile >> $outfile");
463 complex_doit("echo '# End automatically added section' >> $outfile");
467 # Removes a whole substvar line.
472 my $ext=pkgext($package);
473 my $substvarfile="debian/${ext}substvars";
475 if (-e $substvarfile) {
476 complex_doit("grep -s -v '^${substvar}=' $substvarfile > $substvarfile.new || true");
477 doit("mv", "$substvarfile.new","$substvarfile");
481 # Adds a dependency on some package to the specified
482 # substvar in a package's substvar's file.
486 my $deppackage=shift;
490 my $ext=pkgext($package);
491 my $substvarfile="debian/${ext}substvars";
493 $str.=" ($verinfo)" if defined $verinfo && length $verinfo;
495 # Figure out what the line will look like, based on what's there
496 # now, and what we're to add or remove.
498 if (-e $substvarfile) {
500 open(SUBSTVARS_IN, "$substvarfile") || error "read $substvarfile: $!";
501 while (<SUBSTVARS_IN>) {
503 if (/^\Q$substvar\E=(.*)/) {
504 %items = map { $_ => 1} split(", ", $1);
516 $line=join(", ", sort keys %items);
523 complex_doit("(grep -s -v ${substvar} $substvarfile; echo ".escape_shell("${substvar}=$line").") > $substvarfile.new");
524 doit("mv", "$substvarfile.new", $substvarfile);
527 delsubstvar($package,$substvar);
531 # Reads in the specified file, one line at a time. splits on words,
532 # and returns an array of arrays of the contents.
533 # If a value is passed in as the second parameter, then glob
534 # expansion is done in the directory specified by the parameter ("." is
535 # frequently a good choice).
536 sub filedoublearray {
541 open (DH_FARRAY_IN, $file) || error("cannot read $file: $1");
542 while (<DH_FARRAY_IN>) {
544 # Only ignore comments and empty lines in v5 mode.
546 next if /^#/ || /^$/;
549 # Only do glob expansion in v3 mode.
551 # The tricky bit is that the glob expansion is done
552 # as if we were in the specified directory, so the
553 # filenames that come out are relative to it.
554 if (defined $globdir && ! compat(2)) {
555 for (map { glob "$globdir/$_" } split) {
570 # Reads in the specified file, one word at a time, and returns an array of
571 # the result. Can do globbing as does filedoublearray.
573 return map { @$_ } filedoublearray(@_);
576 # Passed a filename, returns true if -X says that file should be excluded.
578 my $filename = shift;
579 foreach my $f (@{$dh{EXCLUDE}}) {
580 return 1 if $filename =~ /\Q$f\E/;
585 # Returns the build architecture. (Memoized)
590 return $arch if defined $arch;
592 $arch=`dpkg-architecture -qDEB_HOST_ARCH 2>/dev/null` || error("dpkg-architecture failed");
598 # Passed an arch and a list of arches to match against, returns true if matched
601 my @archlist=split(/\s+/,shift);
603 foreach my $a (@archlist) {
604 system("dpkg-architecture", "-a$arch", "-i$a") == 0 && return 1;
610 # Returns a list of packages in the control file.
611 # Must pass "arch" or "indep" or "same" to specify arch-dependant or
612 # -independant or same arch packages. If nothing is specified, returns all
614 # As a side effect, populates %package_arches and %package_types with the
615 # types of all packages (not only those returned).
616 my (%package_types, %package_arches);
623 $type="" if ! defined $type;
625 # Look up the build arch if we need to.
627 if ($type eq 'same') {
628 $buildarch=buildarch();
636 open (CONTROL, 'debian/control') ||
637 error("cannot read debian/control: $!\n");
641 if (/^Package:\s*(.*)/) {
643 # Detect duplicate package names in the same control file.
644 if (! $seen{$package}) {
648 error("debian/control has a duplicate entry for $package");
652 if (/^Architecture:\s*(.*)/) {
655 if (/^(?:X[BC]*-)?Package-Type:\s*(.*)/) {
659 if (!$_ or eof) { # end of stanza.
661 $package_types{$package}=$package_type;
662 $package_arches{$package}=$arch;
665 (($type eq 'indep' && $arch eq 'all') ||
666 ($type eq 'arch' && $arch ne 'all') ||
667 ($type eq 'same' && ($arch eq 'any' || samearch($buildarch, $arch))) ||
669 push @list, $package;
680 # Returns the arch a package will build for.
684 if (! exists $package_arches{$package}) {
685 warning "package $package is not in control info";
688 return $package_arches{$package} eq 'all' ? "all" : buildarch();
691 # Return true if a given package is really a udeb.
695 if (! exists $package_types{$package}) {
696 warning "package $package is not in control info";
699 return $package_types{$package} eq 'udeb';
702 # Generates the filename that is used for a udeb package.
706 my $filearch=package_arch($package);
707 isnative($package); # side effect
708 my $version=$dh{VERSION};
709 $version=~s/^[0-9]+://; # strip any epoch
710 return "${package}_${version}_$filearch.udeb";
713 # Handles #DEBHELPER# substitution in a script; also can generate a new
714 # script from scratch if none exists but there is a .debhelper file for it.
715 sub debhelper_script_subst {
719 my $tmp=tmpdir($package);
720 my $ext=pkgext($package);
721 my $file=pkgfile($package,$script);
724 if (-f "debian/$ext$script.debhelper") {
725 # Add this into the script, where it has #DEBHELPER#
726 complex_doit("perl -pe 's~#DEBHELPER#~qx{cat debian/$ext$script.debhelper}~eg' < $file > $tmp/DEBIAN/$script");
729 # Just get rid of any #DEBHELPER# in the script.
730 complex_doit("sed s/#DEBHELPER#// < $file > $tmp/DEBIAN/$script");
732 doit("chown","0:0","$tmp/DEBIAN/$script");
733 doit("chmod",755,"$tmp/DEBIAN/$script");
735 elsif ( -f "debian/$ext$script.debhelper" ) {
736 complex_doit("printf '#!/bin/sh\nset -e\n' > $tmp/DEBIAN/$script");
737 complex_doit("cat debian/$ext$script.debhelper >> $tmp/DEBIAN/$script");
738 doit("chown","0:0","$tmp/DEBIAN/$script");
739 doit("chmod",755,"$tmp/DEBIAN/$script");