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