Skip to content

Sanitize text before making repr_html #3378

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
pp-mo merged 12 commits into from
Oct 16, 2019
Merged

Sanitize text before making repr_html #3378

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
b2ca88a
Add dask array repr to cube repr
DPeterK Aug 28, 2019
13fbc63
Use non-lazy cube instead
DPeterK Aug 28, 2019
efa7bc1
License header year
DPeterK Aug 28, 2019
cc75761
Merge branch 'cube_repr_data' of https://github.com/DPeterK/iris
stephenworsley Sep 24, 2019
e790e5a
Merge branch 'master' of https://github.com/SciTools/iris
stephenworsley Sep 24, 2019
b2eb86e
Merge branch 'master' of https://github.com/SciTools/iris
stephenworsley Oct 3, 2019
6d877c0
escape possible html code from cube repr_html
stephenworsley Sep 2, 2019
3d185a5
added test coverage and escaped title in cube lists
stephenworsley Oct 10, 2019
a070339
Add init to make missing tests runnable, and small fix.
pp-mo Oct 15, 2019
9572f2c
Fix license header date.
pp-mo Oct 16, 2019
d265cb5
Merge pull request #5 from pp-mo/clean_html_plus
stephenworsley Oct 16, 2019
e69a0d8
removed unescape from test
stephenworsley Oct 16, 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
10 changes: 6 additions & 4 deletions lib/iris/experimental/representation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
from __future__ import (absolute_import, division, print_function)
from six.moves import (filter, input, map, range, zip) # noqa

from html import escape
import re


Expand Down Expand Up @@ -96,7 +97,7 @@ class CubeRepresentation(object):
def __init__(self, cube):
self.cube = cube
self.cube_id = id(self.cube)
self.cube_str = str(self.cube)
self.cube_str = escape(str(self.cube))

self.str_headings = {
'Dimension coordinates:': None,
Expand All @@ -115,9 +116,9 @@ def __init__(self, cube):
self.scalar_cube = self.shapes == ()
self.ndims = self.cube.ndim

self.name = self.cube.name().title().replace('_', ' ')
self.names = self._dim_names()
self.units = self.cube.units
self.name = escape(self.cube.name().title().replace('_', ' '))
self.names = [escape(dim_name) for dim_name in self._dim_names()]
self.units = escape(str(self.cube.units))

def _get_dim_names(self):
"""
Expand Down Expand Up @@ -401,6 +402,7 @@ def make_content(self):
for i, cube in enumerate(self.cubelist):
title = '{i}: {summary}'.format(i=i,
summary=cube.summary(shorten=True))
title = escape(title)
content = cube._repr_html_()
html.append(self._accordian_panel.format(uid=self.cubelist_id,
title=title,
Expand Down
11 changes: 6 additions & 5 deletions lib/iris/tests/integration/experimental/test_CubeRepresentation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# (C) British Crown Copyright 2018, Met Office
# (C) British Crown Copyright 2018 - 2019, Met Office
#
# This file is part of Iris.
#
Expand All @@ -18,6 +18,7 @@

from __future__ import (absolute_import, division, print_function)
from six.moves import (filter, input, map, range, zip) # noqa
from html import escape

# Import iris.tests first so that some things can be initialised before
# importing anything else.
Expand Down Expand Up @@ -136,12 +137,12 @@ def test_identfication(self):

def test_header__name(self):
header = self.representer._make_header()
expected_name = self.cube.name().title().replace('_', ' ')
expected_name = escape(self.cube.name().title().replace('_', ' '))
Comment thread
pp-mo marked this conversation as resolved.
self.assertIn(expected_name, header)

def test_header__units(self):
header = self.representer._make_header()
expected_units = self.cube.units.symbol
expected_units = escape(self.cube.units.symbol)
self.assertIn(expected_units, header)

def test_header__scalar_str(self):
Expand All @@ -160,9 +161,9 @@ def test_content__specific_scalar_coord(self):
# Check a specific scalar coord is present in the main content.
content = self.representer._make_content()
expected_coord = self.cube.coords()[0]
expected_coord_name = expected_coord.name()
expected_coord_name = escape(expected_coord.name())
self.assertIn(expected_coord_name, content)
expected_coord_val = str(expected_coord.points[0])
expected_coord_val = escape(str(expected_coord.points[0]))
self.assertIn(expected_coord_val, content)

def test_content__attributes(self):
Expand Down
8 changes: 6 additions & 2 deletions lib/iris/tests/unit/experimental/representation/test_CubeListRepresentation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@

from __future__ import (absolute_import, division, print_function)
from six.moves import (filter, input, map, range, zip) # noqa
from html import escape, unescape
Comment thread
stephenworsley marked this conversation as resolved.
Outdated

# Import iris.tests first so that some things can be initialised before
# importing anything else.
Expand Down Expand Up @@ -46,6 +47,7 @@ def setUp(self):
stock.lat_lon_cube()])
self.representer = CubeListRepresentation(self.cubes)
self.content = self.representer.make_content()
self.cubes[0].rename('name & <html>')

def test_repr_len(self):
self.assertEqual(len(self.cubes), len(self.content))
Expand All @@ -62,8 +64,10 @@ def test__cube_name_summary_consistency(self):
# Get the cube name out of the repr html...
cube_name = first_contents_line.split('>0: ')[1].split('/')[0]
# ... and prettify it (to be the same as in the following cube repr).
pretty_cube_name = cube_name.strip().replace('_', ' ').title()
self.assertIn(pretty_cube_name, single_cube_html)
unescaped_name = unescape(cube_name)
pretty_cube_name = unescaped_name.strip().replace('_', ' ').title()
pretty_escaped_name = escape(pretty_cube_name)
self.assertIn(pretty_escaped_name, single_cube_html)


@tests.skip_data
Expand Down
5 changes: 3 additions & 2 deletions lib/iris/tests/unit/experimental/representation/test_CubeRepresentation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@

from __future__ import (absolute_import, division, print_function)
from six.moves import (filter, input, map, range, zip) # noqa
from html import escape

# Import iris.tests first so that some things can be initialised before
# importing anything else.
Expand Down Expand Up @@ -81,13 +82,13 @@ class Test__summary_content(tests.IrisTest):
def setUp(self):
self.cube = stock.lat_lon_cube()
# Check we're not tripped up by names containing spaces.
self.cube.rename('Electron density')
self.cube.rename('Electron density (&<html>)')
self.cube.units = '1e11 e/m^3'
self.representer = CubeRepresentation(self.cube)

def test_name(self):
# Check the cube name is being set and formatted correctly.
expected = self.cube.name().replace('_', ' ').title()
expected = escape(self.cube.name().replace('_', ' ').title())
result = self.representer.name
self.assertEqual(expected, result)

Expand Down