/usr/share/perl5/Debian/AptContents.pm is in dh-make-perl 0.80-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 | package Debian::AptContents;
use strict;
use warnings;
our $VERSION = '0.77';
=head1 NAME
Debian::AptContents - parse/search through apt-file's Contents files
=head1 SYNOPSIS
my $c = Debian::AptContents->new( { homedir => '~/.dh-make-perl' } );
my @pkgs = $c->find_file_packages('/usr/bin/foo');
my $dep = $c->find_perl_module_package('Foo::Bar');
=head1 TODO
This needs to really work not only for Perl modules.
A module specific to Perl modules is needed by dh-make-perl, but it can
subclass Debian::AptContents, which needs to become more generic.
=cut
use base qw(Class::Accessor);
__PACKAGE__->mk_accessors(
qw(
cache homedir cache_file contents_dir contents_files verbose
source sources dist
)
);
use Config;
use Debian::Dependency;
use DhMakePerl::Utils qw(find_core_perl_dependency);
use File::Spec::Functions qw( catfile catdir splitpath );
use IO::Uncompress::Gunzip;
use List::MoreUtils qw(uniq);
use Module::CoreList ();
use Storable;
use AptPkg::Config;
$AptPkg::Config::_config->init();
our $oldstable_perl = '5.10.1';
=head1 CONSTRUCTOR
=over
=item new
Constructs new instance of the class. Expects at least C<homedir> option.
=back
=head1 FIELDS
=over
=item homedir
(B<mandatory>) Directory where the object stores its cache.
=item contents_dir
Directory where L<apt-file> stores Contents files are stored. Default is
F</var/cache/apt/apt-file>
=item sources
A path to a F<sources.list> file or an array ref of paths to sources.list
files. If not given uses AptPkg's Config to get the list.
=item dist
Used for filtering on the C<distributon> part of the repository paths listed in
L<sources.list>. Default is empty, meaning no filtering.
=item contents_files
Arrayref of F<Contents> file names. Default is to parse the files in C<sources>
and to look in C<contents_dir> for matching files.
=item cache_file
Path to the file with cached parsed information from all F<Contents> files.
Default is F<Contents.cache> under C<homedir>.
=item cache
Filled by C<read_cache>. Used by C<find_file_packages> and (obviously)
C<store_cache>
=item verbose
Verbosity level. 0 means silent, the bigger the more the jabber. Default is 1.
=back
=cut
sub new {
my $class = shift;
$class = ref($class) if ref($class);
my $self = $class->SUPER::new(@_);
# required options
$self->homedir
or die "No homedir given";
# some defaults
$self->contents_dir('/var/cache/apt/apt-file')
unless $self->contents_dir;
$self->sources( [ $self->sources ] )
if $self->sources and not ref( $self->sources );
$self->sources(
[ $AptPkg::Config::_config->get_file('Dir::Etc::sourcelist'),
glob(
$AptPkg::Config::_config->get_dir('Dir::Etc::sourceparts')
. '/*.list'
)
]
) unless defined( $self->sources );
$self->contents_files( $self->get_contents_files )
unless $self->contents_files;
$self->cache_file( catfile( $self->homedir, 'Contents.cache' ) )
unless $self->cache_file;
$self->verbose(1) unless defined( $self->verbose );
$self->read_cache();
return $self;
}
=head1 OBJECT METHODS
=over
=item warning
Used internally. Given a verbosity level and a message, prints the message to
STDERR if the verbosity level is greater than or equal of the value of
C<verbose>.
=cut
sub warning {
my ( $self, $level, $msg ) = @_;
warn "$msg\n" if $self->verbose >= $level;
}
=item repo_source_to_contents_paths
Given a line with Debian package repository path (typically taken from
F<sources.list>), converts it to the corresponding F<Contents> file names.
=cut
sub repo_source_to_contents_paths {
my ( $self, $source ) = @_;
my ( $schema, $uri, $dist, @components ) = split /\s+/, $source;
my ( $proto, $host, $port, $dir ) = $uri =~ m{
^
(?:([^:/?\#]+):)? # proto
(?://
(?:[^:]+:[^@]+@)? # username:password@
([^:/?\#]*) # host
(?::(\d+))? # port
)?
([^?\#]*) # path
}x;
unless ( defined $schema ) {
$self->warning( 1, "'$_' has unknown format" );
next;
}
return unless $schema eq 'deb';
if ( $self->dist ) {
if ( $self->dist =~ /^\s*{\s*(.+)\s*}\s*$/ ) {
return unless grep {/^$dist$/} split( /\s*,\s*/, $1 );
}
else {
return if $dist ne $self->dist;
}
}
$host ||= ''; # set empty string if $host is undef
$dir ||= ''; # deb http://there sid main
s{/$}{} for ( $host, $dir, $dist ); # remove trailing /
s{^/}{} for ( $host, $dir, $dist ); # remove initial /
s{/}{_}g for ( $host, $dir, $dist ); # replace remaining /
# Make sure to generate paths both with and without components to
# be compatible with both old and new apt-file versions. See:
# https://bugs.launchpad.net/ubuntu/+source/dh-make-perl/+bug/1034881
push(@components, '');
return map
{ $host . "_" . join( "_", grep( { defined and length } $dir, "dists", $dist, $_ ) ) }
@components;
}
=item get_contents_files
Reads F<sources.list>, gives the repository paths to
C<repo_source_to_contents_paths> and returns an arrayref of file names of
Contents files.
=cut
sub get_contents_files {
my $self = shift;
my $archspec = `dpkg --print-architecture`;
chomp($archspec);
my @res;
for my $s ( @{ $self->sources } ) {
# by default ->sources contains a list of files that APT would look
# at. Some of them may not exist, so do not fail if this is the case
next unless -e $s;
my $src = IO::File->new( $s, 'r' )
or die "Unable to open '$s': $!\n";
while (<$src>) {
chomp;
s/#.*//;
s/^\s+//;
s/\s+$//;
next unless $_;
for my $path ( $self->repo_source_to_contents_paths($_) ) {
# try all of with/out architecture and
# un/compressed
for my $a ( '', "-$archspec" ) {
for my $c ( '', '.gz' ) {
my $f = catfile( $self->contents_dir,
"${path}_Contents$a$c", );
push @res, $f if -e $f;
}
}
}
}
}
return [ uniq sort @res ];
}
=item read_cache
Reads the cached parsed F<Contents> files. If there are F<Contents> files with
more recent mtime than that of the cache (or if there is no cache at all),
parses all F<Contents> and stores the cache via C<store_cache> for later
invocation.
=cut
sub read_cache {
my $self = shift;
my $cache;
if ( -r $self->cache_file ) {
$cache = eval { Storable::retrieve( $self->cache_file ) };
undef($cache) unless ref($cache) and ref($cache) eq 'HASH';
}
# see if the cache is stale
if ( $cache and $cache->{stamp} and $cache->{contents_files} ) {
undef($cache)
unless join( '><', @{ $self->contents_files } ) eq
join( '><', @{ $cache->{contents_files} } );
# file lists are the same?
# see if any of the files has changed since we
# last read it
if ($cache) {
for ( @{ $self->contents_files } ) {
if ( ( stat($_) )[9] > $cache->{stamp} ) {
undef($cache);
last;
}
}
}
}
else {
undef($cache);
}
unless ($cache) {
$self->source('parsed files');
$cache->{stamp} = time;
$cache->{contents_files} = [];
$cache->{apt_contents} = {};
for ( @{ $self->contents_files } ) {
push @{ $cache->{contents_files} }, $_;
my $f
= /\.gz$/
? IO::Uncompress::Gunzip->new($_)
: IO::File->new( $_, 'r' );
unless ($f) {
warn "Error reading '$_': $!\n";
next;
}
$self->warning( 1, "Parsing $_ ..." );
my $capturing = 0;
my $line;
while ( defined( $line = $f->getline ) ) {
if ($capturing) {
my ( $file, $packages ) = split( /\s+/, $line );
next unless $file =~ s{
^usr/
(?:share|lib)/
(?:perl\d+/ # perl5/
| perl/(?:\d[\d.]+)/ # or perl/5.10/
)
}{}x;
$cache->{apt_contents}{$file} = exists $cache->{apt_contents}{$file}
? $cache->{apt_contents}{$file}.','.$packages
: $packages;
# $packages is a comma-separated list of
# section/package items. We'll parse it when a file
# matches. Otherwise we'd parse thousands of entries,
# while checking only a couple
}
else {
$capturing = 1 if $line =~ /^FILE\s+LOCATION/;
}
}
}
if ( %{ $cache->{apt_contents} } ) {
$self->cache($cache);
$self->store_cache;
}
}
else {
$self->source('cache');
$self->warning( 1,
"Using cached Contents from " . localtime( $cache->{stamp} ) );
$self->cache($cache);
}
}
=item store_cache
Writes the contents of the parsed C<cache> to the C<cache_file>.
Storable is used to stream the data. Along with the information from
F<Contents> files, a time stamp is stored.
=cut
sub store_cache {
my $self = shift;
my ( $vol, $dir, $file ) = splitpath( $self->cache_file );
$dir = catdir( $vol, $dir );
unless ( -d $dir ) {
mkdir $dir
or die "Error creating directory '$dir': $!\n";
}
Storable::nstore( $self->cache, $self->cache_file . '-new' );
rename( $self->cache_file . '-new', $self->cache_file );
}
=item find_file_packages
Returns a list of packages where the given file was found.
F<Contents> files store the package section together with package name. That is
stripped.
Returns an empty list of the file is not found in any package.
=cut
sub find_file_packages {
my ( $self, $file ) = @_;
my $packages = $self->cache->{apt_contents}{$file};
return () unless $packages;
my @packages = split( /,/, $packages ); # Contents contains a
# comma-delimited list
# of packages
s{.+/}{} for @packages; # remove section. Greedy on purpose
# otherwise it won't strip enough off Ubuntu's
# usr/share/perl5/Config/Any.pm universe/perl/libconfig-any-perl
# in-core dependencies are given by find_core_perl_dependency
@packages = grep {
( $_ ne 'perl-base' )
and ( $_ ne 'perl' )
and ( $_ ne 'perl-modules' )
} @packages;
return uniq @packages;
}
=item find_perl_module_package( $module, $version )
Given Perl module name (e.g. Foo::Bar), returns a L<Debian::Dependency> object
representing the required Debian package and version. If the module is a core
one, suitable dependency on perl is returned.
If the package is also available in a separate package, an alternative
dependency is returned.
In case the version of the currently running Perl interpreter is lower than the
version in which the wanted module is available in core, the separate package
is preferred. Otherwise the perl dependency is the first alternative.
=cut
sub find_perl_module_package {
my ( $self, $module, $version ) = @_;
# see if the module is included in perl core
my $core_dep = find_core_perl_dependency( $module, $version );
# try module packages
my $module_file = $module;
$module_file =~ s|::|/|g;
my @matches = $self->find_file_packages("$module_file.pm");
# rank non -perl packages lower
@matches = sort {
if ( $a !~ /-perl$/ ) { return 1; }
elsif ( $b !~ /-perl$/ ) { return -1; }
else { return $a cmp $b; } # or 0?
} @matches;
# we don't want perl, perl-base and perl-modules here
@matches = grep { !/^perl(?:-(?:base|modules))?$/ } @matches;
my $direct_dep;
$direct_dep = Debian::Dependency->new(
( @matches > 1 )
? [ map ( { pkg => $_, rel => '>=', ver => $version }, @matches ) ]
: ( $matches[0], $version )
) if @matches;
my $running_perl = $Config::Config{version};
if ($core_dep) {
# the core dependency is satosfied by oldstable?
if ( $core_dep->ver <= $oldstable_perl ) {
# drop the direct dependency and remove the version
undef($direct_dep);
$core_dep->ver(undef);
$core_dep->rel(undef);
}
if ($direct_dep) {
# both in core and in a package.
if( $running_perl >= $core_dep->ver ) {
return Debian::Dependency->new("$core_dep | $direct_dep");
}
else {
return Debian::Dependency->new("$direct_dep | $core_dep");
}
}
else {
# only in core
return $core_dep;
}
}
else {
# maybe in a package
return $direct_dep;
}
}
1;
=back
=head1 AUTHOR
=over 4
=item Damyan Ivanov <dmn@debian.org>
=back
=head1 COPYRIGHT & LICENSE
=over 4
=item Copyright (C) 2008, 2009, 2010 Damyan Ivanov <dmn@debian.org>
=back
This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License version 2 as published by the Free
Software Foundation.
This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
Street, Fifth Floor, Boston, MA 02110-1301 USA.
=cut
|