]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/LEI.pm
lei_mail_sync: rely on flock(2), avoid IPC
[public-inbox.git] / lib / PublicInbox / LEI.pm
index 5694e92c92001d755cc3062b7d446edce067cf37..053b6174d808514f04227b32f3bef982e72b3498 100644 (file)
@@ -24,9 +24,12 @@ use PublicInbox::DS qw(now dwaitpid);
 use PublicInbox::Spawn qw(spawn popen_rd);
 use PublicInbox::Lock;
 use PublicInbox::Eml;
+use PublicInbox::Import;
+use PublicInbox::ContentHash qw(git_sha);
 use Time::HiRes qw(stat); # ctime comparisons for config cache
 use File::Path qw(mkpath);
 use File::Spec;
+use Sys::Syslog qw(openlog syslog closelog);
 our $quit = \&CORE::exit;
 our ($current_lei, $errors_log, $listener, $oldset, $dir_idle,
        $recv_cmd, $send_cmd);
@@ -146,9 +149,9 @@ sub index_opt {
 }
 
 my @c_opt = qw(c=s@ C=s@ quiet|q);
-my @lxs_opt = (qw(remote! local! external! include|I=s@ exclude=s@ only=s@
-       import-remote! no-torsocks torsocks=s),
-       PublicInbox::LeiQuery::curl_opt());
+my @net_opt = (qw(no-torsocks torsocks=s), PublicInbox::LeiQuery::curl_opt());
+my @lxs_opt = qw(remote! local! external! include|I=s@ exclude=s@ only=s@
+       import-remote!);
 
 # we don't support -C as an alias for --find-copies since it's already
 # used for chdir
@@ -173,7 +176,7 @@ our @diff_opt = qw(unified|U=i output-indicator-new=s output-indicator-old=s
 our %CMD = ( # sorted in order of importance/use:
 'q' => [ '--stdin|SEARCH_TERMS...', 'search for messages matching terms',
        'stdin|', # /|\z/ must be first for lone dash
-       @lxs_opt,
+       @lxs_opt, @net_opt,
        qw(save! output|mfolder|o=s format|f=s dedupe|d=s threads|t+
        sort|s=s reverse|r offset=i pretty jobs|j=s globoff|g augment|a
        import-before! lock=s@ rsyncable alert=s@ mua=s verbose|v+
@@ -185,26 +188,26 @@ our %CMD = ( # sorted in order of importance/use:
 'lcat' => [ '--stdin|MSGID_OR_URL...', 'display local copy of message(s)',
        'stdin|', # /|\z/ must be first for lone dash
        # some of these options are ridiculous for lcat
-       @lxs_opt, qw(output|mfolder|o=s format|f=s dedupe|d=s threads|t+
+       @lxs_opt, @net_opt,
+       qw(output|mfolder|o=s format|f=s dedupe|d=s threads|t+
        sort|s=s reverse|r offset=i jobs|j=s globoff|g augment|a
        import-before! lock=s@ rsyncable alert=s@ mua=s verbose|v+
        color!), @c_opt, opt_dash('limit|n=i', '[0-9]+') ],
 
 'blob' => [ 'OID', 'show a git blob, reconstructing from mail if necessary',
        qw(git-dir=s@ cwd! verbose|v+ mail! oid-a|A=s path-a|a=s path-b|b=s),
-       @lxs_opt, @c_opt ],
+       @lxs_opt, @net_opt, @c_opt ],
 
 'rediff' => [ '--stdin|LOCATION...',
                'regenerate a diff with different options',
        'stdin|', # /|\z/ must be first for lone dash
        qw(git-dir=s@ cwd! verbose|v+ color:s no-color),
-       @diff_opt, @lxs_opt, @c_opt ],
+       @diff_opt, @lxs_opt, @net_opt, @c_opt ],
 
 'add-external' => [ 'LOCATION',
        'add/set priority of a publicinbox|extindex for extra matches',
-       qw(boost=i mirror=s no-torsocks torsocks=s inbox-version=i
-       verbose|v+), @c_opt, index_opt(),
-       PublicInbox::LeiQuery::curl_opt() ],
+       qw(boost=i mirror=s inbox-version=i verbose|v+),
+       @c_opt, index_opt(), @net_opt ],
 'ls-external' => [ '[FILTER]', 'list publicinbox|extindex locations',
        qw(format|f=s z|0 globoff|g invert-match|v local remote), @c_opt ],
 'ls-label' => [ '', 'list labels', qw(z|0 stats:s), @c_opt ],
@@ -225,15 +228,14 @@ our %CMD = ( # sorted in order of importance/use:
 'rm' => [ '--stdin|LOCATION...',
        'remove a message from the index and prevent reindexing',
        'stdin|', # /|\z/ must be first for lone dash
-       @c_opt ],
+       qw(in-format|F=s lock=s@), @net_opt, @c_opt ],
 '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), @c_opt ],
 'tag' => [ 'KEYWORDS...',
        'set/unset keywords and/or labels on message(s)',
        qw(stdin| in-format|F=s input|i=s@ oid=s@ mid=s@),
-       qw(no-torsocks torsocks=s), PublicInbox::LeiQuery::curl_opt(), @c_opt,
-       pass_through('-kw:foo for delete') ],
+       @net_opt, @c_opt, pass_through('-kw:foo for delete') ],
 
 'purge-mailsource' => [ 'LOCATION|--all',
        'remove imported messages from IMAP, Maildirs, and MH',
@@ -252,25 +254,24 @@ our %CMD = ( # sorted in order of importance/use:
 
 'index' => [ 'LOCATION...', 'one-time index from URL or filesystem',
        qw(in-format|F=s kw! offset=i recursive|r exclude=s include|I=s
-       verbose|v+ incremental!),
-        PublicInbox::LeiQuery::curl_opt(), # mainly for --proxy=
+       verbose|v+ incremental!), @net_opt, # mainly for --proxy=
         @c_opt ],
 'import' => [ 'LOCATION...|--stdin',
        'one-time import/update from URL or filesystem',
-       qw(stdin| offset=i recursive|r exclude=s include|I=s jobs=s new-only
+       qw(stdin| offset=i recursive|r exclude=s include|I=s new-only
        lock=s@ in-format|F=s kw! verbose|v+ incremental! mail-sync!),
-       qw(no-torsocks torsocks=s), PublicInbox::LeiQuery::curl_opt(), @c_opt ],
+       @net_opt, @c_opt ],
 'forget-mail-sync' => [ 'LOCATION...',
        'forget sync information for a mail folder', @c_opt ],
-'prune-mail-sync' => [ 'LOCATION...|--all',
+'refresh-mail-sync' => [ 'LOCATION...|--all',
        'prune dangling sync data for a mail folder', 'all:s', @c_opt ],
 'export-kw' => [ 'LOCATION...|--all',
        'one-time export of keywords of sync sources',
-       qw(all:s mode=s), @c_opt ],
+       qw(all:s mode=s), @net_opt, @c_opt ],
 'convert' => [ 'LOCATION...|--stdin',
        'one-time conversion from URL or filesystem to another format',
        qw(stdin| in-format|F=s out-format|f=s output|mfolder|o=s lock=s@ kw!),
-       qw(no-torsocks torsocks=s), PublicInbox::LeiQuery::curl_opt(), @c_opt ],
+       @net_opt, @c_opt ],
 'p2q' => [ 'FILE|COMMIT_OID|--stdin',
        "use a patch to generate a query for `lei q --stdin'",
        qw(stdin| want|w=s@ uri debug), @c_opt ],
@@ -278,8 +279,8 @@ our %CMD = ( # sorted in order of importance/use:
                'git-config(1) wrapper for '._config_path($_[0]);
        }, qw(config-file|system|global|file|f=s), # for conflict detection
         qw(c=s@ C=s@), pass_through('git config') ],
-'inspect' => [ 'ITEMS...', 'inspect lei/store and/or local external',
-       qw(pretty ascii dir=s), @c_opt ],
+'inspect' => [ 'ITEMS...|--stdin', 'inspect lei/store and/or local external',
+       qw(stdin| pretty ascii dir=s), @c_opt ],
 
 'init' => [ '[DIRNAME]', sub {
        "initialize storage, default: ".store_path($_[0]);
@@ -464,12 +465,13 @@ sub x_it ($$) {
        my ($self, $code) = @_;
        # make sure client sees stdout before exit
        $self->{1}->autoflush(1) if $self->{1};
-       dump_and_clear_log();
        stop_pager($self);
-       if ($self->{pkt_op_p}) { # to top lei-daemon
+       if ($self->{pkt_op_p}) { # worker => lei-daemon
                $self->{pkt_op_p}->pkt_do('x_it', $code);
-       } elsif ($self->{sock}) { # to lei(1) client
+       } elsif ($self->{sock}) { # lei->daemon => lei(1) client
                send($self->{sock}, "x_it $code", MSG_EOR);
+       } elsif ($quit == \&CORE::exit) { # an admin (one-shot) command
+               exit($code >> 8);
        } # else ignore if client disconnected
 }
 
@@ -486,6 +488,12 @@ sub err ($;@) {
 
 sub qerr ($;@) { $_[0]->{opt}->{quiet} or err(shift, @_) }
 
+sub qfin { # show message on finalization (LeiFinmsg)
+       my ($lei, $msg) = @_;
+       return if $lei->{opt}->{quiet};
+       $lei->{fmsg} ? push(@{$lei->{fmsg}}, "$msg\n") : qerr($lei, $msg);
+}
+
 sub fail_handler ($;$$) {
        my ($lei, $code, $io) = @_;
        close($io) if $io; # needed to avoid warnings on SIGPIPE
@@ -507,7 +515,7 @@ sub fail ($$;$) {
        my ($self, $buf, $exit_code) = @_;
        $self->{failed}++;
        err($self, $buf) if defined $buf;
-       # calls fail_handler:
+       # calls fail_handler
        $self->{pkt_op_p}->pkt_do('!') if $self->{pkt_op_p};
        x_it($self, ($exit_code // 1) << 8);
        undef;
@@ -526,11 +534,14 @@ sub puts ($;@) { out(shift, map { "$_\n" } @_) }
 
 sub child_error { # passes non-fatal curl exit codes to user
        my ($self, $child_error, $msg) = @_; # child_error is $?
+       $child_error ||= 1 << 8;
        $self->err($msg) if $msg;
        if ($self->{pkt_op_p}) { # to top lei-daemon
                $self->{pkt_op_p}->pkt_do('child_error', $child_error);
        } elsif ($self->{sock}) { # to lei(1) client
                send($self->{sock}, "child_error $child_error", MSG_EOR);
+       } else { # non-lei admin command
+               $self->{child_error} ||= $child_error;
        } # else noop if client disconnected
 }
 
@@ -598,20 +609,25 @@ sub incr {
        $self->{counters}->{$field} += $nr;
 }
 
+sub pkt_ops {
+       my ($lei, $ops) = @_;
+       $ops->{'!'} = [ \&fail_handler, $lei ];
+       $ops->{'|'} = [ \&sigpipe_handler, $lei ];
+       $ops->{x_it} = [ \&x_it, $lei ];
+       $ops->{child_error} = [ \&child_error, $lei ];
+       $ops->{incr} = [ \&incr, $lei ];
+       $ops->{sto_done_request} = [ \&sto_done_request, $lei, $lei->{sock} ];
+       $ops;
+}
+
 sub workers_start {
        my ($lei, $wq, $jobs, $ops, $flds) = @_;
-       $ops = {
-               '!' => [ \&fail_handler, $lei ],
-               '|' => [ \&sigpipe_handler, $lei ],
-               'x_it' => [ \&x_it, $lei ],
-               'child_error' => [ \&child_error, $lei ],
-               'incr' => [ \&incr, $lei ],
-               ($ops ? %$ops : ()),
-       };
+       $ops = pkt_ops($lei, { ($ops ? %$ops : ()) });
        $ops->{''} //= [ $wq->can('_lei_wq_eof') || \&wq_eof, $lei ];
        my $end = $lei->pkt_op_pair;
        my $ident = $wq->{-wq_ident} // "lei-$lei->{cmd} worker";
        $flds->{lei} = $lei;
+       $wq->{-wq_nr_workers} //= $jobs; # lock, no incrementing
        $wq->wq_workers_start($ident, $jobs, $lei->oldset, $flds);
        delete $lei->{pkt_op_p};
        my $op_c = delete $lei->{pkt_op_c};
@@ -757,9 +773,10 @@ sub lazy_cb ($$$) {
 
 sub dispatch {
        my ($self, $cmd, @argv) = @_;
+       fchdir($self) or return;
+       local %ENV = %{$self->{env}};
        local $current_lei = $self; # for __WARN__
        $self->{2}->autoflush(1); # keep stdout buffered until x_it|DESTROY
-       dump_and_clear_log("from previous run\n");
        return _help($self, 'no command given') unless defined($cmd);
        # do not support Getopt bundling for this
        while ($cmd eq '-C' || $cmd eq '-c') {
@@ -813,7 +830,7 @@ sub _lei_cfg ($;$) {
                $cur_st = pack('dd', $st[10], $st[7]);
                qerr($self, "# $f created") if $self->{cmd} ne 'config';
        }
-       my $cfg = PublicInbox::Config->git_config_dump($f);
+       my $cfg = PublicInbox::Config->git_config_dump($f, $self->{2});
        $cfg->{-st} = $cur_st;
        $cfg->{'-f'} = $f;
        if ($sto && canonpath_harder($sto_dir // store_path($self))
@@ -945,6 +962,9 @@ sub exec_buf ($$) {
 
 sub start_mua {
        my ($self) = @_;
+       if ($self->{ovv}->{fmt} =~ /\A(?:maildir)\z/) { # TODO: IMAP
+               refresh_watches($self);
+       }
        my $mua = $self->{opt}->{mua} // return;
        my $mfolder = $self->{ovv}->{dst};
        my (@cmd, $replaced);
@@ -1019,13 +1039,15 @@ sub path_to_fd {
 
 # caller needs to "-t $self->{1}" to check if tty
 sub start_pager {
-       my ($self) = @_;
+       my ($self, $new_env) = @_;
        my $fh = popen_rd([qw(git var GIT_PAGER)]);
        chomp(my $pager = <$fh> // '');
        close($fh) or warn "`git var PAGER' error: \$?=$?";
        return if $pager eq 'cat' || $pager eq '';
-       my $new_env = { LESS => 'FRX', LV => '-c' };
-       $new_env->{MORE} = 'FRX' if $^O eq 'freebsd';
+       $new_env //= {};
+       $new_env->{LESS} //= 'FRX';
+       $new_env->{LV} //= '-c';
+       $new_env->{MORE} = $new_env->{LESS} if $^O eq 'freebsd';
        pipe(my ($r, $wpager)) or return warn "pipe: $!";
        my $rdr = { 0 => $r, 1 => $self->{1}, 2 => $self->{2} };
        my $pgr = [ undef, @$rdr{1, 2} ];
@@ -1042,12 +1064,23 @@ sub start_pager {
        $self->{pgr} = $pgr;
 }
 
+# display a message for user before spawning full-screen $VISUAL
+sub pgr_err {
+       my ($self, @msg) = @_;
+       return $self->err(@msg) unless $self->{sock} && -t $self->{2};
+       start_pager($self, { LESS => 'RX' }); # no 'F' so we prompt
+       print { $self->{2} } @msg;
+       $self->{2}->autoflush(1);
+       stop_pager($self);
+       send($self->{sock}, 'wait', MSG_EOR); # wait for user to quit pager
+}
+
 sub stop_pager {
        my ($self) = @_;
        my $pgr = delete($self->{pgr}) or return;
        $self->{2} = $pgr->[2];
-       # do not restore original stdout, just close it so we error out
        close(delete($self->{1})) if $self->{1};
+       $self->{1} = $pgr->[1];
 }
 
 sub accept_dispatch { # Listener {post_accept} callback
@@ -1077,14 +1110,9 @@ sub accept_dispatch { # Listener {post_accept} callback
        my ($argc, @argv) = split(/\0/, $buf, -1);
        undef $buf;
        my %env = map { split(/=/, $_, 2) } splice(@argv, $argc);
-       if (chdir($self->{3})) {
-               local %ENV = %env;
-               $self->{env} = \%env;
-               eval { dispatch($self, @argv) };
-               send($sock, $@, MSG_EOR) if $@;
-       } else {
-               send($sock, "fchdir: $!", MSG_EOR); # implicit close
-       }
+       $self->{env} = \%env;
+       eval { dispatch($self, @argv) };
+       send($sock, $@, MSG_EOR) if $@;
 }
 
 sub dclose {
@@ -1138,10 +1166,12 @@ sub oldset { $oldset }
 
 sub dump_and_clear_log {
        if (defined($errors_log) && -s STDIN && seek(STDIN, 0, SEEK_SET)) {
-               my @pfx = @_;
-               unshift(@pfx, "$errors_log ") if @pfx;
-               warn @pfx, do { local $/; <STDIN> };
-               truncate(STDIN, 0) or warn "ftruncate ($errors_log): $!";
+               openlog('lei-daemon', 'pid,nowait,nofatal,ndelay', 'user');
+               chomp(my @lines = <STDIN>);
+               truncate(STDIN, 0) or
+                       syslog('warning', "ftruncate (%s): %m", $errors_log);
+               for my $l (@lines) { syslog('warning', '%s', $l) }
+               closelog(); # don't share across fork
        }
 }
 
@@ -1152,7 +1182,6 @@ sub cfg2lei ($) {
        open($lei->{1}, '>>&', \*STDOUT) or die "dup 1: $!";
        open($lei->{2}, '>>&', \*STDERR) or die "dup 2: $!";
        open($lei->{3}, '/') or die "open /: $!";
-       chdir($lei->{3}) or die "chdir /': $!";
        my ($x, $y);
        socketpair($x, $y, AF_UNIX, SOCK_SEQPACKET, 0) or die "socketpair: $!";
        $lei->{sock} = $x;
@@ -1170,7 +1199,6 @@ sub dir_idle_handler ($) { # PublicInbox::DirIdle callback
                for my $f (keys %{$MDIR2CFGPATH->{$mdir} // {}}) {
                        my $cfg = $PATH2CFG{$f} // next;
                        eval {
-                               local %ENV = %{$cfg->{-env}};
                                my $lei = cfg2lei($cfg);
                                $lei->dispatch('note-event',
                                                "maildir:$mdir", $nc, $bn, $fn);
@@ -1234,7 +1262,7 @@ sub lazy_start {
        (-p STDOUT) or die "E: stdout must be a pipe\n";
        open(STDIN, '+>>', $errors_log) or die "open($errors_log): $!";
        STDIN->autoflush(1);
-       dump_and_clear_log("from previous daemon process:\n");
+       dump_and_clear_log();
        POSIX::setsid() > 0 or die "setsid: $!";
        my $pid = fork // die "fork: $!";
        return if $pid;
@@ -1248,6 +1276,7 @@ sub lazy_start {
                my (undef, $eof_p) = PublicInbox::PktOp->pair;
                sub {
                        $exit_code //= shift;
+                       eval 'PublicInbox::LeiNoteEvent::flush_task()';
                        my $lis = $pil or exit($exit_code);
                        # closing eof_p triggers \&noop wakeup
                        $listener = $eof_p = $pil = $path = undef;
@@ -1317,7 +1346,9 @@ sub lazy_start {
        open STDERR, '>&STDIN' or die "redirect stderr failed: $!";
        open STDOUT, '>&STDIN' or die "redirect stdout failed: $!";
        # $daemon pipe to `lei' closed, main loop begins:
-       PublicInbox::DS->EventLoop;
+       eval { PublicInbox::DS->EventLoop };
+       warn "event loop error: $@\n" if $@;
+       dump_and_clear_log();
        exit($exit_code // 0);
 }
 
@@ -1330,11 +1361,12 @@ sub DESTROY {
        if (my $counters = delete $self->{counters}) {
                for my $k (sort keys %$counters) {
                        my $nr = $counters->{$k};
-                       $self->child_error(1 << 8, "$nr $k messages");
+                       $self->child_error(0, "$nr $k messages");
                }
        }
        $self->{1}->autoflush(1) if $self->{1};
        stop_pager($self);
+       dump_and_clear_log();
        # preserve $? for ->fail or ->x_it code
 }
 
@@ -1405,25 +1437,21 @@ sub refresh_watches {
                                add_maildir_watch($d, $cfg_f);
                        }
                } else { # TODO: imap/nntp/jmap
-                       $lei->child_error(1, "E: watch $url not supported, yet")
+                       $lei->child_error(0, "E: watch $url not supported, yet")
                }
        }
 
        # add all known Maildir folders as implicit watches
-       my $sto = $lei->_lei_store;
-       my $renames = 0;
-       if (my $lms = $sto ? $sto->search->lms : undef) {
+       my $lms = $lei->lms;
+       if ($lms) {
+               $lms->lms_write_prepare;
                for my $d ($lms->folders('maildir:')) {
                        substr($d, 0, length('maildir:')) = '';
-                       my $cd = canonpath_harder($d);
-                       my $f = "maildir:$cd";
 
                        # fixup old bugs while we're iterating:
-                       if ($d ne $cd) {
-                               $sto->ipc_do('lms_rename_folder',
-                                               "maildir:$d", $f);
-                               ++$renames;
-                       }
+                       my $cd = canonpath_harder($d);
+                       my $f = "maildir:$cd";
+                       $lms->rename_folder("maildir:$d", $f) if $d ne $cd;
                        next if $watches->{$f}; # may be set to pause
                        require PublicInbox::LeiWatch;
                        $watches->{$f} = PublicInbox::LeiWatch->new($f);
@@ -1431,7 +1459,6 @@ sub refresh_watches {
                        add_maildir_watch($cd, $cfg_f);
                }
        }
-       $lei->sto_done_request if $renames;
        if ($old) { # cull old non-existent entries
                for my $url (keys %$old) {
                        next if exists $seen{$url};
@@ -1440,7 +1467,7 @@ sub refresh_watches {
                                my $d = canonpath_harder($1);
                                cancel_maildir_watch($d, $cfg_f);
                        } else { # TODO: imap/nntp/jmap
-                               $lei->child_error(1, "E: watch $url TODO");
+                               $lei->child_error(0, "E: watch $url TODO");
                        }
                }
        }
@@ -1451,28 +1478,32 @@ sub refresh_watches {
        }
 }
 
-sub git_blob_id {
-       my ($lei, $eml) = @_;
-       ($lei->{sto} // _lei_store($lei, 1))->git_blob_id($eml);
+# TODO: support SHA-256
+sub git_oid {
+       my $eml = $_[-1];
+       $eml->header_set($_) for @PublicInbox::Import::UNWANTED_HEADERS;
+       git_sha(1, $eml);
 }
 
-sub lms { # read-only LeiMailSync
-       my ($lei) = @_;
-       my $lse = $lei->{lse} // do {
-               my $sto = $lei->{sto} // _lei_store($lei);
-               $sto ? $sto->search : undef
-       };
-       $lse ? $lse->lms : undef;
+sub lms {
+       my ($lei, $rw) = @_;
+       my $sto = $lei->{sto} // _lei_store($lei) // return;
+       require PublicInbox::LeiMailSync;
+       my $f = "$sto->{priv_eidx}->{topdir}/mail_sync.sqlite3";
+       (-f $f || $rw) ? PublicInbox::LeiMailSync->new($f) : undef;
 }
 
 sub sto_done_request { # only call this from lei-daemon process (not workers)
        my ($lei, $sock) = @_;
-       if ($sock //= $lei->{sock}) {
-               $LIVE_SOCK{"$sock"} = $sock;
-               $lei->{sto}->ipc_do('done', "$sock"); # issue, async wait
-       } else { # forcibly wait
-               my $wait = $lei->{sto}->ipc_do('done');
-       }
+       eval {
+               if ($sock //= $lei->{sock}) { # issue, async wait
+                       $LIVE_SOCK{"$sock"} = $sock;
+                       $lei->{sto}->ipc_do('done', "$sock");
+               } else { # forcibly wait
+                       my $wait = $lei->{sto}->ipc_do('done');
+               }
+       };
+       $lei->err($@) if $@;
 }
 
 sub sto_done_complete { # called in lei-daemon when LeiStore->done is complete