]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/LEI.pm
lei import: move check_input_format to lei
[public-inbox.git] / lib / PublicInbox / LEI.pm
index 515bc2a3e121cf31f0d9bb8ea2774672484d5a74..1fa9f7516633918a800418e775152c550c7b6356 100644 (file)
@@ -22,7 +22,7 @@ use PublicInbox::Syscall qw(SFD_NONBLOCK EPOLLIN EPOLLET);
 use PublicInbox::Sigfd;
 use PublicInbox::DS qw(now dwaitpid);
 use PublicInbox::Spawn qw(spawn popen_rd);
-use PublicInbox::OnDestroy;
+use PublicInbox::Lock;
 use Time::HiRes qw(stat); # ctime comparisons for config cache
 use File::Path qw(mkpath);
 use File::Spec;
@@ -109,14 +109,14 @@ sub index_opt {
 # command => [ positional_args, 1-line description, Getopt::Long option spec ]
 our %CMD = ( # sorted in order of importance/use:
 'q' => [ '--stdin|SEARCH_TERMS...', 'search for messages matching terms', qw(
-       save-as=s output|mfolder|o=s format|f=s dedupe|d=s thread|t augment|a
+       save-as=s output|mfolder|o=s format|f=s dedupe|d=s threads|t augment|a
        sort|s=s reverse|r offset=i remote! local! external! pretty
        include|I=s@ exclude=s@ only=s@ jobs|j=s globoff|g stdin|
-       mua-cmd|mua=s no-torsocks torsocks=s verbose|v+ quiet|q),
+       alert=s@ mua=s no-torsocks torsocks=s verbose|v+ quiet|q),
        PublicInbox::LeiQuery::curl_opt(), opt_dash('limit|n=i', '[0-9]+') ],
 
 'show' => [ 'MID|OID', 'show a given object (Message-ID or object ID)',
-       qw(type=s solve! format|f=s dedupe|d=s thread|t remote local!),
+       qw(type=s solve! format|f=s dedupe|d=s threads|t remote local!),
        pass_through('git show') ],
 
 'add-external' => [ 'LOCATION',
@@ -124,8 +124,8 @@ our %CMD = ( # sorted in order of importance/use:
        qw(boost=i c=s@ mirror=s no-torsocks torsocks=s inbox-version=i),
        qw(quiet|q verbose|v+),
        index_opt(), PublicInbox::LeiQuery::curl_opt() ],
-'ls-external' => [ '[FILTER...]', 'list publicinbox|extindex locations',
-       qw(format|f=s z|0 local remote quiet|q) ],
+'ls-external' => [ '[FILTER]', 'list publicinbox|extindex locations',
+       qw(format|f=s z|0 globoff|g invert-match|v local remote) ],
 'forget-external' => [ 'LOCATION...|--prune',
        'exclude further results from a publicinbox|extindex',
        qw(prune quiet|q) ],
@@ -135,9 +135,9 @@ our %CMD = ( # sorted in order of importance/use:
 'rm-query' => [ 'QUERY_NAME', 'remove a saved search' ],
 'mv-query' => [ qw(OLD_NAME NEW_NAME), 'rename a saved search' ],
 
-'plonk' => [ '--thread|--from=IDENT',
-       'exclude mail matching From: or thread from non-Message-ID searches',
-       qw(stdin| thread|t from|f=s mid=s oid=s) ],
+'plonk' => [ '--threads|--from=IDENT',
+       'exclude mail matching From: or threads from non-Message-ID searches',
+       qw(stdin| threads|t from|f=s mid=s oid=s) ],
 'mark' => [ 'MESSAGE_FLAGS...',
        'set/unset keywords on message(s) from stdin',
        qw(stdin| oid=s exact by-mid|mid:s) ],
@@ -224,15 +224,20 @@ my %OPTDESC = (
 
 'dedupe|d=s' => ['STRATEGY|content|oid|mid|none',
                'deduplication strategy'],
-'show  thread|t' => 'display entire thread a message belongs to',
-'q     thread|t' =>
-       'return all messages in the same thread as the actual match(es)',
+'show  threads|t' => 'display entire thread a message belongs to',
+'q     threads|t' =>
+       'return all messages in the same threads as the actual match(es)',
+'alert=s@' => ['CMD,:WINCH,:bell,<any command>',
+       'run command(s) or perform ops when done writing to output ' .
+       '(default: ":WINCH,:bell" with --mua and Maildir/IMAP output, ' .
+       'nothing otherwise)' ],
+
 'augment|a' => 'augment --output destination instead of clobbering',
 
 'output|mfolder|o=s' => [ 'MFOLDER',
        "destination (e.g.\xa0`/path/to/Maildir', ".
        "or\xa0`-'\x{a0}for\x{a0}stdout)" ],
-'mua-cmd|mua=s' => [ 'CMD',
+'mua=s' => [ 'CMD',
        "MUA to run on --output Maildir or mbox (e.g.\xa0`mutt\xa0-f\xa0%f')" ],
 
 'show  format|f=s' => [ 'OUT|plain|raw|html|mboxrd|mboxcl2|mboxcl',
@@ -331,8 +336,9 @@ sub x_it ($$) {
                        my $wq = delete $self->{$f} or next;
                        $wq->DESTROY;
                }
-               # cleanup anything that has tempfiles
-               delete @$self{qw(ovv dedupe)};
+               # cleanup anything that has tempfiles or open file handles
+               %PATH2CFG = ();
+               delete @$self{qw(ovv dedupe sto cfg)};
                if (my $signum = ($code & 127)) { # usually SIGPIPE (13)
                        $SIG{PIPE} = 'DEFAULT'; # $SIG{$signum} doesn't work
                        kill $signum, $$;
@@ -360,10 +366,10 @@ sub fail_handler ($;$$) {
        my ($lei, $code, $io) = @_;
        for my $f (@WQ_KEYS) {
                my $wq = delete $lei->{$f} or next;
-               $wq->wq_wait_old($lei) if $wq->wq_kill_old; # lei-daemon
+               $wq->wq_wait_old(undef, $lei) if $wq->wq_kill_old; # lei-daemon
        }
        close($io) if $io; # needed to avoid warnings on SIGPIPE
-       $lei->x_it($code // (1 >> 8));
+       x_it($lei, $code // (1 << 8));
 }
 
 sub sigpipe_handler { # handles SIGPIPE from @WQ_KEYS workers
@@ -385,6 +391,20 @@ sub fail ($$;$) {
        undef;
 }
 
+sub check_input_format ($;$) {
+       my ($self, $files) = @_;
+       my $fmt = $self->{opt}->{'format'};
+       if (!$fmt) {
+               my $err = $files ? "regular file(s):\n@$files" : '--stdin';
+               return fail($self, "--format unset for $err");
+       }
+       return 1 if $fmt eq 'eml';
+       # XXX: should this handle {gz,bz2,xz}? that's currently in LeiToMail
+       require PublicInbox::MboxReader;
+       PublicInbox::MboxReader->can($fmt) ||
+                               fail($self, "--format=$fmt unrecognized");
+}
+
 sub out ($;@) {
        my $self = shift;
        return if print { $self->{1} // return } @_; # likely
@@ -554,9 +574,10 @@ sub _lei_cfg ($;$) {
                open my $fh, '>>', $f or die "open($f): $!\n";
                @st = stat($fh) or die "fstat($f): $!\n";
                $cur_st = pack('dd', $st[10], $st[7]);
-               qerr($self, "I: $f created") if $self->{cmd} ne 'config';
+               qerr($self, "# $f created") if $self->{cmd} ne 'config';
        }
        my $cfg = PublicInbox::Config::git_config_dump($f);
+       bless $cfg, 'PublicInbox::Config';
        $cfg->{-st} = $cur_st;
        $cfg->{'-f'} = $f;
        $self->{cfg} = $PATH2CFG{$f} = $cfg;
@@ -614,7 +635,7 @@ sub lei_init {
        my @cur = stat($cur) if defined($cur);
        $cur = File::Spec->canonpath($cur // $dir);
        my @dir = stat($dir);
-       my $exists = "I: leistore.dir=$cur already initialized" if @dir;
+       my $exists = "# leistore.dir=$cur already initialized" if @dir;
        if (@cur) {
                if ($cur eq $dir) {
                        _lei_store($self, 1)->done;
@@ -633,7 +654,7 @@ E: leistore.dir=$cur already initialized and it is not $dir
        }
        lei_config($self, 'leistore.dir', $dir);
        _lei_store($self, 1)->done;
-       $exists //= "I: leistore.dir=$dir newly initialized";
+       $exists //= "# leistore.dir=$dir newly initialized";
        return qerr($self, $exists);
 }
 
@@ -723,7 +744,7 @@ sub exec_buf ($$) {
 
 sub start_mua {
        my ($self) = @_;
-       my $mua = $self->{opt}->{'mua-cmd'} // return;
+       my $mua = $self->{opt}->{mua} // return;
        my $mfolder = $self->{ovv}->{dst};
        my (@cmd, $replaced);
        if ($mua =~ /\A(?:mutt|mailx|mail|neomutt)\z/) {
@@ -731,7 +752,7 @@ sub start_mua {
        # TODO: help wanted: other common FOSS MUAs
        } else {
                require Text::ParseWords;
-               my @cmd = Text::ParseWords::shellwords($mua);
+               @cmd = Text::ParseWords::shellwords($mua);
                # mutt uses '%f' for open-hook with compressed mbox, we follow
                @cmd = map { $_ eq '%f' ? ($replaced = $mfolder) : $_ } @cmd;
        }
@@ -739,9 +760,44 @@ sub start_mua {
        if (my $sock = $self->{sock}) { # lei(1) client process runs it
                send($sock, exec_buf(\@cmd, {}), MSG_EOR);
        } elsif ($self->{oneshot}) {
-               $self->{"mua.pid.$self.$$"} = spawn(\@cmd);
+               $self->{"pid.$self.$$"}->{spawn(\@cmd)} = \@cmd;
        }
+       if ($self->{lxs} && $self->{au_done}) { # kick wait_startq
+               syswrite($self->{au_done}, 'q' x ($self->{lxs}->{jobs} // 0));
+       }
+       $self->{opt}->{quiet} = 1;
        delete $self->{-progress};
+       delete $self->{opt}->{verbose};
+}
+
+sub poke_mua { # forces terminal MUAs to wake up and hopefully notice new mail
+       my ($self) = @_;
+       my $alerts = $self->{opt}->{alert} // return;
+       while (my $op = shift(@$alerts)) {
+               if ($op eq ':WINCH') {
+                       # hit the process group that started the MUA
+                       if ($self->{sock}) {
+                               send($self->{sock}, '-WINCH', MSG_EOR);
+                       } elsif ($self->{oneshot}) {
+                               kill('-WINCH', $$);
+                       }
+               } elsif ($op eq ':bell') {
+                       out($self, "\a");
+               } elsif ($op =~ /(?<!\\),/) { # bare ',' (not ',,')
+                       push @$alerts, split(/(?<!\\),/, $op);
+               } elsif ($op =~ m!\A([/a-z0-9A-Z].+)!) {
+                       my $cmd = $1; # run an arbitrary command
+                       require Text::ParseWords;
+                       $cmd = [ Text::ParseWords::shellwords($cmd) ];
+                       if (my $s = $self->{sock}) {
+                               send($s, exec_buf($cmd, {}), MSG_EOR);
+                       } elsif ($self->{oneshot}) {
+                               $self->{"pid.$self.$$"}->{spawn($cmd)} = $cmd;
+                       }
+               } else {
+                       err($self, "W: unsupported --alert=$op"); # non-fatal
+               }
+       }
 }
 
 # caller needs to "-t $self->{1}" to check if tty
@@ -752,8 +808,7 @@ sub start_pager {
        chomp(my $pager = <$fh> // '');
        close($fh) or warn "`git var PAGER' error: \$?=$?";
        return if $pager eq 'cat' || $pager eq '';
-       # TODO TIOCGWINSZ
-       my $new_env = { LESS => 'FRX', LV => '-c', COLUMNS => 80 };
+       my $new_env = { LESS => 'FRX', LV => '-c' };
        $new_env->{MORE} = 'FRX' if $^O eq 'freebsd';
        pipe(my ($r, $wpager)) or return warn "pipe: $!";
        my $rdr = { 0 => $r, 1 => $self->{1}, 2 => $self->{2} };
@@ -763,8 +818,8 @@ sub start_pager {
                my $fds = [ map { fileno($_) } @$rdr{0..2} ];
                $send_cmd->($sock, $fds, exec_buf([$pager], $new_env), MSG_EOR);
        } elsif ($self->{oneshot}) {
-               $pgr->[0] = spawn([$pager], $new_env, $rdr);
-               $pgr->[3] = $$; # ew'll reap it
+               my $cmd = [$pager];
+               $self->{"pid.$self.$$"}->{spawn($cmd, $new_env, $rdr)} = $cmd;
        } else {
                die 'BUG: start_pager w/o socket';
        }
@@ -780,8 +835,6 @@ sub stop_pager {
        $self->{2} = $pgr->[2];
        # do not restore original stdout, just close it so we error out
        close(delete($self->{1})) if $self->{1};
-       my $pid = $pgr->[0];
-       dwaitpid($pid) if $pid && ($pgr->[3] // 0) == $$;
 }
 
 sub accept_dispatch { # Listener {post_accept} callback
@@ -791,17 +844,19 @@ sub accept_dispatch { # Listener {post_accept} callback
        vec(my $rvec = '', fileno($sock), 1) = 1;
        select($rvec, undef, undef, 60) or
                return send($sock, 'timed out waiting to recv FDs', MSG_EOR);
-       my @fds = $recv_cmd->($sock, my $buf, 4096 * 33); # >MAX_ARG_STRLEN
+       # (4096 * 33) >MAX_ARG_STRLEN
+       my @fds = $recv_cmd->($sock, my $buf, 4096 * 33) or return; # EOF
        if (scalar(@fds) == 4) {
                for my $i (0..3) {
                        my $fd = shift(@fds);
                        open($self->{$i}, '+<&=', $fd) and next;
                        send($sock, "open(+<&=$fd) (FD=$i): $!", MSG_EOR);
                }
-       } else {
-               my $msg = "recv_cmd failed: $!";
-               warn $msg;
+       } elsif (!defined($fds[0])) {
+               warn(my $msg = "recv_cmd failed: $!");
                return send($sock, $msg, MSG_EOR);
+       } else {
+               return;
        }
        $self->{2}->autoflush(1); # keep stdout buffered until x_it|DESTROY
        # $ENV_STR = join('', map { "\0$_=$ENV{$_}" } keys %ENV);
@@ -827,9 +882,9 @@ sub dclose {
        for my $f (@WQ_KEYS) {
                my $wq = delete $self->{$f} or next;
                if ($wq->wq_kill) {
-                       $wq->wq_close
+                       $wq->wq_close(0, undef, $self);
                } elsif ($wq->wq_kill_old) {
-                       $wq->wq_wait_old($self);
+                       $wq->wq_wait_old(undef, $self);
                }
        }
        close(delete $self->{1}) if $self->{1}; # may reap_compress
@@ -886,22 +941,27 @@ sub dump_and_clear_log {
 # lei(1) calls this when it can't connect
 sub lazy_start {
        my ($path, $errno, $narg) = @_;
-       if ($errno == ECONNREFUSED) {
-               unlink($path) or die "unlink($path): $!";
-       } elsif ($errno != ENOENT) {
+       local ($errors_log, $listener);
+       ($errors_log) = ($path =~ m!\A(.+?/)[^/]+\z!);
+       $errors_log .= 'errors.log';
+       my $addr = pack_sockaddr_un($path);
+       my $lk = bless { lock_path => $errors_log }, 'PublicInbox::Lock';
+       $lk->lock_acquire;
+       socket($listener, AF_UNIX, SOCK_SEQPACKET, 0) or die "socket: $!";
+       if ($errno == ECONNREFUSED || $errno == ENOENT) {
+               return if connect($listener, $addr); # another process won
+               if ($errno == ECONNREFUSED && -S $path) {
+                       unlink($path) or die "unlink($path): $!";
+               }
+       } else {
                $! = $errno; # allow interpolation to stringify in die
                die "connect($path): $!";
        }
-       if (eval { require BSD::Resource }) {
-               my $NOFILE = BSD::Resource::RLIMIT_NOFILE();
-               my ($s, $h) = BSD::Resource::getrlimit($NOFILE);
-               BSD::Resource::setrlimit($NOFILE, $h, $h) if $s < $h;
-       }
        umask(077) // die("umask(077): $!");
-       local $listener;
-       socket($listener, AF_UNIX, SOCK_SEQPACKET, 0) or die "socket: $!";
-       bind($listener, pack_sockaddr_un($path)) or die "bind($path): $!";
+       bind($listener, $addr) or die "bind($path): $!";
        listen($listener, 1024) or die "listen: $!";
+       $lk->lock_release;
+       undef $lk;
        my @st = stat($path) or die "stat($path): $!";
        my $dev_ino_expect = pack('dd', $st[0], $st[1]); # dev+ino
        local $oldset = PublicInbox::DS::block_signals();
@@ -919,9 +979,6 @@ sub lazy_start {
        require PublicInbox::Listener;
        require PublicInbox::EOFpipe;
        (-p STDOUT) or die "E: stdout must be a pipe\n";
-       local $errors_log;
-       ($errors_log) = ($path =~ m!\A(.+?/)[^/]+\z!);
-       $errors_log .= 'errors.log';
        open(STDIN, '+>>', $errors_log) or die "open($errors_log): $!";
        STDIN->autoflush(1);
        dump_and_clear_log("from previous daemon process:\n");
@@ -1031,9 +1088,10 @@ sub DESTROY {
        my ($self) = @_;
        $self->{1}->autoflush(1) if $self->{1};
        stop_pager($self);
-       if (my $mua_pid = delete $self->{"mua.pid.$self.$$"}) {
-               waitpid($mua_pid, 0);
-       }
+       my $err = $?;
+       my $oneshot_pids = delete $self->{"pid.$self.$$"} or return;
+       waitpid($_, 0) for keys %$oneshot_pids;
+       $? = $err if $err; # preserve ->fail or ->x_it code
 }
 
 1;