1 # This module is part of debbugs, and is released
2 # under the terms of the GPL version 2, or any later
3 # version at your option.
4 # See the file README and COPYING for more information.
6 # [Other people have contributed to this file; their copyrights should
8 # Copyright 2007 by Don Armstrong <don@donarmstrong.com>.
10 package Debbugs::Packages;
15 use Exporter qw(import);
16 use vars qw($VERSION @EXPORT_OK %EXPORT_TAGS @EXPORT);
20 use Debbugs::Config qw(:config :globals);
26 %EXPORT_TAGS = (versions => [qw(getversions get_versions make_source_versions)],
27 mapping => [qw(getpkgsrc getpkgcomponent getsrcpkgs),
28 qw(binary_to_source sourcetobinary makesourceversions)
32 Exporter::export_ok_tags(qw(versions mapping));
33 $EXPORT_TAGS{all} = [@EXPORT_OK];
36 use Fcntl qw(O_RDONLY);
37 use MLDBM qw(DB_File Storable);
38 use Storable qw(dclone);
39 use Params::Validate qw(validate_with :types);
40 use Debbugs::Common qw(make_list globify_scalar sort_versions);
42 use List::Util qw(min max);
46 $MLDBM::DumpMeth = 'portable';
47 $MLDBM::RemoveTaint = 1;
51 Debbugs::Packages - debbugs binary/source package handling
55 The Debbugs::Packages module provides support functions to map binary
56 packages to their corresponding source packages and vice versa. (This makes
57 sense for software distributions, where developers may work on a single
58 source package which produces several binary packages for use by users; it
59 may not make sense in other contexts.)
65 Returns a reference to a hash of binary package names to their corresponding
74 return $_pkgsrc if $_pkgsrc;
75 return {} unless defined $Debbugs::Packages::gPackageSource;
80 my $fh = IO::File->new($config{package_source},'r')
81 or die("Unable to open $config{package_source} for reading: $!");
83 next unless m/^(\S+)\s+(\S+)\s+(\S.*\S)\s*$/;
84 my ($bin,$cmp,$src)=($1,$2,$3);
87 push @{$srcpkg{$src}}, $bin;
88 $pkgcomponent{$bin}= $cmp;
92 $_pkgcomponent = \%pkgcomponent;
97 =head2 getpkgcomponent
99 Returns a reference to a hash of binary package names to the component of
100 the archive containing those binary packages (e.g. "main", "contrib",
105 sub getpkgcomponent {
106 return $_pkgcomponent if $_pkgcomponent;
108 return $_pkgcomponent;
113 Returns a list of the binary packages produced by a given source package.
119 getpkgsrc() if not defined $_srcpkg;
120 return () if not defined $src or not exists $_srcpkg->{$src};
121 return @{$_srcpkg->{$src}};
124 =head2 binary_to_source
126 binary_to_source(package => 'foo',
131 Turn a binary package (at optional version in optional architecture)
132 into a single (or set) of source packages (optionally) with associated
135 By default, in LIST context, returns a LIST of array refs of source
136 package, source version pairs corresponding to the binary package(s),
137 arch(s), and verion(s) passed.
139 In SCALAR context, only the corresponding source packages are
140 returned, concatenated with ', ' if necessary.
142 If no source can be found, returns undef in scalar context, or the
143 empty list in list context.
147 =item binary -- binary package name(s) as a SCALAR or ARRAYREF
149 =item version -- binary package version(s) as a SCALAR or ARRAYREF;
150 optional, defaults to all versions.
152 =item arch -- binary package architecture(s) as a SCALAR or ARRAYREF;
153 optional, defaults to all architectures.
155 =item source_only -- return only the source name (forced on if in
156 SCALAR context), defaults to false.
158 =item scalar_only -- return a scalar only (forced true if in SCALAR
159 context, also causes source_only to be true), defaults to false.
161 =item cache -- optional HASHREF to be used to cache results of
168 # the two global variables below are used to tie the source maps; we
169 # probably should be retying them in long lived processes.
170 our %_binarytosource;
171 our %_sourcetobinary;
172 sub binary_to_source{
173 my %param = validate_with(params => \@_,
174 spec => {binary => {type => SCALAR|ARRAYREF,
176 version => {type => SCALAR|ARRAYREF,
179 arch => {type => SCALAR|ARRAYREF,
182 source_only => {default => 0,
184 scalar_only => {default => 0,
186 cache => {type => HASHREF,
192 # TODO: This gets hit a lot, especially from buggyversion() - probably
193 # need an extra cache for speed here.
194 return () unless defined $gBinarySourceMap;
196 if ($param{scalar_only} or not wantarray) {
197 $param{source_only} = 1;
198 $param{scalar_only} = 1;
202 my @binaries = grep {defined $_} make_list(exists $param{binary}?$param{binary}:[]);
203 my @versions = grep {defined $_} make_list(exists $param{version}?$param{version}:[]);
204 my @archs = grep {defined $_} make_list(exists $param{arch}?$param{arch}:[]);
205 return () unless @binaries;
206 my $cache_key = join("\1",
207 join("\0",@binaries),
208 join("\0",@versions),
210 join("\0",@param{qw(source_only scalar_only)}));
211 if (exists $param{cache}{$cache_key}) {
212 return $param{scalar_only} ? $param{cache}{$cache_key}[0]:
213 @{$param{cache}{$cache_key}};
215 for my $binary (@binaries) {
216 if ($binary =~ m/^src:(.+)$/) {
217 push @source,[$1,''];
220 if (not tied %_binarytosource) {
221 tie %_binarytosource, MLDBM => $config{binary_source_map}, O_RDONLY or
222 die "Unable to open $config{binary_source_map} for reading";
224 # avoid autovivification
225 my $bin = $_binarytosource{$binary};
226 next unless defined $bin;
228 for my $ver (keys %{$bin}) {
229 for my $ar (keys %{$bin->{$ver}}) {
230 my $src = $bin->{$ver}{$ar};
231 next unless defined $src;
232 push @source,[$src->[0],$src->[1]];
237 for my $version (@versions) {
238 next unless exists $bin->{$version};
239 if (exists $bin->{$version}{all}) {
240 push @source,dclone($bin->{$version}{all});
248 @t_archs = keys %{$bin->{$version}};
250 for my $arch (@t_archs) {
251 push @source,dclone($bin->{$version}{$arch}) if
252 exists $bin->{$version}{$arch};
258 if (not @source and not @versions and not @archs) {
259 # ok, we haven't found any results at all. If we weren't given
260 # a specific version and architecture, then we should try
261 # really hard to figure out the right source
263 # if any the packages we've been given are a valid source
264 # package name, and there's no binary of the same name (we got
265 # here, so there isn't), return it.
267 if (not tied %_sourcetobinary) {
268 tie %_sourcetobinary, MLDBM => $config{source_binary_map}, O_RDONLY or
269 die "Unable top open $gSourceBinaryMap for reading";
271 for my $maybe_sourcepkg (@binaries) {
272 if (exists $_sourcetobinary{$maybe_sourcepkg}) {
273 push @source,[$maybe_sourcepkg,$_] for keys %{$_sourcetobinary{$maybe_sourcepkg}};
276 # if @source is still empty here, it's probably a non-existant
277 # source package, so don't return anything.
282 if ($param{source_only}) {
284 for my $s (@source) {
285 # we shouldn't need to do this, but do this temporarily to
287 next unless defined $s->[0];
290 @result = sort keys %uniq;
291 if ($param{scalar_only}) {
292 @result = join(', ',@result);
297 for my $s (@source) {
298 $uniq{$s->[0]}{$s->[1]} = 1;
300 for my $sn (sort keys %uniq) {
301 push @result, [$sn, $_] for sort keys %{$uniq{$sn}};
305 # No $gBinarySourceMap, or it didn't have an entry for this name and
307 $param{cache}{$cache_key} = \@result;
308 return $param{scalar_only} ? $result[0] : @result;
311 =head2 sourcetobinary
313 Returns a list of references to triplets of binary package names, versions,
314 and architectures corresponding to a given source package name and version.
315 If the given source package name and version cannot be found in the database
316 but the source package name is in the unversioned package-to-source map
317 file, then a reference to a binary package name and version pair will be
318 returned, without the architecture.
323 my ($srcname, $srcver) = @_;
325 if (not tied %_sourcetobinary) {
326 tie %_sourcetobinary, MLDBM => $config{source_binary_map}, O_RDONLY or
327 die "Unable top open $config{source_binary_map} for reading";
332 # avoid autovivification
333 my $source = $_sourcetobinary{$srcname};
334 return () unless defined $source;
335 if (exists $source->{$srcver}) {
336 my $bin = $source->{$srcver};
337 return () unless defined $bin;
340 # No $gSourceBinaryMap, or it didn't have an entry for this name and
341 # version. Try $gPackageSource (unversioned) instead.
342 my @srcpkgs = getsrcpkgs($srcname);
343 return map [$_, $srcver], @srcpkgs;
348 Returns versions of the package in a distribution at a specific
354 my ($pkg, $dist, $arch) = @_;
355 return get_versions(package=>$pkg,
357 defined $arch ? (arch => $arch):(),
365 get_versions(package=>'foopkg',
370 Returns a list of the versions of package in the distributions and
371 architectures listed. This routine only returns unique values.
375 =item package -- package to return list of versions
377 =item dist -- distribution (unstable, stable, testing); can be an
380 =item arch -- architecture (i386, source, ...); can be an arrayref
382 =item time -- returns a version=>time hash at which the newest package
383 matching this version was uploaded
385 =item source -- returns source/version instead of just versions
387 =item no_source_arch -- discards the source architecture when arch is
388 not passed. [Used for finding the versions of binary packages only.]
389 Defaults to 0, which does not discard the source architecture. (This
390 may change in the future, so if you care, please code accordingly.)
392 =item return_archs -- returns a version=>[archs] hash indicating which
393 architectures are at which versions.
395 =item largest_source_version_only -- if there is more than one source
396 version in a particular distribution, discards all versions but the
397 largest in that distribution. Defaults to 1, as this used to be the
398 way that the Debian archive worked.
402 When called in scalar context, this function will return hashrefs or
403 arrayrefs as appropriate, in list context, it will return paired lists
404 or unpaired lists as appropriate.
412 my %param = validate_with(params => \@_,
413 spec => {package => {type => SCALAR|ARRAYREF,
415 dist => {type => SCALAR|ARRAYREF,
416 default => 'unstable',
418 arch => {type => SCALAR|ARRAYREF,
421 time => {type => BOOLEAN,
424 source => {type => BOOLEAN,
427 no_source_arch => {type => BOOLEAN,
430 return_archs => {type => BOOLEAN,
433 largest_source_version_only => {type => BOOLEAN,
440 return () if not defined $gVersionTimeIndex;
441 unless (tied %_versions_time) {
442 tie %_versions_time, 'MLDBM', $gVersionTimeIndex, O_RDONLY
443 or die "can't open versions index $gVersionTimeIndex: $!";
445 $versions = \%_versions_time;
448 return () if not defined $gVersionIndex;
449 unless (tied %_versions) {
450 tie %_versions, 'MLDBM', $gVersionIndex, O_RDONLY
451 or die "can't open versions index $gVersionIndex: $!";
453 $versions = \%_versions;
456 for my $package (make_list($param{package})) {
458 if ($package =~ s/^src://) {
461 my $version = $versions->{$package};
462 next unless defined $version;
463 for my $dist (make_list($param{dist})) {
464 for my $arch (exists $param{arch}?
465 make_list($param{arch}):
466 (grep {not $param{no_source_arch} or
468 } $source_only?'source':keys %{$version->{$dist}})) {
469 next unless defined $version->{$dist}{$arch};
470 my @vers = ref $version->{$dist}{$arch} eq 'HASH' ?
471 keys %{$version->{$dist}{$arch}} :
472 make_list($version->{$dist}{$arch});
473 if ($param{largest_source_version_only} and
474 $arch eq 'source' and @vers > 1) {
475 # order the versions, then pick the biggest version number
476 @vers = sort_versions(@vers);
479 for my $ver (@vers) {
481 if ($param{source}) {
482 ($f_ver) = make_source_versions(package => $package,
485 next unless defined $f_ver;
488 $versions{$f_ver} = max($versions{$f_ver}||0,$version->{$dist}{$arch}{$ver});
491 push @{$versions{$f_ver}},$arch;
497 if ($param{time} or $param{return_archs}) {
498 return wantarray?%versions :\%versions;
500 return wantarray?keys %versions :[keys %versions];
504 =head2 makesourceversions
506 @{$cgi_var{found}} = makesourceversions($cgi_var{package},undef,@{$cgi_var{found}});
508 Canonicalize versions into source versions, which have an explicitly
509 named source package. This is used to cope with source packages whose
510 names have changed during their history, and with cases where source
511 version numbers differ from binary version numbers.
515 our %_sourceversioncache = ();
516 sub makesourceversions {
517 my ($package,$arch,@versions) = @_;
518 die "Package $package is multiple packages; split on , and call makesourceversions multiple times"
520 return make_source_versions(package => $package,
521 (defined $arch)?(arch => $arch):(),
522 versions => \@versions
526 =head2 make_source_versions
528 make_source_versions(package => 'foo',
532 warnings => \$warnings,
535 An extended version of makesourceversions (which calls this function
536 internally) that allows for multiple packages, architectures, and
537 outputs warnings and debugging information to provided SCALARREFs or
540 The guess_source option determines whether the source package is
541 guessed at if there is no obviously correct package. Things that use
542 this function for non-transient output should set this to false,
543 things that use it for transient output can set this to true.
544 Currently it defaults to true, but that is not a sane option.
549 sub make_source_versions {
550 my %param = validate_with(params => \@_,
551 spec => {package => {type => SCALAR|ARRAYREF,
553 arch => {type => SCALAR|ARRAYREF|UNDEF,
556 versions => {type => SCALAR|ARRAYREF,
559 guess_source => {type => BOOLEAN,
562 source_version_cache => {type => HASHREF,
565 debug => {type => SCALARREF|HANDLE,
568 warnings => {type => SCALARREF|HANDLE,
573 my ($warnings) = globify_scalar(exists $param{warnings}?$param{warnings}:undef);
575 my @packages = grep {defined $_ and length $_ } make_list($param{package});
576 my @archs = grep {defined $_ } make_list ($param{arch});
580 if (not exists $param{source_version_cache}) {
581 $param{source_version_cache} = \%_sourceversioncache;
583 if (grep {/,/} make_list($param{package})) {
584 croak "Package names contain ,; split on /,/ and call make_source_versions with an arrayref of packages"
587 for my $version (make_list($param{versions})) {
588 if ($version =~ m{(.+)/([^/]+)$}) {
589 # Already a source version.
590 $sourceversions{$version} = 1;
591 next unless exists $param{warnings};
592 # check to see if this source version is even possible
593 my @bin_versions = sourcetobinary($1,$2);
594 if (not @bin_versions or
595 @{$bin_versions[0]} != 3) {
596 print {$warnings} "The source $1 and version $2 do not appear to match any binary packages\n";
600 croak "You must provide at least one package if the versions are not fully qualified";
602 for my $pkg (@packages) {
603 if ($pkg =~ /^src:(.+)/) {
604 $sourceversions{"$1/$version"} = 1;
605 next unless exists $param{warnings};
606 # check to see if this source version is even possible
607 my @bin_versions = sourcetobinary($1,$version);
608 if (not @bin_versions or
609 @{$bin_versions[0]} != 3) {
610 print {$warnings} "The source '$1' and version '$version' do not appear to match any binary packages\n";
614 for my $arch (@archs) {
615 my $cachearch = (defined $arch) ? $arch : '';
616 my $cachekey = "$pkg/$cachearch/$version";
617 if (exists($param{source_version_cache}{$cachekey})) {
618 for my $v (@{$param{source_version_cache}{$cachekey}}) {
619 $sourceversions{$v} = 1;
623 elsif ($param{guess_source} and
624 exists$param{source_version_cache}{$cachekey.'/guess'}) {
625 for my $v (@{$param{source_version_cache}{$cachekey.'/guess'}}) {
626 $sourceversions{$v} = 1;
630 my @srcinfo = binary_to_source(binary => $pkg,
632 length($arch)?(arch => $arch):());
634 # We don't have explicit information about the
635 # binary-to-source mapping for this version
637 print {$warnings} "There is no source info for the package '$pkg' at version '$version' with architecture '$arch'\n";
638 if ($param{guess_source}) {
640 my $pkgsrc = getpkgsrc();
641 if (exists $pkgsrc->{$pkg}) {
642 @srcinfo = ([$pkgsrc->{$pkg}, $version]);
643 } elsif (getsrcpkgs($pkg)) {
644 # If we're looking at a source package
645 # that doesn't have a binary of the
646 # same name, just try the same
648 @srcinfo = ([$pkg, $version]);
652 # store guesses in a slightly different location
653 $param{source_version_cache}{$cachekey.'/guess'} = [ map { "$_->[0]/$_->[1]" } @srcinfo ];
657 # only store this if we didn't have to guess it
658 $param{source_version_cache}{$cachekey} = [ map { "$_->[0]/$_->[1]" } @srcinfo ];
660 $sourceversions{"$_->[0]/$_->[1]"} = 1 foreach @srcinfo;
665 return sort keys %sourceversions;