]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/NNTP.pm
switch read-only Email::Simple users to Eml
[public-inbox.git] / lib / PublicInbox / NNTP.pm
index fca632e2d484c425a5b6f49af64b8f7f9b759d4c..54207500dd8db5576658ae993169efd10318fdc5 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 all contributors <meta@public-inbox.org>
+# Copyright (C) 2015-2020 all contributors <meta@public-inbox.org>
 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
 #
 # Each instance of this represents a NNTP client socket
@@ -7,8 +7,8 @@ use strict;
 use warnings;
 use base qw(PublicInbox::DS);
 use fields qw(nntpd article ng long_cb);
-use PublicInbox::MID qw(mid_escape);
-use Email::Simple;
+use PublicInbox::MID qw(mid_escape $MID_EXTRACT);
+use PublicInbox::Eml;
 use POSIX qw(strftime);
 use PublicInbox::DS qw(now);
 use Digest::SHA qw(sha1_hex);
@@ -24,7 +24,7 @@ use constant {
 };
 use PublicInbox::Syscall qw(EPOLLIN EPOLLONESHOT);
 use Errno qw(EAGAIN);
-
+my $ONE_MSGID = qr/\A$MID_EXTRACT\z/;
 my @OVERVIEW = qw(Subject From Date Message-ID References);
 my $OVERVIEW_FMT = join(":\r\n", @OVERVIEW, qw(Bytes Lines), '') .
                "Xref:full\r\n";
@@ -38,8 +38,7 @@ NEWNEWS\r
 LIST ACTIVE ACTIVE.TIMES NEWSGROUPS OVERVIEW.FMT\r
 HDR\r
 OVER\r
-
-my $have_deflate;
+COMPRESS DEFLATE\r
 
 sub greet ($) { $_[0]->write($_[0]->{nntpd}->{greet}) };
 
@@ -76,7 +75,7 @@ sub args_ok ($$) {
 # returns 1 if we can continue, 0 if not due to buffered writes or disconnect
 sub process_line ($$) {
        my ($self, $l) = @_;
-       my ($req, @args) = split(/[ \t]/, $l);
+       my ($req, @args) = split(/[ \t]+/, $l);
        return 1 unless defined($req); # skip blank line
        $req = $self->can('cmd_'.lc($req));
        return res($self, '500 command not recognized') unless $req;
@@ -220,16 +219,17 @@ sub parse_time ($$;$) {
                $gmt =~ /\A(?:UTC|GMT)\z/i or die "GM invalid: $gmt";
                $gmt = 1;
        }
-       my @now = $gmt ? gmtime : localtime;
        my ($YYYY, $MM, $DD);
        if (bytes::length($date) == 8) { # RFC 3977 allows YYYYMMDD
                ($YYYY, $MM, $DD) = unpack('A4A2A2', $date);
        } else { # legacy clients send YYMMDD
-               ($YYYY, $MM, $DD) = unpack('A2A2A2', $date);
+               my $YY;
+               ($YY, $MM, $DD) = unpack('A2A2A2', $date);
+               my @now = $gmt ? gmtime : localtime;
                my $cur_year = $now[5] + 1900;
-               if ($YYYY > $cur_year) {
-                       $YYYY += int($cur_year / 1000) * 1000 - 100;
-               }
+               my $cur_cent = int($cur_year / 100) * 100;
+               $YYYY = (($YY + $cur_cent) > $cur_year) ?
+                       ($YY + 1900) : ($YY + $cur_cent);
        }
        if ($gmt) {
                timegm($ss, $mm, $hh, $DD, $MM - 1, $YYYY);
@@ -383,7 +383,7 @@ sub cmd_quit ($) {
 
 sub header_append ($$$) {
        my ($hdr, $k, $v) = @_;
-       my @v = $hdr->header($k);
+       my @v = $hdr->header_raw($k);
        foreach (@v) {
                return if $v eq $_;
        }
@@ -416,16 +416,13 @@ sub set_nntp_headers ($$$$$) {
        # leafnode (and maybe other NNTP clients) have trouble dealing
        # with v2 messages which have multiple Message-IDs (either due
        # to our own content-based dedupe or buggy git-send-email versions).
-       my @mids = $hdr->header('Message-ID');
+       my @mids = $hdr->header_raw('Message-ID');
        if (scalar(@mids) > 1) {
                my $mid0 = "<$mid>";
                $hdr->header_set('Message-ID', $mid0);
-               my @alt = $hdr->header('X-Alt-Message-ID');
+               my @alt = $hdr->header_raw('X-Alt-Message-ID');
                my %seen = map { $_ => 1 } (@alt, $mid0);
-               foreach my $m (@mids) {
-                       next if $seen{$m}++;
-                       push @alt, $m;
-               }
+               push(@alt, grep { !$seen{$_}++ } @mids);
                $hdr->header_set('X-Alt-Message-ID', @alt);
        }
 
@@ -452,7 +449,7 @@ sub art_lookup ($$$) {
                        $err = '423 no such article number in this group';
                        $n = int($art);
                        goto find_mid;
-               } elsif ($art =~ /\A<([^>]+)>\z/) {
+               } elsif ($art =~ $ONE_MSGID) {
                        $mid = $1;
                        $err = r430;
                        $n = $ng->mm->num_for($mid) if $ng;
@@ -481,10 +478,9 @@ found:
        my $smsg = $ng->over->get_art($n) or return $err;
        my $msg = $ng->msg_by_smsg($smsg) or return $err;
 
-       # Email::Simple->new will modify $msg in-place as documented
-       # in its manpage, so what's left is the body and we won't need
-       # to call Email::Simple::body(), later
-       my $hdr = Email::Simple->new($msg)->header_obj;
+       # PublicInbox::Eml->new will modify $msg in-place, so what's
+       # left is the body and we won't need to call ->body(), later
+       my $hdr = PublicInbox::Eml->new($msg)->header_obj;
        set_nntp_headers($self, $hdr, $ng, $n, $mid) if $set_headers;
        [ $n, $mid, $msg, $hdr ];
 }
@@ -508,13 +504,13 @@ sub set_art {
 sub msg_hdr_write ($$$) {
        my ($self, $hdr, $body_follows) = @_;
        $hdr = $hdr->as_string;
+       # fixup old bug from import (pre-a0c07cba0e5d8b6a)
+       $hdr =~ s/\A[\r\n]*From [^\r\n]*\r?\n//s;
        utf8::encode($hdr);
        $hdr =~ s/(?<!\r)\n/\r\n/sg; # Alpine barfs without this
 
        # for leafnode compatibility, we need to ensure Message-ID headers
-       # are only a single line.  We can't subclass Email::Simple::Header
-       # and override _default_fold_at in here, either; since that won't
-       # affect messages already in the archive.
+       # are only a single line.
        $hdr =~ s/^(Message-ID:)[ \t]*\r\n[ \t]+([^\r]+)\r\n/$1 $2\r\n/igsm;
        $hdr .= "\r\n" if $body_follows;
        $self->msg_more($hdr);
@@ -595,12 +591,11 @@ sub get_range ($$) {
 sub long_step {
        my ($self) = @_;
        # wbuf is unset or empty, here; {long} may add to it
-       my ($cb, $t0, @args) = @{$self->{long_cb}};
+       my ($fd, $cb, $t0, @args) = @{$self->{long_cb}};
        my $more = eval { $cb->($self, @args) };
        if ($@ || !$self->{sock}) { # something bad happened...
                delete $self->{long_cb};
                my $elapsed = now() - $t0;
-               my $fd = fileno($self->{sock});
                if ($@) {
                        err($self,
                            "%s during long response[$fd] - %0.6f",
@@ -616,20 +611,19 @@ sub long_step {
                # each other's data
                $self->zflush;
 
-               # no recursion, schedule another call ASAP
-               # but only after all pending writes are done
-               my $wbuf = $self->{wbuf} ||= [];
-               push @$wbuf, \&long_step;
+               # no recursion, schedule another call ASAP, but only after
+               # all pending writes are done.  autovivify wbuf:
+               my $new_size = push(@{$self->{wbuf}}, \&long_step);
 
                # wbuf may be populated by $cb, no need to rearm if so:
-               $self->requeue if scalar(@$wbuf) == 1;
+               $self->requeue if $new_size == 1;
        } else { # all done!
                delete $self->{long_cb};
                res($self, '.');
                my $elapsed = now() - $t0;
                my $fd = fileno($self->{sock});
                out($self, " deferred[$fd] done - %0.6f", $elapsed);
-               my $wbuf = $self->{wbuf};
+               my $wbuf = $self->{wbuf}; # do NOT autovivify
                $self->requeue unless $wbuf && @$wbuf;
        }
 }
@@ -637,11 +631,11 @@ sub long_step {
 sub long_response ($$;@) {
        my ($self, $cb, @args) = @_; # cb returns true if more, false if done
 
-       $self->{sock} or return;
+       my $sock = $self->{sock} or return;
        # make sure we disable reading during a long response,
        # clients should not be sending us stuff and making us do more
        # work while we are stream a response to them
-       $self->{long_cb} = [ $cb, now(), @args ];
+       $self->{long_cb} = [ fileno($sock), $cb, now(), @args ];
        long_step($self); # kick off!
        undef;
 }
@@ -657,7 +651,7 @@ sub hdr_msgid_range_i {
 sub hdr_message_id ($$$) { # optimize XHDR Message-ID [range] for slrnpull.
        my ($self, $xhdr, $range) = @_;
 
-       if (defined $range && $range =~ /\A<(.+)>\z/) { # Message-ID
+       if (defined $range && $range =~ $ONE_MSGID) {
                my ($ng, $n) = mid_lookup($self, $1);
                return r430 unless $n;
                hdr_mid_response($self, $xhdr, $ng, $n, $range, $range);
@@ -700,7 +694,7 @@ sub xref_range_i {
 sub hdr_xref ($$$) { # optimize XHDR Xref [range] for rtin
        my ($self, $xhdr, $range) = @_;
 
-       if (defined $range && $range =~ /\A<(.+)>\z/) { # Message-ID
+       if (defined $range && $range =~ $ONE_MSGID) {
                my $mid = $1;
                my ($ng, $n) = mid_lookup($self, $mid);
                return r430 unless $n;
@@ -718,11 +712,11 @@ sub hdr_xref ($$$) { # optimize XHDR Xref [range] for rtin
 sub over_header_for {
        my ($over, $num, $field) = @_;
        my $smsg = $over->get_art($num) or return;
-       return PublicInbox::SearchMsg::date($smsg) if $field eq 'date';
+       return PublicInbox::Smsg::date($smsg) if $field eq 'date';
        $smsg->{$field};
 }
 
-sub searchmsg_range_i {
+sub smsg_range_i {
        my ($self, $beg, $end, $field) = @_;
        my $over = $self->{ng}->over;
        my $msgs = $over->query_xover($$beg, $end);
@@ -736,9 +730,9 @@ sub searchmsg_range_i {
        $$beg = $msgs->[-1]->{num} + 1;
 }
 
-sub hdr_searchmsg ($$$$) {
+sub hdr_smsg ($$$$) {
        my ($self, $xhdr, $field, $range) = @_;
-       if (defined $range && $range =~ /\A<(.+)>\z/) { # Message-ID
+       if (defined $range && $range =~ $ONE_MSGID) {
                my ($ng, $n) = mid_lookup($self, $1);
                return r430 unless defined $n;
                my $v = over_header_for($ng->over, $n, $field);
@@ -748,7 +742,7 @@ sub hdr_searchmsg ($$$$) {
                my $r = get_range($self, $range);
                return $r unless ref $r;
                more($self, $xhdr ? r221 : r225);
-               long_response($self, \&searchmsg_range_i, @$r, $field);
+               long_response($self, \&smsg_range_i, @$r, $field);
        }
 }
 
@@ -761,9 +755,9 @@ sub do_hdr ($$$;$) {
                hdr_xref($self, $xhdr, $range);
        } elsif ($sub =~ /\A(?:subject|references|date|from|to|cc|
                                bytes|lines)\z/x) {
-               hdr_searchmsg($self, $xhdr, $sub, $range);
+               hdr_smsg($self, $xhdr, $sub, $range);
        } elsif ($sub =~ /\A:(bytes|lines)\z/) {
-               hdr_searchmsg($self, $xhdr, $1, $range);
+               hdr_smsg($self, $xhdr, $1, $range);
        } else {
                $xhdr ? (r221 . "\r\n.") : "503 HDR not permitted on $header";
        }
@@ -835,7 +829,7 @@ sub over_line ($$$$) {
        my $s = join("\t", $num,
                $smsg->{subject},
                $smsg->{from},
-               PublicInbox::SearchMsg::date($smsg),
+               PublicInbox::Smsg::date($smsg),
                "<$smsg->{mid}>",
                $smsg->{references},
                $smsg->{bytes},
@@ -847,7 +841,7 @@ sub over_line ($$$$) {
 
 sub cmd_over ($;$) {
        my ($self, $range) = @_;
-       if ($range && $range =~ /\A<(.+)>\z/) {
+       if ($range && $range =~ $ONE_MSGID) {
                my ($ng, $n) = mid_lookup($self, $1);
                defined $n or return r430;
                my $smsg = $ng->over->get_art($n) or return r430;
@@ -863,6 +857,19 @@ sub cmd_over ($;$) {
        }
 }
 
+sub xover_i {
+       my ($self, $beg, $end) = @_;
+       my $ng = $self->{ng};
+       my $msgs = $ng->over->query_xover($$beg, $end);
+       my $nr = scalar @$msgs or return;
+
+       # OVERVIEW.FMT
+       more($self, join("\r\n", map {
+               over_line($self, $ng, $_->{num}, $_);
+               } @$msgs));
+       $$beg = $msgs->[-1]->{num} + 1;
+}
+
 sub cmd_xover ($;$) {
        my ($self, $range) = @_;
        $range = $self->{article} unless defined $range;
@@ -870,18 +877,7 @@ sub cmd_xover ($;$) {
        return $r unless ref $r;
        my ($beg, $end) = @$r;
        more($self, "224 Overview information follows for $$beg to $end");
-       my $over = $self->{ng}->over;
-       my $cur = $$beg;
-       long_response($self, sub {
-               my $msgs = $over->query_xover($cur, $end);
-               my $nr = scalar @$msgs or return;
-
-               # OVERVIEW.FMT
-               more($self, join("\r\n", map {
-                       over_line($self, $self->{ng}, $_->{num}, $_);
-                       } @$msgs));
-               $cur = $msgs->[-1]->{num} + 1;
-       });
+       long_response($self, \&xover_i, @$r);
 }
 
 sub compressed { undef }
@@ -903,7 +899,7 @@ sub cmd_starttls ($) {
 sub cmd_compress ($$) {
        my ($self, $alg) = @_;
        return '503 Only DEFLATE is supported' if uc($alg) ne 'DEFLATE';
-       return r502 if $self->compressed || !$have_deflate;
+       return r502 if $self->compressed;
        PublicInbox::NNTPdeflate->enable($self);
        $self->requeue;
        undef
@@ -913,7 +909,7 @@ sub zflush {} # overridden by NNTPdeflate
 
 sub cmd_xpath ($$) {
        my ($self, $mid) = @_;
-       return r501 unless $mid =~ /\A<(.+)>\z/;
+       return r501 unless $mid =~ $ONE_MSGID;
        $mid = $1;
        my @paths;
        foreach my $ng (values %{$self->{nntpd}->{groups}}) {
@@ -990,10 +986,4 @@ sub busy {
        ($self->{rbuf} || $self->{wbuf} || $self->not_idle_long($now));
 }
 
-# this is an import to prevent "perl -c" from complaining about fields
-sub import {
-       $have_deflate = eval { require PublicInbox::NNTPdeflate } and
-               $CAPABILITIES .= "COMPRESS DEFLATE\r\n";
-}
-
 1;