lei ls-mail-source: list IMAP folders and NNTP groups

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

diff --git a/lib/PublicInbox/LeiLsMailSource.pm b/lib/PublicInbox/LeiLsMailSource.pm
new file mode 100644 (file)
index 0000000..e95c0b3
--- /dev/null
+++ b/lib/PublicInbox/LeiLsMailSource.pm
@@ -0,0 +1,82 @@
+# Copyright (C) 2021 all contributors <meta@public-inbox.org>
+# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
+
+# command for listing NNTP groups and IMAP folders,
+# handy for users with git-credential-helper configured
+# TODO: list JMAP labels
+package PublicInbox::LeiLsMailSource;
+use strict;
+use v5.10.1;
+use parent qw(PublicInbox::IPC PublicInbox::LeiInput);
+
+sub input_path_url { # overrides LeiInput version
+       my ($self, $url) = @_;
+       # TODO: support ndjson and other JSONs we support elsewhere
+       my $json;
+       my $lei = $self->{lei};
+       my $ORS = "\n";
+       if ($self->{lei}->{opt}->{l}) {
+               $json = ref(PublicInbox::Config->json)->new->utf8->canonical;
+               $json->ascii(1) if $lei->{opt}->{ascii};
+       } elsif ($self->{lei}->{opt}->{z}) {
+               $ORS = "\0";
+       }
+       if ($url =~ m!\Aimaps?://!i) {
+               my $uri = PublicInbox::URIimap->new($url);
+               my $mic = $lei->{net}->mic_get($uri);
+               my $l = $mic->folders_hash($uri->path); # server-side filter
+               if ($json) {
+                       $lei->puts($json->encode($l));
+               } else {
+                       $lei->out(join($ORS, (map { $_->{name} } @$l), ''));
+               }
+       } elsif ($url =~ m!\A(?:nntps?|s?news)://!i) {
+               my $uri = PublicInbox::URInntps->new($url);
+               my $nn = $lei->{net}->nn_get($uri);
+               my $l = $nn->newsgroups($uri->group); # name => description
+               if ($json) {
+                       my $all = $nn->list;
+                       my @x;
+                       for my $ng (sort keys %$l) {
+                               my $desc = $l->{$ng};
+
+# we need to drop CR ourselves iff using IO::Socket::SSL since
+# Net::Cmd::getline doesn't get used by Net::NNTP if TLS is in play, noted in:
+# <https://rt.cpan.org/Ticket/Display.html?id=129966>
+                               $desc =~ s/\r\z//;
+
+                               my ($hwm, $lwm, $status) = @{$all->{$ng}};
+                               push @x, { name => $ng, lwm => $lwm + 0,
+                                       hwm => $hwm + 0, status => $status,
+                                       description => $desc };
+                       }
+                       $lei->puts($json->encode(\@x));
+               } else {
+                       $lei->out(join($ORS, sort(keys %$l), ''));
+               }
+       } else { die "BUG: $url not supported" }
+}
+
+sub lei_ls_mail_source {
+       my ($lei, $url, $pfx) = @_;
+       $url =~ m!\A(?:imaps?|nntps?|s?news)://!i or return
+               $lei->fail('only NNTP and IMAP URLs supported');
+       my $self = bless { pfx => $pfx, -ls_ok => 1 }, __PACKAGE__;
+       $self->prepare_inputs($lei, [ $url ]) or return;
+       $lei->start_pager if -t $lei->{1};
+       my $ops = {};
+       $lei->{auth}->op_merge($ops, $self);
+       my $j = $self->{-wq_nr_workers} = 1; # locked
+       (my $op_c, $ops) = $lei->workers_start($self, $j, $ops);
+       $lei->{wq1} = $self;
+       $lei->{-err_type} = 'non-fatal';
+       net_merge_all_done($self) unless $lei->{auth};
+       $lei->wait_wq_events($op_c, $ops); # net_merge_all_done if !{auth}
+}
+
+no warnings 'once';
+*ipc_atfork_child = \&PublicInbox::LeiInput::input_only_atfork_child;
+*net_merge_all_done = \&PublicInbox::LeiInput::input_only_net_merge_all_done;
+*net_merge_all = \&PublicInbox::LeiAuth::net_merge_all;
+
+1;