feat: Preserve GET params for "View published" button (#509)

* feat: Preserve GET params for "View published" button

* fix: Update helper

* fix: Preserve GET params on edit_redirect

* fix: Only add search string if GET params present

* fix: Helper signature

* Add tests

* add final test

Author: fsbraun

djangocms_versioning/admin.py

@@ -1222,7 +1222,7 @@ def edit_redirect_view(self, request, object_id):
             return redirect(version_list_url(version.content))
 
         # Redirect
-        return redirect(get_editable_url(target.content, request.GET.get("force_admin")))
+        return redirect(get_editable_url(target.content, request.GET.get("force_admin"), request.GET))
 
     def revert_view(self, request, object_id):
         """Reverts to the specified version i.e. creates a draft from it."""

djangocms_versioning/cms_toolbars.py

@@ -107,6 +107,8 @@ def _add_edit_button(self, disabled=False):
                 f"admin:{proxy_model._meta.app_label}_{proxy_model.__name__.lower()}_edit_redirect",
                 args=(version.pk,),
             )
+            if self.request.GET:
+                edit_url += "?" + self.request.GET.urlencode()
             pks_for_grouper = version.versionable.for_content_grouping_values(version.content).values_list(
                 "pk", flat=True
             )
@@ -254,7 +256,8 @@ def _add_view_published_button(self):
 
         url = None
         if hasattr(published_version, "get_absolute_url"):
-            url = get_object_live_url(published_version, site=get_current_site(self.toolbar.request))
+            request = self.toolbar.request
+            url = get_object_live_url(published_version, site=get_current_site(request), params=request.GET)
         if url and (self.toolbar.edit_mode_active or self.toolbar.preview_mode_active):
             item = ButtonList(side=self.toolbar.RIGHT)
             item.add_button(

djangocms_versioning/helpers.py

@@ -35,7 +35,7 @@
     from cms.utils import get_current_site  # noqa F401
 except ImportError:
     # cms < 5.1
-    def get_object_live_url(obj, language=None, site=None) -> str:
+    def get_object_live_url(obj, language=None, site=None, params=None) -> str:
         with force_language(language):
             return obj.get_absolute_url()
 
@@ -265,13 +265,15 @@ def is_content_editable(placeholder: Placeholder, user: models.Model) -> bool:
     return version.state == DRAFT
 
 
-def get_editable_url(content_obj, force_admin=False):
+def get_editable_url(content_obj, force_admin=False, params=None):
     """If the object is editable the cms editable view should be used, with the toolbar.
     This method provides the URL for it.
     """
     if is_editable_model(content_obj.__class__) and not force_admin:
         language = getattr(content_obj, "language", None)
         url = get_object_edit_url(content_obj, language)
+        if params:
+            url += "?" + params.urlencode()
     # Or else, the standard edit view should be used
     else:
         url = admin_reverse(

tests/test_admin.py

@@ -2074,6 +2074,40 @@ def test_edit_redirect_view_non_editable_object_endpoint(self):
 
         self.assertRedirects(response, target_url, target_status_code=302)
 
+    def test_edit_redirect_view_preserves_get_params_for_editable_target(self):
+        page_versionable = VersioningCMSConfig.versioning[0]
+        page_version = factories.PageVersionFactory(content__language="en")
+        url = self.get_admin_url(
+            page_versionable.version_model_proxy, "edit_redirect", page_version.pk
+        )
+        params = {"foo": "bar", "next": "/return/"}
+
+        with self.login_user_context(self.superuser):
+            response = self.client.post(f"{url}?{urlencode(params)}")
+
+        parsed = urlparse(response.url)
+        self.assertEqual(
+            parsed.path, get_object_edit_url(page_version.content, language="en")
+        )
+        self.assertEqual(parse_qs(parsed.query), {"foo": ["bar"], "next": ["/return/"]})
+
+    def test_edit_redirect_view_drops_get_params_for_admin_redirect(self):
+        draft_version = factories.PollVersionFactory(state=constants.DRAFT)
+        url = self.get_admin_url(
+            self.versionable.version_model_proxy, "edit_redirect", draft_version.pk
+        )
+        params = {"force_admin": "1", "next": "/return/"}
+
+        with self.login_user_context(self.superuser):
+            response = self.client.post(f"{url}?{urlencode(params)}")
+
+        parsed = urlparse(response.url)
+        self.assertEqual(
+            parsed.path,
+            self.get_admin_url(PollContent, "change", draft_version.content.pk),
+        )
+        self.assertEqual(parse_qs(parsed.query), {})
+
     @patch("django.contrib.messages.add_message")
     def test_edit_redirect_view_handles_nonexistent_version(self, mocked_messages):
         url = self.get_admin_url(

tests/test_helpers.py

@@ -0,0 +1,57 @@
+from unittest import skipIf
+from urllib.parse import parse_qs, urlparse
+
+from cms import __version__ as cms_version
+from cms.test_utils.testcases import CMSTestCase
+from cms.toolbar.utils import get_object_edit_url
+from django.http import QueryDict
+from packaging.version import Version as PackageVersion
+
+from djangocms_versioning import helpers
+from djangocms_versioning.test_utils import factories
+from djangocms_versioning.test_utils.polls.models import PollContent
+
+
+class HelperUrlFunctionsTestCase(CMSTestCase):
+    def test_get_editable_url_appends_params_for_editable_content(self):
+        version = factories.PageVersionFactory(content__language="en")
+        params = QueryDict("foo=bar&baz=qux")
+
+        url = helpers.get_editable_url(version.content, params=params)
+
+        parsed = urlparse(url)
+        self.assertEqual(
+            parsed.path, get_object_edit_url(version.content, language="en")
+        )
+        self.assertEqual(parse_qs(parsed.query), {"foo": ["bar"], "baz": ["qux"]})
+
+    def test_get_editable_url_does_not_append_params_for_admin_change(self):
+        poll_version = factories.PollVersionFactory()
+        params = QueryDict("foo=bar&force_admin=1")
+
+        url = helpers.get_editable_url(
+            poll_version.content, force_admin=True, params=params
+        )
+
+        parsed = urlparse(url)
+        self.assertEqual(
+            parsed.path,
+            helpers.get_admin_url(PollContent, "change", poll_version.content.pk),
+        )
+        self.assertEqual(parse_qs(parsed.query), {})
+
+    @skipIf(
+        PackageVersion(cms_version) < PackageVersion("5.1"),
+        "get_object_live_url params supported only on django CMS 5.1+",
+    )
+    def test_get_object_live_url_appends_params(self):
+        poll_version = factories.PollVersionFactory(content__language="en")
+        params = QueryDict("foo=bar&baz=2")
+
+        url = helpers.get_object_live_url(
+            poll_version.content, language="en", params=params
+        )
+
+        parsed = urlparse(url)
+        self.assertEqual(parsed.path, poll_version.content.get_absolute_url())
+        self.assertEqual(parse_qs(parsed.query), {"foo": ["bar"], "baz": ["2"]})

tests/test_toolbars.py

@@ -14,7 +14,7 @@
 
 from djangocms_versioning import cms_toolbars
 from djangocms_versioning.cms_config import VersioningCMSConfig
-from djangocms_versioning.cms_toolbars import VersioningPageToolbar
+from djangocms_versioning.cms_toolbars import VersioningPageToolbar, VersioningToolbar
 from djangocms_versioning.constants import ARCHIVED, DRAFT, PUBLISHED
 from djangocms_versioning.helpers import version_list_url
 from djangocms_versioning.test_utils.factories import (
@@ -255,6 +255,42 @@ def test_default_edit_button_from_cms_exists(self):
         self.assertEqual(len(found_button_list), 1)
         self.assertNotEqual(found_button_list[0].url, edit_url)
 
+    def test_edit_button_preserves_get_params(self):
+        """
+        The edit button URL should contain all GET parameters from the request
+        """
+        from cms.toolbar.toolbar import CMSToolbar
+        from django.test import RequestFactory
+
+        version = PageVersionFactory(content__template="")
+        # Create a request with GET parameters
+        request = RequestFactory().get("/?foo=bar&baz=qux")
+        request.user = self.get_superuser()
+        request.session = {}
+        request.current_page = version.content.page
+        request.toolbar = CMSToolbar(request)
+
+        toolbar = VersioningToolbar(
+            request, toolbar=request.toolbar, is_current_app=True, app_path="/"
+        )
+        toolbar.toolbar.set_object(version.content)
+        toolbar.toolbar.edit_mode_active = False
+        toolbar.toolbar.preview_mode_active = True
+        toolbar.toolbar.structure_mode_active = False
+        toolbar.populate()
+        toolbar.post_template_populate()
+
+        edit_buttons = find_toolbar_buttons("Edit", toolbar.toolbar)
+        self.assertTrue(len(edit_buttons) > 0, "Edit button should be present in toolbar")
+        edit_button = edit_buttons[0]
+
+        # The edit button URL should include the GET parameters
+        self.assertIn("foo=bar", edit_button.url)
+        self.assertIn("baz=qux", edit_button.url)
+        # The base URL should still be the edit redirect URL
+        base_url = self._get_edit_url(version, VersioningCMSConfig.versioning[0])
+        self.assertIn(base_url, edit_button.url)
+
     def test_version_menu_for_non_version_content(self):
         # User objects are not registered with versioning, so attempting
         # to populate toolbar shouldn't contain a version menu