mirror of
https://github.com/inventree/InvenTree
synced 2024-08-30 18:33:04 +00:00
163 lines
3.9 KiB
Python
163 lines
3.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
import string
|
|
import hashlib
|
|
import logging
|
|
|
|
from InvenTree import plugins as InvenTreePlugins
|
|
from barcodes import plugins as BarcodePlugins
|
|
|
|
from stock.models import StockItem
|
|
from stock.serializers import StockItemSerializer, LocationSerializer
|
|
from part.serializers import PartSerializer
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
def hash_barcode(barcode_data):
|
|
"""
|
|
Calculate an MD5 hash of barcode data.
|
|
|
|
HACK: Remove any 'non printable' characters from the hash,
|
|
as it seems browers will remove special control characters...
|
|
|
|
TODO: Work out a way around this!
|
|
"""
|
|
|
|
barcode_data = str(barcode_data).strip()
|
|
|
|
printable_chars = filter(lambda x: x in string.printable, barcode_data)
|
|
|
|
barcode_data = ''.join(list(printable_chars))
|
|
|
|
hash = hashlib.md5(str(barcode_data).encode())
|
|
return str(hash.hexdigest())
|
|
|
|
|
|
class BarcodePlugin:
|
|
"""
|
|
Base class for barcode handling.
|
|
Custom barcode plugins should extend this class as necessary.
|
|
"""
|
|
|
|
# Override the barcode plugin name for each sub-class
|
|
PLUGIN_NAME = ""
|
|
|
|
@property
|
|
def name(self):
|
|
return self.PLUGIN_NAME
|
|
|
|
def __init__(self, barcode_data):
|
|
"""
|
|
Initialize the BarcodePlugin instance
|
|
|
|
Args:
|
|
barcode_data - The raw barcode data
|
|
"""
|
|
|
|
self.data = barcode_data
|
|
|
|
def getStockItem(self):
|
|
"""
|
|
Attempt to retrieve a StockItem associated with this barcode.
|
|
Default implementation returns None
|
|
"""
|
|
|
|
return None
|
|
|
|
def getStockItemByHash(self):
|
|
"""
|
|
Attempt to retrieve a StockItem associated with this barcode,
|
|
based on the barcode hash.
|
|
"""
|
|
|
|
try:
|
|
item = StockItem.objects.get(uid=self.hash())
|
|
return item
|
|
except StockItem.DoesNotExist:
|
|
return None
|
|
|
|
def renderStockItem(self, item):
|
|
"""
|
|
Render a stock item to JSON response
|
|
"""
|
|
|
|
serializer = StockItemSerializer(item, part_detail=True, location_detail=True, supplier_part_detail=True)
|
|
return serializer.data
|
|
|
|
def getStockLocation(self):
|
|
"""
|
|
Attempt to retrieve a StockLocation associated with this barcode.
|
|
Default implementation returns None
|
|
"""
|
|
|
|
return None
|
|
|
|
def renderStockLocation(self, loc):
|
|
"""
|
|
Render a stock location to a JSON response
|
|
"""
|
|
|
|
serializer = LocationSerializer(loc)
|
|
return serializer.data
|
|
|
|
def getPart(self):
|
|
"""
|
|
Attempt to retrieve a Part associated with this barcode.
|
|
Default implementation returns None
|
|
"""
|
|
|
|
return None
|
|
|
|
def renderPart(self, part):
|
|
"""
|
|
Render a part to JSON response
|
|
"""
|
|
|
|
serializer = PartSerializer(part)
|
|
return serializer.data
|
|
|
|
def hash(self):
|
|
"""
|
|
Calculate a hash for the barcode data.
|
|
This is supposed to uniquely identify the barcode contents,
|
|
at least within the bardcode sub-type.
|
|
|
|
The default implementation simply returns an MD5 hash of the barcode data,
|
|
encoded to a string.
|
|
|
|
This may be sufficient for most applications, but can obviously be overridden
|
|
by a subclass.
|
|
|
|
"""
|
|
|
|
return hash_barcode(self.data)
|
|
|
|
def validate(self):
|
|
"""
|
|
Default implementation returns False
|
|
"""
|
|
return False
|
|
|
|
|
|
def load_barcode_plugins(debug=False):
|
|
"""
|
|
Function to load all barcode plugins
|
|
"""
|
|
|
|
logger.debug("Loading barcode plugins")
|
|
|
|
plugins = InvenTreePlugins.get_plugins(BarcodePlugins, BarcodePlugin)
|
|
|
|
if debug:
|
|
if len(plugins) > 0:
|
|
logger.info(f"Discovered {len(plugins)} barcode plugins")
|
|
|
|
for p in plugins:
|
|
logger.debug(" - {p}".format(p=p.PLUGIN_NAME))
|
|
else:
|
|
logger.debug("No barcode plugins found")
|
|
|
|
return plugins
|