1 # Copyright (C) 2020 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # Read-only external (detached) index for cross inbox search.
5 # This is a read-only counterpart to PublicInbox::ExtSearchIdx
6 # and behaves like PublicInbox::Inbox AND PublicInbox::Search
7 package PublicInbox::ExtSearch;
10 use PublicInbox::Over;
11 use PublicInbox::Inbox;
13 use PublicInbox::MiscSearch;
14 use DBI qw(:sql_types); # SQL_BLOB
16 # for ->reopen, ->mset, ->mset_to_artnums
17 use parent qw(PublicInbox::Search);
20 my ($class, $topdir) = @_;
21 $topdir = File::Spec->canonpath($topdir);
25 xpfx => "$topdir/ei".PublicInbox::Search::SCHEMA_VERSION
31 $self->{misc} //= PublicInbox::MiscSearch->new("$self->{xpfx}/misc");
34 sub search { $_[0] } # self
36 # same as per-inbox ->over, for now...
39 $self->{over} //= PublicInbox::Over->new("$self->{xpfx}/over.sqlite3");
44 $self->{git} //= PublicInbox::Git->new("$self->{topdir}/ALL.git");
47 # returns a hashref of { $NEWSGROUP_NAME => $ART_NO } using the `xref3' table
48 sub nntp_xref_for { # NNTP only
49 my ($self, $xibx, $xsmsg) = @_;
50 my $dbh = over($self)->dbh;
52 my $sth = $dbh->prepare_cached(<<'', undef, 1);
53 SELECT ibx_id FROM inboxes WHERE eidx_key = ? LIMIT 1
55 $sth->execute($xibx->{newsgroup});
56 my $xibx_id = $sth->fetchrow_array // do {
57 warn "W: `$xibx->{newsgroup}' not found in $self->{topdir}\n";
61 $sth = $dbh->prepare_cached(<<'', undef, 1);
62 SELECT docid FROM xref3 WHERE oidbin = ? AND xnum = ? AND ibx_id = ? LIMIT 1
64 $sth->bind_param(1, pack('H*', $xsmsg->{blob}), SQL_BLOB);
66 # NNTP::cmd_over can set {num} to zero according to RFC 3977 8.3.2
67 $sth->bind_param(2, $xsmsg->{num} || $xsmsg->{-orig_num});
68 $sth->bind_param(3, $xibx_id);
70 my $docid = $sth->fetchrow_array // do {
72 W: `$xibx->{newsgroup}:$xsmsg->{num}' not found in $self->{topdir}"
77 # LIMIT is number of newsgroups on server:
78 $sth = $dbh->prepare_cached(<<'', undef, 1);
79 SELECT ibx_id,xnum FROM xref3 WHERE docid = ? AND ibx_id != ?
81 $sth->execute($docid, $xibx_id);
82 my $rows = $sth->fetchall_arrayref;
84 my $eidx_key_sth = $dbh->prepare_cached(<<'', undef, 1);
85 SELECT eidx_key FROM inboxes WHERE ibx_id = ? LIMIT 1
88 my ($ibx_id, $xnum) = @$_;
90 $eidx_key_sth->execute($ibx_id);
91 my $eidx_key = $eidx_key_sth->fetchrow_array;
93 # only include if there's a newsgroup name
94 $eidx_key && index($eidx_key, '/') >= 0 ?
95 () : ($eidx_key => $xnum)
97 $xref{$xibx->{newsgroup}} = $xsmsg->{num};
107 ($self->{description} //=
108 PublicInbox::Inbox::cat_desc("$self->{topdir}/description")) //
109 '$EXTINDEX_DIR/description missing';
112 sub cloneurl { [] } # TODO
114 sub base_url { 'https://example.com/TODO/' }
118 *smsg_eml = \&PublicInbox::Inbox::smsg_eml;
119 *smsg_by_mid = \&PublicInbox::Inbox::smsg_by_mid;
120 *msg_by_mid = \&PublicInbox::Inbox::msg_by_mid;
121 *modified = \&PublicInbox::Inbox::modified;
122 *recent = \&PublicInbox::Inbox::recent;
124 *max_git_epoch = *nntp_usable = *msg_by_path = \&mm; # undef