Add removal plan to containers for #737.

kive/container/ajax.py

@@ -3,6 +3,7 @@
 from wsgiref.util import FileWrapper
 
 from django.db.models import Q
+from django.db.models.aggregates import Count
 from django.http import HttpResponse
 from rest_framework import permissions
 from rest_framework.decorators import action
@@ -39,7 +40,8 @@ class ContainerFamilyViewSet(CleanCreateModelMixin,
     * filters[n][key]=user&filters[n][val]=match - username of creator contains
         the value (case insensitive)
     """
-    queryset = ContainerFamily.objects.all()
+    queryset = ContainerFamily.objects.annotate(
+        num_containers=Count('containers'))
     serializer_class = ContainerFamilySerializer
     permission_classes = (permissions.IsAuthenticated, IsDeveloperOrGrantedReadOnly)
     pagination_class = StandardPagination

kive/container/models.py

@@ -1,14 +1,17 @@
 # -*- coding: utf-8 -*-
 from __future__ import unicode_literals
 
+import os
 import re
 
+import errno
 from django.core.validators import RegexValidator
-from django.db import models
+from django.db import models, transaction
+from django.dispatch import receiver
 from django.urls import reverse
 
 from constants import maxlengths
-from metadata.models import AccessControl
+from metadata.models import AccessControl, empty_removal_plan, remove_helper
 
 
 class ContainerFamily(AccessControl):
@@ -20,6 +23,7 @@ class ContainerFamily(AccessControl):
         help_text='URL of Git repository that containers were built from',
         max_length=2000,
         blank=True)
+    containers = None  # Filled in later from child table.
 
     class Meta(object):
         ordering = ['name']
@@ -30,6 +34,23 @@ def __str__(self):
     def get_absolute_url(self):
         return reverse('container_family_update', kwargs=dict(pk=self.pk))
 
+    @transaction.atomic
+    def build_removal_plan(self, removal_accumulator=None):
+        """ Make a manifest of objects to remove when removing this. """
+        removal_plan = removal_accumulator or empty_removal_plan()
+        assert self not in removal_plan["ContainerFamilies"]
+        removal_plan["ContainerFamilies"].add(self)
+
+        for container in self.containers.all():
+            container.build_removal_plan(removal_plan)
+
+        return removal_plan
+
+    @transaction.atomic
+    def remove(self):
+        removal_plan = self.build_removal_plan()
+        remove_helper(removal_plan)
+
 
 class Container(AccessControl):
     UPLOAD_DIR = "CodeResources"
@@ -61,3 +82,27 @@ class Meta:
 
     def get_absolute_url(self):
         return reverse('container_update', kwargs=dict(pk=self.pk))
+
+    @transaction.atomic
+    def build_removal_plan(self, removal_accumulator=None):
+        """ Make a manifest of objects to remove when removing this. """
+        removal_plan = removal_accumulator or empty_removal_plan()
+        assert self not in removal_plan["Containers"]
+        removal_plan["Containers"].add(self)
+
+        return removal_plan
+
+    @transaction.atomic
+    def remove(self):
+        removal_plan = self.build_removal_plan()
+        remove_helper(removal_plan)
+
+
+@receiver(models.signals.post_delete, sender=Container)
+def delete_container_file(instance, **_kwargs):
+    if instance.file:
+        try:
+            os.remove(instance.file.path)
+        except OSError as ex:
+            if ex.errno != errno.ENOENT:
+                raise

kive/container/serializers.py

@@ -8,9 +8,9 @@
 class ContainerFamilySerializer(AccessControlSerializer,
                                 serializers.ModelSerializer):
     absolute_url = URLField(source='get_absolute_url', read_only=True)
-    # TODO: removal plan here and in fields
-    # removal_plan = serializers.HyperlinkedIdentityField(
-    #     view_name='dockerimage-removal-plan')
+    num_containers = serializers.IntegerField()
+    removal_plan = serializers.HyperlinkedIdentityField(
+        view_name='containerfamily-removal-plan')
 
     class Meta:
         model = ContainerFamily
@@ -23,15 +23,13 @@ class Meta:
             "git",
             "user",
             "users_allowed",
-            "groups_allowed")
+            "groups_allowed",
+            "num_containers",
+            "removal_plan")
 
 
 class ContainerSerializer(AccessControlSerializer,
                           serializers.ModelSerializer):
-    # TODO: removal plan here and in fields
-    # removal_plan = serializers.HyperlinkedIdentityField(
-    #     view_name='dockerimage-removal-plan')
-
     absolute_url = URLField(source='get_absolute_url', read_only=True)
     family = serializers.SlugRelatedField(
         slug_field='name',
@@ -43,6 +41,8 @@ class ContainerSerializer(AccessControlSerializer,
         read_only=True)
     download_url = serializers.HyperlinkedIdentityField(
         view_name='container-download')
+    removal_plan = serializers.HyperlinkedIdentityField(
+        view_name='container-removal-plan')
 
     class Meta:
         model = Container
@@ -59,4 +59,5 @@ class Meta:
                   'created',
                   'user',
                   'users_allowed',
-                  'groups_allowed')
+                  'groups_allowed',
+                  'removal_plan')

kive/container/static/container/ContainerFamilyTable.js

@@ -6,6 +6,7 @@
 	    this.registerLinkColumn("Name", "", "name", "absolute_url");
 	    this.registerColumn("Git", "git");
 	    this.registerColumn("Description", "description");
+	    this.registerColumn("Containers", "num_containers");
         this.registerStandardColumn("user");
         this.registerStandardColumn("users_allowed");
         this.registerStandardColumn("groups_allowed");

kive/metadata/models.py

@@ -36,7 +36,8 @@
 deletion_order = [
     "ExecRecords", "Datasets", "Runs", "Pipelines", "PipelineFamilies", "Methods",
     "MethodFamilies", "CompoundDatatypes", "Datatypes",
-    "CodeResourceRevisions", "CodeResources", "DockerImages"
+    "CodeResourceRevisions", "CodeResources", "DockerImages", "Containers",
+    "ContainerFamilies"
 ]
 
 

kive/metadata/templates/metadata/permissions_widget.html

@@ -1,5 +1,5 @@
 <!-- Django template -->
-<!-- Display contents of Datatypes as a HTML table -->
+<!-- Display permissions as an HTML table -->
 {% if old_users or old_groups %}
 <div>
     <h4>Users allowed</h4>