Merge pull request #28 from django-cms/chore/update-readme

fix: Update alias migration for djangocms-alias 2.0.4+

Author: fsbraun

djangocms_4_migration/__init__.py

@@ -1 +1 @@
-__version__ = "0.2.0"
+__version__ = "0.3.0"

djangocms_4_migration/management/commands/cms4_migration.py

@@ -3,22 +3,21 @@
 
 
 class Command(BaseCommand):
-    help = 'django CMS 3.5+ to 4.0 Migration'
+    help = "django CMS 3.5+ to 4.0 Migration"
 
     def handle(self, *args, **options):
-
         # Prepare the DB by cleaning it up before running anything
-        call_command('migration_preparation')
+        call_command("migration_preparation")
 
         # Run standard django migrations
-        call_command('migrate')
+        call_command("migrate")
 
         # Migrate the CMS 3.5 Alias Plugin instances
-        call_command('migrate_alias_plugins')
+        call_command("migrate_alias_plugins")
 
         # Migrate static placeholders
-        call_command('migrate_static_placeholders')
+        call_command("migrate_static_placeholders")
 
         # Clean up after the migration has finished
-        call_command('migration_cleanup')
-        call_command('remove_unlinked_placeholders')
+        call_command("migration_cleanup")
+        call_command("remove_unlinked_placeholders")

djangocms_4_migration/management/commands/migrate_alias_plugins.py

@@ -39,24 +39,29 @@
 
 def _create_site_category(site, language):
     category_name = f"{site.name}-Migrated-{language}"
-    category = Category.objects.language(language).create(
-        name=category_name,
+    category = (
+        Category.objects.language(language)
+        .filter(translations__name=category_name)
+        .first()
     )
-    category.save()
+    if not category:
+        category = Category.objects.language(language).create(
+            name=category_name,
+        )
     return category
 
 
 def create_new_alias_for_source_plugins(old_plugin, new_alias_grouper):
-
     global src_alias_count
 
     try:
-        page_details = PageData.objects.get(page_id=old_plugin.placeholder.source.page.id, language=old_plugin.language)
+        page_details = PageData.objects.get(
+            page_id=old_plugin.placeholder.source.page.id, language=old_plugin.language
+        )
 
         # get published/draft pages for the old Src plugin
         src_plugin_pagecontents = PageContent._base_manager.filter(
-            page_id=page_details.page_id,
-            language=old_plugin.language
+            page_id=page_details.page_id, language=old_plugin.language
         )
 
         for src_plugin_pagecontent in src_plugin_pagecontents:
@@ -65,14 +70,18 @@ def create_new_alias_for_source_plugins(old_plugin, new_alias_grouper):
                 # Get the placeholder with slot name from the published
                 src_plugin_placeholder = Placeholder.objects.get(
                     slot=old_plugin.placeholder.slot,
-                    content_type=ContentType.objects.get(app_label='cms', model='pagecontent'),
-                    object_id=src_plugin_pagecontent.id
+                    content_type=ContentType.objects.get(
+                        app_label="cms", model="pagecontent"
+                    ),
+                    object_id=src_plugin_pagecontent.id,
                 )
 
             except ObjectDoesNotExist:
                 logger.error(
-                    "Error placeholder for the plugin {} Doesn't exist in published pagecontent {}"
-                        .format(old_plugin.id, src_plugin_pagecontent.id))
+                    "Error placeholder for the plugin {} Doesn't exist in published pagecontent {}".format(
+                        old_plugin.id, src_plugin_pagecontent.id
+                    )
+                )
                 return
             # check if the source plugin exists at the same position in the published/draft page
             try:
@@ -84,18 +93,24 @@ def create_new_alias_for_source_plugins(old_plugin, new_alias_grouper):
                 )
             except ObjectDoesNotExist:
                 logger.error(
-                    "Error plugin {} Doesn't exist at the position in placeholder {}"
-                        .format(old_plugin.id, src_plugin_placeholder.id))
+                    "Error plugin {} Doesn't exist at the position in placeholder {}".format(
+                        old_plugin.id, src_plugin_placeholder.id
+                    )
+                )
 
             # Add the count to check total source plugins traversed to migrate to cms4
             src_alias_count += 1
             if src_plugin:
                 # if the plugin of the same plugin type is found in the page and in same placeholder holder
                 # at the same position create the cms4 Alias plugin
-                create_new_alias_plugin(src_plugin, new_alias_grouper, is_src_plugin=True)
+                create_new_alias_plugin(
+                    src_plugin, new_alias_grouper, is_src_plugin=True
+                )
 
     except ObjectDoesNotExist:
-        logger.error("pagedata object doesn;t exist for plugin {}".format(old_plugin.id))
+        logger.error(
+            "pagedata object doesn;t exist for plugin {}".format(old_plugin.id)
+        )
         return
 
 
@@ -118,7 +133,7 @@ def create_new_alias_plugin(old_plugin, new_alias_grouper, is_src_plugin=False):
     # Create a new cms4 alias plugin in place of the old cms 3 plugin
     new_plugin = add_plugin(
         old_plugin.placeholder,
-        'Alias',
+        "Alias",
         language=old_plugin.language,
         alias=new_alias_grouper,
     )
@@ -141,19 +156,25 @@ def create_new_alias_plugin(old_plugin, new_alias_grouper, is_src_plugin=False):
     new_plugin.position = old_plugin_position
     new_plugin.save()
 
-    logger.info("Creating cms4 alias plugin: {}-{} for cms3plugin {}".format(
-        new_plugin.id,
-        new_plugin.plugin_type,
-        old_plugin_id,
-    ))
+    logger.info(
+        "Creating cms4 alias plugin: {}-{} for cms3plugin {}".format(
+            new_plugin.id,
+            new_plugin.plugin_type,
+            old_plugin_id,
+        )
+    )
 
 
 def create_reference_alias_plugins(old_source_plugin, new_alias_grouper):
     """
     Create cms4 Alias plugin for cms3 alias references
     """
-    for old_alias_reference in AliasPluginModel.objects.filter(plugin_id=old_source_plugin):
-        reference_plugin = CMSPlugin.objects.get(id=old_alias_reference.cmsplugin_ptr_id)
+    for old_alias_reference in AliasPluginModel.objects.filter(
+        plugin_id=old_source_plugin
+    ):
+        reference_plugin = CMSPlugin.objects.get(
+            id=old_alias_reference.cmsplugin_ptr_id
+        )
         # Create Alias plugin for the reference plugin at the reference plugin location and delete the reference plugin
         create_new_alias_plugin(reference_plugin, new_alias_grouper)
 
@@ -166,9 +187,7 @@ def get_child_plugins(plugin):
     :param plugin: CMSPlugin Object
     :return: Queryset for Child plugin objects for this plugin
     """
-    child_plugin_queryset = CMSPlugin.objects.filter(
-        parent_id=plugin.id
-    )
+    child_plugin_queryset = CMSPlugin.objects.filter(parent_id=plugin.id)
     return child_plugin_queryset
 
 
@@ -207,9 +226,14 @@ def process_old_alias_sources(site, language, site_plugin_queryset):
 
         if is_versioning_enabled():
             from djangocms_versioning.models import Version
+
             # Create version
-            changed_by = User.objects.get(**{User.USERNAME_FIELD: old_plugin.placeholder.source.changed_by})
-            version = Version.objects.create(content=alias_content, created_by=changed_by)
+            changed_by = User.objects.get(
+                **{User.USERNAME_FIELD: old_plugin.placeholder.source.changed_by}
+            )
+            version = Version.objects.create(
+                content=alias_content, created_by=changed_by
+            )
             version.publish(changed_by)
 
         # create csm4 alias plugins for cms3 alias references
@@ -223,7 +247,9 @@ def _process_sites(plugin_id_list):
 
         sites_placeholders = [
             placeholders.pk
-            for pagecontent in PageContent._base_manager.filter(page__node__site_id=site.id)
+            for pagecontent in PageContent._base_manager.filter(
+                page__node__site_id=site.id
+            )
             for placeholders in pagecontent.get_placeholders()
         ]
         for language in get_language_list(site.id):
@@ -233,9 +259,11 @@ def _process_sites(plugin_id_list):
                 pk__in=plugin_id_list,
                 language=language,
             )
-            logger.info("Processing Language: {} Plugin count: {}".format(
-                language, site_plugin_queryset.count()
-            ))
+            logger.info(
+                "Processing Language: {} Plugin count: {}".format(
+                    language, site_plugin_queryset.count()
+                )
+            )
 
             process_old_alias_sources(site, language, site_plugin_queryset)
 
@@ -248,43 +276,49 @@ class Command(BaseCommand):
     Terms: Alias Reference, Alias Source
     """
 
-    help = 'Run after migrations are applied'
+    help = "Run after migrations are applied"
 
     def handle(self, *args, **options):
         with transaction.atomic():
             # Alias source plugin list
-            plugin_id_list = list(AliasPluginModel.objects.values_list('plugin_id', flat=True).order_by('plugin_id'))
+            plugin_id_list = list(
+                AliasPluginModel.objects.values_list("plugin_id", flat=True).order_by(
+                    "plugin_id"
+                )
+            )
             alias_source_total = len(plugin_id_list)
             # Alias references list count
             alias_reference_total = AliasPluginModel.objects.count()
             old_stats = {
-                'old_alias_source_count': alias_source_total,
+                "old_alias_source_count": alias_source_total,
                 # 'old_alias_reference_count': alias_reference_total,
-                'old_alias_target_count': alias_reference_total + alias_source_total,
-                'src_alias_count': alias_source_total,
-                'reference_alias_count': alias_reference_total,
+                "old_alias_target_count": alias_reference_total + alias_source_total,
+                "src_alias_count": alias_source_total,
+                "reference_alias_count": alias_reference_total,
             }
             new_stats = {
                 # AliasModel list count should match old_alias_source_count
-                'new_alias_source_count': 0,
+                "new_alias_source_count": 0,
                 # CMS4AliasPluginModel list count should match old_alias_target_count
-                'new_alias_plugin_target_count': 0,
-                'src_alias_count': 0,
-                'reference_alias_count': 0,
-                'new_src_alias_plugins_count': 0,
-                'new_ref_alias_plugins_count': 0,
+                "new_alias_plugin_target_count": 0,
+                "src_alias_count": 0,
+                "reference_alias_count": 0,
+                "new_src_alias_plugins_count": 0,
+                "new_ref_alias_plugins_count": 0,
             }
             # Do the work
             _process_sites(plugin_id_list)
             # Finalise stats
-            new_stats['new_alias_source_count'] = AliasContent.objects.count()
+            new_stats["new_alias_source_count"] = AliasContent.objects.count()
             # CMS4 Alias Plugin count is compared with all source and reference plugins because
             # in the CMS 3 implementation the source is a plugin that is then references to.
             # In CMS 4 the source is the Alias instance not a plugin on a page.
-            new_stats['new_alias_plugin_target_count'] = CMS4AliasPluginModel.objects.count()
-            new_stats['src_alias_count'] = src_alias_count
-            new_stats['reference_alias_count'] = reference_alias_count
-            new_stats['new_ref_alias_plugins_count'] = new_ref_alias_plugins_count
-            new_stats['new_src_alias_plugins_count'] = new_src_alias_plugins_count
-            logger.info('old stats: {}'.format(old_stats))
-            logger.info('new stats: {}'.format(new_stats))
+            new_stats["new_alias_plugin_target_count"] = (
+                CMS4AliasPluginModel.objects.count()
+            )
+            new_stats["src_alias_count"] = src_alias_count
+            new_stats["reference_alias_count"] = reference_alias_count
+            new_stats["new_ref_alias_plugins_count"] = new_ref_alias_plugins_count
+            new_stats["new_src_alias_plugins_count"] = new_src_alias_plugins_count
+            logger.info("old stats: {}".format(old_stats))
+            logger.info("new stats: {}".format(new_stats))