""" Helper functions for config. """ import os from pathlib import Path from typing import Optional from ruamel.yaml import YAML from ruamel.yaml.constructor import SafeConstructor _CONFIGURATION_PATH: Optional[Path] = None def find_hass_config() -> Path: """Try to find HASS config.""" if "HASSIO_TOKEN" in os.environ: return Path("/config") """Put together the default configuration directory based on the OS.""" data_dir = Path( os.getenv("APPDATA") if os.name == "nt" else os.path.expanduser("~") ) config_dir = data_dir / ".homeassistant" if config_dir.is_dir(): return config_dir raise ValueError( "Unable to automatically find the location of Home Assistant " "config. Please pass it in." ) class HassSafeConstructor(SafeConstructor): """Hass specific SafeConstructor.""" def _secret_yaml(loader, node): """Load secrets and embed it into the configuration YAML.""" dirpath = Path(os.path.dirname(loader.name)) # Recursively search for the secrets.yaml file # this might be needed when a yaml file is included like # `!included folder/file.yaml`. Same rules as # https://www.home-assistant.io/docs/configuration/secrets/#debugging-secrets fname = dirpath / "secrets.yaml" for _ in range(len(dirpath.parts)): if fname.exists() or ( _CONFIGURATION_PATH is not None and _CONFIGURATION_PATH.exists() and dirpath.samefile(_CONFIGURATION_PATH) ): break dirpath = dirpath.parent fname = dirpath / "secrets.yaml" try: with fname.open() as secret_file: secrets = YAML(typ="safe").load(secret_file) except FileNotFoundError: raise ValueError("Secrets file {} not found".format(fname)) from None try: return secrets[node.value] except KeyError: raise ValueError("Secret {} not found".format(node.value)) from None def _include_yaml(loader, node): """Load another YAML file and embeds it using the !include tag. Example: device_tracker: !include device_tracker.yaml """ dirpath = Path(os.path.dirname(loader.name)) fname = dirpath / node.value for _ in range(len(dirpath.parts)): if fname.exists() or ( _CONFIGURATION_PATH is not None and _CONFIGURATION_PATH.exists() and dirpath.samefile(_CONFIGURATION_PATH) ): break dirpath = dirpath.parent fname = dirpath / node.value return load_yaml(os.path.join(dirpath, node.value)) def _stub_tag(constructor, node): """Stub a constructor with a dictionary.""" seen = getattr(constructor, "_stub_seen", None) if seen is None: seen = constructor._stub_seen = set() if node.tag not in seen: print("YAML tag {} is not supported".format(node.tag)) seen.add(node.tag) return {} HassSafeConstructor.add_constructor("!include", _include_yaml) HassSafeConstructor.add_constructor("!env_var", _stub_tag) HassSafeConstructor.add_constructor("!secret", _secret_yaml) HassSafeConstructor.add_constructor("!include_dir_list", _stub_tag) HassSafeConstructor.add_constructor("!include_dir_merge_list", _stub_tag) HassSafeConstructor.add_constructor("!include_dir_named", _stub_tag) HassSafeConstructor.add_constructor("!include_dir_merge_named", _stub_tag) def load_hass_config(path): """Load the HASS config.""" return load_yaml(os.path.join(path, "configuration.yaml")) def load_yaml(fname): """Load a YAML file.""" yaml = YAML(typ="safe") # Compat with HASS yaml.allow_duplicate_keys = True # Stub HASS constructors HassSafeConstructor.name = fname yaml.Constructor = HassSafeConstructor with open(fname, encoding="utf-8") as conf_file: # If configuration file is empty YAML returns None # We convert that to an empty dict return yaml.load(conf_file) or {} def db_url_from_hass_config(path): """Find the recorder database url from a HASS config dir.""" global _CONFIGURATION_PATH _CONFIGURATION_PATH = Path(path).resolve() config = load_hass_config(path) default_path = os.path.join(path, "home-assistant_v2.db") default_url = "sqlite:///{}".format(default_path) recorder = config.get("recorder") if recorder: db_url = recorder.get("db_url") if db_url is not None: return db_url if not os.path.isfile(default_path): raise ValueError( "Unable to determine DB url from hass config at {}".format(path) ) return default_url