lei: rename "extinbox" => "external"

The words "extinbox" and "extindex" are too close and easy to
confuse with the other.  Rename "extinbox" to "external", since
these could be IMAP, JMAP or other non-public-inbox search APIs.

Link: https://public-inbox.org/meta/20201226112649.GB6226@dcvr/

diff --git a/MANIFEST b/MANIFEST
index 96ad52bf53b1bb5240fb78b485d6525d11f8987f..6dc08f01a114a70fc36f6a81021c5aea9aa66e8b 100644 (file)
--- a/MANIFEST
+++ b/MANIFEST
@@ -164,7 +164,7 @@ lib/PublicInbox/Isearch.pm
 lib/PublicInbox/KQNotify.pm
 lib/PublicInbox/LEI.pm
 lib/PublicInbox/LeiDedupe.pm
-lib/PublicInbox/LeiExtinbox.pm
+lib/PublicInbox/LeiExternal.pm
 lib/PublicInbox/LeiSearch.pm
 lib/PublicInbox/LeiStore.pm
 lib/PublicInbox/LeiToMail.pm

diff --git a/lib/PublicInbox/LEI.pm b/lib/PublicInbox/LEI.pm
index 9aa4d95a9825ca63a58a12087572ad8fc3c2b773..f960aa7289721ae51921ab3ccbf51d979975c186 100644 (file)
--- a/lib/PublicInbox/LEI.pm
+++ b/lib/PublicInbox/LEI.pm
@@ -8,7 +8,7 @@
 package PublicInbox::LEI;
 use strict;
 use v5.10.1;
-use parent qw(PublicInbox::DS PublicInbox::LeiExtinbox);
+use parent qw(PublicInbox::DS PublicInbox::LeiExternal);
 use Getopt::Long ();
 use Socket qw(AF_UNIX SOCK_STREAM pack_sockaddr_un);
 use Errno qw(EAGAIN ECONNREFUSED ENOENT);
@@ -70,19 +70,19 @@ sub _config_path ($) {
 our %CMD = ( # sorted in order of importance/use:
 'q' => [ 'SEARCH_TERMS...', 'search for messages matching terms', qw(
        save-as=s output|o=s format|f=s dedupe|d=s thread|t augment|a
-       sort|s=s@ reverse|r offset=i remote local! extinbox!
+       sort|s=s@ reverse|r offset=i remote local! external!
        since|after=s until|before=s), opt_dash('limit|n=i', '[0-9]+') ],
 
 'show' => [ 'MID|OID', 'show a given object (Message-ID or object ID)',
        qw(type=s solve! format|f=s dedupe|d=s thread|t remote local!),
        pass_through('git show') ],
 
-'add-extinbox' => [ 'URL_OR_PATHNAME',
+'add-external' => [ 'URL_OR_PATHNAME',
        'add/set priority of a publicinbox|extindex for extra matches',
        qw(boost=i quiet|q) ],
-'ls-extinbox' => [ '[FILTER...]', 'list publicinbox|extindex locations',
+'ls-external' => [ '[FILTER...]', 'list publicinbox|extindex locations',
        qw(format|f=s z|0 local remote quiet|q) ],
-'forget-extinbox' => [ '{URL_OR_PATHNAME|--prune}',
+'forget-external' => [ '{URL_OR_PATHNAME|--prune}',
        'exclude further results from a publicinbox|extindex',
        qw(prune quiet|q) ],
 
@@ -189,7 +189,7 @@ my %OPTDESC = (
 'q     format|f=s' => [ 'OUT|maildir|mboxrd|mboxcl2|mboxcl|html|oid|json',
                'specify output format, default depends on --output'],
 'ls-query      format|f=s' => $ls_format,
-'ls-extinbox   format|f=s' => $ls_format,
+'ls-external   format|f=s' => $ls_format,
 
 'limit|n=i@' => ['NUM', 'limit on number of matches (default: 10000)' ],
 'offset=i' => ['OFF', 'search result offset (default: 0)'],

diff --git a/lib/PublicInbox/LeiExtinbox.pm b/lib/PublicInbox/LeiExternal.pm
similarity index 75%
rename from lib/PublicInbox/LeiExtinbox.pm
rename to lib/PublicInbox/LeiExternal.pm
index c2de773535f2eb2169dfd39db722a9ff0ce5b554..0378551a9d97cc3706df8f9f7dc3fb77e9053ab7 100644 (file)
--- a/lib/PublicInbox/LeiExtinbox.pm
+++ b/lib/PublicInbox/LeiExternal.pm
@@ -1,22 +1,22 @@
 # Copyright (C) 2020 all contributors <meta@public-inbox.org>
 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
 
-# *-extinbox commands of lei
-package PublicInbox::LeiExtinbox;
+# *-external commands of lei
+package PublicInbox::LeiExternal;
 use strict;
 use v5.10.1;
 use parent qw(Exporter);
-our @EXPORT = qw(lei_ls_extinbox lei_add_extinbox lei_forget_extinbox);
+our @EXPORT = qw(lei_ls_external lei_add_external lei_forget_external);
 
-sub lei_ls_extinbox {
+sub lei_ls_external {
        my ($self, @argv) = @_;
        my $stor = $self->_lei_store(0);
        my $cfg = $self->_lei_cfg(0);
        my $out = $self->{1};
        my ($OFS, $ORS) = $self->{opt}->{z} ? ("\0", "\0\0") : (" ", "\n");
        my (%boost, @loc);
-       for my $sec (grep(/\Aextinbox\./, @{$cfg->{-section_order}})) {
-               my $loc = substr($sec, length('extinbox.'));
+       for my $sec (grep(/\Aexternal\./, @{$cfg->{-section_order}})) {
+               my $loc = substr($sec, length('external.'));
                $boost{$loc} = $cfg->{"$sec.boost"};
                push @loc, $loc;
        }
@@ -28,14 +28,14 @@ sub lei_ls_extinbox {
        }
 }
 
-sub lei_add_extinbox {
+sub lei_add_external {
        my ($self, $url_or_dir) = @_;
        my $cfg = $self->_lei_cfg(1);
        if ($url_or_dir !~ m!\Ahttps?://!) {
                $url_or_dir = File::Spec->canonpath($url_or_dir);
        }
        my $new_boost = $self->{opt}->{boost} // 0;
-       my $key = "extinbox.$url_or_dir.boost";
+       my $key = "external.$url_or_dir.boost";
        my $cur_boost = $cfg->{$key};
        return if defined($cur_boost) && $cur_boost == $new_boost; # idempotent
        $self->lei_config($key, $new_boost);
@@ -44,7 +44,7 @@ sub lei_add_extinbox {
        $stor->done;
 }
 
-sub lei_forget_extinbox {
+sub lei_forget_external {
        # TODO
 }
 

diff --git a/lib/PublicInbox/LeiXSearch.pm b/lib/PublicInbox/LeiXSearch.pm
index 1a81b14a25540aac31d24ed7b8430504249e1c00..7d251afdbf6ece8eb09ff544e447716926b3f3dd 100644 (file)
--- a/lib/PublicInbox/LeiXSearch.pm
+++ b/lib/PublicInbox/LeiXSearch.pm
@@ -18,7 +18,7 @@ sub new {
        }, $class
 }
 
-sub attach_extinbox {
+sub attach_external {
        my ($self, $ibxish) = @_; # ibxish = ExtSearch or Inbox
        if (!$ibxish->can('over')) {
                push @{$self->{remotes}}, $ibxish

diff --git a/t/lei.t b/t/lei.t
index a95a0efc9a5f79d6d487c9b1b2b2229e4c7b577a..764a7fe4227f631372936913ca00d3d69934d2ea 100644 (file)
--- a/t/lei.t
+++ b/t/lei.t
@@ -154,38 +154,38 @@ my $setup_publicinboxes = sub {
        $seen || BAIL_OUT 'no imports';
 };
 
-my $test_extinbox = sub {
+my $test_external = sub {
        $setup_publicinboxes->();
        $cleanup->();
-       $lei->('ls-extinbox');
-       is($out.$err, '', 'ls-extinbox no output, yet');
+       $lei->('ls-external');
+       is($out.$err, '', 'ls-external no output, yet');
        ok(!-e $config_file && !-e $store_dir,
-               'nothing created by ls-extinbox');
+               'nothing created by ls-external');
 
        my $cfg = PublicInbox::Config->new;
        $cfg->each_inbox(sub {
                my ($ibx) = @_;
-               ok($lei->(qw(add-extinbox -q), $ibx->{inboxdir}),
-                       'added extinbox');
+               ok($lei->(qw(add-external -q), $ibx->{inboxdir}),
+                       'added external');
                is($out.$err, '', 'no output');
        });
        ok(-s $config_file && -e $store_dir,
-               'add-extinbox created config + store');
+               'add-external created config + store');
        my $lcfg = PublicInbox::Config->new($config_file);
        $cfg->each_inbox(sub {
                my ($ibx) = @_;
-               is($lcfg->{"extinbox.$ibx->{inboxdir}.boost"}, 0,
+               is($lcfg->{"external.$ibx->{inboxdir}.boost"}, 0,
                        "configured boost on $ibx->{name}");
        });
-       $lei->('ls-extinbox');
-       like($out, qr/boost=0\n/s, 'ls-extinbox has output');
+       $lei->('ls-external');
+       like($out, qr/boost=0\n/s, 'ls-external has output');
 };
 
 my $test_lei_common = sub {
        $test_help->();
        $test_config->();
        $test_init->();
-       $test_extinbox->();
+       $test_external->();
 };
 
 my $test_lei_oneshot = $ENV{TEST_LEI_ONESHOT};

diff --git a/t/lei_xsearch.t b/t/lei_xsearch.t
index c41213bd2fff69b36a8e4f4d90bbd44e48005855..178c3d371718269d30a92cf19bef44af63d94484 100644 (file)
--- a/t/lei_xsearch.t
+++ b/t/lei_xsearch.t
@@ -49,7 +49,7 @@ $eidx->eidx_sync({fsync => 0});
 my $es = PublicInbox::ExtSearch->new("$home/eidx");
 my $lxs = PublicInbox::LeiXSearch->new;
 for my $ibxish (shuffle($es, @ibx)) {
-       $lxs->attach_extinbox($ibxish);
+       $lxs->attach_external($ibxish);
 }
 my $nr = $lxs->xdb->get_doccount;
 my $mset = $lxs->mset('d:19931002..19931003', { limit => $nr });