user/dev discussion of public-inbox itself
 help / Atom feed
From: Eric Wong <e@80x24.org>
To: meta@public-inbox.org
Subject: [PATCH] linkify: implement Markdown link compatibility (again)
Date: Tue, 6 Dec 2016 23:42:12 +0000
Message-ID: <20161206234212.GA22817@dcvr> (raw)
In-Reply-To: <20161206231710.GA13120@dcvr>

Although unescaped parentheses in URLs are technically allowed,
they are uncommon.  However, Markdown-like syntaxes are
unfortunately common for URLs, so we might as well support them.

This fixes parentheses detection at sentence endings, as seen
in practice on emails.
---
 lib/PublicInbox/Linkify.pm | 14 ++++++++++----
 t/linkify.t                | 22 ++++++++++++++++++++++
 2 files changed, 32 insertions(+), 4 deletions(-)

diff --git a/lib/PublicInbox/Linkify.pm b/lib/PublicInbox/Linkify.pm
index ea7fd71..acd2a47 100644
--- a/lib/PublicInbox/Linkify.pm
+++ b/lib/PublicInbox/Linkify.pm
@@ -15,7 +15,7 @@ use warnings;
 use Digest::SHA qw/sha1_hex/;
 
 my $SALT = rand;
-my $LINK_RE = qr{\b((?:ftps?|https?|nntps?|gopher)://
+my $LINK_RE = qr{(\()?\b((?:ftps?|https?|nntps?|gopher)://
 		 [\@:\w\.-]+/
 		 (?:[a-z0-9\-\._~!\$\&\';\(\)\*\+,;=:@/%]*)
 		 (?:\?[a-z0-9\-\._~!\$\&\';\(\)\*\+,;=:@/%]+)?
@@ -27,14 +27,20 @@ sub new { bless {}, shift }
 sub linkify_1 {
 	my ($self, $s) = @_;
 	$s =~ s!$LINK_RE!
-		my $url = $1;
+		my $beg = $1 || '';
+		my $url = $2;
 		my $end = '';
 
 		# it's fairly common to end URLs in messages with
 		# '.', ',' or ';' to denote the end of a statement;
 		# assume the intent was to end the statement/sentence
 		# in English
-		if ($url =~ s/([\.,;])\z//) {
+		# Markdown compatibility:
+		if ($beg eq '(') {
+			if ($url =~ s/(\)[\.,;]?)\z//) {
+				$end = $1;
+			}
+		} elsif ($url =~ s/([\.,;])\z//) {
 			$end = $1;
 		}
 
@@ -45,7 +51,7 @@ sub linkify_1 {
 		# only escape ampersands, others do not match LINK_RE
 		$url =~ s/&/&#38;/g;
 		$self->{$key} = $url;
-		'PI-LINK-'. $key . $end;
+		$beg . 'PI-LINK-'. $key . $end;
 	!ge;
 	$s;
 }
diff --git a/t/linkify.t b/t/linkify.t
index 49cbbd6..99acf17 100644
--- a/t/linkify.t
+++ b/t/linkify.t
@@ -57,4 +57,26 @@ use PublicInbox::Linkify;
 	is($s, qq(hello <a\nhref="$u">$u</a> world), "root + fragment");
 }
 
+# Markdown compatibility
+{
+	my $l = PublicInbox::Linkify->new;
+	my $u = 'http://example.com/';
+	my $s = "[markdown]($u)";
+	$s = $l->linkify_1($s);
+	$s = $l->linkify_2($s);
+	is($s, qq![markdown](<a\nhref="$u">$u</a>)!, 'Markdown-compatible');
+
+	$s = qq![markdown]($u "title")!;
+	$s = $l->linkify_1($s);
+	$s = $l->linkify_2($s);
+	is($s, qq![markdown](<a\nhref="$u">$u</a> "title")!,
+		'Markdown title compatible');
+
+	$s = qq![markdown]($u).!;
+	$s = $l->linkify_1($s);
+	$s = $l->linkify_2($s);
+	is($s, qq![markdown](<a\nhref="$u">$u</a>).!,
+		'Markdown-compatible end of sentence');
+}
+
 done_testing();
-- 
EW

      reply index

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-12-06 23:01 [PATCH] linkify: implement Markdown link compatibility Eric Wong
2016-12-06 23:17 ` Eric Wong
2016-12-06 23:42   ` Eric Wong [this message]

Reply instructions:

You may reply publically 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=20161206234212.GA22817@dcvr \
    --to=e@80x24.org \
    --cc=meta@public-inbox.org \
    /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

Archives are clonable:
	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

Newsgroups are available over NNTP:
	nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta
	nntp://ou63pmih66umazou.onion/inbox.comp.mail.public-inbox.meta
	nntp://czquwvybam4bgbro.onion/inbox.comp.mail.public-inbox.meta
	nntp://hjrcffqmbrq6wope.onion/inbox.comp.mail.public-inbox.meta
	nntp://news.gmane.org/gmane.mail.public-inbox.general

 note: .onion URLs require Tor: https://www.torproject.org/
       or Tor2web: https://www.tor2web.org/

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