"""Windows Registry plugin for parsing the last shutdown time of a system."""

import os

from dfdatetime import filetime as dfdatetime_filetime
from dfdatetime import semantic_time as dfdatetime_semantic_time

from plaso.containers import events
from plaso.lib import dtfabric_helper
from plaso.lib import errors
from plaso.parsers import winreg_parser
from plaso.parsers.winreg_plugins import interface


class ShutdownWindowsRegistryEventData(events.EventData):
    """Shutdown Windows Registry event data.

    Attributes:
      key_path (str): Windows Registry key path.
      last_shutdown_time (dfdatetime.DateTimeValues): date and time the system
          was last shutdown.
      value_name (str): name of the Windows Registry value.
    """

    DATA_TYPE = "windows:registry:shutdown"

    def __init__(self):
        """Initializes event data."""
        super().__init__(data_type=self.DATA_TYPE)
        self.key_path = None
        self.last_shutdown_time = None
        self.value_name = None


class ShutdownWindowsRegistryPlugin(
    interface.WindowsRegistryPlugin, dtfabric_helper.DtFabricHelper
):
    """Windows Registry plugin for parsing the last shutdown time of a system."""

    NAME = "windows_shutdown"
    DATA_FORMAT = "Windows last shutdown Registry data"

    FILTERS = frozenset(
        [
            interface.WindowsRegistryKeyPathFilter(
                "HKEY_LOCAL_MACHINE\\System\\CurrentControlSet\\Control\\Windows"
            )
        ]
    )

    _DEFINITION_FILE = os.path.join(os.path.dirname(__file__), "filetime.yaml")

    def _ParseFiletime(self, byte_stream):
        """Parses a FILETIME date and time value from a byte stream.

        Args:
          byte_stream (bytes): byte stream.

        Returns:
          dfdatetime.DateTimeValues: a FILETIME date and time values or a semantic
              date and time values if the FILETIME date and time value is not set.

        Raises:
          ParseError: if the FILETIME could not be parsed.
        """
        filetime_map = self._GetDataTypeMap("filetime")

        try:
            filetime = self._ReadStructureFromByteStream(byte_stream, 0, filetime_map)
        except (ValueError, errors.ParseError) as exception:
            raise errors.ParseError(
                f"Unable to parse FILETIME value with error: {exception!s}"
            )

        if filetime == 0:
            return dfdatetime_semantic_time.NotSet()

        try:
            return dfdatetime_filetime.Filetime(timestamp=filetime)
        except ValueError:
            raise errors.ParseError(f"Invalid FILETIME value: 0x{filetime:08x}")

    def ExtractEvents(self, parser_mediator, registry_key, **kwargs):
        """Extracts events from a ShutdownTime Windows Registry value.

        Args:
          parser_mediator (ParserMediator): mediates interactions between parsers and
              other components, such as storage and dfVFS.
          registry_key (dfwinreg.WinRegistryKey): Windows Registry key.
        """
        shutdown_value = registry_key.GetValueByName("ShutdownTime")
        if shutdown_value:
            corrupted = False
            date_time = None

            try:
                date_time = self._ParseFiletime(shutdown_value.data)
            except errors.ParseError as exception:
                parser_mediator.ProduceWarning(
                    f"unable to determine shutdown timestamp with error: {exception!s}"
                )
                corrupted = True

            event_data = ShutdownWindowsRegistryEventData()
            event_data.key_path = registry_key.path
            event_data.last_shutdown_time = date_time
            event_data.value_name = shutdown_value.name

            parser_mediator.ProduceEventData(event_data, corrupted=corrupted)

        self._ProduceDefaultWindowsRegistryEvent(
            parser_mediator, registry_key, names_to_skip=["ShutdownTime"]
        )


winreg_parser.WinRegistryParser.RegisterPlugin(ShutdownWindowsRegistryPlugin)
