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)
58 CREATE TABLE IF NOT EXISTS blob2name (
59 oidbin VARBINARY NOT NULL,
60 fid INTEGER NOT NULL, /* folder ID */
61 name VARBINARY NOT NULL, /* Maildir basename, JMAP blobId */
62 UNIQUE (oidbin, fid, name)
68 my ($self, $folder, $rw) = @_;
69 my $dbh = $self->{dbh};
70 my $sel = 'SELECT fid FROM folders WHERE loc = ? LIMIT 1';
71 my ($fid) = $dbh->selectrow_array($sel, undef, $folder);
72 return $fid if defined $fid;
74 if ($folder =~ s!\A((?:maildir|mh):.*?)/+\z!$1!i) {
75 warn "folder: $folder/ had trailing slash in arg\n";
76 ($fid) = $dbh->selectrow_array($sel, undef, $folder);
78 $dbh->do(<<EOM, undef, $folder, $fid) if $rw;
79 UPDATE folders SET loc = ? WHERE fid = ?
83 # sometimes we stored trailing slash..
84 } elsif ($folder =~ m!\A(?:maildir|mh):!i) {
85 ($fid) = $dbh->selectrow_array($sel, undef, "$folder/");
87 $dbh->do(<<EOM, undef, $folder, $fid) if $rw;
88 UPDATE folders SET loc = ? WHERE fid = ?
92 } elsif ($rw && $folder =~ m!\Aimaps?://!i) {
93 require PublicInbox::URIimap;
94 PublicInbox::URIimap->new($folder)->uidvalidity //
95 Carp::croak("BUG: $folder has no UIDVALIDITY");
99 ($fid) = $dbh->selectrow_array('SELECT MAX(fid) FROM folders');
102 # in case we're reusing, clobber existing stale refs:
103 $dbh->do('DELETE FROM blob2name WHERE fid = ?', undef, $fid);
104 $dbh->do('DELETE FROM blob2num WHERE fid = ?', undef, $fid);
106 my $sth = $dbh->prepare('INSERT INTO folders (fid, loc) VALUES (?, ?)');
107 $sth->execute($fid, $folder);
113 my ($self, $oidhex, $folder, $id) = @_;
114 my $fid = $self->{fmap}->{$folder} //= _fid_for($self, $folder, 1);
116 if (ref($id)) { # scalar name
118 $sth = $self->{dbh}->prepare_cached(<<'');
119 INSERT OR IGNORE INTO blob2name (oidbin, fid, name) VALUES (?, ?, ?)
121 } else { # numeric ID (IMAP UID, MH number)
122 $sth = $self->{dbh}->prepare_cached(<<'');
123 INSERT OR IGNORE INTO blob2num (oidbin, fid, uid) VALUES (?, ?, ?)
126 $sth->execute(pack('H*', $oidhex), $fid, $id);
130 my ($self, $folder, $id) = @_;
131 my $fid = $self->{fmap}->{$folder} //= _fid_for($self, $folder, 1);
133 if (ref($id)) { # scalar name
135 $sth = $self->{dbh}->prepare_cached(<<'');
136 DELETE FROM blob2name WHERE fid = ? AND name = ?
139 $sth = $self->{dbh}->prepare_cached(<<'');
140 DELETE FROM blob2num WHERE fid = ? AND uid = ?
143 $sth->execute($fid, $id);
148 my ($self, $folder, $oidbin, $id, $newbn) = @_;
149 my $fid = $self->{fmap}->{$folder} //= _fid_for($self, $folder, 1);
150 my $sth = $self->{dbh}->prepare_cached(<<'');
151 UPDATE blob2name SET name = ? WHERE fid = ? AND oidbin = ? AND name = ?
153 $sth->execute($newbn, $fid, $oidbin, $$id);
156 # read-only, iterates every oidbin + UID or name for a given folder
158 my ($self, $folder, $cb, @args) = @_;
159 my $dbh = $self->{dbh} //= dbh_new($self);
161 $fid = $self->{fmap}->{$folder} //= _fid_for($self, $folder) // return;
162 $sth = $dbh->prepare('SELECT oidbin,uid FROM blob2num WHERE fid = ?');
164 while (my ($oidbin, $id) = $sth->fetchrow_array) {
165 $cb->($oidbin, $id, @args);
167 $sth = $dbh->prepare('SELECT oidbin,name FROM blob2name WHERE fid = ?');
169 while (my ($oidbin, $id) = $sth->fetchrow_array) {
170 $cb->($oidbin, \$id, @args);
175 my ($self, $folder) = @_;
176 my $dbh = $self->{dbh} //= dbh_new($self);
179 $fid = $self->{fmap}->{$folder} //= _fid_for($self, $folder) // return;
180 my ($row) = $dbh->selectrow_array(<<"", undef, $fid);
181 SELECT COUNT(name) FROM blob2name WHERE fid = ?
183 $ret->{'name.count'} = $row if $row;
184 for my $op (qw(count min max)) {
185 ($row) = $dbh->selectrow_array(<<"", undef, $fid);
186 SELECT $op(uid) FROM blob2num WHERE fid = ?
189 $ret->{"uid.$op"} = $row;
194 # returns a { location => [ list-of-ids-or-names ] } mapping
196 my ($self, $oidhex) = @_;
197 my ($fid, $sth, $id, %fid2id);
198 my $dbh = $self->{dbh} //= dbh_new($self);
199 $sth = $dbh->prepare('SELECT fid,uid FROM blob2num WHERE oidbin = ?');
200 $sth->execute(pack('H*', $oidhex));
201 while (my ($fid, $uid) = $sth->fetchrow_array) {
202 push @{$fid2id{$fid}}, $uid;
204 $sth = $dbh->prepare('SELECT fid,name FROM blob2name WHERE oidbin = ?');
205 $sth->execute(pack('H*', $oidhex));
206 while (my ($fid, $name) = $sth->fetchrow_array) {
207 push @{$fid2id{$fid}}, $name;
209 $sth = $dbh->prepare('SELECT loc FROM folders WHERE fid = ? LIMIT 1');
211 while (my ($fid, $ids) = each %fid2id) {
213 my ($loc) = $sth->fetchrow_array;
214 unless (defined $loc) {
215 warn "E: fid=$fid for $oidhex unknown:\n", map {
216 'E: '.(ref() ? $$_ : "#$_")."\n";
222 scalar(keys %$ret) ? $ret : undef;
225 # returns a list of folders used for completion
227 my ($self, $pfx) = @_;
228 my $dbh = $self->{dbh} //= dbh_new($self);
229 my $sql = 'SELECT loc FROM folders';
232 $sql .= ' WHERE loc LIKE ? ESCAPE ?';
234 $pfx[0] =~ s/([%_\\])/\\$1/g; # glob chars
237 map { $_->[0] } @{$dbh->selectall_arrayref($sql, undef, @pfx)};
241 my ($self, $oidhex, $vrfy) = @_;
242 my $dbh = $self->{dbh} //= dbh_new($self);
243 my $b2n = $dbh->prepare(<<'');
244 SELECT f.loc,b.name FROM blob2name b
245 LEFT JOIN folders f ON b.fid = f.fid
248 $b2n->execute(pack('H*', $oidhex));
249 while (my ($d, $n) = $b2n->fetchrow_array) {
250 substr($d, 0, length('maildir:')) = '';
251 # n.b. both mbsync and offlineimap use ":2," as a suffix
252 # in "new/", despite (from what I understand of reading
253 # <https://cr.yp.to/proto/maildir.html>), the ":2," only
254 # applies to files in "cur/".
255 my @try = $n =~ /:2,[a-zA-Z]+\z/ ? qw(cur new) : qw(new cur);
258 open my $fh, '<', $f or next;
259 # some (buggy) Maildir writers are non-atomic:
263 if ($vrfy && git_sha(1, \$raw)->hexdigest ne $oidhex) {
264 warn "$f changed $oidhex\n";
274 my ($self, $url, $all) = @_; # $all = [ $lms->folders ];
275 $all //= [ $self->folders ];
276 require PublicInbox::URIimap;
277 my $want = PublicInbox::URIimap->new($url)->canonical;
278 my ($s, $h, $mb) = ($want->scheme, $want->host, $want->mailbox);
279 my @uri = map { PublicInbox::URIimap->new($_)->canonical }
280 grep(m!\A\Q$s\E://.*?\Q$h\E\b.*?/\Q$mb\E\b!, @$all);
283 next if $x->mailbox ne $want->mailbox;
284 next if $x->host ne $want->host;
285 next if $x->port != $want->port;
286 my $x_uidval = $x->uidvalidity;
287 next if ($want->uidvalidity // $x_uidval) != $x_uidval;
289 # allow nothing in want to possibly match ";AUTH=ANONYMOUS"
290 if (defined($x->auth) && !defined($want->auth) &&
291 !defined($want->user)) {
293 # or maybe user was forgotten on CLI:
294 } elsif (defined($x->user) && !defined($want->user)) {
296 } elsif (($x->user//"\0") eq ($want->user//"\0")) {
300 return @match if wantarray;
301 scalar(@match) <= 1 ? $match[0] :
302 "E: `$url' is ambiguous:\n\t".join("\n\t", @match)."\n";
305 # map CLI args to folder table entries, returns undef on failure
307 my ($self, $lei, $folders) = @_;
308 my @all = $self->folders;
309 my %all = map { $_ => 1 } @all;
312 next if $all{$_}; # ok
313 if (m!\A(maildir|mh):(.+)!i) {
315 my $d = "$type:".$lei->abs_path($2);
316 push(@no, $_) unless $all{$d};
318 } elsif (-d "$_/new" && -d "$_/cur") {
319 my $d = 'maildir:'.$lei->abs_path($_);
320 push(@no, $_) unless $all{$d};
322 } elsif (m!\Aimaps?://!i) {
324 my $res = match_imap_url($self, $orig, \@all);
327 push(@{$err->{qerr}}, <<EOM);
328 # using `$res' instead of `$orig'
331 $lei->err($res) if defined $res;
339 my $no = join("\n\t", @no);
340 $err->{fail} = <<EOF;
341 No sync information for: $no
342 Run `lei ls-mail-sync' to display valid choices
349 my ($self, $folder) = @_;
351 $fid = delete($self->{fmap}->{$folder}) //
352 _fid_for($self, $folder) // return;
353 my $dbh = $self->{dbh};
354 $dbh->do('DELETE FROM blob2name WHERE fid = ?', undef, $fid);
355 $dbh->do('DELETE FROM blob2num WHERE fid = ?', undef, $fid);
356 $dbh->do('DELETE FROM folders WHERE fid = ?', undef, $fid);
360 my ($self, $lei, $uid_uri) = @_;
361 my $mailbox_uri = $uid_uri->clone;
362 $mailbox_uri->uid(undef);
363 my $folders = [ $$mailbox_uri ];
364 if (my $err = $self->arg2folder($lei, $folders)) {
366 $lei->qerr("# no sync information for $mailbox_uri");
369 $lei->qerr(@{$err->{qerr}}) if $err->{qerr};
371 my $fid = $self->{fmap}->{$folders->[0]} //=
372 _fid_for($self, $folders->[0]) // return;
373 my $sth = $self->{dbh}->prepare_cached(<<EOM, undef, 1);
374 SELECT oidbin FROM blob2num WHERE fid = ? AND uid = ?
376 $sth->execute($fid, $uid_uri->uid);
377 my ($oidbin) = $sth->fetchrow_array;
378 $oidbin ? unpack('H*', $oidbin) : undef;
381 # FIXME: something with "lei <up|q>" is causing uncommitted transaction
382 # warnings, not sure what...
385 my $dbh = $self->{dbh} or return;
386 return if $dbh->{ReadOnly};
388 warn "BUG $$ $0 $self {dbh} UNCOMMITTED ", Carp::longmess();