X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FLEI.pm;h=bdeab7e39b74f4f90fb0b0331078859f6d30fdc7;hb=cfc2f64069e245a700b60113705be477857c51e5;hp=170231917ccf167ad7bb46842237181b66d259c6;hpb=372ff2ba6467e8fcea3eb19e5527a5fc398802f9;p=public-inbox.git diff --git a/lib/PublicInbox/LEI.pm b/lib/PublicInbox/LEI.pm index 17023191..bdeab7e3 100644 --- a/lib/PublicInbox/LEI.pm +++ b/lib/PublicInbox/LEI.pm @@ -11,22 +11,25 @@ use v5.10.1; 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 POSIX (); +use Socket qw(AF_UNIX SOCK_SEQPACKET MSG_EOR pack_sockaddr_un); +use Errno qw(EPIPE EAGAIN EINTR ECONNREFUSED ENOENT ECONNRESET); +use Cwd qw(getcwd); +use POSIX qw(strftime); use IO::Handle (); -use Sys::Syslog qw(syslog openlog); +use Fcntl qw(SEEK_SET); 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 popen_rd); +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; -my $recv_cmd; +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)); my $GLP_PASS = Getopt::Long::Parser->new; @@ -62,27 +65,56 @@ 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'); +} + +sub index_opt { + # TODO: drop underscore variants everywhere, they're undocumented + qw(fsync|sync! jobs|j=i indexlevel|index-level|L=s compact+ + max_size|max-size=s sequential_shard|sequential-shard + batch_size|batch-size=s skip-docdata quiet|q verbose|v+) } # 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 - since|after=s until|before=s), opt_dash('limit|n=i', '[0-9]+') ], + sort|s=s reverse|r offset=i remote! local! external! pretty + 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]+') ], '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!), @@ -90,10 +122,11 @@ our %CMD = ( # sorted in order of importance/use: 'add-external' => [ 'URL_OR_PATHNAME', 'add/set priority of a publicinbox|extindex for extra matches', - qw(boost=i quiet|q) ], + qw(boost=i c=s@ mirror=s no-torsocks torsocks=s inbox-version=i), + index_opt(), PublicInbox::LeiQuery::curl_opt() ], '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) ], @@ -106,13 +139,13 @@ our %CMD = ( # sorted in order of importance/use: 'exclude mail matching From: or thread from non-Message-ID searches', qw(stdin| thread|t from|f=s mid=s oid=s) ], 'mark' => [ 'MESSAGE_FLAGS...', - 'set/unset flags on message(s) from stdin', + 'set/unset keywords on message(s) from stdin', qw(stdin| oid=s exact by-mid|mid:s) ], 'forget' => [ '[--stdin|--oid=OID|--by-mid=MID]', "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) ], @@ -127,7 +160,8 @@ our %CMD = ( # sorted in order of importance/use: 'add-watch' => [ '[URL_OR_PATHNAME]', 'watch for new messages and flag changes', - qw(import! flags! interval=s recursive|r exclude=s include=s) ], + qw(import! kw|keywords|flags! interval=s recursive|r + exclude=s include=s) ], 'ls-watch' => [ '[FILTER...]', 'list active watches with numbers and status', qw(format|f=s z) ], 'pause-watch' => [ '[WATCH_NUMBER_OR_FILTER]', qw(all local remote) ], @@ -135,9 +169,10 @@ 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}', - 'one-shot import/update from URL or filesystem', - qw(stdin| offset=i recursive|r exclude=s include=s !flags), +'import' => [ 'URLS_OR_PATHNAMES...|--stdin', + 'one-time import/update from URL or filesystem', + qw(stdin| offset=i recursive|r exclude=s include|I=s + format|f=s kw|keywords|flags!), ], 'config' => [ '[...]', sub { @@ -169,14 +204,19 @@ our %CMD = ( # sorted in order of importance/use: # $spec => [@ALLOWED_VALUES (default is first), $description], # $spec => $description # "$SUB_COMMAND TAB $spec" => as above -my $stdin_formats = [ 'IN|auto|raw|mboxrd|mboxcl2|mboxcl|mboxo', - 'specify message input format' ]; +my $stdin_formats = [ 'MAIL_FORMAT|eml|mboxrd|mboxcl2|mboxcl|mboxo', + 'specify message input format' ]; 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', + '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' ], @@ -188,15 +228,30 @@ 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'" ], 'show format|f=s' => [ 'OUT|plain|raw|html|mboxrd|mboxcl2|mboxcl', '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'], +'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' ], + +'import format|f=s' => $stdin_formats, + 'ls-query format|f=s' => $ls_format, 'ls-external format|f=s' => $ls_format, @@ -227,6 +282,8 @@ my %OPTDESC = ( 'by-mid|mid:s' => [ 'MID', 'match only by Message-ID, ignoring contents' ], 'jobs:i' => 'set parallelism level', +'kw|keywords|flags!' => 'disable/enable importing flags', + # 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', @@ -237,45 +294,134 @@ my %CONFIG_KEYS = ( 'leistore.dir' => 'top-level storage location', ); -sub x_it ($$) { # pronounced "exit" +my @WQ_KEYS = qw(lxs l2m imp mrr); # internal workers + +# 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}; + dump_and_clear_log(); + 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 (@WQ_KEYS) { + my $wq = delete $self->{$f} or next; + $wq->DESTROY; } - } + # 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 ($;@) { - print { shift->{2} } @_, (substr($_[-1], -1, 1) eq "\n" ? () : "\n"); + my $self = shift; + 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_handler ($;$$) { + my ($lei, $code, $io) = @_; + for my $f (@WQ_KEYS) { + my $wq = delete $lei->{$f} or next; + $wq->wq_wait_old($lei) if $wq->wq_kill_old; # lei-daemon + } + close($io) if $io; # needed to avoid warnings on SIGPIPE + $lei->x_it($code // (1 >> 8)); +} + +sub sigpipe_handler { # handles SIGPIPE from @WQ_KEYS workers + fail_handler($_[0], 13, delete $_[0]->{1}); +} + 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, $msg) = @_; # child_error is $? + $self->err($msg) if $msg; + 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; + } # else noop if client disconnected +} + +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, $persist) = @_; + # we need to explicitly close things which are on stack + if ($persist) { + my @io = delete @$self{0,1,2}; + unless ($self->{oneshot}) { + close($_) for @io; + } + } else { + delete $self->{0}; + } + for (delete @$self{qw(3 sock old_1 au_done)}) { + close($_) if defined($_); + } + if (my $op_c = delete $self->{pkt_op_c}) { + close(delete $op_c->{sock}); + } + if (my $pgr = delete $self->{pgr}) { + close($_) for (@$pgr[1,2]); + } + close $listener if $listener; + undef $listener; + %PATH2CFG = (); + undef $errors_log; + $quit = \&CORE::exit; + $current_lei = $persist ? undef : $self; # for SIG{__WARN__} +} + sub _help ($;$) { my ($self, $errmsg) = @_; my $cmd = $self->{cmd} // 'COMMAND'; 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) @@ -291,7 +437,7 @@ sub _help ($;$) { my (@vals, @s, @l); my $x = $sw; if ($x =~ s/!\z//) { # solve! => --no-solve - $x = "no-$x"; + $x =~ s/(\A|\|)/$1no-/g } elsif ($x =~ s/:.+//) { # optional args: $x = "mid:s" @vals = (' [', undef, ']'); } elsif ($x =~ s/=.+//) { # required arg: $x = "type=s" @@ -340,7 +486,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; } @@ -385,18 +533,20 @@ 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++; last; } # else continue looping } + last if $ok; my $last = pop @or; $err = join(', ', @or) . " or $last must be set"; } else { @@ -412,7 +562,8 @@ sub optparse ($$$) { sub dispatch { my ($self, $cmd, @argv) = @_; - local $SIG{__WARN__} = sub { err($self, @_) }; + 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/-/_/; @@ -431,7 +582,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 @@ -461,8 +612,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 }); }; } @@ -475,25 +625,36 @@ 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_import { + require PublicInbox::LeiImport; + PublicInbox::LeiImport->call(@_); } 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); @@ -505,7 +666,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)"); @@ -559,36 +720,71 @@ 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 - } else { # negation: solve! => no-solve|solve - s/\A(.+)!\z/no-$1|$1/; + if (s/[:=].+\z//) { # req/optional args, e.g output|o=i + } elsif (s/\+\z//) { # verbose|v+ + } elsif (s/!\z//) { + # negation: solve! => no-solve|solve + s/([\w\-]+)/$1|no-$1/g } 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{$_}; + 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]; + @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); + } # TODO: URLs, pathnames, OIDs, MIDs, etc... See optparse() for # proto parsing. } -sub reap_exec { # dwaitpid callback - my ($self, $pid) = @_; - x_it($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 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 start_mua { + my ($self) = @_; + my $mua = $self->{opt}->{'mua-cmd'} // return; + my $mfolder = $self->{ovv}->{dst}; + 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); + if (my $sock = $self->{sock}) { # lei(1) client process runs it + send($sock, exec_buf(\@cmd, {}), MSG_EOR); + } elsif ($self->{oneshot}) { + $self->{"mua.pid.$self.$$"} = spawn(\@cmd); + } + delete $self->{-progress}; } # caller needs to "-t $self->{1}" to check if tty @@ -599,133 +795,199 @@ sub start_pager { 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'; + # 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); + } 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}; - my $pid = spawn([$pager], $env, $rdr); - dwaitpid($pid, undef, $self->{sock}); $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) if $pid && ($pgr->[3] // 0) == $$; } 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) - my $buf; - if (select(my $rout = $rin, undef, undef, 1)) { - my @fds = $recv_cmd->($sock, $buf, 4096 * 33); # >MAX_ARG_STRLEN - 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_cmd failed: $!"; - return; + vec(my $rvec = '', fileno($sock), 1) = 1; + 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) { + for my $i (0..3) { + my $fd = shift(@fds); + open($self->{$i}, '+<&=', $fd) and next; + send($sock, "open(+<&=$fd) (FD=$i): $!", MSG_EOR); } } else { - say $sock "timed out waiting to recv FDs"; - return; + 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"; - if (substr($buf, -2, 2, '') ne "\0\0") { # s/\0\0\z// - say $sock "request command truncated"; - return; - } - my ($client_pid, $argc, @argv) = split(/\0/, $buf, -1); + # $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($env{PWD})) { + if (chdir($self->{3})) { local %ENV = %env; $self->{env} = \%env; - $self->{pid} = $client_pid + 0; eval { dispatch($self, @argv) }; - say $sock $@ if $@; + 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->{-progress}; + for my $f (@WQ_KEYS) { + my $wq = delete $self->{$f} or next; + if ($wq->wq_kill) { + $wq->wq_close + } elsif ($wq->wq_kill_old) { + $wq->wq_wait_old($self); + } + } + close(delete $self->{1}) if $self->{1}; # may reap_compress + $self->close if $self->{sock}; # PublicInbox::DS::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 + 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])) { + 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 + $self->SUPER::new($sock, EPOLLIN|EPOLLET); } } 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 $/; }; + truncate(STDIN, 0) or warn "ftruncate ($errors_log): $!"; + } +} + # 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) { $! = $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): $!"); - socket(my $l, AF_UNIX, SOCK_STREAM, 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: $!"; - my $oldset = PublicInbox::DS::block_signals(); - if ($nfd == 1) { - require PublicInbox::CmdIPC1; - $recv_cmd = PublicInbox::CmdIPC1->can('recv_cmd1'); - } elsif ($nfd == 4) { + 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_cmd or die <<""; -(Socket::MsgHdr || IO::FDPass || Inline::C) missing/unconfigured (nfd=$nfd); +(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"; - 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; - $_->blocking(0) for ($l, $eof_r, $eof_w); - $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); - unlink($path) if defined($path); - # 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); my $sig = { CHLD => \&PublicInbox::DS::enqueue_reap, QUIT => $quit, @@ -736,8 +998,11 @@ sub lazy_start { 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 @@ -752,9 +1017,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); @@ -774,39 +1039,44 @@ 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 { syslog('warning', "@_") }; - my $on_destroy = PublicInbox::OnDestroy->new($$, sub { - syslog('crit', "$@") if $@; - }); + local $SIG{__WARN__} = sub { + $current_lei ? err($current_lei, @_) : warn( + strftime('%Y-%m-%dT%H:%M:%SZ', gmtime(time))," $$ ", @_); + }; 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); } -# for users w/o IO::FDPass +# 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 { + oneshot => 1, 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 # can immediately reread it sub DESTROY { my ($self) = @_; - $self->{1}->autoflush(1); + $self->{1}->autoflush(1) if $self->{1}; + stop_pager($self); + if (my $mua_pid = delete $self->{"mua.pid.$self.$$"}) { + waitpid($mua_pid, 0); + } } 1;