Rework track models, add to modeladmin instead formset

tests/app/migrations/0004_tracks.py

+# Generated by Django 2.2.17 on 2021-01-28 23:40
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('app', '0003_auto_20210129_1006'),
+    ]
+
+    operations = [
+        migrations.DeleteModel(
+            name='CustomTrack',
+        ),
+    ]

tests/app/models.py

@@ -5,7 +5,8 @@ from wagtail.admin.edit_handlers import StreamFieldPanel
 
 from wagtailvideos.edit_handlers import VideoChooserPanel
 from wagtailvideos.blocks import VideoChooserBlock
-from wagtailvideos.models import AbstractVideo, AbstractVideoTranscode, AbstractTrack
+from wagtailvideos.models import AbstractVideo, AbstractVideoTranscode
+from modelcluster.fields import ParentalKey
 
 
 class CustomVideoModel(AbstractVideo):
@@ -30,9 +31,6 @@ class CustomVideoTranscode(AbstractVideoTranscode):
         )
 
 
-class CustomTrack(AbstractTrack):
-    video = models.ForeignKey(CustomVideoModel, related_name='tracks', on_delete=models.CASCADE)
-
 class TestPage(Page):
     video_field = models.ForeignKey(
         'wagtailvideos.Video', related_name='+', null=True, blank=True, on_delete=models.SET_NULL)

tests/app/settings.py

@@ -16,6 +16,7 @@ INSTALLED_APPS = [
     'wagtail.snippets',
     'wagtail.images',
     'wagtail.documents',
+    'wagtail.contrib.modeladmin',
 
     'django.contrib.admin',
     'django.contrib.auth',

wagtailvideos/models.py

+from wagtailvideos import get_video_model_string
+from modelcluster.models import ClusterableModel
+from modelcluster.fields import ParentalKey
 import logging
 import mimetypes
 import os
@@ -73,7 +76,7 @@ def get_upload_to(instance, filename):
     return instance.get_upload_to(filename)
 
 
-class AbstractVideo(CollectionMember, index.Indexed, models.Model):
+class AbstractVideo(CollectionMember, index.Indexed, ClusterableModel):
     title = models.CharField(max_length=255, verbose_name=_('title'))
     file = models.FileField(
         verbose_name=_('file'), upload_to=get_upload_to)
@@ -314,8 +317,18 @@ class VideoTranscode(AbstractVideoTranscode):
         )
 
 
-class AbstractTrack(models.Model):
-    # TODO move to TextChoices once djang0 < 3 is dropped
+class TrackListing(ClusterableModel):
+    video = models.OneToOneField(
+        get_video_model_string(), on_delete=models.CASCADE,
+        related_name='tracks')
+
+    def __str__(self):
+        return self.video.title
+
+
+class VideoTrack(models.Model):
+    listing = ParentalKey(TrackListing, related_name='tracks', on_delete=models.CASCADE)
+    # TODO move to TextChoices once django < 3 is dropped
     track_kinds = [
         ('subtitles', 'Subtitles'),
         ('captions', 'Captions'),
@@ -345,10 +358,3 @@ class AbstractTrack(models.Model):
         folder_name = 'video_tracks'
         filename = self.file.field.storage.get_valid_name(filename)
         return os.path.join(folder_name, filename)
-
-    class Meta:
-        abstract = True
-
-
-class Track(AbstractTrack):
-    video = models.ForeignKey(Video, related_name='tracks', on_delete=models.CASCADE)

wagtailvideos/signals.py

@@ -6,6 +6,7 @@ from django.db import transaction
 from django.db.models.signals import post_delete, post_save
 
 from wagtailvideos import ffmpeg, get_video_model
+from wagtailvideos.models import VideoTrack
 
 
 @contextmanager
@@ -67,10 +68,8 @@ def video_post_save(instance, **kwargs):
 def register_signal_handlers():
     Video = get_video_model()
     VideoTranscode = Video.get_transcode_model()
-    VideoTrack = Video.get_track_model()
 
     post_save.connect(video_post_save, sender=Video)
     post_delete.connect(post_delete_file_cleanup, sender=Video)
     post_delete.connect(post_delete_file_cleanup, sender=VideoTranscode)
     post_delete.connect(post_delete_file_cleanup, sender=VideoTrack)
-

wagtailvideos/templates/wagtailvideos/videos/edit.html

@@ -41,6 +41,9 @@
                     {% include "wagtailadmin/shared/field_as_li.html" with li_classes="label-above label-uppercase" %}
                   {% endif %}
                   {% endfor %}
+            </ul>
+                <h2 class="u-text-transform-uppercase">Tracks</h2>
+                <p>Add/edit subtitles or accessibility captions for you video. For information about the filetype that should be used see the mozilla docs on <a href="https://developer.mozilla.org/en-US/docs/Web/API/WebVTT_API">WebVTT</a></p>
                 <li>
                     <input type="submit" class="button" value="{% trans 'Save' %}" /> {% if user_can_delete %}
                     <a href="{% url 'wagtailvideos:delete' video.id %}" class="button button-secondary no">{% trans "Delete video" %}</a> {% endif %}
@@ -76,10 +79,10 @@
         </div>
         <div class="row" style='margin-top: 2em;'>
         {% if can_transcode %}
-            <h3 class="label no-float u-text-transform-uppercase">Transcodes</h3>
+            <h2 class="u-text-transform-uppercase">Transcodes</h2>
             <p>If you wish to generate HTML5 compliant transcodes use the form below. This may take a while depending on the length of the video.</p>
             {% if transcodes %}
-            <h3 class="label no-float u-text-transform-uppercase">Available Transcodes</h3>
+            <h3 class="u-text-transform-uppercase">Available Transcodes</h3>
             <ul>
                 {% for transcode in transcodes %}
                 <li>
@@ -93,7 +96,7 @@
                 {% endfor %}
             </ul>
             {% endif %}
-            <h3 class="label no-float u-text-transform-uppercase">Create transcode</h3>
+            <h3 class="u-text-transform-uppercase">Create transcode</h3>
             <form action="{% url 'wagtailvideos:create_transcode' video.id %}" method="POST">
                 <ul class="fields">
                     {% csrf_token %}

wagtailvideos/views/videos.py

@@ -2,16 +2,16 @@ from distutils.version import LooseVersion
 
 import wagtail
 from django.core.paginator import Paginator
-from django.http import HttpResponseNotAllowed
 from django.shortcuts import get_object_or_404, redirect, render
 from django.urls import reverse
 from django.utils.translation import ugettext as _
+from django.views.decorators.http import require_POST
 from django.views.decorators.vary import vary_on_headers
 from wagtail.admin import messages
 from wagtail.admin.forms.search import SearchForm
 from wagtail.core.models import Collection
 from wagtail.search.backends import get_search_backends
-from django.forms import modelformset_factory
+
 from wagtailvideos import ffmpeg, get_video_model
 from wagtailvideos.forms import VideoTranscodeAdminForm, get_video_form
 from wagtailvideos.permissions import permission_policy
@@ -104,10 +104,7 @@ def edit(request, video_id):
             for backend in get_search_backends():
                 backend.add(video)
 
-            messages.success(request, _("Video '{0}' updated.").format(video.title), buttons=[
-                messages.button(reverse('wagtailvideos:edit', args=(video.id,)), _('Edit again'))
-            ])
-            return redirect('wagtailvideos:index')
+            messages.success(request, _("Video '{0}' updated.").format(video.title))
         else:
             messages.error(request, _("The video could not be saved due to errors."))
     else:
@@ -121,9 +118,6 @@ def edit(request, video_id):
             messages.button(reverse('wagtailvideos:delete', args=(video.id,)), _('Delete'))
         ])
 
-    Track = Video.get_track_model()
-    TrackFormset = modelformset_factory(Track, exclude=('video',))
-
     return render(request, "wagtailvideos/videos/edit.html", {
         'video': video,
         'form': form,
@@ -131,14 +125,12 @@ def edit(request, video_id):
         'can_transcode': ffmpeg.installed(),
         'transcodes': video.transcodes.all(),
         'transcode_form': VideoTranscodeAdminForm(video=video),
-        'track_formset': TrackFormset(queryset=video.tracks.all()),
         'user_can_delete': permission_policy.user_has_permission_for_instance(request.user, 'delete', video)
     })
 
 
+@require_POST
 def create_transcode(request, video_id):
-    if request.method != 'POST':
-        return HttpResponseNotAllowed(['POST'])
     video = get_object_or_404(get_video_model(), id=video_id)
     transcode_form = VideoTranscodeAdminForm(data=request.POST, video=video)
 
@@ -193,13 +185,13 @@ def add(request):
     })
 
 
-def usage(request, image_id):
-    image = get_object_or_404(get_video_model(), id=image_id)
+def usage(request, video_id):
+    video = get_object_or_404(get_video_model(), id=video_id)
 
-    paginator = Paginator(image.get_usage(), per_page=12)
+    paginator = Paginator(video.get_usage(), per_page=12)
     page = paginator.get_page(request.GET.get('p'))
 
     return render(request, "wagtailvideos/videos/usage.html", {
-        'image': image,
+        'video': video,
         'used_by': page
     })

wagtailvideos/wagtail_hooks.py

+from wagtail.admin.edit_handlers import InlinePanel
+from wagtailvideos.edit_handlers import VideoChooserPanel
+from wagtail.contrib.modeladmin.options import ModelAdmin, modeladmin_register
 from django.conf.urls import include, url
+from django.templatetags.static import static
 from django.urls import reverse
 from django.utils.html import format_html
+from django.utils.safestring import mark_safe
 from django.utils.translation import ugettext_lazy as _
-from wagtail.admin.menu import MenuItem, SubmenuMenuItem, Menu
+from wagtail.admin.menu import Menu, MenuItem, SubmenuMenuItem
 from wagtail.admin.search import SearchArea
 from wagtail.admin.site_summary import SummaryItem
 from wagtail.core import hooks
-from django.utils.html import format_html
-from django.templatetags.static import static
-from wagtailvideos import urls
+
+from wagtailvideos import get_video_model, urls
 from wagtailvideos.forms import GroupVideoPermissionFormSet
-from wagtailvideos import get_video_model
-from django.utils.safestring import mark_safe
+from wagtailvideos.models import TrackListing
+
 from .permissions import permission_policy
 
 Video = get_video_model()
@@ -48,7 +52,7 @@ class VideoMenu(Menu):
 
     def menu_items_for_request(self, request):
         return [
-            MenuItem(_('Videos'), reverse('wagtailvideos:index'),
+            MenuItem(_('Manage videos'), reverse('wagtailvideos:index'),
                      name='videos', classnames='icon icon-media', order=300)
         ]
 
@@ -109,3 +113,19 @@ def register_media_search_area():
 @hooks.register('insert_global_admin_css')
 def summary_css():
     return format_html('<link rel="stylesheet" href="{}">', static('wagtailvideos/css/summary-override.css'))
+
+
+@modeladmin_register
+class TracksAdmin(ModelAdmin):
+    model = TrackListing
+
+    list_display = ('__str__', 'track_count')
+
+    def track_count(self, track_listing):
+        return track_listing.tracks.count()
+    track_count.short_description = 'No. tracks'
+
+    panels = [
+        VideoChooserPanel('video'),
+        InlinePanel('tracks', heading="Tracks")
+    ]