1 # Copyright (C) 2015-2020 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # bidirectional Message-ID <-> Article Number mapping for the NNTP
5 # and web interfaces. This is required for implementing stable article
6 # numbers for NNTP and allows prefix lookups for partial Message-IDs
7 # in case URLs get truncated from copy-n-paste errors by users.
9 # This is maintained by ::SearchIdx (v1) and ::V2Writable (v2)
10 package PublicInbox::Msgmap;
15 use PublicInbox::Over;
16 use PublicInbox::Spawn;
19 my ($class, $git_dir, $writable) = @_;
20 my $d = "$git_dir/public-inbox";
21 if ($writable && !-d $d && !mkdir $d) {
23 -d $d or die "$d not created: $err";
25 new_file($class, "$d/msgmap.sqlite3", $writable);
29 my ($class, $f, $rw) = @_;
30 return if !$rw && !-r $f;
32 my $self = bless { filename => $f }, $class;
33 my $dbh = $self->{dbh} = PublicInbox::Over::dbh_new($self, $rw);
37 $self->created_at(time) unless $self->created_at;
39 $self->num_highwater(max($self));
45 # used to keep track of used numeric mappings for v2 reindex
47 my ($self, $dir) = @_;
49 my $tmp = "mm_tmp-$$-XXXXXX";
50 my ($fh, $fn) = File::Temp::tempfile($tmp, EXLOCK => 0, DIR => $dir);
51 PublicInbox::Spawn::nodatacow_fd(fileno($fh));
52 $self->{dbh}->sqlite_backup_to_file($fn);
53 $tmp = ref($self)->new_file($fn, 2);
54 $tmp->{dbh}->do('PRAGMA journal_mode = MEMORY');
59 # n.b. invoked directly by scripts/xhdr-num2mid
61 my ($self, $key, $value) = @_;
63 my $sql = 'SELECT val FROM meta WHERE key = ? LIMIT 1';
64 my $dbh = $self->{dbh};
66 defined $value or return $dbh->selectrow_array($sql, undef, $key);
68 $prev = $dbh->selectrow_array($sql, undef, $key);
71 $sql = 'UPDATE meta SET val = ? WHERE key = ?';
72 $dbh->do($sql, undef, $value, $key);
74 $sql = 'INSERT INTO meta (key,val) VALUES (?,?)';
75 $dbh->do($sql, undef, $key, $value);
81 my ($self, $commit) = @_;
82 $self->meta_accessor('last_commit', $commit);
85 # v2 uses this to keep track of how up-to-date Xapian is
86 # old versions may be automatically GC'ed away in the future,
87 # but it's a trivial amount of storage.
89 my ($self, $version, $i, $commit) = @_;
90 $self->meta_accessor("last_xap$version-$i", $commit);
93 # this is the UIDVALIDITY for IMAP (cf. RFC 3501 sec 2.3.1.1. item 3)
95 my ($self, $second) = @_;
96 $self->meta_accessor('created_at', $second);
100 my ($self, $num) = @_;
101 my $high = $self->{num_highwater} ||=
102 $self->meta_accessor('num_highwater');
103 if (defined($num) && (!defined($high) || ($num > $high))) {
104 $self->{num_highwater} = $num;
105 $self->meta_accessor('num_highwater', $num);
107 $self->{num_highwater};
111 my ($self, $mid) = @_;
112 my $dbh = $self->{dbh};
113 my $sth = $dbh->prepare_cached(<<'');
114 INSERT INTO msgmap (mid) VALUES (?)
116 return unless eval { $sth->execute($mid) };
117 my $num = $dbh->last_insert_id(undef, undef, 'msgmap', 'num');
118 $self->num_highwater($num) if defined($num);
123 my ($self, $num) = @_;
124 my $dbh = $self->{dbh};
125 my $sth = $self->{mid_for} ||=
126 $dbh->prepare('SELECT mid FROM msgmap WHERE num = ? LIMIT 1');
127 $sth->bind_param(1, $num);
129 $sth->fetchrow_array;
133 my ($self, $mid) = @_;
134 my $dbh = $self->{dbh};
135 my $sth = $self->{num_for} ||=
136 $dbh->prepare('SELECT num FROM msgmap WHERE mid = ? LIMIT 1');
137 $sth->bind_param(1, $mid);
139 $sth->fetchrow_array;
143 my $sth = $_[0]->{dbh}->prepare_cached('SELECT MAX(num) FROM msgmap',
146 $sth->fetchrow_array // 0;
150 # breaking MIN and MAX into separate queries speeds up from 250ms
151 # to around 700us with 2.7million messages.
152 my $sth = $_[0]->{dbh}->prepare_cached('SELECT MIN(num) FROM msgmap',
155 ($sth->fetchrow_array // 0, max($_[0]));
159 my ($self, $mid) = @_;
160 my $dbh = $self->{dbh};
161 my $sth = $dbh->prepare('DELETE FROM msgmap WHERE mid = ?');
162 $sth->bind_param(1, $mid);
167 my ($self, $num) = @_;
168 my $dbh = $self->{dbh};
169 my $sth = $dbh->prepare('DELETE FROM msgmap WHERE num = ?');
170 $sth->bind_param(1, $num);
178 CREATE TABLE IF NOT EXISTS msgmap (
179 num INTEGER PRIMARY KEY AUTOINCREMENT,
180 mid VARCHAR(1000) NOT NULL,
185 CREATE TABLE IF NOT EXISTS meta (
186 key VARCHAR(32) PRIMARY KEY,
187 val VARCHAR(255) NOT NULL
194 my ($self, $num) = @_;
195 my $ids = $self->{dbh}->selectcol_arrayref(<<'', undef, $$num);
196 SELECT num FROM msgmap WHERE num > ?
197 ORDER BY num ASC LIMIT 1000
199 $$num = $ids->[-1] if @$ids;
204 my ($self, $beg, $end, $cols) = @_;
206 my $dbh = $self->{dbh};
207 my $attr = { Columns => [] };
208 my $mids = $dbh->selectall_arrayref(<<"", $attr, $$beg, $end);
209 SELECT $cols FROM msgmap WHERE num >= ? AND num <= ?
210 ORDER BY num ASC LIMIT 1000
212 $$beg = $mids->[-1]->[0] + 1 if @$mids;
216 # only used for mapping external serial numbers (e.g. articles from gmane)
217 # see scripts/xhdr-num2mid or PublicInbox::Filter::RubyLang for usage
219 my ($self, $num, $mid) = @_;
220 my $sth = $self->{mid_set} ||= do {
221 $self->{dbh}->prepare(
222 'INSERT OR IGNORE INTO msgmap (num,mid) VALUES (?,?)');
224 my $result = $sth->execute($num, $mid);
225 $self->num_highwater($num) if (defined($result) && $result == 1);
231 my $dbh = $self->{dbh} or return;
232 if (($self->{pid} // 0) == $$) {
233 my $f = $dbh->sqlite_db_filename;
234 unlink $f or warn "failed to unlink $f: $!\n";
240 $self->{pid} or die 'BUG: not a temporary clone';
241 $self->{dbh} and die 'BUG: tmp_clone dbh not prepared for parent';
242 defined($self->{filename}) or die 'BUG: {filename} not defined';
243 $self->{dbh} = PublicInbox::Over::dbh_new($self, 2);
244 $self->{dbh}->do('PRAGMA journal_mode = MEMORY');
249 my $pid = $self->{pid} or die 'BUG: not a temporary clone';
250 $pid == $$ or die "BUG: atfork_prepare not called by $pid";
251 my $dbh = $self->{dbh} or die 'BUG: temporary clone not open';
253 # must clobber prepared statements
254 %$self = (filename => $dbh->sqlite_db_filename, pid => $pid);
258 my ($self, $skip_artnum) = @_;
259 return meta_accessor($self, 'skip_artnum') if !defined($skip_artnum);
261 my $cur = num_highwater($self) // 0;
262 if ($skip_artnum < $cur) {
263 die "E: current article number $cur ",
264 "exceeds --skip-artnum=$skip_artnum\n";
268 my $mid = 'skip'.rand.'@'.rand.'.example.com';
269 $ok = mid_set($self, $skip_artnum, $mid);
271 mid_delete($self, $mid);
275 $ok or die '--skip-artnum failed';
277 # in the future, the indexer may use this value for
278 # new messages in old epochs
279 meta_accessor($self, 'skip_artnum', $skip_artnum);
285 # no filename if in-:memory:
286 my $f = $self->{dbh}->sqlite_db_filename // return;
287 if (my @st = stat($f)) { # did st_dev, st_ino change?
288 my $st = pack('dd', $st[0], $st[1]);
289 if ($st ne ($self->{st} // $st)) {
290 my $tmp = eval { ref($self)->new_file($f) };
292 warn "E: DBI->connect($f): $@\n";
298 warn "W: stat $f: $!\n";