[Django] #28567: Set Language Redirect View -> 404 if prefix_default_language=False
Django
-------------------------------------------+------------------------
Reporter: George Tantiras | Owner: nobody
Type: Uncategorized | Status: new
Component: Uncategorized | Version: 1.11
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-------------------------------------------+------------------------
Using python 3.4.
In a fresh Django 1.11 install, I configured 2 languages: English (default
Language) and Greek.
When I implemented the example
[https://docs.djangoproject.com/en/dev/topics/i18n/translation/#the-set-
language-redirect-view HTML template code] to add a change language drop
down in admin, everything worked as expected if
`prefix_default_language=True`
However, the following configuration in urls.py although it works when I
change from English to Greek, it will stay to the Greek page when I try to
change from Greek to English:
{{{
clean = [
url(r'^i18n/', include('django.conf.urls.i18n')),
]
admin = i18n_patterns(
url(r'^admin/', admin.site.urls),
prefix_default_language=False
)
urlpatterns = admin + clean
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/28567>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: George Tantiras | Owner: nobody
Component: | Version: 1.11
Internationalization |
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Tim Graham):
* type: Uncategorized => Bug
* component: Uncategorized => Internationalization
Comment:
Can you provide a test that demonstrates the problem? Ideally, as part of
Django's test suite. b8a815e9dfea89034ede7ff786551f89af84a31b may give you
an idea of where to add a test.
--
Ticket URL: <https://code.djangoproject.com/ticket/28567#comment:1>
Django
Reporter: George Tantiras | Owner: nobody
Component: | Version: 1.11
Internationalization |
Severity: Normal | Resolution:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by George Tantiras):
I have written a test class in my project, for the time being. It is a
challenge to integrate it to Django, so I am pasting it here until then:
{{{
from django.test import TestCase
class setlangTest(TestCase):
def test_en2gr(self):
response = self.client.post(
'/i18n/setlang/',
data={'language': 'el'},
follow=False,
HTTP_REFERER='/admin/',
)
self.assertEqual(response.url, '/el/admin/', 'Did not change from
English to Greek')
def test_gr2en(self):
response = self.client.post(
'/i18n/setlang/',
data={'language': 'en'},
follow=False,
HTTP_REFERER='/el/admin/',
)
self.assertEqual(response.url, '/admin/', 'Did not change from
Greek to English')
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/28567#comment:2>
Django
Reporter: George Tantiras | Owner: nobody
Component: | Version: 1.11
Internationalization |
Severity: Normal | Resolution:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by George Tantiras):
I have created a relevant [https://github.com/django/django/pull/9058 pull
request] which includes the above tests.
--
Ticket URL: <https://code.djangoproject.com/ticket/28567#comment:3>
Django
Reporter: George Tantiras | Owner: Tomer
| Chachamu
Type: Bug | Status: assigned
Component: | Version: 1.11
Internationalization |
Severity: Normal | Resolution:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Tomer Chachamu):
* owner: nobody => Tomer Chachamu
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/28567#comment:4>
Django
--------------------------------------+------------------------------------
Reporter: George Tantiras | Owner: (none)
Type: Bug | Status: new
Component: Internationalization | Version: 1.11
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 1
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Tomer Chachamu):
* owner: Tomer Chachamu => (none)
* needs_docs: 0 => 1
* status: assigned => new
* stage: Unreviewed => Accepted
Comment:
Thanks for that test, it really clarified it.
In the HTML in the documentation you mentioned, it mentions the
`redirect_to` context variable, but doesn't really explain what to set it
to. In your case, it is empty, so the `set_language` view has started
looking at the `HTTP_REFERRER` as shown in your tests.
You need to set `redirect_to` to the current page URL, without the
language prefix. For example, you could add this context processor to your
settings:
{{{#!python
from django.urls import translate_url
def redirect_path_context_processor(request):
return {'language_select_redirect_to': translate_url(request.path,
settings.LANGUAGE_CODE)}
}}}
The `set_language` view will then translate the URL again to the user's
selected language.
Also, if you *do* use `prefix_default_language=True`, then the URL for the
set_language view should also be prefixed. I don't think this is
documented anywhere.
--
Ticket URL: <https://code.djangoproject.com/ticket/28567#comment:5>
Django
--------------------------------------+------------------------------------
Reporter: George Tantiras | Owner: (none)
Type: Bug | Status: new
Component: Internationalization | Version: 1.11
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Tomer Chachamu):
Here are some passing tests showing how the view will behave when you have
set `next` correctly.
{{{#!python
@override_settings(
USE_I18N=True,
LANGUAGES=[
('en', 'English'),
('fr', 'French'),
('de', 'German'),
],
MIDDLEWARE=[
'django.contrib.sessions.middleware.SessionMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'django.middleware.locale.LocaleMiddleware',
'django.middleware.common.CommonMiddleware',
],
ROOT_URLCONF='i18n.i18n_unprefixed_urls',
LANGUAGE_CODE='en',
)
class UnprefixedI18nSetLang(TestCase):
def test_en2fr(self):
self.client.post('/i18n/setlang/', data={'language': 'en'})
response = self.client.post(
'/i18n/setlang/',
data={'language': 'fr', 'next': '/admin/'},
follow=True,
)
self.assertEqual(
response.redirect_chain,
[('/fr/admin/', 302), ('/fr/admin/login/?next=/fr/admin/',
302)]
)
def test_fr2en(self):
self.client.post('/i18n/setlang/', data={'language': 'fr'})
response = self.client.post(
'/i18n/setlang/',
data={'language': 'en', 'next': '/admin/'},
follow=True,
)
self.assertEqual(
response.redirect_chain,
[('/admin/', 302), ('/admin/login/?next=/admin/', 302)]
)
def test_fr2de(self):
self.client.post('/i18n/setlang/', data={'language': 'fr'})
response = self.client.post(
'/i18n/setlang/',
data={'language': 'de', 'next': '/admin/'},
follow=True,
)
self.assertEqual(
response.redirect_chain,
[('/de/admin/', 302), ('/de/admin/login/?next=/de/admin/',
302)]
)
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/28567#comment:6>
Django
--------------------------------------+------------------------------------
Reporter: George Tantiras | Owner: (none)
Type: Bug | Status: new
Component: Internationalization | Version: 1.11
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by George Tantiras):
Thank you, indeed. The docs
[https://docs.djangoproject.com/en/1.11/topics/i18n/translation/#the-set-
language-redirect-view] read:
After setting the language choice, Django looks for a next parameter in
the POST or GET data. If that is found and Django considers it to be a
safe URL (i.e. it doesn’t point to a different host and uses a safe
scheme), a redirect to that URL will be performed. Otherwise, Django may
fall back to redirecting the user to the URL from the Referer header or,
if it is not set, to /, depending on the nature of the request:
And the example -I am using in my code where the problem appeared- has the
following line:
{{{
input name="next" type="hidden" value="{{ redirect_to }}" />
}}}
However, it is not clear how can the variabe {{{ redirect_to }}} be set
and it stays empty.
--
Ticket URL: <https://code.djangoproject.com/ticket/28567#comment:7>
Django
--------------------------------------+------------------------------------
Reporter: George Tantiras | Owner: (none)
Type: Bug | Status: new
Component: Internationalization | Version: 1.11
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Tomer Chachamu):
Hi George, try adding the above context processor in your
```settings.TEMPLATES['OPTIONS']['context_processors']```, see
https://docs.djangoproject.com/en/1.11/topics/templates/#django.template.backends.django.DjangoTemplates
--
Ticket URL: <https://code.djangoproject.com/ticket/28567#comment:8>
Django
--------------------------------------+------------------------------------
Reporter: George Tantiras | Owner: (none)
Type: Bug | Status: new
Component: Internationalization | Version: 1.11
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by George Tantiras):
Bingo!
I managed to add it, and it works as expected.
Thank you!
--
Ticket URL: <https://code.djangoproject.com/ticket/28567#comment:9>
Django
--------------------------------------+------------------------------------
Reporter: George Tantiras | Owner: (none)
Component: Internationalization | Version: 1.11
Severity: Normal | Resolution: invalid
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 1
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by George Tantiras):
* status: new => closed
* resolution: => invalid
--
Ticket URL: <https://code.djangoproject.com/ticket/28567#comment:10>
Django
--------------------------------------+------------------------------------
Reporter: George Tantiras | Owner: (none)
Component: Internationalization | Version: 1.11
Severity: Normal | Resolution:
Has patch: 0 | Needs documentation: 1
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by George Tantiras):
* status: closed => new
* resolution: invalid =>
--
Ticket URL: <https://code.djangoproject.com/ticket/28567#comment:11>
Django
--------------------------------------+------------------------------------
Reporter: George Tantiras | Owner: (none)
Type: Bug | Status: new
Component: Internationalization | Version: 1.11
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by George Tantiras):
* has_patch: 0 => 1
Comment:
[https://github.com/django/django/pull/11442 PR]
--
Ticket URL: <https://code.djangoproject.com/ticket/28567#comment:12>
Django
Reporter: George Tantiras | Owner: George
| Tantiras
Type: Bug | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by felixxm):
* status: new => assigned
* needs_docs: 1 => 0
* version: 1.11 => master
* component: Internationalization => Documentation
* owner: (none) => George Tantiras
--
Ticket URL: <https://code.djangoproject.com/ticket/28567#comment:13>
Django
-------------------------------------+-------------------------------------
Reporter: George Tantiras | Owner: George
| Tantiras
Type: Bug | Status: assigned
Internationalization |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Carlton Gibson):
* cc: Claude Paroz (added)
* has_patch: 1 => 0
* component: Documentation => Internationalization
Comment:
This looks like a bug to me, rather than a documentation issue.
You shouldn't have to set the `next` parameter, manually calling
`translate_url()` to get the value, since
[https://github.com/django/django/blob/8ba20d9071e9e1b8f2c81d4df977db4278342085/django/views/i18n.py#L45-L48
the `set_language()` view does that itself]:
{{{
next_trans = translate_url(next, lang_code)
if next_trans != next:
response = HttpResponseRedirect(next_trans)
}}}
A breakpoint inserted here, in the failing test case George provided
([https://github.com/django/django/pull/9058 Original PR]), shows the
`translate_url()` call failing.
Furthermore, as per the report, the `translate_url()` call works when
`prefix_default_language=True`.
The issue lies in the relation between the `set_language()` view,
LocaleMiddleware, and `i18n_patterns()` when
`prefix_default_language=False`.
If you disable `LocaleMiddleware` and set the the request language using
`translation.override()` (to, e.g. `'el'` here) the test passes.
The issue is in
[https://github.com/django/django/blob/8ba20d9071e9e1b8f2c81d4df977db4278342085/django/middleware/locale.py#L18-L26
`LocaleMiddle.process_request()`]:
{{{
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()
}}}
Here, because the `set_language()` view is routed outside of
`i18n_patterns()`, `not language_from_path and i18n_patterns_used and not
prefixed_default_language` is `True` and so the language is **always** set
to `settings.LANGUAGE_CODE`. This means that `translate_url()` never gets
a match trying to resolve the url to translate (because the wrong language
is activated).
**IF** you route the `set_language()` view inside `i18n_patterns()` then
the test passes **but you can't do that** because it's
[https://docs.djangoproject.com/en/2.2/topics/i18n/translation/#django.views.i18n.set_language
explicitly warned against in the docs]:
> **Warning**
> Make sure that you don’t include the above URL within i18n_patterns() -
it needs to be language-independent itself to work correctly.
Two thoughts:
* I'm not sure right now why that warning is required. (Could it be
changed?)
* `translate_url()` only functions on URLs coming from the currently
active language. Would it be feasible to have `set_language()` redetermine
the request language before calling `translate_url()`?
* Is `LocaleMiddleware's `not language_from_path and i18n_patterns_used
and not prefixed_default_language` correct? (I mean it seems it but...)
Option 2 seems the most likely. None of them look that nice.
Claude: I'd be grateful if you could check my reasoning here. 😬 Thanks.
--
Ticket URL: <https://code.djangoproject.com/ticket/28567#comment:14>
Django
i18n_patterns() when prefix_default_language=False.
-------------------------------------+-------------------------------------
Reporter: George Tantiras | Owner: George
| Tantiras
Type: Bug | Status: assigned
Component: | Version: master
Internationalization |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
--
Ticket URL: <https://code.djangoproject.com/ticket/28567#comment:15>
Django
i18n_patterns() when prefix_default_language=False.
-------------------------------------+-------------------------------------
Reporter: George Tantiras | Owner: George
| Tantiras
Type: Bug | Status: assigned
Component: | Version: master
Internationalization |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Carlton Gibson):
#30272 is related here.
--
Ticket URL: <https://code.djangoproject.com/ticket/28567#comment:16>
Django
i18n_patterns() when prefix_default_language=False.
Reporter: George Tantiras | Owner: (none)
Type: Bug | Status: new
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by George Tantiras):
* owner: George Tantiras => (none)
* status: assigned => new
Comment:
A decision is pending about the suited course of action for this case.
--
Ticket URL: <https://code.djangoproject.com/ticket/28567#comment:17>
Django
i18n_patterns() when prefix_default_language=False.
--------------------------------------+------------------------------------
Reporter: George Tantiras | Owner: (none)
Type: Bug | Status: new
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Mariusz Felisiak):
#35009 was a duplicate.
--
Ticket URL: <https://code.djangoproject.com/ticket/28567#comment:18>
Django
i18n_patterns() when prefix_default_language=False.
--------------------------------------+------------------------------------
Reporter: George Tantiras | Owner: (none)
Type: Bug | Status: new
Component: Internationalization | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Mariusz Felisiak):
#35034 was a duplicate.
--
Ticket URL: <https://code.djangoproject.com/ticket/28567#comment:19>
Django
i18n_patterns() when prefix_default_language=False.
--------------------------------------+------------------------------------
Reporter: George Tantiras | Owner: (none)
Type: Bug | Status: new
Component: Internationalization | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Eric Soroos):
#35034 was marked as a duplicate -- however it's a little different, with
no relationship to the `prefix_default_language`:
When posting to `/i18n/setlang/`:
* with a referrer in a language that's not the current django cooke
language like `/km/admin/foo/bar`,
* with a current language cookie of `django_language=en`
* and a post content of `next=&language=en`
`django.urls.translate_urls` attempts to resolve the url using the current
request language (in this case, en) and fails, because the url is in a
different language (km).
`i18n.set_language` then returns the original referrer in the location
header of the redirect, and the language doesn't apparently change,
confusing the user.
This is approximately option 2 from
https://code.djangoproject.com/ticket/28567#comment:14, but with the
resolution entirely in `translate_urls` instead of `set_language`. The
patch for `translate_urls` to handle alternate locales is approximately:
{{{
#!python
from django.utils.translation import override, check_for_language,
get_language_from_path
...
def translate_url(url, lang_code):
"""
Given a URL (absolute or relative), try to get its translated version
in
the `lang_code` language (either by i18n_patterns or by translated
regex).
Return the original URL if no translated version is found.
"""
parsed = urlsplit(url)
try:
# URL may be encoded.
try:
match = resolve(unquote(parsed.path))
except Resolver404:
url_lang_code = get_language_from_path(unquote(parsed.path))
if url_lang_code and check_for_language(url_lang_code):
with override(url_lang_code):
match = resolve(unquote(parsed.path))
else:
raise
except Resolver404:
pass
else:
...
}}}
https://github.com/django/django/compare/main...EricSoroos:django:35034
-translate-url
--
Ticket URL: <https://code.djangoproject.com/ticket/28567#comment:20>