1 # Copyright (C) 2021 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # for maintaining synchronization between lei/store <=> Maildir|MH|IMAP|JMAP
5 package PublicInbox::LeiMailSync;
9 use PublicInbox::ContentHash qw(git_sha);
14 my $f = $self->{filename};
15 my $creat = $rw && !-s $f;
16 my $dbh = DBI->connect("dbi:SQLite:dbname=$f",'','', {
21 sqlite_use_immediate_transaction => 1,
23 # no sqlite_unicode, here, all strings are binary
24 create_tables($dbh) if $rw;
25 $dbh->do('PRAGMA journal_mode = WAL') if $creat;
26 $dbh->do('PRAGMA case_sensitive_like = ON');
32 bless { filename => $f, fmap => {} }, $cls;
35 sub lms_commit { delete($_[0]->{dbh})->commit }
37 sub lms_begin { ($_[0]->{dbh} //= dbh_new($_[0], 1))->begin_work };
43 CREATE TABLE IF NOT EXISTS folders (
44 fid INTEGER PRIMARY KEY,
45 loc VARBINARY NOT NULL, /* URL;UIDVALIDITY=$N or $TYPE:/pathname */
50 CREATE TABLE IF NOT EXISTS blob2num (
51 oidbin VARBINARY NOT NULL,
52 fid INTEGER NOT NULL, /* folder ID */
53 uid INTEGER NOT NULL, /* NNTP article number, IMAP UID, MH number */
54 UNIQUE (oidbin, fid, uid)
57 # speeds up LeiImport->ck_update_kw (for "lei import") by 5-6x:
59 CREATE INDEX IF NOT EXISTS idx_fid_uid ON blob2num(fid,uid)
62 CREATE TABLE IF NOT EXISTS blob2name (
63 oidbin VARBINARY NOT NULL,
64 fid INTEGER NOT NULL, /* folder ID */
65 name VARBINARY NOT NULL, /* Maildir basename, JMAP blobId */
66 UNIQUE (oidbin, fid, name)
69 # speeds up LeiImport->pmdir_cb (for "lei import") by ~6x:
71 CREATE INDEX IF NOT EXISTS idx_fid_name ON blob2name(fid,name)
76 my ($self, $folder, $rw) = @_;
77 my $dbh = $self->{dbh} //= dbh_new($self, $rw);
78 my $sel = 'SELECT fid FROM folders WHERE loc = ? LIMIT 1';
79 my ($fid) = $dbh->selectrow_array($sel, undef, $folder);
80 return $fid if defined $fid;
82 if ($folder =~ s!\A((?:maildir|mh):.*?)/+\z!$1!i) {
83 warn "folder: $folder/ had trailing slash in arg\n";
84 ($fid) = $dbh->selectrow_array($sel, undef, $folder);
86 $dbh->do(<<EOM, undef, $folder, $fid) if $rw;
87 UPDATE folders SET loc = ? WHERE fid = ?
91 # sometimes we stored trailing slash..
92 } elsif ($folder =~ m!\A(?:maildir|mh):!i) {
93 ($fid) = $dbh->selectrow_array($sel, undef, "$folder/");
95 $dbh->do(<<EOM, undef, $folder, $fid) if $rw;
96 UPDATE folders SET loc = ? WHERE fid = ?
100 } elsif ($rw && $folder =~ m!\Aimaps?://!i) {
101 require PublicInbox::URIimap;
102 PublicInbox::URIimap->new($folder)->uidvalidity //
103 Carp::croak("BUG: $folder has no UIDVALIDITY");
107 ($fid) = $dbh->selectrow_array('SELECT MAX(fid) FROM folders');
110 # in case we're reusing, clobber existing stale refs:
111 $dbh->do('DELETE FROM blob2name WHERE fid = ?', undef, $fid);
112 $dbh->do('DELETE FROM blob2num WHERE fid = ?', undef, $fid);
114 my $sth = $dbh->prepare('INSERT INTO folders (fid, loc) VALUES (?, ?)');
115 $sth->execute($fid, $folder);
121 my ($self, $oidhex, $folder, $id) = @_;
122 my $fid = $self->{fmap}->{$folder} //= fid_for($self, $folder, 1);
124 if (ref($id)) { # scalar name
126 $sth = $self->{dbh}->prepare_cached(<<'');
127 INSERT OR IGNORE INTO blob2name (oidbin, fid, name) VALUES (?, ?, ?)
129 } else { # numeric ID (IMAP UID, MH number)
130 $sth = $self->{dbh}->prepare_cached(<<'');
131 INSERT OR IGNORE INTO blob2num (oidbin, fid, uid) VALUES (?, ?, ?)
134 $sth->execute(pack('H*', $oidhex), $fid, $id);
138 my ($self, $folder, $id) = @_;
139 my $fid = $self->{fmap}->{$folder} //= fid_for($self, $folder, 1);
141 if (ref($id)) { # scalar name
143 $sth = $self->{dbh}->prepare_cached(<<'');
144 DELETE FROM blob2name WHERE fid = ? AND name = ?
147 $sth = $self->{dbh}->prepare_cached(<<'');
148 DELETE FROM blob2num WHERE fid = ? AND uid = ?
151 $sth->execute($fid, $id);
156 my ($self, $folder, $oidbin, $id, $newbn) = @_;
157 my $fid = $self->{fmap}->{$folder} //= fid_for($self, $folder, 1);
158 my $sth = $self->{dbh}->prepare_cached(<<'');
159 UPDATE blob2name SET name = ? WHERE fid = ? AND oidbin = ? AND name = ?
161 $sth->execute($newbn, $fid, $oidbin, $$id);
164 # read-only, iterates every oidbin + UID or name for a given folder
166 my ($self, $folder, $cb, @args) = @_;
167 my $dbh = $self->{dbh} //= dbh_new($self);
169 if (ref($folder) eq 'HASH') {
170 $fid = $folder->{fid} // die "BUG: no `fid'";
172 $fid = $self->{fmap}->{$folder} //=
173 fid_for($self, $folder) // return;
175 $sth = $dbh->prepare('SELECT oidbin,uid FROM blob2num WHERE fid = ?');
177 while (my ($oidbin, $id) = $sth->fetchrow_array) {
178 $cb->($oidbin, $id, @args);
180 $sth = $dbh->prepare('SELECT oidbin,name FROM blob2name WHERE fid = ?');
182 while (my ($oidbin, $id) = $sth->fetchrow_array) {
183 $cb->($oidbin, \$id, @args);
188 my ($self, $folder) = @_;
189 my $dbh = $self->{dbh} //= dbh_new($self);
192 $fid = $self->{fmap}->{$folder} //= fid_for($self, $folder) // return;
193 my ($row) = $dbh->selectrow_array(<<"", undef, $fid);
194 SELECT COUNT(name) FROM blob2name WHERE fid = ?
196 $ret->{'name.count'} = $row if $row;
197 for my $op (qw(count min max)) {
198 ($row) = $dbh->selectrow_array(<<"", undef, $fid);
199 SELECT $op(uid) FROM blob2num WHERE fid = ?
202 $ret->{"uid.$op"} = $row;
207 # returns a { location => [ list-of-ids-or-names ] } mapping
209 my ($self, $oidhex) = @_;
210 my ($fid, $sth, $id, %fid2id);
211 my $dbh = $self->{dbh} //= dbh_new($self);
212 $sth = $dbh->prepare('SELECT fid,uid FROM blob2num WHERE oidbin = ?');
213 $sth->execute(pack('H*', $oidhex));
214 while (my ($fid, $uid) = $sth->fetchrow_array) {
215 push @{$fid2id{$fid}}, $uid;
217 $sth = $dbh->prepare('SELECT fid,name FROM blob2name WHERE oidbin = ?');
218 $sth->execute(pack('H*', $oidhex));
219 while (my ($fid, $name) = $sth->fetchrow_array) {
220 push @{$fid2id{$fid}}, $name;
222 $sth = $dbh->prepare('SELECT loc FROM folders WHERE fid = ? LIMIT 1');
224 while (my ($fid, $ids) = each %fid2id) {
226 my ($loc) = $sth->fetchrow_array;
227 unless (defined $loc) {
228 warn "E: fid=$fid for $oidhex unknown:\n", map {
229 'E: '.(ref() ? $$_ : "#$_")."\n";
235 scalar(keys %$ret) ? $ret : undef;
238 # returns a list of folders used for completion
240 my ($self, $pfx) = @_;
241 my $dbh = $self->{dbh} //= dbh_new($self);
242 my $sql = 'SELECT loc FROM folders';
245 $sql .= ' WHERE loc LIKE ? ESCAPE ?';
247 $pfx[0] =~ s/([%_\\])/\\$1/g; # glob chars
250 map { $_->[0] } @{$dbh->selectall_arrayref($sql, undef, @pfx)};
254 my ($self, $oidhex, $vrfy) = @_;
255 my $dbh = $self->{dbh} //= dbh_new($self);
256 my $b2n = $dbh->prepare(<<'');
257 SELECT f.loc,b.name FROM blob2name b
258 LEFT JOIN folders f ON b.fid = f.fid
261 $b2n->execute(pack('H*', $oidhex));
262 while (my ($d, $n) = $b2n->fetchrow_array) {
263 substr($d, 0, length('maildir:')) = '';
264 # n.b. both mbsync and offlineimap use ":2," as a suffix
265 # in "new/", despite (from what I understand of reading
266 # <https://cr.yp.to/proto/maildir.html>), the ":2," only
267 # applies to files in "cur/".
268 my @try = $n =~ /:2,[a-zA-Z]+\z/ ? qw(cur new) : qw(new cur);
271 open my $fh, '<', $f or next;
272 # some (buggy) Maildir writers are non-atomic:
276 if ($vrfy && git_sha(1, \$raw)->hexdigest ne $oidhex) {
277 warn "$f changed $oidhex\n";
287 my ($self, $url, $all) = @_; # $all = [ $lms->folders ];
288 $all //= [ $self->folders ];
289 require PublicInbox::URIimap;
290 my $want = PublicInbox::URIimap->new($url)->canonical;
291 my ($s, $h, $mb) = ($want->scheme, $want->host, $want->mailbox);
292 my @uri = map { PublicInbox::URIimap->new($_)->canonical }
293 grep(m!\A\Q$s\E://.*?\Q$h\E\b.*?/\Q$mb\E\b!, @$all);
296 next if $x->mailbox ne $want->mailbox;
297 next if $x->host ne $want->host;
298 next if $x->port != $want->port;
299 my $x_uidval = $x->uidvalidity;
300 next if ($want->uidvalidity // $x_uidval) != $x_uidval;
302 # allow nothing in want to possibly match ";AUTH=ANONYMOUS"
303 if (defined($x->auth) && !defined($want->auth) &&
304 !defined($want->user)) {
306 # or maybe user was forgotten on CLI:
307 } elsif (defined($x->user) && !defined($want->user)) {
309 } elsif (($x->user//"\0") eq ($want->user//"\0")) {
313 return @match if wantarray;
314 scalar(@match) <= 1 ? $match[0] :
315 "E: `$url' is ambiguous:\n\t".join("\n\t", @match)."\n";
318 # returns undef on failure, number on success
320 my ($self, $lei, $all, $folders) = @_;
321 return $lei->fail(<<EOM) if @$folders;
322 --all= not compatible with @$folders on command-line
324 my %x = map { $_ => $_ } split(/,/, $all);
325 my @ok = grep(defined, delete(@x{qw(local remote), ''}));
328 @no = (join(',', @no));
329 return $lei->fail(<<EOM);
330 --all=@no not accepted (must be `local' and/or `remote')
334 my @all = $self->folders;
336 if ($ok eq 'local') {
337 @inc = grep(!m!\A[a-z0-9\+]+://!i, @all);
338 } elsif ($ok eq 'remote') {
339 @inc = grep(m!\A[a-z0-9\+]+://!i, @all);
340 } elsif ($ok ne '') {
341 return $lei->fail("--all=$all not understood");
346 push(@$folders, $_) unless $seen{$_}++;
349 scalar(@$folders) || $lei->fail(<<EOM);
350 no --mail-sync folders known to lei
354 # map CLI args to folder table entries, returns undef on failure
356 my ($self, $lei, $folders) = @_;
357 my @all = $self->folders;
358 my %all = map { $_ => 1 } @all;
361 next if $all{$_}; # ok
362 if (m!\A(maildir|mh):(.+)!i) {
364 my $d = "$type:".$lei->abs_path($2);
365 push(@no, $_) unless $all{$d};
367 } elsif (-d "$_/new" && -d "$_/cur") {
368 my $d = 'maildir:'.$lei->abs_path($_);
369 push(@no, $_) unless $all{$d};
371 } elsif (m!\Aimaps?://!i) {
373 my $res = match_imap_url($self, $orig, \@all);
376 push(@{$err->{qerr}}, <<EOM);
377 # using `$res' instead of `$orig'
380 $lei->err($res) if defined $res;
388 my $no = join("\n\t", @no);
389 $err->{fail} = <<EOF;
390 No sync information for: $no
391 Run `lei ls-mail-sync' to display valid choices
398 my ($self, $folder) = @_;
400 $fid = delete($self->{fmap}->{$folder}) //
401 fid_for($self, $folder) // return;
402 my $dbh = $self->{dbh};
403 $dbh->do('DELETE FROM blob2name WHERE fid = ?', undef, $fid);
404 $dbh->do('DELETE FROM blob2num WHERE fid = ?', undef, $fid);
405 $dbh->do('DELETE FROM folders WHERE fid = ?', undef, $fid);
408 sub imap_oidbin ($$$) {
409 my ($self, $url, $uid) = @_; # $url MUST have UIDVALIDITY
410 my $fid = $self->{fmap}->{$url} //= fid_for($self, $url) // return;
411 my $sth = $self->{dbh}->prepare_cached(<<EOM, undef, 1);
412 SELECT oidbin FROM blob2num WHERE fid = ? AND uid = ?
414 $sth->execute($fid, $uid);
415 $sth->fetchrow_array;
418 sub name_oidbin ($$$) {
419 my ($self, $mdir, $nm) = @_;
420 my $fid = $self->{fmap}->{$mdir} //= fid_for($self, $mdir) // return;
421 my $sth = $self->{dbh}->prepare_cached(<<EOM, undef, 1);
422 SELECT oidbin FROM blob2name WHERE fid = ? AND name = ?
424 $sth->execute($fid, $nm);
425 $sth->fetchrow_array;
429 my ($self, $lei, $uid_uri) = @_;
430 my $mailbox_uri = $uid_uri->clone;
431 $mailbox_uri->uid(undef);
432 my $folders = [ $$mailbox_uri ];
433 if (my $err = $self->arg2folder($lei, $folders)) {
435 $lei->qerr("# no sync information for $mailbox_uri");
438 $lei->qerr(@{$err->{qerr}}) if $err->{qerr};
440 my $oidbin = imap_oidbin($self, $folders->[0], $uid_uri->uid);
441 $oidbin ? unpack('H*', $oidbin) : undef;
444 # FIXED? something with "lei <up|q>" is causing uncommitted transaction
448 my $dbh = delete($self->{dbh}) or return;
449 return if $dbh->{ReadOnly};
451 warn "BUG $$ $0 $self {dbh} OPEN ppid=".getppid.' '.Carp::longmess();