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/>.
34 use Dpkg::Control::Hash;
35 use Debian::Dgit::ExitStatus;
36 use Debian::Dgit::I18n;
40 our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
44 @EXPORT = qw(setup_sigwarn forkcheck_setup forkcheck_mainprocess
46 debiantags debiantag_new
49 stripepoch source_file_leafname is_orig_file_of_p_v
50 server_branch server_ref
51 stat_exists link_ltarget rename_link_xf
53 fail failmsg ensuredir must_getcwd executable_on_path
54 waitstatusmsg failedcmd_waitstatus
55 failedcmd_report_cmd failedcmd
56 runcmd shell_cmd cmdoutput cmdoutput_errok
57 git_rev_parse changedir_git_toplevel git_cat_file
58 git_get_ref git_get_symref git_for_each_ref
59 git_for_each_tag_referring is_fast_fwd
61 git_reflog_action_msg git_update_ref_cmd
63 reflog_cache_insert reflog_cache_lookup
64 $package_re $component_re $deliberately_re
65 $distro_re $versiontag_re $series_filename_re
66 $orig_f_comp_re $orig_f_sig_re $orig_f_tail_re
67 $extra_orig_namepart_re
70 $ffq_refprefix $gdrlast_refprefix
71 initdebug enabledebug enabledebuglevel
73 $printdebug_when_debuglevel $debugcmd_when_debuglevel
74 $debugprefix *debuglevel *DEBUG
75 shellquote printcmd messagequote
76 $negate_harmful_gitattrs
77 changedir git_slurp_config_src
78 gdr_ffq_prev_branchinfo
79 parsecontrolfh parsecontrol parsechangelog
80 getfield parsechangelog_loop
82 # implicitly uses $main::us
83 %EXPORT_TAGS = ( policyflags => [qw(NOFFCHECK FRESHREPO NOCOMMITCHECK)],
84 playground => [qw(record_maindir $maindir $local_git_cfg
85 $maindir_gitdir $maindir_gitcommon
87 ensure_a_playground)]);
88 @EXPORT_OK = ( @{ $EXPORT_TAGS{policyflags} },
89 @{ $EXPORT_TAGS{playground} } );
94 our $package_re = '[0-9a-z][-+.0-9a-z]*';
95 our $component_re = '[0-9a-zA-Z][-+.0-9a-zA-Z]*';
96 our $deliberately_re = "(?:TEST-)?$package_re";
97 our $distro_re = $component_re;
98 our $versiontag_re = qr{[-+.\%_0-9a-zA-Z/]+};
99 our $branchprefix = 'dgit';
100 our $series_filename_re = qr{(?:^|\.)series(?!\n)$}s;
101 our $extra_orig_namepart_re = qr{[-0-9a-zA-Z]+};
102 our $orig_f_comp_re = qr{orig(?:-$extra_orig_namepart_re)?};
103 our $orig_f_sig_re = '\\.(?:asc|gpg|pgp)';
104 our $orig_f_tail_re = "$orig_f_comp_re\\.tar(?:\\.\\w+)?(?:$orig_f_sig_re)?";
105 our $git_null_obj = '0' x 40;
106 our $ffq_refprefix = 'ffq-prev';
107 our $gdrlast_refprefix = 'debrebase-last';
108 our $printdebug_when_debuglevel = 1;
109 our $debugcmd_when_debuglevel = 1;
111 # these three all go together, only valid after record_maindir
114 our $maindir_gitcommon;
116 # policy hook exit status bits
117 # see dgit-repos-server head comment for documentation
118 # 1 is reserved in case something fails with `exit 1' and to spot
119 # dynamic loader, runtime, etc., failures, which report 127 or 255
120 sub NOFFCHECK () { return 0x2; }
121 sub FRESHREPO () { return 0x4; }
122 sub NOCOMMITCHECK () { return 0x8; }
127 our $negate_harmful_gitattrs =
128 "-text -eol -crlf -ident -filter -working-tree-encoding";
129 # ^ when updating this, alter the regexp in dgit:is_gitattrs_setup
131 our $forkcheck_mainprocess;
133 sub forkcheck_setup () {
134 $forkcheck_mainprocess = $$;
137 sub forkcheck_mainprocess () {
138 # You must have called forkcheck_setup or setup_sigwarn already
139 getppid != $forkcheck_mainprocess;
142 sub setup_sigwarn () {
144 $SIG{__WARN__} = sub {
145 confess $_[0] if forkcheck_mainprocess;
151 open DEBUG, ">/dev/null" or confess "$!";
155 open DEBUG, ">&STDERR" or confess "$!";
160 sub enabledebuglevel ($) {
161 my ($newlevel) = @_; # may be undef (eg from env var)
162 confess if $debuglevel;
165 return unless $newlevel;
166 $debuglevel = $newlevel;
171 # Prints a prefix, and @_, to DEBUG. @_ should normally contain
174 # With no (or only empty) arguments just prints the prefix and
175 # leaves the caller to do more with DEBUG. The caller should make
176 # sure then to call printdebug with something ending in "\n" to
177 # get the prefix right in subsequent calls.
179 return unless $debuglevel >= $printdebug_when_debuglevel;
180 our $printdebug_noprefix;
181 print DEBUG $debugprefix unless $printdebug_noprefix;
182 pop @_ while @_ and !length $_[-1];
184 print DEBUG @_ or confess "$!";
185 $printdebug_noprefix = $_[-1] !~ m{\n$};
188 sub messagequote ($) {
194 s{[\000-\037\177]}{ sprintf "\\x%02x", ord $& }ge;
201 defined or confess __ 'internal error' foreach @_;
204 if (!length || m{[^-=_./:0-9a-z]}i) {
211 return join ' ', @out;
216 my $intro = shift @_;
217 print $fh $intro," " or confess "$!";
218 print $fh shellquote @_ or confess "$!";
219 print $fh "\n" or confess "$!";
223 my $extraprefix = shift @_;
224 printcmd(\*DEBUG,$debugprefix.$extraprefix,@_)
225 if $debuglevel >= $debugcmd_when_debuglevel;
228 sub dep14_version_mangle ($) {
230 # DEP-14 patch proposed 2016-11-09 "Version Mangling"
232 $v =~ s/\.(?=\.|$|lock$)/.#/g;
236 sub debiantag_new ($$) {
237 my ($v,$distro) = @_;
238 return "archive/$distro/".dep14_version_mangle $v;
241 sub debiantag_maintview ($$) {
242 my ($v,$distro) = @_;
243 return "$distro/".dep14_version_mangle $v;
246 sub debiantags ($$) {
247 my ($version,$distro) = @_;
248 map { $_->($version, $distro) } (\&debiantag_new, \&debiantag_maintview);
257 sub upstreamversion ($) {
263 sub source_file_leafname ($$$) {
264 my ($package,$vsn,$sfx) = @_;
265 return "${package}_".(stripepoch $vsn).$sfx
268 sub is_orig_file_of_p_v ($$$) {
269 my ($f, $package, $upstreamvsn) = @_;
270 my $base = source_file_leafname $package, $upstreamvsn, '';
271 return 0 unless $f =~ m/^\Q$base\E\.$orig_f_tail_re$/;
275 sub server_branch ($) { return "$branchprefix/$_[0]"; }
276 sub server_ref ($) { return "refs/".server_branch($_[0]); }
278 sub stat_exists ($) {
281 return 0 if $!==&ENOENT;
282 confess "stat $f: $!";
286 $::us // ($0 =~ m#[^/]*$#, $&);
290 my $s = f_ "error: %s\n", "@_";
292 my $prefix = _us().": ";
293 $s =~ s/^/$prefix/gm;
302 my ($dir) = @_; # does not create parents
303 return if mkdir $dir;
304 return if $! == EEXIST;
305 confess "mkdir $dir: $!";
310 defined $d or fail f_ "getcwd failed: %s\n", $!;
314 sub executable_on_path ($) {
316 return 1 if $program =~ m{/};
317 my @path = split /:/, ($ENV{PATH} // "/usr/local/bin:/bin:/usr/bin");
318 foreach my $pe (@path) {
319 my $here = "$pe/$program";
320 return $here if stat_exists $here && -x _;
325 our @signames = split / /, $Config{sig_name};
327 sub waitstatusmsg () {
329 return __ "terminated, reporting successful completion";
330 } elsif (!($? & 255)) {
331 return f_ "failed with error exit status %s", WEXITSTATUS($?);
332 } elsif (WIFSIGNALED($?)) {
333 my $signum=WTERMSIG($?);
334 return f_ "died due to fatal signal %s",
335 ($signames[$signum] // "number $signum").
336 ($? & 128 ? " (core dumped)" : ""); # POSIX(3pm) has no WCOREDUMP
338 return f_ "failed with unknown wait status %s", $?;
342 sub failedcmd_report_cmd {
343 my $intro = shift @_;
344 $intro //= __ "failed command";
345 { local ($!); printcmd \*STDERR, _us().": $intro:", @_ or confess "$!"; };
348 sub failedcmd_waitstatus {
350 return f_ "failed to fork/exec: %s", $!;
352 return f_ "subprocess %s", waitstatusmsg();
354 return __ "subprocess produced invalid output";
359 # Expects $!,$? as set by close - see below.
360 # To use with system(), set $?=-1 first.
362 # Actual behaviour of perl operations:
363 # success $!==0 $?==0 close of piped open
364 # program failed $!==0 $? >0 close of piped open
365 # syscall failure $! >0 $?=-1 close of piped open
366 # failure $! >0 unchanged close of something else
367 # success trashed $?==0 system
368 # program failed trashed $? >0 system
369 # syscall failure $! >0 unchanged system
370 failedcmd_report_cmd undef, @_;
371 fail failedcmd_waitstatus();
377 failedcmd @_ if system @_;
381 my ($first_shell, @cmd) = @_;
382 return qw(sh -ec), $first_shell.'; exec "$@"', 'x', @cmd;
385 sub cmdoutput_errok {
386 confess Dumper(\@_)." ?" if grep { !defined } @_;
387 local $printdebug_when_debuglevel = $debugcmd_when_debuglevel;
389 open P, "-|", @_ or confess "$_[0] $!";
392 { local $/ = undef; $d = <P>; }
393 confess "$!" if P->error;
394 if (!close P) { printdebug "=>!$?\n"; return undef; }
396 if ($debuglevel > 0) {
399 my $more = (length $' ? '...' : ''); #');
400 $dd =~ s{[^\n -~]|\\}{ sprintf "\\x%02x", ord $& }ge;
401 printdebug "=> \`$dd'",$more,"\n";
407 my $d = cmdoutput_errok @_;
408 defined $d or failedcmd @_;
412 sub link_ltarget ($$) {
414 lstat $old or return undef;
416 $old = cmdoutput qw(realpath --), $old;
418 my $r = link $old, $new;
419 $r = symlink $old, $new if !$r && $!==EXDEV;
420 $r or fail "(sym)link $old $new: $!\n";
423 sub rename_link_xf ($$$) {
424 # renames/moves or links/copies $src to $dst,
425 # even if $dst is on a different fs
426 # (May use the filename "$dst.tmp".);
427 # On success, returns true.
428 # On failure, returns false and sets
429 # $@ to a reason message
430 # $! to an errno value, or -1 if not known
431 # having possibly printed something about mv to stderr.
432 # Not safe to use without $keeporig if $dst might be a symlink
433 # to $src, as it might delete $src leaving $dst invalid.
434 my ($keeporig,$src,$dst) = @_;
437 : rename $src, $dst) {
445 $@ = f_ "stat source file: %S", $!;
448 my @src_stat = (stat _)[0..1];
452 @dst_stat = (stat _)[0..1];
453 } elsif ($! == ENOENT) {
455 $@ = f_ "stat destination file: %S", $!;
459 if ("@src_stat" eq "@dst_stat") {
460 # (Symlinks to) the same file. No need for a copy but
461 # we may need to delete the original.
462 printdebug "rename_link_xf $keeporig $src $dst EXDEV but same\n";
465 my @cmd = (qw(cp --), $src, "$dst.tmp");
468 failedcmd_report_cmd undef, @cmd;
469 $@ = failedcmd_waitstatus();
473 if (!rename "$dst.tmp", $dst) {
474 $@ = f_ "finally install file after cp: %S", $!;
480 $@ = f_ "delete old file after cp: %S", $!;
489 my $h = Digest::SHA->new(256);
491 return $h->hexdigest();
494 sub git_rev_parse ($) {
495 return cmdoutput qw(git rev-parse), "$_[0]~0";
498 sub changedir_git_toplevel () {
499 my $toplevel = cmdoutput qw(git rev-parse --show-toplevel);
500 length $toplevel or fail __ <<END;
501 not in a git working tree?
502 (git rev-parse --show-toplevel produced no output)
504 chdir $toplevel or fail f_ "chdir toplevel %s: %s\n", $toplevel, $!;
507 sub git_cat_file ($;$) {
508 my ($objname, $etype) = @_;
509 # => ($type, $data) or ('missing', undef)
510 # in scalar context, just the data
511 # if $etype defined, dies unless type is $etype or in @$etype
512 our ($gcf_pid, $gcf_i, $gcf_o);
513 local $printdebug_when_debuglevel = $debugcmd_when_debuglevel;
515 my ($gtype, $data) = @_;
517 $etype = [$etype] unless ref $etype;
518 confess "$objname expected @$etype but is $gtype"
519 unless grep { $gtype eq $_ } @$etype;
521 return ($gtype, $data);
524 my @cmd = qw(git cat-file --batch);
525 debugcmd "GCF|", @cmd;
526 $gcf_pid = open2 $gcf_o, $gcf_i, @cmd or confess "$!";
528 printdebug "GCF>| $objname\n";
529 print $gcf_i $objname, "\n" or confess "$!";
531 printdebug "GCF<| ", $x;
532 if ($x =~ m/ (missing)$/) { return $chk->($1, undef); }
533 my ($type, $size) = $x =~ m/^.* (\w+) (\d+)\n/ or confess "$objname ?";
535 (read $gcf_o, $data, $size) == $size or confess "$objname $!";
537 $x eq "\n" or confess "$objname ($_) $!";
538 return $chk->($type, $data);
541 sub git_get_symref (;$) {
542 my ($symref) = @_; $symref //= 'HEAD';
543 # => undef if not a symref, otherwise refs/...
544 my @cmd = (qw(git symbolic-ref -q HEAD));
545 my $branch = cmdoutput_errok @cmd;
546 if (!defined $branch) {
547 $?==256 or failedcmd @cmd;
554 sub git_for_each_ref ($$;$) {
555 my ($pattern,$func,$gitdir) = @_;
556 # calls $func->($objid,$objtype,$fullrefname,$reftail);
557 # $reftail is RHS of ref after refs/[^/]+/
558 # breaks if $pattern matches any ref `refs/blah' where blah has no `/'
559 # $pattern may be an array ref to mean multiple patterns
560 $pattern = [ $pattern ] unless ref $pattern;
561 my @cmd = (qw(git for-each-ref), @$pattern);
562 if (defined $gitdir) {
563 @cmd = ('sh','-ec','cd "$1"; shift; exec "$@"','x', $gitdir, @cmd);
565 open GFER, "-|", @cmd or confess "$!";
568 chomp or confess "$_ ?";
569 printdebug "|> ", $_, "\n";
570 m#^(\w+)\s+(\w+)\s+(refs/[^/]+/(\S+))$# or confess "$_ ?";
571 $func->($1,$2,$3,$4);
573 $!=0; $?=0; close GFER or confess "$pattern $? $!";
576 sub git_get_ref ($) {
577 # => '' if no such ref
580 s{^refs/}{[r]efs/} or confess "$refname $_ ?";
581 return cmdoutput qw(git for-each-ref --format=%(objectname)), $_;
584 sub git_for_each_tag_referring ($$) {
585 my ($objreferring, $func) = @_;
586 # calls $func->($tagobjid,$refobjid,$fullrefname,$tagname);
587 printdebug "git_for_each_tag_referring ",
588 ($objreferring // 'UNDEF'),"\n";
589 git_for_each_ref('refs/tags', sub {
590 my ($tagobjid,$objtype,$fullrefname,$tagname) = @_;
591 return unless $objtype eq 'tag';
592 my $refobjid = git_rev_parse $tagobjid;
594 !defined $objreferring # caller wants them all
595 or $tagobjid eq $objreferring
596 or $refobjid eq $objreferring;
597 $func->($tagobjid,$refobjid,$fullrefname,$tagname);
601 sub git_check_unmodified () {
602 foreach my $cached (qw(0 1)) {
603 my @cmd = qw(git diff --quiet);
604 push @cmd, qw(--cached) if $cached;
607 $!=0; $?=-1; system @cmd;
612 ? __ "git index contains changes (does not match HEAD)"
613 : __ "working tree is dirty (does not match HEAD)";
620 sub is_fast_fwd ($$) {
621 my ($ancestor,$child) = @_;
622 my @cmd = (qw(git merge-base), $ancestor, $child);
623 my $mb = cmdoutput_errok @cmd;
625 return git_rev_parse($mb) eq git_rev_parse($ancestor);
627 $?==256 or failedcmd @cmd;
632 sub git_reflog_action_msg ($) {
634 my $rla = $ENV{GIT_REFLOG_ACTION};
635 $msg = "$rla: $msg" if length $rla;
639 sub git_update_ref_cmd {
640 # returns qw(git update-ref), qw(-m), @_
641 # except that message may be modified to honour GIT_REFLOG_ACTION
643 $msg = git_reflog_action_msg $msg;
644 return qw(git update-ref -m), $msg, @_;
649 printdebug "CD $newdir\n";
650 chdir $newdir or confess "chdir: $newdir: $!";
653 sub git_slurp_config_src ($) {
655 # returns $r such that $r->{KEY}[] = VALUE
656 my @cmd = (qw(git config -z --get-regexp), "--$src", qw(.*));
659 local ($debuglevel) = $debuglevel-2;
663 open GITS, "-|", @cmd or confess "$!";
666 printdebug "=> ", (messagequote $_), "\n";
667 m/\n/ or confess "$_ ?";
668 push @{ $r->{$`} }, $'; #';
672 or ($!==0 && $?==256)
677 sub gdr_ffq_prev_branchinfo ($) {
679 # => ('status', "message", [$symref, $ffq_prev, $gdrlast])
681 # branch message is undef
682 # weird-symref } no $symref,
683 # notbranch } no $ffq_prev
684 return ('detached', __ 'detached HEAD') unless defined $symref;
685 return ('weird-symref', __ 'HEAD symref is not to refs/')
686 unless $symref =~ m{^refs/};
687 my $ffq_prev = "refs/$ffq_refprefix/$'";
688 my $gdrlast = "refs/$gdrlast_refprefix/$'";
689 printdebug "ffq_prev_branchinfo branch current $symref\n";
690 return ('branch', undef, $symref, $ffq_prev, $gdrlast);
693 sub parsecontrolfh ($$;$) {
694 my ($fh, $desc, $allowsigned) = @_;
695 our $dpkgcontrolhash_noissigned;
698 my %opts = ('name' => $desc);
699 $opts{allow_pgp}= $allowsigned || !$dpkgcontrolhash_noissigned;
700 $c = Dpkg::Control::Hash->new(%opts);
701 $c->parse($fh,$desc) or fail f_ "parsing of %s failed", $desc;
702 last if $allowsigned;
703 last if $dpkgcontrolhash_noissigned;
704 my $issigned= $c->get_option('is_pgp_signed');
705 if (!defined $issigned) {
706 $dpkgcontrolhash_noissigned= 1;
707 seek $fh, 0,0 or confess "seek $desc: $!";
708 } elsif ($issigned) {
710 "control file %s is (already) PGP-signed. ".
711 " Note that dgit push needs to modify the .dsc and then".
712 " do the signature itself",
722 my ($file, $desc, $allowsigned) = @_;
723 my $fh = new IO::Handle;
724 open $fh, '<', $file or fail f_ "open %s (%s): %s", $file, $desc, $!;
725 my $c = parsecontrolfh($fh,$desc,$allowsigned);
726 $fh->error and confess "$!";
732 my $c = Dpkg::Control::Hash->new(name => 'parsed changelog');
733 my $p = new IO::Handle;
734 my @cmd = (qw(dpkg-parsechangelog), @_);
735 open $p, '-|', @cmd or confess "$!";
737 $?=0; $!=0; close $p or failedcmd @cmd;
742 my ($dctrl,$field) = @_;
743 my $v = $dctrl->{$field};
744 return $v if defined $v;
745 fail f_ "missing field %s in %s", $field, $dctrl->get_option('name');
748 sub parsechangelog_loop ($$$) {
749 my ($clogcmd, $descbase, $fn) = @_;
750 # @$clogcmd is qw(dpkg-parsechangelog ...some...options...)
751 # calls $fn->($thisstanza, $desc);
752 debugcmd "|",@$clogcmd;
753 open CLOGS, "-|", @$clogcmd or confess "$!";
755 my $stanzatext = do { local $/=""; <CLOGS>; };
756 printdebug "clogp stanza ".Dumper($stanzatext) if $debuglevel>1;
757 last if !defined $stanzatext;
759 my $desc = "$descbase, entry no.$.";
760 open my $stanzafh, "<", \$stanzatext or confess;
761 my $thisstanza = parsecontrolfh $stanzafh, $desc, 1;
763 $fn->($thisstanza, $desc);
765 confess "$!" if CLOGS->error;
766 close CLOGS or $?==SIGPIPE or failedcmd @$clogcmd;
769 sub make_commit_text ($) {
772 my @cmd = (qw(git hash-object -w -t commit --stdin));
774 print Dumper($text) if $debuglevel > 1;
775 my $child = open2($out, $in, @cmd) or confess "$!";
778 print $in $text or confess "$!";
779 close $in or confess "$!";
781 $h =~ m/^\w+$/ or confess;
783 printdebug "=> $h\n";
786 waitpid $child, 0 == $child or confess "$child $!";
787 $? and failedcmd @cmd;
791 sub reflog_cache_insert ($$$) {
792 my ($ref, $cachekey, $value) = @_;
793 # you must call this in $maindir
794 # you must have called record_maindir
796 # When we no longer need to support squeeze, use --create-reflog
798 my $parent = $ref; $parent =~ s{/[^/]+$}{};
799 ensuredir "$maindir_gitcommon/logs/$parent";
800 my $makelogfh = new IO::File "$maindir_gitcommon/logs/$ref", '>>'
803 my $oldcache = git_get_ref $ref;
805 if ($oldcache eq $value) {
806 my $tree = cmdoutput qw(git rev-parse), "$value:";
807 # git update-ref doesn't always update, in this case. *sigh*
808 my $authline = (ucfirst _us()).
809 ' <'._us().'@example.com> 1000000000 +0000';
810 my $dummy = make_commit_text <<ENDU.(__ <<END);
817 Dummy commit - do not use
819 runcmd qw(git update-ref -m), _us()." - dummy", $ref, $dummy;
821 runcmd qw(git update-ref -m), $cachekey, $ref, $value;
824 sub reflog_cache_lookup ($$) {
825 my ($ref, $cachekey) = @_;
826 # you may call this in $maindir or in a playtree
827 # you must have called record_maindir
828 my @cmd = (qw(git log -g), '--pretty=format:%H %gs', $ref);
829 debugcmd "|(probably)",@cmd;
830 my $child = open GC, "-|"; defined $child or confess "$!";
832 chdir $maindir or confess "$!";
833 if (!stat "$maindir_gitcommon/logs/$ref") {
834 $! == ENOENT or confess "$!";
835 printdebug ">(no reflog)\n";
838 exec @cmd; die f_ "exec %s: %s\n", $cmd[0], $!;
842 printdebug ">| ", $_, "\n" if $debuglevel > 1;
843 next unless m/^(\w+) (\S.*\S)$/ && $2 eq $cachekey;
847 confess "$!" if GC->error;
848 failedcmd unless close GC;
852 # ========== playground handling ==========
856 # $maindir user's git working tree
857 # playground area in .git/ where we can make files, unpack, etc. etc.
858 # playtree git working tree sharing object store with the user's
859 # inside playground, or identical to it
863 # $local_git_cfg hash of arrays of values: git config from $maindir
865 # expected calling pattern
870 # must be run in directory containing .git
871 # assigns to $maindir if not already set
872 # also calls git_slurp_config_src to record git config
873 # in $local_git_cfg, unless it's already set
875 # fresh_playground SUBDIR_PATH_COMPONENTS
876 # e.g fresh_playground 'dgit/unpack' ('.git/' is implied)
877 # default SUBDIR_PATH_COMPONENTS is playground_subdir
878 # calls record_maindir
879 # sets up a new playground (destroying any old one)
880 # returns playground pathname
881 # caller may call multiple times with different subdir paths
882 # createing different playgrounds
884 # ensure_a_playground SUBDIR_PATH_COMPONENTS
885 # like fresh_playground except:
886 # merely ensures the directory exists; does not delete an existing one
890 # changedir playground
893 # playtree_setup $local_git_cfg
894 # # ^ call in some (perhaps trivial) subdir of playground
898 # ----- maindir -----
902 sub record_maindir () {
903 if (!defined $maindir) {
904 $maindir = must_getcwd();
905 if (!stat "$maindir/.git") {
906 fail f_ "cannot stat %s/.git: %s", $maindir, $!;
909 # we fall back to this in case we have a pre-worktree
910 # git, which may not know git rev-parse --git-common-dir
911 $maindir_gitdir = "$maindir/.git";
912 $maindir_gitcommon = "$maindir/.git";
914 $maindir_gitdir = cmdoutput qw(git rev-parse --git-dir);
915 $maindir_gitcommon = cmdoutput qw(git rev-parse --git-common-dir);
918 $local_git_cfg //= git_slurp_config_src 'local';
921 # ----- playgrounds -----
923 sub ensure_a_playground_parent ($) {
926 $spc = "$maindir_gitdir/$spc";
927 my $parent = dirname $spc;
928 mkdir $parent or $!==EEXIST or fail f_
929 "failed to mkdir playground parent %s: %s", $parent, $!;
933 sub ensure_a_playground ($) {
935 $spc = ensure_a_playground_parent $spc;
936 mkdir $spc or $!==EEXIST or fail f_
937 "failed to mkdir a playground %s: %s", $spc, $!;
941 sub fresh_playground ($) {
943 $spc = ensure_a_playground_parent $spc;
945 mkdir $spc or fail f_
946 "failed to mkdir the playground %s: %s", $spc, $!;
950 # ----- playtrees -----
952 sub playtree_setup (;$) {
953 my ($t_local_git_cfg) = @_;
954 $t_local_git_cfg //= $local_git_cfg;
955 # for use in the playtree
956 # $maindir must be set, eg by calling record_maindir or fresh_playground
957 runcmd qw(git init -q);
958 runcmd qw(git config gc.auto 0);
959 foreach my $copy (qw(user.email user.name user.useConfigOnly
960 core.sharedRepository
961 core.compression core.looseCompression
962 core.bigFileThreshold core.fsyncObjectFiles)) {
963 my $v = $t_local_git_cfg->{$copy};
965 runcmd qw(git config), $copy, $_ foreach @$v;
967 # this is confusing: we have
968 # . playtree, not a worktree, has .git/, our cwd
969 # $maindir might be a worktree so
970 # $maindir_gitdir contains our main working "dgit", HEAD, etc.
971 # $maindir_gitcommon the shared stuff, including .objects
972 rmtree('.git/objects');
973 symlink "$maindir_gitcommon/objects",'.git/objects' or confess "$!";
974 ensuredir '.git/info';
975 open GA, "> .git/info/attributes" or confess "$!";
976 print GA "* $negate_harmful_gitattrs\n" or confess "$!";
977 close GA or confess "$!";