1 # Copyright (C) 2021 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # handles "lei q" command and provides internals for
5 # several other sub-commands (up, lcat, ...)
6 package PublicInbox::LeiQuery;
10 sub prep_ext { # externals_each callback
11 my ($lxs, $exclude, $loc) = @_;
12 $lxs->prepare_external($loc) unless $exclude->{$loc};
15 sub _start_query { # used by "lei q" and "lei up"
17 require PublicInbox::LeiOverview;
18 PublicInbox::LeiOverview->new($self) or return;
19 my $opt = $self->{opt};
20 my ($xj, $mj) = split(/,/, $opt->{jobs} // '');
21 (defined($xj) && $xj ne '' && $xj !~ /\A[1-9][0-9]*\z/) and
22 die "`$xj' search jobs must be >= 1\n";
23 my $lxs = $self->{lxs};
24 $xj ||= $lxs->concurrency($opt); # allow: "--jobs ,$WRITER_ONLY"
25 my $nproc = $lxs->detect_nproc || 1; # don't memoize, schedtool(1) exists
26 $xj = $nproc if $xj > $nproc;
27 $lxs->{-wq_nr_workers} = $xj;
28 (defined($mj) && $mj !~ /\A[1-9][0-9]*\z/) and
29 die "`$mj' writer jobs must be >= 1\n";
30 my $l2m = $self->{l2m};
31 # we use \1 (a ref) to distinguish between default vs. user-supplied
32 if ($l2m && grep { $opt->{$_} //= \1 } (qw(mail-sync import-remote
34 $self->_lei_store(1)->write_prepare($self);
35 if ($opt->{'mail-sync'}) {
36 my $lms = $l2m->{-lms_rw} = $self->lms(1);
37 $lms->lms_write_prepare->lms_pause; # just create
40 $l2m and $l2m->{-wq_nr_workers} //= $mj //
41 int($nproc * 0.75 + 0.5); # keep some CPU for git
43 # descending docid order is cheapest, MUA controls sorting order
44 $self->{mset_opt}->{relevance} //= -2 if $l2m || $opt->{threads};
46 my $tot = $self->{mset_opt}->{total} //= $self->{opt}->{limit} // 10000;
47 $self->{mset_opt}->{limit} = $tot > 10000 ? 10000 : $tot;
48 $self->{mset_opt}->{offset} //= 0;
49 $self->{mset_opt}->{threads} //= $opt->{threads};
52 require PublicInbox::LeiAuth;
53 $self->{auth} = PublicInbox::LeiAuth->new
55 $lxs->do_query($self);
58 sub qstr_add { # PublicInbox::InputPipe::consume callback for --stdin
59 my ($lei) = @_; # $_[1] = $rbuf
60 $_[1] // $lei->fail("error reading stdin: $!");
61 return $lei->{mset_opt}->{qstr} .= $_[1] if $_[1] ne '';
64 $lei->{mset_opt}->{q_raw} = $lei->{mset_opt}->{qstr};
65 $lei->{lse}->query_approxidate($lei->{lse}->git,
66 $lei->{mset_opt}->{qstr});
74 require PublicInbox::LeiXSearch;
75 # prepare any number of LeiXSearch || LeiSearch || Inbox || URL
76 my $lxs = $self->{lxs} = PublicInbox::LeiXSearch->new;
77 my $opt = $self->{opt};
78 my @only = @{$opt->{only} // []};
79 # --local is enabled by default unless --only is used
80 # we'll allow "--only $LOCATION --local"
81 my $sto = $self->_lei_store(1);
82 $self->{lse} = $sto->search;
83 if ($opt->{'local'} //= scalar(@only) ? 0 : 1) {
84 $lxs->prepare_external($self->{lse});
88 my @loc = $self->get_externals($loc) or return;
89 $lxs->prepare_external($_) for @loc;
92 my (@ilocals, @iremotes);
93 for my $loc (@{$opt->{include} // []}) {
94 my @loc = $self->get_externals($loc) or return;
95 $lxs->prepare_external($_) for @loc;
96 @ilocals = @{$lxs->{locals} // []};
97 @iremotes = @{$lxs->{remotes} // []};
99 # --external is enabled by default, but allow --no-external
100 if ($opt->{external} //= 1) {
101 my $ex = $self->canonicalize_excludes($opt->{exclude});
102 $self->externals_each(\&prep_ext, $lxs, $ex);
103 $opt->{remote} //= !($lxs->locals - $opt->{'local'});
104 $lxs->{locals} = \@ilocals if !$opt->{'local'};
105 $lxs->{remotes} = \@iremotes if !$opt->{remote};
108 ($lxs->locals || $lxs->remotes) ? ($self->{lxs} = $lxs) :
109 die("no local or remote inboxes to search\n");
112 # the main "lei q SEARCH_TERMS" method
114 my ($self, @argv) = @_;
115 PublicInbox::Config->json; # preload before forking
116 my $lxs = lxs_prepare($self) or return;
117 $self->ale->refresh_externals($lxs, $self);
118 my $opt = $self->{opt};
120 $mset_opt{asc} = $opt->{'reverse'} ? 1 : 0;
121 if (defined(my $sort = $opt->{'sort'})) {
122 if ($sort eq 'relevance') {
123 $mset_opt{relevance} = 1;
124 } elsif ($sort eq 'docid') {
125 $mset_opt{relevance} = $mset_opt{asc} ? -1 : -2;
126 } elsif ($sort =~ /\Areceived(?:-?[aA]t)?\z/) {
129 die "unrecognized --sort=$sort\n";
131 $opt->{save} and return
132 $self->fail('--save and --sort are incompatible');
134 $self->{mset_opt} = \%mset_opt;
137 return $self->fail(<<'') if @argv;
138 no query allowed on command-line with --stdin
140 require PublicInbox::InputPipe;
141 PublicInbox::InputPipe::consume($self->{0}, \&qstr_add, $self);
144 $mset_opt{q_raw} = [ @argv ]; # copy
146 $self->{lse}->query_argv_to_string($self->{lse}->git, \@argv);
150 # shell completion helper called by lei__complete
152 my ($self, @argv) = @_;
154 my $cb = $self->lazy_cb(qw(forget-external _complete_));
156 if ($argv[-1] =~ /\A(?:-I|(?:--(?:include|exclude|only)))\z/) {
157 my @c = $cb->($self, @cur);
158 # try basename match:
159 if (scalar(@cur) == 1 && index($cur[0], '/') < 0) {
160 my $all = $self->externals_each;
162 for my $loc (keys %$all) {
163 my $bn = (split(m!/!, $loc))[-1];
167 $bn{$_} == 1 && /\A\Q$cur[0]/
172 unshift(@cur, pop @argv);
177 # Stuff we may pass through to curl (as of 7.64.0), see curl manpage for
178 # details, so most options which make sense for HTTP/HTTPS (including proxy
179 # support for Tor and other methods of getting past weird networks).
180 # Most of these are untested by us, some may not make sense for our use case
181 # and typos below are likely.
182 # n.b. some short options (-$NUMBER) are not supported since they conflict
183 # with other "lei q" switches.
184 # FIXME: Getopt::Long doesn't easily let us support support options with
185 # '.' in them (e.g. --http1.1)
186 # TODO: should we depend on "-c http.*" options for things which have
187 # analogues in git(1)? that would reduce likelyhood of conflicts with
188 # our other CLI options
189 # Note: some names are renamed to avoid potential conflicts,
190 # see %lei2curl in lib/PublicInbox/LeiCurl.pm
193 abstract-unix-socket=s anyauth basic cacert=s capath=s
194 cert-status cert-type cert=s ciphers=s
195 connect-timeout=s connect-to=s cookie-jar=s cookie=s crlfile=s
196 digest disable dns-interface=s dns-ipv4-addr=s dns-ipv6-addr=s
197 dns-servers=s doh-url=s egd-file=s engine=s false-start
198 happy-eyeballs-timeout-ms=s haproxy-protocol header=s@
199 http2-prior-knowledge http2 insecure
200 interface=s ipv4 ipv6 junk-session-cookies
201 key-type=s key=s limit-rate=s local-port=s location-trusted location
202 max-redirs=i max-time=s negotiate netrc-file=s netrc-optional netrc
203 no-alpn no-buffer no-npn no-sessionid noproxy=s ntlm-wb ntlm
204 pass=s pinnedpubkey=s post301 post302 post303 preproxy=s
205 proxy-anyauth proxy-basic proxy-cacert=s proxy-capath=s
206 proxy-cert-type=s proxy-cert=s proxy-ciphers=s proxy-crlfile=s
207 proxy-digest proxy-header=s@ proxy-insecure
208 proxy-key-type=s proxy-key proxy-negotiate proxy-ntlm proxy-pass=s
209 proxy-pinnedpubkey=s proxy-service-name=s proxy-ssl-allow-beast
210 proxy-tls13-ciphers=s proxy-tlsauthtype=s proxy-tlspassword=s
211 proxy-tlsuser=s proxy-tlsv1 proxy-user=s proxy=s
212 proxytunnel=s pubkey=s random-file=s referer=s resolve=s
213 retry-connrefused retry-delay=s retry-max-time=s retry=i
214 sasl-ir service-name=s socks4=s socks4a=s socks5-basic
215 socks5-gssapi-service-name=s socks5-gssapi socks5-hostname=s socks5=s
216 speed-limit speed-type ssl-allow-beast sslv2 sslv3
217 suppress-connect-headers tcp-fastopen tls-max=s
218 tls13-ciphers=s tlsauthtype=s tlspassword=s tlsuser=s
219 tlsv1 trace-ascii=s trace-time trace=s
220 unix-socket=s user-agent=s user=s