3 # Library functions for debhelper programs, perl version.
5 # Joey Hess, GPL copyright 1997, 1998.
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 &isnative &autoscript &filearray &GetPackages
21 # If DH_OPTIONS is set, prepend it @ARGV.
22 if (defined($ENV{DH_OPTIONS})) {
23 unshift @ARGV,split(/\s+/,$ENV{DH_OPTIONS});
26 # Check to see if an argument on the command line starts with a dash.
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.
31 foreach $arg (@ARGV) {
38 eval "use Debian::Debhelper::Dh_Getopt";
40 %dh=Debian::Debhelper::Dh_Getopt::parseopts();
43 # Check to see if DH_VERBOSE environment variable was set, if so,
44 # make sure verbose is on.
45 if (defined $ENV{DH_VERBOSE} && $ENV{DH_VERBOSE} ne "") {
49 # Check to see if DH_NO_ACT environment variable was set, if so,
50 # make sure no act mode is on.
51 if (defined $ENV{DH_NO_ACT} && $ENV{DH_NO_ACT} ne "") {
55 # Get the name of the main binary package (first one listed in
57 my @allpackages=GetPackages();
58 $dh{MAINPACKAGE}=$allpackages[0];
60 # Check if packages to build have been specified, if not, fall back to
61 # the default, doing them all.
62 if (! defined $dh{DOPACKAGES} || ! @{$dh{DOPACKAGES}}) {
63 if ($dh{DOINDEP} || $dh{DOARCH} || $dh{DOSAME}) {
64 # User specified that all arch (in)dep package be
65 # built, and there are none of that type.
66 error("I have no package to act on");
68 push @{$dh{DOPACKAGES}},@allpackages;
71 # Check to see if -P was specified. If so, we can only act on a single
73 if ($dh{TMPDIR} && $#{$dh{DOPACKAGES}} > 0) {
74 error("-P was specified, but multiple packages would be acted on (".join(",",@{$dh{DOPACKAGES}}).").");
77 # Figure out which package is the first one we were instructed to build.
78 # This package gets special treatement: files and directories specified on
79 # the command line may affect it.
80 $dh{FIRSTPACKAGE}=${$dh{DOPACKAGES}}[0];
82 # Split the U_PARAMS up into an array.
86 push @{$dh{U_PARAMS}}, split(/\s+/,$u);
90 # Escapes out shell metacharacters in a word of shell script.
91 sub escape_shell { my $word=shift;
92 # This list is from _Unix in a Nutshell_. (except '#')
93 $word=~s/([\s!"\$()*+#;<>?@\[\]\\`|~])/\\$1/g;
97 # Run a command, and display the command to stdout if verbose mode is on.
98 # All commands that modifiy files in $TMP should be ran via this
101 # Note that this cannot handle complex commands, especially anything
102 # involving redirection. Use complex_doit instead.
104 verbose_print(join(" ",map { escape_shell($_) } @_));
108 || error("command returned error code");
113 # Run a command and display the command to stdout if verbose mode is on.
114 # Use doit() if you can, instead of this function, because this function
115 # forks a shell. However, this function can handle more complicated stuff
118 verbose_print(join(" ",@_));
121 # The join makes system get a scalar so it forks off a shell.
122 system(join(" ",@_)) == 0
123 || error("command returned error code");
127 # Run a command that may have a huge number of arguments, like xargs does.
128 # Pass in a reference to an array containing the arguments, and then other
129 # parameters that are the command and any parameters that should be passed to
134 # The kernel can accept command lines up to 20k worth of characters.
135 my $command_max=20000;
137 # Figure out length of static portion of command.
140 $static_length+=length($_)+1;
144 my $length=$static_length;
146 if (length($_) + 1 + $static_length > $command_max) {
147 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? \"@_ $_\"");
149 $length+=length($_) + 1;
150 if ($length < $command_max) {
154 doit(@_,@collect) if $#collect > -1;
156 $length=$static_length + length($_) + 1;
159 doit(@_,@collect) if $#collect > -1;
162 # Print something if the verbose flag is on.
163 sub verbose_print { my $message=shift;
165 print "\t$message\n";
169 # Output an error message and exit.
170 sub error { my $message=shift;
176 sub warning { my $message=shift;
177 print STDERR basename($0).": $message\n";
180 # Returns the basename of the argument passed to it.
181 sub basename { my $fn=shift;
182 $fn=~s:^.*/(.*?)$:$1:;
186 # Returns the directory name of the argument passed to it.
187 sub dirname { my $fn=shift;
188 $fn=~s:^(.*)/.*?$:$1:;
192 # Pass in a number, will return true iff the current compatability level
193 # is less than or equal to that number.
198 if (defined $ENV{DH_COMPAT}) {
202 if ($c > $max_compat) {
203 error("Sorry, but $max_compat is the highest compatability level of debhelper currently supported.");
209 # Pass it a name of a binary package, it returns the name of the tmp dir to
210 # use, for that package.
211 sub tmpdir { my $package=shift;
215 elsif (compat(1) && $package eq $dh{MAINPACKAGE}) {
216 # This is for back-compatability with the debian/tmp tradition.
220 return "debian/$package";
224 # Pass this the name of a binary package, and the name of the file wanted
225 # for the package, and it will return the actual existing filename to use.
227 # It tries several filenames:
228 # * debian/package.filename.buildarch
229 # * debian/package.filename
230 # * debian/file (if the package is the main package)
235 if (-f "debian/$package.$filename.".buildarch()) {
236 return "debian/$package.$filename.".buildarch();
238 elsif (-f "debian/$package.$filename") {
239 return "debian/$package.$filename";
241 elsif ($package eq $dh{MAINPACKAGE} && -f "debian/$filename") {
242 return "debian/$filename";
249 # Pass it a name of a binary package, it returns the name to prefix to files
250 # in debian for this package.
251 sub pkgext { my $package=shift;
252 if ($package ne $dh{MAINPACKAGE}) {
258 # Returns 1 if the package is a native debian package, null otherwise.
259 # As a side effect, sets $dh{VERSION} to the version of this package.
261 # Caches return code so it only needs to run dpkg-parsechangelog once.
264 sub isnative { my $package=shift;
265 if (! defined $isnative_cache{$package}) {
266 # Make sure we look at the correct changelog.
267 my $isnative_changelog=pkgfile($package,"changelog");
268 if (! $isnative_changelog) {
269 $isnative_changelog="debian/changelog";
272 # Get the package version.
273 my $version=`dpkg-parsechangelog -l$isnative_changelog`;
274 ($dh{VERSION})=$version=~m/Version:\s*(.*)/m;
276 # Did the changelog parse fail?
277 if (! defined $dh{VERSION}) {
278 error("changelog parse failure");
281 # Is this a native Debian package?
282 if ($dh{VERSION}=~m/.*-/) {
283 $isnative_cache{$package}=0;
286 $isnative_cache{$package}=1;
290 return $isnative_cache{$package};
294 # Automatically add a shell script snippet to a debian script.
295 # Only works if the script has #DEBHELPER# in it.
299 # 2: script to add to
300 # 3: filename of snippet
301 # 4: sed to run on the snippet. Ie, s/#PACKAGE#/$PACKAGE/
302 sub autoscript { my $package=shift; my $script=shift; my $filename=shift; my $sed=shift || "";
303 # This is the file we will append to.
304 my $outfile="debian/".pkgext($package)."$script.debhelper";
306 # Figure out what shell script snippet to use.
308 if (defined($ENV{DH_AUTOSCRIPTDIR}) &&
309 -e "$ENV{DH_AUTOSCRIPTDIR}/$filename") {
310 $infile="$ENV{DH_AUTOSCRIPTDIR}/$filename";
313 if (-e "/usr/share/debhelper/autoscripts/$filename") {
314 $infile="/usr/share/debhelper/autoscripts/$filename";
317 error("/usr/share/debhelper/autoscripts/$filename does not exist");
321 # TODO: do this in perl, perhaps?
322 complex_doit("echo \"# Automatically added by ".basename($0)."\">> $outfile");
323 complex_doit("sed \"$sed\" $infile >> $outfile");
324 complex_doit("echo '# End automatically added section' >> $outfile");
327 # Reads in the specified file, one word at a time, and returns an array of
329 sub filearray { my $file=shift;
331 open (DH_FARRAY_IN,"<$file") || error("cannot read $file: $1");
332 while (<DH_FARRAY_IN>) {
333 push @ret,split(' ',$_);
340 # Returns the build architecture. (Memoized)
345 return $arch if defined $arch;
347 $arch=`dpkg --print-architecture` || error($!);
353 # Returns a list of packages in the control file.
354 # Must pass "arch" or "indep" or "same" to specify arch-dependant or
355 # -independant or same arch packages. If nothing is specified, returns all
357 sub GetPackages { my $type=shift;
358 $type="" if ! defined $type;
360 # Look up the build arch if we need to.
362 if ($type eq 'same') {
363 $buildarch=buildarch();
369 open (CONTROL,"<debian/control") ||
370 error("cannot read debian/control: $!\n");
374 if (/^Package:\s*(.*)/) {
377 if (/^Architecture:\s*(.*)/) {
380 if (!$_ or eof) { # end of stanza.
382 (($type eq 'indep' && $arch eq 'all') ||
383 ($type eq 'arch' && $arch ne 'all') ||
384 ($type eq 'same' && ($arch eq 'any' || $arch =~ /\b$buildarch\b/)) ||
386 push @list, $package;