1 # Copyright (C) 2015-2020 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
6 # nntpd: PublicInbox::NNTPD ref
7 # article: per-session current article number
8 # ng: PublicInbox::Inbox ref
9 # long_cb: long_response private data
10 package PublicInbox::NNTP;
12 use parent qw(PublicInbox::DS);
13 use PublicInbox::MID qw(mid_escape $MID_EXTRACT);
15 use POSIX qw(strftime);
16 use PublicInbox::DS qw(now);
17 use Digest::SHA qw(sha1_hex);
18 use Time::Local qw(timegm timelocal);
19 use PublicInbox::GitAsyncCat;
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);
31 my $ONE_MSGID = qr/\A$MID_EXTRACT\z/;
32 my @OVERVIEW = qw(Subject From Date Message-ID References);
33 my $OVERVIEW_FMT = join(":\r\n", @OVERVIEW, qw(Bytes Lines), '') .
35 my $LIST_HEADERS = join("\r\n", @OVERVIEW,
36 qw(:bytes :lines Xref To Cc)) . "\r\n";
37 my $CAPABILITIES = <<"";
38 101 Capability list:\r
42 LIST ACTIVE ACTIVE.TIMES NEWSGROUPS OVERVIEW.FMT\r
47 sub greet ($) { $_[0]->write($_[0]->{nntpd}->{greet}) };
50 my ($class, $sock, $nntpd) = @_;
51 my $self = bless { nntpd => $nntpd }, $class;
54 if ($sock->can('accept_SSL') && !$sock->accept_SSL) {
55 return CORE::close($sock) if $! != EAGAIN;
56 $ev = PublicInbox::TLS::epollbit() or return CORE::close($sock);
57 $wbuf = [ \&PublicInbox::DS::accept_tls_step, \&greet ];
59 $self->SUPER::new($sock, $ev | EPOLLONESHOT);
61 $self->{wbuf} = $wbuf;
65 $self->update_idle_time;
71 my $tot = prototype $cb;
72 my ($nreq, undef) = split(';', $tot);
73 $nreq = ($nreq =~ tr/$//) - 1;
74 $tot = ($tot =~ tr/$//) - 1;
75 ($argc <= $tot && $argc >= $nreq);
78 # returns 1 if we can continue, 0 if not due to buffered writes or disconnect
79 sub process_line ($$) {
81 my ($req, @args) = split(/[ \t]+/, $l);
82 return 1 unless defined($req); # skip blank line
83 $req = $self->can('cmd_'.lc($req));
84 return res($self, '500 command not recognized') unless $req;
85 return res($self, r501) unless args_ok($req, scalar @args);
87 my $res = eval { $req->($self, @args) };
89 if ($err && $self->{sock}) {
92 err($self, 'error from: %s (%s)', $l, $err);
93 $res = '503 program fault - command not performed';
95 return 0 unless defined $res;
99 # The keyword argument is not used (rfc3977 5.2.2)
100 sub cmd_capabilities ($;$) {
101 my ($self, undef) = @_;
102 my $res = $CAPABILITIES;
103 if (!$self->{sock}->can('accept_SSL') &&
104 $self->{nntpd}->{accept_tls}) {
105 $res .= "STARTTLS\r\n";
111 my ($self, $arg) = @_;
113 return r501 unless $arg eq 'READER';
114 '201 Posting prohibited';
117 sub cmd_slave ($) { '202 slave status noted' }
119 sub cmd_xgtitle ($;$) {
120 my ($self, $wildmat) = @_;
121 more($self, '282 list of groups and descriptions follows');
122 list_newsgroups($self, $wildmat);
126 sub list_overview_fmt ($) {
128 $self->msg_more($OVERVIEW_FMT);
131 sub list_headers ($;$) {
133 $self->msg_more($LIST_HEADERS);
136 sub list_active ($;$) {
137 my ($self, $wildmat) = @_;
138 wildmat2re($wildmat);
139 foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
140 $ng->{newsgroup} =~ $wildmat or next;
141 group_line($self, $ng);
145 sub list_active_times ($;$) {
146 my ($self, $wildmat) = @_;
147 wildmat2re($wildmat);
148 foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
149 $ng->{newsgroup} =~ $wildmat or next;
150 my $c = eval { $ng->mm->created_at } || time;
151 more($self, "$ng->{newsgroup} $c $ng->{-primary_address}");
155 sub list_newsgroups ($;$) {
156 my ($self, $wildmat) = @_;
157 wildmat2re($wildmat);
158 foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
159 $ng->{newsgroup} =~ $wildmat or next;
160 my $d = $ng->description;
161 more($self, "$ng->{newsgroup} $d");
165 # LIST SUBSCRIPTIONS, DISTRIB.PATS are not supported
166 sub cmd_list ($;$$) {
167 my ($self, @args) = @_;
169 my $arg = shift @args;
170 $arg =~ tr/A-Z./a-z_/;
172 $arg = $self->can($arg);
173 return r501 unless $arg && args_ok($arg, scalar @args);
174 more($self, '215 information follows');
175 $arg->($self, @args);
177 more($self, '215 list of newsgroups follows');
178 foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
179 group_line($self, $ng);
185 sub listgroup_range_i {
186 my ($self, $beg, $end) = @_;
187 my $r = $self->{ng}->mm->msg_range($beg, $end, 'num');
188 scalar(@$r) or return;
189 more($self, join("\r\n", map { $_->[0] } @$r));
193 sub listgroup_all_i {
194 my ($self, $num) = @_;
195 my $ary = $self->{ng}->mm->ids_after($num);
196 scalar(@$ary) or return;
197 more($self, join("\r\n", @$ary));
201 sub cmd_listgroup ($;$$) {
202 my ($self, $group, $range) = @_;
203 if (defined $group) {
204 my $res = cmd_group($self, $group);
205 return $res if ($res !~ /\A211 /);
208 $self->{ng} or return '412 no newsgroup selected';
209 if (defined $range) {
210 my $r = get_range($self, $range);
211 return $r unless ref $r;
212 long_response($self, \&listgroup_range_i, @$r);
213 } else { # grab every article number
214 long_response($self, \&listgroup_all_i, \(my $num = 0));
218 sub parse_time ($$;$) {
219 my ($date, $time, $gmt) = @_;
220 my ($hh, $mm, $ss) = unpack('A2A2A2', $time);
222 $gmt =~ /\A(?:UTC|GMT)\z/i or die "GM invalid: $gmt";
225 my ($YYYY, $MM, $DD);
226 if (bytes::length($date) == 8) { # RFC 3977 allows YYYYMMDD
227 ($YYYY, $MM, $DD) = unpack('A4A2A2', $date);
228 } else { # legacy clients send YYMMDD
230 ($YY, $MM, $DD) = unpack('A2A2A2', $date);
231 my @now = $gmt ? gmtime : localtime;
232 my $cur_year = $now[5] + 1900;
233 my $cur_cent = int($cur_year / 100) * 100;
234 $YYYY = (($YY + $cur_cent) > $cur_year) ?
235 ($YY + 1900) : ($YY + $cur_cent);
238 timegm($ss, $mm, $hh, $DD, $MM - 1, $YYYY);
240 timelocal($ss, $mm, $hh, $DD, $MM - 1, $YYYY);
244 sub group_line ($$) {
245 my ($self, $ng) = @_;
246 my ($min, $max) = $ng->mm->minmax;
247 more($self, "$ng->{newsgroup} $max $min n") if defined $min && defined $max;
250 sub cmd_newgroups ($$$;$$) {
251 my ($self, $date, $time, $gmt, $dists) = @_;
252 my $ts = eval { parse_time($date, $time, $gmt) };
256 more($self, '231 list of new newsgroups follows');
257 foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
258 my $c = eval { $ng->mm->created_at } || 0;
259 next unless $c > $ts;
260 group_line($self, $ng);
265 sub wildmat2re (;$) {
266 return $_[0] = qr/.*/ if (!defined $_[0] || $_[0] eq '*');
271 $tmp =~ s#(?<!\\)\[(.+)(?<!\\)\]#
273 my $key = sha1_hex($orig . $salt);
274 $orig =~ s/([^\w\-])+/\Q$1/g;
278 my %map = ('*' => '.*', '?' => '.' );
279 $tmp =~ s#(?<!\\)([^\w\\])#$map{$1} || "\Q$1"#ge;
281 $tmp =~ s#([a-f0-9]{40})#
282 my $orig = $keep{$1};
283 defined $orig ? $orig : $1;
286 $_[0] = qr/\A$tmp\z/;
290 return $_[0] = qr/\A\z/ unless defined $_[0];
291 my %map = ('*' => '.*', ',' => '|');
292 $_[0] =~ s!(.)!$map{$1} || "\Q$1"!ge;
293 $_[0] = qr/\A(?:$_[0])\z/;
297 my ($self, $overs, $ts, $prev) = @_;
298 my $over = $overs->[0];
299 my $msgs = $over->query_ts($ts, $$prev);
302 join(">\r\n<", map { $_->{mid} } @$msgs ).
304 $$prev = $msgs->[-1]->{num};
307 if (@$overs) { # continue onto next newsgroup
310 } else { # break out of the long response.
316 sub cmd_newnews ($$$$;$$) {
317 my ($self, $newsgroups, $date, $time, $gmt, $dists) = @_;
318 my $ts = eval { parse_time($date, $time, $gmt) };
320 more($self, '230 list of new articles by message-id follows');
321 my ($keep, $skip) = split('!', $newsgroups, 2);
325 foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
326 $ng->{newsgroup} =~ $keep or next;
327 $ng->{newsgroup} =~ $skip and next;
328 my $over = $ng->over or next;
331 return '.' unless @overs;
334 long_response($self, \&newnews_i, \@overs, $ts, \$prev);
338 my ($self, $group) = @_;
339 my $no_such = '411 no such news group';
340 my $nntpd = $self->{nntpd};
341 my $ng = $nntpd->{groups}->{$group} or return $no_such;
345 my ($min, $max) = $ng->mm->minmax;
348 $self->{article} = $min;
349 my $est_size = $max - $min;
350 "211 $est_size $min $max $group";
353 sub article_adj ($$) {
354 my ($self, $off) = @_;
355 my $ng = $self->{ng} or return '412 no newsgroup selected';
357 my $n = $self->{article};
358 defined $n or return '420 no current article has been selected';
361 my $mid = $ng->mm->mid_for($n);
363 $n = $off > 0 ? 'next' : 'previous';
364 return "421 no $n article in this group";
366 $self->{article} = $n;
367 "223 $n <$mid> article retrieved - request text separately";
370 sub cmd_next ($) { article_adj($_[0], 1) }
371 sub cmd_last ($) { article_adj($_[0], -1) }
373 # We want to encourage using email and CC-ing everybody involved to avoid
374 # the single-point-of-failure a single server provides.
377 my $ng = $self->{ng};
378 $ng ? "440 mailto:$ng->{-primary_address} to post"
379 : '440 posting not allowed'
384 res($self, '205 closing connection - goodbye!');
389 sub header_append ($$$) {
390 my ($hdr, $k, $v) = @_;
391 my @v = $hdr->header_raw($k);
395 $hdr->header_set($k, @v, $v);
399 my ($self, $ng, $n, $mid) = @_;
400 my $ret = $self->{nntpd}->{servername} . " $ng->{newsgroup}:$n";
402 # num_for is pretty cheap and sometimes we'll lookup the existence
403 # of an article without getting even the OVER info. In other words,
404 # I'm not sure if its worth optimizing by scanning To:/Cc: and
405 # PublicInbox::ExtMsg on the PSGI end is just as expensive
406 foreach my $other (@{$self->{nntpd}->{grouplist}}) {
407 next if $ng eq $other;
408 my $num = eval { $other->mm->num_for($mid) } or next;
409 $ret .= " $other->{newsgroup}:$num";
414 sub set_nntp_headers ($$) {
415 my ($hdr, $smsg) = @_;
416 my ($mid) = $smsg->{mid};
418 # leafnode (and maybe other NNTP clients) have trouble dealing
419 # with v2 messages which have multiple Message-IDs (either due
420 # to our own content-based dedupe or buggy git-send-email versions).
421 my @mids = $hdr->header_raw('Message-ID');
422 if (scalar(@mids) > 1) {
424 $hdr->header_set('Message-ID', $mid0);
425 my @alt = $hdr->header_raw('X-Alt-Message-ID');
426 my %seen = map { $_ => 1 } (@alt, $mid0);
427 push(@alt, grep { !$seen{$_}++ } @mids);
428 $hdr->header_set('X-Alt-Message-ID', @alt);
431 # clobber some existing headers
432 my $ibx = $smsg->{-ibx};
433 my $xref = xref($smsg->{nntp}, $ibx, $smsg->{num}, $mid);
434 $hdr->header_set('Xref', $xref);
437 my ($server_name, $newsgroups) = split(/ /, $xref, 2);
438 $newsgroups =~ s/:[0-9]+\b//g; # drop NNTP article numbers
439 $newsgroups =~ tr/ /,/;
440 $hdr->header_set('Newsgroups', $newsgroups);
442 # *something* here is required for leafnode, try to follow
444 $hdr->header_set('Path', $server_name . '!not-for-mail');
446 header_append($hdr, 'List-Post', "<mailto:$ibx->{-primary_address}>");
447 if (my $url = $ibx->base_url) {
448 $mid = mid_escape($mid);
449 header_append($hdr, 'Archived-At', "<$url$mid/>");
450 header_append($hdr, 'List-Archive', "<$url>");
454 sub art_lookup ($$$) {
455 my ($self, $art, $code) = @_;
456 my $ng = $self->{ng};
460 if ($art =~ /\A[0-9]+\z/) {
461 $err = '423 no such article number in this group';
464 } elsif ($art =~ $ONE_MSGID) {
467 $n = $ng->mm->num_for($mid) if $ng;
468 goto found if defined $n;
469 foreach my $g (values %{$self->{nntpd}->{groups}}) {
470 $n = $g->mm->num_for($mid);
481 $err = '420 no current article has been selected';
482 $n = $self->{article};
483 defined $n or return $err;
485 $ng or return '412 no newsgroup has been selected';
486 $mid = $ng->mm->mid_for($n);
487 defined $mid or return $err;
490 my $smsg = $ng->over->get_art($n) or return $err;
492 if ($code == 223) { # STAT
494 "223 $n <$smsg->{mid}> article retrieved - " .
495 "request text separately";
496 } else { # HEAD | BODY | ARTICLE
497 $smsg->{nntp} = $self;
498 $smsg->{nntp_code} = $code;
499 set_art($self, $art);
500 # this dereferences to `undef'
501 ${git_async_cat($ng->git, $smsg->{blob}, \&blob_cb, $smsg)};
505 sub msg_body_write ($$) {
506 my ($self, $msg) = @_;
508 # these can momentarily double the memory consumption :<
509 $$msg =~ s/^\./../smg;
510 $$msg =~ s/(?<!\r)\n/\r\n/sg; # Alpine barfs without this
511 $$msg .= "\r\n" unless $$msg =~ /\r\n\z/s;
512 $self->msg_more($$msg);
516 my ($self, $art) = @_;
517 $self->{article} = $art if defined $art && $art =~ /\A[0-9]+\z/;
520 sub msg_hdr_write ($$) {
521 my ($eml, $smsg) = @_;
522 set_nntp_headers($eml, $smsg);
524 my $hdr = $eml->{hdr} // \(my $x = '');
525 # fixup old bug from import (pre-a0c07cba0e5d8b6a)
526 $$hdr =~ s/\A[\r\n]*From [^\r\n]*\r?\n//s;
527 $$hdr =~ s/(?<!\r)\n/\r\n/sg; # Alpine barfs without this
529 # for leafnode compatibility, we need to ensure Message-ID headers
530 # are only a single line.
531 $$hdr =~ s/^(Message-ID:)[ \t]*\r\n[ \t]+([^\r]+)\r\n/$1 $2\r\n/igsm;
532 $smsg->{nntp}->msg_more($$hdr);
535 sub blob_cb { # called by git->cat_async via git_async_cat
536 my ($bref, $oid, $type, $size, $smsg) = @_;
537 my $self = $smsg->{nntp};
538 my $code = $smsg->{nntp_code};
539 if (!defined($oid)) {
540 # it's possible to have TOCTOU if an admin runs
541 # public-inbox-(edit|purge), just move onto the next message
542 warn "E: $smsg->{blob} missing in $smsg->{-ibx}->{inboxdir}\n";
543 return $self->requeue;
544 } elsif ($smsg->{blob} ne $oid) {
546 die "BUG: $smsg->{blob} != $oid";
548 my $r = "$code $smsg->{num} <$smsg->{mid}> article retrieved - ";
549 my $eml = PublicInbox::Eml->new($bref);
551 more($self, $r .= 'head and body follow');
552 msg_hdr_write($eml, $smsg);
553 $self->msg_more("\r\n");
554 msg_body_write($self, $bref);
555 } elsif ($code == 221) {
556 more($self, $r .= 'head follows');
557 msg_hdr_write($eml, $smsg);
558 } elsif ($code == 222) {
559 more($self, $r .= 'body follows');
560 msg_body_write($self, $bref);
563 die "BUG: bad code: $r";
565 $self->write(\".\r\n"); # flushes (includes ->zflush)
569 sub cmd_article ($;$) {
570 my ($self, $art) = @_;
571 art_lookup($self, $art, 220);
575 my ($self, $art) = @_;
576 art_lookup($self, $art, 221);
580 my ($self, $art) = @_;
581 art_lookup($self, $art, 222);
585 my ($self, $art) = @_;
586 art_lookup($self, $art, 223); # art may be msgid
589 sub cmd_ihave ($) { '435 article not wanted - do not send it' }
591 sub cmd_date ($) { '111 '.strftime('%Y%m%d%H%M%S', gmtime(time)) }
595 more($self, '100 help text follows');
600 my ($self, $range) = @_;
601 my $ng = $self->{ng} or return '412 no news group has been selected';
602 defined $range or return '420 No article(s) selected';
604 my ($min, $max) = $ng->mm->minmax;
605 if ($range =~ /\A([0-9]+)\z/) {
607 } elsif ($range =~ /\A([0-9]+)-\z/) {
608 ($beg, $end) = ($1, $max);
609 } elsif ($range =~ /\A([0-9]+)-([0-9]+)\z/) {
610 ($beg, $end) = ($1, $2);
614 $beg = $min if ($beg < $min);
615 $end = $max if ($end > $max);
616 return '420 No article(s) selected' if ($beg > $end);
622 # wbuf is unset or empty, here; {long} may add to it
623 my ($fd, $cb, $t0, @args) = @{$self->{long_cb}};
624 my $more = eval { $cb->($self, @args) };
625 if ($@ || !$self->{sock}) { # something bad happened...
626 delete $self->{long_cb};
627 my $elapsed = now() - $t0;
630 "%s during long response[$fd] - %0.6f",
633 out($self, " deferred[$fd] aborted - %0.6f", $elapsed);
635 } elsif ($more) { # $self->{wbuf}:
636 $self->update_idle_time;
638 # COMPRESS users all share the same DEFLATE context.
639 # Flush it here to ensure clients don't see
643 # no recursion, schedule another call ASAP, but only after
644 # all pending writes are done. autovivify wbuf:
645 my $new_size = push(@{$self->{wbuf}}, \&long_step);
647 # wbuf may be populated by $cb, no need to rearm if so:
648 $self->requeue if $new_size == 1;
650 delete $self->{long_cb};
652 my $elapsed = now() - $t0;
653 my $fd = fileno($self->{sock});
654 out($self, " deferred[$fd] done - %0.6f", $elapsed);
655 my $wbuf = $self->{wbuf}; # do NOT autovivify
656 $self->requeue unless $wbuf && @$wbuf;
660 sub long_response ($$;@) {
661 my ($self, $cb, @args) = @_; # cb returns true if more, false if done
663 my $sock = $self->{sock} or return;
664 # make sure we disable reading during a long response,
665 # clients should not be sending us stuff and making us do more
666 # work while we are stream a response to them
667 $self->{long_cb} = [ fileno($sock), $cb, now(), @args ];
668 long_step($self); # kick off!
672 sub hdr_msgid_range_i {
673 my ($self, $beg, $end) = @_;
674 my $r = $self->{ng}->mm->msg_range($beg, $end);
676 more($self, join("\r\n", map { "$_->[0] <$_->[1]>" } @$r));
680 sub hdr_message_id ($$$) { # optimize XHDR Message-ID [range] for slrnpull.
681 my ($self, $xhdr, $range) = @_;
683 if (defined $range && $range =~ $ONE_MSGID) {
684 my ($ng, $n) = mid_lookup($self, $1);
685 return r430 unless $n;
686 hdr_mid_response($self, $xhdr, $ng, $n, $range, $range);
687 } else { # numeric range
688 $range = $self->{article} unless defined $range;
689 my $r = get_range($self, $range);
690 return $r unless ref $r;
691 more($self, $xhdr ? r221 : r225);
692 long_response($self, \&hdr_msgid_range_i, @$r);
696 sub mid_lookup ($$) {
697 my ($self, $mid) = @_;
698 my $self_ng = $self->{ng};
700 my $n = $self_ng->mm->num_for($mid);
701 return ($self_ng, $n) if defined $n;
703 foreach my $ng (values %{$self->{nntpd}->{groups}}) {
704 next if defined $self_ng && $ng eq $self_ng;
705 my $n = $ng->mm->num_for($mid);
706 return ($ng, $n) if defined $n;
712 my ($self, $beg, $end) = @_;
713 my $ng = $self->{ng};
714 my $r = $ng->mm->msg_range($beg, $end);
716 more($self, join("\r\n", map {
718 "$num ".xref($self, $ng, $num, $_->[1]);
723 sub hdr_xref ($$$) { # optimize XHDR Xref [range] for rtin
724 my ($self, $xhdr, $range) = @_;
726 if (defined $range && $range =~ $ONE_MSGID) {
728 my ($ng, $n) = mid_lookup($self, $mid);
729 return r430 unless $n;
730 hdr_mid_response($self, $xhdr, $ng, $n, $range,
731 xref($self, $ng, $n, $mid));
732 } else { # numeric range
733 $range = $self->{article} unless defined $range;
734 my $r = get_range($self, $range);
735 return $r unless ref $r;
736 more($self, $xhdr ? r221 : r225);
737 long_response($self, \&xref_range_i, @$r);
741 sub over_header_for {
742 my ($over, $num, $field) = @_;
743 my $smsg = $over->get_art($num) or return;
744 return PublicInbox::Smsg::date($smsg) if $field eq 'date';
749 my ($self, $beg, $end, $field) = @_;
750 my $over = $self->{ng}->over;
751 my $msgs = $over->query_xover($$beg, $end);
752 scalar(@$msgs) or return;
755 # ->{$field} is faster than ->$field invocations, so favor that.
756 if ($field eq 'date') {
758 $tmp .= "$s->{num} ".PublicInbox::Smsg::date($s)."\r\n"
762 $tmp .= "$s->{num} $s->{$field}\r\n";
766 $self->msg_more($tmp);
767 $$beg = $msgs->[-1]->{num} + 1;
770 sub hdr_smsg ($$$$) {
771 my ($self, $xhdr, $field, $range) = @_;
772 if (defined $range && $range =~ $ONE_MSGID) {
773 my ($ng, $n) = mid_lookup($self, $1);
774 return r430 unless defined $n;
775 my $v = over_header_for($ng->over, $n, $field);
776 hdr_mid_response($self, $xhdr, $ng, $n, $range, $v);
777 } else { # numeric range
778 $range = $self->{article} unless defined $range;
779 my $r = get_range($self, $range);
780 return $r unless ref $r;
781 more($self, $xhdr ? r221 : r225);
782 long_response($self, \&smsg_range_i, @$r, $field);
787 my ($self, $xhdr, $header, $range) = @_;
788 my $sub = lc $header;
789 if ($sub eq 'message-id') {
790 hdr_message_id($self, $xhdr, $range);
791 } elsif ($sub eq 'xref') {
792 hdr_xref($self, $xhdr, $range);
793 } elsif ($sub =~ /\A(?:subject|references|date|from|to|cc|
795 hdr_smsg($self, $xhdr, $sub, $range);
796 } elsif ($sub =~ /\A:(bytes|lines)\z/) {
797 hdr_smsg($self, $xhdr, $1, $range);
799 $xhdr ? (r221 . "\r\n.") : "503 HDR not permitted on $header";
805 my ($self, $header, $range) = @_;
806 do_hdr($self, 0, $header, $range);
810 sub cmd_xhdr ($$;$) {
811 my ($self, $header, $range) = @_;
812 do_hdr($self, 1, $header, $range);
815 sub hdr_mid_prefix ($$$$$) {
816 my ($self, $xhdr, $ng, $n, $mid) = @_;
817 return $mid if $xhdr;
819 # HDR for RFC 3977 users
820 if (my $self_ng = $self->{ng}) {
821 ($self_ng eq $ng) ? $n : '0';
827 sub hdr_mid_response ($$$$$$) {
828 my ($self, $xhdr, $ng, $n, $mid, $v) = @_;
831 $res .= r221 . "\r\n";
832 $res .= "$mid $v\r\n";
834 $res .= r225 . "\r\n";
835 my $pfx = hdr_mid_prefix($self, $xhdr, $ng, $n, $mid);
836 $res .= "$pfx $v\r\n";
838 res($self, $res .= '.');
843 my ($self, $beg, $end) = @_;
844 my $h = over_header_for($self->{ng}->over, $$beg, 'references');
845 more($self, "$$beg $h") if defined($h);
849 sub cmd_xrover ($;$) {
850 my ($self, $range) = @_;
851 my $ng = $self->{ng} or return '412 no newsgroup selected';
852 (defined $range && $range =~ /[<>]/) and
853 return '420 No article(s) selected'; # no message IDs
855 $range = $self->{article} unless defined $range;
856 my $r = get_range($self, $range);
857 return $r unless ref $r;
858 more($self, '224 Overview information follows');
859 long_response($self, \&xrover_i, @$r);
862 sub over_line ($$$$) {
863 my ($self, $ng, $num, $smsg) = @_;
864 # n.b. field access and procedural calls can be
865 # 10%-15% faster than OO method calls:
866 my $s = join("\t", $num,
869 PublicInbox::Smsg::date($smsg),
874 "Xref: " . xref($self, $ng, $num, $smsg->{mid}));
880 my ($self, $range) = @_;
881 if ($range && $range =~ $ONE_MSGID) {
882 my ($ng, $n) = mid_lookup($self, $1);
883 defined $n or return r430;
884 my $smsg = $ng->over->get_art($n) or return r430;
885 more($self, '224 Overview information follows (multi-line)');
887 # Only set article number column if it's the current group
888 my $self_ng = $self->{ng};
889 $n = 0 if (!$self_ng || $self_ng ne $ng);
890 more($self, over_line($self, $ng, $n, $smsg));
893 cmd_xover($self, $range);
898 my ($self, $beg, $end) = @_;
899 my $ng = $self->{ng};
900 my $msgs = $ng->over->query_xover($$beg, $end);
901 my $nr = scalar @$msgs or return;
904 more($self, join("\r\n", map {
905 over_line($self, $ng, $_->{num}, $_);
907 $$beg = $msgs->[-1]->{num} + 1;
910 sub cmd_xover ($;$) {
911 my ($self, $range) = @_;
912 $range = $self->{article} unless defined $range;
913 my $r = get_range($self, $range);
914 return $r unless ref $r;
915 my ($beg, $end) = @$r;
916 more($self, "224 Overview information follows for $$beg to $end");
917 long_response($self, \&xover_i, @$r);
920 sub compressed { undef }
922 sub cmd_starttls ($) {
924 my $sock = $self->{sock} or return;
926 return r502 if ($sock->can('accept_SSL') || $self->compressed);
927 my $opt = $self->{nntpd}->{accept_tls} or
928 return '580 can not initiate TLS negotiation';
929 res($self, '382 Continue with TLS negotiation');
930 $self->{sock} = IO::Socket::SSL->start_SSL($sock, %$opt);
931 $self->requeue if PublicInbox::DS::accept_tls_step($self);
936 sub cmd_compress ($$) {
937 my ($self, $alg) = @_;
938 return '503 Only DEFLATE is supported' if uc($alg) ne 'DEFLATE';
939 return r502 if $self->compressed;
940 PublicInbox::NNTPdeflate->enable($self);
945 sub zflush {} # overridden by NNTPdeflate
948 my ($self, $mid) = @_;
949 return r501 unless $mid =~ $ONE_MSGID;
952 foreach my $ng (values %{$self->{nntpd}->{groups}}) {
953 my $n = $ng->mm->num_for($mid);
954 push @paths, "$ng->{newsgroup}/$n" if defined $n;
956 return '430 no such article on server' unless @paths;
957 '223 '.join(' ', @paths);
960 sub res ($$) { do_write($_[0], $_[1] . "\r\n") }
962 sub more ($$) { $_[0]->msg_more($_[1] . "\r\n") }
966 my $done = $self->write(\($_[1]));
967 return 0 unless $self->{sock};
973 my ($self, $fmt, @args) = @_;
974 printf { $self->{nntpd}->{err} } $fmt."\n", @args;
978 my ($self, $fmt, @args) = @_;
979 printf { $self->{nntpd}->{out} } $fmt."\n", @args;
982 # callback used by PublicInbox::DS for any (e)poll (in/out/hup/err)
986 return unless $self->flush_write && $self->{sock} && !$self->{long_cb};
988 $self->update_idle_time;
989 # only read more requests if we've drained the write buffer,
990 # otherwise we can be buffering infinitely w/o backpressure
992 my $rbuf = $self->{rbuf} // \(my $x = '');
993 my $line = index($$rbuf, "\n");
995 return $self->close if length($$rbuf) >= LINE_MAX;
996 $self->do_read($rbuf, LINE_MAX, length($$rbuf)) or return;
997 $line = index($$rbuf, "\n");
999 $line = substr($$rbuf, 0, $line + 1, '');
1000 $line =~ s/\r?\n\z//s;
1001 return $self->close if $line =~ /[[:cntrl:]]/s;
1004 my $fd = fileno($self->{sock});
1005 my $r = eval { process_line($self, $line) };
1006 my $pending = $self->{wbuf} ? ' pending' : '';
1007 out($self, "[$fd] %s - %0.6f$pending", $line, now() - $t0);
1008 return $self->close if $r < 0;
1009 $self->rbuf_idle($rbuf);
1010 $self->update_idle_time;
1012 # maybe there's more pipelined data, or we'll have
1013 # to register it for socket-readiness notifications
1014 $self->requeue unless $pending;
1017 # for graceful shutdown in PublicInbox::Daemon:
1019 my ($self, $now) = @_;
1020 ($self->{rbuf} || $self->{wbuf} || $self->not_idle_long($now));