]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/LEI.pm
lei q: disable remote externals if locals exist
[public-inbox.git] / lib / PublicInbox / LEI.pm
index 802d2cd95396871bb18f3f110f4f7a04fc21e44b..378113e8446a4179ef1ac78456004541d0b53677 100644 (file)
@@ -15,18 +15,19 @@ use Socket qw(AF_UNIX SOCK_SEQPACKET MSG_EOR pack_sockaddr_un);
 use Errno qw(EAGAIN EINTR ECONNREFUSED ENOENT ECONNRESET);
 use POSIX ();
 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;
 use PublicInbox::DS qw(now dwaitpid);
-use PublicInbox::Spawn qw(spawn run_die popen_rd);
+use PublicInbox::Spawn qw(spawn popen_rd);
 use PublicInbox::OnDestroy;
 use Text::Wrap qw(wrap);
 use File::Path qw(mkpath);
 use File::Spec;
 our $quit = \&CORE::exit;
-our $current_lei;
+our ($current_lei, $errors_log, $listener);
 my ($recv_cmd, $send_cmd);
 my $GLP = Getopt::Long::Parser->new;
 $GLP->configure(qw(gnu_getopt no_ignore_case auto_abbrev));
@@ -34,7 +35,6 @@ my $GLP_PASS = Getopt::Long::Parser->new;
 $GLP_PASS->configure(qw(gnu_getopt no_ignore_case auto_abbrev pass_through));
 
 our %PATH2CFG; # persistent for socket daemon
-our @TO_CLOSE_ATFORK_CHILD;
 
 # TBD: this is a documentation mechanism to show a subcommand
 # (may) pass options through to another command:
@@ -83,8 +83,9 @@ sub _config_path ($) {
 our %CMD = ( # sorted in order of importance/use:
 'q' => [ '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=s
-       since|after=s until|before=s), opt_dash('limit|n=i', '[0-9]+') ],
+       sort|s=s reverse|r offset=i remote! local! external! pretty mua-cmd=s
+       torsocks=s no-torsocks verbose|v since|after=s until|before=s),
+       PublicInbox::LeiQuery::curl_opt(), 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!),
@@ -95,7 +96,7 @@ our %CMD = ( # sorted in order of importance/use:
        qw(boost=i quiet|q) ],
 'ls-external' => [ '[FILTER...]', 'list publicinbox|extindex locations',
        qw(format|f=s z|0 local remote quiet|q) ],
-'forget-external' => [ '{URL_OR_PATHNAME|--prune}',
+'forget-external' => [ 'URL_OR_PATHNAME...|--prune',
        'exclude further results from a publicinbox|extindex',
        qw(prune quiet|q) ],
 
@@ -114,7 +115,7 @@ our %CMD = ( # sorted in order of importance/use:
        "exclude message(s) on stdin from `q' search results",
        qw(stdin| oid=s exact by-mid|mid:s quiet|q) ],
 
-'purge-mailsource' => [ '{URL_OR_PATHNAME|--all}',
+'purge-mailsource' => [ 'URL_OR_PATHNAME|--all',
        'remove imported messages from IMAP, Maildirs, and MH',
        qw(exact! all jobs:i indexed) ],
 
@@ -137,7 +138,7 @@ our %CMD = ( # sorted in order of importance/use:
 'forget-watch' => [ '{WATCH_NUMBER|--prune}', 'stop and forget a watch',
        qw(prune) ],
 
-'import' => [ '{URL_OR_PATHNAME|--stdin}',
+'import' => [ 'URL_OR_PATHNAME|--stdin',
        'one-shot import/update from URL or filesystem',
        qw(stdin| offset=i recursive|r exclude=s include=s !flags),
        ],
@@ -246,9 +247,15 @@ sub x_it ($$) {
        my ($self, $code) = @_;
        # 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
+               # 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);
        }
 }
@@ -259,7 +266,7 @@ sub out ($;@) { print { shift->{1} } @_ }
 
 sub err ($;@) {
        my $self = shift;
-       my $err = $self->{2} // *STDERR{IO};
+       my $err = $self->{2} // ($self->{pgr} // [])->[2] // *STDERR{IO};
        print $err @_, (substr($_[-1], -1, 1) eq "\n" ? () : "\n");
 }
 
@@ -272,13 +279,28 @@ sub fail ($$;$) {
        undef;
 }
 
+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
+               $self->{child_error} = $child_error;
+       }
+       undef;
+}
+
 sub atfork_prepare_wq {
        my ($self, $wq) = @_;
-       my $tcafc = $wq->{-ipc_atfork_child_close};
-       push @$tcafc, @TO_CLOSE_ATFORK_CHILD;
+       my $tcafc = $wq->{-ipc_atfork_child_close} //= [ $listener // () ];
        if (my $sock = $self->{sock}) {
                push @$tcafc, @$self{qw(0 1 2)}, $sock;
        }
+       if (my $pgr = $self->{pgr}) {
+               push @$tcafc, @$pgr[1,2];
+       }
+       if (my $old_1 = $self->{old_1}) {
+               push @$tcafc, $old_1;
+       }
        for my $f (qw(lxs l2m)) {
                my $ipc = $self->{$f} or next;
                push @$tcafc, grep { defined }
@@ -295,8 +317,8 @@ sub atfork_child_wq {
        $self->{sock} = $sock if -S $sock;
        $self->{l2m}->{-wq_s1} = $l2m_wq_s1 if $l2m_wq_s1 && -S $l2m_wq_s1;
        %PATH2CFG = ();
+       undef $errors_log;
        $quit = \&CORE::exit;
-       @TO_CLOSE_ATFORK_CHILD = ();
        (__WARN__ => sub { err($self, @_) },
        PIPE => sub {
                $self->x_it(13); # SIGPIPE = 13
@@ -321,15 +343,13 @@ sub atfork_parent_wq {
                $ret->{dedupe} = $wq->deep_clone($dedupe);
        }
        $self->{env} = $env;
-       delete @$ret{qw(-lei_store cfg pgr lxs)}; # keep l2m
+       delete @$ret{qw(-lei_store cfg old_1 pgr lxs)}; # keep l2m
        my @io = delete @$ret{0..2};
-       $io[3] = delete($ret->{sock}) // *STDERR{GLOB};
+       $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};
-               if (my @pids = $l2m->wq_close) {
-                       $wq->{l2m_pids} = \@pids;
-               }
+               $l2m->wq_close(1);
        }
        ($ret, @io);
 }
@@ -462,6 +482,7 @@ sub optparse ($$$) {
                                        last;
                                } # else continue looping
                        }
+                       last if $ok;
                        my $last = pop @or;
                        $err = join(', ', @or) . " or $last must be set";
                } else {
@@ -478,6 +499,7 @@ sub optparse ($$$) {
 sub dispatch {
        my ($self, $cmd, @argv) = @_;
        local $current_lei = $self; # for __WARN__
+       dump_and_clear_log("from previous run\n");
        return _help($self, 'no command given') unless defined($cmd);
        my $func = "lei_$cmd";
        $func =~ tr/-/_/;
@@ -540,16 +562,23 @@ sub lei_mark {
        my ($self, @argv) = @_;
 }
 
-sub lei_config {
+sub _config {
        my ($self, @argv) = @_;
-       $self->{opt}->{'config-file'} and return fail $self,
-               "config file switches not supported by `lei config'";
        my $env = $self->{env};
        delete local $env->{GIT_CONFIG};
+       delete local $ENV{GIT_CONFIG};
        my $cfg = _lei_cfg($self, 1);
        my $cmd = [ qw(git config -f), $cfg->{'-f'}, @argv ];
        my %rdr = map { $_ => $self->{$_} } (0..2);
-       run_die($cmd, $env, \%rdr);
+       waitpid(spawn($cmd, $env, \%rdr), 0);
+}
+
+sub lei_config {
+       my ($self, @argv) = @_;
+       $self->{opt}->{'config-file'} and return fail $self,
+               "config file switches not supported by `lei config'";
+       _config(@_);
+       x_it($self, $?) if $?;
 }
 
 sub lei_init {
@@ -640,6 +669,10 @@ sub lei__complete {
        } elsif ($cmd eq 'config' && !@argv && !$CONFIG_KEYS{$cur}) {
                puts $self, grep(/$re/, keys %CONFIG_KEYS);
        }
+       $cmd =~ tr/-/_/;
+       if (my $sub = $self->can("_complete_$cmd")) {
+               puts $self, $sub->($self, @argv, $cur);
+       }
        # TODO: URLs, pathnames, OIDs, MIDs, etc...  See optparse() for
        # proto parsing.
 }
@@ -665,17 +698,21 @@ sub exec_buf ($$) {
 }
 
 sub start_mua {
-       my ($self, $sock) = @_;
+       my ($self) = @_;
        my $mua = $self->{opt}->{'mua-cmd'} // return;
        my $mfolder = $self->{ovv}->{dst};
-       require Text::ParseWords;
-       my $replaced;
-       my @cmd = Text::ParseWords::shellwords($mua);
-       # mutt uses '%f' for open-hook with compressed folders, so we use %f
-       @cmd = map { $_ eq '%f' ? ($replaced = $mfolder) : $_ } @cmd;
+       my (@cmd, $replaced);
+       if ($mua =~ /\A(?:mutt|mailx|mail|neomutt)\z/) {
+               @cmd = ($mua, '-f');
+       # TODO: help wanted: other common FOSS MUAs
+       } else {
+               require Text::ParseWords;
+               my @cmd = Text::ParseWords::shellwords($mua);
+               # mutt uses '%f' for open-hook with compressed mbox, we follow
+               @cmd = map { $_ eq '%f' ? ($replaced = $mfolder) : $_ } @cmd;
+       }
        push @cmd, $mfolder unless defined($replaced);
-       $sock //= $self->{sock};
-       if ($sock) { # lei(1) client process runs it
+       if (my $sock = $self->{sock}) { # lei(1) client process runs it
                send($sock, exec_buf(\@cmd, {}), MSG_EOR);
        } else { # oneshot
                $self->{"mua.pid.$self.$$"} = spawn(\@cmd);
@@ -728,11 +765,10 @@ sub accept_dispatch { # Listener {post_accept} callback
                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) {
-               my $i = 0;
-               for my $rdr (qw(<&= >&= >&= <&=)) {
+               for my $i (0..3) {
                        my $fd = shift(@fds);
-                       open($self->{$i++}, $rdr, $fd) and next;
-                       send($sock, "open($rdr$fd) (FD=$i): $!", MSG_EOR);
+                       open($self->{$i}, '+<&=', $fd) and next;
+                       send($sock, "open(+<&=$fd) (FD=$i): $!", MSG_EOR);
                }
        } else {
                return send($sock, "recv_cmd failed: $!", MSG_EOR);
@@ -757,7 +793,15 @@ sub accept_dispatch { # Listener {post_accept} callback
 
 sub dclose {
        my ($self) = @_;
-       delete $self->{lxs}; # stops LeiXSearch queries
+       for my $f (qw(lxs l2m)) {
+               my $wq = delete $self->{$f} or next;
+               if ($wq->wq_kill) {
+                       $self->wq_close
+               } elsif ($wq->wq_kill_old) {
+                       $wq->wq_wait_old;
+               }
+       }
+       close(delete $self->{1}) if $self->{1}; # may reap_compress
        $self->close if $self->{sock}; # PublicInbox::DS::close
 }
 
@@ -766,6 +810,7 @@ sub event_step {
        my ($self) = @_;
        local %ENV = %{$self->{env}};
        my $sock = $self->{sock};
+       local $current_lei = $self;
        eval {
                while (my @fds = $recv_cmd->($sock, my $buf, 4096)) {
                        if (scalar(@fds) == 1 && !defined($fds[0])) {
@@ -799,6 +844,15 @@ sub noop {}
 
 our $oldset; sub oldset { $oldset }
 
+sub dump_and_clear_log {
+       if (defined($errors_log) && -s STDIN && seek(STDIN, 0, SEEK_SET)) {
+               my @pfx = @_;
+               unshift(@pfx, "$errors_log ") if @pfx;
+               warn @pfx, do { local $/; <STDIN> };
+               truncate(STDIN, 0) or warn "ftruncate ($errors_log): $!";
+       }
+}
+
 # lei(1) calls this when it can't connect
 sub lazy_start {
        my ($path, $errno, $narg) = @_;
@@ -809,12 +863,12 @@ sub lazy_start {
                die "connect($path): $!";
        }
        umask(077) // die("umask(077): $!");
-       socket(my $l, AF_UNIX, SOCK_SEQPACKET, 0) or die "socket: $!";
-       bind($l, pack_sockaddr_un($path)) or die "bind($path): $!";
-       listen($l, 1024) or die "listen: $!";
+       local $listener;
+       socket($listener, AF_UNIX, SOCK_SEQPACKET, 0) or die "socket: $!";
+       bind($listener, pack_sockaddr_un($path)) or die "bind($path): $!";
+       listen($listener, 1024) or die "listen: $!";
        my @st = stat($path) or die "stat($path): $!";
        my $dev_ino_expect = pack('dd', $st[0], $st[1]); # dev+ino
-       pipe(my ($eof_r, $eof_w)) or die "pipe: $!";
        local $oldset = PublicInbox::DS::block_signals();
        if ($narg == 5) {
                $send_cmd = PublicInbox::Spawn->can('send_cmd4');
@@ -830,26 +884,32 @@ sub lazy_start {
        require PublicInbox::Listener;
        require PublicInbox::EOFpipe;
        (-p STDOUT) or die "E: stdout must be a pipe\n";
-       open(STDIN, '+<', '/dev/null') or die "redirect stdin failed: $!";
+       local $errors_log;
+       ($errors_log) = ($path =~ m!\A(.+?/)[^/]+\z!);
+       $errors_log .= 'errors.log';
+       open(STDIN, '+>>', $errors_log) or die "open($errors_log): $!";
+       STDIN->autoflush(1);
+       dump_and_clear_log("from previous daemon process:\n");
        POSIX::setsid() > 0 or die "setsid: $!";
        my $pid = fork // die "fork: $!";
        return if $pid;
        $0 = "lei-daemon $path";
        local %PATH2CFG;
-       local @TO_CLOSE_ATFORK_CHILD = ($l, $eof_w);
-       $l->blocking(0);
-       $l = PublicInbox::Listener->new($l, \&accept_dispatch, $l);
+       $listener->blocking(0);
        my $exit_code;
-       local $quit = sub {
-               $exit_code //= shift;
-               my $listener = $l or exit($exit_code);
-               # closing eof_w triggers \&noop wakeup
-               $eof_w = $l = $path = undef;
-               $listener->close; # DS::close
-               PublicInbox::DS->SetLoopTimeout(1000);
+       my $pil = PublicInbox::Listener->new($listener, \&accept_dispatch);
+       local $quit = do {
+               pipe(my ($eof_r, $eof_w)) or die "pipe: $!";
+               PublicInbox::EOFpipe->new($eof_r, \&noop, undef);
+               sub {
+                       $exit_code //= shift;
+                       my $lis = $pil or exit($exit_code);
+                       # closing eof_w triggers \&noop wakeup
+                       $listener = $eof_w = $pil = $path = undef;
+                       $lis->close; # DS::close
+                       PublicInbox::DS->SetLoopTimeout(1000);
+               };
        };
-       PublicInbox::EOFpipe->new($eof_r, \&noop, undef);
-       undef $eof_r;
        my $sig = {
                CHLD => \&PublicInbox::DS::enqueue_reap,
                QUIT => $quit,
@@ -916,19 +976,21 @@ sub lazy_start {
        exit($exit_code // 0);
 }
 
-# for users w/o Socket::Msghdr
+# for users w/o Socket::Msghdr installed or Inline::C enabled
 sub oneshot {
        my ($main_pkg) = @_;
        my $exit = $main_pkg->can('exit'); # caller may override exit()
        local $quit = $exit if $exit;
        local %PATH2CFG;
        umask(077) // die("umask(077): $!");
-       dispatch((bless {
+       my $self = bless {
                0 => *STDIN{GLOB},
                1 => *STDOUT{GLOB},
                2 => *STDERR{GLOB},
                env => \%ENV
-       }, __PACKAGE__), @ARGV);
+       }, __PACKAGE__;
+       dispatch($self, @ARGV);
+       x_it($self, $self->{child_error}) if $self->{child_error};
 }
 
 # ensures stdout hits the FS before sock disconnects so a client