-# Copyright (C) 2015-2020 all contributors <meta@public-inbox.org>
+# Copyright (C) all contributors <meta@public-inbox.org>
# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
# bidirectional Message-ID <-> Article Number mapping for the NNTP
# numbers for NNTP and allows prefix lookups for partial Message-IDs
# in case URLs get truncated from copy-n-paste errors by users.
#
-# This is maintained by ::SearchIdx
+# This is maintained by ::SearchIdx (v1) and ::V2Writable (v2)
package PublicInbox::Msgmap;
use strict;
-use warnings;
+use v5.10.1;
use DBI;
use DBD::SQLite;
-use File::Temp qw(tempfile);
use PublicInbox::Over;
-
-sub new {
- my ($class, $git_dir, $writable) = @_;
- my $d = "$git_dir/public-inbox";
- if ($writable && !-d $d && !mkdir $d) {
- my $err = $!;
- -d $d or die "$d not created: $err";
- }
- new_file($class, "$d/msgmap.sqlite3", $writable);
-}
+use Scalar::Util qw(blessed);
sub new_file {
- my ($class, $f, $rw) = @_;
+ my ($class, $ibx, $rw) = @_;
+ my $f;
+ if (blessed($ibx)) {
+ $f = $ibx->mm_file;
+ $rw = 2 if $rw && $ibx->{-no_fsync};
+ } else {
+ $f = $ibx;
+ }
return if !$rw && !-r $f;
my $self = bless { filename => $f }, $class;
my $dbh = $self->{dbh} = PublicInbox::Over::dbh_new($self, $rw);
if ($rw) {
- create_tables($dbh);
-
- # TRUNCATE reduces I/O compared to the default (DELETE)
- $dbh->do('PRAGMA journal_mode = TRUNCATE');
-
$dbh->begin_work;
- $self->created_at(time) unless $self->created_at;
+ create_tables($dbh);
+ unless ($self->created_at) {
+ my $t;
- my $max = $self->max // 0;
- $self->num_highwater($max);
+ if (blessed($ibx) &&
+ -f "$ibx->{inboxdir}/inbox.config.example") {
+ $t = (stat(_))[9]; # mtime set by "curl -R"
+ }
+ $self->created_at($t // time);
+ }
+ $self->num_highwater(max($self));
$dbh->commit;
}
$self;
# used to keep track of used numeric mappings for v2 reindex
sub tmp_clone {
- my ($self) = @_;
- my ($fh, $fn) = tempfile('msgmap-XXXXXXXX', EXLOCK => 0, TMPDIR => 1);
+ my ($self, $dir) = @_;
+ require File::Temp;
+ my $tmp = "mm_tmp-$$-XXXX";
+ my ($fh, $fn) = File::Temp::tempfile($tmp, EXLOCK => 0, DIR => $dir);
+ require PublicInbox::Syscall;
+ PublicInbox::Syscall::nodatacow_fh($fh);
$self->{dbh}->sqlite_backup_to_file($fn);
- my $tmp = ref($self)->new_file($fn, 1);
- $tmp->{dbh}->do('PRAGMA synchronous = OFF');
+ $tmp = ref($self)->new_file($fn, 2);
$tmp->{dbh}->do('PRAGMA journal_mode = MEMORY');
$tmp->{pid} = $$;
- close $fh or die "failed to close $fn: $!";
$tmp;
}
my ($self, $key, $value) = @_;
my $sql = 'SELECT val FROM meta WHERE key = ? LIMIT 1';
- my $dbh = $self->{dbh};
- my $prev;
- defined $value or return $dbh->selectrow_array($sql, undef, $key);
-
- $prev = $dbh->selectrow_array($sql, undef, $key);
+ my $prev = $self->{dbh}->selectrow_array($sql, undef, $key);
+ $value // return $prev;
if (defined $prev) {
$sql = 'UPDATE meta SET val = ? WHERE key = ?';
- $dbh->do($sql, undef, $value, $key);
+ $self->{dbh}->do($sql, undef, $value, $key);
} else {
$sql = 'INSERT INTO meta (key,val) VALUES (?,?)';
- $dbh->do($sql, undef, $key, $value);
+ $self->{dbh}->do($sql, undef, $key, $value);
}
$prev;
}
$self->meta_accessor("last_xap$version-$i", $commit);
}
+# this is the UIDVALIDITY for IMAP (cf. RFC 3501 sec 2.3.1.1. item 3)
sub created_at {
my ($self, $second) = @_;
$self->meta_accessor('created_at', $second);
sub num_highwater {
my ($self, $num) = @_;
- my $high = $self->{num_highwater} ||=
- $self->meta_accessor('num_highwater');
+ my $high = $self->meta_accessor('num_highwater');
if (defined($num) && (!defined($high) || ($num > $high))) {
- $self->{num_highwater} = $num;
+ $high = $num;
$self->meta_accessor('num_highwater', $num);
}
- $self->{num_highwater};
+ $high
}
sub mid_insert {
my ($self, $mid) = @_;
- my $dbh = $self->{dbh};
- my $sth = $dbh->prepare_cached(<<'');
+ my $sth = $self->{dbh}->prepare_cached(<<'');
INSERT INTO msgmap (mid) VALUES (?)
return unless eval { $sth->execute($mid) };
- my $num = $dbh->last_insert_id(undef, undef, 'msgmap', 'num');
+ my $num = $self->{dbh}->last_insert_id(undef, undef, 'msgmap', 'num');
$self->num_highwater($num) if defined($num);
$num;
}
sub mid_for {
my ($self, $num) = @_;
- my $dbh = $self->{dbh};
- my $sth = $self->{mid_for} ||=
- $dbh->prepare('SELECT mid FROM msgmap WHERE num = ? LIMIT 1');
- $sth->bind_param(1, $num);
- $sth->execute;
+ my $sth = $self->{dbh}->prepare_cached(<<"", undef, 1);
+SELECT mid FROM msgmap WHERE num = ? LIMIT 1
+
+ $sth->execute($num);
$sth->fetchrow_array;
}
sub num_for {
my ($self, $mid) = @_;
- my $dbh = $self->{dbh};
- my $sth = $self->{num_for} ||=
- $dbh->prepare('SELECT num FROM msgmap WHERE mid = ? LIMIT 1');
- $sth->bind_param(1, $mid);
- $sth->execute;
+ my $sth = $self->{dbh}->prepare_cached(<<"", undef, 1);
+SELECT num FROM msgmap WHERE mid = ? LIMIT 1
+
+ $sth->execute($mid);
$sth->fetchrow_array;
}
my $sth = $_[0]->{dbh}->prepare_cached('SELECT MAX(num) FROM msgmap',
undef, 1);
$sth->execute;
- $sth->fetchrow_array;
+ $sth->fetchrow_array // 0;
}
sub minmax {
my $sth = $_[0]->{dbh}->prepare_cached('SELECT MIN(num) FROM msgmap',
undef, 1);
$sth->execute;
- ($sth->fetchrow_array, max($_[0]));
+ ($sth->fetchrow_array // 0, max($_[0]));
}
sub mid_delete {
my ($self, $mid) = @_;
- my $dbh = $self->{dbh};
- my $sth = $dbh->prepare('DELETE FROM msgmap WHERE mid = ?');
- $sth->bind_param(1, $mid);
- $sth->execute;
+ $self->{dbh}->do('DELETE FROM msgmap WHERE mid = ?', undef, $mid);
}
sub num_delete {
my ($self, $num) = @_;
- my $dbh = $self->{dbh};
- my $sth = $dbh->prepare('DELETE FROM msgmap WHERE num = ?');
- $sth->bind_param(1, $num);
- $sth->execute;
+ $self->{dbh}->do('DELETE FROM msgmap WHERE num = ?', undef, $num);
}
sub create_tables {
my ($dbh) = @_;
- my $e;
-
- $e = eval { $dbh->selectrow_array('EXPLAIN SELECT * FROM msgmap;') };
- defined $e or $dbh->do('CREATE TABLE msgmap (' .
- 'num INTEGER PRIMARY KEY AUTOINCREMENT, '.
- 'mid VARCHAR(1000) NOT NULL, ' .
- 'UNIQUE (mid) )');
-
- $e = eval { $dbh->selectrow_array('EXPLAIN SELECT * FROM meta') };
- defined $e or $dbh->do('CREATE TABLE meta (' .
- 'key VARCHAR(32) PRIMARY KEY, '.
- 'val VARCHAR(255) NOT NULL)');
-}
-# used by NNTP.pm
-sub ids_after {
- my ($self, $num) = @_;
- my $ids = $self->{dbh}->selectcol_arrayref(<<'', undef, $$num);
-SELECT num FROM msgmap WHERE num > ?
-ORDER BY num ASC LIMIT 1000
+ $dbh->do(<<'');
+CREATE TABLE IF NOT EXISTS msgmap (
+ num INTEGER PRIMARY KEY AUTOINCREMENT,
+ mid VARCHAR(1000) NOT NULL,
+ UNIQUE (mid)
+)
+
+ $dbh->do(<<'');
+CREATE TABLE IF NOT EXISTS meta (
+ key VARCHAR(32) PRIMARY KEY,
+ val VARCHAR(255) NOT NULL
+)
- $$num = $ids->[-1] if @$ids;
- $ids;
}
sub msg_range {
my ($self, $beg, $end, $cols) = @_;
$cols //= 'num,mid';
- my $dbh = $self->{dbh};
my $attr = { Columns => [] };
- my $mids = $dbh->selectall_arrayref(<<"", $attr, $$beg, $end);
+ my $mids = $self->{dbh}->selectall_arrayref(<<"", $attr, $$beg, $end);
SELECT $cols FROM msgmap WHERE num >= ? AND num <= ?
ORDER BY num ASC LIMIT 1000
# see scripts/xhdr-num2mid or PublicInbox::Filter::RubyLang for usage
sub mid_set {
my ($self, $num, $mid) = @_;
- my $sth = $self->{mid_set} ||= do {
- $self->{dbh}->prepare(
- 'INSERT OR IGNORE INTO msgmap (num,mid) VALUES (?,?)');
- };
+ my $sth = $self->{dbh}->prepare_cached(<<"");
+INSERT OR IGNORE INTO msgmap (num,mid) VALUES (?,?)
+
my $result = $sth->execute($num, $mid);
$self->num_highwater($num) if (defined($result) && $result == 1);
$result;
$self->{pid} or die 'BUG: not a temporary clone';
$self->{dbh} and die 'BUG: tmp_clone dbh not prepared for parent';
defined($self->{filename}) or die 'BUG: {filename} not defined';
- my $dbh = $self->{dbh} = PublicInbox::Over::dbh_new($self, 1);
- $dbh->do('PRAGMA synchronous = OFF');
+ $self->{dbh} = PublicInbox::Over::dbh_new($self, 2);
+ $self->{dbh}->do('PRAGMA journal_mode = MEMORY');
}
sub atfork_prepare {
sub check_inodes {
my ($self) = @_;
- # no filename if in-:memory:
- my $f = $self->{dbh}->sqlite_db_filename // return;
- if (my @st = stat($f)) { # did st_dev, st_ino change?
- my $st = pack('dd', $st[0], $st[1]);
- if ($st ne ($self->{st} // $st)) {
- my $tmp = eval { ref($self)->new_file($f) };
- if ($@) {
- warn "E: DBI->connect($f): $@\n";
- } else {
- %$self = %$tmp;
- }
- }
- } else {
- warn "W: stat $f: $!\n";
- }
+ $self->{dbh} // return;
+ my $rw = !$self->{dbh}->{ReadOnly};
+ PublicInbox::Over::check_inodes($self);
+ $self->{dbh} //= PublicInbox::Over::dbh_new($self, !$rw);
}
1;