Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 4 commits into from
Oct 28, 2019
Merged

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

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9ff66ed
fix: external link ignore mailto: & javascript:
SukkaW Oct 27, 2019
3222513
refactor: use startsWith instead of regex
SukkaW Oct 27, 2019
ab23935
refactor(external_link): use whatwg url
SukkaW Oct 28, 2019
ec465a5
fix(external_link): handle whatwg url api
SukkaW Oct 28, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions lib/plugins/filter/after_post_render/external_link.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,23 @@
'use strict';

const { parse } = require('url');
const { URL } = require('url');

const urlObj = (str) => {
try {
return new URL(str);
} catch (err) {
return str;
}
};

const isExternal = (url, config) => {
const exclude = Array.isArray(config.external_link.exclude) ? config.external_link.exclude :
[config.external_link.exclude];
const data = parse(url);
const data = urlObj(url);
const host = data.hostname;
const sitehost = parse(config.url).hostname || config.url;
const sitehost = urlObj(config.url).hostname || config.url;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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;


if (!data.protocol || !sitehost) return false;
if (!data.protocol || !sitehost || !data.origin) return false;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:'

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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;


if (exclude && exclude.length) {
for (const i of exclude) {
Expand All @@ -34,7 +42,7 @@ function externalLinkFilter(data) {
}, config.external_link);
}
if (config.external_link === false || config.external_link.enable === false ||
config.external_link.field !== 'post') return;
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;
Expand Down
16 changes: 12 additions & 4 deletions lib/plugins/filter/after_render/external_link.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
'use strict';

const { parse } = require('url');
const { URL } = require('url');

const urlObj = (str) => {
try {
return new URL(str);
} catch (err) {
return str;
}
};

/**
* Check whether the link is external
Expand All @@ -11,11 +19,11 @@ const { parse } = require('url');
const isExternal = (url, config) => {
const exclude = Array.isArray(config.external_link.exclude) ? config.external_link.exclude :
[config.external_link.exclude];
const data = parse(url);
const data = urlObj(url);
const host = data.hostname;
const sitehost = parse(config.url).hostname || config.url;
const sitehost = urlObj(config.url).hostname || config.url;

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

if (exclude && exclude.length) {
for (const i of exclude) {
Expand Down
32 changes: 20 additions & 12 deletions test/scripts/filters/external_link.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

'<a href="mailto:[email protected]">Hexo</a>',
'<a href="javascript:alert(\'Hexo is awesome!\');">Hexo</a>',
'3. External link with "rel" Attribute',
'<a rel="external" href="https://hexo.io/">Hexo</a>',
'<a href="https://hexo.io/" rel="external">Hexo</a>',
'<a rel="noopenner" href="https://hexo.io/">Hexo</a>',
'<a href="https://hexo.io/" rel="noopenner">Hexo</a>',
'<a rel="external noopenner" href="https://hexo.io/">Hexo</a>',
'<a href="https://hexo.io/" rel="external noopenner">Hexo</a>',
'3. External link with Other Attributes',
'4. External link with Other Attributes',
'<a class="img" href="https://hexo.io/">Hexo</a>',
'<a href="https://hexo.io/" class="img">Hexo</a>',
'4. Internal link',
'5. Internal link',
'<a href="/archives/foo.html">Link</a>',
'5. Ignore links have "target" attribute',
'6. Ignore links have "target" attribute',
'<a href="https://hexo.io/" target="_blank">Hexo</a>',
'6. Ignore links don\'t have "href" attribute',
'7. Ignore links don\'t have "href" attribute',
'<a>Anchor</a>',
'7. Ignore links whose hostname is same as config',
'8. Ignore links whose hostname is same as config',
'<a href="https://example.com">Example Domain</a>'
].join('\n');

Expand All @@ -235,23 +239,27 @@ describe('External link - post', () => {
'# External link test',
'1. External link',
'<a href="https://hexo.io/" target="_blank" rel="noopener">Hexo</a>',
'2. External link with "rel" Attribute',
'2. Link with hash (#), mailto: , javascript: shouldn\'t be processed',
'<a href="#top">Hexo</a>',
'<a href="mailto:[email protected]">Hexo</a>',
'<a href="javascript:alert(\'Hexo is awesome!\');">Hexo</a>',
'3. External link with "rel" Attribute',
'<a rel="external noopener" href="https://hexo.io/" target="_blank">Hexo</a>',
'<a href="https://hexo.io/" target="_blank" rel="external noopener">Hexo</a>',
'<a rel="noopenner" href="https://hexo.io/" target="_blank">Hexo</a>',
'<a href="https://hexo.io/" target="_blank" rel="noopenner">Hexo</a>',
'<a rel="external noopenner" href="https://hexo.io/" target="_blank">Hexo</a>',
'<a href="https://hexo.io/" target="_blank" rel="external noopenner">Hexo</a>',
'3. External link with Other Attributes',
'4. External link with Other Attributes',
'<a class="img" href="https://hexo.io/" target="_blank" rel="noopener">Hexo</a>',
'<a href="https://hexo.io/" target="_blank" rel="noopener" class="img">Hexo</a>',
'4. Internal link',
'5. Internal link',
'<a href="/archives/foo.html">Link</a>',
'5. Ignore links have "target" attribute',
'6. Ignore links have "target" attribute',
'<a href="https://hexo.io/" target="_blank">Hexo</a>',
'6. Ignore links don\'t have "href" attribute',
'7. Ignore links don\'t have "href" attribute',
'<a>Anchor</a>',
'7. Ignore links whose hostname is same as config',
'8. Ignore links whose hostname is same as config',
'<a href="https://example.com">Example Domain</a>'
].join('\n'));
});
Expand Down