-# Copyright (C) 2016 all contributors <meta@public-inbox.org>
+# Copyright (C) 2016-2018 all contributors <meta@public-inbox.org>
# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
#
# Generic PSGI server for convenience. It aims to provide
# a consistent experience for public-inbox admins so they don't have
# to learn different ways to admin both NNTP and HTTP components.
-# There's nothing public-inbox-specific, here.
+# There's nothing which depends on public-inbox, here.
# Each instance of this class represents a HTTP client socket
package PublicInbox::HTTP;
use strict;
use warnings;
-use base qw(Danga::Socket);
-use fields qw(httpd env rbuf input_left);
+use base qw(PublicInbox::DS);
+use fields qw(httpd env rbuf input_left remote_addr remote_port forward pull);
+use bytes (); # only for bytes::length
use Fcntl qw(:seek);
-use HTTP::Parser::XS qw(parse_http_request); # supports pure Perl fallback
+use Plack::HTTPParser qw(parse_http_request); # XS or pure Perl
use HTTP::Status qw(status_message);
use HTTP::Date qw(time2str);
-use IO::File;
-my $null_io = IO::File->new('/dev/null', '<');
+use IO::Handle;
+require PublicInbox::EvCleanup;
use constant {
CHUNK_START => -1, # [a-f0-9]+\r\n
CHUNK_END => -2, # \r\n
CHUNK_MAX_HDR => 256,
};
+my $pipelineq = [];
+my $pipet;
+sub process_pipelineq () {
+ my $q = $pipelineq;
+ $pipet = undef;
+ $pipelineq = [];
+ foreach (@$q) {
+ next if $_->{closed};
+ rbuf_process($_);
+ }
+}
+
+# Use the same configuration parameter as git since this is primarily
+# a slow-client sponge for git-http-backend
+# TODO: support per-respository http.maxRequestBuffer somehow...
+our $MAX_REQUEST_BUFFER = $ENV{GIT_HTTP_MAX_REQUEST_BUFFER} ||
+ (10 * 1024 * 1024);
+
+open(my $null_io, '<', '/dev/null') or die "failed to open /dev/null: $!";
+my $http_date;
+my $prev = 0;
+sub http_date () {
+ my $now = time;
+ $now == $prev ? $http_date : ($http_date = time2str($prev = $now));
+}
+
sub new ($$$) {
my ($class, $sock, $addr, $httpd) = @_;
my $self = fields::new($class);
$self->SUPER::new($sock);
$self->{httpd} = $httpd;
$self->{rbuf} = '';
+ ($self->{remote_addr}, $self->{remote_port}) =
+ PublicInbox::Daemon::host_with_port($addr);
$self->watch_read(1);
$self;
}
-sub event_read { # called by Danga::Socket
+sub event_read { # called by PublicInbox::DS
my ($self) = @_;
return event_read_input($self) if defined $self->{env};
# We do not support Trailers in chunked requests, for now
# (they are rarely-used and git (as of 2.7.2) does not use them)
- return $self->quit(400) if $r == -1 || $env{HTTP_TRAILER};
+ if ($r == -1 || $env{HTTP_TRAILER} ||
+ # this length-check is necessary for PURE_PERL=1:
+ ($r == -2 && length($self->{rbuf}) > 0x4000)) {
+ return quit($self, 400);
+ }
return $self->watch_read(1) if $r < 0; # incomplete
$self->{rbuf} = substr($self->{rbuf}, $r);
+
my $len = input_prepare($self, \%env);
+ defined $len or return write_err($self, undef); # EMFILE/ENFILE
+
$len ? event_read_input($self) : app_dispatch($self);
}
while ($len > 0) {
if ($$rbuf ne '') {
my $w = write_in_full($input, $rbuf, $len);
- return $self->write_err unless $w;
+ return write_err($self, $len) unless $w;
$len -= $w;
die "BUG: $len < 0 (w=$w)" if $len < 0;
if ($len == 0) { # next request may be pipelined
$$rbuf = '';
}
my $r = sysread($sock, $$rbuf, 8192);
- return $self->recv_err($r, $len) unless $r;
+ return recv_err($self, $r, $len) unless $r;
# continue looping if $r > 0;
}
- app_dispatch($self);
+ app_dispatch($self, $input);
}
-sub app_dispatch ($) {
- my ($self) = @_;
+sub app_dispatch {
+ my ($self, $input) = @_;
$self->watch_read(0);
my $env = $self->{env};
- $env->{REMOTE_ADDR} = $self->peer_ip_string; # Danga::Socket
- $env->{REMOTE_PORT} = $self->{peer_port}; # set by peer_ip_string
+ $env->{REMOTE_ADDR} = $self->{remote_addr};
+ $env->{REMOTE_PORT} = $self->{remote_port};
if (my $host = $env->{HTTP_HOST}) {
$host =~ s/:(\d+)\z// and $env->{SERVER_PORT} = $1;
$env->{SERVER_NAME} = $host;
}
- $env->{'psgi.input'}->seek(0, SEEK_SET);
+ if (defined $input) {
+ sysseek($input, 0, SEEK_SET) or
+ die "BUG: psgi.input seek failed: $!";
+ }
+ # note: NOT $self->{sock}, we want our close (+ PublicInbox::DS::close),
+ # to do proper cleanup:
+ $env->{'psgix.io'} = $self; # only for ->close
my $res = Plack::Util::run_app($self->{httpd}->{app}, $env);
eval {
if (ref($res) eq 'CODE') {
if ($k =~ /\ATransfer-Encoding\z/i && $v =~ /\bchunked\b/i) {
$chunked = 1;
}
-
$h .= "$k: $v\r\n";
}
my $conn = $env->{HTTP_CONNECTION} || '';
- my $alive = (defined($len) || $chunked) &&
- ($proto eq 'HTTP/1.1' && $conn !~ /\bclose\b/i) ||
- ($conn =~ /\bkeep-alive\b/i);
-
- $h .= 'Connection: ' . ($alive ? 'keep-alive' : 'close');
- $h .= "\r\nDate: " . time2str(time) . "\r\n\r\n";
+ my $term = defined($len) || $chunked;
+ my $prot_persist = ($proto eq 'HTTP/1.1') && ($conn !~ /\bclose\b/i);
+ my $alive;
+ if (!$term && $prot_persist) { # auto-chunk
+ $chunked = $alive = 2;
+ $h .= "Transfer-Encoding: chunked\r\n";
+ # no need for "Connection: keep-alive" with HTTP/1.1
+ } elsif ($term && ($prot_persist || ($conn =~ /\bkeep-alive\b/i))) {
+ $alive = 1;
+ $h .= "Connection: keep-alive\r\n";
+ } else {
+ $alive = 0;
+ $h .= "Connection: close\r\n";
+ }
+ $h .= 'Date: ' . http_date() . "\r\n\r\n";
if (($len || $chunked) && $env->{REQUEST_METHOD} ne 'HEAD') {
more($self, $h);
} else {
$self->write($h);
}
- ($alive, $chunked);
+ $alive;
+}
+
+# middlewares such as Deflater may write empty strings
+sub chunked_wcb ($) {
+ my ($self) = @_;
+ sub {
+ return if $_[0] eq '';
+ more($self, sprintf("%x\r\n", bytes::length($_[0])));
+ more($self, $_[0]);
+
+ # use $self->write("\n\n") if you care about real-time
+ # streaming responses, public-inbox WWW does not.
+ more($self, "\r\n");
+ }
+}
+
+sub identity_wcb ($) {
+ my ($self) = @_;
+ sub { $self->write(\($_[0])) if $_[0] ne '' }
+}
+
+sub next_request ($) {
+ my ($self) = @_;
+ $self->watch_write(0);
+ if ($self->{rbuf} eq '') { # wait for next request
+ $self->watch_read(1);
+ } else { # avoid recursion for pipelined requests
+ push @$pipelineq, $self;
+ $pipet ||= PublicInbox::EvCleanup::asap(*process_pipelineq);
+ }
+}
+
+sub response_done_cb ($$) {
+ my ($self, $alive) = @_;
+ sub {
+ my $env = $self->{env};
+ $self->{env} = undef;
+ $self->write("0\r\n\r\n") if $alive == 2;
+ $self->write(sub{$alive ? next_request($self) : $self->close});
+ }
+}
+
+sub getline_cb ($$$) {
+ my ($self, $write, $close) = @_;
+ local $/ = \8192;
+ my $forward = $self->{forward};
+ # limit our own running time for fairness with other
+ # clients and to avoid buffering too much:
+ if ($forward) {
+ my $buf = eval { $forward->getline };
+ if (defined $buf) {
+ $write->($buf); # may close in PublicInbox::DS::write
+ unless ($self->{closed}) {
+ my $next = $self->{pull};
+ if ($self->{write_buf_size}) {
+ $self->write($next);
+ } else {
+ PublicInbox::EvCleanup::asap($next);
+ }
+ return;
+ }
+ } elsif ($@) {
+ err($self, "response ->getline error: $@");
+ $forward = undef;
+ $self->close;
+ }
+ }
+
+ $self->{forward} = $self->{pull} = undef;
+ # avoid recursion
+ if ($forward) {
+ eval { $forward->close };
+ if ($@) {
+ err($self, "response ->close error: $@");
+ $self->close; # idempotent
+ }
+ }
+ $close->();
+}
+
+sub getline_response ($$$) {
+ my ($self, $write, $close) = @_;
+ my $pull = $self->{pull} = sub { getline_cb($self, $write, $close) };
+ $pull->();
}
sub response_write {
my ($self, $env, $res) = @_;
- my ($alive, $chunked) = response_header_write($self, $env, $res);
- my $write = sub { $self->write($_[0]) };
- my $close = sub {
- if ($alive) {
- $self->event_write; # watch for readability if done
+ my $alive = response_header_write($self, $env, $res);
+ my $close = response_done_cb($self, $alive);
+ my $write = $alive == 2 ? chunked_wcb($self) : identity_wcb($self);
+ if (defined(my $body = $res->[2])) {
+ if (ref $body eq 'ARRAY') {
+ $write->($_) foreach @$body;
+ $close->();
} else {
- $self->write(sub { $self->close });
+ $self->{forward} = $body;
+ getline_response($self, $write, $close);
}
- $self->{env} = undef;
- };
-
- if (defined $res->[2]) {
- Plack::Util::foreach($res->[2], $write);
- $close->();
} else {
# this is returned to the calling application:
Plack::Util::inline_object(write => $write, close => $close);
use constant MSG_MORE => ($^O eq 'linux') ? 0x8000 : 0;
sub more ($$) {
my $self = $_[0];
+ return if $self->{closed};
if (MSG_MORE && !$self->{write_buf_size}) {
my $n = send($self->{sock}, $_[1], MSG_MORE);
if (defined $n) {
- my $dlen = length($_[1]);
- return 1 if $n == $dlen; # all done!
- $_[1] = substr($_[1], $n, $dlen - $n);
- # fall through to normal write:
+ my $nlen = length($_[1]) - $n;
+ return 1 if $nlen == 0; # all done!
+
+ # PublicInbox::DS::write queues the unwritten substring:
+ return $self->write(substr($_[1], $n, $nlen));
}
}
$self->write($_[1]);
}
-# overrides existing Danga::Socket method
-sub event_write {
- my ($self) = @_;
- # only continue watching for readability when we are done writing:
- return if $self->write(undef) != 1;
-
- if ($self->{rbuf} eq '') {
- $self->watch_read(1);
- } else {
- # avoid recursion
- Danga::Socket->AddTimer(0, sub { rbuf_process($self) });
- }
-}
-
sub input_prepare {
my ($self, $env) = @_;
- my $input = $null_io;
+ my $input;
my $len = $env->{CONTENT_LENGTH};
if ($len) {
- $input = IO::File->new_tmpfile;
+ if ($len > $MAX_REQUEST_BUFFER) {
+ quit($self, 413);
+ return;
+ }
+ open($input, '+>', undef);
} elsif (env_chunked($env)) {
- $input = IO::File->new_tmpfile;
$len = CHUNK_START;
+ open($input, '+>', undef);
+ } else {
+ $input = $null_io;
}
- binmode $input;
+
+ # TODO: expire idle clients on ENFILE / EMFILE
+ return unless $input;
+
$env->{'psgi.input'} = $input;
$self->{env} = $env;
- $self->{input_left} = $len;
+ $self->{input_left} = $len || 0;
}
sub env_chunked { ($_[0]->{HTTP_TRANSFER_ENCODING} || '') =~ /\bchunked\b/i }
+sub err ($$) {
+ eval { $_[0]->{httpd}->{env}->{'psgi.errors'}->print($_[1]."\n") };
+}
+
sub write_err {
- my ($self) = @_;
- my $err = $self->{env}->{'psgi.errors'};
+ my ($self, $len) = @_;
my $msg = $! || '(zero write)';
- $err->print("error buffering to input: $msg\n");
- $self->quit(500);
+ $msg .= " ($len bytes remaining)" if defined $len;
+ err($self, "error buffering to input: $msg");
+ quit($self, 500);
}
sub recv_err {
$self->{input_left} = $len;
return;
}
- my $err = $self->{env}->{'psgi.errors'};
- $err->print("error reading for input: $! ($len bytes remaining)\n");
- $self->quit(500);
+ err($self, "error reading for input: $! ($len bytes remaining)");
+ quit($self, 500);
}
sub write_in_full {
while (1) { # chunk start
if ($len == CHUNK_ZEND) {
- return app_dispatch($self) if $$rbuf =~ s/\A\r\n//s;
- return $self->quit(400) if length($$rbuf) > 2;
+ $$rbuf =~ s/\A\r\n//s and
+ return app_dispatch($self, $input);
+ return quit($self, 400) if length($$rbuf) > 2;
}
if ($len == CHUNK_END) {
if ($$rbuf =~ s/\A\r\n//s) {
$len = CHUNK_START;
} elsif (length($$rbuf) > 2) {
- return $self->quit(400);
+ return quit($self, 400);
}
}
if ($len == CHUNK_START) {
if ($$rbuf =~ s/\A([a-f0-9]+).*?\r\n//i) {
$len = hex $1;
+ if (($len + -s $input) > $MAX_REQUEST_BUFFER) {
+ return quit($self, 413);
+ }
} elsif (length($$rbuf) > CHUNK_MAX_HDR) {
- return $self->quit(400);
+ return quit($self, 400);
}
# will break from loop since $len >= 0
}
if ($len < 0) { # chunk header is trickled, read more
my $off = length($$rbuf);
my $r = sysread($sock, $$rbuf, 8192, $off);
- return $self->recv_err($r, $len) unless $r;
+ return recv_err($self, $r, $len) unless $r;
# (implicit) goto chunk_start if $r > 0;
}
$len = CHUNK_ZEND if $len == 0;
until ($len <= 0) {
if ($$rbuf ne '') {
my $w = write_in_full($input, $rbuf, $len);
- return $self->write_err unless $w;
+ return write_err($self, "$len chunk") if !$w;
$len -= $w;
if ($len == 0) {
# we may have leftover data to parse
if ($$rbuf eq '') {
# read more of current chunk
my $r = sysread($sock, $$rbuf, 8192);
- return $self->recv_err($r, $len) unless $r;
+ return recv_err($self, $r, $len) unless $r;
}
}
}
$self->close;
}
-# callbacks for Danga::Socket
+# callbacks for PublicInbox::DS
sub event_hup { $_[0]->close }
sub event_err { $_[0]->close }
+sub close {
+ my $self = shift;
+ my $forward = $self->{forward};
+ my $env = $self->{env};
+ delete $env->{'psgix.io'} if $env; # prevent circular references
+ $self->{pull} = $self->{forward} = $self->{env} = undef;
+ if ($forward) {
+ eval { $forward->close };
+ err($self, "forward ->close error: $@") if $@;
+ }
+ $self->SUPER::close(@_);
+}
+
# for graceful shutdown in PublicInbox::Daemon:
sub busy () {
my ($self) = @_;