Skip to content

HTML-encode attributes in <tspan>s and <a>s #791

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

Merged
merged 3 commits into from
Jul 29, 2016
Merged

HTML-encode attributes in <tspan>s and <a>s #791

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9e2f251
HTML encode attributes in <tspan>s and <a>s
scjody Jul 29, 2016
4e2761c
Add tests of <tspan> generation
scjody Jul 29, 2016
763485c
Add test that relative links work
scjody Jul 29, 2016
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
16 changes: 12 additions & 4 deletions src/lib/svg_text_utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,15 @@ util.plainText = function(_str) {
return (_str || '').replace(STRIP_TAGS, ' ');
};

function encodeForHTML(_str) {
return (_str || '').replace(/&/g, '&amp;')
.replace(/</g, '&lt;')
.replace(/>/g, '&gt;')
.replace(/"/g, '&quot;')
.replace(/'/g, '&#x27;')
.replace(/\//g, '&#x2F;');
}

function convertToSVG(_str) {
var htmlEntitiesDecoded = Plotly.util.html_entity_decode(_str);
var result = htmlEntitiesDecoded
Expand Down Expand Up @@ -270,15 +279,14 @@ function convertToSVG(_str) {
// remove quotes, leading '=', replace '&' with '&amp;'
var href = extra.substr(4)
.replace(/["']/g, '')
.replace(/=/, '')
.replace(/&/g, '&amp;');
.replace(/=/, '');

// check protocol
var dummyAnchor = document.createElement('a');
dummyAnchor.href = href;
if(PROTOCOLS.indexOf(dummyAnchor.protocol) === -1) return '<a>';

return '<a xlink:show="new" xlink:href="' + href + '">';
return '<a xlink:show="new" xlink:href="' + encodeForHTML(href) + '">';
}
}
else if(tag === 'br') return '<br>';
Expand All @@ -302,7 +310,7 @@ function convertToSVG(_str) {
// most of the svg css users will care about is just like html,
// but font color is different. Let our users ignore this.
extraStyle = extraStyle[1].replace(/(^|;)\s*color:/, '$1 fill:');
style = (style ? style + ';' : '') + extraStyle;
style = (style ? style + ';' : '') + encodeForHTML(extraStyle);
}

return tspanStart + (style ? ' style="' + style + '"' : '') + '>';
Expand Down
60 changes: 60 additions & 0 deletions test/jasmine/tests/svg_text_utils_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,11 @@ describe('svg+text utils', function() {
expect(a.attr('xlink:show')).toBe(href === null ? null : 'new');
}

function assertTspanStyle(node, style) {
var tspan = node.select('tspan');
expect(tspan.attr('style')).toBe(style);
}

function assertAnchorAttrs(node) {
var a = node.select('a');

Expand Down Expand Up @@ -75,6 +80,16 @@ describe('svg+text utils', function() {
assertAnchorLink(node, null);
});

it('whitelist relative hrefs (interpreted as http)', function() {
var node = mockTextSVGElement(
'<a href="/mylink">mylink</a>'
);

expect(node.text()).toEqual('mylink');
assertAnchorAttrs(node);
assertAnchorLink(node, '/mylink');
});

it('whitelist http hrefs', function() {
var node = mockTextSVGElement(
'<a href="http://bl.ocks.org/">bl.ocks.org</a>'
Expand Down Expand Up @@ -134,5 +149,50 @@ describe('svg+text utils', function() {
assertAnchorLink(node, 'https://abc.com/myFeature.jsp?name=abc&pwd=def');
});
});

it('allow basic spans', function() {
var node = mockTextSVGElement(
'<span>text</span>'
);

expect(node.text()).toEqual('text');
assertTspanStyle(node, null);
});

it('ignore unquoted styles in spans', function() {
var node = mockTextSVGElement(
'<span style=unquoted>text</span>'
);

expect(node.text()).toEqual('text');
assertTspanStyle(node, null);
});

it('allow quoted styles in spans', function() {
var node = mockTextSVGElement(
'<span style="quoted: yeah;">text</span>'
);

expect(node.text()).toEqual('text');
assertTspanStyle(node, 'quoted: yeah;');
});

it('ignore extra stuff after span styles', function() {
var node = mockTextSVGElement(
'<span style="quoted: yeah;"disallowed: indeed;">text</span>'
);

expect(node.text()).toEqual('text');
assertTspanStyle(node, 'quoted: yeah;');
});

it('escapes HTML entities in span styles', function() {
var node = mockTextSVGElement(
'<span style="quoted: yeah&\';;">text</span>'
);

expect(node.text()).toEqual('text');
assertTspanStyle(node, 'quoted: yeah&\';;');
});
});
});