chiark / gitweb /
4bd2e0534ff21e14f564f0a7eefa81f5e380fe5f
[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 clone ($) {
3852     # in multisuite, returns twice!
3853     # once in parent after first suite fetched,
3854     # and then again in child after everything is finished
3855     my ($dstdir) = @_;
3856     badusage __ "dry run makes no sense with clone" unless act_local();
3857
3858     my $multi_fetched = fork_for_multisuite(sub {
3859         printdebug "multi clone before fetch merge\n";
3860         changedir $dstdir;
3861         record_maindir();
3862     });
3863     if ($multi_fetched) {
3864         printdebug "multi clone after fetch merge\n";
3865         clone_set_head();
3866         clone_finish($dstdir);
3867         return;
3868     }
3869     printdebug "clone main body\n";
3870
3871     mkdir $dstdir or fail f_ "create \`%s': %s", $dstdir, $!;
3872     changedir $dstdir;
3873     check_bpd_exists();
3874
3875     canonicalise_suite();
3876     my $hasgit = check_for_git();
3877
3878     runcmd @git, qw(init -q);
3879     record_maindir();
3880     setup_new_tree();
3881     clone_set_head();
3882     if ($hasgit) {
3883         progress __ "fetching existing git history";
3884         git_fetch_us();
3885     } else {
3886         progress __ "starting new git history";
3887     }
3888     fetch_from_archive() or no_such_package;
3889     my $vcsgiturl = $dsc->{'Vcs-Git'};
3890     if (length $vcsgiturl) {
3891         $vcsgiturl =~ s/\s+-b\s+\S+//g;
3892         runcmd @git, qw(remote add vcs-git), $vcsgiturl;
3893     }
3894     clone_finish($dstdir);
3895 }
3896
3897 sub fetch_one () {
3898     canonicalise_suite();
3899     if (check_for_git()) {
3900         git_fetch_us();
3901     }
3902     fetch_from_archive() or no_such_package();
3903     
3904     my $vcsgiturl = $dsc && $dsc->{'Vcs-Git'};
3905     if (length $vcsgiturl and
3906         (grep { $csuite eq $_ }
3907          split /\;/,
3908          cfg 'dgit.vcs-git.suites')) {
3909         my $current = cfg 'remote.vcs-git.url', 'RETURN-UNDEF';
3910         if (defined $current && $current ne $vcsgiturl) {
3911             print STDERR f_ <<END, $csuite;
3912 FYI: Vcs-Git in %s has different url to your vcs-git remote.
3913  Your vcs-git remote url may be out of date.  Use dgit update-vcs-git ?
3914 END
3915         }
3916     }
3917     printdone f_ "fetched into %s", lrref();
3918 }
3919
3920 sub dofetch () {
3921     my $multi_fetched = fork_for_multisuite(sub { });
3922     fetch_one() unless $multi_fetched; # parent
3923     finish 0 if $multi_fetched eq '0'; # child
3924 }
3925
3926 sub pull () {
3927     dofetch();
3928     runcmd_ordryrun_local @git, qw(merge -m),
3929         (f_ "Merge from %s [dgit]", $csuite),
3930         lrref();
3931     printdone f_ "fetched to %s and merged into HEAD", lrref();
3932 }
3933
3934 sub check_not_dirty () {
3935     my @forbid = qw(local-options local-patch-header);
3936     @forbid = map { "debian/source/$_" } @forbid;
3937     foreach my $f (@forbid) {
3938         if (stat_exists $f) {
3939             fail f_ "git tree contains %s", $f;
3940         }
3941     }
3942
3943     my @cmd = (@git, qw(status -uall --ignored --porcelain));
3944     push @cmd, qw(debian/source/format debian/source/options);
3945     push @cmd, @forbid;
3946
3947     my $bad = cmdoutput @cmd;
3948     if (length $bad) {
3949         fail +(__
3950  "you have uncommitted changes to critical files, cannot continue:\n").
3951               $bad;
3952     }
3953
3954     return if $includedirty;
3955
3956     git_check_unmodified();
3957 }
3958
3959 sub commit_admin ($) {
3960     my ($m) = @_;
3961     progress "$m";
3962     runcmd_ordryrun_local @git, qw(commit -m), $m;
3963 }
3964
3965 sub quiltify_nofix_bail ($$) {
3966     my ($headinfo, $xinfo) = @_;
3967     if ($quilt_mode eq 'nofix') {
3968         fail f_
3969             "quilt fixup required but quilt mode is \`nofix'\n".
3970             "HEAD commit%s differs from tree implied by debian/patches%s",
3971             $headinfo, $xinfo;
3972     }
3973 }
3974
3975 sub commit_quilty_patch () {
3976     my $output = cmdoutput @git, qw(status --ignored --porcelain);
3977     my %adds;
3978     foreach my $l (split /\n/, $output) {
3979         next unless $l =~ m/\S/;
3980         if ($l =~ m{^(?:[?!][?!]| [MADRC]) (.pc|debian/patches)}) {
3981             $adds{$1}++;
3982         }
3983     }
3984     delete $adds{'.pc'}; # if there wasn't one before, don't add it
3985     if (!%adds) {
3986         progress __ "nothing quilty to commit, ok.";
3987         return;
3988     }
3989     quiltify_nofix_bail "", __ " (wanted to commit patch update)";
3990     my @adds = map { s/[][*?\\]/\\$&/g; $_; } sort keys %adds;
3991     runcmd_ordryrun_local @git, qw(add -f), @adds;
3992     commit_admin +(__ <<ENDT).<<END
3993 Commit Debian 3.0 (quilt) metadata
3994
3995 ENDT
3996 [dgit ($our_version) quilt-fixup]
3997 END
3998 }
3999
4000 sub get_source_format () {
4001     my %options;
4002     if (open F, "debian/source/options") {
4003         while (<F>) {
4004             next if m/^\s*\#/;
4005             next unless m/\S/;
4006             s/\s+$//; # ignore missing final newline
4007             if (m/\s*\#\s*/) {
4008                 my ($k, $v) = ($`, $'); #');
4009                 $v =~ s/^"(.*)"$/$1/;
4010                 $options{$k} = $v;
4011             } else {
4012                 $options{$_} = 1;
4013             }
4014         }
4015         F->error and confess "$!";
4016         close F;
4017     } else {
4018         confess "$!" unless $!==&ENOENT;
4019     }
4020
4021     if (!open F, "debian/source/format") {
4022         confess "$!" unless $!==&ENOENT;
4023         return '';
4024     }
4025     $_ = <F>;
4026     F->error and confess "$!";
4027     chomp;
4028     return ($_, \%options);
4029 }
4030
4031 sub madformat_wantfixup ($) {
4032     my ($format) = @_;
4033     return 0 unless $format eq '3.0 (quilt)';
4034     our $quilt_mode_warned;
4035     if ($quilt_mode eq 'nocheck') {
4036         progress f_ "Not doing any fixup of \`%s'".
4037             " due to ----no-quilt-fixup or --quilt=nocheck", $format
4038             unless $quilt_mode_warned++;
4039         return 0;
4040     }
4041     progress f_ "Format \`%s', need to check/update patch stack", $format
4042         unless $quilt_mode_warned++;
4043     return 1;
4044 }
4045
4046 sub maybe_split_brain_save ($$$) {
4047     my ($headref, $dgitview, $msg) = @_;
4048     # => message fragment "$saved" describing disposition of $dgitview
4049     #    (used inside parens, in the English texts)
4050     my $save = $internal_object_save{'dgit-view'};
4051     return f_ "commit id %s", $dgitview unless defined $save;
4052     my @cmd = (shell_cmd 'cd "$1"; shift', $maindir,
4053                git_update_ref_cmd
4054                "dgit --dgit-view-save $msg HEAD=$headref",
4055                $save, $dgitview);
4056     runcmd @cmd;
4057     return f_ "and left in %s", $save;
4058 }
4059
4060 # An "infopair" is a tuple [ $thing, $what ]
4061 # (often $thing is a commit hash; $what is a description)
4062
4063 sub infopair_cond_equal ($$) {
4064     my ($x,$y) = @_;
4065     $x->[0] eq $y->[0] or fail <<END;
4066 $x->[1] ($x->[0]) not equal to $y->[1] ($y->[0])
4067 END
4068 };
4069
4070 sub infopair_lrf_tag_lookup ($$) {
4071     my ($tagnames, $what) = @_;
4072     # $tagname may be an array ref
4073     my @tagnames = ref $tagnames ? @$tagnames : ($tagnames);
4074     printdebug "infopair_lrfetchref_tag_lookup $what @tagnames\n";
4075     foreach my $tagname (@tagnames) {
4076         my $lrefname = lrfetchrefs."/tags/$tagname";
4077         my $tagobj = $lrfetchrefs_f{$lrefname};
4078         next unless defined $tagobj;
4079         printdebug "infopair_lrfetchref_tag_lookup $tagobj $tagname $what\n";
4080         return [ git_rev_parse($tagobj), $what ];
4081     }
4082     fail @tagnames==1 ? (f_ <<END, $what, "@tagnames")
4083 Wanted tag %s (%s) on dgit server, but not found
4084 END
4085                       : (f_ <<END, $what, "@tagnames");
4086 Wanted tag %s (one of: %s) on dgit server, but not found
4087 END
4088 }
4089
4090 sub infopair_cond_ff ($$) {
4091     my ($anc,$desc) = @_;
4092     is_fast_fwd($anc->[0], $desc->[0]) or
4093         fail f_ <<END, $anc->[1], $anc->[0], $desc->[1], $desc->[0];
4094 %s (%s) .. %s (%s) is not fast forward
4095 END
4096 };
4097
4098 sub pseudomerge_version_check ($$) {
4099     my ($clogp, $archive_hash) = @_;
4100
4101     my $arch_clogp = commit_getclogp $archive_hash;
4102     my $i_arch_v = [ (getfield $arch_clogp, 'Version'),
4103                      __ 'version currently in archive' ];
4104     if (defined $overwrite_version) {
4105         if (length $overwrite_version) {
4106             infopair_cond_equal([ $overwrite_version,
4107                                   '--overwrite= version' ],
4108                                 $i_arch_v);
4109         } else {
4110             my $v = $i_arch_v->[0];
4111             progress f_
4112                 "Checking package changelog for archive version %s ...", $v;
4113             my $cd;
4114             eval {
4115                 my @xa = ("-f$v", "-t$v");
4116                 my $vclogp = parsechangelog @xa;
4117                 my $gf = sub {
4118                     my ($fn) = @_;
4119                     [ (getfield $vclogp, $fn),
4120                       (f_ "%s field from dpkg-parsechangelog %s",
4121                           $fn, "@xa") ];
4122                 };
4123                 my $cv = $gf->('Version');
4124                 infopair_cond_equal($i_arch_v, $cv);
4125                 $cd = $gf->('Distribution');
4126             };
4127             if ($@) {
4128                 $@ =~ s/^\n//s;
4129                 $@ =~ s/^dgit: //gm;
4130                 fail "$@".
4131                     f_ "Perhaps debian/changelog does not mention %s ?", $v;
4132             }
4133             fail f_ <<END, $cd->[1], $cd->[0], $v
4134 %s is %s
4135 Your tree seems to based on earlier (not uploaded) %s.
4136 END
4137                 if $cd->[0] =~ m/UNRELEASED/;
4138         }
4139     }
4140     
4141     printdebug "pseudomerge_version_check i_arch_v @$i_arch_v\n";
4142     return $i_arch_v;
4143 }
4144
4145 sub pseudomerge_hash_commit ($$$$ $$) {
4146     my ($clogp, $dgitview, $archive_hash, $i_arch_v,
4147         $msg_cmd, $msg_msg) = @_;
4148     progress f_ "Declaring that HEAD includes all changes in %s...",
4149                  $i_arch_v->[0];
4150
4151     my $tree = cmdoutput qw(git rev-parse), "${dgitview}:";
4152     my $authline = clogp_authline $clogp;
4153
4154     chomp $msg_msg;
4155     $msg_cmd .=
4156         !defined $overwrite_version ? ""
4157         : !length  $overwrite_version ? " --overwrite"
4158         : " --overwrite=".$overwrite_version;
4159
4160     # Contributing parent is the first parent - that makes
4161     # git rev-list --first-parent DTRT.
4162     my $pmf = dgit_privdir()."/pseudomerge";
4163     open MC, ">", $pmf or die "$pmf $!";
4164     print MC <<END or confess "$!";
4165 tree $tree
4166 parent $dgitview
4167 parent $archive_hash
4168 author $authline
4169 committer $authline
4170
4171 $msg_msg
4172
4173 [$msg_cmd]
4174 END
4175     close MC or confess "$!";
4176
4177     return hash_commit($pmf);
4178 }
4179
4180 sub splitbrain_pseudomerge ($$$$) {
4181     my ($clogp, $maintview, $dgitview, $archive_hash) = @_;
4182     # => $merged_dgitview
4183     printdebug "splitbrain_pseudomerge...\n";
4184     #
4185     #     We:      debian/PREVIOUS    HEAD($maintview)
4186     # expect:          o ----------------- o
4187     #                    \                   \
4188     #                     o                   o
4189     #                 a/d/PREVIOUS        $dgitview
4190     #                $archive_hash              \
4191     #  If so,                \                   \
4192     #  we do:                 `------------------ o
4193     #   this:                                   $dgitview'
4194     #
4195
4196     return $dgitview unless defined $archive_hash;
4197     return $dgitview if deliberately_not_fast_forward();
4198
4199     printdebug "splitbrain_pseudomerge...\n";
4200
4201     my $i_arch_v = pseudomerge_version_check($clogp, $archive_hash);
4202
4203     if (!defined $overwrite_version) {
4204         progress __ "Checking that HEAD includes all changes in archive...";
4205     }
4206
4207     return $dgitview if is_fast_fwd $archive_hash, $dgitview;
4208
4209     if (defined $overwrite_version) {
4210     } elsif (!eval {
4211         my $t_dep14 = debiantag_maintview $i_arch_v->[0], access_nomdistro;
4212         my $i_dep14 = infopair_lrf_tag_lookup($t_dep14,
4213                                               __ "maintainer view tag");
4214         my $t_dgit = debiantag_new $i_arch_v->[0], access_nomdistro;
4215         my $i_dgit = infopair_lrf_tag_lookup($t_dgit, __ "dgit view tag");
4216         my $i_archive = [ $archive_hash, __ "current archive contents" ];
4217
4218         printdebug "splitbrain_pseudomerge i_archive @$i_archive\n";
4219
4220         infopair_cond_equal($i_dgit, $i_archive);
4221         infopair_cond_ff($i_dep14, $i_dgit);
4222         infopair_cond_ff($i_dep14, [ $maintview, 'HEAD' ]);
4223         1;
4224     }) {
4225         $@ =~ s/^\n//; chomp $@;
4226         print STDERR <<END.(__ <<ENDT);
4227 $@
4228 END
4229 | Not fast forward; maybe --overwrite is needed ?  Please see dgit(1).
4230 ENDT
4231         finish -1;
4232     }
4233
4234     my $arch_v = $i_arch_v->[0];
4235     my $r = pseudomerge_hash_commit
4236         $clogp, $dgitview, $archive_hash, $i_arch_v,
4237         "dgit --quilt=$quilt_mode",
4238         (defined $overwrite_version
4239          ? f_ "Declare fast forward from %s\n", $arch_v
4240          : f_ "Make fast forward from %s\n",    $arch_v);
4241
4242     maybe_split_brain_save $maintview, $r, "pseudomerge";
4243
4244     progress f_ "Made pseudo-merge of %s into dgit view.", $arch_v;
4245     return $r;
4246 }       
4247
4248 sub plain_overwrite_pseudomerge ($$$) {
4249     my ($clogp, $head, $archive_hash) = @_;
4250
4251     printdebug "plain_overwrite_pseudomerge...";
4252
4253     my $i_arch_v = pseudomerge_version_check($clogp, $archive_hash);
4254
4255     return $head if is_fast_fwd $archive_hash, $head;
4256
4257     my $m = f_ "Declare fast forward from %s", $i_arch_v->[0];
4258
4259     my $r = pseudomerge_hash_commit
4260         $clogp, $head, $archive_hash, $i_arch_v,
4261         "dgit", $m;
4262
4263     runcmd git_update_ref_cmd $m, 'HEAD', $r, $head;
4264
4265     progress f_ "Make pseudo-merge of %s into your HEAD.", $i_arch_v->[0];
4266     return $r;
4267 }
4268
4269 sub push_parse_changelog ($) {
4270     my ($clogpfn) = @_;
4271
4272     my $clogp = Dpkg::Control::Hash->new();
4273     $clogp->load($clogpfn) or die;
4274
4275     my $clogpackage = getfield $clogp, 'Source';
4276     $package //= $clogpackage;
4277     fail f_ "-p specified %s but changelog specified %s",
4278             $package, $clogpackage
4279         unless $package eq $clogpackage;
4280     my $cversion = getfield $clogp, 'Version';
4281
4282     if (!$we_are_initiator) {
4283         # rpush initiator can't do this because it doesn't have $isuite yet
4284         my $tag = debiantag_new($cversion, access_nomdistro);
4285         runcmd @git, qw(check-ref-format), $tag;
4286     }
4287
4288     my $dscfn = dscfn($cversion);
4289
4290     return ($clogp, $cversion, $dscfn);
4291 }
4292
4293 sub push_parse_dsc ($$$) {
4294     my ($dscfn,$dscfnwhat, $cversion) = @_;
4295     $dsc = parsecontrol($dscfn,$dscfnwhat);
4296     my $dversion = getfield $dsc, 'Version';
4297     my $dscpackage = getfield $dsc, 'Source';
4298     ($dscpackage eq $package && $dversion eq $cversion) or
4299         fail f_ "%s is for %s %s but debian/changelog is for %s %s",
4300                 $dscfn, $dscpackage, $dversion,
4301                         $package,    $cversion;
4302 }
4303
4304 sub push_tagwants ($$$$) {
4305     my ($cversion, $dgithead, $maintviewhead, $tfbase) = @_;
4306     my @tagwants;
4307     push @tagwants, {
4308         TagFn => \&debiantag_new,
4309         Objid => $dgithead,
4310         TfSuffix => '',
4311         View => 'dgit',
4312     };
4313     if (defined $maintviewhead) {
4314         push @tagwants, {
4315             TagFn => \&debiantag_maintview,
4316             Objid => $maintviewhead,
4317             TfSuffix => '-maintview',
4318             View => 'maint',
4319         };
4320     } elsif ($dodep14tag ne 'no') {
4321         push @tagwants, {
4322             TagFn => \&debiantag_maintview,
4323             Objid => $dgithead,
4324             TfSuffix => '-dgit',
4325             View => 'dgit',
4326         };
4327     };
4328     foreach my $tw (@tagwants) {
4329         $tw->{Tag} = $tw->{TagFn}($cversion, access_nomdistro);
4330         $tw->{Tfn} = sub { $tfbase.$tw->{TfSuffix}.$_[0]; };
4331     }
4332     printdebug 'push_tagwants: ', Dumper(\@_, \@tagwants);
4333     return @tagwants;
4334 }
4335
4336 sub push_mktags ($$ $$ $) {
4337     my ($clogp,$dscfn,
4338         $changesfile,$changesfilewhat,
4339         $tagwants) = @_;
4340
4341     die unless $tagwants->[0]{View} eq 'dgit';
4342
4343     my $declaredistro = access_nomdistro();
4344     my $reader_giturl = do { local $access_forpush=0; access_giturl(); };
4345     $dsc->{$ourdscfield[0]} = join " ",
4346         $tagwants->[0]{Objid}, $declaredistro, $tagwants->[0]{Tag},
4347         $reader_giturl;
4348     $dsc->save("$dscfn.tmp") or confess "$!";
4349
4350     my $changes = parsecontrol($changesfile,$changesfilewhat);
4351     foreach my $field (qw(Source Distribution Version)) {
4352         $changes->{$field} eq $clogp->{$field} or
4353             fail f_ "changes field %s \`%s' does not match changelog \`%s'",
4354                     $field, $changes->{$field}, $clogp->{$field};
4355     }
4356
4357     my $cversion = getfield $clogp, 'Version';
4358     my $clogsuite = getfield $clogp, 'Distribution';
4359     my $format = getfield $dsc, 'Format';
4360
4361     # We make the git tag by hand because (a) that makes it easier
4362     # to control the "tagger" (b) we can do remote signing
4363     my $authline = clogp_authline $clogp;
4364
4365     my $mktag = sub {
4366         my ($tw) = @_;
4367         my $tfn = $tw->{Tfn};
4368         my $head = $tw->{Objid};
4369         my $tag = $tw->{Tag};
4370
4371         open TO, '>', $tfn->('.tmp') or confess "$!";
4372         print TO <<END or confess "$!";
4373 object $head
4374 type commit
4375 tag $tag
4376 tagger $authline
4377
4378 END
4379
4380         my @dtxinfo = @deliberatelies;
4381         unshift @dtxinfo, "--quilt=$quilt_mode" if madformat($format);
4382         unshift @dtxinfo, do_split_brain() ? "split" : "no-split"
4383             # rpush protocol 5 and earlier don't tell us
4384             unless $we_are_initiator && $protovsn < 6;
4385         my $dtxinfo = join(" ", "",@dtxinfo);
4386         my $tag_metadata = <<END;
4387 [dgit distro=$declaredistro$dtxinfo]
4388 END
4389         foreach my $ref (sort keys %previously) {
4390             $tag_metadata .= <<END or confess "$!";
4391 [dgit previously:$ref=$previously{$ref}]
4392 END
4393         }
4394
4395         if ($tw->{View} eq 'dgit') {
4396             print TO sprintf <<ENDT, $package, $cversion, $clogsuite, $csuite
4397 %s release %s for %s (%s) [dgit]
4398 ENDT
4399                 or confess "$!";
4400         } elsif ($tw->{View} eq 'maint') {
4401             print TO sprintf <<END, $package, $cversion, $clogsuite, $csuite;
4402 %s release %s for %s (%s)
4403
4404 END
4405             print TO f_ <<END,
4406 (maintainer view tag generated by dgit --quilt=%s)
4407 END
4408                 $quilt_mode
4409                 or confess "$!";
4410         } else {
4411             confess Dumper($tw)."?";
4412         }
4413         print TO "\n", $tag_metadata;
4414
4415         close TO or confess "$!";
4416
4417         my $tagobjfn = $tfn->('.tmp');
4418         if ($sign) {
4419             if (!defined $keyid) {
4420                 $keyid = access_cfg('keyid','RETURN-UNDEF');
4421             }
4422             if (!defined $keyid) {
4423                 $keyid = getfield $clogp, 'Maintainer';
4424             }
4425             unlink $tfn->('.tmp.asc') or $!==&ENOENT or confess "$!";
4426             my @sign_cmd = (@gpg, qw(--detach-sign --armor));
4427             push @sign_cmd, qw(-u),$keyid if defined $keyid;
4428             push @sign_cmd, $tfn->('.tmp');
4429             runcmd_ordryrun @sign_cmd;
4430             if (act_scary()) {
4431                 $tagobjfn = $tfn->('.signed.tmp');
4432                 runcmd shell_cmd "exec >$tagobjfn", qw(cat --),
4433                     $tfn->('.tmp'), $tfn->('.tmp.asc');
4434             }
4435         }
4436         return $tagobjfn;
4437     };
4438
4439     my @r = map { $mktag->($_); } @$tagwants;
4440     return @r;
4441 }
4442
4443 sub sign_changes ($) {
4444     my ($changesfile) = @_;
4445     if ($sign) {
4446         my @debsign_cmd = @debsign;
4447         push @debsign_cmd, "-k$keyid" if defined $keyid;
4448         push @debsign_cmd, "-p$gpg[0]" if $gpg[0] ne 'gpg';
4449         push @debsign_cmd, $changesfile;
4450         runcmd_ordryrun @debsign_cmd;
4451     }
4452 }
4453
4454 sub dopush () {
4455     printdebug "actually entering push\n";
4456
4457     supplementary_message(__ <<'END');
4458 Push failed, while checking state of the archive.
4459 You can retry the push, after fixing the problem, if you like.
4460 END
4461     if (check_for_git()) {
4462         git_fetch_us();
4463     }
4464     my $archive_hash = fetch_from_archive();
4465     if (!$archive_hash) {
4466         $new_package or
4467             fail __ "package appears to be new in this suite;".
4468                     " if this is intentional, use --new";
4469     }
4470
4471     supplementary_message(__ <<'END');
4472 Push failed, while preparing your push.
4473 You can retry the push, after fixing the problem, if you like.
4474 END
4475
4476     prep_ud();
4477
4478     access_giturl(); # check that success is vaguely likely
4479     rpush_handle_protovsn_bothends() if $we_are_initiator;
4480
4481     my $clogpfn = dgit_privdir()."/changelog.822.tmp";
4482     runcmd shell_cmd "exec >$clogpfn", qw(dpkg-parsechangelog);
4483
4484     responder_send_file('parsed-changelog', $clogpfn);
4485
4486     my ($clogp, $cversion, $dscfn) =
4487         push_parse_changelog("$clogpfn");
4488
4489     my $dscpath = "$buildproductsdir/$dscfn";
4490     stat_exists $dscpath or
4491         fail f_ "looked for .dsc %s, but %s; maybe you forgot to build",
4492                 $dscpath, $!;
4493
4494     responder_send_file('dsc', $dscpath);
4495
4496     push_parse_dsc($dscpath, $dscfn, $cversion);
4497
4498     my $format = getfield $dsc, 'Format';
4499
4500     my $symref = git_get_symref();
4501     my $actualhead = git_rev_parse('HEAD');
4502
4503     if (branch_is_gdr_unstitched_ff($symref, $actualhead, $archive_hash)) {
4504         if (quiltmode_splitting()) {
4505             my ($ffq_prev, $gdrlast) = branch_gdr_info($symref, $actualhead);
4506             fail f_ <<END, $ffq_prev, $quilt_mode;
4507 Branch is managed by git-debrebase (%s
4508 exists), but quilt mode (%s) implies a split view.
4509 Pass the right --quilt option or adjust your git config.
4510 Or, maybe, run git-debrebase forget-was-ever-debrebase.
4511 END
4512         }
4513         runcmd_ordryrun_local @git_debrebase, 'stitch';
4514         $actualhead = git_rev_parse('HEAD');
4515     }
4516
4517     my $dgithead = $actualhead;
4518     my $maintviewhead = undef;
4519
4520     my $upstreamversion = upstreamversion $clogp->{Version};
4521
4522     if (madformat_wantfixup($format)) {
4523         # user might have not used dgit build, so maybe do this now:
4524         if (do_split_brain()) {
4525             changedir $playground;
4526             my $cachekey;
4527             ($dgithead, $cachekey) =
4528                 quilt_check_splitbrain_cache($actualhead, $upstreamversion);
4529             $dgithead or fail f_
4530  "--quilt=%s but no cached dgit view:
4531  perhaps HEAD changed since dgit build[-source] ?",
4532                               $quilt_mode;
4533         }
4534         if (!do_split_brain()) {
4535             # In split brain mode, do not attempt to incorporate dirty
4536             # stuff from the user's working tree.  That would be mad.
4537             commit_quilty_patch();
4538         }
4539     }
4540     if (do_split_brain()) {
4541         $made_split_brain = 1;
4542         $dgithead = splitbrain_pseudomerge($clogp,
4543                                            $actualhead, $dgithead,
4544                                            $archive_hash);
4545         $maintviewhead = $actualhead;
4546         changedir $maindir;
4547         prep_ud(); # so _only_subdir() works, below
4548     }
4549
4550     if (defined $overwrite_version && !defined $maintviewhead
4551         && $archive_hash) {
4552         $dgithead = plain_overwrite_pseudomerge($clogp,
4553                                                 $dgithead,
4554                                                 $archive_hash);
4555     }
4556
4557     check_not_dirty();
4558
4559     my $forceflag = '';
4560     if ($archive_hash) {
4561         if (is_fast_fwd($archive_hash, $dgithead)) {
4562             # ok
4563         } elsif (deliberately_not_fast_forward) {
4564             $forceflag = '+';
4565         } else {
4566             fail __ "dgit push: HEAD is not a descendant".
4567                 " of the archive's version.\n".
4568                 "To overwrite the archive's contents,".
4569                 " pass --overwrite[=VERSION].\n".
4570                 "To rewind history, if permitted by the archive,".
4571                 " use --deliberately-not-fast-forward.";
4572         }
4573     }
4574
4575     confess unless !!$made_split_brain == do_split_brain();
4576
4577     changedir $playground;
4578     progress f_ "checking that %s corresponds to HEAD", $dscfn;
4579     runcmd qw(dpkg-source -x --),
4580         $dscpath =~ m#^/# ? $dscpath : "$maindir/$dscpath";
4581     my ($tree,$dir) = mktree_in_ud_from_only_subdir("source package");
4582     check_for_vendor_patches() if madformat($dsc->{format});
4583     changedir $maindir;
4584     my @diffcmd = (@git, qw(diff --quiet), $tree, $dgithead);
4585     debugcmd "+",@diffcmd;
4586     $!=0; $?=-1;
4587     my $r = system @diffcmd;
4588     if ($r) {
4589         if ($r==256) {
4590             my $referent = $made_split_brain ? $dgithead : 'HEAD';
4591             my $diffs = cmdoutput @git, qw(diff --stat), $tree, $dgithead;
4592
4593             my @mode_changes;
4594             my $raw = cmdoutput @git,
4595                 qw(diff --no-renames -z -r --raw), $tree, $dgithead;
4596             my $changed;
4597             foreach (split /\0/, $raw) {
4598                 if (defined $changed) {
4599                     push @mode_changes, "$changed: $_\n" if $changed;
4600                     $changed = undef;
4601                     next;
4602                 } elsif (m/^:0+ 0+ /) {
4603                     $changed = '';
4604                 } elsif (m/^:(?:10*)?(\d+) (?:10*)?(\d+) /) {
4605                     $changed = "Mode change from $1 to $2"
4606                 } else {
4607                     die "$_ ?";
4608                 }
4609             }
4610             if (@mode_changes) {
4611                 fail +(f_ <<ENDT, $dscfn).<<END
4612 HEAD specifies a different tree to %s:
4613 ENDT
4614 $diffs
4615 END
4616                     .(join '', @mode_changes)
4617                     .(f_ <<ENDT, $tree, $referent);
4618 There is a problem with your source tree (see dgit(7) for some hints).
4619 To see a full diff, run git diff %s %s
4620 ENDT
4621             }
4622
4623             fail +(f_ <<ENDT, $dscfn).<<END.(f_ <<ENDT, $tree, $referent);
4624 HEAD specifies a different tree to %s:
4625 ENDT
4626 $diffs
4627 END
4628 Perhaps you forgot to build.  Or perhaps there is a problem with your
4629  source tree (see dgit(7) for some hints).  To see a full diff, run
4630    git diff %s %s
4631 ENDT
4632         } else {
4633             failedcmd @diffcmd;
4634         }
4635     }
4636     if (!$changesfile) {
4637         my $pat = changespat $cversion;
4638         my @cs = glob "$buildproductsdir/$pat";
4639         fail f_ "failed to find unique changes file".
4640                 " (looked for %s in %s);".
4641                 " perhaps you need to use dgit -C",
4642                 $pat, $buildproductsdir
4643             unless @cs==1;
4644         ($changesfile) = @cs;
4645     } else {
4646         $changesfile = "$buildproductsdir/$changesfile";
4647     }
4648
4649     # Check that changes and .dsc agree enough
4650     $changesfile =~ m{[^/]*$};
4651     my $changes = parsecontrol($changesfile,$&);
4652     files_compare_inputs($dsc, $changes)
4653         unless forceing [qw(dsc-changes-mismatch)];
4654
4655     # Check whether this is a source only upload
4656     my $hasdebs = $changes->{Files} =~ m{\.deb$}m;
4657     my $sourceonlypolicy = access_cfg 'source-only-uploads';
4658     if ($sourceonlypolicy eq 'ok') {
4659     } elsif ($sourceonlypolicy eq 'always') {
4660         forceable_fail [qw(uploading-binaries)],
4661             __ "uploading binaries, although distro policy is source only"
4662             if $hasdebs;
4663     } elsif ($sourceonlypolicy eq 'never') {
4664         forceable_fail [qw(uploading-source-only)],
4665             __ "source-only upload, although distro policy requires .debs"
4666             if !$hasdebs;
4667     } elsif ($sourceonlypolicy eq 'not-wholly-new') {
4668         forceable_fail [qw(uploading-source-only)],
4669             f_ "source-only upload, even though package is entirely NEW\n".
4670                "(this is contrary to policy in %s)",
4671                access_nomdistro()
4672             if !$hasdebs
4673             && $new_package
4674             && !(archive_query('package_not_wholly_new', $package) // 1);
4675     } else {
4676         badcfg f_ "unknown source-only-uploads policy \`%s'",
4677                   $sourceonlypolicy;
4678     }
4679
4680     # Perhaps adjust .dsc to contain right set of origs
4681     changes_update_origs_from_dsc($dsc, $changes, $upstreamversion,
4682                                   $changesfile)
4683         unless forceing [qw(changes-origs-exactly)];
4684
4685     # Checks complete, we're going to try and go ahead:
4686
4687     responder_send_file('changes',$changesfile);
4688     responder_send_command("param head $dgithead");
4689     responder_send_command("param csuite $csuite");
4690     responder_send_command("param isuite $isuite");
4691     responder_send_command("param tagformat new"); # needed in $protovsn==4
4692     responder_send_command("param splitbrain $do_split_brain");
4693     if (defined $maintviewhead) {
4694         responder_send_command("param maint-view $maintviewhead");
4695     }
4696
4697     # Perhaps send buildinfo(s) for signing
4698     my $changes_files = getfield $changes, 'Files';
4699     my @buildinfos = ($changes_files =~ m/ .* (\S+\.buildinfo)$/mg);
4700     foreach my $bi (@buildinfos) {
4701         responder_send_command("param buildinfo-filename $bi");
4702         responder_send_file('buildinfo', "$buildproductsdir/$bi");
4703     }
4704
4705     if (deliberately_not_fast_forward) {
4706         git_for_each_ref(lrfetchrefs, sub {
4707             my ($objid,$objtype,$lrfetchrefname,$reftail) = @_;
4708             my $rrefname= substr($lrfetchrefname, length(lrfetchrefs) + 1);
4709             responder_send_command("previously $rrefname=$objid");
4710             $previously{$rrefname} = $objid;
4711         });
4712     }
4713
4714     my @tagwants = push_tagwants($cversion, $dgithead, $maintviewhead,
4715                                  dgit_privdir()."/tag");
4716     my @tagobjfns;
4717
4718     supplementary_message(__ <<'END');
4719 Push failed, while signing the tag.
4720 You can retry the push, after fixing the problem, if you like.
4721 END
4722     # If we manage to sign but fail to record it anywhere, it's fine.
4723     if ($we_are_responder) {
4724         @tagobjfns = map { $_->{Tfn}('.signed-tmp') } @tagwants;
4725         responder_receive_files('signed-tag', @tagobjfns);
4726     } else {
4727         @tagobjfns = push_mktags($clogp,$dscpath,
4728                               $changesfile,$changesfile,
4729                               \@tagwants);
4730     }
4731     supplementary_message(__ <<'END');
4732 Push failed, *after* signing the tag.
4733 If you want to try again, you should use a new version number.
4734 END
4735
4736     pairwise { $a->{TagObjFn} = $b } @tagwants, @tagobjfns;
4737
4738     foreach my $tw (@tagwants) {
4739         my $tag = $tw->{Tag};
4740         my $tagobjfn = $tw->{TagObjFn};
4741         my $tag_obj_hash =
4742             cmdoutput @git, qw(hash-object -w -t tag), $tagobjfn;
4743         runcmd_ordryrun @git, qw(verify-tag), $tag_obj_hash;
4744         runcmd_ordryrun_local
4745             @git, qw(update-ref), "refs/tags/$tag", $tag_obj_hash;
4746     }
4747
4748     supplementary_message(__ <<'END');
4749 Push failed, while updating the remote git repository - see messages above.
4750 If you want to try again, you should use a new version number.
4751 END
4752     if (!check_for_git()) {
4753         create_remote_git_repo();
4754     }
4755
4756     my @pushrefs = $forceflag.$dgithead.":".rrref();
4757     foreach my $tw (@tagwants) {
4758         push @pushrefs, $forceflag."refs/tags/$tw->{Tag}";
4759     }
4760
4761     runcmd_ordryrun @git,
4762         qw(-c push.followTags=false push), access_giturl(), @pushrefs;
4763     runcmd_ordryrun git_update_ref_cmd 'dgit push', lrref(), $dgithead;
4764
4765     supplementary_message(__ <<'END');
4766 Push failed, while obtaining signatures on the .changes and .dsc.
4767 If it was just that the signature failed, you may try again by using
4768 debsign by hand to sign the changes file (see the command dgit tried,
4769 above), and then dput that changes file to complete the upload.
4770 If you need to change the package, you must use a new version number.
4771 END
4772     if ($we_are_responder) {
4773         my $dryrunsuffix = act_local() ? "" : ".tmp";
4774         my @rfiles = ($dscpath, $changesfile);
4775         push @rfiles, map { "$buildproductsdir/$_" } @buildinfos;
4776         responder_receive_files('signed-dsc-changes',
4777                                 map { "$_$dryrunsuffix" } @rfiles);
4778     } else {
4779         if (act_local()) {
4780             rename "$dscpath.tmp",$dscpath or die "$dscfn $!";
4781         } else {
4782             progress f_ "[new .dsc left in %s.tmp]", $dscpath;
4783         }
4784         sign_changes $changesfile;
4785     }
4786
4787     supplementary_message(f_ <<END, $changesfile);
4788 Push failed, while uploading package(s) to the archive server.
4789 You can retry the upload of exactly these same files with dput of:
4790   %s
4791 If that .changes file is broken, you will need to use a new version
4792 number for your next attempt at the upload.
4793 END
4794     my $host = access_cfg('upload-host','RETURN-UNDEF');
4795     my @hostarg = defined($host) ? ($host,) : ();
4796     runcmd_ordryrun @dput, @hostarg, $changesfile;
4797     printdone f_ "pushed and uploaded %s", $cversion;
4798
4799     supplementary_message('');
4800     responder_send_command("complete");
4801 }
4802
4803 sub pre_clone () {
4804     not_necessarily_a_tree();
4805 }
4806 sub cmd_clone {
4807     parseopts();
4808     my $dstdir;
4809     badusage __ "-p is not allowed with clone; specify as argument instead"
4810         if defined $package;
4811     if (@ARGV==1) {
4812         ($package) = @ARGV;
4813     } elsif (@ARGV==2 && $ARGV[1] =~ m#^\w#) {
4814         ($package,$isuite) = @ARGV;
4815     } elsif (@ARGV==2 && $ARGV[1] =~ m#^[./]#) {
4816         ($package,$dstdir) = @ARGV;
4817     } elsif (@ARGV==3) {
4818         ($package,$isuite,$dstdir) = @ARGV;
4819     } else {
4820         badusage __ "incorrect arguments to dgit clone";
4821     }
4822     notpushing();
4823
4824     $dstdir ||= "$package";
4825     if (stat_exists $dstdir) {
4826         fail f_ "%s already exists", $dstdir;
4827     }
4828
4829     my $cwd_remove;
4830     if ($rmonerror && !$dryrun_level) {
4831         $cwd_remove= getcwd();
4832         unshift @end, sub { 
4833             return unless defined $cwd_remove;
4834             if (!chdir "$cwd_remove") {
4835                 return if $!==&ENOENT;
4836                 confess "chdir $cwd_remove: $!";
4837             }
4838             printdebug "clone rmonerror removing $dstdir\n";
4839             if (stat $dstdir) {
4840                 rmtree($dstdir) or fail f_ "remove %s: %s\n", $dstdir, $!;
4841             } elsif (grep { $! == $_ }
4842                      (ENOENT, ENOTDIR, EACCES, EPERM, ELOOP)) {
4843             } else {
4844                 print STDERR f_ "check whether to remove %s: %s\n",
4845                                 $dstdir, $!;
4846             }
4847         };
4848     }
4849
4850     clone($dstdir);
4851     $cwd_remove = undef;
4852 }
4853
4854 sub branchsuite () {
4855     my $branch = git_get_symref();
4856     if (defined $branch && $branch =~ m#$lbranch_re#o) {
4857         return $1;
4858     } else {
4859         return undef;
4860     }
4861 }
4862
4863 sub package_from_d_control () {
4864     if (!defined $package) {
4865         my $sourcep = parsecontrol('debian/control','debian/control');
4866         $package = getfield $sourcep, 'Source';
4867     }
4868 }
4869
4870 sub fetchpullargs () {
4871     package_from_d_control();
4872     if (@ARGV==0) {
4873         $isuite = branchsuite();
4874         if (!$isuite) {
4875             my $clogp = parsechangelog();
4876             my $clogsuite = getfield $clogp, 'Distribution';
4877             $isuite= $clogsuite if $clogsuite ne 'UNRELEASED';
4878         }
4879     } elsif (@ARGV==1) {
4880         ($isuite) = @ARGV;
4881     } else {
4882         badusage __ "incorrect arguments to dgit fetch or dgit pull";
4883     }
4884     notpushing();
4885 }
4886
4887 sub cmd_fetch {
4888     parseopts();
4889     fetchpullargs();
4890     dofetch();
4891 }
4892
4893 sub cmd_pull {
4894     parseopts();
4895     fetchpullargs();
4896     determine_whether_split_brain get_source_format();
4897     if (do_split_brain()) {
4898         my ($format, $fopts) = get_source_format();
4899         madformat($format) and fail f_ <<END, $quilt_mode
4900 dgit pull not yet supported in split view mode (including with view-splitting quilt modes)
4901 END
4902     }
4903     pull();
4904 }
4905
4906 sub cmd_checkout {
4907     parseopts();
4908     package_from_d_control();
4909     @ARGV==1 or badusage __ "dgit checkout needs a suite argument";
4910     ($isuite) = @ARGV;
4911     notpushing();
4912
4913     foreach my $canon (qw(0 1)) {
4914         if (!$canon) {
4915             $csuite= $isuite;
4916         } else {
4917             undef $csuite;
4918             canonicalise_suite();
4919         }
4920         if (length git_get_ref lref()) {
4921             # local branch already exists, yay
4922             last;
4923         }
4924         if (!length git_get_ref lrref()) {
4925             if (!$canon) {
4926                 # nope
4927                 next;
4928             }
4929             dofetch();
4930         }
4931         # now lrref exists
4932         runcmd (@git, qw(update-ref), lref(), lrref(), '');
4933         last;
4934     }
4935     local $ENV{GIT_REFLOG_ACTION} = git_reflog_action_msg
4936         "dgit checkout $isuite";
4937     runcmd (@git, qw(checkout), lbranch());
4938 }
4939
4940 sub cmd_update_vcs_git () {
4941     my $specsuite;
4942     if (@ARGV==0 || $ARGV[0] =~ m/^-/) {
4943         ($specsuite,) = split /\;/, cfg 'dgit.vcs-git.suites';
4944     } else {
4945         ($specsuite) = (@ARGV);
4946         shift @ARGV;
4947     }
4948     my $dofetch=1;
4949     if (@ARGV) {
4950         if ($ARGV[0] eq '-') {
4951             $dofetch = 0;
4952         } elsif ($ARGV[0] eq '-') {
4953             shift;
4954         }
4955     }
4956
4957     package_from_d_control();
4958     my $ctrl;
4959     if ($specsuite eq '.') {
4960         $ctrl = parsecontrol 'debian/control', 'debian/control';
4961     } else {
4962         $isuite = $specsuite;
4963         get_archive_dsc();
4964         $ctrl = $dsc;
4965     }
4966     my $url = getfield $ctrl, 'Vcs-Git';
4967
4968     my @cmd;
4969     my $orgurl = cfg 'remote.vcs-git.url', 'RETURN-UNDEF';
4970     if (!defined $orgurl) {
4971         print STDERR f_ "setting up vcs-git: %s\n", $url;
4972         @cmd = (@git, qw(remote add vcs-git), $url);
4973     } elsif ($orgurl eq $url) {
4974         print STDERR f_ "vcs git already configured: %s\n", $url;
4975     } else {
4976         print STDERR f_ "changing vcs-git url to: %s\n", $url;
4977         @cmd = (@git, qw(remote set-url vcs-git), $url);
4978     }
4979     runcmd_ordryrun_local @cmd;
4980     if ($dofetch) {
4981         print f_ "fetching (%s)\n", "@ARGV";
4982         runcmd_ordryrun_local @git, qw(fetch vcs-git), @ARGV;
4983     }
4984 }
4985
4986 sub prep_push () {
4987     parseopts();
4988     build_or_push_prep_early();
4989     pushing();
4990     build_or_push_prep_modes();
4991     check_not_dirty();
4992     my $specsuite;
4993     if (@ARGV==0) {
4994     } elsif (@ARGV==1) {
4995         ($specsuite) = (@ARGV);
4996     } else {
4997         badusage f_ "incorrect arguments to dgit %s", $subcommand;
4998     }
4999     if ($new_package) {
5000         local ($package) = $existing_package; # this is a hack
5001         canonicalise_suite();
5002     } else {
5003         canonicalise_suite();
5004     }
5005     if (defined $specsuite &&
5006         $specsuite ne $isuite &&
5007         $specsuite ne $csuite) {
5008             fail f_ "dgit %s: changelog specifies %s (%s)".
5009                     " but command line specifies %s",
5010                     $subcommand, $isuite, $csuite, $specsuite;
5011     }
5012 }
5013
5014 sub cmd_push {
5015     prep_push();
5016     dopush();
5017 }
5018
5019 #---------- remote commands' implementation ----------
5020
5021 sub pre_remote_push_build_host {
5022     my ($nrargs) = shift @ARGV;
5023     my (@rargs) = @ARGV[0..$nrargs-1];
5024     @ARGV = @ARGV[$nrargs..$#ARGV];
5025     die unless @rargs;
5026     my ($dir,$vsnwant) = @rargs;
5027     # vsnwant is a comma-separated list; we report which we have
5028     # chosen in our ready response (so other end can tell if they
5029     # offered several)
5030     $debugprefix = ' ';
5031     $we_are_responder = 1;
5032     $us .= " (build host)";
5033
5034     open PI, "<&STDIN" or confess "$!";
5035     open STDIN, "/dev/null" or confess "$!";
5036     open PO, ">&STDOUT" or confess "$!";
5037     autoflush PO 1;
5038     open STDOUT, ">&STDERR" or confess "$!";
5039     autoflush STDOUT 1;
5040
5041     $vsnwant //= 1;
5042     ($protovsn) = grep {
5043         $vsnwant =~ m{^(?:.*,)?$_(?:,.*)?$}
5044     } @rpushprotovsn_support;
5045
5046     fail f_ "build host has dgit rpush protocol versions %s".
5047             " but invocation host has %s",
5048             (join ",", @rpushprotovsn_support), $vsnwant
5049         unless defined $protovsn;
5050
5051     changedir $dir;
5052 }
5053 sub cmd_remote_push_build_host {
5054     responder_send_command("dgit-remote-push-ready $protovsn");
5055     &cmd_push;
5056 }
5057
5058 sub pre_remote_push_responder { pre_remote_push_build_host(); }
5059 sub cmd_remote_push_responder { cmd_remote_push_build_host(); }
5060 # ... for compatibility with proto vsn.1 dgit (just so that user gets
5061 #     a good error message)
5062
5063 sub rpush_handle_protovsn_bothends () {
5064 }
5065
5066 our $i_tmp;
5067
5068 sub i_cleanup {
5069     local ($@, $?);
5070     my $report = i_child_report();
5071     if (defined $report) {
5072         printdebug "($report)\n";
5073     } elsif ($i_child_pid) {
5074         printdebug "(killing build host child $i_child_pid)\n";
5075         kill 15, $i_child_pid;
5076     }
5077     if (defined $i_tmp && !defined $initiator_tempdir) {
5078         changedir "/";
5079         eval { rmtree $i_tmp; };
5080     }
5081 }
5082
5083 END {
5084     return unless forkcheck_mainprocess();
5085     i_cleanup();
5086 }
5087
5088 sub i_method {
5089     my ($base,$selector,@args) = @_;
5090     $selector =~ s/\-/_/g;
5091     { no strict qw(refs); &{"${base}_${selector}"}(@args); }
5092 }
5093
5094 sub pre_rpush () {
5095     not_necessarily_a_tree();
5096 }
5097 sub cmd_rpush {
5098     my $host = nextarg;
5099     my $dir;
5100     if ($host =~ m/^((?:[^][]|\[[^][]*\])*)\:/) {
5101         $host = $1;
5102         $dir = $'; #';
5103     } else {
5104         $dir = nextarg;
5105     }
5106     $dir =~ s{^-}{./-};
5107     my @rargs = ($dir);
5108     push @rargs, join ",", @rpushprotovsn_support;
5109     my @rdgit;
5110     push @rdgit, @dgit;
5111     push @rdgit, @ropts;
5112     push @rdgit, qw(remote-push-build-host), (scalar @rargs), @rargs;
5113     push @rdgit, @ARGV;
5114     my @cmd = (@ssh, $host, shellquote @rdgit);
5115     debugcmd "+",@cmd;
5116
5117     $we_are_initiator=1;
5118
5119     if (defined $initiator_tempdir) {
5120         rmtree $initiator_tempdir;
5121         mkdir $initiator_tempdir, 0700
5122             or fail f_ "create %s: %s", $initiator_tempdir, $!;
5123         $i_tmp = $initiator_tempdir;
5124     } else {
5125         $i_tmp = tempdir();
5126     }
5127     $i_child_pid = open2(\*RO, \*RI, @cmd);
5128     changedir $i_tmp;
5129     ($protovsn) = initiator_expect { m/^dgit-remote-push-ready (\S+)/ };
5130     die "$protovsn ?" unless grep { $_ eq $protovsn } @rpushprotovsn_support;
5131
5132     for (;;) {
5133         my ($icmd,$iargs) = initiator_expect {
5134             m/^(\S+)(?: (.*))?$/;
5135             ($1,$2);
5136         };
5137         i_method "i_resp", $icmd, $iargs;
5138     }
5139 }
5140
5141 sub i_resp_progress ($) {
5142     my ($rhs) = @_;
5143     my $msg = protocol_read_bytes \*RO, $rhs;
5144     progress $msg;
5145 }
5146
5147 sub i_resp_supplementary_message ($) {
5148     my ($rhs) = @_;
5149     $supplementary_message = protocol_read_bytes \*RO, $rhs;
5150 }
5151
5152 sub i_resp_complete {
5153     my $pid = $i_child_pid;
5154     $i_child_pid = undef; # prevents killing some other process with same pid
5155     printdebug "waiting for build host child $pid...\n";
5156     my $got = waitpid $pid, 0;
5157     confess "$!" unless $got == $pid;
5158     fail f_ "build host child failed: %s", waitstatusmsg() if $?;
5159
5160     i_cleanup();
5161     printdebug __ "all done\n";
5162     finish 0;
5163 }
5164
5165 sub i_resp_file ($) {
5166     my ($keyword) = @_;
5167     my $localname = i_method "i_localname", $keyword;
5168     my $localpath = "$i_tmp/$localname";
5169     stat_exists $localpath and
5170         badproto \*RO, f_ "file %s (%s) twice", $keyword, $localpath;
5171     protocol_receive_file \*RO, $localpath;
5172     i_method "i_file", $keyword;
5173 }
5174
5175 our %i_param;
5176
5177 sub i_resp_param ($) {
5178     $_[0] =~ m/^(\S+) (.*)$/ or badproto \*RO, __ "bad param spec";
5179     $i_param{$1} = $2;
5180 }
5181
5182 sub i_resp_previously ($) {
5183     $_[0] =~ m#^(refs/tags/\S+)=(\w+)$#
5184         or badproto \*RO, __ "bad previously spec";
5185     my $r = system qw(git check-ref-format), $1;
5186     confess "bad previously ref spec ($r)" if $r;
5187     $previously{$1} = $2;
5188 }
5189
5190 our %i_wanted;
5191 our ($i_clogp, $i_version, $i_dscfn, $i_changesfn, @i_buildinfos);
5192
5193 sub i_resp_want ($) {
5194     my ($keyword) = @_;
5195     die "$keyword ?" if $i_wanted{$keyword}++;
5196     
5197     defined $i_param{'csuite'} or badproto \*RO, "premature desire, no csuite";
5198     $isuite = $i_param{'isuite'} // $i_param{'csuite'};
5199     die unless $isuite =~ m/^$suite_re$/;
5200
5201     if (!defined $dsc) {
5202         pushing();
5203         rpush_handle_protovsn_bothends();
5204         push_parse_dsc $i_dscfn, 'remote dsc', $i_version;
5205         if ($protovsn >= 6) {
5206             determine_whether_split_brain getfield $dsc, 'Format';
5207             $do_split_brain eq ($i_param{'splitbrain'} // '<unsent>')
5208                 or badproto \*RO,
5209  "split brain mismatch, $do_split_brain != $i_param{'split_brain'}";
5210             printdebug "rpush split brain $do_split_brain\n";
5211         }
5212     }
5213
5214     my @localpaths = i_method "i_want", $keyword;
5215     printdebug "[[  $keyword @localpaths\n";
5216     foreach my $localpath (@localpaths) {
5217         protocol_send_file \*RI, $localpath;
5218     }
5219     print RI "files-end\n" or confess "$!";
5220 }
5221
5222 sub i_localname_parsed_changelog {
5223     return "remote-changelog.822";
5224 }
5225 sub i_file_parsed_changelog {
5226     ($i_clogp, $i_version, $i_dscfn) =
5227         push_parse_changelog "$i_tmp/remote-changelog.822";
5228     die if $i_dscfn =~ m#/|^\W#;
5229 }
5230
5231 sub i_localname_dsc {
5232     defined $i_dscfn or badproto \*RO, "dsc (before parsed-changelog)";
5233     return $i_dscfn;
5234 }
5235 sub i_file_dsc { }
5236
5237 sub i_localname_buildinfo ($) {
5238     my $bi = $i_param{'buildinfo-filename'};
5239     defined $bi or badproto \*RO, "buildinfo before filename";
5240     defined $i_changesfn or badproto \*RO, "buildinfo before changes";
5241     $bi =~ m{^\Q$package\E_[!-.0-~]*\.buildinfo$}s
5242         or badproto \*RO, "improper buildinfo filename";
5243     return $&;
5244 }
5245 sub i_file_buildinfo {
5246     my $bi = $i_param{'buildinfo-filename'};
5247     my $bd = parsecontrol "$i_tmp/$bi", $bi;
5248     my $ch = parsecontrol "$i_tmp/$i_changesfn", 'changes';
5249     if (!forceing [qw(buildinfo-changes-mismatch)]) {
5250         files_compare_inputs($bd, $ch);
5251         (getfield $bd, $_) eq (getfield $ch, $_) or
5252             fail f_ "buildinfo mismatch in field %s", $_
5253             foreach qw(Source Version);
5254         !defined $bd->{$_} or
5255             fail f_ "buildinfo contains forbidden field %s", $_
5256             foreach qw(Changes Changed-by Distribution);
5257     }
5258     push @i_buildinfos, $bi;
5259     delete $i_param{'buildinfo-filename'};
5260 }
5261
5262 sub i_localname_changes {
5263     defined $i_dscfn or badproto \*RO, "dsc (before parsed-changelog)";
5264     $i_changesfn = $i_dscfn;
5265     $i_changesfn =~ s/\.dsc$/_dgit.changes/ or die;
5266     return $i_changesfn;
5267 }
5268 sub i_file_changes { }
5269
5270 sub i_want_signed_tag {
5271     printdebug Dumper(\%i_param, $i_dscfn);
5272     defined $i_param{'head'} && defined $i_dscfn && defined $i_clogp
5273         && defined $i_param{'csuite'}
5274         or badproto \*RO, "premature desire for signed-tag";
5275     my $head = $i_param{'head'};
5276     die if $head =~ m/[^0-9a-f]/ || $head !~ m/^../;
5277
5278     my $maintview = $i_param{'maint-view'};
5279     die if defined $maintview && $maintview =~ m/[^0-9a-f]/;
5280
5281     if ($protovsn == 4) {
5282         my $p = $i_param{'tagformat'} // '<undef>';
5283         $p eq 'new'
5284             or badproto \*RO, "tag format mismatch: $p vs. new";
5285     }
5286
5287     die unless $i_param{'csuite'} =~ m/^$suite_re$/;
5288     $csuite = $&;
5289     defined $dsc or badproto \*RO, "dsc (before parsed-changelog)";
5290
5291     my @tagwants = push_tagwants $i_version, $head, $maintview, "tag";
5292
5293     return
5294         push_mktags $i_clogp, $i_dscfn,
5295             $i_changesfn, (__ 'remote changes file'),
5296             \@tagwants;
5297 }
5298
5299 sub i_want_signed_dsc_changes {
5300     rename "$i_dscfn.tmp","$i_dscfn" or die "$i_dscfn $!";
5301     sign_changes $i_changesfn;
5302     return ($i_dscfn, $i_changesfn, @i_buildinfos);
5303 }
5304
5305 #---------- building etc. ----------
5306
5307 our $version;
5308 our $sourcechanges;
5309 our $dscfn;
5310
5311 #----- `3.0 (quilt)' handling -----
5312
5313 our $fakeeditorenv = 'DGIT_FAKE_EDITOR_QUILT';
5314
5315 sub quiltify_dpkg_commit ($$$;$) {
5316     my ($patchname,$author,$msg, $xinfo) = @_;
5317     $xinfo //= '';
5318
5319     mkpath '.git/dgit'; # we are in playtree
5320     my $descfn = ".git/dgit/quilt-description.tmp";
5321     open O, '>', $descfn or confess "$descfn: $!";
5322     $msg =~ s/\n+/\n\n/;
5323     print O <<END or confess "$!";
5324 From: $author
5325 ${xinfo}Subject: $msg
5326 ---
5327
5328 END
5329     close O or confess "$!";
5330
5331     {
5332         local $ENV{'EDITOR'} = cmdoutput qw(realpath --), $0;
5333         local $ENV{'VISUAL'} = $ENV{'EDITOR'};
5334         local $ENV{$fakeeditorenv} = cmdoutput qw(realpath --), $descfn;
5335         runcmd @dpkgsource, qw(--commit --include-removal .), $patchname;
5336     }
5337 }
5338
5339 sub quiltify_trees_differ ($$;$$$) {
5340     my ($x,$y,$finegrained,$ignorenamesr,$unrepres) = @_;
5341     # returns true iff the two tree objects differ other than in debian/
5342     # with $finegrained,
5343     # returns bitmask 01 - differ in upstream files except .gitignore
5344     #                 02 - differ in .gitignore
5345     # if $ignorenamesr is defined, $ingorenamesr->{$fn}
5346     #  is set for each modified .gitignore filename $fn
5347     # if $unrepres is defined, array ref to which is appeneded
5348     #  a list of unrepresentable changes (removals of upstream files
5349     #  (as messages)
5350     local $/=undef;
5351     my @cmd = (@git, qw(diff-tree -z --no-renames));
5352     push @cmd, qw(--name-only) unless $unrepres;
5353     push @cmd, qw(-r) if $finegrained || $unrepres;
5354     push @cmd, $x, $y;
5355     my $diffs= cmdoutput @cmd;
5356     my $r = 0;
5357     my @lmodes;
5358     foreach my $f (split /\0/, $diffs) {
5359         if ($unrepres && !@lmodes) {
5360             @lmodes = $f =~ m/^\:(\w+) (\w+) \w+ \w+ / or die "$_ ?";
5361             next;
5362         }
5363         my ($oldmode,$newmode) = @lmodes;
5364         @lmodes = ();
5365
5366         next if $f =~ m#^debian(?:/.*)?$#s;
5367
5368         if ($unrepres) {
5369             eval {
5370                 die __ "not a plain file or symlink\n"
5371                     unless $newmode =~ m/^(?:10|12)\d{4}$/ ||
5372                            $oldmode =~ m/^(?:10|12)\d{4}$/;
5373                 if ($oldmode =~ m/[^0]/ &&
5374                     $newmode =~ m/[^0]/) {
5375                     # both old and new files exist
5376                     die __ "mode or type changed\n" if $oldmode ne $newmode;
5377                     die __ "modified symlink\n" unless $newmode =~ m/^10/;
5378                 } elsif ($oldmode =~ m/[^0]/) {
5379                     # deletion
5380                     die __ "deletion of symlink\n"
5381                         unless $oldmode =~ m/^10/;
5382                 } else {
5383                     # creation
5384                     die __ "creation with non-default mode\n"
5385                         unless $newmode =~ m/^100644$/ or
5386                                $newmode =~ m/^120000$/;
5387                 }
5388             };
5389             if ($@) {
5390                 local $/="\n"; chomp $@;
5391                 push @$unrepres, [ $f, "$@ ($oldmode->$newmode)" ];
5392             }
5393         }
5394
5395         my $isignore = $f =~ m#^(?:.*/)?.gitignore$#s;
5396         $r |= $isignore ? 02 : 01;
5397         $ignorenamesr->{$f}=1 if $ignorenamesr && $isignore;
5398     }
5399     printdebug "quiltify_trees_differ $x $y => $r\n";
5400     return $r;
5401 }
5402
5403 sub quiltify_tree_sentinelfiles ($) {
5404     # lists the `sentinel' files present in the tree
5405     my ($x) = @_;
5406     my $r = cmdoutput @git, qw(ls-tree --name-only), $x,
5407         qw(-- debian/rules debian/control);
5408     $r =~ s/\n/,/g;
5409     return $r;
5410 }
5411
5412 sub quiltify_splitting ($$$$$$$) {
5413     my ($clogp, $unapplied, $headref, $oldtiptree, $diffbits,
5414         $editedignores, $cachekey) = @_;
5415     my $gitignore_special = 1;
5416     if ($quilt_mode !~ m/gbp|dpm|baredebian/) {
5417         # treat .gitignore just like any other upstream file
5418         $diffbits = { %$diffbits };
5419         $_ = !!$_ foreach values %$diffbits;
5420         $gitignore_special = 0;
5421     }
5422     # We would like any commits we generate to be reproducible
5423     my @authline = clogp_authline($clogp);
5424     local $ENV{GIT_COMMITTER_NAME} =  $authline[0];
5425     local $ENV{GIT_COMMITTER_EMAIL} = $authline[1];
5426     local $ENV{GIT_COMMITTER_DATE} =  $authline[2];
5427     local $ENV{GIT_AUTHOR_NAME} =  $authline[0];
5428     local $ENV{GIT_AUTHOR_EMAIL} = $authline[1];
5429     local $ENV{GIT_AUTHOR_DATE} =  $authline[2];
5430
5431     confess unless do_split_brain();
5432
5433     my $fulldiffhint = sub {
5434         my ($x,$y) = @_;
5435         my $cmd = "git diff $x $y -- :/ ':!debian'";
5436         $cmd .= " ':!/.gitignore' ':!*/.gitignore'" if $gitignore_special;
5437         return f_ "\nFor full diff showing the problem(s), type:\n %s\n",
5438                   $cmd;
5439     };
5440
5441     if ($quilt_mode =~ m/gbp|unapplied|baredebian/ &&
5442         ($diffbits->{O2H} & 01)) {
5443         my $msg = f_
5444  "--quilt=%s specified, implying patches-unapplied git tree\n".
5445  " but git tree differs from orig in upstream files.",
5446                      $quilt_mode;
5447         $msg .= $fulldiffhint->($unapplied, 'HEAD');
5448         if (!stat_exists "debian/patches" and $quilt_mode !~ m/baredebian/) {
5449             $msg .= __
5450  "\n ... debian/patches is missing; perhaps this is a patch queue branch?";
5451         }  
5452         fail $msg;
5453     }
5454     if ($quilt_mode =~ m/dpm/ &&
5455         ($diffbits->{H2A} & 01)) {
5456         fail +(f_ <<END, $quilt_mode). $fulldiffhint->($oldtiptree,'HEAD');
5457 --quilt=%s specified, implying patches-applied git tree
5458  but git tree differs from result of applying debian/patches to upstream
5459 END
5460     }
5461     if ($quilt_mode =~ m/baredebian/) {
5462         # We need to construct a merge which has upstream files from
5463         # upstream and debian/ files from HEAD.
5464
5465         read_tree_upstream $quilt_upstream_commitish, 1, $headref;
5466         my $version = getfield $clogp, 'Version';
5467         my $upsversion = upstreamversion $version;
5468         my $merge = make_commit
5469             [ $headref, $quilt_upstream_commitish ],
5470  [ +(f_ <<ENDT, $upsversion), $quilt_upstream_commitish_message, <<ENDU ];
5471 Combine debian/ with upstream source for %s
5472 ENDT
5473 [dgit ($our_version) baredebian-merge $version $quilt_upstream_commitish_used]
5474 ENDU
5475         runcmd @git, qw(reset -q --hard), $merge;
5476     }
5477     if ($quilt_mode =~ m/gbp|unapplied|baredebian/ &&
5478         ($diffbits->{O2A} & 01)) { # some patches
5479         progress __ "dgit view: creating patches-applied version using gbp pq";
5480         runcmd shell_cmd 'exec >/dev/null', gbp_pq, qw(import);
5481         # gbp pq import creates a fresh branch; push back to dgit-view
5482         runcmd @git, qw(update-ref refs/heads/dgit-view HEAD);
5483         runcmd @git, qw(checkout -q dgit-view);
5484     }
5485     if ($quilt_mode =~ m/gbp|dpm/ &&
5486         ($diffbits->{O2A} & 02)) {
5487         fail f_ <<END, $quilt_mode;
5488 --quilt=%s specified, implying that HEAD is for use with a
5489  tool which does not create patches for changes to upstream
5490  .gitignores: but, such patches exist in debian/patches.
5491 END
5492     }
5493     if (($diffbits->{O2H} & 02) && # user has modified .gitignore
5494         !($diffbits->{O2A} & 02)) { # patches do not change .gitignore
5495         progress __
5496             "dgit view: creating patch to represent .gitignore changes";
5497         ensuredir "debian/patches";
5498         my $gipatch = "debian/patches/auto-gitignore";
5499         open GIPATCH, ">>", "$gipatch" or confess "$gipatch: $!";
5500         stat GIPATCH or confess "$gipatch: $!";
5501         fail f_ "%s already exists; but want to create it".
5502                 " to record .gitignore changes",
5503                 $gipatch
5504             if (stat _)[7];
5505         print GIPATCH +(__ <<END).<<ENDU or die "$gipatch: $!";
5506 Subject: Update .gitignore from Debian packaging branch
5507
5508 The Debian packaging git branch contains these updates to the upstream
5509 .gitignore file(s).  This patch is autogenerated, to provide these
5510 updates to users of the official Debian archive view of the package.
5511 END
5512
5513 [dgit ($our_version) update-gitignore]
5514 ---
5515 ENDU
5516         close GIPATCH or die "$gipatch: $!";
5517         runcmd shell_cmd "exec >>$gipatch", @git, qw(diff),
5518             $unapplied, $headref, "--", sort keys %$editedignores;
5519         open SERIES, "+>>", "debian/patches/series" or confess "$!";
5520         defined seek SERIES, -1, 2 or $!==EINVAL or confess "$!";
5521         my $newline;
5522         defined read SERIES, $newline, 1 or confess "$!";
5523         print SERIES "\n" or confess "$!" unless $newline eq "\n";
5524         print SERIES "auto-gitignore\n" or confess "$!";
5525         close SERIES or die  $!;
5526         runcmd @git, qw(add -f -- debian/patches/series), $gipatch;
5527         commit_admin +(__ <<END).<<ENDU
5528 Commit patch to update .gitignore
5529 END
5530
5531 [dgit ($our_version) update-gitignore-quilt-fixup]
5532 ENDU
5533     }
5534 }
5535
5536 sub quiltify ($$$$) {
5537     my ($clogp,$target,$oldtiptree,$failsuggestion) = @_;
5538
5539     # Quilt patchification algorithm
5540     #
5541     # We search backwards through the history of the main tree's HEAD
5542     # (T) looking for a start commit S whose tree object is identical
5543     # to to the patch tip tree (ie the tree corresponding to the
5544     # current dpkg-committed patch series).  For these purposes
5545     # `identical' disregards anything in debian/ - this wrinkle is
5546     # necessary because dpkg-source treates debian/ specially.
5547     #
5548     # We can only traverse edges where at most one of the ancestors'
5549     # trees differs (in changes outside in debian/).  And we cannot
5550     # handle edges which change .pc/ or debian/patches.  To avoid
5551     # going down a rathole we avoid traversing edges which introduce
5552     # debian/rules or debian/control.  And we set a limit on the
5553     # number of edges we are willing to look at.
5554     #
5555     # If we succeed, we walk forwards again.  For each traversed edge
5556     # PC (with P parent, C child) (starting with P=S and ending with
5557     # C=T) to we do this:
5558     #  - git checkout C
5559     #  - dpkg-source --commit with a patch name and message derived from C
5560     # After traversing PT, we git commit the changes which
5561     # should be contained within debian/patches.
5562
5563     # The search for the path S..T is breadth-first.  We maintain a
5564     # todo list containing search nodes.  A search node identifies a
5565     # commit, and looks something like this:
5566     #  $p = {
5567     #      Commit => $git_commit_id,
5568     #      Child => $c,                          # or undef if P=T
5569     #      Whynot => $reason_edge_PC_unsuitable, # in @nots only
5570     #      Nontrivial => true iff $p..$c has relevant changes
5571     #  };
5572
5573     my @todo;
5574     my @nots;
5575     my $sref_S;
5576     my $max_work=100;
5577     my %considered; # saves being exponential on some weird graphs
5578
5579     my $t_sentinels = quiltify_tree_sentinelfiles $target;
5580
5581     my $not = sub {
5582         my ($search,$whynot) = @_;
5583         printdebug " search NOT $search->{Commit} $whynot\n";
5584         $search->{Whynot} = $whynot;
5585         push @nots, $search;
5586         no warnings qw(exiting);
5587         next;
5588     };
5589
5590     push @todo, {
5591         Commit => $target,
5592     };
5593
5594     while (@todo) {
5595         my $c = shift @todo;
5596         next if $considered{$c->{Commit}}++;
5597
5598         $not->($c, __ "maximum search space exceeded") if --$max_work <= 0;
5599
5600         printdebug "quiltify investigate $c->{Commit}\n";
5601
5602         # are we done?
5603         if (!quiltify_trees_differ $c->{Commit}, $oldtiptree) {
5604             printdebug " search finished hooray!\n";
5605             $sref_S = $c;
5606             last;
5607         }
5608
5609         quiltify_nofix_bail " $c->{Commit}", " (tree object $oldtiptree)";
5610         if ($quilt_mode eq 'smash') {
5611             printdebug " search quitting smash\n";
5612             last;
5613         }
5614
5615         my $c_sentinels = quiltify_tree_sentinelfiles $c->{Commit};
5616         $not->($c, f_ "has %s not %s", $c_sentinels, $t_sentinels)
5617             if $c_sentinels ne $t_sentinels;
5618
5619         my $commitdata = cmdoutput @git, qw(cat-file commit), $c->{Commit};
5620         $commitdata =~ m/\n\n/;
5621         $commitdata =~ $`;
5622         my @parents = ($commitdata =~ m/^parent (\w+)$/gm);
5623         @parents = map { { Commit => $_, Child => $c } } @parents;
5624
5625         $not->($c, __ "root commit") if !@parents;
5626
5627         foreach my $p (@parents) {
5628             $p->{Nontrivial}= quiltify_trees_differ $p->{Commit},$c->{Commit};
5629         }
5630         my $ndiffers = grep { $_->{Nontrivial} } @parents;
5631         $not->($c, f_ "merge (%s nontrivial parents)", $ndiffers)
5632             if $ndiffers > 1;
5633
5634         foreach my $p (@parents) {
5635             printdebug "considering C=$c->{Commit} P=$p->{Commit}\n";
5636
5637             my @cmd= (@git, qw(diff-tree -r --name-only),
5638                       $p->{Commit},$c->{Commit},
5639                       qw(-- debian/patches .pc debian/source/format));
5640             my $patchstackchange = cmdoutput @cmd;
5641             if (length $patchstackchange) {
5642                 $patchstackchange =~ s/\n/,/g;
5643                 $not->($p, f_ "changed %s", $patchstackchange);
5644             }
5645
5646             printdebug " search queue P=$p->{Commit} ",
5647                 ($p->{Nontrivial} ? "NT" : "triv"),"\n";
5648             push @todo, $p;
5649         }
5650     }
5651
5652     if (!$sref_S) {
5653         printdebug "quiltify want to smash\n";
5654
5655         my $abbrev = sub {
5656             my $x = $_[0]{Commit};
5657             $x =~ s/(.*?[0-9a-z]{8})[0-9a-z]*$/$1/;
5658             return $x;
5659         };
5660         if ($quilt_mode eq 'linear') {
5661             print STDERR f_
5662                 "\n%s: error: quilt fixup cannot be linear.  Stopped at:\n",
5663                 $us;
5664             my $all_gdr = !!@nots;
5665             foreach my $notp (@nots) {
5666                 my $c = $notp->{Child};
5667                 my $cprange = $abbrev->($notp);
5668                 $cprange .= "..".$abbrev->($c) if $c;
5669                 print STDERR f_ "%s:  %s: %s\n",
5670                     $us, $cprange, $notp->{Whynot};
5671                 $all_gdr &&= $notp->{Child} &&
5672                     (git_cat_file $notp->{Child}{Commit}, 'commit')
5673                     =~ m{^\[git-debrebase(?! split[: ]).*\]$}m;
5674             }
5675             print STDERR "\n";
5676             $failsuggestion =
5677                 [ grep { $_->[0] ne 'quilt-mode' } @$failsuggestion ]
5678                 if $all_gdr;
5679             print STDERR "$us: $_->[1]\n" foreach @$failsuggestion;
5680             fail __
5681  "quilt history linearisation failed.  Search \`quilt fixup' in dgit(7).\n";
5682         } elsif ($quilt_mode eq 'smash') {
5683         } elsif ($quilt_mode eq 'auto') {
5684             progress __ "quilt fixup cannot be linear, smashing...";
5685         } else {
5686             confess "$quilt_mode ?";
5687         }
5688
5689         my $time = $ENV{'GIT_COMMITTER_DATE'} || time;
5690         $time =~ s/\s.*//; # trim timezone from GIT_COMMITTER_DATE
5691         my $ncommits = 3;
5692         my $msg = cmdoutput @git, qw(log), "-n$ncommits";
5693
5694         quiltify_dpkg_commit "auto-$version-$target-$time",
5695             (getfield $clogp, 'Maintainer'),
5696             (f_ "Automatically generated patch (%s)\n".
5697              "Last (up to) %s git changes, FYI:\n\n",
5698              $clogp->{Version}, $ncommits).
5699              $msg;
5700         return;
5701     }
5702
5703     progress __ "quiltify linearisation planning successful, executing...";
5704
5705     for (my $p = $sref_S;
5706          my $c = $p->{Child};
5707          $p = $p->{Child}) {
5708         printdebug "quiltify traverse $p->{Commit}..$c->{Commit}\n";
5709         next unless $p->{Nontrivial};
5710
5711         my $cc = $c->{Commit};
5712
5713         my $commitdata = cmdoutput @git, qw(cat-file commit), $cc;
5714         $commitdata =~ m/\n\n/ or die "$c ?";
5715         $commitdata = $`;
5716         my $msg = $'; #';
5717         $commitdata =~ m/^author (.*) \d+ [-+0-9]+$/m or die "$cc ?";
5718         my $author = $1;
5719
5720         my $commitdate = cmdoutput
5721             @git, qw(log -n1 --pretty=format:%aD), $cc;
5722
5723         $msg =~ s/^(.*)\n*/$1\n/ or die "$cc $msg ?";
5724
5725         my $strip_nls = sub { $msg =~ s/\n+$//; $msg .= "\n"; };
5726         $strip_nls->();
5727
5728         my $title = $1;
5729         my $patchname;
5730         my $patchdir;
5731
5732         my $gbp_check_suitable = sub {
5733             $_ = shift;
5734             my ($what) = @_;
5735
5736             eval {
5737                 die __ "contains unexpected slashes\n" if m{//} || m{/$};
5738                 die __ "contains leading punctuation\n" if m{^\W} || m{/\W};
5739                 die __ "contains bad character(s)\n" if m{[^-a-z0-9_.+=~/]}i;
5740                 die __ "is series file\n" if m{$series_filename_re}o;
5741                 die __ "too long\n" if length > 200;
5742             };
5743             return $_ unless $@;
5744             print STDERR f_
5745                 "quiltifying commit %s: ignoring/dropping Gbp-Pq %s: %s",
5746                 $cc, $what, $@;
5747             return undef;
5748         };
5749
5750         if ($msg =~ s/^ (?: gbp(?:-pq)? : \s* name \s+ |
5751                            gbp-pq-name: \s* )
5752                        (\S+) \s* \n //ixm) {
5753             $patchname = $gbp_check_suitable->($1, 'Name');
5754         }
5755         if ($msg =~ s/^ (?: gbp(?:-pq)? : \s* topic \s+ |
5756                            gbp-pq-topic: \s* )
5757                        (\S+) \s* \n //ixm) {
5758             $patchdir = $gbp_check_suitable->($1, 'Topic');
5759         }
5760
5761         $strip_nls->();
5762
5763         if (!defined $patchname) {
5764             $patchname = $title;
5765             $patchname =~ s/[.:]$//;
5766             use Text::Iconv;
5767             eval {
5768                 my $converter = new Text::Iconv qw(UTF-8 ASCII//TRANSLIT);
5769                 my $translitname = $converter->convert($patchname);
5770                 die unless defined $translitname;
5771                 $patchname = $translitname;
5772             };
5773             print STDERR
5774                 +(f_ "dgit: patch title transliteration error: %s", $@)
5775                 if $@;
5776             $patchname =~ y/ A-Z/-a-z/;
5777             $patchname =~ y/-a-z0-9_.+=~//cd;
5778             $patchname =~ s/^\W/x-$&/;
5779             $patchname = substr($patchname,0,40);
5780             $patchname .= ".patch";
5781         }
5782         if (!defined $patchdir) {
5783             $patchdir = '';
5784         }
5785         if (length $patchdir) {
5786             $patchname = "$patchdir/$patchname";
5787         }
5788         if ($patchname =~ m{^(.*)/}) {
5789             mkpath "debian/patches/$1";
5790         }
5791
5792         my $index;
5793         for ($index='';
5794              stat "debian/patches/$patchname$index";
5795              $index++) { }
5796         $!==ENOENT or confess "$patchname$index $!";
5797
5798         runcmd @git, qw(checkout -q), $cc;
5799
5800         # We use the tip's changelog so that dpkg-source doesn't
5801         # produce complaining messages from dpkg-parsechangelog.  None
5802         # of the information dpkg-source gets from the changelog is
5803         # actually relevant - it gets put into the original message
5804         # which dpkg-source provides our stunt editor, and then
5805         # overwritten.
5806         runcmd @git, qw(checkout -q), $target, qw(debian/changelog);
5807
5808         quiltify_dpkg_commit "$patchname$index", $author, $msg,
5809             "Date: $commitdate\n".
5810             "X-Dgit-Generated: $clogp->{Version} $cc\n";
5811
5812         runcmd @git, qw(checkout -q), $cc, qw(debian/changelog);
5813     }
5814 }
5815
5816 sub build_maybe_quilt_fixup () {
5817     my ($format,$fopts) = get_source_format;
5818     return unless madformat_wantfixup $format;
5819     # sigh
5820
5821     check_for_vendor_patches();
5822
5823     my $clogp = parsechangelog();
5824     my $headref = git_rev_parse('HEAD');
5825     my $symref = git_get_symref();
5826     my $upstreamversion = upstreamversion $version;
5827
5828     prep_ud();
5829     changedir $playground;
5830
5831     my $splitbrain_cachekey;
5832
5833     if (do_split_brain()) {
5834         my $cachehit;
5835         ($cachehit, $splitbrain_cachekey) =
5836             quilt_check_splitbrain_cache($headref, $upstreamversion);
5837         if ($cachehit) {
5838             changedir $maindir;
5839             return;
5840         }
5841     }
5842
5843     unpack_playtree_need_cd_work($headref);
5844     if (do_split_brain()) {
5845         runcmd @git, qw(checkout -q -b dgit-view);
5846         # so long as work is not deleted, its current branch will
5847         # remain dgit-view, rather than master, so subsequent calls to
5848         #  unpack_playtree_need_cd_work
5849         # will DTRT, resetting dgit-view.
5850         confess if $made_split_brain;
5851         $made_split_brain = 1;
5852     }
5853     chdir '..';
5854
5855     if ($fopts->{'single-debian-patch'}) {
5856         fail f_
5857  "quilt mode %s does not make sense (or is not supported) with single-debian-patch",
5858             $quilt_mode
5859             if quiltmode_splitting();
5860         quilt_fixup_singlepatch($clogp, $headref, $upstreamversion);
5861     } else {
5862         quilt_fixup_multipatch($clogp, $headref, $upstreamversion,
5863                               $splitbrain_cachekey);
5864     }
5865
5866     if (do_split_brain()) {
5867         my $dgitview = git_rev_parse 'HEAD';
5868
5869         changedir $maindir;
5870         reflog_cache_insert "refs/$splitbraincache",
5871             $splitbrain_cachekey, $dgitview;
5872
5873         changedir "$playground/work";
5874
5875         my $saved = maybe_split_brain_save $headref, $dgitview, __ "converted";
5876         progress f_ "dgit view: created (%s)", $saved;
5877     }
5878
5879     changedir $maindir;
5880     runcmd_ordryrun_local
5881         @git, qw(pull --ff-only -q), "$playground/work", qw(master);
5882 }
5883
5884 sub build_check_quilt_splitbrain () {
5885     build_maybe_quilt_fixup();
5886 }
5887
5888 sub unpack_playtree_need_cd_work ($) {
5889     my ($headref) = @_;
5890
5891     # prep_ud() must have been called already.
5892     if (!chdir "work") {
5893         # Check in the filesystem because sometimes we run prep_ud
5894         # in between multiple calls to unpack_playtree_need_cd_work.
5895         confess "$!" unless $!==ENOENT;
5896         mkdir "work" or confess "$!";
5897         changedir "work";
5898         mktree_in_ud_here();
5899     }
5900     runcmd @git, qw(reset -q --hard), $headref;
5901 }
5902
5903 sub unpack_playtree_linkorigs ($$) {
5904     my ($upstreamversion, $fn) = @_;
5905     # calls $fn->($leafname);
5906
5907     my $bpd_abs = bpd_abs();
5908
5909     dotdot_bpd_transfer_origs $bpd_abs, $upstreamversion, sub { 1 };
5910
5911     opendir QFD, $bpd_abs or fail "buildproductsdir: $bpd_abs: $!";
5912     while ($!=0, defined(my $leaf = readdir QFD)) {
5913         my $f = bpd_abs()."/".$leaf;
5914         {
5915             local ($debuglevel) = $debuglevel-1;
5916             printdebug "QF linkorigs bpd $leaf, $f ?\n";
5917         }
5918         next unless is_orig_file_of_vsn $leaf, $upstreamversion;
5919         printdebug "QF linkorigs $leaf, $f Y\n";
5920         link_ltarget $f, $leaf or die "$leaf $!";
5921         $fn->($leaf);
5922     }
5923     die "$buildproductsdir: $!" if $!;
5924     closedir QFD;
5925 }
5926
5927 sub quilt_fixup_delete_pc () {
5928     runcmd @git, qw(rm -rqf .pc);
5929     commit_admin +(__ <<END).<<ENDU
5930 Commit removal of .pc (quilt series tracking data)
5931 END
5932
5933 [dgit ($our_version) upgrade quilt-remove-pc]
5934 ENDU
5935 }
5936
5937 sub quilt_fixup_singlepatch ($$$) {
5938     my ($clogp, $headref, $upstreamversion) = @_;
5939
5940     progress __ "starting quiltify (single-debian-patch)";
5941
5942     # dpkg-source --commit generates new patches even if
5943     # single-debian-patch is in debian/source/options.  In order to
5944     # get it to generate debian/patches/debian-changes, it is
5945     # necessary to build the source package.
5946
5947     unpack_playtree_linkorigs($upstreamversion, sub { });
5948     unpack_playtree_need_cd_work($headref);
5949
5950     rmtree("debian/patches");
5951
5952     runcmd @dpkgsource, qw(-b .);
5953     changedir "..";
5954     runcmd @dpkgsource, qw(-x), (srcfn $version, ".dsc");
5955     rename srcfn("$upstreamversion", "/debian/patches"), 
5956         "work/debian/patches"
5957         or $!==ENOENT
5958         or confess "install d/patches: $!";
5959
5960     changedir "work";
5961     commit_quilty_patch();
5962 }
5963
5964 sub quilt_need_fake_dsc ($) {
5965     # cwd should be playground
5966     my ($upstreamversion) = @_;
5967
5968     return if stat_exists "fake.dsc";
5969     # ^ OK to test this as a sentinel because if we created it
5970     # we must either have done the rest too, or crashed.
5971
5972     my $fakeversion="$upstreamversion-~~DGITFAKE";
5973
5974     my $fakedsc=new IO::File 'fake.dsc', '>' or confess "$!";
5975     print $fakedsc <<END or confess "$!";
5976 Format: 3.0 (quilt)
5977 Source: $package
5978 Version: $fakeversion
5979 Files:
5980 END
5981
5982     my $dscaddfile=sub {
5983         my ($leaf) = @_;
5984         
5985         my $md = new Digest::MD5;
5986
5987         my $fh = new IO::File $leaf, '<' or die "$leaf $!";
5988         stat $fh or confess "$!";
5989         my $size = -s _;
5990
5991         $md->addfile($fh);
5992         print $fakedsc " ".$md->hexdigest." $size $leaf\n" or confess "$!";
5993     };
5994
5995     unpack_playtree_linkorigs($upstreamversion, $dscaddfile);
5996
5997     my @files=qw(debian/source/format debian/rules
5998                  debian/control debian/changelog);
5999     foreach my $maybe (qw(debian/patches debian/source/options
6000                           debian/tests/control)) {
6001         next unless stat_exists "$maindir/$maybe";
6002         push @files, $maybe;
6003     }
6004
6005     my $debtar= srcfn $fakeversion,'.debian.tar.gz';
6006     runcmd qw(env GZIP=-1n tar -zcf), "./$debtar", qw(-C), $maindir, @files;
6007
6008     $dscaddfile->($debtar);
6009     close $fakedsc or confess "$!";
6010 }
6011
6012 sub quilt_fakedsc2unapplied ($$) {
6013     my ($headref, $upstreamversion) = @_;
6014     # must be run in the playground
6015     # quilt_need_fake_dsc must have been called
6016
6017     quilt_need_fake_dsc($upstreamversion);
6018     runcmd qw(sh -ec),
6019         'exec dpkg-source --no-check --skip-patches -x fake.dsc >/dev/null';
6020
6021     my $fakexdir= $package.'-'.(stripepoch $upstreamversion);
6022     rename $fakexdir, "fake" or die "$fakexdir $!";
6023
6024     changedir 'fake';
6025
6026     remove_stray_gits(__ "source package");
6027     mktree_in_ud_here();
6028
6029     rmtree '.pc';
6030
6031     rmtree 'debian'; # git checkout commitish paths does not delete!
6032     runcmd @git, qw(checkout -f), $headref, qw(-- debian);
6033     my $unapplied=git_add_write_tree();
6034     printdebug "fake orig tree object $unapplied\n";
6035     return $unapplied;
6036 }    
6037
6038 sub quilt_check_splitbrain_cache ($$) {
6039     my ($headref, $upstreamversion) = @_;
6040     # Called only if we are in (potentially) split brain mode.
6041     # Called in playground.
6042     # Computes the cache key and looks in the cache.
6043     # Returns ($dgit_view_commitid, $cachekey) or (undef, $cachekey)
6044
6045     quilt_need_fake_dsc($upstreamversion);
6046
6047     my $splitbrain_cachekey;
6048     
6049     progress f_
6050  "dgit: split brain (separate dgit view) may be needed (--quilt=%s).",
6051                 $quilt_mode;
6052     # we look in the reflog of dgit-intern/quilt-cache
6053     # we look for an entry whose message is the key for the cache lookup
6054     my @cachekey = (qw(dgit), $our_version);
6055     push @cachekey, $upstreamversion;
6056     push @cachekey, $quilt_mode;
6057     push @cachekey, $headref;
6058     push @cachekey, $quilt_upstream_commitish // '-';
6059
6060     push @cachekey, hashfile('fake.dsc');
6061
6062     my $srcshash = Digest::SHA->new(256);
6063     my %sfs = ( %INC, '$0(dgit)' => $0 );
6064     foreach my $sfk (sort keys %sfs) {
6065         next unless $sfk =~ m/^\$0\b/ || $sfk =~ m{^Debian/Dgit\b};
6066         $srcshash->add($sfk,"  ");
6067         $srcshash->add(hashfile($sfs{$sfk}));
6068         $srcshash->add("\n");
6069     }
6070     push @cachekey, $srcshash->hexdigest();
6071     $splitbrain_cachekey = "@cachekey";
6072
6073     printdebug "splitbrain cachekey $splitbrain_cachekey\n";
6074
6075     my $cachehit = reflog_cache_lookup
6076         "refs/$splitbraincache", $splitbrain_cachekey;
6077
6078     if ($cachehit) {
6079         unpack_playtree_need_cd_work($headref);
6080         my $saved = maybe_split_brain_save $headref, $cachehit, "cache-hit";
6081         if ($cachehit ne $headref) {
6082             progress f_ "dgit view: found cached (%s)", $saved;
6083             runcmd @git, qw(checkout -q -b dgit-view), $cachehit;
6084             $made_split_brain = 1;
6085             return ($cachehit, $splitbrain_cachekey);
6086         }
6087         progress __ "dgit view: found cached, no changes required";
6088         return ($headref, $splitbrain_cachekey);
6089     }
6090
6091     printdebug "splitbrain cache miss\n";
6092     return (undef, $splitbrain_cachekey);
6093 }
6094
6095 sub baredebian_origtarballs_scan ($$$) {
6096     my ($fakedfi, $upstreamversion, $dir) = @_;
6097     if (!opendir OD, $dir) {
6098         return if $! == ENOENT;
6099         fail "opendir $dir (origs): $!";
6100     }
6101
6102     while ($!=0, defined(my $leaf = readdir OD)) {
6103         {
6104             local ($debuglevel) = $debuglevel-1;
6105             printdebug "BDOS $dir $leaf ?\n";
6106         }
6107         next unless is_orig_file_of_vsn $leaf, $upstreamversion;
6108         next if grep { $_->{Filename} eq $leaf } @$fakedfi;
6109         push @$fakedfi, {
6110             Filename => $leaf,
6111             Path => "$dir/$leaf",
6112                         };
6113     }
6114
6115     die "$dir; $!" if $!;
6116     closedir OD;
6117 }
6118
6119 sub quilt_fixup_multipatch ($$$) {
6120     my ($clogp, $headref, $upstreamversion, $splitbrain_cachekey) = @_;
6121
6122     progress f_ "examining quilt state (multiple patches, %s mode)",
6123                 $quilt_mode;
6124
6125     # Our objective is:
6126     #  - honour any existing .pc in case it has any strangeness
6127     #  - determine the git commit corresponding to the tip of
6128     #    the patch stack (if there is one)
6129     #  - if there is such a git commit, convert each subsequent
6130     #    git commit into a quilt patch with dpkg-source --commit
6131     #  - otherwise convert all the differences in the tree into
6132     #    a single git commit
6133     #
6134     # To do this we:
6135
6136     # Our git tree doesn't necessarily contain .pc.  (Some versions of
6137     # dgit would include the .pc in the git tree.)  If there isn't
6138     # one, we need to generate one by unpacking the patches that we
6139     # have.
6140     #
6141     # We first look for a .pc in the git tree.  If there is one, we
6142     # will use it.  (This is not the normal case.)
6143     #
6144     # Otherwise need to regenerate .pc so that dpkg-source --commit
6145     # can work.  We do this as follows:
6146     #     1. Collect all relevant .orig from parent directory
6147     #     2. Generate a debian.tar.gz out of
6148     #         debian/{patches,rules,source/format,source/options}
6149     #     3. Generate a fake .dsc containing just these fields:
6150     #          Format Source Version Files
6151     #     4. Extract the fake .dsc
6152     #        Now the fake .dsc has a .pc directory.
6153     # (In fact we do this in every case, because in future we will
6154     # want to search for a good base commit for generating patches.)
6155     #
6156     # Then we can actually do the dpkg-source --commit
6157     #     1. Make a new working tree with the same object
6158     #        store as our main tree and check out the main
6159     #        tree's HEAD.
6160     #     2. Copy .pc from the fake's extraction, if necessary
6161     #     3. Run dpkg-source --commit
6162     #     4. If the result has changes to debian/, then
6163     #          - git add them them
6164     #          - git add .pc if we had a .pc in-tree
6165     #          - git commit
6166     #     5. If we had a .pc in-tree, delete it, and git commit
6167     #     6. Back in the main tree, fast forward to the new HEAD
6168
6169     # Another situation we may have to cope with is gbp-style
6170     # patches-unapplied trees.
6171     #
6172     # We would want to detect these, so we know to escape into
6173     # quilt_fixup_gbp.  However, this is in general not possible.
6174     # Consider a package with a one patch which the dgit user reverts
6175     # (with git revert or the moral equivalent).
6176     #
6177     # That is indistinguishable in contents from a patches-unapplied
6178     # tree.  And looking at the history to distinguish them is not
6179     # useful because the user might have made a confusing-looking git
6180     # history structure (which ought to produce an error if dgit can't
6181     # cope, not a silent reintroduction of an unwanted patch).
6182     #
6183     # So gbp users will have to pass an option.  But we can usually
6184     # detect their failure to do so: if the tree is not a clean
6185     # patches-applied tree, quilt linearisation fails, but the tree
6186     # _is_ a clean patches-unapplied tree, we can suggest that maybe
6187     # they want --quilt=unapplied.
6188     #
6189     # To help detect this, when we are extracting the fake dsc, we
6190     # first extract it with --skip-patches, and then apply the patches
6191     # afterwards with dpkg-source --before-build.  That lets us save a
6192     # tree object corresponding to .origs.
6193
6194     if ($quilt_mode eq 'linear'
6195         && branch_is_gdr($headref)) {
6196         # This is much faster.  It also makes patches that gdr
6197         # likes better for future updates without laundering.
6198         #
6199         # However, it can fail in some casses where we would
6200         # succeed: if there are existing patches, which correspond
6201         # to a prefix of the branch, but are not in gbp/gdr
6202         # format, gdr will fail (exiting status 7), but we might
6203         # be able to figure out where to start linearising.  That
6204         # will be slower so hopefully there's not much to do.
6205
6206         unpack_playtree_need_cd_work $headref;
6207
6208         my @cmd = (@git_debrebase,
6209                    qw(--noop-ok -funclean-mixed -funclean-ordering
6210                       make-patches --quiet-would-amend));
6211         # We tolerate soe snags that gdr wouldn't, by default.
6212         if (act_local()) {
6213             debugcmd "+",@cmd;
6214             $!=0; $?=-1;
6215             failedcmd @cmd
6216                 if system @cmd
6217                 and not ($? == 7*256 or
6218                          $? == -1 && $!==ENOENT);
6219         } else {
6220             dryrun_report @cmd;
6221         }
6222         $headref = git_rev_parse('HEAD');
6223
6224         chdir '..';
6225     }
6226
6227     my $unapplied=quilt_fakedsc2unapplied($headref, $upstreamversion);
6228
6229     ensuredir '.pc';
6230
6231     my @bbcmd = (qw(sh -ec), 'exec dpkg-source --before-build . >/dev/null');
6232     $!=0; $?=-1;
6233     if (system @bbcmd) {
6234         failedcmd @bbcmd if $? < 0;
6235         fail __ <<END;
6236 failed to apply your git tree's patch stack (from debian/patches/) to
6237  the corresponding upstream tarball(s).  Your source tree and .orig
6238  are probably too inconsistent.  dgit can only fix up certain kinds of
6239  anomaly (depending on the quilt mode).  Please see --quilt= in dgit(1).
6240 END
6241     }
6242
6243     changedir '..';
6244
6245     unpack_playtree_need_cd_work($headref);
6246
6247     my $mustdeletepc=0;
6248     if (stat_exists ".pc") {
6249         -d _ or die;
6250         progress __ "Tree already contains .pc - will use it then delete it.";
6251         $mustdeletepc=1;
6252     } else {
6253         rename '../fake/.pc','.pc' or confess "$!";
6254     }
6255
6256     changedir '../fake';
6257     rmtree '.pc';
6258     my $oldtiptree=git_add_write_tree();
6259     printdebug "fake o+d/p tree object $unapplied\n";
6260     changedir '../work';
6261
6262
6263     # We calculate some guesswork now about what kind of tree this might
6264     # be.  This is mostly for error reporting.
6265
6266     my $tentries = cmdoutput @git, qw(ls-tree --name-only -z), $headref;
6267     my $onlydebian = $tentries eq "debian\0";
6268
6269     my $uheadref = $headref;
6270     my $uhead_whatshort = 'HEAD';
6271
6272     if ($quilt_mode =~ m/baredebian\+tarball/) {
6273         # We need to make a tarball import.  Yuk.
6274         # We want to do this here so that we have a $uheadref value
6275
6276         my @fakedfi;
6277         baredebian_origtarballs_scan \@fakedfi, $upstreamversion, bpd_abs();
6278         baredebian_origtarballs_scan \@fakedfi, $upstreamversion,
6279             "$maindir/.." unless $buildproductsdir eq '..';
6280         changedir '..';
6281
6282         my @tartrees = import_tarball_tartrees $upstreamversion, \@fakedfi;
6283
6284         fail __ "baredebian quilt fixup: could not find any origs"
6285             unless @tartrees;
6286
6287         changedir 'work';
6288         my ($authline, $r1authline, $clogp,) =
6289             import_tarball_commits \@tartrees, $upstreamversion;
6290
6291         if (@tartrees == 1) {
6292             $uheadref = $tartrees[0]{Commit};
6293             # TRANSLATORS: this translation must fit in the ASCII art
6294             # quilt differences display.  The untranslated display
6295             # says %9.9s, so with that display it must be at most 9
6296             # characters.
6297             $uhead_whatshort = __ 'tarball';
6298         } else {
6299             # on .dsc import we do not make a separate commit, but
6300             # here we need to do so
6301             rm_subdir_cached '.';
6302             my $parents;
6303             foreach my $ti (@tartrees) {
6304                 my $c = $ti->{Commit};
6305                 if ($ti->{OrigPart} eq 'orig') {
6306                     runcmd qw(git read-tree), $c;
6307                 } elsif ($ti->{OrigPart} =~ m/orig-/) {
6308                     read_tree_subdir $', $c;
6309                 } else {
6310                     confess "$ti->OrigPart} ?"
6311                 }
6312                 $parents .= "parent $c\n";
6313             }
6314             my $tree = git_write_tree();
6315             my $mbody = f_ 'Combine orig tarballs for %s %s',
6316                 $package, $upstreamversion;
6317             $uheadref = hash_commit_text <<END;
6318 tree $tree
6319 ${parents}author $r1authline
6320 committer $r1authline
6321
6322 $mbody
6323
6324 [dgit import tarballs combine $package $upstreamversion]
6325 END
6326             # TRANSLATORS: this translation must fit in the ASCII art
6327             # quilt differences display.  The untranslated display
6328             # says %9.9s, so with that display it must be at most 9
6329             # characters.  This fragmentt is referring to multiple
6330             # orig tarballs in a source package.
6331             $uhead_whatshort = __ 'tarballs';
6332
6333             runcmd @git, qw(reset -q);
6334         }
6335         $quilt_upstream_commitish = $uheadref;
6336         $quilt_upstream_commitish_used = '*orig*';
6337         $quilt_upstream_commitish_message = '';
6338     }
6339     if ($quilt_mode =~ m/baredebian$/) {
6340         $uheadref = $quilt_upstream_commitish;
6341         # TRANSLATORS: this translation must fit in the ASCII art
6342         # quilt differences display.  The untranslated display
6343         # says %9.9s, so with that display it must be at most 9
6344         # characters.
6345         $uhead_whatshort = __ 'upstream';
6346     }
6347
6348     my %editedignores;
6349     my @unrepres;
6350     my $diffbits = {
6351         # H = user's HEAD
6352         # O = orig, without patches applied
6353         # A = "applied", ie orig with H's debian/patches applied
6354         O2H => quiltify_trees_differ($unapplied,$uheadref,   1,
6355                                      \%editedignores, \@unrepres),
6356         H2A => quiltify_trees_differ($uheadref, $oldtiptree,1),
6357         O2A => quiltify_trees_differ($unapplied,$oldtiptree,1),
6358     };
6359
6360     my @dl;
6361     foreach my $bits (qw(01 02)) {
6362         foreach my $v (qw(O2H O2A H2A)) {
6363             push @dl, ($diffbits->{$v} & $bits) ? '##' : '==';
6364         }
6365     }
6366     printdebug "differences \@dl @dl.\n";
6367
6368     progress f_
6369 "%s: base trees orig=%.20s o+d/p=%.20s",
6370               $us, $unapplied, $oldtiptree;
6371     # TRANSLATORS: Try to keep this ascii-art layout right.  The 0s in
6372     # %9.00009s will be ignored and are there to make the format the
6373     # same length (9 characters) as the output it generates.  If you
6374     # change the value 9, your translations of "upstream" and
6375     # 'tarball' must fit into the new length, and you should change
6376     # the number of 0s.  Do not reduce it below 4 as HEAD has to fit
6377     # too.
6378     progress f_
6379 "%s: quilt differences: src:  %s orig %s     gitignores:  %s orig %s\n".
6380 "%s: quilt differences: %9.00009s %s o+d/p          %9.00009s %s o+d/p",
6381   $us,                      $dl[0], $dl[1],              $dl[3], $dl[4],
6382   $us,        $uhead_whatshort, $dl[2],   $uhead_whatshort, $dl[5];
6383
6384     if (@unrepres && $quilt_mode !~ m/baredebian/) {
6385         # With baredebian, even if the upstream commitish has this
6386         # problem, we don't want to print this message, as nothing
6387         # is going to try to make a patch out of it anyway.
6388         print STDERR f_ "dgit:  cannot represent change: %s: %s\n",
6389                         $_->[1], $_->[0]
6390             foreach @unrepres;
6391         forceable_fail [qw(unrepresentable)], __ <<END;
6392 HEAD has changes to .orig[s] which are not representable by `3.0 (quilt)'
6393 END
6394     }
6395
6396     my @failsuggestion;
6397     if ($onlydebian) {
6398         push @failsuggestion, [ 'onlydebian', __
6399  "This has only a debian/ directory; you probably want --quilt=bare debian." ]
6400             unless $quilt_mode =~ m/baredebian/;
6401     } elsif (!($diffbits->{O2H} & $diffbits->{O2A})) {
6402         push @failsuggestion, [ 'unapplied', __
6403  "This might be a patches-unapplied branch." ];
6404     } elsif (!($diffbits->{H2A} & $diffbits->{O2A})) {
6405         push @failsuggestion, [ 'applied', __
6406  "This might be a patches-applied branch." ];
6407     }
6408     push @failsuggestion, [ 'quilt-mode', __
6409  "Maybe you need one of --[quilt=]gbp --[quilt=]dpm --quilt=unapplied ?" ];
6410
6411     push @failsuggestion, [ 'gitattrs', __
6412  "Warning: Tree has .gitattributes.  See GITATTRIBUTES in dgit(7)." ]
6413         if stat_exists '.gitattributes';
6414
6415     push @failsuggestion, [ 'origs', __
6416  "Maybe orig tarball(s) are not identical to git representation?" ]
6417         unless $onlydebian && $quilt_mode !~ m/baredebian/;
6418                # ^ in that case, we didn't really look properly
6419
6420     if (quiltmode_splitting()) {
6421         quiltify_splitting($clogp, $unapplied, $headref, $oldtiptree,
6422                            $diffbits, \%editedignores,
6423                            $splitbrain_cachekey);
6424         return;
6425     }
6426
6427     progress f_ "starting quiltify (multiple patches, %s mode)", $quilt_mode;
6428     quiltify($clogp,$headref,$oldtiptree,\@failsuggestion);
6429     runcmd @git, qw(checkout -q), (qw(master dgit-view)[do_split_brain()]);
6430
6431     if (!open P, '>>', ".pc/applied-patches") {
6432         $!==&ENOENT or confess "$!";
6433     } else {
6434         close P;
6435     }
6436
6437     commit_quilty_patch();
6438
6439     if ($mustdeletepc) {
6440         quilt_fixup_delete_pc();
6441     }
6442 }
6443
6444 sub quilt_fixup_editor () {
6445     my $descfn = $ENV{$fakeeditorenv};
6446     my $editing = $ARGV[$#ARGV];
6447     open I1, '<', $descfn or confess "$descfn: $!";
6448     open I2, '<', $editing or confess "$editing: $!";
6449     unlink $editing or confess "$editing: $!";
6450     open O, '>', $editing or confess "$editing: $!";
6451     while (<I1>) { print O or confess "$!"; } I1->error and confess "$!";
6452     my $copying = 0;
6453     while (<I2>) {
6454         $copying ||= m/^\-\-\- /;
6455         next unless $copying;
6456         print O or confess "$!";
6457     }
6458     I2->error and confess "$!";
6459     close O or die $1;
6460     finish 0;
6461 }
6462
6463 sub maybe_apply_patches_dirtily () {
6464     return unless $quilt_mode =~ m/gbp|unapplied|baredebian/;
6465     print STDERR __ <<END or confess "$!";
6466
6467 dgit: Building, or cleaning with rules target, in patches-unapplied tree.
6468 dgit: Have to apply the patches - making the tree dirty.
6469 dgit: (Consider specifying --clean=git and (or) using dgit sbuild.)
6470
6471 END
6472     $patches_applied_dirtily = 01;
6473     $patches_applied_dirtily |= 02 unless stat_exists '.pc';
6474     runcmd qw(dpkg-source --before-build .);
6475 }
6476
6477 sub maybe_unapply_patches_again () {
6478     progress __ "dgit: Unapplying patches again to tidy up the tree."
6479         if $patches_applied_dirtily;
6480     runcmd qw(dpkg-source --after-build .)
6481         if $patches_applied_dirtily & 01;
6482     rmtree '.pc'
6483         if $patches_applied_dirtily & 02;
6484     $patches_applied_dirtily = 0;
6485 }
6486
6487 #----- other building -----
6488
6489 sub clean_tree_check_git ($$$) {
6490     my ($honour_ignores, $message, $ignmessage) = @_;
6491     my @cmd = (@git, qw(clean -dn));
6492     push @cmd, qw(-x) unless $honour_ignores;
6493     my $leftovers = cmdoutput @cmd;
6494     if (length $leftovers) {
6495         print STDERR $leftovers, "\n" or confess "$!";
6496         $message .= $ignmessage if $honour_ignores;
6497         fail $message;
6498     }
6499 }
6500
6501 sub clean_tree_check_git_wd ($) {
6502     my ($message) = @_;
6503     return if $cleanmode =~ m{no-check};
6504     return if $patches_applied_dirtily; # yuk
6505     clean_tree_check_git +($cleanmode !~ m{all-check}),
6506         $message, "\n".__ <<END;
6507 If this is just missing .gitignore entries, use a different clean
6508 mode, eg --clean=dpkg-source,no-check (-wdn/-wddn) to ignore them
6509 or --clean=git (-wg/-wgf) to use \`git clean' instead.
6510 END
6511 }
6512
6513 sub clean_tree_check () {
6514     # This function needs to not care about modified but tracked files.
6515     # That was done by check_not_dirty, and by now we may have run
6516     # the rules clean target which might modify tracked files (!)
6517     if ($cleanmode =~ m{^check}) {
6518         clean_tree_check_git +($cleanmode =~ m{ignores}), __
6519  "tree contains uncommitted files and --clean=check specified", '';
6520     } elsif ($cleanmode =~ m{^dpkg-source}) {
6521         clean_tree_check_git_wd __
6522  "tree contains uncommitted files (NB dgit didn't run rules clean)";
6523     } elsif ($cleanmode =~ m{^git}) {
6524         clean_tree_check_git 1, __
6525  "tree contains uncommited, untracked, unignored files\n".
6526  "You can use --clean=git[-ff],always (-wga/-wgfa) to delete them.", '';
6527     } elsif ($cleanmode eq 'none') {
6528     } else {
6529         confess "$cleanmode ?";
6530     }
6531 }
6532
6533 sub clean_tree () {
6534     # We always clean the tree ourselves, rather than leave it to the
6535     # builder (dpkg-source, or soemthing which calls dpkg-source).
6536     if ($quilt_mode =~ m/baredebian/ and $cleanmode =~ m/git/) {
6537         fail f_ <<END, $quilt_mode, $cleanmode;
6538 quilt mode %s (generally needs untracked upstream files)
6539 contradicts clean mode %s (which would delete them)
6540 END
6541         # This is not 100% true: dgit build-source and push-source
6542         # (for example) could operate just fine with no upstream
6543         # source in the working tree.  But it doesn't seem likely that
6544         # the user wants dgit to proactively delete such things.
6545         # -wn, for example, would produce identical output without
6546         # deleting anything from the working tree.
6547     }
6548     if ($cleanmode =~ m{^dpkg-source}) {
6549         my @cmd = @dpkgbuildpackage;
6550         push @cmd, qw(-d) if $cleanmode =~ m{^dpkg-source-d};
6551         push @cmd, qw(-T clean);
6552         maybe_apply_patches_dirtily();
6553         runcmd_ordryrun_local @cmd;
6554         clean_tree_check_git_wd __
6555  "tree contains uncommitted files (after running rules clean)";
6556     } elsif ($cleanmode =~ m{^git(?!-)}) {
6557         runcmd_ordryrun_local @git, qw(clean -xdf);
6558     } elsif ($cleanmode =~ m{^git-ff}) {
6559         runcmd_ordryrun_local @git, qw(clean -xdff);
6560     } elsif ($cleanmode =~ m{^check}) {
6561         clean_tree_check();
6562     } elsif ($cleanmode eq 'none') {
6563     } else {
6564         confess "$cleanmode ?";
6565     }
6566 }
6567
6568 sub cmd_clean () {
6569     badusage __ "clean takes no additional arguments" if @ARGV;
6570     notpushing();
6571     clean_tree();
6572     maybe_unapply_patches_again();
6573 }
6574
6575 # return values from massage_dbp_args are one or both of these flags
6576 sub WANTSRC_SOURCE  () { 01; } # caller should build source (separately)
6577 sub WANTSRC_BUILDER () { 02; } # caller should run dpkg-buildpackage
6578
6579 sub build_or_push_prep_early () {
6580     our $build_or_push_prep_early_done //= 0;
6581     return if $build_or_push_prep_early_done++;
6582     my $clogp = parsechangelog();
6583     $isuite = getfield $clogp, 'Distribution';
6584     my $gotpackage = getfield $clogp, 'Source';
6585     $version = getfield $clogp, 'Version';
6586     $package //= $gotpackage;
6587     if ($package ne $gotpackage) {
6588         fail f_ "-p specified package %s, but changelog says %s",
6589             $package, $gotpackage;
6590     }
6591     $dscfn = dscfn($version);
6592 }
6593
6594 sub build_or_push_prep_modes () {
6595     my ($format) = get_source_format();
6596     determine_whether_split_brain($format);
6597
6598     fail __ "dgit: --include-dirty is not supported with split view".
6599             " (including with view-splitting quilt modes)"
6600         if do_split_brain() && $includedirty;
6601
6602     if (madformat_wantfixup $format and $quilt_mode =~ m/baredebian$/) {
6603         ($quilt_upstream_commitish, $quilt_upstream_commitish_used,
6604          $quilt_upstream_commitish_message)
6605             = resolve_upstream_version
6606             $quilt_upstream_commitish, upstreamversion $version;
6607         progress f_ "dgit: --quilt=%s, %s", $quilt_mode,
6608             $quilt_upstream_commitish_message;
6609     } elsif (defined $quilt_upstream_commitish) {
6610         fail __
6611  "dgit: --upstream-commitish only makes sense with --quilt=baredebian"
6612     }
6613 }
6614
6615 sub build_prep_early () {
6616     build_or_push_prep_early();
6617     notpushing();
6618     build_or_push_prep_modes();
6619     check_not_dirty();
6620 }
6621
6622 sub build_prep ($) {
6623     my ($wantsrc) = @_;
6624     build_prep_early();
6625     check_bpd_exists();
6626     if (!building_source_in_playtree() || ($wantsrc & WANTSRC_BUILDER)
6627         # Clean the tree because we're going to use the contents of
6628         # $maindir.  (We trying to include dirty changes in the source
6629         # package, or we are running the builder in $maindir.)
6630         || $cleanmode =~ m{always}) {
6631         # Or because the user asked us to.
6632         clean_tree();
6633     } else {
6634         # We don't actually need to do anything in $maindir, but we
6635         # should do some kind of cleanliness check because (i) the
6636         # user may have forgotten a `git add', and (ii) if the user
6637         # said -wc we should still do the check.
6638         clean_tree_check();
6639     }
6640     build_check_quilt_splitbrain();
6641     if ($rmchanges) {
6642         my $pat = changespat $version;
6643         foreach my $f (glob "$buildproductsdir/$pat") {
6644             if (act_local()) {
6645                 unlink $f or
6646                     fail f_ "remove old changes file %s: %s", $f, $!;
6647             } else {
6648                 progress f_ "would remove %s", $f;
6649             }
6650         }
6651     }
6652 }
6653
6654 sub changesopts_initial () {
6655     my @opts =@changesopts[1..$#changesopts];
6656 }
6657
6658 sub changesopts_version () {
6659     if (!defined $changes_since_version) {
6660         my @vsns;
6661         unless (eval {
6662             @vsns = archive_query('archive_query');
6663             my @quirk = access_quirk();
6664             if ($quirk[0] eq 'backports') {
6665                 local $isuite = $quirk[2];
6666                 local $csuite;
6667                 canonicalise_suite();
6668                 push @vsns, archive_query('archive_query');
6669             }
6670             1;
6671         }) {
6672             print STDERR $@;
6673             fail __
6674  "archive query failed (queried because --since-version not specified)";
6675         }
6676         if (@vsns) {
6677             @vsns = map { $_->[0] } @vsns;
6678             @vsns = sort { -version_compare($a, $b) } @vsns;
6679             $changes_since_version = $vsns[0];
6680             progress f_ "changelog will contain changes since %s", $vsns[0];
6681         } else {
6682             $changes_since_version = '_';
6683             progress __ "package seems new, not specifying -v<version>";
6684         }
6685     }
6686     if ($changes_since_version ne '_') {
6687         return ("-v$changes_since_version");
6688     } else {
6689         return ();
6690     }
6691 }
6692
6693 sub changesopts () {
6694     return (changesopts_initial(), changesopts_version());
6695 }
6696
6697 sub massage_dbp_args ($;$) {
6698     my ($cmd,$xargs) = @_;
6699     # Since we split the source build out so we can do strange things
6700     # to it, massage the arguments to dpkg-buildpackage so that the
6701     # main build doessn't build source (or add an argument to stop it
6702     # building source by default).
6703     debugcmd '#massaging#', @$cmd if $debuglevel>1;
6704     # -nc has the side effect of specifying -b if nothing else specified
6705     # and some combinations of -S, -b, et al, are errors, rather than
6706     # later simply overriding earlie.  So we need to:
6707     #  - search the command line for these options
6708     #  - pick the last one
6709     #  - perhaps add our own as a default
6710     #  - perhaps adjust it to the corresponding non-source-building version
6711     my $dmode = '-F';
6712     foreach my $l ($cmd, $xargs) {
6713         next unless $l;
6714         @$l = grep { !(m/^-[SgGFABb]$|^--build=/s and $dmode=$_) } @$l;
6715     }
6716     push @$cmd, '-nc';
6717 #print STDERR "MASS1 ",Dumper($cmd, $xargs, $dmode);
6718     my $r = WANTSRC_BUILDER;
6719     printdebug "massage split $dmode.\n";
6720     if ($dmode =~ s/^--build=//) {
6721         $r = 0;
6722         my @d = split /,/, $dmode;
6723         $r |= WANTSRC_SOURCE  if grep { s/^full$/binary/ } @d;
6724         $r |= WANTSRC_SOURCE  if grep { s/^source$// } @d;
6725         $r |= WANTSRC_BUILDER if grep { m/./ } @d;
6726         fail __ "Wanted to build nothing!" unless $r;
6727         $dmode = '--build='. join ',', grep m/./, @d;
6728     } else {
6729         $r =
6730           $dmode =~ m/[S]/     ?  WANTSRC_SOURCE :
6731           $dmode =~ y/gGF/ABb/ ?  WANTSRC_SOURCE | WANTSRC_BUILDER :
6732           $dmode =~ m/[ABb]/   ?                   WANTSRC_BUILDER :
6733           confess "$dmode ?";
6734     }
6735     printdebug "massage done $r $dmode.\n";
6736     push @$cmd, $dmode;
6737 #print STDERR "MASS2 ",Dumper($cmd, $xargs, $r);
6738     return $r;
6739 }
6740
6741 sub in_bpd (&) {
6742     my ($fn) = @_;
6743     my $wasdir = must_getcwd();
6744     changedir $buildproductsdir;
6745     $fn->();
6746     changedir $wasdir;
6747 }    
6748
6749 # this sub must run with CWD=$buildproductsdir (eg in in_bpd)
6750 sub postbuild_mergechanges ($) {
6751     my ($msg_if_onlyone) = @_;
6752     # If there is only one .changes file, fail with $msg_if_onlyone,
6753     # or if that is undef, be a no-op.
6754     # Returns the changes file to report to the user.
6755     my $pat = changespat $version;
6756     my @changesfiles = grep { !m/_multi\.changes/ } glob $pat;
6757     @changesfiles = sort {
6758         ($b =~ m/_source\.changes$/ <=> $a =~ m/_source\.changes$/)
6759             or $a cmp $b
6760     } @changesfiles;
6761     my $result;
6762     if (@changesfiles==1) {
6763         fail +(f_ <<END, "@changesfiles").$msg_if_onlyone
6764 only one changes file from build (%s)
6765 END
6766             if defined $msg_if_onlyone;
6767         $result = $changesfiles[0];
6768     } elsif (@changesfiles==2) {
6769         my $binchanges = parsecontrol($changesfiles[1], "binary changes file");
6770         foreach my $l (split /\n/, getfield $binchanges, 'Files') {
6771             fail f_ "%s found in binaries changes file %s", $l, $binchanges
6772                 if $l =~ m/\.dsc$/;
6773         }
6774         runcmd_ordryrun_local @mergechanges, @changesfiles;
6775         my $multichanges = changespat $version,'multi';
6776         if (act_local()) {
6777             stat_exists $multichanges or fail f_
6778                 "%s unexpectedly not created by build", $multichanges;
6779             foreach my $cf (glob $pat) {
6780                 next if $cf eq $multichanges;
6781                 rename "$cf", "$cf.inmulti" or fail f_
6782                     "install new changes %s\{,.inmulti}: %s", $cf, $!;
6783             }
6784         }
6785         $result = $multichanges;
6786     } else {
6787         fail f_ "wrong number of different changes files (%s)",
6788                 "@changesfiles";
6789     }
6790     printdone f_ "build successful, results in %s\n", $result
6791         or confess "$!";
6792 }
6793
6794 sub midbuild_checkchanges () {
6795     my $pat = changespat $version;
6796     return if $rmchanges;
6797     my @unwanted = map { s#.*/##; $_; } glob "$bpd_glob/$pat";
6798     @unwanted = grep {
6799         $_ ne changespat $version,'source' and
6800         $_ ne changespat $version,'multi'
6801     } @unwanted;
6802     fail +(f_ <<END, $pat, "@unwanted")
6803 changes files other than source matching %s already present; building would result in ambiguity about the intended results.
6804 Suggest you delete %s.
6805 END
6806         if @unwanted;
6807 }
6808
6809 sub midbuild_checkchanges_vanilla ($) {
6810     my ($wantsrc) = @_;
6811     midbuild_checkchanges() if $wantsrc == (WANTSRC_SOURCE|WANTSRC_BUILDER);
6812 }
6813
6814 sub postbuild_mergechanges_vanilla ($) {
6815     my ($wantsrc) = @_;
6816     if ($wantsrc == (WANTSRC_SOURCE|WANTSRC_BUILDER)) {
6817         in_bpd {
6818             postbuild_mergechanges(undef);
6819         };
6820     } else {
6821         printdone __ "build successful\n";
6822     }
6823 }
6824
6825 sub cmd_build {
6826     build_prep_early();
6827     $buildproductsdir eq '..' or print STDERR +(f_ <<END, $us, $us);
6828 %s: warning: build-products-dir set, but not supported by dpkg-buildpackage
6829 %s: warning: build-products-dir will be ignored; files will go to ..
6830 END
6831     $buildproductsdir = '..';
6832     my @dbp = (@dpkgbuildpackage, qw(-us -uc), changesopts_initial(), @ARGV);
6833     my $wantsrc = massage_dbp_args \@dbp;
6834     build_prep($wantsrc);
6835     if ($wantsrc & WANTSRC_SOURCE) {
6836         build_source();
6837         midbuild_checkchanges_vanilla $wantsrc;
6838     }
6839     if ($wantsrc & WANTSRC_BUILDER) {
6840         push @dbp, changesopts_version();
6841         maybe_apply_patches_dirtily();
6842         runcmd_ordryrun_local @dbp;
6843     }
6844     maybe_unapply_patches_again();
6845     postbuild_mergechanges_vanilla $wantsrc;
6846 }
6847
6848 sub pre_gbp_build {
6849     $quilt_mode //= 'gbp';
6850 }
6851
6852 sub cmd_gbp_build {
6853     build_prep_early();
6854
6855     # gbp can make .origs out of thin air.  In my tests it does this
6856     # even for a 1.0 format package, with no origs present.  So I
6857     # guess it keys off just the version number.  We don't know
6858     # exactly what .origs ought to exist, but let's assume that we
6859     # should run gbp if: the version has an upstream part and the main
6860     # orig is absent.
6861     my $upstreamversion = upstreamversion $version;
6862     my $origfnpat = srcfn $upstreamversion, '.orig.tar.*';
6863     my $gbp_make_orig = $version =~ m/-/ && !(() = glob "$bpd_glob/$origfnpat");
6864
6865     if ($gbp_make_orig) {
6866         clean_tree();
6867         $cleanmode = 'none'; # don't do it again
6868     }
6869
6870     my @dbp = @dpkgbuildpackage;
6871
6872     my $wantsrc = massage_dbp_args \@dbp, \@ARGV;
6873
6874     if (!length $gbp_build[0]) {
6875         if (length executable_on_path('git-buildpackage')) {
6876             $gbp_build[0] = qw(git-buildpackage);
6877         } else {
6878             $gbp_build[0] = 'gbp buildpackage';
6879         }
6880     }
6881     my @cmd = opts_opt_multi_cmd [], @gbp_build;
6882
6883     push @cmd, (qw(-us -uc --git-no-sign-tags),
6884                 "--git-builder=".(shellquote @dbp));
6885
6886     if ($gbp_make_orig) {
6887         my $priv = dgit_privdir();
6888         my $ok = "$priv/origs-gen-ok";
6889         unlink $ok or $!==&ENOENT or confess "$!";
6890         my @origs_cmd = @cmd;
6891         push @origs_cmd, qw(--git-cleaner=true);
6892         push @origs_cmd, "--git-prebuild=".
6893             "touch ".(shellquote $ok)." ".(shellquote "$priv/no-such-dir/ok");
6894         push @origs_cmd, @ARGV;
6895         if (act_local()) {
6896             debugcmd @origs_cmd;
6897             system @origs_cmd;
6898             do { local $!; stat_exists $ok; }
6899                 or failedcmd @origs_cmd;
6900         } else {
6901             dryrun_report @origs_cmd;
6902         }
6903     }
6904
6905     build_prep($wantsrc);
6906     if ($wantsrc & WANTSRC_SOURCE) {
6907         build_source();
6908         midbuild_checkchanges_vanilla $wantsrc;
6909     } else {
6910         push @cmd, '--git-cleaner=true';
6911     }
6912     maybe_unapply_patches_again();
6913     if ($wantsrc & WANTSRC_BUILDER) {
6914         push @cmd, changesopts();
6915         runcmd_ordryrun_local @cmd, @ARGV;
6916     }
6917     postbuild_mergechanges_vanilla $wantsrc;
6918 }
6919 sub cmd_git_build { cmd_gbp_build(); } # compatibility with <= 1.0
6920
6921 sub building_source_in_playtree {
6922     # If $includedirty, we have to build the source package from the
6923     # working tree, not a playtree, so that uncommitted changes are
6924     # included (copying or hardlinking them into the playtree could
6925     # cause trouble).
6926     #
6927     # Note that if we are building a source package in split brain
6928     # mode we do not support including uncommitted changes, because
6929     # that makes quilt fixup too hard.  I.e. ($made_split_brain && (dgit is
6930     # building a source package)) => !$includedirty
6931     return !$includedirty;
6932 }
6933
6934 sub build_source {
6935     $sourcechanges = changespat $version,'source';
6936     if (act_local()) {
6937         unlink "$buildproductsdir/$sourcechanges" or $!==ENOENT
6938             or fail f_ "remove %s: %s", $sourcechanges, $!;
6939     }
6940 #    confess unless !!$made_split_brain == do_split_brain();
6941
6942     my @cmd = (@dpkgsource, qw(-b --));
6943     my $leafdir;
6944     if (building_source_in_playtree()) {
6945         $leafdir = 'work';
6946         my $headref = git_rev_parse('HEAD');
6947         # If we are in split brain, there is already a playtree with
6948         # the thing we should package into a .dsc (thanks to quilt
6949         # fixup).  If not, make a playtree
6950         prep_ud() unless $made_split_brain;
6951         changedir $playground;
6952         unless ($made_split_brain) {
6953             my $upstreamversion = upstreamversion $version;
6954             unpack_playtree_linkorigs($upstreamversion, sub { });
6955             unpack_playtree_need_cd_work($headref);
6956             changedir '..';
6957         }
6958     } else {
6959         $leafdir = basename $maindir;
6960
6961         if ($buildproductsdir ne '..') {
6962             # Well, we are going to run dpkg-source -b which consumes
6963             # origs from .. and generates output there.  To make this
6964             # work when the bpd is not .. , we would have to (i) link
6965             # origs from bpd to .. , (ii) check for files that
6966             # dpkg-source -b would/might overwrite, and afterwards
6967             # (iii) move all the outputs back to the bpd (iv) except
6968             # for the origs which should be deleted from .. if they
6969             # weren't there beforehand.  And if there is an error and
6970             # we don't run to completion we would necessarily leave a
6971             # mess.  This is too much.  The real way to fix this
6972             # is for dpkg-source to have bpd support.
6973             confess unless $includedirty;
6974             fail __
6975  "--include-dirty not supported with --build-products-dir, sorry";
6976         }
6977
6978         changedir '..';
6979     }
6980     runcmd_ordryrun_local @cmd, $leafdir;
6981
6982     changedir $leafdir;
6983     runcmd_ordryrun_local qw(sh -ec),
6984       'exec >../$1; shift; exec "$@"','x', $sourcechanges,
6985       @dpkggenchanges, qw(-S), changesopts();
6986     changedir '..';
6987
6988     printdebug "moving $dscfn, $sourcechanges, etc. to ".bpd_abs()."\n";
6989     $dsc = parsecontrol($dscfn, "source package");
6990
6991     my $mv = sub {
6992         my ($why, $l) = @_;
6993         printdebug " renaming ($why) $l\n";
6994         rename_link_xf 0, "$l", bpd_abs()."/$l"
6995             or fail f_ "put in place new built file (%s): %s", $l, $@;
6996     };
6997     foreach my $l (split /\n/, getfield $dsc, 'Files') {
6998         $l =~ m/\S+$/ or next;
6999         $mv->('Files', $&);
7000     }
7001     $mv->('dsc', $dscfn);
7002     $mv->('changes', $sourcechanges);
7003
7004     changedir $maindir;
7005 }
7006
7007 sub cmd_build_source {
7008     badusage __ "build-source takes no additional arguments" if @ARGV;
7009     build_prep(WANTSRC_SOURCE);
7010     build_source();
7011     maybe_unapply_patches_again();
7012     printdone f_ "source built, results in %s and %s",
7013                  $dscfn, $sourcechanges;
7014 }
7015
7016 sub cmd_push_source {
7017     prep_push();
7018     fail __
7019         "dgit push-source: --include-dirty/--ignore-dirty does not make".
7020         "sense with push-source!"
7021         if $includedirty;
7022     build_check_quilt_splitbrain();
7023     if ($changesfile) {
7024         my $changes = parsecontrol("$buildproductsdir/$changesfile",
7025                                    __ "source changes file");
7026         unless (test_source_only_changes($changes)) {
7027             fail __ "user-specified changes file is not source-only";
7028         }
7029     } else {
7030         # Building a source package is very fast, so just do it
7031         build_source();
7032         confess "er, patches are applied dirtily but shouldn't be.."
7033             if $patches_applied_dirtily;
7034         $changesfile = $sourcechanges;
7035     }
7036     dopush();
7037 }
7038
7039 sub binary_builder {
7040     my ($bbuilder, $pbmc_msg, @args) = @_;
7041     build_prep(WANTSRC_SOURCE);
7042     build_source();
7043     midbuild_checkchanges();
7044     in_bpd {
7045         if (act_local()) {
7046             stat_exists $dscfn or fail f_
7047                 "%s (in build products dir): %s", $dscfn, $!;
7048             stat_exists $sourcechanges or fail f_
7049                 "%s (in build products dir): %s", $sourcechanges, $!;
7050         }
7051         runcmd_ordryrun_local @$bbuilder, @args;
7052     };
7053     maybe_unapply_patches_again();
7054     in_bpd {
7055         postbuild_mergechanges($pbmc_msg);
7056     };
7057 }
7058
7059 sub cmd_sbuild {
7060     build_prep_early();
7061     binary_builder(\@sbuild, (__ <<END), qw(-d), $isuite, @ARGV, $dscfn);
7062 perhaps you need to pass -A ?  (sbuild's default is to build only
7063 arch-specific binaries; dgit 1.4 used to override that.)
7064 END
7065 }
7066
7067 sub pbuilder ($) {
7068     my ($pbuilder) = @_;
7069     build_prep_early();
7070     # @ARGV is allowed to contain only things that should be passed to
7071     # pbuilder under debbuildopts; just massage those
7072     my $wantsrc = massage_dbp_args \@ARGV;
7073     fail __
7074         "you asked for a builder but your debbuildopts didn't ask for".
7075         " any binaries -- is this really what you meant?"
7076         unless $wantsrc & WANTSRC_BUILDER;
7077     fail __
7078         "we must build a .dsc to pass to the builder but your debbuiltopts".
7079         " forbids the building of a source package; cannot continue"
7080       unless $wantsrc & WANTSRC_SOURCE;
7081     # We do not want to include the verb "build" in @pbuilder because
7082     # the user can customise @pbuilder and they shouldn't be required
7083     # to include "build" in their customised value.  However, if the
7084     # user passes any additional args to pbuilder using the dgit
7085     # option --pbuilder:foo, such args need to come after the "build"
7086     # verb.  opts_opt_multi_cmd does all of that.
7087     binary_builder([opts_opt_multi_cmd ["build"], @$pbuilder], undef,
7088                    qw(--debbuildopts), "@ARGV", qw(--distribution), $isuite,
7089                    $dscfn);
7090 }
7091
7092 sub cmd_pbuilder {
7093     pbuilder(\@pbuilder);
7094 }
7095
7096 sub cmd_cowbuilder {
7097     pbuilder(\@cowbuilder);
7098 }
7099
7100 sub cmd_quilt_fixup {
7101     badusage "incorrect arguments to dgit quilt-fixup" if @ARGV;
7102     build_prep_early();
7103     clean_tree();
7104     build_maybe_quilt_fixup();
7105 }
7106
7107 sub cmd_print_unapplied_treeish {
7108     badusage __ "incorrect arguments to dgit print-unapplied-treeish"
7109         if @ARGV;
7110     my $headref = git_rev_parse('HEAD');
7111     my $clogp = commit_getclogp $headref;
7112     $package = getfield $clogp, 'Source';
7113     $version = getfield $clogp, 'Version';
7114     $isuite = getfield $clogp, 'Distribution';
7115     $csuite = $isuite; # we want this to be offline!
7116     notpushing();
7117
7118     prep_ud();
7119     changedir $playground;
7120     my $uv = upstreamversion $version;
7121     my $u = quilt_fakedsc2unapplied($headref, $uv);
7122     print $u, "\n" or confess "$!";
7123 }
7124
7125 sub import_dsc_result {
7126     my ($dstref, $newhash, $what_log, $what_msg) = @_;
7127     my @cmd = (git_update_ref_cmd $what_log, $dstref, $newhash);
7128     runcmd @cmd;
7129     check_gitattrs($newhash, __ "source tree");
7130
7131     progress f_ "dgit: import-dsc: %s", $what_msg;
7132 }
7133
7134 sub cmd_import_dsc {
7135     my $needsig = 0;
7136
7137     while (@ARGV) {
7138         last unless $ARGV[0] =~ m/^-/;
7139         $_ = shift @ARGV;
7140         last if m/^--?$/;
7141         if (m/^--require-valid-signature$/) {
7142             $needsig = 1;
7143         } else {
7144             badusage f_ "unknown dgit import-dsc sub-option \`%s'", $_;
7145         }
7146     }
7147
7148     badusage __ "usage: dgit import-dsc .../PATH/TO/.DSC BRANCH"
7149         unless @ARGV==2;
7150     my ($dscfn, $dstbranch) = @ARGV;
7151
7152     badusage __ "dry run makes no sense with import-dsc"
7153         unless act_local();
7154
7155     my $force = $dstbranch =~ s/^\+//   ? +1 :
7156                 $dstbranch =~ s/^\.\.// ? -1 :
7157                                            0;
7158     my $info = $force ? " $&" : '';
7159     $info = "$dscfn$info";
7160
7161     my $specbranch = $dstbranch;
7162     $dstbranch = "refs/heads/$dstbranch" unless $dstbranch =~ m#^refs/#;
7163     $dstbranch = cmdoutput @git, qw(check-ref-format --normalize), $dstbranch;
7164
7165     my @symcmd = (@git, qw(symbolic-ref -q HEAD));
7166     my $chead = cmdoutput_errok @symcmd;
7167     defined $chead or $?==256 or failedcmd @symcmd;
7168
7169     fail f_ "%s is checked out - will not update it", $dstbranch
7170         if defined $chead and $chead eq $dstbranch;
7171
7172     my $oldhash = git_get_ref $dstbranch;
7173
7174     open D, "<", $dscfn or fail f_ "open import .dsc (%s): %s", $dscfn, $!;
7175     $dscdata = do { local $/ = undef; <D>; };
7176     D->error and fail f_ "read %s: %s", $dscfn, $!;
7177     close C;
7178
7179     # we don't normally need this so import it here
7180     use Dpkg::Source::Package;
7181     my $dp = new Dpkg::Source::Package filename => $dscfn,
7182         require_valid_signature => $needsig;
7183     {
7184         local $SIG{__WARN__} = sub {
7185             print STDERR $_[0];
7186             return unless $needsig;
7187             fail __ "import-dsc signature check failed";
7188         };
7189         if (!$dp->is_signed()) {
7190             warn f_ "%s: warning: importing unsigned .dsc\n", $us;
7191         } else {
7192             my $r = $dp->check_signature();
7193             confess "->check_signature => $r" if $needsig && $r;
7194         }
7195     }
7196
7197     parse_dscdata();
7198
7199     $package = getfield $dsc, 'Source';
7200
7201     parse_dsc_field($dsc, __ "Dgit metadata in .dsc")
7202         unless forceing [qw(import-dsc-with-dgit-field)];
7203     parse_dsc_field_def_dsc_distro();
7204
7205     $isuite = 'DGIT-IMPORT-DSC';
7206     $idistro //= $dsc_distro;
7207
7208     notpushing();
7209
7210     if (defined $dsc_hash) {
7211         progress __
7212             "dgit: import-dsc of .dsc with Dgit field, using git hash";
7213         resolve_dsc_field_commit undef, undef;
7214     }
7215     if (defined $dsc_hash) {
7216         my @cmd = (qw(sh -ec),
7217                    "echo $dsc_hash | git cat-file --batch-check");
7218         my $objgot = cmdoutput @cmd;
7219         if ($objgot =~ m#^\w+ missing\b#) {
7220             fail f_ <<END, $dsc_hash
7221 .dsc contains Dgit field referring to object %s
7222 Your git tree does not have that object.  Try `git fetch' from a
7223 plausible server (browse.dgit.d.o? salsa?), and try the import-dsc again.
7224 END
7225         }
7226         if ($oldhash && !is_fast_fwd $oldhash, $dsc_hash) {
7227             if ($force > 0) {
7228                 progress __ "Not fast forward, forced update.";
7229             } else {
7230                 fail f_ "Not fast forward to %s", $dsc_hash;
7231             }
7232         }
7233         import_dsc_result $dstbranch, $dsc_hash,
7234             "dgit import-dsc (Dgit): $info",
7235             f_ "updated git ref %s", $dstbranch;
7236         return 0;
7237     }
7238
7239     fail f_ <<END, $dstbranch, $specbranch, $specbranch
7240 Branch %s already exists
7241 Specify ..%s for a pseudo-merge, binding in existing history
7242 Specify  +%s to overwrite, discarding existing history
7243 END
7244         if $oldhash && !$force;
7245
7246     my @dfi = dsc_files_info();
7247     foreach my $fi (@dfi) {
7248         my $f = $fi->{Filename};
7249         # We transfer all the pieces of the dsc to the bpd, not just
7250         # origs.  This is by analogy with dgit fetch, which wants to
7251         # keep them somewhere to avoid downloading them again.
7252         # We make symlinks, though.  If the user wants copies, then
7253         # they can copy the parts of the dsc to the bpd using dcmd,
7254         # or something.
7255         my $here = "$buildproductsdir/$f";
7256         if (lstat $here) {
7257             if (stat $here) {
7258                 next;
7259             }
7260             fail f_ "lstat %s works but stat gives %s !", $here, $!;
7261         }
7262         fail f_ "stat %s: %s", $here, $! unless $! == ENOENT;
7263         printdebug "not in bpd, $f ...\n";
7264         # $f does not exist in bpd, we need to transfer it
7265         my $there = $dscfn;
7266         $there =~ s{[^/]+$}{$f} or confess "$there ?";
7267         # $there is file we want, relative to user's cwd, or abs
7268         printdebug "not in bpd, $f, test $there ...\n";
7269         stat $there or fail f_
7270             "import %s requires %s, but: %s", $dscfn, $there, $!;
7271         if ($there =~ m#^(?:\./+)?\.\./+#) {
7272             # $there is relative to user's cwd
7273             my $there_from_parent = $';
7274             if ($buildproductsdir !~ m{^/}) {
7275                 # abs2rel, despite its name, can take two relative paths
7276                 $there = File::Spec->abs2rel($there,$buildproductsdir);
7277                 # now $there is relative to bpd, great
7278                 printdebug "not in bpd, $f, abs2rel, $there ...\n";
7279             } else {
7280                 $there = (dirname $maindir)."/$there_from_parent";
7281                 # now $there is absoute
7282                 printdebug "not in bpd, $f, rel2rel, $there ...\n";
7283             }
7284         } elsif ($there =~ m#^/#) {
7285             # $there is absolute already
7286             printdebug "not in bpd, $f, abs, $there ...\n";
7287         } else {
7288             fail f_
7289                 "cannot import %s which seems to be inside working tree!",
7290                 $dscfn;
7291         }
7292         symlink $there, $here or fail f_
7293             "symlink %s to %s: %s", $there, $here, $!;
7294         progress f_ "made symlink %s -> %s", $here, $there;
7295 #       print STDERR Dumper($fi);
7296     }
7297     my @mergeinputs = generate_commits_from_dsc();
7298     die unless @mergeinputs == 1;
7299
7300     my $newhash = $mergeinputs[0]{Commit};
7301
7302     if ($oldhash) {
7303         if ($force > 0) {
7304             progress __
7305                 "Import, forced update - synthetic orphan git history.";
7306         } elsif ($force < 0) {
7307             progress __ "Import, merging.";
7308             my $tree = cmdoutput @git, qw(rev-parse), "$newhash:";
7309             my $version = getfield $dsc, 'Version';
7310             my $clogp = commit_getclogp $newhash;
7311             my $authline = clogp_authline $clogp;
7312             $newhash = hash_commit_text <<ENDU
7313 tree $tree
7314 parent $newhash
7315 parent $oldhash
7316 author $authline
7317 committer $authline
7318
7319 ENDU
7320                 .(f_ <<END, $package, $version, $dstbranch);
7321 Merge %s (%s) import into %s
7322 END
7323         } else {
7324             die; # caught earlier
7325         }
7326     }
7327
7328     import_dsc_result $dstbranch, $newhash,
7329         "dgit import-dsc: $info",
7330         f_ "results are in git ref %s", $dstbranch;
7331 }
7332
7333 sub pre_archive_api_query () {
7334     not_necessarily_a_tree();
7335 }
7336 sub cmd_archive_api_query {
7337     badusage __ "need only 1 subpath argument" unless @ARGV==1;
7338     my ($subpath) = @ARGV;
7339     local $isuite = 'DGIT-API-QUERY-CMD';
7340     my $json = api_query_raw $subpath;
7341     print $json or die "$!";
7342 }
7343
7344 sub repos_server_url () {
7345     $package = '_dgit-repos-server';
7346     local $access_forpush = 1;
7347     local $isuite = 'DGIT-REPOS-SERVER';
7348     my $url = access_giturl();
7349 }    
7350
7351 sub pre_clone_dgit_repos_server () {
7352     not_necessarily_a_tree();
7353 }
7354 sub cmd_clone_dgit_repos_server {
7355     badusage __ "need destination argument" unless @ARGV==1;
7356     my ($destdir) = @ARGV;
7357     my $url = repos_server_url();
7358     my @cmd = (@git, qw(clone), $url, $destdir);
7359     debugcmd ">",@cmd;
7360     exec @cmd or fail f_ "exec git clone: %s\n", $!;
7361 }
7362
7363 sub pre_print_dgit_repos_server_source_url () {
7364     not_necessarily_a_tree();
7365 }
7366 sub cmd_print_dgit_repos_server_source_url {
7367     badusage __
7368         "no arguments allowed to dgit print-dgit-repos-server-source-url"
7369         if @ARGV;
7370     my $url = repos_server_url();
7371     print $url, "\n" or confess "$!";
7372 }
7373
7374 sub pre_print_dpkg_source_ignores {
7375     not_necessarily_a_tree();
7376 }
7377 sub cmd_print_dpkg_source_ignores {
7378     badusage __
7379         "no arguments allowed to dgit print-dpkg-source-ignores"
7380         if @ARGV;
7381     print "@dpkg_source_ignores\n" or confess "$!";
7382 }
7383
7384 sub cmd_setup_mergechangelogs {
7385     badusage __ "no arguments allowed to dgit setup-mergechangelogs"
7386         if @ARGV;
7387     local $isuite = 'DGIT-SETUP-TREE';
7388     setup_mergechangelogs(1);
7389 }
7390
7391 sub cmd_setup_useremail {
7392     badusage __ "no arguments allowed to dgit setup-useremail" if @ARGV;
7393     local $isuite = 'DGIT-SETUP-TREE';
7394     setup_useremail(1);
7395 }
7396
7397 sub cmd_setup_gitattributes {
7398     badusage __ "no arguments allowed to dgit setup-useremail" if @ARGV;
7399     local $isuite = 'DGIT-SETUP-TREE';
7400     setup_gitattrs(1);
7401 }
7402
7403 sub cmd_setup_new_tree {
7404     badusage __ "no arguments allowed to dgit setup-tree" if @ARGV;
7405     local $isuite = 'DGIT-SETUP-TREE';
7406     setup_new_tree();
7407 }
7408
7409 #---------- argument parsing and main program ----------
7410
7411 sub cmd_version {
7412     print "dgit version $our_version\n" or confess "$!";
7413     finish 0;
7414 }
7415
7416 our (%valopts_long, %valopts_short);
7417 our (%funcopts_long);
7418 our @rvalopts;
7419 our (@modeopt_cfgs);
7420
7421 sub defvalopt ($$$$) {
7422     my ($long,$short,$val_re,$how) = @_;
7423     my $oi = { Long => $long, Short => $short, Re => $val_re, How => $how };
7424     $valopts_long{$long} = $oi;
7425     $valopts_short{$short} = $oi;
7426     # $how subref should:
7427     #   do whatever assignemnt or thing it likes with $_[0]
7428     #   if the option should not be passed on to remote, @rvalopts=()
7429     # or $how can be a scalar ref, meaning simply assign the value
7430 }
7431
7432 defvalopt '--since-version', '-v', '[^_]+|_', \$changes_since_version;
7433 defvalopt '--distro',        '-d', '.+',      \$idistro;
7434 defvalopt '',                '-k', '.+',      \$keyid;
7435 defvalopt '--existing-package','', '.*',      \$existing_package;
7436 defvalopt '--build-products-dir','','.*',     \$buildproductsdir;
7437 defvalopt '--clean',       '', $cleanmode_re, \$cleanmode;
7438 defvalopt '--package',   '-p',   $package_re, \$package;
7439 defvalopt '--quilt',     '', $quilt_modes_re, \$quilt_mode;
7440
7441 defvalopt '', '-C', '.+', sub {
7442     ($changesfile) = (@_);
7443     if ($changesfile =~ s#^(.*)/##) {
7444         $buildproductsdir = $1;
7445     }
7446 };
7447
7448 defvalopt '--initiator-tempdir','','.*', sub {
7449     ($initiator_tempdir) = (@_);
7450     $initiator_tempdir =~ m#^/# or
7451         badusage __ "--initiator-tempdir must be used specify an".
7452                     " absolute, not relative, directory."
7453 };
7454
7455 sub defoptmodes ($@) {
7456     my ($varref, $cfgkey, $default, %optmap) = @_;
7457     my %permit;
7458     while (my ($opt,$val) = each %optmap) {
7459         $funcopts_long{$opt} = sub { $$varref = $val; };
7460         $permit{$val} = $val;
7461     }
7462     push @modeopt_cfgs, {
7463         Var => $varref,
7464         Key => $cfgkey,
7465         Default => $default,
7466         Vals => \%permit
7467     };
7468 }
7469
7470 defoptmodes \$dodep14tag, qw( dep14tag          want
7471                               --dep14tag        want
7472                               --no-dep14tag     no
7473                               --always-dep14tag always );
7474
7475 sub parseopts () {
7476     my $om;
7477
7478     if (defined $ENV{'DGIT_SSH'}) {
7479         @ssh = string_to_ssh $ENV{'DGIT_SSH'};
7480     } elsif (defined $ENV{'GIT_SSH'}) {
7481         @ssh = ($ENV{'GIT_SSH'});
7482     }
7483
7484     my $oi;
7485     my $val;
7486     my $valopt = sub {
7487         my ($what) = @_;
7488         @rvalopts = ($_);
7489         if (!defined $val) {
7490             badusage f_ "%s needs a value", $what unless @ARGV;
7491             $val = shift @ARGV;
7492             push @rvalopts, $val;
7493         }
7494         badusage f_ "bad value \`%s' for %s", $val, $what unless
7495             $val =~ m/^$oi->{Re}$(?!\n)/s;
7496         my $how = $oi->{How};
7497         if (ref($how) eq 'SCALAR') {
7498             $$how = $val;
7499         } else {
7500             $how->($val);
7501         }
7502         push @ropts, @rvalopts;
7503     };
7504
7505     while (@ARGV) {
7506         last unless $ARGV[0] =~ m/^-/;
7507         $_ = shift @ARGV;
7508         last if m/^--?$/;
7509         if (m/^--/) {
7510             if (m/^--dry-run$/) {
7511                 push @ropts, $_;
7512                 $dryrun_level=2;
7513             } elsif (m/^--damp-run$/) {
7514                 push @ropts, $_;
7515                 $dryrun_level=1;
7516             } elsif (m/^--no-sign$/) {
7517                 push @ropts, $_;
7518                 $sign=0;
7519             } elsif (m/^--help$/) {
7520                 cmd_help();
7521             } elsif (m/^--version$/) {
7522                 cmd_version();
7523             } elsif (m/^--new$/) {
7524                 push @ropts, $_;
7525                 $new_package=1;
7526             } elsif (m/^--([-0-9a-z]+)=(.+)/s &&
7527                      ($om = $opts_opt_map{$1}) &&
7528                      length $om->[0]) {
7529                 push @ropts, $_;
7530                 $om->[0] = $2;
7531             } elsif (m/^--([-0-9a-z]+):(.*)/s &&
7532                      !$opts_opt_cmdonly{$1} &&
7533                      ($om = $opts_opt_map{$1})) {
7534                 push @ropts, $_;
7535                 push @$om, $2;
7536             } elsif (m/^--([-0-9a-z]+)\!:(.*)/s &&
7537                      !$opts_opt_cmdonly{$1} &&
7538                      ($om = $opts_opt_map{$1})) {
7539                 push @ropts, $_;
7540                 my $cmd = shift @$om;
7541                 @$om = ($cmd, grep { $_ ne $2 } @$om);
7542             } elsif (m/^--($quilt_options_re)$/s) {
7543                 push @ropts, "--quilt=$1";
7544                 $quilt_mode = $1;
7545             } elsif (m/^--(?:ignore|include)-dirty$/s) {
7546                 push @ropts, $_;
7547                 $includedirty = 1;
7548             } elsif (m/^--no-quilt-fixup$/s) {
7549                 push @ropts, $_;
7550                 $quilt_mode = 'nocheck';
7551             } elsif (m/^--no-rm-on-error$/s) {
7552                 push @ropts, $_;
7553                 $rmonerror = 0;
7554             } elsif (m/^--no-chase-dsc-distro$/s) {
7555                 push @ropts, $_;
7556                 $chase_dsc_distro = 0;
7557             } elsif (m/^--overwrite$/s) {
7558                 push @ropts, $_;
7559                 $overwrite_version = '';
7560             } elsif (m/^--split-(?:view|brain)$/s) {
7561                 push @ropts, $_;
7562                 $splitview_mode = 'always';
7563             } elsif (m/^--split-(?:view|brain)=($splitview_modes_re)$/s) {
7564                 push @ropts, $_;
7565                 $splitview_mode = $1;
7566             } elsif (m/^--overwrite=(.+)$/s) {
7567                 push @ropts, $_;
7568                 $overwrite_version = $1;
7569             } elsif (m/^--delayed=(\d+)$/s) {
7570                 push @ropts, $_;
7571                 push @dput, $_;
7572             } elsif (m/^--upstream-commitish=(.+)$/s) {
7573                 push @ropts, $_;
7574                 $quilt_upstream_commitish = $1;
7575             } elsif (m/^--save-(dgit-view)=(.+)$/s ||
7576                      m/^--(dgit-view)-save=(.+)$/s
7577                      ) {
7578                 my ($k,$v) = ($1,$2);
7579                 push @ropts, $_;
7580                 $v =~ s#^(?!refs/)#refs/heads/#;
7581                 $internal_object_save{$k} = $v;
7582             } elsif (m/^--(no-)?rm-old-changes$/s) {
7583                 push @ropts, $_;
7584                 $rmchanges = !$1;
7585             } elsif (m/^--deliberately-($deliberately_re)$/s) {
7586                 push @ropts, $_;
7587                 push @deliberatelies, $&;
7588             } elsif (m/^--force-(.*)/ && defined $forceopts{$1}) {
7589                 push @ropts, $&;
7590                 $forceopts{$1} = 1;
7591                 $_='';
7592             } elsif (m/^--force-/) {
7593                 print STDERR
7594                     f_ "%s: warning: ignoring unknown force option %s\n",
7595                        $us, $_;
7596                 $_='';
7597             } elsif (m/^--for-push$/s) {
7598                 push @ropts, $_;
7599                 $access_forpush = 1;
7600             } elsif (m/^--config-lookup-explode=(.+)$/s) {
7601                 # undocumented, for testing
7602                 push @ropts, $_;
7603                 $gitcfgs{cmdline}{$1} = 'CONFIG-LOOKUP-EXPLODE';
7604                 # ^ it's supposed to be an array ref
7605             } elsif (m/^(--[-0-9a-z]+)(=|$)/ && ($oi = $valopts_long{$1})) {
7606                 $val = $2 ? $' : undef; #';
7607                 $valopt->($oi->{Long});
7608             } elsif ($funcopts_long{$_}) {
7609                 push @ropts, $_;
7610                 $funcopts_long{$_}();
7611             } else {
7612                 badusage f_ "unknown long option \`%s'", $_;
7613             }
7614         } else {
7615             while (m/^-./s) {
7616                 if (s/^-n/-/) {
7617                     push @ropts, $&;
7618                     $dryrun_level=2;
7619                 } elsif (s/^-L/-/) {
7620                     push @ropts, $&;
7621                     $dryrun_level=1;
7622                 } elsif (s/^-h/-/) {
7623                     cmd_help();
7624                 } elsif (s/^-D/-/) {
7625                     push @ropts, $&;
7626                     $debuglevel++;
7627                     enabledebug();
7628                 } elsif (s/^-N/-/) {
7629                     push @ropts, $&;
7630                     $new_package=1;
7631                 } elsif (m/^-m/) {
7632                     push @ropts, $&;
7633                     push @changesopts, $_;
7634                     $_ = '';
7635                 } elsif (s/^-wn$//s) {
7636                     push @ropts, $&;
7637                     $cleanmode = 'none';
7638                 } elsif (s/^-wg(f?)(a?)$//s) {
7639                     push @ropts, $&;
7640                     $cleanmode = 'git';
7641                     $cleanmode .= '-ff' if $1;
7642                     $cleanmode .= ',always' if $2;
7643                 } elsif (s/^-wd(d?)([na]?)$//s) {
7644                     push @ropts, $&;
7645                     $cleanmode = 'dpkg-source';
7646                     $cleanmode .= '-d' if $1;
7647                     $cleanmode .= ',no-check' if $2 eq 'n';
7648                     $cleanmode .= ',all-check' if $2 eq 'a';
7649                 } elsif (s/^-wc$//s) {
7650                     push @ropts, $&;
7651                     $cleanmode = 'check';
7652                 } elsif (s/^-wci$//s) {
7653                     push @ropts, $&;
7654                     $cleanmode = 'check,ignores';
7655                 } elsif (s/^-c([^=]*)\=(.*)$//s) {
7656                     push @git, '-c', $&;
7657                     $gitcfgs{cmdline}{$1} = [ $2 ];
7658                 } elsif (s/^-c([^=]+)$//s) {
7659                     push @git, '-c', $&;
7660                     $gitcfgs{cmdline}{$1} = [ 'true' ];
7661                 } elsif (m/^-[a-zA-Z]/ && ($oi = $valopts_short{$&})) {
7662                     $val = $'; #';
7663                     $val = undef unless length $val;
7664                     $valopt->($oi->{Short});
7665                     $_ = '';
7666                 } else {
7667                     badusage f_ "unknown short option \`%s'", $_;
7668                 }
7669             }
7670         }
7671     }
7672 }
7673
7674 sub check_env_sanity () {
7675     my $blocked = new POSIX::SigSet;
7676     sigprocmask SIG_UNBLOCK, $blocked, $blocked or confess "$!";
7677
7678     eval {
7679         foreach my $name (qw(PIPE CHLD)) {
7680             my $signame = "SIG$name";
7681             my $signum = eval "POSIX::$signame" // die;
7682             die f_ "%s is set to something other than SIG_DFL\n",
7683                 $signame
7684                 if defined $SIG{$name} and $SIG{$name} ne 'DEFAULT';
7685             $blocked->ismember($signum) and
7686                 die f_ "%s is blocked\n", $signame;
7687         }
7688     };
7689     return unless $@;
7690     chomp $@;
7691     fail f_ <<END, $@;
7692 On entry to dgit, %s
7693 This is a bug produced by something in your execution environment.
7694 Giving up.
7695 END
7696 }
7697
7698
7699 sub parseopts_late_defaults () {
7700     $isuite //= cfg("dgit-distro.$idistro.default-suite", 'RETURN-UNDEF')
7701         if defined $idistro;
7702     $isuite //= cfg('dgit.default.default-suite');
7703
7704     foreach my $k (keys %opts_opt_map) {
7705         my $om = $opts_opt_map{$k};
7706
7707         my $v = access_cfg("cmd-$k", 'RETURN-UNDEF');
7708         if (defined $v) {
7709             badcfg f_ "cannot set command for %s", $k
7710                 unless length $om->[0];
7711             $om->[0] = $v;
7712         }
7713
7714         foreach my $c (access_cfg_cfgs("opts-$k")) {
7715             my @vl =
7716                 map { $_ ? @$_ : () }
7717                 map { $gitcfgs{$_}{$c} }
7718                 reverse @gitcfgsources;
7719             printdebug "CL $c ", (join " ", map { shellquote } @vl),
7720                 "\n" if $debuglevel >= 4;
7721             next unless @vl;
7722             badcfg f_ "cannot configure options for %s", $k
7723                 if $opts_opt_cmdonly{$k};
7724             my $insertpos = $opts_cfg_insertpos{$k};
7725             @$om = ( @$om[0..$insertpos-1],
7726                      @vl,
7727                      @$om[$insertpos..$#$om] );
7728         }
7729     }
7730
7731     if (!defined $rmchanges) {
7732         local $access_forpush;
7733         $rmchanges = access_cfg_bool(0, 'rm-old-changes');
7734     }
7735
7736     if (!defined $quilt_mode) {
7737         local $access_forpush;
7738         $quilt_mode = cfg('dgit.force.quilt-mode', 'RETURN-UNDEF')
7739             // access_cfg('quilt-mode', 'RETURN-UNDEF')
7740             // 'linear';
7741         $quilt_mode =~ m/^($quilt_modes_re)$/ 
7742             or badcfg f_ "unknown quilt-mode \`%s'", $quilt_mode;
7743         $quilt_mode = $1;
7744     }
7745     $quilt_mode =~ s/^(baredebian)\+git$/$1/;
7746
7747     foreach my $moc (@modeopt_cfgs) {
7748         local $access_forpush;
7749         my $vr = $moc->{Var};
7750         next if defined $$vr;
7751         $$vr = access_cfg($moc->{Key}, 'RETURN-UNDEF') // $moc->{Default};
7752         my $v = $moc->{Vals}{$$vr};
7753         badcfg f_ "unknown %s setting \`%s'", $moc->{Key}, $$vr
7754             unless defined $v;
7755         $$vr = $v;
7756     }
7757
7758     {
7759         local $access_forpush;
7760         default_from_access_cfg(\$cleanmode, 'clean-mode', 'dpkg-source',
7761                                 $cleanmode_re);
7762     }
7763
7764     $buildproductsdir //= access_cfg('build-products-dir', 'RETURN-UNDEF');
7765     $buildproductsdir //= '..';
7766     $bpd_glob = $buildproductsdir;
7767     $bpd_glob =~ s#[][\\{}*?~]#\\$&#g;
7768 }
7769
7770 setlocale(LC_MESSAGES, "");
7771 textdomain("dgit");
7772
7773 if ($ENV{$fakeeditorenv}) {
7774     git_slurp_config();
7775     quilt_fixup_editor();
7776 }
7777
7778 parseopts();
7779 check_env_sanity();
7780
7781 print STDERR __ "DRY RUN ONLY\n" if $dryrun_level > 1;
7782 print STDERR __ "DAMP RUN - WILL MAKE LOCAL (UNSIGNED) CHANGES\n"
7783     if $dryrun_level == 1;
7784 if (!@ARGV) {
7785     print STDERR __ $helpmsg or confess "$!";
7786     finish 8;
7787 }
7788 $cmd = $subcommand = shift @ARGV;
7789 $cmd =~ y/-/_/;
7790
7791 my $pre_fn = ${*::}{"pre_$cmd"};
7792 $pre_fn->() if $pre_fn;
7793
7794 if ($invoked_in_git_tree) {
7795     changedir_git_toplevel();
7796     record_maindir();
7797 }
7798 git_slurp_config();
7799
7800 my $fn = ${*::}{"cmd_$cmd"};
7801 $fn or badusage f_ "unknown operation %s", $cmd;
7802 $fn->();
7803
7804 finish 0;