base.py 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253
  1. from __future__ import unicode_literals
  2. import logging
  3. import sys
  4. import types
  5. from django import http
  6. from django.conf import settings
  7. from django.core import urlresolvers
  8. from django.core import signals
  9. from django.core.exceptions import MiddlewareNotUsed, PermissionDenied, SuspiciousOperation
  10. from django.db import connections, transaction
  11. from django.utils.encoding import force_text
  12. from django.utils.module_loading import import_string
  13. from django.utils import six
  14. from django.views import debug
  15. logger = logging.getLogger('django.request')
  16. class BaseHandler(object):
  17. # Changes that are always applied to a response (in this order).
  18. response_fixes = [
  19. http.fix_location_header,
  20. http.conditional_content_removal,
  21. ]
  22. def __init__(self):
  23. self._request_middleware = self._view_middleware = self._template_response_middleware = self._response_middleware = self._exception_middleware = None
  24. def load_middleware(self):
  25. """
  26. Populate middleware lists from settings.MIDDLEWARE_CLASSES.
  27. Must be called after the environment is fixed (see __call__ in subclasses).
  28. """
  29. self._view_middleware = []
  30. self._template_response_middleware = []
  31. self._response_middleware = []
  32. self._exception_middleware = []
  33. request_middleware = []
  34. for middleware_path in settings.MIDDLEWARE_CLASSES:
  35. mw_class = import_string(middleware_path)
  36. try:
  37. mw_instance = mw_class()
  38. except MiddlewareNotUsed:
  39. continue
  40. if hasattr(mw_instance, 'process_request'):
  41. request_middleware.append(mw_instance.process_request)
  42. if hasattr(mw_instance, 'process_view'):
  43. self._view_middleware.append(mw_instance.process_view)
  44. if hasattr(mw_instance, 'process_template_response'):
  45. self._template_response_middleware.insert(0, mw_instance.process_template_response)
  46. if hasattr(mw_instance, 'process_response'):
  47. self._response_middleware.insert(0, mw_instance.process_response)
  48. if hasattr(mw_instance, 'process_exception'):
  49. self._exception_middleware.insert(0, mw_instance.process_exception)
  50. # We only assign to this when initialization is complete as it is used
  51. # as a flag for initialization being complete.
  52. self._request_middleware = request_middleware
  53. def make_view_atomic(self, view):
  54. non_atomic_requests = getattr(view, '_non_atomic_requests', set())
  55. for db in connections.all():
  56. if (db.settings_dict['ATOMIC_REQUESTS']
  57. and db.alias not in non_atomic_requests):
  58. view = transaction.atomic(using=db.alias)(view)
  59. return view
  60. def get_response(self, request):
  61. "Returns an HttpResponse object for the given HttpRequest"
  62. # Setup default url resolver for this thread, this code is outside
  63. # the try/except so we don't get a spurious "unbound local
  64. # variable" exception in the event an exception is raised before
  65. # resolver is set
  66. urlconf = settings.ROOT_URLCONF
  67. urlresolvers.set_urlconf(urlconf)
  68. resolver = urlresolvers.RegexURLResolver(r'^/', urlconf)
  69. try:
  70. response = None
  71. # Apply request middleware
  72. for middleware_method in self._request_middleware:
  73. response = middleware_method(request)
  74. if response:
  75. break
  76. if response is None:
  77. if hasattr(request, 'urlconf'):
  78. # Reset url resolver with a custom urlconf.
  79. urlconf = request.urlconf
  80. urlresolvers.set_urlconf(urlconf)
  81. resolver = urlresolvers.RegexURLResolver(r'^/', urlconf)
  82. resolver_match = resolver.resolve(request.path_info)
  83. callback, callback_args, callback_kwargs = resolver_match
  84. request.resolver_match = resolver_match
  85. # Apply view middleware
  86. for middleware_method in self._view_middleware:
  87. response = middleware_method(request, callback, callback_args, callback_kwargs)
  88. if response:
  89. break
  90. if response is None:
  91. wrapped_callback = self.make_view_atomic(callback)
  92. try:
  93. response = wrapped_callback(request, *callback_args, **callback_kwargs)
  94. except Exception as e:
  95. # If the view raised an exception, run it through exception
  96. # middleware, and if the exception middleware returns a
  97. # response, use that. Otherwise, reraise the exception.
  98. for middleware_method in self._exception_middleware:
  99. response = middleware_method(request, e)
  100. if response:
  101. break
  102. if response is None:
  103. raise
  104. # Complain if the view returned None (a common error).
  105. if response is None:
  106. if isinstance(callback, types.FunctionType): # FBV
  107. view_name = callback.__name__
  108. else: # CBV
  109. view_name = callback.__class__.__name__ + '.__call__'
  110. raise ValueError("The view %s.%s didn't return an HttpResponse object. It returned None instead."
  111. % (callback.__module__, view_name))
  112. # If the response supports deferred rendering, apply template
  113. # response middleware and then render the response
  114. if hasattr(response, 'render') and callable(response.render):
  115. for middleware_method in self._template_response_middleware:
  116. response = middleware_method(request, response)
  117. response = response.render()
  118. except http.Http404 as e:
  119. logger.warning('Not Found: %s', request.path,
  120. extra={
  121. 'status_code': 404,
  122. 'request': request
  123. })
  124. if settings.DEBUG:
  125. response = debug.technical_404_response(request, e)
  126. else:
  127. try:
  128. callback, param_dict = resolver.resolve404()
  129. response = callback(request, **param_dict)
  130. except:
  131. signals.got_request_exception.send(sender=self.__class__, request=request)
  132. response = self.handle_uncaught_exception(request, resolver, sys.exc_info())
  133. except PermissionDenied:
  134. logger.warning(
  135. 'Forbidden (Permission denied): %s', request.path,
  136. extra={
  137. 'status_code': 403,
  138. 'request': request
  139. })
  140. try:
  141. callback, param_dict = resolver.resolve403()
  142. response = callback(request, **param_dict)
  143. except:
  144. signals.got_request_exception.send(
  145. sender=self.__class__, request=request)
  146. response = self.handle_uncaught_exception(request,
  147. resolver, sys.exc_info())
  148. except SuspiciousOperation as e:
  149. # The request logger receives events for any problematic request
  150. # The security logger receives events for all SuspiciousOperations
  151. security_logger = logging.getLogger('django.security.%s' %
  152. e.__class__.__name__)
  153. security_logger.error(
  154. force_text(e),
  155. extra={
  156. 'status_code': 400,
  157. 'request': request
  158. })
  159. try:
  160. callback, param_dict = resolver.resolve400()
  161. response = callback(request, **param_dict)
  162. except:
  163. signals.got_request_exception.send(
  164. sender=self.__class__, request=request)
  165. response = self.handle_uncaught_exception(request,
  166. resolver, sys.exc_info())
  167. except SystemExit:
  168. # Allow sys.exit() to actually exit. See tickets #1023 and #4701
  169. raise
  170. except: # Handle everything else.
  171. # Get the exception info now, in case another exception is thrown later.
  172. signals.got_request_exception.send(sender=self.__class__, request=request)
  173. response = self.handle_uncaught_exception(request, resolver, sys.exc_info())
  174. try:
  175. # Apply response middleware, regardless of the response
  176. for middleware_method in self._response_middleware:
  177. response = middleware_method(request, response)
  178. response = self.apply_response_fixes(request, response)
  179. except: # Any exception should be gathered and handled
  180. signals.got_request_exception.send(sender=self.__class__, request=request)
  181. response = self.handle_uncaught_exception(request, resolver, sys.exc_info())
  182. response._closable_objects.append(request)
  183. return response
  184. def handle_uncaught_exception(self, request, resolver, exc_info):
  185. """
  186. Processing for any otherwise uncaught exceptions (those that will
  187. generate HTTP 500 responses). Can be overridden by subclasses who want
  188. customised 500 handling.
  189. Be *very* careful when overriding this because the error could be
  190. caused by anything, so assuming something like the database is always
  191. available would be an error.
  192. """
  193. if settings.DEBUG_PROPAGATE_EXCEPTIONS:
  194. raise
  195. logger.error('Internal Server Error: %s', request.path,
  196. exc_info=exc_info,
  197. extra={
  198. 'status_code': 500,
  199. 'request': request
  200. }
  201. )
  202. if settings.DEBUG:
  203. return debug.technical_500_response(request, *exc_info)
  204. # If Http500 handler is not installed, re-raise last exception
  205. if resolver.urlconf_module is None:
  206. six.reraise(*exc_info)
  207. # Return an HttpResponse that displays a friendly error message.
  208. callback, param_dict = resolver.resolve500()
  209. return callback(request, **param_dict)
  210. def apply_response_fixes(self, request, response):
  211. """
  212. Applies each of the functions in self.response_fixes to the request and
  213. response, modifying the response in the process. Returns the new
  214. response.
  215. """
  216. for func in self.response_fixes:
  217. response = func(request, response)
  218. return response