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 PublicInbox::Syscall qw(SFD_NONBLOCK EPOLLIN EPOLLONESHOT);
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;
+my $recv_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:
sub pass_through { $GLP_PASS }
my $OPT;
-sub opt_dash {
+sub opt_dash ($$) {
my ($spec, $re_str) = @_; # 'limit|n=i', '([0-9]+)'
my ($key) = ($spec =~ m/\A([a-z]+)/g);
my $cb = sub { # Getopt::Long "<>" catch-all handler
my ($arg) = @_;
if ($arg =~ /\A-($re_str)\z/) {
$OPT->{$key} = $1;
+ } elsif ($arg eq '--') { # "--" arg separator, ignore first
+ push @{$OPT->{-argv}}, $arg if $OPT->{'--'}++;
+ # lone (single) dash is handled elsewhere
+ } elsif (substr($arg, 0, 1) eq '-') {
+ if ($OPT->{'--'}) {
+ push @{$OPT->{-argv}}, $arg;
+ } else {
+ die "bad argument: $arg\n";
+ }
} else {
- die "bad argument for --$key: $arg\n";
+ push @{$OPT->{-argv}}, $arg;
}
};
- ($spec, '<>' => $cb, $GLP_PASS)
+ ($spec, '<>' => $cb, $GLP_PASS) # for Getopt::Long
}
sub _store_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!
+ sort|s=s reverse|r offset=i remote local! external! pretty
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?
'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
sub x_it ($$) { # pronounced "exit"
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);
- }
+ my $sig = ($code & 127);
+ $code >>= 8 unless $sig;
+ if (my $sock = $self->{sock}) {
+ say $sock "exit=$code";
+ } else { # for oneshot
+ $quit->($code);
}
}
undef;
}
+sub atfork_prepare_wq {
+ my ($self, $wq) = @_;
+ push @{$wq->{-ipc_atfork_child_close}}, @TO_CLOSE_ATFORK_CHILD,
+ grep { defined } @$self{qw(0 1 2 sock)}
+}
+
+# usage: local %SIG = (%SIG, $lei->atfork_child_wq($wq));
+sub atfork_child_wq {
+ my ($self, $wq) = @_;
+ $self->{sock} //= $wq->{0};
+ $self->{$_} //= $wq->{$_} for (0..2);
+ my $oldpipe = $SIG{PIPE};
+ %PATH2CFG = ();
+ @TO_CLOSE_ATFORK_CHILD = ();
+ (
+ __WARN__ => sub { err($self, @_) },
+ PIPE => sub {
+ $self->x_it(141);
+ $oldpipe->() if ref($oldpipe) eq 'CODE';
+ }
+ );
+}
+
+# usage: ($lei, @io) = $lei->atfork_parent_wq($wq);
+sub atfork_parent_wq {
+ my ($self, $wq) = @_;
+ if ($wq->wq_workers) {
+ my $env = delete $self->{env}; # env is inherited at fork
+ my $ret = bless { %$self }, ref($self);
+ $self->{env} = $env;
+ delete @$ret{qw(-lei_store cfg)};
+ my $in = delete $ret->{0};
+ ($ret, delete($ret->{sock}) // $in, delete @$ret{1, 2});
+ } else {
+ ($self, ($self->{sock} // $self->{0}), @$self{1, 2});
+ }
+}
+
sub _help ($;$) {
my ($self, $errmsg) = @_;
my $cmd = $self->{cmd} // 'COMMAND';
return _help($self, "bad arguments or options for $cmd");
return _help($self) if $OPT->{help};
+ push @$argv, @{$OPT->{-argv}} if defined($OPT->{-argv});
+
# "-" aliases "stdin" or "clear"
$OPT->{$lone_dash} = ${$OPT->{$lone_dash}} if defined $lone_dash;
my ($self, @argv) = @_;
}
-sub lei_query {
- my ($self, @argv) = @_;
-}
-
sub lei_mark {
my ($self, @argv) = @_;
}
$dir //= _store_path($env);
$dir = File::Spec->rel2abs($dir, $env->{PWD}); # PWD is symlink-aware
my @cur = stat($cur) if defined($cur);
- $cur = File::Spec->canonpath($cur) if $cur;
+ $cur = File::Spec->canonpath($cur // $dir);
my @dir = stat($dir);
my $exists = "I: leistore.dir=$cur already initialized" if @dir;
if (@cur) {
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);
}
+# 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 '';
+ $env->{LESS} //= 'FRX';
+ $env->{LV} //= '-c';
+ $env->{COLUMNS} //= 80; # TODO TIOCGWINSZ
+ $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} };
+ $self->{1} = $wpager;
+ $self->{2} = $wpager if -t $self->{2};
+ my $pid = spawn([$pager], $env, $rdr);
+ $env->{GIT_PAGER_IN_USE} = 'true'; # we may spawn git
+ [ $pid, @$rdr{1, 2} ];
+}
+
sub accept_dispatch { # Listener {post_accept} callback
my ($sock) = @_; # ignore other
$sock->blocking(1);
my $self = bless { sock => $sock }, __PACKAGE__;
vec(my $rin = '', fileno($sock), 1) = 1;
# `say $sock' triggers "die" in lei(1)
+ my $buf;
if (select(my $rout = $rin, undef, undef, 1)) {
- my @fds = $recv_3fds->(fileno($sock));
+ my @fds = $recv_cmd->($sock, $buf, 4096 * 33); # >MAX_ARG_STRLEN
if (scalar(@fds) == 3) {
my $i = 0;
for my $rdr (qw(<&= >&= >&=)) {
}
}
} else {
- say $sock "recv_3fds failed: $!";
+ say $sock "recv_cmd failed: $!";
return;
}
} else {
return;
}
$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);
+ # $ENV_STR = join('', map { "\0$_=$ENV{$_}" } keys %ENV);
+ # $buf = "$$\0$argc\0".join("\0", @ARGV).$ENV_STR."\0\0";
+ if (substr($buf, -2, 2, '') ne "\0\0") { # s/\0\0\z//
+ say $sock "request command truncated";
+ return;
+ }
+ my ($argc, @argv) = split(/\0/, $buf, -1);
+ undef $buf;
+ my %env = map { split(/=/, $_, 2) } splice(@argv, $argc);
if (chdir($env{PWD})) {
+ local %ENV = %env;
$self->{env} = \%env;
- $self->{pid} = $client_pid;
- eval { dispatch($self, split(/\]\0\[/, $argv)) };
+ eval { dispatch($self, @argv) };
say $sock $@ if $@;
} else {
say $sock "chdir($env{PWD}): $!"; # implicit close
}
}
+# for long-running results
+sub event_step {
+ my ($self) = @_;
+ local %ENV = %{$self->{env}};
+ eval {}; # TODO
+ if ($@) {
+ say { $self->{sock} } $@;
+ $self->close; # PublicInbox::DS::close
+ }
+}
+
sub noop {}
+our $oldset; sub oldset { $oldset }
+
# lei(1) calls this when it can't connect
sub lazy_start {
my ($path, $errno, $nfd) = @_;
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();
+ local $oldset = PublicInbox::DS::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');
+ require PublicInbox::CmdIPC1;
+ $recv_cmd = PublicInbox::CmdIPC1->can('recv_cmd1');
+ } elsif ($nfd == 4) {
+ $recv_cmd = PublicInbox::Spawn->can('recv_cmd4') // do {
+ require PublicInbox::CmdIPC4;
+ 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 || IO::FDPass || Inline::C) missing/unconfigured (nfd=$nfd);
+
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;
+ local @TO_CLOSE_ATFORK_CHILD = ($l, $eof_r, $eof_w);
$_->blocking(0) for ($l, $eof_r, $eof_w);
$l = PublicInbox::Listener->new($l, \&accept_dispatch, $l);
my $exit_code;
};
my $sigfd = PublicInbox::Sigfd->new($sig, SFD_NONBLOCK);
local %SIG = (%SIG, %$sig) if !$sigfd;
+ local $SIG{PIPE} = 'IGNORE';
if ($sigfd) { # TODO: use inotify/kqueue to detect unlinked sockets
+ push @TO_CLOSE_ATFORK_CHILD, $sigfd->{sock};
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 {
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);
+}
1;