/circuits/web/dispatchers/static.py

https://bitbucket.org/prologic/circuits/ · Python · 145 lines · 105 code · 26 blank · 14 comment · 33 complexity · 37783e36f49e8bf9b8aab1e6f5c9a565 MD5 · raw file 

    

  1. # Module:   static
    2. 

  2. # Date:     13th September 2007
    3. 

  3. # Author:   James Mills, prologic at shortcircuit dot net dot au
    4. 

  4. 

  5. """Static
    6. 

    7. 

  7. This modStatic implements a Static dispatcher used to serve up static
    8. 

  8. resources and an optional apache-style directory listing.
    9. 

  9. """
    10. 

    11. 

  11. import os
    12. 

  12. from string import Template
    13. 

  13. 

  14. try:
    15. 

  15.     from urllib import quote, unquote
    16. 

  16. except ImportError:
    17. 

  17.     from urllib.parse import quote, unquote  # NOQA
    18. 

  18. 

  19. from circuits import handler, BaseComponent
    20. 

  20. 

  21. from circuits.web.tools import serve_file
    22. 

  22. 

  23. DEFAULT_DIRECTORY_INDEX_TEMPLATE = """
    24. 

  24. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    25. 

  25.  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    26. 

  26. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    27. 

  27.     <head>
    28. 

  28.         <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
    29. 

  29.         <meta http-equiv="Content-Language" content="en-us" />
    30. 

  30.         <meta name="robots" content="NONE,NOARCHIVE" />
    31. 

  31.         <title>Index of $directory</title>
    32. 

  32.     </head>
    33. 

  33.     <body>
    34. 

  34.         <h1>Index of $directory</h1>
    35. 

  35.         <ul>
    36. 

  36.             $url_up
    37. 

  37.             $listing
    38. 

  38.         </ul>
    39. 

  39.     </body>
    40. 

  40. </html>
    41. 

  41. """
    42. 

    43. 

  43. _dirlisting_template = Template(DEFAULT_DIRECTORY_INDEX_TEMPLATE)
    44. 

  44. 

  45. 

  46. class Static(BaseComponent):
    47. 

  47. 

  48.     channel = "web"
    49. 

  49. 

  50.     def __init__(self, path=None, docroot=None,
    51. 

  51.                  defaults=("index.html", "index.xhtml",), dirlisting=False):
    52. 

  52.         super(Static, self).__init__()
    53. 

  53. 

  54.         self.path = path
    55. 

  55.         self.docroot = os.path.abspath(docroot) if docroot is not None else os.path.abspath(os.getcwd())
    56. 

  56.         self.defaults = defaults
    57. 

  57.         self.dirlisting = dirlisting
    58. 

  58. 

  59.     @handler("request", priority=0.9)
    60. 

  60.     def _on_request(self, event, request, response):
    61. 

  61.         if self.path is not None and not request.path.startswith(self.path):
    62. 

  62.             return
    63. 

  63. 

  64.         path = request.path
    65. 

  65. 

  66.         if self.path is not None:
    67. 

  67.             path = path[len(self.path):]
    68. 

  68. 

  69.         path = unquote(path.strip("/"))
    70. 

  70. 

  71.         if path:
    72. 

  72.             location = os.path.abspath(os.path.join(self.docroot, path))
    73. 

  73.         else:
    74. 

  74.             location = os.path.abspath(os.path.join(self.docroot, "."))
    75. 

  75. 

  76.         if not os.path.exists(location):
    77. 

  77.             return
    78. 

  78. 

  79.         if not location.startswith(os.path.dirname(self.docroot)):
    80. 

  80.             return  # hacking attemp e.g. /foo/../../../../../etc/shadow
    81. 

  81. 

  82.         # Is it a file we can serve directly?
    83. 

  83.         if os.path.isfile(location):
    84. 

  84.             # Don't set cookies for static content
    85. 

  85.             response.cookie.clear()
    86. 

  86.             try:
    87. 

  87.                 return serve_file(request, response, location)
    88. 

  88.             finally:
    89. 

  89.                 event.stop()
    90. 

  90. 

  91.         # Is it a directory?
    92. 

  92.         elif os.path.isdir(location):
    93. 

  93. 

  94.             # Try to serve one of default files first..
    95. 

  95.             for default in self.defaults:
    96. 

  96.                 location = os.path.abspath(
    97. 

  97.                     os.path.join(self.docroot, path, default)
    98. 

  98.                 )
    99. 

  99.                 if os.path.exists(location):
    100. 

  100.                     # Don't set cookies for static content
    101. 

  101.                     response.cookie.clear()
    102. 

  102.                     try:
    103. 

  103.                         return serve_file(request, response, location)
    104. 

  104.                     finally:
    105. 

  105.                         event.stop()
    106. 

  106. 

  107.             # .. serve a directory listing if allowed to.
    108. 

  108.             if self.dirlisting:
    109. 

  109.                 directory = os.path.abspath(os.path.join(self.docroot, path))
    110. 

  110.                 cur_dir = os.path.join(self.path, path) if self.path else ""
    111. 

  111. 

  112.                 if not path:
    113. 

  113.                     url_up = ""
    114. 

  114.                 else:
    115. 

  115.                     if self.path is None:
    116. 

  116.                         url_up = os.path.join("/", os.path.split(path)[0])
    117. 

  117.                     else:
    118. 

  118.                         url_up = os.path.join(cur_dir, "..")
    119. 

  119.                     url_up = '<li><a href="%s">%s</a></li>' % (url_up, "..")
    120. 

  120. 

  121.                 listing = []
    122. 

  122.                 for item in os.listdir(directory):
    123. 

  123.                     if not item.startswith("."):
    124. 

  124.                         url = os.path.join("/", path, cur_dir, item)
    125. 

  125.                         location = os.path.abspath(
    126. 

  126.                             os.path.join(self.docroot, path, item)
    127. 

  127.                         )
    128. 

  128.                         if os.path.isdir(location):
    129. 

  129.                             li = '<li><a href="%s/">%s/</a></li>' % (
    130. 

  130.                                 quote(url), item
    131. 

  131.                             )
    132. 

  132.                         else:
    133. 

  133.                             li = '<li><a href="%s">%s</a></li>' % (
    134. 

  134.                                 quote(url), item
    135. 

  135.                             )
    136. 

  136.                         listing.append(li)
    137. 

  137. 

  138.                 ctx = {}
    139. 

  139.                 ctx["directory"] = cur_dir or os.path.join("/", cur_dir, path)
    140. 

  140.                 ctx["url_up"] = url_up
    141. 

  141.                 ctx["listing"] = "\n".join(listing)
    142. 

  142.                 try:
    143. 

  143.                     return _dirlisting_template.safe_substitute(ctx)
    144. 

  144.                 finally:
    145. 

  145.                     event.stop()
    146.