]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/NNTP.pm
nntp: proper UTF-8 support (hopefully?)
[public-inbox.git] / lib / PublicInbox / NNTP.pm
index 094d26dfea274e6edf30c124a802799164c341f9..91b10f20ac39894a561ecb313cc938a36b3e3c2b 100644 (file)
@@ -4,19 +4,21 @@ package PublicInbox::NNTP;
 use strict;
 use warnings;
 use base qw(Danga::Socket);
-use fields qw(nntpd article ng long_res);
+use fields qw(nntpd article rbuf ng long_res);
 use PublicInbox::Msgmap;
 use PublicInbox::GitCatFile;
 use PublicInbox::MID qw(mid2path);
-use Email::Simple;
+use Email::MIME;
 use Data::Dumper qw(Dumper);
 use POSIX qw(strftime);
-use Time::HiRes qw(gettimeofday tv_interval ualarm);
+use Time::HiRes qw(clock_gettime ualarm CLOCK_MONOTONIC);
 use constant {
        r501 => '501 command syntax error',
        long_response_limit => 0xffffffff,
 };
 
+sub now () { clock_gettime(CLOCK_MONOTONIC) };
+
 my @OVERVIEW = qw(Subject From Date Message-ID References Bytes Lines);
 my %OVERVIEW = map { $_ => 1 } @OVERVIEW;
 
@@ -27,9 +29,11 @@ my %DISABLED; # = map { $_ => 1 } qw(xover list_overview_fmt newnews xhdr);
 sub new ($$$) {
        my ($class, $sock, $nntpd) = @_;
        my $self = fields::new($class);
+       binmode $sock, ':utf8'; # RFC 3977
        $self->SUPER::new($sock);
        $self->{nntpd} = $nntpd;
        res($self, '201 server ready - post via email');
+       $self->{rbuf} = '';
        $self->watch_read(1);
        $self;
 }
@@ -59,7 +63,7 @@ sub process_line ($$) {
        my $err = $@;
        if ($err && !$self->{closed}) {
                chomp($l = Dumper(\$l));
-               warning('error from: ', $l, ' ', $err);
+               err($self, "error from: $l $err");
                $res = '503 program fault - command not performed';
        }
        return 0 unless defined $res;
@@ -90,7 +94,7 @@ sub list_overview_fmt ($$) {
 sub list_active ($;$) {
        my ($self, $wildmat) = @_;
        wildmat2re($wildmat);
-       foreach my $ng (values %{$self->{nntpd}->{groups}}) {
+       foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
                $ng->{name} =~ $wildmat or next;
                group_line($self, $ng);
        }
@@ -99,7 +103,7 @@ sub list_active ($;$) {
 sub list_active_times ($;$) {
        my ($self, $wildmat) = @_;
        wildmat2re($wildmat);
-       foreach my $ng (values %{$self->{nntpd}->{groups}}) {
+       foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
                $ng->{name} =~ $wildmat or next;
                my $c = eval { $ng->mm->created_at } || time;
                more($self, "$ng->{name} $c $ng->{address}");
@@ -109,7 +113,7 @@ sub list_active_times ($;$) {
 sub list_newsgroups ($;$) {
        my ($self, $wildmat) = @_;
        wildmat2re($wildmat);
-       foreach my $ng (values %{$self->{nntpd}->{groups}}) {
+       foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
                $ng->{name} =~ $wildmat or next;
                my $d = $ng->description;
                more($self, "$ng->{name} $d");
@@ -134,7 +138,7 @@ sub cmd_list ($;$$) {
                $arg->($self, @args);
        } else {
                more($self, '215 list of newsgroups follows');
-               foreach my $ng (values %{$self->{nntpd}->{groups}}) {
+               foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
                        group_line($self, $ng);
                }
        }
@@ -197,7 +201,7 @@ sub cmd_newgroups ($$$;$$) {
 
        # TODO dists
        more($self, '231 list of new newsgroups follows');
-       foreach my $ng (values %{$self->{nntpd}->{groups}}) {
+       foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
                my $c = eval { $ng->mm->created_at } || 0;
                next unless $c > $ts;
                group_line($self, $ng);
@@ -246,7 +250,7 @@ sub cmd_newnews ($$$$;$$) {
        ngpat2re($keep);
        ngpat2re($skip);
        my @srch;
-       foreach my $ng (values %{$self->{nntpd}->{groups}}) {
+       foreach my $ng (@{$self->{nntpd}->{grouplist}}) {
                $ng->{name} =~ $keep or next;
                $ng->{name} =~ $skip and next;
                my $srch = $ng->search or next;
@@ -328,7 +332,7 @@ sub cmd_quit ($) {
 
 sub art_lookup ($$$) {
        my ($self, $art, $set_headers) = @_;
-       my $ng = $self->{ng} or return '412 no newsgroup has been selected';
+       my $ng = $self->{ng};
        my ($n, $mid);
        my $err;
        if (defined $art) {
@@ -337,10 +341,18 @@ sub art_lookup ($$$) {
                        $n = int($art);
                        goto find_mid;
                } elsif ($art =~ /\A<([^>]+)>\z/) {
-                       $err = '430 no such article found';
                        $mid = $1;
-                       $n = $ng->mm->num_for($mid);
-                       defined $mid or return $err;
+                       $err = '430 no such article found';
+                       $n = $ng->mm->num_for($mid) if $ng;
+                       goto found if defined $n;
+                       foreach my $g (values %{$self->{nntpd}->{groups}}) {
+                               $n = $g->mm->num_for($mid);
+                               if (defined $n) {
+                                       $ng = $g;
+                                       goto found;
+                               }
+                       }
+                       return $err;
                } else {
                        return r501;
                }
@@ -349,21 +361,23 @@ sub art_lookup ($$$) {
                $n = $self->{article};
                defined $n or return $err;
 find_mid:
+               $ng or return '412 no newsgroup has been selected';
                $mid = $ng->mm->mid_for($n);
                defined $mid or return $err;
        }
-
+found:
        my $o = 'HEAD:' . mid2path($mid);
-       my $s = eval { Email::Simple->new($ng->gcf->cat_file($o)) };
+       my $bytes;
+       my $s = eval { Email::MIME->new($ng->gcf->cat_file($o, \$bytes)) };
        return $err unless $s;
        if ($set_headers) {
                $s->header_set('Newsgroups', $ng->{name});
                $s->header_set('Lines', $s->body =~ tr!\n!\n!);
-               $s->header_set('Xref', "$ng->{domain} $ng->{name}:$n");
+               $s->header_set('Xref', xref($ng, $n));
 
                # must be last
                if ($set_headers == 2) {
-                       $s->header_set('Bytes', bytes::length($s->as_string));
+                       $s->header_set('Bytes', $bytes);
                        $s->body_set('');
                }
        }
@@ -386,41 +400,50 @@ sub header_str ($) {
        $h->as_string
 }
 
-sub cmd_article ($$) {
+sub set_art {
+       my ($self, $art) = @_;
+       $self->{article} = $art if defined $art && $art =~ /\A\d+\z/;
+}
+
+sub cmd_article ($;$) {
        my ($self, $art) = @_;
        my $r = $self->art_lookup($art, 1);
        return $r unless ref $r;
        my ($n, $mid, $s) = @$r;
+       set_art($self, $art);
        more($self, "220 $n <$mid> article retrieved - head and body follow");
        do_more($self, header_str($s));
        do_more($self, "\r\n");
        simple_body_write($self, $s);
 }
 
-sub cmd_head ($$) {
+sub cmd_head ($;$) {
        my ($self, $art) = @_;
        my $r = $self->art_lookup($art, 2);
        return $r unless ref $r;
        my ($n, $mid, $s) = @$r;
+       set_art($self, $art);
        more($self, "221 $n <$mid> article retrieved - head follows");
        do_more($self, header_str($s));
        '.'
 }
 
-sub cmd_body ($$) {
+sub cmd_body ($;$) {
        my ($self, $art) = @_;
        my $r = $self->art_lookup($art, 0);
        return $r unless ref $r;
        my ($n, $mid, $s) = @$r;
+       set_art($self, $art);
        more($self, "222 $n <$mid> article retrieved - body follows");
        simple_body_write($self, $s);
 }
 
-sub cmd_stat ($$) {
+sub cmd_stat ($;$) {
        my ($self, $art) = @_;
        my $r = $self->art_lookup($art, 0);
        return $r unless ref $r;
        my ($n, $mid, undef) = @$r;
+       set_art($self, $art);
        "223 $n <$mid> article retrieved - request text separately";
 }
 
@@ -471,6 +494,8 @@ sub long_response ($$$$) {
        # clients should not be sending us stuff and making us do more
        # work while we are stream a response to them
        $self->watch_read(0);
+       my $fd = fileno $self->{sock};
+       my $t0 = now();
        $self->{long_res} = sub {
                # limit our own running time for fairness with other
                # clients and to avoid buffering too much:
@@ -487,8 +512,18 @@ sub long_response ($$$$) {
 
                if ($err || $self->{closed}) {
                        $self->{long_res} = undef;
-                       warning("$err during long response") if $err;
-                       $self->watch_read(1) unless $self->{closed};
+
+                       if ($err) {
+                               err($self,
+                                   "$err during long response[$fd] - %0.6f",
+                                       now() - $t0);
+                       }
+                       if ($self->{closed}) {
+                               out($self, " deferred[$fd] aborted - %0.6f",
+                                          now() - $t0);
+                       } else {
+                               $self->watch_read(1);
+                       }
                } elsif ($yield || $self->{write_buf_size}) {
                        # no recursion, schedule another call ASAP
                        # but only after all pending writes are done
@@ -499,6 +534,7 @@ sub long_response ($$$$) {
                        $self->{long_res} = undef;
                        $self->watch_read(1);
                        res($self, '.');
+                       out($self, " deferred[$fd] done - %0.6f", now() - $t0);
                }
        };
        $self->{long_res}->(); # kick off!
@@ -528,6 +564,35 @@ sub xhdr_message_id ($$) { # optimize XHDR Message-ID [range] for slrnpull.
        }
 }
 
+sub xref ($$) {
+       my ($ng, $n) = @_;
+       "$ng->{domain} $ng->{name}:$n"
+}
+
+sub xhdr_xref ($$) { # optimize XHDR Xref [range] for rtin
+       my ($self, $range) = @_;
+
+       my $ng = $self->{ng};
+       my $mm = $ng->mm;
+       if (defined $range && $range =~ /\A<(.+)>\z/) { # Message-ID
+               my $n = $mm->num_for($range);
+               more($self, '221 Header follows');
+               more($self, "<$range> ".xref($ng, $n)) if defined $n;
+               '.';
+       } 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, '221 Header follows');
+               $self->long_response($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 {
@@ -578,6 +643,8 @@ sub cmd_xhdr ($$;$) {
        my $sub = lc $header;
        if ($sub eq 'message-id') {
                xhdr_message_id($self, $range);
+       } elsif ($sub eq 'xref') {
+               xhdr_xref($self, $range);
        } elsif ($sub =~ /\A(subject|references|date)\z/ && $ng->search) {
                xhdr_searchmsg($self, $sub, $range);
        } else {
@@ -688,6 +755,16 @@ sub do_write ($$) {
        $done;
 }
 
+sub err ($$;@) {
+       my ($self, $fmt, @args) = @_;
+       printf { $self->{nntpd}->{err} } $fmt."\n", @args;
+}
+
+sub out ($$;@) {
+       my ($self, $fmt, @args) = @_;
+       printf { $self->{nntpd}->{out} } $fmt."\n", @args;
+}
+
 use constant MSG_MORE => ($^O eq 'linux') ? 0x8000 : 0;
 
 sub do_more ($$) {
@@ -695,9 +772,9 @@ sub do_more ($$) {
        if (MSG_MORE && !$self->{write_buf_size}) {
                my $n = send($self->{sock}, $data, MSG_MORE);
                if (defined $n) {
-                       my $dlen = bytes::length($data);
+                       my $dlen = length($data);
                        return 1 if $n == $dlen; # all done!
-                       $data = bytes::substr($data, $n, $dlen - $n);
+                       $data = substr($data, $n, $dlen - $n);
                }
        }
        $self->do_write($data);
@@ -711,27 +788,52 @@ sub event_err { $_[0]->close }
 sub event_write {
        my ($self) = @_;
        # only continue watching for readability when we are done writing:
-       $self->write(undef) == 1 and $self->watch_read(1);
+       if ($self->write(undef) == 1 && !$self->{long_res}) {
+               $self->watch_read(1);
+       }
 }
 
 sub event_read {
        my ($self) = @_;
        use constant LINE_MAX => 512; # RFC 977 section 2.3
+       my $line;
        my $r = 1;
-       my $buf = $self->read(LINE_MAX) or return $self->close;
-       while ($r > 0 && $$buf =~ s/\A([^\r\n]+)\r?\n//) {
-               my $line = $1;
-               my $t0 = [ gettimeofday ];
+again:
+       while ($r > 0 && $self->{rbuf} =~ s/\A\s*([^\r\n]+)\r?\n//) {
+               $line = $1;
+               my $t0 = now();
                $r = eval { $self->process_line($line) };
-               printf(STDERR "$line %0.6f\n",
-                       tv_interval($t0, [gettimeofday]));
+               my $d = $self->{long_res} ?
+                       ' deferred['.fileno($self->{sock}).']' : '';
+               out($self, "$line - %0.6f$d", now() - $t0);
        }
+       unless (defined $line) {
+               my $buf = $self->read(LINE_MAX) or return $self->close;
+               $self->{rbuf} .= $$buf;
+               goto again;
+       }
+
        return $self->close if $r < 0;
-       my $len = bytes::length($$buf);
+       my $len = length($self->{rbuf});
        return $self->close if ($len >= LINE_MAX);
-       $self->push_back_read($buf) if ($len);
 }
 
-sub warning { print STDERR @_, "\n" }
+sub watch_read {
+       my ($self, $bool) = @_;
+       my $rv = $self->SUPER::watch_read($bool);
+       if ($bool && $self->{rbuf} ne '') {
+               # Force another read if there is a pipelined request.
+               # We don't know if the socket has anything for us to 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;
+                       }
+               });
+       }
+       $rv;
+}
 
 1;