Merge branch 'develop-4' into fix/delete-orphaned-plugins

fsbraun · web-flow · commit e2375ffe1f5d · 2024-02-29T00:12:48.000+01:00
diff --git a/.github/workflows/new_contributor_pr.yml b/.github/workflows/new_contributor_pr.yml
@@ -29,10 +29,9 @@ jobs:
     needs: new
     steps:
       - name: Send Discord Webhook
-        uses: Ilshidur/action-discord@master
-        with:
-          webhook_url: ${{ secrets.DISCORD_WEBHOOK_URL }}
-          content: |
+        env:
+          DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK_URL }}
+          DISCORD_EMBEDS: |
             {
               "embeds": [
                 {
@@ -56,3 +55,4 @@ jobs:
                 }
               ]
             }
+        uses: Ilshidur/action-discord@master
diff --git a/cms/plugin_rendering.py b/cms/plugin_rendering.py
@@ -82,7 +82,6 @@ class BaseRenderer:
 
     def __init__(self, request):
         self.request = request
-        self.request_language = get_language_from_request(self.request)
         self._cached_templates = {}
         self._cached_plugin_classes = {}
         self._placeholders_content_cache = {}
@@ -112,6 +111,10 @@ def plugin_pool(self):
         import cms.plugin_pool
         return cms.plugin_pool.plugin_pool
 
+    @cached_property
+    def request_language(self):
+        return get_language_from_request(self.request)
+
     def get_placeholder_plugin_menu(self, placeholder, page=None):
         registered_plugins = self.plugin_pool.registered_plugins
         can_add_plugin = partial(has_plugin_permission, user=self.request.user, permission_type='add')
diff --git a/cms/test_utils/testcases.py b/cms/test_utils/testcases.py
@@ -31,6 +31,7 @@
 )
 from cms.plugin_rendering import ContentRenderer, StructureRenderer
 from cms.test_utils.util.context_managers import UserLoginContext
+from cms.toolbar.utils import get_toolbar_from_request
 from cms.utils.compat import DJANGO_4_1
 from cms.utils.conf import get_cms_setting
 from cms.utils.permissions import set_current_user
@@ -662,6 +663,12 @@ def _add_plugin_to_placeholder(self, placeholder, plugin_type='LinkPlugin', lang
         plugin = add_plugin(placeholder, plugin_type, language, **plugin_data[plugin_type])
         return plugin
 
+    def _render_placeholder(self, placeholder, context, **kwargs):
+        request = context['request']
+        toolbar = get_toolbar_from_request(request)
+        content_renderer = toolbar.content_renderer
+        return content_renderer.render_placeholder(placeholder, context, **kwargs)
+
 
 class CMSTestCase(BaseCMSTestCase, testcases.TestCase):
     pass
diff --git a/cms/tests/test_i18n.py b/cms/tests/test_i18n.py
@@ -1,12 +1,21 @@
+from collections import deque
 from importlib import import_module
+from unittest.mock import patch
 
 from django.conf import settings
+from django.template.context import Context
 from django.test.utils import override_settings
 
 from cms import api
+from cms.plugin_rendering import (
+    ContentRenderer,
+    LegacyRenderer,
+    StructureRenderer,
+)
 from cms.test_utils.testcases import CMSTestCase
 from cms.utils import get_language_from_request, i18n
 from cms.utils.compat import DJANGO_2_2
+from cms.views import details
 
 if DJANGO_2_2:
     from django.utils.translation import LANGUAGE_SESSION_KEY
@@ -336,11 +345,15 @@ def test_get_fallback_languages(self):
 class TestLanguageFallbacks(CMSTestCase):
 
     def test_language_code(self):
+        '''
+        No redirect_on_fallback will return 200 with the fallback content
+        '''
         self.create_homepage("home", "nav_playground.html", "fr")
         response = self.client.get('/')
+        # no language code will cause a redirect.
         self.assertEqual(response.status_code, 302)
         response = self.client.get('/en/')
-        self.assertRedirects(response, '/fr/')
+        self.assertEqual(response.status_code, 200)
         response = self.client.get('/fr/')
         self.assertEqual(response.status_code, 200)
 
@@ -386,6 +399,125 @@ def test_session_language(self):
         self.assertEqual(response.status_code, 302)
         self.assertRedirects(response, '/en/')
 
+    @override_settings(
+        CMS_LANGUAGES={
+            'default': {
+                'fallbacks': ['en', 'fr'],
+                'public': True,  # no 404s
+                'redirect_on_fallback': False
+            }
+        },
+    )
+    def test_no_redirect_on_fallback(self):
+        homepage = self.create_homepage(
+            "home",
+            "nav_playground.html",
+            "fr"
+        )
+        page_data = self.get_new_page_data_dbfields(
+            language="fr"
+        )
+        page = api.create_page(**page_data)
+        response = self.client.get(page.get_absolute_url(language="en"))
+        self.assertEqual(response.status_code, 200)
+
+        # homepage should be the same
+        response = self.client.get(homepage.get_absolute_url(language="en"))
+        self.assertEqual(response.status_code, 200)
+
+    @override_settings(
+        CMS_LANGUAGES={
+            'default': {
+                'fallbacks': ['en', 'fr'],
+                'public': True,  # no 404s
+                'redirect_on_fallback': False
+            }
+        },
+    )
+    def test_no_redirect_on_fallback_content(self):
+        """
+        Test that the fallback content will be displayed
+        """
+        homepage = self.create_homepage(
+            "home",
+            "nav_playground.html",
+            "fr"
+        )
+        homepage_ph_fr = homepage.get_placeholders(
+            "fr").get(slot="body")
+        api.add_plugin(
+            homepage_ph_fr,
+            plugin_type="TextPlugin",
+            language="fr",
+            body="Hello, world!",
+        )
+        page_data = self.get_new_page_data_dbfields(
+            language="fr"
+        )
+        page = api.create_page(**page_data)
+        page_ph_fr = page.get_placeholders(
+            "fr").get(slot="body")
+        api.add_plugin(
+            page_ph_fr,
+            plugin_type="TextPlugin",
+            language="fr",
+            body="Hello, world!",
+        )
+        with patch("cms.views.render_pagecontent") as mock_render:
+            # normal page
+            path = page.get_absolute_url(language="en")
+            request = self.get_request(path)
+            details(request, slug=page.get_path("en"))
+            mock_render.assert_called_once_with(
+                request,
+                page.get_content_obj()
+            )
+            # check that the french plugins will render
+            context = Context({'request': request})
+            rendered_placeholder = self._render_placeholder(page_ph_fr, context)
+            self.assertEqual(rendered_placeholder, "Hello, world!")
+
+        with patch("cms.views.render_pagecontent") as mock_render:
+            # homepage should be the same
+            path = homepage.get_absolute_url(language="en")
+            request = self.get_request(path)
+            details(request, slug=homepage.get_path("en"))
+            mock_render.assert_called_once_with(
+                request,
+                homepage.get_content_obj()
+            )
+            # check that the french plugins will render
+            context = Context({'request': request})
+            rendered_placeholder = self._render_placeholder(homepage_ph_fr, context)
+            self.assertEqual(rendered_placeholder, "Hello, world!")
+
+    @override_settings(
+        CMS_LANGUAGES={
+            'default': {
+                'fallbacks': ['en', 'fr'],
+                'redirect_on_fallback': True,
+            }
+        }
+    )
+    def test_redirect_on_fallback(self):
+        page_data = self.get_new_page_data_dbfields(
+            language="fr"
+        )
+        page = api.create_page(**page_data)
+        response_fr = self.client.get(page.get_absolute_url(language="fr"))
+        self.assertEqual(response_fr.status_code, 200)
+        response_en = self.client.get(page.get_absolute_url(language="en"))
+        self.assertRedirects(response_en, page.get_absolute_url(language="fr"))
+
+        # homepage should be no different.
+        home_page_data = self.get_new_page_data_dbfields(
+            language="fr",
+        )
+        self.create_homepage(**home_page_data)
+        response_fr = self.client.get(page.get_absolute_url(language="fr"))
+        self.assertEqual(response_fr.status_code, 200)
+        response_en = self.client.get(page.get_absolute_url(language="en"))
+        self.assertRedirects(response_en, page.get_absolute_url(language="fr"))
 
 @override_settings(
     LANGUAGE_CODE='en',
diff --git a/cms/tests/test_multilingual.py b/cms/tests/test_multilingual.py
@@ -211,7 +211,7 @@ def test_page_with_invalid_language_for_anon_user(self):
             # url uses "en" as the request language
             # but the site is configured to use "de" and "fr"
             response = self.client.get('/en/')
-            self.assertRedirects(response, '/de/')
+            self.assertEqual(response.status_code, 200)
             response = self.client.get('/en/%s/' % page_2.get_path('de'))
             self.assertEqual(response.status_code, 404)
 
@@ -235,8 +235,10 @@ def test_page_with_invalid_language_for_auth_user(self):
             with self.login_user_context(superuser):
                 # url uses "en" as the request language
                 # but the site is configured to use "de" and "fr"
+                # and no redirect on fallback so cms will render
+                # in place
                 response = self.client.get('/en/')
-                self.assertRedirects(response, '/de/')
+                self.assertEqual(response.status_code, 200)
                 response = self.client.get('/en/%s/' % page_2.get_path('de'))
                 self.assertEqual(response.status_code, 404)
 
@@ -284,7 +286,9 @@ def test_language_fallback(self):
 
         with self.settings(CMS_LANGUAGES=lang_settings):
             response = self.client.get("/de/")
-            self.assertRedirects(response, '/en/')
+            # as per the comments above, the content should
+            # be rendered in place, no redirect should happen
+            self.assertEqual(response.status_code, 200)
 
     def test_no_english_defined(self):
         with self.settings(
diff --git a/cms/tests/test_plugins.py b/cms/tests/test_plugins.py
@@ -70,13 +70,6 @@ def register_plugins(*plugins):
             plugin_pool.unregister_plugin(plugin)
 
 
-def _render_placeholder(placeholder, context, **kwargs):
-    request = context['request']
-    toolbar = get_toolbar_from_request(request)
-    content_renderer = toolbar.content_renderer
-    return content_renderer.render_placeholder(placeholder, context, **kwargs)
-
-
 class DumbFixturePlugin(CMSPluginBase):
     model = CMSPlugin
     name = "Dumb Test Plugin. It does nothing."
@@ -277,7 +270,7 @@ def test_plugin_order(self):
             self.assertEqual(db_plugin_2.position, 2)
             # Finally we render the placeholder to test the actual content
             context = self.get_context(page_en.get_absolute_url(), page=page_en)
-            rendered_placeholder = _render_placeholder(ph_en, context)
+            rendered_placeholder = self._render_placeholder(ph_en, context)
             self.assertEqual(rendered_placeholder, "I'm the firstI'm the second")
 
     def test_plugin_order_alt(self):
@@ -316,7 +309,7 @@ def test_plugin_order_alt(self):
 
             # Finally we render the placeholder to test the actual content
             draft_page_context = self.get_context(cms_page.get_absolute_url(), page=cms_page)
-            rendered_placeholder = _render_placeholder(placeholder, draft_page_context)
+            rendered_placeholder = self._render_placeholder(placeholder, draft_page_context)
             self.assertEqual(rendered_placeholder, "I'm the firstI'm the secondI'm the third")
 
     def test_plugin_position(self):
@@ -633,7 +626,7 @@ def test_empty_plugin_is_ignored(self):
         )
 
         # this should not raise any errors, but just ignore the empty plugin
-        out = _render_placeholder(placeholder, self.get_context(), width=300)
+        out = self._render_placeholder(placeholder, self.get_context(), width=300)
         self.assertFalse(len(out))
         self.assertFalse(len(placeholder._plugins_cache))
 
diff --git a/cms/utils/__init__.py b/cms/utils/__init__.py
@@ -1,6 +1,7 @@
 # TODO: this is just stuff from utils.py - should be split / moved
 
 from cms.utils.i18n import (
+    get_current_language,
     get_default_language,
     get_language_code,
     get_language_list,
@@ -27,8 +28,9 @@ def get_language_from_request(request, current_page=None):
         language = get_language_code(language)
         if language not in get_language_list(site_id):
             language = None
-    if not language:
-        language = get_language_code(getattr(request, 'LANGUAGE_CODE', None))
+    if not language and request:
+        # get the active language
+        language = get_current_language()
     if language:
         if language not in get_language_list(site_id):
             language = None
diff --git a/cms/utils/check.py b/cms/utils/check.py
@@ -232,13 +232,11 @@ def check_middlewares(output):
             'cms.middleware.toolbar.ToolbarMiddleware',
             'cms.middleware.language.LanguageCookieMiddleware',
         )
-        if getattr(settings, 'MIDDLEWARE', None):
-            middlewares = settings.MIDDLEWARE
-        else:
-            middlewares = settings.MIDDLEWARE_CLASSES
+        middlewares = getattr(settings, 'MIDDLEWARE', [])
+
         for middleware in required_middlewares:
             if middleware not in middlewares:
-                section.error("%s middleware must be in MIDDLEWARE_CLASSES" % middleware)
+                section.error("%s middleware must be in MIDDLEWARE" % middleware)
 
 
 @define_check
diff --git a/cms/views.py b/cms/views.py
@@ -16,7 +16,7 @@
 from django.urls import Resolver404, resolve, reverse
 from django.utils.cache import patch_cache_control
 from django.utils.timezone import now
-from django.utils.translation import get_language_from_request
+from django.utils.translation import activate, get_language_from_request
 from django.views.decorators.http import require_POST
 
 from cms.apphook_pool import apphook_pool
@@ -174,17 +174,18 @@ def details(request, slug):
         if language != request_language and language in available_languages
     ]
     language_is_unavailable = request_language not in available_languages
+    first_fallback_language = next(iter(fallback_languages or []), None)
 
     if language_is_unavailable and not fallback_languages:
         # There is no page with the requested language
         # and there's no configured fallbacks
         return _handle_no_page(request)
-    elif language_is_unavailable and (redirect_on_fallback or page.is_home):
+    elif language_is_unavailable and redirect_on_fallback:
         # There is no page with the requested language and
-        # the user has explicitly requested to redirect on fallbacks,
+        # redirect_on_fallback is True,
         # so redirect to the first configured / available fallback language
-        fallback = fallback_languages[0]
-        redirect_url = page.get_absolute_url(fallback, fallback=False)
+        redirect_url = page.get_absolute_url(
+            first_fallback_language, fallback=False)
     else:
         page_path = page.get_absolute_url(request_language)
         page_slug = page.get_path(request_language) or page.get_slug(request_language)
@@ -212,7 +213,19 @@ def details(request, slug):
     if page.login_required and not request.user.is_authenticated:
         return redirect_to_login(quote(request.get_full_path()), settings.LOGIN_URL)
 
-    content = page.get_content_obj(language=request_language)
+    content_language = request_language
+    if language_is_unavailable:
+        # When redirect_on_fallback is False and
+        # language is unavailable, render the content
+        # in the first fallback language available
+        # by switching to it
+        content_language = first_fallback_language
+        # translation.activate() is used without context
+        # as the context won't be preserved when the
+        # plugins get rendered
+        activate(content_language)
+
+    content = page.get_content_obj(language=content_language)
     # use the page object with populated cache
     content.page = page
     if hasattr(request, 'toolbar'):
diff --git a/docs/contributing/development-community.rst b/docs/contributing/development-community.rst
diff --git a/docs/introduction/01-install.rst b/docs/introduction/01-install.rst
diff --git a/package-lock.json b/package-lock.json

Original file line number	Diff line number	Diff line change
`@@ -29,10 +29,9 @@ jobs:`
`29`	`29`	`needs: new`
`30`	`30`	`steps:`
`31`	`31`	`- name: Send Discord Webhook`
`32`		`- uses: Ilshidur/action-discord@master`
`33`		`- with:`
`34`		`- webhook_url: ${{ secrets.DISCORD_WEBHOOK_URL }}`
`35`		`- content: \|`
	`32`	`+ env:`
	`33`	`+ DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK_URL }}`
	`34`	`+ DISCORD_EMBEDS: \|`
`36`	`35`	`{`
`37`	`36`	`"embeds": [`
`38`	`37`	`{`
`@@ -56,3 +55,4 @@ jobs:`
`56`	`55`	`}`
`57`	`56`	`]`
`58`	`57`	`}`
	`58`	`+ uses: Ilshidur/action-discord@master`