Re: [PATCH v2] gitk: Make web links clickable

From: Pratyush Yadav <me@yadavpratyush.com>
Date: Aug 29, 2019, 18:32 UTC
Message-ID: <20190829183207.sy66tyxnnzgvjv35@yadavpratyush.com>
In-Reply-To: <20190829012702.GB3297@blackberry>

On 29/08/19 11:27AM, Paul Mackerras wrote:

Show 35 quoted lines

> This makes gitk look for http or https URLs in the commit description
> and make the URLs clickable.  Clicking on them will invoke an external
> web browser with the URL.
> 
> The web browser command is by default "xdg-open" on Linux, "open" on
> MacOS, and "cmd /c start" on Windows.  The command can be changed in
> the preferences window, and it can include parameters as well as the
> command name.  If it is set to the empty string then URLs will no
> longer be made clickable.
> 
> Signed-off-by: Paul Mackerras <paulus@ozlabs.org>
> ---
> v2: Match URLs anywhere, not just after [Bug]Link:.
> 
>  gitk | 51 ++++++++++++++++++++++++++++++++++++++++++++++++++-
>  1 file changed, 50 insertions(+), 1 deletion(-)
> 
> diff --git a/gitk b/gitk
> index a14d7a1..2a0d00c 100755
> --- a/gitk
> +++ b/gitk
> @@ -7016,6 +7016,7 @@ proc commit_descriptor {p} {
>  
>  # append some text to the ctext widget, and make any SHA1 ID
>  # that we know about be a clickable link.
> +# Also look for URLs of the form "http[s]://..." and make them web links.
>  proc appendwithlinks {text tags} {
>      global ctext linknum curview
>  
> @@ -7032,6 +7033,18 @@ proc appendwithlinks {text tags} {
>  	setlink $linkid link$linknum
>  	incr linknum
>      }
> +    set wlinks [regexp -indices -all -inline -line \
> +		    {https?://[^[:space:]]+} $text]

I know I suggested searching till the first non-whitespace character, 
but thinking more about, there are some problematic cases. Say someone 
has a commit message like:
  
  Foo bar baz (more details at https://example.com/hello)

Or like:

  Check out https://foo.com, https://bar.com

In the first example, the closing parenthesis gets included in the link, but shouldn't be. In the second, the comma after foo.com would be included in the link, but shouldn't be. So maybe use a more sophisticated regex?

A quick Google search gives out the following options [0][1].

[0] gives the following regex:

  https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)

It is kind of ugly to look at, and I'm not even sure if there are any syntax differences with Tcl's regex library.

[1] lists a bunch of regexes and which URLs they work on and which ones they don't. The smallest among them I found is:

  @^(https?|ftp)://[^\s/$.?#].[^\s]*$@iS

Again, I'm not sure how well this would work with Tcl's regex library, or how commonly these URL patterns appear in actual commit messages. Just something to consider.

[0] https://stackoverflow.com/questions/3809401/what-is-a-good-regular-expression-to-match-a-url [1] https://mathiasbynens.be/demo/url-regex

[snip]

-- 
Regards,
Pratyush Yadav