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 PublicInbox::Import;
28 use PublicInbox::ContentHash qw(git_sha);
29 use Time::HiRes qw(stat); # ctime comparisons for config cache
30 use File::Path qw(mkpath);
32 use Sys::Syslog qw(openlog syslog closelog);
33 our $quit = \&CORE::exit;
34 our ($current_lei, $errors_log, $listener, $oldset, $dir_idle,
35 $recv_cmd, $send_cmd);
36 my $GLP = Getopt::Long::Parser->new;
37 $GLP->configure(qw(gnu_getopt no_ignore_case auto_abbrev));
38 my $GLP_PASS = Getopt::Long::Parser->new;
39 $GLP_PASS->configure(qw(gnu_getopt no_ignore_case auto_abbrev pass_through));
41 our %PATH2CFG; # persistent for socket daemon
42 our $MDIR2CFGPATH; # /path/to/maildir => { /path/to/config => [ ino watches ] }
44 # TBD: this is a documentation mechanism to show a subcommand
45 # (may) pass options through to another command:
46 sub pass_through { $GLP_PASS }
50 my ($spec, $re_str) = @_; # 'limit|n=i', '([0-9]+)'
51 my ($key) = ($spec =~ m/\A([a-z]+)/g);
52 my $cb = sub { # Getopt::Long "<>" catch-all handler
54 if ($arg =~ /\A-($re_str)\z/) {
56 } elsif ($arg eq '--') { # "--" arg separator, ignore first
57 push @{$OPT->{-argv}}, $arg if $OPT->{'--'}++;
58 # lone (single) dash is handled elsewhere
59 } elsif (substr($arg, 0, 1) eq '-') {
61 push @{$OPT->{-argv}}, $arg;
63 die "bad argument: $arg\n";
66 push @{$OPT->{-argv}}, $arg;
69 ($spec, '<>' => $cb, $GLP_PASS) # for Getopt::Long
72 # rel2abs preserves symlinks in parent, unlike abs_path
75 if (index($p, '/') == 0) { # already absolute
76 $p =~ tr!/!/!s; # squeeze redundant slashes
77 chop($p) if substr($p, -1, 1) eq '/';
80 my $pwd = $self->{env}->{PWD};
83 my $xcwd = $self->{3} //
84 ($cwd = getcwd() // die "getcwd(PWD=$pwd): $!");
85 if (my @st_pwd = stat($pwd)) {
86 my @st_cwd = stat($xcwd) or die "stat($xcwd): $!";
87 "@st_pwd[1,0]" eq "@st_cwd[1,0]" or
88 $self->{env}->{PWD} = $pwd = undef;
89 } else { # PWD was invalid
90 $self->{env}->{PWD} = $pwd = undef;
93 $pwd //= $self->{env}->{PWD} = $cwd // getcwd() // die "getcwd: $!";
94 File::Spec->rel2abs($p, $pwd);
97 # abs_path resolves symlinks in parent iff all parents exist
98 sub abs_path { Cwd::abs_path($_[1]) // rel2abs(@_) }
100 sub canonpath_harder {
101 my $p = $_[-1]; # $_[0] may be self
102 $p = File::Spec->canonpath($p);
103 $p =~ m!(?:/*|\A)\.\.(?:/*|\z)! && -e $p ? Cwd::abs_path($p) : $p;
106 sub share_path ($) { # $HOME/.local/share/lei/$FOO
108 rel2abs($self, ($self->{env}->{XDG_DATA_HOME} //
109 ($self->{env}->{HOME} // '/nonexistent').'/.local/share')
113 sub store_path ($) { share_path($_[0]) . '/store' }
115 sub _config_path ($) {
117 rel2abs($self, ($self->{env}->{XDG_CONFIG_HOME} //
118 ($self->{env}->{HOME} // '/nonexistent').'/.config')
124 rel2abs($self, ($self->{env}->{XDG_CACHE_HOME} //
125 ($self->{env}->{HOME} // '/nonexistent').'/.cache')
129 sub url_folder_cache {
131 require PublicInbox::SharedKV; # URI => updated_at_sec_
132 PublicInbox::SharedKV->new(cache_dir($self).'/uri_folder');
137 $self->{ale} //= do {
138 require PublicInbox::LeiALE;
139 $self->_lei_cfg(1)->{ale} //= PublicInbox::LeiALE->new($self);
144 # TODO: drop underscore variants everywhere, they're undocumented
145 qw(fsync|sync! jobs|j=i indexlevel|L=s compact
146 max_size|max-size=s sequential-shard
147 batch_size|batch-size=s skip-docdata)
150 my @c_opt = qw(c=s@ C=s@ quiet|q);
151 my @net_opt = (qw(no-torsocks torsocks=s), PublicInbox::LeiQuery::curl_opt());
152 my @lxs_opt = qw(remote! local! external! include|I=s@ exclude=s@ only=s@
155 # we don't support -C as an alias for --find-copies since it's already
157 our @diff_opt = qw(unified|U=i output-indicator-new=s output-indicator-old=s
158 output-indicator-context=s indent-heuristic!
159 minimal patience histogram anchored=s@ diff-algorithm=s
160 color-moved:s color-moved-ws=s no-color-moved no-color-moved-ws
161 word-diff:s word-diff-regex=s color-words:s no-renames
162 rename-empty! check ws-error-highlight=s full-index binary
163 abbrev:i break-rewrites|B:s find-renames|M:s find-copies:s
164 find-copies-harder irreversible-delete|D l=i diff-filter=s
165 S=s G=s find-object=s pickaxe-all pickaxe-regex O=s R
166 relative:s text|a ignore-cr-at-eol ignore-space-at-eol
167 ignore-space-change|b ignore-all-space|w ignore-blank-lines
168 inter-hunk-context=i function-context|W exit-code ext-diff
169 no-ext-diff textconv! src-prefix=s dst-prefix=s no-prefix
172 # we generate shell completion + help using %CMD and %OPTDESC,
173 # see lei__complete() and PublicInbox::LeiHelp
174 # command => [ positional_args, 1-line description, Getopt::Long option spec ]
175 our %CMD = ( # sorted in order of importance/use:
176 'q' => [ '--stdin|SEARCH_TERMS...', 'search for messages matching terms',
177 'stdin|', # /|\z/ must be first for lone dash
179 qw(save! output|mfolder|o=s format|f=s dedupe|d=s threads|t+
180 sort|s=s reverse|r offset=i pretty jobs|j=s globoff|g augment|a
181 import-before! lock=s@ rsyncable alert=s@ mua=s verbose|v+
182 shared color! mail-sync!), @c_opt, opt_dash('limit|n=i', '[0-9]+') ],
184 'up' => [ 'OUTPUT...|--all', 'update saved search',
185 qw(jobs|j=s lock=s@ alert=s@ mua=s verbose|v+
186 remote-fudge-time=s all:s), @c_opt ],
188 'lcat' => [ '--stdin|MSGID_OR_URL...', 'display local copy of message(s)',
189 'stdin|', # /|\z/ must be first for lone dash
190 # some of these options are ridiculous for lcat
192 qw(output|mfolder|o=s format|f=s dedupe|d=s threads|t+
193 sort|s=s reverse|r offset=i jobs|j=s globoff|g augment|a
194 import-before! lock=s@ rsyncable alert=s@ mua=s verbose|v+
195 color!), @c_opt, opt_dash('limit|n=i', '[0-9]+') ],
197 'blob' => [ 'OID', 'show a git blob, reconstructing from mail if necessary',
198 qw(git-dir=s@ cwd! verbose|v+ mail! oid-a|A=s path-a|a=s path-b|b=s),
199 @lxs_opt, @net_opt, @c_opt ],
201 'rediff' => [ '--stdin|LOCATION...',
202 'regenerate a diff with different options',
203 'stdin|', # /|\z/ must be first for lone dash
204 qw(git-dir=s@ cwd! verbose|v+ color:s no-color),
205 @diff_opt, @lxs_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), @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', 'forget a saved search',
225 qw(verbose|v+), @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 'index' => [ 'LOCATION...', 'one-time index from URL or filesystem',
256 qw(in-format|F=s kw! offset=i recursive|r exclude=s include|I=s
257 verbose|v+ incremental!), @net_opt, # mainly for --proxy=
259 'import' => [ 'LOCATION...|--stdin',
260 'one-time import/update from URL or filesystem',
261 qw(stdin| offset=i recursive|r exclude=s include|I=s new-only
262 lock=s@ in-format|F=s kw! verbose|v+ incremental! mail-sync!),
264 'forget-mail-sync' => [ 'LOCATION...',
265 'forget sync information for a mail folder', @c_opt ],
266 'refresh-mail-sync' => [ 'LOCATION...|--all',
267 'prune dangling sync data for a mail folder', 'all:s', @c_opt ],
268 'export-kw' => [ 'LOCATION...|--all',
269 'one-time export of keywords of sync sources',
270 qw(all:s mode=s), @net_opt, @c_opt ],
271 'convert' => [ 'LOCATION...|--stdin',
272 'one-time conversion from URL or filesystem to another format',
273 qw(stdin| in-format|F=s out-format|f=s output|mfolder|o=s lock=s@ kw!),
275 'p2q' => [ 'FILE|COMMIT_OID|--stdin',
276 "use a patch to generate a query for `lei q --stdin'",
277 qw(stdin| want|w=s@ uri debug), @c_opt ],
278 'config' => [ '[...]', sub {
279 'git-config(1) wrapper for '._config_path($_[0]);
280 }, qw(config-file|system|global|file|f=s), # for conflict detection
281 qw(edit|e c=s@ C=s@), pass_through('git config') ],
282 'inspect' => [ 'ITEMS...|--stdin', 'inspect lei/store and/or local external',
283 qw(stdin| pretty ascii dir=s), @c_opt ],
285 'init' => [ '[DIRNAME]', sub {
286 "initialize storage, default: ".store_path($_[0]);
288 'daemon-kill' => [ '[-SIGNAL]', 'signal the lei-daemon',
289 # "-C DIR" conflicts with -CHLD, here, and chdir makes no sense, here
290 opt_dash('signal|s=s', '[0-9]+|(?:[A-Z][A-Z0-9]+)') ],
291 'daemon-pid' => [ '', 'show the PID of the lei-daemon' ],
292 'help' => [ '[SUBCOMMAND]', 'show help' ],
295 #'reorder-local-store-and-break-history' => [ '[REFNAME]',
296 # 'rewrite git history in an attempt to improve compression',
298 #'fuse-mount' => [ 'PATHNAME', 'expose lei/store as Maildir(s)', @c_opt ],
300 # internal commands are prefixed with '_'
301 '_complete' => [ '[...]', 'internal shell completion helper',
302 pass_through('everything') ],
305 # switch descriptions, try to keep consistent across commands
306 # $spec: Getopt::Long option specification
307 # $spec => [@ALLOWED_VALUES (default is first), $description],
308 # $spec => $description
309 # "$SUB_COMMAND TAB $spec" => as above
310 my $stdin_formats = [ 'MAIL_FORMAT|eml|mboxrd|mboxcl2|mboxcl|mboxo',
311 'specify message input format' ];
312 my $ls_format = [ 'OUT|plain|json|null', 'listing output format' ];
314 # we use \x{a0} (non-breaking SP) to avoid wrapping in PublicInbox::LeiHelp
316 'help|h' => 'show this built-in help',
317 'c=s@' => [ 'NAME=VALUE', 'set config option' ],
318 'C=s@' => [ 'DIR', 'chdir to specify to directory' ],
319 'quiet|q' => 'be quiet',
320 'lock=s@' => [ 'METHOD|dotlock|fcntl|flock|none',
321 'mbox(5) locking method(s) to use (default: fcntl,dotlock)' ],
323 'incremental! import' => 'import already seen IMAP and NNTP articles',
324 'globoff|g' => "do not match locations using '*?' wildcards ".
325 "and\xa0'[]'\x{a0}ranges",
326 'invert-match|v' => 'select non-matching lines',
327 'color!' => 'disable color (for --format=text)',
328 'verbose|v+' => 'be more verbose',
329 'external!' => 'do not use externals',
330 'mail!' => 'do not look in mail storage for OID',
331 'cwd!' => 'do not look in git repo of current working directory',
332 'oid-a|A=s' => 'pre-image OID',
333 'path-a|a=s' => 'pre-image pathname associated with OID',
334 'path-b|b=s' => 'post-image pathname associated with OID',
335 'git-dir=s@' => 'additional git repository to scan',
336 'dir=s inspect' => 'specify a inboxdir, extindex topdir or Xapian shard',
337 'proxy=s' => [ 'PROTO://HOST[:PORT]', # shared with curl(1)
338 "proxy for (e.g. `socks5h://0:9050')" ],
339 'torsocks=s' => ['VAL|auto|no|yes',
340 'whether or not to wrap git and curl commands with torsocks'],
341 'no-torsocks' => 'alias for --torsocks=no',
342 'save!' => "do not save a search for `lei up'",
343 'import-remote!' => 'do not memoize remote messages into local store',
345 'type=s' => [ 'any|mid|git', 'disambiguate type' ],
347 'dedupe|d=s' => ['STRATEGY|content|oid|mid|none',
348 'deduplication strategy'],
350 'return all messages in the same threads as the actual match(es)',
352 'want|w=s@' => [ 'PREFIX|dfpost|dfn', # common ones in help...
353 'search prefixes to extract (default: dfpost7)' ],
355 'alert=s@' => ['CMD,:WINCH,:bell,<any command>',
356 'run command(s) or perform ops when done writing to output ' .
357 '(default: ":WINCH,:bell" with --mua and Maildir/IMAP output, ' .
358 'nothing otherwise)' ],
360 'augment|a' => 'augment --output destination instead of clobbering',
362 'output|mfolder|o=s' => [ 'MFOLDER',
363 "destination (e.g.\xa0`/path/to/Maildir', ".
364 "or\xa0`-'\x{a0}for\x{a0}stdout)" ],
366 "MUA to run on --output Maildir or mbox (e.g.\xa0`mutt\xa0-f\xa0%f')" ],
367 'new-only import' => 'only import new messages from IMAP source',
369 'inbox-version=i' => [ 'NUM|1|2',
370 'force a public-inbox version with --mirror'],
371 'mirror=s' => [ 'URL', 'mirror a public-inbox'],
373 # public-inbox-index options
374 'fsync!' => 'speed up indexing after --mirror, risk index corruption',
375 'compact' => 'run compact index after mirroring',
376 'indexlevel|L=s' => [ 'LEVEL|full|medium|basic',
377 "indexlevel with --mirror (default: full)" ],
378 'max_size|max-size=s' => [ 'SIZE',
379 'do not index messages larger than SIZE (default: infinity)' ],
380 'batch_size|batch-size=s' => [ 'SIZE',
381 'flush changes to OS after given number of bytes (default: 1m)' ],
382 'sequential-shard' =>
383 'index Xapian shards sequentially for slow storage',
385 'drop compatibility w/ public-inbox <1.6 to save ~1.5% space',
388 'OUT|maildir|mboxrd|mboxcl2|mboxcl|mboxo|html|json|jsonl|concatjson',
389 'specify output format, default depends on --output'],
390 'exclude=s@ q' => [ 'LOCATION',
391 'exclude specified external(s) from search' ],
392 'include|I=s@ q' => [ 'LOCATION',
393 'include specified external(s) in search' ],
394 'only=s@ q' => [ 'LOCATION',
395 'only use specified external(s) for search' ],
396 'jobs=s q' => [ '[SEARCH_JOBS][,WRITER_JOBS]',
397 'control number of search and writer jobs' ],
398 'jobs|j=i add-external' => 'set parallelism when indexing after --mirror',
400 'in-format|F=s' => $stdin_formats,
401 'format|f=s ls-search' => ['OUT|json|jsonl|concatjson',
402 'listing output format' ],
403 'l ls-search' => 'long listing format',
404 'l ls-watch' => 'long listing format',
405 'l ls-mail-source' => 'long listing format',
406 'url ls-mail-source' => 'show full URL of newsgroup or IMAP folder',
407 'format|f=s ls-external' => $ls_format,
409 'limit|n=i@' => ['NUM', 'limit on number of matches (default: 10000)' ],
410 'offset=i' => ['OFF', 'search result offset (default: 0)'],
412 'sort|s=s' => [ 'VAL|received|relevance|docid',
413 "order of results is `--output'-dependent"],
414 'reverse|r' => 'reverse search results', # like sort(1)
416 'boost=i' => 'increase/decrease priority of results (default: 0)',
418 'local' => 'limit operations to the local filesystem',
419 'local!' => 'exclude results from the local filesystem',
420 'remote' => 'limit operations to those requiring network access',
421 'remote!' => 'prevent operations requiring network access',
423 # up, refresh-mail-sync, export-kw
424 'all:s' => ['TYPE|local|remote', 'all remote or local folders' ],
426 'remote-fudge-time=s' => [ 'INTERVAL',
427 'look for mail INTERVAL older than the last successful query' ],
429 'mid=s' => 'specify the Message-ID of a message',
430 'oid=s' => 'specify the git object ID of a message',
432 'recursive|r' => 'scan directories/mailboxes/newsgroups recursively',
433 'exclude=s' => 'exclude mailboxes/newsgroups based on pattern',
434 'include=s' => 'include mailboxes/newsgroups based on pattern',
436 'exact' => 'operate on exact header matches only',
437 'exact!' => 'rely on content match instead of exact header matches',
439 'by-mid|mid:s' => [ 'MID', 'match only by Message-ID, ignoring contents' ],
441 'kw!' => 'disable/enable importing keywords (aka "flags")',
443 # xargs, env, use "-0", git(1) uses "-z". We support z|0 everywhere
444 'z|0' => 'use NUL \\0 instead of newline (CR) to delimit lines',
446 'signal|s=s' => [ 'SIG', 'signal to send lei-daemon (default: TERM)' ],
450 'leistore.dir' => 'top-level storage location',
453 my @WQ_KEYS = qw(lxs l2m ikw pmd wq1 lne); # internal workers
457 for my $wq (grep(defined, delete(@$self{@WQ_KEYS}))) {
459 $wq->wq_close(0, undef, $self);
460 } elsif ($wq->wq_kill_old) {
461 $wq->wq_wait_old(undef, $self);
467 # pronounced "exit": x_it(1 << 8) => exit(1); x_it(13) => SIGPIPE
469 my ($self, $code) = @_;
470 # make sure client sees stdout before exit
471 $self->{1}->autoflush(1) if $self->{1};
473 if ($self->{pkt_op_p}) { # worker => lei-daemon
474 $self->{pkt_op_p}->pkt_do('x_it', $code);
475 } elsif ($self->{sock}) { # lei->daemon => lei(1) client
476 send($self->{sock}, "x_it $code", MSG_EOR);
477 } elsif ($quit == \&CORE::exit) { # an admin (one-shot) command
479 } # else ignore if client disconnected
484 my $err = $self->{2} // ($self->{pgr} // [])->[2] // *STDERR{GLOB};
485 my @eor = (substr($_[-1]//'', -1, 1) eq "\n" ? () : ("\n"));
486 print $err @_, @eor and return;
487 my $old_err = delete $self->{2};
488 close($old_err) if $! == EPIPE && $old_err;
489 $err = $self->{2} = ($self->{pgr} // [])->[2] // *STDERR{GLOB};
490 print $err @_, @eor or print STDERR @_, @eor;
493 sub qerr ($;@) { $_[0]->{opt}->{quiet} or err(shift, @_) }
495 sub qfin { # show message on finalization (LeiFinmsg)
496 my ($lei, $msg) = @_;
497 return if $lei->{opt}->{quiet};
498 $lei->{fmsg} ? push(@{$lei->{fmsg}}, "$msg\n") : qerr($lei, $msg);
501 sub fail_handler ($;$$) {
502 my ($lei, $code, $io) = @_;
503 close($io) if $io; # needed to avoid warnings on SIGPIPE
505 x_it($lei, $code // (1 << 8));
508 sub sigpipe_handler { # handles SIGPIPE from @WQ_KEYS workers
509 fail_handler($_[0], 13, delete $_[0]->{1});
512 # PublicInbox::OnDestroy callback for SIGINT to take out the entire pgid
515 dwaitpid($pgid) if kill('-INT', $pgid);
519 my ($self, $buf, $exit_code) = @_;
521 err($self, $buf) if defined $buf;
523 $self->{pkt_op_p}->pkt_do('!') if $self->{pkt_op_p};
524 x_it($self, ($exit_code // 1) << 8);
530 return if print { $self->{1} // return } @_; # likely
531 return note_sigpipe($self, 1) if $! == EPIPE;
532 my $err = "error writing to output: $!";
537 sub puts ($;@) { out(shift, map { "$_\n" } @_) }
539 sub child_error { # passes non-fatal curl exit codes to user
540 my ($self, $child_error, $msg) = @_; # child_error is $?
541 $child_error ||= 1 << 8;
542 $self->err($msg) if $msg;
543 if ($self->{pkt_op_p}) { # to top lei-daemon
544 $self->{pkt_op_p}->pkt_do('child_error', $child_error);
545 } elsif ($self->{sock}) { # to lei(1) client
546 send($self->{sock}, "child_error $child_error", MSG_EOR);
547 } else { # non-lei admin command
548 $self->{child_error} ||= $child_error;
549 } # else noop if client disconnected
552 sub note_sigpipe { # triggers sigpipe_handler
553 my ($self, $fd) = @_;
554 close(delete($self->{$fd})); # explicit close silences Perl warning
555 $self->{pkt_op_p}->pkt_do('|') if $self->{pkt_op_p};
559 sub _lei_atfork_child {
560 my ($self, $persist) = @_;
561 # we need to explicitly close things which are on stack
563 chdir '/' or die "chdir(/): $!";
564 close($_) for (grep(defined, delete @$self{qw(0 1 2 sock)}));
565 if (my $cfg = $self->{cfg}) {
566 delete @$cfg{qw(-lei_store -watches -lei_note_event)};
568 } else { # worker, Net::NNTP (Net::Cmd) uses STDERR directly
569 open STDERR, '+>&='.fileno($self->{2}) or warn "open $!";
570 STDERR->autoflush(1);
572 close($_) for (grep(defined, delete @$self{qw(3 old_1 au_done)}));
573 if (my $op_c = delete $self->{pkt_op_c}) {
574 close(delete $op_c->{sock});
576 if (my $pgr = delete $self->{pgr}) {
577 close($_) for (@$pgr[1,2]);
579 close $listener if $listener;
581 $dir_idle->force_close if $dir_idle;
584 eval 'no warnings; undef $PublicInbox::LeiNoteEvent::to_flush';
586 $quit = \&CORE::exit;
587 $self->{-eml_noisy} or # only "lei import" sets this atm
588 $SIG{__WARN__} = PublicInbox::Eml::warn_ignore_cb();
589 $current_lei = $persist ? undef : $self; # for SIG{__WARN__}
592 sub _delete_pkt_op { # OnDestroy callback to prevent leaks on die
594 if (my $op = delete $self->{pkt_op_c}) { # in case of die
595 $op->close; # PublicInbox::PktOp::close
597 my $pkt_op_p = delete($self->{pkt_op_p}) or return;
598 close $pkt_op_p->{op_p};
603 require PublicInbox::OnDestroy;
604 require PublicInbox::PktOp;
605 my $end = PublicInbox::OnDestroy->new($$, \&_delete_pkt_op, $self);
606 @$self{qw(pkt_op_c pkt_op_p)} = PublicInbox::PktOp->pair;
611 my ($self, $field, $nr) = @_;
612 $self->{counters}->{$field} += $nr;
616 my ($lei, $ops) = @_;
617 $ops->{'!'} = [ \&fail_handler, $lei ];
618 $ops->{'|'} = [ \&sigpipe_handler, $lei ];
619 $ops->{x_it} = [ \&x_it, $lei ];
620 $ops->{child_error} = [ \&child_error, $lei ];
621 $ops->{incr} = [ \&incr, $lei ];
626 my ($lei, $wq, $jobs, $ops, $flds) = @_;
627 $ops = pkt_ops($lei, { ($ops ? %$ops : ()) });
628 $ops->{''} //= [ $wq->can('_lei_wq_eof') || \&wq_eof, $lei ];
629 my $end = $lei->pkt_op_pair;
630 my $ident = $wq->{-wq_ident} // "lei-$lei->{cmd} worker";
632 $wq->wq_workers_start($ident, $jobs, $lei->oldset, $flds);
633 delete $lei->{pkt_op_p};
634 my $op_c = delete $lei->{pkt_op_c};
636 $lei->event_step_init;
640 # call this when we're ready to wait on events and yield to other clients
642 my ($lei, $op_c, $ops) = @_;
643 for my $wq (grep(defined, @$lei{qw(ikw pmd)})) { # auxiliary WQs
650 require PublicInbox::LeiHelp;
651 PublicInbox::LeiHelp::call($_[0], $_[1], \%CMD, \%OPTDESC);
655 my ($self, $cmd, $argv) = @_;
656 # allow _complete --help to complete, not show help
657 return 1 if substr($cmd, 0, 1) eq '_';
659 $OPT = $self->{opt} //= {};
660 my $info = $CMD{$cmd} // [ '[...]' ];
661 my ($proto, undef, @spec) = @$info;
662 my $glp = ref($spec[-1]) eq ref($GLP) ? pop(@spec) : $GLP;
663 push @spec, qw(help|h);
665 if ($spec[0] =~ s/\|\z//s) { # "stdin|" or "clear|" allows "-" alias
666 $lone_dash = $spec[0];
667 $OPT->{$spec[0]} = \(my $var);
668 push @spec, '' => \$var;
670 $glp->getoptionsfromarray($argv, $OPT, @spec) or
671 return _help($self, "bad arguments or options for $cmd");
672 return _help($self) if $OPT->{help};
674 push @$argv, @{$OPT->{-argv}} if defined($OPT->{-argv});
676 # "-" aliases "stdin" or "clear"
677 $OPT->{$lone_dash} = ${$OPT->{$lone_dash}} if defined $lone_dash;
680 my $POS_ARG = '[A-Z][A-Z0-9_]+';
682 my @args = split(/ /, $proto);
683 for my $var (@args) {
684 if ($var =~ /\A$POS_ARG\.\.\.\z/o) { # >= 1 args;
685 $inf = defined($argv->[$i]) and last;
686 $var =~ s/\.\.\.\z//;
687 $err = "$var not supplied";
688 } elsif ($var =~ /\A$POS_ARG\z/o) { # required arg at $i
689 $argv->[$i++] // ($err = "$var not supplied");
690 } elsif ($var =~ /\.\.\.\]\z/) { # optional args start
693 } elsif ($var =~ /\A\[-?$POS_ARG\]\z/) { # one optional arg
695 } elsif ($var =~ /\A.+?\|/) { # required FOO|--stdin
696 $inf = 1 if index($var, '...') > 0;
697 my @or = split(/\|/, $var);
700 if ($o =~ /\A--([a-z0-9\-]+)/) {
702 # assume pipe/regular file on stdin
703 # w/o args means stdin
704 if ($sw eq 'stdin' && !@$argv &&
709 $ok = defined($OPT->{$sw});
711 } elsif (defined($argv->[$i])) {
715 } # else continue looping
719 $err = join(', ', @or) . " or $last must be set";
721 warn "BUG: can't parse `$var' in $proto";
725 if (!$inf && scalar(@$argv) > scalar(@args)) {
726 $err //= 'too many arguments';
728 $err ? fail($self, "usage: lei $cmd $proto\nE: $err") : 1;
731 sub _tmp_cfg { # for lei -c <name>=<value> ...
733 my $cfg = _lei_cfg($self, 1);
735 my $ft = File::Temp->new(TEMPLATE => 'lei_cfg-XXXX', TMPDIR => 1);
736 my $tmp = { '-f' => $ft->filename, -tmp => $ft };
738 print $ft <<EOM or return fail($self, "$tmp->{-f}: $!");
742 $tmp = $self->{cfg} = bless { %$cfg, %$tmp }, ref($cfg);
743 for (@{$self->{opt}->{c}}) {
744 /\A([^=\.]+\.[^=]+)(?:=(.*))?\z/ or return fail($self, <<EOM);
745 `-c $_' is not of the form -c <name>=<value>'
749 _config($self, '--add', $name, $value);
750 if (defined(my $v = $tmp->{$name})) {
751 if (ref($v) eq 'ARRAY') {
754 $tmp->{$name} = [ $v, $value ];
757 $tmp->{$name} = $value;
763 my ($self, $cmd, $pfx) = @_;
767 $cb = $self->can($pfx.$ucmd) and return $cb;
769 $base =~ s/_([a-z])/\u$1/g;
770 my $pkg = "PublicInbox::Lei\u$base";
771 ($INC{"PublicInbox/Lei\u$base.pm"} // eval("require $pkg")) ?
772 $pkg->can($pfx.$ucmd) : undef;
776 my ($self, $cmd, @argv) = @_;
777 fchdir($self) or return;
778 local %ENV = %{$self->{env}};
779 local $current_lei = $self; # for __WARN__
780 $self->{2}->autoflush(1); # keep stdout buffered until x_it|DESTROY
781 return _help($self, 'no command given') unless defined($cmd);
782 # do not support Getopt bundling for this
783 while ($cmd eq '-C' || $cmd eq '-c') {
784 my $v = shift(@argv) // return fail($self, $cmd eq '-C' ?
785 '-C DIRECTORY' : '-c <name>=<value>');
786 push @{$self->{opt}->{substr($cmd, 1, 1)}}, $v;
787 $cmd = shift(@argv) // return _help($self, 'no command given');
789 if (my $cb = lazy_cb(__PACKAGE__, $cmd, 'lei_')) {
790 optparse($self, $cmd, \@argv) or return;
791 $self->{opt}->{c} and (_tmp_cfg($self) // return);
792 if (my $chdir = $self->{opt}->{C}) {
793 for my $d (@$chdir) {
794 next if $d eq ''; # same as git(1)
795 chdir $d or return fail($self, "cd $d: $!");
797 open $self->{3}, '.' or return fail($self, "open . $!");
800 } elsif (grep(/\A-/, $cmd, @argv)) { # --help or -h only
801 $GLP->getoptionsfromarray([$cmd, @argv], {}, qw(help|h C=s@))
802 or return _help($self, 'bad arguments or options');
805 fail($self, "`$cmd' is not an lei command");
810 my ($self, $creat) = @_;
811 return $self->{cfg} if $self->{cfg};
812 my $f = _config_path($self);
814 my $cur_st = @st ? pack('dd', $st[10], $st[7]) : ''; # 10:ctime, 7:size
815 my ($sto, $sto_dir, $watches, $lne);
816 if (my $cfg = $PATH2CFG{$f}) { # reuse existing object in common case
817 return ($self->{cfg} = $cfg) if $cur_st eq $cfg->{-st};
818 ($sto, $sto_dir, $watches, $lne) =
819 @$cfg{qw(-lei_store leistore.dir -watches
825 return bless {}, 'PublicInbox::Config';
827 my ($cfg_dir) = ($f =~ m!(.*?/)[^/]+\z!);
828 -d $cfg_dir or mkpath($cfg_dir) or die "mkpath($cfg_dir): $!\n";
829 open my $fh, '>>', $f or die "open($f): $!\n";
830 @st = stat($fh) or die "fstat($f): $!\n";
831 $cur_st = pack('dd', $st[10], $st[7]);
832 qerr($self, "# $f created") if $self->{cmd} ne 'config';
834 my $cfg = PublicInbox::Config->git_config_dump($f, $self->{2});
835 $cfg->{-st} = $cur_st;
837 if ($sto && canonpath_harder($sto_dir // store_path($self))
838 eq canonpath_harder($cfg->{'leistore.dir'} //
839 store_path($self))) {
840 $cfg->{-lei_store} = $sto;
841 $cfg->{-lei_note_event} = $lne;
842 $cfg->{-watches} = $watches if $watches;
844 if (scalar(keys %PATH2CFG) > 5) {
845 # FIXME: use inotify/EVFILT_VNODE to detect unlinked configs
846 for my $k (keys %PATH2CFG) {
847 delete($PATH2CFG{$k}) unless -f $k
850 $self->{cfg} = $PATH2CFG{$f} = $cfg;
851 refresh_watches($self);
855 sub _lei_store ($;$) {
856 my ($self, $creat) = @_;
857 my $cfg = _lei_cfg($self, $creat) // return;
858 $cfg->{-lei_store} //= do {
859 require PublicInbox::LeiStore;
860 my $dir = $cfg->{'leistore.dir'} // store_path($self);
861 return unless $creat || -d $dir;
862 PublicInbox::LeiStore->new($dir, { creat => $creat });
867 my ($self, @argv) = @_;
868 my %env = (%{$self->{env}}, GIT_CONFIG => undef);
869 my $cfg = _lei_cfg($self, 1);
870 my $cmd = [ qw(git config -f), $cfg->{'-f'}, @argv ];
871 my %rdr = map { $_ => $self->{$_} } (0..2);
872 waitpid(spawn($cmd, \%env, \%rdr), 0);
875 sub lei_daemon_pid { puts shift, $$ }
877 sub lei_daemon_kill {
879 my $sig = $self->{opt}->{signal} // 'TERM';
880 kill($sig, $$) or fail($self, "kill($sig, $$): $!");
883 # Shell completion helper. Used by lei-completion.bash and hopefully
884 # other shells. Try to do as much here as possible to avoid redundancy
885 # and improve maintainability.
887 my ($self, @argv) = @_; # argv = qw(lei and any other args...)
888 shift @argv; # ignore "lei", the entire command is sent
889 @argv or return puts $self, grep(!/^_/, keys %CMD), qw(--help -h -C);
890 my $cmd = shift @argv;
891 my $info = $CMD{$cmd} // do { # filter matching commands
892 @argv or puts $self, grep(/\A\Q$cmd\E/, keys %CMD);
895 my ($proto, undef, @spec) = @$info;
897 my $re = defined($cur) ? qr/\A\Q$cur\E/ : qr/./;
898 if (substr(my $_cur = $cur // '-', 0, 1) eq '-') { # --switches
899 # gross special case since the only git-config options
900 # Consider moving to a table if we need more special cases
901 # we use Getopt::Long for are the ones we reject, so these
902 # are the ones we don't reject:
903 if ($cmd eq 'config') {
904 puts $self, grep(/$re/, keys %CONFIG_KEYS);
905 @spec = qw(add z|null get get-all unset unset-all
906 replace-all get-urlmatch
907 remove-section rename-section
908 name-only list|l edit|e
909 get-color-name get-colorbool);
912 # generate short/long names from Getopt::Long specs
913 puts $self, grep(/$re/, qw(--help -h -C), map {
914 if (s/[:=].+\z//) { # req/optional args, e.g output|o=i
915 } elsif (s/\+\z//) { # verbose|v+
917 # negation: mail! => no-mail|mail
918 s/([\w\-]+)/$1|no-$1/g
921 my $x = length > 1 ? "--$_" : "-$_";
922 $x eq $_cur ? () : $x;
923 } grep(!/_/, split(/\|/, $_, -1)) # help|h
924 } grep { $OPTDESC{"$_\t$cmd"} || $OPTDESC{$_} } @spec);
925 } elsif ($cmd eq 'config' && !@argv && !$CONFIG_KEYS{$cur}) {
926 puts $self, grep(/$re/, keys %CONFIG_KEYS);
929 # switch args (e.g. lei q -f mbox<TAB>)
930 if (($argv[-1] // $cur // '') =~ /\A--?([\w\-]+)\z/) {
931 my $opt = quotemeta $1;
933 my $v = $OPTDESC{$_};
934 my @v = ref($v) ? split(/\|/, $v->[0]) : ();
935 # get rid of ALL CAPS placeholder (e.g "OUT")
936 # (TODO: completion for external paths)
937 shift(@v) if scalar(@v) && uc($v[0]) eq $v[0];
939 } grep(/\A(?:[\w-]+\|)*$opt\b.*?(?:\t$cmd)?\z/, keys %OPTDESC);
941 if (my $cb = lazy_cb($self, $cmd, '_complete_')) {
942 puts $self, $cb->($self, @argv, $cur ? ($cur) : ());
944 # TODO: URLs, pathnames, OIDs, MIDs, etc... See optparse() for
949 my ($argv, $env) = @_;
950 my $argc = scalar @$argv;
951 my $buf = 'exec '.join("\0", scalar(@$argv), @$argv);
952 while (my ($k, $v) = each %$env) { $buf .= "\0$k=$v" };
958 if ($self->{ovv}->{fmt} =~ /\A(?:maildir)\z/) { # TODO: IMAP
959 refresh_watches($self);
961 my $mua = $self->{opt}->{mua} // return;
962 my $mfolder = $self->{ovv}->{dst};
963 my (@cmd, $replaced);
964 if ($mua =~ /\A(?:mutt|mailx|mail|neomutt)\z/) {
966 # TODO: help wanted: other common FOSS MUAs
968 require Text::ParseWords;
969 @cmd = Text::ParseWords::shellwords($mua);
970 # mutt uses '%f' for open-hook with compressed mbox, we follow
971 @cmd = map { $_ eq '%f' ? ($replaced = $mfolder) : $_ } @cmd;
973 push @cmd, $mfolder unless defined($replaced);
974 if ($self->{sock}) { # lei(1) client process runs it
975 # restore terminal: echo $query | lei q --stdin --mua=...
977 $io->[0] = $self->{1} if $self->{opt}->{stdin} && -t $self->{1};
978 send_exec_cmd($self, $io, \@cmd, {});
980 if ($self->{lxs} && $self->{au_done}) { # kick wait_startq
981 syswrite($self->{au_done}, 'q' x ($self->{lxs}->{jobs} // 0));
983 return unless -t $self->{2}; # XXX how to determine non-TUI MUAs?
984 $self->{opt}->{quiet} = 1;
985 delete $self->{-progress};
986 delete $self->{opt}->{verbose};
989 sub send_exec_cmd { # tell script/lei to execute a command
990 my ($self, $io, $cmd, $env) = @_;
991 my $sock = $self->{sock} // die 'lei client gone';
992 my $fds = [ map { fileno($_) } @$io ];
993 $send_cmd->($sock, $fds, exec_buf($cmd, $env), MSG_EOR);
996 sub poke_mua { # forces terminal MUAs to wake up and hopefully notice new mail
998 my $alerts = $self->{opt}->{alert} // return;
999 my $sock = $self->{sock};
1000 while (my $op = shift(@$alerts)) {
1001 if ($op eq ':WINCH') {
1002 # hit the process group that started the MUA
1003 send($sock, '-WINCH', MSG_EOR) if $sock;
1004 } elsif ($op eq ':bell') {
1006 } elsif ($op =~ /(?<!\\),/) { # bare ',' (not ',,')
1007 push @$alerts, split(/(?<!\\),/, $op);
1008 } elsif ($op =~ m!\A([/a-z0-9A-Z].+)!) {
1009 my $cmd = $1; # run an arbitrary command
1010 require Text::ParseWords;
1011 $cmd = [ Text::ParseWords::shellwords($cmd) ];
1012 send($sock, exec_buf($cmd, {}), MSG_EOR) if $sock;
1014 err($self, "W: unsupported --alert=$op"); # non-fatal
1019 my %path_to_fd = ('/dev/stdin' => 0, '/dev/stdout' => 1, '/dev/stderr' => 2);
1020 $path_to_fd{"/dev/fd/$_"} = $_ for (0..2);
1022 # this also normalizes the path
1024 my ($self, $path) = @_;
1025 $path = rel2abs($self, $path);
1027 $path_to_fd{$path} // (
1028 ($path =~ m!\A/(?:dev|proc/self)/fd/[0-9]+\z!) ?
1029 fail($self, "cannot open $path from daemon") : -1
1033 # caller needs to "-t $self->{1}" to check if tty
1035 my ($self, $new_env) = @_;
1036 my $fh = popen_rd([qw(git var GIT_PAGER)]);
1037 chomp(my $pager = <$fh> // '');
1038 close($fh) or warn "`git var PAGER' error: \$?=$?";
1039 return if $pager eq 'cat' || $pager eq '';
1041 $new_env->{LESS} //= 'FRX';
1042 $new_env->{LV} //= '-c';
1043 $new_env->{MORE} = $new_env->{LESS} if $^O eq 'freebsd';
1044 pipe(my ($r, $wpager)) or return warn "pipe: $!";
1045 my $rdr = { 0 => $r, 1 => $self->{1}, 2 => $self->{2} };
1046 my $pgr = [ undef, @$rdr{1, 2} ];
1047 my $env = $self->{env};
1048 if ($self->{sock}) { # lei(1) process runs it
1049 delete @$new_env{keys %$env}; # only set iff unset
1050 send_exec_cmd($self, [ @$rdr{0..2} ], [$pager], $new_env);
1052 die 'BUG: start_pager w/o socket';
1054 $self->{1} = $wpager;
1055 $self->{2} = $wpager if -t $self->{2};
1056 $env->{GIT_PAGER_IN_USE} = 'true'; # we may spawn git
1057 $self->{pgr} = $pgr;
1060 # display a message for user before spawning full-screen $VISUAL
1062 my ($self, @msg) = @_;
1063 return $self->err(@msg) unless $self->{sock} && -t $self->{2};
1064 start_pager($self, { LESS => 'RX' }); # no 'F' so we prompt
1065 print { $self->{2} } @msg;
1066 $self->{2}->autoflush(1);
1068 send($self->{sock}, 'wait', MSG_EOR); # wait for user to quit pager
1073 my $pgr = delete($self->{pgr}) or return;
1074 $self->{2} = $pgr->[2];
1075 close(delete($self->{1})) if $self->{1};
1076 $self->{1} = $pgr->[1];
1079 sub accept_dispatch { # Listener {post_accept} callback
1080 my ($sock) = @_; # ignore other
1081 $sock->autoflush(1);
1082 my $self = bless { sock => $sock }, __PACKAGE__;
1083 vec(my $rvec = '', fileno($sock), 1) = 1;
1084 select($rvec, undef, undef, 60) or
1085 return send($sock, 'timed out waiting to recv FDs', MSG_EOR);
1086 # (4096 * 33) >MAX_ARG_STRLEN
1087 my @fds = $recv_cmd->($sock, my $buf, 4096 * 33) or return; # EOF
1088 if (!defined($fds[0])) {
1089 warn(my $msg = "recv_cmd failed: $!");
1090 return send($sock, $msg, MSG_EOR);
1094 open($self->{$i++}, '+<&=', $fd) and next;
1095 send($sock, "open(+<&=$fd) (FD=$i): $!", MSG_EOR);
1097 $i == 4 or return send($sock, 'not enough FDs='.($i-1), MSG_EOR)
1099 # $ENV_STR = join('', map { "\0$_=$ENV{$_}" } keys %ENV);
1100 # $buf = "$argc\0".join("\0", @ARGV).$ENV_STR."\0\0";
1101 substr($buf, -2, 2, '') eq "\0\0" or # s/\0\0\z//
1102 return send($sock, 'request command truncated', MSG_EOR);
1103 my ($argc, @argv) = split(/\0/, $buf, -1);
1105 my %env = map { split(/=/, $_, 2) } splice(@argv, $argc);
1106 $self->{env} = \%env;
1107 eval { dispatch($self, @argv) };
1108 send($sock, $@, MSG_EOR) if $@;
1113 delete $self->{-progress};
1114 _drop_wq($self) if $self->{failed};
1115 $self->close if $self->{-event_init_done}; # PublicInbox::DS::close
1118 # for long-running results
1121 local %ENV = %{$self->{env}};
1122 local $current_lei = $self;
1125 while (my @fds = $recv_cmd->($self->{sock}, $buf, 4096)) {
1126 if (scalar(@fds) == 1 && !defined($fds[0])) {
1127 return if $! == EAGAIN;
1128 next if $! == EINTR;
1129 last if $! == ECONNRESET;
1132 for (@fds) { open my $rfh, '+<&=', $_ }
1135 _drop_wq($self); # EOF, client disconnected
1137 } elsif ($buf =~ /\A(STOP|CONT)\z/) {
1138 for my $wq (grep(defined, @$self{@WQ_KEYS})) {
1139 $wq->wq_kill($buf) or $wq->wq_kill_old($buf);
1142 die "unrecognized client signal: $buf";
1146 eval { $self->fail($err) };
1151 sub event_step_init {
1153 my $sock = $self->{sock} or return;
1154 $self->{-event_init_done} //= do { # persist til $ops done
1156 $self->SUPER::new($sock, EPOLLIN|EPOLLET);
1163 sub oldset { $oldset }
1165 sub dump_and_clear_log {
1166 if (defined($errors_log) && -s STDIN && seek(STDIN, 0, SEEK_SET)) {
1167 openlog('lei-daemon', 'pid,nowait,nofatal,ndelay', 'user');
1168 chomp(my @lines = <STDIN>);
1169 truncate(STDIN, 0) or
1170 syslog('warning', "ftruncate (%s): %m", $errors_log);
1171 for my $l (@lines) { syslog('warning', '%s', $l) }
1172 closelog(); # don't share across fork
1178 my $lei = bless { env => { %{$cfg->{-env}} } }, __PACKAGE__;
1179 open($lei->{0}, '<&', \*STDIN) or die "dup 0: $!";
1180 open($lei->{1}, '>>&', \*STDOUT) or die "dup 1: $!";
1181 open($lei->{2}, '>>&', \*STDERR) or die "dup 2: $!";
1182 open($lei->{3}, '/') or die "open /: $!";
1184 socketpair($x, $y, AF_UNIX, SOCK_SEQPACKET, 0) or die "socketpair: $!";
1186 require PublicInbox::LeiSelfSocket;
1187 PublicInbox::LeiSelfSocket->new($y); # adds to event loop
1191 sub dir_idle_handler ($) { # PublicInbox::DirIdle callback
1192 my ($ev) = @_; # Linux::Inotify2::Event or duck type
1193 my $fn = $ev->fullname;
1194 if ($fn =~ m!\A(.+)/(new|cur)/([^/]+)\z!) { # Maildir file
1195 my ($mdir, $nc, $bn) = ($1, $2, $3);
1196 $nc = '' if $ev->IN_DELETE;
1197 for my $f (keys %{$MDIR2CFGPATH->{$mdir} // {}}) {
1198 my $cfg = $PATH2CFG{$f} // next;
1200 my $lei = cfg2lei($cfg);
1201 $lei->dispatch('note-event',
1202 "maildir:$mdir", $nc, $bn, $fn);
1204 warn "E: note-event $f: $@\n" if $@;
1207 if ($ev->can('cancel') && ($ev->IN_IGNORE || $ev->IN_UNMOUNT)) {
1210 if ($fn =~ m!\A(.+)/(?:new|cur)\z! && !-e $fn) {
1211 delete $MDIR2CFGPATH->{$1};
1213 if (!-e $fn) { # config file or Maildir gone
1214 for my $cfgpaths (values %$MDIR2CFGPATH) {
1215 delete $cfgpaths->{$fn};
1217 delete $PATH2CFG{$fn};
1221 # lei(1) calls this when it can't connect
1223 my ($path, $errno, $narg) = @_;
1224 local ($errors_log, $listener);
1225 my ($sock_dir) = ($path =~ m!\A(.+?)/[^/]+\z!);
1226 $errors_log = "$sock_dir/errors.log";
1227 my $addr = pack_sockaddr_un($path);
1228 my $lk = bless { lock_path => $errors_log }, 'PublicInbox::Lock';
1229 umask(077) // die("umask(077): $!");
1231 socket($listener, AF_UNIX, SOCK_SEQPACKET, 0) or die "socket: $!";
1232 if ($errno == ECONNREFUSED || $errno == ENOENT) {
1233 return if connect($listener, $addr); # another process won
1234 if ($errno == ECONNREFUSED && -S $path) {
1235 unlink($path) or die "unlink($path): $!";
1238 $! = $errno; # allow interpolation to stringify in die
1239 die "connect($path): $!";
1241 bind($listener, $addr) or die "bind($path): $!";
1244 my @st = stat($path) or die "stat($path): $!";
1245 my $dev_ino_expect = pack('dd', $st[0], $st[1]); # dev+ino
1246 local $oldset = PublicInbox::DS::block_signals();
1248 $send_cmd = PublicInbox::Spawn->can('send_cmd4');
1249 $recv_cmd = PublicInbox::Spawn->can('recv_cmd4') // do {
1250 require PublicInbox::CmdIPC4;
1251 $send_cmd = PublicInbox::CmdIPC4->can('send_cmd4');
1252 PublicInbox::CmdIPC4->can('recv_cmd4');
1255 $recv_cmd or die <<"";
1256 (Socket::MsgHdr || Inline::C) missing/unconfigured (narg=$narg);
1258 require PublicInbox::Listener;
1259 require PublicInbox::PktOp;
1260 (-p STDOUT) or die "E: stdout must be a pipe\n";
1261 open(STDIN, '+>>', $errors_log) or die "open($errors_log): $!";
1262 STDIN->autoflush(1);
1263 dump_and_clear_log();
1264 POSIX::setsid() > 0 or die "setsid: $!";
1265 my $pid = fork // die "fork: $!";
1267 $0 = "lei-daemon $path";
1269 local $MDIR2CFGPATH;
1270 $listener->blocking(0);
1272 my $pil = PublicInbox::Listener->new($listener, \&accept_dispatch);
1274 my (undef, $eof_p) = PublicInbox::PktOp->pair;
1276 $exit_code //= shift;
1277 eval 'PublicInbox::LeiNoteEvent::flush_task()';
1278 my $lis = $pil or exit($exit_code);
1279 # closing eof_p triggers \&noop wakeup
1280 $listener = $eof_p = $pil = $path = undef;
1281 $lis->close; # DS::close
1282 PublicInbox::DS->SetLoopTimeout(1000);
1286 CHLD => \&PublicInbox::DS::enqueue_reap,
1294 my $sigfd = PublicInbox::Sigfd->new($sig, SFD_NONBLOCK);
1295 local @SIG{keys %$sig} = values(%$sig) unless $sigfd;
1297 local $SIG{PIPE} = 'IGNORE';
1298 require PublicInbox::DirIdle;
1299 local $dir_idle = PublicInbox::DirIdle->new([$sock_dir], sub {
1300 # just rely on wakeup to hit PostLoopCallback set below
1301 dir_idle_handler($_[0]) if $_[0]->fullname ne $path;
1304 undef $sigfd; # unref, already in DS::DescriptorMap
1306 # wake up every second to accept signals if we don't
1307 # have signalfd or IO::KQueue:
1308 PublicInbox::DS::sig_setmask($oldset);
1309 PublicInbox::DS->SetLoopTimeout(1000);
1311 PublicInbox::DS->SetPostLoopCallback(sub {
1312 my ($dmap, undef) = @_;
1313 if (@st = defined($path) ? stat($path) : ()) {
1314 if ($dev_ino_expect ne pack('dd', $st[0], $st[1])) {
1315 warn "$path dev/ino changed, quitting\n";
1318 } elsif (defined($path)) { # ENOENT is common
1319 warn "stat($path): $!, quitting ...\n" if $! != ENOENT;
1323 return 1 if defined($path);
1326 for my $s (values %$dmap) {
1327 $s->can('busy') or next;
1328 if ($s->busy($now)) {
1334 $n; # true: continue, false: stop
1337 # STDIN was redirected to /dev/null above, closing STDERR and
1338 # STDOUT will cause the calling `lei' client process to finish
1339 # reading the <$daemon> pipe.
1340 local $SIG{__WARN__} = sub {
1341 $current_lei ? err($current_lei, @_) : warn(
1342 strftime('%Y-%m-%dT%H:%M:%SZ', gmtime(time))," $$ ", @_);
1344 open STDERR, '>&STDIN' or die "redirect stderr failed: $!";
1345 open STDOUT, '>&STDIN' or die "redirect stdout failed: $!";
1346 # $daemon pipe to `lei' closed, main loop begins:
1347 eval { PublicInbox::DS->EventLoop };
1348 warn "event loop error: $@\n" if $@;
1349 dump_and_clear_log();
1350 exit($exit_code // 0);
1353 sub busy { 1 } # prevent daemon-shutdown if client is connected
1355 # ensures stdout hits the FS before sock disconnects so a client
1356 # can immediately reread it
1359 if (my $counters = delete $self->{counters}) {
1360 for my $k (sort keys %$counters) {
1361 my $nr = $counters->{$k};
1362 $self->child_error(0, "$nr $k messages");
1365 $self->{1}->autoflush(1) if $self->{1};
1367 dump_and_clear_log();
1368 # preserve $? for ->fail or ->x_it code
1371 sub wq_done_wait { # dwaitpid callback
1372 my ($arg, $pid) = @_;
1373 my ($wq, $lei) = @$arg;
1374 my $err_type = $lei->{-err_type};
1375 $? and $lei->child_error($?,
1376 $err_type ? "$err_type errors during $lei->{cmd}" : ());
1382 my $dh = $lei->{3} // die 'BUG: lei->{3} (CWD) gone';
1383 chdir($dh) || $lei->fail("fchdir: $!");
1386 sub wq_eof { # EOF callback for main daemon
1388 my $wq1 = delete $lei->{wq1} // return $lei->fail; # already failed
1389 $wq1->wq_wait_old($wq1->can('_wq_done_wait') // \&wq_done_wait, $lei);
1392 sub watch_state_ok ($) {
1393 my ($state) = $_[-1]; # $_[0] may be $self
1394 $state =~ /\Apause|(?:import|index|tag)-(?:ro|rw)\z/;
1397 sub cancel_maildir_watch ($$) {
1398 my ($d, $cfg_f) = @_;
1399 my $w = delete $MDIR2CFGPATH->{$d}->{$cfg_f};
1400 scalar(keys %{$MDIR2CFGPATH->{$d}}) or
1401 delete $MDIR2CFGPATH->{$d};
1402 for my $x (@{$w // []}) { $x->cancel }
1405 sub add_maildir_watch ($$) {
1406 my ($d, $cfg_f) = @_;
1407 if (!exists($MDIR2CFGPATH->{$d}->{$cfg_f})) {
1408 my @w = $dir_idle->add_watches(["$d/cur", "$d/new"], 1);
1409 push @{$MDIR2CFGPATH->{$d}->{$cfg_f}}, @w if @w;
1413 sub refresh_watches {
1415 my $cfg = _lei_cfg($lei) or return;
1416 my $old = $cfg->{-watches};
1417 my $watches = $cfg->{-watches} //= {};
1419 my $cfg_f = $cfg->{'-f'};
1420 for my $w (grep(/\Awatch\..+\.state\z/, keys %$cfg)) {
1421 my $url = substr($w, length('watch.'), -length('.state'));
1422 require PublicInbox::LeiWatch;
1423 $watches->{$url} //= PublicInbox::LeiWatch->new($url);
1424 $seen{$url} = undef;
1425 my $state = $cfg->get_1("watch.$url", 'state');
1426 if (!watch_state_ok($state)) {
1427 $lei->err("watch.$url.state=$state not supported");
1430 if ($url =~ /\Amaildir:(.+)/i) {
1431 my $d = canonpath_harder($1);
1432 if ($state eq 'pause') {
1433 cancel_maildir_watch($d, $cfg_f);
1435 add_maildir_watch($d, $cfg_f);
1437 } else { # TODO: imap/nntp/jmap
1438 $lei->child_error(0, "E: watch $url not supported, yet")
1442 # add all known Maildir folders as implicit watches
1443 my $lms = $lei->lms;
1445 $lms->lms_write_prepare;
1446 for my $d ($lms->folders('maildir:')) {
1447 substr($d, 0, length('maildir:')) = '';
1449 # fixup old bugs while we're iterating:
1450 my $cd = canonpath_harder($d);
1451 my $f = "maildir:$cd";
1452 $lms->rename_folder("maildir:$d", $f) if $d ne $cd;
1453 next if $watches->{$f}; # may be set to pause
1454 require PublicInbox::LeiWatch;
1455 $watches->{$f} = PublicInbox::LeiWatch->new($f);
1457 add_maildir_watch($cd, $cfg_f);
1460 if ($old) { # cull old non-existent entries
1461 for my $url (keys %$old) {
1462 next if exists $seen{$url};
1463 delete $old->{$url};
1464 if ($url =~ /\Amaildir:(.+)/i) {
1465 my $d = canonpath_harder($1);
1466 cancel_maildir_watch($d, $cfg_f);
1467 } else { # TODO: imap/nntp/jmap
1468 $lei->child_error(0, "E: watch $url TODO");
1472 if (scalar keys %$watches) {
1473 $cfg->{-env} //= { %{$lei->{env}}, PWD => '/' }; # for cfg2lei
1475 delete $cfg->{-watches};
1479 # TODO: support SHA-256
1482 $eml->header_set($_) for @PublicInbox::Import::UNWANTED_HEADERS;
1487 my ($lei, $rw) = @_;
1488 my $sto = $lei->{sto} // _lei_store($lei) // return;
1489 require PublicInbox::LeiMailSync;
1490 my $f = "$sto->{priv_eidx}->{topdir}/mail_sync.sqlite3";
1491 (-f $f || $rw) ? PublicInbox::LeiMailSync->new($f) : undef;
1494 sub sto_done_request {
1495 my ($lei, $sock) = @_;
1497 if ($sock //= $lei->{sock}) { # issue, async wait
1498 $lei->{sto}->wq_io_do('done', [ $sock ]);
1499 } else { # forcibly wait
1500 my $wait = $lei->{sto}->wq_do('done');
1503 $lei->err($@) if $@;
1508 my $ret = eval { PublicInbox::Config->git_config_dump($f, $lei->{2}) };