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::AllUtils 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 $config{package_source} and
76 length $config{package_source};
81 my $fh = IO::File->new($config{package_source},'r')
82 or croak("Unable to open $config{package_source} for reading: $!");
84 next unless m/^(\S+)\s+(\S+)\s+(\S.*\S)\s*$/;
85 my ($bin,$cmp,$src)=($1,$2,$3);
88 push @{$srcpkg{$src}}, $bin;
89 $pkgcomponent{$bin}= $cmp;
93 $_pkgcomponent = \%pkgcomponent;
98 =head2 getpkgcomponent
100 Returns a reference to a hash of binary package names to the component of
101 the archive containing those binary packages (e.g. "main", "contrib",
106 sub getpkgcomponent {
107 return $_pkgcomponent if $_pkgcomponent;
109 return $_pkgcomponent;
114 Returns a list of the binary packages produced by a given source package.
120 getpkgsrc() if not defined $_srcpkg;
121 return () if not defined $src or not exists $_srcpkg->{$src};
122 return @{$_srcpkg->{$src}};
125 =head2 binary_to_source
127 binary_to_source(package => 'foo',
132 Turn a binary package (at optional version in optional architecture)
133 into a single (or set) of source packages (optionally) with associated
136 By default, in LIST context, returns a LIST of array refs of source
137 package, source version pairs corresponding to the binary package(s),
138 arch(s), and verion(s) passed.
140 In SCALAR context, only the corresponding source packages are
141 returned, concatenated with ', ' if necessary.
143 If no source can be found, returns undef in scalar context, or the
144 empty list in list context.
148 =item binary -- binary package name(s) as a SCALAR or ARRAYREF
150 =item version -- binary package version(s) as a SCALAR or ARRAYREF;
151 optional, defaults to all versions.
153 =item arch -- binary package architecture(s) as a SCALAR or ARRAYREF;
154 optional, defaults to all architectures.
156 =item source_only -- return only the source name (forced on if in
157 SCALAR context), defaults to false.
159 =item scalar_only -- return a scalar only (forced true if in SCALAR
160 context, also causes source_only to be true), defaults to false.
162 =item cache -- optional HASHREF to be used to cache results of
169 # the two global variables below are used to tie the source maps; we
170 # probably should be retying them in long lived processes.
171 our %_binarytosource;
172 our %_sourcetobinary;
173 sub binary_to_source{
174 my %param = validate_with(params => \@_,
175 spec => {binary => {type => SCALAR|ARRAYREF,
177 version => {type => SCALAR|ARRAYREF,
180 arch => {type => SCALAR|ARRAYREF,
183 source_only => {default => 0,
185 scalar_only => {default => 0,
187 cache => {type => HASHREF,
190 schema => {type => OBJECT,
196 # TODO: This gets hit a lot, especially from buggyversion() - probably
197 # need an extra cache for speed here.
198 return () unless defined $gBinarySourceMap or defined $param{schema};
200 if ($param{scalar_only} or not wantarray) {
201 $param{source_only} = 1;
202 $param{scalar_only} = 1;
206 my @binaries = grep {defined $_} make_list(exists $param{binary}?$param{binary}:[]);
207 my @versions = grep {defined $_} make_list(exists $param{version}?$param{version}:[]);
208 my @archs = grep {defined $_} make_list(exists $param{arch}?$param{arch}:[]);
209 return () unless @binaries;
211 # any src:foo is source package foo with unspecified version
212 @source = map {/^src:(.+)$/?
213 [$1,'']:()} @binaries;
214 @binaries = grep {$_ !~ /^src:/} @binaries;
215 if ($param{schema}) {
216 if ($param{source_only}) {
217 @source = map {$_->[0]} @source;
218 my $src_rs = $param{schema}->resultset('SrcPkg')->
219 search_rs({'binpkg.pkg' => [@binaries],
220 @versions?('bin_vers.ver' => [@versions]):(),
221 @archs?('arch.arch' => [@archs]):(),
223 {join => {'src_vers'=>
224 {'bin_vers'=> ['arch','bin_pkg']}
230 map {$_->pkg} $src_rs->all;
231 if ($param{scalar_only}) {
232 return join(',',@source);
237 my $src_rs = $param{schema}->resultset('SrcVer')->
238 search_rs({'bin_pkg.pkg' => [@binaries],
239 @versions?('bin_vers.ver' => [@versions]):(),
240 @archs?('arch.arch' => [@archs]):(),
243 {'bin_vers' => ['arch','binpkg']},
249 map {[$_->get_column('src_pkg.pkg'),
250 $_->get_column('src_ver.ver'),
252 if (not @source and not @versions and not @archs) {
253 $src_rs = $param{schema}->resultset('SrcPkg')->
254 search_rs({pkg => [@binaries]},
263 my $cache_key = join("\1",
264 join("\0",@binaries),
265 join("\0",@versions),
267 join("\0",@param{qw(source_only scalar_only)}));
268 if (exists $param{cache}{$cache_key}) {
269 return $param{scalar_only} ? $param{cache}{$cache_key}[0]:
270 @{$param{cache}{$cache_key}};
272 for my $binary (@binaries) {
273 if (not tied %_binarytosource) {
274 tie %_binarytosource, MLDBM => $config{binary_source_map}, O_RDONLY or
275 die "Unable to open $config{binary_source_map} for reading";
277 # avoid autovivification
278 my $bin = $_binarytosource{$binary};
279 next unless defined $bin;
281 for my $ver (keys %{$bin}) {
282 for my $ar (keys %{$bin->{$ver}}) {
283 my $src = $bin->{$ver}{$ar};
284 next unless defined $src;
285 push @source,[$src->[0],$src->[1]];
290 for my $version (@versions) {
291 next unless exists $bin->{$version};
292 if (exists $bin->{$version}{all}) {
293 push @source,dclone($bin->{$version}{all});
301 @t_archs = keys %{$bin->{$version}};
303 for my $arch (@t_archs) {
304 push @source,dclone($bin->{$version}{$arch}) if
305 exists $bin->{$version}{$arch};
311 if (not @source and not @versions and not @archs) {
312 # ok, we haven't found any results at all. If we weren't given
313 # a specific version and architecture, then we should try
314 # really hard to figure out the right source
316 # if any the packages we've been given are a valid source
317 # package name, and there's no binary of the same name (we got
318 # here, so there isn't), return it.
320 if (not tied %_sourcetobinary) {
321 tie %_sourcetobinary, MLDBM => $config{source_binary_map}, O_RDONLY or
322 die "Unable top open $gSourceBinaryMap for reading";
324 for my $maybe_sourcepkg (@binaries) {
325 if (exists $_sourcetobinary{$maybe_sourcepkg}) {
326 push @source,[$maybe_sourcepkg,$_] for keys %{$_sourcetobinary{$maybe_sourcepkg}};
329 # if @source is still empty here, it's probably a non-existant
330 # source package, so don't return anything.
335 if ($param{source_only}) {
337 for my $s (@source) {
338 # we shouldn't need to do this, but do this temporarily to
340 next unless defined $s->[0];
343 @result = sort keys %uniq;
344 if ($param{scalar_only}) {
345 @result = join(', ',@result);
350 for my $s (@source) {
351 $uniq{$s->[0]}{$s->[1]} = 1;
353 for my $sn (sort keys %uniq) {
354 push @result, [$sn, $_] for sort keys %{$uniq{$sn}};
358 # No $gBinarySourceMap, or it didn't have an entry for this name and
360 $param{cache}{$cache_key} = \@result;
361 return $param{scalar_only} ? $result[0] : @result;
364 =head2 sourcetobinary
366 Returns a list of references to triplets of binary package names, versions,
367 and architectures corresponding to a given source package name and version.
368 If the given source package name and version cannot be found in the database
369 but the source package name is in the unversioned package-to-source map
370 file, then a reference to a binary package name and version pair will be
371 returned, without the architecture.
376 my ($srcname, $srcver) = @_;
378 if (not tied %_sourcetobinary) {
379 tie %_sourcetobinary, MLDBM => $config{source_binary_map}, O_RDONLY or
380 die "Unable top open $config{source_binary_map} for reading";
385 # avoid autovivification
386 my $source = $_sourcetobinary{$srcname};
387 return () unless defined $source;
388 if (exists $source->{$srcver}) {
389 my $bin = $source->{$srcver};
390 return () unless defined $bin;
393 # No $gSourceBinaryMap, or it didn't have an entry for this name and
394 # version. Try $gPackageSource (unversioned) instead.
395 my @srcpkgs = getsrcpkgs($srcname);
396 return map [$_, $srcver], @srcpkgs;
401 Returns versions of the package in a distribution at a specific
407 my ($pkg, $dist, $arch) = @_;
408 return get_versions(package=>$pkg,
410 defined $arch ? (arch => $arch):(),
418 get_versions(package=>'foopkg',
423 Returns a list of the versions of package in the distributions and
424 architectures listed. This routine only returns unique values.
428 =item package -- package to return list of versions
430 =item dist -- distribution (unstable, stable, testing); can be an
433 =item arch -- architecture (i386, source, ...); can be an arrayref
435 =item time -- returns a version=>time hash at which the newest package
436 matching this version was uploaded
438 =item source -- returns source/version instead of just versions
440 =item no_source_arch -- discards the source architecture when arch is
441 not passed. [Used for finding the versions of binary packages only.]
442 Defaults to 0, which does not discard the source architecture. (This
443 may change in the future, so if you care, please code accordingly.)
445 =item return_archs -- returns a version=>[archs] hash indicating which
446 architectures are at which versions.
448 =item largest_source_version_only -- if there is more than one source
449 version in a particular distribution, discards all versions but the
450 largest in that distribution. Defaults to 1, as this used to be the
451 way that the Debian archive worked.
455 When called in scalar context, this function will return hashrefs or
456 arrayrefs as appropriate, in list context, it will return paired lists
457 or unpaired lists as appropriate.
465 my %param = validate_with(params => \@_,
466 spec => {package => {type => SCALAR|ARRAYREF,
468 dist => {type => SCALAR|ARRAYREF,
469 default => 'unstable',
471 arch => {type => SCALAR|ARRAYREF,
474 time => {type => BOOLEAN,
477 source => {type => BOOLEAN,
480 no_source_arch => {type => BOOLEAN,
483 return_archs => {type => BOOLEAN,
486 largest_source_version_only => {type => BOOLEAN,
493 return () if not defined $gVersionTimeIndex;
494 unless (tied %_versions_time) {
495 tie %_versions_time, 'MLDBM', $gVersionTimeIndex, O_RDONLY
496 or die "can't open versions index $gVersionTimeIndex: $!";
498 $versions = \%_versions_time;
501 return () if not defined $gVersionIndex;
502 unless (tied %_versions) {
503 tie %_versions, 'MLDBM', $gVersionIndex, O_RDONLY
504 or die "can't open versions index $gVersionIndex: $!";
506 $versions = \%_versions;
509 for my $package (make_list($param{package})) {
511 if ($package =~ s/^src://) {
514 my $version = $versions->{$package};
515 next unless defined $version;
516 for my $dist (make_list($param{dist})) {
517 for my $arch (exists $param{arch}?
518 make_list($param{arch}):
519 (grep {not $param{no_source_arch} or
521 } $source_only?'source':keys %{$version->{$dist}})) {
522 next unless defined $version->{$dist}{$arch};
523 my @vers = ref $version->{$dist}{$arch} eq 'HASH' ?
524 keys %{$version->{$dist}{$arch}} :
525 make_list($version->{$dist}{$arch});
526 if ($param{largest_source_version_only} and
527 $arch eq 'source' and @vers > 1) {
528 # order the versions, then pick the biggest version number
529 @vers = sort_versions(@vers);
532 for my $ver (@vers) {
534 if ($param{source}) {
535 ($f_ver) = make_source_versions(package => $package,
538 next unless defined $f_ver;
541 $versions{$f_ver} = max($versions{$f_ver}||0,$version->{$dist}{$arch}{$ver});
544 push @{$versions{$f_ver}},$arch;
550 if ($param{time} or $param{return_archs}) {
551 return wantarray?%versions :\%versions;
553 return wantarray?keys %versions :[keys %versions];
557 =head2 makesourceversions
559 @{$cgi_var{found}} = makesourceversions($cgi_var{package},undef,@{$cgi_var{found}});
561 Canonicalize versions into source versions, which have an explicitly
562 named source package. This is used to cope with source packages whose
563 names have changed during their history, and with cases where source
564 version numbers differ from binary version numbers.
568 our %_sourceversioncache = ();
569 sub makesourceversions {
570 my ($package,$arch,@versions) = @_;
571 die "Package $package is multiple packages; split on , and call makesourceversions multiple times"
573 return make_source_versions(package => $package,
574 (defined $arch)?(arch => $arch):(),
575 versions => \@versions
579 =head2 make_source_versions
581 make_source_versions(package => 'foo',
585 warnings => \$warnings,
588 An extended version of makesourceversions (which calls this function
589 internally) that allows for multiple packages, architectures, and
590 outputs warnings and debugging information to provided SCALARREFs or
593 The guess_source option determines whether the source package is
594 guessed at if there is no obviously correct package. Things that use
595 this function for non-transient output should set this to false,
596 things that use it for transient output can set this to true.
597 Currently it defaults to true, but that is not a sane option.
602 sub make_source_versions {
603 my %param = validate_with(params => \@_,
604 spec => {package => {type => SCALAR|ARRAYREF,
606 arch => {type => SCALAR|ARRAYREF|UNDEF,
609 versions => {type => SCALAR|ARRAYREF,
612 guess_source => {type => BOOLEAN,
615 source_version_cache => {type => HASHREF,
618 debug => {type => SCALARREF|HANDLE,
621 warnings => {type => SCALARREF|HANDLE,
626 my ($warnings) = globify_scalar(exists $param{warnings}?$param{warnings}:undef);
628 my @packages = grep {defined $_ and length $_ } make_list($param{package});
629 my @archs = grep {defined $_ } make_list ($param{arch});
633 if (not exists $param{source_version_cache}) {
634 $param{source_version_cache} = \%_sourceversioncache;
636 if (grep {/,/} make_list($param{package})) {
637 croak "Package names contain ,; split on /,/ and call make_source_versions with an arrayref of packages"
640 for my $version (make_list($param{versions})) {
641 if ($version =~ m{(.+)/([^/]+)$}) {
642 # Already a source version.
643 $sourceversions{$version} = 1;
644 next unless exists $param{warnings};
645 # check to see if this source version is even possible
646 my @bin_versions = sourcetobinary($1,$2);
647 if (not @bin_versions or
648 @{$bin_versions[0]} != 3) {
649 print {$warnings} "The source $1 and version $2 do not appear to match any binary packages\n";
653 croak "You must provide at least one package if the versions are not fully qualified";
655 for my $pkg (@packages) {
656 if ($pkg =~ /^src:(.+)/) {
657 $sourceversions{"$1/$version"} = 1;
658 next unless exists $param{warnings};
659 # check to see if this source version is even possible
660 my @bin_versions = sourcetobinary($1,$version);
661 if (not @bin_versions or
662 @{$bin_versions[0]} != 3) {
663 print {$warnings} "The source '$1' and version '$version' do not appear to match any binary packages\n";
667 for my $arch (@archs) {
668 my $cachearch = (defined $arch) ? $arch : '';
669 my $cachekey = "$pkg/$cachearch/$version";
670 if (exists($param{source_version_cache}{$cachekey})) {
671 for my $v (@{$param{source_version_cache}{$cachekey}}) {
672 $sourceversions{$v} = 1;
676 elsif ($param{guess_source} and
677 exists$param{source_version_cache}{$cachekey.'/guess'}) {
678 for my $v (@{$param{source_version_cache}{$cachekey.'/guess'}}) {
679 $sourceversions{$v} = 1;
683 my @srcinfo = binary_to_source(binary => $pkg,
685 length($arch)?(arch => $arch):());
687 # We don't have explicit information about the
688 # binary-to-source mapping for this version
690 print {$warnings} "There is no source info for the package '$pkg' at version '$version' with architecture '$arch'\n";
691 if ($param{guess_source}) {
693 my $pkgsrc = getpkgsrc();
694 if (exists $pkgsrc->{$pkg}) {
695 @srcinfo = ([$pkgsrc->{$pkg}, $version]);
696 } elsif (getsrcpkgs($pkg)) {
697 # If we're looking at a source package
698 # that doesn't have a binary of the
699 # same name, just try the same
701 @srcinfo = ([$pkg, $version]);
705 # store guesses in a slightly different location
706 $param{source_version_cache}{$cachekey.'/guess'} = [ map { "$_->[0]/$_->[1]" } @srcinfo ];
710 # only store this if we didn't have to guess it
711 $param{source_version_cache}{$cachekey} = [ map { "$_->[0]/$_->[1]" } @srcinfo ];
713 $sourceversions{"$_->[0]/$_->[1]"} = 1 foreach @srcinfo;
718 return sort keys %sourceversions;