public-inbox.git  about / heads / tags
an "archives first" approach to mailing lists
blob 3fb3805fe82abea0c23684890d1f33004e6815d5 4813 bytes (raw)
$ git show repobrowse:lib/PublicInbox/Msgmap.pm	# shows this blob on the CLI

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# Copyright (C) 2015 all contributors <meta@public-inbox.org>
# License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt)

# bidirectional Message-ID <-> Article Number mapping for the NNTP
# and web interfaces.  This is required for implementing stable article
# 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
package PublicInbox::Msgmap;
use strict;
use warnings;
use DBI;
use DBD::SQLite;

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 new_file {
	my ($class, $f, $writable) = @_;

	my $dbh = DBI->connect("dbi:SQLite:dbname=$f",'','', {
		AutoCommit => 1,
		RaiseError => 1,
		PrintError => 0,
		ReadOnly => !$writable,
		sqlite_use_immediate_transaction => 1,
	});
	$dbh->do('PRAGMA case_sensitive_like = ON');
	my $self = bless { dbh => $dbh }, $class;

	if ($writable) {
		create_tables($dbh);
		$dbh->begin_work;
		$self->created_at(time) unless $self->created_at;
		$dbh->commit;
	}
	$self;
}

# n.b. invoked directly by scripts/xhdr-num2mid
sub meta_accessor {
	my ($self, $key, $value) = @_;
	use constant {
		meta_select => 'SELECT val FROM meta WHERE key = ? LIMIT 1',
		meta_update => 'UPDATE meta SET val = ? WHERE key = ? LIMIT 1',
		meta_insert => 'INSERT INTO meta (key,val) VALUES (?,?)',
	};

	my $dbh = $self->{dbh};
	my $prev;
	defined $value or
		return $dbh->selectrow_array(meta_select, undef, $key);

	$prev = $dbh->selectrow_array(meta_select, undef, $key);

	if (defined $prev) {
		$dbh->do(meta_update, undef, $value, $key);
	} else {
		$dbh->do(meta_insert, undef, $key, $value);
	}
	$prev;
}

sub last_commit {
	my ($self, $commit) = @_;
	$self->meta_accessor('last_commit', $commit);
}

sub created_at {
	my ($self, $second) = @_;
	$self->meta_accessor('created_at', $second);
}

sub mid_insert {
	my ($self, $mid) = @_;
	my $dbh = $self->{dbh};
	use constant MID_INSERT => 'INSERT INTO msgmap (mid) VALUES (?)';
	my $sth = $self->{mid_insert} ||= $dbh->prepare(MID_INSERT);
	$sth->bind_param(1, $mid);
	$sth->execute;
	$dbh->last_insert_id(undef, undef, 'msgmap', 'num');
}

sub mid_for {
	my ($self, $num) = @_;
	my $dbh = $self->{dbh};
	use constant MID_FOR => 'SELECT mid FROM msgmap WHERE num = ? LIMIT 1';
	my $sth = $self->{mid_for} ||= $dbh->prepare(MID_FOR);
	$sth->bind_param(1, $num);
	$sth->execute;
	$sth->fetchrow_array;
}

sub num_for {
	my ($self, $mid) = @_;
	my $dbh = $self->{dbh};
	use constant NUM_FOR => 'SELECT num FROM msgmap WHERE mid = ? LIMIT 1';
	my $sth = $self->{num_for} ||= $dbh->prepare(NUM_FOR);
	$sth->bind_param(1, $mid);
	$sth->execute;
	$sth->fetchrow_array;
}

sub minmax {
	my ($self) = @_;
	my $dbh = $self->{dbh};
	use constant NUM_MINMAX => 'SELECT MIN(num),MAX(num) FROM msgmap';
	my $sth = $self->{num_minmax} ||= $dbh->prepare(NUM_MINMAX);
	$sth->execute;
        $sth->fetchrow_array;
}

sub mid_prefixes {
	my ($self, $pfx, $limit) = @_;

	die "No prefix given" unless (defined $pfx && $pfx ne '');
	$pfx =~ s/([%_])/\\$1/g;
	$pfx .= '%';

	$limit ||= 100;
	$limit += 0; # force to integer
	$limit ||= 100;

	$self->{dbh}->selectcol_arrayref('SELECT mid FROM msgmap ' .
					 'WHERE mid LIKE ? ESCAPE ? ' .
					 "ORDER BY num DESC LIMIT $limit",
					 undef, $pfx, '\\');
}

sub mid_delete {
	my ($self, $mid) = @_;
	my $dbh = $self->{dbh};
	use constant MID_DELETE => 'DELETE FROM msgmap WHERE mid = ?';
	my $sth = $dbh->prepare(MID_DELETE);
	$sth->bind_param(1, $mid);
	$sth->execute;
}

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 id_batch {
	my ($self, $num, $cb) = @_;
	my $dbh = $self->{dbh};
	my $sth = $dbh->prepare('SELECT num FROM msgmap WHERE num > ? '.
				'ORDER BY num ASC LIMIT 1000');
	$sth->execute($num);
	my $ary = $sth->fetchall_arrayref;
	@$ary = map { $_->[0] } @$ary;
	my $nr = scalar @$ary;
	$cb->($ary) if $nr;
	$nr;
}

# only used for mapping external serial numbers (e.g. articles from gmane)
# see scripts/xhdr-num2mid for usage
sub mid_set {
	my ($self, $num, $mid) = @_;
	my $sth = $self->{mid_set} ||= do {
		my $sql = 'INSERT INTO msgmap (num, mid) VALUES (?,?)';
		$self->{dbh}->prepare($sql);
	};
	$sth->execute($num, $mid);
}

1;

git clone https://public-inbox.org/public-inbox.git
git clone http://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/public-inbox.git