forum/utils/html.py

   1 """Utilities for working with HTML."""
   2 import html5lib
   3 from html5lib import sanitizer, serializer, tokenizer, treebuilders, treewalkers
   4
   5 class HTMLSanitizerMixin(sanitizer.HTMLSanitizerMixin):
   6     acceptable_elements = ('a', 'abbr', 'acronym', 'address', 'b', 'big',
   7         'blockquote', 'br', 'caption', 'center', 'cite', 'code', 'col',
   8         'colgroup', 'dd', 'del', 'dfn', 'dir', 'div', 'dl', 'dt', 'em', 'font',
   9         'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'img', 'ins', 'kbd',
  10         'li', 'ol', 'p', 'pre', 'q', 's', 'samp', 'small', 'span', 'strike',
  11         'strong', 'sub', 'sup', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead',
  12         'tr', 'tt', 'u', 'ul', 'var')
  13
  14     acceptable_attributes = ('abbr', 'align', 'alt', 'axis', 'border',
  15         'cellpadding', 'cellspacing', 'char', 'charoff', 'charset', 'cite',
  16         'cols', 'colspan', 'datetime', 'dir', 'frame', 'headers', 'height',
  17         'href', 'hreflang', 'hspace', 'lang', 'longdesc', 'name', 'nohref',
  18         'noshade', 'nowrap', 'rel', 'rev', 'rows', 'rowspan', 'rules', 'scope',
  19         'span', 'src', 'start', 'summary', 'title', 'type', 'valign', 'vspace',
  20         'width')
  21
  22     allowed_elements = acceptable_elements
  23     allowed_attributes = acceptable_attributes
  24     allowed_css_properties = ()
  25     allowed_css_keywords = ()
  26     allowed_svg_properties = ()
  27
  28 class HTMLSanitizer(tokenizer.HTMLTokenizer, HTMLSanitizerMixin):
  29     def __init__(self, stream, encoding=None, parseMeta=True, useChardet=True,
  30                  lowercaseElementName=True, lowercaseAttrName=True):
  31         tokenizer.HTMLTokenizer.__init__(self, stream, encoding, parseMeta,
  32                                          useChardet, lowercaseElementName,
  33                                          lowercaseAttrName)
  34
  35     def __iter__(self):
  36         for token in tokenizer.HTMLTokenizer.__iter__(self):
  37             token = self.sanitize_token(token)
  38             if token:
  39                 yield token
  40
  41 def sanitize_html(html):
  42     """Sanitizes an HTML fragment."""
  43     p = html5lib.HTMLParser(tokenizer=HTMLSanitizer,
  44                             tree=treebuilders.getTreeBuilder("dom"))
  45     dom_tree = p.parseFragment(html)
  46     walker = treewalkers.getTreeWalker("dom")
  47     stream = walker(dom_tree)
  48     s = serializer.HTMLSerializer(omit_optional_tags=False,
  49                                   quote_attr_values=True)
  50     output_generator = s.serialize(stream)
  51     return u''.join(output_generator)