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::Lock;
26 use Time::HiRes qw(stat); # ctime comparisons for config cache
27 use File::Path qw(mkpath);
29 our $quit = \&CORE::exit;
30 our ($current_lei, $errors_log, $listener, $oldset);
31 my ($recv_cmd, $send_cmd);
32 my $GLP = Getopt::Long::Parser->new;
33 $GLP->configure(qw(gnu_getopt no_ignore_case auto_abbrev));
34 my $GLP_PASS = Getopt::Long::Parser->new;
35 $GLP_PASS->configure(qw(gnu_getopt no_ignore_case auto_abbrev pass_through));
37 our %PATH2CFG; # persistent for socket daemon
39 # TBD: this is a documentation mechanism to show a subcommand
40 # (may) pass options through to another command:
41 sub pass_through { $GLP_PASS }
45 my ($spec, $re_str) = @_; # 'limit|n=i', '([0-9]+)'
46 my ($key) = ($spec =~ m/\A([a-z]+)/g);
47 my $cb = sub { # Getopt::Long "<>" catch-all handler
49 if ($arg =~ /\A-($re_str)\z/) {
51 } elsif ($arg eq '--') { # "--" arg separator, ignore first
52 push @{$OPT->{-argv}}, $arg if $OPT->{'--'}++;
53 # lone (single) dash is handled elsewhere
54 } elsif (substr($arg, 0, 1) eq '-') {
56 push @{$OPT->{-argv}}, $arg;
58 die "bad argument: $arg\n";
61 push @{$OPT->{-argv}}, $arg;
64 ($spec, '<>' => $cb, $GLP_PASS) # for Getopt::Long
69 return $p if index($p, '/') == 0; # already absolute
70 my $pwd = $self->{env}->{PWD};
72 my $cwd = $self->{3} // getcwd() // die "getcwd(PWD=$pwd): $!";
73 if (my @st_pwd = stat($pwd)) {
74 my @st_cwd = stat($cwd) or die "stat($cwd): $!";
75 "@st_pwd[1,0]" eq "@st_cwd[1,0]" or
76 $self->{env}->{PWD} = $pwd = $cwd;
77 } else { # PWD was invalid
78 delete $self->{env}->{PWD};
82 $pwd //= $self->{env}->{PWD} = getcwd() // die "getcwd(PWD=$pwd): $!";
83 File::Spec->rel2abs($p, $pwd);
86 sub share_path ($) { # $HOME/.local/share/lei/$FOO
88 rel2abs($self, ($self->{env}->{XDG_DATA_HOME} //
89 ($self->{env}->{HOME} // '/nonexistent').'/.local/share')
93 sub store_path ($) { share_path($_[0]) . '/store' }
95 sub _config_path ($) {
97 rel2abs($self, ($self->{env}->{XDG_CONFIG_HOME} //
98 ($self->{env}->{HOME} // '/nonexistent').'/.config')
104 rel2abs($self, ($self->{env}->{XDG_CACHE_HOME} //
105 ($self->{env}->{HOME} // '/nonexistent').'/.cache')
111 $self->{ale} //= do {
112 require PublicInbox::LeiALE;
113 $self->_lei_cfg(1)->{ale} //= PublicInbox::LeiALE->new($self);
118 # TODO: drop underscore variants everywhere, they're undocumented
119 qw(fsync|sync! jobs|j=i indexlevel|L=s compact
120 max_size|max-size=s sequential_shard|sequential-shard
121 batch_size|batch-size=s skip-docdata)
124 my @c_opt = qw(c=s@ C=s@ quiet|q);
125 my @lxs_opt = (qw(remote! local! external! include|I=s@ exclude=s@ only=s@
126 import-remote! no-torsocks torsocks=s),
127 PublicInbox::LeiQuery::curl_opt());
129 # we generate shell completion + help using %CMD and %OPTDESC,
130 # see lei__complete() and PublicInbox::LeiHelp
131 # command => [ positional_args, 1-line description, Getopt::Long option spec ]
132 our %CMD = ( # sorted in order of importance/use:
133 'q' => [ '--stdin|SEARCH_TERMS...', 'search for messages matching terms',
134 'stdin|', # /|\z/ must be first for lone dash
136 qw(save output|mfolder|o=s format|f=s dedupe|d=s threads|t+
137 sort|s=s reverse|r offset=i pretty jobs|j=s globoff|g augment|a
138 import-before! lock=s@ rsyncable alert=s@ mua=s verbose|v+), @c_opt,
139 opt_dash('limit|n=i', '[0-9]+') ],
140 'up' => [ 'SEARCH_TERMS...', 'update saved search',
141 qw(jobs|j=s lock=s@ alert=s@ mua=s verbose|v+), @c_opt ],
143 'blob' => [ 'OID', 'show a git blob, reconstructing from mail if necessary',
144 qw(git-dir=s@ cwd! verbose|v+ mail! oid-a|A=s path-a|a=s path-b|b=s),
147 'add-external' => [ 'LOCATION',
148 'add/set priority of a publicinbox|extindex for extra matches',
149 qw(boost=i mirror=s no-torsocks torsocks=s inbox-version=i
150 verbose|v+), @c_opt, index_opt(),
151 PublicInbox::LeiQuery::curl_opt() ],
152 'ls-external' => [ '[FILTER]', 'list publicinbox|extindex locations',
153 qw(format|f=s z|0 globoff|g invert-match|v local remote), @c_opt ],
154 'ls-label' => [ '', 'list labels', qw(z|0 stats:s), @c_opt ],
155 'forget-external' => [ 'LOCATION...|--prune',
156 'exclude further results from a publicinbox|extindex',
159 'ls-query' => [ '[FILTER...]', 'list saved search queries',
160 qw(name-only format|f=s), @c_opt ],
161 'rm-query' => [ 'QUERY_NAME', 'remove a saved search', @c_opt ],
162 'mv-query' => [ qw(OLD_NAME NEW_NAME), 'rename a saved search', @c_opt ],
164 'plonk' => [ '--threads|--from=IDENT',
165 'exclude mail matching From: or threads from non-Message-ID searches',
166 qw(stdin| threads|t from|f=s mid=s oid=s), @c_opt ],
167 'tag' => [ 'KEYWORDS...',
168 'set/unset keywords and/or labels on message(s)',
169 qw(stdin| in-format|F=s input|i=s@ oid=s@ mid=s@), @c_opt,
170 pass_through('-kw:foo for delete') ],
171 'forget' => [ '[--stdin|--oid=OID|--by-mid=MID]',
172 "exclude message(s) on stdin from `q' search results",
173 qw(stdin| oid=s exact by-mid|mid:s), @c_opt ],
175 'purge-mailsource' => [ 'LOCATION|--all',
176 'remove imported messages from IMAP, Maildirs, and MH',
177 qw(exact! all jobs:i indexed), @c_opt ],
179 'add-watch' => [ 'LOCATION', 'watch for new messages and flag changes',
180 qw(import! kw|keywords|flags! interval=s recursive|r
181 exclude=s include=s), @c_opt ],
182 'ls-watch' => [ '[FILTER...]', 'list active watches with numbers and status',
183 qw(format|f=s z), @c_opt ],
184 'pause-watch' => [ '[WATCH_NUMBER_OR_FILTER]', qw(all local remote), @c_opt ],
185 'resume-watch' => [ '[WATCH_NUMBER_OR_FILTER]', qw(all local remote), @c_opt ],
186 'forget-watch' => [ '{WATCH_NUMBER|--prune}', 'stop and forget a watch',
189 'import' => [ 'LOCATION...|--stdin',
190 'one-time import/update from URL or filesystem',
191 qw(stdin| offset=i recursive|r exclude=s include|I=s
192 lock=s@ in-format|F=s kw|keywords|flags! verbose|v+), @c_opt ],
193 'convert' => [ 'LOCATION...|--stdin',
194 'one-time conversion from URL or filesystem to another format',
195 qw(stdin| in-format|F=s out-format|f=s output|mfolder|o=s
196 lock=s@ kw|keywords|flags!), @c_opt ],
197 'p2q' => [ 'FILE|COMMIT_OID|--stdin',
198 "use a patch to generate a query for `lei q --stdin'",
199 qw(stdin| want|w=s@ uri debug), @c_opt ],
200 'config' => [ '[...]', sub {
201 'git-config(1) wrapper for '._config_path($_[0]);
202 }, qw(config-file|system|global|file|f=s), # for conflict detection
203 qw(c=s@ C=s@), pass_through('git config') ],
204 'init' => [ '[DIRNAME]', sub {
205 "initialize storage, default: ".store_path($_[0]);
207 'daemon-kill' => [ '[-SIGNAL]', 'signal the lei-daemon',
208 # "-C DIR" conflicts with -CHLD, here, and chdir makes no sense, here
209 opt_dash('signal|s=s', '[0-9]+|(?:[A-Z][A-Z0-9]+)') ],
210 'daemon-pid' => [ '', 'show the PID of the lei-daemon' ],
211 'help' => [ '[SUBCOMMAND]', 'show help' ],
213 # XXX do we need this?
214 # 'git' => [ '[ANYTHING...]', 'git(1) wrapper', pass_through('git') ],
216 'reorder-local-store-and-break-history' => [ '[REFNAME]',
217 'rewrite git history in an attempt to improve compression',
220 # internal commands are prefixed with '_'
221 '_complete' => [ '[...]', 'internal shell completion helper',
222 pass_through('everything') ],
225 # switch descriptions, try to keep consistent across commands
226 # $spec: Getopt::Long option specification
227 # $spec => [@ALLOWED_VALUES (default is first), $description],
228 # $spec => $description
229 # "$SUB_COMMAND TAB $spec" => as above
230 my $stdin_formats = [ 'MAIL_FORMAT|eml|mboxrd|mboxcl2|mboxcl|mboxo',
231 'specify message input format' ];
232 my $ls_format = [ 'OUT|plain|json|null', 'listing output format' ];
234 # we use \x{a0} (non-breaking SP) to avoid wrapping in PublicInbox::LeiHelp
236 'help|h' => 'show this built-in help',
237 'c=s@' => [ 'NAME=VALUE', 'set config option' ],
238 'C=s@' => [ 'DIR', 'chdir to specify to directory' ],
239 'quiet|q' => 'be quiet',
240 'lock=s@' => [ 'METHOD|dotlock|fcntl|flock|none',
241 'mbox(5) locking method(s) to use (default: fcntl,dotlock)' ],
243 'globoff|g' => "do not match locations using '*?' wildcards ".
244 "and\xa0'[]'\x{a0}ranges",
245 'verbose|v+' => 'be more verbose',
246 'external!' => 'do not use externals',
247 'mail!' => 'do not look in mail storage for OID',
248 'cwd!' => 'do not look in git repo of current working directory',
249 'oid-a|A=s' => 'pre-image OID',
250 'path-a|a=s' => 'pre-image pathname associated with OID',
251 'path-b|b=s' => 'post-image pathname associated with OID',
252 'git-dir=s@' => 'additional git repository to scan',
253 'torsocks=s' => ['VAL|auto|no|yes',
254 'whether or not to wrap git and curl commands with torsocks'],
255 'no-torsocks' => 'alias for --torsocks=no',
256 'save' => "save a search for `lei up'",
257 'import-remote!' => 'do not memoize remote messages into local store',
259 'type=s' => [ 'any|mid|git', 'disambiguate type' ],
261 'dedupe|d=s' => ['STRATEGY|content|oid|mid|none',
262 'deduplication strategy'],
264 'return all messages in the same threads as the actual match(es)',
266 'want|w=s@' => [ 'PREFIX|dfpost|dfn', # common ones in help...
267 'search prefixes to extract (default: dfpost7)' ],
269 'alert=s@' => ['CMD,:WINCH,:bell,<any command>',
270 'run command(s) or perform ops when done writing to output ' .
271 '(default: ":WINCH,:bell" with --mua and Maildir/IMAP output, ' .
272 'nothing otherwise)' ],
274 'augment|a' => 'augment --output destination instead of clobbering',
276 'output|mfolder|o=s' => [ 'MFOLDER',
277 "destination (e.g.\xa0`/path/to/Maildir', ".
278 "or\xa0`-'\x{a0}for\x{a0}stdout)" ],
280 "MUA to run on --output Maildir or mbox (e.g.\xa0`mutt\xa0-f\xa0%f')" ],
282 'inbox-version=i' => [ 'NUM|1|2',
283 'force a public-inbox version with --mirror'],
284 'mirror=s' => [ 'URL', 'mirror a public-inbox'],
286 # public-inbox-index options
287 'fsync!' => 'speed up indexing after --mirror, risk index corruption',
288 'compact' => 'run compact index after mirroring',
289 'indexlevel|L=s' => [ 'LEVEL|full|medium|basic',
290 "indexlevel with --mirror (default: full)" ],
291 'max_size|max-size=s' => [ 'SIZE',
292 'do not index messages larger than SIZE (default: infinity)' ],
293 'batch_size|batch-size=s' => [ 'SIZE',
294 'flush changes to OS after given number of bytes (default: 1m)' ],
295 'sequential_shard|sequential-shard' =>
296 'index Xapian shards sequentially for slow storage',
298 'drop compatibility w/ public-inbox <1.6 to save ~1.5% space',
301 'OUT|maildir|mboxrd|mboxcl2|mboxcl|mboxo|html|json|jsonl|concatjson',
302 'specify output format, default depends on --output'],
303 'exclude=s@ q' => [ 'LOCATION',
304 'exclude specified external(s) from search' ],
305 'include|I=s@ q' => [ 'LOCATION',
306 'include specified external(s) in search' ],
307 'only=s@ q' => [ 'LOCATION',
308 'only use specified external(s) for search' ],
309 'jobs=s q' => [ '[SEARCH_JOBS][,WRITER_JOBS]',
310 'control number of search and writer jobs' ],
311 'jobs|j=i add-external' => 'set parallelism when indexing after --mirror',
313 'in-format|F=s' => $stdin_formats,
314 'format|f=s ls-query' => $ls_format,
315 'format|f=s ls-external' => $ls_format,
317 'limit|n=i@' => ['NUM', 'limit on number of matches (default: 10000)' ],
318 'offset=i' => ['OFF', 'search result offset (default: 0)'],
320 'sort|s=s' => [ 'VAL|received|relevance|docid',
321 "order of results is `--output'-dependent"],
322 'reverse|r' => 'reverse search results', # like sort(1)
324 'boost=i' => 'increase/decrease priority of results (default: 0)',
326 'local' => 'limit operations to the local filesystem',
327 'local!' => 'exclude results from the local filesystem',
328 'remote' => 'limit operations to those requiring network access',
329 'remote!' => 'prevent operations requiring network access',
331 'mid=s' => 'specify the Message-ID of a message',
332 'oid=s' => 'specify the git object ID of a message',
334 'recursive|r' => 'scan directories/mailboxes/newsgroups recursively',
335 'exclude=s' => 'exclude mailboxes/newsgroups based on pattern',
336 'include=s' => 'include mailboxes/newsgroups based on pattern',
338 'exact' => 'operate on exact header matches only',
339 'exact!' => 'rely on content match instead of exact header matches',
341 'by-mid|mid:s' => [ 'MID', 'match only by Message-ID, ignoring contents' ],
343 'kw|keywords|flags!' => 'disable/enable importing flags',
345 # xargs, env, use "-0", git(1) uses "-z". We support z|0 everywhere
346 'z|0' => 'use NUL \\0 instead of newline (CR) to delimit lines',
348 'signal|s=s' => [ 'SIG', 'signal to send lei-daemon (default: TERM)' ],
352 'leistore.dir' => 'top-level storage location',
355 my @WQ_KEYS = qw(lxs l2m imp mrr cnv p2q tag sol); # internal workers
359 for my $wq (grep(defined, delete(@$self{@WQ_KEYS}))) { $wq->DESTROY }
362 # pronounced "exit": x_it(1 << 8) => exit(1); x_it(13) => SIGPIPE
364 my ($self, $code) = @_;
365 # make sure client sees stdout before exit
366 $self->{1}->autoflush(1) if $self->{1};
367 dump_and_clear_log();
368 if (my $s = $self->{pkt_op_p} // $self->{sock}) {
369 send($s, "x_it $code", MSG_EOR);
370 } elsif ($self->{oneshot}) {
371 # don't want to end up using $? from child processes
373 # cleanup anything that has tempfiles or open file handles
375 delete @$self{qw(ovv dedupe sto cfg)};
376 if (my $signum = ($code & 127)) { # usually SIGPIPE (13)
377 $SIG{PIPE} = 'DEFAULT'; # $SIG{$signum} doesn't work
379 sleep(1) while 1; # wait for signal
383 } # else ignore if client disconnected
388 my $err = $self->{2} // ($self->{pgr} // [])->[2] // *STDERR{GLOB};
389 my @eor = (substr($_[-1]//'', -1, 1) eq "\n" ? () : ("\n"));
390 print $err @_, @eor and return;
391 my $old_err = delete $self->{2};
392 close($old_err) if $! == EPIPE && $old_err;
393 $err = $self->{2} = ($self->{pgr} // [])->[2] // *STDERR{GLOB};
394 print $err @_, @eor or print STDERR @_, @eor;
397 sub qerr ($;@) { $_[0]->{opt}->{quiet} or err(shift, @_) }
399 sub fail_handler ($;$$) {
400 my ($lei, $code, $io) = @_;
401 close($io) if $io; # needed to avoid warnings on SIGPIPE
403 x_it($lei, $code // (1 << 8));
406 sub sigpipe_handler { # handles SIGPIPE from @WQ_KEYS workers
407 fail_handler($_[0], 13, delete $_[0]->{1});
410 # PublicInbox::OnDestroy callback for SIGINT to take out the entire pgid
413 dwaitpid($pgid) if kill('-INT', $pgid);
417 my ($self, $buf, $exit_code) = @_;
418 err($self, $buf) if defined $buf;
419 # calls fail_handler:
420 send($self->{pkt_op_p}, '!', MSG_EOR) if $self->{pkt_op_p};
421 x_it($self, ($exit_code // 1) << 8);
427 return if print { $self->{1} // return } @_; # likely
428 return note_sigpipe($self, 1) if $! == EPIPE;
429 my $err = "error writing to output: $!";
434 sub puts ($;@) { out(shift, map { "$_\n" } @_) }
436 sub child_error { # passes non-fatal curl exit codes to user
437 my ($self, $child_error, $msg) = @_; # child_error is $?
438 $self->err($msg) if $msg;
439 if (my $s = $self->{pkt_op_p} // $self->{sock}) {
440 # send to the parent lei-daemon or to lei(1) client
441 send($s, "child_error $child_error", MSG_EOR);
442 } elsif (!$PublicInbox::DS::in_loop) {
443 $self->{child_error} = $child_error;
444 } # else noop if client disconnected
447 sub note_sigpipe { # triggers sigpipe_handler
448 my ($self, $fd) = @_;
449 close(delete($self->{$fd})); # explicit close silences Perl warning
450 send($self->{pkt_op_p}, '|', MSG_EOR) if $self->{pkt_op_p};
454 sub _lei_atfork_child {
455 my ($self, $persist) = @_;
456 # we need to explicitly close things which are on stack
458 chdir '/' or die "chdir(/): $!";
459 my @io = delete @$self{qw(0 1 2 sock)};
460 unless ($self->{oneshot}) {
463 if (my $cfg = $self->{cfg}) {
464 delete $cfg->{-lei_store};
466 } else { # worker, Net::NNTP (Net::Cmd) uses STDERR directly
467 open STDERR, '+>&='.fileno($self->{2}) or warn "open $!";
469 for (delete @$self{qw(3 old_1 au_done)}) {
470 close($_) if defined($_);
472 if (my $op_c = delete $self->{pkt_op_c}) {
473 close(delete $op_c->{sock});
475 if (my $pgr = delete $self->{pgr}) {
476 close($_) for (@$pgr[1,2]);
478 close $listener if $listener;
482 $quit = \&CORE::exit;
483 $current_lei = $persist ? undef : $self; # for SIG{__WARN__}
486 sub _delete_pkt_op { # OnDestroy callback to prevent leaks on die
488 if (my $op = delete $self->{pkt_op_c}) { # in case of die
489 $op->close; # PublicInbox::PktOp::close
491 my $unclosed_after_die = delete($self->{pkt_op_p}) or return;
492 close $unclosed_after_die;
497 require PublicInbox::OnDestroy;
498 require PublicInbox::PktOp;
499 my $end = PublicInbox::OnDestroy->new($$, \&_delete_pkt_op, $self);
500 @$self{qw(pkt_op_c pkt_op_p)} = PublicInbox::PktOp->pair;
505 my ($lei, $wq, $ident, $jobs, $ops) = @_;
507 '!' => [ \&fail_handler, $lei ],
508 '|' => [ \&sigpipe_handler, $lei ],
509 'x_it' => [ \&x_it, $lei ],
510 'child_error' => [ \&child_error, $lei ],
513 $ops->{''} //= [ \&dclose, $lei ];
514 my $end = $lei->pkt_op_pair;
515 $wq->wq_workers_start($ident, $jobs, $lei->oldset, { lei => $lei });
516 delete $lei->{pkt_op_p};
517 my $op_c = delete $lei->{pkt_op_c};
519 $lei->event_step_init;
524 require PublicInbox::LeiHelp;
525 PublicInbox::LeiHelp::call($_[0], $_[1], \%CMD, \%OPTDESC);
529 my ($self, $cmd, $argv) = @_;
530 # allow _complete --help to complete, not show help
531 return 1 if substr($cmd, 0, 1) eq '_';
533 $OPT = $self->{opt} //= {};
534 my $info = $CMD{$cmd} // [ '[...]' ];
535 my ($proto, undef, @spec) = @$info;
536 my $glp = ref($spec[-1]) eq ref($GLP) ? pop(@spec) : $GLP;
537 push @spec, qw(help|h);
539 if ($spec[0] =~ s/\|\z//s) { # "stdin|" or "clear|" allows "-" alias
540 $lone_dash = $spec[0];
541 $OPT->{$spec[0]} = \(my $var);
542 push @spec, '' => \$var;
544 $glp->getoptionsfromarray($argv, $OPT, @spec) or
545 return _help($self, "bad arguments or options for $cmd");
546 return _help($self) if $OPT->{help};
548 push @$argv, @{$OPT->{-argv}} if defined($OPT->{-argv});
550 # "-" aliases "stdin" or "clear"
551 $OPT->{$lone_dash} = ${$OPT->{$lone_dash}} if defined $lone_dash;
554 my $POS_ARG = '[A-Z][A-Z0-9_]+';
556 my @args = split(/ /, $proto);
557 for my $var (@args) {
558 if ($var =~ /\A$POS_ARG\.\.\.\z/o) { # >= 1 args;
559 $inf = defined($argv->[$i]) and last;
560 $var =~ s/\.\.\.\z//;
561 $err = "$var not supplied";
562 } elsif ($var =~ /\A$POS_ARG\z/o) { # required arg at $i
563 $argv->[$i++] // ($err = "$var not supplied");
564 } elsif ($var =~ /\.\.\.\]\z/) { # optional args start
567 } elsif ($var =~ /\A\[-?$POS_ARG\]\z/) { # one optional arg
569 } elsif ($var =~ /\A.+?\|/) { # required FOO|--stdin
570 $inf = 1 if index($var, '...') > 0;
571 my @or = split(/\|/, $var);
574 if ($o =~ /\A--([a-z0-9\-]+)/) {
575 $ok = defined($OPT->{$1});
577 } elsif (defined($argv->[$i])) {
581 } # else continue looping
585 $err = join(', ', @or) . " or $last must be set";
587 warn "BUG: can't parse `$var' in $proto";
591 if (!$inf && scalar(@$argv) > scalar(@args)) {
592 $err //= 'too many arguments';
594 $err ? fail($self, "usage: lei $cmd $proto\nE: $err") : 1;
597 sub _tmp_cfg { # for lei -c <name>=<value> ...
599 my $cfg = _lei_cfg($self, 1);
601 my $ft = File::Temp->new(TEMPLATE => 'lei_cfg-XXXX', TMPDIR => 1);
602 my $tmp = { '-f' => $ft->filename, -tmp => $ft };
604 print $ft <<EOM or return fail($self, "$tmp->{-f}: $!");
608 $tmp = $self->{cfg} = bless { %$cfg, %$tmp }, ref($cfg);
609 for (@{$self->{opt}->{c}}) {
610 /\A([^=\.]+\.[^=]+)(?:=(.*))?\z/ or return fail($self, <<EOM);
611 `-c $_' is not of the form -c <name>=<value>'
615 _config($self, '--add', $name, $value);
616 if (defined(my $v = $tmp->{$name})) {
617 if (ref($v) eq 'ARRAY') {
620 $tmp->{$name} = [ $v, $value ];
623 $tmp->{$name} = $value;
629 my ($self, $cmd, $pfx) = @_;
633 $cb = $self->can($pfx.$ucmd) and return $cb;
635 $base =~ s/_([a-z])/\u$1/g;
636 my $pkg = "PublicInbox::Lei\u$base";
637 ($INC{"PublicInbox/Lei\u$base.pm"} // eval("require $pkg")) ?
638 $pkg->can($pfx.$ucmd) : undef;
642 my ($self, $cmd, @argv) = @_;
643 local $current_lei = $self; # for __WARN__
644 dump_and_clear_log("from previous run\n");
645 return _help($self, 'no command given') unless defined($cmd);
646 # do not support Getopt bundling for this
647 while ($cmd eq '-C' || $cmd eq '-c') {
648 my $v = shift(@argv) // return fail($self, $cmd eq '-C' ?
649 '-C DIRECTORY' : '-c <name>=<value>');
650 push @{$self->{opt}->{substr($cmd, 1, 1)}}, $v;
651 $cmd = shift(@argv) // return _help($self, 'no command given');
653 if (my $cb = lazy_cb(__PACKAGE__, $cmd, 'lei_')) {
654 optparse($self, $cmd, \@argv) or return;
655 $self->{opt}->{c} and (_tmp_cfg($self) // return);
656 if (my $chdir = $self->{opt}->{C}) {
657 for my $d (@$chdir) {
658 next if $d eq ''; # same as git(1)
659 chdir $d or return fail($self, "cd $d: $!");
661 if (delete $self->{3}) { # update cwd for rel2abs
662 opendir my $dh, '.' or
663 return fail($self, "opendir . $!");
668 } elsif (grep(/\A-/, $cmd, @argv)) { # --help or -h only
669 $GLP->getoptionsfromarray([$cmd, @argv], {}, qw(help|h C=s@))
670 or return _help($self, 'bad arguments or options');
673 fail($self, "`$cmd' is not an lei command");
678 my ($self, $creat) = @_;
679 return $self->{cfg} if $self->{cfg};
680 my $f = _config_path($self);
682 my $cur_st = @st ? pack('dd', $st[10], $st[7]) : ''; # 10:ctime, 7:size
684 if (my $cfg = $PATH2CFG{$f}) { # reuse existing object in common case
685 return ($self->{cfg} = $cfg) if $cur_st eq $cfg->{-st};
686 ($sto, $sto_dir) = @$cfg{qw(-lei_store leistore.dir)};
691 return bless {}, 'PublicInbox::Config';
693 my (undef, $cfg_dir, undef) = File::Spec->splitpath($f);
694 -d $cfg_dir or mkpath($cfg_dir) or die "mkpath($cfg_dir): $!\n";
695 open my $fh, '>>', $f or die "open($f): $!\n";
696 @st = stat($fh) or die "fstat($f): $!\n";
697 $cur_st = pack('dd', $st[10], $st[7]);
698 qerr($self, "# $f created") if $self->{cmd} ne 'config';
700 my $cfg = PublicInbox::Config::git_config_dump($f);
701 bless $cfg, 'PublicInbox::Config';
702 $cfg->{-st} = $cur_st;
704 if ($sto && File::Spec->canonpath($sto_dir // store_path($self))
705 eq File::Spec->canonpath($cfg->{'leistore.dir'} //
706 store_path($self))) {
707 $cfg->{-lei_store} = $sto;
709 if (scalar(keys %PATH2CFG) > 5) {
710 # FIXME: use inotify/EVFILT_VNODE to detect unlinked configs
711 for my $k (keys %PATH2CFG) {
712 delete($PATH2CFG{$k}) unless -f $k
715 $self->{cfg} = $PATH2CFG{$f} = $cfg;
718 sub _lei_store ($;$) {
719 my ($self, $creat) = @_;
720 my $cfg = _lei_cfg($self, $creat);
721 $cfg->{-lei_store} //= do {
722 require PublicInbox::LeiStore;
723 my $dir = $cfg->{'leistore.dir'} // store_path($self);
724 return unless $creat || -d $dir;
725 PublicInbox::LeiStore->new($dir, { creat => $creat });
730 my ($self, @argv) = @_;
731 my %env = (%{$self->{env}}, GIT_CONFIG => undef);
732 my $cfg = _lei_cfg($self, 1);
733 my $cmd = [ qw(git config -f), $cfg->{'-f'}, @argv ];
734 my %rdr = map { $_ => $self->{$_} } (0..2);
735 waitpid(spawn($cmd, \%env, \%rdr), 0);
739 my ($self, @argv) = @_;
740 $self->{opt}->{'config-file'} and return fail $self,
741 "config file switches not supported by `lei config'";
743 x_it($self, $?) if $?;
746 sub lei_daemon_pid { puts shift, $$ }
748 sub lei_daemon_kill {
750 my $sig = $self->{opt}->{signal} // 'TERM';
751 kill($sig, $$) or fail($self, "kill($sig, $$): $!");
754 # Shell completion helper. Used by lei-completion.bash and hopefully
755 # other shells. Try to do as much here as possible to avoid redundancy
756 # and improve maintainability.
758 my ($self, @argv) = @_; # argv = qw(lei and any other args...)
759 shift @argv; # ignore "lei", the entire command is sent
760 @argv or return puts $self, grep(!/^_/, keys %CMD), qw(--help -h -C);
761 my $cmd = shift @argv;
762 my $info = $CMD{$cmd} // do { # filter matching commands
763 @argv or puts $self, grep(/\A\Q$cmd\E/, keys %CMD);
766 my ($proto, undef, @spec) = @$info;
768 my $re = defined($cur) ? qr/\A\Q$cur\E/ : qr/./;
769 if (substr(my $_cur = $cur // '-', 0, 1) eq '-') { # --switches
770 # gross special case since the only git-config options
771 # Consider moving to a table if we need more special cases
772 # we use Getopt::Long for are the ones we reject, so these
773 # are the ones we don't reject:
774 if ($cmd eq 'config') {
775 puts $self, grep(/$re/, keys %CONFIG_KEYS);
776 @spec = qw(add z|null get get-all unset unset-all
777 replace-all get-urlmatch
778 remove-section rename-section
779 name-only list|l edit|e
780 get-color-name get-colorbool);
783 # generate short/long names from Getopt::Long specs
784 puts $self, grep(/$re/, qw(--help -h -C), map {
785 if (s/[:=].+\z//) { # req/optional args, e.g output|o=i
786 } elsif (s/\+\z//) { # verbose|v+
788 # negation: mail! => no-mail|mail
789 s/([\w\-]+)/$1|no-$1/g
792 my $x = length > 1 ? "--$_" : "-$_";
793 $x eq $_cur ? () : $x;
794 } grep(!/_/, split(/\|/, $_, -1)) # help|h
795 } grep { $OPTDESC{"$_\t$cmd"} || $OPTDESC{$_} } @spec);
796 } elsif ($cmd eq 'config' && !@argv && !$CONFIG_KEYS{$cur}) {
797 puts $self, grep(/$re/, keys %CONFIG_KEYS);
800 # switch args (e.g. lei q -f mbox<TAB>)
801 if (($argv[-1] // $cur // '') =~ /\A--?([\w\-]+)\z/) {
802 my $opt = quotemeta $1;
804 my $v = $OPTDESC{$_};
805 my @v = ref($v) ? split(/\|/, $v->[0]) : ();
806 # get rid of ALL CAPS placeholder (e.g "OUT")
807 # (TODO: completion for external paths)
808 shift(@v) if scalar(@v) && uc($v[0]) eq $v[0];
810 } grep(/\A(?:[\w-]+\|)*$opt\b.*?(?:\t$cmd)?\z/, keys %OPTDESC);
812 if (my $cb = lazy_cb($self, $cmd, '_complete_')) {
813 puts $self, $cb->($self, @argv, $cur ? ($cur) : ());
815 # TODO: URLs, pathnames, OIDs, MIDs, etc... See optparse() for
820 my ($argv, $env) = @_;
821 my $argc = scalar @$argv;
822 my $buf = 'exec '.join("\0", scalar(@$argv), @$argv);
823 while (my ($k, $v) = each %$env) { $buf .= "\0$k=$v" };
829 my $mua = $self->{opt}->{mua} // return;
830 my $mfolder = $self->{ovv}->{dst};
831 my (@cmd, $replaced);
832 if ($mua =~ /\A(?:mutt|mailx|mail|neomutt)\z/) {
834 # TODO: help wanted: other common FOSS MUAs
836 require Text::ParseWords;
837 @cmd = Text::ParseWords::shellwords($mua);
838 # mutt uses '%f' for open-hook with compressed mbox, we follow
839 @cmd = map { $_ eq '%f' ? ($replaced = $mfolder) : $_ } @cmd;
841 push @cmd, $mfolder unless defined($replaced);
842 if (my $sock = $self->{sock}) { # lei(1) client process runs it
843 send($sock, exec_buf(\@cmd, {}), MSG_EOR);
844 } elsif ($self->{oneshot}) {
845 my $pid = fork // die "fork: $!";
846 if ($pid > 0) { # original process
848 warn "exec @cmd: $!\n";
851 POSIX::setsid() > 0 or die "setsid: $!";
853 if ($self->{lxs} && $self->{au_done}) { # kick wait_startq
854 syswrite($self->{au_done}, 'q' x ($self->{lxs}->{jobs} // 0));
856 return unless -t $self->{2}; # XXX how to determine non-TUI MUAs?
857 $self->{opt}->{quiet} = 1;
858 delete $self->{-progress};
859 delete $self->{opt}->{verbose};
862 sub send_exec_cmd { # tell script/lei to execute a command
863 my ($self, $io, $cmd, $env) = @_;
864 my $sock = $self->{sock} // die 'lei client gone';
865 my $fds = [ map { fileno($_) } @$io ];
866 $send_cmd->($sock, $fds, exec_buf($cmd, $env), MSG_EOR);
869 sub poke_mua { # forces terminal MUAs to wake up and hopefully notice new mail
871 my $alerts = $self->{opt}->{alert} // return;
872 while (my $op = shift(@$alerts)) {
873 if ($op eq ':WINCH') {
874 # hit the process group that started the MUA
876 send($self->{sock}, '-WINCH', MSG_EOR);
877 } elsif ($self->{oneshot}) {
880 } elsif ($op eq ':bell') {
882 } elsif ($op =~ /(?<!\\),/) { # bare ',' (not ',,')
883 push @$alerts, split(/(?<!\\),/, $op);
884 } elsif ($op =~ m!\A([/a-z0-9A-Z].+)!) {
885 my $cmd = $1; # run an arbitrary command
886 require Text::ParseWords;
887 $cmd = [ Text::ParseWords::shellwords($cmd) ];
888 if (my $s = $self->{sock}) {
889 send($s, exec_buf($cmd, {}), MSG_EOR);
890 } elsif ($self->{oneshot}) {
891 $self->{"pid.$self.$$"}->{spawn($cmd)} = $cmd;
894 err($self, "W: unsupported --alert=$op"); # non-fatal
899 my %path_to_fd = ('/dev/stdin' => 0, '/dev/stdout' => 1, '/dev/stderr' => 2);
900 $path_to_fd{"/dev/fd/$_"} = $_ for (0..2);
902 # this also normalizes the path
904 my ($self, $path) = @_;
905 $path = rel2abs($self, $path);
907 $path_to_fd{$path} // (
908 ($path =~ m!\A/(?:dev|proc/self)/fd/[0-9]+\z!) ?
909 fail($self, "cannot open $path from daemon") : -1
913 # caller needs to "-t $self->{1}" to check if tty
916 my $fh = popen_rd([qw(git var GIT_PAGER)]);
917 chomp(my $pager = <$fh> // '');
918 close($fh) or warn "`git var PAGER' error: \$?=$?";
919 return if $pager eq 'cat' || $pager eq '';
920 my $new_env = { LESS => 'FRX', LV => '-c' };
921 $new_env->{MORE} = 'FRX' if $^O eq 'freebsd';
922 pipe(my ($r, $wpager)) or return warn "pipe: $!";
923 my $rdr = { 0 => $r, 1 => $self->{1}, 2 => $self->{2} };
924 my $pgr = [ undef, @$rdr{1, 2} ];
925 my $env = $self->{env};
926 if ($self->{sock}) { # lei(1) process runs it
927 delete @$new_env{keys %$env}; # only set iff unset
928 send_exec_cmd($self, [ @$rdr{0..2} ], [$pager], $new_env);
929 } elsif ($self->{oneshot}) {
931 $self->{"pid.$self.$$"}->{spawn($cmd, $new_env, $rdr)} = $cmd;
933 die 'BUG: start_pager w/o socket';
935 $self->{1} = $wpager;
936 $self->{2} = $wpager if -t $self->{2};
937 $env->{GIT_PAGER_IN_USE} = 'true'; # we may spawn git
943 my $pgr = delete($self->{pgr}) or return;
944 $self->{2} = $pgr->[2];
945 # do not restore original stdout, just close it so we error out
946 close(delete($self->{1})) if $self->{1};
949 sub accept_dispatch { # Listener {post_accept} callback
950 my ($sock) = @_; # ignore other
952 my $self = bless { sock => $sock }, __PACKAGE__;
953 vec(my $rvec = '', fileno($sock), 1) = 1;
954 select($rvec, undef, undef, 60) or
955 return send($sock, 'timed out waiting to recv FDs', MSG_EOR);
956 # (4096 * 33) >MAX_ARG_STRLEN
957 my @fds = $recv_cmd->($sock, my $buf, 4096 * 33) or return; # EOF
958 if (!defined($fds[0])) {
959 warn(my $msg = "recv_cmd failed: $!");
960 return send($sock, $msg, MSG_EOR);
964 open($self->{$i++}, '+<&=', $fd) and next;
965 send($sock, "open(+<&=$fd) (FD=$i): $!", MSG_EOR);
967 return if scalar(@fds) != 4;
969 $self->{2}->autoflush(1); # keep stdout buffered until x_it|DESTROY
970 # $ENV_STR = join('', map { "\0$_=$ENV{$_}" } keys %ENV);
971 # $buf = "$argc\0".join("\0", @ARGV).$ENV_STR."\0\0";
972 substr($buf, -2, 2, '') eq "\0\0" or # s/\0\0\z//
973 return send($sock, 'request command truncated', MSG_EOR);
974 my ($argc, @argv) = split(/\0/, $buf, -1);
976 my %env = map { split(/=/, $_, 2) } splice(@argv, $argc);
977 if (chdir($self->{3})) {
979 $self->{env} = \%env;
980 eval { dispatch($self, @argv) };
981 send($sock, $@, MSG_EOR) if $@;
983 send($sock, "fchdir: $!", MSG_EOR); # implicit close
989 delete $self->{-progress};
991 close(delete $self->{1}) if $self->{1}; # may reap_compress
992 $self->close if $self->{-event_init_done}; # PublicInbox::DS::close
995 # for long-running results
998 local %ENV = %{$self->{env}};
999 my $sock = $self->{sock};
1000 local $current_lei = $self;
1002 while (my @fds = $recv_cmd->($sock, my $buf, 4096)) {
1003 if (scalar(@fds) == 1 && !defined($fds[0])) {
1004 return if $! == EAGAIN;
1005 next if $! == EINTR;
1006 last if $! == ECONNRESET;
1010 open my $rfh, '+<&=', $fd;
1012 die "unrecognized client signal: $buf";
1017 eval { $self->fail($err) };
1022 sub event_step_init {
1024 return if $self->{-event_init_done}++;
1025 if (my $sock = $self->{sock}) { # using DS->EventLoop
1026 $self->SUPER::new($sock, EPOLLIN|EPOLLET);
1032 sub oldset { $oldset }
1034 sub dump_and_clear_log {
1035 if (defined($errors_log) && -s STDIN && seek(STDIN, 0, SEEK_SET)) {
1037 unshift(@pfx, "$errors_log ") if @pfx;
1038 warn @pfx, do { local $/; <STDIN> };
1039 truncate(STDIN, 0) or warn "ftruncate ($errors_log): $!";
1043 # lei(1) calls this when it can't connect
1045 my ($path, $errno, $narg) = @_;
1046 local ($errors_log, $listener);
1047 ($errors_log) = ($path =~ m!\A(.+?/)[^/]+\z!);
1048 $errors_log .= 'errors.log';
1049 my $addr = pack_sockaddr_un($path);
1050 my $lk = bless { lock_path => $errors_log }, 'PublicInbox::Lock';
1052 socket($listener, AF_UNIX, SOCK_SEQPACKET, 0) or die "socket: $!";
1053 if ($errno == ECONNREFUSED || $errno == ENOENT) {
1054 return if connect($listener, $addr); # another process won
1055 if ($errno == ECONNREFUSED && -S $path) {
1056 unlink($path) or die "unlink($path): $!";
1059 $! = $errno; # allow interpolation to stringify in die
1060 die "connect($path): $!";
1062 umask(077) // die("umask(077): $!");
1063 bind($listener, $addr) or die "bind($path): $!";
1064 listen($listener, 1024) or die "listen: $!";
1067 my @st = stat($path) or die "stat($path): $!";
1068 my $dev_ino_expect = pack('dd', $st[0], $st[1]); # dev+ino
1069 local $oldset = PublicInbox::DS::block_signals();
1071 $send_cmd = PublicInbox::Spawn->can('send_cmd4');
1072 $recv_cmd = PublicInbox::Spawn->can('recv_cmd4') // do {
1073 require PublicInbox::CmdIPC4;
1074 $send_cmd = PublicInbox::CmdIPC4->can('send_cmd4');
1075 PublicInbox::CmdIPC4->can('recv_cmd4');
1078 $recv_cmd or die <<"";
1079 (Socket::MsgHdr || Inline::C) missing/unconfigured (narg=$narg);
1081 require PublicInbox::Listener;
1082 require PublicInbox::EOFpipe;
1083 (-p STDOUT) or die "E: stdout must be a pipe\n";
1084 open(STDIN, '+>>', $errors_log) or die "open($errors_log): $!";
1085 STDIN->autoflush(1);
1086 dump_and_clear_log("from previous daemon process:\n");
1087 POSIX::setsid() > 0 or die "setsid: $!";
1088 my $pid = fork // die "fork: $!";
1090 $0 = "lei-daemon $path";
1092 $listener->blocking(0);
1094 my $pil = PublicInbox::Listener->new($listener, \&accept_dispatch);
1096 pipe(my ($eof_r, $eof_w)) or die "pipe: $!";
1097 PublicInbox::EOFpipe->new($eof_r, \&noop, undef);
1099 $exit_code //= shift;
1100 my $lis = $pil or exit($exit_code);
1101 # closing eof_w triggers \&noop wakeup
1102 $listener = $eof_w = $pil = $path = undef;
1103 $lis->close; # DS::close
1104 PublicInbox::DS->SetLoopTimeout(1000);
1108 CHLD => \&PublicInbox::DS::enqueue_reap,
1116 my $sigfd = PublicInbox::Sigfd->new($sig, SFD_NONBLOCK);
1117 local @SIG{keys %$sig} = values(%$sig) unless $sigfd;
1119 local $SIG{PIPE} = 'IGNORE';
1120 if ($sigfd) { # TODO: use inotify/kqueue to detect unlinked sockets
1122 PublicInbox::DS->SetLoopTimeout(5000);
1124 # wake up every second to accept signals if we don't
1125 # have signalfd or IO::KQueue:
1126 PublicInbox::DS::sig_setmask($oldset);
1127 PublicInbox::DS->SetLoopTimeout(1000);
1129 PublicInbox::DS->SetPostLoopCallback(sub {
1130 my ($dmap, undef) = @_;
1131 if (@st = defined($path) ? stat($path) : ()) {
1132 if ($dev_ino_expect ne pack('dd', $st[0], $st[1])) {
1133 warn "$path dev/ino changed, quitting\n";
1136 } elsif (defined($path)) { # ENOENT is common
1137 warn "stat($path): $!, quitting ...\n" if $! != ENOENT;
1141 return 1 if defined($path);
1144 for my $s (values %$dmap) {
1145 $s->can('busy') or next;
1146 if ($s->busy($now)) {
1152 $n; # true: continue, false: stop
1155 # STDIN was redirected to /dev/null above, closing STDERR and
1156 # STDOUT will cause the calling `lei' client process to finish
1157 # reading the <$daemon> pipe.
1158 local $SIG{__WARN__} = sub {
1159 $current_lei ? err($current_lei, @_) : warn(
1160 strftime('%Y-%m-%dT%H:%M:%SZ', gmtime(time))," $$ ", @_);
1162 open STDERR, '>&STDIN' or die "redirect stderr failed: $!";
1163 open STDOUT, '>&STDIN' or die "redirect stdout failed: $!";
1164 # $daemon pipe to `lei' closed, main loop begins:
1165 PublicInbox::DS->EventLoop;
1166 exit($exit_code // 0);
1169 sub busy { 1 } # prevent daemon-shutdown if client is connected
1171 # for users w/o Socket::Msghdr installed or Inline::C enabled
1173 my ($main_pkg) = @_;
1174 my $exit = $main_pkg->can('exit'); # caller may override exit()
1175 local $quit = $exit if $exit;
1177 umask(077) // die("umask(077): $!");
1185 dispatch($self, @ARGV);
1186 x_it($self, $self->{child_error}) if $self->{child_error};
1189 # ensures stdout hits the FS before sock disconnects so a client
1190 # can immediately reread it
1193 $self->{1}->autoflush(1) if $self->{1};
1196 my $oneshot_pids = delete $self->{"pid.$self.$$"} or return;
1197 waitpid($_, 0) for keys %$oneshot_pids;
1198 $? = $err if $err; # preserve ->fail or ->x_it code