devicehub-teal/ereuse_devicehub/parser/computer.py

import logging
import re
from contextlib import suppress
from datetime import datetime
from fractions import Fraction
from math import hypot
from typing import Iterator, List, Optional, Type, TypeVar

import dateutil.parser
from ereuse_utils import getter, text
from ereuse_utils.nested_lookup import (
    get_nested_dicts_with_key_containing_value,
    get_nested_dicts_with_key_value,
)

from ereuse_devicehub.parser import base2, unit, utils
from ereuse_devicehub.parser.models import SnapshotsLog
from ereuse_devicehub.parser.utils import Dumpeable
from ereuse_devicehub.resources.enums import Severity

logger = logging.getLogger(__name__)


class Device(Dumpeable):
    """
    Base class for a computer and each component, containing
    its physical characteristics (like serial number) and Devicehub
    actions. For Devicehub actions, this class has an interface to execute
    :meth:`.benchmarks`.
    """

    def __init__(self, *sources) -> None:
        """Gets the device information."""
        self.actions = set()
        self.type = self.__class__.__name__
        super().__init__()

    def from_lshw(self, lshw_node: dict):
        self.manufacturer = getter.dict(lshw_node, 'vendor', default=None, type=str)
        self.model = getter.dict(
            lshw_node,
            'product',
            remove={self.manufacturer} if self.manufacturer else set(),
            default=None,
            type=str,
        )
        self.serial_number = getter.dict(lshw_node, 'serial', default=None, type=str)

    def __str__(self) -> str:
        return ' '.join(x for x in (self.model, self.serial_number) if x)


C = TypeVar('C', bound='Component')


class Component(Device):
    @classmethod
    def new(cls, lshw, hwinfo, **kwargs) -> Iterator[C]:
        raise NotImplementedError()


class Processor(Component):
    @classmethod
    def new(cls, lshw: dict, **kwargs) -> Iterator[C]:
        nodes = get_nested_dicts_with_key_value(lshw, 'class', 'processor')
        # We want only the physical cpu's, not the logic ones
        # In some cases we may get empty cpu nodes, we can detect them because
        # all regular cpus have at least a description (Intel Core i5...)
        return (
            cls(node)
            for node in nodes
            if 'logical' not in node['id']
            and node.get('description', '').lower() != 'co-processor'
            and not node.get('disabled')
            and 'co-processor' not in node.get('model', '').lower()
            and 'co-processor' not in node.get('description', '').lower()
            and 'width' in node
        )

    def __init__(self, node: dict) -> None:
        super().__init__(node)
        self.from_lshw(node)
        self.speed = unit.Quantity(node['size'], node['units']).to('gigahertz').m
        self.address = node['width']
        try:
            self.cores = int(node['configuration']['cores'])
            self.threads = int(node['configuration']['threads'])
        except KeyError:
            self.threads = 1
            self.cores = 1
        self.serial_number = None  # Processors don't have valid SN :-(
        self.brand, self.generation = self.processor_brand_generation(self.model)

        assert not hasattr(self, 'cores') or 1 <= self.cores <= 16

    @staticmethod  # noqa: C901
    def processor_brand_generation(model: str):
        """Generates the ``brand`` and ``generation`` fields for the given model.

        This returns a tuple with:

        - The brand as a string or None.
        - The generation as an int or None.
        Intel desktop processor numbers:
        https://www.intel.com/content/www/us/en/processors/processor-numbers.html
        Intel server processor numbers:
        https://www.intel.com/content/www/us/en/processors/processor-numbers-data-center.html
        """
        if 'Duo' in model:
            return 'Core2 Duo', None
        if 'Quad' in model:
            return 'Core2 Quad', None
        if 'Atom' in model:
            return 'Atom', None
        if 'Celeron' in model:
            return 'Celeron', None
        if 'Pentium' in model:
            return 'Pentium', None
        if 'Xeon Platinum' in model:
            generation = int(re.findall(r'\bPlatinum \d{4}\w', model)[0][10])
            return 'Xeon Platinum', generation
        if 'Xeon Gold' in model:
            generation = int(re.findall(r'\bGold \d{4}\w', model)[0][6])
            return 'Xeon Gold', generation
        if 'Xeon' in model:  # Xeon E5...
            generation = 1
            results = re.findall(r'\bV\d\b', model)  # find V1, V2...
            if results:
                generation = int(results[0][1])
            return 'Xeon', generation
        results = re.findall(r'\bi\d-\w+', model)  # i3-XXX..., i5-XXX...
        if results:  # i3, i5...
            return 'Core i{}'.format(results[0][1]), int(results[0][3])
        results = re.findall(r'\bi\d CPU \w+', model)
        if results:  # i3 CPU XXX
            return 'Core i{}'.format(results[0][1]), 1
        results = re.findall(r'\bm\d-\w+', model)  # m3-XXXX...
        if results:
            return 'Core m{}'.format(results[0][1]), None
        return None, None

    def __str__(self) -> str:
        return super().__str__() + (
            ' ({} generation)'.format(self.generation) if self.generation else ''
        )


class RamModule(Component):
    @classmethod
    def new(cls, lshw, **kwargs) -> Iterator[C]:
        # We can get flash memory (BIOS?), system memory and unknown types of memory
        memories = get_nested_dicts_with_key_value(lshw, 'class', 'memory')
        TYPES = {'ddr', 'sdram', 'sodimm'}
        for memory in memories:
            physical_ram = any(
                t in memory.get('description', '').lower() for t in TYPES
            )
            not_empty = 'size' in memory
            if physical_ram and not_empty:
                yield cls(memory)

    def __init__(self, node: dict) -> None:
        # Node with no size == empty ram slot
        super().__init__(node)
        self.from_lshw(node)
        description = node['description'].upper()
        self.format = 'SODIMM' if 'SODIMM' in description else 'DIMM'
        self.size = base2.Quantity(node['size'], node['units']).to('MiB').m
        # self.size = int(utils.convert_capacity(node['size'], node['units'], 'MB'))
        for w in description.split():
            if w.startswith('DDR'):  # We assume all DDR are SDRAM
                self.interface = w
                break
            elif w.startswith('SDRAM'):
                # Fallback. SDRAM is generic denomination for DDR types.
                self.interface = w
        if 'clock' in node:
            self.speed = unit.Quantity(node['clock'], 'Hz').to('MHz').m
        assert not hasattr(self, 'speed') or 100.0 <= self.speed <= 1000000000000.0

    def __str__(self) -> str:
        return '{} {} {}'.format(super().__str__(), self.format, self.size)


class GraphicCard(Component):
    @classmethod
    def new(cls, lshw, hwinfo, **kwargs) -> Iterator[C]:
        nodes = get_nested_dicts_with_key_value(lshw, 'class', 'display')
        return (cls(n) for n in nodes if n['configuration'].get('driver', None))

    def __init__(self, node: dict) -> None:
        super().__init__(node)
        self.from_lshw(node)
        self.memory = self._memory(node['businfo'].split('@')[1])

    @staticmethod
    def _memory(bus_info):
        """The size of the memory of the gpu."""
        return None

    def __str__(self) -> str:
        return '{} with {}'.format(super().__str__(), self.memory)


class Motherboard(Component):
    INTERFACES = 'usb', 'firewire', 'serial', 'pcmcia'

    @classmethod
    def new(cls, lshw, hwinfo, **kwargs) -> C:
        node = next(get_nested_dicts_with_key_value(lshw, 'description', 'Motherboard'))
        bios_node = next(get_nested_dicts_with_key_value(lshw, 'id', 'firmware'))
        # bios_node = '1'
        memory_array = next(
            getter.indents(hwinfo, 'Physical Memory Array', indent='    '), None
        )
        return cls(node, bios_node, memory_array)

    def __init__(
        self, node: dict, bios_node: dict, memory_array: Optional[List[str]]
    ) -> None:
        super().__init__(node)
        self.from_lshw(node)
        self.usb = self.num_interfaces(node, 'usb')
        self.firewire = self.num_interfaces(node, 'firewire')
        self.serial = self.num_interfaces(node, 'serial')
        self.pcmcia = self.num_interfaces(node, 'pcmcia')
        self.slots = int(2)
        #     run(
        #         'dmidecode -t 17 | ' 'grep -o BANK | ' 'wc -l',
        #         check=True,
        #         universal_newlines=True,
        #         shell=True,
        #         stdout=PIPE,
        #     ).stdout

        self.bios_date = dateutil.parser.parse(bios_node['date']).isoformat()
        self.version = bios_node['version']
        self.ram_slots = self.ram_max_size = None
        if memory_array:
            self.ram_slots = getter.kv(memory_array, 'Slots', default=None)
            self.ram_max_size = getter.kv(memory_array, 'Max. Size', default=None)
            if self.ram_max_size:
                self.ram_max_size = next(text.numbers(self.ram_max_size))

    @staticmethod
    def num_interfaces(node: dict, interface: str) -> int:
        interfaces = get_nested_dicts_with_key_containing_value(node, 'id', interface)
        if interface == 'usb':
            interfaces = (
                c
                for c in interfaces
                if 'usbhost' not in c['id'] and 'usb' not in c['businfo']
            )
        return len(tuple(interfaces))

    def __str__(self) -> str:
        return super().__str__()


class NetworkAdapter(Component):
    @classmethod
    def new(cls, lshw, hwinfo, **kwargs) -> Iterator[C]:
        nodes = get_nested_dicts_with_key_value(lshw, 'class', 'network')
        return (cls(node) for node in nodes)

    def __init__(self, node: dict) -> None:
        super().__init__(node)
        self.from_lshw(node)
        self.speed = None
        if 'capacity' in node:
            self.speed = unit.Quantity(node['capacity'], 'bit/s').to('Mbit/s').m
        if 'logicalname' in node:  # todo this was taken from 'self'?
            # If we don't have logicalname it means we don't have the
            # (proprietary) drivers fot that NetworkAdaptor
            # which means we can't access at the MAC address
            # (note that S/N == MAC) "sudo /sbin/lspci -vv" could bring
            # the MAC even if no drivers are installed however more work
            # has to be done in ensuring it is reliable, really needed,
            # and to parse it
            # https://www.redhat.com/archives/redhat-list/2010-October/msg00066.html
            # workbench-live includes proprietary firmwares
            self.serial_number = self.serial_number or utils.get_hw_addr(
                node['logicalname']
            )

        self.variant = node.get('version', None)
        self.wireless = bool(node.get('configuration', {}).get('wireless', False))

    def __str__(self) -> str:
        return '{} {} {}'.format(
            super().__str__(), self.speed, 'wireless' if self.wireless else 'ethernet'
        )


class SoundCard(Component):
    @classmethod
    def new(cls, lshw, hwinfo, **kwargs) -> Iterator[C]:
        nodes = get_nested_dicts_with_key_value(lshw, 'class', 'multimedia')
        return (cls(node) for node in nodes)

    def __init__(self, node) -> None:
        super().__init__(node)
        self.from_lshw(node)


class Display(Component):
    TECHS = 'CRT', 'TFT', 'LED', 'PDP', 'LCD', 'OLED', 'AMOLED'
    """Display technologies"""

    @classmethod
    def new(cls, lshw, hwinfo, **kwargs) -> Iterator[C]:
        for node in getter.indents(hwinfo, 'Monitor'):
            yield cls(node)

    def __init__(self, node: dict) -> None:
        super().__init__(node)
        self.model = getter.kv(node, 'Model')
        self.manufacturer = getter.kv(node, 'Vendor')
        self.serial_number = getter.kv(node, 'Serial ID', default=None, type=str)
        self.resolution_width, self.resolution_height, refresh_rate = text.numbers(
            getter.kv(node, 'Resolution')
        )
        self.refresh_rate = unit.Quantity(refresh_rate, 'Hz').m
        with suppress(StopIteration):
            # some monitors can have several resolutions, and the one
            # in "Detailed Timings" seems the highest one
            timings = next(getter.indents(node, 'Detailed Timings', indent='     '))
            self.resolution_width, self.resolution_height = text.numbers(
                getter.kv(timings, 'Resolution')
            )
        x, y = (
            unit.convert(v, 'millimeter', 'inch')
            for v in text.numbers(getter.kv(node, 'Size'))
        )
        self.size = hypot(x, y)
        self.technology = next((t for t in self.TECHS if t in node[0]), None)
        d = '{} {} 0'.format(
            getter.kv(node, 'Year of Manufacture'),
            getter.kv(node, 'Week of Manufacture'),
        )
        # We assume it has been produced the first day of such week
        self.production_date = datetime.strptime(d, '%Y %W %w').isoformat()
        self._aspect_ratio = Fraction(self.resolution_width, self.resolution_height)

    def __str__(self) -> str:
        return (
            '{0} {1.resolution_width}x{1.resolution_height} {1.size} inches {2}'.format(
                super().__str__(), self, self._aspect_ratio
            )
        )


class Computer(Device):
    CHASSIS_TYPE = {
        'Desktop': {
            'desktop',
            'low-profile',
            'tower',
            'docking',
            'all-in-one',
            'pizzabox',
            'mini-tower',
            'space-saving',
            'lunchbox',
            'mini',
            'stick',
        },
        'Laptop': {
            'portable',
            'laptop',
            'convertible',
            'tablet',
            'detachable',
            'notebook',
            'handheld',
            'sub-notebook',
        },
        'Server': {'server'},
        'Computer': {'_virtual'},
    }
    """
    A translation dictionary whose keys are Devicehub types and values
    are possible chassis values that `dmi <https://ezix.org/src/pkg/
    lshw/src/master/src/core/dmi.cc#L632>`_ can offer.
    """
    CHASSIS_DH = {
        'Tower': {'desktop', 'low-profile', 'tower', 'server'},
        'Docking': {'docking'},
        'AllInOne': {'all-in-one'},
        'Microtower': {'mini-tower', 'space-saving', 'mini'},
        'PizzaBox': {'pizzabox'},
        'Lunchbox': {'lunchbox'},
        'Stick': {'stick'},
        'Netbook': {'notebook', 'sub-notebook'},
        'Handheld': {'handheld'},
        'Laptop': {'portable', 'laptop'},
        'Convertible': {'convertible'},
        'Detachable': {'detachable'},
        'Tablet': {'tablet'},
        'Virtual': {'_virtual'},
    }
    """
    A conversion table from DMI's chassis type value Devicehub
    chassis value.
    """

    COMPONENTS = list(Component.__subclasses__())  # type: List[Type[Component]]
    COMPONENTS.remove(Motherboard)

    def __init__(self, node: dict) -> None:
        super().__init__(node)
        self.from_lshw(node)
        chassis = node.get('configuration', {}).get('chassis', '_virtual')
        self.type = next(
            t for t, values in self.CHASSIS_TYPE.items() if chassis in values
        )
        self.chassis = next(
            t for t, values in self.CHASSIS_DH.items() if chassis in values
        )
        self.sku = getter.dict(node, ('configuration', 'sku'), default=None, type=str)
        self.version = getter.dict(node, 'version', default=None, type=str)
        self._ram = None

    @classmethod
    def run(cls, lshw, hwinfo_raw, uuid=None, sid=None):
        """
        Gets hardware information from the computer and its components,
        like serial numbers or model names, and benchmarks them.

        This function uses ``LSHW`` as the main source of hardware information,
        which is obtained once when it is instantiated.
        """
        hwinfo = hwinfo_raw.splitlines()
        computer = cls(lshw)
        components = []
        try:
            for Component in cls.COMPONENTS:
                if Component == Display and computer.type != 'Laptop':
                    continue  # Only get display info when computer is laptop
                components.extend(Component.new(lshw=lshw, hwinfo=hwinfo))
            components.append(Motherboard.new(lshw, hwinfo))
            computer._ram = sum(
                ram.size for ram in components if isinstance(ram, RamModule)
            )
        except Exception as err:
            # if there are any problem with components, save the problem and continue
            txt = "Error: Snapshot: {uuid}, sid: {sid}, type_error: {type}, error: {error}".format(
                uuid=uuid, sid=sid, type=err.__class__, error=err
            )
            cls.errors(txt, uuid=uuid, sid=sid)

        return computer, components

    @classmethod
    def errors(cls, txt=None, uuid=None, sid=None, severity=Severity.Error):
        if not txt:
            return

        logger.error(txt)
        error = SnapshotsLog(
            description=txt, snapshot_uuid=uuid, severity=severity, sid=sid
        )
        error.save()

    def __str__(self) -> str:
        specs = super().__str__()
        return '{} with {} MB of RAM.'.format(specs, self._ram)