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);
13 my $f = $self->{filename};
14 my $creat = $rw && !-s $f;
15 my $dbh = DBI->connect("dbi:SQLite:dbname=$f",'','', {
20 sqlite_use_immediate_transaction => 1,
22 # no sqlite_unicode, here, all strings are binary
23 create_tables($dbh) if $rw;
24 $dbh->do('PRAGMA journal_mode = WAL') if $creat;
25 $dbh->do('PRAGMA case_sensitive_like = ON');
31 bless { filename => $f, fmap => {} }, $cls;
34 sub lms_commit { delete($_[0]->{dbh})->commit }
36 sub lms_begin { ($_[0]->{dbh} //= dbh_new($_[0], 1))->begin_work };
42 CREATE TABLE IF NOT EXISTS folders (
43 fid INTEGER PRIMARY KEY,
44 loc VARBINARY NOT NULL, /* URL;UIDVALIDITY=$N or $TYPE:/pathname */
49 CREATE TABLE IF NOT EXISTS blob2num (
50 oidbin VARBINARY NOT NULL,
51 fid INTEGER NOT NULL, /* folder ID */
52 uid INTEGER NOT NULL, /* NNTP article number, IMAP UID, MH number */
53 UNIQUE (oidbin, fid, uid)
57 CREATE TABLE IF NOT EXISTS blob2name (
58 oidbin VARBINARY NOT NULL,
59 fid INTEGER NOT NULL, /* folder ID */
60 name VARBINARY NOT NULL, /* Maildir basename, JMAP blobId */
61 UNIQUE (oidbin, fid, name)
67 my ($self, $folder, $rw) = @_;
68 my $dbh = $self->{dbh};
69 my $sel = 'SELECT fid FROM folders WHERE loc = ? LIMIT 1';
70 my ($fid) = $dbh->selectrow_array($sel, undef, $folder);
71 return $fid if defined $fid;
73 if ($folder =~ s!\A((?:maildir|mh):.*?)/+\z!$1!i) {
74 warn "folder: $folder/ had trailing slash in arg\n";
75 ($fid) = $dbh->selectrow_array($sel, undef, $folder);
77 $dbh->do(<<EOM, undef, $folder, $fid) if $rw;
78 UPDATE folders SET loc = ? WHERE fid = ?
82 # sometimes we stored trailing slash..
83 } elsif ($folder =~ m!\A(?:maildir|mh):!i) {
84 ($fid) = $dbh->selectrow_array($sel, undef, "$folder/");
86 $dbh->do(<<EOM, undef, $folder, $fid) if $rw;
87 UPDATE folders SET loc = ? WHERE fid = ?
94 ($fid) = $dbh->selectrow_array('SELECT MAX(fid) FROM folders');
97 # in case we're reusing, clobber existing stale refs:
98 $dbh->do('DELETE FROM blob2name WHERE fid = ?', undef, $fid);
99 $dbh->do('DELETE FROM blob2num WHERE fid = ?', undef, $fid);
101 my $sth = $dbh->prepare('INSERT INTO folders (fid, loc) VALUES (?, ?)');
102 $sth->execute($fid, $folder);
108 my ($self, $oidhex, $folder, $id) = @_;
109 my $fid = $self->{fmap}->{$folder} //= _fid_for($self, $folder, 1);
111 if (ref($id)) { # scalar name
113 $sth = $self->{dbh}->prepare_cached(<<'');
114 INSERT OR IGNORE INTO blob2name (oidbin, fid, name) VALUES (?, ?, ?)
116 } else { # numeric ID (IMAP UID, MH number)
117 $sth = $self->{dbh}->prepare_cached(<<'');
118 INSERT OR IGNORE INTO blob2num (oidbin, fid, uid) VALUES (?, ?, ?)
121 $sth->execute(pack('H*', $oidhex), $fid, $id);
125 my ($self, $folder, $id) = @_;
126 my $fid = $self->{fmap}->{$folder} //= _fid_for($self, $folder, 1);
128 if (ref($id)) { # scalar name
130 $sth = $self->{dbh}->prepare_cached(<<'');
131 DELETE FROM blob2name WHERE fid = ? AND name = ?
134 $sth = $self->{dbh}->prepare_cached(<<'');
135 DELETE FROM blob2num WHERE fid = ? AND uid = ?
138 $sth->execute($fid, $id);
143 my ($self, $folder, $oidbin, $id, $newbn) = @_;
144 my $fid = $self->{fmap}->{$folder} //= _fid_for($self, $folder, 1);
145 my $sth = $self->{dbh}->prepare_cached(<<'');
146 UPDATE blob2name SET name = ? WHERE fid = ? AND oidbin = ? AND name = ?
148 $sth->execute($newbn, $fid, $oidbin, $$id);
151 # read-only, iterates every oidbin + UID or name for a given folder
153 my ($self, $folder, $cb, @args) = @_;
154 my $dbh = $self->{dbh} //= dbh_new($self);
156 $fid = $self->{fmap}->{$folder} //= _fid_for($self, $folder) // return;
157 $sth = $dbh->prepare('SELECT oidbin,uid FROM blob2num WHERE fid = ?');
159 while (my ($oidbin, $id) = $sth->fetchrow_array) {
160 $cb->($oidbin, $id, @args);
162 $sth = $dbh->prepare('SELECT oidbin,name FROM blob2name WHERE fid = ?');
164 while (my ($oidbin, $id) = $sth->fetchrow_array) {
165 $cb->($oidbin, \$id, @args);
170 my ($self, $folder) = @_;
171 my $dbh = $self->{dbh} //= dbh_new($self);
174 $fid = $self->{fmap}->{$folder} //= _fid_for($self, $folder) // return;
175 my ($row) = $dbh->selectrow_array(<<"", undef, $fid);
176 SELECT COUNT(name) FROM blob2name WHERE fid = ?
178 $ret->{'name.count'} = $row if $row;
179 for my $op (qw(count min max)) {
180 ($row) = $dbh->selectrow_array(<<"", undef, $fid);
181 SELECT $op(uid) FROM blob2num WHERE fid = ?
184 $ret->{"uid.$op"} = $row;
189 # returns a { location => [ list-of-ids-or-names ] } mapping
191 my ($self, $oidhex) = @_;
192 my ($fid, $sth, $id, %fid2id);
193 my $dbh = $self->{dbh} //= dbh_new($self);
194 $sth = $dbh->prepare('SELECT fid,uid FROM blob2num WHERE oidbin = ?');
195 $sth->execute(pack('H*', $oidhex));
196 while (my ($fid, $uid) = $sth->fetchrow_array) {
197 push @{$fid2id{$fid}}, $uid;
199 $sth = $dbh->prepare('SELECT fid,name FROM blob2name WHERE oidbin = ?');
200 $sth->execute(pack('H*', $oidhex));
201 while (my ($fid, $name) = $sth->fetchrow_array) {
202 push @{$fid2id{$fid}}, $name;
204 $sth = $dbh->prepare('SELECT loc FROM folders WHERE fid = ? LIMIT 1');
206 while (my ($fid, $ids) = each %fid2id) {
208 my ($loc) = $sth->fetchrow_array;
209 unless (defined $loc) {
210 warn "E: fid=$fid for $oidhex unknown:\n", map {
211 'E: '.(ref() ? $$_ : "#$_")."\n";
217 scalar(keys %$ret) ? $ret : undef;
220 # returns a list of folders used for completion
222 my ($self, $pfx) = @_;
223 my $dbh = $self->{dbh} //= dbh_new($self);
224 my $sql = 'SELECT loc FROM folders';
227 $sql .= ' WHERE loc LIKE ? ESCAPE ?';
229 $pfx[0] =~ s/([%_\\])/\\$1/g; # glob chars
232 map { $_->[0] } @{$dbh->selectall_arrayref($sql, undef, @pfx)};
236 my ($self, $oidhex, $vrfy) = @_;
237 my $dbh = $self->{dbh} //= dbh_new($self);
238 my $b2n = $dbh->prepare(<<'');
239 SELECT f.loc,b.name FROM blob2name b
240 LEFT JOIN folders f ON b.fid = f.fid
243 $b2n->execute(pack('H*', $oidhex));
244 while (my ($d, $n) = $b2n->fetchrow_array) {
245 substr($d, 0, length('maildir:')) = '';
246 # n.b. both mbsync and offlineimap use ":2," as a suffix
247 # in "new/", despite (from what I understand of reading
248 # <https://cr.yp.to/proto/maildir.html>), the ":2," only
249 # applies to files in "cur/".
250 my @try = $n =~ /:2,[a-zA-Z]+\z/ ? qw(cur new) : qw(new cur);
253 open my $fh, '<', $f or next;
254 # some (buggy) Maildir writers are non-atomic:
258 if ($vrfy && git_sha(1, \$raw)->hexdigest ne $oidhex) {
259 warn "$f changed $oidhex\n";