1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
|
"""
The bundled WSGI apps.
* Routing: Uses URL prefixes to route to applications
* StaticFiles: Serves a directory
* StaticResources: Serves the resources from a python package
"""
import email.utils # For datetime formatting
import functools
from http import HTTPStatus
import logging
import mimetypes
import os
import posixpath
import traceback
import wsgiref.simple_server
import wsgiref.util
try:
# Python 3.7+
import importlib.resources as importlib_resources
except ImportError as e :
# Python 3.6
import importlib_resources
from .util import abspath
__all__ = ('StaticFiles', 'StaticResources', 'Routing')
logger = logging.getLogger(__name__)
CHUNK_SIZE = 4 * 1024 # 4k
# Follow Django in treating URLs as UTF-8 encoded (which requires undoing the
# implicit ISO-8859-1 decoding applied in Python 3). Strictly speaking, URLs
# should only be ASCII anyway, but UTF-8 can be found in the wild.
def decode_path_info(path_info):
return path_info.encode("iso-8859-1", "replace").decode("utf-8", "replace")
def send_simple_text(environ, start_response, status, body):
"""
Send a simple message as plain text
"""
if isinstance(status, int):
status = "{} {}".format(int(status), status.phrase)
if isinstance(body, str):
body = body.encode('utf-8')
response_headers = [
('Content-Type', 'text/plain'),
('Content-Length', str(len(body)))
]
start_response(status, response_headers)
return [body]
def do_403(environ, start_response):
"""
Generic app to produce a 403
"""
urlpath = environ['SCRIPT_NAME'] + environ['PATH_INFO']
return send_simple_text(
environ, start_response, HTTPStatus.FORBIDDEN, "Path {} is not allowed.".format(urlpath),
)
def do_404(environ, start_response):
"""
Generic app to produce a 404
"""
urlpath = environ['SCRIPT_NAME'] + environ['PATH_INFO']
return send_simple_text(
environ, start_response, HTTPStatus.NOT_FOUND, "Path {} was not found".format(urlpath),
)
def do_405(environ, start_response):
"""
Generic app to produce a 405
"""
urlpath = environ['SCRIPT_NAME'] + environ['PATH_INFO']
return send_simple_text(
environ, start_response, HTTPStatus.METHOD_NOT_ALLOWED,
"Method {} is not allowed on {}".format(
environ['REQUEST_METHOD'], urlpath,
),
)
def do_options(environ, start_response):
"""
Generic app to produce a response to OPTIONS
"""
start_response("204 No Content", [
('Allow', 'OPTIONS, GET, HEAD'),
])
return []
def wsgi_catch_errors(func):
@functools.wraps(func)
def handler(*p):
try:
return func(*p)
except BaseException:
start_response = p[-1]
start_response("500 Server Error", [
('Content-Type', 'text/plain'),
])
return [traceback.format_exc().encode('utf-8')]
return handler
class Routing(dict):
"""
Implements a basic URL routing system.
Path prefixes are compared to the request path. The longest prefix wins.
Example:
Routing({
'/': app,
'/static': Static('mystatic'),
})
"""
def no_route_found(self, environ, start_response):
"""
Handle if there was no matching route
"""
return do_404(environ, start_response)
@wsgi_catch_errors
def __call__(self, environ, start_response):
# SCRIPT_NAME + PATH_INFO = full url
urlpath = environ['SCRIPT_NAME'] + environ['PATH_INFO']
if not urlpath:
urlpath = '/'
potentials = [
prefix
for prefix in self.keys()
if posixpath.commonpath([prefix, urlpath]) == prefix
]
try:
match = max(potentials, key=len)
except ValueError:
# max() got an empty list, aka no matches found
return self.no_route_found(environ, start_response)
logger.debug("For %r found %r routes, selected %r", urlpath, potentials, match)
app = self[match]
environ['SCRIPT_NAME'] = urlpath[:len(match)]
environ['PATH_INFO'] = urlpath[len(match):]
return app(environ, start_response)
class StaticContentsApp:
"""
Base class for static serving implementatins
"""
max_age = 60 # 1min, takes the edge off any frequent responses while staying fresh
def method_not_allowed(self, environ, start_response):
"""
Handle if we got something besides GET or HEAD
"""
return do_405(environ, start_response)
def file_not_found(self, environ, start_response):
"""
Handle if the file cannot be found
"""
return do_404(environ, start_response)
def is_a_directory(self, environ, start_response):
"""
Handle if we were given a directory
"""
return do_404(environ, start_response)
def no_permissions(self, environ, start_response):
"""
Handle if we can't open the file
"""
return do_403(environ, start_response)
def open(path):
"""
Return a file-like object in 'rb' mode.
The path given is normalized.
Add a .name attribute to the file if applicable
Raise a FileNotFoundError, IsADirectoryError, or a PermissionError in
case of error.
"""
raise NotImplementedError
@wsgi_catch_errors
def __call__(self, environ, start_response):
if environ['REQUEST_METHOD'] == 'OPTIONS':
return do_options(environ, start_response)
elif environ['REQUEST_METHOD'] not in ('GET', 'HEAD'):
return self.method_not_allowed(environ, start_response)
path = posixpath.normpath(environ['PATH_INFO'] or '/')
path_options = [path]
if path.endswith('/'):
path_options.append(path[:-1])
path_options.append(posixpath.join(path, 'index.html'))
responder = None
for option in path_options:
try:
file = self.open(option)
except FileNotFoundError:
logger.debug("file not found: %s", option)
if responder is None:
responder = self.file_not_found
except (IsADirectoryError, OSError): # OSError on Windows
logger.debug("is a directory: %s", option)
if responder is None:
responder = self.is_a_directory
except PermissionError:
logger.debug("permission error: %s", option)
if responder is None:
responder = self.no_permissions
except NotADirectoryError:
logger.debug("not a directory: %s", option)
# This can happen if we get a file with a trailing slash
# This should only happen with the first option, and should be
# covered by the next option
pass
else:
break
else:
assert responder
return responder(environ, start_response)
if hasattr(file, 'name'):
filename = file.name
else:
filename = path
mime, _ = mimetypes.guess_type(filename, strict=False)
# NOTE: We're not doing cache control checking, because we don't
# consistently have stat() available.
# TODO: Type negotiation
if 'HTTP_RANGE' in environ:
return self._serve_partial_file(environ, start_response, file, filename, mime)
else:
return self._serve_whole_file(environ, start_response, file, filename, mime)
def _default_headers(self, mime, file):
rv = wsgiref.headers.Headers([
('Content-Type', mime or 'application/octect-stream'),
('Accept-Ranges', 'bytes'),
('Cache-Control', 'max-age={}'.format(self.max_age))
])
if hasattr(file, 'fileno'):
try:
stat = os.fstat(file.fileno())
except OSError:
pass
else:
rv['Content-Length'] = str(stat.st_size)
# rv['Last-Modified'] = email.utils.formatdate(stat.st_mtime, usegmt=True)
return rv
def _serve_whole_file(self, environ, start_response, file, filename, mime):
response_headers = self._default_headers(mime, file)
start_response('200 OK', response_headers._headers)
if environ['REQUEST_METHOD'] == 'HEAD':
file.close()
return []
else:
wrapper = environ.get('wsgi.file_wrapper', wsgiref.util.FileWrapper)
return wrapper(file, CHUNK_SIZE)
def _parse_range(self, header, length):
logger.debug("Got range header %r (length=%s)", header, length)
unit, _, ranges = header.partition('=')
if unit != 'bytes':
raise ValueError("Range not satisfiable: {}".format(header))
ranges = [bit.strip().split('-') for bit in ranges.split(',')]
start, end = ranges[0]
start = int(start) if start else 0
end = int(end) if end else None
if length is not None:
if end is None:
end = length - 1
return start, end
def _compose_content_range(self, start, end, total):
rv = 'bytes '
if start is not None:
rv += str(start)
rv += '-'
if end is not None:
rv += str(end)
rv += '/'
if total is not None:
rv += str(total)
else:
rv += '*'
return rv
def _serve_partial_file(self, environ, start_response, file, filename, mime):
response_headers = self._default_headers(mime, file)
length = response_headers['Content-Length']
if length:
length = int(length)
else:
length = None
start, end = self._parse_range(environ['HTTP_RANGE'], length)
if length is not None:
# Check ranges
maxindex = length - 1
if start > maxindex or end > maxindex:
start_response('416 Range Not Satisfiable', [
('Content-Range', 'bytes */{}'.format(length))
])
return []
assert start <= end
assert length is None or end < length
logger.debug("Serving %s (%s to %s of %s)", filename, start, end, length)
response_headers['Content-Range'] = self._compose_content_range(start, end, length)
if end is None:
amount = None
del response_headers['Content-Length']
else:
amount = end - start + 1
response_headers['Content-Length'] = str(amount)
start_response('206 Partial Content', response_headers._headers)
if environ['REQUEST_METHOD'] == 'HEAD':
file.close()
return []
else:
return self._partial_file_wrapper(file, start, amount)
def _partial_file_wrapper(self, file, skip, amount):
served = 0
if skip:
file.seek(skip)
while (amount is None) or (served <= amount):
data = file.read(min(CHUNK_SIZE, amount - served))
if not data:
break
served += len(data)
yield data
logging.debug("Served %s of %s", served, amount)
class StaticFiles(StaticContentsApp):
"""
Serves static files from a directory on the file system.
"""
def __init__(self, root):
self.root = abspath(root)
def open(self, file):
if file:
path = os.path.join(self.root, file.lstrip('/'))
else:
path = self.root
logger.debug('Resolved %s to %s' % (file, path))
return open(path, 'rb')
class StaticResources(StaticContentsApp):
"""
Serves static files from resources in python packages
"""
def __init__(self, root):
self.root = root
def open(self, file):
slashed, basename = posixpath.split(file)
slashed = slashed.rstrip('/')
if slashed:
packagename = "{}.{}".format(self.root, slashed.replace('/', '.'))
else:
packagename = self.root
try:
return importlib_resources.open_binary(packagename, basename)
except ModuleNotFoundError:
raise FileNotFoundError
|