user/dev discussion of public-inbox itself
 help / color / mirror / code / Atom feed
From: Eric Wong <e@80x24.org>
To: meta@public-inbox.org
Subject: [PATCH 7/8] uri_imap: support uid/auth/user as full accessors
Date: Fri, 21 May 2021 10:28:31 +0000	[thread overview]
Message-ID: <20210521102832.10784-8-e@80x24.org> (raw)
In-Reply-To: <20210521102832.10784-1-e@80x24.org>

We will need this for mail synchronization
---
 lib/PublicInbox/URIimap.pm | 82 ++++++++++++++++++++++++++++++--------
 t/uri_imap.t               | 60 +++++++++++++++++++++-------
 2 files changed, 110 insertions(+), 32 deletions(-)

diff --git a/lib/PublicInbox/URIimap.pm b/lib/PublicInbox/URIimap.pm
index f6244137..a309fde0 100644
--- a/lib/PublicInbox/URIimap.pm
+++ b/lib/PublicInbox/URIimap.pm
@@ -12,11 +12,14 @@
 # RFC 2192 also describes ";TYPE=<list_type>"
 package PublicInbox::URIimap;
 use strict;
+use v5.10.1;
 use URI::Split qw(uri_split uri_join); # part of URI
-use URI::Escape qw(uri_unescape);
+use URI::Escape qw(uri_unescape uri_escape);
 use overload '""' => \&as_string;
 
 my %default_ports = (imap => 143, imaps => 993);
+# for enc-auth-type and enc-user in RFC 5092
+my $achar = qr/[A-Za-z0-9%\-_\.\!\$'\(\)\+\,\&\=\*]+/;
 
 sub new {
 	my ($class, $url) = @_;
@@ -86,14 +89,15 @@ sub uidvalidity { # read/write
 	$path =~ m!\A[^;/]+;UIDVALIDITY=([1-9][0-9]*)\b!i ? ($1 + 0) : undef;
 }
 
-sub iuid {
+sub uid {
 	my ($self, $val) = @_;
 	my ($scheme, $auth, $path, $query, $frag) = uri_split($$self);
-	if (defined $val) {
-		if ($path =~ s!/;UID=[^;/]*\b!/;UID=$val!i) {
-			# s// already changed it
-		} else { # both s// failed, so just append
-			$path .= ";UID=$val";
+	if (scalar(@_) == 2) {
+		if (!defined $val) {
+			$path =~ s!/;UID=[^;/]*\b!!i;
+		} else {
+			$path =~ s!/;UID=[^;/]*\b!/;UID=$val!i or
+				$path .= ";UID=$val";
 		}
 		$$self = uri_join($scheme, $auth, $path, $query);
 	}
@@ -114,12 +118,34 @@ sub authority {
 }
 
 sub user {
-	my ($self) = @_;
-	my (undef, $auth) = uri_split($$self);
-	$auth =~ s/@.*\z// or return undef; # drop host:port
-	$auth =~ s/;.*\z//; # drop ;AUTH=...
-	$auth =~ s/:.*\z//; # drop password
-	uri_unescape($auth);
+	my ($self, $val) = @_;
+	my ($scheme, $auth, $path, $query) = uri_split($$self);
+	my $at_host_port;
+	$auth =~ s/(@.*)\z// and $at_host_port = $1; # stash host:port for now
+	if (scalar(@_) == 2) { # set, this clobbers password, too
+		if (defined $val) {
+			my $uval = uri_escape($val);
+			if (defined($at_host_port)) {
+				$auth =~ s!\A.*?(;AUTH=$achar).*!$uval$1!ix
+					or $auth = $uval;
+			} else {
+				substr($auth, 0, 0) = "$uval@";
+			}
+		} elsif (defined($at_host_port)) { # clobber
+			$auth =~ s!\A.*?(;AUTH=$achar).*!$1!i or $auth = '';
+			if ($at_host_port && $auth eq '') {
+				$at_host_port =~ s/\A\@//;
+			}
+		}
+		$at_host_port //= '';
+		$$self = uri_join($scheme, $auth.$at_host_port, $path, $query);
+		$val;
+	} else { # read-only
+		$at_host_port // return undef; # explicit undef for scalar
+		$auth =~ s/;.*\z//; # drop ;AUTH=...
+		$auth =~ s/:.*\z//; # drop password
+		$auth eq '' ? undef : uri_unescape($auth);
+	}
 }
 
 sub password {
@@ -131,10 +157,32 @@ sub password {
 }
 
 sub auth {
-	my ($self) = @_;
-	my (undef, $auth) = uri_split($$self);
-	$auth =~ s/@.*\z//; # drop host:port
-	$auth =~ /;AUTH=(.+)\z/i ? uri_unescape($1) : undef;
+	my ($self, $val) = @_;
+	my ($scheme, $auth, $path, $query) = uri_split($$self);
+	my $at_host_port;
+	$auth =~ s/(@.*)\z// and $at_host_port = $1; # stash host:port for now
+	if (scalar(@_) == 2) {
+		if (defined $val) {
+			my $uval = uri_escape($val);
+			if ($auth =~ s!;AUTH=$achar!;AUTH=$uval!ix) {
+				# replaced existing
+			} elsif (defined($at_host_port)) {
+				$auth .= ";AUTH=$uval";
+			} else {
+				substr($auth, 0, 0) = ";AUTH=$uval@";
+			}
+		} else { # clobber
+			$auth =~ s!;AUTH=$achar!!i;
+			if ($at_host_port && $auth eq '') {
+				$at_host_port =~ s/\A\@//;
+			}
+		}
+		$at_host_port //= '';
+		$$self = uri_join($scheme, $auth.$at_host_port, $path, $query);
+		$val;
+	} else { # read-only
+		$auth =~ /;AUTH=(.+)\z/i ? uri_unescape($1) : undef;
+	}
 }
 
 sub scheme {
diff --git a/t/uri_imap.t b/t/uri_imap.t
index ed24fc1b..14f0f346 100644
--- a/t/uri_imap.t
+++ b/t/uri_imap.t
@@ -2,7 +2,7 @@
 # Copyright (C) 2020-2021 all contributors <meta@public-inbox.org>
 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
 use strict;
-use Test::More;
+use v5.10.1;
 use PublicInbox::TestCommon;
 require_mods 'URI::Split';
 use_ok 'PublicInbox::URIimap';
@@ -69,36 +69,66 @@ $uri = PublicInbox::URIimap->new('imap://0/mmm;UIDVALIDITY=21');
 is($uri->uidvalidity, 21, 'multi-digit UIDVALIDITY');
 $uri = PublicInbox::URIimap->new('imap://0/mmm;UIDVALIDITY=bogus');
 is($uri->uidvalidity, undef, 'bogus UIDVALIDITY');
-is($uri->uidvalidity(2), 2, 'iuid set');
+is($uri->uidvalidity(2), 2, 'uid set');
 is($$uri, 'imap://0/mmm;UIDVALIDITY=2', 'bogus uidvalidity replaced');
-is($uri->uidvalidity(13), 13, 'iuid set');
+is($uri->uidvalidity(13), 13, 'uid set');
 is($$uri, 'imap://0/mmm;UIDVALIDITY=13', 'valid uidvalidity replaced');
 
 $uri = PublicInbox::URIimap->new('imap://0/mmm');
-is($uri->uidvalidity(2), 2, 'iuid set');
+is($uri->uidvalidity(2), 2, 'uid set');
 is($$uri, 'imap://0/mmm;UIDVALIDITY=2', 'uidvalidity appended');
-is($uri->iuid, undef, 'no iuid');
+is($uri->uid, undef, 'no uid');
 
 is(PublicInbox::URIimap->new('imap://0/x;uidvalidity=1')->canonical->as_string,
 	'imap://0/x;UIDVALIDITY=1', 'capitalized UIDVALIDITY');
 
 $uri = PublicInbox::URIimap->new('imap://0/mmm/;uid=8');
 is($uri->canonical->as_string, 'imap://0/mmm/;UID=8', 'canonicalized UID');
-is($uri->mailbox, 'mmm', 'mailbox works with iuid');
-is($uri->iuid, 8, 'iuid extracted');
-is($uri->iuid(9), 9, 'iuid set');
-is($$uri, 'imap://0/mmm/;UID=9', 'correct iuid when stringified');
-is($uri->uidvalidity(1), 1, 'set uidvalidity with iuid');
+is($uri->mailbox, 'mmm', 'mailbox works with uid');
+is($uri->uid, 8, 'uid extracted');
+is($uri->uid(9), 9, 'uid set');
+is($$uri, 'imap://0/mmm/;UID=9', 'correct uid when stringified');
+is($uri->uidvalidity(1), 1, 'set uidvalidity with uid');
 is($$uri, 'imap://0/mmm;UIDVALIDITY=1/;UID=9',
-	'uidvalidity added with iuid');
-is($uri->uidvalidity(4), 4, 'set uidvalidity with iuid');
+	'uidvalidity added with uid');
+is($uri->uidvalidity(4), 4, 'set uidvalidity with uid');
 is($$uri, 'imap://0/mmm;UIDVALIDITY=4/;UID=9',
-	'uidvalidity replaced with iuid');
-is($uri->iuid(3), 3, 'iuid set with uidvalidity');
-is($$uri, 'imap://0/mmm;UIDVALIDITY=4/;UID=3', 'iuid replaced properly');
+	'uidvalidity replaced with uid');
+is($uri->uid(3), 3, 'uid set with uidvalidity');
+is($$uri, 'imap://0/mmm;UIDVALIDITY=4/;UID=3', 'uid replaced properly');
 
 my $lc = lc($$uri);
 is(PublicInbox::URIimap->new($lc)->canonical->as_string, "$$uri",
 	'canonical uppercased both params');
 
+is($uri->uid(undef), undef, 'uid can be clobbered');
+is($$uri, 'imap://0/mmm;UIDVALIDITY=4', 'uid dropped');
+
+$uri->auth('ANONYMOUS');
+is($$uri, 'imap://;AUTH=ANONYMOUS@0/mmm;UIDVALIDITY=4', 'AUTH= set');
+is($uri->user, undef, 'user is undef w/ AUTH=');
+is($uri->password, undef, 'password is undef w/ AUTH=');
+
+$uri->user('foo');
+is($$uri, 'imap://foo;AUTH=ANONYMOUS@0/mmm;UIDVALIDITY=4', 'user set w/AUTH');
+is($uri->password, undef, 'password is undef w/ AUTH= & user');
+$uri->auth(undef);
+is($$uri, 'imap://foo@0/mmm;UIDVALIDITY=4', 'user remains set w/o auth');
+is($uri->password, undef, 'password is undef w/ user only');
+
+$uri->user('bar');
+is($$uri, 'imap://bar@0/mmm;UIDVALIDITY=4', 'user set w/o AUTH');
+$uri->auth('NTML');
+is($$uri, 'imap://bar;AUTH=NTML@0/mmm;UIDVALIDITY=4', 'auth set w/user');
+$uri->auth(undef);
+$uri->user(undef);
+is($$uri, 'imap://0/mmm;UIDVALIDITY=4', 'auth and user both cleared');
+is($uri->user, undef, 'user is undef');
+is($uri->auth, undef, 'auth is undef');
+is($uri->password, undef, 'password is undef');
+$uri = PublicInbox::URIimap->new('imap://[::1]:36281/');
+my $cred = bless { username => $uri->user, password => $uri->password };
+is($cred->{username}, undef, 'user is undef in array context');
+is($cred->{password}, undef, 'password is undef in array context');
+
 done_testing;

  parent reply	other threads:[~2021-05-21 10:28 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-21 10:28 [PATCH 0/8] lei: export-kw, IMAP import incompatibility Eric Wong
2021-05-21 10:28 ` [PATCH 1/8] treewide: favor open(..., '+<&=', $fd) Eric Wong
2021-05-21 10:28 ` [PATCH 2/8] lei: drop EOFpipe in favor of PktOp Eric Wong
2021-05-21 10:28 ` [PATCH 3/8] lei tag: support tagging index-only messages Eric Wong
2021-05-21 10:28 ` [PATCH 4/8] lei_input: fix canonicalization of Maildirs for sync Eric Wong
2021-05-21 10:28 ` [PATCH 5/8] lei index: support command-line options Eric Wong
2021-05-21 10:28 ` [PATCH 6/8] lei export-kw: new command to export keywords to Maildirs Eric Wong
2021-05-21 10:28 ` Eric Wong [this message]
2021-05-21 10:28 ` [PATCH 8/8] lei import: store IMAP user+auth in mail_sync folder URI Eric Wong

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://public-inbox.org/README

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210521102832.10784-8-e@80x24.org \
    --to=e@80x24.org \
    --cc=meta@public-inbox.org \
    --subject='Re: [PATCH 7/8] uri_imap: support uid/auth/user as full accessors' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

user/dev discussion of public-inbox itself

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://public-inbox.org/meta
	git clone --mirror http://czquwvybam4bgbro.onion/meta
	git clone --mirror http://hjrcffqmbrq6wope.onion/meta
	git clone --mirror http://ou63pmih66umazou.onion/meta

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V1 meta meta/ https://public-inbox.org/meta \
		meta@public-inbox.org
	public-inbox-index meta

Example config snippet for mirrors.
Newsgroups are available over NNTP:
	nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta
	nntp://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/inbox.comp.mail.public-inbox.meta
	nntp://ie5yzdi7fg72h7s4sdcztq5evakq23rdt33mfyfcddc5u3ndnw24ogqd.onion/inbox.comp.mail.public-inbox.meta
	nntp://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/inbox.comp.mail.public-inbox.meta
	nntp://news.gmane.io/gmane.mail.public-inbox.general
 note: .onion URLs require Tor: https://www.torproject.org/

code repositories for project(s) associated with this inbox:

	https://80x24.org/public-inbox.git

AGPL code for this site: git clone https://public-inbox.org/public-inbox.git