diff options
Diffstat (limited to 'lib/PublicInbox/Msgmap.pm')
| -rw-r--r-- | lib/PublicInbox/Msgmap.pm | 260 |
1 files changed, 134 insertions, 126 deletions
diff --git a/lib/PublicInbox/Msgmap.pm b/lib/PublicInbox/Msgmap.pm index 9523752e..cb4bb295 100644 --- a/lib/PublicInbox/Msgmap.pm +++ b/lib/PublicInbox/Msgmap.pm @@ -1,4 +1,4 @@ -# 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 @@ -6,54 +6,41 @@ # 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); - -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); -} - -sub dbh_new { - my ($f, $writable) = @_; - if ($writable && !-f $f) { # SQLite defaults mode to 0644, we want 0666 - open my $fh, '+>>', $f or die "failed to open $f: $!"; - } - my $dbh = DBI->connect("dbi:SQLite:dbname=$f",'','', { - AutoCommit => 1, - RaiseError => 1, - PrintError => 0, - ReadOnly => !$writable, - sqlite_use_immediate_transaction => 1, - }); - $dbh; -} +use PublicInbox::Over; +use Scalar::Util qw(blessed); sub new_file { - my ($class, $f, $writable) = @_; - return if !$writable && !-r $f; - - my $dbh = dbh_new($f, $writable); - my $self = bless { dbh => $dbh }, $class; + 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; - if ($writable) { - create_tables($dbh); + my $self = bless { filename => $f }, $class; + my $dbh = $self->{dbh} = PublicInbox::Over::dbh_new($self, $rw); + if ($rw) { $dbh->begin_work; - $self->created_at(time) unless $self->created_at; - - my (undef, $max) = $self->minmax(); - $max ||= 0; - $self->num_highwater($max); + create_tables($dbh); + unless ($self->created_at) { + my $t; + + 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; @@ -61,14 +48,16 @@ sub new_file { # 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->{tmp_name} = $fn; # SQLite won't work if unlinked, apparently + $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; } @@ -77,18 +66,15 @@ sub meta_accessor { 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; } @@ -106,6 +92,7 @@ sub last_commit_xap { $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); @@ -113,109 +100,96 @@ sub created_at { 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; } +sub max { + my $sth = $_[0]->{dbh}->prepare_cached('SELECT MAX(num) FROM msgmap', + undef, 1); + $sth->execute; + $sth->fetchrow_array // 0; +} + +sub min { + my $sth = $_[0]->{dbh}->prepare_cached('SELECT MIN(num) FROM msgmap', + undef, 1); + $sth->execute; + $sth->fetchrow_array // 0; +} + sub minmax { - my ($self) = @_; - my $dbh = $self->{dbh}; # breaking MIN and MAX into separate queries speeds up from 250ms # to around 700us with 2.7million messages. - my $sth = $dbh->prepare_cached('SELECT MIN(num) FROM msgmap', undef, 1); - $sth->execute; - my $min = $sth->fetchrow_array; - $sth = $dbh->prepare_cached('SELECT MAX(num) FROM msgmap', undef, 1); - $sth->execute; - ($min, $sth->fetchrow_array); + (min($_[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 @@ -227,10 +201,9 @@ 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; @@ -238,29 +211,64 @@ sub mid_set { sub DESTROY { my ($self) = @_; - delete $self->{dbh}; - my $f = delete $self->{tmp_name}; - if (defined $f && $self->{pid} == $$) { + my $dbh = $self->{dbh} or return; + if (($self->{pid} // 0) == $$) { + my $f = $dbh->sqlite_db_filename; unlink $f or warn "failed to unlink $f: $!\n"; } } sub atfork_parent { my ($self) = @_; - my $f = $self->{tmp_name} or die "not a temporary clone\n"; - delete $self->{dbh} and die "tmp_clone dbh not prepared for parent"; - my $dbh = $self->{dbh} = dbh_new($f, 1); - $dbh->do('PRAGMA synchronous = OFF'); + $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'; + $self->{dbh} = PublicInbox::Over::dbh_new($self, 2); + $self->{dbh}->do('PRAGMA journal_mode = MEMORY'); } sub atfork_prepare { my ($self) = @_; - my $f = $self->{tmp_name} or die "not a temporary clone\n"; - $self->{pid} == $$ or - die "BUG: atfork_prepare not called from $self->{pid}\n"; - $self->{dbh} or die "temporary clone not open\n"; + my $pid = $self->{pid} or die 'BUG: not a temporary clone'; + $pid == $$ or die "BUG: atfork_prepare not called by $pid"; + my $dbh = $self->{dbh} or die 'BUG: temporary clone not open'; + # must clobber prepared statements - %$self = (tmp_name => $f, pid => $$); + %$self = (filename => $dbh->sqlite_db_filename, pid => $pid); +} + +sub skip_artnum { + my ($self, $skip_artnum) = @_; + return meta_accessor($self, 'skip_artnum') if !defined($skip_artnum); + + my $cur = num_highwater($self) // 0; + if ($skip_artnum < $cur) { + die "E: current article number $cur ", + "exceeds --skip-artnum=$skip_artnum\n"; + } else { + my $ok; + for (1..10) { + my $mid = 'skip'.rand.'@'.rand.'.example.com'; + $ok = mid_set($self, $skip_artnum, $mid); + if ($ok) { + mid_delete($self, $mid); + last; + } + } + $ok or die '--skip-artnum failed'; + + # in the future, the indexer may use this value for + # new messages in old epochs + meta_accessor($self, 'skip_artnum', $skip_artnum); + } +} + +sub check_inodes { + my ($self) = @_; + $self->{dbh} // return; + my $rw = !$self->{dbh}->{ReadOnly}; + PublicInbox::Over::check_inodes($self); + $self->{dbh} //= PublicInbox::Over::dbh_new($self, !$rw); } 1; |