fortune_html_parser.py 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117
  1. # -*- coding: utf-8
  2. from HTMLParser import HTMLParser
  3. from difflib import unified_diff
  4. class FortuneHTMLParser(HTMLParser):
  5. body = []
  6. valid = '<!doctype html><html><head><title>Fortunes</title></head><body><table><tr><th>id</th><th>message</th></tr><tr><td>11</td><td>&lt;script&gt;alert(&quot;This should not be displayed in a browser alert box.&quot;);&lt;/script&gt;</td></tr><tr><td>4</td><td>A bad random number generator: 1, 1, 1, 1, 1, 4.33e+67, 1, 1, 1</td></tr><tr><td>5</td><td>A computer program does what you tell it to do, not what you want it to do.</td></tr><tr><td>2</td><td>A computer scientist is someone who fixes things that aren&apos;t broken.</td></tr><tr><td>8</td><td>A list is only as strong as its weakest link. — Donald Knuth</td></tr><tr><td>0</td><td>Additional fortune added at request time.</td></tr><tr><td>3</td><td>After enough decimal places, nobody gives a damn.</td></tr><tr><td>7</td><td>Any program that runs right is obsolete.</td></tr><tr><td>10</td><td>Computers make very fast, very accurate mistakes.</td></tr><tr><td>6</td><td>Emacs is a nice operating system, but I prefer UNIX. — Tom Christaensen</td></tr><tr><td>9</td><td>Feature: A bug with seniority.</td></tr><tr><td>1</td><td>fortune: No such file or directory</td></tr><tr><td>12</td><td>フレームワークのベンチマーク</td></tr></table></body></html>'
  7. # Is called when a doctype or other such tag is read in.
  8. # For our purposes, we assume this is only going to be
  9. # "DOCTYPE html", so we will surround it with "<!" and ">".
  10. def handle_decl(self, decl):
  11. # The spec says that for HTML this is case insensitive,
  12. # and since we did not specify xml compliance (where
  13. # incorrect casing would throw a syntax error), we must
  14. # allow all casings. We will lower for our normalization.
  15. self.body.append("<!{d}>".format(d=decl.lower()))
  16. # This is called when an HTML character is parsed (i.e.
  17. # &quot;). There are a number of issues to be resolved
  18. # here. For instance, some tests choose to leave the
  19. # "+" character as-is, which should be fine as far as
  20. # character escaping goes, but others choose to use the
  21. # character reference of "&#43;", which is also fine.
  22. # Therefore, this method looks for all possible character
  23. # references and normalizes them so that we can
  24. # validate the input against a single valid spec string.
  25. # Another example problem: "&quot;" is valid, but so is
  26. # "&#34;"
  27. def handle_charref(self, name):
  28. # "&#34;" is a valid escaping, but we are normalizing
  29. # it so that our final parse can just be checked for
  30. # equality.
  31. if name == "34" or name == "034" or name == "x22":
  32. # Append our normalized entity reference to our body.
  33. self.body.append("&quot;")
  34. # "&#39;" is a valid escaping of "-", but it is not
  35. # required, so we normalize for equality checking.
  36. if name == "39" or name == "039" or name == "x27":
  37. self.body.append("&apos;")
  38. # Again, "&#43;" is a valid escaping of the "+", but
  39. # it is not required, so we need to normalize for out
  40. # final parse and equality check.
  41. if name == "43" or name == "043" or name == "x2B":
  42. self.body.append("+")
  43. # Again, "&#62;" is a valid escaping of ">", but we
  44. # need to normalize to "&gt;" for equality checking.
  45. if name == "62" or name == "062" or name == "x3E":
  46. self.body.append("&gt;")
  47. # Again, "&#60;" is a valid escaping of "<", but we
  48. # need to normalize to "&lt;" for equality checking.
  49. if name == "60" or name == "060" or name == "x3C":
  50. self.body.append("&lt;")
  51. # Not sure why some are escaping '/'
  52. if name == "47" or name == "047" or name == "x2F":
  53. self.body.append("/")
  54. def handle_entityref(self, name):
  55. # Again, "&mdash;" is a valid escaping of "—", but we
  56. # need to normalize to "—" for equality checking.
  57. if name == "mdash":
  58. self.body.append("—")
  59. else:
  60. self.body.append("&{n};".format(n=name))
  61. # This is called every time a tag is opened. We append
  62. # each one wrapped in "<" and ">".
  63. def handle_starttag(self, tag, attrs):
  64. self.body.append("<{t}>".format(t=tag))
  65. # This is called whenever data is presented inside of a
  66. # start and end tag. Generally, this will only ever be
  67. # the contents inside of "<td>" and "</td>", but there
  68. # are also the "<title>" and "</title>" tags.
  69. def handle_data (self, data):
  70. if data.strip() != '':
  71. # After a LOT of debate, these are now considered
  72. # valid in data. The reason for this approach is
  73. # because a few tests use tools which determine
  74. # at compile time whether or not a string needs
  75. # a given type of html escaping, and our fortune
  76. # test has apostrophes and quotes in html data
  77. # rather than as an html attribute etc.
  78. # example:
  79. # <td>A computer scientist is someone who fixes things that aren't broken.</td>
  80. # Semanticly, that apostrophe does not NEED to
  81. # be escaped. The same is currently true for our
  82. # quotes.
  83. # In fact, in data (read: between two html tags)
  84. # even the '>' need not be replaced as long as
  85. # the '<' are all escaped.
  86. # We replace them with their escapings here in
  87. # order to have a noramlized string for equality
  88. # comparison at the end.
  89. data = data.replace('\'', '&apos;')
  90. data = data.replace('"', '&quot;')
  91. data = data.replace('>', '&gt;')
  92. self.body.append("{d}".format(d=data))
  93. # This is called every time a tag is closed. We append
  94. # each one wrapped in "</" and ">".
  95. def handle_endtag(self, tag):
  96. self.body.append("</{t}>".format(t=tag))
  97. # Returns whether the HTML input parsed by this parser
  98. # is valid against our known "fortune" spec.
  99. # The parsed data in 'body' is joined on empty strings
  100. # and checked for equality against our spec.
  101. def isValidFortune(self, out):
  102. body = ''.join(self.body)
  103. diff = self.valid == body
  104. if not diff:
  105. out.write("Fortune invalid. Diff following:\n")
  106. out.write(''.join(unified_diff(self.valid, body, fromfile="Valid", tofile="Output")) + '\n')
  107. return diff