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;
62 while (my ($fd, $v) = each %$EXPMAP) {
63 my ($idle_time, $nntp) = @$v;
64 if ($idle_time < $old) {
75 $expt = PublicInbox::EvCleanup::later(*expire_old) if $nr;
78 sub greet ($) { $_[0]->write($_[0]->{nntpd}->{greet}) };
81 my ($class, $sock, $nntpd) = @_;
82 my $self = fields::new($class);
85 if (ref($sock) eq 'IO::Socket::SSL' && !$sock->accept_SSL) {
86 return CORE::close($sock) if $! != EAGAIN;
87 $ev = PublicInbox::TLS::epollbit();
88 $wbuf = [ \&PublicInbox::DS::accept_tls_step, \&greet ];
90 $self->SUPER::new($sock, $ev | EPOLLONESHOT);
91 $self->{nntpd} = $nntpd;
93 $self->{wbuf} = $wbuf;
97 update_idle_time($self);
98 $expt ||= PublicInbox::EvCleanup::later(*expire_old);
103 my ($cb, $argc) = @_;
104 my $tot = prototype $cb;
105 my ($nreq, undef) = split(';', $tot);
106 $nreq = ($nreq =~ tr/$//) - 1;
107 $tot = ($tot =~ tr/$//) - 1;
108 ($argc <= $tot && $argc >= $nreq);
111 # returns 1 if we can continue, 0 if not due to buffered writes or disconnect
112 sub process_line ($$) {
114 my ($req, @args) = split(/[ \t]/, $l);
115 return 1 unless defined($req); # skip blank line
118 *{'cmd_'.lc($req)}{CODE};
120 return res($self, '500 command not recognized') unless $req;
121 return res($self, r501) unless args_ok($req, scalar @args);
123 my $res = eval { $req->($self, @args) };
125 if ($err && $self->{sock}) {
128 err($self, 'error from: %s (%s)', $l, $err);
129 $res = '503 program fault - command not performed';
131 return 0 unless defined $res;
135 # The keyword argument is not used (rfc3977 5.2.2)
136 sub cmd_capabilities ($;$) {
137 my ($self, undef) = @_;
138 my $res = $CAPABILITIES;
139 if (ref($self->{sock}) ne 'IO::Socket::SSL' &&
140 $self->{nntpd}->{accept_tls}) {
141 $res .= "STARTTLS\r\n";
147 my ($self, $arg) = @_;
149 return r501 unless $arg eq 'READER';
150 '201 Posting prohibited';
153 sub cmd_slave ($) { '202 slave status noted' }
155 sub cmd_xgtitle ($;$) {
156 my ($self, $wildmat) = @_;
157 more($self, '282 list of groups and descriptions follows');
158 list_newsgroups($self, $wildmat);
162 sub list_overview_fmt ($) {
164 $self->msg_more($OVERVIEW_FMT);
167 sub list_headers ($;$) {
169 $self->msg_more($LIST_HEADERS);
172 sub list_active ($;$) {
173 my ($self, $wildmat) = @_;
174 wildmat2re($wildmat);
175 foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
176 $ng->{newsgroup} =~ $wildmat or next;
177 group_line($self, $ng);
181 sub list_active_times ($;$) {
182 my ($self, $wildmat) = @_;
183 wildmat2re($wildmat);
184 foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
185 $ng->{newsgroup} =~ $wildmat or next;
186 my $c = eval { $ng->mm->created_at } || time;
187 more($self, "$ng->{newsgroup} $c $ng->{-primary_address}");
191 sub list_newsgroups ($;$) {
192 my ($self, $wildmat) = @_;
193 wildmat2re($wildmat);
194 foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
195 $ng->{newsgroup} =~ $wildmat or next;
196 my $d = $ng->description;
197 more($self, "$ng->{newsgroup} $d");
201 # LIST SUBSCRIPTIONS, DISTRIB.PATS are not supported
202 sub cmd_list ($;$$) {
203 my ($self, @args) = @_;
205 my $arg = shift @args;
206 $arg =~ tr/A-Z./a-z_/;
213 return r501 unless $arg && args_ok($arg, scalar @args);
214 more($self, '215 information follows');
215 $arg->($self, @args);
217 more($self, '215 list of newsgroups follows');
218 foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
219 group_line($self, $ng);
225 sub cmd_listgroup ($;$) {
226 my ($self, $group) = @_;
227 if (defined $group) {
228 my $res = cmd_group($self, $group);
229 return $res if ($res !~ /\A211 /);
233 $self->{ng} or return '412 no newsgroup selected';
235 long_response($self, sub {
236 my $ary = $self->{ng}->mm->ids_after(\$n);
237 scalar @$ary or return;
238 more($self, join("\r\n", @$ary));
243 sub parse_time ($$;$) {
244 my ($date, $time, $gmt) = @_;
245 my ($hh, $mm, $ss) = unpack('A2A2A2', $time);
247 $gmt =~ /\A(?:UTC|GMT)\z/i or die "GM invalid: $gmt";
250 my @now = $gmt ? gmtime : localtime;
251 my ($YYYY, $MM, $DD);
252 if (bytes::length($date) == 8) { # RFC 3977 allows YYYYMMDD
253 ($YYYY, $MM, $DD) = unpack('A4A2A2', $date);
254 } else { # legacy clients send YYMMDD
255 ($YYYY, $MM, $DD) = unpack('A2A2A2', $date);
256 my $cur_year = $now[5] + 1900;
257 if ($YYYY > $cur_year) {
258 $YYYY += int($cur_year / 1000) * 1000 - 100;
262 timegm($ss, $mm, $hh, $DD, $MM - 1, $YYYY);
264 timelocal($ss, $mm, $hh, $DD, $MM - 1, $YYYY);
268 sub group_line ($$) {
269 my ($self, $ng) = @_;
270 my ($min, $max) = $ng->mm->minmax;
271 more($self, "$ng->{newsgroup} $max $min n") if defined $min && defined $max;
274 sub cmd_newgroups ($$$;$$) {
275 my ($self, $date, $time, $gmt, $dists) = @_;
276 my $ts = eval { parse_time($date, $time, $gmt) };
280 more($self, '231 list of new newsgroups follows');
281 foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
282 my $c = eval { $ng->mm->created_at } || 0;
283 next unless $c > $ts;
284 group_line($self, $ng);
289 sub wildmat2re (;$) {
290 return $_[0] = qr/.*/ if (!defined $_[0] || $_[0] eq '*');
295 $tmp =~ s#(?<!\\)\[(.+)(?<!\\)\]#
297 my $key = sha1_hex($orig . $salt);
298 $orig =~ s/([^\w\-])+/\Q$1/g;
302 my %map = ('*' => '.*', '?' => '.' );
303 $tmp =~ s#(?<!\\)([^\w\\])#$map{$1} || "\Q$1"#ge;
305 $tmp =~ s#([a-f0-9]{40})#
306 my $orig = $keep{$1};
307 defined $orig ? $orig : $1;
310 $_[0] = qr/\A$tmp\z/;
314 return $_[0] = qr/\A\z/ unless defined $_[0];
315 my %map = ('*' => '.*', ',' => '|');
316 $_[0] =~ s!(.)!$map{$1} || "\Q$1"!ge;
317 $_[0] = qr/\A(?:$_[0])\z/;
320 sub cmd_newnews ($$$$;$$) {
321 my ($self, $newsgroups, $date, $time, $gmt, $dists) = @_;
322 my $ts = eval { parse_time($date, $time, $gmt) };
324 more($self, '230 list of new articles by message-id follows');
325 my ($keep, $skip) = split('!', $newsgroups, 2);
329 foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
330 $ng->{newsgroup} =~ $keep or next;
331 $ng->{newsgroup} =~ $skip and next;
332 my $over = $ng->over or next;
335 return '.' unless @over;
338 long_response($self, sub {
340 my $msgs = $over->query_ts($ts, $prev);
343 join(">\r\n<", map { $_->mid } @$msgs ).
345 $prev = $msgs->[-1]->{num};
348 if (@over) { # continue onto next newsgroup
351 } else { # break out of the long response.
359 my ($self, $group) = @_;
360 my $no_such = '411 no such news group';
361 my $ng = $self->{nntpd}->{groups}->{$group} or return $no_such;
364 my ($min, $max) = $ng->mm->minmax;
367 $self->{article} = $min;
368 my $est_size = $max - $min;
369 "211 $est_size $min $max $group";
372 sub article_adj ($$) {
373 my ($self, $off) = @_;
374 my $ng = $self->{ng} or return '412 no newsgroup selected';
376 my $n = $self->{article};
377 defined $n or return '420 no current article has been selected';
380 my $mid = $ng->mm->mid_for($n);
382 $n = $off > 0 ? 'next' : 'previous';
383 return "421 no $n article in this group";
385 $self->{article} = $n;
386 "223 $n <$mid> article retrieved - request text separately";
389 sub cmd_next ($) { article_adj($_[0], 1) }
390 sub cmd_last ($) { article_adj($_[0], -1) }
392 # We want to encourage using email and CC-ing everybody involved to avoid
393 # the single-point-of-failure a single server provides.
396 my $ng = $self->{ng};
397 $ng ? "440 mailto:$ng->{-primary_address} to post"
398 : '440 posting not allowed'
403 res($self, '205 closing connection - goodbye!');
408 sub header_append ($$$) {
409 my ($hdr, $k, $v) = @_;
410 my @v = $hdr->header($k);
414 $hdr->header_set($k, @v, $v);
418 my ($self, $ng, $n, $mid) = @_;
419 my $ret = $self->{nntpd}->{servername} . " $ng->{newsgroup}:$n";
421 # num_for is pretty cheap and sometimes we'll lookup the existence
422 # of an article without getting even the OVER info. In other words,
423 # I'm not sure if its worth optimizing by scanning To:/Cc: and
424 # PublicInbox::ExtMsg on the PSGI end is just as expensive
425 foreach my $other (@{$self->{nntpd}->{grouplist}}) {
426 next if $ng eq $other;
427 my $num = eval { $other->mm->num_for($mid) } or next;
428 $ret .= " $other->{newsgroup}:$num";
433 sub set_nntp_headers ($$$$$) {
434 my ($self, $hdr, $ng, $n, $mid) = @_;
436 # why? leafnode requires a Path: header for some inexplicable
437 # reason. We'll fake the shortest one possible.
438 $hdr->header_set('Path', 'y');
440 # leafnode (and maybe other NNTP clients) have trouble dealing
441 # with v2 messages which have multiple Message-IDs (either due
442 # to our own content-based dedupe or buggy git-send-email versions).
443 my @mids = $hdr->header('Message-ID');
444 if (scalar(@mids) > 1) {
446 $hdr->header_set('Message-ID', $mid0);
447 my @alt = $hdr->header('X-Alt-Message-ID');
448 my %seen = map { $_ => 1 } (@alt, $mid0);
449 foreach my $m (@mids) {
453 $hdr->header_set('X-Alt-Message-ID', @alt);
457 my $xref = xref($self, $ng, $n, $mid);
458 $hdr->header_set('Xref', $xref);
459 $xref =~ s/:[0-9]+//g;
460 $hdr->header_set('Newsgroups', (split(/ /, $xref, 2))[1]);
461 header_append($hdr, 'List-Post', "<mailto:$ng->{-primary_address}>");
462 if (my $url = $ng->base_url) {
463 $mid = mid_escape($mid);
464 header_append($hdr, 'Archived-At', "<$url$mid/>");
465 header_append($hdr, 'List-Archive', "<$url>");
469 sub art_lookup ($$$) {
470 my ($self, $art, $set_headers) = @_;
471 my $ng = $self->{ng};
475 if ($art =~ /\A[0-9]+\z/) {
476 $err = '423 no such article number in this group';
479 } elsif ($art =~ /\A<([^>]+)>\z/) {
482 $n = $ng->mm->num_for($mid) if $ng;
483 goto found if defined $n;
484 foreach my $g (values %{$self->{nntpd}->{groups}}) {
485 $n = $g->mm->num_for($mid);
496 $err = '420 no current article has been selected';
497 $n = $self->{article};
498 defined $n or return $err;
500 $ng or return '412 no newsgroup has been selected';
501 $mid = $ng->mm->mid_for($n);
502 defined $mid or return $err;
505 my $smsg = $ng->over->get_art($n) or return $err;
506 my $msg = $ng->msg_by_smsg($smsg) or return $err;
508 # Email::Simple->new will modify $msg in-place as documented
509 # in its manpage, so what's left is the body and we won't need
510 # to call Email::Simple::body(), later
511 my $hdr = Email::Simple->new($msg)->header_obj;
512 set_nntp_headers($self, $hdr, $ng, $n, $mid) if $set_headers;
513 [ $n, $mid, $msg, $hdr ];
516 sub msg_body_write ($$) {
517 my ($self, $msg) = @_;
519 # these can momentarily double the memory consumption :<
520 $$msg =~ s/^\./../smg;
521 $$msg =~ s/(?<!\r)\n/\r\n/sg; # Alpine barfs without this
522 $$msg .= "\r\n" unless $$msg =~ /\r\n\z/s;
523 $self->msg_more($$msg);
528 my ($self, $art) = @_;
529 $self->{article} = $art if defined $art && $art =~ /\A[0-9]+\z/;
532 sub msg_hdr_write ($$$) {
533 my ($self, $hdr, $body_follows) = @_;
534 $hdr = $hdr->as_string;
536 $hdr =~ s/(?<!\r)\n/\r\n/sg; # Alpine barfs without this
538 # for leafnode compatibility, we need to ensure Message-ID headers
539 # are only a single line. We can't subclass Email::Simple::Header
540 # and override _default_fold_at in here, either; since that won't
541 # affect messages already in the archive.
542 $hdr =~ s/^(Message-ID:)[ \t]*\r\n[ \t]+([^\r]+)\r\n/$1 $2\r\n/igsm;
543 $hdr .= "\r\n" if $body_follows;
544 $self->msg_more($hdr);
547 sub cmd_article ($;$) {
548 my ($self, $art) = @_;
549 my $r = art_lookup($self, $art, 1);
550 return $r unless ref $r;
551 my ($n, $mid, $msg, $hdr) = @$r;
552 set_art($self, $art);
553 more($self, "220 $n <$mid> article retrieved - head and body follow");
554 msg_hdr_write($self, $hdr, 1);
555 msg_body_write($self, $msg);
559 my ($self, $art) = @_;
560 my $r = art_lookup($self, $art, 2);
561 return $r unless ref $r;
562 my ($n, $mid, undef, $hdr) = @$r;
563 set_art($self, $art);
564 more($self, "221 $n <$mid> article retrieved - head follows");
565 msg_hdr_write($self, $hdr, 0);
570 my ($self, $art) = @_;
571 my $r = art_lookup($self, $art, 0);
572 return $r unless ref $r;
573 my ($n, $mid, $msg) = @$r;
574 set_art($self, $art);
575 more($self, "222 $n <$mid> article retrieved - body follows");
576 msg_body_write($self, $msg);
580 my ($self, $art) = @_;
581 my $r = art_lookup($self, $art, 0);
582 return $r unless ref $r;
584 set_art($self, $art);
585 "223 $n <$mid> article retrieved - request text separately";
588 sub cmd_ihave ($) { '435 article not wanted - do not send it' }
590 sub cmd_date ($) { '111 '.strftime('%Y%m%d%H%M%S', gmtime(time)) }
594 more($self, '100 help text follows');
599 my ($self, $range) = @_;
600 my $ng = $self->{ng} or return '412 no news group has been selected';
601 defined $range or return '420 No article(s) selected';
603 my ($min, $max) = $ng->mm->minmax;
604 if ($range =~ /\A([0-9]+)\z/) {
606 } elsif ($range =~ /\A([0-9]+)-\z/) {
607 ($beg, $end) = ($1, $max);
608 } elsif ($range =~ /\A([0-9]+)-([0-9]+)\z/) {
609 ($beg, $end) = ($1, $2);
613 $beg = $min if ($beg < $min);
614 $end = $max if ($end > $max);
615 return '420 No article(s) selected' if ($beg > $end);
619 sub long_response ($$) {
620 my ($self, $cb) = @_; # cb returns true if more, false if done
622 my $fd = fileno($self->{sock});
623 defined $fd or return;
624 # make sure we disable reading during a long response,
625 # clients should not be sending us stuff and making us do more
626 # work while we are stream a response to them
628 my $long_cb; # DANGER: self-referential
630 # wbuf is unset or empty, here; $cb may add to it
631 my $more = eval { $cb->() };
632 if ($@ || !$self->{sock}) { # something bad happened...
634 my $diff = now() - $t0;
637 "%s during long response[$fd] - %0.6f",
640 out($self, " deferred[$fd] aborted - %0.6f", $diff);
642 } elsif ($more) { # $self->{wbuf}:
643 update_idle_time($self);
645 # COMPRESS users all share the same DEFLATE context.
646 # Flush it here to ensure clients don't see
650 # no recursion, schedule another call ASAP
651 # but only after all pending writes are done
652 my $wbuf = $self->{wbuf} ||= [];
653 push @$wbuf, $long_cb;
655 # wbuf may be populated by $cb, no need to rearm if so:
656 $self->requeue if scalar(@$wbuf) == 1;
660 out($self, " deferred[$fd] done - %0.6f", now() - $t0);
661 my $wbuf = $self->{wbuf};
662 $self->requeue unless $wbuf && @$wbuf;
665 $self->write($long_cb); # kick off!
669 sub hdr_message_id ($$$) { # optimize XHDR Message-ID [range] for slrnpull.
670 my ($self, $xhdr, $range) = @_;
672 if (defined $range && $range =~ /\A<(.+)>\z/) { # Message-ID
673 my ($ng, $n) = mid_lookup($self, $1);
674 return r430 unless $n;
675 hdr_mid_response($self, $xhdr, $ng, $n, $range, $range);
676 } else { # numeric range
677 $range = $self->{article} unless defined $range;
678 my $r = get_range($self, $range);
679 return $r unless ref $r;
680 my $mm = $self->{ng}->mm;
681 my ($beg, $end) = @$r;
682 more($self, $xhdr ? r221 : r225);
683 long_response($self, sub {
684 my $r = $mm->msg_range(\$beg, $end);
686 more($self, join("\r\n", map {
694 sub mid_lookup ($$) {
695 my ($self, $mid) = @_;
696 my $self_ng = $self->{ng};
698 my $n = $self_ng->mm->num_for($mid);
699 return ($self_ng, $n) if defined $n;
701 foreach my $ng (values %{$self->{nntpd}->{groups}}) {
702 next if defined $self_ng && $ng eq $self_ng;
703 my $n = $ng->mm->num_for($mid);
704 return ($ng, $n) if defined $n;
709 sub hdr_xref ($$$) { # optimize XHDR Xref [range] for rtin
710 my ($self, $xhdr, $range) = @_;
712 if (defined $range && $range =~ /\A<(.+)>\z/) { # Message-ID
714 my ($ng, $n) = mid_lookup($self, $mid);
715 return r430 unless $n;
716 hdr_mid_response($self, $xhdr, $ng, $n, $range,
717 xref($self, $ng, $n, $mid));
718 } else { # numeric range
719 $range = $self->{article} unless defined $range;
720 my $r = get_range($self, $range);
721 return $r unless ref $r;
722 my $ng = $self->{ng};
724 my ($beg, $end) = @$r;
725 more($self, $xhdr ? r221 : r225);
726 long_response($self, sub {
727 my $r = $mm->msg_range(\$beg, $end);
729 more($self, join("\r\n", map {
731 "$num ".xref($self, $ng, $num, $_->[1]);
738 sub over_header_for {
739 my ($over, $num, $field) = @_;
740 my $smsg = $over->get_art($num) or return;
741 return PublicInbox::SearchMsg::date($smsg) if $field eq 'date';
745 sub hdr_searchmsg ($$$$) {
746 my ($self, $xhdr, $field, $range) = @_;
747 if (defined $range && $range =~ /\A<(.+)>\z/) { # Message-ID
748 my ($ng, $n) = mid_lookup($self, $1);
749 return r430 unless defined $n;
750 my $v = over_header_for($ng->over, $n, $field);
751 hdr_mid_response($self, $xhdr, $ng, $n, $range, $v);
752 } else { # numeric range
753 $range = $self->{article} unless defined $range;
754 my $over = $self->{ng}->over;
755 my $mm = $self->{ng}->mm;
756 my $r = get_range($self, $range);
757 return $r unless ref $r;
758 my ($beg, $end) = @$r;
759 more($self, $xhdr ? r221 : r225);
761 long_response($self, sub {
762 my $msgs = $over->query_xover($cur, $end);
763 my $nr = scalar @$msgs or return;
765 foreach my $s (@$msgs) {
766 $tmp .= $s->{num} . ' ' . $s->$field . "\r\n";
769 $self->msg_more($tmp);
770 $cur = $msgs->[-1]->{num} + 1;
776 my ($self, $xhdr, $header, $range) = @_;
777 my $sub = lc $header;
778 if ($sub eq 'message-id') {
779 hdr_message_id($self, $xhdr, $range);
780 } elsif ($sub eq 'xref') {
781 hdr_xref($self, $xhdr, $range);
782 } elsif ($sub =~ /\A(?:subject|references|date|from|to|cc|
784 hdr_searchmsg($self, $xhdr, $sub, $range);
785 } elsif ($sub =~ /\A:(bytes|lines)\z/) {
786 hdr_searchmsg($self, $xhdr, $1, $range);
788 $xhdr ? (r221 . "\r\n.") : "503 HDR not permitted on $header";
794 my ($self, $header, $range) = @_;
795 do_hdr($self, 0, $header, $range);
799 sub cmd_xhdr ($$;$) {
800 my ($self, $header, $range) = @_;
801 do_hdr($self, 1, $header, $range);
804 sub hdr_mid_prefix ($$$$$) {
805 my ($self, $xhdr, $ng, $n, $mid) = @_;
806 return $mid if $xhdr;
808 # HDR for RFC 3977 users
809 if (my $self_ng = $self->{ng}) {
810 ($self_ng eq $ng) ? $n : '0';
816 sub hdr_mid_response ($$$$$$) {
817 my ($self, $xhdr, $ng, $n, $mid, $v) = @_;
820 $res .= r221 . "\r\n";
821 $res .= "$mid $v\r\n";
823 $res .= r225 . "\r\n";
824 my $pfx = hdr_mid_prefix($self, $xhdr, $ng, $n, $mid);
825 $res .= "$pfx $v\r\n";
827 res($self, $res .= '.');
831 sub cmd_xrover ($;$) {
832 my ($self, $range) = @_;
833 my $ng = $self->{ng} or return '412 no newsgroup selected';
834 (defined $range && $range =~ /[<>]/) and
835 return '420 No article(s) selected'; # no message IDs
837 $range = $self->{article} unless defined $range;
838 my $r = get_range($self, $range);
839 return $r unless ref $r;
840 my ($beg, $end) = @$r;
842 my $over = $ng->over;
843 more($self, '224 Overview information follows');
845 long_response($self, sub {
846 my $h = over_header_for($over, $beg, 'references');
847 more($self, "$beg $h") if defined($h);
852 sub over_line ($$$$) {
853 my ($self, $ng, $num, $smsg) = @_;
854 # n.b. field access and procedural calls can be
855 # 10%-15% faster than OO method calls:
856 my $s = join("\t", $num,
859 PublicInbox::SearchMsg::date($smsg),
864 "Xref: " . xref($self, $ng, $num, $smsg->{mid}));
870 my ($self, $range) = @_;
871 if ($range && $range =~ /\A<(.+)>\z/) {
872 my ($ng, $n) = mid_lookup($self, $1);
873 defined $n or return r430;
874 my $smsg = $ng->over->get_art($n) or return r430;
875 more($self, '224 Overview information follows (multi-line)');
877 # Only set article number column if it's the current group
878 my $self_ng = $self->{ng};
879 $n = 0 if (!$self_ng || $self_ng ne $ng);
880 more($self, over_line($self, $ng, $n, $smsg));
883 cmd_xover($self, $range);
887 sub cmd_xover ($;$) {
888 my ($self, $range) = @_;
889 $range = $self->{article} unless defined $range;
890 my $r = get_range($self, $range);
891 return $r unless ref $r;
892 my ($beg, $end) = @$r;
893 more($self, "224 Overview information follows for $beg to $end");
894 my $over = $self->{ng}->over;
896 long_response($self, sub {
897 my $msgs = $over->query_xover($cur, $end);
898 my $nr = scalar @$msgs or return;
901 more($self, join("\r\n", map {
902 over_line($self, $self->{ng}, $_->{num}, $_);
904 $cur = $msgs->[-1]->{num} + 1;
908 sub compressed { undef }
910 sub cmd_starttls ($) {
912 my $sock = $self->{sock} or return;
914 return r502 if (ref($sock) eq 'IO::Socket::SSL' || $self->compressed);
915 my $opt = $self->{nntpd}->{accept_tls} or
916 return '580 can not initiate TLS negotiation';
917 res($self, '382 Continue with TLS negotiation');
918 $self->{sock} = IO::Socket::SSL->start_SSL($sock, %$opt);
919 $self->requeue if PublicInbox::DS::accept_tls_step($self);
924 sub cmd_compress ($$) {
925 my ($self, $alg) = @_;
926 return '503 Only DEFLATE is supported' if uc($alg) ne 'DEFLATE';
927 return r502 if $self->compressed || !$have_deflate;
928 PublicInbox::NNTPdeflate->enable($self);
933 sub zflush {} # overridden by NNTPdeflate
936 my ($self, $mid) = @_;
937 return r501 unless $mid =~ /\A<(.+)>\z/;
940 foreach my $ng (values %{$self->{nntpd}->{groups}}) {
941 my $n = $ng->mm->num_for($mid);
942 push @paths, "$ng->{newsgroup}/$n" if defined $n;
944 return '430 no such article on server' unless @paths;
945 '223 '.join(' ', @paths);
948 sub res ($$) { do_write($_[0], $_[1] . "\r\n") }
950 sub more ($$) { $_[0]->msg_more($_[1] . "\r\n") }
954 my $done = $self->write(\($_[1]));
955 return 0 unless $self->{sock};
961 my ($self, $fmt, @args) = @_;
962 printf { $self->{nntpd}->{err} } $fmt."\n", @args;
966 my ($self, $fmt, @args) = @_;
967 printf { $self->{nntpd}->{out} } $fmt."\n", @args;
970 # callback used by PublicInbox::DS for any (e)poll (in/out/hup/err)
974 return unless $self->flush_write && $self->{sock};
976 update_idle_time($self);
977 # only read more requests if we've drained the write buffer,
978 # otherwise we can be buffering infinitely w/o backpressure
980 my $rbuf = $self->{rbuf} // (\(my $x = ''));
983 if (index($$rbuf, "\n") < 0) {
984 my $off = bytes::length($$rbuf);
985 $r = $self->do_read($rbuf, LINE_MAX, $off) or return;
987 while ($r > 0 && $$rbuf =~ s/\A[ \t\r\n]*([^\r\n]*)\r?\n//) {
989 return $self->close if $line =~ /[[:cntrl:]]/s;
991 my $fd = fileno($self->{sock});
992 $r = eval { process_line($self, $line) };
993 my $pending = $self->{wbuf} ? ' pending' : '';
994 out($self, "[$fd] %s - %0.6f$pending", $line, now() - $t0);
997 return $self->close if $r < 0;
998 my $len = bytes::length($$rbuf);
999 return $self->close if ($len >= LINE_MAX);
1000 $self->rbuf_idle($rbuf);
1001 update_idle_time($self);
1003 # maybe there's more pipelined data, or we'll have
1004 # to register it for socket-readiness notifications
1005 $self->requeue unless $self->{wbuf};
1008 sub not_idle_long ($$) {
1009 my ($self, $now) = @_;
1010 my $sock = $self->{sock} or return;
1011 my $ary = $EXPMAP->{fileno($sock)} or return;
1012 my $exp_at = $ary->[0] + $EXPTIME;
1016 # for graceful shutdown in PublicInbox::Daemon:
1018 my ($self, $now) = @_;
1019 ($self->{rbuf} || $self->{wbuf} || not_idle_long($self, $now));
1022 # this is an import to prevent "perl -c" from complaining about fields
1024 $have_deflate = eval { require PublicInbox::NNTPdeflate } and
1025 $CAPABILITIES .= "COMPRESS DEFLATE\r\n";