fix: Only allow turning plugins into alias if they can be a root plugin

Author: fsbraun

djangocms_alias/cms_plugins.py

@@ -1,7 +1,7 @@
 from cms.models import Page
 from cms.plugin_base import CMSPluginBase, PluginMenuItem
 from cms.plugin_pool import plugin_pool
-from cms.toolbar.utils import get_object_edit_url
+from cms.toolbar.utils import get_object_edit_url, get_plugin_toolbar_info, get_plugin_tree
 from cms.utils import get_language_from_request
 from cms.utils.permissions import (
     get_model_permission_codename,
@@ -43,6 +43,13 @@ def get_render_template(self, context, instance, placeholder):
             return "djangocms_alias/alias_recursive.html"
         return f"djangocms_alias/{instance.template}/alias.html"
 
+    @classmethod
+    def _get_allowed_root_plugins(cls):
+        if not hasattr(cls, "_cached_allowed_root_plugins"):
+            cls._cached_allowed_root_plugins = set(plugin_pool.get_all_plugins(root_plugin=True))
+            print("==>", cls._cached_allowed_root_plugins)
+        return cls._cached_allowed_root_plugins
+
     @classmethod
     def get_extra_plugin_menu_items(cls, request, plugin):
         if plugin.plugin_type == cls.__name__:
@@ -82,15 +89,19 @@ def get_extra_plugin_menu_items(cls, request, plugin):
             "plugin": plugin.pk,
             "language": get_language_from_request(request),
         }
-        endpoint = add_url_parameters(admin_reverse(CREATE_ALIAS_URL_NAME), **data)
-        return [
-            PluginMenuItem(
-                _("Create Alias"),
-                endpoint,
-                action="modal",
-                attributes={"cms-icon": "alias"},
-            ),
-        ]
+        # Check if the plugin can become root: Should be allowed as a root plugin (in the alias)
+        can_become_alias = plugin.get_plugin_class() in cls._get_allowed_root_plugins()
+        if can_become_alias:
+            endpoint = add_url_parameters(admin_reverse(CREATE_ALIAS_URL_NAME), **data)
+            return [
+                PluginMenuItem(
+                    _("Create Alias"),
+                    endpoint,
+                    action="modal",
+                    attributes={"cms-icon": "alias"},
+                ),
+            ]
+        return []
 
     @classmethod
     def get_extra_placeholder_menu_items(cls, request, placeholder):
@@ -150,6 +161,7 @@ def detach_alias_plugin(cls, plugin, language):
         source_plugins = plugin.alias.get_plugins(language, show_draft_content=True)  # We're in edit mode
         target_placeholder = plugin.placeholder
         plugin_position = plugin.position
+        plugin_parent = plugin.parent
         target_placeholder.delete_plugin(plugin)
         if source_plugins:
             if target_last_plugin := target_placeholder.get_last_plugin(plugin.language):
@@ -163,6 +175,7 @@ def detach_alias_plugin(cls, plugin, language):
                 source_plugins,
                 placeholder=target_placeholder,
                 language=language,
+                root_plugin=plugin_parent,
                 start_positions={language: plugin_position},
             )
         return []
@@ -242,10 +255,13 @@ def create_alias_view(self, request):
         emit_content_change([alias_content])
 
         if replace:
-            return self.render_close_frame(
+            plugin = create_form.cleaned_data.get("plugin")
+            placeholder = create_form.cleaned_data.get("placeholder")
+            return self.render_replace_response(
                 request,
-                obj=alias_plugin,
-                action="reload",
+                new_plugins=[alias_plugin],
+                source_placeholder=placeholder,
+                source_plugin=plugin,
             )
         return TemplateResponse(request, "admin/cms/page/close_frame.html")
 
@@ -276,17 +292,54 @@ def detach_alias_plugin_view(self, request, plugin_pk):
         if not can_detach:
             raise PermissionDenied
 
-        self.detach_alias_plugin(
+        copied_plugins = self.detach_alias_plugin(
             plugin=instance,
             language=language,
         )
 
+        return self.render_replace_response(
+            request,
+            new_plugins=copied_plugins,
+            source_plugin=instance,
+        )
+
         return self.render_close_frame(
             request,
             obj=instance,
             action="reload",
         )
 
+    def render_replace_response(self, request, new_plugins, source_placeholder=None, source_plugin=None):
+        move_plugins, add_plugins = [], []
+        for plugin in new_plugins:
+            root = plugin.parent.get_bound_plugin() if plugin.parent else plugin
+
+            plugins = [root] + list(root.get_descendants())
+
+            plugin_order = plugin.placeholder.get_plugin_tree_order(
+                plugin.language,
+                parent_id=plugin.parent_id,
+            )
+            plugin_tree = get_plugin_tree(request, plugins)
+            move_data = get_plugin_toolbar_info(plugin)
+            move_data["plugin_order"] = plugin_order
+            move_data.update(plugin_tree)
+            move_plugins.append(move_data)
+            add_plugins.append({**get_plugin_toolbar_info(plugin), "structure": plugin_tree})
+        data = {
+            "addedPlugins": add_plugins,
+            "movedPlugins": move_plugins,
+            "is_popup": True,
+        }
+        if source_plugin is not None:
+            data["replacedPlugin"] = get_plugin_toolbar_info(source_plugin)
+        if source_placeholder is not None:
+            data["replacedPlaceholder"] = {
+                "placeholder_id": source_placeholder.pk,
+                "deleted": True,
+            }
+        return self.render_close_frame(request, obj=None, action="ALIAS_REPLACE", extra_data=data)
+
     def alias_usage_view(self, request, pk):
         if not request.user.is_staff:
             raise PermissionDenied

djangocms_alias/forms.py

@@ -104,14 +104,23 @@ class CreateAliasForm(BaseCreateAliasForm):
         required=False,
     )
 
-    def __init__(self, *args, **kwargs):
+    def __init__(self, *args, initial=None, **kwargs):
         self.user = kwargs.pop("user")
 
-        super().__init__(*args, **kwargs)
+        super().__init__(*args, initial=initial, **kwargs)
 
+        # Remove the replace option, if user does not have permission to add "Alias"
         if not has_plugin_permission(self.user, "Alias", "add"):
             self.fields["replace"].widget = forms.HiddenInput()
 
+        # Remove the replace option, if "Alias" cannot be a child of parent plugin
+        plugin = initial.get("plugin")
+        if plugin and plugin.parent:
+            plugin_class = plugin.parent.get_plugin_class()
+            allowed_children = plugin_class.get_child_classes(plugin.placeholder.slot, instance=plugin.parent)
+            if allowed_children and "Alias" not in allowed_children:
+                self.fields["replace"].widget = forms.HiddenInput()
+
         self.set_category_widget(self.user)
         self.fields["site"].initial = get_current_site()
 

djangocms_alias/static/djangocms_alias/js/databridge.js

@@ -0,0 +1,53 @@
+(function () {
+
+    function processDataBridge(data) {
+        let actionsPerformed = 0;
+        window.parent.console.log('Processing data bridge:', data);
+        if (data.replacedPlaceholder) {
+            CMS.API.StructureBoard.invalidateState('CLEAR_PLACEHOLDER', data.replacedPlaceholder);
+            actionsPerformed++;
+        }
+        if (data.replacedPlugin) {
+            CMS.API.StructureBoard.invalidateState('DELETE', data.replacedPlugin);
+            actionsPerformed++;
+        }
+        if (data.addedPlugins) {
+            for (const addedPlugin of data.addedPlugins) {
+                CMS.API.StructureBoard.invalidateState('ADD', addedPlugin);
+                actionsPerformed++;
+            }
+        }
+        if (data.movedPlugins) {
+            for (const movedPlugin of data.movedPlugins) {
+                CMS.API.StructureBoard.invalidateState('MOVE', movedPlugin);
+                actionsPerformed++;
+            }
+        }
+        return actionsPerformed;
+    }
+
+    const iframe = window.parent.document.querySelector('.cms-modal-frame > iframe');
+    const CMS = window.parent.CMS;
+
+    // Register the event handler in the capture phase to increase the chance it runs first
+    iframe.addEventListener('load', function (event) {
+        const iframeDocument = iframe.contentDocument || iframe.contentWindow.document;
+        const dataBridge = iframeDocument.body.querySelector('script#data-bridge');
+        if (dataBridge) {
+            window.parent.console.log('iframe loaded', dataBridge);
+            try {
+                data = JSON.parse(dataBridge.textContent);
+                if (data.action === 'ALIAS_REPLACE') {
+                    event.stopPropagation();
+                    dataBridge.parentNode.removeChild(dataBridge);
+                    if (processDataBridge(data)) {
+                    }
+                    iframe.dispatchEvent(new Event('load')); // re-dispatch load event to trigger modal close
+                }
+            } catch (error) {
+                window.parent.console.error('Error parsing data bridge script:', error);
+            }
+            iframeDocument.body.textContent = JSON.stringify(dataBridge);
+        }
+    }, true); // 'true' sets the event to be handled in the capture phase before the modals handler
+})();

djangocms_alias/templates/djangocms_alias/create_alias.html

@@ -1,5 +1,5 @@
 {% extends "admin/change_form.html" %}
-{% load cms_admin cms_static i18n %}
+{% load cms_admin cms_static i18n static %}
 
 {% block content %}
     <h1>{% trans "Create alias" %}</h1>
@@ -31,4 +31,5 @@ <h1>{% trans "Create alias" %}</h1>
             <input type="submit" value="{% trans "Create" %}" class="default" name="create">
         </div>
     </form>
+    <script src="{% static 'djangocms_alias/js/databridge.js' %}"></script>
 {% endblock %}

djangocms_alias/templates/djangocms_alias/detach_alias.html

@@ -1,6 +1,5 @@
 {% extends "admin/delete_confirmation.html" %}
-{% load i18n admin_urls cms_tags %}
-
+{% load i18n admin_urls cms_tags static %}
 {% block breadcrumbs %}{% endblock %}
 
 {% block content %}
@@ -14,7 +13,8 @@
   <input type="hidden" name="post" value="yes" />
   <div class="submit-row">
     <a href="#" class="button cancel-link">{% trans "No, take me back" %}</a>
-    <input type="submit" class="deletelink" value="{% trans "Yes, I'm sure" %}" />
+    <input type="submit" class="deletelink" value="{% translate "Yes, I'm sure" %}" />
   </div>
 </form>
+<script src="{% static 'djangocms_alias/js/databridge.js' %}"></script>
 {% endblock %}