lib/PublicInbox/NNTP.pm

   1 # Copyright (C) 2015 all contributors <meta@public-inbox.org>
   2 # License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt)
   3 #
   4 # Each instance of this represents a NNTP client socket
   5 package PublicInbox::NNTP;
   6 use strict;
   7 use warnings;
   8 use base qw(Danga::Socket);
   9 use fields qw(nntpd article rbuf ng long_res);
  10 use PublicInbox::Search;
  11 use PublicInbox::Msgmap;
  12 use PublicInbox::Git;
  13 use PublicInbox::MID qw(mid2path);
  14 require PublicInbox::EvCleanup;
  15 use Email::Simple;
  16 use POSIX qw(strftime);
  17 use Time::HiRes qw(clock_gettime CLOCK_MONOTONIC);
  18 use URI::Escape qw(uri_escape_utf8);
  19 use constant {
  20         r501 => '501 command syntax error',
  21         r221 => '221 Header follows',
  22         r224 => '224 Overview information follows (multi-line)',
  23         r225 => '225 Headers follow (multi-line)',
  24         r430 => '430 No article with that message-id',
  25         long_response_limit => 0xffffffff,
  26 };
  27
  28 sub now () { clock_gettime(CLOCK_MONOTONIC) };
  29
  30 my @OVERVIEW = qw(Subject From Date Message-ID References);
  31 my $OVERVIEW_FMT = join(":\r\n", @OVERVIEW, qw(Bytes Lines)) . ":\r\n";
  32 my $LIST_HEADERS = join("\r\n", @OVERVIEW,
  33                         qw(:bytes :lines Xref To Cc)) . "\r\n";
  34
  35 # disable commands with easy DoS potential:
  36 # LISTGROUP could get pretty bad, too...
  37 my %DISABLED; # = map { $_ => 1 } qw(xover list_overview_fmt newnews xhdr);
  38
  39 my $EXPMAP; # fd -> [ idle_time, $self ]
  40 my $expt;
  41 our $EXPTIME = 180; # 3 minutes
  42 my $WEAKEN = {}; # string(nntpd) -> nntpd
  43 my $weakt;
  44 my $nextt;
  45
  46 my $nextq = [];
  47 sub next_tick () {
  48         $nextt = undef;
  49         my $q = $nextq;
  50         $nextq = [];
  51         foreach my $nntp (@$q) {
  52                 # for request && response protocols, always finish writing
  53                 # before finishing reading:
  54                 if (my $long_cb = $nntp->{long_res}) {
  55                         $nntp->write($long_cb);
  56                 } elsif (&Danga::Socket::POLLIN & $nntp->{event_watch}) {
  57                         event_read($nntp);
  58                 }
  59         }
  60 }
  61
  62 sub update_idle_time ($) {
  63         my ($self) = @_;
  64         my $tmp = $self->{sock} or return;
  65         $tmp = fileno($tmp);
  66         defined $tmp and $EXPMAP->{$tmp} = [ now(), $self ];
  67 }
  68
  69 # reduce FD pressure by closing some "git cat-file --batch" processes
  70 # and unused FDs for msgmap and Xapian indices
  71 sub weaken_groups () {
  72         $weakt = undef;
  73         foreach my $nntpd (values %$WEAKEN) {
  74                 $_->weaken_all foreach (@{$nntpd->{grouplist}});
  75         }
  76         $WEAKEN = {};
  77 }
  78
  79 sub expire_old () {
  80         my $now = now();
  81         my $exp = $EXPTIME;
  82         my $old = $now - $exp;
  83         my $nr = 0;
  84         my %new;
  85         while (my ($fd, $v) = each %$EXPMAP) {
  86                 my ($idle_time, $nntp) = @$v;
  87                 if ($idle_time < $old) {
  88                         $nntp->close; # idempotent
  89                 } else {
  90                         ++$nr;
  91                         $new{$fd} = $v;
  92                 }
  93         }
  94         $EXPMAP = \%new;
  95         if ($nr) {
  96                 $expt = PublicInbox::EvCleanup::later(*expire_old);
  97                 weaken_groups();
  98         } else {
  99                 $expt = undef;
 100                 # noop to kick outselves out of the loop ASAP so descriptors
 101                 # really get closed
 102                 PublicInbox::EvCleanup::asap(sub {});
 103
 104                 # grace period for reaping resources
 105                 $weakt ||= PublicInbox::EvCleanup::later(*weaken_groups);
 106         }
 107 }
 108
 109 sub new ($$$) {
 110         my ($class, $sock, $nntpd) = @_;
 111         my $self = fields::new($class);
 112         $self->SUPER::new($sock);
 113         $self->{nntpd} = $nntpd;
 114         res($self, '201 server ready - post via email');
 115         $self->{rbuf} = '';
 116         $self->watch_read(1);
 117         update_idle_time($self);
 118         $WEAKEN->{"$nntpd"} = $nntpd;
 119         $expt ||= PublicInbox::EvCleanup::later(*expire_old);
 120         $self;
 121 }
 122
 123 sub args_ok ($$) {
 124         my ($cb, $argc) = @_;
 125         my $tot = prototype $cb;
 126         my ($nreq, undef) = split(';', $tot);
 127         $nreq = ($nreq =~ tr/$//) - 1;
 128         $tot = ($tot =~ tr/$//) - 1;
 129         ($argc <= $tot && $argc >= $nreq);
 130 }
 131
 132 # returns 1 if we can continue, 0 if not due to buffered writes or disconnect
 133 sub process_line ($$) {
 134         my ($self, $l) = @_;
 135         my ($req, @args) = split(/\s+/, $l);
 136         $req = lc($req);
 137         $req = eval {
 138                 no strict 'refs';
 139                 $req = $DISABLED{$req} ? undef : *{'cmd_'.$req}{CODE};
 140         };
 141         return res($self, '500 command not recognized') unless $req;
 142         return res($self, r501) unless args_ok($req, scalar @args);
 143
 144         my $res = eval { $req->($self, @args) };
 145         my $err = $@;
 146         if ($err && !$self->{closed}) {
 147                 chomp($l);
 148                 err($self, 'error from: %s (%s)', $l, $err);
 149                 $res = '503 program fault - command not performed';
 150         }
 151         return 0 unless defined $res;
 152         res($self, $res);
 153 }
 154
 155 sub cmd_mode ($$) {
 156         my ($self, $arg) = @_;
 157         $arg = uc $arg;
 158         return r501 unless $arg eq 'READER';
 159         '201 Posting prohibited';
 160 }
 161
 162 sub cmd_slave ($) { '202 slave status noted' }
 163
 164 sub cmd_xgtitle ($;$) {
 165         my ($self, $wildmat) = @_;
 166         more($self, '282 list of groups and descriptions follows');
 167         list_newsgroups($self, $wildmat);
 168         '.'
 169 }
 170
 171 sub list_overview_fmt ($) {
 172         my ($self) = @_;
 173         do_more($self, $OVERVIEW_FMT);
 174 }
 175
 176 sub list_headers ($;$) {
 177         my ($self) = @_;
 178         do_more($self, $LIST_HEADERS);
 179 }
 180
 181 sub list_active ($;$) {
 182         my ($self, $wildmat) = @_;
 183         wildmat2re($wildmat);
 184         foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
 185                 $ng->{newsgroup} =~ $wildmat or next;
 186                 group_line($self, $ng);
 187         }
 188 }
 189
 190 sub list_active_times ($;$) {
 191         my ($self, $wildmat) = @_;
 192         wildmat2re($wildmat);
 193         foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
 194                 $ng->{newsgroup} =~ $wildmat or next;
 195                 my $c = eval { $ng->mm->created_at } || time;
 196                 more($self, "$ng->{newsgroup} $c $ng->{-primary_address}");
 197         }
 198 }
 199
 200 sub list_newsgroups ($;$) {
 201         my ($self, $wildmat) = @_;
 202         wildmat2re($wildmat);
 203         foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
 204                 $ng->{newsgroup} =~ $wildmat or next;
 205                 my $d = $ng->description;
 206                 more($self, "$ng->{newsgroup} $d");
 207         }
 208 }
 209
 210 # LIST SUBSCRIPTIONS, DISTRIB.PATS are not supported
 211 sub cmd_list ($;$$) {
 212         my ($self, @args) = @_;
 213         if (scalar @args) {
 214                 my $arg = shift @args;
 215                 $arg =~ tr/A-Z./a-z_/;
 216                 $arg = "list_$arg";
 217                 return r501 if $DISABLED{$arg};
 218
 219                 $arg = eval {
 220                         no strict 'refs';
 221                         *{$arg}{CODE};
 222                 };
 223                 return r501 unless $arg && args_ok($arg, scalar @args);
 224                 more($self, '215 information follows');
 225                 $arg->($self, @args);
 226         } else {
 227                 more($self, '215 list of newsgroups follows');
 228                 foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
 229                         group_line($self, $ng);
 230                 }
 231         }
 232         '.'
 233 }
 234
 235 sub cmd_listgroup ($;$) {
 236         my ($self, $group) = @_;
 237         if (defined $group) {
 238                 my $res = cmd_group($self, $group);
 239                 return $res if ($res !~ /\A211 /);
 240                 more($self, $res);
 241         }
 242
 243         $self->{ng} or return '412 no newsgroup selected';
 244         long_response($self, 0, long_response_limit, sub {
 245                 my ($i) = @_;
 246                 my $nr = $self->{ng}->mm->id_batch($$i, sub {
 247                         my ($ary) = @_;
 248                         more($self, join("\r\n", @$ary));
 249                 });
 250
 251                 # -1 to adjust for implicit increment in long_response
 252                 $$i = $nr ? $$i + $nr - 1 : long_response_limit;
 253         });
 254 }
 255
 256 sub parse_time ($$;$) {
 257         my ($date, $time, $gmt) = @_;
 258         use Time::Local qw();
 259         my ($hh, $mm, $ss) = unpack('A2A2A2', $time);
 260         if (defined $gmt) {
 261                 $gmt =~ /\A(?:UTC|GMT)\z/i or die "GM invalid: $gmt";
 262                 $gmt = 1;
 263         }
 264         my @now = $gmt ? gmtime : localtime;
 265         my ($YYYY, $MM, $DD);
 266         if (length($date) == 8) { # RFC 3977 allows YYYYMMDD
 267                 ($YYYY, $MM, $DD) = unpack('A4A2A2', $date);
 268         } else { # legacy clients send YYMMDD
 269                 ($YYYY, $MM, $DD) = unpack('A2A2A2', $date);
 270                 if ($YYYY > strftime('%y', @now)) {
 271                         my $cur_year = $now[5] + 1900;
 272                         $YYYY += int($cur_year / 1000) * 1000 - 100;
 273                 }
 274         }
 275         if ($gmt) {
 276                 Time::Local::timegm($ss, $mm, $hh, $DD, $MM - 1, $YYYY);
 277         } else {
 278                 Time::Local::timelocal($ss, $mm, $hh, $DD, $MM - 1, $YYYY);
 279         }
 280 }
 281
 282 sub group_line ($$) {
 283         my ($self, $ng) = @_;
 284         my ($min, $max) = $ng->mm->minmax;
 285         more($self, "$ng->{newsgroup} $max $min n") if defined $min && defined $max;
 286 }
 287
 288 sub cmd_newgroups ($$$;$$) {
 289         my ($self, $date, $time, $gmt, $dists) = @_;
 290         my $ts = eval { parse_time($date, $time, $gmt) };
 291         return r501 if $@;
 292
 293         # TODO dists
 294         more($self, '231 list of new newsgroups follows');
 295         foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
 296                 my $c = eval { $ng->mm->created_at } || 0;
 297                 next unless $c > $ts;
 298                 group_line($self, $ng);
 299         }
 300         '.'
 301 }
 302
 303 sub wildmat2re (;$) {
 304         return $_[0] = qr/.*/ if (!defined $_[0] || $_[0] eq '*');
 305         my %keep;
 306         my $salt = rand;
 307         use Digest::SHA qw(sha1_hex);
 308         my $tmp = $_[0];
 309
 310         $tmp =~ s#(?<!\\)\[(.+)(?<!\\)\]#
 311                 my $orig = $1;
 312                 my $key = sha1_hex($orig . $salt);
 313                 $orig =~ s/([^\w\-])+/\Q$1/g;
 314                 $keep{$key} = $orig;
 315                 $key
 316                 #gex;
 317         my %map = ('*' => '.*', '?' => '.' );
 318         $tmp =~ s#(?<!\\)([^\w\\])#$map{$1} || "\Q$1"#ge;
 319         if (scalar %keep) {
 320                 $tmp =~ s#([a-f0-9]{40})#
 321                         my $orig = $keep{$1};
 322                         defined $orig ? $orig : $1;
 323                         #ge;
 324         }
 325         $_[0] = qr/\A$tmp\z/;
 326 }
 327
 328 sub ngpat2re (;$) {
 329         return $_[0] = qr/\A\z/ unless defined $_[0];
 330         my %map = ('*' => '.*', ',' => '|');
 331         $_[0] =~ s!(.)!$map{$1} || "\Q$1"!ge;
 332         $_[0] = qr/\A(?:$_[0])\z/;
 333 }
 334
 335 sub cmd_newnews ($$$$;$$) {
 336         my ($self, $newsgroups, $date, $time, $gmt, $dists) = @_;
 337         my $ts = eval { parse_time($date, $time, $gmt) };
 338         return r501 if $@;
 339         more($self, '230 list of new articles by message-id follows');
 340         my ($keep, $skip) = split('!', $newsgroups, 2);
 341         ngpat2re($keep);
 342         ngpat2re($skip);
 343         my @srch;
 344         foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
 345                 $ng->{newsgroup} =~ $keep or next;
 346                 $ng->{newsgroup} =~ $skip and next;
 347                 my $srch = $ng->search or next;
 348                 push @srch, $srch;
 349         };
 350         return '.' unless @srch;
 351
 352         $ts .= '..';
 353         my $opts = { asc => 1, limit => 1000, offset => 0 };
 354         long_response($self, 0, long_response_limit, sub {
 355                 my ($i) = @_;
 356                 my $srch = $srch[0];
 357                 my $res = $srch->query($ts, $opts);
 358                 my $msgs = $res->{msgs};
 359                 if (my $nr = scalar @$msgs) {
 360                         more($self, '<' .
 361                                 join(">\r\n<", map { $_->mid } @$msgs ).
 362                                 '>');
 363                         $opts->{offset} += $nr;
 364                 } else {
 365                         shift @srch;
 366                         if (@srch) { # continue onto next newsgroup
 367                                 $opts->{offset} = 0;
 368                         } else { # break out of the long response.
 369                                 $$i = long_response_limit;
 370                         }
 371                 }
 372         });
 373 }
 374
 375 sub cmd_group ($$) {
 376         my ($self, $group) = @_;
 377         my $no_such = '411 no such news group';
 378         my $ng = $self->{nntpd}->{groups}->{$group} or return $no_such;
 379
 380         $self->{ng} = $ng;
 381         my ($min, $max) = $ng->mm->minmax;
 382         $min ||= 0;
 383         $max ||= 0;
 384         $self->{article} = $min;
 385         my $est_size = $max - $min;
 386         "211 $est_size $min $max $group";
 387 }
 388
 389 sub article_adj ($$) {
 390         my ($self, $off) = @_;
 391         my $ng = $self->{ng} or return '412 no newsgroup selected';
 392
 393         my $n = $self->{article};
 394         defined $n or return '420 no current article has been selected';
 395
 396         $n += $off;
 397         my $mid = $ng->mm->mid_for($n);
 398         unless ($mid) {
 399                 $n = $off > 0 ? 'next' : 'previous';
 400                 return "421 no $n article in this group";
 401         }
 402         $self->{article} = $n;
 403         "223 $n <$mid> article retrieved - request text separately";
 404 }
 405
 406 sub cmd_next ($) { article_adj($_[0], 1) }
 407 sub cmd_last ($) { article_adj($_[0], -1) }
 408
 409 # We want to encourage using email and CC-ing everybody involved to avoid
 410 # the single-point-of-failure a single server provides.
 411 sub cmd_post ($) {
 412         my ($self) = @_;
 413         my $ng = $self->{ng};
 414         $ng ? "440 mailto:$ng->{-primary_address} to post"
 415                 : '440 posting not allowed'
 416 }
 417
 418 sub cmd_quit ($) {
 419         my ($self) = @_;
 420         res($self, '205 closing connection - goodbye!');
 421         $self->close;
 422         undef;
 423 }
 424
 425 sub header_append ($$$) {
 426         my ($hdr, $k, $v) = @_;
 427         my @v = $hdr->header($k);
 428         foreach (@v) {
 429                 return if $v eq $_;
 430         }
 431         $hdr->header_set($k, @v, $v);
 432 }
 433
 434 sub set_nntp_headers {
 435         my ($hdr, $ng, $n, $mid) = @_;
 436
 437         # clobber some
 438         $hdr->header_set('Newsgroups', $ng->{newsgroup});
 439         $hdr->header_set('Xref', xref($ng, $n));
 440         header_append($hdr, 'List-Post', "<mailto:$ng->{-primary_address}>");
 441         if (my $url = $ng->base_url) {
 442                 $mid = uri_escape_utf8($mid);
 443                 header_append($hdr, 'Archived-At', "<$url$mid/>");
 444                 header_append($hdr, 'List-Archive', "<$url>");
 445         }
 446 }
 447
 448 sub art_lookup ($$$) {
 449         my ($self, $art, $set_headers) = @_;
 450         my $ng = $self->{ng};
 451         my ($n, $mid);
 452         my $err;
 453         if (defined $art) {
 454                 if ($art =~ /\A\d+\z/o) {
 455                         $err = '423 no such article number in this group';
 456                         $n = int($art);
 457                         goto find_mid;
 458                 } elsif ($art =~ /\A<([^>]+)>\z/) {
 459                         $mid = $1;
 460                         $err = r430;
 461                         $n = $ng->mm->num_for($mid) if $ng;
 462                         goto found if defined $n;
 463                         foreach my $g (values %{$self->{nntpd}->{groups}}) {
 464                                 $n = $g->mm->num_for($mid);
 465                                 if (defined $n) {
 466                                         $ng = $g;
 467                                         goto found;
 468                                 }
 469                         }
 470                         return $err;
 471                 } else {
 472                         return r501;
 473                 }
 474         } else {
 475                 $err = '420 no current article has been selected';
 476                 $n = $self->{article};
 477                 defined $n or return $err;
 478 find_mid:
 479                 $ng or return '412 no newsgroup has been selected';
 480                 $mid = $ng->mm->mid_for($n);
 481                 defined $mid or return $err;
 482         }
 483 found:
 484         my $o = 'HEAD:' . mid2path($mid);
 485         my $bytes;
 486         my $s = eval { Email::Simple->new($ng->git->cat_file($o, \$bytes)) };
 487         return $err unless $s;
 488         my $lines;
 489         if ($set_headers) {
 490                 set_nntp_headers($s->header_obj, $ng, $n, $mid);
 491                 $lines = $s->body =~ tr!\n!\n!;
 492
 493                 # must be last
 494                 $s->body_set('') if ($set_headers == 2);
 495         }
 496         [ $n, $mid, $s, $bytes, $lines, $ng ];
 497 }
 498
 499 sub simple_body_write ($$) {
 500         my ($self, $s) = @_;
 501         my $body = $s->body;
 502         $s->body_set('');
 503         $body =~ s/^\./../smg;
 504         $body =~ s/(?<!\r)\n/\r\n/sg;
 505         do_more($self, $body);
 506         do_more($self, "\r\n") unless $body =~ /\r\n\z/s;
 507         '.'
 508 }
 509
 510 sub set_art {
 511         my ($self, $art) = @_;
 512         $self->{article} = $art if defined $art && $art =~ /\A\d+\z/;
 513 }
 514
 515 sub _header ($) {
 516         my $hdr = $_[0]->header_obj->as_string;
 517         utf8::encode($hdr);
 518         $hdr
 519 }
 520
 521 sub cmd_article ($;$) {
 522         my ($self, $art) = @_;
 523         my $r = art_lookup($self, $art, 1);
 524         return $r unless ref $r;
 525         my ($n, $mid, $s) = @$r;
 526         set_art($self, $art);
 527         more($self, "220 $n <$mid> article retrieved - head and body follow");
 528         do_more($self, _header($s));
 529         do_more($self, "\r\n");
 530         simple_body_write($self, $s);
 531 }
 532
 533 sub cmd_head ($;$) {
 534         my ($self, $art) = @_;
 535         my $r = art_lookup($self, $art, 2);
 536         return $r unless ref $r;
 537         my ($n, $mid, $s) = @$r;
 538         set_art($self, $art);
 539         more($self, "221 $n <$mid> article retrieved - head follows");
 540         do_more($self, _header($s));
 541         '.'
 542 }
 543
 544 sub cmd_body ($;$) {
 545         my ($self, $art) = @_;
 546         my $r = art_lookup($self, $art, 0);
 547         return $r unless ref $r;
 548         my ($n, $mid, $s) = @$r;
 549         set_art($self, $art);
 550         more($self, "222 $n <$mid> article retrieved - body follows");
 551         simple_body_write($self, $s);
 552 }
 553
 554 sub cmd_stat ($;$) {
 555         my ($self, $art) = @_;
 556         my $r = art_lookup($self, $art, 0);
 557         return $r unless ref $r;
 558         my ($n, $mid, undef) = @$r;
 559         set_art($self, $art);
 560         "223 $n <$mid> article retrieved - request text separately";
 561 }
 562
 563 sub cmd_ihave ($) { '435 article not wanted - do not send it' }
 564
 565 sub cmd_date ($) { '111 '.strftime('%Y%m%d%H%M%S', gmtime(time)) }
 566
 567 sub cmd_help ($) {
 568         my ($self) = @_;
 569         more($self, '100 help text follows');
 570         '.'
 571 }
 572
 573 sub get_range ($$) {
 574         my ($self, $range) = @_;
 575         my $ng = $self->{ng} or return '412 no news group has been selected';
 576         defined $range or return '420 No article(s) selected';
 577         my ($beg, $end);
 578         my ($min, $max) = $ng->mm->minmax;
 579         if ($range =~ /\A(\d+)\z/) {
 580                 $beg = $end = $1;
 581         } elsif ($range =~ /\A(\d+)-\z/) {
 582                 ($beg, $end) = ($1, $max);
 583         } elsif ($range =~ /\A(\d+)-(\d+)\z/) {
 584                 ($beg, $end) = ($1, $2);
 585         } else {
 586                 return r501;
 587         }
 588         $beg = $min if ($beg < $min);
 589         $end = $max if ($end > $max);
 590         return '420 No article(s) selected' if ($beg > $end);
 591         [ $beg, $end ];
 592 }
 593
 594 sub long_response ($$$$) {
 595         my ($self, $beg, $end, $cb) = @_;
 596         die "BUG: nested long response" if $self->{long_res};
 597
 598         my $fd = $self->{fd};
 599         defined $fd or return;
 600         # make sure we disable reading during a long response,
 601         # clients should not be sending us stuff and making us do more
 602         # work while we are stream a response to them
 603         $self->watch_read(0);
 604         my $t0 = now();
 605         $self->{long_res} = sub {
 606                 # limit our own running time for fairness with other
 607                 # clients and to avoid buffering too much:
 608                 my $lim = 100;
 609
 610                 my $err;
 611                 do {
 612                         eval { $cb->(\$beg) };
 613                 } until (($err = $@) || $self->{closed} ||
 614                          ++$beg > $end || !--$lim || $self->{write_buf_size});
 615
 616                 if ($err || $self->{closed}) {
 617                         $self->{long_res} = undef;
 618
 619                         if ($err) {
 620                                 err($self,
 621                                     "%s during long response[$fd] - %0.6f",
 622                                     $err, now() - $t0);
 623                         }
 624                         if ($self->{closed}) {
 625                                 out($self, " deferred[$fd] aborted - %0.6f",
 626                                            now() - $t0);
 627                         } else {
 628                                 update_idle_time($self);
 629                                 $self->watch_read(1);
 630                         }
 631                 } elsif (!$lim || $self->{write_buf_size}) {
 632                         # no recursion, schedule another call ASAP
 633                         # but only after all pending writes are done
 634                         update_idle_time($self);
 635
 636                         push @$nextq, $self;
 637                         $nextt ||= PublicInbox::EvCleanup::asap(*next_tick);
 638                 } else { # all done!
 639                         $self->{long_res} = undef;
 640                         $self->watch_read(1);
 641                         res($self, '.');
 642                         out($self, " deferred[$fd] done - %0.6f", now() - $t0);
 643                 }
 644         };
 645         $self->{long_res}->(); # kick off!
 646         undef;
 647 }
 648
 649 sub hdr_message_id ($$$) { # optimize XHDR Message-ID [range] for slrnpull.
 650         my ($self, $xhdr, $range) = @_;
 651
 652         if (defined $range && $range =~ /\A<(.+)>\z/) { # Message-ID
 653                 my ($ng, $n) = mid_lookup($self, $1);
 654                 return r430 unless $n;
 655                 hdr_mid_response($self, $xhdr, $ng, $n, $range, $range);
 656         } else { # numeric range
 657                 $range = $self->{article} unless defined $range;
 658                 my $r = get_range($self, $range);
 659                 return $r unless ref $r;
 660                 my $mm = $self->{ng}->mm;
 661                 my ($beg, $end) = @$r;
 662                 more($self, $xhdr ? r221 : r225);
 663                 long_response($self, $beg, $end, sub {
 664                         my ($i) = @_;
 665                         my $mid = $mm->mid_for($$i);
 666                         more($self, "$$i <$mid>") if defined $mid;
 667                 });
 668         }
 669 }
 670
 671 sub xref ($$) {
 672         my ($ng, $n) = @_;
 673         "$ng->{domain} $ng->{newsgroup}:$n"
 674 }
 675
 676 sub mid_lookup ($$) {
 677         my ($self, $mid) = @_;
 678         my $self_ng = $self->{ng};
 679         if ($self_ng) {
 680                 my $n = $self_ng->mm->num_for($mid);
 681                 return ($self_ng, $n) if defined $n;
 682         }
 683         foreach my $ng (values %{$self->{nntpd}->{groups}}) {
 684                 next if defined $self_ng && $ng eq $self_ng;
 685                 my $n = $ng->mm->num_for($mid);
 686                 return ($ng, $n) if defined $n;
 687         }
 688         (undef, undef);
 689 }
 690
 691 sub hdr_xref ($$$) { # optimize XHDR Xref [range] for rtin
 692         my ($self, $xhdr, $range) = @_;
 693
 694         if (defined $range && $range =~ /\A<(.+)>\z/) { # Message-ID
 695                 my ($ng, $n) = mid_lookup($self, $1);
 696                 return r430 unless $n;
 697                 hdr_mid_response($self, $xhdr, $ng, $n, $range, xref($ng, $n));
 698         } else { # numeric range
 699                 $range = $self->{article} unless defined $range;
 700                 my $r = get_range($self, $range);
 701                 return $r unless ref $r;
 702                 my $ng = $self->{ng};
 703                 my $mm = $ng->mm;
 704                 my ($beg, $end) = @$r;
 705                 more($self, $xhdr ? r221 : r225);
 706                 long_response($self, $beg, $end, sub {
 707                         my ($i) = @_;
 708                         my $mid = $mm->mid_for($$i);
 709                         more($self, "$$i ".xref($ng, $$i)) if defined $mid;
 710                 });
 711         }
 712 }
 713
 714 sub search_header_for {
 715         my ($srch, $mid, $field) = @_;
 716         my $smsg = $srch->lookup_message($mid) or return;
 717         $smsg = PublicInbox::SearchMsg->load_doc($smsg->{doc});
 718         $smsg->$field;
 719 }
 720
 721 sub hdr_searchmsg ($$$$) {
 722         my ($self, $xhdr, $field, $range) = @_;
 723         if (defined $range && $range =~ /\A<(.+)>\z/) { # Message-ID
 724                 my ($ng, $n) = mid_lookup($self, $1);
 725                 return r430 unless $n;
 726                 my $v = search_header_for($ng->search, $range, $field);
 727                 hdr_mid_response($self, $xhdr, $ng, $n, $range, $v);
 728         } else { # numeric range
 729                 $range = $self->{article} unless defined $range;
 730                 my $srch = $self->{ng}->search;
 731                 my $mm = $self->{ng}->mm;
 732                 my $r = get_range($self, $range);
 733                 return $r unless ref $r;
 734                 my ($beg, $end) = @$r;
 735                 more($self, $xhdr ? r221 : r225);
 736                 my $off = 0;
 737                 long_response($self, $beg, $end, sub {
 738                         my ($i) = @_;
 739                         my $res = $srch->query_xover($beg, $end, $off);
 740                         my $msgs = $res->{msgs};
 741                         my $nr = scalar @$msgs or return;
 742                         $off += $nr;
 743                         my $tmp = '';
 744                         foreach my $s (@$msgs) {
 745                                 $tmp .= $s->num . ' ' . $s->$field . "\r\n";
 746                         }
 747                         utf8::encode($tmp);
 748                         do_more($self, $tmp);
 749                         # -1 to adjust for implicit increment in long_response
 750                         $$i = $nr ? $$i + $nr - 1 : long_response_limit;
 751                 });
 752         }
 753 }
 754
 755 sub do_hdr ($$$;$) {
 756         my ($self, $xhdr, $header, $range) = @_;
 757         my $sub = lc $header;
 758         if ($sub eq 'message-id') {
 759                 hdr_message_id($self, $xhdr, $range);
 760         } elsif ($sub eq 'xref') {
 761                 hdr_xref($self, $xhdr, $range);
 762         } elsif ($sub =~ /\A(?:subject|references|date|from|to|cc|
 763                                 bytes|lines)\z/x) {
 764                 hdr_searchmsg($self, $xhdr, $sub, $range);
 765         } elsif ($sub =~ /\A:(bytes|lines)\z/) {
 766                 hdr_searchmsg($self, $xhdr, $1, $range);
 767         } else {
 768                 $xhdr ? (r221 . "\r\n.") : "503 HDR not permitted on $header";
 769         }
 770 }
 771
 772 # RFC 3977
 773 sub cmd_hdr ($$;$) {
 774         my ($self, $header, $range) = @_;
 775         do_hdr($self, 0, $header, $range);
 776 }
 777
 778 # RFC 2980
 779 sub cmd_xhdr ($$;$) {
 780         my ($self, $header, $range) = @_;
 781         do_hdr($self, 1, $header, $range);
 782 }
 783
 784 sub hdr_mid_prefix ($$$$$) {
 785         my ($self, $xhdr, $ng, $n, $mid) = @_;
 786         return $mid if $xhdr;
 787
 788         # HDR for RFC 3977 users
 789         if (my $self_ng = $self->{ng}) {
 790                 ($self_ng eq $ng) ? $n : '0';
 791         } else {
 792                 '0';
 793         }
 794 }
 795
 796 sub hdr_mid_response ($$$$$$) {
 797         my ($self, $xhdr, $ng, $n, $mid, $v) = @_; # r: art_lookup result
 798         my $res = '';
 799         if ($xhdr) {
 800                 $res .= r221 . "\r\n";
 801                 $res .= "$mid $v\r\n";
 802         } else {
 803                 $res .= r225 . "\r\n";
 804                 my $pfx = hdr_mid_prefix($self, $xhdr, $ng, $n, $mid);
 805                 $res .= "$pfx $v\r\n";
 806         }
 807         res($self, $res .= '.');
 808         undef;
 809 }
 810
 811 sub cmd_xrover ($;$) {
 812         my ($self, $range) = @_;
 813         my $ng = $self->{ng} or return '412 no newsgroup selected';
 814         (defined $range && $range =~ /[<>]/) and
 815                 return '420 No article(s) selected'; # no message IDs
 816
 817         $range = $self->{article} unless defined $range;
 818         my $r = get_range($self, $range);
 819         return $r unless ref $r;
 820         my ($beg, $end) = @$r;
 821         my $mm = $ng->mm;
 822         my $srch = $ng->search;
 823         more($self, '224 Overview information follows');
 824         long_response($self, $beg, $end, sub {
 825                 my ($i) = @_;
 826                 my $mid = $mm->mid_for($$i) or return;
 827                 my $h = search_header_for($srch, $mid, 'references');
 828                 more($self, "$$i $h");
 829         });
 830 }
 831
 832 sub over_line ($$) {
 833         my ($num, $smsg) = @_;
 834         # n.b. field access and procedural calls can be
 835         # 10%-15% faster than OO method calls:
 836         my $s = join("\t", $num,
 837                 $smsg->{subject},
 838                 $smsg->{from},
 839                 PublicInbox::SearchMsg::date($smsg),
 840                 '<'.PublicInbox::SearchMsg::mid($smsg).'>',
 841                 $smsg->{references},
 842                 PublicInbox::SearchMsg::bytes($smsg),
 843                 PublicInbox::SearchMsg::lines($smsg));
 844         utf8::encode($s);
 845         $s
 846 }
 847
 848 sub cmd_over ($;$) {
 849         my ($self, $range) = @_;
 850         if ($range && $range =~ /\A<(.+)>\z/) {
 851                 my ($ng, $n) = mid_lookup($self, $1);
 852                 my $smsg = $ng->search->lookup_message($range) or
 853                         return '430 No article with that message-id';
 854                 more($self, '224 Overview information follows (multi-line)');
 855                 $smsg = PublicInbox::SearchMsg->load_doc($smsg->{doc});
 856
 857                 # Only set article number column if it's the current group
 858                 my $self_ng = $self->{ng};
 859                 $n = 0 if (!$self_ng || $self_ng ne $ng);
 860                 more($self, over_line($n, $smsg));
 861                 '.';
 862         } else {
 863                 cmd_xover($self, $range);
 864         }
 865 }
 866
 867 sub cmd_xover ($;$) {
 868         my ($self, $range) = @_;
 869         $range = $self->{article} unless defined $range;
 870         my $r = get_range($self, $range);
 871         return $r unless ref $r;
 872         my ($beg, $end) = @$r;
 873         more($self, "224 Overview information follows for $beg to $end");
 874         my $srch = $self->{ng}->search;
 875         my $off = 0;
 876         long_response($self, $beg, $end, sub {
 877                 my ($i) = @_;
 878                 my $res = $srch->query_xover($beg, $end, $off);
 879                 my $msgs = $res->{msgs};
 880                 my $nr = scalar @$msgs or return;
 881                 $off += $nr;
 882
 883                 # OVERVIEW.FMT
 884                 more($self, join("\r\n", map {
 885                         over_line(PublicInbox::SearchMsg::num($_), $_);
 886                         } @$msgs));
 887
 888                 # -1 to adjust for implicit increment in long_response
 889                 $$i = $nr ? $$i + $nr - 1 : long_response_limit;
 890         });
 891 }
 892
 893 sub cmd_xpath ($$) {
 894         my ($self, $mid) = @_;
 895         return r501 unless $mid =~ /\A<(.+)>\z/;
 896         $mid = $1;
 897         my @paths;
 898         foreach my $ng (values %{$self->{nntpd}->{groups}}) {
 899                 my $n = $ng->mm->num_for($mid);
 900                 push @paths, "$ng->{newsgroup}/$n" if defined $n;
 901         }
 902         return '430 no such article on server' unless @paths;
 903         '223 '.join(' ', @paths);
 904 }
 905
 906 sub res ($$) {
 907         my ($self, $line) = @_;
 908         do_write($self, $line . "\r\n");
 909 }
 910
 911 sub more ($$) {
 912         my ($self, $line) = @_;
 913         do_more($self, $line . "\r\n");
 914 }
 915
 916 sub do_write ($$) {
 917         my ($self, $data) = @_;
 918         my $done = $self->write($data);
 919         die if $self->{closed};
 920
 921         # Do not watch for readability if we have data in the queue,
 922         # instead re-enable watching for readability when we can
 923         $self->watch_read(0) if (!$done || $self->{long_res});
 924
 925         $done;
 926 }
 927
 928 sub err ($$;@) {
 929         my ($self, $fmt, @args) = @_;
 930         printf { $self->{nntpd}->{err} } $fmt."\n", @args;
 931 }
 932
 933 sub out ($$;@) {
 934         my ($self, $fmt, @args) = @_;
 935         printf { $self->{nntpd}->{out} } $fmt."\n", @args;
 936 }
 937
 938 use constant MSG_MORE => ($^O eq 'linux') ? 0x8000 : 0;
 939
 940 sub do_more ($$) {
 941         my ($self, $data) = @_;
 942         if (MSG_MORE && !$self->{write_buf_size}) {
 943                 my $n = send($self->{sock}, $data, MSG_MORE);
 944                 if (defined $n) {
 945                         my $dlen = length($data);
 946                         return 1 if $n == $dlen; # all done!
 947                         $data = substr($data, $n, $dlen - $n);
 948                 }
 949         }
 950         do_write($self, $data);
 951 }
 952
 953 # callbacks for Danga::Socket
 954
 955 sub event_hup { $_[0]->close }
 956 sub event_err { $_[0]->close }
 957
 958 sub event_write {
 959         my ($self) = @_;
 960         update_idle_time($self);
 961         # only continue watching for readability when we are done writing:
 962         if ($self->write(undef) == 1 && !$self->{long_res}) {
 963                 $self->watch_read(1);
 964         }
 965 }
 966
 967 sub event_read {
 968         my ($self) = @_;
 969         use constant LINE_MAX => 512; # RFC 977 section 2.3
 970         my $r = 1;
 971
 972         my $buf = $self->read(LINE_MAX) or return $self->close;
 973         $self->{rbuf} .= $$buf;
 974         while ($r > 0 && $self->{rbuf} =~ s/\A\s*([^\r\n]+)\r?\n//) {
 975                 my $line = $1;
 976                 return $self->close if $line =~ /[[:cntrl:]]/s;
 977                 my $t0 = now();
 978                 my $fd = $self->{fd};
 979                 $r = eval { process_line($self, $line) };
 980                 my $d = $self->{long_res} ?
 981                         " deferred[$fd]" : '';
 982                 out($self, "[$fd] %s - %0.6f$d", $line, now() - $t0);
 983         }
 984
 985         return $self->close if $r < 0;
 986         my $len = length($self->{rbuf});
 987         return $self->close if ($len >= LINE_MAX);
 988         update_idle_time($self);
 989 }
 990
 991 sub watch_read {
 992         my ($self, $bool) = @_;
 993         my $rv = $self->SUPER::watch_read($bool);
 994         if ($bool && $self->{rbuf} ne '') {
 995                 # Force another read if there is a pipelined request.
 996                 # We don't know if the socket has anything for us to read,
 997                 # and we must double-check again by the time the timer fires
 998                 # in case we really did dispatch a read event and started
 999                 # another long response.
1000                 push @$nextq, $self;
1001                 $nextt ||= PublicInbox::EvCleanup::asap(*next_tick);
1002         }
1003         $rv;
1004 }
1005
1006 # for graceful shutdown in PublicInbox::Daemon:
1007 sub busy () {
1008         my ($self) = @_;
1009         ($self->{rbuf} ne '' || $self->{long_res} || $self->{write_buf_size});
1010 }
1011
1012 1;