X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FNNTP.pm;h=d6f315bab42a9ed7e0b8b607a3ba6cf01066ef55;hb=77c66b4cdb1d52321ed3cb6352fe0b72312cbb71;hp=53de2bca2495c7b49b4369dbc1a94ebae7fa41fc;hpb=595854982a59f369ab605794f05c046c86253468;p=public-inbox.git diff --git a/lib/PublicInbox/NNTP.pm b/lib/PublicInbox/NNTP.pm index 53de2bca..d6f315ba 100644 --- a/lib/PublicInbox/NNTP.pm +++ b/lib/PublicInbox/NNTP.pm @@ -6,7 +6,7 @@ package PublicInbox::NNTP; use strict; use warnings; use base qw(PublicInbox::DS); -use fields qw(nntpd article rbuf ng long_res); +use fields qw(nntpd article ng); use PublicInbox::Search; use PublicInbox::Msgmap; use PublicInbox::MID qw(mid_escape); @@ -14,54 +14,38 @@ use PublicInbox::Git; require PublicInbox::EvCleanup; use Email::Simple; use POSIX qw(strftime); -PublicInbox::DS->import(qw(now msg_more)); +PublicInbox::DS->import(qw(now)); use Digest::SHA qw(sha1_hex); use Time::Local qw(timegm timelocal); use constant { + LINE_MAX => 512, # RFC 977 section 2.3 r501 => '501 command syntax error', + r502 => '502 Command unavailable', r221 => '221 Header follows', r224 => '224 Overview information follows (multi-line)', r225 => '225 Headers follow (multi-line)', r430 => '430 No article with that message-id', }; -use PublicInbox::Syscall qw(EPOLLOUT EPOLLONESHOT); +use PublicInbox::Syscall qw(EPOLLIN EPOLLONESHOT); use Errno qw(EAGAIN); my @OVERVIEW = qw(Subject From Date Message-ID References Xref); my $OVERVIEW_FMT = join(":\r\n", @OVERVIEW, qw(Bytes Lines)) . ":\r\n"; my $LIST_HEADERS = join("\r\n", @OVERVIEW, qw(:bytes :lines Xref To Cc)) . "\r\n"; - -# disable commands with easy DoS potential: -my %DISABLED; # = map { $_ => 1 } qw(xover list_overview_fmt newnews xhdr); - +my $CAPABILITIES = <<""; +101 Capability list:\r +VERSION 2\r +READER\r +NEWNEWS\r +LIST ACTIVE ACTIVE.TIMES NEWSGROUPS OVERVIEW.FMT\r +HDR\r +OVER\r + +my $have_deflate; my $EXPMAP; # fd -> [ idle_time, $self ] my $expt; our $EXPTIME = 180; # 3 minutes -my $nextt; - -my $nextq = []; -sub next_tick () { - $nextt = undef; - my $q = $nextq; - $nextq = []; - foreach my $nntp (@$q) { - # for request && response protocols, always finish writing - # before finishing reading: - if (my $long_cb = $nntp->{long_res}) { - $nntp->write($long_cb); - } else { - # pipelined request, we bypassed socket-readiness - # checks to get here: - event_step($nntp); - } - } -} - -sub requeue ($) { - push @$nextq, $_[0]; - $nextt ||= PublicInbox::EvCleanup::asap(*next_tick); -} sub update_idle_time ($) { my ($self) = @_; @@ -74,14 +58,11 @@ sub expire_old () { my $exp = $EXPTIME; my $old = $now - $exp; my $nr = 0; - my $closed = 0; my %new; while (my ($fd, $v) = each %$EXPMAP) { my ($idle_time, $nntp) = @$v; if ($idle_time < $old) { - if ($nntp->shutdn) { - $closed++; - } else { + if (!$nntp->shutdn) { ++$nr; $new{$fd} = $v; } @@ -91,33 +72,28 @@ sub expire_old () { } } $EXPMAP = \%new; - if ($nr) { - $expt = PublicInbox::EvCleanup::later(*expire_old); - } else { - $expt = undef; - # noop to kick outselves out of the loop ASAP so descriptors - # really get closed - PublicInbox::EvCleanup::asap(sub {}) if $closed; - } + $expt = PublicInbox::EvCleanup::later(*expire_old) if $nr; } +sub greet ($) { $_[0]->write($_[0]->{nntpd}->{greet}) }; + sub new ($$$) { my ($class, $sock, $nntpd) = @_; my $self = fields::new($class); - my $ev = EPOLLOUT | EPOLLONESHOT; - my $wbuf = []; + my $ev = EPOLLIN; + my $wbuf; if (ref($sock) eq 'IO::Socket::SSL' && !$sock->accept_SSL) { - $ev = PublicInbox::TLS::epollbit() or return CORE::close($sock); - $ev |= EPOLLONESHOT; - $wbuf->[0] = \&PublicInbox::DS::accept_tls_step; + return CORE::close($sock) if $! != EAGAIN; + $ev = PublicInbox::TLS::epollbit(); + $wbuf = [ \&PublicInbox::DS::accept_tls_step, \&greet ]; } - $self->SUPER::new($sock, $ev); + $self->SUPER::new($sock, $ev | EPOLLONESHOT); $self->{nntpd} = $nntpd; - my $greet = "201 $nntpd->{servername} ready - post via email\r\n"; - open my $fh, '<:scalar', \$greet or die "open :scalar: $!"; - push @$wbuf, $fh; - $self->{wbuf} = $wbuf; - $self->{rbuf} = ''; + if ($wbuf) { + $self->{wbuf} = $wbuf; + } else { + greet($self); + } update_idle_time($self); $expt ||= PublicInbox::EvCleanup::later(*expire_old); $self; @@ -137,10 +113,9 @@ sub process_line ($$) { my ($self, $l) = @_; my ($req, @args) = split(/[ \t]/, $l); return 1 unless defined($req); # skip blank line - $req = lc($req); $req = eval { no strict 'refs'; - $req = $DISABLED{$req} ? undef : *{'cmd_'.$req}{CODE}; + *{'cmd_'.lc($req)}{CODE}; }; return res($self, '500 command not recognized') unless $req; return res($self, r501) unless args_ok($req, scalar @args); @@ -157,6 +132,17 @@ sub process_line ($$) { res($self, $res); } +# The keyword argument is not used (rfc3977 5.2.2) +sub cmd_capabilities ($;$) { + my ($self, undef) = @_; + my $res = $CAPABILITIES; + if (ref($self->{sock}) ne 'IO::Socket::SSL' && + $self->{nntpd}->{accept_tls}) { + $res .= "STARTTLS\r\n"; + } + $res .= '.'; +} + sub cmd_mode ($$) { my ($self, $arg) = @_; $arg = uc $arg; @@ -175,12 +161,12 @@ sub cmd_xgtitle ($;$) { sub list_overview_fmt ($) { my ($self) = @_; - msg_more($self, $OVERVIEW_FMT); + $self->msg_more($OVERVIEW_FMT); } sub list_headers ($;$) { my ($self) = @_; - msg_more($self, $LIST_HEADERS); + $self->msg_more($LIST_HEADERS); } sub list_active ($;$) { @@ -219,7 +205,6 @@ sub cmd_list ($;$$) { my $arg = shift @args; $arg =~ tr/A-Z./a-z_/; $arg = "list_$arg"; - return r501 if $DISABLED{$arg}; $arg = eval { no strict 'refs'; @@ -519,24 +504,23 @@ find_mid: found: my $smsg = $ng->over->get_art($n) or return $err; my $msg = $ng->msg_by_smsg($smsg) or return $err; - my $s = Email::Simple->new($msg); - if ($set_headers) { - set_nntp_headers($self, $s->header_obj, $ng, $n, $mid); - # must be last - $s->body_set('') if ($set_headers == 2); - } - [ $n, $mid, $s, $smsg->bytes, $smsg->lines, $ng ]; + # Email::Simple->new will modify $msg in-place as documented + # in its manpage, so what's left is the body and we won't need + # to call Email::Simple::body(), later + my $hdr = Email::Simple->new($msg)->header_obj; + set_nntp_headers($self, $hdr, $ng, $n, $mid) if $set_headers; + [ $n, $mid, $msg, $hdr ]; } -sub simple_body_write ($$) { - my ($self, $s) = @_; - my $body = $s->body; - $s->body_set(''); - $body =~ s/^\./../smg; - $body =~ s/(?msg_more($$msg); '.' } @@ -545,40 +529,40 @@ sub set_art { $self->{article} = $art if defined $art && $art =~ /\A[0-9]+\z/; } -sub _header ($) { - my $hdr = $_[0]->header_obj->as_string; +sub msg_hdr_write ($$$) { + my ($self, $hdr, $body_follows) = @_; + $hdr = $hdr->as_string; utf8::encode($hdr); - $hdr =~ s/(?msg_more($hdr); } sub cmd_article ($;$) { my ($self, $art) = @_; my $r = art_lookup($self, $art, 1); return $r unless ref $r; - my ($n, $mid, $s) = @$r; + my ($n, $mid, $msg, $hdr) = @$r; set_art($self, $art); more($self, "220 $n <$mid> article retrieved - head and body follow"); - msg_more($self, _header($s)); - msg_more($self, "\r\n"); - simple_body_write($self, $s); + msg_hdr_write($self, $hdr, 1); + msg_body_write($self, $msg); } sub cmd_head ($;$) { my ($self, $art) = @_; my $r = art_lookup($self, $art, 2); return $r unless ref $r; - my ($n, $mid, $s) = @$r; + my ($n, $mid, undef, $hdr) = @$r; set_art($self, $art); more($self, "221 $n <$mid> article retrieved - head follows"); - msg_more($self, _header($s)); + msg_hdr_write($self, $hdr, 0); '.' } @@ -586,17 +570,17 @@ sub cmd_body ($;$) { my ($self, $art) = @_; my $r = art_lookup($self, $art, 0); return $r unless ref $r; - my ($n, $mid, $s) = @$r; + my ($n, $mid, $msg) = @$r; set_art($self, $art); more($self, "222 $n <$mid> article retrieved - body follows"); - simple_body_write($self, $s); + msg_body_write($self, $msg); } sub cmd_stat ($;$) { my ($self, $art) = @_; my $r = art_lookup($self, $art, 0); return $r unless ref $r; - my ($n, $mid, undef) = @$r; + my ($n, $mid) = @$r; set_art($self, $art); "223 $n <$mid> article retrieved - request text separately"; } @@ -633,8 +617,7 @@ sub get_range ($$) { } sub long_response ($$) { - my ($self, $cb) = @_; - die "BUG: nested long response" if $self->{long_res}; + my ($self, $cb) = @_; # cb returns true if more, false if done my $fd = fileno($self->{sock}); defined $fd or return; @@ -642,36 +625,38 @@ sub long_response ($$) { # clients should not be sending us stuff and making us do more # work while we are stream a response to them my $t0 = now(); - $self->{long_res} = sub { + my $long_cb; # DANGER: self-referential + $long_cb = sub { + # wbuf is unset or empty, here; $cb may add to it my $more = eval { $cb->() }; if ($@ || !$self->{sock}) { # something bad happened... - delete $self->{long_res}; - + $long_cb = undef; + my $diff = now() - $t0; if ($@) { err($self, "%s during long response[$fd] - %0.6f", - $@, now() - $t0); - } - if ($self->{sock}) { - update_idle_time($self); - requeue($self); - } else { - out($self, " deferred[$fd] aborted - %0.6f", - now() - $t0); + $@, $diff); } + out($self, " deferred[$fd] aborted - %0.6f", $diff); + $self->close; } elsif ($more) { # $self->{wbuf}: + update_idle_time($self); + # no recursion, schedule another call ASAP # but only after all pending writes are done - update_idle_time($self); - requeue($self); + my $wbuf = $self->{wbuf} ||= []; + push @$wbuf, $long_cb; + + # wbuf may be populated by $cb, no need to rearm if so: + $self->requeue if scalar(@$wbuf) == 1; } else { # all done! - delete $self->{long_res}; + $long_cb = undef; res($self, '.'); out($self, " deferred[$fd] done - %0.6f", now() - $t0); - requeue($self); + $self->requeue unless $self->{wbuf}; } }; - $self->{long_res}->(); # kick off! + $self->write($long_cb); # kick off! undef; } @@ -775,7 +760,7 @@ sub hdr_searchmsg ($$$$) { $tmp .= $s->{num} . ' ' . $s->$field . "\r\n"; } utf8::encode($tmp); - msg_more($self, $tmp); + $self->msg_more($tmp); $cur = $msgs->[-1]->{num} + 1; }); } @@ -823,7 +808,7 @@ sub hdr_mid_prefix ($$$$$) { } sub hdr_mid_response ($$$$$$) { - my ($self, $xhdr, $ng, $n, $mid, $v) = @_; # r: art_lookup result + my ($self, $xhdr, $ng, $n, $mid, $v) = @_; my $res = ''; if ($xhdr) { $res .= r221 . "\r\n"; @@ -914,19 +899,32 @@ sub cmd_xover ($;$) { }); } +sub compressed { undef } + sub cmd_starttls ($) { my ($self) = @_; my $sock = $self->{sock} or return; # RFC 4642 2.2.1 - (ref($sock) eq 'IO::Socket::SSL') and return '502 Command unavailable'; + return r502 if (ref($sock) eq 'IO::Socket::SSL' || $self->compressed); my $opt = $self->{nntpd}->{accept_tls} or return '580 can not initiate TLS negotiation'; res($self, '382 Continue with TLS negotiation'); $self->{sock} = IO::Socket::SSL->start_SSL($sock, %$opt); - requeue($self) if PublicInbox::DS::accept_tls_step($self); + $self->requeue if PublicInbox::DS::accept_tls_step($self); undef; } +# RFC 8054 +sub cmd_compress ($$) { + my ($self, $alg) = @_; + return '503 Only the DEFLATE is supported' if uc($alg) ne 'DEFLATE'; + return r502 if $self->compressed || !$have_deflate; + res($self, '206 Compression active'); + PublicInbox::NNTPdeflate->enable($self); + $self->requeue; + undef +} + sub cmd_xpath ($$) { my ($self, $mid) = @_; return r501 unless $mid =~ /\A<(.+)>\z/; @@ -942,7 +940,7 @@ sub cmd_xpath ($$) { sub res ($$) { do_write($_[0], $_[1] . "\r\n") } -sub more ($$) { msg_more($_[0], $_[1] . "\r\n") } +sub more ($$) { $_[0]->msg_more($_[1] . "\r\n") } sub do_write ($$) { my $self = $_[0]; @@ -972,8 +970,7 @@ sub event_step { # only read more requests if we've drained the write buffer, # otherwise we can be buffering infinitely w/o backpressure - use constant LINE_MAX => 512; # RFC 977 section 2.3 - my $rbuf = \($self->{rbuf}); + my $rbuf = $self->{rbuf} // (\(my $x = '')); my $r = 1; if (index($$rbuf, "\n") < 0) { @@ -986,19 +983,19 @@ sub event_step { my $t0 = now(); my $fd = fileno($self->{sock}); $r = eval { process_line($self, $line) }; - my $d = $self->{long_res} ? - " deferred[$fd]" : ''; - out($self, "[$fd] %s - %0.6f$d", $line, now() - $t0); + my $pending = $self->{wbuf} ? ' pending' : ''; + out($self, "[$fd] %s - %0.6f$pending", $line, now() - $t0); } return $self->close if $r < 0; my $len = bytes::length($$rbuf); return $self->close if ($len >= LINE_MAX); + $self->rbuf_idle($rbuf); update_idle_time($self); # maybe there's more pipelined data, or we'll have # to register it for socket-readiness notifications - requeue($self) unless ($self->{long_res} || $self->{wbuf}); + $self->requeue unless $self->{wbuf}; } sub not_idle_long ($$) { @@ -1012,8 +1009,13 @@ sub not_idle_long ($$) { # for graceful shutdown in PublicInbox::Daemon: sub busy { my ($self, $now) = @_; - ($self->{rbuf} ne '' || $self->{long_res} || - $self->{wbuf} || not_idle_long($self, $now)); + ($self->{rbuf} || $self->{wbuf} || not_idle_long($self, $now)); +} + +# this is an import to prevent "perl -c" from complaining about fields +sub import { + $have_deflate = eval { require PublicInbox::NNTPdeflate } and + $CAPABILITIES .= "COMPRESS DEFLATE\r\n"; } 1;