X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FLEI.pm;h=6c2515dc0eb74cf37530445e27acb44134d44702;hb=7349713101700e488231ad9ffece8ee42de0928c;hp=473a28a99ccdc5645e948408cb9d0bf308802030;hpb=c80fc47e280a500ff8d6c3fde53e7554272e749b;p=public-inbox.git diff --git a/lib/PublicInbox/LEI.pm b/lib/PublicInbox/LEI.pm index 473a28a9..6c2515dc 100644 --- a/lib/PublicInbox/LEI.pm +++ b/lib/PublicInbox/LEI.pm @@ -12,11 +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 POSIX (); +use Errno qw(EPIPE EAGAIN EINTR ECONNREFUSED ENOENT ECONNRESET); +use Cwd qw(getcwd); +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; @@ -24,6 +24,7 @@ use PublicInbox::DS qw(now dwaitpid); use PublicInbox::Spawn qw(spawn popen_rd); use PublicInbox::OnDestroy; use Text::Wrap qw(wrap); +use Time::HiRes qw(stat); # ctime comparisons for config cache use File::Path qw(mkpath); use File::Spec; our $quit = \&CORE::exit; @@ -64,18 +65,37 @@ sub opt_dash ($$) { ($spec, '<>' => $cb, $GLP_PASS) # for Getopt::Long } +sub rel2abs ($$) { + my ($self, $p) = @_; + return $p if index($p, '/') == 0; # already absolute + my $pwd = $self->{env}->{PWD}; + if (defined $pwd) { + my $cwd = $self->{3} // getcwd() // die "getcwd(PWD=$pwd): $!"; + if (my @st_pwd = stat($pwd)) { + my @st_cwd = stat($cwd) or die "stat($cwd): $!"; + "@st_pwd[1,0]" eq "@st_cwd[1,0]" or + $self->{env}->{PWD} = $pwd = $cwd; + } else { # PWD was invalid + delete $self->{env}->{PWD}; + undef $pwd; + } + } + $pwd //= $self->{env}->{PWD} = getcwd() // die "getcwd(PWD=$pwd): $!"; + File::Spec->rel2abs($p, $pwd); +} + sub _store_path ($) { - my ($env) = @_; - File::Spec->rel2abs(($env->{XDG_DATA_HOME} // - ($env->{HOME} // '/nonexistent').'/.local/share') - .'/lei/store', $env->{PWD}); + my ($self) = @_; + rel2abs($self, ($self->{env}->{XDG_DATA_HOME} // + ($self->{env}->{HOME} // '/nonexistent').'/.local/share') + .'/lei/store'); } sub _config_path ($) { - my ($env) = @_; - File::Spec->rel2abs(($env->{XDG_CONFIG_HOME} // - ($env->{HOME} // '/nonexistent').'/.config') - .'/lei/config', $env->{PWD}); + my ($self) = @_; + rel2abs($self, ($self->{env}->{XDG_CONFIG_HOME} // + ($self->{env}->{HOME} // '/nonexistent').'/.config') + .'/lei/config'); } # TODO: generate shell completion + help using %CMD and %OPTDESC @@ -83,8 +103,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 - torsocks=s no-torsocks verbose|v since|after=s until|before=s), + sort|s=s reverse|r offset=i remote! local! external! pretty + 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]+') ], 'show' => [ 'MID|OID', 'show a given object (Message-ID or object ID)', @@ -179,7 +200,11 @@ my $ls_format = [ 'OUT|plain|json|null', 'listing output format' ]; my %OPTDESC = ( 'help|h' => 'show this built-in help', 'quiet|q' => 'be quiet', +'verbose|v' => 'be more verbose', 'solve!' => 'do not attempt to reconstruct blobs from emails', +'torsocks=s' => ['auto|no|yes', + 'whether or not to wrap git and curl commands with torsocks'], +'no-torsocks' => 'alias for --torsocks=no', 'save-as=s' => ['NAME', 'save a search terms by given name'], 'type=s' => [ 'any|mid|git', 'disambiguate type' ], @@ -191,7 +216,7 @@ my %OPTDESC = ( 'return all messages in the same thread as the actual match(es)', 'augment|a' => 'augment --output destination instead of clobbering', -'output|o=s' => [ 'DEST', +'output|mfolder|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'" ], @@ -200,7 +225,8 @@ my %OPTDESC = ( 'message/object output format' ], 'mark format|f=s' => $stdin_formats, 'forget format|f=s' => $stdin_formats, -'q format|f=s' => [ 'OUT|maildir|mboxrd|mboxcl2|mboxcl|html|oid|json', +'q format|f=s' => [ + 'OUT|maildir|mboxrd|mboxcl2|mboxcl|mboxo|html|json|jsonl|concatjson', 'specify output format, default depends on --output'], 'ls-query format|f=s' => $ls_format, 'ls-external format|f=s' => $ls_format, @@ -250,7 +276,11 @@ sub x_it ($$) { dump_and_clear_log(); if (my $sock = $self->{sock}) { send($sock, "x_it $code", MSG_EOR); - } elsif (!($code & 127)) { # oneshot, ignore signals + } elsif (my $signum = ($code & 127)) { # oneshot, usually SIGPIPE (13) + $SIG{PIPE} = 'DEFAULT'; # $SIG{$signum} doesn't work + kill $signum, $$; + sleep; # wait for signal + } else { # oneshot # don't want to end up using $? from child processes for my $f (qw(lxs l2m)) { my $wq = delete $self->{$f} or next; @@ -260,25 +290,38 @@ sub x_it ($$) { } } -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; + send($self->{pkt_op}, '!', MSG_EOR) if $self->{pkt_op}; # fail_handler 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 @@ -293,7 +336,7 @@ 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)}, $sock; + push @$tcafc, @$self{qw(0 1 2 3)}, $sock; } if (my $pgr = $self->{pgr}) { push @$tcafc, @$pgr[1,2]; @@ -308,50 +351,73 @@ sub atfork_prepare_wq { } } -# usage: my %sig = $lei->atfork_child_wq($wq); -# local @SIG{keys %sig} = values %sig; +sub io_restore ($$) { + my ($dst, $src) = @_; + for my $i (0..2) { # standard FDs + my $io = delete $src->{$i} or next; + $dst->{$i} = $io; + } + for my $i (3..9) { # named (non-standard) FDs + my $io = $src->{$i} or next; + my @st = stat($io) or die "stat $src.$i ($io): $!"; + my $f = delete $dst->{"dev=$st[0],ino=$st[1]"} // next; + $dst->{$f} = $io; + delete $src->{$i}; + } +} + +sub note_sigpipe { # triggers sigpipe_handler + my ($self, $fd) = @_; + close(delete($self->{$fd})); # explicit close silences Perl warning + send($self->{pkt_op}, '|', MSG_EOR) if $self->{pkt_op}; + x_it($self, 13); +} + 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; + io_restore($self, $wq); + -S $self->{pkt_op} or die 'BUG: {pkt_op} expected'; + io_restore($self->{l2m}, $wq); %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'), - }); + $current_lei = $self; # for SIG{__WARN__} +} + +sub io_extract ($;@) { + my ($obj, @fields) = @_; + my @io; + for my $f (@fields) { + my $io = delete $obj->{$f} or next; + my @st = stat($io) or die "W: stat $obj.$f ($io): $!"; + $obj->{"dev=$st[0],ino=$st[1]"} = $f; + push @io, $io; + } + @io } # 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); + my $lei = bless { %$self }, ref($self); + for my $f (qw(dedupe ovv)) { + my $tmp = delete($lei->{$f}) or next; + $lei->{$f} = $wq->deep_clone($tmp); } $self->{env} = $env; - delete @$ret{qw(-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}; + delete @$lei{qw(3 -lei_store cfg old_1 pgr lxs)}; # keep l2m + my @io = (delete(@$lei{qw(0 1 2)}), + io_extract($lei, qw(sock pkt_op startq))); + my $l2m = $lei->{l2m}; if ($l2m && $l2m != $wq) { # $wq == lxs - $io[4] = $l2m->{-wq_s1} if $l2m->{-wq_s1}; + if (my $wq_s1 = $l2m->{-wq_s1}) { + push @io, io_extract($l2m, '-wq_s1'); + $l2m->{-wq_s1} = $wq_s1; + } $l2m->wq_close(1); } - ($ret, @io); + ($lei, @io); } sub _help ($;$) { @@ -360,7 +426,7 @@ sub _help ($;$) { my @info = @{$CMD{$cmd} // [ '...', '...' ]}; my @top = ($cmd, shift(@info) // ()); my $cmd_desc = shift(@info); - $cmd_desc = $cmd_desc->($self->{env}) if ref($cmd_desc) eq 'CODE'; + $cmd_desc = $cmd_desc->($self) if ref($cmd_desc) eq 'CODE'; my @opt_desc; my $lpad = 2; for my $sw (grep { !ref } @info) { # ("prio=s", "z", $GLP_PASS) @@ -518,7 +584,7 @@ sub dispatch { sub _lei_cfg ($;$) { my ($self, $creat) = @_; - my $f = _config_path($self->{env}); + my $f = _config_path($self); my @st = stat($f); my $cur_st = @st ? pack('dd', $st[10], $st[7]) : ''; # 10:ctime, 7:size if (my $cfg = $PATH2CFG{$f}) { # reuse existing object in common case @@ -548,8 +614,7 @@ sub _lei_store ($;$) { $cfg->{-lei_store} //= do { require PublicInbox::LeiStore; my $dir = $cfg->{'leistore.dir'}; - $dir //= _store_path($self->{env}) if $creat; - return unless $dir; + $dir //= $creat ? _store_path($self) : return; PublicInbox::LeiStore->new($dir, { creat => $creat }); }; } @@ -585,9 +650,8 @@ sub lei_init { my ($self, $dir) = @_; my $cfg = _lei_cfg($self, 1); my $cur = $cfg->{'leistore.dir'}; - my $env = $self->{env}; - $dir //= _store_path($env); - $dir = File::Spec->rel2abs($dir, $env->{PWD}); # PWD is symlink-aware + $dir //= _store_path($self); + $dir = rel2abs($self, $dir); my @cur = stat($cur) if defined($cur); $cur = File::Spec->canonpath($cur // $dir); my @dir = stat($dir); @@ -599,7 +663,7 @@ sub lei_init { } # some folks like symlinks and bind mounts :P - if (@dir && "$cur[0] $cur[1]" eq "$dir[0] $dir[1]") { + if (@dir && "@cur[1,0]" eq "@dir[1,0]") { lei_config($self, 'leistore.dir', $dir); _lei_store($self, 1)->done; return qerr($self, "$exists (as $cur)"); @@ -653,22 +717,33 @@ sub lei__complete { get-color-name get-colorbool); # fall-through } - # TODO: arg support puts $self, grep(/$re/, map { # generate short/long names - my $eq = ''; - if (s/=.+\z//) { # required arg, e.g. output|o=i - $eq = '='; - } elsif (s/:.+\z//) { # optional arg, e.g. mid:s + if (s/[:=].+\z//) { # req/optional args, e.g output|o=i } else { # negation: solve! => no-solve|solve s/\A(.+)!\z/no-$1|$1/; } map { - length > 1 ? "--$_$eq" : "-$_" + my $x = length > 1 ? "--$_" : "-$_"; + $x eq $cur ? () : $x; } split(/\|/, $_, -1) # help|h } grep { $OPTDESC{"$cmd\t$_"} || $OPTDESC{$_} } @spec); } elsif ($cmd eq 'config' && !@argv && !$CONFIG_KEYS{$cur}) { puts $self, grep(/$re/, keys %CONFIG_KEYS); } + + # switch args (e.g. lei q -f mbox) + if (($argv[-1] // $cur // '') =~ /\A--?([\w\-]+)\z/) { + my $opt = quotemeta $1; + puts $self, map { + my $v = $OPTDESC{$_}; + $v = $v->[0] if ref($v); + my @v = split(/\|/, $v); + # get rid of ALL CAPS placeholder (e.g "OUT") + # (TODO: completion for external paths) + shift(@v) if uc($v[0]) eq $v[0]; + @v; + } grep(/\A(?:$cmd\t|)(?:[\w-]+\|)*$opt\b/, keys %OPTDESC); + } $cmd =~ tr/-/_/; if (my $sub = $self->can("_complete_$cmd")) { puts $self, $sub->($self, @argv, $cur); @@ -677,18 +752,6 @@ sub lei__complete { # proto parsing. } -sub reap_exec { # dwaitpid callback - my ($self, $pid) = @_; - x_it($self, $?); -} - -sub lei_git { # support passing through random git commands - my ($self, @argv) = @_; - my %rdr = map { $_ => $self->{$_} } (0..2); - my $pid = spawn(['git', @argv], $self->{env}, \%rdr); - dwaitpid($pid, \&reap_exec, $self); -} - sub exec_buf ($$) { my ($argv, $env) = @_; my $argc = scalar @$argv; @@ -761,7 +824,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) { @@ -771,17 +834,19 @@ 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); - # $buf = "$$\0$argc\0".join("\0", @ARGV).$ENV_STR."\0\0"; + # $buf = "$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}))) { + if (chdir($self->{3})) { local %ENV = %env; $self->{env} = \%env; eval { dispatch($self, @argv) }; @@ -796,9 +861,9 @@ sub dclose { for my $f (qw(lxs l2m)) { my $wq = delete $self->{$f} or next; if ($wq->wq_kill) { - $self->wq_close + $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 @@ -835,7 +900,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); } } @@ -862,6 +926,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: $!"; @@ -939,9 +1008,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); @@ -961,18 +1030,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); }