]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/HTTP.pm
treewide: "require" + "use" cleanup and docs
[public-inbox.git] / lib / PublicInbox / HTTP.pm
index 53d508368fc68b6bf5e255a59c94f37c5e677a8b..1346901ad52300fd4b9985c18ba912502ce0f649 100644 (file)
@@ -11,13 +11,14 @@ package PublicInbox::HTTP;
 use strict;
 use warnings;
 use base qw(PublicInbox::DS);
-use fields qw(httpd env input_left remote_addr remote_port forward);
+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;
+use IO::Handle; # ->write
 use PublicInbox::DS qw(msg_more);
 use PublicInbox::Syscall qw(EPOLLIN EPOLLONESHOT);
 use PublicInbox::Tmpfile;
@@ -164,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') {
@@ -222,22 +223,20 @@ 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 ($) {
@@ -251,76 +250,77 @@ sub next_request ($) {
        }
 }
 
-sub response_done_cb ($$) {
+sub response_done {
        my ($self, $alive) = @_;
-       sub {
-               delete $self->{env}; # we're no longer busy
-               $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_response ($$$) {
-       my ($self, $write, $close) = @_;
-       my $pull; # DANGER: self-referential
-       $pull = sub {
-               my $forward = $self->{forward};
-               # limit our own running time for fairness with other
-               # clients and to avoid buffering too much:
-               my $buf = eval {
-                       local $/ = \8192;
-                       $forward->getline;
-               } if $forward;
-
-               if (defined $buf) {
-                       $write->($buf); # may close in PublicInbox::DS::write
-
-                       if ($self->{sock}) {
-                               my $wbuf = $self->{wbuf} ||= [];
-                               push @$wbuf, $pull;
-
-                               # wbuf may be populated by $write->($buf),
-                               # no need to rearm if so:
-                               $self->requeue if scalar(@$wbuf) == 1;
-                               return; # likely
-                       }
-               } elsif ($@) {
-                       err($self, "response ->getline error: $@");
-                       $self->close;
+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:
+       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);
                }
 
-               $pull = undef; # all done!
-               # avoid recursion
-               if (delete $self->{forward}) {
-                       eval { $forward->close };
-                       if ($@) {
-                               err($self, "response ->close error: $@");
-                               $self->close; # idempotent
-                       }
-               }
-               $forward = undef;
-               $close->(); # call response_done_cb
-       };
+               if ($self->{sock}) {
+                       my $wbuf = $self->{wbuf} //= [];
+                       push @$wbuf, \&getline_pull;
 
-       $pull->(); # kick-off!
+                       # wbuf may be populated by {chunked,identity}_write()
+                       # above, no need to rearm if so:
+                       $self->requeue if scalar(@$wbuf) == 1;
+                       return; # likely
+               }
+       } elsif ($@) {
+               err($self, "response ->getline error: $@");
+               $self->close;
+       }
+       # avoid recursion
+       if (delete $self->{forward}) {
+               eval { $forward->close };
+               if ($@) {
+                       err($self, "response ->close error: $@");
+                       $self->close; # idempotent
+               }
+       }
+       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';
        }
 }
 
@@ -466,4 +466,29 @@ sub busy () {
        ($self->{rbuf} || $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])
+}
+
+sub close {
+       # $_[0] = [$http, $alive]
+       PublicInbox::HTTP::response_done(@{$_[0]});
+}
+
+package PublicInbox::HTTP::Identity;
+use strict;
+our @ISA = qw(PublicInbox::HTTP::Chunked);
+
+sub write {
+       # ([$http], $buf) = @_;
+       PublicInbox::HTTP::identity_write($_[0]->[0], $_[1]);
+}
+
 1;