chiark / gitweb /
dgit: update-vcs-git: Do not crash if url is unchanged
[dgit.git] / dgit
1 #!/usr/bin/perl -w
2 # dgit
3 # Integration between git and Debian-style archives
4 #
5 # Copyright (C)2013-2019 Ian Jackson
6 # Copyright (C)2017-2019 Sean Whitton
7 # Copyright (C)2019      Matthew Vernon / Genome Research Limited
8 #
9 # This program is free software: you can redistribute it and/or modify
10 # it under the terms of the GNU General Public License as published by
11 # the Free Software Foundation, either version 3 of the License, or
12 # (at your option) any later version.
13 #
14 # This program is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 # GNU General Public License for more details.
18 #
19 # You should have received a copy of the GNU General Public License
20 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
21
22 END { $? = $Debian::Dgit::ExitStatus::desired // -1; };
23 use Debian::Dgit::ExitStatus;
24 use Debian::Dgit::I18n;
25
26 use strict;
27
28 use Debian::Dgit qw(:DEFAULT :playground);
29 setup_sigwarn();
30
31 use IO::Handle;
32 use Data::Dumper;
33 use WWW::Curl::Easy;
34 use Dpkg::Control::Hash;
35 use File::Path;
36 use File::Spec;
37 use File::Temp qw(tempdir);
38 use File::Basename;
39 use Dpkg::Version;
40 use Dpkg::Compression;
41 use Dpkg::Compression::Process;
42 use POSIX;
43 use Locale::gettext;
44 use IPC::Open2;
45 use Digest::SHA;
46 use Digest::MD5;
47 use List::MoreUtils qw(pairwise);
48 use Text::Glob qw(match_glob);
49 use Fcntl qw(:DEFAULT :flock);
50 use Carp;
51
52 use Debian::Dgit;
53
54 our $our_version = 'UNRELEASED'; ###substituted###
55 our $absurdity = undef; ###substituted###
56
57 $SIG{INT} = 'DEFAULT'; # work around #932841
58
59 our @rpushprotovsn_support = qw(6 5 4); # Reverse order!
60 our $protovsn;
61
62 our $cmd;
63 our $subcommand;
64 our $isuite;
65 our $idistro;
66 our $package;
67 our @ropts;
68
69 our $sign = 1;
70 our $dryrun_level = 0;
71 our $changesfile;
72 our $buildproductsdir;
73 our $bpd_glob;
74 our $new_package = 0;
75 our $includedirty = 0;
76 our $rmonerror = 1;
77 our @deliberatelies;
78 our %previously;
79 our $existing_package = 'dpkg';
80 our $cleanmode;
81 our $changes_since_version;
82 our $rmchanges;
83 our $overwrite_version; # undef: not specified; '': check changelog
84 our $quilt_mode;
85 our $quilt_upstream_commitish;
86 our $quilt_upstream_commitish_used;
87 our $quilt_upstream_commitish_message;
88 our $quilt_options_re = 'gbp|dpm|baredebian(?:\+tarball|\+git)?';
89 our $quilt_modes_re = "linear|smash|auto|nofix|nocheck|unapplied|$quilt_options_re";
90 our $splitview_mode;
91 our $splitview_modes_re = qr{auto|always|never};
92 our $dodep14tag;
93 our %internal_object_save;
94 our $we_are_responder;
95 our $we_are_initiator;
96 our $initiator_tempdir;
97 our $patches_applied_dirtily = 00;
98 our $chase_dsc_distro=1;
99
100 our %forceopts = map { $_=>0 }
101     qw(unrepresentable unsupported-source-format
102        dsc-changes-mismatch changes-origs-exactly
103        uploading-binaries uploading-source-only
104        import-gitapply-absurd
105        import-gitapply-no-absurd
106        import-dsc-with-dgit-field);
107
108 our %format_ok = map { $_=>1 } ("1.0","3.0 (native)","3.0 (quilt)");
109
110 our $cleanmode_re = qr{(?: dpkg-source (?: -d )? (?: ,no-check | ,all-check )?
111                      | (?: git | git-ff ) (?: ,always )?
112                          | check (?: ,ignores )?
113                          | none
114                          )}x;
115
116 our $git_authline_re = '^([^<>]+) \<(\S+)\> (\d+ [-+]\d+)$';
117 our $splitbraincache = 'dgit-intern/quilt-cache';
118 our $rewritemap = 'dgit-rewrite/map';
119
120 our @dpkg_source_ignores = qw(-i(?:^|/)\.git(?:/|$) -I.git);
121
122 our (@dget) = qw(dget);
123 our (@curl) = (qw(curl --proto-redir), '-all,http,https', qw(-L));
124 our (@dput) = qw(dput);
125 our (@debsign) = qw(debsign);
126 our (@gpg) = qw(gpg);
127 our (@sbuild) = (qw(sbuild --no-source));
128 our (@ssh) = 'ssh';
129 our (@dgit) = qw(dgit);
130 our (@git_debrebase) = qw(git-debrebase);
131 our (@aptget) = qw(apt-get);
132 our (@aptcache) = qw(apt-cache);
133 our (@dpkgbuildpackage) = (qw(dpkg-buildpackage), @dpkg_source_ignores);
134 our (@dpkgsource) = (qw(dpkg-source), @dpkg_source_ignores);
135 our (@dpkggenchanges) = qw(dpkg-genchanges);
136 our (@mergechanges) = qw(mergechanges -f);
137 our (@gbp_build) = ('');
138 our (@gbp_pq) = ('gbp pq');
139 our (@changesopts) = ('');
140 our (@pbuilder) = ("sudo -E pbuilder","--no-source-only-changes");
141 our (@cowbuilder) = ("sudo -E cowbuilder","--no-source-only-changes");
142
143 our %opts_opt_map = ('dget' => \@dget, # accept for compatibility
144                      'curl' => \@curl,
145                      'dput' => \@dput,
146                      'debsign' => \@debsign,
147                      'gpg' => \@gpg,
148                      'sbuild' => \@sbuild,
149                      'ssh' => \@ssh,
150                      'dgit' => \@dgit,
151                      'git' => \@git,
152                      'git-debrebase' => \@git_debrebase,
153                      'apt-get' => \@aptget,
154                      'apt-cache' => \@aptcache,
155                      'dpkg-source' => \@dpkgsource,
156                      'dpkg-buildpackage' => \@dpkgbuildpackage,
157                      'dpkg-genchanges' => \@dpkggenchanges,
158                      'gbp-build' => \@gbp_build,
159                      'gbp-pq' => \@gbp_pq,
160                      'ch' => \@changesopts,
161                      'mergechanges' => \@mergechanges,
162                      'pbuilder' => \@pbuilder,
163                      'cowbuilder' => \@cowbuilder);
164
165 our %opts_opt_cmdonly = ('gpg' => 1, 'git' => 1);
166 our %opts_cfg_insertpos = map {
167     $_,
168     scalar @{ $opts_opt_map{$_} }
169 } keys %opts_opt_map;
170
171 sub parseopts_late_defaults();
172 sub quiltify_trees_differ ($$;$$$);
173 sub setup_gitattrs(;$);
174 sub check_gitattrs($$);
175
176 our $playground;
177 our $keyid;
178
179 autoflush STDOUT 1;
180
181 our $supplementary_message = '';
182 our $made_split_brain = 0;
183 our $do_split_brain;
184
185 # Interactions between quilt mode and split brain
186 # (currently, split brain only implemented iff
187 #  madformat_wantfixup && quiltmode_splitting)
188 #
189 #   source format        sane           `3.0 (quilt)'
190 #                                       madformat_wantfixup()
191 #
192 #   quilt mode                          normal              quiltmode
193 #                                       (eg linear)         _splitbrain
194 #
195 #   ------------      ------------------------------------------------
196 #
197 #   no split          no q cache        no q cache          forbidden,
198 #     brain           PM on master      q fixup on master   prevented
199 #   !do_split_brain()                    PM on master
200 #
201 #   split brain       no q cache        q fixup cached, to dgit view
202 #                     PM in dgit view   PM in dgit view
203 #
204 # PM = pseudomerge to make ff, due to overwrite (or split view)
205 # "no q cache" = do not record in cache on build, do not check cache
206 # `3.0 (quilt)' with --quilt=nocheck is treated as sane format
207
208 END {
209     local ($@, $?);
210     return unless forkcheck_mainprocess();
211     print STDERR "! $_\n" foreach $supplementary_message =~ m/^.+$/mg;
212 }
213
214 our $remotename = 'dgit';
215 our @ourdscfield = qw(Dgit Vcs-Dgit-Master);
216 our $csuite;
217 our $instead_distro;
218
219 if (!defined $absurdity) {
220     $absurdity = $0;
221     $absurdity =~ s{/[^/]+$}{/absurd} or die;
222 }
223
224 sub madformat ($) { $_[0] eq '3.0 (quilt)' }
225
226 sub lbranch () { return "$branchprefix/$csuite"; }
227 my $lbranch_re = '^refs/heads/'.$branchprefix.'/([^/.]+)$';
228 sub lref () { return "refs/heads/".lbranch(); }
229 sub lrref () { return "refs/remotes/$remotename/".server_branch($csuite); }
230 sub rrref () { return server_ref($csuite); }
231
232 sub srcfn ($$) {
233     my ($vsn, $sfx) = @_;
234     return &source_file_leafname($package, $vsn, $sfx);
235 }
236 sub is_orig_file_of_vsn ($$) {
237     my ($f, $upstreamvsn) = @_;
238     return is_orig_file_of_p_v($f, $package, $upstreamvsn);
239 }
240
241 sub dscfn ($) {
242     my ($vsn) = @_;
243     return srcfn($vsn,".dsc");
244 }
245
246 sub changespat ($;$) {
247     my ($vsn, $arch) = @_;
248     return "${package}_".(stripepoch $vsn)."_".($arch//'*').".changes";
249 }
250
251 our $us = 'dgit';
252 initdebug('');
253
254 our @end;
255 END { 
256     local ($?);
257     return unless forkcheck_mainprocess();
258     foreach my $f (@end) {
259         eval { $f->(); };
260         print STDERR "$us: cleanup: $@" if length $@;
261     }
262 };
263
264 sub badcfg {
265     print STDERR f_ "%s: invalid configuration: %s\n", $us, "@_";
266     finish 12;
267 }
268
269 sub forceable_fail ($$) {
270     my ($forceoptsl, $msg) = @_;
271     fail $msg unless grep { $forceopts{$_} } @$forceoptsl;
272     print STDERR +(__ "warning: overriding problem due to --force:\n"). $msg;
273 }
274
275 sub forceing ($) {
276     my ($forceoptsl) = @_;
277     my @got = grep { $forceopts{$_} } @$forceoptsl;
278     return 0 unless @got;
279     print STDERR f_
280         "warning: skipping checks or functionality due to --force-%s\n",
281         $got[0];
282 }
283
284 sub no_such_package () {
285     print STDERR f_ "%s: source package %s does not exist in suite %s\n",
286         $us, $package, $isuite;
287     finish 4;
288 }
289
290 sub deliberately ($) {
291     my ($enquiry) = @_;
292     return !!grep { $_ eq "--deliberately-$enquiry" } @deliberatelies;
293 }
294
295 sub deliberately_not_fast_forward () {
296     foreach (qw(not-fast-forward fresh-repo)) {
297         return 1 if deliberately($_) || deliberately("TEST-dgit-only-$_");
298     }
299 }
300
301 sub quiltmode_splitting () {
302     $quilt_mode =~ m/gbp|dpm|unapplied|baredebian/;
303 }
304 sub format_quiltmode_splitting ($) {
305     my ($format) = @_;
306     return madformat_wantfixup($format) && quiltmode_splitting();
307 }
308
309 sub do_split_brain () { !!($do_split_brain // confess) }
310
311 sub opts_opt_multi_cmd {
312     my $extra = shift;
313     my @cmd;
314     push @cmd, split /\s+/, shift @_;
315     push @cmd, @$extra;
316     push @cmd, @_;
317     @cmd;
318 }
319
320 sub gbp_pq {
321     return opts_opt_multi_cmd [], @gbp_pq;
322 }
323
324 sub dgit_privdir () {
325     our $dgit_privdir_made //= ensure_a_playground 'dgit';
326 }
327
328 sub bpd_abs () {
329     my $r = $buildproductsdir;
330     $r = "$maindir/$r" unless $r =~ m{^/};
331     return $r;
332 }
333
334 sub get_tree_of_commit ($) {
335     my ($commitish) = @_;
336     my $cdata = cmdoutput @git, qw(cat-file commit), $commitish;
337     $cdata =~ m/\n\n/;  $cdata = $`;
338     $cdata =~ m/^tree (\w+)$/m or confess "cdata $cdata ?";
339     return $1;
340 }
341
342 sub branch_gdr_info ($$) {
343     my ($symref, $head) = @_;
344     my ($status, $msg, $current, $ffq_prev, $gdrlast) =
345         gdr_ffq_prev_branchinfo($symref);
346     return () unless $status eq 'branch';
347     $ffq_prev = git_get_ref $ffq_prev;
348     $gdrlast  = git_get_ref $gdrlast;
349     $gdrlast &&= is_fast_fwd $gdrlast, $head;
350     return ($ffq_prev, $gdrlast);
351 }
352
353 sub branch_is_gdr_unstitched_ff ($$$) {
354     my ($symref, $head, $ancestor) = @_;
355     my ($ffq_prev, $gdrlast) = branch_gdr_info($symref, $head);
356     return 0 unless $ffq_prev;
357     return 0 unless !defined $ancestor or is_fast_fwd $ancestor, $ffq_prev;
358     return 1;
359 }
360
361 sub branch_is_gdr ($) {
362     my ($head) = @_;
363     # This is quite like git-debrebase's keycommits.
364     # We have our own implementation because:
365     #  - our algorighm can do fewer tests so is faster
366     #  - it saves testing to see if gdr is installed
367
368     # NB we use this jsut for deciding whether to run gdr make-patches
369     # Before reusing this algorithm for somthing else, its
370     # suitability should be reconsidered.
371
372     my $walk = $head;
373     local $Debian::Dgit::debugcmd_when_debuglevel = 3;
374     printdebug "branch_is_gdr $head...\n";
375     my $get_patches = sub {
376         my $t = git_cat_file "$_[0]:debian/patches", [qw(missing tree)];
377         return $t // '';
378     };
379     my $tip_patches = $get_patches->($head);
380   WALK:
381     for (;;) {
382         my $cdata = git_cat_file $walk, 'commit';
383         my ($hdrs,$msg) = $cdata =~ m{\n\n} ? ($`,$') : ($cdata,'');
384         if ($msg =~ m{^\[git-debrebase\ (
385                           anchor | changelog | make-patches | 
386                           merged-breakwater | pseudomerge
387                       ) [: ] }mx) {
388             # no need to analyse this - it's sufficient
389             # (gdr classifications: Anchor, MergedBreakwaters)
390             # (made by gdr: Pseudomerge, Changelog)
391             printdebug "branch_is_gdr  $walk gdr $1 YES\n";
392             return 1;
393         }
394         my @parents = ($hdrs =~ m/^parent (\w+)$/gm);
395         if (@parents==2) {
396             my $walk_tree = get_tree_of_commit $walk;
397             foreach my $p (@parents) {
398                 my $p_tree = get_tree_of_commit $p;
399                 if ($p_tree eq $walk_tree) { # pseudomerge contriburor
400                     # (gdr classification: Pseudomerge; not made by gdr)
401                     printdebug "branch_is_gdr  $walk unmarked pseudomerge\n"
402                         if $debuglevel >= 2;
403                     $walk = $p;
404                     next WALK;
405                 }
406             }
407             # some other non-gdr merge
408             # (gdr classification: VanillaMerge, DgitImportUnpatched, ?)
409             printdebug "branch_is_gdr  $walk ?-2-merge NO\n";
410             return 0;
411         }
412         if (@parents>2) {
413             # (gdr classification: ?)
414             printdebug "branch_is_gdr  $walk ?-octopus NO\n";
415             return 0;
416         }
417         if (!@parents) {
418             printdebug "branch_is_gdr  $walk origin\n";
419             return 0;
420         }
421         if ($get_patches->($walk) ne $tip_patches) {
422             # Our parent added, removed, or edited patches, and wasn't
423             # a gdr make-patches commit.  gdr make-patches probably
424             # won't do that well, then.
425             # (gdr classification of parent: AddPatches or ?)
426             printdebug "branch_is_gdr  $walk ?-patches NO\n";
427             return 0;
428         }
429         if ($tip_patches eq '' and
430             !defined git_cat_file "$walk~:debian" and
431             !quiltify_trees_differ "$walk~", $walk
432            ) {
433             # (gdr classification of parent: BreakwaterStart
434             printdebug "branch_is_gdr  $walk unmarked BreakwaterStart YES\n";
435             return 1;
436         }
437         # (gdr classification: Upstream Packaging Mixed Changelog)
438         printdebug "branch_is_gdr  $walk plain\n"
439             if $debuglevel >= 2;
440         $walk = $parents[0];
441     }
442 }
443
444 #---------- remote protocol support, common ----------
445
446 # remote push initiator/responder protocol:
447 #  $ dgit remote-push-build-host <n-rargs> <rargs>... <push-args>...
448 #  where <rargs> is <push-host-dir> <supported-proto-vsn>,... ...
449 #  < dgit-remote-push-ready <actual-proto-vsn>
450 #
451 # occasionally:
452 #
453 #  > progress NBYTES
454 #  [NBYTES message]
455 #
456 #  > supplementary-message NBYTES
457 #  [NBYTES message]
458 #
459 # main sequence:
460 #
461 #  > file parsed-changelog
462 #  [indicates that output of dpkg-parsechangelog follows]
463 #  > data-block NBYTES
464 #  > [NBYTES bytes of data (no newline)]
465 #  [maybe some more blocks]
466 #  > data-end
467 #
468 #  > file dsc
469 #  [etc]
470 #
471 #  > file changes
472 #  [etc]
473 #
474 #  > param head DGIT-VIEW-HEAD
475 #  > param csuite SUITE
476 #  > param tagformat new              # $protovsn == 4
477 #  > param splitbrain 0|1             # $protovsn >= 6
478 #  > param maint-view MAINT-VIEW-HEAD
479 #
480 #  > param buildinfo-filename P_V_X.buildinfo   # zero or more times
481 #  > file buildinfo                             # for buildinfos to sign
482 #
483 #  > previously REFNAME=OBJNAME       # if --deliberately-not-fast-forward
484 #                                     # goes into tag, for replay prevention
485 #
486 #  > want signed-tag
487 #  [indicates that signed tag is wanted]
488 #  < data-block NBYTES
489 #  < [NBYTES bytes of data (no newline)]
490 #  [maybe some more blocks]
491 #  < data-end
492 #  < files-end
493 #
494 #  > want signed-dsc-changes
495 #  < data-block NBYTES    [transfer of signed dsc]
496 #  [etc]
497 #  < data-block NBYTES    [transfer of signed changes]
498 #  [etc]
499 #  < data-block NBYTES    [transfer of each signed buildinfo
500 #  [etc]                   same number and order as "file buildinfo"]
501 #  ...
502 #  < files-end
503 #
504 #  > complete
505
506 our $i_child_pid;
507
508 sub i_child_report () {
509     # Sees if our child has died, and reap it if so.  Returns a string
510     # describing how it died if it failed, or undef otherwise.
511     return undef unless $i_child_pid;
512     my $got = waitpid $i_child_pid, WNOHANG;
513     return undef if $got <= 0;
514     die unless $got == $i_child_pid;
515     $i_child_pid = undef;
516     return undef unless $?;
517     return f_ "build host child %s", waitstatusmsg();
518 }
519
520 sub badproto ($$) {
521     my ($fh, $m) = @_;
522     fail f_ "connection lost: %s", $! if $fh->error;
523     fail f_ "protocol violation; %s not expected", $m;
524 }
525
526 sub badproto_badread ($$) {
527     my ($fh, $wh) = @_;
528     fail f_ "connection lost: %s", $! if $!;
529     my $report = i_child_report();
530     fail $report if defined $report;
531     badproto $fh, f_ "eof (reading %s)", $wh;
532 }
533
534 sub protocol_expect (&$) {
535     my ($match, $fh) = @_;
536     local $_;
537     $_ = <$fh>;
538     defined && chomp or badproto_badread $fh, __ "protocol message";
539     if (wantarray) {
540         my @r = &$match;
541         return @r if @r;
542     } else {
543         my $r = &$match;
544         return $r if $r;
545     }
546     badproto $fh, f_ "\`%s'", $_;
547 }
548
549 sub protocol_send_file ($$) {
550     my ($fh, $ourfn) = @_;
551     open PF, "<", $ourfn or die "$ourfn: $!";
552     for (;;) {
553         my $d;
554         my $got = read PF, $d, 65536;
555         die "$ourfn: $!" unless defined $got;
556         last if !$got;
557         print $fh "data-block ".length($d)."\n" or confess "$!";
558         print $fh $d or confess "$!";
559     }
560     PF->error and die "$ourfn $!";
561     print $fh "data-end\n" or confess "$!";
562     close PF;
563 }
564
565 sub protocol_read_bytes ($$) {
566     my ($fh, $nbytes) = @_;
567     $nbytes =~ m/^[1-9]\d{0,5}$|^0$/ or badproto \*RO, __ "bad byte count";
568     my $d;
569     my $got = read $fh, $d, $nbytes;
570     $got==$nbytes or badproto_badread $fh, __ "data block";
571     return $d;
572 }
573
574 sub protocol_receive_file ($$) {
575     my ($fh, $ourfn) = @_;
576     printdebug "() $ourfn\n";
577     open PF, ">", $ourfn or die "$ourfn: $!";
578     for (;;) {
579         my ($y,$l) = protocol_expect {
580             m/^data-block (.*)$/ ? (1,$1) :
581             m/^data-end$/ ? (0,) :
582             ();
583         } $fh;
584         last unless $y;
585         my $d = protocol_read_bytes $fh, $l;
586         print PF $d or confess "$!";
587     }
588     close PF or confess "$!";
589 }
590
591 #---------- remote protocol support, responder ----------
592
593 sub responder_send_command ($) {
594     my ($command) = @_;
595     return unless $we_are_responder;
596     # called even without $we_are_responder
597     printdebug ">> $command\n";
598     print PO $command, "\n" or confess "$!";
599 }    
600
601 sub responder_send_file ($$) {
602     my ($keyword, $ourfn) = @_;
603     return unless $we_are_responder;
604     printdebug "]] $keyword $ourfn\n";
605     responder_send_command "file $keyword";
606     protocol_send_file \*PO, $ourfn;
607 }
608
609 sub responder_receive_files ($@) {
610     my ($keyword, @ourfns) = @_;
611     die unless $we_are_responder;
612     printdebug "[[ $keyword @ourfns\n";
613     responder_send_command "want $keyword";
614     foreach my $fn (@ourfns) {
615         protocol_receive_file \*PI, $fn;
616     }
617     printdebug "[[\$\n";
618     protocol_expect { m/^files-end$/ } \*PI;
619 }
620
621 #---------- remote protocol support, initiator ----------
622
623 sub initiator_expect (&) {
624     my ($match) = @_;
625     protocol_expect { &$match } \*RO;
626 }
627
628 #---------- end remote code ----------
629
630 sub progress {
631     if ($we_are_responder) {
632         my $m = join '', @_;
633         responder_send_command "progress ".length($m) or confess "$!";
634         print PO $m or confess "$!";
635     } else {
636         print @_, "\n";
637     }
638 }
639
640 our $ua;
641
642 our ($dscdata,$dscurl,$dsc,$dsc_checked,$skew_warning_vsn);
643
644 sub act_local () { return $dryrun_level <= 1; }
645 sub act_scary () { return !$dryrun_level; }
646
647 sub printdone {
648     if (!$dryrun_level) {
649         progress f_ "%s ok: %s", $us, "@_";
650     } else {
651         progress f_ "would be ok: %s (but dry run only)", "@_";
652     }
653 }
654
655 sub dryrun_report {
656     printcmd(\*STDERR,$debugprefix."#",@_);
657 }
658
659 sub runcmd_ordryrun {
660     if (act_scary()) {
661         runcmd @_;
662     } else {
663         dryrun_report @_;
664     }
665 }
666
667 sub runcmd_ordryrun_local {
668     if (act_local()) {
669         runcmd @_;
670     } else {
671         dryrun_report @_;
672     }
673 }
674
675 our $helpmsg = i_ <<END;
676 main usages:
677   dgit [dgit-opts] clone [dgit-opts] package [suite] [./dir|/dir]
678   dgit [dgit-opts] fetch|pull [dgit-opts] [suite]
679   dgit [dgit-opts] build [dpkg-buildpackage-opts]
680   dgit [dgit-opts] sbuild [sbuild-opts]
681   dgit [dgit-opts] pbuilder|cowbuilder [debbuildopts]
682   dgit [dgit-opts] push [dgit-opts] [suite]
683   dgit [dgit-opts] push-source [dgit-opts] [suite]
684   dgit [dgit-opts] rpush build-host:build-dir ...
685 important dgit options:
686   -k<keyid>           sign tag and package with <keyid> instead of default
687   --dry-run -n        do not change anything, but go through the motions
688   --damp-run -L       like --dry-run but make local changes, without signing
689   --new -N            allow introducing a new package
690   --debug -D          increase debug level
691   -c<name>=<value>    set git config option (used directly by dgit too)
692 END
693
694 our $later_warning_msg = i_ <<END;
695 Perhaps the upload is stuck in incoming.  Using the version from git.
696 END
697
698 sub badusage {
699     print STDERR f_ "%s: %s\n%s", $us, "@_", __ $helpmsg or confess "$!";
700     finish 8;
701 }
702
703 sub nextarg {
704     @ARGV or badusage __ "too few arguments";
705     return scalar shift @ARGV;
706 }
707
708 sub pre_help () {
709     not_necessarily_a_tree();
710 }
711 sub cmd_help () {
712     print __ $helpmsg or confess "$!";
713     finish 0;
714 }
715
716 our $td = $ENV{DGIT_TEST_DUMMY_DIR} || "DGIT_TEST_DUMMY_DIR-unset";
717
718 our %defcfg = ('dgit.default.distro' => 'debian',
719                'dgit.default.default-suite' => 'unstable',
720                'dgit.default.old-dsc-distro' => 'debian',
721                'dgit-suite.*-security.distro' => 'debian-security',
722                'dgit.default.username' => '',
723                'dgit.default.archive-query-default-component' => 'main',
724                'dgit.default.ssh' => 'ssh',
725                'dgit.default.archive-query' => 'madison:',
726                'dgit.default.sshpsql-dbname' => 'service=projectb',
727                'dgit.default.aptget-components' => 'main',
728                'dgit.default.source-only-uploads' => 'ok',
729                'dgit.dsc-url-proto-ok.http'    => 'true',
730                'dgit.dsc-url-proto-ok.https'   => 'true',
731                'dgit.dsc-url-proto-ok.git'     => 'true',
732                'dgit.vcs-git.suites',          => 'sid', # ;-separated
733                'dgit.default.dsc-url-proto-ok' => 'false',
734                # old means "repo server accepts pushes with old dgit tags"
735                # new means "repo server accepts pushes with new dgit tags"
736                # maint means "repo server accepts split brain pushes"
737                # hist means "repo server may have old pushes without new tag"
738                #   ("hist" is implied by "old")
739                'dgit-distro.debian.archive-query' => 'ftpmasterapi:',
740                'dgit-distro.debian.git-check' => 'url',
741                'dgit-distro.debian.git-check-suffix' => '/info/refs',
742                'dgit-distro.debian.new-private-pushers' => 't',
743                'dgit-distro.debian.source-only-uploads' => 'not-wholly-new',
744                'dgit-distro.debian/push.git-url' => '',
745                'dgit-distro.debian/push.git-host' => 'push.dgit.debian.org',
746                'dgit-distro.debian/push.git-user-force' => 'dgit',
747                'dgit-distro.debian/push.git-proto' => 'git+ssh://',
748                'dgit-distro.debian/push.git-path' => '/dgit/debian/repos',
749                'dgit-distro.debian/push.git-create' => 'true',
750                'dgit-distro.debian/push.git-check' => 'ssh-cmd',
751  'dgit-distro.debian.archive-query-url', 'https://api.ftp-master.debian.org/',
752 # 'dgit-distro.debian.archive-query-tls-key',
753 #    '/etc/ssl/certs/%HOST%.pem:/etc/dgit/%HOST%.pem',
754 # ^ this does not work because curl is broken nowadays
755 # Fixing #790093 properly will involve providing providing the key
756 # in some pacagke and maybe updating these paths.
757 #
758 # 'dgit-distro.debian.archive-query-tls-curl-args',
759 #   '--ca-path=/etc/ssl/ca-debian',
760 # ^ this is a workaround but works (only) on DSA-administered machines
761                'dgit-distro.debian.git-url' => 'https://git.dgit.debian.org',
762                'dgit-distro.debian.git-url-suffix' => '',
763                'dgit-distro.debian.upload-host' => 'ftp-master', # for dput
764                'dgit-distro.debian.mirror' => 'http://ftp.debian.org/debian/',
765  'dgit-distro.debian-security.archive-query' => 'aptget:',
766  'dgit-distro.debian-security.mirror' => 'http://security.debian.org/debian-security/',
767  'dgit-distro.debian-security.aptget-suite-map' => 's#-security$#/updates#',
768  'dgit-distro.debian-security.aptget-suite-rmap' => 's#$#-security#',
769  'dgit-distro.debian-security.nominal-distro' => 'debian',
770  'dgit-distro.debian.backports-quirk' => '(squeeze)-backports*',
771  'dgit-distro.debian-backports.mirror' => 'http://backports.debian.org/debian-backports/',
772                'dgit-distro.ubuntu.git-check' => 'false',
773  'dgit-distro.ubuntu.mirror' => 'http://archive.ubuntu.com/ubuntu',
774                'dgit-distro.ubuntucloud.git-check' => 'false',
775  'dgit-distro.ubuntucloud.nominal-distro' => 'ubuntu',
776  'dgit-distro.ubuntucloud.archive-query' => 'aptget:',
777  'dgit-distro.ubuntucloud.mirror' => 'http://ubuntu-cloud.archive.canonical.com/ubuntu',
778  'dgit-distro.ubuntucloud.aptget-suite-map' => 's#^([^-]+):([^:]+)$#${1}-updates/$2#; s#^(.+)-(.+):(.+)#$1-$2/$3#;',
779  'dgit-distro.ubuntucloud.aptget-suite-rmap' => 's#/(.+)$#-$1#',
780                'dgit-distro.test-dummy.ssh' => "$td/ssh",
781                'dgit-distro.test-dummy.username' => "alice",
782                'dgit-distro.test-dummy.git-check' => "ssh-cmd",
783                'dgit-distro.test-dummy.git-create' => "ssh-cmd",
784                'dgit-distro.test-dummy.git-url' => "$td/git",
785                'dgit-distro.test-dummy.git-host' => "git",
786                'dgit-distro.test-dummy.git-path' => "$td/git",
787                'dgit-distro.test-dummy.archive-query' => "dummycatapi:",
788                'dgit-distro.test-dummy.archive-query-url' => "file://$td/aq/",
789                'dgit-distro.test-dummy.mirror' => "file://$td/mirror/",
790                'dgit-distro.test-dummy.upload-host' => 'test-dummy',
791                );
792
793 our %gitcfgs;
794 our @gitcfgsources = qw(cmdline local global system);
795 our $invoked_in_git_tree = 1;
796
797 sub git_slurp_config () {
798     # This algoritm is a bit subtle, but this is needed so that for
799     # options which we want to be single-valued, we allow the
800     # different config sources to override properly.  See #835858.
801     foreach my $src (@gitcfgsources) {
802         next if $src eq 'cmdline';
803         # we do this ourselves since git doesn't handle it
804
805         $gitcfgs{$src} = git_slurp_config_src $src;
806     }
807 }
808
809 sub git_get_config ($) {
810     my ($c) = @_;
811     foreach my $src (@gitcfgsources) {
812         my $l = $gitcfgs{$src}{$c};
813         confess "internal error ($l $c)" if $l && !ref $l;
814         printdebug"C $c ".(defined $l ?
815                            join " ", map { messagequote "'$_'" } @$l :
816                            "undef")."\n"
817             if $debuglevel >= 4;
818         $l or next;
819         @$l==1 or badcfg
820             f_ "multiple values for %s (in %s git config)", $c, $src
821             if @$l > 1;
822         $l->[0] =~ m/\n/ and badcfg f_
823  "value for config option %s (in %s git config) contains newline(s)!",
824             $c, $src;
825         return $l->[0];
826     }
827     return undef;
828 }
829
830 sub cfg {
831     foreach my $c (@_) {
832         return undef if $c =~ /RETURN-UNDEF/;
833         printdebug "C? $c\n" if $debuglevel >= 5;
834         my $v = git_get_config($c);
835         return $v if defined $v;
836         my $dv = $defcfg{$c};
837         if (defined $dv) {
838             printdebug "CD $c $dv\n" if $debuglevel >= 4;
839             return $dv;
840         }
841     }
842     badcfg f_
843         "need value for one of: %s\n".
844         "%s: distro or suite appears not to be (properly) supported",
845         "@_", $us;
846 }
847
848 sub not_necessarily_a_tree () {
849     # needs to be called from pre_*
850     @gitcfgsources = grep { $_ ne 'local' } @gitcfgsources;
851     $invoked_in_git_tree = 0;
852 }
853
854 sub access_basedistro__noalias () {
855     if (defined $idistro) {
856         return $idistro;
857     } else {    
858         my $def = cfg("dgit-suite.$isuite.distro", 'RETURN-UNDEF');
859         return $def if defined $def;
860         foreach my $src (@gitcfgsources, 'internal') {
861             my $kl = $src eq 'internal' ? \%defcfg : $gitcfgs{$src};
862             next unless $kl;
863             foreach my $k (keys %$kl) {
864                 next unless $k =~ m#^dgit-suite\.(.*)\.distro$#;
865                 my $dpat = $1;
866                 next unless match_glob $dpat, $isuite;
867                 return $kl->{$k};
868             }
869         }
870         return cfg("dgit.default.distro");
871     }
872 }
873
874 sub access_basedistro () {
875     my $noalias = access_basedistro__noalias();
876     my $canon = cfg("dgit-distro.$noalias.alias-canon",'RETURN-UNDEF');
877     return $canon // $noalias;
878 }
879
880 sub access_nomdistro () {
881     my $base = access_basedistro();
882     my $r = cfg("dgit-distro.$base.nominal-distro",'RETURN-UNDEF') // $base;
883     $r =~ m/^$distro_re$/ or badcfg
884         f_ "bad syntax for (nominal) distro \`%s' (does not match %s)",
885         $r, "/^$distro_re$/";
886     return $r;
887 }
888
889 sub access_quirk () {
890     # returns (quirk name, distro to use instead or undef, quirk-specific info)
891     my $basedistro = access_basedistro();
892     my $backports_quirk = cfg("dgit-distro.$basedistro.backports-quirk",
893                               'RETURN-UNDEF');
894     if (defined $backports_quirk) {
895         my $re = $backports_quirk;
896         $re =~ s/[^-0-9a-z_\%*()]/\\$&/ig;
897         $re =~ s/\*/.*/g;
898         $re =~ s/\%/([-0-9a-z_]+)/
899             or $re =~ m/[()]/ or badcfg __ "backports-quirk needs \% or ( )";
900         if ($isuite =~ m/^$re$/) {
901             return ('backports',"$basedistro-backports",$1);
902         }
903     }
904     return ('none',undef);
905 }
906
907 our $access_forpush;
908
909 sub parse_cfg_bool ($$$) {
910     my ($what,$def,$v) = @_;
911     $v //= $def;
912     return
913         $v =~ m/^[ty1]/ ? 1 :
914         $v =~ m/^[fn0]/ ? 0 :
915         badcfg f_ "%s needs t (true, y, 1) or f (false, n, 0) not \`%s'",
916             $what, $v;
917 }       
918
919 sub access_forpush_config () {
920     my $d = access_basedistro();
921
922     return 1 if
923         $new_package &&
924         parse_cfg_bool('new-private-pushers', 0,
925                        cfg("dgit-distro.$d.new-private-pushers",
926                            'RETURN-UNDEF'));
927
928     my $v = cfg("dgit-distro.$d.readonly", 'RETURN-UNDEF');
929     $v //= 'a';
930     return
931         $v =~ m/^[ty1]/ ? 0 : # force readonly,    forpush = 0
932         $v =~ m/^[fn0]/ ? 1 : # force nonreadonly, forpush = 1
933         $v =~ m/^[a]/  ? '' : # auto,              forpush = ''
934         badcfg __
935             "readonly needs t (true, y, 1) or f (false, n, 0) or a (auto)";
936 }
937
938 sub access_forpush () {
939     $access_forpush //= access_forpush_config();
940     return $access_forpush;
941 }
942
943 sub default_from_access_cfg ($$$;$) {
944     my ($var, $keybase, $defval, $permit_re) = @_;
945     return if defined $$var;
946
947     $$var = access_cfg("$keybase-newer", 'RETURN-UNDEF');
948     $$var = undef if $$var && $$var !~ m/^$permit_re$/;
949
950     $$var //= access_cfg($keybase, 'RETURN-UNDEF');
951     $$var //= $defval;
952
953     badcfg f_ "unknown %s \`%s'", $keybase, $$var
954         if defined $permit_re and $$var !~ m/$permit_re/;
955 }
956
957 sub pushing () {
958     confess +(__ 'internal error').' '.Dumper($access_forpush)," ?" if
959         defined $access_forpush and !$access_forpush;
960     badcfg __ "pushing but distro is configured readonly"
961         if access_forpush_config() eq '0';
962     $access_forpush = 1;
963     $supplementary_message = __ <<'END' unless $we_are_responder;
964 Push failed, before we got started.
965 You can retry the push, after fixing the problem, if you like.
966 END
967     parseopts_late_defaults();
968 }
969
970 sub notpushing () {
971     parseopts_late_defaults();
972 }
973
974 sub determine_whether_split_brain ($) {
975     my ($format) = @_;
976     {
977         local $access_forpush;
978         default_from_access_cfg(\$splitview_mode, 'split-view', 'auto',
979                                 $splitview_modes_re);
980         $do_split_brain = 1 if $splitview_mode eq 'always';
981     }
982
983     printdebug "format $format, quilt mode $quilt_mode\n";
984
985     if (format_quiltmode_splitting $format) {
986         $splitview_mode ne 'never' or
987             fail f_ "dgit: quilt mode \`%s' (for format \`%s')".
988                     " implies split view, but split-view set to \`%s'",
989                     $quilt_mode, $format, $splitview_mode;
990         $do_split_brain = 1;
991     }
992     $do_split_brain //= 0;
993 }
994
995 sub supplementary_message ($) {
996     my ($msg) = @_;
997     if (!$we_are_responder) {
998         $supplementary_message = $msg;
999         return;
1000     } else {
1001         responder_send_command "supplementary-message ".length($msg)
1002             or confess "$!";
1003         print PO $msg or confess "$!";
1004     }
1005 }
1006
1007 sub access_distros () {
1008     # Returns list of distros to try, in order
1009     #
1010     # We want to try:
1011     #    0. `instead of' distro name(s) we have been pointed to
1012     #    1. the access_quirk distro, if any
1013     #    2a. the user's specified distro, or failing that  } basedistro
1014     #    2b. the distro calculated from the suite          }
1015     my @l = access_basedistro();
1016
1017     my (undef,$quirkdistro) = access_quirk();
1018     unshift @l, $quirkdistro;
1019     unshift @l, $instead_distro;
1020     @l = grep { defined } @l;
1021
1022     push @l, access_nomdistro();
1023
1024     if (access_forpush()) {
1025         @l = map { ("$_/push", $_) } @l;
1026     }
1027     @l;
1028 }
1029
1030 sub access_cfg_cfgs (@) {
1031     my (@keys) = @_;
1032     my @cfgs;
1033     # The nesting of these loops determines the search order.  We put
1034     # the key loop on the outside so that we search all the distros
1035     # for each key, before going on to the next key.  That means that
1036     # if access_cfg is called with a more specific, and then a less
1037     # specific, key, an earlier distro can override the less specific
1038     # without necessarily overriding any more specific keys.  (If the
1039     # distro wants to override the more specific keys it can simply do
1040     # so; whereas if we did the loop the other way around, it would be
1041     # impossible to for an earlier distro to override a less specific
1042     # key but not the more specific ones without restating the unknown
1043     # values of the more specific keys.
1044     my @realkeys;
1045     my @rundef;
1046     # We have to deal with RETURN-UNDEF specially, so that we don't
1047     # terminate the search prematurely.
1048     foreach (@keys) {
1049         if (m/RETURN-UNDEF/) { push @rundef, $_; last; }
1050         push @realkeys, $_
1051     }
1052     foreach my $d (access_distros()) {
1053         push @cfgs, map { "dgit-distro.$d.$_" } @realkeys;
1054     }
1055     push @cfgs, map { "dgit.default.$_" } @realkeys;
1056     push @cfgs, @rundef;
1057     return @cfgs;
1058 }
1059
1060 sub access_cfg (@) {
1061     my (@keys) = @_;
1062     my (@cfgs) = access_cfg_cfgs(@keys);
1063     my $value = cfg(@cfgs);
1064     return $value;
1065 }
1066
1067 sub access_cfg_bool ($$) {
1068     my ($def, @keys) = @_;
1069     parse_cfg_bool($keys[0], $def, access_cfg(@keys, 'RETURN-UNDEF'));
1070 }
1071
1072 sub string_to_ssh ($) {
1073     my ($spec) = @_;
1074     if ($spec =~ m/\s/) {
1075         return qw(sh -ec), 'exec '.$spec.' "$@"', 'x';
1076     } else {
1077         return ($spec);
1078     }
1079 }
1080
1081 sub access_cfg_ssh () {
1082     my $gitssh = access_cfg('ssh', 'RETURN-UNDEF');
1083     if (!defined $gitssh) {
1084         return @ssh;
1085     } else {
1086         return string_to_ssh $gitssh;
1087     }
1088 }
1089
1090 sub access_runeinfo ($) {
1091     my ($info) = @_;
1092     return ": dgit ".access_basedistro()." $info ;";
1093 }
1094
1095 sub access_someuserhost ($) {
1096     my ($some) = @_;
1097     my $user = access_cfg("$some-user-force", 'RETURN-UNDEF');
1098     defined($user) && length($user) or
1099         $user = access_cfg("$some-user",'username');
1100     my $host = access_cfg("$some-host");
1101     return length($user) ? "$user\@$host" : $host;
1102 }
1103
1104 sub access_gituserhost () {
1105     return access_someuserhost('git');
1106 }
1107
1108 sub access_giturl (;$) {
1109     my ($optional) = @_;
1110     my $url = access_cfg('git-url','RETURN-UNDEF');
1111     my $suffix;
1112     if (!length $url) {
1113         my $proto = access_cfg('git-proto', 'RETURN-UNDEF');
1114         return undef unless defined $proto;
1115         $url =
1116             $proto.
1117             access_gituserhost().
1118             access_cfg('git-path');
1119     } else {
1120         $suffix = access_cfg('git-url-suffix','RETURN-UNDEF');
1121     }
1122     $suffix //= '.git';
1123     return "$url/$package$suffix";
1124 }              
1125
1126 sub commit_getclogp ($) {
1127     # Returns the parsed changelog hashref for a particular commit
1128     my ($objid) = @_;
1129     our %commit_getclogp_memo;
1130     my $memo = $commit_getclogp_memo{$objid};
1131     return $memo if $memo;
1132
1133     my $mclog = dgit_privdir()."clog";
1134     runcmd shell_cmd "exec >$mclog", @git, qw(cat-file blob),
1135         "$objid:debian/changelog";
1136     $commit_getclogp_memo{$objid} = parsechangelog("-l$mclog");
1137 }
1138
1139 sub parse_dscdata () {
1140     my $dscfh = new IO::File \$dscdata, '<' or confess "$!";
1141     printdebug Dumper($dscdata) if $debuglevel>1;
1142     $dsc = parsecontrolfh($dscfh,$dscurl,1);
1143     printdebug Dumper($dsc) if $debuglevel>1;
1144 }
1145
1146 our %rmad;
1147
1148 sub archive_query ($;@) {
1149     my ($method) = shift @_;
1150     fail __ "this operation does not support multiple comma-separated suites"
1151         if $isuite =~ m/,/;
1152     my $query = access_cfg('archive-query','RETURN-UNDEF');
1153     $query =~ s/^(\w+):// or badcfg "invalid archive-query method \`$query'";
1154     my $proto = $1;
1155     my $data = $'; #';
1156     { no strict qw(refs); &{"${method}_${proto}"}($proto,$data,@_); }
1157 }
1158
1159 sub archive_query_prepend_mirror {
1160     my $m = access_cfg('mirror');
1161     return map { [ $_->[0], $m.$_->[1], @$_[2..$#$_] ] } @_;
1162 }
1163
1164 sub pool_dsc_subpath ($$) {
1165     my ($vsn,$component) = @_; # $package is implict arg
1166     my $prefix = substr($package, 0, $package =~ m/^l/ ? 4 : 1);
1167     return "/pool/$component/$prefix/$package/".dscfn($vsn);
1168 }
1169
1170 sub cfg_apply_map ($$$) {
1171     my ($varref, $what, $mapspec) = @_;
1172     return unless $mapspec;
1173
1174     printdebug "config $what EVAL{ $mapspec; }\n";
1175     $_ = $$varref;
1176     eval "package Dgit::Config; $mapspec;";
1177     die $@ if $@;
1178     $$varref = $_;
1179 }
1180
1181 sub url_fetch ($;@) {
1182     my ($url, %xopts) = @_;
1183     # Ok404 => 1   means give undef for 404
1184     # AccessBase => 'archive-query' (eg)
1185     # CurlOpts => { key => value }
1186
1187     my $curl  = WWW::Curl::Easy->new;
1188     my $setopt = sub {
1189         my ($k,$v) = @_;
1190         my $x = $curl->setopt($k, $v);
1191         confess "$k $v ".$curl->strerror($x)." ?" if $x;
1192     };
1193
1194     my $response_body = '';
1195     $setopt->(CURLOPT_REDIR_PROTOCOLS, CURLPROTO_HTTPS|CURLPROTO_HTTP);
1196     $setopt->(CURLOPT_URL,             $url);
1197     $setopt->(CURLOPT_NOSIGNAL,        1);
1198     $setopt->(CURLOPT_WRITEDATA,       \$response_body);
1199
1200     my $xcurlopts = $xopts{CurlOpts} // { };
1201     keys %$xcurlopts;
1202     while (my ($k,$v) = each %$xcurlopts) { $setopt->($k,$v); }
1203
1204     if ($xopts{AccessBase} && $url =~ m#^https://([-.0-9a-z]+)/#) {
1205         foreach my $k ("$xopts{AccessBase}-tls-key",
1206                        "$xopts{AccessBase}-tls-curl-ca-args") {
1207             fail "config option $k is obsolete and no longer supported"
1208                 if defined access_cfg($k, 'RETURN-UNDEF');
1209         }
1210     }
1211
1212     printdebug "query: fetching $url...\n";
1213
1214     local $SIG{PIPE} = 'IGNORE';
1215
1216     my $x = $curl->perform();
1217     fail f_ "fetch of %s failed (%s): %s",
1218         $url, $curl->strerror($x), $curl->errbuf
1219         if $x;
1220
1221     my $code = $curl->getinfo(CURLINFO_HTTP_CODE);
1222     if ($code eq '404' && $xopts{Ok404}) { return undef; }
1223     
1224     fail f_ "fetch of %s gave HTTP code %s", $url, $code
1225         unless $url =~ m#^file://# or $code =~ m/^2/;
1226
1227     confess unless defined $response_body;
1228     return $response_body;
1229 }
1230
1231 #---------- `ftpmasterapi' archive query method (nascent) ----------
1232
1233 sub api_query_raw ($;$) {
1234     my ($subpath, $ok404) = @_;
1235     my $url = access_cfg('archive-query-url');
1236     $url .= $subpath;
1237     return url_fetch $url,
1238         Ok404 => $ok404,
1239         AccessBase => 'archive-query';
1240 }
1241
1242 sub api_query ($$;$) {
1243     my ($data, $subpath, $ok404) = @_;
1244     use JSON;
1245     badcfg __ "ftpmasterapi archive query method takes no data part"
1246         if length $data;
1247     my $json = api_query_raw $subpath, $ok404;
1248     return undef unless defined $json;
1249     return decode_json($json);
1250 }
1251
1252 sub canonicalise_suite_ftpmasterapi {
1253     my ($proto,$data) = @_;
1254     my $suites = api_query($data, 'suites');
1255     my @matched;
1256     foreach my $entry (@$suites) {
1257         next unless grep { 
1258             my $v = $entry->{$_};
1259             defined $v && $v eq $isuite;
1260         } qw(codename name);
1261         push @matched, $entry;
1262     }
1263     fail f_ "unknown suite %s, maybe -d would help", $isuite
1264         unless @matched;
1265     my $cn;
1266     eval {
1267         @matched==1 or die f_ "multiple matches for suite %s\n", $isuite;
1268         $cn = "$matched[0]{codename}";
1269         defined $cn or die f_ "suite %s info has no codename\n", $isuite;
1270         $cn =~ m/^$suite_re$/
1271             or die f_ "suite %s maps to bad codename\n", $isuite;
1272     };
1273     die +(__ "bad ftpmaster api response: ")."$@\n".Dumper(\@matched)
1274         if length $@;
1275     return $cn;
1276 }
1277
1278 sub archive_query_ftpmasterapi {
1279     my ($proto,$data) = @_;
1280     my $info = api_query($data, "dsc_in_suite/$isuite/$package");
1281     my @rows;
1282     my $digester = Digest::SHA->new(256);
1283     foreach my $entry (@$info) {
1284         eval {
1285             my $vsn = "$entry->{version}";
1286             my ($ok,$msg) = version_check $vsn;
1287             die f_ "bad version: %s\n", $msg unless $ok;
1288             my $component = "$entry->{component}";
1289             $component =~ m/^$component_re$/ or die __ "bad component";
1290             my $filename = "$entry->{filename}";
1291             $filename && $filename !~ m#[^-+:._~0-9a-zA-Z/]|^[/.]|/[/.]#
1292                 or die __ "bad filename";
1293             my $sha256sum = "$entry->{sha256sum}";
1294             $sha256sum =~ m/^[0-9a-f]+$/ or die __ "bad sha256sum";
1295             push @rows, [ $vsn, "/pool/$component/$filename",
1296                           $digester, $sha256sum ];
1297         };
1298         die +(__ "bad ftpmaster api response: ")."$@\n".Dumper($entry)
1299             if length $@;
1300     }
1301     @rows = sort { -version_compare($a->[0],$b->[0]) } @rows;
1302     return archive_query_prepend_mirror @rows;
1303 }
1304
1305 sub file_in_archive_ftpmasterapi {
1306     my ($proto,$data,$filename) = @_;
1307     my $pat = $filename;
1308     $pat =~ s/_/\\_/g;
1309     $pat = "%/$pat";
1310     $pat =~ s#[^-+_.0-9a-z/]# sprintf '%%%02x', ord $& #ge;
1311     my $info = api_query($data, "file_in_archive/$pat", 1);
1312 }
1313
1314 sub package_not_wholly_new_ftpmasterapi {
1315     my ($proto,$data,$pkg) = @_;
1316     my $info = api_query($data,"madison?package=${pkg}&f=json");
1317     return !!@$info;
1318 }
1319
1320 #---------- `aptget' archive query method ----------
1321
1322 our $aptget_base;
1323 our $aptget_releasefile;
1324 our $aptget_configpath;
1325
1326 sub aptget_aptget   () { return @aptget,   qw(-c), $aptget_configpath; }
1327 sub aptget_aptcache () { return @aptcache, qw(-c), $aptget_configpath; }
1328
1329 sub aptget_cache_clean {
1330     runcmd_ordryrun_local qw(sh -ec),
1331         'cd "$1"; find -atime +30 -type f -print0 | xargs -0r rm --',
1332         'x', $aptget_base;
1333 }
1334
1335 sub aptget_lock_acquire () {
1336     my $lockfile = "$aptget_base/lock";
1337     open APTGET_LOCK, '>', $lockfile or confess "open $lockfile: $!";
1338     flock APTGET_LOCK, LOCK_EX or confess "lock $lockfile: $!";
1339 }
1340
1341 sub aptget_prep ($) {
1342     my ($data) = @_;
1343     return if defined $aptget_base;
1344
1345     badcfg __ "aptget archive query method takes no data part"
1346         if length $data;
1347
1348     my $cache = $ENV{XDG_CACHE_DIR} // "$ENV{HOME}/.cache";
1349
1350     ensuredir $cache;
1351     ensuredir "$cache/dgit";
1352     my $cachekey =
1353         access_cfg('aptget-cachekey','RETURN-UNDEF')
1354         // access_nomdistro();
1355
1356     $aptget_base = "$cache/dgit/aptget";
1357     ensuredir $aptget_base;
1358
1359     my $quoted_base = $aptget_base;
1360     confess "$quoted_base contains bad chars, cannot continue"
1361         if $quoted_base =~ m/["\\]/; # apt.conf(5) says no escaping :-/
1362
1363     ensuredir $aptget_base;
1364
1365     aptget_lock_acquire();
1366
1367     aptget_cache_clean();
1368
1369     $aptget_configpath = "$aptget_base/apt.conf#$cachekey";
1370     my $sourceslist = "source.list#$cachekey";
1371
1372     my $aptsuites = $isuite;
1373     cfg_apply_map(\$aptsuites, 'suite map',
1374                   access_cfg('aptget-suite-map', 'RETURN-UNDEF'));
1375
1376     open SRCS, ">", "$aptget_base/$sourceslist" or confess "$!";
1377     printf SRCS "deb-src %s %s %s\n",
1378         access_cfg('mirror'),
1379         $aptsuites,
1380         access_cfg('aptget-components')
1381         or confess "$!";
1382
1383     ensuredir "$aptget_base/cache";
1384     ensuredir "$aptget_base/lists";
1385
1386     open CONF, ">", $aptget_configpath or confess "$!";
1387     print CONF <<END;
1388 Debug::NoLocking "true";
1389 APT::Get::List-Cleanup "false";
1390 #clear APT::Update::Post-Invoke-Success;
1391 Dir::Etc::SourceList "$quoted_base/$sourceslist";
1392 Dir::State::Lists "$quoted_base/lists";
1393 Dir::Etc::preferences "$quoted_base/preferences";
1394 Dir::Cache::srcpkgcache "$quoted_base/cache/srcs#$cachekey";
1395 Dir::Cache::pkgcache "$quoted_base/cache/pkgs#$cachekey";
1396 END
1397
1398     foreach my $key (qw(
1399                         Dir::Cache
1400                         Dir::State
1401                         Dir::Cache::Archives
1402                         Dir::Etc::SourceParts
1403                         Dir::Etc::preferencesparts
1404                       )) {
1405         ensuredir "$aptget_base/$key";
1406         print CONF "$key \"$quoted_base/$key\";\n" or confess "$!";
1407     };
1408
1409     my $oldatime = (time // confess "$!") - 1;
1410     foreach my $oldlist (<$aptget_base/lists/*Release>) {
1411         next unless stat_exists $oldlist;
1412         my ($mtime) = (stat _)[9];
1413         utime $oldatime, $mtime, $oldlist or die "$oldlist $!";
1414     }
1415
1416     runcmd_ordryrun_local aptget_aptget(), qw(update);
1417
1418     my @releasefiles;
1419     foreach my $oldlist (<$aptget_base/lists/*Release>) {
1420         next unless stat_exists $oldlist;
1421         my ($atime) = (stat _)[8];
1422         next if $atime == $oldatime;
1423         push @releasefiles, $oldlist;
1424     }
1425     my @inreleasefiles = grep { m#/InRelease$# } @releasefiles;
1426     @releasefiles = @inreleasefiles if @inreleasefiles;
1427     if (!@releasefiles) {
1428         fail f_ <<END, $isuite, $cache;
1429 apt seemed to not to update dgit's cached Release files for %s.
1430 (Perhaps %s
1431  is on a filesystem mounted `noatime'; if so, please use `relatime'.)
1432 END
1433     }
1434     confess "apt updated too many Release files (@releasefiles), erk"
1435         unless @releasefiles == 1;
1436
1437     ($aptget_releasefile) = @releasefiles;
1438 }
1439
1440 sub canonicalise_suite_aptget {
1441     my ($proto,$data) = @_;
1442     aptget_prep($data);
1443
1444     my $release = parsecontrol $aptget_releasefile, "Release file", 1;
1445
1446     foreach my $name (qw(Codename Suite)) {
1447         my $val = $release->{$name};
1448         if (defined $val) {
1449             printdebug "release file $name: $val\n";
1450             cfg_apply_map(\$val, 'suite rmap',
1451                           access_cfg('aptget-suite-rmap', 'RETURN-UNDEF'));
1452             $val =~ m/^$suite_re$/o or fail f_
1453                 "Release file (%s) specifies intolerable %s",
1454                 $aptget_releasefile, $name;
1455             return $val
1456         }
1457     }
1458     return $isuite;
1459 }
1460
1461 sub archive_query_aptget {
1462     my ($proto,$data) = @_;
1463     aptget_prep($data);
1464
1465     ensuredir "$aptget_base/source";
1466     foreach my $old (<$aptget_base/source/*.dsc>) {
1467         unlink $old or die "$old: $!";
1468     }
1469
1470     my $showsrc = cmdoutput aptget_aptcache(), qw(showsrc), $package;
1471     return () unless $showsrc =~ m/^package:\s*\Q$package\E\s*$/mi;
1472     # avoids apt-get source failing with ambiguous error code
1473
1474     runcmd_ordryrun_local
1475         shell_cmd 'cd "$1"/source; shift', $aptget_base,
1476         aptget_aptget(), qw(--download-only --only-source source), $package;
1477
1478     my @dscs = <$aptget_base/source/*.dsc>;
1479     fail __ "apt-get source did not produce a .dsc" unless @dscs;
1480     fail f_ "apt-get source produced several .dscs (%s)", "@dscs"
1481         unless @dscs==1;
1482
1483     my $pre_dsc = parsecontrol $dscs[0], $dscs[0], 1;
1484
1485     use URI::Escape;
1486     my $uri = "file://". uri_escape $dscs[0];
1487     $uri =~ s{\%2f}{/}gi;
1488     return [ (getfield $pre_dsc, 'Version'), $uri ];
1489 }
1490
1491 sub file_in_archive_aptget () { return undef; }
1492 sub package_not_wholly_new_aptget () { return undef; }
1493
1494 #---------- `dummyapicat' archive query method ----------
1495 # (untranslated, because this is for testing purposes etc.)
1496
1497 sub archive_query_dummycatapi { archive_query_ftpmasterapi @_; }
1498 sub canonicalise_suite_dummycatapi { canonicalise_suite_ftpmasterapi @_; }
1499
1500 sub dummycatapi_run_in_mirror ($@) {
1501     # runs $fn with FIA open onto rune
1502     my ($rune, $argl, $fn) = @_;
1503
1504     my $mirror = access_cfg('mirror');
1505     $mirror =~ s#^file://#/# or die "$mirror ?";
1506     my @cmd = (qw(sh -ec), 'cd "$1"; shift'."\n".$rune,
1507                qw(x), $mirror, @$argl);
1508     debugcmd "-|", @cmd;
1509     open FIA, "-|", @cmd or confess "$!";
1510     my $r = $fn->();
1511     close FIA or ($!==0 && $?==141) or die failedcmd @cmd;
1512     return $r;
1513 }
1514
1515 sub file_in_archive_dummycatapi ($$$) {
1516     my ($proto,$data,$filename) = @_;
1517     my @out;
1518     dummycatapi_run_in_mirror '
1519             find -name "$1" -print0 |
1520             xargs -0r sha256sum
1521     ', [$filename], sub {
1522         while (<FIA>) {
1523             chomp or die;
1524             printdebug "| $_\n";
1525             m/^(\w+)  (\S+)$/ or die "$_ ?";
1526             push @out, { sha256sum => $1, filename => $2 };
1527         }
1528     };
1529     return \@out;
1530 }
1531
1532 sub package_not_wholly_new_dummycatapi {
1533     my ($proto,$data,$pkg) = @_;
1534     dummycatapi_run_in_mirror "
1535             find -name ${pkg}_*.dsc
1536     ", [], sub {
1537         local $/ = undef;
1538         !!<FIA>;
1539     };
1540 }
1541
1542 #---------- `madison' archive query method ----------
1543
1544 sub archive_query_madison {
1545     return archive_query_prepend_mirror
1546         map { [ @$_[0..1] ] } madison_get_parse(@_);
1547 }
1548
1549 sub madison_get_parse {
1550     my ($proto,$data) = @_;
1551     die unless $proto eq 'madison';
1552     if (!length $data) {
1553         $data= access_cfg('madison-distro','RETURN-UNDEF');
1554         $data //= access_basedistro();
1555     }
1556     $rmad{$proto,$data,$package} ||= cmdoutput
1557         qw(rmadison -asource),"-s$isuite","-u$data",$package;
1558     my $rmad = $rmad{$proto,$data,$package};
1559
1560     my @out;
1561     foreach my $l (split /\n/, $rmad) {
1562         $l =~ m{^ \s*( [^ \t|]+ )\s* \|
1563                   \s*( [^ \t|]+ )\s* \|
1564                   \s*( [^ \t|/]+ )(?:/([^ \t|/]+))? \s* \|
1565                   \s*( [^ \t|]+ )\s* }x or die "$rmad ?";
1566         $1 eq $package or die "$rmad $package ?";
1567         my $vsn = $2;
1568         my $newsuite = $3;
1569         my $component;
1570         if (defined $4) {
1571             $component = $4;
1572         } else {
1573             $component = access_cfg('archive-query-default-component');
1574         }
1575         $5 eq 'source' or die "$rmad ?";
1576         push @out, [$vsn,pool_dsc_subpath($vsn,$component),$newsuite];
1577     }
1578     return sort { -version_compare($a->[0],$b->[0]); } @out;
1579 }
1580
1581 sub canonicalise_suite_madison {
1582     # madison canonicalises for us
1583     my @r = madison_get_parse(@_);
1584     @r or fail f_
1585         "unable to canonicalise suite using package %s".
1586         " which does not appear to exist in suite %s;".
1587         " --existing-package may help",
1588         $package, $isuite;
1589     return $r[0][2];
1590 }
1591
1592 sub file_in_archive_madison { return undef; }
1593 sub package_not_wholly_new_madison { return undef; }
1594
1595 #---------- `sshpsql' archive query method ----------
1596 # (untranslated, because this is obsolete)
1597
1598 sub sshpsql ($$$) {
1599     my ($data,$runeinfo,$sql) = @_;
1600     if (!length $data) {
1601         $data= access_someuserhost('sshpsql').':'.
1602             access_cfg('sshpsql-dbname');
1603     }
1604     $data =~ m/:/ or badcfg "invalid sshpsql method string \`$data'";
1605     my ($userhost,$dbname) = ($`,$'); #';
1606     my @rows;
1607     my @cmd = (access_cfg_ssh, $userhost,
1608                access_runeinfo("ssh-psql $runeinfo").
1609                " export LC_MESSAGES=C; export LC_CTYPE=C;".
1610                " ".shellquote qw(psql -A), $dbname, qw(-c), $sql);
1611     debugcmd "|",@cmd;
1612     open P, "-|", @cmd or confess "$!";
1613     while (<P>) {
1614         chomp or die;
1615         printdebug(">|$_|\n");
1616         push @rows, $_;
1617     }
1618     $!=0; $?=0; close P or failedcmd @cmd;
1619     @rows or die;
1620     my $nrows = pop @rows;
1621     $nrows =~ s/^\((\d+) rows?\)$/$1/ or die "$nrows ?";
1622     @rows == $nrows+1 or die "$nrows ".(scalar @rows)." ?";
1623     @rows = map { [ split /\|/, $_ ] } @rows;
1624     my $ncols = scalar @{ shift @rows };
1625     die if grep { scalar @$_ != $ncols } @rows;
1626     return @rows;
1627 }
1628
1629 sub sql_injection_check {
1630     foreach (@_) { die "$_ $& ?" if m{[^-+=:_.,/0-9a-zA-Z]}; }
1631 }
1632
1633 sub archive_query_sshpsql ($$) {
1634     my ($proto,$data) = @_;
1635     sql_injection_check $isuite, $package;
1636     my @rows = sshpsql($data, "archive-query $isuite $package", <<END);
1637         SELECT source.version, component.name, files.filename, files.sha256sum
1638           FROM source
1639           JOIN src_associations ON source.id = src_associations.source
1640           JOIN suite ON suite.id = src_associations.suite
1641           JOIN dsc_files ON dsc_files.source = source.id
1642           JOIN files_archive_map ON files_archive_map.file_id = dsc_files.file
1643           JOIN component ON component.id = files_archive_map.component_id
1644           JOIN files ON files.id = dsc_files.file
1645          WHERE ( suite.suite_name='$isuite' OR suite.codename='$isuite' )
1646            AND source.source='$package'
1647            AND files.filename LIKE '%.dsc';
1648 END
1649     @rows = sort { -version_compare($a->[0],$b->[0]) } @rows;
1650     my $digester = Digest::SHA->new(256);
1651     @rows = map {
1652         my ($vsn,$component,$filename,$sha256sum) = @$_;
1653         [ $vsn, "/pool/$component/$filename",$digester,$sha256sum ];
1654     } @rows;
1655     return archive_query_prepend_mirror @rows;
1656 }
1657
1658 sub canonicalise_suite_sshpsql ($$) {
1659     my ($proto,$data) = @_;
1660     sql_injection_check $isuite;
1661     my @rows = sshpsql($data, "canonicalise-suite $isuite", <<END);
1662         SELECT suite.codename
1663           FROM suite where suite_name='$isuite' or codename='$isuite';
1664 END
1665     @rows = map { $_->[0] } @rows;
1666     fail "unknown suite $isuite" unless @rows;
1667     die "ambiguous $isuite: @rows ?" if @rows>1;
1668     return $rows[0];
1669 }
1670
1671 sub file_in_archive_sshpsql ($$$) { return undef; }
1672 sub package_not_wholly_new_sshpsql ($$$) { return undef; }
1673
1674 #---------- `dummycat' archive query method ----------
1675 # (untranslated, because this is for testing purposes etc.)
1676
1677 sub canonicalise_suite_dummycat ($$) {
1678     my ($proto,$data) = @_;
1679     my $dpath = "$data/suite.$isuite";
1680     if (!open C, "<", $dpath) {
1681         $!==ENOENT or die "$dpath: $!";
1682         printdebug "dummycat canonicalise_suite $isuite $dpath ENOENT\n";
1683         return $isuite;
1684     }
1685     $!=0; $_ = <C>;
1686     chomp or die "$dpath: $!";
1687     close C;
1688     printdebug "dummycat canonicalise_suite $isuite $dpath = $_\n";
1689     return $_;
1690 }
1691
1692 sub archive_query_dummycat ($$) {
1693     my ($proto,$data) = @_;
1694     canonicalise_suite();
1695     my $dpath = "$data/package.$csuite.$package";
1696     if (!open C, "<", $dpath) {
1697         $!==ENOENT or die "$dpath: $!";
1698         printdebug "dummycat query $csuite $package $dpath ENOENT\n";
1699         return ();
1700     }
1701     my @rows;
1702     while (<C>) {
1703         next if m/^\#/;
1704         next unless m/\S/;
1705         die unless chomp;
1706         printdebug "dummycat query $csuite $package $dpath | $_\n";
1707         my @row = split /\s+/, $_;
1708         @row==2 or die "$dpath: $_ ?";
1709         push @rows, \@row;
1710     }
1711     C->error and die "$dpath: $!";
1712     close C;
1713     return archive_query_prepend_mirror
1714         sort { -version_compare($a->[0],$b->[0]); } @rows;
1715 }
1716
1717 sub file_in_archive_dummycat () { return undef; }
1718 sub package_not_wholly_new_dummycat () { return undef; }
1719
1720 #---------- archive query entrypoints and rest of program ----------
1721
1722 sub canonicalise_suite () {
1723     return if defined $csuite;
1724     fail f_ "cannot operate on %s suite", $isuite if $isuite eq 'UNRELEASED';
1725     $csuite = archive_query('canonicalise_suite');
1726     if ($isuite ne $csuite) {
1727         progress f_ "canonical suite name for %s is %s", $isuite, $csuite;
1728     } else {
1729         progress f_ "canonical suite name is %s", $csuite;
1730     }
1731 }
1732
1733 sub get_archive_dsc () {
1734     canonicalise_suite();
1735     my @vsns = archive_query('archive_query');
1736     foreach my $vinfo (@vsns) {
1737         my ($vsn,$vsn_dscurl,$digester,$digest) = @$vinfo;
1738         $dscurl = $vsn_dscurl;
1739         $dscdata = url_fetch($dscurl);
1740         if (!$dscdata) {
1741             $skew_warning_vsn = $vsn if !defined $skew_warning_vsn;
1742             next;
1743         }
1744         if ($digester) {
1745             $digester->reset();
1746             $digester->add($dscdata);
1747             my $got = $digester->hexdigest();
1748             $got eq $digest or
1749                 fail f_ "%s has hash %s but archive told us to expect %s",
1750                         $dscurl, $got, $digest;
1751         }
1752         parse_dscdata();
1753         my $fmt = getfield $dsc, 'Format';
1754         $format_ok{$fmt} or forceable_fail [qw(unsupported-source-format)],
1755             f_ "unsupported source format %s, sorry", $fmt;
1756             
1757         $dsc_checked = !!$digester;
1758         printdebug "get_archive_dsc: Version ".(getfield $dsc, 'Version')."\n";
1759         return;
1760     }
1761     $dsc = undef;
1762     printdebug "get_archive_dsc: nothing in archive, returning undef\n";
1763 }
1764
1765 sub check_for_git ();
1766 sub check_for_git () {
1767     # returns 0 or 1
1768     my $how = access_cfg('git-check');
1769     if ($how eq 'ssh-cmd') {
1770         my @cmd =
1771             (access_cfg_ssh, access_gituserhost(),
1772              access_runeinfo("git-check $package").
1773              " set -e; cd ".access_cfg('git-path').";".
1774              " if test -d $package.git; then echo 1; else echo 0; fi");
1775         my $r= cmdoutput @cmd;
1776         if (defined $r and $r =~ m/^divert (\w+)$/) {
1777             my $divert=$1;
1778             my ($usedistro,) = access_distros();
1779             # NB that if we are pushing, $usedistro will be $distro/push
1780             $instead_distro= cfg("dgit-distro.$usedistro.diverts.$divert");
1781             $instead_distro =~ s{^/}{ access_basedistro()."/" }e;
1782             progress f_ "diverting to %s (using config for %s)",
1783                         $divert, $instead_distro;
1784             return check_for_git();
1785         }
1786         failedcmd @cmd unless defined $r and $r =~ m/^[01]$/;
1787         return $r+0;
1788     } elsif ($how eq 'url') {
1789         my $prefix = access_cfg('git-check-url','git-url');
1790         my $suffix = access_cfg('git-check-suffix','git-suffix',
1791                                 'RETURN-UNDEF') // '.git';
1792         my $url = "$prefix/$package$suffix";
1793         my $result = url_fetch $url,
1794             CurlOpts => { CURLOPT_NOBODY() => 1 },
1795             Ok404 => 1,
1796             AccessBase => 'git-check';
1797         $result = defined $result;
1798         printdebug "dgit-repos check_for_git => $result.\n";
1799         return $result;
1800     } elsif ($how eq 'true') {
1801         return 1;
1802     } elsif ($how eq 'false') {
1803         return 0;
1804     } else {
1805         badcfg f_ "unknown git-check \`%s'", $how;
1806     }
1807 }
1808
1809 sub create_remote_git_repo () {
1810     my $how = access_cfg('git-create');
1811     if ($how eq 'ssh-cmd') {
1812         runcmd_ordryrun
1813             (access_cfg_ssh, access_gituserhost(),
1814              access_runeinfo("git-create $package").
1815              "set -e; cd ".access_cfg('git-path').";".
1816              " cp -a _template $package.git");
1817     } elsif ($how eq 'true') {
1818         # nothing to do
1819     } else {
1820         badcfg f_ "unknown git-create \`%s'", $how;
1821     }
1822 }
1823
1824 our ($dsc_hash,$lastpush_mergeinput);
1825 our ($dsc_distro, $dsc_hint_tag, $dsc_hint_url);
1826
1827
1828 sub prep_ud () {
1829     dgit_privdir(); # ensures that $dgit_privdir_made is based on $maindir
1830     $playground = fresh_playground 'dgit/unpack';
1831 }
1832
1833 sub mktree_in_ud_here () {
1834     playtree_setup();
1835 }
1836
1837 sub git_write_tree () {
1838     my $tree = cmdoutput @git, qw(write-tree);
1839     $tree =~ m/^\w+$/ or die "$tree ?";
1840     return $tree;
1841 }
1842
1843 sub git_add_write_tree () {
1844     runcmd @git, qw(add -Af .);
1845     return git_write_tree();
1846 }
1847
1848 sub remove_stray_gits ($) {
1849     my ($what) = @_;
1850     my @gitscmd = qw(find -name .git -prune -print0);
1851     debugcmd "|",@gitscmd;
1852     open GITS, "-|", @gitscmd or confess "$!";
1853     {
1854         local $/="\0";
1855         while (<GITS>) {
1856             chomp or die;
1857             print STDERR f_ "%s: warning: removing from %s: %s\n",
1858                 $us, $what, (messagequote $_);
1859             rmtree $_;
1860         }
1861     }
1862     $!=0; $?=0; close GITS or failedcmd @gitscmd;
1863 }
1864
1865 sub mktree_in_ud_from_only_subdir ($;$) {
1866     my ($what,$raw) = @_;
1867     # changes into the subdir
1868
1869     my (@dirs) = <*/.>;
1870     confess "expected one subdir but found @dirs ?" unless @dirs==1;
1871     $dirs[0] =~ m#^([^/]+)/\.$# or die;
1872     my $dir = $1;
1873     changedir $dir;
1874
1875     remove_stray_gits($what);
1876     mktree_in_ud_here();
1877     if (!$raw) {
1878         my ($format, $fopts) = get_source_format();
1879         if (madformat($format)) {
1880             rmtree '.pc';
1881         }
1882     }
1883
1884     my $tree=git_add_write_tree();
1885     return ($tree,$dir);
1886 }
1887
1888 our @files_csum_info_fields = 
1889     (['Checksums-Sha256','Digest::SHA', 'new(256)', 'sha256sum'],
1890      ['Checksums-Sha1',  'Digest::SHA', 'new(1)',   'sha1sum'],
1891      ['Files',           'Digest::MD5', 'new()',    'md5sum']);
1892
1893 sub dsc_files_info () {
1894     foreach my $csumi (@files_csum_info_fields) {
1895         my ($fname, $module, $method) = @$csumi;
1896         my $field = $dsc->{$fname};
1897         next unless defined $field;
1898         eval "use $module; 1;" or die $@;
1899         my @out;
1900         foreach (split /\n/, $field) {
1901             next unless m/\S/;
1902             m/^(\w+) (\d+) (\S+)$/ or
1903                 fail f_ "could not parse .dsc %s line \`%s'", $fname, $_;
1904             my $digester = eval "$module"."->$method;" or die $@;
1905             push @out, {
1906                 Hash => $1,
1907                 Bytes => $2,
1908                 Filename => $3,
1909                 Digester => $digester,
1910             };
1911         }
1912         return @out;
1913     }
1914     fail f_ "missing any supported Checksums-* or Files field in %s",
1915             $dsc->get_option('name');
1916 }
1917
1918 sub dsc_files () {
1919     map { $_->{Filename} } dsc_files_info();
1920 }
1921
1922 sub files_compare_inputs (@) {
1923     my $inputs = \@_;
1924     my %record;
1925     my %fchecked;
1926
1927     my $showinputs = sub {
1928         return join "; ", map { $_->get_option('name') } @$inputs;
1929     };
1930
1931     foreach my $in (@$inputs) {
1932         my $expected_files;
1933         my $in_name = $in->get_option('name');
1934
1935         printdebug "files_compare_inputs $in_name\n";
1936
1937         foreach my $csumi (@files_csum_info_fields) {
1938             my ($fname) = @$csumi;
1939             printdebug "files_compare_inputs $in_name $fname\n";
1940
1941             my $field = $in->{$fname};
1942             next unless defined $field;
1943
1944             my @files;
1945             foreach (split /\n/, $field) {
1946                 next unless m/\S/;
1947
1948                 my ($info, $f) = m/^(\w+ \d+) (?:\S+ \S+ )?(\S+)$/ or
1949                     fail "could not parse $in_name $fname line \`$_'";
1950
1951                 printdebug "files_compare_inputs $in_name $fname $f\n";
1952
1953                 push @files, $f;
1954
1955                 my $re = \ $record{$f}{$fname};
1956                 if (defined $$re) {
1957                     $fchecked{$f}{$in_name} = 1;
1958                     $$re eq $info or
1959                         fail f_
1960               "hash or size of %s varies in %s fields (between: %s)",
1961                                  $f, $fname, $showinputs->();
1962                 } else {
1963                     $$re = $info;
1964                 }
1965             }
1966             @files = sort @files;
1967             $expected_files //= \@files;
1968             "@$expected_files" eq "@files" or
1969                 fail f_ "file list in %s varies between hash fields!",
1970                         $in_name;
1971         }
1972         $expected_files or
1973             fail f_ "%s has no files list field(s)", $in_name;
1974     }
1975     printdebug "files_compare_inputs ".Dumper(\%fchecked, \%record)
1976         if $debuglevel>=2;
1977
1978     grep { keys %$_ == @$inputs-1 } values %fchecked
1979         or fail f_ "no file appears in all file lists (looked in: %s)",
1980                    $showinputs->();
1981 }
1982
1983 sub is_orig_file_in_dsc ($$) {
1984     my ($f, $dsc_files_info) = @_;
1985     return 0 if @$dsc_files_info <= 1;
1986     # One file means no origs, and the filename doesn't have a "what
1987     # part of dsc" component.  (Consider versions ending `.orig'.)
1988     return 0 unless $f =~ m/\.$orig_f_tail_re$/o;
1989     return 1;
1990 }
1991
1992 # This function determines whether a .changes file is source-only from
1993 # the point of view of dak.  Thus, it permits *_source.buildinfo
1994 # files.
1995 #
1996 # It does not, however, permit any other buildinfo files.  After a
1997 # source-only upload, the buildds will try to upload files like
1998 # foo_1.2.3_amd64.buildinfo.  If the package maintainer included files
1999 # named like this in their (otherwise) source-only upload, the uploads
2000 # of the buildd can be rejected by dak.  Fixing the resultant
2001 # situation can require manual intervention.  So we block such
2002 # .buildinfo files when the user tells us to perform a source-only
2003 # upload (such as when using the push-source subcommand with the -C
2004 # option, which calls this function).
2005 #
2006 # Note, though, that when dgit is told to prepare a source-only
2007 # upload, such as when subcommands like build-source and push-source
2008 # without -C are used, dgit has a more restrictive notion of
2009 # source-only .changes than dak: such uploads will never include
2010 # *_source.buildinfo files.  This is because there is no use for such
2011 # files when using a tool like dgit to produce the source package, as
2012 # dgit ensures the source is identical to git HEAD.
2013 sub test_source_only_changes ($) {
2014     my ($changes) = @_;
2015     foreach my $l (split /\n/, getfield $changes, 'Files') {
2016         $l =~ m/\S+$/ or next;
2017         # \.tar\.[a-z0-9]+ covers orig.tar and the tarballs in native packages
2018         unless ($& =~ m/(?:\.dsc|\.diff\.gz|\.tar\.[a-z0-9]+|_source\.buildinfo)$/) {
2019             print f_ "purportedly source-only changes polluted by %s\n", $&;
2020             return 0;
2021         }
2022     }
2023     return 1;
2024 }
2025
2026 sub changes_update_origs_from_dsc ($$$$) {
2027     my ($dsc, $changes, $upstreamvsn, $changesfile) = @_;
2028     my %changes_f;
2029     printdebug "checking origs needed ($upstreamvsn)...\n";
2030     $_ = getfield $changes, 'Files';
2031     m/^\w+ \d+ (\S+ \S+) \S+$/m or
2032         fail __ "cannot find section/priority from .changes Files field";
2033     my $placementinfo = $1;
2034     my %changed;
2035     printdebug "checking origs needed placement '$placementinfo'...\n";
2036     foreach my $l (split /\n/, getfield $dsc, 'Files') {
2037         $l =~ m/\S+$/ or next;
2038         my $file = $&;
2039         printdebug "origs $file | $l\n";
2040         next unless is_orig_file_of_vsn $file, $upstreamvsn;
2041         printdebug "origs $file is_orig\n";
2042         my $have = archive_query('file_in_archive', $file);
2043         if (!defined $have) {
2044             print STDERR __ <<END;
2045 archive does not support .orig check; hope you used --ch:--sa/-sd if needed
2046 END
2047             return;
2048         }
2049         my $found_same = 0;
2050         my @found_differ;
2051         printdebug "origs $file \$#\$have=$#$have\n";
2052         foreach my $h (@$have) {
2053             my $same = 0;
2054             my @differ;
2055             foreach my $csumi (@files_csum_info_fields) {
2056                 my ($fname, $module, $method, $archivefield) = @$csumi;
2057                 next unless defined $h->{$archivefield};
2058                 $_ = $dsc->{$fname};
2059                 next unless defined;
2060                 m/^(\w+) .* \Q$file\E$/m or
2061                     fail f_ ".dsc %s missing entry for %s", $fname, $file;
2062                 if ($h->{$archivefield} eq $1) {
2063                     $same++;
2064                 } else {
2065                     push @differ, f_
2066                         "%s: %s (archive) != %s (local .dsc)",
2067                         $archivefield, $h->{$archivefield}, $1;
2068                 }
2069             }
2070             confess "$file ".Dumper($h)." ?!" if $same && @differ;
2071             $found_same++
2072                 if $same;
2073             push @found_differ,
2074                 f_ "archive %s: %s", $h->{filename}, join "; ", @differ
2075                 if @differ;
2076         }
2077         printdebug "origs $file f.same=$found_same".
2078             " #f._differ=$#found_differ\n";
2079         if (@found_differ && !$found_same) {
2080             fail join "\n",
2081                 (f_ "archive contains %s with different checksum", $file),
2082                 @found_differ;
2083         }
2084         # Now we edit the changes file to add or remove it
2085         foreach my $csumi (@files_csum_info_fields) {
2086             my ($fname, $module, $method, $archivefield) = @$csumi;
2087             next unless defined $changes->{$fname};
2088             if ($found_same) {
2089                 # in archive, delete from .changes if it's there
2090                 $changed{$file} = "removed" if
2091                     $changes->{$fname} =~ s/\n.* \Q$file\E$(?:)$//m;
2092             } elsif ($changes->{$fname} =~ m/^.* \Q$file\E$(?:)$/m) {
2093                 # not in archive, but it's here in the .changes
2094             } else {
2095                 my $dsc_data = getfield $dsc, $fname;
2096                 $dsc_data =~ m/^(.* \Q$file\E$)$/m or die "$dsc_data $file ?";
2097                 my $extra = $1;
2098                 $extra =~ s/ \d+ /$&$placementinfo /
2099                     or confess "$fname $extra >$dsc_data< ?"
2100                     if $fname eq 'Files';
2101                 $changes->{$fname} .= "\n". $extra;
2102                 $changed{$file} = "added";
2103             }
2104         }
2105     }
2106     if (%changed) {
2107         foreach my $file (keys %changed) {
2108             progress f_
2109                 "edited .changes for archive .orig contents: %s %s",
2110                 $changed{$file}, $file;
2111         }
2112         my $chtmp = "$changesfile.tmp";
2113         $changes->save($chtmp);
2114         if (act_local()) {
2115             rename $chtmp,$changesfile or die "$changesfile $!";
2116         } else {
2117             progress f_ "[new .changes left in %s]", $changesfile;
2118         }
2119     } else {
2120         progress f_ "%s already has appropriate .orig(s) (if any)",
2121                     $changesfile;
2122     }
2123 }
2124
2125 sub clogp_authline ($) {
2126     my ($clogp) = @_;
2127     my $author = getfield $clogp, 'Maintainer';
2128     if ($author =~ m/^[^"\@]+\,/) {
2129         # single entry Maintainer field with unquoted comma
2130         $author = ($& =~ y/,//rd).$'; # strip the comma
2131     }
2132     # git wants a single author; any remaining commas in $author
2133     # are by now preceded by @ (or ").  It seems safer to punt on
2134     # "..." for now rather than attempting to dequote or something.
2135     $author =~ s#,.*##ms unless $author =~ m/"/;
2136     my $date = cmdoutput qw(date), '+%s %z', qw(-d), getfield($clogp,'Date');
2137     my $authline = "$author $date";
2138     $authline =~ m/$git_authline_re/o or
2139         fail f_ "unexpected commit author line format \`%s'".
2140                 " (was generated from changelog Maintainer field)",
2141                 $authline;
2142     return ($1,$2,$3) if wantarray;
2143     return $authline;
2144 }
2145
2146 sub vendor_patches_distro ($$) {
2147     my ($checkdistro, $what) = @_;
2148     return unless defined $checkdistro;
2149
2150     my $series = "debian/patches/\L$checkdistro\E.series";
2151     printdebug "checking for vendor-specific $series ($what)\n";
2152
2153     if (!open SERIES, "<", $series) {
2154         confess "$series $!" unless $!==ENOENT;
2155         return;
2156     }
2157     while (<SERIES>) {
2158         next unless m/\S/;
2159         next if m/^\s+\#/;
2160
2161         print STDERR __ <<END;
2162
2163 Unfortunately, this source package uses a feature of dpkg-source where
2164 the same source package unpacks to different source code on different
2165 distros.  dgit cannot safely operate on such packages on affected
2166 distros, because the meaning of source packages is not stable.
2167
2168 Please ask the distro/maintainer to remove the distro-specific series
2169 files and use a different technique (if necessary, uploading actually
2170 different packages, if different distros are supposed to have
2171 different code).
2172
2173 END
2174         fail f_ "Found active distro-specific series file for".
2175                 " %s (%s): %s, cannot continue",
2176                 $checkdistro, $what, $series;
2177     }
2178     die "$series $!" if SERIES->error;
2179     close SERIES;
2180 }
2181
2182 sub check_for_vendor_patches () {
2183     # This dpkg-source feature doesn't seem to be documented anywhere!
2184     # But it can be found in the changelog (reformatted):
2185
2186     #   commit  4fa01b70df1dc4458daee306cfa1f987b69da58c
2187     #   Author: Raphael Hertzog <hertzog@debian.org>
2188     #   Date: Sun  Oct  3  09:36:48  2010 +0200
2189
2190     #   dpkg-source: correctly create .pc/.quilt_series with alternate
2191     #   series files
2192     #   
2193     #   If you have debian/patches/ubuntu.series and you were
2194     #   unpacking the source package on ubuntu, quilt was still
2195     #   directed to debian/patches/series instead of
2196     #   debian/patches/ubuntu.series.
2197     #   
2198     #   debian/changelog                        |    3 +++
2199     #   scripts/Dpkg/Source/Package/V3/quilt.pm |    4 +++-
2200     #   2 files changed, 6 insertions(+), 1 deletion(-)
2201
2202     use Dpkg::Vendor;
2203     vendor_patches_distro($ENV{DEB_VENDOR}, "DEB_VENDOR");
2204     vendor_patches_distro(Dpkg::Vendor::get_current_vendor(),
2205                           __ "Dpkg::Vendor \`current vendor'");
2206     vendor_patches_distro(access_basedistro(),
2207                           __ "(base) distro being accessed");
2208     vendor_patches_distro(access_nomdistro(),
2209                           __ "(nominal) distro being accessed");
2210 }
2211
2212 sub check_bpd_exists () {
2213     stat $buildproductsdir
2214         or fail f_ "build-products-dir %s is not accessible: %s\n",
2215         $buildproductsdir, $!;
2216 }
2217
2218 sub dotdot_bpd_transfer_origs ($$$) {
2219     my ($bpd_abs, $upstreamversion, $wanted) = @_;
2220     # checks is_orig_file_of_vsn and if
2221     # calls $wanted->{$leaf} and expects boolish
2222
2223     return if $buildproductsdir eq '..';
2224
2225     my $warned;
2226     my $dotdot = $maindir;
2227     $dotdot =~ s{/[^/]+$}{};
2228     opendir DD, $dotdot or fail "opendir .. ($dotdot): $!";
2229     while ($!=0, defined(my $leaf = readdir DD)) {
2230         {
2231             local ($debuglevel) = $debuglevel-1;
2232             printdebug "DD_BPD $leaf ?\n";
2233         }
2234         next unless is_orig_file_of_vsn $leaf, $upstreamversion;
2235         next unless $wanted->($leaf);
2236         next if lstat "$bpd_abs/$leaf";
2237
2238         print STDERR f_
2239  "%s: found orig(s) in .. missing from build-products-dir, transferring:\n",
2240             $us
2241             unless $warned++;
2242         $! == &ENOENT or fail f_
2243             "check orig file %s in bpd %s: %s", $leaf, $bpd_abs, $!;
2244         lstat "$dotdot/$leaf" or fail f_
2245             "check orig file %s in ..: %s", $leaf, $!;
2246         if (-l _) {
2247             stat "$dotdot/$leaf" or fail f_
2248                 "check target of orig symlink %s in ..: %s", $leaf, $!;
2249             my $ltarget = readlink "$dotdot/$leaf" or
2250                 die "readlink $dotdot/$leaf: $!";
2251             if ($ltarget !~ m{^/}) {
2252                 $ltarget = "$dotdot/$ltarget";
2253             }
2254             symlink $ltarget, "$bpd_abs/$leaf"
2255                 or die "$ltarget $bpd_abs $leaf: $!";
2256             print STDERR f_
2257  "%s: cloned orig symlink from ..: %s\n",
2258                 $us, $leaf;
2259         } elsif (link "$dotdot/$leaf", "$bpd_abs/$leaf") {
2260             print STDERR f_
2261  "%s: hardlinked orig from ..: %s\n",
2262                 $us, $leaf;
2263         } elsif ($! != EXDEV) {
2264             fail f_ "failed to make %s a hardlink to %s: %s",
2265                 "$bpd_abs/$leaf", "$dotdot/$leaf", $!;
2266         } else {
2267             symlink "$bpd_abs/$leaf", "$dotdot/$leaf"
2268                 or die "$bpd_abs $dotdot $leaf $!";
2269             print STDERR f_
2270  "%s: symmlinked orig from .. on other filesystem: %s\n",
2271                 $us, $leaf;
2272         }
2273     }
2274     die "$dotdot; $!" if $!;
2275     closedir DD;
2276 }
2277
2278 sub import_tarball_tartrees ($$) {
2279     my ($upstreamv, $dfi) = @_;
2280     # cwd should be the playground
2281
2282     # We unpack and record the orig tarballs first, so that we only
2283     # need disk space for one private copy of the unpacked source.
2284     # But we can't make them into commits until we have the metadata
2285     # from the debian/changelog, so we record the tree objects now and
2286     # make them into commits later.
2287     my @tartrees;
2288     my $orig_f_base = srcfn $upstreamv, '';
2289
2290     foreach my $fi (@$dfi) {
2291         # We actually import, and record as a commit, every tarball
2292         # (unless there is only one file, in which case there seems
2293         # little point.
2294
2295         my $f = $fi->{Filename};
2296         printdebug "import considering $f ";
2297         (printdebug "not tar\n"), next unless $f =~ m/\.tar(\.\w+)?$/;
2298         (printdebug "signature\n"), next if $f =~ m/$orig_f_sig_re$/o;
2299         my $compr_ext = $1;
2300
2301         my ($orig_f_part) =
2302             $f =~ m/^\Q$orig_f_base\E\.([^._]+)?\.tar(?:\.\w+)?$/;
2303
2304         printdebug "Y ", (join ' ', map { $_//"(none)" }
2305                           $compr_ext, $orig_f_part
2306                          ), "\n";
2307
2308         my $path = $fi->{Path} // $f;
2309         my $input = new IO::File $f, '<' or die "$f $!";
2310         my $compr_pid;
2311         my @compr_cmd;
2312
2313         if (defined $compr_ext) {
2314             my $cname =
2315                 Dpkg::Compression::compression_guess_from_filename $f;
2316             fail "Dpkg::Compression cannot handle file $f in source package"
2317                 if defined $compr_ext && !defined $cname;
2318             my $compr_proc =
2319                 new Dpkg::Compression::Process compression => $cname;
2320             @compr_cmd = $compr_proc->get_uncompress_cmdline();
2321             my $compr_fh = new IO::Handle;
2322             my $compr_pid = open $compr_fh, "-|" // confess "$!";
2323             if (!$compr_pid) {
2324                 open STDIN, "<&", $input or confess "$!";
2325                 exec @compr_cmd;
2326                 die "dgit (child): exec $compr_cmd[0]: $!\n";
2327             }
2328             $input = $compr_fh;
2329         }
2330
2331         rmtree "_unpack-tar";
2332         mkdir "_unpack-tar" or confess "$!";
2333         my @tarcmd = qw(tar -x -f -
2334                         --no-same-owner --no-same-permissions
2335                         --no-acls --no-xattrs --no-selinux);
2336         my $tar_pid = fork // confess "$!";
2337         if (!$tar_pid) {
2338             chdir "_unpack-tar" or confess "$!";
2339             open STDIN, "<&", $input or confess "$!";
2340             exec @tarcmd;
2341             die f_ "dgit (child): exec %s: %s", $tarcmd[0], $!;
2342         }
2343         $!=0; (waitpid $tar_pid, 0) == $tar_pid or confess "$!";
2344         !$? or failedcmd @tarcmd;
2345
2346         close $input or
2347             (@compr_cmd ? ($?==SIGPIPE || failedcmd @compr_cmd)
2348              : confess "$!");
2349         # finally, we have the results in "tarball", but maybe
2350         # with the wrong permissions
2351
2352         runcmd qw(chmod -R +rwX _unpack-tar);
2353         changedir "_unpack-tar";
2354         remove_stray_gits($f);
2355         mktree_in_ud_here();
2356         
2357         my ($tree) = git_add_write_tree();
2358         my $tentries = cmdoutput @git, qw(ls-tree -z), $tree;
2359         if ($tentries =~ m/^\d+ tree (\w+)\t[^\000]+\000$/s) {
2360             $tree = $1;
2361             printdebug "one subtree $1\n";
2362         } else {
2363             printdebug "multiple subtrees\n";
2364         }
2365         changedir "..";
2366         rmtree "_unpack-tar";
2367
2368         my $ent = [ $f, $tree ];
2369         push @tartrees, {
2370             Orig => !!$orig_f_part,
2371             Sort => (!$orig_f_part         ? 2 :
2372                      $orig_f_part =~ m/-/g ? 1 :
2373                                              0),
2374             OrigPart => $orig_f_part, # 'orig', 'orig-XXX', or undef 
2375             F => $f,
2376             Tree => $tree,
2377         };
2378     }
2379
2380     @tartrees = sort {
2381         # put any without "_" first (spec is not clear whether files
2382         # are always in the usual order).  Tarballs without "_" are
2383         # the main orig or the debian tarball.
2384         $a->{Sort} <=> $b->{Sort} or
2385         $a->{F}    cmp $b->{F}
2386     } @tartrees;
2387
2388     @tartrees;
2389 }
2390
2391 sub import_tarball_commits ($$) {
2392     my ($tartrees, $upstreamv) = @_;
2393     # cwd should be a playtree which has a relevant debian/changelog
2394     # fills in $tt->{Commit} for each one
2395
2396     my $any_orig = grep { $_->{Orig} } @$tartrees;
2397
2398     my @clogcmd = qw(dpkg-parsechangelog --format rfc822 --all);
2399     my $clogp;
2400     my $r1clogp;
2401
2402     printdebug "import clog search...\n";
2403     parsechangelog_loop \@clogcmd, (__ "package changelog"), sub {
2404         my ($thisstanza, $desc) = @_;
2405         no warnings qw(exiting);
2406
2407         $clogp //= $thisstanza;
2408
2409         printdebug "import clog $thisstanza->{version} $desc...\n";
2410
2411         last if !$any_orig; # we don't need $r1clogp
2412
2413         # We look for the first (most recent) changelog entry whose
2414         # version number is lower than the upstream version of this
2415         # package.  Then the last (least recent) previous changelog
2416         # entry is treated as the one which introduced this upstream
2417         # version and used for the synthetic commits for the upstream
2418         # tarballs.
2419
2420         # One might think that a more sophisticated algorithm would be
2421         # necessary.  But: we do not want to scan the whole changelog
2422         # file.  Stopping when we see an earlier version, which
2423         # necessarily then is an earlier upstream version, is the only
2424         # realistic way to do that.  Then, either the earliest
2425         # changelog entry we have seen so far is indeed the earliest
2426         # upload of this upstream version; or there are only changelog
2427         # entries relating to later upstream versions (which is not
2428         # possible unless the changelog and .dsc disagree about the
2429         # version).  Then it remains to choose between the physically
2430         # last entry in the file, and the one with the lowest version
2431         # number.  If these are not the same, we guess that the
2432         # versions were created in a non-monotonic order rather than
2433         # that the changelog entries have been misordered.
2434
2435         printdebug "import clog $thisstanza->{version} vs $upstreamv...\n";
2436
2437         last if version_compare($thisstanza->{version}, $upstreamv) < 0;
2438         $r1clogp = $thisstanza;
2439
2440         printdebug "import clog $r1clogp->{version} becomes r1\n";
2441     };
2442
2443     $clogp or fail __ "package changelog has no entries!";
2444
2445     my $authline = clogp_authline $clogp;
2446     my $changes = getfield $clogp, 'Changes';
2447     $changes =~ s/^\n//; # Changes: \n
2448     my $cversion = getfield $clogp, 'Version';
2449
2450     my $r1authline;
2451     if (@$tartrees) {
2452         $r1clogp //= $clogp; # maybe there's only one entry;
2453         $r1authline = clogp_authline $r1clogp;
2454         # Strictly, r1authline might now be wrong if it's going to be
2455         # unused because !$any_orig.  Whatever.
2456
2457         printdebug "import tartrees authline   $authline\n";
2458         printdebug "import tartrees r1authline $r1authline\n";
2459
2460         foreach my $tt (@$tartrees) {
2461             printdebug "import tartree $tt->{F} $tt->{Tree}\n";
2462
2463             # untranslated so that different people's imports are identical
2464             my $mbody = sprintf "Import %s", $tt->{F};
2465             $tt->{Commit} = hash_commit_text($tt->{Orig} ? <<END_O : <<END_T);
2466 tree $tt->{Tree}
2467 author $r1authline
2468 committer $r1authline
2469
2470 $mbody
2471
2472 [dgit import orig $tt->{F}]
2473 END_O
2474 tree $tt->{Tree}
2475 author $authline
2476 committer $authline
2477
2478 $mbody
2479
2480 [dgit import tarball $package $cversion $tt->{F}]
2481 END_T
2482         }
2483     }
2484
2485     return ($authline, $r1authline, $clogp, $changes);
2486 }
2487
2488 sub generate_commits_from_dsc () {
2489     # See big comment in fetch_from_archive, below.
2490     # See also README.dsc-import.
2491     prep_ud();
2492     changedir $playground;
2493
2494     my $bpd_abs = bpd_abs();
2495     my $upstreamv = upstreamversion $dsc->{version};
2496     my @dfi = dsc_files_info();
2497
2498     dotdot_bpd_transfer_origs $bpd_abs, $upstreamv,
2499         sub { grep { $_->{Filename} eq $_[0] } @dfi };
2500
2501     foreach my $fi (@dfi) {
2502         my $f = $fi->{Filename};
2503         die "$f ?" if $f =~ m#/|^\.|\.dsc$|\.tmp$#;
2504         my $upper_f = "$bpd_abs/$f";
2505
2506         printdebug "considering reusing $f: ";
2507
2508         if (link_ltarget "$upper_f,fetch", $f) {
2509             printdebug "linked (using ...,fetch).\n";
2510         } elsif ((printdebug "($!) "),
2511                  $! != ENOENT) {
2512             fail f_ "accessing %s: %s", "$buildproductsdir/$f,fetch", $!;
2513         } elsif (link_ltarget $upper_f, $f) {
2514             printdebug "linked.\n";
2515         } elsif ((printdebug "($!) "),
2516                  $! != ENOENT) {
2517             fail f_ "accessing %s: %s", "$buildproductsdir/$f", $!;
2518         } else {
2519             printdebug "absent.\n";
2520         }
2521
2522         my $refetched;
2523         complete_file_from_dsc('.', $fi, \$refetched)
2524             or next;
2525
2526         printdebug "considering saving $f: ";
2527
2528         if (rename_link_xf 1, $f, $upper_f) {
2529             printdebug "linked.\n";
2530         } elsif ((printdebug "($@) "),
2531                  $! != EEXIST) {
2532             fail f_ "saving %s: %s", "$buildproductsdir/$f", $@;
2533         } elsif (!$refetched) {
2534             printdebug "no need.\n";
2535         } elsif (rename_link_xf 1, $f, "$upper_f,fetch") {
2536             printdebug "linked (using ...,fetch).\n";
2537         } elsif ((printdebug "($@) "),
2538                  $! != EEXIST) {
2539             fail f_ "saving %s: %s", "$buildproductsdir/$f,fetch", $@;
2540         } else {
2541             printdebug "cannot.\n";
2542         }
2543     }
2544
2545     my @tartrees;
2546     @tartrees = import_tarball_tartrees($upstreamv, \@dfi)
2547         unless @dfi == 1; # only one file in .dsc
2548
2549     my $dscfn = "$package.dsc";
2550
2551     my $treeimporthow = 'package';
2552
2553     open D, ">", $dscfn or die "$dscfn: $!";
2554     print D $dscdata or die "$dscfn: $!";
2555     close D or die "$dscfn: $!";
2556     my @cmd = qw(dpkg-source);
2557     push @cmd, '--no-check' if $dsc_checked;
2558     if (madformat $dsc->{format}) {
2559         push @cmd, '--skip-patches';
2560         $treeimporthow = 'unpatched';
2561     }
2562     push @cmd, qw(-x --), $dscfn;
2563     runcmd @cmd;
2564
2565     my ($tree,$dir) = mktree_in_ud_from_only_subdir(__ "source package");
2566     if (madformat $dsc->{format}) { 
2567         check_for_vendor_patches();
2568     }
2569
2570     my $dappliedtree;
2571     if (madformat $dsc->{format}) {
2572         my @pcmd = qw(dpkg-source --before-build .);
2573         runcmd shell_cmd 'exec >/dev/null', @pcmd;
2574         rmtree '.pc';
2575         $dappliedtree = git_add_write_tree();
2576     }
2577
2578     my ($authline, $r1authline, $clogp, $changes) =
2579         import_tarball_commits(\@tartrees, $upstreamv);
2580
2581     my $cversion = getfield $clogp, 'Version';
2582
2583     printdebug "import main commit\n";
2584
2585     open C, ">../commit.tmp" or confess "$!";
2586     print C <<END or confess "$!";
2587 tree $tree
2588 END
2589     print C <<END or confess "$!" foreach @tartrees;
2590 parent $_->{Commit}
2591 END
2592     print C <<END or confess "$!";
2593 author $authline
2594 committer $authline
2595
2596 $changes
2597
2598 [dgit import $treeimporthow $package $cversion]
2599 END
2600
2601     close C or confess "$!";
2602     my $rawimport_hash = hash_commit qw(../commit.tmp);
2603
2604     if (madformat $dsc->{format}) {
2605         printdebug "import apply patches...\n";
2606
2607         # regularise the state of the working tree so that
2608         # the checkout of $rawimport_hash works nicely.
2609         my $dappliedcommit = hash_commit_text(<<END);
2610 tree $dappliedtree
2611 author $authline
2612 committer $authline
2613
2614 [dgit dummy commit]
2615 END
2616         runcmd @git, qw(checkout -q -b dapplied), $dappliedcommit;
2617
2618         runcmd @git, qw(checkout -q -b unpa), $rawimport_hash;
2619
2620         # We need the answers to be reproducible
2621         my @authline = clogp_authline($clogp);
2622         local $ENV{GIT_COMMITTER_NAME} =  $authline[0];
2623         local $ENV{GIT_COMMITTER_EMAIL} = $authline[1];
2624         local $ENV{GIT_COMMITTER_DATE} =  $authline[2];
2625         local $ENV{GIT_AUTHOR_NAME} =  $authline[0];
2626         local $ENV{GIT_AUTHOR_EMAIL} = $authline[1];
2627         local $ENV{GIT_AUTHOR_DATE} =  $authline[2];
2628
2629         my $path = $ENV{PATH} or die;
2630
2631         # we use ../../gbp-pq-output, which (given that we are in
2632         # $playground/PLAYTREE, and $playground is .git/dgit/unpack,
2633         # is .git/dgit.
2634
2635         foreach my $use_absurd (qw(0 1)) {
2636             runcmd @git, qw(checkout -q unpa);
2637             runcmd @git, qw(update-ref -d refs/heads/patch-queue/unpa);
2638             local $ENV{PATH} = $path;
2639             if ($use_absurd) {
2640                 chomp $@;
2641                 progress "warning: $@";
2642                 $path = "$absurdity:$path";
2643                 progress f_ "%s: trying slow absurd-git-apply...", $us;
2644                 rename "../../gbp-pq-output","../../gbp-pq-output.0"
2645                     or $!==ENOENT
2646                     or confess "$!";
2647             }
2648             eval {
2649                 die "forbid absurd git-apply\n" if $use_absurd
2650                     && forceing [qw(import-gitapply-no-absurd)];
2651                 die "only absurd git-apply!\n" if !$use_absurd
2652                     && forceing [qw(import-gitapply-absurd)];
2653
2654                 local $ENV{DGIT_ABSURD_DEBUG} = $debuglevel if $use_absurd;
2655                 local $ENV{PATH} = $path                    if $use_absurd;
2656
2657                 my @showcmd = (gbp_pq, qw(import));
2658                 my @realcmd = shell_cmd
2659                     'exec >/dev/null 2>>../../gbp-pq-output', @showcmd;
2660                 debugcmd "+",@realcmd;
2661                 if (system @realcmd) {
2662                     die f_ "%s failed: %s\n",
2663                         +(shellquote @showcmd),
2664                         failedcmd_waitstatus();
2665                 }
2666
2667                 my $gapplied = git_rev_parse('HEAD');
2668                 my $gappliedtree = cmdoutput @git, qw(rev-parse HEAD:);
2669                 $gappliedtree eq $dappliedtree or
2670                     fail f_ <<END, $gapplied, $gappliedtree, $dappliedtree;
2671 gbp-pq import and dpkg-source disagree!
2672  gbp-pq import gave commit %s
2673  gbp-pq import gave tree %s
2674  dpkg-source --before-build gave tree %s
2675 END
2676                 $rawimport_hash = $gapplied;
2677             };
2678             last unless $@;
2679         }
2680         if ($@) {
2681             { local $@; eval { runcmd qw(cat ../../gbp-pq-output); }; }
2682             die $@;
2683         }
2684     }
2685
2686     progress f_ "synthesised git commit from .dsc %s", $cversion;
2687
2688     my $rawimport_mergeinput = {
2689         Commit => $rawimport_hash,
2690         Info => __ "Import of source package",
2691     };
2692     my @output = ($rawimport_mergeinput);
2693
2694     if ($lastpush_mergeinput) {
2695         my $oldclogp = mergeinfo_getclogp($lastpush_mergeinput);
2696         my $oversion = getfield $oldclogp, 'Version';
2697         my $vcmp =
2698             version_compare($oversion, $cversion);
2699         if ($vcmp < 0) {
2700             @output = ($rawimport_mergeinput, $lastpush_mergeinput,
2701                 { ReverseParents => 1,
2702                   # untranslated so that different people's pseudomerges
2703                   # are not needlessly different (although they will
2704                   # still differ if the series of pulls is different)
2705                   Message => (sprintf <<END, $package, $cversion, $csuite) });
2706 Record %s (%s) in archive suite %s
2707 END
2708         } elsif ($vcmp > 0) {
2709             print STDERR f_ <<END, $cversion, $oversion,
2710
2711 Version actually in archive:   %s (older)
2712 Last version pushed with dgit: %s (newer or same)
2713 %s
2714 END
2715                 __ $later_warning_msg or confess "$!";
2716             @output = $lastpush_mergeinput;
2717         } else {
2718             # Same version.  Use what's in the server git branch,
2719             # discarding our own import.  (This could happen if the
2720             # server automatically imports all packages into git.)
2721             @output = $lastpush_mergeinput;
2722         }
2723     }
2724     changedir $maindir;
2725     rmtree $playground;
2726     return @output;
2727 }
2728
2729 sub complete_file_from_dsc ($$;$) {
2730     our ($dstdir, $fi, $refetched) = @_;
2731     # Ensures that we have, in $dstdir, the file $fi, with the correct
2732     # contents.  (Downloading it from alongside $dscurl if necessary.)
2733     # If $refetched is defined, can overwrite "$dstdir/$fi->{Filename}"
2734     # and will set $$refetched=1 if it did so (or tried to).
2735
2736     my $f = $fi->{Filename};
2737     my $tf = "$dstdir/$f";
2738     my $downloaded = 0;
2739
2740     my $got;
2741     my $checkhash = sub {
2742         open F, "<", "$tf" or die "$tf: $!";
2743         $fi->{Digester}->reset();
2744         $fi->{Digester}->addfile(*F);
2745         F->error and confess "$!";
2746         $got = $fi->{Digester}->hexdigest();
2747         return $got eq $fi->{Hash};
2748     };
2749
2750     if (stat_exists $tf) {
2751         if ($checkhash->()) {
2752             progress f_ "using existing %s", $f;
2753             return 1;
2754         }
2755         if (!$refetched) {
2756             fail f_ "file %s has hash %s but .dsc demands hash %s".
2757                     " (perhaps you should delete this file?)",
2758                     $f, $got, $fi->{Hash};
2759         }
2760         progress f_ "need to fetch correct version of %s", $f;
2761         unlink $tf or die "$tf $!";
2762         $$refetched = 1;
2763     } else {
2764         printdebug "$tf does not exist, need to fetch\n";
2765     }
2766
2767     my $furl = $dscurl;
2768     $furl =~ s{/[^/]+$}{};
2769     $furl .= "/$f";
2770     die "$f ?" unless $f =~ m/^\Q${package}\E_/;
2771     die "$f ?" if $f =~ m#/#;
2772     runcmd_ordryrun_local @curl,qw(-f -o),$tf,'--',"$furl";
2773     return 0 if !act_local();
2774
2775     $checkhash->() or
2776         fail f_ "file %s has hash %s but .dsc demands hash %s".
2777                 " (got wrong file from archive!)",
2778                 $f, $got, $fi->{Hash};
2779
2780     return 1;
2781 }
2782
2783 sub ensure_we_have_orig () {
2784     my @dfi = dsc_files_info();
2785     foreach my $fi (@dfi) {
2786         my $f = $fi->{Filename};
2787         next unless is_orig_file_in_dsc($f, \@dfi);
2788         complete_file_from_dsc($buildproductsdir, $fi)
2789             or next;
2790     }
2791 }
2792
2793 #---------- git fetch ----------
2794
2795 sub lrfetchrefs () { return "refs/dgit-fetch/".access_basedistro(); }
2796 sub lrfetchref () { return lrfetchrefs.'/'.server_branch($csuite); }
2797
2798 # We fetch some parts of lrfetchrefs/*.  Ideally we delete these
2799 # locally fetched refs because they have unhelpful names and clutter
2800 # up gitk etc.  So we track whether we have "used up" head ref (ie,
2801 # whether we have made another local ref which refers to this object).
2802 #
2803 # (If we deleted them unconditionally, then we might end up
2804 # re-fetching the same git objects each time dgit fetch was run.)
2805 #
2806 # So, each use of lrfetchrefs needs to be accompanied by arrangements
2807 # in git_fetch_us to fetch the refs in question, and possibly a call
2808 # to lrfetchref_used.
2809
2810 our (%lrfetchrefs_f, %lrfetchrefs_d);
2811 # $lrfetchrefs_X{lrfetchrefs."/heads/whatever"} = $objid
2812
2813 sub lrfetchref_used ($) {
2814     my ($fullrefname) = @_;
2815     my $objid = $lrfetchrefs_f{$fullrefname};
2816     $lrfetchrefs_d{$fullrefname} = $objid if defined $objid;
2817 }
2818
2819 sub git_lrfetch_sane {
2820     my ($url, $supplementary, @specs) = @_;
2821     # Make a 'refs/'.lrfetchrefs.'/*' be just like on server,
2822     # at least as regards @specs.  Also leave the results in
2823     # %lrfetchrefs_f, and arrange for lrfetchref_used to be
2824     # able to clean these up.
2825     #
2826     # With $supplementary==1, @specs must not contain wildcards
2827     # and we add to our previous fetches (non-atomically).
2828
2829     # This is rather miserable:
2830     # When git fetch --prune is passed a fetchspec ending with a *,
2831     # it does a plausible thing.  If there is no * then:
2832     # - it matches subpaths too, even if the supplied refspec
2833     #   starts refs, and behaves completely madly if the source
2834     #   has refs/refs/something.  (See, for example, Debian #NNNN.)
2835     # - if there is no matching remote ref, it bombs out the whole
2836     #   fetch.
2837     # We want to fetch a fixed ref, and we don't know in advance
2838     # if it exists, so this is not suitable.
2839     #
2840     # Our workaround is to use git ls-remote.  git ls-remote has its
2841     # own qairks.  Notably, it has the absurd multi-tail-matching
2842     # behaviour: git ls-remote R refs/foo can report refs/foo AND
2843     # refs/refs/foo etc.
2844     #
2845     # Also, we want an idempotent snapshot, but we have to make two
2846     # calls to the remote: one to git ls-remote and to git fetch.  The
2847     # solution is use git ls-remote to obtain a target state, and
2848     # git fetch to try to generate it.  If we don't manage to generate
2849     # the target state, we try again.
2850
2851     printdebug "git_lrfetch_sane suppl=$supplementary specs @specs\n";
2852
2853     my $specre = join '|', map {
2854         my $x = $_;
2855         $x =~ s/\W/\\$&/g;
2856         my $wildcard = $x =~ s/\\\*$/.*/;
2857         die if $wildcard && $supplementary;
2858         "(?:refs/$x)";
2859     } @specs;
2860     printdebug "git_lrfetch_sane specre=$specre\n";
2861     my $wanted_rref = sub {
2862         local ($_) = @_;
2863         return m/^(?:$specre)$/;
2864     };
2865
2866     my $fetch_iteration = 0;
2867     FETCH_ITERATION:
2868     for (;;) {
2869         printdebug "git_lrfetch_sane iteration $fetch_iteration\n";
2870         if (++$fetch_iteration > 10) {
2871             fail __ "too many iterations trying to get sane fetch!";
2872         }
2873
2874         my @look = map { "refs/$_" } @specs;
2875         my @lcmd = (@git, qw(ls-remote -q --refs), $url, @look);
2876         debugcmd "|",@lcmd;
2877
2878         my %wantr;
2879         open GITLS, "-|", @lcmd or confess "$!";
2880         while (<GITLS>) {
2881             printdebug "=> ", $_;
2882             m/^(\w+)\s+(\S+)\n/ or die "ls-remote $_ ?";
2883             my ($objid,$rrefname) = ($1,$2);
2884             if (!$wanted_rref->($rrefname)) {
2885                 print STDERR f_ <<END, "@look", $rrefname;
2886 warning: git ls-remote %s reported %s; this is silly, ignoring it.
2887 END
2888                 next;
2889             }
2890             $wantr{$rrefname} = $objid;
2891         }
2892         $!=0; $?=0;
2893         close GITLS or failedcmd @lcmd;
2894
2895         # OK, now %want is exactly what we want for refs in @specs
2896         my @fspecs = map {
2897             !m/\*$/ && !exists $wantr{"refs/$_"} ? () :
2898             "+refs/$_:".lrfetchrefs."/$_";
2899         } @specs;
2900
2901         printdebug "git_lrfetch_sane fspecs @fspecs\n";
2902
2903         my @fcmd = (@git, qw(fetch -p -n -q), $url, @fspecs);
2904         runcmd_ordryrun_local @fcmd if @fspecs;
2905
2906         if (!$supplementary) {
2907             %lrfetchrefs_f = ();
2908         }
2909         my %objgot;
2910
2911         git_for_each_ref(lrfetchrefs, sub {
2912             my ($objid,$objtype,$lrefname,$reftail) = @_;
2913             $lrfetchrefs_f{$lrefname} = $objid;
2914             $objgot{$objid} = 1;
2915         });
2916
2917         if ($supplementary) {
2918             last;
2919         }
2920
2921         foreach my $lrefname (sort keys %lrfetchrefs_f) {
2922             my $rrefname = 'refs'.substr($lrefname, length lrfetchrefs);
2923             if (!exists $wantr{$rrefname}) {
2924                 if ($wanted_rref->($rrefname)) {
2925                     printdebug <<END;
2926 git-fetch @fspecs created $lrefname which git ls-remote @look didn't list.
2927 END
2928                 } else {
2929                     print STDERR f_ <<END, "@fspecs", $lrefname
2930 warning: git fetch %s created %s; this is silly, deleting it.
2931 END
2932                 }
2933                 runcmd_ordryrun_local @git, qw(update-ref -d), $lrefname;
2934                 delete $lrfetchrefs_f{$lrefname};
2935                 next;
2936             }
2937         }
2938         foreach my $rrefname (sort keys %wantr) {
2939             my $lrefname = lrfetchrefs.substr($rrefname, 4);
2940             my $got = $lrfetchrefs_f{$lrefname} // '<none>';
2941             my $want = $wantr{$rrefname};
2942             next if $got eq $want;
2943             if (!defined $objgot{$want}) {
2944                 fail __ <<END unless act_local();
2945 --dry-run specified but we actually wanted the results of git fetch,
2946 so this is not going to work.  Try running dgit fetch first,
2947 or using --damp-run instead of --dry-run.
2948 END
2949                 print STDERR f_ <<END, $lrefname, $want;
2950 warning: git ls-remote suggests we want %s
2951 warning:  and it should refer to %s
2952 warning:  but git fetch didn't fetch that object to any relevant ref.
2953 warning:  This may be due to a race with someone updating the server.
2954 warning:  Will try again...
2955 END
2956                 next FETCH_ITERATION;
2957             }
2958             printdebug <<END;
2959 git-fetch @fspecs made $lrefname=$got but want git ls-remote @look says $want
2960 END
2961             runcmd_ordryrun_local @git, qw(update-ref -m),
2962                 "dgit fetch git fetch fixup", $lrefname, $want;
2963             $lrfetchrefs_f{$lrefname} = $want;
2964         }
2965         last;
2966     }
2967
2968     if (defined $csuite) {
2969         printdebug "git_lrfetch_sane: tidying any old suite lrfetchrefs\n";
2970         git_for_each_ref("refs/dgit-fetch/$csuite", sub {
2971             my ($objid,$objtype,$lrefname,$reftail) = @_;
2972             next if $lrfetchrefs_f{$lrefname}; # $csuite eq $distro ?
2973             runcmd_ordryrun_local @git, qw(update-ref -d), $lrefname;
2974         });
2975     }
2976
2977     printdebug "git_lrfetch_sane: git fetch --no-insane emulation complete\n",
2978         Dumper(\%lrfetchrefs_f);
2979 }
2980
2981 sub git_fetch_us () {
2982     # Want to fetch only what we are going to use, unless
2983     # deliberately-not-ff, in which case we must fetch everything.
2984
2985     my @specs = deliberately_not_fast_forward ? qw(tags/*) :
2986         map { "tags/$_" } debiantags('*',access_nomdistro);
2987     push @specs, server_branch($csuite);
2988     push @specs, $rewritemap;
2989     push @specs, qw(heads/*) if deliberately_not_fast_forward;
2990
2991     my $url = access_giturl();
2992     git_lrfetch_sane $url, 0, @specs;
2993
2994     my %here;
2995     my @tagpats = debiantags('*',access_nomdistro);
2996
2997     git_for_each_ref([map { "refs/tags/$_" } @tagpats], sub {
2998         my ($objid,$objtype,$fullrefname,$reftail) = @_;
2999         printdebug "currently $fullrefname=$objid\n";
3000         $here{$fullrefname} = $objid;
3001     });
3002     git_for_each_ref([map { lrfetchrefs."/tags/".$_ } @tagpats], sub {
3003         my ($objid,$objtype,$fullrefname,$reftail) = @_;
3004         my $lref = "refs".substr($fullrefname, length(lrfetchrefs));
3005         printdebug "offered $lref=$objid\n";
3006         if (!defined $here{$lref}) {
3007             my @upd = (@git, qw(update-ref), $lref, $objid, '');
3008             runcmd_ordryrun_local @upd;
3009             lrfetchref_used $fullrefname;
3010         } elsif ($here{$lref} eq $objid) {
3011             lrfetchref_used $fullrefname;
3012         } else {
3013             print STDERR f_ "Not updating %s from %s to %s.\n",
3014                             $lref, $here{$lref}, $objid;
3015         }
3016     });
3017 }
3018
3019 #---------- dsc and archive handling ----------
3020
3021 sub mergeinfo_getclogp ($) {
3022     # Ensures thit $mi->{Clogp} exists and returns it
3023     my ($mi) = @_;
3024     $mi->{Clogp} = commit_getclogp($mi->{Commit});
3025 }
3026
3027 sub mergeinfo_version ($) {
3028     return getfield( (mergeinfo_getclogp $_[0]), 'Version' );
3029 }
3030
3031 sub fetch_from_archive_record_1 ($) {
3032     my ($hash) = @_;
3033     runcmd git_update_ref_cmd "dgit fetch $csuite", 'DGIT_ARCHIVE', $hash;
3034     cmdoutput @git, qw(log -n2), $hash;
3035     # ... gives git a chance to complain if our commit is malformed
3036 }
3037
3038 sub fetch_from_archive_record_2 ($) {
3039     my ($hash) = @_;
3040     my @upd_cmd = (git_update_ref_cmd 'dgit fetch', lrref(), $hash);
3041     if (act_local()) {
3042         cmdoutput @upd_cmd;
3043     } else {
3044         dryrun_report @upd_cmd;
3045     }
3046 }
3047
3048 sub parse_dsc_field_def_dsc_distro () {
3049     $dsc_distro //= cfg qw(dgit.default.old-dsc-distro
3050                            dgit.default.distro);
3051 }
3052
3053 sub parse_dsc_field ($$) {
3054     my ($dsc, $what) = @_;
3055     my $f;
3056     foreach my $field (@ourdscfield) {
3057         $f = $dsc->{$field};
3058         last if defined $f;
3059     }
3060
3061     if (!defined $f) {
3062         progress f_ "%s: NO git hash", $what;
3063         parse_dsc_field_def_dsc_distro();
3064     } elsif (($dsc_hash, $dsc_distro, $dsc_hint_tag, $dsc_hint_url)
3065              = $f =~ m/^(\w+)\s+($distro_re)\s+($versiontag_re)\s+(\S+)(?:\s|$)/) {
3066         progress f_ "%s: specified git info (%s)", $what, $dsc_distro;
3067         $dsc_hint_tag = [ $dsc_hint_tag ];
3068     } elsif ($f =~ m/^\w+\s*$/) {
3069         $dsc_hash = $&;
3070         parse_dsc_field_def_dsc_distro();
3071         $dsc_hint_tag = [ debiantags +(getfield $dsc, 'Version'),
3072                           $dsc_distro ];
3073         progress f_ "%s: specified git hash", $what;
3074     } else {
3075         fail f_ "%s: invalid Dgit info", $what;
3076     }
3077 }
3078
3079 sub resolve_dsc_field_commit ($$) {
3080     my ($already_distro, $already_mapref) = @_;
3081
3082     return unless defined $dsc_hash;
3083
3084     my $mapref =
3085         defined $already_mapref &&
3086         ($already_distro eq $dsc_distro || !$chase_dsc_distro)
3087         ? $already_mapref : undef;
3088
3089     my $do_fetch;
3090     $do_fetch = sub {
3091         my ($what, @fetch) = @_;
3092
3093         local $idistro = $dsc_distro;
3094         my $lrf = lrfetchrefs;
3095
3096         if (!$chase_dsc_distro) {
3097             progress f_ "not chasing .dsc distro %s: not fetching %s",
3098                         $dsc_distro, $what;
3099             return 0;
3100         }
3101
3102         progress f_ ".dsc names distro %s: fetching %s", $dsc_distro, $what;
3103
3104         my $url = access_giturl();
3105         if (!defined $url) {
3106             defined $dsc_hint_url or fail f_ <<END, $dsc_distro;
3107 .dsc Dgit metadata is in context of distro %s
3108 for which we have no configured url and .dsc provides no hint
3109 END
3110             my $proto =
3111                 $dsc_hint_url =~ m#^([-+0-9a-zA-Z]+):# ? $1 :
3112                 $dsc_hint_url =~ m#^/# ? 'file' : 'bad-syntax';
3113             parse_cfg_bool "dsc-url-proto-ok", 'false',
3114                 cfg("dgit.dsc-url-proto-ok.$proto",
3115                     "dgit.default.dsc-url-proto-ok")
3116                 or fail f_ <<END, $dsc_distro, $proto;
3117 .dsc Dgit metadata is in context of distro %s
3118 for which we have no configured url;
3119 .dsc provides hinted url with protocol %s which is unsafe.
3120 (can be overridden by config - consult documentation)
3121 END
3122             $url = $dsc_hint_url;
3123         }
3124
3125         git_lrfetch_sane $url, 1, @fetch;
3126
3127         return $lrf;
3128     };
3129
3130     my $rewrite_enable = do {
3131         local $idistro = $dsc_distro;
3132         access_cfg('rewrite-map-enable', 'RETURN-UNDEF');
3133     };
3134
3135     if (parse_cfg_bool 'rewrite-map-enable', 'true', $rewrite_enable) {
3136         if (!defined $mapref) {
3137             my $lrf = $do_fetch->((__ "rewrite map"), $rewritemap) or return;
3138             $mapref = $lrf.'/'.$rewritemap;
3139         }
3140         my $rewritemapdata = git_cat_file $mapref.':map';
3141         if (defined $rewritemapdata
3142             && $rewritemapdata =~ m/^$dsc_hash(?:[ \t](\w+))/m) {
3143             progress __
3144                 "server's git history rewrite map contains a relevant entry!";
3145
3146             $dsc_hash = $1;
3147             if (defined $dsc_hash) {
3148                 progress __ "using rewritten git hash in place of .dsc value";
3149             } else {
3150                 progress __ "server data says .dsc hash is to be disregarded";
3151             }
3152         }
3153     }
3154
3155     if (!defined git_cat_file $dsc_hash) {
3156         my @tags = map { "tags/".$_ } @$dsc_hint_tag;
3157         my $lrf = $do_fetch->((__ "additional commits"), @tags) &&
3158             defined git_cat_file $dsc_hash
3159             or fail f_ <<END, $dsc_hash;
3160 .dsc Dgit metadata requires commit %s
3161 but we could not obtain that object anywhere.
3162 END
3163         foreach my $t (@tags) {
3164             my $fullrefname = $lrf.'/'.$t;
3165 #           print STDERR "CHK $t $fullrefname ".Dumper(\%lrfetchrefs_f);
3166             next unless $lrfetchrefs_f{$fullrefname};
3167             next unless is_fast_fwd "$fullrefname~0", $dsc_hash;
3168             lrfetchref_used $fullrefname;
3169         }
3170     }
3171 }
3172
3173 sub fetch_from_archive () {
3174     check_bpd_exists();
3175     ensure_setup_existing_tree();
3176
3177     # Ensures that lrref() is what is actually in the archive, one way
3178     # or another, according to us - ie this client's
3179     # appropritaely-updated archive view.  Also returns the commit id.
3180     # If there is nothing in the archive, leaves lrref alone and
3181     # returns undef.  git_fetch_us must have already been called.
3182     get_archive_dsc();
3183
3184     if ($dsc) {
3185         parse_dsc_field($dsc, __ 'last upload to archive');
3186         resolve_dsc_field_commit access_basedistro,
3187             lrfetchrefs."/".$rewritemap
3188     } else {
3189         progress __ "no version available from the archive";
3190     }
3191
3192     # If the archive's .dsc has a Dgit field, there are three
3193     # relevant git commitids we need to choose between and/or merge
3194     # together:
3195     #   1. $dsc_hash: the Dgit field from the archive
3196     #   2. $lastpush_hash: the suite branch on the dgit git server
3197     #   3. $lastfetch_hash: our local tracking brach for the suite
3198     #
3199     # These may all be distinct and need not be in any fast forward
3200     # relationship:
3201     #
3202     # If the dsc was pushed to this suite, then the server suite
3203     # branch will have been updated; but it might have been pushed to
3204     # a different suite and copied by the archive.  Conversely a more
3205     # recent version may have been pushed with dgit but not appeared
3206     # in the archive (yet).
3207     #
3208     # $lastfetch_hash may be awkward because archive imports
3209     # (particularly, imports of Dgit-less .dscs) are performed only as
3210     # needed on individual clients, so different clients may perform a
3211     # different subset of them - and these imports are only made
3212     # public during push.  So $lastfetch_hash may represent a set of
3213     # imports different to a subsequent upload by a different dgit
3214     # client.
3215     #
3216     # Our approach is as follows:
3217     #
3218     # As between $dsc_hash and $lastpush_hash: if $lastpush_hash is a
3219     # descendant of $dsc_hash, then it was pushed by a dgit user who
3220     # had based their work on $dsc_hash, so we should prefer it.
3221     # Otherwise, $dsc_hash was installed into this suite in the
3222     # archive other than by a dgit push, and (necessarily) after the
3223     # last dgit push into that suite (since a dgit push would have
3224     # been descended from the dgit server git branch); thus, in that
3225     # case, we prefer the archive's version (and produce a
3226     # pseudo-merge to overwrite the dgit server git branch).
3227     #
3228     # (If there is no Dgit field in the archive's .dsc then
3229     # generate_commit_from_dsc uses the version numbers to decide
3230     # whether the suite branch or the archive is newer.  If the suite
3231     # branch is newer it ignores the archive's .dsc; otherwise it
3232     # generates an import of the .dsc, and produces a pseudo-merge to
3233     # overwrite the suite branch with the archive contents.)
3234     #
3235     # The outcome of that part of the algorithm is the `public view',
3236     # and is same for all dgit clients: it does not depend on any
3237     # unpublished history in the local tracking branch.
3238     #
3239     # As between the public view and the local tracking branch: The
3240     # local tracking branch is only updated by dgit fetch, and
3241     # whenever dgit fetch runs it includes the public view in the
3242     # local tracking branch.  Therefore if the public view is not
3243     # descended from the local tracking branch, the local tracking
3244     # branch must contain history which was imported from the archive
3245     # but never pushed; and, its tip is now out of date.  So, we make
3246     # a pseudo-merge to overwrite the old imports and stitch the old
3247     # history in.
3248     #
3249     # Finally: we do not necessarily reify the public view (as
3250     # described above).  This is so that we do not end up stacking two
3251     # pseudo-merges.  So what we actually do is figure out the inputs
3252     # to any public view pseudo-merge and put them in @mergeinputs.
3253
3254     my @mergeinputs;
3255     # $mergeinputs[]{Commit}
3256     # $mergeinputs[]{Info}
3257     # $mergeinputs[0] is the one whose tree we use
3258     # @mergeinputs is in the order we use in the actual commit)
3259     #
3260     # Also:
3261     # $mergeinputs[]{Message} is a commit message to use
3262     # $mergeinputs[]{ReverseParents} if def specifies that parent
3263     #                                list should be in opposite order
3264     # Such an entry has no Commit or Info.  It applies only when found
3265     # in the last entry.  (This ugliness is to support making
3266     # identical imports to previous dgit versions.)
3267
3268     my $lastpush_hash = git_get_ref(lrfetchref());
3269     printdebug "previous reference hash=$lastpush_hash\n";
3270     $lastpush_mergeinput = $lastpush_hash && {
3271         Commit => $lastpush_hash,
3272         Info => (__ "dgit suite branch on dgit git server"),
3273     };
3274
3275     my $lastfetch_hash = git_get_ref(lrref());
3276     printdebug "fetch_from_archive: lastfetch=$lastfetch_hash\n";
3277     my $lastfetch_mergeinput = $lastfetch_hash && {
3278         Commit => $lastfetch_hash,
3279         Info => (__ "dgit client's archive history view"),
3280     };
3281
3282     my $dsc_mergeinput = $dsc_hash && {
3283         Commit => $dsc_hash,
3284         Info => (__ "Dgit field in .dsc from archive"),
3285     };
3286
3287     my $cwd = getcwd();
3288     my $del_lrfetchrefs = sub {
3289         changedir $cwd;
3290         my $gur;
3291         printdebug "del_lrfetchrefs...\n";
3292         foreach my $fullrefname (sort keys %lrfetchrefs_d) {
3293             my $objid = $lrfetchrefs_d{$fullrefname};
3294             printdebug "del_lrfetchrefs: $objid $fullrefname\n";
3295             if (!$gur) {
3296                 $gur ||= new IO::Handle;
3297                 open $gur, "|-", qw(git update-ref --stdin) or confess "$!";
3298             }
3299             printf $gur "delete %s %s\n", $fullrefname, $objid;
3300         }
3301         if ($gur) {
3302             close $gur or failedcmd "git update-ref delete lrfetchrefs";
3303         }
3304     };
3305
3306     if (defined $dsc_hash) {
3307         ensure_we_have_orig();
3308         if (!$lastpush_hash || $dsc_hash eq $lastpush_hash) {
3309             @mergeinputs = $dsc_mergeinput
3310         } elsif (is_fast_fwd($dsc_hash,$lastpush_hash)) {
3311             print STDERR f_ <<END, $dsc_hash, $lastpush_hash,
3312
3313 Git commit in archive is behind the last version allegedly pushed/uploaded.
3314 Commit referred to by archive: %s
3315 Last version pushed with dgit: %s
3316 %s
3317 END
3318                 __ $later_warning_msg or confess "$!";
3319             @mergeinputs = ($lastpush_mergeinput);
3320         } else {
3321             # Archive has .dsc which is not a descendant of the last dgit
3322             # push.  This can happen if the archive moves .dscs about.
3323             # Just follow its lead.
3324             if (is_fast_fwd($lastpush_hash,$dsc_hash)) {
3325                 progress __ "archive .dsc names newer git commit";
3326                 @mergeinputs = ($dsc_mergeinput);
3327             } else {
3328                 progress __ "archive .dsc names other git commit, fixing up";
3329                 @mergeinputs = ($dsc_mergeinput, $lastpush_mergeinput);
3330             }
3331         }
3332     } elsif ($dsc) {
3333         @mergeinputs = generate_commits_from_dsc();
3334         # We have just done an import.  Now, our import algorithm might
3335         # have been improved.  But even so we do not want to generate
3336         # a new different import of the same package.  So if the
3337         # version numbers are the same, just use our existing version.
3338         # If the version numbers are different, the archive has changed
3339         # (perhaps, rewound).
3340         if ($lastfetch_mergeinput &&
3341             !version_compare( (mergeinfo_version $lastfetch_mergeinput),
3342                               (mergeinfo_version $mergeinputs[0]) )) {
3343             @mergeinputs = ($lastfetch_mergeinput);
3344         }
3345     } elsif ($lastpush_hash) {
3346         # only in git, not in the archive yet
3347         @mergeinputs = ($lastpush_mergeinput);
3348         print STDERR f_ <<END,
3349
3350 Package not found in the archive, but has allegedly been pushed using dgit.
3351 %s
3352 END
3353             __ $later_warning_msg or confess "$!";
3354     } else {
3355         printdebug "nothing found!\n";
3356         if (defined $skew_warning_vsn) {
3357             print STDERR f_ <<END, $skew_warning_vsn or confess "$!";
3358
3359 Warning: relevant archive skew detected.
3360 Archive allegedly contains %s
3361 But we were not able to obtain any version from the archive or git.
3362
3363 END
3364         }
3365         unshift @end, $del_lrfetchrefs;
3366         return undef;
3367     }
3368
3369     if ($lastfetch_hash &&
3370         !grep {
3371             my $h = $_->{Commit};
3372             $h and is_fast_fwd($lastfetch_hash, $h);
3373             # If true, one of the existing parents of this commit
3374             # is a descendant of the $lastfetch_hash, so we'll
3375             # be ff from that automatically.
3376         } @mergeinputs
3377         ) {
3378         # Otherwise:
3379         push @mergeinputs, $lastfetch_mergeinput;
3380     }
3381
3382     printdebug "fetch mergeinfos:\n";
3383     foreach my $mi (@mergeinputs) {
3384         if ($mi->{Info}) {
3385             printdebug " commit $mi->{Commit} $mi->{Info}\n";
3386         } else {
3387             printdebug sprintf " ReverseParents=%d Message=%s",
3388                 $mi->{ReverseParents}, $mi->{Message};
3389         }
3390     }
3391
3392     my $compat_info= pop @mergeinputs
3393         if $mergeinputs[$#mergeinputs]{Message};
3394
3395     @mergeinputs = grep { defined $_->{Commit} } @mergeinputs;
3396
3397     my $hash;
3398     if (@mergeinputs > 1) {
3399         # here we go, then:
3400         my $tree_commit = $mergeinputs[0]{Commit};
3401
3402         my $tree = get_tree_of_commit $tree_commit;;
3403
3404         # We use the changelog author of the package in question the
3405         # author of this pseudo-merge.  This is (roughly) correct if
3406         # this commit is simply representing aa non-dgit upload.
3407         # (Roughly because it does not record sponsorship - but we
3408         # don't have sponsorship info because that's in the .changes,
3409         # which isn't in the archivw.)
3410         #
3411         # But, it might be that we are representing archive history
3412         # updates (including in-archive copies).  These are not really
3413         # the responsibility of the person who created the .dsc, but
3414         # there is no-one whose name we should better use.  (The
3415         # author of the .dsc-named commit is clearly worse.)
3416
3417         my $useclogp = mergeinfo_getclogp $mergeinputs[0];
3418         my $author = clogp_authline $useclogp;
3419         my $cversion = getfield $useclogp, 'Version';
3420
3421         my $mcf = dgit_privdir()."/mergecommit";
3422         open MC, ">", $mcf or die "$mcf $!";
3423         print MC <<END or confess "$!";
3424 tree $tree
3425 END
3426
3427         my @parents = grep { $_->{Commit} } @mergeinputs;
3428         @parents = reverse @parents if $compat_info->{ReverseParents};
3429         print MC <<END or confess "$!" foreach @parents;
3430 parent $_->{Commit}
3431 END
3432
3433         print MC <<END or confess "$!";
3434 author $author
3435 committer $author
3436
3437 END
3438
3439         if (defined $compat_info->{Message}) {
3440             print MC $compat_info->{Message} or confess "$!";
3441         } else {
3442             print MC f_ <<END, $package, $cversion, $csuite or confess "$!";
3443 Record %s (%s) in archive suite %s
3444
3445 Record that
3446 END
3447             my $message_add_info = sub {
3448                 my ($mi) = (@_);
3449                 my $mversion = mergeinfo_version $mi;
3450                 printf MC "  %-20s %s\n", $mversion, $mi->{Info}
3451                     or confess "$!";
3452             };
3453
3454             $message_add_info->($mergeinputs[0]);
3455             print MC __ <<END or confess "$!";
3456 should be treated as descended from
3457 END
3458             $message_add_info->($_) foreach @mergeinputs[1..$#mergeinputs];
3459         }
3460
3461         close MC or confess "$!";
3462         $hash = hash_commit $mcf;
3463     } else {
3464         $hash = $mergeinputs[0]{Commit};
3465     }
3466     printdebug "fetch hash=$hash\n";
3467
3468     my $chkff = sub {
3469         my ($lasth, $what) = @_;
3470         return unless $lasth;
3471         confess "$lasth $hash $what ?" unless is_fast_fwd($lasth, $hash);
3472     };
3473
3474     $chkff->($lastpush_hash, __ 'dgit repo server tip (last push)')
3475         if $lastpush_hash;
3476     $chkff->($lastfetch_hash, __ 'local tracking tip (last fetch)');
3477
3478     fetch_from_archive_record_1($hash);
3479
3480     if (defined $skew_warning_vsn) {
3481         printdebug "SKEW CHECK WANT $skew_warning_vsn\n";
3482         my $gotclogp = commit_getclogp($hash);
3483         my $got_vsn = getfield $gotclogp, 'Version';
3484         printdebug "SKEW CHECK GOT $got_vsn\n";
3485         if (version_compare($got_vsn, $skew_warning_vsn) < 0) {
3486             print STDERR f_ <<END, $skew_warning_vsn, $got_vsn or confess "$!";
3487
3488 Warning: archive skew detected.  Using the available version:
3489 Archive allegedly contains    %s
3490 We were able to obtain only   %s
3491
3492 END
3493         }
3494     }
3495
3496     if ($lastfetch_hash ne $hash) {
3497         fetch_from_archive_record_2($hash);
3498     }
3499
3500     lrfetchref_used lrfetchref();
3501
3502     check_gitattrs($hash, __ "fetched source tree");
3503
3504     unshift @end, $del_lrfetchrefs;
3505     return $hash;
3506 }
3507
3508 sub set_local_git_config ($$) {
3509     my ($k, $v) = @_;
3510     runcmd @git, qw(config), $k, $v;
3511 }
3512
3513 sub setup_mergechangelogs (;$) {
3514     my ($always) = @_;
3515     return unless $always || access_cfg_bool(1, 'setup-mergechangelogs');
3516
3517     my $driver = 'dpkg-mergechangelogs';
3518     my $cb = "merge.$driver";
3519     confess unless defined $maindir;
3520     my $attrs = "$maindir_gitcommon/info/attributes";
3521     ensuredir "$maindir_gitcommon/info";
3522
3523     open NATTRS, ">", "$attrs.new" or die "$attrs.new $!";
3524     if (!open ATTRS, "<", $attrs) {
3525         $!==ENOENT or die "$attrs: $!";
3526     } else {
3527         while (<ATTRS>) {
3528             chomp;
3529             next if m{^debian/changelog\s};
3530             print NATTRS $_, "\n" or confess "$!";
3531         }
3532         ATTRS->error and confess "$!";
3533         close ATTRS;
3534     }
3535     print NATTRS "debian/changelog merge=$driver\n" or confess "$!";
3536     close NATTRS;
3537
3538     set_local_git_config "$cb.name", __ 'debian/changelog merge driver';
3539     set_local_git_config "$cb.driver", 'dpkg-mergechangelogs -m %O %A %B %A';
3540
3541     rename "$attrs.new", "$attrs" or die "$attrs: $!";
3542 }
3543
3544 sub setup_useremail (;$) {
3545     my ($always) = @_;
3546     return unless $always || access_cfg_bool(1, 'setup-useremail');
3547
3548     my $setup = sub {
3549         my ($k, $envvar) = @_;
3550         my $v = access_cfg("user-$k", 'RETURN-UNDEF') // $ENV{$envvar};
3551         return unless defined $v;
3552         set_local_git_config "user.$k", $v;
3553     };
3554
3555     $setup->('email', 'DEBEMAIL');
3556     $setup->('name', 'DEBFULLNAME');
3557 }
3558
3559 sub ensure_setup_existing_tree () {
3560     my $k = "remote.$remotename.skipdefaultupdate";
3561     my $c = git_get_config $k;
3562     return if defined $c;
3563     set_local_git_config $k, 'true';
3564 }
3565
3566 sub open_main_gitattrs () {
3567     confess 'internal error no maindir' unless defined $maindir;
3568     my $gai = new IO::File "$maindir_gitcommon/info/attributes"
3569         or $!==ENOENT
3570         or die "open $maindir_gitcommon/info/attributes: $!";
3571     return $gai;
3572 }
3573
3574 our $gitattrs_ourmacro_re = qr{^\[attr\]dgit-defuse-attrs\s};
3575
3576 sub is_gitattrs_setup () {
3577     # return values:
3578     #  trueish
3579     #     1: gitattributes set up and should be left alone
3580     #  falseish
3581     #     0: there is a dgit-defuse-attrs but it needs fixing
3582     #     undef: there is none
3583     my $gai = open_main_gitattrs();
3584     return 0 unless $gai;
3585     while (<$gai>) {
3586         next unless m{$gitattrs_ourmacro_re};
3587         return 1 if m{\s-working-tree-encoding\s};
3588         printdebug "is_gitattrs_setup: found old macro\n";
3589         return 0;
3590     }
3591     $gai->error and confess "$!";
3592     printdebug "is_gitattrs_setup: found nothing\n";
3593     return undef;
3594 }    
3595
3596 sub setup_gitattrs (;$) {
3597     my ($always) = @_;
3598     return unless $always || access_cfg_bool(1, 'setup-gitattributes');
3599
3600     my $already = is_gitattrs_setup();
3601     if ($already) {
3602         progress __ <<END;
3603 [attr]dgit-defuse-attrs already found, and proper, in .git/info/attributes
3604  not doing further gitattributes setup
3605 END
3606         return;
3607     }
3608     my $new = "[attr]dgit-defuse-attrs  $negate_harmful_gitattrs";
3609     my $af = "$maindir_gitcommon/info/attributes";
3610     ensuredir "$maindir_gitcommon/info";
3611
3612     open GAO, "> $af.new" or confess "$!";
3613     print GAO <<END, __ <<ENDT or confess "$!" unless defined $already;
3614 *       dgit-defuse-attrs
3615 $new
3616 END
3617 # ^ see GITATTRIBUTES in dgit(7) and dgit setup-new-tree in dgit(1)
3618 ENDT
3619     my $gai = open_main_gitattrs();
3620     if ($gai) {
3621         while (<$gai>) {
3622             if (m{$gitattrs_ourmacro_re}) {
3623                 die unless defined $already;
3624                 $_ = $new;
3625             }
3626             chomp;
3627             print GAO $_, "\n" or confess "$!";
3628         }
3629         $gai->error and confess "$!";
3630     }
3631     close GAO or confess "$!";
3632     rename "$af.new", "$af" or fail f_ "install %s: %s", $af, $!;
3633 }
3634
3635 sub setup_new_tree () {
3636     setup_mergechangelogs();
3637     setup_useremail();
3638     setup_gitattrs();
3639 }
3640
3641 sub check_gitattrs ($$) {
3642     my ($treeish, $what) = @_;
3643
3644     return if is_gitattrs_setup;
3645
3646     local $/="\0";
3647     my @cmd = (@git, qw(ls-tree -lrz --), "${treeish}:");
3648     debugcmd "|",@cmd;
3649     my $gafl = new IO::File;
3650     open $gafl, "-|", @cmd or confess "$!";
3651     while (<$gafl>) {
3652         chomp or die;
3653         s/^\d+\s+\w+\s+\w+\s+(\d+)\t// or die;
3654         next if $1 == 0;
3655         next unless m{(?:^|/)\.gitattributes$};
3656
3657         # oh dear, found one
3658         print STDERR f_ <<END, $what;
3659 dgit: warning: %s contains .gitattributes
3660 dgit: .gitattributes not (fully) defused.  Recommended: dgit setup-new-tree.
3661 END
3662         close $gafl;
3663         return;
3664     }
3665     # tree contains no .gitattributes files
3666     $?=0; $!=0; close $gafl or failedcmd @cmd;
3667 }
3668
3669
3670 sub multisuite_suite_child ($$$) {
3671     my ($tsuite, $mergeinputs, $fn) = @_;
3672     # in child, sets things up, calls $fn->(), and returns undef
3673     # in parent, returns canonical suite name for $tsuite
3674     my $canonsuitefh = IO::File::new_tmpfile;
3675     my $pid = fork // confess "$!";
3676     if (!$pid) {
3677         forkcheck_setup();
3678         $isuite = $tsuite;
3679         $us .= " [$isuite]";
3680         $debugprefix .= " ";
3681         progress f_ "fetching %s...", $tsuite;
3682         canonicalise_suite();
3683         print $canonsuitefh $csuite, "\n" or confess "$!";
3684         close $canonsuitefh or confess "$!";
3685         $fn->();
3686         return undef;
3687     }
3688     waitpid $pid,0 == $pid or confess "$!";
3689     fail f_ "failed to obtain %s: %s", $tsuite, waitstatusmsg()
3690         if $? && $?!=256*4;
3691     seek $canonsuitefh,0,0 or confess "$!";
3692     local $csuite = <$canonsuitefh>;
3693     confess "$!" unless defined $csuite && chomp $csuite;
3694     if ($? == 256*4) {
3695         printdebug "multisuite $tsuite missing\n";
3696         return $csuite;
3697     }
3698     printdebug "multisuite $tsuite ok (canon=$csuite)\n";
3699     push @$mergeinputs, {
3700         Ref => lrref,
3701         Info => $csuite,
3702     };
3703     return $csuite;
3704 }
3705
3706 sub fork_for_multisuite ($) {
3707     my ($before_fetch_merge) = @_;
3708     # if nothing unusual, just returns ''
3709     #
3710     # if multisuite:
3711     # returns 0 to caller in child, to do first of the specified suites
3712     # in child, $csuite is not yet set
3713     #
3714     # returns 1 to caller in parent, to finish up anything needed after
3715     # in parent, $csuite is set to canonicalised portmanteau
3716
3717     my $org_isuite = $isuite;
3718     my @suites = split /\,/, $isuite;
3719     return '' unless @suites > 1;
3720     printdebug "fork_for_multisuite: @suites\n";
3721
3722     my @mergeinputs;
3723
3724     my $cbasesuite = multisuite_suite_child($suites[0], \@mergeinputs,
3725                                             sub { });
3726     return 0 unless defined $cbasesuite;
3727
3728     fail f_ "package %s missing in (base suite) %s", $package, $cbasesuite
3729         unless @mergeinputs;
3730
3731     my @csuites = ($cbasesuite);
3732
3733     $before_fetch_merge->();
3734
3735     foreach my $tsuite (@suites[1..$#suites]) {
3736         $tsuite =~ s/^-/$cbasesuite-/;
3737         my $csubsuite = multisuite_suite_child($tsuite, \@mergeinputs,
3738                                                sub {
3739             @end = ();
3740             fetch_one();
3741             finish 0;
3742         });
3743
3744         $csubsuite =~ s/^\Q$cbasesuite\E-/-/;
3745         push @csuites, $csubsuite;
3746     }
3747
3748     foreach my $mi (@mergeinputs) {
3749         my $ref = git_get_ref $mi->{Ref};
3750         die "$mi->{Ref} ?" unless length $ref;
3751         $mi->{Commit} = $ref;
3752     }
3753
3754     $csuite = join ",", @csuites;
3755
3756     my $previous = git_get_ref lrref;
3757     if ($previous) {
3758         unshift @mergeinputs, {
3759             Commit => $previous,
3760             Info => (__ "local combined tracking branch"),
3761             Warning => (__
3762  "archive seems to have rewound: local tracking branch is ahead!"),
3763         };
3764     }
3765
3766     foreach my $ix (0..$#mergeinputs) {
3767         $mergeinputs[$ix]{Index} = $ix;
3768     }
3769
3770     @mergeinputs = sort {
3771         -version_compare(mergeinfo_version $a,
3772                          mergeinfo_version $b) # highest version first
3773             or
3774         $a->{Index} <=> $b->{Index}; # earliest in spec first
3775     } @mergeinputs;
3776
3777     my @needed;
3778
3779   NEEDED:
3780     foreach my $mi (@mergeinputs) {
3781         printdebug "multisuite merge check $mi->{Info}\n";
3782         foreach my $previous (@needed) {
3783             next unless is_fast_fwd $mi->{Commit}, $previous->{Commit};
3784             printdebug "multisuite merge un-needed $previous->{Info}\n";
3785             next NEEDED;
3786         }
3787         push @needed, $mi;
3788         printdebug "multisuite merge this-needed\n";
3789         $mi->{Character} = '+';
3790     }
3791
3792     $needed[0]{Character} = '*';
3793
3794     my $output = $needed[0]{Commit};
3795
3796     if (@needed > 1) {
3797         printdebug "multisuite merge nontrivial\n";
3798         my $tree = cmdoutput qw(git rev-parse), $needed[0]{Commit}.':';
3799
3800         my $commit = "tree $tree\n";
3801         my $msg = f_ "Combine archive branches %s [dgit]\n\n".
3802                      "Input branches:\n",
3803                      $csuite;
3804
3805         foreach my $mi (sort { $a->{Index} <=> $b->{Index} } @mergeinputs) {
3806             printdebug "multisuite merge include $mi->{Info}\n";
3807             $mi->{Character} //= ' ';
3808             $commit .= "parent $mi->{Commit}\n";
3809             $msg .= sprintf " %s  %-25s %s\n",
3810                 $mi->{Character},
3811                 (mergeinfo_version $mi),
3812                 $mi->{Info};
3813         }
3814         my $authline = clogp_authline mergeinfo_getclogp $needed[0];
3815         $msg .= __ "\nKey\n".
3816             " * marks the highest version branch, which choose to use\n".
3817             " + marks each branch which was not already an ancestor\n\n";
3818         $msg .=
3819             "[dgit multi-suite $csuite]\n";
3820         $commit .=
3821             "author $authline\n".
3822             "committer $authline\n\n";
3823         $output = hash_commit_text $commit.$msg;
3824         printdebug "multisuite merge generated $output\n";
3825     }
3826
3827     fetch_from_archive_record_1($output);
3828     fetch_from_archive_record_2($output);
3829
3830     progress f_ "calculated combined tracking suite %s", $csuite;
3831
3832     return 1;
3833 }
3834
3835 sub clone_set_head () {
3836     open H, "> .git/HEAD" or confess "$!";
3837     print H "ref: ".lref()."\n" or confess "$!";
3838     close H or confess "$!";
3839 }
3840 sub clone_finish ($) {
3841     my ($dstdir) = @_;
3842     runcmd @git, qw(reset --hard), lrref();
3843     runcmd qw(bash -ec), <<'END';
3844         set -o pipefail
3845         git ls-tree -r --name-only -z HEAD | \
3846         xargs -0r touch -h -r . --
3847 END
3848     printdone f_ "ready for work in %s", $dstdir;
3849 }
3850
3851 sub vcs_git_url_of_ctrl ($) {
3852     my ($ctrl) = @_;
3853     my $vcsgiturl = $ctrl->{'Vcs-Git'};
3854     if (length $vcsgiturl) {
3855         $vcsgiturl =~ s/\s+-b\s+\S+//g;
3856     }
3857     return $vcsgiturl;
3858 }
3859
3860 sub clone ($) {
3861     # in multisuite, returns twice!
3862     # once in parent after first suite fetched,
3863     # and then again in child after everything is finished
3864     my ($dstdir) = @_;
3865     badusage __ "dry run makes no sense with clone" unless act_local();
3866
3867     my $multi_fetched = fork_for_multisuite(sub {
3868         printdebug "multi clone before fetch merge\n";
3869         changedir $dstdir;
3870         record_maindir();
3871     });
3872     if ($multi_fetched) {
3873         printdebug "multi clone after fetch merge\n";
3874         clone_set_head();
3875         clone_finish($dstdir);
3876         return;
3877     }
3878     printdebug "clone main body\n";
3879
3880     mkdir $dstdir or fail f_ "create \`%s': %s", $dstdir, $!;
3881     changedir $dstdir;
3882     check_bpd_exists();
3883
3884     canonicalise_suite();
3885     my $hasgit = check_for_git();
3886
3887     runcmd @git, qw(init -q);
3888     record_maindir();
3889     setup_new_tree();
3890     clone_set_head();
3891     if ($hasgit) {
3892         progress __ "fetching existing git history";
3893         git_fetch_us();
3894     } else {
3895         progress __ "starting new git history";
3896     }
3897     fetch_from_archive() or no_such_package;
3898     my $vcsgiturl = vcs_git_url_of_ctrl $dsc;
3899     if (length $vcsgiturl) {
3900         runcmd @git, qw(remote add vcs-git), $vcsgiturl;
3901     }
3902     clone_finish($dstdir);
3903 }
3904
3905 sub fetch_one () {
3906     canonicalise_suite();
3907     if (check_for_git()) {
3908         git_fetch_us();
3909     }
3910     fetch_from_archive() or no_such_package();
3911     
3912     my $vcsgiturl = $dsc && $dsc->{'Vcs-Git'};
3913     if (length $vcsgiturl and
3914         (grep { $csuite eq $_ }
3915          split /\;/,
3916          cfg 'dgit.vcs-git.suites')) {
3917         my $current = cfg 'remote.vcs-git.url', 'RETURN-UNDEF';
3918         if (defined $current && $current ne $vcsgiturl) {
3919             print STDERR f_ <<END, $csuite;
3920 FYI: Vcs-Git in %s has different url to your vcs-git remote.
3921  Your vcs-git remote url may be out of date.  Use dgit update-vcs-git ?
3922 END
3923         }
3924     }
3925     printdone f_ "fetched into %s", lrref();
3926 }
3927
3928 sub dofetch () {
3929     my $multi_fetched = fork_for_multisuite(sub { });
3930     fetch_one() unless $multi_fetched; # parent
3931     finish 0 if $multi_fetched eq '0'; # child
3932 }
3933
3934 sub pull () {
3935     dofetch();
3936     runcmd_ordryrun_local @git, qw(merge -m),
3937         (f_ "Merge from %s [dgit]", $csuite),
3938         lrref();
3939     printdone f_ "fetched to %s and merged into HEAD", lrref();
3940 }
3941
3942 sub check_not_dirty () {
3943     my @forbid = qw(local-options local-patch-header);
3944     @forbid = map { "debian/source/$_" } @forbid;
3945     foreach my $f (@forbid) {
3946         if (stat_exists $f) {
3947             fail f_ "git tree contains %s", $f;
3948         }
3949     }
3950
3951     my @cmd = (@git, qw(status -uall --ignored --porcelain));
3952     push @cmd, qw(debian/source/format debian/source/options);
3953     push @cmd, @forbid;
3954
3955     my $bad = cmdoutput @cmd;
3956     if (length $bad) {
3957         fail +(__
3958  "you have uncommitted changes to critical files, cannot continue:\n").
3959               $bad;
3960     }
3961
3962     return if $includedirty;
3963
3964     git_check_unmodified();
3965 }
3966
3967 sub commit_admin ($) {
3968     my ($m) = @_;
3969     progress "$m";
3970     runcmd_ordryrun_local @git, qw(commit -m), $m;
3971 }
3972
3973 sub quiltify_nofix_bail ($$) {
3974     my ($headinfo, $xinfo) = @_;
3975     if ($quilt_mode eq 'nofix') {
3976         fail f_
3977             "quilt fixup required but quilt mode is \`nofix'\n".
3978             "HEAD commit%s differs from tree implied by debian/patches%s",
3979             $headinfo, $xinfo;
3980     }
3981 }
3982
3983 sub commit_quilty_patch () {
3984     my $output = cmdoutput @git, qw(status --ignored --porcelain);
3985     my %adds;
3986     foreach my $l (split /\n/, $output) {
3987         next unless $l =~ m/\S/;
3988         if ($l =~ m{^(?:[?!][?!]| [MADRC]) (.pc|debian/patches)}) {
3989             $adds{$1}++;
3990         }
3991     }
3992     delete $adds{'.pc'}; # if there wasn't one before, don't add it
3993     if (!%adds) {
3994         progress __ "nothing quilty to commit, ok.";
3995         return;
3996     }
3997     quiltify_nofix_bail "", __ " (wanted to commit patch update)";
3998     my @adds = map { s/[][*?\\]/\\$&/g; $_; } sort keys %adds;
3999     runcmd_ordryrun_local @git, qw(add -f), @adds;
4000     commit_admin +(__ <<ENDT).<<END
4001 Commit Debian 3.0 (quilt) metadata
4002
4003 ENDT
4004 [dgit ($our_version) quilt-fixup]
4005 END
4006 }
4007
4008 sub get_source_format () {
4009     my %options;
4010     if (open F, "debian/source/options") {
4011         while (<F>) {
4012             next if m/^\s*\#/;
4013             next unless m/\S/;
4014             s/\s+$//; # ignore missing final newline
4015             if (m/\s*\#\s*/) {
4016                 my ($k, $v) = ($`, $'); #');
4017                 $v =~ s/^"(.*)"$/$1/;
4018                 $options{$k} = $v;
4019             } else {
4020                 $options{$_} = 1;
4021             }
4022         }
4023         F->error and confess "$!";
4024         close F;
4025     } else {
4026         confess "$!" unless $!==&ENOENT;
4027     }
4028
4029     if (!open F, "debian/source/format") {
4030         confess "$!" unless $!==&ENOENT;
4031         return '';
4032     }
4033     $_ = <F>;
4034     F->error and confess "$!";
4035     close F;
4036     chomp;
4037     return ($_, \%options);
4038 }
4039
4040 sub madformat_wantfixup ($) {
4041     my ($format) = @_;
4042     return 0 unless $format eq '3.0 (quilt)';
4043     our $quilt_mode_warned;
4044     if ($quilt_mode eq 'nocheck') {
4045         progress f_ "Not doing any fixup of \`%s'".
4046             " due to ----no-quilt-fixup or --quilt=nocheck", $format
4047             unless $quilt_mode_warned++;
4048         return 0;
4049     }
4050     progress f_ "Format \`%s', need to check/update patch stack", $format
4051         unless $quilt_mode_warned++;
4052     return 1;
4053 }
4054
4055 sub maybe_split_brain_save ($$$) {
4056     my ($headref, $dgitview, $msg) = @_;
4057     # => message fragment "$saved" describing disposition of $dgitview
4058     #    (used inside parens, in the English texts)
4059     my $save = $internal_object_save{'dgit-view'};
4060     return f_ "commit id %s", $dgitview unless defined $save;
4061     my @cmd = (shell_cmd 'cd "$1"; shift', $maindir,
4062                git_update_ref_cmd
4063                "dgit --dgit-view-save $msg HEAD=$headref",
4064                $save, $dgitview);
4065     runcmd @cmd;
4066     return f_ "and left in %s", $save;
4067 }
4068
4069 # An "infopair" is a tuple [ $thing, $what ]
4070 # (often $thing is a commit hash; $what is a description)
4071
4072 sub infopair_cond_equal ($$) {
4073     my ($x,$y) = @_;
4074     $x->[0] eq $y->[0] or fail <<END;
4075 $x->[1] ($x->[0]) not equal to $y->[1] ($y->[0])
4076 END
4077 };
4078
4079 sub infopair_lrf_tag_lookup ($$) {
4080     my ($tagnames, $what) = @_;
4081     # $tagname may be an array ref
4082     my @tagnames = ref $tagnames ? @$tagnames : ($tagnames);
4083     printdebug "infopair_lrfetchref_tag_lookup $what @tagnames\n";
4084     foreach my $tagname (@tagnames) {
4085         my $lrefname = lrfetchrefs."/tags/$tagname";
4086         my $tagobj = $lrfetchrefs_f{$lrefname};
4087         next unless defined $tagobj;
4088         printdebug "infopair_lrfetchref_tag_lookup $tagobj $tagname $what\n";
4089         return [ git_rev_parse($tagobj), $what ];
4090     }
4091     fail @tagnames==1 ? (f_ <<END, $what, "@tagnames")
4092 Wanted tag %s (%s) on dgit server, but not found
4093 END
4094                       : (f_ <<END, $what, "@tagnames");
4095 Wanted tag %s (one of: %s) on dgit server, but not found
4096 END
4097 }
4098
4099 sub infopair_cond_ff ($$) {
4100     my ($anc,$desc) = @_;
4101     is_fast_fwd($anc->[0], $desc->[0]) or
4102         fail f_ <<END, $anc->[1], $anc->[0], $desc->[1], $desc->[0];
4103 %s (%s) .. %s (%s) is not fast forward
4104 END
4105 };
4106
4107 sub pseudomerge_version_check ($$) {
4108     my ($clogp, $archive_hash) = @_;
4109
4110     my $arch_clogp = commit_getclogp $archive_hash;
4111     my $i_arch_v = [ (getfield $arch_clogp, 'Version'),
4112                      __ 'version currently in archive' ];
4113     if (defined $overwrite_version) {
4114         if (length $overwrite_version) {
4115             infopair_cond_equal([ $overwrite_version,
4116                                   '--overwrite= version' ],
4117                                 $i_arch_v);
4118         } else {
4119             my $v = $i_arch_v->[0];
4120             progress f_
4121                 "Checking package changelog for archive version %s ...", $v;
4122             my $cd;
4123             eval {
4124                 my @xa = ("-f$v", "-t$v");
4125                 my $vclogp = parsechangelog @xa;
4126                 my $gf = sub {
4127                     my ($fn) = @_;
4128                     [ (getfield $vclogp, $fn),
4129                       (f_ "%s field from dpkg-parsechangelog %s",
4130                           $fn, "@xa") ];
4131                 };
4132                 my $cv = $gf->('Version');
4133                 infopair_cond_equal($i_arch_v, $cv);
4134                 $cd = $gf->('Distribution');
4135             };
4136             if ($@) {
4137                 $@ =~ s/^\n//s;
4138                 $@ =~ s/^dgit: //gm;
4139                 fail "$@".
4140                     f_ "Perhaps debian/changelog does not mention %s ?", $v;
4141             }
4142             fail f_ <<END, $cd->[1], $cd->[0], $v
4143 %s is %s
4144 Your tree seems to based on earlier (not uploaded) %s.
4145 END
4146                 if $cd->[0] =~ m/UNRELEASED/;
4147         }
4148     }
4149     
4150     printdebug "pseudomerge_version_check i_arch_v @$i_arch_v\n";
4151     return $i_arch_v;
4152 }
4153
4154 sub pseudomerge_hash_commit ($$$$ $$) {
4155     my ($clogp, $dgitview, $archive_hash, $i_arch_v,
4156         $msg_cmd, $msg_msg) = @_;
4157     progress f_ "Declaring that HEAD includes all changes in %s...",
4158                  $i_arch_v->[0];
4159
4160     my $tree = cmdoutput qw(git rev-parse), "${dgitview}:";
4161     my $authline = clogp_authline $clogp;
4162
4163     chomp $msg_msg;
4164     $msg_cmd .=
4165         !defined $overwrite_version ? ""
4166         : !length  $overwrite_version ? " --overwrite"
4167         : " --overwrite=".$overwrite_version;
4168
4169     # Contributing parent is the first parent - that makes
4170     # git rev-list --first-parent DTRT.
4171     my $pmf = dgit_privdir()."/pseudomerge";
4172     open MC, ">", $pmf or die "$pmf $!";
4173     print MC <<END or confess "$!";
4174 tree $tree
4175 parent $dgitview
4176 parent $archive_hash
4177 author $authline
4178 committer $authline
4179
4180 $msg_msg
4181
4182 [$msg_cmd]
4183 END
4184     close MC or confess "$!";
4185
4186     return hash_commit($pmf);
4187 }
4188
4189 sub splitbrain_pseudomerge ($$$$) {
4190     my ($clogp, $maintview, $dgitview, $archive_hash) = @_;
4191     # => $merged_dgitview
4192     printdebug "splitbrain_pseudomerge...\n";
4193     #
4194     #     We:      debian/PREVIOUS    HEAD($maintview)
4195     # expect:          o ----------------- o
4196     #                    \                   \
4197     #                     o                   o
4198     #                 a/d/PREVIOUS        $dgitview
4199     #                $archive_hash              \
4200     #  If so,                \                   \
4201     #  we do:                 `------------------ o
4202     #   this:                                   $dgitview'
4203     #
4204
4205     return $dgitview unless defined $archive_hash;
4206     return $dgitview if deliberately_not_fast_forward();
4207
4208     printdebug "splitbrain_pseudomerge...\n";
4209
4210     my $i_arch_v = pseudomerge_version_check($clogp, $archive_hash);
4211
4212     if (!defined $overwrite_version) {
4213         progress __ "Checking that HEAD includes all changes in archive...";
4214     }
4215
4216     return $dgitview if is_fast_fwd $archive_hash, $dgitview;
4217
4218     if (defined $overwrite_version) {
4219     } elsif (!eval {
4220         my $t_dep14 = debiantag_maintview $i_arch_v->[0], access_nomdistro;
4221         my $i_dep14 = infopair_lrf_tag_lookup($t_dep14,
4222                                               __ "maintainer view tag");
4223         my $t_dgit = debiantag_new $i_arch_v->[0], access_nomdistro;
4224         my $i_dgit = infopair_lrf_tag_lookup($t_dgit, __ "dgit view tag");
4225         my $i_archive = [ $archive_hash, __ "current archive contents" ];
4226
4227         printdebug "splitbrain_pseudomerge i_archive @$i_archive\n";
4228
4229         infopair_cond_equal($i_dgit, $i_archive);
4230         infopair_cond_ff($i_dep14, $i_dgit);
4231         infopair_cond_ff($i_dep14, [ $maintview, 'HEAD' ]);
4232         1;
4233     }) {
4234         $@ =~ s/^\n//; chomp $@;
4235         print STDERR <<END.(__ <<ENDT);
4236 $@
4237 END
4238 | Not fast forward; maybe --overwrite is needed ?  Please see dgit(1).
4239 ENDT
4240         finish -1;
4241     }
4242
4243     my $arch_v = $i_arch_v->[0];
4244     my $r = pseudomerge_hash_commit
4245         $clogp, $dgitview, $archive_hash, $i_arch_v,
4246         "dgit --quilt=$quilt_mode",
4247         (defined $overwrite_version
4248          ? f_ "Declare fast forward from %s\n", $arch_v
4249          : f_ "Make fast forward from %s\n",    $arch_v);
4250
4251     maybe_split_brain_save $maintview, $r, "pseudomerge";
4252
4253     progress f_ "Made pseudo-merge of %s into dgit view.", $arch_v;
4254     return $r;
4255 }       
4256
4257 sub plain_overwrite_pseudomerge ($$$) {
4258     my ($clogp, $head, $archive_hash) = @_;
4259
4260     printdebug "plain_overwrite_pseudomerge...";
4261
4262     my $i_arch_v = pseudomerge_version_check($clogp, $archive_hash);
4263
4264     return $head if is_fast_fwd $archive_hash, $head;
4265
4266     my $m = f_ "Declare fast forward from %s", $i_arch_v->[0];
4267
4268     my $r = pseudomerge_hash_commit
4269         $clogp, $head, $archive_hash, $i_arch_v,
4270         "dgit", $m;
4271
4272     runcmd git_update_ref_cmd $m, 'HEAD', $r, $head;
4273
4274     progress f_ "Make pseudo-merge of %s into your HEAD.", $i_arch_v->[0];
4275     return $r;
4276 }
4277
4278 sub push_parse_changelog ($) {
4279     my ($clogpfn) = @_;
4280
4281     my $clogp = Dpkg::Control::Hash->new();
4282     $clogp->load($clogpfn) or die;
4283
4284     my $clogpackage = getfield $clogp, 'Source';
4285     $package //= $clogpackage;
4286     fail f_ "-p specified %s but changelog specified %s",
4287             $package, $clogpackage
4288         unless $package eq $clogpackage;
4289     my $cversion = getfield $clogp, 'Version';
4290
4291     if (!$we_are_initiator) {
4292         # rpush initiator can't do this because it doesn't have $isuite yet
4293         my $tag = debiantag_new($cversion, access_nomdistro);
4294         runcmd @git, qw(check-ref-format), $tag;
4295     }
4296
4297     my $dscfn = dscfn($cversion);
4298
4299     return ($clogp, $cversion, $dscfn);
4300 }
4301
4302 sub push_parse_dsc ($$$) {
4303     my ($dscfn,$dscfnwhat, $cversion) = @_;
4304     $dsc = parsecontrol($dscfn,$dscfnwhat);
4305     my $dversion = getfield $dsc, 'Version';
4306     my $dscpackage = getfield $dsc, 'Source';
4307     ($dscpackage eq $package && $dversion eq $cversion) or
4308         fail f_ "%s is for %s %s but debian/changelog is for %s %s",
4309                 $dscfn, $dscpackage, $dversion,
4310                         $package,    $cversion;
4311 }
4312
4313 sub push_tagwants ($$$$) {
4314     my ($cversion, $dgithead, $maintviewhead, $tfbase) = @_;
4315     my @tagwants;
4316     push @tagwants, {
4317         TagFn => \&debiantag_new,
4318         Objid => $dgithead,
4319         TfSuffix => '',
4320         View => 'dgit',
4321     };
4322     if (defined $maintviewhead) {
4323         push @tagwants, {
4324             TagFn => \&debiantag_maintview,
4325             Objid => $maintviewhead,
4326             TfSuffix => '-maintview',
4327             View => 'maint',
4328         };
4329     } elsif ($dodep14tag ne 'no') {
4330         push @tagwants, {
4331             TagFn => \&debiantag_maintview,
4332             Objid => $dgithead,
4333             TfSuffix => '-dgit',
4334             View => 'dgit',
4335         };
4336     };
4337     foreach my $tw (@tagwants) {
4338         $tw->{Tag} = $tw->{TagFn}($cversion, access_nomdistro);
4339         $tw->{Tfn} = sub { $tfbase.$tw->{TfSuffix}.$_[0]; };
4340     }
4341     printdebug 'push_tagwants: ', Dumper(\@_, \@tagwants);
4342     return @tagwants;
4343 }
4344
4345 sub push_mktags ($$ $$ $) {
4346     my ($clogp,$dscfn,
4347         $changesfile,$changesfilewhat,
4348         $tagwants) = @_;
4349
4350     die unless $tagwants->[0]{View} eq 'dgit';
4351
4352     my $declaredistro = access_nomdistro();
4353     my $reader_giturl = do { local $access_forpush=0; access_giturl(); };
4354     $dsc->{$ourdscfield[0]} = join " ",
4355         $tagwants->[0]{Objid}, $declaredistro, $tagwants->[0]{Tag},
4356         $reader_giturl;
4357     $dsc->save("$dscfn.tmp") or confess "$!";
4358
4359     my $changes = parsecontrol($changesfile,$changesfilewhat);
4360     foreach my $field (qw(Source Distribution Version)) {
4361         $changes->{$field} eq $clogp->{$field} or
4362             fail f_ "changes field %s \`%s' does not match changelog \`%s'",
4363                     $field, $changes->{$field}, $clogp->{$field};
4364     }
4365
4366     my $cversion = getfield $clogp, 'Version';
4367     my $clogsuite = getfield $clogp, 'Distribution';
4368     my $format = getfield $dsc, 'Format';
4369
4370     # We make the git tag by hand because (a) that makes it easier
4371     # to control the "tagger" (b) we can do remote signing
4372     my $authline = clogp_authline $clogp;
4373
4374     my $mktag = sub {
4375         my ($tw) = @_;
4376         my $tfn = $tw->{Tfn};
4377         my $head = $tw->{Objid};
4378         my $tag = $tw->{Tag};
4379
4380         open TO, '>', $tfn->('.tmp') or confess "$!";
4381         print TO <<END or confess "$!";
4382 object $head
4383 type commit
4384 tag $tag
4385 tagger $authline
4386
4387 END
4388
4389         my @dtxinfo = @deliberatelies;
4390         unshift @dtxinfo, "--quilt=$quilt_mode" if madformat($format);
4391         unshift @dtxinfo, do_split_brain() ? "split" : "no-split"
4392             # rpush protocol 5 and earlier don't tell us
4393             unless $we_are_initiator && $protovsn < 6;
4394         my $dtxinfo = join(" ", "",@dtxinfo);
4395         my $tag_metadata = <<END;
4396 [dgit distro=$declaredistro$dtxinfo]
4397 END
4398         foreach my $ref (sort keys %previously) {
4399             $tag_metadata .= <<END or confess "$!";
4400 [dgit previously:$ref=$previously{$ref}]
4401 END
4402         }
4403
4404         if ($tw->{View} eq 'dgit') {
4405             print TO sprintf <<ENDT, $package, $cversion, $clogsuite, $csuite
4406 %s release %s for %s (%s) [dgit]
4407 ENDT
4408                 or confess "$!";
4409         } elsif ($tw->{View} eq 'maint') {
4410             print TO sprintf <<END, $package, $cversion, $clogsuite, $csuite;
4411 %s release %s for %s (%s)
4412
4413 END
4414             print TO f_ <<END,
4415 (maintainer view tag generated by dgit --quilt=%s)
4416 END
4417                 $quilt_mode
4418                 or confess "$!";
4419         } else {
4420             confess Dumper($tw)."?";
4421         }
4422         print TO "\n", $tag_metadata;
4423
4424         close TO or confess "$!";
4425
4426         my $tagobjfn = $tfn->('.tmp');
4427         if ($sign) {
4428             if (!defined $keyid) {
4429                 $keyid = access_cfg('keyid','RETURN-UNDEF');
4430             }
4431             if (!defined $keyid) {
4432                 $keyid = getfield $clogp, 'Maintainer';
4433             }
4434             unlink $tfn->('.tmp.asc') or $!==&ENOENT or confess "$!";
4435             my @sign_cmd = (@gpg, qw(--detach-sign --armor));
4436             push @sign_cmd, qw(-u),$keyid if defined $keyid;
4437             push @sign_cmd, $tfn->('.tmp');
4438             runcmd_ordryrun @sign_cmd;
4439             if (act_scary()) {
4440                 $tagobjfn = $tfn->('.signed.tmp');
4441                 runcmd shell_cmd "exec >$tagobjfn", qw(cat --),
4442                     $tfn->('.tmp'), $tfn->('.tmp.asc');
4443             }
4444         }
4445         return $tagobjfn;
4446     };
4447
4448     my @r = map { $mktag->($_); } @$tagwants;
4449     return @r;
4450 }
4451
4452 sub sign_changes ($) {
4453     my ($changesfile) = @_;
4454     if ($sign) {
4455         my @debsign_cmd = @debsign;
4456         push @debsign_cmd, "-k$keyid" if defined $keyid;
4457         push @debsign_cmd, "-p$gpg[0]" if $gpg[0] ne 'gpg';
4458         push @debsign_cmd, $changesfile;
4459         runcmd_ordryrun @debsign_cmd;
4460     }
4461 }
4462
4463 sub dopush () {
4464     printdebug "actually entering push\n";
4465
4466     supplementary_message(__ <<'END');
4467 Push failed, while checking state of the archive.
4468 You can retry the push, after fixing the problem, if you like.
4469 END
4470     if (check_for_git()) {
4471         git_fetch_us();
4472     }
4473     my $archive_hash = fetch_from_archive();
4474     if (!$archive_hash) {
4475         $new_package or
4476             fail __ "package appears to be new in this suite;".
4477                     " if this is intentional, use --new";
4478     }
4479
4480     supplementary_message(__ <<'END');
4481 Push failed, while preparing your push.
4482 You can retry the push, after fixing the problem, if you like.
4483 END
4484
4485     prep_ud();
4486
4487     access_giturl(); # check that success is vaguely likely
4488     rpush_handle_protovsn_bothends() if $we_are_initiator;
4489
4490     my $clogpfn = dgit_privdir()."/changelog.822.tmp";
4491     runcmd shell_cmd "exec >$clogpfn", qw(dpkg-parsechangelog);
4492
4493     responder_send_file('parsed-changelog', $clogpfn);
4494
4495     my ($clogp, $cversion, $dscfn) =
4496         push_parse_changelog("$clogpfn");
4497
4498     my $dscpath = "$buildproductsdir/$dscfn";
4499     stat_exists $dscpath or
4500         fail f_ "looked for .dsc %s, but %s; maybe you forgot to build",
4501                 $dscpath, $!;
4502
4503     responder_send_file('dsc', $dscpath);
4504
4505     push_parse_dsc($dscpath, $dscfn, $cversion);
4506
4507     my $format = getfield $dsc, 'Format';
4508
4509     my $symref = git_get_symref();
4510     my $actualhead = git_rev_parse('HEAD');
4511
4512     if (branch_is_gdr_unstitched_ff($symref, $actualhead, $archive_hash)) {
4513         if (quiltmode_splitting()) {
4514             my ($ffq_prev, $gdrlast) = branch_gdr_info($symref, $actualhead);
4515             fail f_ <<END, $ffq_prev, $quilt_mode;
4516 Branch is managed by git-debrebase (%s
4517 exists), but quilt mode (%s) implies a split view.
4518 Pass the right --quilt option or adjust your git config.
4519 Or, maybe, run git-debrebase forget-was-ever-debrebase.
4520 END
4521         }
4522         runcmd_ordryrun_local @git_debrebase, 'stitch';
4523         $actualhead = git_rev_parse('HEAD');
4524     }
4525
4526     my $dgithead = $actualhead;
4527     my $maintviewhead = undef;
4528
4529     my $upstreamversion = upstreamversion $clogp->{Version};
4530
4531     if (madformat_wantfixup($format)) {
4532         # user might have not used dgit build, so maybe do this now:
4533         if (do_split_brain()) {
4534             changedir $playground;
4535             my $cachekey;
4536             ($dgithead, $cachekey) =
4537                 quilt_check_splitbrain_cache($actualhead, $upstreamversion);
4538             $dgithead or fail f_
4539  "--quilt=%s but no cached dgit view:
4540  perhaps HEAD changed since dgit build[-source] ?",
4541                               $quilt_mode;
4542         }
4543         if (!do_split_brain()) {
4544             # In split brain mode, do not attempt to incorporate dirty
4545             # stuff from the user's working tree.  That would be mad.
4546             commit_quilty_patch();
4547         }
4548     }
4549     if (do_split_brain()) {
4550         $made_split_brain = 1;
4551         $dgithead = splitbrain_pseudomerge($clogp,
4552                                            $actualhead, $dgithead,
4553                                            $archive_hash);
4554         $maintviewhead = $actualhead;
4555         changedir $maindir;
4556         prep_ud(); # so _only_subdir() works, below
4557     }
4558
4559     if (defined $overwrite_version && !defined $maintviewhead
4560         && $archive_hash) {
4561         $dgithead = plain_overwrite_pseudomerge($clogp,
4562                                                 $dgithead,
4563                                                 $archive_hash);
4564     }
4565
4566     check_not_dirty();
4567
4568     my $forceflag = '';
4569     if ($archive_hash) {
4570         if (is_fast_fwd($archive_hash, $dgithead)) {
4571             # ok
4572         } elsif (deliberately_not_fast_forward) {
4573             $forceflag = '+';
4574         } else {
4575             fail __ "dgit push: HEAD is not a descendant".
4576                 " of the archive's version.\n".
4577                 "To overwrite the archive's contents,".
4578                 " pass --overwrite[=VERSION].\n".
4579                 "To rewind history, if permitted by the archive,".
4580                 " use --deliberately-not-fast-forward.";
4581         }
4582     }
4583
4584     confess unless !!$made_split_brain == do_split_brain();
4585
4586     changedir $playground;
4587     progress f_ "checking that %s corresponds to HEAD", $dscfn;
4588     runcmd qw(dpkg-source -x --),
4589         $dscpath =~ m#^/# ? $dscpath : "$maindir/$dscpath";
4590     my ($tree,$dir) = mktree_in_ud_from_only_subdir("source package");
4591     check_for_vendor_patches() if madformat($dsc->{format});
4592     changedir $maindir;
4593     my @diffcmd = (@git, qw(diff --quiet), $tree, $dgithead);
4594     debugcmd "+",@diffcmd;
4595     $!=0; $?=-1;
4596     my $r = system @diffcmd;
4597     if ($r) {
4598         if ($r==256) {
4599             my $referent = $made_split_brain ? $dgithead : 'HEAD';
4600             my $diffs = cmdoutput @git, qw(diff --stat), $tree, $dgithead;
4601
4602             my @mode_changes;
4603             my $raw = cmdoutput @git,
4604                 qw(diff --no-renames -z -r --raw), $tree, $dgithead;
4605             my $changed;
4606             foreach (split /\0/, $raw) {
4607                 if (defined $changed) {
4608                     push @mode_changes, "$changed: $_\n" if $changed;
4609                     $changed = undef;
4610                     next;
4611                 } elsif (m/^:0+ 0+ /) {
4612                     $changed = '';
4613                 } elsif (m/^:(?:10*)?(\d+) (?:10*)?(\d+) /) {
4614                     $changed = "Mode change from $1 to $2"
4615                 } else {
4616                     die "$_ ?";
4617                 }
4618             }
4619             if (@mode_changes) {
4620                 fail +(f_ <<ENDT, $dscfn).<<END
4621 HEAD specifies a different tree to %s:
4622 ENDT
4623 $diffs
4624 END
4625                     .(join '', @mode_changes)
4626                     .(f_ <<ENDT, $tree, $referent);
4627 There is a problem with your source tree (see dgit(7) for some hints).
4628 To see a full diff, run git diff %s %s
4629 ENDT
4630             }
4631
4632             fail +(f_ <<ENDT, $dscfn).<<END.(f_ <<ENDT, $tree, $referent);
4633 HEAD specifies a different tree to %s:
4634 ENDT
4635 $diffs
4636 END
4637 Perhaps you forgot to build.  Or perhaps there is a problem with your
4638  source tree (see dgit(7) for some hints).  To see a full diff, run
4639    git diff %s %s
4640 ENDT
4641         } else {
4642             failedcmd @diffcmd;
4643         }
4644     }
4645     if (!$changesfile) {
4646         my $pat = changespat $cversion;
4647         my @cs = glob "$buildproductsdir/$pat";
4648         fail f_ "failed to find unique changes file".
4649                 " (looked for %s in %s);".
4650                 " perhaps you need to use dgit -C",
4651                 $pat, $buildproductsdir
4652             unless @cs==1;
4653         ($changesfile) = @cs;
4654     } else {
4655         $changesfile = "$buildproductsdir/$changesfile";
4656     }
4657
4658     # Check that changes and .dsc agree enough
4659     $changesfile =~ m{[^/]*$};
4660     my $changes = parsecontrol($changesfile,$&);
4661     files_compare_inputs($dsc, $changes)
4662         unless forceing [qw(dsc-changes-mismatch)];
4663
4664     # Check whether this is a source only upload
4665     my $hasdebs = $changes->{Files} =~ m{\.deb$}m;
4666     my $sourceonlypolicy = access_cfg 'source-only-uploads';
4667     if ($sourceonlypolicy eq 'ok') {
4668     } elsif ($sourceonlypolicy eq 'always') {
4669         forceable_fail [qw(uploading-binaries)],
4670             __ "uploading binaries, although distro policy is source only"
4671             if $hasdebs;
4672     } elsif ($sourceonlypolicy eq 'never') {
4673         forceable_fail [qw(uploading-source-only)],
4674             __ "source-only upload, although distro policy requires .debs"
4675             if !$hasdebs;
4676     } elsif ($sourceonlypolicy eq 'not-wholly-new') {
4677         forceable_fail [qw(uploading-source-only)],
4678             f_ "source-only upload, even though package is entirely NEW\n".
4679                "(this is contrary to policy in %s)",
4680                access_nomdistro()
4681             if !$hasdebs
4682             && $new_package
4683             && !(archive_query('package_not_wholly_new', $package) // 1);
4684     } else {
4685         badcfg f_ "unknown source-only-uploads policy \`%s'",
4686                   $sourceonlypolicy;
4687     }
4688
4689     # Perhaps adjust .dsc to contain right set of origs
4690     changes_update_origs_from_dsc($dsc, $changes, $upstreamversion,
4691                                   $changesfile)
4692         unless forceing [qw(changes-origs-exactly)];
4693
4694     # Checks complete, we're going to try and go ahead:
4695
4696     responder_send_file('changes',$changesfile);
4697     responder_send_command("param head $dgithead");
4698     responder_send_command("param csuite $csuite");
4699     responder_send_command("param isuite $isuite");
4700     responder_send_command("param tagformat new"); # needed in $protovsn==4
4701     responder_send_command("param splitbrain $do_split_brain");
4702     if (defined $maintviewhead) {
4703         responder_send_command("param maint-view $maintviewhead");
4704     }
4705
4706     # Perhaps send buildinfo(s) for signing
4707     my $changes_files = getfield $changes, 'Files';
4708     my @buildinfos = ($changes_files =~ m/ .* (\S+\.buildinfo)$/mg);
4709     foreach my $bi (@buildinfos) {
4710         responder_send_command("param buildinfo-filename $bi");
4711         responder_send_file('buildinfo', "$buildproductsdir/$bi");
4712     }
4713
4714     if (deliberately_not_fast_forward) {
4715         git_for_each_ref(lrfetchrefs, sub {
4716             my ($objid,$objtype,$lrfetchrefname,$reftail) = @_;
4717             my $rrefname= substr($lrfetchrefname, length(lrfetchrefs) + 1);
4718             responder_send_command("previously $rrefname=$objid");
4719             $previously{$rrefname} = $objid;
4720         });
4721     }
4722
4723     my @tagwants = push_tagwants($cversion, $dgithead, $maintviewhead,
4724                                  dgit_privdir()."/tag");
4725     my @tagobjfns;
4726
4727     supplementary_message(__ <<'END');
4728 Push failed, while signing the tag.
4729 You can retry the push, after fixing the problem, if you like.
4730 END
4731     # If we manage to sign but fail to record it anywhere, it's fine.
4732     if ($we_are_responder) {
4733         @tagobjfns = map { $_->{Tfn}('.signed-tmp') } @tagwants;
4734         responder_receive_files('signed-tag', @tagobjfns);
4735     } else {
4736         @tagobjfns = push_mktags($clogp,$dscpath,
4737                               $changesfile,$changesfile,
4738                               \@tagwants);
4739     }
4740     supplementary_message(__ <<'END');
4741 Push failed, *after* signing the tag.
4742 If you want to try again, you should use a new version number.
4743 END
4744
4745     pairwise { $a->{TagObjFn} = $b } @tagwants, @tagobjfns;
4746
4747     foreach my $tw (@tagwants) {
4748         my $tag = $tw->{Tag};
4749         my $tagobjfn = $tw->{TagObjFn};
4750         my $tag_obj_hash =
4751             cmdoutput @git, qw(hash-object -w -t tag), $tagobjfn;
4752         runcmd_ordryrun @git, qw(verify-tag), $tag_obj_hash;
4753         runcmd_ordryrun_local
4754             @git, qw(update-ref), "refs/tags/$tag", $tag_obj_hash;
4755     }
4756
4757     supplementary_message(__ <<'END');
4758 Push failed, while updating the remote git repository - see messages above.
4759 If you want to try again, you should use a new version number.
4760 END
4761     if (!check_for_git()) {
4762         create_remote_git_repo();
4763     }
4764
4765     my @pushrefs = $forceflag.$dgithead.":".rrref();
4766     foreach my $tw (@tagwants) {
4767         push @pushrefs, $forceflag."refs/tags/$tw->{Tag}";
4768     }
4769
4770     runcmd_ordryrun @git,
4771         qw(-c push.followTags=false push), access_giturl(), @pushrefs;
4772     runcmd_ordryrun git_update_ref_cmd 'dgit push', lrref(), $dgithead;
4773
4774     supplementary_message(__ <<'END');
4775 Push failed, while obtaining signatures on the .changes and .dsc.
4776 If it was just that the signature failed, you may try again by using
4777 debsign by hand to sign the changes file (see the command dgit tried,
4778 above), and then dput that changes file to complete the upload.
4779 If you need to change the package, you must use a new version number.
4780 END
4781     if ($we_are_responder) {
4782         my $dryrunsuffix = act_local() ? "" : ".tmp";
4783         my @rfiles = ($dscpath, $changesfile);
4784         push @rfiles, map { "$buildproductsdir/$_" } @buildinfos;
4785         responder_receive_files('signed-dsc-changes',
4786                                 map { "$_$dryrunsuffix" } @rfiles);
4787     } else {
4788         if (act_local()) {
4789             rename "$dscpath.tmp",$dscpath or die "$dscfn $!";
4790         } else {
4791             progress f_ "[new .dsc left in %s.tmp]", $dscpath;
4792         }
4793         sign_changes $changesfile;
4794     }
4795
4796     supplementary_message(f_ <<END, $changesfile);
4797 Push failed, while uploading package(s) to the archive server.
4798 You can retry the upload of exactly these same files with dput of:
4799   %s
4800 If that .changes file is broken, you will need to use a new version
4801 number for your next attempt at the upload.
4802 END
4803     my $host = access_cfg('upload-host','RETURN-UNDEF');
4804     my @hostarg = defined($host) ? ($host,) : ();
4805     runcmd_ordryrun @dput, @hostarg, $changesfile;
4806     printdone f_ "pushed and uploaded %s", $cversion;
4807
4808     supplementary_message('');
4809     responder_send_command("complete");
4810 }
4811
4812 sub pre_clone () {
4813     not_necessarily_a_tree();
4814 }
4815 sub cmd_clone {
4816     parseopts();
4817     my $dstdir;
4818     badusage __ "-p is not allowed with clone; specify as argument instead"
4819         if defined $package;
4820     if (@ARGV==1) {
4821         ($package) = @ARGV;
4822     } elsif (@ARGV==2 && $ARGV[1] =~ m#^\w#) {
4823         ($package,$isuite) = @ARGV;
4824     } elsif (@ARGV==2 && $ARGV[1] =~ m#^[./]#) {
4825         ($package,$dstdir) = @ARGV;
4826     } elsif (@ARGV==3) {
4827         ($package,$isuite,$dstdir) = @ARGV;
4828     } else {
4829         badusage __ "incorrect arguments to dgit clone";
4830     }
4831     notpushing();
4832
4833     $dstdir ||= "$package";
4834     if (stat_exists $dstdir) {
4835         fail f_ "%s already exists", $dstdir;
4836     }
4837
4838     my $cwd_remove;
4839     if ($rmonerror && !$dryrun_level) {
4840         $cwd_remove= getcwd();
4841         unshift @end, sub { 
4842             return unless defined $cwd_remove;
4843             if (!chdir "$cwd_remove") {
4844                 return if $!==&ENOENT;
4845                 confess "chdir $cwd_remove: $!";
4846             }
4847             printdebug "clone rmonerror removing $dstdir\n";
4848             if (stat $dstdir) {
4849                 rmtree($dstdir) or fail f_ "remove %s: %s\n", $dstdir, $!;
4850             } elsif (grep { $! == $_ }
4851                      (ENOENT, ENOTDIR, EACCES, EPERM, ELOOP)) {
4852             } else {
4853                 print STDERR f_ "check whether to remove %s: %s\n",
4854                                 $dstdir, $!;
4855             }
4856         };
4857     }
4858
4859     clone($dstdir);
4860     $cwd_remove = undef;
4861 }
4862
4863 sub branchsuite () {
4864     my $branch = git_get_symref();
4865     if (defined $branch && $branch =~ m#$lbranch_re#o) {
4866         return $1;
4867     } else {
4868         return undef;
4869     }
4870 }
4871
4872 sub package_from_d_control () {
4873     if (!defined $package) {
4874         my $sourcep = parsecontrol('debian/control','debian/control');
4875         $package = getfield $sourcep, 'Source';
4876     }
4877 }
4878
4879 sub fetchpullargs () {
4880     package_from_d_control();
4881     if (@ARGV==0) {
4882         $isuite = branchsuite();
4883         if (!$isuite) {
4884             my $clogp = parsechangelog();
4885             my $clogsuite = getfield $clogp, 'Distribution';
4886             $isuite= $clogsuite if $clogsuite ne 'UNRELEASED';
4887         }
4888     } elsif (@ARGV==1) {
4889         ($isuite) = @ARGV;
4890     } else {
4891         badusage __ "incorrect arguments to dgit fetch or dgit pull";
4892     }
4893     notpushing();
4894 }
4895
4896 sub cmd_fetch {
4897     parseopts();
4898     fetchpullargs();
4899     dofetch();
4900 }
4901
4902 sub cmd_pull {
4903     parseopts();
4904     fetchpullargs();
4905     determine_whether_split_brain get_source_format();
4906     if (do_split_brain()) {
4907         my ($format, $fopts) = get_source_format();
4908         madformat($format) and fail f_ <<END, $quilt_mode
4909 dgit pull not yet supported in split view mode (including with view-splitting quilt modes)
4910 END
4911     }
4912     pull();
4913 }
4914
4915 sub cmd_checkout {
4916     parseopts();
4917     package_from_d_control();
4918     @ARGV==1 or badusage __ "dgit checkout needs a suite argument";
4919     ($isuite) = @ARGV;
4920     notpushing();
4921
4922     foreach my $canon (qw(0 1)) {
4923         if (!$canon) {
4924             $csuite= $isuite;
4925         } else {
4926             undef $csuite;
4927             canonicalise_suite();
4928         }
4929         if (length git_get_ref lref()) {
4930             # local branch already exists, yay
4931             last;
4932         }
4933         if (!length git_get_ref lrref()) {
4934             if (!$canon) {
4935                 # nope
4936                 next;
4937             }
4938             dofetch();
4939         }
4940         # now lrref exists
4941         runcmd (@git, qw(update-ref), lref(), lrref(), '');
4942         last;
4943     }
4944     local $ENV{GIT_REFLOG_ACTION} = git_reflog_action_msg
4945         "dgit checkout $isuite";
4946     runcmd (@git, qw(checkout), lbranch());
4947 }
4948
4949 sub cmd_update_vcs_git () {
4950     my $specsuite;
4951     if (@ARGV==0 || $ARGV[0] =~ m/^-/) {
4952         ($specsuite,) = split /\;/, cfg 'dgit.vcs-git.suites';
4953     } else {
4954         ($specsuite) = (@ARGV);
4955         shift @ARGV;
4956     }
4957     my $dofetch=1;
4958     if (@ARGV) {
4959         if ($ARGV[0] eq '-') {
4960             $dofetch = 0;
4961         } elsif ($ARGV[0] eq '-') {
4962             shift;
4963         }
4964     }
4965
4966     package_from_d_control();
4967     my $ctrl;
4968     if ($specsuite eq '.') {
4969         $ctrl = parsecontrol 'debian/control', 'debian/control';
4970     } else {
4971         $isuite = $specsuite;
4972         get_archive_dsc();
4973         $ctrl = $dsc;
4974     }
4975     my $url = getfield $ctrl, 'Vcs-Git';
4976
4977     my @cmd;
4978     my $orgurl = cfg 'remote.vcs-git.url', 'RETURN-UNDEF';
4979     if (!defined $orgurl) {
4980         print STDERR f_ "setting up vcs-git: %s\n", $url;
4981         @cmd = (@git, qw(remote add vcs-git), $url);
4982     } elsif ($orgurl eq $url) {
4983         print STDERR f_ "vcs git already configured: %s\n", $url;
4984     } else {
4985         print STDERR f_ "changing vcs-git url to: %s\n", $url;
4986         @cmd = (@git, qw(remote set-url vcs-git), $url);
4987     }
4988     runcmd_ordryrun_local @cmd if @cmd;
4989     if ($dofetch) {
4990         print f_ "fetching (%s)\n", "@ARGV";
4991         runcmd_ordryrun_local @git, qw(fetch vcs-git), @ARGV;
4992     }
4993 }
4994
4995 sub prep_push () {
4996     parseopts();
4997     build_or_push_prep_early();
4998     pushing();
4999     build_or_push_prep_modes();
5000     check_not_dirty();
5001     my $specsuite;
5002     if (@ARGV==0) {
5003     } elsif (@ARGV==1) {
5004         ($specsuite) = (@ARGV);
5005     } else {
5006         badusage f_ "incorrect arguments to dgit %s", $subcommand;
5007     }
5008     if ($new_package) {
5009         local ($package) = $existing_package; # this is a hack
5010         canonicalise_suite();
5011     } else {
5012         canonicalise_suite();
5013     }
5014     if (defined $specsuite &&
5015         $specsuite ne $isuite &&
5016         $specsuite ne $csuite) {
5017             fail f_ "dgit %s: changelog specifies %s (%s)".
5018                     " but command line specifies %s",
5019                     $subcommand, $isuite, $csuite, $specsuite;
5020     }
5021 }
5022
5023 sub cmd_push {
5024     prep_push();
5025     dopush();
5026 }
5027
5028 #---------- remote commands' implementation ----------
5029
5030 sub pre_remote_push_build_host {
5031     my ($nrargs) = shift @ARGV;
5032     my (@rargs) = @ARGV[0..$nrargs-1];
5033     @ARGV = @ARGV[$nrargs..$#ARGV];
5034     die unless @rargs;
5035     my ($dir,$vsnwant) = @rargs;
5036     # vsnwant is a comma-separated list; we report which we have
5037     # chosen in our ready response (so other end can tell if they
5038     # offered several)
5039     $debugprefix = ' ';
5040     $we_are_responder = 1;
5041     $us .= " (build host)";
5042
5043     open PI, "<&STDIN" or confess "$!";
5044     open STDIN, "/dev/null" or confess "$!";
5045     open PO, ">&STDOUT" or confess "$!";
5046     autoflush PO 1;
5047     open STDOUT, ">&STDERR" or confess "$!";
5048     autoflush STDOUT 1;
5049
5050     $vsnwant //= 1;
5051     ($protovsn) = grep {
5052         $vsnwant =~ m{^(?:.*,)?$_(?:,.*)?$}
5053     } @rpushprotovsn_support;
5054
5055     fail f_ "build host has dgit rpush protocol versions %s".
5056             " but invocation host has %s",
5057             (join ",", @rpushprotovsn_support), $vsnwant
5058         unless defined $protovsn;
5059
5060     changedir $dir;
5061 }
5062 sub cmd_remote_push_build_host {
5063     responder_send_command("dgit-remote-push-ready $protovsn");
5064     &cmd_push;
5065 }
5066
5067 sub pre_remote_push_responder { pre_remote_push_build_host(); }
5068 sub cmd_remote_push_responder { cmd_remote_push_build_host(); }
5069 # ... for compatibility with proto vsn.1 dgit (just so that user gets
5070 #     a good error message)
5071
5072 sub rpush_handle_protovsn_bothends () {
5073 }
5074
5075 our $i_tmp;
5076
5077 sub i_cleanup {
5078     local ($@, $?);
5079     my $report = i_child_report();
5080     if (defined $report) {
5081         printdebug "($report)\n";
5082     } elsif ($i_child_pid) {
5083         printdebug "(killing build host child $i_child_pid)\n";
5084         kill 15, $i_child_pid;
5085     }
5086     if (defined $i_tmp && !defined $initiator_tempdir) {
5087         changedir "/";
5088         eval { rmtree $i_tmp; };
5089     }
5090 }
5091
5092 END {
5093     return unless forkcheck_mainprocess();
5094     i_cleanup();
5095 }
5096
5097 sub i_method {
5098     my ($base,$selector,@args) = @_;
5099     $selector =~ s/\-/_/g;
5100     { no strict qw(refs); &{"${base}_${selector}"}(@args); }
5101 }
5102
5103 sub pre_rpush () {
5104     not_necessarily_a_tree();
5105 }
5106 sub cmd_rpush {
5107     my $host = nextarg;
5108     my $dir;
5109     if ($host =~ m/^((?:[^][]|\[[^][]*\])*)\:/) {
5110         $host = $1;
5111         $dir = $'; #';
5112     } else {
5113         $dir = nextarg;
5114     }
5115     $dir =~ s{^-}{./-};
5116     my @rargs = ($dir);
5117     push @rargs, join ",", @rpushprotovsn_support;
5118     my @rdgit;
5119     push @rdgit, @dgit;
5120     push @rdgit, @ropts;
5121     push @rdgit, qw(remote-push-build-host), (scalar @rargs), @rargs;
5122     push @rdgit, @ARGV;
5123     my @cmd = (@ssh, $host, shellquote @rdgit);
5124     debugcmd "+",@cmd;
5125
5126     $we_are_initiator=1;
5127
5128     if (defined $initiator_tempdir) {
5129         rmtree $initiator_tempdir;
5130         mkdir $initiator_tempdir, 0700
5131             or fail f_ "create %s: %s", $initiator_tempdir, $!;
5132         $i_tmp = $initiator_tempdir;
5133     } else {
5134         $i_tmp = tempdir();
5135     }
5136     $i_child_pid = open2(\*RO, \*RI, @cmd);
5137     changedir $i_tmp;
5138     ($protovsn) = initiator_expect { m/^dgit-remote-push-ready (\S+)/ };
5139     die "$protovsn ?" unless grep { $_ eq $protovsn } @rpushprotovsn_support;
5140
5141     for (;;) {
5142         my ($icmd,$iargs) = initiator_expect {
5143             m/^(\S+)(?: (.*))?$/;
5144             ($1,$2);
5145         };
5146         i_method "i_resp", $icmd, $iargs;
5147     }
5148 }
5149
5150 sub i_resp_progress ($) {
5151     my ($rhs) = @_;
5152     my $msg = protocol_read_bytes \*RO, $rhs;
5153     progress $msg;
5154 }
5155
5156 sub i_resp_supplementary_message ($) {
5157     my ($rhs) = @_;
5158     $supplementary_message = protocol_read_bytes \*RO, $rhs;
5159 }
5160
5161 sub i_resp_complete {
5162     my $pid = $i_child_pid;
5163     $i_child_pid = undef; # prevents killing some other process with same pid
5164     printdebug "waiting for build host child $pid...\n";
5165     my $got = waitpid $pid, 0;
5166     confess "$!" unless $got == $pid;
5167     fail f_ "build host child failed: %s", waitstatusmsg() if $?;
5168
5169     i_cleanup();
5170     printdebug __ "all done\n";
5171     finish 0;
5172 }
5173
5174 sub i_resp_file ($) {
5175     my ($keyword) = @_;
5176     my $localname = i_method "i_localname", $keyword;
5177     my $localpath = "$i_tmp/$localname";
5178     stat_exists $localpath and
5179         badproto \*RO, f_ "file %s (%s) twice", $keyword, $localpath;
5180     protocol_receive_file \*RO, $localpath;
5181     i_method "i_file", $keyword;
5182 }
5183
5184 our %i_param;
5185
5186 sub i_resp_param ($) {
5187     $_[0] =~ m/^(\S+) (.*)$/ or badproto \*RO, __ "bad param spec";
5188     $i_param{$1} = $2;
5189 }
5190
5191 sub i_resp_previously ($) {
5192     $_[0] =~ m#^(refs/tags/\S+)=(\w+)$#
5193         or badproto \*RO, __ "bad previously spec";
5194     my $r = system qw(git check-ref-format), $1;
5195     confess "bad previously ref spec ($r)" if $r;
5196     $previously{$1} = $2;
5197 }
5198
5199 our %i_wanted;
5200 our ($i_clogp, $i_version, $i_dscfn, $i_changesfn, @i_buildinfos);
5201
5202 sub i_resp_want ($) {
5203     my ($keyword) = @_;
5204     die "$keyword ?" if $i_wanted{$keyword}++;
5205     
5206     defined $i_param{'csuite'} or badproto \*RO, "premature desire, no csuite";
5207     $isuite = $i_param{'isuite'} // $i_param{'csuite'};
5208     die unless $isuite =~ m/^$suite_re$/;
5209
5210     if (!defined $dsc) {
5211         pushing();
5212         rpush_handle_protovsn_bothends();
5213         push_parse_dsc $i_dscfn, 'remote dsc', $i_version;
5214         if ($protovsn >= 6) {
5215             determine_whether_split_brain getfield $dsc, 'Format';
5216             $do_split_brain eq ($i_param{'splitbrain'} // '<unsent>')
5217                 or badproto \*RO,
5218  "split brain mismatch, $do_split_brain != $i_param{'split_brain'}";
5219             printdebug "rpush split brain $do_split_brain\n";
5220         }
5221     }
5222
5223     my @localpaths = i_method "i_want", $keyword;
5224     printdebug "[[  $keyword @localpaths\n";
5225     foreach my $localpath (@localpaths) {
5226         protocol_send_file \*RI, $localpath;
5227     }
5228     print RI "files-end\n" or confess "$!";
5229 }
5230
5231 sub i_localname_parsed_changelog {
5232     return "remote-changelog.822";
5233 }
5234 sub i_file_parsed_changelog {
5235     ($i_clogp, $i_version, $i_dscfn) =
5236         push_parse_changelog "$i_tmp/remote-changelog.822";
5237     die if $i_dscfn =~ m#/|^\W#;
5238 }
5239
5240 sub i_localname_dsc {
5241     defined $i_dscfn or badproto \*RO, "dsc (before parsed-changelog)";
5242     return $i_dscfn;
5243 }
5244 sub i_file_dsc { }
5245
5246 sub i_localname_buildinfo ($) {
5247     my $bi = $i_param{'buildinfo-filename'};
5248     defined $bi or badproto \*RO, "buildinfo before filename";
5249     defined $i_changesfn or badproto \*RO, "buildinfo before changes";
5250     $bi =~ m{^\Q$package\E_[!-.0-~]*\.buildinfo$}s
5251         or badproto \*RO, "improper buildinfo filename";
5252     return $&;
5253 }
5254 sub i_file_buildinfo {
5255     my $bi = $i_param{'buildinfo-filename'};
5256     my $bd = parsecontrol "$i_tmp/$bi", $bi;
5257     my $ch = parsecontrol "$i_tmp/$i_changesfn", 'changes';
5258     if (!forceing [qw(buildinfo-changes-mismatch)]) {
5259         files_compare_inputs($bd, $ch);
5260         (getfield $bd, $_) eq (getfield $ch, $_) or
5261             fail f_ "buildinfo mismatch in field %s", $_
5262             foreach qw(Source Version);
5263         !defined $bd->{$_} or
5264             fail f_ "buildinfo contains forbidden field %s", $_
5265             foreach qw(Changes Changed-by Distribution);
5266     }
5267     push @i_buildinfos, $bi;
5268     delete $i_param{'buildinfo-filename'};
5269 }
5270
5271 sub i_localname_changes {
5272     defined $i_dscfn or badproto \*RO, "dsc (before parsed-changelog)";
5273     $i_changesfn = $i_dscfn;
5274     $i_changesfn =~ s/\.dsc$/_dgit.changes/ or die;
5275     return $i_changesfn;
5276 }
5277 sub i_file_changes { }
5278
5279 sub i_want_signed_tag {
5280     printdebug Dumper(\%i_param, $i_dscfn);
5281     defined $i_param{'head'} && defined $i_dscfn && defined $i_clogp
5282         && defined $i_param{'csuite'}
5283         or badproto \*RO, "premature desire for signed-tag";
5284     my $head = $i_param{'head'};
5285     die if $head =~ m/[^0-9a-f]/ || $head !~ m/^../;
5286
5287     my $maintview = $i_param{'maint-view'};
5288     die if defined $maintview && $maintview =~ m/[^0-9a-f]/;
5289
5290     if ($protovsn == 4) {
5291         my $p = $i_param{'tagformat'} // '<undef>';
5292         $p eq 'new'
5293             or badproto \*RO, "tag format mismatch: $p vs. new";
5294     }
5295
5296     die unless $i_param{'csuite'} =~ m/^$suite_re$/;
5297     $csuite = $&;
5298     defined $dsc or badproto \*RO, "dsc (before parsed-changelog)";
5299
5300     my @tagwants = push_tagwants $i_version, $head, $maintview, "tag";
5301
5302     return
5303         push_mktags $i_clogp, $i_dscfn,
5304             $i_changesfn, (__ 'remote changes file'),
5305             \@tagwants;
5306 }
5307
5308 sub i_want_signed_dsc_changes {
5309     rename "$i_dscfn.tmp","$i_dscfn" or die "$i_dscfn $!";
5310     sign_changes $i_changesfn;
5311     return ($i_dscfn, $i_changesfn, @i_buildinfos);
5312 }
5313
5314 #---------- building etc. ----------
5315
5316 our $version;
5317 our $sourcechanges;
5318 our $dscfn;
5319
5320 #----- `3.0 (quilt)' handling -----
5321
5322 our $fakeeditorenv = 'DGIT_FAKE_EDITOR_QUILT';
5323
5324 sub quiltify_dpkg_commit ($$$;$) {
5325     my ($patchname,$author,$msg, $xinfo) = @_;
5326     $xinfo //= '';
5327
5328     mkpath '.git/dgit'; # we are in playtree
5329     my $descfn = ".git/dgit/quilt-description.tmp";
5330     open O, '>', $descfn or confess "$descfn: $!";
5331     $msg =~ s/\n+/\n\n/;
5332     print O <<END or confess "$!";
5333 From: $author
5334 ${xinfo}Subject: $msg
5335 ---
5336
5337 END
5338     close O or confess "$!";
5339
5340     {
5341         local $ENV{'EDITOR'} = cmdoutput qw(realpath --), $0;
5342         local $ENV{'VISUAL'} = $ENV{'EDITOR'};
5343         local $ENV{$fakeeditorenv} = cmdoutput qw(realpath --), $descfn;
5344         runcmd @dpkgsource, qw(--commit --include-removal .), $patchname;
5345     }
5346 }
5347
5348 sub quiltify_trees_differ ($$;$$$) {
5349     my ($x,$y,$finegrained,$ignorenamesr,$unrepres) = @_;
5350     # returns true iff the two tree objects differ other than in debian/
5351     # with $finegrained,
5352     # returns bitmask 01 - differ in upstream files except .gitignore
5353     #                 02 - differ in .gitignore
5354     # if $ignorenamesr is defined, $ingorenamesr->{$fn}
5355     #  is set for each modified .gitignore filename $fn
5356     # if $unrepres is defined, array ref to which is appeneded
5357     #  a list of unrepresentable changes (removals of upstream files
5358     #  (as messages)
5359     local $/=undef;
5360     my @cmd = (@git, qw(diff-tree -z --no-renames));
5361     push @cmd, qw(--name-only) unless $unrepres;
5362     push @cmd, qw(-r) if $finegrained || $unrepres;
5363     push @cmd, $x, $y;
5364     my $diffs= cmdoutput @cmd;
5365     my $r = 0;
5366     my @lmodes;
5367     foreach my $f (split /\0/, $diffs) {
5368         if ($unrepres && !@lmodes) {
5369             @lmodes = $f =~ m/^\:(\w+) (\w+) \w+ \w+ / or die "$_ ?";
5370             next;
5371         }
5372         my ($oldmode,$newmode) = @lmodes;
5373         @lmodes = ();
5374
5375         next if $f =~ m#^debian(?:/.*)?$#s;
5376
5377         if ($unrepres) {
5378             eval {
5379                 die __ "not a plain file or symlink\n"
5380                     unless $newmode =~ m/^(?:10|12)\d{4}$/ ||
5381                            $oldmode =~ m/^(?:10|12)\d{4}$/;
5382                 if ($oldmode =~ m/[^0]/ &&
5383                     $newmode =~ m/[^0]/) {
5384                     # both old and new files exist
5385                     die __ "mode or type changed\n" if $oldmode ne $newmode;
5386                     die __ "modified symlink\n" unless $newmode =~ m/^10/;
5387                 } elsif ($oldmode =~ m/[^0]/) {
5388                     # deletion
5389                     die __ "deletion of symlink\n"
5390                         unless $oldmode =~ m/^10/;
5391                 } else {
5392                     # creation
5393                     die __ "creation with non-default mode\n"
5394                         unless $newmode =~ m/^100644$/ or
5395                                $newmode =~ m/^120000$/;
5396                 }
5397             };
5398             if ($@) {
5399                 local $/="\n"; chomp $@;
5400                 push @$unrepres, [ $f, "$@ ($oldmode->$newmode)" ];
5401             }
5402         }
5403
5404         my $isignore = $f =~ m#^(?:.*/)?.gitignore$#s;
5405         $r |= $isignore ? 02 : 01;
5406         $ignorenamesr->{$f}=1 if $ignorenamesr && $isignore;
5407     }
5408     printdebug "quiltify_trees_differ $x $y => $r\n";
5409     return $r;
5410 }
5411
5412 sub quiltify_tree_sentinelfiles ($) {
5413     # lists the `sentinel' files present in the tree
5414     my ($x) = @_;
5415     my $r = cmdoutput @git, qw(ls-tree --name-only), $x,
5416         qw(-- debian/rules debian/control);
5417     $r =~ s/\n/,/g;
5418     return $r;
5419 }
5420
5421 sub quiltify_splitting ($$$$$$$) {
5422     my ($clogp, $unapplied, $headref, $oldtiptree, $diffbits,
5423         $editedignores, $cachekey) = @_;
5424     my $gitignore_special = 1;
5425     if ($quilt_mode !~ m/gbp|dpm|baredebian/) {
5426         # treat .gitignore just like any other upstream file
5427         $diffbits = { %$diffbits };
5428         $_ = !!$_ foreach values %$diffbits;
5429         $gitignore_special = 0;
5430     }
5431     # We would like any commits we generate to be reproducible
5432     my @authline = clogp_authline($clogp);
5433     local $ENV{GIT_COMMITTER_NAME} =  $authline[0];
5434     local $ENV{GIT_COMMITTER_EMAIL} = $authline[1];
5435     local $ENV{GIT_COMMITTER_DATE} =  $authline[2];
5436     local $ENV{GIT_AUTHOR_NAME} =  $authline[0];
5437     local $ENV{GIT_AUTHOR_EMAIL} = $authline[1];
5438     local $ENV{GIT_AUTHOR_DATE} =  $authline[2];
5439
5440     confess unless do_split_brain();
5441
5442     my $fulldiffhint = sub {
5443         my ($x,$y) = @_;
5444         my $cmd = "git diff $x $y -- :/ ':!debian'";
5445         $cmd .= " ':!/.gitignore' ':!*/.gitignore'" if $gitignore_special;
5446         return f_ "\nFor full diff showing the problem(s), type:\n %s\n",
5447                   $cmd;
5448     };
5449
5450     if ($quilt_mode =~ m/gbp|unapplied|baredebian/ &&
5451         ($diffbits->{O2H} & 01)) {
5452         my $msg = f_
5453  "--quilt=%s specified, implying patches-unapplied git tree\n".
5454  " but git tree differs from orig in upstream files.",
5455                      $quilt_mode;
5456         $msg .= $fulldiffhint->($unapplied, 'HEAD');
5457         if (!stat_exists "debian/patches" and $quilt_mode !~ m/baredebian/) {
5458             $msg .= __
5459  "\n ... debian/patches is missing; perhaps this is a patch queue branch?";
5460         }  
5461         fail $msg;
5462     }
5463     if ($quilt_mode =~ m/dpm/ &&
5464         ($diffbits->{H2A} & 01)) {
5465         fail +(f_ <<END, $quilt_mode). $fulldiffhint->($oldtiptree,'HEAD');
5466 --quilt=%s specified, implying patches-applied git tree
5467  but git tree differs from result of applying debian/patches to upstream
5468 END
5469     }
5470     if ($quilt_mode =~ m/baredebian/) {
5471         # We need to construct a merge which has upstream files from
5472         # upstream and debian/ files from HEAD.
5473
5474         read_tree_upstream $quilt_upstream_commitish, 1, $headref;
5475         my $version = getfield $clogp, 'Version';
5476         my $upsversion = upstreamversion $version;
5477         my $merge = make_commit
5478             [ $headref, $quilt_upstream_commitish ],
5479  [ +(f_ <<ENDT, $upsversion), $quilt_upstream_commitish_message, <<ENDU ];
5480 Combine debian/ with upstream source for %s
5481 ENDT
5482 [dgit ($our_version) baredebian-merge $version $quilt_upstream_commitish_used]
5483 ENDU
5484         runcmd @git, qw(reset -q --hard), $merge;
5485     }
5486     if ($quilt_mode =~ m/gbp|unapplied|baredebian/ &&
5487         ($diffbits->{O2A} & 01)) { # some patches
5488         progress __ "dgit view: creating patches-applied version using gbp pq";
5489         runcmd shell_cmd 'exec >/dev/null', gbp_pq, qw(import);
5490         # gbp pq import creates a fresh branch; push back to dgit-view
5491         runcmd @git, qw(update-ref refs/heads/dgit-view HEAD);
5492         runcmd @git, qw(checkout -q dgit-view);
5493     }
5494     if ($quilt_mode =~ m/gbp|dpm/ &&
5495         ($diffbits->{O2A} & 02)) {
5496         fail f_ <<END, $quilt_mode;
5497 --quilt=%s specified, implying that HEAD is for use with a
5498  tool which does not create patches for changes to upstream
5499  .gitignores: but, such patches exist in debian/patches.
5500 END
5501     }
5502     if (($diffbits->{O2H} & 02) && # user has modified .gitignore
5503         !($diffbits->{O2A} & 02)) { # patches do not change .gitignore
5504         progress __
5505             "dgit view: creating patch to represent .gitignore changes";
5506         ensuredir "debian/patches";
5507         my $gipatch = "debian/patches/auto-gitignore";
5508         open GIPATCH, ">>", "$gipatch" or confess "$gipatch: $!";
5509         stat GIPATCH or confess "$gipatch: $!";
5510         fail f_ "%s already exists; but want to create it".
5511                 " to record .gitignore changes",
5512                 $gipatch
5513             if (stat _)[7];
5514         print GIPATCH +(__ <<END).<<ENDU or die "$gipatch: $!";
5515 Subject: Update .gitignore from Debian packaging branch
5516
5517 The Debian packaging git branch contains these updates to the upstream
5518 .gitignore file(s).  This patch is autogenerated, to provide these
5519 updates to users of the official Debian archive view of the package.
5520 END
5521
5522 [dgit ($our_version) update-gitignore]
5523 ---
5524 ENDU
5525         close GIPATCH or die "$gipatch: $!";
5526         runcmd shell_cmd "exec >>$gipatch", @git, qw(diff),
5527             $unapplied, $headref, "--", sort keys %$editedignores;
5528         open SERIES, "+>>", "debian/patches/series" or confess "$!";
5529         defined seek SERIES, -1, 2 or $!==EINVAL or confess "$!";
5530         my $newline;
5531         defined read SERIES, $newline, 1 or confess "$!";
5532         print SERIES "\n" or confess "$!" unless $newline eq "\n";
5533         print SERIES "auto-gitignore\n" or confess "$!";
5534         close SERIES or die  $!;
5535         runcmd @git, qw(add -f -- debian/patches/series), $gipatch;
5536         commit_admin +(__ <<END).<<ENDU
5537 Commit patch to update .gitignore
5538 END
5539
5540 [dgit ($our_version) update-gitignore-quilt-fixup]
5541 ENDU
5542     }
5543 }
5544
5545 sub quiltify ($$$$) {
5546     my ($clogp,$target,$oldtiptree,$failsuggestion) = @_;
5547
5548     # Quilt patchification algorithm
5549     #
5550     # We search backwards through the history of the main tree's HEAD
5551     # (T) looking for a start commit S whose tree object is identical
5552     # to to the patch tip tree (ie the tree corresponding to the
5553     # current dpkg-committed patch series).  For these purposes
5554     # `identical' disregards anything in debian/ - this wrinkle is
5555     # necessary because dpkg-source treates debian/ specially.
5556     #
5557     # We can only traverse edges where at most one of the ancestors'
5558     # trees differs (in changes outside in debian/).  And we cannot
5559     # handle edges which change .pc/ or debian/patches.  To avoid
5560     # going down a rathole we avoid traversing edges which introduce
5561     # debian/rules or debian/control.  And we set a limit on the
5562     # number of edges we are willing to look at.
5563     #
5564     # If we succeed, we walk forwards again.  For each traversed edge
5565     # PC (with P parent, C child) (starting with P=S and ending with
5566     # C=T) to we do this:
5567     #  - git checkout C
5568     #  - dpkg-source --commit with a patch name and message derived from C
5569     # After traversing PT, we git commit the changes which
5570     # should be contained within debian/patches.
5571
5572     # The search for the path S..T is breadth-first.  We maintain a
5573     # todo list containing search nodes.  A search node identifies a
5574     # commit, and looks something like this:
5575     #  $p = {
5576     #      Commit => $git_commit_id,
5577     #      Child => $c,                          # or undef if P=T
5578     #      Whynot => $reason_edge_PC_unsuitable, # in @nots only
5579     #      Nontrivial => true iff $p..$c has relevant changes
5580     #  };
5581
5582     my @todo;
5583     my @nots;
5584     my $sref_S;
5585     my $max_work=100;
5586     my %considered; # saves being exponential on some weird graphs
5587
5588     my $t_sentinels = quiltify_tree_sentinelfiles $target;
5589
5590     my $not = sub {
5591         my ($search,$whynot) = @_;
5592         printdebug " search NOT $search->{Commit} $whynot\n";
5593         $search->{Whynot} = $whynot;
5594         push @nots, $search;
5595         no warnings qw(exiting);
5596         next;
5597     };
5598
5599     push @todo, {
5600         Commit => $target,
5601     };
5602
5603     while (@todo) {
5604         my $c = shift @todo;
5605         next if $considered{$c->{Commit}}++;
5606
5607         $not->($c, __ "maximum search space exceeded") if --$max_work <= 0;
5608
5609         printdebug "quiltify investigate $c->{Commit}\n";
5610
5611         # are we done?
5612         if (!quiltify_trees_differ $c->{Commit}, $oldtiptree) {
5613             printdebug " search finished hooray!\n";
5614             $sref_S = $c;
5615             last;
5616         }
5617
5618         quiltify_nofix_bail " $c->{Commit}", " (tree object $oldtiptree)";
5619         if ($quilt_mode eq 'smash') {
5620             printdebug " search quitting smash\n";
5621             last;
5622         }
5623
5624         my $c_sentinels = quiltify_tree_sentinelfiles $c->{Commit};
5625         $not->($c, f_ "has %s not %s", $c_sentinels, $t_sentinels)
5626             if $c_sentinels ne $t_sentinels;
5627
5628         my $commitdata = cmdoutput @git, qw(cat-file commit), $c->{Commit};
5629         $commitdata =~ m/\n\n/;
5630         $commitdata =~ $`;
5631         my @parents = ($commitdata =~ m/^parent (\w+)$/gm);
5632         @parents = map { { Commit => $_, Child => $c } } @parents;
5633
5634         $not->($c, __ "root commit") if !@parents;
5635
5636         foreach my $p (@parents) {
5637             $p->{Nontrivial}= quiltify_trees_differ $p->{Commit},$c->{Commit};
5638         }
5639         my $ndiffers = grep { $_->{Nontrivial} } @parents;
5640         $not->($c, f_ "merge (%s nontrivial parents)", $ndiffers)
5641             if $ndiffers > 1;
5642
5643         foreach my $p (@parents) {
5644             printdebug "considering C=$c->{Commit} P=$p->{Commit}\n";
5645
5646             my @cmd= (@git, qw(diff-tree -r --name-only),
5647                       $p->{Commit},$c->{Commit},
5648                       qw(-- debian/patches .pc debian/source/format));
5649             my $patchstackchange = cmdoutput @cmd;
5650             if (length $patchstackchange) {
5651                 $patchstackchange =~ s/\n/,/g;
5652                 $not->($p, f_ "changed %s", $patchstackchange);
5653             }
5654
5655             printdebug " search queue P=$p->{Commit} ",
5656                 ($p->{Nontrivial} ? "NT" : "triv"),"\n";
5657             push @todo, $p;
5658         }
5659     }
5660
5661     if (!$sref_S) {
5662         printdebug "quiltify want to smash\n";
5663
5664         my $abbrev = sub {
5665             my $x = $_[0]{Commit};
5666             $x =~ s/(.*?[0-9a-z]{8})[0-9a-z]*$/$1/;
5667             return $x;
5668         };
5669         if ($quilt_mode eq 'linear') {
5670             print STDERR f_
5671                 "\n%s: error: quilt fixup cannot be linear.  Stopped at:\n",
5672                 $us;
5673             my $all_gdr = !!@nots;
5674             foreach my $notp (@nots) {
5675                 my $c = $notp->{Child};
5676                 my $cprange = $abbrev->($notp);
5677                 $cprange .= "..".$abbrev->($c) if $c;
5678                 print STDERR f_ "%s:  %s: %s\n",
5679                     $us, $cprange, $notp->{Whynot};
5680                 $all_gdr &&= $notp->{Child} &&
5681                     (git_cat_file $notp->{Child}{Commit}, 'commit')
5682                     =~ m{^\[git-debrebase(?! split[: ]).*\]$}m;
5683             }
5684             print STDERR "\n";
5685             $failsuggestion =
5686                 [ grep { $_->[0] ne 'quilt-mode' } @$failsuggestion ]
5687                 if $all_gdr;
5688             print STDERR "$us: $_->[1]\n" foreach @$failsuggestion;
5689             fail __
5690  "quilt history linearisation failed.  Search \`quilt fixup' in dgit(7).\n";
5691         } elsif ($quilt_mode eq 'smash') {
5692         } elsif ($quilt_mode eq 'auto') {
5693             progress __ "quilt fixup cannot be linear, smashing...";
5694         } else {
5695             confess "$quilt_mode ?";
5696         }
5697
5698         my $time = $ENV{'GIT_COMMITTER_DATE'} || time;
5699         $time =~ s/\s.*//; # trim timezone from GIT_COMMITTER_DATE
5700         my $ncommits = 3;
5701         my $msg = cmdoutput @git, qw(log), "-n$ncommits";
5702
5703         quiltify_dpkg_commit "auto-$version-$target-$time",
5704             (getfield $clogp, 'Maintainer'),
5705             (f_ "Automatically generated patch (%s)\n".
5706              "Last (up to) %s git changes, FYI:\n\n",
5707              $clogp->{Version}, $ncommits).
5708              $msg;
5709         return;
5710     }
5711
5712     progress __ "quiltify linearisation planning successful, executing...";
5713
5714     for (my $p = $sref_S;
5715          my $c = $p->{Child};
5716          $p = $p->{Child}) {
5717         printdebug "quiltify traverse $p->{Commit}..$c->{Commit}\n";
5718         next unless $p->{Nontrivial};
5719
5720         my $cc = $c->{Commit};
5721
5722         my $commitdata = cmdoutput @git, qw(cat-file commit), $cc;
5723         $commitdata =~ m/\n\n/ or die "$c ?";
5724         $commitdata = $`;
5725         my $msg = $'; #';
5726         $commitdata =~ m/^author (.*) \d+ [-+0-9]+$/m or die "$cc ?";
5727         my $author = $1;
5728
5729         my $commitdate = cmdoutput
5730             @git, qw(log -n1 --pretty=format:%aD), $cc;
5731
5732         $msg =~ s/^(.*)\n*/$1\n/ or die "$cc $msg ?";
5733
5734         my $strip_nls = sub { $msg =~ s/\n+$//; $msg .= "\n"; };
5735         $strip_nls->();
5736
5737         my $title = $1;
5738         my $patchname;
5739         my $patchdir;
5740
5741         my $gbp_check_suitable = sub {
5742             $_ = shift;
5743             my ($what) = @_;
5744
5745             eval {
5746                 die __ "contains unexpected slashes\n" if m{//} || m{/$};
5747                 die __ "contains leading punctuation\n" if m{^\W} || m{/\W};
5748                 die __ "contains bad character(s)\n" if m{[^-a-z0-9_.+=~/]}i;
5749                 die __ "is series file\n" if m{$series_filename_re}o;
5750                 die __ "too long\n" if length > 200;
5751             };
5752             return $_ unless $@;
5753             print STDERR f_
5754                 "quiltifying commit %s: ignoring/dropping Gbp-Pq %s: %s",
5755                 $cc, $what, $@;
5756             return undef;
5757         };
5758
5759         if ($msg =~ s/^ (?: gbp(?:-pq)? : \s* name \s+ |
5760                            gbp-pq-name: \s* )
5761                        (\S+) \s* \n //ixm) {
5762             $patchname = $gbp_check_suitable->($1, 'Name');
5763         }
5764         if ($msg =~ s/^ (?: gbp(?:-pq)? : \s* topic \s+ |
5765                            gbp-pq-topic: \s* )
5766                        (\S+) \s* \n //ixm) {
5767             $patchdir = $gbp_check_suitable->($1, 'Topic');
5768         }
5769
5770         $strip_nls->();
5771
5772         if (!defined $patchname) {
5773             $patchname = $title;
5774             $patchname =~ s/[.:]$//;
5775             use Text::Iconv;
5776             eval {
5777                 my $converter = new Text::Iconv qw(UTF-8 ASCII//TRANSLIT);
5778                 my $translitname = $converter->convert($patchname);
5779                 die unless defined $translitname;
5780                 $patchname = $translitname;
5781             };
5782             print STDERR
5783                 +(f_ "dgit: patch title transliteration error: %s", $@)
5784                 if $@;
5785             $patchname =~ y/ A-Z/-a-z/;
5786             $patchname =~ y/-a-z0-9_.+=~//cd;
5787             $patchname =~ s/^\W/x-$&/;
5788             $patchname = substr($patchname,0,40);
5789             $patchname .= ".patch";
5790         }
5791         if (!defined $patchdir) {
5792             $patchdir = '';
5793         }
5794         if (length $patchdir) {
5795             $patchname = "$patchdir/$patchname";
5796         }
5797         if ($patchname =~ m{^(.*)/}) {
5798             mkpath "debian/patches/$1";
5799         }
5800
5801         my $index;
5802         for ($index='';
5803              stat "debian/patches/$patchname$index";
5804              $index++) { }
5805         $!==ENOENT or confess "$patchname$index $!";
5806
5807         runcmd @git, qw(checkout -q), $cc;
5808
5809         # We use the tip's changelog so that dpkg-source doesn't
5810         # produce complaining messages from dpkg-parsechangelog.  None
5811         # of the information dpkg-source gets from the changelog is
5812         # actually relevant - it gets put into the original message
5813         # which dpkg-source provides our stunt editor, and then
5814         # overwritten.
5815         runcmd @git, qw(checkout -q), $target, qw(debian/changelog);
5816
5817         quiltify_dpkg_commit "$patchname$index", $author, $msg,
5818             "Date: $commitdate\n".
5819             "X-Dgit-Generated: $clogp->{Version} $cc\n";
5820
5821         runcmd @git, qw(checkout -q), $cc, qw(debian/changelog);
5822     }
5823 }
5824
5825 sub build_maybe_quilt_fixup () {
5826     my ($format,$fopts) = get_source_format;
5827     return unless madformat_wantfixup $format;
5828     # sigh
5829
5830     check_for_vendor_patches();
5831
5832     my $clogp = parsechangelog();
5833     my $headref = git_rev_parse('HEAD');
5834     my $symref = git_get_symref();
5835     my $upstreamversion = upstreamversion $version;
5836
5837     prep_ud();
5838     changedir $playground;
5839
5840     my $splitbrain_cachekey;
5841
5842     if (do_split_brain()) {
5843         my $cachehit;
5844         ($cachehit, $splitbrain_cachekey) =
5845             quilt_check_splitbrain_cache($headref, $upstreamversion);
5846         if ($cachehit) {
5847             changedir $maindir;
5848             return;
5849         }
5850     }
5851
5852     unpack_playtree_need_cd_work($headref);
5853     if (do_split_brain()) {
5854         runcmd @git, qw(checkout -q -b dgit-view);
5855         # so long as work is not deleted, its current branch will
5856         # remain dgit-view, rather than master, so subsequent calls to
5857         #  unpack_playtree_need_cd_work
5858         # will DTRT, resetting dgit-view.
5859         confess if $made_split_brain;
5860         $made_split_brain = 1;
5861     }
5862     chdir '..';
5863
5864     if ($fopts->{'single-debian-patch'}) {
5865         fail f_
5866  "quilt mode %s does not make sense (or is not supported) with single-debian-patch",
5867             $quilt_mode
5868             if quiltmode_splitting();
5869         quilt_fixup_singlepatch($clogp, $headref, $upstreamversion);
5870     } else {
5871         quilt_fixup_multipatch($clogp, $headref, $upstreamversion,
5872                               $splitbrain_cachekey);
5873     }
5874
5875     if (do_split_brain()) {
5876         my $dgitview = git_rev_parse 'HEAD';
5877
5878         changedir $maindir;
5879         reflog_cache_insert "refs/$splitbraincache",
5880             $splitbrain_cachekey, $dgitview;
5881
5882         changedir "$playground/work";
5883
5884         my $saved = maybe_split_brain_save $headref, $dgitview, __ "converted";
5885         progress f_ "dgit view: created (%s)", $saved;
5886     }
5887
5888     changedir $maindir;
5889     runcmd_ordryrun_local
5890         @git, qw(pull --ff-only -q), "$playground/work", qw(master);
5891 }
5892
5893 sub build_check_quilt_splitbrain () {
5894     build_maybe_quilt_fixup();
5895 }
5896
5897 sub unpack_playtree_need_cd_work ($) {
5898     my ($headref) = @_;
5899
5900     # prep_ud() must have been called already.
5901     if (!chdir "work") {
5902         # Check in the filesystem because sometimes we run prep_ud
5903         # in between multiple calls to unpack_playtree_need_cd_work.
5904         confess "$!" unless $!==ENOENT;
5905         mkdir "work" or confess "$!";
5906         changedir "work";
5907         mktree_in_ud_here();
5908     }
5909     runcmd @git, qw(reset -q --hard), $headref;
5910 }
5911
5912 sub unpack_playtree_linkorigs ($$) {
5913     my ($upstreamversion, $fn) = @_;
5914     # calls $fn->($leafname);
5915
5916     my $bpd_abs = bpd_abs();
5917
5918     dotdot_bpd_transfer_origs $bpd_abs, $upstreamversion, sub { 1 };
5919
5920     opendir QFD, $bpd_abs or fail "buildproductsdir: $bpd_abs: $!";
5921     while ($!=0, defined(my $leaf = readdir QFD)) {
5922         my $f = bpd_abs()."/".$leaf;
5923         {
5924             local ($debuglevel) = $debuglevel-1;
5925             printdebug "QF linkorigs bpd $leaf, $f ?\n";
5926         }
5927         next unless is_orig_file_of_vsn $leaf, $upstreamversion;
5928         printdebug "QF linkorigs $leaf, $f Y\n";
5929         link_ltarget $f, $leaf or die "$leaf $!";
5930         $fn->($leaf);
5931     }
5932     die "$buildproductsdir: $!" if $!;
5933     closedir QFD;
5934 }
5935
5936 sub quilt_fixup_delete_pc () {
5937     runcmd @git, qw(rm -rqf .pc);
5938     commit_admin +(__ <<END).<<ENDU
5939 Commit removal of .pc (quilt series tracking data)
5940 END
5941
5942 [dgit ($our_version) upgrade quilt-remove-pc]
5943 ENDU
5944 }
5945
5946 sub quilt_fixup_singlepatch ($$$) {
5947     my ($clogp, $headref, $upstreamversion) = @_;
5948
5949     progress __ "starting quiltify (single-debian-patch)";
5950
5951     # dpkg-source --commit generates new patches even if
5952     # single-debian-patch is in debian/source/options.  In order to
5953     # get it to generate debian/patches/debian-changes, it is
5954     # necessary to build the source package.
5955
5956     unpack_playtree_linkorigs($upstreamversion, sub { });
5957     unpack_playtree_need_cd_work($headref);
5958
5959     rmtree("debian/patches");
5960
5961     runcmd @dpkgsource, qw(-b .);
5962     changedir "..";
5963     runcmd @dpkgsource, qw(-x), (srcfn $version, ".dsc");
5964     rename srcfn("$upstreamversion", "/debian/patches"), 
5965         "work/debian/patches"
5966         or $!==ENOENT
5967         or confess "install d/patches: $!";
5968
5969     changedir "work";
5970     commit_quilty_patch();
5971 }
5972
5973 sub quilt_need_fake_dsc ($) {
5974     # cwd should be playground
5975     my ($upstreamversion) = @_;
5976
5977     return if stat_exists "fake.dsc";
5978     # ^ OK to test this as a sentinel because if we created it
5979     # we must either have done the rest too, or crashed.
5980
5981     my $fakeversion="$upstreamversion-~~DGITFAKE";
5982
5983     my $fakedsc=new IO::File 'fake.dsc', '>' or confess "$!";
5984     print $fakedsc <<END or confess "$!";
5985 Format: 3.0 (quilt)
5986 Source: $package
5987 Version: $fakeversion
5988 Files:
5989 END
5990
5991     my $dscaddfile=sub {
5992         my ($leaf) = @_;
5993         
5994         my $md = new Digest::MD5;
5995
5996         my $fh = new IO::File $leaf, '<' or die "$leaf $!";
5997         stat $fh or confess "$!";
5998         my $size = -s _;
5999
6000         $md->addfile($fh);
6001         print $fakedsc " ".$md->hexdigest." $size $leaf\n" or confess "$!";
6002     };
6003
6004     unpack_playtree_linkorigs($upstreamversion, $dscaddfile);
6005
6006     my @files=qw(debian/source/format debian/rules
6007                  debian/control debian/changelog);
6008     foreach my $maybe (qw(debian/patches debian/source/options
6009                           debian/tests/control)) {
6010         next unless stat_exists "$maindir/$maybe";
6011         push @files, $maybe;
6012     }
6013
6014     my $debtar= srcfn $fakeversion,'.debian.tar.gz';
6015     runcmd qw(env GZIP=-1n tar -zcf), "./$debtar", qw(-C), $maindir, @files;
6016
6017     $dscaddfile->($debtar);
6018     close $fakedsc or confess "$!";
6019 }
6020
6021 sub quilt_fakedsc2unapplied ($$) {
6022     my ($headref, $upstreamversion) = @_;
6023     # must be run in the playground
6024     # quilt_need_fake_dsc must have been called
6025
6026     quilt_need_fake_dsc($upstreamversion);
6027     runcmd qw(sh -ec),
6028         'exec dpkg-source --no-check --skip-patches -x fake.dsc >/dev/null';
6029
6030     my $fakexdir= $package.'-'.(stripepoch $upstreamversion);
6031     rename $fakexdir, "fake" or die "$fakexdir $!";
6032
6033     changedir 'fake';
6034
6035     remove_stray_gits(__ "source package");
6036     mktree_in_ud_here();
6037
6038     rmtree '.pc';
6039
6040     rmtree 'debian'; # git checkout commitish paths does not delete!
6041     runcmd @git, qw(checkout -f), $headref, qw(-- debian);
6042     my $unapplied=git_add_write_tree();
6043     printdebug "fake orig tree object $unapplied\n";
6044     return $unapplied;
6045 }    
6046
6047 sub quilt_check_splitbrain_cache ($$) {
6048     my ($headref, $upstreamversion) = @_;
6049     # Called only if we are in (potentially) split brain mode.
6050     # Called in playground.
6051     # Computes the cache key and looks in the cache.
6052     # Returns ($dgit_view_commitid, $cachekey) or (undef, $cachekey)
6053
6054     quilt_need_fake_dsc($upstreamversion);
6055
6056     my $splitbrain_cachekey;
6057     
6058     progress f_
6059  "dgit: split brain (separate dgit view) may be needed (--quilt=%s).",
6060                 $quilt_mode;
6061     # we look in the reflog of dgit-intern/quilt-cache
6062     # we look for an entry whose message is the key for the cache lookup
6063     my @cachekey = (qw(dgit), $our_version);
6064     push @cachekey, $upstreamversion;
6065     push @cachekey, $quilt_mode;
6066     push @cachekey, $headref;
6067     push @cachekey, $quilt_upstream_commitish // '-';
6068
6069     push @cachekey, hashfile('fake.dsc');
6070
6071     my $srcshash = Digest::SHA->new(256);
6072     my %sfs = ( %INC, '$0(dgit)' => $0 );
6073     foreach my $sfk (sort keys %sfs) {
6074         next unless $sfk =~ m/^\$0\b/ || $sfk =~ m{^Debian/Dgit\b};
6075         $srcshash->add($sfk,"  ");
6076         $srcshash->add(hashfile($sfs{$sfk}));
6077         $srcshash->add("\n");
6078     }
6079     push @cachekey, $srcshash->hexdigest();
6080     $splitbrain_cachekey = "@cachekey";
6081
6082     printdebug "splitbrain cachekey $splitbrain_cachekey\n";
6083
6084     my $cachehit = reflog_cache_lookup
6085         "refs/$splitbraincache", $splitbrain_cachekey;
6086
6087     if ($cachehit) {
6088         unpack_playtree_need_cd_work($headref);
6089         my $saved = maybe_split_brain_save $headref, $cachehit, "cache-hit";
6090         if ($cachehit ne $headref) {
6091             progress f_ "dgit view: found cached (%s)", $saved;
6092             runcmd @git, qw(checkout -q -b dgit-view), $cachehit;
6093             $made_split_brain = 1;
6094             return ($cachehit, $splitbrain_cachekey);
6095         }
6096         progress __ "dgit view: found cached, no changes required";
6097         return ($headref, $splitbrain_cachekey);
6098     }
6099
6100     printdebug "splitbrain cache miss\n";
6101     return (undef, $splitbrain_cachekey);
6102 }
6103
6104 sub baredebian_origtarballs_scan ($$$) {
6105     my ($fakedfi, $upstreamversion, $dir) = @_;
6106     if (!opendir OD, $dir) {
6107         return if $! == ENOENT;
6108         fail "opendir $dir (origs): $!";
6109     }
6110
6111     while ($!=0, defined(my $leaf = readdir OD)) {
6112         {
6113             local ($debuglevel) = $debuglevel-1;
6114             printdebug "BDOS $dir $leaf ?\n";
6115         }
6116         next unless is_orig_file_of_vsn $leaf, $upstreamversion;
6117         next if grep { $_->{Filename} eq $leaf } @$fakedfi;
6118         push @$fakedfi, {
6119             Filename => $leaf,
6120             Path => "$dir/$leaf",
6121                         };
6122     }
6123
6124     die "$dir; $!" if $!;
6125     closedir OD;
6126 }
6127
6128 sub quilt_fixup_multipatch ($$$) {
6129     my ($clogp, $headref, $upstreamversion, $splitbrain_cachekey) = @_;
6130
6131     progress f_ "examining quilt state (multiple patches, %s mode)",
6132                 $quilt_mode;
6133
6134     # Our objective is:
6135     #  - honour any existing .pc in case it has any strangeness
6136     #  - determine the git commit corresponding to the tip of
6137     #    the patch stack (if there is one)
6138     #  - if there is such a git commit, convert each subsequent
6139     #    git commit into a quilt patch with dpkg-source --commit
6140     #  - otherwise convert all the differences in the tree into
6141     #    a single git commit
6142     #
6143     # To do this we:
6144
6145     # Our git tree doesn't necessarily contain .pc.  (Some versions of
6146     # dgit would include the .pc in the git tree.)  If there isn't
6147     # one, we need to generate one by unpacking the patches that we
6148     # have.
6149     #
6150     # We first look for a .pc in the git tree.  If there is one, we
6151     # will use it.  (This is not the normal case.)
6152     #
6153     # Otherwise need to regenerate .pc so that dpkg-source --commit
6154     # can work.  We do this as follows:
6155     #     1. Collect all relevant .orig from parent directory
6156     #     2. Generate a debian.tar.gz out of
6157     #         debian/{patches,rules,source/format,source/options}
6158     #     3. Generate a fake .dsc containing just these fields:
6159     #          Format Source Version Files
6160     #     4. Extract the fake .dsc
6161     #        Now the fake .dsc has a .pc directory.
6162     # (In fact we do this in every case, because in future we will
6163     # want to search for a good base commit for generating patches.)
6164     #
6165     # Then we can actually do the dpkg-source --commit
6166     #     1. Make a new working tree with the same object
6167     #        store as our main tree and check out the main
6168     #        tree's HEAD.
6169     #     2. Copy .pc from the fake's extraction, if necessary
6170     #     3. Run dpkg-source --commit
6171     #     4. If the result has changes to debian/, then
6172     #          - git add them them
6173     #          - git add .pc if we had a .pc in-tree
6174     #          - git commit
6175     #     5. If we had a .pc in-tree, delete it, and git commit
6176     #     6. Back in the main tree, fast forward to the new HEAD
6177
6178     # Another situation we may have to cope with is gbp-style
6179     # patches-unapplied trees.
6180     #
6181     # We would want to detect these, so we know to escape into
6182     # quilt_fixup_gbp.  However, this is in general not possible.
6183     # Consider a package with a one patch which the dgit user reverts
6184     # (with git revert or the moral equivalent).
6185     #
6186     # That is indistinguishable in contents from a patches-unapplied
6187     # tree.  And looking at the history to distinguish them is not
6188     # useful because the user might have made a confusing-looking git
6189     # history structure (which ought to produce an error if dgit can't
6190     # cope, not a silent reintroduction of an unwanted patch).
6191     #
6192     # So gbp users will have to pass an option.  But we can usually
6193     # detect their failure to do so: if the tree is not a clean
6194     # patches-applied tree, quilt linearisation fails, but the tree
6195     # _is_ a clean patches-unapplied tree, we can suggest that maybe
6196     # they want --quilt=unapplied.
6197     #
6198     # To help detect this, when we are extracting the fake dsc, we
6199     # first extract it with --skip-patches, and then apply the patches
6200     # afterwards with dpkg-source --before-build.  That lets us save a
6201     # tree object corresponding to .origs.
6202
6203     if ($quilt_mode eq 'linear'
6204         && branch_is_gdr($headref)) {
6205         # This is much faster.  It also makes patches that gdr
6206         # likes better for future updates without laundering.
6207         #
6208         # However, it can fail in some casses where we would
6209         # succeed: if there are existing patches, which correspond
6210         # to a prefix of the branch, but are not in gbp/gdr
6211         # format, gdr will fail (exiting status 7), but we might
6212         # be able to figure out where to start linearising.  That
6213         # will be slower so hopefully there's not much to do.
6214
6215         unpack_playtree_need_cd_work $headref;
6216
6217         my @cmd = (@git_debrebase,
6218                    qw(--noop-ok -funclean-mixed -funclean-ordering
6219                       make-patches --quiet-would-amend));
6220         # We tolerate soe snags that gdr wouldn't, by default.
6221         if (act_local()) {
6222             debugcmd "+",@cmd;
6223             $!=0; $?=-1;
6224             failedcmd @cmd
6225                 if system @cmd
6226                 and not ($? == 7*256 or
6227                          $? == -1 && $!==ENOENT);
6228         } else {
6229             dryrun_report @cmd;
6230         }
6231         $headref = git_rev_parse('HEAD');
6232
6233         chdir '..';
6234     }
6235
6236     my $unapplied=quilt_fakedsc2unapplied($headref, $upstreamversion);
6237
6238     ensuredir '.pc';
6239
6240     my @bbcmd = (qw(sh -ec), 'exec dpkg-source --before-build . >/dev/null');
6241     $!=0; $?=-1;
6242     if (system @bbcmd) {
6243         failedcmd @bbcmd if $? < 0;
6244         fail __ <<END;
6245 failed to apply your git tree's patch stack (from debian/patches/) to
6246  the corresponding upstream tarball(s).  Your source tree and .orig
6247  are probably too inconsistent.  dgit can only fix up certain kinds of
6248  anomaly (depending on the quilt mode).  Please see --quilt= in dgit(1).
6249 END
6250     }
6251
6252     changedir '..';
6253
6254     unpack_playtree_need_cd_work($headref);
6255
6256     my $mustdeletepc=0;
6257     if (stat_exists ".pc") {
6258         -d _ or die;
6259         progress __ "Tree already contains .pc - will use it then delete it.";
6260         $mustdeletepc=1;
6261     } else {
6262         rename '../fake/.pc','.pc' or confess "$!";
6263     }
6264
6265     changedir '../fake';
6266     rmtree '.pc';
6267     my $oldtiptree=git_add_write_tree();
6268     printdebug "fake o+d/p tree object $unapplied\n";
6269     changedir '../work';
6270
6271
6272     # We calculate some guesswork now about what kind of tree this might
6273     # be.  This is mostly for error reporting.
6274
6275     my $tentries = cmdoutput @git, qw(ls-tree --name-only -z), $headref;
6276     my $onlydebian = $tentries eq "debian\0";
6277
6278     my $uheadref = $headref;
6279     my $uhead_whatshort = 'HEAD';
6280
6281     if ($quilt_mode =~ m/baredebian\+tarball/) {
6282         # We need to make a tarball import.  Yuk.
6283         # We want to do this here so that we have a $uheadref value
6284
6285         my @fakedfi;
6286         baredebian_origtarballs_scan \@fakedfi, $upstreamversion, bpd_abs();
6287         baredebian_origtarballs_scan \@fakedfi, $upstreamversion,
6288             "$maindir/.." unless $buildproductsdir eq '..';
6289         changedir '..';
6290
6291         my @tartrees = import_tarball_tartrees $upstreamversion, \@fakedfi;
6292
6293         fail __ "baredebian quilt fixup: could not find any origs"
6294             unless @tartrees;
6295
6296         changedir 'work';
6297         my ($authline, $r1authline, $clogp,) =
6298             import_tarball_commits \@tartrees, $upstreamversion;
6299
6300         if (@tartrees == 1) {
6301             $uheadref = $tartrees[0]{Commit};
6302             # TRANSLATORS: this translation must fit in the ASCII art
6303             # quilt differences display.  The untranslated display
6304             # says %9.9s, so with that display it must be at most 9
6305             # characters.
6306             $uhead_whatshort = __ 'tarball';
6307         } else {
6308             # on .dsc import we do not make a separate commit, but
6309             # here we need to do so
6310             rm_subdir_cached '.';
6311             my $parents;
6312             foreach my $ti (@tartrees) {
6313                 my $c = $ti->{Commit};
6314                 if ($ti->{OrigPart} eq 'orig') {
6315                     runcmd qw(git read-tree), $c;
6316                 } elsif ($ti->{OrigPart} =~ m/orig-/) {
6317                     read_tree_subdir $', $c;
6318                 } else {
6319                     confess "$ti->OrigPart} ?"
6320                 }
6321                 $parents .= "parent $c\n";
6322             }
6323             my $tree = git_write_tree();
6324             my $mbody = f_ 'Combine orig tarballs for %s %s',
6325                 $package, $upstreamversion;
6326             $uheadref = hash_commit_text <<END;
6327 tree $tree
6328 ${parents}author $r1authline
6329 committer $r1authline
6330
6331 $mbody
6332
6333 [dgit import tarballs combine $package $upstreamversion]
6334 END
6335             # TRANSLATORS: this translation must fit in the ASCII art
6336             # quilt differences display.  The untranslated display
6337             # says %9.9s, so with that display it must be at most 9
6338             # characters.  This fragmentt is referring to multiple
6339             # orig tarballs in a source package.
6340             $uhead_whatshort = __ 'tarballs';
6341
6342             runcmd @git, qw(reset -q);
6343         }
6344         $quilt_upstream_commitish = $uheadref;
6345         $quilt_upstream_commitish_used = '*orig*';
6346         $quilt_upstream_commitish_message = '';
6347     }
6348     if ($quilt_mode =~ m/baredebian$/) {
6349         $uheadref = $quilt_upstream_commitish;
6350         # TRANSLATORS: this translation must fit in the ASCII art
6351         # quilt differences display.  The untranslated display
6352         # says %9.9s, so with that display it must be at most 9
6353         # characters.
6354         $uhead_whatshort = __ 'upstream';
6355     }
6356
6357     my %editedignores;
6358     my @unrepres;
6359     my $diffbits = {
6360         # H = user's HEAD
6361         # O = orig, without patches applied
6362         # A = "applied", ie orig with H's debian/patches applied
6363         O2H => quiltify_trees_differ($unapplied,$uheadref,   1,
6364                                      \%editedignores, \@unrepres),
6365         H2A => quiltify_trees_differ($uheadref, $oldtiptree,1),
6366         O2A => quiltify_trees_differ($unapplied,$oldtiptree,1),
6367     };
6368
6369     my @dl;
6370     foreach my $bits (qw(01 02)) {
6371         foreach my $v (qw(O2H O2A H2A)) {
6372             push @dl, ($diffbits->{$v} & $bits) ? '##' : '==';
6373         }
6374     }
6375     printdebug "differences \@dl @dl.\n";
6376
6377     progress f_
6378 "%s: base trees orig=%.20s o+d/p=%.20s",
6379               $us, $unapplied, $oldtiptree;
6380     # TRANSLATORS: Try to keep this ascii-art layout right.  The 0s in
6381     # %9.00009s will be ignored and are there to make the format the
6382     # same length (9 characters) as the output it generates.  If you
6383     # change the value 9, your translations of "upstream" and
6384     # 'tarball' must fit into the new length, and you should change
6385     # the number of 0s.  Do not reduce it below 4 as HEAD has to fit
6386     # too.
6387     progress f_
6388 "%s: quilt differences: src:  %s orig %s     gitignores:  %s orig %s\n".
6389 "%s: quilt differences: %9.00009s %s o+d/p          %9.00009s %s o+d/p",
6390   $us,                      $dl[0], $dl[1],              $dl[3], $dl[4],
6391   $us,        $uhead_whatshort, $dl[2],   $uhead_whatshort, $dl[5];
6392
6393     if (@unrepres && $quilt_mode !~ m/baredebian/) {
6394         # With baredebian, even if the upstream commitish has this
6395         # problem, we don't want to print this message, as nothing
6396         # is going to try to make a patch out of it anyway.
6397         print STDERR f_ "dgit:  cannot represent change: %s: %s\n",
6398                         $_->[1], $_->[0]
6399             foreach @unrepres;
6400         forceable_fail [qw(unrepresentable)], __ <<END;
6401 HEAD has changes to .orig[s] which are not representable by `3.0 (quilt)'
6402 END
6403     }
6404
6405     my @failsuggestion;
6406     if ($onlydebian) {
6407         push @failsuggestion, [ 'onlydebian', __
6408  "This has only a debian/ directory; you probably want --quilt=bare debian." ]
6409             unless $quilt_mode =~ m/baredebian/;
6410     } elsif (!($diffbits->{O2H} & $diffbits->{O2A})) {
6411         push @failsuggestion, [ 'unapplied', __
6412  "This might be a patches-unapplied branch." ];
6413     } elsif (!($diffbits->{H2A} & $diffbits->{O2A})) {
6414         push @failsuggestion, [ 'applied', __
6415  "This might be a patches-applied branch." ];
6416     }
6417     push @failsuggestion, [ 'quilt-mode', __
6418  "Maybe you need one of --[quilt=]gbp --[quilt=]dpm --quilt=unapplied ?" ];
6419
6420     push @failsuggestion, [ 'gitattrs', __
6421  "Warning: Tree has .gitattributes.  See GITATTRIBUTES in dgit(7)." ]
6422         if stat_exists '.gitattributes';
6423
6424     push @failsuggestion, [ 'origs', __
6425  "Maybe orig tarball(s) are not identical to git representation?" ]
6426         unless $onlydebian && $quilt_mode !~ m/baredebian/;
6427                # ^ in that case, we didn't really look properly
6428
6429     if (quiltmode_splitting()) {
6430         quiltify_splitting($clogp, $unapplied, $headref, $oldtiptree,
6431                            $diffbits, \%editedignores,
6432                            $splitbrain_cachekey);
6433         return;
6434     }
6435
6436     progress f_ "starting quiltify (multiple patches, %s mode)", $quilt_mode;
6437     quiltify($clogp,$headref,$oldtiptree,\@failsuggestion);
6438     runcmd @git, qw(checkout -q), (qw(master dgit-view)[do_split_brain()]);
6439
6440     if (!open P, '>>', ".pc/applied-patches") {
6441         $!==&ENOENT or confess "$!";
6442     } else {
6443         close P;
6444     }
6445
6446     commit_quilty_patch();
6447
6448     if ($mustdeletepc) {
6449         quilt_fixup_delete_pc();
6450     }
6451 }
6452
6453 sub quilt_fixup_editor () {
6454     my $descfn = $ENV{$fakeeditorenv};
6455     my $editing = $ARGV[$#ARGV];
6456     open I1, '<', $descfn or confess "$descfn: $!";
6457     open I2, '<', $editing or confess "$editing: $!";
6458     unlink $editing or confess "$editing: $!";
6459     open O, '>', $editing or confess "$editing: $!";
6460     while (<I1>) { print O or confess "$!"; } I1->error and confess "$!";
6461     my $copying = 0;
6462     while (<I2>) {
6463         $copying ||= m/^\-\-\- /;
6464         next unless $copying;
6465         print O or confess "$!";
6466     }
6467     I2->error and confess "$!";
6468     close O or die $1;
6469     finish 0;
6470 }
6471
6472 sub maybe_apply_patches_dirtily () {
6473     return unless $quilt_mode =~ m/gbp|unapplied|baredebian/;
6474     print STDERR __ <<END or confess "$!";
6475
6476 dgit: Building, or cleaning with rules target, in patches-unapplied tree.
6477 dgit: Have to apply the patches - making the tree dirty.
6478 dgit: (Consider specifying --clean=git and (or) using dgit sbuild.)
6479
6480 END
6481     $patches_applied_dirtily = 01;
6482     $patches_applied_dirtily |= 02 unless stat_exists '.pc';
6483     runcmd qw(dpkg-source --before-build .);
6484 }
6485
6486 sub maybe_unapply_patches_again () {
6487     progress __ "dgit: Unapplying patches again to tidy up the tree."
6488         if $patches_applied_dirtily;
6489     runcmd qw(dpkg-source --after-build .)
6490         if $patches_applied_dirtily & 01;
6491     rmtree '.pc'
6492         if $patches_applied_dirtily & 02;
6493     $patches_applied_dirtily = 0;
6494 }
6495
6496 #----- other building -----
6497
6498 sub clean_tree_check_git ($$$) {
6499     my ($honour_ignores, $message, $ignmessage) = @_;
6500     my @cmd = (@git, qw(clean -dn));
6501     push @cmd, qw(-x) unless $honour_ignores;
6502     my $leftovers = cmdoutput @cmd;
6503     if (length $leftovers) {
6504         print STDERR $leftovers, "\n" or confess "$!";
6505         $message .= $ignmessage if $honour_ignores;
6506         fail $message;
6507     }
6508 }
6509
6510 sub clean_tree_check_git_wd ($) {
6511     my ($message) = @_;
6512     return if $cleanmode =~ m{no-check};
6513     return if $patches_applied_dirtily; # yuk
6514     clean_tree_check_git +($cleanmode !~ m{all-check}),
6515         $message, "\n".__ <<END;
6516 If this is just missing .gitignore entries, use a different clean
6517 mode, eg --clean=dpkg-source,no-check (-wdn/-wddn) to ignore them
6518 or --clean=git (-wg/-wgf) to use \`git clean' instead.
6519 END
6520 }
6521
6522 sub clean_tree_check () {
6523     # This function needs to not care about modified but tracked files.
6524     # That was done by check_not_dirty, and by now we may have run
6525     # the rules clean target which might modify tracked files (!)
6526     if ($cleanmode =~ m{^check}) {
6527         clean_tree_check_git +($cleanmode =~ m{ignores}), __
6528  "tree contains uncommitted files and --clean=check specified", '';
6529     } elsif ($cleanmode =~ m{^dpkg-source}) {
6530         clean_tree_check_git_wd __
6531  "tree contains uncommitted files (NB dgit didn't run rules clean)";
6532     } elsif ($cleanmode =~ m{^git}) {
6533         clean_tree_check_git 1, __
6534  "tree contains uncommited, untracked, unignored files\n".
6535  "You can use --clean=git[-ff],always (-wga/-wgfa) to delete them.", '';
6536     } elsif ($cleanmode eq 'none') {
6537     } else {
6538         confess "$cleanmode ?";
6539     }
6540 }
6541
6542 sub clean_tree () {
6543     # We always clean the tree ourselves, rather than leave it to the
6544     # builder (dpkg-source, or soemthing which calls dpkg-source).
6545     if ($quilt_mode =~ m/baredebian/ and $cleanmode =~ m/git/) {
6546         fail f_ <<END, $quilt_mode, $cleanmode;
6547 quilt mode %s (generally needs untracked upstream files)
6548 contradicts clean mode %s (which would delete them)
6549 END
6550         # This is not 100% true: dgit build-source and push-source
6551         # (for example) could operate just fine with no upstream
6552         # source in the working tree.  But it doesn't seem likely that
6553         # the user wants dgit to proactively delete such things.
6554         # -wn, for example, would produce identical output without
6555         # deleting anything from the working tree.
6556     }
6557     if ($cleanmode =~ m{^dpkg-source}) {
6558         my @cmd = @dpkgbuildpackage;
6559         push @cmd, qw(-d) if $cleanmode =~ m{^dpkg-source-d};
6560         push @cmd, qw(-T clean);
6561         maybe_apply_patches_dirtily();
6562         runcmd_ordryrun_local @cmd;
6563         clean_tree_check_git_wd __
6564  "tree contains uncommitted files (after running rules clean)";
6565     } elsif ($cleanmode =~ m{^git(?!-)}) {
6566         runcmd_ordryrun_local @git, qw(clean -xdf);
6567     } elsif ($cleanmode =~ m{^git-ff}) {
6568         runcmd_ordryrun_local @git, qw(clean -xdff);
6569     } elsif ($cleanmode =~ m{^check}) {
6570         clean_tree_check();
6571     } elsif ($cleanmode eq 'none') {
6572     } else {
6573         confess "$cleanmode ?";
6574     }
6575 }
6576
6577 sub cmd_clean () {
6578     badusage __ "clean takes no additional arguments" if @ARGV;
6579     notpushing();
6580     clean_tree();
6581     maybe_unapply_patches_again();
6582 }
6583
6584 # return values from massage_dbp_args are one or both of these flags
6585 sub WANTSRC_SOURCE  () { 01; } # caller should build source (separately)
6586 sub WANTSRC_BUILDER () { 02; } # caller should run dpkg-buildpackage
6587
6588 sub build_or_push_prep_early () {
6589     our $build_or_push_prep_early_done //= 0;
6590     return if $build_or_push_prep_early_done++;
6591     my $clogp = parsechangelog();
6592     $isuite = getfield $clogp, 'Distribution';
6593     my $gotpackage = getfield $clogp, 'Source';
6594     $version = getfield $clogp, 'Version';
6595     $package //= $gotpackage;
6596     if ($package ne $gotpackage) {
6597         fail f_ "-p specified package %s, but changelog says %s",
6598             $package, $gotpackage;
6599     }
6600     $dscfn = dscfn($version);
6601 }
6602
6603 sub build_or_push_prep_modes () {
6604     my ($format) = get_source_format();
6605     determine_whether_split_brain($format);
6606
6607     fail __ "dgit: --include-dirty is not supported with split view".
6608             " (including with view-splitting quilt modes)"
6609         if do_split_brain() && $includedirty;
6610
6611     if (madformat_wantfixup $format and $quilt_mode =~ m/baredebian$/) {
6612         ($quilt_upstream_commitish, $quilt_upstream_commitish_used,
6613          $quilt_upstream_commitish_message)
6614             = resolve_upstream_version
6615             $quilt_upstream_commitish, upstreamversion $version;
6616         progress f_ "dgit: --quilt=%s, %s", $quilt_mode,
6617             $quilt_upstream_commitish_message;
6618     } elsif (defined $quilt_upstream_commitish) {
6619         fail __
6620  "dgit: --upstream-commitish only makes sense with --quilt=baredebian"
6621     }
6622 }
6623
6624 sub build_prep_early () {
6625     build_or_push_prep_early();
6626     notpushing();
6627     build_or_push_prep_modes();
6628     check_not_dirty();
6629 }
6630
6631 sub build_prep ($) {
6632     my ($wantsrc) = @_;
6633     build_prep_early();
6634     check_bpd_exists();
6635     if (!building_source_in_playtree() || ($wantsrc & WANTSRC_BUILDER)
6636         # Clean the tree because we're going to use the contents of
6637         # $maindir.  (We trying to include dirty changes in the source
6638         # package, or we are running the builder in $maindir.)
6639         || $cleanmode =~ m{always}) {
6640         # Or because the user asked us to.
6641         clean_tree();
6642     } else {
6643         # We don't actually need to do anything in $maindir, but we
6644         # should do some kind of cleanliness check because (i) the
6645         # user may have forgotten a `git add', and (ii) if the user
6646         # said -wc we should still do the check.
6647         clean_tree_check();
6648     }
6649     build_check_quilt_splitbrain();
6650     if ($rmchanges) {
6651         my $pat = changespat $version;
6652         foreach my $f (glob "$buildproductsdir/$pat") {
6653             if (act_local()) {
6654                 unlink $f or
6655                     fail f_ "remove old changes file %s: %s", $f, $!;
6656             } else {
6657                 progress f_ "would remove %s", $f;
6658             }
6659         }
6660     }
6661 }
6662
6663 sub changesopts_initial () {
6664     my @opts =@changesopts[1..$#changesopts];
6665 }
6666
6667 sub changesopts_version () {
6668     if (!defined $changes_since_version) {
6669         my @vsns;
6670         unless (eval {
6671             @vsns = archive_query('archive_query');
6672             my @quirk = access_quirk();
6673             if ($quirk[0] eq 'backports') {
6674                 local $isuite = $quirk[2];
6675                 local $csuite;
6676                 canonicalise_suite();
6677                 push @vsns, archive_query('archive_query');
6678             }
6679             1;
6680         }) {
6681             print STDERR $@;
6682             fail __
6683  "archive query failed (queried because --since-version not specified)";
6684         }
6685         if (@vsns) {
6686             @vsns = map { $_->[0] } @vsns;
6687             @vsns = sort { -version_compare($a, $b) } @vsns;
6688             $changes_since_version = $vsns[0];
6689             progress f_ "changelog will contain changes since %s", $vsns[0];
6690         } else {
6691             $changes_since_version = '_';
6692             progress __ "package seems new, not specifying -v<version>";
6693         }
6694     }
6695     if ($changes_since_version ne '_') {
6696         return ("-v$changes_since_version");
6697     } else {
6698         return ();
6699     }
6700 }
6701
6702 sub changesopts () {
6703     return (changesopts_initial(), changesopts_version());
6704 }
6705
6706 sub massage_dbp_args ($;$) {
6707     my ($cmd,$xargs) = @_;
6708     # Since we split the source build out so we can do strange things
6709     # to it, massage the arguments to dpkg-buildpackage so that the
6710     # main build doessn't build source (or add an argument to stop it
6711     # building source by default).
6712     debugcmd '#massaging#', @$cmd if $debuglevel>1;
6713     # -nc has the side effect of specifying -b if nothing else specified
6714     # and some combinations of -S, -b, et al, are errors, rather than
6715     # later simply overriding earlie.  So we need to:
6716     #  - search the command line for these options
6717     #  - pick the last one
6718     #  - perhaps add our own as a default
6719     #  - perhaps adjust it to the corresponding non-source-building version
6720     my $dmode = '-F';
6721     foreach my $l ($cmd, $xargs) {
6722         next unless $l;
6723         @$l = grep { !(m/^-[SgGFABb]$|^--build=/s and $dmode=$_) } @$l;
6724     }
6725     push @$cmd, '-nc';
6726 #print STDERR "MASS1 ",Dumper($cmd, $xargs, $dmode);
6727     my $r = WANTSRC_BUILDER;
6728     printdebug "massage split $dmode.\n";
6729     if ($dmode =~ s/^--build=//) {
6730         $r = 0;
6731         my @d = split /,/, $dmode;
6732         $r |= WANTSRC_SOURCE  if grep { s/^full$/binary/ } @d;
6733         $r |= WANTSRC_SOURCE  if grep { s/^source$// } @d;
6734         $r |= WANTSRC_BUILDER if grep { m/./ } @d;
6735         fail __ "Wanted to build nothing!" unless $r;
6736         $dmode = '--build='. join ',', grep m/./, @d;
6737     } else {
6738         $r =
6739           $dmode =~ m/[S]/     ?  WANTSRC_SOURCE :
6740           $dmode =~ y/gGF/ABb/ ?  WANTSRC_SOURCE | WANTSRC_BUILDER :
6741           $dmode =~ m/[ABb]/   ?                   WANTSRC_BUILDER :
6742           confess "$dmode ?";
6743     }
6744     printdebug "massage done $r $dmode.\n";
6745     push @$cmd, $dmode;
6746 #print STDERR "MASS2 ",Dumper($cmd, $xargs, $r);
6747     return $r;
6748 }
6749
6750 sub in_bpd (&) {
6751     my ($fn) = @_;
6752     my $wasdir = must_getcwd();
6753     changedir $buildproductsdir;
6754     $fn->();
6755     changedir $wasdir;
6756 }    
6757
6758 # this sub must run with CWD=$buildproductsdir (eg in in_bpd)
6759 sub postbuild_mergechanges ($) {
6760     my ($msg_if_onlyone) = @_;
6761     # If there is only one .changes file, fail with $msg_if_onlyone,
6762     # or if that is undef, be a no-op.
6763     # Returns the changes file to report to the user.
6764     my $pat = changespat $version;
6765     my @changesfiles = grep { !m/_multi\.changes/ } glob $pat;
6766     @changesfiles = sort {
6767         ($b =~ m/_source\.changes$/ <=> $a =~ m/_source\.changes$/)
6768             or $a cmp $b
6769     } @changesfiles;
6770     my $result;
6771     if (@changesfiles==1) {
6772         fail +(f_ <<END, "@changesfiles").$msg_if_onlyone
6773 only one changes file from build (%s)
6774 END
6775             if defined $msg_if_onlyone;
6776         $result = $changesfiles[0];
6777     } elsif (@changesfiles==2) {
6778         my $binchanges = parsecontrol($changesfiles[1], "binary changes file");
6779         foreach my $l (split /\n/, getfield $binchanges, 'Files') {
6780             fail f_ "%s found in binaries changes file %s", $l, $binchanges
6781                 if $l =~ m/\.dsc$/;
6782         }
6783         runcmd_ordryrun_local @mergechanges, @changesfiles;
6784         my $multichanges = changespat $version,'multi';
6785         if (act_local()) {
6786             stat_exists $multichanges or fail f_
6787                 "%s unexpectedly not created by build", $multichanges;
6788             foreach my $cf (glob $pat) {
6789                 next if $cf eq $multichanges;
6790                 rename "$cf", "$cf.inmulti" or fail f_
6791                     "install new changes %s\{,.inmulti}: %s", $cf, $!;
6792             }
6793         }
6794         $result = $multichanges;
6795     } else {
6796         fail f_ "wrong number of different changes files (%s)",
6797                 "@changesfiles";
6798     }
6799     printdone f_ "build successful, results in %s\n", $result
6800         or confess "$!";
6801 }
6802
6803 sub midbuild_checkchanges () {
6804     my $pat = changespat $version;
6805     return if $rmchanges;
6806     my @unwanted = map { s#.*/##; $_; } glob "$bpd_glob/$pat";
6807     @unwanted = grep {
6808         $_ ne changespat $version,'source' and
6809         $_ ne changespat $version,'multi'
6810     } @unwanted;
6811     fail +(f_ <<END, $pat, "@unwanted")
6812 changes files other than source matching %s already present; building would result in ambiguity about the intended results.
6813 Suggest you delete %s.
6814 END
6815         if @unwanted;
6816 }
6817
6818 sub midbuild_checkchanges_vanilla ($) {
6819     my ($wantsrc) = @_;
6820     midbuild_checkchanges() if $wantsrc == (WANTSRC_SOURCE|WANTSRC_BUILDER);
6821 }
6822
6823 sub postbuild_mergechanges_vanilla ($) {
6824     my ($wantsrc) = @_;
6825     if ($wantsrc == (WANTSRC_SOURCE|WANTSRC_BUILDER)) {
6826         in_bpd {
6827             postbuild_mergechanges(undef);
6828         };
6829     } else {
6830         printdone __ "build successful\n";
6831     }
6832 }
6833
6834 sub cmd_build {
6835     build_prep_early();
6836     $buildproductsdir eq '..' or print STDERR +(f_ <<END, $us, $us);
6837 %s: warning: build-products-dir set, but not supported by dpkg-buildpackage
6838 %s: warning: build-products-dir will be ignored; files will go to ..
6839 END
6840     $buildproductsdir = '..';
6841     my @dbp = (@dpkgbuildpackage, qw(-us -uc), changesopts_initial(), @ARGV);
6842     my $wantsrc = massage_dbp_args \@dbp;
6843     build_prep($wantsrc);
6844     if ($wantsrc & WANTSRC_SOURCE) {
6845         build_source();
6846         midbuild_checkchanges_vanilla $wantsrc;
6847     }
6848     if ($wantsrc & WANTSRC_BUILDER) {
6849         push @dbp, changesopts_version();
6850         maybe_apply_patches_dirtily();
6851         runcmd_ordryrun_local @dbp;
6852     }
6853     maybe_unapply_patches_again();
6854     postbuild_mergechanges_vanilla $wantsrc;
6855 }
6856
6857 sub pre_gbp_build {
6858     $quilt_mode //= 'gbp';
6859 }
6860
6861 sub cmd_gbp_build {
6862     build_prep_early();
6863
6864     # gbp can make .origs out of thin air.  In my tests it does this
6865     # even for a 1.0 format package, with no origs present.  So I
6866     # guess it keys off just the version number.  We don't know
6867     # exactly what .origs ought to exist, but let's assume that we
6868     # should run gbp if: the version has an upstream part and the main
6869     # orig is absent.
6870     my $upstreamversion = upstreamversion $version;
6871     my $origfnpat = srcfn $upstreamversion, '.orig.tar.*';
6872     my $gbp_make_orig = $version =~ m/-/ && !(() = glob "$bpd_glob/$origfnpat");
6873
6874     if ($gbp_make_orig) {
6875         clean_tree();
6876         $cleanmode = 'none'; # don't do it again
6877     }
6878
6879     my @dbp = @dpkgbuildpackage;
6880
6881     my $wantsrc = massage_dbp_args \@dbp, \@ARGV;
6882
6883     if (!length $gbp_build[0]) {
6884         if (length executable_on_path('git-buildpackage')) {
6885             $gbp_build[0] = qw(git-buildpackage);
6886         } else {
6887             $gbp_build[0] = 'gbp buildpackage';
6888         }
6889     }
6890     my @cmd = opts_opt_multi_cmd [], @gbp_build;
6891
6892     push @cmd, (qw(-us -uc --git-no-sign-tags),
6893                 "--git-builder=".(shellquote @dbp));
6894
6895     if ($gbp_make_orig) {
6896         my $priv = dgit_privdir();
6897         my $ok = "$priv/origs-gen-ok";
6898         unlink $ok or $!==&ENOENT or confess "$!";
6899         my @origs_cmd = @cmd;
6900         push @origs_cmd, qw(--git-cleaner=true);
6901         push @origs_cmd, "--git-prebuild=".
6902             "touch ".(shellquote $ok)." ".(shellquote "$priv/no-such-dir/ok");
6903         push @origs_cmd, @ARGV;
6904         if (act_local()) {
6905             debugcmd @origs_cmd;
6906             system @origs_cmd;
6907             do { local $!; stat_exists $ok; }
6908                 or failedcmd @origs_cmd;
6909         } else {
6910             dryrun_report @origs_cmd;
6911         }
6912     }
6913
6914     build_prep($wantsrc);
6915     if ($wantsrc & WANTSRC_SOURCE) {
6916         build_source();
6917         midbuild_checkchanges_vanilla $wantsrc;
6918     } else {
6919         push @cmd, '--git-cleaner=true';
6920     }
6921     maybe_unapply_patches_again();
6922     if ($wantsrc & WANTSRC_BUILDER) {
6923         push @cmd, changesopts();
6924         runcmd_ordryrun_local @cmd, @ARGV;
6925     }
6926     postbuild_mergechanges_vanilla $wantsrc;
6927 }
6928 sub cmd_git_build { cmd_gbp_build(); } # compatibility with <= 1.0
6929
6930 sub building_source_in_playtree {
6931     # If $includedirty, we have to build the source package from the
6932     # working tree, not a playtree, so that uncommitted changes are
6933     # included (copying or hardlinking them into the playtree could
6934     # cause trouble).
6935     #
6936     # Note that if we are building a source package in split brain
6937     # mode we do not support including uncommitted changes, because
6938     # that makes quilt fixup too hard.  I.e. ($made_split_brain && (dgit is
6939     # building a source package)) => !$includedirty
6940     return !$includedirty;
6941 }
6942
6943 sub build_source {
6944     $sourcechanges = changespat $version,'source';
6945     if (act_local()) {
6946         unlink "$buildproductsdir/$sourcechanges" or $!==ENOENT
6947             or fail f_ "remove %s: %s", $sourcechanges, $!;
6948     }
6949 #    confess unless !!$made_split_brain == do_split_brain();
6950
6951     my @cmd = (@dpkgsource, qw(-b --));
6952     my $leafdir;
6953     if (building_source_in_playtree()) {
6954         $leafdir = 'work';
6955         my $headref = git_rev_parse('HEAD');
6956         # If we are in split brain, there is already a playtree with
6957         # the thing we should package into a .dsc (thanks to quilt
6958         # fixup).  If not, make a playtree
6959         prep_ud() unless $made_split_brain;
6960         changedir $playground;
6961         unless ($made_split_brain) {
6962             my $upstreamversion = upstreamversion $version;
6963             unpack_playtree_linkorigs($upstreamversion, sub { });
6964             unpack_playtree_need_cd_work($headref);
6965             changedir '..';
6966         }
6967     } else {
6968         $leafdir = basename $maindir;
6969
6970         if ($buildproductsdir ne '..') {
6971             # Well, we are going to run dpkg-source -b which consumes
6972             # origs from .. and generates output there.  To make this
6973             # work when the bpd is not .. , we would have to (i) link
6974             # origs from bpd to .. , (ii) check for files that
6975             # dpkg-source -b would/might overwrite, and afterwards
6976             # (iii) move all the outputs back to the bpd (iv) except
6977             # for the origs which should be deleted from .. if they
6978             # weren't there beforehand.  And if there is an error and
6979             # we don't run to completion we would necessarily leave a
6980             # mess.  This is too much.  The real way to fix this
6981             # is for dpkg-source to have bpd support.
6982             confess unless $includedirty;
6983             fail __
6984  "--include-dirty not supported with --build-products-dir, sorry";
6985         }
6986
6987         changedir '..';
6988     }
6989     runcmd_ordryrun_local @cmd, $leafdir;
6990
6991     changedir $leafdir;
6992     runcmd_ordryrun_local qw(sh -ec),
6993       'exec >../$1; shift; exec "$@"','x', $sourcechanges,
6994       @dpkggenchanges, qw(-S), changesopts();
6995     changedir '..';
6996
6997     printdebug "moving $dscfn, $sourcechanges, etc. to ".bpd_abs()."\n";
6998     $dsc = parsecontrol($dscfn, "source package");
6999
7000     my $mv = sub {
7001         my ($why, $l) = @_;
7002         printdebug " renaming ($why) $l\n";
7003         rename_link_xf 0, "$l", bpd_abs()."/$l"
7004             or fail f_ "put in place new built file (%s): %s", $l, $@;
7005     };
7006     foreach my $l (split /\n/, getfield $dsc, 'Files') {
7007         $l =~ m/\S+$/ or next;
7008         $mv->('Files', $&);
7009     }
7010     $mv->('dsc', $dscfn);
7011     $mv->('changes', $sourcechanges);
7012
7013     changedir $maindir;
7014 }
7015
7016 sub cmd_build_source {
7017     badusage __ "build-source takes no additional arguments" if @ARGV;
7018     build_prep(WANTSRC_SOURCE);
7019     build_source();
7020     maybe_unapply_patches_again();
7021     printdone f_ "source built, results in %s and %s",
7022                  $dscfn, $sourcechanges;
7023 }
7024
7025 sub cmd_push_source {
7026     prep_push();
7027     fail __
7028         "dgit push-source: --include-dirty/--ignore-dirty does not make".
7029         "sense with push-source!"
7030         if $includedirty;
7031     build_check_quilt_splitbrain();
7032     if ($changesfile) {
7033         my $changes = parsecontrol("$buildproductsdir/$changesfile",
7034                                    __ "source changes file");
7035         unless (test_source_only_changes($changes)) {
7036             fail __ "user-specified changes file is not source-only";
7037         }
7038     } else {
7039         # Building a source package is very fast, so just do it
7040         build_source();
7041         confess "er, patches are applied dirtily but shouldn't be.."
7042             if $patches_applied_dirtily;
7043         $changesfile = $sourcechanges;
7044     }
7045     dopush();
7046 }
7047
7048 sub binary_builder {
7049     my ($bbuilder, $pbmc_msg, @args) = @_;
7050     build_prep(WANTSRC_SOURCE);
7051     build_source();
7052     midbuild_checkchanges();
7053     in_bpd {
7054         if (act_local()) {
7055             stat_exists $dscfn or fail f_
7056                 "%s (in build products dir): %s", $dscfn, $!;
7057             stat_exists $sourcechanges or fail f_
7058                 "%s (in build products dir): %s", $sourcechanges, $!;
7059         }
7060         runcmd_ordryrun_local @$bbuilder, @args;
7061     };
7062     maybe_unapply_patches_again();
7063     in_bpd {
7064         postbuild_mergechanges($pbmc_msg);
7065     };
7066 }
7067
7068 sub cmd_sbuild {
7069     build_prep_early();
7070     binary_builder(\@sbuild, (__ <<END), qw(-d), $isuite, @ARGV, $dscfn);
7071 perhaps you need to pass -A ?  (sbuild's default is to build only
7072 arch-specific binaries; dgit 1.4 used to override that.)
7073 END
7074 }
7075
7076 sub pbuilder ($) {
7077     my ($pbuilder) = @_;
7078     build_prep_early();
7079     # @ARGV is allowed to contain only things that should be passed to
7080     # pbuilder under debbuildopts; just massage those
7081     my $wantsrc = massage_dbp_args \@ARGV;
7082     fail __
7083         "you asked for a builder but your debbuildopts didn't ask for".
7084         " any binaries -- is this really what you meant?"
7085         unless $wantsrc & WANTSRC_BUILDER;
7086     fail __
7087         "we must build a .dsc to pass to the builder but your debbuiltopts".
7088         " forbids the building of a source package; cannot continue"
7089       unless $wantsrc & WANTSRC_SOURCE;
7090     # We do not want to include the verb "build" in @pbuilder because
7091     # the user can customise @pbuilder and they shouldn't be required
7092     # to include "build" in their customised value.  However, if the
7093     # user passes any additional args to pbuilder using the dgit
7094     # option --pbuilder:foo, such args need to come after the "build"
7095     # verb.  opts_opt_multi_cmd does all of that.
7096     binary_builder([opts_opt_multi_cmd ["build"], @$pbuilder], undef,
7097                    qw(--debbuildopts), "@ARGV", qw(--distribution), $isuite,
7098                    $dscfn);
7099 }
7100
7101 sub cmd_pbuilder {
7102     pbuilder(\@pbuilder);
7103 }
7104
7105 sub cmd_cowbuilder {
7106     pbuilder(\@cowbuilder);
7107 }
7108
7109 sub cmd_quilt_fixup {
7110     badusage "incorrect arguments to dgit quilt-fixup" if @ARGV;
7111     build_prep_early();
7112     clean_tree();
7113     build_maybe_quilt_fixup();
7114 }
7115
7116 sub cmd_print_unapplied_treeish {
7117     badusage __ "incorrect arguments to dgit print-unapplied-treeish"
7118         if @ARGV;
7119     my $headref = git_rev_parse('HEAD');
7120     my $clogp = commit_getclogp $headref;
7121     $package = getfield $clogp, 'Source';
7122     $version = getfield $clogp, 'Version';
7123     $isuite = getfield $clogp, 'Distribution';
7124     $csuite = $isuite; # we want this to be offline!
7125     notpushing();
7126
7127     prep_ud();
7128     changedir $playground;
7129     my $uv = upstreamversion $version;
7130     my $u = quilt_fakedsc2unapplied($headref, $uv);
7131     print $u, "\n" or confess "$!";
7132 }
7133
7134 sub import_dsc_result {
7135     my ($dstref, $newhash, $what_log, $what_msg) = @_;
7136     my @cmd = (git_update_ref_cmd $what_log, $dstref, $newhash);
7137     runcmd @cmd;
7138     check_gitattrs($newhash, __ "source tree");
7139
7140     progress f_ "dgit: import-dsc: %s", $what_msg;
7141 }
7142
7143 sub cmd_import_dsc {
7144     my $needsig = 0;
7145
7146     while (@ARGV) {
7147         last unless $ARGV[0] =~ m/^-/;
7148         $_ = shift @ARGV;
7149         last if m/^--?$/;
7150         if (m/^--require-valid-signature$/) {
7151             $needsig = 1;
7152         } else {
7153             badusage f_ "unknown dgit import-dsc sub-option \`%s'", $_;
7154         }
7155     }
7156
7157     badusage __ "usage: dgit import-dsc .../PATH/TO/.DSC BRANCH"
7158         unless @ARGV==2;
7159     my ($dscfn, $dstbranch) = @ARGV;
7160
7161     badusage __ "dry run makes no sense with import-dsc"
7162         unless act_local();
7163
7164     my $force = $dstbranch =~ s/^\+//   ? +1 :
7165                 $dstbranch =~ s/^\.\.// ? -1 :
7166                                            0;
7167     my $info = $force ? " $&" : '';
7168     $info = "$dscfn$info";
7169
7170     my $specbranch = $dstbranch;
7171     $dstbranch = "refs/heads/$dstbranch" unless $dstbranch =~ m#^refs/#;
7172     $dstbranch = cmdoutput @git, qw(check-ref-format --normalize), $dstbranch;
7173
7174     my @symcmd = (@git, qw(symbolic-ref -q HEAD));
7175     my $chead = cmdoutput_errok @symcmd;
7176     defined $chead or $?==256 or failedcmd @symcmd;
7177
7178     fail f_ "%s is checked out - will not update it", $dstbranch
7179         if defined $chead and $chead eq $dstbranch;
7180
7181     my $oldhash = git_get_ref $dstbranch;
7182
7183     open D, "<", $dscfn or fail f_ "open import .dsc (%s): %s", $dscfn, $!;
7184     $dscdata = do { local $/ = undef; <D>; };
7185     D->error and fail f_ "read %s: %s", $dscfn, $!;
7186     close C;
7187
7188     # we don't normally need this so import it here
7189     use Dpkg::Source::Package;
7190     my $dp = new Dpkg::Source::Package filename => $dscfn,
7191         require_valid_signature => $needsig;
7192     {
7193         local $SIG{__WARN__} = sub {
7194             print STDERR $_[0];
7195             return unless $needsig;
7196             fail __ "import-dsc signature check failed";
7197         };
7198         if (!$dp->is_signed()) {
7199             warn f_ "%s: warning: importing unsigned .dsc\n", $us;
7200         } else {
7201             my $r = $dp->check_signature();
7202             confess "->check_signature => $r" if $needsig && $r;
7203         }
7204     }
7205
7206     parse_dscdata();
7207
7208     $package = getfield $dsc, 'Source';
7209
7210     parse_dsc_field($dsc, __ "Dgit metadata in .dsc")
7211         unless forceing [qw(import-dsc-with-dgit-field)];
7212     parse_dsc_field_def_dsc_distro();
7213
7214     $isuite = 'DGIT-IMPORT-DSC';
7215     $idistro //= $dsc_distro;
7216
7217     notpushing();
7218
7219     if (defined $dsc_hash) {
7220         progress __
7221             "dgit: import-dsc of .dsc with Dgit field, using git hash";
7222         resolve_dsc_field_commit undef, undef;
7223     }
7224     if (defined $dsc_hash) {
7225         my @cmd = (qw(sh -ec),
7226                    "echo $dsc_hash | git cat-file --batch-check");
7227         my $objgot = cmdoutput @cmd;
7228         if ($objgot =~ m#^\w+ missing\b#) {
7229             fail f_ <<END, $dsc_hash
7230 .dsc contains Dgit field referring to object %s
7231 Your git tree does not have that object.  Try `git fetch' from a
7232 plausible server (browse.dgit.d.o? salsa?), and try the import-dsc again.
7233 END
7234         }
7235         if ($oldhash && !is_fast_fwd $oldhash, $dsc_hash) {
7236             if ($force > 0) {
7237                 progress __ "Not fast forward, forced update.";
7238             } else {
7239                 fail f_ "Not fast forward to %s", $dsc_hash;
7240             }
7241         }
7242         import_dsc_result $dstbranch, $dsc_hash,
7243             "dgit import-dsc (Dgit): $info",
7244             f_ "updated git ref %s", $dstbranch;
7245         return 0;
7246     }
7247
7248     fail f_ <<END, $dstbranch, $specbranch, $specbranch
7249 Branch %s already exists
7250 Specify ..%s for a pseudo-merge, binding in existing history
7251 Specify  +%s to overwrite, discarding existing history
7252 END
7253         if $oldhash && !$force;
7254
7255     my @dfi = dsc_files_info();
7256     foreach my $fi (@dfi) {
7257         my $f = $fi->{Filename};
7258         # We transfer all the pieces of the dsc to the bpd, not just
7259         # origs.  This is by analogy with dgit fetch, which wants to
7260         # keep them somewhere to avoid downloading them again.
7261         # We make symlinks, though.  If the user wants copies, then
7262         # they can copy the parts of the dsc to the bpd using dcmd,
7263         # or something.
7264         my $here = "$buildproductsdir/$f";
7265         if (lstat $here) {
7266             if (stat $here) {
7267                 next;
7268             }
7269             fail f_ "lstat %s works but stat gives %s !", $here, $!;
7270         }
7271         fail f_ "stat %s: %s", $here, $! unless $! == ENOENT;
7272         printdebug "not in bpd, $f ...\n";
7273         # $f does not exist in bpd, we need to transfer it
7274         my $there = $dscfn;
7275         $there =~ s{[^/]+$}{$f} or confess "$there ?";
7276         # $there is file we want, relative to user's cwd, or abs
7277         printdebug "not in bpd, $f, test $there ...\n";
7278         stat $there or fail f_
7279             "import %s requires %s, but: %s", $dscfn, $there, $!;
7280         if ($there =~ m#^(?:\./+)?\.\./+#) {
7281             # $there is relative to user's cwd
7282             my $there_from_parent = $';
7283             if ($buildproductsdir !~ m{^/}) {
7284                 # abs2rel, despite its name, can take two relative paths
7285                 $there = File::Spec->abs2rel($there,$buildproductsdir);
7286                 # now $there is relative to bpd, great
7287                 printdebug "not in bpd, $f, abs2rel, $there ...\n";
7288             } else {
7289                 $there = (dirname $maindir)."/$there_from_parent";
7290                 # now $there is absoute
7291                 printdebug "not in bpd, $f, rel2rel, $there ...\n";
7292             }
7293         } elsif ($there =~ m#^/#) {
7294             # $there is absolute already
7295             printdebug "not in bpd, $f, abs, $there ...\n";
7296         } else {
7297             fail f_
7298                 "cannot import %s which seems to be inside working tree!",
7299                 $dscfn;
7300         }
7301         symlink $there, $here or fail f_
7302             "symlink %s to %s: %s", $there, $here, $!;
7303         progress f_ "made symlink %s -> %s", $here, $there;
7304 #       print STDERR Dumper($fi);
7305     }
7306     my @mergeinputs = generate_commits_from_dsc();
7307     die unless @mergeinputs == 1;
7308
7309     my $newhash = $mergeinputs[0]{Commit};
7310
7311     if ($oldhash) {
7312         if ($force > 0) {
7313             progress __
7314                 "Import, forced update - synthetic orphan git history.";
7315         } elsif ($force < 0) {
7316             progress __ "Import, merging.";
7317             my $tree = cmdoutput @git, qw(rev-parse), "$newhash:";
7318             my $version = getfield $dsc, 'Version';
7319             my $clogp = commit_getclogp $newhash;
7320             my $authline = clogp_authline $clogp;
7321             $newhash = hash_commit_text <<ENDU
7322 tree $tree
7323 parent $newhash
7324 parent $oldhash
7325 author $authline
7326 committer $authline
7327
7328 ENDU
7329                 .(f_ <<END, $package, $version, $dstbranch);
7330 Merge %s (%s) import into %s
7331 END
7332         } else {
7333             die; # caught earlier
7334         }
7335     }
7336
7337     import_dsc_result $dstbranch, $newhash,
7338         "dgit import-dsc: $info",
7339         f_ "results are in git ref %s", $dstbranch;
7340 }
7341
7342 sub pre_archive_api_query () {
7343     not_necessarily_a_tree();
7344 }
7345 sub cmd_archive_api_query {
7346     badusage __ "need only 1 subpath argument" unless @ARGV==1;
7347     my ($subpath) = @ARGV;
7348     local $isuite = 'DGIT-API-QUERY-CMD';
7349     my $json = api_query_raw $subpath;
7350     print $json or die "$!";
7351 }
7352
7353 sub repos_server_url () {
7354     $package = '_dgit-repos-server';
7355     local $access_forpush = 1;
7356     local $isuite = 'DGIT-REPOS-SERVER';
7357     my $url = access_giturl();
7358 }    
7359
7360 sub pre_clone_dgit_repos_server () {
7361     not_necessarily_a_tree();
7362 }
7363 sub cmd_clone_dgit_repos_server {
7364     badusage __ "need destination argument" unless @ARGV==1;
7365     my ($destdir) = @ARGV;
7366     my $url = repos_server_url();
7367     my @cmd = (@git, qw(clone), $url, $destdir);
7368     debugcmd ">",@cmd;
7369     exec @cmd or fail f_ "exec git clone: %s\n", $!;
7370 }
7371
7372 sub pre_print_dgit_repos_server_source_url () {
7373     not_necessarily_a_tree();
7374 }
7375 sub cmd_print_dgit_repos_server_source_url {
7376     badusage __
7377         "no arguments allowed to dgit print-dgit-repos-server-source-url"
7378         if @ARGV;
7379     my $url = repos_server_url();
7380     print $url, "\n" or confess "$!";
7381 }
7382
7383 sub pre_print_dpkg_source_ignores {
7384     not_necessarily_a_tree();
7385 }
7386 sub cmd_print_dpkg_source_ignores {
7387     badusage __
7388         "no arguments allowed to dgit print-dpkg-source-ignores"
7389         if @ARGV;
7390     print "@dpkg_source_ignores\n" or confess "$!";
7391 }
7392
7393 sub cmd_setup_mergechangelogs {
7394     badusage __ "no arguments allowed to dgit setup-mergechangelogs"
7395         if @ARGV;
7396     local $isuite = 'DGIT-SETUP-TREE';
7397     setup_mergechangelogs(1);
7398 }
7399
7400 sub cmd_setup_useremail {
7401     badusage __ "no arguments allowed to dgit setup-useremail" if @ARGV;
7402     local $isuite = 'DGIT-SETUP-TREE';
7403     setup_useremail(1);
7404 }
7405
7406 sub cmd_setup_gitattributes {
7407     badusage __ "no arguments allowed to dgit setup-useremail" if @ARGV;
7408     local $isuite = 'DGIT-SETUP-TREE';
7409     setup_gitattrs(1);
7410 }
7411
7412 sub cmd_setup_new_tree {
7413     badusage __ "no arguments allowed to dgit setup-tree" if @ARGV;
7414     local $isuite = 'DGIT-SETUP-TREE';
7415     setup_new_tree();
7416 }
7417
7418 #---------- argument parsing and main program ----------
7419
7420 sub cmd_version {
7421     print "dgit version $our_version\n" or confess "$!";
7422     finish 0;
7423 }
7424
7425 our (%valopts_long, %valopts_short);
7426 our (%funcopts_long);
7427 our @rvalopts;
7428 our (@modeopt_cfgs);
7429
7430 sub defvalopt ($$$$) {
7431     my ($long,$short,$val_re,$how) = @_;
7432     my $oi = { Long => $long, Short => $short, Re => $val_re, How => $how };
7433     $valopts_long{$long} = $oi;
7434     $valopts_short{$short} = $oi;
7435     # $how subref should:
7436     #   do whatever assignemnt or thing it likes with $_[0]
7437     #   if the option should not be passed on to remote, @rvalopts=()
7438     # or $how can be a scalar ref, meaning simply assign the value
7439 }
7440
7441 defvalopt '--since-version', '-v', '[^_]+|_', \$changes_since_version;
7442 defvalopt '--distro',        '-d', '.+',      \$idistro;
7443 defvalopt '',                '-k', '.+',      \$keyid;
7444 defvalopt '--existing-package','', '.*',      \$existing_package;
7445 defvalopt '--build-products-dir','','.*',     \$buildproductsdir;
7446 defvalopt '--clean',       '', $cleanmode_re, \$cleanmode;
7447 defvalopt '--package',   '-p',   $package_re, \$package;
7448 defvalopt '--quilt',     '', $quilt_modes_re, \$quilt_mode;
7449
7450 defvalopt '', '-C', '.+', sub {
7451     ($changesfile) = (@_);
7452     if ($changesfile =~ s#^(.*)/##) {
7453         $buildproductsdir = $1;
7454     }
7455 };
7456
7457 defvalopt '--initiator-tempdir','','.*', sub {
7458     ($initiator_tempdir) = (@_);
7459     $initiator_tempdir =~ m#^/# or
7460         badusage __ "--initiator-tempdir must be used specify an".
7461                     " absolute, not relative, directory."
7462 };
7463
7464 sub defoptmodes ($@) {
7465     my ($varref, $cfgkey, $default, %optmap) = @_;
7466     my %permit;
7467     while (my ($opt,$val) = each %optmap) {
7468         $funcopts_long{$opt} = sub { $$varref = $val; };
7469         $permit{$val} = $val;
7470     }
7471     push @modeopt_cfgs, {
7472         Var => $varref,
7473         Key => $cfgkey,
7474         Default => $default,
7475         Vals => \%permit
7476     };
7477 }
7478
7479 defoptmodes \$dodep14tag, qw( dep14tag          want
7480                               --dep14tag        want
7481                               --no-dep14tag     no
7482                               --always-dep14tag always );
7483
7484 sub parseopts () {
7485     my $om;
7486
7487     if (defined $ENV{'DGIT_SSH'}) {
7488         @ssh = string_to_ssh $ENV{'DGIT_SSH'};
7489     } elsif (defined $ENV{'GIT_SSH'}) {
7490         @ssh = ($ENV{'GIT_SSH'});
7491     }
7492
7493     my $oi;
7494     my $val;
7495     my $valopt = sub {
7496         my ($what) = @_;
7497         @rvalopts = ($_);
7498         if (!defined $val) {
7499             badusage f_ "%s needs a value", $what unless @ARGV;
7500             $val = shift @ARGV;
7501             push @rvalopts, $val;
7502         }
7503         badusage f_ "bad value \`%s' for %s", $val, $what unless
7504             $val =~ m/^$oi->{Re}$(?!\n)/s;
7505         my $how = $oi->{How};
7506         if (ref($how) eq 'SCALAR') {
7507             $$how = $val;
7508         } else {
7509             $how->($val);
7510         }
7511         push @ropts, @rvalopts;
7512     };
7513
7514     while (@ARGV) {
7515         last unless $ARGV[0] =~ m/^-/;
7516         $_ = shift @ARGV;
7517         last if m/^--?$/;
7518         if (m/^--/) {
7519             if (m/^--dry-run$/) {
7520                 push @ropts, $_;
7521                 $dryrun_level=2;
7522             } elsif (m/^--damp-run$/) {
7523                 push @ropts, $_;
7524                 $dryrun_level=1;
7525             } elsif (m/^--no-sign$/) {
7526                 push @ropts, $_;
7527                 $sign=0;
7528             } elsif (m/^--help$/) {
7529                 cmd_help();
7530             } elsif (m/^--version$/) {
7531                 cmd_version();
7532             } elsif (m/^--new$/) {
7533                 push @ropts, $_;
7534                 $new_package=1;
7535             } elsif (m/^--([-0-9a-z]+)=(.+)/s &&
7536                      ($om = $opts_opt_map{$1}) &&
7537                      length $om->[0]) {
7538                 push @ropts, $_;
7539                 $om->[0] = $2;
7540             } elsif (m/^--([-0-9a-z]+):(.*)/s &&
7541                      !$opts_opt_cmdonly{$1} &&
7542                      ($om = $opts_opt_map{$1})) {
7543                 push @ropts, $_;
7544                 push @$om, $2;
7545             } elsif (m/^--([-0-9a-z]+)\!:(.*)/s &&
7546                      !$opts_opt_cmdonly{$1} &&
7547                      ($om = $opts_opt_map{$1})) {
7548                 push @ropts, $_;
7549                 my $cmd = shift @$om;
7550                 @$om = ($cmd, grep { $_ ne $2 } @$om);
7551             } elsif (m/^--($quilt_options_re)$/s) {
7552                 push @ropts, "--quilt=$1";
7553                 $quilt_mode = $1;
7554             } elsif (m/^--(?:ignore|include)-dirty$/s) {
7555                 push @ropts, $_;
7556                 $includedirty = 1;
7557             } elsif (m/^--no-quilt-fixup$/s) {
7558                 push @ropts, $_;
7559                 $quilt_mode = 'nocheck';
7560             } elsif (m/^--no-rm-on-error$/s) {
7561                 push @ropts, $_;
7562                 $rmonerror = 0;
7563             } elsif (m/^--no-chase-dsc-distro$/s) {
7564                 push @ropts, $_;
7565                 $chase_dsc_distro = 0;
7566             } elsif (m/^--overwrite$/s) {
7567                 push @ropts, $_;
7568                 $overwrite_version = '';
7569             } elsif (m/^--split-(?:view|brain)$/s) {
7570                 push @ropts, $_;
7571                 $splitview_mode = 'always';
7572             } elsif (m/^--split-(?:view|brain)=($splitview_modes_re)$/s) {
7573                 push @ropts, $_;
7574                 $splitview_mode = $1;
7575             } elsif (m/^--overwrite=(.+)$/s) {
7576                 push @ropts, $_;
7577                 $overwrite_version = $1;
7578             } elsif (m/^--delayed=(\d+)$/s) {
7579                 push @ropts, $_;
7580                 push @dput, $_;
7581             } elsif (m/^--upstream-commitish=(.+)$/s) {
7582                 push @ropts, $_;
7583                 $quilt_upstream_commitish = $1;
7584             } elsif (m/^--save-(dgit-view)=(.+)$/s ||
7585                      m/^--(dgit-view)-save=(.+)$/s
7586                      ) {
7587                 my ($k,$v) = ($1,$2);
7588                 push @ropts, $_;
7589                 $v =~ s#^(?!refs/)#refs/heads/#;
7590                 $internal_object_save{$k} = $v;
7591             } elsif (m/^--(no-)?rm-old-changes$/s) {
7592                 push @ropts, $_;
7593                 $rmchanges = !$1;
7594             } elsif (m/^--deliberately-($deliberately_re)$/s) {
7595                 push @ropts, $_;
7596                 push @deliberatelies, $&;
7597             } elsif (m/^--force-(.*)/ && defined $forceopts{$1}) {
7598                 push @ropts, $&;
7599                 $forceopts{$1} = 1;
7600                 $_='';
7601             } elsif (m/^--force-/) {
7602                 print STDERR
7603                     f_ "%s: warning: ignoring unknown force option %s\n",
7604                        $us, $_;
7605                 $_='';
7606             } elsif (m/^--for-push$/s) {
7607                 push @ropts, $_;
7608                 $access_forpush = 1;
7609             } elsif (m/^--config-lookup-explode=(.+)$/s) {
7610                 # undocumented, for testing
7611                 push @ropts, $_;
7612                 $gitcfgs{cmdline}{$1} = 'CONFIG-LOOKUP-EXPLODE';
7613                 # ^ it's supposed to be an array ref
7614             } elsif (m/^(--[-0-9a-z]+)(=|$)/ && ($oi = $valopts_long{$1})) {
7615                 $val = $2 ? $' : undef; #';
7616                 $valopt->($oi->{Long});
7617             } elsif ($funcopts_long{$_}) {
7618                 push @ropts, $_;
7619                 $funcopts_long{$_}();
7620             } else {
7621                 badusage f_ "unknown long option \`%s'", $_;
7622             }
7623         } else {
7624             while (m/^-./s) {
7625                 if (s/^-n/-/) {
7626                     push @ropts, $&;
7627                     $dryrun_level=2;
7628                 } elsif (s/^-L/-/) {
7629                     push @ropts, $&;
7630                     $dryrun_level=1;
7631                 } elsif (s/^-h/-/) {
7632                     cmd_help();
7633                 } elsif (s/^-D/-/) {
7634                     push @ropts, $&;
7635                     $debuglevel++;
7636                     enabledebug();
7637                 } elsif (s/^-N/-/) {
7638                     push @ropts, $&;
7639                     $new_package=1;
7640                 } elsif (m/^-m/) {
7641                     push @ropts, $&;
7642                     push @changesopts, $_;
7643                     $_ = '';
7644                 } elsif (s/^-wn$//s) {
7645                     push @ropts, $&;
7646                     $cleanmode = 'none';
7647                 } elsif (s/^-wg(f?)(a?)$//s) {
7648                     push @ropts, $&;
7649                     $cleanmode = 'git';
7650                     $cleanmode .= '-ff' if $1;
7651                     $cleanmode .= ',always' if $2;
7652                 } elsif (s/^-wd(d?)([na]?)$//s) {
7653                     push @ropts, $&;
7654                     $cleanmode = 'dpkg-source';
7655                     $cleanmode .= '-d' if $1;
7656                     $cleanmode .= ',no-check' if $2 eq 'n';
7657                     $cleanmode .= ',all-check' if $2 eq 'a';
7658                 } elsif (s/^-wc$//s) {
7659                     push @ropts, $&;
7660                     $cleanmode = 'check';
7661                 } elsif (s/^-wci$//s) {
7662                     push @ropts, $&;
7663                     $cleanmode = 'check,ignores';
7664                 } elsif (s/^-c([^=]*)\=(.*)$//s) {
7665                     push @git, '-c', $&;
7666                     $gitcfgs{cmdline}{$1} = [ $2 ];
7667                 } elsif (s/^-c([^=]+)$//s) {
7668                     push @git, '-c', $&;
7669                     $gitcfgs{cmdline}{$1} = [ 'true' ];
7670                 } elsif (m/^-[a-zA-Z]/ && ($oi = $valopts_short{$&})) {
7671                     $val = $'; #';
7672                     $val = undef unless length $val;
7673                     $valopt->($oi->{Short});
7674                     $_ = '';
7675                 } else {
7676                     badusage f_ "unknown short option \`%s'", $_;
7677                 }
7678             }
7679         }
7680     }
7681 }
7682
7683 sub check_env_sanity () {
7684     my $blocked = new POSIX::SigSet;
7685     sigprocmask SIG_UNBLOCK, $blocked, $blocked or confess "$!";
7686
7687     eval {
7688         foreach my $name (qw(PIPE CHLD)) {
7689             my $signame = "SIG$name";
7690             my $signum = eval "POSIX::$signame" // die;
7691             die f_ "%s is set to something other than SIG_DFL\n",
7692                 $signame
7693                 if defined $SIG{$name} and $SIG{$name} ne 'DEFAULT';
7694             $blocked->ismember($signum) and
7695                 die f_ "%s is blocked\n", $signame;
7696         }
7697     };
7698     return unless $@;
7699     chomp $@;
7700     fail f_ <<END, $@;
7701 On entry to dgit, %s
7702 This is a bug produced by something in your execution environment.
7703 Giving up.
7704 END
7705 }
7706
7707
7708 sub parseopts_late_defaults () {
7709     $isuite //= cfg("dgit-distro.$idistro.default-suite", 'RETURN-UNDEF')
7710         if defined $idistro;
7711     $isuite //= cfg('dgit.default.default-suite');
7712
7713     foreach my $k (keys %opts_opt_map) {
7714         my $om = $opts_opt_map{$k};
7715
7716         my $v = access_cfg("cmd-$k", 'RETURN-UNDEF');
7717         if (defined $v) {
7718             badcfg f_ "cannot set command for %s", $k
7719                 unless length $om->[0];
7720             $om->[0] = $v;
7721         }
7722
7723         foreach my $c (access_cfg_cfgs("opts-$k")) {
7724             my @vl =
7725                 map { $_ ? @$_ : () }
7726                 map { $gitcfgs{$_}{$c} }
7727                 reverse @gitcfgsources;
7728             printdebug "CL $c ", (join " ", map { shellquote } @vl),
7729                 "\n" if $debuglevel >= 4;
7730             next unless @vl;
7731             badcfg f_ "cannot configure options for %s", $k
7732                 if $opts_opt_cmdonly{$k};
7733             my $insertpos = $opts_cfg_insertpos{$k};
7734             @$om = ( @$om[0..$insertpos-1],
7735                      @vl,
7736                      @$om[$insertpos..$#$om] );
7737         }
7738     }
7739
7740     if (!defined $rmchanges) {
7741         local $access_forpush;
7742         $rmchanges = access_cfg_bool(0, 'rm-old-changes');
7743     }
7744
7745     if (!defined $quilt_mode) {
7746         local $access_forpush;
7747         $quilt_mode = cfg('dgit.force.quilt-mode', 'RETURN-UNDEF')
7748             // access_cfg('quilt-mode', 'RETURN-UNDEF')
7749             // 'linear';
7750         $quilt_mode =~ m/^($quilt_modes_re)$/ 
7751             or badcfg f_ "unknown quilt-mode \`%s'", $quilt_mode;
7752         $quilt_mode = $1;
7753     }
7754     $quilt_mode =~ s/^(baredebian)\+git$/$1/;
7755
7756     foreach my $moc (@modeopt_cfgs) {
7757         local $access_forpush;
7758         my $vr = $moc->{Var};
7759         next if defined $$vr;
7760         $$vr = access_cfg($moc->{Key}, 'RETURN-UNDEF') // $moc->{Default};
7761         my $v = $moc->{Vals}{$$vr};
7762         badcfg f_ "unknown %s setting \`%s'", $moc->{Key}, $$vr
7763             unless defined $v;
7764         $$vr = $v;
7765     }
7766
7767     {
7768         local $access_forpush;
7769         default_from_access_cfg(\$cleanmode, 'clean-mode', 'dpkg-source',
7770                                 $cleanmode_re);
7771     }
7772
7773     $buildproductsdir //= access_cfg('build-products-dir', 'RETURN-UNDEF');
7774     $buildproductsdir //= '..';
7775     $bpd_glob = $buildproductsdir;
7776     $bpd_glob =~ s#[][\\{}*?~]#\\$&#g;
7777 }
7778
7779 setlocale(LC_MESSAGES, "");
7780 textdomain("dgit");
7781
7782 if ($ENV{$fakeeditorenv}) {
7783     git_slurp_config();
7784     quilt_fixup_editor();
7785 }
7786
7787 parseopts();
7788 check_env_sanity();
7789
7790 print STDERR __ "DRY RUN ONLY\n" if $dryrun_level > 1;
7791 print STDERR __ "DAMP RUN - WILL MAKE LOCAL (UNSIGNED) CHANGES\n"
7792     if $dryrun_level == 1;
7793 if (!@ARGV) {
7794     print STDERR __ $helpmsg or confess "$!";
7795     finish 8;
7796 }
7797 $cmd = $subcommand = shift @ARGV;
7798 $cmd =~ y/-/_/;
7799
7800 my $pre_fn = ${*::}{"pre_$cmd"};
7801 $pre_fn->() if $pre_fn;
7802
7803 if ($invoked_in_git_tree) {
7804     changedir_git_toplevel();
7805     record_maindir();
7806 }
7807 git_slurp_config();
7808
7809 my $fn = ${*::}{"cmd_$cmd"};
7810 $fn or badusage f_ "unknown operation %s", $cmd;
7811 $fn->();
7812
7813 finish 0;