😝 My label design 😝
', + + 'label_width': '56mm', + 'label_height': '32mm', + 'label_edge_top': '0mm', + 'label_edge_left': '0mm', + 'label_edge_right': '0mm', + }, +``` + +## Example 11 - Cable Label vertical writing. + +This example shows how to write vertically, e.g. for cable labeling on a wide but not so high single label. + + + +```Python + 'cable': { + 'title': 'Für Kabel', + 'with_qr': False, + 'label_edge_left': '0.00mm', + 'label_edge_right': '0.00mm', + 'label_edge_top': '0.00mm', + 'text_align_vertical': 'middle', + 'text_align_horizontal': 'center', + 'text_template': '' + '{{ obj.label }}' + '{{ obj.label }}' + '{{ obj.label }}' + '{{ obj.label }}' + '{{ obj.label }}' + '{{ obj.label }}' + '{{ obj.label }}' + '{{ obj.label }}' + '{{ obj.label }}' + '{{ obj.label }}' + '{{ obj.label }}' + '{{ obj.label }}' + '{{ obj.label }}' + '' + }, +``` + +## Example 12 - Cable Label vertical writing. + +This example shows the creation of a Cabel label with barcode 128. Please note that an online function is used here (internet may be necessary). Barcode 128 is not created on the Netbox server. + + + +```Python + 'cable_2': { + 'title': 'Für Kabel', + 'with_qr': False, + 'label_edge_left': '0.00mm', + 'label_edge_right': '0.00mm', + 'label_edge_top': '0.00mm', + 'text_align_vertical': 'middle', + 'text_align_horizontal': 'center', + + # QR-Code Image File + 'qr_version': 1, + 'qr_error_correction': 1, + 'qr_box_size': 2, + 'qr_border': 0, + + 'text_template': '' + '' + '' + '' + '' + '' + '' + '' + '' + '' +``` \ No newline at end of file diff --git a/docs/img/Configuration_Browser_Print_Settings.png b/docs/img/Configuration_Browser_Print_Settings.png new file mode 100644 index 0000000..b767a4f Binary files /dev/null and b/docs/img/Configuration_Browser_Print_Settings.png differ diff --git a/docs/img/Configuration_Label_Example_01.png b/docs/img/Configuration_Label_Example_01.png new file mode 100644 index 0000000..2e406ea Binary files /dev/null and b/docs/img/Configuration_Label_Example_01.png differ diff --git a/docs/img/Configuration_Label_Example_02.png b/docs/img/Configuration_Label_Example_02.png new file mode 100644 index 0000000..92ee978 Binary files /dev/null and b/docs/img/Configuration_Label_Example_02.png differ diff --git a/docs/img/Configuration_Label_Example_03.png b/docs/img/Configuration_Label_Example_03.png new file mode 100644 index 0000000..43d5ae7 Binary files /dev/null and b/docs/img/Configuration_Label_Example_03.png differ diff --git a/docs/img/Configuration_Label_Example_04.png b/docs/img/Configuration_Label_Example_04.png new file mode 100644 index 0000000..8573cc3 Binary files /dev/null and b/docs/img/Configuration_Label_Example_04.png differ diff --git a/docs/img/Configuration_Label_Example_05.png b/docs/img/Configuration_Label_Example_05.png new file mode 100644 index 0000000..f221a8a Binary files /dev/null and b/docs/img/Configuration_Label_Example_05.png differ diff --git a/docs/img/Configuration_Label_Example_06.png b/docs/img/Configuration_Label_Example_06.png new file mode 100644 index 0000000..ec04bc5 Binary files /dev/null and b/docs/img/Configuration_Label_Example_06.png differ diff --git a/docs/img/Configuration_Label_Example_07.png b/docs/img/Configuration_Label_Example_07.png new file mode 100644 index 0000000..58df97e Binary files /dev/null and b/docs/img/Configuration_Label_Example_07.png differ diff --git a/docs/img/Configuration_Label_Example_08.png b/docs/img/Configuration_Label_Example_08.png new file mode 100644 index 0000000..35211c2 Binary files /dev/null and b/docs/img/Configuration_Label_Example_08.png differ diff --git a/docs/img/Configuration_Label_Example_09.png b/docs/img/Configuration_Label_Example_09.png new file mode 100644 index 0000000..18f2376 Binary files /dev/null and b/docs/img/Configuration_Label_Example_09.png differ diff --git a/docs/img/Configuration_Label_Example_10.png b/docs/img/Configuration_Label_Example_10.png new file mode 100644 index 0000000..33897e4 Binary files /dev/null and b/docs/img/Configuration_Label_Example_10.png differ diff --git a/docs/img/Configuration_Label_Example_11.png b/docs/img/Configuration_Label_Example_11.png new file mode 100644 index 0000000..4edaca5 Binary files /dev/null and b/docs/img/Configuration_Label_Example_11.png differ diff --git a/docs/img/Configuration_Label_Example_12.png b/docs/img/Configuration_Label_Example_12.png new file mode 100644 index 0000000..8585935 Binary files /dev/null and b/docs/img/Configuration_Label_Example_12.png differ diff --git a/docs/img/Configuration_Printer_WordPreview.png b/docs/img/Configuration_Printer_WordPreview.png new file mode 100644 index 0000000..ca7045d Binary files /dev/null and b/docs/img/Configuration_Printer_WordPreview.png differ diff --git a/docs/img/Configuration_Printer_ZM400.png b/docs/img/Configuration_Printer_ZM400.png new file mode 100644 index 0000000..d904fd3 Binary files /dev/null and b/docs/img/Configuration_Printer_ZM400.png differ diff --git a/netbox_qrcode/__init__.py b/netbox_qrcode/__init__.py index 6d16a96..d525620 100644 --- a/netbox_qrcode/__init__.py +++ b/netbox_qrcode/__init__.py @@ -11,21 +11,72 @@ class QRCodeConfig(PluginConfig): author_email = 'mgk.kolek@gmail.com' required_settings = [] default_settings = { + + ################################## + # General Plugin + 'title': '', + + ################################## + # Text content 'with_text': True, + 'text_location': 'right', + 'text_align_horizontal': 'left', + 'text_align_vertical': 'middle', + + # Text source (Option A) 'text_fields': ['name', 'serial'], - 'font': 'TahomaBold', 'custom_text': None, - 'text_location': 'right', + + # Text source (Option B) + 'text_template': None, + + ################################## + # Font + 'font': 'TahomaBold', + 'font_size': '3mm', + 'font_weight': 'normal', + 'font_color': 'black', + + ################################## + # QR-Code + 'with_qr': True, + + # QR-Code alternative source + 'url_template': None, + + # QR-Code Image File 'qr_version': 1, 'qr_error_correction': 0, - 'qr_box_size': 6, - 'qr_border': 4, + 'qr_box_size': 4, + 'qr_border': 0, + + ################################## + # Label Layout + + # Label dimensions + 'label_qr_width': '12mm', + 'label_qr_height': '12mm', + + # Label edge + 'label_edge_top': '0mm', + 'label_edge_left': '1.5mm', + 'label_edge_right': '1.5mm', + 'label_edge_bottom': '0mm', + + # Label QR code positioning + 'label_width': '56mm', + 'label_height': '32mm', + 'label_qr_text_distance': '1mm', + + # Module-dependent configuration 'device': { 'text_fields': ['name', 'serial'] }, + 'rack': { 'text_fields': ['name'] }, + 'cable': { 'text_fields': [ '_termination_a_device', @@ -38,15 +89,20 @@ class QRCodeConfig(PluginConfig): 'b_terminations' ] }, + 'location': { 'text_fields': ['name'] }, + 'powerfeed': { - 'text_fields': ['name'], + 'text_fields': ['name'] }, + 'powerpanel': { 'text_fields': ['name'] - } + }, + + 'logo': '', } config = QRCodeConfig # noqa E305 diff --git a/netbox_qrcode/fonts/ArialBlack.ttf b/netbox_qrcode/fonts/ArialBlack.ttf deleted file mode 100644 index 8877277..0000000 Binary files a/netbox_qrcode/fonts/ArialBlack.ttf and /dev/null differ diff --git a/netbox_qrcode/fonts/ArialMT.ttf b/netbox_qrcode/fonts/ArialMT.ttf deleted file mode 100644 index 084f062..0000000 Binary files a/netbox_qrcode/fonts/ArialMT.ttf and /dev/null differ diff --git a/netbox_qrcode/fonts/ComicSansMSBold.ttf b/netbox_qrcode/fonts/ComicSansMSBold.ttf deleted file mode 100644 index e68979c..0000000 Binary files a/netbox_qrcode/fonts/ComicSansMSBold.ttf and /dev/null differ diff --git a/netbox_qrcode/fonts/CourierNewBold.ttf b/netbox_qrcode/fonts/CourierNewBold.ttf deleted file mode 100644 index 894c455..0000000 Binary files a/netbox_qrcode/fonts/CourierNewBold.ttf and /dev/null differ diff --git a/netbox_qrcode/fonts/Tahoma.ttf b/netbox_qrcode/fonts/Tahoma.ttf deleted file mode 100644 index d204f95..0000000 Binary files a/netbox_qrcode/fonts/Tahoma.ttf and /dev/null differ diff --git a/netbox_qrcode/fonts/TahomaBold.ttf b/netbox_qrcode/fonts/TahomaBold.ttf deleted file mode 100644 index e4024e2..0000000 Binary files a/netbox_qrcode/fonts/TahomaBold.ttf and /dev/null differ diff --git a/netbox_qrcode/template_content.py b/netbox_qrcode/template_content.py index d4b44ba..df9c173 100644 --- a/netbox_qrcode/template_content.py +++ b/netbox_qrcode/template_content.py @@ -1,124 +1,166 @@ from packaging import version - from django.conf import settings from django.core.exceptions import ObjectDoesNotExist -from django.template import engines - from netbox.plugins import PluginTemplateExtension +from .template_content_functions import create_text, create_url, config_for_modul, create_QRCode -from .utilities import get_img_b64, get_qr, get_qr_text, get_concat - +# ****************************************************************************************** +# Contains the main functionalities of the plugin and thus creates the content for the +# individual modules, e.g: Device, Rack etc. +# ****************************************************************************************** +################################## +# Class for creating the plugin content class QRCode(PluginTemplateExtension): - def x_page(self): - config = self.context['config'] - obj = self.context['object'] - request = self.context['request'] - url = request.build_absolute_uri(obj.get_absolute_url()) - # get object settings - obj_cfg = config.get(self.model.replace('dcim.', '')) - if obj_cfg is None: - return '' - # and ovverride default - config.update(obj_cfg) - - qr_args = {} - for k, v in config.items(): - if k.startswith('qr_'): - qr_args[k.replace('qr_', '')] = v - - qr_img = get_qr(url, **qr_args) - if config.get('with_text'): - if config.get('text_template'): - django_engine = engines["django"] - template = django_engine.from_string(config.get('text_template')) - text = template.render({'obj': obj}) - else: - text = [] - for text_field in config.get('text_fields', []): - cfn = None - if '.' in text_field: - try: - text_field, cfn = text_field.split('.') - except ValueError: - cfn = None - if getattr(obj, text_field, None): - if cfn: - try: - if getattr(obj, text_field).get(cfn): - text.append('{}'.format(getattr(obj, text_field).get(cfn))) - except AttributeError: - # fix for nb3.3: trying to get cable termination and device in same way as custom field - if type(getattr(obj, text_field)) is list: - first_element = next(iter(getattr(obj, text_field)), None) - if first_element and getattr(first_element, cfn, None): - text.append('{}'.format(getattr(first_element, cfn))) - else: - text.append('{}'.format(getattr(obj, text_field))) - custom_text = config.get('custom_text') - if custom_text: - text.append(custom_text) - text = '\n'.join(text) - text_img = get_qr_text(qr_img.size, text, config.get('font'), config.get('font_size', 0)) - qr_with_text = get_concat(qr_img, text_img, config.get('text_location', 'right')) - - img = get_img_b64(qr_with_text) - else: - img = get_img_b64(qr_img) + ################################## + # Creates a plug-in view for a label. + # -------------------------------- + # Parameter: + # labelDesignNo: Which label design should be loaded. + def Create_SubPluginContent(self, labelDesignNo): + + thisSelf = self + + obj = self.context['object'] # An object of the type Device, Rack etc. + + # Config suitable for the module + config = config_for_modul(thisSelf, labelDesignNo) + + # Abort if no config data. + if config is None: + return '' + + # Get URL for QR code + url = create_url(thisSelf, config, obj) + + # Create a QR code + qrCode = create_QRCode(url, config) + + # Create the text for the label if required. + text = create_text(config, obj, qrCode) + + # Create plugin using template try: if version.parse(settings.VERSION).major >= 3: - return self.render( - 'netbox_qrcode/qrcode3.html', extra_context={'image': img} + + render = self.render( + 'netbox_qrcode/qrcode3.html', extra_context={ + 'title': config.get('title'), + 'labelDesignNo': labelDesignNo, + 'qrCode': qrCode, + 'with_text': config.get('with_text'), + 'text': text, + 'text_location': config.get('text_location'), + 'text_align_horizontal': config.get('text_align_horizontal'), + 'text_align_vertical': config.get('text_align_vertical'), + 'font': config.get('font'), + 'font_size': config.get('font_size'), + 'font_weight': config.get('font_weight'), + 'font_color': config.get('font_color'), + 'with_qr': config.get('with_qr'), + 'label_qr_width': config.get('label_qr_width'), + 'label_qr_height': config.get('label_qr_height'), + 'label_qr_text_distance': config.get('label_qr_text_distance'), + 'label_width': config.get('label_width'), + 'label_height': config.get('label_height'), + 'label_edge_top': config.get('label_edge_top'), + 'label_edge_left': config.get('label_edge_left'), + 'label_edge_right': config.get('label_edge_right'), + 'label_edge_bottom': config.get('label_edge_bottom') + } ) + + return render else: + # Versions 1 and 2 are no longer supported. return self.render( - 'netbox_qrcode/qrcode.html', extra_context={'image': img} + 'netbox_qrcode/qrcode.html', extra_context={'image': qrCode} ) except ObjectDoesNotExist: return '' + ################################## + # Create plugin content + # - First, a plugin view is created for the first label. + # - If there are further configuration entries for the object/model (e.g. device, rack etc.), + # further label views are also created as additional plugin views. + def Create_PluginContent(self): + # First Plugin Content + pluginContent = QRCode.Create_SubPluginContent(self, 1) + + # Check whether there is another configuration for the object, e.g. device, rack, etc. + # Support up to 10 additional label configurations (objectName_2 to ..._10) per object (e.g. device, rack, etc.). + + config = self.context['config'] # Django configuration + + for i in range(2, 11): + + configName = self.model.replace('dcim.', '') + '_' + str(i) + obj_cfg = config.get(configName) # Load configuration for additional label if possible. + + if(obj_cfg): + pluginContent += QRCode.Create_SubPluginContent(self, i) # Add another plugin view + else: + break + + return pluginContent + +################################## +# The following section serves to integrate the plugin into Netbox Core. + +# Class for creating a QR code for the model: Device class DeviceQRCode(QRCode): - model = 'dcim.device' + model = 'dcim.device' # Info for Netbox in which model the plugin should be integrated. def right_page(self): - return self.x_page() - + return self.Create_PluginContent() +# Class for creating a QR code for the model: Rack class RackQRCode(QRCode): - model = 'dcim.rack' + model = 'dcim.rack' # Info for Netbox in which model the plugin should be integrated. def right_page(self): - return self.x_page() - + return self.Create_PluginContent() +# Class for creating a QR code for the model: Cable class CableQRCode(QRCode): - model = 'dcim.cable' + model = 'dcim.cable' # Info for Netbox in which model the plugin should be integrated. def left_page(self): - return self.x_page() - + return self.Create_PluginContent() +# Class for creating a QR code for the model: Location class LocationQRCode(QRCode): - model = 'dcim.location' + model = 'dcim.location' # Info for Netbox in which model the plugin should be integrated. def left_page(self): - return self.x_page() - + return self.Create_PluginContent() +# Class for creating a QR code for the model: Power Feed class PowerFeedQRCode(QRCode): - model = 'dcim.powerfeed' + model = 'dcim.powerfeed' # Info for Netbox in which model the plugin should be integrated. def right_page(self): - return self.x_page() - + return self.Create_PluginContent() +# Class for creating a QR code for the model: Power Panel class PowerPanelQRCode(QRCode): - model = 'dcim.powerpanel' + model = 'dcim.powerpanel' # Info for Netbox in which model the plugin should be integrated. def right_page(self): - return self.x_page() + return self.Create_PluginContent() +################################## +# Other plugins support + +# Class for creating a QR code for the Plugin: Netbox-Inventory (https://github.com/ArnesSI/netbox-inventory) +class Plugin_Netbox_Inventory(QRCode): + model = 'netbox_inventory.asset' # Info for Netbox in which model the plugin should be integrated. + + def right_page(self): + return self.Create_PluginContent() -template_extensions = [DeviceQRCode, RackQRCode, CableQRCode, LocationQRCode, PowerFeedQRCode, PowerPanelQRCode] +# Connects Netbox Core with the plug-in classes +template_extensions = [DeviceQRCode, RackQRCode, CableQRCode, LocationQRCode, PowerFeedQRCode, PowerPanelQRCode, Plugin_Netbox_Inventory] \ No newline at end of file diff --git a/netbox_qrcode/template_content_functions.py b/netbox_qrcode/template_content_functions.py new file mode 100644 index 0000000..e9edfb9 --- /dev/null +++ b/netbox_qrcode/template_content_functions.py @@ -0,0 +1,146 @@ +from .utilities import get_img_b64, get_qr +from django.template import engines + +# ****************************************************************************************** +# For better clarity, the sub-functions of template_content.py have been outsourced. +# ****************************************************************************************** + +################################## +# The configuration is taken and all fields that are module-specific (e.g. Device, Rack, etc.) are replaced. +# -------------------------------- +# Parameter: +# labelDesignNo: Which label design should be loaded. +# parentSelf: Self from Parrent Function +def config_for_modul(parentSelf, labelDesignNo): + + # Copy so that the Runtime data is not changed. + config = parentSelf.context['config'].copy() # From Netbox Config File + + # Create suffix to read the correct module configuration. + confModulsufix = str() # None if the first standard label + + if(labelDesignNo >= 2): + confModulsufix = '_' + str(labelDesignNo) + + # Collect the QR code plugin configuration for the specific object such as device, rack etc. + # and overwrite the default configuration fields. + obj_cfg = config.get(parentSelf.model.replace('dcim.', '') + confModulsufix) # get spezific object settings + + if obj_cfg is not None: + config.update(obj_cfg) # Ovverride default confiv Values + return config + else: + return config # No module customisation + +################################## +# Create QR-Code +# -------------------------------- +# Parameter: +# text: Text for QR-Code +# config: From the Netbox configuration file +def create_QRCode(text, config): + + # Collect the configuration entries that begin with "qr_. + # These are required to generate the QR code. + qr_args = {} + for k, v in config.items(): + if k.startswith('qr_'): + qr_args[k.replace('qr_', '')] = v + + # Create a QR code + qrCode = get_qr(text, **qr_args) + return get_img_b64(qrCode) + + +################################## +# Create URL for QR code +# -------------------------------- +# Parameter: +# config: From the Netbox configuration file +# obj: Data from the model (e.g. device, rack, etc.) +# request: HTML Request Information +def create_url(parentSelf, config, obj): + + request = parentSelf.context['request'] # HTML Request Informations + + if config.get('url_template'): + # A user-defined design specification of the URL is provided in ninja2 format. + django_engine = engines["django"] + template = django_engine.from_string(config.get('url_template')) # Custom template for URL design. + return template.render({'obj': obj}) # Replace placeholder + else: + return request.build_absolute_uri(obj.get_absolute_url()) # URL to the requested page + +################################## +# Create text for label +# -------------------------------- +# Parameter: +# config: From the Netbox configuration file +# obj: Data from the model (e.g. device, rack, etc.) +# qrCode: QR-Code Image +def create_text(config, obj, qrCode): + + text = str() + + if config.get('with_text'): + if config.get('text_template'): + return get_text_template(config, obj, qrCode) # Create text content based on the Ninja2 template from the user + else: + return get_text_fields(config, obj) # Use the list of variables from the Config. + +################################## +# A user-defined design specification of the text is provided in ninja2 format. +# -------------------------------- +# Parameter: +# config: From the Netbox configuration file +# obj: Data from the model (e.g. device, rack, etc.) +# qrCode: QR-Code Image (To create a freely defined label with QR code.) +def get_text_template(config, obj, qrCode): + + django_engine = engines["django"] + template = django_engine.from_string(config.get('text_template')) # Get Custom Template + logo = config.get('logo') + return template.render({'obj': obj, + 'logo': logo, + 'qrCode': qrCode}) # Replace placeholder + +################################## +# Retrieves all values from the object (e.g. device, rack, etc.) +# depending on the configuration parameter that are to be displayed in list form and prepares them. +# -------------------------------- +# Parameter: +# config: From the Netbox configuration file +# obj: Data from the model (e.g. device, rack, etc.) +def get_text_fields(config, obj): + + text = [] + + for text_field in config.get('text_fields', []): + cfn = None + if '.' in text_field: + try: + text_field, cfn = text_field.split('.') + except ValueError: + cfn = None + if getattr(obj, text_field, None): + if cfn: + try: + if getattr(obj, text_field).get(cfn): + text.append('{}'.format(getattr(obj, text_field).get(cfn))) + except AttributeError: + # fix for nb3.3: trying to get cable termination and device in same way as custom field + if type(getattr(obj, text_field)) is list: + first_element = next(iter(getattr(obj, text_field)), None) + if first_element and getattr(first_element, cfn, None): + text.append('{}'.format(getattr(first_element, cfn))) + else: + text.append('{}'.format(getattr(obj, text_field))) + + # Append user-defined text to the end. + custom_text = config.get('custom_text') + + if custom_text: + text.append(custom_text) + + # Convert text list to string with line breaks. + return '
+
+