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_SEQPACKET MSG_EOR pack_sockaddr_un);
15 use Errno qw(EPIPE EAGAIN EINTR ECONNREFUSED ENOENT ECONNRESET);
17 use POSIX qw(strftime);
19 use Fcntl qw(SEEK_SET);
20 use PublicInbox::Config;
21 use PublicInbox::Syscall qw(SFD_NONBLOCK EPOLLIN EPOLLET);
22 use PublicInbox::Sigfd;
23 use PublicInbox::DS qw(now dwaitpid);
24 use PublicInbox::Spawn qw(spawn popen_rd);
25 use PublicInbox::OnDestroy;
26 use Text::Wrap qw(wrap);
27 use Time::HiRes qw(stat); # ctime comparisons for config cache
28 use File::Path qw(mkpath);
30 our $quit = \&CORE::exit;
31 our ($current_lei, $errors_log, $listener);
32 my ($recv_cmd, $send_cmd);
33 my $GLP = Getopt::Long::Parser->new;
34 $GLP->configure(qw(gnu_getopt no_ignore_case auto_abbrev));
35 my $GLP_PASS = Getopt::Long::Parser->new;
36 $GLP_PASS->configure(qw(gnu_getopt no_ignore_case auto_abbrev pass_through));
38 our %PATH2CFG; # persistent for socket daemon
40 # TBD: this is a documentation mechanism to show a subcommand
41 # (may) pass options through to another command:
42 sub pass_through { $GLP_PASS }
46 my ($spec, $re_str) = @_; # 'limit|n=i', '([0-9]+)'
47 my ($key) = ($spec =~ m/\A([a-z]+)/g);
48 my $cb = sub { # Getopt::Long "<>" catch-all handler
50 if ($arg =~ /\A-($re_str)\z/) {
52 } elsif ($arg eq '--') { # "--" arg separator, ignore first
53 push @{$OPT->{-argv}}, $arg if $OPT->{'--'}++;
54 # lone (single) dash is handled elsewhere
55 } elsif (substr($arg, 0, 1) eq '-') {
57 push @{$OPT->{-argv}}, $arg;
59 die "bad argument: $arg\n";
62 push @{$OPT->{-argv}}, $arg;
65 ($spec, '<>' => $cb, $GLP_PASS) # for Getopt::Long
70 return $p if index($p, '/') == 0; # already absolute
71 my $pwd = $self->{env}->{PWD};
73 my $cwd = $self->{3} // getcwd() // die "getcwd(PWD=$pwd): $!";
74 if (my @st_pwd = stat($pwd)) {
75 my @st_cwd = stat($cwd) or die "stat($cwd): $!";
76 "@st_pwd[1,0]" eq "@st_cwd[1,0]" or
77 $self->{env}->{PWD} = $pwd = $cwd;
78 } else { # PWD was invalid
79 delete $self->{env}->{PWD};
83 $pwd //= $self->{env}->{PWD} = getcwd() // die "getcwd(PWD=$pwd): $!";
84 File::Spec->rel2abs($p, $pwd);
89 rel2abs($self, ($self->{env}->{XDG_DATA_HOME} //
90 ($self->{env}->{HOME} // '/nonexistent').'/.local/share')
94 sub _config_path ($) {
96 rel2abs($self, ($self->{env}->{XDG_CONFIG_HOME} //
97 ($self->{env}->{HOME} // '/nonexistent').'/.config')
101 # TODO: generate shell completion + help using %CMD and %OPTDESC
102 # command => [ positional_args, 1-line description, Getopt::Long option spec ]
103 our %CMD = ( # sorted in order of importance/use:
104 'q' => [ '--stdin|SEARCH_TERMS...', 'search for messages matching terms', qw(
105 save-as=s output|mfolder|o=s format|f=s dedupe|d=s thread|t augment|a
106 sort|s=s reverse|r offset=i remote! local! external! pretty
107 include|I=s@ exclude=s@ only=s@ jobs|j=s globoff|g stdin|
108 mua-cmd|mua=s no-torsocks torsocks=s verbose|v quiet|q
109 received-after=s received-before=s sent-after=s sent-since=s),
110 PublicInbox::LeiQuery::curl_opt(), opt_dash('limit|n=i', '[0-9]+') ],
112 'show' => [ 'MID|OID', 'show a given object (Message-ID or object ID)',
113 qw(type=s solve! format|f=s dedupe|d=s thread|t remote local!),
114 pass_through('git show') ],
116 'add-external' => [ 'URL_OR_PATHNAME',
117 'add/set priority of a publicinbox|extindex for extra matches',
118 qw(boost=i quiet|q) ],
119 'ls-external' => [ '[FILTER...]', 'list publicinbox|extindex locations',
120 qw(format|f=s z|0 local remote quiet|q) ],
121 'forget-external' => [ 'URL_OR_PATHNAME...|--prune',
122 'exclude further results from a publicinbox|extindex',
125 'ls-query' => [ '[FILTER...]', 'list saved search queries',
126 qw(name-only format|f=s z) ],
127 'rm-query' => [ 'QUERY_NAME', 'remove a saved search' ],
128 'mv-query' => [ qw(OLD_NAME NEW_NAME), 'rename a saved search' ],
130 'plonk' => [ '--thread|--from=IDENT',
131 'exclude mail matching From: or thread from non-Message-ID searches',
132 qw(stdin| thread|t from|f=s mid=s oid=s) ],
133 'mark' => [ 'MESSAGE_FLAGS...',
134 'set/unset flags on message(s) from stdin',
135 qw(stdin| oid=s exact by-mid|mid:s) ],
136 'forget' => [ '[--stdin|--oid=OID|--by-mid=MID]',
137 "exclude message(s) on stdin from `q' search results",
138 qw(stdin| oid=s exact by-mid|mid:s quiet|q) ],
140 'purge-mailsource' => [ 'URL_OR_PATHNAME|--all',
141 'remove imported messages from IMAP, Maildirs, and MH',
142 qw(exact! all jobs:i indexed) ],
144 # code repos are used for `show' to solve blobs from patch mails
145 'add-coderepo' => [ 'PATHNAME', 'add or set priority of a git code repo',
147 'ls-coderepo' => [ '[FILTER_TERMS...]',
148 'list known code repos', qw(format|f=s z) ],
149 'forget-coderepo' => [ 'PATHNAME',
150 'stop using repo to solve blobs from patches',
153 'add-watch' => [ '[URL_OR_PATHNAME]',
154 'watch for new messages and flag changes',
155 qw(import! flags! interval=s recursive|r exclude=s include=s) ],
156 'ls-watch' => [ '[FILTER...]', 'list active watches with numbers and status',
158 'pause-watch' => [ '[WATCH_NUMBER_OR_FILTER]', qw(all local remote) ],
159 'resume-watch' => [ '[WATCH_NUMBER_OR_FILTER]', qw(all local remote) ],
160 'forget-watch' => [ '{WATCH_NUMBER|--prune}', 'stop and forget a watch',
163 'import' => [ 'URLS_OR_PATHNAMES...|--stdin',
164 'one-time import/update from URL or filesystem',
165 qw(stdin| offset=i recursive|r exclude=s include|I=s
169 'config' => [ '[...]', sub {
170 'git-config(1) wrapper for '._config_path($_[0]);
171 }, qw(config-file|system|global|file|f=s), # for conflict detection
172 pass_through('git config') ],
173 'init' => [ '[PATHNAME]', sub {
174 'initialize storage, default: '._store_path($_[0]);
176 'daemon-kill' => [ '[-SIGNAL]', 'signal the lei-daemon',
177 opt_dash('signal|s=s', '[0-9]+|(?:[A-Z][A-Z0-9]+)') ],
178 'daemon-pid' => [ '', 'show the PID of the lei-daemon' ],
179 'help' => [ '[SUBCOMMAND]', 'show help' ],
181 # XXX do we need this?
182 # 'git' => [ '[ANYTHING...]', 'git(1) wrapper', pass_through('git') ],
184 'reorder-local-store-and-break-history' => [ '[REFNAME]',
185 'rewrite git history in an attempt to improve compression',
188 # internal commands are prefixed with '_'
189 '_complete' => [ '[...]', 'internal shell completion helper',
190 pass_through('everything') ],
193 # switch descriptions, try to keep consistent across commands
194 # $spec: Getopt::Long option specification
195 # $spec => [@ALLOWED_VALUES (default is first), $description],
196 # $spec => $description
197 # "$SUB_COMMAND TAB $spec" => as above
198 my $stdin_formats = [ 'MAIL_FORMAT|eml|mboxrd|mboxcl2|mboxcl|mboxo',
199 'specify message input format' ];
200 my $ls_format = [ 'OUT|plain|json|null', 'listing output format' ];
203 'help|h' => 'show this built-in help',
204 'quiet|q' => 'be quiet',
205 'globoff|g' => "do not match locations using '*?' wildcards and '[]' ranges",
206 'verbose|v' => 'be more verbose',
207 'solve!' => 'do not attempt to reconstruct blobs from emails',
208 'torsocks=s' => ['auto|no|yes',
209 'whether or not to wrap git and curl commands with torsocks'],
210 'no-torsocks' => 'alias for --torsocks=no',
211 'save-as=s' => ['NAME', 'save a search terms by given name'],
213 'type=s' => [ 'any|mid|git', 'disambiguate type' ],
215 'dedupe|d=s' => ['STRAT|content|oid|mid|none',
216 'deduplication strategy'],
217 'show thread|t' => 'display entire thread a message belongs to',
219 'return all messages in the same thread as the actual match(es)',
220 'augment|a' => 'augment --output destination instead of clobbering',
222 'output|mfolder|o=s' => [ 'DEST',
223 "destination (e.g. `/path/to/Maildir', or `-' for stdout)" ],
224 'mua-cmd|mua=s' => [ 'COMMAND',
225 "MUA to run on --output Maildir or mbox (e.g. `mutt -f %f'" ],
227 'show format|f=s' => [ 'OUT|plain|raw|html|mboxrd|mboxcl2|mboxcl',
228 'message/object output format' ],
229 'mark format|f=s' => $stdin_formats,
230 'forget format|f=s' => $stdin_formats,
232 'OUT|maildir|mboxrd|mboxcl2|mboxcl|mboxo|html|json|jsonl|concatjson',
233 'specify output format, default depends on --output'],
234 'q exclude=s@' => [ 'URL_OR_PATHNAME',
235 'exclude specified external(s) from search' ],
236 'q include|I=s@' => [ 'URL_OR_PATHNAME',
237 'include specified external(s) in search' ],
238 'q only=s@' => [ 'URL_OR_PATHNAME',
239 'only use specified external(s) for search' ],
241 'q jobs=s' => [ '[SEARCH_JOBS][,WRITER_JOBS]',
242 'control number of search and writer jobs' ],
244 'import format|f=s' => $stdin_formats,
246 'ls-query format|f=s' => $ls_format,
247 'ls-external format|f=s' => $ls_format,
249 'limit|n=i@' => ['NUM', 'limit on number of matches (default: 10000)' ],
250 'offset=i' => ['OFF', 'search result offset (default: 0)'],
252 'sort|s=s' => [ 'VAL|received,relevance,docid',
253 "order of results `--output'-dependent"],
254 'reverse|r' => [ 'reverse search results' ], # like sort(1)
256 'boost=i' => 'increase/decrease priority of results (default: 0)',
258 'local' => 'limit operations to the local filesystem',
259 'local!' => 'exclude results from the local filesystem',
260 'remote' => 'limit operations to those requiring network access',
261 'remote!' => 'prevent operations requiring network access',
263 'mid=s' => 'specify the Message-ID of a message',
264 'oid=s' => 'specify the git object ID of a message',
266 'recursive|r' => 'scan directories/mailboxes/newsgroups recursively',
267 'exclude=s' => 'exclude mailboxes/newsgroups based on pattern',
268 'include=s' => 'include mailboxes/newsgroups based on pattern',
270 'exact' => 'operate on exact header matches only',
271 'exact!' => 'rely on content match instead of exact header matches',
273 'by-mid|mid:s' => [ 'MID', 'match only by Message-ID, ignoring contents' ],
274 'jobs:i' => 'set parallelism level',
276 # xargs, env, use "-0", git(1) uses "-z". We support z|0 everywhere
277 'z|0' => 'use NUL \\0 instead of newline (CR) to delimit lines',
279 'signal|s=s' => [ 'SIG', 'signal to send lei-daemon (default: TERM)' ],
283 'leistore.dir' => 'top-level storage location',
286 # pronounced "exit": x_it(1 << 8) => exit(1); x_it(13) => SIGPIPE
288 my ($self, $code) = @_;
289 # make sure client sees stdout before exit
290 $self->{1}->autoflush(1) if $self->{1};
291 dump_and_clear_log();
292 if (my $s = $self->{pkt_op_p} // $self->{sock}) {
293 send($s, "x_it $code", MSG_EOR);
294 } elsif ($self->{oneshot}) {
295 # don't want to end up using $? from child processes
296 for my $f (qw(lxs l2m)) {
297 my $wq = delete $self->{$f} or next;
300 # cleanup anything that has tempfiles
301 delete @$self{qw(ovv dedupe)};
302 if (my $signum = ($code & 127)) { # usually SIGPIPE (13)
303 $SIG{PIPE} = 'DEFAULT'; # $SIG{$signum} doesn't work
305 sleep(1) while 1; # wait for signal
309 } # else ignore if client disconnected
314 my $err = $self->{2} // ($self->{pgr} // [])->[2] // *STDERR{GLOB};
315 my @eor = (substr($_[-1]//'', -1, 1) eq "\n" ? () : ("\n"));
316 print $err @_, @eor and return;
317 my $old_err = delete $self->{2};
318 close($old_err) if $! == EPIPE && $old_err;
319 $err = $self->{2} = ($self->{pgr} // [])->[2] // *STDERR{GLOB};
320 print $err @_, @eor or print STDERR @_, @eor;
323 sub qerr ($;@) { $_[0]->{opt}->{quiet} or err(shift, @_) }
325 sub fail_handler ($;$$) {
326 my ($lei, $code, $io) = @_;
327 for my $f (qw(imp lxs l2m)) {
328 my $wq = delete $lei->{$f} or next;
329 $wq->wq_wait_old($lei) if $wq->wq_kill_old; # lei-daemon
331 close($io) if $io; # needed to avoid warnings on SIGPIPE
332 $lei->x_it($code // (1 >> 8));
335 sub sigpipe_handler { # handles SIGPIPE from l2m/lxs workers
336 fail_handler($_[0], 13, delete $_[0]->{1});
340 my ($self, $buf, $exit_code) = @_;
341 err($self, $buf) if defined $buf;
342 # calls fail_handler:
343 send($self->{pkt_op_p}, '!', MSG_EOR) if $self->{pkt_op_p};
344 x_it($self, ($exit_code // 1) << 8);
350 return if print { $self->{1} // return } @_; # likely
351 return note_sigpipe($self, 1) if $! == EPIPE;
352 my $err = "error writing to stdout: $!";
357 sub puts ($;@) { out(shift, map { "$_\n" } @_) }
359 sub child_error { # passes non-fatal curl exit codes to user
360 my ($self, $child_error, $msg) = @_; # child_error is $?
361 $self->err($msg) if $msg;
362 if (my $s = $self->{pkt_op_p} // $self->{sock}) {
363 # send to the parent lei-daemon or to lei(1) client
364 send($s, "child_error $child_error", MSG_EOR);
365 } elsif (!$PublicInbox::DS::in_loop) {
366 $self->{child_error} = $child_error;
367 } # else noop if client disconnected
370 sub note_sigpipe { # triggers sigpipe_handler
371 my ($self, $fd) = @_;
372 close(delete($self->{$fd})); # explicit close silences Perl warning
373 send($self->{pkt_op_p}, '|', MSG_EOR) if $self->{pkt_op_p};
377 sub lei_atfork_child {
378 my ($self, $persist) = @_;
379 # we need to explicitly close things which are on stack
381 my @io = delete @$self{0,1,2};
382 unless ($self->{oneshot}) {
388 for (delete @$self{qw(3 sock old_1 au_done)}) {
389 close($_) if defined($_);
391 if (my $op_c = delete $self->{pkt_op_c}) {
392 close(delete $op_c->{sock});
394 if (my $pgr = delete $self->{pgr}) {
395 close($_) for (@$pgr[1,2]);
397 close $listener if $listener;
401 $quit = \&CORE::exit;
402 $current_lei = $persist ? undef : $self; # for SIG{__WARN__}
406 my ($self, $errmsg) = @_;
407 my $cmd = $self->{cmd} // 'COMMAND';
408 my @info = @{$CMD{$cmd} // [ '...', '...' ]};
409 my @top = ($cmd, shift(@info) // ());
410 my $cmd_desc = shift(@info);
411 $cmd_desc = $cmd_desc->($self) if ref($cmd_desc) eq 'CODE';
414 for my $sw (grep { !ref } @info) { # ("prio=s", "z", $GLP_PASS)
415 my $desc = $OPTDESC{"$cmd\t$sw"} // $OPTDESC{$sw} // next;
417 ($arg_vals, $desc) = @$desc if ref($desc) eq 'ARRAY';
419 # lower-case is a keyword (e.g. `content', `oid'),
420 # ALL_CAPS is a string description (e.g. `PATH')
421 if ($desc !~ /default/ && $arg_vals =~ /\b([a-z]+)[,\|]/) {
422 $desc .= "\ndefault: `$1'";
426 if ($x =~ s/!\z//) { # solve! => --no-solve
428 } elsif ($x =~ s/:.+//) { # optional args: $x = "mid:s"
429 @vals = (' [', undef, ']');
430 } elsif ($x =~ s/=.+//) { # required arg: $x = "type=s"
431 @vals = (' ', undef);
432 } # else: no args $x = 'thread|t'
433 for (split(/\|/, $x)) { # help|h
434 length($_) > 1 ? push(@l, "--$_") : push(@s, "-$_");
436 if (!scalar(@vals)) { # no args 'thread|t'
437 } elsif ($arg_vals =~ s/\A([A-Z_]+)\b//) { # "NAME"
440 $vals[1] = uc(substr($l[0], 2)); # "--type" => "TYPE"
442 if ($arg_vals =~ /([,\|])/) {
444 my @allow = split(/\Q$sep\E/, $arg_vals);
445 my $must = $sep eq '|' ? 'Must' : 'Can';
446 @allow = map { "`$_'" } @allow;
447 my $last = pop @allow;
448 $desc .= "\n$must be one of: " .
449 join(', ', @allow) . " or $last";
451 my $lhs = join(', ', @s, @l) . join('', @vals);
452 if ($x =~ /\|\z/) { # "stdin|" or "clear|"
453 $lhs =~ s/\A--/- , --/;
455 $lhs =~ s/\A--/ --/; # pad if no short options
457 $lpad = length($lhs) if length($lhs) > $lpad;
458 push @opt_desc, $lhs, $desc;
460 my $msg = $errmsg ? "E: $errmsg\n" : '';
467 local $Text::Wrap::columns = 78 - $lpad;
468 my $padding = ' ' x ($lpad + 2);
469 while (my ($lhs, $rhs) = splice(@opt_desc, 0, 2)) {
470 $msg .= ' '.pack("A$lpad", $lhs);
471 $rhs = wrap('', '', $rhs);
472 $rhs =~ s/\n/\n$padding/sg; # LHS pad continuation lines
476 my $out = $self->{$errmsg ? 2 : 1};
477 start_pager($self) if -t $out;
479 x_it($self, $errmsg ? 1 << 8 : 0); # stderr => failure
484 my ($self, $cmd, $argv) = @_;
486 $OPT = $self->{opt} = {};
487 my $info = $CMD{$cmd} // [ '[...]' ];
488 my ($proto, undef, @spec) = @$info;
489 my $glp = ref($spec[-1]) eq ref($GLP) ? pop(@spec) : $GLP;
490 push @spec, qw(help|h);
492 if ($spec[0] =~ s/\|\z//s) { # "stdin|" or "clear|" allows "-" alias
493 $lone_dash = $spec[0];
494 $OPT->{$spec[0]} = \(my $var);
495 push @spec, '' => \$var;
497 $glp->getoptionsfromarray($argv, $OPT, @spec) or
498 return _help($self, "bad arguments or options for $cmd");
499 return _help($self) if $OPT->{help};
501 push @$argv, @{$OPT->{-argv}} if defined($OPT->{-argv});
503 # "-" aliases "stdin" or "clear"
504 $OPT->{$lone_dash} = ${$OPT->{$lone_dash}} if defined $lone_dash;
507 my $POS_ARG = '[A-Z][A-Z0-9_]+';
509 my @args = split(/ /, $proto);
510 for my $var (@args) {
511 if ($var =~ /\A$POS_ARG\.\.\.\z/o) { # >= 1 args;
512 $inf = defined($argv->[$i]) and last;
513 $var =~ s/\.\.\.\z//;
514 $err = "$var not supplied";
515 } elsif ($var =~ /\A$POS_ARG\z/o) { # required arg at $i
516 $argv->[$i++] // ($err = "$var not supplied");
517 } elsif ($var =~ /\.\.\.\]\z/) { # optional args start
520 } elsif ($var =~ /\A\[-?$POS_ARG\]\z/) { # one optional arg
522 } elsif ($var =~ /\A.+?\|/) { # required FOO|--stdin
523 $inf = 1 if index($var, '...') > 0;
524 my @or = split(/\|/, $var);
527 if ($o =~ /\A--([a-z0-9\-]+)/) {
528 $ok = defined($OPT->{$1});
530 } elsif (defined($argv->[$i])) {
534 } # else continue looping
538 $err = join(', ', @or) . " or $last must be set";
540 warn "BUG: can't parse `$var' in $proto";
544 if (!$inf && scalar(@$argv) > scalar(@args)) {
545 $err //= 'too many arguments';
547 $err ? fail($self, "usage: lei $cmd $proto\nE: $err") : 1;
551 my ($self, $cmd, @argv) = @_;
552 local $current_lei = $self; # for __WARN__
553 dump_and_clear_log("from previous run\n");
554 return _help($self, 'no command given') unless defined($cmd);
555 my $func = "lei_$cmd";
557 if (my $cb = __PACKAGE__->can($func)) {
558 optparse($self, $cmd, \@argv) or return;
560 } elsif (grep(/\A-/, $cmd, @argv)) { # --help or -h only
562 $GLP->getoptionsfromarray([$cmd, @argv], $opt, qw(help|h)) or
563 return _help($self, 'bad arguments or options');
566 fail($self, "`$cmd' is not an lei command");
571 my ($self, $creat) = @_;
572 my $f = _config_path($self);
574 my $cur_st = @st ? pack('dd', $st[10], $st[7]) : ''; # 10:ctime, 7:size
575 if (my $cfg = $PATH2CFG{$f}) { # reuse existing object in common case
576 return ($self->{cfg} = $cfg) if $cur_st eq $cfg->{-st};
583 my (undef, $cfg_dir, undef) = File::Spec->splitpath($f);
584 -d $cfg_dir or mkpath($cfg_dir) or die "mkpath($cfg_dir): $!\n";
585 open my $fh, '>>', $f or die "open($f): $!\n";
586 @st = stat($fh) or die "fstat($f): $!\n";
587 $cur_st = pack('dd', $st[10], $st[7]);
588 qerr($self, "I: $f created") if $self->{cmd} ne 'config';
590 my $cfg = PublicInbox::Config::git_config_dump($f);
591 $cfg->{-st} = $cur_st;
593 $self->{cfg} = $PATH2CFG{$f} = $cfg;
596 sub _lei_store ($;$) {
597 my ($self, $creat) = @_;
598 my $cfg = _lei_cfg($self, $creat);
599 $cfg->{-lei_store} //= do {
600 require PublicInbox::LeiStore;
601 my $dir = $cfg->{'leistore.dir'};
602 $dir //= $creat ? _store_path($self) : return;
603 PublicInbox::LeiStore->new($dir, { creat => $creat });
608 my ($self, @argv) = @_;
612 my ($self, @argv) = @_;
616 my ($self, @argv) = @_;
617 my $env = $self->{env};
618 delete local $env->{GIT_CONFIG};
619 delete local $ENV{GIT_CONFIG};
620 my $cfg = _lei_cfg($self, 1);
621 my $cmd = [ qw(git config -f), $cfg->{'-f'}, @argv ];
622 my %rdr = map { $_ => $self->{$_} } (0..2);
623 waitpid(spawn($cmd, $env, \%rdr), 0);
627 my ($self, @argv) = @_;
628 $self->{opt}->{'config-file'} and return fail $self,
629 "config file switches not supported by `lei config'";
631 x_it($self, $?) if $?;
635 require PublicInbox::LeiImport;
636 PublicInbox::LeiImport->call(@_);
640 my ($self, $dir) = @_;
641 my $cfg = _lei_cfg($self, 1);
642 my $cur = $cfg->{'leistore.dir'};
643 $dir //= _store_path($self);
644 $dir = rel2abs($self, $dir);
645 my @cur = stat($cur) if defined($cur);
646 $cur = File::Spec->canonpath($cur // $dir);
647 my @dir = stat($dir);
648 my $exists = "I: leistore.dir=$cur already initialized" if @dir;
651 _lei_store($self, 1)->done;
652 return qerr($self, $exists);
655 # some folks like symlinks and bind mounts :P
656 if (@dir && "@cur[1,0]" eq "@dir[1,0]") {
657 lei_config($self, 'leistore.dir', $dir);
658 _lei_store($self, 1)->done;
659 return qerr($self, "$exists (as $cur)");
661 return fail($self, <<"");
662 E: leistore.dir=$cur already initialized and it is not $dir
665 lei_config($self, 'leistore.dir', $dir);
666 _lei_store($self, 1)->done;
667 $exists //= "I: leistore.dir=$dir newly initialized";
668 return qerr($self, $exists);
671 sub lei_daemon_pid { puts shift, $$ }
673 sub lei_daemon_kill {
675 my $sig = $self->{opt}->{signal} // 'TERM';
676 kill($sig, $$) or fail($self, "kill($sig, $$): $!");
679 sub lei_help { _help($_[0]) }
681 # Shell completion helper. Used by lei-completion.bash and hopefully
682 # other shells. Try to do as much here as possible to avoid redundancy
683 # and improve maintainability.
685 my ($self, @argv) = @_; # argv = qw(lei and any other args...)
686 shift @argv; # ignore "lei", the entire command is sent
687 @argv or return puts $self, grep(!/^_/, keys %CMD), qw(--help -h);
688 my $cmd = shift @argv;
689 my $info = $CMD{$cmd} // do { # filter matching commands
690 @argv or puts $self, grep(/\A\Q$cmd\E/, keys %CMD);
693 my ($proto, undef, @spec) = @$info;
695 my $re = defined($cur) ? qr/\A\Q$cur\E/ : qr/./;
696 if (substr($cur // '-', 0, 1) eq '-') { # --switches
697 # gross special case since the only git-config options
698 # Consider moving to a table if we need more special cases
699 # we use Getopt::Long for are the ones we reject, so these
700 # are the ones we don't reject:
701 if ($cmd eq 'config') {
702 puts $self, grep(/$re/, keys %CONFIG_KEYS);
703 @spec = qw(add z|null get get-all unset unset-all
704 replace-all get-urlmatch
705 remove-section rename-section
706 name-only list|l edit|e
707 get-color-name get-colorbool);
710 puts $self, grep(/$re/, map { # generate short/long names
711 if (s/[:=].+\z//) { # req/optional args, e.g output|o=i
712 } else { # negation: solve! => no-solve|solve
713 s/\A(.+)!\z/no-$1|$1/;
716 my $x = length > 1 ? "--$_" : "-$_";
717 $x eq $cur ? () : $x;
718 } split(/\|/, $_, -1) # help|h
719 } grep { $OPTDESC{"$cmd\t$_"} || $OPTDESC{$_} } @spec);
720 } elsif ($cmd eq 'config' && !@argv && !$CONFIG_KEYS{$cur}) {
721 puts $self, grep(/$re/, keys %CONFIG_KEYS);
724 # switch args (e.g. lei q -f mbox<TAB>)
725 if (($argv[-1] // $cur // '') =~ /\A--?([\w\-]+)\z/) {
726 my $opt = quotemeta $1;
728 my $v = $OPTDESC{$_};
729 my @v = ref($v) ? split(/\|/, $v->[0]) : ();
730 # get rid of ALL CAPS placeholder (e.g "OUT")
731 # (TODO: completion for external paths)
732 shift(@v) if uc($v[0]) eq $v[0];
734 } grep(/\A(?:$cmd\t|)(?:[\w-]+\|)*$opt\b/, keys %OPTDESC);
737 if (my $sub = $self->can("_complete_$cmd")) {
738 puts $self, $sub->($self, @argv, $cur);
740 # TODO: URLs, pathnames, OIDs, MIDs, etc... See optparse() for
745 my ($argv, $env) = @_;
746 my $argc = scalar @$argv;
747 my $buf = 'exec '.join("\0", scalar(@$argv), @$argv);
748 while (my ($k, $v) = each %$env) { $buf .= "\0$k=$v" };
754 my $mua = $self->{opt}->{'mua-cmd'} // return;
755 my $mfolder = $self->{ovv}->{dst};
756 my (@cmd, $replaced);
757 if ($mua =~ /\A(?:mutt|mailx|mail|neomutt)\z/) {
759 # TODO: help wanted: other common FOSS MUAs
761 require Text::ParseWords;
762 my @cmd = Text::ParseWords::shellwords($mua);
763 # mutt uses '%f' for open-hook with compressed mbox, we follow
764 @cmd = map { $_ eq '%f' ? ($replaced = $mfolder) : $_ } @cmd;
766 push @cmd, $mfolder unless defined($replaced);
767 if (my $sock = $self->{sock}) { # lei(1) client process runs it
768 send($sock, exec_buf(\@cmd, {}), MSG_EOR);
769 } elsif ($self->{oneshot}) {
770 $self->{"mua.pid.$self.$$"} = spawn(\@cmd);
772 delete $self->{-progress};
775 # caller needs to "-t $self->{1}" to check if tty
778 my $env = $self->{env};
779 my $fh = popen_rd([qw(git var GIT_PAGER)], $env);
780 chomp(my $pager = <$fh> // '');
781 close($fh) or warn "`git var PAGER' error: \$?=$?";
782 return if $pager eq 'cat' || $pager eq '';
784 my $new_env = { LESS => 'FRX', LV => '-c', COLUMNS => 80 };
785 $new_env->{MORE} = 'FRX' if $^O eq 'freebsd';
786 pipe(my ($r, $wpager)) or return warn "pipe: $!";
787 my $rdr = { 0 => $r, 1 => $self->{1}, 2 => $self->{2} };
788 my $pgr = [ undef, @$rdr{1, 2} ];
789 if (my $sock = $self->{sock}) { # lei(1) process runs it
790 delete @$new_env{keys %$env}; # only set iff unset
791 my $fds = [ map { fileno($_) } @$rdr{0..2} ];
792 $send_cmd->($sock, $fds, exec_buf([$pager], $new_env), MSG_EOR);
793 } elsif ($self->{oneshot}) {
794 $pgr->[0] = spawn([$pager], $new_env, $rdr);
795 $pgr->[3] = $$; # ew'll reap it
797 die 'BUG: start_pager w/o socket';
799 $self->{1} = $wpager;
800 $self->{2} = $wpager if -t $self->{2};
801 $env->{GIT_PAGER_IN_USE} = 'true'; # we may spawn git
807 my $pgr = delete($self->{pgr}) or return;
808 $self->{2} = $pgr->[2];
809 # do not restore original stdout, just close it so we error out
810 close(delete($self->{1})) if $self->{1};
812 dwaitpid($pid) if $pid && ($pgr->[3] // 0) == $$;
815 sub accept_dispatch { # Listener {post_accept} callback
816 my ($sock) = @_; # ignore other
818 my $self = bless { sock => $sock }, __PACKAGE__;
819 vec(my $rvec = '', fileno($sock), 1) = 1;
820 select($rvec, undef, undef, 60) or
821 return send($sock, 'timed out waiting to recv FDs', MSG_EOR);
822 my @fds = $recv_cmd->($sock, my $buf, 4096 * 33); # >MAX_ARG_STRLEN
823 if (scalar(@fds) == 4) {
825 my $fd = shift(@fds);
826 open($self->{$i}, '+<&=', $fd) and next;
827 send($sock, "open(+<&=$fd) (FD=$i): $!", MSG_EOR);
830 my $msg = "recv_cmd failed: $!";
832 return send($sock, $msg, MSG_EOR);
834 $self->{2}->autoflush(1); # keep stdout buffered until x_it|DESTROY
835 # $ENV_STR = join('', map { "\0$_=$ENV{$_}" } keys %ENV);
836 # $buf = "$argc\0".join("\0", @ARGV).$ENV_STR."\0\0";
837 substr($buf, -2, 2, '') eq "\0\0" or # s/\0\0\z//
838 return send($sock, 'request command truncated', MSG_EOR);
839 my ($argc, @argv) = split(/\0/, $buf, -1);
841 my %env = map { split(/=/, $_, 2) } splice(@argv, $argc);
842 if (chdir($self->{3})) {
844 $self->{env} = \%env;
845 eval { dispatch($self, @argv) };
846 send($sock, $@, MSG_EOR) if $@;
848 send($sock, "fchdir: $!", MSG_EOR); # implicit close
854 delete $self->{-progress};
855 for my $f (qw(lxs l2m)) {
856 my $wq = delete $self->{$f} or next;
859 } elsif ($wq->wq_kill_old) {
860 $wq->wq_wait_old($self);
863 close(delete $self->{1}) if $self->{1}; # may reap_compress
864 $self->close if $self->{sock}; # PublicInbox::DS::close
867 # for long-running results
870 local %ENV = %{$self->{env}};
871 my $sock = $self->{sock};
872 local $current_lei = $self;
874 while (my @fds = $recv_cmd->($sock, my $buf, 4096)) {
875 if (scalar(@fds) == 1 && !defined($fds[0])) {
876 return if $! == EAGAIN;
878 last if $! == ECONNRESET;
882 open my $rfh, '+<&=', $fd;
884 die "unrecognized client signal: $buf";
889 eval { $self->fail($err) };
894 sub event_step_init {
896 if (my $sock = $self->{sock}) { # using DS->EventLoop
897 $self->SUPER::new($sock, EPOLLIN|EPOLLET);
903 our $oldset; sub oldset { $oldset }
905 sub dump_and_clear_log {
906 if (defined($errors_log) && -s STDIN && seek(STDIN, 0, SEEK_SET)) {
908 unshift(@pfx, "$errors_log ") if @pfx;
909 warn @pfx, do { local $/; <STDIN> };
910 truncate(STDIN, 0) or warn "ftruncate ($errors_log): $!";
914 # lei(1) calls this when it can't connect
916 my ($path, $errno, $narg) = @_;
917 if ($errno == ECONNREFUSED) {
918 unlink($path) or die "unlink($path): $!";
919 } elsif ($errno != ENOENT) {
920 $! = $errno; # allow interpolation to stringify in die
921 die "connect($path): $!";
923 if (eval { require BSD::Resource }) {
924 my $NOFILE = BSD::Resource::RLIMIT_NOFILE();
925 my ($s, $h) = BSD::Resource::getrlimit($NOFILE);
926 BSD::Resource::setrlimit($NOFILE, $h, $h) if $s < $h;
928 umask(077) // die("umask(077): $!");
930 socket($listener, AF_UNIX, SOCK_SEQPACKET, 0) or die "socket: $!";
931 bind($listener, pack_sockaddr_un($path)) or die "bind($path): $!";
932 listen($listener, 1024) or die "listen: $!";
933 my @st = stat($path) or die "stat($path): $!";
934 my $dev_ino_expect = pack('dd', $st[0], $st[1]); # dev+ino
935 local $oldset = PublicInbox::DS::block_signals();
937 $send_cmd = PublicInbox::Spawn->can('send_cmd4');
938 $recv_cmd = PublicInbox::Spawn->can('recv_cmd4') // do {
939 require PublicInbox::CmdIPC4;
940 $send_cmd = PublicInbox::CmdIPC4->can('send_cmd4');
941 PublicInbox::CmdIPC4->can('recv_cmd4');
944 $recv_cmd or die <<"";
945 (Socket::MsgHdr || Inline::C) missing/unconfigured (narg=$narg);
947 require PublicInbox::Listener;
948 require PublicInbox::EOFpipe;
949 (-p STDOUT) or die "E: stdout must be a pipe\n";
951 ($errors_log) = ($path =~ m!\A(.+?/)[^/]+\z!);
952 $errors_log .= 'errors.log';
953 open(STDIN, '+>>', $errors_log) or die "open($errors_log): $!";
955 dump_and_clear_log("from previous daemon process:\n");
956 POSIX::setsid() > 0 or die "setsid: $!";
957 my $pid = fork // die "fork: $!";
959 $0 = "lei-daemon $path";
961 $listener->blocking(0);
963 my $pil = PublicInbox::Listener->new($listener, \&accept_dispatch);
965 pipe(my ($eof_r, $eof_w)) or die "pipe: $!";
966 PublicInbox::EOFpipe->new($eof_r, \&noop, undef);
968 $exit_code //= shift;
969 my $lis = $pil or exit($exit_code);
970 # closing eof_w triggers \&noop wakeup
971 $listener = $eof_w = $pil = $path = undef;
972 $lis->close; # DS::close
973 PublicInbox::DS->SetLoopTimeout(1000);
977 CHLD => \&PublicInbox::DS::enqueue_reap,
985 my $sigfd = PublicInbox::Sigfd->new($sig, SFD_NONBLOCK);
986 local @SIG{keys %$sig} = values(%$sig) unless $sigfd;
988 local $SIG{PIPE} = 'IGNORE';
989 if ($sigfd) { # TODO: use inotify/kqueue to detect unlinked sockets
991 PublicInbox::DS->SetLoopTimeout(5000);
993 # wake up every second to accept signals if we don't
994 # have signalfd or IO::KQueue:
995 PublicInbox::DS::sig_setmask($oldset);
996 PublicInbox::DS->SetLoopTimeout(1000);
998 PublicInbox::DS->SetPostLoopCallback(sub {
999 my ($dmap, undef) = @_;
1000 if (@st = defined($path) ? stat($path) : ()) {
1001 if ($dev_ino_expect ne pack('dd', $st[0], $st[1])) {
1002 warn "$path dev/ino changed, quitting\n";
1005 } elsif (defined($path)) { # ENOENT is common
1006 warn "stat($path): $!, quitting ...\n" if $! != ENOENT;
1010 return 1 if defined($path);
1013 for my $s (values %$dmap) {
1014 $s->can('busy') or next;
1015 if ($s->busy($now)) {
1021 $n; # true: continue, false: stop
1024 # STDIN was redirected to /dev/null above, closing STDERR and
1025 # STDOUT will cause the calling `lei' client process to finish
1026 # reading the <$daemon> pipe.
1027 local $SIG{__WARN__} = sub {
1028 $current_lei ? err($current_lei, @_) : warn(
1029 strftime('%Y-%m-%dT%H:%M:%SZ', gmtime(time))," $$ ", @_);
1031 open STDERR, '>&STDIN' or die "redirect stderr failed: $!";
1032 open STDOUT, '>&STDIN' or die "redirect stdout failed: $!";
1033 # $daemon pipe to `lei' closed, main loop begins:
1034 PublicInbox::DS->EventLoop;
1035 exit($exit_code // 0);
1038 # for users w/o Socket::Msghdr installed or Inline::C enabled
1040 my ($main_pkg) = @_;
1041 my $exit = $main_pkg->can('exit'); # caller may override exit()
1042 local $quit = $exit if $exit;
1044 umask(077) // die("umask(077): $!");
1052 dispatch($self, @ARGV);
1053 x_it($self, $self->{child_error}) if $self->{child_error};
1056 # ensures stdout hits the FS before sock disconnects so a client
1057 # can immediately reread it
1060 $self->{1}->autoflush(1) if $self->{1};
1062 if (my $mua_pid = delete $self->{"mua.pid.$self.$$"}) {
1063 waitpid($mua_pid, 0);