chore: Clean up get_extra_menu_items methods & Test for djangocms-transfer's PluginImporter (#50)

Co-authored-by: Fabian Braun <fsbraun@gmx.de>

Author: mrbazzan

djangocms_transfer/cms_plugins.py

@@ -13,6 +13,18 @@
 
 from .forms import ExportImportForm, PluginExportForm, PluginImportForm
 
+try:
+    from cms.toolbar.utils import get_plugin_tree
+except ImportError:
+    # django CMS 4.1 still uses the legacy data bridge
+    # This method serves as a compatibility shim
+    from cms.toolbar.utils import get_plugin_tree_as_json
+
+    def get_plugin_tree(request, plugins):
+        json_str = get_plugin_tree_as_json(request, plugins)
+        return json.loads(json_str)
+
+
 
 class PluginImporter(CMSPluginBase):
     system = True
@@ -33,21 +45,12 @@ def get_plugin_urls(self):
         ]
         return urlpatterns
 
-    def get_extra_global_plugin_menu_items(self, request, plugin):
-        # django-cms 3.4 compatibility
-        return self.get_extra_plugin_menu_items(request, plugin)
-
-    @classmethod
-    def get_extra_plugin_menu_items(cls, request, plugin):
-        if plugin.plugin_type == cls.__name__:
-            return
-
-        data = urlencode(
-            {
-                "language": get_language_from_request(request),
-                "plugin": plugin.pk,
-            }
-        )
+    @staticmethod
+    def _get_extra_menu_items(query_params, request):
+        data = urlencode({
+            "language": get_language_from_request(request),
+            **query_params
+        })
         return [
             PluginMenuItem(
                 _("Export plugins"),
@@ -69,34 +72,18 @@ def get_extra_plugin_menu_items(cls, request, plugin):
             ),
         ]
 
+    @classmethod
+    def get_extra_plugin_menu_items(cls, request, plugin):
+        if plugin.plugin_type == cls.__name__:
+            return
+
+        data = {"plugin": plugin.pk}
+        return cls._get_extra_menu_items(data, request)
+
     @classmethod
     def get_extra_placeholder_menu_items(cls, request, placeholder):  # noqa
-        data = urlencode(
-            {
-                "language": get_language_from_request(request),
-                "placeholder": placeholder.pk,
-            }
-        )
-        return [
-            PluginMenuItem(
-                _("Export plugins"),
-                admin_reverse("cms_export_plugins") + "?" + data,
-                data={},
-                action="none",
-                attributes={
-                    "icon": "export",
-                },
-            ),
-            PluginMenuItem(
-                _("Import plugins"),
-                admin_reverse("cms_import_plugins") + "?" + data,
-                data={},
-                action="modal",
-                attributes={
-                    "icon": "import",
-                },
-            ),
-        ]
+        data = {"placeholder": placeholder.pk}
+        return cls._get_extra_menu_items(data, request)
 
     @classmethod
     def import_plugins_view(cls, request):
@@ -160,8 +147,6 @@ def import_plugins_view(cls, request):
                 request, obj=new_plugins[0]
             )
 
-        from cms.toolbar.utils import get_plugin_tree
-
         # Placeholder plugins import
         new_plugins = placeholder.get_plugins(language).exclude(pk__in=tree_order)
         data = get_plugin_tree(request, list(new_plugins))

djangocms_transfer/forms.py

@@ -84,11 +84,9 @@ def clean(self):
             )
             raise forms.ValidationError(message)
 
+        plugin_is_bound = False
         if plugin:
-            plugin_model = plugin.get_plugin_class().model
-            plugin_is_bound = plugin_model.objects.filter(cmsplugin_ptr=plugin).exists()
-        else:
-            plugin_is_bound = False
+            plugin_is_bound = plugin.get_bound_plugin()
 
         if plugin and not plugin_is_bound:
             raise ValidationError("Plugin is unbound.")

setup.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python
 from setuptools import setup
 
-
 setup()

tests/transfer/abstract.py tests/abstract.pytests/transfer/abstract.py renamed to tests/abstract.py

@@ -10,7 +10,7 @@ class FunctionalityBaseTestCase(CMSTestCase):
 
     def setUp(self):
         self.page = self._create_page()
-        self.page_content = self.page.pagecontent_set(manager="admin_manager").first()
+        self.page_content = self.page.pagecontent_set(manager="admin_manager").filter(language="en").first()
         self.page.set_as_homepage()
 
     def _create_plugin(self, plugin_type="TextPlugin", parent=None, **kwargs):
@@ -40,11 +40,7 @@ def _add_plugin_to_page(self, plugin_publisher, *args, page=None, **kwargs):
         if page is None:
             page = self.page
         return add_plugin(
-            page.pagecontent_set(manager="admin_manager")
-            .filter(language="en")
-            .first()
-            .get_placeholders()
-            .get(slot="content"),
+            self.page_content.get_placeholders().get(slot="content"),
             plugin_publisher,
             "en",
             *args,

tests/settings.py

@@ -24,6 +24,7 @@
     "django.contrib.sessions.middleware.SessionMiddleware",
     "django.contrib.auth.middleware.AuthenticationMiddleware",
     "django.contrib.messages.middleware.MessageMiddleware",
+    "cms.middleware.toolbar.ToolbarMiddleware"
 ]
 
 TEMPLATES = [
@@ -74,4 +75,6 @@
 
 LANGUAGE_CODE = "en"
 
+ROOT_URLCONF = "tests.urls"
+
 DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"

tests/transfer/test_export.py tests/test_export.pytests/transfer/test_export.py renamed to tests/test_export.py

@@ -0,0 +1,238 @@
+import json
+
+from cms.plugin_pool import plugin_pool
+from cms.utils.urlutils import admin_reverse
+from django.core.exceptions import PermissionDenied
+from django.core.files.uploadedfile import SimpleUploadedFile
+
+from .abstract import FunctionalityBaseTestCase
+
+
+class PluginImporterTestCase(FunctionalityBaseTestCase):
+    def setUp(self):
+        super().setUp()
+        self.user = self._create_user("test", True, True)
+        self.plugin_importer = next(
+            (
+                plugin
+                for plugin in plugin_pool.get_all_plugins()
+                if plugin.__name__ == "PluginImporter"
+            ),
+            None
+        )
+
+    def test_get_plugin_urls(self):
+        urlpatterns = self.plugin_importer().get_plugin_urls()
+        self.assertEqual(len(urlpatterns), 2)
+        self.assertEqual(urlpatterns[0].name, "cms_export_plugins")
+        self.assertEqual(urlpatterns[1].name, "cms_import_plugins")
+
+    def test_get_extra_menu_items(self):
+        request = self.get_request()
+
+        with self.subTest("extra plugin menu items"):
+            text_plugin = self._create_plugin()
+            pluginimporter_plugin = self._add_plugin_to_page("PluginImporter")
+            menu_items = self.plugin_importer.get_extra_plugin_menu_items(request, text_plugin)
+            self.assertEqual(len(menu_items), 2)
+            self.assertEqual(menu_items[0].name, "Export plugins")
+            self.assertEqual(menu_items[1].name, "Import plugins")
+            self.assertEqual(
+                menu_items[0].url,
+                "/en/admin/cms/page/plugin/plugin_importer/export-plugins/?language=en&plugin=1"
+            )
+            self.assertEqual(
+                menu_items[1].url,
+                "/en/admin/cms/page/plugin/plugin_importer/import-plugins/?language=en&plugin=1"
+            )
+            # no menu item for PluginImporter itself
+            self.assertIsNone(self.plugin_importer.get_extra_plugin_menu_items(request, pluginimporter_plugin))
+
+        with self.subTest("extra placeholder menu items"):
+            placeholder = self.page_content.get_placeholders().get(slot="content")
+            menu_items = self.plugin_importer.get_extra_placeholder_menu_items(request, placeholder)
+            self.assertEqual(
+                menu_items[0].url,
+                "/en/admin/cms/page/plugin/plugin_importer/export-plugins/?language=en&placeholder=1"
+            )
+            self.assertEqual(
+                menu_items[1].url,
+                "/en/admin/cms/page/plugin/plugin_importer/import-plugins/?language=en&placeholder=1"
+            )
+
+    def test_import_plugin_views(self):
+        with self.login_user_context(self.user):
+            response = self.client.get(admin_reverse("cms_import_plugins"))
+            self.assertEqual(response.content, b"Form received unexpected values.")
+
+        del self.user # self.get_request() checks for "user" attribute
+        self.assertRaises(
+            PermissionDenied,
+            self.plugin_importer.import_plugins_view,
+            self.get_request()
+        )
+
+    def test_import_plugin_views_for_page(self):
+        with self.login_user_context(self.user):
+            # GET page import
+            response = self.client.get(
+                admin_reverse("cms_import_plugins") + f"?language=en&cms_pagecontent={self.page_content.id}"
+            )
+            self.assertEqual(response.templates[0].name, "djangocms_transfer/import_plugins.html")
+            self.assertEqual(response.context["form"].initial["cms_pagecontent"], self.page_content)
+
+            # POST page import
+            post_data = {
+                "language": "en", "cms_pagecontent": [self.page_content.id],
+                "import_file": SimpleUploadedFile("file.txt", bytes(json.dumps(self._get_expected_page_export_data()), "utf-8"))
+            }
+            response = self.client.post(
+                admin_reverse("cms_import_plugins") + f"?language=en&cms_pagecontent={self.page_content.id}",
+                post_data
+            )
+            self.assertIn(b'<div class="success"></div>', response.content)
+
+    def test_import_plugin_views_for_placeholder(self):
+        placeholder = self.page_content.get_placeholders().get(slot="content")
+        with self.login_user_context(self.user):
+            # GET placeholder import
+            response = self.client.get(
+                admin_reverse("cms_import_plugins") + f"?language=en&placeholder={placeholder.id}"
+            )
+            self.assertEqual(response.templates[0].name, "djangocms_transfer/import_plugins.html")
+            self.assertEqual(response.context["form"].initial["placeholder"], placeholder)
+
+            # empty placeholder import (no existing plugin)
+            request_path = admin_reverse("cms_import_plugins") + f"?language=en&placeholder={placeholder.id}"
+            post_data = {
+                "language": "en", "placeholder": [placeholder.id],
+                "import_file": SimpleUploadedFile("file.txt", b"[null, null]")
+            }
+            with self.assertRaises(IndexError):
+                self.client.post(path=request_path, data=post_data)
+
+            # create plugins in the placeholder
+            text_plugin = self._create_plugin()
+            self._add_plugin_to_page("PluginImporter")
+            self._create_plugin(plugin_type="LinkPlugin", parent=text_plugin)
+
+            # empty placeholder import
+            request_path = admin_reverse("cms_import_plugins") + f"?language=en&placeholder={placeholder.id}"
+            post_data = {
+                "language": "en", "placeholder": [placeholder.id],
+                "import_file": SimpleUploadedFile("file.txt", b"[null, null]")
+            }
+            response = self.client.post(path=request_path, data=post_data)
+            self.assertIn(b'<div class="success"></div>', response.content)
+            self.assertEqual(response.context[2].template_name, "djangocms_transfer/placeholder_close_frame.html")
+
+            structure_data = json.loads(response.context["structure_data"])
+            # Since the import file is empty, only child plugins gets
+            # passed to the frontend data bridge
+            self.assertEqual(len(structure_data["plugins"]), 1)
+
+            # POST placeholder import: simple data
+            post_data["import_file"] = SimpleUploadedFile(
+                "file.txt",
+                bytes(json.dumps(self._get_expected_placeholder_export_data()), "utf-8")
+            )
+            response = self.client.post(path=request_path, data=post_data)
+            self.assertIn(b'<div class="success"></div>', response.content)
+
+            structure_data = json.loads(response.context["structure_data"])
+            # newly imported plugin and child plugin gets passed to the frontend data bridge
+            self.assertEqual(len(structure_data["plugins"]), 2)
+
+    def test_import_plugin_views_for_plugin(self):
+        # create plugins
+        text_plugin = self._create_plugin()
+        pluginimporter_plugin = self._create_plugin("PluginImporter")
+        self._create_plugin(plugin_type="LinkPlugin", parent=text_plugin)
+
+        with self.login_user_context(self.user):
+            # GET plugin import
+            response = self.client.get(
+                admin_reverse("cms_import_plugins") + f"?language=en&plugin={text_plugin.pk}"
+            )
+            self.assertEqual(response.templates[0].name, "djangocms_transfer/import_plugins.html")
+            self.assertEqual(response.context["form"].initial["plugin"], text_plugin.cmsplugin_ptr)
+
+            # empty POST plugin import
+            request_path = admin_reverse("cms_import_plugins") + f"?language=en&plugin={text_plugin.pk}"
+            post_data = {
+                "language": "en", "plugin": [text_plugin.id],
+                "import_file": SimpleUploadedFile("file.txt", b"[null, null]")
+            }
+            with self.assertRaises(IndexError):
+                self.client.post(path=request_path, data=post_data)
+
+            # plugin import on TextPlugin
+            post_data["import_file"] = SimpleUploadedFile(
+                "file.txt",
+                bytes(json.dumps(self._get_expected_placeholder_export_data()), "utf-8")
+            )
+            response = self.client.post(path=request_path, data=post_data)
+            self.assertIn(b'<div class="success"></div>', response.content)
+
+            # plugin import on PluginImporterPlugin
+            request_path = admin_reverse("cms_import_plugins") + f"?language=en&plugin={pluginimporter_plugin.pk}"
+            post_data = {"language": "en", "plugin": [pluginimporter_plugin.id]}
+            post_data["import_file"] = SimpleUploadedFile(
+                "file.txt",
+                bytes(json.dumps(self._get_expected_placeholder_export_data()), "utf-8")
+            )
+            response = self.client.post(path=request_path, data=post_data)
+            self.assertIn(b'<div class="success"></div>', response.content)
+
+    def test_export_plugin_views(self):
+        with self.login_user_context(self.user):
+            response = self.client.get(admin_reverse("cms_export_plugins"))
+            self.assertEqual(response.content, b"Form received unexpected values.")
+
+        del self.user # self.get_request() checks for "user" attribute
+        self.assertRaises(
+            PermissionDenied,
+            self.plugin_importer.export_plugins_view,
+            self.get_request()
+        )
+
+    def test_export_plugin_views_for_plugin(self):
+        # create plugins
+        text_plugin = self._create_plugin()
+        self._create_plugin(plugin_type="LinkPlugin", parent=text_plugin)
+
+        with self.login_user_context(self.user):
+            response = self.client.get(
+                admin_reverse("cms_export_plugins") + f"?language=en&plugin={text_plugin.pk}"
+            )
+            self.assertEqual(response.status_code, 200)
+            exported_data = json.loads(response.content)
+            # exported content should be TextPlugin and its child (LinkPlugin).
+            self.assertEqual(len(exported_data), 2)
+            self.assertEqual(list(map(lambda i: i["plugin_type"], exported_data)), ["TextPlugin", "LinkPlugin"])
+
+    def test_export_plugin_views_for_placeholder(self):
+        placeholder = self.page_content.get_placeholders().get(slot="content")
+        # create plugins in the placeholder
+        text_plugin = self._create_plugin()
+        self._add_plugin_to_page("PluginImporter")
+        self._create_plugin(plugin_type="LinkPlugin", parent=text_plugin)
+
+        with self.login_user_context(self.user):
+            response = self.client.get(
+                admin_reverse("cms_export_plugins") + f"?language=en&placeholder={placeholder.pk}"
+            )
+            self.assertEqual(response.status_code, 200)
+            exported_data = json.loads(response.content)
+            self.assertEqual(len(exported_data), 3)
+            self.assertEqual(list(map(lambda i: i["plugin_type"], exported_data)), ["TextPlugin", "LinkPlugin", "PluginImporter"])
+
+    def test_export_plugin_views_for_page(self):
+        with self.login_user_context(self.user):
+            response = self.client.get(
+                admin_reverse("cms_export_plugins") + f"?language=en&cms_pagecontent={self.page_content.pk}"
+            )
+            self.assertEqual(response.status_code, 200)
+            exported_data = json.loads(response.content)
+            self.assertEqual(exported_data[0]["placeholder"], "content")
+            self.assertEqual(len(exported_data[0]["plugins"]), 0)