]> Sergey Matveev's repositories - public-inbox.git/commitdiff
support smart HTTP cloning
authorEric Wong <e@80x24.org>
Sun, 7 Feb 2016 08:35:29 +0000 (08:35 +0000)
committerEric Wong <e@80x24.org>
Sun, 7 Feb 2016 08:46:37 +0000 (08:46 +0000)
This requires POST and (small file) upload support from the
PSGI/Plack web server.  CGI.pm is currently not supported with
this feature.

We'll serve everything git can handle by default for performance
in the general case.

To avoid introducing cognitive overhead for sysadmins managing
existing HTTP backends, we do not introduce new configuration
directives.

Thus, setting http.uploadpack=false in the relevant git config
file for each public-inbox (ssoma) git repo will disable smart
HTTP for CPU/memory-constrained systems.

Technically we could support http.receivepack to allow posting
messages to a public-inbox over HTTP(S), but that breaks
the public-inbox model of encouraging users to Cc: everyone.
Again, we encourage users to Cc: everyone to reduce the chance
of a public-inbox becoming a centralized point of
failure/censorship.

Documentation/design_www.txt
lib/PublicInbox/GitHTTPBackend.pm [moved from lib/PublicInbox/GitHTTPDumb.pm with 53% similarity]
lib/PublicInbox/WWW.pm

index 760152333e651b916db7d62ae5d70c486da39cf8..39b124143fd313baa17b6ea80bd94d7e85fb7854 100644 (file)
@@ -25,6 +25,8 @@ URL naming
 
 /$LISTNAME/atom.xml [2]                   -> identical to /$LISTNAME/new.atom
 
+Additionally, we support "git clone" pointed to http://$HOST/$LISTNAME
+
 FIXME: we must refactor/cleanup/add tests for most of our CGI before
 adding more endpoints and features.
 
similarity index 53%
rename from lib/PublicInbox/GitHTTPDumb.pm
rename to lib/PublicInbox/GitHTTPBackend.pm
index c088d8c4980ebf11cd0fe4188e79a1afcae60409..71b7a8f1b1c12278730dd8c8cd64cf6f3a93d415 100644 (file)
@@ -2,11 +2,12 @@
 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
 
 # when no endpoints match, fallback to this and serve a static file
-# This can serve Smart HTTP in the future.
-package PublicInbox::GitHTTPDumb;
+# or smart HTTP
+package PublicInbox::GitHTTPBackend;
 use strict;
 use warnings;
 use Fcntl qw(:seek);
+use POSIX qw(dup2);
 
 # n.b. serving "description" and "cloneurl" should be innocuous enough to
 # not cause problems.  serving "config" might...
@@ -29,6 +30,12 @@ sub r {
 
 sub serve {
        my ($cgi, $git, $path) = @_;
+       my $service = $cgi->param('service') || '';
+       if ($service =~ /\Agit-\w+-pack\z/ || $path =~ /\Agit-\w+-pack\z/) {
+               my $ok = serve_smart($cgi, $git, $path);
+               return $ok if $ok;
+       }
+
        my $type;
        if ($path =~ /\A(?:$BIN)\z/o) {
                $type = 'application/octet-stream';
@@ -118,4 +125,90 @@ sub prepare_range {
        ($code, $len);
 }
 
+# returns undef if 403 so it falls back to dumb HTTP
+sub serve_smart {
+       my ($cgi, $git, $path) = @_;
+       my $env = $cgi->{env};
+
+       my $input = $env->{'psgi.input'};
+       my $buf;
+       my $in;
+       my $err = $env->{'psgi.errors'};
+       if (fileno($input) >= 0) { # FIXME untested
+               $in = $input;
+       } else {
+               $in = IO::File->new_tmpfile;
+               while (1) {
+                       my $r = $input->read($buf, 8192);
+                       unless (defined $r) {
+                               $err->print('error reading input: ', $!, "\n");
+                               return r(500);
+                       }
+                       last if ($r == 0);
+                       $in->write($buf);
+               }
+               $in->flush;
+               $in->sysseek(0, SEEK_SET);
+       }
+       my $out = IO::File->new_tmpfile;
+       my $pid = fork; # TODO: vfork under Linux...
+       unless (defined $pid) {
+               $err->print('error forking: ', $!, "\n");
+               return r(500);
+       }
+       if ($pid == 0) {
+               # GIT_HTTP_EXPORT_ALL, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL
+               # may be set in the server-process and are passed as-is
+               foreach my $name (qw(QUERY_STRING
+                                       REMOTE_USER REMOTE_ADDR
+                                       HTTP_CONTENT_ENCODING
+                                       CONTENT_TYPE
+                                       SERVER_PROTOCOL
+                                       REQUEST_METHOD)) {
+                       my $val = $env->{$name};
+                       $ENV{$name} = $val if defined $val;
+               }
+               # $ENV{GIT_PROJECT_ROOT} = $git->{git_dir};
+               $ENV{GIT_HTTP_EXPORT_ALL} = '1';
+               $ENV{PATH_TRANSLATED} = "$git->{git_dir}/$path";
+               dup2(fileno($in), 0) or die "redirect stdin failed: $!\n";
+               dup2(fileno($out), 1) or die "redirect stdout failed: $!\n";
+               my @cmd = qw(git http-backend);
+               exec(@cmd) or die 'exec `' . join(' ', @cmd). "' failed: $!\n";
+       }
+
+       if (waitpid($pid, 0) != $pid) {
+               $err->print("git http-backend ($git->{git_dir}): ", $?, "\n");
+               return r(500);
+       }
+       $in = undef;
+       $out->seek(0, SEEK_SET);
+       my @h;
+       my $code = 200;
+       {
+               local $/ = "\r\n";
+               while (defined(my $line = <$out>)) {
+                       if ($line =~ /\AStatus:\s*(\d+)/) {
+                               $code = $1;
+                       } else {
+                               chomp $line;
+                               last if $line eq '';
+                               push @h, split(/:\s*/, $line, 2);
+                       }
+               }
+       }
+       return if $code == 403;
+       sub {
+               my ($cb) = @_;
+               my $fh = $cb->([ $code, \@h ]);
+               while (1) {
+                       my $r = $out->read($buf, 8192);
+                       die "$!\n" unless defined $r;
+                       last if ($r == 0);
+                       $fh->write($buf);
+               }
+               $fh->close;
+       }
+}
+
 1;
index 1c6936f76bd2dcf6f3a4c4e64e8f4c8f90595523..b4b012f962fb81ce0f029f59231fa162b0b5db57 100644 (file)
@@ -18,7 +18,7 @@ use URI::Escape qw(uri_escape_utf8 uri_unescape);
 use constant SSOMA_URL => 'http://ssoma.public-inbox.org/';
 use constant PI_URL => 'http://public-inbox.org/';
 require PublicInbox::Git;
-use PublicInbox::GitHTTPDumb;
+use PublicInbox::GitHTTPBackend;
 our $LISTNAME_RE = qr!\A/([\w\.\-]+)!;
 our $MID_RE = qr!([^/]+)!;
 our $END_RE = qr!(f/|T/|t/|t\.mbox(?:\.gz)?|t\.atom|raw|)!;
@@ -28,10 +28,17 @@ sub run {
        my ($cgi, $method) = @_;
        $pi_config ||= PublicInbox::Config->new;
        my $ctx = { cgi => $cgi, pi_config => $pi_config };
-       if ($method !~ /\AGET|HEAD\z/) {
+       my $path_info = $cgi->path_info;
+
+       if ($method eq 'POST' &&
+                $path_info =~ m!$LISTNAME_RE/(git-upload-pack)\z!) {
+               my $path = $2;
+               return (invalid_list($ctx, $1) ||
+                       serve_git($cgi, $ctx->{git}, $path));
+       }
+       elsif ($method !~ /\AGET|HEAD\z/) {
                return r(405, 'Method Not Allowed');
        }
-       my $path_info = $cgi->path_info;
 
        # top-level indices and feeds
        if ($path_info eq '/') {
@@ -44,7 +51,7 @@ sub run {
                invalid_list($ctx, $1) || get_atom($ctx);
 
        } elsif ($path_info =~ m!$LISTNAME_RE/
-                               ($PublicInbox::GitHTTPDumb::ANY)\z!ox) {
+                               ($PublicInbox::GitHTTPBackend::ANY)\z!ox) {
                my $path = $2;
                invalid_list($ctx, $1) || serve_git($cgi, $ctx->{git}, $path);
        } elsif ($path_info =~ m!$LISTNAME_RE/$MID_RE/$END_RE\z!o) {
@@ -402,7 +409,7 @@ sub msg_page {
 
 sub serve_git {
        my ($cgi, $git, $path) = @_;
-       PublicInbox::GitHTTPDumb::serve($cgi, $git, $path);
+       PublicInbox::GitHTTPBackend::serve($cgi, $git, $path);
 }
 
 1;