1 # Copyright (C) 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;
10 use parent qw(PublicInbox::DS PublicInbox::LeiExternal
11 PublicInbox::LeiQuery);
13 use Socket qw(AF_UNIX SOCK_SEQPACKET MSG_EOR pack_sockaddr_un);
14 use Errno qw(EPIPE EAGAIN ECONNREFUSED ENOENT ECONNRESET);
16 use POSIX qw(strftime);
18 use Fcntl qw(SEEK_SET);
19 use PublicInbox::Config;
20 use PublicInbox::Syscall qw(EPOLLIN);
21 use PublicInbox::Spawn qw(spawn popen_rd);
22 use PublicInbox::Lock;
24 use PublicInbox::Import;
25 use PublicInbox::ContentHash qw(git_sha);
26 use Time::HiRes qw(stat); # ctime comparisons for config cache
27 use File::Path qw(mkpath);
29 use Sys::Syslog qw(openlog syslog closelog);
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};
79 if (my @st_pwd = stat($pwd)) {
80 my @st_cwd = stat($self->{3}) or die "stat({3}): $!";
81 "@st_pwd[1,0]" eq "@st_cwd[1,0]" or
82 $self->{env}->{PWD} = $pwd = undef;
83 } else { # PWD was invalid
84 $self->{env}->{PWD} = $pwd = undef;
87 $pwd //= $self->{env}->{PWD} = getcwd() // die "getcwd: $!";
88 File::Spec->rel2abs($p, $pwd);
91 # abs_path resolves symlinks in parent iff all parents exist
92 sub abs_path { Cwd::abs_path($_[1]) // rel2abs(@_) }
94 sub canonpath_harder {
95 my $p = $_[-1]; # $_[0] may be self
96 $p = File::Spec->canonpath($p);
97 $p =~ m!(?:/*|\A)\.\.(?:/*|\z)! && -e $p ? Cwd::abs_path($p) : $p;
100 sub share_path ($) { # $HOME/.local/share/lei/$FOO
102 rel2abs($self, ($self->{env}->{XDG_DATA_HOME} //
103 ($self->{env}->{HOME} // '/nonexistent').'/.local/share')
107 sub store_path ($) { share_path($_[0]) . '/store' }
109 sub _config_path ($) {
111 rel2abs($self, ($self->{env}->{XDG_CONFIG_HOME} //
112 ($self->{env}->{HOME} // '/nonexistent').'/.config')
118 rel2abs($self, ($self->{env}->{XDG_CACHE_HOME} //
119 ($self->{env}->{HOME} // '/nonexistent').'/.cache')
123 sub url_folder_cache {
125 require PublicInbox::SharedKV; # URI => updated_at_sec_
126 PublicInbox::SharedKV->new(cache_dir($self).'/uri_folder');
132 require PublicInbox::LeiALE;
133 my $cfg = $self->_lei_cfg(1);
134 $self->{ale} = $cfg->{ale} //= PublicInbox::LeiALE->new($self);
139 # TODO: drop underscore variants everywhere, they're undocumented
140 qw(fsync|sync! jobs|j=i indexlevel|L=s compact
141 max_size|max-size=s sequential-shard
142 batch_size|batch-size=s skip-docdata)
145 my @c_opt = qw(c=s@ C=s@ quiet|q);
146 my @net_opt = (qw(no-torsocks torsocks=s), PublicInbox::LeiQuery::curl_opt());
147 my @lxs_opt = qw(remote! local! external! include|I=s@ exclude=s@ only|O=s@
150 # we don't support -C as an alias for --find-copies since it's already
152 our @diff_opt = qw(unified|U=i output-indicator-new=s output-indicator-old=s
153 output-indicator-context=s indent-heuristic!
154 minimal patience histogram anchored=s@ diff-algorithm=s
155 color-moved:s color-moved-ws=s no-color-moved no-color-moved-ws
156 word-diff:s word-diff-regex=s color-words:s no-renames
157 rename-empty! check ws-error-highlight=s full-index binary
158 abbrev:i break-rewrites|B:s find-renames|M:s find-copies:s
159 find-copies-harder irreversible-delete|D l=i diff-filter=s
160 S=s G=s find-object=s pickaxe-all pickaxe-regex O=s R
161 relative:s text|a ignore-cr-at-eol ignore-space-at-eol
162 ignore-space-change|b ignore-all-space|w ignore-blank-lines
163 inter-hunk-context=i function-context|W exit-code ext-diff
164 no-ext-diff textconv! src-prefix=s dst-prefix=s no-prefix
167 # we generate shell completion + help using %CMD and %OPTDESC,
168 # see lei__complete() and PublicInbox::LeiHelp
169 # command => [ positional_args, 1-line description, Getopt::Long option spec ]
170 our %CMD = ( # sorted in order of importance/use:
171 'q' => [ '--stdin|SEARCH_TERMS...', 'search for messages matching terms',
172 'stdin|', # /|\z/ must be first for lone dash
174 qw(save! output|mfolder|o=s format|f=s dedupe|d=s threads|t+
175 sort|s=s reverse|r offset=i pretty jobs|j=s globoff|g augment|a
176 import-before! lock=s@ rsyncable alert=s@ mua=s verbose|v+
177 shared color! mail-sync!), @c_opt, opt_dash('limit|n=i', '[0-9]+') ],
179 'up' => [ 'OUTPUT...|--all', 'update saved search',
180 qw(jobs|j=s lock=s@ alert=s@ mua=s verbose|v+ exclude=s@
181 remote-fudge-time=s all:s remote! local! external!), @net_opt, @c_opt ],
183 'lcat' => [ '--stdin|MSGID_OR_URL...', 'display local copy of message(s)',
184 'stdin|', # /|\z/ must be first for lone dash
185 # some of these options are ridiculous for lcat
187 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),
194 @lxs_opt, @net_opt, @c_opt ],
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 drq:1 dequote-only:1),
200 @diff_opt, @lxs_opt, @net_opt, @c_opt ],
202 'mail-diff' => [ '--stdin|LOCATION...', 'diff the contents of emails',
203 'stdin|', # /|\z/ must be first for lone dash
204 qw(verbose|v+ in-format|F=s color:s no-color raw-header),
205 @diff_opt, @net_opt, @c_opt ],
207 'add-external' => [ 'LOCATION',
208 'add/set priority of a publicinbox|extindex for extra matches',
209 qw(boost=i mirror=s inbox-version=i epoch=s verbose|v+),
210 @c_opt, index_opt(), @net_opt ],
211 'ls-external' => [ '[FILTER]', 'list publicinbox|extindex locations',
212 qw(format|f=s z|0 globoff|g invert-match|v local remote), @c_opt ],
213 'ls-label' => [ '', 'list labels', qw(z|0 stats:s), @c_opt ],
214 'ls-mail-sync' => [ '[FILTER]', 'list mail sync folders',
215 qw(z|0 globoff|g invert-match|v local remote), @c_opt ],
216 'ls-mail-source' => [ 'URL', 'list IMAP or NNTP mail source folders',
217 qw(z|0 ascii l pretty url), @net_opt, @c_opt ],
218 'forget-external' => [ 'LOCATION...|--prune',
219 'exclude further results from a publicinbox|extindex',
222 'ls-search' => [ '[PREFIX]', 'list saved search queries',
223 qw(format|f=s pretty l ascii z|0), @c_opt ],
224 'forget-search' => [ 'OUTPUT...|--prune', 'forget a saved search',
225 qw(verbose|v+ prune:s), @c_opt ],
226 'edit-search' => [ 'OUTPUT', "edit saved search via `git config --edit'",
228 'rm' => [ '--stdin|LOCATION...',
229 'remove a message from the index and prevent reindexing',
230 'stdin|', # /|\z/ must be first for lone dash
231 qw(in-format|F=s lock=s@), @net_opt, @c_opt ],
232 'plonk' => [ '--threads|--from=IDENT',
233 'exclude mail matching From: or threads from non-Message-ID searches',
234 qw(stdin| threads|t from|f=s mid=s oid=s), @c_opt ],
235 'tag' => [ 'KEYWORDS...',
236 'set/unset keywords and/or labels on message(s)',
237 qw(stdin| in-format|F=s input|i=s@ oid=s@ mid=s@),
238 @net_opt, @c_opt, pass_through('-kw:foo for delete') ],
240 'purge-mailsource' => [ 'LOCATION|--all',
241 'remove imported messages from IMAP, Maildirs, and MH',
242 qw(exact! all jobs:i indexed), @c_opt ],
244 'add-watch' => [ 'LOCATION...', 'watch for new messages and flag changes',
245 qw(poll-interval=s state=s recursive|r), @c_opt ],
246 'rm-watch' => [ 'LOCATION...', 'remove specified watch(es)',
247 qw(recursive|r), @c_opt ],
248 'ls-watch' => [ '[FILTER...]', 'list active watches with numbers and status',
250 'pause-watch' => [ '[WATCH_NUMBER_OR_FILTER]', qw(all local remote), @c_opt ],
251 'resume-watch' => [ '[WATCH_NUMBER_OR_FILTER]', qw(all local remote), @c_opt ],
252 'forget-watch' => [ '{WATCH_NUMBER|--prune}', 'stop and forget a watch',
255 'reindex' => [ '', 'reindex all locally-indexed messages', @c_opt ],
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=
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!),
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',
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!),
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 ],
288 'init' => [ '[DIRNAME]', sub {
289 "initialize storage, default: ".store_path($_[0]);
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' ],
298 #'reorder-local-store-and-break-history' => [ '[REFNAME]',
299 # 'rewrite git history in an attempt to improve compression',
301 #'fuse-mount' => [ 'PATHNAME', 'expose lei/store as Maildir(s)', @c_opt ],
303 # internal commands are prefixed with '_'
304 '_complete' => [ '[...]', 'internal shell completion helper',
305 pass_through('everything') ],
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' ];
317 # we use \x{a0} (non-breaking SP) to avoid wrapping in PublicInbox::LeiHelp
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)' ],
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',
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',
349 'type=s' => [ 'any|mid|git', 'disambiguate type' ],
351 'dedupe|d=s' => ['STRATEGY|content|oid|mid|none',
352 'deduplication strategy'],
354 'return all messages in the same threads as the actual match(es)',
356 'want|w=s@' => [ 'PREFIX|dfpost|dfn', # common ones in help...
357 'search prefixes to extract (default: dfpost7)' ],
358 'uri p2q' => [ 'URI escape output' ],
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)' ],
365 'augment|a' => 'augment --output destination instead of clobbering',
367 'output|mfolder|o=s' => [ 'MFOLDER',
368 "destination (e.g.\xa0`/path/to/Maildir', ".
369 "or\xa0`-'\x{a0}for\x{a0}stdout)" ],
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',
374 'inbox-version=i' => [ 'NUM|1|2',
375 'force a public-inbox version with --mirror'],
376 'mirror=s' => [ 'URL', 'mirror a public-inbox'],
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',
390 'drop compatibility w/ public-inbox <1.6 to save ~1.5% space',
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|j=s' => [ 'JOBSPEC',
402 'control number of query and writer jobs' .
403 "integers delimited by `,', either of which may be omitted"
405 'jobs|j=i add-external' => 'set parallelism when indexing after --mirror',
407 'in-format|F=s' => $stdin_formats,
408 'format|f=s ls-search' => ['OUT|json|jsonl|concatjson',
409 'listing output format' ],
410 'l ls-search' => 'long listing format',
411 'l ls-watch' => 'long listing format',
412 'l ls-mail-source' => 'long listing format',
413 'url ls-mail-source' => 'show full URL of newsgroup or IMAP folder',
414 'format|f=s ls-external' => $ls_format,
416 'prune:s forget-search' =>
417 ['TYPE|local|remote', 'prune all, remote or local folders' ],
419 'limit|n=i@' => ['NUM', 'limit on number of matches (default: 10000)' ],
420 'offset=i' => ['OFF', 'search result offset (default: 0)'],
422 'sort|s=s' => [ 'VAL|received|relevance|docid',
423 "order of results is `--output'-dependent"],
424 'reverse|r' => 'reverse search results', # like sort(1)
426 'boost=i' => 'increase/decrease priority of results (default: 0)',
428 'local' => 'limit operations to the local filesystem',
429 'local!' => 'exclude results from the local filesystem',
430 'remote' => 'limit operations to those requiring network access',
431 'remote!' => 'prevent operations requiring network access',
433 # up, refresh-mail-sync, export-kw
434 'all:s' => ['TYPE|local|remote', 'all remote or local folders' ],
436 'remote-fudge-time=s' => [ 'INTERVAL',
437 'look for mail INTERVAL older than the last successful query' ],
439 'mid=s' => 'specify the Message-ID of a message',
440 'oid=s' => 'specify the git object ID of a message',
442 'recursive|r' => 'scan directories/mailboxes/newsgroups recursively',
443 'exclude=s' => 'exclude mailboxes/newsgroups based on pattern',
444 'include=s' => 'include mailboxes/newsgroups based on pattern',
446 'exact' => 'operate on exact header matches only',
447 'exact!' => 'rely on content match instead of exact header matches',
449 'by-mid|mid:s' => [ 'MID', 'match only by Message-ID, ignoring contents' ],
451 'kw!' => 'disable/enable importing keywords (aka "flags")',
453 # xargs, env, use "-0", git(1) uses "-z". We support z|0 everywhere
454 'z|0' => 'use NUL \\0 instead of newline (CR) to delimit lines',
456 'signal|s=s' => [ 'SIG', 'signal to send lei-daemon (default: TERM)' ],
460 'leistore.dir' => 'top-level storage location',
463 my @WQ_KEYS = qw(lxs l2m ikw pmd wq1 lne v2w); # internal workers
467 for my $wq (grep(defined, delete(@$self{@WQ_KEYS}))) {
468 $wq->wq_kill('-TERM');
473 # pronounced "exit": x_it(1 << 8) => exit(1); x_it(13) => SIGPIPE
475 my ($self, $code) = @_;
476 local $current_lei = $self;
477 # make sure client sees stdout before exit
478 $self->{1}->autoflush(1) if $self->{1};
480 if ($self->{pkt_op_p}) { # worker => lei-daemon
481 $self->{pkt_op_p}->pkt_do('x_it', $code);
482 } elsif ($self->{sock}) { # lei->daemon => lei(1) client
483 send($self->{sock}, "x_it $code", MSG_EOR);
484 } elsif ($quit == \&CORE::exit) { # an admin (one-shot) command
486 } # else ignore if client disconnected
491 my $err = $self->{2} // ($self->{pgr} // [])->[2] // *STDERR{GLOB};
492 my @eor = (substr($_[-1]//'', -1, 1) eq "\n" ? () : ("\n"));
493 print $err @_, @eor and return;
494 my $old_err = delete $self->{2};
495 close($old_err) if $! == EPIPE && $old_err;
496 $err = $self->{2} = ($self->{pgr} // [])->[2] // *STDERR{GLOB};
497 print $err @_, @eor or print STDERR @_, @eor;
500 sub qerr ($;@) { $_[0]->{opt}->{quiet} or err(shift, @_) }
502 sub qfin { # show message on finalization (LeiFinmsg)
503 my ($lei, $msg) = @_;
504 return if $lei->{opt}->{quiet};
505 $lei->{fmsg} ? push(@{$lei->{fmsg}}, "$msg\n") : qerr($lei, $msg);
508 sub fail_handler ($;$$) {
509 my ($lei, $code, $io) = @_;
510 local $current_lei = $lei;
511 close($io) if $io; # needed to avoid warnings on SIGPIPE
513 x_it($lei, $code // (1 << 8));
516 sub sigpipe_handler { # handles SIGPIPE from @WQ_KEYS workers
517 fail_handler($_[0], 13, delete $_[0]->{1});
521 my ($self, $msg, $exit_code) = @_;
522 local $current_lei = $self;
524 warn(substr($msg, -1, 1) eq "\n" ? $msg : "$msg\n") if defined $msg;
525 $self->{pkt_op_p}->pkt_do('fail_handler') if $self->{pkt_op_p};
526 x_it($self, ($exit_code // 1) << 8);
532 return if print { $self->{1} // return } @_; # likely
533 return note_sigpipe($self, 1) if $! == EPIPE;
534 my $err = "error writing to output: $!";
539 sub puts ($;@) { out(shift, map { "$_\n" } @_) }
541 sub child_error { # passes non-fatal curl exit codes to user
542 my ($self, $child_error, $msg) = @_; # child_error is $?
543 local $current_lei = $self;
544 $child_error ||= 1 << 8;
545 warn(substr($msg, -1, 1) eq "\n" ? $msg : "$msg\n") if defined $msg;
546 $self->{child_error} ||= $child_error;
547 if ($self->{pkt_op_p}) { # to top lei-daemon
548 $self->{pkt_op_p}->pkt_do('child_error', $child_error);
549 } elsif ($self->{sock}) { # to lei(1) client
550 send($self->{sock}, "child_error $child_error", MSG_EOR);
551 } # else noop if client disconnected
554 sub note_sigpipe { # triggers sigpipe_handler
555 my ($self, $fd) = @_;
556 close(delete($self->{$fd})); # explicit close silences Perl warning
557 $self->{pkt_op_p}->pkt_do('sigpipe_handler') if $self->{pkt_op_p};
561 sub _lei_atfork_child {
562 my ($self, $persist) = @_;
563 # we need to explicitly close things which are on stack
564 my $cfg = $self->{cfg};
566 open $self->{3}, '<', '/' or die "open(/) $!";
568 close($_) for (grep(defined, delete @$self{qw(0 1 2 sock)}));
569 delete @$cfg{qw(-lei_store -watches -lei_note_event)};
570 } else { # worker, Net::NNTP (Net::Cmd) uses STDERR directly
571 open STDERR, '+>&='.fileno($self->{2}) or warn "open $!";
572 STDERR->autoflush(1);
573 POSIX::setpgid(0, $$) // die "setpgid(0, $$): $!";
574 delete @$cfg{qw(-watches -lei_note_event)};
576 close($_) for (grep(defined, delete @$self{qw(old_1 au_done)}));
577 delete $self->{-socks};
578 if (my $op_c = delete $self->{pkt_op_c}) {
579 close(delete $op_c->{sock});
581 if (my $pgr = delete $self->{pgr}) {
582 close($_) for (@$pgr[1,2]);
584 close $listener if $listener;
586 $dir_idle->force_close if $dir_idle;
590 eval 'no warnings; undef $PublicInbox::LeiNoteEvent::to_flush';
592 $quit = \&CORE::exit;
593 if (!$self->{-eml_noisy}) { # only "lei import" sets this atm
594 my $cb = $SIG{__WARN__} // \&CORE::warn;
595 $SIG{__WARN__} = sub {
596 $cb->(@_) unless PublicInbox::Eml::warn_ignore(@_)
599 $SIG{TERM} = sub { exit(128 + 15) };
600 $current_lei = $persist ? undef : $self; # for SIG{__WARN__}
603 sub _delete_pkt_op { # OnDestroy callback to prevent leaks on die
605 if (my $op = delete $self->{pkt_op_c}) { # in case of die
606 $op->close; # PublicInbox::PktOp::close
608 my $pkt_op_p = delete($self->{pkt_op_p}) or return;
609 close $pkt_op_p->{op_p};
614 require PublicInbox::OnDestroy;
615 require PublicInbox::PktOp;
616 my $end = PublicInbox::OnDestroy->new($$, \&_delete_pkt_op, $self);
617 @$self{qw(pkt_op_c pkt_op_p)} = PublicInbox::PktOp->pair;
622 my ($self, $field, $nr) = @_;
623 $self->{counters}->{$field} += $nr;
627 my ($lei, $ops) = @_;
628 $ops->{fail_handler} = [ $lei ];
629 $ops->{sigpipe_handler} = [ $lei ];
630 $ops->{x_it} = [ $lei ];
631 $ops->{child_error} = [ $lei ];
632 $ops->{incr} = [ $lei ];
637 my ($lei, $wq, $jobs, $ops, $flds) = @_;
639 ($wq->can('net_merge_all_done') && $lei->{auth}) and
640 $lei->{auth}->op_merge($ops, $wq, $lei);
642 $ops->{''} //= [ $wq->can('_lei_wq_eof') || \&wq_eof, $lei ];
643 my $end = $lei->pkt_op_pair;
644 my $ident = $wq->{-wq_ident} // "lei-$lei->{cmd} worker";
646 $wq->wq_workers_start($ident, $jobs, $lei->oldset, $flds,
647 $wq->can('_wq_done_wait') // \&wq_done_wait, $lei);
648 delete $lei->{pkt_op_p};
649 my $op_c = delete $lei->{pkt_op_c};
651 $lei->event_step_init;
655 # call this when we're ready to wait on events and yield to other clients
657 my ($lei, $op_c, $ops) = @_;
658 my $wq1 = $lei->{wq1};
659 ($wq1 && $wq1->can('net_merge_all_done') && !$lei->{auth}) and
660 $wq1->net_merge_all_done;
661 for my $wq (grep(defined, @$lei{qw(ikw pmd)})) { # auxiliary WQs
664 $wq1->{lei_sock} = $lei->{sock} if $wq1;
669 my ($lei, $wq, $jobs) = @_;
670 my ($op_c, $ops) = workers_start($lei, $wq, $jobs // 1);
672 wait_wq_events($lei, $op_c, $ops); # net_merge_all_done if !{auth}
676 require PublicInbox::LeiHelp;
677 PublicInbox::LeiHelp::call($_[0], $_[1], \%CMD, \%OPTDESC);
681 my ($self, $cmd, $argv) = @_;
682 # allow _complete --help to complete, not show help
683 return 1 if substr($cmd, 0, 1) eq '_';
685 $OPT = $self->{opt} //= {};
686 my $info = $CMD{$cmd} // [ '[...]' ];
687 my ($proto, undef, @spec) = @$info;
688 my $glp = ref($spec[-1]) eq ref($GLP) ? pop(@spec) : $GLP;
689 push @spec, qw(help|h);
691 if ($spec[0] =~ s/\|\z//s) { # "stdin|" or "clear|" allows "-" alias
692 $lone_dash = $spec[0];
693 $OPT->{$spec[0]} = \(my $var);
694 push @spec, '' => \$var;
696 $glp->getoptionsfromarray($argv, $OPT, @spec) or
697 return _help($self, "bad arguments or options for $cmd");
698 return _help($self) if $OPT->{help};
700 push @$argv, @{$OPT->{-argv}} if defined($OPT->{-argv});
702 # "-" aliases "stdin" or "clear"
703 $OPT->{$lone_dash} = ${$OPT->{$lone_dash}} if defined $lone_dash;
706 my $POS_ARG = '[A-Z][A-Z0-9_]+';
708 my @args = split(/ /, $proto);
709 for my $var (@args) {
710 if ($var =~ /\A$POS_ARG\.\.\.\z/o) { # >= 1 args;
711 $inf = defined($argv->[$i]) and last;
712 $var =~ s/\.\.\.\z//;
713 $err = "$var not supplied";
714 } elsif ($var =~ /\A$POS_ARG\z/o) { # required arg at $i
715 $argv->[$i++] // ($err = "$var not supplied");
716 } elsif ($var =~ /\.\.\.\]\z/) { # optional args start
719 } elsif ($var =~ /\A\[-?$POS_ARG\]\z/) { # one optional arg
721 } elsif ($var =~ /\A.+?\|/) { # required FOO|--stdin
722 $inf = 1 if index($var, '...') > 0;
723 my @or = split(/\|/, $var);
726 if ($o =~ /\A--([a-z0-9\-]+)/) {
728 # assume pipe/regular file on stdin
729 # w/o args means stdin
730 if ($sw eq 'stdin' && !@$argv &&
735 $ok = defined($OPT->{$sw});
737 } elsif (defined($argv->[$i])) {
741 } # else continue looping
745 $err = join(', ', @or) . " or $last must be set";
747 warn "BUG: can't parse `$var' in $proto";
751 if (!$inf && scalar(@$argv) > scalar(@args)) {
752 $err //= 'too many arguments';
754 $err ? fail($self, "usage: lei $cmd $proto\nE: $err") : 1;
757 sub _tmp_cfg { # for lei -c <name>=<value> ...
759 my $cfg = _lei_cfg($self, 1);
761 my $ft = File::Temp->new(TEMPLATE => 'lei_cfg-XXXX', TMPDIR => 1);
762 my $tmp = { '-f' => $ft->filename, -tmp => $ft };
764 print $ft <<EOM or return fail($self, "$tmp->{-f}: $!");
768 $tmp = $self->{cfg} = bless { %$cfg, %$tmp }, ref($cfg);
769 for (@{$self->{opt}->{c}}) {
770 /\A([^=\.]+\.[^=]+)(?:=(.*))?\z/ or return fail($self, <<EOM);
771 `-c $_' is not of the form -c <name>=<value>'
775 _config($self, '--add', $name, $value);
776 if (defined(my $v = $tmp->{$name})) {
777 if (ref($v) eq 'ARRAY') {
780 $tmp->{$name} = [ $v, $value ];
783 $tmp->{$name} = $value;
788 sub lazy_cb ($$$) { # $pfx is _complete_ or lei_
789 my ($self, $cmd, $pfx) = @_;
793 $cb = $self->can($pfx.$ucmd) and return $cb;
795 $base =~ s/_([a-z])/\u$1/g;
796 my $pkg = "PublicInbox::Lei\u$base";
797 ($INC{"PublicInbox/Lei\u$base.pm"} // eval("require $pkg")) ?
798 $pkg->can($pfx.$ucmd) : undef;
802 my ($self, $cmd, @argv) = @_;
804 local %ENV = %{$self->{env}};
805 local $current_lei = $self; # for __WARN__
806 $self->{2}->autoflush(1); # keep stdout buffered until x_it|DESTROY
807 return _help($self, 'no command given') unless defined($cmd);
808 # do not support Getopt bundling for this
809 while ($cmd eq '-C' || $cmd eq '-c') {
810 my $v = shift(@argv) // return fail($self, $cmd eq '-C' ?
811 '-C DIRECTORY' : '-c <name>=<value>');
812 push @{$self->{opt}->{substr($cmd, 1, 1)}}, $v;
813 $cmd = shift(@argv) // return _help($self, 'no command given');
815 if (my $cb = lazy_cb(__PACKAGE__, $cmd, 'lei_')) {
816 optparse($self, $cmd, \@argv) or return;
817 $self->{opt}->{c} and (_tmp_cfg($self) // return);
818 if (my $chdir = $self->{opt}->{C}) {
819 for my $d (@$chdir) {
820 next if $d eq ''; # same as git(1)
821 chdir $d or return fail($self, "cd $d: $!");
823 open $self->{3}, '<', '.' or
824 return fail($self, "open . $!");
827 } elsif (grep(/\A-/, $cmd, @argv)) { # --help or -h only
828 $GLP->getoptionsfromarray([$cmd, @argv], {}, qw(help|h C=s@))
829 or return _help($self, 'bad arguments or options');
832 fail($self, "`$cmd' is not an lei command");
837 my ($self, $creat) = @_;
838 return $self->{cfg} if $self->{cfg};
839 my $f = _config_path($self);
841 my $cur_st = @st ? pack('dd', $st[10], $st[7]) : ''; # 10:ctime, 7:size
842 my ($sto, $sto_dir, $watches, $lne);
843 if (my $cfg = $PATH2CFG{$f}) { # reuse existing object in common case
844 return ($self->{cfg} = $cfg) if $cur_st eq $cfg->{-st};
845 ($sto, $sto_dir, $watches, $lne) =
846 @$cfg{qw(-lei_store leistore.dir -watches
852 return bless {}, 'PublicInbox::Config';
854 my ($cfg_dir) = ($f =~ m!(.*?/)[^/]+\z!);
855 -d $cfg_dir or mkpath($cfg_dir) or die "mkpath($cfg_dir): $!\n";
856 open my $fh, '>>', $f or die "open($f): $!\n";
857 @st = stat($fh) or die "fstat($f): $!\n";
858 $cur_st = pack('dd', $st[10], $st[7]);
859 qerr($self, "# $f created") if $self->{cmd} ne 'config';
861 my $cfg = PublicInbox::Config->git_config_dump($f, $self->{2});
862 $cfg->{-st} = $cur_st;
864 if ($sto && canonpath_harder($sto_dir // store_path($self))
865 eq canonpath_harder($cfg->{'leistore.dir'} //
866 store_path($self))) {
867 $cfg->{-lei_store} = $sto;
868 $cfg->{-lei_note_event} = $lne;
869 $cfg->{-watches} = $watches if $watches;
871 if (scalar(keys %PATH2CFG) > 5) {
872 # FIXME: use inotify/EVFILT_VNODE to detect unlinked configs
873 delete(@PATH2CFG{grep(!-f, keys %PATH2CFG)});
875 $self->{cfg} = $PATH2CFG{$f} = $cfg;
876 refresh_watches($self);
880 sub _lei_store ($;$) {
881 my ($self, $creat) = @_;
882 my $cfg = _lei_cfg($self, $creat) // return;
883 $cfg->{-lei_store} //= do {
884 require PublicInbox::LeiStore;
885 my $dir = $cfg->{'leistore.dir'} // store_path($self);
886 return unless $creat || -d $dir;
887 PublicInbox::LeiStore->new($dir, { creat => $creat });
892 my ($self, @argv) = @_;
893 my %env = (%{$self->{env}}, GIT_CONFIG => undef);
894 my $cfg = _lei_cfg($self, 1);
895 my $cmd = [ qw(git config -f), $cfg->{'-f'}, @argv ];
896 my %rdr = map { $_ => $self->{$_} } (0..2);
897 waitpid(spawn($cmd, \%env, \%rdr), 0);
900 sub lei_daemon_pid { puts shift, $$ }
902 sub lei_daemon_kill {
904 my $sig = $self->{opt}->{signal} // 'TERM';
905 kill($sig, $$) or fail($self, "kill($sig, $$): $!");
908 # Shell completion helper. Used by lei-completion.bash and hopefully
909 # other shells. Try to do as much here as possible to avoid redundancy
910 # and improve maintainability.
912 my ($self, @argv) = @_; # argv = qw(lei and any other args...)
913 shift @argv; # ignore "lei", the entire command is sent
914 @argv or return puts $self, grep(!/^_/, keys %CMD), qw(--help -h -C);
915 my $cmd = shift @argv;
916 my $info = $CMD{$cmd} // do { # filter matching commands
917 @argv or puts $self, grep(/\A\Q$cmd\E/, keys %CMD);
920 my ($proto, undef, @spec) = @$info;
922 my $re = defined($cur) ? qr/\A\Q$cur\E/ : qr/./;
923 if (substr(my $_cur = $cur // '-', 0, 1) eq '-') { # --switches
924 # gross special case since the only git-config options
925 # Consider moving to a table if we need more special cases
926 # we use Getopt::Long for are the ones we reject, so these
927 # are the ones we don't reject:
928 if ($cmd eq 'config') {
929 puts $self, grep(/$re/, keys %CONFIG_KEYS);
930 @spec = qw(add z|null get get-all unset unset-all
931 replace-all get-urlmatch
932 remove-section rename-section
933 name-only list|l edit|e
934 get-color-name get-colorbool);
937 # generate short/long names from Getopt::Long specs
938 puts $self, grep(/$re/, qw(--help -h -C), map {
939 if (s/[:=].+\z//) { # req/optional args, e.g output|o=i
940 } elsif (s/\+\z//) { # verbose|v+
942 # negation: mail! => no-mail|mail
943 s/([\w\-]+)/$1|no-$1/g
946 my $x = length > 1 ? "--$_" : "-$_";
947 $x eq $_cur ? () : $x;
948 } grep(!/_/, split(/\|/, $_, -1)) # help|h
949 } grep { $OPTDESC{"$_\t$cmd"} || $OPTDESC{$_} } @spec);
950 } elsif ($cmd eq 'config' && !@argv && !$CONFIG_KEYS{$cur}) {
951 puts $self, grep(/$re/, keys %CONFIG_KEYS);
954 # switch args (e.g. lei q -f mbox<TAB>)
955 if (($argv[-1] // $cur // '') =~ /\A--?([\w\-]+)\z/) {
956 my $opt = quotemeta $1;
958 my $v = $OPTDESC{$_};
959 my @v = ref($v) ? split(/\|/, $v->[0]) : ();
960 # get rid of ALL CAPS placeholder (e.g "OUT")
961 # (TODO: completion for external paths)
962 shift(@v) if scalar(@v) && uc($v[0]) eq $v[0];
964 } grep(/\A(?:[\w-]+\|)*$opt\b.*?(?:\t$cmd)?\z/, keys %OPTDESC);
966 if (my $cb = lazy_cb($self, $cmd, '_complete_')) {
967 puts $self, $cb->($self, @argv, $cur ? ($cur) : ());
969 # TODO: URLs, pathnames, OIDs, MIDs, etc... See optparse() for
974 my ($argv, $env) = @_;
975 my $argc = scalar @$argv;
976 my $buf = 'exec '.join("\0", scalar(@$argv), @$argv);
977 while (my ($k, $v) = each %$env) { $buf .= "\0$k=$v" };
983 if ($self->{ovv}->{fmt} =~ /\A(?:maildir)\z/) { # TODO: IMAP
984 refresh_watches($self);
986 my $mua = $self->{opt}->{mua} // return;
987 my $mfolder = $self->{ovv}->{dst};
988 my (@cmd, $replaced);
989 if ($mua =~ /\A(?:mutt|mailx|mail|neomutt)\z/) {
991 # TODO: help wanted: other common FOSS MUAs
993 require Text::ParseWords;
994 @cmd = Text::ParseWords::shellwords($mua);
995 # mutt uses '%f' for open-hook with compressed mbox, we follow
996 @cmd = map { $_ eq '%f' ? ($replaced = $mfolder) : $_ } @cmd;
998 push @cmd, $mfolder unless defined($replaced);
999 if ($self->{sock}) { # lei(1) client process runs it
1000 # restore terminal: echo $query | lei q --stdin --mua=...
1002 $io->[0] = $self->{1} if $self->{opt}->{stdin} && -t $self->{1};
1003 send_exec_cmd($self, $io, \@cmd, {});
1005 if ($self->{lxs} && $self->{au_done}) { # kick wait_startq
1006 syswrite($self->{au_done}, 'q' x ($self->{lxs}->{jobs} // 0));
1008 return unless -t $self->{2}; # XXX how to determine non-TUI MUAs?
1009 $self->{opt}->{quiet} = 1;
1010 delete $self->{-progress};
1011 delete $self->{opt}->{verbose};
1014 sub send_exec_cmd { # tell script/lei to execute a command
1015 my ($self, $io, $cmd, $env) = @_;
1016 my $sock = $self->{sock} // die 'lei client gone';
1017 my $fds = [ map { fileno($_) } @$io ];
1018 $send_cmd->($sock, $fds, exec_buf($cmd, $env), MSG_EOR);
1021 sub poke_mua { # forces terminal MUAs to wake up and hopefully notice new mail
1023 my $alerts = $self->{opt}->{alert} // return;
1024 my $sock = $self->{sock};
1025 while (my $op = shift(@$alerts)) {
1026 if ($op eq ':WINCH') {
1027 # hit the process group that started the MUA
1028 send($sock, '-WINCH', MSG_EOR) if $sock;
1029 } elsif ($op eq ':bell') {
1031 } elsif ($op =~ /(?<!\\),/) { # bare ',' (not ',,')
1032 push @$alerts, split(/(?<!\\),/, $op);
1033 } elsif ($op =~ m!\A([/a-z0-9A-Z].+)!) {
1034 my $cmd = $1; # run an arbitrary command
1035 require Text::ParseWords;
1036 $cmd = [ Text::ParseWords::shellwords($cmd) ];
1037 send($sock, exec_buf($cmd, {}), MSG_EOR) if $sock;
1039 warn("W: unsupported --alert=$op\n"); # non-fatal
1044 my %path_to_fd = ('/dev/stdin' => 0, '/dev/stdout' => 1, '/dev/stderr' => 2);
1045 $path_to_fd{"/dev/fd/$_"} = $_ for (0..2);
1047 # this also normalizes the path
1049 my ($self, $path) = @_;
1050 $path = rel2abs($self, $path);
1052 $path_to_fd{$path} // (
1053 ($path =~ m!\A/(?:dev|proc/self)/fd/[0-9]+\z!) ?
1054 fail($self, "cannot open $path from daemon") : -1
1058 # caller needs to "-t $self->{1}" to check if tty
1060 my ($self, $new_env) = @_;
1061 my $fh = popen_rd([qw(git var GIT_PAGER)]);
1062 chomp(my $pager = <$fh> // '');
1063 close($fh) or warn "`git var PAGER' error: \$?=$?";
1064 return if $pager eq 'cat' || $pager eq '';
1066 $new_env->{LESS} //= 'FRX';
1067 $new_env->{LV} //= '-c';
1068 $new_env->{MORE} = $new_env->{LESS} if $^O eq 'freebsd';
1069 pipe(my ($r, $wpager)) or return warn "pipe: $!";
1070 my $rdr = { 0 => $r, 1 => $self->{1}, 2 => $self->{2} };
1071 my $pgr = [ undef, @$rdr{1, 2} ];
1072 my $env = $self->{env};
1073 if ($self->{sock}) { # lei(1) process runs it
1074 delete @$new_env{keys %$env}; # only set iff unset
1075 send_exec_cmd($self, [ @$rdr{0..2} ], [$pager], $new_env);
1077 die 'BUG: start_pager w/o socket';
1079 $self->{1} = $wpager;
1080 $self->{2} = $wpager if -t $self->{2};
1081 $env->{GIT_PAGER_IN_USE} = 'true'; # we may spawn git
1082 $self->{pgr} = $pgr;
1085 # display a message for user before spawning full-screen $VISUAL
1087 my ($self, @msg) = @_;
1088 return warn(@msg) unless $self->{sock} && -t $self->{2};
1089 start_pager($self, { LESS => 'RX' }); # no 'F' so we prompt
1090 print { $self->{2} } @msg;
1091 $self->{2}->autoflush(1);
1093 send($self->{sock}, 'wait', MSG_EOR); # wait for user to quit pager
1098 my $pgr = delete($self->{pgr}) or return;
1099 $self->{2} = $pgr->[2];
1100 close(delete($self->{1})) if $self->{1};
1101 $self->{1} = $pgr->[1];
1104 sub accept_dispatch { # Listener {post_accept} callback
1105 my ($sock) = @_; # ignore other
1106 $sock->autoflush(1);
1107 my $self = bless { sock => $sock }, __PACKAGE__;
1108 vec(my $rvec = '', fileno($sock), 1) = 1;
1109 select($rvec, undef, undef, 60) or
1110 return send($sock, 'timed out waiting to recv FDs', MSG_EOR);
1111 # (4096 * 33) >MAX_ARG_STRLEN
1112 my @fds = $recv_cmd->($sock, my $buf, 4096 * 33) or return; # EOF
1113 if (!defined($fds[0])) {
1114 warn(my $msg = "recv_cmd failed: $!");
1115 return send($sock, $msg, MSG_EOR);
1119 open($self->{$i++}, '+<&=', $fd) and next;
1120 send($sock, "open(+<&=$fd) (FD=$i): $!", MSG_EOR);
1122 $i == 4 or return send($sock, 'not enough FDs='.($i-1), MSG_EOR)
1124 # $ENV_STR = join('', map { "\0$_=$ENV{$_}" } keys %ENV);
1125 # $buf = "$argc\0".join("\0", @ARGV).$ENV_STR."\0\0";
1126 substr($buf, -2, 2, '') eq "\0\0" or # s/\0\0\z//
1127 return send($sock, 'request command truncated', MSG_EOR);
1128 my ($argc, @argv) = split(/\0/, $buf, -1);
1130 my %env = map { split(/=/, $_, 2) } splice(@argv, $argc);
1131 $self->{env} = \%env;
1132 eval { dispatch($self, @argv) };
1133 $self->fail($@) if $@;
1138 local $current_lei = $self;
1139 delete $self->{-progress};
1140 _drop_wq($self) if $self->{failed};
1141 $self->close if $self->{-event_init_done}; # PublicInbox::DS::close
1144 # for long-running results
1147 local %ENV = %{$self->{env}};
1148 local $current_lei = $self;
1150 my @fds = $recv_cmd->($self->{sock} // return, my $buf, 4096);
1151 if (scalar(@fds) == 1 && !defined($fds[0])) {
1152 return if $! == EAGAIN;
1153 die "recvmsg: $!" if $! != ECONNRESET;
1155 @fds = (); # for open loop below:
1157 for (@fds) { open my $rfh, '+<&=', $_ }
1159 _drop_wq($self); # EOF, client disconnected
1163 if ($buf =~ /\A(?:STOP|CONT|TERM)\z/) {
1165 for my $wq (grep(defined, @$self{@WQ_KEYS})) {
1169 die "unrecognized client signal: $buf";
1171 my $s = $self->{-socks} // []; # lei up --all
1172 @$s = grep { send($_, $buf, MSG_EOR) } @$s;
1175 eval { $self->fail($err) };
1180 sub event_step_init {
1182 my $sock = $self->{sock} or return;
1183 $self->{-event_init_done} // do { # persist til $ops done
1185 $self->SUPER::new($sock, EPOLLIN);
1186 $self->{-event_init_done} = $sock;
1192 sub oldset { $oldset }
1194 sub dump_and_clear_log {
1195 if (defined($errors_log) && -s STDIN && seek(STDIN, 0, SEEK_SET)) {
1196 openlog('lei-daemon', 'pid,nowait,nofatal,ndelay', 'user');
1197 chomp(my @lines = <STDIN>);
1198 truncate(STDIN, 0) or
1199 syslog('warning', "ftruncate (%s): %m", $errors_log);
1200 for my $l (@lines) { syslog('warning', '%s', $l) }
1201 closelog(); # don't share across fork
1207 my $lei = bless { env => { %{$cfg->{-env}} } }, __PACKAGE__;
1208 open($lei->{0}, '<&', \*STDIN) or die "dup 0: $!";
1209 open($lei->{1}, '>>&', \*STDOUT) or die "dup 1: $!";
1210 open($lei->{2}, '>>&', \*STDERR) or die "dup 2: $!";
1211 open($lei->{3}, '<', '/') or die "open /: $!";
1213 socketpair($x, $y, AF_UNIX, SOCK_SEQPACKET, 0) or die "socketpair: $!";
1215 require PublicInbox::LeiSelfSocket;
1216 PublicInbox::LeiSelfSocket->new($y); # adds to event loop
1220 sub dir_idle_handler ($) { # PublicInbox::DirIdle callback
1221 my ($ev) = @_; # Linux::Inotify2::Event or duck type
1222 my $fn = $ev->fullname;
1223 if ($fn =~ m!\A(.+)/(new|cur)/([^/]+)\z!) { # Maildir file
1224 my ($mdir, $nc, $bn) = ($1, $2, $3);
1225 $nc = '' if $ev->IN_DELETE || $ev->IN_MOVED_FROM;
1226 for my $f (keys %{$MDIR2CFGPATH->{$mdir} // {}}) {
1227 my $cfg = $PATH2CFG{$f} // next;
1229 my $lei = cfg2lei($cfg);
1230 $lei->dispatch('note-event',
1231 "maildir:$mdir", $nc, $bn, $fn);
1233 warn "E: note-event $f: $@\n" if $@;
1236 if ($ev->can('cancel') && ($ev->IN_IGNORE || $ev->IN_UNMOUNT)) {
1239 if ($fn =~ m!\A(.+)/(?:new|cur)\z! && !-e $fn) {
1240 delete $MDIR2CFGPATH->{$1};
1242 if (!-e $fn) { # config file or Maildir gone
1243 for my $cfgpaths (values %$MDIR2CFGPATH) {
1244 delete $cfgpaths->{$fn};
1246 delete $PATH2CFG{$fn};
1250 # lei(1) calls this when it can't connect
1252 my ($path, $errno, $narg) = @_;
1253 local ($errors_log, $listener);
1254 my ($sock_dir) = ($path =~ m!\A(.+?)/[^/]+\z!);
1255 $errors_log = "$sock_dir/errors.log";
1256 my $addr = pack_sockaddr_un($path);
1257 my $lk = bless { lock_path => $errors_log }, 'PublicInbox::Lock';
1258 umask(077) // die("umask(077): $!");
1260 socket($listener, AF_UNIX, SOCK_SEQPACKET, 0) or die "socket: $!";
1261 if ($errno == ECONNREFUSED || $errno == ENOENT) {
1262 return if connect($listener, $addr); # another process won
1263 if ($errno == ECONNREFUSED && -S $path) {
1264 unlink($path) or die "unlink($path): $!";
1267 $! = $errno; # allow interpolation to stringify in die
1268 die "connect($path): $!";
1270 bind($listener, $addr) or die "bind($path): $!";
1273 my @st = stat($path) or die "stat($path): $!";
1274 my $dev_ino_expect = pack('dd', $st[0], $st[1]); # dev+ino
1275 local $oldset = PublicInbox::DS::block_signals();
1277 $send_cmd = PublicInbox::Spawn->can('send_cmd4');
1278 $recv_cmd = PublicInbox::Spawn->can('recv_cmd4') // do {
1279 require PublicInbox::CmdIPC4;
1280 $send_cmd = PublicInbox::CmdIPC4->can('send_cmd4');
1281 PublicInbox::CmdIPC4->can('recv_cmd4');
1283 $send_cmd = PublicInbox::Syscall->can('send_cmd4');
1284 PublicInbox::Syscall->can('recv_cmd4');
1287 $recv_cmd or die <<"";
1288 (Socket::MsgHdr || Inline::C) missing/unconfigured (narg=$narg);
1290 require PublicInbox::Listener;
1291 require PublicInbox::PktOp;
1292 (-p STDOUT) or die "E: stdout must be a pipe\n";
1293 open(STDIN, '+>>', $errors_log) or die "open($errors_log): $!";
1294 STDIN->autoflush(1);
1295 dump_and_clear_log();
1296 POSIX::setsid() > 0 or die "setsid: $!";
1297 my $pid = fork // die "fork: $!";
1299 $0 = "lei-daemon $path";
1301 local $MDIR2CFGPATH;
1302 $listener->blocking(0);
1304 my $pil = PublicInbox::Listener->new($listener, \&accept_dispatch);
1306 my (undef, $eof_p) = PublicInbox::PktOp->pair;
1308 $exit_code //= shift;
1309 eval 'PublicInbox::LeiNoteEvent::flush_task()';
1310 my $lis = $pil or exit($exit_code);
1311 # closing eof_p triggers \&noop wakeup
1312 $listener = $eof_p = $pil = $path = undef;
1313 $lis->close; # DS::close
1314 PublicInbox::DS->SetLoopTimeout(1000);
1318 CHLD => \&PublicInbox::DS::enqueue_reap,
1326 require PublicInbox::DirIdle;
1327 local $dir_idle = PublicInbox::DirIdle->new(sub {
1328 # just rely on wakeup to hit PostLoopCallback set below
1329 dir_idle_handler($_[0]) if $_[0]->fullname ne $path;
1331 $dir_idle->add_watches([$sock_dir]);
1332 PublicInbox::DS->SetPostLoopCallback(sub {
1333 my ($dmap, undef) = @_;
1334 if (@st = defined($path) ? stat($path) : ()) {
1335 if ($dev_ino_expect ne pack('dd', $st[0], $st[1])) {
1336 warn "$path dev/ino changed, quitting\n";
1339 } elsif (defined($path)) { # ENOENT is common
1340 warn "stat($path): $!, quitting ...\n" if $! != ENOENT;
1344 return 1 if defined($path);
1346 for my $s (values %$dmap) {
1347 $s->can('busy') or next;
1354 $n; # true: continue, false: stop
1357 # STDIN was redirected to /dev/null above, closing STDERR and
1358 # STDOUT will cause the calling `lei' client process to finish
1359 # reading the <$daemon> pipe.
1360 local $SIG{__WARN__} = sub {
1361 $current_lei ? err($current_lei, @_) : warn(
1362 strftime('%Y-%m-%dT%H:%M:%SZ', gmtime(time))," $$ ", @_);
1364 open STDERR, '>&STDIN' or die "redirect stderr failed: $!";
1365 open STDOUT, '>&STDIN' or die "redirect stdout failed: $!";
1366 # $daemon pipe to `lei' closed, main loop begins:
1367 eval { PublicInbox::DS::event_loop($sig, $oldset) };
1368 warn "event loop error: $@\n" if $@;
1369 # exit() may trigger waitpid via various DESTROY, ensure interruptible
1370 PublicInbox::DS::sig_setmask($oldset);
1371 dump_and_clear_log();
1372 exit($exit_code // 0);
1375 sub busy { 1 } # prevent daemon-shutdown if client is connected
1377 # ensures stdout hits the FS before sock disconnects so a client
1378 # can immediately reread it
1381 if (my $counters = delete $self->{counters}) {
1382 for my $k (sort keys %$counters) {
1383 my $nr = $counters->{$k};
1384 $self->child_error(0, "$nr $k messages");
1387 $self->{1}->autoflush(1) if $self->{1};
1389 dump_and_clear_log();
1390 # preserve $? for ->fail or ->x_it code
1393 sub wq_done_wait { # awaitpid cb (via wq_eof)
1394 my ($pid, $wq, $lei) = @_;
1395 local $current_lei = $lei;
1396 my $err_type = $lei->{-err_type};
1397 $? and $lei->child_error($?,
1398 $err_type ? "$err_type errors during $lei->{cmd} \$?=$?" : ());
1404 my $dh = $lei->{3} // die 'BUG: lei->{3} (CWD) gone';
1405 chdir($dh) || die "fchdir: $!";
1408 sub wq_eof { # EOF callback for main daemon
1409 my ($lei, $wq_fld) = @_;
1410 local $current_lei = $lei;
1411 my $wq = delete $lei->{$wq_fld // 'wq1'};
1412 $lei->sto_done_request($wq);
1413 $wq // $lei->fail; # already failed
1416 sub watch_state_ok ($) {
1417 my ($state) = $_[-1]; # $_[0] may be $self
1418 $state =~ /\Apause|(?:import|index|tag)-(?:ro|rw)\z/;
1421 sub cancel_maildir_watch ($$) {
1422 my ($d, $cfg_f) = @_;
1423 my $w = delete $MDIR2CFGPATH->{$d}->{$cfg_f};
1424 scalar(keys %{$MDIR2CFGPATH->{$d}}) or
1425 delete $MDIR2CFGPATH->{$d};
1426 for my $x (@{$w // []}) { $x->cancel }
1429 sub add_maildir_watch ($$) {
1430 my ($d, $cfg_f) = @_;
1431 if (!exists($MDIR2CFGPATH->{$d}->{$cfg_f})) {
1432 my @w = $dir_idle->add_watches(["$d/cur", "$d/new"], 1);
1433 push @{$MDIR2CFGPATH->{$d}->{$cfg_f}}, @w if @w;
1437 sub refresh_watches {
1439 $dir_idle or return;
1440 my $cfg = _lei_cfg($lei) or return;
1441 my $old = $cfg->{-watches};
1442 my $watches = $cfg->{-watches} //= {};
1444 my $cfg_f = $cfg->{'-f'};
1445 for my $w (grep(/\Awatch\..+\.state\z/, keys %$cfg)) {
1446 my $url = substr($w, length('watch.'), -length('.state'));
1447 require PublicInbox::LeiWatch;
1448 $watches->{$url} //= PublicInbox::LeiWatch->new($url);
1449 $seen{$url} = undef;
1450 my $state = $cfg->get_1("watch.$url.state");
1451 if (!watch_state_ok($state)) {
1452 warn("watch.$url.state=$state not supported\n");
1455 if ($url =~ /\Amaildir:(.+)/i) {
1456 my $d = canonpath_harder($1);
1457 if ($state eq 'pause') {
1458 cancel_maildir_watch($d, $cfg_f);
1460 add_maildir_watch($d, $cfg_f);
1462 } else { # TODO: imap/nntp/jmap
1463 $lei->child_error(0, "E: watch $url not supported, yet")
1467 # add all known Maildir folders as implicit watches
1468 my $lms = $lei->lms;
1470 $lms->lms_write_prepare;
1471 for my $d ($lms->folders('maildir:')) {
1472 substr($d, 0, length('maildir:')) = '';
1474 # fixup old bugs while we're iterating:
1475 my $cd = canonpath_harder($d);
1476 my $f = "maildir:$cd";
1477 $lms->rename_folder("maildir:$d", $f) if $d ne $cd;
1478 next if $watches->{$f}; # may be set to pause
1479 require PublicInbox::LeiWatch;
1480 $watches->{$f} = PublicInbox::LeiWatch->new($f);
1482 add_maildir_watch($cd, $cfg_f);
1485 if ($old) { # cull old non-existent entries
1486 for my $url (keys %$old) {
1487 next if exists $seen{$url};
1488 delete $old->{$url};
1489 if ($url =~ /\Amaildir:(.+)/i) {
1490 my $d = canonpath_harder($1);
1491 cancel_maildir_watch($d, $cfg_f);
1492 } else { # TODO: imap/nntp/jmap
1493 $lei->child_error(0, "E: watch $url TODO");
1497 if (scalar keys %$watches) {
1498 $cfg->{-env} //= { %{$lei->{env}}, PWD => '/' }; # for cfg2lei
1500 delete $cfg->{-watches};
1504 # TODO: support SHA-256
1507 $eml->header_set($_) for @PublicInbox::Import::UNWANTED_HEADERS;
1512 my ($lei, $creat) = @_;
1513 my $sto = $lei->{sto} // _lei_store($lei) // return;
1514 require PublicInbox::LeiMailSync;
1515 my $f = "$sto->{priv_eidx}->{topdir}/mail_sync.sqlite3";
1516 (-f $f || $creat) ? PublicInbox::LeiMailSync->new($f) : undef;
1519 sub sto_done_request {
1520 my ($lei, $wq) = @_;
1521 return unless $lei->{sto};
1522 local $current_lei = $lei;
1523 my $sock = $wq ? $wq->{lei_sock} : undef;
1524 $sock //= $lei->{sock};
1526 push(@io, $sock) if $sock; # async wait iff possible
1527 eval { $lei->{sto}->wq_io_do('done', \@io) };
1533 my $ret = eval { PublicInbox::Config->git_config_dump($f, $lei->{2}) };
1541 my $s = $lei->{sock} // return;
1542 send($s, 'umask', MSG_EOR) // die "send: $!";
1543 vec(my $rvec = '', fileno($s), 1) = 1;
1544 select($rvec, undef, undef, 2) or die 'timeout waiting for umask';
1545 recv($s, my $v, 5, 0) // die "recv: $!";
1546 (my $u, $lei->{client_umask}) = unpack('AV', $v);
1547 $u eq 'u' or warn "E: recv $v has no umask";