1 # Copyright (C) 2014-2015 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);
17 my ($class, $git_dir) = @_;
18 bless { git_dir => $git_dir }, $class
22 my ($self, $batch, $in, $out, $pid) = @_;
23 return if $self->{$pid};
24 my ($in_r, $in_w, $out_r, $out_w);
26 pipe($in_r, $in_w) or fail($self, "pipe failed: $!");
27 pipe($out_r, $out_w) or fail($self, "pipe failed: $!");
29 my @cmd = ('git', "--git-dir=$self->{git_dir}", qw(cat-file), $batch);
30 my $redir = { 0 => fileno($out_r), 1 => fileno($in_w) };
31 $self->{$pid} = spawn(\@cmd, undef, $redir);
33 $self->{$out} = $out_w;
38 my ($self, $obj, $ref) = @_;
40 $self->_bidi_pipe(qw(--batch in out pid));
41 $self->{out}->print($obj, "\n") or fail($self, "write error: $!");
45 my $head = $in->getline;
46 $head =~ / missing$/ and return undef;
47 $head =~ /^[0-9a-f]{40} \S+ (\d+)$/ or
48 fail($self, "Unexpected result from git cat-file: $head");
51 my $ref_type = $ref ? ref($ref) : '';
55 $$ref = $size if ($ref_type eq 'SCALAR');
58 if ($ref_type eq 'CODE') {
59 $rv = eval { $ref->($in, \$left) };
64 my $r = read($in, my $x, $left > $max ? $max : $left);
65 defined($r) or fail($self, "read failed: $!");
66 $r == 0 and fail($self, 'exited unexpectedly');
73 my $r = read($in, $buf, $left, $offset);
74 defined($r) or fail($self, "read failed: $!");
75 $r == 0 and fail($self, 'exited unexpectedly');
82 my $r = read($in, my $buf, 1);
83 defined($r) or fail($self, "read failed: $!");
84 fail($self, 'newline missing after blob') if ($r != 1 || $buf ne "\n");
85 die $cb_err if $cb_err;
91 my ($self, $obj) = @_;
92 $self->_bidi_pipe(qw(--batch-check in_c out_c pid_c));
93 $self->{out_c}->print($obj, "\n") or fail($self, "write error: $!");
95 chomp(my $line = $self->{in_c}->getline);
96 my ($hex, $type, $size) = split(' ', $line);
97 return if $type eq 'missing';
102 my ($self, $in, $out, $pid) = @_;
103 my $p = delete $self->{$pid} or return;
104 foreach my $f ($in, $out) {
111 my ($self, $msg) = @_;
117 my ($self, @cmd) = @_;
118 @cmd = ('git', "--git-dir=$self->{git_dir}", @cmd);
123 my ($self, @cmd) = @_;
124 my $fh = $self->popen(@cmd);
126 return <$fh> if wantarray;
133 _destroy($self, qw(in out pid));
134 _destroy($self, qw(in_c out_c pid_c));
137 sub DESTROY { cleanup(@_) }
145 PublicInbox::Git - git wrapper
153 use PublicInbox::Git;
154 chomp(my $git_dir = `git rev-parse --git-dir`);
155 $git_dir or die "GIT_DIR= must be specified\n";
156 my $git = PublicInbox::Git->new($git_dir);
160 Unstable API outside of the L</new> method.
161 It requires L<git(1)> to be installed.
169 my $git = PublicInbox::Git->new($git_dir);
171 Initialize a new PublicInbox::Git object for use with L<PublicInbox::Import>
172 This is the only public API method we support. Everything else
173 in this module is subject to change.
177 L<Git>, L<PublicInbox::Import>
181 All feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
183 The mail archives are hosted at L<https://public-inbox.org/meta/>
187 Copyright (C) 2016 all contributors L<mailto:meta@public-inbox.org>
189 License: AGPL-3.0+ L<http://www.gnu.org/licenses/agpl-3.0.txt>