/raptorizemw/middleware.py

https://github.com/ralphbean/raptorizemw · Python · 151 lines · 89 code · 30 blank · 32 comment · 15 complexity · a0472412d1f3e8961c2d9ad77500f6e7 MD5 · raw file 

    

  1. import BeautifulSoup
    2. 

  2. import datetime
    3. 

  3. import random
    4. 

  4. import webob
    5. 

  5. 

  6. import raptorizemw.resources
    7. 

  7. 

  8. 

  9. truthy = frozenset(('t', 'true', 'y', 'yes', 'on', '1'))
    10. 

  10. 

  11. def asbool(s):
    12. 

  12.     """ Return the boolean value ``True`` if the case-lowered value of string
    13. 

  13.     input ``s`` is any of ``t``, ``true``, ``y``, ``on``, or ``1``, otherwise
    14. 

  14.     return the boolean value ``False``.  If ``s`` is the value ``None``,
    15. 

  15.     return ``False``.  If ``s`` is already one of the boolean values ``True``
    16. 

  16.     or ``False``, return it."""
    17. 

  17.     if s is None:
    18. 

  18.         return False
    19. 

  19.     if isinstance(s, bool):
    20. 

  20.         return s
    21. 

  21.     s = str(s).strip()
    22. 

  22.     return s.lower() in truthy
    23. 

  23. 

  24. 

  25. class RaptorizeMiddleware(object):
    26. 

  26.     """ WSGI middleware that throws a raptor on your page. """
    27. 

  27. 

  28.     def __init__(self, app, serve_resources=True, random_chance=1.0,
    29. 

  29.                  only_on_april_1st=False, enterOn='timer', delayTime=2000,
    30. 

  30.                  **kw):
    31. 

  31.         """ Configuration arguments are documented in README.rst
    32. 

    33. 

  33.         Also at http://pypi.python.org/pypi/raptorizemw
    34. 

  34.         """
    35. 

    36. 

  36.         if not enterOn in ['timer', 'konami-code']:
    37. 

  37.             raise ValueError("enterOn must be either 'timer' or 'konami-code'")
    38. 

  38. 

  39.         self.resources_app = raptorizemw.resources.ResourcesApp()
    40. 

  40. 

  41.         self.app = app
    42. 

  42.         self.serve_resources = serve_resources
    43. 

  43.         self.random_chance = float(random_chance)
    44. 

  44.         self.only_on_april_1st = asbool(only_on_april_1st)
    45. 

  45.         self.enterOn = enterOn
    46. 

  46.         self.delayTime = int(delayTime)
    47. 

  47. 

  48.     def __call__(self, environ, start_response):
    49. 

  49.         """ Process a request.
    50. 

    51. 

  51.         Do one of two things::
    52. 

  52. 

  53.             - If this request is for a raptor resource (image, sound, js
    54. 

  54.               code).  Ignore the next WSGI layer in the call chain and just
    55. 

  55.               serve the resource myself.
    56. 

  56.             - Call the next layer in the WSGI call chain and retrieve its
    57. 

  57.               output.  Determine if I should actually raptorize this request
    58. 

  58.               and if so, insert our magic javascript in the <head> tag.
    59. 

  59.         """
    60. 

  60.         __app__ = None
    61. 

  61.         if self.serve_resources and 'raptorizemw' in environ['PATH_INFO']:
    62. 

  62.             __app__ = self.resources_app
    63. 

  63.         else:
    64. 

  64.             __app__ = self.app
    65. 

  65. 

  66.         req = webob.Request(environ)
    67. 

  67.         resp = req.get_response(__app__, catch_exc_info=True)
    68. 

  68. 

  69.         if self.should_raptorize(req, resp):
    70. 

  70.             resp = self.raptorize(resp)
    71. 

  71. 

  72.         return resp(environ, start_response)
    73. 

  73. 

  74.     def should_raptorize(self, req, resp):
    75. 

  75.         """ Determine if this request should be raptorized.  Boolean. """
    76. 

  76. 

  77.         if resp.status != "200 OK":
    78. 

  78.             return False
    79. 

  79. 

  80.         content_type = resp.headers.get('Content-Type', 'text/plain').lower()
    81. 

  81.         if not 'html' in content_type:
    82. 

  82.             return False
    83. 

  83. 

  84.         if random.random() > self.random_chance:
    85. 

  85.             return False
    86. 

  86. 

  87.         if self.only_on_april_1st:
    88. 

  88.             now = datetime.datetime.now()
    89. 

  89.             if now.month != 20 and now.day != 1:
    90. 

  90.                 return False
    91. 

  91. 

  92.         return True
    93. 

  93. 

  94.     def raptorize(self, resp):
    95. 

  95.         """ Raptorize this response!
    96. 

    97. 

  97.         Insert javascript into the <head> tag.
    98. 

  98. 

  99.         If jquery is already included, make sure not to stomp on it by
    100. 

  100.         re-including it.
    101. 

  101.         """
    102. 

    103. 

  103.         soup = BeautifulSoup.BeautifulSoup(resp.body)
    104. 

  104. 

  105.         if not soup.html:
    106. 

  106.             return resp
    107. 

  107. 

  108.         if not soup.html.head:
    109. 

  109.             soup.html.insert(0, BeautifulSoup.Tag(soup, "head"))
    110. 

  110. 

  111.         prefix = self.resources_app.prefix
    112. 

  112.         js_helper = BeautifulSoup.Tag(
    113. 

  113.             soup, "script", attrs=[
    114. 

  114.                 ('type', 'text/javascript'),
    115. 

  115.                 ('src', prefix + '/js_helper.js'),
    116. 

  116.             ])
    117. 

  117.         soup.html.head.insert(len(soup.html.head), js_helper)
    118. 

  118. 

  119.         payload_js = BeautifulSoup.Tag(
    120. 

  120.             soup, "script", attrs=[
    121. 

  121.                 ('type', 'text/javascript'),
    122. 

  122.             ])
    123. 

  123.         payload_js.setString(
    124. 

  124.             """
    125. 

  125.             run_with_jquery(function() {
    126. 

  126.                 include_js("%s", function() {
    127. 

  127.                     $(window).load(function() {
    128. 

  128.                         $('body').raptorize({
    129. 

  129.                             enterOn: "%s",
    130. 

  130.                             delayTime: %i,
    131. 

  131.                         });
    132. 

  132.                     });
    133. 

  133.                 })
    134. 

  134.             });
    135. 

  135.             """ % (
    136. 

  136.                 prefix + '/jquery.raptorize.1.0.js',
    137. 

  137.                 self.enterOn,
    138. 

  138.                 self.delayTime
    139. 

  139.             )
    140. 

  140.         )
    141. 

  141.         soup.html.head.insert(len(soup.html.head), payload_js)
    142. 

  142. 

  143.         resp.body = str(soup.prettify())
    144. 

  144.         return resp
    145. 

  145. 

  146. 

  147. def make_middleware(app=None, *args, **kw):
    148. 

  148.     """ Given an app, return that app wrapped in RaptorizeMiddleware """
    149. 

  149.     app = RaptorizeMiddleware(app, *args, **kw)
    150. 

  150.     return app
    151.