3 # Integration between git and Debian-style archives
5 # Copyright (C)2013-2015 Ian Jackson
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
28 use Dpkg::Control::Hash;
30 use File::Temp qw(tempdir);
40 our $our_version = 'UNRELEASED'; ###substituted###
42 our @rpushprotovsn_support = qw(3 2); # 4 is new tag format
45 our $isuite = 'unstable';
51 our $dryrun_level = 0;
53 our $buildproductsdir = '..';
59 our $existing_package = 'dpkg';
61 our $changes_since_version;
64 our $quilt_modes_re = 'linear|smash|auto|nofix|nocheck|gbp|unapplied';
65 our $we_are_responder;
66 our $initiator_tempdir;
67 our $patches_applied_dirtily = 00;
72 our %format_ok = map { $_=>1 } ("1.0","3.0 (native)","3.0 (quilt)");
74 our $suite_re = '[-+.0-9a-z]+';
75 our $cleanmode_re = 'dpkg-source(?:-d)?|git|git-ff|check|none';
77 our $git_authline_re = '^([^<>]+) \<(\S+)\> (\d+ [-+]\d+)$';
78 our $splitbraincache = 'dgit-intern/quilt-cache';
81 our (@dget) = qw(dget);
82 our (@curl) = qw(curl -f);
83 our (@dput) = qw(dput);
84 our (@debsign) = qw(debsign);
86 our (@sbuild) = qw(sbuild);
88 our (@dgit) = qw(dgit);
89 our (@dpkgbuildpackage) = qw(dpkg-buildpackage -i\.git/ -I.git);
90 our (@dpkgsource) = qw(dpkg-source -i\.git/ -I.git);
91 our (@dpkggenchanges) = qw(dpkg-genchanges);
92 our (@mergechanges) = qw(mergechanges -f);
94 our (@changesopts) = ('');
96 our %opts_opt_map = ('dget' => \@dget, # accept for compatibility
99 'debsign' => \@debsign,
101 'sbuild' => \@sbuild,
105 'dpkg-source' => \@dpkgsource,
106 'dpkg-buildpackage' => \@dpkgbuildpackage,
107 'dpkg-genchanges' => \@dpkggenchanges,
109 'ch' => \@changesopts,
110 'mergechanges' => \@mergechanges);
112 our %opts_opt_cmdonly = ('gpg' => 1, 'git' => 1);
113 our %opts_cfg_insertpos = map {
115 scalar @{ $opts_opt_map{$_} }
116 } keys %opts_opt_map;
118 sub finalise_opts_opts();
124 our $supplementary_message = '';
125 our $need_split_build_invocation = 0;
126 our $split_brain = 0;
130 print STDERR "! $_\n" foreach $supplementary_message =~ m/^.+$/mg;
133 our $remotename = 'dgit';
134 our @ourdscfield = qw(Dgit Vcs-Dgit-Master);
139 my ($v,$distro) = @_;
140 return $tagformatfn->($v, $distro);
143 sub lbranch () { return "$branchprefix/$csuite"; }
144 my $lbranch_re = '^refs/heads/'.$branchprefix.'/([^/.]+)$';
145 sub lref () { return "refs/heads/".lbranch(); }
146 sub lrref () { return "refs/remotes/$remotename/".server_branch($csuite); }
147 sub rrref () { return server_ref($csuite); }
149 sub lrfetchrefs () { return "refs/dgit-fetch/$csuite"; }
159 return "${package}_".(stripepoch $vsn).$sfx
164 return srcfn($vsn,".dsc");
167 sub changespat ($;$) {
168 my ($vsn, $arch) = @_;
169 return "${package}_".(stripepoch $vsn)."_".($arch//'*').".changes";
178 foreach my $f (@end) {
180 print STDERR "$us: cleanup: $@" if length $@;
184 sub badcfg { print STDERR "$us: invalid configuration: @_\n"; exit 12; }
186 sub no_such_package () {
187 print STDERR "$us: package $package does not exist in suite $isuite\n";
193 return "+".rrref().":".lrref();
198 printdebug "CD $newdir\n";
199 chdir $newdir or die "chdir: $newdir: $!";
202 sub deliberately ($) {
204 return !!grep { $_ eq "--deliberately-$enquiry" } @deliberatelies;
207 sub deliberately_not_fast_forward () {
208 foreach (qw(not-fast-forward fresh-repo)) {
209 return 1 if deliberately($_) || deliberately("TEST-dgit-only-$_");
213 sub quiltmode_splitbrain () {
214 $quilt_mode =~ m/gbp|dpm|unapplied/;
217 #---------- remote protocol support, common ----------
219 # remote push initiator/responder protocol:
220 # $ dgit remote-push-build-host <n-rargs> <rargs>... <push-args>...
221 # where <rargs> is <push-host-dir> <supported-proto-vsn>,... ...
222 # < dgit-remote-push-ready <actual-proto-vsn>
229 # > supplementary-message NBYTES # $protovsn >= 3
234 # > file parsed-changelog
235 # [indicates that output of dpkg-parsechangelog follows]
236 # > data-block NBYTES
237 # > [NBYTES bytes of data (no newline)]
238 # [maybe some more blocks]
248 # > param csuite SUITE
249 # > param tagformat old|new
251 # > previously REFNAME=OBJNAME # if --deliberately-not-fast-forward
252 # # goes into tag, for replay prevention
255 # [indicates that signed tag is wanted]
256 # < data-block NBYTES
257 # < [NBYTES bytes of data (no newline)]
258 # [maybe some more blocks]
262 # > want signed-dsc-changes
263 # < data-block NBYTES [transfer of signed dsc]
265 # < data-block NBYTES [transfer of signed changes]
273 sub i_child_report () {
274 # Sees if our child has died, and reap it if so. Returns a string
275 # describing how it died if it failed, or undef otherwise.
276 return undef unless $i_child_pid;
277 my $got = waitpid $i_child_pid, WNOHANG;
278 return undef if $got <= 0;
279 die unless $got == $i_child_pid;
280 $i_child_pid = undef;
281 return undef unless $?;
282 return "build host child ".waitstatusmsg();
287 fail "connection lost: $!" if $fh->error;
288 fail "protocol violation; $m not expected";
291 sub badproto_badread ($$) {
293 fail "connection lost: $!" if $!;
294 my $report = i_child_report();
295 fail $report if defined $report;
296 badproto $fh, "eof (reading $wh)";
299 sub protocol_expect (&$) {
300 my ($match, $fh) = @_;
303 defined && chomp or badproto_badread $fh, "protocol message";
311 badproto $fh, "\`$_'";
314 sub protocol_send_file ($$) {
315 my ($fh, $ourfn) = @_;
316 open PF, "<", $ourfn or die "$ourfn: $!";
319 my $got = read PF, $d, 65536;
320 die "$ourfn: $!" unless defined $got;
322 print $fh "data-block ".length($d)."\n" or die $!;
323 print $fh $d or die $!;
325 PF->error and die "$ourfn $!";
326 print $fh "data-end\n" or die $!;
330 sub protocol_read_bytes ($$) {
331 my ($fh, $nbytes) = @_;
332 $nbytes =~ m/^[1-9]\d{0,5}$|^0$/ or badproto \*RO, "bad byte count";
334 my $got = read $fh, $d, $nbytes;
335 $got==$nbytes or badproto_badread $fh, "data block";
339 sub protocol_receive_file ($$) {
340 my ($fh, $ourfn) = @_;
341 printdebug "() $ourfn\n";
342 open PF, ">", $ourfn or die "$ourfn: $!";
344 my ($y,$l) = protocol_expect {
345 m/^data-block (.*)$/ ? (1,$1) :
346 m/^data-end$/ ? (0,) :
350 my $d = protocol_read_bytes $fh, $l;
351 print PF $d or die $!;
356 #---------- remote protocol support, responder ----------
358 sub responder_send_command ($) {
360 return unless $we_are_responder;
361 # called even without $we_are_responder
362 printdebug ">> $command\n";
363 print PO $command, "\n" or die $!;
366 sub responder_send_file ($$) {
367 my ($keyword, $ourfn) = @_;
368 return unless $we_are_responder;
369 printdebug "]] $keyword $ourfn\n";
370 responder_send_command "file $keyword";
371 protocol_send_file \*PO, $ourfn;
374 sub responder_receive_files ($@) {
375 my ($keyword, @ourfns) = @_;
376 die unless $we_are_responder;
377 printdebug "[[ $keyword @ourfns\n";
378 responder_send_command "want $keyword";
379 foreach my $fn (@ourfns) {
380 protocol_receive_file \*PI, $fn;
383 protocol_expect { m/^files-end$/ } \*PI;
386 #---------- remote protocol support, initiator ----------
388 sub initiator_expect (&) {
390 protocol_expect { &$match } \*RO;
393 #---------- end remote code ----------
396 if ($we_are_responder) {
398 responder_send_command "progress ".length($m) or die $!;
399 print PO $m or die $!;
409 $ua = LWP::UserAgent->new();
413 progress "downloading $what...";
414 my $r = $ua->get(@_) or die $!;
415 return undef if $r->code == 404;
416 $r->is_success or fail "failed to fetch $what: ".$r->status_line;
417 return $r->decoded_content(charset => 'none');
420 our ($dscdata,$dscurl,$dsc,$dsc_checked,$skew_warning_vsn);
425 failedcmd @_ if system @_;
428 sub act_local () { return $dryrun_level <= 1; }
429 sub act_scary () { return !$dryrun_level; }
432 if (!$dryrun_level) {
433 progress "dgit ok: @_";
435 progress "would be ok: @_ (but dry run only)";
440 printcmd(\*STDERR,$debugprefix."#",@_);
443 sub runcmd_ordryrun {
451 sub runcmd_ordryrun_local {
460 my ($first_shell, @cmd) = @_;
461 return qw(sh -ec), $first_shell.'; exec "$@"', 'x', @cmd;
464 our $helpmsg = <<END;
466 dgit [dgit-opts] clone [dgit-opts] package [suite] [./dir|/dir]
467 dgit [dgit-opts] fetch|pull [dgit-opts] [suite]
468 dgit [dgit-opts] build [dpkg-buildpackage-opts]
469 dgit [dgit-opts] sbuild [sbuild-opts]
470 dgit [dgit-opts] push [dgit-opts] [suite]
471 dgit [dgit-opts] rpush build-host:build-dir ...
472 important dgit options:
473 -k<keyid> sign tag and package with <keyid> instead of default
474 --dry-run -n do not change anything, but go through the motions
475 --damp-run -L like --dry-run but make local changes, without signing
476 --new -N allow introducing a new package
477 --debug -D increase debug level
478 -c<name>=<value> set git config option (used directly by dgit too)
481 our $later_warning_msg = <<END;
482 Perhaps the upload is stuck in incoming. Using the version from git.
486 print STDERR "$us: @_\n", $helpmsg or die $!;
491 @ARGV or badusage "too few arguments";
492 return scalar shift @ARGV;
496 print $helpmsg or die $!;
500 our $td = $ENV{DGIT_TEST_DUMMY_DIR} || "DGIT_TEST_DUMMY_DIR-unset";
502 our %defcfg = ('dgit.default.distro' => 'debian',
503 'dgit.default.username' => '',
504 'dgit.default.archive-query-default-component' => 'main',
505 'dgit.default.ssh' => 'ssh',
506 'dgit.default.archive-query' => 'madison:',
507 'dgit.default.sshpsql-dbname' => 'service=projectb',
508 'dgit.default.dgit-tag-format' => 'old,new',
509 'dgit-distro.debian.archive-query' => 'ftpmasterapi:',
510 'dgit-distro.debian.git-check' => 'url',
511 'dgit-distro.debian.git-check-suffix' => '/info/refs',
512 'dgit-distro.debian.new-private-pushers' => 't',
513 'dgit-distro.debian.dgit-tag-format' => 'old',
514 'dgit-distro.debian/push.git-url' => '',
515 'dgit-distro.debian/push.git-host' => 'push.dgit.debian.org',
516 'dgit-distro.debian/push.git-user-force' => 'dgit',
517 'dgit-distro.debian/push.git-proto' => 'git+ssh://',
518 'dgit-distro.debian/push.git-path' => '/dgit/debian/repos',
519 'dgit-distro.debian/push.git-create' => 'true',
520 'dgit-distro.debian/push.git-check' => 'ssh-cmd',
521 'dgit-distro.debian.archive-query-url', 'https://api.ftp-master.debian.org/',
522 # 'dgit-distro.debian.archive-query-tls-key',
523 # '/etc/ssl/certs/%HOST%.pem:/etc/dgit/%HOST%.pem',
524 # ^ this does not work because curl is broken nowadays
525 # Fixing #790093 properly will involve providing providing the key
526 # in some pacagke and maybe updating these paths.
528 # 'dgit-distro.debian.archive-query-tls-curl-args',
529 # '--ca-path=/etc/ssl/ca-debian',
530 # ^ this is a workaround but works (only) on DSA-administered machines
531 'dgit-distro.debian.git-url' => 'https://git.dgit.debian.org',
532 'dgit-distro.debian.git-url-suffix' => '',
533 'dgit-distro.debian.upload-host' => 'ftp-master', # for dput
534 'dgit-distro.debian.mirror' => 'http://ftp.debian.org/debian/',
535 'dgit-distro.debian.backports-quirk' => '(squeeze)-backports*',
536 'dgit-distro.debian-backports.mirror' => 'http://backports.debian.org/debian-backports/',
537 'dgit-distro.ubuntu.git-check' => 'false',
538 'dgit-distro.ubuntu.mirror' => 'http://archive.ubuntu.com/ubuntu',
539 'dgit-distro.test-dummy.ssh' => "$td/ssh",
540 'dgit-distro.test-dummy.username' => "alice",
541 'dgit-distro.test-dummy.git-check' => "ssh-cmd",
542 'dgit-distro.test-dummy.git-create' => "ssh-cmd",
543 'dgit-distro.test-dummy.git-url' => "$td/git",
544 'dgit-distro.test-dummy.git-host' => "git",
545 'dgit-distro.test-dummy.git-path' => "$td/git",
546 'dgit-distro.test-dummy.archive-query' => "ftpmasterapi:",
547 'dgit-distro.test-dummy.archive-query-url' => "file://$td/aq/",
548 'dgit-distro.test-dummy.mirror' => "file://$td/mirror/",
549 'dgit-distro.test-dummy.upload-host' => 'test-dummy',
554 sub git_slurp_config () {
555 local ($debuglevel) = $debuglevel-2;
558 my @cmd = (@git, qw(config -z --get-regexp .*));
561 open GITS, "-|", @cmd or die $!;
564 printdebug "=> ", (messagequote $_), "\n";
566 push @{ $gitcfg{$`} }, $'; #';
570 or ($!==0 && $?==256)
574 sub git_get_config ($) {
577 printdebug"C $c ".(defined $l ? messagequote "'$l'" : "undef")."\n"
580 @$l==1 or badcfg "multiple values for $c" if @$l > 1;
586 return undef if $c =~ /RETURN-UNDEF/;
587 my $v = git_get_config($c);
588 return $v if defined $v;
589 my $dv = $defcfg{$c};
590 return $dv if defined $dv;
592 badcfg "need value for one of: @_\n".
593 "$us: distro or suite appears not to be (properly) supported";
596 sub access_basedistro () {
597 if (defined $idistro) {
600 return cfg("dgit-suite.$isuite.distro",
601 "dgit.default.distro");
605 sub access_quirk () {
606 # returns (quirk name, distro to use instead or undef, quirk-specific info)
607 my $basedistro = access_basedistro();
608 my $backports_quirk = cfg("dgit-distro.$basedistro.backports-quirk",
610 if (defined $backports_quirk) {
611 my $re = $backports_quirk;
612 $re =~ s/[^-0-9a-z_\%*()]/\\$&/ig;
614 $re =~ s/\%/([-0-9a-z_]+)/
615 or $re =~ m/[()]/ or badcfg "backports-quirk needs \% or ( )";
616 if ($isuite =~ m/^$re$/) {
617 return ('backports',"$basedistro-backports",$1);
620 return ('none',undef);
625 sub parse_cfg_bool ($$$) {
626 my ($what,$def,$v) = @_;
629 $v =~ m/^[ty1]/ ? 1 :
630 $v =~ m/^[fn0]/ ? 0 :
631 badcfg "$what needs t (true, y, 1) or f (false, n, 0) not \`$v'";
634 sub access_forpush_config () {
635 my $d = access_basedistro();
639 parse_cfg_bool('new-private-pushers', 0,
640 cfg("dgit-distro.$d.new-private-pushers",
643 my $v = cfg("dgit-distro.$d.readonly", 'RETURN-UNDEF');
646 $v =~ m/^[ty1]/ ? 0 : # force readonly, forpush = 0
647 $v =~ m/^[fn0]/ ? 1 : # force nonreadonly, forpush = 1
648 $v =~ m/^[a]/ ? '' : # auto, forpush = ''
649 badcfg "readonly needs t (true, y, 1) or f (false, n, 0) or a (auto)";
652 sub access_forpush () {
653 $access_forpush //= access_forpush_config();
654 return $access_forpush;
658 die "$access_forpush ?" if ($access_forpush // 1) ne 1;
659 badcfg "pushing but distro is configured readonly"
660 if access_forpush_config() eq '0';
662 $supplementary_message = <<'END' unless $we_are_responder;
663 Push failed, before we got started.
664 You can retry the push, after fixing the problem, if you like.
666 finalise_opts_opts();
670 finalise_opts_opts();
673 sub supplementary_message ($) {
675 if (!$we_are_responder) {
676 $supplementary_message = $msg;
678 } elsif ($protovsn >= 3) {
679 responder_send_command "supplementary-message ".length($msg)
681 print PO $msg or die $!;
685 sub access_distros () {
686 # Returns list of distros to try, in order
689 # 0. `instead of' distro name(s) we have been pointed to
690 # 1. the access_quirk distro, if any
691 # 2a. the user's specified distro, or failing that } basedistro
692 # 2b. the distro calculated from the suite }
693 my @l = access_basedistro();
695 my (undef,$quirkdistro) = access_quirk();
696 unshift @l, $quirkdistro;
697 unshift @l, $instead_distro;
698 @l = grep { defined } @l;
700 if (access_forpush()) {
701 @l = map { ("$_/push", $_) } @l;
706 sub access_cfg_cfgs (@) {
709 # The nesting of these loops determines the search order. We put
710 # the key loop on the outside so that we search all the distros
711 # for each key, before going on to the next key. That means that
712 # if access_cfg is called with a more specific, and then a less
713 # specific, key, an earlier distro can override the less specific
714 # without necessarily overriding any more specific keys. (If the
715 # distro wants to override the more specific keys it can simply do
716 # so; whereas if we did the loop the other way around, it would be
717 # impossible to for an earlier distro to override a less specific
718 # key but not the more specific ones without restating the unknown
719 # values of the more specific keys.
722 # We have to deal with RETURN-UNDEF specially, so that we don't
723 # terminate the search prematurely.
725 if (m/RETURN-UNDEF/) { push @rundef, $_; last; }
728 foreach my $d (access_distros()) {
729 push @cfgs, map { "dgit-distro.$d.$_" } @realkeys;
731 push @cfgs, map { "dgit.default.$_" } @realkeys;
738 my (@cfgs) = access_cfg_cfgs(@keys);
739 my $value = cfg(@cfgs);
743 sub access_cfg_bool ($$) {
744 my ($def, @keys) = @_;
745 parse_cfg_bool($keys[0], $def, access_cfg(@keys, 'RETURN-UNDEF'));
748 sub string_to_ssh ($) {
750 if ($spec =~ m/\s/) {
751 return qw(sh -ec), 'exec '.$spec.' "$@"', 'x';
757 sub access_cfg_ssh () {
758 my $gitssh = access_cfg('ssh', 'RETURN-UNDEF');
759 if (!defined $gitssh) {
762 return string_to_ssh $gitssh;
766 sub access_runeinfo ($) {
768 return ": dgit ".access_basedistro()." $info ;";
771 sub access_someuserhost ($) {
773 my $user = access_cfg("$some-user-force", 'RETURN-UNDEF');
774 defined($user) && length($user) or
775 $user = access_cfg("$some-user",'username');
776 my $host = access_cfg("$some-host");
777 return length($user) ? "$user\@$host" : $host;
780 sub access_gituserhost () {
781 return access_someuserhost('git');
784 sub access_giturl (;$) {
786 my $url = access_cfg('git-url','RETURN-UNDEF');
789 my $proto = access_cfg('git-proto', 'RETURN-UNDEF');
790 return undef unless defined $proto;
793 access_gituserhost().
794 access_cfg('git-path');
796 $suffix = access_cfg('git-url-suffix','RETURN-UNDEF');
799 return "$url/$package$suffix";
802 sub parsecontrolfh ($$;$) {
803 my ($fh, $desc, $allowsigned) = @_;
804 our $dpkgcontrolhash_noissigned;
807 my %opts = ('name' => $desc);
808 $opts{allow_pgp}= $allowsigned || !$dpkgcontrolhash_noissigned;
809 $c = Dpkg::Control::Hash->new(%opts);
810 $c->parse($fh,$desc) or die "parsing of $desc failed";
811 last if $allowsigned;
812 last if $dpkgcontrolhash_noissigned;
813 my $issigned= $c->get_option('is_pgp_signed');
814 if (!defined $issigned) {
815 $dpkgcontrolhash_noissigned= 1;
816 seek $fh, 0,0 or die "seek $desc: $!";
817 } elsif ($issigned) {
818 fail "control file $desc is (already) PGP-signed. ".
819 " Note that dgit push needs to modify the .dsc and then".
820 " do the signature itself";
829 my ($file, $desc) = @_;
830 my $fh = new IO::Handle;
831 open $fh, '<', $file or die "$file: $!";
832 my $c = parsecontrolfh($fh,$desc);
833 $fh->error and die $!;
839 my ($dctrl,$field) = @_;
840 my $v = $dctrl->{$field};
841 return $v if defined $v;
842 fail "missing field $field in ".$v->get_option('name');
846 my $c = Dpkg::Control::Hash->new();
847 my $p = new IO::Handle;
848 my @cmd = (qw(dpkg-parsechangelog), @_);
849 open $p, '-|', @cmd or die $!;
851 $?=0; $!=0; close $p or failedcmd @cmd;
857 defined $d or fail "getcwd failed: $!";
863 sub archive_query ($) {
865 my $query = access_cfg('archive-query','RETURN-UNDEF');
866 $query =~ s/^(\w+):// or badcfg "invalid archive-query method \`$query'";
869 { no strict qw(refs); &{"${method}_${proto}"}($proto,$data); }
872 sub pool_dsc_subpath ($$) {
873 my ($vsn,$component) = @_; # $package is implict arg
874 my $prefix = substr($package, 0, $package =~ m/^l/ ? 4 : 1);
875 return "/pool/$component/$prefix/$package/".dscfn($vsn);
878 #---------- `ftpmasterapi' archive query method (nascent) ----------
880 sub archive_api_query_cmd ($) {
882 my @cmd = qw(curl -sS);
883 my $url = access_cfg('archive-query-url');
884 if ($url =~ m#^https://([-.0-9a-z]+)/#) {
886 my $keys = access_cfg('archive-query-tls-key','RETURN-UNDEF') //'';
887 foreach my $key (split /\:/, $keys) {
888 $key =~ s/\%HOST\%/$host/g;
890 fail "for $url: stat $key: $!" unless $!==ENOENT;
893 fail "config requested specific TLS key but do not know".
894 " how to get curl to use exactly that EE key ($key)";
895 # push @cmd, "--cacert", $key, "--capath", "/dev/enoent";
896 # # Sadly the above line does not work because of changes
897 # # to gnutls. The real fix for #790093 may involve
898 # # new curl options.
901 # Fixing #790093 properly will involve providing a value
902 # for this on clients.
903 my $kargs = access_cfg('archive-query-tls-curl-ca-args','RETURN-UNDEF');
904 push @cmd, split / /, $kargs if defined $kargs;
906 push @cmd, $url.$subpath;
912 my ($data, $subpath) = @_;
913 badcfg "ftpmasterapi archive query method takes no data part"
915 my @cmd = archive_api_query_cmd($subpath);
916 my $json = cmdoutput @cmd;
917 return decode_json($json);
920 sub canonicalise_suite_ftpmasterapi () {
921 my ($proto,$data) = @_;
922 my $suites = api_query($data, 'suites');
924 foreach my $entry (@$suites) {
926 my $v = $entry->{$_};
927 defined $v && $v eq $isuite;
929 push @matched, $entry;
931 fail "unknown suite $isuite" unless @matched;
934 @matched==1 or die "multiple matches for suite $isuite\n";
935 $cn = "$matched[0]{codename}";
936 defined $cn or die "suite $isuite info has no codename\n";
937 $cn =~ m/^$suite_re$/ or die "suite $isuite maps to bad codename\n";
939 die "bad ftpmaster api response: $@\n".Dumper(\@matched)
944 sub archive_query_ftpmasterapi () {
945 my ($proto,$data) = @_;
946 my $info = api_query($data, "dsc_in_suite/$isuite/$package");
948 my $digester = Digest::SHA->new(256);
949 foreach my $entry (@$info) {
951 my $vsn = "$entry->{version}";
952 my ($ok,$msg) = version_check $vsn;
953 die "bad version: $msg\n" unless $ok;
954 my $component = "$entry->{component}";
955 $component =~ m/^$component_re$/ or die "bad component";
956 my $filename = "$entry->{filename}";
957 $filename && $filename !~ m#[^-+:._~0-9a-zA-Z/]|^[/.]|/[/.]#
958 or die "bad filename";
959 my $sha256sum = "$entry->{sha256sum}";
960 $sha256sum =~ m/^[0-9a-f]+$/ or die "bad sha256sum";
961 push @rows, [ $vsn, "/pool/$component/$filename",
962 $digester, $sha256sum ];
964 die "bad ftpmaster api response: $@\n".Dumper($entry)
967 @rows = sort { -version_compare($a->[0],$b->[0]) } @rows;
971 #---------- `madison' archive query method ----------
973 sub archive_query_madison {
974 return map { [ @$_[0..1] ] } madison_get_parse(@_);
977 sub madison_get_parse {
978 my ($proto,$data) = @_;
979 die unless $proto eq 'madison';
981 $data= access_cfg('madison-distro','RETURN-UNDEF');
982 $data //= access_basedistro();
984 $rmad{$proto,$data,$package} ||= cmdoutput
985 qw(rmadison -asource),"-s$isuite","-u$data",$package;
986 my $rmad = $rmad{$proto,$data,$package};
989 foreach my $l (split /\n/, $rmad) {
990 $l =~ m{^ \s*( [^ \t|]+ )\s* \|
991 \s*( [^ \t|]+ )\s* \|
992 \s*( [^ \t|/]+ )(?:/([^ \t|/]+))? \s* \|
993 \s*( [^ \t|]+ )\s* }x or die "$rmad ?";
994 $1 eq $package or die "$rmad $package ?";
1001 $component = access_cfg('archive-query-default-component');
1003 $5 eq 'source' or die "$rmad ?";
1004 push @out, [$vsn,pool_dsc_subpath($vsn,$component),$newsuite];
1006 return sort { -version_compare($a->[0],$b->[0]); } @out;
1009 sub canonicalise_suite_madison {
1010 # madison canonicalises for us
1011 my @r = madison_get_parse(@_);
1013 "unable to canonicalise suite using package $package".
1014 " which does not appear to exist in suite $isuite;".
1015 " --existing-package may help";
1019 #---------- `sshpsql' archive query method ----------
1022 my ($data,$runeinfo,$sql) = @_;
1023 if (!length $data) {
1024 $data= access_someuserhost('sshpsql').':'.
1025 access_cfg('sshpsql-dbname');
1027 $data =~ m/:/ or badcfg "invalid sshpsql method string \`$data'";
1028 my ($userhost,$dbname) = ($`,$'); #';
1030 my @cmd = (access_cfg_ssh, $userhost,
1031 access_runeinfo("ssh-psql $runeinfo").
1032 " export LC_MESSAGES=C; export LC_CTYPE=C;".
1033 " ".shellquote qw(psql -A), $dbname, qw(-c), $sql);
1035 open P, "-|", @cmd or die $!;
1038 printdebug(">|$_|\n");
1041 $!=0; $?=0; close P or failedcmd @cmd;
1043 my $nrows = pop @rows;
1044 $nrows =~ s/^\((\d+) rows?\)$/$1/ or die "$nrows ?";
1045 @rows == $nrows+1 or die "$nrows ".(scalar @rows)." ?";
1046 @rows = map { [ split /\|/, $_ ] } @rows;
1047 my $ncols = scalar @{ shift @rows };
1048 die if grep { scalar @$_ != $ncols } @rows;
1052 sub sql_injection_check {
1053 foreach (@_) { die "$_ $& ?" if m{[^-+=:_.,/0-9a-zA-Z]}; }
1056 sub archive_query_sshpsql ($$) {
1057 my ($proto,$data) = @_;
1058 sql_injection_check $isuite, $package;
1059 my @rows = sshpsql($data, "archive-query $isuite $package", <<END);
1060 SELECT source.version, component.name, files.filename, files.sha256sum
1062 JOIN src_associations ON source.id = src_associations.source
1063 JOIN suite ON suite.id = src_associations.suite
1064 JOIN dsc_files ON dsc_files.source = source.id
1065 JOIN files_archive_map ON files_archive_map.file_id = dsc_files.file
1066 JOIN component ON component.id = files_archive_map.component_id
1067 JOIN files ON files.id = dsc_files.file
1068 WHERE ( suite.suite_name='$isuite' OR suite.codename='$isuite' )
1069 AND source.source='$package'
1070 AND files.filename LIKE '%.dsc';
1072 @rows = sort { -version_compare($a->[0],$b->[0]) } @rows;
1073 my $digester = Digest::SHA->new(256);
1075 my ($vsn,$component,$filename,$sha256sum) = @$_;
1076 [ $vsn, "/pool/$component/$filename",$digester,$sha256sum ];
1081 sub canonicalise_suite_sshpsql ($$) {
1082 my ($proto,$data) = @_;
1083 sql_injection_check $isuite;
1084 my @rows = sshpsql($data, "canonicalise-suite $isuite", <<END);
1085 SELECT suite.codename
1086 FROM suite where suite_name='$isuite' or codename='$isuite';
1088 @rows = map { $_->[0] } @rows;
1089 fail "unknown suite $isuite" unless @rows;
1090 die "ambiguous $isuite: @rows ?" if @rows>1;
1094 #---------- `dummycat' archive query method ----------
1096 sub canonicalise_suite_dummycat ($$) {
1097 my ($proto,$data) = @_;
1098 my $dpath = "$data/suite.$isuite";
1099 if (!open C, "<", $dpath) {
1100 $!==ENOENT or die "$dpath: $!";
1101 printdebug "dummycat canonicalise_suite $isuite $dpath ENOENT\n";
1105 chomp or die "$dpath: $!";
1107 printdebug "dummycat canonicalise_suite $isuite $dpath = $_\n";
1111 sub archive_query_dummycat ($$) {
1112 my ($proto,$data) = @_;
1113 canonicalise_suite();
1114 my $dpath = "$data/package.$csuite.$package";
1115 if (!open C, "<", $dpath) {
1116 $!==ENOENT or die "$dpath: $!";
1117 printdebug "dummycat query $csuite $package $dpath ENOENT\n";
1125 printdebug "dummycat query $csuite $package $dpath | $_\n";
1126 my @row = split /\s+/, $_;
1127 @row==2 or die "$dpath: $_ ?";
1130 C->error and die "$dpath: $!";
1132 return sort { -version_compare($a->[0],$b->[0]); } @rows;
1135 #---------- tag format handling ----------
1137 sub access_cfg_tagformats () {
1138 split /\,/, access_cfg('dgit-tag-format');
1141 sub select_tagformat () {
1143 return if $tagformatfn && !$tagformat_want;
1144 die 'bug' if $tagformatfn && $tagformat_want;
1145 # ... $tagformat_want assigned after previous select_tagformat
1147 my (@supported) = access_cfg_tagformats();
1148 printdebug "select_tagformat supported @supported\n";
1150 $tagformat_want //= [ $supported[0], "distro access configuration", 0 ];
1151 printdebug "select_tagformat specified @$tagformat_want\n";
1153 my ($fmt,$why,$override) = @$tagformat_want;
1155 fail "target distro supports tag formats @supported".
1156 " but have to use $fmt ($why)"
1158 or grep { $_ eq $fmt } @supported;
1160 $tagformat_want = undef;
1162 $tagformatfn = ${*::}{"debiantag_$fmt"};
1164 fail "trying to use unknown tag format \`$fmt' ($why) !"
1165 unless $tagformatfn;
1168 #---------- archive query entrypoints and rest of program ----------
1170 sub canonicalise_suite () {
1171 return if defined $csuite;
1172 fail "cannot operate on $isuite suite" if $isuite eq 'UNRELEASED';
1173 $csuite = archive_query('canonicalise_suite');
1174 if ($isuite ne $csuite) {
1175 progress "canonical suite name for $isuite is $csuite";
1179 sub get_archive_dsc () {
1180 canonicalise_suite();
1181 my @vsns = archive_query('archive_query');
1182 foreach my $vinfo (@vsns) {
1183 my ($vsn,$subpath,$digester,$digest) = @$vinfo;
1184 $dscurl = access_cfg('mirror').$subpath;
1185 $dscdata = url_get($dscurl);
1187 $skew_warning_vsn = $vsn if !defined $skew_warning_vsn;
1192 $digester->add($dscdata);
1193 my $got = $digester->hexdigest();
1195 fail "$dscurl has hash $got but".
1196 " archive told us to expect $digest";
1198 my $dscfh = new IO::File \$dscdata, '<' or die $!;
1199 printdebug Dumper($dscdata) if $debuglevel>1;
1200 $dsc = parsecontrolfh($dscfh,$dscurl,1);
1201 printdebug Dumper($dsc) if $debuglevel>1;
1202 my $fmt = getfield $dsc, 'Format';
1203 fail "unsupported source format $fmt, sorry" unless $format_ok{$fmt};
1204 $dsc_checked = !!$digester;
1210 sub check_for_git ();
1211 sub check_for_git () {
1213 my $how = access_cfg('git-check');
1214 if ($how eq 'ssh-cmd') {
1216 (access_cfg_ssh, access_gituserhost(),
1217 access_runeinfo("git-check $package").
1218 " set -e; cd ".access_cfg('git-path').";".
1219 " if test -d $package.git; then echo 1; else echo 0; fi");
1220 my $r= cmdoutput @cmd;
1221 if (defined $r and $r =~ m/^divert (\w+)$/) {
1223 my ($usedistro,) = access_distros();
1224 # NB that if we are pushing, $usedistro will be $distro/push
1225 $instead_distro= cfg("dgit-distro.$usedistro.diverts.$divert");
1226 $instead_distro =~ s{^/}{ access_basedistro()."/" }e;
1227 progress "diverting to $divert (using config for $instead_distro)";
1228 return check_for_git();
1230 failedcmd @cmd unless defined $r and $r =~ m/^[01]$/;
1232 } elsif ($how eq 'url') {
1233 my $prefix = access_cfg('git-check-url','git-url');
1234 my $suffix = access_cfg('git-check-suffix','git-suffix',
1235 'RETURN-UNDEF') // '.git';
1236 my $url = "$prefix/$package$suffix";
1237 my @cmd = (qw(curl -sS -I), $url);
1238 my $result = cmdoutput @cmd;
1239 $result =~ s/^\S+ 200 .*\n\r?\n//;
1240 # curl -sS -I with https_proxy prints
1241 # HTTP/1.0 200 Connection established
1242 $result =~ m/^\S+ (404|200) /s or
1243 fail "unexpected results from git check query - ".
1244 Dumper($prefix, $result);
1246 if ($code eq '404') {
1248 } elsif ($code eq '200') {
1253 } elsif ($how eq 'true') {
1255 } elsif ($how eq 'false') {
1258 badcfg "unknown git-check \`$how'";
1262 sub create_remote_git_repo () {
1263 my $how = access_cfg('git-create');
1264 if ($how eq 'ssh-cmd') {
1266 (access_cfg_ssh, access_gituserhost(),
1267 access_runeinfo("git-create $package").
1268 "set -e; cd ".access_cfg('git-path').";".
1269 " cp -a _template $package.git");
1270 } elsif ($how eq 'true') {
1273 badcfg "unknown git-create \`$how'";
1277 our ($dsc_hash,$lastpush_hash);
1279 our $ud = '.git/dgit/unpack';
1289 sub mktree_in_ud_here () {
1290 runcmd qw(git init -q);
1291 rmtree('.git/objects');
1292 symlink '../../../../objects','.git/objects' or die $!;
1295 sub git_write_tree () {
1296 my $tree = cmdoutput @git, qw(write-tree);
1297 $tree =~ m/^\w+$/ or die "$tree ?";
1301 sub remove_stray_gits () {
1302 my @gitscmd = qw(find -name .git -prune -print0);
1303 debugcmd "|",@gitscmd;
1304 open GITS, "-|", @gitscmd or die $!;
1309 print STDERR "$us: warning: removing from source package: ",
1310 (messagequote $_), "\n";
1314 $!=0; $?=0; close GITS or failedcmd @gitscmd;
1317 sub mktree_in_ud_from_only_subdir () {
1318 # changes into the subdir
1320 die "@dirs ?" unless @dirs==1;
1321 $dirs[0] =~ m#^([^/]+)/\.$# or die;
1325 remove_stray_gits();
1326 mktree_in_ud_here();
1327 my ($format, $fopts) = get_source_format();
1328 if (madformat($format)) {
1331 runcmd @git, qw(add -Af);
1332 my $tree=git_write_tree();
1333 return ($tree,$dir);
1336 sub dsc_files_info () {
1337 foreach my $csumi (['Checksums-Sha256','Digest::SHA', 'new(256)'],
1338 ['Checksums-Sha1', 'Digest::SHA', 'new(1)'],
1339 ['Files', 'Digest::MD5', 'new()']) {
1340 my ($fname, $module, $method) = @$csumi;
1341 my $field = $dsc->{$fname};
1342 next unless defined $field;
1343 eval "use $module; 1;" or die $@;
1345 foreach (split /\n/, $field) {
1347 m/^(\w+) (\d+) (\S+)$/ or
1348 fail "could not parse .dsc $fname line \`$_'";
1349 my $digester = eval "$module"."->$method;" or die $@;
1354 Digester => $digester,
1359 fail "missing any supported Checksums-* or Files field in ".
1360 $dsc->get_option('name');
1364 map { $_->{Filename} } dsc_files_info();
1367 sub is_orig_file ($;$) {
1370 m/\.orig(?:-\w+)?\.tar\.\w+$/ or return 0;
1371 defined $base or return 1;
1375 sub make_commit ($) {
1377 return cmdoutput @git, qw(hash-object -w -t commit), $file;
1380 sub clogp_authline ($) {
1382 my $author = getfield $clogp, 'Maintainer';
1383 $author =~ s#,.*##ms;
1384 my $date = cmdoutput qw(date), '+%s %z', qw(-d), getfield($clogp,'Date');
1385 my $authline = "$author $date";
1386 $authline =~ m/$git_authline_re/o or
1387 fail "unexpected commit author line format \`$authline'".
1388 " (was generated from changelog Maintainer field)";
1389 return ($1,$2,$3) if wantarray;
1393 sub vendor_patches_distro ($$) {
1394 my ($checkdistro, $what) = @_;
1395 return unless defined $checkdistro;
1397 my $series = "debian/patches/\L$checkdistro\E.series";
1398 printdebug "checking for vendor-specific $series ($what)\n";
1400 if (!open SERIES, "<", $series) {
1401 die "$series $!" unless $!==ENOENT;
1410 Unfortunately, this source package uses a feature of dpkg-source where
1411 the same source package unpacks to different source code on different
1412 distros. dgit cannot safely operate on such packages on affected
1413 distros, because the meaning of source packages is not stable.
1415 Please ask the distro/maintainer to remove the distro-specific series
1416 files and use a different technique (if necessary, uploading actually
1417 different packages, if different distros are supposed to have
1421 fail "Found active distro-specific series file for".
1422 " $checkdistro ($what): $series, cannot continue";
1424 die "$series $!" if SERIES->error;
1428 sub check_for_vendor_patches () {
1429 # This dpkg-source feature doesn't seem to be documented anywhere!
1430 # But it can be found in the changelog (reformatted):
1432 # commit 4fa01b70df1dc4458daee306cfa1f987b69da58c
1433 # Author: Raphael Hertzog <hertzog@debian.org>
1434 # Date: Sun Oct 3 09:36:48 2010 +0200
1436 # dpkg-source: correctly create .pc/.quilt_series with alternate
1439 # If you have debian/patches/ubuntu.series and you were
1440 # unpacking the source package on ubuntu, quilt was still
1441 # directed to debian/patches/series instead of
1442 # debian/patches/ubuntu.series.
1444 # debian/changelog | 3 +++
1445 # scripts/Dpkg/Source/Package/V3/quilt.pm | 4 +++-
1446 # 2 files changed, 6 insertions(+), 1 deletion(-)
1449 vendor_patches_distro($ENV{DEB_VENDOR}, "DEB_VENDOR");
1450 vendor_patches_distro(Dpkg::Vendor::get_current_vendor(),
1451 "Dpkg::Vendor \`current vendor'");
1452 vendor_patches_distro(access_basedistro(),
1453 "distro being accessed");
1456 sub generate_commit_from_dsc () {
1460 foreach my $fi (dsc_files_info()) {
1461 my $f = $fi->{Filename};
1462 die "$f ?" if $f =~ m#/|^\.|\.dsc$|\.tmp$#;
1464 link_ltarget "../../../$f", $f
1468 complete_file_from_dsc('.', $fi)
1471 if (is_orig_file($f)) {
1472 link $f, "../../../../$f"
1478 my $dscfn = "$package.dsc";
1480 open D, ">", $dscfn or die "$dscfn: $!";
1481 print D $dscdata or die "$dscfn: $!";
1482 close D or die "$dscfn: $!";
1483 my @cmd = qw(dpkg-source);
1484 push @cmd, '--no-check' if $dsc_checked;
1485 push @cmd, qw(-x --), $dscfn;
1488 my ($tree,$dir) = mktree_in_ud_from_only_subdir();
1489 check_for_vendor_patches() if madformat($dsc->{format});
1490 runcmd qw(sh -ec), 'dpkg-parsechangelog >../changelog.tmp';
1491 my $clogp = parsecontrol('../changelog.tmp',"commit's changelog");
1492 my $authline = clogp_authline $clogp;
1493 my $changes = getfield $clogp, 'Changes';
1494 open C, ">../commit.tmp" or die $!;
1495 print C <<END or die $!;
1502 # imported from the archive
1505 my $outputhash = make_commit qw(../commit.tmp);
1506 my $cversion = getfield $clogp, 'Version';
1507 progress "synthesised git commit from .dsc $cversion";
1508 if ($lastpush_hash) {
1509 runcmd @git, qw(reset -q --hard), $lastpush_hash;
1510 runcmd qw(sh -ec), 'dpkg-parsechangelog >>../changelogold.tmp';
1511 my $oldclogp = parsecontrol('../changelogold.tmp','previous changelog');
1512 my $oversion = getfield $oldclogp, 'Version';
1514 version_compare($oversion, $cversion);
1516 # git upload/ is earlier vsn than archive, use archive
1517 open C, ">../commit2.tmp" or die $!;
1518 print C <<END or die $!;
1520 parent $lastpush_hash
1525 Record $package ($cversion) in archive suite $csuite
1527 $outputhash = make_commit qw(../commit2.tmp);
1528 } elsif ($vcmp > 0) {
1529 print STDERR <<END or die $!;
1531 Version actually in archive: $cversion (older)
1532 Last allegedly pushed/uploaded: $oversion (newer or same)
1535 $outputhash = $lastpush_hash;
1537 $outputhash = $lastpush_hash;
1540 changedir '../../../..';
1541 runcmd @git, qw(update-ref -m),"dgit fetch import $cversion",
1542 'DGIT_ARCHIVE', $outputhash;
1543 cmdoutput @git, qw(log -n2), $outputhash;
1544 # ... gives git a chance to complain if our commit is malformed
1549 sub complete_file_from_dsc ($$) {
1550 our ($dstdir, $fi) = @_;
1551 # Ensures that we have, in $dir, the file $fi, with the correct
1552 # contents. (Downloading it from alongside $dscurl if necessary.)
1554 my $f = $fi->{Filename};
1555 my $tf = "$dstdir/$f";
1558 if (stat_exists $tf) {
1559 progress "using existing $f";
1562 $furl =~ s{/[^/]+$}{};
1564 die "$f ?" unless $f =~ m/^\Q${package}\E_/;
1565 die "$f ?" if $f =~ m#/#;
1566 runcmd_ordryrun_local @curl,qw(-o),$tf,'--',"$furl";
1567 return 0 if !act_local();
1571 open F, "<", "$tf" or die "$tf: $!";
1572 $fi->{Digester}->reset();
1573 $fi->{Digester}->addfile(*F);
1574 F->error and die $!;
1575 my $got = $fi->{Digester}->hexdigest();
1576 $got eq $fi->{Hash} or
1577 fail "file $f has hash $got but .dsc".
1578 " demands hash $fi->{Hash} ".
1579 ($downloaded ? "(got wrong file from archive!)"
1580 : "(perhaps you should delete this file?)");
1585 sub ensure_we_have_orig () {
1586 foreach my $fi (dsc_files_info()) {
1587 my $f = $fi->{Filename};
1588 next unless is_orig_file($f);
1589 complete_file_from_dsc('..', $fi)
1594 sub git_fetch_us () {
1595 my @specs = (fetchspec());
1597 map { "+refs/$_/*:".lrfetchrefs."/$_/*" }
1599 runcmd_ordryrun_local @git, qw(fetch -p -n -q), access_giturl(), @specs;
1602 my @tagpats = debiantags('*',access_basedistro);
1604 git_for_each_ref([map { "refs/tags/$_" } @tagpats], sub {
1605 my ($objid,$objtype,$fullrefname,$reftail) = @_;
1606 printdebug "currently $fullrefname=$objid\n";
1607 $here{$fullrefname} = $objid;
1609 git_for_each_ref([map { lrfetchrefs."/tags/".$_ } @tagpats], sub {
1610 my ($objid,$objtype,$fullrefname,$reftail) = @_;
1611 my $lref = "refs".substr($fullrefname, length lrfetchrefs);
1612 printdebug "offered $lref=$objid\n";
1613 if (!defined $here{$lref}) {
1614 my @upd = (@git, qw(update-ref), $lref, $objid, '');
1615 runcmd_ordryrun_local @upd;
1616 } elsif ($here{$lref} eq $objid) {
1619 "Not updateting $lref from $here{$lref} to $objid.\n";
1624 sub fetch_from_archive () {
1625 # ensures that lrref() is what is actually in the archive,
1626 # one way or another
1630 foreach my $field (@ourdscfield) {
1631 $dsc_hash = $dsc->{$field};
1632 last if defined $dsc_hash;
1634 if (defined $dsc_hash) {
1635 $dsc_hash =~ m/\w+/ or fail "invalid hash in .dsc \`$dsc_hash'";
1637 progress "last upload to archive specified git hash";
1639 progress "last upload to archive has NO git hash";
1642 progress "no version available from the archive";
1645 $lastpush_hash = git_get_ref(lrref());
1646 printdebug "previous reference hash=$lastpush_hash\n";
1648 if (defined $dsc_hash) {
1649 fail "missing remote git history even though dsc has hash -".
1650 " could not find ref ".lrref().
1651 " (should have been fetched from ".access_giturl()."#".rrref().")"
1652 unless $lastpush_hash;
1654 ensure_we_have_orig();
1655 if ($dsc_hash eq $lastpush_hash) {
1656 } elsif (is_fast_fwd($dsc_hash,$lastpush_hash)) {
1657 print STDERR <<END or die $!;
1659 Git commit in archive is behind the last version allegedly pushed/uploaded.
1660 Commit referred to by archive: $dsc_hash
1661 Last allegedly pushed/uploaded: $lastpush_hash
1664 $hash = $lastpush_hash;
1666 fail "git head (".lrref()."=$lastpush_hash) is not a ".
1667 "descendant of archive's .dsc hash ($dsc_hash)";
1670 $hash = generate_commit_from_dsc();
1671 } elsif ($lastpush_hash) {
1672 # only in git, not in the archive yet
1673 $hash = $lastpush_hash;
1674 print STDERR <<END or die $!;
1676 Package not found in the archive, but has allegedly been pushed using dgit.
1680 printdebug "nothing found!\n";
1681 if (defined $skew_warning_vsn) {
1682 print STDERR <<END or die $!;
1684 Warning: relevant archive skew detected.
1685 Archive allegedly contains $skew_warning_vsn
1686 But we were not able to obtain any version from the archive or git.
1692 printdebug "current hash=$hash\n";
1693 if ($lastpush_hash) {
1694 fail "not fast forward on last upload branch!".
1695 " (archive's version left in DGIT_ARCHIVE)"
1696 unless is_fast_fwd($lastpush_hash, $hash);
1698 if (defined $skew_warning_vsn) {
1700 printdebug "SKEW CHECK WANT $skew_warning_vsn\n";
1701 my $clogf = ".git/dgit/changelog.tmp";
1702 runcmd shell_cmd "exec >$clogf",
1703 @git, qw(cat-file blob), "$hash:debian/changelog";
1704 my $gotclogp = parsechangelog("-l$clogf");
1705 my $got_vsn = getfield $gotclogp, 'Version';
1706 printdebug "SKEW CHECK GOT $got_vsn\n";
1707 if (version_compare($got_vsn, $skew_warning_vsn) < 0) {
1708 print STDERR <<END or die $!;
1710 Warning: archive skew detected. Using the available version:
1711 Archive allegedly contains $skew_warning_vsn
1712 We were able to obtain only $got_vsn
1717 if ($lastpush_hash ne $hash) {
1718 my @upd_cmd = (@git, qw(update-ref -m), 'dgit fetch', lrref(), $hash);
1722 dryrun_report @upd_cmd;
1728 sub set_local_git_config ($$) {
1730 runcmd @git, qw(config), $k, $v;
1733 sub setup_mergechangelogs (;$) {
1735 return unless $always || access_cfg_bool(1, 'setup-mergechangelogs');
1737 my $driver = 'dpkg-mergechangelogs';
1738 my $cb = "merge.$driver";
1739 my $attrs = '.git/info/attributes';
1740 ensuredir '.git/info';
1742 open NATTRS, ">", "$attrs.new" or die "$attrs.new $!";
1743 if (!open ATTRS, "<", $attrs) {
1744 $!==ENOENT or die "$attrs: $!";
1748 next if m{^debian/changelog\s};
1749 print NATTRS $_, "\n" or die $!;
1751 ATTRS->error and die $!;
1754 print NATTRS "debian/changelog merge=$driver\n" or die $!;
1757 set_local_git_config "$cb.name", 'debian/changelog merge driver';
1758 set_local_git_config "$cb.driver", 'dpkg-mergechangelogs -m %O %A %B %A';
1760 rename "$attrs.new", "$attrs" or die "$attrs: $!";
1763 sub setup_useremail (;$) {
1765 return unless $always || access_cfg_bool(1, 'setup-useremail');
1768 my ($k, $envvar) = @_;
1769 my $v = access_cfg("user-$k", 'RETURN-UNDEF') // $ENV{$envvar};
1770 return unless defined $v;
1771 set_local_git_config "user.$k", $v;
1774 $setup->('email', 'DEBEMAIL');
1775 $setup->('name', 'DEBFULLNAME');
1778 sub setup_new_tree () {
1779 setup_mergechangelogs();
1785 canonicalise_suite();
1786 badusage "dry run makes no sense with clone" unless act_local();
1787 my $hasgit = check_for_git();
1788 mkdir $dstdir or fail "create \`$dstdir': $!";
1790 runcmd @git, qw(init -q);
1791 my $giturl = access_giturl(1);
1792 if (defined $giturl) {
1793 set_local_git_config "remote.$remotename.fetch", fetchspec();
1794 open H, "> .git/HEAD" or die $!;
1795 print H "ref: ".lref()."\n" or die $!;
1797 runcmd @git, qw(remote add), 'origin', $giturl;
1800 progress "fetching existing git history";
1802 runcmd_ordryrun_local @git, qw(fetch origin);
1804 progress "starting new git history";
1806 fetch_from_archive() or no_such_package;
1807 my $vcsgiturl = $dsc->{'Vcs-Git'};
1808 if (length $vcsgiturl) {
1809 $vcsgiturl =~ s/\s+-b\s+\S+//g;
1810 runcmd @git, qw(remote add vcs-git), $vcsgiturl;
1813 runcmd @git, qw(reset --hard), lrref();
1814 printdone "ready for work in $dstdir";
1818 if (check_for_git()) {
1821 fetch_from_archive() or no_such_package();
1822 printdone "fetched into ".lrref();
1827 runcmd_ordryrun_local @git, qw(merge -m),"Merge from $csuite [dgit]",
1829 printdone "fetched to ".lrref()." and merged into HEAD";
1832 sub check_not_dirty () {
1833 foreach my $f (qw(local-options local-patch-header)) {
1834 if (stat_exists "debian/source/$f") {
1835 fail "git tree contains debian/source/$f";
1839 return if $ignoredirty;
1841 my @cmd = (@git, qw(diff --quiet HEAD));
1843 $!=0; $?=-1; system @cmd;
1846 fail "working tree is dirty (does not match HEAD)";
1852 sub commit_admin ($) {
1855 runcmd_ordryrun_local @git, qw(commit -m), $m;
1858 sub commit_quilty_patch () {
1859 my $output = cmdoutput @git, qw(status --porcelain);
1861 foreach my $l (split /\n/, $output) {
1862 next unless $l =~ m/\S/;
1863 if ($l =~ m{^(?:\?\?| M) (.pc|debian/patches)}) {
1867 delete $adds{'.pc'}; # if there wasn't one before, don't add it
1869 progress "nothing quilty to commit, ok.";
1872 my @adds = map { s/[][*?\\]/\\$&/g; $_; } sort keys %adds;
1873 runcmd_ordryrun_local @git, qw(add -f), @adds;
1874 commit_admin "Commit Debian 3.0 (quilt) metadata";
1877 sub get_source_format () {
1879 if (open F, "debian/source/options") {
1883 s/\s+$//; # ignore missing final newline
1885 my ($k, $v) = ($`, $'); #');
1886 $v =~ s/^"(.*)"$/$1/;
1892 F->error and die $!;
1895 die $! unless $!==&ENOENT;
1898 if (!open F, "debian/source/format") {
1899 die $! unless $!==&ENOENT;
1903 F->error and die $!;
1905 return ($_, \%options);
1910 return 0 unless $format eq '3.0 (quilt)';
1911 our $quilt_mode_warned;
1912 if ($quilt_mode eq 'nocheck') {
1913 progress "Not doing any fixup of \`$format' due to".
1914 " ----no-quilt-fixup or --quilt=nocheck"
1915 unless $quilt_mode_warned++;
1918 progress "Format \`$format', need to check/update patch stack"
1919 unless $quilt_mode_warned++;
1923 sub push_parse_changelog ($) {
1926 my $clogp = Dpkg::Control::Hash->new();
1927 $clogp->load($clogpfn) or die;
1929 $package = getfield $clogp, 'Source';
1930 my $cversion = getfield $clogp, 'Version';
1931 my $tag = debiantag($cversion, access_basedistro);
1932 runcmd @git, qw(check-ref-format), $tag;
1934 my $dscfn = dscfn($cversion);
1936 return ($clogp, $cversion, $tag, $dscfn);
1939 sub push_parse_dsc ($$$) {
1940 my ($dscfn,$dscfnwhat, $cversion) = @_;
1941 $dsc = parsecontrol($dscfn,$dscfnwhat);
1942 my $dversion = getfield $dsc, 'Version';
1943 my $dscpackage = getfield $dsc, 'Source';
1944 ($dscpackage eq $package && $dversion eq $cversion) or
1945 fail "$dscfn is for $dscpackage $dversion".
1946 " but debian/changelog is for $package $cversion";
1949 sub push_mktag ($$$$$$$) {
1950 my ($dgithead,$clogp,$dgittag,
1952 $changesfile,$changesfilewhat,
1955 $dsc->{$ourdscfield[0]} = $dgithead;
1956 $dsc->save("$dscfn.tmp") or die $!;
1958 my $changes = parsecontrol($changesfile,$changesfilewhat);
1959 foreach my $field (qw(Source Distribution Version)) {
1960 $changes->{$field} eq $clogp->{$field} or
1961 fail "changes field $field \`$changes->{$field}'".
1962 " does not match changelog \`$clogp->{$field}'";
1965 my $cversion = getfield $clogp, 'Version';
1966 my $clogsuite = getfield $clogp, 'Distribution';
1968 # We make the git tag by hand because (a) that makes it easier
1969 # to control the "tagger" (b) we can do remote signing
1970 my $authline = clogp_authline $clogp;
1971 my $delibs = join(" ", "",@deliberatelies);
1972 my $declaredistro = access_basedistro();
1975 my ($tfn, $head, $tag) = @_;
1977 open TO, '>', $tfn->('.tmp') or die $!;
1978 print TO <<END or die $!;
1984 $package release $cversion for $clogsuite ($csuite) [dgit]
1985 [dgit distro=$declaredistro$delibs]
1987 foreach my $ref (sort keys %previously) {
1988 print TO <<END or die $!;
1989 [dgit previously:$ref=$previously{$ref}]
1995 my $tagobjfn = $tfn->('.tmp');
1997 if (!defined $keyid) {
1998 $keyid = access_cfg('keyid','RETURN-UNDEF');
2000 if (!defined $keyid) {
2001 $keyid = getfield $clogp, 'Maintainer';
2003 unlink $tfn->('.tmp.asc') or $!==&ENOENT or die $!;
2004 my @sign_cmd = (@gpg, qw(--detach-sign --armor));
2005 push @sign_cmd, qw(-u),$keyid if defined $keyid;
2006 push @sign_cmd, $tfn->('.tmp');
2007 runcmd_ordryrun @sign_cmd;
2009 $tagobjfn = $tfn->('.signed.tmp');
2010 runcmd shell_cmd "exec >$tagobjfn", qw(cat --),
2011 $tfn->('.tmp'), $tfn->('.tmp.asc');
2018 push @r, $mktag->($tfnbase, $dgithead, $dgittag);
2022 sub sign_changes ($) {
2023 my ($changesfile) = @_;
2025 my @debsign_cmd = @debsign;
2026 push @debsign_cmd, "-k$keyid" if defined $keyid;
2027 push @debsign_cmd, "-p$gpg[0]" if $gpg[0] ne 'gpg';
2028 push @debsign_cmd, $changesfile;
2029 runcmd_ordryrun @debsign_cmd;
2034 my ($forceflag) = @_;
2035 printdebug "actually entering push\n";
2036 supplementary_message(<<'END');
2037 Push failed, while preparing your push.
2038 You can retry the push, after fixing the problem, if you like.
2042 access_giturl(); # check that success is vaguely likely
2045 my $clogpfn = ".git/dgit/changelog.822.tmp";
2046 runcmd shell_cmd "exec >$clogpfn", qw(dpkg-parsechangelog);
2048 responder_send_file('parsed-changelog', $clogpfn);
2050 my ($clogp, $cversion, $tag, $dscfn) =
2051 push_parse_changelog("$clogpfn");
2053 my $dscpath = "$buildproductsdir/$dscfn";
2054 stat_exists $dscpath or
2055 fail "looked for .dsc $dscfn, but $!;".
2056 " maybe you forgot to build";
2058 responder_send_file('dsc', $dscpath);
2060 push_parse_dsc($dscpath, $dscfn, $cversion);
2062 my $format = getfield $dsc, 'Format';
2063 printdebug "format $format\n";
2065 my $head = git_rev_parse('HEAD');
2067 if (madformat($format)) {
2068 # user might have not used dgit build, so maybe do this now:
2069 if (quiltmode_splitbrain()) {
2070 my $upstreamversion = $clogp->{Version};
2071 $upstreamversion =~ s/-[^-]*$//;
2073 quilt_make_fake_dsc($upstreamversion);
2074 my ($dgitview, $cachekey) =
2075 quilt_check_splitbrain_cache($head, $upstreamversion);
2077 "--quilt=$quilt_mode but no cached dgit view:
2078 perhaps tree changed since dgit build[-source] ?";
2080 changedir '../../../..';
2081 prep_ud(); # so _only_subdir() works, below
2083 commit_quilty_patch();
2087 die 'xxx fast forward (should not depend on quilt mode, but will always be needed if we did $split_brain)' if $split_brain;
2091 progress "checking that $dscfn corresponds to HEAD";
2092 runcmd qw(dpkg-source -x --),
2093 $dscpath =~ m#^/# ? $dscpath : "../../../$dscpath";
2094 my ($tree,$dir) = mktree_in_ud_from_only_subdir();
2095 check_for_vendor_patches() if madformat($dsc->{format});
2096 changedir '../../../..';
2097 my $diffopt = $debuglevel>0 ? '--exit-code' : '--quiet';
2098 my @diffcmd = (@git, qw(diff), $diffopt, $tree);
2099 debugcmd "+",@diffcmd;
2101 my $r = system @diffcmd;
2104 fail "$dscfn specifies a different tree to your HEAD commit;".
2105 " perhaps you forgot to build".
2106 ($diffopt eq '--exit-code' ? "" :
2107 " (run with -D to see full diff output)");
2112 if (!$changesfile) {
2113 my $pat = changespat $cversion;
2114 my @cs = glob "$buildproductsdir/$pat";
2115 fail "failed to find unique changes file".
2116 " (looked for $pat in $buildproductsdir);".
2117 " perhaps you need to use dgit -C"
2119 ($changesfile) = @cs;
2121 $changesfile = "$buildproductsdir/$changesfile";
2124 responder_send_file('changes',$changesfile);
2125 responder_send_command("param head $head");
2126 responder_send_command("param csuite $csuite");
2127 responder_send_command("param tagformat $tagformat");
2129 if (deliberately_not_fast_forward) {
2130 git_for_each_ref(lrfetchrefs, sub {
2131 my ($objid,$objtype,$lrfetchrefname,$reftail) = @_;
2132 my $rrefname= substr($lrfetchrefname, length(lrfetchrefs) + 1);
2133 responder_send_command("previously $rrefname=$objid");
2134 $previously{$rrefname} = $objid;
2138 my $tfn = sub { ".git/dgit/tag$_[0]"; };
2141 supplementary_message(<<'END');
2142 Push failed, while signing the tag.
2143 You can retry the push, after fixing the problem, if you like.
2145 # If we manage to sign but fail to record it anywhere, it's fine.
2146 if ($we_are_responder) {
2147 $tagobjfn = $tfn->('.signed.tmp');
2148 responder_receive_files('signed-tag', $tagobjfn);
2151 push_mktag($head,$clogp,$tag,
2153 $changesfile,$changesfile,
2156 supplementary_message(<<'END');
2157 Push failed, *after* signing the tag.
2158 If you want to try again, you should use a new version number.
2161 my $tag_obj_hash = cmdoutput @git, qw(hash-object -w -t tag), $tagobjfn;
2162 runcmd_ordryrun @git, qw(verify-tag), $tag_obj_hash;
2163 runcmd_ordryrun_local @git, qw(update-ref), "refs/tags/$tag", $tag_obj_hash;
2165 supplementary_message(<<'END');
2166 Push failed, while updating the remote git repository - see messages above.
2167 If you want to try again, you should use a new version number.
2169 if (!check_for_git()) {
2170 create_remote_git_repo();
2172 runcmd_ordryrun @git, qw(push),access_giturl(),
2173 $forceflag."HEAD:".rrref(), $forceflag."refs/tags/$tag";
2174 runcmd_ordryrun @git, qw(update-ref -m), 'dgit push', lrref(), 'HEAD';
2176 supplementary_message(<<'END');
2177 Push failed, after updating the remote git repository.
2178 If you want to try again, you must use a new version number.
2180 if ($we_are_responder) {
2181 my $dryrunsuffix = act_local() ? "" : ".tmp";
2182 responder_receive_files('signed-dsc-changes',
2183 "$dscpath$dryrunsuffix",
2184 "$changesfile$dryrunsuffix");
2187 rename "$dscpath.tmp",$dscpath or die "$dscfn $!";
2189 progress "[new .dsc left in $dscpath.tmp]";
2191 sign_changes $changesfile;
2194 supplementary_message(<<END);
2195 Push failed, while uploading package(s) to the archive server.
2196 You can retry the upload of exactly these same files with dput of:
2198 If that .changes file is broken, you will need to use a new version
2199 number for your next attempt at the upload.
2201 my $host = access_cfg('upload-host','RETURN-UNDEF');
2202 my @hostarg = defined($host) ? ($host,) : ();
2203 runcmd_ordryrun @dput, @hostarg, $changesfile;
2204 printdone "pushed and uploaded $cversion";
2206 supplementary_message('');
2207 responder_send_command("complete");
2214 badusage "-p is not allowed with clone; specify as argument instead"
2215 if defined $package;
2218 } elsif (@ARGV==2 && $ARGV[1] =~ m#^\w#) {
2219 ($package,$isuite) = @ARGV;
2220 } elsif (@ARGV==2 && $ARGV[1] =~ m#^[./]#) {
2221 ($package,$dstdir) = @ARGV;
2222 } elsif (@ARGV==3) {
2223 ($package,$isuite,$dstdir) = @ARGV;
2225 badusage "incorrect arguments to dgit clone";
2227 $dstdir ||= "$package";
2229 if (stat_exists $dstdir) {
2230 fail "$dstdir already exists";
2234 if ($rmonerror && !$dryrun_level) {
2235 $cwd_remove= getcwd();
2237 return unless defined $cwd_remove;
2238 if (!chdir "$cwd_remove") {
2239 return if $!==&ENOENT;
2240 die "chdir $cwd_remove: $!";
2243 rmtree($dstdir) or die "remove $dstdir: $!\n";
2244 } elsif (!grep { $! == $_ }
2245 (ENOENT, ENOTDIR, EACCES, EPERM, ELOOP)) {
2247 print STDERR "check whether to remove $dstdir: $!\n";
2253 $cwd_remove = undef;
2256 sub branchsuite () {
2257 my $branch = cmdoutput_errok @git, qw(symbolic-ref HEAD);
2258 if ($branch =~ m#$lbranch_re#o) {
2265 sub fetchpullargs () {
2267 if (!defined $package) {
2268 my $sourcep = parsecontrol('debian/control','debian/control');
2269 $package = getfield $sourcep, 'Source';
2272 # $isuite = branchsuite(); # this doesn't work because dak hates canons
2274 my $clogp = parsechangelog();
2275 $isuite = getfield $clogp, 'Distribution';
2277 canonicalise_suite();
2278 progress "fetching from suite $csuite";
2279 } elsif (@ARGV==1) {
2281 canonicalise_suite();
2283 badusage "incorrect arguments to dgit fetch or dgit pull";
2302 badusage "-p is not allowed with dgit push" if defined $package;
2304 my $clogp = parsechangelog();
2305 $package = getfield $clogp, 'Source';
2308 } elsif (@ARGV==1) {
2309 ($specsuite) = (@ARGV);
2311 badusage "incorrect arguments to dgit push";
2313 $isuite = getfield $clogp, 'Distribution';
2315 local ($package) = $existing_package; # this is a hack
2316 canonicalise_suite();
2318 canonicalise_suite();
2320 if (defined $specsuite &&
2321 $specsuite ne $isuite &&
2322 $specsuite ne $csuite) {
2323 fail "dgit push: changelog specifies $isuite ($csuite)".
2324 " but command line specifies $specsuite";
2326 supplementary_message(<<'END');
2327 Push failed, while checking state of the archive.
2328 You can retry the push, after fixing the problem, if you like.
2330 if (check_for_git()) {
2334 if (fetch_from_archive()) {
2335 if (is_fast_fwd(lrref(), 'HEAD')) {
2337 } elsif (deliberately_not_fast_forward) {
2340 fail "dgit push: HEAD is not a descendant".
2341 " of the archive's version.\n".
2342 "dgit: To overwrite its contents,".
2343 " use git merge -s ours ".lrref().".\n".
2344 "dgit: To rewind history, if permitted by the archive,".
2345 " use --deliberately-not-fast-forward";
2349 fail "package appears to be new in this suite;".
2350 " if this is intentional, use --new";
2355 #---------- remote commands' implementation ----------
2357 sub cmd_remote_push_build_host {
2358 my ($nrargs) = shift @ARGV;
2359 my (@rargs) = @ARGV[0..$nrargs-1];
2360 @ARGV = @ARGV[$nrargs..$#ARGV];
2362 my ($dir,$vsnwant) = @rargs;
2363 # vsnwant is a comma-separated list; we report which we have
2364 # chosen in our ready response (so other end can tell if they
2367 $we_are_responder = 1;
2368 $us .= " (build host)";
2372 open PI, "<&STDIN" or die $!;
2373 open STDIN, "/dev/null" or die $!;
2374 open PO, ">&STDOUT" or die $!;
2376 open STDOUT, ">&STDERR" or die $!;
2380 ($protovsn) = grep {
2381 $vsnwant =~ m{^(?:.*,)?$_(?:,.*)?$}
2382 } @rpushprotovsn_support;
2384 fail "build host has dgit rpush protocol versions ".
2385 (join ",", @rpushprotovsn_support).
2386 " but invocation host has $vsnwant"
2387 unless defined $protovsn;
2389 responder_send_command("dgit-remote-push-ready $protovsn");
2390 rpush_handle_protovsn_bothends();
2395 sub cmd_remote_push_responder { cmd_remote_push_build_host(); }
2396 # ... for compatibility with proto vsn.1 dgit (just so that user gets
2397 # a good error message)
2399 sub rpush_handle_protovsn_bothends () {
2400 if ($protovsn < 4) {
2401 fail "rpush negotiated protocol version $protovsn".
2402 " which supports old tag format only".
2403 " but trying to use new format (".$tagformat_want->[1].")"
2404 if $tagformat_want && $tagformat_want->[0] ne 'old';
2405 $tagformat_want = ['old', "rpush negotiated protocol $protovsn", 0];
2414 my $report = i_child_report();
2415 if (defined $report) {
2416 printdebug "($report)\n";
2417 } elsif ($i_child_pid) {
2418 printdebug "(killing build host child $i_child_pid)\n";
2419 kill 15, $i_child_pid;
2421 if (defined $i_tmp && !defined $initiator_tempdir) {
2423 eval { rmtree $i_tmp; };
2427 END { i_cleanup(); }
2430 my ($base,$selector,@args) = @_;
2431 $selector =~ s/\-/_/g;
2432 { no strict qw(refs); &{"${base}_${selector}"}(@args); }
2439 if ($host =~ m/^((?:[^][]|\[[^][]*\])*)\:/) {
2447 push @rargs, join ",", @rpushprotovsn_support;
2450 push @rdgit, @ropts;
2451 push @rdgit, qw(remote-push-build-host), (scalar @rargs), @rargs;
2453 my @cmd = (@ssh, $host, shellquote @rdgit);
2456 if (defined $initiator_tempdir) {
2457 rmtree $initiator_tempdir;
2458 mkdir $initiator_tempdir, 0700 or die "$initiator_tempdir: $!";
2459 $i_tmp = $initiator_tempdir;
2463 $i_child_pid = open2(\*RO, \*RI, @cmd);
2465 ($protovsn) = initiator_expect { m/^dgit-remote-push-ready (\S+)/ };
2466 die "$protovsn ?" unless grep { $_ eq $protovsn } @rpushprotovsn_support;
2467 $supplementary_message = '' unless $protovsn >= 3;
2468 rpush_handle_protovsn_bothends();
2470 my ($icmd,$iargs) = initiator_expect {
2471 m/^(\S+)(?: (.*))?$/;
2474 i_method "i_resp", $icmd, $iargs;
2478 sub i_resp_progress ($) {
2480 my $msg = protocol_read_bytes \*RO, $rhs;
2484 sub i_resp_supplementary_message ($) {
2486 $supplementary_message = protocol_read_bytes \*RO, $rhs;
2489 sub i_resp_complete {
2490 my $pid = $i_child_pid;
2491 $i_child_pid = undef; # prevents killing some other process with same pid
2492 printdebug "waiting for build host child $pid...\n";
2493 my $got = waitpid $pid, 0;
2494 die $! unless $got == $pid;
2495 die "build host child failed $?" if $?;
2498 printdebug "all done\n";
2502 sub i_resp_file ($) {
2504 my $localname = i_method "i_localname", $keyword;
2505 my $localpath = "$i_tmp/$localname";
2506 stat_exists $localpath and
2507 badproto \*RO, "file $keyword ($localpath) twice";
2508 protocol_receive_file \*RO, $localpath;
2509 i_method "i_file", $keyword;
2514 sub i_resp_param ($) {
2515 $_[0] =~ m/^(\S+) (.*)$/ or badproto \*RO, "bad param spec";
2519 sub i_resp_previously ($) {
2520 $_[0] =~ m#^(refs/tags/\S+)=(\w+)$#
2521 or badproto \*RO, "bad previously spec";
2522 my $r = system qw(git check-ref-format), $1;
2523 die "bad previously ref spec ($r)" if $r;
2524 $previously{$1} = $2;
2529 sub i_resp_want ($) {
2531 die "$keyword ?" if $i_wanted{$keyword}++;
2532 my @localpaths = i_method "i_want", $keyword;
2533 printdebug "[[ $keyword @localpaths\n";
2534 foreach my $localpath (@localpaths) {
2535 protocol_send_file \*RI, $localpath;
2537 print RI "files-end\n" or die $!;
2540 our ($i_clogp, $i_version, $i_tag, $i_dscfn, $i_changesfn);
2542 sub i_localname_parsed_changelog {
2543 return "remote-changelog.822";
2545 sub i_file_parsed_changelog {
2546 ($i_clogp, $i_version, $i_tag, $i_dscfn) =
2547 push_parse_changelog "$i_tmp/remote-changelog.822";
2548 die if $i_dscfn =~ m#/|^\W#;
2551 sub i_localname_dsc {
2552 defined $i_dscfn or badproto \*RO, "dsc (before parsed-changelog)";
2557 sub i_localname_changes {
2558 defined $i_dscfn or badproto \*RO, "dsc (before parsed-changelog)";
2559 $i_changesfn = $i_dscfn;
2560 $i_changesfn =~ s/\.dsc$/_dgit.changes/ or die;
2561 return $i_changesfn;
2563 sub i_file_changes { }
2565 sub i_want_signed_tag {
2566 printdebug Dumper(\%i_param, $i_dscfn);
2567 defined $i_param{'head'} && defined $i_dscfn && defined $i_clogp
2568 && defined $i_param{'csuite'}
2569 or badproto \*RO, "premature desire for signed-tag";
2570 my $head = $i_param{'head'};
2571 die if $head =~ m/[^0-9a-f]/ || $head !~ m/^../;
2574 if ($protovsn >= 4) {
2575 my $p = $i_param{'tagformat'} // '<undef>';
2577 or badproto \*RO, "tag format mismatch: $p vs. $tagformat";
2580 die unless $i_param{'csuite'} =~ m/^$suite_re$/;
2582 push_parse_dsc $i_dscfn, 'remote dsc', $i_version;
2585 push_mktag $head, $i_clogp, $i_tag,
2587 $i_changesfn, 'remote changes',
2588 sub { "tag$_[0]"; };
2593 sub i_want_signed_dsc_changes {
2594 rename "$i_dscfn.tmp","$i_dscfn" or die "$i_dscfn $!";
2595 sign_changes $i_changesfn;
2596 return ($i_dscfn, $i_changesfn);
2599 #---------- building etc. ----------
2605 #----- `3.0 (quilt)' handling -----
2607 our $fakeeditorenv = 'DGIT_FAKE_EDITOR_QUILT';
2609 sub quiltify_dpkg_commit ($$$;$) {
2610 my ($patchname,$author,$msg, $xinfo) = @_;
2614 my $descfn = ".git/dgit/quilt-description.tmp";
2615 open O, '>', $descfn or die "$descfn: $!";
2618 $msg =~ s/^\s+$/ ./mg;
2619 print O <<END or die $!;
2629 local $ENV{'EDITOR'} = cmdoutput qw(realpath --), $0;
2630 local $ENV{'VISUAL'} = $ENV{'EDITOR'};
2631 local $ENV{$fakeeditorenv} = cmdoutput qw(realpath --), $descfn;
2632 runcmd @dpkgsource, qw(--commit .), $patchname;
2636 sub quiltify_trees_differ ($$;$$) {
2637 my ($x,$y,$finegrained,$ignorenamesr) = @_;
2638 # returns true iff the two tree objects differ other than in debian/
2639 # with $finegrained,
2640 # returns bitmask 01 - differ in upstream files except .gitignore
2641 # 02 - differ in .gitignore
2642 # if $ignorenamesr is defined, $ingorenamesr->{$fn}
2643 # is set for each modified .gitignore filename $fn
2645 my @cmd = (@git, qw(diff-tree --name-only -z));
2646 push @cmd, qw(-r) if $finegrained;
2648 my $diffs= cmdoutput @cmd;
2650 foreach my $f (split /\0/, $diffs) {
2651 next if $f =~ m#^debian(?:/.*)?$#s;
2652 my $isignore = $f =~ m#^(?:.*/)?.gitignore$#s;
2653 $r |= $isignore ? 02 : 01;
2654 $ignorenamesr->{$f}=1 if $ignorenamesr && $isignore;
2656 printdebug "quiltify_trees_differ $x $y => $r\n";
2660 sub quiltify_tree_sentinelfiles ($) {
2661 # lists the `sentinel' files present in the tree
2663 my $r = cmdoutput @git, qw(ls-tree --name-only), $x,
2664 qw(-- debian/rules debian/control);
2669 sub quiltify_splitbrain_needed () {
2670 if (!$split_brain) {
2671 progress "dgit view: changes are required...";
2672 runcmd @git, qw(checkout -q -b dgit-view);
2677 sub quiltify_splitbrain ($$$$$$) {
2678 my ($clogp, $unapplied, $headref, $diffbits,
2679 $editedignores, $cachekey) = @_;
2680 if ($quilt_mode !~ m/gbp|dpm/) {
2681 # treat .gitignore just like any other upstream file
2682 $diffbits = { %$diffbits };
2683 $_ = !!$_ foreach values %$diffbits;
2685 # We would like any commits we generate to be reproducible
2686 my @authline = clogp_authline($clogp);
2687 local $ENV{GIT_COMMITTER_NAME} = $authline[0];
2688 local $ENV{GIT_COMMITTER_EMAIL} = $authline[1];
2689 local $ENV{GIT_COMMITTER_DATE} = $authline[2];
2691 if ($quilt_mode =~ m/gbp|unapplied/ &&
2692 ($diffbits->{H2O} & 01)) {
2694 "--quilt=$quilt_mode specified, implying patches-unapplied git tree\n".
2695 " but git tree differs from orig in upstream files.";
2696 if (!stat_exists "debian/patches") {
2698 "\n ... debian/patches is missing; perhaps this is a patch queue branch?";
2702 if ($quilt_mode =~ m/gbp|unapplied/ &&
2703 ($diffbits->{O2A} & 01)) { # some patches
2704 quiltify_splitbrain_needed();
2705 progress "dgit view: creating patches-applied version using gbp pq";
2706 runcmd shell_cmd 'exec >/dev/null', @gbp, qw(pq import);
2707 # gbp pq import creates a fresh branch; push back to dgit-view
2708 runcmd @git, qw(update-ref refs/heads/dgit-view HEAD);
2709 runcmd @git, qw(checkout -q dgit-view);
2711 if (($diffbits->{H2O} & 02) && # user has modified .gitignore
2712 !($diffbits->{O2A} & 02)) { # patches do not change .gitignore
2713 quiltify_splitbrain_needed();
2714 progress "dgit view: creating patch to represent .gitignore changes";
2715 ensuredir "debian/patches";
2716 my $gipatch = "debian/patches/auto-gitignore";
2717 open GIPATCH, ">>", "$gipatch" or die "$gipatch: $!";
2718 stat GIPATCH or die "$gipatch: $!";
2719 fail "$gipatch already exists; but want to create it".
2720 " to record .gitignore changes" if (stat _)[7];
2721 print GIPATCH <<END or die "$gipatch: $!";
2722 Subject: Update .gitignore from Debian packaging branch
2724 The Debian packaging git branch contains these updates to the upstream
2725 .gitignore file(s). This patch is autogenerated, to provide these
2726 updates to users of the official Debian archive view of the package.
2728 [dgit version $our_version]
2731 close GIPATCH or die "$gipatch: $!";
2732 runcmd shell_cmd "exec >>$gipatch", @git, qw(diff),
2733 $unapplied, $headref, "--", sort keys %$editedignores;
2734 open SERIES, "+>>", "debian/patches/series" or die $!;
2735 defined seek SERIES, -1, 2 or $!==EINVAL or die $!;
2737 defined read SERIES, $newline, 1 or die $!;
2738 print SERIES "\n" or die $! unless $newline eq "\n";
2739 print SERIES "auto-gitignore\n" or die $!;
2740 close SERIES or die $!;
2741 runcmd @git, qw(add -- debian/patches/series), $gipatch;
2742 commit_admin "Commit patch to update .gitignore";
2745 my $dgitview = git_rev_parse 'refs/heads/dgit-view';
2747 changedir '../../../..';
2748 ensuredir ".git/logs/refs/dgit-intern";
2749 my $makelogfh = new IO::File ".git/logs/refs/$splitbraincache", '>>'
2751 runcmd @git, qw(update-ref -m), $cachekey, "refs/$splitbraincache",
2754 progress "dgit view: created (commit id $dgitview)";
2756 changedir '.git/dgit/unpack/work';
2759 sub quiltify ($$$$) {
2760 my ($clogp,$target,$oldtiptree,$failsuggestion) = @_;
2762 # Quilt patchification algorithm
2764 # We search backwards through the history of the main tree's HEAD
2765 # (T) looking for a start commit S whose tree object is identical
2766 # to to the patch tip tree (ie the tree corresponding to the
2767 # current dpkg-committed patch series). For these purposes
2768 # `identical' disregards anything in debian/ - this wrinkle is
2769 # necessary because dpkg-source treates debian/ specially.
2771 # We can only traverse edges where at most one of the ancestors'
2772 # trees differs (in changes outside in debian/). And we cannot
2773 # handle edges which change .pc/ or debian/patches. To avoid
2774 # going down a rathole we avoid traversing edges which introduce
2775 # debian/rules or debian/control. And we set a limit on the
2776 # number of edges we are willing to look at.
2778 # If we succeed, we walk forwards again. For each traversed edge
2779 # PC (with P parent, C child) (starting with P=S and ending with
2780 # C=T) to we do this:
2782 # - dpkg-source --commit with a patch name and message derived from C
2783 # After traversing PT, we git commit the changes which
2784 # should be contained within debian/patches.
2786 # The search for the path S..T is breadth-first. We maintain a
2787 # todo list containing search nodes. A search node identifies a
2788 # commit, and looks something like this:
2790 # Commit => $git_commit_id,
2791 # Child => $c, # or undef if P=T
2792 # Whynot => $reason_edge_PC_unsuitable, # in @nots only
2793 # Nontrivial => true iff $p..$c has relevant changes
2800 my %considered; # saves being exponential on some weird graphs
2802 my $t_sentinels = quiltify_tree_sentinelfiles $target;
2805 my ($search,$whynot) = @_;
2806 printdebug " search NOT $search->{Commit} $whynot\n";
2807 $search->{Whynot} = $whynot;
2808 push @nots, $search;
2809 no warnings qw(exiting);
2818 my $c = shift @todo;
2819 next if $considered{$c->{Commit}}++;
2821 $not->($c, "maximum search space exceeded") if --$max_work <= 0;
2823 printdebug "quiltify investigate $c->{Commit}\n";
2826 if (!quiltify_trees_differ $c->{Commit}, $oldtiptree) {
2827 printdebug " search finished hooray!\n";
2832 if ($quilt_mode eq 'nofix') {
2833 fail "quilt fixup required but quilt mode is \`nofix'\n".
2834 "HEAD commit $c->{Commit} differs from tree implied by ".
2835 " debian/patches (tree object $oldtiptree)";
2837 if ($quilt_mode eq 'smash') {
2838 printdebug " search quitting smash\n";
2842 my $c_sentinels = quiltify_tree_sentinelfiles $c->{Commit};
2843 $not->($c, "has $c_sentinels not $t_sentinels")
2844 if $c_sentinels ne $t_sentinels;
2846 my $commitdata = cmdoutput @git, qw(cat-file commit), $c->{Commit};
2847 $commitdata =~ m/\n\n/;
2849 my @parents = ($commitdata =~ m/^parent (\w+)$/gm);
2850 @parents = map { { Commit => $_, Child => $c } } @parents;
2852 $not->($c, "root commit") if !@parents;
2854 foreach my $p (@parents) {
2855 $p->{Nontrivial}= quiltify_trees_differ $p->{Commit},$c->{Commit};
2857 my $ndiffers = grep { $_->{Nontrivial} } @parents;
2858 $not->($c, "merge ($ndiffers nontrivial parents)") if $ndiffers > 1;
2860 foreach my $p (@parents) {
2861 printdebug "considering C=$c->{Commit} P=$p->{Commit}\n";
2863 my @cmd= (@git, qw(diff-tree -r --name-only),
2864 $p->{Commit},$c->{Commit}, qw(-- debian/patches .pc));
2865 my $patchstackchange = cmdoutput @cmd;
2866 if (length $patchstackchange) {
2867 $patchstackchange =~ s/\n/,/g;
2868 $not->($p, "changed $patchstackchange");
2871 printdebug " search queue P=$p->{Commit} ",
2872 ($p->{Nontrivial} ? "NT" : "triv"),"\n";
2878 printdebug "quiltify want to smash\n";
2881 my $x = $_[0]{Commit};
2882 $x =~ s/(.*?[0-9a-z]{8})[0-9a-z]*$/$1/;
2885 my $reportnot = sub {
2887 my $s = $abbrev->($notp);
2888 my $c = $notp->{Child};
2889 $s .= "..".$abbrev->($c) if $c;
2890 $s .= ": ".$notp->{Whynot};
2893 if ($quilt_mode eq 'linear') {
2894 print STDERR "$us: quilt fixup cannot be linear. Stopped at:\n";
2895 foreach my $notp (@nots) {
2896 print STDERR "$us: ", $reportnot->($notp), "\n";
2898 print STDERR "$us: $_\n" foreach @$failsuggestion;
2899 fail "quilt fixup naive history linearisation failed.\n".
2900 "Use dpkg-source --commit by hand; or, --quilt=smash for one ugly patch";
2901 } elsif ($quilt_mode eq 'smash') {
2902 } elsif ($quilt_mode eq 'auto') {
2903 progress "quilt fixup cannot be linear, smashing...";
2905 die "$quilt_mode ?";
2908 my $time = $ENV{'GIT_COMMITTER_DATE'} || time;
2909 $time =~ s/\s.*//; # trim timezone from GIT_COMMITTER_DATE
2911 my $msg = cmdoutput @git, qw(log), "-n$ncommits";
2913 quiltify_dpkg_commit "auto-$version-$target-$time",
2914 (getfield $clogp, 'Maintainer'),
2915 "Automatically generated patch ($clogp->{Version})\n".
2916 "Last (up to) $ncommits git changes, FYI:\n\n". $msg;
2920 progress "quiltify linearisation planning successful, executing...";
2922 for (my $p = $sref_S;
2923 my $c = $p->{Child};
2925 printdebug "quiltify traverse $p->{Commit}..$c->{Commit}\n";
2926 next unless $p->{Nontrivial};
2928 my $cc = $c->{Commit};
2930 my $commitdata = cmdoutput @git, qw(cat-file commit), $cc;
2931 $commitdata =~ m/\n\n/ or die "$c ?";
2934 $commitdata =~ m/^author (.*) \d+ [-+0-9]+$/m or die "$cc ?";
2937 $msg =~ s/^(.*)\n*/$1\n/ or die "$cc $msg ?";
2940 my $patchname = $title;
2941 $patchname =~ s/[.:]$//;
2942 $patchname =~ y/ A-Z/-a-z/;
2943 $patchname =~ y/-a-z0-9_.+=~//cd;
2944 $patchname =~ s/^\W/x-$&/;
2945 $patchname = substr($patchname,0,40);
2948 stat "debian/patches/$patchname$index";
2950 $!==ENOENT or die "$patchname$index $!";
2952 runcmd @git, qw(checkout -q), $cc;
2954 # We use the tip's changelog so that dpkg-source doesn't
2955 # produce complaining messages from dpkg-parsechangelog. None
2956 # of the information dpkg-source gets from the changelog is
2957 # actually relevant - it gets put into the original message
2958 # which dpkg-source provides our stunt editor, and then
2960 runcmd @git, qw(checkout -q), $target, qw(debian/changelog);
2962 quiltify_dpkg_commit "$patchname$index", $author, $msg,
2963 "X-Dgit-Generated: $clogp->{Version} $cc\n";
2965 runcmd @git, qw(checkout -q), $cc, qw(debian/changelog);
2968 runcmd @git, qw(checkout -q master);
2971 sub build_maybe_quilt_fixup () {
2972 my ($format,$fopts) = get_source_format;
2973 return unless madformat $format;
2976 check_for_vendor_patches();
2978 my $clogp = parsechangelog();
2979 my $headref = git_rev_parse('HEAD');
2984 my $upstreamversion=$version;
2985 $upstreamversion =~ s/-[^-]*$//;
2987 if ($fopts->{'single-debian-patch'}) {
2988 quilt_fixup_singlepatch($clogp, $headref, $upstreamversion);
2990 quilt_fixup_multipatch($clogp, $headref, $upstreamversion);
2993 die 'bug' if $split_brain && !$need_split_build_invocation;
2995 changedir '../../../..';
2996 runcmd_ordryrun_local
2997 @git, qw(pull --ff-only -q .git/dgit/unpack/work master);
3000 sub quilt_fixup_mkwork ($) {
3003 mkdir "work" or die $!;
3005 mktree_in_ud_here();
3006 runcmd @git, qw(reset -q --hard), $headref;
3009 sub quilt_fixup_linkorigs ($$) {
3010 my ($upstreamversion, $fn) = @_;
3011 # calls $fn->($leafname);
3013 foreach my $f (<../../../../*>) { #/){
3014 my $b=$f; $b =~ s{.*/}{};
3016 local ($debuglevel) = $debuglevel-1;
3017 printdebug "QF linkorigs $b, $f ?\n";
3019 next unless is_orig_file $b, srcfn $upstreamversion,'';
3020 printdebug "QF linkorigs $b, $f Y\n";
3021 link_ltarget $f, $b or die "$b $!";
3026 sub quilt_fixup_delete_pc () {
3027 runcmd @git, qw(rm -rqf .pc);
3028 commit_admin "Commit removal of .pc (quilt series tracking data)";
3031 sub quilt_fixup_singlepatch ($$$) {
3032 my ($clogp, $headref, $upstreamversion) = @_;
3034 progress "starting quiltify (single-debian-patch)";
3036 # dpkg-source --commit generates new patches even if
3037 # single-debian-patch is in debian/source/options. In order to
3038 # get it to generate debian/patches/debian-changes, it is
3039 # necessary to build the source package.
3041 quilt_fixup_linkorigs($upstreamversion, sub { });
3042 quilt_fixup_mkwork($headref);
3044 rmtree("debian/patches");
3046 runcmd @dpkgsource, qw(-b .);
3048 runcmd @dpkgsource, qw(-x), (srcfn $version, ".dsc");
3049 rename srcfn("$upstreamversion", "/debian/patches"),
3050 "work/debian/patches";
3053 commit_quilty_patch();
3056 sub quilt_make_fake_dsc ($) {
3057 my ($upstreamversion) = @_;
3059 my $fakeversion="$upstreamversion-~~DGITFAKE";
3061 my $fakedsc=new IO::File 'fake.dsc', '>' or die $!;
3062 print $fakedsc <<END or die $!;
3065 Version: $fakeversion
3069 my $dscaddfile=sub {
3072 my $md = new Digest::MD5;
3074 my $fh = new IO::File $b, '<' or die "$b $!";
3079 print $fakedsc " ".$md->hexdigest." $size $b\n" or die $!;
3082 quilt_fixup_linkorigs($upstreamversion, $dscaddfile);
3084 my @files=qw(debian/source/format debian/rules
3085 debian/control debian/changelog);
3086 foreach my $maybe (qw(debian/patches debian/source/options
3087 debian/tests/control)) {
3088 next unless stat_exists "../../../$maybe";
3089 push @files, $maybe;
3092 my $debtar= srcfn $fakeversion,'.debian.tar.gz';
3093 runcmd qw(env GZIP=-1n tar -zcf), "./$debtar", qw(-C ../../..), @files;
3095 $dscaddfile->($debtar);
3096 close $fakedsc or die $!;
3099 sub quilt_check_splitbrain_cache ($$) {
3100 my ($headref, $upstreamversion) = @_;
3101 # Called only if we are in (potentially) split brain mode.
3103 # Computes the cache key and looks in the cache.
3104 # Returns ($dgit_view_commitid, $cachekey) or (undef, $cachekey)
3106 my $splitbrain_cachekey;
3109 "dgit: split brain (separate dgit view) may be needed (--quilt=$quilt_mode).";
3110 # we look in the reflog of dgit-intern/quilt-cache
3111 # we look for an entry whose message is the key for the cache lookup
3112 my @cachekey = (qw(dgit), $our_version);
3113 push @cachekey, $upstreamversion;
3114 push @cachekey, $quilt_mode;
3115 push @cachekey, $headref;
3117 push @cachekey, hashfile('fake.dsc');
3119 my $srcshash = Digest::SHA->new(256);
3120 my %sfs = ( %INC, '$0(dgit)' => $0 );
3121 foreach my $sfk (sort keys %sfs) {
3122 next unless m/^\$0\b/ || m{^Debian/Dgit\b};
3123 $srcshash->add($sfk," ");
3124 $srcshash->add(hashfile($sfs{$sfk}));
3125 $srcshash->add("\n");
3127 push @cachekey, $srcshash->hexdigest();
3128 $splitbrain_cachekey = "@cachekey";
3130 my @cmd = (@git, qw(reflog), '--pretty=format:%H %gs',
3132 printdebug "splitbrain cachekey $splitbrain_cachekey\n";
3133 debugcmd "|(probably)",@cmd;
3134 my $child = open GC, "-|"; defined $child or die $!;
3136 chdir '../../..' or die $!;
3137 if (!stat ".git/logs/refs/$splitbraincache") {
3138 $! == ENOENT or die $!;
3139 printdebug ">(no reflog)\n";
3146 printdebug ">| ", $_, "\n" if $debuglevel > 1;
3147 next unless m/^(\w+) (\S.*\S)$/ && $2 eq $splitbrain_cachekey;
3150 quilt_fixup_mkwork($headref);
3151 if ($cachehit ne $headref) {
3152 progress "dgit view: found cached (commit id $cachehit)";
3153 runcmd @git, qw(checkout -q -b dgit-view), $cachehit;
3155 return ($cachehit, $splitbrain_cachekey);
3157 progress "dgit view: found cached, no changes required";
3158 return ($headref, $splitbrain_cachekey);
3160 die $! if GC->error;
3161 failedcmd unless close GC;
3163 printdebug "splitbrain cache miss\n";
3164 return (undef, $splitbrain_cachekey);
3167 sub quilt_fixup_multipatch ($$$) {
3168 my ($clogp, $headref, $upstreamversion) = @_;
3170 progress "examining quilt state (multiple patches, $quilt_mode mode)";
3173 # - honour any existing .pc in case it has any strangeness
3174 # - determine the git commit corresponding to the tip of
3175 # the patch stack (if there is one)
3176 # - if there is such a git commit, convert each subsequent
3177 # git commit into a quilt patch with dpkg-source --commit
3178 # - otherwise convert all the differences in the tree into
3179 # a single git commit
3183 # Our git tree doesn't necessarily contain .pc. (Some versions of
3184 # dgit would include the .pc in the git tree.) If there isn't
3185 # one, we need to generate one by unpacking the patches that we
3188 # We first look for a .pc in the git tree. If there is one, we
3189 # will use it. (This is not the normal case.)
3191 # Otherwise need to regenerate .pc so that dpkg-source --commit
3192 # can work. We do this as follows:
3193 # 1. Collect all relevant .orig from parent directory
3194 # 2. Generate a debian.tar.gz out of
3195 # debian/{patches,rules,source/format,source/options}
3196 # 3. Generate a fake .dsc containing just these fields:
3197 # Format Source Version Files
3198 # 4. Extract the fake .dsc
3199 # Now the fake .dsc has a .pc directory.
3200 # (In fact we do this in every case, because in future we will
3201 # want to search for a good base commit for generating patches.)
3203 # Then we can actually do the dpkg-source --commit
3204 # 1. Make a new working tree with the same object
3205 # store as our main tree and check out the main
3207 # 2. Copy .pc from the fake's extraction, if necessary
3208 # 3. Run dpkg-source --commit
3209 # 4. If the result has changes to debian/, then
3210 # - git-add them them
3211 # - git-add .pc if we had a .pc in-tree
3213 # 5. If we had a .pc in-tree, delete it, and git-commit
3214 # 6. Back in the main tree, fast forward to the new HEAD
3216 # Another situation we may have to cope with is gbp-style
3217 # patches-unapplied trees.
3219 # We would want to detect these, so we know to escape into
3220 # quilt_fixup_gbp. However, this is in general not possible.
3221 # Consider a package with a one patch which the dgit user reverts
3222 # (with git-revert or the moral equivalent).
3224 # That is indistinguishable in contents from a patches-unapplied
3225 # tree. And looking at the history to distinguish them is not
3226 # useful because the user might have made a confusing-looking git
3227 # history structure (which ought to produce an error if dgit can't
3228 # cope, not a silent reintroduction of an unwanted patch).
3230 # So gbp users will have to pass an option. But we can usually
3231 # detect their failure to do so: if the tree is not a clean
3232 # patches-applied tree, quilt linearisation fails, but the tree
3233 # _is_ a clean patches-unapplied tree, we can suggest that maybe
3234 # they want --quilt=unapplied.
3236 # To help detect this, when we are extracting the fake dsc, we
3237 # first extract it with --skip-patches, and then apply the patches
3238 # afterwards with dpkg-source --before-build. That lets us save a
3239 # tree object corresponding to .origs.
3241 my $splitbrain_cachekey;
3243 quilt_make_fake_dsc($upstreamversion);
3245 if (quiltmode_splitbrain()) {
3247 ($cachehit, $splitbrain_cachekey) =
3248 quilt_check_splitbrain_cache($headref, $upstreamversion);
3249 return if $cachehit;
3253 'exec dpkg-source --no-check --skip-patches -x fake.dsc >/dev/null';
3255 my $fakexdir= $package.'-'.(stripepoch $upstreamversion);
3256 rename $fakexdir, "fake" or die "$fakexdir $!";
3260 remove_stray_gits();
3261 mktree_in_ud_here();
3265 runcmd @git, qw(add -Af .);
3266 my $unapplied=git_write_tree();
3267 printdebug "fake orig tree object $unapplied\n";
3272 'exec dpkg-source --before-build . >/dev/null';
3276 quilt_fixup_mkwork($headref);
3279 if (stat_exists ".pc") {
3281 progress "Tree already contains .pc - will use it then delete it.";
3284 rename '../fake/.pc','.pc' or die $!;
3287 changedir '../fake';
3289 runcmd @git, qw(add -Af .);
3290 my $oldtiptree=git_write_tree();
3291 printdebug "fake o+d/p tree object $unapplied\n";
3292 changedir '../work';
3295 # We calculate some guesswork now about what kind of tree this might
3296 # be. This is mostly for error reporting.
3301 # O = orig, without patches applied
3302 # A = "applied", ie orig with H's debian/patches applied
3303 H2O => quiltify_trees_differ($headref, $unapplied, 1,\%editedignores),
3304 H2A => quiltify_trees_differ($headref, $oldtiptree,1),
3305 O2A => quiltify_trees_differ($unapplied,$oldtiptree,1),
3309 foreach my $b (qw(01 02)) {
3310 foreach my $v (qw(H2O O2A H2A)) {
3311 push @dl, ($diffbits->{$v} & $b) ? '##' : '==';
3314 printdebug "differences \@dl @dl.\n";
3317 "$us: quilt differences: src: %s orig %s gitignores: %s orig %s\n".
3318 "$us: quilt differences: HEAD %s o+d/p HEAD %s o+d/p",
3319 $dl[0], $dl[1], $dl[3], $dl[4],
3323 if (!($diffbits->{H2O} & $diffbits->{O2A})) {
3324 push @failsuggestion, "This might be a patches-unapplied branch.";
3325 } elsif (!($diffbits->{H2A} & $diffbits->{O2A})) {
3326 push @failsuggestion, "This might be a patches-applied branch.";
3328 push @failsuggestion, "Maybe you need to specify one of".
3329 " --quilt=gbp --quilt=dpm --quilt=unapplied ?";
3331 if (quiltmode_splitbrain()) {
3332 quiltify_splitbrain($clogp, $unapplied, $headref,
3333 $diffbits, \%editedignores,
3334 $splitbrain_cachekey);
3338 progress "starting quiltify (multiple patches, $quilt_mode mode)";
3339 quiltify($clogp,$headref,$oldtiptree,\@failsuggestion);
3341 if (!open P, '>>', ".pc/applied-patches") {
3342 $!==&ENOENT or die $!;
3347 commit_quilty_patch();
3349 if ($mustdeletepc) {
3350 quilt_fixup_delete_pc();
3354 sub quilt_fixup_editor () {
3355 my $descfn = $ENV{$fakeeditorenv};
3356 my $editing = $ARGV[$#ARGV];
3357 open I1, '<', $descfn or die "$descfn: $!";
3358 open I2, '<', $editing or die "$editing: $!";
3359 unlink $editing or die "$editing: $!";
3360 open O, '>', $editing or die "$editing: $!";
3361 while (<I1>) { print O or die $!; } I1->error and die $!;
3364 $copying ||= m/^\-\-\- /;
3365 next unless $copying;
3368 I2->error and die $!;
3373 sub maybe_apply_patches_dirtily () {
3374 return unless $quilt_mode =~ m/gbp|unapplied/;
3375 print STDERR <<END or die $!;
3377 dgit: Building, or cleaning with rules target, in patches-unapplied tree.
3378 dgit: Have to apply the patches - making the tree dirty.
3379 dgit: (Consider specifying --clean=git and (or) using dgit sbuild.)
3382 $patches_applied_dirtily = 01;
3383 $patches_applied_dirtily |= 02 unless stat_exists '.pc';
3384 runcmd qw(dpkg-source --before-build .);
3387 sub maybe_unapply_patches_again () {
3388 progress "dgit: Unapplying patches again to tidy up the tree."
3389 if $patches_applied_dirtily;
3390 runcmd qw(dpkg-source --after-build .)
3391 if $patches_applied_dirtily & 01;
3393 if $patches_applied_dirtily & 02;
3396 #----- other building -----
3398 our $clean_using_builder;
3399 # ^ tree is to be cleaned by dpkg-source's builtin idea that it should
3400 # clean the tree before building (perhaps invoked indirectly by
3401 # whatever we are using to run the build), rather than separately
3402 # and explicitly by us.
3405 return if $clean_using_builder;
3406 if ($cleanmode eq 'dpkg-source') {
3407 maybe_apply_patches_dirtily();
3408 runcmd_ordryrun_local @dpkgbuildpackage, qw(-T clean);
3409 } elsif ($cleanmode eq 'dpkg-source-d') {
3410 maybe_apply_patches_dirtily();
3411 runcmd_ordryrun_local @dpkgbuildpackage, qw(-d -T clean);
3412 } elsif ($cleanmode eq 'git') {
3413 runcmd_ordryrun_local @git, qw(clean -xdf);
3414 } elsif ($cleanmode eq 'git-ff') {
3415 runcmd_ordryrun_local @git, qw(clean -xdff);
3416 } elsif ($cleanmode eq 'check') {
3417 my $leftovers = cmdoutput @git, qw(clean -xdn);
3418 if (length $leftovers) {
3419 print STDERR $leftovers, "\n" or die $!;
3420 fail "tree contains uncommitted files and --clean=check specified";
3422 } elsif ($cleanmode eq 'none') {
3429 badusage "clean takes no additional arguments" if @ARGV;
3432 maybe_unapply_patches_again();
3437 badusage "-p is not allowed when building" if defined $package;
3440 my $clogp = parsechangelog();
3441 $isuite = getfield $clogp, 'Distribution';
3442 $package = getfield $clogp, 'Source';
3443 $version = getfield $clogp, 'Version';
3444 build_maybe_quilt_fixup();
3446 my $pat = changespat $version;
3447 foreach my $f (glob "$buildproductsdir/$pat") {
3449 unlink $f or fail "remove old changes file $f: $!";
3451 progress "would remove $f";
3457 sub changesopts_initial () {
3458 my @opts =@changesopts[1..$#changesopts];
3461 sub changesopts_version () {
3462 if (!defined $changes_since_version) {
3463 my @vsns = archive_query('archive_query');
3464 my @quirk = access_quirk();
3465 if ($quirk[0] eq 'backports') {
3466 local $isuite = $quirk[2];
3468 canonicalise_suite();
3469 push @vsns, archive_query('archive_query');
3472 @vsns = map { $_->[0] } @vsns;
3473 @vsns = sort { -version_compare($a, $b) } @vsns;
3474 $changes_since_version = $vsns[0];
3475 progress "changelog will contain changes since $vsns[0]";
3477 $changes_since_version = '_';
3478 progress "package seems new, not specifying -v<version>";
3481 if ($changes_since_version ne '_') {
3482 return ("-v$changes_since_version");
3488 sub changesopts () {
3489 return (changesopts_initial(), changesopts_version());
3492 sub massage_dbp_args ($;$) {
3493 my ($cmd,$xargs) = @_;
3496 # - if we're going to split the source build out so we can
3497 # do strange things to it, massage the arguments to dpkg-buildpackage
3498 # so that the main build doessn't build source (or add an argument
3499 # to stop it building source by default).
3501 # - add -nc to stop dpkg-source cleaning the source tree,
3502 # unless we're not doing a split build and want dpkg-source
3503 # as cleanmode, in which case we can do nothing
3506 # 0 - source will NOT need to be built separately by caller
3507 # +1 - source will need to be built separately by caller
3508 # +2 - source will need to be built separately by caller AND
3509 # dpkg-buildpackage should not in fact be run at all!
3510 debugcmd '#massaging#', @$cmd if $debuglevel>1;
3511 #print STDERR "MASS0 ",Dumper($cmd, $xargs, $need_split_build_invocation);
3512 if ($cleanmode eq 'dpkg-source' && !$need_split_build_invocation) {
3513 $clean_using_builder = 1;
3516 # -nc has the side effect of specifying -b if nothing else specified
3517 # and some combinations of -S, -b, et al, are errors, rather than
3518 # later simply overriding earlie. So we need to:
3519 # - search the command line for these options
3520 # - pick the last one
3521 # - perhaps add our own as a default
3522 # - perhaps adjust it to the corresponding non-source-building version
3524 foreach my $l ($cmd, $xargs) {
3526 @$l = grep { !(m/^-[SgGFABb]$/s and $dmode=$_) } @$l;
3529 #print STDERR "MASS1 ",Dumper($cmd, $xargs, $dmode);
3531 if ($need_split_build_invocation) {
3532 printdebug "massage split $dmode.\n";
3533 $r = $dmode =~ m/[S]/ ? +2 :
3534 $dmode =~ y/gGF/ABb/ ? +1 :
3535 $dmode =~ m/[ABb]/ ? 0 :
3538 printdebug "massage done $r $dmode.\n";
3540 #print STDERR "MASS2 ",Dumper($cmd, $xargs, $r);
3545 my @dbp = (@dpkgbuildpackage, qw(-us -uc), changesopts_initial(), @ARGV);
3546 my $wantsrc = massage_dbp_args \@dbp;
3553 push @dbp, changesopts_version();
3554 maybe_apply_patches_dirtily();
3555 runcmd_ordryrun_local @dbp;
3557 maybe_unapply_patches_again();
3558 printdone "build successful\n";
3562 my @dbp = @dpkgbuildpackage;
3564 my $wantsrc = massage_dbp_args \@dbp, \@ARGV;
3567 if (length executable_on_path('git-buildpackage')) {
3568 @cmd = qw(git-buildpackage);
3570 @cmd = qw(gbp buildpackage);
3572 push @cmd, (qw(-us -uc --git-no-sign-tags), "--git-builder=@dbp");
3577 if (!$clean_using_builder) {
3578 push @cmd, '--git-cleaner=true';
3583 unless (grep { m/^--git-debian-branch|^--git-ignore-branch/ } @ARGV) {
3584 canonicalise_suite();
3585 push @cmd, "--git-debian-branch=".lbranch();
3587 push @cmd, changesopts();
3588 maybe_apply_patches_dirtily();
3589 runcmd_ordryrun_local @cmd, @ARGV;
3591 maybe_unapply_patches_again();
3592 printdone "build successful\n";
3594 sub cmd_git_build { cmd_gbp_build(); } # compatibility with <= 1.0
3597 my $our_cleanmode = $cleanmode;
3598 if ($need_split_build_invocation) {
3599 # Pretend that clean is being done some other way. This
3600 # forces us not to try to use dpkg-buildpackage to clean and
3601 # build source all in one go; and instead we run dpkg-source
3602 # (and build_prep() will do the clean since $clean_using_builder
3604 $our_cleanmode = 'ELSEWHERE';
3606 if ($our_cleanmode =~ m/^dpkg-source/) {
3607 # dpkg-source invocation (below) will clean, so build_prep shouldn't
3608 $clean_using_builder = 1;
3611 $sourcechanges = changespat $version,'source';
3613 unlink "../$sourcechanges" or $!==ENOENT
3614 or fail "remove $sourcechanges: $!";
3616 $dscfn = dscfn($version);
3617 if ($our_cleanmode eq 'dpkg-source') {
3618 maybe_apply_patches_dirtily();
3619 runcmd_ordryrun_local @dpkgbuildpackage, qw(-us -uc -S),
3621 } elsif ($our_cleanmode eq 'dpkg-source-d') {
3622 maybe_apply_patches_dirtily();
3623 runcmd_ordryrun_local @dpkgbuildpackage, qw(-us -uc -S -d),
3626 my @cmd = (@dpkgsource, qw(-b --));
3629 runcmd_ordryrun_local @cmd, "work";
3630 my @udfiles = <${package}_*>;
3631 changedir "../../..";
3632 foreach my $f (@udfiles) {
3633 printdebug "source copy, found $f\n";
3636 ($f =~ m/\.debian\.tar(?:\.\w+)$/ &&
3637 $f eq srcfn($version, $&));
3638 printdebug "source copy, found $f - renaming\n";
3639 rename "$ud/$f", "../$f" or $!==ENOENT
3640 or fail "put in place new source file ($f): $!";
3643 my $pwd = must_getcwd();
3644 my $leafdir = basename $pwd;
3646 runcmd_ordryrun_local @cmd, $leafdir;
3649 runcmd_ordryrun_local qw(sh -ec),
3650 'exec >$1; shift; exec "$@"','x',
3651 "../$sourcechanges",
3652 @dpkggenchanges, qw(-S), changesopts();
3656 sub cmd_build_source {
3657 badusage "build-source takes no additional arguments" if @ARGV;
3659 maybe_unapply_patches_again();
3660 printdone "source built, results in $dscfn and $sourcechanges";
3665 my $pat = changespat $version;
3667 my @unwanted = map { s#^\.\./##; $_; } glob "../$pat";
3668 @unwanted = grep { $_ ne changespat $version,'source' } @unwanted;
3669 fail "changes files other than source matching $pat".
3670 " already present (@unwanted);".
3671 " building would result in ambiguity about the intended results"
3676 stat_exists $dscfn or fail "$dscfn (in parent directory): $!";
3677 stat_exists $sourcechanges
3678 or fail "$sourcechanges (in parent directory): $!";
3680 runcmd_ordryrun_local @sbuild, qw(-d), $isuite, @ARGV, $dscfn;
3681 my @changesfiles = glob $pat;
3682 @changesfiles = sort {
3683 ($b =~ m/_source\.changes$/ <=> $a =~ m/_source\.changes$/)
3686 fail "wrong number of different changes files (@changesfiles)"
3687 unless @changesfiles==2;
3688 my $binchanges = parsecontrol($changesfiles[1], "binary changes file");
3689 foreach my $l (split /\n/, getfield $binchanges, 'Files') {
3690 fail "$l found in binaries changes file $binchanges"
3693 runcmd_ordryrun_local @mergechanges, @changesfiles;
3694 my $multichanges = changespat $version,'multi';
3696 stat_exists $multichanges or fail "$multichanges: $!";
3697 foreach my $cf (glob $pat) {
3698 next if $cf eq $multichanges;
3699 rename "$cf", "$cf.inmulti" or fail "$cf\{,.inmulti}: $!";
3702 maybe_unapply_patches_again();
3703 printdone "build successful, results in $multichanges\n" or die $!;
3706 sub cmd_quilt_fixup {
3707 badusage "incorrect arguments to dgit quilt-fixup" if @ARGV;
3708 my $clogp = parsechangelog();
3709 $version = getfield $clogp, 'Version';
3710 $package = getfield $clogp, 'Source';
3713 build_maybe_quilt_fixup();
3716 sub cmd_archive_api_query {
3717 badusage "need only 1 subpath argument" unless @ARGV==1;
3718 my ($subpath) = @ARGV;
3719 my @cmd = archive_api_query_cmd($subpath);
3721 exec @cmd or fail "exec curl: $!\n";
3724 sub cmd_clone_dgit_repos_server {
3725 badusage "need destination argument" unless @ARGV==1;
3726 my ($destdir) = @ARGV;
3727 $package = '_dgit-repos-server';
3728 my @cmd = (@git, qw(clone), access_giturl(), $destdir);
3730 exec @cmd or fail "exec git clone: $!\n";
3733 sub cmd_setup_mergechangelogs {
3734 badusage "no arguments allowed to dgit setup-mergechangelogs" if @ARGV;
3735 setup_mergechangelogs(1);
3738 sub cmd_setup_useremail {
3739 badusage "no arguments allowed to dgit setup-mergechangelogs" if @ARGV;
3743 sub cmd_setup_new_tree {
3744 badusage "no arguments allowed to dgit setup-tree" if @ARGV;
3748 #---------- argument parsing and main program ----------
3751 print "dgit version $our_version\n" or die $!;
3755 our (%valopts_long, %valopts_short);
3758 sub defvalopt ($$$$) {
3759 my ($long,$short,$val_re,$how) = @_;
3760 my $oi = { Long => $long, Short => $short, Re => $val_re, How => $how };
3761 $valopts_long{$long} = $oi;
3762 $valopts_short{$short} = $oi;
3763 # $how subref should:
3764 # do whatever assignemnt or thing it likes with $_[0]
3765 # if the option should not be passed on to remote, @rvalopts=()
3766 # or $how can be a scalar ref, meaning simply assign the value
3769 defvalopt '--since-version', '-v', '[^_]+|_', \$changes_since_version;
3770 defvalopt '--distro', '-d', '.+', \$idistro;
3771 defvalopt '', '-k', '.+', \$keyid;
3772 defvalopt '--existing-package','', '.*', \$existing_package;
3773 defvalopt '--build-products-dir','','.*', \$buildproductsdir;
3774 defvalopt '--clean', '', $cleanmode_re, \$cleanmode;
3775 defvalopt '--quilt', '', $quilt_modes_re, \$quilt_mode;
3777 defvalopt '', '-c', '.*=.*', sub { push @git, '-c', @_; };
3779 defvalopt '', '-C', '.+', sub {
3780 ($changesfile) = (@_);
3781 if ($changesfile =~ s#^(.*)/##) {
3782 $buildproductsdir = $1;
3786 defvalopt '--initiator-tempdir','','.*', sub {
3787 ($initiator_tempdir) = (@_);
3788 $initiator_tempdir =~ m#^/# or
3789 badusage "--initiator-tempdir must be used specify an".
3790 " absolute, not relative, directory."
3796 if (defined $ENV{'DGIT_SSH'}) {
3797 @ssh = string_to_ssh $ENV{'DGIT_SSH'};
3798 } elsif (defined $ENV{'GIT_SSH'}) {
3799 @ssh = ($ENV{'GIT_SSH'});
3807 if (!defined $val) {
3808 badusage "$what needs a value" unless @ARGV;
3810 push @rvalopts, $val;
3812 badusage "bad value \`$val' for $what" unless
3813 $val =~ m/^$oi->{Re}$(?!\n)/s;
3814 my $how = $oi->{How};
3815 if (ref($how) eq 'SCALAR') {
3820 push @ropts, @rvalopts;
3824 last unless $ARGV[0] =~ m/^-/;
3828 if (m/^--dry-run$/) {
3831 } elsif (m/^--damp-run$/) {
3834 } elsif (m/^--no-sign$/) {
3837 } elsif (m/^--help$/) {
3839 } elsif (m/^--version$/) {
3841 } elsif (m/^--new$/) {
3844 } elsif (m/^--([-0-9a-z]+)=(.+)/s &&
3845 ($om = $opts_opt_map{$1}) &&
3849 } elsif (m/^--([-0-9a-z]+):(.*)/s &&
3850 !$opts_opt_cmdonly{$1} &&
3851 ($om = $opts_opt_map{$1})) {
3854 } elsif (m/^--ignore-dirty$/s) {
3857 } elsif (m/^--no-quilt-fixup$/s) {
3859 $quilt_mode = 'nocheck';
3860 } elsif (m/^--no-rm-on-error$/s) {
3863 } elsif (m/^--(no-)?rm-old-changes$/s) {
3866 } elsif (m/^--deliberately-($deliberately_re)$/s) {
3868 push @deliberatelies, $&;
3869 } elsif (m/^--dgit-tag-format=(old|new)$/s) {
3870 # undocumented, for testing
3872 $tagformat_want = [ $1, 'command line', 1 ];
3873 # 1 menas overrides distro configuration
3874 } elsif (m/^--always-split-source-build$/s) {
3875 # undocumented, for testing
3877 $need_split_build_invocation = 1;
3878 } elsif (m/^(--[-0-9a-z]+)(=|$)/ && ($oi = $valopts_long{$1})) {
3879 $val = $2 ? $' : undef; #';
3880 $valopt->($oi->{Long});
3882 badusage "unknown long option \`$_'";
3889 } elsif (s/^-L/-/) {
3892 } elsif (s/^-h/-/) {
3894 } elsif (s/^-D/-/) {
3898 } elsif (s/^-N/-/) {
3903 push @changesopts, $_;
3905 } elsif (s/^-wn$//s) {
3907 $cleanmode = 'none';
3908 } elsif (s/^-wg$//s) {
3911 } elsif (s/^-wgf$//s) {
3913 $cleanmode = 'git-ff';
3914 } elsif (s/^-wd$//s) {
3916 $cleanmode = 'dpkg-source';
3917 } elsif (s/^-wdd$//s) {
3919 $cleanmode = 'dpkg-source-d';
3920 } elsif (s/^-wc$//s) {
3922 $cleanmode = 'check';
3923 } elsif (m/^-[a-zA-Z]/ && ($oi = $valopts_short{$&})) {
3925 $val = undef unless length $val;
3926 $valopt->($oi->{Short});
3929 badusage "unknown short option \`$_'";
3936 sub finalise_opts_opts () {
3937 foreach my $k (keys %opts_opt_map) {
3938 my $om = $opts_opt_map{$k};
3940 my $v = access_cfg("cmd-$k", 'RETURN-UNDEF');
3942 badcfg "cannot set command for $k"
3943 unless length $om->[0];
3947 foreach my $c (access_cfg_cfgs("opts-$k")) {
3948 my $vl = $gitcfg{$c};
3949 printdebug "CL $c ",
3950 ($vl ? join " ", map { shellquote } @$vl : ""),
3951 "\n" if $debuglevel >= 4;
3953 badcfg "cannot configure options for $k"
3954 if $opts_opt_cmdonly{$k};
3955 my $insertpos = $opts_cfg_insertpos{$k};
3956 @$om = ( @$om[0..$insertpos-1],
3958 @$om[$insertpos..$#$om] );
3963 if ($ENV{$fakeeditorenv}) {
3965 quilt_fixup_editor();
3971 print STDERR "DRY RUN ONLY\n" if $dryrun_level > 1;
3972 print STDERR "DAMP RUN - WILL MAKE LOCAL (UNSIGNED) CHANGES\n"
3973 if $dryrun_level == 1;
3975 print STDERR $helpmsg or die $!;
3978 my $cmd = shift @ARGV;
3981 if (!defined $rmchanges) {
3982 local $access_forpush;
3983 $rmchanges = access_cfg_bool(0, 'rm-old-changes');
3986 if (!defined $quilt_mode) {
3987 local $access_forpush;
3988 $quilt_mode = cfg('dgit.force.quilt-mode', 'RETURN-UNDEF')
3989 // access_cfg('quilt-mode', 'RETURN-UNDEF')
3991 $quilt_mode =~ m/^($quilt_modes_re)$/
3992 or badcfg "unknown quilt-mode \`$quilt_mode'";
3996 $need_split_build_invocation ||= quiltmode_splitbrain();
3998 if (!defined $cleanmode) {
3999 local $access_forpush;
4000 $cleanmode = access_cfg('clean-mode', 'RETURN-UNDEF');
4001 $cleanmode //= 'dpkg-source';
4003 badcfg "unknown clean-mode \`$cleanmode'" unless
4004 $cleanmode =~ m/^($cleanmode_re)$(?!\n)/s;
4007 my $fn = ${*::}{"cmd_$cmd"};
4008 $fn or badusage "unknown operation $cmd";