3 # Debian::Dgit: functions common to dgit and its helpers and servers
5 # Copyright (C) 2015-2016 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/>.
37 our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
41 @EXPORT = qw(setup_sigwarn forkcheck_setup forkcheck_mainprocess
43 debiantags debiantag_old debiantag_new
44 server_branch server_ref
45 stat_exists link_ltarget
47 fail ensuredir must_getcwd executable_on_path
48 waitstatusmsg failedcmd_waitstatus
49 failedcmd_report_cmd failedcmd
50 runcmd cmdoutput cmdoutput_errok
51 git_rev_parse git_cat_file
52 git_get_ref git_get_symref git_for_each_ref
53 git_for_each_tag_referring is_fast_fwd
55 $package_re $component_re $deliberately_re
56 $distro_re $versiontag_re $series_filename_re
57 $extra_orig_namepart_re
60 $ffq_refprefix $gdrlast_refprefix
61 initdebug enabledebug enabledebuglevel
63 $debugprefix *debuglevel *DEBUG
64 shellquote printcmd messagequote
65 $negate_harmful_gitattrs
66 changedir git_slurp_config_src
68 # implicitly uses $main::us
69 %EXPORT_TAGS = ( policyflags => [qw(NOFFCHECK FRESHREPO NOCOMMITCHECK)],
70 playground => [qw(record_maindir $maindir $local_git_cfg
71 $maindir_gitdir $maindir_gitcommon
73 ensure_a_playground)]);
74 @EXPORT_OK = ( @{ $EXPORT_TAGS{policyflags} },
75 @{ $EXPORT_TAGS{playground} } );
80 our $package_re = '[0-9a-z][-+.0-9a-z]*';
81 our $component_re = '[0-9a-zA-Z][-+.0-9a-zA-Z]*';
82 our $deliberately_re = "(?:TEST-)?$package_re";
83 our $distro_re = $component_re;
84 our $versiontag_re = qr{[-+.\%_0-9a-zA-Z/]+};
85 our $branchprefix = 'dgit';
86 our $series_filename_re = qr{(?:^|\.)series(?!\n)$}s;
87 our $extra_orig_namepart_re = qr{[-0-9a-z]+};
88 our $git_null_obj = '0' x 40;
89 our $ffq_refprefix = 'ffq-prev';
90 our $gdrlast_refprefix = 'debrebase-last';
92 # policy hook exit status bits
93 # see dgit-repos-server head comment for documentation
94 # 1 is reserved in case something fails with `exit 1' and to spot
95 # dynamic loader, runtime, etc., failures, which report 127 or 255
96 sub NOFFCHECK () { return 0x2; }
97 sub FRESHREPO () { return 0x4; }
98 sub NOCOMMITCHECK () { return 0x8; }
103 our $negate_harmful_gitattrs = "-text -eol -crlf -ident -filter";
105 our $forkcheck_mainprocess;
107 sub forkcheck_setup () {
108 $forkcheck_mainprocess = $$;
111 sub forkcheck_mainprocess () {
112 # You must have called forkcheck_setup or setup_sigwarn already
113 getppid != $forkcheck_mainprocess;
116 sub setup_sigwarn () {
118 $SIG{__WARN__} = sub {
119 confess $_[0] if forkcheck_mainprocess;
125 open DEBUG, ">/dev/null" or die $!;
129 open DEBUG, ">&STDERR" or die $!;
134 sub enabledebuglevel ($) {
135 my ($newlevel) = @_; # may be undef (eg from env var)
139 return unless $newlevel;
140 $debuglevel = $newlevel;
145 print DEBUG $debugprefix, @_ or die $! if $debuglevel>0;
148 sub messagequote ($) {
154 s{[\000-\037\177]}{ sprintf "\\x%02x", ord $& }ge;
161 defined or confess 'internal error' foreach @_;
164 if (!length || m{[^-=_./:0-9a-z]}i) {
171 return join ' ', @out;
176 my $intro = shift @_;
177 print $fh $intro," " or die $!;
178 print $fh shellquote @_ or die $!;
179 print $fh "\n" or die $!;
183 my $extraprefix = shift @_;
184 printcmd(\*DEBUG,$debugprefix.$extraprefix,@_) if $debuglevel>0;
187 sub dep14_version_mangle ($) {
189 # DEP-14 patch proposed 2016-11-09 "Version Mangling"
191 $v =~ s/\.(?=\.|$|lock$)/.#/g;
195 sub debiantag_old ($$) {
196 my ($v,$distro) = @_;
197 return "$distro/". dep14_version_mangle $v;
200 sub debiantag_new ($$) {
201 my ($v,$distro) = @_;
202 return "archive/$distro/".dep14_version_mangle $v;
205 sub debiantags ($$) {
206 my ($version,$distro) = @_;
207 map { $_->($version, $distro) } (\&debiantag_new, \&debiantag_old);
210 sub server_branch ($) { return "$branchprefix/$_[0]"; }
211 sub server_ref ($) { return "refs/".server_branch($_[0]); }
213 sub stat_exists ($) {
216 return 0 if $!==&ENOENT;
221 $::us // ($0 =~ m#[^/]*$#, $&);
227 my $prefix = _us().": ";
228 $s =~ s/^/$prefix/gm;
233 my ($dir) = @_; # does not create parents
234 return if mkdir $dir;
235 return if $! == EEXIST;
236 die "mkdir $dir: $!";
241 defined $d or fail "getcwd failed: $!";
245 sub executable_on_path ($) {
247 return 1 if $program =~ m{/};
248 my @path = split /:/, ($ENV{PATH} // "/usr/local/bin:/bin:/usr/bin");
249 foreach my $pe (@path) {
250 my $here = "$pe/$program";
251 return $here if stat_exists $here && -x _;
256 our @signames = split / /, $Config{sig_name};
258 sub waitstatusmsg () {
260 return "terminated, reporting successful completion";
261 } elsif (!($? & 255)) {
262 return "failed with error exit status ".WEXITSTATUS($?);
263 } elsif (WIFSIGNALED($?)) {
264 my $signum=WTERMSIG($?);
265 return "died due to fatal signal ".
266 ($signames[$signum] // "number $signum").
267 ($? & 128 ? " (core dumped)" : ""); # POSIX(3pm) has no WCOREDUMP
269 return "failed with unknown wait status ".$?;
273 sub failedcmd_report_cmd {
274 my $intro = shift @_;
275 $intro //= "failed command";
276 { local ($!); printcmd \*STDERR, _us().": $intro:", @_ or die $!; };
279 sub failedcmd_waitstatus {
281 return "failed to fork/exec: $!";
283 return "subprocess ".waitstatusmsg();
285 return "subprocess produced invalid output";
290 # Expects $!,$? as set by close - see below.
291 # To use with system(), set $?=-1 first.
293 # Actual behaviour of perl operations:
294 # success $!==0 $?==0 close of piped open
295 # program failed $!==0 $? >0 close of piped open
296 # syscall failure $! >0 $?=-1 close of piped open
297 # failure $! >0 unchanged close of something else
298 # success trashed $?==0 system
299 # program failed trashed $? >0 system
300 # syscall failure $! >0 unchanged system
301 failedcmd_report_cmd undef, @_;
302 fail failedcmd_waitstatus();
308 failedcmd @_ if system @_;
311 sub cmdoutput_errok {
312 confess Dumper(\@_)." ?" if grep { !defined } @_;
314 open P, "-|", @_ or die "$_[0] $!";
317 { local $/ = undef; $d = <P>; }
319 if (!close P) { printdebug "=>!$?\n"; return undef; }
321 if ($debuglevel > 0) {
324 my $more = (length $' ? '...' : ''); #');
325 $dd =~ s{[^\n -~]|\\}{ sprintf "\\x%02x", ord $& }ge;
326 printdebug "=> \`$dd'",$more,"\n";
332 my $d = cmdoutput_errok @_;
333 defined $d or failedcmd @_;
337 sub link_ltarget ($$) {
339 lstat $old or return undef;
341 $old = cmdoutput qw(realpath --), $old;
343 my $r = link $old, $new;
344 $r = symlink $old, $new if !$r && $!==EXDEV;
345 $r or die "(sym)link $old $new: $!";
350 my $h = Digest::SHA->new(256);
352 return $h->hexdigest();
355 sub git_rev_parse ($) {
356 return cmdoutput qw(git rev-parse), "$_[0]~0";
359 sub git_cat_file ($;$) {
360 my ($objname, $etype) = @_;
361 # => ($type, $data) or ('missing', undef)
362 # in scalar context, just the data
363 # if $etype defined, dies unless type is $etype or in @$etype
364 our ($gcf_pid, $gcf_i, $gcf_o);
366 my ($gtype, $data) = @_;
368 $etype = [$etype] unless ref $etype;
369 confess "$objname expected @$etype but is $gtype"
370 unless grep { $gtype eq $_ } @$etype;
372 return ($gtype, $data);
375 my @cmd = qw(git cat-file --batch);
376 debugcmd "GCF|", @cmd;
377 $gcf_pid = open2 $gcf_o, $gcf_i, @cmd or die $!;
379 printdebug "GCF>| ", $objname, "\n";
380 print $gcf_i $objname, "\n" or die $!;
382 printdebug "GCF<| ", $x;
383 if ($x =~ m/ (missing)$/) { return $chk->($1, undef); }
384 my ($type, $size) = $x =~ m/^.* (\w+) (\d+)\n/ or die "$objname ?";
386 (read $gcf_o, $data, $size) == $size or die "$objname $!";
388 $x eq "\n" or die "$objname ($_) $!";
389 return $chk->($type, $data);
392 sub git_get_symref (;$) {
393 my ($symref) = @_; $symref //= 'HEAD';
394 # => undef if not a symref, otherwise refs/...
395 my @cmd = (qw(git symbolic-ref -q HEAD));
396 my $branch = cmdoutput_errok @cmd;
397 if (!defined $branch) {
398 $?==256 or failedcmd @cmd;
405 sub git_for_each_ref ($$;$) {
406 my ($pattern,$func,$gitdir) = @_;
407 # calls $func->($objid,$objtype,$fullrefname,$reftail);
408 # $reftail is RHS of ref after refs/[^/]+/
409 # breaks if $pattern matches any ref `refs/blah' where blah has no `/'
410 # $pattern may be an array ref to mean multiple patterns
411 $pattern = [ $pattern ] unless ref $pattern;
412 my @cmd = (qw(git for-each-ref), @$pattern);
413 if (defined $gitdir) {
414 @cmd = ('sh','-ec','cd "$1"; shift; exec "$@"','x', $gitdir, @cmd);
416 open GFER, "-|", @cmd or die $!;
420 printdebug "|> ", $_, "\n";
421 m#^(\w+)\s+(\w+)\s+(refs/[^/]+/(\S+))$# or die "$_ ?";
422 $func->($1,$2,$3,$4);
424 $!=0; $?=0; close GFER or die "$pattern $? $!";
427 sub git_get_ref ($) {
428 # => '' if no such ref
431 s{^refs/}{[r]efs/} or die "$refname $_ ?";
432 return cmdoutput qw(git for-each-ref --format=%(objectname)), $_;
435 sub git_for_each_tag_referring ($$) {
436 my ($objreferring, $func) = @_;
437 # calls $func->($tagobjid,$refobjid,$fullrefname,$tagname);
438 printdebug "git_for_each_tag_referring ",
439 ($objreferring // 'UNDEF'),"\n";
440 git_for_each_ref('refs/tags', sub {
441 my ($tagobjid,$objtype,$fullrefname,$tagname) = @_;
442 return unless $objtype eq 'tag';
443 my $refobjid = git_rev_parse $tagobjid;
445 !defined $objreferring # caller wants them all
446 or $tagobjid eq $objreferring
447 or $refobjid eq $objreferring;
448 $func->($tagobjid,$refobjid,$fullrefname,$tagname);
452 sub git_check_unmodified () {
453 foreach my $cached (qw(0 1)) {
454 my @cmd = qw(git diff --quiet);
455 push @cmd, qw(--cached) if $cached;
458 $!=0; $?=-1; system @cmd;
463 ? "git index contains changes (does not match HEAD)"
464 : "working tree is dirty (does not match HEAD)";
471 sub is_fast_fwd ($$) {
472 my ($ancestor,$child) = @_;
473 my @cmd = (qw(git merge-base), $ancestor, $child);
474 my $mb = cmdoutput_errok @cmd;
476 return git_rev_parse($mb) eq git_rev_parse($ancestor);
478 $?==256 or failedcmd @cmd;
485 printdebug "CD $newdir\n";
486 chdir $newdir or confess "chdir: $newdir: $!";
489 sub git_slurp_config_src ($) {
491 # returns $r such that $r->{KEY}[] = VALUE
492 my @cmd = (qw(git config -z --get-regexp), "--$src", qw(.*));
495 local ($debuglevel) = $debuglevel-2;
499 open GITS, "-|", @cmd or die $!;
502 printdebug "=> ", (messagequote $_), "\n";
504 push @{ $r->{$`} }, $'; #';
508 or ($!==0 && $?==256)
513 # ========== playground handling ==========
517 # $maindir user's git working tree
518 # playground area in .git/ where we can make files, unpack, etc. etc.
519 # playtree git working tree sharing object store with the user's
520 # inside playground, or identical to it
524 # $local_git_cfg hash of arrays of values: git config from $maindir
526 # expected calling pattern
531 # must be run in directory containing .git
532 # assigns to $maindir if not already set
533 # also calls git_slurp_config_src to record git config
534 # in $local_git_cfg, unless it's already set
536 # fresh_playground SUBDIR_PATH_COMPONENTS
537 # e.g fresh_playground 'dgit/unpack' ('.git/' is implied)
538 # default SUBDIR_PATH_COMPONENTS is playground_subdir
539 # calls record_maindir
540 # sets up a new playground (destroying any old one)
541 # returns playground pathname
542 # caller may call multiple times with different subdir paths
543 # createing different playgrounds
545 # ensure_a_playground SUBDIR_PATH_COMPONENTS
546 # like fresh_playground except:
547 # merely ensures the directory exists; does not delete an existing one
551 # changedir playground
554 # playtree_setup $local_git_cfg
555 # # ^ call in some (perhaps trivial) subdir of playground
559 # ----- maindir -----
561 # these three all go together
564 our $maindir_gitcommon;
568 sub record_maindir () {
569 if (!defined $maindir) {
570 $maindir = must_getcwd();
571 if (!stat "$maindir/.git") {
572 fail "cannot stat $maindir/.git: $!";
575 # we fall back to this in case we have a pre-worktree
576 # git, which may not know git rev-parse --git-common-dir
577 $maindir_gitdir = "$maindir/.git";
578 $maindir_gitcommon = "$maindir/.git";
580 $maindir_gitdir = cmdoutput qw(git rev-parse --git-dir);
581 $maindir_gitcommon = cmdoutput qw(git rev-parse --git-common-dir);
584 $local_git_cfg //= git_slurp_config_src 'local';
587 # ----- playgrounds -----
589 sub ensure_a_playground_parent ($) {
592 $spc = "$maindir_gitdir/$spc";
593 my $parent = dirname $spc;
594 mkdir $parent or $!==EEXIST
595 or fail "failed to mkdir playground parent $parent: $!";
599 sub ensure_a_playground ($) {
601 $spc = ensure_a_playground_parent $spc;
602 mkdir $spc or $!==EEXIST or fail "failed to mkdir a playground $spc: $!";
606 sub fresh_playground ($) {
608 $spc = ensure_a_playground_parent $spc;
610 mkdir $spc or fail "failed to mkdir the playground $spc: $!";
614 # ----- playtrees -----
616 sub playtree_setup (;$) {
617 my ($t_local_git_cfg) = @_;
618 $t_local_git_cfg //= $local_git_cfg;
619 # for use in the playtree
620 # $maindir must be set, eg by calling record_maindir or fresh_playground
621 runcmd qw(git init -q);
622 runcmd qw(git config gc.auto 0);
623 foreach my $copy (qw(user.email user.name user.useConfigOnly
624 core.sharedRepository
625 core.compression core.looseCompression
626 core.bigFileThreshold core.fsyncObjectFiles)) {
627 my $v = $t_local_git_cfg->{$copy};
629 runcmd qw(git config), $copy, $_ foreach @$v;
631 # this is confusing: we have
632 # . playtree, not a worktree, has .git/, our cwd
633 # $maindir might be a worktree so
634 # $maindir_gitdir contains our main working "dgit", HEAD, etc.
635 # $maindir_gitcommon the shared stuff, including .objects
636 rmtree('.git/objects');
637 symlink "$maindir_gitcommon/objects",'.git/objects' or die $!;
638 ensuredir '.git/info';
639 open GA, "> .git/info/attributes" or die $!;
640 print GA "* $negate_harmful_gitattrs\n" or die $!;