#!/usr/bin/env python
"""A registry based configuration parser."""

# NOTE: Running a 32 bit compiled client and 64 bit compiled client on a 64 bit
# system will run both clients on _DIFFERENT_ hives according to the WOW64
# scheme. This means that GRR will appear to have different clients for the same
# system. The clients will not share their config keys if the registry keys they
# use are hooked by WOW64.


import collections
import logging
from typing import Any
from urllib import parse as urlparse
import winreg

from grr_response_core.lib import config_parser
from grr_response_core.lib.util import precondition


class RegistryKeySpec(
    collections.namedtuple("RegistryKey", ["hive", "winreg_hive", "path"])
):
  __slots__ = ()

  def __str__(self):
    return "{}\\{}".format(self.hive, self.path)


def ParseRegistryURI(uri):
  url = urlparse.urlparse(uri, scheme="file")
  return RegistryKeySpec(
      hive=url.netloc,
      winreg_hive=getattr(winreg, url.netloc),
      path=url.path.replace("/", "\\").lstrip("\\"),
  )


class RegistryConfigParser(config_parser.GRRConfigParser):
  """A registry based configuration parser.

  This config system simply stores all the parameters as values of type REG_SZ
  in a single key.
  """

  def __init__(self, config_path: str) -> None:
    """We interpret the name as a key name."""
    self._key_spec = ParseRegistryURI(config_path)

    self._root_key = None

    try:
      # Access the key during __init__ to set `self.parsed`, which might be
      # expected by callers. Do not fail instantly though on error.
      self._AccessRootKey()
    except OSError as e:
      logging.debug("Unable to open config registry key: %s", e)

  def _AccessRootKey(self):
    if self._root_key is None:
      # Don't use winreg.KEY_WOW64_64KEY since it breaks on Windows 2000
      self._root_key = winreg.CreateKeyEx(
          self._key_spec.winreg_hive,
          self._key_spec.path,
          0,
          winreg.KEY_ALL_ACCESS,
      )
      self.parsed = self._key_spec.path
    return self._root_key

  def ReadData(self) -> dict[str, Any]:
    """Yields the valus in each section."""
    result = dict()

    i = 0
    while True:
      try:
        name, value, value_type = winreg.EnumValue(self._AccessRootKey(), i)
        # Only support strings here.
        if value_type == winreg.REG_SZ:
          precondition.AssertType(value, str)
          result[name] = value
      except OSError:
        break

      i += 1

    return result

  def SaveData(self, raw_data: dict[str, Any]) -> None:
    logging.info("Writing back configuration to key %s.", self._key_spec)

    # Ensure intermediate directories exist.
    try:
      for key, value in raw_data.items():
        # TODO(user): refactor regconfig. At the moment it has no idea
        # what kind of data it's serializing and simply stringifies, them
        # assuming that bytes are simply ascii-encoded strings. Note that
        # lists (Client.tempdir_roots) also get stringified and can't
        # really be deserialized, since RegistryConfigParser doesn't
        # support deserializing anything but strings.
        if isinstance(value, bytes):
          str_value = value.decode("ascii")
        else:
          str_value = str(value)
        winreg.SetValueEx(
            self._AccessRootKey(), key, 0, winreg.REG_SZ, str_value
        )

    finally:
      # Make sure changes hit the disk.
      winreg.FlushKey(self._AccessRootKey())

  def Copy(self) -> "RegistryConfigParser":
    return RegistryConfigParser(self.config_path)