#!/usr/bin/env python3
"""Generate the portable VDD report from the maintained Markdown and SVG sources."""
import argparse
import base64
import html
from html.parser import HTMLParser
from pathlib import Path
import re
from string import Template
import sys
from urllib.parse import quote, urlsplit
HERE = Path(__file__).resolve().parent
sys.path.insert(0, str(HERE.parent / 'deploy' / 'ubuntu'))
from document_site import markdown, title_for # noqa: E402
DOCUMENTS = {
'VDD_HOST_INTEGRATION.ko.md': 'design',
'VDD_PRIVACY_VERIFICATION.ko.md': 'verify',
}
IMAGES = {
'diagrams/vdd-privacy/' + name + '.svg'
for name in ('responsibilities', 'display-decision', 'privacy-lifetime')
}
OUTPUT = HERE / 'vdd-privacy-report.html'
class Portable(HTMLParser):
def __init__(self, prefix):
super().__init__(convert_charrefs=False)
self.prefix, self.parts = prefix, []
def target(self, value):
parsed = urlsplit(value)
if parsed.scheme or parsed.netloc:
return value
if value.startswith('#'):
return '#' + self.prefix + '-' + value[1:]
if parsed.path in DOCUMENTS:
prefix = DOCUMENTS[parsed.path]
return '#' + prefix + ('-' + parsed.fragment if parsed.fragment else '')
return value
def handle_starttag(self, tag, attrs):
updated = []
for key, value in attrs:
if key == 'id':
value = self.prefix + '-' + value
elif key == 'href':
value = self.target(value)
elif tag == 'img' and key == 'src':
if value not in IMAGES:
raise ValueError('Unexpected report image: ' + value)
value = 'data:image/svg+xml;base64,' + base64.b64encode((HERE / value).read_bytes()).decode('ascii')
updated.append(key if value is None else key + '="' + html.escape(value, quote=True) + '"')
if tag == 'details':
updated.append('open')
# Preserve document hierarchy below the report title and section title.
if re.fullmatch('h[2-5]', tag):
tag = 'h' + str(int(tag[1]) + 1)
self.parts.append('<' + tag + (' ' + ' '.join(updated) if updated else '') + '>')
def handle_startendtag(self, tag, attrs):
self.handle_starttag(tag, attrs)
if tag not in ('area', 'base', 'br', 'col', 'embed', 'hr', 'img', 'input', 'link', 'meta', 'param', 'source', 'track', 'wbr'):
self.handle_endtag(tag)
def handle_endtag(self, tag):
if re.fullmatch('h[2-5]', tag):
tag = 'h' + str(int(tag[1]) + 1)
self.parts.append('' + tag + '>')
def handle_data(self, value): self.parts.append(value)
def handle_entityref(self, value): self.parts.append('&' + value + ';')
def handle_charref(self, value): self.parts.append('' + value + ';')
def portable(source, prefix):
parser = Portable(prefix)
parser.feed(source)
parser.close()
return ''.join(parser.parts)
def render():
navigation, articles = [], []
for filename, prefix in DOCUMENTS.items():
source = (HERE / filename).read_text(encoding='utf-8')
title = html.escape(title_for(filename, source))
toc, body = markdown(source)
navigation.append('' + title + '' + portable(toc, prefix))
articles.append(''
''
'' + portable(body, prefix) + '')
template = Template((HERE / 'vdd-privacy-report.template.html').read_text(encoding='utf-8'))
css = (HERE.parent / 'deploy/ubuntu/document-site.css').read_text(encoding='utf-8')
return template.substitute(styles=css, navigation='\n'.join(navigation), articles='\n'.join(articles))
def main():
parser = argparse.ArgumentParser(description=__doc__)
parser.add_argument('--check', action='store_true', help='Check that the committed HTML matches its sources.')
args = parser.parse_args()
rendered = render()
if args.check:
if not OUTPUT.exists() or OUTPUT.read_text(encoding='utf-8') != rendered:
raise SystemExit('Report is stale; run python3 design/render_vdd_privacy_report.py')
print('VDD_REPORT_CHECKED ' + str(OUTPUT))
else:
OUTPUT.write_text(rendered, encoding='utf-8')
print('VDD_REPORT_GENERATED ' + str(OUTPUT))
if __name__ == '__main__':
main()