]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/NNTP.pm
nntp: support COMPRESS DEFLATE per RFC 8054
[public-inbox.git] / lib / PublicInbox / NNTP.pm
index 9973fcaf149eb3a4b637a148286303f702e06a96..d6f315bab42a9ed7e0b8b607a3ba6cf01066ef55 100644 (file)
@@ -14,11 +14,13 @@ use PublicInbox::Git;
 require PublicInbox::EvCleanup;
 use Email::Simple;
 use POSIX qw(strftime);
-PublicInbox::DS->import(qw(now msg_more));
+PublicInbox::DS->import(qw(now));
 use Digest::SHA qw(sha1_hex);
 use Time::Local qw(timegm timelocal);
 use constant {
+       LINE_MAX => 512, # RFC 977 section 2.3
        r501 => '501 command syntax error',
+       r502 => '502 Command unavailable',
        r221 => '221 Header follows',
        r224 => '224 Overview information follows (multi-line)',
        r225 => '225 Headers follow (multi-line)',
@@ -31,10 +33,16 @@ my @OVERVIEW = qw(Subject From Date Message-ID References Xref);
 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:
-my %DISABLED; # = map { $_ => 1 } qw(xover list_overview_fmt newnews xhdr);
-
+my $CAPABILITIES = <<"";
+101 Capability list:\r
+VERSION 2\r
+READER\r
+NEWNEWS\r
+LIST ACTIVE ACTIVE.TIMES NEWSGROUPS OVERVIEW.FMT\r
+HDR\r
+OVER\r
+
+my $have_deflate;
 my $EXPMAP; # fd -> [ idle_time, $self ]
 my $expt;
 our $EXPTIME = 180; # 3 minutes
@@ -75,7 +83,8 @@ sub new ($$$) {
        my $ev = EPOLLIN;
        my $wbuf;
        if (ref($sock) eq 'IO::Socket::SSL' && !$sock->accept_SSL) {
-               $ev = PublicInbox::TLS::epollbit() or return CORE::close($sock);
+               return CORE::close($sock) if $! != EAGAIN;
+               $ev = PublicInbox::TLS::epollbit();
                $wbuf = [ \&PublicInbox::DS::accept_tls_step, \&greet ];
        }
        $self->SUPER::new($sock, $ev | EPOLLONESHOT);
@@ -104,10 +113,9 @@ sub process_line ($$) {
        my ($self, $l) = @_;
        my ($req, @args) = split(/[ \t]/, $l);
        return 1 unless defined($req); # skip blank line
-       $req = lc($req);
        $req = eval {
                no strict 'refs';
-               $req = $DISABLED{$req} ? undef : *{'cmd_'.$req}{CODE};
+               *{'cmd_'.lc($req)}{CODE};
        };
        return res($self, '500 command not recognized') unless $req;
        return res($self, r501) unless args_ok($req, scalar @args);
@@ -124,6 +132,17 @@ sub process_line ($$) {
        res($self, $res);
 }
 
+# The keyword argument is not used (rfc3977 5.2.2)
+sub cmd_capabilities ($;$) {
+       my ($self, undef) = @_;
+       my $res = $CAPABILITIES;
+       if (ref($self->{sock}) ne 'IO::Socket::SSL' &&
+                       $self->{nntpd}->{accept_tls}) {
+               $res .= "STARTTLS\r\n";
+       }
+       $res .= '.';
+}
+
 sub cmd_mode ($$) {
        my ($self, $arg) = @_;
        $arg = uc $arg;
@@ -142,12 +161,12 @@ sub cmd_xgtitle ($;$) {
 
 sub list_overview_fmt ($) {
        my ($self) = @_;
-       msg_more($self, $OVERVIEW_FMT);
+       $self->msg_more($OVERVIEW_FMT);
 }
 
 sub list_headers ($;$) {
        my ($self) = @_;
-       msg_more($self, $LIST_HEADERS);
+       $self->msg_more($LIST_HEADERS);
 }
 
 sub list_active ($;$) {
@@ -186,7 +205,6 @@ sub cmd_list ($;$$) {
                my $arg = shift @args;
                $arg =~ tr/A-Z./a-z_/;
                $arg = "list_$arg";
-               return r501 if $DISABLED{$arg};
 
                $arg = eval {
                        no strict 'refs';
@@ -486,24 +504,23 @@ find_mid:
 found:
        my $smsg = $ng->over->get_art($n) or return $err;
        my $msg = $ng->msg_by_smsg($smsg) or return $err;
-       my $s = Email::Simple->new($msg);
-       if ($set_headers) {
-               set_nntp_headers($self, $s->header_obj, $ng, $n, $mid);
 
-               # must be last
-               $s->body_set('') if ($set_headers == 2);
-       }
-       [ $n, $mid, $s, $smsg->bytes, $smsg->lines, $ng ];
+       # 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;
+       set_nntp_headers($self, $hdr, $ng, $n, $mid) if $set_headers;
+       [ $n, $mid, $msg, $hdr ];
 }
 
-sub simple_body_write ($$) {
-       my ($self, $s) = @_;
-       my $body = $s->body;
-       $s->body_set('');
-       $body =~ s/^\./../smg;
-       $body =~ s/(?<!\r)\n/\r\n/sg;
-       msg_more($self, $body);
-       msg_more($self, "\r\n") unless $body =~ /\r\n\z/s;
+sub msg_body_write ($$) {
+       my ($self, $msg) = @_;
+
+       # these can momentarily double the memory consumption :<
+       $$msg =~ s/^\./../smg;
+       $$msg =~ s/(?<!\r)\n/\r\n/sg; # Alpine barfs without this
+       $$msg .= "\r\n" unless $$msg =~ /\r\n\z/s;
+       $self->msg_more($$msg);
        '.'
 }
 
@@ -512,40 +529,40 @@ sub set_art {
        $self->{article} = $art if defined $art && $art =~ /\A[0-9]+\z/;
 }
 
-sub _header ($) {
-       my $hdr = $_[0]->header_obj->as_string;
+sub msg_hdr_write ($$$) {
+       my ($self, $hdr, $body_follows) = @_;
+       $hdr = $hdr->as_string;
        utf8::encode($hdr);
-       $hdr =~ s/(?<!\r)\n/\r\n/sg;
+       $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.
        $hdr =~ s/^(Message-ID:)[ \t]*\r\n[ \t]+([^\r]+)\r\n/$1 $2\r\n/igsm;
-
-       $hdr
+       $hdr .= "\r\n" if $body_follows;
+       $self->msg_more($hdr);
 }
 
 sub cmd_article ($;$) {
        my ($self, $art) = @_;
        my $r = art_lookup($self, $art, 1);
        return $r unless ref $r;
-       my ($n, $mid, $s) = @$r;
+       my ($n, $mid, $msg, $hdr) = @$r;
        set_art($self, $art);
        more($self, "220 $n <$mid> article retrieved - head and body follow");
-       msg_more($self, _header($s));
-       msg_more($self, "\r\n");
-       simple_body_write($self, $s);
+       msg_hdr_write($self, $hdr, 1);
+       msg_body_write($self, $msg);
 }
 
 sub cmd_head ($;$) {
        my ($self, $art) = @_;
        my $r = art_lookup($self, $art, 2);
        return $r unless ref $r;
-       my ($n, $mid, $s) = @$r;
+       my ($n, $mid, undef, $hdr) = @$r;
        set_art($self, $art);
        more($self, "221 $n <$mid> article retrieved - head follows");
-       msg_more($self, _header($s));
+       msg_hdr_write($self, $hdr, 0);
        '.'
 }
 
@@ -553,17 +570,17 @@ sub cmd_body ($;$) {
        my ($self, $art) = @_;
        my $r = art_lookup($self, $art, 0);
        return $r unless ref $r;
-       my ($n, $mid, $s) = @$r;
+       my ($n, $mid, $msg) = @$r;
        set_art($self, $art);
        more($self, "222 $n <$mid> article retrieved - body follows");
-       simple_body_write($self, $s);
+       msg_body_write($self, $msg);
 }
 
 sub cmd_stat ($;$) {
        my ($self, $art) = @_;
        my $r = art_lookup($self, $art, 0);
        return $r unless ref $r;
-       my ($n, $mid, undef) = @$r;
+       my ($n, $mid) = @$r;
        set_art($self, $art);
        "223 $n <$mid> article retrieved - request text separately";
 }
@@ -743,7 +760,7 @@ sub hdr_searchmsg ($$$$) {
                                $tmp .= $s->{num} . ' ' . $s->$field . "\r\n";
                        }
                        utf8::encode($tmp);
-                       msg_more($self, $tmp);
+                       $self->msg_more($tmp);
                        $cur = $msgs->[-1]->{num} + 1;
                });
        }
@@ -791,7 +808,7 @@ sub hdr_mid_prefix ($$$$$) {
 }
 
 sub hdr_mid_response ($$$$$$) {
-       my ($self, $xhdr, $ng, $n, $mid, $v) = @_; # r: art_lookup result
+       my ($self, $xhdr, $ng, $n, $mid, $v) = @_;
        my $res = '';
        if ($xhdr) {
                $res .= r221 . "\r\n";
@@ -882,11 +899,13 @@ sub cmd_xover ($;$) {
        });
 }
 
+sub compressed { undef }
+
 sub cmd_starttls ($) {
        my ($self) = @_;
        my $sock = $self->{sock} or return;
        # RFC 4642 2.2.1
-       (ref($sock) eq 'IO::Socket::SSL') and return '502 Command unavailable';
+       return r502 if (ref($sock) eq 'IO::Socket::SSL' || $self->compressed);
        my $opt = $self->{nntpd}->{accept_tls} or
                return '580 can not initiate TLS negotiation';
        res($self, '382 Continue with TLS negotiation');
@@ -895,6 +914,17 @@ sub cmd_starttls ($) {
        undef;
 }
 
+# RFC 8054
+sub cmd_compress ($$) {
+       my ($self, $alg) = @_;
+       return '503 Only the DEFLATE is supported' if uc($alg) ne 'DEFLATE';
+       return r502 if $self->compressed || !$have_deflate;
+       res($self, '206 Compression active');
+       PublicInbox::NNTPdeflate->enable($self);
+       $self->requeue;
+       undef
+}
+
 sub cmd_xpath ($$) {
        my ($self, $mid) = @_;
        return r501 unless $mid =~ /\A<(.+)>\z/;
@@ -910,7 +940,7 @@ sub cmd_xpath ($$) {
 
 sub res ($$) { do_write($_[0], $_[1] . "\r\n") }
 
-sub more ($$) { msg_more($_[0], $_[1] . "\r\n") }
+sub more ($$) { $_[0]->msg_more($_[1] . "\r\n") }
 
 sub do_write ($$) {
        my $self = $_[0];
@@ -940,7 +970,6 @@ sub event_step {
        # only read more requests if we've drained the write buffer,
        # otherwise we can be buffering infinitely w/o backpressure
 
-       use constant LINE_MAX => 512; # RFC 977 section 2.3
        my $rbuf = $self->{rbuf} // (\(my $x = ''));
        my $r = 1;
 
@@ -983,4 +1012,10 @@ sub busy {
        ($self->{rbuf} || $self->{wbuf} || not_idle_long($self, $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;