X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FHTTP.pm;h=df328904a86b57e318879afa67da71ecea35ee8f;hb=95bdac7f09c69036efed537a4d03d5bdd2ae4eb6;hp=a1cb4aca9469c236bb090fa92c5deaafa834e009;hpb=a3c27256d273492e1c9ee464dabda2c7ed4019c2;p=public-inbox.git diff --git a/lib/PublicInbox/HTTP.pm b/lib/PublicInbox/HTTP.pm index a1cb4aca..df328904 100644 --- a/lib/PublicInbox/HTTP.pm +++ b/lib/PublicInbox/HTTP.pm @@ -1,4 +1,4 @@ -# Copyright (C) 2016-2018 all contributors +# Copyright (C) 2016-2020 all contributors # License: AGPL-3.0+ # # Generic PSGI server for convenience. It aims to provide @@ -11,16 +11,17 @@ package PublicInbox::HTTP; use strict; use warnings; use base qw(PublicInbox::DS); -use fields qw(httpd env rbuf input_left remote_addr remote_port forward pull); +use fields qw(httpd env input_left remote_addr remote_port forward alive); use bytes (); # only for bytes::length 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; -require PublicInbox::EvCleanup; -PublicInbox::DS->import(qw(msg_more)); +use IO::Handle; # ->write +use PublicInbox::DS qw(msg_more); use PublicInbox::Syscall qw(EPOLLIN EPOLLONESHOT); +use PublicInbox::Tmpfile; use constant { CHUNK_START => -1, # [a-f0-9]+\r\n CHUNK_END => -2, # \r\n @@ -30,10 +31,8 @@ use constant { use Errno qw(EAGAIN); my $pipelineq = []; -my $pipet; sub process_pipelineq () { my $q = $pipelineq; - $pipet = undef; $pipelineq = []; foreach (@$q) { next unless $_->{sock}; @@ -58,9 +57,16 @@ sub http_date () { sub new ($$$) { my ($class, $sock, $addr, $httpd) = @_; my $self = fields::new($class); - $self->SUPER::new($sock, EPOLLIN | EPOLLONESHOT); + my $ev = EPOLLIN; + my $wbuf; + if (ref($sock) eq 'IO::Socket::SSL' && !$sock->accept_SSL) { + return CORE::close($sock) if $! != EAGAIN; + $ev = PublicInbox::TLS::epollbit(); + $wbuf = [ \&PublicInbox::DS::accept_tls_step ]; + } + $self->SUPER::new($sock, $ev | EPOLLONESHOT); $self->{httpd} = $httpd; - $self->{rbuf} = ''; + $self->{wbuf} = $wbuf if $wbuf; ($self->{remote_addr}, $self->{remote_port}) = PublicInbox::Daemon::host_with_port($addr); $self; @@ -74,32 +80,35 @@ sub event_step { # called by PublicInbox::DS # 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 defined $self->{env}; - my $rbuf = \($self->{rbuf}); - my $off = bytes::length($$rbuf); - $self->do_read($rbuf, 8192, $off) and rbuf_process($self); + 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) = @_; + my ($self, $rbuf) = @_; + $rbuf //= $self->{rbuf} // (\(my $x = '')); my %env = %{$self->{httpd}->{env}}; # full hash copy - my $r = parse_http_request($self->{rbuf}, \%env); + 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($self->{rbuf}) > 0x4000)) { + ($r == -2 && bytes::length($$rbuf) > 0x4000)) { return quit($self, 400); } - return $self->watch_in1 if $r < 0; # incomplete - $self->{rbuf} = substr($self->{rbuf}, $r); - + if ($r < 0) { # incomplete + $self->rbuf_idle($rbuf); + return $self->requeue; + } + $$rbuf = substr($$rbuf, $r); my $len = input_prepare($self, \%env); defined $len or return write_err($self, undef); # EMFILE/ENFILE - $len ? read_input($self) : app_dispatch($self); + $len ? read_input($self, $rbuf) : app_dispatch($self, undef, $rbuf); } # IO::Handle::write returns boolean, this returns bytes written: @@ -111,16 +120,14 @@ sub xwrite ($$$) { $w; } -sub read_input ($) { - my ($self) = @_; +sub read_input ($;$) { + my ($self, $rbuf) = @_; + $rbuf //= $self->{rbuf} // (\(my $x = '')); my $env = $self->{env}; - return if $env->{REMOTE_ADDR}; # in app dispatch - return read_input_chunked($self) if env_chunked($env); + return read_input_chunked($self, $rbuf) if env_chunked($env); # env->{CONTENT_LENGTH} (identity) - my $sock = $self->{sock}; my $len = delete $self->{input_left}; - my $rbuf = \($self->{rbuf}); my $input = $env->{'psgi.input'}; while ($len > 0) { @@ -135,19 +142,20 @@ sub read_input ($) { } $$rbuf = ''; } - my $r = sysread($sock, $$rbuf, 8192); - return recv_err($self, $r, $len) unless $r; + $self->do_read($rbuf, 8192) or return recv_err($self, $len); # continue looping if $r > 0; } - app_dispatch($self, $input); + app_dispatch($self, $input, $rbuf); } sub app_dispatch { - my ($self, $input) = @_; + my ($self, $input, $rbuf) = @_; + $self->rbuf_idle($rbuf); my $env = $self->{env}; + $self->{env} = undef; # for exists() check in ->busy $env->{REMOTE_ADDR} = $self->{remote_addr}; $env->{REMOTE_PORT} = $self->{remote_port}; - if (my $host = $env->{HTTP_HOST}) { + if (defined(my $host = $env->{HTTP_HOST})) { $host =~ s/:([0-9]+)\z// and $env->{SERVER_PORT} = $1; $env->{SERVER_NAME} = $host; } @@ -157,7 +165,7 @@ sub app_dispatch { } # note: NOT $self->{sock}, we want our close (+ PublicInbox::DS::close), # to do proper cleanup: - $env->{'psgix.io'} = $self; # only for ->close + $env->{'psgix.io'} = $self; # for ->close or async_pass my $res = Plack::Util::run_app($self->{httpd}->{app}, $env); eval { if (ref($res) eq 'CODE') { @@ -166,7 +174,10 @@ sub app_dispatch { response_write($self, $env, $res); } }; - $self->close if $@; + if ($@) { + err($self, "response_write error: $@"); + $self->close; + } } sub response_header_write { @@ -215,109 +226,111 @@ sub response_header_write { } # middlewares such as Deflater may write empty strings -sub chunked_wcb ($) { - my ($self) = @_; - sub { - return if $_[0] eq ''; - msg_more($self, sprintf("%x\r\n", bytes::length($_[0]))); - msg_more($self, $_[0]); - - # use $self->write(\"\n\n") if you care about real-time - # streaming responses, public-inbox WWW does not. - msg_more($self, "\r\n"); - } +sub chunked_write ($$) { + my $self = $_[0]; + return if $_[1] eq ''; + msg_more($self, sprintf("%x\r\n", bytes::length($_[1]))); + msg_more($self, $_[1]); + + # use $self->write(\"\n\n") if you care about real-time + # streaming responses, public-inbox WWW does not. + msg_more($self, "\r\n"); } -sub identity_wcb ($) { - my ($self) = @_; - sub { $self->write(\($_[0])) if $_[0] ne '' } +sub identity_write ($$) { + my $self = $_[0]; + $self->write(\($_[1])) if $_[1] ne ''; } sub next_request ($) { my ($self) = @_; - if ($self->{rbuf} eq '') { # wait for next request - $self->watch_in1; - } else { # avoid recursion for pipelined requests + if ($self->{rbuf}) { + # avoid recursion for pipelined requests + PublicInbox::DS::requeue(\&process_pipelineq) if !@$pipelineq; push @$pipelineq, $self; - $pipet ||= PublicInbox::EvCleanup::asap(*process_pipelineq); + } else { # wait for next request + $self->requeue; } } -sub response_done_cb ($$) { +sub response_done { my ($self, $alive) = @_; - sub { - my $env = delete $self->{env}; - $self->write(\"0\r\n\r\n") if $alive == 2; - $self->write($alive ? \&next_request : \&close); - } + delete $self->{env}; # we're no longer busy + $self->write(\"0\r\n\r\n") if $alive == 2; + $self->write($alive ? \&next_request : \&close); } -sub getline_cb ($$$) { - my ($self, $write, $close) = @_; - local $/ = \8192; +sub getline_pull { + my ($self) = @_; 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 - if ($self->{sock}) { - my $next = $self->{pull}; - if ($self->{wbuf}) { - $self->write($next); - } else { - PublicInbox::EvCleanup::asap($next); - } - return; - } - } elsif ($@) { - err($self, "response ->getline error: $@"); - $forward = undef; - $self->close; + my $buf = eval { + local $/ = \8192; + $forward->getline; + } if $forward; + + if (defined $buf) { + # may close in PublicInbox::DS::write + if ($self->{alive} == 2) { + chunked_write($self, $buf); + } else { + identity_write($self, $buf); } - } - delete @$self{qw(forward pull)}; + if ($self->{sock}) { + # autovivify wbuf + my $new_size = push(@{$self->{wbuf}}, \&getline_pull); + + # wbuf may be populated by {chunked,identity}_write() + # above, no need to rearm if so: + $self->requeue if $new_size == 1; + return; # likely + } + } elsif ($@) { + err($self, "response ->getline error: $@"); + $self->close; + } # avoid recursion - if ($forward) { + if (delete $self->{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->(); + response_done($self, delete $self->{alive}); } sub response_write { my ($self, $env, $res) = @_; 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->(); + if ($alive == 2) { + chunked_write($self, $_) for @$body; + } else { + identity_write($self, $_) for @$body; + } + response_done($self, $alive); } else { $self->{forward} = $body; - getline_response($self, $write, $close); + $self->{alive} = $alive; + getline_pull($self); # kick-off! } + # these are returned to the calling application: + } elsif ($alive == 2) { + bless [ $self, $alive ], 'PublicInbox::HTTP::Chunked'; } else { - # this is returned to the calling application: - Plack::Util::inline_object(write => $write, close => $close); + bless [ $self, $alive ], 'PublicInbox::HTTP::Identity'; } } sub input_tmpfile ($) { - open($_[0], '+>', undef); - $_[0]->autoflush(1); + my $input = tmpfile('http.input', $_[0]->{sock}) or return; + $input->autoflush(1); + $input; } sub input_prepare { @@ -329,10 +342,10 @@ sub input_prepare { quit($self, 413); return; } - input_tmpfile($input); + $input = input_tmpfile($self); } elsif (env_chunked($env)) { $len = CHUNK_START; - input_tmpfile($input); + $input = input_tmpfile($self); } else { $input = $null_io; } @@ -360,27 +373,25 @@ sub write_err { } sub recv_err { - my ($self, $r, $len) = @_; - return $self->close if (defined $r && $r == 0); - if ($! == EAGAIN) { + my ($self, $len) = @_; + if ($! == EAGAIN) { # epoll/kevent watch already set by do_read $self->{input_left} = $len; - return $self->watch_in1; + } else { + err($self, "error reading input: $! ($len bytes remaining)"); } - err($self, "error reading for input: $! ($len bytes remaining)"); - quit($self, 500); } sub read_input_chunked { # unlikely... - my ($self) = @_; + my ($self, $rbuf) = @_; + $rbuf //= $self->{rbuf} // (\(my $x = '')); my $input = $self->{env}->{'psgi.input'}; - my $sock = $self->{sock}; my $len = delete $self->{input_left}; - my $rbuf = \($self->{rbuf}); while (1) { # chunk start if ($len == CHUNK_ZEND) { $$rbuf =~ s/\A\r\n//s and - return app_dispatch($self, $input); + return app_dispatch($self, $input, $rbuf); + return quit($self, 400) if bytes::length($$rbuf) > 2; } if ($len == CHUNK_END) { @@ -403,9 +414,8 @@ sub read_input_chunked { # unlikely... } if ($len < 0) { # chunk header is trickled, read more - my $off = bytes::length($$rbuf); - my $r = sysread($sock, $$rbuf, 8192, $off); - return recv_err($self, $r, $len) unless $r; + $self->do_read($rbuf, 8192, bytes::length($$rbuf)) or + return recv_err($self, $len); # (implicit) goto chunk_start if $r > 0; } $len = CHUNK_ZEND if $len == 0; @@ -429,8 +439,8 @@ sub read_input_chunked { # unlikely... } if ($$rbuf eq '') { # read more of current chunk - my $r = sysread($sock, $$rbuf, 8192); - return recv_err($self, $r, $len) unless $r; + $self->do_read($rbuf, 8192) or + return recv_err($self, $len); } } } @@ -445,10 +455,6 @@ sub quit { sub close { my $self = $_[0]; - if (my $env = delete $self->{env}) { - delete $env->{'psgix.io'}; # prevent circular references - } - delete $self->{pull}; if (my $forward = delete $self->{forward}) { eval { $forward->close }; err($self, "forward ->close error: $@") if $@; @@ -459,14 +465,32 @@ sub close { # for graceful shutdown in PublicInbox::Daemon: sub busy () { my ($self) = @_; - ($self->{rbuf} ne '' || $self->{env} || $self->{wbuf}); + ($self->{rbuf} || exists($self->{env}) || $self->{wbuf}); +} + +# Chunked and Identity packages are used for writing responses. +# They may be exposed to the PSGI application when the PSGI app +# returns a CODE ref for "push"-based responses +package PublicInbox::HTTP::Chunked; +use strict; + +sub write { + # ([$http], $buf) = @_; + PublicInbox::HTTP::chunked_write($_[0]->[0], $_[1]) } -# fires after pending writes are complete: -sub restart_pass ($) { - $_[0]->{forward}->restart_read; # see PublicInbox::HTTPD::Async +sub close { + # $_[0] = [$http, $alive] + PublicInbox::HTTP::response_done(@{$_[0]}); } -sub enqueue_restart_pass ($) { $_[0]->write(\&restart_pass) } +package PublicInbox::HTTP::Identity; +use strict; +our @ISA = qw(PublicInbox::HTTP::Chunked); + +sub write { + # ([$http], $buf) = @_; + PublicInbox::HTTP::identity_write($_[0]->[0], $_[1]); +} 1;