1 # Copyright (C) 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 # ibx: PublicInbox::Inbox ref
9 # long_cb: long_response private data
10 package PublicInbox::NNTP;
13 use parent qw(PublicInbox::DS);
14 use PublicInbox::MID qw(mid_escape $MID_EXTRACT);
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);
20 use PublicInbox::GitAsyncCat;
21 use PublicInbox::Address;
24 LINE_MAX => 512, # RFC 977 section 2.3
25 r501 => "501 command syntax error\r\n",
26 r502 => "502 Command unavailable\r\n",
27 r221 => "221 Header follows\r\n",
28 r225 => "225 Headers follow (multi-line)\r\n",
29 r430 => "430 No article with that message-id\r\n",
32 my $ONE_MSGID = qr/\A$MID_EXTRACT\z/;
33 my @OVERVIEW = qw(Subject From Date Message-ID References);
34 my $OVERVIEW_FMT = join(":\r\n", @OVERVIEW, qw(Bytes Lines), '') .
36 my $LIST_HEADERS = join("\r\n", @OVERVIEW,
37 qw(:bytes :lines Xref To Cc)) . "\r\n.\r\n";
38 my $CAPABILITIES = <<"";
39 101 Capability list:\r
43 LIST ACTIVE ACTIVE.TIMES NEWSGROUPS OVERVIEW.FMT\r
48 sub do_greet ($) { $_[0]->write($_[0]->{nntpd}->{greet}) };
51 my ($cls, $sock, $nntpd) = @_;
52 (bless { nntpd => $nntpd }, $cls)->greet($sock)
57 my $tot = prototype $cb;
58 my ($nreq, undef) = split(/;/, $tot);
59 $nreq = ($nreq =~ tr/$//) - 1;
60 $tot = ($tot =~ tr/$//) - 1;
61 ($argc <= $tot && $argc >= $nreq);
64 # returns 1 if we can continue, 0 if not due to buffered writes or disconnect
65 sub process_line ($$) {
67 my ($req, @args) = split(/[ \t]+/, $l);
68 return 1 unless defined($req); # skip blank line
69 $req = $self->can('cmd_'.lc($req)) //
70 return $self->write(\"500 command not recognized\r\n");
71 return $self->write(\r501) unless args_ok($req, scalar @args);
72 my $res = eval { $req->($self, @args) };
74 if ($err && $self->{sock}) {
77 err($self, 'error from: %s (%s)', $l, $err);
78 $res = \"503 program fault - command not performed\r\n";
80 defined($res) ? $self->write($res) : 0;
83 # The keyword argument is not used (rfc3977 5.2.2)
84 sub cmd_capabilities ($;$) {
85 my ($self, undef) = @_;
86 my $res = $CAPABILITIES;
87 if (!$self->{sock}->can('accept_SSL') &&
88 $self->{nntpd}->{ssl_ctx_opt}) {
89 $res .= "STARTTLS\r\n";
95 my ($self, $arg) = @_;
96 uc($arg) eq 'READER' ? \"201 Posting prohibited\r\n" : \r501;
99 sub cmd_slave ($) { \"202 slave status noted\r\n" }
101 sub cmd_xgtitle ($;$) {
102 my ($self, $wildmat) = @_;
103 $self->msg_more("282 list of groups and descriptions follows\r\n");
104 list_newsgroups($self, $wildmat);
107 sub list_overview_fmt ($) { $OVERVIEW_FMT }
109 sub list_headers ($;$) { $LIST_HEADERS }
111 sub names2ibx ($;$) {
112 my ($self, $names) = @_;
113 my $groups = $self->{nntpd}->{pi_cfg}->{-by_newsgroup};
114 if ($names) { # modify arrayref in-place
115 $_ = $groups->{$_} for @$names;
116 $names; # now an arrayref of ibx
118 my @ret = map { $groups->{$_} } @{$self->{nntpd}->{groupnames}};
123 sub list_active_i { # "LIST ACTIVE" and also just "LIST" (no args)
124 my ($self, $ibxs) = @_;
125 my @window = splice(@$ibxs, 0, 1000);
126 emit_group_lines($self, \@window);
127 scalar @$ibxs; # continue if there's more
130 sub list_active ($;$) { # called by cmd_list
131 my ($self, $wildmat) = @_;
132 wildmat2re($wildmat);
133 my @names = grep(/$wildmat/, @{$self->{nntpd}->{groupnames}});
134 $self->long_response(\&list_active_i, names2ibx($self, \@names));
137 sub list_active_times_i {
138 my ($self, $ibxs) = @_;
139 my @window = splice(@$ibxs, 0, 1000);
140 $self->msg_more(join('', map {
141 my $c = eval { $_->uidvalidity } // time;
142 "$_->{newsgroup} $c <$_->{-primary_address}>\r\n";
144 scalar @$ibxs; # continue if there's more
147 sub list_active_times ($;$) { # called by cmd_list
148 my ($self, $wildmat) = @_;
149 wildmat2re($wildmat);
150 my @names = grep(/$wildmat/, @{$self->{nntpd}->{groupnames}});
151 $self->long_response(\&list_active_times_i, names2ibx($self, \@names));
154 sub list_newsgroups_i {
155 my ($self, $ibxs) = @_;
156 my @window = splice(@$ibxs, 0, 1000);
157 $self->msg_more(join('', map {
158 "$_->{newsgroup} ".$_->description."\r\n"
160 scalar @$ibxs; # continue if there's more
163 sub list_newsgroups ($;$) { # called by cmd_list
164 my ($self, $wildmat) = @_;
165 wildmat2re($wildmat);
166 my @names = grep(/$wildmat/, @{$self->{nntpd}->{groupnames}});
167 $self->long_response(\&list_newsgroups_i, names2ibx($self, \@names));
170 # LIST SUBSCRIPTIONS, DISTRIB.PATS are not supported
171 sub cmd_list ($;$$) {
172 my ($self, @args) = @_;
174 my $arg = shift @args;
175 $arg =~ tr/A-Z./a-z_/;
176 my $ret = $arg eq 'active';
178 $arg = $self->can($arg);
179 return r501 unless $arg && args_ok($arg, scalar @args);
180 $self->msg_more("215 information follows\r\n");
181 $arg->($self, @args);
183 $self->msg_more("215 list of newsgroups follows\r\n");
184 $self->long_response(\&list_active_i, names2ibx($self));
188 sub listgroup_range_i {
189 my ($self, $beg, $end) = @_;
190 my $r = $self->{ibx}->mm(1)->msg_range($beg, $end, 'num');
191 scalar(@$r) or return;
192 $self->msg_more(join("\r\n", @$r, ''));
196 sub listgroup_all_i {
197 my ($self, $num) = @_;
198 my $ary = $self->{ibx}->over(1)->ids_after($num);
199 scalar(@$ary) or return;
200 $self->msg_more(join("\r\n", @$ary, ''));
204 sub cmd_listgroup ($;$$) {
205 my ($self, $group, $range) = @_;
206 if (defined $group) {
207 my $res = cmd_group($self, $group);
208 return $res if ref($res); # error if const strref
209 $self->msg_more($res);
211 $self->{ibx} or return \"412 no newsgroup selected\r\n";
212 if (defined $range) {
213 my $r = get_range($self, $range);
214 return $r unless ref $r;
215 $self->long_response(\&listgroup_range_i, @$r);
216 } else { # grab every article number
217 $self->long_response(\&listgroup_all_i, \(my $num = 0));
221 sub parse_time ($$;$) {
222 my ($date, $time, $gmt) = @_;
223 my ($hh, $mm, $ss) = unpack('A2A2A2', $time);
225 $gmt =~ /\A(?:UTC|GMT)\z/i or die "GM invalid: $gmt";
228 my ($YYYY, $MM, $DD);
229 if (length($date) == 8) { # RFC 3977 allows YYYYMMDD
230 ($YYYY, $MM, $DD) = unpack('A4A2A2', $date);
231 } else { # legacy clients send YYMMDD
233 ($YY, $MM, $DD) = unpack('A2A2A2', $date);
234 my @now = $gmt ? gmtime : localtime;
235 my $cur_year = $now[5] + 1900;
236 my $cur_cent = int($cur_year / 100) * 100;
237 $YYYY = (($YY + $cur_cent) > $cur_year) ?
238 ($YY + 1900) : ($YY + $cur_cent);
241 timegm($ss, $mm, $hh, $DD, $MM - 1, $YYYY);
243 timelocal($ss, $mm, $hh, $DD, $MM - 1, $YYYY);
247 sub emit_group_lines {
248 my ($self, $ibxs) = @_;
250 my $ALL = $self->{nntpd}->{pi_cfg}->ALL;
251 my $misc = $ALL->misc if $ALL;
253 for my $ibx (@$ibxs) {
254 $misc ? $misc->inbox_data($ibx) :
255 delete(@$ibx{qw(-art_min -art_max)});
256 ($min, $max) = ($ibx->art_min, $ibx->art_max);
257 $buf .= "$ibx->{newsgroup} $max $min n\r\n";
259 $self->msg_more($buf);
263 my ($self, $ts, $ibxs) = @_;
264 my @window = splice(@$ibxs, 0, 1000);
265 @window = grep { (eval { $_->uidvalidity } // 0) > $ts } @window;
266 emit_group_lines($self, \@window);
267 scalar @$ibxs; # any more?
270 sub cmd_newgroups ($$$;$$) {
271 my ($self, $date, $time, $gmt, $dists) = @_;
272 my $ts = eval { parse_time($date, $time, $gmt) };
276 $self->msg_more("231 list of new newsgroups follows\r\n");
277 $self->long_response(\&newgroups_i, $ts, names2ibx($self));
280 sub wildmat2re (;$) {
281 return $_[0] = qr/.*/ if (!defined $_[0] || $_[0] eq '*');
286 $tmp =~ s#(?<!\\)\[(.+)(?<!\\)\]#
288 my $key = sha1_hex($orig . $salt);
289 $orig =~ s/([^\w\-])+/\Q$1/g;
293 my %map = ('*' => '.*', '?' => '.' );
294 $tmp =~ s#(?<!\\)([^\w\\])#$map{$1} || "\Q$1"#ge;
296 $tmp =~ s#([a-f0-9]{40})#
297 my $orig = $keep{$1};
298 defined $orig ? $orig : $1;
301 $_[0] = qr/\A$tmp\z/;
305 return $_[0] = qr/\A\z/ unless defined $_[0];
306 my %map = ('*' => '.*', ',' => '|');
307 $_[0] =~ s!(.)!$map{$1} || "\Q$1"!ge;
308 $_[0] = qr/\A(?:$_[0])\z/;
312 my ($self, $ibxs, $ts, $prev) = @_;
313 if (my $over = $ibxs->[0]->over) {
314 my $msgs = $over->query_ts($ts, $$prev);
316 $self->msg_more(join('', map {
319 $$prev = $msgs->[-1]->{num};
320 return 1; # continue on current group
324 if (@$ibxs) { # continue onto next newsgroup
327 } else { # all done, break out of the long_response
332 sub cmd_newnews ($$$$;$$) {
333 my ($self, $newsgroups, $date, $time, $gmt, $dists) = @_;
334 my $ts = eval { parse_time($date, $time, $gmt) };
336 $self->msg_more("230 list of new articles by message-id follows\r\n");
337 my ($keep, $skip) = split(/!/, $newsgroups, 2);
340 my @names = grep(/$keep/, @{$self->{nntpd}->{groupnames}});
341 @names = grep(!/$skip/, @names);
342 return \".\r\n" unless scalar(@names);
344 $self->long_response(\&newnews_i, names2ibx($self, \@names),
349 my ($self, $group) = @_;
350 my $nntpd = $self->{nntpd};
351 my $ibx = $nntpd->{pi_cfg}->{-by_newsgroup}->{$group} or
352 return \"411 no such news group\r\n";
356 my ($min, $max) = $ibx->mm(1)->minmax;
357 $self->{article} = $min;
358 my $est_size = $max - $min;
359 "211 $est_size $min $max $group\r\n";
362 sub article_adj ($$) {
363 my ($self, $off) = @_;
364 my $ibx = $self->{ibx} // return \"412 no newsgroup selected\r\n";
365 my $n = $self->{article} //
366 return \"420 no current article has been selected\r\n";
369 my $mid = $ibx->mm(1)->mid_for($n) // do {
370 $n = $off > 0 ? 'next' : 'previous';
371 return "421 no $n article in this group\r\n";
373 $self->{article} = $n;
374 "223 $n <$mid> article retrieved - request text separately\r\n";
377 sub cmd_next ($) { article_adj($_[0], 1) }
378 sub cmd_last ($) { article_adj($_[0], -1) }
380 # We want to encourage using email and CC-ing everybody involved to avoid
381 # the single-point-of-failure a single server provides.
384 my $ibx = $self->{ibx};
385 $ibx ? "440 mailto:$ibx->{-primary_address} to post\r\n"
386 : \"440 posting not allowed\r\n"
391 $self->write(\"205 closing connection - goodbye!\r\n");
396 sub xref_by_tc ($$$) {
397 my ($xref, $pi_cfg, $smsg) = @_;
398 my $by_addr = $pi_cfg->{-by_addr};
399 my $mid = $smsg->{mid};
400 for my $f (qw(to cc)) {
402 $by_addr->{lc($_)} // ()
403 } (PublicInbox::Address::emails($smsg->{$f} // ''));
404 for my $ibx (@ibxs) {
405 $xref->{$ibx->{newsgroup}} //=
406 $ibx->mm(1)->num_for($mid);
412 my ($self, $cur_ibx, $smsg) = @_;
413 my $nntpd = $self->{nntpd};
414 my $cur_ng = $cur_ibx->{newsgroup};
416 if (my $ALL = $nntpd->{pi_cfg}->ALL) {
417 $xref = $ALL->nntp_xref_for($cur_ibx, $smsg);
418 xref_by_tc($xref, $nntpd->{pi_cfg}, $smsg);
420 $xref = { $cur_ng => $smsg->{num} };
421 my $mid = $smsg->{mid};
422 for my $ibx (values %{$nntpd->{pi_cfg}->{-by_newsgroup}}) {
423 $xref->{$ibx->{newsgroup}} //=
424 $ibx->mm(1)->num_for($mid);
427 my $ret = "$nntpd->{servername} $cur_ng:".delete($xref->{$cur_ng});
428 for my $ng (sort keys %$xref) {
429 my $num = $xref->{$ng} // next;
435 sub set_nntp_headers ($$) {
436 my ($hdr, $smsg) = @_;
437 my ($mid) = $smsg->{mid};
439 # leafnode (and maybe other NNTP clients) have trouble dealing
440 # with v2 messages which have multiple Message-IDs (either due
441 # to our own content-based dedupe or buggy git-send-email versions).
442 my @mids = $hdr->header_raw('Message-ID');
443 if (scalar(@mids) > 1) {
445 $hdr->header_set('Message-ID', $mid0);
446 my @alt = $hdr->header_raw('X-Alt-Message-ID');
447 my %seen = map { $_ => 1 } (@alt, $mid0);
448 push(@alt, grep { !$seen{$_}++ } @mids);
449 $hdr->header_set('X-Alt-Message-ID', @alt);
452 # clobber some existing headers
453 my $ibx = $smsg->{-ibx};
454 my $xref = xref($smsg->{nntp}, $ibx, $smsg);
455 $hdr->header_set('Xref', $xref);
458 my ($server_name, $newsgroups) = split(/ /, $xref, 2);
459 $newsgroups =~ s/:[0-9]+\b//g; # drop NNTP article numbers
460 $newsgroups =~ tr/ /,/;
461 $hdr->header_set('Newsgroups', $newsgroups);
463 # *something* here is required for leafnode, try to follow
465 $hdr->header_set('Path', $server_name . '!not-for-mail');
468 sub art_lookup ($$$) {
469 my ($self, $art, $code) = @_;
473 if ($art =~ /\A[0-9]+\z/) {
474 $err = \"423 no such article number in this group\r\n";
477 } elsif ($art =~ $ONE_MSGID) {
478 ($ibx, $n) = mid_lookup($self, $1);
485 $err = \"420 no current article has been selected\r\n";
486 $n = $self->{article} // return $err;
488 $ibx = $self->{ibx} or
489 return \"412 no newsgroup has been selected\r\n";
492 my $smsg = $ibx->over(1)->get_art($n) or return $err;
493 $smsg->{-ibx} = $ibx;
494 if ($code == 223) { # STAT
496 "223 $n <$smsg->{mid}> article retrieved - " .
497 "request text separately\r\n";
498 } else { # HEAD | BODY | ARTICLE
499 $smsg->{nntp} = $self;
500 $smsg->{nntp_code} = $code;
501 set_art($self, $art);
502 # this dereferences to `undef'
503 ${ibx_async_cat($ibx, $smsg->{blob}, \&blob_cb, $smsg)};
507 sub msg_body_write ($$) {
508 my ($self, $msg) = @_;
510 # these can momentarily double the memory consumption :<
511 $$msg =~ s/^\./../smg;
512 $$msg =~ s/(?<!\r)\n/\r\n/sg; # Alpine barfs without this
513 $$msg .= "\r\n" unless substr($$msg, -2, 2) eq "\r\n";
514 $self->msg_more($$msg);
518 my ($self, $art) = @_;
519 $self->{article} = $art if defined $art && $art =~ /\A[0-9]+\z/;
522 sub msg_hdr_write ($$) {
523 my ($eml, $smsg) = @_;
524 set_nntp_headers($eml, $smsg);
526 my $hdr = $eml->{hdr} // \(my $x = '');
527 # fixup old bug from import (pre-a0c07cba0e5d8b6a)
528 $$hdr =~ s/\A[\r\n]*From [^\r\n]*\r?\n//s;
529 $$hdr =~ s/(?<!\r)\n/\r\n/sg; # Alpine barfs without this
531 # for leafnode compatibility, we need to ensure Message-ID headers
532 # are only a single line.
533 $$hdr =~ s/^(Message-ID:)[ \t]*\r\n[ \t]+([^\r]+)\r\n/$1 $2\r\n/igsm;
534 $smsg->{nntp}->msg_more($$hdr);
537 sub blob_cb { # called by git->cat_async via ibx_async_cat
538 my ($bref, $oid, $type, $size, $smsg) = @_;
539 my $self = $smsg->{nntp};
540 my $code = $smsg->{nntp_code};
541 if (!defined($oid)) {
542 # it's possible to have TOCTOU if an admin runs
543 # public-inbox-(edit|purge), just move onto the next message
544 warn "E: $smsg->{blob} missing in $smsg->{-ibx}->{inboxdir}\n";
545 return $self->requeue;
546 } elsif ($smsg->{blob} ne $oid) {
548 die "BUG: $smsg->{blob} != $oid";
550 my $r = "$code $smsg->{num} <$smsg->{mid}> article retrieved - ";
551 my $eml = PublicInbox::Eml->new($bref);
553 $self->msg_more($r .= "head and body follow\r\n");
554 msg_hdr_write($eml, $smsg);
555 $self->msg_more("\r\n");
556 msg_body_write($self, $bref);
557 } elsif ($code == 221) {
558 $self->msg_more($r .= "head follows\r\n");
559 msg_hdr_write($eml, $smsg);
560 } elsif ($code == 222) {
561 $self->msg_more($r .= "body follows\r\n");
562 msg_body_write($self, $bref);
565 die "BUG: bad code: $r";
567 $self->write(\".\r\n"); # flushes (includes ->dflush)
571 sub cmd_article ($;$) {
572 my ($self, $art) = @_;
573 art_lookup($self, $art, 220);
577 my ($self, $art) = @_;
578 art_lookup($self, $art, 221);
582 my ($self, $art) = @_;
583 art_lookup($self, $art, 222);
587 my ($self, $art) = @_;
588 art_lookup($self, $art, 223); # art may be msgid
591 sub cmd_ihave ($) { \"435 article not wanted - do not send it\r\n" }
593 sub cmd_date ($) { '111 '.strftime('%Y%m%d%H%M%S', gmtime(time))."\r\n" }
595 sub cmd_help ($) { \"100 help text follows\r\n.\r\n" }
597 # returns a ref on success
599 my ($self, $range) = @_;
600 my $ibx = $self->{ibx} //
601 return "412 no news group has been selected\r\n";
602 $range // return "420 No article(s) selected\r\n";
604 my ($min, $max) = $ibx->mm(1)->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 $beg > $end ? "420 No article(s) selected\r\n" : [ \$beg, $end ];
619 sub long_response_done { $_[0]->write(\".\r\n") } # overrides superclass
621 sub hdr_msgid_range_i {
622 my ($self, $beg, $end) = @_;
623 my $r = $self->{ibx}->mm(1)->msg_range($beg, $end);
625 $self->msg_more(join('', map { "$_->[0] <$_->[1]>\r\n" } @$r));
629 sub hdr_message_id ($$$) { # optimize XHDR Message-ID [range] for slrnpull.
630 my ($self, $xhdr, $range) = @_;
632 if (defined $range && $range =~ $ONE_MSGID) {
633 my ($ibx, $n) = mid_lookup($self, $1);
634 return r430 unless $n;
635 hdr_mid_response($self, $xhdr, $ibx, $n, $range, $range);
636 } else { # numeric range
637 $range = $self->{article} unless defined $range;
638 my $r = get_range($self, $range);
639 return $r unless ref $r;
640 $self->msg_more($xhdr ? r221 : r225);
641 $self->long_response(\&hdr_msgid_range_i, @$r);
645 sub mid_lookup ($$) {
646 my ($self, $mid) = @_;
647 my $cur_ibx = $self->{ibx};
649 my $n = $cur_ibx->mm(1)->num_for($mid);
650 return ($cur_ibx, $n) if defined $n;
652 my $pi_cfg = $self->{nntpd}->{pi_cfg};
653 if (my $ALL = $pi_cfg->ALL) {
655 while (my $smsg = $ALL->over->next_by_mid($mid, \$id, \$prev)) {
656 my $xr3 = $ALL->over->get_xref3($smsg->{num});
657 if (my @x = grep(/:$smsg->{blob}\z/, @$xr3)) {
658 my ($ngname, $xnum) = split(/:/, $x[0]);
659 my $ibx = $pi_cfg->{-by_newsgroup}->{$ngname};
660 return ($ibx, $xnum) if $ibx;
661 # fall through to trying all xref3s
664 W: xref3 missing for <$mid> ($smsg->{blob}) in $ALL->{topdir}, -extindex bug?
669 my ($ngname, $xnum) = split(/:/, $x);
670 my $ibx = $pi_cfg->{-by_newsgroup}->{$ngname};
671 return ($ibx, $xnum) if $ibx;
672 warn "W: `$ngname' does not exist for #$xnum\n";
675 # no warning here, $mid is just invalid
676 } else { # slow path for non-ALL users
677 for my $ibx (values %{$pi_cfg->{-by_newsgroup}}) {
678 next if defined $cur_ibx && $ibx eq $cur_ibx;
679 my $n = $ibx->mm(1)->num_for($mid);
680 return ($ibx, $n) if defined $n;
687 my ($self, $beg, $end) = @_;
688 my $ibx = $self->{ibx};
689 my $msgs = $ibx->over(1)->query_xover($$beg, $end);
690 scalar(@$msgs) or return;
691 $$beg = $msgs->[-1]->{num} + 1;
692 $self->msg_more(join('', map {
693 "$_->{num} ".xref($self, $ibx, $_) . "\r\n";
698 sub hdr_xref ($$$) { # optimize XHDR Xref [range] for rtin
699 my ($self, $xhdr, $range) = @_;
701 if (defined $range && $range =~ $ONE_MSGID) {
703 my ($ibx, $n) = mid_lookup($self, $mid);
704 return r430 unless $n;
705 my $smsg = $ibx->over(1)->get_art($n) or return;
706 hdr_mid_response($self, $xhdr, $ibx, $n, $range,
707 xref($self, $ibx, $smsg));
708 } else { # numeric range
709 $range = $self->{article} unless defined $range;
710 my $r = get_range($self, $range);
711 return $r unless ref $r;
712 $self->msg_more($xhdr ? r221 : r225);
713 $self->long_response(\&xref_range_i, @$r);
717 sub over_header_for {
718 my ($ibx, $num, $field) = @_;
719 my $smsg = $ibx->over(1)->get_art($num) or return;
720 return PublicInbox::Smsg::date($smsg) if $field eq 'date';
725 my ($self, $beg, $end, $field) = @_;
726 my $msgs = $self->{ibx}->over(1)->query_xover($$beg, $end);
727 scalar(@$msgs) or return;
730 # ->{$field} is faster than ->$field invocations, so favor that.
731 if ($field eq 'date') {
733 $tmp .= "$s->{num} ".PublicInbox::Smsg::date($s)."\r\n"
737 $tmp .= "$s->{num} $s->{$field}\r\n";
741 $self->msg_more($tmp);
742 $$beg = $msgs->[-1]->{num} + 1;
745 sub hdr_smsg ($$$$) {
746 my ($self, $xhdr, $field, $range) = @_;
747 if (defined $range && $range =~ $ONE_MSGID) {
748 my ($ibx, $n) = mid_lookup($self, $1);
749 return r430 unless defined $n;
750 my $v = over_header_for($ibx, $n, $field);
751 hdr_mid_response($self, $xhdr, $ibx, $n, $range, $v);
752 } else { # numeric range
753 $range = $self->{article} unless defined $range;
754 my $r = get_range($self, $range);
755 return $r unless ref $r;
756 $self->msg_more($xhdr ? r221 : r225);
757 $self->long_response(\&smsg_range_i, @$r, $field);
762 my ($self, $xhdr, $header, $range) = @_;
763 my $sub = lc $header;
764 if ($sub eq 'message-id') {
765 hdr_message_id($self, $xhdr, $range);
766 } elsif ($sub eq 'xref') {
767 hdr_xref($self, $xhdr, $range);
768 } elsif ($sub =~ /\A(?:subject|references|date|from|to|cc|
770 hdr_smsg($self, $xhdr, $sub, $range);
771 } elsif ($sub =~ /\A:(bytes|lines)\z/) {
772 hdr_smsg($self, $xhdr, $1, $range);
774 $xhdr ? (r221.".\r\n") : "503 HDR not permitted on $header\r\n";
780 my ($self, $header, $range) = @_;
781 do_hdr($self, 0, $header, $range);
785 sub cmd_xhdr ($$;$) {
786 my ($self, $header, $range) = @_;
787 do_hdr($self, 1, $header, $range);
790 sub hdr_mid_prefix ($$$$$) {
791 my ($self, $xhdr, $ibx, $n, $mid) = @_;
792 return $mid if $xhdr;
794 # HDR for RFC 3977 users
795 if (my $cur_ibx = $self->{ibx}) {
796 ($cur_ibx eq $ibx) ? $n : '0';
802 sub hdr_mid_response ($$$$$$) {
803 my ($self, $xhdr, $ibx, $n, $mid, $v) = @_;
804 $self->write(($xhdr ? r221.$mid :
805 r225.hdr_mid_prefix($self, $xhdr, $ibx, $n, $mid)) .
811 my ($self, $beg, $end) = @_;
812 my $h = over_header_for($self->{ibx}, $$beg, 'references');
813 $self->msg_more("$$beg $h\r\n") if defined($h);
817 sub cmd_xrover ($;$) {
818 my ($self, $range) = @_;
819 my $ibx = $self->{ibx} or return \"412 no newsgroup selected\r\n";
820 (defined $range && $range =~ /[<>]/) and
821 return \"420 No article(s) selected\r\n"; # no message IDs
823 $range = $self->{article} unless defined $range;
824 my $r = get_range($self, $range);
825 return $r unless ref $r;
826 $self->msg_more("224 Overview information follows\r\n");
827 $self->long_response(\&xrover_i, @$r);
830 sub over_line ($$$) {
831 my ($self, $ibx, $smsg) = @_;
832 # n.b. field access and procedural calls can be
833 # 10%-15% faster than OO method calls:
834 my $s = join("\t", $smsg->{num},
837 PublicInbox::Smsg::date($smsg),
842 "Xref: " . xref($self, $ibx, $smsg));
848 my ($self, $range) = @_;
849 if ($range && $range =~ $ONE_MSGID) {
850 my ($ibx, $n) = mid_lookup($self, $1);
851 defined $n or return r430;
852 my $smsg = $ibx->over(1)->get_art($n) or return r430;
854 "224 Overview information follows (multi-line)\r\n");
856 # Only set article number column if it's the current group
858 my $cur_ibx = $self->{ibx};
859 if (!$cur_ibx || $cur_ibx ne $ibx) {
860 # set {-orig_num} for nntp_xref_for
861 $smsg->{-orig_num} = $smsg->{num};
864 over_line($self, $ibx, $smsg).".\r\n";
866 cmd_xover($self, $range);
871 my ($self, $beg, $end) = @_;
872 my $ibx = $self->{ibx};
873 my $msgs = $ibx->over(1)->query_xover($$beg, $end);
874 my $nr = scalar @$msgs or return;
877 $self->msg_more(join('', map {
878 over_line($self, $ibx, $_);
880 $$beg = $msgs->[-1]->{num} + 1;
883 sub cmd_xover ($;$) {
884 my ($self, $range) = @_;
885 $range = $self->{article} unless defined $range;
886 my $r = get_range($self, $range);
887 return $r unless ref $r;
888 my ($beg, $end) = @$r;
890 "224 Overview information follows for $$beg to $end\r\n");
891 $self->long_response(\&xover_i, @$r);
894 sub cmd_starttls ($) {
897 (($self->{sock} // return)->can('stop_SSL') || $self->compressed) and
899 $self->{nntpd}->{ssl_ctx_opt} or
900 return \"580 can not initiate TLS negotiation\r\n";
901 $self->write(\"382 Continue with TLS negotiation\r\n");
902 PublicInbox::TLS::start($self->{sock}, $self->{nntpd});
903 $self->requeue if PublicInbox::DS::accept_tls_step($self);
908 sub cmd_compress ($$) {
909 my ($self, $alg) = @_;
910 return "503 Only DEFLATE is supported\r\n" if uc($alg) ne 'DEFLATE';
911 return r502 if $self->compressed;
912 PublicInbox::NNTPdeflate->enable($self) or return
913 \"403 Unable to activate compression\r\n";
914 PublicInbox::DS::write($self, \"206 Compression active\r\n");
920 my ($self, $mid) = @_;
921 return r501 unless $mid =~ $ONE_MSGID;
924 my $pi_cfg = $self->{nntpd}->{pi_cfg};
925 my $groups = $pi_cfg->{-by_newsgroup};
926 if (my $ALL = $pi_cfg->ALL) {
927 my ($id, $prev, %seen);
928 while (my $smsg = $ALL->over->next_by_mid($mid, \$id, \$prev)) {
929 my $xr3 = $ALL->over->get_xref3($smsg->{num});
931 my ($ngname, $n) = split(/:/, $x);
933 if ($groups->{$ngname} && !$seen{$x}++) {
938 } else { # slow path, no point in using long_response
939 for my $ibx (values %$groups) {
940 my $n = $ibx->mm(1)->num_for($mid) // next;
941 push @paths, "$ibx->{newsgroup}/$n";
944 return \"430 no such article on server\r\n" unless @paths;
945 '223 '.join(' ', sort(@paths))."\r\n";
949 my ($self, $fmt, @args) = @_;
950 printf { $self->{nntpd}->{err} } $fmt."\n", @args;
954 my ($self, $fmt, @args) = @_;
955 printf { $self->{nntpd}->{out} } $fmt."\n", @args;
958 # callback used by PublicInbox::DS for any (e)poll (in/out/hup/err)
961 local $SIG{__WARN__} = $self->{nntpd}->{warn_cb};
962 return unless $self->flush_write && $self->{sock} && !$self->{long_cb};
964 # only read more requests if we've drained the write buffer,
965 # otherwise we can be buffering infinitely w/o backpressure
967 my $rbuf = $self->{rbuf} // \(my $x = '');
968 my $line = index($$rbuf, "\n");
970 return $self->close if length($$rbuf) >= LINE_MAX;
971 $self->do_read($rbuf, LINE_MAX, length($$rbuf)) or return;
972 $line = index($$rbuf, "\n");
974 $line = substr($$rbuf, 0, $line + 1, '');
975 $line =~ s/\r?\n\z//s;
976 return $self->close if $line =~ /[[:cntrl:]]/s;
979 my $fd = fileno($self->{sock});
980 my $r = eval { process_line($self, $line) };
981 my $pending = $self->{wbuf} ? ' pending' : '';
982 out($self, "[$fd] %s - %0.6f$pending", $line, now() - $t0);
983 return $self->close if $r < 0;
984 $self->rbuf_idle($rbuf);
986 # maybe there's more pipelined data, or we'll have
987 # to register it for socket-readiness notifications
988 $self->requeue unless $pending;
991 sub busy { # for graceful shutdown in PublicInbox::Daemon:
993 defined($self->{rbuf}) || defined($self->{wbuf})
996 package PublicInbox::NNTPdeflate;
997 use PublicInbox::DSdeflate;
998 our @ISA = qw(PublicInbox::DSdeflate PublicInbox::NNTP);