# Copyright (C) 2015 all contributors <meta@public-inbox.org>
# License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt)
+#
+# Each instance of this represents a NNTP client socket
package PublicInbox::NNTP;
use strict;
use warnings;
use base qw(Danga::Socket);
use fields qw(nntpd article rbuf ng long_res);
+use PublicInbox::Search;
use PublicInbox::Msgmap;
-use PublicInbox::GitCatFile;
+use PublicInbox::Git;
use PublicInbox::MID qw(mid2path);
use Email::MIME;
use Data::Dumper qw(Dumper);
use POSIX qw(strftime);
use Time::HiRes qw(clock_gettime CLOCK_MONOTONIC);
+use URI::Escape qw(uri_escape_utf8);
use constant {
r501 => '501 command syntax error',
r221 => '221 Header follows',
sub now () { clock_gettime(CLOCK_MONOTONIC) };
-my @OVERVIEW = qw(Subject From Date Message-ID References Bytes Lines);
-my $OVERVIEW_FMT = join(":\r\n", @OVERVIEW) . ":\r\n";
-my $LIST_HEADERS = join("\r\n", qw(Subject From Date Message-ID References
- :bytes :lines Xref To Cc)) . "\r\n";
+my @OVERVIEW = qw(Subject From Date Message-ID References);
+my $OVERVIEW_FMT = join(":\r\n", @OVERVIEW, qw(Bytes Lines)) . ":\r\n";
+my $LIST_HEADERS = join("\r\n", @OVERVIEW,
+ qw(:bytes :lines Xref To Cc)) . "\r\n";
# disable commands with easy DoS potential:
# LISTGROUP could get pretty bad, too...
my %DISABLED; # = map { $_ => 1 } qw(xover list_overview_fmt newnews xhdr);
+my $EXPMAP; # fd -> [ idle_time, $self ]
+my $EXPTIMER;
+our $EXPTIME = 180; # 3 minutes
+my $WEAKEN = {}; # string(nntpd) -> nntpd
+my $WEAKTIMER;
+
+my $next_tick;
+my $nextq = [];
+sub next_tick () {
+ $next_tick = undef;
+ my $q = $nextq;
+ $nextq = [];
+ foreach my $nntp (@$q) {
+ # for request && response protocols, always finish writing
+ # before finishing reading:
+ if (my $long_cb = $nntp->{long_res}) {
+ $nntp->write($long_cb);
+ } elsif (&Danga::Socket::POLLIN & $nntp->{event_watch}) {
+ event_read($nntp);
+ }
+ }
+}
+
+sub update_idle_time ($) {
+ my ($self) = @_;
+ my $tmp = $self->{sock} or return;
+ $tmp = fileno($tmp);
+ defined $tmp and $EXPMAP->{$tmp} = [ now(), $self ];
+}
+
+# reduce FD pressure by closing some "git cat-file --batch" processes
+# and unused FDs for msgmap and Xapian indices
+sub weaken_groups () {
+ $WEAKTIMER = undef;
+ foreach my $nntpd (values %$WEAKEN) {
+ $_->weaken_all foreach (@{$nntpd->{grouplist}});
+ }
+ $WEAKEN = {};
+}
+
+sub expire_old () {
+ my $now = now();
+ my $exp = $EXPTIME;
+ my $old = $now - $exp;
+ my $next = $now + $exp;
+ my $nr = 0;
+ my %new;
+ while (my ($fd, $v) = each %$EXPMAP) {
+ my ($idle_time, $nntp) = @$v;
+ if ($idle_time < $old) {
+ $nntp->close; # idempotent
+ } else {
+ my $nexp = $idle_time + $exp;
+ $next = $nexp if ($nexp < $next);
+ ++$nr;
+ $new{$fd} = $v;
+ }
+ }
+ $EXPMAP = \%new;
+ if ($nr) {
+ $next -= $now;
+ $next = 0 if $next < 0;
+ $EXPTIMER = Danga::Socket->AddTimer($next, *expire_old);
+ weaken_groups();
+ } else {
+ $EXPTIMER = undef;
+ # noop to kick outselves out of the loop ASAP so descriptors
+ # really get closed
+ Danga::Socket->AddTimer(0, sub {});
+
+ # grace period for reaping resources
+ $WEAKTIMER ||= Danga::Socket->AddTimer(30, *weaken_groups);
+ }
+}
+
sub new ($$$) {
my ($class, $sock, $nntpd) = @_;
my $self = fields::new($class);
res($self, '201 server ready - post via email');
$self->{rbuf} = '';
$self->watch_read(1);
+ update_idle_time($self);
+ $WEAKEN->{"$nntpd"} = $nntpd;
+ $EXPTIMER ||= Danga::Socket->AddTimer($EXPTIME, *expire_old);
$self;
}
my $err = $@;
if ($err && !$self->{closed}) {
chomp($l = Dumper(\$l));
- err($self, "error from: $l $err");
+ err($self, 'error from: %s (%s)', $l, $err);
$res = '503 program fault - command not performed';
}
return 0 unless defined $res;
}
$self->{ng} or return '412 no newsgroup selected';
- $self->long_response(0, long_response_limit, sub {
+ long_response($self, 0, long_response_limit, sub {
my ($i) = @_;
my $nr = $self->{ng}->mm->id_batch($$i, sub {
my ($ary) = @_;
use Time::Local qw();
my ($hh, $mm, $ss) = unpack('A2A2A2', $time);
if (defined $gmt) {
- $gmt =~ /\A(?:UTC|GMT)\z/i or die "GM invalid: $gmt\n";
+ $gmt =~ /\A(?:UTC|GMT)\z/i or die "GM invalid: $gmt";
$gmt = 1;
}
my @now = $gmt ? gmtime : localtime;
$ts .= '..';
my $opts = { asc => 1, limit => 1000, offset => 0 };
- $self->long_response(0, long_response_limit, sub {
+ long_response($self, 0, long_response_limit, sub {
my ($i) = @_;
my $srch = $srch[0];
my $res = $srch->query($ts, $opts);
undef;
}
+sub header_append ($$$) {
+ my ($hdr, $k, $v) = @_;
+ my @v = $hdr->header($k);
+ foreach (@v) {
+ return if $v eq $_;
+ }
+ $hdr->header_set($k, @v, $v);
+}
+
+sub set_nntp_headers {
+ my ($hdr, $ng, $n, $mid) = @_;
+
+ # clobber some
+ $hdr->header_set('Newsgroups', $ng->{name});
+ $hdr->header_set('Xref', xref($ng, $n));
+ header_append($hdr, 'List-Post', "<mailto:$ng->{address}>");
+ if (my $url = $ng->{url}) {
+ $mid = uri_escape_utf8($mid);
+ header_append($hdr, 'Archived-At', "<$url$mid/>");
+ header_append($hdr, 'List-Archive', "<$url>");
+ }
+}
+
sub art_lookup ($$$) {
my ($self, $art, $set_headers) = @_;
my $ng = $self->{ng};
return $err unless $s;
my $lines;
if ($set_headers) {
- $s->header_set('Newsgroups', $ng->{name});
- $s->header_set('Xref', xref($ng, $n));
+ set_nntp_headers($s->header_obj, $ng, $n, $mid);
$lines = $s->body =~ tr!\n!\n!;
# must be last
sub cmd_article ($;$) {
my ($self, $art) = @_;
- my $r = $self->art_lookup($art, 1);
+ my $r = art_lookup($self, $art, 1);
return $r unless ref $r;
my ($n, $mid, $s) = @$r;
set_art($self, $art);
sub cmd_head ($;$) {
my ($self, $art) = @_;
- my $r = $self->art_lookup($art, 2);
+ my $r = art_lookup($self, $art, 2);
return $r unless ref $r;
my ($n, $mid, $s) = @$r;
set_art($self, $art);
sub cmd_body ($;$) {
my ($self, $art) = @_;
- my $r = $self->art_lookup($art, 0);
+ my $r = art_lookup($self, $art, 0);
return $r unless ref $r;
my ($n, $mid, $s) = @$r;
set_art($self, $art);
sub cmd_stat ($;$) {
my ($self, $art) = @_;
- my $r = $self->art_lookup($art, 0);
+ my $r = art_lookup($self, $art, 0);
return $r unless ref $r;
my ($n, $mid, undef) = @$r;
set_art($self, $art);
[ $beg, $end ];
}
-sub hdr_val ($$) {
- my ($r, $header) = @_;
- return $r->[3] if $header =~ /\A:?bytes\z/i;
- return $r->[4] if $header =~ /\A:?lines\z/i;
- $r = $r->[2]->header_obj->header($header);
- defined $r or return;
- $r =~ s/[\r\n\t]+/ /sg;
- $r;
-}
-
sub long_response ($$$$) {
my ($self, $beg, $end, $cb) = @_;
die "BUG: nested long response" if $self->{long_res};
if ($err) {
err($self,
- "$err during long response[$fd] - %0.6f",
- now() - $t0);
+ "%s during long response[$fd] - %0.6f",
+ $err, now() - $t0);
}
if ($self->{closed}) {
out($self, " deferred[$fd] aborted - %0.6f",
now() - $t0);
} else {
+ update_idle_time($self);
$self->watch_read(1);
}
} elsif (!$lim || $self->{write_buf_size}) {
# no recursion, schedule another call ASAP
# but only after all pending writes are done
- Danga::Socket->AddTimer(0, sub {
- $self->write($self->{long_res});
- });
+ update_idle_time($self);
+
+ push @$nextq, $self;
+ $next_tick ||= Danga::Socket->AddTimer(0, *next_tick);
} else { # all done!
$self->{long_res} = undef;
$self->watch_read(1);
my $mm = $self->{ng}->mm;
my ($beg, $end) = @$r;
more($self, $xhdr ? r221 : r225);
- $self->long_response($beg, $end, sub {
+ long_response($self, $beg, $end, sub {
my ($i) = @_;
my $mid = $mm->mid_for($$i);
more($self, "$$i <$mid>") if defined $mid;
my $mm = $ng->mm;
my ($beg, $end) = @$r;
more($self, $xhdr ? r221 : r225);
- $self->long_response($beg, $end, sub {
+ long_response($self, $beg, $end, sub {
my ($i) = @_;
my $mid = $mm->mid_for($$i);
more($self, "$$i ".xref($ng, $$i)) if defined $mid;
}
}
-sub header_obj_for {
- my ($srch, $mid) = @_;
- eval {
- my $smsg = $srch->lookup_message($mid);
- $smsg = PublicInbox::SearchMsg->load_doc($smsg->{doc});
- $smsg->mini_mime->header_obj;
- };
-};
+sub search_header_for {
+ my ($srch, $mid, $field) = @_;
+ my $smsg = $srch->lookup_message($mid) or return;
+ $smsg = PublicInbox::SearchMsg->load_doc($smsg->{doc});
+ $smsg->$field;
+}
sub hdr_searchmsg ($$$$) {
- my ($self, $xhdr, $hdr, $range) = @_;
- my $filter;
- if ($hdr eq 'date') {
- $hdr = 'X-PI-TS';
- $filter = sub ($) {
- strftime('%a, %d %b %Y %T %z', gmtime($_[0]));
- };
- }
-
+ my ($self, $xhdr, $field, $range) = @_;
if (defined $range && $range =~ /\A<(.+)>\z/) { # Message-ID
my ($ng, $n) = mid_lookup($self, $1);
return r430 unless $n;
- if (my $srch = $ng->search) {
- my $m = header_obj_for($srch, $range);
- my $v = $m->header($hdr);
- $v = $filter->($v) if defined $v && $filter;
- hdr_mid_response($self, $xhdr, $ng, $n, $range, $v);
- } else {
- hdr_slow($self, $xhdr, $hdr, $range);
- }
+ my $v = search_header_for($ng->search, $range, $field);
+ hdr_mid_response($self, $xhdr, $ng, $n, $range, $v);
} else { # numeric range
$range = $self->{article} unless defined $range;
- my $srch = $self->{ng}->search or
- return hdr_slow($self, $xhdr, $hdr, $range);
+ my $srch = $self->{ng}->search;
my $mm = $self->{ng}->mm;
my $r = get_range($self, $range);
return $r unless ref $r;
my ($beg, $end) = @$r;
more($self, $xhdr ? r221 : r225);
- $self->long_response($beg, $end, sub {
+ my $off = 0;
+ long_response($self, $beg, $end, sub {
my ($i) = @_;
- my $mid = $mm->mid_for($$i) or return;
- my $m = header_obj_for($srch, $mid) or return;
- my $v = $m->header($hdr);
- defined $v or return;
- $v = $filter->($v) if $filter;
- more($self, "$$i $v");
+ my $res = $srch->query_xover($beg, $end, $off);
+ my $msgs = $res->{msgs};
+ my $nr = scalar @$msgs or return;
+ $off += $nr;
+ my $tmp = '';
+ foreach my $s (@$msgs) {
+ $tmp .= $s->num . ' ' . $s->$field . "\r\n";
+ }
+ do_more($self, $tmp);
+ # -1 to adjust for implicit increment in long_response
+ $$i = $nr ? $$i + $nr - 1 : long_response_limit;
});
}
}
hdr_message_id($self, $xhdr, $range);
} elsif ($sub eq 'xref') {
hdr_xref($self, $xhdr, $range);
- } elsif ($sub =~ /\A(subject|references|date)\z/) {
+ } elsif ($sub =~ /\A(?:subject|references|date|from|to|cc|
+ bytes|lines)\z/x) {
hdr_searchmsg($self, $xhdr, $sub, $range);
+ } elsif ($sub =~ /\A:(bytes|lines)\z/) {
+ hdr_searchmsg($self, $xhdr, $1, $range);
} else {
- hdr_slow($self, $xhdr, $header, $range);
+ $xhdr ? (r221 . "\r\n.") : "503 HDR not permitted on $header";
}
}
my $res = '';
if ($xhdr) {
$res .= r221 . "\r\n";
- $res .= "$mid $v\r\n" if defined $v;
+ $res .= "$mid $v\r\n";
} else {
$res .= r225 . "\r\n";
- if (defined $v) {
- my $pfx = hdr_mid_prefix($self, $xhdr, $ng, $n, $mid);
- $res .= "$pfx $v\r\n";
- }
+ my $pfx = hdr_mid_prefix($self, $xhdr, $ng, $n, $mid);
+ $res .= "$pfx $v\r\n";
}
res($self, $res .= '.');
undef;
}
-sub hdr_slow ($$$$) {
- my ($self, $xhdr, $header, $range) = @_;
-
- if (defined $range && $range =~ /\A<.+>\z/) { # Message-ID
- my $r = $self->art_lookup($range, 2);
- return $r unless ref $r;
- my ($n, $ng) = ($r->[0], $r->[5]);
- my $v = hdr_val($r, $header);
- hdr_mid_response($self, $xhdr, $ng, $n, $range, $v);
- } else { # numeric range
- $range = $self->{article} unless defined $range;
- my $r = get_range($self, $range);
- return $r unless ref $r;
- my ($beg, $end) = @$r;
- more($self, $xhdr ? r221 : r225);
- $self->long_response($beg, $end, sub {
- my ($i) = @_;
- $r = $self->art_lookup($$i, 2);
- return unless ref $r;
- defined($r = hdr_val($r, $header)) or return;
- more($self, "$$i $r");
- });
- }
-}
-
sub cmd_xrover ($;$) {
my ($self, $range) = @_;
my $ng = $self->{ng} or return '412 no newsgroup selected';
my $mm = $ng->mm;
my $srch = $ng->search;
more($self, '224 Overview information follows');
- $self->long_response($beg, $end, sub {
+ long_response($self, $beg, $end, sub {
my ($i) = @_;
my $mid = $mm->mid_for($$i) or return;
- my $m = header_obj_for($srch, $mid) or return;
- my $h = $m->header('references');
- more($self, "$$i $h") if defined $h;
+ my $h = search_header_for($srch, $mid, 'references');
+ more($self, "$$i $h");
});
}
sub over_line ($$) {
- my ($self, $r) = @_;
-
- more($self, join("\t", $r->[0], map {
- my $h = hdr_val($r, $_);
- defined $h ? $h : '';
- } @OVERVIEW ));
+ my ($num, $smsg) = @_;
+ # n.b. field access and procedural calls can be
+ # 10%-15% faster than OO method calls:
+ join("\t", $num,
+ $smsg->{subject},
+ $smsg->{from},
+ PublicInbox::SearchMsg::date($smsg),
+ '<'.PublicInbox::SearchMsg::mid($smsg).'>',
+ $smsg->{references},
+ PublicInbox::SearchMsg::bytes($smsg),
+ PublicInbox::SearchMsg::lines($smsg));
}
sub cmd_over ($;$) {
my ($self, $range) = @_;
- if ($range && $range =~ /\A<.+>\z/) {
- my $r = $self->art_lookup($range, 2);
- return '430 No article with that message-id' unless ref $r;
+ if ($range && $range =~ /\A<(.+)>\z/) {
+ my ($ng, $n) = mid_lookup($self, $1);
+ my $smsg = $ng->search->lookup_message($range) or
+ return '430 No article with that message-id';
more($self, '224 Overview information follows (multi-line)');
+ $smsg = PublicInbox::SearchMsg->load_doc($smsg->{doc});
# Only set article number column if it's the current group
- my $ng = $self->{ng};
- $r->[0] = 0 if (!$ng || $ng ne $r->[5]);
- over_line($self, $r);
+ my $self_ng = $self->{ng};
+ $n = 0 if (!$self_ng || $self_ng ne $ng);
+ more($self, over_line($n, $smsg));
'.';
} else {
cmd_xover($self, $range);
return $r unless ref $r;
my ($beg, $end) = @$r;
more($self, "224 Overview information follows for $beg to $end");
- $self->long_response($beg, $end, sub {
+ my $srch = $self->{ng}->search;
+ my $off = 0;
+ long_response($self, $beg, $end, sub {
my ($i) = @_;
- my $r = $self->art_lookup($$i, 2);
- return unless ref $r;
- over_line($self, $r);
+ my $res = $srch->query_xover($beg, $end, $off);
+ my $msgs = $res->{msgs};
+ my $nr = scalar @$msgs or return;
+ $off += $nr;
+
+ # OVERVIEW.FMT
+ more($self, join("\r\n", map {
+ over_line(PublicInbox::SearchMsg::num($_), $_);
+ } @$msgs));
+
+ # -1 to adjust for implicit increment in long_response
+ $$i = $nr ? $$i + $nr - 1 : long_response_limit;
});
}
$data = substr($data, $n, $dlen - $n);
}
}
- $self->do_write($data);
+ do_write($self, $data);
}
-# callbacks for by Danga::Socket
+# callbacks for Danga::Socket
sub event_hup { $_[0]->close }
sub event_err { $_[0]->close }
sub event_write {
my ($self) = @_;
+ update_idle_time($self);
# only continue watching for readability when we are done writing:
if ($self->write(undef) == 1 && !$self->{long_res}) {
$self->watch_read(1);
my $line = $1;
my $t0 = now();
my $fd = $self->{fd};
- $r = eval { $self->process_line($line) };
+ $r = eval { process_line($self, $line) };
my $d = $self->{long_res} ?
" deferred[$fd]" : '';
- out($self, "[$fd] $line - %0.6f$d", now() - $t0);
+ out($self, "[$fd] %s - %0.6f$d", $line, now() - $t0);
}
return $self->close if $r < 0;
my $len = length($self->{rbuf});
return $self->close if ($len >= LINE_MAX);
+ update_idle_time($self);
}
sub watch_read {
# and we must double-check again by the time the timer fires
# in case we really did dispatch a read event and started
# another long response.
- Danga::Socket->AddTimer(0, sub {
- if (&Danga::Socket::POLLIN & $self->{event_watch}) {
- $self->event_read;
- }
- });
+ push @$nextq, $self;
+ $next_tick ||= Danga::Socket->AddTimer(0, *next_tick);
}
$rv;
}
+# for graceful shutdown in PublicInbox::Daemon:
sub busy () {
my ($self) = @_;
($self->{rbuf} ne '' || $self->{long_res} || $self->{write_buf_size});