#18 File upload in certain folders

* removes document file folder if the last EmaDocument is removed from an Ema

compensation/models.py

@@ -5,10 +5,12 @@ Contact: michel.peltriaux@sgdnord.rlp.de
 Created on: 17.11.20
 
 """
+import shutil
+
 from django.contrib.auth.models import User
 from django.contrib.gis.db import models
 from django.core.validators import MinValueValidator
-from django.db.models import Sum
+from django.db.models import Sum, QuerySet
 from django.utils.translation import gettext_lazy as _
 
 from codelist.models import KonovaCode
@@ -197,6 +199,17 @@ class Compensation(AbstractCompensation):
             y,
         )
 
+    def get_documents(self) -> QuerySet:
+        """ Getter for all documents of a compensation
+
+        Returns:
+            docs (QuerySet): The queryset of all documents
+        """
+        docs = CompensationDocument.objects.filter(
+            instance=self
+        )
+        return docs
+
 
 class CompensationDocument(AbstractDocument):
     """
@@ -212,6 +225,35 @@ class CompensationDocument(AbstractDocument):
         max_length=1000,
     )
 
+    def delete(self, *args, **kwargs):
+        """
+        Custom delete functionality for CompensationDocuments.
+        Removes the folder from the file system if there are no further documents for this entry.
+
+        Args:
+            *args ():
+            **kwargs ():
+
+        Returns:
+
+        """
+        comp_docs = self.instance.get_documents()
+
+        folder_path = None
+        if comp_docs.count() == 1:
+            # The only file left for this compensation is the one which is currently processed and will be deleted
+            # Make sure that the compensation folder itself is deleted as well, not only the file
+            # Therefore take the folder path from the file path
+            folder_path = self.file.path.split("/")[:-1]
+            folder_path = "/".join(folder_path)
+
+        # Remove the file itself
+        super().delete(*args, **kwargs)
+
+        # If a folder path has been set, we need to delete the whole folder!
+        if folder_path is not None:
+            shutil.rmtree(folder_path)
+
 
 class EcoAccount(AbstractCompensation):
     """
@@ -313,6 +355,17 @@ class EcoAccount(AbstractCompensation):
 
         return ret_msgs
 
+    def get_documents(self) -> QuerySet:
+        """ Getter for all documents of an EcoAccount
+
+        Returns:
+            docs (QuerySet): The queryset of all documents
+        """
+        docs = EcoAccountDocument.objects.filter(
+            instance=self
+        )
+        return docs
+
 
 class EcoAccountDocument(AbstractDocument):
     """
@@ -328,6 +381,35 @@ class EcoAccountDocument(AbstractDocument):
         max_length=1000,
     )
 
+    def delete(self, *args, **kwargs):
+        """
+        Custom delete functionality for EcoAccountDocuments.
+        Removes the folder from the file system if there are no further documents for this entry.
+
+        Args:
+            *args ():
+            **kwargs ():
+
+        Returns:
+
+        """
+        acc_docs = self.instance.get_documents()
+
+        folder_path = None
+        if acc_docs.count() == 1:
+            # The only file left for this eco account is the one which is currently processed and will be deleted
+            # Make sure that the compensation folder itself is deleted as well, not only the file
+            # Therefore take the folder path from the file path
+            folder_path = self.file.path.split("/")[:-1]
+            folder_path = "/".join(folder_path)
+
+        # Remove the file itself
+        super().delete(*args, **kwargs)
+
+        # If a folder path has been set, we need to delete the whole folder!
+        if folder_path is not None:
+            shutil.rmtree(folder_path)
+
 
 class EcoAccountDeduction(BaseResource):
     """

ema/models.py

@@ -1,5 +1,8 @@
+import shutil
+
 from django.contrib.auth.models import User
 from django.db import models
+from django.db.models import QuerySet
 
 from compensation.models import AbstractCompensation
 from konova.models import AbstractDocument, generate_document_file_upload_path
@@ -86,6 +89,17 @@ class Ema(AbstractCompensation):
 
         return ret_msgs
 
+    def get_documents(self) -> QuerySet:
+        """ Getter for all documents of an EMA
+
+        Returns:
+            docs (QuerySet): The queryset of all documents
+        """
+        docs = EmaDocument.objects.filter(
+            instance=self
+        )
+        return docs
+
 
 class EmaDocument(AbstractDocument):
     """
@@ -99,4 +113,33 @@ class EmaDocument(AbstractDocument):
     file = models.FileField(
         upload_to=generate_document_file_upload_path,
         max_length=1000,
-    )
+    )
+
+    def delete(self, *args, **kwargs):
+        """
+        Custom delete functionality for EcoAccountDocuments.
+        Removes the folder from the file system if there are no further documents for this entry.
+
+        Args:
+            *args ():
+            **kwargs ():
+
+        Returns:
+
+        """
+        ema_docs = self.instance.get_documents()
+
+        folder_path = None
+        if ema_docs.count() == 1:
+            # The only file left for this EMA is the one which is currently processed and will be deleted
+            # Make sure that the compensation folder itself is deleted as well, not only the file
+            # Therefore take the folder path from the file path
+            folder_path = self.file.path.split("/")[:-1]
+            folder_path = "/".join(folder_path)
+
+        # Remove the file itself
+        super().delete(*args, **kwargs)
+
+        # If a folder path has been set, we need to delete the whole folder!
+        if folder_path is not None:
+            shutil.rmtree(folder_path)

intervention/models.py

@@ -5,8 +5,11 @@ Contact: michel.peltriaux@sgdnord.rlp.de
 Created on: 17.11.20
 
 """
+import shutil
+
 from django.contrib.auth.models import User
 from django.contrib.gis.db import models
+from django.db.models import QuerySet
 from django.utils.timezone import localtime
 from django.utils.translation import gettext_lazy as _
 
@@ -92,8 +95,39 @@ class RevocationDocument(AbstractDocument):
 
     @property
     def intervention(self):
+        """
+        Shortcut for opening the related intervention
+
+        Returns:
+            intervention (Intervention)
+        """
         return self.instance.legaldata.intervention
 
+    def delete(self, *args, **kwargs):
+        """
+        Custom delete functionality for RevocationDocuments.
+        Removes the folder from the file system if there are no further documents for this entry.
+
+        Args:
+            *args ():
+            **kwargs ():
+
+        Returns:
+
+        """
+        revoc_docs, other_intervention_docs = self.intervention.get_documents()
+
+        # Remove the file itself
+        super().delete(*args, **kwargs)
+
+        # Always remove 'revocation' folder
+        folder_path = self.file.path.split("/")
+        shutil.rmtree("/".join(folder_path[:-1]))
+
+        if other_intervention_docs.count() == 0:
+            # If there are no further documents for the intervention, we can simply remove the whole folder as well!
+            shutil.rmtree("/".join(folder_path[:-2]))
+
 
 class LegalData(UuidModel):
     """
@@ -324,6 +358,21 @@ class Intervention(BaseObject):
             tooltip = _("Recorded on {} by {}").format(on, self.recorded.user)
         return tooltip
 
+    def get_documents(self) -> (QuerySet, QuerySet):
+        """ Getter for all documents of an intervention
+
+        Returns:
+            revoc_docs (QuerySet): The queryset of a revocation document
+            regular_docs (QuerySet): The queryset of regular other documents
+        """
+        revoc_docs = RevocationDocument.objects.filter(
+            instance=self.legal.revocation
+        )
+        regular_docs = InterventionDocument.objects.filter(
+            instance=self
+        )
+        return revoc_docs, regular_docs
+
 
 class InterventionDocument(AbstractDocument):
     """
@@ -338,3 +387,33 @@ class InterventionDocument(AbstractDocument):
         upload_to=generate_document_file_upload_path,
         max_length=1000,
     )
+
+    def delete(self, *args, **kwargs):
+        """
+        Custom delete functionality for InterventionDocuments.
+        Removes the folder from the file system if there are no further documents for this entry.
+
+        Args:
+            *args ():
+            **kwargs ():
+
+        Returns:
+
+        """
+        revoc_docs, other_intervention_docs = self.instance.get_documents()
+
+        folder_path = None
+        if revoc_docs.count() == 0 and other_intervention_docs.count() == 1:
+            # The only file left for this intervention is the one which is currently processed and will be deleted
+            # Make sure that the intervention folder itself is deleted as well, not only the file
+            # Therefore take the folder path from the file path
+            folder_path = self.file.path.split("/")[:-1]
+            folder_path = "/".join(folder_path)
+
+        # Remove the file itself
+        super().delete(*args, **kwargs)
+
+        # If a folder path has been set, we need to delete the whole folder!
+        if folder_path is not None:
+            shutil.rmtree(folder_path)
+