]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/NetReader.pm
net_reader: improve naming of common args
[public-inbox.git] / lib / PublicInbox / NetReader.pm
index 9faa362c397acc5c110ac6271090b161f92a1bf2..181741f6aaf0e2eced14b38a88b7aa0f53dc38a3 100644 (file)
@@ -42,23 +42,23 @@ EOM
 
 sub mic_new ($$$$) {
        my ($self, $mic_arg, $sec, $uri) = @_;
-       my %socks;
-       my $sa = $self->{imap_opt}->{$sec}->{-proxy_cfg} || $self->{-proxy_cli};
+       my %mic_arg = %$mic_arg;
+       my $sa = $self->{cfg_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
+               $opt{ConnectAddr} = delete $mic_arg{Server};
+               $opt{ConnectPort} = delete $mic_arg{Port};
+               $mic_arg{Socket} = IO::Socket::Socks->new(%opt) or die
                        "E: <$$uri> ".eval('$IO::Socket::Socks::SOCKS_ERROR');
        }
-       PublicInbox::IMAPClient->new(%$mic_arg, %socks, Keepalive => 1);
+       PublicInbox::IMAPClient->new(%mic_arg, Keepalive => 1);
 }
 
 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, $uri, $mic_args, $lei) = @_;
+       my ($self, $uri, $mic_common, $lei) = @_;
        require PublicInbox::GitCredential;
        my $cred = bless {
                url => "$uri",
@@ -68,7 +68,7 @@ sub mic_for ($$$$) { # mic = Mail::IMAPClient
                password => $uri->password,
        }, 'PublicInbox::GitCredential';
        my $sec = uri_section($uri);
-       my $common = $mic_args->{$sec} // {};
+       my $common = $mic_common->{$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';
@@ -108,7 +108,7 @@ 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}->{$sec} = $mic_arg;
+               $self->{net_arg}->{$sec} = $mic_arg;
                if ($cred) {
                        $uri->user($cred->{username}) if !defined($uri->user);
                } elsif ($mic_arg->{Authmechanism} eq 'ANONYMOUS') {
@@ -138,7 +138,7 @@ sub try_starttls ($) {
 }
 
 sub nn_new ($$$) {
-       my ($nn_arg, $nntp_opt, $uri) = @_;
+       my ($nn_arg, $nntp_cfg, $uri) = @_;
        my $nn;
        if (defined $nn_arg->{ProxyAddr}) {
                require PublicInbox::NetNNTPSocks;
@@ -151,19 +151,19 @@ sub nn_new ($$$) {
        # default to using STARTTLS if it's available, but allow
        # it to be disabled for localhost/VPN users
        if (!$nn_arg->{SSL} && $nn->can('starttls')) {
-               if (!defined($nntp_opt->{starttls}) &&
+               if (!defined($nntp_cfg->{starttls}) &&
                                try_starttls($nn_arg->{Host})) {
                        # soft fail by default
                        $nn->starttls or warn <<"";
 W: <$uri> STARTTLS tried and failed (not requested)
 
-               } elsif ($nntp_opt->{starttls}) {
+               } elsif ($nntp_cfg->{starttls}) {
                        # hard fail if explicitly configured
                        $nn->starttls or die <<"";
 E: <$uri> STARTTLS requested and failed
 
                }
-       } elsif ($nntp_opt->{starttls}) {
+       } elsif ($nntp_cfg->{starttls}) {
                $nn->can('starttls') or
                        die "E: <$uri> Net::NNTP too old for STARTTLS\n";
                $nn->starttls or die <<"";
@@ -174,9 +174,9 @@ E: <$uri> STARTTLS requested and failed
 }
 
 sub nn_for ($$$$) { # nn = Net::NNTP
-       my ($self, $uri, $nn_args, $lei) = @_;
+       my ($self, $uri, $nn_common, $lei) = @_;
        my $sec = uri_section($uri);
-       my $nntp_opt = $self->{nntp_opt}->{$sec} //= {};
+       my $nntp_cfg = $self->{cfg_opt}->{$sec} //= {};
        my $host = $uri->host;
        # Net::NNTP and Net::Netrc both mishandle `0', so we pass `127.0.0.1'
        $host = '127.0.0.1' if $host eq '0';
@@ -193,7 +193,7 @@ sub nn_for ($$$$) { # nn = Net::NNTP
                ($cred->{username}, $cred->{password}) = ($u, $p);
                $p //= $cred->check_netrc;
        }
-       my $common = $nn_args->{$sec} // {};
+       my $common = $nn_common->{$sec} // {};
        my $nn_arg = {
                Port => $uri->port,
                Host => $host,
@@ -202,27 +202,27 @@ sub nn_for ($$$$) { # nn = Net::NNTP
        $nn_arg->{SSL} = 1 if $uri->secure; # snews == nntps
        my $sa = $self->{-proxy_cli};
        %$nn_arg = (%$nn_arg, %$sa) if $sa;
-       my $nn = nn_new($nn_arg, $nntp_opt, $uri);
+       my $nn = nn_new($nn_arg, $nntp_cfg, $uri);
        if ($cred) {
                $cred->fill($lei) unless defined($p); # may prompt user here
                if ($nn->authinfo($u, $p)) {
-                       push @{$nntp_opt->{-postconn}}, [ 'authinfo', $u, $p ];
+                       push @{$nntp_cfg->{-postconn}}, [ 'authinfo', $u, $p ];
                } else {
                        warn "E: <$uri> AUTHINFO $u XXXX failed\n";
                        $nn = undef;
                }
        }
 
-       if ($nntp_opt->{compress}) {
+       if ($nntp_cfg->{compress}) {
                # https://rt.cpan.org/Ticket/Display.html?id=129967
                if ($nn->can('compress')) {
                        if ($nn->compress) {
-                               push @{$nntp_opt->{-postconn}}, [ 'compress' ];
+                               push @{$nntp_cfg->{-postconn}}, [ 'compress' ];
                        } else {
                                warn "W: <$uri> COMPRESS failed\n";
                        }
                } else {
-                       delete $nntp_opt->{compress};
+                       delete $nntp_cfg->{compress};
                        warn <<"";
 W: <$uri> COMPRESS not supported by Net::NNTP
 W: see https://rt.cpan.org/Ticket/Display.html?id=129967 for updates
@@ -230,7 +230,7 @@ W: see https://rt.cpan.org/Ticket/Display.html?id=129967 for updates
                }
        }
 
-       $self->{nn_arg}->{$sec} = $nn_arg;
+       $self->{net_arg}->{$sec} = $nn_arg;
        $cred->run($nn ? 'approve' : 'reject') if $cred && $cred->{filled};
        $nn;
 }
@@ -282,37 +282,36 @@ sub imap_common_init ($;$) {
                die "DBD::SQLite is required for IMAP\n:$@\n";
        require PublicInbox::URIimap;
        my $cfg = $self->{pi_cfg} // $lei->_lei_cfg;
-       my $mic_args = {}; # scheme://authority => Mail:IMAPClient arg
+       my $mic_common = {}; # scheme://authority => Mail:IMAPClient arg
        for my $uri (@{$self->{imap_order}}) {
                my $sec = uri_section($uri);
                for my $k (qw(Starttls Debug Compress)) {
                        my $bool = cfg_bool($cfg, "imap.$k", $$uri) // next;
-                       $mic_args->{$sec}->{$k} = $bool;
+                       $mic_common->{$sec}->{$k} = $bool;
                }
                my $to = cfg_intvl($cfg, 'imap.timeout', $$uri);
-               $mic_args->{$sec}->{Timeout} = $to if $to;
+               $mic_common->{$sec}->{Timeout} = $to if $to;
                my $sa = socks_args($cfg->urlmatch('imap.Proxy', $$uri));
-               $self->{imap_opt}->{$sec}->{-proxy_cfg} = $sa if $sa;
+               $self->{cfg_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;
+                       $self->{cfg_opt}->{$sec}->{$k} = $to;
                }
                my $k = 'imap.fetchBatchSize';
                my $bs = $cfg->urlmatch($k, $$uri) // next;
                if ($bs =~ /\A([0-9]+)\z/) {
-                       $self->{imap_opt}->{$sec}->{batch_size} = $bs;
+                       $self->{cfg_opt}->{$sec}->{batch_size} = $bs;
                } else {
                        warn "$k=$bs is not an integer\n";
                }
        }
        # 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 $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) //
+                               mic_for($self, $uri, $mic_common, $lei) //
                                die "Unable to continue\n";
                next unless $self->isa('PublicInbox::NetWriter');
                my $dst = $orig_uri->mailbox // next;
@@ -332,10 +331,10 @@ sub nntp_common_init ($;$) {
        ($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
+       my $nn_common = {}; # scheme://authority => Net::NNTP->new arg
        for my $uri (@{$self->{nntp_order}}) {
                my $sec = uri_section($uri);
-               my $args = $nn_args->{$sec} //= {};
+               my $args = $nn_common->{$sec} //= {};
 
                # Debug and Timeout are passed to Net::NNTP->new
                my $v = cfg_bool($cfg, 'nntp.Debug', $$uri);
@@ -348,21 +347,20 @@ sub nntp_common_init ($;$) {
                # 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;
+                       $self->{cfg_opt}->{$sec}->{$k} = $v;
                }
 
                # -watch internal option
                for my $k (qw(pollInterval)) {
                        $to = cfg_intvl($cfg, "nntp.$k", $$uri) // next;
-                       $self->{nntp_opt}->{$sec}->{$k} = $to;
+                       $self->{cfg_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{$sec} //= nn_for($self, $uri, $nn_common, $lei);
        }
        \%nn; # for optional {nn_cached}
 }
@@ -462,7 +460,7 @@ sub each_old_flags ($$$$) {
        my ($self, $mic, $uri, $l_uid) = @_;
        $l_uid ||= 1;
        my $sec = uri_section($uri);
-       my $bs = ($self->{imap_opt}->{$sec}->{batch_size} // 1) * 10000;
+       my $bs = ($self->{cfg_opt}->{$sec}->{batch_size} // 1) * 10000;
        my ($eml_cb, @args) = @{$self->{eml_each}};
        $self->{quiet} or warn "# $uri syncing flags 1:$l_uid\n";
        for (my $n = 1; $n <= $l_uid; $n += $bs) {
@@ -554,7 +552,7 @@ EOF
                my $m = $mod ? " [(UID % $mod) == $shard]" : '';
                warn "# $uri fetching UID $l_uid:$r_uid$m\n";
        }
-       my $bs = $self->{imap_opt}->{$sec}->{batch_size} // 1;
+       my $bs = $self->{cfg_opt}->{$sec}->{batch_size} // 1;
        my $req = $mic->imap4rev1 ? 'BODY.PEEK[]' : 'RFC822.PEEK';
        my $key = $req;
        $key =~ s/\.PEEK//;
@@ -622,7 +620,7 @@ sub mic_get {
                return $mic if $mic && $mic->IsConnected;
                delete $cached->{$sec};
        }
-       my $mic_arg = $self->{mic_arg}->{$sec} or
+       my $mic_arg = $self->{net_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') {
@@ -660,11 +658,11 @@ sub nn_get {
        my $cached = $self->{nn_cached} // {};
        my $nn;
        $nn = delete($cached->{$sec}) and return $nn;
-       my $nn_arg = $self->{nn_arg}->{$sec} or
+       my $nn_arg = $self->{net_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}) {
+       my $nntp_cfg = $self->{cfg_opt}->{$sec};
+       $nn = nn_new($nn_arg, $nntp_cfg, $uri) or return;
+       if (my $postconn = $nntp_cfg->{-postconn}) {
                for my $m_arg (@$postconn) {
                        my ($method, @args) = @$m_arg;
                        $nn->$method(@args) and next;