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;
26 use Time::HiRes qw(stat); # ctime comparisons for config cache
27 use File::Path qw(mkpath);
29 our $quit = \&CORE::exit;
30 our ($current_lei, $errors_log, $listener);
31 my ($recv_cmd, $send_cmd);
32 my $GLP = Getopt::Long::Parser->new;
33 $GLP->configure(qw(gnu_getopt no_ignore_case auto_abbrev));
34 my $GLP_PASS = Getopt::Long::Parser->new;
35 $GLP_PASS->configure(qw(gnu_getopt no_ignore_case auto_abbrev pass_through));
37 our %PATH2CFG; # persistent for socket daemon
39 # TBD: this is a documentation mechanism to show a subcommand
40 # (may) pass options through to another command:
41 sub pass_through { $GLP_PASS }
45 my ($spec, $re_str) = @_; # 'limit|n=i', '([0-9]+)'
46 my ($key) = ($spec =~ m/\A([a-z]+)/g);
47 my $cb = sub { # Getopt::Long "<>" catch-all handler
49 if ($arg =~ /\A-($re_str)\z/) {
51 } elsif ($arg eq '--') { # "--" arg separator, ignore first
52 push @{$OPT->{-argv}}, $arg if $OPT->{'--'}++;
53 # lone (single) dash is handled elsewhere
54 } elsif (substr($arg, 0, 1) eq '-') {
56 push @{$OPT->{-argv}}, $arg;
58 die "bad argument: $arg\n";
61 push @{$OPT->{-argv}}, $arg;
64 ($spec, '<>' => $cb, $GLP_PASS) # for Getopt::Long
69 return $p if index($p, '/') == 0; # already absolute
70 my $pwd = $self->{env}->{PWD};
72 my $cwd = $self->{3} // getcwd() // die "getcwd(PWD=$pwd): $!";
73 if (my @st_pwd = stat($pwd)) {
74 my @st_cwd = stat($cwd) or die "stat($cwd): $!";
75 "@st_pwd[1,0]" eq "@st_cwd[1,0]" or
76 $self->{env}->{PWD} = $pwd = $cwd;
77 } else { # PWD was invalid
78 delete $self->{env}->{PWD};
82 $pwd //= $self->{env}->{PWD} = getcwd() // die "getcwd(PWD=$pwd): $!";
83 File::Spec->rel2abs($p, $pwd);
88 rel2abs($self, ($self->{env}->{XDG_DATA_HOME} //
89 ($self->{env}->{HOME} // '/nonexistent').'/.local/share')
93 sub _config_path ($) {
95 rel2abs($self, ($self->{env}->{XDG_CONFIG_HOME} //
96 ($self->{env}->{HOME} // '/nonexistent').'/.config')
101 # TODO: drop underscore variants everywhere, they're undocumented
102 qw(fsync|sync! jobs|j=i indexlevel|L=s compact
103 max_size|max-size=s sequential_shard|sequential-shard
104 batch_size|batch-size=s skip-docdata)
107 # we generate shell completion + help using %CMD and %OPTDESC,
108 # see lei__complete() and PublicInbox::LeiHelp
109 # command => [ positional_args, 1-line description, Getopt::Long option spec ]
110 our %CMD = ( # sorted in order of importance/use:
111 'q' => [ '--stdin|SEARCH_TERMS...', 'search for messages matching terms', qw(
112 save-as=s output|mfolder|o=s format|f=s dedupe|d=s threads|t augment|a
113 sort|s=s reverse|r offset=i remote! local! external! pretty
114 include|I=s@ exclude=s@ only=s@ jobs|j=s globoff|g stdin|
115 alert=s@ mua=s no-torsocks torsocks=s verbose|v+ quiet|q),
116 PublicInbox::LeiQuery::curl_opt(), opt_dash('limit|n=i', '[0-9]+') ],
118 'show' => [ 'MID|OID', 'show a given object (Message-ID or object ID)',
119 qw(type=s solve! format|f=s dedupe|d=s threads|t remote local!),
120 pass_through('git show') ],
122 'add-external' => [ 'LOCATION',
123 'add/set priority of a publicinbox|extindex for extra matches',
124 qw(boost=i c=s@ mirror=s no-torsocks torsocks=s inbox-version=i),
125 qw(quiet|q verbose|v+),
126 index_opt(), PublicInbox::LeiQuery::curl_opt() ],
127 'ls-external' => [ '[FILTER]', 'list publicinbox|extindex locations',
128 qw(format|f=s z|0 globoff|g invert-match|v local remote) ],
129 'forget-external' => [ 'LOCATION...|--prune',
130 'exclude further results from a publicinbox|extindex',
133 'ls-query' => [ '[FILTER...]', 'list saved search queries',
134 qw(name-only format|f=s z) ],
135 'rm-query' => [ 'QUERY_NAME', 'remove a saved search' ],
136 'mv-query' => [ qw(OLD_NAME NEW_NAME), 'rename a saved search' ],
138 'plonk' => [ '--threads|--from=IDENT',
139 'exclude mail matching From: or threads from non-Message-ID searches',
140 qw(stdin| threads|t from|f=s mid=s oid=s) ],
141 'mark' => [ 'MESSAGE_FLAGS...',
142 'set/unset keywords on message(s) from stdin',
143 qw(stdin| oid=s exact by-mid|mid:s) ],
144 'forget' => [ '[--stdin|--oid=OID|--by-mid=MID]',
145 "exclude message(s) on stdin from `q' search results",
146 qw(stdin| oid=s exact by-mid|mid:s quiet|q) ],
148 'purge-mailsource' => [ 'LOCATION|--all',
149 'remove imported messages from IMAP, Maildirs, and MH',
150 qw(exact! all jobs:i indexed) ],
152 # code repos are used for `show' to solve blobs from patch mails
153 'add-coderepo' => [ 'DIRNAME', 'add or set priority of a git code repo',
155 'ls-coderepo' => [ '[FILTER_TERMS...]',
156 'list known code repos', qw(format|f=s z) ],
157 'forget-coderepo' => [ 'DIRNAME',
158 'stop using repo to solve blobs from patches',
161 'add-watch' => [ 'LOCATION', 'watch for new messages and flag changes',
162 qw(import! kw|keywords|flags! interval=s recursive|r
163 exclude=s include=s) ],
164 'ls-watch' => [ '[FILTER...]', 'list active watches with numbers and status',
166 'pause-watch' => [ '[WATCH_NUMBER_OR_FILTER]', qw(all local remote) ],
167 'resume-watch' => [ '[WATCH_NUMBER_OR_FILTER]', qw(all local remote) ],
168 'forget-watch' => [ '{WATCH_NUMBER|--prune}', 'stop and forget a watch',
171 'import' => [ 'LOCATION...|--stdin',
172 'one-time import/update from URL or filesystem',
173 qw(stdin| offset=i recursive|r exclude=s include|I=s
174 format|f=s kw|keywords|flags!),
176 'convert' => [ 'LOCATION...|--stdin',
177 'one-time conversion from URL or filesystem to another format',
178 qw(stdin| in-format|F=s out-format|f=s output|mfolder|o=s quiet|q
181 'config' => [ '[...]', sub {
182 'git-config(1) wrapper for '._config_path($_[0]);
183 }, qw(config-file|system|global|file|f=s), # for conflict detection
184 pass_through('git config') ],
185 'init' => [ '[DIRNAME]', sub {
186 "initialize storage, default: "._store_path($_[0]);
188 'daemon-kill' => [ '[-SIGNAL]', 'signal the lei-daemon',
189 opt_dash('signal|s=s', '[0-9]+|(?:[A-Z][A-Z0-9]+)') ],
190 'daemon-pid' => [ '', 'show the PID of the lei-daemon' ],
191 'help' => [ '[SUBCOMMAND]', 'show help' ],
193 # XXX do we need this?
194 # 'git' => [ '[ANYTHING...]', 'git(1) wrapper', pass_through('git') ],
196 'reorder-local-store-and-break-history' => [ '[REFNAME]',
197 'rewrite git history in an attempt to improve compression',
200 # internal commands are prefixed with '_'
201 '_complete' => [ '[...]', 'internal shell completion helper',
202 pass_through('everything') ],
205 # switch descriptions, try to keep consistent across commands
206 # $spec: Getopt::Long option specification
207 # $spec => [@ALLOWED_VALUES (default is first), $description],
208 # $spec => $description
209 # "$SUB_COMMAND TAB $spec" => as above
210 my $stdin_formats = [ 'MAIL_FORMAT|eml|mboxrd|mboxcl2|mboxcl|mboxo',
211 'specify message input format' ];
212 my $ls_format = [ 'OUT|plain|json|null', 'listing output format' ];
214 # we use \x{a0} (non-breaking SP) to avoid wrapping in PublicInbox::LeiHelp
216 'help|h' => 'show this built-in help',
217 'quiet|q' => 'be quiet',
218 'globoff|g' => "do not match locations using '*?' wildcards ".
219 "and\xa0'[]'\x{a0}ranges",
220 'verbose|v+' => 'be more verbose',
221 'solve!' => 'do not attempt to reconstruct blobs from emails',
222 'torsocks=s' => ['VAL|auto|no|yes',
223 'whether or not to wrap git and curl commands with torsocks'],
224 'no-torsocks' => 'alias for --torsocks=no',
225 'save-as=s' => ['NAME', 'save a search terms by given name'],
227 'type=s' => [ 'any|mid|git', 'disambiguate type' ],
229 'dedupe|d=s' => ['STRATEGY|content|oid|mid|none',
230 'deduplication strategy'],
231 'show threads|t' => 'display entire thread a message belongs to',
233 'return all messages in the same threads as the actual match(es)',
234 'alert=s@' => ['CMD,:WINCH,:bell,<any command>',
235 'run command(s) or perform ops when done writing to output ' .
236 '(default: ":WINCH,:bell" with --mua and Maildir/IMAP output, ' .
237 'nothing otherwise)' ],
239 'augment|a' => 'augment --output destination instead of clobbering',
241 'output|mfolder|o=s' => [ 'MFOLDER',
242 "destination (e.g.\xa0`/path/to/Maildir', ".
243 "or\xa0`-'\x{a0}for\x{a0}stdout)" ],
245 "MUA to run on --output Maildir or mbox (e.g.\xa0`mutt\xa0-f\xa0%f')" ],
247 'show format|f=s' => [ 'OUT|plain|raw|html|mboxrd|mboxcl2|mboxcl',
248 'message/object output format' ],
249 'mark format|f=s' => $stdin_formats,
250 'forget format|f=s' => $stdin_formats,
252 'add-external inbox-version=i' => [ 'NUM|1|2',
253 'force a public-inbox version with --mirror'],
254 'add-external mirror=s' => [ 'URL', 'mirror a public-inbox'],
256 # public-inbox-index options
257 'add-external jobs|j=i' => 'set parallelism when indexing after --mirror',
258 'fsync!' => 'speed up indexing after --mirror, risk index corruption',
259 'compact' => 'run compact index after mirroring',
260 'indexlevel|L=s' => [ 'LEVEL|full|medium|basic',
261 "indexlevel with --mirror (default: full)" ],
262 'max_size|max-size=s' => [ 'SIZE',
263 'do not index messages larger than SIZE (default: infinity)' ],
264 'batch_size|batch-size=s' => [ 'SIZE',
265 'flush changes to OS after given number of bytes (default: 1m)' ],
266 'sequential_shard|sequential-shard' =>
267 'index Xapian shards sequentially for slow storage',
269 'drop compatibility w/ public-inbox <1.6 to save ~1.5% space',
272 'OUT|maildir|mboxrd|mboxcl2|mboxcl|mboxo|html|json|jsonl|concatjson',
273 'specify output format, default depends on --output'],
274 'q exclude=s@' => [ 'LOCATION',
275 'exclude specified external(s) from search' ],
276 'q include|I=s@' => [ 'LOCATION',
277 'include specified external(s) in search' ],
278 'q only=s@' => [ 'LOCATION',
279 'only use specified external(s) for search' ],
281 'q jobs=s' => [ '[SEARCH_JOBS][,WRITER_JOBS]',
282 'control number of search and writer jobs' ],
284 'import format|f=s' => $stdin_formats,
286 'ls-query format|f=s' => $ls_format,
287 'ls-external format|f=s' => $ls_format,
289 'limit|n=i@' => ['NUM', 'limit on number of matches (default: 10000)' ],
290 'offset=i' => ['OFF', 'search result offset (default: 0)'],
292 'sort|s=s' => [ 'VAL|received|relevance|docid',
293 "order of results is `--output'-dependent"],
294 'reverse|r' => 'reverse search results', # like sort(1)
296 'boost=i' => 'increase/decrease priority of results (default: 0)',
298 'local' => 'limit operations to the local filesystem',
299 'local!' => 'exclude results from the local filesystem',
300 'remote' => 'limit operations to those requiring network access',
301 'remote!' => 'prevent operations requiring network access',
303 'mid=s' => 'specify the Message-ID of a message',
304 'oid=s' => 'specify the git object ID of a message',
306 'recursive|r' => 'scan directories/mailboxes/newsgroups recursively',
307 'exclude=s' => 'exclude mailboxes/newsgroups based on pattern',
308 'include=s' => 'include mailboxes/newsgroups based on pattern',
310 'exact' => 'operate on exact header matches only',
311 'exact!' => 'rely on content match instead of exact header matches',
313 'by-mid|mid:s' => [ 'MID', 'match only by Message-ID, ignoring contents' ],
315 'kw|keywords|flags!' => 'disable/enable importing flags',
317 # xargs, env, use "-0", git(1) uses "-z". We support z|0 everywhere
318 'z|0' => 'use NUL \\0 instead of newline (CR) to delimit lines',
320 'signal|s=s' => [ 'SIG', 'signal to send lei-daemon (default: TERM)' ],
324 'leistore.dir' => 'top-level storage location',
327 my @WQ_KEYS = qw(lxs l2m imp mrr cnv auth); # internal workers
329 # pronounced "exit": x_it(1 << 8) => exit(1); x_it(13) => SIGPIPE
331 my ($self, $code) = @_;
332 # make sure client sees stdout before exit
333 $self->{1}->autoflush(1) if $self->{1};
334 dump_and_clear_log();
335 if (my $s = $self->{pkt_op_p} // $self->{sock}) {
336 send($s, "x_it $code", MSG_EOR);
337 } elsif ($self->{oneshot}) {
338 # don't want to end up using $? from child processes
339 for my $f (@WQ_KEYS) {
340 my $wq = delete $self->{$f} or next;
343 # cleanup anything that has tempfiles or open file handles
345 delete @$self{qw(ovv dedupe sto cfg)};
346 if (my $signum = ($code & 127)) { # usually SIGPIPE (13)
347 $SIG{PIPE} = 'DEFAULT'; # $SIG{$signum} doesn't work
349 sleep(1) while 1; # wait for signal
353 } # else ignore if client disconnected
358 my $err = $self->{2} // ($self->{pgr} // [])->[2] // *STDERR{GLOB};
359 my @eor = (substr($_[-1]//'', -1, 1) eq "\n" ? () : ("\n"));
360 print $err @_, @eor and return;
361 my $old_err = delete $self->{2};
362 close($old_err) if $! == EPIPE && $old_err;
363 $err = $self->{2} = ($self->{pgr} // [])->[2] // *STDERR{GLOB};
364 print $err @_, @eor or print STDERR @_, @eor;
367 sub qerr ($;@) { $_[0]->{opt}->{quiet} or err(shift, @_) }
369 sub fail_handler ($;$$) {
370 my ($lei, $code, $io) = @_;
371 for my $f (@WQ_KEYS) {
372 my $wq = delete $lei->{$f} or next;
373 $wq->wq_wait_old(undef, $lei) if $wq->wq_kill_old; # lei-daemon
375 close($io) if $io; # needed to avoid warnings on SIGPIPE
376 x_it($lei, $code // (1 << 8));
379 sub sigpipe_handler { # handles SIGPIPE from @WQ_KEYS workers
380 fail_handler($_[0], 13, delete $_[0]->{1});
383 # PublicInbox::OnDestroy callback for SIGINT to take out the entire pgid
386 dwaitpid($pgid) if kill('-INT', $pgid);
390 my ($self, $buf, $exit_code) = @_;
391 err($self, $buf) if defined $buf;
392 # calls fail_handler:
393 send($self->{pkt_op_p}, '!', MSG_EOR) if $self->{pkt_op_p};
394 x_it($self, ($exit_code // 1) << 8);
398 sub check_input_format ($;$$) {
399 my ($self, $files, $opt_key) = @_;
400 $opt_key //= 'format';
401 my $fmt = $self->{opt}->{$opt_key};
403 my $err = $files ? "regular file(s):\n@$files" : '--stdin';
404 return fail($self, "--$opt_key unset for $err");
406 return 1 if $fmt eq 'eml';
407 # XXX: should this handle {gz,bz2,xz}? that's currently in LeiToMail
408 require PublicInbox::MboxReader;
409 PublicInbox::MboxReader->can($fmt) ||
410 fail($self, "--$opt_key=$fmt unrecognized");
415 return if print { $self->{1} // return } @_; # likely
416 return note_sigpipe($self, 1) if $! == EPIPE;
417 my $err = "error writing to stdout: $!";
422 sub puts ($;@) { out(shift, map { "$_\n" } @_) }
424 sub child_error { # passes non-fatal curl exit codes to user
425 my ($self, $child_error, $msg) = @_; # child_error is $?
426 $self->err($msg) if $msg;
427 if (my $s = $self->{pkt_op_p} // $self->{sock}) {
428 # send to the parent lei-daemon or to lei(1) client
429 send($s, "child_error $child_error", MSG_EOR);
430 } elsif (!$PublicInbox::DS::in_loop) {
431 $self->{child_error} = $child_error;
432 } # else noop if client disconnected
435 sub note_sigpipe { # triggers sigpipe_handler
436 my ($self, $fd) = @_;
437 close(delete($self->{$fd})); # explicit close silences Perl warning
438 send($self->{pkt_op_p}, '|', MSG_EOR) if $self->{pkt_op_p};
442 sub lei_atfork_child {
443 my ($self, $persist) = @_;
444 # we need to explicitly close things which are on stack
446 my @io = delete @$self{qw(0 1 2 sock)};
447 unless ($self->{oneshot}) {
453 delete @$self{qw(cnv)};
454 for (delete @$self{qw(3 old_1 au_done)}) {
455 close($_) if defined($_);
457 if (my $op_c = delete $self->{pkt_op_c}) {
458 close(delete $op_c->{sock});
460 if (my $pgr = delete $self->{pgr}) {
461 close($_) for (@$pgr[1,2]);
463 close $listener if $listener;
467 $quit = \&CORE::exit;
468 $current_lei = $persist ? undef : $self; # for SIG{__WARN__}
472 my ($lei, $wq, $ident, $jobs, $ops) = @_;
474 '!' => [ $lei->can('fail_handler'), $lei ],
475 '|' => [ $lei->can('sigpipe_handler'), $lei ],
476 'x_it' => [ $lei->can('x_it'), $lei ],
477 'child_error' => [ $lei->can('child_error'), $lei ],
480 require PublicInbox::PktOp;
481 ($lei->{pkt_op_c}, $lei->{pkt_op_p}) = PublicInbox::PktOp->pair($ops);
482 $wq->wq_workers_start($ident, $jobs, $lei->oldset, { lei => $lei });
483 delete $lei->{pkt_op_p};
484 my $op = delete $lei->{pkt_op_c};
485 $lei->event_step_init;
486 # oneshot needs $op, daemon-mode uses DS->EventLoop to handle $op
487 $lei->{oneshot} ? $op : undef;
491 require PublicInbox::LeiHelp;
492 PublicInbox::LeiHelp::call($_[0], $_[1], \%CMD, \%OPTDESC);
496 my ($self, $cmd, $argv) = @_;
497 # allow _complete --help to complete, not show help
498 return 1 if substr($cmd, 0, 1) eq '_';
500 $OPT = $self->{opt} = {};
501 my $info = $CMD{$cmd} // [ '[...]' ];
502 my ($proto, undef, @spec) = @$info;
503 my $glp = ref($spec[-1]) eq ref($GLP) ? pop(@spec) : $GLP;
504 push @spec, qw(help|h);
506 if ($spec[0] =~ s/\|\z//s) { # "stdin|" or "clear|" allows "-" alias
507 $lone_dash = $spec[0];
508 $OPT->{$spec[0]} = \(my $var);
509 push @spec, '' => \$var;
511 $glp->getoptionsfromarray($argv, $OPT, @spec) or
512 return _help($self, "bad arguments or options for $cmd");
513 return _help($self) if $OPT->{help};
515 push @$argv, @{$OPT->{-argv}} if defined($OPT->{-argv});
517 # "-" aliases "stdin" or "clear"
518 $OPT->{$lone_dash} = ${$OPT->{$lone_dash}} if defined $lone_dash;
521 my $POS_ARG = '[A-Z][A-Z0-9_]+';
523 my @args = split(/ /, $proto);
524 for my $var (@args) {
525 if ($var =~ /\A$POS_ARG\.\.\.\z/o) { # >= 1 args;
526 $inf = defined($argv->[$i]) and last;
527 $var =~ s/\.\.\.\z//;
528 $err = "$var not supplied";
529 } elsif ($var =~ /\A$POS_ARG\z/o) { # required arg at $i
530 $argv->[$i++] // ($err = "$var not supplied");
531 } elsif ($var =~ /\.\.\.\]\z/) { # optional args start
534 } elsif ($var =~ /\A\[-?$POS_ARG\]\z/) { # one optional arg
536 } elsif ($var =~ /\A.+?\|/) { # required FOO|--stdin
537 $inf = 1 if index($var, '...') > 0;
538 my @or = split(/\|/, $var);
541 if ($o =~ /\A--([a-z0-9\-]+)/) {
542 $ok = defined($OPT->{$1});
544 } elsif (defined($argv->[$i])) {
548 } # else continue looping
552 $err = join(', ', @or) . " or $last must be set";
554 warn "BUG: can't parse `$var' in $proto";
558 if (!$inf && scalar(@$argv) > scalar(@args)) {
559 $err //= 'too many arguments';
561 $err ? fail($self, "usage: lei $cmd $proto\nE: $err") : 1;
565 my ($self, $cmd, @argv) = @_;
566 local $current_lei = $self; # for __WARN__
567 dump_and_clear_log("from previous run\n");
568 return _help($self, 'no command given') unless defined($cmd);
569 my $func = "lei_$cmd";
571 if (my $cb = __PACKAGE__->can($func)) {
572 optparse($self, $cmd, \@argv) or return;
574 } elsif (grep(/\A-/, $cmd, @argv)) { # --help or -h only
576 $GLP->getoptionsfromarray([$cmd, @argv], $opt, qw(help|h)) or
577 return _help($self, 'bad arguments or options');
580 fail($self, "`$cmd' is not an lei command");
585 my ($self, $creat) = @_;
586 my $f = _config_path($self);
588 my $cur_st = @st ? pack('dd', $st[10], $st[7]) : ''; # 10:ctime, 7:size
589 if (my $cfg = $PATH2CFG{$f}) { # reuse existing object in common case
590 return ($self->{cfg} = $cfg) if $cur_st eq $cfg->{-st};
595 return bless {}, 'PublicInbox::Config';
597 my (undef, $cfg_dir, undef) = File::Spec->splitpath($f);
598 -d $cfg_dir or mkpath($cfg_dir) or die "mkpath($cfg_dir): $!\n";
599 open my $fh, '>>', $f or die "open($f): $!\n";
600 @st = stat($fh) or die "fstat($f): $!\n";
601 $cur_st = pack('dd', $st[10], $st[7]);
602 qerr($self, "# $f created") if $self->{cmd} ne 'config';
604 my $cfg = PublicInbox::Config::git_config_dump($f);
605 bless $cfg, 'PublicInbox::Config';
606 $cfg->{-st} = $cur_st;
608 $self->{cfg} = $PATH2CFG{$f} = $cfg;
611 sub _lei_store ($;$) {
612 my ($self, $creat) = @_;
613 my $cfg = _lei_cfg($self, $creat);
614 $cfg->{-lei_store} //= do {
615 require PublicInbox::LeiStore;
616 my $dir = $cfg->{'leistore.dir'};
617 $dir //= $creat ? _store_path($self) : return;
618 PublicInbox::LeiStore->new($dir, { creat => $creat });
623 my ($self, @argv) = @_;
627 my ($self, @argv) = @_;
631 my ($self, @argv) = @_;
632 my $env = $self->{env};
633 delete local $env->{GIT_CONFIG};
634 delete local $ENV{GIT_CONFIG};
635 my $cfg = _lei_cfg($self, 1);
636 my $cmd = [ qw(git config -f), $cfg->{'-f'}, @argv ];
637 my %rdr = map { $_ => $self->{$_} } (0..2);
638 waitpid(spawn($cmd, $env, \%rdr), 0);
642 my ($self, @argv) = @_;
643 $self->{opt}->{'config-file'} and return fail $self,
644 "config file switches not supported by `lei config'";
646 x_it($self, $?) if $?;
650 require PublicInbox::LeiImport;
651 PublicInbox::LeiImport->call(@_);
655 require PublicInbox::LeiConvert;
656 PublicInbox::LeiConvert->call(@_);
660 my ($self, $dir) = @_;
661 my $cfg = _lei_cfg($self, 1);
662 my $cur = $cfg->{'leistore.dir'};
663 $dir //= _store_path($self);
664 $dir = rel2abs($self, $dir);
665 my @cur = stat($cur) if defined($cur);
666 $cur = File::Spec->canonpath($cur // $dir);
667 my @dir = stat($dir);
668 my $exists = "# leistore.dir=$cur already initialized" if @dir;
671 _lei_store($self, 1)->done;
672 return qerr($self, $exists);
675 # some folks like symlinks and bind mounts :P
676 if (@dir && "@cur[1,0]" eq "@dir[1,0]") {
677 lei_config($self, 'leistore.dir', $dir);
678 _lei_store($self, 1)->done;
679 return qerr($self, "$exists (as $cur)");
681 return fail($self, <<"");
682 E: leistore.dir=$cur already initialized and it is not $dir
685 lei_config($self, 'leistore.dir', $dir);
686 _lei_store($self, 1)->done;
687 $exists //= "# leistore.dir=$dir newly initialized";
688 return qerr($self, $exists);
691 sub lei_daemon_pid { puts shift, $$ }
693 sub lei_daemon_kill {
695 my $sig = $self->{opt}->{signal} // 'TERM';
696 kill($sig, $$) or fail($self, "kill($sig, $$): $!");
699 sub lei_help { _help($_[0]) }
701 # Shell completion helper. Used by lei-completion.bash and hopefully
702 # other shells. Try to do as much here as possible to avoid redundancy
703 # and improve maintainability.
705 my ($self, @argv) = @_; # argv = qw(lei and any other args...)
706 shift @argv; # ignore "lei", the entire command is sent
707 @argv or return puts $self, grep(!/^_/, keys %CMD), qw(--help -h);
708 my $cmd = shift @argv;
709 my $info = $CMD{$cmd} // do { # filter matching commands
710 @argv or puts $self, grep(/\A\Q$cmd\E/, keys %CMD);
713 my ($proto, undef, @spec) = @$info;
715 my $re = defined($cur) ? qr/\A\Q$cur\E/ : qr/./;
716 if (substr($cur // '-', 0, 1) eq '-') { # --switches
717 # gross special case since the only git-config options
718 # Consider moving to a table if we need more special cases
719 # we use Getopt::Long for are the ones we reject, so these
720 # are the ones we don't reject:
721 if ($cmd eq 'config') {
722 puts $self, grep(/$re/, keys %CONFIG_KEYS);
723 @spec = qw(add z|null get get-all unset unset-all
724 replace-all get-urlmatch
725 remove-section rename-section
726 name-only list|l edit|e
727 get-color-name get-colorbool);
730 # generate short/long names from Getopt::Long specs
731 puts $self, grep(/$re/, qw(--help -h), map {
732 if (s/[:=].+\z//) { # req/optional args, e.g output|o=i
733 } elsif (s/\+\z//) { # verbose|v+
735 # negation: solve! => no-solve|solve
736 s/([\w\-]+)/$1|no-$1/g
739 my $x = length > 1 ? "--$_" : "-$_";
740 $x eq $cur ? () : $x;
741 } grep(!/_/, split(/\|/, $_, -1)) # help|h
742 } grep { $OPTDESC{"$cmd\t$_"} || $OPTDESC{$_} } @spec);
743 } elsif ($cmd eq 'config' && !@argv && !$CONFIG_KEYS{$cur}) {
744 puts $self, grep(/$re/, keys %CONFIG_KEYS);
747 # switch args (e.g. lei q -f mbox<TAB>)
748 if (($argv[-1] // $cur // '') =~ /\A--?([\w\-]+)\z/) {
749 my $opt = quotemeta $1;
751 my $v = $OPTDESC{$_};
752 my @v = ref($v) ? split(/\|/, $v->[0]) : ();
753 # get rid of ALL CAPS placeholder (e.g "OUT")
754 # (TODO: completion for external paths)
755 shift(@v) if uc($v[0]) eq $v[0];
757 } grep(/\A(?:$cmd\t|)(?:[\w-]+\|)*$opt\b/, keys %OPTDESC);
760 if (my $sub = $self->can("_complete_$cmd")) {
761 puts $self, $sub->($self, @argv, $cur);
763 # TODO: URLs, pathnames, OIDs, MIDs, etc... See optparse() for
768 my ($argv, $env) = @_;
769 my $argc = scalar @$argv;
770 my $buf = 'exec '.join("\0", scalar(@$argv), @$argv);
771 while (my ($k, $v) = each %$env) { $buf .= "\0$k=$v" };
777 my $mua = $self->{opt}->{mua} // return;
778 my $mfolder = $self->{ovv}->{dst};
779 my (@cmd, $replaced);
780 if ($mua =~ /\A(?:mutt|mailx|mail|neomutt)\z/) {
782 # TODO: help wanted: other common FOSS MUAs
784 require Text::ParseWords;
785 @cmd = Text::ParseWords::shellwords($mua);
786 # mutt uses '%f' for open-hook with compressed mbox, we follow
787 @cmd = map { $_ eq '%f' ? ($replaced = $mfolder) : $_ } @cmd;
789 push @cmd, $mfolder unless defined($replaced);
790 if (my $sock = $self->{sock}) { # lei(1) client process runs it
791 send($sock, exec_buf(\@cmd, {}), MSG_EOR);
792 } elsif ($self->{oneshot}) {
793 $self->{"pid.$self.$$"}->{spawn(\@cmd)} = \@cmd;
795 if ($self->{lxs} && $self->{au_done}) { # kick wait_startq
796 syswrite($self->{au_done}, 'q' x ($self->{lxs}->{jobs} // 0));
798 $self->{opt}->{quiet} = 1;
799 delete $self->{-progress};
800 delete $self->{opt}->{verbose};
803 sub send_exec_cmd { # tell script/lei to execute a command
804 my ($self, $io, $cmd, $env) = @_;
805 my $sock = $self->{sock} // die 'lei client gone';
806 my $fds = [ map { fileno($_) } @$io ];
807 $send_cmd->($sock, $fds, exec_buf($cmd, $env), MSG_EOR);
810 sub poke_mua { # forces terminal MUAs to wake up and hopefully notice new mail
812 my $alerts = $self->{opt}->{alert} // return;
813 while (my $op = shift(@$alerts)) {
814 if ($op eq ':WINCH') {
815 # hit the process group that started the MUA
817 send($self->{sock}, '-WINCH', MSG_EOR);
818 } elsif ($self->{oneshot}) {
821 } elsif ($op eq ':bell') {
823 } elsif ($op =~ /(?<!\\),/) { # bare ',' (not ',,')
824 push @$alerts, split(/(?<!\\),/, $op);
825 } elsif ($op =~ m!\A([/a-z0-9A-Z].+)!) {
826 my $cmd = $1; # run an arbitrary command
827 require Text::ParseWords;
828 $cmd = [ Text::ParseWords::shellwords($cmd) ];
829 if (my $s = $self->{sock}) {
830 send($s, exec_buf($cmd, {}), MSG_EOR);
831 } elsif ($self->{oneshot}) {
832 $self->{"pid.$self.$$"}->{spawn($cmd)} = $cmd;
835 err($self, "W: unsupported --alert=$op"); # non-fatal
840 # caller needs to "-t $self->{1}" to check if tty
843 my $env = $self->{env};
844 my $fh = popen_rd([qw(git var GIT_PAGER)], $env);
845 chomp(my $pager = <$fh> // '');
846 close($fh) or warn "`git var PAGER' error: \$?=$?";
847 return if $pager eq 'cat' || $pager eq '';
848 my $new_env = { LESS => 'FRX', LV => '-c' };
849 $new_env->{MORE} = 'FRX' if $^O eq 'freebsd';
850 pipe(my ($r, $wpager)) or return warn "pipe: $!";
851 my $rdr = { 0 => $r, 1 => $self->{1}, 2 => $self->{2} };
852 my $pgr = [ undef, @$rdr{1, 2} ];
853 if ($self->{sock}) { # lei(1) process runs it
854 delete @$new_env{keys %$env}; # only set iff unset
855 send_exec_cmd($self, [ @$rdr{0..2} ], [$pager], $new_env);
856 } elsif ($self->{oneshot}) {
858 $self->{"pid.$self.$$"}->{spawn($cmd, $new_env, $rdr)} = $cmd;
860 die 'BUG: start_pager w/o socket';
862 $self->{1} = $wpager;
863 $self->{2} = $wpager if -t $self->{2};
864 $env->{GIT_PAGER_IN_USE} = 'true'; # we may spawn git
870 my $pgr = delete($self->{pgr}) or return;
871 $self->{2} = $pgr->[2];
872 # do not restore original stdout, just close it so we error out
873 close(delete($self->{1})) if $self->{1};
876 sub accept_dispatch { # Listener {post_accept} callback
877 my ($sock) = @_; # ignore other
879 my $self = bless { sock => $sock }, __PACKAGE__;
880 vec(my $rvec = '', fileno($sock), 1) = 1;
881 select($rvec, undef, undef, 60) or
882 return send($sock, 'timed out waiting to recv FDs', MSG_EOR);
883 # (4096 * 33) >MAX_ARG_STRLEN
884 my @fds = $recv_cmd->($sock, my $buf, 4096 * 33) or return; # EOF
885 if (scalar(@fds) == 4) {
887 my $fd = shift(@fds);
888 open($self->{$i}, '+<&=', $fd) and next;
889 send($sock, "open(+<&=$fd) (FD=$i): $!", MSG_EOR);
891 } elsif (!defined($fds[0])) {
892 warn(my $msg = "recv_cmd failed: $!");
893 return send($sock, $msg, MSG_EOR);
897 $self->{2}->autoflush(1); # keep stdout buffered until x_it|DESTROY
898 # $ENV_STR = join('', map { "\0$_=$ENV{$_}" } keys %ENV);
899 # $buf = "$argc\0".join("\0", @ARGV).$ENV_STR."\0\0";
900 substr($buf, -2, 2, '') eq "\0\0" or # s/\0\0\z//
901 return send($sock, 'request command truncated', MSG_EOR);
902 my ($argc, @argv) = split(/\0/, $buf, -1);
904 my %env = map { split(/=/, $_, 2) } splice(@argv, $argc);
905 if (chdir($self->{3})) {
907 $self->{env} = \%env;
908 eval { dispatch($self, @argv) };
909 send($sock, $@, MSG_EOR) if $@;
911 send($sock, "fchdir: $!", MSG_EOR); # implicit close
917 delete $self->{-progress};
918 for my $f (@WQ_KEYS) {
919 my $wq = delete $self->{$f} or next;
921 $wq->wq_close(0, undef, $self);
922 } elsif ($wq->wq_kill_old) {
923 $wq->wq_wait_old(undef, $self);
926 close(delete $self->{1}) if $self->{1}; # may reap_compress
927 $self->close if $self->{sock}; # PublicInbox::DS::close
930 # for long-running results
933 local %ENV = %{$self->{env}};
934 my $sock = $self->{sock};
935 local $current_lei = $self;
937 while (my @fds = $recv_cmd->($sock, my $buf, 4096)) {
938 if (scalar(@fds) == 1 && !defined($fds[0])) {
939 return if $! == EAGAIN;
941 last if $! == ECONNRESET;
945 open my $rfh, '+<&=', $fd;
947 die "unrecognized client signal: $buf";
952 eval { $self->fail($err) };
957 sub event_step_init {
959 return if $self->{-event_init_done}++;
960 if (my $sock = $self->{sock}) { # using DS->EventLoop
961 $self->SUPER::new($sock, EPOLLIN|EPOLLET);
967 our $oldset; sub oldset { $oldset }
969 sub dump_and_clear_log {
970 if (defined($errors_log) && -s STDIN && seek(STDIN, 0, SEEK_SET)) {
972 unshift(@pfx, "$errors_log ") if @pfx;
973 warn @pfx, do { local $/; <STDIN> };
974 truncate(STDIN, 0) or warn "ftruncate ($errors_log): $!";
978 # lei(1) calls this when it can't connect
980 my ($path, $errno, $narg) = @_;
981 local ($errors_log, $listener);
982 ($errors_log) = ($path =~ m!\A(.+?/)[^/]+\z!);
983 $errors_log .= 'errors.log';
984 my $addr = pack_sockaddr_un($path);
985 my $lk = bless { lock_path => $errors_log }, 'PublicInbox::Lock';
987 socket($listener, AF_UNIX, SOCK_SEQPACKET, 0) or die "socket: $!";
988 if ($errno == ECONNREFUSED || $errno == ENOENT) {
989 return if connect($listener, $addr); # another process won
990 if ($errno == ECONNREFUSED && -S $path) {
991 unlink($path) or die "unlink($path): $!";
994 $! = $errno; # allow interpolation to stringify in die
995 die "connect($path): $!";
997 umask(077) // die("umask(077): $!");
998 bind($listener, $addr) or die "bind($path): $!";
999 listen($listener, 1024) or die "listen: $!";
1002 my @st = stat($path) or die "stat($path): $!";
1003 my $dev_ino_expect = pack('dd', $st[0], $st[1]); # dev+ino
1004 local $oldset = PublicInbox::DS::block_signals();
1006 $send_cmd = PublicInbox::Spawn->can('send_cmd4');
1007 $recv_cmd = PublicInbox::Spawn->can('recv_cmd4') // do {
1008 require PublicInbox::CmdIPC4;
1009 $send_cmd = PublicInbox::CmdIPC4->can('send_cmd4');
1010 PublicInbox::CmdIPC4->can('recv_cmd4');
1013 $recv_cmd or die <<"";
1014 (Socket::MsgHdr || Inline::C) missing/unconfigured (narg=$narg);
1016 require PublicInbox::Listener;
1017 require PublicInbox::EOFpipe;
1018 (-p STDOUT) or die "E: stdout must be a pipe\n";
1019 open(STDIN, '+>>', $errors_log) or die "open($errors_log): $!";
1020 STDIN->autoflush(1);
1021 dump_and_clear_log("from previous daemon process:\n");
1022 POSIX::setsid() > 0 or die "setsid: $!";
1023 my $pid = fork // die "fork: $!";
1025 $0 = "lei-daemon $path";
1027 $listener->blocking(0);
1029 my $pil = PublicInbox::Listener->new($listener, \&accept_dispatch);
1031 pipe(my ($eof_r, $eof_w)) or die "pipe: $!";
1032 PublicInbox::EOFpipe->new($eof_r, \&noop, undef);
1034 $exit_code //= shift;
1035 my $lis = $pil or exit($exit_code);
1036 # closing eof_w triggers \&noop wakeup
1037 $listener = $eof_w = $pil = $path = undef;
1038 $lis->close; # DS::close
1039 PublicInbox::DS->SetLoopTimeout(1000);
1043 CHLD => \&PublicInbox::DS::enqueue_reap,
1051 my $sigfd = PublicInbox::Sigfd->new($sig, SFD_NONBLOCK);
1052 local @SIG{keys %$sig} = values(%$sig) unless $sigfd;
1054 local $SIG{PIPE} = 'IGNORE';
1055 if ($sigfd) { # TODO: use inotify/kqueue to detect unlinked sockets
1057 PublicInbox::DS->SetLoopTimeout(5000);
1059 # wake up every second to accept signals if we don't
1060 # have signalfd or IO::KQueue:
1061 PublicInbox::DS::sig_setmask($oldset);
1062 PublicInbox::DS->SetLoopTimeout(1000);
1064 PublicInbox::DS->SetPostLoopCallback(sub {
1065 my ($dmap, undef) = @_;
1066 if (@st = defined($path) ? stat($path) : ()) {
1067 if ($dev_ino_expect ne pack('dd', $st[0], $st[1])) {
1068 warn "$path dev/ino changed, quitting\n";
1071 } elsif (defined($path)) { # ENOENT is common
1072 warn "stat($path): $!, quitting ...\n" if $! != ENOENT;
1076 return 1 if defined($path);
1079 for my $s (values %$dmap) {
1080 $s->can('busy') or next;
1081 if ($s->busy($now)) {
1087 $n; # true: continue, false: stop
1090 # STDIN was redirected to /dev/null above, closing STDERR and
1091 # STDOUT will cause the calling `lei' client process to finish
1092 # reading the <$daemon> pipe.
1093 local $SIG{__WARN__} = sub {
1094 $current_lei ? err($current_lei, @_) : warn(
1095 strftime('%Y-%m-%dT%H:%M:%SZ', gmtime(time))," $$ ", @_);
1097 open STDERR, '>&STDIN' or die "redirect stderr failed: $!";
1098 open STDOUT, '>&STDIN' or die "redirect stdout failed: $!";
1099 # $daemon pipe to `lei' closed, main loop begins:
1100 PublicInbox::DS->EventLoop;
1101 exit($exit_code // 0);
1104 sub busy { 1 } # prevent daemon-shutdown if client is connected
1106 # for users w/o Socket::Msghdr installed or Inline::C enabled
1108 my ($main_pkg) = @_;
1109 my $exit = $main_pkg->can('exit'); # caller may override exit()
1110 local $quit = $exit if $exit;
1112 umask(077) // die("umask(077): $!");
1120 dispatch($self, @ARGV);
1121 x_it($self, $self->{child_error}) if $self->{child_error};
1124 # ensures stdout hits the FS before sock disconnects so a client
1125 # can immediately reread it
1128 $self->{1}->autoflush(1) if $self->{1};
1131 my $oneshot_pids = delete $self->{"pid.$self.$$"} or return;
1132 waitpid($_, 0) for keys %$oneshot_pids;
1133 $? = $err if $err; # preserve ->fail or ->x_it code