X-Git-Url: http://www.git.stargrave.org/?p=public-inbox.git;a=blobdiff_plain;f=lib%2FPublicInbox%2FNNTP.pm;h=5eb6112ceb2f932286bd263a11795b4c163590b1;hp=1f9058ca2b886604a99c923200bc36b974fa23b6;hb=1c3e60b66e01df89afdf74990a849a5a7386f9c7;hpb=0b3d2b151965aad70ca90f642edf0059c29e6855 diff --git a/lib/PublicInbox/NNTP.pm b/lib/PublicInbox/NNTP.pm index 1f9058ca..5eb6112c 100644 --- a/lib/PublicInbox/NNTP.pm +++ b/lib/PublicInbox/NNTP.pm @@ -22,21 +22,19 @@ use PublicInbox::Address; use constant { LINE_MAX => 512, # RFC 977 section 2.3 - r501 => '501 command syntax error', - r502 => '502 Command unavailable', + r501 => "501 command syntax error\r\n", + r502 => "502 Command unavailable\r\n", r221 => "221 Header follows\r\n", - r224 => '224 Overview information follows (multi-line)', r225 => "225 Headers follow (multi-line)\r\n", - r430 => '430 No article with that message-id', + r430 => "430 No article with that message-id\r\n", }; -use PublicInbox::Syscall qw(EPOLLIN EPOLLONESHOT); use Errno qw(EAGAIN); my $ONE_MSGID = qr/\A$MID_EXTRACT\z/; my @OVERVIEW = qw(Subject From Date Message-ID References); my $OVERVIEW_FMT = join(":\r\n", @OVERVIEW, qw(Bytes Lines), '') . - "Xref:full\r\n."; + "Xref:full\r\n.\r\n"; my $LIST_HEADERS = join("\r\n", @OVERVIEW, - qw(:bytes :lines Xref To Cc)) . "\r\n."; + qw(:bytes :lines Xref To Cc)) . "\r\n.\r\n"; my $CAPABILITIES = <<""; 101 Capability list:\r VERSION 2\r @@ -47,25 +45,11 @@ HDR\r OVER\r COMPRESS DEFLATE\r -sub greet ($) { $_[0]->write($_[0]->{nntpd}->{greet}) }; - -sub new ($$$) { - my ($class, $sock, $nntpd) = @_; - my $self = bless { nntpd => $nntpd }, $class; - my $ev = EPOLLIN; - my $wbuf; - if ($sock->can('accept_SSL') && !$sock->accept_SSL) { - return CORE::close($sock) if $! != EAGAIN; - $ev = PublicInbox::TLS::epollbit() or return CORE::close($sock); - $wbuf = [ \&PublicInbox::DS::accept_tls_step, \&greet ]; - } - $self->SUPER::new($sock, $ev | EPOLLONESHOT); - if ($wbuf) { - $self->{wbuf} = $wbuf; - } else { - greet($self); - } - $self; +sub do_greet ($) { $_[0]->write($_[0]->{nntpd}->{greet}) }; + +sub new { + my ($cls, $sock, $nntpd) = @_; + (bless { nntpd => $nntpd }, $cls)->greet($sock) } sub args_ok ($$) { @@ -84,17 +68,16 @@ sub process_line ($$) { return 1 unless defined($req); # skip blank line $req = $self->can('cmd_'.lc($req)) // return $self->write(\"500 command not recognized\r\n"); - return res($self, r501) unless args_ok($req, scalar @args); - + return $self->write(\r501) unless args_ok($req, scalar @args); my $res = eval { $req->($self, @args) }; my $err = $@; if ($err && $self->{sock}) { local $/ = "\n"; chomp($l); err($self, 'error from: %s (%s)', $l, $err); - $res = '503 program fault - command not performed'; + $res = \"503 program fault - command not performed\r\n"; } - defined($res) ? res($self, $res) : 0; + defined($res) ? $self->write($res) : 0; } # The keyword argument is not used (rfc3977 5.2.2) @@ -105,19 +88,19 @@ sub cmd_capabilities ($;$) { $self->{nntpd}->{accept_tls}) { $res .= "STARTTLS\r\n"; } - $res .= '.'; + $res .= ".\r\n"; } sub cmd_mode ($$) { my ($self, $arg) = @_; - uc($arg) eq 'READER' ? '201 Posting prohibited' : r501; + uc($arg) eq 'READER' ? \"201 Posting prohibited\r\n" : \r501; } -sub cmd_slave ($) { '202 slave status noted' } +sub cmd_slave ($) { \"202 slave status noted\r\n" } sub cmd_xgtitle ($;$) { my ($self, $wildmat) = @_; - more($self, '282 list of groups and descriptions follows'); + $self->msg_more("282 list of groups and descriptions follows\r\n"); list_newsgroups($self, $wildmat); } @@ -150,7 +133,7 @@ sub list_active_times_i { for my $ngname (@window) { my $ibx = $groups->{$ngname} or next; my $c = eval { $ibx->uidvalidity } // time; - more($self, "$ngname $c <$ibx->{-primary_address}>"); + $self->msg_more("$ngname $c <$ibx->{-primary_address}>\r\n"); } scalar(@$groupnames); # continue if there's more } @@ -169,7 +152,7 @@ sub list_newsgroups_i { my $ibx; for my $ngname (@window) { $ibx = $groups->{$ngname} and - more($self, "$ngname ".$ibx->description); + $self->msg_more("$ngname ".$ibx->description."\r\n"); } scalar(@$groupnames); # continue if there's more } @@ -191,10 +174,10 @@ sub cmd_list ($;$$) { $arg = "list_$arg"; $arg = $self->can($arg); return r501 unless $arg && args_ok($arg, scalar @args); - more($self, '215 information follows'); + $self->msg_more("215 information follows\r\n"); $arg->($self, @args); } else { - more($self, '215 list of newsgroups follows'); + $self->msg_more("215 list of newsgroups follows\r\n"); long_response($self, \&list_active_i, [ # copy array @{$self->{nntpd}->{groupnames}} ]); } @@ -204,7 +187,7 @@ sub listgroup_range_i { my ($self, $beg, $end) = @_; my $r = $self->{ibx}->mm(1)->msg_range($beg, $end, 'num'); scalar(@$r) or return; - $self->msg_more(join('', map { "$_->[0]\r\n" } @$r)); + $self->msg_more(join("\r\n", @$r, '')); 1; } @@ -212,7 +195,7 @@ sub listgroup_all_i { my ($self, $num) = @_; my $ary = $self->{ibx}->over(1)->ids_after($num); scalar(@$ary) or return; - more($self, join("\r\n", @$ary)); + $self->msg_more(join("\r\n", @$ary, '')); 1; } @@ -220,10 +203,10 @@ sub cmd_listgroup ($;$$) { my ($self, $group, $range) = @_; if (defined $group) { my $res = cmd_group($self, $group); - return $res if ($res !~ /\A211 /); - more($self, $res); + return $res if ref($res); # error if const strref + $self->msg_more($res); } - $self->{ibx} or return '412 no newsgroup selected'; + $self->{ibx} or return \"412 no newsgroup selected\r\n"; if (defined $range) { my $r = get_range($self, $range); return $r unless ref $r; @@ -262,7 +245,7 @@ sub parse_time ($$;$) { sub group_line ($$) { my ($self, $ibx) = @_; my ($min, $max) = $ibx->mm(1)->minmax; - more($self, "$ibx->{newsgroup} $max $min n"); + $self->msg_more("$ibx->{newsgroup} $max $min n\r\n"); } sub newgroups_i { @@ -284,7 +267,7 @@ sub cmd_newgroups ($$$;$$) { return r501 if $@; # TODO dists - more($self, '231 list of new newsgroups follows'); + $self->msg_more("231 list of new newsgroups follows\r\n"); long_response($self, \&newgroups_i, $ts, \(my $i = 0), $self->{nntpd}->{groupnames}); } @@ -348,13 +331,13 @@ sub cmd_newnews ($$$$;$$) { my ($self, $newsgroups, $date, $time, $gmt, $dists) = @_; my $ts = eval { parse_time($date, $time, $gmt) }; return r501 if $@; - more($self, '230 list of new articles by message-id follows'); + $self->msg_more("230 list of new articles by message-id follows\r\n"); my ($keep, $skip) = split(/!/, $newsgroups, 2); ngpat2re($keep); ngpat2re($skip); my @names = grep(!/$skip/, grep(/$keep/, @{$self->{nntpd}->{groupnames}})); - return '.' unless scalar(@names); + return ".\r\n" unless scalar(@names); my $prev = 0; long_response($self, \&newnews_i, \@names, $ts, \$prev); } @@ -363,30 +346,29 @@ sub cmd_group ($$) { my ($self, $group) = @_; my $nntpd = $self->{nntpd}; my $ibx = $nntpd->{pi_cfg}->{-by_newsgroup}->{$group} or - return '411 no such news group'; + return \"411 no such news group\r\n"; $nntpd->idler_start; $self->{ibx} = $ibx; my ($min, $max) = $ibx->mm(1)->minmax; $self->{article} = $min; my $est_size = $max - $min; - "211 $est_size $min $max $group"; + "211 $est_size $min $max $group\r\n"; } sub article_adj ($$) { my ($self, $off) = @_; - my $ibx = $self->{ibx} or return '412 no newsgroup selected'; - - my $n = $self->{article}; - defined $n or return '420 no current article has been selected'; + my $ibx = $self->{ibx} // return \"412 no newsgroup selected\r\n"; + my $n = $self->{article} // + return \"420 no current article has been selected\r\n"; $n += $off; my $mid = $ibx->mm(1)->mid_for($n) // do { $n = $off > 0 ? 'next' : 'previous'; - return "421 no $n article in this group"; + return "421 no $n article in this group\r\n"; }; $self->{article} = $n; - "223 $n <$mid> article retrieved - request text separately"; + "223 $n <$mid> article retrieved - request text separately\r\n"; } sub cmd_next ($) { article_adj($_[0], 1) } @@ -397,8 +379,8 @@ sub cmd_last ($) { article_adj($_[0], -1) } sub cmd_post ($) { my ($self) = @_; my $ibx = $self->{ibx}; - $ibx ? "440 mailto:$ibx->{-primary_address} to post" - : '440 posting not allowed' + $ibx ? "440 mailto:$ibx->{-primary_address} to post\r\n" + : \"440 posting not allowed\r\n" } sub cmd_quit ($) { @@ -486,22 +468,22 @@ sub art_lookup ($$$) { my $err; if (defined $art) { if ($art =~ /\A[0-9]+\z/) { - $err = '423 no such article number in this group'; + $err = \"423 no such article number in this group\r\n"; $n = int($art); goto find_ibx; } elsif ($art =~ $ONE_MSGID) { ($ibx, $n) = mid_lookup($self, $1); goto found if $ibx; - return r430; + return \r430; } else { - return r501; + return \r501; } } else { - $err = '420 no current article has been selected'; + $err = \"420 no current article has been selected\r\n"; $n = $self->{article} // return $err; find_ibx: $ibx = $self->{ibx} or - return '412 no newsgroup has been selected'; + return \"412 no newsgroup has been selected\r\n"; } found: my $smsg = $ibx->over(1)->get_art($n) or return $err; @@ -509,7 +491,7 @@ found: if ($code == 223) { # STAT set_art($self, $n); "223 $n <$smsg->{mid}> article retrieved - " . - "request text separately"; + "request text separately\r\n"; } else { # HEAD | BODY | ARTICLE $smsg->{nntp} = $self; $smsg->{nntp_code} = $code; @@ -565,15 +547,15 @@ sub blob_cb { # called by git->cat_async via ibx_async_cat my $r = "$code $smsg->{num} <$smsg->{mid}> article retrieved - "; my $eml = PublicInbox::Eml->new($bref); if ($code == 220) { - more($self, $r .= 'head and body follow'); + $self->msg_more($r .= "head and body follow\r\n"); msg_hdr_write($eml, $smsg); $self->msg_more("\r\n"); msg_body_write($self, $bref); } elsif ($code == 221) { - more($self, $r .= 'head follows'); + $self->msg_more($r .= "head follows\r\n"); msg_hdr_write($eml, $smsg); } elsif ($code == 222) { - more($self, $r .= 'body follows'); + $self->msg_more($r .= "body follows\r\n"); msg_body_write($self, $bref); } else { $self->close; @@ -603,20 +585,18 @@ sub cmd_stat ($;$) { art_lookup($self, $art, 223); # art may be msgid } -sub cmd_ihave ($) { '435 article not wanted - do not send it' } +sub cmd_ihave ($) { \"435 article not wanted - do not send it\r\n" } -sub cmd_date ($) { '111 '.strftime('%Y%m%d%H%M%S', gmtime(time)) } +sub cmd_date ($) { '111 '.strftime('%Y%m%d%H%M%S', gmtime(time))."\r\n" } -sub cmd_help ($) { - my ($self) = @_; - more($self, '100 help text follows'); - '.' -} +sub cmd_help ($) { \"100 help text follows\r\n.\r\n" } +# returns a ref on success sub get_range ($$) { my ($self, $range) = @_; - my $ibx = $self->{ibx} or return '412 no news group has been selected'; - defined $range or return '420 No article(s) selected'; + my $ibx = $self->{ibx} // + return "412 no news group has been selected\r\n"; + $range // return "420 No article(s) selected\r\n"; my ($beg, $end); my ($min, $max) = $ibx->mm(1)->minmax; if ($range =~ /\A([0-9]+)\z/) { @@ -630,8 +610,7 @@ sub get_range ($$) { } $beg = $min if ($beg < $min); $end = $max if ($end > $max); - return '420 No article(s) selected' if ($beg > $end); - [ \$beg, $end ]; + $beg > $end ? "420 No article(s) selected\r\n" : [ \$beg, $end ]; } sub long_step { @@ -650,20 +629,11 @@ sub long_step { out($self, " deferred[$fd] aborted - %0.6f", $elapsed); $self->close; } elsif ($more) { # $self->{wbuf}: - # COMPRESS users all share the same DEFLATE context. - # Flush it here to ensure clients don't see - # each other's data - $self->zflush; - - # no recursion, schedule another call ASAP, but only after - # all pending writes are done. autovivify wbuf: - my $new_size = push(@{$self->{wbuf}}, \&long_step); - - # wbuf may be populated by $cb, no need to rearm if so: - $self->requeue if $new_size == 1; + # control passed to ibx_async_cat if $more == \undef + $self->requeue_once if !ref($more); } else { # all done! delete $self->{long_cb}; - $self->write(\".\r\n"); + $self->write(\".\r\n"); # TODO get rid of this my $elapsed = now() - $t0; my $fd = fileno($self->{sock}); out($self, " deferred[$fd] done - %0.6f", $elapsed); @@ -837,7 +807,7 @@ sub do_hdr ($$$;$) { } elsif ($sub =~ /\A:(bytes|lines)\z/) { hdr_smsg($self, $xhdr, $1, $range); } else { - $xhdr ? (r221 . '.') : "503 HDR not permitted on $header"; + $xhdr ? (r221.".\r\n") : "503 HDR not permitted on $header\r\n"; } } @@ -876,20 +846,20 @@ sub hdr_mid_response ($$$$$$) { sub xrover_i { my ($self, $beg, $end) = @_; my $h = over_header_for($self->{ibx}, $$beg, 'references'); - more($self, "$$beg $h") if defined($h); + $self->msg_more("$$beg $h\r\n") if defined($h); $$beg++ < $end; } sub cmd_xrover ($;$) { my ($self, $range) = @_; - my $ibx = $self->{ibx} or return '412 no newsgroup selected'; + my $ibx = $self->{ibx} or return \"412 no newsgroup selected\r\n"; (defined $range && $range =~ /[<>]/) and - return '420 No article(s) selected'; # no message IDs + return \"420 No article(s) selected\r\n"; # no message IDs $range = $self->{article} unless defined $range; my $r = get_range($self, $range); return $r unless ref $r; - more($self, '224 Overview information follows'); + $self->msg_more("224 Overview information follows\r\n"); long_response($self, \&xrover_i, @$r); } @@ -916,7 +886,8 @@ sub cmd_over ($;$) { my ($ibx, $n) = mid_lookup($self, $1); defined $n or return r430; my $smsg = $ibx->over(1)->get_art($n) or return r430; - more($self, '224 Overview information follows (multi-line)'); + $self->msg_more( + "224 Overview information follows (multi-line)\r\n"); # Only set article number column if it's the current group # (RFC 3977 8.3.2) @@ -926,8 +897,7 @@ sub cmd_over ($;$) { $smsg->{-orig_num} = $smsg->{num}; $smsg->{num} = 0; } - $self->msg_more(over_line($self, $ibx, $smsg)); - '.'; + over_line($self, $ibx, $smsg).".\r\n"; } else { cmd_xover($self, $range); } @@ -952,7 +922,8 @@ sub cmd_xover ($;$) { my $r = get_range($self, $range); return $r unless ref $r; my ($beg, $end) = @$r; - more($self, "224 Overview information follows for $$beg to $end"); + $self->msg_more( + "224 Overview information follows for $$beg to $end\r\n"); long_response($self, \&xover_i, @$r); } @@ -964,7 +935,7 @@ sub cmd_starttls ($) { # RFC 4642 2.2.1 return r502 if ($sock->can('accept_SSL') || $self->compressed); my $opt = $self->{nntpd}->{accept_tls} or - return '580 can not initiate TLS negotiation'; + return \"580 can not initiate TLS negotiation\r\n"; $self->write(\"382 Continue with TLS negotiation\r\n"); $self->{sock} = IO::Socket::SSL->start_SSL($sock, %$opt); $self->requeue if PublicInbox::DS::accept_tls_step($self); @@ -974,15 +945,13 @@ sub cmd_starttls ($) { # RFC 8054 sub cmd_compress ($$) { my ($self, $alg) = @_; - return '503 Only DEFLATE is supported' if uc($alg) ne 'DEFLATE'; + return "503 Only DEFLATE is supported\r\n" if uc($alg) ne 'DEFLATE'; return r502 if $self->compressed; PublicInbox::NNTPdeflate->enable($self); $self->requeue; undef } -sub zflush {} # overridden by NNTPdeflate - sub cmd_xpath ($$) { my ($self, $mid) = @_; return r501 unless $mid =~ $ONE_MSGID; @@ -1008,20 +977,8 @@ sub cmd_xpath ($$) { push @paths, "$ibx->{newsgroup}/$n"; } } - return '430 no such article on server' unless @paths; - '223 '.join(' ', sort(@paths)); -} - -sub res ($$) { do_write($_[0], $_[1] . "\r\n") } - -sub more ($$) { $_[0]->msg_more($_[1] . "\r\n") } - -sub do_write ($$) { - my $self = $_[0]; - my $done = $self->write(\($_[1])); - return 0 unless $self->{sock}; - - $done; + return \"430 no such article on server\r\n" unless @paths; + '223 '.join(' ', sort(@paths))."\r\n"; } sub err ($$;@) {