[PATCH 0/3] IMAP and Tor .onion niceities

[PATCH 0/3] IMAP and Tor .onion niceities

[Eric Wong]

Some things I noticed while writing a quick how-to on
"lei ls-mail-source" and .onion usage in
https://public-inbox.org/meta/20210915230605.GA22173@dcvr/

Eric Wong (3):
  net_reader: emit .onion help for potential Tor users
  lei ls-mail-source: sort IMAP folder names
  imapd: sort LIST response

 lib/PublicInbox/IMAP.pm            |  4 ++--
 lib/PublicInbox/IMAPD.pm           | 15 ++++++++++++---
 lib/PublicInbox/LeiLsMailSource.pm |  6 ++++++
 lib/PublicInbox/NetReader.pm       | 30 +++++++++++++++++++++++++++---
 4 files changed, 47 insertions(+), 8 deletions(-)

[PATCH 1/3] net_reader: emit .onion help for potential Tor users

[Eric Wong]

We can't easily use torsocks, here, so try to be helpful
when it comes to proxy support.
---
 lib/PublicInbox/NetReader.pm | 30 +++++++++++++++++++++++++++---
 1 file changed, 27 insertions(+), 3 deletions(-)

diff --git a/lib/PublicInbox/NetReader.pm b/lib/PublicInbox/NetReader.pm
index f0f56431..abcb5d2f 100644
--- a/lib/PublicInbox/NetReader.pm
+++ b/lib/PublicInbox/NetReader.pm
@@ -56,6 +56,28 @@ sub mic_new ($$$$) {
 
 sub auth_anon_cb { '' }; # for Mail::IMAPClient::Authcallback
 
+sub onion_hint ($$) {
+	my ($lei, $uri) = @_;
+	$uri->host =~ /\.onion\z/i or return "\n";
+	my $t = $uri->isa('PublicInbox::URIimap') ? 'imap' : 'nntp';
+	my $url = uri_section($uri);
+	my $set_cfg = 'lei config';
+	if (!$lei) { # public-inbox-watch
+		my $f = $ENV{PI_CONFIG} || '~/.public-inbox/config';
+		$set_cfg = "git config -f $f";
+	}
+	<<EOM
+
+Assuming you have Tor configured and running locally on port 9050,
+try configuring a socks5h:// proxy:
+
+	url=$url
+	$set_cfg $t.\$url.proxy socks5h://127.0.0.1:9050
+
+...before retrying your current command
+EOM
+}
+
 # mic_for may prompt the user and store auth info, prepares mic_get
 sub mic_for ($$$$) { # mic = Mail::IMAPClient
 	my ($self, $uri, $mic_common, $lei) = @_;
@@ -81,7 +103,8 @@ sub mic_for ($$$$) { # mic = Mail::IMAPClient
 	$mic_arg->{Ssl} = 1 if $uri->scheme eq 'imaps';
 	require PublicInbox::IMAPClient;
 	my $mic = mic_new($self, $mic_arg, $sec, $uri) or
-			die "E: <$uri> new: $@\n";
+		die "E: <$uri> new: $@".onion_hint($lei, $uri);
+
 	# default to using STARTTLS if it's available, but allow
 	# it to be disabled since I usually connect to localhost
 	if (!$mic_arg->{Ssl} && !defined($mic_arg->{Starttls}) &&
@@ -145,7 +168,7 @@ sub nn_new ($$$) {
 		eval { $nn = PublicInbox::NetNNTPSocks->new_socks(%$nn_arg) };
 		die "E: <$uri> $@\n" if $@;
 	} else {
-		$nn = Net::NNTP->new(%$nn_arg) or die "E: <$uri> new: $!\n";
+		$nn = Net::NNTP->new(%$nn_arg) or return;
 	}
 
 	# default to using STARTTLS if it's available, but allow
@@ -202,7 +225,8 @@ sub nn_for ($$$$) { # nn = Net::NNTP
 	$nn_arg->{SSL} = 1 if $uri->secure; # snews == nntps
 	my $sa = $self->{-proxy_cli};
 	%$nn_arg = (%$nn_arg, %$sa) if $sa;
-	my $nn = nn_new($nn_arg, $nntp_cfg, $uri);
+	my $nn = nn_new($nn_arg, $nntp_cfg, $uri) or
+		die "E: <$uri> new: $@".onion_hint($lei, $uri);
 	if ($cred) {
 		$cred->fill($lei) unless defined($p); # may prompt user here
 		if ($nn->authinfo($u, $p)) {

[PATCH 2/3] lei ls-mail-source: sort IMAP folder names

[Eric Wong]

Otherwise, public-inbox-imapd will emit mailboxes in random
order (as IMAP servers do not need to guarantee any sort of
ordering).  We'll take into account numeric slice numbers
generated by -imapd if they exist, so slice "80" doesn't show up
next to "8".
---
 lib/PublicInbox/LeiLsMailSource.pm | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/lib/PublicInbox/LeiLsMailSource.pm b/lib/PublicInbox/LeiLsMailSource.pm
index 71e253d9..f012e10e 100644
--- a/lib/PublicInbox/LeiLsMailSource.pm
+++ b/lib/PublicInbox/LeiLsMailSource.pm
@@ -27,6 +27,12 @@ sub input_path_url { # overrides LeiInput version
 		my $sec = $lei->{net}->can('uri_section')->($uri);
 		my $mic = $lei->{net}->mic_get($uri);
 		my $l = $mic->folders_hash($uri->path); # server-side filter
+		@$l = map { $_->[2] } # undo Schwartzian transform below:
+			sort { $a->[0] cmp $b->[0] || $a->[1] <=> $b->[1] }
+			map { # prepare to sort -imapd slices numerically
+				$_->{name} =~ /\A(.+?)\.([0-9]+)\z/ ?
+				[ $1, $2 + 0, $_ ] : [ $_->{name}, -1, $_ ];
+			} @$l;
 		@f = map { "$sec/$_->{name}" } @$l;
 		if ($json) {
 			$_->{url} = "$sec/$_->{name}" for @$l;

[PATCH 3/3] imapd: sort LIST response

[Eric Wong]

While RFC 3501 doesn't require LIST responses be sorted,
it makes reading protocol dumps easier and we memoize it
once per-refresh, so it shouldn't be too expensive even
with thousands of folders.
---
 lib/PublicInbox/IMAP.pm  |  4 ++--
 lib/PublicInbox/IMAPD.pm | 15 ++++++++++++---
 2 files changed, 14 insertions(+), 5 deletions(-)

diff --git a/lib/PublicInbox/IMAP.pm b/lib/PublicInbox/IMAP.pm
index 37e07dae..27013ea5 100644
--- a/lib/PublicInbox/IMAP.pm
+++ b/lib/PublicInbox/IMAP.pm
@@ -384,7 +384,7 @@ sub ensure_slices_exist ($$$) {
 		push @created, $sub_mailbox;
 	}
 	return unless @created;
-	my $l = $imapd->{inboxlist} or return;
+	my $l = $imapd->{mailboxlist} or return;
 	push @$l, map { qq[* LIST (\\HasNoChildren) "." $_\r\n] } @created;
 }
 
@@ -850,7 +850,7 @@ sub cmd_status ($$$;@) {
 my %patmap = ('*' => '.*', '%' => '[^\.]*');
 sub cmd_list ($$$$) {
 	my ($self, $tag, $refname, $wildcard) = @_;
-	my $l = $self->{imapd}->{inboxlist};
+	my $l = $self->{imapd}->{mailboxlist};
 	if ($refname eq '' && $wildcard eq '') {
 		# request for hierarchy delimiter
 		$l = [ qq[* LIST (\\Noselect) "." ""\r\n] ];
diff --git a/lib/PublicInbox/IMAPD.pm b/lib/PublicInbox/IMAPD.pm
index 7425409d..6aa3d12f 100644
--- a/lib/PublicInbox/IMAPD.pm
+++ b/lib/PublicInbox/IMAPD.pm
@@ -70,12 +70,21 @@ sub imapd_refresh_finalize {
 	}
 	%$mailboxes = (%$mailboxes, %{$imapd->{mailboxes}});
 	$imapd->{mailboxes} = $mailboxes;
-	$imapd->{inboxlist} = [
+	$imapd->{mailboxlist} = [
+		map { $_->[2] }
+		sort { $a->[0] cmp $b->[0] || $a->[1] <=> $b->[1] }
 		map {
-			my $no = $mailboxes->{$_} == $dummy ? '' : 'No';
 			my $u = $_; # capitalize "INBOX" for user-familiarity
 			$u =~ s/\Ainbox(\.|\z)/INBOX$1/i;
-			qq[* LIST (\\Has${no}Children) "." $u\r\n]
+			if ($mailboxes->{$_} == $dummy) {
+				[ $u, -1,
+				  qq[* LIST (\\HasChildren) "." $u\r\n]]
+			} else {
+				$u =~ /\A(.+)\.([0-9]+)\z/ or
+					die "BUG: `$u' has no slice digit(s)";
+				[ $1, $2 + 0,
+				  qq[* LIST (\\HasNoChildren) "." $u\r\n] ]
+			}
 		} keys %$mailboxes
 	];
 	$imapd->{pi_cfg} = $pi_cfg;