Skip to content

Commit

Permalink
Fixed #19468 -- Decoded request.path correctly on Python 3.
Browse files Browse the repository at this point in the history
Thanks aliva for the report and claudep for the feedback.
  • Loading branch information
aaugustin committed Dec 22, 2012
1 parent d9a0b6a commit 1e4a27d
Show file tree
Hide file tree
Showing 6 changed files with 49 additions and 19 deletions.
3 changes: 2 additions & 1 deletion django/contrib/staticfiles/handlers.py
Expand Up @@ -6,6 +6,7 @@
from urlparse import urlparse from urlparse import urlparse


from django.conf import settings from django.conf import settings
from django.core.handlers.base import get_path_info
from django.core.handlers.wsgi import WSGIHandler from django.core.handlers.wsgi import WSGIHandler


from django.contrib.staticfiles import utils from django.contrib.staticfiles import utils
Expand Down Expand Up @@ -67,6 +68,6 @@ def get_response(self, request):
return super(StaticFilesHandler, self).get_response(request) return super(StaticFilesHandler, self).get_response(request)


def __call__(self, environ, start_response): def __call__(self, environ, start_response):
if not self._should_handle(environ['PATH_INFO']): if not self._should_handle(get_path_info(environ)):
return self.application(environ, start_response) return self.application(environ, start_response)
return super(StaticFilesHandler, self).__call__(environ, start_response) return super(StaticFilesHandler, self).__call__(environ, start_response)
43 changes: 28 additions & 15 deletions django/core/handlers/base.py
Expand Up @@ -5,10 +5,14 @@
import types import types


from django import http from django import http
from django.conf import settings
from django.core import exceptions
from django.core import urlresolvers
from django.core import signals from django.core import signals
from django.utils.encoding import force_text from django.utils.encoding import force_text
from django.utils.importlib import import_module from django.utils.importlib import import_module
from django.utils import six from django.utils import six
from django.views import debug


logger = logging.getLogger('django.request') logger = logging.getLogger('django.request')


Expand All @@ -32,8 +36,6 @@ def load_middleware(self):
Must be called after the environment is fixed (see __call__ in subclasses). Must be called after the environment is fixed (see __call__ in subclasses).
""" """
from django.conf import settings
from django.core import exceptions
self._view_middleware = [] self._view_middleware = []
self._template_response_middleware = [] self._template_response_middleware = []
self._response_middleware = [] self._response_middleware = []
Expand Down Expand Up @@ -75,9 +77,6 @@ def load_middleware(self):


def get_response(self, request): def get_response(self, request):
"Returns an HttpResponse object for the given HttpRequest" "Returns an HttpResponse object for the given HttpRequest"
from django.core import exceptions, urlresolvers
from django.conf import settings

try: try:
# Setup default url resolver for this thread, this code is outside # Setup default url resolver for this thread, this code is outside
# the try/except so we don't get a spurious "unbound local # the try/except so we don't get a spurious "unbound local
Expand Down Expand Up @@ -147,7 +146,6 @@ def get_response(self, request):
'request': request 'request': request
}) })
if settings.DEBUG: if settings.DEBUG:
from django.views import debug
response = debug.technical_404_response(request, e) response = debug.technical_404_response(request, e)
else: else:
try: try:
Expand Down Expand Up @@ -204,8 +202,6 @@ def handle_uncaught_exception(self, request, resolver, exc_info):
caused by anything, so assuming something like the database is always caused by anything, so assuming something like the database is always
available would be an error. available would be an error.
""" """
from django.conf import settings

if settings.DEBUG_PROPAGATE_EXCEPTIONS: if settings.DEBUG_PROPAGATE_EXCEPTIONS:
raise raise


Expand All @@ -218,7 +214,6 @@ def handle_uncaught_exception(self, request, resolver, exc_info):
) )


if settings.DEBUG: if settings.DEBUG:
from django.views import debug
return debug.technical_500_response(request, *exc_info) return debug.technical_500_response(request, *exc_info)


# If Http500 handler is not installed, re-raise last exception # If Http500 handler is not installed, re-raise last exception
Expand All @@ -238,6 +233,20 @@ def apply_response_fixes(self, request, response):
response = func(request, response) response = func(request, response)
return response return response



def get_path_info(environ):
"""
Returns the HTTP request's PATH_INFO as a unicode string.
"""
path_info = environ.get('PATH_INFO', str('/'))
# Under Python 3, strings in environ are decoded with ISO-8859-1;
# re-encode to recover the original bytestring provided by the webserver.
if six.PY3:
path_info = path_info.encode('iso-8859-1')
# It'd be better to implement URI-to-IRI decoding, see #19508.
return path_info.decode('utf-8')


def get_script_name(environ): def get_script_name(environ):
""" """
Returns the equivalent of the HTTP request's SCRIPT_NAME environment Returns the equivalent of the HTTP request's SCRIPT_NAME environment
Expand All @@ -246,7 +255,6 @@ def get_script_name(environ):
from the client's perspective), unless the FORCE_SCRIPT_NAME setting is from the client's perspective), unless the FORCE_SCRIPT_NAME setting is
set (to anything). set (to anything).
""" """
from django.conf import settings
if settings.FORCE_SCRIPT_NAME is not None: if settings.FORCE_SCRIPT_NAME is not None:
return force_text(settings.FORCE_SCRIPT_NAME) return force_text(settings.FORCE_SCRIPT_NAME)


Expand All @@ -255,9 +263,14 @@ def get_script_name(environ):
# rewrites. Unfortunately not every Web server (lighttpd!) passes this # rewrites. Unfortunately not every Web server (lighttpd!) passes this
# information through all the time, so FORCE_SCRIPT_NAME, above, is still # information through all the time, so FORCE_SCRIPT_NAME, above, is still
# needed. # needed.
script_url = environ.get('SCRIPT_URL', '') script_url = environ.get('SCRIPT_URL', environ.get('REDIRECT_URL', str('')))
if not script_url:
script_url = environ.get('REDIRECT_URL', '')
if script_url: if script_url:
return force_text(script_url[:-len(environ.get('PATH_INFO', ''))]) script_name = script_url[:-len(environ.get('PATH_INFO', str('')))]
return force_text(environ.get('SCRIPT_NAME', '')) else:
script_name = environ.get('SCRIPT_NAME', str(''))
# Under Python 3, strings in environ are decoded with ISO-8859-1;
# re-encode to recover the original bytestring provided by the webserver.
if six.PY3:
script_name = script_name.encode('iso-8859-1')
# It'd be better to implement URI-to-IRI decoding, see #19508.
return script_name.decode('utf-8')
2 changes: 1 addition & 1 deletion django/core/handlers/wsgi.py
Expand Up @@ -128,7 +128,7 @@ def readline(self, size=None):
class WSGIRequest(http.HttpRequest): class WSGIRequest(http.HttpRequest):
def __init__(self, environ): def __init__(self, environ):
script_name = base.get_script_name(environ) script_name = base.get_script_name(environ)
path_info = force_text(environ.get('PATH_INFO', '/')) path_info = base.get_path_info(environ)
if not path_info or path_info == script_name: if not path_info or path_info == script_name:
# Sometimes PATH_INFO exists, but is empty (e.g. accessing # Sometimes PATH_INFO exists, but is empty (e.g. accessing
# the SCRIPT_NAME URL without a trailing slash). We really need to # the SCRIPT_NAME URL without a trailing slash). We really need to
Expand Down
6 changes: 5 additions & 1 deletion django/test/client.py
Expand Up @@ -245,7 +245,11 @@ def _get_path(self, parsed):
# If there are parameters, add them # If there are parameters, add them
if parsed[3]: if parsed[3]:
path += str(";") + force_str(parsed[3]) path += str(";") + force_str(parsed[3])
return unquote(path) path = unquote(path)
# WSGI requires latin-1 encoded strings. See get_path_info().
if six.PY3:
path = path.encode('utf-8').decode('iso-8859-1')
return path


def get(self, path, data={}, **extra): def get(self, path, data={}, **extra):
"Construct a GET request." "Construct a GET request."
Expand Down
3 changes: 2 additions & 1 deletion tests/regressiontests/handlers/tests.py
@@ -1,6 +1,7 @@
from django.core.handlers.wsgi import WSGIHandler from django.core.handlers.wsgi import WSGIHandler
from django.test import RequestFactory from django.test import RequestFactory
from django.test.utils import override_settings from django.test.utils import override_settings
from django.utils import six
from django.utils import unittest from django.utils import unittest


class HandlerTests(unittest.TestCase): class HandlerTests(unittest.TestCase):
Expand All @@ -22,7 +23,7 @@ def test_lock_safety(self):
def test_bad_path_info(self): def test_bad_path_info(self):
"""Tests for bug #15672 ('request' referenced before assignment)""" """Tests for bug #15672 ('request' referenced before assignment)"""
environ = RequestFactory().get('/').environ environ = RequestFactory().get('/').environ
environ['PATH_INFO'] = b'\xed' environ['PATH_INFO'] = '\xed'
handler = WSGIHandler() handler = WSGIHandler()
response = handler(environ, lambda *a, **k: None) response = handler(environ, lambda *a, **k: None)
self.assertEqual(response.status_code, 400) self.assertEqual(response.status_code, 400)
11 changes: 11 additions & 0 deletions tests/regressiontests/requests/tests.py
Expand Up @@ -11,6 +11,7 @@
from django.http import HttpRequest, HttpResponse, parse_cookie, build_request_repr, UnreadablePostError from django.http import HttpRequest, HttpResponse, parse_cookie, build_request_repr, UnreadablePostError
from django.test.client import FakePayload from django.test.client import FakePayload
from django.test.utils import override_settings, str_prefix from django.test.utils import override_settings, str_prefix
from django.utils import six
from django.utils import unittest from django.utils import unittest
from django.utils.http import cookie_date, urlencode from django.utils.http import cookie_date, urlencode
from django.utils.timezone import utc from django.utils.timezone import utc
Expand Down Expand Up @@ -57,6 +58,16 @@ def test_wsgirequest_repr(self):
self.assertEqual(build_request_repr(request, path_override='/otherpath/', GET_override={'a': 'b'}, POST_override={'c': 'd'}, COOKIES_override={'e': 'f'}, META_override={'g': 'h'}), self.assertEqual(build_request_repr(request, path_override='/otherpath/', GET_override={'a': 'b'}, POST_override={'c': 'd'}, COOKIES_override={'e': 'f'}, META_override={'g': 'h'}),
str_prefix("<WSGIRequest\npath:/otherpath/,\nGET:{%(_)s'a': %(_)s'b'},\nPOST:{%(_)s'c': %(_)s'd'},\nCOOKIES:{%(_)s'e': %(_)s'f'},\nMETA:{%(_)s'g': %(_)s'h'}>")) str_prefix("<WSGIRequest\npath:/otherpath/,\nGET:{%(_)s'a': %(_)s'b'},\nPOST:{%(_)s'c': %(_)s'd'},\nCOOKIES:{%(_)s'e': %(_)s'f'},\nMETA:{%(_)s'g': %(_)s'h'}>"))


def test_wsgirequest_path_info(self):
def wsgi_str(path_info):
path_info = path_info.encode('utf-8') # Actual URL sent by the browser (bytestring)
if six.PY3:
path_info = path_info.decode('iso-8859-1') # Value in the WSGI environ dict (native string)
return path_info
# Regression for #19468
request = WSGIRequest({'PATH_INFO': wsgi_str("/سلام/"), 'REQUEST_METHOD': 'get', 'wsgi.input': BytesIO(b'')})
self.assertEqual(request.path, "/سلام/")

def test_parse_cookie(self): def test_parse_cookie(self):
self.assertEqual(parse_cookie('invalid@key=true'), {}) self.assertEqual(parse_cookie('invalid@key=true'), {})


Expand Down

0 comments on commit 1e4a27d

Please sign in to comment.