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 base qw(Exporter);
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);
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.
144 =item binary -- binary package name(s) as a SCALAR or ARRAYREF
146 =item version -- binary package version(s) as a SCALAR or ARRAYREF;
147 optional, defaults to all versions.
149 =item arch -- binary package architecture(s) as a SCALAR or ARRAYREF;
150 optional, defaults to all architectures.
152 =item source_only -- return only the source name (forced on if in
153 SCALAR context), defaults to false.
155 =item scalar_only -- return a scalar only (forced true if in SCALAR
156 context, also causes source_only to be true), defaults to false.
158 =item cache -- optional HASHREF to be used to cache results of
165 our %_binarytosource;
166 sub binary_to_source{
167 my %param = validate_with(params => \@_,
168 spec => {binary => {type => SCALAR|ARRAYREF,
170 version => {type => SCALAR|ARRAYREF,
173 arch => {type => SCALAR|ARRAYREF,
176 source_only => {default => 0,
178 scalar_only => {default => 0,
180 cache => {type => HASHREF,
186 # TODO: This gets hit a lot, especially from buggyversion() - probably
187 # need an extra cache for speed here.
188 return () unless defined $gBinarySourceMap;
190 if ($param{scalar_only} or not wantarray) {
191 $param{source_only} = 1;
192 $param{scalar_only} = 1;
196 my @binaries = grep {defined $_} make_list(exists $param{binary}?$param{binary}:[]);
197 my @versions = grep {defined $_} make_list(exists $param{version}?$param{version}:[]);
198 my @archs = grep {defined $_} make_list(exists $param{arch}?$param{arch}:[]);
199 return () unless @binaries;
200 my $cache_key = join("\1",
201 join("\0",@binaries),
202 join("\0",@versions),
204 join("\0",@param{qw(source_only scalar_only)}));
205 if (exists $param{cache}{$cache_key}) {
206 return $param{scalar_only} ? $param{cache}{$cache_key}[0]:
207 @{$param{cache}{$cache_key}};
209 for my $binary (@binaries) {
210 if ($binary =~ m/^src:(.+)$/) {
211 push @source,[$1,''];
214 if (not tied %_binarytosource) {
215 tie %_binarytosource, MLDBM => $config{binary_source_map}, O_RDONLY or
216 die "Unable to open $config{binary_source_map} for reading";
218 # avoid autovivification
219 my $bin = $_binarytosource{$binary};
221 next unless defined $bin;
222 for my $ver (keys %{$bin}) {
223 for my $ar (keys %{$bin->{$ver}}) {
224 my $src = $bin->{$ver}{$ar};
225 next unless defined $src;
226 push @source,[$src->[0],$src->[1]];
231 my $found_one_version = 0;
232 for my $version (@versions) {
233 next unless exists $bin->{$version};
234 if (exists $bin->{$version}{all}) {
235 push @source,dclone($bin->{$version}{all});
243 @t_archs = keys %{$bin->{$version}};
245 for my $arch (@t_archs) {
246 push @source,dclone($bin->{$version}{$arch}) if
247 exists $bin->{$version}{$arch};
254 if ($param{source_only}) {
256 for my $s (@source) {
259 @result = sort keys %uniq;
260 if ($param{scalar_only}) {
261 @result = join(', ',@result);
266 for my $s (@source) {
267 $uniq{$s->[0]}{$s->[1]} = 1;
269 for my $sn (sort keys %uniq) {
270 push @result, [$sn, $_] for sort keys %{$uniq{$sn}};
274 # No $gBinarySourceMap, or it didn't have an entry for this name and
276 $param{cache}{$cache_key} = \@result;
277 return $param{scalar_only} ? $result[0] : @result;
280 =head2 sourcetobinary
282 Returns a list of references to triplets of binary package names, versions,
283 and architectures corresponding to a given source package name and version.
284 If the given source package name and version cannot be found in the database
285 but the source package name is in the unversioned package-to-source map
286 file, then a reference to a binary package name and version pair will be
287 returned, without the architecture.
291 our %_sourcetobinary;
293 my ($srcname, $srcver) = @_;
295 if (not tied %_sourcetobinary) {
296 tie %_sourcetobinary, MLDBM => $gSourceBinaryMap, O_RDONLY or
297 die "Unable top open $gSourceBinaryMap for reading";
302 # avoid autovivification
303 my $source = $_sourcetobinary{$srcname};
304 return () unless defined $source;
305 if (exists $source->{$srcver}) {
306 my $bin = $source->{$srcver};
307 return () unless defined $bin;
310 # No $gSourceBinaryMap, or it didn't have an entry for this name and
311 # version. Try $gPackageSource (unversioned) instead.
312 my @srcpkgs = getsrcpkgs($srcname);
313 return map [$_, $srcver], @srcpkgs;
318 Returns versions of the package in a distribution at a specific
324 my ($pkg, $dist, $arch) = @_;
325 return get_versions(package=>$pkg,
327 defined $arch ? (arch => $arch):(),
335 get_versions(package=>'foopkg',
340 Returns a list of the versions of package in the distributions and
341 architectures listed. This routine only returns unique values.
345 =item package -- package to return list of versions
347 =item dist -- distribution (unstable, stable, testing); can be an
350 =item arch -- architecture (i386, source, ...); can be an arrayref
352 =item time -- returns a version=>time hash at which the newest package
353 matching this version was uploaded
355 =item source -- returns source/version instead of just versions
357 =item no_source_arch -- discards the source architecture when arch is
358 not passed. [Used for finding the versions of binary packages only.]
359 Defaults to 0, which does not discard the source architecture. (This
360 may change in the future, so if you care, please code accordingly.)
362 =item return_archs -- returns a version=>[archs] hash indicating which
363 architectures are at which versions.
367 When called in scalar context, this function will return hashrefs or
368 arrayrefs as appropriate, in list context, it will return paired lists
369 or unpaired lists as appropriate.
377 my %param = validate_with(params => \@_,
378 spec => {package => {type => SCALAR|ARRAYREF,
380 dist => {type => SCALAR|ARRAYREF,
381 default => 'unstable',
383 arch => {type => SCALAR|ARRAYREF,
386 time => {type => BOOLEAN,
389 source => {type => BOOLEAN,
392 no_source_arch => {type => BOOLEAN,
395 return_archs => {type => BOOLEAN,
402 return () if not defined $gVersionTimeIndex;
403 unless (tied %_versions_time) {
404 tie %_versions_time, 'MLDBM', $gVersionTimeIndex, O_RDONLY
405 or die "can't open versions index $gVersionTimeIndex: $!";
407 $versions = \%_versions_time;
410 return () if not defined $gVersionIndex;
411 unless (tied %_versions) {
412 tie %_versions, 'MLDBM', $gVersionIndex, O_RDONLY
413 or die "can't open versions index $gVersionIndex: $!";
415 $versions = \%_versions;
418 for my $package (make_list($param{package})) {
419 my $version = $versions->{$package};
420 next unless defined $version;
421 for my $dist (make_list($param{dist})) {
422 for my $arch (exists $param{arch}?
423 make_list($param{arch}):
424 (grep {not $param{no_source_arch} or
426 } keys %{$version->{$dist}})) {
427 next unless defined $version->{$dist}{$arch};
428 for my $ver (ref $version->{$dist}{$arch} ?
429 keys %{$version->{$dist}{$arch}} :
430 $version->{$dist}{$arch}
433 if ($param{source}) {
434 ($f_ver) = make_source_versions(package => $package,
437 next unless defined $f_ver;
440 $versions{$f_ver} = max($versions{$f_ver}||0,$version->{$dist}{$arch}{$ver});
443 push @{$versions{$f_ver}},$arch;
449 if ($param{time} or $param{return_archs}) {
450 return wantarray?%versions :\%versions;
452 return wantarray?keys %versions :[keys %versions];
456 =head2 makesourceversions
458 @{$cgi_var{found}} = makesourceversions($cgi_var{package},undef,@{$cgi_var{found}});
460 Canonicalize versions into source versions, which have an explicitly
461 named source package. This is used to cope with source packages whose
462 names have changed during their history, and with cases where source
463 version numbers differ from binary version numbers.
467 our %_sourceversioncache = ();
468 sub makesourceversions {
469 my ($package,$arch,@versions) = @_;
470 die "Package $package is multiple packages; split on , and call makesourceversions multiple times"
472 return make_source_versions(package => $package,
473 (defined $arch)?(arch => $arch):(),
474 versions => \@versions
478 =head2 make_source_versions
480 make_source_versions(package => 'foo',
485 warnings => \$warnings,
488 An extended version of makesourceversions (which calls this function
489 internally) that allows for multiple packages, architectures, and
490 outputs warnings and debugging information to provided SCALARREFs or
493 The guess_source option determines whether the source package is
494 guessed at if there is no obviously correct package. Things that use
495 this function for non-transient output should set this to false,
496 things that use it for transient output can set this to true.
497 Currently it defaults to true, but that is not a sane option.
502 sub make_source_versions {
503 my %param = validate_with(params => \@_,
504 spec => {package => {type => SCALAR|ARRAYREF,
506 arch => {type => SCALAR|ARRAYREF|UNDEF,
509 versions => {type => SCALAR|ARRAYREF,
512 guess_source => {type => BOOLEAN,
515 source_version_cache => {type => HASHREF,
518 debug => {type => SCALARREF|HANDLE,
521 warnings => {type => SCALARREF|HANDLE,
526 my ($warnings) = globify_scalar(exists $param{warnings}?$param{warnings}:undef);
527 my ($debug) = globify_scalar(exists $param{debug} ?$param{debug} :undef);
529 my @packages = grep {defined $_ and length $_ } make_list($param{package});
530 my @archs = grep {defined $_ } make_list ($param{arch});
534 if (not exists $param{source_version_cache}) {
535 $param{source_version_cache} = \%_sourceversioncache;
537 if (grep {/,/} make_list($param{package})) {
538 croak "Package names contain ,; split on /,/ and call make_source_versions with an arrayref of packages"
541 for my $version (make_list($param{versions})) {
542 if ($version =~ m{(.+)/([^/]+)$}) {
543 # Already a source version.
544 $sourceversions{$version} = 1;
545 next unless exists $param{warnings};
546 # check to see if this source version is even possible
547 my @bin_versions = sourcetobinary($1,$2);
548 if (not @bin_versions or
549 @{$bin_versions[0]} != 3) {
550 print {$warnings} "The source $1 and version $2 do not appear to match any binary packages\n";
554 croak "You must provide at least one package if the versions are not fully qualified";
556 for my $pkg (@packages) {
557 if ($pkg =~ /^src:(.+)/) {
558 $sourceversions{"$1/$version"} = 1;
559 next unless exists $param{warnings};
560 # check to see if this source version is even possible
561 my @bin_versions = sourcetobinary($1,$version);
562 if (not @bin_versions or
563 @{$bin_versions[0]} != 3) {
564 print {$warnings} "The source $1 and version $2 do not appear to match any binary packages\n";
568 for my $arch (@archs) {
569 my $cachearch = (defined $arch) ? $arch : '';
570 my $cachekey = "$pkg/$cachearch/$version";
571 if (exists($param{source_version_cache}{$cachekey})) {
572 for my $v (@{$param{source_version_cache}{$cachekey}}) {
573 $sourceversions{$v} = 1;
577 elsif ($param{guess_source} and
578 exists$param{source_version_cache}{$cachekey.'/guess'}) {
579 for my $v (@{$param{source_version_cache}{$cachekey.'/guess'}}) {
580 $sourceversions{$v} = 1;
584 my @srcinfo = binary_to_source(binary => $pkg,
588 # We don't have explicit information about the
589 # binary-to-source mapping for this version
591 print {$warnings} "There is no source info for the package '$pkg' at version '$version' with architecture '$arch'\n";
592 if ($param{guess_source}) {
594 my $pkgsrc = getpkgsrc();
595 if (exists $pkgsrc->{$pkg}) {
596 @srcinfo = ([$pkgsrc->{$pkg}, $version]);
597 } elsif (getsrcpkgs($pkg)) {
598 # If we're looking at a source package
599 # that doesn't have a binary of the
600 # same name, just try the same
602 @srcinfo = ([$pkg, $version]);
606 # store guesses in a slightly different location
607 $param{source_version_cache}{$cachekey.'/guess'} = [ map { "$_->[0]/$_->[1]" } @srcinfo ];
611 # only store this if we didn't have to guess it
612 $param{source_version_cache}{$cachekey} = [ map { "$_->[0]/$_->[1]" } @srcinfo ];
614 $sourceversions{"$_->[0]/$_->[1]"} = 1 foreach @srcinfo;
619 return sort keys %sourceversions;