fix: external link ignore mailto: & javascript: #3812

SukkaW · 2019-10-27T13:26:45Z

What does it do?

How to test

git clone -b external-link-exclude https://github.com/sukkaw/hexo.git
cd hexo
npm install
npm test

Screenshots

Pull request tasks

Add test cases for the changes.
Passed the CI test.

Close hexojs#3796

coveralls · 2019-10-27T13:34:20Z

Coverage increased (+0.008%) to 97.272% when pulling ec465a5 on SukkaW:external-link-exclude into 4bc90de on hexojs:master.

curbengh · 2019-10-28T03:39:46Z

lib/plugins/filter/after_post_render/external_link.js

@@ -37,7 +37,7 @@ function externalLinkFilter(data) {
    config.external_link.field !== 'post') return;

  data.content = data.content.replace(/<a.*?(href=['"](.*?)['"]).*?>/gi, (str, hrefStr, href) => {
-    if (/target=/gi.test(str) || !isExternal(href, config)) return str;
+    if (/target=/gi.test(str) || href.startsWith('mailto:') || href.startsWith('javascript:') || !isExternal(href, config)) return str;


there are countless of types (data:, vbscript: and so on), can test whether it's a link protocol (http/ftp) or not by testing whether URL(href).origin is null. See encodeURL().

OK, I will change to that.

It required WHATWG URL API. I might mitgate external_link filter to use it in this PR.

curbengh

need to handle some oddity in whatwg.

curbengh · 2019-10-28T05:44:07Z

lib/plugins/filter/after_post_render/external_link.js


-  if (!data.protocol || !sitehost) return false;
+  if (!data.protocol || !sitehost || !data.origin) return false;


when there is no data.origin, it returns a string value of 'null', not null type.

!data.protocol should be removed, because it's not null even in javascript:foobar.

const url = new URL('javascript:foobar') console.log(url.protocol) // 'javascript:'

data variable will be string type if url is internal link.

you need to check the type of data first, otherwise data.origin will cause error if internal link.

if (!sitehost || typeof data === 'string') return false; if (data.origin === 'null') return false;

curbengh · 2019-10-28T05:59:32Z

lib/plugins/filter/after_post_render/external_link.js

  const host = data.hostname;
-  const sitehost = parse(config.url).hostname || config.url;
+  const sitehost = urlObj(config.url).hostname || config.url;


urlObj(config.url).hostname would throw error if config.url doesn't have http.

To handle that case,

const sitehost = typeof urlObj(config.url) === 'object' ? urlObj(config.url).hostname : config.url;

@curbengh

Apply code suggestions from code review by @curbengh

curbengh · 2019-10-28T06:45:16Z

test/scripts/filters/external_link.js

@@ -208,23 +208,27 @@ describe('External link - post', () => {
      '# External link test',
      '1. External link',
      '<a href="https://hexo.io/">Hexo</a>',
-      '2. External link with "rel" Attribute',
+      '2. Link with hash (#), mailto: , javascript: shouldn\'t be processed',
+      '<a href="#top">Hexo</a>',


SukkaW · 2019-10-28T09:09:41Z

I might implement is_external_link() helper in another PR, so that isExternal() can be used across both filters.

This reverts commit 91a4784.

@curbengh

* fix: external link ignore mailto: & javascript: Close hexojs#3796 * refactor: use startsWith instead of regex * refactor(external_link): use whatwg url * fix(external_link): handle whatwg url api Apply code suggestions from code review by @curbengh

fix: external link ignore mailto: & javascript:

9ff66ed

Close hexojs#3796

SukkaW requested a review from curbengh October 27, 2019 13:26

refactor: use startsWith instead of regex

3222513

SukkaW mentioned this pull request Oct 27, 2019

fix: ignore links with mailto: javascript: hexojs/hexo-filter-nofollow#6

Closed

curbengh requested changes Oct 28, 2019

View reviewed changes

SukkaW requested a review from curbengh October 28, 2019 05:14

refactor(external_link): use whatwg url

ab23935

SukkaW force-pushed the external-link-exclude branch from 98fd59a to ab23935 Compare October 28, 2019 05:15

curbengh requested changes Oct 28, 2019

View reviewed changes

fix(external_link): handle whatwg url api

ec465a5

Apply code suggestions from code review by @curbengh

SukkaW requested a review from curbengh October 28, 2019 06:29

curbengh added this to the v4.1.0 milestone Oct 28, 2019

curbengh reviewed Oct 28, 2019

View reviewed changes

curbengh approved these changes Oct 28, 2019

View reviewed changes

SukkaW merged commit 91a4784 into hexojs:master Oct 28, 2019

1v9 referenced this pull request in theme-next/hexo-theme-next Oct 30, 2019

Optimize the behavior of back2top and a[role="button"]

38dc1de

curbengh mentioned this pull request Nov 5, 2019

Regression in CI benchmark #3833

Closed

curbengh added a commit to curbengh/hexo that referenced this pull request Nov 5, 2019

Revert "fix: external link ignore mailto: & javascript: (hexojs#3812)"

9b3f828

This reverts commit 91a4784.

curbengh added a commit to curbengh/hexo that referenced this pull request Nov 5, 2019

Revert "fix: external link ignore mailto: & javascript: (hexojs#3812)"

de496cd

This reverts commit 91a4784.

curbengh mentioned this pull request Nov 5, 2019

Revert "fix: external link ignore mailto: & javascript: (#3812)" #3834

Closed

2 tasks

This was referenced Nov 6, 2019

test/refactor: update isExternalLink #3839

Closed

WHATWG URL API performance issue #3846

Open

ppoffice mentioned this pull request Nov 12, 2019

back-to-top feature with a problem ppoffice/hexo-theme-icarus#554

Closed

2 tasks

SukkaW mentioned this pull request Dec 20, 2019

test(benchmark): skip checking completion time in hot processing #3993

Merged

2 tasks

snyk-bot mentioned this pull request Mar 16, 2020

[Snyk] Upgrade hexo from 4.0.0 to 4.2.0 MichaelKohler/michaelkohler.info#14

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: external link ignore mailto: & javascript: #3812

fix: external link ignore mailto: & javascript: #3812

SukkaW commented Oct 27, 2019 •

edited by curbengh

Loading

coveralls commented Oct 27, 2019 •

edited

Loading

curbengh Oct 28, 2019

SukkaW Oct 28, 2019 •

edited

Loading

curbengh left a comment

curbengh Oct 28, 2019

curbengh Oct 28, 2019

curbengh Oct 28, 2019

curbengh Oct 28, 2019

SukkaW commented Oct 28, 2019 •

edited

Loading


		if (!data.protocol \|\| !sitehost) return false;
		if (!data.protocol \|\| !sitehost \|\| !data.origin) return false;

fix: external link ignore mailto: & javascript: #3812

fix: external link ignore mailto: & javascript: #3812

Conversation

SukkaW commented Oct 27, 2019 • edited by curbengh Loading

What does it do?

How to test

Screenshots

Pull request tasks

coveralls commented Oct 27, 2019 • edited Loading

curbengh Oct 28, 2019

Choose a reason for hiding this comment

SukkaW Oct 28, 2019 • edited Loading

Choose a reason for hiding this comment

curbengh left a comment

Choose a reason for hiding this comment

curbengh Oct 28, 2019

Choose a reason for hiding this comment

curbengh Oct 28, 2019

Choose a reason for hiding this comment

curbengh Oct 28, 2019

Choose a reason for hiding this comment

curbengh Oct 28, 2019

Choose a reason for hiding this comment

SukkaW commented Oct 28, 2019 • edited Loading

SukkaW commented Oct 27, 2019 •

edited by curbengh

Loading

coveralls commented Oct 27, 2019 •

edited

Loading

SukkaW Oct 28, 2019 •

edited

Loading

SukkaW commented Oct 28, 2019 •

edited

Loading