1 # Copyright (C) 2020-2021 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # Backend for `lei' (local email interface). Unlike the C10K-oriented
5 # PublicInbox::Daemon, this is designed exclusively to handle trusted
6 # local clients with read/write access to the FS and use as many
7 # system resources as the local user has access to.
8 package PublicInbox::LEI;
11 use parent qw(PublicInbox::DS PublicInbox::LeiExternal
12 PublicInbox::LeiQuery);
14 use Socket qw(AF_UNIX SOCK_SEQPACKET MSG_EOR pack_sockaddr_un);
15 use Errno qw(EPIPE EAGAIN EINTR ECONNREFUSED ENOENT ECONNRESET);
17 use POSIX qw(strftime);
19 use Fcntl qw(SEEK_SET);
20 use PublicInbox::Config;
21 use PublicInbox::Syscall qw(SFD_NONBLOCK EPOLLIN EPOLLET);
22 use PublicInbox::Sigfd;
23 use PublicInbox::DS qw(now dwaitpid);
24 use PublicInbox::Spawn qw(spawn popen_rd);
25 use PublicInbox::Lock;
27 use Time::HiRes qw(stat); # ctime comparisons for config cache
28 use File::Path qw(mkpath);
30 our $quit = \&CORE::exit;
31 our ($current_lei, $errors_log, $listener, $oldset, $dir_idle,
32 $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));
38 our %PATH2CFG; # persistent for socket daemon
39 our $MDIR2CFGPATH; # /path/to/maildir => { /path/to/config => [ ino watches ] }
41 # TBD: this is a documentation mechanism to show a subcommand
42 # (may) pass options through to another command:
43 sub pass_through { $GLP_PASS }
47 my ($spec, $re_str) = @_; # 'limit|n=i', '([0-9]+)'
48 my ($key) = ($spec =~ m/\A([a-z]+)/g);
49 my $cb = sub { # Getopt::Long "<>" catch-all handler
51 if ($arg =~ /\A-($re_str)\z/) {
53 } elsif ($arg eq '--') { # "--" arg separator, ignore first
54 push @{$OPT->{-argv}}, $arg if $OPT->{'--'}++;
55 # lone (single) dash is handled elsewhere
56 } elsif (substr($arg, 0, 1) eq '-') {
58 push @{$OPT->{-argv}}, $arg;
60 die "bad argument: $arg\n";
63 push @{$OPT->{-argv}}, $arg;
66 ($spec, '<>' => $cb, $GLP_PASS) # for Getopt::Long
69 # rel2abs preserves symlinks in parent, unlike abs_path
72 if (index($p, '/') == 0) { # already absolute
73 $p =~ tr!/!/!s; # squeeze redundant slashes
74 chop($p) if substr($p, -1, 1) eq '/';
77 my $pwd = $self->{env}->{PWD};
80 my $xcwd = $self->{3} //
81 ($cwd = getcwd() // die "getcwd(PWD=$pwd): $!");
82 if (my @st_pwd = stat($pwd)) {
83 my @st_cwd = stat($xcwd) or die "stat($xcwd): $!";
84 "@st_pwd[1,0]" eq "@st_cwd[1,0]" or
85 $self->{env}->{PWD} = $pwd = undef;
86 } else { # PWD was invalid
87 $self->{env}->{PWD} = $pwd = undef;
90 $pwd //= $self->{env}->{PWD} = $cwd // getcwd() // die "getcwd: $!";
91 File::Spec->rel2abs($p, $pwd);
94 # abs_path resolves symlinks in parent iff all parents exist
95 sub abs_path { Cwd::abs_path($_[1]) // rel2abs(@_) }
97 sub share_path ($) { # $HOME/.local/share/lei/$FOO
99 rel2abs($self, ($self->{env}->{XDG_DATA_HOME} //
100 ($self->{env}->{HOME} // '/nonexistent').'/.local/share')
104 sub store_path ($) { share_path($_[0]) . '/store' }
106 sub _config_path ($) {
108 rel2abs($self, ($self->{env}->{XDG_CONFIG_HOME} //
109 ($self->{env}->{HOME} // '/nonexistent').'/.config')
115 rel2abs($self, ($self->{env}->{XDG_CACHE_HOME} //
116 ($self->{env}->{HOME} // '/nonexistent').'/.cache')
120 sub url_folder_cache {
122 require PublicInbox::SharedKV; # URI => updated_at_sec_
123 PublicInbox::SharedKV->new(cache_dir($self).'/uri_folder');
128 $self->{ale} //= do {
129 require PublicInbox::LeiALE;
130 $self->_lei_cfg(1)->{ale} //= PublicInbox::LeiALE->new($self);
135 # TODO: drop underscore variants everywhere, they're undocumented
136 qw(fsync|sync! jobs|j=i indexlevel|L=s compact
137 max_size|max-size=s sequential-shard
138 batch_size|batch-size=s skip-docdata)
141 my @c_opt = qw(c=s@ C=s@ quiet|q);
142 my @lxs_opt = (qw(remote! local! external! include|I=s@ exclude=s@ only=s@
143 import-remote! no-torsocks torsocks=s),
144 PublicInbox::LeiQuery::curl_opt());
146 # we don't support -C as an alias for --find-copies since it's already
148 our @diff_opt = qw(unified|U=i output-indicator-new=s output-indicator-old=s
149 output-indicator-context=s indent-heuristic!
150 minimal patience histogram anchored=s@ diff-algorithm=s
151 color-moved:s color-moved-ws=s no-color-moved no-color-moved-ws
152 word-diff:s word-diff-regex=s color-words:s no-renames
153 rename-empty! check ws-error-highlight=s full-index binary
154 abbrev:i break-rewrites|B:s find-renames|M:s find-copies:s
155 find-copies-harder irreversible-delete|D l=i diff-filter=s
156 S=s G=s find-object=s pickaxe-all pickaxe-regex O=s R
157 relative:s text|a ignore-cr-at-eol ignore-space-at-eol
158 ignore-space-change|b ignore-all-space|w ignore-blank-lines
159 inter-hunk-context=i function-context|W exit-code ext-diff
160 no-ext-diff textconv! src-prefix=s dst-prefix=s no-prefix
163 # we generate shell completion + help using %CMD and %OPTDESC,
164 # see lei__complete() and PublicInbox::LeiHelp
165 # command => [ positional_args, 1-line description, Getopt::Long option spec ]
166 our %CMD = ( # sorted in order of importance/use:
167 'q' => [ '--stdin|SEARCH_TERMS...', 'search for messages matching terms',
168 'stdin|', # /|\z/ must be first for lone dash
170 qw(save output|mfolder|o=s format|f=s dedupe|d=s threads|t+
171 sort|s=s reverse|r offset=i pretty jobs|j=s globoff|g augment|a
172 import-before! lock=s@ rsyncable alert=s@ mua=s verbose|v+
173 shared color! mail-sync!), @c_opt, opt_dash('limit|n=i', '[0-9]+') ],
175 'up' => [ 'OUTPUT|--all', 'update saved search',
176 qw(jobs|j=s lock=s@ alert=s@ mua=s verbose|v+ all:s), @c_opt ],
178 'lcat' => [ '--stdin|MSGID_OR_URL...', 'display local copy of message(s)',
179 'stdin|', # /|\z/ must be first for lone dash
180 # some of these options are ridiculous for lcat
181 @lxs_opt, qw(output|mfolder|o=s format|f=s dedupe|d=s threads|t+
182 sort|s=s reverse|r offset=i jobs|j=s globoff|g augment|a
183 import-before! lock=s@ rsyncable alert=s@ mua=s verbose|v+
184 color!), @c_opt, opt_dash('limit|n=i', '[0-9]+') ],
186 'blob' => [ 'OID', 'show a git blob, reconstructing from mail if necessary',
187 qw(git-dir=s@ cwd! verbose|v+ mail! oid-a|A=s path-a|a=s path-b|b=s),
190 'rediff' => [ '--stdin|LOCATION...',
191 'regenerate a diff with different options',
192 'stdin|', # /|\z/ must be first for lone dash
193 qw(git-dir=s@ cwd! verbose|v+ color:s no-color),
194 @diff_opt, @lxs_opt, @c_opt ],
196 'add-external' => [ 'LOCATION',
197 'add/set priority of a publicinbox|extindex for extra matches',
198 qw(boost=i mirror=s no-torsocks torsocks=s inbox-version=i
199 verbose|v+), @c_opt, index_opt(),
200 PublicInbox::LeiQuery::curl_opt() ],
201 'ls-external' => [ '[FILTER]', 'list publicinbox|extindex locations',
202 qw(format|f=s z|0 globoff|g invert-match|v local remote), @c_opt ],
203 'ls-label' => [ '', 'list labels', qw(z|0 stats:s), @c_opt ],
204 'ls-mail-sync' => [ '[FILTER]', 'list mail sync folders',
205 qw(z|0 globoff|g invert-match|v local remote), @c_opt ],
206 'ls-mail-source' => [ 'URL', 'list IMAP or NNTP mail source folders',
207 qw(z|0 ascii l url), @c_opt ],
208 'forget-external' => [ 'LOCATION...|--prune',
209 'exclude further results from a publicinbox|extindex',
212 'ls-search' => [ '[PREFIX]', 'list saved search queries',
213 qw(format|f=s pretty l ascii z|0), @c_opt ],
214 'forget-search' => [ 'OUTPUT', 'forget a saved search',
215 qw(verbose|v+), @c_opt ],
216 'edit-search' => [ 'OUTPUT', "edit saved search via `git config --edit'",
218 'rm' => [ '--stdin|LOCATION...',
219 'remove a message from the index and prevent reindexing',
220 'stdin|', # /|\z/ must be first for lone dash
222 'plonk' => [ '--threads|--from=IDENT',
223 'exclude mail matching From: or threads from non-Message-ID searches',
224 qw(stdin| threads|t from|f=s mid=s oid=s), @c_opt ],
225 'tag' => [ 'KEYWORDS...',
226 'set/unset keywords and/or labels on message(s)',
227 qw(stdin| in-format|F=s input|i=s@ oid=s@ mid=s@),
228 qw(no-torsocks torsocks=s), PublicInbox::LeiQuery::curl_opt(), @c_opt,
229 pass_through('-kw:foo for delete') ],
231 'purge-mailsource' => [ 'LOCATION|--all',
232 'remove imported messages from IMAP, Maildirs, and MH',
233 qw(exact! all jobs:i indexed), @c_opt ],
235 'add-watch' => [ 'LOCATION...', 'watch for new messages and flag changes',
236 qw(poll-interval=s state=s recursive|r), @c_opt ],
237 'rm-watch' => [ 'LOCATION...', 'remove specified watch(es)',
238 qw(recursive|r), @c_opt ],
239 'ls-watch' => [ '[FILTER...]', 'list active watches with numbers and status',
241 'pause-watch' => [ '[WATCH_NUMBER_OR_FILTER]', qw(all local remote), @c_opt ],
242 'resume-watch' => [ '[WATCH_NUMBER_OR_FILTER]', qw(all local remote), @c_opt ],
243 'forget-watch' => [ '{WATCH_NUMBER|--prune}', 'stop and forget a watch',
246 'index' => [ 'LOCATION...', 'one-time index from URL or filesystem',
247 qw(in-format|F=s kw! offset=i recursive|r exclude=s include|I=s
248 verbose|v+ incremental!),
249 PublicInbox::LeiQuery::curl_opt(), # mainly for --proxy=
251 'import' => [ 'LOCATION...|--stdin',
252 'one-time import/update from URL or filesystem',
253 qw(stdin| offset=i recursive|r exclude=s include|I=s jobs=s new-only
254 lock=s@ in-format|F=s kw! verbose|v+ incremental! mail-sync!),
255 qw(no-torsocks torsocks=s), PublicInbox::LeiQuery::curl_opt(), @c_opt ],
256 'forget-mail-sync' => [ 'LOCATION...',
257 'forget sync information for a mail folder', @c_opt ],
258 'prune-mail-sync' => [ 'LOCATION...|--all',
259 'prune dangling sync data for a mail folder', 'all:s', @c_opt ],
260 'export-kw' => [ 'LOCATION...|--all',
261 'one-time export of keywords of sync sources',
262 qw(all:s mode=s), @c_opt ],
263 'convert' => [ 'LOCATION...|--stdin',
264 'one-time conversion from URL or filesystem to another format',
265 qw(stdin| in-format|F=s out-format|f=s output|mfolder|o=s lock=s@ kw!),
266 qw(no-torsocks torsocks=s), PublicInbox::LeiQuery::curl_opt(), @c_opt ],
267 'p2q' => [ 'FILE|COMMIT_OID|--stdin',
268 "use a patch to generate a query for `lei q --stdin'",
269 qw(stdin| want|w=s@ uri debug), @c_opt ],
270 'config' => [ '[...]', sub {
271 'git-config(1) wrapper for '._config_path($_[0]);
272 }, qw(config-file|system|global|file|f=s), # for conflict detection
273 qw(c=s@ C=s@), pass_through('git config') ],
274 'inspect' => [ 'ITEMS...', 'inspect lei/store and/or local external',
275 qw(pretty ascii dir=s), @c_opt ],
277 'init' => [ '[DIRNAME]', sub {
278 "initialize storage, default: ".store_path($_[0]);
280 'daemon-kill' => [ '[-SIGNAL]', 'signal the lei-daemon',
281 # "-C DIR" conflicts with -CHLD, here, and chdir makes no sense, here
282 opt_dash('signal|s=s', '[0-9]+|(?:[A-Z][A-Z0-9]+)') ],
283 'daemon-pid' => [ '', 'show the PID of the lei-daemon' ],
284 'help' => [ '[SUBCOMMAND]', 'show help' ],
287 #'reorder-local-store-and-break-history' => [ '[REFNAME]',
288 # 'rewrite git history in an attempt to improve compression',
290 #'fuse-mount' => [ 'PATHNAME', 'expose lei/store as Maildir(s)', @c_opt ],
292 # internal commands are prefixed with '_'
293 '_complete' => [ '[...]', 'internal shell completion helper',
294 pass_through('everything') ],
297 # switch descriptions, try to keep consistent across commands
298 # $spec: Getopt::Long option specification
299 # $spec => [@ALLOWED_VALUES (default is first), $description],
300 # $spec => $description
301 # "$SUB_COMMAND TAB $spec" => as above
302 my $stdin_formats = [ 'MAIL_FORMAT|eml|mboxrd|mboxcl2|mboxcl|mboxo',
303 'specify message input format' ];
304 my $ls_format = [ 'OUT|plain|json|null', 'listing output format' ];
306 # we use \x{a0} (non-breaking SP) to avoid wrapping in PublicInbox::LeiHelp
308 'help|h' => 'show this built-in help',
309 'c=s@' => [ 'NAME=VALUE', 'set config option' ],
310 'C=s@' => [ 'DIR', 'chdir to specify to directory' ],
311 'quiet|q' => 'be quiet',
312 'lock=s@' => [ 'METHOD|dotlock|fcntl|flock|none',
313 'mbox(5) locking method(s) to use (default: fcntl,dotlock)' ],
315 'incremental! import' => 'import already seen IMAP and NNTP articles',
316 'globoff|g' => "do not match locations using '*?' wildcards ".
317 "and\xa0'[]'\x{a0}ranges",
318 'invert-match|v' => 'select non-matching lines',
319 'color!' => 'disable color (for --format=text)',
320 'verbose|v+' => 'be more verbose',
321 'external!' => 'do not use externals',
322 'mail!' => 'do not look in mail storage for OID',
323 'cwd!' => 'do not look in git repo of current working directory',
324 'oid-a|A=s' => 'pre-image OID',
325 'path-a|a=s' => 'pre-image pathname associated with OID',
326 'path-b|b=s' => 'post-image pathname associated with OID',
327 'git-dir=s@' => 'additional git repository to scan',
328 'dir=s inspect' => 'specify a inboxdir, extindex topdir or Xapian shard',
329 'proxy=s' => [ 'PROTO://HOST[:PORT]', # shared with curl(1)
330 "proxy for (e.g. `socks5h://0:9050')" ],
331 'torsocks=s' => ['VAL|auto|no|yes',
332 'whether or not to wrap git and curl commands with torsocks'],
333 'no-torsocks' => 'alias for --torsocks=no',
334 'save' => "save a search for `lei up'",
335 'import-remote!' => 'do not memoize remote messages into local store',
337 'type=s' => [ 'any|mid|git', 'disambiguate type' ],
339 'dedupe|d=s' => ['STRATEGY|content|oid|mid|none',
340 'deduplication strategy'],
342 'return all messages in the same threads as the actual match(es)',
344 'want|w=s@' => [ 'PREFIX|dfpost|dfn', # common ones in help...
345 'search prefixes to extract (default: dfpost7)' ],
347 'alert=s@' => ['CMD,:WINCH,:bell,<any command>',
348 'run command(s) or perform ops when done writing to output ' .
349 '(default: ":WINCH,:bell" with --mua and Maildir/IMAP output, ' .
350 'nothing otherwise)' ],
352 'augment|a' => 'augment --output destination instead of clobbering',
354 'output|mfolder|o=s' => [ 'MFOLDER',
355 "destination (e.g.\xa0`/path/to/Maildir', ".
356 "or\xa0`-'\x{a0}for\x{a0}stdout)" ],
358 "MUA to run on --output Maildir or mbox (e.g.\xa0`mutt\xa0-f\xa0%f')" ],
359 'new-only import' => 'only import new messages from IMAP source',
361 'inbox-version=i' => [ 'NUM|1|2',
362 'force a public-inbox version with --mirror'],
363 'mirror=s' => [ 'URL', 'mirror a public-inbox'],
365 # public-inbox-index options
366 'fsync!' => 'speed up indexing after --mirror, risk index corruption',
367 'compact' => 'run compact index after mirroring',
368 'indexlevel|L=s' => [ 'LEVEL|full|medium|basic',
369 "indexlevel with --mirror (default: full)" ],
370 'max_size|max-size=s' => [ 'SIZE',
371 'do not index messages larger than SIZE (default: infinity)' ],
372 'batch_size|batch-size=s' => [ 'SIZE',
373 'flush changes to OS after given number of bytes (default: 1m)' ],
374 'sequential-shard' =>
375 'index Xapian shards sequentially for slow storage',
377 'drop compatibility w/ public-inbox <1.6 to save ~1.5% space',
380 'OUT|maildir|mboxrd|mboxcl2|mboxcl|mboxo|html|json|jsonl|concatjson',
381 'specify output format, default depends on --output'],
382 'exclude=s@ q' => [ 'LOCATION',
383 'exclude specified external(s) from search' ],
384 'include|I=s@ q' => [ 'LOCATION',
385 'include specified external(s) in search' ],
386 'only=s@ q' => [ 'LOCATION',
387 'only use specified external(s) for search' ],
388 'jobs=s q' => [ '[SEARCH_JOBS][,WRITER_JOBS]',
389 'control number of search and writer jobs' ],
390 'jobs|j=i add-external' => 'set parallelism when indexing after --mirror',
392 'in-format|F=s' => $stdin_formats,
393 'format|f=s ls-search' => ['OUT|json|jsonl|concatjson',
394 'listing output format' ],
395 'l ls-search' => 'long listing format',
396 'l ls-watch' => 'long listing format',
397 'l ls-mail-source' => 'long listing format',
398 'url ls-mail-source' => 'show full URL of newsgroup or IMAP folder',
399 'format|f=s ls-external' => $ls_format,
401 'limit|n=i@' => ['NUM', 'limit on number of matches (default: 10000)' ],
402 'offset=i' => ['OFF', 'search result offset (default: 0)'],
404 'sort|s=s' => [ 'VAL|received|relevance|docid',
405 "order of results is `--output'-dependent"],
406 'reverse|r' => 'reverse search results', # like sort(1)
408 'boost=i' => 'increase/decrease priority of results (default: 0)',
410 'local' => 'limit operations to the local filesystem',
411 'local!' => 'exclude results from the local filesystem',
412 'remote' => 'limit operations to those requiring network access',
413 'remote!' => 'prevent operations requiring network access',
415 'all:s up' => ['local', 'update all (local) saved searches' ],
417 'mid=s' => 'specify the Message-ID of a message',
418 'oid=s' => 'specify the git object ID of a message',
420 'recursive|r' => 'scan directories/mailboxes/newsgroups recursively',
421 'exclude=s' => 'exclude mailboxes/newsgroups based on pattern',
422 'include=s' => 'include mailboxes/newsgroups based on pattern',
424 'exact' => 'operate on exact header matches only',
425 'exact!' => 'rely on content match instead of exact header matches',
427 'by-mid|mid:s' => [ 'MID', 'match only by Message-ID, ignoring contents' ],
429 'kw!' => 'disable/enable importing keywords (aka "flags")',
431 # xargs, env, use "-0", git(1) uses "-z". We support z|0 everywhere
432 'z|0' => 'use NUL \\0 instead of newline (CR) to delimit lines',
434 'signal|s=s' => [ 'SIG', 'signal to send lei-daemon (default: TERM)' ],
438 'leistore.dir' => 'top-level storage location',
441 my @WQ_KEYS = qw(lxs l2m ikw pmd wq1 lne); # internal workers
445 for my $wq (grep(defined, delete(@$self{@WQ_KEYS}))) {
447 $wq->wq_close(0, undef, $self);
448 } elsif ($wq->wq_kill_old) {
449 $wq->wq_wait_old(undef, $self);
455 # pronounced "exit": x_it(1 << 8) => exit(1); x_it(13) => SIGPIPE
457 my ($self, $code) = @_;
458 # make sure client sees stdout before exit
459 $self->{1}->autoflush(1) if $self->{1};
460 dump_and_clear_log();
462 if ($self->{pkt_op_p}) { # to top lei-daemon
463 $self->{pkt_op_p}->pkt_do('x_it', $code);
464 } elsif ($self->{sock}) { # to lei(1) client
465 send($self->{sock}, "x_it $code", MSG_EOR);
466 } # else ignore if client disconnected
471 my $err = $self->{2} // ($self->{pgr} // [])->[2] // *STDERR{GLOB};
472 my @eor = (substr($_[-1]//'', -1, 1) eq "\n" ? () : ("\n"));
473 print $err @_, @eor and return;
474 my $old_err = delete $self->{2};
475 close($old_err) if $! == EPIPE && $old_err;
476 $err = $self->{2} = ($self->{pgr} // [])->[2] // *STDERR{GLOB};
477 print $err @_, @eor or print STDERR @_, @eor;
480 sub qerr ($;@) { $_[0]->{opt}->{quiet} or err(shift, @_) }
482 sub fail_handler ($;$$) {
483 my ($lei, $code, $io) = @_;
484 close($io) if $io; # needed to avoid warnings on SIGPIPE
486 x_it($lei, $code // (1 << 8));
489 sub sigpipe_handler { # handles SIGPIPE from @WQ_KEYS workers
490 fail_handler($_[0], 13, delete $_[0]->{1});
493 # PublicInbox::OnDestroy callback for SIGINT to take out the entire pgid
496 dwaitpid($pgid) if kill('-INT', $pgid);
500 my ($self, $buf, $exit_code) = @_;
502 err($self, $buf) if defined $buf;
503 # calls fail_handler:
504 $self->{pkt_op_p}->pkt_do('!') if $self->{pkt_op_p};
505 x_it($self, ($exit_code // 1) << 8);
511 return if print { $self->{1} // return } @_; # likely
512 return note_sigpipe($self, 1) if $! == EPIPE;
513 my $err = "error writing to output: $!";
518 sub puts ($;@) { out(shift, map { "$_\n" } @_) }
520 sub child_error { # passes non-fatal curl exit codes to user
521 my ($self, $child_error, $msg) = @_; # child_error is $?
522 $self->err($msg) if $msg;
523 if ($self->{pkt_op_p}) { # to top lei-daemon
524 $self->{pkt_op_p}->pkt_do('child_error', $child_error);
525 } elsif ($self->{sock}) { # to lei(1) client
526 send($self->{sock}, "child_error $child_error", MSG_EOR);
527 } # else noop if client disconnected
530 sub note_sigpipe { # triggers sigpipe_handler
531 my ($self, $fd) = @_;
532 close(delete($self->{$fd})); # explicit close silences Perl warning
533 $self->{pkt_op_p}->pkt_do('|') if $self->{pkt_op_p};
537 sub _lei_atfork_child {
538 my ($self, $persist) = @_;
539 # we need to explicitly close things which are on stack
541 chdir '/' or die "chdir(/): $!";
542 close($_) for (grep(defined, delete @$self{qw(0 1 2 sock)}));
543 if (my $cfg = $self->{cfg}) {
544 delete @$cfg{qw(-lei_store -watches -lei_note_event)};
546 } else { # worker, Net::NNTP (Net::Cmd) uses STDERR directly
547 open STDERR, '+>&='.fileno($self->{2}) or warn "open $!";
548 STDERR->autoflush(1);
550 close($_) for (grep(defined, delete @$self{qw(3 old_1 au_done)}));
551 if (my $op_c = delete $self->{pkt_op_c}) {
552 close(delete $op_c->{sock});
554 if (my $pgr = delete $self->{pgr}) {
555 close($_) for (@$pgr[1,2]);
557 close $listener if $listener;
559 $dir_idle->force_close if $dir_idle;
562 eval 'no warnings; undef $PublicInbox::LeiNoteEvent::to_flush';
564 $quit = \&CORE::exit;
565 $self->{-eml_noisy} or # only "lei import" sets this atm
566 $SIG{__WARN__} = PublicInbox::Eml::warn_ignore_cb();
567 $current_lei = $persist ? undef : $self; # for SIG{__WARN__}
570 sub _delete_pkt_op { # OnDestroy callback to prevent leaks on die
572 if (my $op = delete $self->{pkt_op_c}) { # in case of die
573 $op->close; # PublicInbox::PktOp::close
575 my $pkt_op_p = delete($self->{pkt_op_p}) or return;
576 close $pkt_op_p->{op_p};
581 require PublicInbox::OnDestroy;
582 require PublicInbox::PktOp;
583 my $end = PublicInbox::OnDestroy->new($$, \&_delete_pkt_op, $self);
584 @$self{qw(pkt_op_c pkt_op_p)} = PublicInbox::PktOp->pair;
589 my ($self, $field, $nr) = @_;
590 $self->{counters}->{$field} += $nr;
594 my ($lei, $wq, $jobs, $ops, $flds) = @_;
596 '!' => [ \&fail_handler, $lei ],
597 '|' => [ \&sigpipe_handler, $lei ],
598 'x_it' => [ \&x_it, $lei ],
599 'child_error' => [ \&child_error, $lei ],
600 'incr' => [ \&incr, $lei ],
603 $ops->{''} //= [ $wq->can('_lei_wq_eof') || \&wq_eof, $lei ];
604 my $end = $lei->pkt_op_pair;
605 my $ident = $wq->{-wq_ident} // "lei-$lei->{cmd} worker";
607 $wq->wq_workers_start($ident, $jobs, $lei->oldset, $flds);
608 delete $lei->{pkt_op_p};
609 my $op_c = delete $lei->{pkt_op_c};
611 $lei->event_step_init;
615 # call this when we're ready to wait on events and yield to other clients
617 my ($lei, $op_c, $ops) = @_;
618 for my $wq (grep(defined, @$lei{qw(ikw pmd)})) { # auxiliary WQs
625 require PublicInbox::LeiHelp;
626 PublicInbox::LeiHelp::call($_[0], $_[1], \%CMD, \%OPTDESC);
630 my ($self, $cmd, $argv) = @_;
631 # allow _complete --help to complete, not show help
632 return 1 if substr($cmd, 0, 1) eq '_';
634 $OPT = $self->{opt} //= {};
635 my $info = $CMD{$cmd} // [ '[...]' ];
636 my ($proto, undef, @spec) = @$info;
637 my $glp = ref($spec[-1]) eq ref($GLP) ? pop(@spec) : $GLP;
638 push @spec, qw(help|h);
640 if ($spec[0] =~ s/\|\z//s) { # "stdin|" or "clear|" allows "-" alias
641 $lone_dash = $spec[0];
642 $OPT->{$spec[0]} = \(my $var);
643 push @spec, '' => \$var;
645 $glp->getoptionsfromarray($argv, $OPT, @spec) or
646 return _help($self, "bad arguments or options for $cmd");
647 return _help($self) if $OPT->{help};
649 push @$argv, @{$OPT->{-argv}} if defined($OPT->{-argv});
651 # "-" aliases "stdin" or "clear"
652 $OPT->{$lone_dash} = ${$OPT->{$lone_dash}} if defined $lone_dash;
655 my $POS_ARG = '[A-Z][A-Z0-9_]+';
657 my @args = split(/ /, $proto);
658 for my $var (@args) {
659 if ($var =~ /\A$POS_ARG\.\.\.\z/o) { # >= 1 args;
660 $inf = defined($argv->[$i]) and last;
661 $var =~ s/\.\.\.\z//;
662 $err = "$var not supplied";
663 } elsif ($var =~ /\A$POS_ARG\z/o) { # required arg at $i
664 $argv->[$i++] // ($err = "$var not supplied");
665 } elsif ($var =~ /\.\.\.\]\z/) { # optional args start
668 } elsif ($var =~ /\A\[-?$POS_ARG\]\z/) { # one optional arg
670 } elsif ($var =~ /\A.+?\|/) { # required FOO|--stdin
671 $inf = 1 if index($var, '...') > 0;
672 my @or = split(/\|/, $var);
675 if ($o =~ /\A--([a-z0-9\-]+)/) {
677 # assume pipe/regular file on stdin
678 # w/o args means stdin
679 if ($sw eq 'stdin' && !@$argv &&
684 $ok = defined($OPT->{$sw});
686 } elsif (defined($argv->[$i])) {
690 } # else continue looping
694 $err = join(', ', @or) . " or $last must be set";
696 warn "BUG: can't parse `$var' in $proto";
700 if (!$inf && scalar(@$argv) > scalar(@args)) {
701 $err //= 'too many arguments';
703 $err ? fail($self, "usage: lei $cmd $proto\nE: $err") : 1;
706 sub _tmp_cfg { # for lei -c <name>=<value> ...
708 my $cfg = _lei_cfg($self, 1);
710 my $ft = File::Temp->new(TEMPLATE => 'lei_cfg-XXXX', TMPDIR => 1);
711 my $tmp = { '-f' => $ft->filename, -tmp => $ft };
713 print $ft <<EOM or return fail($self, "$tmp->{-f}: $!");
717 $tmp = $self->{cfg} = bless { %$cfg, %$tmp }, ref($cfg);
718 for (@{$self->{opt}->{c}}) {
719 /\A([^=\.]+\.[^=]+)(?:=(.*))?\z/ or return fail($self, <<EOM);
720 `-c $_' is not of the form -c <name>=<value>'
724 _config($self, '--add', $name, $value);
725 if (defined(my $v = $tmp->{$name})) {
726 if (ref($v) eq 'ARRAY') {
729 $tmp->{$name} = [ $v, $value ];
732 $tmp->{$name} = $value;
738 my ($self, $cmd, $pfx) = @_;
742 $cb = $self->can($pfx.$ucmd) and return $cb;
744 $base =~ s/_([a-z])/\u$1/g;
745 my $pkg = "PublicInbox::Lei\u$base";
746 ($INC{"PublicInbox/Lei\u$base.pm"} // eval("require $pkg")) ?
747 $pkg->can($pfx.$ucmd) : undef;
751 my ($self, $cmd, @argv) = @_;
752 local $current_lei = $self; # for __WARN__
753 $self->{2}->autoflush(1); # keep stdout buffered until x_it|DESTROY
754 dump_and_clear_log("from previous run\n");
755 return _help($self, 'no command given') unless defined($cmd);
756 # do not support Getopt bundling for this
757 while ($cmd eq '-C' || $cmd eq '-c') {
758 my $v = shift(@argv) // return fail($self, $cmd eq '-C' ?
759 '-C DIRECTORY' : '-c <name>=<value>');
760 push @{$self->{opt}->{substr($cmd, 1, 1)}}, $v;
761 $cmd = shift(@argv) // return _help($self, 'no command given');
763 if (my $cb = lazy_cb(__PACKAGE__, $cmd, 'lei_')) {
764 optparse($self, $cmd, \@argv) or return;
765 $self->{opt}->{c} and (_tmp_cfg($self) // return);
766 if (my $chdir = $self->{opt}->{C}) {
767 for my $d (@$chdir) {
768 next if $d eq ''; # same as git(1)
769 chdir $d or return fail($self, "cd $d: $!");
771 open $self->{3}, '.' or return fail($self, "open . $!");
774 } elsif (grep(/\A-/, $cmd, @argv)) { # --help or -h only
775 $GLP->getoptionsfromarray([$cmd, @argv], {}, qw(help|h C=s@))
776 or return _help($self, 'bad arguments or options');
779 fail($self, "`$cmd' is not an lei command");
784 my ($self, $creat) = @_;
785 return $self->{cfg} if $self->{cfg};
786 my $f = _config_path($self);
788 my $cur_st = @st ? pack('dd', $st[10], $st[7]) : ''; # 10:ctime, 7:size
789 my ($sto, $sto_dir, $watches, $lne);
790 if (my $cfg = $PATH2CFG{$f}) { # reuse existing object in common case
791 return ($self->{cfg} = $cfg) if $cur_st eq $cfg->{-st};
792 ($sto, $sto_dir, $watches, $lne) =
793 @$cfg{qw(-lei_store leistore.dir -watches
799 return bless {}, 'PublicInbox::Config';
801 my ($cfg_dir) = ($f =~ m!(.*?/)[^/]+\z!);
802 -d $cfg_dir or mkpath($cfg_dir) or die "mkpath($cfg_dir): $!\n";
803 open my $fh, '>>', $f or die "open($f): $!\n";
804 @st = stat($fh) or die "fstat($f): $!\n";
805 $cur_st = pack('dd', $st[10], $st[7]);
806 qerr($self, "# $f created") if $self->{cmd} ne 'config';
808 my $cfg = PublicInbox::Config->git_config_dump($f);
809 $cfg->{-st} = $cur_st;
811 if ($sto && File::Spec->canonpath($sto_dir // store_path($self))
812 eq File::Spec->canonpath($cfg->{'leistore.dir'} //
813 store_path($self))) {
814 $cfg->{-lei_store} = $sto;
815 $cfg->{-lei_note_event} = $lne;
816 $cfg->{-watches} = $watches if $watches;
818 if (scalar(keys %PATH2CFG) > 5) {
819 # FIXME: use inotify/EVFILT_VNODE to detect unlinked configs
820 for my $k (keys %PATH2CFG) {
821 delete($PATH2CFG{$k}) unless -f $k
824 $self->{cfg} = $PATH2CFG{$f} = $cfg;
825 refresh_watches($self);
829 sub _lei_store ($;$) {
830 my ($self, $creat) = @_;
831 my $cfg = _lei_cfg($self, $creat) // return;
832 $cfg->{-lei_store} //= do {
833 require PublicInbox::LeiStore;
834 my $dir = $cfg->{'leistore.dir'} // store_path($self);
835 return unless $creat || -d $dir;
836 PublicInbox::LeiStore->new($dir, { creat => $creat });
841 my ($self, @argv) = @_;
842 my %env = (%{$self->{env}}, GIT_CONFIG => undef);
843 my $cfg = _lei_cfg($self, 1);
844 my $cmd = [ qw(git config -f), $cfg->{'-f'}, @argv ];
845 my %rdr = map { $_ => $self->{$_} } (0..2);
846 waitpid(spawn($cmd, \%env, \%rdr), 0);
850 my ($self, @argv) = @_;
851 $self->{opt}->{'config-file'} and return fail $self,
852 "config file switches not supported by `lei config'";
854 x_it($self, $?) if $?;
857 sub lei_daemon_pid { puts shift, $$ }
859 sub lei_daemon_kill {
861 my $sig = $self->{opt}->{signal} // 'TERM';
862 kill($sig, $$) or fail($self, "kill($sig, $$): $!");
865 # Shell completion helper. Used by lei-completion.bash and hopefully
866 # other shells. Try to do as much here as possible to avoid redundancy
867 # and improve maintainability.
869 my ($self, @argv) = @_; # argv = qw(lei and any other args...)
870 shift @argv; # ignore "lei", the entire command is sent
871 @argv or return puts $self, grep(!/^_/, keys %CMD), qw(--help -h -C);
872 my $cmd = shift @argv;
873 my $info = $CMD{$cmd} // do { # filter matching commands
874 @argv or puts $self, grep(/\A\Q$cmd\E/, keys %CMD);
877 my ($proto, undef, @spec) = @$info;
879 my $re = defined($cur) ? qr/\A\Q$cur\E/ : qr/./;
880 if (substr(my $_cur = $cur // '-', 0, 1) eq '-') { # --switches
881 # gross special case since the only git-config options
882 # Consider moving to a table if we need more special cases
883 # we use Getopt::Long for are the ones we reject, so these
884 # are the ones we don't reject:
885 if ($cmd eq 'config') {
886 puts $self, grep(/$re/, keys %CONFIG_KEYS);
887 @spec = qw(add z|null get get-all unset unset-all
888 replace-all get-urlmatch
889 remove-section rename-section
890 name-only list|l edit|e
891 get-color-name get-colorbool);
894 # generate short/long names from Getopt::Long specs
895 puts $self, grep(/$re/, qw(--help -h -C), map {
896 if (s/[:=].+\z//) { # req/optional args, e.g output|o=i
897 } elsif (s/\+\z//) { # verbose|v+
899 # negation: mail! => no-mail|mail
900 s/([\w\-]+)/$1|no-$1/g
903 my $x = length > 1 ? "--$_" : "-$_";
904 $x eq $_cur ? () : $x;
905 } grep(!/_/, split(/\|/, $_, -1)) # help|h
906 } grep { $OPTDESC{"$_\t$cmd"} || $OPTDESC{$_} } @spec);
907 } elsif ($cmd eq 'config' && !@argv && !$CONFIG_KEYS{$cur}) {
908 puts $self, grep(/$re/, keys %CONFIG_KEYS);
911 # switch args (e.g. lei q -f mbox<TAB>)
912 if (($argv[-1] // $cur // '') =~ /\A--?([\w\-]+)\z/) {
913 my $opt = quotemeta $1;
915 my $v = $OPTDESC{$_};
916 my @v = ref($v) ? split(/\|/, $v->[0]) : ();
917 # get rid of ALL CAPS placeholder (e.g "OUT")
918 # (TODO: completion for external paths)
919 shift(@v) if scalar(@v) && uc($v[0]) eq $v[0];
921 } grep(/\A(?:[\w-]+\|)*$opt\b.*?(?:\t$cmd)?\z/, keys %OPTDESC);
923 if (my $cb = lazy_cb($self, $cmd, '_complete_')) {
924 puts $self, $cb->($self, @argv, $cur ? ($cur) : ());
926 # TODO: URLs, pathnames, OIDs, MIDs, etc... See optparse() for
931 my ($argv, $env) = @_;
932 my $argc = scalar @$argv;
933 my $buf = 'exec '.join("\0", scalar(@$argv), @$argv);
934 while (my ($k, $v) = each %$env) { $buf .= "\0$k=$v" };
940 my $mua = $self->{opt}->{mua} // return;
941 my $mfolder = $self->{ovv}->{dst};
942 my (@cmd, $replaced);
943 if ($mua =~ /\A(?:mutt|mailx|mail|neomutt)\z/) {
945 # TODO: help wanted: other common FOSS MUAs
947 require Text::ParseWords;
948 @cmd = Text::ParseWords::shellwords($mua);
949 # mutt uses '%f' for open-hook with compressed mbox, we follow
950 @cmd = map { $_ eq '%f' ? ($replaced = $mfolder) : $_ } @cmd;
952 push @cmd, $mfolder unless defined($replaced);
953 if ($self->{sock}) { # lei(1) client process runs it
954 # restore terminal: echo $query | lei q --stdin --mua=...
956 $io->[0] = $self->{1} if $self->{opt}->{stdin} && -t $self->{1};
957 send_exec_cmd($self, $io, \@cmd, {});
959 if ($self->{lxs} && $self->{au_done}) { # kick wait_startq
960 syswrite($self->{au_done}, 'q' x ($self->{lxs}->{jobs} // 0));
962 return unless -t $self->{2}; # XXX how to determine non-TUI MUAs?
963 $self->{opt}->{quiet} = 1;
964 delete $self->{-progress};
965 delete $self->{opt}->{verbose};
968 sub send_exec_cmd { # tell script/lei to execute a command
969 my ($self, $io, $cmd, $env) = @_;
970 my $sock = $self->{sock} // die 'lei client gone';
971 my $fds = [ map { fileno($_) } @$io ];
972 $send_cmd->($sock, $fds, exec_buf($cmd, $env), MSG_EOR);
975 sub poke_mua { # forces terminal MUAs to wake up and hopefully notice new mail
977 my $alerts = $self->{opt}->{alert} // return;
978 my $sock = $self->{sock};
979 while (my $op = shift(@$alerts)) {
980 if ($op eq ':WINCH') {
981 # hit the process group that started the MUA
982 send($sock, '-WINCH', MSG_EOR) if $sock;
983 } elsif ($op eq ':bell') {
985 } elsif ($op =~ /(?<!\\),/) { # bare ',' (not ',,')
986 push @$alerts, split(/(?<!\\),/, $op);
987 } elsif ($op =~ m!\A([/a-z0-9A-Z].+)!) {
988 my $cmd = $1; # run an arbitrary command
989 require Text::ParseWords;
990 $cmd = [ Text::ParseWords::shellwords($cmd) ];
991 send($sock, exec_buf($cmd, {}), MSG_EOR) if $sock;
993 err($self, "W: unsupported --alert=$op"); # non-fatal
998 my %path_to_fd = ('/dev/stdin' => 0, '/dev/stdout' => 1, '/dev/stderr' => 2);
999 $path_to_fd{"/dev/fd/$_"} = $_ for (0..2);
1001 # this also normalizes the path
1003 my ($self, $path) = @_;
1004 $path = rel2abs($self, $path);
1006 $path_to_fd{$path} // (
1007 ($path =~ m!\A/(?:dev|proc/self)/fd/[0-9]+\z!) ?
1008 fail($self, "cannot open $path from daemon") : -1
1012 # caller needs to "-t $self->{1}" to check if tty
1015 my $fh = popen_rd([qw(git var GIT_PAGER)]);
1016 chomp(my $pager = <$fh> // '');
1017 close($fh) or warn "`git var PAGER' error: \$?=$?";
1018 return if $pager eq 'cat' || $pager eq '';
1019 my $new_env = { LESS => 'FRX', LV => '-c' };
1020 $new_env->{MORE} = 'FRX' if $^O eq 'freebsd';
1021 pipe(my ($r, $wpager)) or return warn "pipe: $!";
1022 my $rdr = { 0 => $r, 1 => $self->{1}, 2 => $self->{2} };
1023 my $pgr = [ undef, @$rdr{1, 2} ];
1024 my $env = $self->{env};
1025 if ($self->{sock}) { # lei(1) process runs it
1026 delete @$new_env{keys %$env}; # only set iff unset
1027 send_exec_cmd($self, [ @$rdr{0..2} ], [$pager], $new_env);
1029 die 'BUG: start_pager w/o socket';
1031 $self->{1} = $wpager;
1032 $self->{2} = $wpager if -t $self->{2};
1033 $env->{GIT_PAGER_IN_USE} = 'true'; # we may spawn git
1034 $self->{pgr} = $pgr;
1039 my $pgr = delete($self->{pgr}) or return;
1040 $self->{2} = $pgr->[2];
1041 # do not restore original stdout, just close it so we error out
1042 close(delete($self->{1})) if $self->{1};
1045 sub accept_dispatch { # Listener {post_accept} callback
1046 my ($sock) = @_; # ignore other
1047 $sock->autoflush(1);
1048 my $self = bless { sock => $sock }, __PACKAGE__;
1049 vec(my $rvec = '', fileno($sock), 1) = 1;
1050 select($rvec, undef, undef, 60) or
1051 return send($sock, 'timed out waiting to recv FDs', MSG_EOR);
1052 # (4096 * 33) >MAX_ARG_STRLEN
1053 my @fds = $recv_cmd->($sock, my $buf, 4096 * 33) or return; # EOF
1054 if (!defined($fds[0])) {
1055 warn(my $msg = "recv_cmd failed: $!");
1056 return send($sock, $msg, MSG_EOR);
1060 open($self->{$i++}, '+<&=', $fd) and next;
1061 send($sock, "open(+<&=$fd) (FD=$i): $!", MSG_EOR);
1063 $i == 4 or return send($sock, 'not enough FDs='.($i-1), MSG_EOR)
1065 # $ENV_STR = join('', map { "\0$_=$ENV{$_}" } keys %ENV);
1066 # $buf = "$argc\0".join("\0", @ARGV).$ENV_STR."\0\0";
1067 substr($buf, -2, 2, '') eq "\0\0" or # s/\0\0\z//
1068 return send($sock, 'request command truncated', MSG_EOR);
1069 my ($argc, @argv) = split(/\0/, $buf, -1);
1071 my %env = map { split(/=/, $_, 2) } splice(@argv, $argc);
1072 if (chdir($self->{3})) {
1074 $self->{env} = \%env;
1075 eval { dispatch($self, @argv) };
1076 send($sock, $@, MSG_EOR) if $@;
1078 send($sock, "fchdir: $!", MSG_EOR); # implicit close
1084 delete $self->{-progress};
1085 _drop_wq($self) if $self->{failed};
1086 close(delete $self->{1}) if $self->{1}; # may reap_compress
1087 $self->close if $self->{-event_init_done}; # PublicInbox::DS::close
1090 # for long-running results
1093 local %ENV = %{$self->{env}};
1094 my $sock = $self->{sock};
1095 local $current_lei = $self;
1097 while (my @fds = $recv_cmd->($sock, my $buf, 4096)) {
1098 if (scalar(@fds) == 1 && !defined($fds[0])) {
1099 return if $! == EAGAIN;
1100 next if $! == EINTR;
1101 last if $! == ECONNRESET;
1105 open my $rfh, '+<&=', $fd;
1107 die "unrecognized client signal: $buf";
1109 _drop_wq($self); # EOF, client disconnected
1113 eval { $self->fail($err) };
1118 sub event_step_init {
1120 my $sock = $self->{sock} or return;
1121 $self->{-event_init_done} //= do { # persist til $ops done
1122 $self->SUPER::new($sock, EPOLLIN|EPOLLET);
1129 sub oldset { $oldset }
1131 sub dump_and_clear_log {
1132 if (defined($errors_log) && -s STDIN && seek(STDIN, 0, SEEK_SET)) {
1134 unshift(@pfx, "$errors_log ") if @pfx;
1135 warn @pfx, do { local $/; <STDIN> };
1136 truncate(STDIN, 0) or warn "ftruncate ($errors_log): $!";
1142 my $lei = bless { env => { %{$cfg->{-env}} } }, __PACKAGE__;
1143 open($lei->{0}, '<&', \*STDIN) or die "dup 0: $!";
1144 open($lei->{1}, '>>&', \*STDOUT) or die "dup 1: $!";
1145 open($lei->{2}, '>>&', \*STDERR) or die "dup 2: $!";
1146 open($lei->{3}, '/') or die "open /: $!";
1147 chdir($lei->{3}) or die "chdir /': $!";
1149 socketpair($x, $y, AF_UNIX, SOCK_SEQPACKET, 0) or die "socketpair: $!";
1151 require PublicInbox::LeiSelfSocket;
1152 PublicInbox::LeiSelfSocket->new($y); # adds to event loop
1156 sub dir_idle_handler ($) { # PublicInbox::DirIdle callback
1157 my ($ev) = @_; # Linux::Inotify2::Event or duck type
1158 my $fn = $ev->fullname;
1159 if ($fn =~ m!\A(.+)/(new|cur)/([^/]+)\z!) { # Maildir file
1160 my ($mdir, $nc, $bn) = ($1, $2, $3);
1161 $nc = '' if $ev->IN_DELETE;
1162 for my $f (keys %{$MDIR2CFGPATH->{$mdir} // {}}) {
1163 my $cfg = $PATH2CFG{$f} // next;
1165 local %ENV = %{$cfg->{-env}};
1166 my $lei = cfg2lei($cfg);
1167 $lei->dispatch('note-event',
1168 "maildir:$mdir", $nc, $bn, $fn);
1170 warn "E note-event $f: $@\n" if $@;
1173 if ($ev->can('cancel') && ($ev->IN_IGNORE || $ev->IN_UNMOUNT)) {
1176 if ($fn =~ m!\A(.+)/(?:new|cur)\z! && !-e $fn) {
1177 delete $MDIR2CFGPATH->{$1};
1179 if (!-e $fn) { # config file or Maildir gone
1180 for my $cfgpaths (values %$MDIR2CFGPATH) {
1181 delete $cfgpaths->{$fn};
1183 delete $PATH2CFG{$fn};
1187 # lei(1) calls this when it can't connect
1189 my ($path, $errno, $narg) = @_;
1190 local ($errors_log, $listener);
1191 my ($sock_dir) = ($path =~ m!\A(.+?)/[^/]+\z!);
1192 $errors_log = "$sock_dir/errors.log";
1193 my $addr = pack_sockaddr_un($path);
1194 my $lk = bless { lock_path => $errors_log }, 'PublicInbox::Lock';
1196 socket($listener, AF_UNIX, SOCK_SEQPACKET, 0) or die "socket: $!";
1197 if ($errno == ECONNREFUSED || $errno == ENOENT) {
1198 return if connect($listener, $addr); # another process won
1199 if ($errno == ECONNREFUSED && -S $path) {
1200 unlink($path) or die "unlink($path): $!";
1203 $! = $errno; # allow interpolation to stringify in die
1204 die "connect($path): $!";
1206 umask(077) // die("umask(077): $!");
1207 bind($listener, $addr) or die "bind($path): $!";
1210 my @st = stat($path) or die "stat($path): $!";
1211 my $dev_ino_expect = pack('dd', $st[0], $st[1]); # dev+ino
1212 local $oldset = PublicInbox::DS::block_signals();
1214 $send_cmd = PublicInbox::Spawn->can('send_cmd4');
1215 $recv_cmd = PublicInbox::Spawn->can('recv_cmd4') // do {
1216 require PublicInbox::CmdIPC4;
1217 $send_cmd = PublicInbox::CmdIPC4->can('send_cmd4');
1218 PublicInbox::CmdIPC4->can('recv_cmd4');
1221 $recv_cmd or die <<"";
1222 (Socket::MsgHdr || Inline::C) missing/unconfigured (narg=$narg);
1224 require PublicInbox::Listener;
1225 require PublicInbox::PktOp;
1226 (-p STDOUT) or die "E: stdout must be a pipe\n";
1227 open(STDIN, '+>>', $errors_log) or die "open($errors_log): $!";
1228 STDIN->autoflush(1);
1229 dump_and_clear_log("from previous daemon process:\n");
1230 POSIX::setsid() > 0 or die "setsid: $!";
1231 my $pid = fork // die "fork: $!";
1233 $0 = "lei-daemon $path";
1235 local $MDIR2CFGPATH;
1236 $listener->blocking(0);
1238 my $pil = PublicInbox::Listener->new($listener, \&accept_dispatch);
1240 my (undef, $eof_p) = PublicInbox::PktOp->pair;
1242 $exit_code //= shift;
1243 my $lis = $pil or exit($exit_code);
1244 # closing eof_p triggers \&noop wakeup
1245 $listener = $eof_p = $pil = $path = undef;
1246 $lis->close; # DS::close
1247 PublicInbox::DS->SetLoopTimeout(1000);
1251 CHLD => \&PublicInbox::DS::enqueue_reap,
1259 my $sigfd = PublicInbox::Sigfd->new($sig, SFD_NONBLOCK);
1260 local @SIG{keys %$sig} = values(%$sig) unless $sigfd;
1262 local $SIG{PIPE} = 'IGNORE';
1263 require PublicInbox::DirIdle;
1264 local $dir_idle = PublicInbox::DirIdle->new([$sock_dir], sub {
1265 # just rely on wakeup to hit PostLoopCallback set below
1266 dir_idle_handler($_[0]) if $_[0]->fullname ne $path;
1269 undef $sigfd; # unref, already in DS::DescriptorMap
1271 # wake up every second to accept signals if we don't
1272 # have signalfd or IO::KQueue:
1273 PublicInbox::DS::sig_setmask($oldset);
1274 PublicInbox::DS->SetLoopTimeout(1000);
1276 PublicInbox::DS->SetPostLoopCallback(sub {
1277 my ($dmap, undef) = @_;
1278 if (@st = defined($path) ? stat($path) : ()) {
1279 if ($dev_ino_expect ne pack('dd', $st[0], $st[1])) {
1280 warn "$path dev/ino changed, quitting\n";
1283 } elsif (defined($path)) { # ENOENT is common
1284 warn "stat($path): $!, quitting ...\n" if $! != ENOENT;
1288 return 1 if defined($path);
1291 for my $s (values %$dmap) {
1292 $s->can('busy') or next;
1293 if ($s->busy($now)) {
1299 $n; # true: continue, false: stop
1302 # STDIN was redirected to /dev/null above, closing STDERR and
1303 # STDOUT will cause the calling `lei' client process to finish
1304 # reading the <$daemon> pipe.
1305 local $SIG{__WARN__} = sub {
1306 $current_lei ? err($current_lei, @_) : warn(
1307 strftime('%Y-%m-%dT%H:%M:%SZ', gmtime(time))," $$ ", @_);
1309 open STDERR, '>&STDIN' or die "redirect stderr failed: $!";
1310 open STDOUT, '>&STDIN' or die "redirect stdout failed: $!";
1311 # $daemon pipe to `lei' closed, main loop begins:
1312 PublicInbox::DS->EventLoop;
1313 exit($exit_code // 0);
1316 sub busy { 1 } # prevent daemon-shutdown if client is connected
1318 # ensures stdout hits the FS before sock disconnects so a client
1319 # can immediately reread it
1322 if (my $counters = delete $self->{counters}) {
1323 for my $k (sort keys %$counters) {
1324 my $nr = $counters->{$k};
1325 $self->child_error(1 << 8, "$nr $k messages");
1328 $self->{1}->autoflush(1) if $self->{1};
1330 # preserve $? for ->fail or ->x_it code
1333 sub wq_done_wait { # dwaitpid callback
1334 my ($arg, $pid) = @_;
1335 my ($wq, $lei) = @$arg;
1336 my $err_type = $lei->{-err_type};
1337 $? and $lei->child_error($?,
1338 $err_type ? "$err_type errors during $lei->{cmd}" : ());
1344 my $dh = $lei->{3} // die 'BUG: lei->{3} (CWD) gone';
1345 chdir($dh) || $lei->fail("fchdir: $!");
1348 sub wq_eof { # EOF callback for main daemon
1350 my $wq1 = delete $lei->{wq1} // return $lei->fail; # already failed
1351 $wq1->wq_wait_old(\&wq_done_wait, $lei);
1354 sub watch_state_ok ($) {
1355 my ($state) = $_[-1]; # $_[0] may be $self
1356 $state =~ /\Apause|(?:import|index|tag)-(?:ro|rw)\z/;
1359 sub cancel_maildir_watch ($$) {
1360 my ($d, $cfg_f) = @_;
1361 my $w = delete $MDIR2CFGPATH->{$d}->{$cfg_f};
1362 scalar(keys %{$MDIR2CFGPATH->{$d}}) or
1363 delete $MDIR2CFGPATH->{$d};
1364 for my $x (@{$w // []}) { $x->cancel }
1367 sub refresh_watches {
1369 my $cfg = _lei_cfg($lei) or return;
1370 my $old = $cfg->{-watches};
1371 my $watches = $cfg->{-watches} //= {};
1373 my $cfg_f = $cfg->{'-f'};
1374 for my $w (grep(/\Awatch\..+\.state\z/, keys %$cfg)) {
1375 my $url = substr($w, length('watch.'), -length('.state'));
1376 require PublicInbox::LeiWatch;
1377 my $lw = $watches->{$url} //= PublicInbox::LeiWatch->new($url);
1378 $seen{$url} = undef;
1379 my $state = $cfg->get_1("watch.$url", 'state');
1380 if (!watch_state_ok($state)) {
1381 $lei->err("watch.$url.state=$state not supported");
1384 if ($url =~ /\Amaildir:(.+)/i) {
1385 my $d = File::Spec->canonpath($1);
1386 if ($state eq 'pause') {
1387 cancel_maildir_watch($d, $cfg_f);
1388 } elsif (!exists($MDIR2CFGPATH->{$d}->{$cfg_f})) {
1389 my @w = $dir_idle->add_watches(
1390 ["$d/cur", "$d/new"], 1);
1391 push @{$MDIR2CFGPATH->{$d}->{$cfg_f}}, @w if @w;
1393 } else { # TODO: imap/nntp/jmap
1394 $lei->child_error(1,
1395 "E: watch $url not supported, yet");
1398 if ($old) { # cull old non-existent entries
1399 for my $url (keys %$old) {
1400 next if exists $seen{$url};
1401 delete $old->{$url};
1402 if ($url =~ /\Amaildir:(.+)/i) {
1403 my $d = File::Spec->canonpath($1);
1404 cancel_maildir_watch($d, $cfg_f);
1405 } else { # TODO: imap/nntp/jmap
1406 $lei->child_error(1, "E: watch $url TODO");
1410 if (scalar keys %$watches) {
1411 $cfg->{-env} //= { %{$lei->{env}}, PWD => '/' }; # for cfg2lei
1413 delete $cfg->{-watches};