1 # Copyright (C) 2020-2021 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # Combine any combination of PublicInbox::Search,
5 # PublicInbox::ExtSearch, and PublicInbox::LeiSearch objects
7 package PublicInbox::LeiXSearch;
10 use parent qw(PublicInbox::LeiSearch PublicInbox::IPC);
11 use PublicInbox::DS qw(now);
12 use File::Temp 0.19 (); # 0.19 for ->newdir
14 use PublicInbox::Search qw(xap_terms);
15 use PublicInbox::Spawn qw(popen_rd spawn which);
16 use PublicInbox::MID qw(mids);
17 use PublicInbox::Smsg;
19 use Fcntl qw(SEEK_SET F_SETFL O_APPEND O_RDWR);
20 use PublicInbox::ContentHash qw(git_sha);
24 PublicInbox::Search::load_xapian();
26 qp_flags => $PublicInbox::Search::QP_FLAGS |
27 PublicInbox::Search::FLAG_PURE_NOT(),
32 my ($self, $ibxish) = @_; # ibxish = ExtSearch or Inbox
33 my $desc = $ibxish->{inboxdir} // $ibxish->{topdir};
34 my $srch = $ibxish->search or
35 return warn("$desc not indexed for Xapian ($@ $!)\n");
36 my @shards = $srch->xdb_shards_flat or
37 return warn("$desc has no Xapian shards\n");
39 if (delete $self->{xdb}) { # XXX: do we need this?
40 # clobber existing {xdb} if amending
41 my $expect = delete $self->{nshard};
42 my $shards = delete $self->{shards_flat};
43 scalar(@$shards) == $expect or die
44 "BUG: {nshard}$expect != shards=".scalar(@$shards);
47 for my $old_ibxish (@{$self->{shard2ibx}}) {
48 next if $prev == $old_ibxish;
50 my @shards = $old_ibxish->search->xdb_shards_flat;
51 push @{$self->{shards_flat}}, @shards;
53 my $nr = scalar(@{$self->{shards_flat}});
55 "BUG: reloaded $nr shards, expected $expect"
57 push @{$self->{shards_flat}}, @shards;
58 push(@{$self->{shard2ibx}}, $ibxish) for (@shards);
61 # returns a list of local inboxes (or count in scalar context)
62 sub locals { @{$_[0]->{locals} // []} }
64 sub remotes { @{$_[0]->{remotes} // []} }
66 # called by PublicInbox::Search::xdb (usually via ->mset)
67 sub xdb_shards_flat { @{$_[0]->{shards_flat} // []} }
69 sub _mitem_kw { # retry_reopen callback
70 my ($srch, $smsg, $mitem, $flagged) = @_;
71 my $doc = $mitem->get_document;
72 my $kw = xap_terms('K', $doc);
73 $kw->{flagged} = 1 if $flagged;
74 my @L = xap_terms('L', $doc);
75 # we keep the empty {kw} array here to prevent expensive work in
76 # ->xsmsg_vmd, _unbless_smsg will clobber it iff it's empty
77 $smsg->{kw} = [ sort keys %$kw ];
78 $smsg->{L} = \@L if scalar(@L);
81 sub mitem_kw ($$$;$) {
82 my ($srch, $smsg, $mitem, $flagged) = @_;
83 $srch->retry_reopen(\&_mitem_kw, $smsg, $mitem, $flagged);
88 my ($self, $mitem) = @_;
89 # cf. https://trac.xapian.org/wiki/FAQ/MultiDatabaseDocumentID
90 my $nshard = $self->{nshard};
91 my $docid = $mitem->get_docid;
92 my $shard = ($docid - 1) % $nshard;
93 my $num = int(($docid - 1) / $nshard) + 1;
94 my $ibx = $self->{shard2ibx}->[$shard];
95 my $smsg = $ibx->over->get_art($num);
96 return if $smsg->{bytes} == 0; # external message
97 if ($ibx->can('msg_keywords')) {
98 mitem_kw($self, $smsg, $mitem);
104 my ($self, $qstr, $opt) = @_;
106 $opt->{relevance} //= -2;
107 $self->mset($qstr //= 'z:1..', $opt);
112 sub _mset_more ($$) {
113 my ($mset, $mo) = @_;
114 my $size = $mset->size;
115 $size >= $mo->{limit} && (($mo->{offset} += $size) < $mo->{limit});
118 # $startq will EOF when do_augment is done augmenting and allow
119 # query_combined_mset and query_thread_mset to proceed.
120 sub wait_startq ($) {
122 my $startq = delete $lei->{startq} or return;
124 my $n = sysread($startq, my $do_augment_done, 1);
126 return if $n == 0; # no MUA
127 if ($do_augment_done eq 'q') {
128 $lei->{opt}->{quiet} = 1;
129 delete $lei->{opt}->{verbose};
130 delete $lei->{-progress};
132 $lei->fail("$$ WTF `$do_augment_done'");
136 return $lei->fail("$$ wait_startq: $!") unless $!{EINTR};
142 return if $lei->{early_mua} || !$lei->{-progress};
143 if ($lei->{pkt_op_p}) {
144 $lei->{pkt_op_p}->pkt_do('mset_progress', @_);
145 } else { # single lei-daemon consumer
146 my ($desc, $mset_size, $mset_total_est) = @_;
147 $lei->{-mset_total} += $mset_size if $mset_total_est ne '?';
148 $lei->qerr("# $desc $mset_size/$mset_total_est");
154 $lei->{-nr_write} += $nr;
157 sub query_one_mset { # for --threads and l2m w/o sort
158 my ($self, $ibxish) = @_;
159 local $0 = "$0 query_one_mset";
160 my $lei = $self->{lei};
161 my ($srch, $over) = ($ibxish->search, $ibxish->over);
162 my $dir = $ibxish->{inboxdir} // $ibxish->{topdir};
163 return warn("$dir not indexed by Xapian\n") unless ($srch && $over);
164 bless $srch, 'PublicInbox::LeiSearch'; # for ->qparse_new
165 my $mo = { %{$lei->{mset_opt}} }; # copy
167 my $each_smsg = $lei->{ovv}->ovv_each_smsg_cb($lei);
168 my $can_kw = !!$ibxish->can('msg_keywords');
169 my $threads = $lei->{opt}->{threads} // 0;
170 my $fl = $threads > 1 ? 1 : undef;
171 my $lss = $lei->{dedupe};
172 $lss = undef unless $lss && $lss->can('cfg_set'); # saved search
173 my $maxk = "external.$dir.maxuid";
174 my $stop_at = $lss ? $lss->{-cfg}->{$maxk} : undef;
175 if (defined $stop_at) {
176 die "$maxk=$stop_at has multiple values" if ref $stop_at;
178 local $SIG{__WARN__} = sub { push @e, @_ };
180 return warn("$maxk=$stop_at: @e") if @e;
184 $mset = $srch->mset($mo->{qstr}, $mo);
185 mset_progress($lei, $dir, $mset->size,
186 $mset->get_matches_estimated);
187 wait_startq($lei); # wait for keyword updates
188 my $ids = $srch->mset_to_artnums($mset, $mo);
189 @$ids = grep { $_ > $stop_at } @$ids if defined($stop_at);
192 # copy $ids if $lss since over->expand_thread
193 # shifts @{$ctx->{ids}}
194 $first_ids = [ @$ids ] if $lss;
195 my $ctx = { ids => $ids };
196 my %n2item = map { ($ids->[$i++], $_) } $mset->items;
197 while ($over->expand_thread($ctx)) {
198 for my $n (@{$ctx->{xids}}) {
199 my $smsg = $over->get_art($n) or next;
200 my $mitem = delete $n2item{$n};
201 next if $smsg->{bytes} == 0;
202 if ($mitem && $can_kw) {
203 mitem_kw($srch, $smsg, $mitem,
205 } elsif ($mitem && $fl) {
206 # call ->xsmsg_vmd, later
207 $smsg->{lei_q_tt_flagged} = 1;
209 $each_smsg->($smsg, $mitem);
211 @{$ctx->{xids}} = ();
215 my @items = $mset->items;
217 my $mitem = $items[$i++];
218 my $smsg = $over->get_art($n) or next;
219 next if $smsg->{bytes} == 0;
220 mitem_kw($srch, $smsg, $mitem, $fl) if $can_kw;
221 $each_smsg->($smsg, $mitem);
224 } while (_mset_more($mset, $mo));
225 if ($lss && scalar(@$first_ids)) {
227 my $max = $first_ids->[0];
228 $lss->cfg_set($maxk, $max);
231 undef $each_smsg; # may commit
232 $lei->{ovv}->ovv_atexit_child($lei);
235 sub query_combined_mset { # non-parallel for non-"--threads" users
237 local $0 = "$0 query_combined_mset";
238 my $lei = $self->{lei};
239 my $mo = { %{$lei->{mset_opt}} };
241 for my $loc (locals($self)) {
242 attach_external($self, $loc);
244 my $each_smsg = $lei->{ovv}->ovv_each_smsg_cb($lei);
246 $mset = $self->mset($mo->{qstr}, $mo);
247 mset_progress($lei, 'xsearch', $mset->size,
248 $mset->get_matches_estimated);
249 wait_startq($lei); # wait for keyword updates
250 for my $mitem ($mset->items) {
251 my $smsg = smsg_for($self, $mitem) or next;
252 $each_smsg->($smsg, $mitem);
254 } while (_mset_more($mset, $mo));
255 undef $each_smsg; # may commit
256 $lei->{ovv}->ovv_atexit_child($lei);
259 sub _smsg_fill ($$) {
260 my ($smsg, $eml) = @_;
261 $smsg->populate($eml);
262 $smsg->parse_references($eml, mids($eml));
263 $smsg->{$_} //= '' for qw(from to cc ds subject references mid);
264 delete @$smsg{qw(From Subject -ds -ts)};
267 sub each_remote_eml { # callback for MboxReader->mboxrd
268 my ($eml, $self, $lei, $each_smsg) = @_;
269 my $xoids = $lei->{ale}->xoids_for($eml, 1);
270 my $smsg = bless {}, 'PublicInbox::Smsg';
271 if ($self->{import_sto} && !$xoids) {
272 my $res = $self->{import_sto}->ipc_do('add_eml', $eml);
273 if (ref($res) eq ref($smsg)) { # totally new message
275 $smsg->{kw} = []; # short-circuit xsmsg_vmd
278 $smsg->{blob} //= $xoids ? (keys(%$xoids))[0] : $lei->git_blob_id($eml);
279 _smsg_fill($smsg, $eml);
281 if ($lei->{-progress}) {
282 ++$lei->{-nr_remote_eml};
284 my $next = $lei->{-next_progress} //= ($now + 1);
286 $lei->{-next_progress} = $now + 1;
287 my $nr = $lei->{-nr_remote_eml};
288 mset_progress($lei, $lei->{-current_url}, $nr, '?');
291 $each_smsg->($smsg, undef, $eml);
294 sub query_remote_mboxrd {
295 my ($self, $uris) = @_;
296 local $0 = "$0 query_remote_mboxrd";
297 local $SIG{TERM} = sub { exit(0) }; # for DESTROY (File::Temp, $reap)
298 my $lei = $self->{lei};
299 my $opt = $lei->{opt};
300 my @qform = (q => $lei->{mset_opt}->{qstr}, x => 'm');
301 push(@qform, t => 1) if $opt->{threads};
302 my $verbose = $opt->{verbose};
303 my ($reap_tail, $reap_curl);
304 my $cerr = File::Temp->new(TEMPLATE => 'curl.err-XXXX', TMPDIR => 1);
305 fcntl($cerr, F_SETFL, O_APPEND|O_RDWR) or warn "set O_APPEND: $!";
306 my $rdr = { 2 => $cerr, pgid => 0 };
307 my $sigint_reap = $lei->can('sigint_reap');
309 # spawn a process to force line-buffering, otherwise curl
310 # will write 1 character at-a-time and parallel outputs
311 # mmmaaayyy llloookkk llliiikkkeee ttthhhiiisss
312 my $o = { 1 => $lei->{2}, 2 => $lei->{2}, pgid => 0 };
313 my $pid = spawn(['tail', '-f', $cerr->filename], undef, $o);
314 $reap_tail = PublicInbox::OnDestroy->new($sigint_reap, $pid);
316 my $curl = PublicInbox::LeiCurl->new($lei, $self->{curl}) or return;
317 push @$curl, '-s', '-d', '';
318 my $each_smsg = $lei->{ovv}->ovv_each_smsg_cb($lei);
319 $self->{import_sto} = $lei->{sto} if $lei->{opt}->{'import-remote'};
320 for my $uri (@$uris) {
321 $lei->{-current_url} = $uri->as_string;
322 $lei->{-nr_remote_eml} = 0;
323 $uri->query_form(@qform);
324 my $cmd = $curl->for_uri($lei, $uri);
325 $lei->qerr("# $cmd");
326 my ($fh, $pid) = popen_rd($cmd, undef, $rdr);
327 $reap_curl = PublicInbox::OnDestroy->new($sigint_reap, $pid);
328 $fh = IO::Uncompress::Gunzip->new($fh, MultiStream => 1);
329 PublicInbox::MboxReader->mboxrd($fh, \&each_remote_eml, $self,
331 my $err = waitpid($pid, 0) == $pid ? undef
332 : "BUG: waitpid($cmd): $!";
333 @$reap_curl = (); # cancel OnDestroy
335 my $nr = $lei->{-nr_remote_eml};
336 if ($nr && $lei->{sto}) {
337 my $wait = $lei->{sto}->ipc_do('done');
340 mset_progress($lei, $lei->{-current_url}, $nr, $nr);
345 seek($cerr, 0, SEEK_SET) or
346 $lei->err("seek($cmd stderr): $!");
347 $err = do { local $/; <$cerr> } //
348 "read($cmd stderr): $!";
349 truncate($cerr, 0) or
350 $lei->err("truncate($cmd stderr): $!");
352 next if (($? >> 8) == 22 && $err =~ /\b404\b/);
353 $uri->query_form(q => $lei->{mset_opt}->{qstr});
354 $lei->child_error($?, "E: <$uri> $err");
357 $lei->{ovv}->ovv_atexit_child($lei);
360 sub git { $_[0]->{git} // die 'BUG: git uninitialized' }
362 sub xsearch_done_wait { # dwaitpid callback
363 my ($arg, $pid) = @_;
364 my ($wq, $lei) = @$arg;
365 $lei->child_error($?, 'non-fatal error from '.ref($wq)) if $?;
368 sub query_done { # EOF callback for main daemon
370 my $l2m = delete $lei->{l2m};
371 $l2m->wq_wait_old(\&xsearch_done_wait, $lei) if $l2m;
372 if (my $lxs = delete $lei->{lxs}) {
373 $lxs->wq_wait_old(\&xsearch_done_wait, $lei);
375 if ($lei->{opt}->{'mail-sync'} && !$lei->{sto}) {
376 warn "BUG: {sto} missing with --mail-sync";
378 $lei->sto_done_request if $lei->{sto};
379 my $wait = $lei->{v2w} ? $lei->{v2w}->ipc_do('done') : undef;
380 $lei->{ovv}->ovv_end($lei);
382 if ($l2m) { # close() calls LeiToMail reap_compress
383 if (my $out = delete $lei->{old_1}) {
384 if (my $mbout = $lei->{1}) {
385 close($mbout) or return $lei->fail(<<"");
386 Error closing $lei->{ovv}->{dst}: $!
391 if ($l2m->lock_free) {
394 } else { # mbox users
395 delete $l2m->{mbl}; # drop dotlock
399 if ($lei->{-progress}) {
400 my $tot = $lei->{-mset_total} // 0;
401 my $nr = $lei->{-nr_write} // 0;
403 $lei->qfin("# $nr written to " .
404 "$lei->{ovv}->{dst} ($tot matches)");
406 $lei->qerr("# $tot matches");
409 $lei->start_mua if $start_mua;
413 sub do_post_augment {
415 my $l2m = $lei->{l2m} or return; # client disconnected
416 $lei->fchdir or return;
418 eval { $l2m->post_augment($lei) };
421 if (my $lxs = delete $lei->{lxs}) {
423 $lxs->wq_close(0, undef, $lei);
427 if (!$err && delete $lei->{early_mua}) { # non-augment case
430 close(delete $lei->{au_done}); # triggers wait_startq in lei_xsearch
433 sub incr_post_augment { # called whenever an l2m shard finishes augment
435 my $l2m = $lei->{l2m} or return; # client disconnected
436 return if ++$lei->{nr_post_augment} != $l2m->{-wq_nr_workers};
437 do_post_augment($lei);
440 my $MAX_PER_HOST = 4;
443 my ($self, $opt) = @_;
444 my $nl = $opt->{threads} ? locals($self) : 1;
445 my $nr = remotes($self);
446 $nr = $MAX_PER_HOST if $nr > $MAX_PER_HOST;
450 sub start_query ($;$) { # always runs in main (lei-daemon) process
451 my ($self, $l2m) = @_;
452 if ($self->{opt_threads} || ($l2m && !$self->{opt_sort})) {
453 for my $ibxish (locals($self)) {
454 $self->wq_io_do('query_one_mset', [], $ibxish);
456 } elsif (locals($self)) {
457 $self->wq_io_do('query_combined_mset', []);
461 for my $uri (remotes($self)) {
462 push @{$q->[$i++ % $MAX_PER_HOST]}, $uri;
465 $self->wq_io_do('query_remote_mboxrd', [], $uris);
467 if ($self->{-do_lcat}) {
468 $self->wq_io_do('lcat_dump', []);
470 $self->wq_close(1); # lei_xsearch workers stop when done
473 sub incr_start_query { # called whenever an l2m shard starts do_post_auth
474 my ($self, $l2m) = @_;
475 return if ++$self->{nr_start_query} != $l2m->{-wq_nr_workers};
476 start_query($self, $l2m);
479 sub ipc_atfork_child {
481 $self->{lei}->_lei_atfork_child;
482 $self->SUPER::ipc_atfork_child;
486 my ($self, $lei) = @_;
487 my $l2m = $lei->{l2m};
489 '|' => [ $lei->can('sigpipe_handler'), $lei ],
490 '!' => [ $lei->can('fail_handler'), $lei ],
491 '.' => [ \&do_post_augment, $lei ],
492 '+' => [ \&incr_post_augment, $lei ],
493 '' => [ \&query_done, $lei ],
494 'mset_progress' => [ \&mset_progress, $lei ],
495 'l2m_progress' => [ \&l2m_progress, $lei ],
496 'x_it' => [ $lei->can('x_it'), $lei ],
497 'child_error' => [ $lei->can('child_error'), $lei ],
498 'incr_start_query' => [ \&incr_start_query, $self, $l2m ],
500 $lei->{auth}->op_merge($ops, $l2m) if $l2m && $lei->{auth};
501 my $end = $lei->pkt_op_pair;
502 $lei->{1}->autoflush(1);
503 $lei->start_pager if delete $lei->{need_pager};
504 $lei->{ovv}->ovv_begin($lei);
505 die 'BUG: xdb|over open' if $lei->{lse}->{xdb} || $lei->{lse}->{over};
507 $l2m->pre_augment($lei);
508 if ($lei->{opt}->{augment} && delete $lei->{early_mua}) {
511 my $F_SETPIPE_SZ = $^O eq 'linux' ? 1031 : undef;
512 if ($l2m->{-wq_nr_workers} > 1 &&
513 $l2m->{base_type} =~ /\A(?:maildir|mbox)\z/) {
514 # setup two barriers to coordinate ->has_entries
515 # between l2m workers
516 pipe(my ($a_r, $a_w)) or die "pipe: $!";
517 fcntl($a_r, $F_SETPIPE_SZ, 4096) if $F_SETPIPE_SZ;
518 pipe(my ($b_r, $b_w)) or die "pipe: $!";
519 fcntl($b_r, $F_SETPIPE_SZ, 4096) if $F_SETPIPE_SZ;
520 $l2m->{au_peers} = [ $a_r, $a_w, $b_r, $b_w ];
522 $l2m->wq_workers_start('lei2mail', undef,
523 $lei->oldset, { lei => $lei });
524 pipe($lei->{startq}, $lei->{au_done}) or die "pipe: $!";
525 fcntl($lei->{startq}, $F_SETPIPE_SZ, 4096) if $F_SETPIPE_SZ;
526 delete $l2m->{au_peers};
528 $self->wq_workers_start('lei_xsearch', undef,
529 $lei->oldset, { lei => $lei });
530 my $op_c = delete $lei->{pkt_op_c};
531 delete $lei->{pkt_op_p};
533 $self->{opt_threads} = $lei->{opt}->{threads};
534 $self->{opt_sort} = $lei->{opt}->{'sort'};
535 $self->{-do_lcat} = $lei->{lcat_blob} // $lei->{lcat_fid};
537 $l2m->net_merge_all_done unless $lei->{auth};
541 $lei->event_step_init; # wait for shutdowns
542 $lei->wait_wq_events($op_c, $ops);
546 my ($self, $uri) = @_;
547 if (my $curl = $self->{curl} //= which('curl') // 0) {
548 require PublicInbox::MboxReader;
549 require IO::Uncompress::Gunzip;
550 require PublicInbox::LeiCurl;
551 push @{$self->{remotes}}, $uri;
553 warn "curl missing, ignoring $uri\n";
557 sub prepare_external {
558 my ($self, $loc, $boost) = @_; # n.b. already ordered by boost
559 if (ref $loc) { # already a URI, or PublicInbox::Inbox-like object
560 return add_uri($self, $loc) if $loc->can('scheme');
561 } elsif ($loc =~ m!\Ahttps?://!) {
563 return add_uri($self, URI->new($loc));
564 } elsif (-f "$loc/ei.lock") {
565 require PublicInbox::ExtSearch;
566 die "`\\n' not allowed in `$loc'\n" if index($loc, "\n") >= 0;
567 $loc = PublicInbox::ExtSearch->new($loc);
568 } elsif (-f "$loc/inbox.lock" || -d "$loc/public-inbox") {
569 die "`\\n' not allowed in `$loc'\n" if index($loc, "\n") >= 0;
570 require PublicInbox::Inbox; # v2, v1
571 $loc = bless { inboxdir => $loc }, 'PublicInbox::Inbox';
573 warn "W: ignoring $loc, unable to determine type\n";
576 push @{$self->{locals}}, $loc;
579 sub _lcat_i { # LeiMailSync->each_src iterator callback
580 my ($oidbin, $id, $each_smsg) = @_;
581 $each_smsg->({blob => unpack('H*', $oidbin), pct => 100});
584 sub _lcat2smsg { # git->cat_async callback
585 my ($bref, $oid, $type, $size, $smsg) = @_;
587 my $eml = PublicInbox::Eml->new($bref);
588 my $json_dump = delete $smsg->{-json_dump};
589 bless $smsg, 'PublicInbox::Smsg';
590 _smsg_fill($smsg, $eml);
591 $json_dump->($smsg, undef, $eml);
597 my $lei = $self->{lei};
598 my $each_smsg = $lei->{ovv}->ovv_each_smsg_cb($lei);
599 my $git = $lei->{ale}->git;
601 my $json_dump = $each_smsg;
605 $smsg->{-json_dump} = $json_dump;
606 $git->cat_async($smsg->{blob}, \&_lcat2smsg, $smsg);
609 for my $oid (@{$lei->{lcat_blob} // []}) {
610 $each_smsg->({ blob => $oid, pct => 100 });
612 if (my $fids = delete $lei->{lcat_fid}) {
613 my $lms = $lei->{lse}->lms;
614 for my $fid (@$fids) {
615 $lms->each_src({fid => $fid}, \&_lcat_i, $each_smsg);
618 $git->async_wait_all;
619 undef $each_smsg; # may commit
620 $lei->{ovv}->ovv_atexit_child($lei);