504 copy paste plugins inside ckeditor refer to same instance (#572)

* Ran isort on models.py

* Fixed copying referenced plugins removing other child plugin references

* Added test case for copy_referenced_plugins method

Author: nichoski

djangocms_text_ckeditor/models.py

@@ -85,20 +85,25 @@ def clean_plugins(self):
     def copy_referenced_plugins(self):
         referenced_plugins = self.get_referenced_plugins()
         if referenced_plugins:
-            plugins_ziplist = copy_plugins_to(
+            plugins_pairs = list(copy_plugins_to(
                 referenced_plugins,
                 self.placeholder,
                 to_language=self.language,
                 parent_plugin_id=self.id
-            )
-            self.post_copy(self, plugins_ziplist)
+            ))
+            self.add_existing_child_plugins_to_pairs(plugins_pairs)
+            self.post_copy(self, plugins_pairs)
 
     def get_referenced_plugins(self):
         ids_in_body = set(plugin_tags_to_id_list(self.body))
         child_plugins_ids = set(self.cmsplugin_set.all().values_list('id', flat=True))
         referenced_plugins_ids = ids_in_body - child_plugins_ids
         return CMSPlugin.objects.filter(id__in=referenced_plugins_ids)
 
+    def add_existing_child_plugins_to_pairs(self, plugins_pairs):
+        for plugin in self.cmsplugin_set.all():
+            plugins_pairs.append((plugin, plugin))
+
     def _get_inline_plugin_ids(self):
         return plugin_tags_to_id_list(self.body)
 

tests/test_plugin.py

@@ -223,6 +223,74 @@ def test_add_and_cancel_plugin(self):
             response = text_plugin_class.delete_on_cancel(request)
             self.assertEqual(response.status_code, 400)
 
+    def test_copy_referenced_plugins(self):
+        """
+        Test that copy+pasting a child plugin between text editors
+        creates proper copies of the child plugin and messes no other data up
+        """
+        simple_page = create_page('test page', 'page.html', u'en')
+        simple_placeholder = get_page_placeholders(simple_page, 'en').get(slot='content')
+
+        def _get_text_plugin_with_children():
+            text_plugin = add_plugin(
+                simple_placeholder,
+                'TextPlugin',
+                'en',
+                body='Text plugin we copy child plugins to'
+            )
+            _add_child_plugins_to_text_plugin(text_plugin)
+            return text_plugin
+
+        def _add_child_plugins_to_text_plugin(text_plugin):
+            child_plugin_1 = add_plugin(
+                simple_placeholder,
+                'PicturePlugin',
+                'en',
+                target=text_plugin,
+                picture=self.create_filer_image_object(),
+                caption_text='Child plugin one',
+            )
+            child_plugin_2 = add_plugin(
+                simple_placeholder,
+                'PicturePlugin',
+                'en',
+                target=text_plugin,
+                picture=self.create_filer_image_object(),
+                caption_text='Child plugin two',
+            )
+            self.add_plugin_to_text(text_plugin, child_plugin_1)
+            self.add_plugin_to_text(text_plugin, child_plugin_2)
+
+        def _copy_child_plugins_from_text(text_plugin_source, text_plugin_destination):
+            for child_plugin in text_plugin_source.cmsplugin_set.all():
+                text_plugin_destination.body += ' ' + plugin_to_tag(child_plugin)
+            text_plugin_destination.save()
+            _run_clean_and_copy(text_plugin_destination)
+
+        def _run_clean_and_copy(text_plugin):
+            text_plugin.clean_plugins()
+            text_plugin.copy_referenced_plugins()
+
+        def _get_common_children_ids(text_plugin_one, text_plugin_two):
+            original_children_ids = set(plugin_tags_to_id_list(text_plugin_one.body))
+            copied_children_ids = set(plugin_tags_to_id_list(text_plugin_two.body))
+            return original_children_ids.intersection(copied_children_ids)
+
+        text_plugin_copy_from = _get_text_plugin_with_children()
+        text_plugin_copy_to = _get_text_plugin_with_children()
+
+        _copy_child_plugins_from_text(text_plugin_copy_from, text_plugin_copy_to)
+        self.assertEqual(text_plugin_copy_from.cmsplugin_set.count(), 2)
+        self.assertEqual(text_plugin_copy_to.cmsplugin_set.count(), 4)
+
+        _run_clean_and_copy(text_plugin_copy_from)
+        _run_clean_and_copy(text_plugin_copy_to)
+        self.assertEqual(text_plugin_copy_from.cmsplugin_set.count(), 2)
+        self.assertEqual(text_plugin_copy_to.cmsplugin_set.count(), 4)
+
+        common_children_ids = _get_common_children_ids(text_plugin_copy_from, text_plugin_copy_to)
+        self.assertFalse(common_children_ids)
+
     def test_add_and_cancel_child_plugin(self):
         """
         Test that you can add a text plugin