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
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.
36 foreach $arg (@ARGV) {
43 eval "use Debian::Debhelper::Dh_Getopt";
45 %dh=Debian::Debhelper::Dh_Getopt::parseopts();
48 # Another way to set excludes.
49 if (exists $ENV{DH_ALWAYS_EXCLUDE} && length $ENV{DH_ALWAYS_EXCLUDE}) {
50 push @{$dh{EXCLUDE}}, split(":", $ENV{DH_ALWAYS_EXCLUDE});
53 # Generate EXCLUDE_FIND.
56 foreach (@{$dh{EXCLUDE}}) {
60 $dh{EXCLUDE_FIND}.="-regex .\\*$x.\\* -or ";
62 $dh{EXCLUDE_FIND}=~s/ -or $//;
65 # Check to see if DH_VERBOSE environment variable was set, if so,
66 # make sure verbose is on.
67 if (defined $ENV{DH_VERBOSE} && $ENV{DH_VERBOSE} ne "") {
71 # Check to see if DH_NO_ACT environment variable was set, if so,
72 # make sure no act mode is on.
73 if (defined $ENV{DH_NO_ACT} && $ENV{DH_NO_ACT} ne "") {
77 my @allpackages=getpackages();
78 # Get the name of the main binary package (first one listed in
79 # debian/control). Only if the main package was not set on the
81 if (! exists $dh{MAINPACKAGE} || ! defined $dh{MAINPACKAGE}) {
82 $dh{MAINPACKAGE}=$allpackages[0];
85 # Check if packages to build have been specified, if not, fall back to
86 # the default, doing them all.
87 if (! defined $dh{DOPACKAGES} || ! @{$dh{DOPACKAGES}}) {
88 if ($dh{DOINDEP} || $dh{DOARCH} || $dh{DOSAME}) {
89 error("You asked that all arch in(dep) packages be built, but there are none of that type.");
91 push @{$dh{DOPACKAGES}},@allpackages;
94 # Check to see if -P was specified. If so, we can only act on a single
96 if ($dh{TMPDIR} && $#{$dh{DOPACKAGES}} > 0) {
97 error("-P was specified, but multiple packages would be acted on (".join(",",@{$dh{DOPACKAGES}}).").");
100 # Figure out which package is the first one we were instructed to build.
101 # This package gets special treatement: files and directories specified on
102 # the command line may affect it.
103 $dh{FIRSTPACKAGE}=${$dh{DOPACKAGES}}[0];
105 # If no error handling function was specified, just propigate
107 if (! exists $dh{ERROR_HANDLER} || ! defined $dh{ERROR_HANDLER}) {
108 $dh{ERROR_HANDLER}='exit \$?';
112 # Run at exit. Add the command to the log files for the packages it acted
113 # on, if it's exiting successfully.
116 if ($? == 0 && $write_log) {
117 my $cmd=basename($0);
118 foreach my $package (@{$dh{DOPACKAGES}}) {
119 my $ext=pkgext($package);
120 open(LOG, ">>", "debian/${ext}debhelper.log") || error("failed to write to log");
131 # Pass it an array containing the arguments of a shell command like would
132 # be run by exec(). It turns that into a line like you might enter at the
133 # shell, escaping metacharacters and quoting arguments that contain spaces.
138 foreach my $word (@args) {
140 # Escape only a few things since it will be quoted.
141 # Note we use double quotes because you cannot
142 # escape ' in single quotes, while " can be escaped
144 # This does make -V"foo bar" turn into "-Vfoo bar",
145 # but that will be parsed identically by the shell
147 $word=~s/([\n`\$"\\])/\\$1/g;
148 push @ret, "\"$word\"";
151 # This list is from _Unix in a Nutshell_. (except '#')
152 $word=~s/([\s!"\$()*+#;<>?@\[\]\\`|~])/\\$1/g;
156 return join(' ', @ret);
159 # Run a command, and display the command to stdout if verbose mode is on.
160 # All commands that modifiy files in $TMP should be ran via this
163 # Note that this cannot handle complex commands, especially anything
164 # involving redirection. Use complex_doit instead.
166 verbose_print(escape_shell(@_));
170 $ret == 0 || error("command returned error code $ret");
174 # Run a command and display the command to stdout if verbose mode is on.
175 # Use doit() if you can, instead of this function, because this function
176 # forks a shell. However, this function can handle more complicated stuff
179 verbose_print(join(" ",@_));
182 # The join makes system get a scalar so it forks off a shell.
183 system(join(" ",@_)) == 0
184 || error("command returned error code");
188 # Run a command that may have a huge number of arguments, like xargs does.
189 # Pass in a reference to an array containing the arguments, and then other
190 # parameters that are the command and any parameters that should be passed to
195 # The kernel can accept command lines up to 20k worth of characters.
196 my $command_max=20000; # LINUX SPECIFIC!!
197 # I could use POSIX::ARG_MAX, but that would be slow.
199 # Figure out length of static portion of command.
202 $static_length+=length($_)+1;
206 my $length=$static_length;
208 if (length($_) + 1 + $static_length > $command_max) {
209 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? \"@_ $_\"");
211 $length+=length($_) + 1;
212 if ($length < $command_max) {
216 doit(@_,@collect) if $#collect > -1;
218 $length=$static_length + length($_) + 1;
221 doit(@_,@collect) if $#collect > -1;
224 # Print something if the verbose flag is on.
229 print "\t$message\n";
233 # Output an error message and exit.
245 print STDERR basename($0).": $message\n";
248 # Returns the basename of the argument passed to it.
252 $fn=~s/\/$//g; # ignore trailing slashes
253 $fn=~s:^.*/(.*?)$:$1:;
257 # Returns the directory name of the argument passed to it.
261 $fn=~s/\/$//g; # ignore trailing slashes
262 $fn=~s:^(.*)/.*?$:$1:;
266 # Pass in a number, will return true iff the current compatibility level
267 # is less than or equal to that number.
277 if (defined $ENV{DH_COMPAT}) {
280 elsif (-e 'debian/compat') {
282 open (COMPAT_IN, "debian/compat") || error "debian/compat: $!";
284 if (! defined $l || ! length $l) {
285 warning("debian/compat is empty, assuming level $c");
294 if ($c < 4 && ! $warned_compat) {
295 warning("Compatibility levels before 4 are deprecated.");
299 if ($c > $max_compat) {
300 error("Sorry, but $max_compat is the highest compatibility level supported by this debhelper.");
307 # Pass it a name of a binary package, it returns the name of the tmp dir to
308 # use, for that package.
315 elsif (compat(1) && $package eq $dh{MAINPACKAGE}) {
316 # This is for back-compatibility with the debian/tmp tradition.
320 return "debian/$package";
324 # Pass this the name of a binary package, and the name of the file wanted
325 # for the package, and it will return the actual existing filename to use.
327 # It tries several filenames:
328 # * debian/package.filename.buildarch
329 # * debian/package.filename
330 # * debian/file (if the package is the main package)
331 # If --name was specified then tonly the first two are tried, and they must
332 # have the name after the pacage name:
333 # * debian/package.name.filename.buildarch
334 # * debian/package.name.filename
339 if (defined $dh{NAME}) {
340 $filename="$dh{NAME}.$filename";
343 my @try=("debian/$package.$filename.".buildarch(),
344 "debian/$package.$filename");
345 if ($package eq $dh{MAINPACKAGE}) {
346 push @try, "debian/$filename";
349 foreach my $file (@try) {
351 (! $dh{IGNORE} || ! exists $dh{IGNORE}->{$file})) {
361 # Pass it a name of a binary package, it returns the name to prefix to files
362 # in debian/ for this package.
366 if (compat(1) and $package eq $dh{MAINPACKAGE}) {
372 # Pass it the name of a binary package, it returns the name to install
373 # files by in eg, etc. Normally this is the same, but --name can override
378 if (defined $dh{NAME}) {
384 # Returns 1 if the package is a native debian package, null otherwise.
385 # As a side effect, sets $dh{VERSION} to the version of this package.
387 # Caches return code so it only needs to run dpkg-parsechangelog once.
393 return $isnative_cache{$package} if defined $isnative_cache{$package};
395 # Make sure we look at the correct changelog.
396 my $isnative_changelog=pkgfile($package,"changelog");
397 if (! $isnative_changelog) {
398 $isnative_changelog="debian/changelog";
400 # Get the package version.
401 my $version=`dpkg-parsechangelog -l$isnative_changelog`;
402 ($dh{VERSION})=$version=~m/Version:\s*(.*)/m;
403 # Did the changelog parse fail?
404 if (! defined $dh{VERSION}) {
405 error("changelog parse failure");
408 # Is this a native Debian package?
409 if ($dh{VERSION}=~m/.*-/) {
410 return $isnative_cache{$package}=0;
413 return $isnative_cache{$package}=1;
418 # Automatically add a shell script snippet to a debian script.
419 # Only works if the script has #DEBHELPER# in it.
423 # 2: script to add to
424 # 3: filename of snippet
425 # 4: sed to run on the snippet. Ie, s/#PACKAGE#/$PACKAGE/
432 # This is the file we will modify.
433 my $outfile="debian/".pkgext($package)."$script.debhelper";
435 # Figure out what shell script snippet to use.
437 if (defined($ENV{DH_AUTOSCRIPTDIR}) &&
438 -e "$ENV{DH_AUTOSCRIPTDIR}/$filename") {
439 $infile="$ENV{DH_AUTOSCRIPTDIR}/$filename";
442 if (-e "/usr/share/debhelper/autoscripts/$filename") {
443 $infile="/usr/share/debhelper/autoscripts/$filename";
446 error("/usr/share/debhelper/autoscripts/$filename does not exist");
450 if (-e $outfile && ($script eq 'postrm' || $script eq 'prerm')
452 # Add fragments to top so they run in reverse order when removing.
453 complex_doit("echo \"# Automatically added by ".basename($0)."\"> $outfile.new");
454 complex_doit("sed \"$sed\" $infile >> $outfile.new");
455 complex_doit("echo '# End automatically added section' >> $outfile.new");
456 complex_doit("cat $outfile >> $outfile.new");
457 complex_doit("mv $outfile.new $outfile");
460 complex_doit("echo \"# Automatically added by ".basename($0)."\">> $outfile");
461 complex_doit("sed \"$sed\" $infile >> $outfile");
462 complex_doit("echo '# End automatically added section' >> $outfile");
466 # Removes a whole substvar line.
471 my $ext=pkgext($package);
472 my $substvarfile="debian/${ext}substvars";
474 if (-e $substvarfile) {
475 complex_doit("grep -s -v '^${substvar}=' $substvarfile > $substvarfile.new || true");
476 doit("mv", "$substvarfile.new","$substvarfile");
480 # Adds a dependency on some package to the specified
481 # substvar in a package's substvar's file.
485 my $deppackage=shift;
489 my $ext=pkgext($package);
490 my $substvarfile="debian/${ext}substvars";
492 $str.=" ($verinfo)" if defined $verinfo && length $verinfo;
494 # Figure out what the line will look like, based on what's there
495 # now, and what we're to add or remove.
497 if (-e $substvarfile) {
499 open(SUBSTVARS_IN, "$substvarfile") || error "read $substvarfile: $!";
500 while (<SUBSTVARS_IN>) {
502 if (/^\Q$substvar\E=(.*)/) {
503 %items = map { $_ => 1} split(", ", $1);
515 $line=join(", ", sort keys %items);
522 complex_doit("(grep -s -v ${substvar} $substvarfile; echo ".escape_shell("${substvar}=$line").") > $substvarfile.new");
523 doit("mv", "$substvarfile.new", $substvarfile);
526 delsubstvar($package,$substvar);
530 # Reads in the specified file, one line at a time. splits on words,
531 # and returns an array of arrays of the contents.
532 # If a value is passed in as the second parameter, then glob
533 # expansion is done in the directory specified by the parameter ("." is
534 # frequently a good choice).
535 sub filedoublearray {
540 open (DH_FARRAY_IN, $file) || error("cannot read $file: $1");
541 while (<DH_FARRAY_IN>) {
543 # Only ignore comments and empty lines in v5 mode.
545 next if /^#/ || /^$/;
548 # Only do glob expansion in v3 mode.
550 # The tricky bit is that the glob expansion is done
551 # as if we were in the specified directory, so the
552 # filenames that come out are relative to it.
553 if (defined $globdir && ! compat(2)) {
554 for (map { glob "$globdir/$_" } split) {
569 # Reads in the specified file, one word at a time, and returns an array of
570 # the result. Can do globbing as does filedoublearray.
572 return map { @$_ } filedoublearray(@_);
575 # Passed a filename, returns true if -X says that file should be excluded.
577 my $filename = shift;
578 foreach my $f (@{$dh{EXCLUDE}}) {
579 return 1 if $filename =~ /\Q$f\E/;
584 # Returns the build architecture. (Memoized)
589 return $arch if defined $arch;
591 $arch=`dpkg-architecture -qDEB_HOST_ARCH 2>/dev/null` || error("dpkg-architecture failed");
597 # Passed an arch and a list of arches to match against, returns true if matched
600 my @archlist=split(/\s+/,shift);
602 foreach my $a (@archlist) {
603 system("dpkg-architecture", "-a$arch", "-i$a") == 0 && return 1;
609 # Returns a list of packages in the control file.
610 # Must pass "arch" or "indep" or "same" to specify arch-dependant or
611 # -independant or same arch packages. If nothing is specified, returns all
613 # As a side effect, populates %package_arches and %package_types with the
614 # types of all packages (not only those returned).
615 my (%package_types, %package_arches);
622 $type="" if ! defined $type;
624 # Look up the build arch if we need to.
626 if ($type eq 'same') {
627 $buildarch=buildarch();
635 open (CONTROL, 'debian/control') ||
636 error("cannot read debian/control: $!\n");
640 if (/^Package:\s*(.*)/) {
642 # Detect duplicate package names in the same control file.
643 if (! $seen{$package}) {
647 error("debian/control has a duplicate entry for $package");
651 if (/^Architecture:\s*(.*)/) {
654 if (/^(?:X[BC]*-)?Package-Type:\s*(.*)/) {
658 if (!$_ or eof) { # end of stanza.
660 $package_types{$package}=$package_type;
661 $package_arches{$package}=$arch;
664 (($type eq 'indep' && $arch eq 'all') ||
665 ($type eq 'arch' && $arch ne 'all') ||
666 ($type eq 'same' && ($arch eq 'any' || samearch($buildarch, $arch))) ||
668 push @list, $package;
679 # Returns the arch a package will build for.
683 if (! exists $package_arches{$package}) {
684 warning "package $package is not in control info";
687 return $package_arches{$package} eq 'all' ? "all" : buildarch();
690 # Return true if a given package is really a udeb.
694 if (! exists $package_types{$package}) {
695 warning "package $package is not in control info";
698 return $package_types{$package} eq 'udeb';
701 # Generates the filename that is used for a udeb package.
705 my $filearch=package_arch($package);
706 isnative($package); # side effect
707 my $version=$dh{VERSION};
708 $version=~s/^[0-9]+://; # strip any epoch
709 return "${package}_${version}_$filearch.udeb";
712 # Handles #DEBHELPER# substitution in a script; also can generate a new
713 # script from scratch if none exists but there is a .debhelper file for it.
714 sub debhelper_script_subst {
718 my $tmp=tmpdir($package);
719 my $ext=pkgext($package);
720 my $file=pkgfile($package,$script);
723 if (-f "debian/$ext$script.debhelper") {
724 # Add this into the script, where it has #DEBHELPER#
725 complex_doit("perl -pe 's~#DEBHELPER#~qx{cat debian/$ext$script.debhelper}~eg' < $file > $tmp/DEBIAN/$script");
728 # Just get rid of any #DEBHELPER# in the script.
729 complex_doit("sed s/#DEBHELPER#// < $file > $tmp/DEBIAN/$script");
731 doit("chown","0:0","$tmp/DEBIAN/$script");
732 doit("chmod",755,"$tmp/DEBIAN/$script");
734 elsif ( -f "debian/$ext$script.debhelper" ) {
735 complex_doit("printf '#!/bin/sh\nset -e\n' > $tmp/DEBIAN/$script");
736 complex_doit("cat debian/$ext$script.debhelper >> $tmp/DEBIAN/$script");
737 doit("chown","0:0","$tmp/DEBIAN/$script");
738 doit("chmod",755,"$tmp/DEBIAN/$script");