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