X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FNetReader.pm;h=d3094fc7137eeb6546f1596ff3fa7d7d669ca399;hb=2bc961811c57bef3feef24244bf20546f3754d4f;hp=4c4124913ec64b3c488bf385841950d3571e0e82;hpb=9dafc7333ee43a77ad18629d1e30195b4a7ea482;p=public-inbox.git diff --git a/lib/PublicInbox/NetReader.pm b/lib/PublicInbox/NetReader.pm index 4c412491..d3094fc7 100644 --- a/lib/PublicInbox/NetReader.pm +++ b/lib/PublicInbox/NetReader.pm @@ -10,27 +10,13 @@ use PublicInbox::Eml; our %IMAPflags2kw = map {; "\\\u$_" => $_ } qw(seen answered flagged draft); -# TODO: trim this down, this is huge -our @EXPORT = qw(uri_new uri_scheme uri_section - nn_new nn_for - imap_uri nntp_url - cfg_bool cfg_intvl imap_common_init - ); - -# avoid exposing deprecated "snews" to users. -my %SCHEME_MAP = ('snews' => 'nntps'); - -sub uri_scheme ($) { - my ($uri) = @_; - my $scheme = $uri->scheme; - $SCHEME_MAP{$scheme} // $scheme; -} +our @EXPORT = qw(uri_section imap_uri nntp_uri); # returns the git config section name, e.g [imap "imaps://user@example.com"] # without the mailbox, so we can share connections between different inboxes sub uri_section ($) { my ($uri) = @_; - uri_scheme($uri) . '://' . $uri->authority; + $uri->scheme . '://' . $uri->authority; } sub auth_anon_cb { '' }; # for Mail::IMAPClient::Authcallback @@ -104,15 +90,6 @@ sub mic_for { # mic = Mail::IMAPClient $mic; } -sub uri_new { - my ($url) = @_; - require URI; - - # URI::snews exists, URI::nntps does not, so use URI::snews - $url =~ s!\Anntps://!snews://!i; - URI->new($url); -} - # Net::NNTP doesn't support CAPABILITIES, yet sub try_starttls ($) { my ($host) = @_; @@ -123,8 +100,8 @@ sub try_starttls ($) { } sub nn_new ($$$) { - my ($nn_arg, $nntp_opt, $url) = @_; - my $nn = Net::NNTP->new(%$nn_arg) or die "E: <$url> new: $!\n"; + my ($nn_arg, $nntp_opt, $uri) = @_; + my $nn = Net::NNTP->new(%$nn_arg) or die "E: <$uri> new: $!\n"; # default to using STARTTLS if it's available, but allow # it to be disabled for localhost/VPN users @@ -133,27 +110,26 @@ sub nn_new ($$$) { try_starttls($nn_arg->{Host})) { # soft fail by default $nn->starttls or warn <<""; -W: <$url> STARTTLS tried and failed (not requested) +W: <$uri> STARTTLS tried and failed (not requested) } elsif ($nntp_opt->{starttls}) { # hard fail if explicitly configured $nn->starttls or die <<""; -E: <$url> STARTTLS requested and failed +E: <$uri> STARTTLS requested and failed } } elsif ($nntp_opt->{starttls}) { $nn->can('starttls') or - die "E: <$url> Net::NNTP too old for STARTTLS\n"; + die "E: <$uri> Net::NNTP too old for STARTTLS\n"; $nn->starttls or die <<""; -E: <$url> STARTTLS requested and failed +E: <$uri> STARTTLS requested and failed } $nn; } sub nn_for ($$$;$) { # nn = Net::NNTP - my ($self, $url, $nn_args, $lei) = @_; - my $uri = uri_new($url); + my ($self, $uri, $nn_args, $lei) = @_; my $sec = uri_section($uri); my $nntp_opt = $self->{nntp_opt}->{$sec} //= {}; my $host = $uri->host; @@ -165,7 +141,7 @@ sub nn_for ($$$;$) { # nn = Net::NNTP require PublicInbox::GitCredential; $cred = bless { url => $sec, - protocol => uri_scheme($uri), + protocol => $uri->scheme, host => $host, }, 'PublicInbox::GitCredential'; ($u, $p) = split(/:/, $ui, 2); @@ -179,14 +155,13 @@ sub nn_for ($$$;$) { # nn = Net::NNTP SSL => $uri->secure, # snews == nntps %$common, # may Debug .... }; - my $nn = nn_new($nn_arg, $nntp_opt, $url); - + my $nn = nn_new($nn_arg, $nntp_opt, $uri); if ($cred) { $cred->fill($lei); # may prompt user here if ($nn->authinfo($u, $p)) { push @{$nntp_opt->{-postconn}}, [ 'authinfo', $u, $p ]; } else { - warn "E: <$url> AUTHINFO $u XXXX failed\n"; + warn "E: <$uri> AUTHINFO $u XXXX failed\n"; $nn = undef; } } @@ -197,12 +172,12 @@ sub nn_for ($$$;$) { # nn = Net::NNTP if ($nn->compress) { push @{$nntp_opt->{-postconn}}, [ 'compress' ]; } else { - warn "W: <$url> COMPRESS failed\n"; + warn "W: <$uri> COMPRESS failed\n"; } } else { delete $nntp_opt->{compress}; warn <<""; -W: <$url> COMPRESS not supported by Net::NNTP +W: <$uri> COMPRESS not supported by Net::NNTP W: see https://rt.cpan.org/Ticket/Display.html?id=129967 for updates } @@ -220,15 +195,12 @@ sub imap_uri { $uri ? $uri->canonical : undef; } -my %IS_NNTP = (news => 1, snews => 1, nntp => 1); -sub nntp_url { +my %IS_NNTP = (news => 1, snews => 1, nntp => 1, nntps => 1); +sub nntp_uri { my ($url) = @_; - my $uri = uri_new($url); - return unless $uri && $IS_NNTP{$uri->scheme} && $uri->group; - $url = $uri->canonical->as_string; - # nntps is IANA registered, snews is deprecated - $url =~ s!\Asnews://!nntps://!; - $url; + require PublicInbox::URInntps; + my $uri = PublicInbox::URInntps->new($url); + $uri && $IS_NNTP{$uri->scheme} && $uri->group ? $uri->canonical : undef; } sub cfg_intvl ($$$) { @@ -254,6 +226,7 @@ sub cfg_bool ($$$) { # flesh out common IMAP-specific data structures sub imap_common_init ($;$) { my ($self, $lei) = @_; + return unless $self->{imap_order}; $self->{quiet} = 1 if $lei && $lei->{opt}->{quiet}; eval { require PublicInbox::IMAPClient } or die "Mail::IMAPClient is required for IMAP:\n$@\n"; @@ -297,10 +270,55 @@ sub imap_common_init ($;$) { $mics; } +# flesh out common NNTP-specific data structures +sub nntp_common_init ($;$) { + my ($self, $lei) = @_; + return unless $self->{nntp_order}; + $self->{quiet} = 1 if $lei && $lei->{opt}->{quiet}; + eval { require Net::NNTP } or + die "Net::NNTP is required for NNTP:\n$@\n"; + eval { require PublicInbox::IMAPTracker } or + die "DBD::SQLite is required for NNTP\n:$@\n"; + my $cfg = $self->{pi_cfg} // $lei->_lei_cfg; + my $nn_args = {}; # scheme://authority => Net::NNTP->new arg + for my $uri (@{$self->{nntp_order}}) { + my $sec = uri_section($uri); + + # Debug and Timeout are passed to Net::NNTP->new + my $v = cfg_bool($cfg, 'nntp.Debug', $$uri); + $nn_args->{$sec}->{Debug} = $v if defined $v; + my $to = cfg_intvl($cfg, 'nntp.Timeout', $$uri); + $nn_args->{$sec}->{Timeout} = $to if $to; + + # Net::NNTP post-connect commands + for my $k (qw(starttls compress)) { + $v = cfg_bool($cfg, "nntp.$k", $$uri) // next; + $self->{nntp_opt}->{$sec}->{$k} = $v; + } + + # internal option + for my $k (qw(pollInterval)) { + $to = cfg_intvl($cfg, "nntp.$k", $$uri) // next; + $self->{nntp_opt}->{$sec}->{$k} = $to; + } + } + # make sure we can connect and cache the credentials in memory + $self->{nn_arg} = {}; # schema://authority => Net::NNTP->new args + my %nn; # schema://authority => Net::NNTP object + for my $uri (@{$self->{nntp_order}}) { + my $sec = uri_section($uri); + $nn{$sec} //= nn_for($self, $uri, $nn_args, $lei); + } + \%nn; # for optional {nn_cached} +} + sub add_url { my ($self, $arg) = @_; - if (my $uri = imap_uri($arg)) { + my $uri; + if ($uri = imap_uri($arg)) { push @{$self->{imap_order}}, $uri; + } elsif ($uri = nntp_uri($arg)) { + push @{$self->{nntp_order}}, $uri; } else { push @{$self->{unsupported_url}}, $arg; } @@ -315,6 +333,10 @@ sub errors { eval { require PublicInbox::IMAPClient } or die "Mail::IMAPClient is required for IMAP:\n$@\n"; } + if ($self->{nntp_order}) { + eval { require Net::NNTP } or + die "Net::NNTP is required for NNTP:\n$@\n"; + } undef; } @@ -324,13 +346,27 @@ sub _imap_do_msg ($$$$$) { $$raw =~ s/\r\n/\n/sg; my $kw = []; for my $f (split(/ /, $flags)) { - my $k = $IMAPflags2kw{$f} // next; # TODO: X-Label? - push @$kw, $k; + if (my $k = $IMAPflags2kw{$f}) { + push @$kw, $k; + } elsif ($f eq "\\Recent") { # not in JMAP + } elsif ($f eq "\\Deleted") { # not in JMAP + return; + } elsif ($self->{verbose}) { + warn "# unknown IMAP flag $f <$uri;uid=$uid>\n"; + } } + @$kw = sort @$kw; # for all UI/UX purposes my ($eml_cb, @args) = @{$self->{eml_each}}; $eml_cb->($uri, $uid, $kw, PublicInbox::Eml->new($raw), @args); } +sub run_commit_cb ($) { + my ($self) = @_; + my $cmt_cb_args = $self->{on_commit} or return; + my ($cb, @args) = @$cmt_cb_args; + $cb->(@args); +} + sub _imap_fetch_all ($$$) { my ($self, $mic, $uri) = @_; my $sec = uri_section($uri); @@ -363,8 +399,11 @@ sub _imap_fetch_all ($$$) { } return if $l_uid >= $r_uid; # nothing to do $l_uid ||= 1; - - warn "# $uri fetching UID $l_uid:$r_uid\n" unless $self->{quiet}; + my ($mod, $shard) = @{$self->{shard_info} // []}; + unless ($self->{quiet}) { + my $m = $mod ? " [(UID % $mod) == $shard]" : ''; + warn "# $uri fetching UID $l_uid:$r_uid$m\n"; + } $mic->Uid(1); # the default, we hope my $bs = $self->{imap_opt}->{$sec}->{batch_size} // 1; my $req = $mic->imap4rev1 ? 'BODY.PEEK[]' : 'RFC822.PEEK'; @@ -376,8 +415,10 @@ sub _imap_fetch_all ($$$) { # I wish "UID FETCH $START:*" could work, but: # 1) servers do not need to return results in any order # 2) Mail::IMAPClient doesn't offer a streaming API - $uids = $mic->search("UID $l_uid:*") or + unless ($uids = $mic->search("UID $l_uid:*")) { + return if $!{EINTR} && $self->{quit}; return "E: $uri UID SEARCH $l_uid:* error: $!"; + } return if scalar(@$uids) == 0; # RFC 3501 doesn't seem to indicate order of UID SEARCH @@ -391,12 +432,15 @@ sub _imap_fetch_all ($$$) { $l_uid = $uids->[-1] + 1; # for next search my $last_uid; my $n = $self->{max_batch}; + + @$uids = grep { ($_ % $mod) == $shard } @$uids if $mod; while (scalar @$uids) { my @batch = splice(@$uids, 0, $bs); $batch = join(',', @batch); local $0 = "UID:$batch $mbx $sec"; my $r = $mic->fetch_hash($batch, $req, 'FLAGS'); unless ($r) { # network error? + last if $!{EINTR} && $self->{quit}; $err = "E: $uri UID FETCH $batch error: $!"; last; } @@ -411,6 +455,7 @@ sub _imap_fetch_all ($$$) { } last if $self->{quit}; } + run_commit_cb($self); $itrk->update_last($r_uidval, $last_uid) if $itrk; } until ($err || $self->{quit}); $err; @@ -418,21 +463,25 @@ sub _imap_fetch_all ($$$) { # uses cached auth info prepared by mic_for sub mic_get { - my ($self, $sec) = @_; - my $mic_arg = $self->{mic_arg}->{$sec}; - unless ($mic_arg) { - my $uri = ref $sec ? $sec : PublicInbox::URIimap->new($sec); - $sec = uri_section($uri); - $mic_arg = $self->{mic_arg}->{$sec} or - die "BUG: no Mail::IMAPClient->new arg for $sec"; + my ($self, $uri) = @_; + my $sec = uri_section($uri); + # see if caller saved result of imap_common_init + my $cached = $self->{mics_cached}; + if ($cached) { + my $mic = $cached->{$sec}; + return $mic if $mic && $mic->IsConnected; + delete $cached->{$sec}; } + my $mic_arg = $self->{mic_arg}->{$sec} or + die "BUG: no Mail::IMAPClient->new arg for $sec"; if (defined(my $cb_name = $mic_arg->{Authcallback})) { if (ref($cb_name) ne 'CODE') { $mic_arg->{Authcallback} = $self->can($cb_name); } } my $mic = PublicInbox::IMAPClient->new(%$mic_arg); - $mic && $mic->IsConnected ? $mic : undef; + $cached //= {}; # invalid placeholder if no cache enabled + $mic && $mic->IsConnected ? ($cached->{$sec} = $mic) : undef; } sub imap_each { @@ -446,12 +495,115 @@ sub imap_each { local $self->{eml_each} = [ $eml_cb, @args ]; $err = _imap_fetch_all($self, $mic, $uri); } else { - $err = "E: not connected: $!"; + $err = "E: <$uri> not connected: $!"; } warn $err if $err; $mic; } +# may used cached auth info prepared by nn_for once +sub nn_get { + my ($self, $uri) = @_; + my $sec = uri_section($uri); + # see if caller saved result of nntp_common_init + my $cached = $self->{nn_cached} // {}; + my $nn; + $nn = delete($cached->{$sec}) and return $nn; + my $nn_arg = $self->{nn_arg}->{$sec} or + die "BUG: no Net::NNTP->new arg for $sec"; + my $nntp_opt = $self->{nntp_opt}->{$sec}; + $nn = nn_new($nn_arg, $nntp_opt, $uri) or return; + if (my $postconn = $nntp_opt->{-postconn}) { + for my $m_arg (@$postconn) { + my ($method, @args) = @$m_arg; + $nn->$method(@args) and next; + die "E: <$uri> $method failed\n"; + return; + } + } + $nn; +} + +sub _nntp_fetch_all ($$$) { + my ($self, $nn, $uri) = @_; + my ($group, $num_a, $num_b) = $uri->group; + my $sec = uri_section($uri); + my ($nr, $beg, $end) = $nn->group($group); + unless (defined($nr)) { + chomp(my $msg = $nn->message); + return "E: GROUP $group <$sec> $msg"; + } + + # IMAPTracker is also used for tracking NNTP, UID == article number + # LIST.ACTIVE can get the equivalent of UIDVALIDITY, but that's + # expensive. So we assume newsgroups don't change: + my $itrk = $self->{incremental} ? + PublicInbox::IMAPTracker->new($$uri) : 0; + my (undef, $l_art) = $itrk ? $itrk->get_last : (); + + # allow users to specify articles to refetch + # cf. https://tools.ietf.org/id/draft-gilman-news-url-01.txt + # nntp://example.com/inbox.foo/$num_a-$num_b + $beg = $num_a if defined($num_a) && $num_a < $beg; + $end = $num_b if defined($num_b) && $num_b < $end; + if (defined $l_art) { + return if $l_art >= $end; # nothing to do + $beg = $l_art + 1; + } + my ($err, $art); + unless ($self->{quiet}) { + warn "# $uri fetching ARTICLE $beg..$end\n"; + } + my $last_art; + my $n = $self->{max_batch}; + for ($beg..$end) { + last if $self->{quit}; + $art = $_; + if (--$n < 0) { + run_commit_cb($self); + $itrk->update_last(0, $last_art) if $itrk; + $n = $self->{max_batch}; + } + my $raw = $nn->article($art); + unless (defined($raw)) { + my $msg = $nn->message; + if ($nn->code == 421) { # pseudo response from Net::Cmd + $err = "E: $msg"; + last; + } else { # probably just a deleted message (spam) + warn "W: $msg"; + next; + } + } + $raw = join('', @$raw); + $raw =~ s/\r\n/\n/sg; + my ($eml_cb, @args) = @{$self->{eml_each}}; + $eml_cb->($uri, $art, [], PublicInbox::Eml->new(\$raw), @args); + $last_art = $art; + } + run_commit_cb($self); + $itrk->update_last(0, $last_art) if $itrk; + $err; +} + +sub nntp_each { + my ($self, $url, $eml_cb, @args) = @_; + my $uri = ref($url) ? $url : PublicInbox::URInntps->new($url); + my $sec = uri_section($uri); + local $0 = $uri->group ." $sec"; + my $nn = nn_get($self, $uri); + return if $self->{quit}; + my $err; + if ($nn) { + local $self->{eml_each} = [ $eml_cb, @args ]; + $err = _nntp_fetch_all($self, $nn, $uri); + } else { + $err = "E: <$uri> not connected: $!"; + } + warn $err if $err; + $nn; +} + sub new { bless {}, shift }; 1;