1 # Copyright (C) 2020-2021 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # Backend for `lei' (local email interface). Unlike the C10K-oriented
5 # PublicInbox::Daemon, this is designed exclusively to handle trusted
6 # local clients with read/write access to the FS and use as many
7 # system resources as the local user has access to.
8 package PublicInbox::LEI;
11 use parent qw(PublicInbox::DS PublicInbox::LeiExternal
12 PublicInbox::LeiQuery);
14 use Socket qw(AF_UNIX SOCK_STREAM pack_sockaddr_un);
15 use Errno qw(EAGAIN ECONNREFUSED ENOENT);
18 use Sys::Syslog qw(syslog openlog);
19 use PublicInbox::Config;
20 use PublicInbox::Syscall qw(SFD_NONBLOCK EPOLLIN EPOLLONESHOT);
21 use PublicInbox::Sigfd;
22 use PublicInbox::DS qw(now dwaitpid);
23 use PublicInbox::Spawn qw(spawn run_die popen_rd);
24 use PublicInbox::OnDestroy;
25 use Text::Wrap qw(wrap);
26 use File::Path qw(mkpath);
28 our $quit = \&CORE::exit;
30 my $GLP = Getopt::Long::Parser->new;
31 $GLP->configure(qw(gnu_getopt no_ignore_case auto_abbrev));
32 my $GLP_PASS = Getopt::Long::Parser->new;
33 $GLP_PASS->configure(qw(gnu_getopt no_ignore_case auto_abbrev pass_through));
35 our %PATH2CFG; # persistent for socket daemon
37 # TBD: this is a documentation mechanism to show a subcommand
38 # (may) pass options through to another command:
39 sub pass_through { $GLP_PASS }
43 my ($spec, $re_str) = @_; # 'limit|n=i', '([0-9]+)'
44 my ($key) = ($spec =~ m/\A([a-z]+)/g);
45 my $cb = sub { # Getopt::Long "<>" catch-all handler
47 if ($arg =~ /\A-($re_str)\z/) {
49 } elsif ($arg eq '--') { # "--" arg separator, ignore first
50 push @{$OPT->{-argv}}, $arg if $OPT->{'--'}++;
51 # lone (single) dash is handled elsewhere
52 } elsif (substr($arg, 0, 1) eq '-') {
54 push @{$OPT->{-argv}}, $arg;
56 die "bad argument: $arg\n";
59 push @{$OPT->{-argv}}, $arg;
62 ($spec, '<>' => $cb, $GLP_PASS) # for Getopt::Long
67 File::Spec->rel2abs(($env->{XDG_DATA_HOME} //
68 ($env->{HOME} // '/nonexistent').'/.local/share')
69 .'/lei/store', $env->{PWD});
72 sub _config_path ($) {
74 File::Spec->rel2abs(($env->{XDG_CONFIG_HOME} //
75 ($env->{HOME} // '/nonexistent').'/.config')
76 .'/lei/config', $env->{PWD});
79 # TODO: generate shell completion + help using %CMD and %OPTDESC
80 # command => [ positional_args, 1-line description, Getopt::Long option spec ]
81 our %CMD = ( # sorted in order of importance/use:
82 'q' => [ 'SEARCH_TERMS...', 'search for messages matching terms', qw(
83 save-as=s output|mfolder|o=s format|f=s dedupe|d=s thread|t augment|a
84 sort|s=s reverse|r offset=i remote local! external! pretty
85 since|after=s until|before=s), opt_dash('limit|n=i', '[0-9]+') ],
87 'show' => [ 'MID|OID', 'show a given object (Message-ID or object ID)',
88 qw(type=s solve! format|f=s dedupe|d=s thread|t remote local!),
89 pass_through('git show') ],
91 'add-external' => [ 'URL_OR_PATHNAME',
92 'add/set priority of a publicinbox|extindex for extra matches',
93 qw(boost=i quiet|q) ],
94 'ls-external' => [ '[FILTER...]', 'list publicinbox|extindex locations',
95 qw(format|f=s z|0 local remote quiet|q) ],
96 'forget-external' => [ '{URL_OR_PATHNAME|--prune}',
97 'exclude further results from a publicinbox|extindex',
100 'ls-query' => [ '[FILTER...]', 'list saved search queries',
101 qw(name-only format|f=s z) ],
102 'rm-query' => [ 'QUERY_NAME', 'remove a saved search' ],
103 'mv-query' => [ qw(OLD_NAME NEW_NAME), 'rename a saved search' ],
105 'plonk' => [ '--thread|--from=IDENT',
106 'exclude mail matching From: or thread from non-Message-ID searches',
107 qw(stdin| thread|t from|f=s mid=s oid=s) ],
108 'mark' => [ 'MESSAGE_FLAGS...',
109 'set/unset flags on message(s) from stdin',
110 qw(stdin| oid=s exact by-mid|mid:s) ],
111 'forget' => [ '[--stdin|--oid=OID|--by-mid=MID]',
112 "exclude message(s) on stdin from `q' search results",
113 qw(stdin| oid=s exact by-mid|mid:s quiet|q) ],
115 'purge-mailsource' => [ '{URL_OR_PATHNAME|--all}',
116 'remove imported messages from IMAP, Maildirs, and MH',
117 qw(exact! all jobs:i indexed) ],
119 # code repos are used for `show' to solve blobs from patch mails
120 'add-coderepo' => [ 'PATHNAME', 'add or set priority of a git code repo',
122 'ls-coderepo' => [ '[FILTER_TERMS...]',
123 'list known code repos', qw(format|f=s z) ],
124 'forget-coderepo' => [ 'PATHNAME',
125 'stop using repo to solve blobs from patches',
128 'add-watch' => [ '[URL_OR_PATHNAME]',
129 'watch for new messages and flag changes',
130 qw(import! flags! interval=s recursive|r exclude=s include=s) ],
131 'ls-watch' => [ '[FILTER...]', 'list active watches with numbers and status',
133 'pause-watch' => [ '[WATCH_NUMBER_OR_FILTER]', qw(all local remote) ],
134 'resume-watch' => [ '[WATCH_NUMBER_OR_FILTER]', qw(all local remote) ],
135 'forget-watch' => [ '{WATCH_NUMBER|--prune}', 'stop and forget a watch',
138 'import' => [ '{URL_OR_PATHNAME|--stdin}',
139 'one-shot import/update from URL or filesystem',
140 qw(stdin| offset=i recursive|r exclude=s include=s !flags),
143 'config' => [ '[...]', sub {
144 'git-config(1) wrapper for '._config_path($_[0]);
145 }, qw(config-file|system|global|file|f=s), # for conflict detection
146 pass_through('git config') ],
147 'init' => [ '[PATHNAME]', sub {
148 'initialize storage, default: '._store_path($_[0]);
150 'daemon-kill' => [ '[-SIGNAL]', 'signal the lei-daemon',
151 opt_dash('signal|s=s', '[0-9]+|(?:[A-Z][A-Z0-9]+)') ],
152 'daemon-pid' => [ '', 'show the PID of the lei-daemon' ],
153 'help' => [ '[SUBCOMMAND]', 'show help' ],
155 # XXX do we need this?
156 # 'git' => [ '[ANYTHING...]', 'git(1) wrapper', pass_through('git') ],
158 'reorder-local-store-and-break-history' => [ '[REFNAME]',
159 'rewrite git history in an attempt to improve compression',
162 # internal commands are prefixed with '_'
163 '_complete' => [ '[...]', 'internal shell completion helper',
164 pass_through('everything') ],
167 # switch descriptions, try to keep consistent across commands
168 # $spec: Getopt::Long option specification
169 # $spec => [@ALLOWED_VALUES (default is first), $description],
170 # $spec => $description
171 # "$SUB_COMMAND TAB $spec" => as above
172 my $stdin_formats = [ 'IN|auto|raw|mboxrd|mboxcl2|mboxcl|mboxo',
173 'specify message input format' ];
174 my $ls_format = [ 'OUT|plain|json|null', 'listing output format' ];
177 'help|h' => 'show this built-in help',
178 'quiet|q' => 'be quiet',
179 'solve!' => 'do not attempt to reconstruct blobs from emails',
180 'save-as=s' => ['NAME', 'save a search terms by given name'],
182 'type=s' => [ 'any|mid|git', 'disambiguate type' ],
184 'dedupe|d=s' => ['STRAT|content|oid|mid|none',
185 'deduplication strategy'],
186 'show thread|t' => 'display entire thread a message belongs to',
188 'return all messages in the same thread as the actual match(es)',
189 'augment|a' => 'augment --output destination instead of clobbering',
191 'output|o=s' => [ 'DEST',
192 "destination (e.g. `/path/to/Maildir', or `-' for stdout)" ],
194 'show format|f=s' => [ 'OUT|plain|raw|html|mboxrd|mboxcl2|mboxcl',
195 'message/object output format' ],
196 'mark format|f=s' => $stdin_formats,
197 'forget format|f=s' => $stdin_formats,
198 'q format|f=s' => [ 'OUT|maildir|mboxrd|mboxcl2|mboxcl|html|oid|json',
199 'specify output format, default depends on --output'],
200 'ls-query format|f=s' => $ls_format,
201 'ls-external format|f=s' => $ls_format,
203 'limit|n=i@' => ['NUM', 'limit on number of matches (default: 10000)' ],
204 'offset=i' => ['OFF', 'search result offset (default: 0)'],
206 'sort|s=s' => [ 'VAL|received,relevance,docid',
207 "order of results `--output'-dependent"],
208 'reverse|r' => [ 'reverse search results' ], # like sort(1)
210 'boost=i' => 'increase/decrease priority of results (default: 0)',
212 'local' => 'limit operations to the local filesystem',
213 'local!' => 'exclude results from the local filesystem',
214 'remote' => 'limit operations to those requiring network access',
215 'remote!' => 'prevent operations requiring network access',
217 'mid=s' => 'specify the Message-ID of a message',
218 'oid=s' => 'specify the git object ID of a message',
220 'recursive|r' => 'scan directories/mailboxes/newsgroups recursively',
221 'exclude=s' => 'exclude mailboxes/newsgroups based on pattern',
222 'include=s' => 'include mailboxes/newsgroups based on pattern',
224 'exact' => 'operate on exact header matches only',
225 'exact!' => 'rely on content match instead of exact header matches',
227 'by-mid|mid:s' => [ 'MID', 'match only by Message-ID, ignoring contents' ],
228 'jobs:i' => 'set parallelism level',
230 # xargs, env, use "-0", git(1) uses "-z". We support z|0 everywhere
231 'z|0' => 'use NUL \\0 instead of newline (CR) to delimit lines',
233 'signal|s=s' => [ 'SIG', 'signal to send lei-daemon (default: TERM)' ],
237 'leistore.dir' => 'top-level storage location',
240 sub x_it ($$) { # pronounced "exit"
241 my ($self, $code) = @_;
242 $self->{1}->autoflush(1); # make sure client sees stdout before exit
243 my $sig = ($code & 127);
244 $code >>= 8 unless $sig;
245 if (my $sock = $self->{sock}) {
246 say $sock "exit=$code";
247 } else { # for oneshot
252 sub puts ($;@) { print { shift->{1} } map { "$_\n" } @_ }
254 sub out ($;@) { print { shift->{1} } @_ }
257 print { shift->{2} } @_, (substr($_[-1], -1, 1) eq "\n" ? () : "\n");
260 sub qerr ($;@) { $_[0]->{opt}->{quiet} or err(shift, @_) }
263 my ($self, $buf, $exit_code) = @_;
265 x_it($self, ($exit_code // 1) << 8);
269 # usage: local %SIG = (%SIG, $lei->atfork_child_wq($wq));
270 sub atfork_child_wq {
271 my ($self, $wq) = @_;
272 $self->{sock} //= $wq->{0};
273 $self->{$_} //= $wq->{$_} for (0..2);
274 my $oldpipe = $SIG{PIPE};
276 __WARN__ => sub { err($self, @_) },
279 $oldpipe->() if ref($oldpipe) eq 'CODE';
284 # usage: ($lei, @io) = $lei->atfork_prepare_wq($wq);
285 sub atfork_prepare_wq {
286 my ($self, $wq) = @_;
287 if ($wq->wq_workers) {
288 my $ret = bless { %$self }, ref($self);
289 my $in = delete $ret->{0};
290 ($ret, delete($ret->{sock}) // $in, delete @$ret{1, 2});
292 ($self, ($self->{sock} // $self->{0}), @$self{1, 2});
297 my ($self, $errmsg) = @_;
298 my $cmd = $self->{cmd} // 'COMMAND';
299 my @info = @{$CMD{$cmd} // [ '...', '...' ]};
300 my @top = ($cmd, shift(@info) // ());
301 my $cmd_desc = shift(@info);
302 $cmd_desc = $cmd_desc->($self->{env}) if ref($cmd_desc) eq 'CODE';
305 for my $sw (grep { !ref } @info) { # ("prio=s", "z", $GLP_PASS)
306 my $desc = $OPTDESC{"$cmd\t$sw"} // $OPTDESC{$sw} // next;
308 ($arg_vals, $desc) = @$desc if ref($desc) eq 'ARRAY';
310 # lower-case is a keyword (e.g. `content', `oid'),
311 # ALL_CAPS is a string description (e.g. `PATH')
312 if ($desc !~ /default/ && $arg_vals =~ /\b([a-z]+)[,\|]/) {
313 $desc .= "\ndefault: `$1'";
317 if ($x =~ s/!\z//) { # solve! => --no-solve
319 } elsif ($x =~ s/:.+//) { # optional args: $x = "mid:s"
320 @vals = (' [', undef, ']');
321 } elsif ($x =~ s/=.+//) { # required arg: $x = "type=s"
322 @vals = (' ', undef);
323 } # else: no args $x = 'thread|t'
324 for (split(/\|/, $x)) { # help|h
325 length($_) > 1 ? push(@l, "--$_") : push(@s, "-$_");
327 if (!scalar(@vals)) { # no args 'thread|t'
328 } elsif ($arg_vals =~ s/\A([A-Z_]+)\b//) { # "NAME"
331 $vals[1] = uc(substr($l[0], 2)); # "--type" => "TYPE"
333 if ($arg_vals =~ /([,\|])/) {
335 my @allow = split(/\Q$sep\E/, $arg_vals);
336 my $must = $sep eq '|' ? 'Must' : 'Can';
337 @allow = map { "`$_'" } @allow;
338 my $last = pop @allow;
339 $desc .= "\n$must be one of: " .
340 join(', ', @allow) . " or $last";
342 my $lhs = join(', ', @s, @l) . join('', @vals);
343 if ($x =~ /\|\z/) { # "stdin|" or "clear|"
344 $lhs =~ s/\A--/- , --/;
346 $lhs =~ s/\A--/ --/; # pad if no short options
348 $lpad = length($lhs) if length($lhs) > $lpad;
349 push @opt_desc, $lhs, $desc;
351 my $msg = $errmsg ? "E: $errmsg\n" : '';
358 local $Text::Wrap::columns = 78 - $lpad;
359 my $padding = ' ' x ($lpad + 2);
360 while (my ($lhs, $rhs) = splice(@opt_desc, 0, 2)) {
361 $msg .= ' '.pack("A$lpad", $lhs);
362 $rhs = wrap('', '', $rhs);
363 $rhs =~ s/\n/\n$padding/sg; # LHS pad continuation lines
367 print { $self->{$errmsg ? 2 : 1} } $msg;
368 x_it($self, $errmsg ? 1 << 8 : 0); # stderr => failure
373 my ($self, $cmd, $argv) = @_;
375 $OPT = $self->{opt} = {};
376 my $info = $CMD{$cmd} // [ '[...]' ];
377 my ($proto, undef, @spec) = @$info;
378 my $glp = ref($spec[-1]) eq ref($GLP) ? pop(@spec) : $GLP;
379 push @spec, qw(help|h);
381 if ($spec[0] =~ s/\|\z//s) { # "stdin|" or "clear|" allows "-" alias
382 $lone_dash = $spec[0];
383 $OPT->{$spec[0]} = \(my $var);
384 push @spec, '' => \$var;
386 $glp->getoptionsfromarray($argv, $OPT, @spec) or
387 return _help($self, "bad arguments or options for $cmd");
388 return _help($self) if $OPT->{help};
390 push @$argv, @{$OPT->{-argv}} if defined($OPT->{-argv});
392 # "-" aliases "stdin" or "clear"
393 $OPT->{$lone_dash} = ${$OPT->{$lone_dash}} if defined $lone_dash;
396 my $POS_ARG = '[A-Z][A-Z0-9_]+';
398 my @args = split(/ /, $proto);
399 for my $var (@args) {
400 if ($var =~ /\A$POS_ARG\.\.\.\z/o) { # >= 1 args;
401 $inf = defined($argv->[$i]) and last;
402 $var =~ s/\.\.\.\z//;
403 $err = "$var not supplied";
404 } elsif ($var =~ /\A$POS_ARG\z/o) { # required arg at $i
405 $argv->[$i++] // ($err = "$var not supplied");
406 } elsif ($var =~ /\.\.\.\]\z/) { # optional args start
409 } elsif ($var =~ /\A\[-?$POS_ARG\]\z/) { # one optional arg
411 } elsif ($var =~ /\A.+?\|/) { # required FOO|--stdin
412 my @or = split(/\|/, $var);
415 if ($o =~ /\A--([a-z0-9\-]+)/) {
416 $ok = defined($OPT->{$1});
418 } elsif (defined($argv->[$i])) {
422 } # else continue looping
425 $err = join(', ', @or) . " or $last must be set";
427 warn "BUG: can't parse `$var' in $proto";
431 if (!$inf && scalar(@$argv) > scalar(@args)) {
432 $err //= 'too many arguments';
434 $err ? fail($self, "usage: lei $cmd $proto\nE: $err") : 1;
438 my ($self, $cmd, @argv) = @_;
439 local $SIG{__WARN__} = sub { err($self, @_) };
440 return _help($self, 'no command given') unless defined($cmd);
441 my $func = "lei_$cmd";
443 if (my $cb = __PACKAGE__->can($func)) {
444 optparse($self, $cmd, \@argv) or return;
446 } elsif (grep(/\A-/, $cmd, @argv)) { # --help or -h only
448 $GLP->getoptionsfromarray([$cmd, @argv], $opt, qw(help|h)) or
449 return _help($self, 'bad arguments or options');
452 fail($self, "`$cmd' is not an lei command");
457 my ($self, $creat) = @_;
458 my $f = _config_path($self->{env});
460 my $cur_st = @st ? pack('dd', $st[10], $st[7]) : ''; # 10:ctime, 7:size
461 if (my $cfg = $PATH2CFG{$f}) { # reuse existing object in common case
462 return ($self->{cfg} = $cfg) if $cur_st eq $cfg->{-st};
469 my (undef, $cfg_dir, undef) = File::Spec->splitpath($f);
470 -d $cfg_dir or mkpath($cfg_dir) or die "mkpath($cfg_dir): $!\n";
471 open my $fh, '>>', $f or die "open($f): $!\n";
472 @st = stat($fh) or die "fstat($f): $!\n";
473 $cur_st = pack('dd', $st[10], $st[7]);
474 qerr($self, "I: $f created") if $self->{cmd} ne 'config';
476 my $cfg = PublicInbox::Config::git_config_dump($f);
477 $cfg->{-st} = $cur_st;
479 $self->{cfg} = $PATH2CFG{$f} = $cfg;
482 sub _lei_store ($;$) {
483 my ($self, $creat) = @_;
484 my $cfg = _lei_cfg($self, $creat);
485 $cfg->{-lei_store} //= do {
486 require PublicInbox::LeiStore;
487 my $dir = $cfg->{'leistore.dir'};
488 $dir //= _store_path($self->{env}) if $creat;
490 PublicInbox::LeiStore->new($dir, { creat => $creat });
495 my ($self, @argv) = @_;
499 my ($self, @argv) = @_;
503 my ($self, @argv) = @_;
504 $self->{opt}->{'config-file'} and return fail $self,
505 "config file switches not supported by `lei config'";
506 my $env = $self->{env};
507 delete local $env->{GIT_CONFIG};
508 my $cfg = _lei_cfg($self, 1);
509 my $cmd = [ qw(git config -f), $cfg->{'-f'}, @argv ];
510 my %rdr = map { $_ => $self->{$_} } (0..2);
511 run_die($cmd, $env, \%rdr);
515 my ($self, $dir) = @_;
516 my $cfg = _lei_cfg($self, 1);
517 my $cur = $cfg->{'leistore.dir'};
518 my $env = $self->{env};
519 $dir //= _store_path($env);
520 $dir = File::Spec->rel2abs($dir, $env->{PWD}); # PWD is symlink-aware
521 my @cur = stat($cur) if defined($cur);
522 $cur = File::Spec->canonpath($cur // $dir);
523 my @dir = stat($dir);
524 my $exists = "I: leistore.dir=$cur already initialized" if @dir;
527 _lei_store($self, 1)->done;
528 return qerr($self, $exists);
531 # some folks like symlinks and bind mounts :P
532 if (@dir && "$cur[0] $cur[1]" eq "$dir[0] $dir[1]") {
533 lei_config($self, 'leistore.dir', $dir);
534 _lei_store($self, 1)->done;
535 return qerr($self, "$exists (as $cur)");
537 return fail($self, <<"");
538 E: leistore.dir=$cur already initialized and it is not $dir
541 lei_config($self, 'leistore.dir', $dir);
542 _lei_store($self, 1)->done;
543 $exists //= "I: leistore.dir=$dir newly initialized";
544 return qerr($self, $exists);
547 sub lei_daemon_pid { puts shift, $$ }
549 sub lei_daemon_kill {
551 my $sig = $self->{opt}->{signal} // 'TERM';
552 kill($sig, $$) or fail($self, "kill($sig, $$): $!");
555 sub lei_help { _help($_[0]) }
557 # Shell completion helper. Used by lei-completion.bash and hopefully
558 # other shells. Try to do as much here as possible to avoid redundancy
559 # and improve maintainability.
561 my ($self, @argv) = @_; # argv = qw(lei and any other args...)
562 shift @argv; # ignore "lei", the entire command is sent
563 @argv or return puts $self, grep(!/^_/, keys %CMD), qw(--help -h);
564 my $cmd = shift @argv;
565 my $info = $CMD{$cmd} // do { # filter matching commands
566 @argv or puts $self, grep(/\A\Q$cmd\E/, keys %CMD);
569 my ($proto, undef, @spec) = @$info;
571 my $re = defined($cur) ? qr/\A\Q$cur\E/ : qr/./;
572 if (substr($cur // '-', 0, 1) eq '-') { # --switches
573 # gross special case since the only git-config options
574 # Consider moving to a table if we need more special cases
575 # we use Getopt::Long for are the ones we reject, so these
576 # are the ones we don't reject:
577 if ($cmd eq 'config') {
578 puts $self, grep(/$re/, keys %CONFIG_KEYS);
579 @spec = qw(add z|null get get-all unset unset-all
580 replace-all get-urlmatch
581 remove-section rename-section
582 name-only list|l edit|e
583 get-color-name get-colorbool);
587 puts $self, grep(/$re/, map { # generate short/long names
589 if (s/=.+\z//) { # required arg, e.g. output|o=i
591 } elsif (s/:.+\z//) { # optional arg, e.g. mid:s
592 } else { # negation: solve! => no-solve|solve
593 s/\A(.+)!\z/no-$1|$1/;
596 length > 1 ? "--$_$eq" : "-$_"
597 } split(/\|/, $_, -1) # help|h
598 } grep { $OPTDESC{"$cmd\t$_"} || $OPTDESC{$_} } @spec);
599 } elsif ($cmd eq 'config' && !@argv && !$CONFIG_KEYS{$cur}) {
600 puts $self, grep(/$re/, keys %CONFIG_KEYS);
602 # TODO: URLs, pathnames, OIDs, MIDs, etc... See optparse() for
606 sub reap_exec { # dwaitpid callback
607 my ($self, $pid) = @_;
611 sub lei_git { # support passing through random git commands
612 my ($self, @argv) = @_;
613 my %rdr = map { $_ => $self->{$_} } (0..2);
614 my $pid = spawn(['git', @argv], $self->{env}, \%rdr);
615 dwaitpid($pid, \&reap_exec, $self);
618 # caller needs to "-t $self->{1}" to check if tty
621 my $env = $self->{env};
622 my $fh = popen_rd([qw(git var GIT_PAGER)], $env);
623 chomp(my $pager = <$fh> // '');
624 close($fh) or warn "`git var PAGER' error: \$?=$?";
625 return if $pager eq 'cat' || $pager eq '';
626 $env->{LESS} //= 'FRX';
628 $env->{COLUMNS} //= 80; # TODO TIOCGWINSZ
629 $env->{MORE} //= 'FRX' if $^O eq 'freebsd';
630 pipe(my ($r, $wpager)) or return warn "pipe: $!";
631 my $rdr = { 0 => $r, 1 => $self->{1}, 2 => $self->{2} };
632 $self->{1} = $wpager;
633 $self->{2} = $wpager if -t $self->{2};
634 my $pid = spawn([$pager], $env, $rdr);
635 $env->{GIT_PAGER_IN_USE} = 'true'; # we may spawn git
636 [ $pid, @$rdr{1, 2} ];
639 sub accept_dispatch { # Listener {post_accept} callback
640 my ($sock) = @_; # ignore other
643 my $self = bless { sock => $sock }, __PACKAGE__;
644 vec(my $rin = '', fileno($sock), 1) = 1;
645 # `say $sock' triggers "die" in lei(1)
647 if (select(my $rout = $rin, undef, undef, 1)) {
648 my @fds = $recv_cmd->($sock, $buf, 4096 * 33); # >MAX_ARG_STRLEN
649 if (scalar(@fds) == 3) {
651 for my $rdr (qw(<&= >&= >&=)) {
652 my $fd = shift(@fds);
653 if (open(my $fh, $rdr, $fd)) {
656 say $sock "open($rdr$fd) (FD=$i): $!";
661 say $sock "recv_cmd failed: $!";
665 say $sock "timed out waiting to recv FDs";
668 $self->{2}->autoflush(1); # keep stdout buffered until x_it|DESTROY
669 # $ENV_STR = join('', map { "\0$_=$ENV{$_}" } keys %ENV);
670 # $buf = "$$\0$argc\0".join("\0", @ARGV).$ENV_STR."\0\0";
671 if (substr($buf, -2, 2, '') ne "\0\0") { # s/\0\0\z//
672 say $sock "request command truncated";
675 my ($argc, @argv) = split(/\0/, $buf, -1);
677 my %env = map { split(/=/, $_, 2) } splice(@argv, $argc);
678 if (chdir($env{PWD})) {
680 $self->{env} = \%env;
681 eval { dispatch($self, @argv) };
684 say $sock "chdir($env{PWD}): $!"; # implicit close
688 # for long-running results
691 local %ENV = %{$self->{env}};
694 say { $self->{sock} } $@;
695 $self->close; # PublicInbox::DS::close
701 our $oldset; sub oldset { $oldset }
703 # lei(1) calls this when it can't connect
705 my ($path, $errno, $nfd) = @_;
706 if ($errno == ECONNREFUSED) {
707 unlink($path) or die "unlink($path): $!";
708 } elsif ($errno != ENOENT) {
709 $! = $errno; # allow interpolation to stringify in die
710 die "connect($path): $!";
712 umask(077) // die("umask(077): $!");
713 socket(my $l, AF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
714 bind($l, pack_sockaddr_un($path)) or die "bind($path): $!";
715 listen($l, 1024) or die "listen: $!";
716 my @st = stat($path) or die "stat($path): $!";
717 my $dev_ino_expect = pack('dd', $st[0], $st[1]); # dev+ino
718 pipe(my ($eof_r, $eof_w)) or die "pipe: $!";
719 local $oldset = PublicInbox::DS::block_signals();
721 require PublicInbox::CmdIPC1;
722 $recv_cmd = PublicInbox::CmdIPC1->can('recv_cmd1');
723 } elsif ($nfd == 4) {
724 $recv_cmd = PublicInbox::Spawn->can('recv_cmd4') // do {
725 require PublicInbox::CmdIPC4;
726 PublicInbox::CmdIPC4->can('recv_cmd4');
729 $recv_cmd or die <<"";
730 (Socket::MsgHdr || IO::FDPass || Inline::C) missing/unconfigured (nfd=$nfd);
732 require PublicInbox::Listener;
733 require PublicInbox::EOFpipe;
734 (-p STDOUT) or die "E: stdout must be a pipe\n";
735 open(STDIN, '+<', '/dev/null') or die "redirect stdin failed: $!";
736 POSIX::setsid() > 0 or die "setsid: $!";
737 my $pid = fork // die "fork: $!";
739 $0 = "lei-daemon $path";
741 $_->blocking(0) for ($l, $eof_r, $eof_w);
742 $l = PublicInbox::Listener->new($l, \&accept_dispatch, $l);
745 $exit_code //= shift;
746 my $listener = $l or exit($exit_code);
747 unlink($path) if defined($path);
748 # closing eof_w triggers \&noop wakeup
749 $eof_w = $l = $path = undef;
750 $listener->close; # DS::close
751 PublicInbox::DS->SetLoopTimeout(1000);
753 PublicInbox::EOFpipe->new($eof_r, \&noop, undef);
755 CHLD => \&PublicInbox::DS::enqueue_reap,
763 my $sigfd = PublicInbox::Sigfd->new($sig, SFD_NONBLOCK);
764 local %SIG = (%SIG, %$sig) if !$sigfd;
765 local $SIG{PIPE} = 'IGNORE';
766 if ($sigfd) { # TODO: use inotify/kqueue to detect unlinked sockets
767 PublicInbox::DS->SetLoopTimeout(5000);
769 # wake up every second to accept signals if we don't
770 # have signalfd or IO::KQueue:
771 PublicInbox::DS::sig_setmask($oldset);
772 PublicInbox::DS->SetLoopTimeout(1000);
774 PublicInbox::DS->SetPostLoopCallback(sub {
775 my ($dmap, undef) = @_;
776 if (@st = defined($path) ? stat($path) : ()) {
777 if ($dev_ino_expect ne pack('dd', $st[0], $st[1])) {
778 warn "$path dev/ino changed, quitting\n";
781 } elsif (defined($path)) {
782 warn "stat($path): $!, quitting ...\n";
783 undef $path; # don't unlink
786 return 1 if defined($path);
789 for my $s (values %$dmap) {
790 $s->can('busy') or next;
791 if ($s->busy($now)) {
797 $n; # true: continue, false: stop
800 # STDIN was redirected to /dev/null above, closing STDERR and
801 # STDOUT will cause the calling `lei' client process to finish
802 # reading the <$daemon> pipe.
803 openlog($path, 'pid', 'user');
804 local $SIG{__WARN__} = sub { syslog('warning', "@_") };
805 my $on_destroy = PublicInbox::OnDestroy->new($$, sub {
806 syslog('crit', "$@") if $@;
808 open STDERR, '>&STDIN' or die "redirect stderr failed: $!";
809 open STDOUT, '>&STDIN' or die "redirect stdout failed: $!";
810 # $daemon pipe to `lei' closed, main loop begins:
811 PublicInbox::DS->EventLoop;
812 @$on_destroy = (); # cancel on_destroy if we get here
813 exit($exit_code // 0);
816 # for users w/o IO::FDPass
819 my $exit = $main_pkg->can('exit'); # caller may override exit()
820 local $quit = $exit if $exit;
822 umask(077) // die("umask(077): $!");
828 }, __PACKAGE__), @ARGV);
831 # ensures stdout hits the FS before sock disconnects so a client
832 # can immediately reread it
835 $self->{1}->autoflush(1);