From 0f9bddbcd28fb5cffd1bb13cdbeade2a3b67c8d3 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
 <41898282+github-actions[bot]@users.noreply.github.com>
Date: Mon, 3 Feb 2025 08:03:59 +1100
Subject: [PATCH] Report bugfix (#9013) (#9014)

- Ensure default label templates exist
- Ensure default report templates exist

(cherry picked from commit 2a6434ead89443b075adf48d12afd21fbb47443b)

Co-authored-by: Oliver <oliver.henry.walters@gmail.com>
---
 src/backend/InvenTree/report/apps.py | 70 +++++++++++++++-------------
 1 file changed, 37 insertions(+), 33 deletions(-)

diff --git a/src/backend/InvenTree/report/apps.py b/src/backend/InvenTree/report/apps.py
index 1018a28835..e6346004ac 100644
--- a/src/backend/InvenTree/report/apps.py
+++ b/src/backend/InvenTree/report/apps.py
@@ -7,6 +7,7 @@ from pathlib import Path
 from django.apps import AppConfig
 from django.core.exceptions import AppRegistryNotReady
 from django.core.files.base import ContentFile
+from django.core.files.storage import default_storage
 from django.db.utils import IntegrityError, OperationalError, ProgrammingError
 
 from maintenance_mode.core import maintenance_mode_on, set_maintenance_mode
@@ -55,6 +56,18 @@ class ReportConfig(AppConfig):
 
         set_maintenance_mode(False)
 
+    def file_from_template(self, dir_name: str, file_name: str) -> ContentFile:
+        """Construct a new ContentFile from a template file."""
+        logger.info('Creating %s template file: %s', dir_name, file_name)
+
+        return ContentFile(
+            Path(__file__)
+            .parent.joinpath('templates', dir_name, file_name)
+            .open('r')
+            .read(),
+            os.path.basename(file_name),
+        )
+
     def create_default_labels(self):
         """Create default label templates."""
         # Test if models are ready
@@ -106,29 +119,25 @@ class ReportConfig(AppConfig):
         ]
 
         for template in label_templates:
-            # Ignore matching templates which are already in the database
-            if report.models.LabelTemplate.objects.filter(
-                name=template['name']
-            ).exists():
-                continue
-
             filename = template.pop('file')
 
-            template_file = Path(__file__).parent.joinpath(
-                'templates', 'label', filename
-            )
-
-            if not template_file.exists():
-                logger.warning("Missing template file: '%s'", template['name'])
+            # Template already exists in the database - check that the file exists too
+            if existing_template := report.models.LabelTemplate.objects.filter(
+                name=template['name'], model_type=template['model_type']
+            ).first():
+                if not default_storage.exists(existing_template.template.name):
+                    # The file does not exist in the storage system - add it in
+                    existing_template.template = self.file_from_template(
+                        'label', filename
+                    )
+                    existing_template.save()
                 continue
 
-            # Read the existing template file
-            data = template_file.open('r').read()
-
+            # Otherwise, create a new entry
             try:
                 # Create a new entry
                 report.models.LabelTemplate.objects.create(
-                    **template, template=ContentFile(data, os.path.basename(filename))
+                    **template, template=self.file_from_template('label', filename)
                 )
                 logger.info("Creating new label template: '%s'", template['name'])
             except Exception:
@@ -202,29 +211,24 @@ class ReportConfig(AppConfig):
         ]
 
         for template in report_templates:
-            # Ignore matching templates which are already in the database
-            if report.models.ReportTemplate.objects.filter(
-                name=template['name']
-            ).exists():
-                continue
-
             filename = template.pop('file')
 
-            template_file = Path(__file__).parent.joinpath(
-                'templates', 'report', filename
-            )
-
-            if not template_file.exists():
-                logger.warning("Missing template file: '%s'", template['name'])
+            # Template already exists in the database - check that the file exists too
+            if existing_template := report.models.ReportTemplate.objects.filter(
+                name=template['name'], model_type=template['model_type']
+            ).first():
+                if not default_storage.exists(existing_template.template.name):
+                    # The file does not exist in the storage system - add it in
+                    existing_template.template = self.file_from_template(
+                        'report', filename
+                    )
+                    existing_template.save()
                 continue
 
-            # Read the existing template file
-            data = template_file.open('r').read()
-
-            # Create a new entry
+            # Otherwise, create a new entry
             try:
                 report.models.ReportTemplate.objects.create(
-                    **template, template=ContentFile(data, os.path.basename(filename))
+                    **template, template=self.file_from_template('report', filename)
                 )
                 logger.info("Created new report template: '%s'", template['name'])
             except Exception: