3 # Library functions for debhelper programs, perl version.
5 # Joey Hess, GPL copyright 1997-2000.
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);
22 # If DH_OPTIONS is set, prepend it @ARGV.
23 if (defined($ENV{DH_OPTIONS})) {
24 # Ignore leading/trailing whitespace.
25 $ENV{DH_OPTIONS}=~s/^\s+//;
26 $ENV{DH_OPTIONS}=~s/\s+$//;
27 unshift @ARGV,split(/\s+/,$ENV{DH_OPTIONS});
30 # Check to see if an argument on the command line starts with a dash.
31 # if so, we need to pass this off to the resource intensive
32 # Getopt::Long, which I'd prefer to avoid loading at all if possible.
35 foreach $arg (@ARGV) {
42 eval "use Debian::Debhelper::Dh_Getopt";
44 %dh=Debian::Debhelper::Dh_Getopt::parseopts();
47 # Another way to set excludes.
48 if (exists $ENV{DH_ALWAYS_EXCLUDE} && length $ENV{DH_ALWAYS_EXCLUDE}) {
49 push @{$dh{EXCLUDE}}, split(":", $ENV{DH_ALWAYS_EXCLUDE});
52 # Generate EXCLUDE_FIND.
55 foreach (@{$dh{EXCLUDE}}) {
59 $dh{EXCLUDE_FIND}.="-regex .\\*$x.\\* -or ";
61 $dh{EXCLUDE_FIND}=~s/ -or $//;
64 # Check to see if DH_VERBOSE environment variable was set, if so,
65 # make sure verbose is on.
66 if (defined $ENV{DH_VERBOSE} && $ENV{DH_VERBOSE} ne "") {
70 # Check to see if DH_NO_ACT environment variable was set, if so,
71 # make sure no act mode is on.
72 if (defined $ENV{DH_NO_ACT} && $ENV{DH_NO_ACT} ne "") {
76 my @allpackages=getpackages();
77 # Get the name of the main binary package (first one listed in
78 # debian/control). Only if the main package was not set on the
80 if (! exists $dh{MAINPACKAGE} || ! defined $dh{MAINPACKAGE}) {
81 $dh{MAINPACKAGE}=$allpackages[0];
84 # Check if packages to build have been specified, if not, fall back to
85 # the default, doing them all.
86 if (! defined $dh{DOPACKAGES} || ! @{$dh{DOPACKAGES}}) {
87 if ($dh{DOINDEP} || $dh{DOARCH} || $dh{DOSAME}) {
88 error("You asked that all arch in(dep) packages be built, but there are none of that type.");
90 push @{$dh{DOPACKAGES}},@allpackages;
93 # Check to see if -P was specified. If so, we can only act on a single
95 if ($dh{TMPDIR} && $#{$dh{DOPACKAGES}} > 0) {
96 error("-P was specified, but multiple packages would be acted on (".join(",",@{$dh{DOPACKAGES}}).").");
99 # Figure out which package is the first one we were instructed to build.
100 # This package gets special treatement: files and directories specified on
101 # the command line may affect it.
102 $dh{FIRSTPACKAGE}=${$dh{DOPACKAGES}}[0];
104 # If no error handling function was specified, just propigate
106 if (! exists $dh{ERROR_HANDLER} || ! defined $dh{ERROR_HANDLER}) {
107 $dh{ERROR_HANDLER}='exit \$?';
111 # Run at exit. Add the command to the log files for the packages it acted
112 # on, if it's exiting successfully.
115 my $cmd=basename($0);
116 # dh_clean deletes the log, so should not recreate it at
118 if ($cmd ne "dh_clean") {
119 foreach my $package (@{$dh{DOPACKAGES}}) {
120 my $ext=pkgext($package);
121 open(LOG, ">>", "debian/${ext}debhelper.log") || error("failed to write to log");
129 # Pass it an array containing the arguments of a shell command like would
130 # be run by exec(). It turns that into a line like you might enter at the
131 # shell, escaping metacharacters and quoting arguments that contain spaces.
136 foreach my $word (@args) {
138 # Escape only a few things since it will be quoted.
139 # Note we use double quotes because you cannot
140 # escape ' in single quotes, while " can be escaped
142 # This does make -V"foo bar" turn into "-Vfoo bar",
143 # but that will be parsed identically by the shell
145 $word=~s/([\n`\$"\\])/\\$1/g;
146 push @ret, "\"$word\"";
149 # This list is from _Unix in a Nutshell_. (except '#')
150 $word=~s/([\s!"\$()*+#;<>?@\[\]\\`|~])/\\$1/g;
154 return join(' ', @ret);
157 # Run a command, and display the command to stdout if verbose mode is on.
158 # All commands that modifiy files in $TMP should be ran via this
161 # Note that this cannot handle complex commands, especially anything
162 # involving redirection. Use complex_doit instead.
164 verbose_print(escape_shell(@_));
168 $ret == 0 || error("command returned error code $ret");
172 # Run a command and display the command to stdout if verbose mode is on.
173 # Use doit() if you can, instead of this function, because this function
174 # forks a shell. However, this function can handle more complicated stuff
177 verbose_print(join(" ",@_));
180 # The join makes system get a scalar so it forks off a shell.
181 system(join(" ",@_)) == 0
182 || error("command returned error code");
186 # Run a command that may have a huge number of arguments, like xargs does.
187 # Pass in a reference to an array containing the arguments, and then other
188 # parameters that are the command and any parameters that should be passed to
193 # The kernel can accept command lines up to 20k worth of characters.
194 my $command_max=20000; # LINUX SPECIFIC!!
195 # I could use POSIX::ARG_MAX, but that would be slow.
197 # Figure out length of static portion of command.
200 $static_length+=length($_)+1;
204 my $length=$static_length;
206 if (length($_) + 1 + $static_length > $command_max) {
207 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? \"@_ $_\"");
209 $length+=length($_) + 1;
210 if ($length < $command_max) {
214 doit(@_,@collect) if $#collect > -1;
216 $length=$static_length + length($_) + 1;
219 doit(@_,@collect) if $#collect > -1;
222 # Print something if the verbose flag is on.
227 print "\t$message\n";
231 # Output an error message and exit.
243 print STDERR basename($0).": $message\n";
246 # Returns the basename of the argument passed to it.
250 $fn=~s/\/$//g; # ignore trailing slashes
251 $fn=~s:^.*/(.*?)$:$1:;
255 # Returns the directory name of the argument passed to it.
259 $fn=~s/\/$//g; # ignore trailing slashes
260 $fn=~s:^(.*)/.*?$:$1:;
264 # Pass in a number, will return true iff the current compatibility level
265 # is less than or equal to that number.
275 if (defined $ENV{DH_COMPAT}) {
278 elsif (-e 'debian/compat') {
280 open (COMPAT_IN, "debian/compat") || error "debian/compat: $!";
282 if (! defined $l || ! length $l) {
283 warning("debian/compat is empty, assuming level $c");
292 if ($c < 4 && ! $warned_compat) {
293 warning("Compatibility levels before 4 are deprecated.");
297 if ($c > $max_compat) {
298 error("Sorry, but $max_compat is the highest compatibility level supported by this debhelper.");
305 # Pass it a name of a binary package, it returns the name of the tmp dir to
306 # use, for that package.
313 elsif (compat(1) && $package eq $dh{MAINPACKAGE}) {
314 # This is for back-compatibility with the debian/tmp tradition.
318 return "debian/$package";
322 # Pass this the name of a binary package, and the name of the file wanted
323 # for the package, and it will return the actual existing filename to use.
325 # It tries several filenames:
326 # * debian/package.filename.buildarch
327 # * debian/package.filename
328 # * debian/file (if the package is the main package)
329 # If --name was specified then tonly the first two are tried, and they must
330 # have the name after the pacage name:
331 # * debian/package.name.filename.buildarch
332 # * debian/package.name.filename
337 if (defined $dh{NAME}) {
338 $filename="$dh{NAME}.$filename";
341 my @try=("debian/$package.$filename.".buildarch(),
342 "debian/$package.$filename");
343 if ($package eq $dh{MAINPACKAGE}) {
344 push @try, "debian/$filename";
347 foreach my $file (@try) {
349 (! $dh{IGNORE} || ! exists $dh{IGNORE}->{$file})) {
359 # Pass it a name of a binary package, it returns the name to prefix to files
360 # in debian/ for this package.
364 if (compat(1) and $package eq $dh{MAINPACKAGE}) {
370 # Pass it the name of a binary package, it returns the name to install
371 # files by in eg, etc. Normally this is the same, but --name can override
376 if (defined $dh{NAME}) {
382 # Returns 1 if the package is a native debian package, null otherwise.
383 # As a side effect, sets $dh{VERSION} to the version of this package.
385 # Caches return code so it only needs to run dpkg-parsechangelog once.
391 return $isnative_cache{$package} if defined $isnative_cache{$package};
393 # Make sure we look at the correct changelog.
394 my $isnative_changelog=pkgfile($package,"changelog");
395 if (! $isnative_changelog) {
396 $isnative_changelog="debian/changelog";
398 # Get the package version.
399 my $version=`dpkg-parsechangelog -l$isnative_changelog`;
400 ($dh{VERSION})=$version=~m/Version:\s*(.*)/m;
401 # Did the changelog parse fail?
402 if (! defined $dh{VERSION}) {
403 error("changelog parse failure");
406 # Is this a native Debian package?
407 if ($dh{VERSION}=~m/.*-/) {
408 return $isnative_cache{$package}=0;
411 return $isnative_cache{$package}=1;
416 # Automatically add a shell script snippet to a debian script.
417 # Only works if the script has #DEBHELPER# in it.
421 # 2: script to add to
422 # 3: filename of snippet
423 # 4: sed to run on the snippet. Ie, s/#PACKAGE#/$PACKAGE/
430 # This is the file we will modify.
431 my $outfile="debian/".pkgext($package)."$script.debhelper";
433 # Figure out what shell script snippet to use.
435 if (defined($ENV{DH_AUTOSCRIPTDIR}) &&
436 -e "$ENV{DH_AUTOSCRIPTDIR}/$filename") {
437 $infile="$ENV{DH_AUTOSCRIPTDIR}/$filename";
440 if (-e "/usr/share/debhelper/autoscripts/$filename") {
441 $infile="/usr/share/debhelper/autoscripts/$filename";
444 error("/usr/share/debhelper/autoscripts/$filename does not exist");
448 if (-e $outfile && ($script eq 'postrm' || $script eq 'prerm')
450 # Add fragments to top so they run in reverse order when removing.
451 complex_doit("echo \"# Automatically added by ".basename($0)."\"> $outfile.new");
452 complex_doit("sed \"$sed\" $infile >> $outfile.new");
453 complex_doit("echo '# End automatically added section' >> $outfile.new");
454 complex_doit("cat $outfile >> $outfile.new");
455 complex_doit("mv $outfile.new $outfile");
458 complex_doit("echo \"# Automatically added by ".basename($0)."\">> $outfile");
459 complex_doit("sed \"$sed\" $infile >> $outfile");
460 complex_doit("echo '# End automatically added section' >> $outfile");
464 # Removes a whole substvar line.
469 my $ext=pkgext($package);
470 my $substvarfile="debian/${ext}substvars";
472 if (-e $substvarfile) {
473 complex_doit("grep -s -v '^${substvar}=' $substvarfile > $substvarfile.new || true");
474 doit("mv", "$substvarfile.new","$substvarfile");
478 # Adds a dependency on some package to the specified
479 # substvar in a package's substvar's file.
483 my $deppackage=shift;
487 my $ext=pkgext($package);
488 my $substvarfile="debian/${ext}substvars";
490 $str.=" ($verinfo)" if defined $verinfo && length $verinfo;
492 # Figure out what the line will look like, based on what's there
493 # now, and what we're to add or remove.
495 if (-e $substvarfile) {
497 open(SUBSTVARS_IN, "$substvarfile") || error "read $substvarfile: $!";
498 while (<SUBSTVARS_IN>) {
500 if (/^\Q$substvar\E=(.*)/) {
501 %items = map { $_ => 1} split(", ", $1);
513 $line=join(", ", sort keys %items);
520 complex_doit("(grep -s -v ${substvar} $substvarfile; echo ".escape_shell("${substvar}=$line").") > $substvarfile.new");
521 doit("mv", "$substvarfile.new", $substvarfile);
524 delsubstvar($package,$substvar);
528 # Reads in the specified file, one line at a time. splits on words,
529 # and returns an array of arrays of the contents.
530 # If a value is passed in as the second parameter, then glob
531 # expansion is done in the directory specified by the parameter ("." is
532 # frequently a good choice).
533 sub filedoublearray {
538 open (DH_FARRAY_IN, $file) || error("cannot read $file: $1");
539 while (<DH_FARRAY_IN>) {
541 # Only ignore comments and empty lines in v5 mode.
543 next if /^#/ || /^$/;
546 # Only do glob expansion in v3 mode.
548 # The tricky bit is that the glob expansion is done
549 # as if we were in the specified directory, so the
550 # filenames that come out are relative to it.
551 if (defined $globdir && ! compat(2)) {
552 for (map { glob "$globdir/$_" } split) {
567 # Reads in the specified file, one word at a time, and returns an array of
568 # the result. Can do globbing as does filedoublearray.
570 return map { @$_ } filedoublearray(@_);
573 # Passed a filename, returns true if -X says that file should be excluded.
575 my $filename = shift;
576 foreach my $f (@{$dh{EXCLUDE}}) {
577 return 1 if $filename =~ /\Q$f\E/;
582 # Returns the build architecture. (Memoized)
587 return $arch if defined $arch;
589 $arch=`dpkg-architecture -qDEB_HOST_ARCH 2>/dev/null` || error("dpkg-architecture failed");
595 # Passed an arch and a list of arches to match against, returns true if matched
598 my @archlist=split(/\s+/,shift);
600 foreach my $a (@archlist) {
601 system("dpkg-architecture", "-a$arch", "-i$a") == 0 && return 1;
607 # Returns a list of packages in the control file.
608 # Must pass "arch" or "indep" or "same" to specify arch-dependant or
609 # -independant or same arch packages. If nothing is specified, returns all
611 # As a side effect, populates %package_arches and %package_types with the
612 # types of all packages (not only those returned).
613 my (%package_types, %package_arches);
620 $type="" if ! defined $type;
622 # Look up the build arch if we need to.
624 if ($type eq 'same') {
625 $buildarch=buildarch();
633 open (CONTROL, 'debian/control') ||
634 error("cannot read debian/control: $!\n");
638 if (/^Package:\s*(.*)/) {
640 # Detect duplicate package names in the same control file.
641 if (! $seen{$package}) {
645 error("debian/control has a duplicate entry for $package");
649 if (/^Architecture:\s*(.*)/) {
652 if (/^(?:X[BC]*-)?Package-Type:\s*(.*)/) {
656 if (!$_ or eof) { # end of stanza.
658 $package_types{$package}=$package_type;
659 $package_arches{$package}=$arch;
662 (($type eq 'indep' && $arch eq 'all') ||
663 ($type eq 'arch' && $arch ne 'all') ||
664 ($type eq 'same' && ($arch eq 'any' || samearch($buildarch, $arch))) ||
666 push @list, $package;
677 # Returns the arch a package will build for.
681 if (! exists $package_arches{$package}) {
682 warning "package $package is not in control info";
685 return $package_arches{$package} eq 'all' ? "all" : buildarch();
688 # Return true if a given package is really a udeb.
692 if (! exists $package_types{$package}) {
693 warning "package $package is not in control info";
696 return $package_types{$package} eq 'udeb';
699 # Generates the filename that is used for a udeb package.
703 my $filearch=package_arch($package);
704 isnative($package); # side effect
705 my $version=$dh{VERSION};
706 $version=~s/^[0-9]+://; # strip any epoch
707 return "${package}_${version}_$filearch.udeb";
710 # Handles #DEBHELPER# substitution in a script; also can generate a new
711 # script from scratch if none exists but there is a .debhelper file for it.
712 sub debhelper_script_subst {
716 my $tmp=tmpdir($package);
717 my $ext=pkgext($package);
718 my $file=pkgfile($package,$script);
721 if (-f "debian/$ext$script.debhelper") {
722 # Add this into the script, where it has #DEBHELPER#
723 complex_doit("perl -pe 's~#DEBHELPER#~qx{cat debian/$ext$script.debhelper}~eg' < $file > $tmp/DEBIAN/$script");
726 # Just get rid of any #DEBHELPER# in the script.
727 complex_doit("sed s/#DEBHELPER#// < $file > $tmp/DEBIAN/$script");
729 doit("chown","0:0","$tmp/DEBIAN/$script");
730 doit("chmod",755,"$tmp/DEBIAN/$script");
732 elsif ( -f "debian/$ext$script.debhelper" ) {
733 complex_doit("printf '#!/bin/sh\nset -e\n' > $tmp/DEBIAN/$script");
734 complex_doit("cat debian/$ext$script.debhelper >> $tmp/DEBIAN/$script");
735 doit("chown","0:0","$tmp/DEBIAN/$script");
736 doit("chmod",755,"$tmp/DEBIAN/$script");