feat: django-cms 5.0 compatibility & restored import callback invocation (#46)

Author: florianschieder

.github/workflows/test.yml

@@ -10,9 +10,14 @@ jobs:
       matrix:
         python-version: [ "3.9", "3.10", "3.11", "3.12", "3.13"]
         requirements-file: [
+          dj42_cms41.txt,
           dj50_cms41.txt,
           dj51_cms41.txt,
-          dj42_cms41.txt,
+          dj52_cms41.txt,
+          dj42_cms50.txt,
+          dj50_cms50.txt,
+          dj51_cms50.txt,
+          dj52_cms50.txt,
         ]
         os: [
           ubuntu-latest,
@@ -22,6 +27,14 @@ jobs:
             python-version: 3.9
           - requirements-file: dj51_cms41.txt
             python-version: 3.9
+          - requirements-file: dj52_cms41.txt
+            python-version: 3.9
+          - requirements-file: dj50_cms50.txt
+            python-version: 3.9
+          - requirements-file: dj51_cms50.txt
+            python-version: 3.9
+          - requirements-file: dj52_cms50.txt
+            python-version: 3.9
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}

README.rst

@@ -91,14 +91,23 @@ different systems while setting the contents as you need it::
             })
         return plugin_data
 
-    def import_function(deserialized_object):
-        some_related_object = MyModel.objects.first()
-        for field in deserialized_object.object._meta.fields:
+    def import_function(plugin, plugin_data):
+        some_related_fallback_object = MyModel.objects.first()
+        for field in plugin._meta.fields:
             # example of setting a default value for a related field
             if isinstance(field, ForeignKey):
-                value = getattr(deserialized_object.object, field.attname)
-                if field.related_model == MyModel and value is not None:
-                    setattr(deserialized_object.object, field.name, some_related_object)
+                plugin_value = getattr(plugin, field.attname)
+                raw_value = plugin_data[field.name]
+                if (
+                    field.related_model == MyModel
+                    # related object is referenced, but does not exist
+                    and plugin_value is None and raw_value is not None
+                ):
+                    setattr(plugin, field.name, some_related_fallback_object)
+        # There is no guarantee on whether djangocms-transfer saves the
+        # plugin. It is recommended to do this yourself in case you changed
+        # the plugin.
+        plugin.save()
 
 
 Running Tests

djangocms_transfer/cms_plugins.py

@@ -160,11 +160,11 @@ def import_plugins_view(cls, request):
                 request, obj=new_plugins[0]
             )
 
-        from cms.toolbar.utils import get_plugin_tree_as_json
+        from cms.toolbar.utils import get_plugin_tree
 
         # Placeholder plugins import
         new_plugins = placeholder.get_plugins(language).exclude(pk__in=tree_order)
-        data = json.loads(get_plugin_tree_as_json(request, list(new_plugins)))
+        data = get_plugin_tree(request, list(new_plugins))
         data["plugin_order"] = tree_order + ["__COPY__"]
         data["target_placeholder_id"] = placeholder.pk
         context = {"structure_data": json.dumps(data)}

djangocms_transfer/datastructures.py

@@ -1,4 +1,6 @@
+import importlib
 from collections import namedtuple
+from typing import Callable
 
 from cms.api import add_plugin
 from cms.models import CMSPlugin
@@ -66,6 +68,7 @@ def restore(self, placeholder, language, parent=None):
             target=parent,
             **data,
         )
+        self._call_user_site_import_processor_if_necessary(plugin, self.data)
 
         field = ("target",) if plugin_target else ()
         # An empty *update_fields* iterable will skip the save
@@ -91,3 +94,23 @@ def restore(self, placeholder, language, parent=None):
 
         plugin.save()
         return plugin
+
+    def _call_user_site_import_processor_if_necessary(
+        self, plugin: CMSPlugin, plugin_data: dict
+    ):
+        # customize plugin-data on import with configured function
+        if processor_symbol := getattr(
+            settings, "DJANGOCMS_TRANSFER_PROCESS_IMPORT_PLUGIN_DATA", None
+        ):
+            function = self._resolve_function_from_full_path(processor_symbol)
+            function(plugin, plugin_data)
+
+    def _resolve_function_from_full_path(
+        self, fully_qualified_path: str
+    ) -> Callable:
+        try:
+            module_name, function_name = fully_qualified_path.rsplit(".", 1)
+            module = importlib.import_module(module_name)
+            return getattr(module, function_name)
+        except (AttributeError, ImportError):
+            raise ImportError(f"could not resolve {fully_qualified_path}")

djangocms_transfer/forms.py

@@ -133,7 +133,10 @@ def run_export(self):
 
 
 class PluginImportForm(ExportImportForm):
-    import_file = forms.FileField(required=True)
+    import_file = forms.FileField(
+        required=True,
+        widget=forms.FileInput(attrs={"accept": "application/json"}),
+    )
 
     def clean(self):
         if self.errors:

pyproject.toml

@@ -36,6 +36,7 @@ classifiers = [
     "Framework :: Django :: 5.1",
     "Framework :: Django CMS",
     "Framework :: Django CMS :: 4.1",
+    "Framework :: Django CMS :: 5.0",
     "Topic :: Internet :: WWW/HTTP",
     "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
     "Topic :: Software Development",

tests/requirements/dj42_cms50.txt

@@ -0,0 +1,4 @@
+-r base.txt
+
+Django>=4.2,<5.0
+django-cms>=5.0,<5.1

tests/requirements/dj50_cms50.txt

@@ -0,0 +1,4 @@
+-r base.txt
+
+Django>=5.0,<5.1
+django-cms>=5.0,<5.1

tests/requirements/dj51_cms50.txt

@@ -0,0 +1,4 @@
+-r base.txt
+
+Django>=5.1,<5.2
+django-cms>=5.0,<5.1

tests/requirements/dj52_cms41.txt

@@ -0,0 +1,4 @@
+-r base.txt
+
+Django>=5.2,<5.3
+django-cms>=4.1,<4.2