X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FNetReader.pm;h=2795a9d4d85e4bbc21c7669a13825db1d6870ba8;hb=84cc78416994832973c44aab08814b43a0fe7e51;hp=2a45321769b19230e37ec2e1e23d6f9313642994;hpb=2f9f6c9eca667dfde9e267e946498eaad0b0c8da;p=public-inbox.git diff --git a/lib/PublicInbox/NetReader.pm b/lib/PublicInbox/NetReader.pm index 2a453217..2795a9d4 100644 --- a/lib/PublicInbox/NetReader.pm +++ b/lib/PublicInbox/NetReader.pm @@ -7,14 +7,16 @@ use strict; use v5.10.1; use parent qw(Exporter PublicInbox::IPC); use PublicInbox::Eml; - +use PublicInbox::Config; our %IMAPflags2kw = map {; "\\\u$_" => $_ } qw(seen answered flagged draft); +$IMAPflags2kw{'$Forwarded'} = 'forwarded'; # RFC 5550 + +our @EXPORT = qw(uri_section imap_uri nntp_uri); -# TODO: trim this down, this is huge -our @EXPORT = qw(uri_new uri_section - nn_new imap_uri nntp_uri - cfg_bool cfg_intvl imap_common_init nntp_common_init - ); +sub ndump { + require Data::Dumper; + Data::Dumper->new(\@_)->Useqq(1)->Terse(1)->Dump; +} # returns the git config section name, e.g [imap "imaps://user@example.com"] # without the mailbox, so we can share connections between different inboxes @@ -23,22 +25,50 @@ sub uri_section ($) { $uri->scheme . '://' . $uri->authority; } +sub socks_args ($) { + my ($val) = @_; + return if ($val // '') eq ''; + if ($val =~ m!\Asocks5h:// (?: \[ ([^\]]+) \] | ([^:/]+) ) + (?::([0-9]+))?/*\z!ix) { + my ($h, $p) = ($1 // $2, $3 + 0); + $h = '127.0.0.1' if $h eq '0'; + eval { require IO::Socket::Socks } or die < $h, ProxyPort => $p }; + } + die "$val not understood (only socks5h:// is supported)\n"; +} + +sub mic_new ($$$$) { + my ($self, $mic_arg, $sec, $uri) = @_; + my %socks; + my $sa = $self->{imap_opt}->{$sec}->{-proxy_cfg} || $self->{-proxy_cli}; + if ($sa) { + my %opt = %$sa; + $opt{ConnectAddr} = delete $mic_arg->{Server}; + $opt{ConnectPort} = delete $mic_arg->{Port}; + $socks{Socket} = IO::Socket::Socks->new(%opt) or die + "E: <$$uri> ".eval('$IO::Socket::Socks::SOCKS_ERROR'); + } + PublicInbox::IMAPClient->new(%$mic_arg, %socks); +} + sub auth_anon_cb { '' }; # for Mail::IMAPClient::Authcallback # mic_for may prompt the user and store auth info, prepares mic_get -sub mic_for { # mic = Mail::IMAPClient - my ($self, $url, $mic_args, $lei) = @_; - require PublicInbox::URIimap; - my $uri = PublicInbox::URIimap->new($url); +sub mic_for ($$$$) { # mic = Mail::IMAPClient + my ($self, $uri, $mic_args, $lei) = @_; require PublicInbox::GitCredential; my $cred = bless { - url => $url, + url => "$uri", protocol => $uri->scheme, host => $uri->host, username => $uri->user, password => $uri->password, }, 'PublicInbox::GitCredential'; - my $common = $mic_args->{uri_section($uri)} // {}; + my $sec = uri_section($uri); + my $common = $mic_args->{$sec} // {}; # IMAPClient and Net::Netrc both mishandles `0', so we pass `127.0.0.1' my $host = $cred->{host}; $host = '127.0.0.1' if $host eq '0'; @@ -50,15 +80,14 @@ sub mic_for { # mic = Mail::IMAPClient %$common, # may set Starttls, Compress, Debug .... }; require PublicInbox::IMAPClient; - my $mic = PublicInbox::IMAPClient->new(%$mic_arg) or - die "E: <$url> new: $@\n"; - + my $mic = mic_new($self, $mic_arg, $sec, $uri) or + die "E: <$uri> new: $@\n"; # default to using STARTTLS if it's available, but allow # it to be disabled since I usually connect to localhost if (!$mic_arg->{Ssl} && !defined($mic_arg->{Starttls}) && $mic->has_capability('STARTTLS') && $mic->can('starttls')) { - $mic->starttls or die "E: <$url> STARTTLS: $@\n"; + $mic->starttls or die "E: <$uri> STARTTLS: $@\n"; } # do we even need credentials? @@ -79,9 +108,14 @@ sub mic_for { # mic = Mail::IMAPClient my $err; if ($mic->login && $mic->IsAuthenticated) { # success! keep IMAPClient->new arg in case we get disconnected - $self->{mic_arg}->{uri_section($uri)} = $mic_arg; + $self->{mic_arg}->{$sec} = $mic_arg; + if ($cred) { + $uri->user($cred->{username}) if !defined($uri->user); + } elsif ($mic_arg->{Authmechanism} eq 'ANONYMOUS') { + $uri->auth('ANONYMOUS') if !defined($uri->auth); + } } else { - $err = "E: <$url> LOGIN: $@\n"; + $err = "E: <$uri> LOGIN: $@\n"; if ($cred && defined($cred->{password})) { $err =~ s/\Q$cred->{password}\E/*******/g; } @@ -94,15 +128,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) = @_; @@ -114,7 +139,14 @@ sub try_starttls ($) { sub nn_new ($$$) { my ($nn_arg, $nntp_opt, $uri) = @_; - my $nn = Net::NNTP->new(%$nn_arg) or die "E: <$uri> new: $!\n"; + my $nn; + if (defined $nn_arg->{ProxyAddr}) { + require PublicInbox::NetNNTPSocks; + eval { $nn = PublicInbox::NetNNTPSocks->new_socks(%$nn_arg) }; + die "E: <$uri> $@\n" if $@; + } else { + $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 @@ -141,7 +173,7 @@ E: <$uri> STARTTLS requested and failed $nn; } -sub nn_for ($$$;$) { # nn = Net::NNTP +sub nn_for ($$$$) { # nn = Net::NNTP my ($self, $uri, $nn_args, $lei) = @_; my $sec = uri_section($uri); my $nntp_opt = $self->{nntp_opt}->{$sec} //= {}; @@ -168,6 +200,8 @@ sub nn_for ($$$;$) { # nn = Net::NNTP SSL => $uri->secure, # snews == nntps %$common, # may Debug .... }; + my $sa = $self->{-proxy_cli}; + %$nn_arg = (%$nn_arg, %$sa) if $sa; my $nn = nn_new($nn_arg, $nntp_opt, $uri); if ($cred) { $cred->fill($lei); # may prompt user here @@ -243,7 +277,7 @@ sub imap_common_init ($;$) { $self->{quiet} = 1 if $lei && $lei->{opt}->{quiet}; eval { require PublicInbox::IMAPClient } or die "Mail::IMAPClient is required for IMAP:\n$@\n"; - eval { require PublicInbox::IMAPTracker } or + ($lei || eval { require PublicInbox::IMAPTracker }) or die "DBD::SQLite is required for IMAP\n:$@\n"; require PublicInbox::URIimap; my $cfg = $self->{pi_cfg} // $lei->_lei_cfg; @@ -256,6 +290,8 @@ sub imap_common_init ($;$) { } my $to = cfg_intvl($cfg, 'imap.timeout', $$uri); $mic_args->{$sec}->{Timeout} = $to if $to; + my $sa = socks_args($cfg->urlmatch('imap.Proxy', $$uri)); + $self->{imap_opt}->{$sec}->{-proxy_cfg} = $sa if $sa; for my $k (qw(pollInterval idleInterval)) { $to = cfg_intvl($cfg, "imap.$k", $$uri) // next; $self->{imap_opt}->{$sec}->{$k} = $to; @@ -271,14 +307,16 @@ sub imap_common_init ($;$) { # make sure we can connect and cache the credentials in memory $self->{mic_arg} = {}; # schema://authority => IMAPClient->new args my $mics = {}; # schema://authority => IMAPClient obj - for my $uri (@{$self->{imap_order}}) { - my $sec = uri_section($uri); - $mics->{$sec} //= mic_for($self, "$sec/", $mic_args, $lei); + for my $orig_uri (@{$self->{imap_order}}) { + my $sec = uri_section($orig_uri); + my $uri = PublicInbox::URIimap->new("$sec/"); + my $mic = $mics->{$sec} //= + mic_for($self, $uri, $mic_args, $lei) // + die "Unable to continue\n"; next unless $self->isa('PublicInbox::NetWriter'); - my $dst = $uri->mailbox // next; - my $mic = $mics->{$sec}; + my $dst = $orig_uri->mailbox // next; next if $mic->exists($dst); # already exists - $mic->create($dst) or die "CREATE $dst failed <$uri>: $@"; + $mic->create($dst) or die "CREATE $dst failed <$orig_uri>: $@"; } $mics; } @@ -290,18 +328,21 @@ sub nntp_common_init ($;$) { $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 + ($lei || 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); + my $args = $nn_args->{$sec} //= {}; # 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; + $args->{Debug} = $v if defined $v; my $to = cfg_intvl($cfg, 'nntp.Timeout', $$uri); - $nn_args->{$sec}->{Timeout} = $to if $to; + $args->{Timeout} = $to if $to; + my $sa = socks_args($cfg->urlmatch('nntp.Proxy', $$uri)); + %$args = (%$args, %$sa) if $sa; # Net::NNTP post-connect commands for my $k (qw(starttls compress)) { @@ -309,7 +350,7 @@ sub nntp_common_init ($;$) { $self->{nntp_opt}->{$sec}->{$k} = $v; } - # internal option + # -watch internal option for my $k (qw(pollInterval)) { $to = cfg_intvl($cfg, "nntp.$k", $$uri) // next; $self->{nntp_opt}->{$sec}->{$k} = $to; @@ -338,7 +379,7 @@ sub add_url { } sub errors { - my ($self) = @_; + my ($self, $lei) = @_; if (my $u = $self->{unsupported_url}) { return "Unsupported URL(s): @$u"; } @@ -350,51 +391,153 @@ sub errors { eval { require Net::NNTP } or die "Net::NNTP is required for NNTP:\n$@\n"; } + my $sa = socks_args($lei ? $lei->{opt}->{proxy} : undef); + $self->{-proxy_cli} = $sa if $sa; undef; } +sub flags2kw ($$$$) { + my ($self, $uri, $uid, $flags) = @_; + my $kw = []; + for my $f (split(/ /, $flags)) { + 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 LeiSearch->kw_changed and UI/UX purposes + $kw; +} + sub _imap_do_msg ($$$$$) { my ($self, $uri, $uid, $raw, $flags) = @_; # our target audience expects LF-only, save storage $$raw =~ s/\r\n/\n/sg; - my $kw = []; - for my $f (split(/ /, $flags)) { - my $k = $IMAPflags2kw{$f} // next; # TODO: X-Label? - push @$kw, $k; - } + my $kw = flags2kw($self, $uri, $uid, $flags) // return; my ($eml_cb, @args) = @{$self->{eml_each}}; $eml_cb->($uri, $uid, $kw, PublicInbox::Eml->new($raw), @args); } -sub _imap_fetch_all ($$$) { - my ($self, $mic, $uri) = @_; +sub run_commit_cb ($) { + my ($self) = @_; + my $cmt_cb_args = $self->{on_commit} or return; + my ($cb, @args) = @$cmt_cb_args; + $cb->(@args); +} + +sub itrk_last ($$;$$) { + my ($self, $uri, $r_uidval, $mic) = @_; + return (undef, undef, $r_uidval) unless $self->{incremental}; + my ($itrk, $l_uid, $l_uidval); + if (defined(my $lms = $self->{-lms_ro})) { # LeiMailSync or 0 + $uri->uidvalidity($r_uidval) if defined $r_uidval; + if ($mic) { + my $auth = $mic->Authmechanism // ''; + $uri->auth($auth) if $auth eq 'ANONYMOUS'; + my $user = $mic->User; + $uri->user($user) if defined($user); + } + my $x; + $l_uid = ($lms && ($x = $lms->location_stats($$uri))) ? + $x->{'uid.max'} : undef; + # itrk remains undef, lei/store worker writes to + # mail_sync.sqlite3 + } else { + $itrk = PublicInbox::IMAPTracker->new($$uri); + ($l_uidval, $l_uid) = $itrk->get_last($$uri); + } + ($itrk, $l_uid, $l_uidval //= $r_uidval); +} + +# import flags of already-seen messages +sub each_old_flags ($$$$) { + my ($self, $mic, $uri, $l_uid) = @_; + $l_uid ||= 1; my $sec = uri_section($uri); - my $mbx = $uri->mailbox; + my $bs = $self->{imap_opt}->{$sec}->{batch_size} // 10000; + my ($eml_cb, @args) = @{$self->{eml_each}}; + for (my $n = 1; $n <= $l_uid; $n += $bs) { + my $end = $n + $bs; + $end = $l_uid if $end > $l_uid; + my $r = $mic->fetch_hash("$n:$end", 'FLAGS'); + if (!$r) { + return if $!{EINTR} && $self->{quit}; + return "E: $uri UID FETCH $n:$end error: $!"; + } + while (my ($uid, $per_uid) = each %$r) { + my $kw = flags2kw($self, $uri, $uid, $per_uid->{FLAGS}) + // next; + # LeiImport->input_net_cb + $eml_cb->($uri, $uid, $kw, undef, @args); + } + } +} + +# returns true if PERMANENTFLAGS indicates FLAGS of already imported +# messages are meaningful +sub perm_fl_ok ($) { + my ($perm_fl) = @_; + return if !defined($perm_fl); + for my $f (split(/[ \t]+/, $perm_fl)) { + return 1 if $IMAPflags2kw{$f}; + } + undef; +} + +sub _imap_fetch_all ($$$) { + my ($self, $mic, $orig_uri) = @_; + my $sec = uri_section($orig_uri); + my $mbx = $orig_uri->mailbox; $mic->Clear(1); # trim results history - $mic->examine($mbx) or return "E: EXAMINE $mbx ($sec) failed: $!"; - my ($r_uidval, $r_uidnext); + + # we need to check for mailbox writability to see if we care about + # FLAGS from already-imported messages. + my $cmd = $self->{each_old} ? 'select' : 'examine'; + $mic->$cmd($mbx) or return "E: \U$cmd\E $mbx ($sec) failed: $!"; + + my ($r_uidval, $r_uidnext, $perm_fl); for ($mic->Results) { + /^\* OK \[PERMANENTFLAGS \(([^\)]*)\)\].*/ and $perm_fl = $1; /^\* OK \[UIDVALIDITY ([0-9]+)\].*/ and $r_uidval = $1; /^\* OK \[UIDNEXT ([0-9]+)\].*/ and $r_uidnext = $1; - last if $r_uidval && $r_uidnext; } $r_uidval //= $mic->uidvalidity($mbx) // - return "E: $uri cannot get UIDVALIDITY"; + return "E: $orig_uri cannot get UIDVALIDITY"; $r_uidnext //= $mic->uidnext($mbx) // - return "E: $uri cannot get UIDNEXT"; - my $itrk = $self->{incremental} ? - PublicInbox::IMAPTracker->new($$uri) : 0; - my ($l_uidval, $l_uid) = $itrk ? $itrk->get_last : (); - $l_uidval //= $r_uidval; # first time + return "E: $orig_uri cannot get UIDNEXT"; + my $expect = $orig_uri->uidvalidity // $r_uidval; + return <clone; + my $single_uid = $uri->uid; + my ($itrk, $l_uid, $l_uidval) = itrk_last($self, $uri, $r_uidval, $mic); + if (defined($single_uid)) { + $itrk = $l_uid = undef; + $uri->uid(undef); # for eml_cb + } + return <uidvalidity($r_uidval); $l_uid //= 0; - if ($l_uidval != $r_uidval) { - return "E: $uri UIDVALIDITY mismatch\n". - "E: local=$l_uidval != remote=$r_uidval"; - } my $r_uid = $r_uidnext - 1; - if ($l_uid > $r_uid) { - return "E: $uri local UID exceeds remote ($l_uid > $r_uid)\n". - "E: $uri strangely, UIDVALIDLITY matches ($l_uidval)\n"; + return < $r_uid; +E: $uri local UID exceeds remote ($l_uid > $r_uid) +E: $uri strangely, UIDVALIDLITY matches ($l_uidval) +EOF + $mic->Uid(1); # the default, we hope + my $err; + if (!defined($single_uid) && $self->{each_old} && + perm_fl_ok($perm_fl)) { + $err = each_old_flags($self, $mic, $uri, $l_uid); + return $err if $err; } return if $l_uid >= $r_uid; # nothing to do $l_uid ||= 1; @@ -403,19 +546,21 @@ sub _imap_fetch_all ($$$) { 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'; my $key = $req; $key =~ s/\.PEEK//; my ($uids, $batch); - my $err; do { # 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 + if (defined $single_uid) { + $uids = [ $single_uid ]; + } elsif (!($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 @@ -437,6 +582,7 @@ sub _imap_fetch_all ($$$) { 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; } @@ -451,8 +597,9 @@ 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}); + } until ($err || $self->{quit} || defined($single_uid)); $err; } @@ -474,7 +621,7 @@ sub mic_get { $mic_arg->{Authcallback} = $self->can($cb_name); } } - my $mic = PublicInbox::IMAPClient->new(%$mic_arg); + my $mic = mic_new($self, $mic_arg, $sec, $uri); $cached //= {}; # invalid placeholder if no cache enabled $mic && $mic->IsConnected ? ($cached->{$sec} = $mic) : undef; } @@ -490,8 +637,9 @@ 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: $!"; } + die $err if $err && $self->{-can_die}; warn $err if $err; $mic; } @@ -525,16 +673,14 @@ sub _nntp_fetch_all ($$$) { my $sec = uri_section($uri); my ($nr, $beg, $end) = $nn->group($group); unless (defined($nr)) { - chomp(my $msg = $nn->message); + my $msg = ndump($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 : (); + my ($itrk, $l_art) = itrk_last($self, $uri); # allow users to specify articles to refetch # cf. https://tools.ietf.org/id/draft-gilman-news-url-01.txt @@ -545,22 +691,22 @@ sub _nntp_fetch_all ($$$) { return if $l_art >= $end; # nothing to do $beg = $l_art + 1; } - my ($err, $art); + my ($err, $art, $last_art, $kw); # kw stays undef, no keywords in NNTP 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; + my $msg = ndump($nn->message); if ($nn->code == 421) { # pseudo response from Net::Cmd $err = "E: $msg"; last; @@ -572,9 +718,10 @@ sub _nntp_fetch_all ($$$) { $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); + $eml_cb->($uri, $art, $kw, PublicInbox::Eml->new(\$raw), @args); $last_art = $art; } + run_commit_cb($self); $itrk->update_last(0, $last_art) if $itrk; $err; } @@ -585,17 +732,38 @@ sub nntp_each { 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: not connected: $!"; + $err = "E: <$uri> not connected: $!"; } + die $err if $err && $self->{-can_die}; warn $err if $err; $nn; } sub new { bless {}, shift }; +# updates $uri with UIDVALIDITY +sub mic_for_folder { + my ($self, $uri) = @_; + my $mic = $self->mic_get($uri) or die "E: not connected: $@"; + my $m = $self->isa('PublicInbox::NetWriter') ? 'select' : 'examine'; + $mic->$m($uri->mailbox) or return; + my $uidval; + for ($mic->Results) { + /^\* OK \[UIDVALIDITY ([0-9]+)\].*/ or next; + $uidval = $1; + last; + } + $uidval //= $mic->uidvalidity($uri->mailbox) or + die "E: failed to get uidvalidity from <$uri>: $@"; + $uri->uidvalidity($uidval); + $mic; +} + + 1;