-# Copyright (C) 2016-2020 all contributors <meta@public-inbox.org>
+# Copyright (C) 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
# to learn different ways to admin both NNTP and HTTP components.
# There's nothing which depends on public-inbox, here.
# Each instance of this class represents a HTTP client socket
-
+#
+# fields:
+# httpd: PublicInbox::HTTPD ref
+# env: PSGI env hashref
+# input_left: bytes left to read in request body (e.g. POST/PUT)
+# remote_addr: remote IP address as a string (e.g. "127.0.0.1")
+# remote_port: peer port
+# forward: response body object, response to ->getline + ->close
+# alive: HTTP keepalive state:
+# 0: drop connection when done
+# 1: keep connection when done
+# 2: keep connection, chunk responses
package PublicInbox::HTTP;
use strict;
-use warnings;
-use base qw(PublicInbox::DS);
-use fields qw(httpd env input_left remote_addr remote_port forward alive);
-use bytes (); # only for bytes::length
+use parent qw(PublicInbox::DS);
use Fcntl qw(:seek);
use Plack::HTTPParser qw(parse_http_request); # XS or pure Perl
use Plack::Util;
use HTTP::Status qw(status_message);
use HTTP::Date qw(time2str);
-use IO::Handle; # ->write
use PublicInbox::DS qw(msg_more);
use PublicInbox::Syscall qw(EPOLLIN EPOLLONESHOT);
use PublicInbox::Tmpfile;
};
use Errno qw(EAGAIN);
-my $pipelineq = [];
-sub process_pipelineq () {
- my $q = $pipelineq;
- $pipelineq = [];
- foreach (@$q) {
- next unless $_->{sock};
- 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...
}
sub new ($$$) {
- my ($class, $sock, $addr, $httpd) = @_;
- my $self = fields::new($class);
+ my ($class, $sock, $addr, $srv_env) = @_;
+ my $self = bless { srv_env => $srv_env }, $class;
my $ev = EPOLLIN;
my $wbuf;
if ($sock->can('accept_SSL') && !$sock->accept_SSL) {
return CORE::close($sock) if $! != EAGAIN;
- $ev = PublicInbox::TLS::epollbit();
+ $ev = PublicInbox::TLS::epollbit() or return CORE::close($sock);
$wbuf = [ \&PublicInbox::DS::accept_tls_step ];
}
- $self->SUPER::new($sock, $ev | EPOLLONESHOT);
- $self->{httpd} = $httpd;
$self->{wbuf} = $wbuf if $wbuf;
($self->{remote_addr}, $self->{remote_port}) =
PublicInbox::Daemon::host_with_port($addr);
- $self;
+ $self->SUPER::new($sock, $ev | EPOLLONESHOT);
}
sub event_step { # called by PublicInbox::DS
my ($self) = @_;
-
+ local $SIG{__WARN__} = $self->{srv_env}->{'pi-httpd.warn_cb'};
return unless $self->flush_write && $self->{sock};
# only read more requests if we've drained the write buffer,
# otherwise we can be buffering infinitely w/o backpressure
return read_input($self) if ref($self->{env});
- my $rbuf = $self->{rbuf} // (\(my $x = ''));
- $self->do_read($rbuf, 8192, bytes::length($$rbuf)) or return;
- rbuf_process($self, $rbuf);
-}
-
-sub rbuf_process {
- my ($self, $rbuf) = @_;
- $rbuf //= $self->{rbuf} // (\(my $x = ''));
-
- my %env = %{$self->{httpd}->{env}}; # full hash copy
- my $r = parse_http_request($$rbuf, \%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)
- if ($r == -1 || $env{HTTP_TRAILER} ||
- # this length-check is necessary for PURE_PERL=1:
- ($r == -2 && bytes::length($$rbuf) > 0x4000)) {
- return quit($self, 400);
- }
- if ($r < 0) { # incomplete
- $self->rbuf_idle($rbuf);
- return $self->requeue;
+ my $rbuf = $self->{rbuf} // (\(my $x = ''));
+ my %env = %{$self->{srv_env}}; # full hash copy
+ my $r;
+ while (($r = parse_http_request($$rbuf, \%env)) < 0) {
+ # 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).
+ # this length-check is necessary for PURE_PERL=1:
+ if ($r == -1 || $env{HTTP_TRAILER} ||
+ ($r == -2 && length($$rbuf) > 0x4000)) {
+ return quit($self, 400);
+ }
+ $self->do_read($rbuf, 8192, length($$rbuf)) or return;
}
+ return quit($self, 400) if grep(/\s/, keys %env); # stop smugglers
$$rbuf = substr($$rbuf, $r);
- my $len = input_prepare($self, \%env);
- defined $len or return write_err($self, undef); # EMFILE/ENFILE
+ my $len = input_prepare($self, \%env) //
+ return write_err($self, undef); # EMFILE/ENFILE
$len ? read_input($self, $rbuf) : app_dispatch($self, undef, $rbuf);
}
-# IO::Handle::write returns boolean, this returns bytes written:
-sub xwrite ($$$) {
- my ($fh, $rbuf, $max) = @_;
- my $w = bytes::length($$rbuf);
- $w = $max if $w > $max;
- $fh->write($$rbuf, $w) or return;
- $w;
-}
-
sub read_input ($;$) {
my ($self, $rbuf) = @_;
$rbuf //= $self->{rbuf} // (\(my $x = ''));
while ($len > 0) {
if ($$rbuf ne '') {
- my $w = xwrite($input, $rbuf, $len);
+ my $w = syswrite($input, $$rbuf, $len);
return write_err($self, $len) unless $w;
$len -= $w;
die "BUG: $len < 0 (w=$w)" if $len < 0;
$env->{REMOTE_ADDR} = $self->{remote_addr};
$env->{REMOTE_PORT} = $self->{remote_port};
if (defined(my $host = $env->{HTTP_HOST})) {
- $host =~ s/:([0-9]+)\z// and $env->{SERVER_PORT} = $1;
+ $host =~ s/:([0-9]+)\z// and $env->{SERVER_PORT} = $1 + 0;
$env->{SERVER_NAME} = $host;
}
if (defined $input) {
# note: NOT $self->{sock}, we want our close (+ PublicInbox::DS::close),
# to do proper cleanup:
$env->{'psgix.io'} = $self; # for ->close or async_pass
- my $res = Plack::Util::run_app($self->{httpd}->{app}, $env);
+ my $res = Plack::Util::run_app($env->{'pi-httpd.app'}, $env);
eval {
if (ref($res) eq 'CODE') {
$res->(sub { response_write($self, $env, $_[0]) });
}
};
if ($@) {
- err($self, "response_write error: $@");
+ warn "response_write error: $@";
$self->close;
}
}
my $alive;
if (!$term && $prot_persist) { # auto-chunk
$chunked = $alive = 2;
+ $alive = 3 if $env->{REQUEST_METHOD} eq 'HEAD';
$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))) {
sub chunked_write ($$) {
my $self = $_[0];
return if $_[1] eq '';
- msg_more($self, sprintf("%x\r\n", bytes::length($_[1])));
+ msg_more($self, sprintf("%x\r\n", length($_[1])));
msg_more($self, $_[1]);
# use $self->write(\"\n\n") if you care about real-time
$self->write(\($_[1])) if $_[1] ne '';
}
-sub next_request ($) {
- my ($self) = @_;
- if ($self->{rbuf}) {
- # avoid recursion for pipelined requests
- PublicInbox::DS::requeue(\&process_pipelineq) if !@$pipelineq;
- push @$pipelineq, $self;
- } else { # wait for next request
- $self->requeue;
- }
-}
-
sub response_done {
my ($self, $alive) = @_;
delete $self->{env}; # we're no longer busy
+ # HEAD requests set $alive = 3 so we don't send "0\r\n\r\n";
$self->write(\"0\r\n\r\n") if $alive == 2;
- $self->write($alive ? \&next_request : \&close);
+ $self->write($alive ? $self->can('requeue') : \&close);
}
sub getline_pull {
# limit our own running time for fairness with other
# clients and to avoid buffering too much:
my $buf = eval {
- local $/ = \8192;
+ local $/ = \65536;
$forward->getline;
} if $forward;
return; # likely
}
} elsif ($@) {
- err($self, "response ->getline error: $@");
+ warn "response ->getline error: $@";
$self->close;
}
# avoid recursion
if (delete $self->{forward}) {
eval { $forward->close };
if ($@) {
- err($self, "response ->close error: $@");
+ warn "response ->close error: $@";
$self->close; # idempotent
}
}
getline_pull($self); # kick-off!
}
# these are returned to the calling application:
- } elsif ($alive == 2) {
+ } elsif ($alive >= 2) {
bless [ $self, $alive ], 'PublicInbox::HTTP::Chunked';
} else {
bless [ $self, $alive ], 'PublicInbox::HTTP::Identity';
}
}
-sub input_tmpfile ($) {
- my $input = tmpfile('http.input', $_[0]->{sock}) or return;
- $input->autoflush(1);
- $input;
-}
-
sub input_prepare {
my ($self, $env) = @_;
my ($input, $len);
return quit($self, 400) if $hte !~ /\Achunked\z/i;
$len = CHUNK_START;
- $input = input_tmpfile($self);
+ $input = tmpfile('http.input', $self->{sock});
} else {
$len = $env->{CONTENT_LENGTH};
if (defined $len) {
# rfc7230 3.3.3.4
return quit($self, 400) if $len !~ /\A[0-9]+\z/;
-
return quit($self, 413) if $len > $MAX_REQUEST_BUFFER;
- $input = $len ? input_tmpfile($self) : $null_io;
+ $input = $len ? tmpfile('http.input', $self->{sock})
+ : $null_io;
} else {
$input = $null_io;
}
}
# TODO: expire idle clients on ENFILE / EMFILE
- return unless $input;
-
- $env->{'psgi.input'} = $input;
+ $env->{'psgi.input'} = $input // return;
$self->{env} = $env;
$self->{input_left} = $len || 0;
}
sub env_chunked { ($_[0]->{HTTP_TRANSFER_ENCODING} // '') =~ /\Achunked\z/i }
-sub err ($$) {
- eval { $_[0]->{httpd}->{env}->{'psgi.errors'}->print($_[1]."\n") };
-}
-
sub write_err {
my ($self, $len) = @_;
my $msg = $! || '(zero write)';
$msg .= " ($len bytes remaining)" if defined $len;
- err($self, "error buffering to input: $msg");
+ warn "error buffering to input: $msg";
quit($self, 500);
}
if ($! == EAGAIN) { # epoll/kevent watch already set by do_read
$self->{input_left} = $len;
} else {
- err($self, "error reading input: $! ($len bytes remaining)");
+ warn "error reading input: $! ($len bytes remaining)";
}
}
$$rbuf =~ s/\A\r\n//s and
return app_dispatch($self, $input, $rbuf);
- return quit($self, 400) if bytes::length($$rbuf) > 2;
+ return quit($self, 400) if length($$rbuf) > 2;
}
if ($len == CHUNK_END) {
if ($$rbuf =~ s/\A\r\n//s) {
$len = CHUNK_START;
- } elsif (bytes::length($$rbuf) > 2) {
+ } elsif (length($$rbuf) > 2) {
return quit($self, 400);
}
}
if (($len + -s $input) > $MAX_REQUEST_BUFFER) {
return quit($self, 413);
}
- } elsif (bytes::length($$rbuf) > CHUNK_MAX_HDR) {
+ } elsif (length($$rbuf) > CHUNK_MAX_HDR) {
return quit($self, 400);
}
# will break from loop since $len >= 0
}
if ($len < 0) { # chunk header is trickled, read more
- $self->do_read($rbuf, 8192, bytes::length($$rbuf)) or
+ $self->do_read($rbuf, 8192, length($$rbuf)) or
return recv_err($self, $len);
# (implicit) goto chunk_start if $r > 0;
}
# drain the current chunk
until ($len <= 0) {
if ($$rbuf ne '') {
- my $w = xwrite($input, $rbuf, $len);
+ my $w = syswrite($input, $$rbuf, $len);
return write_err($self, "$len chunk") if !$w;
$len -= $w;
if ($len == 0) {
my $self = $_[0];
if (my $forward = delete $self->{forward}) {
eval { $forward->close };
- err($self, "forward ->close error: $@") if $@;
+ warn "forward ->close error: $@" if $@;
}
$self->SUPER::close; # PublicInbox::DS::close
}
-# for graceful shutdown in PublicInbox::Daemon:
-sub busy () {
+sub busy { # for graceful shutdown in PublicInbox::Daemon:
my ($self) = @_;
- ($self->{rbuf} || exists($self->{env}) || $self->{wbuf});
+ defined($self->{rbuf}) || exists($self->{env}) || defined($self->{wbuf})
+}
+
+# runs $cb on the next iteration of the event loop at earliest
+sub next_step {
+ my ($self, $cb) = @_;
+ return unless exists $self->{sock};
+ $self->requeue if 1 == push(@{$self->{wbuf}}, $cb);
}
# Chunked and Identity packages are used for writing responses.