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);
21 CHUNK_START => -1, # [a-f0-9]+\r\n
22 CHUNK_END => -2, # \r\n
23 CHUNK_ZEND => -3, # \r\n
27 my $null_io = IO::File->new('/dev/null', '<');
32 $now == $prev ? $http_date : ($http_date = time2str($prev = $now));
36 my ($class, $sock, $addr, $httpd) = @_;
37 my $self = fields::new($class);
38 $self->SUPER::new($sock);
39 $self->{httpd} = $httpd;
45 sub event_read { # called by Danga::Socket
48 return event_read_input($self) if defined $self->{env};
50 my $off = length($self->{rbuf});
51 my $r = sysread($self->{sock}, $self->{rbuf}, 8192, $off);
53 return $self->close if $r == 0;
54 return rbuf_process($self);
56 return if $!{EAGAIN}; # no need to call watch_read(1) again
58 # common for clients to break connections without warning,
59 # would be too noisy to log here:
66 my %env = %{$self->{httpd}->{env}}; # full hash copy
67 my $r = parse_http_request($self->{rbuf}, \%env);
69 # We do not support Trailers in chunked requests, for now
70 # (they are rarely-used and git (as of 2.7.2) does not use them)
71 return quit($self, 400) if $r == -1 || $env{HTTP_TRAILER};
72 return $self->watch_read(1) if $r < 0; # incomplete
73 $self->{rbuf} = substr($self->{rbuf}, $r);
75 my $len = input_prepare($self, \%env);
76 defined $len or return write_err($self); # EMFILE/ENFILE
78 $len ? event_read_input($self) : app_dispatch($self);
81 sub event_read_input ($) {
83 my $env = $self->{env};
84 return event_read_input_chunked($self) if env_chunked($env);
86 # env->{CONTENT_LENGTH} (identity)
87 my $sock = $self->{sock};
88 my $len = $self->{input_left};
89 $self->{input_left} = undef;
90 my $rbuf = \($self->{rbuf});
91 my $input = $env->{'psgi.input'};
95 my $w = write_in_full($input, $rbuf, $len);
96 return write_err($self) unless $w;
98 die "BUG: $len < 0 (w=$w)" if $len < 0;
99 if ($len == 0) { # next request may be pipelined
100 $$rbuf = substr($$rbuf, $w);
105 my $r = sysread($sock, $$rbuf, 8192);
106 return recv_err($self, $r, $len) unless $r;
107 # continue looping if $r > 0;
112 sub app_dispatch ($) {
114 $self->watch_read(0);
115 my $env = $self->{env};
116 $env->{REMOTE_ADDR} = $self->peer_ip_string; # Danga::Socket
117 $env->{REMOTE_PORT} = $self->{peer_port}; # set by peer_ip_string
118 if (my $host = $env->{HTTP_HOST}) {
119 $host =~ s/:(\d+)\z// and $env->{SERVER_PORT} = $1;
120 $env->{SERVER_NAME} = $host;
123 sysseek($env->{'psgi.input'}, 0, SEEK_SET) or
124 die "BUG: psgi.input seek failed: $!";
126 my $res = Plack::Util::run_app($self->{httpd}->{app}, $env);
128 if (ref($res) eq 'CODE') {
129 $res->(sub { response_write($self, $env, $_[0]) });
131 response_write($self, $env, $res);
137 sub response_header_write {
138 my ($self, $env, $res) = @_;
139 my $proto = $env->{SERVER_PROTOCOL} or return; # HTTP/0.9 :P
140 my $status = $res->[0];
141 my $h = "$proto $status " . status_message($status) . "\r\n";
143 my $headers = $res->[1];
145 for (my $i = 0; $i < @$headers; $i += 2) {
146 my $k = $headers->[$i];
147 my $v = $headers->[$i + 1];
148 next if $k =~ /\A(?:Connection|Date)\z/i;
150 $len = $v if $k =~ /\AContent-Length\z/i;
151 if ($k =~ /\ATransfer-Encoding\z/i && $v =~ /\bchunked\b/i) {
158 my $conn = $env->{HTTP_CONNECTION} || '';
159 my $alive = (defined($len) || $chunked) &&
160 ($proto eq 'HTTP/1.1' && $conn !~ /\bclose\b/i) ||
161 ($conn =~ /\bkeep-alive\b/i);
163 $h .= 'Connection: ' . ($alive ? 'keep-alive' : 'close');
164 $h .= "\r\nDate: " . http_date() . "\r\n\r\n";
166 if (($len || $chunked) && $env->{REQUEST_METHOD} ne 'HEAD') {
175 my ($self, $env, $res) = @_;
176 my ($alive, $chunked) = response_header_write($self, $env, $res);
177 my $write = sub { $self->write($_[0]) };
180 $self->event_write; # watch for readability if done
182 $self->write(sub { $self->close });
184 $self->{env} = undef;
187 if (defined $res->[2]) {
188 Plack::Util::foreach($res->[2], $write);
191 # this is returned to the calling application:
192 Plack::Util::inline_object(write => $write, close => $close);
196 use constant MSG_MORE => ($^O eq 'linux') ? 0x8000 : 0;
199 if (MSG_MORE && !$self->{write_buf_size}) {
200 my $n = send($self->{sock}, $_[1], MSG_MORE);
202 my $dlen = length($_[1]);
203 return 1 if $n == $dlen; # all done!
204 $_[1] = substr($_[1], $n, $dlen - $n);
205 # fall through to normal write:
211 # overrides existing Danga::Socket method
214 # only continue watching for readability when we are done writing:
215 return if $self->write(undef) != 1;
217 if ($self->{rbuf} eq '') { # wait for next request
218 $self->watch_read(1);
219 } else { # avoid recursion for pipelined requests
220 Danga::Socket->AddTimer(0, sub { rbuf_process($self) });
225 my ($self, $env) = @_;
226 my $input = $null_io;
227 my $len = $env->{CONTENT_LENGTH};
229 $input = IO::File->new_tmpfile;
230 } elsif (env_chunked($env)) {
232 $input = IO::File->new_tmpfile;
235 # TODO: expire idle clients on ENFILE / EMFILE
236 return unless $input;
239 $env->{'psgi.input'} = $input;
241 $self->{input_left} = $len || 0;
244 sub env_chunked { ($_[0]->{HTTP_TRANSFER_ENCODING} || '') =~ /\bchunked\b/i }
248 my $err = $self->{env}->{'psgi.errors'};
249 my $msg = $! || '(zero write)';
250 $err->print("error buffering to input: $msg\n");
255 my ($self, $r, $len) = @_;
256 return $self->close if (defined $r && $r == 0);
258 $self->{input_left} = $len;
261 my $err = $self->{env}->{'psgi.errors'};
262 $err->print("error reading for input: $! ($len bytes remaining)\n");
267 my ($fh, $rbuf, $len) = @_;
271 my $w = syswrite($fh, $$rbuf, $len, $off);
272 return ($rv ? $rv : $w) unless $w; # undef or 0
280 sub event_read_input_chunked { # unlikely...
282 my $input = $self->{env}->{'psgi.input'};
283 my $sock = $self->{sock};
284 my $len = $self->{input_left};
285 $self->{input_left} = undef;
286 my $rbuf = \($self->{rbuf});
288 while (1) { # chunk start
289 if ($len == CHUNK_ZEND) {
290 return app_dispatch($self) if $$rbuf =~ s/\A\r\n//s;
291 return quit($self, 400) if length($$rbuf) > 2;
293 if ($len == CHUNK_END) {
294 if ($$rbuf =~ s/\A\r\n//s) {
296 } elsif (length($$rbuf) > 2) {
297 return quit($self, 400);
300 if ($len == CHUNK_START) {
301 if ($$rbuf =~ s/\A([a-f0-9]+).*?\r\n//i) {
303 } elsif (length($$rbuf) > CHUNK_MAX_HDR) {
304 return quit($self, 400);
306 # will break from loop since $len >= 0
309 if ($len < 0) { # chunk header is trickled, read more
310 my $off = length($$rbuf);
311 my $r = sysread($sock, $$rbuf, 8192, $off);
312 return recv_err($self, $r, $len) unless $r;
313 # (implicit) goto chunk_start if $r > 0;
315 $len = CHUNK_ZEND if $len == 0;
317 # drain the current chunk
320 my $w = write_in_full($input, $rbuf, $len);
321 return write_err($self) unless $w;
324 # we may have leftover data to parse
326 $$rbuf = substr($$rbuf, $w);
329 die "BUG: len < 0: $len";
335 # read more of current chunk
336 my $r = sysread($sock, $$rbuf, 8192);
337 return recv_err($self, $r, $len) unless $r;
344 my ($self, $status) = @_;
345 my $h = "HTTP/1.1 $status " . status_message($status) . "\r\n\r\n";
350 # callbacks for Danga::Socket
352 sub event_hup { $_[0]->close }
353 sub event_err { $_[0]->close }
355 # for graceful shutdown in PublicInbox::Daemon:
358 ($self->{rbuf} ne '' || $self->{env} || $self->{write_buf_size});