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 long_cb);
10 use PublicInbox::MID qw(mid_escape);
12 use POSIX qw(strftime);
13 use PublicInbox::DS qw(now);
14 use Digest::SHA qw(sha1_hex);
15 use Time::Local qw(timegm timelocal);
17 LINE_MAX => 512, # RFC 977 section 2.3
18 r501 => '501 command syntax error',
19 r502 => '502 Command unavailable',
20 r221 => '221 Header follows',
21 r224 => '224 Overview information follows (multi-line)',
22 r225 => '225 Headers follow (multi-line)',
23 r430 => '430 No article with that message-id',
25 use PublicInbox::Syscall qw(EPOLLIN EPOLLONESHOT);
28 my @OVERVIEW = qw(Subject From Date Message-ID References);
29 my $OVERVIEW_FMT = join(":\r\n", @OVERVIEW, qw(Bytes Lines), '') .
31 my $LIST_HEADERS = join("\r\n", @OVERVIEW,
32 qw(:bytes :lines Xref To Cc)) . "\r\n";
33 my $CAPABILITIES = <<"";
34 101 Capability list:\r
38 LIST ACTIVE ACTIVE.TIMES NEWSGROUPS OVERVIEW.FMT\r
44 sub greet ($) { $_[0]->write($_[0]->{nntpd}->{greet}) };
47 my ($class, $sock, $nntpd) = @_;
48 my $self = fields::new($class);
51 if (ref($sock) eq 'IO::Socket::SSL' && !$sock->accept_SSL) {
52 return CORE::close($sock) if $! != EAGAIN;
53 $ev = PublicInbox::TLS::epollbit();
54 $wbuf = [ \&PublicInbox::DS::accept_tls_step, \&greet ];
56 $self->SUPER::new($sock, $ev | EPOLLONESHOT);
57 $self->{nntpd} = $nntpd;
59 $self->{wbuf} = $wbuf;
63 $self->update_idle_time;
69 my $tot = prototype $cb;
70 my ($nreq, undef) = split(';', $tot);
71 $nreq = ($nreq =~ tr/$//) - 1;
72 $tot = ($tot =~ tr/$//) - 1;
73 ($argc <= $tot && $argc >= $nreq);
76 # returns 1 if we can continue, 0 if not due to buffered writes or disconnect
77 sub process_line ($$) {
79 my ($req, @args) = split(/[ \t]/, $l);
80 return 1 unless defined($req); # skip blank line
81 $req = $self->can('cmd_'.lc($req));
82 return res($self, '500 command not recognized') unless $req;
83 return res($self, r501) unless args_ok($req, scalar @args);
85 my $res = eval { $req->($self, @args) };
87 if ($err && $self->{sock}) {
90 err($self, 'error from: %s (%s)', $l, $err);
91 $res = '503 program fault - command not performed';
93 return 0 unless defined $res;
97 # The keyword argument is not used (rfc3977 5.2.2)
98 sub cmd_capabilities ($;$) {
99 my ($self, undef) = @_;
100 my $res = $CAPABILITIES;
101 if (ref($self->{sock}) ne 'IO::Socket::SSL' &&
102 $self->{nntpd}->{accept_tls}) {
103 $res .= "STARTTLS\r\n";
109 my ($self, $arg) = @_;
111 return r501 unless $arg eq 'READER';
112 '201 Posting prohibited';
115 sub cmd_slave ($) { '202 slave status noted' }
117 sub cmd_xgtitle ($;$) {
118 my ($self, $wildmat) = @_;
119 more($self, '282 list of groups and descriptions follows');
120 list_newsgroups($self, $wildmat);
124 sub list_overview_fmt ($) {
126 $self->msg_more($OVERVIEW_FMT);
129 sub list_headers ($;$) {
131 $self->msg_more($LIST_HEADERS);
134 sub list_active ($;$) {
135 my ($self, $wildmat) = @_;
136 wildmat2re($wildmat);
137 foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
138 $ng->{newsgroup} =~ $wildmat or next;
139 group_line($self, $ng);
143 sub list_active_times ($;$) {
144 my ($self, $wildmat) = @_;
145 wildmat2re($wildmat);
146 foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
147 $ng->{newsgroup} =~ $wildmat or next;
148 my $c = eval { $ng->mm->created_at } || time;
149 more($self, "$ng->{newsgroup} $c $ng->{-primary_address}");
153 sub list_newsgroups ($;$) {
154 my ($self, $wildmat) = @_;
155 wildmat2re($wildmat);
156 foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
157 $ng->{newsgroup} =~ $wildmat or next;
158 my $d = $ng->description;
159 more($self, "$ng->{newsgroup} $d");
163 # LIST SUBSCRIPTIONS, DISTRIB.PATS are not supported
164 sub cmd_list ($;$$) {
165 my ($self, @args) = @_;
167 my $arg = shift @args;
168 $arg =~ tr/A-Z./a-z_/;
170 $arg = $self->can($arg);
171 return r501 unless $arg && args_ok($arg, scalar @args);
172 more($self, '215 information follows');
173 $arg->($self, @args);
175 more($self, '215 list of newsgroups follows');
176 foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
177 group_line($self, $ng);
183 sub listgroup_range_i {
184 my ($self, $beg, $end) = @_;
185 my $r = $self->{ng}->mm->msg_range($beg, $end, 'num');
186 scalar(@$r) or return;
187 more($self, join("\r\n", map { $_->[0] } @$r));
191 sub listgroup_all_i {
192 my ($self, $num) = @_;
193 my $ary = $self->{ng}->mm->ids_after($num);
194 scalar(@$ary) or return;
195 more($self, join("\r\n", @$ary));
199 sub cmd_listgroup ($;$$) {
200 my ($self, $group, $range) = @_;
201 if (defined $group) {
202 my $res = cmd_group($self, $group);
203 return $res if ($res !~ /\A211 /);
206 $self->{ng} or return '412 no newsgroup selected';
207 if (defined $range) {
208 my $r = get_range($self, $range);
209 return $r unless ref $r;
210 long_response($self, \&listgroup_range_i, @$r);
211 } else { # grab every article number
212 long_response($self, \&listgroup_all_i, \(my $num = 0));
216 sub parse_time ($$;$) {
217 my ($date, $time, $gmt) = @_;
218 my ($hh, $mm, $ss) = unpack('A2A2A2', $time);
220 $gmt =~ /\A(?:UTC|GMT)\z/i or die "GM invalid: $gmt";
223 my ($YYYY, $MM, $DD);
224 if (bytes::length($date) == 8) { # RFC 3977 allows YYYYMMDD
225 ($YYYY, $MM, $DD) = unpack('A4A2A2', $date);
226 } else { # legacy clients send YYMMDD
228 ($YY, $MM, $DD) = unpack('A2A2A2', $date);
229 my @now = $gmt ? gmtime : localtime;
230 my $cur_year = $now[5] + 1900;
231 my $cur_cent = int($cur_year / 100) * 100;
232 $YYYY = (($YY + $cur_cent) > $cur_year) ?
233 ($YY + 1900) : ($YY + $cur_cent);
236 timegm($ss, $mm, $hh, $DD, $MM - 1, $YYYY);
238 timelocal($ss, $mm, $hh, $DD, $MM - 1, $YYYY);
242 sub group_line ($$) {
243 my ($self, $ng) = @_;
244 my ($min, $max) = $ng->mm->minmax;
245 more($self, "$ng->{newsgroup} $max $min n") if defined $min && defined $max;
248 sub cmd_newgroups ($$$;$$) {
249 my ($self, $date, $time, $gmt, $dists) = @_;
250 my $ts = eval { parse_time($date, $time, $gmt) };
254 more($self, '231 list of new newsgroups follows');
255 foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
256 my $c = eval { $ng->mm->created_at } || 0;
257 next unless $c > $ts;
258 group_line($self, $ng);
263 sub wildmat2re (;$) {
264 return $_[0] = qr/.*/ if (!defined $_[0] || $_[0] eq '*');
269 $tmp =~ s#(?<!\\)\[(.+)(?<!\\)\]#
271 my $key = sha1_hex($orig . $salt);
272 $orig =~ s/([^\w\-])+/\Q$1/g;
276 my %map = ('*' => '.*', '?' => '.' );
277 $tmp =~ s#(?<!\\)([^\w\\])#$map{$1} || "\Q$1"#ge;
279 $tmp =~ s#([a-f0-9]{40})#
280 my $orig = $keep{$1};
281 defined $orig ? $orig : $1;
284 $_[0] = qr/\A$tmp\z/;
288 return $_[0] = qr/\A\z/ unless defined $_[0];
289 my %map = ('*' => '.*', ',' => '|');
290 $_[0] =~ s!(.)!$map{$1} || "\Q$1"!ge;
291 $_[0] = qr/\A(?:$_[0])\z/;
295 my ($self, $overs, $ts, $prev) = @_;
296 my $over = $overs->[0];
297 my $msgs = $over->query_ts($ts, $$prev);
300 join(">\r\n<", map { $_->mid } @$msgs ).
302 $$prev = $msgs->[-1]->{num};
305 if (@$overs) { # continue onto next newsgroup
308 } else { # break out of the long response.
314 sub cmd_newnews ($$$$;$$) {
315 my ($self, $newsgroups, $date, $time, $gmt, $dists) = @_;
316 my $ts = eval { parse_time($date, $time, $gmt) };
318 more($self, '230 list of new articles by message-id follows');
319 my ($keep, $skip) = split('!', $newsgroups, 2);
323 foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
324 $ng->{newsgroup} =~ $keep or next;
325 $ng->{newsgroup} =~ $skip and next;
326 my $over = $ng->over or next;
329 return '.' unless @overs;
332 long_response($self, \&newnews_i, \@overs, $ts, \$prev);
336 my ($self, $group) = @_;
337 my $no_such = '411 no such news group';
338 my $ng = $self->{nntpd}->{groups}->{$group} or return $no_such;
341 my ($min, $max) = $ng->mm->minmax;
344 $self->{article} = $min;
345 my $est_size = $max - $min;
346 "211 $est_size $min $max $group";
349 sub article_adj ($$) {
350 my ($self, $off) = @_;
351 my $ng = $self->{ng} or return '412 no newsgroup selected';
353 my $n = $self->{article};
354 defined $n or return '420 no current article has been selected';
357 my $mid = $ng->mm->mid_for($n);
359 $n = $off > 0 ? 'next' : 'previous';
360 return "421 no $n article in this group";
362 $self->{article} = $n;
363 "223 $n <$mid> article retrieved - request text separately";
366 sub cmd_next ($) { article_adj($_[0], 1) }
367 sub cmd_last ($) { article_adj($_[0], -1) }
369 # We want to encourage using email and CC-ing everybody involved to avoid
370 # the single-point-of-failure a single server provides.
373 my $ng = $self->{ng};
374 $ng ? "440 mailto:$ng->{-primary_address} to post"
375 : '440 posting not allowed'
380 res($self, '205 closing connection - goodbye!');
385 sub header_append ($$$) {
386 my ($hdr, $k, $v) = @_;
387 my @v = $hdr->header($k);
391 $hdr->header_set($k, @v, $v);
395 my ($self, $ng, $n, $mid) = @_;
396 my $ret = $self->{nntpd}->{servername} . " $ng->{newsgroup}:$n";
398 # num_for is pretty cheap and sometimes we'll lookup the existence
399 # of an article without getting even the OVER info. In other words,
400 # I'm not sure if its worth optimizing by scanning To:/Cc: and
401 # PublicInbox::ExtMsg on the PSGI end is just as expensive
402 foreach my $other (@{$self->{nntpd}->{grouplist}}) {
403 next if $ng eq $other;
404 my $num = eval { $other->mm->num_for($mid) } or next;
405 $ret .= " $other->{newsgroup}:$num";
410 sub set_nntp_headers ($$$$$) {
411 my ($self, $hdr, $ng, $n, $mid) = @_;
413 # why? leafnode requires a Path: header for some inexplicable
414 # reason. We'll fake the shortest one possible.
415 $hdr->header_set('Path', 'y');
417 # leafnode (and maybe other NNTP clients) have trouble dealing
418 # with v2 messages which have multiple Message-IDs (either due
419 # to our own content-based dedupe or buggy git-send-email versions).
420 my @mids = $hdr->header('Message-ID');
421 if (scalar(@mids) > 1) {
423 $hdr->header_set('Message-ID', $mid0);
424 my @alt = $hdr->header('X-Alt-Message-ID');
425 my %seen = map { $_ => 1 } (@alt, $mid0);
426 foreach my $m (@mids) {
430 $hdr->header_set('X-Alt-Message-ID', @alt);
434 my $xref = xref($self, $ng, $n, $mid);
435 $hdr->header_set('Xref', $xref);
436 $xref =~ s/:[0-9]+//g;
437 $hdr->header_set('Newsgroups', (split(/ /, $xref, 2))[1]);
438 header_append($hdr, 'List-Post', "<mailto:$ng->{-primary_address}>");
439 if (my $url = $ng->base_url) {
440 $mid = mid_escape($mid);
441 header_append($hdr, 'Archived-At', "<$url$mid/>");
442 header_append($hdr, 'List-Archive', "<$url>");
446 sub art_lookup ($$$) {
447 my ($self, $art, $set_headers) = @_;
448 my $ng = $self->{ng};
452 if ($art =~ /\A[0-9]+\z/) {
453 $err = '423 no such article number in this group';
456 } elsif ($art =~ /\A<([^>]+)>\z/) {
459 $n = $ng->mm->num_for($mid) if $ng;
460 goto found if defined $n;
461 foreach my $g (values %{$self->{nntpd}->{groups}}) {
462 $n = $g->mm->num_for($mid);
473 $err = '420 no current article has been selected';
474 $n = $self->{article};
475 defined $n or return $err;
477 $ng or return '412 no newsgroup has been selected';
478 $mid = $ng->mm->mid_for($n);
479 defined $mid or return $err;
482 my $smsg = $ng->over->get_art($n) or return $err;
483 my $msg = $ng->msg_by_smsg($smsg) or return $err;
485 # Email::Simple->new will modify $msg in-place as documented
486 # in its manpage, so what's left is the body and we won't need
487 # to call Email::Simple::body(), later
488 my $hdr = Email::Simple->new($msg)->header_obj;
489 set_nntp_headers($self, $hdr, $ng, $n, $mid) if $set_headers;
490 [ $n, $mid, $msg, $hdr ];
493 sub msg_body_write ($$) {
494 my ($self, $msg) = @_;
496 # these can momentarily double the memory consumption :<
497 $$msg =~ s/^\./../smg;
498 $$msg =~ s/(?<!\r)\n/\r\n/sg; # Alpine barfs without this
499 $$msg .= "\r\n" unless $$msg =~ /\r\n\z/s;
500 $self->msg_more($$msg);
505 my ($self, $art) = @_;
506 $self->{article} = $art if defined $art && $art =~ /\A[0-9]+\z/;
509 sub msg_hdr_write ($$$) {
510 my ($self, $hdr, $body_follows) = @_;
511 $hdr = $hdr->as_string;
513 $hdr =~ s/(?<!\r)\n/\r\n/sg; # Alpine barfs without this
515 # for leafnode compatibility, we need to ensure Message-ID headers
516 # are only a single line. We can't subclass Email::Simple::Header
517 # and override _default_fold_at in here, either; since that won't
518 # affect messages already in the archive.
519 $hdr =~ s/^(Message-ID:)[ \t]*\r\n[ \t]+([^\r]+)\r\n/$1 $2\r\n/igsm;
520 $hdr .= "\r\n" if $body_follows;
521 $self->msg_more($hdr);
524 sub cmd_article ($;$) {
525 my ($self, $art) = @_;
526 my $r = art_lookup($self, $art, 1);
527 return $r unless ref $r;
528 my ($n, $mid, $msg, $hdr) = @$r;
529 set_art($self, $art);
530 more($self, "220 $n <$mid> article retrieved - head and body follow");
531 msg_hdr_write($self, $hdr, 1);
532 msg_body_write($self, $msg);
536 my ($self, $art) = @_;
537 my $r = art_lookup($self, $art, 2);
538 return $r unless ref $r;
539 my ($n, $mid, undef, $hdr) = @$r;
540 set_art($self, $art);
541 more($self, "221 $n <$mid> article retrieved - head follows");
542 msg_hdr_write($self, $hdr, 0);
547 my ($self, $art) = @_;
548 my $r = art_lookup($self, $art, 0);
549 return $r unless ref $r;
550 my ($n, $mid, $msg) = @$r;
551 set_art($self, $art);
552 more($self, "222 $n <$mid> article retrieved - body follows");
553 msg_body_write($self, $msg);
557 my ($self, $art) = @_;
558 my $r = art_lookup($self, $art, 0);
559 return $r unless ref $r;
561 set_art($self, $art);
562 "223 $n <$mid> article retrieved - request text separately";
565 sub cmd_ihave ($) { '435 article not wanted - do not send it' }
567 sub cmd_date ($) { '111 '.strftime('%Y%m%d%H%M%S', gmtime(time)) }
571 more($self, '100 help text follows');
576 my ($self, $range) = @_;
577 my $ng = $self->{ng} or return '412 no news group has been selected';
578 defined $range or return '420 No article(s) selected';
580 my ($min, $max) = $ng->mm->minmax;
581 if ($range =~ /\A([0-9]+)\z/) {
583 } elsif ($range =~ /\A([0-9]+)-\z/) {
584 ($beg, $end) = ($1, $max);
585 } elsif ($range =~ /\A([0-9]+)-([0-9]+)\z/) {
586 ($beg, $end) = ($1, $2);
590 $beg = $min if ($beg < $min);
591 $end = $max if ($end > $max);
592 return '420 No article(s) selected' if ($beg > $end);
598 # wbuf is unset or empty, here; {long} may add to it
599 my ($cb, $t0, @args) = @{$self->{long_cb}};
600 my $more = eval { $cb->($self, @args) };
601 if ($@ || !$self->{sock}) { # something bad happened...
602 delete $self->{long_cb};
603 my $elapsed = now() - $t0;
604 my $fd = fileno($self->{sock});
607 "%s during long response[$fd] - %0.6f",
610 out($self, " deferred[$fd] aborted - %0.6f", $elapsed);
612 } elsif ($more) { # $self->{wbuf}:
613 $self->update_idle_time;
615 # COMPRESS users all share the same DEFLATE context.
616 # Flush it here to ensure clients don't see
620 # no recursion, schedule another call ASAP
621 # but only after all pending writes are done
622 my $wbuf = $self->{wbuf} ||= [];
623 push @$wbuf, \&long_step;
625 # wbuf may be populated by $cb, no need to rearm if so:
626 $self->requeue if scalar(@$wbuf) == 1;
628 delete $self->{long_cb};
630 my $elapsed = now() - $t0;
631 my $fd = fileno($self->{sock});
632 out($self, " deferred[$fd] done - %0.6f", $elapsed);
633 my $wbuf = $self->{wbuf};
634 $self->requeue unless $wbuf && @$wbuf;
638 sub long_response ($$;@) {
639 my ($self, $cb, @args) = @_; # cb returns true if more, false if done
641 $self->{sock} or return;
642 # make sure we disable reading during a long response,
643 # clients should not be sending us stuff and making us do more
644 # work while we are stream a response to them
645 $self->{long_cb} = [ $cb, now(), @args ];
646 long_step($self); # kick off!
650 sub hdr_msgid_range_i {
651 my ($self, $beg, $end) = @_;
652 my $r = $self->{ng}->mm->msg_range($beg, $end);
654 more($self, join("\r\n", map { "$_->[0] <$_->[1]>" } @$r));
658 sub hdr_message_id ($$$) { # optimize XHDR Message-ID [range] for slrnpull.
659 my ($self, $xhdr, $range) = @_;
661 if (defined $range && $range =~ /\A<(.+)>\z/) { # Message-ID
662 my ($ng, $n) = mid_lookup($self, $1);
663 return r430 unless $n;
664 hdr_mid_response($self, $xhdr, $ng, $n, $range, $range);
665 } else { # numeric range
666 $range = $self->{article} unless defined $range;
667 my $r = get_range($self, $range);
668 return $r unless ref $r;
669 more($self, $xhdr ? r221 : r225);
670 long_response($self, \&hdr_msgid_range_i, @$r);
674 sub mid_lookup ($$) {
675 my ($self, $mid) = @_;
676 my $self_ng = $self->{ng};
678 my $n = $self_ng->mm->num_for($mid);
679 return ($self_ng, $n) if defined $n;
681 foreach my $ng (values %{$self->{nntpd}->{groups}}) {
682 next if defined $self_ng && $ng eq $self_ng;
683 my $n = $ng->mm->num_for($mid);
684 return ($ng, $n) if defined $n;
690 my ($self, $beg, $end) = @_;
691 my $ng = $self->{ng};
692 my $r = $ng->mm->msg_range($beg, $end);
694 more($self, join("\r\n", map {
696 "$num ".xref($self, $ng, $num, $_->[1]);
701 sub hdr_xref ($$$) { # optimize XHDR Xref [range] for rtin
702 my ($self, $xhdr, $range) = @_;
704 if (defined $range && $range =~ /\A<(.+)>\z/) { # Message-ID
706 my ($ng, $n) = mid_lookup($self, $mid);
707 return r430 unless $n;
708 hdr_mid_response($self, $xhdr, $ng, $n, $range,
709 xref($self, $ng, $n, $mid));
710 } else { # numeric range
711 $range = $self->{article} unless defined $range;
712 my $r = get_range($self, $range);
713 return $r unless ref $r;
714 more($self, $xhdr ? r221 : r225);
715 long_response($self, \&xref_range_i, @$r);
719 sub over_header_for {
720 my ($over, $num, $field) = @_;
721 my $smsg = $over->get_art($num) or return;
722 return PublicInbox::SearchMsg::date($smsg) if $field eq 'date';
726 sub searchmsg_range_i {
727 my ($self, $beg, $end, $field) = @_;
728 my $over = $self->{ng}->over;
729 my $msgs = $over->query_xover($$beg, $end);
730 scalar(@$msgs) or return;
732 foreach my $s (@$msgs) {
733 $tmp .= $s->{num} . ' ' . $s->$field . "\r\n";
736 $self->msg_more($tmp);
737 $$beg = $msgs->[-1]->{num} + 1;
740 sub hdr_searchmsg ($$$$) {
741 my ($self, $xhdr, $field, $range) = @_;
742 if (defined $range && $range =~ /\A<(.+)>\z/) { # Message-ID
743 my ($ng, $n) = mid_lookup($self, $1);
744 return r430 unless defined $n;
745 my $v = over_header_for($ng->over, $n, $field);
746 hdr_mid_response($self, $xhdr, $ng, $n, $range, $v);
747 } else { # numeric range
748 $range = $self->{article} unless defined $range;
749 my $r = get_range($self, $range);
750 return $r unless ref $r;
751 more($self, $xhdr ? r221 : r225);
752 long_response($self, \&searchmsg_range_i, @$r, $field);
757 my ($self, $xhdr, $header, $range) = @_;
758 my $sub = lc $header;
759 if ($sub eq 'message-id') {
760 hdr_message_id($self, $xhdr, $range);
761 } elsif ($sub eq 'xref') {
762 hdr_xref($self, $xhdr, $range);
763 } elsif ($sub =~ /\A(?:subject|references|date|from|to|cc|
765 hdr_searchmsg($self, $xhdr, $sub, $range);
766 } elsif ($sub =~ /\A:(bytes|lines)\z/) {
767 hdr_searchmsg($self, $xhdr, $1, $range);
769 $xhdr ? (r221 . "\r\n.") : "503 HDR not permitted on $header";
775 my ($self, $header, $range) = @_;
776 do_hdr($self, 0, $header, $range);
780 sub cmd_xhdr ($$;$) {
781 my ($self, $header, $range) = @_;
782 do_hdr($self, 1, $header, $range);
785 sub hdr_mid_prefix ($$$$$) {
786 my ($self, $xhdr, $ng, $n, $mid) = @_;
787 return $mid if $xhdr;
789 # HDR for RFC 3977 users
790 if (my $self_ng = $self->{ng}) {
791 ($self_ng eq $ng) ? $n : '0';
797 sub hdr_mid_response ($$$$$$) {
798 my ($self, $xhdr, $ng, $n, $mid, $v) = @_;
801 $res .= r221 . "\r\n";
802 $res .= "$mid $v\r\n";
804 $res .= r225 . "\r\n";
805 my $pfx = hdr_mid_prefix($self, $xhdr, $ng, $n, $mid);
806 $res .= "$pfx $v\r\n";
808 res($self, $res .= '.');
813 my ($self, $beg, $end) = @_;
814 my $h = over_header_for($self->{ng}->over, $$beg, 'references');
815 more($self, "$$beg $h") if defined($h);
819 sub cmd_xrover ($;$) {
820 my ($self, $range) = @_;
821 my $ng = $self->{ng} or return '412 no newsgroup selected';
822 (defined $range && $range =~ /[<>]/) and
823 return '420 No article(s) selected'; # no message IDs
825 $range = $self->{article} unless defined $range;
826 my $r = get_range($self, $range);
827 return $r unless ref $r;
828 more($self, '224 Overview information follows');
829 long_response($self, \&xrover_i, @$r);
832 sub over_line ($$$$) {
833 my ($self, $ng, $num, $smsg) = @_;
834 # n.b. field access and procedural calls can be
835 # 10%-15% faster than OO method calls:
836 my $s = join("\t", $num,
839 PublicInbox::SearchMsg::date($smsg),
844 "Xref: " . xref($self, $ng, $num, $smsg->{mid}));
850 my ($self, $range) = @_;
851 if ($range && $range =~ /\A<(.+)>\z/) {
852 my ($ng, $n) = mid_lookup($self, $1);
853 defined $n or return r430;
854 my $smsg = $ng->over->get_art($n) or return r430;
855 more($self, '224 Overview information follows (multi-line)');
857 # Only set article number column if it's the current group
858 my $self_ng = $self->{ng};
859 $n = 0 if (!$self_ng || $self_ng ne $ng);
860 more($self, over_line($self, $ng, $n, $smsg));
863 cmd_xover($self, $range);
868 my ($self, $beg, $end) = @_;
869 my $ng = $self->{ng};
870 my $msgs = $ng->over->query_xover($$beg, $end);
871 my $nr = scalar @$msgs or return;
874 more($self, join("\r\n", map {
875 over_line($self, $ng, $_->{num}, $_);
877 $$beg = $msgs->[-1]->{num} + 1;
880 sub cmd_xover ($;$) {
881 my ($self, $range) = @_;
882 $range = $self->{article} unless defined $range;
883 my $r = get_range($self, $range);
884 return $r unless ref $r;
885 my ($beg, $end) = @$r;
886 more($self, "224 Overview information follows for $$beg to $end");
887 long_response($self, \&xover_i, @$r);
890 sub compressed { undef }
892 sub cmd_starttls ($) {
894 my $sock = $self->{sock} or return;
896 return r502 if (ref($sock) eq 'IO::Socket::SSL' || $self->compressed);
897 my $opt = $self->{nntpd}->{accept_tls} or
898 return '580 can not initiate TLS negotiation';
899 res($self, '382 Continue with TLS negotiation');
900 $self->{sock} = IO::Socket::SSL->start_SSL($sock, %$opt);
901 $self->requeue if PublicInbox::DS::accept_tls_step($self);
906 sub cmd_compress ($$) {
907 my ($self, $alg) = @_;
908 return '503 Only DEFLATE is supported' if uc($alg) ne 'DEFLATE';
909 return r502 if $self->compressed || !$have_deflate;
910 PublicInbox::NNTPdeflate->enable($self);
915 sub zflush {} # overridden by NNTPdeflate
918 my ($self, $mid) = @_;
919 return r501 unless $mid =~ /\A<(.+)>\z/;
922 foreach my $ng (values %{$self->{nntpd}->{groups}}) {
923 my $n = $ng->mm->num_for($mid);
924 push @paths, "$ng->{newsgroup}/$n" if defined $n;
926 return '430 no such article on server' unless @paths;
927 '223 '.join(' ', @paths);
930 sub res ($$) { do_write($_[0], $_[1] . "\r\n") }
932 sub more ($$) { $_[0]->msg_more($_[1] . "\r\n") }
936 my $done = $self->write(\($_[1]));
937 return 0 unless $self->{sock};
943 my ($self, $fmt, @args) = @_;
944 printf { $self->{nntpd}->{err} } $fmt."\n", @args;
948 my ($self, $fmt, @args) = @_;
949 printf { $self->{nntpd}->{out} } $fmt."\n", @args;
952 # callback used by PublicInbox::DS for any (e)poll (in/out/hup/err)
956 return unless $self->flush_write && $self->{sock};
958 $self->update_idle_time;
959 # only read more requests if we've drained the write buffer,
960 # otherwise we can be buffering infinitely w/o backpressure
962 my $rbuf = $self->{rbuf} // (\(my $x = ''));
965 if (index($$rbuf, "\n") < 0) {
966 my $off = bytes::length($$rbuf);
967 $r = $self->do_read($rbuf, LINE_MAX, $off) or return;
969 while ($r > 0 && $$rbuf =~ s/\A[ \t]*([^\n]*?)\r?\n//) {
971 return $self->close if $line =~ /[[:cntrl:]]/s;
973 my $fd = fileno($self->{sock});
974 $r = eval { process_line($self, $line) };
975 my $pending = $self->{wbuf} ? ' pending' : '';
976 out($self, "[$fd] %s - %0.6f$pending", $line, now() - $t0);
979 return $self->close if $r < 0;
980 my $len = bytes::length($$rbuf);
981 return $self->close if ($len >= LINE_MAX);
982 $self->rbuf_idle($rbuf);
983 $self->update_idle_time;
985 # maybe there's more pipelined data, or we'll have
986 # to register it for socket-readiness notifications
987 $self->requeue unless $self->{wbuf};
990 # for graceful shutdown in PublicInbox::Daemon:
992 my ($self, $now) = @_;
993 ($self->{rbuf} || $self->{wbuf} || $self->not_idle_long($now));
996 # this is an import to prevent "perl -c" from complaining about fields
998 $have_deflate = eval { require PublicInbox::NNTPdeflate } and
999 $CAPABILITIES .= "COMPRESS DEFLATE\r\n";