]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/HTTP.pm
www: label sections and hopefully improve navigation
[public-inbox.git] / lib / PublicInbox / HTTP.pm
index 414fc733a99be34d483f4126e2f8361d0e15f0ca..fa34b443f579b45c37a72b8678e64978062fe6a1 100644 (file)
@@ -4,18 +4,19 @@
 # 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 remote_addr remote_port);
+use fields qw(httpd env rbuf input_left remote_addr remote_port forward pull);
 use Fcntl qw(:seek);
 use Plack::HTTPParser qw(parse_http_request); # XS or pure Perl
 use HTTP::Status qw(status_message);
 use HTTP::Date qw(time2str);
+use Scalar::Util qw(weaken);
 use IO::File;
 use constant {
        CHUNK_START => -1,   # [a-f0-9]+\r\n
@@ -24,6 +25,18 @@ use constant {
        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...
@@ -85,7 +98,7 @@ sub rbuf_process {
        $self->{rbuf} = substr($self->{rbuf}, $r);
 
        my $len = input_prepare($self, \%env);
-       defined $len or return write_err($self); # EMFILE/ENFILE
+       defined $len or return write_err($self, undef); # EMFILE/ENFILE
 
        $len ? event_read_input($self) : app_dispatch($self);
 }
@@ -105,7 +118,7 @@ sub event_read_input ($) {
        while ($len > 0) {
                if ($$rbuf ne '') {
                        my $w = write_in_full($input, $rbuf, $len);
-                       return write_err($self) 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
@@ -171,12 +184,20 @@ sub response_header_write {
 
        my $conn = $env->{HTTP_CONNECTION} || '';
        my $term = defined($len) || $chunked;
-       my $alive = $term &&
-                       (($proto eq 'HTTP/1.1' && $conn !~ /\bclose\b/i) ||
-                        ($conn =~ /\bkeep-alive\b/i));
-
-       $h .= 'Connection: ' . ($alive ? 'keep-alive' : 'close');
-       $h .= "\r\nDate: " . http_date() . "\r\n\r\n";
+       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);
@@ -186,22 +207,83 @@ sub response_header_write {
        $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 ($$) {
+       my ($self, $alive) = @_;
+       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_response {
+       my ($self, $body, $write, $close) = @_;
+       $self->{forward} = $body;
+       weaken($self);
+       my $pull = $self->{pull} = sub {
+               local $/ = \8192;
+               my $forward = $self->{forward};
+               # limit our own running time for fairness with other
+               # clients and to avoid buffering too much:
+               while ($forward && defined(my $buf = $forward->getline)) {
+                       $write->($buf);
+                       last if $self->{closed};
+                       if ($self->{write_buf_size}) {
+                               $self->write($self->{pull});
+                       } else {
+                               PublicInbox::EvCleanup::asap($self->{pull});
+                       }
+                       return;
+               }
+               $self->{forward} = $self->{pull} = undef;
+               $forward->close if $forward; # avoid recursion
+               $close->();
+       };
+       $pull->();
+}
+
 sub response_write {
        my ($self, $env, $res) = @_;
        my $alive = 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 $write = $alive == 2 ? chunked_wcb($self) : identity_wcb($self);
+       my $close = sub { response_done($self, $alive) };
+       if (defined(my $body = $res->[2])) {
+               if (ref $body eq 'ARRAY') {
+                       $write->($_) foreach @$body;
+                       $close->();
                } else {
-                       $self->write(sub { $self->close });
+                       getline_response($self, $body, $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);
@@ -211,6 +293,7 @@ sub response_write {
 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) {
@@ -223,19 +306,6 @@ sub more ($$) {
        $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 '') { # wait for next request
-               $self->watch_read(1);
-       } else { # avoid recursion for pipelined requests
-               Danga::Socket->AddTimer(0, sub { rbuf_process($self) });
-       }
-}
-
 sub input_prepare {
        my ($self, $env) = @_;
        my $input = $null_io;
@@ -254,7 +324,6 @@ sub input_prepare {
        # TODO: expire idle clients on ENFILE / EMFILE
        return unless $input;
 
-       binmode $input;
        $env->{'psgi.input'} = $input;
        $self->{env} = $env;
        $self->{input_left} = $len || 0;
@@ -263,9 +332,10 @@ sub input_prepare {
 sub env_chunked { ($_[0]->{HTTP_TRANSFER_ENCODING} || '') =~ /\bchunked\b/i }
 
 sub write_err {
-       my ($self) = @_;
+       my ($self, $len) = @_;
        my $err = $self->{httpd}->{env}->{'psgi.errors'};
        my $msg = $! || '(zero write)';
+       $msg .= " ($len bytes remaining)" if defined $len;
        $err->print("error buffering to input: $msg\n");
        quit($self, 500);
 }
@@ -341,7 +411,7 @@ sub event_read_input_chunked { # unlikely...
                until ($len <= 0) {
                        if ($$rbuf ne '') {
                                my $w = write_in_full($input, $rbuf, $len);
-                               return write_err($self) unless $w;
+                               return write_err($self, "$len chunk") if !$w;
                                $len -= $w;
                                if ($len == 0) {
                                        # we may have leftover data to parse
@@ -377,17 +447,14 @@ sub event_err { $_[0]->close }
 
 sub close {
        my $self = shift;
-       $self->{env} = undef;
+       my $forward = $self->{forward};
+       my $env = $self->{env};
+       delete $env->{'psgix.io'} if $env; # prevent circular referernces
+       $self->{pull} = $self->{forward} = $self->{env} = undef;
+       $forward->close if $forward;
        $self->SUPER::close(@_);
 }
 
-sub write ($$) : method {
-       my PublicInbox::HTTP $self = $_[0];
-       return 1 if (defined($_[1]) && ref($_[1]) eq '' && $_[1] eq '');
-
-       $self->SUPER::write($_[1]);
-}
-
 # for graceful shutdown in PublicInbox::Daemon:
 sub busy () {
        my ($self) = @_;