package PublicInbox::LEI;
use strict;
use v5.10.1;
-use parent qw(PublicInbox::DS PublicInbox::LeiExternal);
+use parent qw(PublicInbox::DS PublicInbox::LeiExternal
+ PublicInbox::LeiQuery);
use Getopt::Long ();
-use Socket qw(AF_UNIX SOCK_STREAM pack_sockaddr_un);
-use Errno qw(EAGAIN ECONNREFUSED ENOENT);
+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 Sys::Syslog qw(syslog openlog);
use PublicInbox::Config;
-use PublicInbox::Syscall qw(SFD_NONBLOCK EPOLLIN EPOLLONESHOT);
+use PublicInbox::Syscall qw(SFD_NONBLOCK EPOLLIN EPOLLET);
use PublicInbox::Sigfd;
use PublicInbox::DS qw(now dwaitpid);
-use PublicInbox::Spawn qw(spawn run_die);
+use PublicInbox::Spawn qw(spawn run_die popen_rd);
use PublicInbox::OnDestroy;
use Text::Wrap qw(wrap);
use File::Path qw(mkpath);
use File::Spec;
our $quit = \&CORE::exit;
-my $recv_3fds;
+our $current_lei;
+my ($recv_cmd, $send_cmd);
my $GLP = Getopt::Long::Parser->new;
$GLP->configure(qw(gnu_getopt no_ignore_case auto_abbrev));
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:
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!
+ 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]+') ],
'show' => [ 'MID|OID', 'show a given object (Message-ID or object ID)',
'daemon-kill' => [ '[-SIGNAL]', 'signal the lei-daemon',
opt_dash('signal|s=s', '[0-9]+|(?:[A-Z][A-Z0-9]+)') ],
'daemon-pid' => [ '', 'show the PID of the lei-daemon' ],
-'daemon-env' => [ '[NAME=VALUE...]', 'set, unset, or show daemon environment',
- qw(clear| unset|u=s@ z|0) ],
'help' => [ '[SUBCOMMAND]', 'show help' ],
# XXX do we need this?
'output|o=s' => [ 'DEST',
"destination (e.g. `/path/to/Maildir', or `-' for stdout)" ],
+'mua-cmd|mua=s' => [ 'COMMAND',
+ "MUA to run on --output Maildir or mbox (e.g. `mutt -f %f'" ],
'show format|f=s' => [ 'OUT|plain|raw|html|mboxrd|mboxcl2|mboxcl',
'message/object output format' ],
'limit|n=i@' => ['NUM', 'limit on number of matches (default: 10000)' ],
'offset=i' => ['OFF', 'search result offset (default: 0)'],
-'sort|s=s@' => [ 'VAL|internaldate,date,relevance,docid',
+'sort|s=s' => [ 'VAL|received,relevance,docid',
"order of results `--output'-dependent"],
+'reverse|r' => [ 'reverse search results' ], # like sort(1)
'boost=i' => 'increase/decrease priority of results (default: 0)',
# xargs, env, use "-0", git(1) uses "-z". We support z|0 everywhere
'z|0' => 'use NUL \\0 instead of newline (CR) to delimit lines',
-# note: no "--ignore-environment" / "-i" support like env(1) since that
-# is one-shot and this is for a persistent daemon:
-'clear|' => 'clear the daemon environment',
-'unset|u=s@' => ['NAME',
- 'unset matching NAME, may be specified multiple times'],
-
'signal|s=s' => [ 'SIG', 'signal to send lei-daemon (default: TERM)' ],
); # %OPTDESC
'leistore.dir' => 'top-level storage location',
);
-sub x_it ($$) { # pronounced "exit"
+# pronounced "exit": x_it(1 << 8) => exit(1); x_it(13) => SIGPIPE
+sub x_it ($$) {
my ($self, $code) = @_;
- $self->{1}->autoflush(1); # make sure client sees stdout before exit
- if (my $sig = ($code & 127)) {
- kill($sig, $self->{pid} // $$);
- } else {
- $code >>= 8;
- if (my $sock = $self->{sock}) {
- say $sock "exit=$code";
- } else { # for oneshot
- $quit->($code);
- }
+ # make sure client sees stdout before exit
+ $self->{1}->autoflush(1) if $self->{1};
+ if (my $sock = $self->{sock}) {
+ send($sock, "x_it $code", MSG_EOR);
+ } elsif (!($code & 127)) { # oneshot, ignore signals
+ $quit->($code >> 8);
}
}
sub out ($;@) { print { shift->{1} } @_ }
sub err ($;@) {
- print { shift->{2} } @_, (substr($_[-1], -1, 1) eq "\n" ? () : "\n");
+ my $self = shift;
+ my $err = $self->{2} // *STDERR{IO};
+ print $err @_, (substr($_[-1], -1, 1) eq "\n" ? () : "\n");
}
sub qerr ($;@) { $_[0]->{opt}->{quiet} or err(shift, @_) }
undef;
}
+sub atfork_prepare_wq {
+ my ($self, $wq) = @_;
+ my $tcafc = $wq->{-ipc_atfork_child_close};
+ push @$tcafc, @TO_CLOSE_ATFORK_CHILD;
+ if (my $sock = $self->{sock}) {
+ push @$tcafc, @$self{qw(0 1 2)}, $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)};
+ }
+}
+
+# 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;
+ %PATH2CFG = ();
+ $quit = \&CORE::exit;
+ @TO_CLOSE_ATFORK_CHILD = ();
+ (__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(-lei_store cfg pgr lxs)}; # keep l2m
+ my @io = delete @$ret{0..2};
+ $io[3] = delete($ret->{sock}) // *STDERR{GLOB};
+ 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;
+ }
+ }
+ ($ret, @io);
+}
+
sub _help ($;$) {
my ($self, $errmsg) = @_;
my $cmd = $self->{cmd} // 'COMMAND';
sub dispatch {
my ($self, $cmd, @argv) = @_;
- local $SIG{__WARN__} = sub { err($self, @_) };
+ local $current_lei = $self; # for __WARN__
return _help($self, 'no command given') unless defined($cmd);
my $func = "lei_$cmd";
$func =~ tr/-/_/;
my ($self, @argv) = @_;
}
-sub lei_query {
- my ($self, @argv) = @_;
-}
-
sub lei_mark {
my ($self, @argv) = @_;
}
kill($sig, $$) or fail($self, "kill($sig, $$): $!");
}
-sub lei_daemon_env {
- my ($self, @argv) = @_;
- my $opt = $self->{opt};
- if (defined $opt->{clear}) {
- %ENV = ();
- } elsif (my $u = $opt->{unset}) {
- delete @ENV{@$u};
- }
- if (@argv) {
- %ENV = (%ENV, map { split(/=/, $_, 2) } @argv);
- } elsif (!defined($opt->{clear}) && !$opt->{unset}) {
- my $eor = $opt->{z} ? "\0" : "\n";
- my $buf = '';
- while (my ($k, $v) = each %ENV) { $buf .= "$k=$v$eor" }
- out $self, $buf;
- }
-}
-
sub lei_help { _help($_[0]) }
# Shell completion helper. Used by lei-completion.bash and hopefully
dwaitpid($pid, \&reap_exec, $self);
}
+sub exec_buf ($$) {
+ my ($argv, $env) = @_;
+ my $argc = scalar @$argv;
+ my $buf = 'exec '.join("\0", scalar(@$argv), @$argv);
+ while (my ($k, $v) = each %$env) { $buf .= "\0$k=$v" };
+ $buf;
+}
+
+sub start_mua {
+ my ($self, $sock) = @_;
+ 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;
+ push @cmd, $mfolder unless defined($replaced);
+ $sock //= $self->{sock};
+ if ($sock) { # lei(1) client process runs it
+ send($sock, exec_buf(\@cmd, {}), MSG_EOR);
+ } else { # oneshot
+ $self->{"mua.pid.$self.$$"} = spawn(\@cmd);
+ }
+}
+
+# caller needs to "-t $self->{1}" to check if tty
+sub start_pager {
+ my ($self) = @_;
+ my $env = $self->{env};
+ my $fh = popen_rd([qw(git var GIT_PAGER)], $env);
+ chomp(my $pager = <$fh> // '');
+ close($fh) or warn "`git var PAGER' error: \$?=$?";
+ return if $pager eq 'cat' || $pager eq '';
+ # TODO TIOCGWINSZ
+ my $new_env = { LESS => 'FRX', LV => '-c', COLUMNS => 80 };
+ $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}, $$ ];
+ 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 {
+ $pgr->[0] = spawn([$pager], $new_env, $rdr);
+ }
+ $self->{1} = $wpager;
+ $self->{2} = $wpager if -t $self->{2};
+ $env->{GIT_PAGER_IN_USE} = 'true'; # we may spawn git
+ $self->{pgr} = $pgr;
+}
+
+sub stop_pager {
+ my ($self) = @_;
+ my $pgr = delete($self->{pgr}) or return;
+ $self->{2} = $pgr->[2];
+ # 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] == $$;
+}
+
sub accept_dispatch { # Listener {post_accept} callback
my ($sock) = @_; # ignore other
- $sock->blocking(1);
$sock->autoflush(1);
my $self = bless { sock => $sock }, __PACKAGE__;
- vec(my $rin = '', fileno($sock), 1) = 1;
- # `say $sock' triggers "die" in lei(1)
- if (select(my $rout = $rin, undef, undef, 1)) {
- my @fds = $recv_3fds->(fileno($sock));
- if (scalar(@fds) == 3) {
- my $i = 0;
- for my $rdr (qw(<&= >&= >&=)) {
- my $fd = shift(@fds);
- if (open(my $fh, $rdr, $fd)) {
- $self->{$i++} = $fh;
- } else {
- say $sock "open($rdr$fd) (FD=$i): $!";
- return;
- }
- }
- } else {
- say $sock "recv_3fds failed: $!";
- return;
+ vec(my $rvec = '', fileno($sock), 1) = 1;
+ select($rvec, undef, undef, 1) 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) {
+ my $i = 0;
+ for my $rdr (qw(<&= >&= >&= <&=)) {
+ my $fd = shift(@fds);
+ open($self->{$i++}, $rdr, $fd) and next;
+ send($sock, "open($rdr$fd) (FD=$i): $!", MSG_EOR);
}
} else {
- say $sock "timed out waiting to recv FDs";
- return;
+ return send($sock, "recv_cmd failed: $!", MSG_EOR);
}
$self->{2}->autoflush(1); # keep stdout buffered until x_it|DESTROY
- # $ARGV_STR = join("]\0[", @ARGV);
- # $ENV_STR = join('', map { "$_=$ENV{$_}\0" } keys %ENV);
- # $line = "$$\0\0>$ARGV_STR\0\0>$ENV_STR\0\0";
- my ($client_pid, $argv, $env) = do {
- local $/ = "\0\0\0"; # yes, 3 NULs at EOL, not 2
- chomp(my $line = <$sock>);
- split(/\0\0>/, $line, 3);
- };
- my %env = map { split(/=/, $_, 2) } split(/\0/, $env);
- if (chdir($env{PWD})) {
+ # $ENV_STR = join('', map { "\0$_=$ENV{$_}" } keys %ENV);
+ # $buf = "$$\0$argc\0".join("\0", @ARGV).$ENV_STR."\0\0";
+ substr($buf, -2, 2, '') eq "\0\0" or # s/\0\0\z//
+ return send($sock, 'request command truncated', MSG_EOR);
+ my ($argc, @argv) = split(/\0/, $buf, -1);
+ undef $buf;
+ my %env = map { split(/=/, $_, 2) } splice(@argv, $argc);
+ if (chdir(delete($self->{3}))) {
+ local %ENV = %env;
$self->{env} = \%env;
- $self->{pid} = $client_pid;
- eval { dispatch($self, split(/\]\0\[/, $argv)) };
- say $sock $@ if $@;
+ eval { dispatch($self, @argv) };
+ send($sock, $@, MSG_EOR) if $@;
} else {
- say $sock "chdir($env{PWD}): $!"; # implicit close
+ send($sock, "fchdir: $!", MSG_EOR); # implicit close
+ }
+}
+
+sub dclose {
+ my ($self) = @_;
+ delete $self->{lxs}; # stops LeiXSearch queries
+ $self->close if $self->{sock}; # PublicInbox::DS::close
+}
+
+# for long-running results
+sub event_step {
+ my ($self) = @_;
+ local %ENV = %{$self->{env}};
+ my $sock = $self->{sock};
+ eval {
+ while (my @fds = $recv_cmd->($sock, my $buf, 4096)) {
+ if (scalar(@fds) == 1 && !defined($fds[0])) {
+ return if $! == EAGAIN;
+ next if $! == EINTR;
+ last if $! == ECONNRESET;
+ die "recvmsg: $!";
+ }
+ for my $fd (@fds) {
+ open my $rfh, '+<&=', $fd;
+ }
+ die "unrecognized client signal: $buf";
+ }
+ dclose($self);
+ };
+ if (my $err = $@) {
+ eval { $self->fail($err) };
+ dclose($self);
+ }
+}
+
+sub event_step_init {
+ my ($self) = @_;
+ if (my $sock = $self->{sock}) { # using DS->EventLoop
+ $sock->blocking(0);
+ $self->SUPER::new($sock, EPOLLIN|EPOLLET);
}
}
sub noop {}
+our $oldset; sub oldset { $oldset }
+
# lei(1) calls this when it can't connect
sub lazy_start {
- my ($path, $errno, $nfd) = @_;
+ my ($path, $errno, $narg) = @_;
if ($errno == ECONNREFUSED) {
unlink($path) or die "unlink($path): $!";
} elsif ($errno != ENOENT) {
die "connect($path): $!";
}
umask(077) // die("umask(077): $!");
- socket(my $l, AF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
+ 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: $!";
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: $!";
- my $oldset = PublicInbox::Sigfd::block_signals();
- if ($nfd == 1) {
- require IO::FDPass;
- $recv_3fds = sub { map { IO::FDPass::recv($_[0]) } (0..2) };
- } elsif ($nfd == 3) {
- $recv_3fds = PublicInbox::Spawn->can('recv_3fds');
+ local $oldset = PublicInbox::DS::block_signals();
+ if ($narg == 5) {
+ $send_cmd = PublicInbox::Spawn->can('send_cmd4');
+ $recv_cmd = PublicInbox::Spawn->can('recv_cmd4') // do {
+ require PublicInbox::CmdIPC4;
+ $send_cmd = PublicInbox::CmdIPC4->can('send_cmd4');
+ PublicInbox::CmdIPC4->can('recv_cmd4');
+ };
}
- $recv_3fds or die
- "IO::FDPass missing or Inline::C not installed/configured\n";
+ $recv_cmd or die <<"";
+(Socket::MsgHdr || Inline::C) missing/unconfigured (narg=$narg);
+
require PublicInbox::Listener;
require PublicInbox::EOFpipe;
(-p STDOUT) or die "E: stdout must be a pipe\n";
return if $pid;
$0 = "lei-daemon $path";
local %PATH2CFG;
- $_->blocking(0) for ($l, $eof_r, $eof_w);
+ local @TO_CLOSE_ATFORK_CHILD = ($l, $eof_w);
+ $l->blocking(0);
$l = PublicInbox::Listener->new($l, \&accept_dispatch, $l);
my $exit_code;
local $quit = sub {
$exit_code //= shift;
my $listener = $l or exit($exit_code);
- unlink($path) if defined($path);
# closing eof_w triggers \&noop wakeup
$eof_w = $l = $path = undef;
$listener->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,
USR2 => \&noop,
};
my $sigfd = PublicInbox::Sigfd->new($sig, SFD_NONBLOCK);
- local %SIG = (%SIG, %$sig) if !$sigfd;
+ local @SIG{keys %$sig} = values(%$sig) unless $sigfd;
+ undef $sig;
+ local $SIG{PIPE} = 'IGNORE';
if ($sigfd) { # TODO: use inotify/kqueue to detect unlinked sockets
+ undef $sigfd;
PublicInbox::DS->SetLoopTimeout(5000);
} else {
# wake up every second to accept signals if we don't
# have signalfd or IO::KQueue:
- PublicInbox::Sigfd::sig_setmask($oldset);
+ PublicInbox::DS::sig_setmask($oldset);
PublicInbox::DS->SetLoopTimeout(1000);
}
PublicInbox::DS->SetPostLoopCallback(sub {
# STDOUT will cause the calling `lei' client process to finish
# reading the <$daemon> pipe.
openlog($path, 'pid', 'user');
- local $SIG{__WARN__} = sub { syslog('warning', "@_") };
+ local $SIG{__WARN__} = sub {
+ $current_lei ? err($current_lei, @_) : syslog('warning', "@_");
+ };
my $on_destroy = PublicInbox::OnDestroy->new($$, sub {
syslog('crit', "$@") if $@;
});
exit($exit_code // 0);
}
-# for users w/o IO::FDPass
+# for users w/o Socket::Msghdr
sub oneshot {
my ($main_pkg) = @_;
my $exit = $main_pkg->can('exit'); # caller may override exit()
local %PATH2CFG;
umask(077) // die("umask(077): $!");
dispatch((bless {
- 0 => *STDIN{IO},
- 1 => *STDOUT{IO},
- 2 => *STDERR{IO},
+ 0 => *STDIN{GLOB},
+ 1 => *STDOUT{GLOB},
+ 2 => *STDERR{GLOB},
env => \%ENV
}, __PACKAGE__), @ARGV);
}
# ensures stdout hits the FS before sock disconnects so a client
# can immediately reread it
-sub DESTROY { $_[0]->{1}->autoflush(1) }
+sub DESTROY {
+ my ($self) = @_;
+ $self->{1}->autoflush(1) if $self->{1};
+ stop_pager($self);
+ if (my $mua_pid = delete $self->{"mua.pid.$self.$$"}) {
+ waitpid($mua_pid, 0);
+ }
+}
1;