17.12
This commit is contained in:
Mai Gillmann
@@ -0,0 +1,173 @@
|
||||
import re
|
||||
from urllib.parse import urlparse
|
||||
|
||||
from django.conf import settings
|
||||
from django.core.exceptions import PermissionDenied
|
||||
from django.core.mail import mail_managers
|
||||
from django.http import HttpResponsePermanentRedirect
|
||||
from django.urls import is_valid_path
|
||||
from django.utils.deprecation import MiddlewareMixin
|
||||
from django.utils.http import escape_leading_slashes
|
||||
|
||||
|
||||
class CommonMiddleware(MiddlewareMixin):
|
||||
"""
|
||||
"Common" middleware for taking care of some basic operations:
|
||||
|
||||
- Forbid access to User-Agents in settings.DISALLOWED_USER_AGENTS
|
||||
|
||||
- URL rewriting: Based on the APPEND_SLASH and PREPEND_WWW settings,
|
||||
append missing slashes and/or prepends missing "www."s.
|
||||
|
||||
- If APPEND_SLASH is set and the initial URL doesn't end with a
|
||||
slash, and it is not found in urlpatterns, form a new URL by
|
||||
appending a slash at the end. If this new URL is found in
|
||||
urlpatterns, return an HTTP redirect to this new URL; otherwise
|
||||
process the initial URL as usual.
|
||||
|
||||
This behavior can be customized by subclassing CommonMiddleware and
|
||||
overriding the response_redirect_class attribute.
|
||||
"""
|
||||
|
||||
response_redirect_class = HttpResponsePermanentRedirect
|
||||
|
||||
def process_request(self, request):
|
||||
"""
|
||||
Check for denied User-Agents and rewrite the URL based on
|
||||
settings.APPEND_SLASH and settings.PREPEND_WWW
|
||||
"""
|
||||
|
||||
# Check for denied User-Agents
|
||||
if 'HTTP_USER_AGENT' in request.META:
|
||||
for user_agent_regex in settings.DISALLOWED_USER_AGENTS:
|
||||
if user_agent_regex.search(request.META['HTTP_USER_AGENT']):
|
||||
raise PermissionDenied('Forbidden user agent')
|
||||
|
||||
# Check for a redirect based on settings.PREPEND_WWW
|
||||
host = request.get_host()
|
||||
must_prepend = settings.PREPEND_WWW and host and not host.startswith('www.')
|
||||
redirect_url = ('%s://www.%s' % (request.scheme, host)) if must_prepend else ''
|
||||
|
||||
# Check if a slash should be appended
|
||||
if self.should_redirect_with_slash(request):
|
||||
path = self.get_full_path_with_slash(request)
|
||||
else:
|
||||
path = request.get_full_path()
|
||||
|
||||
# Return a redirect if necessary
|
||||
if redirect_url or path != request.get_full_path():
|
||||
redirect_url += path
|
||||
return self.response_redirect_class(redirect_url)
|
||||
|
||||
def should_redirect_with_slash(self, request):
|
||||
"""
|
||||
Return True if settings.APPEND_SLASH is True and appending a slash to
|
||||
the request path turns an invalid path into a valid one.
|
||||
"""
|
||||
if settings.APPEND_SLASH and not request.path_info.endswith('/'):
|
||||
urlconf = getattr(request, 'urlconf', None)
|
||||
return (
|
||||
not is_valid_path(request.path_info, urlconf) and
|
||||
is_valid_path('%s/' % request.path_info, urlconf)
|
||||
)
|
||||
return False
|
||||
|
||||
def get_full_path_with_slash(self, request):
|
||||
"""
|
||||
Return the full path of the request with a trailing slash appended.
|
||||
|
||||
Raise a RuntimeError if settings.DEBUG is True and request.method is
|
||||
POST, PUT, or PATCH.
|
||||
"""
|
||||
new_path = request.get_full_path(force_append_slash=True)
|
||||
# Prevent construction of scheme relative urls.
|
||||
new_path = escape_leading_slashes(new_path)
|
||||
if settings.DEBUG and request.method in ('POST', 'PUT', 'PATCH'):
|
||||
raise RuntimeError(
|
||||
"You called this URL via %(method)s, but the URL doesn't end "
|
||||
"in a slash and you have APPEND_SLASH set. Django can't "
|
||||
"redirect to the slash URL while maintaining %(method)s data. "
|
||||
"Change your form to point to %(url)s (note the trailing "
|
||||
"slash), or set APPEND_SLASH=False in your Django settings." % {
|
||||
'method': request.method,
|
||||
'url': request.get_host() + new_path,
|
||||
}
|
||||
)
|
||||
return new_path
|
||||
|
||||
def process_response(self, request, response):
|
||||
"""
|
||||
When the status code of the response is 404, it may redirect to a path
|
||||
with an appended slash if should_redirect_with_slash() returns True.
|
||||
"""
|
||||
# If the given URL is "Not Found", then check if we should redirect to
|
||||
# a path with a slash appended.
|
||||
if response.status_code == 404:
|
||||
if self.should_redirect_with_slash(request):
|
||||
return self.response_redirect_class(self.get_full_path_with_slash(request))
|
||||
|
||||
# Add the Content-Length header to non-streaming responses if not
|
||||
# already set.
|
||||
if not response.streaming and not response.has_header('Content-Length'):
|
||||
response['Content-Length'] = str(len(response.content))
|
||||
|
||||
return response
|
||||
|
||||
|
||||
class BrokenLinkEmailsMiddleware(MiddlewareMixin):
|
||||
|
||||
def process_response(self, request, response):
|
||||
"""Send broken link emails for relevant 404 NOT FOUND responses."""
|
||||
if response.status_code == 404 and not settings.DEBUG:
|
||||
domain = request.get_host()
|
||||
path = request.get_full_path()
|
||||
referer = request.META.get('HTTP_REFERER', '')
|
||||
|
||||
if not self.is_ignorable_request(request, path, domain, referer):
|
||||
ua = request.META.get('HTTP_USER_AGENT', '<none>')
|
||||
ip = request.META.get('REMOTE_ADDR', '<none>')
|
||||
mail_managers(
|
||||
"Broken %slink on %s" % (
|
||||
('INTERNAL ' if self.is_internal_request(domain, referer) else ''),
|
||||
domain
|
||||
),
|
||||
"Referrer: %s\nRequested URL: %s\nUser agent: %s\n"
|
||||
"IP address: %s\n" % (referer, path, ua, ip),
|
||||
fail_silently=True,
|
||||
)
|
||||
return response
|
||||
|
||||
def is_internal_request(self, domain, referer):
|
||||
"""
|
||||
Return True if the referring URL is the same domain as the current
|
||||
request.
|
||||
"""
|
||||
# Different subdomains are treated as different domains.
|
||||
return bool(re.match("^https?://%s/" % re.escape(domain), referer))
|
||||
|
||||
def is_ignorable_request(self, request, uri, domain, referer):
|
||||
"""
|
||||
Return True if the given request *shouldn't* notify the site managers
|
||||
according to project settings or in situations outlined by the inline
|
||||
comments.
|
||||
"""
|
||||
# The referer is empty.
|
||||
if not referer:
|
||||
return True
|
||||
|
||||
# APPEND_SLASH is enabled and the referer is equal to the current URL
|
||||
# without a trailing slash indicating an internal redirect.
|
||||
if settings.APPEND_SLASH and uri.endswith('/') and referer == uri[:-1]:
|
||||
return True
|
||||
|
||||
# A '?' in referer is identified as a search engine source.
|
||||
if not self.is_internal_request(domain, referer) and '?' in referer:
|
||||
return True
|
||||
|
||||
# The referer is equal to the current URL, ignoring the scheme (assumed
|
||||
# to be a poorly implemented bot).
|
||||
parsed_referer = urlparse(referer)
|
||||
if parsed_referer.netloc in ['', domain] and parsed_referer.path == uri:
|
||||
return True
|
||||
|
||||
return any(pattern.search(uri) for pattern in settings.IGNORABLE_404_URLS)
|
||||
@@ -0,0 +1,52 @@
|
||||
import re
|
||||
|
||||
from django.utils.cache import patch_vary_headers
|
||||
from django.utils.deprecation import MiddlewareMixin
|
||||
from django.utils.text import compress_sequence, compress_string
|
||||
|
||||
re_accepts_gzip = re.compile(r'\bgzip\b')
|
||||
|
||||
|
||||
class GZipMiddleware(MiddlewareMixin):
|
||||
"""
|
||||
Compress content if the browser allows gzip compression.
|
||||
Set the Vary header accordingly, so that caches will base their storage
|
||||
on the Accept-Encoding header.
|
||||
"""
|
||||
def process_response(self, request, response):
|
||||
# It's not worth attempting to compress really short responses.
|
||||
if not response.streaming and len(response.content) < 200:
|
||||
return response
|
||||
|
||||
# Avoid gzipping if we've already got a content-encoding.
|
||||
if response.has_header('Content-Encoding'):
|
||||
return response
|
||||
|
||||
patch_vary_headers(response, ('Accept-Encoding',))
|
||||
|
||||
ae = request.META.get('HTTP_ACCEPT_ENCODING', '')
|
||||
if not re_accepts_gzip.search(ae):
|
||||
return response
|
||||
|
||||
if response.streaming:
|
||||
# Delete the `Content-Length` header for streaming content, because
|
||||
# we won't know the compressed size until we stream it.
|
||||
response.streaming_content = compress_sequence(response.streaming_content)
|
||||
del response['Content-Length']
|
||||
else:
|
||||
# Return the compressed content only if it's actually shorter.
|
||||
compressed_content = compress_string(response.content)
|
||||
if len(compressed_content) >= len(response.content):
|
||||
return response
|
||||
response.content = compressed_content
|
||||
response['Content-Length'] = str(len(response.content))
|
||||
|
||||
# If there is a strong ETag, make it weak to fulfill the requirements
|
||||
# of RFC 7232 section-2.1 while also allowing conditional request
|
||||
# matches on ETags.
|
||||
etag = response.get('ETag')
|
||||
if etag and etag.startswith('"'):
|
||||
response['ETag'] = 'W/' + etag
|
||||
response['Content-Encoding'] = 'gzip'
|
||||
|
||||
return response
|
||||
@@ -0,0 +1,61 @@
|
||||
from django.conf import settings
|
||||
from django.conf.urls.i18n import is_language_prefix_patterns_used
|
||||
from django.http import HttpResponseRedirect
|
||||
from django.urls import get_script_prefix, is_valid_path
|
||||
from django.utils import translation
|
||||
from django.utils.cache import patch_vary_headers
|
||||
from django.utils.deprecation import MiddlewareMixin
|
||||
|
||||
|
||||
class LocaleMiddleware(MiddlewareMixin):
|
||||
"""
|
||||
Parse a request and decide what translation object to install in the
|
||||
current thread context. This allows pages to be dynamically translated to
|
||||
the language the user desires (if the language is available, of course).
|
||||
"""
|
||||
response_redirect_class = HttpResponseRedirect
|
||||
|
||||
def process_request(self, request):
|
||||
urlconf = getattr(request, 'urlconf', settings.ROOT_URLCONF)
|
||||
i18n_patterns_used, prefixed_default_language = is_language_prefix_patterns_used(urlconf)
|
||||
language = translation.get_language_from_request(request, check_path=i18n_patterns_used)
|
||||
language_from_path = translation.get_language_from_path(request.path_info)
|
||||
if not language_from_path and i18n_patterns_used and not prefixed_default_language:
|
||||
language = settings.LANGUAGE_CODE
|
||||
translation.activate(language)
|
||||
request.LANGUAGE_CODE = translation.get_language()
|
||||
|
||||
def process_response(self, request, response):
|
||||
language = translation.get_language()
|
||||
language_from_path = translation.get_language_from_path(request.path_info)
|
||||
urlconf = getattr(request, 'urlconf', settings.ROOT_URLCONF)
|
||||
i18n_patterns_used, prefixed_default_language = is_language_prefix_patterns_used(urlconf)
|
||||
|
||||
if (response.status_code == 404 and not language_from_path and
|
||||
i18n_patterns_used and prefixed_default_language):
|
||||
# Maybe the language code is missing in the URL? Try adding the
|
||||
# language prefix and redirecting to that URL.
|
||||
language_path = '/%s%s' % (language, request.path_info)
|
||||
path_valid = is_valid_path(language_path, urlconf)
|
||||
path_needs_slash = (
|
||||
not path_valid and (
|
||||
settings.APPEND_SLASH and not language_path.endswith('/') and
|
||||
is_valid_path('%s/' % language_path, urlconf)
|
||||
)
|
||||
)
|
||||
|
||||
if path_valid or path_needs_slash:
|
||||
script_prefix = get_script_prefix()
|
||||
# Insert language after the script prefix and before the
|
||||
# rest of the URL
|
||||
language_url = request.get_full_path(force_append_slash=path_needs_slash).replace(
|
||||
script_prefix,
|
||||
'%s%s/' % (script_prefix, language),
|
||||
1
|
||||
)
|
||||
return self.response_redirect_class(language_url)
|
||||
|
||||
if not (i18n_patterns_used and language_from_path):
|
||||
patch_vary_headers(response, ('Accept-Language',))
|
||||
response.setdefault('Content-Language', language)
|
||||
return response
|
||||
Reference in New Issue
Block a user