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 my $max = $self->max // 0;
40 $self->num_highwater($max);
46 # used to keep track of used numeric mappings for v2 reindex
48 my ($self, $dir) = @_;
50 my $tmp = "mm_tmp-$$-XXXXXX";
51 my ($fh, $fn) = File::Temp::tempfile($tmp, EXLOCK => 0, DIR => $dir);
52 PublicInbox::Spawn::nodatacow_fd(fileno($fh));
53 $self->{dbh}->sqlite_backup_to_file($fn);
54 $tmp = ref($self)->new_file($fn, 2);
55 $tmp->{dbh}->do('PRAGMA journal_mode = MEMORY');
60 # n.b. invoked directly by scripts/xhdr-num2mid
62 my ($self, $key, $value) = @_;
64 my $sql = 'SELECT val FROM meta WHERE key = ? LIMIT 1';
65 my $dbh = $self->{dbh};
67 defined $value or return $dbh->selectrow_array($sql, undef, $key);
69 $prev = $dbh->selectrow_array($sql, undef, $key);
72 $sql = 'UPDATE meta SET val = ? WHERE key = ?';
73 $dbh->do($sql, undef, $value, $key);
75 $sql = 'INSERT INTO meta (key,val) VALUES (?,?)';
76 $dbh->do($sql, undef, $key, $value);
82 my ($self, $commit) = @_;
83 $self->meta_accessor('last_commit', $commit);
86 # v2 uses this to keep track of how up-to-date Xapian is
87 # old versions may be automatically GC'ed away in the future,
88 # but it's a trivial amount of storage.
90 my ($self, $version, $i, $commit) = @_;
91 $self->meta_accessor("last_xap$version-$i", $commit);
94 # this is the UIDVALIDITY for IMAP (cf. RFC 3501 sec 2.3.1.1. item 3)
96 my ($self, $second) = @_;
97 $self->meta_accessor('created_at', $second);
101 my ($self, $num) = @_;
102 my $high = $self->{num_highwater} ||=
103 $self->meta_accessor('num_highwater');
104 if (defined($num) && (!defined($high) || ($num > $high))) {
105 $self->{num_highwater} = $num;
106 $self->meta_accessor('num_highwater', $num);
108 $self->{num_highwater};
112 my ($self, $mid) = @_;
113 my $dbh = $self->{dbh};
114 my $sth = $dbh->prepare_cached(<<'');
115 INSERT INTO msgmap (mid) VALUES (?)
117 return unless eval { $sth->execute($mid) };
118 my $num = $dbh->last_insert_id(undef, undef, 'msgmap', 'num');
119 $self->num_highwater($num) if defined($num);
124 my ($self, $num) = @_;
125 my $dbh = $self->{dbh};
126 my $sth = $self->{mid_for} ||=
127 $dbh->prepare('SELECT mid FROM msgmap WHERE num = ? LIMIT 1');
128 $sth->bind_param(1, $num);
130 $sth->fetchrow_array;
134 my ($self, $mid) = @_;
135 my $dbh = $self->{dbh};
136 my $sth = $self->{num_for} ||=
137 $dbh->prepare('SELECT num FROM msgmap WHERE mid = ? LIMIT 1');
138 $sth->bind_param(1, $mid);
140 $sth->fetchrow_array;
144 my $sth = $_[0]->{dbh}->prepare_cached('SELECT MAX(num) FROM msgmap',
147 $sth->fetchrow_array;
151 # breaking MIN and MAX into separate queries speeds up from 250ms
152 # to around 700us with 2.7million messages.
153 my $sth = $_[0]->{dbh}->prepare_cached('SELECT MIN(num) FROM msgmap',
156 ($sth->fetchrow_array, max($_[0]));
160 my ($self, $mid) = @_;
161 my $dbh = $self->{dbh};
162 my $sth = $dbh->prepare('DELETE FROM msgmap WHERE mid = ?');
163 $sth->bind_param(1, $mid);
168 my ($self, $num) = @_;
169 my $dbh = $self->{dbh};
170 my $sth = $dbh->prepare('DELETE FROM msgmap WHERE num = ?');
171 $sth->bind_param(1, $num);
179 CREATE TABLE IF NOT EXISTS msgmap (
180 num INTEGER PRIMARY KEY AUTOINCREMENT,
181 mid VARCHAR(1000) NOT NULL,
186 CREATE TABLE IF NOT EXISTS meta (
187 key VARCHAR(32) PRIMARY KEY,
188 val VARCHAR(255) NOT NULL
195 my ($self, $num) = @_;
196 my $ids = $self->{dbh}->selectcol_arrayref(<<'', undef, $$num);
197 SELECT num FROM msgmap WHERE num > ?
198 ORDER BY num ASC LIMIT 1000
200 $$num = $ids->[-1] if @$ids;
205 my ($self, $beg, $end, $cols) = @_;
207 my $dbh = $self->{dbh};
208 my $attr = { Columns => [] };
209 my $mids = $dbh->selectall_arrayref(<<"", $attr, $$beg, $end);
210 SELECT $cols FROM msgmap WHERE num >= ? AND num <= ?
211 ORDER BY num ASC LIMIT 1000
213 $$beg = $mids->[-1]->[0] + 1 if @$mids;
217 # only used for mapping external serial numbers (e.g. articles from gmane)
218 # see scripts/xhdr-num2mid or PublicInbox::Filter::RubyLang for usage
220 my ($self, $num, $mid) = @_;
221 my $sth = $self->{mid_set} ||= do {
222 $self->{dbh}->prepare(
223 'INSERT OR IGNORE INTO msgmap (num,mid) VALUES (?,?)');
225 my $result = $sth->execute($num, $mid);
226 $self->num_highwater($num) if (defined($result) && $result == 1);
232 my $dbh = $self->{dbh} or return;
233 if (($self->{pid} // 0) == $$) {
234 my $f = $dbh->sqlite_db_filename;
235 unlink $f or warn "failed to unlink $f: $!\n";
241 $self->{pid} or die 'BUG: not a temporary clone';
242 $self->{dbh} and die 'BUG: tmp_clone dbh not prepared for parent';
243 defined($self->{filename}) or die 'BUG: {filename} not defined';
244 $self->{dbh} = PublicInbox::Over::dbh_new($self, 2);
245 $self->{dbh}->do('PRAGMA journal_mode = MEMORY');
250 my $pid = $self->{pid} or die 'BUG: not a temporary clone';
251 $pid == $$ or die "BUG: atfork_prepare not called by $pid";
252 my $dbh = $self->{dbh} or die 'BUG: temporary clone not open';
254 # must clobber prepared statements
255 %$self = (filename => $dbh->sqlite_db_filename, pid => $pid);
259 my ($self, $skip_artnum) = @_;
260 return meta_accessor($self, 'skip_artnum') if !defined($skip_artnum);
262 my $cur = num_highwater($self) // 0;
263 if ($skip_artnum < $cur) {
264 die "E: current article number $cur ",
265 "exceeds --skip-artnum=$skip_artnum\n";
269 my $mid = 'skip'.rand.'@'.rand.'.example.com';
270 $ok = mid_set($self, $skip_artnum, $mid);
272 mid_delete($self, $mid);
276 $ok or die '--skip-artnum failed';
278 # in the future, the indexer may use this value for
279 # new messages in old epochs
280 meta_accessor($self, 'skip_artnum', $skip_artnum);
286 # no filename if in-:memory:
287 my $f = $self->{dbh}->sqlite_db_filename // return;
288 if (my @st = stat($f)) { # did st_dev, st_ino change?
289 my $st = pack('dd', $st[0], $st[1]);
290 if ($st ne ($self->{st} // $st)) {
291 my $tmp = eval { ref($self)->new_file($f) };
293 warn "E: DBI->connect($f): $@\n";
299 warn "W: stat $f: $!\n";