Develop to master - prep for 2.1.0

.gitignore

@@ -1,6 +1,8 @@
 .idea/
 *.pyc
+__pycache__
 .vscode/*
 **/.mypy_cache
+build/
 dist/
 *.egg-info/

README.md

@@ -9,7 +9,7 @@ Content:
 
 ## 1. Requirements
 
-- Wagtail > 2.0 and WagtailMedia
+- Wagtail >= 2.12 and WagtailMedia
 - Django > 2.2
 - Celery
 - RestFramework

setup.py

@@ -80,7 +80,7 @@ def package_data_with_recursive_dirs(package_data_spec):
     keywords="ION Wagtail API Adapter",
     install_requires=[
         "django>=2.2",
-        "wagtail>2.0",
+        "wagtail>=2.12",
         "celery[redis]>=4.3",
         "djangorestframework>=3.9",
         "beautifulsoup4>=4.6",

wagtail_to_ion/admin.py

@@ -4,13 +4,30 @@
 from wagtail_to_ion.models import get_ion_media_rendition_model
 
 
-class AbstractIonImageAdmin(admin.ModelAdmin):
+class ProtectInUseModelAdmin(admin.ModelAdmin):
+    protect_objects_in_use: bool = True
+
+    def get_deleted_objects(self, objs, request):
+        if self.protect_objects_in_use:
+            protected = []
+
+            for obj in objs:
+                usage = obj.get_usage()
+                if usage:
+                    protected += list(usage)
+            if protected:
+                return [], {}, set(), protected
+
+        return super().get_deleted_objects(objs, request)
+
+
+class AbstractIonImageAdmin(ProtectInUseModelAdmin):
     list_display = ('title', 'collection', 'include_in_archive')
     list_filter = ('collection', 'include_in_archive')
     search_fields = ('title',)
 
 
-class AbstractIonDocumentAdmin(admin.ModelAdmin):
+class AbstractIonDocumentAdmin(ProtectInUseModelAdmin):
     list_display = ('title', 'collection', 'include_in_archive')
     list_filter = ('collection', 'include_in_archive')
     search_fields = ('title',)
@@ -21,7 +38,7 @@ class IonMediaRenditionInlineAdmin(admin.TabularInline):
     extra = 0
 
 
-class AbstractIonMediaAdmin(admin.ModelAdmin):
+class AbstractIonMediaAdmin(ProtectInUseModelAdmin):
     list_display = ('title', 'collection', 'include_in_archive')
     list_filter = ('collection', 'include_in_archive')
     search_fields = ('title',)

wagtail_to_ion/blocks.py

@@ -0,0 +1,17 @@
+from django.utils.functional import cached_property
+from wagtailmedia.blocks import AbstractMediaChooserBlock
+
+
+class IonMediaBlock(AbstractMediaChooserBlock):
+    @cached_property
+    def target_model(self):
+        from wagtailmedia.models import get_media_model
+        return get_media_model()
+
+    @cached_property
+    def widget(self):
+        from wagtailmedia.widgets import AdminMediaChooser
+        return AdminMediaChooser
+
+    def render_basic(self, value, context=None):
+        raise NotImplementedError('You need to implement %s.render_basic' % self.__class__.__name__)

wagtail_to_ion/conf.py

@@ -19,3 +19,9 @@
     False
 
 )
+
+settings.ION_ARCHIVE_BUILD_URL_FUNCTION = getattr(
+    settings,
+    'ION_ARCHIVE_BUILD_URL_FUNCTION',
+    None
+)

wagtail_to_ion/models/abstract.py

@@ -1,76 +1,109 @@
-# Copyright © 2017 anfema GmbH. All rights reserved.
-from typing import Optional
-
-from django.conf import settings
-from django.utils.text import slugify
-
-from wagtail.core.models import Page, Site
-
-
-class AbstractIonPage(Page):
-
-    @classmethod
-    def ion_metadata(cls):
-        """
-        Returns additional metadata for the page.
-
-        See `DynamicPageSerializer.get_meta()`
-        """
-        return ()
-
-    @classmethod
-    def ion_extra_fields(cls):
-        """
-        Add extra fields (not part of `content_panels`) for serialization with ION.
-
-        Returns an iterable of tuples containing two strings:
-            - the outlet name
-            - the path to the extra field
-
-        Example: to add the value of `self.some_related_model.some_field` use:
-            return (
-                ('outlet_name', 'some_related_model.some_field'),
-            )
-        """
-        return ()
-
-    @classmethod
-    def get_layout_name(cls, api_version: Optional[int] = None):  # TODO: rename to `get_ion_layout_name`?
-        return cls.__name__.lower()  # TODO: use `cls._meta.model_name`?
-
-    #
-    # wagtail attributes/methods
-    #
-
-    # ion pages have no preview currently; clear wagtail preview modes
-    preview_modes = ()
-
-    # ion pages have no public url (disables wagtail "live view" buttons too)
-    def get_url_parts(self, request=None):
-        site = Site.find_for_request(request)
-        return site, None, None  # return only the site to silence the "no site configured" warning
-
-    #
-    # django model setup
-    #
-
-    class Meta:
-        abstract = True
-
-    def __str__(self):
-        return self.title
-
-    def save(self, *args, **kwargs):
-        if self.slug.startswith('to-be-filled'):
-            self.slug = slugify(self.title)
-        super().save(*args, **kwargs)
-
-
-class AbstractIonCollection(AbstractIonPage):
-    ion_api_object_name = 'collection'
-
-    parent_page_types = ['wagtailcore.Page']
-    subpage_types = [settings.ION_LANGUAGE_MODEL]
-
-    class Meta:
-        abstract = True
+# Copyright © 2017 anfema GmbH. All rights reserved.
+from typing import Optional
+from uuid import uuid4
+
+from django.conf import settings
+from django.utils.text import slugify
+
+from wagtail.core.models import Page, Site
+
+
+class AbstractIonPage(Page):
+    ion_generate_page_title = True
+
+    @classmethod
+    def generate_page_title(cls):
+        """Generate ION specific page title"""
+        return '{class_name}{uuid}'.format(class_name=cls.__name__, uuid=uuid4())
+
+    @classmethod
+    def ion_metadata(cls):
+        """
+        Returns additional metadata for the page.
+
+        See `DynamicPageSerializer.get_meta()`
+        """
+        return ()
+
+    @classmethod
+    def ion_extra_fields(cls):
+        """
+        Add extra fields (not part of `content_panels`) for serialization with ION.
+
+        Returns an iterable of tuples containing two strings:
+            - the outlet name
+            - the path to the extra field
+
+        Example: to add the value of `self.some_related_model.some_field` use:
+            return (
+                ('outlet_name', 'some_related_model.some_field'),
+            )
+        """
+        return ()
+
+    @classmethod
+    def get_layout_name(cls, api_version: Optional[int] = None):  # TODO: rename to `get_ion_layout_name`?
+        return cls.__name__.lower()  # TODO: use `cls._meta.model_name`?
+
+    #
+    # wagtail attributes/methods
+    #
+
+    # ion pages have no preview currently; clear wagtail preview modes
+    preview_modes = ()
+
+    # ion pages have no public url (disables wagtail "live view" buttons too)
+    def get_url_parts(self, request=None):
+        site = Site.find_for_request(request)
+        return site, None, None  # return only the site to silence the "no site configured" warning
+
+    # overwrite Page.copy() to automatically replace the page title & slug if `ion_generate_page_title` flag is set.
+    # this method is called for every child page too (on recursive copy).
+    def copy(self, *args, **kwargs):
+        new_update_attrs = kwargs.get('update_attrs', None) or {}
+
+        if self.ion_generate_page_title:
+            new_page_title = self.generate_page_title()
+            new_update_attrs.update({
+                'title': new_page_title,
+                'slug': slugify(new_page_title),
+            })
+
+        # Backport: Fix crash when copying an alias page
+        # TODO: remove once https://github.com/wagtail/wagtail/pull/6854 is merged & released
+        new_update_attrs.update({
+            'alias_of': None,
+        })
+        kwargs['update_attrs'] = new_update_attrs
+
+        return super().copy(*args, **kwargs)
+
+    #
+    # django model setup
+    #
+
+    class Meta:
+        abstract = True
+
+    def __str__(self):
+        return self.title
+
+    # overwrite Page.full_clean() to implement ION specific title & slug handling
+    def full_clean(self, *args, **kwargs):
+        # most ION pages have an auto-generated title (indicated by the `ion_generate_page_title` flag)
+        if not self.title and self.ion_generate_page_title:
+            self.title = self.generate_page_title()
+            self.slug = slugify(self.title)
+
+        super().full_clean(*args, **kwargs)
+
+
+class AbstractIonCollection(AbstractIonPage):
+    ion_api_object_name = 'collection'
+    ion_generate_page_title = False
+
+    parent_page_types = ['wagtailcore.Page']
+    subpage_types = [settings.ION_LANGUAGE_MODEL]
+
+    class Meta:
+        abstract = True