Attachments refactor (#737)

* refactor attachment code into its own file * Add getters * Remove custom models for each type of attachment * Refactor existing widgets * Fix double camera open bug * Remove dead code * Remove unused imports * Refactor common code * format * Update release notes
2026-01-13 03:26:24 +00:00 · 2025-11-28 23:53:10 +11:00 · 2025-11-28 23:53:10 +11:00 · 346b1a150f
commit 346b1a150f
parent bb10117f01
15 changed files with 381 additions and 519 deletions
--- a/lib/widget/attachment_widget.dart
+++ b/lib/widget/attachment_widget.dart
@ -2,14 +2,13 @@ import "dart:io";

 import "package:flutter/material.dart";
 import "package:flutter_tabler_icons/flutter_tabler_icons.dart";
+import "package:inventree/api.dart";
+import "package:inventree/inventree/attachment.dart";
+import "package:inventree/widget/link_icon.dart";
 import "package:one_context/one_context.dart";

-import "package:inventree/api.dart";
 import "package:inventree/l10.dart";
 import "package:inventree/app_colors.dart";
-
-import "package:inventree/inventree/model.dart";
-
 import "package:inventree/widget/fields.dart";
 import "package:inventree/widget/progress.dart";
 import "package:inventree/widget/snacks.dart";
@ -23,13 +22,13 @@ import "package:inventree/widget/refreshable_state.dart";
 */
 class AttachmentWidget extends StatefulWidget {
  const AttachmentWidget(
-    this.attachmentClass,
+    this.modelType,
    this.modelId,
    this.imagePrefix,
    this.hasUploadPermission,
  ) : super();

-  final InvenTreeAttachment attachmentClass;
+  final String modelType;
  final int modelId;
  final bool hasUploadPermission;
  final String imagePrefix;
@ -54,15 +53,15 @@ class _AttachmentWidgetState extends RefreshableState<AttachmentWidget> {
      IconButton(
        icon: Icon(TablerIcons.camera),
        onPressed: () async {
-          widget.attachmentClass.uploadImage(
-            widget.modelId,
-            prefix: widget.imagePrefix,
-          );
-          FilePickerDialog.pickImageFromCamera().then((File? file) {
-            upload(context, file).then((_) {
-              refresh(context);
-            });
-          });
+          InvenTreeAttachment()
+              .uploadImage(
+                widget.modelType,
+                widget.modelId,
+                prefix: widget.imagePrefix,
+              )
+              .then((_) {
+                refresh(context);
+              });
        },
      ),
      IconButton(
@ -83,8 +82,9 @@ class _AttachmentWidgetState extends RefreshableState<AttachmentWidget> {

    showLoadingOverlay();

-    final bool result = await widget.attachmentClass.uploadAttachment(
+    final bool result = await InvenTreeAttachment().uploadAttachment(
      file,
+      widget.modelType,
      widget.modelId,
    );

@ -168,25 +168,24 @@ class _AttachmentWidgetState extends RefreshableState<AttachmentWidget> {
  Future<void> request(BuildContext context) async {
    Map<String, String> filters = {};

-    if (InvenTreeAPI().supportsModernAttachments) {
-      filters["model_type"] = widget.attachmentClass.REF_MODEL_TYPE;
-      filters["model_id"] = widget.modelId.toString();
-    } else {
-      filters[widget.attachmentClass.REFERENCE_FIELD] = widget.modelId
-          .toString();
-    }
+    filters["model_type"] = widget.modelType;
+    filters["model_id"] = widget.modelId.toString();

-    await widget.attachmentClass.list(filters: filters).then((var results) {
-      attachments.clear();
+    List<InvenTreeAttachment> _attachments = [];

+    InvenTreeAttachment().list(filters: filters).then((var results) {
      for (var result in results) {
        if (result is InvenTreeAttachment) {
-          attachments.add(result);
+          _attachments.add(result);
        }
      }
-    });

-    setState(() {});
+      if (mounted) {
+        setState(() {
+          attachments = _attachments;
+        });
+      }
+    });
  }

  @override
@ -240,3 +239,40 @@ class _AttachmentWidgetState extends RefreshableState<AttachmentWidget> {
    return tiles;
  }
 }
+
+/*
+ * Return a ListTile to display attachments for the specified model
+ */
+ListTile? ShowAttachmentsItem(
+  BuildContext context,
+  String modelType,
+  int modelId,
+  String imagePrefix,
+  int attachmentCount,
+  bool hasUploadPermission,
+) {
+  if (!InvenTreeAPI().supportsModernAttachments) {
+    return null;
+  }
+
+  return ListTile(
+    title: Text(L10().attachments),
+    leading: Icon(TablerIcons.file, color: COLOR_ACTION),
+    trailing: LinkIcon(
+      text: attachmentCount > 0 ? attachmentCount.toString() : null,
+    ),
+    onTap: () {
+      Navigator.push(
+        context,
+        MaterialPageRoute(
+          builder: (context) => AttachmentWidget(
+            modelType,
+            modelId,
+            imagePrefix,
+            hasUploadPermission,
+          ),
+        ),
+      );
+    },
+  );
+}
--- a/lib/widget/company/company_detail.dart
+++ b/lib/widget/company/company_detail.dart
@ -1,6 +1,7 @@
 import "package:flutter/material.dart";
 import "package:flutter_speed_dial/flutter_speed_dial.dart";
 import "package:flutter_tabler_icons/flutter_tabler_icons.dart";
+import "package:inventree/inventree/attachment.dart";

 import "package:inventree/l10.dart";
 import "package:inventree/api.dart";
@ -184,15 +185,15 @@ class _CompanyDetailState extends RefreshableState<CompanyDetailWidget> {
          }
        });

-    InvenTreeCompanyAttachment().countAttachments(widget.company.pk).then((
-      value,
-    ) {
-      if (mounted) {
-        setState(() {
-          attachmentCount = value;
+    InvenTreeAttachment()
+        .countAttachments(InvenTreeCompany.MODEL_TYPE, widget.company.pk)
+        .then((value) {
+          if (mounted) {
+            setState(() {
+              attachmentCount = value;
+            });
+          }
        });
-      }
-    });
  }

  Future<void> editCompany(BuildContext context) async {
@ -393,29 +394,19 @@ class _CompanyDetailState extends RefreshableState<CompanyDetailWidget> {
      );
    }

-    tiles.add(
-      ListTile(
-        title: Text(L10().attachments),
-        leading: Icon(TablerIcons.file, color: COLOR_ACTION),
-        trailing: LinkIcon(
-          text: attachmentCount > 0 ? attachmentCount.toString() : null,
-        ),
-        onTap: () {
-          Navigator.push(
-            context,
-            MaterialPageRoute(
-              builder: (context) => AttachmentWidget(
-                InvenTreeCompanyAttachment(),
-                widget.company.pk,
-                widget.company.name,
-                InvenTreeCompany().canEdit,
-              ),
-            ),
-          );
-        },
-      ),
+    ListTile? attachmentTile = ShowAttachmentsItem(
+      context,
+      InvenTreeCompany.MODEL_TYPE,
+      widget.company.pk,
+      widget.company.name,
+      attachmentCount,
+      widget.company.canEdit,
    );

+    if (attachmentTile != null) {
+      tiles.add(attachmentTile);
+    }
+
    return tiles;
  }
 }
--- a/lib/widget/order/purchase_order_detail.dart
+++ b/lib/widget/order/purchase_order_detail.dart
@ -7,6 +7,7 @@ import "package:inventree/app_colors.dart";
 import "package:inventree/barcode/barcode.dart";
 import "package:inventree/barcode/purchase_order.dart";
 import "package:inventree/helpers.dart";
+import "package:inventree/inventree/attachment.dart";
 import "package:inventree/l10.dart";

 import "package:inventree/inventree/model.dart";
@ -174,8 +175,12 @@ class _PurchaseOrderDetailState

  /// Upload an image against the current PurchaseOrder
  Future<void> _uploadImage(BuildContext context) async {
-    InvenTreePurchaseOrderAttachment()
-        .uploadImage(widget.order.pk, prefix: widget.order.reference)
+    InvenTreeAttachment()
+        .uploadImage(
+          InvenTreePurchaseOrder.MODEL_TYPE,
+          widget.order.pk,
+          prefix: widget.order.reference,
+        )
        .then((result) => refresh(context));
  }

@ -295,15 +300,15 @@ class _PurchaseOrderDetailState
      }
    }

-    InvenTreePurchaseOrderAttachment().countAttachments(widget.order.pk).then((
-      int value,
-    ) {
-      if (mounted) {
-        setState(() {
-          attachmentCount = value;
+    InvenTreeAttachment()
+        .countAttachments(InvenTreePurchaseOrder.MODEL_TYPE, widget.order.pk)
+        .then((int value) {
+          if (mounted) {
+            setState(() {
+              attachmentCount = value;
+            });
+          }
        });
-      }
-    });

    if (api.supportsPurchaseOrderDestination &&
        widget.order.destinationId > 0) {
@ -565,30 +570,19 @@ class _PurchaseOrderDetailState
      ),
    );

-    // Attachments
-    tiles.add(
-      ListTile(
-        title: Text(L10().attachments),
-        leading: Icon(TablerIcons.file, color: COLOR_ACTION),
-        trailing: LinkIcon(
-          text: attachmentCount > 0 ? attachmentCount.toString() : null,
-        ),
-        onTap: () {
-          Navigator.push(
-            context,
-            MaterialPageRoute(
-              builder: (context) => AttachmentWidget(
-                InvenTreePurchaseOrderAttachment(),
-                widget.order.pk,
-                widget.order.reference,
-                widget.order.canEdit,
-              ),
-            ),
-          );
-        },
-      ),
+    ListTile? attachmentTile = ShowAttachmentsItem(
+      context,
+      InvenTreePurchaseOrder.MODEL_TYPE,
+      widget.order.pk,
+      widget.order.reference,
+      attachmentCount,
+      widget.order.canEdit,
    );

+    if (attachmentTile != null) {
+      tiles.add(attachmentTile);
+    }
+
    return tiles;
  }

--- a/lib/widget/order/sales_order_detail.dart
+++ b/lib/widget/order/sales_order_detail.dart
@ -3,6 +3,7 @@ import "package:flutter_speed_dial/flutter_speed_dial.dart";
 import "package:flutter_tabler_icons/flutter_tabler_icons.dart";
 import "package:inventree/barcode/barcode.dart";
 import "package:inventree/barcode/sales_order.dart";
+import "package:inventree/inventree/attachment.dart";
 import "package:inventree/inventree/company.dart";
 import "package:inventree/inventree/sales_order.dart";
 import "package:inventree/preferences.dart";
@ -108,8 +109,12 @@ class _SalesOrderDetailState extends RefreshableState<SalesOrderDetailWidget> {

  /// Upload an image for this order
  Future<void> _uploadImage(BuildContext context) async {
-    InvenTreeSalesOrderAttachment()
-        .uploadImage(widget.order.pk, prefix: widget.order.reference)
+    InvenTreeAttachment()
+        .uploadImage(
+          InvenTreeSalesOrder.MODEL_TYPE,
+          widget.order.pk,
+          prefix: widget.order.reference,
+        )
        .then((result) => refresh(context));
  }

@ -266,15 +271,15 @@ class _SalesOrderDetailState extends RefreshableState<SalesOrderDetailWidget> {
      true,
    );

-    InvenTreeSalesOrderAttachment().countAttachments(widget.order.pk).then((
-      int value,
-    ) {
-      if (mounted) {
-        setState(() {
-          attachmentCount = value;
+    InvenTreeAttachment()
+        .countAttachments(InvenTreeSalesOrder.MODEL_TYPE, widget.order.pk)
+        .then((int value) {
+          if (mounted) {
+            setState(() {
+              attachmentCount = value;
+            });
+          }
        });
-      }
-    });

    // Count number of "extra line items" against this order
    InvenTreeSOExtraLineItem()
@ -492,30 +497,19 @@ class _SalesOrderDetailState extends RefreshableState<SalesOrderDetailWidget> {
      ),
    );

-    // Attachments
-    tiles.add(
-      ListTile(
-        title: Text(L10().attachments),
-        leading: Icon(TablerIcons.file, color: COLOR_ACTION),
-        trailing: LinkIcon(
-          text: attachmentCount > 0 ? attachmentCount.toString() : null,
-        ),
-        onTap: () {
-          Navigator.push(
-            context,
-            MaterialPageRoute(
-              builder: (context) => AttachmentWidget(
-                InvenTreeSalesOrderAttachment(),
-                widget.order.pk,
-                widget.order.reference,
-                widget.order.canEdit,
-              ),
-            ),
-          );
-        },
-      ),
+    ListTile? attachmentTile = ShowAttachmentsItem(
+      context,
+      InvenTreeSalesOrder.MODEL_TYPE,
+      widget.order.pk,
+      widget.order.reference,
+      attachmentCount,
+      widget.order.canEdit,
    );

+    if (attachmentTile != null) {
+      tiles.add(attachmentTile);
+    }
+
    return tiles;
  }

--- a/lib/widget/order/so_shipment_detail.dart
+++ b/lib/widget/order/so_shipment_detail.dart
@ -8,6 +8,7 @@ import "package:flutter_tabler_icons/flutter_tabler_icons.dart";
 import "package:inventree/api.dart";
 import "package:inventree/api_form.dart";
 import "package:inventree/app_colors.dart";
+import "package:inventree/inventree/attachment.dart";
 import "package:inventree/inventree/sales_order.dart";
 import "package:inventree/l10.dart";
 import "package:inventree/preferences.dart";
@ -91,8 +92,11 @@ class _SOShipmentDetailWidgetState
      });
    }

-    InvenTreeSalesOrderShipmentAttachment()
-        .countAttachments(widget.shipment.pk)
+    InvenTreeAttachment()
+        .countAttachments(
+          InvenTreeSalesOrderShipment.MODEL_TYPE,
+          widget.shipment.pk,
+        )
        .then((int value) {
          if (mounted) {
            setState(() {
@ -104,8 +108,12 @@ class _SOShipmentDetailWidgetState

  /// Upload an image for this shipment
  Future<void> _uploadImage(BuildContext context) async {
-    InvenTreeSalesOrderShipmentAttachment()
-        .uploadImage(widget.shipment.pk, prefix: widget.shipment.reference)
+    InvenTreeAttachment()
+        .uploadImage(
+          InvenTreeSalesOrderShipment.MODEL_TYPE,
+          widget.shipment.pk,
+          prefix: widget.shipment.reference,
+        )
        .then((result) => refresh(context));
  }

@ -339,30 +347,19 @@ class _SOShipmentDetailWidgetState
      ),
    );

-    // Attachments
-    tiles.add(
-      ListTile(
-        title: Text(L10().attachments),
-        leading: Icon(TablerIcons.file, color: COLOR_ACTION),
-        trailing: LinkIcon(
-          text: attachmentCount > 0 ? attachmentCount.toString() : null,
-        ),
-        onTap: () {
-          Navigator.push(
-            context,
-            MaterialPageRoute(
-              builder: (context) => AttachmentWidget(
-                InvenTreeSalesOrderShipmentAttachment(),
-                widget.shipment.pk,
-                widget.shipment.reference,
-                widget.shipment.canEdit,
-              ),
-            ),
-          );
-        },
-      ),
+    ListTile? attachmentTile = ShowAttachmentsItem(
+      context,
+      InvenTreeSalesOrderShipment.MODEL_TYPE,
+      widget.shipment.pk,
+      widget.shipment.reference,
+      attachmentCount,
+      widget.shipment.canEdit,
    );

+    if (attachmentTile != null) {
+      tiles.add(attachmentTile);
+    }
+
    return tiles;
  }

--- a/lib/widget/part/part_detail.dart
+++ b/lib/widget/part/part_detail.dart
@ -4,6 +4,7 @@ import "package:flutter_tabler_icons/flutter_tabler_icons.dart";

 import "package:inventree/app_colors.dart";
 import "package:inventree/barcode/barcode.dart";
+import "package:inventree/inventree/attachment.dart";
 import "package:inventree/l10.dart";
 import "package:inventree/helpers.dart";

@ -212,13 +213,15 @@ class _PartDisplayState extends RefreshableState<PartDetailWidget> {
    }

    // Request the number of attachments
-    InvenTreePartAttachment().countAttachments(part.pk).then((int value) {
-      if (mounted) {
-        setState(() {
-          attachmentCount = value;
+    InvenTreeAttachment()
+        .countAttachments(InvenTreePart.MODEL_TYPE, part.pk)
+        .then((int value) {
+          if (mounted) {
+            setState(() {
+              attachmentCount = value;
+            });
+          }
        });
-      }
-    });

    // If show pricing information?
    if (showPricing) {
@ -596,29 +599,19 @@ class _PartDisplayState extends RefreshableState<PartDetailWidget> {
      ),
    );

-    tiles.add(
-      ListTile(
-        title: Text(L10().attachments),
-        leading: Icon(TablerIcons.file, color: COLOR_ACTION),
-        trailing: LinkIcon(
-          text: attachmentCount > 0 ? attachmentCount.toString() : null,
-        ),
-        onTap: () {
-          Navigator.push(
-            context,
-            MaterialPageRoute(
-              builder: (context) => AttachmentWidget(
-                InvenTreePartAttachment(),
-                part.pk,
-                L10().part,
-                part.canEdit,
-              ),
-            ),
-          );
-        },
-      ),
+    ListTile? attachmentTile = ShowAttachmentsItem(
+      context,
+      InvenTreePart.MODEL_TYPE,
+      part.pk,
+      L10().part,
+      attachmentCount,
+      part.canEdit,
    );

+    if (attachmentTile != null) {
+      tiles.add(attachmentTile);
+    }
+
    return tiles;
  }

--- a/lib/widget/stock/stock_detail.dart
+++ b/lib/widget/stock/stock_detail.dart
@ -7,6 +7,7 @@ import "package:inventree/app_colors.dart";
 import "package:inventree/barcode/barcode.dart";
 import "package:inventree/barcode/stock.dart";
 import "package:inventree/helpers.dart";
+import "package:inventree/inventree/attachment.dart";
 import "package:inventree/inventree/sales_order.dart";
 import "package:inventree/l10.dart";
 import "package:inventree/api.dart";
@ -255,15 +256,15 @@ class _StockItemDisplayState extends RefreshableState<StockDetailWidget> {
    }

    // Request the number of attachments
-    InvenTreeStockItemAttachment().countAttachments(widget.item.pk).then((
-      int value,
-    ) {
-      if (mounted) {
-        setState(() {
-          attachmentCount = value;
+    InvenTreeAttachment()
+        .countAttachments(InvenTreeStockItem.MODEL_TYPE, widget.item.pk)
+        .then((int value) {
+          if (mounted) {
+            setState(() {
+              attachmentCount = value;
+            });
+          }
        });
-      }
-    });

    // Request SalesOrder information
    if (widget.item.hasSalesOrder) {
@ -837,29 +838,19 @@ class _StockItemDisplayState extends RefreshableState<StockDetailWidget> {
      ),
    );

-    tiles.add(
-      ListTile(
-        title: Text(L10().attachments),
-        leading: Icon(TablerIcons.file, color: COLOR_ACTION),
-        trailing: LinkIcon(
-          text: attachmentCount > 0 ? attachmentCount.toString() : null,
-        ),
-        onTap: () {
-          Navigator.push(
-            context,
-            MaterialPageRoute(
-              builder: (context) => AttachmentWidget(
-                InvenTreeStockItemAttachment(),
-                widget.item.pk,
-                L10().stockItem,
-                widget.item.canEdit,
-              ),
-            ),
-          );
-        },
-      ),
+    ListTile? attachmentTile = ShowAttachmentsItem(
+      context,
+      InvenTreeStockItem.MODEL_TYPE,
+      widget.item.pk,
+      L10().stockItem,
+      attachmentCount,
+      widget.item.canEdit,
    );

+    if (attachmentTile != null) {
+      tiles.add(attachmentTile);
+    }
+
    return tiles;
  }
 }