From ec1e3b6e74aa200b1ccafb42677390d639d26d8b Mon Sep 17 00:00:00 2001 From: Maxim Beder Date: Wed, 27 Oct 2021 20:03:00 +0200 Subject: [PATCH] fix: fix side-wide language for legacy UI When side-wide language is set via LANGUAGE_CODE site configuration, some elements of legacy UI still use the language set in user preferences (or None, which fallsback to 'en' if nothing is set in preferences). The expectation is that everything should be translated to the language which is set in the site configuration. In legacy UI (i.e. templates) the code of the current language sometimes is needed, and in these cases `user_language` variable from the context is used. The value for that variable is inserted via context processor, which takes the value from the user preferences. The solution modifies the context processor to check if there is a language set in site configuration, and if there is, send that value, instead of whatever value there was in user peferences. --- lms/djangoapps/courseware/context_processor.py | 6 ++++++ .../courseware/tests/test_context_processor.py | 9 ++++++++- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/lms/djangoapps/courseware/context_processor.py b/lms/djangoapps/courseware/context_processor.py index c6afdad46bee..bc40b166a50f 100644 --- a/lms/djangoapps/courseware/context_processor.py +++ b/lms/djangoapps/courseware/context_processor.py @@ -10,6 +10,7 @@ from edx_django_utils.cache import TieredCache from lms.djangoapps.courseware.models import LastSeenCoursewareTimezone +from openedx.core.djangoapps.site_configuration.helpers import get_value from openedx.core.djangoapps.user_api.errors import UserAPIInternalError, UserNotFound from openedx.core.djangoapps.user_api.preferences.api import get_user_preference, get_user_preferences from openedx.core.lib.cache_utils import get_cache @@ -26,6 +27,8 @@ def user_timezone_locale_prefs(request): """ Checks if request has an authenticated user. If so, sends set (or none if unset) time_zone and language prefs. + If site-wide language is set, that language is used over the language set + in user preferences. This interacts with the DateUtils to either display preferred or attempt to determine system/browser set time_zones and languages @@ -47,6 +50,9 @@ def user_timezone_locale_prefs(request): key: user_preferences.get(pref_name, None) for key, pref_name in RETRIEVABLE_PREFERENCES.items() } + site_wide_language = get_value('LANGUAGE_CODE', None) + if site_wide_language: + user_prefs['user_language'] = site_wide_language cached_value.update(user_prefs) return cached_value diff --git a/lms/djangoapps/courseware/tests/test_context_processor.py b/lms/djangoapps/courseware/tests/test_context_processor.py index 3eb873765bc1..df4c6543db33 100644 --- a/lms/djangoapps/courseware/tests/test_context_processor.py +++ b/lms/djangoapps/courseware/tests/test_context_processor.py @@ -3,7 +3,7 @@ """ from pytz import timezone -from unittest.mock import Mock +from unittest.mock import Mock, patch from django.contrib.auth.models import AnonymousUser from lms.djangoapps.courseware.context_processor import ( @@ -48,6 +48,13 @@ def test_no_language_preference(self): assert context['user_timezone'] is not None assert context['user_timezone'] == 'Asia/Tokyo' + @patch("lms.djangoapps.courseware.context_processor.get_value") + def test_site_wide_language_set(self, mock_get_value): + mock_get_value.return_value = 'ar' + set_user_preference(self.user, 'pref-lang', 'en') + context = user_timezone_locale_prefs(self.request) + assert context['user_language'] == 'ar' + def test_get_user_timezone_or_last_seen_timezone_or_utc(self): # We default to UTC course = CourseFactory()