fix: Redirects to newly created object (#7864)

django-cms · fsbraun · Apr 23, 2024 · Jan 5, 2024 · Jan 10, 2024 · Jan 10, 2024
commit 0b43a43c389b99025a022d194a17d0a16a6bf1d1
diff --git a/cms/admin/forms.py b/cms/admin/forms.py
@@ -252,6 +252,11 @@ class AddPageForm(BasePageContentForm):
         required=False,
         widget=forms.HiddenInput(),
     )
+    edit = forms.IntegerField(
+        # Got to edit/preview mode after adding
+        required=False,
+        widget=forms.HiddenInput(),
+    )
     content_defaults = {
         "in_navigation": True,
     }

diff --git a/cms/admin/pageadmin.py b/cms/admin/pageadmin.py
@@ -50,6 +50,7 @@
 )
 from cms.admin.permissionadmin import PERMISSION_ADMIN_INLINES
 from cms.cache.permissions import clear_permission_cache
+from cms.constants import MODAL_HTML_REDIRECT
 from cms.models import (
     CMSPlugin,
     EmptyPageContent,
@@ -65,6 +66,7 @@
 )
 from cms.plugin_pool import plugin_pool
 from cms.signals.apphook import set_restart_trigger
+from cms.toolbar.utils import get_object_edit_url
 from cms.utils import get_current_site, page_permissions, permissions
 from cms.utils.admin import jsonify_request
 from cms.utils.conf import get_cms_setting
@@ -980,6 +982,20 @@ def change_view(self, request, object_id, form_url='', extra_context=None):
 
         return super().change_view(request, object_id, form_url=form_url, extra_context=context)
 
+    def response_add(self, request, obj):
+        redirect = request.POST.get("edit", False)
+        if redirect == "1":
+            from django.core.cache import cache
+
+            from cms.cache.permissions import get_cache_key, get_cache_permission_version
+            cache.delete(get_cache_key(request.user, 'change_page'), version=get_cache_permission_version())
+
+            # redirect to the edit view if added from the toolbar
+            url = get_object_edit_url(obj)  # Redirects to preview if necessary
+            return HttpResponse(MODAL_HTML_REDIRECT.format(url=url))
+        return super().response_add(request, obj)
+
+
     def get_filled_languages(self, request, page):
         site_id = get_site(request).pk
         filled_languages = page.get_languages()

diff --git a/cms/cms_toolbars.py b/cms/cms_toolbars.py
@@ -499,7 +499,9 @@ def change_language_menu(self):
                 page_add_url = admin_reverse('cms_pagecontent_add')
 
                 for code, name in add:
-                    url = add_url_parameters(page_add_url, cms_page=self.page.pk, language=code)
+                    url = add_url_parameters(
+                        page_add_url, cms_page=self.page.pk, parent_node=self.page.node.id, language=code
+                    )
                     add_plugins_menu.add_modal_item(name, url=url)
 
             if remove:

diff --git a/cms/constants.py b/cms/constants.py
@@ -78,3 +78,5 @@
 SCRIPT_USERNAME = 'script'
 
 CMS_CONFIG_NAME = 'cms_config'
+
+MODAL_HTML_REDIRECT = '<body><a class="cms-view-new-object" target="_top" href="{url}">Redirecting...</a></body>'
diff --git a/cms/static/cms/js/modules/cms.modal.js b/cms/static/cms/js/modules/cms.modal.js
@@ -910,6 +910,14 @@ class Modal {
                 return;
             }
 
+            // check if we are redirected - should only happen after successful form submission
+            var redirect = body.find('a.cms-view-new-object').attr('href');
+
+            if (redirect) {
+                Helpers.reloadBrowser(redirect, false);
+                return true;
+            }
+
             // tabindex is required for keyboard navigation
             // body.attr('tabindex', '0');
             iframe.on('focus', function() {

diff --git a/cms/test_utils/testcases.py b/cms/test_utils/testcases.py
@@ -153,6 +153,18 @@ def add_page_permission(self, user, page, **kwargs):
         return pp
 
     def get_page_title_obj(self, page, language="en"):
+        import warnings
+
+        from cms.utils.compat.warnings import RemovedInDjangoCMS42Warning
+
+        warnings.warn(
+            "get_page_title_obj is deprecated, use get_pagecontent_obj instead",
+            RemovedInDjangoCMS42Warning,
+            stacklevel=2,
+        )
+        return PageContent.objects.get(page=page, language=language)
+
+    def get_pagecontent_obj(self, page, language="en"):
         return PageContent.objects.get(page=page, language=language)
 
     def _create_user(self, username, is_staff=False, is_superuser=False,

diff --git a/cms/tests/test_admin.py b/cms/tests/test_admin.py
@@ -371,7 +371,7 @@ def get_page(self):
 
     def test_change_innavigation(self):
         page = self.get_page()
-        content = self.get_page_title_obj(page, 'en')
+        content = self.get_pagecontent_obj(page, 'en')
         permless = self.get_permless()
         admin_user = self.get_admin()
         pagecontent_admin = self.pagecontent_admin_class

diff --git a/cms/tests/test_cache.py b/cms/tests/test_cache.py
@@ -457,7 +457,7 @@ def test_no_page_cache_on_toolbar_edit(self):
             superuser = self.get_superuser()
             # Create a test page
             page = create_page("test page 1", "nav_playground.html", "en")
-            page_content = self.get_page_title_obj(page)
+            page_content = self.get_pagecontent_obj(page)
             page_url = page.get_absolute_url()
             page_edit_url = get_object_edit_url(page_content)
 

diff --git a/cms/tests/test_extensions.py b/cms/tests/test_extensions.py
@@ -289,7 +289,7 @@ def setUp(self):
 
     def test_duplicate_extensions(self):
         with self.login_user_context(self.admin):
-            content = self.get_page_title_obj(self.page, 'en')
+            content = self.get_pagecontent_obj(self.page, 'en')
             # create page copy
             page_data = {
                 'title': 'type1', 'slug': 'type1', '_save': 1, 'template': 'nav_playground.html',

diff --git a/cms/tests/test_page_admin.py b/cms/tests/test_page_admin.py
@@ -32,6 +32,7 @@
     LanguageOverride,
     UserLoginContext,
 )
+from cms.toolbar.utils import get_object_edit_url
 from cms.utils.compat import DJANGO_4_2
 from cms.utils.compat.dj import installed_apps
 from cms.utils.conf import get_cms_setting
@@ -1310,7 +1311,7 @@ def test_form_url_page_change(self):
         with self.login_user_context(superuser):
             content_admin = PageContentAdmin(PageContent, admin.site)
             page = self.get_page()
-            content = self.get_page_title_obj(page, 'en')
+            content = self.get_pagecontent_obj(page, 'en')
             form_url = self.get_page_change_uri('en', page)
             # Middleware is needed to correctly setup the environment for the admin
             request = self.get_request()
@@ -1558,6 +1559,51 @@ def test_page_tree_render_localized_page_ids(self):
             self.assertEqual(response.status_code, 200)
 
 
+class PageActionsTestCase(PageTestBase):
+    def setUp(self):
+        self.admin = self.get_superuser()
+        self.site = Site.objects.get(pk=1)
+        self.page = create_page(
+            'My Page', 'nav_playground.html', 'en',
+            slug="ok",
+            site=self.site, created_by=self.admin)
+
+    def test_add_page_redirect(self):
+        """When adding the edit parameter to the add page form, the user should be redirected to the edit endpoint
+        of the new page."""
+        with self.login_user_context(self.admin):
+            # add page
+            page_data = {
+                'title': 'another page', 'slug': 'type1', 'template': 'nav_playground.html',
+                'language': 'en',
+                'edit': 1,
+            }
+            self.assertEqual(Page.objects.all().count(), 1)
+            response = self.client.post(
+                self.get_admin_url(PageContent, 'add'),
+                data=page_data,
+            )
+            redirect_url = get_object_edit_url(PageContent.objects.get(title='another page'))
+            self.assertContains(response, f'href="{redirect_url}"')
+            self.assertEqual(Page.objects.all().count(), 2)
+
+    def test_add_page_no_redirect(self):
+        with self.login_user_context(self.admin):
+            # add page
+            page_data = {
+                'title': 'another page', 'slug': 'type1', 'template': 'nav_playground.html',
+                'language': 'en',
+                'edit': 0,
+            }
+            self.assertEqual(Page.objects.all().count(), 1)
+            response = self.client.post(
+                self.get_admin_url(PageContent, 'add'),
+                data=page_data,
+            )
+            redirect_url = self.get_admin_url(PageContent, 'changelist') + "?language=en"
+            self.assertRedirects(response, redirect_url)
+            self.assertEqual(Page.objects.all().count(), 2)
+
 class PermissionsTestCase(PageTestBase):
 
     def _add_translation_to_page(self, page):
@@ -2912,7 +2958,7 @@ def test_user_can_copy_plugins_to_language(self):
         """
         page = self.get_permissions_test_page()
         staff_user = self.get_staff_user_with_no_permissions()
-        source_translation = self.get_page_title_obj(page, 'en')
+        source_translation = self.get_pagecontent_obj(page, 'en')
         target_translation = self._add_translation_to_page(page)
         endpoint = self.get_admin_url(PageContent, 'copy_language', source_translation.pk)
         plugins = [
@@ -4320,7 +4366,7 @@ def test_user_can_copy_plugins_to_language(self):
         """
         page = self._permissions_page
         staff_user = self.get_staff_user_with_no_permissions()
-        source_translation = self.get_page_title_obj(page, 'en')
+        source_translation = self.get_pagecontent_obj(page, 'en')
         target_translation = self._add_translation_to_page(page)
         endpoint = self.get_admin_url(PageContent, 'copy_language', source_translation.pk)
         plugins = [

diff --git a/cms/tests/test_placeholder.py b/cms/tests/test_placeholder.py
@@ -879,7 +879,7 @@ def test_sets_source_when_title_is_created(self):
         page = create_page('test page en', 'col_two.html', 'en')
 
         # check for en
-        page_content_en = self.get_page_title_obj(page)
+        page_content_en = self.get_pagecontent_obj(page)
         self.assertQuerySetEqual(
             Placeholder.objects.get_for_obj(page_content_en),
             page_content_en.get_placeholders(),
@@ -906,8 +906,8 @@ def test_sets_source_when_title_is_copied(self):
         with self.login_user_context(self.get_superuser()):
             new_page = self.copy_page(page, page, position=1)
 
-        page_content = self.get_page_title_obj(page)
-        new_page_content = self.get_page_title_obj(new_page)
+        page_content = self.get_pagecontent_obj(page)
+        new_page_content = self.get_pagecontent_obj(new_page)
         page_content_plhs = Placeholder.objects.get_for_obj(page_content)
         new_page_content_plhs = Placeholder.objects.get_for_obj(new_page_content)
         self.assertEqual(page_content_plhs.count(), new_page_content_plhs.count())

diff --git a/cms/tests/test_plugins.py b/cms/tests/test_plugins.py
@@ -816,7 +816,7 @@ def test_plugin_toolbar_struct(self):
 
     def test_plugin_toolbar_struct_permissions(self):
         page = self.get_permissions_test_page()
-        page_content = self.get_page_title_obj(page)
+        page_content = self.get_pagecontent_obj(page)
         page_edit_url = get_object_edit_url(page_content)
         staff_user = self.get_staff_user_with_no_permissions()
         placeholder = page.get_placeholders('en').get(slot='body')

diff --git a/cms/tests/test_rendering.py b/cms/tests/test_rendering.py
@@ -734,7 +734,7 @@ def test_render_placeholder_toolbar(self):
         placeholder.pk = placeholder.id = 99
 
         with self.login_user_context(self.get_superuser()):
-            page_content = self.get_page_title_obj(self.test_page)
+            page_content = self.get_pagecontent_obj(self.test_page)
             request = self.get_request(get_object_edit_url(page_content))
             request.session = {}
             request.toolbar = CMSToolbar(request)
@@ -771,7 +771,7 @@ def test_render_plugin_toolbar_markup(self):
         ]
 
         with self.login_user_context(self.get_superuser()):
-            page_content = self.get_page_title_obj(page)
+            page_content = self.get_pagecontent_obj(page)
             request = self.get_request(get_object_edit_url(page_content))
             request.session = {}
             request.toolbar = CMSToolbar(request)

diff --git a/cms/tests/test_templatetags.py b/cms/tests/test_templatetags.py
@@ -462,7 +462,7 @@ def test_render_plugin_editable(self):
         from django.core.cache import cache
         cache.clear()
         page = create_page('Test', 'col_two.html', 'en')
-        page_content = self.get_page_title_obj(page)
+        page_content = self.get_pagecontent_obj(page)
         placeholder = page.get_placeholders('en')[0]
         plugin = add_plugin(placeholder, TextPlugin, 'en', body='<b>Test</b>')
         template = "{% load cms_tags %}{% render_plugin plugin %}"
@@ -500,7 +500,7 @@ def test_render_plugin_not_editable(self):
 
     def test_render_plugin_no_context(self):
         page = create_page('Test', 'col_two.html', 'en')
-        page_content = self.get_page_title_obj(page)
+        page_content = self.get_pagecontent_obj(page)
         placeholder = Placeholder.objects.create(slot='test')
         plugin = add_plugin(placeholder, TextPlugin, 'en', body='Test')
         superuser = self.get_superuser()
@@ -557,7 +557,7 @@ def test_render_model_with_deferred_fields(self):
         Category.objects.create(name='foo', depth=1)
         cache.clear()
         page = create_page('Test', 'col_two.html', 'en')
-        page_content = self.get_page_title_obj(page)
+        page_content = self.get_pagecontent_obj(page)
         template = "{% load cms_tags %}{% render_model category 'name' %}"
         user = self._create_user("admin", True, True)
         request = RequestFactory().get(get_object_edit_url(page_content))
@@ -589,7 +589,7 @@ def test_render_model_add(self):
 
         cache.clear()
         page = create_page('Test', 'col_two.html', 'en')
-        page_content = self.get_page_title_obj(page)
+        page_content = self.get_pagecontent_obj(page)
         template = "{% load cms_tags %}{% render_model_add category %}"
         user = self._create_user("admin", True, True)
         request = RequestFactory().get(get_object_edit_url(page_content))
@@ -627,7 +627,7 @@ def test_render_model_add_block(self):
 
         cache.clear()
         page = create_page('Test', 'col_two.html', 'en')
-        page_content = self.get_page_title_obj(page)
+        page_content = self.get_pagecontent_obj(page)
         template = "{% load cms_tags %}{% render_model_add_block category %}wrapped{% endrender_model_add_block %}"
         user = self._create_user("admin", True, True)
         request = RequestFactory().get(get_object_edit_url(page_content))
Original file line number	Diff line number	Diff line change
Expand Up		@@ -78,3 +78,5 @@
		SCRIPT_USERNAME = 'script'

		CMS_CONFIG_NAME = 'cms_config'

		MODAL_HTML_REDIRECT = '<body><a class="cms-view-new-object" target="_top" href="{url}">Redirecting...</a></body>'