1 # Copyright (C) 2016 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # Generic PSGI server for convenience. It aims to provide
5 # a consistent experience for public-inbox admins so they don't have
6 # to learn different ways to admin both NNTP and HTTP components.
7 # There's nothing public-inbox-specific, here.
8 # Each instance of this class represents a HTTP client socket
10 package PublicInbox::HTTP;
13 use base qw(Danga::Socket);
14 use fields qw(httpd env rbuf input_left);
16 use HTTP::Parser::XS qw(parse_http_request); # supports pure Perl fallback
17 use HTTP::Status qw(status_message);
18 use HTTP::Date qw(time2str);
20 my $null_io = IO::File->new('/dev/null', '<');
22 CHUNK_START => -1, # [a-f0-9]+\r\n
23 CHUNK_END => -2, # \r\n
24 CHUNK_ZEND => -3, # \r\n
29 my ($class, $sock, $addr, $httpd) = @_;
30 my $self = fields::new($class);
31 $self->SUPER::new($sock);
32 $self->{httpd} = $httpd;
38 sub event_read { # called by Danga::Socket
41 return event_read_input($self) if defined $self->{env};
43 my $off = length($self->{rbuf});
44 my $r = sysread($self->{sock}, $self->{rbuf}, 8192, $off);
46 return $self->close if $r == 0;
47 return rbuf_process($self);
49 return if $!{EAGAIN}; # no need to call watch_read(1) again
51 # common for clients to break connections without warning,
52 # would be too noisy to log here:
59 my %env = %{$self->{httpd}->{env}}; # full hash copy
60 my $r = parse_http_request($self->{rbuf}, \%env);
62 # We do not support Trailers in chunked requests, for now
63 # (they are rarely-used and git (as of 2.7.2) does not use them)
64 return $self->quit(400) if $r == -1 || $env{HTTP_TRAILER};
65 return $self->watch_read(1) if $r < 0; # incomplete
66 $self->{rbuf} = substr($self->{rbuf}, $r);
67 my $len = input_prepare($self, \%env);
68 $len ? event_read_input($self) : app_dispatch($self);
71 sub event_read_input ($) {
73 my $env = $self->{env};
74 return event_read_input_chunked($self) if env_chunked($env);
76 # env->{CONTENT_LENGTH} (identity)
77 my $sock = $self->{sock};
78 my $len = $self->{input_left};
79 $self->{input_left} = undef;
80 my $rbuf = \($self->{rbuf});
81 my $input = $env->{'psgi.input'};
85 my $w = write_in_full($input, $rbuf, $len);
86 return $self->write_err unless $w;
88 die "BUG: $len < 0 (w=$w)" if $len < 0;
89 if ($len == 0) { # next request may be pipelined
90 $$rbuf = substr($$rbuf, $w);
95 my $r = sysread($sock, $$rbuf, 8192);
96 return $self->recv_err($r, $len) unless $r;
97 # continue looping if $r > 0;
102 sub app_dispatch ($) {
104 $self->watch_read(0);
105 my $env = $self->{env};
106 $env->{REMOTE_ADDR} = $self->peer_ip_string; # Danga::Socket
107 $env->{REMOTE_PORT} = $self->{peer_port}; # set by peer_ip_string
108 if (my $host = $env->{HTTP_HOST}) {
109 $host =~ s/:(\d+)\z// and $env->{SERVER_PORT} = $1;
110 $env->{SERVER_NAME} = $host;
112 sysseek($env->{'psgi.input'}, 0, SEEK_SET) or die "input seek failed: $!";
113 my $res = Plack::Util::run_app($self->{httpd}->{app}, $env);
115 if (ref($res) eq 'CODE') {
116 $res->(sub { response_write($self, $env, $_[0]) });
118 response_write($self, $env, $res);
124 sub response_header_write {
125 my ($self, $env, $res) = @_;
126 my $proto = $env->{SERVER_PROTOCOL} or return; # HTTP/0.9 :P
127 my $status = $res->[0];
128 my $h = "$proto $status " . status_message($status) . "\r\n";
130 my $headers = $res->[1];
132 for (my $i = 0; $i < @$headers; $i += 2) {
133 my $k = $headers->[$i];
134 my $v = $headers->[$i + 1];
135 next if $k =~ /\A(?:Connection|Date)\z/i;
137 $len = $v if $k =~ /\AContent-Length\z/i;
138 if ($k =~ /\ATransfer-Encoding\z/i && $v =~ /\bchunked\b/i) {
145 my $conn = $env->{HTTP_CONNECTION} || '';
146 my $alive = (defined($len) || $chunked) &&
147 ($proto eq 'HTTP/1.1' && $conn !~ /\bclose\b/i) ||
148 ($conn =~ /\bkeep-alive\b/i);
150 $h .= 'Connection: ' . ($alive ? 'keep-alive' : 'close');
151 $h .= "\r\nDate: " . time2str(time) . "\r\n\r\n";
153 if (($len || $chunked) && $env->{REQUEST_METHOD} ne 'HEAD') {
162 my ($self, $env, $res) = @_;
163 my ($alive, $chunked) = response_header_write($self, $env, $res);
164 my $write = sub { $self->write($_[0]) };
167 $self->event_write; # watch for readability if done
169 $self->write(sub { $self->close });
171 $self->{env} = undef;
174 if (defined $res->[2]) {
175 Plack::Util::foreach($res->[2], $write);
178 # this is returned to the calling application:
179 Plack::Util::inline_object(write => $write, close => $close);
183 use constant MSG_MORE => ($^O eq 'linux') ? 0x8000 : 0;
186 if (MSG_MORE && !$self->{write_buf_size}) {
187 my $n = send($self->{sock}, $_[1], MSG_MORE);
189 my $dlen = length($_[1]);
190 return 1 if $n == $dlen; # all done!
191 $_[1] = substr($_[1], $n, $dlen - $n);
192 # fall through to normal write:
198 # overrides existing Danga::Socket method
201 # only continue watching for readability when we are done writing:
202 return if $self->write(undef) != 1;
204 if ($self->{rbuf} eq '') { # wait for next request
205 $self->watch_read(1);
206 } else { # avoid recursion for pipelined requests
207 Danga::Socket->AddTimer(0, sub { rbuf_process($self) });
212 my ($self, $env) = @_;
213 my $input = $null_io;
214 my $len = $env->{CONTENT_LENGTH};
216 $input = IO::File->new_tmpfile;
217 } elsif (env_chunked($env)) {
218 $input = IO::File->new_tmpfile;
222 $env->{'psgi.input'} = $input;
224 $self->{input_left} = $len;
227 sub env_chunked { ($_[0]->{HTTP_TRANSFER_ENCODING} || '') =~ /\bchunked\b/i }
231 my $err = $self->{env}->{'psgi.errors'};
232 my $msg = $! || '(zero write)';
233 $err->print("error buffering to input: $msg\n");
238 my ($self, $r, $len) = @_;
239 return $self->close if (defined $r && $r == 0);
241 $self->{input_left} = $len;
244 my $err = $self->{env}->{'psgi.errors'};
245 $err->print("error reading for input: $! ($len bytes remaining)\n");
250 my ($fh, $rbuf, $len) = @_;
254 my $w = syswrite($fh, $$rbuf, $len, $off);
255 return ($rv ? $rv : $w) unless $w; # undef or 0
263 sub event_read_input_chunked { # unlikely...
265 my $input = $self->{env}->{'psgi.input'};
266 my $sock = $self->{sock};
267 my $len = $self->{input_left};
268 $self->{input_left} = undef;
269 my $rbuf = \($self->{rbuf});
271 while (1) { # chunk start
272 if ($len == CHUNK_ZEND) {
273 return app_dispatch($self) if $$rbuf =~ s/\A\r\n//s;
274 return $self->quit(400) if length($$rbuf) > 2;
276 if ($len == CHUNK_END) {
277 if ($$rbuf =~ s/\A\r\n//s) {
279 } elsif (length($$rbuf) > 2) {
280 return $self->quit(400);
283 if ($len == CHUNK_START) {
284 if ($$rbuf =~ s/\A([a-f0-9]+).*?\r\n//i) {
286 } elsif (length($$rbuf) > CHUNK_MAX_HDR) {
287 return $self->quit(400);
289 # will break from loop since $len >= 0
292 if ($len < 0) { # chunk header is trickled, read more
293 my $off = length($$rbuf);
294 my $r = sysread($sock, $$rbuf, 8192, $off);
295 return $self->recv_err($r, $len) unless $r;
296 # (implicit) goto chunk_start if $r > 0;
298 $len = CHUNK_ZEND if $len == 0;
300 # drain the current chunk
303 my $w = write_in_full($input, $rbuf, $len);
304 return $self->write_err unless $w;
307 # we may have leftover data to parse
309 $$rbuf = substr($$rbuf, $w);
312 die "BUG: len < 0: $len";
318 # read more of current chunk
319 my $r = sysread($sock, $$rbuf, 8192);
320 return $self->recv_err($r, $len) unless $r;
327 my ($self, $status) = @_;
328 my $h = "HTTP/1.1 $status " . status_message($status) . "\r\n\r\n";
333 # callbacks for Danga::Socket
335 sub event_hup { $_[0]->close }
336 sub event_err { $_[0]->close }
338 # for graceful shutdown in PublicInbox::Daemon:
341 ($self->{rbuf} ne '' || $self->{env} || $self->{write_buf_size});