1 # Copyright (C) 2015-2018 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
10 package PublicInbox::Msgmap;
15 use File::Temp qw(tempfile);
18 my ($class, $git_dir, $writable) = @_;
19 my $d = "$git_dir/public-inbox";
20 if ($writable && !-d $d && !mkdir $d) {
22 -d $d or die "$d not created: $err";
24 new_file($class, "$d/msgmap.sqlite3", $writable);
28 my ($f, $writable) = @_;
29 my $dbh = DBI->connect("dbi:SQLite:dbname=$f",'','', {
33 ReadOnly => !$writable,
34 sqlite_use_immediate_transaction => 1,
36 $dbh->do('PRAGMA case_sensitive_like = ON');
41 my ($class, $f, $writable) = @_;
43 my $dbh = dbh_new($f, $writable);
44 my $self = bless { dbh => $dbh }, $class;
49 $self->created_at(time) unless $self->created_at;
55 # used to keep track of used numeric mappings for v2 reindex
58 my ($fh, $fn) = tempfile('msgmap-XXXXXXXX', EXLOCK => 0, TMPDIR => 1);
59 $self->{dbh}->sqlite_backup_to_file($fn);
60 my $tmp = ref($self)->new_file($fn, 1);
61 $tmp->{dbh}->do('PRAGMA synchronous = OFF');
62 $tmp->{tmp_name} = $fn; # SQLite won't work if unlinked, apparently
64 close $fh or die "failed to close $fn: $!";
68 # n.b. invoked directly by scripts/xhdr-num2mid
70 my ($self, $key, $value) = @_;
72 my $sql = 'SELECT val FROM meta WHERE key = ? LIMIT 1';
73 my $dbh = $self->{dbh};
75 defined $value or return $dbh->selectrow_array($sql, undef, $key);
77 $prev = $dbh->selectrow_array($sql, undef, $key);
80 $sql = 'UPDATE meta SET val = ? WHERE key = ? LIMIT 1';
81 $dbh->do($sql, undef, $value, $key);
83 $sql = 'INSERT INTO meta (key,val) VALUES (?,?)';
84 $dbh->do($sql, undef, $key, $value);
90 my ($self, $commit) = @_;
91 $self->meta_accessor('last_commit', $commit);
95 my ($self, $second) = @_;
96 $self->meta_accessor('created_at', $second);
100 my ($self, $mid) = @_;
101 my $dbh = $self->{dbh};
102 my $sql = 'INSERT OR IGNORE INTO msgmap (mid) VALUES (?)';
103 my $sth = $self->{mid_insert} ||= $dbh->prepare($sql);
104 $sth->bind_param(1, $mid);
105 return if $sth->execute == 0;
106 $dbh->last_insert_id(undef, undef, 'msgmap', 'num');
110 my ($self, $num) = @_;
111 my $dbh = $self->{dbh};
112 my $sth = $self->{mid_for} ||=
113 $dbh->prepare('SELECT mid FROM msgmap WHERE num = ? LIMIT 1');
114 $sth->bind_param(1, $num);
116 $sth->fetchrow_array;
120 my ($self, $mid) = @_;
121 my $dbh = $self->{dbh};
122 my $sth = $self->{num_for} ||=
123 $dbh->prepare('SELECT num FROM msgmap WHERE mid = ? LIMIT 1');
124 $sth->bind_param(1, $mid);
126 $sth->fetchrow_array;
131 my $dbh = $self->{dbh};
132 my $sth = $self->{num_minmax} ||=
133 $dbh->prepare('SELECT MIN(num),MAX(num) FROM msgmap');
135 $sth->fetchrow_array;
139 my ($self, $pfx, $limit) = @_;
141 die "No prefix given" unless (defined $pfx && $pfx ne '');
142 $pfx =~ s/([%_])/\\$1/g;
146 $limit += 0; # force to integer
149 $self->{dbh}->selectcol_arrayref('SELECT mid FROM msgmap ' .
150 'WHERE mid LIKE ? ESCAPE ? ' .
151 "ORDER BY num DESC LIMIT $limit",
156 my ($self, $mid) = @_;
157 my $dbh = $self->{dbh};
158 my $sth = $dbh->prepare('DELETE FROM msgmap WHERE mid = ?');
159 $sth->bind_param(1, $mid);
164 my ($self, $num) = @_;
165 my $dbh = $self->{dbh};
166 my $sth = $dbh->prepare('DELETE FROM msgmap WHERE num = ?');
167 $sth->bind_param(1, $num);
175 $e = eval { $dbh->selectrow_array('EXPLAIN SELECT * FROM msgmap;') };
176 defined $e or $dbh->do('CREATE TABLE msgmap (' .
177 'num INTEGER PRIMARY KEY AUTOINCREMENT, '.
178 'mid VARCHAR(1000) NOT NULL, ' .
181 $e = eval { $dbh->selectrow_array('EXPLAIN SELECT * FROM meta') };
182 defined $e or $dbh->do('CREATE TABLE meta (' .
183 'key VARCHAR(32) PRIMARY KEY, '.
184 'val VARCHAR(255) NOT NULL)');
189 my ($self, $num, $cb) = @_;
190 my $dbh = $self->{dbh};
191 my $sth = $dbh->prepare('SELECT num FROM msgmap WHERE num > ? '.
192 'ORDER BY num ASC LIMIT 1000');
194 my $ary = $sth->fetchall_arrayref;
195 @$ary = map { $_->[0] } @$ary;
196 my $nr = scalar @$ary;
201 # only used for mapping external serial numbers (e.g. articles from gmane)
202 # see scripts/xhdr-num2mid or PublicInbox::Filter::RubyLang for usage
204 my ($self, $num, $mid) = @_;
205 my $sth = $self->{mid_set} ||= do {
206 $self->{dbh}->prepare(
207 'INSERT OR IGNORE INTO msgmap (num,mid) VALUES (?,?)');
209 $sth->execute($num, $mid);
215 my $f = delete $self->{tmp_name};
216 if (defined $f && $self->{pid} == $$) {
217 unlink $f or warn "failed to unlink $f: $!\n";
223 my $f = $self->{tmp_name} or die "not a temporary clone\n";
224 delete $self->{dbh} and die "tmp_clone dbh not prepared for parent";
225 my $dbh = $self->{dbh} = dbh_new($f, 1);
226 $dbh->do('PRAGMA synchronous = OFF');
231 my $f = $self->{tmp_name} or die "not a temporary clone\n";
232 $self->{pid} == $$ or
233 die "BUG: atfork_prepare not called from $self->{pid}\n";
234 $self->{dbh} or die "temporary clone not open\n";
235 # must clobber prepared statements
236 %$self = (tmp_name => $f, pid => $$);