]> Sergey Matveev's repositories - public-inbox.git/blob - lib/PublicInbox/LEI.pm
7349c2614bf307a3e509922acff201379dd1a779
[public-inbox.git] / lib / PublicInbox / LEI.pm
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>
3
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;
9 use strict;
10 use v5.10.1;
11 use parent qw(PublicInbox::DS PublicInbox::LeiExternal
12         PublicInbox::LeiQuery);
13 use Getopt::Long ();
14 use Socket qw(AF_UNIX SOCK_SEQPACKET MSG_EOR pack_sockaddr_un);
15 use Errno qw(EPIPE EAGAIN EINTR ECONNREFUSED ENOENT ECONNRESET);
16 use Cwd qw(getcwd);
17 use POSIX qw(strftime);
18 use IO::Handle ();
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 PublicInbox::Eml;
27 use Time::HiRes qw(stat); # ctime comparisons for config cache
28 use File::Path qw(mkpath);
29 use File::Spec;
30 our $quit = \&CORE::exit;
31 our ($current_lei, $errors_log, $listener, $oldset);
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));
37
38 our %PATH2CFG; # persistent for socket daemon
39
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 }
43
44 my $OPT;
45 sub opt_dash ($$) {
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
49                 my ($arg) = @_;
50                 if ($arg =~ /\A-($re_str)\z/) {
51                         $OPT->{$key} = $1;
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 '-') {
56                         if ($OPT->{'--'}) {
57                                 push @{$OPT->{-argv}}, $arg;
58                         } else {
59                                 die "bad argument: $arg\n";
60                         }
61                 } else {
62                         push @{$OPT->{-argv}}, $arg;
63                 }
64         };
65         ($spec, '<>' => $cb, $GLP_PASS) # for Getopt::Long
66 }
67
68 # rel2abs preserves symlinks in parent, unlike abs_path
69 sub rel2abs {
70         my ($self, $p) = @_;
71         if (index($p, '/') == 0) { # already absolute
72                 $p =~ tr!/!/!s; # squeeze redundant slashes
73                 chop($p) if substr($p, -1, 1) eq '/';
74                 return $p;
75         }
76         my $pwd = $self->{env}->{PWD};
77         my $cwd;
78         if (defined $pwd) {
79                 my $xcwd = $self->{3} //
80                         ($cwd = getcwd() // die "getcwd(PWD=$pwd): $!");
81                 if (my @st_pwd = stat($pwd)) {
82                         my @st_cwd = stat($xcwd) or die "stat($xcwd): $!";
83                         "@st_pwd[1,0]" eq "@st_cwd[1,0]" or
84                                 $self->{env}->{PWD} = $pwd = undef;
85                 } else { # PWD was invalid
86                         $self->{env}->{PWD} = $pwd = undef;
87                 }
88         }
89         $pwd //= $self->{env}->{PWD} = $cwd // getcwd() // die "getcwd: $!";
90         File::Spec->rel2abs($p, $pwd);
91 }
92
93 # abs_path resolves symlinks in parent iff all parents exist
94 sub abs_path { Cwd::abs_path($_[1]) // rel2abs(@_) }
95
96 sub share_path ($) { # $HOME/.local/share/lei/$FOO
97         my ($self) = @_;
98         rel2abs($self, ($self->{env}->{XDG_DATA_HOME} //
99                 ($self->{env}->{HOME} // '/nonexistent').'/.local/share')
100                 .'/lei');
101 }
102
103 sub store_path ($) { share_path($_[0]) . '/store' }
104
105 sub _config_path ($) {
106         my ($self) = @_;
107         rel2abs($self, ($self->{env}->{XDG_CONFIG_HOME} //
108                 ($self->{env}->{HOME} // '/nonexistent').'/.config')
109                 .'/lei/config');
110 }
111
112 sub cache_dir ($) {
113         my ($self) = @_;
114         rel2abs($self, ($self->{env}->{XDG_CACHE_HOME} //
115                 ($self->{env}->{HOME} // '/nonexistent').'/.cache')
116                 .'/lei');
117 }
118
119 sub ale {
120         my ($self) = @_;
121         $self->{ale} //= do {
122                 require PublicInbox::LeiALE;
123                 $self->_lei_cfg(1)->{ale} //= PublicInbox::LeiALE->new($self);
124         };
125 }
126
127 sub index_opt {
128         # TODO: drop underscore variants everywhere, they're undocumented
129         qw(fsync|sync! jobs|j=i indexlevel|L=s compact
130         max_size|max-size=s sequential_shard|sequential-shard
131         batch_size|batch-size=s skip-docdata)
132 }
133
134 my @c_opt = qw(c=s@ C=s@ quiet|q);
135 my @lxs_opt = (qw(remote! local! external! include|I=s@ exclude=s@ only=s@
136         import-remote! no-torsocks torsocks=s),
137         PublicInbox::LeiQuery::curl_opt());
138
139 # we don't support -C as an alias for --find-copies since it's already
140 # used for chdir
141 our @diff_opt = qw(unified|U=i output-indicator-new=s output-indicator-old=s
142         output-indicator-context=s indent-heuristic!
143         minimal patience histogram anchored=s@ diff-algorithm=s
144         color-moved=s color-moved-ws=s no-color-moved no-color-moved-ws
145         word-diff:s word-diff-regex=s color-words:s no-renames
146         rename-empty! check ws-error-highlight=s full-index binary
147         abbrev:i break-rewrites|B:s find-renames|M:s find-copies:s
148         find-copies-harder irreversible-delete|D l=i diff-filter=s
149         S=s G=s find-object=s pickaxe-all pickaxe-regex O=s R
150         relative:s text|a ignore-cr-at-eol ignore-space-at-eol
151         ignore-space-change|b ignore-all-space|w ignore-blank-lines
152         inter-hunk-context=i function-context|W exit-code ext-diff
153         no-ext-diff textconv! src-prefix=s dst-prefix=s no-prefix
154         line-prefix=s);
155
156 # we generate shell completion + help using %CMD and %OPTDESC,
157 # see lei__complete() and PublicInbox::LeiHelp
158 # command => [ positional_args, 1-line description, Getopt::Long option spec ]
159 our %CMD = ( # sorted in order of importance/use:
160 'q' => [ '--stdin|SEARCH_TERMS...', 'search for messages matching terms',
161         'stdin|', # /|\z/ must be first for lone dash
162         @lxs_opt,
163         qw(save output|mfolder|o=s format|f=s dedupe|d=s threads|t+
164         sort|s=s reverse|r offset=i pretty jobs|j=s globoff|g augment|a
165         import-before! lock=s@ rsyncable alert=s@ mua=s verbose|v+
166         color! mail-sync!), @c_opt, opt_dash('limit|n=i', '[0-9]+') ],
167
168 'up' => [ 'OUTPUT|--all', 'update saved search',
169         qw(jobs|j=s lock=s@ alert=s@ mua=s verbose|v+ all:s), @c_opt ],
170
171 'lcat' => [ '--stdin|MSGID_OR_URL..', 'display local copy of message(s)',
172         'stdin|', # /|\z/ must be first for lone dash
173         # some of these options are ridiculous for lcat
174         @lxs_opt, qw(output|mfolder|o=s format|f=s dedupe|d=s threads|t+
175         sort|s=s reverse|r offset=i jobs|j=s globoff|g augment|a
176         import-before! lock=s@ rsyncable alert=s@ mua=s verbose|v+
177         color!), @c_opt, opt_dash('limit|n=i', '[0-9]+') ],
178
179 'blob' => [ 'OID', 'show a git blob, reconstructing from mail if necessary',
180         qw(git-dir=s@ cwd! verbose|v+ mail! oid-a|A=s path-a|a=s path-b|b=s),
181         @lxs_opt, @c_opt ],
182
183 'rediff' => [ '[--stdin|LOCATION...]',
184                 'regenerate a diff with different options',
185         qw(git-dir=s@ cwd! verbose|v+ color:s no-color),
186         @diff_opt, @lxs_opt, @c_opt ],
187
188 'add-external' => [ 'LOCATION',
189         'add/set priority of a publicinbox|extindex for extra matches',
190         qw(boost=i mirror=s no-torsocks torsocks=s inbox-version=i
191         verbose|v+), @c_opt, index_opt(),
192         PublicInbox::LeiQuery::curl_opt() ],
193 'ls-external' => [ '[FILTER]', 'list publicinbox|extindex locations',
194         qw(format|f=s z|0 globoff|g invert-match|v local remote), @c_opt ],
195 'ls-label' => [ '', 'list labels', qw(z|0 stats:s), @c_opt ],
196 'ls-mail-sync' => [ '[FILTER]', 'list mail sync folders',
197                 qw(z|0 globoff|g invert-match|v local remote), @c_opt ],
198 'forget-external' => [ 'LOCATION...|--prune',
199         'exclude further results from a publicinbox|extindex',
200         qw(prune), @c_opt ],
201
202 'ls-search' => [ '[PREFIX]', 'list saved search queries',
203                 qw(format|f=s pretty l ascii z|0), @c_opt ],
204 'forget-search' => [ 'OUTPUT', 'forget a saved search',
205                 qw(verbose|v+), @c_opt ],
206 'edit-search' => [ 'OUTPUT', "edit saved search via `git config --edit'",
207                         @c_opt ],
208
209 'plonk' => [ '--threads|--from=IDENT',
210         'exclude mail matching From: or threads from non-Message-ID searches',
211         qw(stdin| threads|t from|f=s mid=s oid=s), @c_opt ],
212 'tag' => [ 'KEYWORDS...',
213         'set/unset keywords and/or labels on message(s)',
214         qw(stdin| in-format|F=s input|i=s@ oid=s@ mid=s@),
215         qw(no-torsocks torsocks=s), PublicInbox::LeiQuery::curl_opt(), @c_opt,
216         pass_through('-kw:foo for delete') ],
217 'forget' => [ '[--stdin|--oid=OID|--by-mid=MID]',
218         "exclude message(s) on stdin from `q' search results",
219         qw(stdin| oid=s exact by-mid|mid:s), @c_opt ],
220
221 'purge-mailsource' => [ 'LOCATION|--all',
222         'remove imported messages from IMAP, Maildirs, and MH',
223         qw(exact! all jobs:i indexed), @c_opt ],
224
225 'add-watch' => [ 'LOCATION', 'watch for new messages and flag changes',
226         qw(import! kw! interval=s recursive|r
227         exclude=s include=s), @c_opt ],
228 'ls-watch' => [ '[FILTER...]', 'list active watches with numbers and status',
229                 qw(format|f=s z), @c_opt ],
230 'pause-watch' => [ '[WATCH_NUMBER_OR_FILTER]', qw(all local remote), @c_opt ],
231 'resume-watch' => [ '[WATCH_NUMBER_OR_FILTER]', qw(all local remote), @c_opt ],
232 'forget-watch' => [ '{WATCH_NUMBER|--prune}', 'stop and forget a watch',
233         qw(prune), @c_opt ],
234
235 'import' => [ 'LOCATION...|--stdin',
236         'one-time import/update from URL or filesystem',
237         qw(stdin| offset=i recursive|r exclude=s include|I=s
238         lock=s@ in-format|F=s kw! verbose|v+ incremental! mail-sync!),
239         qw(no-torsocks torsocks=s), PublicInbox::LeiQuery::curl_opt(), @c_opt ],
240 'convert' => [ 'LOCATION...|--stdin',
241         'one-time conversion from URL or filesystem to another format',
242         qw(stdin| in-format|F=s out-format|f=s output|mfolder|o=s lock=s@ kw!),
243         qw(no-torsocks torsocks=s), PublicInbox::LeiQuery::curl_opt(), @c_opt ],
244 'p2q' => [ 'FILE|COMMIT_OID|--stdin',
245         "use a patch to generate a query for `lei q --stdin'",
246         qw(stdin| want|w=s@ uri debug), @c_opt ],
247 'config' => [ '[...]', sub {
248                 'git-config(1) wrapper for '._config_path($_[0]);
249         }, qw(config-file|system|global|file|f=s), # for conflict detection
250          qw(c=s@ C=s@), pass_through('git config') ],
251 'inspect' => [ 'ITEMS...', 'inspect lei/store and/or local external',
252         qw(pretty ascii dir=s), @c_opt ],
253
254 'init' => [ '[DIRNAME]', sub {
255         "initialize storage, default: ".store_path($_[0]);
256         }, @c_opt ],
257 'daemon-kill' => [ '[-SIGNAL]', 'signal the lei-daemon',
258         # "-C DIR" conflicts with -CHLD, here, and chdir makes no sense, here
259         opt_dash('signal|s=s', '[0-9]+|(?:[A-Z][A-Z0-9]+)') ],
260 'daemon-pid' => [ '', 'show the PID of the lei-daemon' ],
261 'help' => [ '[SUBCOMMAND]', 'show help' ],
262
263 # XXX do we need this?
264 # 'git' => [ '[ANYTHING...]', 'git(1) wrapper', pass_through('git') ],
265
266 'reorder-local-store-and-break-history' => [ '[REFNAME]',
267         'rewrite git history in an attempt to improve compression',
268         qw(gc!), @c_opt ],
269
270 # internal commands are prefixed with '_'
271 '_complete' => [ '[...]', 'internal shell completion helper',
272                 pass_through('everything') ],
273 ); # @CMD
274
275 # switch descriptions, try to keep consistent across commands
276 # $spec: Getopt::Long option specification
277 # $spec => [@ALLOWED_VALUES (default is first), $description],
278 # $spec => $description
279 # "$SUB_COMMAND TAB $spec" => as above
280 my $stdin_formats = [ 'MAIL_FORMAT|eml|mboxrd|mboxcl2|mboxcl|mboxo',
281                         'specify message input format' ];
282 my $ls_format = [ 'OUT|plain|json|null', 'listing output format' ];
283
284 # we use \x{a0} (non-breaking SP) to avoid wrapping in PublicInbox::LeiHelp
285 my %OPTDESC = (
286 'help|h' => 'show this built-in help',
287 'c=s@' => [ 'NAME=VALUE', 'set config option' ],
288 'C=s@' => [ 'DIR', 'chdir to specify to directory' ],
289 'quiet|q' => 'be quiet',
290 'lock=s@' => [ 'METHOD|dotlock|fcntl|flock|none',
291         'mbox(5) locking method(s) to use (default: fcntl,dotlock)' ],
292
293 'incremental!   import' => 'import already seen IMAP and NNTP articles',
294 'globoff|g' => "do not match locations using '*?' wildcards ".
295                 "and\xa0'[]'\x{a0}ranges",
296 'invert-match|v' => 'select non-matching lines',
297 'color!' => 'disable color (for --format=text)',
298 'verbose|v+' => 'be more verbose',
299 'external!' => 'do not use externals',
300 'mail!' => 'do not look in mail storage for OID',
301 'cwd!' => 'do not look in git repo of current working directory',
302 'oid-a|A=s' => 'pre-image OID',
303 'path-a|a=s' => 'pre-image pathname associated with OID',
304 'path-b|b=s' => 'post-image pathname associated with OID',
305 'git-dir=s@' => 'additional git repository to scan',
306 'proxy=s' => [ 'PROTO://HOST[:PORT]', # shared with curl(1)
307         "proxy for (e.g. `socks5h://0:9050')" ],
308 'torsocks=s' => ['VAL|auto|no|yes',
309                 'whether or not to wrap git and curl commands with torsocks'],
310 'no-torsocks' => 'alias for --torsocks=no',
311 'save' =>  "save a search for `lei up'",
312 'import-remote!' => 'do not memoize remote messages into local store',
313
314 'type=s' => [ 'any|mid|git', 'disambiguate type' ],
315
316 'dedupe|d=s' => ['STRATEGY|content|oid|mid|none',
317                 'deduplication strategy'],
318 'threads|t+' =>
319         'return all messages in the same threads as the actual match(es)',
320
321 'want|w=s@' => [ 'PREFIX|dfpost|dfn', # common ones in help...
322                 'search prefixes to extract (default: dfpost7)' ],
323
324 'alert=s@' => ['CMD,:WINCH,:bell,<any command>',
325         'run command(s) or perform ops when done writing to output ' .
326         '(default: ":WINCH,:bell" with --mua and Maildir/IMAP output, ' .
327         'nothing otherwise)' ],
328
329 'augment|a' => 'augment --output destination instead of clobbering',
330
331 'output|mfolder|o=s' => [ 'MFOLDER',
332         "destination (e.g.\xa0`/path/to/Maildir', ".
333         "or\xa0`-'\x{a0}for\x{a0}stdout)" ],
334 'mua=s' => [ 'CMD',
335         "MUA to run on --output Maildir or mbox (e.g.\xa0`mutt\xa0-f\xa0%f')" ],
336
337 'inbox-version=i' => [ 'NUM|1|2',
338                 'force a public-inbox version with --mirror'],
339 'mirror=s' => [ 'URL', 'mirror a public-inbox'],
340
341 # public-inbox-index options
342 'fsync!' => 'speed up indexing after --mirror, risk index corruption',
343 'compact' => 'run compact index after mirroring',
344 'indexlevel|L=s' => [ 'LEVEL|full|medium|basic',
345         "indexlevel with --mirror (default: full)" ],
346 'max_size|max-size=s' => [ 'SIZE',
347         'do not index messages larger than SIZE (default: infinity)' ],
348 'batch_size|batch-size=s' => [ 'SIZE',
349         'flush changes to OS after given number of bytes (default: 1m)' ],
350 'sequential_shard|sequential-shard' =>
351         'index Xapian shards sequentially for slow storage',
352 'skip-docdata' =>
353         'drop compatibility w/ public-inbox <1.6 to save ~1.5% space',
354
355 'format|f=s     q' => [
356         'OUT|maildir|mboxrd|mboxcl2|mboxcl|mboxo|html|json|jsonl|concatjson',
357                 'specify output format, default depends on --output'],
358 'exclude=s@     q' => [ 'LOCATION',
359                 'exclude specified external(s) from search' ],
360 'include|I=s@   q' => [ 'LOCATION',
361                 'include specified external(s) in search' ],
362 'only=s@        q' => [ 'LOCATION',
363                 'only use specified external(s) for search' ],
364 'jobs=s q' => [ '[SEARCH_JOBS][,WRITER_JOBS]',
365                 'control number of search and writer jobs' ],
366 'jobs|j=i       add-external' => 'set parallelism when indexing after --mirror',
367
368 'in-format|F=s' => $stdin_formats,
369 'format|f=s     ls-search' => ['OUT|json|jsonl|concatjson',
370                         'listing output format' ],
371 'l      ls-search' => 'long listing format',
372 'format|f=s     ls-external' => $ls_format,
373
374 'limit|n=i@' => ['NUM', 'limit on number of matches (default: 10000)' ],
375 'offset=i' => ['OFF', 'search result offset (default: 0)'],
376
377 'sort|s=s' => [ 'VAL|received|relevance|docid',
378                 "order of results is `--output'-dependent"],
379 'reverse|r' => 'reverse search results', # like sort(1)
380
381 'boost=i' => 'increase/decrease priority of results (default: 0)',
382
383 'local' => 'limit operations to the local filesystem',
384 'local!' => 'exclude results from the local filesystem',
385 'remote' => 'limit operations to those requiring network access',
386 'remote!' => 'prevent operations requiring network access',
387
388 'all:s  up' => ['local', 'update all (local) saved searches' ],
389
390 'mid=s' => 'specify the Message-ID of a message',
391 'oid=s' => 'specify the git object ID of a message',
392
393 'recursive|r' => 'scan directories/mailboxes/newsgroups recursively',
394 'exclude=s' => 'exclude mailboxes/newsgroups based on pattern',
395 'include=s' => 'include mailboxes/newsgroups based on pattern',
396
397 'exact' => 'operate on exact header matches only',
398 'exact!' => 'rely on content match instead of exact header matches',
399
400 'by-mid|mid:s' => [ 'MID', 'match only by Message-ID, ignoring contents' ],
401
402 'kw!' => 'disable/enable importing keywords (aka "flags")',
403
404 # xargs, env, use "-0", git(1) uses "-z".  We support z|0 everywhere
405 'z|0' => 'use NUL \\0 instead of newline (CR) to delimit lines',
406
407 'signal|s=s' => [ 'SIG', 'signal to send lei-daemon (default: TERM)' ],
408 ); # %OPTDESC
409
410 my %CONFIG_KEYS = (
411         'leistore.dir' => 'top-level storage location',
412 );
413
414 my @WQ_KEYS = qw(lxs l2m wq1); # internal workers
415
416 sub _drop_wq {
417         my ($self) = @_;
418         for my $wq (grep(defined, delete(@$self{@WQ_KEYS}))) {
419                 if ($wq->wq_kill) {
420                         $wq->wq_close(0, undef, $self);
421                 } elsif ($wq->wq_kill_old) {
422                         $wq->wq_wait_old(undef, $self);
423                 }
424                 $wq->DESTROY;
425         }
426 }
427
428 # pronounced "exit": x_it(1 << 8) => exit(1); x_it(13) => SIGPIPE
429 sub x_it ($$) {
430         my ($self, $code) = @_;
431         # make sure client sees stdout before exit
432         $self->{1}->autoflush(1) if $self->{1};
433         dump_and_clear_log();
434         if (my $s = $self->{pkt_op_p} // $self->{sock}) {
435                 send($s, "x_it $code", MSG_EOR);
436         } elsif ($self->{oneshot}) {
437                 # don't want to end up using $? from child processes
438                 _drop_wq($self);
439                 # cleanup anything that has tempfiles or open file handles
440                 %PATH2CFG = ();
441                 delete @$self{qw(ovv dedupe sto cfg)};
442                 if (my $signum = ($code & 127)) { # usually SIGPIPE (13)
443                         $SIG{PIPE} = 'DEFAULT'; # $SIG{$signum} doesn't work
444                         kill $signum, $$;
445                         sleep(1) while 1; # wait for signal
446                 } else {
447                         $quit->($code >> 8);
448                 }
449         } # else ignore if client disconnected
450 }
451
452 sub err ($;@) {
453         my $self = shift;
454         my $err = $self->{2} // ($self->{pgr} // [])->[2] // *STDERR{GLOB};
455         my @eor = (substr($_[-1]//'', -1, 1) eq "\n" ? () : ("\n"));
456         print $err @_, @eor and return;
457         my $old_err = delete $self->{2};
458         close($old_err) if $! == EPIPE && $old_err;
459         $err = $self->{2} = ($self->{pgr} // [])->[2] // *STDERR{GLOB};
460         print $err @_, @eor or print STDERR @_, @eor;
461 }
462
463 sub qerr ($;@) { $_[0]->{opt}->{quiet} or err(shift, @_) }
464
465 sub fail_handler ($;$$) {
466         my ($lei, $code, $io) = @_;
467         close($io) if $io; # needed to avoid warnings on SIGPIPE
468         _drop_wq($lei);
469         x_it($lei, $code // (1 << 8));
470 }
471
472 sub sigpipe_handler { # handles SIGPIPE from @WQ_KEYS workers
473         fail_handler($_[0], 13, delete $_[0]->{1});
474 }
475
476 # PublicInbox::OnDestroy callback for SIGINT to take out the entire pgid
477 sub sigint_reap {
478         my ($pgid) = @_;
479         dwaitpid($pgid) if kill('-INT', $pgid);
480 }
481
482 sub fail ($$;$) {
483         my ($self, $buf, $exit_code) = @_;
484         err($self, $buf) if defined $buf;
485         # calls fail_handler:
486         send($self->{pkt_op_p}, '!', MSG_EOR) if $self->{pkt_op_p};
487         x_it($self, ($exit_code // 1) << 8);
488         undef;
489 }
490
491 sub out ($;@) {
492         my $self = shift;
493         return if print { $self->{1} // return } @_; # likely
494         return note_sigpipe($self, 1) if $! == EPIPE;
495         my $err = "error writing to output: $!";
496         delete $self->{1};
497         fail($self, $err);
498 }
499
500 sub puts ($;@) { out(shift, map { "$_\n" } @_) }
501
502 sub child_error { # passes non-fatal curl exit codes to user
503         my ($self, $child_error, $msg) = @_; # child_error is $?
504         $self->err($msg) if $msg;
505         if (my $s = $self->{pkt_op_p} // $self->{sock}) {
506                 # send to the parent lei-daemon or to lei(1) client
507                 send($s, "child_error $child_error", MSG_EOR);
508         } elsif (!$PublicInbox::DS::in_loop) {
509                 $self->{child_error} = $child_error;
510         } # else noop if client disconnected
511 }
512
513 sub note_sigpipe { # triggers sigpipe_handler
514         my ($self, $fd) = @_;
515         close(delete($self->{$fd})); # explicit close silences Perl warning
516         send($self->{pkt_op_p}, '|', MSG_EOR) if $self->{pkt_op_p};
517         x_it($self, 13);
518 }
519
520 sub _lei_atfork_child {
521         my ($self, $persist) = @_;
522         # we need to explicitly close things which are on stack
523         if ($persist) {
524                 chdir '/' or die "chdir(/): $!";
525                 close($_) for (grep(defined, delete @$self{qw(0 1 2 sock)}));
526                 if (my $cfg = $self->{cfg}) {
527                         delete $cfg->{-lei_store};
528                 }
529         } else { # worker, Net::NNTP (Net::Cmd) uses STDERR directly
530                 open STDERR, '+>&='.fileno($self->{2}) or warn "open $!";
531                 STDERR->autoflush(1);
532         }
533         close($_) for (grep(defined, delete @$self{qw(3 old_1 au_done)}));
534         if (my $op_c = delete $self->{pkt_op_c}) {
535                 close(delete $op_c->{sock});
536         }
537         if (my $pgr = delete $self->{pgr}) {
538                 close($_) for (@$pgr[1,2]);
539         }
540         close $listener if $listener;
541         undef $listener;
542         %PATH2CFG = ();
543         undef $errors_log;
544         $quit = \&CORE::exit;
545         $self->{-eml_noisy} or # only "lei import" sets this atm
546                 $SIG{__WARN__} = PublicInbox::Eml::warn_ignore_cb();
547         $current_lei = $persist ? undef : $self; # for SIG{__WARN__}
548 }
549
550 sub _delete_pkt_op { # OnDestroy callback to prevent leaks on die
551         my ($self) = @_;
552         if (my $op = delete $self->{pkt_op_c}) { # in case of die
553                 $op->close; # PublicInbox::PktOp::close
554         }
555         my $unclosed_after_die = delete($self->{pkt_op_p}) or return;
556         close $unclosed_after_die;
557 }
558
559 sub pkt_op_pair {
560         my ($self) = @_;
561         require PublicInbox::OnDestroy;
562         require PublicInbox::PktOp;
563         my $end = PublicInbox::OnDestroy->new($$, \&_delete_pkt_op, $self);
564         @$self{qw(pkt_op_c pkt_op_p)} = PublicInbox::PktOp->pair;
565         $end;
566 }
567
568 sub workers_start {
569         my ($lei, $wq, $jobs, $ops) = @_;
570         $ops = {
571                 '!' => [ \&fail_handler, $lei ],
572                 '|' => [ \&sigpipe_handler, $lei ],
573                 'x_it' => [ \&x_it, $lei ],
574                 'child_error' => [ \&child_error, $lei ],
575                 ($ops ? %$ops : ()),
576         };
577         $ops->{''} //= [ $wq->can('_lei_wq_eof') || \&wq_eof, $lei ];
578         my $end = $lei->pkt_op_pair;
579         my $ident = $wq->{-wq_ident} // "lei-$lei->{cmd} worker";
580         $wq->wq_workers_start($ident, $jobs, $lei->oldset, { lei => $lei });
581         delete $lei->{pkt_op_p};
582         my $op_c = delete $lei->{pkt_op_c};
583         @$end = ();
584         $lei->event_step_init;
585         ($op_c, $ops);
586 }
587
588 sub _help {
589         require PublicInbox::LeiHelp;
590         PublicInbox::LeiHelp::call($_[0], $_[1], \%CMD, \%OPTDESC);
591 }
592
593 sub optparse ($$$) {
594         my ($self, $cmd, $argv) = @_;
595         # allow _complete --help to complete, not show help
596         return 1 if substr($cmd, 0, 1) eq '_';
597         $self->{cmd} = $cmd;
598         $OPT = $self->{opt} //= {};
599         my $info = $CMD{$cmd} // [ '[...]' ];
600         my ($proto, undef, @spec) = @$info;
601         my $glp = ref($spec[-1]) eq ref($GLP) ? pop(@spec) : $GLP;
602         push @spec, qw(help|h);
603         my $lone_dash;
604         if ($spec[0] =~ s/\|\z//s) { # "stdin|" or "clear|" allows "-" alias
605                 $lone_dash = $spec[0];
606                 $OPT->{$spec[0]} = \(my $var);
607                 push @spec, '' => \$var;
608         }
609         $glp->getoptionsfromarray($argv, $OPT, @spec) or
610                 return _help($self, "bad arguments or options for $cmd");
611         return _help($self) if $OPT->{help};
612
613         push @$argv, @{$OPT->{-argv}} if defined($OPT->{-argv});
614
615         # "-" aliases "stdin" or "clear"
616         $OPT->{$lone_dash} = ${$OPT->{$lone_dash}} if defined $lone_dash;
617
618         my $i = 0;
619         my $POS_ARG = '[A-Z][A-Z0-9_]+';
620         my ($err, $inf);
621         my @args = split(/ /, $proto);
622         for my $var (@args) {
623                 if ($var =~ /\A$POS_ARG\.\.\.\z/o) { # >= 1 args;
624                         $inf = defined($argv->[$i]) and last;
625                         $var =~ s/\.\.\.\z//;
626                         $err = "$var not supplied";
627                 } elsif ($var =~ /\A$POS_ARG\z/o) { # required arg at $i
628                         $argv->[$i++] // ($err = "$var not supplied");
629                 } elsif ($var =~ /\.\.\.\]\z/) { # optional args start
630                         $inf = 1;
631                         last;
632                 } elsif ($var =~ /\A\[-?$POS_ARG\]\z/) { # one optional arg
633                         $i++;
634                 } elsif ($var =~ /\A.+?\|/) { # required FOO|--stdin
635                         $inf = 1 if index($var, '...') > 0;
636                         my @or = split(/\|/, $var);
637                         my $ok;
638                         for my $o (@or) {
639                                 if ($o =~ /\A--([a-z0-9\-]+)/) {
640                                         $ok = defined($OPT->{$1});
641                                         last if $ok;
642                                 } elsif (defined($argv->[$i])) {
643                                         $ok = 1;
644                                         $i++;
645                                         last;
646                                 } # else continue looping
647                         }
648                         last if $ok;
649                         my $last = pop @or;
650                         $err = join(', ', @or) . " or $last must be set";
651                 } else {
652                         warn "BUG: can't parse `$var' in $proto";
653                 }
654                 last if $err;
655         }
656         if (!$inf && scalar(@$argv) > scalar(@args)) {
657                 $err //= 'too many arguments';
658         }
659         $err ? fail($self, "usage: lei $cmd $proto\nE: $err") : 1;
660 }
661
662 sub _tmp_cfg { # for lei -c <name>=<value> ...
663         my ($self) = @_;
664         my $cfg = _lei_cfg($self, 1);
665         require File::Temp;
666         my $ft = File::Temp->new(TEMPLATE => 'lei_cfg-XXXX', TMPDIR => 1);
667         my $tmp = { '-f' => $ft->filename, -tmp => $ft };
668         $ft->autoflush(1);
669         print $ft <<EOM or return fail($self, "$tmp->{-f}: $!");
670 [include]
671         path = $cfg->{-f}
672 EOM
673         $tmp = $self->{cfg} = bless { %$cfg, %$tmp }, ref($cfg);
674         for (@{$self->{opt}->{c}}) {
675                 /\A([^=\.]+\.[^=]+)(?:=(.*))?\z/ or return fail($self, <<EOM);
676 `-c $_' is not of the form -c <name>=<value>'
677 EOM
678                 my $name = $1;
679                 my $value = $2 // 1;
680                 _config($self, '--add', $name, $value);
681                 if (defined(my $v = $tmp->{$name})) {
682                         if (ref($v) eq 'ARRAY') {
683                                 push @$v, $value;
684                         } else {
685                                 $tmp->{$name} = [ $v, $value ];
686                         }
687                 } else {
688                         $tmp->{$name} = $value;
689                 }
690         }
691 }
692
693 sub lazy_cb ($$$) {
694         my ($self, $cmd, $pfx) = @_;
695         my $ucmd = $cmd;
696         $ucmd =~ tr/-/_/;
697         my $cb;
698         $cb = $self->can($pfx.$ucmd) and return $cb;
699         my $base = $ucmd;
700         $base =~ s/_([a-z])/\u$1/g;
701         my $pkg = "PublicInbox::Lei\u$base";
702         ($INC{"PublicInbox/Lei\u$base.pm"} // eval("require $pkg")) ?
703                 $pkg->can($pfx.$ucmd) : undef;
704 }
705
706 sub dispatch {
707         my ($self, $cmd, @argv) = @_;
708         local $current_lei = $self; # for __WARN__
709         $self->{2}->autoflush(1); # keep stdout buffered until x_it|DESTROY
710         dump_and_clear_log("from previous run\n");
711         return _help($self, 'no command given') unless defined($cmd);
712         # do not support Getopt bundling for this
713         while ($cmd eq '-C' || $cmd eq '-c') {
714                 my $v = shift(@argv) // return fail($self, $cmd eq '-C' ?
715                                         '-C DIRECTORY' : '-c <name>=<value>');
716                 push @{$self->{opt}->{substr($cmd, 1, 1)}}, $v;
717                 $cmd = shift(@argv) // return _help($self, 'no command given');
718         }
719         if (my $cb = lazy_cb(__PACKAGE__, $cmd, 'lei_')) {
720                 optparse($self, $cmd, \@argv) or return;
721                 $self->{opt}->{c} and (_tmp_cfg($self) // return);
722                 if (my $chdir = $self->{opt}->{C}) {
723                         for my $d (@$chdir) {
724                                 next if $d eq ''; # same as git(1)
725                                 chdir $d or return fail($self, "cd $d: $!");
726                         }
727                         if (delete $self->{3}) { # update cwd for rel2abs
728                                 opendir my $dh, '.' or
729                                         return fail($self, "opendir . $!");
730                                 $self->{3} = $dh;
731                         }
732                 }
733                 $cb->($self, @argv);
734         } elsif (grep(/\A-/, $cmd, @argv)) { # --help or -h only
735                 $GLP->getoptionsfromarray([$cmd, @argv], {}, qw(help|h C=s@))
736                         or return _help($self, 'bad arguments or options');
737                 _help($self);
738         } else {
739                 fail($self, "`$cmd' is not an lei command");
740         }
741 }
742
743 sub _lei_cfg ($;$) {
744         my ($self, $creat) = @_;
745         return $self->{cfg} if $self->{cfg};
746         my $f = _config_path($self);
747         my @st = stat($f);
748         my $cur_st = @st ? pack('dd', $st[10], $st[7]) : ''; # 10:ctime, 7:size
749         my ($sto, $sto_dir);
750         if (my $cfg = $PATH2CFG{$f}) { # reuse existing object in common case
751                 return ($self->{cfg} = $cfg) if $cur_st eq $cfg->{-st};
752                 ($sto, $sto_dir) = @$cfg{qw(-lei_store leistore.dir)};
753         }
754         if (!@st) {
755                 unless ($creat) {
756                         delete $self->{cfg};
757                         return bless {}, 'PublicInbox::Config';
758                 }
759                 my (undef, $cfg_dir, undef) = File::Spec->splitpath($f);
760                 -d $cfg_dir or mkpath($cfg_dir) or die "mkpath($cfg_dir): $!\n";
761                 open my $fh, '>>', $f or die "open($f): $!\n";
762                 @st = stat($fh) or die "fstat($f): $!\n";
763                 $cur_st = pack('dd', $st[10], $st[7]);
764                 qerr($self, "# $f created") if $self->{cmd} ne 'config';
765         }
766         my $cfg = PublicInbox::Config->git_config_dump($f);
767         $cfg->{-st} = $cur_st;
768         $cfg->{'-f'} = $f;
769         if ($sto && File::Spec->canonpath($sto_dir // store_path($self))
770                         eq File::Spec->canonpath($cfg->{'leistore.dir'} //
771                                                 store_path($self))) {
772                 $cfg->{-lei_store} = $sto;
773         }
774         if (scalar(keys %PATH2CFG) > 5) {
775                 # FIXME: use inotify/EVFILT_VNODE to detect unlinked configs
776                 for my $k (keys %PATH2CFG) {
777                         delete($PATH2CFG{$k}) unless -f $k
778                 }
779         }
780         $self->{cfg} = $PATH2CFG{$f} = $cfg;
781 }
782
783 sub _lei_store ($;$) {
784         my ($self, $creat) = @_;
785         my $cfg = _lei_cfg($self, $creat);
786         $cfg->{-lei_store} //= do {
787                 require PublicInbox::LeiStore;
788                 my $dir = $cfg->{'leistore.dir'} // store_path($self);
789                 return unless $creat || -d $dir;
790                 PublicInbox::LeiStore->new($dir, { creat => $creat });
791         };
792 }
793
794 sub _config {
795         my ($self, @argv) = @_;
796         my %env = (%{$self->{env}}, GIT_CONFIG => undef);
797         my $cfg = _lei_cfg($self, 1);
798         my $cmd = [ qw(git config -f), $cfg->{'-f'}, @argv ];
799         my %rdr = map { $_ => $self->{$_} } (0..2);
800         waitpid(spawn($cmd, \%env, \%rdr), 0);
801 }
802
803 sub lei_config {
804         my ($self, @argv) = @_;
805         $self->{opt}->{'config-file'} and return fail $self,
806                 "config file switches not supported by `lei config'";
807         _config(@_);
808         x_it($self, $?) if $?;
809 }
810
811 sub lei_daemon_pid { puts shift, $$ }
812
813 sub lei_daemon_kill {
814         my ($self) = @_;
815         my $sig = $self->{opt}->{signal} // 'TERM';
816         kill($sig, $$) or fail($self, "kill($sig, $$): $!");
817 }
818
819 # Shell completion helper.  Used by lei-completion.bash and hopefully
820 # other shells.  Try to do as much here as possible to avoid redundancy
821 # and improve maintainability.
822 sub lei__complete {
823         my ($self, @argv) = @_; # argv = qw(lei and any other args...)
824         shift @argv; # ignore "lei", the entire command is sent
825         @argv or return puts $self, grep(!/^_/, keys %CMD), qw(--help -h -C);
826         my $cmd = shift @argv;
827         my $info = $CMD{$cmd} // do { # filter matching commands
828                 @argv or puts $self, grep(/\A\Q$cmd\E/, keys %CMD);
829                 return;
830         };
831         my ($proto, undef, @spec) = @$info;
832         my $cur = pop @argv;
833         my $re = defined($cur) ? qr/\A\Q$cur\E/ : qr/./;
834         if (substr(my $_cur = $cur // '-', 0, 1) eq '-') { # --switches
835                 # gross special case since the only git-config options
836                 # Consider moving to a table if we need more special cases
837                 # we use Getopt::Long for are the ones we reject, so these
838                 # are the ones we don't reject:
839                 if ($cmd eq 'config') {
840                         puts $self, grep(/$re/, keys %CONFIG_KEYS);
841                         @spec = qw(add z|null get get-all unset unset-all
842                                 replace-all get-urlmatch
843                                 remove-section rename-section
844                                 name-only list|l edit|e
845                                 get-color-name get-colorbool);
846                         # fall-through
847                 }
848                 # generate short/long names from Getopt::Long specs
849                 puts $self, grep(/$re/, qw(--help -h -C), map {
850                         if (s/[:=].+\z//) { # req/optional args, e.g output|o=i
851                         } elsif (s/\+\z//) { # verbose|v+
852                         } elsif (s/!\z//) {
853                                 # negation: mail! => no-mail|mail
854                                 s/([\w\-]+)/$1|no-$1/g
855                         }
856                         map {
857                                 my $x = length > 1 ? "--$_" : "-$_";
858                                 $x eq $_cur ? () : $x;
859                         } grep(!/_/, split(/\|/, $_, -1)) # help|h
860                 } grep { $OPTDESC{"$_\t$cmd"} || $OPTDESC{$_} } @spec);
861         } elsif ($cmd eq 'config' && !@argv && !$CONFIG_KEYS{$cur}) {
862                 puts $self, grep(/$re/, keys %CONFIG_KEYS);
863         }
864
865         # switch args (e.g. lei q -f mbox<TAB>)
866         if (($argv[-1] // $cur // '') =~ /\A--?([\w\-]+)\z/) {
867                 my $opt = quotemeta $1;
868                 puts $self, map {
869                         my $v = $OPTDESC{$_};
870                         my @v = ref($v) ? split(/\|/, $v->[0]) : ();
871                         # get rid of ALL CAPS placeholder (e.g "OUT")
872                         # (TODO: completion for external paths)
873                         shift(@v) if scalar(@v) && uc($v[0]) eq $v[0];
874                         @v;
875                 } grep(/\A(?:[\w-]+\|)*$opt\b.*?(?:\t$cmd)?\z/, keys %OPTDESC);
876         }
877         if (my $cb = lazy_cb($self, $cmd, '_complete_')) {
878                 puts $self, $cb->($self, @argv, $cur ? ($cur) : ());
879         }
880         # TODO: URLs, pathnames, OIDs, MIDs, etc...  See optparse() for
881         # proto parsing.
882 }
883
884 sub exec_buf ($$) {
885         my ($argv, $env) = @_;
886         my $argc = scalar @$argv;
887         my $buf = 'exec '.join("\0", scalar(@$argv), @$argv);
888         while (my ($k, $v) = each %$env) { $buf .= "\0$k=$v" };
889         $buf;
890 }
891
892 sub start_mua {
893         my ($self) = @_;
894         my $mua = $self->{opt}->{mua} // return;
895         my $mfolder = $self->{ovv}->{dst};
896         my (@cmd, $replaced);
897         if ($mua =~ /\A(?:mutt|mailx|mail|neomutt)\z/) {
898                 @cmd = ($mua, '-f');
899         # TODO: help wanted: other common FOSS MUAs
900         } else {
901                 require Text::ParseWords;
902                 @cmd = Text::ParseWords::shellwords($mua);
903                 # mutt uses '%f' for open-hook with compressed mbox, we follow
904                 @cmd = map { $_ eq '%f' ? ($replaced = $mfolder) : $_ } @cmd;
905         }
906         push @cmd, $mfolder unless defined($replaced);
907         if ($self->{sock}) { # lei(1) client process runs it
908                 # restore terminal: echo $query | lei q -stdin --mua=...
909                 my $io = [];
910                 $io->[0] = $self->{1} if $self->{opt}->{stdin} && -t $self->{1};
911                 send_exec_cmd($self, $io, \@cmd, {});
912         } elsif ($self->{oneshot}) {
913                 my $pid = fork // die "fork: $!";
914                 if ($pid > 0) { # original process
915                         if ($self->{opt}->{stdin} && -t STDOUT) {
916                                 open STDIN, '+<&', \*STDOUT or die "dup2: $!";
917                         }
918                         exec(@cmd);
919                         warn "exec @cmd: $!\n";
920                         POSIX::_exit(1);
921                 }
922                 POSIX::setsid() > 0 or die "setsid: $!";
923         }
924         if ($self->{lxs} && $self->{au_done}) { # kick wait_startq
925                 syswrite($self->{au_done}, 'q' x ($self->{lxs}->{jobs} // 0));
926         }
927         return unless -t $self->{2}; # XXX how to determine non-TUI MUAs?
928         $self->{opt}->{quiet} = 1;
929         delete $self->{-progress};
930         delete $self->{opt}->{verbose};
931 }
932
933 sub send_exec_cmd { # tell script/lei to execute a command
934         my ($self, $io, $cmd, $env) = @_;
935         my $sock = $self->{sock} // die 'lei client gone';
936         my $fds = [ map { fileno($_) } @$io ];
937         $send_cmd->($sock, $fds, exec_buf($cmd, $env), MSG_EOR);
938 }
939
940 sub poke_mua { # forces terminal MUAs to wake up and hopefully notice new mail
941         my ($self) = @_;
942         my $alerts = $self->{opt}->{alert} // return;
943         while (my $op = shift(@$alerts)) {
944                 if ($op eq ':WINCH') {
945                         # hit the process group that started the MUA
946                         if ($self->{sock}) {
947                                 send($self->{sock}, '-WINCH', MSG_EOR);
948                         } elsif ($self->{oneshot}) {
949                                 kill('-WINCH', $$);
950                         }
951                 } elsif ($op eq ':bell') {
952                         out($self, "\a");
953                 } elsif ($op =~ /(?<!\\),/) { # bare ',' (not ',,')
954                         push @$alerts, split(/(?<!\\),/, $op);
955                 } elsif ($op =~ m!\A([/a-z0-9A-Z].+)!) {
956                         my $cmd = $1; # run an arbitrary command
957                         require Text::ParseWords;
958                         $cmd = [ Text::ParseWords::shellwords($cmd) ];
959                         if (my $s = $self->{sock}) {
960                                 send($s, exec_buf($cmd, {}), MSG_EOR);
961                         } elsif ($self->{oneshot}) {
962                                 $self->{"pid.$self.$$"}->{spawn($cmd)} = $cmd;
963                         }
964                 } else {
965                         err($self, "W: unsupported --alert=$op"); # non-fatal
966                 }
967         }
968 }
969
970 my %path_to_fd = ('/dev/stdin' => 0, '/dev/stdout' => 1, '/dev/stderr' => 2);
971 $path_to_fd{"/dev/fd/$_"} = $_ for (0..2);
972
973 # this also normalizes the path
974 sub path_to_fd {
975         my ($self, $path) = @_;
976         $path = rel2abs($self, $path);
977         $path =~ tr!/!/!s;
978         $path_to_fd{$path} // (
979                 ($path =~ m!\A/(?:dev|proc/self)/fd/[0-9]+\z!) ?
980                         fail($self, "cannot open $path from daemon") : -1
981         );
982 }
983
984 # caller needs to "-t $self->{1}" to check if tty
985 sub start_pager {
986         my ($self) = @_;
987         my $fh = popen_rd([qw(git var GIT_PAGER)]);
988         chomp(my $pager = <$fh> // '');
989         close($fh) or warn "`git var PAGER' error: \$?=$?";
990         return if $pager eq 'cat' || $pager eq '';
991         my $new_env = { LESS => 'FRX', LV => '-c' };
992         $new_env->{MORE} = 'FRX' if $^O eq 'freebsd';
993         pipe(my ($r, $wpager)) or return warn "pipe: $!";
994         my $rdr = { 0 => $r, 1 => $self->{1}, 2 => $self->{2} };
995         my $pgr = [ undef, @$rdr{1, 2} ];
996         my $env = $self->{env};
997         if ($self->{sock}) { # lei(1) process runs it
998                 delete @$new_env{keys %$env}; # only set iff unset
999                 send_exec_cmd($self, [ @$rdr{0..2} ], [$pager], $new_env);
1000         } elsif ($self->{oneshot}) {
1001                 my $cmd = [$pager];
1002                 $self->{"pid.$self.$$"}->{spawn($cmd, $new_env, $rdr)} = $cmd;
1003         } else {
1004                 die 'BUG: start_pager w/o socket';
1005         }
1006         $self->{1} = $wpager;
1007         $self->{2} = $wpager if -t $self->{2};
1008         $env->{GIT_PAGER_IN_USE} = 'true'; # we may spawn git
1009         $self->{pgr} = $pgr;
1010 }
1011
1012 sub stop_pager {
1013         my ($self) = @_;
1014         my $pgr = delete($self->{pgr}) or return;
1015         $self->{2} = $pgr->[2];
1016         # do not restore original stdout, just close it so we error out
1017         close(delete($self->{1})) if $self->{1};
1018 }
1019
1020 sub accept_dispatch { # Listener {post_accept} callback
1021         my ($sock) = @_; # ignore other
1022         $sock->autoflush(1);
1023         my $self = bless { sock => $sock }, __PACKAGE__;
1024         vec(my $rvec = '', fileno($sock), 1) = 1;
1025         select($rvec, undef, undef, 60) or
1026                 return send($sock, 'timed out waiting to recv FDs', MSG_EOR);
1027         # (4096 * 33) >MAX_ARG_STRLEN
1028         my @fds = $recv_cmd->($sock, my $buf, 4096 * 33) or return; # EOF
1029         if (!defined($fds[0])) {
1030                 warn(my $msg = "recv_cmd failed: $!");
1031                 return send($sock, $msg, MSG_EOR);
1032         } else {
1033                 my $i = 0;
1034                 for my $fd (@fds) {
1035                         open($self->{$i++}, '+<&=', $fd) and next;
1036                         send($sock, "open(+<&=$fd) (FD=$i): $!", MSG_EOR);
1037                 }
1038                 $i == 4 or return send($sock, 'not enough FDs='.($i-1), MSG_EOR)
1039         }
1040         # $ENV_STR = join('', map { "\0$_=$ENV{$_}" } keys %ENV);
1041         # $buf = "$argc\0".join("\0", @ARGV).$ENV_STR."\0\0";
1042         substr($buf, -2, 2, '') eq "\0\0" or  # s/\0\0\z//
1043                 return send($sock, 'request command truncated', MSG_EOR);
1044         my ($argc, @argv) = split(/\0/, $buf, -1);
1045         undef $buf;
1046         my %env = map { split(/=/, $_, 2) } splice(@argv, $argc);
1047         if (chdir($self->{3})) {
1048                 local %ENV = %env;
1049                 $self->{env} = \%env;
1050                 eval { dispatch($self, @argv) };
1051                 send($sock, $@, MSG_EOR) if $@;
1052         } else {
1053                 send($sock, "fchdir: $!", MSG_EOR); # implicit close
1054         }
1055 }
1056
1057 sub dclose {
1058         my ($self) = @_;
1059         delete $self->{-progress};
1060         _drop_wq($self);
1061         close(delete $self->{1}) if $self->{1}; # may reap_compress
1062         $self->close if $self->{-event_init_done}; # PublicInbox::DS::close
1063 }
1064
1065 # for long-running results
1066 sub event_step {
1067         my ($self) = @_;
1068         local %ENV = %{$self->{env}};
1069         my $sock = $self->{sock};
1070         local $current_lei = $self;
1071         eval {
1072                 while (my @fds = $recv_cmd->($sock, my $buf, 4096)) {
1073                         if (scalar(@fds) == 1 && !defined($fds[0])) {
1074                                 return if $! == EAGAIN;
1075                                 next if $! == EINTR;
1076                                 last if $! == ECONNRESET;
1077                                 die "recvmsg: $!";
1078                         }
1079                         for my $fd (@fds) {
1080                                 open my $rfh, '+<&=', $fd;
1081                         }
1082                         die "unrecognized client signal: $buf";
1083                 }
1084                 dclose($self);
1085         };
1086         if (my $err = $@) {
1087                 eval { $self->fail($err) };
1088                 dclose($self);
1089         }
1090 }
1091
1092 sub event_step_init {
1093         my ($self) = @_;
1094         return if $self->{-event_init_done}++;
1095         if (my $sock = $self->{sock}) { # using DS->EventLoop
1096                 $self->SUPER::new($sock, EPOLLIN|EPOLLET);
1097         }
1098 }
1099
1100 sub noop {}
1101
1102 sub oldset { $oldset }
1103
1104 sub dump_and_clear_log {
1105         if (defined($errors_log) && -s STDIN && seek(STDIN, 0, SEEK_SET)) {
1106                 my @pfx = @_;
1107                 unshift(@pfx, "$errors_log ") if @pfx;
1108                 warn @pfx, do { local $/; <STDIN> };
1109                 truncate(STDIN, 0) or warn "ftruncate ($errors_log): $!";
1110         }
1111 }
1112
1113 # lei(1) calls this when it can't connect
1114 sub lazy_start {
1115         my ($path, $errno, $narg) = @_;
1116         local ($errors_log, $listener);
1117         ($errors_log) = ($path =~ m!\A(.+?/)[^/]+\z!);
1118         $errors_log .= 'errors.log';
1119         my $addr = pack_sockaddr_un($path);
1120         my $lk = bless { lock_path => $errors_log }, 'PublicInbox::Lock';
1121         $lk->lock_acquire;
1122         socket($listener, AF_UNIX, SOCK_SEQPACKET, 0) or die "socket: $!";
1123         if ($errno == ECONNREFUSED || $errno == ENOENT) {
1124                 return if connect($listener, $addr); # another process won
1125                 if ($errno == ECONNREFUSED && -S $path) {
1126                         unlink($path) or die "unlink($path): $!";
1127                 }
1128         } else {
1129                 $! = $errno; # allow interpolation to stringify in die
1130                 die "connect($path): $!";
1131         }
1132         umask(077) // die("umask(077): $!");
1133         bind($listener, $addr) or die "bind($path): $!";
1134         listen($listener, 1024) or die "listen: $!";
1135         $lk->lock_release;
1136         undef $lk;
1137         my @st = stat($path) or die "stat($path): $!";
1138         my $dev_ino_expect = pack('dd', $st[0], $st[1]); # dev+ino
1139         local $oldset = PublicInbox::DS::block_signals();
1140         if ($narg == 5) {
1141                 $send_cmd = PublicInbox::Spawn->can('send_cmd4');
1142                 $recv_cmd = PublicInbox::Spawn->can('recv_cmd4') // do {
1143                         require PublicInbox::CmdIPC4;
1144                         $send_cmd = PublicInbox::CmdIPC4->can('send_cmd4');
1145                         PublicInbox::CmdIPC4->can('recv_cmd4');
1146                 };
1147         }
1148         $recv_cmd or die <<"";
1149 (Socket::MsgHdr || Inline::C) missing/unconfigured (narg=$narg);
1150
1151         require PublicInbox::Listener;
1152         require PublicInbox::EOFpipe;
1153         (-p STDOUT) or die "E: stdout must be a pipe\n";
1154         open(STDIN, '+>>', $errors_log) or die "open($errors_log): $!";
1155         STDIN->autoflush(1);
1156         dump_and_clear_log("from previous daemon process:\n");
1157         POSIX::setsid() > 0 or die "setsid: $!";
1158         my $pid = fork // die "fork: $!";
1159         return if $pid;
1160         $0 = "lei-daemon $path";
1161         local %PATH2CFG;
1162         $listener->blocking(0);
1163         my $exit_code;
1164         my $pil = PublicInbox::Listener->new($listener, \&accept_dispatch);
1165         local $quit = do {
1166                 pipe(my ($eof_r, $eof_w)) or die "pipe: $!";
1167                 PublicInbox::EOFpipe->new($eof_r, \&noop, undef);
1168                 sub {
1169                         $exit_code //= shift;
1170                         my $lis = $pil or exit($exit_code);
1171                         # closing eof_w triggers \&noop wakeup
1172                         $listener = $eof_w = $pil = $path = undef;
1173                         $lis->close; # DS::close
1174                         PublicInbox::DS->SetLoopTimeout(1000);
1175                 };
1176         };
1177         my $sig = {
1178                 CHLD => \&PublicInbox::DS::enqueue_reap,
1179                 QUIT => $quit,
1180                 INT => $quit,
1181                 TERM => $quit,
1182                 HUP => \&noop,
1183                 USR1 => \&noop,
1184                 USR2 => \&noop,
1185         };
1186         my $sigfd = PublicInbox::Sigfd->new($sig, SFD_NONBLOCK);
1187         local @SIG{keys %$sig} = values(%$sig) unless $sigfd;
1188         undef $sig;
1189         local $SIG{PIPE} = 'IGNORE';
1190         if ($sigfd) { # TODO: use inotify/kqueue to detect unlinked sockets
1191                 undef $sigfd;
1192                 PublicInbox::DS->SetLoopTimeout(5000);
1193         } else {
1194                 # wake up every second to accept signals if we don't
1195                 # have signalfd or IO::KQueue:
1196                 PublicInbox::DS::sig_setmask($oldset);
1197                 PublicInbox::DS->SetLoopTimeout(1000);
1198         }
1199         PublicInbox::DS->SetPostLoopCallback(sub {
1200                 my ($dmap, undef) = @_;
1201                 if (@st = defined($path) ? stat($path) : ()) {
1202                         if ($dev_ino_expect ne pack('dd', $st[0], $st[1])) {
1203                                 warn "$path dev/ino changed, quitting\n";
1204                                 $path = undef;
1205                         }
1206                 } elsif (defined($path)) { # ENOENT is common
1207                         warn "stat($path): $!, quitting ...\n" if $! != ENOENT;
1208                         undef $path;
1209                         $quit->();
1210                 }
1211                 return 1 if defined($path);
1212                 my $now = now();
1213                 my $n = 0;
1214                 for my $s (values %$dmap) {
1215                         $s->can('busy') or next;
1216                         if ($s->busy($now)) {
1217                                 ++$n;
1218                         } else {
1219                                 $s->close;
1220                         }
1221                 }
1222                 $n; # true: continue, false: stop
1223         });
1224
1225         # STDIN was redirected to /dev/null above, closing STDERR and
1226         # STDOUT will cause the calling `lei' client process to finish
1227         # reading the <$daemon> pipe.
1228         local $SIG{__WARN__} = sub {
1229                 $current_lei ? err($current_lei, @_) : warn(
1230                   strftime('%Y-%m-%dT%H:%M:%SZ', gmtime(time))," $$ ", @_);
1231         };
1232         open STDERR, '>&STDIN' or die "redirect stderr failed: $!";
1233         open STDOUT, '>&STDIN' or die "redirect stdout failed: $!";
1234         # $daemon pipe to `lei' closed, main loop begins:
1235         PublicInbox::DS->EventLoop;
1236         exit($exit_code // 0);
1237 }
1238
1239 sub busy { 1 } # prevent daemon-shutdown if client is connected
1240
1241 # for users w/o Socket::Msghdr installed or Inline::C enabled
1242 sub oneshot {
1243         my ($main_pkg) = @_;
1244         my $exit = $main_pkg->can('exit'); # caller may override exit()
1245         local $quit = $exit if $exit;
1246         local %PATH2CFG;
1247         umask(077) // die("umask(077): $!");
1248         my $self = bless { oneshot => 1, env => \%ENV }, __PACKAGE__;
1249         for (0..2) { open($self->{$_}, '+<&=', $_) or die "open fd=$_: $!" }
1250         dispatch($self, @ARGV);
1251         x_it($self, $self->{child_error}) if $self->{child_error};
1252 }
1253
1254 # ensures stdout hits the FS before sock disconnects so a client
1255 # can immediately reread it
1256 sub DESTROY {
1257         my ($self) = @_;
1258         $self->{1}->autoflush(1) if $self->{1};
1259         stop_pager($self);
1260         my $err = $?;
1261         my $oneshot_pids = delete $self->{"pid.$self.$$"} or return;
1262         waitpid($_, 0) for keys %$oneshot_pids;
1263         $? = $err if $err; # preserve ->fail or ->x_it code
1264 }
1265
1266 sub wq_done_wait { # dwaitpid callback
1267         my ($arg, $pid) = @_;
1268         my ($wq, $lei) = @$arg;
1269         my $err_type = $lei->{-err_type};
1270         $? and $lei->child_error($?,
1271                         $err_type ? "$err_type errors during $lei->{cmd}" : ());
1272         $lei->dclose;
1273 }
1274
1275 sub wq_eof { # EOF callback for main daemon
1276         my ($lei) = @_;
1277         my $wq1 = delete $lei->{wq1} // return $lei->fail; # already failed
1278         $wq1->wq_wait_old(\&wq_done_wait, $lei);
1279 }
1280
1281 1;