lei ls-search: command to list saved searches

[public-inbox.git] / lib / PublicInbox / LeiSavedSearch.pm

diff --git a/lib/PublicInbox/LeiSavedSearch.pm b/lib/PublicInbox/LeiSavedSearch.pm
index a8bf470be4738db3733ed0f39bbe196c32c0d92d..d67622c9b08ce6bfc30fa75cef75cb9206ba06ea 100644 (file)
--- a/lib/PublicInbox/LeiSavedSearch.pm
+++ b/lib/PublicInbox/LeiSavedSearch.pm
@@ -13,6 +13,19 @@ use PublicInbox::Spawn qw(run_die);
 use PublicInbox::ContentHash qw(git_sha);
 use Digest::SHA qw(sha256_hex);
 
+# move this to PublicInbox::Config if other things use it:
+my %cquote = ("\n" => '\\n', "\t" => '\\t', "\b" => '\\b');
+sub cquote_val ($) { # cf. git-config(1)
+       my ($val) = @_;
+       $val =~ s/([\n\t\b])/$cquote{$1}/g;
+       $val;
+}
+
+sub ARRAY_FIELDS () { qw(only include exclude) }
+sub BOOL_FIELDS () {
+       qw(external local remote import-remote import-before threads)
+}
+
 sub lss_dir_for ($$) {
        my ($lei, $dstref) = @_;
        my @n;
@@ -22,20 +35,50 @@ sub lss_dir_for ($$) {
                $$dstref = $$uri;
                @n = ($uri->mailbox);
        } else { # basename
-               @n = ($$dstref =~ m{([\w\-\.]+)/*\z});
                $$dstref = $lei->rel2abs($$dstref);
+               $$dstref .= '/' if -d $$dstref;
+               $$dstref =~ tr!/!/!s;
+               @n = ($$dstref =~ m{([^/]+)/*\z});
        }
        push @n, sha256_hex($$dstref);
        $lei->share_path . '/saved-searches/' . join('-', @n);
 }
 
+sub list {
+       my ($lei, $pfx) = @_;
+       my $lss_dir = $lei->share_path.'/saved-searches/';
+       return () unless -d $lss_dir;
+       # TODO: persist the cache?  Use another format?
+       my $f = $lei->cache_dir."/saved-tmp.$$.".time.'.config';
+       open my $fh, '>', $f or die "open $f: $!";
+       print $fh "[include]\n";
+       for my $p (glob("$lss_dir/*/lei.saved-search")) {
+               print $fh "\tpath = ", cquote_val($p), "\n";
+       }
+       close $fh or die "close $f: $!";
+       my $cfg = PublicInbox::Config::git_config_dump($f);
+       unlink($f);
+       bless $cfg, 'PublicInbox::Config';
+       my $out = $cfg->get_all('lei.q.output') or return ();
+       map {;
+               if (s!\A(?:maildir|mh|mbox.+|mmdf):!!i) {
+                       -e $_ ? $_ : (); # TODO auto-prune somewhere?
+               } else { # IMAP, maybe JMAP
+                       $_;
+               }
+       } @$out
+}
+
 sub new {
-       my ($cls, $lei, $dir) = @_;
+       my ($cls, $lei, $dst) = @_;
        my $self = bless { ale => $lei->ale }, $cls;
-       if (defined $dir) { # updating existing saved search via "lei up"
-               my $f = "$dir/lei.saved-search";
-               ((-f $f && -r _) || output2lssdir($self, $lei, \$dir, \$f)) or
-                       return $lei->fail("$f non-existent or unreadable");
+       my $dir;
+       if (defined $dst) { # updating existing saved search via "lei up"
+               my $f;
+               $dir = $dst;
+               output2lssdir($self, $lei, \$dir, \$f) or
+                       return $lei->fail("--save was not used with $dst cwd=".
+                                               $lei->rel2abs('.'));
                $self->{-cfg} //= PublicInbox::Config::git_config_dump($f);
                $self->{'-f'} = $f;
        } else { # new saved search "lei q --save"
@@ -44,26 +87,34 @@ sub new {
                require File::Path;
                File::Path::make_path($dir); # raises on error
                $self->{-cfg} = {};
-               $self->{'-f'} = "$dir/lei.saved-search";
+               my $f = $self->{'-f'} = "$dir/lei.saved-search";
+               open my $fh, '>', $f or return $lei->fail("open $f: $!");
+               my $sq_dst = PublicInbox::Config::squote_maybe($dst);
                my $q = $lei->{mset_opt}->{q_raw} // die 'BUG: {q_raw} missing';
                if (ref $q) {
-                       cfg_set($self, '--add', 'lei.q', $_) for @$q;
+                       $q = join("\n", map { "\tq = ".cquote_val($_) } @$q);
                } else {
-                       cfg_set($self, 'lei.q', $q);
+                       $q = "\tq = ".cquote_val($q);
                }
                $dst = "$lei->{ovv}->{fmt}:$dst" if $dst !~ m!\Aimaps?://!i;
-               cfg_set($self, 'lei.q.output', $dst);
-               for my $k (qw(only include exclude)) {
+               print $fh <<EOM;
+; to refresh with new results, run: lei up $sq_dst
+[lei]
+$q
+[lei "q"]
+       output = $dst
+EOM
+               for my $k (ARRAY_FIELDS) {
                        my $ary = $lei->{opt}->{$k} // next;
                        for my $x (@$ary) {
-                               cfg_set($self, '--add', "lei.q.$k", $x);
+                               print $fh "\t$k = ".cquote_val($x)."\n";
                        }
                }
-               for my $k (qw(external local remote import-remote
-                               import-before threads)) {
+               for my $k (BOOL_FIELDS) {
                        my $val = $lei->{opt}->{$k} // next;
-                       cfg_set($self, "lei.q.$k", $val);
+                       print $fh "\t$k = ".($val ? 1 : 0)."\n";
                }
+               close($fh) or return $lei->fail("close $f: $!");
        }
        bless $self->{-cfg}, 'PublicInbox::Config';
        $self->{lock_path} = "$self->{-f}.flock";
@@ -73,7 +124,7 @@ sub new {
 
 sub description { $_[0]->{qstr} } # for WWW
 
-sub cfg_set {
+sub cfg_set { # called by LeiXSearch
        my ($self, @args) = @_;
        my $lk = $self->lock_for_scope; # git-config doesn't wait
        run_die([qw(git config -f), $self->{'-f'}, @args]);