# dgit
# Debian::Dgit: functions common to dgit and its helpers and servers
#
-# Copyright (C) 2015-2016 Ian Jackson
+# Copyright (C) 2015-2019 Ian Jackson
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
use Digest::SHA;
use Data::Dumper;
use IPC::Open2;
-use File::Path;
+use File::Path qw(:DEFAULT make_path);
use File::Basename;
use Dpkg::Control::Hash;
use Debian::Dgit::ExitStatus;
@ISA = qw(Exporter);
@EXPORT = qw(setup_sigwarn forkcheck_setup forkcheck_mainprocess
dep14_version_mangle
- debiantags debiantag_old debiantag_new
+ debiantags debiantag_new
debiantag_maintview
upstreamversion
+ upstream_commitish_search resolve_upstream_version
stripepoch source_file_leafname is_orig_file_of_p_v
server_branch server_ref
- stat_exists link_ltarget
+ stat_exists link_ltarget rename_link_xf
hashfile
- fail failmsg ensuredir must_getcwd executable_on_path
+ fail failmsg ensuredir ensurepath
+ must_getcwd executable_on_path
waitstatusmsg failedcmd_waitstatus
failedcmd_report_cmd failedcmd
runcmd shell_cmd cmdoutput cmdoutput_errok
- git_rev_parse git_cat_file
+ @git
+ git_rev_parse changedir_git_toplevel git_cat_file
git_get_ref git_get_symref git_for_each_ref
git_for_each_tag_referring is_fast_fwd
git_check_unmodified
git_reflog_action_msg git_update_ref_cmd
- make_commit_text
+ rm_subdir_cached read_tree_subdir
+ read_tree_debian read_tree_upstream
+ make_commit hash_commit hash_commit_text
reflog_cache_insert reflog_cache_lookup
- $package_re $component_re $deliberately_re
+ $package_re $component_re $suite_re $deliberately_re
$distro_re $versiontag_re $series_filename_re
- $orig_f_comp_re $orig_f_sig_re $orig_f_tail_re
+ $orig_f_comp_re $orig_f_sig_re
+ $tarball_f_ext_re $orig_f_tail_re
$extra_orig_namepart_re
$git_null_obj
$branchprefix
our $package_re = '[0-9a-z][-+.0-9a-z]*';
our $component_re = '[0-9a-zA-Z][-+.0-9a-zA-Z]*';
+our $suite_re = '[-+.0-9a-z]+';
our $deliberately_re = "(?:TEST-)?$package_re";
our $distro_re = $component_re;
our $versiontag_re = qr{[-+.\%_0-9a-zA-Z/]+};
our $branchprefix = 'dgit';
our $series_filename_re = qr{(?:^|\.)series(?!\n)$}s;
-our $extra_orig_namepart_re = qr{[-0-9a-z]+};
+our $extra_orig_namepart_re = qr{[-0-9a-zA-Z]+};
our $orig_f_comp_re = qr{orig(?:-$extra_orig_namepart_re)?};
our $orig_f_sig_re = '\\.(?:asc|gpg|pgp)';
-our $orig_f_tail_re = "$orig_f_comp_re\\.tar(?:\\.\\w+)?(?:$orig_f_sig_re)?";
+our $tarball_f_ext_re = "\\.tar(?:\\.\\w+)?(?:$orig_f_sig_re)?";
+our $orig_f_tail_re = "$orig_f_comp_re$tarball_f_ext_re";
our $git_null_obj = '0' x 40;
our $ffq_refprefix = 'ffq-prev';
our $gdrlast_refprefix = 'debrebase-last';
our $printdebug_when_debuglevel = 1;
our $debugcmd_when_debuglevel = 1;
+our (@git) = qw(git);
+
# these three all go together, only valid after record_maindir
our $maindir;
our $maindir_gitdir;
sub initdebug ($) {
($debugprefix) = @_;
- open DEBUG, ">/dev/null" or confess $!;
+ open DEBUG, ">/dev/null" or confess "$!";
}
sub enabledebug () {
- open DEBUG, ">&STDERR" or confess $!;
+ open DEBUG, ">&STDERR" or confess "$!";
DEBUG->autoflush(1);
$debuglevel ||= 1;
}
print DEBUG $debugprefix unless $printdebug_noprefix;
pop @_ while @_ and !length $_[-1];
return unless @_;
- print DEBUG @_ or confess $!;
+ print DEBUG @_ or confess "$!";
$printdebug_noprefix = $_[-1] !~ m{\n$};
}
sub printcmd {
my $fh = shift @_;
my $intro = shift @_;
- print $fh $intro," " or confess $!;
- print $fh shellquote @_ or confess $!;
- print $fh "\n" or confess $!;
+ print $fh $intro." ".(join '', shellquote @_)."\n" or confess "$!";
}
sub debugcmd {
return $v;
}
-sub debiantag_old ($$) {
- my ($v,$distro) = @_;
- return "$distro/". dep14_version_mangle $v;
-}
-
sub debiantag_new ($$) {
my ($v,$distro) = @_;
return "archive/$distro/".dep14_version_mangle $v;
sub debiantags ($$) {
my ($version,$distro) = @_;
- map { $_->($version, $distro) } (\&debiantag_new, \&debiantag_old);
+ map { $_->($version, $distro) } (\&debiantag_new, \&debiantag_maintview);
}
sub stripepoch ($) {
confess "mkdir $dir: $!";
}
+sub ensurepath ($$) {
+ my ($firsttocreate, $subdir) = @_; # creates necessary bits of $subidr
+ ensuredir $firsttocreate;
+ make_path "$firsttocreate/$subdir";
+}
+
sub must_getcwd () {
my $d = getcwd();
defined $d or fail f_ "getcwd failed: %s\n", $!;
sub failedcmd_report_cmd {
my $intro = shift @_;
$intro //= __ "failed command";
- { local ($!); printcmd \*STDERR, _us().": $intro:", @_ or confess $!; };
+ { local ($!); printcmd \*STDERR, _us().": $intro:", @_ or confess "$!"; };
}
sub failedcmd_waitstatus {
my $d;
$!=0; $?=0;
{ local $/ = undef; $d = <P>; }
- confess $! if P->error;
+ confess "$!" if P->error;
if (!close P) { printdebug "=>!$?\n"; return undef; }
chomp $d;
if ($debuglevel > 0) {
$r or fail "(sym)link $old $new: $!\n";
}
+sub rename_link_xf ($$$) {
+ # renames/moves or links/copies $src to $dst,
+ # even if $dst is on a different fs
+ # (May use the filename "$dst.tmp".);
+ # On success, returns true.
+ # On failure, returns false and sets
+ # $@ to a reason message
+ # $! to an errno value, or -1 if not known
+ # having possibly printed something about mv to stderr.
+ # Not safe to use without $keeporig if $dst might be a symlink
+ # to $src, as it might delete $src leaving $dst invalid.
+ my ($keeporig,$src,$dst) = @_;
+ if ($keeporig
+ ? link $src, $dst
+ : rename $src, $dst) {
+ return 1;
+ }
+ if ($! != EXDEV) {
+ $@ = "$!";
+ return 0;
+ }
+ if (!stat $src) {
+ $@ = f_ "stat source file: %S", $!;
+ return 0;
+ }
+ my @src_stat = (stat _)[0..1];
+
+ my @dst_stat;
+ if (stat $dst) {
+ @dst_stat = (stat _)[0..1];
+ } elsif ($! == ENOENT) {
+ } else {
+ $@ = f_ "stat destination file: %S", $!;
+ return 0;
+ }
+
+ if ("@src_stat" eq "@dst_stat") {
+ # (Symlinks to) the same file. No need for a copy but
+ # we may need to delete the original.
+ printdebug "rename_link_xf $keeporig $src $dst EXDEV but same\n";
+ } else {
+ $!=0; $?=0;
+ my @cmd = (qw(cp --), $src, "$dst.tmp");
+ debugcmd '+',@cmd;
+ if (system @cmd) {
+ failedcmd_report_cmd undef, @cmd;
+ $@ = failedcmd_waitstatus();
+ $! = -1;
+ return 0;
+ }
+ if (!rename "$dst.tmp", $dst) {
+ $@ = f_ "finally install file after cp: %S", $!;
+ return 0;
+ }
+ }
+ if (!$keeporig) {
+ if (!unlink $src) {
+ $@ = f_ "delete old file after cp: %S", $!;
+ return 0;
+ }
+ }
+ return 1;
+}
+
sub hashfile ($) {
my ($fn) = @_;
my $h = Digest::SHA->new(256);
return cmdoutput qw(git rev-parse), "$_[0]~0";
}
+sub changedir_git_toplevel () {
+ my $toplevel = cmdoutput qw(git rev-parse --show-toplevel);
+ length $toplevel or fail __ <<END;
+not in a git working tree?
+(git rev-parse --show-toplevel produced no output)
+END
+ chdir $toplevel or fail f_ "chdir toplevel %s: %s\n", $toplevel, $!;
+}
+
sub git_cat_file ($;$) {
my ($objname, $etype) = @_;
# => ($type, $data) or ('missing', undef)
if (!$gcf_pid) {
my @cmd = qw(git cat-file --batch);
debugcmd "GCF|", @cmd;
- $gcf_pid = open2 $gcf_o, $gcf_i, @cmd or confess $!;
+ $gcf_pid = open2 $gcf_o, $gcf_i, @cmd or confess "$!";
}
- printdebug "GCF>| ", $objname, "\n";
- print $gcf_i $objname, "\n" or confess $!;
+ printdebug "GCF>| $objname\n";
+ print $gcf_i $objname, "\n" or confess "$!";
my $x = <$gcf_o>;
printdebug "GCF<| ", $x;
if ($x =~ m/ (missing)$/) { return $chk->($1, undef); }
if (defined $gitdir) {
@cmd = ('sh','-ec','cd "$1"; shift; exec "$@"','x', $gitdir, @cmd);
}
- open GFER, "-|", @cmd or confess $!;
+ open GFER, "-|", @cmd or confess "$!";
debugcmd "|", @cmd;
while (<GFER>) {
chomp or confess "$_ ?";
if ($?==256) {
fail
$cached
- ? "git index contains changes (does not match HEAD)"
- : "working tree is dirty (does not match HEAD)";
+ ? __ "git index contains changes (does not match HEAD)"
+ : __ "working tree is dirty (does not match HEAD)";
} else {
failedcmd @cmd;
}
}
}
+sub upstream_commitish_search ($$) {
+ my ($upstream_version, $tried) = @_;
+ # todo: at some point maybe use git-deborig to do this
+ foreach my $tagpfx ('', 'v', 'upstream/') {
+ my $tag = $tagpfx.(dep14_version_mangle $upstream_version);
+ my $new_upstream = git_get_ref "refs/tags/$tag";
+ push @$tried, $tag;
+ return $new_upstream if length $new_upstream;
+ }
+}
+
+sub resolve_upstream_version ($$) {
+ my ($new_upstream, $upstream_version) = @_;
+
+ my $used = $new_upstream;
+ my $message = __ 'using specified upstream commitish';
+ if (!defined $new_upstream) {
+ my @tried;
+ $new_upstream = upstream_commitish_search $upstream_version, \@tried;
+ if (!length $new_upstream) {
+ fail f_
+ "Could not determine appropriate upstream commitish.\n".
+ " (Tried these tags: %s)\n".
+ " Check version, and specify upstream commitish explicitly.",
+ "@tried";
+ }
+ $used = $tried[-1];
+ $message = f_ 'using upstream from git tag %s', $used;
+ } elsif ($new_upstream =~ m{^refs/tags/($versiontag_re)$}s) {
+ $message = f_ 'using upstream from git tag %s', $1;
+ $used = $1;
+ }
+ $new_upstream = git_rev_parse $new_upstream;
+
+ return ($new_upstream, $used, $message);
+ # used is a human-readable idea of what we found
+}
+
sub is_fast_fwd ($$) {
my ($ancestor,$child) = @_;
my @cmd = (qw(git merge-base), $ancestor, $child);
return qw(git update-ref -m), $msg, @_;
}
+sub rm_subdir_cached ($) {
+ my ($subdir) = @_;
+ runcmd qw(git rm --quiet -rf --cached --ignore-unmatch), $subdir;
+}
+
+sub read_tree_subdir ($$) {
+ my ($subdir, $new_tree_object) = @_;
+ # If $new_tree_object is '', the subtree is deleted.
+ confess unless defined $new_tree_object;
+ rm_subdir_cached $subdir;
+ runcmd qw(git read-tree), "--prefix=$subdir/", $new_tree_object
+ if length $new_tree_object;
+}
+
+sub read_tree_debian ($) {
+ my ($treeish) = @_;
+ read_tree_subdir 'debian', "$treeish:debian";
+ rm_subdir_cached 'debian/patches';
+}
+
+sub read_tree_upstream ($;$$) {
+ my ($treeish, $keep_patches, $tree_with_debian) = @_;
+ # if $tree_with_debian is supplied, will use that for debian/
+ # otherwise will save and restore it. If $tree_with_debian
+ # is '' then debian/ is deleted.
+ my $debian =
+ defined $tree_with_debian ? "$tree_with_debian:debian"
+ : cmdoutput qw(git write-tree --prefix=debian/);
+ runcmd qw(git read-tree), $treeish;
+ read_tree_subdir 'debian', $debian;
+ rm_subdir_cached 'debian/patches' unless $keep_patches;
+}
+
sub changedir ($) {
my ($newdir) = @_;
printdebug "CD $newdir\n";
local $/="\0";
my $r = { };
- open GITS, "-|", @cmd or confess $!;
+ open GITS, "-|", @cmd or confess "$!";
while (<GITS>) {
chomp or confess;
printdebug "=> ", (messagequote $_), "\n";
# branch message is undef
# weird-symref } no $symref,
# notbranch } no $ffq_prev
- return ('detached', 'detached HEAD') unless defined $symref;
- return ('weird-symref', 'HEAD symref is not to refs/')
+ return ('detached', __ 'detached HEAD') unless defined $symref;
+ return ('weird-symref', __ 'HEAD symref is not to refs/')
unless $symref =~ m{^refs/};
my $ffq_prev = "refs/$ffq_refprefix/$'";
my $gdrlast = "refs/$gdrlast_refprefix/$'";
my %opts = ('name' => $desc);
$opts{allow_pgp}= $allowsigned || !$dpkgcontrolhash_noissigned;
$c = Dpkg::Control::Hash->new(%opts);
- $c->parse($fh,$desc) or fail "parsing of $desc failed";
+ $c->parse($fh,$desc) or fail f_ "parsing of %s failed", $desc;
last if $allowsigned;
last if $dpkgcontrolhash_noissigned;
my $issigned= $c->get_option('is_pgp_signed');
$dpkgcontrolhash_noissigned= 1;
seek $fh, 0,0 or confess "seek $desc: $!";
} elsif ($issigned) {
- fail "control file $desc is (already) PGP-signed. ".
+ fail f_
+ "control file %s is (already) PGP-signed. ".
" Note that dgit push needs to modify the .dsc and then".
- " do the signature itself";
+ " do the signature itself",
+ $desc;
} else {
last;
}
sub parsecontrol {
my ($file, $desc, $allowsigned) = @_;
my $fh = new IO::Handle;
- open $fh, '<', $file or die "$file: $!";
+ open $fh, '<', $file or fail f_ "open %s (%s): %s", $file, $desc, $!;
my $c = parsecontrolfh($fh,$desc,$allowsigned);
- $fh->error and confess $!;
+ $fh->error and confess "$!";
close $fh;
return $c;
}
my $c = Dpkg::Control::Hash->new(name => 'parsed changelog');
my $p = new IO::Handle;
my @cmd = (qw(dpkg-parsechangelog), @_);
- open $p, '-|', @cmd or confess $!;
+ open $p, '-|', @cmd or confess "$!";
$c->parse($p);
$?=0; $!=0; close $p or failedcmd @cmd;
return $c;
# @$clogcmd is qw(dpkg-parsechangelog ...some...options...)
# calls $fn->($thisstanza, $desc);
debugcmd "|",@$clogcmd;
- open CLOGS, "-|", @$clogcmd or confess $!;
+ open CLOGS, "-|", @$clogcmd or confess "$!";
for (;;) {
my $stanzatext = do { local $/=""; <CLOGS>; };
printdebug "clogp stanza ".Dumper($stanzatext) if $debuglevel>1;
$fn->($thisstanza, $desc);
}
- confess $! if CLOGS->error;
+ confess "$!" if CLOGS->error;
close CLOGS or $?==SIGPIPE or failedcmd @$clogcmd;
}
-sub make_commit_text ($) {
+sub make_commit ($$) {
+ my ($parents, $message_paras) = @_;
+ my $tree = cmdoutput qw(git write-tree);
+ my @cmd = (qw(git commit-tree), $tree);
+ push @cmd, qw(-p), $_ foreach @$parents;
+ push @cmd, qw(-m), $_ foreach @$message_paras;
+ return cmdoutput @cmd;
+}
+
+sub hash_commit ($) {
+ my ($file) = @_;
+ return cmdoutput qw(git hash-object -w -t commit), $file;
+}
+
+sub hash_commit_text ($) {
my ($text) = @_;
my ($out, $in);
my @cmd = (qw(git hash-object -w -t commit --stdin));
debugcmd "|",@cmd;
print Dumper($text) if $debuglevel > 1;
- my $child = open2($out, $in, @cmd) or confess $!;
+ my $child = open2($out, $in, @cmd) or confess "$!";
my $h;
eval {
- print $in $text or confess $!;
- close $in or confess $!;
+ print $in $text or confess "$!";
+ close $in or confess "$!";
$h = <$out>;
$h =~ m/^\w+$/ or confess;
$h = $&;
# When we no longer need to support squeeze, use --create-reflog
# instead of this:
my $parent = $ref; $parent =~ s{/[^/]+$}{};
- ensuredir "$maindir_gitcommon/logs/$parent";
+ ensurepath "$maindir_gitcommon/logs", "$parent";
my $makelogfh = new IO::File "$maindir_gitcommon/logs/$ref", '>>'
- or confess $!;
+ or confess "$!";
my $oldcache = git_get_ref $ref;
# git update-ref doesn't always update, in this case. *sigh*
my $authline = (ucfirst _us()).
' <'._us().'@example.com> 1000000000 +0000';
- my $dummy = make_commit_text <<END;
+ my $dummy = hash_commit_text <<ENDU.(__ <<END);
tree $tree
parent $value
author $authline
committer $authline
+ENDU
Dummy commit - do not use
END
runcmd qw(git update-ref -m), _us()." - dummy", $ref, $dummy;
# you must have called record_maindir
my @cmd = (qw(git log -g), '--pretty=format:%H %gs', $ref);
debugcmd "|(probably)",@cmd;
- my $child = open GC, "-|"; defined $child or confess $!;
+ my $child = open GC, "-|"; defined $child or confess "$!";
if (!$child) {
- chdir $maindir or confess $!;
+ chdir $maindir or confess "$!";
if (!stat "$maindir_gitcommon/logs/$ref") {
- $! == ENOENT or confess $!;
+ $! == ENOENT or confess "$!";
printdebug ">(no reflog)\n";
finish 0;
}
- exec @cmd; confess $!;
+ exec @cmd; die f_ "exec %s: %s\n", $cmd[0], $!;
}
while (<GC>) {
chomp;
close GC;
return $1;
}
- confess $! if GC->error;
+ confess "$!" if GC->error;
failedcmd unless close GC;
return undef;
}
# changedir playground
# changedir $maindir
#
-# playtree_setup $local_git_cfg
+# playtree_setup
# # ^ call in some (perhaps trivial) subdir of playground
#
# rmtree playground
if (!defined $maindir) {
$maindir = must_getcwd();
if (!stat "$maindir/.git") {
- fail "cannot stat $maindir/.git: $!";
+ fail f_ "cannot stat %s/.git: %s", $maindir, $!;
}
if (-d _) {
# we fall back to this in case we have a pre-worktree
record_maindir();
$spc = "$maindir_gitdir/$spc";
my $parent = dirname $spc;
- mkdir $parent or $!==EEXIST
- or fail "failed to mkdir playground parent $parent: $!";
+ mkdir $parent or $!==EEXIST or fail f_
+ "failed to mkdir playground parent %s: %s", $parent, $!;
return $spc;
}
sub ensure_a_playground ($) {
my ($spc) = @_;
$spc = ensure_a_playground_parent $spc;
- mkdir $spc or $!==EEXIST or fail "failed to mkdir a playground $spc: $!";
+ mkdir $spc or $!==EEXIST or fail f_
+ "failed to mkdir a playground %s: %s", $spc, $!;
return $spc;
}
my ($spc) = @_;
$spc = ensure_a_playground_parent $spc;
rmtree $spc;
- mkdir $spc or fail "failed to mkdir the playground $spc: $!";
+ mkdir $spc or fail f_
+ "failed to mkdir the playground %s: %s", $spc, $!;
return $spc;
}
# ----- playtrees -----
-sub playtree_setup (;$) {
- my ($t_local_git_cfg) = @_;
- $t_local_git_cfg //= $local_git_cfg;
+sub playtree_setup () {
# for use in the playtree
# $maindir must be set, eg by calling record_maindir or fresh_playground
- runcmd qw(git init -q);
- runcmd qw(git config gc.auto 0);
- foreach my $copy (qw(user.email user.name user.useConfigOnly
- core.sharedRepository
- core.compression core.looseCompression
- core.bigFileThreshold core.fsyncObjectFiles)) {
- my $v = $t_local_git_cfg->{$copy};
- next unless $v;
- runcmd qw(git config), $copy, $_ foreach @$v;
- }
# this is confusing: we have
# . playtree, not a worktree, has .git/, our cwd
# $maindir might be a worktree so
# $maindir_gitdir contains our main working "dgit", HEAD, etc.
# $maindir_gitcommon the shared stuff, including .objects
- rmtree('.git/objects');
- symlink "$maindir_gitcommon/objects",'.git/objects' or confess $!;
+
+ # we need to invoke git-playtree-setup via git because
+ # there may be config options it needs which are only available
+ # to us, sensibly, in @git
+
+ # And, we look for it in @INC too. This is a bit perverse.
+ # We do this because in the Debian packages we want to have
+ # a copy of this script in each binary package, rather than
+ # making yet another .deb or tangling the dependencies.
+ # @INC is conveniently available.
+ my $newpath = join ':', +(grep { !m/:/ } @INC),
+ '/usr/share/dgit', $ENV{PATH};
+ runcmd qw(env), "PATH=$newpath", @git, qw(playtree-setup .);
+
ensuredir '.git/info';
- open GA, "> .git/info/attributes" or confess $!;
- print GA "* $negate_harmful_gitattrs\n" or confess $!;
- close GA or confess $!;
+ open GA, "> .git/info/attributes" or confess "$!";
+ print GA "* $negate_harmful_gitattrs\n" or confess "$!";
+ close GA or confess "$!";
}
1;
~ianmdlvl / dgit.git / blobdiff