object_classes.py

# -*- coding: utf-8 -*-
#  Copyright (c) 2020 - 2025 Ricardo Bartels. All rights reserved.
#
#  netbox-sync.py
#
#  This work is licensed under the terms of the MIT license.
#  For a copy, see file LICENSE.txt included in this
#  repository or visit: <https://opensource.org/licenses/MIT>.

import json
from ipaddress import ip_network, IPv4Network, IPv6Network

# noinspection PyUnresolvedReferences
from packaging import version

from module.common.misc import grab
from module.common.logging import get_logger
from module.netbox.manufacturer_mapping import sanitize_manufacturer_name

log = get_logger()


class NetBoxInterfaceType:
    """
    class to handle and determine NetBox interface types

    Parameters
    ----------
    data: int, str
        int: set interface speed
        str: try to parse the adapter model and determine speed and interface type
    """

    fallback_type = "other"

    # valid types which can be used within netbox-sync
    valid_types = {
        "virtual":         "Virtual",
        "other":             "Other",
        "100base-tx":            100,
        "1000base-t":          1_000,
        "1000base-x-sfp":      1_000,
        "2.5gbase-t":          2_500,
        "5gbase-t":            5_000,
        "10gbase-t":          10_000,
        "10gbase-x-sfpp":     10_000,
        "10gbase-x-xfp":      10_000,
        "25gbase-x-sfp28":    25_000,
        "40gbase-x-qsfpp":    40_000,
        "50gbase-x-sfp28":    50_000,
        "50gbase-x-sfp56":    50_000,
        "100gbase-x-cfp":    100_000,
        "100gbase-x-cfp2":   100_000,
        "100gbase-x-cfp4":   100_000,
        "100gbase-x-cpak":   100_000,
        "100gbase-x-qsfp28": 100_000,
        "200gbase-x-qsfp56": 200_000,
        "200gbase-x-cfp2":   200_000,
        "400gbase-x-qsfpdd": 400_000,
        "400gbase-x-osfp":   400_000
    }

    # assign common types for an interface speed value
    common_types = {
        100:     "100base-tx",
        1_000:   "1000base-t",
        2_500:   "2.5gbase-t",
        5_000:   "5gbase-t",
        10_000:  "10gbase-x-sfpp",
        25_000:  "25gbase-x-sfp28",
        40_000:  "40gbase-x-qsfpp",
        50_000:  "50gbase-x-sfp28",
        100_000: "100gbase-x-qsfp28",
        200_000: "200gbase-x-qsfp56",
        400_000: "400gbase-x-qsfpdd"
    }

    detected_speed = 0
    detected_type = None

    def __init__(self, data=None):
        """
        Parameters
        ----------
        data: int, str
            int: set interface speed
            str: try to parse the adapter model and determine speed and interface type
        """

        try:
            self.detected_speed = int(data)
        except (TypeError, ValueError):
            self.parse_data_from_adapter_name(data)

    def get_netbox_type_list(self) -> list:
        """
        get a list of valid interface types

        Returns
        -------
        valid_interface_types: list
            a list with valid types
        """

        return list(self.valid_types.keys())

    def get_common_type(self) -> str:
        """
        return an interface type from the common type list

        Returns
        -------
        common_type: str
            NetBox interface type
        """

        return self.common_types.get(self.detected_speed, self.fallback_type)

    def parse_data_from_adapter_name(self, adapter_name: str = None) -> None:
        """
        parses a provided adapter name and tries to determine speed and interface connector type

        Parameters
        ----------
        adapter_name: str
            the adapter name/description
        """

        if not isinstance(adapter_name, str):
            return

        detected_speed = 0
        for nic_speed in ["400", "200", "100", "50", "40", "25", "10", "5", "2.5", "1"]:
            if f"{nic_speed}gb" in adapter_name.lower():
                detected_speed = nic_speed
                break
            elif f"{nic_speed}gbe" in adapter_name.lower():
                detected_speed = nic_speed
                break

        if detected_speed == "2.5":
            self.detected_speed = 2500
        else:
            self.detected_speed = int(detected_speed) * 1000

        for nic_type in ["Base-T", "QSFP-DD", "QSFP28", "QSFP56", "SFP28", "QSFP+", "QSFP", "SFP+", "SFP", "XFP"]:
            if nic_type.lower() in adapter_name.lower():
                if nic_type == "QSFP-DD":
                    nic_type = nic_type.replace("-", "")
                elif "+" in nic_type:
                    nic_type = nic_type.replace("+", "p")

                self.detected_type = nic_type.lower()
                break

    def get_speed_human(self) -> str:
        """
        return a human representation of the detected interface speed

        Returns
        -------
        human_speed: str
            human-readable string of interface speed
        """

        if self.detected_speed == 0:
            return self.fallback_type

        if self.detected_speed < 1000:
            return f"{self.detected_speed}MbE"
        else:
            if self.detected_speed == 2500:
                speed_to_return = "2.5"
            else:
                speed_to_return = int(self.detected_speed / 1000)

            return f"{speed_to_return}GbE"

    def get_this_netbox_type(self) -> str:
        """
        returns a NetBox interface type based on the detected parameters

        Returns
        -------
        interface_type: str
            NetBox interface type
        """

        if self.detected_speed == 0:
            return self.fallback_type

        if self.detected_type is None:
            return self.get_common_type()

        # get possible speed types:
        possible_speed_types = list()
        for nic_type, nic_speed in self.valid_types.items():
            if nic_speed == self.detected_speed:
                possible_speed_types.append(nic_type)

        # only one possible nic type
        if len(possible_speed_types) == 1:
            return self.get_common_type()

        detected_nic_type = None
        for possible_speed_type in possible_speed_types:
            if self.detected_type in possible_speed_type:
                return possible_speed_type

        if detected_nic_type is None:
            return self.get_common_type()


class NetBoxMappings:
    """
    Adds singleton to map between NetBox object class and "object_type" attribute of that class
    this is used for objects scopes and IP address and MAC address objects
    """

    mapping = dict()

    def __new__(cls):
        it = cls.__dict__.get("__it__")
        if it is not None:
            return it
        cls.__it__ = it = object.__new__(cls)
        it.init()
        return it

    def init(self):

        for classDefinition in NetBoxObject.__subclasses__():

            if classDefinition.object_type is not None:
                self.mapping[classDefinition] = classDefinition.object_type
                self.mapping[classDefinition.object_type] = classDefinition

    def get(self, needle):
        if isinstance(needle, NetBoxObject):
            return self.mapping.get(type(needle))
        else:
            return self.mapping.get(needle)

    def scopes_object_types(self, scopes_list) -> list:
        result = list()

        if not isinstance(scopes_list, list):
            raise ValueError("value for 'scopes_list' must be a list")

        for scope in scopes_list:
            result.append(self.get(scope))

        return result


class NetBoxObject:
    """
    Base class for all NetBox object types. Implements all methods used on a NetBox object.

    subclasses need to have the following attributes:
        name: string
            name of the object type (i.e. "virtual machine")
        api_path: string
            NetBox api path of object type (i.e: "virtualization/virtual-machines")
        object_type: string
            NetBox object type (i.e: "virtualization.virtualmachine") to handle scopes for this NetBox object
        primary_key: string
            name of the data model key which represents the primary key of this object besides id (i.e: "name")
        data_model: string
            dict of permitted data keys and possible values (see description below)
        prune: bool
            defines if this object type will be pruned by netbox-sync

    optional attributes
        secondary_key: string
            name of the data model key which represents the secondary key of this object besides id
        enforce_secondary_key: bool
            if secondary key of an object shall be added to name when get_display_name() method is called
        min_netbox_version: string
            defines since which NetBox version this object is available
        read_only: bool
            defines if this is a read only object class and can't be changed within netbox-sync

    The data_model attribute needs to be a dict describing the data model in NetBox.
    Key must be string.
    Value can be following types:
        int (instance):
            value of this attribute must be a string and will be truncated if string exceeds max length of "int"
        int (class):
            value must be an integer
        str (class):
            can be a string with an undefined length
        bool (class):
            attribute must be True or False
        NetBoxObject subclass:
            value of this key is a reference to another NetBoxObject of exact defined type
        list (instance):
            value can be one of the predefined values in that list.
        list of NetBoxObject subclasses:
            value must be an instance of predefined netBoxObject classes in list
        NBObjectList subclass:
            value mast be the defined subclass of NBObjectList


    """
    name = ""
    api_path = ""
    primary_key = ""
    data_model = {}
    object_type = None
    min_netbox_version = "0.0"
    read_only = False
    # _mandatory_attrs must be set at subclasses
    _mandatory_attrs = ("name", "api_path", "primary_key", "data_model", "object_type")

    # just skip this object if a mandatory attribute is missing
    skip_object_if_mandatory_attr_is_missing = False

    # keep handle to inventory instance to append objects on demand
    inventory = None

    def __init__(self, data=None, read_from_netbox=False, inventory=None, source=None):
        if not all(getattr(self, attr) for attr in self._mandatory_attrs) or hasattr(self, "prune") is False:
            raise ValueError(
                f"FATAL: not all mandatory attributes {self._mandatory_attrs} "
                f"are set in {self.__class__.__name__}."
            )

        # set default values
        self.data = dict()
        self.inventory = inventory
        self.is_new = True
        self.nb_id = 0
        self.updated_items = list()
        self.unset_items = list()
        self.source = source
        self.deleted = False
        self._original_data = dict()

        # add empty lists for list items
        for key, data_type in self.data_model.items():
            if data_type in NBObjectList.__subclasses__():
                self.data[key] = data_type()

        # add data to this object
        self.update(data=data, read_from_netbox=read_from_netbox, source=source)

    def __repr__(self):
        return "<%s instance '%s' at %s>" % (self.__class__.__name__, self.get_display_name(), id(self))

    def to_dict(self):
        """
        returns this object as a dictionary

        Returns
        -------
        dict: dictionary of all relevant items of this object instance
        """

        out = dict()

        for key in dir(self):
            value = getattr(self, key)
            if "__" in key:
                continue
            if callable(value) is True:
                continue
            if key in ["inventory", "default_attributes", "data_model_relation", "mapping", "scopes"]:
                continue
            if key == "source":
                value = getattr(value, "name", None)

            if key == "data_model":

                data_model = dict()
                for data_key, data_value in value.items():
                    if isinstance(data_value, list):
                        new_data_value = list()
                        for possible_option in data_value:
                            if type(possible_option) == type:
                                new_data_value.append(str(possible_option))
                            else:
                                new_data_value.append(possible_option)

                        data_value = new_data_value

                    # if value is class name then print class name
                    if type(data_value) == type:
                        data_value = str(data_value)

                    data_model[data_key] = data_value

                value = data_model

            if key == "data":

                data = dict()
                for data_key, data_value in value.items():
                    # if value is class name then print class representation
                    if isinstance(data_value, (NetBoxObject, IPv4Network, IPv6Network)):
                        data_value = repr(data_value)

                    elif isinstance(data_value, NBObjectList):
                        data_value = [repr(x) for x in data_value]

                    data[data_key] = data_value

                value = data

            out[key] = value

        return out

    def __str__(self):
        """
        formats this object as a dict in JSON format

        Returns
        -------
        str: object dict as JSON
        """

        return json.dumps(self.to_dict(), sort_keys=True, indent=4)

    @staticmethod
    def format_slug(text=None, max_len=50):
        """
        Format string to comply to NetBox slug acceptable pattern and max length.

        Parameters
        ----------
        text: str
            name to format into a NetBox slug
        max_len: int
            maximum possible length of slug

        Returns
        -------
        str: input name formatted as slug und truncated if necessary
        """

        if text is None or len(text) == 0:
            raise AttributeError("Argument 'text' can't be None or empty!")

        permitted_chars = (
            "abcdefghijklmnopqrstuvwxyz"  # alphabet
            "0123456789"  # numbers
            "_-"  # symbols
        )

        # Replace separators with dash
        for sep in [" ", ",", "."]:
            text = text.replace(sep, "-")

        # Strip unacceptable characters
        text = "".join([c for c in text.lower() if c in permitted_chars])

        # Enforce max length
        return text[0:max_len]

    def get_uniq_slug(self, text=None, max_len=50)-> str:
        """
        return an uniq slug. If the default slug is already used try to
        append a number until a slug is found which has not been used.

        Parameters
        ----------
        text: str
            name to format into a NetBox slug
        max_len: int
            maximum possible length of slug

        Returns
        -------
        (str): return the slug
        """

        slug = self.format_slug(text=text, max_len=max_len)

        if self.inventory.slug_used(self.__class__, slug) is False:
            return slug

        for x in range(1,20):
            new_slug = f"{slug}-{x}"
            if self.inventory.slug_used(self.__class__, new_slug) is False and len(new_slug) <= max_len:
                log.info(f"Slug '{slug}' for {self.name} '{text}' has been used. "
                         f"Assigning slug '{new_slug}'")
                return new_slug

        raise ValueError(f"Unable to find uniq slug for {self.name} '{text}'")

    # noinspection PyAttributeOutsideInit
    def update(self, data=None, read_from_netbox=False, source=None):
        """
        parse data dictionary and validate input. Add data to object if valid.

        Parameters
        ----------
        data: dict
            dictionary with data to add/update
        read_from_netbox: bool
            True if data was gathered from NetBox via request
        source: source handler
            object handler of source

        Returns
        -------
        None
        """

        if data is None:
            return

        if not isinstance(data, dict):
            raise AttributeError("Argument 'data' needs to be a dict!")

        if data.get("id") is not None:
            self.nb_id = data.get("id")

        # skip item as it's missing its primary key
        if data.get(self.primary_key) is None and \
                (read_from_netbox is True or self.data.get(self.primary_key) is None):

            if self.skip_object_if_mandatory_attr_is_missing is True:
                device_url = data.get("url") or self.data.get('url')
                log.debug2(f"This '{self.name}' ({self.nb_id}) data structure does not contain "
                           f"the primary key '{self.primary_key}'. Skipping. Link: {device_url}")
            else:
                log.error(f"This '{self.name}' data structure does not contain "
                          f"the primary key '{self.primary_key}' got: {data}")
            return None

        if read_from_netbox is True:
            self.is_new = False
            self.data = data
            self.updated_items = list()
            self.unset_items = list()

            return

        if self.read_only is True:
            raise ValueError(f"Adding {self.name} by this program is currently not implemented.")

        self.set_source(source)

        display_name = self.get_display_name(data)

        if display_name is None:
            display_name = self.get_display_name()

        log.debug2(f"Parsing '{self.name}' data structure: {display_name}")

        parsed_data = dict()
        for key, value in data.items():

            if key not in self.data_model.keys():
                log.error(f"Found undefined data model key '{key}' for object '{self.__class__.__name__}'")
                continue

            # skip unset values
            if value is None:
                log.info(f"Found unset key '{key}' while parsing {display_name}. Skipping This key")
                continue

            # check data model to see how we have to parse the value
            defined_value_type = self.data_model.get(key)

            # value must be a string witch a certain max length
            if isinstance(defined_value_type, int):
                if not isinstance(value, str):
                    log.error(f"Invalid data type for '{self.__class__.__name__}.{key}' (must be str), got: "
                              f"{value} ({type(value)})")
                    continue

                value = value[0:defined_value_type]

                if key == "slug":
                    value = self.get_uniq_slug(text=value, max_len=defined_value_type)

            if isinstance(defined_value_type, list):

                if isinstance(value, NetBoxObject):

                    if type(value) not in defined_value_type:
                        log.error(f"Invalid data type for '{key}' (must be one of {defined_value_type}), "
                                  f"got: '{type(value)}'")
                        continue

                # check if value is in defined list
                elif value not in defined_value_type:
                    log.error(f"Invalid data type for '{key}' (must be one of {defined_value_type}), got: '{value}'")
                    continue

            # just check the type of the value
            type_check_failed = False
            for valid_type in [bool, str, int, list]:

                if defined_value_type == valid_type and not isinstance(value, valid_type):
                    log.error(f"Invalid data type for '{key}' (must be {valid_type.__name__}), got: '{value}'")
                    type_check_failed = True
                    break

            if type_check_failed is True:
                continue

            # tags need to be treated as list of dictionaries, tags are only added
            if defined_value_type == NBTagList:
                # noinspection PyTypeChecker
                value = self.compile_tags(value)

            # VLANs will overwrite the whole list of current VLANs
            if defined_value_type == NBVLANList:
                value = self.compile_vlans(value)

            if defined_value_type == NBManufacturer:
                value = self.sanitize_manufacturer_name(value)

            if defined_value_type == NBCustomField:
                if not isinstance(value, dict):
                    log.error(f"Invalid data type for '{key}' (must be 'dict'), got: '{value}'")
                    continue
                for field_name in value.keys():
                    if self.inventory.get_by_data(NBCustomField, data={"name": field_name}) is None:
                        log.error(f"{NBCustomField.name} '{field_name}' not found in inventory. "
                                  "Needs to be created first!")
                        type_check_failed = True

                if type_check_failed is True:
                    continue

            # allows an empty site for netbox objects where a site is not mandatory
            # required for clusters and sub-objects without site reference
            if (isinstance(self, (NBCluster, NBVM, NBVLAN)) and
                    key == "site" and
                    grab(value, "name") is None):
                parsed_data[key] = None
                continue

            # this is meant to be reference to a different object
            if defined_value_type in NetBoxObject.__subclasses__() and defined_value_type != NBCustomField:

                if not isinstance(value, NetBoxObject):
                    # try to find object.
                    value = self.inventory.add_update_object(defined_value_type, data=value, source=source)

                # add source if currently undefined (read from NetBox)
                value.set_source(source)

            # add to parsed data dict
            parsed_data[key] = value

        # add/update slug
        # if data model contains a slug we need to handle it
        if "slug" in self.data_model.keys() and \
                parsed_data.get("slug") is None and \
                parsed_data.get(self.primary_key) is not None and \
                self.data.get("slug") in [None, ""]:

            parsed_data["slug"] = self.get_uniq_slug(text=parsed_data.get(self.primary_key),
                                                     max_len=self.data_model.get("slug"))

        # update all data items
        data_updated = False
        for key, new_value in parsed_data.items():

            # nothing changed, continue with next key
            current_value = self.data.get(key)
            if current_value == new_value:
                continue

            # get current value str
            if isinstance(current_value, (NetBoxObject, NBObjectList)):
                current_value_str = str(current_value.get_display_name())

            # if data model is a list then we need to read the NetBox data value
            elif isinstance(self.data_model.get(key), list) and isinstance(current_value, dict):
                current_value_str = str(current_value.get("value"))

            else:
                current_value_str = str(current_value).replace("\r", "")

            # get new value str
            if self.data_model.get(key) == NBCustomField:
                if current_value is None:
                    current_value = dict()
                
                # Fix for object/multi-object custom fields
                # When patching, we only need the IDs, not the full object representation
                new_value_copy = new_value.copy()
                for field_name, field_value in new_value_copy.items():
                    # Check for custom field type
                    custom_field = self.inventory.get_by_data(NBCustomField, data={"name": field_name})
                    if custom_field is not None:
                        field_type = grab(custom_field, "data.type")
                        
                        # Handle object type custom fields - need only ID
                        if field_type == "object" and isinstance(field_value, dict) and field_value.get('id') is not None:
                            new_value[field_name] = field_value.get('id')
                        
                        # Handle multi-object type custom fields - need list of IDs
                        elif field_type == "multi-object" and isinstance(field_value, list):
                            ids = []
                            for item in field_value:
                                if isinstance(item, dict) and item.get('id') is not None:
                                    ids.append(item.get('id'))
                            if ids:
                                new_value[field_name] = ids
                
                new_value = {**current_value, **new_value}
                new_value_str = str(new_value)
            elif isinstance(new_value, (NetBoxObject, NBObjectList)):
                new_value_str = str(new_value.get_display_name())
            else:
                new_value_str = str(new_value).replace("\r", "")

            # support NetBox 2.11+ vcpus float value
            # noinspection PyTypeChecker
            if current_value is not None and \
                    self.data_model.get(key) in [int, float] and \
                    isinstance(new_value, (int, float)) and \
                    float(current_value) == float(new_value):

                continue

            if isinstance(current_value, NetBoxObject) and isinstance(new_value, NetBoxObject):
                if current_value is new_value:
                    continue

            # just check again if values might match now
            elif current_value_str == new_value_str:
                continue

            # skip update if just the letter case changed for the primary key
            if key == self.primary_key and current_value_str.lower() == new_value_str.lower():
                continue

            if self.is_new is False:

                if self._original_data.get(key) == new_value_str and key in self.updated_items:
                    self.data[key] = new_value
                    self.updated_items.remove(key)
                    log.debug(f"{self.name.capitalize()} '{display_name}' attribute '{key}' was set back to "
                              f"original NetBox value '{current_value_str}'")
                    continue

                # save original NetBox value for future use to detect updates which sets it back to the same value
                # which is already saved in NetBox
                elif self._original_data.get(key) is None:
                    self._original_data[key] = current_value_str

                new_value_str = new_value_str.replace("\n", " ")
                log.info(f"{self.name.capitalize()} '{display_name}' attribute '{key}' changed from "
                         f"'{current_value_str}' to '{new_value_str}'")

            self.data[key] = new_value
            self.updated_items.append(key)
            data_updated = True

            self.resolve_relations()

        if data_updated is True and self.is_new is False:
            log.debug("Updated %s object: %s" % (self.name, self.get_display_name()))

    def set_source(self, source=None):
        """
        updates the source attribute, Only update if undefined
        """

        if source is not None and self.source is None:
            self.source = source

    def get_display_name(self, data=None, including_second_key=False):
        """
        return a name as string of this object based on primary/secondary key

        Parameters
        ----------
        data: dict
            optional data dictionary to format name from if object is not initialized
        including_second_key: bool
            if True adds second key if object has one

        Returns
        -------
        str: name of object
        """

        this_data_set = data
        if data is None:
            this_data_set = self.data

        if this_data_set is None:
            return None

        my_name = this_data_set.get(self.primary_key)

        secondary_key = getattr(self, "secondary_key", None)
        enforce_secondary_key = getattr(self, "enforce_secondary_key", False)
        include_secondary_key_if_present = getattr(self, "include_secondary_key_if_present", False)

        if secondary_key is None:
            return my_name

        if my_name is not None and True in \
                [enforce_secondary_key, including_second_key, include_secondary_key_if_present]:

            secondary_key_value = this_data_set.get(secondary_key)
            org_secondary_key_value = str(secondary_key_value)
            read_from_netbox = False

            if isinstance(secondary_key_value, NetBoxObject):
                read_from_netbox = True if secondary_key_value.nb_id != 0 else False
                secondary_key_value = secondary_key_value.get_display_name()

            elif isinstance(secondary_key_value, dict):
                read_from_netbox = True if secondary_key_value.get("id", 0) != 0 else False
                secondary_key_value = self.get_display_name(data=secondary_key_value)

            if secondary_key_value is None and read_from_netbox is False and include_secondary_key_if_present is False:
                log.warning(f"Unable to determine second key '{secondary_key}' for {self.name} '{my_name}', "
                            f"got: {org_secondary_key_value}")
                log.warning("This could cause serious errors and lead to wrongly assigned object relations!!!")

            my_name = f"{my_name} ({secondary_key_value})"

        return my_name

    def resolve_relations(self):
        """
        Resolve object relations for this object. Substitute a dict of data with an id with the instantiated
        reference of this object
        """

        for key, data_type in self.data_model.items():

            if self.data.get(key) is None:
                continue

            # continue if data_type is not an NetBox object
            # noinspection PyTypeChecker
            if data_type not in NetBoxObject.__subclasses__() + NBObjectList.__subclasses__():
                continue

            # NBCustomField are special
            if data_type == NBCustomField:
                continue

            data_value = self.data.get(key)

            if data_type in NBObjectList.__subclasses__():

                resolved_object_list = data_type()
                assert isinstance(resolved_object_list, list)

                for item in data_value:

                    if isinstance(item, data_type.member_type):
                        item_object = item
                    else:
                        item_object = self.inventory.get_by_data(data_type.member_type, data=item)

                    if item_object is not None:
                        resolved_object_list.append(item_object)

                resolved_data = resolved_object_list

            else:
                if data_value is None:
                    continue

                if isinstance(data_value, NetBoxObject):
                    resolved_data = data_value
                else:
                    data_to_find = None
                    if isinstance(data_value, int):
                        data_to_find = {"id": data_value}
                    elif isinstance(data_value, dict):
                        data_to_find = data_value

                    resolved_data = self.inventory.get_by_data(data_type, data=data_to_find)

            if resolved_data is not None:
                self.data[key] = resolved_data
            else:
                log.error(f"Problems resolving relation '{key}' for object '{self.get_display_name()}' and "
                          f"value '{data_value}'")

    def resolve_scoped_relations(self, id_attr, type_attr):

        o_id = self.data.get(id_attr)
        o_type = self.data.get(type_attr)

        if hasattr(self, "mapping") is True:
            mapping = getattr(self, "mapping")
        else:
            return

        if isinstance(o_id, int) and o_type is not None and mapping.get(o_type) is not None:
            self.data[id_attr] = self.inventory.get_by_id(mapping.get(o_type), nb_id=o_id)
        elif o_id is not None and not isinstance(o_id, NetBoxObject):
            o_id_name = grab(self, f"data.{id_attr}.name")
            log.debug(f"{self.name} '{self.data.get('name')}' {type_attr} '{o_type}' for "
                      f"'{o_id_name}' is currently not supported")
            self.data[type_attr] = ""

    def get_dependencies(self):
        """
        returns a list of NetBoxObject subclasses this object depends on

        Returns
        -------
        list: of NetBoxObject subclasses
        """

        r = [x for x in self.data_model.values() if x in NetBoxObject.__subclasses__()]
        r.extend([x.member_type for x in self.data_model.values() if x in NBObjectList.__subclasses__()])

        return r

    def get_tags(self) -> list:
        """
        returns a list of strings of tag names

        Returns
        -------
        list: of strings of tag names
        """

        tag_list = list()

        if "tags" not in self.data_model.keys():
            return tag_list

        for tag in self.data.get("tags", list()):
            if isinstance(tag, NetBoxObject):
                tag_name = tag.get_display_name()
                if tag_name not in tag_list:
                    tag_list.append(tag_name)
            else:
                log.error(f"This tag is not an NetBox object: {tag}")
                log.error(f"Please report this here: https://github.com/bb-Ricardo/netbox-sync/issues/120")

        return tag_list

    @classmethod
    def extract_tag_name(cls, this_tag):

        if isinstance(this_tag, NBTag):
            return this_tag.get_display_name()
        elif isinstance(this_tag, str):
            return this_tag
        elif isinstance(this_tag, dict) and this_tag.get("name") is not None:
            return this_tag.get("name")

    def compile_tags(self, tags, remove=False):
        """

        Parameters
        ----------
        tags: (str, list, dict, NBTag)
            tags to parse and add/remove to/from current list of object tags
        remove: bool
            True if tags shall be removed, otherwise they will be added

        Returns
        -------
        NBTagList: with added/removed tags
        """

        if tags is None or NBTagList not in self.data_model.values():
            return

        # list of parsed tag strings
        sanitized_tag_strings = list()

        """
        disable logging
        log.debug2(f"Compiling TAG list")
        """

        new_tag_list = NBTagList()

        if isinstance(tags, list):
            for tag in tags:
                sanitized_tag_strings.append(self.extract_tag_name(tag))

        else:
            # noinspection PyTypeChecker
            sanitized_tag_strings.append(self.extract_tag_name(tags))

        # current list of tag strings
        current_tag_strings = self.get_tags()

        new_tags = list()
        removed_tags = list()

        for tag_name in sanitized_tag_strings:

            if tag_name is None:
                continue

            # add tag
            if tag_name not in current_tag_strings and remove is False:

                tag = self.inventory.add_update_object(NBTag, data={"name": tag_name})

                # mark tag as used in order to not delete newly used tags
                if isinstance(tag, NBTag):
                    tag.used = True

                new_tags.append(tag)

            if tag_name in current_tag_strings and remove is True:

                tag = self.inventory.get_by_data(NBTag, data={"name": tag_name})

                removed_tags.append(tag)

        current_tags = grab(self, "data.tags", fallback=NBTagList())

        if len(new_tags) > 0:

            for tag in new_tags + current_tags:
                new_tag_list.append(tag)

        elif len(removed_tags) > 0:

            for tag in current_tags:
                if tag not in removed_tags:
                    new_tag_list.append(tag)
        else:
            new_tag_list = current_tags

        return new_tag_list

    def update_tags(self, tags, remove=False):
        """
        Update list of object tags

        Parameters
        ----------
        tags: str, list, dict, NBTag
            tags to parse and add/remove to/from current list of object tags
        remove: bool
            True if tags shall be removed, otherwise they will be added

        Returns
        -------
        None
        """

        if tags is None or NBTagList not in self.data_model.values():
            return

        """
        disable logging
        action = "Adding" if remove is False else "Removing"
        log.debug2(f"{action} Tags: {tags}")
        """

        current_tags = grab(self, "data.tags", fallback=NBTagList())

        new_tags = self.compile_tags(tags, remove=remove)

        if str(current_tags.get_display_name()) != str(new_tags.get_display_name()):

            self.data["tags"] = new_tags
            self.updated_items.append("tags")

            log.info(f"{self.name.capitalize()} '{self.get_display_name()}' attribute 'tags' changed from "
                     f"'{current_tags.get_display_name()}' to '{new_tags.get_display_name()}'")

    def add_tags(self, tags_to_add):
        """
        Add tag(s) to object

        Parameters
        ----------
        tags_to_add: (str, list, dict, NBTag)
            tags to parse and add to current list of object tags

        Returns
        -------
        None
        """

        self.update_tags(tags_to_add)

    def remove_tags(self, tags_to_remove):
        """
        remove tag(s) to object

        Parameters
        ----------
        tags_to_remove: (str, list, dict, NBTag)
            tags to parse and remove from current list of object tags

        Returns
        -------
        None
        """

        self.update_tags(tags_to_remove, remove=True)

    def compile_vlans(self, vlans):
        """
        Read list of VLANs and return a new and sanitized list of VLANs

        Parameters
        ----------
        vlans: list of (dict or NBVLAN)
            list of VLANs that should be in the returned list

        Returns
        -------
        NBVLANList
            of parsed VLANs
        """

        if vlans is None or NBVLANList not in self.data_model.values():
            return

        if not isinstance(vlans, list):
            raise ValueError("Value for vlans must be a list")

        log.debug2(f"Compiling VLAN list")
        new_vlan_list = NBVLANList()

        for vlan in vlans:

            if isinstance(vlan, NBVLAN):
                new_vlan_object = vlan
            elif isinstance(vlan, dict):
                new_vlan_object = self.inventory.add_update_object(NBVLAN, data=vlan, source=self.source)
            else:
                log.error(f"Unable to parse provided VLAN data: {vlan}")
                continue

            # set source for this vlan if undefined
            new_vlan_object.set_source(self.source)

            # VLAN already in list, must have been submitted twice
            if new_vlan_object in new_vlan_list:
                continue

            new_vlan_list.append(new_vlan_object)

        return new_vlan_list

    def sanitize_manufacturer_name(self, manufacturer_data):
        """
        Sanitize the manufacturer name to use a generic one for different representations

        Parameters
        ----------
        manufacturer_data: dict, NBManufacturer
            manufacturer data or object

        Returns
        -------
        NBManufacturer
        """

        if manufacturer_data is None:
            return

        sanitized_name = None
        if isinstance(manufacturer_data, dict):
            sanitized_name = sanitize_manufacturer_name(manufacturer_data.get("name"))

        elif isinstance(manufacturer_data, NBManufacturer):
            sanitized_name = sanitize_manufacturer_name(manufacturer_data.get_display_name())

        if sanitized_name is None:
            return manufacturer_data

        manufacturer_object = self.inventory.get_by_data(NBManufacturer, {
            "slug": self.get_uniq_slug(sanitized_name)
        })
        if manufacturer_object is None:
            manufacturer_object = self.inventory.add_update_object(NBManufacturer, {
                "name": sanitized_name
            })
        else:
            manufacturer_object.update({
                "name": sanitized_name
            })

        if manufacturer_object.source is None:
            manufacturer_object.source = self.source

        return manufacturer_object

    def unset_attribute(self, attribute_name=None):
        """
        Unset a certain attribute. This will delete the value of this attribute in NetBox on the first run of
        updating data in NetBox

        Parameters
        ----------
        attribute_name: str
            name of the attribute to unset

        Returns
        -------
        None
        """

        if attribute_name is None:
            return

        if attribute_name not in self.data_model.keys():
            log.error(f"Found undefined data model key '{attribute_name}' for object '{self.__class__.__name__}'")
            return

        data_type = self.data_model.get(attribute_name)
        current_value = self.data.get(attribute_name)

        if (data_type in [NBTagList, NBVLANList] or isinstance(data_type, (list, dict))) and \
                hasattr(current_value, '__len__') and len(current_value) == 0:
            return

        if current_value is None:
            return

        if attribute_name in self.unset_items:
            return

        # mark attribute to unset, this way it will be deleted in NetBox before any other updates are performed
        log.info(f"Setting attribute '{attribute_name}' for '{self.get_display_name()}' to None")
        self.unset_items.append(attribute_name)

    def get_nb_reference(self):
        """
        return reference of how this object is referenced in NetBox

        Returns
        -------
        (None, int): if NetBox ID is 0 (new object) return None otherwise return ID
        """

        if self.nb_id == 0:
            return None

        return self.nb_id

    def get_site_name(self, data=None):

        if NBSite not in self.data_model.values():
            return

        this_data_set = data
        if this_data_set is None:
            this_data_set = self.data

        this_site = this_data_set.get("site")
        if this_site is not None:

            if isinstance(this_site, NetBoxObject):
                return this_site.get_display_name()

            if isinstance(this_site, dict):
                return this_site.get("name")

        this_scope_type = this_data_set.get("scope_type")
        this_site = this_data_set.get("scope_id")

        if this_scope_type == "dcim.site" and this_site is not None:

            if isinstance(this_site, NetBoxObject):
                return this_site.get_display_name()

            if isinstance(this_site, dict):
                return this_site.get("name")


class NBObjectList(list):
    """
    Base class of listed NetBox objects. Extends list(). Currently used for tags and untagged VLANs

    Mandatory attributes:
        member_type: NetBoxObject subclass
            defines the type objects contained in this type of list
    """

    def get_display_name(self):

        return sorted([x.get_display_name() for x in self])


class NBCustomField(NetBoxObject):
    name = "custom field"
    api_path = "extras/custom-fields"
    object_type = "extras.customfield"
    primary_key = "name"
    prune = False

    def __init__(self, *args, **kwargs):
        # used by this software
        self.valid_object_types = [
            NBDevice.object_type,
            NBInterface.object_type,
            NBInventoryItem.object_type,
            NBPowerPort.object_type,
            NBClusterGroup.object_type,
            NBVMInterface.object_type,
            NBVM.object_type
        ]

        self.data_model = {
            "object_types": list,
            # field name (object_types) for NetBox < 4.0.0
            "content_types": list,
            "type": ["text", "longtext", "integer", "boolean", "date", "url", "json", "select", "multiselect", "object", "multi-object"],
            "name": 50,
            "label": 50,
            "description": 200,
            "required": bool,
            "default": str,
            "choices": list
        }
        super().__init__(*args, **kwargs)

    def update(self, data=None, read_from_netbox=False, source=None):
        """
            handle content types properly
            append to existing object_types and don't delete any
        """

        # Keep support for NetBox < 4.0
        if version.parse(self.inventory.netbox_api_version) < version.parse("4.0.0"):
            if data.get("content_types") is not None:
                data["object_types"] = data.pop("content_types")

        # get current content types
        current_object_types = list()
        for object_type in grab(self, "data.object_types", fallback=list()):
            current_object_types.append(object_type)

        if isinstance(data.get("object_types"), str):
            data["object_types"] = [data.get("object_types")]

        elif data.get("object_types") is None:
            data["object_types"] = []

        for object_type in data.get("object_types"):
            if object_type not in self.valid_object_types and read_from_netbox is False:
                log.error(f"Invalid content type '{object_type}' for {self.name}")
                continue

            if object_type not in current_object_types:
                current_object_types.append(object_type)

        data["object_types"] = current_object_types

        # Keep support for NetBox < 4.0
        if version.parse(self.inventory.netbox_api_version) < version.parse("4.0.0"):
            if data.get("object_types") is not None:
                data["content_types"] = data.pop("object_types")

        super().update(data=data, read_from_netbox=read_from_netbox, source=source)

        if isinstance(grab(self, "data.object_types"), str):
            self.data["object_types"] = [grab(self, "data.object_types")]

        # Keep support for NetBox < 4.0
        if isinstance(grab(self, "data.content_types"), str):
            self.data["content_types"] = [grab(self, "data.content_types")]


class NBTag(NetBoxObject):
    name = "tag"
    api_path = "extras/tags"
    object_type = "extras.tag"
    primary_key = "name"
    prune = False

    def __init__(self, *args, **kwargs):
        self.data_model = {
            "name": 100,
            "slug": 100,
            "color": 6,
            "description": 200,
            "tagged_items": int
        }
        self.used = False
        super().__init__(*args, **kwargs)


class NBTagList(NBObjectList):
    member_type = NBTag

    def get_nb_reference(self):
        """
            return None if one tag is unresolvable

            Once the tag was created in NetBox it can be assigned to objects
        """
        return_list = list()
        for tag in self:
            if tag.nb_id == 0:
                return None

            return_list.append({"name": tag.get_display_name()})

        return return_list


class NBTenant(NetBoxObject):
    name = "tenant"
    api_path = "tenancy/tenants"
    object_type = "tenancy.tenant"
    primary_key = "name"
    prune = False

    def __init__(self, *args, **kwargs):
        self.data_model = {
            "name": 100,
            "slug": 100,
            "comments": str,
            "description": 200,
            "tags": NBTagList
        }
        super().__init__(*args, **kwargs)


# class NBLocation(NetBoxObject):
#     name = "location"
#     api_path = "dcim/locations"
#     object_type = "dcim.location"
#     primary_key = "name"
#     prune = False
#     read_only = True
#
#     def __init__(self, *args, **kwargs):
#         self.data_model = {
#             "name": 100,
#             "slug": 100,
#             "site": NBSite,
#             "tags": NBTagList
#         }
#         super().__init__(*args, **kwargs)
#
#
# class NBRegion(NetBoxObject):
#     name = "region"
#     api_path = "dcim/regions"
#     object_type = "dcim.region"
#     primary_key = "name"
#     prune = False
#     read_only = True
#
#     def __init__(self, *args, **kwargs):
#         self.data_model = {
#             "name": 100,
#             "slug": 100,
#             "tags": NBTagList
#         }
#         super().__init__(*args, **kwargs)


class NBSite(NetBoxObject):
    name = "site"
    api_path = "dcim/sites"
    object_type = "dcim.site"
    primary_key = "name"
    prune = False

    def __init__(self, *args, **kwargs):
        self.data_model = {
            "name": 100,
            "slug": 100,
            "comments": str,
            "tenant": NBTenant,
            "tags": NBTagList,
            "group": NBSiteGroup
        }
        super().__init__(*args, **kwargs)


class NBSiteGroup(NetBoxObject):
    name = "site group"
    api_path = "dcim/site-groups"
    object_type = "dcim.sitegroup"
    primary_key = "name"
    prune = False
    read_only = True

    def __init__(self, *args, **kwargs):
        self.data_model = {
            "name": 100,
            "slug": 100,
        }
        super().__init__(*args, **kwargs)


class NBVRF(NetBoxObject):
    name = "VRF"
    api_path = "ipam/vrfs"
    object_type = "ipam.vrf"
    primary_key = "name"
    prune = False
    read_only = True

    def __init__(self, *args, **kwargs):
        self.data_model = {
            "name": 100,
            "description": 200,
            "tenant": NBTenant,
            "tags": NBTagList
        }
        super().__init__(*args, **kwargs)


class NBVLAN(NetBoxObject):
    name = "VLAN"
    api_path = "ipam/vlans"
    object_type = "ipam.vlan"
    primary_key = "vid"
    secondary_key = "name"
    enforce_secondary_key = True
    prune = False

    def __init__(self, *args, **kwargs):
        self.data_model = {
            "vid": int,
            "name": 64,
            "site": NBSite,
            "description": 200,
            "tenant": NBTenant,
            "tags": NBTagList,
            "group": NBVLANGroup
        }
        super().__init__(*args, **kwargs)

    def get_display_name(self, data=None, including_second_key=False):
        """
            for VLANs we change the behavior of display name.

            It is important to get the VLAN for the same site. And we don't want
            to change the name if it's already in NetBox.

            Even though the secondary key is the name we change it to site. If site
            is not present we fall back to name.
        """

        # run just to check input data
        my_name = super().get_display_name(data=data, including_second_key=including_second_key)

        this_data_set = data
        if this_data_set is None:
            this_data_set = self.data

        # we use "site" as secondary key, otherwise fall back to "name"
        this_site = this_data_set.get("site")
        if this_site is not None:
            vlan_id = this_data_set.get(self.primary_key)
            site_name = self.get_site_name(this_data_set)

            if site_name is not None:
                my_name = f"{vlan_id} (site: {site_name})"

        this_group = this_data_set.get("group")
        if this_group is not None:
            vlan_id = this_data_set.get(self.primary_key)
            group_name = grab(this_group, "data.name")

            if group_name is not None:
                my_name = f"{vlan_id} (group: {group_name})"

        return my_name

    def update(self, data=None, read_from_netbox=False, source=None):

        # don't change the name of the VLAN if it already exists
        if read_from_netbox is False and grab(self, "data.name") is not None:
            data["name"] = grab(self, "data.name")

        super().update(data=data, read_from_netbox=read_from_netbox, source=source)


class NBVLANGroup(NetBoxObject):
    name = "VLANGroup"
    api_path = "ipam/vlan-groups"
    object_type = "ipam.vlangroup"
    primary_key = "name"
    prune = False
    read_only = True

    def __init__(self, *args, **kwargs):
        self.mapping = NetBoxMappings()
        self.scopes = [
            NBSite, NBSiteGroup, NBCluster, NBClusterGroup
        ]
        self.data_model = {
            "name": 100,
            "slug": 100,
            "description": 200,
            "scope_type": self.mapping.scopes_object_types(self.scopes),
            "scope_id": self.scopes,
        }

        super().__init__(*args, **kwargs)

    def resolve_relations(self):

        self.resolve_scoped_relations("scope_id", "scope_type")
        super().resolve_relations()

    def matches_site_cluster(self, site=None, cluster=None) -> bool:
        """
        tries to figure out if this vlan group matches a certain site or cluster

        Parameters
        ----------
        site: NBSite
            the site object to match to
        cluster: NBCluster
            the cluster object to match to

        Returns
        -------
        bool: True if matches one of the params

        """
        if isinstance(site, NBSite):
            if isinstance(self.data.get("scope_id"), NBSite) and self.data.get("scope_id") == site:
                return True
            if (isinstance(self.data.get("scope_id"), NBSiteGroup) and
                    self.data["scope_id"] == grab(site, "data.group")):
                return True

        if isinstance(cluster, NBCluster):
            if isinstance(self.data.get("scope_id"), NBCluster) and self.data.get("scope_id") == cluster:
                return True
            if (isinstance(self.data.get("scope_id"), NBClusterGroup) and
                    self.data["scope_id"] == grab(cluster, "data.group")):
                return True

        return False


class NBVLANList(NBObjectList):
    member_type = NBVLAN

    def get_nb_reference(self):
        """
            return None if one VLAN is unresolvable

            Once the VLAN was created in NetBox it can be assigned to objects
        """
        return_list = list()
        for vlan in self:
            if vlan.nb_id == 0:
                return None

            return_list.append(vlan.nb_id)

        return return_list


class NBPrefix(NetBoxObject):
    name = "IP prefix"
    api_path = "ipam/prefixes"
    object_type = "ipam.prefix"
    primary_key = "prefix"
    read_only = True
    prune = False

    def __init__(self, *args, **kwargs):
        self.mapping = NetBoxMappings()
        self.scopes = [
            NBSite, NBSiteGroup
        ]
        self.data_model = {
            "prefix": [IPv4Network, IPv6Network],
            "site": NBSite,
            "scope_type": self.mapping.scopes_object_types(self.scopes),
            "scope_id": self.scopes,
            "tenant": NBTenant,
            "vlan": NBVLAN,
            "vrf": NBVRF,
            "description": 200,
            "tags": NBTagList
        }

        super().__init__(*args, **kwargs)

    def update(self, data=None, read_from_netbox=False, source=None):

        # prefixes are parsed into ip_networks
        data_prefix = data.get(self.primary_key)
        if not isinstance(data_prefix, (IPv4Network, IPv6Network)) and data_prefix is not None:
            try:
                data[self.primary_key] = ip_network(data_prefix)
            except ValueError as e:
                log.error(f"Failed to parse {self.name} '{data_prefix}': {e}")
                return

        super().update(data=data, read_from_netbox=read_from_netbox, source=source)


    def resolve_relations(self):

        self.resolve_scoped_relations("scope_id", "scope_type")
        super().resolve_relations()

    def matches_site(self, site=None) -> bool:
        """
        tries to figure out if this prefix matches a certain site or site group

        Parameters
        ----------
        site: NBSite
            the site object to match to

        Returns
        -------
        bool: True if matches one of the params

        """
        if isinstance(site, NBSite):
            if isinstance(self.data.get("scope_id"), NBSite) and self.data.get("scope_id") == site:
                return True
            if (isinstance(self.data.get("scope_id"), NBSiteGroup) and
                    self.data["scope_id"] == grab(site, "data.group")):
                return True

            # compatible for NetBox versions < 4.2.0
            if self.data.get("site") == site:
                return True

        return False

    def get_scope_display_name(self):

        if self.data.get("scope_id") is not None:
            if isinstance(self.data.get("scope_id"), NetBoxObject):
                scope_object = self.data.get("scope_id")
                return f"{scope_object.name} '{scope_object.get_display_name()}'"
            if isinstance(self.data.get("scope_id"), dict) and self.data.get("scope_type") is not None:

                if isinstance(self.data.get("scope_type"), str):
                    scope_class = self.mapping.get(self.data.get("scope_type"))
                else:
                    scope_class = self.data.get("scope_type")

                if scope_class is not None:
                    return f"{scope_class.name} '{grab(self, 'data.scope_id.data.name')}'"

        if self.data.get("site") is not None:
            if isinstance(self.data.get("site"), NetBoxObject):
                site_name = self.data.get("site").get_display_name()
                return f"site '{site_name}'"
            elif isinstance(self.data.get("site"), dict):
                return f"site '{grab(self, 'data.scope_id.data.name')}'"


class NBManufacturer(NetBoxObject):
    name = "manufacturer"
    api_path = "dcim/manufacturers"
    object_type = "dcim.manufacturer"
    primary_key = "name"
    prune = False

    def __init__(self, *args, **kwargs):
        self.data_model = {
            "name": 100,
            "slug": 100,
            "description": 200,
            "tags": NBTagList
        }
        super().__init__(*args, **kwargs)


class NBDeviceType(NetBoxObject):
    name = "device type"
    api_path = "dcim/device-types"
    object_type = "dcim.devicetype"
    primary_key = "model"
    prune = False

    def __init__(self, *args, **kwargs):
        self.data_model = {
            "model": 100,
            "slug": 100,
            "part_number": 50,
            "manufacturer": NBManufacturer,
            "tags": NBTagList
        }
        super().__init__(*args, **kwargs)


class NBPlatform(NetBoxObject):
    name = "platform"
    api_path = "dcim/platforms"
    object_type = "dcim.platform"
    primary_key = "name"
    prune = False

    def __init__(self, *args, **kwargs):
        self.data_model = {
            "name": 100,
            "slug": 100,
            "manufacturer": NBManufacturer,
            "description": 200,
            "tags": NBTagList
        }
        super().__init__(*args, **kwargs)


class NBClusterType(NetBoxObject):
    name = "cluster type"
    api_path = "virtualization/cluster-types"
    object_type = "virtualization.clustertype"
    primary_key = "name"
    prune = False

    def __init__(self, *args, **kwargs):
        self.data_model = {
            "name": 100,
            "slug": 100,
            "description": 200,
            "tags": NBTagList
        }
        super().__init__(*args, **kwargs)


class NBClusterGroup(NetBoxObject):
    name = "cluster group"
    api_path = "virtualization/cluster-groups"
    object_type = "virtualization.clustergroup"
    primary_key = "name"
    prune = False

    def __init__(self, *args, **kwargs):
        self.data_model = {
            "name": 100,
            "slug": 100,
            "description": 200,
            "tags": NBTagList,
            "custom_fields": NBCustomField
        }
        super().__init__(*args, **kwargs)


class NBDeviceRole(NetBoxObject):
    name = "device role"
    api_path = "dcim/device-roles"
    object_type = "dcim.devicerole"
    primary_key = "name"
    prune = False

    def __init__(self, *args, **kwargs):
        self.data_model = {
            "name": 100,
            "slug": 100,
            "color": 6,
            "description": 200,
            "vm_role": bool,
            "tags": NBTagList
        }
        super().__init__(*args, **kwargs)


class NBCluster(NetBoxObject):
    name = "cluster"
    api_path = "virtualization/clusters"
    object_type = "virtualization.cluster"
    primary_key = "name"
    secondary_key = "site"
    prune = False
    # include_secondary_key_if_present = True

    def __init__(self, *args, **kwargs):
        self.mapping = NetBoxMappings()
        self.scopes = [
            NBSite, NBSiteGroup
        ]
        self.data_model = {
            "name": 100,
            "comments": str,
            "type": NBClusterType,
            "tenant": NBTenant,
            "group": NBClusterGroup,
            "scope_type": self.mapping.scopes_object_types(self.scopes),
            # currently only site is supported as a scope
            "scope_id": NBSite,
            "tags": NBTagList
        }
        super().__init__(*args, **kwargs)

    def update(self, data=None, read_from_netbox=False, source=None):

        # Add adaption for change in NetBox 4.2.0 Device model
        if version.parse(self.inventory.netbox_api_version) >= version.parse("4.2.0"):
            if data.get("site") is not None:
                data["scope_id"] = data.get("site")
                data["scope_type"] = "dcim.site"
                del data["site"]

            if data.get("scope_id") is not None:
                data["scope_type"] = "dcim.site"

        super().update(data=data, read_from_netbox=read_from_netbox, source=source)

    def resolve_relations(self):

        self.resolve_scoped_relations("scope_id", "scope_type")
        super().resolve_relations()


class NBDevice(NetBoxObject):
    name = "device"
    api_path = "dcim/devices"
    object_type = "dcim.device"
    primary_key = "name"
    secondary_key = "site"
    prune = True

    skip_object_if_mandatory_attr_is_missing = True

    def __init__(self, *args, **kwargs):
        self.data_model = {
            "name": 64,
            "device_type": NBDeviceType,
            "device_role": NBDeviceRole,
            "role": NBDeviceRole,
            "platform": NBPlatform,
            "serial": 50,
            "site": NBSite,
            "status": ["offline", "active", "planned", "staged", "failed", "inventory", "decommissioning"],
            "cluster": NBCluster,
            "asset_tag": 50,
            "primary_ip4": NBIPAddress,
            "primary_ip6": NBIPAddress,
            "tags": NBTagList,
            "tenant": NBTenant,
            "custom_fields": NBCustomField
        }
        super().__init__(*args, **kwargs)

    def update(self, data=None, read_from_netbox=False, source=None):

        # Add adaption for change in NetBox 3.6.0 Device model
        if version.parse(self.inventory.netbox_api_version) >= version.parse("3.6.0"):
            if data.get("device_role") is not None:
                data["role"] = data.get("device_role")
                del data["device_role"]

        super().update(data=data, read_from_netbox=read_from_netbox, source=source)


class NBVM(NetBoxObject):
    name = "virtual machine"
    api_path = "virtualization/virtual-machines"
    object_type = "virtualization.virtualmachine"
    primary_key = "name"
    secondary_key = "cluster"
    prune = True

    def __init__(self, *args, **kwargs):
        self.data_model = {
            "name": 64,
            "serial": 50,
            "status": ["offline", "active", "planned", "staged", "failed", "decommissioning"],
            "cluster": NBCluster,
            "role": NBDeviceRole,
            "platform": NBPlatform,
            "vcpus": float,
            "memory": int,
            "disk": int,
            "comments": str,
            "primary_ip4": NBIPAddress,
            "primary_ip6": NBIPAddress,
            "site": NBSite,
            "tags": NBTagList,
            "tenant": NBTenant,
            "device": NBDevice,
            "custom_fields": NBCustomField
        }
        super().__init__(*args, **kwargs)

    def get_virtual_disks(self):
        result_list = list()
        for ip_object in self.inventory.get_all_items(NBVirtualDisk):
            if grab(ip_object, "data.virtual_machine") == self:
                result_list.append(ip_object)

        return result_list


class NBVMInterface(NetBoxObject):
    name = "virtual machine interface"
    api_path = "virtualization/interfaces"
    object_type = "virtualization.vminterface"
    primary_key = "name"
    secondary_key = "virtual_machine"
    enforce_secondary_key = True
    prune = True

    def __init__(self, *args, **kwargs):
        self.data_model = {
            "name": 64,
            "virtual_machine": NBVM,
            "enabled": bool,
            "mac_address": str,
            "primary_mac_address": NBMACAddress,
            "mtu": int,
            "mode": ["access", "tagged", "tagged-all"],
            "untagged_vlan": NBVLAN,
            "tagged_vlans": NBVLANList,
            "description": 200,
            "tags": NBTagList
        }
        super().__init__(*args, **kwargs)

    def get_ip_addresses(self):

        result_list = list()
        for ip_object in self.inventory.get_all_items(NBIPAddress):
            if ip_object.data.get("assigned_object_id") == self:
                result_list.append(ip_object)

        return result_list

    def get_mac_addresses(self):

        result_list = list()
        for mac_object in self.inventory.get_all_items(NBMACAddress):
            if mac_object.data.get("assigned_object_id") == self:
                result_list.append(mac_object)

        return result_list


class NBInterface(NetBoxObject):
    name = "interface"
    api_path = "dcim/interfaces"
    object_type = "dcim.interface"
    primary_key = "name"
    secondary_key = "device"
    enforce_secondary_key = True
    prune = True

    def __init__(self, *args, **kwargs):
        self.data_model = {
            "name": 64,
            "device": NBDevice,
            "label": 64,
            "type": NetBoxInterfaceType().get_netbox_type_list(),
            "enabled": bool,
            "mac_address": str,
            "primary_mac_address": NBMACAddress,
            "wwn": str,
            "mgmt_only": bool,
            "mtu": int,
            "mode": ["access", "tagged", "tagged-all"],
            "speed": int,
            "duplex": ["half", "full", "auto"],
            "untagged_vlan": NBVLAN,
            "tagged_vlans": NBVLANList,
            "description": 200,
            "mark_connected": bool,
            "tags": NBTagList,
            "parent": object
        }
        super().__init__(*args, **kwargs)

    def get_ip_addresses(self):

        result_list = list()
        for ip_object in self.inventory.get_all_items(NBIPAddress):
            if ip_object.data.get("assigned_object_id") == self:
                result_list.append(ip_object)

        return result_list

    def get_mac_addresses(self):

        result_list = list()
        for mac_object in self.inventory.get_all_items(NBMACAddress):
            if mac_object.data.get("assigned_object_id") == self:
                result_list.append(mac_object)

        return result_list

    def update(self, data=None, read_from_netbox=False, source=None):

        # remove definition of interface type if a parent interface is set as it only supports virtual types
        if grab(self, "data.parent") is not None and data.get("type") is not None:
            log.debug2(f"{self.name} '{self.get_display_name()}' attribute 'parent' is set. "
                       f"Removing type {data.get('type')} from update request")
            del data["type"]

        super().update(data=data, read_from_netbox=read_from_netbox, source=source)


class NBVirtualDisk(NetBoxObject):
    name = "Virtual Disk"
    api_path = "virtualization/virtual-disks"
    object_type = "virtualization.virtualdisk"
    primary_key = "name"
    secondary_key = "virtual_machine"
    min_netbox_version = "3.7"
    prune = True

    def __init__(self, *args, **kwargs):
        self.data_model = {
            "name": 64,
            "virtual_machine": NBVM,
            "description": 200,
            "size": int,  # in MB
            "tags": NBTagList
        }
        super().__init__(*args, **kwargs)


class NBIPAddress(NetBoxObject):
    name = "IP address"
    api_path = "ipam/ip-addresses"
    object_type = "ipam.ipaddress"
    primary_key = "address"
    is_primary = False
    prune = True

    def __init__(self, *args, **kwargs):
        self.mapping = NetBoxMappings()
        self.scopes = [
            NBInterface, NBVMInterface, NBFHRPGroupItem
        ]
        self.data_model = {
            "address": str,
            "assigned_object_type": self.mapping.scopes_object_types(self.scopes),
            "assigned_object_id": self.scopes,
            "description": 200,
            "role": ["loopback", "secondary", "anycast", "vip", "vrrp", "hsrp", "glbp", "carp"],
            "dns_name": 255,
            "tags": NBTagList,
            "tenant": NBTenant,
            "vrf": NBVRF
        }
        super().__init__(*args, **kwargs)

    def resolve_relations(self):

        self.resolve_scoped_relations("assigned_object_id", "assigned_object_type")
        super().resolve_relations()

    def update(self, data=None, read_from_netbox=False, source=None):

        object_type = data.get("assigned_object_type")
        assigned_object = data.get("assigned_object_id")

        # used to track changes in object primary IP assignments
        previous_ip_device_vm = None
        is_primary_ipv4_of_previous_device = False
        is_primary_ipv6_of_previous_device = False

        # we got an object data structure where we have to find the object
        if read_from_netbox is False and assigned_object is not None:

            # get current device to make sure to unset primary ip before moving IP address
            previous_ip_device_vm = self.get_device_vm()
            if grab(previous_ip_device_vm, "data.primary_ip4") is self:
                is_primary_ipv4_of_previous_device = True
            if grab(previous_ip_device_vm, "data.primary_ip6") is self:
                is_primary_ipv6_of_previous_device = True

            if not isinstance(assigned_object, NetBoxObject):

                data["assigned_object_id"] = \
                    self.inventory.add_update_object(self.mapping.get(object_type), data=assigned_object)

            else:
                # noinspection PyTypeChecker
                data["assigned_object_type"] = self.mapping.get(assigned_object)

        super().update(data=data, read_from_netbox=read_from_netbox, source=source)

        # we need to tell NetBox which object type this is meant to be
        if "assigned_object_id" in self.updated_items:
            self.updated_items.append("assigned_object_type")

        # if ip association has been removed we also need to get rid of object type
        if "assigned_object_type" in self.updated_items and self.data.get("assigned_object_id") is None \
                and "assigned_object_type" in self.updated_items:
            self.updated_items.remove("assigned_object_type")

        if assigned_object is None or previous_ip_device_vm is None:
            return

        if previous_ip_device_vm is self.get_device_vm():
            return

        if is_primary_ipv4_of_previous_device is True:
            previous_ip_device_vm.unset_attribute("primary_ip4")
        if is_primary_ipv6_of_previous_device is True:
            previous_ip_device_vm.unset_attribute("primary_ip6")

    def get_interface(self):
        o_id = self.data.get("assigned_object_id")
        o_type = self.data.get("assigned_object_type")

        if isinstance(o_id, (NBInterface, NBVMInterface)):
            return o_id

        if o_type is None or not isinstance(o_id, int):
            return

        if o_type not in self.data_model.get("assigned_object_type"):
            return

        return self.inventory.get_by_id(self.mapping.get(o_type), nb_id=o_id)

    def get_device_vm(self):

        o_interface = self.get_interface()

        if o_interface is None:
            return

        if isinstance(o_interface, NBInterface):
            return o_interface.data.get("device")
        elif isinstance(o_interface, NBVMInterface):
            return o_interface.data.get("virtual_machine")

    def remove_interface_association(self):
        o_id = self.data.get("assigned_object_id")
        o_type = self.data.get("assigned_object_type")
        o_device = self.get_device_vm()

        if grab(o_device, "data.primary_ip4") is self:
            o_device.unset_attribute("primary_ip4")
        if grab(o_device, "data.primary_ip6") is self:
            o_device.unset_attribute("primary_ip6")

        if o_id is not None:
            self.unset_attribute("assigned_object_id")
        if o_type is not None:
            self.unset_attribute("assigned_object_type")

class NBMACAddress(NetBoxObject):
    name = "MAC address"
    api_path = "dcim/mac-addresses"
    object_type = "ipam.macaddress"
    primary_key = "mac_address"
    prune = True
    min_netbox_version = "4.2"

    def __init__(self, *args, **kwargs):
        self.mapping = NetBoxMappings()
        self.scopes = [
            NBInterface, NBVMInterface
        ]
        self.data_model = {
            "mac_address": str,
            "assigned_object_type": self.mapping.scopes_object_types(self.scopes),
            "assigned_object_id": self.scopes,
            "description": 200,
            "tags": NBTagList,
        }
        super().__init__(*args, **kwargs)

    def resolve_relations(self):

        self.resolve_scoped_relations("assigned_object_id", "assigned_object_type")
        super().resolve_relations()

    def update(self, data=None, read_from_netbox=False, source=None):

        object_type = data.get("assigned_object_type")
        assigned_object = data.get("assigned_object_id")

        # we got an object data structure where we have to find the object
        if read_from_netbox is False and assigned_object is not None:

            if not isinstance(assigned_object, NetBoxObject):

                data["assigned_object_id"] = \
                    self.inventory.add_update_object(self.mapping.get(object_type), data=assigned_object)

            else:
                # noinspection PyTypeChecker
                data["assigned_object_type"] = self.mapping.get(assigned_object)

        super().update(data=data, read_from_netbox=read_from_netbox, source=source)

        # we need to tell NetBox which object type this is meant to be
        if "assigned_object_id" in self.updated_items:
            self.updated_items.append("assigned_object_type")

        # if ip association has been removed we also need to get rid of object type
        if "assigned_object_type" in self.updated_items and self.data.get("assigned_object_id") is None \
                and "assigned_object_type" in self.updated_items:
            self.updated_items.remove("assigned_object_type")

    def get_interface(self):
        o_id = self.data.get("assigned_object_id")
        o_type = self.data.get("assigned_object_type")

        if isinstance(o_id, (NBInterface, NBVMInterface)):
            return o_id

        if o_type is None or not isinstance(o_id, int):
            return

        if o_type not in self.data_model.get("assigned_object_type"):
            return

        return self.inventory.get_by_id(self.mapping.get(o_type), nb_id=o_id)

    def get_device_vm(self):

        o_interface = self.get_interface()

        if o_interface is None:
            return

        if isinstance(o_interface, NBInterface):
            return o_interface.data.get("device")
        elif isinstance(o_interface, NBVMInterface):
            return o_interface.data.get("virtual_machine")

    def remove_interface_association(self):
        o_id = self.data.get("assigned_object_id")
        o_type = self.data.get("assigned_object_type")
        o_device = self.get_device_vm()

        if grab(o_device, "data.primary_mac_address") is self:
            o_device.unset_attribute("primary_mac_address")

        if o_id is not None:
            self.unset_attribute("assigned_object_id")
        if o_type is not None:
            self.unset_attribute("assigned_object_type")


class NBFHRPGroupItem(NetBoxObject):
    name = "FHRP group"
    api_path = "ipam/fhrp-groups"
    object_type = "ipam.fhrpgroup"
    primary_key = "group_id"
    prune = False
    read_only = True

    def __init__(self, *args, **kwargs):
        self.data_model = {
            "group_id": int,
            "ip_addresses": NBIPAddress,
            "description": 200,
            "tags": NBTagList,
            "custom_fields": NBCustomField
        }
        super().__init__(*args, **kwargs)


class NBInventoryItem(NetBoxObject):
    name = "inventory item"
    api_path = "dcim/inventory-items"
    object_type = "dcim.inventoryitem"
    primary_key = "name"
    secondary_key = "device"
    prune = True

    def __init__(self, *args, **kwargs):
        self.data_model = {
            "device": NBDevice,
            "name": 64,
            "label": 64,
            "manufacturer": NBManufacturer,
            "part_id": 50,
            "serial": 50,
            "asset_tag": 50,
            "discovered": bool,
            "description": 200,
            "tags": NBTagList,
            "custom_fields": NBCustomField
        }
        super().__init__(*args, **kwargs)


class NBPowerPort(NetBoxObject):
    name = "power port"
    api_path = "dcim/power-ports"
    object_type = "dcim.powerport"
    primary_key = "name"
    secondary_key = "device"
    prune = True

    def __init__(self, *args, **kwargs):
        self.data_model = {
            "device": NBDevice,
            "name": 64,
            "label": 64,
            "description": 200,
            "maximum_draw": int,
            "allocated_draw": int,
            "mark_connected": bool,
            "tags": NBTagList,
            "custom_fields": NBCustomField
        }
        super().__init__(*args, **kwargs)

    def update(self, data=None, read_from_netbox=False, source=None):

        # take care of "maximum_draw" API limitation
        maximum_draw = data.get("maximum_draw")
        if maximum_draw is not None:
            try:
                maximum_draw = int(maximum_draw)
            except ValueError:
                data.pop("maximum_draw")

            if maximum_draw < 1:
                data.pop("maximum_draw")

        super().update(data=data, read_from_netbox=read_from_netbox, source=source)

# EOF