]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/LEI.pm
lei q: reinstate early MUA spawn for Maildir
[public-inbox.git] / lib / PublicInbox / LEI.pm
index f5413aab51c3c01257ee7a46dd8662181500408f..24efb49489c39332eb3110025543b41a818121ba 100644 (file)
@@ -12,12 +12,11 @@ use parent qw(PublicInbox::DS PublicInbox::LeiExternal
        PublicInbox::LeiQuery);
 use Getopt::Long ();
 use Socket qw(AF_UNIX SOCK_SEQPACKET MSG_EOR pack_sockaddr_un);
-use Errno qw(EAGAIN EINTR ECONNREFUSED ENOENT ECONNRESET);
+use Errno qw(EPIPE EAGAIN EINTR ECONNREFUSED ENOENT ECONNRESET);
 use Cwd qw(getcwd);
-use POSIX ();
+use POSIX qw(strftime);
 use IO::Handle ();
 use Fcntl qw(SEEK_SET);
-use Sys::Syslog qw(syslog openlog);
 use PublicInbox::Config;
 use PublicInbox::Syscall qw(SFD_NONBLOCK EPOLLIN EPOLLET);
 use PublicInbox::Sigfd;
@@ -102,10 +101,11 @@ sub _config_path ($) {
 # TODO: generate shell completion + help using %CMD and %OPTDESC
 # command => [ positional_args, 1-line description, Getopt::Long option spec ]
 our %CMD = ( # sorted in order of importance/use:
-'q' => [ 'SEARCH_TERMS...', 'search for messages matching terms', qw(
+'q' => [ '--stdin|SEARCH_TERMS...', 'search for messages matching terms', qw(
        save-as=s output|mfolder|o=s format|f=s dedupe|d=s thread|t augment|a
        sort|s=s reverse|r offset=i remote! local! external! pretty
-       mua-cmd|mua=s no-torsocks torsocks=s verbose|v
+       include|I=s@ exclude=s@ only=s@ jobs|j=s globoff|g stdin|
+       mua-cmd|mua=s no-torsocks torsocks=s verbose|v quiet|q
        received-after=s received-before=s sent-after=s sent-since=s),
        PublicInbox::LeiQuery::curl_opt(), opt_dash('limit|n=i', '[0-9]+') ],
 
@@ -201,6 +201,7 @@ my $ls_format = [ 'OUT|plain|json|null', 'listing output format' ];
 my %OPTDESC = (
 'help|h' => 'show this built-in help',
 'quiet|q' => 'be quiet',
+'globoff|g' => "do not match locations using '*?' wildcards and '[]' ranges",
 'verbose|v' => 'be more verbose',
 'solve!' => 'do not attempt to reconstruct blobs from emails',
 'torsocks=s' => ['auto|no|yes',
@@ -229,6 +230,16 @@ my %OPTDESC = (
 'q     format|f=s' => [
        'OUT|maildir|mboxrd|mboxcl2|mboxcl|mboxo|html|json|jsonl|concatjson',
                'specify output format, default depends on --output'],
+'q     exclude=s@' => [ 'URL_OR_PATHNAME',
+               'exclude specified external(s) from search' ],
+'q     include|I=s@' => [ 'URL_OR_PATHNAME',
+               'include specified external(s) in search' ],
+'q     only=s@' => [ 'URL_OR_PATHNAME',
+               'only use specified external(s) for search' ],
+
+'q     jobs=s' => [ '[SEARCH_JOBS][,WRITER_JOBS]',
+               'control number of search and writer jobs' ],
+
 'ls-query      format|f=s' => $ls_format,
 'ls-external   format|f=s' => $ls_format,
 
@@ -275,110 +286,95 @@ sub x_it ($$) {
        # make sure client sees stdout before exit
        $self->{1}->autoflush(1) if $self->{1};
        dump_and_clear_log();
-       if (my $sock = $self->{sock}) {
-               send($sock, "x_it $code", MSG_EOR);
-       } elsif (!($code & 127)) { # oneshot, ignore signals
+       if (my $s = $self->{pkt_op_p} // $self->{sock}) {
+               send($s, "x_it $code", MSG_EOR);
+       } elsif ($self->{oneshot}) {
                # don't want to end up using $? from child processes
                for my $f (qw(lxs l2m)) {
                        my $wq = delete $self->{$f} or next;
                        $wq->DESTROY;
                }
-               $quit->($code >> 8);
-       }
+               # cleanup anything that has tempfiles
+               delete @$self{qw(ovv dedupe)};
+               if (my $signum = ($code & 127)) { # usually SIGPIPE (13)
+                       $SIG{PIPE} = 'DEFAULT'; # $SIG{$signum} doesn't work
+                       kill $signum, $$;
+                       sleep(1) while 1; # wait for signal
+               } else {
+                       $quit->($code >> 8);
+               }
+       } # else ignore if client disconnected
 }
 
-sub puts ($;@) { print { shift->{1} } map { "$_\n" } @_ }
-
-sub out ($;@) { print { shift->{1} } @_ }
-
 sub err ($;@) {
        my $self = shift;
-       my $err = $self->{2} // ($self->{pgr} // [])->[2] // *STDERR{IO};
-       print $err @_, (substr($_[-1], -1, 1) eq "\n" ? () : "\n");
+       my $err = $self->{2} // ($self->{pgr} // [])->[2] // *STDERR{GLOB};
+       my @eor = (substr($_[-1]//'', -1, 1) eq "\n" ? () : ("\n"));
+       print $err @_, @eor and return;
+       my $old_err = delete $self->{2};
+       close($old_err) if $! == EPIPE && $old_err;
+       $err = $self->{2} = ($self->{pgr} // [])->[2] // *STDERR{GLOB};
+       print $err @_, @eor or print STDERR @_, @eor;
 }
 
 sub qerr ($;@) { $_[0]->{opt}->{quiet} or err(shift, @_) }
 
 sub fail ($$;$) {
        my ($self, $buf, $exit_code) = @_;
-       err($self, $buf);
+       err($self, $buf) if defined $buf;
+       # calls fail_handler:
+       send($self->{pkt_op_p}, '!', MSG_EOR) if $self->{pkt_op_p};
        x_it($self, ($exit_code // 1) << 8);
        undef;
 }
 
+sub out ($;@) {
+       my $self = shift;
+       return if print { $self->{1} // return } @_; # likely
+       return note_sigpipe($self, 1) if $! == EPIPE;
+       my $err = "error writing to stdout: $!";
+       delete $self->{1};
+       fail($self, $err);
+}
+
+sub puts ($;@) { out(shift, map { "$_\n" } @_) }
+
 sub child_error { # passes non-fatal curl exit codes to user
        my ($self, $child_error) = @_; # child_error is $?
-       if (my $sock = $self->{sock}) { # send to lei(1) client
-               send($sock, "child_error $child_error", MSG_EOR);
-       } else { # oneshot
+       if (my $s = $self->{pkt_op_p} // $self->{sock}) {
+               # send to the parent lei-daemon or to lei(1) client
+               send($s, "child_error $child_error", MSG_EOR);
+       } elsif (!$PublicInbox::DS::in_loop) {
                $self->{child_error} = $child_error;
-       }
-       undef;
+       } # else noop if client disconnected
 }
 
-sub atfork_prepare_wq {
-       my ($self, $wq) = @_;
-       my $tcafc = $wq->{-ipc_atfork_child_close} //= [ $listener // () ];
-       if (my $sock = $self->{sock}) {
-               push @$tcafc, @$self{qw(0 1 2 3)}, $sock;
-       }
-       if (my $pgr = $self->{pgr}) {
-               push @$tcafc, @$pgr[1,2];
+sub note_sigpipe { # triggers sigpipe_handler
+       my ($self, $fd) = @_;
+       close(delete($self->{$fd})); # explicit close silences Perl warning
+       send($self->{pkt_op_p}, '|', MSG_EOR) if $self->{pkt_op_p};
+       x_it($self, 13);
+}
+
+sub lei_atfork_child {
+       my ($self) = @_;
+       # we need to explicitly close things which are on stack
+       delete $self->{0};
+       for (delete @$self{qw(3 sock old_1 au_done)}) {
+               close($_) if defined($_);
        }
-       if (my $old_1 = $self->{old_1}) {
-               push @$tcafc, $old_1;
+       if (my $op_c = delete $self->{pkt_op_c}) {
+               close(delete $op_c->{sock});
        }
-       for my $f (qw(lxs l2m)) {
-               my $ipc = $self->{$f} or next;
-               push @$tcafc, grep { defined }
-                               @$ipc{qw(-wq_s1 -wq_s2 -ipc_req -ipc_res)};
+       if (my $pgr = delete $self->{pgr}) {
+               close($_) for (@$pgr[1,2]);
        }
-}
-
-# usage: my %sig = $lei->atfork_child_wq($wq);
-#       local @SIG{keys %sig} = values %sig;
-sub atfork_child_wq {
-       my ($self, $wq) = @_;
-       my ($sock, $l2m_wq_s1);
-       (@$self{qw(0 1 2)}, $sock, $l2m_wq_s1) = delete(@$wq{0..4});
-       $self->{sock} = $sock if -S $sock;
-       $self->{l2m}->{-wq_s1} = $l2m_wq_s1 if $l2m_wq_s1 && -S $l2m_wq_s1;
+       close $listener if $listener;
+       undef $listener;
        %PATH2CFG = ();
        undef $errors_log;
        $quit = \&CORE::exit;
-       (__WARN__ => sub { err($self, @_) },
-       PIPE => sub {
-               $self->x_it(13); # SIGPIPE = 13
-               # we need to close explicitly to avoid Perl warning on SIGPIPE
-               for my $i (1, 2) {
-                       next unless $self->{$i} && (-p $self->{$i} || -S _);
-                       close(delete $self->{$i});
-               }
-               # trigger the LeiXSearch $done OpPipe:
-               syswrite($self->{0}, '!') if $self->{0} && -p $self->{0};
-               $SIG{PIPE} = 'DEFAULT';
-               die bless(\"$_[0]", 'PublicInbox::SIGPIPE'),
-       });
-}
-
-# usage: ($lei, @io) = $lei->atfork_parent_wq($wq);
-sub atfork_parent_wq {
-       my ($self, $wq) = @_;
-       my $env = delete $self->{env}; # env is inherited at fork
-       my $ret = bless { %$self }, ref($self);
-       if (my $dedupe = delete $ret->{dedupe}) {
-               $ret->{dedupe} = $wq->deep_clone($dedupe);
-       }
-       $self->{env} = $env;
-       delete @$ret{qw(3 -lei_store cfg old_1 pgr lxs)}; # keep l2m
-       my @io = delete @$ret{0..2};
-       $io[3] = delete($ret->{sock}) // $io[2];
-       my $l2m = $ret->{l2m};
-       if ($l2m && $l2m != $wq) { # $wq == lxs
-               $io[4] = $l2m->{-wq_s1} if $l2m->{-wq_s1};
-               $l2m->wq_close(1);
-       }
-       ($ret, @io);
+       $current_lei = $self; # for SIG{__WARN__}
 }
 
 sub _help ($;$) {
@@ -452,7 +448,9 @@ EOF
                $msg .= $rhs;
                $msg .= "\n";
        }
-       print { $self->{$errmsg ? 2 : 1} } $msg;
+       my $out = $self->{$errmsg ? 2 : 1};
+       start_pager($self) if -t $out;
+       print $out $msg;
        x_it($self, $errmsg ? 1 << 8 : 0); # stderr => failure
        undef;
 }
@@ -497,12 +495,13 @@ sub optparse ($$$) {
                } elsif ($var =~ /\A\[-?$POS_ARG\]\z/) { # one optional arg
                        $i++;
                } elsif ($var =~ /\A.+?\|/) { # required FOO|--stdin
+                       $inf = 1 if index($var, '...') > 0;
                        my @or = split(/\|/, $var);
                        my $ok;
                        for my $o (@or) {
                                if ($o =~ /\A--([a-z0-9\-]+)/) {
                                        $ok = defined($OPT->{$1});
-                                       last;
+                                       last if $ok;
                                } elsif (defined($argv->[$i])) {
                                        $ok = 1;
                                        $i++;
@@ -697,8 +696,7 @@ sub lei__complete {
                my $opt = quotemeta $1;
                puts $self, map {
                        my $v = $OPTDESC{$_};
-                       $v = $v->[0] if ref($v);
-                       my @v = split(/\|/, $v);
+                       my @v = ref($v) ? split(/\|/, $v->[0]) : ();
                        # get rid of ALL CAPS placeholder (e.g "OUT")
                        # (TODO: completion for external paths)
                        shift(@v) if uc($v[0]) eq $v[0];
@@ -738,9 +736,10 @@ sub start_mua {
        push @cmd, $mfolder unless defined($replaced);
        if (my $sock = $self->{sock}) { # lei(1) client process runs it
                send($sock, exec_buf(\@cmd, {}), MSG_EOR);
-       } else { # oneshot
+       } elsif ($self->{oneshot}) {
                $self->{"mua.pid.$self.$$"} = spawn(\@cmd);
        }
+       delete $self->{-progress};
 }
 
 # caller needs to "-t $self->{1}" to check if tty
@@ -756,13 +755,16 @@ sub start_pager {
        $new_env->{MORE} = 'FRX' if $^O eq 'freebsd';
        pipe(my ($r, $wpager)) or return warn "pipe: $!";
        my $rdr = { 0 => $r, 1 => $self->{1}, 2 => $self->{2} };
-       my $pgr = [ undef, @$rdr{1, 2}, $$ ];
+       my $pgr = [ undef, @$rdr{1, 2} ];
        if (my $sock = $self->{sock}) { # lei(1) process runs it
                delete @$new_env{keys %$env}; # only set iff unset
                my $fds = [ map { fileno($_) } @$rdr{0..2} ];
                $send_cmd->($sock, $fds, exec_buf([$pager], $new_env), MSG_EOR);
-       } else {
+       } elsif ($self->{oneshot}) {
                $pgr->[0] = spawn([$pager], $new_env, $rdr);
+               $pgr->[3] = $$; # ew'll reap it
+       } else {
+               die 'BUG: start_pager w/o socket';
        }
        $self->{1} = $wpager;
        $self->{2} = $wpager if -t $self->{2};
@@ -777,7 +779,7 @@ sub stop_pager {
        # do not restore original stdout, just close it so we error out
        close(delete($self->{1})) if $self->{1};
        my $pid = $pgr->[0];
-       dwaitpid($pid, undef, $self->{sock}) if $pid && $pgr->[3] == $$;
+       dwaitpid($pid) if $pid && ($pgr->[3] // 0) == $$;
 }
 
 sub accept_dispatch { # Listener {post_accept} callback
@@ -785,7 +787,7 @@ sub accept_dispatch { # Listener {post_accept} callback
        $sock->autoflush(1);
        my $self = bless { sock => $sock }, __PACKAGE__;
        vec(my $rvec = '', fileno($sock), 1) = 1;
-       select($rvec, undef, undef, 1) or
+       select($rvec, undef, undef, 60) or
                return send($sock, 'timed out waiting to recv FDs', MSG_EOR);
        my @fds = $recv_cmd->($sock, my $buf, 4096 * 33); # >MAX_ARG_STRLEN
        if (scalar(@fds) == 4) {
@@ -795,7 +797,9 @@ sub accept_dispatch { # Listener {post_accept} callback
                        send($sock, "open(+<&=$fd) (FD=$i): $!", MSG_EOR);
                }
        } else {
-               return send($sock, "recv_cmd failed: $!", MSG_EOR);
+               my $msg = "recv_cmd failed: $!";
+               warn $msg;
+               return send($sock, $msg, MSG_EOR);
        }
        $self->{2}->autoflush(1); # keep stdout buffered until x_it|DESTROY
        # $ENV_STR = join('', map { "\0$_=$ENV{$_}" } keys %ENV);
@@ -817,12 +821,13 @@ sub accept_dispatch { # Listener {post_accept} callback
 
 sub dclose {
        my ($self) = @_;
+       delete $self->{-progress};
        for my $f (qw(lxs l2m)) {
                my $wq = delete $self->{$f} or next;
                if ($wq->wq_kill) {
                        $wq->wq_close
                } elsif ($wq->wq_kill_old) {
-                       $wq->wq_wait_old;
+                       $wq->wq_wait_old($self);
                }
        }
        close(delete $self->{1}) if $self->{1}; # may reap_compress
@@ -859,7 +864,6 @@ sub event_step {
 sub event_step_init {
        my ($self) = @_;
        if (my $sock = $self->{sock}) { # using DS->EventLoop
-               $sock->blocking(0);
                $self->SUPER::new($sock, EPOLLIN|EPOLLET);
        }
 }
@@ -886,6 +890,11 @@ sub lazy_start {
                $! = $errno; # allow interpolation to stringify in die
                die "connect($path): $!";
        }
+       if (eval { require BSD::Resource }) {
+               my $NOFILE = BSD::Resource::RLIMIT_NOFILE();
+               my ($s, $h) = BSD::Resource::getrlimit($NOFILE);
+               BSD::Resource::setrlimit($NOFILE, $h, $h) if $s < $h;
+       }
        umask(077) // die("umask(077): $!");
        local $listener;
        socket($listener, AF_UNIX, SOCK_SEQPACKET, 0) or die "socket: $!";
@@ -963,9 +972,9 @@ sub lazy_start {
                                warn "$path dev/ino changed, quitting\n";
                                $path = undef;
                        }
-               } elsif (defined($path)) {
-                       warn "stat($path): $!, quitting ...\n";
-                       undef $path; # don't unlink
+               } elsif (defined($path)) { # ENOENT is common
+                       warn "stat($path): $!, quitting ...\n" if $! != ENOENT;
+                       undef $path;
                        $quit->();
                }
                return 1 if defined($path);
@@ -985,18 +994,14 @@ sub lazy_start {
        # STDIN was redirected to /dev/null above, closing STDERR and
        # STDOUT will cause the calling `lei' client process to finish
        # reading the <$daemon> pipe.
-       openlog($path, 'pid', 'user');
        local $SIG{__WARN__} = sub {
-               $current_lei ? err($current_lei, @_) : syslog('warning', "@_");
+               $current_lei ? err($current_lei, @_) : warn(
+                 strftime('%Y-%m-%dT%H:%M:%SZ', gmtime(time))," $$ ", @_);
        };
-       my $on_destroy = PublicInbox::OnDestroy->new($$, sub {
-               syslog('crit', "$@") if $@;
-       });
        open STDERR, '>&STDIN' or die "redirect stderr failed: $!";
        open STDOUT, '>&STDIN' or die "redirect stdout failed: $!";
        # $daemon pipe to `lei' closed, main loop begins:
        PublicInbox::DS->EventLoop;
-       @$on_destroy = (); # cancel on_destroy if we get here
        exit($exit_code // 0);
 }
 
@@ -1008,6 +1013,7 @@ sub oneshot {
        local %PATH2CFG;
        umask(077) // die("umask(077): $!");
        my $self = bless {
+               oneshot => 1,
                0 => *STDIN{GLOB},
                1 => *STDOUT{GLOB},
                2 => *STDERR{GLOB},