1 # Copyright (C) 2014-2018 all contributors <meta@public-inbox.org>
2 # License: GPLv2 or later <https://www.gnu.org/licenses/gpl-2.0.txt>
4 # Used to read files from a git repository without excessive forking.
5 # Used in our web interfaces as well as our -nntpd server.
6 # This is based on code in Git.pm which is GPLv2+, but modified to avoid
7 # dependence on environment variables for compatibility with mod_perl.
8 # There are also API changes to simplify our usage and data set.
9 package PublicInbox::Git;
14 use PublicInbox::Spawn qw(spawn popen_rd);
15 use base qw(Exporter);
16 our @EXPORT_OK = qw(git_unquote);
30 # unquote pathnames used by git, see quote.c::unquote_c_style.c in git.git
32 return $_[0] unless ($_[0] =~ /\A"(.*)"\z/);
34 $_[0] =~ s/\\([\\"abfnrtv])/$GIT_ESC{$1}/g;
35 $_[0] =~ s/\\([0-7]{1,3})/chr(oct($1))/ge;
40 my ($class, $git_dir) = @_;
43 # may contain {-wt} field (working-tree (File::Temp::Dir))
44 bless { git_dir => $git_dir, st => \@st }, $class
47 sub alternates_changed {
49 my $alt = "$self->{git_dir}/objects/info/alternates";
50 my @st = stat($alt) or return 0;
51 my $old_st = $self->{st};
52 # 10 - ctime, 7 - size
53 return 0 if ($st[10] == $old_st->[10] && $st[7] == $old_st->[7]);
58 my ($self, $batch, $in, $out, $pid) = @_;
59 return if $self->{$pid};
60 my ($in_r, $in_w, $out_r, $out_w);
62 pipe($in_r, $in_w) or fail($self, "pipe failed: $!");
63 pipe($out_r, $out_w) or fail($self, "pipe failed: $!");
64 if ($^O eq 'linux') { # 1031: F_SETPIPE_SZ
65 fcntl($out_w, 1031, 4096);
66 fcntl($in_w, 1031, 4096) if $batch eq '--batch-check';
69 my @cmd = ('git', "--git-dir=$self->{git_dir}", qw(cat-file), $batch);
70 my $redir = { 0 => fileno($out_r), 1 => fileno($in_w) };
71 my $p = spawn(\@cmd, undef, $redir);
72 defined $p or fail($self, "spawn failed: $!");
75 $self->{$out} = $out_w;
80 my ($self, $obj, $ref) = @_;
81 my ($retried, $in, $head);
85 $self->{out}->print($obj, "\n") or fail($self, "write error: $!");
90 if ($head =~ / missing$/) {
91 if (!$retried && alternates_changed($self)) {
98 $head =~ /^[0-9a-f]{40} \S+ (\d+)$/ or
99 fail($self, "Unexpected result from git cat-file: $head");
102 my $ref_type = $ref ? ref($ref) : '';
106 $$ref = $size if ($ref_type eq 'SCALAR');
109 if ($ref_type eq 'CODE') {
110 $rv = eval { $ref->($in, \$left) };
115 my $r = read($in, my $x, $left > $max ? $max : $left);
116 defined($r) or fail($self, "read failed: $!");
117 $r == 0 and fail($self, 'exited unexpectedly');
124 my $r = read($in, $buf, $left, $offset);
125 defined($r) or fail($self, "read failed: $!");
126 $r == 0 and fail($self, 'exited unexpectedly');
133 my $r = read($in, my $buf, 1);
134 defined($r) or fail($self, "read failed: $!");
135 fail($self, 'newline missing after blob') if ($r != 1 || $buf ne "\n");
136 die $cb_err if $cb_err;
141 sub batch_prepare ($) { _bidi_pipe($_[0], qw(--batch in out pid)) }
144 my ($self, $obj) = @_;
145 $self->_bidi_pipe(qw(--batch-check in_c out_c pid_c));
146 $self->{out_c}->print($obj, "\n") or fail($self, "write error: $!");
148 chomp(my $line = $self->{in_c}->getline);
149 my ($hex, $type, $size) = split(' ', $line);
150 return if $type eq 'missing';
151 ($hex, $type, $size);
155 my ($self, $in, $out, $pid) = @_;
156 my $p = delete $self->{$pid} or return;
157 foreach my $f ($in, $out) {
164 my ($self, $msg) = @_;
170 my ($self, @cmd) = @_;
171 @cmd = ('git', "--git-dir=$self->{git_dir}", @cmd);
176 my ($self, @cmd) = @_;
177 my $fh = $self->popen(@cmd);
178 defined $fh or return;
180 return <$fh> if wantarray;
187 _destroy($self, qw(in out pid));
188 _destroy($self, qw(in_c out_c pid_c));
191 # assuming a well-maintained repo, this should be a somewhat
192 # accurate estimation of its size
193 # TODO: show this in the WWW UI as a hint to potential cloners
197 foreach my $p (glob("$self->{git_dir}/objects/pack/*.pack")) {
203 sub DESTROY { cleanup(@_) }
208 # don't show full FS path, basename should be OK:
209 if ($self->{git_dir} =~ m!/([^/]+)(?:/\.git)?\z!) {
210 $ret = "/path/to/$1";
212 wantarray ? ($ret) : $ret;
215 # show the blob URL for cgit/gitweb/whatever
217 my ($self, $oid) = @_;
218 # blob_url_format = "https://example.com/foo.git/blob/%s"
219 if (my $bfu = $self->{blob_url_format}) {
220 return map { sprintf($_, $oid) } @$bfu if wantarray;
221 return sprintf($bfu->[0], $oid);
228 if (my $urls = $self->{cgit_url}) {
240 PublicInbox::Git - git wrapper
248 use PublicInbox::Git;
249 chomp(my $git_dir = `git rev-parse --git-dir`);
250 $git_dir or die "GIT_DIR= must be specified\n";
251 my $git = PublicInbox::Git->new($git_dir);
255 Unstable API outside of the L</new> method.
256 It requires L<git(1)> to be installed.
264 my $git = PublicInbox::Git->new($git_dir);
266 Initialize a new PublicInbox::Git object for use with L<PublicInbox::Import>
267 This is the only public API method we support. Everything else
268 in this module is subject to change.
272 L<Git>, L<PublicInbox::Import>
276 All feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
278 The mail archives are hosted at L<https://public-inbox.org/meta/>
282 Copyright (C) 2016 all contributors L<mailto:meta@public-inbox.org>
284 License: AGPL-3.0+ L<http://www.gnu.org/licenses/agpl-3.0.txt>