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 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
|
#!/usr/bin/perl
=head1 NAME
pristine-tar - regenerate pristine tarballs
=head1 SYNOPSIS
B<pristine-tar> [-vdk] gendelta I<tarball> I<delta>
B<pristine-tar> [-vdk] gentar I<delta> I<tarball>
B<pristine-tar> [-vdk] [-m message] commit I<tarball> [I<upstream>]
B<pristine-tar> [-vdk] checkout I<tarball>
B<pristine-tar> [-vdk] list
B<pristine-tar> [-vdk] verify I<tarball>
=head1 DESCRIPTION
pristine-tar can regenerate an exact copy of a pristine upstream tarball
using only a small binary I<delta> file and the contents of the tarball,
which are typically kept in an I<upstream> branch in version control.
The I<delta> file is designed to be checked into version control along-side
the I<upstream> branch, thus allowing Debian packages to be built entirely
using sources in version control, without the need to keep copies of
upstream tarballs.
pristine-tar supports compressed tarballs, calling out to pristine-gz(1),
pristine-bz2(1), and pristine-xz(1) to produce the pristine gzip, bzip2,
and xz files.
=head1 COMMANDS
=over 4
=item pristine-tar gendelta I<tarball> I<delta>
This takes the specified upstream I<tarball>, and generates a small binary
delta file that can later be used by pristine-tar gentar to recreate the
tarball.
If the delta filename is "-", it is written to standard output.
=item pristine-tar gentar I<delta> I<tarball>
This takes the specified I<delta> file, and the files in the current
directory, which must have identical content to those in the upstream
tarball, and uses these to regenerate the pristine upstream I<tarball>.
If the delta filename is "-", it is read from standard input.
=item pristine-tar commit I<tarball> [I<upstream>]
B<pristine-tar commit> generates a pristine-tar delta file for the specified
I<tarball>, and commits it to version control. The B<pristine-tar checkout>
command can later be used to recreate the original tarball based only
on the information stored in version control.
The I<upstream> parameter specifies the tag or branch that contains the
same content that is present in the tarball. This defaults to
"refs/heads/upstream", or if there's no such branch, any
branch matching "upstream". The name of the tree it points to will be
recorded for later use by B<pristine-tar checkout>. Note that the content
does not need to be 100% identical to the content of the tarball, but
if it is not, additional space will be used in the delta file.
The delta files are stored in a branch named "pristine-tar", with filenames
corresponding to the input tarball, with ".delta" appended. This
branch is created or updated as needed to add each new delta.
If I<tarball> already exists previously, it will only be overwritten if it does
not match a hash of the tarball that has been committed to version control.
=item pristine-tar checkout I<tarball>
This regenerates a copy of the specified I<tarball> using information
previously saved in version control by B<pristine-tar commit>.
=item pristine-tar list
This lists tarballs that pristine-tar is able to checkout from version
control.
=item pristine-tar verify I<tarball>
Verifies whether an existing I<tarball> matches the one that has been committed
to version control.
=back
=head1 OPTIONS
=over 4
=item -v
=item --verbose
Verbose mode, show each command that is run.
=item -d
=item --debug
Debug mode.
=item -k
=item --keep
Don't clean up the temporary directory on exit.
=item -m message
=item --message=message
Use this option to specify a custom commit message to pristine-tar commit.
=back
=head1 EXAMPLES
Suppose you maintain the hello package, in a git repository. You have
just created a tarball of the release, I<hello-1.0.tar.gz>, which you
will upload to a "forge" site.
You want to ensure that, if the "forge" loses the tarball, you can always
recreate exactly that same tarball. And you'd prefer not to keep copies
of tarballs for every release, as that could use a lot of disk space
when hello gets the background mp3s and user-contributed levels you
are planning for version 2.0.
The solution is to use pristine-tar to commit a delta file that efficiently
stores enough information to reproduce the tarball later.
cd hello
git tag -s 1.0
pristine-tar commit ../hello-1.0.tar.gz 1.0
Remember to tell git to push both the pristine-tar branch, and your tag:
git push --all --tags
Now it is a year later. The worst has come to pass; the "forge" lost
all its data, you deleted the tarballs to make room for bug report emails,
and you want to regenerate them. Happily, the git repository is still
available.
git clone git://github.com/joeyh/hello.git
cd hello
pristine-tar checkout ../hello-1.0.tar.gz
=head1 LIMITATIONS
Only tarballs, gzipped tarballs, bzip2ed tarballs, and xzed tarballs
are currently supported.
Currently only the git revision control system is supported by the
"checkout" and "commit" commands. It's ok if the working copy
is not clean or has uncommitted changes, or has changes staged in the
index; none of that will be touched by "checkout" or "commit".
=head1 ENVIRONMENT
=over 4
=item B<TMPDIR>
Specifies a location to place temporary files, other than the default.
=item B<PRISTINE_ALL_XDELTA>
Defines the underlying binary delta tool to be used for new deltas. Supported
values are "xdelta" (default) and "xdelta3".
Existing deltas will be handled with the original tool that was used to
create them, regardless of the value of B<$PRISTINE_ALL_XDELTA>.
=back
=head1 AUTHOR
Joey Hess <joeyh@debian.org>
Licensed under the GPL, version 2 or above.
=cut
use warnings;
use strict;
use Digest::SHA;
use File::Temp;
use Pristine::Tar;
use Pristine::Tar::Delta;
use Pristine::Tar::Formats;
use Pristine::Tar::DeltaTools;
use File::Path;
use File::Basename;
use Cwd qw{getcwd abs_path};
# Force locale to C since tar may output utf-8 filenames differently
# depending on the locale.
$ENV{LANG} = 'C';
# Don't let environment change tar's behavior.
delete $ENV{TAR_OPTIONS};
delete $ENV{TAPE};
# Ask tar to please be compatable with version 1.26.
# In version 1.27, it changed some fields used in longlink entries.
$ENV{PRISTINE_TAR_COMPAT} = 1;
# The following two assignments are potentially munged during the
# build process to hold the values of TAR_PROGRAM parameters as given
# to Makefile.PL.
my $tar_program = "tar";
use constant {
XDELTA => "2",
XDELTA3 => "3",
XDELTA_LONG => "2.0"
};
my $message;
my $genversion =
version_from_env(XDELTA, "xdelta" => XDELTA, "xdelta3" => XDELTA3);
dispatch(
commands => {
usage => [ \&usage ],
gentar => [ \&gentar, 2 ],
gendelta => [ \&gendelta, 2 ],
commit => [ \&commit ],
ci => [ \&commit, 1 ],
checkout => [ \&checkout, 1 ],
co => [ \&checkout, 1 ],
list => [ \&list, 0 ],
verify => [ \&verify, 1 ],
},
options => {
"m|message=s" => \$message,
},
);
sub usage {
print STDERR "Usage: pristine-tar [-vdk] gendelta tarball delta\n";
print STDERR " pristine-tar [-vdk] gentar delta tarball\n";
print STDERR
" pristine-tar [-vdk] [-m message] commit tarball [upstream]\n";
print STDERR " pristine-tar [-vdk] checkout tarball\n";
print STDERR " pristine-tar [-vdk] verify tarball\n";
print STDERR " pristine-tar list\n";
exit 1;
}
sub unquote_filename {
my $filename = shift;
$filename =~ s/\\a/\a/g;
$filename =~ s/\\b/\b/g;
$filename =~ s/\\f/\f/g;
$filename =~ s/\\n/\n/g;
$filename =~ s/\\r/\r/g;
$filename =~ s/\\t/\t/g;
$filename =~ s/\\v/\x11/g;
$filename =~ s/\\\\/\\/g;
return $filename;
}
my $recreatetarball_tempdir;
sub recreatetarball {
my $manifestfile = shift;
my $source = shift;
my %options = @_;
my $tempdir = tempdir();
my @manifest;
open(IN, "<", $manifestfile) || die "$manifestfile: $!";
while (<IN>) {
chomp;
push @manifest, $_;
}
close IN;
link($manifestfile, "$tempdir/manifest") || die "link $tempdir/manifest: $!";
# The manifest and source should have the same filenames,
# but the manifest probably has all the files under a common
# subdirectory. Check if it does.
my $subdir = "";
foreach my $file (@manifest) {
#debug("file: $file");
if ($file =~ m!^(/?[^/]+)(/|$)!) {
if (length $subdir && $subdir ne $1) {
debug("found file not in subdir $subdir: $file");
$subdir = "";
last;
} elsif (!length $subdir) {
$subdir = $1;
debug("set subdir to $subdir");
}
} else {
debug("found file not in subdir: $file");
$subdir = "";
last;
}
}
if (length $subdir) {
debug("subdir is $subdir");
doit("mkdir", "$tempdir/workdir");
$subdir = "/$subdir";
}
if (!$options{clobber_source}) {
doit("cp", "-a", $source, "$tempdir/workdir$subdir");
} else {
doit("mv", $source, "$tempdir/workdir$subdir");
}
# It's important that this create an identical tarball each time
# for a given set of input files. So don't include file metadata
# in the tarball, since it can easily vary.
my $full_sweep = 0;
foreach my $file (@manifest) {
my $unquoted_file = unquote_filename($file);
if (-l "$tempdir/workdir/$unquoted_file") {
# Can't set timestamp of a symlink, so
# replace the symlink with an empty file.
unlink("$tempdir/workdir/$unquoted_file") || die "unlink: $!";
open(OUT, ">", "$tempdir/workdir/$unquoted_file") || die "open: $!";
close OUT;
} elsif (!-e "$tempdir/workdir/$unquoted_file") {
debug(
"$file is listed in the manifest but may not be present in the source directory"
);
$full_sweep = 1;
if ($options{create_missing}) {
# Avoid tar failing on the nonexistent item by
# creating a dummy directory.
debug("creating missing $unquoted_file");
mkpath "$tempdir/workdir/$unquoted_file";
}
}
if (-d "$tempdir/workdir/$unquoted_file" && (-u _ || -g _ || -k _)) {
# tar behaves weirdly for some special modes
# and ignores --mode, so clear them.
debug("chmod $file");
chmod(0755, "$tempdir/workdir/$unquoted_file")
|| die "chmod: $!";
}
}
# Set file times only after modifying of the directory content is
# done.
foreach my $file (@manifest) {
my $unquoted_file = unquote_filename($file);
if (-e "$tempdir/workdir/$unquoted_file") {
utime(0, 0, "$tempdir/workdir/$unquoted_file") || die "utime: $file: $!";
}
}
# If some files couldn't be matched up with the manifest,
# it's possible they do exist, but just with names that make sense
# to tar, but not to this program. Work around this and make sure
# such files have their metadata tweaked, by doing a full sweep of
# the tree.
if ($full_sweep) {
debug("doing full tree sweep to catch missing files");
use File::Find;
find(
sub {
if (-l $_) {
unlink($_) || die "unlink: $!";
open(OUT, ">", $_) || die "open: $!";
close OUT;
}
if (-d $_ && (-u _ || -g _ || -k _)) {
chmod(0755, $_)
|| die "chmod: $!";
}
},
"$tempdir/workdir"
);
find(
sub {
utime(0, 0, $_) || die "utime: $_: $!";
},
"$tempdir/workdir"
);
}
$recreatetarball_tempdir = $tempdir;
return recreatetarball_helper(%options);
}
sub recreatetarball_helper {
my %options = @_;
my $tempdir = $recreatetarball_tempdir;
my $ret = "$tempdir/recreatetarball";
my @cmd = (
$tar_program, "cf",
$ret, "--owner",
0, "--group",
0, "--numeric-owner",
"-C", "$tempdir/workdir",
"--no-recursion", "--mode",
"0644", "--verbatim-files-from",
"--files-from", "$tempdir/manifest"
);
if (exists $options{tar_format}) {
push @cmd, ("-H", $options{tar_format});
}
doit(@cmd);
return $ret;
}
sub recreatetarball_longlink_100 {
# For a long time, Debian's tar had a patch that made it output
# larger tar files if a filename was exactly 100 bytes. Now that
# Debian's tar has been fixed, in order to recreate the tarball
# created by that version of tar, we reply on on an environment
# variable to turn back on the old behavior.
#
# This variable is currently only available in Debian's tar,
# so users of non-debian tar who want to recreate tarballs from
# deltas created using the old version of Debian's tar are SOL.
$ENV{TAR_LONGLINK_100} = 1;
my $ret = recreatetarball_helper();
delete $ENV{TAR_LONGLINK_100};
return $ret;
}
sub gentar {
my $deltafile = shift;
my $tarball = shift;
my %opts = @_;
my $delta = Pristine::Tar::Delta::read(Tarball => $deltafile);
if (-e $tarball && verify_delta($delta, $tarball, fast => 1) == 0) {
message("$tarball already exists and is valid");
return;
}
Pristine::Tar::Delta::assert(
$delta,
type => "tar",
maxversion => XDELTA3,
minversion => XDELTA,
fields => [qw{manifest delta}]
);
my $out = (
defined $delta->{wrapper}
? tempdir() . "/" . basename($tarball) . ".tmp"
: $tarball
);
my @try;
push @try, sub {
recreatetarball(
$delta->{manifest}, getcwd,
clobber_source => 0,
%opts
);
};
push @try, \&recreatetarball_longlink_100;
push @try, sub {
recreatetarball(
$delta->{manifest}, getcwd,
clobber_source => 0,
tar_format => "gnu",
%opts
);
};
push @try, sub {
recreatetarball(
$delta->{manifest}, getcwd,
clobber_source => 0,
tar_format => "posix",
%opts
);
};
my $ok;
my $version = $delta->{version};
foreach my $variant (@try) {
my $recreatetarball = $variant->();
my $ret;
if ($version eq XDELTA || $version eq XDELTA_LONG) {
$ret = try_xdelta_patch($recreatetarball, $delta->{delta}, $out);
} elsif ($version eq XDELTA3) {
$ret = try_xdelta3_patch($recreatetarball, $delta->{delta}, $out);
} else {
die "Unknown version: $version!";
}
if ($ret == 0) {
$ok = 1;
last;
}
}
if (!$ok) {
error "Failed to reproduce original tarball. Please file a bug report.";
}
if (defined $delta->{wrapper}) {
my $delta_wrapper =
Pristine::Tar::Delta::read(Tarball => $delta->{wrapper});
if (grep { $_ eq $delta_wrapper->{type} } qw{gz bz2 xz}) {
doit(
"pristine-" . $delta_wrapper->{type},
($verbose ? "-v" : "--no-verbose"),
($debug ? "-d" : "--no-debug"),
($keep ? "-k" : "--no-keep"),
"gen" . $delta_wrapper->{type},
$delta->{wrapper},
$out
);
doit("mv", "-f", $out . "." . $delta_wrapper->{type}, $tarball);
} else {
error "unknown wrapper file type: " . $delta_wrapper->{type};
}
}
}
sub genmanifest {
my $tarball = shift;
my $manifest = shift;
open(IN, "tar --quoting-style=escape -tf $tarball |") || die "tar tf: $!";
open(OUT, ">", $manifest) || die "$!";
while (<IN>) {
chomp;
# ./ or / in the manifest just confuses tar
s/^\.?\/+//;
print OUT "$_\n" if length $_;
}
close IN;
close OUT;
}
sub gendelta {
my $tarball = shift;
my $deltafile = shift;
my %opts = @_;
my $tempdir = tempdir();
my %delta;
# Check to see if it's compressed, and get uncompressed tarball.
my $compression = undef;
if (is_gz($tarball)) {
$compression = 'gz';
open(IN, "-|", "zcat", $tarball) || die "zcat: $!";
open(OUT, ">", "$tempdir/origtarball") || die "$tempdir/origtarball: $!";
print OUT $_ while <IN>;
close IN || die "zcat: $!";
close OUT || die "$tempdir/origtarball: $!";
} elsif (is_bz2($tarball)) {
$compression = 'bz2';
open(IN, "-|", "bzcat", $tarball) || die "bzcat: $!";
open(OUT, ">", "$tempdir/origtarball") || die "$tempdir/origtarball: $!";
print OUT $_ while <IN>;
close IN || die "bzcat: $!";
close OUT || die "$tempdir/origtarball: $!";
} elsif (is_xz($tarball)) {
$compression = 'xz';
open(IN, "-|", "xzcat", $tarball) || die "xzcat: $!";
open(OUT, ">", "$tempdir/origtarball") || die "$tempdir/origtarball: $!";
print OUT $_ while <IN>;
close IN || die "xzcat: $!";
close OUT || die "$tempdir/origtarball: $!";
}
close IN;
# store a hash of the original tarball
$delta{sha256sum} = get_sha256sum($tarball);
# Generate a wrapper file to recreate the compressed file.
if (defined $compression) {
$delta{wrapper} = "$tempdir/wrapper";
doit(
"pristine-$compression", ($verbose ? "-v" : "--no-verbose"),
($debug ? "-d" : "--no-debug"), ($keep ? "-k" : "--no-keep"),
"gendelta", $tarball,
$delta{wrapper}
);
$tarball = "$tempdir/origtarball";
}
$delta{manifest} = "$tempdir/manifest";
genmanifest($tarball, $delta{manifest});
my $recreatetarball;
if (!exists $opts{recreatetarball}) {
my $sourcedir = "$tempdir/tmp";
doit("mkdir", $sourcedir);
doit($tar_program, "xf", File::Spec->rel2abs($tarball), "-C", $sourcedir);
# if all files were in a subdir, use the subdir as the sourcedir
my @out = grep { $_ ne "$sourcedir/.." && $_ ne "$sourcedir/." }
(glob("$sourcedir/*"), glob("$sourcedir/.*"));
if ($#out == 0 && -d $out[0]) {
$sourcedir = $out[0];
}
$recreatetarball =
recreatetarball("$tempdir/manifest", $sourcedir, clobber_source => 1);
} else {
$recreatetarball = $opts{recreatetarball};
}
$delta{delta} = "$tempdir/delta";
my $ret;
if ($genversion eq XDELTA) {
$ret = try_xdelta_diff($recreatetarball, $tarball, $delta{delta});
} elsif ($genversion eq XDELTA3) {
$ret = try_xdelta3_diff($recreatetarball, $tarball, $delta{delta});
} else {
die "Unknown delta version $genversion. Internal error.";
}
if ($ret != 0) {
error "delta program failed with return code $ret";
}
if (-s $delta{delta} >= -s $tarball) {
print STDERR "error: excessively large binary delta for $tarball\n";
if (!defined $compression) {
print STDERR
"(Probably the tarball is compressed with an unsupported form of compression.)\n";
} else {
print STDERR "(Please consider filing a bug report.)\n";
}
exit 1;
}
Pristine::Tar::Delta::write(
Tarball => $deltafile,
{
version => $genversion,
type => 'tar',
%delta,
}
);
}
sub get_sha256sum {
my $tarball = shift;
my $sha256sum = Digest::SHA->new(256);
$sha256sum->addfile($tarball);
return $sha256sum->hexdigest;
}
sub vcstype {
if (-e ".git" || (exists $ENV{GIT_DIR} && length $ENV{GIT_DIR})) {
return 'git';
} else {
error("cannot determine type of vcs used for the current directory");
}
}
sub export {
my $upstream = shift;
my $dest = tempdir();
my $id;
my $vcs = vcstype();
if ($vcs eq "git") {
if (defined $upstream && $upstream =~ /[A-Za-z0-9]{40}/) {
$id = $upstream;
} else {
if (!defined $upstream) {
$upstream = 'upstream';
}
my @reflines = map { chomp; $_ } `git show-ref \Q$upstream\E`;
if (!@reflines) {
error "failed to find ref using: git show-ref $upstream";
}
# if one line's ref matches exactly, use it
foreach my $line (@reflines) {
my ($b) = $line =~ /^[A-Za-z0-9]+\s(.*)/;
if ($b eq $upstream || $b eq "refs/heads/$upstream") {
($id) = $line =~ /^([A-Za-z0-9]+)\s/;
last;
}
}
if (!defined $id) {
if (@reflines == 1) {
($id) = $reflines[0] =~ /^([A-Za-z0-9]+)\s/;
} else {
error "more than one ref matches \"$upstream\":\n"
. join("\n", @reflines);
}
}
}
# We have an id that is probably a commit. Let's get to the
# id of the actual tree instead. This makes us more robust
# against any later changes to the commit.
my $treeid = `git rev-parse '$id^{tree}'`;
chomp $treeid;
$id = $treeid if length $treeid;
doit("git archive --format=tar \Q$id\E | (cd '$dest' && tar x)");
} else {
die "unsupported vcs $vcs";
}
return ($dest, $id);
}
sub git_findbranch {
# Looks for a branch with the given name. If a local branch exists,
# returns it. Otherwise, looks for a remote branch, and if exactly
# one exists, returns that. If there's no such branch at all, returns
# undef. Finally, if there are multiple remote branches and no
# local branch, fails with an error.
# If remove_dups is true, then remote branches pointing to the same
# hash are squashed. This allows to list/checkout in this special case.
my $branch = shift;
my $remove_dups = shift;
my @reflines = split(/\n/, `git show-ref \Q$branch\E`);
my @remotes = grep { !m/ refs\/heads\/\Q$branch\E$/ } @reflines;
if ($#reflines != $#remotes) {
return $branch;
} else {
if ($remove_dups) {
# squash remotes with the same git hash (first field)
my (%ids, @new_remotes);
foreach my $line (@remotes) {
$line =~ /^(\w+)/;
if (!$ids{$1}) {
push @new_remotes, $line;
$ids{$1} = 1;
}
}
@remotes = @new_remotes;
}
if (@reflines == 0) {
return undef;
} elsif (@remotes == 1) {
my ($remote_branch) = $remotes[0] =~ /^[A-Za-z0-9]+\s(.*)/;
return $remote_branch;
} else {
error
"There's no local $branch branch. Several remote $branch branches exist.\n"
. "Run \"git branch --track $branch <remote>\" to create a local $branch branch\n"
. join("\n", @remotes);
}
}
}
sub checkoutdelta {
my $tarball = shift;
my $branch = "pristine-tar";
my $deltafile = basename($tarball) . ".delta";
my $idfile = basename($tarball) . ".id";
my ($delta, $id);
my $vcs = vcstype();
if ($vcs eq "git") {
my $b = git_findbranch($branch, 1);
if (!defined $b) {
error "no $branch branch found, use \"pristine-tar commit\" first";
} elsif ($b eq $branch) {
$branch = "refs/heads/$branch";
} else {
# use remote branch
$branch = $b;
}
$delta = `git show $branch:\Q$deltafile\E`;
if ($?) {
error "git show $branch:$deltafile failed";
}
if (!length $delta) {
error "git show $branch:$deltafile returned no content";
}
$id = `git show $branch:\Q$idfile\E`;
if ($?) {
error "git show $branch:$idfile failed";
}
chomp $id;
if (!length $id) {
error "git show $branch:$idfile returned no id";
}
} else {
die "unsupported vcs $vcs";
}
return ($delta, $id);
}
sub commitdelta {
my $delta = shift;
my $id = shift;
my $tarball = shift;
my $branch = "pristine-tar";
my $deltafile = basename($tarball) . ".delta";
my $idfile = basename($tarball) . ".id";
my $commit_message =
defined $message
? $message
: "pristine-tar data for " . basename($tarball);
my $vcs = vcstype();
if ($vcs eq "git") {
my $tempdir = tempdir();
open(OUT, ">$tempdir/$deltafile") || die "$tempdir/$deltafile: $!";
print OUT $delta;
close OUT;
open(OUT, ">$tempdir/$idfile") || die "$tempdir/$idfile: $!";
print OUT "$id\n";
close OUT;
# Commit the delta to a branch in git without affecting the
# index, and without touching the working tree. Aka deep
# git magick.
$ENV{GIT_INDEX_FILE} = "$tempdir/index";
$ENV{GIT_WORK_TREE} = "$tempdir";
if (!exists $ENV{GIT_DIR} || !length $ENV{GIT_DIR}) {
$ENV{GIT_DIR} = getcwd . "/.git";
} else {
$ENV{GIT_DIR} = abs_path($ENV{GIT_DIR});
}
chdir($tempdir) || die "chdir: $!";
# If there's no local branch, branch from a remote branch
# if one exists. If there's no remote branch either, the
# code below will create the local branch.
my $b = git_findbranch($branch, 0);
if (defined $b && $b ne $branch) {
doit("git branch --track \Q$branch\E \Q$b\E");
}
my $branch_exists =
(system("git show-ref --quiet --verify refs/heads/$branch") == 0);
if ($branch_exists) {
doit(
"git ls-tree -r --full-name $branch | git update-index --index-info");
}
doit("git", "update-index", "--add", $deltafile, $idfile);
my $sha = `git write-tree`;
if ($?) {
error("git write-tree failed");
}
$sha =~ s/\n//sg;
if (!length $sha) {
error("git write-tree did not return a sha");
}
my $pid = open(COMMIT, "|-");
if (!$pid) {
# child
my $commitopts = $branch_exists ? "-p $branch" : "";
my $commitsha = `git commit-tree $sha $commitopts`;
if ($?) {
error("git commit-tree failed");
}
$commitsha =~ s/\n//sg;
if (!length $commitsha) {
error("git commit-tree did not return a sha");
}
doit("git", "update-ref", "refs/heads/$branch", $commitsha);
exit 0;
} else {
# parent
print COMMIT $commit_message . "\n";
close COMMIT || error("git commit-tree failed");
}
message("committed $deltafile to branch $branch");
} else {
die "unsupported vcs $vcs";
}
}
sub commit {
my $tarball = shift;
my $upstream = shift; # optional
if (!defined $tarball || @_) {
usage();
}
my $tempdir = tempdir();
my ($sourcedir, $id) = export($upstream);
genmanifest($tarball, "$tempdir/manifest");
my $recreatetarball = recreatetarball(
"$tempdir/manifest", $sourcedir,
clobber_source => 1,
create_missing => 1
);
my $pid = open(GENDELTA, "-|");
if (!$pid) {
# child
gendelta($tarball, "-", recreatetarball => $recreatetarball);
exit 0;
}
local $/ = undef;
my $delta = <GENDELTA>;
close GENDELTA || error "failed to generate delta";
commitdelta($delta, $id, $tarball);
}
sub checkout {
my $tarball = shift;
my %opts = @_;
my ($delta, $id) = checkoutdelta($tarball);
my ($sourcedir, undef) = export($id);
my $pid = open(GENTAR, "|-");
if (!$pid) {
# child
$tarball = abs_path($tarball);
chdir($sourcedir) || die "chdir $sourcedir: $!";
gentar("-", $tarball, clobber_source => 1, create_missing => 1);
exit 0;
}
print GENTAR $delta;
close GENTAR || error "failed to generate tarball";
message("successfully generated $tarball") unless $opts{quiet};
}
sub list {
my $branch = "pristine-tar";
my $vcs = vcstype();
if ($vcs eq "git") {
my $b = git_findbranch($branch, 1);
if (defined $b) {
open(LIST, "git ls-tree $b --name-only |");
while (<LIST>) {
chomp;
next unless s/\.delta$//;
print $_. "\n";
}
}
} else {
die "unsupported vcs $vcs";
}
}
sub verify {
my $tarball = shift;
my ($deltadata, $id) = checkoutdelta($tarball);
my $deltafile = File::Temp->new();
print $deltafile $deltadata;
my $delta = Pristine::Tar::Delta::read(Tarball => $deltafile->filename);
exit(verify_delta($delta, $tarball));
}
sub verify_delta {
my $delta = shift;
my $tarball = shift;
my %opts = @_;
my $tarball_hash = get_sha256sum($tarball);
my $stored_hash;
if (defined $delta->{sha256sum}) {
$stored_hash = $delta->{sha256sum};
} elsif ($opts{fast}) {
return 1;
} else {
my $tmpdir = File::Temp->newdir();
my $tmpdirpath = $tmpdir->{DIRNAME};
my $orig_tarball = $tmpdirpath . '/' . basename($tarball);
checkout($orig_tarball, quiet => 1);
$stored_hash = get_sha256sum($orig_tarball);
}
if ($tarball_hash eq $stored_hash) {
return 0;
} else {
message(
"${tarball} does not match stored hash (expected ${stored_hash}, got ${tarball_hash})"
);
return 1;
}
}
|