Skip to content

htmlreport: escape message and file name in generated pages #8920

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

Open
Nussu06 wants to merge 1 commit into
base: main
Choose a base branch
from
+35 −9
Open

htmlreport: escape message and file name in generated pages #8920

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 9 additions & 9 deletions htmlreport/cppcheck-htmlreport
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -620,15 +620,15 @@ class AnnotateCodeFormatter(HtmlFormatter):
# from actual message
if error.get('verbose') and (error['verbose'] != error['msg']):
index = t.rfind('\n')
t = t[:index] + HTML_EXPANDABLE_INCONCLUSIVE % (error['msg'], html_escape(error['verbose'].replace("\\012", '\n'))) + t[index + 1:]
t = t[:index] + HTML_EXPANDABLE_INCONCLUSIVE % (html_escape(error['msg']), html_escape(error['verbose'].replace("\\012", '\n'))) + t[index + 1:]
else:
t = t.replace('\n', HTML_INCONCLUSIVE % error['msg'])
t = t.replace('\n', HTML_INCONCLUSIVE % html_escape(error['msg']))
except KeyError:
if error.get('verbose') and (error['verbose'] != error['msg']):
index = t.rfind('\n')
t = t[:index] + HTML_EXPANDABLE_ERROR % (error['msg'], html_escape(error['verbose'].replace("\\012", '\n'))) + t[index + 1:]
t = t[:index] + HTML_EXPANDABLE_ERROR % (html_escape(error['msg']), html_escape(error['verbose'].replace("\\012", '\n'))) + t[index + 1:]
else:
t = t.replace('\n', HTML_ERROR % error['msg'])
t = t.replace('\n', HTML_ERROR % html_escape(error['msg']))

line_no = line_no + 1
yield i, t
Expand Down Expand Up @@ -824,7 +824,7 @@ def main() -> None:
if is_remote:
# Construct remote URL for GitHub/GitLab
# tr_str() will use the actual line number, so we can just start with line 1
remote_url = source_dir.rstrip('/') + '/' + filename + '#L1'
remote_url = source_dir.rstrip('/') + '/' + html_escape(filename) + '#L1'
files[filename] = {'errors': [], 'htmlfile': remote_url}
else:
files[filename] = {'errors': [], 'htmlfile': str(file_no) + '.html'}
Expand Down Expand Up @@ -900,10 +900,10 @@ def main() -> None:
(options.title,
htmlFormatter.get_style_defs('.highlight'),
options.title,
': ' + filename))
': ' + html_escape(filename)))
output_file.write(HTML_HEAD_END)

output_file.write(HTML_MENU % (filename.split('/')[-1]))
output_file.write(HTML_MENU % (html_escape(filename.split('/')[-1])))
for error in sorted(errors, key=lambda k: k['line']):
output_file.write("<a href=\"%s#line-%d\"> %s %s</a>" % (data['htmlfile'], error['line'], error['id'], error['line']))
output_file.write(HTML_MENU_END)
Expand Down Expand Up @@ -1006,7 +1006,7 @@ def main() -> None:
for filename, data in sorted(files.items()):
file_error = filename in decode_errors or filename.endswith('*')
is_file = filename != '' and not file_error
row_content = filename if file_error else "<a href=\"%s\">%s</a>" % (data['htmlfile'], filename)
row_content = html_escape(filename) if file_error else "<a href=\"%s\">%s</a>" % (data['htmlfile'], html_escape(filename))
htmlfile = data.get('htmlfile') if is_file else None

output_file.write("\n <tbody class=\"fileEntry\">")
Expand Down Expand Up @@ -1122,7 +1122,7 @@ def main() -> None:
if it == 0:
LENGTH = len(str(i[1])) # <- length of longest number, now get the difference and try to make other numbers align to it

stats_file.write("&#160;" * 3 + str(i[1]) + "&#160;" * (1 + LENGTH - len(str(i[1]))) + "<a href=\"" + files[i[0]]['htmlfile'] + "\"> " + i[0] + "</a><br>\n")
stats_file.write("&#160;" * 3 + str(i[1]) + "&#160;" * (1 + LENGTH - len(str(i[1]))) + "<a href=\"" + files[i[0]]['htmlfile'] + "\"> " + html_escape(i[0]) + "</a><br>\n")
it += 1
if it == 10: # print only the top 10
break
Expand Down
26 changes: 26 additions & 0 deletions test/tools/htmlreport/test_htmlreport.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,32 @@ def testSeverityFilterBar(self):
self.assertIn('onclick="toggleSeverity(this)"', report)
output_directory.cleanup()

def testEscape(self):
with tempfile.TemporaryDirectory() as source_directory:
source_filename = os.path.join(source_directory, '<b>escape.c')
with open(source_filename, 'w') as source_file:
source_file.write('#error <b>escape</b>\n')

with runCheck(
source_filename,
xml_version='2'
) as (report, output_directory):
self.assertIn('&lt;b&gt;escape.c', report)
self.assertNotIn('<b>', report)

with open(os.path.join(output_directory.name, '0.html')) as input_file:
detail_contents = input_file.read()
self.assertIn('&lt;b&gt;escape.c', detail_contents)
self.assertIn('&lt;--- #error &lt;b&gt;escape&lt;/b&gt;', detail_contents)
self.assertNotIn('<b>', detail_contents)

with open(os.path.join(output_directory.name, 'stats.html')) as input_file:
stats_contents = input_file.read()
self.assertIn('&lt;b&gt;escape.c', stats_contents)
self.assertNotIn('<b>', stats_contents)

output_directory.cleanup()


@contextlib.contextmanager
def runCheck(source_filename=None, xml_version='1', xml_filename=None, checkers_filename=None):
Expand Down