1 # Copyright (C) 2015-2019 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # Each instance of this represents a NNTP client socket
5 package PublicInbox::NNTP;
8 use base qw(PublicInbox::DS);
9 use fields qw(nntpd article ng);
10 use PublicInbox::Search;
11 use PublicInbox::Msgmap;
12 use PublicInbox::MID qw(mid_escape);
14 require PublicInbox::EvCleanup;
16 use POSIX qw(strftime);
17 use PublicInbox::DS qw(now);
18 use Digest::SHA qw(sha1_hex);
19 use Time::Local qw(timegm timelocal);
21 LINE_MAX => 512, # RFC 977 section 2.3
22 r501 => '501 command syntax error',
23 r502 => '502 Command unavailable',
24 r221 => '221 Header follows',
25 r224 => '224 Overview information follows (multi-line)',
26 r225 => '225 Headers follow (multi-line)',
27 r430 => '430 No article with that message-id',
29 use PublicInbox::Syscall qw(EPOLLIN EPOLLONESHOT);
32 my @OVERVIEW = qw(Subject From Date Message-ID References Xref);
33 my $OVERVIEW_FMT = join(":\r\n", @OVERVIEW, qw(Bytes Lines)) . ":\r\n";
34 my $LIST_HEADERS = join("\r\n", @OVERVIEW,
35 qw(:bytes :lines Xref To Cc)) . "\r\n";
36 my $CAPABILITIES = <<"";
37 101 Capability list:\r
41 LIST ACTIVE ACTIVE.TIMES NEWSGROUPS OVERVIEW.FMT\r
46 my $EXPMAP; # fd -> [ idle_time, $self ]
48 our $EXPTIME = 180; # 3 minutes
50 sub update_idle_time ($) {
52 my $sock = $self->{sock} or return;
53 $EXPMAP->{fileno($sock)} = [ now(), $self ];
59 my $old = $now - $exp;
61 while (my ($fd, $v) = each %$EXPMAP) {
62 my ($idle_time, $nntp) = @$v;
63 if ($idle_time < $old) {
72 $expt = scalar(keys %new) ? PublicInbox::EvCleanup::later(*expire_old)
76 sub greet ($) { $_[0]->write($_[0]->{nntpd}->{greet}) };
79 my ($class, $sock, $nntpd) = @_;
80 my $self = fields::new($class);
83 if (ref($sock) eq 'IO::Socket::SSL' && !$sock->accept_SSL) {
84 return CORE::close($sock) if $! != EAGAIN;
85 $ev = PublicInbox::TLS::epollbit();
86 $wbuf = [ \&PublicInbox::DS::accept_tls_step, \&greet ];
88 $self->SUPER::new($sock, $ev | EPOLLONESHOT);
89 $self->{nntpd} = $nntpd;
91 $self->{wbuf} = $wbuf;
95 update_idle_time($self);
96 $expt ||= PublicInbox::EvCleanup::later(*expire_old);
101 my ($cb, $argc) = @_;
102 my $tot = prototype $cb;
103 my ($nreq, undef) = split(';', $tot);
104 $nreq = ($nreq =~ tr/$//) - 1;
105 $tot = ($tot =~ tr/$//) - 1;
106 ($argc <= $tot && $argc >= $nreq);
109 # returns 1 if we can continue, 0 if not due to buffered writes or disconnect
110 sub process_line ($$) {
112 my ($req, @args) = split(/[ \t]/, $l);
113 return 1 unless defined($req); # skip blank line
116 *{'cmd_'.lc($req)}{CODE};
118 return res($self, '500 command not recognized') unless $req;
119 return res($self, r501) unless args_ok($req, scalar @args);
121 my $res = eval { $req->($self, @args) };
123 if ($err && $self->{sock}) {
126 err($self, 'error from: %s (%s)', $l, $err);
127 $res = '503 program fault - command not performed';
129 return 0 unless defined $res;
133 # The keyword argument is not used (rfc3977 5.2.2)
134 sub cmd_capabilities ($;$) {
135 my ($self, undef) = @_;
136 my $res = $CAPABILITIES;
137 if (ref($self->{sock}) ne 'IO::Socket::SSL' &&
138 $self->{nntpd}->{accept_tls}) {
139 $res .= "STARTTLS\r\n";
145 my ($self, $arg) = @_;
147 return r501 unless $arg eq 'READER';
148 '201 Posting prohibited';
151 sub cmd_slave ($) { '202 slave status noted' }
153 sub cmd_xgtitle ($;$) {
154 my ($self, $wildmat) = @_;
155 more($self, '282 list of groups and descriptions follows');
156 list_newsgroups($self, $wildmat);
160 sub list_overview_fmt ($) {
162 $self->msg_more($OVERVIEW_FMT);
165 sub list_headers ($;$) {
167 $self->msg_more($LIST_HEADERS);
170 sub list_active ($;$) {
171 my ($self, $wildmat) = @_;
172 wildmat2re($wildmat);
173 foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
174 $ng->{newsgroup} =~ $wildmat or next;
175 group_line($self, $ng);
179 sub list_active_times ($;$) {
180 my ($self, $wildmat) = @_;
181 wildmat2re($wildmat);
182 foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
183 $ng->{newsgroup} =~ $wildmat or next;
184 my $c = eval { $ng->mm->created_at } || time;
185 more($self, "$ng->{newsgroup} $c $ng->{-primary_address}");
189 sub list_newsgroups ($;$) {
190 my ($self, $wildmat) = @_;
191 wildmat2re($wildmat);
192 foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
193 $ng->{newsgroup} =~ $wildmat or next;
194 my $d = $ng->description;
195 more($self, "$ng->{newsgroup} $d");
199 # LIST SUBSCRIPTIONS, DISTRIB.PATS are not supported
200 sub cmd_list ($;$$) {
201 my ($self, @args) = @_;
203 my $arg = shift @args;
204 $arg =~ tr/A-Z./a-z_/;
211 return r501 unless $arg && args_ok($arg, scalar @args);
212 more($self, '215 information follows');
213 $arg->($self, @args);
215 more($self, '215 list of newsgroups follows');
216 foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
217 group_line($self, $ng);
223 sub cmd_listgroup ($;$) {
224 my ($self, $group) = @_;
225 if (defined $group) {
226 my $res = cmd_group($self, $group);
227 return $res if ($res !~ /\A211 /);
231 $self->{ng} or return '412 no newsgroup selected';
233 long_response($self, sub {
234 my $ary = $self->{ng}->mm->ids_after(\$n);
235 scalar @$ary or return;
236 more($self, join("\r\n", @$ary));
241 sub parse_time ($$;$) {
242 my ($date, $time, $gmt) = @_;
243 my ($hh, $mm, $ss) = unpack('A2A2A2', $time);
245 $gmt =~ /\A(?:UTC|GMT)\z/i or die "GM invalid: $gmt";
248 my @now = $gmt ? gmtime : localtime;
249 my ($YYYY, $MM, $DD);
250 if (bytes::length($date) == 8) { # RFC 3977 allows YYYYMMDD
251 ($YYYY, $MM, $DD) = unpack('A4A2A2', $date);
252 } else { # legacy clients send YYMMDD
253 ($YYYY, $MM, $DD) = unpack('A2A2A2', $date);
254 my $cur_year = $now[5] + 1900;
255 if ($YYYY > $cur_year) {
256 $YYYY += int($cur_year / 1000) * 1000 - 100;
260 timegm($ss, $mm, $hh, $DD, $MM - 1, $YYYY);
262 timelocal($ss, $mm, $hh, $DD, $MM - 1, $YYYY);
266 sub group_line ($$) {
267 my ($self, $ng) = @_;
268 my ($min, $max) = $ng->mm->minmax;
269 more($self, "$ng->{newsgroup} $max $min n") if defined $min && defined $max;
272 sub cmd_newgroups ($$$;$$) {
273 my ($self, $date, $time, $gmt, $dists) = @_;
274 my $ts = eval { parse_time($date, $time, $gmt) };
278 more($self, '231 list of new newsgroups follows');
279 foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
280 my $c = eval { $ng->mm->created_at } || 0;
281 next unless $c > $ts;
282 group_line($self, $ng);
287 sub wildmat2re (;$) {
288 return $_[0] = qr/.*/ if (!defined $_[0] || $_[0] eq '*');
293 $tmp =~ s#(?<!\\)\[(.+)(?<!\\)\]#
295 my $key = sha1_hex($orig . $salt);
296 $orig =~ s/([^\w\-])+/\Q$1/g;
300 my %map = ('*' => '.*', '?' => '.' );
301 $tmp =~ s#(?<!\\)([^\w\\])#$map{$1} || "\Q$1"#ge;
303 $tmp =~ s#([a-f0-9]{40})#
304 my $orig = $keep{$1};
305 defined $orig ? $orig : $1;
308 $_[0] = qr/\A$tmp\z/;
312 return $_[0] = qr/\A\z/ unless defined $_[0];
313 my %map = ('*' => '.*', ',' => '|');
314 $_[0] =~ s!(.)!$map{$1} || "\Q$1"!ge;
315 $_[0] = qr/\A(?:$_[0])\z/;
318 sub cmd_newnews ($$$$;$$) {
319 my ($self, $newsgroups, $date, $time, $gmt, $dists) = @_;
320 my $ts = eval { parse_time($date, $time, $gmt) };
322 more($self, '230 list of new articles by message-id follows');
323 my ($keep, $skip) = split('!', $newsgroups, 2);
327 foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
328 $ng->{newsgroup} =~ $keep or next;
329 $ng->{newsgroup} =~ $skip and next;
330 my $over = $ng->over or next;
333 return '.' unless @over;
336 long_response($self, sub {
338 my $msgs = $over->query_ts($ts, $prev);
341 join(">\r\n<", map { $_->mid } @$msgs ).
343 $prev = $msgs->[-1]->{num};
346 if (@over) { # continue onto next newsgroup
349 } else { # break out of the long response.
357 my ($self, $group) = @_;
358 my $no_such = '411 no such news group';
359 my $ng = $self->{nntpd}->{groups}->{$group} or return $no_such;
362 my ($min, $max) = $ng->mm->minmax;
365 $self->{article} = $min;
366 my $est_size = $max - $min;
367 "211 $est_size $min $max $group";
370 sub article_adj ($$) {
371 my ($self, $off) = @_;
372 my $ng = $self->{ng} or return '412 no newsgroup selected';
374 my $n = $self->{article};
375 defined $n or return '420 no current article has been selected';
378 my $mid = $ng->mm->mid_for($n);
380 $n = $off > 0 ? 'next' : 'previous';
381 return "421 no $n article in this group";
383 $self->{article} = $n;
384 "223 $n <$mid> article retrieved - request text separately";
387 sub cmd_next ($) { article_adj($_[0], 1) }
388 sub cmd_last ($) { article_adj($_[0], -1) }
390 # We want to encourage using email and CC-ing everybody involved to avoid
391 # the single-point-of-failure a single server provides.
394 my $ng = $self->{ng};
395 $ng ? "440 mailto:$ng->{-primary_address} to post"
396 : '440 posting not allowed'
401 res($self, '205 closing connection - goodbye!');
406 sub header_append ($$$) {
407 my ($hdr, $k, $v) = @_;
408 my @v = $hdr->header($k);
412 $hdr->header_set($k, @v, $v);
416 my ($self, $ng, $n, $mid) = @_;
417 my $ret = $self->{nntpd}->{servername} . " $ng->{newsgroup}:$n";
419 # num_for is pretty cheap and sometimes we'll lookup the existence
420 # of an article without getting even the OVER info. In other words,
421 # I'm not sure if its worth optimizing by scanning To:/Cc: and
422 # PublicInbox::ExtMsg on the PSGI end is just as expensive
423 foreach my $other (@{$self->{nntpd}->{grouplist}}) {
424 next if $ng eq $other;
425 my $num = eval { $other->mm->num_for($mid) } or next;
426 $ret .= " $other->{newsgroup}:$num";
431 sub set_nntp_headers ($$$$$) {
432 my ($self, $hdr, $ng, $n, $mid) = @_;
434 # why? leafnode requires a Path: header for some inexplicable
435 # reason. We'll fake the shortest one possible.
436 $hdr->header_set('Path', 'y');
438 # leafnode (and maybe other NNTP clients) have trouble dealing
439 # with v2 messages which have multiple Message-IDs (either due
440 # to our own content-based dedupe or buggy git-send-email versions).
441 my @mids = $hdr->header('Message-ID');
442 if (scalar(@mids) > 1) {
444 $hdr->header_set('Message-ID', $mid0);
445 my @alt = $hdr->header('X-Alt-Message-ID');
446 my %seen = map { $_ => 1 } (@alt, $mid0);
447 foreach my $m (@mids) {
451 $hdr->header_set('X-Alt-Message-ID', @alt);
455 my $xref = xref($self, $ng, $n, $mid);
456 $hdr->header_set('Xref', $xref);
457 $xref =~ s/:[0-9]+//g;
458 $hdr->header_set('Newsgroups', (split(/ /, $xref, 2))[1]);
459 header_append($hdr, 'List-Post', "<mailto:$ng->{-primary_address}>");
460 if (my $url = $ng->base_url) {
461 $mid = mid_escape($mid);
462 header_append($hdr, 'Archived-At', "<$url$mid/>");
463 header_append($hdr, 'List-Archive', "<$url>");
467 sub art_lookup ($$$) {
468 my ($self, $art, $set_headers) = @_;
469 my $ng = $self->{ng};
473 if ($art =~ /\A[0-9]+\z/) {
474 $err = '423 no such article number in this group';
477 } elsif ($art =~ /\A<([^>]+)>\z/) {
480 $n = $ng->mm->num_for($mid) if $ng;
481 goto found if defined $n;
482 foreach my $g (values %{$self->{nntpd}->{groups}}) {
483 $n = $g->mm->num_for($mid);
494 $err = '420 no current article has been selected';
495 $n = $self->{article};
496 defined $n or return $err;
498 $ng or return '412 no newsgroup has been selected';
499 $mid = $ng->mm->mid_for($n);
500 defined $mid or return $err;
503 my $smsg = $ng->over->get_art($n) or return $err;
504 my $msg = $ng->msg_by_smsg($smsg) or return $err;
506 # Email::Simple->new will modify $msg in-place as documented
507 # in its manpage, so what's left is the body and we won't need
508 # to call Email::Simple::body(), later
509 my $hdr = Email::Simple->new($msg)->header_obj;
510 set_nntp_headers($self, $hdr, $ng, $n, $mid) if $set_headers;
511 [ $n, $mid, $msg, $hdr ];
514 sub msg_body_write ($$) {
515 my ($self, $msg) = @_;
517 # these can momentarily double the memory consumption :<
518 $$msg =~ s/^\./../smg;
519 $$msg =~ s/(?<!\r)\n/\r\n/sg; # Alpine barfs without this
520 $$msg .= "\r\n" unless $$msg =~ /\r\n\z/s;
521 $self->msg_more($$msg);
526 my ($self, $art) = @_;
527 $self->{article} = $art if defined $art && $art =~ /\A[0-9]+\z/;
530 sub msg_hdr_write ($$$) {
531 my ($self, $hdr, $body_follows) = @_;
532 $hdr = $hdr->as_string;
534 $hdr =~ s/(?<!\r)\n/\r\n/sg; # Alpine barfs without this
536 # for leafnode compatibility, we need to ensure Message-ID headers
537 # are only a single line. We can't subclass Email::Simple::Header
538 # and override _default_fold_at in here, either; since that won't
539 # affect messages already in the archive.
540 $hdr =~ s/^(Message-ID:)[ \t]*\r\n[ \t]+([^\r]+)\r\n/$1 $2\r\n/igsm;
541 $hdr .= "\r\n" if $body_follows;
542 $self->msg_more($hdr);
545 sub cmd_article ($;$) {
546 my ($self, $art) = @_;
547 my $r = art_lookup($self, $art, 1);
548 return $r unless ref $r;
549 my ($n, $mid, $msg, $hdr) = @$r;
550 set_art($self, $art);
551 more($self, "220 $n <$mid> article retrieved - head and body follow");
552 msg_hdr_write($self, $hdr, 1);
553 msg_body_write($self, $msg);
557 my ($self, $art) = @_;
558 my $r = art_lookup($self, $art, 2);
559 return $r unless ref $r;
560 my ($n, $mid, undef, $hdr) = @$r;
561 set_art($self, $art);
562 more($self, "221 $n <$mid> article retrieved - head follows");
563 msg_hdr_write($self, $hdr, 0);
568 my ($self, $art) = @_;
569 my $r = art_lookup($self, $art, 0);
570 return $r unless ref $r;
571 my ($n, $mid, $msg) = @$r;
572 set_art($self, $art);
573 more($self, "222 $n <$mid> article retrieved - body follows");
574 msg_body_write($self, $msg);
578 my ($self, $art) = @_;
579 my $r = art_lookup($self, $art, 0);
580 return $r unless ref $r;
582 set_art($self, $art);
583 "223 $n <$mid> article retrieved - request text separately";
586 sub cmd_ihave ($) { '435 article not wanted - do not send it' }
588 sub cmd_date ($) { '111 '.strftime('%Y%m%d%H%M%S', gmtime(time)) }
592 more($self, '100 help text follows');
597 my ($self, $range) = @_;
598 my $ng = $self->{ng} or return '412 no news group has been selected';
599 defined $range or return '420 No article(s) selected';
601 my ($min, $max) = $ng->mm->minmax;
602 if ($range =~ /\A([0-9]+)\z/) {
604 } elsif ($range =~ /\A([0-9]+)-\z/) {
605 ($beg, $end) = ($1, $max);
606 } elsif ($range =~ /\A([0-9]+)-([0-9]+)\z/) {
607 ($beg, $end) = ($1, $2);
611 $beg = $min if ($beg < $min);
612 $end = $max if ($end > $max);
613 return '420 No article(s) selected' if ($beg > $end);
617 sub long_response ($$) {
618 my ($self, $cb) = @_; # cb returns true if more, false if done
620 my $fd = fileno($self->{sock});
621 defined $fd or return;
622 # make sure we disable reading during a long response,
623 # clients should not be sending us stuff and making us do more
624 # work while we are stream a response to them
626 my $long_cb; # DANGER: self-referential
628 # wbuf is unset or empty, here; $cb may add to it
629 my $more = eval { $cb->() };
630 if ($@ || !$self->{sock}) { # something bad happened...
632 my $diff = now() - $t0;
635 "%s during long response[$fd] - %0.6f",
638 out($self, " deferred[$fd] aborted - %0.6f", $diff);
640 } elsif ($more) { # $self->{wbuf}:
641 update_idle_time($self);
643 # COMPRESS users all share the same DEFLATE context.
644 # Flush it here to ensure clients don't see
648 # no recursion, schedule another call ASAP
649 # but only after all pending writes are done
650 my $wbuf = $self->{wbuf} ||= [];
651 push @$wbuf, $long_cb;
653 # wbuf may be populated by $cb, no need to rearm if so:
654 $self->requeue if scalar(@$wbuf) == 1;
658 out($self, " deferred[$fd] done - %0.6f", now() - $t0);
659 my $wbuf = $self->{wbuf};
660 $self->requeue unless $wbuf && @$wbuf;
663 $self->write($long_cb); # kick off!
667 sub hdr_message_id ($$$) { # optimize XHDR Message-ID [range] for slrnpull.
668 my ($self, $xhdr, $range) = @_;
670 if (defined $range && $range =~ /\A<(.+)>\z/) { # Message-ID
671 my ($ng, $n) = mid_lookup($self, $1);
672 return r430 unless $n;
673 hdr_mid_response($self, $xhdr, $ng, $n, $range, $range);
674 } else { # numeric range
675 $range = $self->{article} unless defined $range;
676 my $r = get_range($self, $range);
677 return $r unless ref $r;
678 my $mm = $self->{ng}->mm;
679 my ($beg, $end) = @$r;
680 more($self, $xhdr ? r221 : r225);
681 long_response($self, sub {
682 my $r = $mm->msg_range(\$beg, $end);
684 more($self, join("\r\n", map {
692 sub mid_lookup ($$) {
693 my ($self, $mid) = @_;
694 my $self_ng = $self->{ng};
696 my $n = $self_ng->mm->num_for($mid);
697 return ($self_ng, $n) if defined $n;
699 foreach my $ng (values %{$self->{nntpd}->{groups}}) {
700 next if defined $self_ng && $ng eq $self_ng;
701 my $n = $ng->mm->num_for($mid);
702 return ($ng, $n) if defined $n;
707 sub hdr_xref ($$$) { # optimize XHDR Xref [range] for rtin
708 my ($self, $xhdr, $range) = @_;
710 if (defined $range && $range =~ /\A<(.+)>\z/) { # Message-ID
712 my ($ng, $n) = mid_lookup($self, $mid);
713 return r430 unless $n;
714 hdr_mid_response($self, $xhdr, $ng, $n, $range,
715 xref($self, $ng, $n, $mid));
716 } else { # numeric range
717 $range = $self->{article} unless defined $range;
718 my $r = get_range($self, $range);
719 return $r unless ref $r;
720 my $ng = $self->{ng};
722 my ($beg, $end) = @$r;
723 more($self, $xhdr ? r221 : r225);
724 long_response($self, sub {
725 my $r = $mm->msg_range(\$beg, $end);
727 more($self, join("\r\n", map {
729 "$num ".xref($self, $ng, $num, $_->[1]);
736 sub over_header_for {
737 my ($over, $num, $field) = @_;
738 my $smsg = $over->get_art($num) or return;
739 return PublicInbox::SearchMsg::date($smsg) if $field eq 'date';
743 sub hdr_searchmsg ($$$$) {
744 my ($self, $xhdr, $field, $range) = @_;
745 if (defined $range && $range =~ /\A<(.+)>\z/) { # Message-ID
746 my ($ng, $n) = mid_lookup($self, $1);
747 return r430 unless defined $n;
748 my $v = over_header_for($ng->over, $n, $field);
749 hdr_mid_response($self, $xhdr, $ng, $n, $range, $v);
750 } else { # numeric range
751 $range = $self->{article} unless defined $range;
752 my $over = $self->{ng}->over;
753 my $mm = $self->{ng}->mm;
754 my $r = get_range($self, $range);
755 return $r unless ref $r;
756 my ($beg, $end) = @$r;
757 more($self, $xhdr ? r221 : r225);
759 long_response($self, sub {
760 my $msgs = $over->query_xover($cur, $end);
761 my $nr = scalar @$msgs or return;
763 foreach my $s (@$msgs) {
764 $tmp .= $s->{num} . ' ' . $s->$field . "\r\n";
767 $self->msg_more($tmp);
768 $cur = $msgs->[-1]->{num} + 1;
774 my ($self, $xhdr, $header, $range) = @_;
775 my $sub = lc $header;
776 if ($sub eq 'message-id') {
777 hdr_message_id($self, $xhdr, $range);
778 } elsif ($sub eq 'xref') {
779 hdr_xref($self, $xhdr, $range);
780 } elsif ($sub =~ /\A(?:subject|references|date|from|to|cc|
782 hdr_searchmsg($self, $xhdr, $sub, $range);
783 } elsif ($sub =~ /\A:(bytes|lines)\z/) {
784 hdr_searchmsg($self, $xhdr, $1, $range);
786 $xhdr ? (r221 . "\r\n.") : "503 HDR not permitted on $header";
792 my ($self, $header, $range) = @_;
793 do_hdr($self, 0, $header, $range);
797 sub cmd_xhdr ($$;$) {
798 my ($self, $header, $range) = @_;
799 do_hdr($self, 1, $header, $range);
802 sub hdr_mid_prefix ($$$$$) {
803 my ($self, $xhdr, $ng, $n, $mid) = @_;
804 return $mid if $xhdr;
806 # HDR for RFC 3977 users
807 if (my $self_ng = $self->{ng}) {
808 ($self_ng eq $ng) ? $n : '0';
814 sub hdr_mid_response ($$$$$$) {
815 my ($self, $xhdr, $ng, $n, $mid, $v) = @_;
818 $res .= r221 . "\r\n";
819 $res .= "$mid $v\r\n";
821 $res .= r225 . "\r\n";
822 my $pfx = hdr_mid_prefix($self, $xhdr, $ng, $n, $mid);
823 $res .= "$pfx $v\r\n";
825 res($self, $res .= '.');
829 sub cmd_xrover ($;$) {
830 my ($self, $range) = @_;
831 my $ng = $self->{ng} or return '412 no newsgroup selected';
832 (defined $range && $range =~ /[<>]/) and
833 return '420 No article(s) selected'; # no message IDs
835 $range = $self->{article} unless defined $range;
836 my $r = get_range($self, $range);
837 return $r unless ref $r;
838 my ($beg, $end) = @$r;
840 my $over = $ng->over;
841 more($self, '224 Overview information follows');
843 long_response($self, sub {
844 my $h = over_header_for($over, $beg, 'references');
845 more($self, "$beg $h") if defined($h);
850 sub over_line ($$$$) {
851 my ($self, $ng, $num, $smsg) = @_;
852 # n.b. field access and procedural calls can be
853 # 10%-15% faster than OO method calls:
854 my $s = join("\t", $num,
857 PublicInbox::SearchMsg::date($smsg),
862 "Xref: " . xref($self, $ng, $num, $smsg->{mid}));
868 my ($self, $range) = @_;
869 if ($range && $range =~ /\A<(.+)>\z/) {
870 my ($ng, $n) = mid_lookup($self, $1);
871 defined $n or return r430;
872 my $smsg = $ng->over->get_art($n) or return r430;
873 more($self, '224 Overview information follows (multi-line)');
875 # Only set article number column if it's the current group
876 my $self_ng = $self->{ng};
877 $n = 0 if (!$self_ng || $self_ng ne $ng);
878 more($self, over_line($self, $ng, $n, $smsg));
881 cmd_xover($self, $range);
885 sub cmd_xover ($;$) {
886 my ($self, $range) = @_;
887 $range = $self->{article} unless defined $range;
888 my $r = get_range($self, $range);
889 return $r unless ref $r;
890 my ($beg, $end) = @$r;
891 more($self, "224 Overview information follows for $beg to $end");
892 my $over = $self->{ng}->over;
894 long_response($self, sub {
895 my $msgs = $over->query_xover($cur, $end);
896 my $nr = scalar @$msgs or return;
899 more($self, join("\r\n", map {
900 over_line($self, $self->{ng}, $_->{num}, $_);
902 $cur = $msgs->[-1]->{num} + 1;
906 sub compressed { undef }
908 sub cmd_starttls ($) {
910 my $sock = $self->{sock} or return;
912 return r502 if (ref($sock) eq 'IO::Socket::SSL' || $self->compressed);
913 my $opt = $self->{nntpd}->{accept_tls} or
914 return '580 can not initiate TLS negotiation';
915 res($self, '382 Continue with TLS negotiation');
916 $self->{sock} = IO::Socket::SSL->start_SSL($sock, %$opt);
917 $self->requeue if PublicInbox::DS::accept_tls_step($self);
922 sub cmd_compress ($$) {
923 my ($self, $alg) = @_;
924 return '503 Only DEFLATE is supported' if uc($alg) ne 'DEFLATE';
925 return r502 if $self->compressed || !$have_deflate;
926 PublicInbox::NNTPdeflate->enable($self);
931 sub zflush {} # overridden by NNTPdeflate
934 my ($self, $mid) = @_;
935 return r501 unless $mid =~ /\A<(.+)>\z/;
938 foreach my $ng (values %{$self->{nntpd}->{groups}}) {
939 my $n = $ng->mm->num_for($mid);
940 push @paths, "$ng->{newsgroup}/$n" if defined $n;
942 return '430 no such article on server' unless @paths;
943 '223 '.join(' ', @paths);
946 sub res ($$) { do_write($_[0], $_[1] . "\r\n") }
948 sub more ($$) { $_[0]->msg_more($_[1] . "\r\n") }
952 my $done = $self->write(\($_[1]));
953 return 0 unless $self->{sock};
959 my ($self, $fmt, @args) = @_;
960 printf { $self->{nntpd}->{err} } $fmt."\n", @args;
964 my ($self, $fmt, @args) = @_;
965 printf { $self->{nntpd}->{out} } $fmt."\n", @args;
968 # callback used by PublicInbox::DS for any (e)poll (in/out/hup/err)
972 return unless $self->flush_write && $self->{sock};
974 update_idle_time($self);
975 # only read more requests if we've drained the write buffer,
976 # otherwise we can be buffering infinitely w/o backpressure
978 my $rbuf = $self->{rbuf} // (\(my $x = ''));
981 if (index($$rbuf, "\n") < 0) {
982 my $off = bytes::length($$rbuf);
983 $r = $self->do_read($rbuf, LINE_MAX, $off) or return;
985 while ($r > 0 && $$rbuf =~ s/\A[ \t\r\n]*([^\r\n]*)\r?\n//) {
987 return $self->close if $line =~ /[[:cntrl:]]/s;
989 my $fd = fileno($self->{sock});
990 $r = eval { process_line($self, $line) };
991 my $pending = $self->{wbuf} ? ' pending' : '';
992 out($self, "[$fd] %s - %0.6f$pending", $line, now() - $t0);
995 return $self->close if $r < 0;
996 my $len = bytes::length($$rbuf);
997 return $self->close if ($len >= LINE_MAX);
998 $self->rbuf_idle($rbuf);
999 update_idle_time($self);
1001 # maybe there's more pipelined data, or we'll have
1002 # to register it for socket-readiness notifications
1003 $self->requeue unless $self->{wbuf};
1006 sub not_idle_long ($$) {
1007 my ($self, $now) = @_;
1008 my $sock = $self->{sock} or return;
1009 my $ary = $EXPMAP->{fileno($sock)} or return;
1010 my $exp_at = $ary->[0] + $EXPTIME;
1014 # for graceful shutdown in PublicInbox::Daemon:
1016 my ($self, $now) = @_;
1017 ($self->{rbuf} || $self->{wbuf} || not_idle_long($self, $now));
1020 # this is an import to prevent "perl -c" from complaining about fields
1022 $have_deflate = eval { require PublicInbox::NNTPdeflate } and
1023 $CAPABILITIES .= "COMPRESS DEFLATE\r\n";