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 more($self, join("\r\n", map { $_->[0] } @$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);
332 map { $_->{mid} } @$msgs ) .
334 $$prev = $msgs->[-1]->{num};
335 return 1; # continue on current group
340 if (@$names) { # continue onto next newsgroup
343 } else { # all done, break out of the long_response
348 sub cmd_newnews ($$$$;$$) {
349 my ($self, $newsgroups, $date, $time, $gmt, $dists) = @_;
350 my $ts = eval { parse_time($date, $time, $gmt) };
352 more($self, '230 list of new articles by message-id follows');
353 my ($keep, $skip) = split('!', $newsgroups, 2);
356 my @names = grep(!/$skip/, grep(/$keep/,
357 @{$self->{nntpd}->{groupnames}}));
358 return '.' unless scalar(@names);
360 long_response($self, \&newnews_i, \@names, $ts, \$prev);
364 my ($self, $group) = @_;
365 my $nntpd = $self->{nntpd};
366 my $ibx = $nntpd->{pi_config}->{-by_newsgroup}->{$group} or
367 return '411 no such news group';
371 my ($min, $max) = $ibx->mm->minmax;
372 $self->{article} = $min;
373 my $est_size = $max - $min;
374 "211 $est_size $min $max $group";
377 sub article_adj ($$) {
378 my ($self, $off) = @_;
379 my $ng = $self->{ng} or return '412 no newsgroup selected';
381 my $n = $self->{article};
382 defined $n or return '420 no current article has been selected';
385 my $mid = $ng->mm->mid_for($n);
387 $n = $off > 0 ? 'next' : 'previous';
388 return "421 no $n article in this group";
390 $self->{article} = $n;
391 "223 $n <$mid> article retrieved - request text separately";
394 sub cmd_next ($) { article_adj($_[0], 1) }
395 sub cmd_last ($) { article_adj($_[0], -1) }
397 # We want to encourage using email and CC-ing everybody involved to avoid
398 # the single-point-of-failure a single server provides.
401 my $ng = $self->{ng};
402 $ng ? "440 mailto:$ng->{-primary_address} to post"
403 : '440 posting not allowed'
408 res($self, '205 closing connection - goodbye!');
413 sub header_append ($$$) {
414 my ($hdr, $k, $v) = @_;
415 my @v = $hdr->header_raw($k);
419 $hdr->header_set($k, @v, $v);
422 sub xref_by_tc ($$$) {
423 my ($xref, $pi_cfg, $smsg) = @_;
424 my $by_addr = $pi_cfg->{-by_addr};
425 my $mid = $smsg->{mid};
426 for my $f (qw(to cc)) {
428 $by_addr->{lc($_)} // ()
429 } (PublicInbox::Address::emails($smsg->{$f} // ''));
430 for my $ibx (@ibxs) {
431 my $ngname = $ibx->{newsgroup} // next;
432 next if defined $xref->{$ngname};
433 $xref->{$ngname} = eval { $ibx->mm->num_for($mid) };
439 my ($self, $cur_ibx, $smsg) = @_;
440 my $nntpd = $self->{nntpd};
441 my $cur_ng = $cur_ibx->{newsgroup};
443 if (my $ALL = $nntpd->{pi_config}->ALL) {
444 $xref = $ALL->nntp_xref_for($cur_ibx, $smsg);
445 xref_by_tc($xref, $nntpd->{pi_config}, $smsg);
447 $xref = { $cur_ng => $smsg->{num} };
448 my $mid = $smsg->{mid};
449 for my $ibx (values %{$nntpd->{pi_config}->{-by_newsgroup}}) {
450 next if defined($xref->{$ibx->{newsgroup}});
451 my $num = eval { $ibx->mm->num_for($mid) } // next;
452 $xref->{$ibx->{newsgroup}} = $num;
455 my $ret = "$nntpd->{servername} $cur_ng:".delete($xref->{$cur_ng});
456 $ret .= " $_:$xref->{$_}" for (sort keys %$xref);
460 sub set_nntp_headers ($$) {
461 my ($hdr, $smsg) = @_;
462 my ($mid) = $smsg->{mid};
464 # leafnode (and maybe other NNTP clients) have trouble dealing
465 # with v2 messages which have multiple Message-IDs (either due
466 # to our own content-based dedupe or buggy git-send-email versions).
467 my @mids = $hdr->header_raw('Message-ID');
468 if (scalar(@mids) > 1) {
470 $hdr->header_set('Message-ID', $mid0);
471 my @alt = $hdr->header_raw('X-Alt-Message-ID');
472 my %seen = map { $_ => 1 } (@alt, $mid0);
473 push(@alt, grep { !$seen{$_}++ } @mids);
474 $hdr->header_set('X-Alt-Message-ID', @alt);
477 # clobber some existing headers
478 my $ibx = $smsg->{-ibx};
479 my $xref = xref($smsg->{nntp}, $ibx, $smsg);
480 $hdr->header_set('Xref', $xref);
483 my ($server_name, $newsgroups) = split(/ /, $xref, 2);
484 $newsgroups =~ s/:[0-9]+\b//g; # drop NNTP article numbers
485 $newsgroups =~ tr/ /,/;
486 $hdr->header_set('Newsgroups', $newsgroups);
488 # *something* here is required for leafnode, try to follow
490 $hdr->header_set('Path', $server_name . '!not-for-mail');
492 header_append($hdr, 'List-Post', "<mailto:$ibx->{-primary_address}>");
493 if (my $url = $ibx->base_url) {
494 $mid = mid_escape($mid);
495 header_append($hdr, 'Archived-At', "<$url$mid/>");
496 header_append($hdr, 'List-Archive', "<$url>");
500 sub art_lookup ($$$) {
501 my ($self, $art, $code) = @_;
505 if ($art =~ /\A[0-9]+\z/) {
506 $err = '423 no such article number in this group';
509 } elsif ($art =~ $ONE_MSGID) {
510 ($ibx, $n) = mid_lookup($self, $1);
517 $err = '420 no current article has been selected';
518 $n = $self->{article} // return $err;
520 $ibx = $self->{ng} or
521 return '412 no newsgroup has been selected';
524 my $smsg = $ibx->over->get_art($n) or return $err;
525 $smsg->{-ibx} = $ibx;
526 if ($code == 223) { # STAT
528 "223 $n <$smsg->{mid}> article retrieved - " .
529 "request text separately";
530 } else { # HEAD | BODY | ARTICLE
531 $smsg->{nntp} = $self;
532 $smsg->{nntp_code} = $code;
533 set_art($self, $art);
534 # this dereferences to `undef'
535 ${git_async_cat($ibx->git, $smsg->{blob}, \&blob_cb, $smsg)};
539 sub msg_body_write ($$) {
540 my ($self, $msg) = @_;
542 # these can momentarily double the memory consumption :<
543 $$msg =~ s/^\./../smg;
544 $$msg =~ s/(?<!\r)\n/\r\n/sg; # Alpine barfs without this
545 $$msg .= "\r\n" unless $$msg =~ /\r\n\z/s;
546 $self->msg_more($$msg);
550 my ($self, $art) = @_;
551 $self->{article} = $art if defined $art && $art =~ /\A[0-9]+\z/;
554 sub msg_hdr_write ($$) {
555 my ($eml, $smsg) = @_;
556 set_nntp_headers($eml, $smsg);
558 my $hdr = $eml->{hdr} // \(my $x = '');
559 # fixup old bug from import (pre-a0c07cba0e5d8b6a)
560 $$hdr =~ s/\A[\r\n]*From [^\r\n]*\r?\n//s;
561 $$hdr =~ s/(?<!\r)\n/\r\n/sg; # Alpine barfs without this
563 # for leafnode compatibility, we need to ensure Message-ID headers
564 # are only a single line.
565 $$hdr =~ s/^(Message-ID:)[ \t]*\r\n[ \t]+([^\r]+)\r\n/$1 $2\r\n/igsm;
566 $smsg->{nntp}->msg_more($$hdr);
569 sub blob_cb { # called by git->cat_async via git_async_cat
570 my ($bref, $oid, $type, $size, $smsg) = @_;
571 my $self = $smsg->{nntp};
572 my $code = $smsg->{nntp_code};
573 if (!defined($oid)) {
574 # it's possible to have TOCTOU if an admin runs
575 # public-inbox-(edit|purge), just move onto the next message
576 warn "E: $smsg->{blob} missing in $smsg->{-ibx}->{inboxdir}\n";
577 return $self->requeue;
578 } elsif ($smsg->{blob} ne $oid) {
580 die "BUG: $smsg->{blob} != $oid";
582 my $r = "$code $smsg->{num} <$smsg->{mid}> article retrieved - ";
583 my $eml = PublicInbox::Eml->new($bref);
585 more($self, $r .= 'head and body follow');
586 msg_hdr_write($eml, $smsg);
587 $self->msg_more("\r\n");
588 msg_body_write($self, $bref);
589 } elsif ($code == 221) {
590 more($self, $r .= 'head follows');
591 msg_hdr_write($eml, $smsg);
592 } elsif ($code == 222) {
593 more($self, $r .= 'body follows');
594 msg_body_write($self, $bref);
597 die "BUG: bad code: $r";
599 $self->write(\".\r\n"); # flushes (includes ->zflush)
603 sub cmd_article ($;$) {
604 my ($self, $art) = @_;
605 art_lookup($self, $art, 220);
609 my ($self, $art) = @_;
610 art_lookup($self, $art, 221);
614 my ($self, $art) = @_;
615 art_lookup($self, $art, 222);
619 my ($self, $art) = @_;
620 art_lookup($self, $art, 223); # art may be msgid
623 sub cmd_ihave ($) { '435 article not wanted - do not send it' }
625 sub cmd_date ($) { '111 '.strftime('%Y%m%d%H%M%S', gmtime(time)) }
629 more($self, '100 help text follows');
634 my ($self, $range) = @_;
635 my $ng = $self->{ng} or return '412 no news group has been selected';
636 defined $range or return '420 No article(s) selected';
638 my ($min, $max) = $ng->mm->minmax;
639 if ($range =~ /\A([0-9]+)\z/) {
641 } elsif ($range =~ /\A([0-9]+)-\z/) {
642 ($beg, $end) = ($1, $max);
643 } elsif ($range =~ /\A([0-9]+)-([0-9]+)\z/) {
644 ($beg, $end) = ($1, $2);
648 $beg = $min if ($beg < $min);
649 $end = $max if ($end > $max);
650 return '420 No article(s) selected' if ($beg > $end);
656 # wbuf is unset or empty, here; {long} may add to it
657 my ($fd, $cb, $t0, @args) = @{$self->{long_cb}};
658 my $more = eval { $cb->($self, @args) };
659 if ($@ || !$self->{sock}) { # something bad happened...
660 delete $self->{long_cb};
661 my $elapsed = now() - $t0;
664 "%s during long response[$fd] - %0.6f",
667 out($self, " deferred[$fd] aborted - %0.6f", $elapsed);
669 } elsif ($more) { # $self->{wbuf}:
670 $self->update_idle_time;
672 # COMPRESS users all share the same DEFLATE context.
673 # Flush it here to ensure clients don't see
677 # no recursion, schedule another call ASAP, but only after
678 # all pending writes are done. autovivify wbuf:
679 my $new_size = push(@{$self->{wbuf}}, \&long_step);
681 # wbuf may be populated by $cb, no need to rearm if so:
682 $self->requeue if $new_size == 1;
684 delete $self->{long_cb};
686 my $elapsed = now() - $t0;
687 my $fd = fileno($self->{sock});
688 out($self, " deferred[$fd] done - %0.6f", $elapsed);
689 my $wbuf = $self->{wbuf}; # do NOT autovivify
690 $self->requeue unless $wbuf && @$wbuf;
694 sub long_response ($$;@) {
695 my ($self, $cb, @args) = @_; # cb returns true if more, false if done
697 my $sock = $self->{sock} or return;
698 # make sure we disable reading during a long response,
699 # clients should not be sending us stuff and making us do more
700 # work while we are stream a response to them
701 $self->{long_cb} = [ fileno($sock), $cb, now(), @args ];
702 long_step($self); # kick off!
706 sub hdr_msgid_range_i {
707 my ($self, $beg, $end) = @_;
708 my $r = $self->{ng}->mm->msg_range($beg, $end);
710 more($self, join("\r\n", map { "$_->[0] <$_->[1]>" } @$r));
714 sub hdr_message_id ($$$) { # optimize XHDR Message-ID [range] for slrnpull.
715 my ($self, $xhdr, $range) = @_;
717 if (defined $range && $range =~ $ONE_MSGID) {
718 my ($ng, $n) = mid_lookup($self, $1);
719 return r430 unless $n;
720 hdr_mid_response($self, $xhdr, $ng, $n, $range, $range);
721 } else { # numeric range
722 $range = $self->{article} unless defined $range;
723 my $r = get_range($self, $range);
724 return $r unless ref $r;
725 more($self, $xhdr ? r221 : r225);
726 long_response($self, \&hdr_msgid_range_i, @$r);
730 sub mid_lookup ($$) {
731 my ($self, $mid) = @_;
732 my $self_ng = $self->{ng};
734 my $n = $self_ng->mm->num_for($mid);
735 return ($self_ng, $n) if defined $n;
737 my $pi_cfg = $self->{nntpd}->{pi_config};
738 if (my $ALL = $pi_cfg->ALL) {
740 while (my $smsg = $ALL->over->next_by_mid($mid, \$id, \$prev)) {
741 my $xr3 = $ALL->over->get_xref3($smsg->{num});
742 if (my @x = grep(/:$smsg->{blob}\z/, @$xr3)) {
743 my ($ngname, $xnum) = split(/:/, $x[0]);
744 my $ibx = $pi_cfg->{-by_newsgroup}->{$ngname};
745 return ($ibx, $xnum) if $ibx;
746 # fall through to trying all xref3s
749 W: xref3 missing for <$mid> ($smsg->{blob}) in $ALL->{topdir}, -extindex bug?
754 my ($ngname, $xnum) = split(/:/, $x);
755 my $ibx = $pi_cfg->{-by_newsgroup}->{$ngname};
756 return ($ibx, $xnum) if $ibx;
757 warn "W: `$ngname' does not exist for #$xnum\n";
760 # no warning here, $mid is just invalid
761 } else { # slow path for non-ALL users
762 for my $ibx (values %{$pi_cfg->{-by_newsgroup}}) {
763 next if defined $self_ng && $ibx eq $self_ng;
764 my $n = $ibx->mm->num_for($mid);
765 return ($ibx, $n) if defined $n;
772 my ($self, $beg, $end) = @_;
773 my $ng = $self->{ng};
774 my $msgs = $ng->over->query_xover($$beg, $end);
775 scalar(@$msgs) or return;
776 $$beg = $msgs->[-1]->{num} + 1;
777 more($self, join("\r\n", map {
778 "$_->{num} ".xref($self, $ng, $_);
783 sub hdr_xref ($$$) { # optimize XHDR Xref [range] for rtin
784 my ($self, $xhdr, $range) = @_;
786 if (defined $range && $range =~ $ONE_MSGID) {
788 my ($ng, $n) = mid_lookup($self, $mid);
789 return r430 unless $n;
790 my $smsg = $ng->over->get_art($n) or return;
791 hdr_mid_response($self, $xhdr, $ng, $n, $range,
792 xref($self, $ng, $smsg));
793 } else { # numeric range
794 $range = $self->{article} unless defined $range;
795 my $r = get_range($self, $range);
796 return $r unless ref $r;
797 more($self, $xhdr ? r221 : r225);
798 long_response($self, \&xref_range_i, @$r);
802 sub over_header_for {
803 my ($over, $num, $field) = @_;
804 my $smsg = $over->get_art($num) or return;
805 return PublicInbox::Smsg::date($smsg) if $field eq 'date';
810 my ($self, $beg, $end, $field) = @_;
811 my $over = $self->{ng}->over;
812 my $msgs = $over->query_xover($$beg, $end);
813 scalar(@$msgs) or return;
816 # ->{$field} is faster than ->$field invocations, so favor that.
817 if ($field eq 'date') {
819 $tmp .= "$s->{num} ".PublicInbox::Smsg::date($s)."\r\n"
823 $tmp .= "$s->{num} $s->{$field}\r\n";
827 $self->msg_more($tmp);
828 $$beg = $msgs->[-1]->{num} + 1;
831 sub hdr_smsg ($$$$) {
832 my ($self, $xhdr, $field, $range) = @_;
833 if (defined $range && $range =~ $ONE_MSGID) {
834 my ($ng, $n) = mid_lookup($self, $1);
835 return r430 unless defined $n;
836 my $v = over_header_for($ng->over, $n, $field);
837 hdr_mid_response($self, $xhdr, $ng, $n, $range, $v);
838 } else { # numeric range
839 $range = $self->{article} unless defined $range;
840 my $r = get_range($self, $range);
841 return $r unless ref $r;
842 more($self, $xhdr ? r221 : r225);
843 long_response($self, \&smsg_range_i, @$r, $field);
848 my ($self, $xhdr, $header, $range) = @_;
849 my $sub = lc $header;
850 if ($sub eq 'message-id') {
851 hdr_message_id($self, $xhdr, $range);
852 } elsif ($sub eq 'xref') {
853 hdr_xref($self, $xhdr, $range);
854 } elsif ($sub =~ /\A(?:subject|references|date|from|to|cc|
856 hdr_smsg($self, $xhdr, $sub, $range);
857 } elsif ($sub =~ /\A:(bytes|lines)\z/) {
858 hdr_smsg($self, $xhdr, $1, $range);
860 $xhdr ? (r221 . "\r\n.") : "503 HDR not permitted on $header";
866 my ($self, $header, $range) = @_;
867 do_hdr($self, 0, $header, $range);
871 sub cmd_xhdr ($$;$) {
872 my ($self, $header, $range) = @_;
873 do_hdr($self, 1, $header, $range);
876 sub hdr_mid_prefix ($$$$$) {
877 my ($self, $xhdr, $ng, $n, $mid) = @_;
878 return $mid if $xhdr;
880 # HDR for RFC 3977 users
881 if (my $self_ng = $self->{ng}) {
882 ($self_ng eq $ng) ? $n : '0';
888 sub hdr_mid_response ($$$$$$) {
889 my ($self, $xhdr, $ng, $n, $mid, $v) = @_;
892 $res .= r221 . "\r\n";
893 $res .= "$mid $v\r\n";
895 $res .= r225 . "\r\n";
896 my $pfx = hdr_mid_prefix($self, $xhdr, $ng, $n, $mid);
897 $res .= "$pfx $v\r\n";
899 res($self, $res .= '.');
904 my ($self, $beg, $end) = @_;
905 my $h = over_header_for($self->{ng}->over, $$beg, 'references');
906 more($self, "$$beg $h") if defined($h);
910 sub cmd_xrover ($;$) {
911 my ($self, $range) = @_;
912 my $ng = $self->{ng} or return '412 no newsgroup selected';
913 (defined $range && $range =~ /[<>]/) and
914 return '420 No article(s) selected'; # no message IDs
916 $range = $self->{article} unless defined $range;
917 my $r = get_range($self, $range);
918 return $r unless ref $r;
919 more($self, '224 Overview information follows');
920 long_response($self, \&xrover_i, @$r);
923 sub over_line ($$$) {
924 my ($self, $ng, $smsg) = @_;
925 # n.b. field access and procedural calls can be
926 # 10%-15% faster than OO method calls:
927 my $s = join("\t", $smsg->{num},
930 PublicInbox::Smsg::date($smsg),
935 "Xref: " . xref($self, $ng, $smsg));
941 my ($self, $range) = @_;
942 if ($range && $range =~ $ONE_MSGID) {
943 my ($ng, $n) = mid_lookup($self, $1);
944 defined $n or return r430;
945 my $smsg = $ng->over->get_art($n) or return r430;
946 more($self, '224 Overview information follows (multi-line)');
948 # Only set article number column if it's the current group
950 my $self_ng = $self->{ng};
951 if (!$self_ng || $self_ng ne $ng) {
952 # set {-orig_num} for nntp_xref_for
953 $smsg->{-orig_num} = $smsg->{num};
956 more($self, over_line($self, $ng, $smsg));
959 cmd_xover($self, $range);
964 my ($self, $beg, $end) = @_;
965 my $ng = $self->{ng};
966 my $msgs = $ng->over->query_xover($$beg, $end);
967 my $nr = scalar @$msgs or return;
970 more($self, join("\r\n", map {
971 over_line($self, $ng, $_);
973 $$beg = $msgs->[-1]->{num} + 1;
976 sub cmd_xover ($;$) {
977 my ($self, $range) = @_;
978 $range = $self->{article} unless defined $range;
979 my $r = get_range($self, $range);
980 return $r unless ref $r;
981 my ($beg, $end) = @$r;
982 more($self, "224 Overview information follows for $$beg to $end");
983 long_response($self, \&xover_i, @$r);
986 sub compressed { undef }
988 sub cmd_starttls ($) {
990 my $sock = $self->{sock} or return;
992 return r502 if ($sock->can('accept_SSL') || $self->compressed);
993 my $opt = $self->{nntpd}->{accept_tls} or
994 return '580 can not initiate TLS negotiation';
995 res($self, '382 Continue with TLS negotiation');
996 $self->{sock} = IO::Socket::SSL->start_SSL($sock, %$opt);
997 $self->requeue if PublicInbox::DS::accept_tls_step($self);
1002 sub cmd_compress ($$) {
1003 my ($self, $alg) = @_;
1004 return '503 Only DEFLATE is supported' if uc($alg) ne 'DEFLATE';
1005 return r502 if $self->compressed;
1006 PublicInbox::NNTPdeflate->enable($self);
1011 sub zflush {} # overridden by NNTPdeflate
1013 sub cmd_xpath ($$) {
1014 my ($self, $mid) = @_;
1015 return r501 unless $mid =~ $ONE_MSGID;
1018 my $pi_cfg = $self->{nntpd}->{pi_config};
1019 my $groups = $pi_cfg->{-by_newsgroup};
1020 if (my $ALL = $pi_cfg->ALL) {
1021 my ($id, $prev, %seen);
1022 while (my $smsg = $ALL->over->next_by_mid($mid, \$id, \$prev)) {
1023 my $xr3 = $ALL->over->get_xref3($smsg->{num});
1025 my ($ngname, $n) = split(/:/, $x);
1027 if ($groups->{$ngname} && !$seen{$x}++) {
1032 } else { # slow path, no point in using long_response
1033 for my $ibx (values %$groups) {
1034 my $n = $ibx->mm->num_for($mid) // next;
1035 push @paths, "$ibx->{newsgroup}/$n";
1038 return '430 no such article on server' unless @paths;
1039 '223 '.join(' ', sort(@paths));
1042 sub res ($$) { do_write($_[0], $_[1] . "\r\n") }
1044 sub more ($$) { $_[0]->msg_more($_[1] . "\r\n") }
1048 my $done = $self->write(\($_[1]));
1049 return 0 unless $self->{sock};
1055 my ($self, $fmt, @args) = @_;
1056 printf { $self->{nntpd}->{err} } $fmt."\n", @args;
1060 my ($self, $fmt, @args) = @_;
1061 printf { $self->{nntpd}->{out} } $fmt."\n", @args;
1064 # callback used by PublicInbox::DS for any (e)poll (in/out/hup/err)
1068 return unless $self->flush_write && $self->{sock} && !$self->{long_cb};
1070 $self->update_idle_time;
1071 # only read more requests if we've drained the write buffer,
1072 # otherwise we can be buffering infinitely w/o backpressure
1074 my $rbuf = $self->{rbuf} // \(my $x = '');
1075 my $line = index($$rbuf, "\n");
1077 return $self->close if length($$rbuf) >= LINE_MAX;
1078 $self->do_read($rbuf, LINE_MAX, length($$rbuf)) or return;
1079 $line = index($$rbuf, "\n");
1081 $line = substr($$rbuf, 0, $line + 1, '');
1082 $line =~ s/\r?\n\z//s;
1083 return $self->close if $line =~ /[[:cntrl:]]/s;
1086 my $fd = fileno($self->{sock});
1087 my $r = eval { process_line($self, $line) };
1088 my $pending = $self->{wbuf} ? ' pending' : '';
1089 out($self, "[$fd] %s - %0.6f$pending", $line, now() - $t0);
1090 return $self->close if $r < 0;
1091 $self->rbuf_idle($rbuf);
1092 $self->update_idle_time;
1094 # maybe there's more pipelined data, or we'll have
1095 # to register it for socket-readiness notifications
1096 $self->requeue unless $pending;
1099 # for graceful shutdown in PublicInbox::Daemon:
1101 my ($self, $now) = @_;
1102 ($self->{rbuf} || $self->{wbuf} || $self->not_idle_long($now));