www: update internal docs

[public-inbox.git] / lib / PublicInbox / GetlineBody.pm

diff --git a/lib/PublicInbox/GetlineBody.pm b/lib/PublicInbox/GetlineBody.pm
index ea07f3d6dd0de1d031012c62372754dbc91acd49..988bc63f41d59bac209931af65bc64d05deedd0b 100644 (file)
--- a/lib/PublicInbox/GetlineBody.pm
+++ b/lib/PublicInbox/GetlineBody.pm
@@ -1,20 +1,24 @@
-# Copyright (C) 2016-2018 all contributors <meta@public-inbox.org>
+# Copyright (C) 2016-2020 all contributors <meta@public-inbox.org>
 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
 
 # Wrap a pipe or file for PSGI streaming response bodies and calls the
 # end callback when the object goes out-of-scope.
 # This depends on rpipe being _blocking_ on getline.
 #
-# public-inbox-httpd favors "getline" response bodies to take a
-# "pull"-based approach to feeding slow clients (as opposed to a
-# more common "push" model)
+# This is only used by generic PSGI servers and not public-inbox-httpd
 package PublicInbox::GetlineBody;
 use strict;
 use warnings;
 
 sub new {
-       my ($class, $rpipe, $end, $buf) = @_;
-       bless { rpipe => $rpipe, end => $end, buf => $buf }, $class;
+       my ($class, $rpipe, $end, $end_arg, $buf, $filter) = @_;
+       bless {
+               rpipe => $rpipe,
+               end => $end,
+               end_arg => $end_arg,
+               initial_buf => $buf,
+               filter => $filter,
+       }, $class;
 }
 
 # close should always be called after getline returns undef,
@@ -24,16 +28,19 @@ sub DESTROY { $_[0]->close }
 
 sub getline {
        my ($self) = @_;
-       my $buf = delete $self->{buf}; # initial buffer
-       defined $buf ? $buf : $self->{rpipe}->getline;
+       my $rpipe = $self->{rpipe} or return; # EOF was set on previous call
+       my $buf = delete($self->{initial_buf}) // $rpipe->getline;
+       delete($self->{rpipe}) unless defined $buf; # set EOF for next call
+       if (my $filter = $self->{filter}) {
+               $buf = $filter->translate($buf);
+       }
+       $buf;
 }
 
 sub close {
        my ($self) = @_;
-       my $rpipe = delete $self->{rpipe};
-       close $rpipe if $rpipe;
-       my $end = delete $self->{end};
-       $end->() if $end;
+       my ($end, $end_arg) = delete @$self{qw(end end_arg)};
+       $end->($end_arg) if $end;
 }
 
 1;