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 canonpath_harder {
98 my $p = $_[-1]; # $_[0] may be self
99 $p = File::Spec->canonpath($p);
100 $p =~ m!(?:/*|\A)\.\.(?:/*|\z)! && -e $p ? Cwd::abs_path($p) : $p;
103 sub share_path ($) { # $HOME/.local/share/lei/$FOO
105 rel2abs($self, ($self->{env}->{XDG_DATA_HOME} //
106 ($self->{env}->{HOME} // '/nonexistent').'/.local/share')
110 sub store_path ($) { share_path($_[0]) . '/store' }
112 sub _config_path ($) {
114 rel2abs($self, ($self->{env}->{XDG_CONFIG_HOME} //
115 ($self->{env}->{HOME} // '/nonexistent').'/.config')
121 rel2abs($self, ($self->{env}->{XDG_CACHE_HOME} //
122 ($self->{env}->{HOME} // '/nonexistent').'/.cache')
126 sub url_folder_cache {
128 require PublicInbox::SharedKV; # URI => updated_at_sec_
129 PublicInbox::SharedKV->new(cache_dir($self).'/uri_folder');
134 $self->{ale} //= do {
135 require PublicInbox::LeiALE;
136 $self->_lei_cfg(1)->{ale} //= PublicInbox::LeiALE->new($self);
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)
147 my @c_opt = qw(c=s@ C=s@ quiet|q);
148 my @lxs_opt = (qw(remote! local! external! include|I=s@ exclude=s@ only=s@
149 import-remote! no-torsocks torsocks=s),
150 PublicInbox::LeiQuery::curl_opt());
152 # we don't support -C as an alias for --find-copies since it's already
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
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
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]+') ],
181 'up' => [ 'OUTPUT...|--all', 'update saved search',
182 qw(jobs|j=s lock=s@ alert=s@ mua=s verbose|v+ all:s), @c_opt ],
184 'lcat' => [ '--stdin|MSGID_OR_URL...', 'display local copy of message(s)',
185 'stdin|', # /|\z/ must be first for lone dash
186 # some of these options are ridiculous for lcat
187 @lxs_opt, qw(output|mfolder|o=s format|f=s dedupe|d=s threads|t+
188 sort|s=s reverse|r offset=i jobs|j=s globoff|g augment|a
189 import-before! lock=s@ rsyncable alert=s@ mua=s verbose|v+
190 color!), @c_opt, opt_dash('limit|n=i', '[0-9]+') ],
192 'blob' => [ 'OID', 'show a git blob, reconstructing from mail if necessary',
193 qw(git-dir=s@ cwd! verbose|v+ mail! oid-a|A=s path-a|a=s path-b|b=s),
196 'rediff' => [ '--stdin|LOCATION...',
197 'regenerate a diff with different options',
198 'stdin|', # /|\z/ must be first for lone dash
199 qw(git-dir=s@ cwd! verbose|v+ color:s no-color),
200 @diff_opt, @lxs_opt, @c_opt ],
202 'add-external' => [ 'LOCATION',
203 'add/set priority of a publicinbox|extindex for extra matches',
204 qw(boost=i mirror=s no-torsocks torsocks=s inbox-version=i
205 verbose|v+), @c_opt, index_opt(),
206 PublicInbox::LeiQuery::curl_opt() ],
207 'ls-external' => [ '[FILTER]', 'list publicinbox|extindex locations',
208 qw(format|f=s z|0 globoff|g invert-match|v local remote), @c_opt ],
209 'ls-label' => [ '', 'list labels', qw(z|0 stats:s), @c_opt ],
210 'ls-mail-sync' => [ '[FILTER]', 'list mail sync folders',
211 qw(z|0 globoff|g invert-match|v local remote), @c_opt ],
212 'ls-mail-source' => [ 'URL', 'list IMAP or NNTP mail source folders',
213 qw(z|0 ascii l url), @c_opt ],
214 'forget-external' => [ 'LOCATION...|--prune',
215 'exclude further results from a publicinbox|extindex',
218 'ls-search' => [ '[PREFIX]', 'list saved search queries',
219 qw(format|f=s pretty l ascii z|0), @c_opt ],
220 'forget-search' => [ 'OUTPUT', 'forget a saved search',
221 qw(verbose|v+), @c_opt ],
222 'edit-search' => [ 'OUTPUT', "edit saved search via `git config --edit'",
224 'rm' => [ '--stdin|LOCATION...',
225 'remove a message from the index and prevent reindexing',
226 'stdin|', # /|\z/ must be first for lone dash
228 'plonk' => [ '--threads|--from=IDENT',
229 'exclude mail matching From: or threads from non-Message-ID searches',
230 qw(stdin| threads|t from|f=s mid=s oid=s), @c_opt ],
231 'tag' => [ 'KEYWORDS...',
232 'set/unset keywords and/or labels on message(s)',
233 qw(stdin| in-format|F=s input|i=s@ oid=s@ mid=s@),
234 qw(no-torsocks torsocks=s), PublicInbox::LeiQuery::curl_opt(), @c_opt,
235 pass_through('-kw:foo for delete') ],
237 'purge-mailsource' => [ 'LOCATION|--all',
238 'remove imported messages from IMAP, Maildirs, and MH',
239 qw(exact! all jobs:i indexed), @c_opt ],
241 'add-watch' => [ 'LOCATION...', 'watch for new messages and flag changes',
242 qw(poll-interval=s state=s recursive|r), @c_opt ],
243 'rm-watch' => [ 'LOCATION...', 'remove specified watch(es)',
244 qw(recursive|r), @c_opt ],
245 'ls-watch' => [ '[FILTER...]', 'list active watches with numbers and status',
247 'pause-watch' => [ '[WATCH_NUMBER_OR_FILTER]', qw(all local remote), @c_opt ],
248 'resume-watch' => [ '[WATCH_NUMBER_OR_FILTER]', qw(all local remote), @c_opt ],
249 'forget-watch' => [ '{WATCH_NUMBER|--prune}', 'stop and forget a watch',
252 'index' => [ 'LOCATION...', 'one-time index from URL or filesystem',
253 qw(in-format|F=s kw! offset=i recursive|r exclude=s include|I=s
254 verbose|v+ incremental!),
255 PublicInbox::LeiQuery::curl_opt(), # mainly for --proxy=
257 'import' => [ 'LOCATION...|--stdin',
258 'one-time import/update from URL or filesystem',
259 qw(stdin| offset=i recursive|r exclude=s include|I=s jobs=s new-only
260 lock=s@ in-format|F=s kw! verbose|v+ incremental! mail-sync!),
261 qw(no-torsocks torsocks=s), PublicInbox::LeiQuery::curl_opt(), @c_opt ],
262 'forget-mail-sync' => [ 'LOCATION...',
263 'forget sync information for a mail folder', @c_opt ],
264 'prune-mail-sync' => [ 'LOCATION...|--all',
265 'prune dangling sync data for a mail folder', 'all:s', @c_opt ],
266 'export-kw' => [ 'LOCATION...|--all',
267 'one-time export of keywords of sync sources',
268 qw(all:s mode=s), @c_opt ],
269 'convert' => [ 'LOCATION...|--stdin',
270 'one-time conversion from URL or filesystem to another format',
271 qw(stdin| in-format|F=s out-format|f=s output|mfolder|o=s lock=s@ kw!),
272 qw(no-torsocks torsocks=s), PublicInbox::LeiQuery::curl_opt(), @c_opt ],
273 'p2q' => [ 'FILE|COMMIT_OID|--stdin',
274 "use a patch to generate a query for `lei q --stdin'",
275 qw(stdin| want|w=s@ uri debug), @c_opt ],
276 'config' => [ '[...]', sub {
277 'git-config(1) wrapper for '._config_path($_[0]);
278 }, qw(config-file|system|global|file|f=s), # for conflict detection
279 qw(c=s@ C=s@), pass_through('git config') ],
280 'inspect' => [ 'ITEMS...', 'inspect lei/store and/or local external',
281 qw(pretty ascii dir=s), @c_opt ],
283 'init' => [ '[DIRNAME]', sub {
284 "initialize storage, default: ".store_path($_[0]);
286 'daemon-kill' => [ '[-SIGNAL]', 'signal the lei-daemon',
287 # "-C DIR" conflicts with -CHLD, here, and chdir makes no sense, here
288 opt_dash('signal|s=s', '[0-9]+|(?:[A-Z][A-Z0-9]+)') ],
289 'daemon-pid' => [ '', 'show the PID of the lei-daemon' ],
290 'help' => [ '[SUBCOMMAND]', 'show help' ],
293 #'reorder-local-store-and-break-history' => [ '[REFNAME]',
294 # 'rewrite git history in an attempt to improve compression',
296 #'fuse-mount' => [ 'PATHNAME', 'expose lei/store as Maildir(s)', @c_opt ],
298 # internal commands are prefixed with '_'
299 '_complete' => [ '[...]', 'internal shell completion helper',
300 pass_through('everything') ],
303 # switch descriptions, try to keep consistent across commands
304 # $spec: Getopt::Long option specification
305 # $spec => [@ALLOWED_VALUES (default is first), $description],
306 # $spec => $description
307 # "$SUB_COMMAND TAB $spec" => as above
308 my $stdin_formats = [ 'MAIL_FORMAT|eml|mboxrd|mboxcl2|mboxcl|mboxo',
309 'specify message input format' ];
310 my $ls_format = [ 'OUT|plain|json|null', 'listing output format' ];
312 # we use \x{a0} (non-breaking SP) to avoid wrapping in PublicInbox::LeiHelp
314 'help|h' => 'show this built-in help',
315 'c=s@' => [ 'NAME=VALUE', 'set config option' ],
316 'C=s@' => [ 'DIR', 'chdir to specify to directory' ],
317 'quiet|q' => 'be quiet',
318 'lock=s@' => [ 'METHOD|dotlock|fcntl|flock|none',
319 'mbox(5) locking method(s) to use (default: fcntl,dotlock)' ],
321 'incremental! import' => 'import already seen IMAP and NNTP articles',
322 'globoff|g' => "do not match locations using '*?' wildcards ".
323 "and\xa0'[]'\x{a0}ranges",
324 'invert-match|v' => 'select non-matching lines',
325 'color!' => 'disable color (for --format=text)',
326 'verbose|v+' => 'be more verbose',
327 'external!' => 'do not use externals',
328 'mail!' => 'do not look in mail storage for OID',
329 'cwd!' => 'do not look in git repo of current working directory',
330 'oid-a|A=s' => 'pre-image OID',
331 'path-a|a=s' => 'pre-image pathname associated with OID',
332 'path-b|b=s' => 'post-image pathname associated with OID',
333 'git-dir=s@' => 'additional git repository to scan',
334 'dir=s inspect' => 'specify a inboxdir, extindex topdir or Xapian shard',
335 'proxy=s' => [ 'PROTO://HOST[:PORT]', # shared with curl(1)
336 "proxy for (e.g. `socks5h://0:9050')" ],
337 'torsocks=s' => ['VAL|auto|no|yes',
338 'whether or not to wrap git and curl commands with torsocks'],
339 'no-torsocks' => 'alias for --torsocks=no',
340 'save!' => "do not save a search for `lei up'",
341 'import-remote!' => 'do not memoize remote messages into local store',
343 'type=s' => [ 'any|mid|git', 'disambiguate type' ],
345 'dedupe|d=s' => ['STRATEGY|content|oid|mid|none',
346 'deduplication strategy'],
348 'return all messages in the same threads as the actual match(es)',
350 'want|w=s@' => [ 'PREFIX|dfpost|dfn', # common ones in help...
351 'search prefixes to extract (default: dfpost7)' ],
353 'alert=s@' => ['CMD,:WINCH,:bell,<any command>',
354 'run command(s) or perform ops when done writing to output ' .
355 '(default: ":WINCH,:bell" with --mua and Maildir/IMAP output, ' .
356 'nothing otherwise)' ],
358 'augment|a' => 'augment --output destination instead of clobbering',
360 'output|mfolder|o=s' => [ 'MFOLDER',
361 "destination (e.g.\xa0`/path/to/Maildir', ".
362 "or\xa0`-'\x{a0}for\x{a0}stdout)" ],
364 "MUA to run on --output Maildir or mbox (e.g.\xa0`mutt\xa0-f\xa0%f')" ],
365 'new-only import' => 'only import new messages from IMAP source',
367 'inbox-version=i' => [ 'NUM|1|2',
368 'force a public-inbox version with --mirror'],
369 'mirror=s' => [ 'URL', 'mirror a public-inbox'],
371 # public-inbox-index options
372 'fsync!' => 'speed up indexing after --mirror, risk index corruption',
373 'compact' => 'run compact index after mirroring',
374 'indexlevel|L=s' => [ 'LEVEL|full|medium|basic',
375 "indexlevel with --mirror (default: full)" ],
376 'max_size|max-size=s' => [ 'SIZE',
377 'do not index messages larger than SIZE (default: infinity)' ],
378 'batch_size|batch-size=s' => [ 'SIZE',
379 'flush changes to OS after given number of bytes (default: 1m)' ],
380 'sequential-shard' =>
381 'index Xapian shards sequentially for slow storage',
383 'drop compatibility w/ public-inbox <1.6 to save ~1.5% space',
386 'OUT|maildir|mboxrd|mboxcl2|mboxcl|mboxo|html|json|jsonl|concatjson',
387 'specify output format, default depends on --output'],
388 'exclude=s@ q' => [ 'LOCATION',
389 'exclude specified external(s) from search' ],
390 'include|I=s@ q' => [ 'LOCATION',
391 'include specified external(s) in search' ],
392 'only=s@ q' => [ 'LOCATION',
393 'only use specified external(s) for search' ],
394 'jobs=s q' => [ '[SEARCH_JOBS][,WRITER_JOBS]',
395 'control number of search and writer jobs' ],
396 'jobs|j=i add-external' => 'set parallelism when indexing after --mirror',
398 'in-format|F=s' => $stdin_formats,
399 'format|f=s ls-search' => ['OUT|json|jsonl|concatjson',
400 'listing output format' ],
401 'l ls-search' => 'long listing format',
402 'l ls-watch' => 'long listing format',
403 'l ls-mail-source' => 'long listing format',
404 'url ls-mail-source' => 'show full URL of newsgroup or IMAP folder',
405 'format|f=s ls-external' => $ls_format,
407 'limit|n=i@' => ['NUM', 'limit on number of matches (default: 10000)' ],
408 'offset=i' => ['OFF', 'search result offset (default: 0)'],
410 'sort|s=s' => [ 'VAL|received|relevance|docid',
411 "order of results is `--output'-dependent"],
412 'reverse|r' => 'reverse search results', # like sort(1)
414 'boost=i' => 'increase/decrease priority of results (default: 0)',
416 'local' => 'limit operations to the local filesystem',
417 'local!' => 'exclude results from the local filesystem',
418 'remote' => 'limit operations to those requiring network access',
419 'remote!' => 'prevent operations requiring network access',
421 'all:s up' => ['local', 'update all (local) saved searches' ],
423 'mid=s' => 'specify the Message-ID of a message',
424 'oid=s' => 'specify the git object ID of a message',
426 'recursive|r' => 'scan directories/mailboxes/newsgroups recursively',
427 'exclude=s' => 'exclude mailboxes/newsgroups based on pattern',
428 'include=s' => 'include mailboxes/newsgroups based on pattern',
430 'exact' => 'operate on exact header matches only',
431 'exact!' => 'rely on content match instead of exact header matches',
433 'by-mid|mid:s' => [ 'MID', 'match only by Message-ID, ignoring contents' ],
435 'kw!' => 'disable/enable importing keywords (aka "flags")',
437 # xargs, env, use "-0", git(1) uses "-z". We support z|0 everywhere
438 'z|0' => 'use NUL \\0 instead of newline (CR) to delimit lines',
440 'signal|s=s' => [ 'SIG', 'signal to send lei-daemon (default: TERM)' ],
444 'leistore.dir' => 'top-level storage location',
447 my @WQ_KEYS = qw(lxs l2m ikw pmd wq1 lne); # internal workers
451 for my $wq (grep(defined, delete(@$self{@WQ_KEYS}))) {
453 $wq->wq_close(0, undef, $self);
454 } elsif ($wq->wq_kill_old) {
455 $wq->wq_wait_old(undef, $self);
461 # pronounced "exit": x_it(1 << 8) => exit(1); x_it(13) => SIGPIPE
463 my ($self, $code) = @_;
464 # make sure client sees stdout before exit
465 $self->{1}->autoflush(1) if $self->{1};
466 dump_and_clear_log();
468 if ($self->{pkt_op_p}) { # to top lei-daemon
469 $self->{pkt_op_p}->pkt_do('x_it', $code);
470 } elsif ($self->{sock}) { # to lei(1) client
471 send($self->{sock}, "x_it $code", MSG_EOR);
472 } # else ignore if client disconnected
477 my $err = $self->{2} // ($self->{pgr} // [])->[2] // *STDERR{GLOB};
478 my @eor = (substr($_[-1]//'', -1, 1) eq "\n" ? () : ("\n"));
479 print $err @_, @eor and return;
480 my $old_err = delete $self->{2};
481 close($old_err) if $! == EPIPE && $old_err;
482 $err = $self->{2} = ($self->{pgr} // [])->[2] // *STDERR{GLOB};
483 print $err @_, @eor or print STDERR @_, @eor;
486 sub qerr ($;@) { $_[0]->{opt}->{quiet} or err(shift, @_) }
488 sub fail_handler ($;$$) {
489 my ($lei, $code, $io) = @_;
490 close($io) if $io; # needed to avoid warnings on SIGPIPE
492 x_it($lei, $code // (1 << 8));
495 sub sigpipe_handler { # handles SIGPIPE from @WQ_KEYS workers
496 fail_handler($_[0], 13, delete $_[0]->{1});
499 # PublicInbox::OnDestroy callback for SIGINT to take out the entire pgid
502 dwaitpid($pgid) if kill('-INT', $pgid);
506 my ($self, $buf, $exit_code) = @_;
508 err($self, $buf) if defined $buf;
509 # calls fail_handler:
510 $self->{pkt_op_p}->pkt_do('!') if $self->{pkt_op_p};
511 x_it($self, ($exit_code // 1) << 8);
517 return if print { $self->{1} // return } @_; # likely
518 return note_sigpipe($self, 1) if $! == EPIPE;
519 my $err = "error writing to output: $!";
524 sub puts ($;@) { out(shift, map { "$_\n" } @_) }
526 sub child_error { # passes non-fatal curl exit codes to user
527 my ($self, $child_error, $msg) = @_; # child_error is $?
528 $self->err($msg) if $msg;
529 if ($self->{pkt_op_p}) { # to top lei-daemon
530 $self->{pkt_op_p}->pkt_do('child_error', $child_error);
531 } elsif ($self->{sock}) { # to lei(1) client
532 send($self->{sock}, "child_error $child_error", MSG_EOR);
533 } # else noop if client disconnected
536 sub note_sigpipe { # triggers sigpipe_handler
537 my ($self, $fd) = @_;
538 close(delete($self->{$fd})); # explicit close silences Perl warning
539 $self->{pkt_op_p}->pkt_do('|') if $self->{pkt_op_p};
543 sub _lei_atfork_child {
544 my ($self, $persist) = @_;
545 # we need to explicitly close things which are on stack
547 chdir '/' or die "chdir(/): $!";
548 close($_) for (grep(defined, delete @$self{qw(0 1 2 sock)}));
549 if (my $cfg = $self->{cfg}) {
550 delete @$cfg{qw(-lei_store -watches -lei_note_event)};
552 } else { # worker, Net::NNTP (Net::Cmd) uses STDERR directly
553 open STDERR, '+>&='.fileno($self->{2}) or warn "open $!";
554 STDERR->autoflush(1);
556 close($_) for (grep(defined, delete @$self{qw(3 old_1 au_done)}));
557 if (my $op_c = delete $self->{pkt_op_c}) {
558 close(delete $op_c->{sock});
560 if (my $pgr = delete $self->{pgr}) {
561 close($_) for (@$pgr[1,2]);
563 close $listener if $listener;
565 $dir_idle->force_close if $dir_idle;
568 eval 'no warnings; undef $PublicInbox::LeiNoteEvent::to_flush';
570 $quit = \&CORE::exit;
571 $self->{-eml_noisy} or # only "lei import" sets this atm
572 $SIG{__WARN__} = PublicInbox::Eml::warn_ignore_cb();
573 $current_lei = $persist ? undef : $self; # for SIG{__WARN__}
576 sub _delete_pkt_op { # OnDestroy callback to prevent leaks on die
578 if (my $op = delete $self->{pkt_op_c}) { # in case of die
579 $op->close; # PublicInbox::PktOp::close
581 my $pkt_op_p = delete($self->{pkt_op_p}) or return;
582 close $pkt_op_p->{op_p};
587 require PublicInbox::OnDestroy;
588 require PublicInbox::PktOp;
589 my $end = PublicInbox::OnDestroy->new($$, \&_delete_pkt_op, $self);
590 @$self{qw(pkt_op_c pkt_op_p)} = PublicInbox::PktOp->pair;
595 my ($self, $field, $nr) = @_;
596 $self->{counters}->{$field} += $nr;
600 my ($lei, $wq, $jobs, $ops, $flds) = @_;
602 '!' => [ \&fail_handler, $lei ],
603 '|' => [ \&sigpipe_handler, $lei ],
604 'x_it' => [ \&x_it, $lei ],
605 'child_error' => [ \&child_error, $lei ],
606 'incr' => [ \&incr, $lei ],
609 $ops->{''} //= [ $wq->can('_lei_wq_eof') || \&wq_eof, $lei ];
610 my $end = $lei->pkt_op_pair;
611 my $ident = $wq->{-wq_ident} // "lei-$lei->{cmd} worker";
613 $wq->wq_workers_start($ident, $jobs, $lei->oldset, $flds);
614 delete $lei->{pkt_op_p};
615 my $op_c = delete $lei->{pkt_op_c};
617 $lei->event_step_init;
621 # call this when we're ready to wait on events and yield to other clients
623 my ($lei, $op_c, $ops) = @_;
624 for my $wq (grep(defined, @$lei{qw(ikw pmd)})) { # auxiliary WQs
631 require PublicInbox::LeiHelp;
632 PublicInbox::LeiHelp::call($_[0], $_[1], \%CMD, \%OPTDESC);
636 my ($self, $cmd, $argv) = @_;
637 # allow _complete --help to complete, not show help
638 return 1 if substr($cmd, 0, 1) eq '_';
640 $OPT = $self->{opt} //= {};
641 my $info = $CMD{$cmd} // [ '[...]' ];
642 my ($proto, undef, @spec) = @$info;
643 my $glp = ref($spec[-1]) eq ref($GLP) ? pop(@spec) : $GLP;
644 push @spec, qw(help|h);
646 if ($spec[0] =~ s/\|\z//s) { # "stdin|" or "clear|" allows "-" alias
647 $lone_dash = $spec[0];
648 $OPT->{$spec[0]} = \(my $var);
649 push @spec, '' => \$var;
651 $glp->getoptionsfromarray($argv, $OPT, @spec) or
652 return _help($self, "bad arguments or options for $cmd");
653 return _help($self) if $OPT->{help};
655 push @$argv, @{$OPT->{-argv}} if defined($OPT->{-argv});
657 # "-" aliases "stdin" or "clear"
658 $OPT->{$lone_dash} = ${$OPT->{$lone_dash}} if defined $lone_dash;
661 my $POS_ARG = '[A-Z][A-Z0-9_]+';
663 my @args = split(/ /, $proto);
664 for my $var (@args) {
665 if ($var =~ /\A$POS_ARG\.\.\.\z/o) { # >= 1 args;
666 $inf = defined($argv->[$i]) and last;
667 $var =~ s/\.\.\.\z//;
668 $err = "$var not supplied";
669 } elsif ($var =~ /\A$POS_ARG\z/o) { # required arg at $i
670 $argv->[$i++] // ($err = "$var not supplied");
671 } elsif ($var =~ /\.\.\.\]\z/) { # optional args start
674 } elsif ($var =~ /\A\[-?$POS_ARG\]\z/) { # one optional arg
676 } elsif ($var =~ /\A.+?\|/) { # required FOO|--stdin
677 $inf = 1 if index($var, '...') > 0;
678 my @or = split(/\|/, $var);
681 if ($o =~ /\A--([a-z0-9\-]+)/) {
683 # assume pipe/regular file on stdin
684 # w/o args means stdin
685 if ($sw eq 'stdin' && !@$argv &&
690 $ok = defined($OPT->{$sw});
692 } elsif (defined($argv->[$i])) {
696 } # else continue looping
700 $err = join(', ', @or) . " or $last must be set";
702 warn "BUG: can't parse `$var' in $proto";
706 if (!$inf && scalar(@$argv) > scalar(@args)) {
707 $err //= 'too many arguments';
709 $err ? fail($self, "usage: lei $cmd $proto\nE: $err") : 1;
712 sub _tmp_cfg { # for lei -c <name>=<value> ...
714 my $cfg = _lei_cfg($self, 1);
716 my $ft = File::Temp->new(TEMPLATE => 'lei_cfg-XXXX', TMPDIR => 1);
717 my $tmp = { '-f' => $ft->filename, -tmp => $ft };
719 print $ft <<EOM or return fail($self, "$tmp->{-f}: $!");
723 $tmp = $self->{cfg} = bless { %$cfg, %$tmp }, ref($cfg);
724 for (@{$self->{opt}->{c}}) {
725 /\A([^=\.]+\.[^=]+)(?:=(.*))?\z/ or return fail($self, <<EOM);
726 `-c $_' is not of the form -c <name>=<value>'
730 _config($self, '--add', $name, $value);
731 if (defined(my $v = $tmp->{$name})) {
732 if (ref($v) eq 'ARRAY') {
735 $tmp->{$name} = [ $v, $value ];
738 $tmp->{$name} = $value;
744 my ($self, $cmd, $pfx) = @_;
748 $cb = $self->can($pfx.$ucmd) and return $cb;
750 $base =~ s/_([a-z])/\u$1/g;
751 my $pkg = "PublicInbox::Lei\u$base";
752 ($INC{"PublicInbox/Lei\u$base.pm"} // eval("require $pkg")) ?
753 $pkg->can($pfx.$ucmd) : undef;
757 my ($self, $cmd, @argv) = @_;
758 local $current_lei = $self; # for __WARN__
759 $self->{2}->autoflush(1); # keep stdout buffered until x_it|DESTROY
760 dump_and_clear_log("from previous run\n");
761 return _help($self, 'no command given') unless defined($cmd);
762 # do not support Getopt bundling for this
763 while ($cmd eq '-C' || $cmd eq '-c') {
764 my $v = shift(@argv) // return fail($self, $cmd eq '-C' ?
765 '-C DIRECTORY' : '-c <name>=<value>');
766 push @{$self->{opt}->{substr($cmd, 1, 1)}}, $v;
767 $cmd = shift(@argv) // return _help($self, 'no command given');
769 if (my $cb = lazy_cb(__PACKAGE__, $cmd, 'lei_')) {
770 optparse($self, $cmd, \@argv) or return;
771 $self->{opt}->{c} and (_tmp_cfg($self) // return);
772 if (my $chdir = $self->{opt}->{C}) {
773 for my $d (@$chdir) {
774 next if $d eq ''; # same as git(1)
775 chdir $d or return fail($self, "cd $d: $!");
777 open $self->{3}, '.' or return fail($self, "open . $!");
780 } elsif (grep(/\A-/, $cmd, @argv)) { # --help or -h only
781 $GLP->getoptionsfromarray([$cmd, @argv], {}, qw(help|h C=s@))
782 or return _help($self, 'bad arguments or options');
785 fail($self, "`$cmd' is not an lei command");
790 my ($self, $creat) = @_;
791 return $self->{cfg} if $self->{cfg};
792 my $f = _config_path($self);
794 my $cur_st = @st ? pack('dd', $st[10], $st[7]) : ''; # 10:ctime, 7:size
795 my ($sto, $sto_dir, $watches, $lne);
796 if (my $cfg = $PATH2CFG{$f}) { # reuse existing object in common case
797 return ($self->{cfg} = $cfg) if $cur_st eq $cfg->{-st};
798 ($sto, $sto_dir, $watches, $lne) =
799 @$cfg{qw(-lei_store leistore.dir -watches
805 return bless {}, 'PublicInbox::Config';
807 my ($cfg_dir) = ($f =~ m!(.*?/)[^/]+\z!);
808 -d $cfg_dir or mkpath($cfg_dir) or die "mkpath($cfg_dir): $!\n";
809 open my $fh, '>>', $f or die "open($f): $!\n";
810 @st = stat($fh) or die "fstat($f): $!\n";
811 $cur_st = pack('dd', $st[10], $st[7]);
812 qerr($self, "# $f created") if $self->{cmd} ne 'config';
814 my $cfg = PublicInbox::Config->git_config_dump($f);
815 $cfg->{-st} = $cur_st;
817 if ($sto && canonpath_harder($sto_dir // store_path($self))
818 eq canonpath_harder($cfg->{'leistore.dir'} //
819 store_path($self))) {
820 $cfg->{-lei_store} = $sto;
821 $cfg->{-lei_note_event} = $lne;
822 $cfg->{-watches} = $watches if $watches;
824 if (scalar(keys %PATH2CFG) > 5) {
825 # FIXME: use inotify/EVFILT_VNODE to detect unlinked configs
826 for my $k (keys %PATH2CFG) {
827 delete($PATH2CFG{$k}) unless -f $k
830 $self->{cfg} = $PATH2CFG{$f} = $cfg;
831 refresh_watches($self);
835 sub _lei_store ($;$) {
836 my ($self, $creat) = @_;
837 my $cfg = _lei_cfg($self, $creat) // return;
838 $cfg->{-lei_store} //= do {
839 require PublicInbox::LeiStore;
840 my $dir = $cfg->{'leistore.dir'} // store_path($self);
841 return unless $creat || -d $dir;
842 PublicInbox::LeiStore->new($dir, { creat => $creat });
847 my ($self, @argv) = @_;
848 my %env = (%{$self->{env}}, GIT_CONFIG => undef);
849 my $cfg = _lei_cfg($self, 1);
850 my $cmd = [ qw(git config -f), $cfg->{'-f'}, @argv ];
851 my %rdr = map { $_ => $self->{$_} } (0..2);
852 waitpid(spawn($cmd, \%env, \%rdr), 0);
856 my ($self, @argv) = @_;
857 $self->{opt}->{'config-file'} and return fail $self,
858 "config file switches not supported by `lei config'";
860 x_it($self, $?) if $?;
863 sub lei_daemon_pid { puts shift, $$ }
865 sub lei_daemon_kill {
867 my $sig = $self->{opt}->{signal} // 'TERM';
868 kill($sig, $$) or fail($self, "kill($sig, $$): $!");
871 # Shell completion helper. Used by lei-completion.bash and hopefully
872 # other shells. Try to do as much here as possible to avoid redundancy
873 # and improve maintainability.
875 my ($self, @argv) = @_; # argv = qw(lei and any other args...)
876 shift @argv; # ignore "lei", the entire command is sent
877 @argv or return puts $self, grep(!/^_/, keys %CMD), qw(--help -h -C);
878 my $cmd = shift @argv;
879 my $info = $CMD{$cmd} // do { # filter matching commands
880 @argv or puts $self, grep(/\A\Q$cmd\E/, keys %CMD);
883 my ($proto, undef, @spec) = @$info;
885 my $re = defined($cur) ? qr/\A\Q$cur\E/ : qr/./;
886 if (substr(my $_cur = $cur // '-', 0, 1) eq '-') { # --switches
887 # gross special case since the only git-config options
888 # Consider moving to a table if we need more special cases
889 # we use Getopt::Long for are the ones we reject, so these
890 # are the ones we don't reject:
891 if ($cmd eq 'config') {
892 puts $self, grep(/$re/, keys %CONFIG_KEYS);
893 @spec = qw(add z|null get get-all unset unset-all
894 replace-all get-urlmatch
895 remove-section rename-section
896 name-only list|l edit|e
897 get-color-name get-colorbool);
900 # generate short/long names from Getopt::Long specs
901 puts $self, grep(/$re/, qw(--help -h -C), map {
902 if (s/[:=].+\z//) { # req/optional args, e.g output|o=i
903 } elsif (s/\+\z//) { # verbose|v+
905 # negation: mail! => no-mail|mail
906 s/([\w\-]+)/$1|no-$1/g
909 my $x = length > 1 ? "--$_" : "-$_";
910 $x eq $_cur ? () : $x;
911 } grep(!/_/, split(/\|/, $_, -1)) # help|h
912 } grep { $OPTDESC{"$_\t$cmd"} || $OPTDESC{$_} } @spec);
913 } elsif ($cmd eq 'config' && !@argv && !$CONFIG_KEYS{$cur}) {
914 puts $self, grep(/$re/, keys %CONFIG_KEYS);
917 # switch args (e.g. lei q -f mbox<TAB>)
918 if (($argv[-1] // $cur // '') =~ /\A--?([\w\-]+)\z/) {
919 my $opt = quotemeta $1;
921 my $v = $OPTDESC{$_};
922 my @v = ref($v) ? split(/\|/, $v->[0]) : ();
923 # get rid of ALL CAPS placeholder (e.g "OUT")
924 # (TODO: completion for external paths)
925 shift(@v) if scalar(@v) && uc($v[0]) eq $v[0];
927 } grep(/\A(?:[\w-]+\|)*$opt\b.*?(?:\t$cmd)?\z/, keys %OPTDESC);
929 if (my $cb = lazy_cb($self, $cmd, '_complete_')) {
930 puts $self, $cb->($self, @argv, $cur ? ($cur) : ());
932 # TODO: URLs, pathnames, OIDs, MIDs, etc... See optparse() for
937 my ($argv, $env) = @_;
938 my $argc = scalar @$argv;
939 my $buf = 'exec '.join("\0", scalar(@$argv), @$argv);
940 while (my ($k, $v) = each %$env) { $buf .= "\0$k=$v" };
946 my $mua = $self->{opt}->{mua} // return;
947 my $mfolder = $self->{ovv}->{dst};
948 my (@cmd, $replaced);
949 if ($mua =~ /\A(?:mutt|mailx|mail|neomutt)\z/) {
951 # TODO: help wanted: other common FOSS MUAs
953 require Text::ParseWords;
954 @cmd = Text::ParseWords::shellwords($mua);
955 # mutt uses '%f' for open-hook with compressed mbox, we follow
956 @cmd = map { $_ eq '%f' ? ($replaced = $mfolder) : $_ } @cmd;
958 push @cmd, $mfolder unless defined($replaced);
959 if ($self->{sock}) { # lei(1) client process runs it
960 # restore terminal: echo $query | lei q --stdin --mua=...
962 $io->[0] = $self->{1} if $self->{opt}->{stdin} && -t $self->{1};
963 send_exec_cmd($self, $io, \@cmd, {});
965 if ($self->{lxs} && $self->{au_done}) { # kick wait_startq
966 syswrite($self->{au_done}, 'q' x ($self->{lxs}->{jobs} // 0));
968 return unless -t $self->{2}; # XXX how to determine non-TUI MUAs?
969 $self->{opt}->{quiet} = 1;
970 delete $self->{-progress};
971 delete $self->{opt}->{verbose};
974 sub send_exec_cmd { # tell script/lei to execute a command
975 my ($self, $io, $cmd, $env) = @_;
976 my $sock = $self->{sock} // die 'lei client gone';
977 my $fds = [ map { fileno($_) } @$io ];
978 $send_cmd->($sock, $fds, exec_buf($cmd, $env), MSG_EOR);
981 sub poke_mua { # forces terminal MUAs to wake up and hopefully notice new mail
983 my $alerts = $self->{opt}->{alert} // return;
984 my $sock = $self->{sock};
985 while (my $op = shift(@$alerts)) {
986 if ($op eq ':WINCH') {
987 # hit the process group that started the MUA
988 send($sock, '-WINCH', MSG_EOR) if $sock;
989 } elsif ($op eq ':bell') {
991 } elsif ($op =~ /(?<!\\),/) { # bare ',' (not ',,')
992 push @$alerts, split(/(?<!\\),/, $op);
993 } elsif ($op =~ m!\A([/a-z0-9A-Z].+)!) {
994 my $cmd = $1; # run an arbitrary command
995 require Text::ParseWords;
996 $cmd = [ Text::ParseWords::shellwords($cmd) ];
997 send($sock, exec_buf($cmd, {}), MSG_EOR) if $sock;
999 err($self, "W: unsupported --alert=$op"); # non-fatal
1004 my %path_to_fd = ('/dev/stdin' => 0, '/dev/stdout' => 1, '/dev/stderr' => 2);
1005 $path_to_fd{"/dev/fd/$_"} = $_ for (0..2);
1007 # this also normalizes the path
1009 my ($self, $path) = @_;
1010 $path = rel2abs($self, $path);
1012 $path_to_fd{$path} // (
1013 ($path =~ m!\A/(?:dev|proc/self)/fd/[0-9]+\z!) ?
1014 fail($self, "cannot open $path from daemon") : -1
1018 # caller needs to "-t $self->{1}" to check if tty
1021 my $fh = popen_rd([qw(git var GIT_PAGER)]);
1022 chomp(my $pager = <$fh> // '');
1023 close($fh) or warn "`git var PAGER' error: \$?=$?";
1024 return if $pager eq 'cat' || $pager eq '';
1025 my $new_env = { LESS => 'FRX', LV => '-c' };
1026 $new_env->{MORE} = 'FRX' if $^O eq 'freebsd';
1027 pipe(my ($r, $wpager)) or return warn "pipe: $!";
1028 my $rdr = { 0 => $r, 1 => $self->{1}, 2 => $self->{2} };
1029 my $pgr = [ undef, @$rdr{1, 2} ];
1030 my $env = $self->{env};
1031 if ($self->{sock}) { # lei(1) process runs it
1032 delete @$new_env{keys %$env}; # only set iff unset
1033 send_exec_cmd($self, [ @$rdr{0..2} ], [$pager], $new_env);
1035 die 'BUG: start_pager w/o socket';
1037 $self->{1} = $wpager;
1038 $self->{2} = $wpager if -t $self->{2};
1039 $env->{GIT_PAGER_IN_USE} = 'true'; # we may spawn git
1040 $self->{pgr} = $pgr;
1045 my $pgr = delete($self->{pgr}) or return;
1046 $self->{2} = $pgr->[2];
1047 # do not restore original stdout, just close it so we error out
1048 close(delete($self->{1})) if $self->{1};
1051 sub accept_dispatch { # Listener {post_accept} callback
1052 my ($sock) = @_; # ignore other
1053 $sock->autoflush(1);
1054 my $self = bless { sock => $sock }, __PACKAGE__;
1055 vec(my $rvec = '', fileno($sock), 1) = 1;
1056 select($rvec, undef, undef, 60) or
1057 return send($sock, 'timed out waiting to recv FDs', MSG_EOR);
1058 # (4096 * 33) >MAX_ARG_STRLEN
1059 my @fds = $recv_cmd->($sock, my $buf, 4096 * 33) or return; # EOF
1060 if (!defined($fds[0])) {
1061 warn(my $msg = "recv_cmd failed: $!");
1062 return send($sock, $msg, MSG_EOR);
1066 open($self->{$i++}, '+<&=', $fd) and next;
1067 send($sock, "open(+<&=$fd) (FD=$i): $!", MSG_EOR);
1069 $i == 4 or return send($sock, 'not enough FDs='.($i-1), MSG_EOR)
1071 # $ENV_STR = join('', map { "\0$_=$ENV{$_}" } keys %ENV);
1072 # $buf = "$argc\0".join("\0", @ARGV).$ENV_STR."\0\0";
1073 substr($buf, -2, 2, '') eq "\0\0" or # s/\0\0\z//
1074 return send($sock, 'request command truncated', MSG_EOR);
1075 my ($argc, @argv) = split(/\0/, $buf, -1);
1077 my %env = map { split(/=/, $_, 2) } splice(@argv, $argc);
1078 if (chdir($self->{3})) {
1080 $self->{env} = \%env;
1081 eval { dispatch($self, @argv) };
1082 send($sock, $@, MSG_EOR) if $@;
1084 send($sock, "fchdir: $!", MSG_EOR); # implicit close
1090 delete $self->{-progress};
1091 _drop_wq($self) if $self->{failed};
1092 close(delete $self->{1}) if $self->{1}; # may reap_compress
1093 $self->close if $self->{-event_init_done}; # PublicInbox::DS::close
1096 # for long-running results
1099 local %ENV = %{$self->{env}};
1100 my $sock = $self->{sock};
1101 local $current_lei = $self;
1103 while (my @fds = $recv_cmd->($sock, my $buf, 4096)) {
1104 if (scalar(@fds) == 1 && !defined($fds[0])) {
1105 return if $! == EAGAIN;
1106 next if $! == EINTR;
1107 last if $! == ECONNRESET;
1111 open my $rfh, '+<&=', $fd;
1113 die "unrecognized client signal: $buf";
1115 _drop_wq($self); # EOF, client disconnected
1119 eval { $self->fail($err) };
1124 sub event_step_init {
1126 my $sock = $self->{sock} or return;
1127 $self->{-event_init_done} //= do { # persist til $ops done
1128 $self->SUPER::new($sock, EPOLLIN|EPOLLET);
1135 sub oldset { $oldset }
1137 sub dump_and_clear_log {
1138 if (defined($errors_log) && -s STDIN && seek(STDIN, 0, SEEK_SET)) {
1140 unshift(@pfx, "$errors_log ") if @pfx;
1141 warn @pfx, do { local $/; <STDIN> };
1142 truncate(STDIN, 0) or warn "ftruncate ($errors_log): $!";
1148 my $lei = bless { env => { %{$cfg->{-env}} } }, __PACKAGE__;
1149 open($lei->{0}, '<&', \*STDIN) or die "dup 0: $!";
1150 open($lei->{1}, '>>&', \*STDOUT) or die "dup 1: $!";
1151 open($lei->{2}, '>>&', \*STDERR) or die "dup 2: $!";
1152 open($lei->{3}, '/') or die "open /: $!";
1153 chdir($lei->{3}) or die "chdir /': $!";
1155 socketpair($x, $y, AF_UNIX, SOCK_SEQPACKET, 0) or die "socketpair: $!";
1157 require PublicInbox::LeiSelfSocket;
1158 PublicInbox::LeiSelfSocket->new($y); # adds to event loop
1162 sub dir_idle_handler ($) { # PublicInbox::DirIdle callback
1163 my ($ev) = @_; # Linux::Inotify2::Event or duck type
1164 my $fn = $ev->fullname;
1165 if ($fn =~ m!\A(.+)/(new|cur)/([^/]+)\z!) { # Maildir file
1166 my ($mdir, $nc, $bn) = ($1, $2, $3);
1167 $nc = '' if $ev->IN_DELETE;
1168 for my $f (keys %{$MDIR2CFGPATH->{$mdir} // {}}) {
1169 my $cfg = $PATH2CFG{$f} // next;
1171 local %ENV = %{$cfg->{-env}};
1172 my $lei = cfg2lei($cfg);
1173 $lei->dispatch('note-event',
1174 "maildir:$mdir", $nc, $bn, $fn);
1176 warn "E note-event $f: $@\n" if $@;
1179 if ($ev->can('cancel') && ($ev->IN_IGNORE || $ev->IN_UNMOUNT)) {
1182 if ($fn =~ m!\A(.+)/(?:new|cur)\z! && !-e $fn) {
1183 delete $MDIR2CFGPATH->{$1};
1185 if (!-e $fn) { # config file or Maildir gone
1186 for my $cfgpaths (values %$MDIR2CFGPATH) {
1187 delete $cfgpaths->{$fn};
1189 delete $PATH2CFG{$fn};
1193 # lei(1) calls this when it can't connect
1195 my ($path, $errno, $narg) = @_;
1196 local ($errors_log, $listener);
1197 my ($sock_dir) = ($path =~ m!\A(.+?)/[^/]+\z!);
1198 $errors_log = "$sock_dir/errors.log";
1199 my $addr = pack_sockaddr_un($path);
1200 my $lk = bless { lock_path => $errors_log }, 'PublicInbox::Lock';
1202 socket($listener, AF_UNIX, SOCK_SEQPACKET, 0) or die "socket: $!";
1203 if ($errno == ECONNREFUSED || $errno == ENOENT) {
1204 return if connect($listener, $addr); # another process won
1205 if ($errno == ECONNREFUSED && -S $path) {
1206 unlink($path) or die "unlink($path): $!";
1209 $! = $errno; # allow interpolation to stringify in die
1210 die "connect($path): $!";
1212 umask(077) // die("umask(077): $!");
1213 bind($listener, $addr) or die "bind($path): $!";
1216 my @st = stat($path) or die "stat($path): $!";
1217 my $dev_ino_expect = pack('dd', $st[0], $st[1]); # dev+ino
1218 local $oldset = PublicInbox::DS::block_signals();
1220 $send_cmd = PublicInbox::Spawn->can('send_cmd4');
1221 $recv_cmd = PublicInbox::Spawn->can('recv_cmd4') // do {
1222 require PublicInbox::CmdIPC4;
1223 $send_cmd = PublicInbox::CmdIPC4->can('send_cmd4');
1224 PublicInbox::CmdIPC4->can('recv_cmd4');
1227 $recv_cmd or die <<"";
1228 (Socket::MsgHdr || Inline::C) missing/unconfigured (narg=$narg);
1230 require PublicInbox::Listener;
1231 require PublicInbox::PktOp;
1232 (-p STDOUT) or die "E: stdout must be a pipe\n";
1233 open(STDIN, '+>>', $errors_log) or die "open($errors_log): $!";
1234 STDIN->autoflush(1);
1235 dump_and_clear_log("from previous daemon process:\n");
1236 POSIX::setsid() > 0 or die "setsid: $!";
1237 my $pid = fork // die "fork: $!";
1239 $0 = "lei-daemon $path";
1241 local $MDIR2CFGPATH;
1242 $listener->blocking(0);
1244 my $pil = PublicInbox::Listener->new($listener, \&accept_dispatch);
1246 my (undef, $eof_p) = PublicInbox::PktOp->pair;
1248 $exit_code //= shift;
1249 my $lis = $pil or exit($exit_code);
1250 # closing eof_p triggers \&noop wakeup
1251 $listener = $eof_p = $pil = $path = undef;
1252 $lis->close; # DS::close
1253 PublicInbox::DS->SetLoopTimeout(1000);
1257 CHLD => \&PublicInbox::DS::enqueue_reap,
1265 my $sigfd = PublicInbox::Sigfd->new($sig, SFD_NONBLOCK);
1266 local @SIG{keys %$sig} = values(%$sig) unless $sigfd;
1268 local $SIG{PIPE} = 'IGNORE';
1269 require PublicInbox::DirIdle;
1270 local $dir_idle = PublicInbox::DirIdle->new([$sock_dir], sub {
1271 # just rely on wakeup to hit PostLoopCallback set below
1272 dir_idle_handler($_[0]) if $_[0]->fullname ne $path;
1275 undef $sigfd; # unref, already in DS::DescriptorMap
1277 # wake up every second to accept signals if we don't
1278 # have signalfd or IO::KQueue:
1279 PublicInbox::DS::sig_setmask($oldset);
1280 PublicInbox::DS->SetLoopTimeout(1000);
1282 PublicInbox::DS->SetPostLoopCallback(sub {
1283 my ($dmap, undef) = @_;
1284 if (@st = defined($path) ? stat($path) : ()) {
1285 if ($dev_ino_expect ne pack('dd', $st[0], $st[1])) {
1286 warn "$path dev/ino changed, quitting\n";
1289 } elsif (defined($path)) { # ENOENT is common
1290 warn "stat($path): $!, quitting ...\n" if $! != ENOENT;
1294 return 1 if defined($path);
1297 for my $s (values %$dmap) {
1298 $s->can('busy') or next;
1299 if ($s->busy($now)) {
1305 $n; # true: continue, false: stop
1308 # STDIN was redirected to /dev/null above, closing STDERR and
1309 # STDOUT will cause the calling `lei' client process to finish
1310 # reading the <$daemon> pipe.
1311 local $SIG{__WARN__} = sub {
1312 $current_lei ? err($current_lei, @_) : warn(
1313 strftime('%Y-%m-%dT%H:%M:%SZ', gmtime(time))," $$ ", @_);
1315 open STDERR, '>&STDIN' or die "redirect stderr failed: $!";
1316 open STDOUT, '>&STDIN' or die "redirect stdout failed: $!";
1317 # $daemon pipe to `lei' closed, main loop begins:
1318 PublicInbox::DS->EventLoop;
1319 exit($exit_code // 0);
1322 sub busy { 1 } # prevent daemon-shutdown if client is connected
1324 # ensures stdout hits the FS before sock disconnects so a client
1325 # can immediately reread it
1328 if (my $counters = delete $self->{counters}) {
1329 for my $k (sort keys %$counters) {
1330 my $nr = $counters->{$k};
1331 $self->child_error(1 << 8, "$nr $k messages");
1334 $self->{1}->autoflush(1) if $self->{1};
1336 # preserve $? for ->fail or ->x_it code
1339 sub wq_done_wait { # dwaitpid callback
1340 my ($arg, $pid) = @_;
1341 my ($wq, $lei) = @$arg;
1342 my $err_type = $lei->{-err_type};
1343 $? and $lei->child_error($?,
1344 $err_type ? "$err_type errors during $lei->{cmd}" : ());
1350 my $dh = $lei->{3} // die 'BUG: lei->{3} (CWD) gone';
1351 chdir($dh) || $lei->fail("fchdir: $!");
1354 sub wq_eof { # EOF callback for main daemon
1356 my $wq1 = delete $lei->{wq1} // return $lei->fail; # already failed
1357 $wq1->wq_wait_old(\&wq_done_wait, $lei);
1360 sub watch_state_ok ($) {
1361 my ($state) = $_[-1]; # $_[0] may be $self
1362 $state =~ /\Apause|(?:import|index|tag)-(?:ro|rw)\z/;
1365 sub cancel_maildir_watch ($$) {
1366 my ($d, $cfg_f) = @_;
1367 my $w = delete $MDIR2CFGPATH->{$d}->{$cfg_f};
1368 scalar(keys %{$MDIR2CFGPATH->{$d}}) or
1369 delete $MDIR2CFGPATH->{$d};
1370 for my $x (@{$w // []}) { $x->cancel }
1373 sub add_maildir_watch ($$) {
1374 my ($d, $cfg_f) = @_;
1375 if (!exists($MDIR2CFGPATH->{$d}->{$cfg_f})) {
1376 my @w = $dir_idle->add_watches(["$d/cur", "$d/new"], 1);
1377 push @{$MDIR2CFGPATH->{$d}->{$cfg_f}}, @w if @w;
1381 sub refresh_watches {
1383 my $cfg = _lei_cfg($lei) or return;
1384 my $old = $cfg->{-watches};
1385 my $watches = $cfg->{-watches} //= {};
1387 my $cfg_f = $cfg->{'-f'};
1388 for my $w (grep(/\Awatch\..+\.state\z/, keys %$cfg)) {
1389 my $url = substr($w, length('watch.'), -length('.state'));
1390 require PublicInbox::LeiWatch;
1391 $watches->{$url} //= PublicInbox::LeiWatch->new($url);
1392 $seen{$url} = undef;
1393 my $state = $cfg->get_1("watch.$url", 'state');
1394 if (!watch_state_ok($state)) {
1395 $lei->err("watch.$url.state=$state not supported");
1398 if ($url =~ /\Amaildir:(.+)/i) {
1399 my $d = canonpath_harder($1);
1400 if ($state eq 'pause') {
1401 cancel_maildir_watch($d, $cfg_f);
1403 add_maildir_watch($d, $cfg_f);
1405 } else { # TODO: imap/nntp/jmap
1406 $lei->child_error(1, "E: watch $url not supported, yet")
1410 # add all known Maildir folders as implicit watches
1411 my $sto = $lei->_lei_store;
1413 if (my $lms = $sto ? $sto->search->lms : undef) {
1414 for my $d ($lms->folders('maildir:')) {
1415 substr($d, 0, length('maildir:')) = '';
1416 my $cd = canonpath_harder($d);
1417 my $f = "maildir:$cd";
1419 # fixup old bugs while we're iterating:
1421 $sto->ipc_do('lms_rename_folder',
1425 next if $watches->{$f}; # may be set to pause
1426 $watches->{$f} = PublicInbox::LeiWatch->new($f);
1428 add_maildir_watch($cd, $cfg_f);
1431 my $wait = $renames ? $sto->ipc_do('done') : undef;
1432 if ($old) { # cull old non-existent entries
1433 for my $url (keys %$old) {
1434 next if exists $seen{$url};
1435 delete $old->{$url};
1436 if ($url =~ /\Amaildir:(.+)/i) {
1437 my $d = canonpath_harder($1);
1438 cancel_maildir_watch($d, $cfg_f);
1439 } else { # TODO: imap/nntp/jmap
1440 $lei->child_error(1, "E: watch $url TODO");
1444 if (scalar keys %$watches) {
1445 $cfg->{-env} //= { %{$lei->{env}}, PWD => '/' }; # for cfg2lei
1447 delete $cfg->{-watches};
1452 my ($lei, $eml) = @_;
1453 ($lei->{sto} // _lei_store($lei, 1))->git_blob_id($eml);
1456 sub lms { # read-only LeiMailSync
1458 my $lse = $lei->{lse} // do {
1459 my $sto = $lei->{sto} // _lei_store($lei);
1460 $sto ? $sto->search : undef
1462 $lse ? $lse->lms : undef;