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;
20 use PublicInbox::Address;
23 LINE_MAX => 512, # RFC 977 section 2.3
24 r501 => '501 command syntax error',
25 r502 => '502 Command unavailable',
26 r221 => '221 Header follows',
27 r224 => '224 Overview information follows (multi-line)',
28 r225 => '225 Headers follow (multi-line)',
29 r430 => '430 No article with that message-id',
31 use PublicInbox::Syscall qw(EPOLLIN EPOLLONESHOT);
33 my $ONE_MSGID = qr/\A$MID_EXTRACT\z/;
34 my @OVERVIEW = qw(Subject From Date Message-ID References);
35 my $OVERVIEW_FMT = join(":\r\n", @OVERVIEW, qw(Bytes Lines), '') .
37 my $LIST_HEADERS = join("\r\n", @OVERVIEW,
38 qw(:bytes :lines Xref To Cc)) . "\r\n.";
39 my $CAPABILITIES = <<"";
40 101 Capability list:\r
44 LIST ACTIVE ACTIVE.TIMES NEWSGROUPS OVERVIEW.FMT\r
49 sub greet ($) { $_[0]->write($_[0]->{nntpd}->{greet}) };
52 my ($class, $sock, $nntpd) = @_;
53 my $self = bless { nntpd => $nntpd }, $class;
56 if ($sock->can('accept_SSL') && !$sock->accept_SSL) {
57 return CORE::close($sock) if $! != EAGAIN;
58 $ev = PublicInbox::TLS::epollbit() or return CORE::close($sock);
59 $wbuf = [ \&PublicInbox::DS::accept_tls_step, \&greet ];
61 $self->SUPER::new($sock, $ev | EPOLLONESHOT);
63 $self->{wbuf} = $wbuf;
67 $self->update_idle_time;
73 my $tot = prototype $cb;
74 my ($nreq, undef) = split(';', $tot);
75 $nreq = ($nreq =~ tr/$//) - 1;
76 $tot = ($tot =~ tr/$//) - 1;
77 ($argc <= $tot && $argc >= $nreq);
80 # returns 1 if we can continue, 0 if not due to buffered writes or disconnect
81 sub process_line ($$) {
83 my ($req, @args) = split(/[ \t]+/, $l);
84 return 1 unless defined($req); # skip blank line
85 $req = $self->can('cmd_'.lc($req));
86 return res($self, '500 command not recognized') unless $req;
87 return res($self, r501) unless args_ok($req, scalar @args);
89 my $res = eval { $req->($self, @args) };
91 if ($err && $self->{sock}) {
94 err($self, 'error from: %s (%s)', $l, $err);
95 $res = '503 program fault - command not performed';
97 defined($res) ? res($self, $res) : 0;
100 # The keyword argument is not used (rfc3977 5.2.2)
101 sub cmd_capabilities ($;$) {
102 my ($self, undef) = @_;
103 my $res = $CAPABILITIES;
104 if (!$self->{sock}->can('accept_SSL') &&
105 $self->{nntpd}->{accept_tls}) {
106 $res .= "STARTTLS\r\n";
112 my ($self, $arg) = @_;
113 uc($arg) eq 'READER' ? '201 Posting prohibited' : r501;
116 sub cmd_slave ($) { '202 slave status noted' }
118 sub cmd_xgtitle ($;$) {
119 my ($self, $wildmat) = @_;
120 more($self, '282 list of groups and descriptions follows');
121 list_newsgroups($self, $wildmat);
124 sub list_overview_fmt ($) { $OVERVIEW_FMT }
126 sub list_headers ($;$) { $LIST_HEADERS }
128 sub list_active_i { # "LIST ACTIVE" and also just "LIST" (no args)
129 my ($self, $groupnames) = @_;
130 my @window = splice(@$groupnames, 0, 100) or return 0;
132 my $groups = $self->{nntpd}->{pi_config}->{-by_newsgroup};
133 for my $ngname (@window) {
134 $ibx = $groups->{$ngname} and group_line($self, $ibx);
136 scalar(@$groupnames); # continue if there's more
139 sub list_active ($;$) { # called by cmd_list
140 my ($self, $wildmat) = @_;
141 wildmat2re($wildmat);
142 long_response($self, \&list_active_i, [
143 grep(/$wildmat/, @{$self->{nntpd}->{groupnames}}) ]);
146 sub list_active_times_i {
147 my ($self, $groupnames) = @_;
148 my @window = splice(@$groupnames, 0, 100) or return 0;
149 my $groups = $self->{nntpd}->{pi_config}->{-by_newsgroup};
150 for my $ngname (@window) {
151 my $ibx = $groups->{$ngname} or next;
152 my $c = eval { $ibx->uidvalidity } // time;
153 more($self, "$ngname $c <$ibx->{-primary_address}>");
155 scalar(@$groupnames); # continue if there's more
158 sub list_active_times ($;$) { # called by cmd_list
159 my ($self, $wildmat) = @_;
160 wildmat2re($wildmat);
161 long_response($self, \&list_active_times_i, [
162 grep(/$wildmat/, @{$self->{nntpd}->{groupnames}}) ]);
165 sub list_newsgroups_i {
166 my ($self, $groupnames) = @_;
167 my @window = splice(@$groupnames, 0, 100) or return 0;
168 my $groups = $self->{nntpd}->{pi_config}->{-by_newsgroup};
170 for my $ngname (@window) {
171 $ibx = $groups->{$ngname} and
172 more($self, "$ngname ".$ibx->description);
174 scalar(@$groupnames); # continue if there's more
177 sub list_newsgroups ($;$) { # called by cmd_list
178 my ($self, $wildmat) = @_;
179 wildmat2re($wildmat);
180 long_response($self, \&list_newsgroups_i, [
181 grep(/$wildmat/, @{$self->{nntpd}->{groupnames}}) ]);
184 # LIST SUBSCRIPTIONS, DISTRIB.PATS are not supported
185 sub cmd_list ($;$$) {
186 my ($self, @args) = @_;
188 my $arg = shift @args;
189 $arg =~ tr/A-Z./a-z_/;
190 my $ret = $arg eq 'active';
192 $arg = $self->can($arg);
193 return r501 unless $arg && args_ok($arg, scalar @args);
194 more($self, '215 information follows');
195 $arg->($self, @args);
197 more($self, '215 list of newsgroups follows');
198 long_response($self, \&list_active_i, [ # copy array
199 @{$self->{nntpd}->{groupnames}} ]);
203 sub listgroup_range_i {
204 my ($self, $beg, $end) = @_;
205 my $r = $self->{ng}->mm->msg_range($beg, $end, 'num');
206 scalar(@$r) or return;
207 $self->msg_more(join('', map { "$_->[0]\r\n" } @$r));
211 sub listgroup_all_i {
212 my ($self, $num) = @_;
213 my $ary = $self->{ng}->mm->ids_after($num);
214 scalar(@$ary) or return;
215 more($self, join("\r\n", @$ary));
219 sub cmd_listgroup ($;$$) {
220 my ($self, $group, $range) = @_;
221 if (defined $group) {
222 my $res = cmd_group($self, $group);
223 return $res if ($res !~ /\A211 /);
226 $self->{ng} or return '412 no newsgroup selected';
227 if (defined $range) {
228 my $r = get_range($self, $range);
229 return $r unless ref $r;
230 long_response($self, \&listgroup_range_i, @$r);
231 } else { # grab every article number
232 long_response($self, \&listgroup_all_i, \(my $num = 0));
236 sub parse_time ($$;$) {
237 my ($date, $time, $gmt) = @_;
238 my ($hh, $mm, $ss) = unpack('A2A2A2', $time);
240 $gmt =~ /\A(?:UTC|GMT)\z/i or die "GM invalid: $gmt";
243 my ($YYYY, $MM, $DD);
244 if (bytes::length($date) == 8) { # RFC 3977 allows YYYYMMDD
245 ($YYYY, $MM, $DD) = unpack('A4A2A2', $date);
246 } else { # legacy clients send YYMMDD
248 ($YY, $MM, $DD) = unpack('A2A2A2', $date);
249 my @now = $gmt ? gmtime : localtime;
250 my $cur_year = $now[5] + 1900;
251 my $cur_cent = int($cur_year / 100) * 100;
252 $YYYY = (($YY + $cur_cent) > $cur_year) ?
253 ($YY + 1900) : ($YY + $cur_cent);
256 timegm($ss, $mm, $hh, $DD, $MM - 1, $YYYY);
258 timelocal($ss, $mm, $hh, $DD, $MM - 1, $YYYY);
262 sub group_line ($$) {
263 my ($self, $ng) = @_;
264 my ($min, $max) = $ng->mm->minmax;
265 more($self, "$ng->{newsgroup} $max $min n");
269 my ($self, $ts, $i, $groupnames) = @_;
271 my $groups = $self->{nntpd}->{pi_config}->{-by_newsgroup};
273 my $ngname = $groupnames->[$$i++] // return;
274 my $ibx = $groups->{$ngname} or next; # expired on reload
275 next unless (eval { $ibx->uidvalidity } // 0) > $ts;
276 group_line($self, $ibx);
281 sub cmd_newgroups ($$$;$$) {
282 my ($self, $date, $time, $gmt, $dists) = @_;
283 my $ts = eval { parse_time($date, $time, $gmt) };
287 more($self, '231 list of new newsgroups follows');
288 long_response($self, \&newgroups_i, $ts, \(my $i = 0),
289 $self->{nntpd}->{groupnames});
292 sub wildmat2re (;$) {
293 return $_[0] = qr/.*/ if (!defined $_[0] || $_[0] eq '*');
298 $tmp =~ s#(?<!\\)\[(.+)(?<!\\)\]#
300 my $key = sha1_hex($orig . $salt);
301 $orig =~ s/([^\w\-])+/\Q$1/g;
305 my %map = ('*' => '.*', '?' => '.' );
306 $tmp =~ s#(?<!\\)([^\w\\])#$map{$1} || "\Q$1"#ge;
308 $tmp =~ s#([a-f0-9]{40})#
309 my $orig = $keep{$1};
310 defined $orig ? $orig : $1;
313 $_[0] = qr/\A$tmp\z/;
317 return $_[0] = qr/\A\z/ unless defined $_[0];
318 my %map = ('*' => '.*', ',' => '|');
319 $_[0] =~ s!(.)!$map{$1} || "\Q$1"!ge;
320 $_[0] = qr/\A(?:$_[0])\z/;
324 my ($self, $names, $ts, $prev) = @_;
325 my $ngname = $names->[0];
326 if (my $ibx = $self->{nntpd}->{pi_config}->{-by_newsgroup}->{$ngname}) {
327 if (my $over = $ibx->over) {
328 my $msgs = $over->query_ts($ts, $$prev);
330 $self->msg_more(join('', map {
333 $$prev = $msgs->[-1]->{num};
334 return 1; # continue on current group
339 if (@$names) { # continue onto next newsgroup
342 } else { # all done, break out of the long_response
347 sub cmd_newnews ($$$$;$$) {
348 my ($self, $newsgroups, $date, $time, $gmt, $dists) = @_;
349 my $ts = eval { parse_time($date, $time, $gmt) };
351 more($self, '230 list of new articles by message-id follows');
352 my ($keep, $skip) = split('!', $newsgroups, 2);
355 my @names = grep(!/$skip/, grep(/$keep/,
356 @{$self->{nntpd}->{groupnames}}));
357 return '.' unless scalar(@names);
359 long_response($self, \&newnews_i, \@names, $ts, \$prev);
363 my ($self, $group) = @_;
364 my $nntpd = $self->{nntpd};
365 my $ibx = $nntpd->{pi_config}->{-by_newsgroup}->{$group} or
366 return '411 no such news group';
370 my ($min, $max) = $ibx->mm->minmax;
371 $self->{article} = $min;
372 my $est_size = $max - $min;
373 "211 $est_size $min $max $group";
376 sub article_adj ($$) {
377 my ($self, $off) = @_;
378 my $ng = $self->{ng} or return '412 no newsgroup selected';
380 my $n = $self->{article};
381 defined $n or return '420 no current article has been selected';
384 my $mid = $ng->mm->mid_for($n);
386 $n = $off > 0 ? 'next' : 'previous';
387 return "421 no $n article in this group";
389 $self->{article} = $n;
390 "223 $n <$mid> article retrieved - request text separately";
393 sub cmd_next ($) { article_adj($_[0], 1) }
394 sub cmd_last ($) { article_adj($_[0], -1) }
396 # We want to encourage using email and CC-ing everybody involved to avoid
397 # the single-point-of-failure a single server provides.
400 my $ng = $self->{ng};
401 $ng ? "440 mailto:$ng->{-primary_address} to post"
402 : '440 posting not allowed'
407 res($self, '205 closing connection - goodbye!');
412 sub header_append ($$$) {
413 my ($hdr, $k, $v) = @_;
414 my @v = $hdr->header_raw($k);
418 $hdr->header_set($k, @v, $v);
421 sub xref_by_tc ($$$) {
422 my ($xref, $pi_cfg, $smsg) = @_;
423 my $by_addr = $pi_cfg->{-by_addr};
424 my $mid = $smsg->{mid};
425 for my $f (qw(to cc)) {
427 $by_addr->{lc($_)} // ()
428 } (PublicInbox::Address::emails($smsg->{$f} // ''));
429 for my $ibx (@ibxs) {
430 my $ngname = $ibx->{newsgroup} // next;
431 next if defined $xref->{$ngname};
432 $xref->{$ngname} = eval { $ibx->mm->num_for($mid) };
438 my ($self, $cur_ibx, $smsg) = @_;
439 my $nntpd = $self->{nntpd};
440 my $cur_ng = $cur_ibx->{newsgroup};
442 if (my $ALL = $nntpd->{pi_config}->ALL) {
443 $xref = $ALL->nntp_xref_for($cur_ibx, $smsg);
444 xref_by_tc($xref, $nntpd->{pi_config}, $smsg);
446 $xref = { $cur_ng => $smsg->{num} };
447 my $mid = $smsg->{mid};
448 for my $ibx (values %{$nntpd->{pi_config}->{-by_newsgroup}}) {
449 next if defined($xref->{$ibx->{newsgroup}});
450 my $num = eval { $ibx->mm->num_for($mid) } // next;
451 $xref->{$ibx->{newsgroup}} = $num;
454 my $ret = "$nntpd->{servername} $cur_ng:".delete($xref->{$cur_ng});
455 $ret .= " $_:$xref->{$_}" for (sort keys %$xref);
459 sub set_nntp_headers ($$) {
460 my ($hdr, $smsg) = @_;
461 my ($mid) = $smsg->{mid};
463 # leafnode (and maybe other NNTP clients) have trouble dealing
464 # with v2 messages which have multiple Message-IDs (either due
465 # to our own content-based dedupe or buggy git-send-email versions).
466 my @mids = $hdr->header_raw('Message-ID');
467 if (scalar(@mids) > 1) {
469 $hdr->header_set('Message-ID', $mid0);
470 my @alt = $hdr->header_raw('X-Alt-Message-ID');
471 my %seen = map { $_ => 1 } (@alt, $mid0);
472 push(@alt, grep { !$seen{$_}++ } @mids);
473 $hdr->header_set('X-Alt-Message-ID', @alt);
476 # clobber some existing headers
477 my $ibx = $smsg->{-ibx};
478 my $xref = xref($smsg->{nntp}, $ibx, $smsg);
479 $hdr->header_set('Xref', $xref);
482 my ($server_name, $newsgroups) = split(/ /, $xref, 2);
483 $newsgroups =~ s/:[0-9]+\b//g; # drop NNTP article numbers
484 $newsgroups =~ tr/ /,/;
485 $hdr->header_set('Newsgroups', $newsgroups);
487 # *something* here is required for leafnode, try to follow
489 $hdr->header_set('Path', $server_name . '!not-for-mail');
491 header_append($hdr, 'List-Post', "<mailto:$ibx->{-primary_address}>");
492 if (my $url = $ibx->base_url) {
493 $mid = mid_escape($mid);
494 header_append($hdr, 'Archived-At', "<$url$mid/>");
495 header_append($hdr, 'List-Archive', "<$url>");
499 sub art_lookup ($$$) {
500 my ($self, $art, $code) = @_;
504 if ($art =~ /\A[0-9]+\z/) {
505 $err = '423 no such article number in this group';
508 } elsif ($art =~ $ONE_MSGID) {
509 ($ibx, $n) = mid_lookup($self, $1);
516 $err = '420 no current article has been selected';
517 $n = $self->{article} // return $err;
519 $ibx = $self->{ng} or
520 return '412 no newsgroup has been selected';
523 my $smsg = $ibx->over->get_art($n) or return $err;
524 $smsg->{-ibx} = $ibx;
525 if ($code == 223) { # STAT
527 "223 $n <$smsg->{mid}> article retrieved - " .
528 "request text separately";
529 } else { # HEAD | BODY | ARTICLE
530 $smsg->{nntp} = $self;
531 $smsg->{nntp_code} = $code;
532 set_art($self, $art);
533 # this dereferences to `undef'
534 ${git_async_cat($ibx->git, $smsg->{blob}, \&blob_cb, $smsg)};
538 sub msg_body_write ($$) {
539 my ($self, $msg) = @_;
541 # these can momentarily double the memory consumption :<
542 $$msg =~ s/^\./../smg;
543 $$msg =~ s/(?<!\r)\n/\r\n/sg; # Alpine barfs without this
544 $$msg .= "\r\n" unless $$msg =~ /\r\n\z/s;
545 $self->msg_more($$msg);
549 my ($self, $art) = @_;
550 $self->{article} = $art if defined $art && $art =~ /\A[0-9]+\z/;
553 sub msg_hdr_write ($$) {
554 my ($eml, $smsg) = @_;
555 set_nntp_headers($eml, $smsg);
557 my $hdr = $eml->{hdr} // \(my $x = '');
558 # fixup old bug from import (pre-a0c07cba0e5d8b6a)
559 $$hdr =~ s/\A[\r\n]*From [^\r\n]*\r?\n//s;
560 $$hdr =~ s/(?<!\r)\n/\r\n/sg; # Alpine barfs without this
562 # for leafnode compatibility, we need to ensure Message-ID headers
563 # are only a single line.
564 $$hdr =~ s/^(Message-ID:)[ \t]*\r\n[ \t]+([^\r]+)\r\n/$1 $2\r\n/igsm;
565 $smsg->{nntp}->msg_more($$hdr);
568 sub blob_cb { # called by git->cat_async via git_async_cat
569 my ($bref, $oid, $type, $size, $smsg) = @_;
570 my $self = $smsg->{nntp};
571 my $code = $smsg->{nntp_code};
572 if (!defined($oid)) {
573 # it's possible to have TOCTOU if an admin runs
574 # public-inbox-(edit|purge), just move onto the next message
575 warn "E: $smsg->{blob} missing in $smsg->{-ibx}->{inboxdir}\n";
576 return $self->requeue;
577 } elsif ($smsg->{blob} ne $oid) {
579 die "BUG: $smsg->{blob} != $oid";
581 my $r = "$code $smsg->{num} <$smsg->{mid}> article retrieved - ";
582 my $eml = PublicInbox::Eml->new($bref);
584 more($self, $r .= 'head and body follow');
585 msg_hdr_write($eml, $smsg);
586 $self->msg_more("\r\n");
587 msg_body_write($self, $bref);
588 } elsif ($code == 221) {
589 more($self, $r .= 'head follows');
590 msg_hdr_write($eml, $smsg);
591 } elsif ($code == 222) {
592 more($self, $r .= 'body follows');
593 msg_body_write($self, $bref);
596 die "BUG: bad code: $r";
598 $self->write(\".\r\n"); # flushes (includes ->zflush)
602 sub cmd_article ($;$) {
603 my ($self, $art) = @_;
604 art_lookup($self, $art, 220);
608 my ($self, $art) = @_;
609 art_lookup($self, $art, 221);
613 my ($self, $art) = @_;
614 art_lookup($self, $art, 222);
618 my ($self, $art) = @_;
619 art_lookup($self, $art, 223); # art may be msgid
622 sub cmd_ihave ($) { '435 article not wanted - do not send it' }
624 sub cmd_date ($) { '111 '.strftime('%Y%m%d%H%M%S', gmtime(time)) }
628 more($self, '100 help text follows');
633 my ($self, $range) = @_;
634 my $ng = $self->{ng} or return '412 no news group has been selected';
635 defined $range or return '420 No article(s) selected';
637 my ($min, $max) = $ng->mm->minmax;
638 if ($range =~ /\A([0-9]+)\z/) {
640 } elsif ($range =~ /\A([0-9]+)-\z/) {
641 ($beg, $end) = ($1, $max);
642 } elsif ($range =~ /\A([0-9]+)-([0-9]+)\z/) {
643 ($beg, $end) = ($1, $2);
647 $beg = $min if ($beg < $min);
648 $end = $max if ($end > $max);
649 return '420 No article(s) selected' if ($beg > $end);
655 # wbuf is unset or empty, here; {long} may add to it
656 my ($fd, $cb, $t0, @args) = @{$self->{long_cb}};
657 my $more = eval { $cb->($self, @args) };
658 if ($@ || !$self->{sock}) { # something bad happened...
659 delete $self->{long_cb};
660 my $elapsed = now() - $t0;
663 "%s during long response[$fd] - %0.6f",
666 out($self, " deferred[$fd] aborted - %0.6f", $elapsed);
668 } elsif ($more) { # $self->{wbuf}:
669 $self->update_idle_time;
671 # COMPRESS users all share the same DEFLATE context.
672 # Flush it here to ensure clients don't see
676 # no recursion, schedule another call ASAP, but only after
677 # all pending writes are done. autovivify wbuf:
678 my $new_size = push(@{$self->{wbuf}}, \&long_step);
680 # wbuf may be populated by $cb, no need to rearm if so:
681 $self->requeue if $new_size == 1;
683 delete $self->{long_cb};
685 my $elapsed = now() - $t0;
686 my $fd = fileno($self->{sock});
687 out($self, " deferred[$fd] done - %0.6f", $elapsed);
688 my $wbuf = $self->{wbuf}; # do NOT autovivify
689 $self->requeue unless $wbuf && @$wbuf;
693 sub long_response ($$;@) {
694 my ($self, $cb, @args) = @_; # cb returns true if more, false if done
696 my $sock = $self->{sock} or return;
697 # make sure we disable reading during a long response,
698 # clients should not be sending us stuff and making us do more
699 # work while we are stream a response to them
700 $self->{long_cb} = [ fileno($sock), $cb, now(), @args ];
701 long_step($self); # kick off!
705 sub hdr_msgid_range_i {
706 my ($self, $beg, $end) = @_;
707 my $r = $self->{ng}->mm->msg_range($beg, $end);
709 $self->msg_more(join('', map { "$_->[0] <$_->[1]>\r\n" } @$r));
713 sub hdr_message_id ($$$) { # optimize XHDR Message-ID [range] for slrnpull.
714 my ($self, $xhdr, $range) = @_;
716 if (defined $range && $range =~ $ONE_MSGID) {
717 my ($ng, $n) = mid_lookup($self, $1);
718 return r430 unless $n;
719 hdr_mid_response($self, $xhdr, $ng, $n, $range, $range);
720 } else { # numeric range
721 $range = $self->{article} unless defined $range;
722 my $r = get_range($self, $range);
723 return $r unless ref $r;
724 more($self, $xhdr ? r221 : r225);
725 long_response($self, \&hdr_msgid_range_i, @$r);
729 sub mid_lookup ($$) {
730 my ($self, $mid) = @_;
731 my $self_ng = $self->{ng};
733 my $n = $self_ng->mm->num_for($mid);
734 return ($self_ng, $n) if defined $n;
736 my $pi_cfg = $self->{nntpd}->{pi_config};
737 if (my $ALL = $pi_cfg->ALL) {
739 while (my $smsg = $ALL->over->next_by_mid($mid, \$id, \$prev)) {
740 my $xr3 = $ALL->over->get_xref3($smsg->{num});
741 if (my @x = grep(/:$smsg->{blob}\z/, @$xr3)) {
742 my ($ngname, $xnum) = split(/:/, $x[0]);
743 my $ibx = $pi_cfg->{-by_newsgroup}->{$ngname};
744 return ($ibx, $xnum) if $ibx;
745 # fall through to trying all xref3s
748 W: xref3 missing for <$mid> ($smsg->{blob}) in $ALL->{topdir}, -extindex bug?
753 my ($ngname, $xnum) = split(/:/, $x);
754 my $ibx = $pi_cfg->{-by_newsgroup}->{$ngname};
755 return ($ibx, $xnum) if $ibx;
756 warn "W: `$ngname' does not exist for #$xnum\n";
759 # no warning here, $mid is just invalid
760 } else { # slow path for non-ALL users
761 for my $ibx (values %{$pi_cfg->{-by_newsgroup}}) {
762 next if defined $self_ng && $ibx eq $self_ng;
763 my $n = $ibx->mm->num_for($mid);
764 return ($ibx, $n) if defined $n;
771 my ($self, $beg, $end) = @_;
772 my $ng = $self->{ng};
773 my $msgs = $ng->over->query_xover($$beg, $end);
774 scalar(@$msgs) or return;
775 $$beg = $msgs->[-1]->{num} + 1;
776 $self->msg_more(join('', map {
777 "$_->{num} ".xref($self, $ng, $_) . "\r\n";
782 sub hdr_xref ($$$) { # optimize XHDR Xref [range] for rtin
783 my ($self, $xhdr, $range) = @_;
785 if (defined $range && $range =~ $ONE_MSGID) {
787 my ($ng, $n) = mid_lookup($self, $mid);
788 return r430 unless $n;
789 my $smsg = $ng->over->get_art($n) or return;
790 hdr_mid_response($self, $xhdr, $ng, $n, $range,
791 xref($self, $ng, $smsg));
792 } else { # numeric range
793 $range = $self->{article} unless defined $range;
794 my $r = get_range($self, $range);
795 return $r unless ref $r;
796 more($self, $xhdr ? r221 : r225);
797 long_response($self, \&xref_range_i, @$r);
801 sub over_header_for {
802 my ($over, $num, $field) = @_;
803 my $smsg = $over->get_art($num) or return;
804 return PublicInbox::Smsg::date($smsg) if $field eq 'date';
809 my ($self, $beg, $end, $field) = @_;
810 my $over = $self->{ng}->over;
811 my $msgs = $over->query_xover($$beg, $end);
812 scalar(@$msgs) or return;
815 # ->{$field} is faster than ->$field invocations, so favor that.
816 if ($field eq 'date') {
818 $tmp .= "$s->{num} ".PublicInbox::Smsg::date($s)."\r\n"
822 $tmp .= "$s->{num} $s->{$field}\r\n";
826 $self->msg_more($tmp);
827 $$beg = $msgs->[-1]->{num} + 1;
830 sub hdr_smsg ($$$$) {
831 my ($self, $xhdr, $field, $range) = @_;
832 if (defined $range && $range =~ $ONE_MSGID) {
833 my ($ng, $n) = mid_lookup($self, $1);
834 return r430 unless defined $n;
835 my $v = over_header_for($ng->over, $n, $field);
836 hdr_mid_response($self, $xhdr, $ng, $n, $range, $v);
837 } else { # numeric range
838 $range = $self->{article} unless defined $range;
839 my $r = get_range($self, $range);
840 return $r unless ref $r;
841 more($self, $xhdr ? r221 : r225);
842 long_response($self, \&smsg_range_i, @$r, $field);
847 my ($self, $xhdr, $header, $range) = @_;
848 my $sub = lc $header;
849 if ($sub eq 'message-id') {
850 hdr_message_id($self, $xhdr, $range);
851 } elsif ($sub eq 'xref') {
852 hdr_xref($self, $xhdr, $range);
853 } elsif ($sub =~ /\A(?:subject|references|date|from|to|cc|
855 hdr_smsg($self, $xhdr, $sub, $range);
856 } elsif ($sub =~ /\A:(bytes|lines)\z/) {
857 hdr_smsg($self, $xhdr, $1, $range);
859 $xhdr ? (r221 . "\r\n.") : "503 HDR not permitted on $header";
865 my ($self, $header, $range) = @_;
866 do_hdr($self, 0, $header, $range);
870 sub cmd_xhdr ($$;$) {
871 my ($self, $header, $range) = @_;
872 do_hdr($self, 1, $header, $range);
875 sub hdr_mid_prefix ($$$$$) {
876 my ($self, $xhdr, $ng, $n, $mid) = @_;
877 return $mid if $xhdr;
879 # HDR for RFC 3977 users
880 if (my $self_ng = $self->{ng}) {
881 ($self_ng eq $ng) ? $n : '0';
887 sub hdr_mid_response ($$$$$$) {
888 my ($self, $xhdr, $ng, $n, $mid, $v) = @_;
891 $res .= r221 . "\r\n";
892 $res .= "$mid $v\r\n";
894 $res .= r225 . "\r\n";
895 my $pfx = hdr_mid_prefix($self, $xhdr, $ng, $n, $mid);
896 $res .= "$pfx $v\r\n";
898 res($self, $res .= '.');
903 my ($self, $beg, $end) = @_;
904 my $h = over_header_for($self->{ng}->over, $$beg, 'references');
905 more($self, "$$beg $h") if defined($h);
909 sub cmd_xrover ($;$) {
910 my ($self, $range) = @_;
911 my $ng = $self->{ng} or return '412 no newsgroup selected';
912 (defined $range && $range =~ /[<>]/) and
913 return '420 No article(s) selected'; # no message IDs
915 $range = $self->{article} unless defined $range;
916 my $r = get_range($self, $range);
917 return $r unless ref $r;
918 more($self, '224 Overview information follows');
919 long_response($self, \&xrover_i, @$r);
922 sub over_line ($$$) {
923 my ($self, $ng, $smsg) = @_;
924 # n.b. field access and procedural calls can be
925 # 10%-15% faster than OO method calls:
926 my $s = join("\t", $smsg->{num},
929 PublicInbox::Smsg::date($smsg),
934 "Xref: " . xref($self, $ng, $smsg));
940 my ($self, $range) = @_;
941 if ($range && $range =~ $ONE_MSGID) {
942 my ($ng, $n) = mid_lookup($self, $1);
943 defined $n or return r430;
944 my $smsg = $ng->over->get_art($n) or return r430;
945 more($self, '224 Overview information follows (multi-line)');
947 # Only set article number column if it's the current group
949 my $self_ng = $self->{ng};
950 if (!$self_ng || $self_ng ne $ng) {
951 # set {-orig_num} for nntp_xref_for
952 $smsg->{-orig_num} = $smsg->{num};
955 $self->msg_more(over_line($self, $ng, $smsg));
958 cmd_xover($self, $range);
963 my ($self, $beg, $end) = @_;
964 my $ng = $self->{ng};
965 my $msgs = $ng->over->query_xover($$beg, $end);
966 my $nr = scalar @$msgs or return;
969 $self->msg_more(join('', map {
970 over_line($self, $ng, $_);
972 $$beg = $msgs->[-1]->{num} + 1;
975 sub cmd_xover ($;$) {
976 my ($self, $range) = @_;
977 $range = $self->{article} unless defined $range;
978 my $r = get_range($self, $range);
979 return $r unless ref $r;
980 my ($beg, $end) = @$r;
981 more($self, "224 Overview information follows for $$beg to $end");
982 long_response($self, \&xover_i, @$r);
985 sub compressed { undef }
987 sub cmd_starttls ($) {
989 my $sock = $self->{sock} or return;
991 return r502 if ($sock->can('accept_SSL') || $self->compressed);
992 my $opt = $self->{nntpd}->{accept_tls} or
993 return '580 can not initiate TLS negotiation';
994 res($self, '382 Continue with TLS negotiation');
995 $self->{sock} = IO::Socket::SSL->start_SSL($sock, %$opt);
996 $self->requeue if PublicInbox::DS::accept_tls_step($self);
1001 sub cmd_compress ($$) {
1002 my ($self, $alg) = @_;
1003 return '503 Only DEFLATE is supported' if uc($alg) ne 'DEFLATE';
1004 return r502 if $self->compressed;
1005 PublicInbox::NNTPdeflate->enable($self);
1010 sub zflush {} # overridden by NNTPdeflate
1012 sub cmd_xpath ($$) {
1013 my ($self, $mid) = @_;
1014 return r501 unless $mid =~ $ONE_MSGID;
1017 my $pi_cfg = $self->{nntpd}->{pi_config};
1018 my $groups = $pi_cfg->{-by_newsgroup};
1019 if (my $ALL = $pi_cfg->ALL) {
1020 my ($id, $prev, %seen);
1021 while (my $smsg = $ALL->over->next_by_mid($mid, \$id, \$prev)) {
1022 my $xr3 = $ALL->over->get_xref3($smsg->{num});
1024 my ($ngname, $n) = split(/:/, $x);
1026 if ($groups->{$ngname} && !$seen{$x}++) {
1031 } else { # slow path, no point in using long_response
1032 for my $ibx (values %$groups) {
1033 my $n = $ibx->mm->num_for($mid) // next;
1034 push @paths, "$ibx->{newsgroup}/$n";
1037 return '430 no such article on server' unless @paths;
1038 '223 '.join(' ', sort(@paths));
1041 sub res ($$) { do_write($_[0], $_[1] . "\r\n") }
1043 sub more ($$) { $_[0]->msg_more($_[1] . "\r\n") }
1047 my $done = $self->write(\($_[1]));
1048 return 0 unless $self->{sock};
1054 my ($self, $fmt, @args) = @_;
1055 printf { $self->{nntpd}->{err} } $fmt."\n", @args;
1059 my ($self, $fmt, @args) = @_;
1060 printf { $self->{nntpd}->{out} } $fmt."\n", @args;
1063 # callback used by PublicInbox::DS for any (e)poll (in/out/hup/err)
1067 return unless $self->flush_write && $self->{sock} && !$self->{long_cb};
1069 $self->update_idle_time;
1070 # only read more requests if we've drained the write buffer,
1071 # otherwise we can be buffering infinitely w/o backpressure
1073 my $rbuf = $self->{rbuf} // \(my $x = '');
1074 my $line = index($$rbuf, "\n");
1076 return $self->close if length($$rbuf) >= LINE_MAX;
1077 $self->do_read($rbuf, LINE_MAX, length($$rbuf)) or return;
1078 $line = index($$rbuf, "\n");
1080 $line = substr($$rbuf, 0, $line + 1, '');
1081 $line =~ s/\r?\n\z//s;
1082 return $self->close if $line =~ /[[:cntrl:]]/s;
1085 my $fd = fileno($self->{sock});
1086 my $r = eval { process_line($self, $line) };
1087 my $pending = $self->{wbuf} ? ' pending' : '';
1088 out($self, "[$fd] %s - %0.6f$pending", $line, now() - $t0);
1089 return $self->close if $r < 0;
1090 $self->rbuf_idle($rbuf);
1091 $self->update_idle_time;
1093 # maybe there's more pipelined data, or we'll have
1094 # to register it for socket-readiness notifications
1095 $self->requeue unless $pending;
1098 # for graceful shutdown in PublicInbox::Daemon:
1100 my ($self, $now) = @_;
1101 ($self->{rbuf} || $self->{wbuf} || $self->not_idle_long($now));