8000 fix: Page menu disappeared in edit or structure endpoints when refreshing the toolbar by fsbraun · Pull Request #8137 · django-cms/django-cms · GitHub
[go: up one dir, main page]
Skip to content

fix: Page menu disappeared in edit or structure endpoints when refreshing the toolbar #8137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 10, 2025
Merged

fix: Page menu disappeared in edit or structure endpoints when refreshing the toolbar #8137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion cms/admin/forms.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1497,7 +1497,9 @@ def clean(self):

try:
# Use admin manager if available for the toolbar form
if hasattr(model_class, "admin_manager"):
if issubclass(model_class, PageContent):
generic_obj = model_class.admin_manager.select_related("page").get(pk=obj_id)
elif hasattr(model_class, "admin_manager"):
generic_obj = model_class.admin_manager.get(pk=obj_id)
else:
generic_obj = model_class.objects.get(pk=obj_id)
Expand Down
9 changes: 5 additions & 4 deletions cms/admin/settingsadmin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

from cms.admin.forms import RequestToolbarForm
from cms.models import UserSettings
from cms.models.contentmodels import PageContent
from cms.utils.page import get_page_from_request
from cms.utils.urlutils import admin_reverse

Expand Down Expand Up @@ -80,10 +81,10 @@ def get_toolbar(self, request):
cms_path = form_data.get('cms_path') or request.path_info
origin_url = urlparse(cms_path)
attached_obj = form_data.get('attached_obj')
current_page = get_page_from_request(request, use_path=origin_url.path, clean_path=True)

if attached_obj and current_page and not (attached_obj == current_page):
return HttpResponseBadRequest('Generic object does not match current page')
if isinstance(attached_obj, PageContent):
current_page = attached_obj.page
else:
current_page = get_page_from_request(request, use_path=origin_url.path, clean_path=True)

data = QueryDict(query_string=origin_url.query, mutable=True)
placeholders = request.GET.getlist("placeholders[]")
Expand Down
161 changes: 94 additions & 67 deletions cms/tests/test_placeholder_admin.py
View file
Open in desktop
10000
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,20 @@


class PlaceholderAdminTestCase(CMSTestCase):

def test_add_plugin_endpoint(self):
"""
The Placeholder admin add_plugin endpoint works
"""
superuser = self.get_superuser()
placeholder = Placeholder.objects.create(slot='test')
plugins = placeholder.get_plugins('en').filter(plugin_type='LinkPlugin')
placeholder = Placeholder.objects.create(slot="test")
plugins = placeholder.get_plugins("en").filter(plugin_type="LinkPlugin")
uri = self.get_add_plugin_uri(
placeholder=placeholder,
plugin_type='LinkPlugin',
language='en',
plugin_type="LinkPlugin",
language="en",
)
with self.login_user_context(superuser):
data = {'name': 'A Link', 'external_link': 'https://www.django-cms.org'}
data = {"name": "A Link", "external_link": "https://www.django-cms.org"}
response = self.client.post(uri, data)

self.assertEqual(response.status_code, 200)
Expand All @@ -35,28 +34,23 @@ def test_add_plugins_from_placeholder(self):
User can copy plugins from one placeholder to another
"""
superuser = self.get_superuser()
source_placeholder = Placeholder.objects.create(slot='source')
target_placeholder = Placeholder.objects.create(slot='target')
source_placeholder = Placeholder.objects.create(slot="source")
target_placeholder = Placeholder.objects.create(slot="target")
source_plugin = self._add_plugin_to_placeholder(source_placeholder)
endpoint = self.get_copy_plugin_uri(source_plugin)
with self.login_user_context(superuser):
data = {
'source_language': "en",
'source_placeholder_id': source_placeholder.pk,
'target_language': "en",
'target_placeholder_id': target_placeholder.pk,
"source_language": "en",
"source_placeholder_id": source_placeholder.pk,
"target_language": "en",
"target_placeholder_id": target_placeholder.pk,
}
response = self.client.post(endpoint, data)

# Test that the target placeholder has the plugin copied from the source placeholder
self.assertEqual(response.status_code, 200)
self.assertTrue(source_placeholder.get_plugins('en').filter(pk=source_plugin.pk).exists())
self.assertTrue(
target_placeholder
.get_plugins('en')
.filter(plugin_type=source_plugin.plugin_type)
.exists()
)
self.assertTrue(source_placeholder.get_plugins("en").filter(pk=source_plugin.pk).exists())
self.assertTrue(target_placeholder.get_plugins("en").filter(plugin_type=source_plugin.plugin_type).exists())

def test_copy_plugins_to_clipboard(self):
"""
Expand All @@ -68,27 +62,24 @@ def test_copy_plugins_to_clipboard(self):
user=superuser,
clipboard=Placeholder.objects.create(),
)
source_placeholder = Placeholder.objects.create(slot='source')
source_placeholder = Placeholder.objects.create(slot="source")
source_plugin = self._add_plugin_to_placeholder(source_placeholder)
endpoint = self.get_copy_plugin_uri(source_plugin)
with self.login_user_context(superuser):
data = {
'source_language': "en",
'source_placeholder_id': source_placeholder.pk,
'source_plugin_id': source_plugin.pk,
'target_language': "en",
'target_placeholder_id': user_settings.clipboard.pk,
"source_language": "en",
"source_placeholder_id": source_placeholder.pk,
"source_plugin_id": source_plugin.pk,
"target_language": "en",
"target_placeholder_id": user_settings.clipboard.pk,
}
response = self.client.post(endpoint, data)

# Test that the target placeholder has the plugin copied from the source placeholder (clipboard)
self.assertEqual(response.status_code, 200)
self.assertTrue(source_placeholder.get_plugins('en').filter(pk=source_plugin.pk).exists())
self.assertTrue(source_placeholder.get_plugins("en").filter(pk=source_plugin.pk).exists())
self.assertTrue(
user_settings.clipboard
.get_plugins('en')
.filter(plugin_type=source_plugin.plugin_type)
.exists()
user_settings.clipboard.get_plugins("en").filter(plugin_type=source_plugin.plugin_type).exists()
)

def test_copy_placeholder_to_clipboard(self):
Expand All @@ -101,54 +92,49 @@ def test_copy_placeholder_to_clipboard(self):
user=superuser,
clipboard=Placeholder.objects.create(),
)
source_placeholder = Placeholder.objects.create(slot='source')
source_placeholder = Placeholder.objects.create(slot="source")
source_plugin = self._add_plugin_to_placeholder(source_placeholder)
endpoint = self.get_copy_plugin_uri(source_plugin)
with self.login_user_context(superuser):
data = {
'source_language': "en",
'source_placeholder_id': source_placeholder.pk,
'target_language': "en",
'target_placeholder_id': user_settings.clipboard.pk,
"source_language": "en",
"source_placeholder_id": source_placeholder.pk,
"target_language": "en",
"target_placeholder_id": user_settings.clipboard.pk,
}
response = self.client.post(endpoint, data)

self.assertEqual(response.status_code, 200)
self.assertTrue(source_placeholder.get_plugins('en').filter(pk=source_plugin.pk).exists())
self.assertTrue(
user_settings.clipboard
.get_plugins('en')
.filter(plugin_type='PlaceholderPlugin')
.exists()
)
self.assertTrue(source_placeholder.get_plugins("en").filter(pk=source_plugin.pk).exists())
self.assertTrue(user_settings.clipboard.get_plugins("en").filter(plugin_type="PlaceholderPlugin").exists())

def test_edit_plugin_endpoint(self):
"""
The Placeholder admin edit_plugins endpoint works
"""
superuser = self.get_superuser()
placeholder = Placeholder.objects.create(slot='edit_plugin_placeholder')
placeholder = Placeholder.objects.create(slot="edit_plugin_placeholder")
plugin = self._add_plugin_to_placeholder(placeholder)
endpoint = self.get_change_plugin_uri(plugin)
with self.login_user_context(superuser):
data = model_to_dict(plugin, fields=['name', 'external_link'])
data['name'] = 'Contents modified'
data = model_to_dict(plugin, fields=["name", "external_link"])
data["name"] = "Contents modified"
response = self.client.post(endpoint, data)
plugin.refresh_from_db()

self.assertEqual(response.status_code, 200)
self.assertEqual(plugin.name, data['name'])
self.assertEqual(plugin.name, data["name"])

def test_delete_plugin_endpoint(self):
"""
The Placeholder admin delete_plugin endpoint works
"""
superuser = self.get_superuser()
placeholder = Placeholder.objects.create(slot='source')
placeholder = Placeholder.objects.create(slot="source")
plugin = self._add_plugin_to_placeholder(placeholder)
endpoint = self.get_delete_plugin_uri(plugin)
with self.login_user_context(superuser):
data = {'post': True}
data = {"post": True}
response = self.client.post(endpoint, data)

self.assertEqual(response.status_code, 302)
Expand All @@ -159,14 +145,14 @@ def test_clear_placeholder_endpoint(self):
The Placeholder admin delete_plugin endpoint works
"""
superuser = self.get_superuser()
placeholder = Placeholder.objects.create(slot='source')
placeholder = Placeholder.objects.create(slot="source")
self._add_plugin_to_placeholder(placeholder)
endpoint = self.get_clear_placeholder_url(placeholder)
with self.login_user_context(superuser):
response = self.client.post(endpoint, {'test': 0})
response = self.client.post(endpoint, {"test": 0})

self.assertEqual(response.status_code, 302)
self.assertEqual(placeholder.get_plugins('en').count(), 0)
self.assertEqual(placeholder.get_plugins("en").count(), 0)

def _fill_page_body(self, page, lang):
ph_en = page.get_placeholders(lang).get(slot="placeholder")
Expand All @@ -183,19 +169,29 @@ def _fill_page_body(self, page, lang):
add_plugin(ph_en, "LinkPlugin", lang, target=col4, name="A Link", external_link="https://www.django-cms.org")
add_plugin(ph_en, "StylePlugin", lang, target=col4, tag_type="div")

@override_settings(CMS_PLACEHOLDER_CONF={
'simple.html': {'excluded_plugins': ['InheritPlugin']},
})
@override_settings(
CMS_PLACEHOLDER_CONF={
"simple.html": {"excluded_plugins": ["InheritPlugin"]},
}
)
def test_object_edit_endpoint(self):
page = create_page('Page 1', 'simple.html', 'en')
self._fill_page_body(page, 'en')
page = create_page("Page 1", "simple.html", "en")
self._fill_page_body(page, "en")
content = page.get_content_obj()
content_type = ContentType.objects.get(app_label='cms', model='pagecontent')
content_type = ContentType.objects.get(app_label="cms", model="pagecontent")
user = self.get_superuser()
settings = UserSettings.objects.create(language="en", user=user, clipboard=Placeholder.objects.create(slot='clipboard'))
settings = UserSettings.objects.create(
language="en", user=user, clipboard=Placeholder.objects.create(slot="clipboard")
)
settings.clipboard.source = settings
settings.clipboard.save()
endpoint = admin_reverse('cms_placeholder_render_object_edit', args=(content_type.pk, content.pk,))
endpoint = admin_reverse(
"cms_placeholder_render_object_edit",
args=(
content_type.pk,
content.pk,
),
)
with self.login_user_context(user):
with CaptureQueriesContext(connection) as queries:
response = self.client.get(endpoint)
Expand All @@ -218,20 +214,30 @@ def test_object_edit_endpoint(self):
# 14. SELECT "cms_cmsplugin"."id", "cms_cmsplugin"."placeholder_id", "cms_cmsplugin"."parent_id", "cms_cmsplugin"."position", "cms_cmsplugin"."language", "cms_cmsplugin"."plugin_type", "cms_cmsplugin"."creation_date", "cms_cmsplugin"."changed_date", "link_link"."cmsplugin_ptr_id", "link_link"."name", "link_link"."external_link" FROM "link_link" INNER JOIN "cms_cmsplugin" ON ("link_link"."cmsplugin_ptr_id" = "cms_cmsplugin"."id") WHERE "link_link"."cmsplugin_ptr_id" IN (7) ORDER BY "cms_cmsplugin"."position" ASC
# 15. SELECT "cms_cmsplugin"."id", "cms_cmsplugin"."placeholder_id", "cms_cmsplugin"."parent_id", "cms_cmsplugin"."position", "cms_cmsplugin"."language", "cms_cmsplugin"."plugin_type", "cms_cmsplugin"."creation_date", "cms_cmsplugin"."changed_date", "style_style"."cmsplugin_ptr_id", "style_style"."label", "style_style"."tag_type", "style_style"."class_name", "style_style"."additional_classes" FROM "style_style" INNER JOIN "cms_cmsplugin" ON ("style_style"."cmsplugin_ptr_id" = "cms_cmsplugin"."id") WHERE "style_style"."cmsplugin_ptr_id" IN (9) ORDER BY "cms_cmsplugin"."position" ASC

@override_settings(CMS_PLACEHOLDER_CONF={
'simple.html': {'excluded_plugins': ['InheritPlugin']},
})
@override_settings(
CMS_PLACEHOLDER_CONF={
"simple.html": {"excluded_plugins": ["InheritPlugin"]},
}
)
def test_object_structure_endpoint(self):
page = create_page('Page 1', 'simple.html', 'en')
self._fill_page_body(page, 'en')
page = create_page("Page 1", "simple.html", "en")
self._fill_page_body(page, "en")
content = page.get_content_obj()
content_type = ContentType.objects.get(app_label='cms', model='pagecontent')
content_type = ContentType.objects.get(app_label="cms", model="pagecontent")
user = self.get_superuser()
settings = UserSettings.objects.create(language="en", user=user, clipboard=Placeholder.objects.create(slot='clipboard'))
settings = UserSettings.objects.create(
language="en", user=user, clipboard=Placeholder.objects.create(slot="clipboard")
)
settings.clipboard.source = settings
settings.clipboard.save()

endpoint = admin_reverse('cms_placeholder_render_object_structure', args=(content_type.pk, content.pk,))
endpoint = admin_reverse(
"cms_placeholder_render_object_structure",
args=(
content_type.pk,
content.pk,
),
)
with self.login_user_context(user):
with CaptureQueriesContext(connection) as queries:
response = self.client.get(endpoint)
Expand All @@ -255,3 +261,24 @@ def test_object_structure_endpoint(self):
# 15. SELECT "cms_cmsplugin"."id", "cms_cmsplugin"."placeholder_id", "cms_cmsplugin"."parent_id", "cms_cmsplugin"."position", "cms_cmsplugin"."language", "cms_cmsplugin"."plugin_type", "cms_cmsplugin"."creation_date", "cms_cmsplugin"."changed_date", "link_link"."cmsplugin_ptr_id", "link_link"."name", "link_link"."external_link" FROM "link_link" INNER JOIN "cms_cmsplugin" ON ("link_link"."cmsplugin_ptr_id" = "cms_cmsplugin"."id") WHERE "link_link"."cmsplugin_ptr_id" IN (7) ORDER BY "cms_cmsplugin"."position" ASC
# 16. SELECT "cms_cmsplugin"."language" AS "language" FROM "cms_cmsplugin" WHERE "cms_cmsplugin"."placeholder_id" = 1 ORDER BY "cms_cmsplugin"."position" ASC
# 17. SELECT "cms_cmsplugin"."id", "cms_cmsplugin"."placeholder_id", "cms_cmsplugin"."parent_id", "cms_cmsplugin"."position", "cms_cmsplugin"."language", "cms_cmsplugin"."plugin_type", "cms_cmsplugin"."creation_date", "cms_cmsplugin"."changed_date", "style_style"."cmsplugin_ptr_id", "style_style"."label", "style_style"."tag_type", "style_style"."class_name", "style_style"."additional_classes" FROM "style_style" INNER JOIN "cms_cmsplugin" ON ("style_style"."cmsplugin_ptr_id" = "cms_cmsplugin"."id") WHERE "style_style"."cmsplugin_ptr_id" IN (9) ORDER BY "cms_cmsplugin"."position" ASC

def test_get_toolbar_endpoint(self):
"""Toolbar endpoint returns the toolbar including the page menu when called from the edit endpoint"""
page = create_page("Page 1", "simple.html", "en")
self._fill_page_body(page, "en")
content = page.get_content_obj()
content_type = ContentType.objects.get(app_label="cms", model="pagecontent")
user = self.get_superuser()
toolbar_endpoint = admin_reverse("cms_usersettings_get_toolbar")
edit_endpoint = admin_reverse(
"cms_placeholder_render_object_edit",
args=(
content_type.pk,
content.pk,
),
)

with self.login_user_context(user):
response = self.client.get(f"{toolbar_endpoint}?obj_id={content.id}&obj_type=cms.pagecontent&cms_path={edit_endpoint}")

self.assertContains(response, '<span>Page<span class="cms-icon cms-icon-arrow"></span></span>') # Contains page menu
0