]> Sergey Matveev's repositories - public-inbox.git/commitdiff
lei up: automatically use dt: for remote externals
authorEric Wong <e@80x24.org>
Sat, 18 Sep 2021 09:33:32 +0000 (09:33 +0000)
committerEric Wong <e@80x24.org>
Sat, 18 Sep 2021 20:28:16 +0000 (20:28 +0000)
Since we can't use maxuid for remote externals, automatically
maintaining the last time we got results and appending a dt:
range to the query will prevent HTTP(S) responses from getting
too big.

We could be using "rt:", but no stable release of public-inbox
supports it, yet, so we'll use dt:, instead.

By default, there's a two day fudge factor to account for MTA
downtime and delays; which is hopefully enough.  The fudge
factor may be changed per-invocation with the
--remote-fudge-factor=INTERVAL option

Since different externals can have different message transport
routes, "lastresult" entries are stored on a per-external basis.

Documentation/lei-up.pod
lib/PublicInbox/LEI.pm
lib/PublicInbox/LeiSavedSearch.pm
lib/PublicInbox/LeiToMail.pm
lib/PublicInbox/LeiUp.pm
lib/PublicInbox/LeiXSearch.pm
t/lei-q-remote-import.t

index e5d97f434ace08461b3092248257336db78427df..f06ee5eb62b7270c070ad8d7ac8a62410099d648 100644 (file)
@@ -22,6 +22,21 @@ C<--all> updates all saved searches (listed in L<lei-ls-search(1)>).
 C<--all=local> only updates local mailboxes, C<--all=remote> only
 updates remote mailboxes (currently C<imap://> and C<imaps://>).
 
+=item --remote-fudge-time=INTERVAL
+
+Look for mail older than the time of the last successful query.
+Using a small interval will reduce bandwidth use.  A larger
+interval reduces the likelyhood of missing a result due to MTA
+delays or downtime.
+
+The time(s) of the last successful queries are the C<lastresult>
+values visible from L<lei-edit-search(1)>.
+
+Date formats understood by L<git-rev-parse(1)> may be used.
+e.g C<1.hour> or C<3.days>
+
+Default: 2.days
+
 =back
 
 The following options, described in L<lei-q(1)>, are supported.
index 053b6174d808514f04227b32f3bef982e72b3498..8b0614f27980f8e4e53f31681562ae25cc83b119 100644 (file)
@@ -183,7 +183,8 @@ our %CMD = ( # sorted in order of importance/use:
        shared color! mail-sync!), @c_opt, opt_dash('limit|n=i', '[0-9]+') ],
 
 'up' => [ 'OUTPUT...|--all', 'update saved search',
-       qw(jobs|j=s lock=s@ alert=s@ mua=s verbose|v+ all:s), @c_opt ],
+       qw(jobs|j=s lock=s@ alert=s@ mua=s verbose|v+
+       remote-fudge-time=s all:s), @c_opt ],
 
 'lcat' => [ '--stdin|MSGID_OR_URL...', 'display local copy of message(s)',
        'stdin|', # /|\z/ must be first for lone dash
@@ -420,7 +421,9 @@ my %OPTDESC = (
 'remote' => 'limit operations to those requiring network access',
 'remote!' => 'prevent operations requiring network access',
 
-'all:s up' => ['local', 'update all (local) saved searches' ],
+'all:s up' => ['local|remote', 'update all remote or local saved searches' ],
+'remote-fudge-time=s' => [ 'INTERVAL',
+       'look for mail INTERVAL older than the last successful query' ],
 
 'mid=s' => 'specify the Message-ID of a message',
 'oid=s' => 'specify the git object ID of a message',
index 96ff816e2bab79234d7f56080534f8da9ec51ece..754f8294d486c486caf22e3dc729f0bc8978fac2 100644 (file)
@@ -149,6 +149,7 @@ sub new { # new saved search "lei q --save"
        $dst = "$lei->{ovv}->{fmt}:$dst" if $dst !~ m!\Aimaps?://!i;
        print $fh <<EOM;
 ; to refresh with new results, run: lei up $sq_dst
+; `maxuid' and `lastresult' lines are maintained by "lei up" for optimization
 [lei]
 $q
 [lei "q"]
index d3253d9b01139bf6a2ea7b29cd0a5619485d2f41..9f7171fb04bbc89110fa7d6eedde534c6419e426 100644 (file)
@@ -437,7 +437,9 @@ sub new {
                        ($lei->{opt}->{save} ? 'LeiSavedSearch' : 'LeiDedupe');
                eval "require $dd_cls";
                die "$dd_cls: $@" if $@;
-               $dd_cls->new($lei);
+               my $dd = $dd_cls->new($lei);
+               $lei->{lss} //= $dd if $dd && $dd->can('cfg_set');
+               $dd;
        };
        $self;
 }
index 4637cb46a28f5968d63bee430eb3fdd18773b4e7..abb05d46eca5252637a31163f72c6c116a6229a7 100644 (file)
@@ -45,7 +45,7 @@ sub up1 ($$) {
                ref($v) and return $lei->fail("multiple values of $c in $f");
                $lei->{opt}->{$k} = $v;
        }
-       $lei->{lss} = $lss; # for LeiOverview->new
+       $lei->{lss} = $lss; # for LeiOverview->new and query_remote_mboxrd
        my $lxs = $lei->lxs_prepare or return;
        $lei->ale->refresh_externals($lxs, $lei);
        $lei->_start_query;
index 50cadb5eca5b9905e8ce065cf57843813dfacea4..1d49da3d3a4df1f0ef84bf70687f86523262b87f 100644 (file)
@@ -18,6 +18,7 @@ use PublicInbox::Smsg;
 use PublicInbox::Eml;
 use Fcntl qw(SEEK_SET F_SETFL O_APPEND O_RDWR);
 use PublicInbox::ContentHash qw(git_sha);
+use POSIX qw(strftime);
 
 sub new {
        my ($class) = @_;
@@ -168,8 +169,7 @@ sub query_one_mset { # for --threads and l2m w/o sort
        my $can_kw = !!$ibxish->can('msg_keywords');
        my $threads = $lei->{opt}->{threads} // 0;
        my $fl = $threads > 1 ? 1 : undef;
-       my $lss = $lei->{dedupe};
-       $lss = undef unless $lss && $lss->can('cfg_set'); # saved search
+       my $lss = $lei->{lss};
        my $maxk = "external.$dir.maxuid";
        my $stop_at = $lss ? $lss->{-cfg}->{$maxk} : undef;
        if (defined $stop_at) {
@@ -292,6 +292,37 @@ sub each_remote_eml { # callback for MboxReader->mboxrd
        $each_smsg->($smsg, undef, $eml);
 }
 
+sub fudge_qstr_time ($$$) {
+       my ($lei, $uri, $qstr) = @_;
+       return ($qstr, undef) unless $lei->{lss};
+       my $cfg = $lei->{lss}->{-cfg} // die 'BUG: no lss->{-cfg}';
+       my $cfg_key = "external.$uri.lastresult";
+       my $lr = $cfg->{$cfg_key} or return ($qstr, $cfg_key);
+       if ($lr !~ /\A\-?[0-9]+\z/) {
+               $lei->child_error(0,
+                       "$cfg->{-f}: $cfg_key=$lr not an integer, ignoring");
+               return ($qstr, $cfg_key);
+       }
+       my $rft = $lei->{opt}->{'remote-fudge-time'};
+       if ($rft && $rft !~ /\A-?[0-9]+\z/) {
+               my @t = $lei->{lss}->git->date_parse($rft);
+               my $diff = time - $t[0];
+               $lei->qerr("# $rft => $diff seconds");
+               $rft = $diff;
+       }
+       $lr -= ($rft || (48 * 60 * 60));
+       $lei->qerr("# $uri limiting to ".
+               strftime('%Y-%m-%d %k:%M', gmtime($lr)). ' and newer');
+       # this should really be rt: (received-time), but no stable
+       # public-inbox releases support it, yet.
+       my $dt = 'dt:'.strftime('%Y%m%d%H%M%S', gmtime($lr)).'..';
+       if ($qstr =~ /\S/) {
+               substr($qstr, 0, 0, '(');
+               $qstr .= ') AND ';
+       }
+       ($qstr .= $dt, $cfg_key);
+}
+
 sub query_remote_mboxrd {
        my ($self, $uris) = @_;
        local $0 = "$0 query_remote_mboxrd";
@@ -300,7 +331,7 @@ sub query_remote_mboxrd {
        my $opt = $lei->{opt};
        my $qstr = $lei->{mset_opt}->{qstr};
        $qstr =~ s/[ \n\t]+/ /sg; # make URLs less ugly
-       my @qform = (q => $qstr, x => 'm');
+       my @qform = (x => 'm');
        push(@qform, t => 1) if $opt->{threads};
        my $verbose = $opt->{verbose};
        my ($reap_tail, $reap_curl);
@@ -323,7 +354,9 @@ sub query_remote_mboxrd {
        for my $uri (@$uris) {
                $lei->{-current_url} = $uri->as_string;
                $lei->{-nr_remote_eml} = 0;
-               $uri->query_form(@qform);
+               my $start = time;
+               my ($q, $key) = fudge_qstr_time($lei, $uri, $qstr);
+               $uri->query_form(@qform, q => $q);
                my $cmd = $curl->for_uri($lei, $uri);
                $lei->qerr("# $cmd");
                my ($fh, $pid) = popen_rd($cmd, undef, $rdr);
@@ -336,10 +369,11 @@ sub query_remote_mboxrd {
                @$reap_curl = (); # cancel OnDestroy
                die $err if $err;
                my $nr = $lei->{-nr_remote_eml};
-               if ($nr && $lei->{sto}) {
-                       my $wait = $lei->{sto}->ipc_do('done');
-               }
+               my $wait = $lei->{sto}->ipc_do('done') if $nr && $lei->{sto};
                if ($? == 0) {
+                       # don't update if no results, maybe MTA is down
+                       $key && $nr and
+                               $lei->{lss}->cfg_set($key, $start);
                        mset_progress($lei, $lei->{-current_url}, $nr, $nr);
                        next;
                }
@@ -353,7 +387,7 @@ sub query_remote_mboxrd {
                                        $lei->err("truncate($cmd stderr): $!");
                }
                next if (($? >> 8) == 22 && $err =~ /\b404\b/);
-               $uri->query_form(q => $lei->{mset_opt}->{qstr});
+               $uri->query_form(q => $qstr);
                $lei->child_error($?, "E: <$uri> $err");
        }
        undef $each_smsg;
index 9131c01bb6378f7b93f8d09a49653d735dfffee4..fdf6a11e3b574e5b32e736881c7849e6ea18156d 100644 (file)
@@ -99,5 +99,9 @@ EOF
        lei_ok('up', "$ENV{HOME}/md");
        is_deeply(\@f, [ glob("$ENV{HOME}/md/*/*") ],
                'lei up remote dedupe works on maildir');
+       my $edit_env = { VISUAL => 'cat' };
+       lei_ok([qw(edit-search), "$ENV{HOME}/md"], $edit_env);
+       like($lei_out, qr/^\Q[external "$url"]\E\n\s*lastresult = \d+/sm,
+               'lastresult set');
 });
 done_testing;