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 # Pass it an array containing the arguments of a shell command like would
112 # be run by exec(). It turns that into a line like you might enter at the
113 # shell, escaping metacharacters and quoting arguments that contain spaces.
118 foreach my $word (@args) {
120 # Escape only a few things since it will be quoted.
121 # Note we use double quotes because you cannot
122 # escape ' in single quotes, while " can be escaped
124 # This does make -V"foo bar" turn into "-Vfoo bar",
125 # but that will be parsed identically by the shell
127 $word=~s/([\n`\$"\\])/\\$1/g;
128 push @ret, "\"$word\"";
131 # This list is from _Unix in a Nutshell_. (except '#')
132 $word=~s/([\s!"\$()*+#;<>?@\[\]\\`|~])/\\$1/g;
136 return join(' ', @ret);
139 # Run a command, and display the command to stdout if verbose mode is on.
140 # All commands that modifiy files in $TMP should be ran via this
143 # Note that this cannot handle complex commands, especially anything
144 # involving redirection. Use complex_doit instead.
146 verbose_print(escape_shell(@_));
150 $ret == 0 || error("command returned error code $ret");
154 # Run a command and display the command to stdout if verbose mode is on.
155 # Use doit() if you can, instead of this function, because this function
156 # forks a shell. However, this function can handle more complicated stuff
159 verbose_print(join(" ",@_));
162 # The join makes system get a scalar so it forks off a shell.
163 system(join(" ",@_)) == 0
164 || error("command returned error code");
168 # Run a command that may have a huge number of arguments, like xargs does.
169 # Pass in a reference to an array containing the arguments, and then other
170 # parameters that are the command and any parameters that should be passed to
175 # The kernel can accept command lines up to 20k worth of characters.
176 my $command_max=20000; # LINUX SPECIFIC!!
177 # I could use POSIX::ARG_MAX, but that would be slow.
179 # Figure out length of static portion of command.
182 $static_length+=length($_)+1;
186 my $length=$static_length;
188 if (length($_) + 1 + $static_length > $command_max) {
189 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? \"@_ $_\"");
191 $length+=length($_) + 1;
192 if ($length < $command_max) {
196 doit(@_,@collect) if $#collect > -1;
198 $length=$static_length + length($_) + 1;
201 doit(@_,@collect) if $#collect > -1;
204 # Print something if the verbose flag is on.
209 print "\t$message\n";
213 # Output an error message and exit.
225 print STDERR basename($0).": $message\n";
228 # Returns the basename of the argument passed to it.
232 $fn=~s/\/$//g; # ignore trailing slashes
233 $fn=~s:^.*/(.*?)$:$1:;
237 # Returns the directory name of the argument passed to it.
241 $fn=~s/\/$//g; # ignore trailing slashes
242 $fn=~s:^(.*)/.*?$:$1:;
246 # Pass in a number, will return true iff the current compatibility level
247 # is less than or equal to that number.
257 if (defined $ENV{DH_COMPAT}) {
260 elsif (-e 'debian/compat') {
262 open (COMPAT_IN, "debian/compat") || error "debian/compat: $!";
264 if (! defined $l || ! length $l) {
265 warning("debian/compat is empty, assuming level $c");
274 if ($c < 4 && ! $warned_compat) {
275 warning("Compatibility levels before 4 are deprecated.");
279 if ($c > $max_compat) {
280 error("Sorry, but $max_compat is the highest compatibility level supported by this debhelper.");
287 # Pass it a name of a binary package, it returns the name of the tmp dir to
288 # use, for that package.
295 elsif (compat(1) && $package eq $dh{MAINPACKAGE}) {
296 # This is for back-compatibility with the debian/tmp tradition.
300 return "debian/$package";
304 # Pass this the name of a binary package, and the name of the file wanted
305 # for the package, and it will return the actual existing filename to use.
307 # It tries several filenames:
308 # * debian/package.filename.buildarch
309 # * debian/package.filename
310 # * debian/file (if the package is the main package)
311 # If --name was specified then tonly the first two are tried, and they must
312 # have the name after the pacage name:
313 # * debian/package.name.filename.buildarch
314 # * debian/package.name.filename
319 if (defined $dh{NAME}) {
320 $filename="$dh{NAME}.$filename";
323 if (-f "debian/$package.$filename.".buildarch()) {
324 return "debian/$package.$filename.".buildarch();
326 elsif (-f "debian/$package.$filename") {
327 return "debian/$package.$filename";
329 elsif ($package eq $dh{MAINPACKAGE} && -f "debian/$filename") {
330 return "debian/$filename";
337 # Pass it a name of a binary package, it returns the name to prefix to files
338 # in debian/ for this package.
342 if (compat(1) and $package eq $dh{MAINPACKAGE}) {
348 # Pass it the name of a binary package, it returns the name to install
349 # files by in eg, etc. Normally this is the same, but --name can override
354 if (defined $dh{NAME}) {
360 # Returns 1 if the package is a native debian package, null otherwise.
361 # As a side effect, sets $dh{VERSION} to the version of this package.
363 # Caches return code so it only needs to run dpkg-parsechangelog once.
369 return $isnative_cache{$package} if defined $isnative_cache{$package};
371 # Make sure we look at the correct changelog.
372 my $isnative_changelog=pkgfile($package,"changelog");
373 if (! $isnative_changelog) {
374 $isnative_changelog="debian/changelog";
376 # Get the package version.
377 my $version=`dpkg-parsechangelog -l$isnative_changelog`;
378 ($dh{VERSION})=$version=~m/Version:\s*(.*)/m;
379 # Did the changelog parse fail?
380 if (! defined $dh{VERSION}) {
381 error("changelog parse failure");
384 # Is this a native Debian package?
385 if ($dh{VERSION}=~m/.*-/) {
386 return $isnative_cache{$package}=0;
389 return $isnative_cache{$package}=1;
394 # Automatically add a shell script snippet to a debian script.
395 # Only works if the script has #DEBHELPER# in it.
399 # 2: script to add to
400 # 3: filename of snippet
401 # 4: sed to run on the snippet. Ie, s/#PACKAGE#/$PACKAGE/
408 # This is the file we will modify.
409 my $outfile="debian/".pkgext($package)."$script.debhelper";
411 # Figure out what shell script snippet to use.
413 if (defined($ENV{DH_AUTOSCRIPTDIR}) &&
414 -e "$ENV{DH_AUTOSCRIPTDIR}/$filename") {
415 $infile="$ENV{DH_AUTOSCRIPTDIR}/$filename";
418 if (-e "/usr/share/debhelper/autoscripts/$filename") {
419 $infile="/usr/share/debhelper/autoscripts/$filename";
422 error("/usr/share/debhelper/autoscripts/$filename does not exist");
426 if (-e $outfile && ($script eq 'postrm' || $script eq 'prerm')) {
427 # Add fragments to top so they run in reverse order when removing.
428 complex_doit("echo \"# Automatically added by ".basename($0)."\"> $outfile.new");
429 complex_doit("sed \"$sed\" $infile >> $outfile.new");
430 complex_doit("echo '# End automatically added section' >> $outfile.new");
431 complex_doit("cat $outfile >> $outfile.new");
432 complex_doit("mv $outfile.new $outfile");
435 complex_doit("echo \"# Automatically added by ".basename($0)."\">> $outfile");
436 complex_doit("sed \"$sed\" $infile >> $outfile");
437 complex_doit("echo '# End automatically added section' >> $outfile");
441 # Removes a whole substvar line.
446 my $ext=pkgext($package);
447 my $substvarfile="debian/${ext}substvars";
449 if (-e $substvarfile) {
450 complex_doit("grep -s -v '^${substvar}=' $substvarfile > $substvarfile.new || true");
451 doit("mv", "$substvarfile.new","$substvarfile");
455 # Adds a dependency on some package to the specified
456 # substvar in a package's substvar's file.
460 my $deppackage=shift;
464 my $ext=pkgext($package);
465 my $substvarfile="debian/${ext}substvars";
467 $str.=" ($verinfo)" if defined $verinfo && length $verinfo;
469 # Figure out what the line will look like, based on what's there
470 # now, and what we're to add or remove.
472 if (-e $substvarfile) {
474 open(SUBSTVARS_IN, "$substvarfile") || error "read $substvarfile: $!";
475 while (<SUBSTVARS_IN>) {
477 if (/^\Q$substvar\E=(.*)/) {
478 %items = map { $_ => 1} split(", ", $1);
490 $line=join(", ", keys %items);
497 complex_doit("(grep -s -v ${substvar} $substvarfile; echo ".escape_shell("${substvar}=$line").") > $substvarfile.new");
498 doit("mv", "$substvarfile.new", $substvarfile);
501 delsubstvar($package,$substvar);
505 # Reads in the specified file, one line at a time. splits on words,
506 # and returns an array of arrays of the contents.
507 # If a value is passed in as the second parameter, then glob
508 # expansion is done in the directory specified by the parameter ("." is
509 # frequently a good choice).
510 sub filedoublearray {
515 open (DH_FARRAY_IN, $file) || error("cannot read $file: $1");
516 while (<DH_FARRAY_IN>) {
518 # Only ignore comments and empty lines in v5 mode.
520 next if /^#/ || /^$/;
523 # Only do glob expansion in v3 mode.
525 # The tricky bit is that the glob expansion is done
526 # as if we were in the specified directory, so the
527 # filenames that come out are relative to it.
528 if (defined $globdir && ! compat(2)) {
529 for (map { glob "$globdir/$_" } split) {
544 # Reads in the specified file, one word at a time, and returns an array of
545 # the result. Can do globbing as does filedoublearray.
547 return map { @$_ } filedoublearray(@_);
550 # Passed a filename, returns true if -X says that file should be excluded.
552 my $filename = shift;
553 foreach my $f (@{$dh{EXCLUDE}}) {
554 return 1 if $filename =~ /\Q$f\E/;
559 # Returns the build architecture. (Memoized)
564 return $arch if defined $arch;
566 $arch=`dpkg-architecture -qDEB_HOST_ARCH 2>/dev/null` || error("dpkg-architecture failed");
572 # Passed an arch and a list of arches to match against, returns true if matched
575 my @archlist=split(/\s+/,shift);
577 foreach my $a (@archlist) {
578 system("dpkg-architecture", "-a$arch", "-i$a") == 0 && return 1;
584 # Returns a list of packages in the control file.
585 # Must pass "arch" or "indep" or "same" to specify arch-dependant or
586 # -independant or same arch packages. If nothing is specified, returns all
588 # As a side effect, populates %package_arches and %package_types with the
589 # types of all packages (not only those returned).
590 my (%package_types, %package_arches);
597 $type="" if ! defined $type;
599 # Look up the build arch if we need to.
601 if ($type eq 'same') {
602 $buildarch=buildarch();
610 open (CONTROL, 'debian/control') ||
611 error("cannot read debian/control: $!\n");
615 if (/^Package:\s*(.*)/) {
617 # Detect duplicate package names in the same control file.
618 if (! $seen{$package}) {
622 error("debian/control has a duplicate entry for $package");
626 if (/^Architecture:\s*(.*)/) {
629 if (/^(?:X[BC]*-)?Package-Type:\s*(.*)/) {
633 if (!$_ or eof) { # end of stanza.
635 $package_types{$package}=$package_type;
636 $package_arches{$package}=$arch;
639 (($type eq 'indep' && $arch eq 'all') ||
640 ($type eq 'arch' && $arch ne 'all') ||
641 ($type eq 'same' && ($arch eq 'any' || samearch($buildarch, $arch))) ||
643 push @list, $package;
654 # Returns the arch a package will build for.
658 return $package_arches{$package} eq 'all' ? "all" : buildarch();
661 # Return true if a given package is really a udeb.
665 return $package_types{$package} eq 'udeb';
668 # Generates the filename that is used for a udeb package.
672 my $filearch=package_arch($package);
673 isnative($package); # side effect
674 my $version=$dh{VERSION};
675 $version=~s/^[0-9]+://; # strip any epoch
676 return "${package}_${version}_$filearch.udeb";
679 # Handles #DEBHELPER# substitution in a script; also can generate a new
680 # script from scratch if none exists but there is a .debhelper file for it.
681 sub debhelper_script_subst {
685 my $tmp=tmpdir($package);
686 my $ext=pkgext($package);
687 my $file=pkgfile($package,$script);
690 if (-f "debian/$ext$script.debhelper") {
691 # Add this into the script, where it has #DEBHELPER#
692 complex_doit("perl -pe 's~#DEBHELPER#~qx{cat debian/$ext$script.debhelper}~eg' < $file > $tmp/DEBIAN/$script");
695 # Just get rid of any #DEBHELPER# in the script.
696 complex_doit("sed s/#DEBHELPER#// < $file > $tmp/DEBIAN/$script");
698 doit("chown","0:0","$tmp/DEBIAN/$script");
699 doit("chmod",755,"$tmp/DEBIAN/$script");
701 elsif ( -f "debian/$ext$script.debhelper" ) {
702 complex_doit("printf '#!/bin/sh\nset -e\n' > $tmp/DEBIAN/$script");
703 complex_doit("cat debian/$ext$script.debhelper >> $tmp/DEBIAN/$script");
704 doit("chown","0:0","$tmp/DEBIAN/$script");
705 doit("chmod",755,"$tmp/DEBIAN/$script");