]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/LeiMailSync.pm
lei_mail_sync: rely on flock(2), avoid IPC
[public-inbox.git] / lib / PublicInbox / LeiMailSync.pm
index 558988f3d3fe922121c286384ffab2f84f0aa590..690c6477efa9c3be76242392d39fcdad90d1378e 100644 (file)
@@ -5,6 +5,7 @@
 package PublicInbox::LeiMailSync;
 use strict;
 use v5.10.1;
+use parent qw(PublicInbox::Lock);
 use DBI;
 use PublicInbox::ContentHash qw(git_sha);
 use Carp ();
@@ -21,7 +22,7 @@ sub dbh_new {
                sqlite_use_immediate_transaction => 1,
        });
        # no sqlite_unicode, here, all strings are binary
-       create_tables($dbh) if $rw;
+       create_tables($self, $dbh) if $rw;
        $dbh->do('PRAGMA journal_mode = WAL') if $creat;
        $dbh->do('PRAGMA case_sensitive_like = ON');
        $dbh;
@@ -29,15 +30,24 @@ sub dbh_new {
 
 sub new {
        my ($cls, $f) = @_;
-       bless { filename => $f, fmap => {} }, $cls;
+       bless {
+               filename => $f,
+               fmap => {},
+               lock_path => "$f.flock",
+       }, $cls;
 }
 
-sub lms_commit { delete($_[0]->{dbh})->commit }
+sub lms_write_prepare { ($_[0]->{dbh} //= dbh_new($_[0], 1)); $_[0] }
 
-sub lms_begin { ($_[0]->{dbh} //= dbh_new($_[0], 1))->begin_work };
+sub lms_pause {
+       my ($self) = @_;
+       $self->{fmap} = {};
+       delete $self->{dbh};
+}
 
 sub create_tables {
-       my ($dbh) = @_;
+       my ($self, $dbh) = @_;
+       my $lk = $self->lock_for_scope;
 
        $dbh->do(<<'');
 CREATE TABLE IF NOT EXISTS folders (
@@ -79,8 +89,8 @@ sub fid_for {
        my ($fid) = $dbh->selectrow_array($sel, undef, $folder);
        return $fid if defined $fid;
 
+       # caller had trailing slash (LeiToMail)
        if ($folder =~ s!\A((?:maildir|mh):.*?)/+\z!$1!i) {
-               warn "folder: $folder/ had trailing slash in arg\n";
                ($fid) = $dbh->selectrow_array($sel, undef, $folder);
                if (defined $fid) {
                        $dbh->do(<<EOM, undef, $folder, $fid) if $rw;
@@ -117,8 +127,15 @@ EOM
        $fid;
 }
 
+sub add_folders {
+       my ($self, @folders) = @_;
+       my $lk = $self->lock_for_scope;
+       for my $f (@folders) { $self->{fmap}->{$f} //= fid_for($self, $f, 1) }
+}
+
 sub set_src {
-       my ($self, $oidhex, $folder, $id) = @_;
+       my ($self, $oidbin, $folder, $id) = @_;
+       my $lk = $self->lock_for_scope;
        my $fid = $self->{fmap}->{$folder} //= fid_for($self, $folder, 1);
        my $sth;
        if (ref($id)) { # scalar name
@@ -131,11 +148,12 @@ INSERT OR IGNORE INTO blob2name (oidbin, fid, name) VALUES (?, ?, ?)
 INSERT OR IGNORE INTO blob2num (oidbin, fid, uid) VALUES (?, ?, ?)
 
        }
-       $sth->execute(pack('H*', $oidhex), $fid, $id);
+       $sth->execute($oidbin, $fid, $id);
 }
 
 sub clear_src {
        my ($self, $folder, $id) = @_;
+       my $lk = $self->lock_for_scope;
        my $fid = $self->{fmap}->{$folder} //= fid_for($self, $folder, 1);
        my $sth;
        if (ref($id)) { # scalar name
@@ -154,33 +172,63 @@ DELETE FROM blob2num WHERE fid = ? AND uid = ?
 # Maildir-only
 sub mv_src {
        my ($self, $folder, $oidbin, $id, $newbn) = @_;
+       my $lk = $self->lock_for_scope;
        my $fid = $self->{fmap}->{$folder} //= fid_for($self, $folder, 1);
        my $sth = $self->{dbh}->prepare_cached(<<'');
 UPDATE blob2name SET name = ? WHERE fid = ? AND oidbin = ? AND name = ?
 
-       $sth->execute($newbn, $fid, $oidbin, $$id);
+       my $nr = $sth->execute($newbn, $fid, $oidbin, $$id);
+       if ($nr == 0) { # may race with a clear_src, ensure new value exists
+               $sth = $self->{dbh}->prepare_cached(<<'');
+INSERT OR IGNORE INTO blob2name (oidbin, fid, name) VALUES (?, ?, ?)
+
+               $sth->execute($oidbin, $fid, $newbn);
+       }
 }
 
 # read-only, iterates every oidbin + UID or name for a given folder
 sub each_src {
        my ($self, $folder, $cb, @args) = @_;
        my $dbh = $self->{dbh} //= dbh_new($self);
-       my ($fid, $sth);
+       my $fid;
        if (ref($folder) eq 'HASH') {
                $fid = $folder->{fid} // die "BUG: no `fid'";
        } else {
                $fid = $self->{fmap}->{$folder} //=
                        fid_for($self, $folder) // return;
        }
-       $sth = $dbh->prepare('SELECT oidbin,uid FROM blob2num WHERE fid = ?');
-       $sth->execute($fid);
-       while (my ($oidbin, $id) = $sth->fetchrow_array) {
-               $cb->($oidbin, $id, @args);
+
+       # minimize implicit txn time to avoid blocking writers by
+       # batching SELECTs.  This looks wonky but is necessary since
+       # $cb-> may access the DB on its own.
+       my $ary = $dbh->selectall_arrayref(<<'', undef, $fid);
+SELECT _rowid_,oidbin,uid FROM blob2num WHERE fid = ?
+ORDER BY _rowid_ ASC LIMIT 1000
+
+       my $min = @$ary ? $ary->[-1]->[0] : undef;
+       while (defined $min) {
+               for my $row (@$ary) { $cb->($row->[1], $row->[2], @args) }
+
+               $ary = $dbh->selectall_arrayref(<<'', undef, $fid, $min);
+SELECT _rowid_,oidbin,uid FROM blob2num WHERE fid = ? AND _rowid_ > ?
+ORDER BY _rowid_ ASC LIMIT 1000
+
+               $min = @$ary ? $ary->[-1]->[0] : undef;
        }
-       $sth = $dbh->prepare('SELECT oidbin,name FROM blob2name WHERE fid = ?');
-       $sth->execute($fid);
-       while (my ($oidbin, $id) = $sth->fetchrow_array) {
-               $cb->($oidbin, \$id, @args);
+
+       $ary = $dbh->selectall_arrayref(<<'', undef, $fid);
+SELECT _rowid_,oidbin,name FROM blob2name WHERE fid = ?
+ORDER BY _rowid_ ASC LIMIT 1000
+
+       $min = @$ary ? $ary->[-1]->[0] : undef;
+       while (defined $min) {
+               for my $row (@$ary) { $cb->($row->[1], \($row->[2]), @args) }
+
+               $ary = $dbh->selectall_arrayref(<<'', undef, $fid, $min);
+SELECT _rowid_,oidbin,name FROM blob2name WHERE fid = ? AND _rowid_ > ?
+ORDER BY _rowid_ ASC LIMIT 1000
+
+               $min = @$ary ? $ary->[-1]->[0] : undef;
        }
 }
 
@@ -206,16 +254,16 @@ SELECT $op(uid) FROM blob2num WHERE fid = ?
 
 # returns a { location => [ list-of-ids-or-names ] } mapping
 sub locations_for {
-       my ($self, $oidhex) = @_;
+       my ($self, $oidbin) = @_;
        my ($fid, $sth, $id, %fid2id);
        my $dbh = $self->{dbh} //= dbh_new($self);
        $sth = $dbh->prepare('SELECT fid,uid FROM blob2num WHERE oidbin = ?');
-       $sth->execute(pack('H*', $oidhex));
+       $sth->execute($oidbin);
        while (my ($fid, $uid) = $sth->fetchrow_array) {
                push @{$fid2id{$fid}}, $uid;
        }
        $sth = $dbh->prepare('SELECT fid,name FROM blob2name WHERE oidbin = ?');
-       $sth->execute(pack('H*', $oidhex));
+       $sth->execute($oidbin);
        while (my ($fid, $name) = $sth->fetchrow_array) {
                push @{$fid2id{$fid}}, $name;
        }
@@ -225,6 +273,7 @@ sub locations_for {
                $sth->execute($fid);
                my ($loc) = $sth->fetchrow_array;
                unless (defined $loc) {
+                       my $oidhex = unpack('H*', $oidbin);
                        warn "E: fid=$fid for $oidhex unknown:\n", map {
                                        'E: '.(ref() ? $$_ : "#$_")."\n";
                                } @$ids;
@@ -315,6 +364,41 @@ sub match_imap_url {
                        "E: `$url' is ambiguous:\n\t".join("\n\t", @match)."\n";
 }
 
+# returns undef on failure, number on success
+sub group2folders {
+       my ($self, $lei, $all, $folders) = @_;
+       return $lei->fail(<<EOM) if @$folders;
+--all= not compatible with @$folders on command-line
+EOM
+       my %x = map { $_ => $_ } split(/,/, $all);
+       my @ok = grep(defined, delete(@x{qw(local remote), ''}));
+       push(@ok, '') if $all eq '';
+       my @no = keys %x;
+       if (@no) {
+               @no = (join(',', @no));
+               return $lei->fail(<<EOM);
+--all=@no not accepted (must be `local' and/or `remote')
+EOM
+       }
+       my (%seen, @inc);
+       my @all = $self->folders;
+       for my $ok (@ok) {
+               if ($ok eq 'local') {
+                       @inc = grep(!m!\A[a-z0-9\+]+://!i, @all);
+               } elsif ($ok eq 'remote') {
+                       @inc = grep(m!\A[a-z0-9\+]+://!i, @all);
+               } elsif ($ok ne '') {
+                       return $lei->fail("--all=$all not understood");
+               } else {
+                       @inc = @all;
+               }
+               push(@$folders, (grep { !$seen{$_}++ } @inc));
+       }
+       scalar(@$folders) || $lei->fail(<<EOM);
+no --mail-sync folders known to lei
+EOM
+}
+
 # map CLI args to folder table entries, returns undef on failure
 sub arg2folder {
        my ($self, $lei, $folders) = @_;
@@ -358,15 +442,41 @@ EOF
        $err;
 }
 
-sub forget_folder {
-       my ($self, $folder) = @_;
-       my ($fid, $sth);
-       $fid = delete($self->{fmap}->{$folder}) //
-               fid_for($self, $folder) // return;
-       my $dbh = $self->{dbh};
-       $dbh->do('DELETE FROM blob2name WHERE fid = ?', undef, $fid);
-       $dbh->do('DELETE FROM blob2num WHERE fid = ?', undef, $fid);
-       $dbh->do('DELETE FROM folders WHERE fid = ?', undef, $fid);
+sub forget_folders {
+       my ($self, @folders) = @_;
+       my $lk = $self->lock_for_scope;
+       for my $folder (@folders) {
+               my $fid = delete($self->{fmap}->{$folder}) //
+                       fid_for($self, $folder) // next;
+               for my $t (qw(blob2name blob2num folders)) {
+                       $self->{dbh}->do("DELETE FROM $t WHERE fid = ?",
+                                       undef, $fid);
+               }
+       }
+}
+
+# only used for changing canonicalization errors
+sub rename_folder {
+       my ($self, $old, $new) = @_;
+       my $lk = $self->lock_for_scope;
+       my $ofid = delete($self->{fmap}->{$old}) //
+               fid_for($self, $old) // return;
+       eval {
+               $self->{dbh}->do(<<EOM, undef, $new, $ofid);
+UPDATE folders SET loc = ? WHERE fid = ?
+EOM
+       };
+       if ($@ =~ /\bunique\b/i) {
+               my $nfid = $self->{fmap}->{$new} // fid_for($self, $new);
+               for my $t (qw(blob2name blob2num)) {
+                       $self->{dbh}->do(<<EOM, undef, $nfid, $ofid);
+UPDATE OR REPLACE $t SET fid = ? WHERE fid = ?
+EOM
+               }
+               $self->{dbh}->do(<<EOM, undef, $ofid);
+DELETE FROM folders WHERE fid = ?
+EOM
+       }
 }
 
 sub imap_oidbin ($$$) {
@@ -405,14 +515,4 @@ sub imap_oid {
        $oidbin ? unpack('H*', $oidbin) : undef;
 }
 
-# FIXED? something with "lei <up|q>" is causing uncommitted transaction
-# TODO: remove soon
-sub DESTROY {
-       my ($self) = @_;
-       my $dbh = delete($self->{dbh}) or return;
-       return if $dbh->{ReadOnly};
-       undef $dbh;
-       warn "BUG $$ $0 $self {dbh} OPEN ppid=".getppid.' '.Carp::longmess();
-}
-
 1;