Single table for file attachments

src/backend/InvenTree/common/admin.py

@@ -7,6 +7,24 @@
 import common.models
 
 
+@admin.register(common.models.Attachment)
+class AttachmentAdmin(admin.ModelAdmin):
+    """Admin interface for Attachment objects."""
+
+    list_display = (
+        'model_type',
+        'model_id',
+        'attachment',
+        'link',
+        'user',
+        'upload_date',
+    )
+
+    readonly_fields = ['file_size', 'upload_date', 'user']
+
+    search_fields = ('content_type', 'comment')
+
+
 @admin.register(common.models.ProjectCode)
 class ProjectCodeAdmin(ImportExportModelAdmin):
     """Admin settings for ProjectCode."""
@@ -16,6 +34,7 @@ class ProjectCodeAdmin(ImportExportModelAdmin):
     search_fields = ('code', 'description')
 
 
+@admin.register(common.models.InvenTreeSetting)
 class SettingsAdmin(ImportExportModelAdmin):
     """Admin settings for InvenTreeSetting."""
 
@@ -28,6 +47,7 @@ def get_readonly_fields(self, request, obj=None):  # pragma: no cover
         return []
 
 
+@admin.register(common.models.InvenTreeUserSetting)
 class UserSettingsAdmin(ImportExportModelAdmin):
     """Admin settings for InvenTreeUserSetting."""
 
@@ -40,18 +60,21 @@ def get_readonly_fields(self, request, obj=None):  # pragma: no cover
         return []
 
 
+@admin.register(common.models.WebhookEndpoint)
 class WebhookAdmin(ImportExportModelAdmin):
     """Admin settings for Webhook."""
 
     list_display = ('endpoint_id', 'name', 'active', 'user')
 
 
+@admin.register(common.models.NotificationEntry)
 class NotificationEntryAdmin(admin.ModelAdmin):
     """Admin settings for NotificationEntry."""
 
     list_display = ('key', 'uid', 'updated')
 
 
+@admin.register(common.models.NotificationMessage)
 class NotificationMessageAdmin(admin.ModelAdmin):
     """Admin settings for NotificationMessage."""
 
@@ -70,16 +93,11 @@ class NotificationMessageAdmin(admin.ModelAdmin):
     search_fields = ('name', 'category', 'message')
 
 
+@admin.register(common.models.NewsFeedEntry)
 class NewsFeedEntryAdmin(admin.ModelAdmin):
     """Admin settings for NewsFeedEntry."""
 
     list_display = ('title', 'author', 'published', 'summary')
 
 
-admin.site.register(common.models.InvenTreeSetting, SettingsAdmin)
-admin.site.register(common.models.InvenTreeUserSetting, UserSettingsAdmin)
-admin.site.register(common.models.WebhookEndpoint, WebhookAdmin)
 admin.site.register(common.models.WebhookMessage, ImportExportModelAdmin)
-admin.site.register(common.models.NotificationEntry, NotificationEntryAdmin)
-admin.site.register(common.models.NotificationMessage, NotificationMessageAdmin)
-admin.site.register(common.models.NewsFeedEntry, NewsFeedEntryAdmin)

src/backend/InvenTree/common/migrations/0025_attachment.py

@@ -0,0 +1,35 @@
+# Generated by Django 4.2.12 on 2024-06-08 12:37
+
+import InvenTree.fields
+import InvenTree.models
+import common.models
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('contenttypes', '0002_remove_content_type_name'),
+        ('common', '0024_notesimage_model_id_notesimage_model_type'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Attachment',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('model_id', models.PositiveIntegerField()),
+                ('attachment', models.FileField(blank=True, help_text='Select file to attach', null=True, upload_to=common.models.rename_attachment, verbose_name='Attachment')),
+                ('link', InvenTree.fields.InvenTreeURLField(blank=True, help_text='Link to external URL', null=True, verbose_name='Link')),
+                ('comment', models.CharField(blank=True, help_text='Attachment comment', max_length=100, verbose_name='Comment')),
+                ('upload_date', models.DateField(auto_now_add=True, help_text='Date the file was uploaded', null=True, verbose_name='Upload date')),
+                ('file_size', models.PositiveIntegerField(default=0, help_text='File size in bytes', verbose_name='File size')),
+                ('model_type', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='contenttypes.contenttype')),
+                ('user', models.ForeignKey(blank=True, help_text='User', null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL, verbose_name='User')),
+            ],
+            bases=(InvenTree.models.PluginValidationMixin, models.Model),
+        ),
+    ]

src/backend/InvenTree/common/migrations/0026_auto_20240608_1238.py

@@ -0,0 +1,86 @@
+# Generated by Django 4.2.12 on 2024-06-08 12:38
+
+from django.db import migrations
+from django.core.files.storage import default_storage
+
+
+def update_attachments(apps, schema_editor):
+    """Migrate any existing attachment models to the new attachment table."""
+
+    Attachment = apps.get_model('common', 'attachment')
+
+    # Legacy attachment types to convert:
+    # app_label, table name, target model, model ref
+    legacy_models = [
+        ('build', 'BuildOrderAttachment', 'build', 'build'),
+        ('company', 'CompanyAttachment', 'company', 'company'),
+        ('company', 'ManufacturerPartAttachment', 'manufacturerpart', 'manufacturer_part'),
+        ('order', 'PurchaseOrderAttachment', 'purchaseorder', 'order'),
+        ('order', 'SalesOrderAttachment', 'salesorder', 'order'),
+        ('order', 'ReturnOrderAttachment', 'order', 'order'),
+        ('part', 'PartAttachment', 'part', 'part'),
+        ('stock', 'StockItemAttachment', 'stockitem', 'stock_item')
+    ]
+
+    # Get the "ContentType" model
+    ContentType = apps.get_model('contenttypes', 'ContentType') 
+
+    for app, model, target_model, model_ref in legacy_models:
+        LegacyAttachmentModel = apps.get_model(app, model)
+
+        if LegacyAttachmentModel.objects.count() == 0:
+            continue
+
+        # Find the ContentType model which matches the target table
+        content_type = ContentType.objects.get(app_label=app, model=target_model)
+
+        to_create = []
+
+        for attachment in LegacyAttachmentModel.objects.all():
+
+            # Find the size of the file (if exists)
+            if attachment.attachment and default_storage.exists(attachment.attachment.name):
+                try:
+                    file_size = default_storage.size(attachment.attachment.name)
+                except NotImplementedError:
+                    file_size = 0
+            else:
+                file_size = 0
+
+            to_create.append(
+                Attachment(
+                    model_type=content_type,
+                    model_id=getattr(attachment, model_ref).pk,
+                    attachment=attachment.attachment,
+                    link=attachment.link,
+                    comment=attachment.comment,
+                    user=attachment.user,
+                    upload_date=attachment.upload_date,
+                    file_size=file_size
+                )
+            )
+
+        if len(to_create) > 0:
+            print(f"Migrating {len(to_create)} attachments for the legacy '{model}' model.")
+            Attachment.objects.bulk_create(to_create)
+
+
+def delete_attachments(apps, schema_editor):
+    """Reverse data migration removes any Attachment objects."""
+
+    Attachment = apps.get_model('common', 'attachment')
+
+    if n := Attachment.objects.count():
+        Attachment.objects.all().delete()
+        print(f"Deleted {n} Attachments in reverse migration")
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('common', '0025_attachment'),
+    ]
+
+    operations = [
+        migrations.RunPython(update_attachments, reverse_code=delete_attachments)
+    ]

src/backend/InvenTree/common/models.py

@@ -3062,3 +3062,116 @@
     from InvenTree.conversion import reload_unit_registry
 
     reload_unit_registry()
+
+
+def rename_attachment(instance, filename):
+    """Callback function to rename an uploaded attachment file.
+
+    Arguments:
+        - instance: The Attachment instance
+        - filename: The original filename of the uploaded file
+
+    Returns:
+        - The new filename for the uploaded file, e.g. 'attachments/<content_type>/<object_id>/<filename>'
+    """
+    filename = os.path.basename(filename)
+
+    # Generate a new filename for the attachment
+    return os.path.join(
+        'attachments',
+        str(instance.content_type.model),
+        str(instance.object_id),
+        filename,
+    )
+
+
+class Attachment(InvenTree.models.InvenTreeModel):
+    """Class which represents an uploaded file attachment.
+
+    An attachment can be either an uploaded file, or an external URL.
+
+    Attributes:
+        attachment: The uploaded file
+        url: An external URL
+        comment: A comment or description for the attachment
+        user: The user who uploaded the attachment
+        upload_date: The date the attachment was uploaded
+        file_size: The size of the uploaded file
+    """
+
+    class Meta:
+        """Metaclass options."""
+
+        ...
+
+    model_type = models.ForeignKey(ContentType, on_delete=models.CASCADE)
+    model_id = models.PositiveIntegerField()
+
+    content_object = GenericForeignKey('model_type', 'model_id')
+
+    attachment = models.FileField(
+        upload_to=rename_attachment,
+        verbose_name=_('Attachment'),
+        help_text=_('Select file to attach'),
+        blank=True,
+        null=True,
+    )
+
+    link = InvenTree.fields.InvenTreeURLField(
+        blank=True,
+        null=True,
+        verbose_name=_('Link'),
+        help_text=_('Link to external URL'),
+    )
+
+    comment = models.CharField(
+        blank=True,
+        max_length=100,
+        verbose_name=_('Comment'),
+        help_text=_('Attachment comment'),
+    )
+
+    user = models.ForeignKey(
+        User,
+        on_delete=models.SET_NULL,
+        blank=True,
+        null=True,
+        verbose_name=_('User'),
+        help_text=_('User'),
+    )
+
+    upload_date = models.DateField(
+        auto_now_add=True,
+        null=True,
+        blank=True,
+        verbose_name=_('Upload date'),
+        help_text=_('Date the file was uploaded'),
+    )
+
+    file_size = models.PositiveIntegerField(
+        default=0, verbose_name=_('File size'), help_text=_('File size in bytes')
+    )
+
+    @property
+    def basename(self):
+        """Base name/path for attachment."""
+        if self.attachment:
+            return os.path.basename(self.attachment.name)
+        return None
+
+    def fully_qualified_url(self):
+        """Return a 'fully qualified' URL for this attachment.
+
+        - If the attachment is a link to an external resource, return the link
+        - If the attachment is an uploaded file, return the fully qualified media URL
+        """
+        if self.link:
+            return self.link
+
+        if self.attachment:
+            import InvenTree.helpers_model
+
+            media_url = InvenTree.helpers.getMediaUrl(self.attachment.url)
+            return InvenTree.helpers_model.construct_absolute_url(media_url)
+
+        return ''