3 # Script to extract files from Debian packages
4 # Copyright 2004-2007 Frank Lichtenheld <frank@lichtenheld.de>
6 # based on a shell script which was
7 # Copyright 2003 Noel Köthe
8 # Copyright 2004 Martin Schulze <joey@debian.org>
10 # This program is free software; you can redistribute it and/or modify
11 # it under the terms of the GNU General Public License as published by
12 # the Free Software Foundation; either version 2 of the License, or
13 # (at your option) any later version.
15 # This program is distributed in the hope that it will be useful,
16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 # GNU General Public License for more details.
20 # You should have received a copy of the GNU General Public License
21 # along with this program; if not, write to the Free Software
22 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
28 use lib "$FindBin::Bin/../lib";
29 use lib "$FindBin::Bin";
32 use File::Temp qw( tempdir );
38 use Parse::DebControl;
39 use Parse::DebianChangelog;
41 use Fcntl qw(:DEFAULT :flock);
45 use constant PKGPOOL => 1;
46 use constant DIGESTPOOL => 2;
48 my $PROGNAME = 'extract_files';
52 my $directory = cwd()."/pool";
55 my $target = cwd()."/extracted_files";
57 my $configdir = cwd()."/etc";
58 my ( $verbose, $version, $help, $debug, $force, $use_dump );
61 'verbose|v' => \$verbose,
63 'directory|d=s' => \$directory,
64 'config|c=s' => \$configdir,
65 'target|t=s' => \$target,
66 'workdir|w=s' => \$workdir,
67 'cachefile=s' => \$cachefile,
68 'dumpfile=s' => \$dumpfile,
69 'use_dump' => \$use_dump,
70 'version' => \$version,
75 my (%src_packages, %bin_packages, %cache);
80 already_extracted => 0,
85 Getopt::Long::config('no_getopt_compat', 'no_auto_abbrev');
87 GetOptions(%opthash) or do_error( "couldn't parse commandline parameters" );
90 $directory =~ s,/+$,,o;
92 $TEMPDIR = tempdir( 'pdo_extract_file.XXXXXX',
93 DIR => $workdir, CLEANUP => 1 );
95 $TEMPDIR = tempdir( 'pdo_extract_file.XXXXXX',
99 ##################################################
103 die "$PROGNAME: FATAL: @_\n";
108 warn "$PROGNAME: WARNING: @_\n";
109 if (++$no_warnings > $MAXWARN) {
110 do_error( "too many warnings ($MAXWARN)" );
116 print "$PROGNAME: INFO: @_\n";
122 print "$PROGNAME: DEBUG: @_\n";
130 $$log .= localtime().": @_\n";
133 ##################################################
134 # PACKAGE HANDLING (UNPACKING/CLEANUP)
137 my ( $pkgname, $dscname, $log ) = @_;
139 chdir( $TEMPDIR ) or do_error( "couldn't change working directory to $TEMPDIR" );
141 add_log( $log, "dpkg-source -sn -x $dscname $pkgname+source" );
143 system("dpkg-source", "-sn", "-x", $dscname, "$pkgname+source" ) == 0
145 do_warning( "couldn't unpack $dscname: $!" );
146 add_log( $log, "couldn't unpack $dscname: $!" );
150 return "$pkgname+source";
154 my ( $pkgname, $debname, $log ) = @_;
156 add_log( $log, "unpacking binary package $pkgname" );
158 mkdir( "$TEMPDIR/$pkgname" ) or do {
159 do_warning( "couldn't create directory $TEMPDIR/$pkgname" );
160 add_log( $log, "couldn't create directory $TEMPDIR/$pkgname" );
164 add_log( $log, "dpkg-deb --extract $debname $TEMPDIR/$pkgname" );
166 system("dpkg-deb", "--extract", $debname, "$TEMPDIR/$pkgname" ) == 0
168 do_warning( "couldn't unpack $debname" );
169 add_log( $log, "couldn't unpack $debname" );
176 sub unpack_allbinpkg {
177 my ($pkg_data, $log) = @_;
181 foreach my $pkg (@{$pkg_data->{bins}}) {
182 next if $already_seen{$pkg->{bin_name}}; # some assumptions about sane version numbers included
184 unpack_binpkg($pkg->{bin_name}, $pkg->{deb}, $log );
186 $already_seen{$pkg->{bin_name}}++;
193 foreach my $pkg (keys %{$pkg_data->{bin_list}}) {
194 # rmtree should do that itself, but there seems to be a bug somewhere
195 system( "chmod", "-R", "u+rwx", "$TEMPDIR/$pkg" );
196 rmtree( "$TEMPDIR/$pkg" );
200 ##################################################
203 sub pkg_pool_directory {
206 my $name = $pkg_data->{src_name};
207 my $version = $pkg_data->{src_version};
208 my $dscname = $pkg_data->{dsc};
212 # I would prefer $name_$version but lets be backward compatible
213 # in case someone depends on the naming
214 if ($name =~ /^(lib.)/o) {
215 # $dir .= "$1/$name/${name}_$version";
216 $dir .= "$1/$name/".basename($dscname, '.dsc');
218 # $dir .= substr($name,0,1)."/$name/${name}_$version";
219 $dir .= substr($name,0,1)."/$name/".basename($dscname, '.dsc');
226 my ($pkg_data, $config_data, $log) = @_;
228 if ($config_data->{structure} == PKGPOOL) {
229 my $dir = "$target/".pkg_pool_directory( $pkg_data );
230 if (!$force && -d $dir && -f "$dir/log") {
231 (system( "touch", "$dir/log" ) == 0)
232 or do_warning( "touch of $dir/log failed" );
238 } elsif ($config_data->{structure} == DIGESTPOOL) {
239 die "UNIMPLEMENTED!";
241 do_error( "unknown pool structure $config_data->{structure}" );
246 my ($dir, $log) = @_;
248 open my $logfh, ">$dir/log" or do_error( "couldn't open log file $dir/log.\n$log" );
249 flock $logfh, LOCK_EX or do_error( "couldn't lock log file $dir/log" );;
253 close $logfh or do_warning( "couldn't close log file $dir/log" );
256 ##################################################
259 sub extract_copyright_to_pkgpool {
260 my ($pkg_data, $config_data, $log, $source_dir, $target_dir) = @_;
262 add_log( $log, "copy copyright file from source package" );
264 my $src_tgt = "$target_dir/copyright";
265 copy( "$source_dir/debian/copyright", $src_tgt )
266 or add_log( $log, "seems to have failed: $!" );
268 foreach my $bin_pkg (keys %{$pkg_data->{bin_list}}) {
270 my $usd = "$TEMPDIR/$bin_pkg/usr/share/doc/$bin_pkg";
271 my $cpy = "$usd/copyright";
272 my $tgt = "$target_dir/$bin_pkg.copyright";
275 add_log( $log, "copy copyright file from binary package $bin_pkg" );
277 or add_log( $log, "seems to have failed: $!" );
279 add_log( $log, "copyright file $cpy is symlink, I can't handle that" );
281 add_log( $log, "doc directory $usd is symlink" );
282 my $link = readlink($usd) or add_log( $log, "readlink $usd failed" );
283 if ($link && $link =~ m,^(?:\./)?(\S+)/?$,o) { # do a little sanity check
285 if ($pkg_data->{bin_list}{$pkg2}) {
286 add_log( $log, "symlink points to $pkg2, make symlink to copyright file" );
287 (system("ln", "-s", "$pkg2.copyright", $tgt ) == 0)
288 or add_log( $log, "symlink creation failed" );
290 add_log( $log, "symlink points to $pkg2, don't know what to do with that" );
293 add_log( $log, "link seems fishy, not using" );
297 unless (-e $tgt || -l $tgt) { # if it is a link, we can't be sure that the target package was already processed
298 add_log( $log, "copyright file $tgt still doesn't exist" );
300 add_log( $log, "copyright file of the source package exists, make symlink" );
301 (system("ln", "-s", "copyright", $tgt ) == 0)
302 or add_log( $log, "symlink generation failed" );
304 add_log( $log, "give up on $bin_pkg" );
305 (system( "touch", "$tgt.ERROR" ) == 0)
306 or add_log( $log, "even the touch of $tgt.ERROR failed :(" );
312 unless (-e $src_tgt) {
313 add_log( $log, "copyright file $src_tgt still doesn't exist" );
314 # take one of the binary packages, prefering one that has
315 # the same name as the source package
316 foreach my $bin_pkg (($pkg_data->{src_name},
317 keys %{$pkg_data->{bin_list}})) {
318 if (-e "$target_dir/$bin_pkg.copyright") {
319 add_log( $log, "copyright file $target_dir/$bin_pkg.copyright seems like a good guess to me, make a symlink" );
320 (system("ln", "-s", "$bin_pkg.copyright", $src_tgt ) == 0)
322 add_log( $log, "symlink generation failed" );
328 unless (-e $src_tgt) {
329 add_log( $log, "give up" );
330 (system( "touch", "$src_tgt.ERROR" ) == 0) or
331 add_log( $log, "even the touch of $src_tgt.ERROR failed :(" );
336 sub extract_changelog_to_pkgpool {
337 my ($pkg_data, $config_data, $log, $source_dir, $target_dir) = @_;
339 add_log( $log, "copy changelog file from source package" );
341 my $src_changelog = copy( "$source_dir/debian/changelog",
342 "$target_dir/changelog.txt" );
344 if ($src_changelog) {
345 add_log( $log, "changelog file sucessfully copied" );
347 add_log( $log, "seems to have failed: $!" );
350 add_log( $log, "create enhanced HTML version" );
351 my $chg = Parse::DebianChangelog->init;
352 my $parsed = $chg->parse( { infile => "$source_dir/debian/changelog" } );
354 $chg->html( { outfile => "$target_dir/changelog.html",
355 template => "$configdir/tmpl/default.tmpl" } );
356 add_log( $log, scalar $chg->get_parse_errors )
357 if $chg->get_parse_errors;
359 do_warning( $chg->get_error );
360 add_log( $log, $chg->get_error );
364 sub manage_current_link {
365 my ($pkg_data, $config_data, $log, $source_dir, $target_dir) = @_;
367 my $parent_dir = dirname($target_dir);
368 my $dirname = basename($target_dir);
369 my $current_link = "$parent_dir/current";
370 add_log( $log, "parent_dir=$parent_dir; dirname=$dirname" );
371 unless (-l $current_link) {
372 add_log( $log, "create new current link" );
373 (chdir( $parent_dir ) and
374 not system( 'ln', '-s', $dirname, 'current' )) or
375 add_log( $log, "creating new current link failed: $!" );
377 my $old_target = readlink( $current_link );
378 (my $old_version = $old_target) =~ s/^[^_]*_//o;
379 if (version_cmp( $pkg_data->{src_version},
382 "old_version=$old_version; overwriting current link" );
383 (chdir( $parent_dir ) and
384 unlink( 'current' ) and
385 not system( 'ln', '-s', $dirname, 'current' )) or
386 add_log( $log, "overwriting current link failed: $!" );
389 "old_version=$old_version; not touching current link" );
395 my ($pkg_data, $config_data) = @_;
398 add_log( \$log, "process source package $pkg_data->{src_name} ($pkg_data->{src_version})" );
400 unless (to_update( $pkg_data, $config_data, \$log )) {
401 $stats{already_extracted}++;
402 do_debug( "source package $pkg_data->{src_name} ($pkg_data->{src_version}) doesn't need extracting" );
406 if (my $source_dir = unpack_srcpkg( $pkg_data->{src_name}, $pkg_data->{dsc}, \$log )) {
408 $source_dir = "$TEMPDIR/$source_dir";
410 unpack_allbinpkg($pkg_data, \$log);
412 my $target_dir = "$target/".pkg_pool_directory($pkg_data);
413 add_log( \$log, "source_dir=$source_dir; target_dir=$target_dir" );
415 mkpath( $target_dir );
417 if ($config_data->{structure} == PKGPOOL) {
418 extract_copyright_to_pkgpool( $pkg_data, $config_data, \$log,
419 $source_dir, $target_dir );
420 extract_changelog_to_pkgpool( $pkg_data, $config_data, \$log,
421 $source_dir, $target_dir );
422 manage_current_link( $pkg_data, $config_data, \$log,
423 $source_dir, $target_dir );
424 } elsif ($config_data->{structure} == DIGESTPOOL) {
425 die "UNIMPLEMENTED!";
427 do_error( "unknown pool structure $config_data->{structure}" );
430 # rmtree should do that itself, but there seems to be a bug somewhere
431 system( "chmod", "-R", "u+rwx", "$source_dir" );
432 rmtree( $source_dir );
433 cleanup_binpkg($pkg_data);
434 write_log( $target_dir, $log );
438 sub extract_from_all {
439 my ( $src_packages ) = @_;
441 unless (-d $target) {
442 mkpath( $target ) or do_error( "couldn't create target directory" );
445 # TODO: make configurable
447 structure => PKGPOOL,
450 do_info( scalar(keys(%$src_packages))." source packages to process" );
451 foreach my $p (keys %$src_packages) {
452 foreach my $v (keys %{$src_packages->{$p}}) {
453 extract_files( $src_packages->{$p}{$v}, \%config );
458 ##################################################
459 # COLLECTING INFORMATION
461 sub merge_src_bin_packages {
462 my ( $src_packages, $bin_packages ) = @_;
464 foreach my $p (keys %$bin_packages) { # packages
465 foreach my $v (keys %{$bin_packages->{$p}}) { # versions
466 foreach my $a (keys %{$bin_packages->{$p}{$v}}) { # architectures
467 my %bin_data = %{$bin_packages->{$p}{$v}{$a}};
469 if (exists $src_packages->{$bin_data{bin_src}}{$bin_data{bin_src_version}}) {
470 $src_packages->{$bin_data{bin_src}}{$bin_data{bin_src_version}}{bins} ||= [];
471 push @{$src_packages->{$bin_data{bin_src}}{$bin_data{bin_src_version}}{bins}}, \%bin_data;
472 $src_packages->{$bin_data{bin_src}}{$bin_data{bin_src_version}}{bin_list}{$p}++;
478 return $src_packages;
482 my ( $dscname ) = @_;
484 my $parser = Parse::DebControl->new();
485 my ( $raw_data, $pkg_data );
487 my $dsccontent = $cache{$dscname};
488 unless ($dsccontent) {
489 open my $dscfh, "<", $dscname or do {
490 do_warning( "reading file $dscname failed" );
497 if (/^-----BEGIN PGP SIGNED MESSAGE/o) {
498 while (<$dscfh> =~ /\S/) {}; # skip Hash: line and similar
501 if (/^-----BEGIN PGP SIGNATURE/o) {
507 $cache{$dscname} = $dsccontent;
511 (my $begin = substr($dsccontent,0,20)) =~ s/\n/\\n/go;
512 do_debug( "CACHE HIT: $dscname ($begin)" );
516 unless ( $raw_data = $parser->parse_mem( $dsccontent,
517 { discardCase => 1 } ) ) {
518 do_warning( "parsing file $dscname failed.\n$dsccontent" );
522 my $no_chunks = @$raw_data;
523 if ($no_chunks != 1) {
524 do_warning( "expected exactly one chunk in .dsc file, got $no_chunks" );
529 src_name => $raw_data->[0]{source},
530 src_version => $raw_data->[0]{version},
534 unless( $pkg_data->{src_name} && defined($pkg_data->{src_version})
535 && $pkg_data->{dsc} ) {
537 do_error( "something fishy happened.\n", Dumper( $pkg_data ) );
540 do_debug( "found source package $pkg_data->{src_name}, version $pkg_data->{src_version}" );
547 my ( $debname ) = @_;
549 my $parser = Parse::DebControl->new();
550 my ( $raw_data, $pkg_data );
552 if ($cache{$debname}) {
555 (my $begin = substr($cache{$debname},0,20)) =~ s/\n/\\n/go;
556 do_debug( "CACHE HIT: $debname ($begin)" );
559 $cache{$debname} ||= qx/dpkg-deb --info "$debname" control/;
560 my $control = $cache{$debname};
562 unless ( $raw_data = $parser->parse_mem( $control,
563 { discardCase => 1 } ) ) {
564 do_warning( "parsing control information <<$control>> of file $debname failed" );
568 my $no_chunks = @$raw_data;
569 if ($no_chunks != 1) {
570 do_warning( "expected exactly one chunk in .deb control information, got $no_chunks" );
575 bin_name => $raw_data->[0]{package},
576 bin_version => $raw_data->[0]{version},
577 bin_arch => $raw_data->[0]{architecture},
578 bin_src => $raw_data->[0]{source} || $raw_data->[0]{package},,
579 bin_src_version => $raw_data->[0]{version},
583 if ($pkg_data->{bin_src} =~ /^([\w.+-]+)\s*\(\s*=\s*([^\s\)])\s*\)\s*$/) {
584 $pkg_data->{bin_src} = $1;
585 $pkg_data->{bin_src_version} = $2;
588 do_debug( "found binary package $pkg_data->{bin_name}, version $pkg_data->{bin_version}, architecture $pkg_data->{bin_arch}" );
595 my ( $debname ) = @_;
597 do_debug( "processing deb file $debname" );
599 my $pkg_data = read_deb( $debname );
600 return unless $pkg_data;
602 if (exists $bin_packages{$pkg_data->{bin_name}}{$pkg_data->{bin_version}}{$pkg_data->{bin_arch}}) {
603 do_warning( "duplicated package $pkg_data->{bin_name}, version {$pkg_data->{bin_version}{$pkg_data->{bin_arch}}" );
606 $bin_packages{$pkg_data->{bin_name}}{$pkg_data->{bin_version}}{$pkg_data->{bin_arch}} = $pkg_data;
611 my ( $dscname ) = @_;
613 do_debug( "processing dsc file $dscname" );
615 my $pkg_data = read_dsc( $dscname );
616 return unless $pkg_data;
618 if (exists $src_packages{$pkg_data->{src_name}}{$pkg_data->{src_version}}) {
619 do_warning( "duplicated package $pkg_data->{src_name}, version {$pkg_data->{src_version}" );
622 $src_packages{$pkg_data->{src_name}}{$pkg_data->{src_version}} = $pkg_data;
629 do_debug( "processing directory $dir" );
631 opendir my $dh, $dir or do_error( "couldn't open directory $dir" );
632 while( my $entry = readdir $dh ) {
634 next if $entry =~ /^\.\.?$/o;
636 my $fullname = "$dir/$entry";
638 read_sub( $fullname ) if -d $fullname;
639 collect_dsc( $fullname ) if -f _ && ( $fullname =~ /\.dsc$/o );
640 collect_deb( $fullname ) if -f _ && ( $fullname =~ /\..?deb$/o );
642 closedir $dh or do_warning( "couldn't close directory $dir" );
645 ##################################################
648 do_info( "Using working directory $TEMPDIR" );
650 do_info( "load information from dump file" );
651 open DUMP, '<', $dumpfile
652 or do_error( "couldn't open dump file $dumpfile: $!" );
653 my $info = join "", <DUMP>;
655 close DUMP or do_warning( "couldn't close dump file: $!" );
657 do_info( "collect information (in $directory)" );
659 tie %cache, 'DB_File', $cachefile, O_CREAT|O_RDWR, 0640
660 or die "E: tie with file $cachefile failed: $!";
662 read_sub( $directory );
663 #FIXME: "untie attempted while 1 inner references still exist"
664 # untie %cache if tied %cache;
665 do_info( "postprocess collected information" );
666 merge_src_bin_packages( \%src_packages, \%bin_packages );
668 do_info( "dump backup of collected information" );
669 open DUMP, '>', $dumpfile
670 or do_error( "couldn't open dump file $dumpfile: $!" );
671 print DUMP Data::Dumper->Dump( [ \%src_packages ],
672 [ '*src_packages' ] );
673 close DUMP or do_warning( "couldn't close dump file: $!" );
676 do_info( "begin extracting files" );
677 extract_from_all( \%src_packages );
680 Source Packages: $stats{src_pkgs}
681 Cached Info: $stats{src_cache}
682 Already Extracted: $stats{already_extracted}
683 Binary Packages: $stats{bin_pkgs}
684 Cached Info: $stats{bin_cache}