-# Copyright (C) 2014-2019 all contributors <meta@public-inbox.org>
+# Copyright (C) all contributors <meta@public-inbox.org>
# License: GPLv2 or later <https://www.gnu.org/licenses/gpl-2.0.txt>
#
# Used to read files from a git repository without excessive forking.
# There are also API changes to simplify our usage and data set.
package PublicInbox::Git;
use strict;
-use warnings;
-use POSIX qw(dup2);
+use v5.10.1;
+use parent qw(Exporter);
+use POSIX ();
use IO::Handle; # ->autoflush
-use PublicInbox::Spawn qw(spawn popen_rd);
+use Errno qw(EINTR EAGAIN);
+use File::Glob qw(bsd_glob GLOB_NOSORT);
+use File::Spec ();
+use Time::HiRes qw(stat);
+use PublicInbox::Spawn qw(popen_rd which);
use PublicInbox::Tmpfile;
-use base qw(Exporter);
+use IO::Poll qw(POLLIN);
+use Carp qw(croak carp);
+use PublicInbox::SHA ();
+use PublicInbox::DS qw(awaitpid);
our @EXPORT_OK = qw(git_unquote git_quote);
-
-use constant MAX_INFLIGHT =>
- ($^O eq 'linux' ? 4096 : POSIX::_POSIX_PIPE_BUF())
- /
- 65; # SHA-256 hex size + "\n" in preparation for git using non-SHA1
+our $PIPE_BUFSIZ = 65536; # Linux default
+our $in_cleanup;
+our $RDTIMEO = 60_000; # milliseconds
+our $async_warn; # true in read-only daemons
+
+# 512: POSIX PIPE_BUF minimum (see pipe(7))
+# 3: @$inflight is flattened [ $OID, $cb, $arg ]
+# 65: SHA-256 hex size + "\n" in preparation for git using non-SHA1
+use constant {
+ MAX_INFLIGHT => 512 * 3 / (65 + length('contents ')),
+ BATCH_CMD_VER => (2 << 24 | 36 << 16), # git 2.36+
+};
my %GIT_ESC = (
a => "\a",
);
my %ESC_GIT = map { $GIT_ESC{$_} => $_ } keys %GIT_ESC;
+my $EXE_ST = ''; # pack('dd', st_ctime, st_size);
+my ($GIT_EXE, $GIT_VER);
+
+sub version {
+ check_git_exe();
+ $GIT_VER;
+}
+
+sub check_git_exe () {
+ $GIT_EXE = which('git') // die "git not found in $ENV{PATH}";
+ my @st = stat($GIT_EXE) or die "stat: $!";
+ my $st = pack('dd', $st[10], $st[7]);
+ if ($st ne $EXE_ST) {
+ my $rd = popen_rd([ $GIT_EXE, '--version' ]);
+ my $v = readline($rd);
+ $v =~ /\b([0-9]+(?:\.[0-9]+){2})/ or die
+ "$GIT_EXE --version output: $v # unparseable";
+ my @v = split(/\./, $1, 3);
+ $GIT_VER = ($v[0] << 24) | ($v[1] << 16) | $v[2];
+ $EXE_ST = $st;
+ }
+}
# unquote pathnames used by git, see quote.c::unquote_c_style.c in git.git
sub git_unquote ($) {
return $_[0] unless ($_[0] =~ /\A"(.*)"\z/);
$_[0] = $1;
- $_[0] =~ s/\\([\\"abfnrtv])/$GIT_ESC{$1}/g;
- $_[0] =~ s/\\([0-7]{1,3})/chr(oct($1))/ge;
+ $_[0] =~ s!\\([\\"abfnrtv]|[0-3][0-7]{2})!$GIT_ESC{$1}//chr(oct($1))!ge;
$_[0];
}
sub git_quote ($) {
if ($_[0] =~ s/([\\"\a\b\f\n\r\t\013]|[^[:print:]])/
- '\\'.($ESC_GIT{$1}||sprintf("%0o",ord($1)))/egs) {
+ '\\'.($ESC_GIT{$1}||sprintf("%03o",ord($1)))/egs) {
return qq{"$_[0]"};
}
$_[0];
sub new {
my ($class, $git_dir) = @_;
- my @st;
- $st[7] = $st[10] = 0;
+ $git_dir =~ tr!/!/!s;
+ $git_dir =~ s!/*\z!!s;
# may contain {-tmp} field for File::Temp::Dir
- bless { git_dir => $git_dir, st => \@st, -git_path => {} }, $class
+ bless { git_dir => $git_dir }, $class
}
sub git_path ($$) {
my ($self, $path) = @_;
- $self->{-git_path}->{$path} ||= do {
+ $self->{-git_path}->{$path} //= do {
local $/ = "\n";
chomp(my $str = $self->qx(qw(rev-parse --git-path), $path));
my ($self) = @_;
my $alt = git_path($self, 'objects/info/alternates');
my @st = stat($alt) or return 0;
- my $old_st = $self->{st};
- # 10 - ctime, 7 - size
- return 0 if ($st[10] == $old_st->[10] && $st[7] == $old_st->[7]);
- $self->{st} = \@st;
+
+ # can't rely on 'q' on some 32-bit builds, but `d' works
+ my $st = pack('dd', $st[10], $st[7]); # 10: ctime, 7: size
+ return 0 if ($self->{alt_st} // '') eq $st;
+ $self->{alt_st} = $st; # always a true value
+}
+
+sub object_format {
+ $_[0]->{object_format} //= do {
+ my $fmt = $_[0]->qx(qw(config extensions.objectformat));
+ $fmt eq "sha256\n" ? \'sha256' : \undef;
+ }
}
sub last_check_err {
my ($self) = @_;
my $fh = $self->{err_c} or return;
- sysseek($fh, 0, 0) or fail($self, "sysseek failed: $!");
+ sysseek($fh, 0, 0) or $self->fail("sysseek failed: $!");
defined(sysread($fh, my $buf, -s $fh)) or
- fail($self, "sysread failed: $!");
+ $self->fail("sysread failed: $!");
$buf;
}
if ($self->{$pid}) {
if (defined $err) { # "err_c"
my $fh = $self->{$err};
- sysseek($fh, 0, 0) or fail($self, "sysseek failed: $!");
- truncate($fh, 0) or fail($self, "truncate failed: $!");
+ sysseek($fh, 0, 0) or $self->fail("sysseek failed: $!");
+ truncate($fh, 0) or $self->fail("truncate failed: $!");
}
return;
}
- my ($in_r, $in_w, $out_r, $out_w);
- pipe($in_r, $in_w) or fail($self, "pipe failed: $!");
- pipe($out_r, $out_w) or fail($self, "pipe failed: $!");
- if ($^O eq 'linux') { # 1031: F_SETPIPE_SZ
- fcntl($out_w, 1031, 4096);
- fcntl($in_w, 1031, 4096) if $batch eq '--batch-check';
+ pipe(my ($out_r, $out_w)) or $self->fail("pipe failed: $!");
+ my $rdr = { 0 => $out_r, pgid => 0 };
+ my $gd = $self->{git_dir};
+ if ($gd =~ s!/([^/]+/[^/]+)\z!/!) {
+ $rdr->{-C} = $gd;
+ $gd = $1;
}
- my @cmd = (qw(git), "--git-dir=$self->{git_dir}",
- qw(-c core.abbrev=40 cat-file), $batch);
- my $redir = { 0 => $out_r, 1 => $in_w };
+ # git 2.31.0+ supports -c core.abbrev=no, don't bother with
+ # core.abbrev=64 since not many releases had SHA-256 prior to 2.31
+ my $abbr = $GIT_VER < (2 << 24 | 31 << 16) ? 40 : 'no';
+ my @cmd = ($GIT_EXE, "--git-dir=$gd", '-c', "core.abbrev=$abbr",
+ 'cat-file', "--$batch");
if ($err) {
- my $id = "git.$self->{git_dir}$batch.err";
- my $fh = tmpfile($id) or fail($self, "tmpfile($id): $!");
+ my $id = "git.$self->{git_dir}.$batch.err";
+ my $fh = tmpfile($id) or $self->fail("tmpfile($id): $!");
$self->{$err} = $fh;
- $redir->{2} = $fh;
+ $rdr->{2} = $fh;
}
- my $p = spawn(\@cmd, undef, $redir);
- $self->{$pid} = $p;
+ # see lib/PublicInbox/ProcessPipe.pm for why we don't use that here
+ my ($in_r, $p) = popen_rd(\@cmd, undef, $rdr);
+ awaitpid($self->{$pid} = $p, undef);
+ $self->{"$pid.owner"} = $$;
$out_w->autoflush(1);
+ if ($^O eq 'linux') { # 1031: F_SETPIPE_SZ
+ fcntl($out_w, 1031, 4096);
+ fcntl($in_r, 1031, 4096) if $batch eq 'batch-check';
+ }
+ $out_w->blocking(0);
$self->{$out} = $out_w;
$self->{$in} = $in_r;
}
-sub read_cat_in_full ($$$) {
- my ($self, $in, $left) = @_;
- my $offset = 0;
- my $buf = '';
+sub poll_in ($) { IO::Poll::_poll($RDTIMEO, fileno($_[0]), my $ev = POLLIN) }
+
+sub my_read ($$$) {
+ my ($fh, $rbuf, $len) = @_;
+ my $left = $len - length($$rbuf);
+ my $r;
while ($left > 0) {
- my $r = read($in, $buf, $left, $offset);
- defined($r) or fail($self, "read failed: $!");
- $r == 0 and fail($self, 'exited unexpectedly');
- $left -= $r;
- $offset += $r;
+ $r = sysread($fh, $$rbuf, $PIPE_BUFSIZ, length($$rbuf));
+ if ($r) {
+ $left -= $r;
+ } elsif (defined($r)) { # EOF
+ return 0;
+ } else {
+ next if ($! == EAGAIN and poll_in($fh));
+ next if $! == EINTR; # may be set by sysread or poll_in
+ return; # unrecoverable error
+ }
}
- my $r = read($in, my $lf, 1);
- defined($r) or fail($self, "read failed: $!");
- fail($self, 'newline missing after blob') if ($r != 1 || $lf ne "\n");
- \$buf;
+ my $no_pad = substr($$rbuf, 0, $len, '');
+ \$no_pad;
}
-sub _cat_async_step ($$$) {
- my ($self, $inflight, $in) = @_;
- my $pair = shift @$inflight or die 'BUG: inflight empty';
- my ($cb, $arg) = @$pair;
- local $/ = "\n";
- my $head = $in->getline;
- $head =~ / missing$/ and return
- eval { $cb->(undef, undef, undef, undef, $arg) };
+sub my_readline ($$) {
+ my ($fh, $rbuf) = @_;
+ while (1) {
+ if ((my $n = index($$rbuf, "\n")) >= 0) {
+ return substr($$rbuf, 0, $n + 1, '');
+ }
+ my $r = sysread($fh, $$rbuf, $PIPE_BUFSIZ, length($$rbuf))
+ and next;
+
+ # return whatever's left on EOF
+ return substr($$rbuf, 0, length($$rbuf)+1, '') if defined($r);
+
+ next if ($! == EAGAIN and poll_in($fh));
+ next if $! == EINTR; # may be set by sysread or poll_in
+ return; # unrecoverable error
+ }
+}
+
+sub cat_async_retry ($$) {
+ my ($self, $inflight) = @_;
+
+ # {inflight} may be non-existent, but if it isn't we delete it
+ # here to prevent cleanup() from waiting:
+ delete $self->{inflight};
+ cleanup($self);
+
+ $self->{inflight} = $inflight;
+ batch_prepare($self);
+ my $buf = '';
+ for (my $i = 0; $i < @$inflight; $i += 3) {
+ $buf .= "$inflight->[$i]\n";
+ }
+ $self->{out}->blocking(1); # brand new pipe, should never block
+ print { $self->{out} } $buf or $self->fail("write error: $!");
+ $self->{out}->blocking(0);
+ my $req = shift @$inflight;
+ unshift(@$inflight, \$req); # \$ref to indicate retried
- $head =~ /^([0-9a-f]{40}) (\S+) ([0-9]+)$/ or
- fail($self, "Unexpected result from async git cat-file: $head");
- my ($oid_hex, $type, $size) = ($1, $2, $3 + 0);
- my $bref = read_cat_in_full($self, $in, $size);
- eval { $cb->($bref, $oid_hex, $type, $size, $arg) };
+ cat_async_step($self, $inflight); # take one step
+}
+
+# returns true if prefetch is successful
+sub async_prefetch {
+ my ($self, $oid, $cb, $arg) = @_;
+ my $inflight = $self->{inflight} or return;
+ return if @$inflight;
+ substr($oid, 0, 0) = 'contents ' if $self->{-bc};
+ write_all($self, $self->{out}, "$oid\n", \&cat_async_step, $inflight);
+ push(@$inflight, $oid, $cb, $arg);
+}
+
+sub cat_async_step ($$) {
+ my ($self, $inflight) = @_;
+ die 'BUG: inflight empty or odd' if scalar(@$inflight) < 3;
+ my ($req, $cb, $arg) = @$inflight[0, 1, 2];
+ my $rbuf = delete($self->{rbuf}) // \(my $new = '');
+ my ($bref, $oid, $type, $size);
+ my $head = my_readline($self->{in}, $rbuf);
+ my $cmd = ref($req) ? $$req : $req;
+ # ->fail may be called via Gcf2Client.pm
+ my $bc = $self->{-bc};
+ if ($head =~ /^([0-9a-f]{40,}) (\S+) ([0-9]+)$/) {
+ ($oid, $type, $size) = ($1, $2, $3 + 0);
+ unless ($bc && $cmd =~ /\Ainfo /) { # --batch-command
+ $bref = my_read($self->{in}, $rbuf, $size + 1) or
+ $self->fail(defined($bref) ?
+ 'read EOF' : "read: $!");
+ chop($$bref) eq "\n" or
+ $self->fail('LF missing after blob');
+ }
+ } elsif ($bc && $cmd =~ /\Ainfo / &&
+ $head =~ / (missing|ambiguous)\n/) {
+ $type = $1;
+ $oid = substr($cmd, 5);
+ } elsif ($head =~ s/ missing\n//s) {
+ $oid = $head;
+ # ref($req) indicates it's already been retried
+ # -gcf2 retries internally, so it never hits this path:
+ if (!ref($req) && !$in_cleanup && $self->alternates_changed) {
+ return cat_async_retry($self, $inflight);
+ }
+ $type = 'missing';
+ if ($oid eq '') {
+ $oid = $cmd;
+ $oid =~ s/\A(?:contents|info) // if $bc;
+ }
+ } else {
+ my $err = $! ? " ($!)" : '';
+ $self->fail("bad result from async cat-file: $head$err");
+ }
+ $self->{rbuf} = $rbuf if $$rbuf ne '';
+ splice(@$inflight, 0, 3); # don't retry $cb on ->fail
+ if ($bc && $cmd =~ /\Ainfo /) {
+ eval { $cb->($oid, $type, $size, $arg, $self) };
+ async_err($self, $req, $oid, $@, 'check') if $@;
+ } else {
+ eval { $cb->($bref, $oid, $type, $size, $arg) };
+ async_err($self, $req, $oid, $@, 'cat') if $@;
+ }
}
sub cat_async_wait ($) {
my ($self) = @_;
- my $inflight = delete $self->{inflight} or return;
- my $in = $self->{in};
+ my $inflight = $self->{inflight} or return;
while (scalar(@$inflight)) {
- _cat_async_step($self, $inflight, $in);
+ cat_async_step($self, $inflight);
}
}
+sub batch_prepare ($) {
+ my ($self) = @_;
+ check_git_exe();
+ if ($GIT_VER >= BATCH_CMD_VER) {
+ _bidi_pipe($self, qw(batch-command in out pid err_c));
+ $self->{-bc} = 1;
+ } else {
+ _bidi_pipe($self, qw(batch in out pid));
+ }
+ $self->{inflight} = [];
+}
+
+sub _cat_file_cb {
+ my ($bref, $oid, $type, $size, $result) = @_;
+ @$result = ($bref, $oid, $type, $size);
+}
+
sub cat_file {
- my ($self, $obj, $ref) = @_;
- my ($retried, $in, $head);
+ my ($self, $oid) = @_;
+ my $result = [];
+ cat_async($self, $oid, \&_cat_file_cb, $result);
cat_async_wait($self);
-again:
- batch_prepare($self);
- $self->{out}->print($obj, "\n") or fail($self, "write error: $!");
-
- $in = $self->{in};
- local $/ = "\n";
- $head = $in->getline;
- if ($head =~ / missing$/) {
- if (!$retried && alternates_changed($self)) {
- $retried = 1;
- cleanup($self);
- goto again;
- }
- return;
+ wantarray ? @$result : $result->[0];
+}
+
+sub check_async_step ($$) {
+ my ($self, $inflight_c) = @_;
+ die 'BUG: inflight empty or odd' if scalar(@$inflight_c) < 3;
+ my ($req, $cb, $arg) = @$inflight_c[0, 1, 2];
+ my $rbuf = delete($self->{rbuf_c}) // \(my $new = '');
+ chomp(my $line = my_readline($self->{in_c}, $rbuf));
+ my ($hex, $type, $size) = split(/ /, $line);
+
+ # git <2.21 would show `dangling' (2.21+ shows `ambiguous')
+ # https://public-inbox.org/git/20190118033845.s2vlrb3wd3m2jfzu@dcvr/T/
+ if ($hex eq 'dangling') {
+ my $ret = my_read($self->{in_c}, $rbuf, $type + 1);
+ $self->fail(defined($ret) ? 'read EOF' : "read: $!") if !$ret;
}
- $head =~ /^[0-9a-f]{40} \S+ ([0-9]+)$/ or
- fail($self, "Unexpected result from git cat-file: $head");
+ $self->{rbuf_c} = $rbuf if $$rbuf ne '';
+ splice(@$inflight_c, 0, 3); # don't retry $cb on ->fail
+ eval { $cb->($hex, $type, $size, $arg, $self) };
+ async_err($self, $req, $hex, $@, 'check') if $@;
+}
- my $size = $1;
- $$ref = $size if $ref;
- read_cat_in_full($self, $in, $size);
+sub check_async_wait ($) {
+ my ($self) = @_;
+ return cat_async_wait($self) if $self->{-bc};
+ my $inflight_c = $self->{inflight_c} or return;
+ check_async_step($self, $inflight_c) while (scalar(@$inflight_c));
}
-sub batch_prepare ($) { _bidi_pipe($_[0], qw(--batch in out pid)) }
+sub check_async_begin ($) {
+ my ($self) = @_;
+ die 'BUG: already in async check' if $self->{inflight_c};
+ cleanup($self) if alternates_changed($self);
+ check_git_exe();
+ if ($GIT_VER >= BATCH_CMD_VER) {
+ _bidi_pipe($self, qw(batch-command in out pid err_c));
+ $self->{-bc} = 1;
+ $self->{inflight} = [];
+ } else {
+ _bidi_pipe($self, qw(batch-check in_c out_c pid_c err_c));
+ $self->{inflight_c} = [];
+ }
+}
-sub check {
- my ($self, $obj) = @_;
- _bidi_pipe($self, qw(--batch-check in_c out_c pid_c err_c));
- $self->{out_c}->print($obj, "\n") or fail($self, "write error: $!");
- local $/ = "\n";
- chomp(my $line = $self->{in_c}->getline);
- my ($hex, $type, $size) = split(' ', $line);
-
- # Future versions of git.git may show 'ambiguous', but for now,
- # we must handle 'dangling' below (and maybe some other oddball
- # stuff):
- # https://public-inbox.org/git/20190118033845.s2vlrb3wd3m2jfzu@dcvr/T/
- return if $type eq 'missing' || $type eq 'ambiguous';
+sub write_all {
+ my ($self, $out, $buf, $read_step, $inflight) = @_;
+ $read_step->($self, $inflight) while @$inflight >= MAX_INFLIGHT;
+ do {
+ my $w = syswrite($out, $buf);
+ if (defined $w) {
+ return if $w == length($buf);
+ substr($buf, 0, $w, ''); # sv_chop
+ } elsif ($! != EAGAIN) {
+ $self->fail("write: $!");
+ }
+ $read_step->($self, $inflight);
+ } while (1);
+}
- if ($hex eq 'dangling' || $hex eq 'notdir' || $hex eq 'loop') {
- $size = $type + length("\n");
- my $r = read($self->{in_c}, my $buf, $size);
- defined($r) or fail($self, "read failed: $!");
- return;
+sub check_async ($$$$) {
+ my ($self, $oid, $cb, $arg) = @_;
+ my $inflight = $self->{-bc} ?
+ ($self->{inflight} // cat_async_begin($self)) :
+ ($self->{inflight_c} // check_async_begin($self));
+ if ($self->{-bc}) {
+ substr($oid, 0, 0) = 'info ';
+ write_all($self, $self->{out}, "$oid\n",
+ \&cat_async_step, $inflight);
+ } else {
+ write_all($self, $self->{out_c}, "$oid\n",
+ \&check_async_step, $inflight);
}
+ push(@$inflight, $oid, $cb, $arg);
+}
+sub _check_cb { # check_async callback
+ my ($hex, $type, $size, $result) = @_;
+ @$result = ($hex, $type, $size);
+}
+
+sub check {
+ my ($self, $oid) = @_;
+ my $result = [];
+ check_async($self, $oid, \&_check_cb, $result);
+ check_async_wait($self);
+ my ($hex, $type, $size) = @$result;
+
+ # git <2.21 would show `dangling' (2.21+ shows `ambiguous')
+ # https://public-inbox.org/git/20190118033845.s2vlrb3wd3m2jfzu@dcvr/T/
+ return if $type =~ /\A(?:missing|ambiguous)\z/ || $hex eq 'dangling';
($hex, $type, $size);
}
sub _destroy {
- my ($self, $in, $out, $pid, $err) = @_;
- my $p = delete $self->{$pid} or return;
- delete @$self{($in, $out)};
- delete $self->{$err} if $err; # `err_c'
+ my ($self, $pid, @rest) = @_; # rest = rbuf, in, out, err
+ my ($p) = delete @$self{($pid, @rest)};
- # PublicInbox::DS may not be loaded
- eval { PublicInbox::DS::dwaitpid($p, undef, undef) };
- waitpid($p, 0) if $@; # wait synchronously if not in event loop
+ # GitAsyncCat::event_step may delete {$pid}
+ awaitpid($p) if defined($p) && $$ == $self->{"$pid.owner"};
}
-sub cat_async_abort ($) {
+sub async_abort ($) {
my ($self) = @_;
- my $inflight = delete $self->{inflight} or die 'BUG: not in async';
+ while (scalar(@{$self->{inflight_c} // []}) ||
+ scalar(@{$self->{inflight} // []})) {
+ for my $c ('', '_c') {
+ my $q = $self->{"inflight$c"} or next;
+ while (@$q) {
+ my ($req, $cb, $arg) = splice(@$q, 0, 3);
+ $req = $$req if ref($req);
+ $self->{-bc} and
+ $req =~ s/\A(?:contents|info) //;
+ $req =~ s/ .*//; # drop git_dir for Gcf2Client
+ eval { $cb->(undef, $req, undef, undef, $arg) };
+ warn "E: (in abort) $req: $@" if $@;
+ }
+ delete $self->{"inflight$c"};
+ delete $self->{"rbuf$c"};
+ }
+ }
cleanup($self);
}
-sub fail {
+sub fail { # may be augmented in subclasses
my ($self, $msg) = @_;
- $self->{inflight} ? cat_async_abort($self) : cleanup($self);
- die $msg;
+ async_abort($self);
+ croak(ref($self) . ' ' . ($self->{git_dir} // '') . ": $msg");
}
+sub async_err ($$$$$) {
+ my ($self, $req, $oid, $err, $action) = @_;
+ $req = $$req if ref($req); # retried
+ my $msg = "E: $action $req ($oid): $err";
+ $async_warn ? carp($msg) : $self->fail($msg);
+}
+
+# $git->popen(qw(show f00)); # or
+# $git->popen(qw(show f00), { GIT_CONFIG => ... }, { 2 => ... });
sub popen {
- my ($self, @cmd) = @_;
- @cmd = ('git', "--git-dir=$self->{git_dir}", @cmd);
- popen_rd(\@cmd);
+ my ($self, $cmd) = splice(@_, 0, 2);
+ $cmd = [ 'git', "--git-dir=$self->{git_dir}",
+ ref($cmd) ? @$cmd : ($cmd, grep { defined && !ref } @_) ];
+ popen_rd($cmd, grep { !defined || ref } @_); # env and opt
}
+# same args as popen above
sub qx {
- my ($self, @cmd) = @_;
- my $fh = $self->popen(@cmd);
- local $/ = "\n";
- return <$fh> if wantarray;
- local $/;
- <$fh>
+ my $fh = popen(@_);
+ if (wantarray) {
+ my @ret = <$fh>;
+ close $fh; # caller should check $?
+ @ret;
+ } else {
+ local $/;
+ my $ret = <$fh>;
+ close $fh; # caller should check $?
+ $ret;
+ }
+}
+
+sub date_parse {
+ my $self = shift;
+ map {
+ substr($_, length('--max-age='), -1)
+ } $self->qx('rev-parse', map { "--since=$_" } @_);
+}
+
+# check_async and cat_async may trigger the other, so ensure they're
+# both completely done by using this:
+sub async_wait_all ($) {
+ my ($self) = @_;
+ while (scalar(@{$self->{inflight_c} // []}) ||
+ scalar(@{$self->{inflight} // []})) {
+ check_async_wait($self);
+ cat_async_wait($self);
+ }
}
# returns true if there are pending "git cat-file" processes
sub cleanup {
- my ($self) = @_;
- _destroy($self, qw(in out pid));
- _destroy($self, qw(in_c out_c pid_c err_c));
- !!($self->{pid} || $self->{pid_c});
+ my ($self, $lazy) = @_;
+ return 1 if $lazy && (scalar(@{$self->{inflight_c} // []}) ||
+ scalar(@{$self->{inflight} // []}));
+ local $in_cleanup = 1;
+ delete @$self{qw(async_cat async_chk)};
+ async_wait_all($self);
+ delete @$self{qw(inflight inflight_c -bc)};
+ _destroy($self, qw(pid rbuf in out err_c));
+ _destroy($self, qw(pid_c rbuf_c in_c out_c err_c));
+ undef;
}
# assuming a well-maintained repo, this should be a somewhat
my ($self) = @_;
my $n = 0;
my $pack_dir = git_path($self, 'objects/pack');
- foreach my $p (glob("$pack_dir/*.pack")) {
+ foreach my $p (bsd_glob("$pack_dir/*.pack", GLOB_NOSORT)) {
$n += -s $p;
}
$n
sub DESTROY { cleanup(@_) }
sub local_nick ($) {
- my ($self) = @_;
- my $ret = '???';
# don't show full FS path, basename should be OK:
- if ($self->{git_dir} =~ m!/([^/]+)(?:/\.git)?\z!) {
- $ret = "/path/to/$1";
- }
- wantarray ? ($ret) : $ret;
+ $_[0]->{nick} // ($_[0]->{git_dir} =~ m!/([^/]+?)(?:/*\.git/*)?\z! ?
+ "$1.git" : undef);
}
sub host_prefix_url ($$) {
my ($env, $url) = @_;
return $url if index($url, '//') >= 0;
- my $scheme = $env->{'psgi.url_scheme'};
my $host_port = $env->{HTTP_HOST} //
"$env->{SERVER_NAME}:$env->{SERVER_PORT}";
- "$scheme://$host_port". ($env->{SCRIPT_NAME} || '/') . $url;
+ my $sn = $env->{SCRIPT_NAME} // '';
+ "$env->{'psgi.url_scheme'}://$host_port$sn/$url";
+}
+
+sub base_url { # for coderepos, PSGI-only
+ my ($self, $env) = @_; # env - PSGI env
+ my $nick = $self->{nick} // return undef;
+ my $url = host_prefix_url($env, '');
+ # for mount in Plack::Builder
+ $url .= '/' if substr($url, -1, 1) ne '/';
+ $url . $nick . '/';
}
+sub isrch {} # TODO
+
sub pub_urls {
my ($self, $env) = @_;
if (my $urls = $self->{cgit_url}) {
- return map { host_prefix_url($env, $_) } @$urls;
+ map { host_prefix_url($env, $_) } @$urls;
+ } else {
+ (base_url($self, $env) // '???');
}
- local_nick($self);
}
sub cat_async_begin {
my ($self) = @_;
- cleanup($self) if alternates_changed($self);
- batch_prepare($self);
+ cleanup($self) if $self->alternates_changed;
die 'BUG: already in async' if $self->{inflight};
- $self->{inflight} = [];
+ batch_prepare($self);
}
sub cat_async ($$$;$) {
my ($self, $oid, $cb, $arg) = @_;
- my $inflight = $self->{inflight} or die 'BUG: not in async';
- if (scalar(@$inflight) >= MAX_INFLIGHT) {
- _cat_async_step($self, $inflight, $self->{in});
- }
+ my $inflight = $self->{inflight} // cat_async_begin($self);
+ substr($oid, 0, 0) = 'contents ' if $self->{-bc};
+ write_all($self, $self->{out}, $oid."\n", \&cat_async_step, $inflight);
+ push(@$inflight, $oid, $cb, $arg);
+}
- $self->{out}->print($oid, "\n") or fail($self, "write error: $!");
- push(@$inflight, [ $cb, $arg ]);
+# returns the modified time of a git repo, same as the "modified" field
+# of a grokmirror manifest
+sub modified ($) {
+ # committerdate:unix is git 2.9.4+ (2017-05-05), so using raw instead
+ my $fh = popen($_[0], qw[for-each-ref --sort=-committerdate
+ --format=%(committerdate:raw) --count=1]);
+ (split(/ /, <$fh> // time))[0] + 0; # integerize for JSON
}
-sub extract_cmt_time {
- my ($bref, undef, undef, undef, $modified) = @_;
+sub try_cat {
+ my ($path) = @_;
+ open(my $fh, '<', $path) or return '';
+ local $/;
+ <$fh> // '';
+}
- if ($$bref =~ /^committer .*?> ([0-9]+) [\+\-]?[0-9]+/sm) {
- my $cmt_time = $1 + 0;
- $$modified = $cmt_time if $cmt_time > $$modified;
+sub cat_desc ($) {
+ my $desc = try_cat($_[0]);
+ chomp $desc;
+ utf8::decode($desc);
+ $desc =~ s/\s+/ /smg;
+ $desc eq '' ? undef : $desc;
+}
+
+sub description {
+ cat_desc("$_[0]->{git_dir}/description") // 'Unnamed repository';
+}
+
+sub cloneurl {
+ my ($self, $env) = @_;
+ $self->{cloneurl} // do {
+ my @urls = split(/\s+/s, try_cat("$self->{git_dir}/cloneurl"));
+ scalar(@urls) ? ($self->{cloneurl} = \@urls) : undef;
+ } // [ substr(base_url($self, $env), 0, -1) ];
+}
+
+# for grokmirror, which doesn't read gitweb.description
+# templates/hooks--update.sample and git-multimail in git.git
+# only match "Unnamed repository", not the full contents of
+# templates/this--description in git.git
+sub manifest_entry {
+ my ($self, $epoch, $default_desc) = @_;
+ my $fh = $self->popen('show-ref');
+ my $dig = PublicInbox::SHA->new(1);
+ while (read($fh, my $buf, 65536)) {
+ $dig->add($buf);
+ }
+ close $fh or return; # empty, uninitialized git repo
+ undef $fh; # for open, below
+ my $git_dir = $self->{git_dir};
+ my $ent = {
+ fingerprint => $dig->hexdigest,
+ reference => undef,
+ modified => modified($self),
+ };
+ chomp(my $owner = $self->qx('config', 'gitweb.owner'));
+ utf8::decode($owner);
+ $ent->{owner} = $owner eq '' ? undef : $owner;
+ my $desc = description($self);
+ if (defined $epoch && index($desc, 'Unnamed repository') == 0) {
+ $desc = "$default_desc [epoch $epoch]";
+ }
+ $ent->{description} = $desc;
+ if (open($fh, '<', "$git_dir/objects/info/alternates")) {
+ # n.b.: GitPython doesn't seem to handle comments or C-quoted
+ # strings like native git does; and we don't for now, either.
+ local $/ = "\n";
+ chomp(my @alt = <$fh>);
+
+ # grokmirror only supports 1 alternate for "reference",
+ if (scalar(@alt) == 1) {
+ my $objdir = "$git_dir/objects";
+ my $ref = File::Spec->rel2abs($alt[0], $objdir);
+ $ref =~ s!/[^/]+/?\z!!; # basename
+ $ent->{reference} = $ref;
+ }
}
+ $ent;
}
-# returns the modified time of a git repo, same as the "modified" field
-# of a grokmirror manifest
-sub modified ($) {
+# returns true if there are pending cat-file processes
+sub cleanup_if_unlinked {
my ($self) = @_;
- my $modified = 0;
- my $fh = popen($self, qw(rev-parse --branches));
- cat_async_begin($self);
- local $/ = "\n";
- foreach my $oid (<$fh>) {
- chomp $oid;
- cat_async($self, $oid, \&extract_cmt_time, \$modified);
+ return cleanup($self, 1) if $^O ne 'linux';
+ # Linux-specific /proc/$PID/maps access
+ # TODO: support this inside git.git
+ my $ret = 0;
+ for my $fld (qw(pid pid_c)) {
+ my $pid = $self->{$fld} // next;
+ open my $fh, '<', "/proc/$pid/maps" or return cleanup($self, 1);
+ while (<$fh>) {
+ # n.b. we do not restart for unlinked multi-pack-index
+ # since it's not too huge, and the startup cost may
+ # be higher.
+ /\.(?:idx|pack) \(deleted\)$/ and
+ return cleanup($self, 1);
+ }
+ ++$ret;
}
- cat_async_wait($self);
- $modified || time;
+ $ret;
}
1;