3 # Integration between git and Debian-style archives
5 # Copyright (C)2013-2015 Ian Jackson
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
28 use Dpkg::Control::Hash;
30 use File::Temp qw(tempdir);
37 use List::Util qw(any);
38 use List::MoreUtils qw(pairwise);
43 our $our_version = 'UNRELEASED'; ###substituted###
45 our @rpushprotovsn_support = qw(4 3 2); # 4 is new tag format
48 our $isuite = 'unstable';
54 our $dryrun_level = 0;
56 our $buildproductsdir = '..';
62 our $existing_package = 'dpkg';
64 our $changes_since_version;
67 our $quilt_modes_re = 'linear|smash|auto|nofix|nocheck|gbp|unapplied';
68 our $we_are_responder;
69 our $initiator_tempdir;
70 our $patches_applied_dirtily = 00;
75 our %format_ok = map { $_=>1 } ("1.0","3.0 (native)","3.0 (quilt)");
77 our $suite_re = '[-+.0-9a-z]+';
78 our $cleanmode_re = 'dpkg-source(?:-d)?|git|git-ff|check|none';
80 our $git_authline_re = '^([^<>]+) \<(\S+)\> (\d+ [-+]\d+)$';
81 our $splitbraincache = 'dgit-intern/quilt-cache';
84 our (@dget) = qw(dget);
85 our (@curl) = qw(curl -f);
86 our (@dput) = qw(dput);
87 our (@debsign) = qw(debsign);
89 our (@sbuild) = qw(sbuild);
91 our (@dgit) = qw(dgit);
92 our (@dpkgbuildpackage) = qw(dpkg-buildpackage -i\.git/ -I.git);
93 our (@dpkgsource) = qw(dpkg-source -i\.git/ -I.git);
94 our (@dpkggenchanges) = qw(dpkg-genchanges);
95 our (@mergechanges) = qw(mergechanges -f);
97 our (@changesopts) = ('');
99 our %opts_opt_map = ('dget' => \@dget, # accept for compatibility
102 'debsign' => \@debsign,
104 'sbuild' => \@sbuild,
108 'dpkg-source' => \@dpkgsource,
109 'dpkg-buildpackage' => \@dpkgbuildpackage,
110 'dpkg-genchanges' => \@dpkggenchanges,
112 'ch' => \@changesopts,
113 'mergechanges' => \@mergechanges);
115 our %opts_opt_cmdonly = ('gpg' => 1, 'git' => 1);
116 our %opts_cfg_insertpos = map {
118 scalar @{ $opts_opt_map{$_} }
119 } keys %opts_opt_map;
121 sub finalise_opts_opts();
127 our $supplementary_message = '';
128 our $need_split_build_invocation = 0;
129 our $split_brain = 0;
133 print STDERR "! $_\n" foreach $supplementary_message =~ m/^.+$/mg;
136 our $remotename = 'dgit';
137 our @ourdscfield = qw(Dgit Vcs-Dgit-Master);
142 my ($v,$distro) = @_;
143 return $tagformatfn->($v, $distro);
146 sub debiantag_maintview ($$) {
147 my ($v,$distro) = @_;
152 sub lbranch () { return "$branchprefix/$csuite"; }
153 my $lbranch_re = '^refs/heads/'.$branchprefix.'/([^/.]+)$';
154 sub lref () { return "refs/heads/".lbranch(); }
155 sub lrref () { return "refs/remotes/$remotename/".server_branch($csuite); }
156 sub rrref () { return server_ref($csuite); }
158 sub lrfetchrefs () { return "refs/dgit-fetch/$csuite"; }
159 sub lrfetchref () { return lrfetchrefs.'/'.server_branch($csuite); }
161 # We fetch some parts of lrfetchrefs/*. Ideally we delete these
162 # locally fetched refs because they have unhelpful names and clutter
163 # up gitk etc. So we track whether we have "used up" head ref (ie,
164 # whether we have made another local ref which refers to this object).
166 # (If we deleted them unconditionally, then we might end up
167 # re-fetching the same git objects each time dgit fetch was run.)
169 # So, leach use of lrfetchrefs needs to be accompanied by arrangements
170 # in git_fetch_us to fetch the refs in question, and possibly a call
171 # to lrfetchref_used.
173 our (%lrfetchrefs_f, %lrfetchrefs_d);
174 # $lrfetchrefs_X{lrfetchrefs."/heads/whatever"} = $objid
176 sub lrfetchref_used ($) {
177 my ($fullrefname) = @_;
178 my $objid = $lrfetchrefs_f{$fullrefname};
179 $lrfetchrefs_d{$fullrefname} = $objid if defined $objid;
190 return "${package}_".(stripepoch $vsn).$sfx
195 return srcfn($vsn,".dsc");
198 sub changespat ($;$) {
199 my ($vsn, $arch) = @_;
200 return "${package}_".(stripepoch $vsn)."_".($arch//'*').".changes";
209 foreach my $f (@end) {
211 print STDERR "$us: cleanup: $@" if length $@;
215 sub badcfg { print STDERR "$us: invalid configuration: @_\n"; exit 12; }
217 sub no_such_package () {
218 print STDERR "$us: package $package does not exist in suite $isuite\n";
224 printdebug "CD $newdir\n";
225 chdir $newdir or confess "chdir: $newdir: $!";
228 sub deliberately ($) {
230 return !!grep { $_ eq "--deliberately-$enquiry" } @deliberatelies;
233 sub deliberately_not_fast_forward () {
234 foreach (qw(not-fast-forward fresh-repo)) {
235 return 1 if deliberately($_) || deliberately("TEST-dgit-only-$_");
239 sub quiltmode_splitbrain () {
240 $quilt_mode =~ m/gbp|dpm|unapplied/;
243 #---------- remote protocol support, common ----------
245 # remote push initiator/responder protocol:
246 # $ dgit remote-push-build-host <n-rargs> <rargs>... <push-args>...
247 # where <rargs> is <push-host-dir> <supported-proto-vsn>,... ...
248 # < dgit-remote-push-ready <actual-proto-vsn>
255 # > supplementary-message NBYTES # $protovsn >= 3
260 # > file parsed-changelog
261 # [indicates that output of dpkg-parsechangelog follows]
262 # > data-block NBYTES
263 # > [NBYTES bytes of data (no newline)]
264 # [maybe some more blocks]
273 # > param head DGIT-VIEW-HEAD
274 # > param csuite SUITE
275 # > param tagformat old|new
276 # > param maint-view MAINT-VIEW-HEAD
278 # > previously REFNAME=OBJNAME # if --deliberately-not-fast-forward
279 # # goes into tag, for replay prevention
282 # [indicates that signed tag is wanted]
283 # < data-block NBYTES
284 # < [NBYTES bytes of data (no newline)]
285 # [maybe some more blocks]
289 # > want signed-dsc-changes
290 # < data-block NBYTES [transfer of signed dsc]
292 # < data-block NBYTES [transfer of signed changes]
300 sub i_child_report () {
301 # Sees if our child has died, and reap it if so. Returns a string
302 # describing how it died if it failed, or undef otherwise.
303 return undef unless $i_child_pid;
304 my $got = waitpid $i_child_pid, WNOHANG;
305 return undef if $got <= 0;
306 die unless $got == $i_child_pid;
307 $i_child_pid = undef;
308 return undef unless $?;
309 return "build host child ".waitstatusmsg();
314 fail "connection lost: $!" if $fh->error;
315 fail "protocol violation; $m not expected";
318 sub badproto_badread ($$) {
320 fail "connection lost: $!" if $!;
321 my $report = i_child_report();
322 fail $report if defined $report;
323 badproto $fh, "eof (reading $wh)";
326 sub protocol_expect (&$) {
327 my ($match, $fh) = @_;
330 defined && chomp or badproto_badread $fh, "protocol message";
338 badproto $fh, "\`$_'";
341 sub protocol_send_file ($$) {
342 my ($fh, $ourfn) = @_;
343 open PF, "<", $ourfn or die "$ourfn: $!";
346 my $got = read PF, $d, 65536;
347 die "$ourfn: $!" unless defined $got;
349 print $fh "data-block ".length($d)."\n" or die $!;
350 print $fh $d or die $!;
352 PF->error and die "$ourfn $!";
353 print $fh "data-end\n" or die $!;
357 sub protocol_read_bytes ($$) {
358 my ($fh, $nbytes) = @_;
359 $nbytes =~ m/^[1-9]\d{0,5}$|^0$/ or badproto \*RO, "bad byte count";
361 my $got = read $fh, $d, $nbytes;
362 $got==$nbytes or badproto_badread $fh, "data block";
366 sub protocol_receive_file ($$) {
367 my ($fh, $ourfn) = @_;
368 printdebug "() $ourfn\n";
369 open PF, ">", $ourfn or die "$ourfn: $!";
371 my ($y,$l) = protocol_expect {
372 m/^data-block (.*)$/ ? (1,$1) :
373 m/^data-end$/ ? (0,) :
377 my $d = protocol_read_bytes $fh, $l;
378 print PF $d or die $!;
383 #---------- remote protocol support, responder ----------
385 sub responder_send_command ($) {
387 return unless $we_are_responder;
388 # called even without $we_are_responder
389 printdebug ">> $command\n";
390 print PO $command, "\n" or die $!;
393 sub responder_send_file ($$) {
394 my ($keyword, $ourfn) = @_;
395 return unless $we_are_responder;
396 printdebug "]] $keyword $ourfn\n";
397 responder_send_command "file $keyword";
398 protocol_send_file \*PO, $ourfn;
401 sub responder_receive_files ($@) {
402 my ($keyword, @ourfns) = @_;
403 die unless $we_are_responder;
404 printdebug "[[ $keyword @ourfns\n";
405 responder_send_command "want $keyword";
406 foreach my $fn (@ourfns) {
407 protocol_receive_file \*PI, $fn;
410 protocol_expect { m/^files-end$/ } \*PI;
413 #---------- remote protocol support, initiator ----------
415 sub initiator_expect (&) {
417 protocol_expect { &$match } \*RO;
420 #---------- end remote code ----------
423 if ($we_are_responder) {
425 responder_send_command "progress ".length($m) or die $!;
426 print PO $m or die $!;
436 $ua = LWP::UserAgent->new();
440 progress "downloading $what...";
441 my $r = $ua->get(@_) or die $!;
442 return undef if $r->code == 404;
443 $r->is_success or fail "failed to fetch $what: ".$r->status_line;
444 return $r->decoded_content(charset => 'none');
447 our ($dscdata,$dscurl,$dsc,$dsc_checked,$skew_warning_vsn);
452 failedcmd @_ if system @_;
455 sub act_local () { return $dryrun_level <= 1; }
456 sub act_scary () { return !$dryrun_level; }
459 if (!$dryrun_level) {
460 progress "dgit ok: @_";
462 progress "would be ok: @_ (but dry run only)";
467 printcmd(\*STDERR,$debugprefix."#",@_);
470 sub runcmd_ordryrun {
478 sub runcmd_ordryrun_local {
487 my ($first_shell, @cmd) = @_;
488 return qw(sh -ec), $first_shell.'; exec "$@"', 'x', @cmd;
491 our $helpmsg = <<END;
493 dgit [dgit-opts] clone [dgit-opts] package [suite] [./dir|/dir]
494 dgit [dgit-opts] fetch|pull [dgit-opts] [suite]
495 dgit [dgit-opts] build [dpkg-buildpackage-opts]
496 dgit [dgit-opts] sbuild [sbuild-opts]
497 dgit [dgit-opts] push [dgit-opts] [suite]
498 dgit [dgit-opts] rpush build-host:build-dir ...
499 important dgit options:
500 -k<keyid> sign tag and package with <keyid> instead of default
501 --dry-run -n do not change anything, but go through the motions
502 --damp-run -L like --dry-run but make local changes, without signing
503 --new -N allow introducing a new package
504 --debug -D increase debug level
505 -c<name>=<value> set git config option (used directly by dgit too)
508 our $later_warning_msg = <<END;
509 Perhaps the upload is stuck in incoming. Using the version from git.
513 print STDERR "$us: @_\n", $helpmsg or die $!;
518 @ARGV or badusage "too few arguments";
519 return scalar shift @ARGV;
523 print $helpmsg or die $!;
527 our $td = $ENV{DGIT_TEST_DUMMY_DIR} || "DGIT_TEST_DUMMY_DIR-unset";
529 our %defcfg = ('dgit.default.distro' => 'debian',
530 'dgit.default.username' => '',
531 'dgit.default.archive-query-default-component' => 'main',
532 'dgit.default.ssh' => 'ssh',
533 'dgit.default.archive-query' => 'madison:',
534 'dgit.default.sshpsql-dbname' => 'service=projectb',
535 'dgit.default.dgit-tag-format' => 'old,new,maint',
536 'dgit-distro.debian.archive-query' => 'ftpmasterapi:',
537 'dgit-distro.debian.git-check' => 'url',
538 'dgit-distro.debian.git-check-suffix' => '/info/refs',
539 'dgit-distro.debian.new-private-pushers' => 't',
540 'dgit-distro.debian.dgit-tag-format' => 'old',
541 'dgit-distro.debian/push.git-url' => '',
542 'dgit-distro.debian/push.git-host' => 'push.dgit.debian.org',
543 'dgit-distro.debian/push.git-user-force' => 'dgit',
544 'dgit-distro.debian/push.git-proto' => 'git+ssh://',
545 'dgit-distro.debian/push.git-path' => '/dgit/debian/repos',
546 'dgit-distro.debian/push.git-create' => 'true',
547 'dgit-distro.debian/push.git-check' => 'ssh-cmd',
548 'dgit-distro.debian.archive-query-url', 'https://api.ftp-master.debian.org/',
549 # 'dgit-distro.debian.archive-query-tls-key',
550 # '/etc/ssl/certs/%HOST%.pem:/etc/dgit/%HOST%.pem',
551 # ^ this does not work because curl is broken nowadays
552 # Fixing #790093 properly will involve providing providing the key
553 # in some pacagke and maybe updating these paths.
555 # 'dgit-distro.debian.archive-query-tls-curl-args',
556 # '--ca-path=/etc/ssl/ca-debian',
557 # ^ this is a workaround but works (only) on DSA-administered machines
558 'dgit-distro.debian.git-url' => 'https://git.dgit.debian.org',
559 'dgit-distro.debian.git-url-suffix' => '',
560 'dgit-distro.debian.upload-host' => 'ftp-master', # for dput
561 'dgit-distro.debian.mirror' => 'http://ftp.debian.org/debian/',
562 'dgit-distro.debian.backports-quirk' => '(squeeze)-backports*',
563 'dgit-distro.debian-backports.mirror' => 'http://backports.debian.org/debian-backports/',
564 'dgit-distro.ubuntu.git-check' => 'false',
565 'dgit-distro.ubuntu.mirror' => 'http://archive.ubuntu.com/ubuntu',
566 'dgit-distro.test-dummy.ssh' => "$td/ssh",
567 'dgit-distro.test-dummy.username' => "alice",
568 'dgit-distro.test-dummy.git-check' => "ssh-cmd",
569 'dgit-distro.test-dummy.git-create' => "ssh-cmd",
570 'dgit-distro.test-dummy.git-url' => "$td/git",
571 'dgit-distro.test-dummy.git-host' => "git",
572 'dgit-distro.test-dummy.git-path' => "$td/git",
573 'dgit-distro.test-dummy.archive-query' => "ftpmasterapi:",
574 'dgit-distro.test-dummy.archive-query-url' => "file://$td/aq/",
575 'dgit-distro.test-dummy.mirror' => "file://$td/mirror/",
576 'dgit-distro.test-dummy.upload-host' => 'test-dummy',
581 sub git_slurp_config () {
582 local ($debuglevel) = $debuglevel-2;
585 my @cmd = (@git, qw(config -z --get-regexp .*));
588 open GITS, "-|", @cmd or die $!;
591 printdebug "=> ", (messagequote $_), "\n";
593 push @{ $gitcfg{$`} }, $'; #';
597 or ($!==0 && $?==256)
601 sub git_get_config ($) {
604 printdebug"C $c ".(defined $l ? messagequote "'$l'" : "undef")."\n"
607 @$l==1 or badcfg "multiple values for $c" if @$l > 1;
613 return undef if $c =~ /RETURN-UNDEF/;
614 my $v = git_get_config($c);
615 return $v if defined $v;
616 my $dv = $defcfg{$c};
617 return $dv if defined $dv;
619 badcfg "need value for one of: @_\n".
620 "$us: distro or suite appears not to be (properly) supported";
623 sub access_basedistro () {
624 if (defined $idistro) {
627 return cfg("dgit-suite.$isuite.distro",
628 "dgit.default.distro");
632 sub access_quirk () {
633 # returns (quirk name, distro to use instead or undef, quirk-specific info)
634 my $basedistro = access_basedistro();
635 my $backports_quirk = cfg("dgit-distro.$basedistro.backports-quirk",
637 if (defined $backports_quirk) {
638 my $re = $backports_quirk;
639 $re =~ s/[^-0-9a-z_\%*()]/\\$&/ig;
641 $re =~ s/\%/([-0-9a-z_]+)/
642 or $re =~ m/[()]/ or badcfg "backports-quirk needs \% or ( )";
643 if ($isuite =~ m/^$re$/) {
644 return ('backports',"$basedistro-backports",$1);
647 return ('none',undef);
652 sub parse_cfg_bool ($$$) {
653 my ($what,$def,$v) = @_;
656 $v =~ m/^[ty1]/ ? 1 :
657 $v =~ m/^[fn0]/ ? 0 :
658 badcfg "$what needs t (true, y, 1) or f (false, n, 0) not \`$v'";
661 sub access_forpush_config () {
662 my $d = access_basedistro();
666 parse_cfg_bool('new-private-pushers', 0,
667 cfg("dgit-distro.$d.new-private-pushers",
670 my $v = cfg("dgit-distro.$d.readonly", 'RETURN-UNDEF');
673 $v =~ m/^[ty1]/ ? 0 : # force readonly, forpush = 0
674 $v =~ m/^[fn0]/ ? 1 : # force nonreadonly, forpush = 1
675 $v =~ m/^[a]/ ? '' : # auto, forpush = ''
676 badcfg "readonly needs t (true, y, 1) or f (false, n, 0) or a (auto)";
679 sub access_forpush () {
680 $access_forpush //= access_forpush_config();
681 return $access_forpush;
685 die "$access_forpush ?" if ($access_forpush // 1) ne 1;
686 badcfg "pushing but distro is configured readonly"
687 if access_forpush_config() eq '0';
689 $supplementary_message = <<'END' unless $we_are_responder;
690 Push failed, before we got started.
691 You can retry the push, after fixing the problem, if you like.
693 finalise_opts_opts();
697 finalise_opts_opts();
700 sub supplementary_message ($) {
702 if (!$we_are_responder) {
703 $supplementary_message = $msg;
705 } elsif ($protovsn >= 3) {
706 responder_send_command "supplementary-message ".length($msg)
708 print PO $msg or die $!;
712 sub access_distros () {
713 # Returns list of distros to try, in order
716 # 0. `instead of' distro name(s) we have been pointed to
717 # 1. the access_quirk distro, if any
718 # 2a. the user's specified distro, or failing that } basedistro
719 # 2b. the distro calculated from the suite }
720 my @l = access_basedistro();
722 my (undef,$quirkdistro) = access_quirk();
723 unshift @l, $quirkdistro;
724 unshift @l, $instead_distro;
725 @l = grep { defined } @l;
727 if (access_forpush()) {
728 @l = map { ("$_/push", $_) } @l;
733 sub access_cfg_cfgs (@) {
736 # The nesting of these loops determines the search order. We put
737 # the key loop on the outside so that we search all the distros
738 # for each key, before going on to the next key. That means that
739 # if access_cfg is called with a more specific, and then a less
740 # specific, key, an earlier distro can override the less specific
741 # without necessarily overriding any more specific keys. (If the
742 # distro wants to override the more specific keys it can simply do
743 # so; whereas if we did the loop the other way around, it would be
744 # impossible to for an earlier distro to override a less specific
745 # key but not the more specific ones without restating the unknown
746 # values of the more specific keys.
749 # We have to deal with RETURN-UNDEF specially, so that we don't
750 # terminate the search prematurely.
752 if (m/RETURN-UNDEF/) { push @rundef, $_; last; }
755 foreach my $d (access_distros()) {
756 push @cfgs, map { "dgit-distro.$d.$_" } @realkeys;
758 push @cfgs, map { "dgit.default.$_" } @realkeys;
765 my (@cfgs) = access_cfg_cfgs(@keys);
766 my $value = cfg(@cfgs);
770 sub access_cfg_bool ($$) {
771 my ($def, @keys) = @_;
772 parse_cfg_bool($keys[0], $def, access_cfg(@keys, 'RETURN-UNDEF'));
775 sub string_to_ssh ($) {
777 if ($spec =~ m/\s/) {
778 return qw(sh -ec), 'exec '.$spec.' "$@"', 'x';
784 sub access_cfg_ssh () {
785 my $gitssh = access_cfg('ssh', 'RETURN-UNDEF');
786 if (!defined $gitssh) {
789 return string_to_ssh $gitssh;
793 sub access_runeinfo ($) {
795 return ": dgit ".access_basedistro()." $info ;";
798 sub access_someuserhost ($) {
800 my $user = access_cfg("$some-user-force", 'RETURN-UNDEF');
801 defined($user) && length($user) or
802 $user = access_cfg("$some-user",'username');
803 my $host = access_cfg("$some-host");
804 return length($user) ? "$user\@$host" : $host;
807 sub access_gituserhost () {
808 return access_someuserhost('git');
811 sub access_giturl (;$) {
813 my $url = access_cfg('git-url','RETURN-UNDEF');
816 my $proto = access_cfg('git-proto', 'RETURN-UNDEF');
817 return undef unless defined $proto;
820 access_gituserhost().
821 access_cfg('git-path');
823 $suffix = access_cfg('git-url-suffix','RETURN-UNDEF');
826 return "$url/$package$suffix";
829 sub parsecontrolfh ($$;$) {
830 my ($fh, $desc, $allowsigned) = @_;
831 our $dpkgcontrolhash_noissigned;
834 my %opts = ('name' => $desc);
835 $opts{allow_pgp}= $allowsigned || !$dpkgcontrolhash_noissigned;
836 $c = Dpkg::Control::Hash->new(%opts);
837 $c->parse($fh,$desc) or die "parsing of $desc failed";
838 last if $allowsigned;
839 last if $dpkgcontrolhash_noissigned;
840 my $issigned= $c->get_option('is_pgp_signed');
841 if (!defined $issigned) {
842 $dpkgcontrolhash_noissigned= 1;
843 seek $fh, 0,0 or die "seek $desc: $!";
844 } elsif ($issigned) {
845 fail "control file $desc is (already) PGP-signed. ".
846 " Note that dgit push needs to modify the .dsc and then".
847 " do the signature itself";
856 my ($file, $desc) = @_;
857 my $fh = new IO::Handle;
858 open $fh, '<', $file or die "$file: $!";
859 my $c = parsecontrolfh($fh,$desc);
860 $fh->error and die $!;
866 my ($dctrl,$field) = @_;
867 my $v = $dctrl->{$field};
868 return $v if defined $v;
869 fail "missing field $field in ".$v->get_option('name');
873 my $c = Dpkg::Control::Hash->new();
874 my $p = new IO::Handle;
875 my @cmd = (qw(dpkg-parsechangelog), @_);
876 open $p, '-|', @cmd or die $!;
878 $?=0; $!=0; close $p or failedcmd @cmd;
882 sub commit_getclogp ($) {
883 # Returns the parsed changelog hashref for a particular commit
885 our %commit_getclogp_memo;
886 my $memo = $commit_getclogp_memo{$objid};
887 return $memo if $memo;
889 my $mclog = ".git/dgit/clog-$objid";
890 runcmd shell_cmd "exec >$mclog", @git, qw(cat-file blob),
891 "$objid:debian/changelog";
892 $commit_getclogp_memo{$objid} = parsechangelog("-l$mclog");
897 defined $d or fail "getcwd failed: $!";
903 sub archive_query ($) {
905 my $query = access_cfg('archive-query','RETURN-UNDEF');
906 $query =~ s/^(\w+):// or badcfg "invalid archive-query method \`$query'";
909 { no strict qw(refs); &{"${method}_${proto}"}($proto,$data); }
912 sub pool_dsc_subpath ($$) {
913 my ($vsn,$component) = @_; # $package is implict arg
914 my $prefix = substr($package, 0, $package =~ m/^l/ ? 4 : 1);
915 return "/pool/$component/$prefix/$package/".dscfn($vsn);
918 #---------- `ftpmasterapi' archive query method (nascent) ----------
920 sub archive_api_query_cmd ($) {
922 my @cmd = qw(curl -sS);
923 my $url = access_cfg('archive-query-url');
924 if ($url =~ m#^https://([-.0-9a-z]+)/#) {
926 my $keys = access_cfg('archive-query-tls-key','RETURN-UNDEF') //'';
927 foreach my $key (split /\:/, $keys) {
928 $key =~ s/\%HOST\%/$host/g;
930 fail "for $url: stat $key: $!" unless $!==ENOENT;
933 fail "config requested specific TLS key but do not know".
934 " how to get curl to use exactly that EE key ($key)";
935 # push @cmd, "--cacert", $key, "--capath", "/dev/enoent";
936 # # Sadly the above line does not work because of changes
937 # # to gnutls. The real fix for #790093 may involve
938 # # new curl options.
941 # Fixing #790093 properly will involve providing a value
942 # for this on clients.
943 my $kargs = access_cfg('archive-query-tls-curl-ca-args','RETURN-UNDEF');
944 push @cmd, split / /, $kargs if defined $kargs;
946 push @cmd, $url.$subpath;
952 my ($data, $subpath) = @_;
953 badcfg "ftpmasterapi archive query method takes no data part"
955 my @cmd = archive_api_query_cmd($subpath);
956 my $json = cmdoutput @cmd;
957 return decode_json($json);
960 sub canonicalise_suite_ftpmasterapi () {
961 my ($proto,$data) = @_;
962 my $suites = api_query($data, 'suites');
964 foreach my $entry (@$suites) {
966 my $v = $entry->{$_};
967 defined $v && $v eq $isuite;
969 push @matched, $entry;
971 fail "unknown suite $isuite" unless @matched;
974 @matched==1 or die "multiple matches for suite $isuite\n";
975 $cn = "$matched[0]{codename}";
976 defined $cn or die "suite $isuite info has no codename\n";
977 $cn =~ m/^$suite_re$/ or die "suite $isuite maps to bad codename\n";
979 die "bad ftpmaster api response: $@\n".Dumper(\@matched)
984 sub archive_query_ftpmasterapi () {
985 my ($proto,$data) = @_;
986 my $info = api_query($data, "dsc_in_suite/$isuite/$package");
988 my $digester = Digest::SHA->new(256);
989 foreach my $entry (@$info) {
991 my $vsn = "$entry->{version}";
992 my ($ok,$msg) = version_check $vsn;
993 die "bad version: $msg\n" unless $ok;
994 my $component = "$entry->{component}";
995 $component =~ m/^$component_re$/ or die "bad component";
996 my $filename = "$entry->{filename}";
997 $filename && $filename !~ m#[^-+:._~0-9a-zA-Z/]|^[/.]|/[/.]#
998 or die "bad filename";
999 my $sha256sum = "$entry->{sha256sum}";
1000 $sha256sum =~ m/^[0-9a-f]+$/ or die "bad sha256sum";
1001 push @rows, [ $vsn, "/pool/$component/$filename",
1002 $digester, $sha256sum ];
1004 die "bad ftpmaster api response: $@\n".Dumper($entry)
1007 @rows = sort { -version_compare($a->[0],$b->[0]) } @rows;
1011 #---------- `madison' archive query method ----------
1013 sub archive_query_madison {
1014 return map { [ @$_[0..1] ] } madison_get_parse(@_);
1017 sub madison_get_parse {
1018 my ($proto,$data) = @_;
1019 die unless $proto eq 'madison';
1020 if (!length $data) {
1021 $data= access_cfg('madison-distro','RETURN-UNDEF');
1022 $data //= access_basedistro();
1024 $rmad{$proto,$data,$package} ||= cmdoutput
1025 qw(rmadison -asource),"-s$isuite","-u$data",$package;
1026 my $rmad = $rmad{$proto,$data,$package};
1029 foreach my $l (split /\n/, $rmad) {
1030 $l =~ m{^ \s*( [^ \t|]+ )\s* \|
1031 \s*( [^ \t|]+ )\s* \|
1032 \s*( [^ \t|/]+ )(?:/([^ \t|/]+))? \s* \|
1033 \s*( [^ \t|]+ )\s* }x or die "$rmad ?";
1034 $1 eq $package or die "$rmad $package ?";
1041 $component = access_cfg('archive-query-default-component');
1043 $5 eq 'source' or die "$rmad ?";
1044 push @out, [$vsn,pool_dsc_subpath($vsn,$component),$newsuite];
1046 return sort { -version_compare($a->[0],$b->[0]); } @out;
1049 sub canonicalise_suite_madison {
1050 # madison canonicalises for us
1051 my @r = madison_get_parse(@_);
1053 "unable to canonicalise suite using package $package".
1054 " which does not appear to exist in suite $isuite;".
1055 " --existing-package may help";
1059 #---------- `sshpsql' archive query method ----------
1062 my ($data,$runeinfo,$sql) = @_;
1063 if (!length $data) {
1064 $data= access_someuserhost('sshpsql').':'.
1065 access_cfg('sshpsql-dbname');
1067 $data =~ m/:/ or badcfg "invalid sshpsql method string \`$data'";
1068 my ($userhost,$dbname) = ($`,$'); #';
1070 my @cmd = (access_cfg_ssh, $userhost,
1071 access_runeinfo("ssh-psql $runeinfo").
1072 " export LC_MESSAGES=C; export LC_CTYPE=C;".
1073 " ".shellquote qw(psql -A), $dbname, qw(-c), $sql);
1075 open P, "-|", @cmd or die $!;
1078 printdebug(">|$_|\n");
1081 $!=0; $?=0; close P or failedcmd @cmd;
1083 my $nrows = pop @rows;
1084 $nrows =~ s/^\((\d+) rows?\)$/$1/ or die "$nrows ?";
1085 @rows == $nrows+1 or die "$nrows ".(scalar @rows)." ?";
1086 @rows = map { [ split /\|/, $_ ] } @rows;
1087 my $ncols = scalar @{ shift @rows };
1088 die if grep { scalar @$_ != $ncols } @rows;
1092 sub sql_injection_check {
1093 foreach (@_) { die "$_ $& ?" if m{[^-+=:_.,/0-9a-zA-Z]}; }
1096 sub archive_query_sshpsql ($$) {
1097 my ($proto,$data) = @_;
1098 sql_injection_check $isuite, $package;
1099 my @rows = sshpsql($data, "archive-query $isuite $package", <<END);
1100 SELECT source.version, component.name, files.filename, files.sha256sum
1102 JOIN src_associations ON source.id = src_associations.source
1103 JOIN suite ON suite.id = src_associations.suite
1104 JOIN dsc_files ON dsc_files.source = source.id
1105 JOIN files_archive_map ON files_archive_map.file_id = dsc_files.file
1106 JOIN component ON component.id = files_archive_map.component_id
1107 JOIN files ON files.id = dsc_files.file
1108 WHERE ( suite.suite_name='$isuite' OR suite.codename='$isuite' )
1109 AND source.source='$package'
1110 AND files.filename LIKE '%.dsc';
1112 @rows = sort { -version_compare($a->[0],$b->[0]) } @rows;
1113 my $digester = Digest::SHA->new(256);
1115 my ($vsn,$component,$filename,$sha256sum) = @$_;
1116 [ $vsn, "/pool/$component/$filename",$digester,$sha256sum ];
1121 sub canonicalise_suite_sshpsql ($$) {
1122 my ($proto,$data) = @_;
1123 sql_injection_check $isuite;
1124 my @rows = sshpsql($data, "canonicalise-suite $isuite", <<END);
1125 SELECT suite.codename
1126 FROM suite where suite_name='$isuite' or codename='$isuite';
1128 @rows = map { $_->[0] } @rows;
1129 fail "unknown suite $isuite" unless @rows;
1130 die "ambiguous $isuite: @rows ?" if @rows>1;
1134 #---------- `dummycat' archive query method ----------
1136 sub canonicalise_suite_dummycat ($$) {
1137 my ($proto,$data) = @_;
1138 my $dpath = "$data/suite.$isuite";
1139 if (!open C, "<", $dpath) {
1140 $!==ENOENT or die "$dpath: $!";
1141 printdebug "dummycat canonicalise_suite $isuite $dpath ENOENT\n";
1145 chomp or die "$dpath: $!";
1147 printdebug "dummycat canonicalise_suite $isuite $dpath = $_\n";
1151 sub archive_query_dummycat ($$) {
1152 my ($proto,$data) = @_;
1153 canonicalise_suite();
1154 my $dpath = "$data/package.$csuite.$package";
1155 if (!open C, "<", $dpath) {
1156 $!==ENOENT or die "$dpath: $!";
1157 printdebug "dummycat query $csuite $package $dpath ENOENT\n";
1165 printdebug "dummycat query $csuite $package $dpath | $_\n";
1166 my @row = split /\s+/, $_;
1167 @row==2 or die "$dpath: $_ ?";
1170 C->error and die "$dpath: $!";
1172 return sort { -version_compare($a->[0],$b->[0]); } @rows;
1175 #---------- tag format handling ----------
1177 sub access_cfg_tagformats () {
1178 split /\,/, access_cfg('dgit-tag-format');
1181 sub need_tagformat ($$) {
1182 my ($fmt, $why) = @_;
1183 fail "need to use tag format $fmt ($why) but also need".
1184 " to use tag format $tagformat_want->[0] ($tagformat_want->[1])".
1185 " - no way to proceed"
1186 if $tagformat_want && $tagformat_want->[0] ne $fmt;
1187 $tagformat_want = [$fmt, $why, $tagformat_want->[2] // 0];
1190 sub select_tagformat () {
1192 return if $tagformatfn && !$tagformat_want;
1193 die 'bug' if $tagformatfn && $tagformat_want;
1194 # ... $tagformat_want assigned after previous select_tagformat
1196 my (@supported) = grep { $_ ne 'maint' } access_cfg_tagformats();
1197 printdebug "select_tagformat supported @supported\n";
1199 $tagformat_want //= [ $supported[0], "distro access configuration", 0 ];
1200 printdebug "select_tagformat specified @$tagformat_want\n";
1202 my ($fmt,$why,$override) = @$tagformat_want;
1204 fail "target distro supports tag formats @supported".
1205 " but have to use $fmt ($why)"
1207 or grep { $_ eq $fmt } @supported;
1209 $tagformat_want = undef;
1211 $tagformatfn = ${*::}{"debiantag_$fmt"};
1213 fail "trying to use unknown tag format \`$fmt' ($why) !"
1214 unless $tagformatfn;
1217 #---------- archive query entrypoints and rest of program ----------
1219 sub canonicalise_suite () {
1220 return if defined $csuite;
1221 fail "cannot operate on $isuite suite" if $isuite eq 'UNRELEASED';
1222 $csuite = archive_query('canonicalise_suite');
1223 if ($isuite ne $csuite) {
1224 progress "canonical suite name for $isuite is $csuite";
1228 sub get_archive_dsc () {
1229 canonicalise_suite();
1230 my @vsns = archive_query('archive_query');
1231 foreach my $vinfo (@vsns) {
1232 my ($vsn,$subpath,$digester,$digest) = @$vinfo;
1233 $dscurl = access_cfg('mirror').$subpath;
1234 $dscdata = url_get($dscurl);
1236 $skew_warning_vsn = $vsn if !defined $skew_warning_vsn;
1241 $digester->add($dscdata);
1242 my $got = $digester->hexdigest();
1244 fail "$dscurl has hash $got but".
1245 " archive told us to expect $digest";
1247 my $dscfh = new IO::File \$dscdata, '<' or die $!;
1248 printdebug Dumper($dscdata) if $debuglevel>1;
1249 $dsc = parsecontrolfh($dscfh,$dscurl,1);
1250 printdebug Dumper($dsc) if $debuglevel>1;
1251 my $fmt = getfield $dsc, 'Format';
1252 fail "unsupported source format $fmt, sorry" unless $format_ok{$fmt};
1253 $dsc_checked = !!$digester;
1254 printdebug "get_archive_dsc: Version ".(getfield $dsc, 'Version')."\n";
1258 printdebug "get_archive_dsc: nothing in archive, returning undef\n";
1261 sub check_for_git ();
1262 sub check_for_git () {
1264 my $how = access_cfg('git-check');
1265 if ($how eq 'ssh-cmd') {
1267 (access_cfg_ssh, access_gituserhost(),
1268 access_runeinfo("git-check $package").
1269 " set -e; cd ".access_cfg('git-path').";".
1270 " if test -d $package.git; then echo 1; else echo 0; fi");
1271 my $r= cmdoutput @cmd;
1272 if (defined $r and $r =~ m/^divert (\w+)$/) {
1274 my ($usedistro,) = access_distros();
1275 # NB that if we are pushing, $usedistro will be $distro/push
1276 $instead_distro= cfg("dgit-distro.$usedistro.diverts.$divert");
1277 $instead_distro =~ s{^/}{ access_basedistro()."/" }e;
1278 progress "diverting to $divert (using config for $instead_distro)";
1279 return check_for_git();
1281 failedcmd @cmd unless defined $r and $r =~ m/^[01]$/;
1283 } elsif ($how eq 'url') {
1284 my $prefix = access_cfg('git-check-url','git-url');
1285 my $suffix = access_cfg('git-check-suffix','git-suffix',
1286 'RETURN-UNDEF') // '.git';
1287 my $url = "$prefix/$package$suffix";
1288 my @cmd = (qw(curl -sS -I), $url);
1289 my $result = cmdoutput @cmd;
1290 $result =~ s/^\S+ 200 .*\n\r?\n//;
1291 # curl -sS -I with https_proxy prints
1292 # HTTP/1.0 200 Connection established
1293 $result =~ m/^\S+ (404|200) /s or
1294 fail "unexpected results from git check query - ".
1295 Dumper($prefix, $result);
1297 if ($code eq '404') {
1299 } elsif ($code eq '200') {
1304 } elsif ($how eq 'true') {
1306 } elsif ($how eq 'false') {
1309 badcfg "unknown git-check \`$how'";
1313 sub create_remote_git_repo () {
1314 my $how = access_cfg('git-create');
1315 if ($how eq 'ssh-cmd') {
1317 (access_cfg_ssh, access_gituserhost(),
1318 access_runeinfo("git-create $package").
1319 "set -e; cd ".access_cfg('git-path').";".
1320 " cp -a _template $package.git");
1321 } elsif ($how eq 'true') {
1324 badcfg "unknown git-create \`$how'";
1328 our ($dsc_hash,$lastpush_mergeinput);
1330 our $ud = '.git/dgit/unpack';
1340 sub mktree_in_ud_here () {
1341 runcmd qw(git init -q);
1342 rmtree('.git/objects');
1343 symlink '../../../../objects','.git/objects' or die $!;
1346 sub git_write_tree () {
1347 my $tree = cmdoutput @git, qw(write-tree);
1348 $tree =~ m/^\w+$/ or die "$tree ?";
1352 sub remove_stray_gits () {
1353 my @gitscmd = qw(find -name .git -prune -print0);
1354 debugcmd "|",@gitscmd;
1355 open GITS, "-|", @gitscmd or die $!;
1360 print STDERR "$us: warning: removing from source package: ",
1361 (messagequote $_), "\n";
1365 $!=0; $?=0; close GITS or failedcmd @gitscmd;
1368 sub mktree_in_ud_from_only_subdir () {
1369 # changes into the subdir
1371 die "@dirs ?" unless @dirs==1;
1372 $dirs[0] =~ m#^([^/]+)/\.$# or die;
1376 remove_stray_gits();
1377 mktree_in_ud_here();
1378 my ($format, $fopts) = get_source_format();
1379 if (madformat($format)) {
1382 runcmd @git, qw(add -Af);
1383 my $tree=git_write_tree();
1384 return ($tree,$dir);
1387 sub dsc_files_info () {
1388 foreach my $csumi (['Checksums-Sha256','Digest::SHA', 'new(256)'],
1389 ['Checksums-Sha1', 'Digest::SHA', 'new(1)'],
1390 ['Files', 'Digest::MD5', 'new()']) {
1391 my ($fname, $module, $method) = @$csumi;
1392 my $field = $dsc->{$fname};
1393 next unless defined $field;
1394 eval "use $module; 1;" or die $@;
1396 foreach (split /\n/, $field) {
1398 m/^(\w+) (\d+) (\S+)$/ or
1399 fail "could not parse .dsc $fname line \`$_'";
1400 my $digester = eval "$module"."->$method;" or die $@;
1405 Digester => $digester,
1410 fail "missing any supported Checksums-* or Files field in ".
1411 $dsc->get_option('name');
1415 map { $_->{Filename} } dsc_files_info();
1418 sub is_orig_file ($;$) {
1421 m/\.orig(?:-\w+)?\.tar\.\w+$/ or return 0;
1422 defined $base or return 1;
1426 sub make_commit ($) {
1428 return cmdoutput @git, qw(hash-object -w -t commit), $file;
1431 sub clogp_authline ($) {
1433 my $author = getfield $clogp, 'Maintainer';
1434 $author =~ s#,.*##ms;
1435 my $date = cmdoutput qw(date), '+%s %z', qw(-d), getfield($clogp,'Date');
1436 my $authline = "$author $date";
1437 $authline =~ m/$git_authline_re/o or
1438 fail "unexpected commit author line format \`$authline'".
1439 " (was generated from changelog Maintainer field)";
1440 return ($1,$2,$3) if wantarray;
1444 sub vendor_patches_distro ($$) {
1445 my ($checkdistro, $what) = @_;
1446 return unless defined $checkdistro;
1448 my $series = "debian/patches/\L$checkdistro\E.series";
1449 printdebug "checking for vendor-specific $series ($what)\n";
1451 if (!open SERIES, "<", $series) {
1452 die "$series $!" unless $!==ENOENT;
1461 Unfortunately, this source package uses a feature of dpkg-source where
1462 the same source package unpacks to different source code on different
1463 distros. dgit cannot safely operate on such packages on affected
1464 distros, because the meaning of source packages is not stable.
1466 Please ask the distro/maintainer to remove the distro-specific series
1467 files and use a different technique (if necessary, uploading actually
1468 different packages, if different distros are supposed to have
1472 fail "Found active distro-specific series file for".
1473 " $checkdistro ($what): $series, cannot continue";
1475 die "$series $!" if SERIES->error;
1479 sub check_for_vendor_patches () {
1480 # This dpkg-source feature doesn't seem to be documented anywhere!
1481 # But it can be found in the changelog (reformatted):
1483 # commit 4fa01b70df1dc4458daee306cfa1f987b69da58c
1484 # Author: Raphael Hertzog <hertzog@debian.org>
1485 # Date: Sun Oct 3 09:36:48 2010 +0200
1487 # dpkg-source: correctly create .pc/.quilt_series with alternate
1490 # If you have debian/patches/ubuntu.series and you were
1491 # unpacking the source package on ubuntu, quilt was still
1492 # directed to debian/patches/series instead of
1493 # debian/patches/ubuntu.series.
1495 # debian/changelog | 3 +++
1496 # scripts/Dpkg/Source/Package/V3/quilt.pm | 4 +++-
1497 # 2 files changed, 6 insertions(+), 1 deletion(-)
1500 vendor_patches_distro($ENV{DEB_VENDOR}, "DEB_VENDOR");
1501 vendor_patches_distro(Dpkg::Vendor::get_current_vendor(),
1502 "Dpkg::Vendor \`current vendor'");
1503 vendor_patches_distro(access_basedistro(),
1504 "distro being accessed");
1507 sub generate_commits_from_dsc () {
1508 # See big comment in fetch_from_archive, below.
1512 foreach my $fi (dsc_files_info()) {
1513 my $f = $fi->{Filename};
1514 die "$f ?" if $f =~ m#/|^\.|\.dsc$|\.tmp$#;
1516 link_ltarget "../../../$f", $f
1520 complete_file_from_dsc('.', $fi)
1523 if (is_orig_file($f)) {
1524 link $f, "../../../../$f"
1530 my $dscfn = "$package.dsc";
1532 open D, ">", $dscfn or die "$dscfn: $!";
1533 print D $dscdata or die "$dscfn: $!";
1534 close D or die "$dscfn: $!";
1535 my @cmd = qw(dpkg-source);
1536 push @cmd, '--no-check' if $dsc_checked;
1537 push @cmd, qw(-x --), $dscfn;
1540 my ($tree,$dir) = mktree_in_ud_from_only_subdir();
1541 check_for_vendor_patches() if madformat($dsc->{format});
1542 runcmd qw(sh -ec), 'dpkg-parsechangelog >../changelog.tmp';
1543 my $clogp = parsecontrol('../changelog.tmp',"commit's changelog");
1544 my $authline = clogp_authline $clogp;
1545 my $changes = getfield $clogp, 'Changes';
1546 open C, ">../commit.tmp" or die $!;
1547 print C <<END or die $!;
1554 # imported from the archive
1557 my $rawimport_hash = make_commit qw(../commit.tmp);
1558 my $cversion = getfield $clogp, 'Version';
1559 my $rawimport_mergeinput = {
1560 Commit => $rawimport_hash,
1561 Info => "Import of source package",
1563 my @output = ($rawimport_mergeinput);
1564 progress "synthesised git commit from .dsc $cversion";
1565 if ($lastpush_mergeinput) {
1566 my $lastpush_hash = $lastpush_mergeinput->{Commit};
1567 runcmd @git, qw(reset -q --hard), $lastpush_hash;
1568 runcmd qw(sh -ec), 'dpkg-parsechangelog >>../changelogold.tmp';
1569 my $oldclogp = parsecontrol('../changelogold.tmp','previous changelog');
1570 my $oversion = getfield $oldclogp, 'Version';
1572 version_compare($oversion, $cversion);
1574 @output = ($rawimport_mergeinput, $lastpush_mergeinput,
1575 { Message => <<END, ReverseParents => 1 });
1576 Record $package ($cversion) in archive suite $csuite
1578 } elsif ($vcmp > 0) {
1579 print STDERR <<END or die $!;
1581 Version actually in archive: $cversion (older)
1582 Last version pushed with dgit: $oversion (newer or same)
1585 @output = $lastpush_mergeinput;
1587 # Same version. Use what's in the server git branch,
1588 # discarding our own import. (This could happen if the
1589 # server automatically imports all packages into git.)
1590 @output = $lastpush_mergeinput;
1593 changedir '../../../..';
1598 sub complete_file_from_dsc ($$) {
1599 our ($dstdir, $fi) = @_;
1600 # Ensures that we have, in $dir, the file $fi, with the correct
1601 # contents. (Downloading it from alongside $dscurl if necessary.)
1603 my $f = $fi->{Filename};
1604 my $tf = "$dstdir/$f";
1607 if (stat_exists $tf) {
1608 progress "using existing $f";
1611 $furl =~ s{/[^/]+$}{};
1613 die "$f ?" unless $f =~ m/^\Q${package}\E_/;
1614 die "$f ?" if $f =~ m#/#;
1615 runcmd_ordryrun_local @curl,qw(-o),$tf,'--',"$furl";
1616 return 0 if !act_local();
1620 open F, "<", "$tf" or die "$tf: $!";
1621 $fi->{Digester}->reset();
1622 $fi->{Digester}->addfile(*F);
1623 F->error and die $!;
1624 my $got = $fi->{Digester}->hexdigest();
1625 $got eq $fi->{Hash} or
1626 fail "file $f has hash $got but .dsc".
1627 " demands hash $fi->{Hash} ".
1628 ($downloaded ? "(got wrong file from archive!)"
1629 : "(perhaps you should delete this file?)");
1634 sub ensure_we_have_orig () {
1635 foreach my $fi (dsc_files_info()) {
1636 my $f = $fi->{Filename};
1637 next unless is_orig_file($f);
1638 complete_file_from_dsc('..', $fi)
1643 sub git_fetch_us () {
1644 # Want to fetch only what we are going to use, unless
1645 # deliberately-not-ff, in which case we must fetch everything.
1647 my @specs = deliberately_not_fast_forward ? qw(tags/*) :
1648 map { "tags/$_" } debiantags('*',access_basedistro);
1649 push @specs, server_branch($csuite);
1650 push @specs, qw(heads/*) if deliberately_not_fast_forward;
1652 # This is rather miserable:
1653 # When git-fetch --prune is passed a fetchspec ending with a *,
1654 # it does a plausible thing. If there is no * then:
1655 # - it matches subpaths too, even if the supplied refspec
1656 # starts refs, and behaves completely madly if the source
1657 # has refs/refs/something. (See, for example, Debian #NNNN.)
1658 # - if there is no matching remote ref, it bombs out the whole
1660 # We want to fetch a fixed ref, and we don't know in advance
1661 # if it exists, so this is not suitable.
1663 # Our workaround is to use git-ls-remote. git-ls-remote has its
1664 # own qairks. Notably, it has the absurd multi-tail-matching
1665 # behaviour: git-ls-remote R refs/foo can report refs/foo AND
1666 # refs/refs/foo etc.
1668 # Also, we want an idempotent snapshot, but we have to make two
1669 # calls to the remote: one to git-ls-remote and to git-fetch. The
1670 # solution is use git-ls-remote to obtain a target state, and
1671 # git-fetch to try to generate it. If we don't manage to generate
1672 # the target state, we try again.
1674 my $specre = join '|', map {
1680 printdebug "git_fetch_us specre=$specre\n";
1681 my $wanted_rref = sub {
1683 return m/^(?:$specre)$/o;
1686 my $fetch_iteration = 0;
1689 if (++$fetch_iteration > 10) {
1690 fail "too many iterations trying to get sane fetch!";
1693 my @look = map { "refs/$_" } @specs;
1694 my @lcmd = (@git, qw(ls-remote -q --refs), access_giturl(), @look);
1698 open GITLS, "-|", @lcmd or die $!;
1700 printdebug "=> ", $_;
1701 m/^(\w+)\s+(\S+)\n/ or die "ls-remote $_ ?";
1702 my ($objid,$rrefname) = ($1,$2);
1703 if (!$wanted_rref->($rrefname)) {
1705 warning: git-ls-remote @look reported $rrefname; this is silly, ignoring it.
1709 $wantr{$rrefname} = $objid;
1712 close GITLS or failedcmd @lcmd;
1714 # OK, now %want is exactly what we want for refs in @specs
1716 return () if !m/\*$/ && !exists $wantr{"refs/$_"};
1717 "+refs/$_:".lrfetchrefs."/$_";
1720 my @fcmd = (@git, qw(fetch -p -n -q), access_giturl(), @fspecs);
1721 runcmd_ordryrun_local @git, qw(fetch -p -n -q), access_giturl(),
1724 %lrfetchrefs_f = ();
1727 git_for_each_ref(lrfetchrefs, sub {
1728 my ($objid,$objtype,$lrefname,$reftail) = @_;
1729 $lrfetchrefs_f{$lrefname} = $objid;
1730 $objgot{$objid} = 1;
1733 foreach my $lrefname (sort keys %lrfetchrefs_f) {
1734 my $rrefname = 'refs'.substr($lrefname, length lrfetchrefs);
1735 if (!exists $wantr{$rrefname}) {
1736 if ($wanted_rref->($rrefname)) {
1738 git-fetch @fspecs created $lrefname which git-ls-remote @look didn't list.
1742 warning: git-fetch @fspecs created $lrefname; this is silly, deleting it.
1745 runcmd_ordryrun_local @git, qw(update-ref -d), $lrefname;
1746 delete $lrfetchrefs_f{$lrefname};
1750 foreach my $rrefname (sort keys %wantr) {
1751 my $lrefname = lrfetchrefs.substr($rrefname, 4);
1752 my $got = $lrfetchrefs_f{$lrefname} // '<none>';
1753 my $want = $wantr{$rrefname};
1754 next if $got eq $want;
1755 if (!defined $objgot{$want}) {
1757 warning: git-ls-remote suggests we want $lrefname
1758 warning: and it should refer to $want
1759 warning: but git-fetch didn't fetch that object to any relevant ref.
1760 warning: This may be due to a race with someone updating the server.
1761 warning: Will try again...
1763 next FETCH_ITERATION;
1766 git-fetch @fspecs made $lrefname=$got but want git-ls-remote @look says $want
1768 runcmd_ordryrun_local @git, qw(update-ref -m),
1769 "dgit fetch git-fetch fixup", $lrefname, $want;
1770 $lrfetchrefs_f{$lrefname} = $want;
1774 printdebug "git_fetch_us: git-fetch --no-insane emulation complete\n",
1775 Dumper(\%lrfetchrefs_f);
1778 my @tagpats = debiantags('*',access_basedistro);
1780 git_for_each_ref([map { "refs/tags/$_" } @tagpats], sub {
1781 my ($objid,$objtype,$fullrefname,$reftail) = @_;
1782 printdebug "currently $fullrefname=$objid\n";
1783 $here{$fullrefname} = $objid;
1785 git_for_each_ref([map { lrfetchrefs."/tags/".$_ } @tagpats], sub {
1786 my ($objid,$objtype,$fullrefname,$reftail) = @_;
1787 my $lref = "refs".substr($fullrefname, length(lrfetchrefs));
1788 printdebug "offered $lref=$objid\n";
1789 if (!defined $here{$lref}) {
1790 my @upd = (@git, qw(update-ref), $lref, $objid, '');
1791 runcmd_ordryrun_local @upd;
1792 lrfetchref_used $fullrefname;
1793 } elsif ($here{$lref} eq $objid) {
1794 lrfetchref_used $fullrefname;
1797 "Not updateting $lref from $here{$lref} to $objid.\n";
1802 sub mergeinfo_getclogp ($) {
1803 # Ensures thit $mi->{Clogp} exists and returns it
1805 $mi->{Clogp} = commit_getclogp($mi->{Commit});
1808 sub mergeinfo_version ($) {
1809 return getfield( (mergeinfo_getclogp $_[0]), 'Version' );
1812 sub fetch_from_archive () {
1813 # Ensures that lrref() is what is actually in the archive, one way
1814 # or another, according to us - ie this client's
1815 # appropritaely-updated archive view. Also returns the commit id.
1816 # If there is nothing in the archive, leaves lrref alone and
1817 # returns undef. git_fetch_us must have already been called.
1821 foreach my $field (@ourdscfield) {
1822 $dsc_hash = $dsc->{$field};
1823 last if defined $dsc_hash;
1825 if (defined $dsc_hash) {
1826 $dsc_hash =~ m/\w+/ or fail "invalid hash in .dsc \`$dsc_hash'";
1828 progress "last upload to archive specified git hash";
1830 progress "last upload to archive has NO git hash";
1833 progress "no version available from the archive";
1836 # If the archive's .dsc has a Dgit field, there are three
1837 # relevant git commitids we need to choose between and/or merge
1839 # 1. $dsc_hash: the Dgit field from the archive
1840 # 2. $lastpush_hash: the suite branch on the dgit git server
1841 # 3. $lastfetch_hash: our local tracking brach for the suite
1843 # These may all be distinct and need not be in any fast forward
1846 # If the dsc was pushed to this suite, then the server suite
1847 # branch will have been updated; but it might have been pushed to
1848 # a different suite and copied by the archive. Conversely a more
1849 # recent version may have been pushed with dgit but not appeared
1850 # in the archive (yet).
1852 # $lastfetch_hash may be awkward because archive imports
1853 # (particularly, imports of Dgit-less .dscs) are performed only as
1854 # needed on individual clients, so different clients may perform a
1855 # different subset of them - and these imports are only made
1856 # public during push. So $lastfetch_hash may represent a set of
1857 # imports different to a subsequent upload by a different dgit
1860 # Our approach is as follows:
1862 # As between $dsc_hash and $lastpush_hash: if $lastpush_hash is a
1863 # descendant of $dsc_hash, then it was pushed by a dgit user who
1864 # had based their work on $dsc_hash, so we should prefer it.
1865 # Otherwise, $dsc_hash was installed into this suite in the
1866 # archive other than by a dgit push, and (necessarily) after the
1867 # last dgit push into that suite (since a dgit push would have
1868 # been descended from the dgit server git branch); thus, in that
1869 # case, we prefer the archive's version (and produce a
1870 # pseudo-merge to overwrite the dgit server git branch).
1872 # (If there is no Dgit field in the archive's .dsc then
1873 # generate_commit_from_dsc uses the version numbers to decide
1874 # whether the suite branch or the archive is newer. If the suite
1875 # branch is newer it ignores the archive's .dsc; otherwise it
1876 # generates an import of the .dsc, and produces a pseudo-merge to
1877 # overwrite the suite branch with the archive contents.)
1879 # The outcome of that part of the algorithm is the `public view',
1880 # and is same for all dgit clients: it does not depend on any
1881 # unpublished history in the local tracking branch.
1883 # As between the public view and the local tracking branch: The
1884 # local tracking branch is only updated by dgit fetch, and
1885 # whenever dgit fetch runs it includes the public view in the
1886 # local tracking branch. Therefore if the public view is not
1887 # descended from the local tracking branch, the local tracking
1888 # branch must contain history which was imported from the archive
1889 # but never pushed; and, its tip is now out of date. So, we make
1890 # a pseudo-merge to overwrite the old imports and stitch the old
1893 # Finally: we do not necessarily reify the public view (as
1894 # described above). This is so that we do not end up stacking two
1895 # pseudo-merges. So what we actually do is figure out the inputs
1896 # to any public view psuedo-merge and put them in @mergeinputs.
1899 # $mergeinputs[]{Commit}
1900 # $mergeinputs[]{Info}
1901 # $mergeinputs[0] is the one whose tree we use
1902 # @mergeinputs is in the order we use in the actual commit)
1905 # $mergeinputs[]{Message} is a commit message to use
1906 # $mergeinputs[]{ReverseParents} if def specifies that parent
1907 # list should be in opposite order
1908 # Such an entry has no Commit or Info. It applies only when found
1909 # in the last entry. (This ugliness is to support making
1910 # identical imports to previous dgit versions.)
1912 my $lastpush_hash = git_get_ref(lrfetchref());
1913 printdebug "previous reference hash=$lastpush_hash\n";
1914 $lastpush_mergeinput = $lastpush_hash && {
1915 Commit => $lastpush_hash,
1916 Info => "dgit suite branch on dgit git server",
1919 my $lastfetch_hash = git_get_ref(lrref());
1920 printdebug "fetch_from_archive: lastfetch=$lastfetch_hash\n";
1921 my $lastfetch_mergeinput = $lastfetch_hash && {
1922 Commit => $lastfetch_hash,
1923 Info => "dgit client's archive history view",
1926 my $dsc_mergeinput = $dsc_hash && {
1927 Commit => $dsc_hash,
1928 Info => "Dgit field in .dsc from archive",
1932 my $del_lrfetchrefs = sub {
1935 printdebug "del_lrfetchrefs...\n";
1936 foreach my $fullrefname (sort keys %lrfetchrefs_d) {
1937 my $objid = $lrfetchrefs_d{$fullrefname};
1938 printdebug "del_lrfetchrefs: $objid $fullrefname\n";
1940 $gur ||= new IO::Handle;
1941 open $gur, "|-", qw(git update-ref --stdin) or die $!;
1943 printf $gur "delete %s %s\n", $fullrefname, $objid;
1946 close $gur or failedcmd "git update-ref delete lrfetchrefs";
1950 if (defined $dsc_hash) {
1951 fail "missing remote git history even though dsc has hash -".
1952 " could not find ref ".rref()." at ".access_giturl()
1953 unless $lastpush_hash;
1954 ensure_we_have_orig();
1955 if ($dsc_hash eq $lastpush_hash) {
1956 @mergeinputs = $dsc_mergeinput
1957 } elsif (is_fast_fwd($dsc_hash,$lastpush_hash)) {
1958 print STDERR <<END or die $!;
1960 Git commit in archive is behind the last version allegedly pushed/uploaded.
1961 Commit referred to by archive: $dsc_hash
1962 Last version pushed with dgit: $lastpush_hash
1965 @mergeinputs = ($lastpush_mergeinput);
1967 # Archive has .dsc which is not a descendant of the last dgit
1968 # push. This can happen if the archive moves .dscs about.
1969 # Just follow its lead.
1970 if (is_fast_fwd($lastpush_hash,$dsc_hash)) {
1971 progress "archive .dsc names newer git commit";
1972 @mergeinputs = ($dsc_mergeinput);
1974 progress "archive .dsc names other git commit, fixing up";
1975 @mergeinputs = ($dsc_mergeinput, $lastpush_mergeinput);
1979 @mergeinputs = generate_commits_from_dsc();
1980 # We have just done an import. Now, our import algorithm might
1981 # have been improved. But even so we do not want to generate
1982 # a new different import of the same package. So if the
1983 # version numbers are the same, just use our existing version.
1984 # If the version numbers are different, the archive has changed
1985 # (perhaps, rewound).
1986 if ($lastfetch_mergeinput &&
1987 !version_compare( (mergeinfo_version $lastfetch_mergeinput),
1988 (mergeinfo_version $mergeinputs[0]) )) {
1989 @mergeinputs = ($lastfetch_mergeinput);
1991 } elsif ($lastpush_hash) {
1992 # only in git, not in the archive yet
1993 @mergeinputs = ($lastpush_mergeinput);
1994 print STDERR <<END or die $!;
1996 Package not found in the archive, but has allegedly been pushed using dgit.
2000 printdebug "nothing found!\n";
2001 if (defined $skew_warning_vsn) {
2002 print STDERR <<END or die $!;
2004 Warning: relevant archive skew detected.
2005 Archive allegedly contains $skew_warning_vsn
2006 But we were not able to obtain any version from the archive or git.
2010 unshift @end, $del_lrfetchrefs;
2014 if ($lastfetch_hash &&
2016 my $h = $_->{Commit};
2017 $h and is_fast_fwd($lastfetch_hash, $h);
2018 # If true, one of the existing parents of this commit
2019 # is a descendant of the $lastfetch_hash, so we'll
2020 # be ff from that automatically.
2024 push @mergeinputs, $lastfetch_mergeinput;
2027 printdebug "fetch mergeinfos:\n";
2028 foreach my $mi (@mergeinputs) {
2030 printdebug " commit $mi->{Commit} $mi->{Info}\n";
2032 printdebug sprintf " ReverseParents=%d Message=%s",
2033 $mi->{ReverseParents}, $mi->{Message};
2037 my $compat_info= pop @mergeinputs
2038 if $mergeinputs[$#mergeinputs]{Message};
2040 @mergeinputs = grep { defined $_->{Commit} } @mergeinputs;
2043 if (@mergeinputs > 1) {
2045 my $tree_commit = $mergeinputs[0]{Commit};
2047 my $tree = cmdoutput @git, qw(cat-file commit), $tree_commit;
2048 $tree =~ m/\n\n/; $tree = $`;
2049 $tree =~ m/^tree (\w+)$/m or die "$dsc_hash tree ?";
2052 # We use the changelog author of the package in question the
2053 # author of this pseudo-merge. This is (roughly) correct if
2054 # this commit is simply representing aa non-dgit upload.
2055 # (Roughly because it does not record sponsorship - but we
2056 # don't have sponsorship info because that's in the .changes,
2057 # which isn't in the archivw.)
2059 # But, it might be that we are representing archive history
2060 # updates (including in-archive copies). These are not really
2061 # the responsibility of the person who created the .dsc, but
2062 # there is no-one whose name we should better use. (The
2063 # author of the .dsc-named commit is clearly worse.)
2065 my $useclogp = mergeinfo_getclogp $mergeinputs[0];
2066 my $author = clogp_authline $useclogp;
2067 my $cversion = getfield $useclogp, 'Version';
2069 my $mcf = ".git/dgit/mergecommit";
2070 open MC, ">", $mcf or die "$mcf $!";
2071 print MC <<END or die $!;
2075 my @parents = grep { $_->{Commit} } @mergeinputs;
2076 @parents = reverse @parents if $compat_info->{ReverseParents};
2077 print MC <<END or die $! foreach @parents;
2081 print MC <<END or die $!;
2087 if (defined $compat_info->{Message}) {
2088 print MC $compat_info->{Message} or die $!;
2090 print MC <<END or die $!;
2091 Record $package ($cversion) in archive suite $csuite
2095 my $message_add_info = sub {
2097 my $mversion = mergeinfo_version $mi;
2098 printf MC " %-20s %s\n", $mversion, $mi->{Info}
2102 $message_add_info->($mergeinputs[0]);
2103 print MC <<END or die $!;
2104 should be treated as descended from
2106 $message_add_info->($_) foreach @mergeinputs[1..$#mergeinputs];
2110 $hash = make_commit $mcf;
2112 $hash = $mergeinputs[0]{Commit};
2114 progress "fetch hash=$hash\n";
2117 my ($lasth, $what) = @_;
2118 return unless $lasth;
2119 die "$lasth $hash $what ?" unless is_fast_fwd($lasth, $hash);
2122 $chkff->($lastpush_hash, 'dgit repo server tip (last push)');
2123 $chkff->($lastfetch_hash, 'local tracking tip (last fetch)');
2125 runcmd @git, qw(update-ref -m), "dgit fetch $csuite",
2126 'DGIT_ARCHIVE', $hash;
2127 cmdoutput @git, qw(log -n2), $hash;
2128 # ... gives git a chance to complain if our commit is malformed
2130 if (defined $skew_warning_vsn) {
2132 printdebug "SKEW CHECK WANT $skew_warning_vsn\n";
2133 my $clogf = ".git/dgit/changelog.tmp";
2134 runcmd shell_cmd "exec >$clogf",
2135 @git, qw(cat-file blob), "$hash:debian/changelog";
2136 my $gotclogp = parsechangelog("-l$clogf");
2137 my $got_vsn = getfield $gotclogp, 'Version';
2138 printdebug "SKEW CHECK GOT $got_vsn\n";
2139 if (version_compare($got_vsn, $skew_warning_vsn) < 0) {
2140 print STDERR <<END or die $!;
2142 Warning: archive skew detected. Using the available version:
2143 Archive allegedly contains $skew_warning_vsn
2144 We were able to obtain only $got_vsn
2150 if ($lastfetch_hash ne $hash) {
2151 my @upd_cmd = (@git, qw(update-ref -m), 'dgit fetch', lrref(), $hash);
2155 dryrun_report @upd_cmd;
2159 lrfetchref_used lrfetchref();
2161 unshift @end, $del_lrfetchrefs;
2165 sub set_local_git_config ($$) {
2167 runcmd @git, qw(config), $k, $v;
2170 sub setup_mergechangelogs (;$) {
2172 return unless $always || access_cfg_bool(1, 'setup-mergechangelogs');
2174 my $driver = 'dpkg-mergechangelogs';
2175 my $cb = "merge.$driver";
2176 my $attrs = '.git/info/attributes';
2177 ensuredir '.git/info';
2179 open NATTRS, ">", "$attrs.new" or die "$attrs.new $!";
2180 if (!open ATTRS, "<", $attrs) {
2181 $!==ENOENT or die "$attrs: $!";
2185 next if m{^debian/changelog\s};
2186 print NATTRS $_, "\n" or die $!;
2188 ATTRS->error and die $!;
2191 print NATTRS "debian/changelog merge=$driver\n" or die $!;
2194 set_local_git_config "$cb.name", 'debian/changelog merge driver';
2195 set_local_git_config "$cb.driver", 'dpkg-mergechangelogs -m %O %A %B %A';
2197 rename "$attrs.new", "$attrs" or die "$attrs: $!";
2200 sub setup_useremail (;$) {
2202 return unless $always || access_cfg_bool(1, 'setup-useremail');
2205 my ($k, $envvar) = @_;
2206 my $v = access_cfg("user-$k", 'RETURN-UNDEF') // $ENV{$envvar};
2207 return unless defined $v;
2208 set_local_git_config "user.$k", $v;
2211 $setup->('email', 'DEBEMAIL');
2212 $setup->('name', 'DEBFULLNAME');
2215 sub setup_new_tree () {
2216 setup_mergechangelogs();
2222 canonicalise_suite();
2223 badusage "dry run makes no sense with clone" unless act_local();
2224 my $hasgit = check_for_git();
2225 mkdir $dstdir or fail "create \`$dstdir': $!";
2227 runcmd @git, qw(init -q);
2228 my $giturl = access_giturl(1);
2229 if (defined $giturl) {
2230 open H, "> .git/HEAD" or die $!;
2231 print H "ref: ".lref()."\n" or die $!;
2233 runcmd @git, qw(remote add), 'origin', $giturl;
2236 progress "fetching existing git history";
2238 runcmd_ordryrun_local @git, qw(fetch origin);
2240 progress "starting new git history";
2242 fetch_from_archive() or no_such_package;
2243 my $vcsgiturl = $dsc->{'Vcs-Git'};
2244 if (length $vcsgiturl) {
2245 $vcsgiturl =~ s/\s+-b\s+\S+//g;
2246 runcmd @git, qw(remote add vcs-git), $vcsgiturl;
2249 runcmd @git, qw(reset --hard), lrref();
2250 printdone "ready for work in $dstdir";
2254 if (check_for_git()) {
2257 fetch_from_archive() or no_such_package();
2258 printdone "fetched into ".lrref();
2263 runcmd_ordryrun_local @git, qw(merge -m),"Merge from $csuite [dgit]",
2265 printdone "fetched to ".lrref()." and merged into HEAD";
2268 sub check_not_dirty () {
2269 foreach my $f (qw(local-options local-patch-header)) {
2270 if (stat_exists "debian/source/$f") {
2271 fail "git tree contains debian/source/$f";
2275 return if $ignoredirty;
2277 my @cmd = (@git, qw(diff --quiet HEAD));
2279 $!=0; $?=-1; system @cmd;
2282 fail "working tree is dirty (does not match HEAD)";
2288 sub commit_admin ($) {
2291 runcmd_ordryrun_local @git, qw(commit -m), $m;
2294 sub commit_quilty_patch () {
2295 my $output = cmdoutput @git, qw(status --porcelain);
2297 foreach my $l (split /\n/, $output) {
2298 next unless $l =~ m/\S/;
2299 if ($l =~ m{^(?:\?\?| M) (.pc|debian/patches)}) {
2303 delete $adds{'.pc'}; # if there wasn't one before, don't add it
2305 progress "nothing quilty to commit, ok.";
2308 my @adds = map { s/[][*?\\]/\\$&/g; $_; } sort keys %adds;
2309 runcmd_ordryrun_local @git, qw(add -f), @adds;
2310 commit_admin "Commit Debian 3.0 (quilt) metadata";
2313 sub get_source_format () {
2315 if (open F, "debian/source/options") {
2319 s/\s+$//; # ignore missing final newline
2321 my ($k, $v) = ($`, $'); #');
2322 $v =~ s/^"(.*)"$/$1/;
2328 F->error and die $!;
2331 die $! unless $!==&ENOENT;
2334 if (!open F, "debian/source/format") {
2335 die $! unless $!==&ENOENT;
2339 F->error and die $!;
2341 return ($_, \%options);
2346 return 0 unless $format eq '3.0 (quilt)';
2347 our $quilt_mode_warned;
2348 if ($quilt_mode eq 'nocheck') {
2349 progress "Not doing any fixup of \`$format' due to".
2350 " ----no-quilt-fixup or --quilt=nocheck"
2351 unless $quilt_mode_warned++;
2354 progress "Format \`$format', need to check/update patch stack"
2355 unless $quilt_mode_warned++;
2359 sub push_parse_changelog ($) {
2362 my $clogp = Dpkg::Control::Hash->new();
2363 $clogp->load($clogpfn) or die;
2365 $package = getfield $clogp, 'Source';
2366 my $cversion = getfield $clogp, 'Version';
2367 my $tag = debiantag($cversion, access_basedistro);
2368 runcmd @git, qw(check-ref-format), $tag;
2370 my $dscfn = dscfn($cversion);
2372 return ($clogp, $cversion, $dscfn);
2375 sub push_parse_dsc ($$$) {
2376 my ($dscfn,$dscfnwhat, $cversion) = @_;
2377 $dsc = parsecontrol($dscfn,$dscfnwhat);
2378 my $dversion = getfield $dsc, 'Version';
2379 my $dscpackage = getfield $dsc, 'Source';
2380 ($dscpackage eq $package && $dversion eq $cversion) or
2381 fail "$dscfn is for $dscpackage $dversion".
2382 " but debian/changelog is for $package $cversion";
2385 sub push_tagwants ($$$$) {
2386 my ($cversion, $dgithead, $maintviewhead, $tfbase) = @_;
2389 TagFn => \&debiantag,
2394 if (defined $maintviewhead) {
2396 TagFn => \&debiantag_maintview,
2397 Objid => $maintviewhead,
2398 TfSuffix => '-maintview',
2402 foreach my $tw (@tagwants) {
2403 $tw->{Tag} = $tw->{TagFn}($cversion, access_basedistro);
2404 $tw->{Tfn} = sub { $tfbase.$tw->{TfSuffix}.$_[0]; };
2409 sub push_mktags ($$ $$ $) {
2411 $changesfile,$changesfilewhat,
2414 die unless $tagwants->[0]{View} eq 'dgit';
2416 $dsc->{$ourdscfield[0]} = $tagwants->[0]{Objid};
2417 $dsc->save("$dscfn.tmp") or die $!;
2419 my $changes = parsecontrol($changesfile,$changesfilewhat);
2420 foreach my $field (qw(Source Distribution Version)) {
2421 $changes->{$field} eq $clogp->{$field} or
2422 fail "changes field $field \`$changes->{$field}'".
2423 " does not match changelog \`$clogp->{$field}'";
2426 my $cversion = getfield $clogp, 'Version';
2427 my $clogsuite = getfield $clogp, 'Distribution';
2429 # We make the git tag by hand because (a) that makes it easier
2430 # to control the "tagger" (b) we can do remote signing
2431 my $authline = clogp_authline $clogp;
2432 my $delibs = join(" ", "",@deliberatelies);
2433 my $declaredistro = access_basedistro();
2437 my $tfn = $tw->{Tfn};
2438 my $head = $tw->{Objid};
2439 my $tag = $tw->{Tag};
2441 open TO, '>', $tfn->('.tmp') or die $!;
2442 print TO <<END or die $!;
2449 if ($tw->{View} eq 'dgit') {
2450 print TO <<END or die $!;
2451 $package release $cversion for $clogsuite ($csuite) [dgit]
2452 [dgit distro=$declaredistro$delibs]
2454 foreach my $ref (sort keys %previously) {
2455 print TO <<END or die $!;
2456 [dgit previously:$ref=$previously{$ref}]
2459 } elsif ($tw->{View} eq 'maint') {
2460 print TO <<END or die $!;
2461 $package release $cversion for $clogsuite ($csuite)
2462 (maintainer view tag generated by dgit --quilt=$quilt_mode)
2465 die Dumper($tw)."?";
2470 my $tagobjfn = $tfn->('.tmp');
2472 if (!defined $keyid) {
2473 $keyid = access_cfg('keyid','RETURN-UNDEF');
2475 if (!defined $keyid) {
2476 $keyid = getfield $clogp, 'Maintainer';
2478 unlink $tfn->('.tmp.asc') or $!==&ENOENT or die $!;
2479 my @sign_cmd = (@gpg, qw(--detach-sign --armor));
2480 push @sign_cmd, qw(-u),$keyid if defined $keyid;
2481 push @sign_cmd, $tfn->('.tmp');
2482 runcmd_ordryrun @sign_cmd;
2484 $tagobjfn = $tfn->('.signed.tmp');
2485 runcmd shell_cmd "exec >$tagobjfn", qw(cat --),
2486 $tfn->('.tmp'), $tfn->('.tmp.asc');
2492 my @r = map { $mktag->($_); } @$tagwants;
2496 sub sign_changes ($) {
2497 my ($changesfile) = @_;
2499 my @debsign_cmd = @debsign;
2500 push @debsign_cmd, "-k$keyid" if defined $keyid;
2501 push @debsign_cmd, "-p$gpg[0]" if $gpg[0] ne 'gpg';
2502 push @debsign_cmd, $changesfile;
2503 runcmd_ordryrun @debsign_cmd;
2508 printdebug "actually entering push\n";
2510 supplementary_message(<<'END');
2511 Push failed, while checking state of the archive.
2512 You can retry the push, after fixing the problem, if you like.
2514 if (check_for_git()) {
2517 my $archive_hash = fetch_from_archive();
2518 if (!$archive_hash) {
2520 fail "package appears to be new in this suite;".
2521 " if this is intentional, use --new";
2524 supplementary_message(<<'END');
2525 Push failed, while preparing your push.
2526 You can retry the push, after fixing the problem, if you like.
2529 need_tagformat 'new', "quilt mode $quilt_mode"
2530 if quiltmode_splitbrain;
2534 access_giturl(); # check that success is vaguely likely
2537 my $clogpfn = ".git/dgit/changelog.822.tmp";
2538 runcmd shell_cmd "exec >$clogpfn", qw(dpkg-parsechangelog);
2540 responder_send_file('parsed-changelog', $clogpfn);
2542 my ($clogp, $cversion, $dscfn) =
2543 push_parse_changelog("$clogpfn");
2545 my $dscpath = "$buildproductsdir/$dscfn";
2546 stat_exists $dscpath or
2547 fail "looked for .dsc $dscfn, but $!;".
2548 " maybe you forgot to build";
2550 responder_send_file('dsc', $dscpath);
2552 push_parse_dsc($dscpath, $dscfn, $cversion);
2554 my $format = getfield $dsc, 'Format';
2555 printdebug "format $format\n";
2557 my $actualhead = git_rev_parse('HEAD');
2558 my $dgithead = $actualhead;
2559 my $maintviewhead = undef;
2561 if (madformat($format)) {
2562 # user might have not used dgit build, so maybe do this now:
2563 if (quiltmode_splitbrain()) {
2564 my $upstreamversion = $clogp->{Version};
2565 $upstreamversion =~ s/-[^-]*$//;
2567 quilt_make_fake_dsc($upstreamversion);
2568 my ($dgitview, $cachekey) =
2569 quilt_check_splitbrain_cache($actualhead, $upstreamversion);
2571 "--quilt=$quilt_mode but no cached dgit view:
2572 perhaps tree changed since dgit build[-source] ?";
2574 $dgithead = $dgitview;
2575 $maintviewhead = $actualhead;
2576 changedir '../../../..';
2577 prep_ud(); # so _only_subdir() works, below
2579 commit_quilty_patch();
2586 if ($archive_hash) {
2587 if (is_fast_fwd($archive_hash, $dgithead)) {
2589 } elsif (deliberately_not_fast_forward) {
2592 fail "dgit push: HEAD is not a descendant".
2593 " of the archive's version.\n".
2594 "dgit: To overwrite its contents,".
2595 " use git merge -s ours ".lrref().".\n".
2596 "dgit: To rewind history, if permitted by the archive,".
2597 " use --deliberately-not-fast-forward";
2602 progress "checking that $dscfn corresponds to HEAD";
2603 runcmd qw(dpkg-source -x --),
2604 $dscpath =~ m#^/# ? $dscpath : "../../../$dscpath";
2605 my ($tree,$dir) = mktree_in_ud_from_only_subdir();
2606 check_for_vendor_patches() if madformat($dsc->{format});
2607 changedir '../../../..';
2608 my $diffopt = $debuglevel>0 ? '--exit-code' : '--quiet';
2609 my @diffcmd = (@git, qw(diff), $diffopt, $tree, $dgithead);
2610 debugcmd "+",@diffcmd;
2612 my $r = system @diffcmd;
2615 fail "$dscfn specifies a different tree to your HEAD commit;".
2616 " perhaps you forgot to build".
2617 ($diffopt eq '--exit-code' ? "" :
2618 " (run with -D to see full diff output)");
2623 if (!$changesfile) {
2624 my $pat = changespat $cversion;
2625 my @cs = glob "$buildproductsdir/$pat";
2626 fail "failed to find unique changes file".
2627 " (looked for $pat in $buildproductsdir);".
2628 " perhaps you need to use dgit -C"
2630 ($changesfile) = @cs;
2632 $changesfile = "$buildproductsdir/$changesfile";
2635 # Checks complete, we're going to try and go ahead:
2637 responder_send_file('changes',$changesfile);
2638 responder_send_command("param head $dgithead");
2639 responder_send_command("param csuite $csuite");
2640 responder_send_command("param tagformat $tagformat");
2641 if (quiltmode_splitbrain) {
2642 die unless ($protovsn//4) >= 4;
2643 responder_send_command("param maint-view $maintviewhead");
2646 if (deliberately_not_fast_forward) {
2647 git_for_each_ref(lrfetchrefs, sub {
2648 my ($objid,$objtype,$lrfetchrefname,$reftail) = @_;
2649 my $rrefname= substr($lrfetchrefname, length(lrfetchrefs) + 1);
2650 responder_send_command("previously $rrefname=$objid");
2651 $previously{$rrefname} = $objid;
2655 my @tagwants = push_tagwants($cversion, $dgithead, $maintviewhead,
2659 supplementary_message(<<'END');
2660 Push failed, while signing the tag.
2661 You can retry the push, after fixing the problem, if you like.
2663 # If we manage to sign but fail to record it anywhere, it's fine.
2664 if ($we_are_responder) {
2665 @tagobjfns = map { $_->{Tfn}('.signed-tmp') } @tagwants;
2666 responder_receive_files('signed-tag', @tagobjfns);
2668 @tagobjfns = push_mktags($clogp,$dscpath,
2669 $changesfile,$changesfile,
2672 supplementary_message(<<'END');
2673 Push failed, *after* signing the tag.
2674 If you want to try again, you should use a new version number.
2677 pairwise { $a->{TagObjFn} = $b } @tagwants, @tagobjfns;
2679 foreach my $tw (@tagwants) {
2680 my $tag = $tw->{Tag};
2681 my $tagobjfn = $tw->{TagObjFn};
2683 cmdoutput @git, qw(hash-object -w -t tag), $tagobjfn;
2684 runcmd_ordryrun @git, qw(verify-tag), $tag_obj_hash;
2685 runcmd_ordryrun_local
2686 @git, qw(update-ref), "refs/tags/$tag", $tag_obj_hash;
2689 supplementary_message(<<'END');
2690 Push failed, while updating the remote git repository - see messages above.
2691 If you want to try again, you should use a new version number.
2693 if (!check_for_git()) {
2694 create_remote_git_repo();
2697 my @pushrefs = $forceflag.$dgithead.":".rrref();
2698 foreach my $tw (@tagwants) {
2699 my $view = $tw->{View};
2700 next unless $view eq 'dgit'
2701 or any { $_ eq $view } access_cfg_tagformats();
2702 # ^ $view is "dgit" or "maint" so this looks for "maint"
2703 # in archive supported tagformats.
2704 push @pushrefs, $forceflag."refs/tags/$tw->{Tag}";
2707 runcmd_ordryrun @git, qw(push),access_giturl(), @pushrefs;
2708 runcmd_ordryrun @git, qw(update-ref -m), 'dgit push', lrref(), $dgithead;
2710 supplementary_message(<<'END');
2711 Push failed, after updating the remote git repository.
2712 If you want to try again, you must use a new version number.
2714 if ($we_are_responder) {
2715 my $dryrunsuffix = act_local() ? "" : ".tmp";
2716 responder_receive_files('signed-dsc-changes',
2717 "$dscpath$dryrunsuffix",
2718 "$changesfile$dryrunsuffix");
2721 rename "$dscpath.tmp",$dscpath or die "$dscfn $!";
2723 progress "[new .dsc left in $dscpath.tmp]";
2725 sign_changes $changesfile;
2728 supplementary_message(<<END);
2729 Push failed, while uploading package(s) to the archive server.
2730 You can retry the upload of exactly these same files with dput of:
2732 If that .changes file is broken, you will need to use a new version
2733 number for your next attempt at the upload.
2735 my $host = access_cfg('upload-host','RETURN-UNDEF');
2736 my @hostarg = defined($host) ? ($host,) : ();
2737 runcmd_ordryrun @dput, @hostarg, $changesfile;
2738 printdone "pushed and uploaded $cversion";
2740 supplementary_message('');
2741 responder_send_command("complete");
2748 badusage "-p is not allowed with clone; specify as argument instead"
2749 if defined $package;
2752 } elsif (@ARGV==2 && $ARGV[1] =~ m#^\w#) {
2753 ($package,$isuite) = @ARGV;
2754 } elsif (@ARGV==2 && $ARGV[1] =~ m#^[./]#) {
2755 ($package,$dstdir) = @ARGV;
2756 } elsif (@ARGV==3) {
2757 ($package,$isuite,$dstdir) = @ARGV;
2759 badusage "incorrect arguments to dgit clone";
2761 $dstdir ||= "$package";
2763 if (stat_exists $dstdir) {
2764 fail "$dstdir already exists";
2768 if ($rmonerror && !$dryrun_level) {
2769 $cwd_remove= getcwd();
2771 return unless defined $cwd_remove;
2772 if (!chdir "$cwd_remove") {
2773 return if $!==&ENOENT;
2774 die "chdir $cwd_remove: $!";
2777 rmtree($dstdir) or die "remove $dstdir: $!\n";
2778 } elsif (!grep { $! == $_ }
2779 (ENOENT, ENOTDIR, EACCES, EPERM, ELOOP)) {
2781 print STDERR "check whether to remove $dstdir: $!\n";
2787 $cwd_remove = undef;
2790 sub branchsuite () {
2791 my $branch = cmdoutput_errok @git, qw(symbolic-ref HEAD);
2792 if ($branch =~ m#$lbranch_re#o) {
2799 sub fetchpullargs () {
2801 if (!defined $package) {
2802 my $sourcep = parsecontrol('debian/control','debian/control');
2803 $package = getfield $sourcep, 'Source';
2806 # $isuite = branchsuite(); # this doesn't work because dak hates canons
2808 my $clogp = parsechangelog();
2809 $isuite = getfield $clogp, 'Distribution';
2811 canonicalise_suite();
2812 progress "fetching from suite $csuite";
2813 } elsif (@ARGV==1) {
2815 canonicalise_suite();
2817 badusage "incorrect arguments to dgit fetch or dgit pull";
2836 badusage "-p is not allowed with dgit push" if defined $package;
2838 my $clogp = parsechangelog();
2839 $package = getfield $clogp, 'Source';
2842 } elsif (@ARGV==1) {
2843 ($specsuite) = (@ARGV);
2845 badusage "incorrect arguments to dgit push";
2847 $isuite = getfield $clogp, 'Distribution';
2849 local ($package) = $existing_package; # this is a hack
2850 canonicalise_suite();
2852 canonicalise_suite();
2854 if (defined $specsuite &&
2855 $specsuite ne $isuite &&
2856 $specsuite ne $csuite) {
2857 fail "dgit push: changelog specifies $isuite ($csuite)".
2858 " but command line specifies $specsuite";
2863 #---------- remote commands' implementation ----------
2865 sub cmd_remote_push_build_host {
2866 my ($nrargs) = shift @ARGV;
2867 my (@rargs) = @ARGV[0..$nrargs-1];
2868 @ARGV = @ARGV[$nrargs..$#ARGV];
2870 my ($dir,$vsnwant) = @rargs;
2871 # vsnwant is a comma-separated list; we report which we have
2872 # chosen in our ready response (so other end can tell if they
2875 $we_are_responder = 1;
2876 $us .= " (build host)";
2880 open PI, "<&STDIN" or die $!;
2881 open STDIN, "/dev/null" or die $!;
2882 open PO, ">&STDOUT" or die $!;
2884 open STDOUT, ">&STDERR" or die $!;
2888 ($protovsn) = grep {
2889 $vsnwant =~ m{^(?:.*,)?$_(?:,.*)?$}
2890 } @rpushprotovsn_support;
2892 fail "build host has dgit rpush protocol versions ".
2893 (join ",", @rpushprotovsn_support).
2894 " but invocation host has $vsnwant"
2895 unless defined $protovsn;
2897 responder_send_command("dgit-remote-push-ready $protovsn");
2898 rpush_handle_protovsn_bothends();
2903 sub cmd_remote_push_responder { cmd_remote_push_build_host(); }
2904 # ... for compatibility with proto vsn.1 dgit (just so that user gets
2905 # a good error message)
2907 sub rpush_handle_protovsn_bothends () {
2908 if ($protovsn < 4) {
2909 need_tagformat 'old', "rpush negotiated protocol $protovsn";
2918 my $report = i_child_report();
2919 if (defined $report) {
2920 printdebug "($report)\n";
2921 } elsif ($i_child_pid) {
2922 printdebug "(killing build host child $i_child_pid)\n";
2923 kill 15, $i_child_pid;
2925 if (defined $i_tmp && !defined $initiator_tempdir) {
2927 eval { rmtree $i_tmp; };
2931 END { i_cleanup(); }
2934 my ($base,$selector,@args) = @_;
2935 $selector =~ s/\-/_/g;
2936 { no strict qw(refs); &{"${base}_${selector}"}(@args); }
2943 if ($host =~ m/^((?:[^][]|\[[^][]*\])*)\:/) {
2951 push @rargs, join ",", @rpushprotovsn_support;
2954 push @rdgit, @ropts;
2955 push @rdgit, qw(remote-push-build-host), (scalar @rargs), @rargs;
2957 my @cmd = (@ssh, $host, shellquote @rdgit);
2960 if (defined $initiator_tempdir) {
2961 rmtree $initiator_tempdir;
2962 mkdir $initiator_tempdir, 0700 or die "$initiator_tempdir: $!";
2963 $i_tmp = $initiator_tempdir;
2967 $i_child_pid = open2(\*RO, \*RI, @cmd);
2969 ($protovsn) = initiator_expect { m/^dgit-remote-push-ready (\S+)/ };
2970 die "$protovsn ?" unless grep { $_ eq $protovsn } @rpushprotovsn_support;
2971 $supplementary_message = '' unless $protovsn >= 3;
2973 fail "rpush negotiated protocol version $protovsn".
2974 " which does not support quilt mode $quilt_mode"
2975 if quiltmode_splitbrain;
2977 rpush_handle_protovsn_bothends();
2979 my ($icmd,$iargs) = initiator_expect {
2980 m/^(\S+)(?: (.*))?$/;
2983 i_method "i_resp", $icmd, $iargs;
2987 sub i_resp_progress ($) {
2989 my $msg = protocol_read_bytes \*RO, $rhs;
2993 sub i_resp_supplementary_message ($) {
2995 $supplementary_message = protocol_read_bytes \*RO, $rhs;
2998 sub i_resp_complete {
2999 my $pid = $i_child_pid;
3000 $i_child_pid = undef; # prevents killing some other process with same pid
3001 printdebug "waiting for build host child $pid...\n";
3002 my $got = waitpid $pid, 0;
3003 die $! unless $got == $pid;
3004 die "build host child failed $?" if $?;
3007 printdebug "all done\n";
3011 sub i_resp_file ($) {
3013 my $localname = i_method "i_localname", $keyword;
3014 my $localpath = "$i_tmp/$localname";
3015 stat_exists $localpath and
3016 badproto \*RO, "file $keyword ($localpath) twice";
3017 protocol_receive_file \*RO, $localpath;
3018 i_method "i_file", $keyword;
3023 sub i_resp_param ($) {
3024 $_[0] =~ m/^(\S+) (.*)$/ or badproto \*RO, "bad param spec";
3028 sub i_resp_previously ($) {
3029 $_[0] =~ m#^(refs/tags/\S+)=(\w+)$#
3030 or badproto \*RO, "bad previously spec";
3031 my $r = system qw(git check-ref-format), $1;
3032 die "bad previously ref spec ($r)" if $r;
3033 $previously{$1} = $2;
3038 sub i_resp_want ($) {
3040 die "$keyword ?" if $i_wanted{$keyword}++;
3041 my @localpaths = i_method "i_want", $keyword;
3042 printdebug "[[ $keyword @localpaths\n";
3043 foreach my $localpath (@localpaths) {
3044 protocol_send_file \*RI, $localpath;
3046 print RI "files-end\n" or die $!;
3049 our ($i_clogp, $i_version, $i_dscfn, $i_changesfn);
3051 sub i_localname_parsed_changelog {
3052 return "remote-changelog.822";
3054 sub i_file_parsed_changelog {
3055 ($i_clogp, $i_version, $i_dscfn) =
3056 push_parse_changelog "$i_tmp/remote-changelog.822";
3057 die if $i_dscfn =~ m#/|^\W#;
3060 sub i_localname_dsc {
3061 defined $i_dscfn or badproto \*RO, "dsc (before parsed-changelog)";
3066 sub i_localname_changes {
3067 defined $i_dscfn or badproto \*RO, "dsc (before parsed-changelog)";
3068 $i_changesfn = $i_dscfn;
3069 $i_changesfn =~ s/\.dsc$/_dgit.changes/ or die;
3070 return $i_changesfn;
3072 sub i_file_changes { }
3074 sub i_want_signed_tag {
3075 printdebug Dumper(\%i_param, $i_dscfn);
3076 defined $i_param{'head'} && defined $i_dscfn && defined $i_clogp
3077 && defined $i_param{'csuite'}
3078 or badproto \*RO, "premature desire for signed-tag";
3079 my $head = $i_param{'head'};
3080 die if $head =~ m/[^0-9a-f]/ || $head !~ m/^../;
3082 my $maintview = $i_param{'maint-view'};
3083 die if defined $maintview && $maintview =~ m/[^0-9a-f]/;
3086 if ($protovsn >= 4) {
3087 my $p = $i_param{'tagformat'} // '<undef>';
3089 or badproto \*RO, "tag format mismatch: $p vs. $tagformat";
3092 die unless $i_param{'csuite'} =~ m/^$suite_re$/;
3094 push_parse_dsc $i_dscfn, 'remote dsc', $i_version;
3096 my @tagwants = push_tagwants $i_version, $head, $maintview, "tag";
3099 push_mktags $i_clogp, $i_dscfn,
3100 $i_changesfn, 'remote changes',
3104 sub i_want_signed_dsc_changes {
3105 rename "$i_dscfn.tmp","$i_dscfn" or die "$i_dscfn $!";
3106 sign_changes $i_changesfn;
3107 return ($i_dscfn, $i_changesfn);
3110 #---------- building etc. ----------
3116 #----- `3.0 (quilt)' handling -----
3118 our $fakeeditorenv = 'DGIT_FAKE_EDITOR_QUILT';
3120 sub quiltify_dpkg_commit ($$$;$) {
3121 my ($patchname,$author,$msg, $xinfo) = @_;
3125 my $descfn = ".git/dgit/quilt-description.tmp";
3126 open O, '>', $descfn or die "$descfn: $!";
3129 $msg =~ s/^\s+$/ ./mg;
3130 print O <<END or die $!;
3140 local $ENV{'EDITOR'} = cmdoutput qw(realpath --), $0;
3141 local $ENV{'VISUAL'} = $ENV{'EDITOR'};
3142 local $ENV{$fakeeditorenv} = cmdoutput qw(realpath --), $descfn;
3143 runcmd @dpkgsource, qw(--commit .), $patchname;
3147 sub quiltify_trees_differ ($$;$$) {
3148 my ($x,$y,$finegrained,$ignorenamesr) = @_;
3149 # returns true iff the two tree objects differ other than in debian/
3150 # with $finegrained,
3151 # returns bitmask 01 - differ in upstream files except .gitignore
3152 # 02 - differ in .gitignore
3153 # if $ignorenamesr is defined, $ingorenamesr->{$fn}
3154 # is set for each modified .gitignore filename $fn
3156 my @cmd = (@git, qw(diff-tree --name-only -z));
3157 push @cmd, qw(-r) if $finegrained;
3159 my $diffs= cmdoutput @cmd;
3161 foreach my $f (split /\0/, $diffs) {
3162 next if $f =~ m#^debian(?:/.*)?$#s;
3163 my $isignore = $f =~ m#^(?:.*/)?.gitignore$#s;
3164 $r |= $isignore ? 02 : 01;
3165 $ignorenamesr->{$f}=1 if $ignorenamesr && $isignore;
3167 printdebug "quiltify_trees_differ $x $y => $r\n";
3171 sub quiltify_tree_sentinelfiles ($) {
3172 # lists the `sentinel' files present in the tree
3174 my $r = cmdoutput @git, qw(ls-tree --name-only), $x,
3175 qw(-- debian/rules debian/control);
3180 sub quiltify_splitbrain_needed () {
3181 if (!$split_brain) {
3182 progress "dgit view: changes are required...";
3183 runcmd @git, qw(checkout -q -b dgit-view);
3188 sub quiltify_splitbrain ($$$$$$) {
3189 my ($clogp, $unapplied, $headref, $diffbits,
3190 $editedignores, $cachekey) = @_;
3191 if ($quilt_mode !~ m/gbp|dpm/) {
3192 # treat .gitignore just like any other upstream file
3193 $diffbits = { %$diffbits };
3194 $_ = !!$_ foreach values %$diffbits;
3196 # We would like any commits we generate to be reproducible
3197 my @authline = clogp_authline($clogp);
3198 local $ENV{GIT_COMMITTER_NAME} = $authline[0];
3199 local $ENV{GIT_COMMITTER_EMAIL} = $authline[1];
3200 local $ENV{GIT_COMMITTER_DATE} = $authline[2];
3202 if ($quilt_mode =~ m/gbp|unapplied/ &&
3203 ($diffbits->{H2O} & 01)) {
3205 "--quilt=$quilt_mode specified, implying patches-unapplied git tree\n".
3206 " but git tree differs from orig in upstream files.";
3207 if (!stat_exists "debian/patches") {
3209 "\n ... debian/patches is missing; perhaps this is a patch queue branch?";
3213 if ($quilt_mode =~ m/gbp|unapplied/ &&
3214 ($diffbits->{O2A} & 01)) { # some patches
3215 quiltify_splitbrain_needed();
3216 progress "dgit view: creating patches-applied version using gbp pq";
3217 runcmd shell_cmd 'exec >/dev/null', @gbp, qw(pq import);
3218 # gbp pq import creates a fresh branch; push back to dgit-view
3219 runcmd @git, qw(update-ref refs/heads/dgit-view HEAD);
3220 runcmd @git, qw(checkout -q dgit-view);
3222 if (($diffbits->{H2O} & 02) && # user has modified .gitignore
3223 !($diffbits->{O2A} & 02)) { # patches do not change .gitignore
3224 quiltify_splitbrain_needed();
3225 progress "dgit view: creating patch to represent .gitignore changes";
3226 ensuredir "debian/patches";
3227 my $gipatch = "debian/patches/auto-gitignore";
3228 open GIPATCH, ">>", "$gipatch" or die "$gipatch: $!";
3229 stat GIPATCH or die "$gipatch: $!";
3230 fail "$gipatch already exists; but want to create it".
3231 " to record .gitignore changes" if (stat _)[7];
3232 print GIPATCH <<END or die "$gipatch: $!";
3233 Subject: Update .gitignore from Debian packaging branch
3235 The Debian packaging git branch contains these updates to the upstream
3236 .gitignore file(s). This patch is autogenerated, to provide these
3237 updates to users of the official Debian archive view of the package.
3239 [dgit version $our_version]
3242 close GIPATCH or die "$gipatch: $!";
3243 runcmd shell_cmd "exec >>$gipatch", @git, qw(diff),
3244 $unapplied, $headref, "--", sort keys %$editedignores;
3245 open SERIES, "+>>", "debian/patches/series" or die $!;
3246 defined seek SERIES, -1, 2 or $!==EINVAL or die $!;
3248 defined read SERIES, $newline, 1 or die $!;
3249 print SERIES "\n" or die $! unless $newline eq "\n";
3250 print SERIES "auto-gitignore\n" or die $!;
3251 close SERIES or die $!;
3252 runcmd @git, qw(add -- debian/patches/series), $gipatch;
3253 commit_admin "Commit patch to update .gitignore";
3256 my $dgitview = git_rev_parse 'refs/heads/dgit-view';
3258 changedir '../../../..';
3259 ensuredir ".git/logs/refs/dgit-intern";
3260 my $makelogfh = new IO::File ".git/logs/refs/$splitbraincache", '>>'
3262 runcmd @git, qw(update-ref -m), $cachekey, "refs/$splitbraincache",
3265 progress "dgit view: created (commit id $dgitview)";
3267 changedir '.git/dgit/unpack/work';
3270 sub quiltify ($$$$) {
3271 my ($clogp,$target,$oldtiptree,$failsuggestion) = @_;
3273 # Quilt patchification algorithm
3275 # We search backwards through the history of the main tree's HEAD
3276 # (T) looking for a start commit S whose tree object is identical
3277 # to to the patch tip tree (ie the tree corresponding to the
3278 # current dpkg-committed patch series). For these purposes
3279 # `identical' disregards anything in debian/ - this wrinkle is
3280 # necessary because dpkg-source treates debian/ specially.
3282 # We can only traverse edges where at most one of the ancestors'
3283 # trees differs (in changes outside in debian/). And we cannot
3284 # handle edges which change .pc/ or debian/patches. To avoid
3285 # going down a rathole we avoid traversing edges which introduce
3286 # debian/rules or debian/control. And we set a limit on the
3287 # number of edges we are willing to look at.
3289 # If we succeed, we walk forwards again. For each traversed edge
3290 # PC (with P parent, C child) (starting with P=S and ending with
3291 # C=T) to we do this:
3293 # - dpkg-source --commit with a patch name and message derived from C
3294 # After traversing PT, we git commit the changes which
3295 # should be contained within debian/patches.
3297 # The search for the path S..T is breadth-first. We maintain a
3298 # todo list containing search nodes. A search node identifies a
3299 # commit, and looks something like this:
3301 # Commit => $git_commit_id,
3302 # Child => $c, # or undef if P=T
3303 # Whynot => $reason_edge_PC_unsuitable, # in @nots only
3304 # Nontrivial => true iff $p..$c has relevant changes
3311 my %considered; # saves being exponential on some weird graphs
3313 my $t_sentinels = quiltify_tree_sentinelfiles $target;
3316 my ($search,$whynot) = @_;
3317 printdebug " search NOT $search->{Commit} $whynot\n";
3318 $search->{Whynot} = $whynot;
3319 push @nots, $search;
3320 no warnings qw(exiting);
3329 my $c = shift @todo;
3330 next if $considered{$c->{Commit}}++;
3332 $not->($c, "maximum search space exceeded") if --$max_work <= 0;
3334 printdebug "quiltify investigate $c->{Commit}\n";
3337 if (!quiltify_trees_differ $c->{Commit}, $oldtiptree) {
3338 printdebug " search finished hooray!\n";
3343 if ($quilt_mode eq 'nofix') {
3344 fail "quilt fixup required but quilt mode is \`nofix'\n".
3345 "HEAD commit $c->{Commit} differs from tree implied by ".
3346 " debian/patches (tree object $oldtiptree)";
3348 if ($quilt_mode eq 'smash') {
3349 printdebug " search quitting smash\n";
3353 my $c_sentinels = quiltify_tree_sentinelfiles $c->{Commit};
3354 $not->($c, "has $c_sentinels not $t_sentinels")
3355 if $c_sentinels ne $t_sentinels;
3357 my $commitdata = cmdoutput @git, qw(cat-file commit), $c->{Commit};
3358 $commitdata =~ m/\n\n/;
3360 my @parents = ($commitdata =~ m/^parent (\w+)$/gm);
3361 @parents = map { { Commit => $_, Child => $c } } @parents;
3363 $not->($c, "root commit") if !@parents;
3365 foreach my $p (@parents) {
3366 $p->{Nontrivial}= quiltify_trees_differ $p->{Commit},$c->{Commit};
3368 my $ndiffers = grep { $_->{Nontrivial} } @parents;
3369 $not->($c, "merge ($ndiffers nontrivial parents)") if $ndiffers > 1;
3371 foreach my $p (@parents) {
3372 printdebug "considering C=$c->{Commit} P=$p->{Commit}\n";
3374 my @cmd= (@git, qw(diff-tree -r --name-only),
3375 $p->{Commit},$c->{Commit}, qw(-- debian/patches .pc));
3376 my $patchstackchange = cmdoutput @cmd;
3377 if (length $patchstackchange) {
3378 $patchstackchange =~ s/\n/,/g;
3379 $not->($p, "changed $patchstackchange");
3382 printdebug " search queue P=$p->{Commit} ",
3383 ($p->{Nontrivial} ? "NT" : "triv"),"\n";
3389 printdebug "quiltify want to smash\n";
3392 my $x = $_[0]{Commit};
3393 $x =~ s/(.*?[0-9a-z]{8})[0-9a-z]*$/$1/;
3396 my $reportnot = sub {
3398 my $s = $abbrev->($notp);
3399 my $c = $notp->{Child};
3400 $s .= "..".$abbrev->($c) if $c;
3401 $s .= ": ".$notp->{Whynot};
3404 if ($quilt_mode eq 'linear') {
3405 print STDERR "$us: quilt fixup cannot be linear. Stopped at:\n";
3406 foreach my $notp (@nots) {
3407 print STDERR "$us: ", $reportnot->($notp), "\n";
3409 print STDERR "$us: $_\n" foreach @$failsuggestion;
3410 fail "quilt fixup naive history linearisation failed.\n".
3411 "Use dpkg-source --commit by hand; or, --quilt=smash for one ugly patch";
3412 } elsif ($quilt_mode eq 'smash') {
3413 } elsif ($quilt_mode eq 'auto') {
3414 progress "quilt fixup cannot be linear, smashing...";
3416 die "$quilt_mode ?";
3419 my $time = $ENV{'GIT_COMMITTER_DATE'} || time;
3420 $time =~ s/\s.*//; # trim timezone from GIT_COMMITTER_DATE
3422 my $msg = cmdoutput @git, qw(log), "-n$ncommits";
3424 quiltify_dpkg_commit "auto-$version-$target-$time",
3425 (getfield $clogp, 'Maintainer'),
3426 "Automatically generated patch ($clogp->{Version})\n".
3427 "Last (up to) $ncommits git changes, FYI:\n\n". $msg;
3431 progress "quiltify linearisation planning successful, executing...";
3433 for (my $p = $sref_S;
3434 my $c = $p->{Child};
3436 printdebug "quiltify traverse $p->{Commit}..$c->{Commit}\n";
3437 next unless $p->{Nontrivial};
3439 my $cc = $c->{Commit};
3441 my $commitdata = cmdoutput @git, qw(cat-file commit), $cc;
3442 $commitdata =~ m/\n\n/ or die "$c ?";
3445 $commitdata =~ m/^author (.*) \d+ [-+0-9]+$/m or die "$cc ?";
3448 $msg =~ s/^(.*)\n*/$1\n/ or die "$cc $msg ?";
3451 my $patchname = $title;
3452 $patchname =~ s/[.:]$//;
3453 $patchname =~ y/ A-Z/-a-z/;
3454 $patchname =~ y/-a-z0-9_.+=~//cd;
3455 $patchname =~ s/^\W/x-$&/;
3456 $patchname = substr($patchname,0,40);
3459 stat "debian/patches/$patchname$index";
3461 $!==ENOENT or die "$patchname$index $!";
3463 runcmd @git, qw(checkout -q), $cc;
3465 # We use the tip's changelog so that dpkg-source doesn't
3466 # produce complaining messages from dpkg-parsechangelog. None
3467 # of the information dpkg-source gets from the changelog is
3468 # actually relevant - it gets put into the original message
3469 # which dpkg-source provides our stunt editor, and then
3471 runcmd @git, qw(checkout -q), $target, qw(debian/changelog);
3473 quiltify_dpkg_commit "$patchname$index", $author, $msg,
3474 "X-Dgit-Generated: $clogp->{Version} $cc\n";
3476 runcmd @git, qw(checkout -q), $cc, qw(debian/changelog);
3479 runcmd @git, qw(checkout -q master);
3482 sub build_maybe_quilt_fixup () {
3483 my ($format,$fopts) = get_source_format;
3484 return unless madformat $format;
3487 check_for_vendor_patches();
3489 my $clogp = parsechangelog();
3490 my $headref = git_rev_parse('HEAD');
3495 my $upstreamversion=$version;
3496 $upstreamversion =~ s/-[^-]*$//;
3498 if ($fopts->{'single-debian-patch'}) {
3499 quilt_fixup_singlepatch($clogp, $headref, $upstreamversion);
3501 quilt_fixup_multipatch($clogp, $headref, $upstreamversion);
3504 die 'bug' if $split_brain && !$need_split_build_invocation;
3506 changedir '../../../..';
3507 runcmd_ordryrun_local
3508 @git, qw(pull --ff-only -q .git/dgit/unpack/work master);
3511 sub quilt_fixup_mkwork ($) {
3514 mkdir "work" or die $!;
3516 mktree_in_ud_here();
3517 runcmd @git, qw(reset -q --hard), $headref;
3520 sub quilt_fixup_linkorigs ($$) {
3521 my ($upstreamversion, $fn) = @_;
3522 # calls $fn->($leafname);
3524 foreach my $f (<../../../../*>) { #/){
3525 my $b=$f; $b =~ s{.*/}{};
3527 local ($debuglevel) = $debuglevel-1;
3528 printdebug "QF linkorigs $b, $f ?\n";
3530 next unless is_orig_file $b, srcfn $upstreamversion,'';
3531 printdebug "QF linkorigs $b, $f Y\n";
3532 link_ltarget $f, $b or die "$b $!";
3537 sub quilt_fixup_delete_pc () {
3538 runcmd @git, qw(rm -rqf .pc);
3539 commit_admin "Commit removal of .pc (quilt series tracking data)";
3542 sub quilt_fixup_singlepatch ($$$) {
3543 my ($clogp, $headref, $upstreamversion) = @_;
3545 progress "starting quiltify (single-debian-patch)";
3547 # dpkg-source --commit generates new patches even if
3548 # single-debian-patch is in debian/source/options. In order to
3549 # get it to generate debian/patches/debian-changes, it is
3550 # necessary to build the source package.
3552 quilt_fixup_linkorigs($upstreamversion, sub { });
3553 quilt_fixup_mkwork($headref);
3555 rmtree("debian/patches");
3557 runcmd @dpkgsource, qw(-b .);
3559 runcmd @dpkgsource, qw(-x), (srcfn $version, ".dsc");
3560 rename srcfn("$upstreamversion", "/debian/patches"),
3561 "work/debian/patches";
3564 commit_quilty_patch();
3567 sub quilt_make_fake_dsc ($) {
3568 my ($upstreamversion) = @_;
3570 my $fakeversion="$upstreamversion-~~DGITFAKE";
3572 my $fakedsc=new IO::File 'fake.dsc', '>' or die $!;
3573 print $fakedsc <<END or die $!;
3576 Version: $fakeversion
3580 my $dscaddfile=sub {
3583 my $md = new Digest::MD5;
3585 my $fh = new IO::File $b, '<' or die "$b $!";
3590 print $fakedsc " ".$md->hexdigest." $size $b\n" or die $!;
3593 quilt_fixup_linkorigs($upstreamversion, $dscaddfile);
3595 my @files=qw(debian/source/format debian/rules
3596 debian/control debian/changelog);
3597 foreach my $maybe (qw(debian/patches debian/source/options
3598 debian/tests/control)) {
3599 next unless stat_exists "../../../$maybe";
3600 push @files, $maybe;
3603 my $debtar= srcfn $fakeversion,'.debian.tar.gz';
3604 runcmd qw(env GZIP=-1n tar -zcf), "./$debtar", qw(-C ../../..), @files;
3606 $dscaddfile->($debtar);
3607 close $fakedsc or die $!;
3610 sub quilt_check_splitbrain_cache ($$) {
3611 my ($headref, $upstreamversion) = @_;
3612 # Called only if we are in (potentially) split brain mode.
3614 # Computes the cache key and looks in the cache.
3615 # Returns ($dgit_view_commitid, $cachekey) or (undef, $cachekey)
3617 my $splitbrain_cachekey;
3620 "dgit: split brain (separate dgit view) may be needed (--quilt=$quilt_mode).";
3621 # we look in the reflog of dgit-intern/quilt-cache
3622 # we look for an entry whose message is the key for the cache lookup
3623 my @cachekey = (qw(dgit), $our_version);
3624 push @cachekey, $upstreamversion;
3625 push @cachekey, $quilt_mode;
3626 push @cachekey, $headref;
3628 push @cachekey, hashfile('fake.dsc');
3630 my $srcshash = Digest::SHA->new(256);
3631 my %sfs = ( %INC, '$0(dgit)' => $0 );
3632 foreach my $sfk (sort keys %sfs) {
3633 next unless m/^\$0\b/ || m{^Debian/Dgit\b};
3634 $srcshash->add($sfk," ");
3635 $srcshash->add(hashfile($sfs{$sfk}));
3636 $srcshash->add("\n");
3638 push @cachekey, $srcshash->hexdigest();
3639 $splitbrain_cachekey = "@cachekey";
3641 my @cmd = (@git, qw(reflog), '--pretty=format:%H %gs',
3643 printdebug "splitbrain cachekey $splitbrain_cachekey\n";
3644 debugcmd "|(probably)",@cmd;
3645 my $child = open GC, "-|"; defined $child or die $!;
3647 chdir '../../..' or die $!;
3648 if (!stat ".git/logs/refs/$splitbraincache") {
3649 $! == ENOENT or die $!;
3650 printdebug ">(no reflog)\n";
3657 printdebug ">| ", $_, "\n" if $debuglevel > 1;
3658 next unless m/^(\w+) (\S.*\S)$/ && $2 eq $splitbrain_cachekey;
3661 quilt_fixup_mkwork($headref);
3662 if ($cachehit ne $headref) {
3663 progress "dgit view: found cached (commit id $cachehit)";
3664 runcmd @git, qw(checkout -q -b dgit-view), $cachehit;
3666 return ($cachehit, $splitbrain_cachekey);
3668 progress "dgit view: found cached, no changes required";
3669 return ($headref, $splitbrain_cachekey);
3671 die $! if GC->error;
3672 failedcmd unless close GC;
3674 printdebug "splitbrain cache miss\n";
3675 return (undef, $splitbrain_cachekey);
3678 sub quilt_fixup_multipatch ($$$) {
3679 my ($clogp, $headref, $upstreamversion) = @_;
3681 progress "examining quilt state (multiple patches, $quilt_mode mode)";
3684 # - honour any existing .pc in case it has any strangeness
3685 # - determine the git commit corresponding to the tip of
3686 # the patch stack (if there is one)
3687 # - if there is such a git commit, convert each subsequent
3688 # git commit into a quilt patch with dpkg-source --commit
3689 # - otherwise convert all the differences in the tree into
3690 # a single git commit
3694 # Our git tree doesn't necessarily contain .pc. (Some versions of
3695 # dgit would include the .pc in the git tree.) If there isn't
3696 # one, we need to generate one by unpacking the patches that we
3699 # We first look for a .pc in the git tree. If there is one, we
3700 # will use it. (This is not the normal case.)
3702 # Otherwise need to regenerate .pc so that dpkg-source --commit
3703 # can work. We do this as follows:
3704 # 1. Collect all relevant .orig from parent directory
3705 # 2. Generate a debian.tar.gz out of
3706 # debian/{patches,rules,source/format,source/options}
3707 # 3. Generate a fake .dsc containing just these fields:
3708 # Format Source Version Files
3709 # 4. Extract the fake .dsc
3710 # Now the fake .dsc has a .pc directory.
3711 # (In fact we do this in every case, because in future we will
3712 # want to search for a good base commit for generating patches.)
3714 # Then we can actually do the dpkg-source --commit
3715 # 1. Make a new working tree with the same object
3716 # store as our main tree and check out the main
3718 # 2. Copy .pc from the fake's extraction, if necessary
3719 # 3. Run dpkg-source --commit
3720 # 4. If the result has changes to debian/, then
3721 # - git-add them them
3722 # - git-add .pc if we had a .pc in-tree
3724 # 5. If we had a .pc in-tree, delete it, and git-commit
3725 # 6. Back in the main tree, fast forward to the new HEAD
3727 # Another situation we may have to cope with is gbp-style
3728 # patches-unapplied trees.
3730 # We would want to detect these, so we know to escape into
3731 # quilt_fixup_gbp. However, this is in general not possible.
3732 # Consider a package with a one patch which the dgit user reverts
3733 # (with git-revert or the moral equivalent).
3735 # That is indistinguishable in contents from a patches-unapplied
3736 # tree. And looking at the history to distinguish them is not
3737 # useful because the user might have made a confusing-looking git
3738 # history structure (which ought to produce an error if dgit can't
3739 # cope, not a silent reintroduction of an unwanted patch).
3741 # So gbp users will have to pass an option. But we can usually
3742 # detect their failure to do so: if the tree is not a clean
3743 # patches-applied tree, quilt linearisation fails, but the tree
3744 # _is_ a clean patches-unapplied tree, we can suggest that maybe
3745 # they want --quilt=unapplied.
3747 # To help detect this, when we are extracting the fake dsc, we
3748 # first extract it with --skip-patches, and then apply the patches
3749 # afterwards with dpkg-source --before-build. That lets us save a
3750 # tree object corresponding to .origs.
3752 my $splitbrain_cachekey;
3754 quilt_make_fake_dsc($upstreamversion);
3756 if (quiltmode_splitbrain()) {
3758 ($cachehit, $splitbrain_cachekey) =
3759 quilt_check_splitbrain_cache($headref, $upstreamversion);
3760 return if $cachehit;
3764 'exec dpkg-source --no-check --skip-patches -x fake.dsc >/dev/null';
3766 my $fakexdir= $package.'-'.(stripepoch $upstreamversion);
3767 rename $fakexdir, "fake" or die "$fakexdir $!";
3771 remove_stray_gits();
3772 mktree_in_ud_here();
3776 runcmd @git, qw(add -Af .);
3777 my $unapplied=git_write_tree();
3778 printdebug "fake orig tree object $unapplied\n";
3783 'exec dpkg-source --before-build . >/dev/null';
3787 quilt_fixup_mkwork($headref);
3790 if (stat_exists ".pc") {
3792 progress "Tree already contains .pc - will use it then delete it.";
3795 rename '../fake/.pc','.pc' or die $!;
3798 changedir '../fake';
3800 runcmd @git, qw(add -Af .);
3801 my $oldtiptree=git_write_tree();
3802 printdebug "fake o+d/p tree object $unapplied\n";
3803 changedir '../work';
3806 # We calculate some guesswork now about what kind of tree this might
3807 # be. This is mostly for error reporting.
3812 # O = orig, without patches applied
3813 # A = "applied", ie orig with H's debian/patches applied
3814 H2O => quiltify_trees_differ($headref, $unapplied, 1,\%editedignores),
3815 H2A => quiltify_trees_differ($headref, $oldtiptree,1),
3816 O2A => quiltify_trees_differ($unapplied,$oldtiptree,1),
3820 foreach my $b (qw(01 02)) {
3821 foreach my $v (qw(H2O O2A H2A)) {
3822 push @dl, ($diffbits->{$v} & $b) ? '##' : '==';
3825 printdebug "differences \@dl @dl.\n";
3828 "$us: quilt differences: src: %s orig %s gitignores: %s orig %s\n".
3829 "$us: quilt differences: HEAD %s o+d/p HEAD %s o+d/p",
3830 $dl[0], $dl[1], $dl[3], $dl[4],
3834 if (!($diffbits->{H2O} & $diffbits->{O2A})) {
3835 push @failsuggestion, "This might be a patches-unapplied branch.";
3836 } elsif (!($diffbits->{H2A} & $diffbits->{O2A})) {
3837 push @failsuggestion, "This might be a patches-applied branch.";
3839 push @failsuggestion, "Maybe you need to specify one of".
3840 " --quilt=gbp --quilt=dpm --quilt=unapplied ?";
3842 if (quiltmode_splitbrain()) {
3843 quiltify_splitbrain($clogp, $unapplied, $headref,
3844 $diffbits, \%editedignores,
3845 $splitbrain_cachekey);
3849 progress "starting quiltify (multiple patches, $quilt_mode mode)";
3850 quiltify($clogp,$headref,$oldtiptree,\@failsuggestion);
3852 if (!open P, '>>', ".pc/applied-patches") {
3853 $!==&ENOENT or die $!;
3858 commit_quilty_patch();
3860 if ($mustdeletepc) {
3861 quilt_fixup_delete_pc();
3865 sub quilt_fixup_editor () {
3866 my $descfn = $ENV{$fakeeditorenv};
3867 my $editing = $ARGV[$#ARGV];
3868 open I1, '<', $descfn or die "$descfn: $!";
3869 open I2, '<', $editing or die "$editing: $!";
3870 unlink $editing or die "$editing: $!";
3871 open O, '>', $editing or die "$editing: $!";
3872 while (<I1>) { print O or die $!; } I1->error and die $!;
3875 $copying ||= m/^\-\-\- /;
3876 next unless $copying;
3879 I2->error and die $!;
3884 sub maybe_apply_patches_dirtily () {
3885 return unless $quilt_mode =~ m/gbp|unapplied/;
3886 print STDERR <<END or die $!;
3888 dgit: Building, or cleaning with rules target, in patches-unapplied tree.
3889 dgit: Have to apply the patches - making the tree dirty.
3890 dgit: (Consider specifying --clean=git and (or) using dgit sbuild.)
3893 $patches_applied_dirtily = 01;
3894 $patches_applied_dirtily |= 02 unless stat_exists '.pc';
3895 runcmd qw(dpkg-source --before-build .);
3898 sub maybe_unapply_patches_again () {
3899 progress "dgit: Unapplying patches again to tidy up the tree."
3900 if $patches_applied_dirtily;
3901 runcmd qw(dpkg-source --after-build .)
3902 if $patches_applied_dirtily & 01;
3904 if $patches_applied_dirtily & 02;
3905 $patches_applied_dirtily = 0;
3908 #----- other building -----
3910 our $clean_using_builder;
3911 # ^ tree is to be cleaned by dpkg-source's builtin idea that it should
3912 # clean the tree before building (perhaps invoked indirectly by
3913 # whatever we are using to run the build), rather than separately
3914 # and explicitly by us.
3917 return if $clean_using_builder;
3918 if ($cleanmode eq 'dpkg-source') {
3919 maybe_apply_patches_dirtily();
3920 runcmd_ordryrun_local @dpkgbuildpackage, qw(-T clean);
3921 } elsif ($cleanmode eq 'dpkg-source-d') {
3922 maybe_apply_patches_dirtily();
3923 runcmd_ordryrun_local @dpkgbuildpackage, qw(-d -T clean);
3924 } elsif ($cleanmode eq 'git') {
3925 runcmd_ordryrun_local @git, qw(clean -xdf);
3926 } elsif ($cleanmode eq 'git-ff') {
3927 runcmd_ordryrun_local @git, qw(clean -xdff);
3928 } elsif ($cleanmode eq 'check') {
3929 my $leftovers = cmdoutput @git, qw(clean -xdn);
3930 if (length $leftovers) {
3931 print STDERR $leftovers, "\n" or die $!;
3932 fail "tree contains uncommitted files and --clean=check specified";
3934 } elsif ($cleanmode eq 'none') {
3941 badusage "clean takes no additional arguments" if @ARGV;
3944 maybe_unapply_patches_again();
3949 badusage "-p is not allowed when building" if defined $package;
3952 my $clogp = parsechangelog();
3953 $isuite = getfield $clogp, 'Distribution';
3954 $package = getfield $clogp, 'Source';
3955 $version = getfield $clogp, 'Version';
3956 build_maybe_quilt_fixup();
3958 my $pat = changespat $version;
3959 foreach my $f (glob "$buildproductsdir/$pat") {
3961 unlink $f or fail "remove old changes file $f: $!";
3963 progress "would remove $f";
3969 sub changesopts_initial () {
3970 my @opts =@changesopts[1..$#changesopts];
3973 sub changesopts_version () {
3974 if (!defined $changes_since_version) {
3975 my @vsns = archive_query('archive_query');
3976 my @quirk = access_quirk();
3977 if ($quirk[0] eq 'backports') {
3978 local $isuite = $quirk[2];
3980 canonicalise_suite();
3981 push @vsns, archive_query('archive_query');
3984 @vsns = map { $_->[0] } @vsns;
3985 @vsns = sort { -version_compare($a, $b) } @vsns;
3986 $changes_since_version = $vsns[0];
3987 progress "changelog will contain changes since $vsns[0]";
3989 $changes_since_version = '_';
3990 progress "package seems new, not specifying -v<version>";
3993 if ($changes_since_version ne '_') {
3994 return ("-v$changes_since_version");
4000 sub changesopts () {
4001 return (changesopts_initial(), changesopts_version());
4004 sub massage_dbp_args ($;$) {
4005 my ($cmd,$xargs) = @_;
4008 # - if we're going to split the source build out so we can
4009 # do strange things to it, massage the arguments to dpkg-buildpackage
4010 # so that the main build doessn't build source (or add an argument
4011 # to stop it building source by default).
4013 # - add -nc to stop dpkg-source cleaning the source tree,
4014 # unless we're not doing a split build and want dpkg-source
4015 # as cleanmode, in which case we can do nothing
4018 # 0 - source will NOT need to be built separately by caller
4019 # +1 - source will need to be built separately by caller
4020 # +2 - source will need to be built separately by caller AND
4021 # dpkg-buildpackage should not in fact be run at all!
4022 debugcmd '#massaging#', @$cmd if $debuglevel>1;
4023 #print STDERR "MASS0 ",Dumper($cmd, $xargs, $need_split_build_invocation);
4024 if ($cleanmode eq 'dpkg-source' && !$need_split_build_invocation) {
4025 $clean_using_builder = 1;
4028 # -nc has the side effect of specifying -b if nothing else specified
4029 # and some combinations of -S, -b, et al, are errors, rather than
4030 # later simply overriding earlie. So we need to:
4031 # - search the command line for these options
4032 # - pick the last one
4033 # - perhaps add our own as a default
4034 # - perhaps adjust it to the corresponding non-source-building version
4036 foreach my $l ($cmd, $xargs) {
4038 @$l = grep { !(m/^-[SgGFABb]$/s and $dmode=$_) } @$l;
4041 #print STDERR "MASS1 ",Dumper($cmd, $xargs, $dmode);
4043 if ($need_split_build_invocation) {
4044 printdebug "massage split $dmode.\n";
4045 $r = $dmode =~ m/[S]/ ? +2 :
4046 $dmode =~ y/gGF/ABb/ ? +1 :
4047 $dmode =~ m/[ABb]/ ? 0 :
4050 printdebug "massage done $r $dmode.\n";
4052 #print STDERR "MASS2 ",Dumper($cmd, $xargs, $r);
4057 my @dbp = (@dpkgbuildpackage, qw(-us -uc), changesopts_initial(), @ARGV);
4058 my $wantsrc = massage_dbp_args \@dbp;
4065 push @dbp, changesopts_version();
4066 maybe_apply_patches_dirtily();
4067 runcmd_ordryrun_local @dbp;
4069 maybe_unapply_patches_again();
4070 printdone "build successful\n";
4074 my @dbp = @dpkgbuildpackage;
4076 my $wantsrc = massage_dbp_args \@dbp, \@ARGV;
4079 if (length executable_on_path('git-buildpackage')) {
4080 @cmd = qw(git-buildpackage);
4082 @cmd = qw(gbp buildpackage);
4084 push @cmd, (qw(-us -uc --git-no-sign-tags), "--git-builder=@dbp");
4089 if (!$clean_using_builder) {
4090 push @cmd, '--git-cleaner=true';
4094 maybe_unapply_patches_again();
4096 unless (grep { m/^--git-debian-branch|^--git-ignore-branch/ } @ARGV) {
4097 canonicalise_suite();
4098 push @cmd, "--git-debian-branch=".lbranch();
4100 push @cmd, changesopts();
4101 runcmd_ordryrun_local @cmd, @ARGV;
4103 printdone "build successful\n";
4105 sub cmd_git_build { cmd_gbp_build(); } # compatibility with <= 1.0
4108 my $our_cleanmode = $cleanmode;
4109 if ($need_split_build_invocation) {
4110 # Pretend that clean is being done some other way. This
4111 # forces us not to try to use dpkg-buildpackage to clean and
4112 # build source all in one go; and instead we run dpkg-source
4113 # (and build_prep() will do the clean since $clean_using_builder
4115 $our_cleanmode = 'ELSEWHERE';
4117 if ($our_cleanmode =~ m/^dpkg-source/) {
4118 # dpkg-source invocation (below) will clean, so build_prep shouldn't
4119 $clean_using_builder = 1;
4122 $sourcechanges = changespat $version,'source';
4124 unlink "../$sourcechanges" or $!==ENOENT
4125 or fail "remove $sourcechanges: $!";
4127 $dscfn = dscfn($version);
4128 if ($our_cleanmode eq 'dpkg-source') {
4129 maybe_apply_patches_dirtily();
4130 runcmd_ordryrun_local @dpkgbuildpackage, qw(-us -uc -S),
4132 } elsif ($our_cleanmode eq 'dpkg-source-d') {
4133 maybe_apply_patches_dirtily();
4134 runcmd_ordryrun_local @dpkgbuildpackage, qw(-us -uc -S -d),
4137 my @cmd = (@dpkgsource, qw(-b --));
4140 runcmd_ordryrun_local @cmd, "work";
4141 my @udfiles = <${package}_*>;
4142 changedir "../../..";
4143 foreach my $f (@udfiles) {
4144 printdebug "source copy, found $f\n";
4147 ($f =~ m/\.debian\.tar(?:\.\w+)$/ &&
4148 $f eq srcfn($version, $&));
4149 printdebug "source copy, found $f - renaming\n";
4150 rename "$ud/$f", "../$f" or $!==ENOENT
4151 or fail "put in place new source file ($f): $!";
4154 my $pwd = must_getcwd();
4155 my $leafdir = basename $pwd;
4157 runcmd_ordryrun_local @cmd, $leafdir;
4160 runcmd_ordryrun_local qw(sh -ec),
4161 'exec >$1; shift; exec "$@"','x',
4162 "../$sourcechanges",
4163 @dpkggenchanges, qw(-S), changesopts();
4167 sub cmd_build_source {
4168 badusage "build-source takes no additional arguments" if @ARGV;
4170 maybe_unapply_patches_again();
4171 printdone "source built, results in $dscfn and $sourcechanges";
4176 my $pat = changespat $version;
4178 my @unwanted = map { s#^\.\./##; $_; } glob "../$pat";
4179 @unwanted = grep { $_ ne changespat $version,'source' } @unwanted;
4180 fail "changes files other than source matching $pat".
4181 " already present (@unwanted);".
4182 " building would result in ambiguity about the intended results"
4185 my $wasdir = must_getcwd();
4188 stat_exists $dscfn or fail "$dscfn (in parent directory): $!";
4189 stat_exists $sourcechanges
4190 or fail "$sourcechanges (in parent directory): $!";
4192 runcmd_ordryrun_local @sbuild, qw(-d), $isuite, @ARGV, $dscfn;
4193 my @changesfiles = glob $pat;
4194 @changesfiles = sort {
4195 ($b =~ m/_source\.changes$/ <=> $a =~ m/_source\.changes$/)
4198 fail "wrong number of different changes files (@changesfiles)"
4199 unless @changesfiles==2;
4200 my $binchanges = parsecontrol($changesfiles[1], "binary changes file");
4201 foreach my $l (split /\n/, getfield $binchanges, 'Files') {
4202 fail "$l found in binaries changes file $binchanges"
4205 runcmd_ordryrun_local @mergechanges, @changesfiles;
4206 my $multichanges = changespat $version,'multi';
4208 stat_exists $multichanges or fail "$multichanges: $!";
4209 foreach my $cf (glob $pat) {
4210 next if $cf eq $multichanges;
4211 rename "$cf", "$cf.inmulti" or fail "$cf\{,.inmulti}: $!";
4215 maybe_unapply_patches_again();
4216 printdone "build successful, results in $multichanges\n" or die $!;
4219 sub cmd_quilt_fixup {
4220 badusage "incorrect arguments to dgit quilt-fixup" if @ARGV;
4221 my $clogp = parsechangelog();
4222 $version = getfield $clogp, 'Version';
4223 $package = getfield $clogp, 'Source';
4226 build_maybe_quilt_fixup();
4229 sub cmd_archive_api_query {
4230 badusage "need only 1 subpath argument" unless @ARGV==1;
4231 my ($subpath) = @ARGV;
4232 my @cmd = archive_api_query_cmd($subpath);
4234 exec @cmd or fail "exec curl: $!\n";
4237 sub cmd_clone_dgit_repos_server {
4238 badusage "need destination argument" unless @ARGV==1;
4239 my ($destdir) = @ARGV;
4240 $package = '_dgit-repos-server';
4241 my @cmd = (@git, qw(clone), access_giturl(), $destdir);
4243 exec @cmd or fail "exec git clone: $!\n";
4246 sub cmd_setup_mergechangelogs {
4247 badusage "no arguments allowed to dgit setup-mergechangelogs" if @ARGV;
4248 setup_mergechangelogs(1);
4251 sub cmd_setup_useremail {
4252 badusage "no arguments allowed to dgit setup-mergechangelogs" if @ARGV;
4256 sub cmd_setup_new_tree {
4257 badusage "no arguments allowed to dgit setup-tree" if @ARGV;
4261 #---------- argument parsing and main program ----------
4264 print "dgit version $our_version\n" or die $!;
4268 our (%valopts_long, %valopts_short);
4271 sub defvalopt ($$$$) {
4272 my ($long,$short,$val_re,$how) = @_;
4273 my $oi = { Long => $long, Short => $short, Re => $val_re, How => $how };
4274 $valopts_long{$long} = $oi;
4275 $valopts_short{$short} = $oi;
4276 # $how subref should:
4277 # do whatever assignemnt or thing it likes with $_[0]
4278 # if the option should not be passed on to remote, @rvalopts=()
4279 # or $how can be a scalar ref, meaning simply assign the value
4282 defvalopt '--since-version', '-v', '[^_]+|_', \$changes_since_version;
4283 defvalopt '--distro', '-d', '.+', \$idistro;
4284 defvalopt '', '-k', '.+', \$keyid;
4285 defvalopt '--existing-package','', '.*', \$existing_package;
4286 defvalopt '--build-products-dir','','.*', \$buildproductsdir;
4287 defvalopt '--clean', '', $cleanmode_re, \$cleanmode;
4288 defvalopt '--quilt', '', $quilt_modes_re, \$quilt_mode;
4290 defvalopt '', '-c', '.*=.*', sub { push @git, '-c', @_; };
4292 defvalopt '', '-C', '.+', sub {
4293 ($changesfile) = (@_);
4294 if ($changesfile =~ s#^(.*)/##) {
4295 $buildproductsdir = $1;
4299 defvalopt '--initiator-tempdir','','.*', sub {
4300 ($initiator_tempdir) = (@_);
4301 $initiator_tempdir =~ m#^/# or
4302 badusage "--initiator-tempdir must be used specify an".
4303 " absolute, not relative, directory."
4309 if (defined $ENV{'DGIT_SSH'}) {
4310 @ssh = string_to_ssh $ENV{'DGIT_SSH'};
4311 } elsif (defined $ENV{'GIT_SSH'}) {
4312 @ssh = ($ENV{'GIT_SSH'});
4320 if (!defined $val) {
4321 badusage "$what needs a value" unless @ARGV;
4323 push @rvalopts, $val;
4325 badusage "bad value \`$val' for $what" unless
4326 $val =~ m/^$oi->{Re}$(?!\n)/s;
4327 my $how = $oi->{How};
4328 if (ref($how) eq 'SCALAR') {
4333 push @ropts, @rvalopts;
4337 last unless $ARGV[0] =~ m/^-/;
4341 if (m/^--dry-run$/) {
4344 } elsif (m/^--damp-run$/) {
4347 } elsif (m/^--no-sign$/) {
4350 } elsif (m/^--help$/) {
4352 } elsif (m/^--version$/) {
4354 } elsif (m/^--new$/) {
4357 } elsif (m/^--([-0-9a-z]+)=(.+)/s &&
4358 ($om = $opts_opt_map{$1}) &&
4362 } elsif (m/^--([-0-9a-z]+):(.*)/s &&
4363 !$opts_opt_cmdonly{$1} &&
4364 ($om = $opts_opt_map{$1})) {
4367 } elsif (m/^--ignore-dirty$/s) {
4370 } elsif (m/^--no-quilt-fixup$/s) {
4372 $quilt_mode = 'nocheck';
4373 } elsif (m/^--no-rm-on-error$/s) {
4376 } elsif (m/^--(no-)?rm-old-changes$/s) {
4379 } elsif (m/^--deliberately-($deliberately_re)$/s) {
4381 push @deliberatelies, $&;
4382 } elsif (m/^--dgit-tag-format=(old|new)$/s) {
4383 # undocumented, for testing
4385 $tagformat_want = [ $1, 'command line', 1 ];
4386 # 1 menas overrides distro configuration
4387 } elsif (m/^--always-split-source-build$/s) {
4388 # undocumented, for testing
4390 $need_split_build_invocation = 1;
4391 } elsif (m/^(--[-0-9a-z]+)(=|$)/ && ($oi = $valopts_long{$1})) {
4392 $val = $2 ? $' : undef; #';
4393 $valopt->($oi->{Long});
4395 badusage "unknown long option \`$_'";
4402 } elsif (s/^-L/-/) {
4405 } elsif (s/^-h/-/) {
4407 } elsif (s/^-D/-/) {
4411 } elsif (s/^-N/-/) {
4416 push @changesopts, $_;
4418 } elsif (s/^-wn$//s) {
4420 $cleanmode = 'none';
4421 } elsif (s/^-wg$//s) {
4424 } elsif (s/^-wgf$//s) {
4426 $cleanmode = 'git-ff';
4427 } elsif (s/^-wd$//s) {
4429 $cleanmode = 'dpkg-source';
4430 } elsif (s/^-wdd$//s) {
4432 $cleanmode = 'dpkg-source-d';
4433 } elsif (s/^-wc$//s) {
4435 $cleanmode = 'check';
4436 } elsif (m/^-[a-zA-Z]/ && ($oi = $valopts_short{$&})) {
4438 $val = undef unless length $val;
4439 $valopt->($oi->{Short});
4442 badusage "unknown short option \`$_'";
4449 sub finalise_opts_opts () {
4450 foreach my $k (keys %opts_opt_map) {
4451 my $om = $opts_opt_map{$k};
4453 my $v = access_cfg("cmd-$k", 'RETURN-UNDEF');
4455 badcfg "cannot set command for $k"
4456 unless length $om->[0];
4460 foreach my $c (access_cfg_cfgs("opts-$k")) {
4461 my $vl = $gitcfg{$c};
4462 printdebug "CL $c ",
4463 ($vl ? join " ", map { shellquote } @$vl : ""),
4464 "\n" if $debuglevel >= 4;
4466 badcfg "cannot configure options for $k"
4467 if $opts_opt_cmdonly{$k};
4468 my $insertpos = $opts_cfg_insertpos{$k};
4469 @$om = ( @$om[0..$insertpos-1],
4471 @$om[$insertpos..$#$om] );
4476 if ($ENV{$fakeeditorenv}) {
4478 quilt_fixup_editor();
4484 print STDERR "DRY RUN ONLY\n" if $dryrun_level > 1;
4485 print STDERR "DAMP RUN - WILL MAKE LOCAL (UNSIGNED) CHANGES\n"
4486 if $dryrun_level == 1;
4488 print STDERR $helpmsg or die $!;
4491 my $cmd = shift @ARGV;
4494 if (!defined $rmchanges) {
4495 local $access_forpush;
4496 $rmchanges = access_cfg_bool(0, 'rm-old-changes');
4499 if (!defined $quilt_mode) {
4500 local $access_forpush;
4501 $quilt_mode = cfg('dgit.force.quilt-mode', 'RETURN-UNDEF')
4502 // access_cfg('quilt-mode', 'RETURN-UNDEF')
4504 $quilt_mode =~ m/^($quilt_modes_re)$/
4505 or badcfg "unknown quilt-mode \`$quilt_mode'";
4509 $need_split_build_invocation ||= quiltmode_splitbrain();
4511 if (!defined $cleanmode) {
4512 local $access_forpush;
4513 $cleanmode = access_cfg('clean-mode', 'RETURN-UNDEF');
4514 $cleanmode //= 'dpkg-source';
4516 badcfg "unknown clean-mode \`$cleanmode'" unless
4517 $cleanmode =~ m/^($cleanmode_re)$(?!\n)/s;
4520 my $fn = ${*::}{"cmd_$cmd"};
4521 $fn or badusage "unknown operation $cmd";