- {% include "stock_table.html" with prevent_new_stock=True %}
+ {% include "stock_table.html" %}
-
+
{% trans "Attachments" %}
{% include "spacer.html" %}
diff --git a/InvenTree/order/templates/order/purchase_orders.html b/InvenTree/order/templates/order/purchase_orders.html
index 4be817f8d2..8ddae982b9 100644
--- a/InvenTree/order/templates/order/purchase_orders.html
+++ b/InvenTree/order/templates/order/purchase_orders.html
@@ -26,19 +26,18 @@
@@ -171,6 +170,7 @@ $("#view-list").click(function() {
$("#view-calendar").show();
});
+{% if report_enabled %}
$("#order-print").click(function() {
var rows = $("#purchase-order-table").bootstrapTable('getSelections');
@@ -182,6 +182,7 @@ $("#order-print").click(function() {
printPurchaseOrderReports(orders);
})
+{% endif %}
$("#po-create").click(function() {
createPurchaseOrder();
diff --git a/InvenTree/order/templates/order/sales_order_base.html b/InvenTree/order/templates/order/sales_order_base.html
index 42a09e8ede..368c3a2e47 100644
--- a/InvenTree/order/templates/order/sales_order_base.html
+++ b/InvenTree/order/templates/order/sales_order_base.html
@@ -16,7 +16,7 @@
{% block thumbnail %}
+ {% include "filter_list.html" with id="salesorder" %}
@@ -175,6 +174,7 @@ loadSalesOrderTable("#sales-order-table", {
url: "{% url 'api-so-list' %}",
});
+{% if report_enabled %}
$("#order-print").click(function() {
var rows = $("#sales-order-table").bootstrapTable('getSelections');
@@ -186,6 +186,7 @@ $("#order-print").click(function() {
printSalesOrderReports(orders);
})
+{% endif %}
$("#so-create").click(function() {
createSalesOrder();
diff --git a/InvenTree/order/test_api.py b/InvenTree/order/test_api.py
index 0f29e5bd16..143a51bdb1 100644
--- a/InvenTree/order/test_api.py
+++ b/InvenTree/order/test_api.py
@@ -350,6 +350,31 @@ class PurchaseOrderReceiveTest(OrderTest):
# No new stock items have been created
self.assertEqual(self.n, StockItem.objects.count())
+ def test_null_barcode(self):
+ """
+ Test than a "null" barcode field can be provided
+ """
+
+ # Set stock item barcode
+ item = StockItem.objects.get(pk=1)
+ item.save()
+
+ # Test with "null" value
+ self.post(
+ self.url,
+ {
+ 'items': [
+ {
+ 'line_item': 1,
+ 'quantity': 50,
+ 'barcode': None,
+ }
+ ],
+ 'location': 1,
+ },
+ expected_code=201
+ )
+
def test_invalid_barcodes(self):
"""
Tests for checking in items with invalid barcodes:
diff --git a/InvenTree/part/admin.py b/InvenTree/part/admin.py
index 2e434d928d..90543d429d 100644
--- a/InvenTree/part/admin.py
+++ b/InvenTree/part/admin.py
@@ -8,13 +8,7 @@ from import_export.resources import ModelResource
from import_export.fields import Field
import import_export.widgets as widgets
-from .models import PartCategory, Part
-from .models import PartAttachment, PartStar, PartRelated
-from .models import BomItem
-from .models import PartParameterTemplate, PartParameter
-from .models import PartCategoryParameterTemplate
-from .models import PartTestTemplate
-from .models import PartSellPriceBreak, PartInternalPriceBreak
+import part.models as models
from stock.models import StockLocation
from company.models import SupplierPart
@@ -24,7 +18,7 @@ class PartResource(ModelResource):
""" Class for managing Part data import/export """
# ForeignKey fields
- category = Field(attribute='category', widget=widgets.ForeignKeyWidget(PartCategory))
+ category = Field(attribute='category', widget=widgets.ForeignKeyWidget(models.PartCategory))
default_location = Field(attribute='default_location', widget=widgets.ForeignKeyWidget(StockLocation))
@@ -32,7 +26,7 @@ class PartResource(ModelResource):
category_name = Field(attribute='category__name', readonly=True)
- variant_of = Field(attribute='variant_of', widget=widgets.ForeignKeyWidget(Part))
+ variant_of = Field(attribute='variant_of', widget=widgets.ForeignKeyWidget(models.Part))
suppliers = Field(attribute='supplier_count', readonly=True)
@@ -48,7 +42,7 @@ class PartResource(ModelResource):
building = Field(attribute='quantity_being_built', readonly=True, widget=widgets.IntegerWidget())
class Meta:
- model = Part
+ model = models.Part
skip_unchanged = True
report_skipped = False
clean_model_instances = True
@@ -86,14 +80,14 @@ class PartAdmin(ImportExportModelAdmin):
class PartCategoryResource(ModelResource):
""" Class for managing PartCategory data import/export """
- parent = Field(attribute='parent', widget=widgets.ForeignKeyWidget(PartCategory))
+ parent = Field(attribute='parent', widget=widgets.ForeignKeyWidget(models.PartCategory))
parent_name = Field(attribute='parent__name', readonly=True)
default_location = Field(attribute='default_location', widget=widgets.ForeignKeyWidget(StockLocation))
class Meta:
- model = PartCategory
+ model = models.PartCategory
skip_unchanged = True
report_skipped = False
clean_model_instances = True
@@ -108,14 +102,14 @@ class PartCategoryResource(ModelResource):
super().after_import(dataset, result, using_transactions, dry_run, **kwargs)
# Rebuild the PartCategory tree(s)
- PartCategory.objects.rebuild()
+ models.PartCategory.objects.rebuild()
class PartCategoryInline(admin.TabularInline):
"""
Inline for PartCategory model
"""
- model = PartCategory
+ model = models.PartCategory
class PartCategoryAdmin(ImportExportModelAdmin):
@@ -146,6 +140,11 @@ class PartStarAdmin(admin.ModelAdmin):
list_display = ('part', 'user')
+class PartCategoryStarAdmin(admin.ModelAdmin):
+
+ list_display = ('category', 'user')
+
+
class PartTestTemplateAdmin(admin.ModelAdmin):
list_display = ('part', 'test_name', 'required')
@@ -159,7 +158,7 @@ class BomItemResource(ModelResource):
bom_id = Field(attribute='pk')
# ID of the parent part
- parent_part_id = Field(attribute='part', widget=widgets.ForeignKeyWidget(Part))
+ parent_part_id = Field(attribute='part', widget=widgets.ForeignKeyWidget(models.Part))
# IPN of the parent part
parent_part_ipn = Field(attribute='part__IPN', readonly=True)
@@ -168,7 +167,7 @@ class BomItemResource(ModelResource):
parent_part_name = Field(attribute='part__name', readonly=True)
# ID of the sub-part
- part_id = Field(attribute='sub_part', widget=widgets.ForeignKeyWidget(Part))
+ part_id = Field(attribute='sub_part', widget=widgets.ForeignKeyWidget(models.Part))
# IPN of the sub-part
part_ipn = Field(attribute='sub_part__IPN', readonly=True)
@@ -233,7 +232,7 @@ class BomItemResource(ModelResource):
return fields
class Meta:
- model = BomItem
+ model = models.BomItem
skip_unchanged = True
report_skipped = False
clean_model_instances = True
@@ -262,16 +261,16 @@ class ParameterTemplateAdmin(ImportExportModelAdmin):
class ParameterResource(ModelResource):
""" Class for managing PartParameter data import/export """
- part = Field(attribute='part', widget=widgets.ForeignKeyWidget(Part))
+ part = Field(attribute='part', widget=widgets.ForeignKeyWidget(models.Part))
part_name = Field(attribute='part__name', readonly=True)
- template = Field(attribute='template', widget=widgets.ForeignKeyWidget(PartParameterTemplate))
+ template = Field(attribute='template', widget=widgets.ForeignKeyWidget(models.PartParameterTemplate))
template_name = Field(attribute='template__name', readonly=True)
class Meta:
- model = PartParameter
+ model = models.PartParameter
skip_unchanged = True
report_skipped = False
clean_model_instance = True
@@ -292,7 +291,7 @@ class PartCategoryParameterAdmin(admin.ModelAdmin):
class PartSellPriceBreakAdmin(admin.ModelAdmin):
class Meta:
- model = PartSellPriceBreak
+ model = models.PartSellPriceBreak
list_display = ('part', 'quantity', 'price',)
@@ -300,20 +299,21 @@ class PartSellPriceBreakAdmin(admin.ModelAdmin):
class PartInternalPriceBreakAdmin(admin.ModelAdmin):
class Meta:
- model = PartInternalPriceBreak
+ model = models.PartInternalPriceBreak
list_display = ('part', 'quantity', 'price',)
-admin.site.register(Part, PartAdmin)
-admin.site.register(PartCategory, PartCategoryAdmin)
-admin.site.register(PartRelated, PartRelatedAdmin)
-admin.site.register(PartAttachment, PartAttachmentAdmin)
-admin.site.register(PartStar, PartStarAdmin)
-admin.site.register(BomItem, BomItemAdmin)
-admin.site.register(PartParameterTemplate, ParameterTemplateAdmin)
-admin.site.register(PartParameter, ParameterAdmin)
-admin.site.register(PartCategoryParameterTemplate, PartCategoryParameterAdmin)
-admin.site.register(PartTestTemplate, PartTestTemplateAdmin)
-admin.site.register(PartSellPriceBreak, PartSellPriceBreakAdmin)
-admin.site.register(PartInternalPriceBreak, PartInternalPriceBreakAdmin)
+admin.site.register(models.Part, PartAdmin)
+admin.site.register(models.PartCategory, PartCategoryAdmin)
+admin.site.register(models.PartRelated, PartRelatedAdmin)
+admin.site.register(models.PartAttachment, PartAttachmentAdmin)
+admin.site.register(models.PartStar, PartStarAdmin)
+admin.site.register(models.PartCategoryStar, PartCategoryStarAdmin)
+admin.site.register(models.BomItem, BomItemAdmin)
+admin.site.register(models.PartParameterTemplate, ParameterTemplateAdmin)
+admin.site.register(models.PartParameter, ParameterAdmin)
+admin.site.register(models.PartCategoryParameterTemplate, PartCategoryParameterAdmin)
+admin.site.register(models.PartTestTemplate, PartTestTemplateAdmin)
+admin.site.register(models.PartSellPriceBreak, PartSellPriceBreakAdmin)
+admin.site.register(models.PartInternalPriceBreak, PartInternalPriceBreakAdmin)
diff --git a/InvenTree/part/api.py b/InvenTree/part/api.py
index a11bb1b088..b08834445c 100644
--- a/InvenTree/part/api.py
+++ b/InvenTree/part/api.py
@@ -58,6 +58,18 @@ class CategoryList(generics.ListCreateAPIView):
queryset = PartCategory.objects.all()
serializer_class = part_serializers.CategorySerializer
+ def get_serializer_context(self):
+
+ ctx = super().get_serializer_context()
+
+ try:
+ ctx['starred_categories'] = [star.category for star in self.request.user.starred_categories.all()]
+ except AttributeError:
+ # Error is thrown if the view does not have an associated request
+ ctx['starred_categories'] = []
+
+ return ctx
+
def filter_queryset(self, queryset):
"""
Custom filtering:
@@ -110,6 +122,18 @@ class CategoryList(generics.ListCreateAPIView):
except (ValueError, PartCategory.DoesNotExist):
pass
+ # Filter by "starred" status
+ starred = params.get('starred', None)
+
+ if starred is not None:
+ starred = str2bool(starred)
+ starred_categories = [star.category.pk for star in self.request.user.starred_categories.all()]
+
+ if starred:
+ queryset = queryset.filter(pk__in=starred_categories)
+ else:
+ queryset = queryset.exclude(pk__in=starred_categories)
+
return queryset
filter_backends = [
@@ -149,6 +173,29 @@ class CategoryDetail(generics.RetrieveUpdateDestroyAPIView):
serializer_class = part_serializers.CategorySerializer
queryset = PartCategory.objects.all()
+ def get_serializer_context(self):
+
+ ctx = super().get_serializer_context()
+
+ try:
+ ctx['starred_categories'] = [star.category for star in self.request.user.starred_categories.all()]
+ except AttributeError:
+ # Error is thrown if the view does not have an associated request
+ ctx['starred_categories'] = []
+
+ return ctx
+
+ def update(self, request, *args, **kwargs):
+
+ if 'starred' in request.data:
+ starred = str2bool(request.data.get('starred', False))
+
+ self.get_object().set_starred(request.user, starred)
+
+ response = super().update(request, *args, **kwargs)
+
+ return response
+
class CategoryParameterList(generics.ListAPIView):
""" API endpoint for accessing a list of PartCategoryParameterTemplate objects.
@@ -389,7 +436,7 @@ class PartDetail(generics.RetrieveUpdateDestroyAPIView):
# Ensure the request context is passed through
kwargs['context'] = self.get_serializer_context()
- # Pass a list of "starred" parts fo the current user to the serializer
+ # Pass a list of "starred" parts of the current user to the serializer
# We do this to reduce the number of database queries required!
if self.starred_parts is None and self.request is not None:
self.starred_parts = [star.part for star in self.request.user.starred_parts.all()]
@@ -418,9 +465,9 @@ class PartDetail(generics.RetrieveUpdateDestroyAPIView):
"""
if 'starred' in request.data:
- starred = str2bool(request.data.get('starred', None))
+ starred = str2bool(request.data.get('starred', False))
- self.get_object().setStarred(request.user, starred)
+ self.get_object().set_starred(request.user, starred)
response = super().update(request, *args, **kwargs)
diff --git a/InvenTree/part/bom.py b/InvenTree/part/bom.py
index f67e4ffe8f..fd31aba339 100644
--- a/InvenTree/part/bom.py
+++ b/InvenTree/part/bom.py
@@ -7,7 +7,7 @@ from collections import OrderedDict
from django.utils.translation import gettext as _
-from InvenTree.helpers import DownloadFile, GetExportFormats
+from InvenTree.helpers import DownloadFile, GetExportFormats, normalize
from .admin import BomItemResource
from .models import BomItem
@@ -59,7 +59,7 @@ def ExportBom(part, fmt='csv', cascade=False, max_levels=None, parameter_data=Fa
uids = []
- def add_items(items, level):
+ def add_items(items, level, cascade):
# Add items at a given layer
for item in items:
@@ -71,21 +71,13 @@ def ExportBom(part, fmt='csv', cascade=False, max_levels=None, parameter_data=Fa
bom_items.append(item)
- if item.sub_part.assembly:
+ if cascade and item.sub_part.assembly:
if max_levels is None or level < max_levels:
add_items(item.sub_part.bom_items.all().order_by('id'), level + 1)
- if cascade:
- # Cascading (multi-level) BOM
+ top_level_items = part.get_bom_items().order_by('id')
- # Start with the top level
- items_to_process = part.bom_items.all().order_by('id')
-
- add_items(items_to_process, 1)
-
- else:
- # No cascading needed - just the top-level items
- bom_items = [item for item in part.bom_items.all().order_by('id')]
+ add_items(top_level_items, 1, cascade)
dataset = BomItemResource().export(queryset=bom_items, cascade=cascade)
@@ -148,8 +140,9 @@ def ExportBom(part, fmt='csv', cascade=False, max_levels=None, parameter_data=Fa
stock_data.append('')
except AttributeError:
stock_data.append('')
+
# Get part current stock
- stock_data.append(str(bom_item.sub_part.available_stock))
+ stock_data.append(str(normalize(bom_item.sub_part.available_stock)))
for s_idx, header in enumerate(stock_headers):
try:
@@ -160,171 +153,108 @@ def ExportBom(part, fmt='csv', cascade=False, max_levels=None, parameter_data=Fa
# Add stock columns to dataset
add_columns_to_dataset(stock_cols, len(bom_items))
- if manufacturer_data and supplier_data:
+ if manufacturer_data or supplier_data:
"""
If requested, add extra columns for each SupplierPart and ManufacturerPart associated with each line item
"""
- # Expand dataset with manufacturer parts
- manufacturer_headers = [
- _('Manufacturer'),
- _('MPN'),
- ]
-
- supplier_headers = [
- _('Supplier'),
- _('SKU'),
- ]
+ # Keep track of the supplier parts we have already exported
+ supplier_parts_used = set()
manufacturer_cols = {}
- for b_idx, bom_item in enumerate(bom_items):
+ for bom_idx, bom_item in enumerate(bom_items):
# Get part instance
b_part = bom_item.sub_part
- # Filter manufacturer parts
- manufacturer_parts = ManufacturerPart.objects.filter(part__pk=b_part.pk)
- manufacturer_parts = manufacturer_parts.prefetch_related('supplier_parts')
+ # Include manufacturer data for each BOM item
+ if manufacturer_data:
- # Process manufacturer part
- for manufacturer_idx, manufacturer_part in enumerate(manufacturer_parts):
+ # Filter manufacturer parts
+ manufacturer_parts = ManufacturerPart.objects.filter(part__pk=b_part.pk).prefetch_related('supplier_parts')
+
+ for mp_idx, mp_part in enumerate(manufacturer_parts):
- if manufacturer_part and manufacturer_part.manufacturer:
- manufacturer_name = manufacturer_part.manufacturer.name
- else:
- manufacturer_name = ''
+ # Extract the "name" field of the Manufacturer (Company)
+ if mp_part and mp_part.manufacturer:
+ manufacturer_name = mp_part.manufacturer.name
+ else:
+ manufacturer_name = ''
- if manufacturer_part:
- manufacturer_mpn = manufacturer_part.MPN
- else:
- manufacturer_mpn = ''
+ # Extract the "MPN" field from the Manufacturer Part
+ if mp_part:
+ manufacturer_mpn = mp_part.MPN
+ else:
+ manufacturer_mpn = ''
- # Generate column names for this manufacturer
- k_man = manufacturer_headers[0] + "_" + str(manufacturer_idx)
- k_mpn = manufacturer_headers[1] + "_" + str(manufacturer_idx)
+ # Generate a column name for this manufacturer
+ k_man = f'{_("Manufacturer")}_{mp_idx}'
+ k_mpn = f'{_("MPN")}_{mp_idx}'
+
+ try:
+ manufacturer_cols[k_man].update({bom_idx: manufacturer_name})
+ manufacturer_cols[k_mpn].update({bom_idx: manufacturer_mpn})
+ except KeyError:
+ manufacturer_cols[k_man] = {bom_idx: manufacturer_name}
+ manufacturer_cols[k_mpn] = {bom_idx: manufacturer_mpn}
- try:
- manufacturer_cols[k_man].update({b_idx: manufacturer_name})
- manufacturer_cols[k_mpn].update({b_idx: manufacturer_mpn})
- except KeyError:
- manufacturer_cols[k_man] = {b_idx: manufacturer_name}
- manufacturer_cols[k_mpn] = {b_idx: manufacturer_mpn}
+ # We wish to include supplier data for this manufacturer part
+ if supplier_data:
+
+ for sp_idx, sp_part in enumerate(mp_part.supplier_parts.all()):
- # Process supplier parts
- for supplier_idx, supplier_part in enumerate(manufacturer_part.supplier_parts.all()):
+ supplier_parts_used.add(sp_part)
- if supplier_part.supplier and supplier_part.supplier:
- supplier_name = supplier_part.supplier.name
+ if sp_part.supplier and sp_part.supplier:
+ supplier_name = sp_part.supplier.name
+ else:
+ supplier_name = ''
+
+ if sp_part:
+ supplier_sku = sp_part.SKU
+ else:
+ supplier_sku = ''
+
+ # Generate column names for this supplier
+ k_sup = str(_("Supplier")) + "_" + str(mp_idx) + "_" + str(sp_idx)
+ k_sku = str(_("SKU")) + "_" + str(mp_idx) + "_" + str(sp_idx)
+
+ try:
+ manufacturer_cols[k_sup].update({bom_idx: supplier_name})
+ manufacturer_cols[k_sku].update({bom_idx: supplier_sku})
+ except KeyError:
+ manufacturer_cols[k_sup] = {bom_idx: supplier_name}
+ manufacturer_cols[k_sku] = {bom_idx: supplier_sku}
+
+ if supplier_data:
+ # Add in any extra supplier parts, which are not associated with a manufacturer part
+
+ for sp_idx, sp_part in enumerate(SupplierPart.objects.filter(part__pk=b_part.pk)):
+
+ if sp_part in supplier_parts_used:
+ continue
+
+ supplier_parts_used.add(sp_part)
+
+ if sp_part.supplier:
+ supplier_name = sp_part.supplier.name
else:
supplier_name = ''
- if supplier_part:
- supplier_sku = supplier_part.SKU
- else:
- supplier_sku = ''
+ supplier_sku = sp_part.SKU
# Generate column names for this supplier
- k_sup = str(supplier_headers[0]) + "_" + str(manufacturer_idx) + "_" + str(supplier_idx)
- k_sku = str(supplier_headers[1]) + "_" + str(manufacturer_idx) + "_" + str(supplier_idx)
+ k_sup = str(_("Supplier")) + "_" + str(sp_idx)
+ k_sku = str(_("SKU")) + "_" + str(sp_idx)
try:
- manufacturer_cols[k_sup].update({b_idx: supplier_name})
- manufacturer_cols[k_sku].update({b_idx: supplier_sku})
+ manufacturer_cols[k_sup].update({bom_idx: supplier_name})
+ manufacturer_cols[k_sku].update({bom_idx: supplier_sku})
except KeyError:
- manufacturer_cols[k_sup] = {b_idx: supplier_name}
- manufacturer_cols[k_sku] = {b_idx: supplier_sku}
+ manufacturer_cols[k_sup] = {bom_idx: supplier_name}
+ manufacturer_cols[k_sku] = {bom_idx: supplier_sku}
- # Add manufacturer columns to dataset
- add_columns_to_dataset(manufacturer_cols, len(bom_items))
-
- elif manufacturer_data:
- """
- If requested, add extra columns for each ManufacturerPart associated with each line item
- """
-
- # Expand dataset with manufacturer parts
- manufacturer_headers = [
- _('Manufacturer'),
- _('MPN'),
- ]
-
- manufacturer_cols = {}
-
- for b_idx, bom_item in enumerate(bom_items):
- # Get part instance
- b_part = bom_item.sub_part
-
- # Filter supplier parts
- manufacturer_parts = ManufacturerPart.objects.filter(part__pk=b_part.pk)
-
- for idx, manufacturer_part in enumerate(manufacturer_parts):
-
- if manufacturer_part:
- manufacturer_name = manufacturer_part.manufacturer.name
- else:
- manufacturer_name = ''
-
- manufacturer_mpn = manufacturer_part.MPN
-
- # Add manufacturer data to the manufacturer columns
-
- # Generate column names for this manufacturer
- k_man = manufacturer_headers[0] + "_" + str(idx)
- k_mpn = manufacturer_headers[1] + "_" + str(idx)
-
- try:
- manufacturer_cols[k_man].update({b_idx: manufacturer_name})
- manufacturer_cols[k_mpn].update({b_idx: manufacturer_mpn})
- except KeyError:
- manufacturer_cols[k_man] = {b_idx: manufacturer_name}
- manufacturer_cols[k_mpn] = {b_idx: manufacturer_mpn}
-
- # Add manufacturer columns to dataset
- add_columns_to_dataset(manufacturer_cols, len(bom_items))
-
- elif supplier_data:
- """
- If requested, add extra columns for each SupplierPart associated with each line item
- """
-
- # Expand dataset with manufacturer parts
- manufacturer_headers = [
- _('Supplier'),
- _('SKU'),
- ]
-
- manufacturer_cols = {}
-
- for b_idx, bom_item in enumerate(bom_items):
- # Get part instance
- b_part = bom_item.sub_part
-
- # Filter supplier parts
- supplier_parts = SupplierPart.objects.filter(part__pk=b_part.pk)
-
- for idx, supplier_part in enumerate(supplier_parts):
-
- if supplier_part.supplier:
- supplier_name = supplier_part.supplier.name
- else:
- supplier_name = ''
-
- supplier_sku = supplier_part.SKU
-
- # Add manufacturer data to the manufacturer columns
-
- # Generate column names for this supplier
- k_sup = manufacturer_headers[0] + "_" + str(idx)
- k_sku = manufacturer_headers[1] + "_" + str(idx)
-
- try:
- manufacturer_cols[k_sup].update({b_idx: supplier_name})
- manufacturer_cols[k_sku].update({b_idx: supplier_sku})
- except KeyError:
- manufacturer_cols[k_sup] = {b_idx: supplier_name}
- manufacturer_cols[k_sku] = {b_idx: supplier_sku}
-
- # Add manufacturer columns to dataset
+ # Add supplier columns to dataset
add_columns_to_dataset(manufacturer_cols, len(bom_items))
data = dataset.export(fmt)
diff --git a/InvenTree/part/migrations/0074_partcategorystar.py b/InvenTree/part/migrations/0074_partcategorystar.py
new file mode 100644
index 0000000000..0015212d2e
--- /dev/null
+++ b/InvenTree/part/migrations/0074_partcategorystar.py
@@ -0,0 +1,27 @@
+# Generated by Django 3.2.5 on 2021-11-03 07:03
+
+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),
+ ('part', '0073_auto_20211013_1048'),
+ ]
+
+ operations = [
+ migrations.CreateModel(
+ name='PartCategoryStar',
+ fields=[
+ ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+ ('category', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='starred_users', to='part.partcategory', verbose_name='Category')),
+ ('user', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='starred_categories', to=settings.AUTH_USER_MODEL, verbose_name='User')),
+ ],
+ options={
+ 'unique_together': {('category', 'user')},
+ },
+ ),
+ ]
diff --git a/InvenTree/part/models.py b/InvenTree/part/models.py
index 5cd9fa3180..e77008b076 100644
--- a/InvenTree/part/models.py
+++ b/InvenTree/part/models.py
@@ -20,7 +20,7 @@ from django.db.models.functions import Coalesce
from django.core.validators import MinValueValidator
from django.contrib.auth.models import User
-from django.db.models.signals import pre_delete
+from django.db.models.signals import pre_delete, post_save
from django.dispatch import receiver
from jinja2 import Template
@@ -47,6 +47,7 @@ from InvenTree import validators
from InvenTree.models import InvenTreeTree, InvenTreeAttachment
from InvenTree.fields import InvenTreeURLField
from InvenTree.helpers import decimal2string, normalize, decimal2money
+import InvenTree.tasks
from InvenTree.status_codes import BuildStatus, PurchaseOrderStatus, SalesOrderStatus
@@ -56,6 +57,7 @@ from company.models import SupplierPart
from stock import models as StockModels
import common.models
+
import part.settings as part_settings
@@ -102,11 +104,11 @@ class PartCategory(InvenTreeTree):
if cascade:
""" Select any parts which exist in this category or any child categories """
- query = Part.objects.filter(category__in=self.getUniqueChildren(include_self=True))
+ queryset = Part.objects.filter(category__in=self.getUniqueChildren(include_self=True))
else:
- query = Part.objects.filter(category=self.pk)
+ queryset = Part.objects.filter(category=self.pk)
- return query
+ return queryset
@property
def item_count(self):
@@ -201,6 +203,60 @@ class PartCategory(InvenTreeTree):
return prefetch.filter(category=self.id)
+ def get_subscribers(self, include_parents=True):
+ """
+ Return a list of users who subscribe to this PartCategory
+ """
+
+ cats = self.get_ancestors(include_self=True)
+
+ subscribers = set()
+
+ if include_parents:
+ queryset = PartCategoryStar.objects.filter(
+ category__pk__in=[cat.pk for cat in cats]
+ )
+ else:
+ queryset = PartCategoryStar.objects.filter(
+ category=self,
+ )
+
+ for result in queryset:
+ subscribers.add(result.user)
+
+ return [s for s in subscribers]
+
+ def is_starred_by(self, user, **kwargs):
+ """
+ Returns True if the specified user subscribes to this category
+ """
+
+ return user in self.get_subscribers(**kwargs)
+
+ def set_starred(self, user, status):
+ """
+ Set the "subscription" status of this PartCategory against the specified user
+ """
+
+ if not user:
+ return
+
+ if self.is_starred_by(user) == status:
+ return
+
+ if status:
+ PartCategoryStar.objects.create(
+ category=self,
+ user=user
+ )
+ else:
+ # Note that this won't actually stop the user being subscribed,
+ # if the user is subscribed to a parent category
+ PartCategoryStar.objects.filter(
+ category=self,
+ user=user,
+ ).delete()
+
@receiver(pre_delete, sender=PartCategory, dispatch_uid='partcategory_delete_log')
def before_delete_part_category(sender, instance, using, **kwargs):
@@ -332,9 +388,16 @@ class Part(MPTTModel):
context = {}
- context['starred'] = self.isStarredBy(request.user)
context['disabled'] = not self.active
+ # Subscription status
+ context['starred'] = self.is_starred_by(request.user)
+ context['starred_directly'] = context['starred'] and self.is_starred_by(
+ request.user,
+ include_variants=False,
+ include_categories=False
+ )
+
# Pre-calculate complex queries so they only need to be performed once
context['total_stock'] = self.total_stock
@@ -1040,30 +1103,65 @@ class Part(MPTTModel):
return self.total_stock - self.allocation_count() + self.on_order
- def isStarredBy(self, user):
- """ Return True if this part has been starred by a particular user """
-
- try:
- PartStar.objects.get(part=self, user=user)
- return True
- except PartStar.DoesNotExist:
- return False
-
- def setStarred(self, user, starred):
+ def get_subscribers(self, include_variants=True, include_categories=True):
"""
- Set the "starred" status of this Part for the given user
+ Return a list of users who are 'subscribed' to this part.
+
+ A user may 'subscribe' to this part in the following ways:
+
+ a) Subscribing to the part instance directly
+ b) Subscribing to a template part "above" this part (if it is a variant)
+ c) Subscribing to the part category that this part belongs to
+ d) Subscribing to a parent category of the category in c)
+
+ """
+
+ subscribers = set()
+
+ # Start by looking at direct subscriptions to a Part model
+ queryset = PartStar.objects.all()
+
+ if include_variants:
+ queryset = queryset.filter(
+ part__pk__in=[part.pk for part in self.get_ancestors(include_self=True)]
+ )
+ else:
+ queryset = queryset.filter(part=self)
+
+ for star in queryset:
+ subscribers.add(star.user)
+
+ if include_categories and self.category:
+
+ for sub in self.category.get_subscribers():
+ subscribers.add(sub)
+
+ return [s for s in subscribers]
+
+ def is_starred_by(self, user, **kwargs):
+ """
+ Return True if the specified user subscribes to this part
+ """
+
+ return user in self.get_subscribers(**kwargs)
+
+ def set_starred(self, user, status):
+ """
+ Set the "subscription" status of this Part against the specified user
"""
if not user:
return
- # Do not duplicate efforts
- if self.isStarredBy(user) == starred:
+ # Already subscribed?
+ if self.is_starred_by(user) == status:
return
- if starred:
+ if status:
PartStar.objects.create(part=self, user=user)
else:
+ # Note that this won't actually stop the user being subscribed,
+ # if the user is subscribed to a parent part or category
PartStar.objects.filter(part=self, user=user).delete()
def need_to_restock(self):
@@ -1226,6 +1324,17 @@ class Part(MPTTModel):
return query
+ def get_stock_count(self, include_variants=True):
+ """
+ Return the total "in stock" count for this part
+ """
+
+ entries = self.stock_entries(in_stock=True, include_variants=include_variants)
+
+ query = entries.aggregate(t=Coalesce(Sum('quantity'), Decimal(0)))
+
+ return query['t']
+
@property
def total_stock(self):
""" Return the total stock quantity for this part.
@@ -1234,11 +1343,7 @@ class Part(MPTTModel):
- If this part is a "template" (variants exist) then these are counted too
"""
- entries = self.stock_entries(in_stock=True)
-
- query = entries.aggregate(t=Coalesce(Sum('quantity'), Decimal(0)))
-
- return query['t']
+ return self.get_stock_count()
def get_bom_item_filter(self, include_inherited=True):
"""
@@ -1287,6 +1392,27 @@ class Part(MPTTModel):
return BomItem.objects.filter(self.get_bom_item_filter(include_inherited=include_inherited))
+ def get_installed_part_options(self, include_inherited=True, include_variants=True):
+ """
+ Return a set of all Parts which can be "installed" into this part, based on the BOM.
+
+ arguments:
+ include_inherited - If set, include BomItem entries defined for parent parts
+ include_variants - If set, include variant parts for BomItems which allow variants
+ """
+
+ parts = set()
+
+ for bom_item in self.get_bom_items(include_inherited=include_inherited):
+
+ if include_variants and bom_item.allow_variants:
+ for part in bom_item.sub_part.get_descendants(include_self=True):
+ parts.add(part)
+ else:
+ parts.add(bom_item.sub_part)
+
+ return parts
+
def get_used_in_filter(self, include_inherited=True):
"""
Return a query filter for all parts that this part is used in.
@@ -1945,10 +2071,10 @@ class Part(MPTTModel):
if self.variant_of:
parts.append(self.variant_of)
- siblings = self.get_siblings(include_self=False)
+ siblings = self.get_siblings(include_self=False)
- for sib in siblings:
- parts.append(sib)
+ for sib in siblings:
+ parts.append(sib)
filtered_parts = Part.objects.filter(pk__in=[part.pk for part in parts])
@@ -1988,6 +2114,26 @@ class Part(MPTTModel):
def related_count(self):
return len(self.get_related_parts())
+ def is_part_low_on_stock(self):
+ """
+ Returns True if the total stock for this part is less than the minimum stock level
+ """
+
+ return self.get_stock_count() < self.minimum_stock
+
+
+@receiver(post_save, sender=Part, dispatch_uid='part_post_save_log')
+def after_save_part(sender, instance: Part, created, **kwargs):
+ """
+ Function to be executed after a Part is saved
+ """
+
+ if not created:
+ # Check part stock only if we are *updating* the part (not creating it)
+
+ # Run this check in the background
+ InvenTree.tasks.offload_task('part.tasks.notify_low_stock_if_required', instance)
+
def attach_file(instance, filename):
""" Function for storing a file for a PartAttachment
@@ -2059,10 +2205,9 @@ class PartInternalPriceBreak(common.models.PriceBreak):
class PartStar(models.Model):
- """ A PartStar object creates a relationship between a User and a Part.
+ """ A PartStar object creates a subscription relationship between a User and a Part.
- It is used to designate a Part as 'starred' (or favourited) for a given User,
- so that the user can track a list of their favourite parts.
+ It is used to designate a Part as 'subscribed' for a given User.
Attributes:
part: Link to a Part object
@@ -2074,7 +2219,30 @@ class PartStar(models.Model):
user = models.ForeignKey(User, on_delete=models.CASCADE, verbose_name=_('User'), related_name='starred_parts')
class Meta:
- unique_together = ['part', 'user']
+ unique_together = [
+ 'part',
+ 'user'
+ ]
+
+
+class PartCategoryStar(models.Model):
+ """
+ A PartCategoryStar creates a subscription relationship between a User and a PartCategory.
+
+ Attributes:
+ category: Link to a PartCategory object
+ user: Link to a User object
+ """
+
+ category = models.ForeignKey(PartCategory, on_delete=models.CASCADE, verbose_name=_('Category'), related_name='starred_users')
+
+ user = models.ForeignKey(User, on_delete=models.CASCADE, verbose_name=_('User'), related_name='starred_categories')
+
+ class Meta:
+ unique_together = [
+ 'category',
+ 'user',
+ ]
class PartTestTemplate(models.Model):
diff --git a/InvenTree/part/serializers.py b/InvenTree/part/serializers.py
index ff1fb2c8c6..47ce3f66c8 100644
--- a/InvenTree/part/serializers.py
+++ b/InvenTree/part/serializers.py
@@ -33,12 +33,25 @@ from .models import (BomItem, BomItemSubstitute,
class CategorySerializer(InvenTreeModelSerializer):
""" Serializer for PartCategory """
+ def __init__(self, *args, **kwargs):
+
+ super().__init__(*args, **kwargs)
+
+ def get_starred(self, category):
+ """
+ Return True if the category is directly "starred" by the current user
+ """
+
+ return category in self.context.get('starred_categories', [])
+
url = serializers.CharField(source='get_absolute_url', read_only=True)
parts = serializers.IntegerField(source='item_count', read_only=True)
level = serializers.IntegerField(read_only=True)
+ starred = serializers.SerializerMethodField()
+
class Meta:
model = PartCategory
fields = [
@@ -51,6 +64,7 @@ class CategorySerializer(InvenTreeModelSerializer):
'parent',
'parts',
'pathstring',
+ 'starred',
'url',
]
@@ -241,6 +255,9 @@ class PartSerializer(InvenTreeModelSerializer):
to reduce database trips.
"""
+ # TODO: Update the "in_stock" annotation to include stock for variants of the part
+ # Ref: https://github.com/inventree/InvenTree/issues/2240
+
# Annotate with the total 'in stock' quantity
queryset = queryset.annotate(
in_stock=Coalesce(
diff --git a/InvenTree/part/tasks.py b/InvenTree/part/tasks.py
new file mode 100644
index 0000000000..0cd9cf09a7
--- /dev/null
+++ b/InvenTree/part/tasks.py
@@ -0,0 +1,77 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+import logging
+from datetime import timedelta
+
+from django.utils.translation import ugettext_lazy as _
+from django.template.loader import render_to_string
+
+from allauth.account.models import EmailAddress
+
+from common.models import NotificationEntry
+
+import InvenTree.helpers
+import InvenTree.tasks
+
+import part.models
+
+logger = logging.getLogger("inventree")
+
+
+def notify_low_stock(part: part.models.Part):
+ """
+ Notify users who have starred a part when its stock quantity falls below the minimum threshold
+ """
+
+ # Check if we have notified recently...
+ delta = timedelta(days=1)
+
+ if NotificationEntry.check_recent('part.notify_low_stock', part.pk, delta):
+ logger.info(f"Low stock notification has recently been sent for '{part.full_name}' - SKIPPING")
+ return
+
+ logger.info(f"Sending low stock notification email for {part.full_name}")
+
+ # Get a list of users who are subcribed to this part
+ subscribers = part.get_subscribers()
+
+ emails = EmailAddress.objects.filter(
+ user__in=subscribers,
+ )
+
+ # TODO: In the future, include the part image in the email template
+
+ if len(emails) > 0:
+ logger.info(f"Notify users regarding low stock of {part.name}")
+ context = {
+ # Pass the "Part" object through to the template context
+ 'part': part,
+ 'link': InvenTree.helpers.construct_absolute_url(part.get_absolute_url()),
+ }
+
+ subject = "[InvenTree] " + _("Low stock notification")
+ html_message = render_to_string('email/low_stock_notification.html', context)
+ recipients = emails.values_list('email', flat=True)
+
+ InvenTree.tasks.send_email(subject, '', recipients, html_message=html_message)
+
+ NotificationEntry.notify('part.notify_low_stock', part.pk)
+
+
+def notify_low_stock_if_required(part: part.models.Part):
+ """
+ Check if the stock quantity has fallen below the minimum threshold of part.
+
+ If true, notify the users who have subscribed to the part
+ """
+
+ # Run "up" the tree, to allow notification for "parent" parts
+ parts = part.get_ancestors(include_self=True, ascending=True)
+
+ for p in parts:
+ if p.is_part_low_on_stock():
+ InvenTree.tasks.offload_task(
+ 'part.tasks.notify_low_stock',
+ p
+ )
diff --git a/InvenTree/part/templates/part/bom.html b/InvenTree/part/templates/part/bom.html
index aa01dd64eb..7a3ab1ad6d 100644
--- a/InvenTree/part/templates/part/bom.html
+++ b/InvenTree/part/templates/part/bom.html
@@ -34,11 +34,8 @@
{% trans "Delete Items" %}
- {% endif %}
-
- 
`;
- html += item.label;
-
- html += '';
-
- if (user_settings.SEARCH_SHOW_STOCK_LEVELS) {
- html += partStockLabel(item.data);
+ if (user_settings.SEARCH_HIDE_INACTIVE_PARTS) {
+ // Limit to active parts
+ params.active = true;
}
- html += '';
+ $.ajax({
+ url: '/api/part/',
+ data: params,
+ success: function(data) {
- return $('![](${item.thumbnail || "/static/img/blank_image.png"}){kind=spacer}
${item.label}
+
+
+ `;
+
+ if (user_settings.SEARCH_SHOW_STOCK_LEVELS) {
+ html += partStockLabel(
+ item.data,
+ {
+ classes: 'badge-right',
+ }
+ );
+ }
+
+ html += '