about summary refs log tree commit homepage
path: root/lib/PublicInbox/LeiRefreshMailSync.pm
diff options
context:
space:
mode:
authorEric Wong <e@80x24.org>2021-09-16 20:56:39 -0500
committerEric Wong <e@80x24.org>2021-09-17 04:41:03 +0000
commit1323196d1df67db5cb47a171a60236049c1e5ce5 (patch)
treee81ed65e5659a1e8d052a19acca8274f565b0a68 /lib/PublicInbox/LeiRefreshMailSync.pm
parent40e1f1612777251169fe9fb0d81bc5d062dd72c8 (diff)
downloadpublic-inbox-1323196d1df67db5cb47a171a60236049c1e5ce5.tar.gz
Merely pruning mail synchronization information was
insufficient for Maildir: renames are common in Maildir
and we need to detect them after-the-fact when lei-daemon
isn't running.

Running this command could make "lei index" far more
useful...

v2: close R/O mail_sync.sqlite3 dbh before fork
  Keeping the DB file handle open across fork can cause bad things
  to happen even if we don't use it since sqlite3 itself still knows
  about it (but doesn't know Perl code doesn't know about it).
Diffstat (limited to 'lib/PublicInbox/LeiRefreshMailSync.pm')
-rw-r--r--lib/PublicInbox/LeiRefreshMailSync.pm112
1 files changed, 112 insertions, 0 deletions
diff --git a/lib/PublicInbox/LeiRefreshMailSync.pm b/lib/PublicInbox/LeiRefreshMailSync.pm
new file mode 100644
index 00000000..3c083965
--- /dev/null
+++ b/lib/PublicInbox/LeiRefreshMailSync.pm
@@ -0,0 +1,112 @@
+# Copyright (C) 2021 all contributors <meta@public-inbox.org>
+# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
+
+# "lei refresh-mail-sync" drops dangling sync information
+# and attempts to detect moved files
+package PublicInbox::LeiRefreshMailSync;
+use strict;
+use v5.10.1;
+use parent qw(PublicInbox::IPC PublicInbox::LeiInput);
+use PublicInbox::LeiExportKw;
+use PublicInbox::InboxWritable qw(eml_from_path);
+use PublicInbox::ContentHash qw(git_sha);
+use PublicInbox::Import;
+
+sub eml_match ($$) {
+        my ($eml, $oidbin) = @_;
+        $eml->header_set($_) for @PublicInbox::Import::UNWANTED_HEADERS;
+        $oidbin eq git_sha(length($oidbin) == 20 ? 1 : 256, $eml)->digest;
+}
+
+sub prune_mdir { # lms->each_src callback
+        my ($oidbin, $id, $self, $mdir) = @_;
+        my @try = $$id =~ /:2,[a-zA-Z]*\z/ ? qw(cur new) : qw(new cur);
+        for my $d (@try) {
+                my $src = "$mdir/$d/$$id";
+                if ($self->{verify}) {
+                        my $eml = eml_from_path($src) // next;
+                        return if eml_match($eml, $oidbin);
+                } elsif (-f $src) {
+                        return;
+                }
+        }
+        # both tries failed
+        $self->{lei}->qerr("# maildir:$mdir $$id gone");
+        $self->{lei}->{sto}->ipc_do('lms_clear_src', "maildir:$mdir", $id);
+}
+
+sub prune_imap { # lms->each_src callback
+        my ($oidbin, $uid, $self, $uids, $url) = @_;
+        return if exists $uids->{$uid};
+        $self->{lei}->qerr("# $url $uid gone");
+        $self->{lei}->{sto}->ipc_do('lms_clear_src', $url, $uid);
+}
+
+# detects missed file moves
+sub pmdir_cb { # called via LeiPmdir->each_mdir_fn
+        my ($self, $f, $fl) = @_;
+        my ($folder, $bn) = ($f =~ m!\A(.+?)/(?:new|cur)/([^/]+)\z!) or
+                die "BUG: $f was not from a Maildir?";
+        substr($folder, 0, 0) = 'maildir:'; # add prefix
+        my $lms = $self->{-lms_ro} //= $self->{lei}->lms;
+        return if defined($lms->name_oidbin($folder, $bn));
+        my $eml = eml_from_path($f) // return;
+        my $oidbin = $self->{lei}->git_oid($eml)->digest;
+        $self->{lei}->{sto}->ipc_do('lms_set_src', $oidbin, $folder, \$bn);
+}
+
+sub input_path_url { # overrides PublicInbox::LeiInput::input_path_url
+        my ($self, $input, @args) = @_;
+        my $lms = $self->{-lms_ro} //= $self->{lei}->lms;
+        if ($input =~ /\Amaildir:(.+)/i) {
+                $lms->each_src($input, \&prune_mdir, $self, my $mdir = $1);
+                $self->{lse} //= $self->{lei}->{sto}->search;
+                # call pmdir_cb (via maildir_each_file -> each_mdir_fn)
+                PublicInbox::LeiInput::input_path_url($self, $input);
+        } elsif ($input =~ m!\Aimaps?://!i) {
+                my $uri = PublicInbox::URIimap->new($input);
+                my $mic = $self->{lei}->{net}->mic_for_folder($uri);
+                my $uids = $mic->search('UID 1:*');
+                $uids = +{ map { $_ => undef } @$uids };
+                $lms->each_src($$uri, \&prune_imap, $self, $uids, $$uri);
+        } else { die "BUG: $input not supported" }
+        $self->{lei}->{pkt_op_p}->pkt_do('sto_done_request');
+}
+
+sub lei_refresh_mail_sync {
+        my ($lei, @folders) = @_;
+        my $sto = $lei->_lei_store or return $lei->fail(<<EOM);
+lei/store uninitialized, see lei-import(1)
+EOM
+        my $lms = $lei->lms or return $lei->fail(<<EOM);
+lei mail_sync.sqlite3 uninitialized, see lei-import(1)
+EOM
+        if (defined(my $all = $lei->{opt}->{all})) {
+                $lms->group2folders($lei, $all, \@folders) or return;
+        } else {
+                my $err = $lms->arg2folder($lei, \@folders);
+                $lei->qerr(@{$err->{qerr}}) if $err->{qerr};
+                return $lei->fail($err->{fail}) if $err->{fail};
+        }
+        undef $lms; # must be done before fork
+        $sto->write_prepare($lei);
+        my $self = bless { missing_ok => 1 }, __PACKAGE__;
+        $lei->{opt}->{'mail-sync'} = 1; # for prepare_inputs
+        $self->prepare_inputs($lei, \@folders) or return;
+        my $j = $lei->{opt}->{jobs} || scalar(@{$self->{inputs}}) || 1;
+        my $ops = {};
+        $lei->{auth}->op_merge($ops, $self) if $lei->{auth};
+        $self->{-wq_nr_workers} = $j // 1; # locked
+        (my $op_c, $ops) = $lei->workers_start($self, $j, $ops);
+        $lei->{wq1} = $self;
+        $lei->{-err_type} = 'non-fatal';
+        net_merge_all_done($self) unless $lei->{auth};
+        $lei->wait_wq_events($op_c, $ops); # net_merge_all_done if !{auth}
+}
+
+no warnings 'once';
+*_complete_refresh_mail_sync = \&PublicInbox::LeiExportKw::_complete_export_kw;
+*ipc_atfork_child = \&PublicInbox::LeiInput::input_only_atfork_child;
+*net_merge_all_done = \&PublicInbox::LeiInput::input_only_net_merge_all_done;
+
+1;