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